osdEvent.c File Reference

#include <stdio.h>
#include <rtems.h>
#include <rtems/error.h>
#include "epicsEvent.h"
#include "epicsThread.h"
#include "errlog.h"

Include dependency graph for osdEvent.c:

Go to the source code of this file.

Macros
#define	__RTEMS_VIOLATE_KERNEL_VISIBILITY__   1
#define	SEMSTAT(i)

Functions
epicsEventId	epicsEventCreate (epicsEventInitialState initialState)
	Create an epicsEvent for use from C code, or return NULL. More...
void	epicsEventDestroy (epicsEventId id)
	Destroy an epicsEvent and any resources it holds. More...
epicsEventStatus	epicsEventTrigger (epicsEventId id)
	Trigger an event i.e. ensures the next or current call to wait completes. More...
epicsEventStatus	epicsEventWait (epicsEventId id)
	Wait for an event. More...
epicsEventStatus	epicsEventWaitWithTimeout (epicsEventId id, double timeOut)
	Wait an the event or until the specified timeout period is over. More...
epicsEventStatus	epicsEventTryWait (epicsEventId id)
	Similar to wait() except that if the event is currenly empty the call will return immediately with status epicsEventWaitTimeout. More...
void	epicsEventShow (epicsEventId id, unsigned int level)
	Display information about the semaphore. More...

Macro Definition Documentation

#define __RTEMS_VIOLATE_KERNEL_VISIBILITY__   1

Definition at line 19 of file osdEvent.c.

#define SEMSTAT

(

i

)

Definition at line 37 of file osdEvent.c.

Function Documentation

epicsEventId epicsEventCreate

(

epicsEventInitialState

initialState

)

Create an epicsEvent for use from C code, or return NULL.

Parameters

initialState

Starting state, epicsEventEmpty or epicsEventFull.

Returns

An identifier for the new event, or NULL if one not be created.

Definition at line 44 of file osdEvent.c.

{
    rtems_status_code sc;
    rtems_id sid;
    rtems_interrupt_level level;
    static char c1 = 'a';
    static char c2 = 'a';
    static char c3 = 'a';

    sc = rtems_semaphore_create (rtems_build_name ('B', c3, c2, c1),
        initialState,
        RTEMS_FIFO | RTEMS_SIMPLE_BINARY_SEMAPHORE |
            RTEMS_NO_INHERIT_PRIORITY | RTEMS_NO_PRIORITY_CEILING | RTEMS_LOCAL,
        0,
        &sid);
    if (sc != RTEMS_SUCCESSFUL) {
        errlogPrintf ("Can't create binary semaphore: %s\n", rtems_status_text (sc));
        return NULL;
    }
    rtems_interrupt_disable (level);
    if (c1 == 'z') {
        if (c2 == 'z') {
            if (c3 == 'z') {
                c3 = 'a';
            }
            else {
                c3++;
            }
            c2 = 'a';
        }
        else {
            c2++;
        }
        c1 = 'a';
    }
    else {
        c1++;
    }
    rtems_interrupt_enable (level);
    return (epicsEventId)sid;
}

void epicsEventDestroy

(

epicsEventId

id

)

Destroy an epicsEvent and any resources it holds.

No calls to any epicsEventWait routines can be active when this call is made.

Parameters

id	The event identifier.

Definition at line 87 of file osdEvent.c.

{
    rtems_id sid = (rtems_id)id;
    rtems_status_code sc;

    sc = rtems_semaphore_delete (sid);
    if (sc != RTEMS_SUCCESSFUL)
        errlogPrintf ("Can't destroy semaphore: %s\n", rtems_status_text (sc));
}

void epicsEventShow	(	epicsEventId	id,
		unsigned int	level
	)

Display information about the semaphore.

Note

The information displayed is architecture dependant.

Parameters

id	The event identifier.
level	An unsigned int for the level of information to be displayed.

Definition at line 163 of file osdEvent.c.

