#include <string.h>
#include <stdlib.h>
#include "epicsTypes.h"
#include "epicsEvent.h"
#include "epicsMutex.h"
#include "epicsMessageQueue.h"
#include "epicsString.h"
#include "epicsStdioRedirect.h"
#include "epicsThread.h"
#include "epicsTime.h"
#include "epicsTimer.h"
#include "epicsInterrupt.h"
#include "osiSock.h"
#include "ellLib.h"
#include "errlog.h"
#include "cantProceed.h"
#include "envDefs.h"
#include "generalTimeSup.h"
#include "epicsGeneralTime.h"

Include dependency graph for epicsGeneralTime.c:

Classes
struct	gtProvider

Macros
#define	IFDEBUG(n) if(0) /* Compiler will elide the block or statement */

Functions
int	osdTimeGetCurrent (epicsTimeStamp *pDest)

void	generalTime_Init (void)
	Initialise the framework. More...

int	generalTimeGetExceptPriority (epicsTimeStamp pDest, int pPrio, int ignore)

int epicsStdCall	epicsTimeGetCurrent (epicsTimeStamp *pDest)
	Get current time into `*pDest`. More...

int	epicsTimeGetMonotonic (epicsTimeStamp *pDest)
	Get monotonic time into `*pDest`. More...

int	epicsTimeGetCurrentInt (epicsTimeStamp *pDest)
	Get current time into `*pDest` (ISR-safe) More...

int epicsStdCall	epicsTimeGetEvent (epicsTimeStamp *pDest, int eventNumber)
	Get time of event `eventNumber` into `*pDest`. More...

int	epicsTimeGetEventInt (epicsTimeStamp *pDest, int eventNumber)
	Get time of event `eventNumber` into `*pDest` (ISR-safe) More...

int	generalTimeRegisterEventProvider (const char *name, int priority, TIMEEVENTFUN getEvent)

int	generalTimeAddIntEventProvider (const char *name, int priority, TIMEEVENTFUN getEvent)

int	generalTimeRegisterCurrentProvider (const char *name, int priority, TIMECURRENTFUN getTime)

int	generalTimeAddIntCurrentProvider (const char *name, int priority, TIMECURRENTFUN getTime)

int	installLastResortEventProvider (void)
	Install a Time Event time provider that returns the current time for any Time event number. More...

long	generalTimeReport (int level)
	Provide information about the installed providers and their current best times. More...

void	generalTimeResetErrorCounts (void)
	Reset the internal counter of the number of times the time returned was earlier than when previously requested. More...

int	generalTimeGetErrorCounts (void)
	Return the internal counter of the number of times the time returned was earlier than when previously requested. More...

const char *	generalTimeCurrentProviderName (void)
	Return the nume of the provider that last returned a valid current time, or NULL if none. More...

const char *	generalTimeEventProviderName (void)
	Return the name of the provider that last returned a valid Time Event time, or NULL of none. More...

const char *	generalTimeHighestCurrentName (void)
	Return the name of the registered current time provider that has the highest priority. More...

Macro Definition Documentation

#define IFDEBUG ( n ) if(0) /* Compiler will elide the block or statement */

Definition at line 41 of file epicsGeneralTime.c.

Function Documentation

int epicsStdCall epicsTimeGetCurrent ( epicsTimeStamp * pDest )

Get current time into *pDest.

