Merge 3.16 branch into 7.0

modules/database/src/ioc/db/Makefile

@@ -61,7 +61,7 @@ DBDINC += menuScan
 DBDINC += dbCommon
 
 dbMenusPod = $(notdir $(wildcard ../db/menu*.dbd.pod))
-HTMLS += $(patsubst %.dbd.pod,%.html,$(menusPod))
+HTMLS += $(patsubst %.dbd.pod,%.html,$(dbMenusPod))
 
 dbCore_SRCS += dbLock.c
 dbCore_SRCS += dbAccess.c

modules/database/src/ioc/db/callback.c

@@ -54,6 +54,7 @@ typedef struct cbQueueSet {
     epicsEventId semWakeUp;
     epicsRingPointerId queue;
     int queueOverflow;
+    int queueOverflows;
     int shutdown;
     int threadsConfigured;
     int threadsRunning;
@@ -103,6 +104,51 @@ int callbackSetQueueSize(int size)
     return 0;
 }
 
+int callbackQueueStatus(const int reset, callbackQueueStats *result)
+{
+    int ret;
+    if (!callbackIsInit) return -1;
+    if (result) {
+        int prio;
+        result->size = callbackQueueSize;
+        for(prio = 0; prio < NUM_CALLBACK_PRIORITIES; prio++) {
+            epicsRingPointerId qId = callbackQueue[prio].queue;
+            result->numUsed[prio] = epicsRingPointerGetUsed(qId);
+            result->maxUsed[prio] = epicsRingPointerGetHighWaterMark(qId);
+            result->numOverflow[prio] = epicsAtomicGetIntT(&callbackQueue[prio].queueOverflows);
+        }
+        ret = 0;
+    } else {
+        ret = -2;
+    }
+    if (reset) {
+        int prio;
+        for(prio = 0; prio < NUM_CALLBACK_PRIORITIES; prio++) {
+            epicsRingPointerResetHighWaterMark(callbackQueue[prio].queue);
+        }
+    }
+    return ret;
+}
+
+void callbackQueueShow(const int reset)
+{
+    callbackQueueStats stats;
+    if (callbackQueueStatus(reset, &stats) == -1) {
+        fprintf(stderr, "Callback system not initialized, yet. Please run "
+            "iocInit before using this command.\n");
+    } else {
+        int prio;
+        printf("PRIORITY  HIGH-WATER MARK  ITEMS IN Q  Q SIZE  %% USED  Q OVERFLOWS\n");
+        for (prio = 0; prio < NUM_CALLBACK_PRIORITIES; prio++) {
+            double qusage = 100.0 * stats.numUsed[prio] / stats.size;
+            printf("%8s  %15d  %10d  %6d  %6.1f  %11d\n",
+                   threadNamePrefix[prio], stats.maxUsed[prio],
+                   stats.numUsed[prio], stats.size, qusage,
+                   stats.numOverflow[prio]);
+        }
+    }
+}
+
 int callbackParallelThreads(int count, const char *prio)
 {
     if (callbackIsInit) {
@@ -290,6 +336,7 @@ int callbackRequest(CALLBACK *pcallback)
     if (!pushOK) {
         epicsInterruptContextMessage(fullMessage[priority]);
         mySet->queueOverflow = TRUE;
+        epicsAtomicIncrIntT(&mySet->queueOverflows);
         return S_db_bufFull;
     }
     epicsEventSignal(mySet->semWakeUp);

modules/database/src/ioc/db/callback.h

@@ -48,6 +48,13 @@ typedef epicsCallback CALLBACK;
 
 typedef void    (*CALLBACKFUNC)(struct callbackPvt*);
 
+typedef struct callbackQueueStats {
+    int size;
+    int numUsed[NUM_CALLBACK_PRIORITIES];
+    int maxUsed[NUM_CALLBACK_PRIORITIES];
+    int numOverflow[NUM_CALLBACK_PRIORITIES];
+} callbackQueueStats;
+
 #define callbackSetCallback(PFUN, PCALLBACK) \
     ( (PCALLBACK)->callback = (PFUN) )
 #define callbackSetPriority(PRIORITY, PCALLBACK) \
@@ -73,6 +80,8 @@ epicsShareFunc void callbackCancelDelayed(CALLBACK *pcallback);
 epicsShareFunc void callbackRequestProcessCallbackDelayed(
     CALLBACK *pCallback, int Priority, void *pRec, double seconds);
 epicsShareFunc int callbackSetQueueSize(int size);
+epicsShareFunc int callbackQueueStatus(const int reset, callbackQueueStats *result);
+epicsShareFunc void callbackQueueShow(const int reset);
 epicsShareFunc int callbackParallelThreads(int count, const char *prio);
 
 #ifdef __cplusplus

modules/database/src/ioc/db/dbCa.c

@@ -703,7 +703,12 @@ static long doLocked(struct link *plink, dbLinkUserCallback rtn, void *priv)
     caLink *pca;
     long status;
 
-    pcaGetCheck
+    assert(plink);
+    if (plink->type != CA_LINK) return -1;
+    pca = (caLink *)plink->value.pv_link.pvt;
+    assert(pca);
+    epicsMutexMustLock(pca->lock);
+    assert(pca->plink);
     status = rtn(plink, priv);
     epicsMutexUnlock(pca->lock);
     return status;

modules/database/src/ioc/db/dbChannel.c

@@ -20,6 +20,7 @@
 #include "cantProceed.h"
 #include "epicsAssert.h"
 #include "epicsString.h"
+#include "epicsStdio.h"
 #include "errlog.h"
 #include "freeList.h"
 #include "gpHash.h"

modules/database/src/ioc/db/dbIocRegister.c

@@ -296,6 +296,17 @@ static void scanOnceSetQueueSizeCallFunc(const iocshArgBuf *args)
     scanOnceSetQueueSize(args[0].ival);
 }
 
+/* scanOnceQueueShow */
+static const iocshArg scanOnceQueueShowArg0 = { "reset",iocshArgInt};
+static const iocshArg * const scanOnceQueueShowArgs[1] =
+    {&scanOnceQueueShowArg0};
+static const iocshFuncDef scanOnceQueueShowFuncDef =
+    {"scanOnceQueueShow",1,scanOnceQueueShowArgs};
+static void scanOnceQueueShowCallFunc(const iocshArgBuf *args)
+{
+    scanOnceQueueShow(args[0].ival);
+}
+
 /* scanppl */
 static const iocshArg scanpplArg0 = { "rate",iocshArgDouble};
 static const iocshArg * const scanpplArgs[1] = {&scanpplArg0};
@@ -335,6 +346,17 @@ static void callbackSetQueueSizeCallFunc(const iocshArgBuf *args)
     callbackSetQueueSize(args[0].ival);
 }
 
