#ifndef NDPluginDriver_H #define NDPluginDriver_H #include #include #include #include #include #include "asynNDArrayDriver.h" class Throttler; // This class defines the object that is contained in the std::multilist for sorting output NDArrays // It contains a pointer to the NDArray and the time that the object was added to the list // It defines the < operator to use the NDArray::uniqueId field as the sort key // We would like to hide this class definition in NDPluginDriver.cpp and just forward reference it here. // That works on Visual Studio, and on gcc if instantiating plugins as heap variables with "new", but fails on gcc // if instantiating plugins as automatic variables. //class sortedListElement; class sortedListElement { public: sortedListElement(NDArray *pArray, epicsTimeStamp time); friend bool operator<(const sortedListElement& lhs, const sortedListElement& rhs) { return (lhs.pArray_->uniqueId < rhs.pArray_->uniqueId); } NDArray *pArray_; epicsTimeStamp insertionTime_; }; #define NDPluginDriverArrayPortString "NDARRAY_PORT" /**< (asynOctet, r/w) The port for the NDArray interface */ #define NDPluginDriverArrayAddrString "NDARRAY_ADDR" /**< (asynInt32, r/w) The address on the port */ #define NDPluginDriverPluginTypeString "PLUGIN_TYPE" /**< (asynOctet, r/o) The type of plugin */ #define NDPluginDriverDroppedArraysString "DROPPED_ARRAYS" /**< (asynInt32, r/w) Number of dropped input arrays */ #define NDPluginDriverQueueSizeString "QUEUE_SIZE" /**< (asynInt32, r/w) Total queue elements */ #define NDPluginDriverQueueFreeString "QUEUE_FREE" /**< (asynInt32, r/w) Free queue elements */ #define NDPluginDriverMaxThreadsString "MAX_THREADS" /**< (asynInt32, r/w) Maximum number of threads */ #define NDPluginDriverNumThreadsString "NUM_THREADS" /**< (asynInt32, r/w) Number of threads */ #define NDPluginDriverSortModeString "SORT_MODE" /**< (asynInt32, r/w) sorted callback mode */ #define NDPluginDriverSortTimeString "SORT_TIME" /**< (asynFloat64, r/w) sorted callback time */ #define NDPluginDriverSortSizeString "SORT_SIZE" /**< (asynInt32, r/o) std::multiset maximum # elements */ #define NDPluginDriverSortFreeString "SORT_FREE" /**< (asynInt32, r/o) std::multiset free elements */ #define NDPluginDriverDisorderedArraysString "DISORDERED_ARRAYS" /**< (asynInt32, r/o) Number of out of order output arrays */ #define NDPluginDriverDroppedOutputArraysString "DROPPED_OUTPUT_ARRAYS" /**< (asynInt32, r/o) Number of dropped output arrays */ #define NDPluginDriverEnableCallbacksString "ENABLE_CALLBACKS" /**< (asynInt32, r/w) Enable callbacks from driver (1=Yes, 0=No) */ #define NDPluginDriverBlockingCallbacksString "BLOCKING_CALLBACKS" /**< (asynInt32, r/w) Callbacks block (1=Yes, 0=No) */ #define NDPluginDriverProcessPluginString "PROCESS_PLUGIN" /**< (asynInt32, r/w) Process plugin with last callback array */ #define NDPluginDriverExecutionTimeString "EXECUTION_TIME" /**< (asynFloat64, r/o) The last execution time (milliseconds) */ #define NDPluginDriverMinCallbackTimeString "MIN_CALLBACK_TIME" /**< (asynFloat64, r/w) Minimum time between calling processCallbacks *to execute plugin code */ #define NDPluginDriverMaxByteRateString "MAX_BYTE_RATE" /**< (asynFloat64, r/w) Limit on byte rate output of plugin */ /** Class from which actual plugin drivers are derived; derived from asynNDArrayDriver */ class epicsShareClass NDPluginDriver : public asynNDArrayDriver, public epicsThreadRunable { public: NDPluginDriver(const char *portName, int queueSize, int blockingCallbacks, const char *NDArrayPort, int NDArrayAddr, int maxAddr, int maxBuffers, size_t maxMemory, int interfaceMask, int interruptMask, int asynFlags, int autoConnect, int priority, int stackSize, int maxThreads, bool compressionAware = false); ~NDPluginDriver(); /* These are the methods that we override from asynNDArrayDriver */ virtual asynStatus writeInt32(asynUser *pasynUser, epicsInt32 value); virtual asynStatus writeFloat64(asynUser *pasynUser, epicsFloat64 value); virtual asynStatus writeOctet(asynUser *pasynUser, const char *value, size_t maxChars, size_t *nActual); virtual asynStatus readInt32Array(asynUser *pasynUser, epicsInt32 *value, size_t nElements, size_t *nIn); /* These are the methods that are new to this class */ virtual void driverCallback(asynUser *pasynUser, void *genericPointer); virtual void run(void); virtual asynStatus start(void); void sortingTask(); protected: virtual void processCallbacks(NDArray *pArray) = 0; virtual void beginProcessCallbacks(NDArray *pArray); virtual asynStatus endProcessCallbacks(NDArray *pArray, bool copyArray=false, bool readAttributes=true); virtual asynStatus connectToArrayPort(void); virtual asynStatus setArrayInterrupt(int connect); protected: int NDPluginDriverArrayPort; #define FIRST_NDPLUGIN_PARAM NDPluginDriverArrayPort int NDPluginDriverArrayAddr; int NDPluginDriverPluginType; int NDPluginDriverDroppedArrays; int NDPluginDriverQueueSize; int NDPluginDriverQueueFree; int NDPluginDriverMaxThreads; int NDPluginDriverNumThreads; int NDPluginDriverSortMode; int NDPluginDriverSortTime; int NDPluginDriverSortSize; int NDPluginDriverSortFree; int NDPluginDriverDisorderedArrays; int NDPluginDriverDroppedOutputArrays; int NDPluginDriverEnableCallbacks; int NDPluginDriverBlockingCallbacks; int NDPluginDriverProcessPlugin; int NDPluginDriverExecutionTime; int NDPluginDriverMinCallbackTime; int NDPluginDriverMaxByteRate; NDArray *pPrevInputArray_; bool throttled(NDArray *pArray); private: void processTask(); asynStatus createCallbackThreads(); asynStatus startCallbackThreads(); asynStatus deleteCallbackThreads(); asynStatus createSortingThread(); /* The asyn interfaces we access as a client */ void *asynGenericPointerInterruptPvt_; /* Our data */ int numThreads_; bool pluginStarted_; bool firstOutputArray_; asynUser *pasynUserGenericPointer_; /**< asynUser for connecting to NDArray driver */ void *asynGenericPointerPvt_; /**< Handle for connecting to NDArray driver */ asynGenericPointer *pasynGenericPointer_; /**< asyn interface for connecting to NDArray driver */ bool connectedToArrayPort_; std::vectorpThreads_; epicsMessageQueue *pToThreadMsgQ_; epicsMessageQueue *pFromThreadMsgQ_; std::multiset sortedNDArrayList_; int prevUniqueId_; epicsThreadId sortingThreadId_; epicsTimeStamp lastProcessTime_; int dimsPrev_[ND_ARRAY_MAX_DIMS]; bool compressionAware_; Throttler *throttler_; }; #endif