Definition at line 152 of file epicsGeneralTime.c.

 {
     gtProvider *ptp;
     int status = S_time_noProvider;
     epicsTimeStamp ts;
 
     if(useOsdGetCurrent)
         return osdTimeGetCurrent(pDest);
 
     generalTime_Init();
 
     IFDEBUG(20)
         printf("epicsTimeGetCurrent()\n");
 
     epicsMutexMustLock(gtPvt.timeListLock);
     for (ptp = (gtProvider *)ellFirst(&gtPvt.timeProviders);
          ptp; ptp = (gtProvider *)ellNext(&ptp->node)) {
 
         status = ptp->get.Time(&ts);
         if (status == epicsTimeOK) {
             /* check time is monotonic */
             if (epicsTimeGreaterThanEqual(&ts, &gtPvt.lastProvidedTime)) {
                 *pDest = ts;
                 gtPvt.lastProvidedTime = ts;
                 gtPvt.lastTimeProvider = ptp;
             } else {
                 int key;
 
                 *pDest = gtPvt.lastProvidedTime;
                 key = epicsInterruptLock();
                 gtPvt.ErrorCounts++;
                 epicsInterruptUnlock(key);
 
                 IFDEBUG(10) {
                     char last[40], buff[40];
 
                     epicsTimeToStrftime(last, sizeof(last), tsfmt,
                         &gtPvt.lastProvidedTime);
                     epicsTimeToStrftime(buff, sizeof(buff), tsfmt, &ts);
                     printf("eTGC provider '%s' returned older time\n"
                         "    %s, using %s instead\n", ptp->name, buff, last);
                 }
             }
             break;
         }
     }
     if (status)
         gtPvt.lastTimeProvider = NULL;
     epicsMutexUnlock(gtPvt.timeListLock);
 
     IFDEBUG(20) {
         if (ptp && status == epicsTimeOK) {
             char buff[40];
 
             epicsTimeToStrftime(buff, sizeof(buff), tsfmt, &ts);
             printf("eTGC returning %s from provider '%s'\n",
                 buff, ptp->name);
         }
         else
             printf("eTGC returning error\n");
     }
 
     return status;
 }

int epicsTimeGetCurrentInt ( epicsTimeStamp * pDest )

Get current time into *pDest (ISR-safe)

Definition at line 225 of file epicsGeneralTime.c.

 {
     gtProvider *ptp = gtPvt.lastTimeProvider;
 
     if (ptp == NULL ||
         ptp->getInt.Time == NULL) {
         IFDEBUG(20)
             epicsInterruptContextMessage("eTGCInt: No support\n");
         return S_time_noProvider;
     }
 
     return ptp->getInt.Time(pDest);
 }

int epicsStdCall epicsTimeGetEvent	(	epicsTimeStamp *	pDest,
		int	eventNumber
	)

Get time of event eventNumber into *pDest.

Definition at line 341 of file epicsGeneralTime.c.

 {
     if (eventNumber == epicsTimeEventCurrentTime) {
         return epicsTimeGetCurrent(pDest);
     } else {
         return generalTimeGetEventPriority(pDest, eventNumber, NULL);
     }
 }

int epicsTimeGetEventInt	(	epicsTimeStamp *	pDest,
		int	eventNumber
	)

Get time of event eventNumber into *pDest (ISR-safe)

Definition at line 350 of file epicsGeneralTime.c.

 {
     if (eventNumber == epicsTimeEventCurrentTime) {
         return epicsTimeGetCurrentInt(pDest);
     } else {
         gtProvider *ptp = gtPvt.lastEventProvider;
 
         if (ptp == NULL ||
             ptp->getInt.Event == NULL) {
             IFDEBUG(20)
                 epicsInterruptContextMessage("eTGEvInt: No support\n");
             return S_time_noProvider;
         }
 
         return ptp->getInt.Event(pDest, eventNumber);
     }
 }

int epicsTimeGetMonotonic ( epicsTimeStamp * pDest )

Get monotonic time into *pDest.

Definition at line 217 of file epicsGeneralTime.c.

 {
     epicsUInt64 now = epicsMonotonicGet();
     pDest->nsec = now%1000000000ul;
     pDest->secPastEpoch = now/1000000000ul;
     return 0;
 }

void generalTime_Init ( void )

Initialise the framework.

This routine is called automatically by any function that requires the framework. It does not need to be called explicitly.

Definition at line 99 of file epicsGeneralTime.c.

 {
     epicsThreadOnce(&onceId, generalTime_InitOnce, NULL);
 }

