2 ########################################################################
3 # Begin $rc_base/init.d/functions
5 # Description : Run Level Control Functions
7 # Authors : Gerard Beekmans - gerard@linuxfromscratch.org
11 # Notes : With code based on Matthias Benkmann's simpleinit-msb
12 # http://winterdrache.de/linux/newboot/index.html
14 ########################################################################
16 ## Environmental setup
17 # Setup default values for environment
19 export PATH
="/bin:/usr/bin:/sbin:/usr/sbin"
21 # Signal sent to running processes to refresh their configuration
24 # Number of seconds between STOPSIG and FALLBACK when stopping processes
28 # Find current screen size
29 if [ -z "${COLUMNS}" ]; then
31 COLUMNS
=${COLUMNS##* }
34 # When using remote connections, such as a serial port, stty size returns 0
35 if [ "${COLUMNS}" = "0" ]; then
39 ## Measurements for positioning result messages
40 COL
=$
((${COLUMNS} - 8))
43 ## Set Cursor Position Commands, used via echo -e
44 SET_COL
="\\033[${COL}G" # at the $COL char
45 SET_WCOL
="\\033[${WCOL}G" # at the $WCOL char
46 CURS_UP
="\\033[1A\\033[0G" # Up one line, at the 0'th char
48 ## Set color commands, used via echo -e
49 # Please consult `man console_codes for more information
50 # under the "ECMA-48 Set Graphics Rendition" section
52 # Warning: when switching from a 8bit to a 9bit font,
53 # the linux console will reinterpret the bold (1;) to
54 # the top 256 glyphs of the 9bit font. This does
55 # not affect framebuffer consoles
56 NORMAL
="\\033[0;39m" # Standard console grey
57 SUCCESS
="\\033[1;32m" # Success is green
58 WARNING
="\\033[1;33m" # Warnings are yellow
59 FAILURE
="\\033[1;31m" # Failures are red
60 INFO
="\\033[1;36m" # Information is light cyan
61 BRACKET
="\\033[1;34m" # Brackets are blue
63 STRING_LENGTH
="0" # the length of the current message
65 #*******************************************************************************
66 # Function - boot_mesg()
68 # Purpose: Sending information from bootup scripts to the console
70 # Inputs: $1 is the message
71 # $2 is the colorcode for the console
73 # Outputs: Standard Output
75 # Dependencies: - sed for parsing strings.
76 # - grep for counting string length.
79 #*******************************************************************************
92 echo "Unknown Option: ${1}"
101 ## Figure out the length of what is to be printed to be used
102 ## for warning messges.
103 STRING_LENGTH
="`echo "${1}" | sed \
104 -e 's,.,.,g' -e 'l 1' | grep -c \$`"
106 # Print the message to the screen
107 echo ${ECHOPARM} -e "${2}${1}"
113 # Reset STRING_LENGTH for next message
119 # Left in for backwards compatibility
125 echo -n -e "${CURS_UP}${SET_COL}${BRACKET}[${SUCCESS} OK ${BRACKET}]"
132 echo -n -e "${CURS_UP}${SET_COL}${BRACKET}[${FAILURE} FAIL ${BRACKET}]"
139 echo -n -e "${CURS_UP}${SET_COL}${BRACKET}[${WARNING} WARN ${BRACKET}]"
147 # $i is inherited by the rc script
148 boot_mesg -n "FAILURE
:\n\nYou should not be reading this error message.
\n\n" ${FAILURE}
149 boot_mesg -n " It means that an unforeseen error took
"
150 boot_mesg -n " place
in ${i}, which exited with a
return value of
"
151 boot_mesg " ${error_value}.
\n"
153 boot_mesg -n "If you
're able to track this"
154 boot_mesg -n " error down to a bug in one of the files provided by"
155 boot_mesg -n " the LFS book, please be so kind to inform us at"
156 boot_mesg " lfs-dev@linuxfromscratch.org.\n"
158 boot_mesg -n "Press Enter to continue..." ${INFO}
159 boot_mesg "" ${NORMAL}
163 check_script_status()
165 # $i is inherited by the rc script
166 if [ ! -f ${i} ]; then
167 boot_mesg "${i} is not a valid symlink." ${WARNING}
172 if [ ! -x ${i} ]; then
173 boot_mesg "${i} is not executable, skipping." ${WARNING}
183 if [ ${error_value} = 0 ]; then
189 # This prevents the 'An Unexpected Error Has Occurred
' from trivial
196 if [ "${#}" = "0" ]; then
197 echo "Usage: ${0} {success|warning|failure}"
208 # Leave this extra case in because old scripts
209 # may call it this way.
212 echo -e -n "${CURS_UP}"
213 echo -e -n "\\033[${STRING_LENGTH}G "
214 boot_mesg "Already running." ${WARNING}
218 echo -e -n "${CURS_UP}"
219 echo -e -n "\\033[${STRING_LENGTH}G "
220 boot_mesg "Not running." ${WARNING}
224 echo -e -n "${CURS_UP}"
225 echo -e -n "\\033[${STRING_LENGTH}G "
226 boot_mesg "Not available." ${WARNING}
230 # This is how it is supposed to
247 if [ "${#}" = "0" ]; then
248 echo "Usage: reloadproc [{program}]"
254 if [ -n "${pidlist}" ]; then
256 for pid in ${pidlist}
258 kill -"${RELOADSIG}" "${pid}" || failure="1"
265 boot_mesg "Process ${1} not running." ${WARNING}
274 echo "Usage: statusproc {program}"
280 if [ -n "${pidlist}" ]; then
281 echo -e "${INFO}${base} is running with Process"\
282 "ID(s) ${pidlist}.${NORMAL}"
284 if [ -n "${base}" -a -e "/var/run/${base}.pid" ]; then
285 echo -e "${WARNING}${1} is not running but"\
286 "/var/run/${base}.pid exists.${NORMAL}"
288 if [ -n "${PIDFILE}" -a -e "${PIDFILE}" ]; then
289 echo -e "${WARNING}${1} is not running"\
290 "but ${PIDFILE} exists.${NORMAL}"
292 echo -e "${INFO}${1} is not running.${NORMAL}"
298 # The below functions are documented in the LSB-generic 2.1.0
300 #*******************************************************************************
301 # Function - pidofproc [-s] [-p pidfile] pathname
303 # Purpose: This function returns one or more pid(s) for a particular daemon
305 # Inputs: -p pidfile, use the specified pidfile instead of pidof
306 # pathname, path to the specified program
308 # Outputs: return 0 - Success, pid's
in stdout
309 # return 1 - Program is dead, pidfile exists
310 # return 2 - Invalid or excessive number of arguments,
312 # return 3 - Program is not running
314 # Dependencies: pidof, echo, head
316 # Todo: Remove dependency on head
317 # This depreciates getpids
318 # Test changes to pidof
320 #*******************************************************************************
336 # Added for legacy opperation of getpids
337 # eliminates several '> /dev/null'
342 log_failure_msg
"Unknown Option: ${1}"
351 if [ "${#}" != "1" ]; then
353 log_failure_msg
"Usage: pidofproc [-s] [-p pidfile] pathname"
357 if [ -n "${pidfile}" ]; then
358 if [ ! -r "${pidfile}" ]; then
359 return 3 # Program is not running
362 lpids
=`head -n 1 ${pidfile}`
365 if [ "${pid}" -ne "$$" -a "${pid}" -ne "${PPID}" ]; then
366 kill -0 "${pid}" > /dev
/null
&&
367 pidlist
="${pidlist} ${pid}"
370 if [ "${silent}" -ne "1" ]; then
374 test -z "${pidlist}" &&
375 # Program is dead, pidfile exists
382 pidlist
=`pidof -o $$ -o $PPID -x "$1"`
383 if [ "x${silent}" != "x1" ]; then
387 # Get provide correct running status
388 if [ -n "${pidlist}" ]; then
396 if [ "$?" != "0" ]; then
397 return 3 # Program is not running
401 # This will ensure compatibility with previous LFS Bootscripts
404 if [ -z "${PIDFILE}" ]; then
405 pidofproc
-s -p "${PIDFILE}" $@
412 #*******************************************************************************
413 # Function - loadproc [-f] [-n nicelevel] [-p pidfile] pathname [args]
415 # Purpose: This runs the specified program as a daemon
417 # Inputs: -f, run the program even if it is already running
418 # -n nicelevel, specifies a nice level. See nice(1).
419 # -p pidfile, uses the specified pidfile
420 # pathname, pathname to the specified program
421 # args, arguments to pass to specified program
423 # Outputs: return 0 - Success
424 # return 2 - Invalid of excessive number of arguments,
426 # return 4 - Program or service status is unknown
430 # Todo: LSB says this should be called start_daemon
431 # LSB does not say that it should call evaluate_retval
432 # It checks for PIDFILE, which is deprecated.
433 # Will be removed after BLFS 6.0
434 # loadproc returns 0 if program is already running, not LSB compliant
436 #*******************************************************************************
443 # This will ensure compatibility with previous LFS Bootscripts
444 if [ -n "${PIDFILE}" ]; then
464 log_failure_msg
"Unknown Option: ${1}"
465 return 2 #invalid or excess argument(s)
473 if [ "${#}" = "0" ]; then
474 log_failure_msg
"Usage: loadproc [-f] [-n nicelevel] [-p pidfile] pathname [args]"
475 return 2 #invalid or excess argument(s)
478 if [ -z "${forcestart}" ]; then
479 if [ -z "${pidfile}" ]; then
482 pidofproc
-s -p "${pidfile}" "${1}"
487 log_warning_msg
"Unable to continue: ${1} is running"
491 log_warning_msg
"Unable to continue: ${pidfile} exists"
497 log_failure_msg
"Unknown error code from pidofproc: ${?}"
503 nice
-n "${nicelevel}" "${@}"
504 evaluate_retval
# This is "Probably" not LSB compliant, but required to be compatible with older bootscripts
508 #*******************************************************************************
509 # Function - killproc [-p pidfile] pathname [signal]
513 # Inputs: -p pidfile, uses the specified pidfile
514 # pathname, pathname to the specified program
515 # signal, send this signal to pathname
517 # Outputs: return 0 - Success
518 # return 2 - Invalid of excessive number of arguments,
520 # return 4 - Unknown Status
524 # Todo: LSB does not say that it should call evaluate_retval
525 # It checks for PIDFILE, which is deprecated.
526 # Will be removed after BLFS 6.0
528 #*******************************************************************************
535 # This will ensure compatibility with previous LFS Bootscripts
536 if [ -n "${PIDFILE}" ]; then
548 log_failure_msg
"Unknown Option: ${1}"
557 if [ "${#}" = "2" ]; then
559 elif [ "${#}" != "1" ]; then
561 log_failure_msg
"Usage: killproc [-p pidfile] pathname [signal]"
565 if [ -z "${pidfile}" ]; then
568 pidofproc
-s -p "${pidfile}" "${1}"
572 if [ -n "${pidlist}" ]; then
573 for pid
in ${pidlist}
575 kill -${killsig:-TERM} ${pid} 2>/dev
/null
576 if [ -z "${killsig}" ]; then
577 # Wait up to 3 seconds, for ${pid} to terminate
578 local dtime
=${KILLDELAY}
579 while [ "${dtime}" != "0" ]
581 kill -0 ${pid} 2>/dev
/null ||
break
583 dtime
=$
(( ${dtime} - 1))
585 # If ${pid} is still running, kill it
586 kill -0 ${pid} 2>/dev
/null
&& kill -KILL ${pid} 2>/dev
/null
590 if [ -z "${killsig}" ]; then
593 # Program was terminated
594 if [ "$?" != "0" ]; then
596 if [ -f "${pidfile}" ]; then
601 else # Program is still running
603 return 4 # Unknown Status
606 if [ -z "${pidfile}" ]; then
609 pidofproc
-s -p "${pidfile}" "${1}"
613 evaluate_retval
# This is "Probably" not LSB compliant, but required to be compatible with older bootscripts
616 print_status warning not_running
621 #*******************************************************************************
622 # Function - log_success_msg "message"
624 # Purpose: Print a success message
626 # Inputs: $@ - Message
628 # Outputs: Text output to screen
634 #*******************************************************************************
637 echo -n -e "${BOOTMESG_PREFIX}${@}"
638 echo -e "${SET_COL}""${BRACKET}""[""${SUCCESS}"" OK ""${BRACKET}""]""${NORMAL}"
642 #*******************************************************************************
643 # Function - log_failure_msg "message"
645 # Purpose: Print a failure message
647 # Inputs: $@ - Message
649 # Outputs: Text output to screen
655 #*******************************************************************************
657 echo -n -e "${BOOTMESG_PREFIX}${@}"
658 echo -e "${SET_COL}""${BRACKET}""[""${FAILURE}"" FAIL ""${BRACKET}""]""${NORMAL}"
662 #*******************************************************************************
663 # Function - log_warning_msg "message"
665 # Purpose: print a warning message
667 # Inputs: $@ - Message
669 # Outputs: Text output to screen
675 #*******************************************************************************
677 echo -n -e "${BOOTMESG_PREFIX}${@}"
678 echo -e "${SET_COL}""${BRACKET}""[""${WARNING}"" WARN ""${BRACKET}""]""${NORMAL}"
686 echo "Usage: animate {hook}"
693 # End $rc_base/init.d/functions