EPICS Base 3.15.0.x releases are not intended for use in production systems.
adds calls to handle 8, 16, and 32 bit Memory Mapped I/O reads and writes. The calls added include X_iowriteY() and X_ioreadY(). Where X is nat (native), be, or le, and Y is 16 or 32. Also added are ioread8() and iowrite8().
tapfiles
This new make target runs the same tests as the runtests
target, but
instead of summarizing or displaying the output for each test script it creates
a .tap
file inside the architecture build directory which contains the
detailed test output. The output file can be parsed by continuous integration
packages such as Jenkins to show the
test results.
Array data can now be moved, without copying, into and out of the VAL field of the waveform, aai, and aao record types by replacing the pointer in BPTR. The basic rules which device support must follow are:
The new header file epicsSpin.h adds a portable spin-locks API which is intended for locking very short sections of code (typically one or two lines of C or C++) to provide a critical section that protects against race conditions. On Posix platforms this uses the pthread_spinlock_t type if it's available but falls back to a pthread_mutex_t if not; on the UP VxWorks and RTEMS platforms the implementations lock out the CPU interrupts; the default implementation (used where no better implementation is available for the platform) uses an epicsMutex. Spin-locks may not be taken recursively, and the code inside the critical section should always be short and deterministic.
The libCom routine aToIPAddr() and the vxWorks implementation of the associated hostToIPAddr() function have been modified to be able to look up hostnames that begin with one or more digits. The epicsSockResolveTest program was added to check this functionality.
These record types have undergone some significant rework, and will behave slightly differently than they did in their 3.14 versions. The externally visible changes are as follows:
supervisoryand UDF is clear the fields B0-BF will be set from the current VAL field.
supervisory, the fields B0-BF will be set from the current VAL field. This did not used to happen, the individual bit fields were previously never modified by the record. Note that this change may require some databases to be modified, if they were designed to take advantage of the previous behavior.
A new routine has been added to the errlog facility which allows the console error message stream to be redirected from stderr to some other already open file stream:
int errlogSetConsole(FILE *stream);
The stream argument must be a FILE* pointer as returned by fopen() that is open for output. If NULL is passed in, the errlog thread's stderr output stream will be used instead. Note that messages to the console can be disabled and re-enabled using the eltc routine which is also an iocsh command, but there is no iocsh command currently provided for calling errlogSetConsole.
An aSub routine may set the CADR field with a function pointer which will be run before a new routine in the event that a change to the SNAM field changes the record's process subroutine.
This can be used to free any resources the routine needs to allocate. It can also be used to determine if this is the first time this routine has been called by this record instance. The CADR field is set to NULL immediately after the routine it points to is called.
Example:
void cleanup(aSubRecord* prec) { free(prec->dpvt); prec->dpvt = NULL; } long myAsubRoutine(aSubRecord* prec) { if (!prec->cadr) { /* check types of inputs and outputs */ if (prec->ftva != menuFtypeDOUBLE) return 1; /* oops */ dpvt = malloc(42); prec->cadr = &cleanup; } /* normal processing */ } epicsRegisterFunction(myAsubRoutine);
The sequence record type now has 16 link groups numbered 0 through 9 and A through F, instead of the previous 10 groups numbered 1 through 9 and A. The changes to this record are directly equivalent to those described below for the fanout record. The fields OFFS and SHFT have been added and operate on the SELN value exactly the same way. The result is backwards compatible with the 3.14 version of the sequence record as long as none of the new fields are modified and the application does not rely on the SOFT/INVALID alarm that was generated when the selection number exceeded 10. The record also now posts monitors on the SELN field at the end of the sequence if its value changed when read through the SELL link.
The fanout record type now has 16 output links LNK0-LNK9 and LNKA-LNKF, plus two additional fields which make the result backwards compatible with 3.14 databases, but also allow the link selection to be shifted without having to process the SELN value through a calc or calcout record first.
Previously there was no LNK0 field, so when SELM is Mask
bit 0 of SELN
controls whether the LNK1 link field was activated; bit 1 controls LNK2 and so
on. When SELM is Specified
and SELN is zero no output link would be
activated at all; LNK1 gets activated when SELN is 1 and so on. Only 6 links
were provided, LNK1 through LNK6. The updated record type maintains the original
behavior when the new fields are not configured, except that the SOFT/INVALID
alarm is not generated when SELN is 7 through 15.
The update involved adding a LNK0 field, as well as fields LNK7 through LNK9 and LNKA through LNKF. To add flexibility and maintain backwards compatibility, two additional fields have been added:
Specified. If the resulting value is outside the range 0 .. 15 the record will go into a SOFT/INVALID alarm state. The default value of OFFS is zero, so if it is not explicitly set and SELN is 1 the LNK1 link will be activated.
Maskthe signed field SHFT is used to shift the SELN value by SHFT bits (positive means right-wards, values outside the range -15 .. 15 will result in a SOFT/INVALID alarm), before using the resulting bit-pattern to control which links to activate. The default value is -1, so if SHFT is not explicitly set bit 0 of SELN will be used to control whether LNK1 gets activated.
The record also now posts monitors on the SELN field if it changes as a result of record processing (i.e. when read through the SELL link).
Java has its own build systems now, so we've deleted the rules and associated variables from Base, although they might get added to the Extensions build rules for a while in case anyone still needs them.
The clean Makefile target has changed between a single-colon rule and a double-colon rule more than once in the life of the EPICS build rules, and it just changed back to a single-colon rule, but now we recommend that applications that wish to provide a Makefile that is backwards compatible with the 3.14 build rules use the construct shown below. The 3.15 rules now support a variable called CLEANS to which a Makefile can add a list of files to be deleted when the user does a make clean like this:
CLEANS += <list of files to be cleaned> ifndef BASE_3_15 clean:: $(RM) $(CLEANS) endif
The conditional rule provides compatibility for use with the 3.14 build system.
An enhanced version of the Macro Substitution and Include program msi
has been included with Base. Both this new version of msi and the IOC's
dbLoadTemplates command now support setting global macros in
substitution files, and dbLoadTemplates can now take a list of global
macro settings as the second argument on its command line. The substitution file
syntax is documented in the Application Developers Guide.
Some Linux distributions now package the MinGW cross-compiler which makes it possible to cross-build the win32-x86-mingw target from a linux-x86 host. Build configuration files for this combination are now included; adjust the settings in configure/os/CONFIG_SITE.linux-x86.win32-x86-mingw and add win32-x86-mingw to the CROSS_COMPILER_TARGET_ARCHS variable in configure/CONFIG_SITE or in configure/os/CONFIG_SITE.linux-x86.Common.
The ability to compile non-cygwin binaries using the Cygwin build tools is no longer supported by current versions of Cygwin, so this architecture has been removed. Use the MinWG tools and the win32-x86-mingw architecture instead.
The original libCom test harness has been renamed libComTestHarness, and two additional test harnesses have been created dbTestHarness and filterTestHarness which are all built for RTEMS and vxWorks targets. The new ones include tests in src/ioc/db/test and src/std/filters/test.
Running the new tests requires additional .db and .dbd files to be loaded at runtime, which can be found in the relevant source directory or its O.Common subdirectory. If the target can access the Base source tree directly it may be simplest to cd to the relevant source directory before running the test. If not, the files needed are listed in the generated 'testspec' file found in the associated build (O.arch) directory.
For RTEMS users the current directory is determined in a BSP specific way. See rtems_init.c and setBootConfigFromNVRAM.c in src/libCom/RTEMS.
A hook API has been added allowing user-supplied functions to be called whenever a thread starts. The calls are made from the thread's context, and can be used to control additional thread properties not handled inside EPICS base, e.g. setting the scheduling policy or CPU affinity (on SMP systems).
The API also supports a mapping operation, calling a user-supplied function for every thread that is currently running.
Scan rates defined in the menuScan.dbd file may now be specified in seconds, minutes, hours or Hertz, and plural time units will also be accepted (seconds are used if no unit is mentioned in the choice string). At iocInit each scan rate is compared with the OS's clock tick and a warning printed if the rate is too fast or likely to be more than 10% different to the requested rate. For example the rates given below are all valid, although non-standard (the default menuScan choices that come with Base have not been changed):
menu(menuScan) { choice(menuScanPassive, "Passive") choice(menuScanEvent, "Event") choice(menuScanI_O_Intr, "I/O Intr") choice(menuScan1_hour, "1 hour") choice(menuScan0_5_hours, "0.5 hours") choice(menuScan15_minutes, "15 minutes") choice(menuScan5_minutes, "5 minutes") choice(menuScan1_minute, "1 minute") choice(menuScan10_seconds, "10 seconds") choice(menuScan5_seconds, "5 seconds") choice(menuScan2_seconds, "2 seconds") choice(menuScan1_second, "1 second") choice(menuScan2_Hertz, "2 Hertz") choice(menuScan5_Hertz, "5 Hertz") choice(menuScan10_Hertz, "10 Hz") }
The record types ai, calc, longin and mbbi have a new alarm filter added to them. This provides a low-pass filter that can be used to delay the reporting of alarms caused by the input level passing the HIGH, HIHI, LOW or LOLO values. The filter is controlled with a new AFTC field that sets the filter's time constant. The default value for this field is zero, which keeps the record's original alarm behaviour.
The record must be scanned often enough for the filtering action to work effectively and the alarm severity can only change when the record is processed, but that processing does not have to be regular; the filter uses the time since the record last processed in its calculation. Setting AFTC to a positive number of seconds will delay the record going into or out of a minor alarm severity or from minor to major severity until the input signal has been in that range for that number of seconds.
When the record type or device support modify the NORD field of a waveform record, the record support code now posts DBE_VALUE and DBE_LOG events for that field, signalling the array length change to any client monitoring the NORD field.
Non-VAL fields now report meaningful information for precision, units, graphic limits, control limits, and alarm limits instead of simply using PREC, EGU, HOPR, LOPR, DRVL, DRVH, HIHI, HIGH, LOW, and LOLO. All delay fields have a default precision of 2 digits, units "s" and control limits of 0 to 100,000 seconds (these precision and limit values can be changed for each record type as a whole at runtime by updating a registered global variable). Input fields like A-L of the calc record read their metadata from the corresponding INPn link if possible.
The definitions from the header file epicsStdioRedirect.h have been moved into epicsStdio.h so all calls to printf(), puts() and putchar() in files that include that OSI header will now be subject to stdout redirection. In past releases (3.14.7 and later) it was necessary to request the redirection support by including the epicsStdioRedirect.h header file. The header file is still provided, but now it just includes epicsStdio.h.
Soft events can now be given meaningful names instead of just using the numbers 1-255. The EVNT field is now a DBF_STRING. The post_event() API is now deprecated but still works. It should be replaced by code that in advance looks up the EVNTPVT event handle associated with the named event by calling eventNameToHandle(char *), and when that event occurs passes that handle to the new postEvent(EVNTPVT) routine (which may be called from interrupt level). A new iocsh command postEvent name will trigger a named event from the command-line or a startup script (on vxWorks the expression postEvent(eventNameToHandle("name")) must be used instead though).
As EPICS sites get computers with more CPUs they report additional bugs in our parallel build rules. Various issues have been fixed by separating out the build rules that generate dependency (.d) files, ensuring that they are constructed at the appropriate time in the build.
These rule changes can cause additional warning messages to appear when building support modules. Where an application provides its own Makefile rules it may now have to add rules to construct an associated dependency file. In many cases though the change needed is just to replace a dependency for a target$(OBJ) with the target$(DEP) so this
myLib$(OBJ): myLib_lex.c
becomes
myLib$(DEP): myLib_lex.c
To debug build issues assocated with dependency files, use the command make --debug=m which tells GNUmake to display information about what it is doing during the first pass when it updates its makefiles.
The deprecated tsDefs API was provided for 3.13 compatibility only, and has now been removed. Convert any remaining code that used it to call the epicsTime API instead.
The two macros EPICS_UPDATE_LEVEL and EPICS_CVS_SNAPSHOT have been deleted from the epicsVersion.h file; they were deprecated in R3.14 and can be replaced with EPICS_PATCH_LEVEL and EPICS_DEV_SNAPSHOT respectively.
A new pair of macros has been added to make version number comparisons easier. Code that will not work with a version of Base before 3.15.0 can now be written like this to prevent it from compiling:
#if defined(VERSION_INT) && EPICS_VERSION_INT < VERSION_INT(3,15,0,0) # error EPICS Base R3.15.0 or later is required #endif
Added a iocLogPrefix
command to iocsh
. This adds a
prefix to all messages from this IOC (or other log client) as they get sent to the
iocLogServer. This lets sites use the "fac=<facility>" syntax for
displaying the facility, process name etc. in log viewers like the
cmlogviewer
.
The histogram record was not included in the base.dbd file in any 3.14 release, but has now been added along with its associated soft device support. The build system now generates the list of all the record.dbd files in base automatically in src/std/rec/Makefile.
Reorganization of subdirectories of src/ to better represent the relation between different parts as described in the following table.
This change also allows the number of libraries built to be reduced to: libCap5.so, libca.so, libdbCore.so, libdbStaticHost.so, libCom.so, libcas.so, libdbRecStd.so, and libgdd.so
Component | Dependency | Library name | Description |
---|---|---|---|
src/tools | Build system scripts | ||
src/libCom | src/tools | Com | Utility routines and OS-independant API |
src/template | src/tools | User application templates (e.g. makeBaseApp) | |
src/ca/client | src/libCom | ca | Channel Access client |
src/ca/legacy/gdd | src/ca/client | gdd | Generic data layer for PCAS |
src/ca/legacy/pcas | src/ca/legacy/gdd | cas | Portable Channel Access Server |
src/ioc | src/ca | dbCore | Core database processing functions |
src/std | src/ioc | dbRecStd | Standard records, soft device support and the softIoc |
In order to better reflect these relations the following directories and files were moved as described:
Relocations | |
---|---|
Previous | New |
libCom | |
src/RTEMS | src/libCom/RTEMS |
src/toolsComm/flex | src/libCom/flex |
src/toolsComm/antelope | src/libCom/yacc |
src/dbStatic/alarm.h .../alarmString.h |
src/libCom/misc/ |
IOC Core Components | |
src/bpt | src/ioc/bpt |
src/db | src/ioc/db |
src/dbStatic | src/ioc/dbStatic |
src/dbtools | src/ioc/dbtemplate |
src/misc | src/ioc/misc |
src/registry | src/ioc/registry |
src/rsrv | src/ioc/rsrv 1 |
Standard Record Definitions | |
src/dev/softDev | src/std/dev |
src/rec | src/std/rec |
src/softIoc | src/std/softIoc |
Channel Access | |
src/ca | src/ca/client |
src/catools | src/ca/client/tools |
src/cap5 | src/ca/client/perl |
src/gdd | src/ca/legacy/gdd |
src/cas | src/ca/legacy/pcas |
src/excas | src/ca/legacy/pcas/ex |
User Templates | |
src/makeBaseApp | src/template/base |
src/makeBaseExt | src/template/ext |
Dispersed | |
src/util 2 | src/ca/client |
src/ca/client/test | |
src/libCom/log | |
src/as 3 | src/libCom/as |
src/ioc/as |
1 RSRV is built as part of dbCore due to its tight (bidirectional) coupling with the other database code.
2 The contents for src/util/ moved to three locations. The caRepeater init script was moved to src/ca/client/. ca_test is now in src/ca/client/test/. The iocLogServer was moved into the same directory (src/libCom/log) as the log client code.
3 The Access Security code has been divided, with the parts not related to the database (lexer/parser and trap registration) becoming part of libCom. The remaining components are included in the dbCore library
These files are now found under src/RTEMS.
Removed the 3.13 <top>/config directory and build compatibility rules and variables, and various conversion documents.