3 # Copyright (C) 2003 Enrico Scholz <enrico.scholz@informatik.tu-chemnitz.de>
5 # This program is free software; you can redistribute it and/or modify
6 # it under the terms of the GNU General Public License as published by
7 # the Free Software Foundation; version 2 of the License.
9 # This program is distributed in the hope that it will be useful,
10 # but WITHOUT ANY WARRANTY; without even the implied warranty of
11 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 # GNU General Public License for more details.
14 # You should have received a copy of the GNU General Public License
15 # along with this program; if not, write to the Free Software
16 # Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
23 declare -r _VS_NEWLINE=${_VS_NEWLINE:0-1}
24 declare -r VS_ALLVSERVERS_ARGS=all,marked,unmarked,stopped,running
35 test -n "$_fo_i" || continue
36 test ! $_fo_mod "$_fo_i" || { _fo_file=$_fo_i; break; }
39 test -z "$_fo_i" -o -n "$_fo_file" || {
40 echo "Can not find file for '$_fo_var'; aborting"
44 eval "$_fo_var=\"$_fo_file\""
60 test ! -s "$dst" || return 0
66 test -n "$tmp" -a -s "$tmp" || return 0
67 $_CP -af "$tmp" "$dst"
70 ## Usage: isRegularFile <filename> [<mod>]
71 function isRegularFile
73 test ${2:--f} "$1" || return 1
76 (*.rpmsave|*.rpmnew|*.rpmorig|*.cfsaved*|*.~*~) return 1;;
82 function getPhysicalDir
84 ( set -P && cd "$1" && pwd )
87 ## Usage: logging <message>
90 if test -n "$_VS_LOGFILE"; then
91 echo "$@" >>"$_VS_LOGFILE"
97 ## Usage: warning <message>
100 if test -n "$_VS_ERRFILE"; then
101 echo "$@" >>"$_VS_ERRFILE"
107 ## Usage: panic <message>
110 if test -n "$_VS_ERRFILE"; then
111 echo "$@" >>"$_VS_ERRFILE"
119 ## Usage: execute <message>
122 test -z "${DEBUG_EXEC:-}" || echo "$@"
123 test "${DEBUG_EXEC:-}" = noexec || exec "$@"
128 ## Usage: spawn <message>
131 test -z "${DEBUG_EXEC:-}" || echo "$@"
132 test "${DEBUG_EXEC:-}" = noexec || "$@"
135 ## Usage: isNumber <arg>
139 let tmp=$1+0 2>/dev/null || test -z "${1//0/}" -a -n "$1" || return 1
143 ## Usage: hasSubstring <haystack> <needle>+
144 function hasSubstring
152 test x"${pat/*$i*/$i}" = x"$i" || continue
159 ## Usage: colorize <style> <command>
169 findFile cfile "$__CONFDIR"/.defaults/styles/"$style" ''
170 if test -n "$cfile"; then
174 (bold) echo -ne "\e[1m";;
175 (emph) echo -ne "\e[34m";;
176 (info) echo -ne "\e[0;34m";;
177 (warn*) echo -ne "\e[1;31m";;
178 (error) echo -ne "\e[1;33;41m";;
188 ## Usage: xtermTitle <title>
192 echo -ne "\e]0;$@\007"
196 ## Usage: lock <lockfile> [<timeout>]
199 local tmp=$($_MKTEMP /tmp/vserver-lock.XXXXXX)
203 $_LOCKFILE "$1" $tmp $2 &
204 $_GREP -q true $tmp 2>/dev/null || return 1
206 _VS_LOCKS="$! $_VS_LOCKS"
209 ## Usage: unlock [<num>]
216 while test "$#" -gt 0; do
217 kill -HUP "$1" >/dev/null || :
219 test "$num" != 1 || break
220 test -z "$num" || let --num
225 function _pkgMountBindDir()
227 test "$1" != "$2" || return 0
229 $_MOUNT -n --bind "$1" "$2"
232 function _pkgSetVarsBase
236 if test -d "$vserver/vdir"; then
238 VDIR=$(getPhysicalDir "$vserver/vdir")
240 PKGDIR=$BASEDIR/apps/pkgmgmt
241 test -d "$PKGDIR" || {
242 echo "Can not find configuration-directory for package-managment tools"
245 findDir EXECDIR $PKGDIR/execdir /
247 VDIR=$(getPhysicalDir "$vserver")
252 BASEDIR=$__CONFDIR/$vserver
253 test -d "$BASEDIR" || {
254 echo "Can not find configuration-directory"
259 test -d "$VDIR" || VDIR=$__DEFAULT_VSERVERDIR/$vserver
260 VDIR=$(getPhysicalDir "$VDIR")
262 PKGDIR=$BASEDIR/apps/pkgmgmt
263 test -d "$PKGDIR" || {
264 echo "Can not find configuration-directory for package-managment tools"
268 findDir EXECDIR $PKGDIR/execdir /
273 if test -z "$WORKAROUND_106057"; then
276 _rpmdb_mntpoint=/.rpmdb
280 function _pkgSetVarsRPM
282 if test -n "$PKGDIR"; then
283 findDir RPMETCDIR $PKGDIR/rpmetc $PKGDIR/base/rpm/etc /etc/rpm
284 findDir RPMSTATEDIR $PKGDIR/rpmstate $PKGDIR/base/rpm/state
286 findDir RPMLIBDIR $PKGDIR/rpmlib /
289 findDir RPMETCDIR "$VDIR"/etc/rpm /etc/rpm
290 findDir RPMSTATEDIR "$VDIR"/var/lib/rpm
294 RPMSTATEDIR=$(getPhysicalDir "$RPMSTATEDIR")
295 RPMETCDIR=$(getPhysicalDir "$RPMETCDIR")
298 function _pkgSetVarsApt
300 if test -n "$PKGDIR"; then
301 findDir APTETCDIR $PKGDIR/aptetc $PKGDIR/base/apt/etc /etc/apt
302 findDir APTSTATEDIR $PKGDIR/aptstate $PKGDIR/base/apt/state
303 findDir APTCACHEDIR $PKGDIR/aptcache $PKGDIR/base/apt/cache
304 findDir APTARCHIVDIR $PKGDIR/aptarchives $PKGDIR/base/apt/archives /var/cache/apt/archives
306 findDir APTETCDIR "$VDIR"/etc/apt /etc/apt
307 findDir APTSTATEDIR "$VDIR"/var/state/apt
308 findDir APTCACHEDIR "$VDIR"/var/cache/apt
309 findDir APTARCHIVDIR "$VDIR"/var/cache/apt/archives /var/cache/apt/archives
312 findFile APT_CONFIG "$APTETCDIR"/apt.conf ""
313 test -z "$APT_CONFIG" || export APT_CONFIG
316 function _pkgSetVarsYum
318 if test -n "$PKGDIR"; then
319 findDir YUMETCDIR $PKGDIR/yumetc $PKGDIR/base/yum/etc /etc
320 findDir YUMCACHEDIR $PKGDIR/yumcache $PKGDIR/base/yum/cache
322 findDir YUMETCDIR "$VDIR"/etc /etc
323 findDir YUMCACHEDIR "$VDIR"/var/cache/yum
328 function _pkgMountBase
333 function _pkgMountApt
338 function _pkgMountYum
343 function _pkgMountRPM
345 _pkgMountBindDir "$RPMETCDIR" /etc/rpm
346 test "$RPMLIBDIR" = "/" || _pkgMountBindDir "$RPMLIBDIR" /usr/lib/rpm
348 pushd "$VDIR" >/dev/null
350 $_SECURE_MOUNT --chroot -n --bind "$RPMSTATEDIR" "$_rpmdb_mntpoint"
351 test -z "$WORKAROUND_106057" || mount -n --bind "$RPMSTATEDIR" "$_rpmdb_mntpoint"
353 test -e "$VDIR"/proc/self/status || \
354 $_SECURE_MOUNT --chroot -n -t proc none /proc
359 function _pkgSetEnvBase
361 test "$EXECDIR" = "/" || {
363 LD_LIBRARY_PATH=$EXECDIR${LD_LIBRARY_PATH:+:$LD_LIBRARY_PATH}
366 export PATH LD_LIBRARY_PATH
369 function _pkgSetEnvApt
374 function _pkgSetEnvYum
379 function _pkgSetEnvRPM
382 RPM_FAKE_NAMESPACE_MOUNTS=$_rpmdb_mntpoint
383 RPM_BINARY=$_VRPM_PRELOAD
385 export CUR_VSERVER RPM_FAKE_NAMESPACE_MOUNTS RPM_BINARY
397 rpm) _pkgSetVarsRPM;;
398 apt) _pkgSetVarsApt;;
399 yum) _pkgSetVarsYum;;
400 *) echo "Unknown packaging flavor" >&2; exit 1;;
423 _PKG_VSERVER=$vserver
426 function isAvoidNamespace
430 $_VSERVER_INFO - FEATURE namespace || return 0
431 cfgdir=$($_VSERVER_INFO "$1" CFGDIR) || return 0
432 test ! -e "$cfgdir"/namespace || return 1
433 test -e "$__CONFDIR"/.defaults/nonamespace -o \
434 -e "$cfgdir"/nonamespace
437 ## Usage: getAllVservers <var> [<KIND>*]
438 function getAllVservers
441 declare -a _ga_tmp=()
443 for _ga_i in $__CONFDIR/*; do
444 isRegularFile "$_ga_i" -d || continue
446 test ! -e "$_ga_i"/disabled || continue
447 test -d "$_ga_i"/vdir || continue
450 local _ga_markfile=$_ga_i/apps/init/mark
453 (MARKED) test -s "$_ga_markfile" || _ga_doadd=;;
454 (UNMARKED) test ! -s "$_ga_markfile" || _ga_doadd=;;
455 (STOPPED) ! $_VSERVER "$_ga_i" running &>/dev/null || _ga_doadd=;;
456 (RUNNING) $_VSERVER "$_ga_i" running &>/dev/null || _ga_doadd=;;
458 (*) panic $"Unknown vserver tagging '$2'";;
461 test -z "$_ga_doadd" || _ga_tmp=( "${_ga_tmp[@]}" "${_ga_i##$__CONFDIR/}")
464 eval $1='( "${_ga_tmp[@]}" )'
467 ## Usage: getAllVserversByArg <var> <arg>
468 function getAllVserversByArg
473 (--all) _gav_mark=ALL;;
474 (--marked) _gav_mark=MARKED;;
475 (--unmarked) _gav_mark=UNMARKED;;
476 (--stopped) _gav_mark=STOPPED;;
477 (--running) _gav_mark=RUNNING;;
481 getAllVservers "$1" "$_gav_mark"
484 ## Usage: _getProcNumberCount <ctx> <var>
485 function _getProcNumberCount
488 local _gp_procnr_cnt=0
490 # Use /proc/virtual from kernel 2.6 when possible
491 if test -d "/proc/virtual"; then
492 set -- $($_GREP '^PROC:' "/proc/virtual/$1/limit" 2>/dev/null)
495 _gp_procnr_cnt=$($_VPS ax | $_AWK '{print $2}' | $_GREP -x "$1" | $_WC -l )
498 let _gp_procnr_cnt=_gp_procnr_cnt+0
499 eval $_gp_var=\$_gp_procnr_cnt
502 ## Usage: getVserverCtx <vdir> <result-varname> [<procnumber-varname> [<do-cleanup>]]
503 ## Returns: 0 iff vserver is running
504 function getVserverStatus
506 test -r "$1"/run || return 1
509 read _gvs_ctx <"$1"/run
512 test -n "$3" || return 0
514 _getProcNumberCount "$_gvs_ctx" _gvs_tmp
517 if test "$_gvs_tmp" = 0; then
518 local runfile=$($_READLINK "$1/run")
519 test -z "$4" || $_RM -f "$runfile"
526 ## Usage: isCtxRunning <ctx>
527 function isCtxRunning
530 _getProcNumberCount "$1" _tmp
534 ## Usage: isVserverRunning <vdir> [<ctx-varname>]
535 function isVserverRunning
537 local _ivr_ctx _ivr_procnum
539 getVserverStatus "$1" _ivr_ctx _ivr_procnum 1 || return 1
540 test "$_ivr_procnum" != 0 || return 1
541 test -z "$2" || eval "$2"=\$_ivr_ctx
545 ## Called as 'getFileValue <varname> <filename>+'
546 function getFileValue
552 findFile _gfv_file "$@" ''
553 test -n "$_gfv_file" -a -r "$_gfv_file" || return 0
554 eval read "$_gfv_var" <"$_gfv_file"
557 ## Called as 'getFileArray <varname> <filename>'
558 function getFileArray
560 test -r "$2" || return 1
562 local IFS=$_VS_NEWLINE
563 eval "$1"='( $(< "$2") )'
566 function checkComponents
577 (core) test -x "$_CHBIND" || failed=1;;
578 (build) test -x "$_VSERVER_BUILD" || failed=1;;
579 (sysv) test -x "$__INITRDDIR/vserver" || failed=1;;
580 (devel) test -d "$__INCLUDEDIR/vserver.h" || failed=1;;
581 (*) echo "Unknown component '$i'" >&2
586 test -z "$failed" || {
595 ## Usage: isKernelAPI <ver> [<cmp-modifier>]
599 api=$($_VSERVER_INFO - APIVER) || api=0
600 test $[ $api ] -${2:-ge} $[ $1 ]
603 ## Usage: callInNamespace <vserver> <command> <args>*
604 function callInNamespace
608 isAvoidNamespace "$1" || \
609 ctx=$( $_VSERVER_INFO "$1" CONTEXT f ) || ctx=
612 if test -n "$ctx"; then
613 $_VNAMESPACE --enter "$ctx" -- "$@"
619 ## Usage: setDefaultTTY <vdir> [<fallback-tty>]
620 function setDefaultTTY
624 cfgdir=$($_VSERVER_INFO "$1" APPDIR init) || cfgdir=
625 findObject -e ttyname \
626 ${cfgdir:+"$cfgdir"/tty} \
627 "$__CONFDIR/.defaults/apps/init/tty" \
634 ## Usage: killContext <XID> [<SIG>]
639 #$_VKILL -s STOP --xid "$1" 1 &>/dev/null || :
640 $_VKILL -s "$sig" --xid "$1" 1 &>/dev/null || :
641 $_VKILL -s "$sig" --xid "$1" &>/dev/null || :
642 #$_VKILL -s "$sig" --xid "$1" 1 &>/dev/null || :
643 #$_VKILL -s CONT --xid "$1" 1 &>/dev/null || :
646 ## Usage: pkgmgmt.guessStyle <vserver> <resultvar>
647 function pkgmgmt.guessStyle()
650 _pgs_vdir=$($_VSERVER_INFO "$1" VDIR) || {
651 echo $"Can not determine vserver-root" >&2
654 local _pgs_cfgdir=$($_VSERVER_INFO "$1" APPDIR pkgmgmt) || :
656 if test -n "$_pgs_cfgdir" -a -e "$_pgs_cfgdir"/style; then
657 read style <"$_pgs_cfgdir"/style
658 elif test -e "$_pgs_vdir"/etc/redhat-release -o -e "$_pgs_vdir"/etc/fedora-release; then
660 elif test -e "$_pgs_vdir"/etc/mandrake-release; then
662 elif test -e "$_pgs_vdir"/etc/debian_version; then
664 elif test -e "$_pgs_vdir"/etc/SuSE-release; then
667 echo $"Can not determine packagemanagement style" >&2
675 ## Usage: pkgmgmt.isInternal <vserver>
676 ## returns true iff <vserver> is configured for internal packagemanagement
677 ## A typical application is
679 ## | pkgmgmt.isInternal "$vserver" || is_external=1
680 function pkgmgmt.isInternal
682 local cfgdir=$($_VSERVER_INFO "$1" APPDIR pkgmgmt) || :
684 test -z "$cfgdir" -o ! -d "$cfgdir" -o -e "$cfgdir"/internal
687 ## Usage: pkgmgmt.isAptAvailable <cfgdir> <vdir> [<is-internal>]
688 function pkgmgmt.isAptAvailable
692 local is_internal="$3"
695 if test -n "$is_internal"; then
697 test -d "$cfgdir"/base/apt -o -d "$cfgdir"/aptetc || have_apt=
700 for i in /bin /usr/bin /usr/local/bin; do
701 test ! -x "$vdir$i"/apt-get || { have_apt=1; break; }
705 test -n "$have_apt" && return 0 || return 1
708 ## Usage: pkgmgmt.isYumAvailable <cfgdir> <vdir> [<is-internal>]
709 function pkgmgmt.isYumAvailable
713 local is_internal="$3"
716 if test -n "$is_internal"; then
718 test -d "$cfgdir"/base/yum -o -d "$cfgdir"/yumetc || have_yum=
721 for i in /bin /usr/bin /usr/local/bin; do
722 test ! -x "$vdir$i"/yum || { have_yum=1; break; }
726 test -n "$have_yum" && return 0 || return 1
730 function vshelper.doSanityCheck
732 local vshelper this_xid i
733 declare -a warnings=()
734 local solution_disable=
735 local solution_sysctl=
737 vshelper.isEnabled && vshelper.isEnabled warning || return 0
739 this_xid=$($_VSERVER_INFO - XID) ||
740 panic $"Failed to determine current context; aborting..."
742 ## Do nothing in other xid's; the helper will be executed in xid 0 only
743 test "$this_xid" = 0 || return 0
745 local proc_file=/proc/sys/kernel/vshelper
747 if ! test -r "$proc_file"; then
749 warnings=( "${warnings[@]}"
750 $"File '$proc_file' does not exist but is required for vshelper setup" )
753 vshelper=$(cat "$proc_file")
755 $_CMP -s "$vshelper" "$_VSHELPER" || {
756 warnings=( "${warnings[@]}"
757 $"The configured vshelper '$vshelper' does not match the 'vshelper'
758 script of the util-vserver package"
765 test -d "$__VSHELPERSTATEDIR" || {
766 warnings=( "${warnings[@]}"
768 The vshelper state-directory '$__VSHELPERSTATEDIR' does not exist; since
769 it is created by 'make install', this indicates a serious problem with
770 your util-vserver installation" )
774 test "${#warnings[@]}" -eq 0 || {
776 The following problem(s) were encountered while verifying vshelper
779 for i in "${warnings[@]}"; do
785 To fix this, you can:"
787 test -z "$solution_disable" || warning $"\
788 * disable vshelper entirely by executing
789 | touch \"$__CONFDIR/.defaults/apps/vshelper/disabled\"
790 * disable only this message by executing
791 | touch \"$__CONFDIR/.defaults/apps/vshelper/warning-disabled\""
793 test -x "$solution_sysctl" || warning $"\
794 * configure the util-vserver vshelper script, e.g. by adding
795 | kernel.vshelper = $_VSHELPER
796 to /etc/sysctl.conf and rebooting the machine, or by executing
797 | echo \"$_VSHELPER\" >$proc_file"
807 ## Usage: vshelper.isEnabled [<style>] [<vserver>]
808 function vshelper.isEnabled
810 local f=${1:+$1-}disabled
811 test ! -e "$__CONFDIR"/.defaults/apps/vshelper/"$f" || return 1
812 $_VSERVER_INFO - FEATURE vshelper || return 1
813 if test -n "$2"; then
815 appdir=$($_VSERVER_INFO "$2" APPDIR vshelper) || return 0
816 test -z "$2" -o ! -e "$appdir/$f" || return 1
822 ## Usage: vshelper.isDebug [<vserver>]
823 function vshelper.isDebug
825 test ! -e "$__CONFDIR"/.defaults/apps/vshelper/debug || return 0
826 $_VSERVER_INFO - FEATURE vshelper || return 1
827 if test -n "$1"; then
829 appdir=$($_VSERVER_INFO "$1" APPDIR vshelper) || return 1
830 test ! -e "$appdir/debug" || return 0
836 function vshelper._getHandlerInternal
841 shift ## HACK: see below the note about the 'set -u' mode
843 while test "$#" -ge 2; do
848 test "$_vghi_mod" "$_vghi_obj" || continue
851 eval $_vghi_var=\$_vghi_obj
854 read _vghi_tmp <"$_vghi_obj"
855 eval $_vghi_var=:\$_vghi_tmp
857 (*) panic $"Internal error, unexpected modifier '$_vghi_mod'"
865 ## Usage: vshelper.getHandler <result-var> <vserver> <action>
866 function vshelper.getHandler
869 _vgh_appdir=$($_VSERVER_INFO "$2" APPDIR vshelper) || _vgh_appdir=
871 declare -a _vgh_search_list=( X )
872 ## HACK: when we are in 'set -u' mode, empty lists are causing errors
874 test -z "$_vgh_appdir" || _vgh_search_list=( "${_vgh_search_list[@]}" -x "$_vgh_appdir/$3" )
875 test -z "$_vgh_appdir" || _vgh_search_list=( "${_vgh_search_list[@]}" -e "$_vgh_appdir/action" )
876 _vgh_search_list=( "${_vgh_search_list[@]}" -x "$__CONFDIR"/.defaults/apps/vshelper/"$3" )
877 _vgh_search_list=( "${_vgh_search_list[@]}" -e "$__CONFDIR"/.defaults/apps/vshelper/action )
879 ! vshelper._getHandlerInternal "$1" "${_vgh_search_list[@]}" || return 0
883 ## Usage: vshelper.init <vserver> [<method> <args>*]
884 function vshelper.doInit
886 vshelper.isEnabled || return 0
889 xid=$($_VSERVER_INFO "$1" CONTEXT false) && test -n "$xid" || {
890 warning $"vshelper.init: can not determine xid of vserver '$vserver'; returned value was '$xid'"
894 local f="$__VSHELPERSTATEDIR/$xid"
901 if test -n "$2"; then
914 ## Usage: vshelper.doDestroy <vserver> <xid>
915 function vshelper.doDestroy
917 vshelper.isEnabled || return 0
919 $_RM -f "$__VSHELPERSTATEDIR/$2"
922 ## Usage: vshelper.initSync <vserver> <pipe-varname> [<method>]
923 function vshelper.initSync
926 _vis_tmpdir=$($_MKTEMPDIR /tmp/vserver-stop.XXXXXX) || {
927 warning $"Failed to generate temporary directory for vshelper sync"
931 local _vis_fifo="$_vis_tmpdir"/pipe
932 $_MKFIFO -m700 "$_vis_fifo"
933 vshelper.doInit "$1" "${method:-sync}" "$_vis_fifo"
937 ## Usage: vshelper.getSyncTimeout <vserver> <varname>
938 function vshelper.getSyncTimeout
940 local _vgst_appdir _vgst_file _vgst_tmp
941 _vgst_appdir=$($_VSERVER_INFO "$1" APPDIR vshelper) || _vgst_appdir=
943 findFile _vgst_file ${_vgst_appdir:+"$_vgst_appdir"/sync-timeout} "$__CONFDIR"/.defaults/apps/vshelper/sync-timeout ''
944 test -n "$_vgst_file" || return 1
945 read _vgst_tmp <"$_vgst_file"
950 function _rpmFake.getCapFlags
954 if test -n "$ctx" && ! $_VSERVER_INFO - FEATURE migrate; then
955 set -- $($_CHCONTEXT_COMPAT --xid 1 \
956 $_SH -c "$_CAT /proc/[0-9]*/status | $_EGREP '^(CapBset|s_context|ctxflags)'" | \
957 $_GREP -B 1 -A 1 "^s_context: $ctx " | \
958 $_SED -e '1,3p;d' | $_AWK '{ print $2 }')
963 if test -n "$3"; then
964 RPM_FAKE_CAP=$[ ~0x$1 ]
967 RPM_FAKE_CAP=$[ ~0xd40c04ff ]
972 function rpmFake.init
976 vdir=$($_VSERVER_INFO "$1" VDIR) || vdir="$1"
977 ctx=$($_VSERVER_INFO "$1" CONTEXT) || ctx=
980 panic $"Can not find chroot environment at '$vdir' for '$1'"
982 _rpmFake.getCapFlags "$ctx"
984 RPM_FAKE_CHROOT=$vdir
988 function rpmFake.exec
990 export RPM_FAKE_CHROOT RPM_FAKE_CTX RPM_FAKE_CAP RPM_FAKE_FLAGS
992 LD_PRELOAD=$_RPM_FAKE_SO${LD_PRELOAD:+:$LD_PRELOAD} \