Linux啓動腳本分析之functions | |
|
|
來源: ChinaUnix博客 日期:2009.03.23 11:31 (共有條評論) 我要評論 | |
# -*-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 等函數 # TEXTDOMAIN=initscripts # 設置 TEXTDOMAIN 變量 ########################################################################################################################################################## # Make sure umask is sane # 確保 root 用戶的 umask 是正確的 022 (也就是 rwxr-xr-x) 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 [url=file:///C:/DOCUME~1/ADMINI~1/LOCALS~1/Temp/CyberArticle/033%5B$%7BRES_COL%7DG/]\\033[${RES_COL}G[/url] " # MOVE_TO_COL 是用於打印 "OK" 或者 "FAILED" ,或者 "PASSED" ,或者 "WARNING" 之前的部分,不含 "[" SETCOLOR_SUCCESS="echo -en [url=file:///C:/DOCUME~1/ADMINI~1/LOCALS~1/Temp/CyberArticle/033%5B1;32m/]\\033[1;32m[/url] " # SETCOLOR_SUCCESS 設置後面的字體都爲綠色 SETCOLOR_FAILURE="echo -en [url=file:///C:/DOCUME~1/ADMINI~1/LOCALS~1/Temp/CyberArticle/033%5B1;31m/]\\033[1;31m[/url] " # SETCOLOR_FAILURE 設置後面將要輸出的字體都爲紅色 SETCOLOR_WARNING="echo -en [url=file:///C:/DOCUME~1/ADMINI~1/LOCALS~1/Temp/CyberArticle/033%5B1;33m/]\\033[1;33m[/url] " # SETCOLOR_WARNING 設置後面將要輸出的字體都爲黃色 SETCOLOR_NORMAL="echo -en [url=file:///C:/DOCUME~1/ADMINI~1/LOCALS~1/Temp/CyberArticle/033%5B0;39m/]\\033[0;39m[/url] " # 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 ,--check= , 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 , --user=) 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 # 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 的格式,因爲 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 initlog -q -c "$*" else # 如果指定了用戶,則 $nice initlog $INITLOG_ARGS -c "runuser -s /bin/bash - $user -c \"$*\"" # 執行 nice -n initlog -q -c "runuser -s /bin/bash - -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 [] ,例如 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 # 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// 目錄存在,則表示還沒有殺死,繼續等待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 文件 # 例如下面 : [root@mail init.d]# ps -ef |grep xinetd root 2635 1 0 12:25 ? 00:00:00 xinetd -stayalive -pidfile /var/run/xinetd.pid [root@mail init.d]# ./xinetd reload Reloading configuration: [ OK ] [root@mail 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 [root@mail 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 ########################################################################################################################################################## # 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 ########################################################################################################################################################## 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 ########################################################################################################################################################## # 註釋 :下面的 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 [ -x /usr/bin/rhgb-client ] && /usr/bin/rhgb-client --details=yes return $rc } # Log that something passed, but may have had errors. Useful for fsck passed() { rc=$? if [ -z "${IN_INITLOG:-}" ]; then initlog $INITLOG_ARGS -n $0 -s "$1" -e 1 # passed 的話 --event 還是1 else trap "" SIGPIPE echo "$INITLOG_ARGS -n $0 -s \"$1\" -e 1" >&21 trap - SIGPIPE fi [ "$BOOTUP" != "verbose" -a -z "$LSB" ] && echo_passed return $rc } # Log a warning warning() { rc=$? if [ -z "${IN_INITLOG:-}" ]; then initlog $INITLOG_ARGS -n $0 -s "$1" -e 1 # warning 的話 --event 也是 1 else trap "" SIGPIPE echo "$INITLOG_ARGS -n $0 -s \"$1\" -e 1" >&21 trap - SIGPIPE fi [ "$BOOTUP" != "verbose" -a -z "$LSB" ] && echo_warning return $rc } ########################################################################################################################################################## # Run some action. Log its output. # action 函數是另外一個最重要的函數,它的作用是打印某個提示信息並執行給定命令 tion() { STRING=$1 echo -n "$STRING " if [ "${RHGB_STARTED}" != "" -a -w /etc/rhgb/temp/rhgb-console ]; then echo -n "$STRING " > /etc/rhgb/temp/rhgb-console fi shift initlog $INITLOG_ARGS -c "$*" && success $"$STRING" || failure $"$STRING" rc=$? echo if [ "${RHGB_STARTED}" != "" -a -w /etc/rhgb/temp/rhgb-console ]; then if [ "$rc" = "0" ]; then echo_success > /etc/rhgb/temp/rhgb-console else echo_failed > /etc/rhgb/temp/rhgb-console [ -x /usr/bin/rhgb-client ] && /usr/bin/rhgb-client --details=yes fi echo fi return $rc } ########################################################################################################################################################## # returns OK if $1 contains $2 # strstr 函數是判斷 $1 字符串是否含有 $2 字符串,是則返回0,否則返回1 () { [ "${1#*$2*}" = "$1" ] && return 1 return 0 } ########################################################################################################################################################## # Confirm whether we really want to run this service # confirm 函數是用於交互式的啓動服務 nfirm() { [ -x /usr/bin/rhgb-client ] && /usr/bin/rhgb-client --details=yes while : ; do echo -n $"Start service $1 (Y)es/(N)o/(C)ontinue? [Y] " # 會打印一個提示信息 read answer if strstr $"yY" "$answer" || [ "$answer" = "" ] ; then # 如果 answer 變量是 y 或者 Y 則 return 0 # 返回 0(但未真正啓動) elif strstr $"cC" "$answer" ; then # 如果 answer 是 c 或者 C ,則 rm -f /var/run/confirm # 刪除 /var/run/confirm 文件 [ -x /usr/bin/rhgb-client ] && /usr/bin/rhgb-client --details=no return 2 # 返回2 elif strstr $"nN" "$answer" ; then # 如果 answer 是 n 或者 N,則 return 1 # 直接返回1 fi done } 本文來自ChinaUnix博客,如果查看原文請點:http://blog.chinaunix.net/u3/93926/showart_1875186.html |
Linux啓動腳本分析之functions
發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.