int generalTimeAddIntCurrentProvider	(	const char *	name,
		int	priority,
		TIMECURRENTFUN	getTime
	)

Definition at line 487 of file epicsGeneralTime.c.

 {
     gtProvider *ptp = findProvider(&gtPvt.timeProviders, gtPvt.timeListLock,
         name, priority);
     if (ptp == NULL)
         return S_time_noProvider;
 
     ptp->getInt.Time = getTime;
 
     IFDEBUG(1)
         printf("Time provider '%s' is interrupt-callable\n", name);
 
     return epicsTimeOK;
 }

int generalTimeAddIntEventProvider	(	const char *	name,
		int	priority,
		TIMEEVENTFUN	getEvent
	)

Definition at line 444 of file epicsGeneralTime.c.

 {
     gtProvider *ptp = findProvider(&gtPvt.eventProviders, gtPvt.eventListLock,
         name, priority);
     if (ptp == NULL)
         return S_time_noProvider;
 
     ptp->getInt.Event = getEvent;
 
     IFDEBUG(1)
         printf("Event provider '%s' is interrupt-callable\n", name);
 
     return epicsTimeOK;
 }

const char* generalTimeCurrentProviderName ( void )

Return the nume of the provider that last returned a valid current time, or NULL if none.

Used by stringin device support with:

1 DTYP = "General Time"

2 INP = "@BESTTCP"

Returns: Provider name

Definition at line 638 of file epicsGeneralTime.c.

 {
     if (gtPvt.lastTimeProvider)
         return gtPvt.lastTimeProvider->name;
     return NULL;
 }

const char* generalTimeEventProviderName ( void )

Return the name of the provider that last returned a valid Time Event time, or NULL of none.

Used by stringin device support with:

1 DTYP = "General Time"

2 INP = "@BESTTEP"

Returns: Provider name

Definition at line 645 of file epicsGeneralTime.c.

 {
     if (gtPvt.lastEventProvider)
         return gtPvt.lastEventProvider->name;
     return NULL;
 }

int generalTimeGetErrorCounts ( void )

Return the internal counter of the number of times the time returned was earlier than when previously requested.

Used by device support for longin record with:

1 DTYP = "General Time"

2 INP = "@GETERRCNT"

Returns: Reset error counts

Definition at line 630 of file epicsGeneralTime.c.

 {
     int key = epicsInterruptLock();
     int errors = gtPvt.ErrorCounts;
     epicsInterruptUnlock(key);
     return errors;
 }

int generalTimeGetExceptPriority	(	epicsTimeStamp *	pDest,
		int *	pPrio,
		int	ignore
	)

Definition at line 105 of file epicsGeneralTime.c.

 {
     gtProvider *ptp;
     int status = S_time_noProvider;
 
     if(useOsdGetCurrent)
         return osdTimeGetCurrent(pDest);
 
     generalTime_Init();
 
     IFDEBUG(2)
         printf("generalTimeGetExceptPriority(ignore=%d)\n", ignore);
 
     epicsMutexMustLock(gtPvt.timeListLock);
     for (ptp = (gtProvider *)ellFirst(&gtPvt.timeProviders);
          ptp; ptp = (gtProvider *)ellNext(&ptp->node)) {
         if ((ignore > 0 && ptp->priority == ignore) ||
             (ignore < 0 && ptp->priority != -ignore))
             continue;
 
         status = ptp->get.Time(pDest);
         if (status == epicsTimeOK) {
             /* No ratchet, time from this routine may go backwards */
             if (pPrio)
                 *pPrio = ptp->priority;
             break;
         }
         else IFDEBUG(2)
             printf("gTGExP provider '%s' returned error\n", ptp->name);
     }
     epicsMutexUnlock(gtPvt.timeListLock);
 
     IFDEBUG(2) {
         if (ptp && status == epicsTimeOK) {
             char buff[40];
 
             epicsTimeToStrftime(buff, sizeof(buff), tsfmt, pDest);
             printf("gTGExP returning %s from provider '%s'\n",
                 buff, ptp->name);
         }
         else
             printf("gTGExP returning error\n");
     }
 
     return status;
 }

