Update version numbers

Also contains some reformatting in README.md

appveyor.yml

@@ -46,8 +46,8 @@ environment:
   - TOOLCHAIN: 14.0
   - APPVEYOR_BUILD_WORKER_IMAGE: Visual Studio 2017
     TOOLCHAIN: 2017
-  - TOOLCHAIN: cygwin
   - TOOLCHAIN: mingw
+    APPVEYOR_BUILD_WORKER_IMAGE: Visual Studio 2015
 
 # Platform: architecture
 platform:
@@ -61,6 +61,7 @@ matrix:
   - platform: x64
     TOOLCHAIN: 10.0
 
+
 #---------------------------------#
 #     building & testing          #
 #---------------------------------#
@@ -80,6 +81,9 @@ test_script:
 
 notifications:
 
-  - provider: Slack
-    incoming_webhook:
-      secure: RYOm3FIUYeZGjWKaeTVKwq+C3fzK54AKwbmAoECED45mex3lN+8HmrC845a6mg9xPUJ/ND51RopWVaKDD9/UzaM0SO195RQLKqUTIUafiuM=
+  - provider: Email
+    to:
+      - core-talk@aps.anl.gov
+    on_build_success: false
+
+  - provider: GitHubPullRequest

ci/appveyor-make.bat

@@ -1,6 +1,6 @@
 :: Universal build script for AppVeyor (https://ci.appveyor.com/)
 :: Environment:
-::     TOOLCHAIN      -  toolchain version   [10.0/11.0/12.0/14.0/2017/cygwin/mingw]
+::     TOOLCHAIN      -  toolchain version   [10.0/11.0/12.0/14.0/2017/mingw]
 ::     CONFIGURATION  -  determines EPICS build   [dynamic/static]
 ::     PLATFORM       -  architecture   [x86/x64]
 ::
@@ -20,35 +20,17 @@ echo [INFO] Platform: %OS%
 set "MAKEARGS=-j2 -Otarget"
 if "%APPVEYOR_REPO_BRANCH%"=="3.14" set MAKEARGS=
 
-if "%TOOLCHAIN%"=="cygwin" (
-    set "MAKE=make"
-    if "%OS%"=="64BIT" (
-        set "EPICS_HOST_ARCH=cygwin-x86_64"
-        set "INCLUDE=C:\cygwin64\include;%INCLUDE%"
-        set "PATH=C:\cygwin64\bin;%PATH%"
-        echo [INFO] Cygwin Toolchain 64bit
-    ) else (
-        set "EPICS_HOST_ARCH=cygwin-x86"
-        set "INCLUDE=C:\cygwin\include;%INCLUDE%"
-        set "PATH=C:\cygwin\bin;%PATH%"
-        echo [INFO] Cygwin Toolchain 32bit
-    )
-    echo [INFO] Compiler Version
-    gcc -v
-    goto Finish
-)
-
 if "%TOOLCHAIN%"=="mingw" (
     set "MAKE=mingw32-make"
     if "%OS%"=="64BIT" (
         set "EPICS_HOST_ARCH=windows-x64-mingw"
-        set "INCLUDE=C:\tools\mingw64\include;%INCLUDE%"
-        set "PATH=C:\tools\mingw64\bin;%PATH%"
+        set "INCLUDE=C:\mingw-w64\x86_64-8.1.0-posix-seh-rt_v6-rev0\mingw64\include;%INCLUDE%"
+        set "PATH=C:\mingw-w64\x86_64-8.1.0-posix-seh-rt_v6-rev0\mingw64\bin;%PATH%"
         echo [INFO] MinGW Toolchain 64bit
     ) else (
         set "EPICS_HOST_ARCH=win32-x86-mingw"
-        set "INCLUDE=C:\tools\mingw32\include;%INCLUDE%"
-        set "PATH=C:\tools\mingw32\bin;%PATH%"
+        set "INCLUDE=C:\mingw-w64\i686-6.3.0-posix-dwarf-rt_v5-rev1\mingw32\include;%INCLUDE%"
+        set "PATH=C:\mingw-w64\i686-6.3.0-posix-dwarf-rt_v5-rev1\mingw32\bin;%PATH%"
         echo [INFO] MinGW Toolchain 32bit
     )
     echo [INFO] Compiler Version

ci/appveyor-prepare.bat

@@ -1,12 +1,12 @@
 :: Build script for AppVeyor (https://ci.appveyor.com/)
 :: Environment:
-::     TOOLCHAIN      -  Toolchain Version  [9.0/10.0/11.0/12.0/14.0/cygwin/mingw]
+::     TOOLCHAIN      -  Toolchain Version  [9.0/10.0/11.0/12.0/14.0/mingw]
 ::     CONFIGURATION  -  determines EPICS build  [dynamic/static, -debug]
 ::     PLATFORM       -  "x86" -> use 32bit architecture
 ::
 :: Prepares an Appveyor build by excuting the following steps
 ::     - Set up configure\CONFIG_SITE for static vs. dynamic build
-::     - Install Cygwin / Mingw  (TOOLCHAIN setting) in the in the appropriate flavor
+::     - Install Mingw  (TOOLCHAIN setting) in the in the appropriate flavor
 ::     - Download and install Make-4.1 from EPICS download page
 
 Setlocal EnableDelayedExpansion
@@ -16,31 +16,6 @@ if "%PLATFORM%"=="x86" set OS=32BIT
 
 echo [INFO] Platform: %OS%
 
-if "%TOOLCHAIN%"=="cygwin" (
-    echo.%CONFIGURATION% | findstr /C:"static">nul && (
-        echo SHARED_LIBRARIES=NO>> configure\CONFIG_SITE
-        echo STATIC_BUILD=YES>> configure\CONFIG_SITE
-        echo [INFO] EPICS set up for static build
-    ) || (
-        echo [INFO] EPICS set up for dynamic build
-    )
-    echo.%CONFIGURATION% | findstr /C:"debug">nul && (
-        echo HOST_OPT=NO>> configure\CONFIG_SITE
-        echo [INFO] EPICS set up for debug build
-    ) || (
-        echo [INFO] EPICS set up for optimized build
-    )
-    if "%OS%"=="64BIT" (
-        echo [INFO] Installing Cygwin 64bit and dependencies
-        @powershell -Command "(new-object net.webclient).DownloadFile('http://www.cygwin.com/setup-x86_64.exe', 'C:\cygwin64\setup-x86_64.exe')"
-        C:\cygwin64\setup-x86_64.exe -q -P "libreadline-devel,libncursesw-devel"
-    ) else (
-        echo [INFO] Installing Cygwin 32bit and dependencies
-        @powershell -Command "(new-object net.webclient).DownloadFile('http://www.cygwin.com/setup-x86.exe', 'C:\cygwin\setup-x86.exe')"
-        C:\cygwin\setup-x86.exe -q -P "libreadline-devel,libncursesw-devel"
-    )
-)
-
 if "%TOOLCHAIN%"=="mingw" (
     echo.%CONFIGURATION% | findstr /C:"static">nul && (
         echo SHARED_LIBRARIES=NO>> configure\CONFIG_SITE
@@ -55,16 +30,9 @@ if "%TOOLCHAIN%"=="mingw" (
     ) || (
         echo [INFO] EPICS set up for optimized build
     )
-    if "%OS%"=="64BIT" (
-        echo [INFO] Installing MinGW 64bit
-        cinst mingw || cinst mingw
-    ) else (
-        echo [INFO] Installing MinGW 32bit
-        cinst mingw --x86 || cinst mingw --x86
-    )
 )
 
-echo [INFO] Installing Make 4.1
-curl -fsS --retry 3 -o C:\tools\make-4.1.zip https://epics.anl.gov/download/tools/make-4.1-win64.zip
+echo [INFO] Installing Make 4.2.1 from ANL web site
+curl -fsS --retry 3 -o C:\tools\make-4.2.1.zip https://epics.anl.gov/download/tools/make-4.2.1-win64.zip
 cd \tools
-"C:\Program Files\7-Zip\7z" e make-4.1.zip
+"C:\Program Files\7-Zip\7z" e make-4.2.1.zip

configure/CONFIG_BASE

@@ -69,6 +69,7 @@ REGISTERRECORDDEVICEDRIVER = $(PERL) $(TOOLS)/registerRecordDeviceDriver.pl
 CONVERTRELEASE             = $(PERL) $(call FIND_TOOL,convertRelease.pl)
 FULLPATHNAME               = $(PERL) $(TOOLS)/fullPathName.pl
 TAPTOJUNIT                 = $(PERL) $(TOOLS)/tap-to-junit-xml.pl
+PROVE                      = $(PERL) $(TOOLS)/epicsProve.pl
 
 #-------------------------------------------------------
 # tools for installing libraries and products

configure/CONFIG_BASE_VERSION

@@ -27,14 +27,14 @@ EPICS_VERSION = 3
 EPICS_REVISION = 15
 
 # EPICS_MODIFICATION must be a number >=0 and <256
-EPICS_MODIFICATION = 6
+EPICS_MODIFICATION = 7
 
 # EPICS_PATCH_LEVEL must be a number (win32 resource file requirement)
 # Not included if zero
 EPICS_PATCH_LEVEL = 0
 
 # This will end in -DEV between official releases
-EPICS_DEV_SNAPSHOT=-DEV
+#EPICS_DEV_SNAPSHOT=-DEV
 #EPICS_DEV_SNAPSHOT=-pre1
 #EPICS_DEV_SNAPSHOT=-pre1-DEV
 #EPICS_DEV_SNAPSHOT=-pre2
@@ -43,7 +43,7 @@ EPICS_DEV_SNAPSHOT=-DEV
 #EPICS_DEV_SNAPSHOT=-rc1-DEV
 #EPICS_DEV_SNAPSHOT=-rc2
 #EPICS_DEV_SNAPSHOT=-rc2-DEV
-#EPICS_DEV_SNAPSHOT=
+EPICS_DEV_SNAPSHOT=
 
 # No changes should be needed below here
 

configure/CONFIG_SITE_ENV

@@ -24,40 +24,41 @@
 
 #  Site-specific environment settings
 
-# Time service:
-# EPICS_TIMEZONE
-#	Local timezone info for vxWorks and RTEMS.  The format is
-#	    <name>::<minutesWest>:<startDST>:<endDST>
-#	where <name> is only used by strftime() for %Z conversions,
-#	and <startDST> and <endDST> are mmddhh - that is month,day,hour
-#	e.g. for ANL in 2018: EPICS_TIMEZONE=CUS::360:031102:110402
-#	The future dates below assume the rules don't get changed;
-#	see http://www.timeanddate.com/time/dst/2018.html to check.
-#
-#	DST for 2018  US: Mar 11 - Nov 04
-#	              EU: Mar 25 - Oct 28
-EPICS_TIMEZONE = CUS::360:031102:110402
-#EPICS_TIMEZONE = MET::-60:032502:102803
-#
-#	DST for 2019  US: Mar 10 - Nov 03
-#	              EU: Mar 31 - Oct 27
-#EPICS_TIMEZONE = CUS::360:031002:110302
-#EPICS_TIMEZONE = MET::-60:033102:102703
-#
-#	DST for 2020  US: Mar 08 - Nov 01
-#	              EU: Mar 29 - Oct 25
-#EPICS_TIMEZONE = CUS::360:030802:110102
-#EPICS_TIMEZONE = MET::-60:032902:102503
-#
-#	DST for 2021  US: Mar 14 - Nov 07
-#	              EU: Mar 28 - Oct 31
-#EPICS_TIMEZONE = CUS::360:031402:110702
-#EPICS_TIMEZONE = MET::-60:032802:103103
-#
-#	DST for 2022  US: Mar 13 - Nov 06
-#	              EU: Mar 27 - Oct 30
-#EPICS_TIMEZONE = CUS::360:031302:110602
-#EPICS_TIMEZONE = MET::-60:032702:103003
+## Time service:
+# EPICS_TZ
+#       Local timezone rules for vxWorks and RTEMS. The value follows the Posix
+#       TZ environment variable's Mm.n.d/h format (see the IBM link below for
+#       details). If TZ hasn't already been set when the osdTime timeRegister()
+#       C++ static constructor runs, this parameter will be copied into the TZ
+#       environment variable. Once the OS clock has been synchronized to NTP the
+#       routine tz2timezone() will be run to convert TZ into the TIMEZONE
+#       variable format that VxWorks needs.
+#               https://developer.ibm.com/articles/au-aix-posix/
+
+# Japan Standard Time, no DST:
+#EPICS_TZ = "JST-9"
+
+# Central European (Summer) Time:
+#EPICS_TZ = "CET-1CEST,M3.5.0/2,M10.5.0/3"
+
+# Greenwich Mean/British Summer Time:
+#EPICS_TZ = "GMT0BST,M3.5.0/1,M10.5.0/2"
+
+# US Eastern Standard/Daylight Time:
+#EPICS_TZ = "EST5EDT,M3.2.0/2,M11.1.0/2"
+
+# US Central Standard/Daylight Time:
+EPICS_TZ = "CST6CDT,M3.2.0/2,M11.1.0/2"
+
+# US Mountain Standard/Daylight Time:
+#EPICS_TZ = "MST7MDT,M3.2.0/2,M11.1.0/2"
+
+# US Pacific Standard/Daylight Time:
+#EPICS_TZ = "PST8PDT,M3.2.0/2,M11.1.0/2"
+
+# US Hawaiian Standard Time, no DST:
+#EPICS_TZ = "HST10"
+
 
 # EPICS_TS_NTP_INET
 #	NTP time server ip address for VxWorks and RTEMS.

configure/RULES_BUILD

@@ -351,7 +351,7 @@ testspec: $(TESTSCRIPTS)
 test-results: tapfiles
 ifneq ($(TAPFILES),)
 ifdef RUNTESTS_ENABLED
-	prove --failures --ext .tap --exec "$(CAT)" --color $(TAPFILES)
+	$(PROVE) --failures --ext .tap --exec "$(CAT)" --color $(TAPFILES)
 endif
 
 CURRENT_TAPFILES := $(wildcard $(TAPFILES))

configure/os/CONFIG_SITE.Common.linux-arm

@@ -1,39 +1,35 @@
 # CONFIG_SITE.Common.linux-arm
 #
-# Site Specific definitions for all linux-arm targets
-#-------------------------------------------------------
+# Site-specific settings for the linux-arm target
 
-# NOTE for SHARED_LIBRARIES: In most cases if this is set to YES the
+# NOTE: In most cases if SHARED_LIBRARIES is set to YES the
 # shared libraries will be found automatically.  However if the .so
 # files are installed at a different path to their compile-time path
 # then in order to be found at runtime do one of these:
 # a) LD_LIBRARY_PATH must include the full absolute pathname to
 #    $(INSTALL_LOCATION)/lib/$(EPICS_HOST_ARCH) when invoking base
 #    executables.
-# b) Add the runtime path to SHRLIB_DEPLIB_DIRS and PROD_DEPLIB_DIRS, which 
+# b) Add the runtime path to SHRLIB_DEPLIB_DIRS and PROD_DEPLIB_DIRS, which
 #    will add the named directory to the list contained in the executables.
 # c) Add the runtime path to /etc/ld.so.conf and run ldconfig
 #    to inform the system of the shared library location.
 
-# Depending on your version of Linux you'll want one of the following
-# lines to enable command-line editing and history in iocsh.  If you're
-# not sure which, start with the top one and work downwards until the
-# build doesn't fail to link the readline library.  If none of them work,
-# comment them all out to build without readline support.
 
-# No other libraries needed (recent Fedora, Ubuntu etc.):
-#COMMANDLINE_LIBRARY = READLINE
+# Use GNU Readline if the header file is installed
+COMMANDLINE_LIBRARY = $(strip $(if $(wildcard \
+    $(firstword $(READLINE_DIR) $(GNU_DIR))/include/readline/readline.h), \
+  READLINE, EPICS))
 
-# Needs -lncurses (RHEL 5 etc.):
+# If libreadline needs additional libraries to be linked with it, try
+# uncommenting each of the lines below in turn, starting with the top
+# one and working downwards, until the build succeeds. Do a 'make rebuild'
+# from the top of the Base tree after changing this setting.
+
+# Needs -lncurses:
 #COMMANDLINE_LIBRARY = READLINE_NCURSES
 
-# Needs -lcurses (older versions)
+# Needs -lcurses:
 #COMMANDLINE_LIBRARY = READLINE_CURSES
 
-
-# It makes sense to include debugging symbols even in optimized builds
-# in case you want to attach gdb to the process or examine a core-dump.
-# This does cost disk space, but not memory as debug symbols are not
-# loaded into RAM when the binary is loaded.
-OPT_CFLAGS_YES += -g
-OPT_CXXFLAGS_YES += -g
+# Readline is broken or you don't want use it:
+#COMMANDLINE_LIBRARY = EPICS

configure/os/CONFIG_SITE.Common.linux-cris

@@ -1,9 +1,8 @@
 # CONFIG_SITE.Common.linux-cris
 #
-# Site Specific definitions for linux-cris target
-# Only the local epics system manager should modify this file
+# Site-specific settings for the linux-cris target
 
-# NOTE for SHARED_LIBRARIES: In most cases if this is set to YES the
+# NOTE: In most cases if SHARED_LIBRARIES is set to YES the
 # shared libraries will be found automatically.  However if the .so
 # files are installed at a different path to their compile-time path
 # then in order to be found at runtime do one of these:
@@ -15,21 +14,21 @@
 # c) Add the runtime path to /etc/ld.so.conf and run ldconfig
 #    to inform the system of the shared library location.
 
-# Depending on your version of Linux you may want one of the following
-# lines to enable command-line editing and history in iocsh.  If you're
-# not sure which, start with the top one and work downwards until the
-# build doesn't fail to link the readline library.  If none of them work,
-# comment them all out to build without readline support.
 
-# No other libraries needed (recent Fedora, Ubuntu etc.):
-#COMMANDLINE_LIBRARY = READLINE
+# Use GNU Readline if the header file is installed
+COMMANDLINE_LIBRARY = $(strip $(if $(wildcard \
+    $(GNU_DIR)/include/readline/readline.h), READLINE, EPICS))
 
-# Needs -lncurses (RHEL 5 etc.):
+# If libreadline needs additional libraries to be linked with it, try
+# uncommenting each of the lines below in turn, starting with the top
+# one and working downwards, until the build succeeds. Do a 'make rebuild'
+# from the top of the Base tree after changing this setting.
+
+# Needs -lncurses:
 #COMMANDLINE_LIBRARY = READLINE_NCURSES
 
-# Needs -lcurses (older versions)
+# Needs -lcurses:
 #COMMANDLINE_LIBRARY = READLINE_CURSES
 
-
-OP_SYS_CFLAGS += -g
-
+# Readline is broken or you don't want use it:
+#COMMANDLINE_LIBRARY = EPICS

configure/os/CONFIG_SITE.Common.linux-microblaze

@@ -1,7 +1,6 @@
 # CONFIG_SITE.Common.linux-microblaze
 #
-# Site specific definitions for linux-microblaze target builds.
-#-------------------------------------------------------
+# Site-specific settings for the linux-microblaze target
 
 # The gnu tools for cross compiling for MicroBlaze (little endian)
 # on Linux can be downloaded from the Xilinx git server:
@@ -12,3 +11,21 @@
 
 GNU_DIR = /usr/local/vw/microblaze-2.0/microblazeel-unknown-linux-gnu
 
+
+# Use GNU Readline if the header file is installed
+COMMANDLINE_LIBRARY = $(strip $(if $(wildcard \
+    $(GNU_DIR)/include/readline/readline.h), READLINE, EPICS))
+
+# If libreadline needs additional libraries to be linked with it, try
+# uncommenting each of the lines below in turn, starting with the top
+# one and working downwards, until the build succeeds. Do a 'make rebuild'
+# from the top of the Base tree after changing this setting.
+
+# Needs -lncurses:
+#COMMANDLINE_LIBRARY = READLINE_NCURSES
+
+# Needs -lcurses:
+#COMMANDLINE_LIBRARY = READLINE_CURSES
+
+# Readline is broken or you don't want use it:
+#COMMANDLINE_LIBRARY = EPICS

configure/os/CONFIG_SITE.Common.linux-x86

@@ -1,9 +1,8 @@
 # CONFIG_SITE.Common.linux-x86
 #
-# Site Specific definitions for linux-x86 target
-# Only the local epics system manager should modify this file
+# Site-specific settings for the linux-x86 target
 
-# NOTE for SHARED_LIBRARIES: In most cases if this is set to YES the
+# NOTE: In most cases if SHARED_LIBRARIES is set to YES the
 # shared libraries will be found automatically.  However if the .so
 # files are installed at a different path to their compile-time path
 # then in order to be found at runtime do one of these:
@@ -15,14 +14,15 @@
 # c) Add the runtime path to /etc/ld.so.conf and run ldconfig
 #    to inform the system of the shared library location.
 
-# Depending on your version of Linux you'll want one of the following
-# lines to enable command-line editing and history in iocsh.  If you're
-# not sure which, start with the top one and work downwards until the
-# build doesn't fail to link the readline library.  If none of them work,
-# comment them all out to build without readline support.
 
-# No other libraries needed (recent Fedora, Ubuntu etc.):
-COMMANDLINE_LIBRARY = READLINE
+# Use GNU Readline if the header file is installed
+COMMANDLINE_LIBRARY = $(strip $(if $(wildcard \
+    $(GNU_DIR)/include/readline/readline.h), READLINE, EPICS))
+
+# If libreadline needs additional libraries to be linked with it, try
+# uncommenting each of the lines below in turn, starting with the top
+# one and working downwards, until the build succeeds. Do a 'make rebuild'
+# from the top of the Base tree after changing this setting.
 
 # Needs -lncurses (RHEL 5 etc.):
 #COMMANDLINE_LIBRARY = READLINE_NCURSES
@@ -30,6 +30,9 @@ COMMANDLINE_LIBRARY = READLINE
 # Needs -lcurses (older versions)
 #COMMANDLINE_LIBRARY = READLINE_CURSES
 
+# Readline is broken or you don't want use it:
+#COMMANDLINE_LIBRARY = EPICS
+
 
 # Permit access to 64-bit file-systems
 OP_SYS_CFLAGS += -D_FILE_OFFSET_BITS=64
@@ -43,14 +46,6 @@ OP_SYS_CFLAGS += -D_FILE_OFFSET_BITS=64
 #CCC         = clang++
 
 
-# It makes sense to include debugging symbols even in optimized builds
-# in case you want to attach gdb to the process or examine a core-dump.
-# This does cost disk space, but not memory as debug symbols are not
-# loaded into RAM when the binary is loaded.
-OPT_CFLAGS_YES += -g
-OPT_CXXFLAGS_YES += -g
-
-
 # Tune GNU compiler output for a specific 32-bit cpu-type
 # (e.g. generic, native, i386, i686, pentium2/3/4, prescott, k6, athlon etc.)
 GNU_TUNE_CFLAGS = -mtune=generic

configure/os/CONFIG_SITE.Common.linux-x86_64

@@ -1,9 +1,8 @@
 # CONFIG_SITE.Common.linux-x86_64
 #
-# Site Specific definitions for linux-x86_64 target
-# Only the local epics system manager should modify this file
+# Site-specific settings for the linux-x86_64 target
 
-# NOTE for SHARED_LIBRARIES: In most cases if this is set to YES the
+# NOTE: In most cases if SHARED_LIBRARIES is set to YES the
 # shared libraries will be found automatically.  However if the .so
 # files are installed at a different path to their compile-time path
 # then in order to be found at runtime do one of these:
@@ -15,14 +14,15 @@
 # c) Add the runtime path to /etc/ld.so.conf and run ldconfig
 #    to inform the system of the shared library location.
 
-# Depending on your version of Linux you'll want one of the following
-# lines to enable command-line editing and history in iocsh.  If you're
-# not sure which, start with the top one and work downwards until the
-# build doesn't fail to link the readline library.  If none of them work,
-# comment them all out to build without readline support.
 
-# No other libraries needed (recent Fedora, Ubuntu etc.):
-COMMANDLINE_LIBRARY = READLINE
+# Use GNU Readline if the header file is installed
+COMMANDLINE_LIBRARY = $(strip $(if $(wildcard \
+    $(GNU_DIR)/include/readline/readline.h), READLINE, EPICS))
+
+# If libreadline needs additional libraries to be linked with it, try
+# uncommenting each of the lines below in turn, starting with the top
+# one and working downwards, until the build succeeds. Do a 'make rebuild'
+# from the top of the Base tree after changing this setting.
 
 # Needs -lncurses (RHEL 5 etc.):
 #COMMANDLINE_LIBRARY = READLINE_NCURSES
@@ -30,6 +30,9 @@ COMMANDLINE_LIBRARY = READLINE
 # Needs -lcurses (older versions)
 #COMMANDLINE_LIBRARY = READLINE_CURSES
 
+# Readline is broken or you don't want use it:
+#COMMANDLINE_LIBRARY = EPICS
+
 
 # Uncomment the followings lines to build with CLANG instead of GCC.
 #
@@ -39,14 +42,6 @@ COMMANDLINE_LIBRARY = READLINE
 #CCC         = clang++
 
 
-# It makes sense to include debugging symbols even in optimized builds
-# in case you want to attach gdb to the process or examine a core-dump.
-# This does cost disk space, but not memory as debug symbols are not
-# loaded into RAM when the binary is loaded.
-OPT_CFLAGS_YES += -g
-OPT_CXXFLAGS_YES += -g
-
-
 # Tune GNU compiler output for a specific 64-bit cpu-type
 # (e.g. generic, native, core2, nocona, k8, opteron, athlon64, barcelona etc.)
 GNU_TUNE_CFLAGS = -mtune=generic

configure/os/CONFIG_SITE.Common.linux-xscale_be

@@ -1,4 +1,23 @@
 # CONFIG_SITE.Common.linux-xscale_be
 #
-# Site specific definitions for all linux-xscale_be target builds.
-#-------------------------------------------------------
+# Site-specific settings for the linux-xscale_be target
+
+
+# Use GNU Readline if the header file is installed
+COMMANDLINE_LIBRARY = $(strip $(if $(wildcard \
+    $(firstword $(READLINE_DIR) $(GNU_DIR))/include/readline/readline.h), \
+  READLINE, EPICS))
+
+# If libreadline needs additional libraries to be linked with it, try
+# uncommenting each of the lines below in turn, starting with the top
+# one and working downwards, until the build succeeds. Do a 'make rebuild'
+# from the top of the Base tree after changing this setting.
+
+# Needs -lncurses:
+#COMMANDLINE_LIBRARY = READLINE_NCURSES
+
+# Needs -lcurses:
+#COMMANDLINE_LIBRARY = READLINE_CURSES
+
+# Readline is broken or you don't want use it:
+#COMMANDLINE_LIBRARY = EPICS

configure/os/CONFIG_SITE.Common.linuxCommon

@@ -0,0 +1,11 @@
+# CONFIG_SITE.Common.linuxCommon
+#
+# Site-specific settings for all linux targets
+
+
+# It makes sense to include debugging symbols even in optimized builds
+# in case you want to attach gdb to the process or examine a core-dump.
+# This does cost disk space, but not memory as debug symbols are not
+# loaded into RAM when the binary is loaded.
+OPT_CFLAGS_YES += -g
+OPT_CXXFLAGS_YES += -g

documentation/KnownProblems.html

@@ -4,17 +4,17 @@
 <html xmlns="http://www.w3.org/1999/xhtml">
 <head>
   <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
-  <title>Known Problems in R3.15.6</title>
+  <title>Known Problems in R3.15.7</title>
 </head>
 
 <body>
-<h1 style="text-align: center">EPICS Base R3.15.6: Known Problems</h1>
+<h1 style="text-align: center">EPICS Base R3.15.7: Known Problems</h1>
 
 <p>Any patch files linked below should be applied at the root of the
-base-3.15.6 tree. Download them, then use the GNU Patch program as
+base-3.15.7 tree. Download them, then use the GNU Patch program as
 follows:</p>
 
-<blockquote><pre>% <b>cd <i>/path/to/</i>base-3.15.6</b>
+<blockquote><pre>% <b>cd <i>/path/to/</i>base-3.15.7</b>
 % <b>patch -p1 &lt; <i>/path/to/</i>file.patch</b></pre></blockquote>
 
 <p>The following significant problems have been reported with this

documentation/README.1st

@@ -1,346 +0,0 @@
-                           Installation Instructions
-
-                           EPICS Base Release 3.15.6
-
-   --------------------------------------------------------------------------
-
-  Table of Contents
-
-     * What is EPICS base?
-     * What is new in this release?
-     * Copyright
-     * Supported platforms
-     * Supported compilers
-     * Software requirements
-     * Host system storage requirements
-     * Documentation
-     * Directory Structure
-     * Build related components
-     * Building EPICS base (Unix and Win32)
-     * Example application and extension
-     * Multiple host platforms
-
-   --------------------------------------------------------------------------
-
-  What is EPICS base?
-
-     The Experimental Physics and Industrial Control Systems (EPICS) is an
-     extensible set of software components and tools with which application
-     developers can create a control system. This control system can be used
-     to control accelerators, detectors, telescopes, or other scientific
-     experimental equipment. EPICS base is the set of core software, i.e. the
-     components of EPICS without which EPICS would not function. EPICS base
-     allows an arbitrary number of target systems, IOCs (input/output
-     controllers), and host systems, OPIs (operator interfaces) of various
-     types.
-
-  What is new in this release?
-
-     Please check the RELEASE_NOTES file in the distribution for description
-     of changes and release migration details.
-
-  Copyright
-
-     Please review the LICENSE file included in the distribution for legal
-     terms of usage.
-
-  Supported platforms
-
-     The list of platforms supported by this version of EPICS base is given
-     in the configure/CONFIG_SITE file. If you are trying to build EPICS Base
-     on an unlisted host or for a different target machine you must have the
-     proper host/target cross compiler and header files, and you will have to
-     create and add the appropriate new configure files to the
-     base/configure/os/directory. You can start by copying existing
-     configuration files in the configure/os directory and then make changes
-     for your new platforms.
-
-  Supported compilers
-
-     This version of EPICS base has been built and tested using the host
-     vendor's C and C++ compilers, as well as the GNU gcc and g++ compilers.
-     The GNU cross-compilers work for all cross-compiled targets. You may
-     need the C and C++ compilers to be in your search path to do EPICS
-     builds; check the definitions of CC and CCC in
-     base/configure/os/CONFIG.<host>.<host> if you have problems.
-
-  Software requirements
-
-     GNU make
-     You must use GNU make, gnumake, for any EPICS builds. Set your path so
-     that a gnumake version 3.81 or later is available.
-
-     Perl
-     You must have Perl version 5.8.1 or later installed. The EPICS
-     configuration files do not specify the perl full pathname, so the perl
-     executable must be found through your normal search path.
-
-     Unzip and tar (Winzip on WIN32 systems)
-     You must have tools available to unzip and untar the EPICS base
-     distribution file.
-
-     Target systems
-     EPICS supports IOCs running on embedded platforms such as VxWorks and
-     RTEMS built using a cross-compiler, and also supports soft IOCs running
-     as processes on the host platform.
-
-     vxWorks
-     You must have vxWorks 5.5.x or 6.x installed if any of your target
-     systems are vxWorks systems; the C++ compiler for vxWorks 5.4 is now too
-     old to support. The vxWorks installation provides the cross-compiler and
-     header files needed to build for these targets. The absolute path to and
-     the version number of the vxWorks installation must be set in the
-     base/configure/os/CONFIG_SITE.Common.vxWorksCommon file or in one of its
-     target-specific overrides.
-
-     Consult the vxWorks 5.x or vxWorks 6.x EPICS web pages about and the
-     vxWorks documentation for information about configuring your vxWorks
-     operating system for use with EPICS.
-
-     RTEMS
-     For RTEMS targets, you need RTEMS core and toolset version 4.9.2 or
-     later.
-
-     GNU readline or Tecla library
-     GNU readline and Tecla libraries can be used by the IOC shell to provide
-     command line editing and command line history recall and edit. GNU
-     readline (or Tecla library) must be installed on your target system when
-     COMMANDLINE_LIBRARY is set to READLINE (or TECLA) for that target. EPICS
-     (EPICS shell) is the default specified in CONFIG_COMMON. A READLINE
-     override is defined for linux-x86 in the EPICS distribution. Comment out
-     COMMANDLINE_LIBRARY=READLINE in
-     configure/os/CONFIG_SITE.Common.linux-x86 if readline is not installed
-     on linux-x86. Command-line editing and history will then be those
-     supplied by the os. On vxWorks the ledLib command-line input library is
-     used instead.
-
-  Host system storage requirements
-
-     The compressed tar file is approximately 1.6 MB in size. The
-     distribution source tree takes up approximately 12 MB. Each host target
-     will need around 40 MB for build files, and each cross-compiled target
-     around 20 MB.
-
-  Documentation
-
-     EPICS documentation is available through the EPICS website at Argonne.
-
-     Release specific documentation can also be found in the
-     base/documentation directory of the distribution.
-
-  Directory Structure
-
-    Distribution directory structure:
-
-         base                    Root directory of the base distribution
-         base/configure          Operating system independent build config files
-         base/configure/os       Operating system dependent build config files
-         base/documentation      Distribution documentation
-         base/src                Source code in various subdirectories
-         base/startup            Scripts for setting up path and environment
-
-    Install directories created by the build:
-
-         bin                     Installed scripts and executables in subdirs
-         cfg                     Installed build configuration files
-         db                      Installed data bases
-         dbd                     Installed data base definitions
-         doc                     Installed documentation files
-         html                    Installed html documentation
-         include                 Installed header files
-         include/os              Installed os specific header files in subdirs
-         include/compiler        Installed compiler-specific header files
-         lib                     Installed libraries in arch subdirectories
-         lib/perl                Installed perl modules
-         templates               Installed templates
-
-  Build related components
-
-    base/documentation directory - contains setup, build, and install documents
-
-         README.1st           Instructions for setup and building epics base
-         README.html          html version of README.1st
-         README.darwin.html   Installation notes for Mac OS X (Darwin)
-         RELEASE_NOTES.html   Notes on release changes
-         KnownProblems.html   List of known problems and workarounds
-
-    base/startup directory - contains scripts to set environment and path
-
-         EpicsHostArch       Shell script to set EPICS_HOST_ARCH env variable
-         unix.csh            C shell script to set path and env variables
-         unix.sh             Bourne shell script to set path and env variables
-         win32.bat           Bat file example to configure win32-x86 target
-         windows.bat         Bat file example to configure windows-x64 target
-
-    base/configure directory - contains build definitions and rules
-
-         CONFIG                Includes configure files and allows variable overrides
-         CONFIG.CrossCommon    Cross build definitions
-         CONFIG.gnuCommon      Gnu compiler build definitions for all archs
-         CONFIG_ADDONS         Definitions for <osclass> and DEFAULT options
-         CONFIG_APP_INCLUDE
-         CONFIG_BASE           EPICS base tool and location definitions
-         CONFIG_BASE_VERSION   Definitions for EPICS base version number
-         CONFIG_COMMON         Definitions common to all builds
-         CONFIG_ENV            Definitions of EPICS environment variables
-         CONFIG_FILE_TYPE
-         CONFIG_SITE           Site specific make definitions
-         CONFIG_SITE_ENV       Site defaults for EPICS environment variables
-         MAKEFILE              Installs CONFIG* RULES* creates
-         RELEASE               Location of external products
-         RULES                 Includes appropriate rules file
-         RULES.Db              Rules for database and database definition files
-         RULES.ioc             Rules for application iocBoot/ioc* directory
-         RULES_ARCHS           Definitions and rules for building architectures
-         RULES_BUILD           Build and install rules and definitions
-         RULES_DIRS            Definitions and rules for building subdirectories
-         RULES_EXPAND
-         RULES_FILE_TYPE
-         RULES_TARGET
-         RULES_TOP             Rules specific to a <top> dir (uninstall and tar)
-         Sample.Makefile       Sample makefile with comments
-
-    base/configure/os directory - contains os-arch specific definitions
-
-         CONFIG.<host>.<target>      Specific host-target build definitions
-         CONFIG.Common.<target>      Specific target definitions for all hosts
-         CONFIG.<host>.Common        Specific host definitions for all targets
-         CONFIG.UnixCommon.Common    Definitions for Unix hosts and all targets
-         CONFIG.Common.UnixCommon    Definitions for Unix targets and all hosts
-         CONFIG.Common.vxWorksCommon Specific host definitions for all vx targets
-         CONFIG_SITE.<host>.<target> Site specific host-target definitions
-         CONFIG_SITE.Common.<target> Site specific target defs for all hosts
-         CONFIG_SITE.<host>.Common   Site specific host defs for all targets
-
-  Building EPICS base (Unix and Win32)
-
-    Unpack file
-
-       Unzip and untar the distribution file. Use WinZip on Windows systems.
-
-    Set environment variables
-
-       Files in the base/startup directory have been provided to help set
-       required path and other environment variables.
-
-       EPICS_HOST_ARCH
-       Before you can build or use EPICS R3.15, the environment variable
-       EPICS_HOST_ARCH must be defined. A perl script EpicsHostArch.pl in the
-       base/startup directory has been provided to help set EPICS_HOST_ARCH.
-       You should have EPICS_HOST_ARCH set to your host operating system
-       followed by a dash and then your host architecture, e.g.
-       solaris-sparc. If you are not using the OS vendor's c/c++ compiler for
-       host builds, you will need another dash followed by the alternate
-       compiler name (e.g. "-gnu" for GNU c/c++ compilers on a solaris host
-       or "-mingw" for MinGW c/c++ compilers on a WIN32 host). See
-       configure/CONFIG_SITE for a list of supported EPICS_HOST_ARCH values.
-
-       PERLLIB
-       On WIN32, some versions of Perl require that the environment variable
-       PERLLIB be set to <perl directory location>.
-
-       PATH
-       As already mentioned, you must have the perl executable and you may
-       need C and C++ compilers in your search path. For building base you
-       also must have echo in your search path. For Unix host builds you also
-       need ln, cpp, cp, rm, mv, and mkdir in your search path and /bin/chmod
-       must exist. On some Unix systems you may also need ar and ranlib in
-       your path, and the C compiler may require as and ld in your path. On
-       solaris systems you need uname in your path.
-
-       LD_LIBRARY_PATH
-       R3.15 shared libraries and executables normally contain the full path
-       to any libraries they require. However, if you move the EPICS files or
-       directories from their build-time location then in order for the
-       shared libraries to be found at runtime LD_LIBRARY_PATH must include
-       the full pathname to $(INSTALL_LOCATION)/lib/$(EPICS_HOST_ARCH) when
-       invoking executables, or some equivalent OS-specific mechanism (such
-       as /etc/ld.so.conf on Linux) must be used. Shared libraries are now
-       built by default on all Unix type hosts.
-
-    Do site-specific build configuration
-
-       Site configuration
-       To configure EPICS, you may want to modify the default definitions in
-       the following files:
-
-         configure/CONFIG_SITE      Build choices. Specify target archs.
-         configure/CONFIG_SITE_ENV  Environment variable defaults
-         configure/RELEASE          TORNADO2 full path location
-
-       Host configuration
-       To configure each host system, you may override the default
-       definitions by adding a new file in the configure/os directory with
-       override definitions. The new file should have the same name as the
-       distribution file to be overridden except with CONFIG in the name
-       changed to CONFIG_SITE.
-
-         configure/os/CONFIG.<host>.<host>      Host build settings
-         configure/os/CONFIG.<host>.Common      Host common build settings
-
-       Target configuration
-       To configure each target system, you may override the default
-       definitions by adding a new file in the configure/os directory with
-       override definitions. The new file should have the same name as the
-       distribution file to be overridden except with CONFIG in the name
-       replaced by CONFIG_SITE. This step is necessary even if the host
-       system is the only target system.
-
-         configure/os/CONFIG.Common.<target>     Target common settings
-         configure/os/CONFIG.<host>.<target>     Host-target settings
-
-    Build EPICS base
-
-       After configuring the build you should be able to build EPICS base by
-       issuing the following commands in the distribution's root directory
-       (base):
-
-         gnumake clean uninstall
-         gnumake
-
-       The command "gnumake clean uninstall" will remove all files and
-       directories generated by a previous build. The command "gnumake" will
-       build and install everything for the configured host and targets.
-
-       It is recommended that you do a "gnumake clean uninstall" at the root
-       directory of an EPICS directory structure before each complete rebuild
-       to ensure that all components will be rebuilt.
-
-  Example application and extension
-
-     A perl tool, makeBaseApp.pl is included in the distribution file. This
-     script will create a sample application that can be built and then
-     executed to try out this release of base.
-
-     Instructions for building and executing the 3.15 example application can
-     be found in the section "Example Application" of Chapter 2, "Getting
-     Started", in the "IOC Application Developer's Guide" for this release.
-     The "Example IOC Application" section briefly explains how to create and
-     build an example application in a user created <top> directory. It also
-     explains how to run the example application on a vxWorks ioc or as a
-     process on the host system. By running the example application as a
-     host-based IOC, you will be able to quickly implement a complete EPICS
-     system and be able to run channel access clients on the host system.
-
-     A perl script, makeBaseExt.pl, is included in the distribution file.
-     This script will create a sample extension that can be built and
-     executed. The makeBaseApp.pl and makeBaseExt.pl scripts are installed
-     into the install location bin/<hostarch> directory during the base
-     build.
-
-  Multiple host platforms
-
-     You can build using a single EPICS directory structure on multiple host
-     systems and for multiple cross target systems. The intermediate and
-     binary files generated by the build will be created in separate
-     subdirectories and installed into the appropriate separate host/target
-     install directories. EPICS executables and perl scripts are installed
-     into the $(INSTALL_LOCATION)/bin/<arch> directories. Libraries are
-     installed into $(INSTALL_LOCATION)/lib/<arch>. The default definition
-     for $(INSTALL_LOCATION) is $(TOP) which is the root directory in the
-     distribution directory structure, base. Created object files are stored
-     in O.<arch> source subdirectories, This allows objects for multiple
-     cross target architectures to be maintained at the same time. To build
-     EPICS base for a specific host/target combination you must have the
-     proper host/target C/C++ cross compiler and target header files and the
-     base/configure/os directory must have the appropriate configure files.

documentation/README.html

@@ -1,383 +0,0 @@
-<!DOCTYPE HTML>
-<!-- Generate the README.1st file from this file using:
-    elinks -dump -no-numbering -no-references -dump-width 80 README.html
-  -->
-<HTML>
-<HEAD>
-<TITLE>README - EPICS Base Installation Instructions</TITLE>
-</HEAD>
-<BODY>
-<CENTER>
-<H1>Installation Instructions</H1>
-<H2>EPICS Base Release 3.15.6</H2><BR>
-</CENTER>
-<HR>
-<H3> Table of Contents</H3>
-<UL>
-<LI><A HREF="#0_0_1"> What is EPICS base?</A></LI>
-<LI><A HREF="#0_0_2"> What is new in this release?</A></LI>
-<LI><A HREF="#0_0_3"> Copyright</A></LI>
-<LI><A HREF="#0_0_4"> Supported platforms</A></LI>
-<LI><A HREF="#0_0_5"> Supported compilers</A></LI>
-<LI><A HREF="#0_0_6"> Software requirements</A></LI>
-<LI><A HREF="#0_0_7"> Host system storage requirements</A></LI>
-<LI><A HREF="#0_0_8"> Documentation</A></LI>
-<LI><A HREF="#0_0_10"> Directory Structure</A></LI>
-<LI><A HREF="#0_0_11"> Build related components</A></LI>
-<LI><A HREF="#0_0_12"> Building EPICS base (Unix and Win32)</A></LI>
-<LI><A HREF="#0_0_13"> Example application and extension</A></LI>
-<LI><A HREF="#0_0_14"> Multiple host platforms</A></LI>
-</UL>
-<HR>
-
-<H3><A NAME="0_0_1"> What is EPICS base?</A></H3>
-<BLOCKQUOTE>The Experimental Physics and Industrial Control Systems
- (EPICS) is an extensible set of software components and tools with
- which application developers can create a control system. This control
- system can be used to control accelerators, detectors, telescopes, or
- other scientific experimental equipment. EPICS base is the set of core
- software, i.e. the components of EPICS without which EPICS would not
- function. EPICS base allows an arbitrary number of target systems, IOCs
- (input/output controllers), and host systems, OPIs (operator
- interfaces) of various types.</BLOCKQUOTE>
-
-<H3><A NAME="0_0_2"> What is new in this release?</A></H3>
-<BLOCKQUOTE> Please check the RELEASE_NOTES file in the distribution for
- description of changes and release migration details.</BLOCKQUOTE>
-
-<H3><A NAME="0_0_3"> Copyright</A></H3>
-<BLOCKQUOTE>Please review the LICENSE file included in the
- distribution for legal terms of usage.</BLOCKQUOTE>
-
-<H3><A NAME="0_0_4"> Supported platforms</A></H3>
-
-<BLOCKQUOTE>The list of platforms supported by this version of EPICS base
- is given in the configure/CONFIG_SITE file. If you are trying to build
- EPICS Base on an unlisted host or for a different target machine you
- must have the proper host/target cross compiler and header files, and
- you will have to create and add the appropriate new configure files to
- the base/configure/os/directory. You can start by copying existing
- configuration files in the configure/os directory and then make changes
- for your new platforms.</BLOCKQUOTE>
-
-<H3><A NAME="0_0_5"> Supported compilers</A></H3>
-
-<BLOCKQUOTE>This version of EPICS base has been built and tested using the host
- vendor's C and C++ compilers, as well as the GNU gcc and g++ compilers. The GNU
- cross-compilers work for all cross-compiled targets. You may need the C and C++
- compilers to be in your search path to do EPICS builds; check the definitions
- of CC and CCC in base/configure/os/CONFIG.&lt;host&gt;.&lt;host&gt; if you have
- problems.</BLOCKQUOTE>
-
-<H3><A NAME="0_0_6"> Software requirements</A></H3>
-
-<BLOCKQUOTE><B>GNU make</B><BR>
- You must use GNU make, gnumake, for any EPICS builds. Set your path
- so that a gnumake version 3.81 or later is available.
-
-<P><B>Perl</B><BR>
- You must have Perl version 5.8.1 or later installed. The EPICS configuration
- files do not specify the perl full pathname, so the perl executable must
- be found through your normal search path.</P>
-
-<P><B>Unzip and tar (Winzip on WIN32 systems)</B><BR>
- You must have tools available to unzip and untar the EPICS base
- distribution file.</P>
-
-<P><B>Target systems</B><BR>
- EPICS supports IOCs running on embedded platforms such as VxWorks
- and RTEMS built using a cross-compiler, and also supports soft IOCs running
- as processes on the host platform.</P>
-
-<P><B>vxWorks</B><BR>
- You must have vxWorks 5.5.x or 6.x installed if any of your target systems are
- vxWorks systems; the C++ compiler for vxWorks 5.4 is now too old to support.
- The vxWorks installation provides the cross-compiler and header files needed to
- build for these targets. The absolute path to and the version number of the
- vxWorks installation must be set in the
- base/configure/os/CONFIG_SITE.Common.vxWorksCommon file or in one of its
- target-specific overrides.</P>
-
-<P>Consult the <a href="https://epics.anl.gov/base/tornado.php">vxWorks
- 5.x</a> or <a href="https://epics.anl.gov/base/vxWorks6.php">vxWorks
- 6.x</a> EPICS web pages about and the vxWorks documentation for information
- about configuring your vxWorks operating system for use with EPICS.</P>
-
-<P><B>RTEMS</B><BR>
- For RTEMS targets, you need RTEMS core and toolset version 4.9.2 or later.</P>
-
-<P><B>GNU readline or Tecla library</B><BR>
- GNU readline and Tecla libraries can be used by the IOC shell to
- provide command line editing and command line history recall and edit.
- GNU readline (or Tecla library) must be installed on your target system
- when COMMANDLINE_LIBRARY is set to READLINE (or TECLA) for that target.
- EPICS (EPICS shell) is the default specified in CONFIG_COMMON. A
- READLINE override is defined for linux-x86 in the EPICS distribution.
- Comment out COMMANDLINE_LIBRARY=READLINE in
- configure/os/CONFIG_SITE.Common.linux-x86 if readline is not installed
- on linux-x86. Command-line editing and history will then be those
- supplied by the os. On vxWorks the ledLib command-line input library is
- used instead.</P>
-</BLOCKQUOTE>
-
-<H3><A NAME="0_0_7"> Host system storage requirements</A></H3>
-
-<BLOCKQUOTE>The compressed tar file is approximately 1.6 MB in size. The
- distribution source tree takes up approximately 12 MB. Each host target will
- need around 40 MB for build files, and each cross-compiled target around 20
- MB.</BLOCKQUOTE>
-
-<H3><A NAME="0_0_8"> Documentation</A></H3>
-<BLOCKQUOTE>EPICS documentation is available through the
- <a href="https://epics.anl.gov/">EPICS website</a> at Argonne.
- <P>Release specific documentation can also be found in the base/documentation
- directory of the distribution.</BLOCKQUOTE>
-
-<H3><A NAME="0_0_10"> Directory Structure</A></H3>
-<BLOCKQUOTE><H4>Distribution directory structure:</H4>
-
-<PRE>
-        base                    Root directory of the base distribution
-        base/configure          Operating system independent build config files
-        base/configure/os       Operating system dependent build config files
-        base/documentation      Distribution documentation
-        base/src                Source code in various subdirectories
-        base/startup            Scripts for setting up path and environment
-</PRE>
-
-<H4>Install directories created by the build:</H4>
-<PRE>
-        bin                     Installed scripts and executables in subdirs
-        cfg                     Installed build configuration files
-        db                      Installed data bases
-        dbd                     Installed data base definitions
-        doc                     Installed documentation files
-        html                    Installed html documentation
-        include                 Installed header files
-        include/os              Installed os specific header files in subdirs
-        include/compiler        Installed compiler-specific header files
-        lib                     Installed libraries in arch subdirectories
-        lib/perl                Installed perl modules
-        templates               Installed templates
-</PRE>
-</BLOCKQUOTE>
-
-<H3><A NAME="0_0_11"> Build related components</A></H3>
-<BLOCKQUOTE>
-
-<H4>base/documentation directory - contains setup, build, and install
- documents</H4>
- <PRE>
-        README.1st           Instructions for setup and building epics base
-        README.html          html version of README.1st
-        README.darwin.html   Installation notes for Mac OS X (Darwin)
-        RELEASE_NOTES.html   Notes on release changes
-        KnownProblems.html   List of known problems and workarounds
-</PRE>
-
-<H4>base/startup directory - contains scripts to set environment and path</H4>
-<PRE>
-        EpicsHostArch       Shell script to set EPICS_HOST_ARCH env variable
-        unix.csh            C shell script to set path and env variables
-        unix.sh             Bourne shell script to set path and env variables
-        win32.bat           Bat file example to configure win32-x86 target
-        windows.bat         Bat file example to configure windows-x64 target
-</PRE>
-
-<H4>base/configure directory - contains build definitions and rules</H4>
-<PRE>
-        CONFIG                Includes configure files and allows variable overrides
-        CONFIG.CrossCommon    Cross build definitions
-        CONFIG.gnuCommon      Gnu compiler build definitions for all archs
-        CONFIG_ADDONS         Definitions for &lt;osclass&gt; and DEFAULT options
-        CONFIG_APP_INCLUDE    
-        CONFIG_BASE           EPICS base tool and location definitions
-        CONFIG_BASE_VERSION   Definitions for EPICS base version number
-        CONFIG_COMMON         Definitions common to all builds
-        CONFIG_ENV            Definitions of EPICS environment variables
-        CONFIG_FILE_TYPE      
-        CONFIG_SITE           Site specific make definitions
-        CONFIG_SITE_ENV       Site defaults for EPICS environment variables
-        MAKEFILE              Installs CONFIG* RULES* creates
-        RELEASE               Location of external products
-        RULES                 Includes appropriate rules file
-        RULES.Db              Rules for database and database definition files
-        RULES.ioc             Rules for application iocBoot/ioc* directory
-        RULES_ARCHS           Definitions and rules for building architectures
-        RULES_BUILD           Build and install rules and definitions
-        RULES_DIRS            Definitions and rules for building subdirectories
-        RULES_EXPAND          
-        RULES_FILE_TYPE       
-        RULES_TARGET          
-        RULES_TOP             Rules specific to a &lt;top&gt; dir (uninstall and tar)
-        Sample.Makefile       Sample makefile with comments
-</PRE>
-
-<H4>base/configure/os directory - contains os-arch specific definitions</H4>
-<PRE>
-        CONFIG.&lt;host&gt;.&lt;target&gt;      Specific host-target build definitions
-        CONFIG.Common.&lt;target&gt;      Specific target definitions for all hosts
-        CONFIG.&lt;host&gt;.Common        Specific host definitions for all targets
-        CONFIG.UnixCommon.Common    Definitions for Unix hosts and all targets
-        CONFIG.Common.UnixCommon    Definitions for Unix targets and all hosts
-        CONFIG.Common.vxWorksCommon Specific host definitions for all vx targets
-        CONFIG_SITE.&lt;host&gt;.&lt;target&gt; Site specific host-target definitions
-        CONFIG_SITE.Common.&lt;target&gt; Site specific target defs for all hosts
-        CONFIG_SITE.&lt;host&gt;.Common   Site specific host defs for all targets
-</PRE>
-
-</BLOCKQUOTE>
-
-<H3><A NAME="0_0_12"> Building EPICS base (Unix and Win32)</A></H3>
-<BLOCKQUOTE>
-
-<H4> Unpack file</H4>
-<BLOCKQUOTE>
-Unzip and untar the distribution file. Use WinZip on Windows
- systems.
-</BLOCKQUOTE>
-
-<H4>Set environment variables</H4>
-<BLOCKQUOTE>
-Files in the base/startup directory have been provided to
- help set required path and other environment variables.
-
-<P><B>EPICS_HOST_ARCH</B><BR>
- Before you can build or use EPICS R3.15, the environment variable
- EPICS_HOST_ARCH must be defined. A perl script EpicsHostArch.pl in the
- base/startup directory has been provided to help set EPICS_HOST_ARCH.
- You should have EPICS_HOST_ARCH set to your host operating system
- followed by a dash and then your host architecture, e.g. solaris-sparc.
- If you are not using the OS vendor's c/c++ compiler for host builds,
- you will need another dash followed by the alternate compiler name
- (e.g. &quot;-gnu&quot; for GNU c/c++ compilers on a solaris host or &quot;-mingw&quot;
- for MinGW c/c++ compilers on a WIN32 host). See configure/CONFIG_SITE
- for a list of supported EPICS_HOST_ARCH values.</P>
-
-<P><B>PERLLIB</B><BR>
- On WIN32, some versions of Perl require that the environment
- variable PERLLIB be set to &lt;perl directory location&gt;.</P>
-
-<P><B>PATH</B><BR>
- As already mentioned, you must have the perl executable and you may
- need C and C++ compilers in your search path. For building base you
- also must have echo in your search path. For Unix host builds you also
- need ln, cpp, cp, rm, mv, and mkdir in your search path and /bin/chmod
- must exist. On some Unix systems you may also need ar and ranlib in
- your path, and the C compiler may require as and ld in your path. On
- solaris systems you need uname in your path.</P>
-
-<P><B>LD_LIBRARY_PATH</B><BR>
-
- R3.15 shared libraries and executables normally contain the full path
- to any libraries they require.
- However, if you move the EPICS files or directories from their build-time
- location then in order for the shared libraries to be found at runtime
- LD_LIBRARY_PATH must include the full pathname to
- $(INSTALL_LOCATION)/lib/$(EPICS_HOST_ARCH) when invoking executables, or
- some equivalent OS-specific mechanism (such as /etc/ld.so.conf on Linux)
- must be used.
- Shared libraries are now built by default on all Unix type hosts.</P>
-</BLOCKQUOTE>
-
-<H4>Do site-specific build configuration</H4>
-<BLOCKQUOTE>
-
-<B>Site configuration</B><BR>
- To configure EPICS, you may want to modify the default definitions
- in the following files:
-<PRE>
-        configure/CONFIG_SITE      Build choices. Specify target archs.
-        configure/CONFIG_SITE_ENV  Environment variable defaults
-        configure/RELEASE          TORNADO2 full path location
-</PRE>
-
-<B> Host configuration</B><BR>
- To configure each host system, you may override the default
- definitions by adding a new file in the configure/os directory with
- override definitions. The new file should have the same name as the
- distribution file to be overridden except with CONFIG in the name
- changed to CONFIG_SITE.
-
-<PRE>
-        configure/os/CONFIG.&lt;host&gt;.&lt;host&gt;      Host build settings
-        configure/os/CONFIG.&lt;host&gt;.Common      Host common build settings
-</PRE>
-
-<B>Target configuration</B><BR>
- To configure each target system, you may override the default
- definitions by adding a new file in the configure/os directory with
- override definitions. The new file should have the same name as the
- distribution file to be overridden except with CONFIG in the name
- replaced by CONFIG_SITE. This step is necessary even if the host system
- is the only target system.
- <PRE>
-        configure/os/CONFIG.Common.&lt;target&gt;     Target common settings
-        configure/os/CONFIG.&lt;host&gt;.&lt;target&gt;     Host-target settings
-</PRE>
-</BLOCKQUOTE>
-
-<H4>Build EPICS base</H4>
-<BLOCKQUOTE>After configuring the build you should be able to build
- EPICS base by issuing the following commands in the distribution's root
- directory (base):
- <PRE>
-        gnumake clean uninstall
-        gnumake
-</PRE>
-
- The command &quot;gnumake clean uninstall&quot;
- will remove all files and directories generated by a previous build.
- The command &quot;gnumake&quot; will build and install everything for the
- configured host and targets.
-
-<P> It is recommended that you do a &quot;gnumake clean uninstall&quot; at the
- root directory of an EPICS directory structure before each complete
- rebuild to ensure that all components will be rebuilt.
-</BLOCKQUOTE>
-</BLOCKQUOTE>
-
-<H3><A NAME="0_0_13"> Example application and extension</A></H3>
-<BLOCKQUOTE>A perl tool, makeBaseApp.pl is included in the distribution
- file. This script will create a sample application that can be built
- and then executed to try out this release of base. 
-
-<P>
- Instructions for building and executing the 3.15 example application
- can be found in the section &quot;Example Application&quot; of Chapter 2,
- &quot;Getting Started&quot;, in the &quot;IOC Application Developer's Guide&quot; for this
- release. The &quot;Example IOC Application&quot; section briefly explains how to
- create and build an example application in a user created &lt;top&gt;
- directory. It also explains how to run the example application on a
- vxWorks ioc or as a process on the host system.
- By running the example application as a host-based IOC, you will be 
- able to quickly implement a complete EPICS system and be able to run channel 
- access clients on the host system.
-
-<P>
- A perl script,
- makeBaseExt.pl, is included in the distribution file. This script will
- create a sample extension that can be built and executed. The
- makeBaseApp.pl and makeBaseExt.pl scripts are installed into the
- install location bin/&lt;hostarch&gt; directory during the base build.
-</BLOCKQUOTE>
-
-<H3><A NAME="0_0_14"> Multiple host platforms</A></H3>
-<BLOCKQUOTE>You can build using a single EPICS directory structure on
- multiple host systems and for multiple cross target systems. The
- intermediate and binary files generated by the build will be created in
- separate subdirectories and installed into the appropriate separate
- host/target install directories. EPICS executables and perl scripts are
- installed into the <TT>$(INSTALL_LOCATION)/bin/&lt;arch&gt;</TT> directories.
- Libraries are installed into $<TT>(INSTALL_LOCATION)/lib/&lt;arch&gt;</TT>.
- The default definition for <TT>$(INSTALL_LOCATION)</TT> is <TT>$(TOP)</TT>
- which is the root directory in the distribution directory structure,
- base. Created object files are stored in O.&lt;arch&gt; source
- subdirectories, This allows objects for multiple cross target
- architectures to be maintained at the same time. To build EPICS base
- for a specific host/target combination you must have the proper
- host/target C/C++ cross compiler and target header files and the
- base/configure/os directory must have the appropriate configure files.
-</BLOCKQUOTE>
-</BODY>
-</HTML>

documentation/README.md

@@ -0,0 +1,373 @@
+# Installation Instructions
+
+## EPICS Base Release 3.15.7
+
+-----
+
+### Table of Contents
+
+  - [What is EPICS base?](#0_0_1)
+  - [What is new in this release?](#0_0_2)
+  - [Copyright](#0_0_3)
+  - [Supported platforms](#0_0_4)
+  - [Supported compilers](#0_0_5)
+  - [Software requirements](#0_0_6)
+  - [Host system storage requirements](#0_0_7)
+  - [Documentation](#0_0_8)
+  - [Directory Structure](#0_0_10)
+  - [Build related components](#0_0_11)
+  - [Building EPICS base (Unix and Win32)](#0_0_12)
+  - [Example application and extension](#0_0_13)
+  - [Multiple host platforms](#0_0_14)
+
+-----
+
+### <span id="0_0_1">What is EPICS base?</span>
+
+The Experimental Physics and Industrial Control Systems (EPICS) is an
+extensible set of software components and tools with which application
+developers can create a control system. This control system can be
+used to control accelerators, detectors, telescopes, or other
+scientific experimental equipment. EPICS base is the set of core
+software, i.e. the components of EPICS without which EPICS would not
+function. EPICS base allows an arbitrary number of target systems,
+IOCs (input/output controllers), and host systems, OPIs (operator
+interfaces) of various types.
+
+### <span id="0_0_2">What is new in this release?</span>
+
+Please check the `RELEASE_NOTES` file in the distribution for
+description of changes and release migration details.
+
+### <span id="0_0_3">Copyright</span>
+
+Please review the LICENSE file included in the distribution for legal
+terms of usage.
+
+### <span id="0_0_4">Supported platforms</span>
+
+The list of platforms supported by this version of EPICS base is given
+in the `configure/CONFIG_SITE` file. If you are trying to build EPICS
+Base on an unlisted host or for a different target machine you must
+have the proper host/target cross compiler and header files, and you
+will have to create and add the appropriate new configure files to the
+base/configure/os/directory. You can start by copying existing
+configuration files in the configure/os directory and then make
+changes for your new platforms.
+
+### <span id="0_0_5">Supported compilers</span>
+
+This version of EPICS base has been built and tested using the host
+vendor's C and C++ compilers, as well as the GNU gcc and g++
+compilers. The GNU cross-compilers work for all cross-compiled
+targets. You may need the C and C++ compilers to be in your search
+path to do EPICS builds; check the definitions of CC and CCC in
+base/configure/os/CONFIG.&lt;host>.&lt;host> if you have problems.
+
+### <span id="0_0_6">Software requirements</span>
+
+**GNU make**
+You must use GNU make, gnumake, for any EPICS builds. Set your path so
+that a gnumake version 3.81 or later is available.
+
+**Perl**
+You must have Perl version 5.8.1 or later installed. The EPICS
+configuration files do not specify the perl full pathname, so the perl
+executable must be found through your normal search path.
+
+**Unzip and tar (Winzip on WIN32 systems)**
+You must have tools available to unzip and untar the EPICS base
+distribution file.
+
+**Target systems**
+EPICS supports IOCs running on embedded platforms such as VxWorks and
+RTEMS built using a cross-compiler, and also supports soft IOCs
+running as processes on the host platform.
+
+**vxWorks**
+You must have vxWorks 5.5.x or 6.x installed if any of your target
+systems are vxWorks systems; the C++ compiler for vxWorks 5.4 is now
+too old to support. The vxWorks installation provides the
+cross-compiler and header files needed to build for these targets. The
+absolute path to and the version number of the vxWorks installation
+must be set in the `base/configure/os/CONFIG_SITE.Common.vxWorksCommon`
+file or in one of its target-specific overrides.
+
+Consult the [vxWorks 5.x](https://epics.anl.gov/base/tornado.php) or
+[vxWorks 6.x](https://epics.anl.gov/base/vxWorks6.php) EPICS web pages
+about and the vxWorks documentation for information about configuring
+your vxWorks operating system for use with EPICS.
+
+**RTEMS**
+For RTEMS targets, you need RTEMS core and toolset version 4.9.2 or
+later.
+
+**GNU readline or Tecla library**
+GNU readline and Tecla libraries can be used by the IOC shell to
+provide command line editing and command line history recall and edit.
+GNU readline (or Tecla library) must be installed on your target
+system when `COMMANDLINE_LIBRARY` is set to READLINE (or TECLA) for
+that target. EPICS (EPICS shell) is the default specified in
+`CONFIG_COMMON`. A READLINE override is defined for linux-x86 in the
+EPICS distribution. Comment out `COMMANDLINE_LIBRARY=READLINE` in
+`configure/os/CONFIG_SITE.Common.linux-x86` if readline is not
+installed on linux-x86. Command-line editing and history will then be
+those supplied by the os. On vxWorks the ledLib command-line input
+library is used instead.
+
+### <span id="0_0_7">Host system storage requirements</span>
+
+The compressed tar file is approximately 1.6 MB in size. The
+distribution source tree takes up approximately 12 MB. Each host
+target will need around 40 MB for build files, and each cross-compiled
+target around 20 MB.
+
+### <span id="0_0_8">Documentation</span>
+
+EPICS documentation is available through the [EPICS
+website](https://epics.anl.gov/) at Argonne.
+
+Release specific documentation can also be found in the
+base/documentation directory of the distribution.
+
+### <span id="0_0_10">Directory Structure</span>
+
+#### Distribution directory structure:
+
+```
+        base                    Root directory of the base distribution
+        base/configure          Operating system independent build config files
+        base/configure/os       Operating system dependent build config files
+        base/documentation      Distribution documentation
+        base/src                Source code in various subdirectories
+        base/startup            Scripts for setting up path and environment
+```
+
+#### Install directories created by the build:
+
+```
+        bin                     Installed scripts and executables in subdirs
+        cfg                     Installed build configuration files
+        db                      Installed data bases
+        dbd                     Installed data base definitions
+        doc                     Installed documentation files
+        html                    Installed html documentation
+        include                 Installed header files
+        include/os              Installed os specific header files in subdirs
+        include/compiler        Installed compiler-specific header files
+        lib                     Installed libraries in arch subdirectories
+        lib/perl                Installed perl modules
+        templates               Installed templates
+```
+
+### <span id="0_0_11">Build related components</span>
+
+#### base/documentation directory - contains setup, build, and install documents
+
+```
+        README.md            Instructions for setup and building epics base
+        README.darwin.html   Installation notes for Mac OS X (Darwin)
+        RELEASE_NOTES.html   Notes on release changes
+        KnownProblems.html   List of known problems and workarounds
+```
+
+#### base/startup directory - contains scripts to set environment and path
+
+```
+        EpicsHostArch       Shell script to set EPICS_HOST_ARCH env variable
+        unix.csh            C shell script to set path and env variables
+        unix.sh             Bourne shell script to set path and env variables
+        win32.bat           Bat file example to configure win32-x86 target
+        windows.bat         Bat file example to configure windows-x64 target
+```
+
+#### base/configure directory - contains build definitions and rules
+
+```
+        CONFIG                Includes configure files and allows variable overrides
+        CONFIG.CrossCommon    Cross build definitions
+        CONFIG.gnuCommon      Gnu compiler build definitions for all archs
+        CONFIG_ADDONS         Definitions for &lt;osclass> and DEFAULT options
+        CONFIG_APP_INCLUDE
+        CONFIG_BASE           EPICS base tool and location definitions
+        CONFIG_BASE_VERSION   Definitions for EPICS base version number
+        CONFIG_COMMON         Definitions common to all builds
+        CONFIG_ENV            Definitions of EPICS environment variables
+        CONFIG_FILE_TYPE
+        CONFIG_SITE           Site specific make definitions
+        CONFIG_SITE_ENV       Site defaults for EPICS environment variables
+        MAKEFILE              Installs CONFIG* RULES* creates
+        RELEASE               Location of external products
+        RULES                 Includes appropriate rules file
+        RULES.Db              Rules for database and database definition files
+        RULES.ioc             Rules for application iocBoot/ioc* directory
+        RULES_ARCHS           Definitions and rules for building architectures
+        RULES_BUILD           Build and install rules and definitions
+        RULES_DIRS            Definitions and rules for building subdirectories
+        RULES_EXPAND
+        RULES_FILE_TYPE
+        RULES_TARGET
+        RULES_TOP             Rules specific to a &lt;top> dir (uninstall and tar)
+        Sample.Makefile       Sample makefile with comments
+```
+
+#### base/configure/os directory - contains os-arch specific definitions
+
+```
+        CONFIG.&lt;host>.&lt;target>      Specific host-target build definitions
+        CONFIG.Common.&lt;target>      Specific target definitions for all hosts
+        CONFIG.&lt;host>.Common        Specific host definitions for all targets
+        CONFIG.UnixCommon.Common    Definitions for Unix hosts and all targets
+        CONFIG.Common.UnixCommon    Definitions for Unix targets and all hosts
+        CONFIG.Common.vxWorksCommon Specific host definitions for all vx targets
+        CONFIG_SITE.&lt;host>.&lt;target> Site specific host-target definitions
+        CONFIG_SITE.Common.&lt;target> Site specific target defs for all hosts
+        CONFIG_SITE.&lt;host>.Common   Site specific host defs for all targets
+```
+
+### <span id="0_0_12">Building EPICS base (Unix and Win32)</span>
+
+#### Unpack file
+
+Unzip and untar the distribution file. Use WinZip on Windows
+systems.
+
+#### Set environment variables
+
+Files in the base/startup directory have been provided to help set
+required path and other environment variables.
+
+* `EPICS_HOST_ARCH`
+Before you can build or use EPICS R3.15, the environment variable
+`EPICS_HOST_ARCH` must be defined. A perl script EpicsHostArch.pl in
+the base/startup directory has been provided to help set
+`EPICS_HOST_ARCH.` You should have `EPICS_HOST_ARCH` set to your
+host operating system followed by a dash and then your host
+architecture, e.g. solaris-sparc. If you are not using the OS
+vendor's c/c++ compiler for host builds, you will need another dash
+followed by the alternate compiler name (e.g. "-gnu" for GNU c/c++
+compilers on a solaris host or "-mingw" for MinGW c/c++ compilers on
+a WIN32 host). See `configure/CONFIG_SITE` for a list of supported
+`EPICS_HOST_ARCH` values.
+
+* `PERLLIB`
+On WIN32, some versions of Perl require that the environment
+variable PERLLIB be set to &lt;perl directory location>.
+
+* `PATH`
+As already mentioned, you must have the perl executable and you may
+need C and C++ compilers in your search path. For building base you
+also must have echo in your search path. For Unix host builds you
+also need ln, cpp, cp, rm, mv, and mkdir in your search path and
+/bin/chmod must exist. On some Unix systems you may also need ar and
+ranlib in your path, and the C compiler may require as and ld in
+your path. On solaris systems you need uname in your path.
+
+* `LD_LIBRARY_PATH`
+R3.15 shared libraries and executables normally contain the full
+path to any libraries they require. However, if you move the EPICS
+files or directories from their build-time location then in order
+for the shared libraries to be found at runtime `LD_LIBRARY_PATH`
+must include the full pathname to
+`$(INSTALL_LOCATION)/lib/$(EPICS_HOST_ARCH)` when invoking
+executables, or some equivalent OS-specific mechanism (such as
+/etc/ld.so.conf on Linux) must be used. Shared libraries are now
+built by default on all Unix type hosts.
+
+#### Do site-specific build configuration
+
+**Site configuration**
+To configure EPICS, you may want to modify the default definitions
+in the following files:
+
+```
+        configure/CONFIG_SITE      Build choices. Specify target archs.
+        configure/CONFIG_SITE_ENV  Environment variable defaults
+        configure/RELEASE          TORNADO2 full path location
+```
+
+**Host configuration**
+To configure each host system, you may override the default
+definitions by adding a new file in the configure/os directory with
+override definitions. The new file should have the same name as the
+distribution file to be overridden except with CONFIG in the name
+changed to `CONFIG_SITE`.
+
+```
+        configure/os/CONFIG.&lt;host>.&lt;host>      Host build settings
+        configure/os/CONFIG.&lt;host>.Common      Host common build settings
+```
+
+**Target configuration**
+To configure each target system, you may override the default
+definitions by adding a new file in the configure/os directory with
+override definitions. The new file should have the same name as the
+distribution file to be overridden except with CONFIG in the name
+replaced by `CONFIG_SITE`. This step is necessary even if the host
+system is the only target system.
+
+```
+        configure/os/CONFIG.Common.&lt;target>     Target common settings
+        configure/os/CONFIG.&lt;host>.&lt;target>     Host-target settings
+```
+
+#### Build EPICS base
+
+After configuring the build you should be able to build EPICS base
+by issuing the following commands in the distribution's root
+directory (base):
+
+```
+        gnumake clean uninstall
+        gnumake
+```
+
+The command "gnumake clean uninstall" will remove all files and
+directories generated by a previous build. The command "gnumake"
+will build and install everything for the configured host and
+targets.
+
+It is recommended that you do a "gnumake clean uninstall" at the
+root directory of an EPICS directory structure before each complete
+rebuild to ensure that all components will be rebuilt.
+
+### <span id="0_0_13">Example application and extension</span>
+
+A perl tool, makeBaseApp.pl is included in the distribution file. This
+script will create a sample application that can be built and then
+executed to try out this release of base.
+
+Instructions for building and executing the 3.15 example application
+can be found in the section "Example Application" of Chapter 2,
+"Getting Started", in the "IOC Application Developer's Guide" for this
+release. The "Example IOC Application" section briefly explains how to
+create and build an example application in a user created &lt;top>
+directory. It also explains how to run the example application on a
+vxWorks ioc or as a process on the host system. By running the example
+application as a host-based IOC, you will be able to quickly implement
+a complete EPICS system and be able to run channel access clients on
+the host system.
+
+A perl script, makeBaseExt.pl, is included in the distribution file.
+This script will create a sample extension that can be built and
+executed. The makeBaseApp.pl and makeBaseExt.pl scripts are installed
+into the install location bin/&lt;hostarch> directory during the base
+build.
+
+### <span id="0_0_14">Multiple host platforms</span>
+
+You can build using a single EPICS directory structure on multiple
+host systems and for multiple cross target systems. The intermediate
+and binary files generated by the build will be created in separate
+subdirectories and installed into the appropriate separate host/target
+install directories. EPICS executables and perl scripts are installed
+into the `$(INSTALL_LOCATION)/bin/<arch>` directories. Libraries are
+installed into $`(INSTALL_LOCATION)/lib/<arch>`. The default
+definition for `$(INSTALL_LOCATION)` is `$(TOP)` which is the root
+directory in the distribution directory structure, base. Created
+object files are stored in O.&lt;arch> source subdirectories, This
+allows objects for multiple cross target architectures to be
+maintained at the same time. To build EPICS base for a specific
+host/target combination you must have the proper host/target C/C++
+cross compiler and target header files and the base/configure/os
+directory must have the appropriate configure files.

documentation/ReleaseChecklist.html

@@ -136,17 +136,17 @@ relevent roles unless the Release Manager designates otherwise:</p>
       <td>Tag the module in Git, using these tag conventions:
         <ul>
           <li>
-            <tt>R3.15.6-pre1</tt>
+            <tt>R3.15.7-pre1</tt>
             &mdash; pre-release tag
             </li>
           <li>
-            <tt>R3.15.6-rc1</tt>
+            <tt>R3.15.7-rc1</tt>
             &mdash; release candidate tag
             </li>
         </ul>
         <blockquote><tt>
           cd base-3.15<br />
-          git tag -m 'RL: Tagged for 3.15.6-rc1' R3.15.6-rc1
+          git tag -m 'ANJ: Tagged for 3.15.7-rc1' R3.15.7-rc1
           </tt></blockquote>
         </td>
       </tr>
@@ -158,11 +158,11 @@ relevent roles unless the Release Manager designates otherwise:</p>
         files and directories that are only used for continuous integration:
         <blockquote><tt>
           cd base-3.15<br />
-          git archive --prefix=base-3.15.6-rc1/ --output=base-3.15.6-rc1.tar.gz R3.15.6-rc1 configure documentation LICENSE Makefile README src startup
+          git archive --prefix=base-3.15.7-rc1/ --output=base-3.15.7-rc1.tar.gz R3.15.7-rc1 configure documentation LICENSE Makefile README src startup
           </tt></blockquote>
         Create a GPG signature file of the tarfile as follows:
         <blockquote><tt>
-          gpg --armor --sign --detach-sig base-3.15.6-rc1.tar.gz
+          gpg --armor --sign --detach-sig base-3.15.7-rc1.tar.gz
           </tt></blockquote>
         </td>
       </tr>
@@ -274,7 +274,7 @@ relevent roles unless the Release Manager designates otherwise:</p>
       <td>Tag the module in Git:
         <blockquote><tt>
           cd base-3.15<br />
-          git tag -m 'RL: Tagged for 3.15.6' R3.15.6
+          git tag -m 'ANJ: Tagged for 3.15.7' R3.15.7
           </tt></blockquote>
         </td>
       </tr>
@@ -285,11 +285,11 @@ relevent roles unless the Release Manager designates otherwise:</p>
         generates a gzipped tarfile directly from the repository:
         <blockquote><tt>
           cd base-3.15<br />
-          git archive --prefix=base-3.15.6/ --output=base-3.15.6.tar.gz R3.15.6 configure documentation LICENSE Makefile README src startup
+          git archive --prefix=base-3.15.7/ --output=base-3.15.7.tar.gz R3.15.7 configure documentation LICENSE Makefile README src startup
           </tt></blockquote>
         Create a GPG signature file of the tarfile as follows:
         <blockquote><tt>
-          gpg --armor --sign --detach-sig base-3.15.6.tar.gz
+          gpg --armor --sign --detach-sig base-3.15.7.tar.gz
           </tt></blockquote>
         </td>
       </tr>

src/ca/client/CAref.html

@@ -3137,7 +3137,8 @@ indicating the current state of the channel.</p>
 <dl>
   <dt><code>COUNT</code></dt>
     <dd>The element count to be read from the specified channel. A count of
-      zero means use the current element count from the server.</dd>
+      zero means use the current element count from the server, effectively
+      resulting in a variable size array subscription.</dd>
 </dl>
 <dl>
   <dt><code>CHID</code></dt>

src/ca/client/caRepeater.cpp

@@ -32,10 +32,12 @@
 #define epicsAssertAuthor "Jeff Hill johill@lanl.gov"
 
 #include "epicsAssert.h"
+#include "osiUnistd.h"
 #include "udpiiu.h"
 
 int main()
 {
+    chdir ( "/" );
     ca_repeater ();
     return ( 0 );
 }

src/ca/client/ca_client_context.cpp

@@ -45,20 +45,12 @@ static epicsThreadOnceId cacOnce = EPICS_THREAD_ONCE_INIT;
 
 const unsigned ca_client_context :: flushBlockThreshold = 0x58000;
 
-extern "C" void cacExitHandler ( void *)
-{
-    epicsThreadPrivateDelete ( caClientCallbackThreadId );
-    caClientCallbackThreadId = 0;
-    delete ca_client_context::pDefaultServiceInstallMutex;
-}
-
 // runs once only for each process
 extern "C" void cacOnceFunc ( void * )
 {
     caClientCallbackThreadId = epicsThreadPrivateCreate ();
     assert ( caClientCallbackThreadId );
     ca_client_context::pDefaultServiceInstallMutex = newEpicsMutex;
-    epicsAtExit ( cacExitHandler,0 );
 }
 
 extern epicsThreadPrivateId caClientContextId;

src/ca/client/oldAccess.h

@@ -288,7 +288,6 @@ private:
 };
 
 extern "C" void cacOnceFunc ( void * );
-extern "C" void cacExitHandler ( void *);
 
 struct ca_client_context : public cacContextNotify
 {
@@ -428,7 +427,6 @@ private:
     ca_client_context & operator = ( const ca_client_context & );
 
     friend void cacOnceFunc ( void * );
-    friend void cacExitHandler ( void *);
     static cacService * pDefaultService;
     static epicsMutex * pDefaultServiceInstallMutex;
     static const unsigned flushBlockThreshold;

src/ca/client/perl/Makefile

@@ -8,6 +8,18 @@
 TOP=../../../..
 include $(TOP)/configure/CONFIG
 
+ifdef T_A
+  PERL_VERSION = $(shell $(PERL) ../perlConfig.pl version)
+  PERL_ARCHNAME = $(shell $(PERL) ../perlConfig.pl archname)
+  PERL_ARCHPATH := $(PERL_VERSION)/$(PERL_ARCHNAME)
+
+  PERL_ARCHLIB  := $(shell $(PERL) ../perlConfig.pl archlib)
+  PERL_h = $(PERL_ARCHLIB)/CORE/perl.h
+
+  EXTUTILS := $(shell $(PERL) ../perlConfig.pl privlib)/ExtUtils
+  PERLBIN := $(shell $(PERL) ../perlConfig.pl bin)
+  XSUBPP := $(firstword $(wildcard $(PERLBIN)/xsubpp $(EXTUTILS)/xsubpp))
+
 # Special settings for Darwin:
 ifeq ($(OS_CLASS),Darwin)
   # Use hdepends command (not GNU compiler flags)
@@ -18,22 +30,23 @@ ifeq ($(OS_CLASS),Darwin)
   # Perl loadable libraries on Darwin have funny names
   LOADABLE_SHRLIB_PREFIX =
   LOADABLE_SHRLIB_SUFFIX = .$(shell $(PERL) ../perlConfig.pl dlext)
+
+ifeq ($(wildcard $(PERL_h)),)
+  # Perl's headers moved in Mojave
+  SDK_PATH := $(shell xcodebuild -version -sdk macosx Path)
+  PERL_ARCHLIB := $(SDK_PATH)/$(PERL_ARCHLIB)
+endif
 endif
 
-ifdef T_A
-  PERL_VERSION = $(shell $(PERL) ../perlConfig.pl version)
-  PERL_ARCHNAME = $(shell $(PERL) ../perlConfig.pl archname)
-  PERL_ARCHPATH := $(PERL_VERSION)/$(PERL_ARCHNAME)
-
-  EXTUTILS := $(shell $(PERL) ../perlConfig.pl privlib)/ExtUtils
-  PERLBIN := $(shell $(PERL) ../perlConfig.pl bin)
-  XSUBPP := $(firstword $(wildcard $(PERLBIN)/xsubpp $(EXTUTILS)/xsubpp))
-
+ifeq ($(T_A),$(EPICS_HOST_ARCH))                 # No cross-builds (wrong Perl!)
 ifeq ($(strip $(XSUBPP)),)
   $(warning Perl's xsubpp program was not found.)
   $(warning The Perl CA module will not be built.)
 else
-ifeq ($(T_A),$(EPICS_HOST_ARCH))                 # No cross-builds (wrong Perl!)
+ifeq ($(wildcard $(PERL_h)),)
+  $(warning Perl's C header files were not found.)
+  $(warning The Perl CA module will not be built.)
+else
 ifeq ($(findstring $(OS_CLASS),WIN32 cygwin32),) # Doesn't build on WIN32
   LOADABLE_LIBRARY_HOST = Cap5
 
@@ -52,10 +65,11 @@ endif
 endif
 endif
 endif
+endif
 
 Cap5_SRCS = Cap5.xs
 Cap5_LIBS = ca Com
-Cap5_INCLUDES = -I$(shell $(PERL) ../perlConfig.pl archlib)/CORE
+Cap5_INCLUDES = -I$(PERL_ARCHLIB)/CORE
 Cap5_CFLAGS = $(shell $(PERL) ../perlConfig.pl ccflags)
 
 CLEANS += Cap5.c

src/ioc/as/asDbLib.h

@@ -16,7 +16,7 @@
 #include "shareLib.h"
 
 typedef struct {
-    CALLBACK	callback;
+    epicsCallback	callback;
     long	status;
 } ASDBCALLBACK;
 

src/ioc/db/callback.c

@@ -168,7 +168,7 @@ static void callbackTask(void *arg)
             epicsEventMustWait(mySet->semWakeUp);
 
         while ((ptr = epicsRingPointerPop(mySet->queue))) {
-            CALLBACK *pcallback = (CALLBACK *)ptr;
+            epicsCallback *pcallback = (epicsCallback *)ptr;
             if(!epicsRingPointerIsEmpty(mySet->queue))
                 epicsEventMustTrigger(mySet->semWakeUp);
             mySet->queueOverflow = FALSE;
@@ -268,7 +268,7 @@ void callbackInit(void)
 }
 
 /* This routine can be called from interrupt context */
-int callbackRequest(CALLBACK *pcallback)
+int callbackRequest(epicsCallback *pcallback)
 {
     int priority;
     int pushOK;
@@ -297,7 +297,7 @@ int callbackRequest(CALLBACK *pcallback)
     return 0;
 }
 
-static void ProcessCallback(CALLBACK *pcallback)
+static void ProcessCallback(epicsCallback *pcallback)
 {
     dbCommon *pRec;
 
@@ -308,14 +308,14 @@ static void ProcessCallback(CALLBACK *pcallback)
     dbScanUnlock(pRec);
 }
 
-void callbackSetProcess(CALLBACK *pcallback, int Priority, void *pRec)
+void callbackSetProcess(epicsCallback *pcallback, int Priority, void *pRec)
 {
     callbackSetCallback(ProcessCallback, pcallback);
     callbackSetPriority(Priority, pcallback);
     callbackSetUser(pRec, pcallback);
 }
 
-int  callbackRequestProcessCallback(CALLBACK *pcallback,
+int  callbackRequestProcessCallback(epicsCallback *pcallback,
     int Priority, void *pRec)
 {
     callbackSetProcess(pcallback, Priority, pRec);
@@ -324,11 +324,11 @@ int  callbackRequestProcessCallback(CALLBACK *pcallback,
 
 static void notify(void *pPrivate)
 {
-    CALLBACK *pcallback = (CALLBACK *)pPrivate;
+    epicsCallback *pcallback = (epicsCallback *)pPrivate;
     callbackRequest(pcallback);
 }
 
-void callbackRequestDelayed(CALLBACK *pcallback, double seconds)
+void callbackRequestDelayed(epicsCallback *pcallback, double seconds)
 {
     epicsTimerId timer = (epicsTimerId)pcallback->timer;
 
@@ -339,7 +339,7 @@ void callbackRequestDelayed(CALLBACK *pcallback, double seconds)
     epicsTimerStartDelay(timer, seconds);
 }
 
-void callbackCancelDelayed(CALLBACK *pcallback)
+void callbackCancelDelayed(epicsCallback *pcallback)
 {
     epicsTimerId timer = (epicsTimerId)pcallback->timer;
 
@@ -348,7 +348,7 @@ void callbackCancelDelayed(CALLBACK *pcallback)
     }
 }
 
-void callbackRequestProcessCallbackDelayed(CALLBACK *pcallback,
+void callbackRequestProcessCallbackDelayed(epicsCallback *pcallback,
     int Priority, void *pRec, double seconds)
 {
     callbackSetProcess(pcallback, Priority, pRec);

src/ioc/db/callback.h

@@ -26,7 +26,7 @@ extern "C" {
 /*
  * WINDOWS also has a "CALLBACK" type def
  */
-#ifdef _WIN32
+#if defined(_WIN32) && !defined(EPICS_NO_CALLBACK)
 #	ifdef CALLBACK
 #		undef CALLBACK
 #	endif /*CALLBACK*/
@@ -44,7 +44,9 @@ typedef struct callbackPvt {
         void            *timer; /*for use by callback itself*/
 }epicsCallback;
 
+#if !defined(EPICS_NO_CALLBACK)
 typedef epicsCallback CALLBACK;
+#endif
 
 typedef void    (*CALLBACKFUNC)(struct callbackPvt*);
 
@@ -55,21 +57,21 @@ typedef void    (*CALLBACKFUNC)(struct callbackPvt*);
 #define callbackSetUser(USER,PCALLBACK)\
 ( (PCALLBACK)->user = (void *)(USER) )
 #define callbackGetUser(USER,PCALLBACK)\
-( (USER) = (void *)((CALLBACK *)(PCALLBACK))->user )
+( (USER) = (void *)((epicsCallback *)(PCALLBACK))->user )
 
 epicsShareFunc void callbackInit(void);
 epicsShareFunc void callbackStop(void);
 epicsShareFunc void callbackCleanup(void);
-epicsShareFunc int callbackRequest(CALLBACK *pCallback);
+epicsShareFunc int callbackRequest(epicsCallback *pCallback);
 epicsShareFunc void callbackSetProcess(
-    CALLBACK *pcallback, int Priority, void *pRec);
+    epicsCallback *pcallback, int Priority, void *pRec);
 epicsShareFunc int callbackRequestProcessCallback(
-    CALLBACK *pCallback,int Priority, void *pRec);
+    epicsCallback *pCallback,int Priority, void *pRec);
 epicsShareFunc void callbackRequestDelayed(
-    CALLBACK *pCallback,double seconds);
-epicsShareFunc void callbackCancelDelayed(CALLBACK *pcallback);
+    epicsCallback *pCallback,double seconds);
+epicsShareFunc void callbackCancelDelayed(epicsCallback *pcallback);
 epicsShareFunc void callbackRequestProcessCallbackDelayed(
-    CALLBACK *pCallback, int Priority, void *pRec, double seconds);
+    epicsCallback *pCallback, int Priority, void *pRec, double seconds);
 epicsShareFunc int callbackSetQueueSize(int size);
 epicsShareFunc int callbackParallelThreads(int count, const char *prio);
 

src/ioc/db/dbEvent.c

@@ -1165,3 +1165,8 @@ void db_delete_field_log (db_field_log *pfl)
         freeListFree(dbevFieldLogFreeList, pfl);
     }
 }
+
+int db_available_logs(void)
+{
+    return (int) freeListItemsAvail(dbevFieldLogFreeList);
+}

src/ioc/db/dbEvent.h

@@ -78,6 +78,7 @@ epicsShareFunc void db_event_disable (dbEventSubscription es);
 epicsShareFunc struct db_field_log* db_create_event_log (struct evSubscrip *pevent);
 epicsShareFunc struct db_field_log* db_create_read_log (struct dbChannel *chan);
 epicsShareFunc void db_delete_field_log (struct db_field_log *pfl);
+epicsShareFunc int db_available_logs(void);
 
 #define DB_EVENT_OK 0
 #define DB_EVENT_ERROR (-1)
@@ -87,4 +88,3 @@ epicsShareFunc void db_delete_field_log (struct db_field_log *pfl);
 #endif
 
 #endif /*INCLdbEventh*/
-

src/ioc/db/dbNotify.c

@@ -70,7 +70,7 @@ typedef struct notifyPvt {
     ELLNODE      node;   /*For free list*/
     long         magic;
     short        state;
-    CALLBACK     callback;
+    epicsCallback     callback;
     ELLLIST      waitList; /*list of records for current processNotify*/
     short        cancelWait;
     short        userCallbackWait;
@@ -93,7 +93,7 @@ static void notifyCleanup(processNotify *ppn);
 static void restartCheck(processNotifyRecord *ppnr);
 static void callDone(dbCommon *precord,processNotify *ppn);
 static void processNotifyCommon(processNotify *ppn,dbCommon *precord);
-static void notifyCallback(CALLBACK *pcallback);
+static void notifyCallback(epicsCallback *pcallback);
 
 #define ellSafeAdd(list,listnode) \
 { \
@@ -265,7 +265,7 @@ static void processNotifyCommon(processNotify *ppn,dbCommon *precord)
     callDone(precord, ppn);
 }
 
-static void notifyCallback(CALLBACK *pcallback)
+static void notifyCallback(epicsCallback *pcallback)
 {
     processNotify *ppn = NULL;
     dbCommon  *precord;

src/ioc/db/dbScan.c

@@ -109,7 +109,7 @@ static char *priorityName[NUM_CALLBACK_PRIORITIES] = {
 /* EVENT */
 
 typedef struct event_list {
-    CALLBACK            callback[NUM_CALLBACK_PRIORITIES];
+    epicsCallback            callback[NUM_CALLBACK_PRIORITIES];
     scan_list           scan_list[NUM_CALLBACK_PRIORITIES];
     struct event_list   *next;
     char                eventname[1]; /* actually arbitrary size */
@@ -120,7 +120,7 @@ static epicsMutexId event_lock;
 /* IO_EVENT*/
 
 typedef struct io_scan_list {
-    CALLBACK callback;
+    epicsCallback callback;
     scan_list scan_list;
 } io_scan_list;
 
@@ -141,9 +141,9 @@ static void periodicTask(void *arg);
 static void initPeriodic(void);
 static void deletePeriodic(void);
 static void spawnPeriodic(int ind);
-static void eventCallback(CALLBACK *pcallback);
+static void eventCallback(epicsCallback *pcallback);
 static void ioscanInit(void);
-static void ioscanCallback(CALLBACK *pcallback);
+static void ioscanCallback(epicsCallback *pcallback);
 static void ioscanDestroy(void);
 static void printList(scan_list *psl, char *message);
 static void scanList(scan_list *psl);
@@ -448,7 +448,7 @@ int scanpiol(void)                  /* print pioscan_list */
     return 0;
 }
 
-static void eventCallback(CALLBACK *pcallback)
+static void eventCallback(epicsCallback *pcallback)
 {
     scan_list *psl;
 
@@ -863,7 +863,7 @@ static void spawnPeriodic(int ind)
     epicsEventWait(startStopEvent);
 }
 
-static void ioscanCallback(CALLBACK *pcallback)
+static void ioscanCallback(epicsCallback *pcallback)
 {
     ioscan_head *piosh = (ioscan_head *) pcallback->user;
     int prio = pcallback->priority;

src/ioc/db/dbTest.c

@@ -54,7 +54,7 @@ typedef struct msgBuff TAB_BUFFER;
 #   define MIN(x,y)  (((x) < (y)) ? (x) : (y))
 #endif
 #ifndef MAX
-#   define MAX(x,y)  (((x) < (y)) ? (x) : (y))
+#   define MAX(x,y)  (((x) > (y)) ? (x) : (y))
 #endif
 
 /* Local Routines */

src/ioc/db/menuAlarmStat.dbd.pod

@@ -7,6 +7,17 @@
 # and higher are distributed subject to a Software License Agreement found
 # in file LICENSE that is included with this distribution. 
 #*************************************************************************
+
+=head1 Menu menuAlarmStat
+
+This menu defines the possible alarm statuses that EPICS records can exhibit 
+which is used for C<STAT> and C<NSTA> fields of all record types.
+See L<Alarm Status> for more information.
+
+=menu menuAlarmStat
+
+=cut
+
 menu(menuAlarmStat) {
 	choice(menuAlarmStatNO_ALARM,"NO_ALARM")
 	choice(menuAlarmStatREAD,"READ")

src/ioc/db/menuFtype.dbd.pod

@@ -7,6 +7,15 @@
 # and higher are distributed subject to a Software License Agreement found
 # in file LICENSE that is included with this distribution. 
 #*************************************************************************
+
+=head1 Menu menuFtype
+
+This menu is used for the C<FTVL> and similar fields of many record types.
+
+=menu menuFtype
+
+=cut
+
 menu(menuFtype) {
 	choice(menuFtypeSTRING,"STRING")
 	choice(menuFtypeCHAR,"CHAR")

src/ioc/db/menuIvoa.dbd.pod

@@ -3,10 +3,19 @@
 #     National Laboratory.
 # Copyright (c) 2002 The Regents of the University of California, as
 #     Operator of Los Alamos National Laboratory.
-# EPICS BASE Versions 3.13.7
-# and higher are distributed subject to a Software License Agreement found
-# in file LICENSE that is included with this distribution. 
+# EPICS BASE is distributed subject to a Software License Agreement found
+# in file LICENSE that is included with this distribution.
 #*************************************************************************
+
+=head1 Menu menuIvoa
+
+This menu specifies the possibile actions to take when the INVALID alarm is
+triggered. See individual record types for more information.
+
+=menu menuIvoa
+
+=cut
+
 menu(menuIvoa) {
 	choice(menuIvoaContinue_normally,"Continue normally")
 	choice(menuIvoaDon_t_drive_outputs,"Don't drive outputs")

src/ioc/db/menuOmsl.dbd

@@ -1,13 +0,0 @@
-#*************************************************************************
-# Copyright (c) 2002 The University of Chicago, as Operator of Argonne
-#     National Laboratory.
-# Copyright (c) 2002 The Regents of the University of California, as
-#     Operator of Los Alamos National Laboratory.
-# EPICS BASE Versions 3.13.7
-# and higher are distributed subject to a Software License Agreement found
-# in file LICENSE that is included with this distribution. 
-#*************************************************************************
-menu(menuOmsl) {
-	choice(menuOmslsupervisory,"supervisory")
-	choice(menuOmslclosed_loop,"closed_loop")
-}

src/ioc/db/menuOmsl.dbd.pod

@@ -6,19 +6,20 @@
 # EPICS BASE is distributed subject to a Software License Agreement found
 # in file LICENSE that is included with this distribution.
 #*************************************************************************
-recordtype(state) {
-	include "dbCommon.dbd" 
-	field(VAL,DBF_STRING) {
-		prompt("Value")
-		promptgroup("40 - Input")
-		asl(ASL0)
-		pp(TRUE)
-		size(20)
-	}
-	field(OVAL,DBF_STRING) {
-		prompt("Prev Value")
-		special(SPC_NOMOD)
-		interest(3)
-		size(20)
-	}
+
+=head1 Menu menuOmsl
+
+This menu is used for the C<OMSL> field of many output record types. It controls
+whether the record will fetch an input value from its C<DOL> input link when
+processed, which is useful when it is part of a closed loop control algorithm.
+The C<supervisory> state means the input link will not be used, C<closed_loop>
+enables the input link.
+
+=menu menuOmsl
+
+=cut
+
+menu(menuOmsl) {
+	choice(menuOmslsupervisory,"supervisory")
+	choice(menuOmslclosed_loop,"closed_loop")
 }

src/ioc/db/menuYesNo.dbd

@@ -1,13 +0,0 @@
-#*************************************************************************
-# Copyright (c) 2002 The University of Chicago, as Operator of Argonne
-#     National Laboratory.
-# Copyright (c) 2002 The Regents of the University of California, as
-#     Operator of Los Alamos National Laboratory.
-# EPICS BASE Versions 3.13.7
-# and higher are distributed subject to a Software License Agreement found
-# in file LICENSE that is included with this distribution. 
-#*************************************************************************
-menu(menuYesNo) {
-	choice(menuYesNoNO,"NO")
-	choice(menuYesNoYES,"YES")
-}

src/ioc/db/menuYesNo.dbd.pod

@@ -0,0 +1,29 @@
+#*************************************************************************
+# Copyright (c) 2002 The University of Chicago, as Operator of Argonne
+#     National Laboratory.
+# Copyright (c) 2002 The Regents of the University of California, as
+#     Operator of Los Alamos National Laboratory.
+# EPICS BASE is distributed subject to a Software License Agreement found
+# in file LICENSE that is included with this distribution.
+#*************************************************************************
+
+=head1 Menu menuYesNo
+
+This menu is used by many record types to specify simple C<NO> or C<YES>
+options for record-specific purposes.
+
+Note that no other values for a field that uses menuYesNo are possible, e.g.
+C<MAYBE> or C<NO WAY> would not be accepted as choices for the field.
+Also, the choices C<yes>, C<No>, and C<Yes> are not valid choices since they
+don't match the case of C<NO> or C<YES>.
+The integer values C<0> and C<1> may often be used instead however, they are
+used as an index into the choices so C<0> becomes C<NO> and C<1> becomes <YES>.
+
+=menu menuYesNo
+
+=cut
+
+menu(menuYesNo) {
+	choice(menuYesNoNO,"NO")
+	choice(menuYesNoYES,"YES")
+}

src/ioc/db/test/callbackParallelTest.c

@@ -44,8 +44,8 @@
 #define TEST_DELAY(i) ((i / NUM_CALLBACK_PRIORITIES) * DELAY_QUANTUM)
 
 typedef struct myPvt {
-    CALLBACK cb1;
-    CALLBACK cb2;
+    epicsCallback cb1;
+    epicsCallback cb2;
     epicsTimeStamp pass1Time;
     epicsTimeStamp pass2Time;
     double delay;
@@ -55,7 +55,7 @@ typedef struct myPvt {
 
 epicsEventId finished;
 
-static void myCallback(CALLBACK *pCallback)
+static void myCallback(epicsCallback *pCallback)
 {
     myPvt *pmyPvt;
 
@@ -74,7 +74,7 @@ static void myCallback(CALLBACK *pCallback)
     }
 }
 
-static void finalCallback(CALLBACK *pCallback)
+static void finalCallback(epicsCallback *pCallback)
 {
     myCallback(pCallback);
     epicsEventSignal(finished);

src/ioc/db/test/callbackTest.c

@@ -44,8 +44,8 @@
 #define TEST_DELAY(i) ((i / NUM_CALLBACK_PRIORITIES) * DELAY_QUANTUM)
 
 typedef struct myPvt {
-    CALLBACK cb1;
-    CALLBACK cb2;
+    epicsCallback cb1;
+    epicsCallback cb2;
     epicsTimeStamp pass1Time;
     epicsTimeStamp pass2Time;
     double delay;
@@ -56,7 +56,7 @@ typedef struct myPvt {
 epicsEventId finished;
 
 
-static void myCallback(CALLBACK *pCallback)
+static void myCallback(epicsCallback *pCallback)
 {
     myPvt *pmyPvt;
 
@@ -75,7 +75,7 @@ static void myCallback(CALLBACK *pCallback)
     }
 }
 
-static void finalCallback(CALLBACK *pCallback)
+static void finalCallback(epicsCallback *pCallback)
 {
     myCallback(pCallback);
     epicsEventSignal(finished);

src/ioc/dbStatic/dbLexRoutines.c

@@ -428,6 +428,10 @@ static void dbMenuHead(char *name)
     dbMenu		*pdbMenu;
     GPHENTRY		*pgphentry;
 
+    if (!*name) {
+        yyerrorAbort("dbMenuHead: Menu name can't be empty");
+        return;
+    }
     pgphentry = gphFind(pdbbase->pgpHash,name,&pdbbase->menuList);
     if(pgphentry) {
 	duplicate = TRUE;
@@ -441,6 +445,10 @@ static void dbMenuHead(char *name)
 
 static void dbMenuChoice(char *name,char *value)
 {
+    if (!*name) {
+        yyerror("dbMenuChoice: Menu choice name can't be empty");
+        return;
+    }
     if(duplicate) return;
     allocTemp(epicsStrDup(name));
     allocTemp(epicsStrDup(value));
@@ -488,6 +496,10 @@ static void dbRecordtypeHead(char *name)
     dbRecordType		*pdbRecordType;
     GPHENTRY		*pgphentry;
 
+    if (!*name) {
+        yyerrorAbort("dbRecordtypeHead: Recordtype name can't be empty");
+        return;
+    }
     pgphentry = gphFind(pdbbase->pgpHash,name,&pdbbase->recordTypeList);
     if(pgphentry) {
 	duplicate = TRUE;
@@ -505,7 +517,11 @@ static void dbRecordtypeFieldHead(char *name,char *type)
 {
     dbFldDes		*pdbFldDes;
     int			i;
-    
+
+    if (!*name) {
+        yyerrorAbort("dbRecordtypeFieldHead: Field name can't be empty");
+        return;
+    }
     if(duplicate) return;
     pdbFldDes = dbCalloc(1,sizeof(dbFldDes));
     allocTemp(pdbFldDes);
@@ -572,7 +588,7 @@ static void dbRecordtypeFieldItem(char *name,char *value)
         if(sscanf(value,"%hd",&pdbFldDes->special)==1) {
             return;
         }
-        yyerror("Illegal special value.");
+        yyerror("Illegal 'special' value.");
         return;
     }
     if(strcmp(name,"pp")==0) {
@@ -581,13 +597,13 @@ static void dbRecordtypeFieldItem(char *name,char *value)
         } else if((strcmp(value,"NO")==0) || (strcmp(value,"FALSE")==0)) {
             pdbFldDes->process_passive = FALSE;
         } else {
-            yyerror("Illegal value. Must be NO or YES");
+            yyerror("Illegal 'pp' value, must be YES/NO/TRUE/FALSE");
         }
         return;
     }
     if(strcmp(name,"interest")==0) {
         if(sscanf(value,"%hd",&pdbFldDes->interest)!=1)
-            yyerror("Illegal value. Must be integer");
+            yyerror("Illegal 'interest' value, must be integer");
         return;
     }
     if(strcmp(name,"base")==0) {
@@ -596,13 +612,13 @@ static void dbRecordtypeFieldItem(char *name,char *value)
         } else if(strcmp(value,"HEX")==0) {
             pdbFldDes->base = CT_HEX;
         } else {
-            yyerror("Illegal value. Must be CT_DECIMAL or CT_HEX");
+            yyerror("Illegal 'base' value, must be DECIMAL/HEX");
         }
         return;
     }
     if(strcmp(name,"size")==0) {
         if(sscanf(value,"%hd",&pdbFldDes->size)!=1)
-            yyerror("Illegal value. Must be integer");
+            yyerror("Illegal 'size' value, must be integer");
         return;
     }
     if(strcmp(name,"extra")==0) {
@@ -794,6 +810,10 @@ static void dbDriver(char *name)
     drvSup	*pdrvSup;
     GPHENTRY	*pgphentry;
 
+    if (!*name) {
+        yyerrorAbort("dbDriver: Driver name can't be empty");
+        return;
+    }
     pgphentry = gphFind(pdbbase->pgpHash,name,&pdbbase->drvList);
     if(pgphentry) {
 	return;
@@ -813,6 +833,10 @@ static void dbRegistrar(char *name)
     dbText	*ptext;
     GPHENTRY	*pgphentry;
 
+    if (!*name) {
+        yyerrorAbort("dbRegistrar: Registrar name can't be empty");
+        return;
+    }
     pgphentry = gphFind(pdbbase->pgpHash,name,&pdbbase->registrarList);
     if(pgphentry) {
 	return;
@@ -832,6 +856,10 @@ static void dbFunction(char *name)
     dbText     *ptext;
     GPHENTRY   *pgphentry;
 
+    if (!*name) {
+        yyerrorAbort("dbFunction: Function name can't be empty");
+        return;
+    }
     pgphentry = gphFind(pdbbase->pgpHash,name,&pdbbase->functionList);
     if(pgphentry) {
        return;
@@ -851,6 +879,10 @@ static void dbVariable(char *name, char *type)
     dbVariableDef	*pvar;
     GPHENTRY	*pgphentry;
 
+    if (!*name) {
+        yyerrorAbort("dbVariable: Variable name can't be empty");
+        return;
+    }
     pgphentry = gphFind(pdbbase->pgpHash,name,&pdbbase->variableList);
     if(pgphentry) {
 	return;
@@ -871,6 +903,10 @@ static void dbBreakHead(char *name)
     brkTable	*pbrkTable;
     GPHENTRY	*pgphentry;
 
+    if (!*name) {
+        yyerrorAbort("dbBreakHead: Breaktable name can't be empty");
+        return;
+    }
     pgphentry = gphFind(pdbbase->pgpHash,name,&pdbbase->bptList);
     if(pgphentry) {
 	duplicate = TRUE;
@@ -973,6 +1009,10 @@ static void dbRecordHead(char *recordType, char *name, int visible)
     DBENTRY *pdbentry;
     long status;
 
+    if (!*name) {
+        yyerrorAbort("dbRecordHead: Record name can't be empty");
+        return;
+    }
     badch = strpbrk(name, " \"'.$");
     if (badch) {
         epicsPrintf("Bad character '%c' in record name \"%s\"\n",
@@ -1072,6 +1112,10 @@ static void dbRecordInfo(char *name, char *value)
     tempListNode *ptempListNode;
     long status;
 
+    if (!*name) {
+        yyerrorAbort("dbRecordInfo: Info item name can't be empty");
+        return;
+    }
     if (duplicate) return;
     ptempListNode = (tempListNode *)ellFirst(&tempList);
     pdbentry = ptempListNode->item;
@@ -1091,6 +1135,10 @@ static void dbRecordAlias(char *name)
     tempListNode *ptempListNode;
     long status;
 
+    if (!*name) {
+        yyerrorAbort("dbRecordAlias: Alias name can't be empty");
+        return;
+    }
     if (duplicate) return;
     ptempListNode = (tempListNode *)ellFirst(&tempList);
     pdbentry = ptempListNode->item;
@@ -1108,6 +1156,10 @@ static void dbAlias(char *name, char *alias)
     DBENTRY dbEntry;
     DBENTRY *pdbEntry = &dbEntry;
 
+    if (!*alias) {
+        yyerrorAbort("dbAlias: Alias name can't be empty");
+        return;
+    }
     dbInitEntry(pdbbase, pdbEntry);
     if (dbFindRecord(pdbEntry, name)) {
         epicsPrintf("Alias \"%s\" refers to unknown record \"%s\"\n",

src/ioc/dbtemplate/Makefile

@@ -13,7 +13,7 @@ SRC_DIRS += $(IOCDIR)/dbtemplate
 
 PROD_HOST += msi
 
-msi_SRCS = msi.c
+msi_SRCS = msi.cpp
 msi_LIBS += Com
 HTMLS += msi.html
 

src/ioc/dbtemplate/msi.cpp

@@ -9,6 +9,9 @@
 
 /* msi - macro substitutions and include */
 
+#include <string>
+#include <list>
+
 #include <stdlib.h>
 #include <stddef.h>
 #include <stdio.h>
@@ -18,7 +21,6 @@
 
 #include <dbDefs.h>
 #include <macLib.h>
-#include <ellLib.h>
 #include <errlog.h>
 #include <epicsString.h>
 #include <osiFileName.h>
@@ -56,32 +58,35 @@ int din = 0;
 typedef struct inputData inputData;
 
 static void inputConstruct(inputData **ppvt);
-static void inputDestruct(inputData *pvt);
-static void inputAddPath(inputData *pvt, char *pval);
-static void inputBegin(inputData *pvt, char *fileName);
-static char *inputNextLine(inputData *pvt);
-static void inputNewIncludeFile(inputData *pvt, char *name);
-static void inputErrPrint(inputData *pvt);
+static void inputDestruct(inputData * const pvt);
+static void inputAddPath(inputData * const pvt, const char * const pval);
+static void inputBegin(inputData * const pvt, const char * const fileName);
+static char *inputNextLine(inputData * const pvt);
+static void inputNewIncludeFile(inputData * const pvt, const char * const name);
+static void inputErrPrint(const inputData * const pvt);
 
 /* Module to read the substitution file */
 typedef struct subInfo subInfo;
 
-static void substituteOpen(subInfo **ppvt, char *substitutionName);
-static void substituteDestruct(subInfo *pvt);
-static int substituteGetNextSet(subInfo *pvt, char **filename);
-static int substituteGetGlobalSet(subInfo *pvt);
-static char *substituteGetReplacements(subInfo *pvt);
-static char *substituteGetGlobalReplacements(subInfo *pvt);
+static void substituteOpen(subInfo **ppvt, const std::string& substitutionName);
+static void substituteDestruct(subInfo * const pvt);
+static bool substituteGetNextSet(subInfo * const pvt, char **filename);
+static bool substituteGetGlobalSet(subInfo * const pvt);
+static const char *substituteGetReplacements(subInfo * const pvt);
+static const char *substituteGetGlobalReplacements(subInfo * const pvt);
 
 /* Forward references to local routines */
-static void usageExit(int status);
-static void abortExit(int status);
-static void addMacroReplacements(MAC_HANDLE *macPvt, char *pval);
-static void makeSubstitutions(inputData *inputPvt, MAC_HANDLE *macPvt, char *templateName);
+static void usageExit(const int status);
+static void abortExit(const int status);
+static void addMacroReplacements(MAC_HANDLE * const macPvt,
+                                 const char * const pval);
+static void makeSubstitutions(inputData * const inputPvt,
+                              MAC_HANDLE * const macPvt,
+                              const char * const templateName);
 
 /*Global variables */
 static int opt_V = 0;
-static int opt_D = 0;
+static bool opt_D = false;
 
 static char *outFile = 0;
 static int numDeps = 0, depHashes[MAX_DEPS];
@@ -92,23 +97,21 @@ int main(int argc,char **argv)
     inputData *inputPvt;
     MAC_HANDLE *macPvt;
     char *pval;
-    int  narg;
-    char *substitutionName = 0;
+    std::string substitutionName;
     char *templateName = 0;
-    int  i;
-    int  localScope = 1;
+    bool localScope = true;
 
     inputConstruct(&inputPvt);
     macCreateHandle(&macPvt, 0);
     while ((argc > 1) && (argv[1][0] == '-')) {
-        narg = (strlen(argv[1]) == 2) ? 2 : 1;
+        int narg = (strlen(argv[1]) == 2) ? 2 : 1;
         pval = (narg == 1) ? (argv[1] + 2) : argv[2];
 
         if (strncmp(argv[1], "-I", 2) == 0) {
             inputAddPath(inputPvt, pval);
         }
         else if (strcmp(argv[1], "-D") == 0) {
-            opt_D = 1;
+            opt_D = true;
             narg = 1; /* no argument for this option */
         }
         else if(strncmp(argv[1], "-o", 2) == 0) {
@@ -118,14 +121,14 @@ int main(int argc,char **argv)
             addMacroReplacements(macPvt, pval);
         }
         else if(strncmp(argv[1], "-S", 2) == 0) {
-            substitutionName = epicsStrDup(pval);
+            substitutionName = pval;
         }
         else if (strcmp(argv[1], "-V") == 0) {
             opt_V = 1;
             narg = 1; /* no argument for this option */
         }
         else if (strcmp(argv[1], "-g") == 0) {
-            localScope = 0;
+            localScope = false;
             narg = 1; /* no argument for this option */
         }
         else if (strcmp(argv[1], "-h") == 0) {
@@ -137,7 +140,7 @@ int main(int argc,char **argv)
         }
 
         argc -= narg;
-        for (i = 1; i < argc; i++)
+        for (int i = 1; i < argc; i++)
             argv[i] = argv[i + narg];
     }
 
@@ -165,24 +168,24 @@ int main(int argc,char **argv)
     if (argc == 2)
         templateName = epicsStrDup(argv[1]);
 
-    if (!substitutionName) {
+    if (substitutionName.empty()) {
         STEP("Single template+substitutions file");
         makeSubstitutions(inputPvt, macPvt, templateName);
     }
     else {
         subInfo *substitutePvt;
         char *filename = 0;
-        int isGlobal, isFile;
+        bool isGlobal, isFile;
 
-        STEPS("Substitutions from file", substitutionName);
+        STEPS("Substitutions from file", substitutionName.c_str());
         substituteOpen(&substitutePvt, substitutionName);
         do {
             isGlobal = substituteGetGlobalSet(substitutePvt);
             if (isGlobal) {
                 STEP("Handling global macros");
-                pval = substituteGetGlobalReplacements(substitutePvt);
-                if (pval)
-                    addMacroReplacements(macPvt, pval);
+                const char *macStr = substituteGetGlobalReplacements(substitutePvt);
+                if (macStr)
+                    addMacroReplacements(macPvt, macStr);
             }
             else if ((isFile = substituteGetNextSet(substitutePvt, &filename))) {
                 if (templateName)
@@ -193,11 +196,12 @@ int main(int argc,char **argv)
                 }
 
                 STEPS("Handling template file", filename);
-                while ((pval = substituteGetReplacements(substitutePvt))) {
+                const char *macStr;
+                while ((macStr = substituteGetReplacements(substitutePvt))) {
                     if (localScope)
                         macPushScope(macPvt);
 
-                    addMacroReplacements(macPvt, pval);
+                    addMacroReplacements(macPvt, macStr);
                     makeSubstitutions(inputPvt, macPvt, filename);
 
                     if (localScope)
@@ -207,18 +211,18 @@ int main(int argc,char **argv)
         } while (isGlobal || isFile);
         substituteDestruct(substitutePvt);
     }
-    errlogFlush();
     macDeleteHandle(macPvt);
+    errlogFlush();  // macLib calls errlogPrintf()
     inputDestruct(inputPvt);
     if (opt_D) {
         printf("\n");
     }
+    fflush(stdout);
     free(templateName);
-    free(substitutionName);
     return opt_V & 2;
 }
 
-void usageExit(int status)
+void usageExit(const int status)
 {
     fprintf(stderr,
         "Usage: msi [options] [template]\n"
@@ -236,7 +240,7 @@ void usageExit(int status)
     exit(status);
 }
 
-void abortExit(int status)
+void abortExit(const int status)
 {
     if (outFile) {
         fclose(stdout);
@@ -245,7 +249,8 @@ void abortExit(int status)
     exit(status);
 }
 
-static void addMacroReplacements(MAC_HANDLE *macPvt, char *pval)
+static void addMacroReplacements(MAC_HANDLE * const macPvt,
+                                 const char * const pval)
 {
     char **pairs;
     long status;
@@ -268,7 +273,9 @@ static void addMacroReplacements(MAC_HANDLE *macPvt, char *pval)
 typedef enum {cmdInclude,cmdSubstitute} cmdType;
 static const char *cmdNames[] = {"include","substitute"};
 
-static void makeSubstitutions(inputData *inputPvt, MAC_HANDLE *macPvt, char *templateName)
+static void makeSubstitutions(inputData * const inputPvt,
+                              MAC_HANDLE * const macPvt,
+                              const char * const templateName)
 {
     char *input;
     static char buffer[MAX_BUFFER_SIZE];
@@ -292,7 +299,6 @@ static void makeSubstitutions(inputData *inputPvt, MAC_HANDLE *macPvt, char *tem
         if (command) {
             char *pstart;
             char *pend;
-            char *copy;
             int  cmdind=-1;
             int  i;
 
@@ -325,16 +331,15 @@ static void makeSubstitutions(inputData *inputPvt, MAC_HANDLE *macPvt, char *tem
             /*skip quote and any trailing blanks*/
             while (*++p == ' ') ;
             if (*p != '\n' && *p != 0) goto endcmd;
-            copy = calloc(pend-pstart + 1, sizeof(char));
-            strncpy(copy, pstart, pend-pstart);
+            std::string copy = std::string(pstart, pend);
 
             switch(cmdind) {
             case cmdInclude:
-                inputNewIncludeFile(inputPvt,copy);
+                inputNewIncludeFile(inputPvt, copy.c_str());
                 break;
 
             case cmdSubstitute:
-                addMacroReplacements(macPvt,copy);
+                addMacroReplacements(macPvt, copy.c_str());
                 break;
 
             default:
@@ -342,7 +347,6 @@ static void makeSubstitutions(inputData *inputPvt, MAC_HANDLE *macPvt, char *tem
                 inputErrPrint(inputPvt);
                 abortExit(1);
             }
-            free(copy);
             expand = 0;
         }
 
@@ -361,94 +365,72 @@ endcmd:
 }
 
 typedef struct inputFile {
-    ELLNODE     node;
-    char        *filename;
+    std::string filename;
     FILE        *fp;
     int         lineNum;
 } inputFile;
 
-typedef struct pathNode {
-    ELLNODE     node;
-    char        *directory;
-} pathNode;
-
 struct inputData {
-    ELLLIST     inputFileList;
-    ELLLIST     pathList;
+    std::list<inputFile> inputFileList;
+    std::list<std::string> pathList;
     char        inputBuffer[MAX_BUFFER_SIZE];
+    inputData() { memset(inputBuffer, 0, sizeof(inputBuffer) * sizeof(inputBuffer[0])); };
 };
 
-static void inputOpenFile(inputData *pinputData, char *filename);
+static void inputOpenFile(inputData *pinputData, const char * const filename);
 static void inputCloseFile(inputData *pinputData);
 static void inputCloseAllFiles(inputData *pinputData);
 
 static void inputConstruct(inputData **ppvt)
 {
-    inputData *pinputData;
-
-    pinputData = calloc(1, sizeof(inputData));
-    ellInit(&pinputData->inputFileList);
-    ellInit(&pinputData->pathList);
-    *ppvt = pinputData;
+    *ppvt = new inputData;
 }
 
-static void inputDestruct(inputData *pinputData)
+static void inputDestruct(inputData * const pinputData)
 {
-    pathNode *ppathNode;
-
     inputCloseAllFiles(pinputData);
-    while ((ppathNode = (pathNode *) ellFirst(&pinputData->pathList))) {
-        ellDelete(&pinputData->pathList, &ppathNode->node);
-        free(ppathNode->directory);
-        free(ppathNode);
-    }
-    free(pinputData);
+    delete(pinputData);
 }
 
-static void inputAddPath(inputData *pinputData, char *path)
+static void inputAddPath(inputData * const pinputData, const char * const path)
 {
-    ELLLIST     *ppathList = &pinputData->pathList;
-    pathNode    *ppathNode;
     const char  *pcolon;
     const char  *pdir;
     size_t      len;
-    int         emptyName;
     const char  sep = *OSI_PATH_LIST_SEPARATOR;
 
     ENTER;
     pdir = path;
     /*an empty name at beginning, middle, or end means current directory*/
     while (pdir && *pdir) {
-        emptyName = ((*pdir == sep) ? 1 : 0);
+        bool emptyName = (*pdir == sep);
         if (emptyName) ++pdir;
 
-        ppathNode = (pathNode *) calloc(1, sizeof(pathNode));
-        ellAdd(ppathList, &ppathNode->node);
-
+        std::string directory;
         if (!emptyName) {
             pcolon = strchr(pdir, sep);
             len = (pcolon ? (pcolon - pdir) : strlen(pdir));
             if (len > 0)  {
-                ppathNode->directory = (char *) calloc(len + 1, sizeof(char));
-                strncpy(ppathNode->directory, pdir, len);
+                directory = std::string(pdir, len);
                 pdir = pcolon;
                 /*unless at end skip past first colon*/
                 if (pdir && *(pdir + 1) != 0) ++pdir;
             }
             else { /*must have been trailing : */
-                emptyName = 1;
+                emptyName = true;
             }
         }
 
         if (emptyName) {
-            ppathNode->directory = (char *) calloc(2, sizeof(char));
-            strcpy(ppathNode->directory, ".");
+            directory = ".";
         }
+
+        pinputData->pathList.push_back(directory);
     }
     EXIT;
 }
 
-static void inputBegin(inputData *pinputData, char *fileName)
+static void inputBegin(inputData * const pinputData, const char * const fileName)
 {
     ENTER;
     inputCloseAllFiles(pinputData);
@@ -456,16 +438,16 @@ static void inputBegin(inputData *pinputData, char *fileName)
     EXIT;
 }
 
-static char *inputNextLine(inputData *pinputData)
+static char *inputNextLine(inputData * const pinputData)
 {
-    inputFile   *pinputFile;
-    char        *pline;
+    std::list<inputFile>& inFileList = pinputData->inputFileList;
 
     ENTER;
-    while ((pinputFile = (inputFile *) ellFirst(&pinputData->inputFileList))) {
-        pline = fgets(pinputData->inputBuffer, MAX_BUFFER_SIZE, pinputFile->fp);
+    while (!inFileList.empty()) {
+        inputFile& inFile = inFileList.front();
+        char *pline = fgets(pinputData->inputBuffer, MAX_BUFFER_SIZE, inFile.fp);
         if (pline) {
-            ++pinputFile->lineNum;
+            ++inFile.lineNum;
             EXITS(pline);
             return pline;
         }
@@ -475,32 +457,31 @@ static char *inputNextLine(inputData *pinputData)
     return 0;
 }
 
-static void inputNewIncludeFile(inputData *pinputData, char *name)
+static void inputNewIncludeFile(inputData * const pinputData,
+                                const char * const name)
 {
     ENTER;
     inputOpenFile(pinputData,name);
     EXIT;
 }
 
-static void inputErrPrint(inputData *pinputData)
+static void inputErrPrint(const inputData *const pinputData)
 {
-    inputFile   *pinputFile;
-
     ENTER;
     fprintf(stderr, "input: '%s' at ", pinputData->inputBuffer);
-    pinputFile = (inputFile *) ellFirst(&pinputData->inputFileList);
-    while (pinputFile) {
-        fprintf(stderr, "line %d of ", pinputFile->lineNum);
+    const std::list<inputFile>& inFileList = pinputData->inputFileList;
+    std::list<inputFile>::const_iterator inFileIt = inFileList.begin();
+    while (inFileIt != inFileList.end()) {
+        fprintf(stderr, "line %d of ", inFileIt->lineNum);
 
-        if (pinputFile->filename) {
-            fprintf(stderr, " file %s\n", pinputFile->filename);
+        if (!inFileIt->filename.empty()) {
+            fprintf(stderr, " file %s\n", inFileIt->filename.c_str());
         }
         else {
             fprintf(stderr, "stdin:\n");
         }
 
-        pinputFile = (inputFile *) ellNext(&pinputFile->node);
-        if (pinputFile) {
+        if (++inFileIt != inFileList.end()) {
             fprintf(stderr, "  included from ");
         }
         else {
@@ -511,12 +492,11 @@ static void inputErrPrint(inputData *pinputData)
     EXIT;
 }
 
-static void inputOpenFile(inputData *pinputData,char *filename)
+static void inputOpenFile(inputData *pinputData, const char * const filename)
 {
-    ELLLIST     *ppathList = &pinputData->pathList;
-    pathNode    *ppathNode = 0;
-    inputFile   *pinputFile;
-    char        *fullname = 0;
+    std::list<std::string>& pathList = pinputData->pathList;
+    std::list<std::string>::iterator pathIt = pathList.end();
+    std::string fullname;
     FILE        *fp = 0;
 
     ENTER;
@@ -524,24 +504,19 @@ static void inputOpenFile(inputData *pinputData,char *filename)
         STEP("Using stdin");
         fp = stdin;
     }
-    else if ((ellCount(ppathList) == 0) || strchr(filename, '/')){
+    else if (pathList.empty() || strchr(filename, '/')){
         STEPS("Opening ", filename);
         fp = fopen(filename, "r");
     }
     else {
-        ppathNode = (pathNode *) ellFirst(ppathList);
-        while (ppathNode) {
-            fullname = calloc(strlen(filename) + strlen(ppathNode->directory) + 2,
-                sizeof(char));
-            strcpy(fullname, ppathNode->directory);
-            strcat(fullname, "/");
-            strcat(fullname, filename);
+        pathIt = pathList.begin();
+        while(pathIt != pathList.end()) {
+            fullname = *pathIt + "/" + filename;
             STEPS("Trying", filename);
-            fp = fopen(fullname, "r");
+            fp = fopen(fullname.c_str(), "r");
             if (fp)
                 break;
-            free(fullname);
-            ppathNode = (pathNode *) ellNext(&ppathNode->node);
+            ++pathIt;
         }
     }
 
@@ -552,20 +527,20 @@ static void inputOpenFile(inputData *pinputData,char *filename)
     }
 
     STEP("File opened");
-    pinputFile = calloc(1, sizeof(inputFile));
+    inputFile inFile = inputFile();
 
-    if (ppathNode) {
-        pinputFile->filename = fullname;
+    if (pathIt != pathList.end()) {
+        inFile.filename = fullname;
     }
     else if (filename) {
-        pinputFile->filename = epicsStrDup(filename);
+        inFile.filename = filename;
     }
     else {
-        pinputFile->filename = epicsStrDup("stdin");
+        inFile.filename = "stdin";
     }
 
     if (opt_D) {
-        int hash = epicsStrHash(pinputFile->filename, 12345);
+        int hash = epicsStrHash(inFile.filename.c_str(), 12345);
         int i = 0;
         int match = 0;
 
@@ -578,7 +553,7 @@ static void inputOpenFile(inputData *pinputData,char *filename)
         if (!match) {
             const char *wrap = numDeps ? " \\\n" : "";
 
-            printf("%s %s", wrap, pinputFile->filename);
+            printf("%s %s", wrap, inFile.filename.c_str());
             if (numDeps < MAX_DEPS) {
                 depHashes[numDeps++] = hash;
             }
@@ -589,33 +564,29 @@ static void inputOpenFile(inputData *pinputData,char *filename)
         }
     }
 
-    pinputFile->fp = fp;
-    ellInsert(&pinputData->inputFileList, 0, &pinputFile->node);
+    inFile.fp = fp;
+    pinputData->inputFileList.push_front(inFile);
     EXIT;
 }
 
 static void inputCloseFile(inputData *pinputData)
 {
-    inputFile *pinputFile;
-
+    std::list<inputFile>& inFileList = pinputData->inputFileList;
     ENTER;
-    pinputFile = (inputFile *) ellFirst(&pinputData->inputFileList);
-    if (pinputFile) {
-        ellDelete(&pinputData->inputFileList, &pinputFile->node);
-        if (fclose(pinputFile->fp))
-            fprintf(stderr, "msi: Can't close input file '%s'\n", pinputFile->filename);
-        free(pinputFile->filename);
-        free(pinputFile);
+    if(!inFileList.empty()) {
+        inputFile& inFile = inFileList.front();
+        if (fclose(inFile.fp))
+            fprintf(stderr, "msi: Can't close input file '%s'\n", inFile.filename.c_str());
+        inFileList.erase(inFileList.begin());
     }
     EXIT;
 }
 
 static void inputCloseAllFiles(inputData *pinputData)
 {
-    inputFile   *pinputFile;
-
     ENTER;
-    while ((pinputFile = (inputFile *) ellFirst(&pinputData->inputFileList))) {
+    const std::list<inputFile>& inFileList = pinputData->inputFileList;
+    while(!inFileList.empty()) {
         inputCloseFile(pinputData);
     }
     EXIT;
@@ -627,7 +598,7 @@ typedef enum {
 } tokenType;
 
 typedef struct subFile {
-    char        *substitutionName;
+    std::string substitutionName;
     FILE        *fp;
     int         lineNum;
     char        inputBuffer[MAX_BUFFER_SIZE];
@@ -636,25 +607,20 @@ typedef struct subFile {
     char        string[MAX_BUFFER_SIZE];
 } subFile;
 
-typedef struct patternNode {
-    ELLNODE     node;
-    char        *var;
-} patternNode;
-
 struct subInfo {
     subFile     *psubFile;
-    int         isFile;
+    bool        isFile;
     char        *filename;
-    int         isPattern;
-    ELLLIST     patternList;
-    size_t      size;
-    size_t      curLength;
-    char        *macroReplacements;
+    bool        isPattern;
+    std::list<std::string> patternList;
+    std::string macroReplacements;
+    subInfo() : psubFile(NULL), isFile(false), filename(NULL),
+                isPattern(false) {};
 };
 
 static char *subGetNextLine(subFile *psubFile);
 static tokenType subGetNextToken(subFile *psubFile);
-static void subFileErrPrint(subFile *psubFile,char * message);
+static void subFileErrPrint(subFile *psubFile, const char * message);
 static void freeSubFile(subInfo *psubInfo);
 static void freePattern(subInfo *psubInfo);
 static void catMacroReplacements(subInfo *psubInfo,const char *value);
@@ -668,7 +634,7 @@ void freeSubFile(subInfo *psubInfo)
         if (fclose(psubFile->fp))
             fprintf(stderr, "msi: Can't close substitution file\n");
     }
-    free(psubFile);
+    delete(psubFile);
     free(psubInfo->filename);
     psubInfo->psubFile = 0;
     EXIT;
@@ -676,43 +642,36 @@ void freeSubFile(subInfo *psubInfo)
 
 void freePattern(subInfo *psubInfo)
 {
-    patternNode *ppatternNode;
-
     ENTER;
-    while ((ppatternNode = (patternNode *) ellFirst(&psubInfo->patternList))) {
-        ellDelete(&psubInfo->patternList, &ppatternNode->node);
-        free(ppatternNode->var);
-        free(ppatternNode);
-    }
-    psubInfo->isPattern = 0;
+    psubInfo->patternList.clear();
+    psubInfo->isPattern = false;
     EXIT;
 }
 
-static void substituteDestruct(subInfo *psubInfo)
+static void substituteDestruct(subInfo * const psubInfo)
 {
     ENTER;
     freeSubFile(psubInfo);
     freePattern(psubInfo);
-    free(psubInfo);
+    delete(psubInfo);
     EXIT;
 }
 
-static void substituteOpen(subInfo **ppvt, char *substitutionName)
+static void substituteOpen(subInfo **ppvt, const std::string& substitutionName)
 {
     subInfo     *psubInfo;
     subFile     *psubFile;
     FILE        *fp;
 
     ENTER;
-    psubInfo = calloc(1, sizeof(subInfo));
+    psubInfo = new subInfo;
     *ppvt = psubInfo;
-    psubFile = calloc(1, sizeof(subFile));
+    psubFile = new subFile;
     psubInfo->psubFile = psubFile;
-    ellInit(&psubInfo->patternList);
 
-    fp = fopen(substitutionName, "r");
+    fp = fopen(substitutionName.c_str(), "r");
     if (!fp) {
-        fprintf(stderr, "msi: Can't open file '%s'\n", substitutionName);
+        fprintf(stderr, "msi: Can't open file '%s'\n", substitutionName.c_str());
         abortExit(1);
     }
 
@@ -725,7 +684,7 @@ static void substituteOpen(subInfo **ppvt, char *substitutionName)
     EXIT;
 }
 
-static int substituteGetGlobalSet(subInfo *psubInfo)
+static bool substituteGetGlobalSet(subInfo * const psubInfo)
 {
     subFile *psubFile = psubInfo->psubFile;
 
@@ -737,17 +696,16 @@ static int substituteGetGlobalSet(subInfo *psubInfo)
         strcmp(psubFile->string, "global") == 0) {
         subGetNextToken(psubFile);
         EXITD(1);
-        return 1;
+        return true;
     }
 
     EXITD(0);
-    return 0;
+    return false;
 }
 
-static int substituteGetNextSet(subInfo *psubInfo,char **filename)
+static bool substituteGetNextSet(subInfo * const psubInfo,char **filename)
 {
     subFile     *psubFile = psubInfo->psubFile;
-    patternNode *ppatternNode;
 
     ENTER;
     *filename = 0;
@@ -756,7 +714,7 @@ static int substituteGetNextSet(subInfo *psubInfo,char **filename)
 
     if (psubFile->token == tokenEOF) {
         EXITD(0);
-        return 0;
+        return false;
     }
 
     if (psubFile->token == tokenString &&
@@ -764,7 +722,7 @@ static int substituteGetNextSet(subInfo *psubInfo,char **filename)
         size_t len;
 
         STEP("Parsed 'file'");
-        psubInfo->isFile = 1;
+        psubInfo->isFile = true;
         if (subGetNextToken(psubFile) != tokenString) {
             subFileErrPrint(psubFile, "Parse error, expecting a filename");
             abortExit(1);
@@ -799,7 +757,7 @@ static int substituteGetNextSet(subInfo *psubInfo,char **filename)
 
     if (psubFile->token == tokenLBrace) {
         EXITD(1);
-        return 1;
+        return true;
     }
 
     if (psubFile->token == tokenRBrace) {
@@ -815,7 +773,7 @@ static int substituteGetNextSet(subInfo *psubInfo,char **filename)
 
     STEP("Parsed 'pattern'");
     freePattern(psubInfo);
-    psubInfo->isPattern = 1;
+    psubInfo->isPattern = true;
 
     while (subGetNextToken(psubFile) == tokenSeparator);
 
@@ -825,15 +783,13 @@ static int substituteGetNextSet(subInfo *psubInfo,char **filename)
     }
     STEP("Parsed '{'");
 
-    while (1) {
+    while (true) {
         while (subGetNextToken(psubFile) == tokenSeparator);
 
         if (psubFile->token != tokenString)
             break;
 
-        ppatternNode = calloc(1, sizeof(patternNode));
-        ellAdd(&psubInfo->patternList, &ppatternNode->node);
-        ppatternNode->var = epicsStrDup(psubFile->string);
+        psubInfo->patternList.push_back(psubFile->string);
     }
 
     if (psubFile->token != tokenRBrace) {
@@ -843,23 +799,21 @@ static int substituteGetNextSet(subInfo *psubInfo,char **filename)
 
     subGetNextToken(psubFile);
     EXITD(1);
-    return 1;
+    return true;
 }
 
-static char *substituteGetGlobalReplacements(subInfo *psubInfo)
+static const char *substituteGetGlobalReplacements(subInfo * const psubInfo)
 {
     subFile     *psubFile = psubInfo->psubFile;
 
     ENTER;
-    if (psubInfo->macroReplacements)
-        psubInfo->macroReplacements[0] = 0;
-    psubInfo->curLength = 0;
+    psubInfo->macroReplacements.clear();
 
     while (psubFile->token == tokenSeparator)
         subGetNextToken(psubFile);
 
     if (psubFile->token == tokenRBrace && psubInfo->isFile) {
-        psubInfo->isFile = 0;
+        psubInfo->isFile = false;
         free(psubInfo->filename);
         psubInfo->filename = 0;
         freePattern(psubInfo);
@@ -877,12 +831,12 @@ static char *substituteGetGlobalReplacements(subInfo *psubInfo)
         return 0;
     }
 
-    while (1) {
+    while (true) {
         switch(subGetNextToken(psubFile)) {
             case tokenRBrace:
                 subGetNextToken(psubFile);
-                EXITS(psubInfo->macroReplacements);
-                return psubInfo->macroReplacements;
+                EXITS(psubInfo->macroReplacements.c_str());
+                return psubInfo->macroReplacements.c_str();
 
             case tokenSeparator:
                 catMacroReplacements(psubInfo, ",");
@@ -902,21 +856,18 @@ static char *substituteGetGlobalReplacements(subInfo *psubInfo)
     }
 }
 
-static char *substituteGetReplacements(subInfo *psubInfo)
+static const char *substituteGetReplacements(subInfo * const psubInfo)
 {
     subFile     *psubFile = psubInfo->psubFile;
-    patternNode *ppatternNode;
 
     ENTER;
-    if (psubInfo->macroReplacements)
-        psubInfo->macroReplacements[0] = 0;
-    psubInfo->curLength = 0;
+    psubInfo->macroReplacements.clear();
 
     while (psubFile->token == tokenSeparator)
         subGetNextToken(psubFile);
 
     if (psubFile->token==tokenRBrace && psubInfo->isFile) {
-        psubInfo->isFile = 0;
+        psubInfo->isFile = false;
         free(psubInfo->filename);
         psubInfo->filename = 0;
         freePattern(psubInfo);
@@ -936,15 +887,16 @@ static char *substituteGetReplacements(subInfo *psubInfo)
     }
 
     if (psubInfo->isPattern) {
-        int gotFirstPattern = 0;
+        bool gotFirstPattern = false;
 
         while (subGetNextToken(psubFile) == tokenSeparator);
-        ppatternNode = (patternNode *) ellFirst(&psubInfo->patternList);
-        while (1) {
+        std::list<std::string>& patternList = psubInfo->patternList;
+        std::list<std::string>::iterator patternIt = patternList.begin();
+        while (true) {
             if (psubFile->token == tokenRBrace) {
                 subGetNextToken(psubFile);
-                EXITS(psubInfo->macroReplacements);
-                return psubInfo->macroReplacements;
+                EXITS(psubInfo->macroReplacements.c_str());
+                return psubInfo->macroReplacements.c_str();
             }
 
             if (psubFile->token != tokenString) {
@@ -954,13 +906,13 @@ static char *substituteGetReplacements(subInfo *psubInfo)
 
             if (gotFirstPattern)
                 catMacroReplacements(psubInfo, ",");
-            gotFirstPattern = 1;
+            gotFirstPattern = true;
 
-            if (ppatternNode) {
-                catMacroReplacements(psubInfo, ppatternNode->var);
+            if (patternIt != patternList.end()) {
+                catMacroReplacements(psubInfo, patternIt->c_str());
                 catMacroReplacements(psubInfo, "=");
                 catMacroReplacements(psubInfo, psubFile->string);
-                ppatternNode = (patternNode *) ellNext(&ppatternNode->node);
+                ++patternIt;
             }
             else {
                 subFileErrPrint(psubFile, "Warning, too many values given");
@@ -969,12 +921,12 @@ static char *substituteGetReplacements(subInfo *psubInfo)
             while (subGetNextToken(psubFile) == tokenSeparator);
         }
     }
-    else while(1) {
+    else while(true) {
         switch(subGetNextToken(psubFile)) {
             case tokenRBrace:
                 subGetNextToken(psubFile);
-                EXITS(psubInfo->macroReplacements);
-                return psubInfo->macroReplacements;
+                EXITS(psubInfo->macroReplacements.c_str());
+                return psubInfo->macroReplacements.c_str();
 
             case tokenSeparator:
                 catMacroReplacements(psubInfo, ",");
@@ -1017,11 +969,12 @@ static char *subGetNextLine(subFile *psubFile)
     return &psubFile->inputBuffer[0];
 }
 
-static void subFileErrPrint(subFile *psubFile,char * message)
+static void subFileErrPrint(subFile *psubFile, const char * message)
 {
     fprintf(stderr, "msi: %s\n",message);
     fprintf(stderr, "  in substitution file '%s' at line %d:\n  %s",
-        psubFile->substitutionName, psubFile->lineNum, psubFile->inputBuffer);
+            psubFile->substitutionName.c_str(), psubFile->lineNum,
+            psubFile->inputBuffer);
 }
 
 
@@ -1107,32 +1060,8 @@ done:
 
 static void catMacroReplacements(subInfo *psubInfo, const char *value)
 {
-    size_t len = strlen(value);
-
     ENTER;
-    if (psubInfo->size <= (psubInfo->curLength + len)) {
-        size_t newsize = psubInfo->size + MAX_BUFFER_SIZE;
-        char *newbuf;
-
-        STEP("Enlarging buffer");
-        if (newsize <= psubInfo->curLength + len)
-            newsize = psubInfo->curLength + len + 1;
-        newbuf = calloc(1, newsize);
-        if (!newbuf) {
-            fprintf(stderr, "calloc failed for size %lu\n",
-                (unsigned long) newsize);
-            abortExit(1);
-        }
-        if (psubInfo->macroReplacements) {
-            memcpy(newbuf, psubInfo->macroReplacements, psubInfo->curLength);
-            free(psubInfo->macroReplacements);
-        }
-        psubInfo->size = newsize;
-        psubInfo->macroReplacements = newbuf;
-    }
-
     STEPS("Appending", value);
-    strcat(psubInfo->macroReplacements, value);
-    psubInfo->curLength += len;
+    psubInfo->macroReplacements += value;
     EXIT;
 }

src/ioc/dbtemplate/test/msi.plt

@@ -11,7 +11,7 @@
 use strict;
 use Test;
 
-BEGIN {plan tests => 9}
+BEGIN {plan tests => 12}
 
 # Check include/substitute command model
 ok(msi('-I .. ../t1-template.txt'),             slurp('../t1-result.txt'));
@@ -33,16 +33,9 @@ ok(msi('-S../t6-substitute.txt ../t6-template.txt'), slurp('../t6-result.txt'));
 
 # Output option -o and verbose option -V
 my $out = 't7-output.txt';
-my $count = 5; # Try up to 5 times...
-my $result;
-do {
-    unlink $out;
-    msi("-I.. -V -o $out ../t1-template.txt");
-    $result = slurp($out);
-    print "# msi output file empty, retrying\n"
-        if $result eq '';
-} while ($result eq '') && (--$count > 0);
-ok($result, slurp('../t7-result.txt'));
+unlink $out;
+msi("-I.. -V -o $out ../t1-template.txt");
+ok(slurp($out), slurp('../t7-result.txt'));
 
 # Dependency generation, include/substitute model
 ok(msi('-I.. -D -o t8.txt ../t1-template.txt'), slurp('../t8-result.txt'));
@@ -50,6 +43,17 @@ ok(msi('-I.. -D -o t8.txt ../t1-template.txt'), slurp('../t8-result.txt'));
 # Dependency generation, dbLoadTemplate format
 ok(msi('-I.. -D -ot9.txt -S ../t2-substitution.txt'), slurp('../t9-result.txt'));
 
+# Substitution file, variable format, with 0 variable definitions
+ok(msi('-I. -I.. -S ../t10-substitute.txt'), slurp('../t10-result.txt'));
+
+# Substitution file, pattern format, with 0 pattern definitions
+ok(msi('-I. -I.. -S ../t11-substitute.txt'), slurp('../t11-result.txt'));
+
+# Substitution file, environment variable macros in template filename
+my %envs = (TEST_NO => 12, PREFIX => 't');
+@ENV{ keys %envs } = values %envs;
+ok(msi('-I. -I.. -S ../t12-substitute.txt'), slurp('../t12-result.txt'));
+delete @ENV{ keys %envs };  # Not really needed
 
 # Test support routines
 
@@ -63,21 +67,7 @@ sub slurp {
 
 sub msi {
     my ($args) = @_;
-    my $exe = ($^O eq 'MSWin32') || ($^O eq 'cygwin') ? '.exe' : '';
-    my $msi = "./msi-copy$exe";
-    my $result;
-    if ($args =~ m/-o / && $args !~ m/-D/) {
-        # An empty result is expected
-        $result = `$msi $args`;
-    }
-    else {
-        # Try up to 5 times, sometimes msi fails on Windows
-        my $count = 5;
-        do {
-            $result = `$msi $args`;
-            print "# result of '$msi $args' empty, retrying\n"
-                if $result eq '';
-        } while ($result eq '') && (--$count > 0);
-    }
-    return $result;
+    my $nul = ($^O eq 'MSWin32') ? 'NUL' : '/dev/null';
+    my $msi = ($^O eq 'MSWin32') ? 'msi-copy.exe' : './msi-copy';
+    return `$msi $args 2>$nul`;
 }

src/ioc/dbtemplate/test/t10-result.txt

@@ -0,0 +1,4 @@
+# comment line
+a=$(a)
+# comment line
+a=gbl

src/ioc/dbtemplate/test/t10-substitute.txt

@@ -0,0 +1,8 @@
+file t10-template.txt {
+    {}
+}
+
+global { a=gbl }
+file t10-template.txt {
+    {}
+}

src/ioc/dbtemplate/test/t10-template.txt

@@ -0,0 +1,2 @@
+# comment line
+a=$(a)

src/ioc/dbtemplate/test/t11-result.txt

@@ -0,0 +1,4 @@
+# comment line
+a=$(a)
+# comment line
+a=gbl

src/ioc/dbtemplate/test/t11-substitute.txt

@@ -0,0 +1,10 @@
+file t11-template.txt {
+    pattern {}
+    {}
+}
+
+global { a=gbl }
+file t11-template.txt {
+    pattern {}
+    {}
+}

src/ioc/dbtemplate/test/t11-template.txt

@@ -0,0 +1,2 @@
+# comment line
+a=$(a)

src/ioc/dbtemplate/test/t12-result.txt

@@ -0,0 +1,2 @@
+# comment line
+a=foo

src/ioc/dbtemplate/test/t12-substitute.txt

@@ -0,0 +1,3 @@
+file $(PREFIX)$(TEST_NO)-template.txt {
+    { a=foo }
+}

src/ioc/dbtemplate/test/t12-template.txt

@@ -0,0 +1,2 @@
+# comment line
+a=$(a)

src/libCom/RTEMS/rtems_init.c

@@ -581,25 +581,11 @@ Init (rtems_task_argument ignored)
             printf ("***** Can't set time: %s\n", rtems_status_text (sc));
     }
     if (getenv("TZ") == NULL) {
-        const char *tzp = envGetConfigParamPtr(&EPICS_TIMEZONE);
-        if (tzp == NULL) {
-            printf("Warning -- no timezone information available -- times will be displayed as GMT.\n");
-        }
-        else {
-            char tz[10];
-            int minWest, toDst = 0, fromDst = 0;
-            if(sscanf(tzp, "%9[^:]::%d:%d:%d", tz, &minWest, &toDst, &fromDst) < 2) {
-                printf("Warning: EPICS_TIMEZONE (%s) unrecognizable -- times will be displayed as GMT.\n", tzp);
-            }
-            else {
-                char posixTzBuf[40];
-                char *p = posixTzBuf;
-                p += sprintf(p, "%cST%d:%.2d", tz[0], minWest/60, minWest%60);
-                if (toDst != fromDst)
-                    p += sprintf(p, "%cDT", tz[0]);
-                epicsEnvSet("TZ", posixTzBuf);
-            }
-        }
+        const char *tzp = envGetConfigParamPtr(&EPICS_TZ);
+        if (!tzp || *tzp)
+            printf("Warning: No timezone information, times will be displayed in UTC.\n");
+        else
+            epicsEnvSet("TZ", tzp);
     }
     tzset();
     osdTimeRegister();

src/libCom/env/envDefs.h

@@ -61,7 +61,7 @@ epicsShareExtern const ENV_PARAM EPICS_CAS_BEACON_PORT;
 epicsShareExtern const ENV_PARAM EPICS_BUILD_COMPILER_CLASS;
 epicsShareExtern const ENV_PARAM EPICS_BUILD_OS_CLASS;
 epicsShareExtern const ENV_PARAM EPICS_BUILD_TARGET_ARCH;
-epicsShareExtern const ENV_PARAM EPICS_TIMEZONE;
+epicsShareExtern const ENV_PARAM EPICS_TZ;
 epicsShareExtern const ENV_PARAM EPICS_TS_NTP_INET;
 epicsShareExtern const ENV_PARAM EPICS_IOC_LOG_PORT;
 epicsShareExtern const ENV_PARAM EPICS_IOC_LOG_INET;

src/libCom/log/iocLogServer.c

@@ -37,7 +37,7 @@
 
 static unsigned short ioc_log_port;
 static long ioc_log_file_limit;
-static char ioc_log_file_name[256];
+static char ioc_log_file_name[512];
 static char ioc_log_file_command[256];
 
 
@@ -866,7 +866,12 @@ static int setupSIGHUP(struct ioc_log_server *pserver)
  */
 static void sighupHandler(int signo)
 {
-	(void) write(sighupPipe[1], "SIGHUP\n", 7);
+    const char msg[] = "SIGHUP\n";
+    const ssize_t bytesWritten = write(sighupPipe[1], msg, sizeof(msg));
+    if (bytesWritten != sizeof(msg)) {
+        fprintf(stderr, "iocLogServer: failed to write to SIGHUP pipe because "
+                        "`%s'\n", strerror(errno));
+    }
 }
 
 
@@ -884,7 +889,10 @@ static void serviceSighupRequest(void *pParam)
 	/*
 	 * Read and discard message from pipe.
 	 */
-	(void) read(sighupPipe[0], buff, sizeof buff);
+	if (read(sighupPipe[0], buff, sizeof buff) <= 0) {
+        fprintf(stderr, "iocLogServer: failed to read from SIGHUP pipe because "
+                        "`%s'\n", strerror(errno));
+    };
 
 	/*
 	 * Determine new log file name.

src/libCom/osi/Makefile

@@ -77,7 +77,7 @@ Com_SRCS += epicsGeneralTime.c
 
 # Time providers
 Com_SRCS += osiClockTime.c
-Com_SRCS_vxWorks += osiNTPTime.c
+Com_SRCS_vxWorks += osiNTPTime.c tz2timezone.c
 Com_SRCS_RTEMS += osiNTPTime.c
 
 ifeq ($(OS_CLASS),vxWorks)

src/libCom/osi/epicsTime.cpp

@@ -205,9 +205,6 @@ epicsTime::epicsTime (const epicsTimeStamp &ts)
 epicsTime::epicsTime () :
     secPastEpoch(0u), nSec(0u) {}
 
-epicsTime::epicsTime (const epicsTime &t) :
-    secPastEpoch (t.secPastEpoch), nSec (t.nSec) {}
-
 epicsTime epicsTime::getCurrent ()
 {
     epicsTimeStamp current;
@@ -955,7 +952,8 @@ extern "C" {
         try {
             local_tm_nano_sec tmns = epicsTime (*pSrc);
             *pDest = tmns.ansi_tm;
-            *pNSecDest = tmns.nSec;
+            if (pNSecDest)
+                *pNSecDest = tmns.nSec;
         }
         catch (...) {
             return epicsTimeERROR;
@@ -967,7 +965,8 @@ extern "C" {
         try {
             gm_tm_nano_sec gmtmns = epicsTime (*pSrc);
             *pDest = gmtmns.ansi_tm;
-            *pNSecDest = gmtmns.nSec;
+            if (pNSecDest)
+                *pNSecDest = gmtmns.nSec;
         }
         catch (...) {
             return epicsTimeERROR;

src/libCom/osi/epicsTime.h

@@ -81,7 +81,6 @@ public:
     class formatProblemWithStructTM {};
 
     epicsTime ();
-    epicsTime ( const epicsTime & t );
 
     static epicsTime getEvent ( const epicsTimeEvent & );
     static epicsTime getCurrent ();

src/libCom/osi/os/vxWorks/osdSock.h

@@ -65,7 +65,7 @@ typedef int                     SOCKET;
 #define socket_ioctl(A,B,C)     ioctl(A,B,(int)C)
 typedef int osiSockIoctl_t;
 typedef int osiSocklen_t;
-typedef int osiSockOptMcastLoop_t;
+typedef char osiSockOptMcastLoop_t;
 
 #define FD_IN_FDSET(FD) ((FD)<FD_SETSIZE&&(FD)>=0)
 

src/libCom/osi/os/vxWorks/osdTime.cpp

@@ -24,22 +24,38 @@
 
 #define NTP_REQUEST_TIMEOUT 4 /* seconds */
 
+extern "C" {
+    int tz2timezone(void);
+}
+
 static char sntp_sync_task[] = "ipsntps";
 static char ntp_daemon[] = "ipntpd";
 
 static const char *pserverAddr = NULL;
+static CLOCKTIME_SYNCHOOK prevHook;
+
 extern char* sysBootLine;
 
+static void timeSync(int synchronized) {
+    if (!tz2timezone())
+        ClockTime_syncHook = prevHook; /* Don't call me again */
+}
+
 static int timeRegister(void)
 {
-    /* If TIMEZONE not defined, set it from EPICS_TIMEZONE */
-    if (getenv("TIMEZONE") == NULL) {
-        const char *timezone = envGetConfigParamPtr(&EPICS_TIMEZONE);
-        if (timezone == NULL) {
-            printf("timeRegister: No Time Zone Information\n");
-        } else {
-            epicsEnvSet("TIMEZONE", timezone);
+    /* If TZ not defined, set it from EPICS_TZ */
+    if (getenv("TZ") == NULL) {
+        const char *tz = envGetConfigParamPtr(&EPICS_TZ);
+
+        if (tz && *tz) {
+            epicsEnvSet("TZ", tz);
+
+            /* Call tz2timezone() once we know what year it is */
+            prevHook = ClockTime_syncHook;
+            ClockTime_syncHook = timeSync;
         }
+        else if (getenv("TIMEZONE") == NULL)
+            printf("timeRegister: No Time Zone Information available\n");
     }
 
     // Define EPICS_TS_FORCE_NTPTIME to force use of NTPTime provider
@@ -57,7 +73,7 @@ static int timeRegister(void)
     }
 
     if (useNTP) {
-        // Start NTP first so it can be used to sync SysTime
+        // Start NTP first so it can be used to sync ClockTime
         NTPTime_Init(100);
         ClockTime_Init(CLOCKTIME_SYNC);
     } else {

src/libCom/osi/os/vxWorks/tz2timezone.c

@@ -0,0 +1,278 @@
+/*************************************************************************\
+* Copyright (c) 2009 Brookhaven Science Associates, as Operator of
+*     Brookhaven National Laboratory.
+* Copyright (c) 2019 UChicago Argonne LLC, as Operator of Argonne
+*     National Laboratory.
+* EPICS BASE is distributed subject to a Software License Agreement found
+* in file LICENSE that is included with this distribution.
+\*************************************************************************/
+/*
+ * Authors: Larry Hoff, Andrew Johnson <anj@anl.gov>
+ */
+
+/*
+ * This file exports a single function "int tz2timezone(void)" which reads
+ * the TZ environment variable (defined by POSIX) and converts it to the
+ * TIMEZONE environment variable defined by ANSI. The latter is used by
+ * VxWorks "time" functions, is largely deprecated in other computing
+ * environments, has limitations, and is difficult to maintain. This holds
+ * out the possibility of "pretending" that VxWorks supports "TZ" - until
+ * such time as it actually does.
+ *
+ * For simplicity, only the "POSIX standard form" of TZ will be supported.
+ * Even that is complicated enough (see following spec). Furthermore,
+ * only the "M" form of DST start and stop dates are supported.
+ *
+ * TZ = zone[-]offset[dst[offset],start[/time],end[/time]]
+ *
+ * zone
+ *     A three or more letter name for the timezone in normal (winter) time.
+ *
+ * [-]offset
+ *     A signed time giving the offset of the time zone westwards from
+ *     Greenwich. The time has the form hh[:mm[:ss]] with a one of two
+ *     digit hour, and optional two digit minutes and seconds.
+ *
+ * dst
+ *     The name of the time zone when daylight saving is in effect. It may
+ *     be followed by an offset giving how big the adjustment is, required
+ *     if different than the default of 1 hour.
+ *
+ * start/time,end/time
+ *     Specify the start and end of the daylight saving period. The start
+ *     and end fields indicate on what day the changeover occurs, and must
+ *     be in this format:
+ *
+ *     Mm.n.d
+ *         This indicates month m, the n-th occurrence of day d, where
+ *             1 <= m <= 12,  1 <= n <= 5,  0 <= d <= 6, 0=Sunday
+ *         The 5th occurrence means the last occurrence of that day in a
+ *         month. So M4.1.0 is the first Sunday in April, M9.5.0 is the
+ *         last Sunday in September.
+ *
+ *     The time field indicates what hour the changeover occurs on the given
+ *     day (TIMEZONE only supports switching on the hour).
+ *
+ */
+
+#include <vxWorks.h>
+#include <envLib.h>   /* getenv() */
+#include <stdio.h>    /* printf() */
+#include <string.h>   /* strchr() */
+#include <ctype.h>    /* isalpha() */
+
+#include <epicsTime.h>
+
+/* for reference: TZ syntax, example, and TIMEZONE example
+ * std offset dst [offset],start[/time],end[/time]
+ *    CST6CDT5,M3.2.0,M11.1.0
+ *    EST+5EDT,M4.1.0/2,M10.5.0/2
+ *
+ * std <unused> offset start stop
+ *    TIMEZONE=EST::300:030802:110102
+ */
+
+static int extractDate(const char *tz, struct tm *current, char *s)
+{
+    static const int startdays[] = {
+        0, 31, 59, 90, 120, 151, 181, 212, 243, 273, 304, 334
+    };
+    static const int molengths[] = {
+        31, 28, 31, 30, 31, 30, 31, 31, 30, 31, 30, 31
+    };
+
+    int month, week, weekday, hour=2; /* default=2AM */
+    int jan1wday, wday, mday;
+
+    /* Require 'M' format */
+    if (*++tz != 'M') {
+        printf("tz2timezone: Unsupported date type, need 'M' format\n");
+        return ERROR;
+    }
+    tz++;
+
+    if (sscanf(tz, "%d.%d.%d/%d", &month, &week, &weekday, &hour) < 3)
+        return ERROR; /* something important missing */
+
+    if (month == 0 || month>12 ||
+        week < 1 || week > 5 ||
+        weekday < 0 || weekday > 6 ||
+        hour < 0 || hour > 23)
+        return ERROR;
+
+    /* Now for some brute-force calendar calculations... */
+    /* start month is in "month", and the day is "weekday", but
+       we need to know when that weekday first occurs in that month */
+    /* Let's start with weekday on Jan. 1 */
+    jan1wday = (7 + current->tm_wday - (current->tm_yday % 7)) % 7;
+
+    /* We need to know if it is a leap year (and if it matters) */
+    /* Let's assume that we're working with a date between 1901 and 2099,
+       that way we don't have to think about the "century exception".
+       If this code is still running (unchanged) in 2100, I'll be stunned
+       (and 139 years old) */
+    wday = (jan1wday + startdays[month-1] +
+        ((month > 2 && (current->tm_year % 4 == 0)) ? 1 : 0)) % 7;
+
+    /* Let's see on what day-of-the-month the first target weekday occurs
+       (counting from 1). The result is a number between 1 and 7, inclusive. */
+    mday = 1 + ((7 + weekday - wday) % 7);
+
+    /* Next, we add the week offset. If we overflow the month, we subtract
+       one week */
+    mday += 7 * (week - 1);
+    if (mday > molengths[month-1])
+        mday -= 7;
+
+    /* Should I handle Feb 29? I'm willing to gamble that no one in their right
+       mind would schedule a time change to occur on Feb. 29. If so, we'll be a
+       week early */
+    sprintf(s, "%02d%02d%02d", month, mday, hour);
+
+    return OK;
+}
+
+
+static const char *getTime(const char *s, int *time)
+{
+    /* Time format is [+/-]hh[:mm][:ss] followed by the next zone name */
+
+    *time = 0;
+
+    if (!isdigit((int) s[0]))
+        return s; /* no number here... */
+
+    if (!isdigit((int) s[1])) { /* single digit form */
+        *time = s[0] - '0';
+        return s + 1;
+    }
+
+    if (isdigit((int) s[1])) { /* two digit form */
+        *time = 10 * (s[0] - '0') + (s[1] - '0');
+        return s + 2;
+    }
+
+    return s; /* does not follow supported form */
+}
+
+int tz2timezone(void)
+{
+    const char *tz = getenv("TZ");
+    /* Spec. says that zone names must be at least 3 chars.
+     * I've never seen a longer zone name, but I'll allocate
+     * 40 chars. If you live in a zone with a longer name,
+     * you may want to think about the benefits of relocation.
+     */
+    char zone[40];
+    char start[10], stop[10]; /* only really need 7 bytes now */
+    int hours = 0, minutes = 0, sign = 1;
+    /* This is more than enough, even with a 40-char zone
+     * name, and 4-char offset.
+     */
+    char timezone[100];
+    int i = 0; /* You *always need an "i" :-) */
+    epicsTimeStamp now;
+    struct tm current;
+
+    /* First let's get the current time. We need the year to
+     * compute the start/stop dates for DST.
+     */
+    if (epicsTimeGetCurrent(&now) ||
+        epicsTimeToTM(&current, NULL, &now))
+        return ERROR;
+
+    /* Make sure TZ exists.
+     * Spec. says that ZONE must be at least 3 chars.
+     */
+    if ((!tz) || (strlen(tz) < 3))
+        return ERROR;
+
+    /* OK, now a bunch of brute-force parsing. My brain hurts if
+     * I try to think of an elegant regular expression for the
+     * string.
+     */
+
+    /* Start extracting zone name, must be alpha */
+    while ((i < sizeof(zone) - 1) && isalpha((int) *tz)) {
+        zone[i++] = *tz++;
+    }
+    if (i < 3)
+        return ERROR; /* Too short, not a real zone name? */
+
+    zone[i] = 0; /* Nil-terminate (for now) */
+
+    /* Now extract offset time. The format is [+/-]hh[:mm[:ss]]
+     * Recall that TIMEZONE doesn't support seconds....
+     */
+    if (*tz == '-') {
+        sign = -1;
+        tz++;
+    }
+    else if (*tz == '+') {
+        tz++;
+    }
+
+    /* Need a digit now */
+    if (!isdigit((int) *tz))
+        return ERROR;
+
+    /* First get the hours */
+    tz = getTime(tz, &hours);
+    if (hours > 24)
+        return ERROR;
+
+    if (*tz == ':') { /* There is a minutes part */
+        /* Need another digit now */
+        if (!isdigit((int) *++tz))
+            return ERROR;
+
+        /* Extract the minutes */
+        tz = getTime(tz, &minutes);
+        if (minutes > 60)
+            return ERROR;
+
+        /* Skip any seconds part */
+        if (*tz == ':') {
+            int seconds;
+            tz = getTime(tz + 1, &seconds);
+        }
+    }
+
+    /* Extract any DST zone name, must be alpha */
+    if (isalpha((int) *tz)) {
+        zone[i++] = '/'; /* Separate the names */
+
+        while ((i < sizeof(zone) - 1) && isalpha((int) *tz)) {
+            zone[i++] = *tz++;
+        }
+        zone[i] = 0; /* Nil-terminate */
+    }
+
+    minutes += hours * 60;
+    minutes *= sign;
+
+    /* Look for start/stop dates - require neither or both */
+    tz = strchr(tz, ',');
+    if (!tz) {  /* No daylight savings time here */
+        /* Format the env. variable */
+        sprintf(timezone, "TIMEZONE=%s::%d", zone, minutes);
+    }
+    else {
+        if (extractDate(tz, &current, start) != OK)
+            return ERROR;
+
+        tz = strchr(tz + 1, ',');
+        if (!tz)
+            return ERROR;
+        if (extractDate(tz, &current, stop) != OK)
+            return ERROR;
+
+        /* Format the env. variable */
+        sprintf(timezone, "TIMEZONE=%s::%d:%s:%s", zone, minutes, start, stop);
+    }
+
+    /* Make it live! */
+    putenv(timezone);
+
+    return OK;
+}

src/libCom/osi/osiClockTime.c

@@ -23,7 +23,8 @@
 #include "taskwd.h"
 
 #define NSEC_PER_SEC 1000000000
-#define ClockTimeSyncInterval_value 60.0
+#define ClockTimeSyncInterval_initial 1.0
+#define ClockTimeSyncInterval_normal 60.0
 
 
 static struct {
@@ -79,7 +80,7 @@ static void ClockTime_InitOnce(void *pfirst)
 
     ClockTimePvt.loopEvent   = epicsEventMustCreate(epicsEventEmpty);
     ClockTimePvt.lock        = epicsMutexCreate();
-    ClockTimePvt.ClockTimeSyncInterval = 1.0;   /* First sync */
+    ClockTimePvt.ClockTimeSyncInterval = ClockTimeSyncInterval_initial;
 
     epicsAtExit(ClockTime_Shutdown, NULL);
 
@@ -148,6 +149,8 @@ void ClockTime_GetProgramStart(epicsTimeStamp *pDest)
 /* Synchronization thread */
 
 #if defined(vxWorks) || defined(__rtems__)
+CLOCKTIME_SYNCHOOK ClockTime_syncHook = NULL;
+
 static void ClockTimeSync(void *dummy)
 {
     taskwdInsert(0, NULL, NULL);
@@ -179,11 +182,16 @@ static void ClockTimeSync(void *dummy)
             ClockTimePvt.syncTime         = timeNow;
             epicsMutexUnlock(ClockTimePvt.lock);
 
-            ClockTimePvt.ClockTimeSyncInterval = ClockTimeSyncInterval_value;
+            if (ClockTime_syncHook)
+                ClockTime_syncHook(1);
+
+            ClockTimePvt.ClockTimeSyncInterval = ClockTimeSyncInterval_normal;
         }
     }
 
     ClockTimePvt.synchronized = 0;
+    if (ClockTime_syncHook)
+        ClockTime_syncHook(0);
     taskwdRemove(0);
 }
 #endif

src/libCom/osi/osiClockTime.h

@@ -19,6 +19,12 @@ void ClockTime_Init(int synchronize);
 void ClockTime_Shutdown(void *dummy);
 int  ClockTime_Report(int level);
 
+#if defined(vxWorks) || defined(__rtems__)
+typedef void (* CLOCKTIME_SYNCHOOK)(int synchronized);
+
+extern CLOCKTIME_SYNCHOOK ClockTime_syncHook;
+#endif
+
 #ifdef __cplusplus
 }
 #endif

src/libCom/taskwd/taskwd.c

@@ -367,7 +367,7 @@ epicsShareFunc void taskwdShow(int level)
         mCount, tCount, fCount);
     if (level) {
         printf("%16.16s %9s %12s %12s %12s\n",
-            "THREAD NAME", "STATE", "EPICS TID", "CALLBACK", "USR ARG");
+            "THREAD NAME", "STATE", "EPICS TID", "epicsCallback", "USR ARG");
         pt = (struct tNode *)ellFirst(&tList);
         while (pt != NULL) {
             epicsThreadGetName(pt->tid, tName, sizeof(tName));

src/libCom/test/epicsStdlibTest.c

@@ -381,8 +381,14 @@ MAIN(epicsStdlibTest)
 
     testOk(epicsParseFloat("1e-40", &f, NULL) == S_stdlib_underflow,
         "Float '1e-40' => underflow");
+#ifdef vxWorks
+    testTodoBegin("Not detected on VxWorks");
+#endif
     testOk(epicsParseDouble("1e-330", &d, NULL) == S_stdlib_underflow,
         "Double '1e-330' => underflow");
+#ifdef vxWorks
+    testTodoEnd();
+#endif
 
     testOk(epicsScanFloat("1e30", &f) && fabs(f - 1e30) < 1e24,
         "Float '1e30'");

src/std/dev/asSubRecordFunctions.c

@@ -34,7 +34,7 @@
 /* The following is provided for access security*/
 /*It allows a CA client to force access security initialization*/
 
-static void myCallback(CALLBACK *pcallback)
+static void myCallback(epicsCallback *pcallback)
 {
     ASDBCALLBACK	*pasdbcallback = (ASDBCALLBACK *)pcallback;
     subRecord	*precord;

src/std/dev/devAiSoftCallback.c

@@ -36,7 +36,7 @@
 
 typedef struct devPvt {
     processNotify pn;
-    CALLBACK callback;
+    epicsCallback callback;
     long options;
     int status;
     int smooth;

src/std/dev/devBiSoftCallback.c

@@ -35,7 +35,7 @@
 
 typedef struct devPvt {
     processNotify pn;
-    CALLBACK callback;
+    epicsCallback callback;
     long options;
     int status;
     struct {

src/std/dev/devLiSoftCallback.c

@@ -35,7 +35,7 @@
 
 typedef struct devPvt {
     processNotify pn;
-    CALLBACK callback;
+    epicsCallback callback;
     long options;
     int status;
     struct {

src/std/dev/devMbbiDirectSoftCallback.c

@@ -35,7 +35,7 @@
 
 typedef struct devPvt {
     processNotify pn;
-    CALLBACK callback;
+    epicsCallback callback;
     long options;
     int status;
     struct {

src/std/dev/devMbbiSoftCallback.c

@@ -35,7 +35,7 @@
 
 typedef struct devPvt {
     processNotify pn;
-    CALLBACK callback;
+    epicsCallback callback;
     long options;
     int status;
     struct {

src/std/dev/devSiSoftCallback.c

@@ -37,7 +37,7 @@
 typedef struct devPvt {
     DBADDR dbaddr;
     processNotify pn;
-    CALLBACK callback;
+    epicsCallback callback;
     long options;
     int status;
     struct {

src/std/filters/Makefile

@@ -15,6 +15,7 @@ dbRecStd_SRCS += ts.c
 dbRecStd_SRCS += dbnd.c
 dbRecStd_SRCS += arr.c
 dbRecStd_SRCS += sync.c
+dbRecStd_SRCS += decimate.c
 
 HTMLS += filters.html
 

src/std/filters/decimate.c

@@ -0,0 +1,117 @@
+/*************************************************************************\
+* Copyright (c) 2019 UChicago Argonne LLC, as Operator of Argonne
+*     National Laboratory.
+* Copyright (c) 2010 Brookhaven National Laboratory.
+* Copyright (c) 2010 Helmholtz-Zentrum Berlin
+*     fuer Materialien und Energie GmbH.
+* EPICS BASE is distributed subject to a Software License Agreement found
+* in file LICENSE that is included with this distribution.
+\*************************************************************************/
+
+/*
+ *  Authors: Ralph Lange <Ralph.Lange@bessy.de>,
+ *           Andrew Johnson <anj@anl.gov>
+ */
+
+#include <stdio.h>
+
+#include "freeList.h"
+#include "db_field_log.h"
+#include "chfPlugin.h"
+#include "epicsExport.h"
+
+typedef struct myStruct {
+    epicsInt32 n, i;
+} myStruct;
+
+static void *myStructFreeList;
+
+static const
+chfPluginArgDef opts[] = {
+    chfInt32(myStruct, n, "n", 1, 0),
+    chfPluginArgEnd
+};
+
+static void * allocPvt(void)
+{
+    myStruct *my = (myStruct*) freeListCalloc(myStructFreeList);
+    return (void *) my;
+}
+
+static void freePvt(void *pvt)
+{
+    freeListFree(myStructFreeList, pvt);
+}
+
+static int parse_ok(void *pvt)
+{
+    myStruct *my = (myStruct*) pvt;
+
+    if (my->n < 1)
+        return -1;
+
+    return 0;
+}
+
+static db_field_log* filter(void* pvt, dbChannel *chan, db_field_log *pfl) {
+    db_field_log *passfl = NULL;
+    myStruct *my = (myStruct*) pvt;
+    epicsInt32 i = my->i;
+
+    if (pfl->ctx == dbfl_context_read)
+        return pfl;
+
+    if (i++ == 0)
+        passfl = pfl;
+    else
+        db_delete_field_log(pfl);
+
+    if (i >= my->n)
+        i = 0;
+
+    my->i = i;
+    return passfl;
+}
+
+static void channelRegisterPre(dbChannel *chan, void *pvt,
+                               chPostEventFunc **cb_out, void **arg_out, db_field_log *probe)
+{
+    *cb_out = filter;
+    *arg_out = pvt;
+}
+
+static void channel_report(dbChannel *chan, void *pvt, int level, const unsigned short indent)
+{
+    myStruct *my = (myStruct*) pvt;
+    printf("%*sDecimate (dec): n=%d, i=%d\n", indent, "",
+           my->n, my->i);
+}
+
+static chfPluginIf pif = {
+    allocPvt,
+    freePvt,
+
+    NULL, /* parse_error, */
+    parse_ok,
+
+    NULL, /* channel_open, */
+    channelRegisterPre,
+    NULL, /* channelRegisterPost, */
+    channel_report,
+    NULL /* channel_close */
+};
+
+static void decInitialize(void)
+{
+    static int firstTime = 1;
+
+    if (!firstTime) return;
+    firstTime = 0;
+
+    if (!myStructFreeList)
+        freeListInitPvt(&myStructFreeList, sizeof(myStruct), 64);
+
+    chfPluginRegister("dec", &pif, opts);
+}
+
+epicsExportRegistrar(decInitialize);

src/std/filters/filters.dbd.pod

@@ -14,6 +14,8 @@ The following filters are available in this release:
 
 =item * L<Synchronize|/"Synchronize Filter sync">
 
+=item * L<Decimation|/"Decimation Filter dec">
+
 =back
 
 =head2 Using Filters
@@ -241,7 +243,45 @@ Assuming there is a system state called "blue", that is being controlled by
 some other facility such as a timing system, updates could be restricted to
 periods only when "blue" is true by using
 
- Hal$ camonitor 'test:channel' 'test:channel.{"while":"blue"}'
+ Hal$ camonitor 'test:channel' 'test:channel.{"sync":{"while":"blue"}}'
+ ...
+
+=cut
+
+registrar(decInitialize)
+
+=head3 Decimation Filter C<"dec">
+
+This filter is used to reduce the number or rate of monitor updates from a
+channel by an integer factor C<n> that is provided as a filter argument,
+discarding the other updates. A true decimation following the original meaning
+of the word would be achieved by giving C<n> as 10, to only allow every tenth
+update through.
+
+=head4 Parameters
+
+=over
+
+=item Number C<"n">
+
+The decimation factor, a positive integer. Giving n=1 is equivalent to a no-op
+that allows all updates to be passed to the client.
+
+=back
+
+This filter is intentionally very simplistic. It passes on the first monitor
+event that it sees after the channel connects, then discards the next N-1 events
+before sending the next event. If several clients connect to a channel using the
+same filter settings they may see completely different data streams since each
+client gets its own instance of the filter whose event counter starts when that
+client connects.
+
+=head4 Example
+
+To sample a 60Hz channel at 1Hz, a 10Hz channel every 6 seconds or a 1Hz channel
+once every minute:
+
+ Hal$ camonitor 'test:channel' 'test:channel.{"dec":{"n":60}}'
  ...
 
 =cut

src/std/filters/sync.c

@@ -109,7 +109,9 @@ static db_field_log* filter(void* pvt, dbChannel *chan, db_field_log *pfl) {
             passfl = pfl;
             pfl = NULL;
         }
-        break;
+        else
+            db_delete_field_log(pfl);
+        goto save_state;
     case syncModeLast:
         if (!actstate && my->laststate) {
             passfl = my->lastfl;
@@ -121,28 +123,34 @@ static db_field_log* filter(void* pvt, dbChannel *chan, db_field_log *pfl) {
             passfl = pfl;
             pfl = NULL;
         }
-        break;
+        else
+            db_delete_field_log(pfl);
+        goto save_state;
     case syncModeWhile:
-        if (actstate) {
+        if (actstate)
             passfl = pfl;
-        }
+        else
+            db_delete_field_log(pfl);
         goto no_shift;
     case syncModeUnless:
-        if (!actstate) {
+        if (!actstate)
             passfl = pfl;
-        }
+        else
+            db_delete_field_log(pfl);
         goto no_shift;
     }
 
     if (my->lastfl)
         db_delete_field_log(my->lastfl);
     my->lastfl = pfl;
-    my->laststate = actstate;
 
     /* since no copy is made we can't keep a reference to the returned fl */
     assert(my->lastfl != passfl);
 
-    no_shift:
+save_state:
+    my->laststate = actstate;
+
+no_shift:
     return passfl;
 }
 

src/std/filters/test/Makefile

@@ -56,6 +56,12 @@ syncTest_SRCS += filterTest_registerRecordDeviceDriver.cpp
 testHarness_SRCS += syncTest.c
 TESTS += syncTest
 
+TESTPROD_HOST += decTest
+decTest_SRCS += decTest.c
+decTest_SRCS += filterTest_registerRecordDeviceDriver.cpp
+testHarness_SRCS += decTest.c
+TESTS += decTest
+
 # epicsRunFilterTests runs all the test programs in a known working order.
 testHarness_SRCS += epicsRunFilterTests.c
 

src/std/filters/test/dbndTest.c

@@ -39,12 +39,14 @@ static int fl_equal(const db_field_log *pfl1, const db_field_log *pfl2) {
 static void fl_setup(dbChannel *chan, db_field_log *pfl) {
     struct dbCommon  *prec = dbChannelRecord(chan);
 
+    memset(pfl, 0, sizeof(db_field_log));
     pfl->ctx  = dbfl_context_read;
     pfl->type = dbfl_type_val;
     pfl->stat = prec->stat;
     pfl->sevr = prec->sevr;
     pfl->time = prec->time;
     pfl->field_type  = dbChannelFieldType(chan);
+    pfl->field_size  = dbChannelFieldSize(chan);
     pfl->no_elements = dbChannelElements(chan);
     /*
      * use memcpy to avoid a bus error on
@@ -62,6 +64,7 @@ static void changeValue(db_field_log *pfl2, long val) {
 }
 
 static void mustPassOnce(dbChannel *pch, db_field_log *pfl2, char* m, double d, long val) {
+    int oldFree = db_available_logs(), newFree;
     db_field_log *pfl;
 
     changeValue(pfl2, val);
@@ -71,18 +74,26 @@ static void mustPassOnce(dbChannel *pch, db_field_log *pfl2, char* m, double d,
     testOk(fl_equal(pfl, pfl2), "call 1 does not change field_log data");
     pfl = dbChannelRunPreChain(pch, pfl2);
     testOk(NULL == pfl, "call 2 drops field_log");
+    newFree = db_available_logs();
+    testOk(newFree == oldFree + 1, "field_log was freed - %d+1 => %d",
+        oldFree, newFree);
 }
 
 static void mustDrop(dbChannel *pch, db_field_log *pfl2, char* m, double d, long val) {
+    int oldFree = db_available_logs(), newFree;
     db_field_log *pfl;
 
     changeValue(pfl2, val);
     testDiag("mode=%s delta=%g filter must drop", m, d);
     pfl = dbChannelRunPreChain(pch, pfl2);
     testOk(NULL == pfl, "call 1 drops field_log");
+    newFree = db_available_logs();
+    testOk(newFree == oldFree + 1, "field_log was freed - %d+1 => %d",
+        oldFree, newFree);
 }
 
 static void mustPassTwice(dbChannel *pch, db_field_log *pfl2, char* m, double d, long val) {
+    int oldFree = db_available_logs(), newFree;
     db_field_log *pfl;
 
     changeValue(pfl2, val);
@@ -93,6 +104,9 @@ static void mustPassTwice(dbChannel *pch, db_field_log *pfl2, char* m, double d,
     pfl = dbChannelRunPreChain(pch, pfl2);
     testOk(pfl2 == pfl, "call 2 does not drop or replace field_log");
     testOk(fl_equal(pfl, pfl2), "call 2 does not change field_log data");
+    newFree = db_available_logs();
+    testOk(newFree == oldFree, "field_log was not freed - %d => %d",
+        oldFree, newFree);
 }
 
 static void testHead (char* title) {
@@ -113,8 +127,9 @@ MAIN(dbndTest)
     db_field_log *pfl2;
     db_field_log fl1;
     dbEventCtx evtctx;
+    int logsFree, logsFinal;
 
-    testPlan(59);
+    testPlan(77);
 
     testdbPrepare();
 
@@ -135,6 +150,11 @@ MAIN(dbndTest)
     testOk(!!(pch = dbChannelCreate("x.VAL{\"dbnd\":{}}")), "dbChannel with plugin dbnd (delta=0) created");
     testOk((ellCount(&pch->filters) == 1), "channel has one plugin");
 
+    /* Start the free-list */
+    db_delete_field_log(db_create_read_log(pch));
+    logsFree = db_available_logs();
+    testDiag("%d field_logs on free-list", logsFree);
+
     memset(&fl, PATTERN, sizeof(fl));
     fl1 = fl;
     node = ellFirst(&pch->filters);
@@ -176,6 +196,8 @@ MAIN(dbndTest)
 
     dbChannelDelete(pch);
 
+    testDiag("%d field_logs on free-list", db_available_logs());
+
     /* Delta = -1: pass any update */
 
     testHead("Delta = -1: pass any update");
@@ -192,6 +214,8 @@ MAIN(dbndTest)
     db_delete_field_log(pfl2);
     dbChannelDelete(pch);
 
+    testDiag("%d field_logs on free-list", db_available_logs());
+
     /* Delta = absolute */
 
     testHead("Delta = absolute");
@@ -224,6 +248,8 @@ MAIN(dbndTest)
 
     dbChannelDelete(pch);
 
+    testDiag("%d field_logs on free-list", db_available_logs());
+
     /* Delta = relative */
 
     testHead("Delta = relative");
@@ -275,6 +301,9 @@ MAIN(dbndTest)
 
     dbChannelDelete(pch);
 
+    logsFinal = db_available_logs();
+    testOk(logsFree == logsFinal, "%d field_logs on free-list", logsFinal);
+
     db_close_events(evtctx);
 
     testIocShutdownOk();

src/std/filters/test/decTest.c

@@ -0,0 +1,289 @@
+/*************************************************************************\
+* Copyright (c) 2019 UChicago Argonne LLC, as Operator of Argonne
+*     National Laboratory.
+* Copyright (c) 2010 Brookhaven National Laboratory.
+* Copyright (c) 2010 Helmholtz-Zentrum Berlin
+*     fuer Materialien und Energie GmbH.
+* EPICS BASE is distributed subject to a Software License Agreement found
+* in file LICENSE that is included with this distribution.
+\*************************************************************************/
+
+/*
+ *  Authors: Ralph Lange <Ralph.Lange@bessy.de>,
+ *           Andrew Johnson <anj@anl.gov>
+ */
+
+#include <string.h>
+
+#include "dbStaticLib.h"
+#include "dbAccessDefs.h"
+#include "db_field_log.h"
+#include "dbCommon.h"
+#include "dbChannel.h"
+#include "registry.h"
+#include "chfPlugin.h"
+#include "errlog.h"
+#include "dbmf.h"
+#include "epicsUnitTest.h"
+#include "dbUnitTest.h"
+#include "epicsTime.h"
+#include "testMain.h"
+#include "osiFileName.h"
+
+void filterTest_registerRecordDeviceDriver(struct dbBase *);
+
+static int fl_equal(const db_field_log *pfl1, const db_field_log *pfl2) {
+    return !(memcmp(pfl1, pfl2, sizeof(db_field_log)));
+}
+
+static void fl_setup(dbChannel *chan, db_field_log *pfl, long val) {
+    struct dbCommon  *prec = dbChannelRecord(chan);
+
+    memset(pfl, 0, sizeof(db_field_log));
+    pfl->ctx  = dbfl_context_event;
+    pfl->type = dbfl_type_val;
+    pfl->stat = prec->stat;
+    pfl->sevr = prec->sevr;
+    pfl->time = prec->time;
+    pfl->field_type  = DBF_LONG;
+    pfl->field_size  = sizeof(epicsInt32);
+    pfl->no_elements = 1;
+    /*
+     * use memcpy to avoid a bus error on
+     * union copy of char in the db at an odd
+     * address
+     */
+    memcpy(&pfl->u.v.field,
+           dbChannelField(chan),
+           dbChannelFieldSize(chan));
+    pfl->u.v.field.dbf_long = val;
+}
+
+static void testHead (char* title) {
+    testDiag("--------------------------------------------------------");
+    testDiag("%s", title);
+    testDiag("--------------------------------------------------------");
+}
+
+static void mustDrop(dbChannel *pch, db_field_log *pfl, char* m) {
+    int oldFree = db_available_logs();
+    db_field_log *pfl2 = dbChannelRunPreChain(pch, pfl);
+    int newFree = db_available_logs();
+
+    testOk(NULL == pfl2, "filter drops field_log (%s)", m);
+    testOk(newFree == oldFree + 1, "field_log was freed - %d+1 => %d",
+        oldFree, newFree);
+
+    db_delete_field_log(pfl2);
+}
+
+static void mustPass(dbChannel *pch, db_field_log *pfl, char* m) {
+    int oldFree = db_available_logs();
+    db_field_log *pfl2 = dbChannelRunPreChain(pch, pfl);
+    int newFree = db_available_logs();
+
+    testOk(pfl == pfl2, "filter passes field_log (%s)", m);
+    testOk(newFree == oldFree, "field_log was not freed - %d => %d",
+        oldFree, newFree);
+
+    db_delete_field_log(pfl2);
+}
+
+static void checkAndOpenChannel(dbChannel *pch, const chFilterPlugin *plug) {
+    ELLNODE *node;
+    chFilter *filter;
+    chPostEventFunc *cb_out = NULL;
+    void *arg_out = NULL;
+    db_field_log fl, fl1;
+
+    testDiag("Test filter structure and open channel");
+
+    testOk((ellCount(&pch->filters) == 1), "channel has one plugin");
+
+    fl_setup(pch, &fl, 1);
+    fl1 = fl;
+    node = ellFirst(&pch->filters);
+    filter = CONTAINER(node, chFilter, list_node);
+    plug->fif->channel_register_pre(filter, &cb_out, &arg_out, &fl1);
+    testOk(cb_out && arg_out,
+        "register_pre registers one filter with argument");
+    testOk(fl_equal(&fl1, &fl),
+        "register_pre does not change field_log data type");
+
+    testOk(!(dbChannelOpen(pch)), "dbChannel with plugin dec opened");
+    node = ellFirst(&pch->pre_chain);
+    filter = CONTAINER(node, chFilter, pre_node);
+    testOk((ellCount(&pch->pre_chain) == 1 && filter->pre_arg != NULL),
+        "dec has one filter with argument in pre chain");
+    testOk((ellCount(&pch->post_chain) == 0),
+        "sync has no filter in post chain");
+}
+
+MAIN(decTest)
+{
+    dbChannel *pch;
+    const chFilterPlugin *plug;
+    char myname[] = "dec";
+    db_field_log *pfl[10];
+    int i, logsFree, logsFinal;
+    dbEventCtx evtctx;
+
+    testPlan(104);
+
+    testdbPrepare();
+
+    testdbReadDatabase("filterTest.dbd", NULL, NULL);
+
+    filterTest_registerRecordDeviceDriver(pdbbase);
+
+    testdbReadDatabase("xRecord.db", NULL, NULL);
+
+    eltc(0);
+    testIocInitOk();
+    eltc(1);
+
+    evtctx = db_init_events();
+
+    testOk(!!(plug = dbFindFilter(myname, strlen(myname))),
+        "plugin '%s' registered correctly", myname);
+
+    /* N < 1 */
+    testOk(!(pch = dbChannelCreate("x.VAL{\"dec\":{\"n\":-1}}")),
+           "dbChannel with dec (n=-1) failed");
+    testOk(!(pch = dbChannelCreate("x.VAL{\"dec\":{\"n\":0}}")),
+           "dbChannel with dec (n=0) failed");
+    /* Bad parms */
+    testOk(!(pch = dbChannelCreate("x.VAL{\"dec\":{}}")),
+           "dbChannel with dec (no parm) failed");
+    testOk(!(pch = dbChannelCreate("x.VAL{\"dec\":{\"x\":true}}")),
+           "dbChannel with dec (x=true) failed");
+
+    /* No Decimation (N=1) */
+
+    testHead("No Decimation (n=1)");
+    testOk(!!(pch = dbChannelCreate("x.VAL{\"dec\":{\"n\":1}}")),
+           "dbChannel with plugin dec (n=1) created");
+
+    /* Start the free-list */
+    db_delete_field_log(db_create_read_log(pch));
+    logsFree = db_available_logs();
+    testDiag("%d field_logs on free-list", logsFree);
+
+    checkAndOpenChannel(pch, plug);
+
+    for (i = 0; i < 5; i++) {
+        pfl[i] = db_create_read_log(pch);
+        fl_setup(pch, pfl[i], 10 + i);
+    }
+
+    testDiag("Test event stream");
+
+    mustPass(pch, pfl[0], "i=0");
+    mustPass(pch, pfl[1], "i=1");
+    mustPass(pch, pfl[2], "i=2");
+    mustPass(pch, pfl[3], "i=3");
+    mustPass(pch, pfl[4], "i=4");
+
+    dbChannelDelete(pch);
+
+    testDiag("%d field_logs on free-list", db_available_logs());
+
+    /* Decimation (N=2) */
+
+    testHead("Decimation (n=2)");
+    testOk(!!(pch = dbChannelCreate("x.VAL{\"dec\":{\"n\":2}}")),
+           "dbChannel with plugin dec (n=2) created");
+
+    checkAndOpenChannel(pch, plug);
+
+    for (i = 0; i < 10; i++) {
+        pfl[i] = db_create_read_log(pch);
+        fl_setup(pch, pfl[i], 20 + i);
+    }
+
+    testDiag("Test event stream");
+
+    mustPass(pch, pfl[0], "i=0");
+    mustDrop(pch, pfl[1], "i=1");
+    mustPass(pch, pfl[2], "i=2");
+    mustDrop(pch, pfl[3], "i=3");
+    mustPass(pch, pfl[4], "i=4");
+    mustDrop(pch, pfl[5], "i=5");
+    mustPass(pch, pfl[6], "i=6");
+    mustDrop(pch, pfl[7], "i=7");
+    mustPass(pch, pfl[8], "i=8");
+    mustDrop(pch, pfl[9], "i=9");
+
+    dbChannelDelete(pch);
+
+    testDiag("%d field_logs on free-list", db_available_logs());
+
+    /* Decimation (N=3) */
+
+    testHead("Decimation (n=3)");
+    testOk(!!(pch = dbChannelCreate("x.VAL{\"dec\":{\"n\":3}}")),
+           "dbChannel with plugin dec (n=3) created");
+
+    checkAndOpenChannel(pch, plug);
+
+    for (i = 0; i < 10; i++) {
+        pfl[i] = db_create_read_log(pch);
+        fl_setup(pch, pfl[i], 30 + i);
+    }
+
+    testDiag("Test event stream");
+
+    mustPass(pch, pfl[0], "i=0");
+    mustDrop(pch, pfl[1], "i=1");
+    mustDrop(pch, pfl[2], "i=2");
+    mustPass(pch, pfl[3], "i=3");
+    mustDrop(pch, pfl[4], "i=4");
+    mustDrop(pch, pfl[5], "i=5");
+    mustPass(pch, pfl[6], "i=6");
+    mustDrop(pch, pfl[7], "i=7");
+    mustDrop(pch, pfl[8], "i=8");
+    mustPass(pch, pfl[9], "i=9");
+
+    dbChannelDelete(pch);
+
+    testDiag("%d field_logs on free-list", db_available_logs());
+
+    /* Decimation (N=4) */
+
+    testHead("Decimation (n=4)");
+    testOk(!!(pch = dbChannelCreate("x.VAL{\"dec\":{\"n\":4}}")),
+           "dbChannel with plugin dec (n=4) created");
+
+    checkAndOpenChannel(pch, plug);
+
+    for (i = 0; i < 10; i++) {
+        pfl[i] = db_create_read_log(pch);
+        fl_setup(pch, pfl[i], 40 + i);
+    }
+
+    testDiag("Test event stream");
+
+    mustPass(pch, pfl[0], "i=0");
+    mustDrop(pch, pfl[1], "i=1");
+    mustDrop(pch, pfl[2], "i=2");
+    mustDrop(pch, pfl[3], "i=3");
+    mustPass(pch, pfl[4], "i=4");
+    mustDrop(pch, pfl[5], "i=5");
+    mustDrop(pch, pfl[6], "i=6");
+    mustDrop(pch, pfl[7], "i=7");
+    mustPass(pch, pfl[8], "i=8");
+    mustDrop(pch, pfl[9], "i=9");
+
+    dbChannelDelete(pch);
+
+    logsFinal = db_available_logs();
+    testOk(logsFree == logsFinal, "%d field_logs on free-list", logsFinal);
+
+    db_close_events(evtctx);
+
+    testIocShutdownOk();
+
+    testdbCleanup();
+
+    return testDone();
+}

src/std/filters/test/epicsRunFilterTests.c

@@ -17,6 +17,7 @@ int tsTest(void);
 int dbndTest(void);
 int syncTest(void);
 int arrTest(void);
+int decTest(void);
 
 void epicsRunFilterTests(void)
 {
@@ -26,6 +27,7 @@ void epicsRunFilterTests(void)
     runTest(dbndTest);
     runTest(syncTest);
     runTest(arrTest);
+    runTest(decTest);
 
     dbmfFreeChunks();
 

src/std/filters/test/syncTest.c

@@ -42,12 +42,14 @@ static int fl_equal(const db_field_log *pfl1, const db_field_log *pfl2) {
 static void fl_setup(dbChannel *chan, db_field_log *pfl, long val) {
     struct dbCommon  *prec = dbChannelRecord(chan);
 
+    memset(pfl, 0, sizeof(db_field_log));
     pfl->ctx  = dbfl_context_event;
     pfl->type = dbfl_type_val;
     pfl->stat = prec->stat;
     pfl->sevr = prec->sevr;
     pfl->time = prec->time;
     pfl->field_type  = DBF_LONG;
+    pfl->field_size  = sizeof(epicsInt32);
     pfl->no_elements = 1;
     /*
      * use memcpy to avoid a bus error on
@@ -66,31 +68,92 @@ static void testHead (char* title) {
     testDiag("--------------------------------------------------------");
 }
 
-static void mustDrop(dbChannel *pch, db_field_log *pfl2, char* m) {
-    db_field_log *pfl = dbChannelRunPreChain(pch, pfl2);
-    testOk(NULL == pfl, "filter drops field_log (%s)", m);
+/*
+ * Use mustDrop() and mustPass() to test filters with no memory
+ * of previous field_log pointers.
+ */
+static void mustDrop(dbChannel *pch, db_field_log *pfl, char* m) {
+    int oldFree = db_available_logs();
+    db_field_log *pfl2 = dbChannelRunPreChain(pch, pfl);
+    int newFree = db_available_logs();
+
+    testOk(NULL == pfl2, "filter drops field_log (%s)", m);
+    testOk(newFree == oldFree + 1, "a field_log was freed - %d+1 => %d",
+        oldFree, newFree);
+
+    db_delete_field_log(pfl2);
 }
 
-static void mustPassTwice(dbChannel *pch, db_field_log *pfl2, char* m) {
-    db_field_log *pfl;
+static void mustPass(dbChannel *pch, db_field_log *pfl, char* m) {
+    int oldFree = db_available_logs();
+    db_field_log *pfl2 = dbChannelRunPreChain(pch, pfl);
+    int newFree = db_available_logs();
+
+    testOk(pfl == pfl2, "filter passes field_log (%s)", m);
+    testOk(newFree == oldFree, "no field_logs were freed - %d => %d",
+        oldFree, newFree);
+
+    db_delete_field_log(pfl2);
+}
+
+/*
+ * Use mustStash() and mustSwap() to test filters that save
+ * field_log pointers and return them later.
+ *
+ * mustStash() expects the filter to save the current pointer
+ *      (freeing any previously saved pointer) and return NULL.
+ * mustSwap() expects the filter to return the previously
+ *      saved pointer and save the current pointer.
+ */
+static db_field_log *stashed;
+
+static void streamReset(void) {
+    stashed = NULL;
+}
+
+static void mustStash(dbChannel *pch, db_field_log *pfl, char* m) {
+    int oldFree = db_available_logs();
+    db_field_log *pfl2 = dbChannelRunPreChain(pch, pfl);
+    int newFree = db_available_logs();
+
+    testOk(NULL == pfl2, "filter stashes field_log (%s)", m);
+    if (stashed) {
+        testOk(newFree == oldFree + 1, "a field_log was freed - %d+1 => %d",
+            oldFree, newFree);
+    }
+    else {
+        testOk(newFree == oldFree, "no field_logs were freed - %d => %d",
+            oldFree, newFree);
+    }
+    stashed = pfl;
+    db_delete_field_log(pfl2);
+}
+
+static void mustSwap(dbChannel *pch, db_field_log *pfl, char* m) {
+    int oldFree = db_available_logs();
+    db_field_log *pfl2 = dbChannelRunPreChain(pch, pfl);
+    int newFree = db_available_logs();
+
+    testOk(stashed == pfl2, "filter returns stashed field log (%s)", m);
+    testOk(newFree == oldFree, "no field_logs were freed - %d => %d",
+        oldFree, newFree);
+
+    stashed = pfl;
+    db_delete_field_log(pfl2);
+}
+
+static void mustPassTwice(dbChannel *pch, db_field_log *pfl, char* m) {
+    int oldFree = db_available_logs(), newFree;
+    db_field_log *pfl2;
 
     testDiag("%s: filter must pass twice", m);
-    pfl = dbChannelRunPreChain(pch, pfl2);
+    pfl2 = dbChannelRunPreChain(pch, pfl);
     testOk(pfl2 == pfl, "call 1 does not drop or replace field_log");
-    pfl = dbChannelRunPreChain(pch, pfl2);
+    pfl2 = dbChannelRunPreChain(pch, pfl);
     testOk(pfl2 == pfl, "call 2 does not drop or replace field_log");
-}
-
-static void mustPassOld(dbChannel *pch, db_field_log *old, db_field_log *cur, char* m) {
-    db_field_log *pfl = dbChannelRunPreChain(pch, cur);
-
-    testOk(old == pfl, "filter passes previous field log (%s)", m);
-}
-
-static void mustPass(dbChannel *pch, db_field_log *cur, char* m) {
-    db_field_log *pfl = dbChannelRunPreChain(pch, cur);
-
-    testOk(cur == pfl, "filter passes field_log (%s)", m);
+    newFree = db_available_logs();
+    testOk(newFree == oldFree, "no field_logs were freed - %d => %d",
+        oldFree, newFree);
 }
 
 static void checkCtxRead(dbChannel *pch, dbStateId id) {
@@ -138,10 +201,10 @@ MAIN(syncTest)
     const chFilterPlugin *plug;
     char myname[] = "sync";
     db_field_log *pfl[10];
-    int i;
+    int i, logsFree, logsFinal;
     dbEventCtx evtctx;
 
-    testPlan(139);
+    testPlan(214);
 
     testdbPrepare();
 
@@ -176,9 +239,14 @@ MAIN(syncTest)
     testOk(!!(pch = dbChannelCreate("x.VAL{\"sync\":{\"m\":\"while\",\"s\":\"red\"}}")),
            "dbChannel with plugin sync (m='while' s='red') created");
 
+    /* Start the free-list */
+    db_delete_field_log(db_create_read_log(pch));
+    logsFree = db_available_logs();
+    testDiag("%d field_logs on free-list", logsFree);
+
     checkAndOpenChannel(pch, plug);
 
-    for (i = 0; i < 10; i++) {
+    for (i = 0; i < 9; i++) {
         pfl[i] = db_create_read_log(pch);
         fl_setup(pch, pfl[i], 120 + i);
     }
@@ -198,11 +266,10 @@ MAIN(syncTest)
     mustDrop(pch, pfl[7], "state=FALSE, log7");
     mustDrop(pch, pfl[8], "state=FALSE, log8");
 
-    for (i = 0; i < 10; i++)
-        db_delete_field_log(pfl[i]);
-
     dbChannelDelete(pch);
 
+    testDiag("%d field_logs on free-list", db_available_logs());
+
     /* mode UNLESS */
 
     testHead("Mode UNLESS  (m='unless', s='red')");
@@ -211,7 +278,7 @@ MAIN(syncTest)
 
     checkAndOpenChannel(pch, plug);
 
-    for (i = 0; i < 10; i++) {
+    for (i = 0; i < 9; i++) {
         pfl[i] = db_create_read_log(pch);
         fl_setup(pch, pfl[i], 120 + i);
     }
@@ -231,11 +298,10 @@ MAIN(syncTest)
     mustPass(pch, pfl[7], "state=FALSE, log7");
     mustPass(pch, pfl[8], "state=FALSE, log8");
 
-    for (i = 0; i < 10; i++)
-        db_delete_field_log(pfl[i]);
-
     dbChannelDelete(pch);
 
+    testDiag("%d field_logs on free-list", db_available_logs());
+
     /* mode BEFORE */
 
     testHead("Mode BEFORE  (m='before', s='red')");
@@ -251,24 +317,25 @@ MAIN(syncTest)
 
     testDiag("Test event stream");
 
+    streamReset();
     dbStateClear(red);
-    mustDrop(pch, pfl[0], "state=FALSE, log0");
-    mustDrop(pch, pfl[1], "state=FALSE, log1");
-    mustDrop(pch, pfl[2], "state=FALSE, log2");
+    mustStash(pch, pfl[0], "state=FALSE, log0");
+    mustStash(pch, pfl[1], "state=FALSE, log1");
+    mustStash(pch, pfl[2], "state=FALSE, log2");
     dbStateSet(red);
-    mustPassOld(pch, pfl[2], pfl[3], "state=TRUE, log3, pass=log2");
-    mustDrop(pch, pfl[4], "state=TRUE, log4");
-    mustDrop(pch, pfl[5], "state=TRUE, log5");
-    mustDrop(pch, pfl[6], "state=TRUE, log6");
+    mustSwap(pch, pfl[3], "state=TRUE, log3");
+    mustStash(pch, pfl[4], "state=TRUE, log4");
+    mustStash(pch, pfl[5], "state=TRUE, log5");
+    mustStash(pch, pfl[6], "state=TRUE, log6");
     dbStateClear(red);
-    mustDrop(pch, pfl[7], "state=FALSE, log7");
-    mustDrop(pch, pfl[8], "state=FALSE, log8");
-    mustDrop(pch, pfl[9], "state=FALSE, log9");
-
-    db_delete_field_log(pfl[2]);
+    mustStash(pch, pfl[7], "state=FALSE, log7");
+    mustStash(pch, pfl[8], "state=FALSE, log8");
+    mustStash(pch, pfl[9], "state=FALSE, log9");
 
     dbChannelDelete(pch);
 
+    testDiag("%d field_logs on free-list", db_available_logs());
+
     /* mode FIRST */
 
     testHead("Mode FIRST  (m='first', s='red')");
@@ -277,13 +344,14 @@ MAIN(syncTest)
 
     checkAndOpenChannel(pch, plug);
 
-    for (i = 0; i < 10; i++) {
+    for (i = 0; i < 9; i++) {
         pfl[i] = db_create_read_log(pch);
         fl_setup(pch, pfl[i], 120 + i);
     }
 
     testDiag("Test event stream");
 
+    streamReset();
     dbStateClear(red);
     mustDrop(pch, pfl[0], "state=FALSE, log0");
     mustDrop(pch, pfl[1], "state=FALSE, log1");
@@ -297,11 +365,10 @@ MAIN(syncTest)
     mustDrop(pch, pfl[7], "state=FALSE, log7");
     mustDrop(pch, pfl[8], "state=FALSE, log8");
 
-    db_delete_field_log(pfl[3]);
-    db_delete_field_log(pfl[9]);
-
     dbChannelDelete(pch);
 
+    testDiag("%d field_logs on free-list", db_available_logs());
+
     /* mode LAST */
 
     testHead("Mode LAST  (m='last', s='red')");
@@ -317,24 +384,25 @@ MAIN(syncTest)
 
     testDiag("Test event stream");
 
+    streamReset();
     dbStateClear(red);
-    mustDrop(pch, pfl[0], "state=FALSE, log0");
-    mustDrop(pch, pfl[1], "state=FALSE, log1");
-    mustDrop(pch, pfl[2], "state=FALSE, log2");
+    mustStash(pch, pfl[0], "state=FALSE, log0");
+    mustStash(pch, pfl[1], "state=FALSE, log1");
+    mustStash(pch, pfl[2], "state=FALSE, log2");
     dbStateSet(red);
-    mustDrop(pch, pfl[3], "state=TRUE, log3");
-    mustDrop(pch, pfl[4], "state=TRUE, log4");
-    mustDrop(pch, pfl[5], "state=TRUE, log5");
+    mustStash(pch, pfl[3], "state=TRUE, log3");
+    mustStash(pch, pfl[4], "state=TRUE, log4");
+    mustStash(pch, pfl[5], "state=TRUE, log5");
     dbStateClear(red);
-    mustPassOld(pch, pfl[5], pfl[6], "state=TRUE, log6, pass=log5");
-    mustDrop(pch, pfl[7], "state=FALSE, log7");
-    mustDrop(pch, pfl[8], "state=FALSE, log8");
-    mustDrop(pch, pfl[9], "state=FALSE, log9");
-
-    db_delete_field_log(pfl[5]);
+    mustSwap(pch, pfl[6], "state=TRUE, log6");
+    mustStash(pch, pfl[7], "state=FALSE, log7");
+    mustStash(pch, pfl[8], "state=FALSE, log8");
+    mustStash(pch, pfl[9], "state=FALSE, log9");
 
     dbChannelDelete(pch);
 
+    testDiag("%d field_logs on free-list", db_available_logs());
+
     /* mode AFTER */
 
     testHead("Mode AFTER  (m='after', s='red')");
@@ -343,13 +411,14 @@ MAIN(syncTest)
 
     checkAndOpenChannel(pch, plug);
 
-    for (i = 0; i < 10; i++) {
+    for (i = 0; i < 9; i++) {
         pfl[i] = db_create_read_log(pch);
         fl_setup(pch, pfl[i], 120 + i);
     }
 
     testDiag("Test event stream");
 
+    streamReset();
     dbStateClear(red);
     mustDrop(pch, pfl[0], "state=FALSE, log0");
     mustDrop(pch, pfl[1], "state=FALSE, log1");
@@ -363,11 +432,11 @@ MAIN(syncTest)
     mustDrop(pch, pfl[7], "state=FALSE, log7");
     mustDrop(pch, pfl[8], "state=FALSE, log8");
 
-    db_delete_field_log(pfl[6]);
-    db_delete_field_log(pfl[9]);
-
     dbChannelDelete(pch);
 
+    logsFinal = db_available_logs();
+    testOk(logsFree == logsFinal, "%d field_logs on free-list", logsFinal);
+
     db_close_events(evtctx);
 
     testIocShutdownOk();

src/std/rec/Makefile

@@ -53,3 +53,7 @@ stdRecords_DBD = $(patsubst %,%.dbd,$(stdRecords))
 dbRecStd_SRCS += $(patsubst %,%.c,$(stdRecords))
 
 HTMLS += $(patsubst %.dbd.pod,%.html,$(notdir $(wildcard ../rec/*Record.dbd.pod)))
+
+vpath %.png $(SRC_DIRS)
+HTMLS += image/compress-1.png
+HTMLS += image/compress-2.png

src/std/rec/aiRecord.dbd.pod

@@ -4,7 +4,7 @@
 # Copyright (c) 2002 The Regents of the University of California, as
 #     Operator of Los Alamos National Laboratory.
 # EPICS BASE is distributed subject to a Software License Agreement found
-# in file LICENSE that is included with this distribution. 
+# in file LICENSE that is included with this distribution.
 #*************************************************************************
 
 =title Analog Input Record (ai)
@@ -214,7 +214,7 @@ monitoring functionality.
 
 =cut
 
-    include "dbCommon.dbd" 
+    include "dbCommon.dbd"
     field(VAL,DBF_DOUBLE) {
         prompt("Current EGU Value")
         promptgroup("40 - Input")
@@ -520,7 +520,7 @@ The individual routines are described below.
 
 =head3 Device Support Routines
 
-=head4 long report(int level)
+  long report(int level)
 
 This optional routine is called by the IOC command C<dbior> and is passed the
 report level that was requested by the user.
@@ -530,7 +530,7 @@ information at higher levels, or to select different types of information with
 different levels.
 Level zero should print no more than a small summary.
 
-=head4 long init(int after)
+  long init(int after)
 
 This optional routine is called twice at IOC initialization time.
 The first call happens before any of the C<init_record()> calls are made, with
@@ -538,7 +538,7 @@ the integer parameter C<after> set to 0.
 The second call happens after all of the C<init_record()> calls have been made,
 with C<after> set to 1.
 
-=head4 long init_record(aiRecord *prec)
+  long init_record(aiRecord *prec)
 
 This optional routine is called by the record initialization code for each ai
 record instance that has its DTYP field set to use this device support.
@@ -555,7 +555,7 @@ C<LINEAR>, but it is not necessary to check that condition first.
 This same calculation takes place in the C<special_linconv()> routine, so the
 implementation can usually just call that routine to perform the task.
 
-=head4 long get_ioint_info(int cmd, aiRecord *prec, IOSCANPVT *piosl)
+  long get_ioint_info(int cmd, aiRecord *prec, IOSCANPVT *piosl)
 
 This optional routine is called whenever the record's SCAN field is being
 changed to or from the value C<I/O Intr> to find out which I/O Interrupt Scan
@@ -584,7 +584,7 @@ thread.
 The C<scanIoRequest()> routine is safe to call from an interrupt service routine
 on embedded architectures (vxWorks and RTEMS).
 
-=head4 long read_ai(aiRecord *prec)
+  long read_ai(aiRecord *prec)
 
 This essential routine is called when the record wants a new value from the
 addressed device.
@@ -595,7 +595,7 @@ It is responsible for performing (or at least initiating) a read operation, and
 
 ... return value ...
 
-=head4 long special_linconv(aiRecord *prec, int after)
+  long special_linconv(aiRecord *prec, int after)
 
 This optional routine should be provided if the record type's unit conversion
 features are used by the device support's C<read_ai()> routine returning a

src/std/rec/aoRecord.dbd.pod

@@ -70,7 +70,7 @@ output value PVAL is added to it.
 =head4 Drive Limits
 
 The output value is now clipped to the range DRVL to DRVH inclusive, provided
-that DRVH > DRVL.
+that DRVH E<gt> DRVL.
 The result is copied into both the VAL and PVAL fields.
 
 =head4 Limit Rate of Change
@@ -164,9 +164,7 @@ OUT field must specify the address of the I/O card. In addition, the
 DTYP field must contain the name of the device support module. Be aware
 that the address format differs according to the I/O bus used. See
 Address Specification for information on the format of hardware
-addresses. The user can see a list of the device support modules
-currently supported at the user's local site by using the dbst utility
-in R3.13.
+addresses.
 
 For soft records the output link can be a database link, a channel
 access link, or a constant value. If the link is a constant, no output
@@ -593,7 +591,7 @@ terminated.
 For compatibility with old device supports that don't know EOFF, if
 both EOFF and ESLO have their default value, EOFF is set to EGUL.
 
-If device support includes init_record, it is called.
+If device support includes C<init_record()>, it is called.
 
 INIT is set TRUE. This causes PBRK, LBRK, and smoothing to be
 re-initialized. If "backwards" linear conversion is requested, then VAL
@@ -620,10 +618,6 @@ called.
 INIT is set TRUE. This causes PBRK, LBRK, and smoothing to be
 re-initialized.
 
-=item get_value
-
-Fills in the values of struct valueDes so that they refer to VAL.
-
 =item get_alarm_double
 
 Sets the following values:
@@ -903,7 +897,7 @@ OUT link type must be either a CONSTANT, DB_LINK, or CA_LINK.
 This module writes the current value of OVAL.
 
 If the OUT link type is PV_LINK, then dbCaAddInlink is called by
-init_record. init_record always returns a value of 2, which means that
+C<init_record()>. C<init_record()> always returns a value of 2, which means that
 no conversion will ever be attempted.
 
 write_ao calls recGblPutLinkValue to write the current value of VAL.

src/std/rec/biRecord.dbd.pod

@@ -69,9 +69,7 @@ If the binary input record gets its value from hardware, the address of the
 card must be entered in the INP field, and the name of the device support
 module must be entered in the DTYP field. See L<Address Specification> for
 information on the format of the hardware address. Be aware that the format
-differs between types of cards. You can see a list of device support
-modules currently supported at the user's local site by using C<dbst>
-utility (R3.13).
+differs between types of cards.
 
 For records that specify C<Soft Channel> or C<Raw Soft Channel> device
 support routines, the INP field can be a channel or a database link, or a
@@ -94,18 +92,18 @@ the device support module reads a value directly into VAL or the
 C<Soft Channel> device support is used. The value can also be fetched as one of
 the strings specified in the ZNAM or ONAM fields. The ZNAM field has a
 string that corresponds to the 0 state, so when the value is fetched as
-this string, C<put_enum_str> will return a 0. The ONAM field hold the
+this string, C<put_enum_str()> will return a 0. The ONAM field hold the
 string that corresponds to the 1 state, so when the value is fetched as
-this string, C<put_enum_str> returns a 1.
+this string, C<put_enum_str()> returns a 1.
 
 =fields ZNAM, ONAM
 
 =head3 Operator Display Parameters
 
 These parameters are used to present meaningful data to the operator. The
-C<get_enum_str> record support routine can retrieve the state string
-corresponding to the VAL's state. If the value is 1, C<get_enum_str> will
-return the string in the ONAM field; and if 0, C<get_enum_str> will return
+C<get_enum_str()> record support routine can retrieve the state string
+corresponding to the VAL's state. If the value is 1, C<get_enum_str()> will
+return the string in the ONAM field; and if 0, C<get_enum_str()> will return
 the ZNAM string.
 
 See L<Fields Common to All Record Types> for more on the record name (NAME)
@@ -149,7 +147,7 @@ The LALM fields holds the value of the last occurence of the change of
 state alarm. It is used to implement the change of state alarm, and thus
 only has meaning if COSV is MAJOR or MINOR.
 
-The MSLT field is used by the C<process> record support routine to
+The MSLT field is used by the C<process()> record support routine to
 determine if archive and value change monitors are invoked. They are if MSLT
 is not equal to VAL.
 
@@ -164,7 +162,7 @@ these fields.
 
 =cut
 
-	include "dbCommon.dbd" 
+	include "dbCommon.dbd"
 	field(INP,DBF_INLINK) {
 		prompt("Input Specification")
 		promptgroup("40 - Input")
@@ -266,7 +264,7 @@ these fields.
 
 =head3 Record Support Routines
 
-=head2 C<init_record>
+  long init_record(struct dbCommon *precord, int pass);
 
 This routine initializes SIMM with the value of SIML if SIML type is a
 CONSTANT link or creates a channel access link if SIML type is PV_LINK.
@@ -276,25 +274,21 @@ This routine next checks to see that device support is available and a
 device support routine is defined. If neither exist, an error is issued and
 processing is terminated.
 
-If device support includes C<init_record>, it is called.
+If device support includes C<init_record()>, it is called.
 
-=head2 C<process>
+  long process(struct dbCommon *precord);
 
-See next section.
+See L<Record Processing> below.
 
-=head2 C<get_value>
-
-Fills in the values of struct valueDes so that they refer to VAL.
-
-=head2 C<get_enum_str>
+  long get_enum_str(const struct dbAddr *paddr, char *pbuffer);
 
 Retrieves ASCII string corresponding to VAL.
 
-=head2 C<get_enum_strs>
+  long get_enum_strs(const struct dbAddr *paddr, struct dbr_enumStrs *p);
 
 Retrieves ASCII strings for ZNAM and ONAM.
 
-=head2 C<put_enum_str>
+  long put_enum_str(const struct dbAddr *paddr, const char *pbuffer);
 
 Check if string matches ZNAM or ONAM, and if it does, sets VAL.
 
@@ -302,7 +296,7 @@ Check if string matches ZNAM or ONAM, and if it does, sets VAL.
 
 Routine process implements the following algorithm:
 
-=over 1
+=over
 
 =item 1.
 Check to see that the appropriate device support module exists. If it
@@ -311,7 +305,7 @@ the PACT field still set to TRUE. This ensures that processes will no
 longer be called for this record. Thus error storms will not occur.
 
 =item 2.
-C<readValue> is called. See L<Input Records> for details.
+C<readValue()> is called. See L<Input Records> for details.
 
 =item 3.
 If PACT has been changed to TRUE, the device support read routine has
@@ -323,7 +317,7 @@ Convert.
 
 =back
 
-=over 1
+=over
 
 =item *
 status = read_bi
@@ -332,7 +326,7 @@ status = read_bi
 PACT = TRUE
 
 =item *
-TIME = tslocaltime
+C<recGblGetTimeStamp()> is called.
 
 =item *
 if status is 0, then set VAL=(0,1) if RVAL is (0, not 0) and UDF = False.
@@ -342,7 +336,7 @@ if status is 2, set status = 0
 
 =back
 
-=over 1
+=over
 
 =item 5.
 Check alarms: This routine checks to see if the new VAL causes the alarm
@@ -354,7 +348,7 @@ Check if monitors should be invoked:
 
 =back
 
-=over 1
+=over
 
 =item *
 Alarm monitors are invoked if the alarm status or severity has changed.
@@ -370,7 +364,7 @@ NSEV and NSTA are reset to 0.
 
 =back
 
-=over 1
+=over
 
 =item 7.
 Scan forward link if necessary, set PACT FALSE, and return.
@@ -383,7 +377,7 @@ Scan forward link if necessary, set PACT FALSE, and return.
 
 Each binary input record must have an associated set of device support
 routines. The primary resposibility of the device support routines is to
-obtain a new raw input value whenever C<read_bi> is called. The device
+obtain a new raw input value whenever C<read_bi()> is called. The device
 support routines are primarily interested in the following fields:
 
 =fields PACT, DPVT, UDF, NSEV, NSTA, VAL, INP, RVAL, MASK
@@ -392,27 +386,37 @@ support routines are primarily interested in the following fields:
 
 Device support consists of the following routines:
 
-=head2 C<report(FILE fp, paddr)>
+  long report(int level);
 
-Not currently used.
+This optional routine is called by the IOC command C<dbior> and is passed the
+report level that was requested by the user.
+It should print a report on the state of the device support to stdout.
+The C<level> parameter may be used to output increasingly more detailed
+information at higher levels, or to select different types of information with
+different levels.
+Level zero should print no more than a small summary.
 
-=head2 C<init()>
+  long init(int after);
 
-This routine is called once during IOC initialization.
+This optional routine is called twice at IOC initialization time.
+The first call happens before any of the C<init_record()> calls are made, with
+the integer parameter C<after> set to 0.
+The second call happens after all of the C<init_record()> calls have been made,
+with C<after> set to 1.
 
-=head2 C<init_record(precord)>
+  long init_record(struct dbCommon *precord);
 
 This routine is optional. If provided, it is called by the record support
-C<init_record> routine.
+C<init_record()> routine.
 
-=head2 C<get_ioint_info(int cmd, struct dbCommon *precord, IOSCANPVT *ppvt)>
+  long get_ioint_info(int cmd, struct dbCommon *precord, IOSCANPVT *ppvt);
 
-This routine is called by the C<ioEventScan> system each time the record is
+This routine is called by the ioEventScan system each time the record is
 added or deleted from an I/O event scan list. C<cmd> has the value (0,1) if
 the record is being (added to, deleted from) and I/O event list. It must be
 provided for any device type that can use the ioEvent scanner.
 
-=head2 C<read_bi(precord)>
+  long read_bi(struct dbCommon *precord);
 
 This routine must provide a new input value. It returns the following
 values:
@@ -439,25 +443,25 @@ link type must be either CONSTANT, DB_LINK, or CA_LINK.
 
 =head3 Soft Channel
 
-C<read_bi> always returns a value of 2, which means that no conversion is
+C<read_bi()> always returns a value of 2, which means that no conversion is
 performed.
 
 If the INP link type is CONSTANT, then the constant value is stored in VAL
-by C<init_record>, and the UDF is set to FALSE. VAL can be changed via
-C<dbPut> requests. If the INP link type is PV_LINK, the C<dbCaAddInlink> is
-called by C<init_record>.
+by C<init_record()>, and the UDF is set to FALSE. VAL can be changed via
+C<dbPut()> requests. If the INP link type is PV_LINK, the C<dbCaAddInlink()> is
+called by C<init_record()>.
 
-C<read_bi> calls C<recGbleGetLinkValue> to read the current value of VAL.
+C<read_bi()> calls C<dbGetLinkValue> to read the current value of VAL.
 See L<Soft Input> for details.
 
-If the return status of C<recGblGetLinkValue> is zero, then C<read_bi> sets
-UDF to FALSE. The status of C<recGblGetLinkValue> is returned.
+If the return status of C<dbGetLinkValue()> is zero, then C<read_bi()> sets
+UDF to FALSE. The status of C<dbGetLinkValue()> is returned.
 
 =head3 Raw Soft Channel
 
 This module is like the previous except that values are read into RVAL.
 
-C<read_bi> returns a value of 0. Thus the record processing routine will
+C<read_bi()> returns a value of 0. Thus the record processing routine will
 force VAL to be 0 or 1.
 
 =cut

src/std/rec/boRecord.c

@@ -98,7 +98,7 @@ struct bodset { /* binary output dset */
 
 /* control block for callback*/
 typedef struct myCallback {
-        CALLBACK        callback;
+        epicsCallback        callback;
         struct dbCommon *precord;
 }myCallback;
 
@@ -106,7 +106,7 @@ static void checkAlarms(boRecord *);
 static void monitor(boRecord *);
 static long writeValue(boRecord *);
 
-static void myCallbackFunc(CALLBACK *arg)
+static void myCallbackFunc(epicsCallback *arg)
 {
     myCallback *pcallback;
     boRecord *prec;
@@ -329,9 +329,9 @@ static long get_enum_strs(DBADDR *paddr,struct dbr_enumStrs *pes)
     /*SETTING no_str=0 breaks channel access clients*/
     pes->no_str = 2;
     memset(pes->strs,'\0',sizeof(pes->strs));
-    strncpy(pes->strs[0],prec->znam,sizeof(prec->znam));
+    strncpy(pes->strs[0],prec->znam,sizeof(pes->strs[0]));
     if(*prec->znam!=0) pes->no_str=1;
-    strncpy(pes->strs[1],prec->onam,sizeof(prec->onam));
+    strncpy(pes->strs[1],prec->onam,sizeof(pes->strs[1]));
     if(*prec->onam!=0) pes->no_str=2;
     return(0);
 }

src/std/rec/boRecord.dbd.pod

@@ -65,9 +65,9 @@ C<losed_loop> or C<supervisory>. If C<supervisory> is specified, the value
 in the VAL field can be set externally via dbPuts at run-time. If
 C<closed_loop> is specified, the VAL field's value is obtained from the
 address specified in the desired output location (DOL) field which can be a
-database link, a channel access link, or a constant. To achieve continuous
-control, a database link to a control algorithm record should be entered in
-the DOL field.
+database link or a channel access link, but not a constant. To achieve
+continuous control, a database link to a control algorithm record should be
+entered in the DOL field.
 
 L<Address Specification> presents more information on database addresses
 and links. L<Scanning Specification> explaines the effect of database
@@ -130,8 +130,7 @@ It must specify the address of an I/O card if the record sends its output
 to hardware, and the DTYP field must contain the corresponding device
 support module. Be aware that the address format differs according to the
 I/O bus used. See L<Address Specification> for information on the format of
-hardware addresses. You can see a list of device support modules currently
-supported at the user's local site by using the C<dbst> utility in R3.13.
+hardware addresses.
 
 Otherwise, if the record is configured to use the soft device support
 modules, then it can be either a database link, a channel access link, or a
@@ -143,9 +142,9 @@ this chapter for more on output to other records.
 =head3 Operator Display Parameters
 
 These parameters are used to present meaningful data to the operator, The
-C<get_enum_str> record support routine can retrieve the state string
-corresponding to the VAL's state. So, if the value is 1, C<get_enum_str>
-will return the string in the ONAM field: and if 0, C<get_enum_str> will
+C<get_enum_str()> record support routine can retrieve the state string
+corresponding to the VAL's state. So, if the value is 1, C<get_enum_str()>
+will return the string in the ONAM field: and if 0, C<get_enum_str()> will
 return the ZNAM string.
 
 See L<Fields Common to All Record Types> for more on the record name (NAME)
@@ -194,7 +193,7 @@ The LALM field holds the value of the last occurrence of the change of
 state alarm. It is used to implement the change of state alarm, and thus
 only has meaning if COSV is MINOR or MAJOR.
 
-The MLST is used by the C<process> record support routine to determine if
+The MLST is used by the C<process()> record support routine to determine if
 archive and value change monitors are invoked. They are if MLST is not
 equal to VAL.
 
@@ -373,17 +372,13 @@ exist, and error message is issued and processing is terminated.
 If DOL is a constant, then VAL is initialized to 1 if its value is nonzero
 or initialzed to 0 if DOL is zero, and UDF is set to FALSE.
 
-If device support includes C<init_record>, it is called. VAL is set using
+If device support includes C<init_record()>, it is called. VAL is set using
 RVAL, and UDF is set to FALSE.
 
 =head2 C<process>
 
 See next section.
 
-=head2 C<get_value>
-
-Fills in the values of struct valueDes so that they refer to VAL.
-
 =head2 C<get_enum_str>
 
 Retrieves ASCII string corresponding to VAL.
@@ -416,7 +411,7 @@ If PACT is FALSE
 =over
 
 =item *
-If DOL is DB_LINK and OMSL is CLOSED_LOOP
+If DOL holds a link and OMSL is C<closed_loop>
 
 =over
 
@@ -500,27 +495,37 @@ Scan forward link if necessary, set PACT FALSE, and return
 
 Each binary output record must have an associated set of device support
 routines. The primary responsibility of the device support routines is to
-write a new value whenever C<write_bo> is called. The device support routines
+write a new value whenever C<write_bo()> is called. The device support routines
 are primarily interested in the following fields:
 
 =fields PACT, DPVT, NSEV, NSTA, VAL, OUT, RVAL, MASK, RBV
 
-=head3 Decive Support Routines
+=head3 Device Support Routines
 
 Device support consists of the following routines:
 
-=head2 C<report(FILE fp, paddr)>
+=head4 long report(int level)
 
-Not currently used.
+This optional routine is called by the IOC command C<dbior> and is passed the
+report level that was requested by the user.
+It should print a report on the state of the device support to stdout.
+The C<level> parameter may be used to output increasingly more detailed
+information at higher levels, or to select different types of information with
+different levels.
+Level zero should print no more than a small summary.
 
-=head2 C<init()>
+=head4 long init(int after)
 
-This routine is called once during IOC initialization.
+This optional routine is called twice at IOC initialization time.
+The first call happens before any of the C<init_record()> calls are made, with
+the integer parameter C<after> set to 0.
+The second call happens after all of the C<init_record()> calls have been made,
+with C<after> set to 1.
 
 =head2 C<init_record(precord)>
 
 This routine is optional. If provided, it is called by record support
-C<init_record> routine. It should determine MASK if it is needed.
+C<init_record()> routine. It should determine MASK if it is needed.
 
 =over
 
@@ -566,10 +571,10 @@ link type must be either CONSTANT, DB_LINK, or CA_LINK.
 
 This module writes the current value of VAL.
 
-If the OUT link type is PV_LINK, then C<dbCaAddInlink> is called by
-C<init_record>. C<init_record> always returns a value of 2, which means
-that no conversion will ever be attempted. C<write_bo> calls
-C<recGblPutLinkValue> to write the current value of VAL. See L<Soft Output>
+If the OUT link type is PV_LINK, then C<dbCaAddInlink()> is called by
+C<init_record()>. C<init_record()> always returns a value of 2, which means
+that no conversion will ever be attempted. C<write_bo()> calls
+C<recGblPutLinkValue()> to write the current value of VAL. See L<Soft Output>
 for details.
 
 =head3 Raw Soft Channel

src/std/rec/calcRecord.dbd.pod

@@ -261,22 +261,22 @@ ATAN: Arc tangent
 =over 1
 
 =item *
->= : Greater than or equal to
+C<<< >= >>> : Greater than or equal to
 
 =item *
-> : Greater than
+C<<< > >>> : Greater than
 
 =item *
-<= : Less than or equal to
+C<<< <= >>> : Less than or equal to
 
 =item *
-< : Less than
+C<<< < >>> : Less than
 
 =item *
-# : Not equal to
+C<<< # >>> : Not equal to
 
 =item *
-= : Equal to
+C<<< = >>> : Equal to
 
 =back
 
@@ -285,13 +285,13 @@ ATAN: Arc tangent
 =over 1
 
 =item *
-&& : And
+C<&&> : And
 
 =item *
-|| : Or
+C<||> : Or
 
 =item *
-! : Not
+C<!> : Not
 
 =back
 
@@ -300,10 +300,10 @@ ATAN: Arc tangent
 =over 1
 
 =item *
-| : Bitwise Or
+C<|> : Bitwise Or
 
 =item *
-& : Bitwise And
+C<&> : Bitwise And
 
 =item *
 OR : Bitwise Or
@@ -315,13 +315,13 @@ AND : Bitwise And
 XOR : Bitwise Exclusive Or
 
 =item *
-~ : One's Complement
+C<~> : One's Complement
 
 =item *
-<< : Left shift
+C<<< << >>> : Left shift
 
 =item *
->> : Right shift
+C<<< >> >>> : Right shift
 
 =back
 
@@ -330,7 +330,7 @@ XOR : Bitwise Exclusive Or
 =over 1
 
 =item *
-:= : assigns a value (right hand side) to a variable (i.e. field)
+C<:=> : assigns a value (right hand side) to a variable (i.e. field)
 
 =back
 
@@ -360,35 +360,35 @@ C<A + B + 10>
 =over 1
 
 =item *
-Result is A + B + 10
+Result is C<A + B + 10>
 
 =back
 
 =head3 Relational
 
-C<(A + B) < (C + D)>
+C<<< (A + B) < (C + D) >>>
 
 =over 1
 
 =item *
-Result is 1 if (A + B) < (C + D)
+Result is 1 if C<<< (A + B) < (C + D) >>>
 
 =item *
-Result is 0 if (A + B) >= (C + D)
+Result is 0 if C<<< (A + B) >= (C + D) >>>
 
 =back
 
 =head3 Question Mark
 
-C<(A + B) < (C + D) ? E : F + L + 10>
+C<<< (A + B) < (C + D) ? E : F + L + 10 >>>
 
 =over 1
 
 =item *
-Result is E if (A + B) < (C + D)
+Result is C<E> if C<<< (A + B) < (C + D) >>>
 
 =item *
-Result is F + L + 10 if (A + B) >= (C + D)
+Result is C<F + L + 10> if C<<< (A + B) >= (C + D) >>>
 
 =back
 
@@ -412,7 +412,7 @@ C<(A + B) < (C + D) ? E : VAL>
 
 =head3 Logical
 
-C<A&B>
+C<A & B>
 
 =over 1
 
@@ -851,10 +851,6 @@ See next section.
 
 This is called if CALC is changed. C<special> calls postfix.
 
-=head2 C<get_value>
-
-Fills in the values of struct valueDes so that the refer to VAL.
-
 =head2 C<get_units>
 
 Retrieves EGU.

src/std/rec/calcoutRecord.c

@@ -116,8 +116,8 @@ typedef struct calcoutDSET {
 #define CA_LINKS_NOT_OK 2
 
 typedef struct rpvtStruct {
-    CALLBACK doOutCb;
-    CALLBACK checkLinkCb;
+    epicsCallback doOutCb;
+    epicsCallback checkLinkCb;
     short    cbScheduled;
     short    caLinkStat; /* NO_CA_LINKS, CA_LINKS_ALL_OK, CA_LINKS_NOT_OK */
 } rpvtStruct;
@@ -127,7 +127,7 @@ static void monitor(calcoutRecord *prec);
 static int fetch_values(calcoutRecord *prec);
 static void execOutput(calcoutRecord *prec);
 static void checkLinks(calcoutRecord *prec);
-static void checkLinksCallback(CALLBACK *arg);
+static void checkLinksCallback(epicsCallback *arg);
 static long writeValue(calcoutRecord *prec);
 
 int    calcoutRecDebug;
@@ -673,7 +673,7 @@ static int fetch_values(calcoutRecord *prec)
         return(status);
 }
 
-static void checkLinksCallback(CALLBACK *arg)
+static void checkLinksCallback(epicsCallback *arg)
 {
 
     calcoutRecord *prec;
@@ -731,7 +731,7 @@ static void checkLinks(calcoutRecord *prec)
         prpvt->caLinkStat = NO_CA_LINKS;
 
     if (!prpvt->cbScheduled && caLinkNc) {
-        /* Schedule another CALLBACK */
+        /* Schedule another epicsCallback */
         prpvt->cbScheduled = 1;
         callbackRequestDelayed(&prpvt->checkLinkCb, .5);
     }

src/std/rec/calcoutRecord.dbd.pod

@@ -293,22 +293,22 @@ ATAN: Arc tangent
 =over 1
 
 =item *
->= : Greater than or equal to
+C<<< >= >>> : Greater than or equal to
 
 =item *
-> : Greater than
+C<<< > >>> : Greater than
 
 =item *
-<= : Less than or equal to
+C<<< <= >>> : Less than or equal to
 
 =item *
-< : Less than
+C<<< < >>> : Less than
 
 =item *
-# : Not equal to
+C<<< # >>> : Not equal to
 
 =item *
-= : Equal to
+C<<< = >>> : Equal to
 
 =back
 
@@ -332,10 +332,10 @@ ATAN: Arc tangent
 =over 1
 
 =item *
-| : Bitwise Or
+C<|> : Bitwise Or
 
 =item *
-& : Bitwise And
+C<&> : Bitwise And
 
 =item *
 OR : Bitwise Or
@@ -347,13 +347,13 @@ AND : Bitwise And
 XOR : Bitwise Exclusive Or
 
 =item *
-~ : One's Complement
+C<~> : One's Complement
 
 =item *
-<< : Left shift
+C<<< << >>> : Left shift
 
 =item *
->> : Right shift
+C<<< >> >>> : Right shift
 
 =back
 
@@ -362,11 +362,11 @@ XOR : Bitwise Exclusive Or
 =over 1
 
 =item *
-:= : assigns a value (right hand side) to a variable (i.e. field)
+C<:=> : assigns a value (right hand side) to a variable (i.e. field)
 
 =back
 
-=head3 Parentheses and Comma
+=head3 Parantheses, Comma, and Semicolon
 
 The open and close parentheses are supported. Nested parentheses are
 supported.
@@ -374,6 +374,10 @@ supported.
 The comma is supported when used to separate the arguments of a binary
 function.
 
+The semicolon is used to separate expressions. Although only one
+traditional calculation expression is allowed, multiple assignment
+expressions are allowed.
+
 =head3 Conditional Expression
 
 The C language's question mark operator is supported. The format is:
@@ -388,41 +392,59 @@ C<A + B + 10>
 =over 1
 
 =item *
-Result is A + B + 10
+Result is C<A + B + 10>
 
 =back
 
 =head3 Relational
 
-C<(A + B) < (C + D)>
+C<<< (A + B) < (C + D) >>>
 
 =over 1
 
 =item *
-Result is 1 if (A + B) < (C + D)
+Result is 1 if C<<< (A + B) < (C + D) >>>
 
 =item *
-Result is 0 if (A + B) >= (C + D)
+Result is 0 if C<<< (A + B) >= (C + D) >>>
 
 =back
 
 =head3 Question Mark
 
-C<(A + B) < (C + D) ? E : F + L + 10>
+C<<< (A + B) < (C + D) ? E : F + L + 10 >>>
 
 =over 1
 
 =item *
-Result is E if (A + B) < (C + D)
+Result is C<E> if C<<< (A + B) < (C + D) >>>
 
 =item *
-Result is F + L + 10 if (A + B) >= (C + D)
+Result is C<F + L + 10> if C<<< (A + B) >= (C + D) >>>
+
+=back
+
+Prior to Base 3.14.9 it was legal to omit the : and the second (else) part
+of the conditional, like this:
+
+C<(A + B)<(C + D) ? E>
+
+=over 1
+
+=item
+Result is E if (A + B)<(C + D)
+
+=item
+Result is unchanged if (A + B)>=(C + D)
+
+From 3.14.9 onwards, this expresion must be written as
+C<(A + B) < (C + D) ? E : VAL>
 
 =back
 
 =head3 Logical
 
-C<A&B>
+C<A & B>
 
 =over 1
 
@@ -447,6 +469,18 @@ Convert result to floating point
 
 =back
 
+=head3 Assignment
+
+C<sin(a); a:=a+D2R>
+
+=over 1
+
+=item *
+Causes the Calc record to output the successive values of a sine curve in
+1 degree intervals.
+
+=back
+
 =head3 Output Parameters
 
 These parameters specify and control the output capabilities of the Calcout
@@ -529,7 +563,7 @@ are also meant to represent the status of the record at run-time.
 
 The EGU field contains a string of up to 16 characters which is supplied by
 the user and which describes the values being operated upon. The string is
-retrieved whenever the routine C<get_units> is called. The EGU string is
+retrieved whenever the routine C<get_units()> is called. The EGU string is
 solely for an operator's sake and does not have to be used.
 
 The HOPR and LOPR fields on;y refer to the limits if the VAL, HIHI, HIGH,
@@ -1146,10 +1180,6 @@ See next section.
 
 This is called id CALC or OCAL is changed. C<special> calls postfix.
 
-=head2 C<get_value>
-
-Fills in the values of struct valueDes so that they refer to VAL.
-
 =head2 C<get_units>
 
 Retrieves EGU.

src/std/rec/compressRecord.dbd.pod

@@ -4,33 +4,25 @@
 # Copyright (c) 2002 The Regents of the University of California, as
 #     Operator of Los Alamos National Laboratory.
 # EPICS BASE is distributed subject to a Software License Agreement found
-# in file LICENSE that is included with this distribution. 
+# in file LICENSE that is included with this distribution.
 #*************************************************************************
 
-=title Compress Record (compress)
+=title Compression Record (compress)
 
-...
+The data compression record is used to collect and compress data from arrays.
+When the INP field references a data array field, it immediately compresses the
+entire array into an element of an array using one of several algorithms,
+overwriting the previous element. If the INP field obtains its value from a
+scalar-value field, the compression record will collect a new sample each time
+the record is processed and add it to the compressed data array as a circular
+buffer.
 
-=head2 Record-specific Menus
-
-=head3 Menu compressALG
-
-The ALG field which uses this menu controls the compression algorithm used.
-
-...
-
-=menu compressALG
-
-...
-
-=head2 Parameter Fields
-
-The record-specific fields are described below.
+The INP link can also specify a constant; however, if this is the case, the
+compression algorithms are ignored, and the record support routines merely
+return after checking the FLNK field.
 
 =recordtype compress
 
-...
-
 =cut
 
 menu(compressALG) {
@@ -43,11 +35,299 @@ menu(compressALG) {
 }
 recordtype(compress) {
 
-=fields VAL
+=head2 Parameter Fields
+
+The record-specific fields are described below, grouped by functionality.
+
+=head3 Scanning Parameters
+
+The compression record has the standard fields for specifying under what
+circumstances the record will be processed. These fields are listed in
+L<Scan Fields>. In addition, L<Scanning Specification>
+explains how these fields are used. Since  the compression record supports no
+direct interfaces to hardware, its SCAN field cannot specify C<<< I/O Intr >>>.
+
+=head3 Algorithms and Related Parameters
+
+The user specifies the algorithm to be used in the ALG field. There are six possible
+algorithms which can be specified as follows:
+
+=head4 Menu compressALG
+
+=menu compressALG
+
+The following fields determine what channel to read and how to compress the data:
+
+=fields ALG, INP, NSAM, N, ILIL, IHIL, OFF, RES
+
+As stated above, the ALG field specifies which algorithm to be performed on the data.
+
+The INP should be a database or channel access link. Though INP can be a constant,
+the data compression algorithms are supported only when INP is a database link. See
+L<Address Specification> for information on specifying links.
+
+
+IHIL and ILIL can be set to provide an initial value filter on the input array.
+If ILIL E<lt> IHIL, the input elements will be skipped until a value is found
+that is in the range of ILIL to IHIL. Note that ILIL and IHIL are used only in
+C<<< N to 1 >>> algorithms.
+
+OFF provides the offset to the current beginning of the array data.
+Note that OFF is used only in C<<< N to 1 >>> algorithms.
+
+The RES field can be accessed at run time to cause the algorithm to reset
+itself before the maximum number of samples are reached.
+
+=head4 Algorithms
+
+B<Circular Buffer> algorithm keeps a circular buffer of length NSAM.
+Each time the record is processed, it gets the data referenced by INP and puts
+it into the circular buffer referenced by VAL. The INP can refer to both scalar or
+array data and VAL is just a time ordered circular buffer of  values obtained
+from INP.
+Note that N, ILIL, IHIL and OFF are not used in C<<< Circular Buffer >>> algorithm.
+
+B<Average> takes an average of every element of the array obtained from
+INP over time; that is, the entire array referenced by INP is retrieved, and for
+each element, the new average is calculated and placed in the corresponding
+element of the value buffer. The retrieved array is truncated to be of length
+NSAM. N successive arrays are averaged and placed in the buffer. Thus, VAL[0]
+holds the average of the first element of INP over N samples, VAL[1] holds the
+average of the next element of INP over N samples, and so on. The following
+shows the equation:
+
+=for comment Latex form of equation bellow : VAL[i] \leftarrow \frac{1}{N}\sum_{n=1}^NINP_{n}[i]
+
+=begin html
+
+<img src="image/compress-1.png">
+
+=end html
+
+B<N to 1> If any of the C<<< N to 1 >>> algorithms are chosen, then VAL is a circular
+buffer of NSAM samples.
+The actual algorithm depends on whether INP references a scalar or an array.
+
+If INP refers to a scalar, then N successive time ordered samples of INP are taken.
+After the Nth sample is obtained, a new value determined by the algorithm
+(Lowest, Highest, or Average), is written to the circular buffer referenced by
+VAL. If C<<< Low Value >>> the lowest value of all the samples is written; if
+C<<< High Value >>> the highest value is written; and if C<<< Average >>>, the
+average of all the samples are written.  The C<<< Median >>> setting behaves
+like C<<< Average >>> with scalar input data.
+
+If INP refers to an array, then the following applies:
+
+=over
+
+=item C<<< N to 1 Low Value >>>
+
+Compress N to 1 samples, keeping the lowest value.
+
+=item C<<< N to 1 High Value >>>
+
+Compress N to 1 samples, keeping the highest value.
+
+=item C<<< N to 1 Average >>>
+
+Compress N to 1 samples, taking the average value.
+
+=item C<<< N to 1 Median >>>
+
+Compress N to 1 samples, taking the median value.
+
+=back
+
+The compression record keeps NSAM data samples.
+
+The field N determines the number of elements to compress into each result.
+
+Thus, if NSAM was 3, and N was also equal to 3, then the algorithms would work
+as in the following diagram:
+
+=begin html
+
+<img src="image/compress-2.png">
+
+=end html
+
+
+=head3 Operator Display Parameters
+
+These parameters are used to present meaningful data to the operator. They
+display the value and other parameters of the record either textually or
+graphically.
+
+=fields EGU, HOPR, LOPR, PREC, NAME, DESC
+
+The EGU field should be given a string that describes the value of VAL, but is
+used whenever the C<<< get_units >>> record support routine is called.
+
+The HOPR and LOPR fields only specify the upper and lower display limits for
+VAL, HIHI, HIGH, LOLO and LOW fields.
+
+PREC controls the floating-point precision whenever C<<< get_precision >>> is
+called, and the field being referenced is the VAL field (i.e., one of the values
+contained in the circular buffer).
+
+See L<Fields Common to All Record Types>
+for more on the record name (NAME) and description (DESC) fields.
+
+
+=head3 Alarm Parameters
+
+The compression record has the alarm parameters common to all record types
+described in L<Alarm Fields>.
+
+=head3 Run-time Parameters
+
+These parameters are used by the run-time code for processing the data
+compression algorithm. They are not configurable by the user, though some are
+accessible at run-time. They can represent the current state of the waveform or
+of the record whose field is referenced by the INP field.
+
+=fields NUSE, OUSE, BPTR, SPTR, WPTR, CVB, INPN, INX
+
+NUSE and OUSE hold the current and previous number of elements stored in VAL.
+
+BPTR is a pointer that refers to the buffer referenced by VAL.
+
+SPTR points to an array that is used for array averages.
+
+WPTR is used by the dbGetlinks routines.
+
+=head2 Record Support
+
+=head3 Record Support Routines
+
+  long init_record(struct dbCommon *precord, int pass)
+
+Space for all necessary arrays is allocated. The addresses are stored in the
+appropriate fields in the record.
+
+  long process(struct dbCommon *precord)
+
+See L<Record Processing> below.
+
+  long special(struct dbAddr *paddr, int after)
+
+This routine is called when RSET, ALG, or N are set. It performs a reset.
+
+  long cvt_dbaddr(struct dbAddr *paddr)
+
+This is called by dbNameToAddr. It makes the dbAddr structure refer to the
+actual buffer holding the result.
+
+  long get_array_info(struct dbAddr *paddr, long *no_elements, long *offset)
+
+Obtains values from the circular buffer referenced by VAL.
+
+  long put_array_info(struct dbAddr *paddr, long nNew);
+
+Writes values into the circular buffer referenced by VAL.
+
+  long get_units(struct dbAddr *paddr, char *units);
+
+Retrieves EGU.
+
+  long get_precision(const struct dbAddr *paddr, long *precision);
+
+Retrieves PREC.
+
+  long get_graphic_double(struct dbAddr *paddr, struct dbr_grDouble *p);
+
+Sets the upper display and lower display limits for a field. If the field is
+VAL, the limits are set to HOPR and LOPR, else if the field has upper and lower
+limits defined they will be used, else the upper and lower maximum values for
+the field type will be used.
+
+  long get_control_double(struct dbAddr *paddr, struct dbr_ctrlDouble *p);
+
+Sets the upper control and the lower control limits for a field. If the field is
+VAL, the limits are set to HOPR and LOPR, else if the field has upper and lower
+limits defined they will be used, else the upper and lower maximum values for
+the field type will be used.
+
+=head3 Record Processing
+
+Routine process implements the following algorithm:
+
+=over
+
+=item 1.
+
+If INP is not a database link, check monitors and the forward link and return.
+
+=item 2.
+
+Get the current data referenced by INP.
+
+=item 3.
+
+Perform the appropriate algorithm:
+
+=over
+
+=item *
+
+Average: Read N successive instances of INP and perform an element by element
+average. Until N instances have been obtained it just return without checking
+monitors or the forward link. When N instances have been obtained complete the
+algorithm, store the result in the VAL array, check monitors and the forward
+link, and return.
+
+=item *
+
+Circular Buffer: Write the values obtained from INP into the VAL array as a
+circular buffer, check monitors and the forward link, and return.
+
+=item *
+
+N to 1 xxx when INP refers to a scalar: Obtain N successive values from INP and
+apply the N to 1 xxx algorithm to these values. Until N values are obtained
+monitors and forward links are not triggered. When N successive values have been
+obtained, complete the algorithm, check monitors and trigger the forward link,
+and return.
+
+=item *
+
+N to 1 xxx when INP refers to an array: The ILIL and IHIL are honored if ILIL
+E<lt> IHIL. The input array is divided into subarrays of length N. The specified
+N to 1 xxx compression algorithm is applied to each sub-array and the result
+stored in the array referenced by VAL. The monitors and forward link are
+checked.
+
+=back
+
+=item 4.
+
+If success, set UDF to FALSE.
+
+=item 5.
+
+Check to see if monitors should be invoked:
+
+=over
+
+=item *
+
+Alarm monitors are invoked if the alarm status or severity has changed.
+
+=item *
+
+NSEV and NSTA are reset to 0.
+
+=back
+
+=item 6.
+
+Scan forward link if necessary, set PACT FALSE, and return.
+
+=back
 
 =cut
 
-	include "dbCommon.dbd" 
+	include "dbCommon.dbd"
 	field(VAL,DBF_NOACCESS) {
 		prompt("Value")
 		asl(ASL0)

src/std/rec/dfanoutRecord.dbd.pod

@@ -379,11 +379,6 @@ and the DOL link, a non-zero value is returned if an error occurs.
 
 See next section.
 
-=head2 C<get_value()>
-
-This routine fills in the members of C<struct valueDes> with the VAL fields
-value and characteristics.
-
 =head2 C<get_units()>
 
 The routine copies the string specified in the EGU field to the location

src/std/rec/eventRecord.dbd

@@ -1,55 +0,0 @@
-#*************************************************************************
-# Copyright (c) 2002 The University of Chicago, as Operator of Argonne
-#     National Laboratory.
-# Copyright (c) 2002 The Regents of the University of California, as
-#     Operator of Los Alamos National Laboratory.
-# EPICS BASE is distributed subject to a Software License Agreement found
-# in file LICENSE that is included with this distribution.
-#*************************************************************************
-recordtype(event) {
-	include "dbCommon.dbd" 
-	field(VAL,DBF_STRING) {
-		prompt("Event Name To Post")
-		promptgroup("40 - Input")
-		special(SPC_MOD)
-		asl(ASL0)
-		size(40)
-	}
-	%#include "dbScan.h"
-	field(EPVT, DBF_NOACCESS) {
-		prompt("Event private")
-		special(SPC_NOMOD)
-		interest(4)
-		extra("EVENTPVT epvt")
-	}
-	field(INP,DBF_INLINK) {
-		prompt("Input Specification")
-		promptgroup("40 - Input")
-		interest(1)
-	}
-	field(SIOL,DBF_INLINK) {
-		prompt("Sim Input Specifctn")
-		promptgroup("90 - Simulate")
-		interest(1)
-	}
-	field(SVAL,DBF_STRING) {
-		prompt("Simulation Value")
-		size(40)
-	}
-	field(SIML,DBF_INLINK) {
-		prompt("Sim Mode Location")
-		promptgroup("90 - Simulate")
-		interest(1)
-	}
-	field(SIMM,DBF_MENU) {
-		prompt("Simulation Mode")
-		interest(1)
-		menu(menuYesNo)
-	}
-	field(SIMS,DBF_MENU) {
-		prompt("Sim mode Alarm Svrty")
-		promptgroup("90 - Simulate")
-		interest(2)
-		menu(menuAlarmSevr)
-	}
-}

src/std/rec/eventRecord.dbd.pod

@@ -0,0 +1,278 @@
+#*************************************************************************
+# Copyright (c) 2002 The University of Chicago, as Operator of Argonne
+#     National Laboratory.
+# Copyright (c) 2002 The Regents of the University of California, as
+#     Operator of Los Alamos National Laboratory.
+# EPICS BASE is distributed subject to a Software License Agreement found
+# in file LICENSE that is included with this distribution.
+#*************************************************************************
+
+=title Event Record (event)
+
+The normal use for this record type is to post an event and/or process a
+forward link. Device support for this record can provide a hardware interrupt
+handler routine for I/O Event-scanned records.
+
+=head2 Parameter Fields
+
+The records in this field fall into the following groups of parameters:
+
+=over
+
+=item *
+
+scan parameters
+
+=item *
+
+read parameters
+
+=item *
+
+event number parameters
+
+=item *
+
+simulation mode parameters
+
+=back
+
+=recordtype event
+
+=cut
+
+recordtype(event) {
+	include "dbCommon.dbd"
+
+=head3 Scan Parameters
+
+The event record has the standard fields for specifying under what circumstances
+it will be processed. If the SCAN field specifies C<I/O Intr>, then device
+support will provide an interrupt handler, posting an event number when an I/O
+interrupt occurs. These fields are listed in L<Scan Fields>. In addition,
+L<Scanning Specification> explains how the scanning fields work. Note that I/O
+event scanning is only supported for those card types that interrupt.
+
+=head3 Event Number Parameters
+
+The VAL field contains the event number read by the device support routines. It
+is this number which is posted. For records that use C<Soft Channel> device
+support, it can be configured before run-time or set via dbPuts.
+
+=fields VAL
+
+=cut
+
+	field(VAL,DBF_STRING) {
+		prompt("Event Name To Post")
+		promptgroup("40 - Input")
+		special(SPC_MOD)
+		asl(ASL0)
+		size(40)
+	}
+	%#include "dbScan.h"
+	field(EPVT, DBF_NOACCESS) {
+		prompt("Event private")
+		special(SPC_NOMOD)
+		interest(4)
+		extra("EVENTPVT epvt")
+	}
+
+=head3 Input Specification
+
+The device support routines use the address in this record to obtain input. For
+records that provide an interrupt handler, the INP field should specify the
+address of the I/O card, and the DTYP field should specify a valid device
+support module. Be aware that the address format differs according to the card
+type  used. See L<Address Specification> for information on the format of
+hardware addresses and specifying links.
+
+For soft records, the INP field can be a constant, a database link, or a channel
+access link. For soft records, the DTYP field should specify C<Soft Channel>.
+
+=fields INP, DTYP
+
+=cut
+
+	field(INP,DBF_INLINK) {
+		prompt("Input Specification")
+		promptgroup("40 - Input")
+		interest(1)
+	}
+
+=head3 Operator Display Parameters
+
+See L<Fields Common to All Record Types> for more on the record name (NAME) and
+description (DESC) fields.
+
+=fields NAME, DESC
+
+=head3 Alarm Parameters
+
+The Event record has the alarm parameters common to all record types. L<Alarm
+Fields> lists other fields related to alarms that are common to all record
+types.
+
+=head3 Simulation Mode Parameters
+
+The following fields are used to operate the event record in the simulation
+mode.  See L<Fields Common to Many Record Types> for more information on these
+fields.
+
+=fields SIOL, SVAL, SIML, SIMM, SIMS
+
+=cut
+
+	field(SIOL,DBF_INLINK) {
+		prompt("Sim Input Specifctn")
+		promptgroup("90 - Simulate")
+		interest(1)
+	}
+	field(SVAL,DBF_STRING) {
+		prompt("Simulation Value")
+		size(40)
+	}
+	field(SIML,DBF_INLINK) {
+		prompt("Sim Mode Location")
+		promptgroup("90 - Simulate")
+		interest(1)
+	}
+	field(SIMM,DBF_MENU) {
+		prompt("Simulation Mode")
+		interest(1)
+		menu(menuYesNo)
+	}
+	field(SIMS,DBF_MENU) {
+		prompt("Sim mode Alarm Svrty")
+		promptgroup("90 - Simulate")
+		interest(2)
+		menu(menuAlarmSevr)
+	}
+
+=head2 Record Support
+
+=head3 Record Support Routines
+
+=head4 init_record
+
+This routine initializes SIMM with the value of SIML if SIML type is a CONSTANT
+link or creates a channel access link if SIML type is PV_LINK. SVAL is likewise
+initialized if SIOL is CONSTANT or PV_LINK.
+
+If device support includes C<init_record()>, it is called.
+
+=head4 process
+
+See next section.
+
+=head3 Record Processing
+
+Routine process implements the following algorithm:
+
+=over
+
+=item 1.
+
+readValue is called. See L<Input Records> for more information.
+
+=item 2.
+
+If PACT has been changed to TRUE, the device support read routine has started
+but has not completed reading a new input value. In this case, the processing
+routine merely returns, leaving PACT TRUE.
+
+=item 3.
+
+If VAL E<gt> 0, post event number VAL.
+
+=item 4.
+
+Check to see if monitors should be invoked. Alarm monitors are invoked if the
+alarm status or severity has chanet to 0.
+
+=item 5.
+
+Scan forward link if necessary, set PACT FALSE, and return.
+
+=back
+
+=head2 Device Support
+
+=head3 Fields of Interest To Device Support
+
+Each record must have an associated set of device support routines. The device
+support routines are primarily interested in the following fields:
+
+=fields PACT, DPVT, UDF, NSEV, NSTA, INP, PRIO
+
+=head3 Device Support Routines
+
+Device support consists of the following routines:
+
+=head4 long report(int level)
+
+This optional routine is called by the IOC command C<dbior> and is passed the
+report level that was requested by the user.
+It should print a report on the state of the device support to stdout.
+The C<level> parameter may be used to output increasingly more detailed
+information at higher levels, or to select different types of information with
+different levels.
+Level zero should print no more than a small summary.
+
+=head4 long init(int after)
+
+This optional routine is called twice at IOC initialization time.
+The first call happens before any of the C<init_record()> calls are made, with
+the integer parameter C<after> set to 0.
+The second call happens after all of the C<init_record()> calls have been made,
+with C<after> set to 1.
+
+=head4 init_record
+
+  init_record(precord)
+
+This routine is optional. If provided, it is called by the record support
+C<init_record()> routine.
+
+=head4 get_ioint_info
+
+  get_ioint_info(int cmd, struct dbCommon *precord, IOSCANPVT *ppvt)
+
+This routine is called by the ioEventScan system each time the record is added
+or deleted from an I/O event scan list. cmd has the value (0,1) if the record is
+being (added to, deleted from) an I/O event list. It must be provided for any
+device type that can use the ioEvent scanner.
+
+=head4 read_event
+
+  read_event(precord)
+
+This routine returns the following values:
+
+=over
+
+=item *
+
+0: Success.
+
+=item *
+
+Other: Error.
+
+=back
+
+=head3 Device Support For Soft Records
+
+The C<Soft Channel> device support module is available. The INP link type must
+be either CONSTANT, DB_LINK, or CA_LINK.
+
+If the INP link type is CONSTANT, then the constant value is stored into VAL by
+C<init_record()>, and UDF is set to FALSE. If the INP link type is PV_LINK, then
+dbCaAddInlink is called by C<init_record()>.
+
+C<read_event> calls recGblGetLinkValue to read the current value of VAL. See
+L<Input Records> for details on soft input.
+
+=cut
+
+}

src/std/rec/fanoutRecord.dbd

@@ -1,129 +0,0 @@
-#*************************************************************************
-# Copyright (c) 2012 UChicago Argonne LLC, as Operator of Argonne
-#     National Laboratory.
-# Copyright (c) 2002 The Regents of the University of California, as
-#     Operator of Los Alamos National Laboratory.
-# EPICS BASE is distributed subject to a Software License Agreement found
-# in file LICENSE that is included with this distribution. 
-#*************************************************************************
-menu(fanoutSELM) {
-	choice(fanoutSELM_All,"All")
-	choice(fanoutSELM_Specified,"Specified")
-	choice(fanoutSELM_Mask,"Mask")
-}
-recordtype(fanout) {
-	include "dbCommon.dbd" 
-	field(VAL,DBF_LONG) {
-		prompt("Used to trigger")
-		asl(ASL0)
-		pp(TRUE)
-	}
-	field(SELM,DBF_MENU) {
-		prompt("Select Mechanism")
-		promptgroup("30 - Action")
-		interest(1)
-		menu(fanoutSELM)
-	}
-	field(SELN,DBF_USHORT) {
-		prompt("Link Selection")
-		interest(1)
-		initial("1")
-	}
-	field(SELL,DBF_INLINK) {
-		prompt("Link Selection Loc")
-		promptgroup("30 - Action")
-		interest(1)
-	}
-	field(OFFS,DBF_SHORT) {
-		prompt("Offset for Specified")
-                promptgroup("30 - Action")
-                interest(1)
-		initial("0")
-	}
-	field(SHFT,DBF_SHORT) {
-		prompt("Shift for Mask mode")
-                promptgroup("30 - Action")
-                interest(1)
-		initial("-1")
-	}
-	field(LNK0,DBF_FWDLINK) {
-		prompt("Forward Link 0")
-		promptgroup("51 - Output 0-7")
-		interest(1)
-	}
-	field(LNK1,DBF_FWDLINK) {
-		prompt("Forward Link 1")
-		promptgroup("51 - Output 0-7")
-		interest(1)
-	}
-	field(LNK2,DBF_FWDLINK) {
-		prompt("Forward Link 2")
-		promptgroup("51 - Output 0-7")
-		interest(1)
-	}
-	field(LNK3,DBF_FWDLINK) {
-		prompt("Forward Link 3")
-		promptgroup("51 - Output 0-7")
-		interest(1)
-	}
-	field(LNK4,DBF_FWDLINK) {
-		prompt("Forward Link 4")
-		promptgroup("51 - Output 0-7")
-		interest(1)
-	}
-	field(LNK5,DBF_FWDLINK) {
-		prompt("Forward Link 5")
-		promptgroup("51 - Output 0-7")
-		interest(1)
-	}
-	field(LNK6,DBF_FWDLINK) {
-		prompt("Forward Link 6")
-		promptgroup("51 - Output 0-7")
-		interest(1)
-	}
-	field(LNK7,DBF_FWDLINK) {
-		prompt("Forward Link 7")
-		promptgroup("51 - Output 0-7")
-		interest(1)
-	}
-	field(LNK8,DBF_FWDLINK) {
-		prompt("Forward Link 8")
-		promptgroup("52 - Output 8-F")
-		interest(1)
-	}
-	field(LNK9,DBF_FWDLINK) {
-		prompt("Forward Link 9")
-		promptgroup("52 - Output 8-F")
-		interest(1)
-	}
-	field(LNKA,DBF_FWDLINK) {
-		prompt("Forward Link 10")
-		promptgroup("52 - Output 8-F")
-		interest(1)
-	}
-	field(LNKB,DBF_FWDLINK) {
-		prompt("Forward Link 11")
-		promptgroup("52 - Output 8-F")
-		interest(1)
-	}
-	field(LNKC,DBF_FWDLINK) {
-		prompt("Forward Link 12")
-		promptgroup("52 - Output 8-F")
-		interest(1)
-	}
-	field(LNKD,DBF_FWDLINK) {
-		prompt("Forward Link 13")
-		promptgroup("52 - Output 8-F")
-		interest(1)
-	}
-	field(LNKE,DBF_FWDLINK) {
-		prompt("Forward Link 14")
-		promptgroup("52 - Output 8-F")
-		interest(1)
-	}
-	field(LNKF,DBF_FWDLINK) {
-		prompt("Forward Link 15")
-		promptgroup("52 - Output 8-F")
-		interest(1)
-	}
-}

src/std/rec/fanoutRecord.dbd.pod

@@ -0,0 +1,314 @@
+#*************************************************************************
+# Copyright (c) 2012 UChicago Argonne LLC, as Operator of Argonne
+#     National Laboratory.
+# Copyright (c) 2002 The Regents of the University of California, as
+#     Operator of Los Alamos National Laboratory.
+# EPICS BASE is distributed subject to a Software License Agreement found
+# in file LICENSE that is included with this distribution. 
+#*************************************************************************
+
+=title Fanout Record (fanout)
+
+The fanout record uses several forward processing links to force multiple
+passive records to scan. When more than one record needs to be scanned as the
+result of a record being processed, the forward link of that record can specify
+a fanout record. The fanout record can specify up to sixteen other records to
+process. If more than sixteen are needed, one of the forward links in the fanout
+record (or its FLNK field) can point to another fanout record.
+
+B<NOTE: Fanout records only propagate processing, not data.> The dfanout or
+data fanout record can, on the other hand, send data to other records.
+
+=head2 Parameter Fields
+
+The fanout record's fields fall into the following categories:
+
+=over
+
+=item *
+
+scan parameters
+
+=item *
+
+operator display parameters
+
+=item *
+
+run-time parameters.
+
+=back
+
+=recordtype fanout
+
+=cut
+
+menu(fanoutSELM) {
+	choice(fanoutSELM_All,"All")
+	choice(fanoutSELM_Specified,"Specified")
+	choice(fanoutSELM_Mask,"Mask")
+}
+
+recordtype(fanout) {
+	include "dbCommon.dbd"
+
+=head3 Scan Parameters
+
+The forward link fields of the fanout record (LNK0-LNK9, LNKA-LNKF) specify
+records to be scanned. The records to be processed must specify C<Passive> in
+their SCAN fields; otherwise the forward link will not cause them to process.
+Also when specifying database links for the fanout record, the user needs only
+to specify the record name. As no value is being sent or retrieved, a field name
+is only required when the link will be over Channel Access, in which case the
+field PROC must be named.
+
+The SELM, SELN, and SELL fields specify the order of processing for the forward
+links. The select mechanism menu field (SELM) has three choices:
+
+=menu fanoutSELM
+
+How the SELM value affects which links to process and in which order is as
+follows:
+
+=over
+
+=item *
+
+B<All>
+Links are processed in numerical order - LNK0, LNK1, etc.
+
+=item *
+
+B<Specified> The sum of the values in the SELN and OFFS fields is used as the
+specifier of which link to process. For instance, with OFFS=0 and SELN=1, the
+record targeted by LNK1 will be processed.
+
+=item *
+
+B<Mask> The individual bits in SELN are shifted by SHFT bits (negative means
+shift left) and the result used to select which links to process as follows:
+
+=over
+
+=item *
+
+If bit 0 (LSB) is set, LNK0 is processed.
+
+=item *
+
+If bit 1 is set, LNK2 is processed.
+
+=item *
+
+If bit 2 is set, LNK3 is processed, etc.
+
+=back
+
+=back
+
+SELN reads its value from SELL. SELL can be a constant, a database link, or a
+channel access link.  If a constant, SELN is initialized with the constant value
+and can be changed via dbPuts. For database/channel access links, SELN is
+retrieved from SELL each time the record is processed and can also be changed
+via dbPuts.
+
+The Fanout record also has the standard scanning fields common to all records.
+These fields are listed in L<Scan Fields>. In addition,
+L<Scanning Specification> explains in more detail how forward links and the
+scanning algorithms work.
+
+=fields SELM, SELN, SELL, OFFS, SHFT, LNK0, LNK1, LNK2, LNK3, LNK4, LNK5, LNK6, LNK7, LNK8, LNK9, LNKA, LNKB, LNKC, LNKD, LNKE, LNKF
+
+=cut
+
+	field(VAL,DBF_LONG) {
+		prompt("Used to trigger")
+		asl(ASL0)
+		pp(TRUE)
+	}
+	field(SELM,DBF_MENU) {
+		prompt("Select Mechanism")
+		promptgroup("30 - Action")
+		interest(1)
+		menu(fanoutSELM)
+	}
+	field(SELN,DBF_USHORT) {
+		prompt("Link Selection")
+		interest(1)
+		initial("1")
+	}
+	field(SELL,DBF_INLINK) {
+		prompt("Link Selection Loc")
+		promptgroup("30 - Action")
+		interest(1)
+	}
+	field(OFFS,DBF_SHORT) {
+		prompt("Offset for Specified")
+                promptgroup("30 - Action")
+                interest(1)
+		initial("0")
+	}
+	field(SHFT,DBF_SHORT) {
+		prompt("Shift for Mask mode")
+                promptgroup("30 - Action")
+                interest(1)
+		initial("-1")
+	}
+	field(LNK0,DBF_FWDLINK) {
+		prompt("Forward Link 0")
+		promptgroup("51 - Output 0-7")
+		interest(1)
+	}
+	field(LNK1,DBF_FWDLINK) {
+		prompt("Forward Link 1")
+		promptgroup("51 - Output 0-7")
+		interest(1)
+	}
+	field(LNK2,DBF_FWDLINK) {
+		prompt("Forward Link 2")
+		promptgroup("51 - Output 0-7")
+		interest(1)
+	}
+	field(LNK3,DBF_FWDLINK) {
+		prompt("Forward Link 3")
+		promptgroup("51 - Output 0-7")
+		interest(1)
+	}
+	field(LNK4,DBF_FWDLINK) {
+		prompt("Forward Link 4")
+		promptgroup("51 - Output 0-7")
+		interest(1)
+	}
+	field(LNK5,DBF_FWDLINK) {
+		prompt("Forward Link 5")
+		promptgroup("51 - Output 0-7")
+		interest(1)
+	}
+	field(LNK6,DBF_FWDLINK) {
+		prompt("Forward Link 6")
+		promptgroup("51 - Output 0-7")
+		interest(1)
+	}
+	field(LNK7,DBF_FWDLINK) {
+		prompt("Forward Link 7")
+		promptgroup("51 - Output 0-7")
+		interest(1)
+	}
+	field(LNK8,DBF_FWDLINK) {
+		prompt("Forward Link 8")
+		promptgroup("52 - Output 8-F")
+		interest(1)
+	}
+	field(LNK9,DBF_FWDLINK) {
+		prompt("Forward Link 9")
+		promptgroup("52 - Output 8-F")
+		interest(1)
+	}
+	field(LNKA,DBF_FWDLINK) {
+		prompt("Forward Link 10")
+		promptgroup("52 - Output 8-F")
+		interest(1)
+	}
+	field(LNKB,DBF_FWDLINK) {
+		prompt("Forward Link 11")
+		promptgroup("52 - Output 8-F")
+		interest(1)
+	}
+	field(LNKC,DBF_FWDLINK) {
+		prompt("Forward Link 12")
+		promptgroup("52 - Output 8-F")
+		interest(1)
+	}
+	field(LNKD,DBF_FWDLINK) {
+		prompt("Forward Link 13")
+		promptgroup("52 - Output 8-F")
+		interest(1)
+	}
+	field(LNKE,DBF_FWDLINK) {
+		prompt("Forward Link 14")
+		promptgroup("52 - Output 8-F")
+		interest(1)
+	}
+	field(LNKF,DBF_FWDLINK) {
+		prompt("Forward Link 15")
+		promptgroup("52 - Output 8-F")
+		interest(1)
+	}
+
+=head3 Operator Display Parameters
+
+These parameters are used to present meaningful data to the operator. See
+L<Fields Common to All Record Types> for more on these fields.
+
+=fields NAME, DESC
+
+=head3 Alarm Parameters
+
+The Fanout record has the alarm parameters common to all record types.
+L<Alarm Fields> lists other fields related to a alarms that are common to all
+record types.
+
+=head3 Run-time Parameters
+
+The VAL field performs no specific function, but a Channel Access put to it will
+cause the record to process.
+
+=fields VAL
+
+=head2 Record Support
+
+=head3 Record Support Routines
+
+=head4 init_record
+
+This routine initializes SELN with the value of SELL, if SELL type is CONSTANT
+link, or creates a channel access link if SELL type is PV_LINK.
+
+=head4 process
+
+See next section.
+
+=head3 Record Processing
+
+Routine process implements the following algorithm:
+
+=over
+
+=item 1.
+
+PACT is set to TRUE.
+
+=item 2.
+
+The link selection SELN is fetched.
+
+=item 3.
+
+Depending on the selection mechanism, the link selection forward links are
+processed, and UDF is set to FALSE.
+
+=item 4.
+
+Check to see if monitors should be invoked:
+
+=over
+
+=item *
+
+Alarm monitors are invoked if the alarm status or severity has changed.
+
+=item *
+
+NSEV and NSTA are reset to 0.
+
+=back
+
+=item 5.
+
+Scan forward link field FLNK if used, set PACT FALSE, and return.
+
+=back
+
+=cut
+
+}