/etc/rc.d/init.d/functions檔案詳細分析
阿新 • • 發佈：2019-01-21
functions這個指令碼是給/etc/init.d裡邊的檔案使用的（可理解為全域性檔案）。
提供了一些基礎的功能，看看裡邊究竟有些什麼。首先會設定umask，path，還有語言環境，然後會設定success,failure,warning,normal幾種情況下的字型顏色。
下面再看看提供的重要方法：
checkpid:檢查是否已存在pid，如果有一個存在，返回0（通過檢視/proc目錄）
daemon:啟動某個服務。/etc/init.d目錄部分指令碼的start使用到這個
killproc:殺死某個程序。/etc/init.d目錄部分指令碼的stop使用到這個
pidfileofproc:尋找某個程序的pid
pidofproc:類似上面的，只是還查找了pidof命令
status:返回一個服務的狀態
echo_success,echo_failure,echo_passed,echo_warning分別輸出各類資訊
success,failure,passed,warning分別記錄日誌並呼叫相應的方法
action:列印某個資訊並執行給定的命令，它會根據命令執行的結果來呼叫 success,failure方法
strstr:判斷$1是否含有$2
confirm:顯示 "Start service $1 (Y)es/(N)o/(C)ontinue? [Y]"的提示資訊，並返回選擇結果
詳細分析：
# -*-Shell-script-*-
#
# functions This file contains functions to be used by most or all # 註釋 ：該指令碼幾乎被 /etc/init.d/ 下的所有指令碼所呼叫，因為它包含了大量的
# shell scripts in the /etc/init.d directory. # 的基礎函式。同時也被 /etc/rc.d/rc.sysinit ，例如 success、action、failure 等函式
umask 022 # Set up a default search path. # 設定預設的 PATH 變數
PATH="/sbin:/usr/sbin:/bin:/usr/bin:/usr/X11R6/bin" # 預設為 /sbin:/usr/sbin:/bin:/usr/bin:/usr/X11R6/bin
export PATH # 匯出為環境變數 # Get a sane screen width # 設定正確的螢幕寬度
[ -z "${COLUMNS:-}" ] && COLUMNS=80 # 如果 COLUMNS 變數的值為空，則設定為 80 （列） [ -z "${CONSOLETYPE:-}" ] && CONSOLETYPE="`/sbin/consoletype`" # 如果 CONSOLETYPE 為空則設定 CONSOLETYPE 為 /sbin/consoletype 命令返回的值 # 一般是 vt 或者 pty 、serial ########################################################################################################################################################## if [ -f /etc/sysconfig/i18n -a -z "${NOLOCALE:-}" ] ; then # 如果存在 /etc/sysconfig/i18n 且 NOLOCALE 變數的值為空，則
. /etc/sysconfig/i18n # 執行 /etc/sysconfig/i18n 檔案，取得 LANG 變數的值
if [ "$CONSOLETYPE" != "pty" ]; then # 如果當前 console 型別不是 pty（遠端登入），而是 vt 或者 serial ，則
case "${LANG:-}" in # 根據 LANG 的值作出選擇
ja_JP*|ko_KR*|zh_CN*|zh_TW*|bn_*|bd_*|pa_*|hi_*|ta_*|gu_*) # 如果 LANG 是 日文、中文簡體、中文繁體、韓文等，則
export LC_MESSAGES=en_US # 把 LC_MESSAGES 設定為 en_US
export LANG # 同時匯出為環境變數
;;
*)
export LANG # 如果是其他型別的語言，則直接匯出 LANG
; ;
esac
else # 如果當前 consle 是 pty
[ -n "$LC_MESSAGES" ] && export LC_MESSAGES # 且如果 LC_MESSAGES 不為空，則直接匯出 LC_MESSAGES
export LANG
fi
fi ########################################################################################################################################################## # 下面是設定 success、failure、passed、warning 4種情況下的字型顏色的 # Read in our configuration
if [ -z "${BOOTUP:-}" ]; then # 首先如果 BOOTUP 變數為空，則
if [ -f /etc/sysconfig/init ]; then # 如果存在 /etc/sysconfig/init 檔案，執行 /etc/sysconfig/init 檔案
. /etc/sysconfig/init
else # 否則我們就手工設定
# This all seem confusing? Look in /etc/sysconfig/init,
# or in /usr/doc/initscripts-*/sysconfig.txt
BOOTUP=color # 第一設定 BOOTUP 變數，預設就是 color
RES_COL=60 # 第二設定設定在螢幕的第幾列輸出後面的 "[ xxx ]" ，預設是第60列
MOVE_TO_COL="echo -en //033[${RES_COL}G" # MOVE_TO_COL 是用於列印 "OK" 或者 "FAILED" ,或者 "PASSED" ,或者 "WARNING" 之前的部分，不含 "["
SETCOLOR_SUCCESS="echo -en //033[1;32m" # SETCOLOR_SUCCESS 設定後面的字型都為綠色
SETCOLOR_FAILURE="echo -en //033[1;31m" # SETCOLOR_FAILURE 設定後面將要輸出的字型都為紅色
SETCOLOR_WARNING="echo -en //033[1;33m" # SETCOLOR_WARNING 設定後面將要輸出的字型都為黃色
SETCOLOR_NORMAL="echo -en //033[0;39m" # SETCOLOR_NORMAL 設定後面輸出的字型都為白色（預設）
LOGLEVEL=1
fi
if [ "$CONSOLETYPE" = "serial" ]; then # 如果是通過串列埠登入的，則全部取消彩色輸出
BOOTUP=serial
MOVE_TO_COL=
SETCOLOR_SUCCESS=
SETCOLOR_FAILURE=
SETCOLOR_WARNING=
SETCOLOR_NORMAL=
fi
fi ########################################################################################################################################################## if [ "${BOOTUP:-}" != "verbose" ]; then # 如果 BOOTUP 變數的值不為 verbose ，則
INITLOG_ARGS="-q" # 把 INITLOG_ARGS 的值設定為 -q （安靜模式）
else # 否則
INITLOG_ARGS= # 把 INITLOG_ARGS 的值請空
fi ########################################################################################################################################################## # Check if $pid (could be plural) are running # 下面定義一個函式 checkpid （），目的是檢查 /proc 下是否存在指定的目錄（例如 /proc/1/）
checkpid() { # 如果有任意一個存在，則返回0；
local i for i in $* ; do
[ -d "/proc/$i" ] && return 0
done
return 1 # 如果給出的引數全部不存在對應的目錄，則返回1
}
########################################################################################################################################################## # A function to start a program. # 下面定義最重要的一個函式，daemon 函式，它的作用是啟動某項服務。/etc/init.d/ 下的指令碼的 start 部分都會用到它
daemon() {
# Test syntax.
local gotbase= force=
local base= user= nice= bg= pid=
nicelevel=0
while [ "$1" != "${1##[-+]}" ]; do # daemon 函式本身可以指定多個選項，例如 --check <value> ，--check=<value> ，
case $1 in
'') echo $"$0: Usage: daemon [nicelevel] {program}" # 也可以指定 nice 值
return 1;;
--check)
base=$2
gotbase="yes"
shift 2
;;
--check=?*)
base=${1#--check=}
gotbase="yes"
shift
;;
--user) # 也可以指定要以什麼使用者身份執行（--user <usr> , --user=<usr>)
user=$2
shift 2
;;
--user=?*)
user=${1#--user=}
shift
;;
--force)
force="force" # --force 表示強制執行
shift
;;
[-+][0-9]*)
nice="nice -n $1" # 如果 daemon 的第一個引數是數字，則認為是 nice 值
shift
;;
*) echo $"$0: Usage: daemon [nicelevel] {program}"
return 1;;
esac
done # Save basename. # basename 就是從伺服器的二進位制程式的 full path 中取出最後的部分
[ -z "$gotbase" ] && base=${1##*/} # See if it's already running. Look *only* at the pid file. # 檢查該服務是否已經在執行。不過 daemon 函式只檢視 pid 檔案而已
if [ -f /var/run/${base}.pid ]; then # 如果 /var/run 下存在該服務的 pid 檔案，則
local line p
read line < /var/run/${base}.pid # 從該 pid 檔案每次讀取一行，送給變數 line 。注意 pid 檔案可能有多行，且不一定都是數字
for p in $line ; do # 對於 line 變數的每個 word 進行檢查
[ -z "${p//[0-9]/}" -a -d "/proc/$p" ] && pid="$pid $p" # 如果 p 全部是數字，且存在 /proc/$p/ 目錄，則認為該數字是一個 pid ，把它加入到 pid 變數
done # 到最後 pid 變數的值可能是有多個由空格分隔的數字組成
fi
[ -n "${pid:-}" -a -z "${force:-}" ] && return # 如果 pid 變數最終為空，則 force 變數為空（不強制啟動），則返回 # make sure it doesn't core dump anywhere unless requested # 下面對該服務使用的資源作一些設定
ulimit -S -c ${DAEMON_COREFILE_LIMIT:-0} >/dev/null 2>&1 # ulimit 是控制由該 shell 啟動的程序能夠使用的資源，-S 是 soft control 的意思，-c 是指最大的 core # dump 檔案大小，如果 DEAMON_COREFILE_LIMIT 為空，則預設為 0
# if they set NICELEVEL in /etc/sysconfig/foo, honor it # 如果存在 /etc/sysconfi/foo 檔案，且其中有 NICELEVEL 變數則用它代替 daemon 後面的那個 nice 值
[ -n "$NICELEVEL" ] && nice="nice -n $NICELEVEL" # 注意，這裡的 nice 賦值是用 nice -n <value> 的格式，因為 nice 本身可以啟動命令，用這個格式較方便
# Echo daemon # 如果 BOOTUP 的值為 verbose ，則列印一個服務名
[ "${BOOTUP:-}" = "verbose" -a -z "$LSB" ] && echo -n " $base" # And start it up. # 下面是開始啟動它了
if [ -z "$user" ]; then # 如果 user 變數為空，則預設使用 root 啟動它
$nice initlog $INITLOG_ARGS -c "$*" # 執行 nice -n <nice_value> initlog -q -c "$*"
else # 如果指定了使用者，則
$nice initlog $INITLOG_ARGS -c "runuser -s /bin/bash - $user -c /"$*/"" # 執行 nice -n <nice_value> initlog -q -c "runuser -s /bin/bash - <user> -c "$*"
fi
[ "$?" -eq 0 ] && success $"$base startup" || failure $"$base startup" # 如果上面的命令成功，則顯示一個綠色的 [ OK ] ，否則顯示 [ FAILURE ]
} ########################################################################################################################################################## # A function to stop a program. # 下面定義另外一個很重要的函式 killproc ，/etc/init.d/ 下面的指令碼的 stop 部分都會用到它
killproc() {
RC=0 # RC 是最終返回的值，初始化為 0
# Test syntax.
if [ "$#" -eq 0 ]; then # killproc 函式的語法格式是 killproc <service> [<signal>] ，例如 killproc sm-client 9
echo $"Usage: killproc {program} [signal]"
return 1
fi notset=0 # noset 是用於檢查使用者是否指定了 kill 要使用的訊號
# check for second arg to be kill level
if [ -n "$2" ]; then # 如果 $2 不為空，則表示使用者有設定訊號，則
killlevel=$2 # 把 $2 的值賦予 killlevel 變數
else # 否則
notset=1 # notset 變數的值為1，同時 killlevel 為 '-9' （KILL 訊號）
killlevel="-9"
fi # 補充 ：注意，並不是說使用者沒有指定訊號地停止某項服務時，就會立即用 kill -9 這樣的方式強制殺死，而是先用 TERM 訊號，然後再用 KILL # Save basename.
base=${1##*/} # basename 就是得出服務的名稱 # Find pid.
pid= # 把 pid 變數的值清空。注意，不是指 pid 變數的值等於下面指令碼的執行結果，要看清楚
if [ -f /var/run/${base}.pid ]; then # 下面和上面的 daemon 函式一樣找出 pid
local line p
read line < /var/run/${base}.pid
for p in $line ; do
[ -z "${p//[0-9]/}" -a -d "/proc/$p" ] && pid="$pid $p"
done
fi
if [ -z "$pid" ]; then # 不過和 daemon 不同的是，一旦 pid 為空不會直接 return 而是嘗試用 pid 命令再次查詢
pid=`pidof -o $$ -o $PPID -o %PPID -x $1 || / # -o 是用於忽略某個 pid ，-o $$ 是忽略當前 shell 的 pid、-o $PPID 是忽略 shell 的 pid
pidof -o $$ -o $PPID -o %PPID -x $base` # -o %PPID 是忽略 pidof 命令的父程序，要查詢的程序是 $1 (fullpath) 或者 $base
fi # Kill it.
if [ -n "${pid:-}" ] ; then # 如果 pid 的值最終不為空，則
[ "$BOOTUP" = "verbose" -a -z "$LSB" ] && echo -n "$base " # 且 BOOTUP 的值為 verbose ，且 LSB 變數不為空，則列印一個服務名
if [ "$notset" -eq "1" ] ; then # 如果 notset 變數不為1，表示使用者沒有指定訊號，則
if checkpid $pid 2>&1; then # 呼叫 checkpid $pid 檢查是否在 /proc/ 下存在程序目錄，如果有
# TERM first, then KILL if not dead # 先嚐試用 TERM 資訊，不行再用 KILL 訊號
kill -TERM $pid >/dev/null 2>&1 # 執行 kill -TERM $pid
usleep 100000 # usleep 和 sleep 一樣，不過單位是百萬分之1秒。這裡休眠1秒
if checkpid $pid && sleep 1 && # 如果 checkpid $pid 還是查到有 /proc/<pid>/ 目錄存在，則表示還沒有殺死，繼續等待1秒
checkpid $pid && sleep 3 && # 如果1秒後用 checkpid 檢查還是有，則再等待3秒；
checkpid $pid ; then # 如果還是沒有殺死，則用 KILL 訊號
kill -KILL $pid >/dev/null 2>&1 # 執行 kill -KILL 殺死它
usleep 100000 # 等待1秒種
fi
fi
checkpid $pid # 再次檢查 pid 目錄
RC=$? # 並把結果返回給 RC ，這就算是 killproc 的最後狀態了
[ "$RC" -eq 0 ] && failure $"$base shutdown" || success $"$base shutdown" # 如果 RC 的值為0，則表示kill -9 沒有殺死了程序，則呼叫 failure 函式，否則呼叫 success
RC=$((! $RC))
# use specified level only # 上面都是在沒有指定訊號的情況的，下面是使用者指定了訊號的。例如 restart）或者 reload）部分
else # 這個 else 是針對 if [ "$notset" -eq "1" ] 的
if checkpid $pid; then # 如果檢查到程序存在，則
kill $killlevel $pid >/dev/null 2>&1 # 執行kill命令，但使用指定的訊號 $killlevel
RC=$? # 並把狀態值返回給變數 RC
[ "$RC" -eq 0 ] && success $"$base $killlevel" || failure $"$base $killlevel" # 如果 RC 為0則表示成功，呼叫 success；否則呼叫 failure 函式
fi
fi
else # 這個 else 是針對 if [ -n "${pid:-}" ] 的，也就是說沒有 pid 檔案，pidof 命令也沒有找到 pid ，則
failure $"$base shutdown" # 呼叫 failure 函式，表示停止服務失敗
RC=1 # 同時 RC 的值為1
fi # Remove pid file if any. # 根據具體情況可能需要刪除 pid 檔案
if [ "$notset" = "1" ]; then # 如果 notset 不為1 ，也就是使用者沒有指定訊號的情況
rm -f /var/run/$base.pid # 自動刪除 /var/run 下的 pid 檔案
fi
return $RC # 並把 RC 作為 exit status 返回
} # 補充 ：自所以刪除 pid 檔案只針對 notset 為1 的情況，是因為 -HUP 訊號（重讀配置），並不殺死程序，所以不能刪除它的 pid 檔案 # 例如下面 ： [[email protected] init.d]# ps -ef |grep xinetd
root 2635 1 0 12:25 ? 00:00:00 xinetd -stayalive -pidfile /var/run/xinetd.pid
[[email protected] init.d]# ./xinetd reload
Reloading configuration: [ OK ]
[[email protected] init.d]# ps -ef |grep xinetd
root 2635 1 0 12:25 ? 00:00:00 xinetd -stayalive -pidfile /var/run/xinetd.pid
root 3927 3412 0 16:43 pts/0 00:00:00 grep xinetd
[[email protected] init.d]# 可以看到 pid 在 reload 後並沒有變 ########################################################################################################################################################## # A function to find the pid of a program. Looks *only* at the pidfile # 下面的 pidfileofproc 函式和 checkpid 類似，但不執行 pidof 命令，只查詢 pid 檔案
pidfileofproc() {
local base=${1##*/}
# Test syntax.
if [ "$#" = 0 ] ; then
echo $"Usage: pidfileofproc {program}"
return 1
fi # First try "/var/run/*.pid" files
if [ -f /var/run/$base.pid ] ; then
local line p pid=
read line < /var/run/$base.pid
for p in $line ; do
[ -z "${p//[0-9]/}" -a -d /proc/$p ] && pid="$pid $p"
done
if [ -n "$pid" ]; then
echo $pid
return 0
fi
fi
} ########################################################################################################################################################## # A function to find the pid of a program. # 下面的 pidofproc 函式和上面的 pidfileofproc 函式類似，但多了一步 pidof 命令
pidofproc() {
base=${1##*/} # Test syntax.
if [ "$#" = 0 ]; then
echo $"Usage: pidofproc {program}"
return 1
fi # First try "/var/run/*.pid" files
if [ -f /var/run/$base.pid ]; then
local line p pid=
read line < /var/run/$base.pid
for p in $line ; do
[ -z "${p//[0-9]/}" -a -d /proc/$p ] && pid="$pid $p"
done
if [ -n "$pid" ]; then
echo $pid
return 0
fi
fi
pidof -o $$ -o $PPID -o %PPID -x $1 || /
pidof -o $$ -o $PPID -o %PPID -x $base
} ########################################################################################################################################################## status() { # 註釋 ：下面的 status 函式是判斷服務的狀態，總共有4種
local base=${1##*/}
local pid # Test syntax.
if [ "$#" = 0 ] ; then
echo $"Usage: status {program}"
return 1
fi # First try "pidof" # 同樣是查詢 pid 先。直接使用 pidof 命令
pid=`pidof -o $$ -o $PPID -o %PPID -x $1 || /
pidof -o $$ -o $PPID -o %PPID -x ${base}`
if [ -n "$pid" ]; then # 如果 pid 變數的值不為空，則表示找到程序，
echo $"${base} (pid $pid) is running..." # 則列印 "xxx (pid nnn) is running " ,
return 0 # 並返回 0
fi # Next try "/var/run/*.pid" files # 如果 pidof 命令沒有找到，則嘗試從 pid 檔案找
if [ -f /var/run/${base}.pid ] ; then
read pid < /var/run/${base}.pid
if [ -n "$pid" ]; then # 如果 pidof 命令找不到，但從 pid 檔案找到了 pid ，則
echo $"${base} dead but pid file exists" # 列印 "xxx dead but pid file exists"，
return 1 # 並返回 1
fi
fi
# See if /var/lock/subsys/${base} exists # 如果 pidof 命令和 pid 檔案都沒有找到 pid ，則
if [ -f /var/lock/subsys/${base} ]; then # 如果在 /var/lock/subsys 下存在對應的檔案，則
echo $"${base} dead but subsys locked" # 列印 “xxxx dead but subsys locked”，
return 2 # 並返回 2
fi
echo $"${base} is stopped" # 如果 pidof 命令、pidf 檔案都沒有找到pid ，且沒有別鎖，則列印 “xxx is stopped”
return 3 # 並返回3
} ########################################################################################################################################################## # 註釋 ：下面的 echo_xxx 函式就是真正在螢幕上列印 [ ok ] 、[ PASSED ]、[ FAILURE ]、[ WARNING ] 的部分了 echo_success() { # 下面是 echo_success 部分
[ "$BOOTUP" = "color" ] && $MOVE_TO_COL # 首先是列印 “[” 之前的空格
echo -n "[ " # 然後列印 "["
[ "$BOOTUP" = "color" ] && $SETCOLOR_SUCCESS # 設定字型為紅色
echo -n $"OK" # 列印 OK
[ "$BOOTUP" = "color" ] && $SETCOLOR_NORMAL # 返回字型為白色
echo -n " ]" # 列印 "]"
echo -ne "/r" # 換行。
return 0 # 返回 0，其他一律返回 1 echo_failure() {
[ "$BOOTUP" = "color" ] && $MOVE_TO_COL
echo -n "["
[ "$BOOTUP" = "color" ] && $SETCOLOR_FAILURE
echo -n $"FAILED"
[ "$BOOTUP" = "color" ] && $SETCOLOR_NORMAL
echo -n "]"
echo -ne "/r"
return 1
} echo_passed() {
[ "$BOOTUP" = "color" ] && $MOVE_TO_COL
echo -n "["
[ "$BOOTUP" = "color" ] && $SETCOLOR_WARNING
echo -n $"PASSED"
[ "$BOOTUP" = "color" ] && $SETCOLOR_NORMAL
echo -n "]"
echo -ne "/r"
return 1
} echo_warning() {
[ "$BOOTUP" = "color" ] && $MOVE_TO_COL
echo -n "["
[ "$BOOTUP" = "color" ] && $SETCOLOR_WARNING
echo -n $"WARNING"
[ "$BOOTUP" = "color" ] && $SETCOLOR_NORMAL
echo -n "]"
echo -ne "/r"
return 1
} ########################################################################################################################################################## # Inform the graphical boot of our current state
update_boot_stage() {
if [ "$GRAPHICAL" = "yes" -a -x /usr/bin/rhgb-client ]; then
/usr/bin/rhgb-client --update="$1"
fi
return 0
} ########################################################################################################################################################## # Log that something succeeded
success() { # success 函式除了列印 [ xxx ] 之外，還會使用 initlog 記錄資訊
if [ -z "${IN_INITLOG:-}" ]; then
initlog $INITLOG_ARGS -n $0 -s "$1" -e 1 # -n 是 --name 的意思，-s 是 --string ，-e 是 --event ，1 表示完全成功
else
# silly hack to avoid EPIPE killing rc.sysinit
trap "" SIGPIPE
echo "$INITLOG_ARGS -n $0 -s /"$1/" -e 1" >&21
trap - SIGPIPE
fi
[ "$BOOTUP" != "verbose" -a -z "$LSB" ] && echo_success
return 0
} # Log that something failed
failure() {
rc=$?
if [ -z "${IN_INITLOG:-}" ]; then
initlog $INITLOG_ARGS -n $0 -s "$1" -e 2 # failure 的話 --event 是 2 是失敗
else
trap "" SIGPIPE
echo "$INITLOG_ARGS -n $0 -s /"$1/" -e 2" >&21
trap - SIGPIPE
fi
[ "$BOOTUP" != "verbose" -a -z "$LSB" ] && echo_failure
[