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 ${mod:--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: colorize <style> <command>
153 findFile cfile "$__CONFDIR"/.defaults/styles/"$style" ''
154 if test -n "$cfile"; then
158 (bold) echo -ne "\e[1m";;
159 (emph) echo -ne "\e[34m";;
160 (info) echo -ne "\e[0;34m";;
161 (warn*) echo -ne "\e[1;31m";;
162 (error) echo -ne "\e[1;33;41m";;
172 ## Usage: xtermTitle <title>
176 echo -ne "\e]0;$@\007"
180 ## Usage: lock <lockfile> [<timeout>]
183 local tmp=$($_MKTEMP /tmp/vserver-lock.XXXXXX)
187 $_LOCKFILE "$1" $tmp $2 &
188 $_GREP -q true $tmp 2>/dev/null || return 1
190 _VS_LOCKS="$! $_VS_LOCKS"
193 ## Usage: unlock [<num>]
200 while test "$#" -gt 0; do
201 kill -HUP "$1" >/dev/null || :
203 test "$num" != 1 || break
204 test -z "$num" || let --num
209 function _pkgMountBindDir()
211 test "$1" != "$2" || return 0
213 $_MOUNT -n --bind "$1" "$2"
216 function _pkgSetVarsBase
220 if test -d "$vserver/vdir"; then
222 VDIR=$(getPhysicalDir "$vserver/vdir")
224 PKGDIR=$BASEDIR/apps/pkgmgmt
225 test -d "$PKGDIR" || {
226 echo "Can not find configuration-directory for package-managment tools"
229 findDir EXECDIR $PKGDIR/execdir /
231 VDIR=$(getPhysicalDir "$vserver")
236 BASEDIR=$__CONFDIR/$vserver
237 test -d "$BASEDIR" || {
238 echo "Can not find configuration-directory"
243 test -d "$VDIR" || VDIR=$__DEFAULT_VSERVERDIR/$vserver
244 VDIR=$(getPhysicalDir "$VDIR")
246 PKGDIR=$BASEDIR/apps/pkgmgmt
247 test -d "$PKGDIR" || {
248 echo "Can not find configuration-directory for package-managment tools"
252 findDir EXECDIR $PKGDIR/execdir /
257 if test -z "$WORKAROUND_106057"; then
260 _rpmdb_mntpoint=/.rpmdb
264 function _pkgSetVarsRPM
266 if test -n "$PKGDIR"; then
267 findDir RPMETCDIR $PKGDIR/rpmetc $PKGDIR/base/rpm/etc /etc/rpm
268 findDir RPMSTATEDIR $PKGDIR/rpmstate $PKGDIR/base/rpm/state
270 findDir RPMLIBDIR $PKGDIR/rpmlib /
273 findDir RPMETCDIR "$VDIR"/etc/rpm /etc/rpm
274 findDir RPMSTATEDIR "$VDIR"/var/lib/rpm
278 RPMSTATEDIR=$(getPhysicalDir "$RPMSTATEDIR")
279 RPMETCDIR=$(getPhysicalDir "$RPMETCDIR")
282 function _pkgSetVarsApt
284 if test -n "$PKGDIR"; then
285 findDir APTETCDIR $PKGDIR/aptetc $PKGDIR/base/apt/etc /etc/apt
286 findDir APTSTATEDIR $PKGDIR/aptstate $PKGDIR/base/apt/state
287 findDir APTCACHEDIR $PKGDIR/aptcache $PKGDIR/base/apt/cache
288 findDir APTARCHIVDIR $PKGDIR/aptarchives $PKGDIR/base/apt/archives /var/cache/apt/archives
290 findDir APTETCDIR "$VDIR"/etc/apt /etc/apt
291 findDir APTSTATEDIR "$VDIR"/var/state/apt
292 findDir APTCACHEDIR "$VDIR"/var/cache/apt
293 findDir APTARCHIVDIR "$VDIR"/var/cache/apt/archives /var/cache/apt/archives
296 findFile APT_CONFIG "$APTETCDIR"/apt.conf ""
297 test -z "$APT_CONFIG" || export APT_CONFIG
300 function _pkgSetVarsYum
302 if test -n "$PKGDIR"; then
303 findDir YUMETCDIR $PKGDIR/yumetc $PKGDIR/base/yum/etc /etc
304 findDir YUMCACHEDIR $PKGDIR/yumcache $PKGDIR/base/yum/cache
306 findDir YUMETCDIR "$VDIR"/etc /etc
307 findDir YUMCACHEDIR "$VDIR"/var/cache/yum
312 function _pkgMountBase
317 function _pkgMountApt
322 function _pkgMountYum
327 function _pkgMountRPM
329 _pkgMountBindDir "$RPMETCDIR" /etc/rpm
330 test "$RPMLIBDIR" = "/" || _pkgMountBindDir "$RPMLIBDIR" /usr/lib/rpm
332 pushd "$VDIR" >/dev/null
334 $_SECURE_MOUNT --chroot -n --bind "$RPMSTATEDIR" "$_rpmdb_mntpoint"
335 test -z "$WORKAROUND_106057" || mount -n --bind "$RPMSTATEDIR" "$_rpmdb_mntpoint"
337 test -e "$VDIR"/proc/self/status || \
338 $_SECURE_MOUNT --chroot -n -t proc none /proc
343 function _pkgSetEnvBase
345 test "$EXECDIR" = "/" || {
347 LD_LIBRARY_PATH=$EXECDIR${LD_LIBRARY_PATH:+:$LD_LIBRARY_PATH}
350 export PATH LD_LIBRARY_PATH
353 function _pkgSetEnvApt
358 function _pkgSetEnvYum
363 function _pkgSetEnvRPM
366 RPM_FAKE_NAMESPACE_MOUNTS=$_rpmdb_mntpoint
367 RPM_BINARY=$_VRPM_PRELOAD
369 export CUR_VSERVER RPM_FAKE_NAMESPACE_MOUNTS RPM_BINARY
381 rpm) _pkgSetVarsRPM;;
382 apt) _pkgSetVarsApt;;
383 yum) _pkgSetVarsYum;;
384 *) echo "Unknown packaging flavor" >&2; exit 1;;
407 _PKG_VSERVER=$vserver
410 function isAvoidNamespace
414 $_VSERVER_INFO - FEATURE namespace || return 0
415 cfgdir=$($_VSERVER_INFO "$1" CFGDIR) || return 0
416 test ! -e "$cfgdir"/namespace || return 1
417 test -e "$__CONFDIR"/.defaults/nonamespace -o \
418 -e "$cfgdir"/nonamespace
421 ## Usage: getAllVservers <var> [<KIND>*]
422 function getAllVservers
425 declare -a _ga_tmp=()
427 for _ga_i in $__CONFDIR/*; do
428 isRegularFile "$_ga_i" -d || continue
430 test ! -e "$_ga_i"/disabled || continue
431 test -d "$_ga_i"/vdir || continue
434 local _ga_markfile=$_ga_i/apps/init/mark
437 (MARKED) test -s "$_ga_markfile" || _ga_doadd=;;
438 (UNMARKED) test ! -s "$_ga_markfile" || _ga_doadd=;;
439 (STOPPED) ! $_VSERVER "$_ga_i" runnning &>/dev/null || _ga_doadd=;;
440 (RUNNING) $_VSERVER "$_ga_i" runnning &>/dev/null || _ga_doadd=;;
442 (*) panic $"Unknown vserver tagging '$2'";;
445 test -z "$_ga_doadd" || _ga_tmp=( "${_ga_tmp[@]}" "${_ga_i##$__CONFDIR/}")
448 eval $1='( "${_ga_tmp[@]}" )'
451 ## Usage: getAllVserversByArg <var> <arg>
452 function getAllVserversByArg
457 (--all) _gav_mark=ALL;;
458 (--marked) _gav_mark=MARKED;;
459 (--unmarked) _gav_mark=UNMARKED;;
460 (--stopped) _gav_mark=STOPPED;;
461 (--running) _gav_mark=RUNNING;;
465 getAllVservers "$1" "$_gav_mark"
468 ## Usage: _getProcNumberCount <ctx> <var>
469 function _getProcNumberCount
472 local _gp_procnr_cnt=0
474 # Use /proc/virtual from kernel 2.6 when possible
475 if test -d "/proc/virtual"; then
476 set -- $($_GREP '^PROC:' "/proc/virtual/$1/limit" 2>/dev/null)
479 _gp_procnr_cnt=$($_VPS ax | $_AWK '{print $2}' | $_GREP -x "$1" | $_WC -l )
482 let _gp_procnr_cnt=_gp_procnr_cnt+0
483 eval $_gp_var=\$_gp_procnr_cnt
486 ## Usage: getVserverCtx <vdir> <result-varname> [<procnumber-varname> [<do-cleanup>]]
487 ## Returns: 0 iff vserver is running
488 function getVserverStatus
490 test -r "$1"/run || return 1
493 read _gvs_ctx <"$1"/run
496 test -n "$3" || return 0
498 _getProcNumberCount "$_gvs_ctx" _gvs_tmp
501 if test "$_gvs_tmp" = 0; then
502 local runfile=$($_READLINK "$1/run")
503 test -z "$4" || $_RM -f "$runfile"
510 ## Usage: isCtxRunning <ctx>
511 function isCtxRunning
514 _getProcNumberCount "$1" _tmp
518 ## Usage: isVserverRunning <vdir> [<ctx-varname>]
519 function isVserverRunning
521 local _ivr_ctx _ivr_procnum
523 getVserverStatus "$1" _ivr_ctx _ivr_procnum 1 || return 1
524 test "$_ivr_procnum" != 0 || return 1
525 test -z "$2" || eval "$2"=\$_ivr_ctx
529 ## Called as 'getFileValue <varname> <filename>+'
530 function getFileValue
536 findFile _gfv_file "$@" ''
537 test -n "$_gfv_file" -a -r "$_gfv_file" || return 0
538 eval read "$_gfv_var" <"$_gfv_file"
541 ## Called as 'getFileArray <varname> <filename>'
542 function getFileArray
544 test -r "$2" || return 1
546 local IFS=$_VS_NEWLINE
547 eval "$1"='( $(< "$2") )'
550 function checkComponents
561 (core) test -x "$_CHBIND" || failed=1;;
562 (build) test -x "$_VSERVER_BUILD" || failed=1;;
563 (sysv) test -x "$__INITRDDIR/vserver" || failed=1;;
564 (devel) test -d "$__INCLUDEDIR/vserver.h" || failed=1;;
565 (*) echo "Unknown component '$i'" >&2
570 test -z "$failed" || {
579 ## Usage: isKernelAPI <ver> [<cmp-modifier>]
583 api=$($_VSERVER_INFO - APIVER) || api=0
584 test $[ $api ] -${2:-ge} $[ $1 ]
587 ## Usage: callInNamespace <vserver> <command> <args>*
588 function callInNamespace
592 isAvoidNamespace "$1" || \
593 ctx=$( $_VSERVER_INFO "$1" CONTEXT f ) || ctx=
596 if test -n "$ctx"; then
597 $_VNAMESPACE --enter "$ctx" -- "$@"
603 ## Usage: setDefaultTTY <vdir> [<fallback-tty>]
604 function setDefaultTTY
608 cfgdir=$($_VSERVER_INFO "$1" APPDIR init) || cfgdir=
609 findObject -e ttyname \
610 ${cfgdir:+"$cfgdir"/tty} \
611 "$__CONFDIR/.defaults/apps/init/tty" \
618 ## Usage: killContext <XID> [<SIG>]
623 #$_VKILL -s STOP --xid "$1" 1 &>/dev/null || :
624 $_VKILL -s "$sig" --xid "$1" 1 &>/dev/null || :
625 $_VKILL -s "$sig" --xid "$1" &>/dev/null || :
626 #$_VKILL -s "$sig" --xid "$1" 1 &>/dev/null || :
627 #$_VKILL -s CONT --xid "$1" 1 &>/dev/null || :
630 ## Usage: pkgmgmt.guessStyle <vserver> <resultvar>
631 function pkgmgmt.guessStyle()
634 _pgs_vdir=$($_VSERVER_INFO "$1" VDIR) || {
635 echo $"Can not determine vserver-root" >&2
638 local _pgs_cfgdir=$($_VSERVER_INFO "$1" APPDIR pkgmgmt) || :
640 if test -n "$_pgs_cfgdir" -a -e "$_pgs_cfgdir"/style; then
641 read style <"$_pgs_cfgdir"/style
642 elif test -e "$_pgs_vdir"/etc/redhat-release -o -e "$_pgs_vdir"/etc/fedora-release; then
644 elif test -e "$_pgs_vdir"/etc/mandrake-release; then
646 elif test -e "$_pgs_vdir"/etc/debian_version; then
648 elif test -e "$_pgs_vdir"/etc/SuSE-release; then
651 echo $"Can not determine packagemanagement style" >&2
659 ## Usage: pkgmgmt.isInternal <vserver>
660 ## returns true iff <vserver> is configured for internal packagemanagement
661 ## A typical application is
663 ## | pkgmgmt.isInternal "$vserver" || is_external=1
664 function pkgmgmt.isInternal
666 local cfgdir=$($_VSERVER_INFO "$1" APPDIR pkgmgmt) || :
668 test -z "$cfgdir" -o ! -d "$cfgdir" -o -e "$cfgdir"/internal
671 ## Usage: pkgmgmt.isAptAvailable <cfgdir> <vdir> [<is-internal>]
672 function pkgmgmt.isAptAvailable
676 local is_internal="$3"
679 if test -n "$is_internal"; then
681 test -d "$cfgdir"/base/apt -o -d "$cfgdir"/aptetc || have_apt=
684 for i in /bin /usr/bin /usr/local/bin; do
685 test ! -x "$vdir$i"/apt-get || { have_apt=1; break; }
689 test -n "$have_apt" && return 0 || return 1
692 ## Usage: pkgmgmt.isYumAvailable <cfgdir> <vdir> [<is-internal>]
693 function pkgmgmt.isYumAvailable
697 local is_internal="$3"
700 if test -n "$is_internal"; then
702 test -d "$cfgdir"/base/yum -o -d "$cfgdir"/yumetc || have_yum=
705 for i in /bin /usr/bin /usr/local/bin; do
706 test ! -x "$vdir$i"/yum || { have_yum=1; break; }
710 test -n "$have_yum" && return 0 || return 1
714 function vshelper.doSanityCheck
716 local vshelper this_xid i
717 declare -a warnings=()
718 local solution_disable=
719 local solution_sysctl=
721 vshelper.isEnabled && vshelper.isEnabled warning || return 0
723 this_xid=$($_VSERVER_INFO - XID) ||
724 panic $"Failed to determine current context; aborting..."
726 ## Do nothing in other xid's; the helper will be executed in xid 0 only
727 test "$this_xid" = 0 || return 0
729 local proc_file=/proc/sys/kernel/vshelper
731 if ! test -r "$proc_file"; then
733 warnings=( "${warnings[@]}"
734 $"File '$proc_file' does not exist but is required for vshelper setup" )
737 vshelper=$(cat "$proc_file")
739 $_CMP -s "$vshelper" "$_VSHELPER" || {
740 warnings=( "${warnings[@]}"
741 $"The configured vshelper '$vshelper' does not match the 'vshelper'
742 script of the util-vserver package"
749 test -d "$__VSHELPERSTATEDIR" || {
750 warnings=( "${warnings[@]}"
752 The vshelper state-directory '$__VSHELPERSTATEDIR' does not exist; since
753 it is created by 'make install', this indicates a serious problem with
754 your util-vserver installation" )
758 test "${#warnings[@]}" -eq 0 || {
760 The following problem(s) were encountered while verifying vshelper
763 for i in "${warnings[@]}"; do
769 To fix this, you can:"
771 test -z "$solution_disable" || warning $"\
772 * disable vshelper entirely by executing
773 | touch \"$__CONFDIR/.defaults/apps/vshelper/disabled\"
774 * disable only this message by executing
775 | touch \"$__CONFDIR/.defaults/apps/vshelper/warning-disabled\""
777 test -x "$solution_sysctl" || warning $"\
778 * configure the util-vserver vshelper script, e.g. by adding
779 | kernel.vshelper = \"$_VSHELPER\"
780 to /etc/sysctl.conf and rebooting the machine, or by executing
781 | echo \"$_VSHELPER\" >$proc_file"
791 ## Usage: vshelper.isEnabled [<style>] [<vserver>]
792 function vshelper.isEnabled
794 local f=${1:+$1-}disabled
795 test ! -e "$__CONFDIR"/.defaults/apps/vshelper/"$f" || return 1
796 $_VSERVER_INFO - FEATURE vshelper || return 1
797 if test -n "$2"; then
799 appdir=$($_VSERVER_INFO "$2" APPDIR vshelper) || return 0
800 test -z "$2" -o ! -e "$appdir/$f" || return 1
806 ## Usage: vshelper.isDebug [<vserver>]
807 function vshelper.isDebug
809 test ! -e "$__CONFDIR"/.defaults/apps/vshelper/debug || return 0
810 $_VSERVER_INFO - FEATURE vshelper || return 1
811 if test -n "$1"; then
813 appdir=$($_VSERVER_INFO "$1" APPDIR vshelper) || return 1
814 test ! -e "$appdir/debug" || return 0
820 function vshelper._getHandlerInternal
825 shift ## HACK: see below the note about the 'set -u' mode
827 while test "$#" -ge 2; do
832 test "$_vghi_mod" "$_vghi_obj" || continue
835 eval $_vghi_var=\$_vghi_obj
838 read _vghi_tmp <"$_vghi_obj"
839 eval $_vghi_var=:\$_vghi_tmp
841 (*) panic $"Internal error, unexpected modifier '$_vghi_mod'"
849 ## Usage: vshelper.getHandler <result-var> <vserver> <action>
850 function vshelper.getHandler
853 _vgh_appdir=$($_VSERVER_INFO "$2" APPDIR vshelper) || _vgh_appdir=
855 declare -a _vgh_search_list=( X )
856 ## HACK: when we are in 'set -u' mode, empty lists are causing errors
858 test -z "$_vgh_appdir" || _vgh_search_list=( "${_vgh_search_list[@]}" -x "$_vgh_appdir/$3" )
859 test -z "$_vgh_appdir" || _vgh_search_list=( "${_vgh_search_list[@]}" -e "$_vgh_appdir/action" )
860 _vgh_search_list=( "${_vgh_search_list[@]}" -x "$__CONFDIR"/.defaults/apps/vshelper/"$3" )
861 _vgh_search_list=( "${_vgh_search_list[@]}" -e "$__CONFDIR"/.defaults/apps/vshelper/action )
863 ! vshelper._getHandlerInternal "$1" "${_vgh_search_list[@]}" || return 0
867 ## Usage: vshelper.init <vserver> [<method> <args>*]
868 function vshelper.doInit
870 vshelper.isEnabled || return 0
873 xid=$($_VSERVER_INFO "$1" CONTEXT false) && test -n "$xid" || {
874 warning $"vshelper.init: can not determine xid of vserver '$vserver'; returned value was '$xid'"
878 local f="$__VSHELPERSTATEDIR/$xid"
885 if test -n "$2"; then
898 ## Usage: vshelper.doDestroy <vserver> <xid>
899 function vshelper.doDestroy
901 vshelper.isEnabled || return 0
903 $_RM -f "$__VSHELPERSTATEDIR/$2"
906 ## Usage: vshelper.initSync <vserver> <pipe-varname> [<method>]
907 function vshelper.initSync
910 _vis_tmpdir=$($_MKTEMPDIR /tmp/vserver-stop.XXXXXX) || {
911 warning $"Failed to generate temporary directory for vshelper sync"
915 local _vis_fifo="$_vis_tmpdir"/pipe
916 $_MKFIFO -m700 "$_vis_fifo"
917 vshelper.doInit "$1" "${method:-sync}" "$_vis_fifo"
921 ## Usage: vshelper.getSyncTimeout <vserver> <varname>
922 function vshelper.getSyncTimeout
924 local _vgst_appdir _vgst_file _vgst_tmp
925 _vgst_appdir=$($_VSERVER_INFO "$1" APPDIR vshelper) || _vgst_appdir=
927 findFile _vgst_file ${_vgst_appdir:+"$_vgst_appdir"/sync-timeout} "$__CONFDIR"/.defaults/apps/vshelper/sync-timeout ''
928 test -n "$_vgst_file" || return 1
929 read _vgst_tmp <"$_vgst_file"
934 function _rpmFake.getCapFlags
938 if test -n "$ctx" && ! $_VSERVER_INFO - FEATURE migrate; then
939 set -- $($_CHCONTEXT_COMPAT --xid 1 \
940 $_SH -c "$_CAT /proc/[0-9]*/status | $_EGREP '^(CapBset|s_context|ctxflags)'" | \
941 $_GREP -B 1 -A 1 "^s_context: $ctx " | \
942 $_SED -e '1,3p;d' | $_AWK '{ print $2 }')
947 if test -n "$3"; then
948 RPM_FAKE_CAP=$[ ~0x$1 ]
951 RPM_FAKE_CAP=$[ ~0xd40c04ff ]
956 function rpmFake.init
960 vdir=$($_VSERVER_INFO "$1" VDIR) || vdir="$1"
961 ctx=$($_VSERVER_INFO "$1" CONTEXT) || ctx=
964 panic $"Can not find chroot environment at '$vdir' for '$1'"
966 _rpmFake.getCapFlags "$ctx"
968 RPM_FAKE_CHROOT=$vdir
972 function rpmFake.exec
974 export RPM_FAKE_CHROOT RPM_FAKE_CTX RPM_FAKE_CAP RPM_FAKE_FLAGS
976 LD_PRELOAD=$_RPM_FAKE_SO${LD_PRELOAD:+:$LD_PRELOAD} \