fix hanging 'in' command when it is the first command of the protocol and the device is offline

EPICS R3.15.6 dev guide

GNUmakefile

@@ -11,12 +11,8 @@ DOCUDIR = docs
 
 PCRE=1
 ASYN=1
-ifdef EPICSVERSION
-ifndef RECORDTYPES
-include src/CONFIG_STREAM
-export RECORDTYPES BUSSES FORMATS
-endif
-endif
+-include ../src/CONFIG_STREAM
+-include src/CONFIG_STREAM
 
 SOURCES += $(RECORDTYPES:%=src/dev%Stream.c)
 SOURCES += $(FORMATS:%=src/%Converter.cc)
@@ -32,9 +28,8 @@ HEADERS += StreamError.h
 StreamCore.o StreamCore.d: streamReferences
 
 # Update version string (contains __DATE__ and __TIME__)
-# each time make runs.
-StreamVersion.o: FORCE
-FORCE:
+# each time anything changes.
+StreamVersion.o: $(filter-out StreamVersion.o stream_exportAddress.o,$(LIBOBJS))
 
 streamReferences:
 	$(PERL) ../src/makeref.pl Interface $(BUSSES) > $@

README.md

@@ -1,6 +1,6 @@
 # StreamDevice
 
-_StreamDevice_ is a generic [EPICS](https://www.aps.anl.gov/epics)
+_StreamDevice_ is a generic [EPICS](https://epics.anl.gov/)
 device support for devices with a "byte stream" based
 communication interface.
 That means devices that can be controlled by sending and receiving

configure/RELEASE

@@ -14,14 +14,21 @@ TEMPLATE_TOP=$(EPICS_BASE)/templates/makeBaseApp/top
 # define INSTALL_LOCATION_APP here
 #INSTALL_LOCATION_APP=<fullpathname>
 
+# For SynApps:
+RELEASE=
 
-EPICS_BASE=/usr/local/epics/base-3.16.1
-ASYN=~/top-3.16/asyn4-30
-CALC=~/top-3.16/SynApps/calc-2-8
-PCRE=~/top-3.16/pcre-7-2
-PCRE_INCLUDE_SL6-x86=/usr/include
-PCRE_INCLUDE_SL6-x86_64=/usr/include
-PCRE_INCLUDE_SL6-x86_64-clang=/usr/include
+EPICS_BASE=/usr/local/epics/base-7.0.1
+ASYN=~/top-7/asyn4-33
+CALC=~/top-7/SynApps/calc-2-8
+PCRE=~/top-7/pcre-7-2
+
+#EPICS_BASE=/usr/local/epics/base-3.16.1
+#ASYN=~/top-3.16/asyn4-30
+#CALC=~/top-3.16/SynApps/calc-2-8
+#PCRE=~/top-3.16/pcre-7-2
+#PCRE_INCLUDE_SL6-x86=/usr/include
+#PCRE_INCLUDE_SL6-x86_64=/usr/include
+#PCRE_INCLUDE_SL6-x86_64-clang=/usr/include
 
 #EPICS_BASE=/usr/local/epics/base-3.15.5
 #ASYN=~/top-3.15/asyn4-30

docs/formatconverter.html

@@ -53,7 +53,7 @@ RegisterConverter(MyConverter,"Q");
 </pre>
 
 <a name="theory"></a>
-<h2>Theroy of Operation</h2>
+<h2>Theory of Operation</h2>
 
 <a name="registration"></a>
 <h3>Registration </h3>

docs/index.html

@@ -15,7 +15,7 @@
 <h2>What is <em>StreamDevice</em>?</h2>
 <p>
 <em>StreamDevice</em> is a generic
-<a href="https://www.aps.anl.gov/epics" target="ex">EPICS</a>
+<a href="https://epics.anl.gov/" target="ex">EPICS</a>
 device support for devices with a "byte stream" based
 communication interface.
 That means devices that can be controlled by sending and
@@ -98,7 +98,7 @@ come in a predictible order to be parsable by <em>StreamDevice</em>.
 IOC Application Developer's Guide:
 <a href="https://epics.anl.gov/base/R3-14/12-docs/AppDevGuide/"
 target="ex">R3.14.12</a>,
-<a href="https://epics.anl.gov/base/R3-15/5-docs/AppDevGuide/AppDevGuide.html"
+<a href="https://epics.anl.gov/base/R3-15/6-docs/AppDevGuide/AppDevGuide.html"
 target="ex">R3.15.5</a>,
 <a href="https://epics.anl.gov/base/R3-16/1-docs/AppDevGuide/AppDevGuide.html"
 target="ex">R3.16.1</a>

docs/mbbo.html

@@ -23,7 +23,7 @@ written or read value.
   <dd>
    Not allowed.
   </dd>
- <dt>LONG format (e.g. <code>%i</code>):</dt>
+ <dt>LONG <span class=new>or ENUM</span> format (e.g. <code>%i</code>):</dt>
   <dd>
    <dl>
     <dt>If any of <code>ZRVL</code> ... <code>FFVL</code> is set
@@ -41,17 +41,12 @@ written or read value.
      </dd>
     <dt>If none of <code>ZRVL</code> ... <code>FFVL</code> is set
         (all are <code>0</code>):</dt>
-     <dd>
-      <u>Output:</u> <code><i>x</i>=VAL</code><br>
-      <u>Input:</u> <code>VAL=<i>x</i></code><br>
+     <dd class=new>
+      <u>Output:</u> <code><i>x</i>=(VAL&lt;&lt;SHFT)&amp;MASK</code><br>
+      <u>Input:</u> <code>VAL=(RBV=(<i>x</i>&amp;MASK))&gt;&gt;SHFT</code><br>
      </dd>
     </dl>
   </dd>
- <dt>ENUM format (e.g. <code>%{</code>):</dt>
-  <dd>
-   <u>Output:</u> <code><i>x</i>=VAL</code><br>
-   <u>Input:</u> <code>VAL=<i>x</i></code><br>
-  </dd>
  <dt>STRING format (e.g. <code>%s</code>):</dt>
   <dd>
    <u>Output:</u> Depending on <code>VAL</code>, one of <code>ZRST</code>

docs/processing.html

@@ -16,7 +16,7 @@
 <h2>1. Normal Processing</h2>
 <p>
 <em>StreamDevice</em> is an asynchronous device support
-(see <a href="http://www.aps.anl.gov/epics/base/R3-14/8-docs/AppDevGuide.pdf"
+(see <a href="http://www.aps.anl.gov/epics/base/R3-14/12-docs/AppDevGuide.pdf"
 target="ex">IOC Application Developer's Guide</a> chapter 12:
 Device Support).
 Whenever the record is processed, the <a href="protocol.html">protocol</a>

docs/scalcout.html

@@ -15,7 +15,7 @@
 <p>
 <b>Note:</b> The scalcout record is part of the <i>calc</i> module of
 the <a target="ex"
-href="http://www.aps.anl.gov/aod/bcda/synApps/index.php"
+href="https://www.aps.anl.gov/BCDA/synApps"
 ><em>synApps</em></a> package.
 Device support for scalcout records is only available for <i>calc</i>
 module release 2-4 or higher.

src/Makefile

@@ -74,7 +74,7 @@ CPPFLAGS += -DUSE_TYPED_RSET
 -include $(TOP)/configure/RULES
 
 # Update version string whenever something changes
-StreamVersion$(OBJ): ../*.c ../*.h ../*.cc ../CONFIG_STREAM
+StreamVersion$(OBJ): $(filter-out StreamVersion.o,$(LIBOBJS)$(LIBRARY_OBJS))
 
 # Add references to all registrars to main file to avoid
 # missing initialization.
@@ -86,10 +86,7 @@ streamReferences: ../CONFIG_STREAM
 
 # create stream.dbd from all RECORDTYPES
 $(COMMON_DIR)/$(LIBRARY_DEFAULT).dbd: ../CONFIG_STREAM
-	$(PERL) ../makedbd.pl $(RECORDTYPES) > $@
-ifdef ASYN
-	echo "registrar(AsynDriverInterfaceRegistrar)" >> $@
-endif
+	$(PERL) ../makedbd.pl $(if $(ASYN),--with-asyn) $(if $(BASE_3_14),,-3.13) $(RECORDTYPES) > $@
 
 $(LIBRARY_DEFAULT).dbd$(DEP): ../CONFIG_STREAM
 	echo $(LIBRARY_DEFAULT).dbd: $< > $@

src/StreamBuffer.cc

@@ -17,6 +17,11 @@
 *                                                              *
 ***************************************************************/
 
+// Make sure that vsnprintf is available
+#ifndef _BSD_SOURCE
+#define _BSD_SOURCE
+#endif
+
 #include "StreamBuffer.h"
 #include "StreamError.h"
 
@@ -24,10 +29,47 @@
 #include <stdarg.h>
 #include <stdlib.h>
 
-#if defined(__vxworks) || defined(vxWorks) || defined(_WIN32) || defined(__rtems__)
-// These systems have no vsnprintf
-#define vsnprintf(p,l,f,v) vsprintf(p,f,v)
-#endif
+#ifdef vxWorks
+#include <version.h>
+#ifndef _WRS_VXWORKS_MAJOR
+// VxWorks 5 has no vsnprintf
+// Implementation taken from EPICS 3.14
+
+#include <vxWorks.h>
+#include <fioLib.h>
+
+struct outStr_s {
+    char *str;
+    int free;
+};
+
+static STATUS outRoutine(char *buffer, int nchars, int outarg) {
+    struct outStr_s *poutStr = (struct outStr_s *) outarg;
+    int free = poutStr->free;
+    int len;
+
+    if (free < 1) { /*let fioFormatV continue to count length*/
+        return OK;
+    } else if (free > 1) {
+        len = min(free-1, nchars);
+        strncpy(poutStr->str, buffer, len);
+        poutStr->str += len;
+        poutStr->free -= len;
+    }
+    /*make sure final string is null terminated*/
+    *poutStr->str = 0;
+    return OK;
+}
+
+int vsnprintf(char *str, size_t size, const char *format, va_list ap) {
+    struct outStr_s outStr;
+
+    outStr.str = str;
+    outStr.free = size;
+    return fioFormatV(format, ap, (FUNCPTR)outRoutine, (int)&outStr);
+}
+#endif // ! _WRS_VXWORKS_MAJOR
+#endif // vxWorks
 
 #define P PRINTF_SIZE_T_PREFIX
 
@@ -296,7 +338,7 @@ StreamBuffer StreamBuffer::expand(ssize_t start, ssize_t length) const
     {
         c = buffer[i];
         if (c < 0x20 || c >= 0x7f)
-            result.print("\033[1m<%02x>\033[22m", c & 0xff);
+            result.print("\033[7m<%02x>\033[27m", c & 0xff);
         else
             result.append(c);
     }
@@ -316,7 +358,7 @@ dump() const
         c = buffer[i];
         if (offs && i == offs) result.append("\033[0m");
         if (c < 0x20 || c >= 0x7f)
-            result.print("\033[1m<%02x>\033[22m", c & 0xff);
+            result.print("\033[7m<%02x>\033[27m", c & 0xff);
         else
             result.append(c);
         if (i == offs+len-1) result.append("\033[47m");

src/StreamCore.cc

@@ -919,14 +919,12 @@ evalIn()
             busUnlock();
             flags &= ~BusOwner;
         }
-        busReadRequest(pollPeriod, readTimeout,
+        return busReadRequest(pollPeriod, readTimeout,
             expectedInput, true);
-        return true;
     }
-    busReadRequest(replyTimeout, readTimeout,
+    return busReadRequest(replyTimeout, readTimeout,
         expectedInput, false);
     // continue with readCallback() in another thread
-    return true;
 }
 
 ssize_t StreamCore::
@@ -1315,12 +1313,12 @@ normal_format:
                 break;
             }
             case StreamProtocolParser::skip:
-                // ignore next input byte
-                consumedInput++;
+                // ignore next input byte (if exists)
+                if (consumedInput < inputLine.length()) consumedInput++;
                 break;
             case StreamProtocolParser::whitespace:
                 // any number of whitespace (including 0)
-                while (isspace(inputLine[consumedInput])) consumedInput++;
+                while (consumedInput < inputLine.length() && isspace(inputLine[consumedInput])) consumedInput++;
                 break;
             case esc:
                 // escaped literal byte

src/StreamEpics.cc

@@ -831,7 +831,7 @@ initRecord(const char* filename, const char* protocol,
         return ERROR;
     }
     debug("Stream::initRecord %s: initialized. %s\n",
-        name(), convert==2 ?
+        name(), convert == DO_NOT_CONVERT ?
             "convert" : "don't convert");
     return convert;
 }
@@ -843,6 +843,7 @@ process()
     debug("Stream::process(%s)\n", name());
     if (record->pact || record->scan == SCAN_IO_EVENT)
     {
+        record->proc = 0;
         if (status != NO_ALARM)
         {
             debug("Stream::process(%s) error status=%s (%d)\n",
@@ -854,7 +855,7 @@ process()
             return false;
         }
         debug("Stream::process(%s) ready. %s\n",
-            name(), convert==2 ?
+            name(), convert == DO_NOT_CONVERT ?
             "convert" : "don't convert");
         return true;
     }
@@ -868,11 +869,15 @@ process()
     debug("Stream::process(%s) start\n", name());
     status = NO_ALARM;
     convert = OK;
-    if (!startProtocol(record->proc==2 ? StreamCore::StartInit : StreamCore::StartNormal))
+    if (!startProtocol(record->proc == 2 ? StreamCore::StartInit : StreamCore::StartNormal))
     {
-        debug("Stream::process(%s): could not start %sprotocol, status=%d\n",
-            name(), record->proc==2 ? "@init " : "", status);
+        debug("Stream::process(%s): could not start %sprotocol, status=%s (%d)\n",
+            name(), record->proc == 2 ? "@init " : "", 
+                status >= 0 && status < ALARM_NSTATUS ?
+                    epicsAlarmConditionStrings[status] : "ERROR",
+            status);
         (void) recGblSetSevr(record, status ? status : UDF_ALARM, INVALID_ALARM);
+        record->proc = 0;
         return false;
     }
     debug("Stream::process(%s): protocol started\n", name());
@@ -920,7 +925,7 @@ scan(format_t *format, void* value, size_t maxStringSize)
             currentValueLength = scanValue(*format->priv, *(double*)value);
             break;
         case DBF_STRING:
-            currentValueLength  = scanValue(*format->priv, (char*)value, size);
+            currentValueLength = scanValue(*format->priv, (char*)value, size);
             break;
         default:
             error("INTERNAL ERROR (%s): Illegal format type %d\n",
@@ -1083,7 +1088,7 @@ getFieldAddress(const char* fieldname, StreamBuffer& address)
         // FIELD in this record or VAL in other record
         StreamBuffer fullname;
         fullname.print("%s.%s", name(), fieldname);
-        if (dbNameToAddr(fullname(), &dbaddr) != OK)
+        if (dbNameToAddr(fullname(), &dbaddr) != OK || strcmp(((dbFldDes*)dbaddr.pfldDes)->name, fieldname) != 0)
         {
             // VAL in other record
             fullname.clear().print("%s.VAL", fieldname);

src/StreamError.cc

@@ -18,6 +18,9 @@
 ***************************************************************/
 
 #include "StreamError.h"
+#ifdef _WIN32
+#include <windows.h>
+#endif
 #include <string.h>
 #include <time.h>
 #include <stdio.h>
@@ -39,6 +42,18 @@ FILE *StreamDebugFile = NULL;
 
 #ifdef _WIN32
 #define localtime_r(timet,tm) localtime_s(tm,timet)
+
+/* Enable ANSI colors in Windows console */
+static int win_console_init() {
+	DWORD dwMode = 0;
+    HANDLE hCons = GetStdHandle(STD_ERROR_HANDLE);
+	GetConsoleMode(hCons, &dwMode);
+	dwMode |= ENABLE_VIRTUAL_TERMINAL_PROCESSING;
+	SetConsoleMode(hCons, dwMode);
+	return 0;
+}
+static int s = win_console_init();
+
 #endif
 
 /* You can globally change the printTimestamp function
@@ -115,4 +130,3 @@ print(const char* fmt, ...)
     va_end(args);
     return 1;
 }
-

src/devStream.h

@@ -32,7 +32,6 @@ extern "C" {
 
 #define STREAM_MAJOR 2
 #define STREAM_MINOR 8
-#define STREAM_PATCHLEVEL 0
 
 #ifndef OK
 #define OK 0

src/devmbboStream.c

@@ -33,11 +33,12 @@ static long readData(dbCommon *record, format_t *format)
     {
         case DBF_ULONG:
         case DBF_LONG:
+        case DBF_ENUM:
         {
             if (streamScanf(record, format, &val) == ERROR) return ERROR;
+            if (mbbo->mask) val &= mbbo->mask;
             mbbo->rbv = val;
             mbbo->rval = val;
-            if (mbbo->mask) val &= mbbo->mask;
             if (mbbo->shft > 0) val >>= mbbo->shft;
             /* read VAL or RBV? Look if any value is defined */
             if (mbbo->sdef)
@@ -56,17 +57,12 @@ static long readData(dbCommon *record, format_t *format)
             mbbo->val = (epicsEnum16)val;
             break;
         }
-        case DBF_ENUM:
-        {
-            if (streamScanf(record, format, &val) == ERROR) return ERROR;
-            mbbo->val = (epicsEnum16)val;
-            break;
-        }
         case DBF_STRING:
         {
             char buffer[sizeof(mbbo->zrst)];
             if (streamScanfN(record, format, buffer, sizeof(buffer)) == ERROR)
                 return ERROR;
+            mbbo->val = 65535; /* initalize to unknown state*/
             for (val = 0; val < 16; val++)
             {
                 if (strcmp ((&mbbo->zrst)[val], buffer) == 0)
@@ -75,6 +71,7 @@ static long readData(dbCommon *record, format_t *format)
                     break;
                 }
             }
+            break;
         }
         default:
             return ERROR;
@@ -82,12 +79,21 @@ static long readData(dbCommon *record, format_t *format)
     if (record->pact) return DO_NOT_CONVERT;
     /* In @init handler, no processing, enforce monitor updates. */
     monitor_mask = recGblResetAlarms(record);
+    if (mbbo->val > 15) {
+        recGblSetSevr(record, STATE_ALARM, mbbo->unsv);
+    } else {
+        recGblSetSevr(record, STATE_ALARM, (&(mbbo->zrsv))[mbbo->val]);
+    }
+    mbbo->lalm = mbbo->val;
+    if (mbbo->val != mbbo->lalm) {
+        if (!recGblSetSevr(record, COS_ALARM, mbbo->cosv)) mbbo->lalm = mbbo->val;
+    }
     if (mbbo->mlst != mbbo->val)
     {
         monitor_mask |= (DBE_VALUE | DBE_LOG);
         mbbo->mlst = mbbo->val;
     }
-    if (monitor_mask){
+    if (monitor_mask) {
         db_post_events(record, &mbbo->val, monitor_mask);
     }
     if (mbbo->oraw != mbbo->rval) {
@@ -110,39 +116,38 @@ static long writeData(dbCommon *record, format_t *format)
     switch (format->type)
     {
         case DBF_ULONG:
+        case DBF_ENUM:
             /* print VAL or RVAL ? */
             val = mbbo->val;
+            if (mbbo->shft > 0) val <<= mbbo->shft;
             if (mbbo->sdef) for (i=0; i<16; i++)
             {
                 if ((&mbbo->zrvl)[i])
                 {
                     /* any values defined ? */
                     val = mbbo->rval;
-                    if (mbbo->mask) val &= mbbo->mask;
                     break;
                 }
             }
+            if (mbbo->mask) val &= mbbo->mask;
             return streamPrintf(record, format, val);
         case DBF_LONG:
         {
             /* print VAL or RVAL ? */
             val = (epicsInt16)mbbo->val;
+            if (mbbo->shft > 0) val <<= mbbo->shft;
             if (mbbo->sdef) for (i=0; i<16; i++)
             {
                 if ((&mbbo->zrvl)[i])
                 {
                     /* any values defined ? */
                     val = (epicsInt32)mbbo->rval;
-                    if (mbbo->mask) val &= mbbo->mask;
                     break;
                 }
             }
+            if (mbbo->mask) val &= mbbo->mask;
             return streamPrintf(record, format, val);
         }
-        case DBF_ENUM:
-        {
-            return streamPrintf(record, format, mbbo->val);
-        }
         case DBF_STRING:
         {
             if (mbbo->val >= 16) return ERROR;

src/makedbd.pl

@@ -1,9 +1,14 @@
-if (@ARGV[0] == "-3.13") {
+if (@ARGV[0] eq "--with-asyn") {
+    shift;
+    $asyn = 1;
+}
+if (@ARGV[0] eq "-3.13") {
     shift;
 } else {
     print "variable(streamDebug, int)\n";
     print "variable(streamError, int)\n";
     print "registrar(streamRegistrar)\n";
+    if ($asyn) { print "registrar(AsynDriverInterfaceRegistrar)\n"; }
 }
 print "driver(stream)\n";
 for (@ARGV) {

streamApp/tests/testFormats

@@ -54,8 +54,6 @@ set debug 0
 startioc
 
 # Some formats give different results on 32 bit and 64 bit machines.
-# This occurs when printing negative numbers with unsigned formats.
-# This is normal. E.g. -1 HAS a different number of 1 bits.
 # Specify the width field in the format if this is a problem.
 
 put DZ:percent 1
@@ -75,17 +73,9 @@ assure "12345 12345 012345 3039 003039 11000000111001 11000000111001 111001 !!..
 put DZ:lo 2147483647
 assure "2147483647 2147483647 2147483647 7fffffff FFFFFF 1111111111111111111111111111111 1111111111111111111111111111111 111111 !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!\n"
 put DZ:lo -1
-if {$tcl_platform(machine) == "x86_64"} {
-assure "-1 -1 -00001 ffffffffffffffff FFFFFF 1111111111111111111111111111111111111111111111111111111111111111 1111111111111111111111111111111111111111111111111111111111111111 111111 !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!\n"
-} else {
 assure "-1 -1 -00001 ffffffff FFFFFF 11111111111111111111111111111111 11111111111111111111111111111111 111111 !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!\n"
-}
 put DZ:lo -1234
-if {$tcl_platform(machine) == "x86_64"} {
-assure "-1234 -1234 -01234 fffffffffffffb2e FFFB2E 1111111111111111111111111111111111111111111111111111101100101110 1111111111111111111111111111111111111111111111111111101100101110 101110 !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!.!!..!.!!!. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!.!!..!.!!!.\n"
-} else {
 assure "-1234 -1234 -01234 fffffb2e FFFB2E 11111111111111111111101100101110 11111111111111111111101100101110 101110 !!!!!!!!!!!!!!!!!!!!!.!!..!.!!!. !!!!!!!!!!!!!!!!!!!!!.!!..!.!!!.\n"
-}
 put DZ:lo 255
 assure "255 255 000255 ff 0000FF 11111111 11111111 111111 !!!!!!!! !!!!!!!!\n"
 put DZ:lo 65535