const char* generalTimeHighestCurrentName ( void )

Return the name of the registered current time provider that has the highest priority.

Used by stringin device support with:

1 DTYP = "General Time"

2 INP = "@TOPTCP"

Returns: Provider name

Definition at line 652 of file epicsGeneralTime.c.

 {
     gtProvider *ptp;
 
     epicsMutexMustLock(gtPvt.timeListLock);
     ptp = (gtProvider *)ellFirst(&gtPvt.timeProviders);
     epicsMutexUnlock(gtPvt.timeListLock);
     return ptp ? ptp->name : NULL;
 }

int generalTimeRegisterCurrentProvider	(	const char *	name,
		int	priority,
		TIMECURRENTFUN	getTime
	)

Definition at line 460 of file epicsGeneralTime.c.

 {
     gtProvider *ptp;
 
     generalTime_Init();
 
     if (name == NULL || getTime == NULL)
         return S_time_badArgs;
 
     ptp = (gtProvider *)malloc(sizeof(gtProvider));
     if (ptp == NULL)
         return S_time_noMemory;
 
     ptp->name        = epicsStrDup(name);
     ptp->priority    = priority;
     ptp->get.Time    = getTime;
     ptp->getInt.Time = NULL;
 
     insertProvider(ptp, &gtPvt.timeProviders, gtPvt.timeListLock);
 
     IFDEBUG(1)
         printf("Registered time provider '%s' at %d\n", name, priority);
 
     return epicsTimeOK;
 }

int generalTimeRegisterEventProvider	(	const char *	name,
		int	priority,
		TIMEEVENTFUN	getEvent
	)

Definition at line 417 of file epicsGeneralTime.c.

 {
     gtProvider *ptp;
 
     generalTime_Init();
 
     if (name == NULL || getEvent == NULL)
         return S_time_badArgs;
 
     ptp = (gtProvider *)malloc(sizeof(gtProvider));
     if (ptp == NULL)
         return S_time_noMemory;
 
     ptp->name         = epicsStrDup(name);
     ptp->priority     = priority;
     ptp->get.Event    = getEvent;
     ptp->getInt.Event = NULL;
 
     insertProvider(ptp, &gtPvt.eventProviders, gtPvt.eventListLock);
 
     IFDEBUG(1)
         printf("Registered event provider '%s' at %d\n", name, priority);
 
     return epicsTimeOK;
 }

long generalTimeReport ( int interest )

Provide information about the installed providers and their current best times.

Parameters

interest Desired interest level to report

