/etc/rc.d/init.d/functions文件详细分析
/etc/rc.d/init.d/functions文件详细分析
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
PATH="/sbin:/usr/sbin:/bin:/usr/bin:/usr/X11R6/bin" # 默认为 /sbin:/usr/sbin:/bin:/usr/bin:/usr/X11R6/bin
export PATH # 导出为环境变量
[ -z "${COLUMNS:-}" ] && COLUMNS=80 # 如果 COLUMNS 变量的值为空,则设置为 80 (列)
. /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
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
BOOTUP=serial
MOVE_TO_COL=
SETCOLOR_SUCCESS=
SETCOLOR_FAILURE=
SETCOLOR_WARNING=
SETCOLOR_NORMAL=
fi
fi
INITLOG_ARGS="-q" # 把 INITLOG_ARGS 的值设置为 -q (安静模式)
else # 否则
INITLOG_ARGS= # 把 INITLOG_ARGS 的值请空
fi
checkpid() { # 如果有任意一个存在,则返回0;
local i
[ -d "/proc/$i" ] && return 0
done
return 1 # 如果给出的参数全部不存在对应的目录,则返回1
}
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
[ -z "$gotbase" ] && base=${1##*/}
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 变量为空(不强制启动),则返回
ulimit -S -c ${DAEMON_COREFILE_LIMIT:-0} >/dev/null 2>&1 # ulimit 是控制由该 shell 启动的进程能够使用的资源,-S 是 soft control 的意思,-c 是指最大的 core
# 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"
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 ]
}
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
# 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
base=${1##*/} # basename 就是得出服务的名称
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
if [ -n "${pid:-}" ] ; then # 如果 pid 的值最终不为空,则
[ "$BOOTUP" = "verbose" -a -z "$LSB" ] && echo -n "$base " # 且 BOOTUP 的值为 verbose ,且 LSB 变量不为空,则打印一个服务名
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))
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
if [ "$notset" = "1" ]; then # 如果 notset 不为1 ,也就是用户没有指定信号的情况
rm -f /var/run/$base.pid # 自动删除 /var/run 下的 pid 文件
fi
return $RC # 并把 RC 作为 exit status 返回
}
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]#
pidfileofproc() {
local base=${1##*/}
# Test syntax.
if [ "$#" = 0 ] ; then
echo $"Usage: pidfileofproc {program}"
return 1
fi
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
}
pidofproc() {
base=${1##*/}
if [ "$#" = 0 ]; then
echo $"Usage: pidofproc {program}"
return 1
fi
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
}
local base=${1##*/}
local pid
if [ "$#" = 0 ] ; then
echo $"Usage: status {program}"
return 1
fi
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
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
}
[ "$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
[ "$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
}
[ "$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
}
[ "$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
}
update_boot_stage() {
if [ "$GRAPHICAL" = "yes" -a -x /usr/bin/rhgb-client ]; then
/usr/bin/rhgb-client --update="$1"
fi
return 0
}
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
}
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
}
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
}
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
}
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
}
() {
[ "${1#*$2*}" = "$1" ] && return 1
return 0
}
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
}