Compare commits

..

58 Commits

Author SHA1 Message Date
75aa267875 error message on reply timeout 2020-03-16 16:58:07 +01:00
7dda6ca773 bugix for systems where vsnprintf returns -1 on buffer overrun: double buffer capacity 2020-03-02 13:56:42 +01:00
1378a9fcbb Merge branch 'windows_build_fix' of https://github.com/FreddieAkeroyd/StreamDevice 2020-03-02 09:13:38 +01:00
4d3672994d bugfix: when passing negative start index to find(), don't start earlier than index 0 2020-03-02 09:11:50 +01:00
967539c4e1 allow commas inside matching pairs of parentheses in protocol parameters 2020-03-02 09:10:28 +01:00
f072c217f3 allow () inside protocol parameters 2020-02-27 13:45:54 +01:00
a60ffd685f tests updated 2020-02-27 13:44:32 +01:00
0803c94c79 cleanup spaces 2020-02-26 15:53:02 +01:00
b03726903d Fix linker error on WIN32 2019-12-16 19:11:27 +00:00
afe8cc9a3e Merge branch 'master' of github.com:paulscherrerinstitute/StreamDevice 2019-11-27 16:50:36 +01:00
277635c65f fix linker problem on windows 2019-11-27 16:49:57 +01:00
4180bbbdd9 Merge pull request #45 from jgnrendra3/master
New Checksums including support for Brooks Cryopump
2019-11-12 15:30:14 +01:00
d683969556 New Checksums including support for Brooks Cryopump 2019-11-12 07:13:02 -05:00
a62d4d1a40 update documentation according to previous API change 2019-11-11 13:35:56 +01:00
aadecf1853 Merge pull request #44 from SLACer-garth/buffer-overflow-fix
Buffer overflow fix
2019-11-11 13:24:39 +01:00
f172f3d0a0 Merge pull request #43 from bfrk/master
remove error message in streamReadWrite
2019-11-11 12:47:41 +01:00
08ac900eda Make expectedLength ssize_t everywhere.
Also fix other type related warnings.
2019-11-07 17:20:08 -08:00
53caf69f3a Cast expectedLength to ssize_t where it is used as a signed number. Fixes buffer overrun memory corruption segfault. 2019-11-07 17:19:43 -08:00
3eac2b804d Bugfix in 64 bit data type handling. (Thanks to Andrew Johnson) 2019-11-07 20:23:35 +01:00
9b9e7bf722 remove error message in streamReadWrite
If the record hasn't been initialized correctly, we don't want the console
to be spammed every time the record gets processed.
2019-10-10 14:51:56 +02:00
7a48a5440e made RELEASE file more similar to SynApps 2019-08-26 09:10:28 +02:00
ef5d0cf3f1 improve building streamApp for 3.13 2019-08-22 16:34:32 +02:00
a5e9ed2d78 do not use epicsStdioRedirect.h for EPICS 3.13 2019-08-22 15:53:29 +02:00
40e937b091 do not use -ansi with vxWorks compiler in EPICS 3.13 2019-08-22 15:52:52 +02:00
1bac175c42 no need to go into config for 3.13 and it can cause problems with 3.14+ 2019-08-22 15:51:53 +02:00
507a8229de fix generation of stream-calcout.dbd: older EPICS versions have no CAT macro and we don't want duplicate registrations 2019-08-22 15:50:36 +02:00
3fd2e8fd31 support epicsStdioRedirect everywhere 2019-08-21 16:01:06 +02:00
f2e9395377 don't include 3.14 headers in EPICS 3.13 2019-08-21 15:38:13 +02:00
6669b1c33c fix problems with extern C and epics headers in different EPICS versions 2019-08-21 15:33:46 +02:00
21ce272a65 don't complain unnecessarily in finishProtoco() when protocols are reloaded 2019-08-21 14:48:23 +02:00
2b6a064913 Show errors when debug is enabled 2019-08-21 14:40:03 +02:00
81a901b386 updated docu for EPICS 7.0.3 2019-08-21 14:36:55 +02:00
cfbc4ac369 have error logging initially enabled 2019-08-21 14:34:17 +02:00
d1b6c8bf1a fix bug that caused endless loops in I/O Intr records 2019-08-21 14:27:26 +02:00
491cfa6d4b Merge Freddie Akeroyd's Windows fixes 2019-08-19 17:02:26 +02:00
a6b11bea0e document recommended value for PollPeriod 2019-08-08 14:54:20 +02:00
a6190c7ddf document debug and error messages 2019-08-08 14:48:40 +02:00
4ece622c52 Merge pull request #40 from FreddieAkeroyd/build_with_vs2010
Fix build issues with vs2010
2019-07-18 17:34:08 +02:00
0e525fc893 Use $(CAT) for WIN32 2019-06-08 21:48:54 +01:00
85c9a8b130 Fix linker import warning for StreamDebugFile on WIN32 2019-06-08 21:30:37 +01:00
905d8a3b4a Fix for VS2010 usage of __VA_ARGS__ 2019-06-08 20:46:21 +01:00
1cc5f3fbd6 Fix missing inttypes.h on VS2010 2019-06-08 20:44:26 +01:00
3ad63e04d0 Define ENABLE_VIRTUAL_TERMINAL_PROCESSING if not present 2019-06-08 20:34:39 +01:00
880a399e4e fix for commit cb4d49: needed to add SUPPORT=, not RELEASE= for SynApps 2019-05-29 08:48:35 +02:00
592146a648 Have separate dbd file without scalcout support (by Martin Konrad) 2019-05-21 16:58:41 +02:00
e03285b9a9 Merge branch 'master' of github.com:paulscherrerinstitute/StreamDevice 2019-05-21 11:40:30 +02:00
fb3d20bfd9 Merge pull request #37 from shadowguy/master
Update some EPICS related links
2019-05-21 11:39:52 +02:00
3363f4f525 add new record types to the pdf 2019-05-21 11:36:19 +02:00
ed300116bd add tolower and toupper to regsubst 2019-05-21 09:50:53 +02:00
f912e0b370 Update some EPICS related links 2019-05-02 11:24:18 +02:00
b84655e4de Support %% in protocol just like in printf/scanf. (Suggested by Klemen Vodopivec) 2019-02-26 16:30:20 +01:00
ece1e01d21 Fix incosistent readRequst() function signature in documentation. 2019-02-26 15:17:53 +01:00
26877dedbd move enum Commands into class StreamCore to avoid collisions of enum state wait with function pid_t wait(int*) 2019-02-20 15:11:07 +01:00
7aa1802ec6 link streamApp with sscan if SSCAN is defined in RELEASE 2019-02-19 16:14:45 +01:00
eb9f565aec don't mess with asynTraceMask any more 2019-02-18 13:54:43 +01:00
04906a5835 regsub converter: empty match advances by 1 byte to avoid loops 2019-02-18 11:08:21 +01:00
acf7efcff2 fix hanging 'in' command when it is the first command of the protocol and the device is offline 2018-11-27 13:45:27 +01:00
d873d220dc fix broken version detection 2018-11-27 13:41:49 +01:00
43 changed files with 636 additions and 321 deletions

View File

@ -11,12 +11,8 @@ DOCUDIR = docs
PCRE=1 PCRE=1
ASYN=1 ASYN=1
ifdef EPICSVERSION -include ../src/CONFIG_STREAM
ifndef RECORDTYPES -include src/CONFIG_STREAM
include src/CONFIG_STREAM
export RECORDTYPES BUSSES FORMATS
endif
endif
SOURCES += $(RECORDTYPES:%=src/dev%Stream.c) SOURCES += $(RECORDTYPES:%=src/dev%Stream.c)
SOURCES += $(FORMATS:%=src/%Converter.cc) SOURCES += $(FORMATS:%=src/%Converter.cc)

View File

@ -9,7 +9,7 @@ else ifneq ($(wildcard ../config),)
else else
# Using our own local configuration # Using our own local configuration
TOP = . TOP = .
DIRS = config configure DIRS = configure
src_DEPEND_DIRS := $(DIRS) src_DEPEND_DIRS := $(DIRS)
include $(TOP)/configure/CONFIG include $(TOP)/configure/CONFIG
endif endif

View File

@ -14,37 +14,18 @@ TEMPLATE_TOP=$(EPICS_BASE)/templates/makeBaseApp/top
# define INSTALL_LOCATION_APP here # define INSTALL_LOCATION_APP here
#INSTALL_LOCATION_APP=<fullpathname> #INSTALL_LOCATION_APP=<fullpathname>
# For SynApps: SUPPORT=$(TOP)/..
RELEASE= -include $(TOP)/../configure/SUPPORT.$(EPICS_HOST_ARCH)
EPICS_BASE=/usr/local/epics/base-7.0.1 ASYN=$(SUPPORT)/asyn4-36
ASYN=~/top-7/asyn4-33 CALC=$(SUPPORT)/calc-3-7
CALC=~/top-7/SynApps/calc-2-8 PCRE=$(SUPPORT)/pcre-7-2
PCRE=~/top-7/pcre-7-2
#EPICS_BASE=/usr/local/epics/base-3.16.1 # EPICS_BASE usually appears last so other apps can override stuff:
#ASYN=~/top-3.16/asyn4-30 EPICS_BASE=/usr/local/epics/base-7.0.3
#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 # These lines allow developers to override these RELEASE settings
#ASYN=~/top-3.15/asyn4-30 # without having to modify this file directly.
#CALC=~/top-3.15/SynApps/calc-2-8 -include $(TOP)/../RELEASE.local
#PCRE=~/top-3.15/pcre-7-2 -include $(TOP)/../RELEASE.$(EPICS_HOST_ARCH).local
-include $(TOP)/configure/RELEASE.local
#EPICS_BASE=/usr/local/epics/base-3.14.12
#ASYN=~/top/asyn4-30
#CALC=~/top/SynApps/calc-2-8
#PCRE=~/top/pcre-7-2
#3.14.8 does not understand ~
#EPICS_BASE=/usr/local/epics/base-3.14.8
#ASYN=/afs/psi.ch/user/z/zimoch/top/asyn-4.10
##Example 3.13 build
#EPICS_BASE=/usr/local/epics/base-3.13.10
#ASYN=/afs/psi.ch/user/z/zimoch/top_3.13/4-6
#COMPAT=/afs/psi.ch/user/z/zimoch/top_3.13

View File