+/* callbackQueueShow */
+static const iocshArg callbackQueueShowArg0 = { "reset", iocshArgInt};
+static const iocshArg * const callbackQueueShowArgs[1] =
+    {&callbackQueueShowArg0};
+static const iocshFuncDef callbackQueueShowFuncDef =
+    {"callbackQueueShow",1,callbackQueueShowArgs};
+static void callbackQueueShowCallFunc(const iocshArgBuf *args)
+{
+    callbackQueueShow(args[0].ival);
+}
+
 /* callbackParallelThreads */
 static const iocshArg callbackParallelThreadsArg0 = { "no of threads", iocshArgInt};
 static const iocshArg callbackParallelThreadsArg1 = { "priority", iocshArgString};
@@ -441,12 +463,14 @@ void dbIocRegister(void)
     iocshRegister(&dbLockShowLockedFuncDef,dbLockShowLockedCallFunc);
 
     iocshRegister(&scanOnceSetQueueSizeFuncDef,scanOnceSetQueueSizeCallFunc);
+    iocshRegister(&scanOnceQueueShowFuncDef,scanOnceQueueShowCallFunc);
     iocshRegister(&scanpplFuncDef,scanpplCallFunc);
     iocshRegister(&scanpelFuncDef,scanpelCallFunc);
     iocshRegister(&postEventFuncDef,postEventCallFunc);
     iocshRegister(&scanpiolFuncDef,scanpiolCallFunc);
 
     iocshRegister(&callbackSetQueueSizeFuncDef,callbackSetQueueSizeCallFunc);
+    iocshRegister(&callbackQueueShowFuncDef,callbackQueueShowCallFunc);
     iocshRegister(&callbackParallelThreadsFuncDef,callbackParallelThreadsCallFunc);
 
     /* Needed before callback system is initialized */

modules/database/src/ioc/db/dbScan.c

@@ -24,6 +24,7 @@
 #include "cantProceed.h"
 #include "dbDefs.h"
 #include "ellLib.h"
+#include "epicsAtomic.h"
 #include "epicsEvent.h"
 #include "epicsMutex.h"
 #include "epicsPrint.h"
@@ -63,6 +64,7 @@ static volatile enum ctl scanCtl;
 static int onceQueueSize = 1000;
 static epicsEventId onceSem;
 static epicsRingBytesId onceQ;
+static int onceQOverruns = 0;
 static epicsThreadId onceTaskId;
 static void *exitOnce;
 
