RRM 3-14 Subroutine

EPICS Record Reference Manual

sub - Subroutine

The subroutine record is used to call a C initialization routine and a recurring scan routine. There is no device support for this record.

Parameter Fields

The fields fall into several categories:

• scan parameters
• read parameters
• subroutine connection parameters
• operator display parameters
• alarm parameters
• monitor parameters
• run-time parameters.

Scan Parameters

The subroutine record has the standard fields for specifying under what circumstances it will be processed. These fields are listed in Scan Fields. In addition, Scanning Specification explains how these fields are used.

Read Parameters

The subroutine record has twelve input links (INPA-INPL), each of which has a corresponding value field (A-L). These fields are used to retrieve and store values that can be passed to the subroutine that the record calls.

The input links can be either channel access or database links, or constants. When constants, the corresponding value field for the link is initialized with the constant value and the field's value can be changed at run-time via dbPuts. Otherwise, the values for (A-F) are fetched from the input links when the record is processed. See Address Specification for information on specifying links.

Field	Summary	Type	DCT	Initial	Access	Modify	Rec Proc Monitor	PP
INPA	Input A	INLINK	Yes	0	No	No	N/A	No
INPB	Input B	INLINK	Yes	0	No	No	N/A	No
INPC	Input C	INLINK	Yes	0	No	No	N/A	No
INPD	Input D	INLINK	Yes	0	No	No	N/A	No
INPE	Input E	INLINK	Yes	0	No	No	N/A	No
INPF	Input F	INLINK	Yes	0	No	No	N/A	No
INPG	Input G	INLINK	Yes	0	No	No	N/A	No
INPH	Input H	INLINK	Yes	0	No	No	N/A	No
INPI	Input F	INLINK	Yes	0	No	No	N/A	No
INPJ	Input H	INLINK	Yes	0	No	No	N/A	No
INPK	Input K	INLINK	Yes	0	No	No	N/A	No
INPL	Input L	INLINK	Yes	0	No	No	N/A	No
A	Value for A	DOUBLE	No	0	Yes	Yes/No	Yes	Yes
B	B Value	DOUBLE	No	0	Yes	Yes/No	Yes	Yes
C	C Value	DOUBLE	No	0	Yes	Yes/No	Yes	Yes
D	D Value	DOUBLE	No	0	Yes	Yes/No	Yes	Yes
E	E Value	DOUBLE	No	0	Yes	Yes/No	Yes	Yes
F	F Value	DOUBLE	No	0	Yes	Yes/No	Yes	Yes
G	G Value	DOUBLE	No	0	Yes	Yes/No	Yes	Yes
H	H Value	DOUBLE	No	0	Yes	Yes/No	Yes	Yes
I	I Value	DOUBLE	No	0	Yes	Yes/No	Yes	Yes
J	J Value	DOUBLE	No	0	Yes	Yes/No	Yes	Yes
K	K Value	DOUBLE	No	0	Yes	Yes/No	Yes	Yes
L	L Value	DOUBLE	No	0	Yes	Yes/No	Yes	Yes

Subroutine Connection

These fields are used to connect to the C subroutine. The name of the subroutine should be entered in the SNAM field.

Field	Summary	Type	DCT	Initial	Access	Modify	Rec Proc Monitor	PP
INAM	Initialization Name	STRING [16]	Yes	Null	Yes	No	No	No
SNAM	Subroutine Name	STRING [16]	Yes	Null	Yes	No	No	No

Operator Display Parameters

These parameters are used to present meaningful data to the operator. They display the value and other parameters of the subroutine either textually or graphically.

EGU is a string of up to 16 characters that could describe any units used by the subroutine record. It is retrieved by the get_units record support routine.

The HOPR and LOPR fields set the upper and lower display limits for the VAL, A-L, LA-LL, HIHI, LOLO, LOW, and HIGH fields. Both the get_graphic_double and get_control_double record support routines retrieve these fields.

The PREC field determines the floating point precision with which to display VAL. It is used whenever the get_precision record support routine is called.

See Fields Common to All Record Types for more on the record name (NAME) and description (DESC) fields.

Field	Summary	Type	DCT	Initial	Access	Modify	Rec Proc Monitor	PP
EGU	Engineering Units	STRING [16]	Yes	null	Yes	Yes	No	No
HOPR	High Operating Range	FLOAT	Yes	0	Yes	Yes	No	No
LOPR	Low Operating Range	FLOAT	Yes	0	Yes	Yes	No	No
PREC	Display Precision	SHORT	Yes	0	Yes	Yes	No	No
NAME	Record Name	STRING [29]	Yes	0	Yes	No	No	No
DESC	Description	STRING [29]	Yes	Null	Yes	Yes	No	No

Alarm Parameters

