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}
35 test ! $mod "$i" || { file=$i; break; }
38 test -z "$i" -o "$file" || {
39 echo "Can not find file for '$var'; aborting"
59 test ! -s "$dst" || return 0
65 test "$tmp" -a -s "$tmp" || return 0
69 function getPhysicalDir
71 ( set -P && cd "$1" && pwd )
74 ## Usage: logging <message>
77 if test "$_VS_LOGFILE"; then
78 echo "$@" >>"$_VS_LOGFILE"
84 ## Usage: warning <message>
87 if test "$_VS_ERRFILE"; then
88 echo "$@" >>"$_VS_ERRFILE"
94 ## Usage: panic <message>
97 if test "$_VS_ERRFILE"; then
98 echo "$@" >>"$_VS_ERRFILE"
106 ## Usage: execute <message>
109 test -z "${DEBUG_EXEC:-}" || echo "$@"
110 test "${DEBUG_EXEC:-}" = noexec || exec "$@"
114 ## Usage: isNumber <arg>
118 let tmp=$1+0 2>/dev/null || test -z "${1//0/}" -a "$1" || return 1
122 ## Usage: colorize <style> <command>
132 findFile cfile "$CONFDIR"/.defaults/styles/"$style" ''
133 if test "$cfile"; then
137 (bold) echo -ne "\e[1m";;
138 (emph) echo -ne "\e[34m";;
139 (info) echo -ne "\e[0;34m";;
140 (warn*) echo -ne "\e[1;31m";;
141 (error) echo -ne "\e[1;33;41m";;
151 ## Usage: xtermTitle <title>
155 echo -ne "\e]0;$@\007"
159 ## Usage: lock <lockfile> [<timeout>]
162 local tmp=$(mktemp /tmp/vserver-lock.XXXXXX)
166 $_LOCKFILE "$1" $tmp $2 &
167 grep -q true $tmp 2>/dev/null || return 1
169 _VS_LOCKS="$! $_VS_LOCKS"
172 ## Usage: unlock [<num>]
179 while test "$#" -gt 0; do
180 kill -HUP "$1" >/dev/null || :
182 test "$num" != 1 || break
183 test -z "$num" || let --num
188 function _pkgMountBindDir()
190 test "$1" != "$2" || return 0
192 mount -n --bind "$1" "$2"
195 function _pkgSetVarsBase
199 if test -d "$vserver/vdir"; then
201 VDIR=$(getPhysicalDir "$vserver/vdir")
203 PKGDIR=$BASEDIR/apps/pkgmgmt
204 test -d "$PKGDIR" || {
205 echo "Can not find configuration-directory for package-managment tools"
208 findDir EXECDIR $PKGDIR/execdir /
210 VDIR=$(getPhysicalDir "$vserver")
215 BASEDIR=$CONFDIR/$vserver
216 test -d "$BASEDIR" || {
217 echo "Can not find configuration-directory"
222 test -d "$VDIR" || VDIR=$DEFAULT_VSERVERDIR/$vserver
223 VDIR=$(getPhysicalDir "$VDIR")
225 PKGDIR=$BASEDIR/apps/pkgmgmt
226 test -d "$PKGDIR" || {
227 echo "Can not find configuration-directory for package-managment tools"
231 findDir EXECDIR $PKGDIR/execdir /
236 if test -z "$WORKAROUND_106057"; then
239 _rpmdb_mntpoint=/.rpmdb
243 function _pkgSetVarsRPM
245 if test "$PKGDIR"; then
246 findDir RPMETCDIR $PKGDIR/rpmetc $PKGDIR/base/rpm/etc /etc/rpm
247 findDir RPMSTATEDIR $PKGDIR/rpmstate $PKGDIR/base/rpm/state
249 findDir RPMLIBDIR $PKGDIR/rpmlib /
252 findDir RPMETCDIR "$VDIR"/etc/rpm /etc/rpm
253 findDir RPMSTATEDIR "$VDIR"/var/lib/rpm
257 RPMSTATEDIR=$(getPhysicalDir "$RPMSTATEDIR")
258 RPMETCDIR=$(getPhysicalDir "$RPMETCDIR")
261 function _pkgSetVarsApt
263 if test "$PKGDIR"; then
264 findDir APTETCDIR $PKGDIR/aptetc $PKGDIR/base/apt/etc /etc/apt
265 findDir APTSTATEDIR $PKGDIR/aptstate $PKGDIR/base/apt/state
266 findDir APTCACHEDIR $PKGDIR/aptcache $PKGDIR/base/apt/cache
267 findDir APTARCHIVDIR $PKGDIR/aptarchives $PKGDIR/base/apt/archives /var/cache/apt/archives
269 findDir APTETCDIR "$VDIR"/etc/apt /etc/apt
270 findDir APTSTATEDIR "$VDIR"/var/state/apt
271 findDir APTCACHEDIR "$VDIR"/var/cache/apt
272 findDir APTARCHIVDIR "$VDIR"/var/cache/apt/archives /var/cache/apt/archives
275 findFile APT_CONFIG "$APTETCDIR"/apt.conf ""
276 test -z "$APT_CONFIG" || export APT_CONFIG
279 function _pkgMountBase
284 function _pkgMountApt
289 function _pkgMountRPM
291 _pkgMountBindDir "$RPMETCDIR" /etc/rpm
292 test "$RPMLIBDIR" = "/" || _pkgMountBindDir "$RPMLIBDIR" /usr/lib/rpm
294 "$_SECURE_MOUNT" --chroot "$VDIR" -n --secure --bind "$RPMSTATEDIR" "$_rpmdb_mntpoint"
295 test -z "$WORKAROUND_106057" || mount -n --bind "$RPMSTATEDIR" "$_rpmdb_mntpoint"
297 test -e "$VDIR"/proc/self/status || \
298 "$_SECURE_MOUNT" --chroot "$VDIR" -n --secure -t proc none /proc
301 function _pkgSetEnvBase
303 test "$EXECDIR" = "/" || {
305 LD_LIBRARY_PATH=$EXECDIR${LD_LIBRARY_PATH:+:$LD_LIBRARY_PATH}
308 export PATH LD_LIBRARY_PATH
311 function _pkgSetEnvApt
316 function _pkgSetEnvRPM
319 RPM_FAKE_NAMESPACE_MOUNTS=$_rpmdb_mntpoint
320 RPM_BINARY=$_VRPM_PRELOAD
322 export CUR_VSERVER RPM_FAKE_NAMESPACE_MOUNTS RPM_BINARY
334 rpm) _pkgSetVarsRPM;;
335 apt) _pkgSetVarsApt;;
336 *) echo "Unknown packaging flavor" >&2; exit 1;;
357 _PKG_VSERVER=$vserver
360 function isAvoidNamespace
364 $_VSERVER_INFO - FEATURE namespace || return 0
365 cfgdir=$($_VSERVER_INFO "$1" CFGDIR) || return 0
366 test ! -e "$cfgdir"/namespace || return 1
367 test -e "$CONFDIR"/.defaults/nonamespace -o \
368 -e "$cfgdir"/nonamespace
371 function getAllVservers
376 for i in $CONFDIR/*; do
377 test -d "$i" || continue
378 test ! -e "$i"/disabled || continue
379 test -d "$i"/vdir || continue
384 _tmp=( "${_tmp[@]}" "${i##$CONFDIR/}")
387 eval $1='( "${_tmp[@]}" )'
390 ## Usage: getVserverCtx <vdir> <result-varname> [<procnumber-varname> [<do-cleanup>]]
391 ## Returns: 0 iff vserver is running
392 function getVserverStatus
394 test -r "$1"/run || return 1
400 test "$3" || return 0
401 local _tmp=$($_VPS ax | $_AWK '{print $2}' | $_GREP -x "$_ctx" | $_WC -l )
405 if test "$_tmp" = 0; then
406 local runfile=$($_READLINK "$1/run")
407 test -z "$4" || rm -f "$runfile"
414 ## Usage: isCtxRunning <ctx>
415 function isCtxRunning
417 local _tmp=$($_VPS ax | $_AWK '{print $2}' | $_GREP -x "$1" | $_WC -l )
421 ## Usage: isVserverRunning <vdir> [<ctx-varname>]
422 function isVserverRunning
426 getVserverStatus "$1" ctx procnum 1 || return 1
427 test $procnum != 0 || return 1
428 test -z "$2" || eval "$2"=\$ctx
432 ## Called as 'getFileValue <varname> <filename>'
433 function getFileValue
435 test -r "$2" || return 0
439 ## Called as 'getFileArray <varname> <filename>'
440 function getFileArray
442 test -r "$2" || return 1
444 local IFS=$_VS_NEWLINE
445 eval "$1"='( $(< "$2") )'
448 function checkComponents
459 core) test -x "$_CHBIND" || failed=1;;
460 build) test -x "$_VSERVER_BUILD" || failed=1;;
461 sysv) test -x "$INITRDDIR/vserver" || failed=1;;
462 devel) test -d "$INCLUDEDIR/vserver.h" || failed=1;;
463 *) echo "Unknown component '$i'" >&2
468 test -z "$failed" || {
477 ## Usage: isKernelAPI <ver> [<cmp-modifier>]
480 local api=$($_VSERVER_INFO - APIVER) || api=0
481 test $[ $api ] -${2:-ge} $[ $1 ]
484 ## Usage: callInNamespace <vserver> <command> <args>*
485 function callInNamespace
489 isAvoidNamespace "$1" || \
490 ctx=$( $_VSERVER_INFO "$1" CONTEXT f ) || ctx=
494 $_VNAMESPACE --enter "$ctx" -- "$@"
500 ## Usage: setDefaultTTY <vdir> [<fallback-tty>]
501 function setDefaultTTY
505 cfgdir=$($_VSERVER_INFO "$1" APPDIR init) || cfgdir=
506 findObject -e ttyname \
507 ${cfgdir:+"$cfgdir"/tty} \
508 "$CONFDIR/.defaults/apps/init/tty" \
515 ## Usage: pkgmgmt.guessStyle <vserver> <resultvar>
516 function pkgmgmt.guessStyle()
518 local vdir=$($_VSERVER_INFO "$1" VDIR) || {
519 echo $"Can not determine vserver-root" >&2
522 local cfgdir=$($_VSERVER_INFO "$1" APPDIR pkgmgmt) || :
524 if test "$cfgdir" -a -e "$cfgdir"/style; then
525 read style <"$cfgdir"/style
526 elif test -e "$vdir"/etc/redhat-release -o -e "$vdir"/etc/fedora-release; then
528 elif test -e "$vdir"/etc/mandrake-release; then
530 elif test -e "$vdir"/etc/debian_version; then
532 elif test -e "$vdir"/etc/SuSE-release; then
535 echo $"Can not determine packagemanagement style" >&2
543 ## Usage: pkgmgmt.isInternal <vserver>
544 ## returns true iff <vserver> is configured for internal packagemanagement
545 ## A typical application is
547 ## | pkgmgmt.isInternal "$vserver" || is_external=1
548 function pkgmgmt.isInternal
550 local cfgdir=$($_VSERVER_INFO "$1" APPDIR pkgmgmt) || :
552 test -z "$cfgdir" -o ! -d "$cfgdir" -o -e "$cfgdir"/internal
555 ## Usage: pkgmgmt.isAptAvailable <cfgdir> <vdir> [<is-internal>]
556 function pkgmgmt.isAptAvailable
560 local is_internal="$3"
563 if test "$is_internal"; then
565 test -d "$cfgdir"/base/apt -o -d "$cfgdir"/aptetc || have_apt=
568 for i in /bin /usr/bin /usr/local/bin; do
569 test ! -x "$vdir$i"/apt-get || { have_apt=1; break; }
573 test "$have_apt" && return 0 || return 1
576 function vshelper.doSanityCheck
578 local vshelper this_xid i
579 declare -a warnings=()
580 local solution_disable=
581 local solution_sysctl=
583 vshelper.isEnabled && vshelper.isEnabled warning || return 0
585 this_xid=$($_VSERVER_INFO - XID) ||
586 panic $"Failed to determine current context; aborting..."
588 ## Do nothing in other xid's; the helper will be executed in xid 0 only
589 test "$this_xid" = 0 || return 0
591 local proc_file=/proc/sys/kernel/vshelper
593 if ! test -r "$proc_file"; then
595 warnings=( "${warnings[@]}"
596 $"File '$proc_file' does not exists but is required for vshelper setup" )
599 vshelper=$(cat "$proc_file")
601 cmp -s "$vshelper" "$_VSHELPER" || {
602 warnings=( "${warnings[@]}"
603 $"The configured vshelper '$vshelper' does not match the 'vshelper'
604 script of the util-vserver package"
611 test -d "$VSHELPERSTATEDIR" || {
612 warnings=( "${warnings[@]}"
614 The vshelper state-directory '$VSHELPERSTATEDIR' does not exist; since
615 it is created by 'make install', this indicates a serious problem with
616 your util-vserver installation" )
620 test "${#warnings[@]}" -eq 0 || {
622 The following problem(s) were encountered while verifying vshelper
625 for i in "${warnings[@]}"; do
631 To fix this, you can:"
633 test -z "$solution_disable" || warning $"\
634 * disable vshelper entirely by executing
635 | touch \"$CONFDIR/.defaults/apps/vshelper/disabled\"
636 * disable only this message by executing
637 | touch \"$CONFDIR/.defaults/apps/vshelper/warning-disabled\""
639 test -x "$solution_sysctl" || warning $"\
640 * configure the util-vserver vshelper script, e.g. by adding
641 | kernel.vshelper = \"$_VSHELPER\"
642 to /etc/sysctl.conf and rebooting the machine, or by executing
643 | echo \"$_VSHELPER\" >$proc_file"
653 ## Usage: vshelper.isEnabled [<style>] [<vserver>]
654 function vshelper.isEnabled
656 local f=${1:+$1-}disabled
657 test ! -e "$CONFDIR"/.defaults/apps/vshelper/"$f" || return 1
658 $_VSERVER_INFO - FEATURE vshelper || return 1
660 local appdir=$($_VSERVER_INFO "$2" APPDIR vshelper) || return 0
661 test -z "$2" -o ! -e "$appdir/$f" || return 1
667 function vshelper._getHandlerInternal
672 shift ## HACK: see below the note about the 'set -u' mode
674 while test "$#" -ge 2; do
679 test "$mod" "$obj" || continue
688 (*) panic $"Internal error, unexpected modifier '$mod'"
696 ## Usage: vshelper.getHandler <result-var> <vserver> <action>
697 function vshelper.getHandler
699 local appdir=$($_VSERVER_INFO "$2" APPDIR vshelper) || appdir=
701 declare -a search_list=( X )
702 ## HACK: when we are in 'set -u' mode, empty lists are causing errors
704 test -z "$appdir" || search_list=( "${search_list[@]}" -x "$appdir/$3" )
705 test -z "$appdir" || search_list=( "${search_list[@]}" -e "$appdir/action" )
706 search_list=( "${search_list[@]}" -x "$CONFDIR"/.defaults/apps/vshelper/"$3" )
707 search_list=( "${search_list[@]}" -e "$CONFDIR"/.defaults/apps/vshelper/action )
709 ! vshelper._getHandlerInternal "$1" "${search_list[@]}" || return 0
713 ## Usage: vshelper.init <vserver> [<method> <args>*]
714 function vshelper.doInit
716 vshelper.isEnabled || return 0
718 local xid=$($_VSERVER_INFO "$1" CONTEXT false) && test "$xid" || {
719 warning $"vshelper.init: can not determine xid of vserver '$vserver'; returned value was '$xid'"
723 local f="$VSHELPERSTATEDIR/$xid"
743 ## Usage: vshelper.doDestroy <vserver> <xid>
744 function vshelper.doDestroy
746 vshelper.isEnabled || return 0
748 rm -f "$VSHELPERSTATEDIR/$2"
751 ## Usage: vshelper.initSync <vserver> <pipe-varname>
752 function vshelper.initSync
754 local tmpdir=$(mktemp -d /tmp/vserver-stop.XXXXXX) || {
755 warning $"Failed to generate temporary directory for vshelper sync"
759 local fifo="$tmpdir"/pipe
761 vshelper.doInit "$VSERVER_DIR" sync "$fifo"
765 ## Usage: vshelper.getSyncTimeout <vserver> <varname>
766 function vshelper.getSyncTimeout
768 local appdir=$($_VSERVER_INFO "$1" APPDIR vshelper) || appdir=
771 findFile file ${appdir:+"$appdir"/sync-timeout} "$CONFDIR"/.defaults/apps/vshelper/sync-timeout ''
772 test "$file" || return 1