@@ -676,6 +678,7 @@ int scanOnceCallback(struct dbCommon *precord, once_complete cb, void *usr)
     if (!pushOK) {
         if (newOverflow) errlogPrintf("scanOnce: Ring buffer overflow\n");
         newOverflow = FALSE;
+        epicsAtomicIncrIntT(&onceQOverruns);
     } else {
         newOverflow = TRUE;
     }
@@ -722,6 +725,40 @@ int scanOnceSetQueueSize(int size)
     return 0;
 }
 
+int scanOnceQueueStatus(const int reset, scanOnceQueueStats *result)
+{
+    int ret;
+    if (!onceQ) return -1;
+    if (result) {
+        result->size = epicsRingBytesSize(onceQ) / sizeof(onceEntry);
+        result->numUsed = epicsRingBytesUsedBytes(onceQ) / sizeof(onceEntry);
+        result->maxUsed = epicsRingBytesHighWaterMark(onceQ) / sizeof(onceEntry);
+        result->numOverflow = epicsAtomicGetIntT(&onceQOverruns);
+        ret = 0;
+    } else {
+        ret = -2;
+    }
+    if (reset) {
+        epicsRingBytesResetHighWaterMark(onceQ);
+    }
+    return ret;
+}
+
+void scanOnceQueueShow(const int reset)
+{
+    scanOnceQueueStats stats;
+    if (scanOnceQueueStatus(reset, &stats) == -1) {
+        fprintf(stderr, "scanOnce system not initialized, yet. Please run "
+            "iocInit before using this command.\n");
+    } else {
+        double qusage = 100.0 * stats.numUsed / stats.size;
+        printf("PRIORITY  HIGH-WATER MARK  ITEMS IN Q  Q SIZE  %% USED  Q OVERFLOWS\n");
+        printf("%8s  %15d  %10d  %6d  %6.1f  %11d\n", "scanOnce", stats.maxUsed,
+               stats.numUsed, stats.size, qusage,
+               epicsAtomicGetIntT(&onceQOverruns));
+    }
+}
+
 static void initOnce(void)
 {
     if ((onceQ = epicsRingBytesLockedCreate(sizeof(onceEntry)*onceQueueSize)) == NULL) {

modules/database/src/ioc/db/dbScan.h

@@ -42,6 +42,13 @@ struct dbCommon;
 typedef void (*io_scan_complete)(void *usr, IOSCANPVT, int prio);
 typedef void (*once_complete)(void *usr, struct dbCommon*);
 
+typedef struct scanOnceQueueStats {
+    int size;
+    int numUsed;
+    int maxUsed;
+    int numOverflow;
+} scanOnceQueueStats;
+
 epicsShareFunc long scanInit(void);
 epicsShareFunc void scanRun(void);
 epicsShareFunc void scanPause(void);
@@ -57,6 +64,8 @@ epicsShareFunc double scanPeriod(int scan);
 epicsShareFunc int scanOnce(struct dbCommon *);
 epicsShareFunc int scanOnceCallback(struct dbCommon *, once_complete cb, void *usr);
 epicsShareFunc int scanOnceSetQueueSize(int size);
+epicsShareFunc int scanOnceQueueStatus(const int reset, scanOnceQueueStats *result);
+epicsShareFunc void scanOnceQueueShow(const int reset);
 
 /*print periodic lists*/
 epicsShareFunc int scanppl(double rate);

modules/database/src/ioc/db/menuScan.dbd.pod

@@ -1,11 +1,48 @@
 #*************************************************************************
-# Copyright (c) 2008 UChicago Argonne LLC, as Operator of Argonne
+# Copyright (c) 2018 UChicago Argonne LLC, as Operator of Argonne
 #     National Laboratory.
 # Copyright (c) 2002 The Regents of the University of California, as
 #     Operator of Los Alamos National Laboratory.
 # EPICS BASE is distributed subject to a Software License Agreement found
 # in file LICENSE that is included with this distribution.
 #*************************************************************************
+
+=head1 Menu menuScan
+
+This menu is used for the C<SCAN> field of all record types.
+
+The set of periodic scan rates may be modified for an individual IOC by
+copying the F<menuScan.dbd> file from Base into the IOC's source
+directory and changing it to contain the desired scan rates.
+
+The scan periods are extracted from the choice strings at runtime, which
+must be expressed as a number with any of the following units appended:
+
+=over 4
+
+ second
+ seconds
+ minute
+ minutes
+ hour
+ hours
+ Hertz
+ Hz
+
+=back
+
+At IOC start-up a separate scan thread will be created for each period,
+with thread priority increasing further down the list, so faster periods
+should appear after slower ones.
+
+Scan rates that cannot be achieved will generate a warning message from
+the C<iocInit> command.
+
+
+=menu menuScan
+
+=cut
+
 menu(menuScan) {
 	choice(menuScanPassive,"Passive")
 	choice(menuScanEvent,"Event")