diff --git a/documentation/RELEASE_NOTES.html b/documentation/RELEASE_NOTES.html
index e55b4692b..2e56b647c 100644
--- a/documentation/RELEASE_NOTES.html
+++ b/documentation/RELEASE_NOTES.html
@@ -15,6 +15,18 @@ EPICS Base 3.15.0.x releases are not intended for use in production systems.
Changes between 3.14.x and 3.15.0.x
+Named Soft Events
+
+Soft events can now be given meaningful names instead of just using the
+numbers 1-255. The EVNT field is now a DBF_STRING. The post_event() API
+is now deprecated but still works. It should be replaced by code that in advance
+looks up the EVNTPVT event handle associated with the named event by
+calling eventNameToHandle(char *), and when that event occurs passes
+that handle to the new postEvent(EVNTPVT) routine (which may be called
+from interrupt level). A new iocsh command postEvent name will
+trigger a named event from the command-line or a startup script (on vxWorks the
+expression postEvent(eventNameToHandle("name")) must be used
+instead though).
Parallel Builds
diff --git a/src/ioc/db/dbCommon.dbd b/src/ioc/db/dbCommon.dbd
index 29d1c0009..d940999e7 100644
--- a/src/ioc/db/dbCommon.dbd
+++ b/src/ioc/db/dbCommon.dbd
@@ -43,10 +43,11 @@
special(SPC_SCAN)
interest(1)
}
- field(EVNT,DBF_SHORT) {
- prompt("Event Number")
+ field(EVNT,DBF_STRING) {
+ prompt("Event Name")
promptgroup(GUI_SCAN)
special(SPC_SCAN)
+ size(40)
interest(1)
}
field(TSE,DBF_SHORT) {
diff --git a/src/ioc/db/dbIocRegister.c b/src/ioc/db/dbIocRegister.c
index a82337f03..60965f200 100644
--- a/src/ioc/db/dbIocRegister.c
+++ b/src/ioc/db/dbIocRegister.c
@@ -266,11 +266,21 @@ static void scanpplCallFunc(const iocshArgBuf *args)
{ scanppl(args[0].dval);}
/* scanpel */
-static const iocshArg scanpelArg0 = { "event number",iocshArgInt};
+static const iocshArg scanpelArg0 = { "event name",iocshArgString};
static const iocshArg * const scanpelArgs[1] = {&scanpelArg0};
static const iocshFuncDef scanpelFuncDef = {"scanpel",1,scanpelArgs};
static void scanpelCallFunc(const iocshArgBuf *args)
-{ scanpel(args[0].ival);}
+{ scanpel(args[0].sval);}
+
+/* postEvent */
+static const iocshArg postEventArg0 = { "event name",iocshArgString};
+static const iocshArg * const postEventArgs[1] = {&postEventArg0};
+static const iocshFuncDef postEventFuncDef = {"postEvent",1,postEventArgs};
+static void postEventCallFunc(const iocshArgBuf *args)
+{
+ EVENTPVT pel = eventNameToHandle(args[0].sval);
+ postEvent(pel);
+}
/* scanpiol */
static const iocshFuncDef scanpiolFuncDef = {"scanpiol",0};
@@ -328,6 +338,7 @@ void epicsShareAPI dbIocRegister(void)
iocshRegister(&scanOnceSetQueueSizeFuncDef,scanOnceSetQueueSizeCallFunc);
iocshRegister(&scanpplFuncDef,scanpplCallFunc);
iocshRegister(&scanpelFuncDef,scanpelCallFunc);
+ iocshRegister(&postEventFuncDef,postEventCallFunc);
iocshRegister(&scanpiolFuncDef,scanpiolCallFunc);
iocshRegister(&callbackSetQueueSizeFuncDef,callbackSetQueueSizeCallFunc);
diff --git a/src/ioc/db/dbScan.c b/src/ioc/db/dbScan.c
index 12098b31a..8aaf1b14e 100644
--- a/src/ioc/db/dbScan.c
+++ b/src/ioc/db/dbScan.c
@@ -101,12 +101,13 @@ static char *priorityName[NUM_CALLBACK_PRIORITIES] = {
/* EVENT */
-#define MAX_EVENTS 256
-typedef struct event_scan_list {
- CALLBACK callback;
- scan_list scan_list;
-} event_scan_list;
-static event_scan_list *pevent_list[NUM_CALLBACK_PRIORITIES][MAX_EVENTS];
+typedef struct event_list {
+ CALLBACK callback[NUM_CALLBACK_PRIORITIES];
+ scan_list scan_list[NUM_CALLBACK_PRIORITIES];
+ struct event_list *next;
+ char event_name[MAX_STRING_SIZE];
+} event_list;
+static event_list * volatile pevent_list[256];
/* IO_EVENT*/
@@ -204,35 +205,24 @@ void scanAdd(struct dbCommon *precord)
recGblRecordError(-1, (void *)precord,
"scanAdd detected illegal SCAN value");
} else if (scan == menuScanEvent) {
- int evnt;
+ char* eventname;
int prio;
- event_scan_list *pesl;
+ event_list *pel;
- evnt = precord->evnt;
- if (evnt < 0 || evnt >= MAX_EVENTS) {
+ eventname = precord->evnt;
+ if (strlen(eventname) >= MAX_STRING_SIZE) {
recGblRecordError(S_db_badField, (void *)precord,
- "scanAdd detected illegal EVNT value");
- precord->scan = menuScanPassive;
+ "scanAdd: too long EVNT value");
return;
}
prio = precord->prio;
if (prio < 0 || prio >= NUM_CALLBACK_PRIORITIES) {
recGblRecordError(-1, (void *)precord,
"scanAdd: illegal prio field");
- precord->scan = menuScanPassive;
return;
}
- pesl = pevent_list[prio][evnt];
- if (pesl == NULL) {
- pesl = dbCalloc(1, sizeof(event_scan_list));
- pevent_list[prio][evnt] = pesl;
- pesl->scan_list.lock = epicsMutexMustCreate();
- callbackSetCallback(eventCallback, &pesl->callback);
- callbackSetPriority(prio, &pesl->callback);
- callbackSetUser(pesl, &pesl->callback);
- ellInit(&pesl->scan_list.list);
- }
- addToList(precord, &pesl->scan_list);
+ pel = eventNameToHandle(eventname);
+ if (pel) addToList(precord, &pel->scan_list[prio]);
} else if (scan == menuScanI_O_Intr) {
io_scan_list *piosl = NULL;
int prio;
@@ -287,31 +277,25 @@ void scanDelete(struct dbCommon *precord)
recGblRecordError(-1, (void *)precord,
"scanDelete detected illegal SCAN value");
} else if (scan == menuScanEvent) {
- int evnt;
+ char* eventname;
int prio;
- event_scan_list *pesl;
+ event_list *pel;
scan_list *psl = 0;
- evnt = precord->evnt;
- if (evnt < 0 || evnt >= MAX_EVENTS) {
- recGblRecordError(S_db_badField, (void *)precord,
- "scanAdd detected illegal EVNT value");
- precord->scan = menuScanPassive;
- return;
- }
+ eventname = precord->evnt;
prio = precord->prio;
if (prio < 0 || prio >= NUM_CALLBACK_PRIORITIES) {
recGblRecordError(-1, (void *)precord,
- "scanAdd: illegal prio field");
- precord->scan = menuScanPassive;
+ "scanDelete detected illegal PRIO field");
return;
}
- pesl = pevent_list[prio][evnt];
- if (pesl) psl = &pesl->scan_list;
- if (!pesl || !psl)
- recGblRecordError(-1, (void *)precord,
- "scanDelete for bad evnt");
- else
+ do /* multithreading: make sure pel is consistent */
+ pel = pevent_list[0];
+ while (pel != pevent_list[0]);
+ for (; pel; pel=pel->next) {
+ if (strcmp(pel->event_name, eventname) == 0) break;
+ }
+ if (pel && (psl = &pel->scan_list[prio]))
deleteFromList(precord, psl);
} else if (scan == menuScanI_O_Intr) {
io_scan_list *piosl=NULL;
@@ -372,21 +356,22 @@ int scanppl(double period) /* print periodic list */
return 0;
}
-int scanpel(int event_number) /* print event list */
+int scanpel(const char* eventname) /* print event list */
{
char message[80];
- int prio, evnt;
- event_scan_list *pesl;
+ int prio;
+ event_list *pel;
- for (evnt = 0; evnt < MAX_EVENTS; evnt++) {
- if (event_number && evntevent_number) break;
- for (prio = 0; prio < NUM_CALLBACK_PRIORITIES; prio++) {
- pesl = pevent_list[prio][evnt];
- if (!pesl) continue;
- if (ellCount(&pesl->scan_list.list) == 0) continue;
- sprintf(message, "Event %d Priority %s", evnt, priorityName[prio]);
- printList(&pesl->scan_list, message);
+ do /* multithreading: make sure pel is consistent */
+ pel = pevent_list[0];
+ while (pel != pevent_list[0]);
+ for (; pel; pel = pel->next) {
+ if (!eventname || strcmp(pel->event_name, eventname) == 0) {
+ for (prio = 0; prio < NUM_CALLBACK_PRIORITIES; prio++) {
+ if (ellCount(&pel->scan_list[prio].list) == 0) continue;
+ sprintf(message, "Event \"%s\" Priority %s", pel->event_name, priorityName[prio]);
+ printList(&pel->scan_list[prio], message);
+ }
}
}
return 0;
@@ -412,39 +397,73 @@ int scanpiol(void) /* print io_event list */
static void eventCallback(CALLBACK *pcallback)
{
- event_scan_list *pesl;
+ scan_list *psl;
- callbackGetUser(pesl, pcallback);
- scanList(&pesl->scan_list);
+ callbackGetUser(psl, pcallback);
+ scanList(psl);
}
static void initEvent(void)
{
- int evnt, prio;
+}
- for (prio = 0; prio < NUM_CALLBACK_PRIORITIES; prio++) {
- for (evnt = 0; evnt < MAX_EVENTS; evnt++) {
- pevent_list[prio][evnt] = NULL;
+event_list *eventNameToHandle(const char *eventname)
+{
+ int prio;
+ event_list *pel;
+ static epicsMutexId lock = NULL;
+
+ if (!lock) lock = epicsMutexMustCreate();
+ if (!eventname || eventname[0] == 0) return NULL;
+ epicsMutexMustLock(lock);
+ for (pel = pevent_list[0]; pel; pel=pel->next) {
+ if (strcmp(pel->event_name, eventname) == 0) break;
+ }
+ if (pel == NULL) {
+ pel = dbCalloc(1, sizeof(event_list));
+ strcpy(pel->event_name, eventname);
+ for (prio = 0; prio < NUM_CALLBACK_PRIORITIES; prio++) {
+ callbackSetUser(&pel->scan_list[prio], &pel->callback[prio]);
+ callbackSetPriority(prio, &pel->callback[prio]);
+ callbackSetCallback(eventCallback, &pel->callback[prio]);
+ pel->scan_list[prio].lock = epicsMutexMustCreate();
+ ellInit(&pel->scan_list[prio].list);
}
+ pel->next=pevent_list[0];
+ pevent_list[0]=pel;
+ { /* backward compatibility */
+ char* p;
+ long e = strtol(eventname, &p, 0);
+ if (*p == 0 && e > 0 && e <= 255)
+ pevent_list[e] = pel;
+ }
+ }
+ epicsMutexUnlock(lock);
+ return pel;
+}
+
+void postEvent(event_list *pel)
+{
+ int prio;
+
+ if (scanCtl != ctlRun) return;
+ if (!pel) return;
+ for (prio = 0; prio < NUM_CALLBACK_PRIORITIES; prio++) {
+ if (ellCount(&pel->scan_list[prio].list) >0)
+ callbackRequest(&pel->callback[prio]);
}
}
+/* backward compatibility */
void post_event(int event)
{
- int prio;
- event_scan_list *pesl;
+ event_list* pel;
- if (scanCtl != ctlRun) return;
- if (event < 0 || event >= MAX_EVENTS) {
- errMessage(-1, "illegal event passed to post_event");
- return;
- }
- for (prio=0; prioscan_list.list) >0)
- callbackRequest((void *)pesl);
- }
+ if (event <= 0 || event > 255) return;
+ do { /* multithreading: make sure pel is consistent */
+ pel = pevent_list[event];
+ } while (pel != pevent_list[event]);
+ postEvent(pel);
}
void scanIoInit(IOSCANPVT *ppioscanpvt)
diff --git a/src/ioc/db/dbScan.h b/src/ioc/db/dbScan.h
index 5b96b8196..eca2c889d 100644
--- a/src/ioc/db/dbScan.h
+++ b/src/ioc/db/dbScan.h
@@ -19,6 +19,7 @@
#include "menuScan.h"
#include "shareLib.h"
+#include "compilerDependencies.h"
#ifdef __cplusplus
extern "C" {
@@ -36,6 +37,7 @@ extern "C" {
struct io_scan_list;
typedef struct io_scan_list *IOSCANPVT;
+typedef struct event_list *EVENTPVT;
struct dbCommon;
@@ -43,7 +45,9 @@ epicsShareFunc long scanInit(void);
epicsShareFunc void scanRun(void);
epicsShareFunc void scanPause(void);
-epicsShareFunc void post_event(int event);
+epicsShareFunc EVENTPVT eventNameToHandle(const char* event);
+epicsShareFunc void postEvent(EVENTPVT epvt);
+epicsShareFunc void post_event(int event) EPICS_DEPRECATED;
epicsShareFunc void scanAdd(struct dbCommon *);
epicsShareFunc void scanDelete(struct dbCommon *);
epicsShareFunc double scanPeriod(int scan);
@@ -54,7 +58,7 @@ epicsShareFunc int scanOnceSetQueueSize(int size);
epicsShareFunc int scanppl(double rate);
/*print event lists*/
-epicsShareFunc int scanpel(int event_number);
+epicsShareFunc int scanpel(const char *event_name);
/*print io_event list*/
epicsShareFunc int scanpiol(void);
diff --git a/src/std/dev/devEventSoft.c b/src/std/dev/devEventSoft.c
index 167d18df2..45de65393 100644
--- a/src/std/dev/devEventSoft.c
+++ b/src/std/dev/devEventSoft.c
@@ -51,7 +51,7 @@ static long init_record(eventRecord *prec)
/* INP must be CONSTANT, PV_LINK, DB_LINK or CA_LINK*/
switch (prec->inp.type) {
case CONSTANT:
- if (recGblInitConstantLink(&prec->inp, DBF_USHORT, &prec->val))
+ if (recGblInitConstantLink(&prec->inp, DBF_STRING, &prec->val))
prec->udf = FALSE;
break;
case PV_LINK:
@@ -69,13 +69,20 @@ static long init_record(eventRecord *prec)
static long read_event(eventRecord *prec)
{
long status;
+ char newEvent[MAX_STRING_SIZE];
- status = dbGetLink(&prec->inp, DBR_USHORT, &prec->val, 0, 0);
- if (!status) {
- prec->udf = FALSE;
- if (prec->tsel.type == CONSTANT &&
- prec->tse == epicsTimeEventDeviceTime)
- dbGetTimeStamp(&prec->inp, &prec->time);
+ if (prec->inp.type != CONSTANT)
+ {
+ status = dbGetLinkValue(&prec->inp, DBR_STRING, newEvent, 0, 0);
+ if (status) return status;
+ if (strcmp(newEvent, prec->val) != 0) {
+ strcpy(prec->val, newEvent);
+ prec->epvt = eventNameToHandle(prec->val);
+ }
}
- return status;
+ prec->udf = FALSE;
+ if (prec->tsel.type == CONSTANT &&
+ prec->tse == epicsTimeEventDeviceTime)
+ dbGetTimeStamp(&prec->inp, &prec->time);
+ return 0;
}
diff --git a/src/std/rec/calcoutRecord.c b/src/std/rec/calcoutRecord.c
index 0b7c78323..9e18c0996 100644
--- a/src/std/rec/calcoutRecord.c
+++ b/src/std/rec/calcoutRecord.c
@@ -197,6 +197,8 @@ static long init_record(calcoutRecord *prec, int pass)
callbackSetUser(prec, &prpvt->checkLinkCb);
prpvt->cbScheduled = 0;
+ prec->epvt = eventNameToHandle(prec->oevt);
+
if (pcalcoutDSET->init_record) pcalcoutDSET->init_record(prec);
prec->pval = prec->val;
prec->mlst = prec->val;
@@ -360,6 +362,9 @@ static long special(DBADDR *paddr, int after)
}
db_post_events(prec, plinkValid, DBE_VALUE);
return 0;
+ case(calcoutRecordOEVT):
+ prec->epvt = eventNameToHandle(prec->oevt);
+ return 0;
default:
recGblDbaddrError(S_db_badChoice, paddr, "calc: special");
return(S_db_badChoice);
@@ -543,27 +548,21 @@ static void execOutput(calcoutRecord *prec)
if (prec->nsev < INVALID_ALARM ) {
/* Output the value */
status = writeValue(prec);
- /* post event if output event != 0 */
- if (prec->oevt > 0) {
- post_event((int)prec->oevt);
- }
+ /* post output event if set */
+ if (prec->epvt) postEvent(prec->epvt);
} else switch (prec->ivoa) {
case menuIvoaContinue_normally:
status = writeValue(prec);
- /* post event if output event != 0 */
- if (prec->oevt > 0) {
- post_event((int)prec->oevt);
- }
+ /* post output event if set */
+ if (prec->epvt) postEvent(prec->epvt);
break;
case menuIvoaDon_t_drive_outputs:
break;
case menuIvoaSet_output_to_IVOV:
prec->oval = prec->ivov;
status = writeValue(prec);
- /* post event if output event != 0 */
- if (prec->oevt > 0) {
- post_event((int)prec->oevt);
- }
+ /* post output event if set */
+ if (prec->epvt) postEvent(prec->epvt);
break;
default:
status = -1;
diff --git a/src/std/rec/calcoutRecord.dbd b/src/std/rec/calcoutRecord.dbd
index fc393a782..bc916c961 100644
--- a/src/std/rec/calcoutRecord.dbd
+++ b/src/std/rec/calcoutRecord.dbd
@@ -255,10 +255,19 @@ recordtype(calcout) {
prompt("OCAL Valid")
interest(1)
}
- field(OEVT,DBF_USHORT) {
+ field(OEVT,DBF_STRING) {
prompt("Event To Issue")
promptgroup(GUI_CLOCK)
+ special(SPC_MOD)
asl(ASL0)
+ size(40)
+ }
+ %#include "dbScan.h"
+ field(EPVT, DBF_NOACCESS) {
+ prompt("Event private")
+ special(SPC_NOMOD)
+ interest(4)
+ extra("EVENTPVT epvt")
}
field(IVOA,DBF_MENU) {
prompt("INVALID output action")
diff --git a/src/std/rec/eventRecord.c b/src/std/rec/eventRecord.c
index b8cc2b208..435666ccf 100644
--- a/src/std/rec/eventRecord.c
+++ b/src/std/rec/eventRecord.c
@@ -32,6 +32,7 @@
#include "errMdef.h"
#include "recSup.h"
#include "recGbl.h"
+#include "special.h"
#include "menuYesNo.h"
#define GEN_SIZE_OFFSET
#include "eventRecord.h"
@@ -43,7 +44,7 @@
#define initialize NULL
static long init_record(eventRecord *, int);
static long process(eventRecord *);
-#define special NULL
+static long special(DBADDR *, int);
static long get_value(eventRecord *, struct valueDes *);
#define cvt_dbaddr NULL
#define get_array_info NULL
@@ -103,9 +104,11 @@ static long init_record(eventRecord *prec, int pass)
}
if (prec->siol.type == CONSTANT) {
- recGblInitConstantLink(&prec->siol,DBF_USHORT,&prec->sval);
+ recGblInitConstantLink(&prec->siol,DBF_STRING,&prec->sval);
}
+ prec->epvt = eventNameToHandle(prec->val);
+
if( (pdset=(struct eventdset *)(prec->dset)) && (pdset->init_record) )
status=(*pdset->init_record)(prec);
return(status);
@@ -123,7 +126,7 @@ static long process(eventRecord *prec)
if ( !pact && prec->pact ) return(0);
prec->pact = TRUE;
- if(prec->val>0) post_event((int)prec->val);
+ postEvent(prec->epvt);
recGblGetTimeStamp(prec);
@@ -137,10 +140,22 @@ static long process(eventRecord *prec)
return(status);
}
+
+static long special(DBADDR *paddr, int after)
+{
+ eventRecord *prec = (eventRecord *)paddr->precord;
+ if (!after) return 0;
+ if (dbGetFieldIndex(paddr) == eventRecordVAL) {
+ prec->epvt = eventNameToHandle(prec->val);
+ }
+ return 0;
+}
+
+
static long get_value(eventRecord *prec, struct valueDes *pvdes)
{
- pvdes->field_type = DBF_USHORT;
+ pvdes->field_type = DBF_STRING;
pvdes->no_elements=1;
pvdes->pvalue = (void *)(&prec->val);
return(0);
@@ -177,10 +192,13 @@ static long readValue(eventRecord *prec)
return(status);
}
if (prec->simm == menuYesNoYES){
- status=dbGetLink(&(prec->siol),DBR_USHORT,
+ status=dbGetLink(&(prec->siol),DBR_STRING,
&(prec->sval),0,0);
if (status==0) {
- prec->val=prec->sval;
+ if (strcmp(prec->sval, prec->val) != 0) {
+ strcpy(prec->val, prec->sval);
+ prec->epvt = eventNameToHandle(prec->val);
+ }
prec->udf=FALSE;
}
} else {
diff --git a/src/std/rec/eventRecord.dbd b/src/std/rec/eventRecord.dbd
index f63355900..842d2b1c0 100644
--- a/src/std/rec/eventRecord.dbd
+++ b/src/std/rec/eventRecord.dbd
@@ -9,10 +9,19 @@
#*************************************************************************
recordtype(event) {
include "dbCommon.dbd"
- field(VAL,DBF_USHORT) {
- prompt("Event Number To Post")
+ field(VAL,DBF_STRING) {
+ prompt("Event Name To Post")
promptgroup(GUI_INPUTS)
+ special(SPC_MOD)
asl(ASL0)
+ size(40)
+ }
+ %#include "dbScan.h"
+ field(EPVT, DBF_NOACCESS) {
+ prompt("Event private")
+ special(SPC_NOMOD)
+ interest(4)
+ extra("EVENTPVT epvt")
}
field(INP,DBF_INLINK) {
prompt("Input Specification")
@@ -24,8 +33,9 @@ recordtype(event) {
promptgroup(GUI_INPUTS)
interest(1)
}
- field(SVAL,DBF_USHORT) {
+ field(SVAL,DBF_STRING) {
prompt("Simulation Value")
+ size(40)
}
field(SIML,DBF_INLINK) {
prompt("Sim Mode Location")