sihmon(1M) (RM400 only) sihmon(1M)
NAME
sihmon - SIH monitor
SYNOPSIS
/usr/lib/saf/sihmon [-d level] [-f file] [-t timeout] [-r retry]
[-s size]
/usr/lib/saf/sihmon -v
/usr/lib/saf/sihmon -h|-?
DESCRIPTION
The SIH monitor sihmon administers HDLC devices, which are connected
to an SIH board via an SIH driver. It sets the HDLC parameters and
ensures that a deactivated, loadable HDLC device is loaded with a
workstation program when switched on.
The SIH monitor is a port monitor in terms of the Service Access
Facility (SAF) and uses the latter's facilities to configure and con-
trol the monitor. It is designed to run under the control of the Ser-
vice Access Controller (SAC). The sacadm(1M) command informs the SAC
of a SIH monitor incarnation. The pmadm(1M) and sihadm(1M) commands
are used to make entries and changes in the SIH monitor (pmtab)
administration table. Additional SIH monitor-specific commands are
available using the sihadm(1M) command.
An SIH driver link should be understood as a port in the SAF sense.
The configuration of a link is defined by an entry in the pmtab file.
This kind of entry is identified by a specific name (SIH monitor ser-
vice ID).
Messages are usually written to the /var/saf/pmtag/log log file of the
relevant SIH monitor incarnation. Usage output and error messages
resulting from incorrect application of the options are output to
stderr. Other error messages, which are issued before the log file can
be opened, are output to both stderr and the console terminal.
The SIH monitor can only be successfully started with root authoriza-
tion.
OPTIONS
If sihmon is invoked without options, the following default values apply.
-d level
This option presets the SIH monitor trace level. The level argu-
ment shows the trace level:
0 no output (trace not activated, default value)
1 output of error messages and important operating messages
2 additional output of detailed operating messages
Page 1 Reliant UNIX 5.44 Printed 11/98
sihmon(1M) (RM400 only) sihmon(1M)
The trace level can be changed during operation using the
sihadm(1M) command. If the -f option is not used, all trace out-
puts are added to the end of the /var/saf/pmtag/trace file.
-f file
With this option, the file file is used as the trace file instead
of the default /var/saf/pmtag/trace file. An absolute path name
is expected. Traces are only output if the current trace level is
0 (see -d option).
-t timeout
This option specifies the period of time in seconds which should
expire before a failed operation (e.g. loading error) is
repeated. If a value lower than 10 is specified, 10 is used. The
default value is 90 seconds.
-r retry
This option specifies how many times in succession an operation
can fail (e.g. loading error), before the corresponding link is
internally DISABLED. An internally DISABLED link can be reac-
tivated by invoking sacadm -x -ppmtag again. The internal status
of the link can be established by invoking sihadm -S.
The retry argument can assume 0 or a positive value. A 0 value
allows unlimited repetition (default value).
-s size
This option defines the maximum size of the log file
/var/saf/pmtag/log in bytes. If this size is exceeded, the file
is copied to the /var/saf/pmtag/log.alt file. The original file
is shortened to zero length.
The value for the size argument may be 0 or positive as long as
it does not exceed the maximum file size authorized by the sys-
tem. If the 0 value is selected, no data is written to the log
file. Values between 1 and 1023 are increased to 1024. The
default value is 1048576 bytes (1 MB).
-v Outputs the SIH monitor version ID to stdout without line feed.
This ID is identical to the version ID of the SIsih package.
-h | -?
The command syntax is displayed on stderr.
NOTES
The SIH monitor can only make link-specific contact with the SIH
driver, if the SIH driver for this link is switched to loading mode
before the corresponding multidevice is opened for the first time.
This can be done by correctly timing the start of the SIH monitor
incarnation, or by correctly timing the invocation of the sihadm -I
command (e.g. when the system is being brought up).
Page 2 Reliant UNIX 5.44 Printed 11/98
sihmon(1M) (RM400 only) sihmon(1M)
It is assumed that all links entered in the pmtab file of the corre-
sponding SIH monitor incarnation are to be monitored. Thus, for
entries in the pmtab file which are disabled, the corresponding SIH
driver admin device is opened and loading mode is set. Other opera-
tions are started, when the entry is enabled.
The loading mode for an admin device is reset when an entry is removed
from the pmtab file, or the SIH monitor terminates.
An SIH monitor incarnation can monitor a maximum of 200 links. Thus,
the pmtab file should only contain a maximum of 200 enabled entries
at any one time.
For internal purposes the SIH monitor has a maximum requirement of 15
file descriptors and one additional file descriptor for each link to
be monitored.
All log and trace files are protected from overflow. If the file size
exceeds the maximum value, the file is copied to a file with the same
prefix name and the suffix .alt. The original file is reduced to zero
length. The prescribed maximum values are:
/var/saf/pmtag/log see option -s
/var/saf/pmtag/trace 2097152 bytes (2 MB)
/var/saf/pmtag/state 2097152 bytes (2 MB)
Loading programs invoked from the SIH monitor [see sihadm(1M) and
xbload(1M)], should observe the following conventions:
1. The loading program should show a return value of 0 if the relevant
HDLC device has been successfully loaded or was already loaded.
Otherwise, it should display a positive return value; the loading
attempt is repeated when the timed interval has expired (see the -t
and -r options).
2. Error messages should be written to a separate file or to stderr.
If changes are made to the /var/sadm/terms/hdlclabs, /etc/hdlcdefs or
/etc/ttydefs files, which affect the SIH monitor incarnation pmtag,
the SIH monitor must be notified of the changes by the sacadm -x
-ppmtag command. The changes are then taken into account the next time
HDLC parameters are set. (see the -a option of the sihadm(1M) com-
mand).
Page 3 Reliant UNIX 5.44 Printed 11/98
sihmon(1M) (RM400 only) sihmon(1M)
DIAGNOSTICS
For diagnostic purposes, the SIH monitor administers the private
/var/saf/pmtag/log log file (see the -s option), to which exceptional
events and error messages are written. A line in the log file has the
following format:
type dd.mm HH:MM:SS pid text
The type field can contain the following entries:
INFO The line contains important information (e.g. start and stop of
the SIH monitor). There is no error.
WARN An error has occurred, which can result in one or more links
not being monitored. Such messages should not appear during
normal operation.
FATAL A fatal error has occurred which leads to the immediate termi-
nation of the SIH monitor.
dd, mm, HH, MM and SS give the day, month, hour, minute and second of
the error message.
The pid field shows the process number of the corresponding SIH moni-
tor incarnation.
The text field describes the error that has occurred.
The format of the trace file entries is identical to the format of the
log file entries. If the current trace level is positive, all log mes-
sages are also written to the trace file. This is also the case when
the SIH monitor incarnated was started using the -s0 option.
All log messages are also written to Logging 3.0 (Component number
1080005). The error level can accept the values 6 (INFO), 4 (WARN) or
3 (FATAL). Each log messages has a different number. The format of the
logging text is shown below:
pid text
Under normal operating conditions, the SIH monitor is terminated using
the SAC SIGTERM(15) signal. It is, however, also possible to terminate
the monitor manually using the kill -15 pid. The return value in both
cases is 0. The SIGKILL(9) signal should be avoided as a means to ter-
minate the monitor, as clean-up operations cannot be executed.
In the case of an error, the SIH monitor terminates with a FATAL error
message in the log file. In this case, the return value is one of the
following:
Page 4 Reliant UNIX 5.44 Printed 11/98
sihmon(1M) (RM400 only) sihmon(1M)
1 = Wrong option used (EILLOPT)
2 = Wrong argument for an option (EWRARG)
3 = No root authorization (ENOROOT)
4 = Monitor incarnation already running (EPIDLOCK)
5 = pid cannot be created (ECPID)
6 = pmtag variable not available in the process environment
(EPMTAG)
7 = Log file cannot be opened (ENOLOG)
8 = Content of ISTATE variables unknown (EISTATE)
9 = pmpipe cannot be opened (EPMPIPE)
10 = sacpipe cannot be opened (ESACPIPE)
11 = Too few file descriptors available in the system (ETOOFEWFDS)
12 = pmtab cannot be opened (ENOPMTAB)
13 = hdlclabs cannot be opened (ENOHDLCLABS)
14 = hdlcdefs cannot be opened (ENOHDLCDEFS)
15 = ttydefs cannot be opened (ENOTTYDEFS)
16 = Wrong pmtab version (EWRPMTAB)
17 = Wrong hdlclabs version (EWRHDLCLABS)
18 = Wrong hdlcdefs wrong (EWRHDLCDEFS)
19 = Wrong ttydefs version (EWRTTYDEFS)
20 = Error in polling pmpipe file (EPOLLSAC)
21 = Error in loader exec (ECLDEXEC)
50 = Internal program error (EINTERNAL1)
99 = Internal program error - core dump (EINTERNAL2)
Page 5 Reliant UNIX 5.44 Printed 11/98
sihmon(1M) (RM400 only) sihmon(1M)
FILES
/usr/sbin/sihadm
/etc/saf/pmtag/pmtab
/etc/ttydefs
/etc/hdlcdefs
/var/sadm/terms/hdlclabs
/var/saf/pmtag/log[.alt]
/var/saf/pmtag/trace[.alt]
/var/saf/pmtag/state[.alt]
SEE ALSO
pmadm(1M), sac(1M), sacadm(1M), sihadm(1M), xbload(1M).
Page 6 Reliant UNIX 5.44 Printed 11/98