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}
34 test "$_fo_i" || continue
35 test ! $_fo_mod "$_fo_i" || { _fo_file=$_fo_i; break; }
38 test -z "$_fo_i" -o "$_fo_file" || {
39 echo "Can not find file for '$_fo_var'; aborting"
43 eval "$_fo_var=\"$_fo_file\""
59 test ! -s "$dst" || return 0
65 test "$tmp" -a -s "$tmp" || return 0
66 $_CP -af "$tmp" "$dst"
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 pushd "$VDIR" >/dev/null
296 $_SECURE_MOUNT --chroot -n --bind "$RPMSTATEDIR" "$_rpmdb_mntpoint"
297 test -z "$WORKAROUND_106057" || mount -n --bind "$RPMSTATEDIR" "$_rpmdb_mntpoint"
299 test -e "$VDIR"/proc/self/status || \
300 $_SECURE_MOUNT --chroot -n -t proc none /proc
305 function _pkgSetEnvBase
307 test "$EXECDIR" = "/" || {
309 LD_LIBRARY_PATH=$EXECDIR${LD_LIBRARY_PATH:+:$LD_LIBRARY_PATH}
312 export PATH LD_LIBRARY_PATH
315 function _pkgSetEnvApt
320 function _pkgSetEnvRPM
323 RPM_FAKE_NAMESPACE_MOUNTS=$_rpmdb_mntpoint
324 RPM_BINARY=$_VRPM_PRELOAD
326 export CUR_VSERVER RPM_FAKE_NAMESPACE_MOUNTS RPM_BINARY
338 rpm) _pkgSetVarsRPM;;
339 apt) _pkgSetVarsApt;;
340 *) echo "Unknown packaging flavor" >&2; exit 1;;
361 _PKG_VSERVER=$vserver
364 function isAvoidNamespace
368 $_VSERVER_INFO - FEATURE namespace || return 0
369 cfgdir=$($_VSERVER_INFO "$1" CFGDIR) || return 0
370 test ! -e "$cfgdir"/namespace || return 1
371 test -e "$CONFDIR"/.defaults/nonamespace -o \
372 -e "$cfgdir"/nonamespace
375 function getAllVservers
378 declare -a _ga_tmp=()
380 for _ga_i in $CONFDIR/*; do
381 test -d "$_ga_i" || continue
382 test ! -e "$_ga_i"/disabled || continue
383 test -d "$_ga_i"/vdir || continue
388 _ga_tmp=( "${_ga_tmp[@]}" "${_ga_i##$CONFDIR/}")
391 eval $1='( "${_ga_tmp[@]}" )'
394 ## Usage: _getProcNumberCount <ctx> <var>
395 function _getProcNumberCount
398 local _gp_procnr_cnt=0
400 # Use /proc/virtual from kernel 2.6 when possible
401 if test -d "/proc/virtual"; then
402 set -- $($_GREP '^PROC:' "/proc/virtual/$1/limit" 2>/dev/null)
405 _gp_procnr_cnt=$($_VPS ax | $_AWK '{print $2}' | $_GREP -x "$1" | $_WC -l )
408 let _gp_procnr_cnt=_gp_procnr_cnt+0
409 eval $_gp_var=\$_gp_procnr_cnt
412 ## Usage: getVserverCtx <vdir> <result-varname> [<procnumber-varname> [<do-cleanup>]]
413 ## Returns: 0 iff vserver is running
414 function getVserverStatus
416 test -r "$1"/run || return 1
419 read _gvs_ctx <"$1"/run
422 test "$3" || return 0
424 _getProcNumberCount "$_gvs_ctx" _gvs_tmp
427 if test "$_gvs_tmp" = 0; then
428 local runfile=$($_READLINK "$1/run")
429 test -z "$4" || $_RM -f "$runfile"
436 ## Usage: isCtxRunning <ctx>
437 function isCtxRunning
440 _getProcNumberCount "$1" _tmp
444 ## Usage: isVserverRunning <vdir> [<ctx-varname>]
445 function isVserverRunning
447 local _ivr_ctx _ivr_procnum
449 getVserverStatus "$1" _ivr_ctx _ivr_procnum 1 || return 1
450 test $_ivr_procnum != 0 || return 1
451 test -z "$2" || eval "$2"=\$_ivr_ctx
455 ## Called as 'getFileValue <varname> <filename>+'
456 function getFileValue
462 findFile _gfv_file "$@" ''
463 test "$_gfv_file" -a -r "$_gfv_file" || return 0
464 eval read "$_gfv_var" <"$_gfv_file"
467 ## Called as 'getFileArray <varname> <filename>'
468 function getFileArray
470 test -r "$2" || return 1
472 local IFS=$_VS_NEWLINE
473 eval "$1"='( $(< "$2") )'
476 function checkComponents
487 (core) test -x "$_CHBIND" || failed=1;;
488 (build) test -x "$_VSERVER_BUILD" || failed=1;;
489 (sysv) test -x "$INITRDDIR/vserver" || failed=1;;
490 (devel) test -d "$INCLUDEDIR/vserver.h" || failed=1;;
491 (*) echo "Unknown component '$i'" >&2
496 test -z "$failed" || {
505 ## Usage: isKernelAPI <ver> [<cmp-modifier>]
508 local api=$($_VSERVER_INFO - APIVER) || api=0
509 test $[ $api ] -${2:-ge} $[ $1 ]
512 ## Usage: callInNamespace <vserver> <command> <args>*
513 function callInNamespace
517 isAvoidNamespace "$1" || \
518 ctx=$( $_VSERVER_INFO "$1" CONTEXT f ) || ctx=
522 $_VNAMESPACE --enter "$ctx" -- "$@"
528 ## Usage: setDefaultTTY <vdir> [<fallback-tty>]
529 function setDefaultTTY
533 cfgdir=$($_VSERVER_INFO "$1" APPDIR init) || cfgdir=
534 findObject -e ttyname \
535 ${cfgdir:+"$cfgdir"/tty} \
536 "$CONFDIR/.defaults/apps/init/tty" \
543 ## Usage: pkgmgmt.guessStyle <vserver> <resultvar>
544 function pkgmgmt.guessStyle()
546 local _pgs_vdir=$($_VSERVER_INFO "$1" VDIR) || {
547 echo $"Can not determine vserver-root" >&2
550 local _pgs_cfgdir=$($_VSERVER_INFO "$1" APPDIR pkgmgmt) || :
552 if test "$_pgs_cfgdir" -a -e "$_pgs_cfgdir"/style; then
553 read style <"$_pgs_cfgdir"/style
554 elif test -e "$_pgs_vdir"/etc/redhat-release -o -e "$_pgs_vdir"/etc/fedora-release; then
556 elif test -e "$_pgs_vdir"/etc/mandrake-release; then
558 elif test -e "$_pgs_vdir"/etc/debian_version; then
560 elif test -e "$_pgs_vdir"/etc/SuSE-release; then
563 echo $"Can not determine packagemanagement style" >&2
571 ## Usage: pkgmgmt.isInternal <vserver>
572 ## returns true iff <vserver> is configured for internal packagemanagement
573 ## A typical application is
575 ## | pkgmgmt.isInternal "$vserver" || is_external=1
576 function pkgmgmt.isInternal
578 local cfgdir=$($_VSERVER_INFO "$1" APPDIR pkgmgmt) || :
580 test -z "$cfgdir" -o ! -d "$cfgdir" -o -e "$cfgdir"/internal
583 ## Usage: pkgmgmt.isAptAvailable <cfgdir> <vdir> [<is-internal>]
584 function pkgmgmt.isAptAvailable
588 local is_internal="$3"
591 if test "$is_internal"; then
593 test -d "$cfgdir"/base/apt -o -d "$cfgdir"/aptetc || have_apt=
596 for i in /bin /usr/bin /usr/local/bin; do
597 test ! -x "$vdir$i"/apt-get || { have_apt=1; break; }
601 test "$have_apt" && return 0 || return 1
604 function vshelper.doSanityCheck
606 local vshelper this_xid i
607 declare -a warnings=()
608 local solution_disable=
609 local solution_sysctl=
611 vshelper.isEnabled && vshelper.isEnabled warning || return 0
613 this_xid=$($_VSERVER_INFO - XID) ||
614 panic $"Failed to determine current context; aborting..."
616 ## Do nothing in other xid's; the helper will be executed in xid 0 only
617 test "$this_xid" = 0 || return 0
619 local proc_file=/proc/sys/kernel/vshelper
621 if ! test -r "$proc_file"; then
623 warnings=( "${warnings[@]}"
624 $"File '$proc_file' does not exists but is required for vshelper setup" )
627 vshelper=$(cat "$proc_file")
629 $_CMP -s "$vshelper" "$_VSHELPER" || {
630 warnings=( "${warnings[@]}"
631 $"The configured vshelper '$vshelper' does not match the 'vshelper'
632 script of the util-vserver package"
639 test -d "$VSHELPERSTATEDIR" || {
640 warnings=( "${warnings[@]}"
642 The vshelper state-directory '$VSHELPERSTATEDIR' does not exist; since
643 it is created by 'make install', this indicates a serious problem with
644 your util-vserver installation" )
648 test "${#warnings[@]}" -eq 0 || {
650 The following problem(s) were encountered while verifying vshelper
653 for i in "${warnings[@]}"; do
659 To fix this, you can:"
661 test -z "$solution_disable" || warning $"\
662 * disable vshelper entirely by executing
663 | touch \"$CONFDIR/.defaults/apps/vshelper/disabled\"
664 * disable only this message by executing
665 | touch \"$CONFDIR/.defaults/apps/vshelper/warning-disabled\""
667 test -x "$solution_sysctl" || warning $"\
668 * configure the util-vserver vshelper script, e.g. by adding
669 | kernel.vshelper = \"$_VSHELPER\"
670 to /etc/sysctl.conf and rebooting the machine, or by executing
671 | echo \"$_VSHELPER\" >$proc_file"
681 ## Usage: vshelper.isEnabled [<style>] [<vserver>]
682 function vshelper.isEnabled
684 local f=${1:+$1-}disabled
685 test ! -e "$CONFDIR"/.defaults/apps/vshelper/"$f" || return 1
686 $_VSERVER_INFO - FEATURE vshelper || return 1
688 local appdir=$($_VSERVER_INFO "$2" APPDIR vshelper) || return 0
689 test -z "$2" -o ! -e "$appdir/$f" || return 1
695 function vshelper._getHandlerInternal
700 shift ## HACK: see below the note about the 'set -u' mode
702 while test "$#" -ge 2; do
707 test "$_vghi_mod" "$_vghi_obj" || continue
710 eval $_vghi_var=\$_vghi_obj
713 read _vghi_tmp <"$_vghi_obj"
714 eval $_vghi_var=:\$_vghi_tmp
716 (*) panic $"Internal error, unexpected modifier '$_vghi_mod'"
724 ## Usage: vshelper.getHandler <result-var> <vserver> <action>
725 function vshelper.getHandler
727 local _vgh_appdir=$($_VSERVER_INFO "$2" APPDIR vshelper) || _vgh_appdir=
728 declare -a _vgh_search_list=( X )
729 ## HACK: when we are in 'set -u' mode, empty lists are causing errors
731 test -z "$_vgh_appdir" || _vgh_search_list=( "${_vgh_search_list[@]}" -x "$_vgh_appdir/$3" )
732 test -z "$_vgh_appdir" || _vgh_search_list=( "${_vgh_search_list[@]}" -e "$_vgh_appdir/action" )
733 _vgh_search_list=( "${_vgh_search_list[@]}" -x "$CONFDIR"/.defaults/apps/vshelper/"$3" )
734 _vgh_search_list=( "${_vgh_search_list[@]}" -e "$CONFDIR"/.defaults/apps/vshelper/action )
736 ! vshelper._getHandlerInternal "$1" "${_vgh_search_list[@]}" || return 0
740 ## Usage: vshelper.init <vserver> [<method> <args>*]
741 function vshelper.doInit
743 vshelper.isEnabled || return 0
745 local xid=$($_VSERVER_INFO "$1" CONTEXT false) && test "$xid" || {
746 warning $"vshelper.init: can not determine xid of vserver '$vserver'; returned value was '$xid'"
750 local f="$VSHELPERSTATEDIR/$xid"
770 ## Usage: vshelper.doDestroy <vserver> <xid>
771 function vshelper.doDestroy
773 vshelper.isEnabled || return 0
775 $_RM -f "$VSHELPERSTATEDIR/$2"
778 ## Usage: vshelper.initSync <vserver> <pipe-varname>
779 function vshelper.initSync
781 local _vis_tmpdir=$($_MKTEMPDIR /tmp/vserver-stop.XXXXXX) || {
782 warning $"Failed to generate temporary directory for vshelper sync"
786 local _vis_fifo="$_vis_tmpdir"/pipe
787 $_MKFIFO -m700 "$_vis_fifo"
788 vshelper.doInit "$1" sync "$_vis_fifo"
792 ## Usage: vshelper.getSyncTimeout <vserver> <varname>
793 function vshelper.getSyncTimeout
795 local _vgst_appdir=$($_VSERVER_INFO "$1" APPDIR vshelper) || _vgst_appdir=
796 local _vgst_file _vgst_tmp
798 findFile _vgst_file ${_vgst_appdir:+"$_vgst_appdir"/sync-timeout} "$CONFDIR"/.defaults/apps/vshelper/sync-timeout ''
799 test "$_vgst_file" || return 1
800 read _vgst_tmp <"$_vgst_file"