The possible alarm conditions for subroutine records are the SCAN, READ, limit alarms, and an alarm that can be triggered if the subroutine returns a negative value. The SCAN and READ alarms are called by the record or device support routines. The limit alarms are configured by the user in the HIHI, LOLO, HIGH, and LOW fields using numerical values. They apply to the VAL field. For each of these fields, there is a corresponding severity field which can be either NO_ALARM, MINOR, or MAJOR.

The BRSV field is where the user can set the alarm severity in case the subroutine returns a negative value. See Alarm Specification for a complete explanation of alarms and these fields. Alarm Fields lists other fields related to a alarms that are common to all record types.

Field	Summary	Type	DCT	Initial	Access	Modify	Rec Proc Monitor	PP
HIHI	Hihi Alarm Limit	FLOAT	Yes	0	Yes	Yes	No	Yes
HIGH	High Alarm Limit	FLOAT	Yes	0	Yes	Yes	No	Yes
LOW	Low Alarm Limit	FLOAT	Yes	0	Yes	Yes	No	Yes
LOLO	Lolo Alarm Limit	FLOAT	Yes	0	Yes	Yes	No	Yes
HHSV	Hihi Alarm Severity	GBLCHOICE	Yes	0	Yes	Yes	No	Yes
HSV	High Alarm Severity	GBLCHOICE	Yes	0	Yes	Yes	No	Yes
LSV	Low Alarm Severity	GBLCHOICE	Yes	0	Yes	Yes	No	Yes
LLSV	Lolo Alarm Severity	GBLCHOICE	Yes	0	Yes	Yes	No	Yes
BRSV	Severity for a subroutine return value less than 0.	GBLCHOICE	Yes	0	Yes	Yes	No	Yes
HYST	Alarm Deadband	DOUBLE	Yes	0	Yes	Yes	No	No

Monitor Parameters

These parameters are used to determine when to send monitors placed on the VAL field. The appropriate monitors are invoked when VAL differs from the values in the ALST and MLST run-time fields, i.e., when the value of VAL changes by more than the deadband specified in these fields. The ADEL and MDEL fields specify a minimum delta which the change must surpass before the value-change monitors are invoked. If these fields have a value of zero, everytime the value changes, a monitor will be triggered; if they have a value of -1, everytime the record is processed, monitors are triggered. The ADEL field is used by archive monitors and the MDEL field for all other types of monitors. See Monitor Specification for a complete explanation of monitors and deadbands.

Field	Summary	Type	DCT	Initial	Access	Modify	Rec Proc Monitor	PP
ADEL	Archive Deadband	DOUBLE	Yes	0	Yes	Yes	No	No
MDEL	Monitor, i.e. value change, Deadband	DOUBLE	Yes	0	Yes	Yes	No	No

Run-time Parameters

These parameters are used by the run-time code for processing the subroutine record. They are not configured using a database configuration tool. They represent the current state of the record. Many of them are used by the record processing routines or the monitors.

VAL should be set by the subroutine. SADR holds the subroutine address and is set by the record processing routine. STYP, the subroutine symbol type, is also set by the record processing routine.

The rest of these fields--LALM, ALST, MLST, and the LA-LL fields--are used to implement the monitors. For example, when LA is not equal to A, the value-change monitors are called for that field.

Field	Summary	Type	DCT	Initial	Access	Modify	Rec Proc Monitor	PP
VAL	Value Field	DOUBLE	No	0	Yes	Yes	Yes	Yes
SADR	Subroutine Address	NOACCESS	No	0	No	No	No
STYP	Subroutine Symbol Type	SHORT	No	0	Yes	No	No	No
LALM	Last Alarm Monitor Trigger Value	DOUBLE	No	0	Yes	No	No	No
ALST	Last Archiver Monitor Trigger Value	DOUBLE	No	0	Yes	No	No	No
MLST	Last Value Change Monitor Trigger Value	DOUBLE	No	0	Yes	No	No	No
LA	Last A Value	DOUBLE	No	0	Yes	No	No	No
LB	Last B Value	DOUBLE	No	0	Yes	No	No	No
LC	Last C Value	DOUBLE	No	0	Yes	No	No	No
LD	Last D Value	DOUBLE	No	0	Yes	No	No	No
LE	Last E Value	DOUBLE	No	0	Yes	No	No	No
LF	Last F Value	DOUBLE	No	0	Yes	No	No	No
LG	Last G Value	DOUBLE	No	0	Yes	No	No	No
LH	Last H Value	DOUBLE	No	0	Yes	No	No	No
LI	Last I Value	DOUBLE	No	0	Yes	No	No	No
LJ	Last J Value	DOUBLE	No	0	Yes	No	No	No
LK	Last K Value	DOUBLE	No	0	Yes	No	No	No
LL	Last L Value	DOUBLE	No	0	Yes	No	No	No

Record Support

Record Support Routines

init_record

For each constant input link, the corresponding value field is initialized with the constant value. For each input link that is of type PV_LINK, a channel access link is created.

If an initialization subroutine is defined, it is located and called.

The processing subroutine is located and its address and type stored in SADR and STYP.

process

See next section.

get_value

