Version 2 (modified by branden, 10 years ago) (diff)


Earthworm Module: startstop_sol


startstop for Solaris


Startstop is a system-specific module; the configuration file described here is for the Solaris version. On startup, startstop changes to the directory specified by the EW_PARAMS environment variable. Then it reads the configuration file named startstop_sol.d. This file sets up all parameters required to run an Earthworm system. In the configuration file, lines may begin with a valid startstop command (listed below) or with a # to denote a comment. Command names must be typed in the configuration file exactly as shown in this document (upper/lower case matters!).

Example startstop_sol.d Configuration File

#       Startstop (Solaris Version) Configuration File
#    <nRing> is the number of transport rings to create.
#    <Ring> specifies the name of a ring followed by it's size
#    in kilobytes, eg        Ring    WAVE_RING 1024
#    The maximum size of a ring is 1024 kilobytes.
#    Ring names are listed in file earthworm.h.
 nRing               3
 Ring   WAVE_RING 1024
 Ring   PICK_RING 1024
 Ring   HYPO_RING 1024
 MyModuleId    MOD_STARTSTOP  # Module Id for this program
 HeartbeatInt  50             # Heartbeat interval in seconds
 MyClassName   TS             # For this program
 MyPriority     0             # For this program
 LogFile        1             # 1=write a log file to disk, 0=don't
 KillDelay      5             # seconds to wait before killing modules on
                              #  shutdown
 HardKillDelay  5             # seconds to wait after SIGKILL
                              #   if absert, no SIGKILL is sent
# maxStatusLineLen 120         # Uncomment to specify length of lines in status
 Stderr         None          # Where to send stderr messages: None, Console or File
#    Class must be RT or TS
#    RT priorities from 0 to 59
#    TS priorities le 0
#    If the command string required to start a process contains
#    embedded blanks, it must be enclosed in double-quotes.
#    Processes may be disabled by commenting them out.
#    To comment out a line, preceed the line by #.
#    The optional Agent command lists the user and group names under which
#       the command will be run. Make sure they are valid names!
#       You cannot use "root" as the Agent user. If an earthworm module
#       needs to run as root, you should make that module's binary setuid root.
 Process          "pick_ew pick_ew.d"
 Class/Priority    TS 0
 Agent             "eworm" "net"
# Process          "coaxtoring coaxtoring.d"
# Class/Priority    RT 10
# Process          "export_generic export_picks.d"
# Class/Priority    TS 0
 Process          "binder_ew binder_ew.d"
 Class/Priority    TS 0
 Stderr            File
 Process          "eqproc eqproc.d"
 Class/Priority    TS 0
 Stderr            Console
 Process          "diskmgr diskmgr.d"
 Class/Priority    TS 0
 Process          "pagerfeeder pagerfeeder.d"
 Class/Priority    TS 0
 Process          "statmgr statmgr.d"
 Class/Priority    TS 0
# Process          "eqalarm_ew eqalarm_ew.d"
# Class/Priority    TS 0
 Process          "copystatus WAVE_RING HYPO_RING"
 Class/Priority    RT 5
 Process          "copystatus PICK_RING HYPO_RING"
 Class/Priority    RT 5
 Process          "menlo_report menlo_report.d"
 Class/Priority    TS 0

Functional Commands

Unlike most other Earthworm modules, startstop expects the lines in its control file to be in a certain order. Below are the commands recognized by startstop, grouped by the function they influence and listed in the order in which they must appear in the control file. All commands are required!

Shared memory setup

nRing required Ring required (nRing)


nRing nRing

Specifies the number of shared memory regions (aka transport rings) that startstop will create for "public" use by the modules of this Earthworm system. nRing should be an integer from 1 to MAX_RING (currently defined to be 50).

Example: nRing 3


Ring name size

Specifies the name and size, in kilobytes, of one transport ring. There must be exactly nRing "Ring" commands following the "nRing" command in the startstop_sol.d. name is a character string (up to 19 characters long, valid strings are listed in earthworm.d) that relates (in earthworm.d) to a unique number for the key to the shared memory region. size should be an integer between 1 and 1024 (the default maximum size). When deciding how large to make a memory region, realize that the transport layer uses a portion of the memory region for its own bookkeeping. The region size is NOT required to be an even multiple of the size of the messages it will contain. However, suppose you want the region to be exactly large enough to store NUM messages of size MSGSIZE. To include space for transport bookkeeping too, the region size (in bytes) should be: sizeof(SHM_HEAD) + NUM * ( sizeof(TPORT_HEAD) + MSGSIZE )

where SHM_HEAD and TPORT_HEAD are structures defined in transport.h. Startstop places all of its outgoing messages in the memory region specified by the first "Ring" command.

Example: Ring WAVE_RING 1024

Startstop-specific info

MyModuleId? required HeartbeatInt? required MyClassName? required MyPriority? required LogFile? required KillDelay? required HardKillDelay? optional maxStatusLineLen optional Stderr optional


MyModuleId? mod_id

Sets the module id for labeling all outgoing messages. mod_id is a character string (up to 30 characters, valid strings listed in earthworm.d) that relates (in earthworm.d) to a unique single-byte number. Startstop places its outgoing messages on the shared memory ring specified by the first "Ring" command in startstop_sol.d.

Example: MyModuleId? MOD_STARTSTOP


HeartbeatInt? nsec

Defines the number of seconds, nsec, between TYPE_HEARTBEAT messages issued by startstop. Startstop places its heartbeats on the shared memory ring specified by the first "Ring" command in startstop_sol.d.

Example: HeartbeatInt? 30


MyClassName? class

Sets the process class for startstop. class is a character string that must be set to either "RT" (for Real-Time) or "TS" (for Time- Share) on solaris.

Example: MyClassName? RT


MyPriority? priority

Sets the process priority for startstop. See the "Class/Priority?" command below for allowed values. After startstop reads its configuration file, it changes its own class/priority to the values specified in the "MyClassName?" and "MyPriority?" commands.

Example: MyPriority? 4


LogFile? switch

Sets the on-off switch for writing a log file to disk. If switch is 0, no log file will be written. If switch is 1, startstop will write a daily log file(s) called cfname_yyyymmdd.log where cfname is the name (without extension) of startstop's configuration file (ex: startstop_sol) and yyyymmdd is the current UTC date (ex: 19960123) on the system clock. The file(s) will be written in the EW_LOG directory (environment variable).

Example: LogFile? 1


Earthworm modules to run

Process required \ Class/Priority? required | one set Stderr optional | per module Agent optional /


(see above)


Helpful Hints