天天看點

linux /etc/init.d/functions詳解

http://www.cnblogs.com/p_w_picpath-eye/archive/2011/10/26/2220405.html

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 等函數

TEXTDOMAIN=initscripts                # 設定 TEXTDOMAIN 變量

#某些系統使用LC_MESSAGES shell變量所指定的消息類型. 其他一些系統根據

shell變量TEXTDOMAIN的值來建立消息類型的名稱, 可能還會加上字尾'.mo'. 如果

你使用TEXTDOMAIN變量, 你可能需要設定變量TEXTDOMAINDIR指向消息類型檔案所

在的位置. 還有某些系統以這種形式兩個變量都使用: TEXTDOMAINDIR/LC_MESSAGES

/Lc_Messages/TEXTDOMAIN.mo.

########################################################################################################################

# 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

#######################*******************************###################

case語句 :它能夠把變量的内容與多個模闆進行比對,再根據成功比對的模闆去決定應該執行哪部分代碼。

  使用格式:

  case 比對主機闆 in

    模闆1 [ | 模闆2 ] … )  語句組 ;;

    模闆3 [ | 模闆4 ] … )  語句組 ;;

  esac

  case語句的比對是從上往下地比對順序。是以,case語句編寫的原則是從上往下,模闆從特殊到普通。在C語言裡,case語句中有default模闆,而在shell程式設計中,可能将模闆寫成*,就可以完成相同的功能。

case語句的模闆支援比對

  比對以n開頭的所有情況: n*

  比對yes的所有字母大小不同的情況: [yY][eE][sS]

  但不支援{}比對,因為模闆可以使用 | 就可以達到目的。

例程:

#!/bin/sh

echo "Please input \"yes\" or \"no\""

read var

case "$var" in

[yY][eE][sS] ) echo "Your input is YES" ;;

[nN][oO]     ) echo "Your input is YES" ;;

*            ) echo "Input Error!"      ;;

esac

exit 0

#############*******************#################

###########################################################################################################

# 下面是設定 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

  if [ "$CONSOLETYPE" = "serial" ]; then                                        # 如果是通過序列槽登入的,則全部取消彩色輸出

      BOOTUP=serial

      MOVE_TO_COL=

      SETCOLOR_SUCCESS=

      SETCOLOR_FAILURE=

      SETCOLOR_WARNING=

      SETCOLOR_NORMAL=

##########################################################################################################################################################

if [ "${BOOTUP:-}" != "verbose" ]; then                    # 如果 BOOTUP 變量的值不為 verbose ,則

   INITLOG_ARGS="-q"                                                    # 把 INITLOG_ARGS 的值設定為 -q (安靜模式)

else                                                                     # 否則

   INITLOG_ARGS=                                                         # 把 INITLOG_ARGS 的值請空 

#################################################################################################

# 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=}

     shift

     --user)                                                                        # 也可以指定要以什麼使用者身份運作(--user <usr> , --user=<usr>)

     user=$2

     --user=?*)

            user=${1#--user=}

     --force)

         force="force"                                                           # --force 表示強制運作

     [-+][0-9]*)

         nice="nice -n $1"                                                        # 如果 daemon 的第一個參數是數字,則認為是 nice 值

            shift

     *)     echo $"$0: Usage: daemon [+/-nicelevel] {program}"

   esac

        # 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 變量的值可能是有多個由空格分隔的數字組成

[ -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 "$*"

[ "$?" -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

if [ "$#" -eq 0 ]; then                                            # killproc 函數的文法格式是 killproc <service> [<signal>] ,例如 killproc sm-client 9

  echo $"Usage: killproc {program} [signal]"              

  return 1

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"

# 補充 :注意,并不是說使用者沒有指定信号地停止某項服務時,就會立即用 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

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 

# 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

else      # 這個 else 是針對 if [ -n "${pid:-}" ]  的,也就是說沒有 pid 檔案,pidof 指令也沒有找到 pid ,則

     failure $"$base shutdown"                # 調用 failure 函數,表示停止服務失敗

     RC=1                                             # 同時 RC 的值為1

# Remove pid file if any.                    # 根據具體情況可能需要删除 pid 檔案

if [ "$notset" = "1" ]; then                    # 如果 notset 不為1 ,也就是使用者沒有指定信号的情況

            rm -f /var/run/$base.pid            # 自動删除 /var/run 下的 pid 檔案

return $RC                                        # 并把 RC 作為 exit status 傳回

# 補充 :自是以删除 pid 檔案隻針對 notset 為1 的情況,是因為 -HUP 信号(重讀配置),并不殺死程序,是以不能删除它的 pid 檔案

# 例如下面 :

# ps -ef |grep xinetd

root      2635     1  0 12:25 ?        00:00:00 xinetd -stayalive -pidfile /var/run/xinetd.pid

# ./xinetd reload

Reloading configuration:                                   [  OK  ]

root      3927  3412  0 16:43 pts/0    00:00:00 grep xinetd

#可以看到 pid 在 reload 後并沒有變

##################################################################################################

# A function to find the pid of a program. Looks *only* at the pidfile