/*
* calcTimeout() - calculate the time-out for pending on events
* Return whether to time out when waiting for events.
* If yes, set *pdelay to the timout (in seconds).
*/
static boolean calcTimeout(SSCB *ss, double *pdelay)
{
unsigned ndelay;
boolean do_timeout = FALSE;
double now, timeElapsed;
double delayMin = 0;
/* not really necessary to initialize delayMin,
but tell that to the compiler...
*/
if (ss->numDelays == 0)
return FALSE;
/*
* Calculate the timeElapsed since this state was entered.
*/
pvTimeGetCurrentDouble(&now);
timeElapsed = now - ss->timeEntered;
DEBUG("calcTimeout: now=%f, timeElapsed=%f\n", now, timeElapsed);
/*
* Find the minimum delay among all unexpired timeouts if
* one exists, and set do_timeout in this case.
*/
for (ndelay = 0; ndelay < ss->numDelays; ndelay++)
{
double delayN = ss->delay[ndelay];
if (ss->delayExpired[ndelay])
continue; /* skip if this delay entry already expired */
if (timeElapsed >= delayN)
{ /* just expired */
ss->delayExpired[ndelay] = TRUE; /* mark as expired */
*pdelay = 0.0;
DEBUG("calcTimeout: %d expired\n", ndelay);
return TRUE;
}
if (!do_timeout || delayN<=delayMin)
{
do_timeout = TRUE;
delayMin = delayN; /* this is the min. delay so far */
}
}
if (do_timeout)
{
*pdelay = max(0.0, delayMin - timeElapsed);
}
DEBUG("calcTimeout: do_timeout=%s, *pdelay=%f\n",
do_timeout?"yes":"no", *pdelay);
return do_timeout;
}
/*
* Test whether a given delay has expired.
*
* As a side-effect, adjust the state set's wakeupTime if our delay
* is shorter than previously tested ones.
*/
epicsShareFunc boolean seq_delay(SS_ID ss, double delay)
{
boolean expired;
double now, timeExpired;
pvTimeGetCurrentDouble(&now);
timeExpired = ss->timeEntered + delay;
expired = timeExpired <= now;
if (!expired && timeExpired < ss->wakeupTime)
ss->wakeupTime = timeExpired;
DEBUG("delay(%s/%s,%.10f): entered=%.10f, diff=%.10f, %s\n", ss->ssName,
ss->states[ss->currentState].stateName, delay, ss->timeEntered,
timeExpired - now, expired ? "expired": "unexpired");
return expired;
}
/*
* Test whether a given delay has expired.
*/
epicsShareFunc boolean epicsShareAPI seq_delay(SS_ID ss, DELAY_ID delayId)
{
double timeNow, timeElapsed;
boolean expired = FALSE;
/* Calc. elapsed time since state was entered */
pvTimeGetCurrentDouble( &timeNow );
timeElapsed = timeNow - ss->timeEntered;
/* Check for delay timeout */
if (timeElapsed > ss->delay[delayId]-0.000001)
{
ss->delayExpired[delayId] = TRUE; /* mark as expired */
expired = TRUE;
}
DEBUG("delay(%s,%u): diff=%.10f, %s\n", ss->ssName, delayId,
timeElapsed - ss->delay[delayId], expired ? "expired": "unexpired");
return expired;
}
/*
* clearDelays() - clear the time delay list.
*/
static void clearDelays(SSCB *ss, STATE *st)
{
unsigned ndelay;
/* On state change set time we entered this state; or if transition from
* same state if option to do so is on for this state.
*/
if ((ss->currentState != ss->prevState) ||
!(st->options & OPT_NORESETTIMERS))
{
pvTimeGetCurrentDouble(&ss->timeEntered);
}
for (ndelay = 0; ndelay < ss->maxNumDelays; ndelay++)
{
ss->delay[ndelay] = 0;
ss->delayExpired[ndelay] = FALSE;
}
ss->numDelays = 0;
}
static pvStat check_pending(
pvEventType evtype,
SS_ID ss,
PVREQ **req,
const char *varName,
DBCHAN *dbch,
PVMETA *meta,
enum compType compType,
double tmo)
{
const char *call = evtype == pvEventGet ? "pvGet" : "pvPut";
assert(evtype != pvEventMonitor);
if (compType == SYNC)
{
if (tmo <= 0.0)
{
errlogSevPrintf(errlogMajor,
"%s(%s,SYNC,%f): user error (timeout must be positive)\n",
call, varName, tmo);
return pvStatERROR;
}
while (*req)
{
/* a request is already pending (must be an async request) */
double before, after;
pvStat status;
pvTimeGetCurrentDouble(&before);
switch (epicsEventWaitWithTimeout(ss->syncSem, tmo))
{
case epicsEventWaitOK:
status = check_connected(dbch, meta);
if (status != pvStatOK)
return status;
pvTimeGetCurrentDouble(&after);
tmo -= (after - before);
if (tmo > 0.0)
break;
/* else: fall through to timeout */
case epicsEventWaitTimeout:
errlogSevPrintf(errlogMajor,
"%s(ss %s, var %s, pv %s): failed (timeout "
"waiting for other %s requests to finish)\n",
call, ss->ssName, varName, dbch->dbName, call
);
completion_timeout(evtype, meta);
return meta->status;
case epicsEventWaitError:
errlogSevPrintf(errlogFatal,
"%s: epicsEventWaitWithTimeout() failure\n", call);
completion_failure(evtype, meta);
return meta->status;
}
}
}
else if (compType == ASYNC)
{
if (*req) {
errlogSevPrintf(errlogMajor,
"%s(ss %s, var %s, pv %s): user error "
"(there is already a %s pending for this channel/"
"state set combination)\n",
call, ss->ssName, varName, dbch->dbName, call
);
return pvStatERROR;
}
}
return pvStatOK;
}
/*
* ss_entry() - Thread entry point for all state sets.
* Provides the main loop for state set processing.
*/
static void ss_entry(void *arg)
{
SSCB *ss = (SSCB *)arg;
PROG *sp = ss->prog;
/* Attach to PV system; was already done for the first state set */
if (ss != sp->ss)
{
ss->threadId = epicsThreadGetIdSelf();
createOrAttachPvSystem(sp);
}
/* Register this thread with the EPICS watchdog (no callback func) */
taskwdInsert(ss->threadId, 0, 0);
/* In safe mode, update local var buffer with global one before
entering the event loop. Must do this using
ss_read_all_buffer since CA and other state sets could
already post events resp. pvPut. */
if (optTest(sp, OPT_SAFE))
ss_read_all_buffer(sp, ss);
/* Initial state is the first one */
ss->currentState = 0;
ss->nextState = -1;
ss->prevState = -1;
DEBUG("ss %s: entering main loop\n", ss->ssName);
/*
* ============= Main loop ==============
*/
while (TRUE)
{
boolean ev_trig;
int transNum = 0; /* highest prio trans. # triggered */
STATE *st = ss->states + ss->currentState;
double now;
/* Set state to current state */
assert(ss->currentState >= 0);
/* Set state set event mask to this state's event mask */
ss->mask = st->eventMask;
/* If we've changed state, do any entry actions. Also do these
* even if it's the same state if option to do so is enabled.
*/
if (st->entryFunc && (ss->prevState != ss->currentState
|| optTest(st, OPT_DOENTRYFROMSELF)))
{
st->entryFunc(ss);
}
/* Flush any outstanding DB requests */
pvSysFlush(sp->pvSys);
/* Setting this semaphore here guarantees that a when() is
* always executed at least once when a state is first entered.
*/
epicsEventSignal(ss->syncSem);
pvTimeGetCurrentDouble(&now);
/* Set time we entered this state if transition from a different
* state or else if option not to do so is off for this state.
*/
if ((ss->currentState != ss->prevState) ||
!optTest(st, OPT_NORESETTIMERS))
{
ss->timeEntered = now;
}
ss->wakeupTime = epicsINF;
/* Loop until an event is triggered, i.e. when() returns TRUE
*/
do {
/* Wake up on PV event, event flag, or expired delay */
DEBUG("before epicsEventWaitWithTimeout(ss=%d,timeout=%f)\n",
ss - sp->ss, ss->wakeupTime - now);
epicsEventWaitWithTimeout(ss->syncSem, ss->wakeupTime - now);
DEBUG("after epicsEventWaitWithTimeout()\n");
/* Check whether we have been asked to exit */
if (sp->die) goto exit;
/* Copy dirty variable values from CA buffer
* to user (safe mode only).
*/
if (optTest(sp, OPT_SAFE))
ss_read_all_buffer(sp, ss);
ss->wakeupTime = epicsINF;
/* Check state change conditions */
ev_trig = st->eventFunc(ss,
&transNum, &ss->nextState);
/* Clear all event flags (old ef mode only) */
if (ev_trig && !optTest(sp, OPT_NEWEF))
{
unsigned i;
for (i = 0; i < NWORDS(sp->numEvFlags); i++)
{
sp->evFlags[i] &= ~ss->mask[i];
}
}
if (!ev_trig)
pvTimeGetCurrentDouble(&now);
} while (!ev_trig);
/* Execute the state change action */
st->actionFunc(ss, transNum, &ss->nextState);
/* Check whether we have been asked to exit */
if (sp->die) goto exit;
/* If changing state, do exit actions */
if (st->exitFunc && (ss->currentState != ss->nextState
|| optTest(st, OPT_DOEXITTOSELF)))
{
st->exitFunc(ss);
}
/* Change to next state */
ss->prevState = ss->currentState;
ss->currentState = ss->nextState;
}
/* Thread exit has been requested */
exit:
taskwdRemove(ss->threadId);
/* Declare ourselves dead */
if (ss != sp->ss)
epicsEventSignal(ss->dead);
}
/*
* Get value from a channel.
* TODO: add optional timeout argument.
*/
epicsShareFunc pvStat epicsShareAPI seq_pvGet(SS_ID ss, VAR_ID varId, enum compType compType)
{
SPROG *sp = ss->sprog;
CHAN *ch = sp->chan + varId;
pvStat status;
PVREQ *req;
epicsEventId getSem = ss->getSemId[varId];
DBCHAN *dbch = ch->dbch;
PVMETA *meta = metaPtr(ch,ss);
double tmo = seq_sync_timeout;
/* Anonymous PV and safe mode, just copy from shared buffer.
Note that completion is always immediate, so no distinction
between SYNC and ASYNC needed. See also pvGetComplete. */
if ((sp->options & OPT_SAFE) && !dbch)
{
/* Copy regardless of whether dirty flag is set or not */
ss_read_buffer(ss, ch, FALSE);
return pvStatOK;
}
/* No named PV and traditional mode => user error */
if (!dbch)
{
errlogSevPrintf(errlogMajor,
"pvGet(%s): user error (variable not assigned)\n",
ch->varName
);
return pvStatERROR;
}
if (compType == DEFAULT)
{
compType = (sp->options & OPT_ASYNC) ? ASYNC : SYNC;
}
if (compType == SYNC)
{
double before, after;
pvTimeGetCurrentDouble(&before);
switch (epicsEventWaitWithTimeout(getSem, tmo))
{
case epicsEventWaitOK:
status = check_connected(dbch, meta);
if (status) return epicsEventSignal(getSem), status;
pvTimeGetCurrentDouble(&after);
tmo -= (after - before);
break;
case epicsEventWaitTimeout:
errlogSevPrintf(errlogMajor,
"pvGet(ss %s, var %s, pv %s): failed (timeout "
"waiting for other get requests to finish)\n",
ss->ssName, ch->varName, dbch->dbName
);
return pvStatERROR;
case epicsEventWaitError:
/* try to recover */
ss->getReq[varId] = NULL;
epicsEventSignal(getSem);
errlogSevPrintf(errlogFatal,
"pvGet: epicsEventWaitWithTimeout() failure\n");
return pvStatERROR;
}
}
else if (compType == ASYNC)
{
switch (epicsEventTryWait(getSem))
{
case epicsEventWaitOK:
if (ss->getReq[varId] != NULL)
{
/* previous request timed out but user
did not call pvGetComplete */
ss->getReq[varId] = NULL;
}
status = check_connected(dbch, meta);
if (status) return epicsEventSignal(getSem), status;
break;
case epicsEventWaitTimeout:
errlogSevPrintf(errlogMajor,
"pvGet(ss %s, var %s, pv %s): user error "
"(there is already a get pending for this variable/"
"state set combination)\n",
ss->ssName, ch->varName, dbch->dbName
);
return pvStatERROR;
case epicsEventWaitError:
/* try to recover */
ss->getReq[varId] = NULL;
epicsEventSignal(getSem);
errlogSevPrintf(errlogFatal,
"pvGet: epicsEventTryWait() failure\n");
return pvStatERROR;
}
}
/* Allocate and initialize a pv request */
req = (PVREQ *)freeListMalloc(sp->pvReqPool);
req->ss = ss;
req->ch = ch;
assert(ss->getReq[varId] == NULL);
ss->getReq[varId] = req;
/* Perform the PV get operation with a callback routine specified.
Requesting more than db channel has available is ok. */
status = pvVarGetCallback(
dbch->pvid, /* PV id */
ch->type->getType, /* request type */
ch->count, /* element count */
seq_get_handler, /* callback handler */
req); /* user arg */
if (status != pvStatOK)
{
meta->status = pvStatERROR;
meta->severity = pvSevrMAJOR;
meta->message = "get failure";
errlogSevPrintf(errlogFatal, "pvGet(var %s, pv %s): pvVarGetCallback() failure: %s\n",
ch->varName, dbch->dbName, pvVarGetMess(dbch->pvid));
ss->getReq[varId] = NULL;
freeListFree(sp->pvReqPool, req);
epicsEventSignal(getSem);
check_connected(dbch, meta);
return status;
}
/* Synchronous: wait for completion */
if (compType == SYNC)
{
epicsEventWaitStatus event_status;
pvSysFlush(sp->pvSys);
event_status = epicsEventWaitWithTimeout(getSem, tmo);
ss->getReq[varId] = NULL;
epicsEventSignal(getSem);
switch (event_status)
{
case epicsEventWaitOK:
status = check_connected(dbch, meta);
if (status) return status;
if (sp->options & OPT_SAFE)
/* Copy regardless of whether dirty flag is set or not */
ss_read_buffer(ss, ch, FALSE);
break;
case epicsEventWaitTimeout:
meta->status = pvStatTIMEOUT;
meta->severity = pvSevrMAJOR;
meta->message = "get completion timeout";
return meta->status;
case epicsEventWaitError:
meta->status = pvStatERROR;
meta->severity = pvSevrMAJOR;
meta->message = "get completion failure";
return meta->status;
}
}
return pvStatOK;
}
/*
* Put a variable's value to a PV.
*/
epicsShareFunc pvStat epicsShareAPI seq_pvPut(SS_ID ss, VAR_ID varId, enum compType compType)
{
SPROG *sp = ss->sprog;
CHAN *ch = sp->chan + varId;
pvStat status;
unsigned count;
char *var = valPtr(ch,ss); /* ptr to value */
PVREQ *req;
DBCHAN *dbch = ch->dbch;
PVMETA *meta = metaPtr(ch,ss);
epicsEventId putSem = ss->putSemId[varId];
double tmo = seq_sync_timeout;
DEBUG("pvPut: pv name=%s, var=%p\n", dbch ? dbch->dbName : "<anonymous>", var);
/* First handle anonymous PV (safe mode only) */
if ((sp->options & OPT_SAFE) && !dbch)
{
anonymous_put(ss, ch);
return pvStatOK;
}
if (!dbch)
{
errlogSevPrintf(errlogMajor,
"pvPut(%s): user error (variable not assigned)\n",
ch->varName
);
return pvStatERROR;
}
/* Check for channel connected */
status = check_connected(dbch, meta);
if (status) return status;
/* Determine whether to perform synchronous, asynchronous, or
plain put ((+a) option was never honored for put, so DEFAULT
means non-blocking and therefore implicitly asynchronous) */
if (compType == SYNC)
{
double before, after;
pvTimeGetCurrentDouble(&before);
switch (epicsEventWaitWithTimeout(putSem, tmo))
{
case epicsEventWaitOK:
pvTimeGetCurrentDouble(&after);
tmo -= (after - before);
break;
case epicsEventWaitTimeout:
errlogSevPrintf(errlogMajor,
"pvPut(ss %s, var %s, pv %s): failed (timeout "
"waiting for other put requests to finish)\n",
ss->ssName, ch->varName, dbch->dbName
);
return pvStatERROR;
case epicsEventWaitError:
/* try to recover */
ss->putReq[varId] = NULL;
epicsEventSignal(putSem);
errlogSevPrintf(errlogFatal,
"pvPut: epicsEventWaitWithTimeout() failure\n");
return pvStatERROR;
}
}
else if (compType == ASYNC)
{
switch (epicsEventTryWait(putSem))
{
case epicsEventWaitOK:
if (ss->putReq[varId] != NULL)
{
/* previous request timed out but user
did not call pvPutComplete */
ss->putReq[varId] = NULL;
}
break;
case epicsEventWaitTimeout:
meta->status = pvStatERROR;
meta->severity = pvSevrMAJOR;
meta->message = "already one put pending";
status = meta->status;
errlogSevPrintf(errlogMajor,
"pvPut(ss %s, var %s, pv %s): user error "
"(there is already a put pending for this variable/"
"state set combination)\n",
ss->ssName, ch->varName, dbch->dbName
);
return pvStatERROR;
case epicsEventWaitError:
/* try to recover */
ss->putReq[varId] = NULL;
epicsEventSignal(putSem);
errlogSevPrintf(errlogFatal,
"pvPut: epicsEventTryWait() failure\n");
return pvStatERROR;
}
}
/* Determine number of elements to put (don't try to put more
than db count) */
count = dbch->dbCount;
/* Perform the PV put operation (either non-blocking or with a
callback routine specified) */
if (compType == DEFAULT)
{
status = pvVarPutNoBlock(
dbch->pvid, /* PV id */
ch->type->putType, /* data type */
count, /* element count */
(pvValue *)var); /* data value */
if (status != pvStatOK)
{
errlogSevPrintf(errlogFatal, "pvPut(var %s, pv %s): pvVarPutNoBlock() failure: %s\n",
ch->varName, dbch->dbName, pvVarGetMess(dbch->pvid));
return status;
}
}
else
{
/* Allocate and initialize a pv request */
req = (PVREQ *)freeListMalloc(sp->pvReqPool);
req->ss = ss;
req->ch = ch;
assert(ss->putReq[varId] == NULL);
ss->putReq[varId] = req;
status = pvVarPutCallback(
dbch->pvid, /* PV id */
ch->type->putType, /* data type */
count, /* element count */
(pvValue *)var, /* data value */
seq_put_handler, /* callback handler */
req); /* user arg */
if (status != pvStatOK)
{
ss->putReq[varId] = NULL;
errlogSevPrintf(errlogFatal, "pvPut(var %s, pv %s): pvVarPutCallback() failure: %s\n",
ch->varName, dbch->dbName, pvVarGetMess(dbch->pvid));
freeListFree(sp->pvReqPool, req);
epicsEventSignal(putSem);
check_connected(dbch, meta);
return status;
}
}
/* Synchronous: wait for completion (10s timeout) */
if (compType == SYNC)
{
epicsEventWaitStatus event_status;
pvSysFlush(sp->pvSys);
event_status = epicsEventWaitWithTimeout(putSem, tmo);
ss->putReq[varId] = NULL;
epicsEventSignal(putSem);
switch (event_status)
{
case epicsEventWaitOK:
status = check_connected(dbch, meta);
if (status) return status;
break;
case epicsEventWaitTimeout:
meta->status = pvStatTIMEOUT;
meta->severity = pvSevrMAJOR;
meta->message = "put completion timeout";
return meta->status;
break;
case epicsEventWaitError:
meta->status = pvStatERROR;
meta->severity = pvSevrMAJOR;
meta->message = "put completion failure";
return meta->status;
break;
}
}
return pvStatOK;
}