@ -69,7 +69,7 @@ class MyInterface : StreamBusInterface
bool <a href="#lock">lockRequest</a>(unsigned long lockTimeout_ms); bool <a href="#lock">lockRequest</a>(unsigned long lockTimeout_ms);
bool <a href="#lock">unlock</a>(); bool <a href="#lock">unlock</a>();
bool <a href="#write">writeRequest</a>(const void* output, size_t size, unsigned long writeTimeout_ms); bool <a href="#write">writeRequest</a>(const void* output, size_t size, unsigned long writeTimeout_ms);
bool <a href="#read">readRequest</a>(unsigned long replyTimeout_ms, unsigned long readTimeout_ms, long expectedLength, bool async); bool <a href="#read">readRequest</a>(unsigned long replyTimeout_ms, unsigned long readTimeout_ms, ssize_t expectedLength, bool async);
bool <a href="#read">supportsAsyncRead</a>(); bool <a href="#read">supportsAsyncRead</a>();
bool <a href="#event">supportsEvent</a>(); bool <a href="#event">supportsEvent</a>();
bool <a href="#event">acceptEvent</a>(unsigned long mask, unsigned long timeout_ms); bool <a href="#event">acceptEvent</a>(unsigned long mask, unsigned long timeout_ms);
@ -118,7 +118,7 @@ bool <a href="#write">writeRequest</a>(const&nbsp;void*&nbsp;output,
<div class="indent"><code> <div class="indent"><code>
bool <a href="#read">readRequest</a>(unsigned&nbsp;long&nbsp;replyTimeout_ms, bool <a href="#read">readRequest</a>(unsigned&nbsp;long&nbsp;replyTimeout_ms,
unsigned&nbsp;long&nbsp;readTimeout_ms, unsigned&nbsp;long&nbsp;readTimeout_ms,
long&nbsp;expectedLength, bool&nbsp;async); ssize_t&nbsp;expectedLength, bool&nbsp;async);
</code></div> </code></div>
<div class="indent"><code> <div class="indent"><code>
bool <a href="#read">supportsAsyncRead</a>(); bool <a href="#read">supportsAsyncRead</a>();
@ -460,7 +460,7 @@ The client may request more I/O or call <code>unlock()</code> after
<div class="indent"><code> <div class="indent"><code>
bool readRequest(unsigned&nbsp;long&nbsp;replyTimeout_ms, bool readRequest(unsigned&nbsp;long&nbsp;replyTimeout_ms,
unsigned&nbsp;long&nbsp;readTimeout_ms, unsigned&nbsp;long&nbsp;readTimeout_ms,
long&nbsp;expectedLength, bool&nbsp;async); ssize_t&nbsp;expectedLength, bool&nbsp;async);
</code></div> </code></div>
<div class="indent"><code> <div class="indent"><code>
ssize_t readCallback(IoStatus&nbsp;status, ssize_t readCallback(IoStatus&nbsp;status,

View File

@ -37,6 +37,14 @@ A format converter consists of
<li>Additional information required by some converters</li> <li>Additional information required by some converters</li>
</ul> </ul>
<p class="new">
An exception is the sequence <code>%%</code> which stands for a single
literal <code>%</code>.
This has been added for compatibility with the C functions
<em>printf()</em> and <em>scanf()</em>.
It behaves the same as the escaped percent <code>\%</code>.
</p>
<p> <p>
The flags <code>*# +0-</code> work like in the C functions The flags <code>*# +0-</code> work like in the C functions
<em>printf()</em> and <em>scanf()</em>. <em>printf()</em> and <em>scanf()</em>.
@ -83,8 +91,6 @@ formatted (like for output) and then compared to the input.
The <code>!</code> flag demands that input is exactly <em>width</em> The <code>!</code> flag demands that input is exactly <em>width</em>
bytes long (normally <em>width</em> defines the maximum number of bytes long (normally <em>width</em> defines the maximum number of
bytes read in many formats). bytes read in many formats).
For example <code>in "%!5d";</code> expects exactly 5 digits.
Fewer digits are considered loss of data and make the format fail.
This feature has been added by Klemen Vodopivec, SNS. This feature has been added by Klemen Vodopivec, SNS.
</p> </p>
@ -118,6 +124,14 @@ This feature has been added by Klemen Vodopivec, SNS.
<td><code>in "%=.3f";</code></td> <td><code>in "%=.3f";</code></td>
<td>Assure that the input is equal to the current value formatted as a float with precision 3</td> <td>Assure that the input is equal to the current value formatted as a float with precision 3</td>
</tr> </tr>
<tr>
<td><code>in "%!5d";</code></td>
<td>Expect exactly 5 decimal digits. Fewer digits are considered loss of data and make the format fail.
</tr>
<tr>
<td><code>in "%d%%";</code></td>
<td>Read a decimal number followed by a % sign</td>
</tr>
</table> </table>
<a name="types"></a> <a name="types"></a>
@ -587,7 +601,7 @@ It is only available if a PCRE library is installed.
<div class="box"> <div class="box">
<p> <p>
If PCRE is not available for your host or cross architecture, download If PCRE is not available for your host or cross architecture, download
the sourcecode from <a target="ex" href="http://www.pcre.org/">www.pcre.org</a> the sourcecode from <a target="ex" href="https://www.pcre.org/">www.pcre.org</a>
and try my EPICS compatible <a target="ex" and try my EPICS compatible <a target="ex"
href="http://epics.web.psi.ch/software/streamdevice/pcre/Makefile">Makefile</a> href="http://epics.web.psi.ch/software/streamdevice/pcre/Makefile">Makefile</a>
to compile it like a normal EPICS support module. to compile it like a normal EPICS support module.
@ -642,6 +656,13 @@ Matches of the <em>regex</em> are replaced by the string <em>subst</em> with all
<code>\1</code> through <code>\9</code> replaced with the match of the corresponding <code>\1</code> through <code>\9</code> replaced with the match of the corresponding
sub-expression <span class="new"> if such a sub-expression exists. sub-expression <span class="new"> if such a sub-expression exists.
Occurrences of <code>\U<i>n</i></code>, <code>\L<i>n</i></code>, <code>\u<i>n</i></code>,
or <code>\l<i>n</i></code> with <code><i>n</i></code> being a number <code>0</code>
through <code>9</code> or <code>&</code> are replaced with the corresponding sub-expression
converted to all upper case, all lower case, first letter upper case, or first letter lower
case, respectively.</span>
</p>
<p><span class="new">
Due to limitations of the parser, <code>\1</code> and <code>\x01</code> are the same Due to limitations of the parser, <code>\1</code> and <code>\x01</code> are the same
which makes it difficult to use literal bytes with values lower than 10 in <em>subst</em>. which makes it difficult to use literal bytes with values lower than 10 in <em>subst</em>.
Therefore <code>\0</code> aways means a literal byte (incompatible change from earlier version!) Therefore <code>\0</code> aways means a literal byte (incompatible change from earlier version!)
@ -666,6 +687,13 @@ Otherwise <em>precision</em> is the index (counting from 1) of the match to repl
Without <em>precision</em> (or 0), all matches are replaced. Without <em>precision</em> (or 0), all matches are replaced.
</p> </p>
<p> <p>
When replacing multiple matches, the next match is searched directly after the currently
replaced string, so that the <em>subst</em> string itself will never be modified recursively.
<span class="new">
However if an empty string is matched, searching advances by 1 character in order to
avoid matching the same empty string again.</span>
</p>
<p>
In input this converter pre-processes data received from the device before In input this converter pre-processes data received from the device before
following converters read it. following converters read it.
Converters preceding this one will read unmodified input. Converters preceding this one will read unmodified input.
@ -701,6 +729,9 @@ which is not at the end of a word.
<code>%#/([^+-])*([+-])/\2\1/</code> moves a postfix sign to the front. <code>%#/([^+-])*([+-])/\2\1/</code> moves a postfix sign to the front.
(<code>1.23-</code> becomes <code>-1.23</code>)<br> (<code>1.23-</code> becomes <code>-1.23</code>)<br>
</div> </div>
<div class="indent">
<code>%#-2/.*/\U0/</code> converts the previous 2 characters to upper case.
</div>
<a name="mantexp"></a> <a name="mantexp"></a>
<h2>15. MantissaExponent DOUBLE converter (<code>%m</code>)</h2> <h2>15. MantissaExponent DOUBLE converter (<code>%m</code>)</h2>
<p> <p>

View File

@ -99,9 +99,9 @@ IOC Application Developer's Guide:
<a href="https://epics.anl.gov/base/R3-14/12-docs/AppDevGuide/" <a href="https://epics.anl.gov/base/R3-14/12-docs/AppDevGuide/"
target="ex">R3.14.12</a>, target="ex">R3.14.12</a>,
<a href="https://epics.anl.gov/base/R3-15/6-docs/AppDevGuide/AppDevGuide.html" <a href="https://epics.anl.gov/base/R3-15/6-docs/AppDevGuide/AppDevGuide.html"
target="ex">R3.15.5</a>, target="ex">R3.15.6</a>,
<a href="https://epics.anl.gov/base/R3-16/1-docs/AppDevGuide/AppDevGuide.html" <a href="https://epics.anl.gov/base/R3-16/2-docs/AppDevGuide/AppDevGuide.html"
target="ex">R3.16.1</a> target="ex">R3.16.2</a>
</p> </p>
<p> <p>
<a href="https://wiki-ext.aps.anl.gov/epics/index.php/RRM_3-14" <a href="https://wiki-ext.aps.anl.gov/epics/index.php/RRM_3-14"
@ -120,7 +120,7 @@ Longer code segments are often set in a box.
<h2>Changes in Version 2.8</h2> <h2>Changes in Version 2.8</h2>
<ul> <ul>
<li>Support standard EPICS module build system. <li>Support standard EPICS module build system.
<li>Compatible with EPICS base releases up to 7.0.1. <li>Compatible with EPICS 7.
<ul> <ul>
<li>Support for new record types: int64in, int64out, lsi, lso. <li>Support for new record types: int64in, int64out, lsi, lso.
<li>Support for INT64 and UINT64 in aai, aao, waveform. <li>Support for INT64 and UINT64 in aai, aao, waveform.
@ -128,7 +128,6 @@ Longer code segments are often set in a box.
<li>Run @init more often (e.g. when device re-connects or paused IOC is resumed). <li>Run @init more often (e.g. when device re-connects or paused IOC is resumed).
<li>Use "COMM" error code in .STAT when device is disconnected. <li>Use "COMM" error code in .STAT when device is disconnected.
<li>Allow spaces in protocol parameter list. <li>Allow spaces in protocol parameter list.
<li>Errors are new silent by default (var streamError 0) except during init.
<li>Support output redirect of all shell functions. <li>Support output redirect of all shell functions.
<li>Fix building shared libraries on Windows. <li>Fix building shared libraries on Windows.
<li>Fix some C++11 warnings. <li>Fix some C++11 warnings.

View File

@ -20,17 +20,21 @@ ai.html
ao.html ao.html
bi.html bi.html
bo.html bo.html
mbbi.html calcout.html
mbbo.html int64in.html
mbbiDirect.html int64out.html
mbboDirect.html
stringin.html
stringout.html
longin.html longin.html
longout.html longout.html
waveform.html lsi.html
calcout.html lso.html
mbbiDirect.html
mbboDirect.html
mbbi.html
mbbo.html
scalcout.html scalcout.html
stringin.html
stringout.html
waveform.html
tipsandtricks.html tipsandtricks.html
recordinterface.html recordinterface.html
businterface.html businterface.html

View File

@ -95,6 +95,7 @@ div div div a {list-style-type:circle;}
<div> <div>
<a target="_parent" href="setup.html#reload">Reloading</a> <a target="_parent" href="setup.html#reload">Reloading</a>
</div> </div>
<a target="_parent" href="setup.html#debug">Debugging</a>
<a target="_parent" href="setup.html#rec">Records</a> <a target="_parent" href="setup.html#rec">Records</a>
</div> </div>
</div> </div>

View File

@ -390,6 +390,9 @@ what they influence.
the moment. the moment.
How many milliseconds to wait after last poll or last received How many milliseconds to wait after last poll or last received
input before polling again? input before polling again?
A good value is about half the time of the expected input period.
Longer values cause latency and shorter values may increase CPU
consumption.
If not set the same value as for <code>ReplyTimeout</code> is If not set the same value as for <code>ReplyTimeout</code> is
used. used.
</dd> </dd>
@ -479,12 +482,63 @@ To make this easier, <em>protocol arguments</em> can be used:
move { out "\$1 GOTO %d"; } move { out "\$1 GOTO %d"; }
</pre> </pre>
<p> <p>
Now, the protocol can be references in the <code>OUT</code> link Now the same protocol can be used in the <code>OUT</code> link
of three different records as <code>move(X)</code>, of three different records as <code>move(X)</code>,
<code>move(Y)</code> and <code>move(Z)</code>. <code>move(Y)</code> and <code>move(Z)</code>.
Up to 9 parameters, referenced as <code>$1</code> ... <code>$9</code> </p>
can be specified in parentheses, separated by comma. <p>
The variable <code>$0</code> is replaced by the name of the protocol. Up to 9 parameters can be specified in parentheses, separated by comma.
In the protocol, they are referenced as <code>$1</code> ...
<code>$9</code> outside quotes or <code>\$1</code> ... <code>\$9</code>
within quotes. The parameter <code>$0</code> resolves to the protocol name.
</p>
<div class="new">
<p>
To make links more readable, one space is allowed before and after each comma
and the enclosing parentheses. This space is not part of the parameter string.
Any additional space is part of the parameter.
</p>
<p>
If a parameter contains matching pairs of parentheses, these and all commas
inside are part of the parameter.
This allows to pass parameter strings like <code>(1,2)</code> easily without
much escaping.
</p>
<p>
Unmatched parentheses must be escaped with double backslash <code>\\</code>
as well as must be commas outside pairs of parentheses.
Double backslash is necessary because one backslash is already consumed by
the db file parser.
To pass a literal backslash in a parameter string use 4 backslashes
<code>\\\\</code>.
</p>
</div>
<p>
Note that macros can be used in parameters. That makes it possible to
pass part of the record name to the protocol to be used in
<a href="formats.html#redirection">redirections</a>.
</p>
<h4>Example:</h3>
<pre>
record(ai, "$(PREFIX)recX5") {
field(DTYP, "stream")
field(INP, "@$(PROTOCOLFILE) read(5, X\\,Y $(PREFIX)) $(PORT)")
}
record(ai, "$(PREFIX)recY5") {}
read { out 0x8$1 "READ \$2"; in "%f,%(\$3recY\$1)f" }
</pre>
<p>
The protocol resolves to:
</p>
<pre>
read { out 0x85 "READ X,Y"; in "%f,%($(PREFIX)recY5)f" }
</pre>
<p>
Here <code>$(PREFIX)</code> is replaced with its macro value.
But be aware that the macro is actually replaced before the link is parsed so
that macro values containing comma or parentheses may have unintended effects.
</p> </p>
<a name="usrvar"></a> <a name="usrvar"></a>
@ -562,7 +616,7 @@ There is a fixed set of exception handler names starting with
</dd> </dd>
</dl> </dl>
<h3>Example:</h3> <h4>Example:</h3>
<pre> <pre>
setPosition { setPosition {
out "POS %f"; out "POS %f";

View File

@ -17,9 +17,9 @@
<p> <p>
<em>StreamDevice</em> works with <em>StreamDevice</em> works with
<a href="https://epics.anl.gov/base/index.php">EPICS base</a> <a href="https://epics.anl.gov/base/index.php">EPICS base</a>
versions from R3.14.6 on, tested up to 7.0.1. versions from R3.14.6 on, tested up to 7.0.3.
It also works (with limitations) with older It also works (with limitations) with older
<a href="https://www.aps.anl.gov/epics/base/R3-13.php">R3.13</a> <a href="https://epics.anl.gov/base/R3-13.php">R3.13</a>
versions from R3.13.7 on. versions from R3.13.7 on.
How to use <em>StreamDevice</em> with EPICS R3.13 is described on a How to use <em>StreamDevice</em> with EPICS R3.13 is described on a
<a href="epics3_13.html">separate page</a>. <a href="epics3_13.html">separate page</a>.
@ -377,8 +377,43 @@ protocol is loaded.
See the <a href="protocol.html">next chapter</a> for protocol files in depth. See the <a href="protocol.html">next chapter</a> for protocol files in depth.
</p> </p>
<a name="debug"></a>
<h2>5. Debug and Error Messages</h2>
<p>
Generation of debug and error messages is controlled with two shell variables,
<code>streamDebug</code> and <code>streamError</code>.
Setting those variables to 1 (actually to any number but 0) enables the
messages.
Per default debug messages are switched off and error messages are switched on.
Errors occuring while loading protocol files are always shown.
</p>
<p>
Warning: Enabling debug messages can create a lot of output!
At the moment, there is no way to set filters on debug or error messages.
</p>
<p>
Debug output can be redirected to a file with the command
<code>streamSetLogfile("<var>filename</var>")</code>.
When called without a filename, debug output is directed back
to the console.
</p>
<h3>Example (vxWorks):</h3>
<pre>
streamError=1
streamDebug=1
streamSetLogfile("logfile.txt")
</pre>
<h3>Example (iocsh):</h3>
<pre>
var streamError 1
var streamDebug 1
streamSetLogfile("logfile.txt")
</pre>
<a name="rec"></a> <a name="rec"></a>
<h2>5. Configuring the Records</h2> <h2>6. Configuring the Records</h2>
<p> <p>
To tell a record to use <em>StreamDevice</em>, set its <code>DTYP</code> field to To tell a record to use <em>StreamDevice</em>, set its <code>DTYP</code> field to
<code>"stream"</code>. <code>"stream"</code>.

View File

@ -69,6 +69,10 @@ h4 {
margin-bottom:0.25ex; margin-bottom:0.25ex;
} }
h1, h2, h3, h4 {
page-break-after:avoid;
}
p { p {
margin-top:0.75ex; margin-top:0.75ex;
margin-bottom:0.75ex; margin-bottom:0.75ex;

View File

@ -17,10 +17,6 @@
* * * *
***************************************************************/ ***************************************************************/
#include "StreamBusInterface.h"
#include "StreamError.h"
#include "StreamBuffer.h"
#ifdef EPICS_3_13 #ifdef EPICS_3_13
#include <assert.h> #include <assert.h>
#include <wdLib.h> #include <wdLib.h>
@ -32,10 +28,13 @@ extern "C" {
#include "epicsAssert.h" #include "epicsAssert.h"
#include "epicsTime.h" #include "epicsTime.h"
#include "epicsTimer.h" #include "epicsTimer.h"
#include "epicsStdioRedirect.h"
#include "iocsh.h" #include "iocsh.h"
#endif #endif
#include "StreamBusInterface.h"
#include "StreamError.h"
#include "StreamBuffer.h"
#include "asynDriver.h" #include "asynDriver.h"
#include "asynOctet.h" #include "asynOctet.h"
#include "asynInt32.h" #include "asynInt32.h"
@ -43,6 +42,7 @@ extern "C" {
#include "asynGpibDriver.h" #include "asynGpibDriver.h"
#include "devStream.h" #include "devStream.h"
#include "MacroMagic.h" #include "MacroMagic.h"
#define Z PRINTF_SIZE_T_PREFIX #define Z PRINTF_SIZE_T_PREFIX
@ -162,7 +162,7 @@ class AsynDriverInterface : StreamBusInterface
double writeTimeout; double writeTimeout;
double readTimeout; double readTimeout;
double replyTimeout; double replyTimeout;
size_t expectedLength; ssize_t expectedLength;
unsigned long eventMask; unsigned long eventMask;
unsigned long receivedEvent; unsigned long receivedEvent;
StreamBuffer inputBuffer; StreamBuffer inputBuffer;
@ -187,7 +187,7 @@ class AsynDriverInterface : StreamBusInterface
bool writeRequest(const void* output, size_t size, bool writeRequest(const void* output, size_t size,
unsigned long writeTimeout_ms); unsigned long writeTimeout_ms);
bool readRequest(unsigned long replyTimeout_ms, bool readRequest(unsigned long replyTimeout_ms,
unsigned long readTimeout_ms, size_t expectedLength, bool async); unsigned long readTimeout_ms, ssize_t expectedLength, bool async);
bool acceptEvent(unsigned long mask, unsigned long replytimeout_ms); bool acceptEvent(unsigned long mask, unsigned long replytimeout_ms);
bool supportsEvent(); bool supportsEvent();
bool supportsAsyncRead(); bool supportsAsyncRead();
@ -457,10 +457,6 @@ connectToBus(const char* portname, int addr)
return false; return false;
} }
// disable asyn errors to avoid flooding when device is disconnected
// user can re-enable later
pasynTrace->setTraceMask(pasynUser, 0);
asynInterface* pasynInterface; asynInterface* pasynInterface;
// find the asynCommon interface // find the asynCommon interface
@ -804,7 +800,7 @@ writeHandler()
// interface function: we want to read something // interface function: we want to read something
bool AsynDriverInterface:: bool AsynDriverInterface::
readRequest(unsigned long replyTimeout_ms, unsigned long readTimeout_ms, readRequest(unsigned long replyTimeout_ms, unsigned long readTimeout_ms,
size_t _expectedLength, bool async) ssize_t _expectedLength, bool async)
{ {
debug("AsynDriverInterface::readRequest(%s, %ld msec reply, " debug("AsynDriverInterface::readRequest(%s, %ld msec reply, "
"%ld msec read, expect %" Z "u bytes, async=%s)\n", "%ld msec read, expect %" Z "u bytes, async=%s)\n",

35
src/ChecksumConverter.cc Normal file → Executable file
View File

@ -28,6 +28,12 @@
#define SCNx8 "hhx" #define SCNx8 "hhx"
#define uint_fast8_t uint8_t #define uint_fast8_t uint8_t
#define int_fast8_t int8_t #define int_fast8_t int8_t
#elif defined(_MSC_VER) && _MSC_VER < 1700 /* Visual Studio 2010 does not have inttypes.h */
#include <stdint.h>
#define PRIX32 "X"
#define PRIu32 "u"
#define PRIX8 "X"
#define SCNx8 "hhx"
#else #else
#define __STDC_FORMAT_MACROS #define __STDC_FORMAT_MACROS
#include <stdint.h> #include <stdint.h>
@ -498,6 +504,18 @@ static uint32_t leybold(const uint8_t* data, size_t len, uint32_t sum)
return sum; return sum;
} }
// Checksum used by Brooks Cryopumps
static uint32_t brksCryo(const uint8_t* data, size_t len, uint32_t sum)
{
uint32_t xsum;
while (len--) {
sum += (*data++) & 0x7F;
}
xsum = (((sum >> 6) ^ sum) & 0x3F) + 0x30;
return xsum;
}
struct checksum struct checksum
{ {
const char* name; const char* name;
@ -515,8 +533,13 @@ static checksum checksumMap[] =
{"sum8", sum, 0x00, 0x00, 1}, // 0xDD {"sum8", sum, 0x00, 0x00, 1}, // 0xDD
{"sum16", sum, 0x0000, 0x0000, 2}, // 0x01DD {"sum16", sum, 0x0000, 0x0000, 2}, // 0x01DD
{"sum32", sum, 0x00000000, 0x00000000, 4}, // 0x000001DD {"sum32", sum, 0x00000000, 0x00000000, 4}, // 0x000001DD
{"nsum8", sum, 0xFF, 0xFF, 1}, // 0x23
{"nsum16", sum, 0xFFFF, 0xFFFF, 2}, // 0xFE23
{"nsum32", sum, 0xFFFFFFFF, 0xFFFFFFFF, 4}, // 0xFFFFFE23
{"notsum", sum, 0x00, 0xFF, 1}, // 0x22
{"xor", xor8, 0x00, 0x00, 1}, // 0x31 {"xor", xor8, 0x00, 0x00, 1}, // 0x31
{"xor8", xor8, 0x00, 0x00, 1}, // 0x31 {"xor8", xor8, 0x00, 0x00, 1}, // 0x31
{"xor8ff", xor8, 0x00, 0xFF, 1}, // 0xCE
{"xor7", xor7, 0x00, 0x00, 1}, // 0x31 {"xor7", xor7, 0x00, 0x00, 1}, // 0x31
{"crc8", crc_0x07, 0x00, 0x00, 1}, // 0xF4 {"crc8", crc_0x07, 0x00, 0x00, 1}, // 0xF4
{"ccitt8", crc_0x31, 0x00, 0x00, 1}, // 0xA1 {"ccitt8", crc_0x31, 0x00, 0x00, 1}, // 0xA1
@ -535,6 +558,7 @@ static checksum checksumMap[] =
{"hexsum8", hexsum, 0x00, 0x00, 1}, // 0x2D {"hexsum8", hexsum, 0x00, 0x00, 1}, // 0x2D
{"cpi", CPI, 0x00, 0x00, 1}, // 0x7E {"cpi", CPI, 0x00, 0x00, 1}, // 0x7E
{"leybold", leybold, 0x00, 0x00, 1}, // 0x22 {"leybold", leybold, 0x00, 0x00, 1}, // 0x22
{"brksCryo",brksCryo, 0x00, 0x00, 1} // 0x4A
}; };
static uint32_t mask[5] = {0, 0xFF, 0xFFFF, 0xFFFFFF, 0xFFFFFFFF}; static uint32_t mask[5] = {0, 0xFF, 0xFFFF, 0xFFFFFF, 0xFFFFFFFF};
@ -700,13 +724,14 @@ scanPseudo(const StreamFormat& format, StreamBuffer& input, size_t& cursor)
debug("ChecksumConverter %s: input to check: \"%s\n", debug("ChecksumConverter %s: input to check: \"%s\n",
checksumMap[fnum].name, input.expand(start,length)()); checksumMap[fnum].name, input.expand(start,length)());
uint_fast8_t expectedLength = uint_fast8_t nDigits =
// get number of decimal digits from number of bytes: ceil(bytes*2.5) // get number of decimal digits from number of bytes: ceil(bytes*2.5)
format.flags & sign_flag ? (checksumMap[fnum].bytes + 1) * 25 / 10 - 2 : format.flags & sign_flag ? (checksumMap[fnum].bytes + 1) * 25 / 10 - 2 :
format.flags & (zero_flag|left_flag) ? 2 * checksumMap[fnum].bytes : format.flags & (zero_flag|left_flag) ? 2 * checksumMap[fnum].bytes :
checksumMap[fnum].bytes; checksumMap[fnum].bytes;
ssize_t expectedLength = nDigits;
if (input.length() - cursor < expectedLength) if ((ssize_t)( input.length() - cursor ) < expectedLength)
{ {
debug("ChecksumConverter %s: Input '%s' too short for checksum\n", debug("ChecksumConverter %s: Input '%s' too short for checksum\n",
checksumMap[fnum].name, input.expand(cursor)()); checksumMap[fnum].name, input.expand(cursor)());
@ -725,7 +750,7 @@ scanPseudo(const StreamFormat& format, StreamBuffer& input, size_t& cursor)
if (format.flags & sign_flag) // decimal if (format.flags & sign_flag) // decimal
{ {
uint32_t sumin = 0; uint32_t sumin = 0;
size_t i; ssize_t i;
for (i = 0; i < expectedLength; i++) for (i = 0; i < expectedLength; i++)
{ {
inchar = input[cursor+i]; inchar = input[cursor+i];
@ -747,7 +772,7 @@ scanPseudo(const StreamFormat& format, StreamBuffer& input, size_t& cursor)
{ {
if (format.flags & zero_flag) // ASCII if (format.flags & zero_flag) // ASCII
{ {
if (sscanf(input(cursor+2*i), "%2" SCNx8, &inchar) != 1) if (sscanf(input(cursor+2*i), "%2" SCNx8, (int8_t *) &inchar) != 1)
{ {
debug("ChecksumConverter %s: Input byte '%s' is not a hex byte\n", debug("ChecksumConverter %s: Input byte '%s' is not a hex byte\n",
checksumMap[fnum].name, input.expand(cursor+2*i,2)()); checksumMap[fnum].name, input.expand(cursor+2*i,2)());
@ -791,7 +816,7 @@ scanPseudo(const StreamFormat& format, StreamBuffer& input, size_t& cursor)
{ {
if (format.flags & zero_flag) // ASCII if (format.flags & zero_flag) // ASCII
{ {
sscanf(input(cursor+2*i), "%2" SCNx8, &inchar); sscanf(input(cursor+2*i), "%2" SCNx8, (int8_t *) &inchar);
} }
else else
if (format.flags & left_flag) // poor man's hex: 0x30 - 0x3F if (format.flags & left_flag) // poor man's hex: 0x30 - 0x3F

View File

@ -37,7 +37,7 @@ class DebugInterface : StreamBusInterface
bool writeRequest(const void* output, size_t size, bool writeRequest(const void* output, size_t size,
unsigned long writeTimeout_ms); unsigned long writeTimeout_ms);
bool readRequest(unsigned long replyTimeout_ms, bool readRequest(unsigned long replyTimeout_ms,
unsigned long readTimeout_ms, size_t expectedLength, bool async); unsigned long readTimeout_ms, ssize_t expectedLength, bool async);
protected: protected:
~DebugInterface(); ~DebugInterface();
@ -169,9 +169,9 @@ writeRequest(const void* output, size_t size, unsigned long writeTimeout_ms)
// Return false if the read request cannot be accepted. // Return false if the read request cannot be accepted.
bool DebugInterface:: bool DebugInterface::
readRequest(unsigned long replyTimeout_ms, unsigned long readTimeout_ms, readRequest(unsigned long replyTimeout_ms, unsigned long readTimeout_ms,
size_t expectedLength, bool async) ssize_t expectedLength, bool async)
{ {
debug("DebugInterface::readRequest(%s, %ld msec reply, %ld msec read, expect %" Z "u bytes, asyn=%s)\n", debug("DebugInterface::readRequest(%s, %ld msec reply, %ld msec read, expect %" Z "d bytes, asyn=%s)\n",
clientName(), replyTimeout_ms, readTimeout_ms, expectedLength, async?"yes":"no"); clientName(), replyTimeout_ms, readTimeout_ms, expectedLength, async?"yes":"no");
// Debug interface does not support async mode. // Debug interface does not support async mode.

View File

@ -127,7 +127,7 @@ printLong(const StreamFormat& fmt, StreamBuffer& output, long value)
if (numEnums < 0) numEnums=-numEnums-1; if (numEnums < 0) numEnums=-numEnums-1;
while (numEnums-- && (value != index)) while (numEnums-- && (value != index))
{ {
while(*s) while (*s)
{ {
if (*s == esc) s++; if (*s == esc) s++;
s++; s++;
@ -140,7 +140,7 @@ printLong(const StreamFormat& fmt, StreamBuffer& output, long value)
error("Value %li not found in enum set\n", value); error("Value %li not found in enum set\n", value);
return false; return false;
} }
while(*s) while (*s)
{ {
if (*s == esc) s++; if (*s == esc) s++;
output.append(*s++); output.append(*s++);
@ -165,7 +165,7 @@ scanLong(const StreamFormat& fmt, const char* input, long& value)
debug("EnumConverter::scanLong: check #%ld \"%s\"\n", index, s); debug("EnumConverter::scanLong: check #%ld \"%s\"\n", index, s);
consumed = 0; consumed = 0;
match = true; match = true;
while(*s) while (*s)
{ {
if (*s == StreamProtocolParser::skip) if (*s == StreamProtocolParser::skip)
{ {

View File

@ -28,7 +28,7 @@
#define ENUM(type, args...) \ #define ENUM(type, args...) \
enum type { args }; \ enum type { args }; \
static inline const char* type##ToStr(int x) {switch(x){MACRO_FOR_EACH(_CASE_LINE,args)default: return "invalid";}}\ static inline const char* type##ToStr(int x) {switch(x) {MACRO_FOR_EACH(_CASE_LINE,args)default: return "invalid";}}\
_ENUM_CAST(type) _ENUM_CAST(type)
#else #else
@ -37,28 +37,35 @@ _ENUM_CAST(type)
#define _NTH_ARG(_1, _2, _3, _4, _5, _6, _7, _8, _9, _10, _11, N, ...) N #define _NTH_ARG(_1, _2, _3, _4, _5, _6, _7, _8, _9, _10, _11, N, ...) N
/*
* we need to use _EXPAND below to work around a problem in Visual Studio 2010
* where __VA_ARGS__ is treated as a single argument
* See https://stackoverflow.com/questions/5134523/msvc-doesnt-expand-va-args-correctly
*/
#define _EXPAND( x ) x
#define _fe_0(_call, ...) #define _fe_0(_call, ...)
#define _fe_1(_call, x) _call(x) #define _fe_1(_call, x) _call(x)
#define _fe_2(_call, x, ...) _call(x) _fe_1(_call, __VA_ARGS__) #define _fe_2(_call, x, ...) _call(x) _EXPAND(_fe_1(_call, __VA_ARGS__))
#define _fe_3(_call, x, ...) _call(x) _fe_2(_call, __VA_ARGS__) #define _fe_3(_call, x, ...) _call(x) _EXPAND(_fe_2(_call, __VA_ARGS__))
#define _fe_4(_call, x, ...) _call(x) _fe_3(_call, __VA_ARGS__) #define _fe_4(_call, x, ...) _call(x) _EXPAND(_fe_3(_call, __VA_ARGS__))
#define _fe_5(_call, x, ...) _call(x) _fe_4(_call, __VA_ARGS__) #define _fe_5(_call, x, ...) _call(x) _EXPAND(_fe_4(_call, __VA_ARGS__))
#define _fe_6(_call, x, ...) _call(x) _fe_5(_call, __VA_ARGS__) #define _fe_6(_call, x, ...) _call(x) _EXPAND(_fe_5(_call, __VA_ARGS__))
#define _fe_7(_call, x, ...) _call(x) _fe_6(_call, __VA_ARGS__) #define _fe_7(_call, x, ...) _call(x) _EXPAND(_fe_6(_call, __VA_ARGS__))
#define _fe_8(_call, x, ...) _call(x) _fe_7(_call, __VA_ARGS__) #define _fe_8(_call, x, ...) _call(x) _EXPAND(_fe_7(_call, __VA_ARGS__))
#define _fe_9(_call, x, ...) _call(x) _fe_8(_call, __VA_ARGS__) #define _fe_9(_call, x, ...) _call(x) _EXPAND(_fe_8(_call, __VA_ARGS__))
#define _fe_10(_call, x, ...) _call(x) _fe_9(_call, __VA_ARGS__) #define _fe_10(_call, x, ...) _call(x) _EXPAND(_fe_9(_call, __VA_ARGS__))
#define MACRO_FOR_EACH(x, ...) \ #define MACRO_FOR_EACH(x, ...) \
_NTH_ARG(_, ##__VA_ARGS__, \ _EXPAND(_NTH_ARG(_, ##__VA_ARGS__, \
_fe_10, _fe_9, _fe_8, _fe_7, _fe_6, _fe_5, _fe_4, _fe_3, _fe_2, _fe_1, _fe_0) \ _fe_10, _fe_9, _fe_8, _fe_7, _fe_6, _fe_5, _fe_4, _fe_3, _fe_2, _fe_1, _fe_0) \
(x, ##__VA_ARGS__) (x, ##__VA_ARGS__))
/* Enum to string magic */ /* Enum to string magic */
#define ENUM(type,...) \ #define ENUM(type,...) \
enum type { __VA_ARGS__ }; \ enum type { __VA_ARGS__ }; \
static inline const char* type##ToStr(int x) {switch(x){MACRO_FOR_EACH(_CASE_LINE,__VA_ARGS__) default: return "invalid";}} \ static inline const char* type##ToStr(int x) {switch(x) {_EXPAND(MACRO_FOR_EACH(_CASE_LINE,__VA_ARGS__)) default: return "invalid";}} \
_ENUM_CAST(type) _ENUM_CAST(type)
#endif #endif

View File

@ -35,6 +35,10 @@ endif
LIBRARY_DEFAULT = stream LIBRARY_DEFAULT = stream
DBD += $(LIBRARY_DEFAULT).dbd DBD += $(LIBRARY_DEFAULT).dbd
DBD += $(LIBRARY_DEFAULT)-base.dbd
ifdef CALC
DBD += $(LIBRARY_DEFAULT)-scalcout.dbd
endif
ifdef ASYN ifdef ASYN
LIB_LIBS += asyn LIB_LIBS += asyn
@ -84,7 +88,27 @@ streamReferences: ../CONFIG_STREAM
$(PERL) ../makeref.pl Interface $(BUSSES) > $@ $(PERL) ../makeref.pl Interface $(BUSSES) > $@
$(PERL) ../makeref.pl Converter $(FORMATS) >> $@ $(PERL) ../makeref.pl Converter $(FORMATS) >> $@
# create stream.dbd from all RECORDTYPES # create stream-base.dbd from all RECORDTYPES except scalcout record
$(COMMON_DIR)/$(LIBRARY_DEFAULT)-base.dbd: ../CONFIG_STREAM
$(PERL) ../makedbd.pl $(if $(ASYN),--with-asyn) $(if $(BASE_3_14),,-3.13) $(filter-out scalcout, $(RECORDTYPES)) > $@
$(LIBRARY_DEFAULT)-base.dbd$(DEP): ../CONFIG_STREAM
echo $(LIBRARY_DEFAULT)-base.dbd: $< > $@
STREAM_DBD_FILES = $(LIBRARY_DEFAULT)-base.dbd
ifdef CALC
# create stream-scalcout.dbd for scalcout record
$(COMMON_DIR)/$(LIBRARY_DEFAULT)-scalcout.dbd: ../CONFIG_STREAM
$(PERL) ../makedbd.pl --rec-only scalcout > $@
$(LIBRARY_DEFAULT)-scalcout.dbd$(DEP): ../CONFIG_STREAM
echo $(LIBRARY_DEFAULT)-scalcout.dbd: $< > $@
STREAM_DBD_FILES += $(LIBRARY_DEFAULT)-scalcout.dbd
endif
# create stream.dbd for all record types
$(COMMON_DIR)/$(LIBRARY_DEFAULT).dbd: ../CONFIG_STREAM $(COMMON_DIR)/$(LIBRARY_DEFAULT).dbd: ../CONFIG_STREAM
$(PERL) ../makedbd.pl $(if $(ASYN),--with-asyn) $(if $(BASE_3_14),,-3.13) $(RECORDTYPES) > $@ $(PERL) ../makedbd.pl $(if $(ASYN),--with-asyn) $(if $(BASE_3_14),,-3.13) $(RECORDTYPES) > $@

View File

@ -26,6 +26,9 @@ endif
include $(TOP)/config/CONFIG_APP include $(TOP)/config/CONFIG_APP
include ../CONFIG_STREAM include ../CONFIG_STREAM
CXXCMPLR=NORMAL
G++_NORMAL = $(G++)
LIBNAME = streamLib LIBNAME = streamLib
SRCS.cc += $(BUSSES:%=../%Interface.cc) SRCS.cc += $(BUSSES:%=../%Interface.cc)

View File

@ -20,9 +20,10 @@
#include "StreamFormatConverter.h" #include "StreamFormatConverter.h"
#include "StreamError.h" #include "StreamError.h"
#include "string.h"
#include "pcre.h" #include "pcre.h"
#include <string.h>
#include <limits.h> #include <limits.h>
#include <ctype.h>
#define Z PRINTF_SIZE_T_PREFIX #define Z PRINTF_SIZE_T_PREFIX
@ -197,54 +198,94 @@ static void regsubst(const StreamFormat& fmt, StreamBuffer& buffer, size_t start
debug("pcre_exec: no match\n"); debug("pcre_exec: no match\n");
break; break;
} }
if (!(fmt.flags & sign_flag) && n < fmt.prec) // without + flag
{
// do not yet replace this match
c += ovector[1];
continue;
}
// replace subexpressions
l = ovector[1] - ovector[0]; l = ovector[1] - ovector[0];
debug("before [%d]= \"%s\"\n", ovector[0], buffer.expand(start+c,ovector[0])());
debug("match [%d]= \"%s\"\n", l, buffer.expand(start+c+ovector[0],l)()); // no prec: replace all matches
for (r = 1; r < rc; r++) // prec with + flag: replace first prec matches
debug("sub%d = \"%s\"\n", r, buffer.expand(start+c+ovector[r*2], ovector[r*2+1]-ovector[r*2])()); // prec without + flag: replace only match number prec
debug("after = \"%s\"\n", buffer.expand(start+c+ovector[1])());
s = subst; if ((fmt.flags & sign_flag) || n >= fmt.prec)
debug("subs = \"%s\"\n", s.expand()());
for (r = 0; r < (int)s.length(); r++)
{ {
debug("check \"%s\"\n", s.expand(r)()); // replace subexpressions
if (s[r] == esc) debug("before [%d]= \"%s\"\n", ovector[0], buffer.expand(start+c,ovector[0])());
debug("match [%d]= \"%s\"\n", l, buffer.expand(start+c+ovector[0],l)());
for (r = 1; r < rc; r++)
debug("sub%d = \"%s\"\n", r, buffer.expand(start+c+ovector[r*2], ovector[r*2+1]-ovector[r*2])());
debug("after = \"%s\"\n", buffer.expand(start+c+ovector[1])());
s = subst;
debug("subs = \"%s\"\n", s.expand()());
for (r = 0; r < (int)s.length(); r++)
{ {
unsigned char ch = s[r+1]; debug("check \"%s\"\n", s.expand(r)());
debug("found escaped \\%u, in range 1-%d?\n", ch, rc-1); if (s[r] == esc)
if (ch != 0 && ch < rc) // escaped 1 - 9 : replace with subexpr
{ {
ch *= 2; unsigned char ch = s[r+1];
rl = ovector[ch+1] - ovector[ch]; if (strchr("ulUL", ch))
debug("yes, replace \\%d: \"%s\"\n", ch/2, buffer.expand(start+c+ovector[ch], rl)()); {
s.replace(r, 2, buffer(start+c+ovector[ch]), rl); unsigned char br = s[r+2] - '0';
r += rl - 1; if (br == (unsigned char)('&'-'0')) br = 0;
debug("found case conversion \\%c%u\n", ch, br);
if (br >= rc)
{
s.remove(r, 1);
continue;
}
br *= 2;
rl = ovector[br+1] - ovector[br];
s.replace(r, 3, buffer(start+c+ovector[br]), rl);
switch (ch)
{
case 'u':
if (islower(s[r])) s[r] = toupper(s[r]);
break;
case 'l':
if (isupper(s[r])) s[r] = tolower(s[r]);
break;
case 'U':
for (int i = 0; i < rl; i++)
if (islower(s[r+i])) s[r+i] = toupper(s[r+i]);
break;
case 'L':
for (int i = 0; i < rl; i++)
if (isupper(s[r+i])) s[r+i] = tolower(s[r+i]);
break;
}
}
else if (ch != 0 && ch < rc) // escaped 1 - 9 : replace with subexpr
{
debug("found escaped \\%u\n", ch);
ch *= 2;
rl = ovector[ch+1] - ovector[ch];
debug("yes, replace \\%d: \"%s\"\n", ch/2, buffer.expand(start+c+ovector[ch], rl)());
s.replace(r, 2, buffer(start+c+ovector[ch]), rl);
r += rl - 1;
}
else
{
debug("use literal \\%u\n", ch);
s.remove(r, 1); // just remove escape
}
} }
else else if (s[r] == '&') // unescaped & : replace with match
{ {
debug("no, use literal \\%u\n", ch); debug("replace &: \"%s\"\n", buffer.expand(start+c+ovector[0], l)());
s.remove(r, 1); // just remove escape s.replace(r, 1, buffer(start+c+ovector[0]), l);
r += l - 1;
} }
else continue;
debug("subs = \"%s\"\n", s.expand()());
} }
else if (s[r] == '&') // unescaped & : replace with match buffer.replace(start+c+ovector[0], l, s);
{ length -= l;
debug("replace &: \"%s\"\n", buffer.expand(start+c+ovector[0], l)()); length += s.length();
s.replace(r, 1, buffer(start+c+ovector[0]), l); c += s.length();
r += l - 1; }
} c += ovector[0];
else continue; if (l == 0)
debug("subs = \"%s\"\n", s.expand()()); {
debug("pcre_exec: empty match\n");
c++; // Empty strings may lead to an endless loop. Match them only once.
} }
buffer.replace(start+c+ovector[0], l, s);
length += s.length() - l;
c += ovector[0] + s.length();
if (n == fmt.prec) // max match reached if (n == fmt.prec) // max match reached
{ {
debug("pcre_exec: max match %d reached\n", n); debug("pcre_exec: max match %d reached\n", n);

View File

@ -306,7 +306,7 @@ print(const char* fmt, ...)
return *this; return *this;
} }
if (printed > -1) grow(len+printed); if (printed > -1) grow(len+printed);
else grow(len); else grow(cap*2-1);
} }
} }

View File

@ -199,11 +199,10 @@ public:
// find: get index of data in buffer or -1 // find: get index of data in buffer or -1
ssize_t find(char c, ssize_t start=0) const ssize_t find(char c, ssize_t start=0) const
{char* p; {if (start < 0 && (start -= len) < 0) start = 0;
char* p;
return (p = static_cast<char*>( return (p = static_cast<char*>(
memchr(buffer+offs+(start<0?start+len:start), memchr(buffer+offs+start, c, len-start)))? p-(buffer+offs) : -1;}
c, start<0?-start:len-start)))?
p-(buffer+offs) : -1;}
ssize_t find(const void* s, size_t size, ssize_t start=0) const; ssize_t find(const void* s, size_t size, ssize_t start=0) const;

View File

@ -118,7 +118,7 @@ writeRequest(const void*, size_t, unsigned long)
} }
bool StreamBusInterface:: bool StreamBusInterface::
readRequest(unsigned long, unsigned long, size_t, bool) readRequest(unsigned long, unsigned long, ssize_t, bool)
{ {
return false; return false;
} }

View File

@ -76,7 +76,7 @@ public:
return businterface && businterface->writeRequest(output, size, timeout_ms); return businterface && businterface->writeRequest(output, size, timeout_ms);
} }
bool busReadRequest(unsigned long replytimeout_ms, bool busReadRequest(unsigned long replytimeout_ms,
unsigned long readtimeout_ms, size_t expectedLength, unsigned long readtimeout_ms, ssize_t expectedLength,
bool async) { bool async) {
return businterface && businterface->readRequest(replytimeout_ms, return businterface && businterface->readRequest(replytimeout_ms,
readtimeout_ms, expectedLength, async); readtimeout_ms, expectedLength, async);
@ -133,7 +133,7 @@ protected:
virtual bool writeRequest(const void* output, size_t size, virtual bool writeRequest(const void* output, size_t size,
unsigned long timeout_ms); unsigned long timeout_ms);
virtual bool readRequest(unsigned long replytimeout_ms, virtual bool readRequest(unsigned long replytimeout_ms,
unsigned long readtimeout_ms, size_t expectedLength, unsigned long readtimeout_ms, ssize_t expectedLength,
bool async); bool async);
virtual bool supportsEvent(); // defaults to false virtual bool supportsEvent(); // defaults to false
virtual bool supportsAsyncRead(); // defaults to false virtual bool supportsAsyncRead(); // defaults to false

View File

@ -25,18 +25,16 @@
#define Z PRINTF_SIZE_T_PREFIX #define Z PRINTF_SIZE_T_PREFIX
ENUM (Commands,
end, in, out, wait, event, exec, connect, disconnect);
/// debug functions ///////////////////////////////////////////// /// debug functions /////////////////////////////////////////////
static char* printCommands(StreamBuffer& buffer, const char* c) char* StreamCore::
printCommands(StreamBuffer& buffer, const char* c)
{ {
unsigned long timeout; unsigned long timeout;
unsigned long eventnumber; unsigned long eventnumber;
while (1) while (1)
{ {
switch(*c++) switch (*c++)
{ {
case end: case end:
return buffer(); return buffer();
@ -191,14 +189,26 @@ parse(const char* filename, const char* _protocolname)
ssize_t i = protocolname.find('('); ssize_t i = protocolname.find('(');
if (i >= 0) if (i >= 0)
{ {
while (i >= 0) while (i < (ssize_t)protocolname.length())
{ {
if (protocolname[i-1] == ' ') if (protocolname[i-1] == ' ')
protocolname.remove(--i, 1); // remove trailing space protocolname.remove(--i, 1); // remove trailing space
protocolname[i] = '\0'; // replace '(' and ',' with '\0' protocolname[i] = '\0'; // replace initial '(' and separating ',' with '\0'
if (protocolname[i+1] == ' ') if (protocolname[i+1] == ' ')
protocolname.remove(i+1, 1); // remove leading space protocolname.remove(i+1, 1); // remove leading space
i = protocolname.find(',', i+1); int brackets = 0;
do {
i++;
i += strcspn(protocolname(i), ",()\\");
char c = protocolname[i];
if (c == '(') brackets++;
else if (c == ')') brackets--;
else if (c == ',' && brackets <= 0) break;
else if (c == '\\') {
if (protocolname[i+1] == '\\') i++; // keep '\\'
else protocolname.remove(i, 1); // else skip over next char
}
} while (i < (ssize_t)protocolname.length());
} }
// should have closing parentheses // should have closing parentheses
if (protocolname[-1] != ')') if (protocolname[-1] != ')')
@ -208,9 +218,8 @@ parse(const char* filename, const char* _protocolname)
} }
protocolname.truncate(-1); // remove ')' protocolname.truncate(-1); // remove ')'
if (protocolname[-1] == ' ') if (protocolname[-1] == ' ')
{
protocolname.truncate(-1); // remove trailing space protocolname.truncate(-1); // remove trailing space
} debug("StreamCore::parse \"%s\" -> \"%s\"\n", _protocolname, protocolname.expand()());
} }
StreamProtocolParser::Protocol* protocol; StreamProtocolParser::Protocol* protocol;
protocol = StreamProtocolParser::getProtocol(filename, protocolname); protocol = StreamProtocolParser::getProtocol(filename, protocolname);
@ -449,10 +458,10 @@ finishProtocol(ProtocolResult status)
debug("StreamCore::finishProtocol(%s, %s) %sbus owner\n", debug("StreamCore::finishProtocol(%s, %s) %sbus owner\n",
name(), toStr(status), flags & BusOwner ? "" : "not "); name(), toStr(status), flags & BusOwner ? "" : "not ");
if (flags & BusPending) if (status == Success && flags & BusPending)
{ {
error("StreamCore::finishProtocol(%s): Still waiting for %s%s%s\n", error("StreamCore::finishProtocol(%s, %s): Still waiting for %s%s%s\n",
name(), name(), toStr(status),
flags & LockPending ? "lockSuccess() " : "", flags & LockPending ? "lockSuccess() " : "",
flags & WritePending ? "writeSuccess() " : "", flags & WritePending ? "writeSuccess() " : "",
flags & WaitPending ? "timerCallback()" : ""); flags & WaitPending ? "timerCallback()" : "");
@ -903,11 +912,10 @@ evalIn()
debug("StreamCore::evalIn(%s): early input: %s\n", debug("StreamCore::evalIn(%s): early input: %s\n",
name(), inputBuffer.expand()()); name(), inputBuffer.expand()());
expectedInput = readCallback(lastInputStatus, NULL, 0); expectedInput = readCallback(lastInputStatus, NULL, 0);
if (!expectedInput) if (expectedInput == 0)
{
// no more input needed
return true; return true;
} if (expectedInput == -1) // don't know how much
expectedInput = 0;
} }
if (flags & AsyncMode) if (flags & AsyncMode)
{ {
@ -919,14 +927,12 @@ evalIn()
busUnlock(); busUnlock();
flags &= ~BusOwner; flags &= ~BusOwner;
} }
busReadRequest(pollPeriod, readTimeout, return busReadRequest(pollPeriod, readTimeout,
expectedInput, true); expectedInput, true);
return true;
} }
busReadRequest(replyTimeout, readTimeout, return busReadRequest(replyTimeout, readTimeout,
expectedInput, false); expectedInput, false);
// continue with readCallback() in another thread // continue with readCallback() in another thread
return true;
} }
ssize_t StreamCore:: ssize_t StreamCore::
@ -980,8 +986,8 @@ readCallback(StreamIoStatus status,
evalIn(); evalIn();
return 0; return 0;
} }
debug("StreamCore::readCallback(%s): No reply from device within %ld ms\n", error("%s: No reply within %ld ms to \"%s\"\n",
name(), replyTimeout); name(), replyTimeout, outputLine.expand()());
inputBuffer.clear(); inputBuffer.clear();
finishProtocol(ReplyTimeout); finishProtocol(ReplyTimeout);
return 0; return 0;
@ -1082,7 +1088,7 @@ readCallback(StreamIoStatus status,
if (maxInput) if (maxInput)
return maxInput - inputBuffer.length(); return maxInput - inputBuffer.length();
else else
return -1; return -1; // We don't know for how much to wait
} }
// try to parse what we got // try to parse what we got
end = inputBuffer.length(); end = inputBuffer.length();
@ -1348,7 +1354,7 @@ normal_format:
{ {
int i = 0; int i = 0;
while (commandIndex[i] >= ' ') i++; while (commandIndex[i] >= ' ') i++;
error("%s: Input \"%s%s%s\"\n", error("%s: Input \"%s%s%s\"\n",
name(), name(),
consumedInput > 20 ? "..." : "", consumedInput > 20 ? "..." : "",
inputLine.expand(consumedInput > 20 ? consumedInput-20 : 0, 40)(), inputLine.expand(consumedInput > 20 ? consumedInput-20 : 0, 40)(),
@ -1361,7 +1367,7 @@ normal_format:
consumedInput > 10 ? "..." : "", consumedInput > 10 ? "..." : "",
inputLine.expand(consumedInput > 10 ? consumedInput-10 : 0, inputLine.expand(consumedInput > 10 ? consumedInput-10 : 0,
consumedInput > 10 ? 10 : consumedInput)()); consumedInput > 10 ? 10 : consumedInput)());
error("%s: got \"%s%s\" where \"%s\" was expected\n", error("%s: got \"%s%s\" where \"%s\" was expected\n",
name(), name(),
inputLine.expand(consumedInput, 10)(), inputLine.expand(consumedInput, 10)(),

View File

@ -107,6 +107,9 @@ protected:
ENUM(StartMode, ENUM(StartMode,
StartNormal, StartInit, StartAsync); StartNormal, StartInit, StartAsync);
ENUM (Commands,
end, in, out, wait, event, exec, connect, disconnect);
class MutexLock class MutexLock
{ {
StreamCore* stream; StreamCore* stream;
@ -221,6 +224,9 @@ public:
void printProtocol(FILE* = stdout); void printProtocol(FILE* = stdout);
const char* name() { return streamname; } const char* name() { return streamname; }
void printStatus(StreamBuffer& buffer); void printStatus(StreamBuffer& buffer);
private:
char* printCommands(StreamBuffer& buffer, const char* c);
}; };
#endif #endif

View File

@ -29,6 +29,9 @@
#ifdef EPICS_3_13 #ifdef EPICS_3_13
extern "C" { extern "C" {
static char* epicsStrDup(const char *s) { char* c = (char*)malloc(strlen(s)+1); strcpy(c, s); return c; }
#endif #endif
#define epicsAlarmGLOBAL #define epicsAlarmGLOBAL
@ -63,8 +66,8 @@ extern DBBASE *pdbbase;
#include "epicsThread.h" #include "epicsThread.h"
#include "epicsString.h" #include "epicsString.h"
#include "registryFunction.h" #include "registryFunction.h"
#include "epicsStdioRedirect.h"
#include "iocsh.h" #include "iocsh.h"
#include "epicsExport.h"
#if defined(VERSION_INT) || EPICS_MODIFICATION >= 11 #if defined(VERSION_INT) || EPICS_MODIFICATION >= 11
#include "initHooks.h" #include "initHooks.h"
@ -161,10 +164,7 @@ class Stream : protected StreamCore
Stream(dbCommon* record, const struct link *ioLink, Stream(dbCommon* record, const struct link *ioLink,
streamIoFunction readData, streamIoFunction writeData); streamIoFunction readData, streamIoFunction writeData);
~Stream(); ~Stream();
long parseLink(const struct link *ioLink, char* filename, char* protocol, long initRecord(char* linkstring);
char* busname, int* addr, char* busparam);
long initRecord(const char* filename, const char* protocol,
const char* busname, int addr, const char* busparam);
bool print(format_t *format, va_list ap); bool print(format_t *format, va_list ap);
ssize_t scan(format_t *format, void* pvalue, size_t maxStringSize); ssize_t scan(format_t *format, void* pvalue, size_t maxStringSize);
bool process(); bool process();
@ -211,7 +211,7 @@ long streamReload(const char* recordname)
int oldStreamError = streamError; int oldStreamError = streamError;
streamError = 1; streamError = 1;
if(!pdbbase) { if (!pdbbase) {
error("No database has been loaded\n"); error("No database has been loaded\n");
streamError = oldStreamError; streamError = oldStreamError;
return ERROR; return ERROR;
@ -223,7 +223,7 @@ long streamReload(const char* recordname)
if (recordname && recordname[0] && if (recordname && recordname[0] &&
#ifdef EPICS_3_13 #ifdef EPICS_3_13
strcmp(stream->name(), recordname) == 0) strcmp(stream->name(), recordname) == 0)
#else #else
!epicsStrGlobMatch(stream->name(), recordname)) !epicsStrGlobMatch(stream->name(), recordname))
#endif #endif
continue; continue;
@ -534,12 +534,7 @@ long streamInitRecord(dbCommon* record, const struct link *ioLink,
streamIoFunction readData, streamIoFunction writeData) streamIoFunction readData, streamIoFunction writeData)
{ {
long status; long status;
char filename[256]; char* linkstring;
char protocol[256];
char busname[256];
int addr = -1;
char busparam[256];
memset(busparam, 0 ,sizeof(busparam));
debug("streamInitRecord(%s): SEVR=%d\n", record->name, record->sevr); debug("streamInitRecord(%s): SEVR=%d\n", record->name, record->sevr);
Stream* stream = static_cast<Stream*>(record->dpvt); Stream* stream = static_cast<Stream*>(record->dpvt);
@ -556,19 +551,30 @@ long streamInitRecord(dbCommon* record, const struct link *ioLink,
record->name); record->name);
stream->finishProtocol(Stream::Abort); stream->finishProtocol(Stream::Abort);
} }
// scan the i/o link if (ioLink->type != INST_IO)
debug("streamInitRecord(%s): parse link \"%s\"\n",
record->name, ioLink->value.instio.string);
status = stream->parseLink(ioLink, filename, protocol,
busname, &addr, busparam);
// (re)initialize bus and protocol
if (status == 0)
{ {
debug("streamInitRecord(%s): calling initRecord\n", error("%s: Wrong I/O link type %s\n", record->name,
record->name); pamaplinkType[ioLink->type].strvalue);
status = stream->initRecord(filename, protocol, return S_dev_badInitRet;
busname, addr, busparam);
} }
if (!ioLink->value.instio.string[0])
{
error("%s: Empty I/O link. "
"Forgot the leading '@' or confused INP with OUT or link is too long ?\n",
record->name);
return S_dev_badInitRet;
}
// (re)initialize bus and protocol
linkstring = epicsStrDup(ioLink->value.instio.string);
if (!linkstring)
{
error("%s: Out of memory", record->name);
return S_dev_noMemory;
}
debug("streamInitRecord(%s): calling initRecord\n",
record->name);
status = stream->initRecord(linkstring);
free(linkstring);
if (status != OK && status != DO_NOT_CONVERT) if (status != OK && status != DO_NOT_CONVERT)
{ {
error("%s: Record initialization failed\n", record->name); error("%s: Record initialization failed\n", record->name);
@ -587,7 +593,6 @@ long streamReadWrite(dbCommon *record)
if (!stream || stream->status == ERROR) if (!stream || stream->status == ERROR)
{ {
(void) recGblSetSevr(record, UDF_ALARM, INVALID_ALARM); (void) recGblSetSevr(record, UDF_ALARM, INVALID_ALARM);
error("%s: Record not initialised correctly\n", record->name);
return ERROR; return ERROR;
} }
return stream->process() ? stream->convert : ERROR; return stream->process() ? stream->convert : ERROR;
@ -699,77 +704,77 @@ Stream::
} }
long Stream:: long Stream::
parseLink(const struct link *ioLink, char* filename, initRecord(char* linkstring /* modifiable copy */)
char* protocol, char* busname, int* addr, char* busparam)
{ {
// parse link parameters: filename protocol busname addr busparam char *filename;
int n1, n2; char *protocol;
if (ioLink->type != INST_IO) char *busname;
{ char *busparam;
error("%s: Wrong I/O link type %s\n", name(), long addr = -1;
pamaplinkType[ioLink->type].strvalue);
return S_dev_badInitRet;
}
if (0 >= sscanf(ioLink->value.instio.string, "%s%n", filename, &n1))
{
error("%s: Empty I/O link. "
"Forgot the leading '@' or confused INP with OUT or link is too long ?\n",
name());
return S_dev_badInitRet;
}
if (0 >= sscanf(ioLink->value.instio.string+n1, " %[^ \t(] %n", protocol, &n2))
{
error("%s: Missing protocol name\n"
" expect \"@file protocol[(arg1,...)] bus [addr] [params]\"\n"
" in \"@%s\"\n", name(),
ioLink->value.instio.string);
return S_dev_badInitRet;
}
n1+=n2;
if (ioLink->value.instio.string[n1] == '(')
{
n2 = 0;
sscanf(ioLink->value.instio.string+n1, " %[^)] %n", protocol+strlen(protocol), &n2);
n1+=n2;
if (ioLink->value.instio.string[n1++] != ')')
{
error("%s: Missing ')' after protocol arguments '%s'\n"
" expect \"@file protocol(arg1,...) bus [addr] [params]\"\n"
" in \"@%s\"\n", name(), protocol,
ioLink->value.instio.string);
return S_dev_badInitRet;
}
strcat(protocol, ")");
}
if (0 >= sscanf(ioLink->value.instio.string+n1, "%s %i %99c", busname, addr, busparam))
{
error("%s: Missing bus name\n"
" expect \"@file protocol[(arg1,...)] bus [addr] [params]\"\n"
" in \"@%s\"\n", name(),
ioLink->value.instio.string);
return S_dev_badInitRet;
}
return OK;
}
long Stream:: debug("Stream::initRecord %s: parse link string \"%s\"\n", name(), linkstring);
initRecord(const char* filename, const char* protocol,
const char* busname, int addr, const char* busparam) while (isspace(*linkstring)) linkstring++;
{ filename = linkstring;
// It is safe to call this function again with different arguments while (*linkstring && !isspace(*linkstring)) linkstring++;
if (*linkstring) *linkstring++ = 0;
while (isspace(*linkstring)) linkstring++;
protocol = linkstring;
while (*linkstring && !isspace(*linkstring) && *linkstring != '(') linkstring++;
while (isspace(*linkstring)) linkstring++;
if (*linkstring == '(') {
int brackets = 0;
while(*++linkstring) {
if (*linkstring == '(') brackets++;
else if (*linkstring == ')') brackets--;
else if (*linkstring == '\\' && !*++linkstring) break;
else if (isspace(*linkstring) && brackets < 0) break;
}
}
else if (*linkstring) linkstring--;
if (*linkstring) *linkstring++ = 0;
while (isspace(*linkstring)) linkstring++;
busname = linkstring;
while (*linkstring && !isspace(*linkstring)) linkstring++;
if (*linkstring) *linkstring++ = 0;
if (linkstring) addr = strtol(linkstring, &linkstring, 0);
while (isspace(*linkstring)) linkstring++;
busparam = linkstring;
debug("Stream::initRecord %s: filename=\"%s\" protocol=\"%s\" bus=\"%s\" addr=%ld params=\"%s\"\n",
name(), filename, protocol, busname, addr, busparam);
if (!*filename)
{
error("%s: Missing protocol file name\n", name());
return S_dev_badInitRet;
}
if (!*protocol)
{
error("%s: Missing protocol name\n", name());
return S_dev_badInitRet;
}
if (!*busname)
{
error("%s: Missing bus name\n", name());
return S_dev_badInitRet;
}
// attach to bus interface // attach to bus interface
debug("Stream::initRecord %s: attachBus(%s, %d, \"%s\")\n", debug("Stream::initRecord %s: attachBus(\"%s\", %ld, \"%s\")\n",
name(), busname, addr, busparam); name(), busname, addr, busparam);
if (!attachBus(busname, addr, busparam)) if (!attachBus(busname, addr, busparam))
{ {
error("%s: Can't attach to bus %s %d\n", error("%s: Can't attach to bus %s %ld\n",
name(), busname, addr); name(), busname, addr);
return S_dev_noDevice; return S_dev_noDevice;
} }
// parse protocol file // parse protocol file
debug("Stream::initRecord %s: parse(%s, %s)\n", debug("Stream::initRecord %s: parse(\"%s\", \"%s\")\n",
name(), filename, protocol); name(), filename, protocol);
if (!parse(filename, protocol)) if (!parse(filename, protocol))
{ {
@ -872,7 +877,7 @@ process()
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=%s (%d)\n", debug("Stream::process(%s): could not start %sprotocol, status=%s (%d)\n",
name(), record->proc == 2 ? "@init " : "", name(), record->proc == 2 ? "@init " : "",
status >= 0 && status < ALARM_NSTATUS ? status >= 0 && status < ALARM_NSTATUS ?
epicsAlarmConditionStrings[status] : "ERROR", epicsAlarmConditionStrings[status] : "ERROR",
status); status);
@ -1100,7 +1105,7 @@ getFieldAddress(const char* fieldname, StreamBuffer& address)
} }
static const unsigned char dbfMapping[] = static const unsigned char dbfMapping[] =
#ifdef DBF_INT64 #ifdef DBR_INT64
{0, DBF_UINT64, DBF_INT64, DBF_ENUM, DBF_DOUBLE, DBF_STRING}; {0, DBF_UINT64, DBF_INT64, DBF_ENUM, DBF_DOUBLE, DBF_STRING};
#else #else
{0, DBF_ULONG, DBF_LONG, DBF_ENUM, DBF_DOUBLE, DBF_STRING}; {0, DBF_ULONG, DBF_LONG, DBF_ENUM, DBF_DOUBLE, DBF_STRING};

View File

@ -26,13 +26,8 @@
#include <stdio.h> #include <stdio.h>
int streamDebug = 0; int streamDebug = 0;
int streamError = 0; int streamError = 1;
extern "C" {
#ifdef _WIN32
__declspec(dllexport)
#endif
FILE *StreamDebugFile = NULL; FILE *StreamDebugFile = NULL;
}
#ifndef va_copy #ifndef va_copy
#ifdef __va_copy #ifdef __va_copy
@ -43,6 +38,11 @@ FILE *StreamDebugFile = NULL;
#ifdef _WIN32 #ifdef _WIN32
#define localtime_r(timet,tm) localtime_s(tm,timet) #define localtime_r(timet,tm) localtime_s(tm,timet)
/* this may not be defined if using older Windows SDKs */
#ifndef ENABLE_VIRTUAL_TERMINAL_PROCESSING
#define ENABLE_VIRTUAL_TERMINAL_PROCESSING 0x0004
#endif
/* Enable ANSI colors in Windows console */ /* Enable ANSI colors in Windows console */
static int win_console_init() { static int win_console_init() {
DWORD dwMode = 0; DWORD dwMode = 0;
@ -90,7 +90,7 @@ void StreamError(int line, const char* file, const char* fmt, ...)
void StreamVError(int line, const char* file, const char* fmt, va_list args) void StreamVError(int line, const char* file, const char* fmt, va_list args)
{ {
char timestamp[40]; char timestamp[40];
if (!streamError) return; // Error logging disabled if (!(streamError || streamDebug)) return; // Error logging disabled
StreamPrintTimestampFunction(timestamp, 40); StreamPrintTimestampFunction(timestamp, 40);
#ifdef va_copy #ifdef va_copy
if (StreamDebugFile) if (StreamDebugFile)

View File

@ -286,7 +286,7 @@ parseProtocol(Protocol& protocol, StreamBuffer* commands)
} }
if (token[0] == '{') if (token[0] == '{')
{ {
error(line, filename(), "Expect %s name before '%c'\n", error(line, filename(), "Expect %s name before '%c'\n",
isGlobalContext(commands) ? "protocol" : "handler", isGlobalContext(commands) ? "protocol" : "handler",
token[0]); token[0]);
return false; return false;
@ -1039,7 +1039,7 @@ compileNumber(unsigned long& number, const char*& source, unsigned long max)
*source, source); *source, source);
if (*source == '$') if (*source == '$')
{ {
if(!replaceVariable(buffer, source)) return false; if (!replaceVariable(buffer, source)) return false;
debug("buffer=%s\n", buffer.expand()()); debug("buffer=%s\n", buffer.expand()());
buffer.truncate(-1-(int)sizeof(int)); buffer.truncate(-1-(int)sizeof(int));
} }
@ -1124,6 +1124,13 @@ compileString(StreamBuffer& buffer, const char*& source,
continue; continue;
} }
if (c == '%') { if (c == '%') {
if (buffer[formatpos+1] == '%') {
// treat %% as literal % like printf/scanf do
// replace with escaped %
buffer[formatpos] = esc;
formatpos+=2;
continue;
}
debug("StreamProtocolParser::Protocol::compileString " debug("StreamProtocolParser::Protocol::compileString "
"format=\"%s\"\n", buffer.expand(formatpos)()); "format=\"%s\"\n", buffer.expand(formatpos)());
nformats++; nformats++;

View File

@ -26,10 +26,6 @@
#include <string.h> #include <string.h>
#include <sys/types.h> #include <sys/types.h>
#if defined(__cplusplus)
extern "C" {
#endif
#define STREAM_MAJOR 2 #define STREAM_MAJOR 2
#define STREAM_MINOR 8 #define STREAM_MINOR 8
@ -44,14 +40,19 @@ extern "C" {
#define DO_NOT_CONVERT 2 #define DO_NOT_CONVERT 2
#define INIT_RUN (!interruptAccept) #define INIT_RUN (!interruptAccept)
#include "epicsVersion.h"
#ifdef BASE_VERSION
#define EPICS_3_13
#endif
#ifdef epicsExportSharedSymbols #ifdef epicsExportSharedSymbols
# define devStream_epicsExportSharedSymbols # define devStream_epicsExportSharedSymbols
# undef epicsExportSharedSymbols # undef epicsExportSharedSymbols
# include "shareLib.h"
#endif
#include "epicsVersion.h"
#ifdef BASE_VERSION
#define EPICS_3_13
/* EPICS 3.13 include files are not C++ ready. */
#ifdef __cplusplus
extern "C" {
#endif
#endif #endif
#include "dbCommon.h" #include "dbCommon.h"
@ -64,11 +65,21 @@ extern "C" {
#include "dbEvent.h" #include "dbEvent.h"
#include "epicsMath.h" #include "epicsMath.h"
#ifdef devStream_epicsExportSharedSymbols #ifdef EPICS_3_13
# define epicsExportSharedSymbols #ifdef __cplusplus
}
#endif
#else
#include "epicsStdioRedirect.h"
#endif #endif
#if defined(_WIN32) #ifdef devStream_epicsExportSharedSymbols
# undef devStream_epicsExportSharedSymbols
# define epicsExportSharedSymbols
# include "shareLib.h"
#endif
#ifdef _WIN32
typedef ptrdiff_t ssize_t; typedef ptrdiff_t ssize_t;
#endif #endif
@ -77,11 +88,16 @@ typedef const struct format_s {
const struct StreamFormat* priv; const struct StreamFormat* priv;
} format_t; } format_t;
epicsShareExtern FILE* StreamDebugFile; extern FILE* StreamDebugFile;
extern const char StreamVersion [];
typedef long (*streamIoFunction) (dbCommon*, format_t*); typedef long (*streamIoFunction) (dbCommon*, format_t*);
#ifdef __cplusplus
extern "C" {
#endif
extern const char StreamVersion [];
long streamInit(int after); long streamInit(int after);
long streamInitRecord(dbCommon *record, long streamInitRecord(dbCommon *record,
const struct link *ioLink, const struct link *ioLink,
@ -94,6 +110,10 @@ long streamPrintf(dbCommon *record, format_t *format, ...);
ssize_t streamScanfN(dbCommon *record, format_t *format, ssize_t streamScanfN(dbCommon *record, format_t *format,
void*, size_t maxStringSize); void*, size_t maxStringSize);
#ifdef __cplusplus
}
#endif
/* backward compatibility stuff */ /* backward compatibility stuff */
#define streamScanf(record, format, value) \ #define streamScanf(record, format, value) \
streamScanfN(record, format, value, MAX_STRING_SIZE) streamScanfN(record, format, value, MAX_STRING_SIZE)
@ -107,8 +127,4 @@ ssize_t streamScanfN(dbCommon *record, format_t *format,
#include "epicsExport.h" #include "epicsExport.h"
#endif #endif
#ifdef __cplusplus
}
#endif
#endif #endif

View File

@ -69,7 +69,7 @@ static long readData(dbCommon *record, format_t *format)
case DBF_FLOAT: case DBF_FLOAT:
((epicsFloat32 *)aai->bptr)[aai->nord] = (epicsFloat32)lval; ((epicsFloat32 *)aai->bptr)[aai->nord] = (epicsFloat32)lval;
break; break;
#ifdef DBF_INT64 #ifdef DBR_INT64
case DBF_INT64: case DBF_INT64:
case DBF_UINT64: case DBF_UINT64:
((epicsInt64 *)aai->bptr)[aai->nord] = (epicsInt64)lval; ((epicsInt64 *)aai->bptr)[aai->nord] = (epicsInt64)lval;
@ -167,7 +167,7 @@ static long writeData(dbCommon *record, format_t *format)
case DBF_FLOAT: case DBF_FLOAT:
dval = ((epicsFloat32 *)aai->bptr)[nowd]; dval = ((epicsFloat32 *)aai->bptr)[nowd];
break; break;
#ifdef DBF_INT64 #ifdef DBR_INT64
case DBF_INT64: case DBF_INT64:
dval = ((epicsInt64 *)aai->bptr)[nowd]; dval = ((epicsInt64 *)aai->bptr)[nowd];
break; break;
@ -210,12 +210,12 @@ static long writeData(dbCommon *record, format_t *format)
{ {
switch (aai->ftvl) switch (aai->ftvl)
{ {
#ifdef DBF_INT64 #ifdef DBR_INT64
case DBF_INT64: case DBF_INT64:
lval = ((epicsInt64 *)aao->bptr)[nowd]; lval = ((epicsInt64 *)aai->bptr)[nowd];
break; break;
case DBF_UINT64: case DBF_UINT64:
lval = ((epicsUInt64 *)aao->bptr)[nowd]; lval = ((epicsUInt64 *)aai->bptr)[nowd];
break; break;
#endif #endif
case DBF_LONG: case DBF_LONG:

View File

@ -68,7 +68,7 @@ static long readData(dbCommon *record, format_t *format)
case DBF_FLOAT: case DBF_FLOAT:
((epicsFloat32 *)aao->bptr)[aao->nord] = (epicsFloat32)lval; ((epicsFloat32 *)aao->bptr)[aao->nord] = (epicsFloat32)lval;
break; break;
#ifdef DBF_INT64 #ifdef DBR_INT64
case DBF_INT64: case DBF_INT64:
case DBF_UINT64: case DBF_UINT64:
((epicsInt64 *)aao->bptr)[aao->nord] = (epicsInt64)lval; ((epicsInt64 *)aao->bptr)[aao->nord] = (epicsInt64)lval;
@ -171,7 +171,7 @@ end_no_check:
#endif #endif
if (monitor_mask) if (monitor_mask)
db_post_events(aao, aao->bptr, monitor_mask); db_post_events(aao, aao->bptr, monitor_mask);
return OK; return OK;
} }
@ -196,7 +196,7 @@ static long writeData(dbCommon *record, format_t *format)
case DBF_FLOAT: case DBF_FLOAT:
dval = ((epicsFloat32 *)aao->bptr)[nowd]; dval = ((epicsFloat32 *)aao->bptr)[nowd];
break; break;
#ifdef DBF_INT64 #ifdef DBR_INT64
case DBF_INT64: case DBF_INT64:
dval = ((epicsInt64 *)aao->bptr)[nowd]; dval = ((epicsInt64 *)aao->bptr)[nowd];
break; break;
@ -239,7 +239,7 @@ static long writeData(dbCommon *record, format_t *format)
{ {
switch (aao->ftvl) switch (aao->ftvl)
{ {
#ifdef DBF_INT64 #ifdef DBR_INT64
case DBF_INT64: case DBF_INT64:
lval = ((epicsInt64 *)aao->bptr)[nowd]; lval = ((epicsInt64 *)aao->bptr)[nowd];
break; break;

View File

@ -46,7 +46,7 @@ static long readData(dbCommon *record, format_t *format)
break; break;
} }
default: default:
return ERROR; return ERROR;
} }
if (record->pact) return OK; if (record->pact) return OK;
/* In @init handler, no processing, enforce monitor updates. */ /* In @init handler, no processing, enforce monitor updates. */
@ -60,10 +60,10 @@ static long readData(dbCommon *record, format_t *format)
monitor_mask |= DBE_LOG; monitor_mask |= DBE_LOG;
co->alst = co->val; co->alst = co->val;
} }
if (monitor_mask){ if (monitor_mask) {
db_post_events(record, &co->val, monitor_mask); db_post_events(record, &co->val, monitor_mask);
} }
return OK; return OK;
} }

View File

@ -25,7 +25,7 @@
of the device support. of the device support.
Fix: sCalcoutRecord.c, end of init_record() add Fix: sCalcoutRecord.c, end of init_record() add
if(pscalcoutDSET->init_record ) { if (pscalcoutDSET->init_record ) {
return (*pscalcoutDSET->init_record)(pcalc); return (*pscalcoutDSET->init_record)(pcalc);
} }
*/ */

View File

@ -70,10 +70,10 @@ static long readData(dbCommon *record, format_t *format)
case DBF_FLOAT: case DBF_FLOAT:
((epicsFloat32 *)wf->bptr)[wf->nord] = (epicsFloat32)lval; ((epicsFloat32 *)wf->bptr)[wf->nord] = (epicsFloat32)lval;
break; break;
#ifdef DBF_INT64 #ifdef DBR_INT64
case DBF_INT64: case DBF_INT64:
case DBF_UINT64: case DBF_UINT64:
((epicsInt64 *)wf->bptr)[aao->nord] = (epicsInt64)lval; ((epicsInt64 *)wf->bptr)[wf->nord] = (epicsInt64)lval;
break; break;
#endif #endif
case DBF_LONG: case DBF_LONG:
@ -168,7 +168,7 @@ static long writeData(dbCommon *record, format_t *format)
case DBF_FLOAT: case DBF_FLOAT:
dval = ((epicsFloat32 *)wf->bptr)[nowd]; dval = ((epicsFloat32 *)wf->bptr)[nowd];
break; break;
#ifdef DBF_INT64 #ifdef DBR_INT64
case DBF_INT64: case DBF_INT64:
dval = ((epicsInt64 *)wf->bptr)[nowd]; dval = ((epicsInt64 *)wf->bptr)[nowd];
break; break;
@ -211,7 +211,7 @@ static long writeData(dbCommon *record, format_t *format)
{ {
switch (wf->ftvl) switch (wf->ftvl)
{ {
#ifdef DBF_INT64 #ifdef DBR_INT64
case DBF_INT64: case DBF_INT64:
lval = ((epicsInt64 *)wf->bptr)[nowd]; lval = ((epicsInt64 *)wf->bptr)[nowd];
break; break;

View File

@ -1,3 +1,6 @@
if (@ARGV[0] eq "--rec-only") {
shift;
} else {
if (@ARGV[0] eq "--with-asyn") { if (@ARGV[0] eq "--with-asyn") {
shift; shift;
$asyn = 1; $asyn = 1;
@ -11,6 +14,7 @@ if (@ARGV[0] eq "-3.13") {
if ($asyn) { print "registrar(AsynDriverInterfaceRegistrar)\n"; } if ($asyn) { print "registrar(AsynDriverInterfaceRegistrar)\n"; }
} }
print "driver(stream)\n"; print "driver(stream)\n";
}
for (@ARGV) { for (@ARGV) {
print "device($_,INST_IO,dev${_}Stream,\"stream\")\n"; print "device($_,INST_IO,dev${_}Stream,\"stream\")\n";
} }

1
streamApp/.gitignore vendored Normal file
View File

@ -0,0 +1 @@
streamAppInclude.dbd

View File

@ -40,8 +40,9 @@ ifneq ($(words $(CALC) $(SYNAPPS)), 0)
# With synApps scalcout record # With synApps scalcout record
streamApp_DBD += calcSupport.dbd streamApp_DBD += calcSupport.dbd
PROD_LIBS += calc PROD_LIBS += calc
# older calc versions require sscan ifneq ($(words $(SSCAN) $(SYNAPPS)), 0)
#PROD_LIBS += sscan PROD_LIBS += sscan
endif
endif endif
streamApp_DBD += stream.dbd streamApp_DBD += stream.dbd

View File

@ -7,19 +7,27 @@ include $(TOP)/config/CONFIG_APP
LIBNAME = streamApp LIBNAME = streamApp
DBD += base-3-13.dbd
DBD += stream.dbd
LDLIBS += $(TOP)/bin/$(T_A)/streamLib LDLIBS += $(TOP)/bin/$(T_A)/streamLib
ifdef ASYN
LDLIBS += $(ASYN)/bin/$(T_A)/asynLib LDLIBS += $(ASYN)/bin/$(T_A)/asynLib
DBD += asyn.dbd
endif
ifdef COMPAT
LDLIBS += $(COMPAT)/bin/$(T_A)/compatLib LDLIBS += $(COMPAT)/bin/$(T_A)/compatLib
endif
include ../base-3-13LIBOBJS include ../base-3-13LIBOBJS
streamApp_DBD += base-3-13.dbd
streamApp_DBD += stream.dbd
DBDNAME = streamApp.dbd DBDNAME = streamApp.dbd
DBDEXPAND = streamAppInclude-3-13.dbd DBDEXPAND = streamAppInclude.dbd
# Write StreamDevice debug output to this file $(DBDNAME): ../$(DBDEXPAND)
#CPPFLAGS += -DDEBUGFILE=StreamDebug.log .PHONY:: ../$(DBDEXPAND)
../$(DBDEXPAND):
echo -e '$(DBD:%=include "%"\n)' > $@
include $(EPICS_BASE)/config/RULES.Vx include $(EPICS_BASE)/config/RULES.Vx
include ../../config/RULES.munch include ../../config/RULES.munch

View File

@ -1,3 +0,0 @@
include "base-3-13.dbd"
include "asyn.dbd"
include "stream.dbd"

View File

@ -62,14 +62,17 @@ proc startioc {} {
puts $fd "streamApp_registerRecordDeviceDriver" puts $fd "streamApp_registerRecordDeviceDriver"
} }
puts $fd "streamSetLogfile StreamDebug.log" puts $fd "streamSetLogfile StreamDebug.log"
puts $fd "var streamDebug 1"
puts $fd "var streamError 1"
puts $fd "epicsEnvSet STREAM_PROTOCOL_PATH ." puts $fd "epicsEnvSet STREAM_PROTOCOL_PATH ."
puts $fd "drvAsynIPPortConfigure device localhost:$port" puts $fd "drvAsynIPPortConfigure device localhost:$port"
if [info exists startup] {
puts $fd $startup
}
puts $fd "dbLoadRecords test.db" puts $fd "dbLoadRecords test.db"
puts $fd $startup
puts $fd "iocInit" puts $fd "iocInit"
puts $fd "dbl" puts $fd "dbl"
puts $fd "dbior stream 2" puts $fd "dbior stream 2"
puts $fd "var streamDebug 1"
close $fd close $fd
if [info exists streamversion] { if [info exists streamversion] {
set ioc [open "|iocsh test.cmd >& $testname.ioclog 2>@stderr" w] set ioc [open "|iocsh test.cmd >& $testname.ioclog 2>@stderr" w]

View File

@ -0,0 +1,61 @@
#!/usr/bin/env tclsh
source streamtestlib.tcl
# Define records, protocol and startup (text goes to files)
# The asynPort "device" is connected to a network TCP socket
# Talk to the socket with send/receive/assure
# Send commands to the ioc shell with ioccmd
set records {
record(ao, "DZ:test1")
{
field (DTYP, "stream")
field (OUT, "@test.proto test1(ARG(10),20,30) device")
}
record(ao, "DZ:test2")
{
field (DTYP, "stream")
field (OUT, "@test.proto test1 (ARG(10,20), 30) device")
}
record(ao, "DZ:test3")
{
field (DTYP, "stream")
field (OUT, "@test.proto test1 ( ARG ( 10 , 20 ) , 30 ) device")
}
record(ao, "DZ:test4")
{
field (DTYP, "stream")
field (OUT, "@test.proto test1( ARG \\( 10 , 20 , 30 ) device")
}
record(ao, "DZ:test5")
{
field (DTYP, "stream")
field (OUT, "@test.proto test1(\\ ARG\\,\\\\(10,20)\\,30) device")
}
}
set protocol {
Terminator = LF;
test1 { out "VAL:\$1:%d"}
}
set startup {
}
set debug 0
startioc
put DZ:test1 "1"
assure "VAL:ARG(10):1\n"
put DZ:test2 "1"
assure "VAL:ARG(10,20):1\n"
put DZ:test3 "1"
assure "VAL:ARG ( 10 , 20 ):1\n"
put DZ:test4 "1"
assure "VAL: ARG ( 10 :1\n"
put DZ:test5 "1"
assure "VAL: ARG,\\(10,20),30:1\n"
#finish

View File

@ -16,7 +16,7 @@ set records {
set protocol { set protocol {
Terminator = LF; Terminator = LF;
test1 {out "\%\e%d\e\e\%";} test1 {out "\%\e%d%%\e\e\%";}
} }
set startup { set startup {
@ -28,6 +28,6 @@ set debug 0
startioc startioc
put DZ:test1 1 put DZ:test1 1
assure "%\0331\033\033%\n" assure "%\0331%\033\033%\n"
finish finish

View File

@ -63,7 +63,7 @@ fi
for o in $O for o in $O
do do
g++ -I ../../src $o test.cc -o test.exe g++ -I ../../src $o test.cc -o test.exe
test.exe ./test.exe
if [ $? != 0 ] if [ $? != 0 ]
then then
echo -e "\033[31;7mTest failed.\033[0m" echo -e "\033[31;7mTest failed.\033[0m"