Definition at line 529 of file epicsGeneralTime.c.

 {
     int items;
 
     if (onceId == EPICS_THREAD_ONCE_INIT) {
         printf("General time framework not yet initialized.\n");
         return epicsTimeOK;
     }
 
     printf("Backwards time errors prevented %u times.\n\n",
         generalTimeGetErrorCounts());
 
     /* Use an output buffer to avoid holding mutexes during printing */
 
     printf("Current Time Providers:\n");
     epicsMutexMustLock(gtPvt.timeListLock);
     if ((items = ellCount(&gtPvt.timeProviders))) {
         gtProvider *ptp;
         char *message;     /* Temporary output buffer */
         char *pout;
 
         message = calloc(items, 80 * 2); /* Each provider needs 2 lines */
         if (!message) {
             epicsMutexUnlock(gtPvt.timeListLock);
             printf("Out of memory\n");
             return S_time_noMemory;
         }
 
         pout = message;
 
         for (ptp = (gtProvider *)ellFirst(&gtPvt.timeProviders);
              ptp; ptp = (gtProvider *)ellNext(&ptp->node)) {
             pout += sprintf(pout, "    \"%s\", priority = %d\n",
                 ptp->name, ptp->priority);
             if (level) {
                 epicsTimeStamp tempTS;
                 if (ptp->get.Time(&tempTS) == epicsTimeOK) {
                     char tempTSText[40];
                     epicsTimeToStrftime(tempTSText, sizeof(tempTSText),
                         "%Y-%m-%d %H:%M:%S.%06f", &tempTS);
                     pout += sprintf(pout, "\tCurrent Time is %s.\n",
                         tempTSText);
                 } else {
                     pout += sprintf(pout, "\tCurrent Time not available\n");
                 }
             }
         }
         epicsMutexUnlock(gtPvt.timeListLock);
         puts(message);
         free(message);
     } else {
         epicsMutexUnlock(gtPvt.timeListLock);
         printf("\tNo Providers registered.\n");
     }
 
     printf("Event Time Providers:\n");
     epicsMutexMustLock(gtPvt.eventListLock);
     if ((items = ellCount(&gtPvt.eventProviders)))
     {
         gtProvider *ptp;
         char *message;     /* Temporary output buffer */
         char *pout;
 
         message = calloc(items, 80);     /* Each provider needs 1 line, */
         if (!message) {
             epicsMutexUnlock(gtPvt.eventListLock);
             printf("Out of memory\n");
             return S_time_noMemory;
         }
 
         pout = message;
 
         for (ptp = (gtProvider *)ellFirst(&gtPvt.eventProviders);
              ptp; ptp = (gtProvider *)ellNext(&ptp->node)) {
             pout += sprintf(pout, "    \"%s\", priority = %d\n",
                 ptp->name, ptp->priority);
         }
         epicsMutexUnlock(gtPvt.eventListLock);
         puts(message);
         free(message);
     }
     else
     {
         epicsMutexUnlock(gtPvt.eventListLock);
         printf("\tNo Providers registered.\n");
     }
 
     return epicsTimeOK;
 }

void generalTimeResetErrorCounts ( void )

Reset the internal counter of the number of times the time returned was earlier than when previously requested.

Used by device support for binary out record with:

1 DTYP = "General Time"

2 OUT = "@RSTERRCNT"

Definition at line 623 of file epicsGeneralTime.c.

 {
     int key = epicsInterruptLock();
     gtPvt.ErrorCounts = 0;
     epicsInterruptUnlock(key);
 }

int installLastResortEventProvider ( void )

Install a Time Event time provider that returns the current time for any Time event number.

Note: This is optional as it is site policy whether the last resort for a Time Event time in the absence of any working provider should be a failure, or the current time.

Definition at line 520 of file epicsGeneralTime.c.

 {
     return generalTimeEventTpRegister("Last Resort Event",
         LAST_RESORT_PRIORITY, lastResortGetEvent);
 }

int osdTimeGetCurrent ( epicsTimeStamp * pDest )

Definition at line 119 of file osdTime.cpp.

 {
     assert ( pCurrentTime );
 
     pCurrentTime->getCurrentTime ( *pDest );
     return epicsTimeOK;
 }

Variable Documentation

int ErrorCounts

Definition at line 73 of file epicsGeneralTime.c.

epicsMutexId eventListLock

Definition at line 67 of file epicsGeneralTime.c.

ELLLIST eventProviders

Definition at line 68 of file epicsGeneralTime.c.

epicsTimeStamp eventTime[NUM_TIME_EVENTS]

Definition at line 70 of file epicsGeneralTime.c.

gtProvider* lastEventProvider

Definition at line 69 of file epicsGeneralTime.c.

epicsTimeStamp lastProvidedBestTime

Definition at line 71 of file epicsGeneralTime.c.

epicsTimeStamp lastProvidedTime

Definition at line 65 of file epicsGeneralTime.c.

gtProvider* lastTimeProvider

Definition at line 64 of file epicsGeneralTime.c.

epicsMutexId timeListLock

Definition at line 62 of file epicsGeneralTime.c.

ELLLIST timeProviders

Definition at line 63 of file epicsGeneralTime.c.

Classes

Macros

Functions

Macro Definition Documentation

Function Documentation

Variable Documentation