{
#if __RTEMS_VIOLATE_KERNEL_VISIBILITY__
    rtems_id sid = (rtems_id)id;
    Semaphore_Control *the_semaphore;
    Semaphore_Control semaphore;
    Objects_Locations location;

    the_semaphore = _Semaphore_Get (sid, &location);
    if (location != OBJECTS_LOCAL)
        return;
    /*
     * Yes, there's a race condition here since an interrupt might
     * change things while the copy is in progress, but the information
     * is only for display, so it's not that critical.
     */
    semaphore = *the_semaphore;
    _Thread_Enable_dispatch();
    printf ("          %8.8x  ", (int)sid);
    if (_Attributes_Is_counting_semaphore (semaphore.attribute_set)) {
            printf ("Count: %d", (int)semaphore.Core_control.semaphore.count);
    }
    else {
        if (_CORE_mutex_Is_locked(&semaphore.Core_control.mutex)) {
            char name[30];
            epicsThreadGetName ((epicsThreadId)semaphore.Core_control.mutex.holder_id, name, sizeof name);
            printf ("Held by:%8.8x (%s)  Nest count:%d",
                                    (unsigned int)semaphore.Core_control.mutex.holder_id,
                                    name,
                                    (int)semaphore.Core_control.mutex.nest_count);
        }
        else {
            printf ("Not Held");
        }
    }
    printf ("\n");
#endif
}

epicsEventStatus epicsEventTrigger

(

epicsEventId

id

)

Trigger an event i.e. ensures the next or current call to wait completes.

Note

This method may be called from a VxWorks or RTEMS interrupt handler.

Parameters

id	The event identifier.

Returns

Status indicator.

Definition at line 98 of file osdEvent.c.

{
    rtems_id sid = (rtems_id)id;
    rtems_status_code sc;

    sc = rtems_semaphore_release (sid);
    if (sc == RTEMS_SUCCESSFUL)
        return epicsEventOK;
    errlogPrintf ("Can't release semaphore: %s\n", rtems_status_text (sc));
    return epicsEventError;
}

epicsEventStatus epicsEventTryWait

(

epicsEventId

id

)

Similar to wait() except that if the event is currenly empty the call will return immediately with status epicsEventWaitTimeout.

Parameters

id	The event identifier.

Returns

Status indicator, epicsEventWaitTimeout when the event is empty.

Definition at line 147 of file osdEvent.c.

{
    rtems_id sid = (rtems_id)id;
    rtems_status_code sc;

    SEMSTAT(2)
    sc = rtems_semaphore_obtain (sid, RTEMS_NO_WAIT, RTEMS_NO_TIMEOUT);
    if (sc == RTEMS_SUCCESSFUL)
        return epicsEventOK;
    else if (sc == RTEMS_UNSATISFIED)
        return epicsEventWaitTimeout;
    else
        return epicsEventError;
}

epicsEventStatus epicsEventWait

(

epicsEventId

id

)

Wait for an event.

Note

Blocks until full.

Parameters

id	The event identifier.

Returns

Status indicator.

Definition at line 111 of file osdEvent.c.

{
    rtems_id sid = (rtems_id)id;
    rtems_status_code sc;

    SEMSTAT(0)
    sc = rtems_semaphore_obtain (sid, RTEMS_WAIT, RTEMS_NO_TIMEOUT);
    if (sc != RTEMS_SUCCESSFUL)
        return epicsEventError;
    return epicsEventOK;
}

epicsEventStatus epicsEventWaitWithTimeout	(	epicsEventId	id,
		double	timeOut
	)

Wait an the event or until the specified timeout period is over.

Note

Blocks until full or timeout.

Parameters

id	The event identifier.
timeOut	The timeout delay in seconds.

Returns

Status indicator.

Definition at line 124 of file osdEvent.c.

{
    rtems_id sid = (rtems_id)id;
    rtems_status_code sc;
    rtems_interval delay;
    extern double rtemsTicksPerSecond_double;

    if (timeOut <= 0.0)
        return epicsEventTryWait(id);
    SEMSTAT(1)
    delay = timeOut * rtemsTicksPerSecond_double;
    if (delay == 0)
        delay++;
    sc = rtems_semaphore_obtain (sid, RTEMS_WAIT, delay);
    if (sc == RTEMS_SUCCESSFUL)
        return epicsEventOK;
    else if (sc == RTEMS_TIMEOUT)
        return epicsEventWaitTimeout;
    else
        return epicsEventError;
}