Fills in the values of struct valueDes so that they refer to VAL.

get_units

Retrieves EGU.

get_precision

Retrieves PREC when VAL is the field being referenced. Otherwise, calls recGblGetPrec().

get_graphic_double

Sets the upper display and lower display limits for a field. If the field is VAL, A-L, LA-LL, HIHI, HIGH, LOW, or LOLO, 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.

get_control_double

Sets the upper control and the lower control limits for a field. If the field is VAL, A-L, LA-LL, HIHI, HIGH, LOW, or LOLO, 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.

get_alarm_double

Sets the following values:

upper_alarm_limit = HIHI
upper_warning_limit = HIGH
lower_warning_limit = LOW
lower_alarm_limit = LOLO

Record Processing

Routine process implements the following algorithm:

1. If PACT is FALSE then fetch all arguments.
2. Call the subroutine and check return value.
   • Call subroutine
   • Set PACT TRUE
   • If return value is 1, return
3. Check alarms. This routine checks to see if the new VAL causes the alarm status and severity to change. If so, NSEV, NSTA and LALM are set. It also honors the alarm hysteresis factor (HYST). Thus the value must change by more than HYST before the alarm status and severity is lowered.
4. Check to see if monitors should be invoked.
   • Alarm monitors are invoked if the alarm status or severity has changed.
   • Archive and value change monitors are invoked if ADEL and MDEL conditions are met.
   • Monitors for A-L are invoked if value has changed.
   • NSEV and NSTA are reset to 0.
5. Scan forward link if necessary, set PACT FALSE, and return.

Example Synchronous Subroutine

This is an example subroutine that merely increments VAL each time process is called.

#include <vxWorks.h>
#include <types.h>
#include <stdioLib.h>
#include <dbDefs.h>
#include <subRecord.h>
#include <dbCommon.h>
#include <recSup.h>

long subInit(struct subRecord *psub)
{
    printf("subInit was called\n");
    return(0);
}

long subProcess(struct subRecord *psub)
{
    psub->val++;
    return(0);
}

Example Asynchronous Subroutine

This example shows an asynchronous subroutine. It uses (actually misuses) fields A and B. Field A is taken as the number of seconds until asynchronous completion. Field B is a flag to decide if messages should be printed. Lets assume A > 0 and B = 1. The following sequence of actions will occcur:

1. subProcess is called with pact FALSE. It performs the following steps.
   • Computes, from A, the number of ticks until asynchronous completion should occur.
   • Prints a message stating that it is requesting an asynchronous callback.
   • Calls the vxWorks watchdog start routine.
   • Sets pact TRUE and returns a value of 0. This tells record support to complete without checking alarms, monitors, or the forward link.
2. When the time expires, the system wide callback task calls myCallback. myCallback locks the record, calls process, and unlocks the record.
3. Process again calls subProcess, but now pact is TRUE. Thus the following is done:
   • VAL is incremented.
   • A completion message is printed.
   • subProcess returns 0. The record processing routine will complete record processing.

#include   <vxWorks.h>
#include   <types.h>
#include   <stdioLib.h>
#include   <wdLib.h>
#include   <callback.h>
#include   <dbDefs.h>
#include   <dbAccess.h>
#include   <subRecord.h>

/* control block for callback*/
struct callback {
    CALLBACK   callback;
    struct dbCommon *precord;
    WDOG_ID wd_id;
};

void myCallback(struct callback *pcallback)
{
    struct dbCommon *precord=pcallback->precord;
    struct rset  *prset=(struct rset *)(precord->rset);
    dbScanLock(precord);
    (*prset->process)(precord);
    dbScanUnlock(precord);
}

long subInit(struct subRecord *psub)
{
    struct callback *pcallback;
    pcallback = (struct callback *)(calloc(1,sizeof(struct callback)));
    psub->dpvt = (void *)pcallback;
    callbackSetCallback(myCallback,pcallback);
    pcallback->precord = (struct dbCommon *)psub;
    pcallback->wd_id = wdCreate();
    printf("subInit was called\n");
    return 0;
}

long subProcess(struct subRecord *psub)
{
    struct callback *pcallback=(struct callback *)(psub->dpvt);
    /* sub.inp must be a CONSTANT*/
    if (psub->pact) {
        psub->val++;
        if (psub->b)
        printf("%s subProcess Completed\n", psub->name);
        return 0;
    } else {
        int wait_time = (long)(psub->a * vxTicksPerSecond);
        if (wait_time <= 0){
            if (psub->b)
                printf("%s subProcess sync processing\n", psub->name);
            psub->pact = TRUE;
            return 0;
        }
        if (psub->b){
            callbackSetPriority(psub->prio, pcallback);
            printf("%s Starting async processing\n", psub->name);
            wdStart(pcallback->wd_id, wait_time, callbackRequest, (int)pcallback);
            return 1;
        }
    }
    return 0;
}

---

EPICS Record Reference Manual - 19 MAY 1998