HOWTO: setup HADES IOC to start at reboot

Objective

Project data

• CVSROOT: :ext:[<valid user>@]lxi001.gsi.de:/misc/hadesprojects/daq/cvsroot
• module: EPICS/startupProcedures

Basics and Commons

• The mechanisms used are based on shell scripts (not bash, but rather dash since its the the least common denominator) on the systems
• They run on linux systems

  softIOC and special IOCs	x86-based
  hadcon and TRB	axis cris architecture

• They do also all rely on procServ, a Process Server with Telnet Console and Log Access

Common Shell scripts

• The procServ calling script startBackgroundEpicsIoc.sh
  ... (Click to expand) (Click to retract)

  ... due to the length of this script just the help is shown

  startBackgroundEpicsIOC.sh
  usage: startBackgroundEpicsIOC.sh [options]
  
  starts EPICS IOC in background using procServ tool,
    which spawns and automatically respawns the ioc process
    and makes it available via local telnet:
     telnet localhost port
          where port is set to default `4813'
  options:
     -w workingDir   : EPICS IOC application dir / a.k.a. workingDir (absolute path)
                        [`/home/hadaq/EPICS/epics_apps/HadControlTemperatureAndThreshold']
     -i iocBootdir   : EPICS IOC iocboot dir
                        place where to change to and where log and pid files may be written (absolute path)
                        [`/home/hadaq/EPICS/epics_apps/HadControlTemperatureAndThreshold/iocBoot/iocHadControlTemperatureAndThreshold_linux-cris_v10']
     -c command file : st.cmd file started relativ to `./'
                        if not absolute path, taken relatively to `EpicsIocBootDir'
                        [`st_linux-cris_v10.cmd']
     -a commandArgs  : [quoted list] of argument[s] for executable of ioc process,
                        [`""']
     -P procServ exe : procServ executable
                        [`/home/hadaq/EPICS/startupProcedures/procServ/procServ']
     -L procServ lib : procServ lib path needed to be added to LD_LIBRARY_PATH, multiple calls possible
                        [`/home/hadaq/EPICS/startupProcedures/procServ/lib']
     -p port         : telnet port [`4813'], see above
     -t logport      : set log readonly telnet port for active procServ access (NOTE: default log port will be port+1)
                        [`4814']
     -g              : activate file logging for procServ [OFF]
     -G loggingDir   : file logging directory,
                        if not absolute path, taken relatively to `workingDir' [`/home/hadaq/EPICS/epics_apps/HadControlTemperatureAndThreshold']
                        [`/home/hadaq/EPICS/epics_apps/HadControlTemperatureAndThreshold']
     -D              : debug mode of procServ [OFF]
     -I name         : name of (IOC) process
                        [`etrax047:4813_st_linux-cris_v10.cmd']
     -o "options"    : additional options for procServ
                        [`']
     General:
     -b baseHome     : home directory of hadaq
                        [`/home/hadaq']
     -n              : no action, just echos command instead of executing the ioc process [OFF]
     -d              : debug mode of caller, sets set -xv [OFF]
     -v              : verbosity of caller, can be called repeatedly  [OFF]
     -e scriptname   : helper script internally used by `startBackgroundEpicsIOC.sh' for checks
                              defaults to be searched in the same directory as \'startBackgroundEpicsIOC.sh'
                        [`./exitIfHelpers.sh']
     -q              : sets verbosity of caller off [OFF]
     -h              : this help
  

• and its helper script exitIfHelpers.sh used by the other scripts
  ... (Click to expand) (Click to retract)

  %begin bash%

  #/bin/sh # exitIfHelpers.sh # # helper functions: # tests: # - If Not Absolute Path # - If Not A File # - If Not A Directory # - If Not Executable # else exits with error 1 # # created: 20-01-2010 # author: p.zumbruch, GSI # modified: 22-01-2010

  #debug - uncomment to debug #set -xv

  isAbsolutePath() { # isAbsolutePath path # checks if path is absolute # exit values: # 0 : is not absolute # 1 : is absolute

  [ 3 -le $myVerbosity ] && myLevel=$(($myLevel+1)) && echo [${myLevel}] entering function \"isAbsolutePath $*\"

  if [ $# -lt 1 ] then echo "$scriptname: function \"absolutePath\" called with too few arguments, needs at least \"$0 path [name]\" ... exiting" 1>&2 unsets exit 1; fi

  if [ ! -z "${1##/*}" ] # doesn't start with '/' then if [ ! -z "${1##~*}" ] # nor starts with "~" then [ 3 -le $myVerbosity ] && echo [${myLevel}] " leaving" function \"isAbsolutePath\" [return: 1]&& myLevel=$(($myLevel-1)) return 1; fi fi

  [ 3 -le $myVerbosity ] && echo [${myLevel}] " leaving" function \"isAbsolutePath\" [return: 0] && myLevel=$(($myLevel-1))

  return 0; }

  #exitIfNotAbsolutePath function exitIfNotAbsolutePath() { # exitIfNotAbsolutePath path description # checks if path is absolute # otherwise exits

  [ 3 -le $myVerbosity ] && myLevel=$(($myLevel+1)) && echo [${myLevel}] entering function \"exitIfNotAbsolutePath $*\"

  if [ $# -lt 1 ] then echo "$scriptname: function \"exitIfNotAbsolutePath\" called with too few arguments, needs at least \"$0 path [name]\" ... exiting" 1>&2 unsets exit 1; fi

  isAbsolutePath $1 if [ 0 -ne $? ] then echo "$scriptname: $2 \`${1}' is not an absulute path ... exiting" 1>&2 unsets exit 1; fi [ 3 -le $myVerbosity ] && echo [${myLevel}] " leaving" function \"exitIfNotAbsolutePath\" && myLevel=$(($myLevel-1)) }

  #exitIfNotAFile function exitIfNotAFile() { # exitIfNotAFile path description # checks if path is a file # otherwise exits

  [ 3 -le $myVerbosity ] && myLevel=$(($myLevel+1)) && echo [${myLevel}] entering function \"exitIfNotAFile $*\"

  if [ $# -lt 1 ] then echo "$scriptname: function \"exitIfNotAFile\" called with too few arguments, needs at least \"$0 path [name]\" ... exiting" 1>&2 unsets exit 1; fi

  if [ ! -f "${1}" ] then echo "$scriptname: $2 \`${1}' is not a file ... exiting" 1>&2 unsets exit 1; fi

  [ 3 -le $myVerbosity ] && echo [${myLevel}] " leaving" function \"exitIfNotAFile\" && myLevel=$(($myLevel-1)) }

  #exitIfNotADirectory function exitIfNotADirectory() { # exitIfNotADirectory path description # checks if path is a directory # otherwise exits

  [ 3 -le $myVerbosity ] && myLevel=$(($myLevel+1)) && echo [${myLevel}] entering function \"exitIfNotADirectory $*\"

  if [ $# -lt 1 ] then echo "$scriptname: function \"exitIfNotADirectory\" called with too few arguments, needs at least \"$0 path [name]\" ... exiting" 1>&2 unsets exit 1; fi

  if [ ! -d "${1}" ] then echo "$scriptname: $2 \`${1}' is not a directory ... exiting" 1>&2 unsets exit 1; fi

  [ 3 -le $myVerbosity ] && echo [${myLevel}] " leaving" function \"exitIfNotADirectory\" && myLevel=$(($myLevel-1)) }

  #exitIfNotExecutable function exitIfNotExecutable() { # exitIfNotAbsolutePath exe description # checks if exe is executable # otherwise exits

  [ 3 -le $myVerbosity ] && myLevel=$(($myLevel+1)) && echo [${myLevel}] entering function \"exitIfNotExecutable $*\"

  if [ $# -lt 1 ] then echo "$scriptname: function \"exitIfNotAbsolutePath\" called with too few arguments, needs at least \"$0 path [name]\" ... exiting" 1>&2 unsets exit 1; fi

  exitIfNotAFile $*

  if [ ! -x "${1}" ] then echo "$scriptname: $2 \`${1}' is not an executable or does not exist ... exiting" 1>&2 unsets exit 1; fi

  [ 3 -le $myVerbosity ] && echo [${myLevel}] " leaving" function \"exitIfNotExecutable\" && myLevel=$(($myLevel-1)) } %end%

softIOC

• cron and
• procServ, a Process Server with Telnet Console and Log Access

Status

Scripts

template script download ... (Click to expand) (Click to retract) %begin bash% #!/bin/bash # ioc-.sh # starts EPICS IOC in background using procServ tool # by defining user specific variables # and # then calling/sourcing ${startBackgroundEpicsIocScript} # which implements those settings # # Author: P.Zumbruch@gsi.de 12/01/2010 # Last modification: 23/02/2010 # uncomment to debug #set -xv scriptname=ioc-cave.sh startBackgroundEpicsIocScriptName=startBackgroundEpicsIoc.sh useUserDefinedVariables=yes #specific predefines userDefines() { userProcServTelnetPort= #eg. 4813 userProcServTelnetLogPort=-1 #-1:defaults to userProcServTelnetPort+1 userIOC=ioc--$(hostname) userWorkingDir= #e.g ~scs/apps/hades/iocBoot/ioctemplate; userCommandExecutable= #e.g. "../../bin/linux-x86/hades"; userCommandArgument= #e.g. "st.cmd"; userProcServExecutable=$(which procServ) userProcServDefaultExecutable= #e.g. /usr/local/bin/procServ userLibraryPathAdd= #e.g. /home/scs/apps/hades/hadesApp/src #several paths allowed, separated by colon ':' [ 0 -ge "${userProcServTelnetLogPort}" ] && unset userProcServTelnetLogPort userCommand="${userCommandExecutable} ${userCommandArgument}"; userProcServLoggingDir=${userWorkingDir} userProcServExecutable=${userProcServExecutable:-${userProcServDefaultExecutable}} } #look for startBackgroundEpicsIocScriptName startBackgroundEpicsIocScript=$(which $startBackgroundEpicsIocScriptName) startBackgroundEpicsIocScript=${startBackgroundEpicsIocScript:-./${startBackgroundEpicsIocScriptName}} #start script if available, else report ERROR and exit if [ -f "${startBackgroundEpicsIocScript}" ] then . ${startBackgroundEpicsIocScript} else echo "$scriptname: ERROR could not find main script file \`$startBackgroundEpicsIocScriptName'" exit -1 fi %end%

HV script download ... (Click to expand) (Click to retract) %begin bash% #!/bin/bash # ioc-hv.sh # starts EPICS IOC in background using procServ tool # by defining user specific variables # and # then calling/sourcing ${startBackgroundEpicsIocScript} # which implements those settings # # Author: P.Zumbruch@gsi.de 12/01/2010 # Last modification: 23/02/2010 # uncomment to debug #set -xv scriptname=ioc-hv.sh startBackgroundEpicsIocScriptName=startBackgroundEpicsIoc.sh useUserDefinedVariables=yes #specific predefines userDefines() { userProcServTelnetPort=4813 #userProcServTelnetLogPort=4814 userIOC=ioc-hv-$(hostname); userWorkingDir=~scs/epics_apps/prototypes/cbmall/iocBoot/ioccbm userCommandExecutable="../../bin/linux-x86/cbmall"; userCommandArgument="st.cmd"; userProcServExecutable=$(which procServ) userProcServDefaultExecutable=/u/epics/programs/bin/procServ userLibraryPathAdd=/u/scs/epics_apps/prototypes/cbmall/cbmApp/src #several paths allowed, separated by colon ':' [ 0 -ge "${userProcServTelnetLogPort}" ] && unset userProcServTelnetLogPort userCommand="${userCommandExecutable} ${userCommandArgument}"; userProcServLoggingDir=${userWorkingDir} userProcServExecutable=${userProcServExecutable:-${userProcServDefaultExecutable}} } #look for startBackgroundEpicsIocScriptName startBackgroundEpicsIocScript=$(which $startBackgroundEpicsIocScriptName) startBackgroundEpicsIocScript=${startBackgroundEpicsIocScript:-./${startBackgroundEpicsIocScriptName}} #start script if available, else report ERROR and exit if [ -f "${startBackgroundEpicsIocScript}" ] then . ${startBackgroundEpicsIocScript} else echo "$scriptname: ERROR could not find main script file \`$startBackgroundEpicsIocScriptName'" exit -1 fi %end%

cave script download ... (Click to expand) (Click to retract) %begin bash% #!/bin/bash # ioc-cave.sh # starts EPICS IOC in background using procServ tool # by defining user specific variables # and # then calling/sourcing ${startBackgroundEpicsIocScript} # which implements those settings # # Author: P.Zumbruch@gsi.de 12/01/2010 # Last modification: 23/02/2010 # uncomment to debug #set -xv scriptname=ioc-cave.sh startBackgroundEpicsIocScriptName=startBackgroundEpicsIoc.sh useUserDefinedVariables=yes #specific predefines userDefines() { userProcServTelnetPort=4813 #userProcServTelnetLogPort=4814 userIOC=ioc-cave-$(hostname); userWorkingDir=~scs/apps/hades/iocBoot/ioccave userCommandExecutable="../../bin/linux-x86/hades"; userCommandArgument="st.cmd"; userProcServExecutable=$(which procServ) userProcServDefaultExecutable=/usr/local/bin/procServ userLibraryPathAdd=/home/scs/apps/hades/hadesApp/src #several paths allowed, separated by colon ':' [ 0 -ge "${userProcServTelnetLogPort}" ] && unset userProcServTelnetLogPort userCommand="${userCommandExecutable} ${userCommandArgument}"; userProcServLoggingDir=${userWorkingDir} userProcServExecutable=${userProcServExecutable:-${userProcServDefaultExecutable}} } #look for startBackgroundEpicsIocScriptName startBackgroundEpicsIocScript=$(which $startBackgroundEpicsIocScriptName) startBackgroundEpicsIocScript=${startBackgroundEpicsIocScript:-./${startBackgroundEpicsIocScriptName}} #start script if available, else report ERROR and exit if [ -f "${startBackgroundEpicsIocScript}" ] then . ${startBackgroundEpicsIocScript} else echo "$scriptname: ERROR could not find main script file \`$startBackgroundEpicsIocScriptName'" exit -1 fi %end%

Install

... (Click to expand) (Click to retract)

1. make sure procServ, a Process Server with Telnet Console and Log Access , is installed
   1. remember where you installed it: <ProcServ Default Executable>/procServ
2. change to your parent directory <procServ Parent Dir, e.g. ~scs>
   cd <procServ Parent Dir>
3. get the source:
   1. either do a cvs checkout of EPICS/startupProcedures/softIOC/procServ to <startup Procedues Dir, e.g. procServ>
      cvs -r -d :ext:[<valid user>@]lxi001.gsi.de:/misc/hadesprojects/daq/cvsroot checkout -d procServ EPICS/startupProcedures/softIOC/procServ
   2. or download the tar-ball and untar it
      wget -N https://wiki.gsi.de/pub/Epics/HowToSetupHadesIOCsRestartAtReboot/startupProcedures_softIOC.tar.gz &&
tar zxvf startupProcedures_softIOC.tar.gz
4. change to the directory <startup Procedues Dir, e.g. procServ> and change permissions on template and shell script files:
   cd <procServ Parent Dir>/<startup Procedues Dir, e.g. procServ> &&
chmod 775 ioc-template.sh && chmod a+x *.sh
5. rename template file to ioc-<myName>.sh:
   cd <procServ Parent Dir>/<startup Procedues Dir, e.g. procServ> &&
mv ioc-template.sh ioc-<myName>.sh
6. replace script name placeholder within script by <myName>:
   cd <procServ Parent Dir>/<startup Procedues Dir, e.g. procServ> &&
perl -pi -e 's/<Name>/<myName>/g' ioc-<myName>.sh
7. The function userDefines of the scripts contains several definition lines, which you have to change according to your settings:
   • open ioc-<myName>.sh with an editor and change those values in '< ... >'
     • myProcServExecutable is set automatically via which, it is possible that this doesn't work for cron.
       So you can set a default executable for procServ, which is used if myProcServExecutable is empty or not set.

%begin bash%

#specific predefines userDefines() { userProcServTelnetPort= #eg. 4813 userProcServTelnetLogPort=-1 #-1:defaults to userProcServTelnetPort+1 userIOC=ioc--$(hostname) userWorkingDir= #e.g ~scs/apps/hades/iocBoot/ioctemplate; userCommandExecutable= #e.g. "../../bin/linux-x86/hades"; userCommandArgument= #e.g. "st.cmd";

... userProcServDefaultExecutable= #e.g. /usr/local/bin/procServ userLibraryPathAdd= #e.g. /home/scs/apps/hades/hadesApp/src #several paths allowed, separated by colon ':' %end%

7. test the code on the command line:
   <procServ Parent Dir>/procServ/ioc-<myName>.sh
   • you should get something like: procServ: spawning daemon process: 17357, if not check your settings
8. connect via telnet to your procServ session:
   telnet localhost <Telnet Port>
9. Toggle auto restart off by typing "^T"
10. Exit the EPICS IOC or in general the executable: exit
11. Exit procServ session by typing "^Q"
12. Add your executable to cron by using crontab
    crontab -e
    and adding @reboot cd <ABSOLUTE PATH: procServ Parent Dir>/procServ && ./ioc-<myName>.sh leave the crontab editor and check result with
    crontab -l
13. To test the cron job, you should temporarily add another line to cron:
    crontab -e
    and adding e.g. 30 19 * * * cd <ABSOLUTE PATH: procServ Parent Dir>/procServ && ./ioc-<myName>.sh to start your job also at 19:30.
14. Check after 19:30 or (after reboot) by using ps if your jobs are running:
    ps x
    should result in something like

          PID TTY      STAT   TIME COMMAND
                    [...]
          11097 ?        S      0:00 <ProcServ Default Executable>/procServ --chdir <Working Directory> --logfile  [...] 
                    [...]
          11101 pts/4    Ssl+   2:21 <Command Executable>  <Command Argument>
            

    Errors of cron are reported typically via mail to the local mail system of your machine, try e.g. mail
15. If all is o.k. don't forget to remove the extra cron job by using crontab
crontab -e
and remove 30 19 * * * cd <ABSOLUTE PATH: procServ Parent Dir>/procServ && ./ioc-<myName>.sh leave the crontab editor and check result with
crontab -l
16. ... done

special IOCs and EPICS client and servers

channel Archiver

channel Server

Gateway

hadcon

• The rc script resides on the mounted file system from lxhadesdaq and shows up on the local mount point /home/hadaq/etc/rc
  
  • while it can originally be found on /var/diskless/etrax of lxhadesdaq,
    the place to edit and change as user hadaq.
    • while this is not fully true, since you are advised to develop the code somewhere else, and copy the results to /var/diskless/etrax since this is not in the backup :-/

Mechanism

Basic concept

• One single <EPICS IOC (re)start script> is called/sourced from rc
  • small code within general rc script
• Depending on the hostname the <EPICS IOC (re)start script> calls <EPICS IOC start Background script> which calls the corresponding EPICS IOC executable with its additional varying <Startup cmd Script> by using the functionalities of procServ
• Besides its default values the <EPICS IOC (re)start script> should be called using a lookup table text file
  • the text file may be also created by calls to a database, but not during runtime
  • e.g. IocListFile.txt
    ... (Click to expand) (Click to retract)

    # IOC list file
    # 
    # hostname | command exe  | command arguments | telnet  | telnet | logging directory | working dir a.k.a application dir | IOC boot directory | procServ exe | procServ libs | name | baseHome 
    #          |              |                   | control | log    |                   |                                   |                    |              |               |      |
    #          |              |                   | port    | port   |                   |                                   |                    |              |               |      |
    #
       
    # PZ
    etrax047   | st_linux-cris_v10.cmd | | 4813 | 4814 | | /home/hadaq/EPICS/epics_apps/HadControlTemperatureAndThreshold | iocBoot/iocHadControlTemperatureAndThreshold_linux-cris_v10 | 
    etrax048   | st_linux-cris_v10.cmd | | 4813 | 4814 | | /home/hadaq/EPICS/epics_apps/HadControlTemperatureAndThreshold | iocBoot/iocHadControlTemperatureAndThreshold_linux-cris_v10 | 
      
    # RPC LV
    #etrax105   | ...                   | | 4813 | 4814 | | ...                  
    #etrax106   | ...                   | | 4813 | 4814 | | ...                  
    #etrax107   | ...                   | | 4813 | 4814 | | ...                  
    #etrax108   | ...                   | | 4813 | 4814 | | ...                  
    #etrax109   | ...                   | | 4813 | 4814 | | ...                  
    #etrax110   | ...                   | | 4813 | 4814 | | ...                  
    

• <EPICS IOC (re)start script> analyzes the lookup table or input options and selects depending on hostname
• <EPICS IOC start Background script> calls procServ with the embedding of the EPICS IOC

Prerequisites

• correct system time
  • contained in rc
• correct MAC address (?)
  • used to have switch script for etrax04x, contained in rc,
  • what about others etrax1xx ?
• hostname available via command hostname
  • o.k.
• export HOSTNAME=$(hostname)
  • o.k.
• procServ installed
  • where
    • /home/hadaq/procServ
    • copy of /home/hadaq/EPICS/startupProcedures/procServ
  • what additions to LD_LIBRARY_PATH are needed
    • /home/hadaq/EPICS/startupProcedures/procServ/lib
• list of hadcons: <EPICS-IOCS>.txt
  • maybe created via a database (also as first column of the lookup file)
  • but static from the point of view of the hadcons at startup, i.e. at startup no database access

Modifications

• Created directory /home/hadaq/EPICS/startupProcedures
• Changed rc script to just hold callers to scripts in /home/hadaq/EPICS/startupProcedures
  ... (Click to expand) (Click to retract)

  %begin bash% #!/bin/sh # rc # script called at system startup/reboot

  # # [...] commented out code #

  # --------------------------- # set the time server if [ ! -e "/etc/localtime" ] then ln -s /home/hadaq/Berlin /etc/localtime fi /home/hadaq/ntpdate 140.181.90.22

  # --------------------------- # reset MAC address to have the same last to digits of the hostname # - checks in script $resetMACsScript # for matching hostnames and reconfigures eth0 # P.Zumbruch, GSI, 13-01-2010

  resetMACsScript=/home/hadaq/EPICS/startupProcedures/resetMACs.sh [ -x "$resetMACsScript" ] && $resetMACsScript -e eth0 || echo "$resetMACsScript" failed unset resetMACsScript

  # --------------------------- # start EPICS IOC script # - checks in script $startEpicsIocScript # for matching hostnames and starts IOC in background # P.Zumbruch, GSI, 13-01-2010

  startEpicsIocScript=/home/hadaq/EPICS/startupProcedures/startEpicsIoc.sh [ -x "$startEpicsIocScript" ] && $startEpicsIocScript || echo "$startEpicsIocScript" failed unset startEpicsIocScript

  # --------------------------- export PATH=$PATH:/home/hadaq:/home/hadaq/bin

  %end%

• Created in /home/hadaq/EPICS/startupProcedures script resetMACs.sh calling callee resetMAC.sh
  ... (Click to expand) (Click to retract)

  %begin bash% #/bin/sh # resetMACs.sh # # dispatcher for resetMAC.sh # - checks for matching hostnames and # calls $resetMac.sh resets MAC address depending on HOSTNAME content # # created: 13-01-2010 # author: p.zumbruch, GSI # modified: 13-01-2010

  #debug - uncomment to debug #set -xv

  #predefines scriptname=resetMACs.sh myHostname=$(hostname) mylist='etrax042 etrax043 etrax044 etrax045 etrax046 etrax047 etrax048' HomeHadaq=/home/hadaq resetMACscript=${HomeHadaq}/EPICS/startupProcedures/resetMAC.sh interface=eth0

  unset myDebug;

  #unset function unsets () { unset myHostname mylist item resetMACscript unset scriptname HomeHadaq interface

  return 0; }

  #usage function usage() { echo echo "$scriptname" echo "usage: $scriptname [options]" echo echo " dispatcher for resetMAC.sh," echo " checks for matching hostnames with a given list of hostname" echo " and calls resetMAC.sh, which resets their MAC according to the hostname" echo echo "options:" echo " -H hostname : hostname" echo " [\`${myHostname}']" echo " -s scriptname : resetMACscript name (absolute path) " echo " [\`${resetMACscript}']" echo " -e interface : uses ethernet interface" echo " [\`$interface']" echo " -l list : quoted space separated list of hostnames, whose MACs are to be reset" echo " [\`\"$mylist\"']" echo " -D : just echos command instead of executing [$([ -z "${myDebug}" ] && echo OFF || echo ON)]" echo " -d : debug mode sets set -xv" echo " -h : this help" echo }

  #eval options while getopts dhe:l:s:DH: arg do case $arg in \? | h )usage ; unsets; exit 0; shift ;; H ) myHostname=$OPTARG; shift 2;; e ) interface=$OPTARG; shift 2;; l ) mylist=$OPTARG; shift 2;; s ) resetMACscript=$OPTARG; shift 2;; d ) set -xv shift;; D ) myDebug=echo shift;; esac done

  #checks, directories and permissions ... # hostname if [ -z "$myHostname" ] then echo "$scriptname: hostname not available ... exiting" 1>&2 unsets exit 1; fi # interface if [ -z "$interface" ] then echo "$scriptname: interface not set ... exiting" 1>&2 unsets exit 1; fi # resetMAC script if [ ! -x "${resetMACscript}" ] then echo "$scriptname: reset MAC Script: \`${resetMACscript}' is not executable or available ... exiting" 1>&2 unsets exit 1; fi

  #execute for item in $mylist do if [ "$item" = "$myHostname" ] then ${myDebug} ${resetMACscript} -e ${interface} break; fi done

  unsets

  exit 0

  %end%

• Modified/Extended in /home/hadaq/EPICS/startupProcedures the procServ calling script startBackgroundEpicsIoc.sh
  ... (Click to expand) (Click to retract)

  ... due to the length of this script just the help is shown

  startBackgroundEpicsIOC.sh
  usage: startBackgroundEpicsIOC.sh [options]
  
  starts EPICS IOC in background using procServ tool,
    which spawns and automatically respawns the ioc process
    and makes it available via local telnet:
     telnet localhost port
          where port is set to default `4813'
  options:
     -w workingDir   : EPICS IOC application dir / a.k.a. workingDir (absolute path)
                        [`/home/hadaq/EPICS/epics_apps/HadControlTemperatureAndThreshold']
     -i iocBootdir   : EPICS IOC iocboot dir
                        place where to change to and where log and pid files may be written (absolute path)
                        [`/home/hadaq/EPICS/epics_apps/HadControlTemperatureAndThreshold/iocBoot/iocHadControlTemperatureAndThreshold_linux-cris_v10']
     -c command file : st.cmd file started relativ to `./'
                        if not absolute path, taken relatively to `EpicsIocBootDir'
                        [`st_linux-cris_v10.cmd']
     -a commandArgs  : [quoted list] of argument[s] for executable of ioc process,
                        [`""']
     -P procServ exe : procServ executable
                        [`/home/hadaq/EPICS/startupProcedures/procServ/procServ']
     -L procServ lib : procServ lib path needed to be added to LD_LIBRARY_PATH, multiple calls possible
                        [`/home/hadaq/EPICS/startupProcedures/procServ/lib']
     -p port         : telnet port [`4813'], see above
     -t logport      : set log readonly telnet port for active procServ access (NOTE: default log port will be port+1)
                        [`4814']
     -g              : activate file logging for procServ [OFF]
     -G loggingDir   : file logging directory,
                        if not absolute path, taken relatively to `workingDir' [`/home/hadaq/EPICS/epics_apps/HadControlTemperatureAndThreshold']
                        [`/home/hadaq/EPICS/epics_apps/HadControlTemperatureAndThreshold']
     -D              : debug mode of procServ [OFF]
     -I name         : name of (IOC) process
                        [`etrax047:4813_st_linux-cris_v10.cmd']
     -o "options"    : additional options for procServ
                        [`']
     General:
     -b baseHome     : home directory of hadaq
                        [`/home/hadaq']
     -n              : no action, just echos command instead of executing the ioc process [OFF]
     -d              : debug mode of caller, sets set -xv [OFF]
     -v              : verbosity of caller, can be called repeatedly  [OFF]
     -e scriptname   : helper script internally used by `startBackgroundEpicsIOC.sh' for checks
                              defaults to be searched in the same directory as \'startBackgroundEpicsIOC.sh'
                        [`./exitIfHelpers.sh']
     -q              : sets verbosity of caller off [OFF]
     -h              : this help
  

• Created in /home/hadaq/EPICS/startupProcedures script startEpicsIoc.sh calling callee startBackgroundEpicsIoc.sh
  ... (Click to expand) (Click to retract)

  ... due to the length of this script just the help is shown

  
  startEpicsIoc.sh
  usage: startEpicsIoc.sh [options]
  
   caller for script calling EPICS IOCs with procServ in "Background",
    checks for matching hostnames with a given list of hostname,
    or a file with a lookuptable to be evaluated
    and calls the start script with the right argument
  
  options:
  
     Caller:
     -H hostname     : hostname
                         [`etrax047']
     -s scriptname   : background starting script's name (absolute path)
                         [`/home/hadaq/EPICS/startupProcedures/startBackgroundEpicsIoc.sh']
     -e scriptname   : helper script internally used by `startEpicsIoc.sh' for checks
                defaults to be searched in the same directory as \'startEpicsIoc.sh'
                         [`./exitIfHelpers.sh']
     -l list         : quoted space separated list of hostnames, where an IOC should be started
                         [`"etrax047 etrax048"']
     -m              : allow several IOCs running [needs differing telnet ports to monitor/control]
                         [`"yes"']
     -f file         : file to retrieve hostnames, executables, dirs, arguments from,
                         overwrites all other relevant/default settings (absolute path)
                         [`iocListFile-Etrax.txt']
     -S char         : character separating the entries in the ioc list file
                         [`|']
  
     Callee:
     -w workingDir   : place where log (default) and pid files may be written (absolute path)
                         [`']
     -i iocBootDir   : place where to change to IOC's boot directory,
                         if not absolute path, taken relatively to `workingDir'
                         [`']
     -c commandExe   : executable to be executed by callee,
                         if not absolute path, taken relatively to `workingDir'
                         [`']
     -a commandArgs  : [quoted list] of argument[s] for executable to be executed by callee,
                         [`""']
     -A commandArgs  : [quoted list] of [additional] argument[s] for callee,
                         [`""']
     -I name         : name to assign to the process (ioc) the callee starts
                         [automatically set by callee]
     -g              : activate file logging for procServ [OFF]
     -G loggingDir   : file logging directory,
                         if not absolute path, taken relatively to `workingDir' [`']
                         [`']
     -p port         : set telnet port for active procServ access, (NOTE: readonly port will be port+1)
                         [`4813']
     -t logport      : set log readonly telnet port for active procServ access (NOTE: default log port will be port+1)
                         [`']
     -P procServExe  : procServ executable
                         if not absolute path, taken relatively to `baseHome' [`/home/hadaq']
                         [`/home/hadaq/EPICS/startupProcedures/procServ/procServ']
     -L              : [list of colon ':' separated] shared library paths to be added
                         to LD_LIBRARY_PATH (may be called repeatedly)
                         [`/home/hadaq/EPICS/startupProcedures/procServ/lib']
  
     General:
     -b baseHome     : home directory of hadaq
                         [`/home/hadaq']
     -n              : no caller action, just echos command instead of executing the caller [ON]
     -N              : no callee action, just echos command instead of executing the callee [OFF]
     -d              : debug mode of caller, sets set -xv [OFF]
     -D              : debug mode of callee, sets set -xv [OFF]
     -v              : verbosity of caller, can be called repeatedly  [ON(2)]
     -V              : verbosity of callee, can be called repeatedly  [OFF]
     -q              : sets verbosity of caller off [OFF]
     -Q              : sets verbosity of callee off  [OFF]
     -h              : this help
  

• Created in /home/hadaq/EPICS/startupProcedures helper script exitIfHelpers.sh used by the other scripts
  ... (Click to expand) (Click to retract)

  %begin bash%

  #/bin/sh # exitIfHelpers.sh # # helper functions: # tests: # - If Not Absolute Path # - If Not A File # - If Not A Directory # - If Not Executable # else exits with error 1 # # created: 20-01-2010 # author: p.zumbruch, GSI # modified: 22-01-2010

  #debug - uncomment to debug #set -xv

  isAbsolutePath() { # isAbsolutePath path # checks if path is absolute # exit values: # 0 : is not absolute # 1 : is absolute

  [ 3 -le $myVerbosity ] && myLevel=$(($myLevel+1)) && echo [${myLevel}] entering function \"isAbsolutePath $*\"

  if [ $# -lt 1 ] then echo "$scriptname: function \"absolutePath\" called with too few arguments, needs at least \"$0 path [name]\" ... exiting" 1>&2 unsets exit 1; fi

  if [ ! -z "${1##/*}" ] # doesn't start with '/' then if [ ! -z "${1##~*}" ] # nor starts with "~" then [ 3 -le $myVerbosity ] && echo [${myLevel}] " leaving" function \"isAbsolutePath\" [return: 1]&& myLevel=$(($myLevel-1)) return 1; fi fi

  [ 3 -le $myVerbosity ] && echo [${myLevel}] " leaving" function \"isAbsolutePath\" [return: 0] && myLevel=$(($myLevel-1))

  return 0; }

  #exitIfNotAbsolutePath function exitIfNotAbsolutePath() { # exitIfNotAbsolutePath path description # checks if path is absolute # otherwise exits

  [ 3 -le $myVerbosity ] && myLevel=$(($myLevel+1)) && echo [${myLevel}] entering function \"exitIfNotAbsolutePath $*\"

  if [ $# -lt 1 ] then echo "$scriptname: function \"exitIfNotAbsolutePath\" called with too few arguments, needs at least \"$0 path [name]\" ... exiting" 1>&2 unsets exit 1; fi

  isAbsolutePath $1 if [ 0 -ne $? ] then echo "$scriptname: $2 \`${1}' is not an absulute path ... exiting" 1>&2 unsets exit 1; fi [ 3 -le $myVerbosity ] && echo [${myLevel}] " leaving" function \"exitIfNotAbsolutePath\" && myLevel=$(($myLevel-1)) }

  #exitIfNotAFile function exitIfNotAFile() { # exitIfNotAFile path description # checks if path is a file # otherwise exits

  [ 3 -le $myVerbosity ] && myLevel=$(($myLevel+1)) && echo [${myLevel}] entering function \"exitIfNotAFile $*\"

  if [ $# -lt 1 ] then echo "$scriptname: function \"exitIfNotAFile\" called with too few arguments, needs at least \"$0 path [name]\" ... exiting" 1>&2 unsets exit 1; fi

  if [ ! -f "${1}" ] then echo "$scriptname: $2 \`${1}' is not a file ... exiting" 1>&2 unsets exit 1; fi

  [ 3 -le $myVerbosity ] && echo [${myLevel}] " leaving" function \"exitIfNotAFile\" && myLevel=$(($myLevel-1)) }

  #exitIfNotADirectory function exitIfNotADirectory() { # exitIfNotADirectory path description # checks if path is a directory # otherwise exits

  [ 3 -le $myVerbosity ] && myLevel=$(($myLevel+1)) && echo [${myLevel}] entering function \"exitIfNotADirectory $*\"

  if [ $# -lt 1 ] then echo "$scriptname: function \"exitIfNotADirectory\" called with too few arguments, needs at least \"$0 path [name]\" ... exiting" 1>&2 unsets exit 1; fi

  if [ ! -d "${1}" ] then echo "$scriptname: $2 \`${1}' is not a directory ... exiting" 1>&2 unsets exit 1; fi

  [ 3 -le $myVerbosity ] && echo [${myLevel}] " leaving" function \"exitIfNotADirectory\" && myLevel=$(($myLevel-1)) }

  #exitIfNotExecutable function exitIfNotExecutable() { # exitIfNotAbsolutePath exe description # checks if exe is executable # otherwise exits

  [ 3 -le $myVerbosity ] && myLevel=$(($myLevel+1)) && echo [${myLevel}] entering function \"exitIfNotExecutable $*\"

  if [ $# -lt 1 ] then echo "$scriptname: function \"exitIfNotAbsolutePath\" called with too few arguments, needs at least \"$0 path [name]\" ... exiting" 1>&2 unsets exit 1; fi

  exitIfNotAFile $*

  if [ ! -x "${1}" ] then echo "$scriptname: $2 \`${1}' is not an executable or does not exist ... exiting" 1>&2 unsets exit 1; fi

  [ 3 -le $myVerbosity ] && echo [${myLevel}] " leaving" function \"exitIfNotExecutable\" && myLevel=$(($myLevel-1)) } %end%

• Created in /home/hadaq/EPICS/startupProcedures lookup table file IocListFile.txt
  ... (Click to expand) (Click to retract)

  # IOC list file
  # 
  # hostname | command exe  | command arguments | telnet  | telnet | logging directory | working dir a.k.a application dir | IOC boot directory | procServ exe | procServ libs | name | baseHome 
  #          |              |                   | control | log    |                   |                                   |                    |              |               |      |
  #          |              |                   | port    | port   |                   |                                   |                    |              |               |      |
  #
     
  # PZ
  etrax047   | st_linux-cris_v10.cmd | | 4813 | 4814 | | /home/hadaq/EPICS/epics_apps/HadControlTemperatureAndThreshold | iocBoot/iocHadControlTemperatureAndThreshold_linux-cris_v10 | 
  etrax048   | st_linux-cris_v10.cmd | | 4813 | 4814 | | /home/hadaq/EPICS/epics_apps/HadControlTemperatureAndThreshold | iocBoot/iocHadControlTemperatureAndThreshold_linux-cris_v10 | 
    
  # RPC LV
  #etrax105   | ...                   | | 4813 | 4814 | | ...                  
  #etrax106   | ...                   | | 4813 | 4814 | | ...                  
  #etrax107   | ...                   | | 4813 | 4814 | | ...                  
  #etrax108   | ...                   | | 4813 | 4814 | | ...                  
  #etrax109   | ...                   | | 4813 | 4814 | | ...                  
  #etrax110   | ...                   | | 4813 | 4814 | | ...                  
  

• Again changed rc script in /home/hadaq/etc to call the specific iocListFile
  ... (Click to expand) (Click to retract)

  %begin bash% #!/bin/sh # rc # script called at system startup/reboot

  # # [...] commented out code #

  # --------------------------- # set the time server if [ ! -e "/etc/localtime" ] then ln -s /home/hadaq/Berlin /etc/localtime fi /home/hadaq/ntpdate 140.181.90.22

  # --------------------------- # reset MAC address to have the same last to digits of the hostname # - checks in script $resetMACsScript # for matching hostnames and reconfigures eth0 # P.Zumbruch, GSI, 13-01-2010

  resetMACsScript=/home/hadaq/EPICS/startupProcedures/resetMACs.sh [ -x "$resetMACsScript" ] && $resetMACsScript -e eth0 || echo "$resetMACsScript" failed unset resetMACsScript

  # --------------------------- # start EPICS IOC script # - checks in script $startEpicsIocScript # for matching hostnames and starts IOC in background # P.Zumbruch, GSI, 11-02-2010

  startEpicsIocScript=/home/hadaq/EPICS/startupProcedures/startEpicsIoc.sh startEpicsIocListFile=/home/hadaq/EPICS/startupProcedures/iocListFile-Etrax.txt startEpicsIocCommand="$startEpicsIocScript -f $startEpicsIocListFile" [ -x "$startEpicsIocScript" ] && [ -f "$startEpicsIocListFile" ] && $startEpicsIocCommand || echo "$startEpicsIocScript" failed unset startEpicsIocScript startEpicsIocListFile

  # --------------------------- export PATH=$PATH:/home/hadaq:/home/hadaq/bin

  %end%

• Created tar file: EPICS_startupProcedures_hadcon.tar.bz2 of all necessary startup directory structure and files in /home/hadaq/EPICS

Install / Add / New

Change / TODO

• Adopt / Combine startBackgroundEpicsIOC.sh and ioc-template.sh

TRB