017bb070c08819c5c2381c061d148d39a7b5b2fd
[util-vserver.git] / util-vserver / scripts / functions
1 # $Id$  --*- sh -*--
2
3 # Copyright (C) 2003 Enrico Scholz <enrico.scholz@informatik.tu-chemnitz.de>
4 #  
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.
8 #  
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.
13 #  
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.
17
18 _VS_LOGFILE=
19 _VS_ERRFILE=
20
21 _VS_NEWLINE='
22 '
23 declare -r _VS_NEWLINE=${_VS_NEWLINE:0-1}
24 declare -r VS_ALLVSERVERS_ARGS=all,marked,unmarked,stopped,running
25
26 function findObject
27 {
28     local _fo_mod=$1
29     local _fo_var=$2
30     local _fo_file=
31     local _fo_i=X
32     shift 2
33     
34     for _fo_i; do
35         test -n "$_fo_i"         || continue
36         test ! $_fo_mod "$_fo_i" || { _fo_file=$_fo_i; break; }
37     done
38
39     test -z "$_fo_i" -o -n "$_fo_file" || {
40         echo "Can not find file for '$_fo_var'; aborting"
41         exit 1
42     } >&2
43
44     eval "$_fo_var=\"$_fo_file\""
45 }
46
47 function findFile
48 {
49     findObject -f "$@"
50 }
51
52 function findDir
53 {
54     findObject -d "$@"
55 }
56
57 function findAndCopy
58 {
59     local dst=$1
60     test ! -s "$dst"         || return 0
61     
62     local tmp
63     shift
64     findFile tmp "$@"
65
66     test -n "$tmp" -a -s "$tmp" || return 0
67     $_CP -af "$tmp" "$dst"
68 }
69
70 ## Usage: isRegularFile <filename> [<mod>]
71 function isRegularFile
72 {
73     test ${mod:--f} "$1" || return 1
74
75     case $file in
76         (*.rpmsave|*.rpmnew|*.rpmorig|*.cfsaved*|*.~*~) return 1;;
77     esac
78
79     return 0
80 }
81
82 function getPhysicalDir
83 {
84     ( set -P && cd "$1" && pwd )
85 }
86
87 ## Usage: logging <message>
88 function logging
89 {
90     if test -n "$_VS_LOGFILE"; then
91         echo "$@" >>"$_VS_LOGFILE"
92     else
93         echo "$@"
94     fi
95 }
96
97 ## Usage: warning <message>
98 function warning
99 {
100     if test -n "$_VS_ERRFILE"; then
101         echo "$@" >>"$_VS_ERRFILE"
102     else
103         echo "$@" >&2
104     fi
105 }
106
107 ## Usage: panic <message>
108 function panic
109 {
110     if test -n "$_VS_ERRFILE"; then
111         echo "$@" >>"$_VS_ERRFILE"
112     else
113         echo "$@" >&2
114     fi
115
116     exit 1
117 }
118
119 ## Usage: execute <message>
120 function execute
121 {
122     test -z "${DEBUG_EXEC:-}"       || echo "$@"
123     test "${DEBUG_EXEC:-}" = noexec || exec "$@"
124     exit 0
125 }
126
127
128 ## Usage: spawn <message>
129 function spawn
130 {
131     test -z "${DEBUG_EXEC:-}"       || echo  "$@"
132     test "${DEBUG_EXEC:-}" = noexec || "$@"
133 }
134
135 ## Usage: isNumber <arg>
136 function isNumber
137 {
138     local tmp
139     let tmp=$1+0 2>/dev/null || test -z "${1//0/}" -a -n "$1" || return 1
140     return 0
141 }
142
143 ## Usage: colorize <style> <command>
144 function colorize
145 {
146     local       style=$1
147     shift
148     
149     if ! $_TTY -s; then
150         "$@"
151     else
152         local   cfile
153         findFile cfile "$__CONFDIR"/.defaults/styles/"$style" ''
154         if test -n "$cfile"; then
155           $_CAT "$cfile"
156         else
157           case "$style" in
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";;
163             (*)         ;;
164           esac
165         fi
166             
167         "$@"
168         echo -ne "\e[m"
169     fi
170 }
171
172 ## Usage: xtermTitle <title>
173 function xtermTitle
174 {
175     $_TTY -s || return 0
176     echo -ne "\e]0;$@\007"
177 }
178
179 _VS_LOCKS=''
180 ## Usage: lock <lockfile> [<timeout>]
181 function lock
182 {
183     local tmp=$($_MKTEMP /tmp/vserver-lock.XXXXXX)
184     $_RM -f $tmp
185     $_MKFIFO -m600 $tmp
186
187     $_LOCKFILE "$1" $tmp $2 &
188     $_GREP -q true $tmp 2>/dev/null || return 1
189     
190     _VS_LOCKS="$! $_VS_LOCKS"
191 }
192
193 ## Usage: unlock [<num>]
194 function unlock
195 {
196     local num=$1
197     local i
198
199     set -- $_VS_LOCKS
200     while test "$#" -gt 0; do
201         kill -HUP "$1" >/dev/null || :
202         shift
203         test "$num" != 1 || break
204         test -z "$num"   || let --num
205     done
206     _VS_LOCKS="$@"
207 }
208
209 function _pkgMountBindDir()
210 {
211     test "$1" != "$2" || return 0
212
213     $_MOUNT -n --bind "$1" "$2"
214 }
215
216 function _pkgSetVarsBase
217 {
218     case "$vserver" in
219         ./*|/*)
220             if test -d "$vserver/vdir"; then
221                 BASEDIR=$vserver
222                 VDIR=$(getPhysicalDir "$vserver/vdir")
223                 
224                 PKGDIR=$BASEDIR/apps/pkgmgmt
225                 test -d "$PKGDIR" || {
226                     echo "Can not find configuration-directory for package-managment tools"
227                     exit 1
228                 } >&2
229                 findDir EXECDIR      $PKGDIR/execdir     /
230             else
231                 VDIR=$(getPhysicalDir "$vserver")
232                 PKGDIR=
233             fi
234             ;;
235         *)
236             BASEDIR=$__CONFDIR/$vserver
237             test -d "$BASEDIR" || {
238                 echo "Can not find configuration-directory"
239                 exit 1
240             } >&2
241             
242             VDIR=$BASEDIR/vdir
243             test -d "$VDIR"   || VDIR=$__DEFAULT_VSERVERDIR/$vserver
244             VDIR=$(getPhysicalDir "$VDIR")
245             
246             PKGDIR=$BASEDIR/apps/pkgmgmt
247             test -d "$PKGDIR" || {
248                 echo "Can not find configuration-directory for package-managment tools"
249                 exit 1
250             } >&2
251
252             findDir EXECDIR      $PKGDIR/execdir     /
253
254             ;;
255     esac
256
257     if test -z "$WORKAROUND_106057"; then
258         _rpmdb_mntpoint=/dev
259     else
260         _rpmdb_mntpoint=/.rpmdb
261     fi
262 }
263
264 function _pkgSetVarsRPM
265 {
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
269
270         findDir RPMLIBDIR    $PKGDIR/rpmlib      /
271
272     else
273         findDir RPMETCDIR    "$VDIR"/etc/rpm     /etc/rpm
274         findDir RPMSTATEDIR  "$VDIR"/var/lib/rpm
275         RPMLIBDIR=/
276     fi
277     
278     RPMSTATEDIR=$(getPhysicalDir "$RPMSTATEDIR")
279     RPMETCDIR=$(getPhysicalDir "$RPMETCDIR")
280 }
281
282 function _pkgSetVarsApt
283 {
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
289     else
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
294     fi
295
296     findFile APT_CONFIG "$APTETCDIR"/apt.conf ""
297     test -z "$APT_CONFIG" || export APT_CONFIG
298 }
299
300 function _pkgSetVarsYum
301 {
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
305     else
306         findDir YUMETCDIR    "$VDIR"/etc         /etc
307         findDir YUMCACHEDIR  "$VDIR"/var/cache/yum
308     fi
309 }
310
311
312 function _pkgMountBase
313 {
314     :
315 }
316
317 function _pkgMountApt
318 {
319     :
320 }
321
322 function _pkgMountYum
323 {
324     :
325 }
326
327 function _pkgMountRPM
328 {
329     _pkgMountBindDir "$RPMETCDIR" /etc/rpm
330     test "$RPMLIBDIR" = "/" || _pkgMountBindDir "$RPMLIBDIR" /usr/lib/rpm
331
332     pushd "$VDIR" >/dev/null
333
334     $_SECURE_MOUNT --chroot -n --bind "$RPMSTATEDIR" "$_rpmdb_mntpoint"
335     test -z "$WORKAROUND_106057" || mount -n --bind "$RPMSTATEDIR" "$_rpmdb_mntpoint"
336
337     test -e "$VDIR"/proc/self/status || \
338         $_SECURE_MOUNT --chroot -n -t proc none /proc
339
340     popd >/dev/null
341 }
342
343 function _pkgSetEnvBase
344 {
345     test "$EXECDIR" = "/" || {
346         PATH=$EXECDIR:$PATH
347         LD_LIBRARY_PATH=$EXECDIR${LD_LIBRARY_PATH:+:$LD_LIBRARY_PATH}
348     }
349
350     export PATH LD_LIBRARY_PATH
351 }
352
353 function _pkgSetEnvApt
354 {
355     :
356 }
357
358 function _pkgSetEnvYum
359 {
360     :
361 }
362
363 function _pkgSetEnvRPM
364 {
365     CUR_VSERVER=$vserver
366     RPM_FAKE_NAMESPACE_MOUNTS=$_rpmdb_mntpoint
367     RPM_BINARY=$_VRPM_PRELOAD
368
369     export CUR_VSERVER RPM_FAKE_NAMESPACE_MOUNTS RPM_BINARY
370 }
371
372 function pkgInit
373 {
374     local i
375     local vserver=$1
376     shift
377     
378     _pkgSetVarsBase
379     for i; do
380         case "$i" in
381             rpm)        _pkgSetVarsRPM;;
382             apt)        _pkgSetVarsApt;;
383             yum)        _pkgSetVarsYum;;
384             *)          echo "Unknown packaging flavor" >&2; exit 1;;
385         esac
386     done
387
388     _pkgMountBase
389     for i; do
390         case "$i" in
391             rpm)        _pkgMountRPM;;
392             apt)        _pkgMountApt;;
393             yum)        _pkgMountYum;;
394         esac
395     done
396
397     _pkgSetEnvBase
398     for i; do
399         case "$i" in
400             rpm)        _pkgSetEnvRPM;;
401             apt)        _pkgSetEnvApt;;
402             yum)        _pkgSetEnvYum;;
403         esac
404     done
405
406     _PKG_FLAVORS="$@"
407     _PKG_VSERVER=$vserver
408 }
409
410 function isAvoidNamespace
411 {
412     local cfgdir
413
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
419 }
420
421 ## Usage: getAllVservers <var> [<KIND>*]
422 function getAllVservers
423 {
424     local _ga_i
425     declare -a _ga_tmp=()
426
427     for _ga_i in $__CONFDIR/*; do
428         isRegularFile "$_ga_i" -d   || continue
429
430         test ! -e "$_ga_i"/disabled || continue
431         test   -d "$_ga_i"/vdir     || continue
432
433         local _ga_doadd=1
434         local _ga_markfile=$_ga_i/apps/init/mark
435         
436         case ${2:-ALL} in
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=;;
441             (ALL)       ;;
442             (*)         panic $"Unknown vserver tagging '$2'";;
443         esac
444
445         test -z "$_ga_doadd" || _ga_tmp=( "${_ga_tmp[@]}" "${_ga_i##$__CONFDIR/}")
446     done
447
448     eval $1='( "${_ga_tmp[@]}" )'
449 }
450
451 ## Usage: getAllVserversByArg <var> <arg>
452 function getAllVserversByArg
453 {
454     local _gav_mark=
455     
456     case $2 in
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;;
462         (*)             return 1;;
463     esac
464
465     getAllVservers "$1" "$_gav_mark"
466 }
467
468 ## Usage: _getProcNumberCount <ctx> <var>
469 function _getProcNumberCount
470 {
471     local _gp_var=$2
472     local _gp_procnr_cnt=0
473
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)
477         _gp_procnr_cnt=$2
478     else
479         _gp_procnr_cnt=$($_VPS ax | $_AWK '{print $2}' | $_GREP -x "$1" | $_WC -l )
480     fi
481
482     let _gp_procnr_cnt=_gp_procnr_cnt+0
483     eval $_gp_var=\$_gp_procnr_cnt
484 }
485
486 ## Usage: getVserverCtx <vdir> <result-varname> [<procnumber-varname> [<do-cleanup>]]
487 ## Returns: 0 iff vserver is running
488 function getVserverStatus
489 {
490     test -r "$1"/run || return 1
491
492     local _gvs_ctx
493     read _gvs_ctx <"$1"/run
494     eval "$2"=\$_gvs_ctx
495
496     test -n "$3"     || return 0
497     local _gvs_tmp
498     _getProcNumberCount "$_gvs_ctx" _gvs_tmp
499     eval "$3"=\$_gvs_tmp
500
501     if test "$_gvs_tmp" = 0; then
502         local runfile=$($_READLINK "$1/run")
503         test -z "$4" || $_RM -f "$runfile"
504         return 1
505     fi
506
507     return 0
508 }
509
510 ## Usage: isCtxRunning <ctx>
511 function isCtxRunning
512 {
513     local _tmp
514     _getProcNumberCount "$1" _tmp
515     test $_tmp -gt 0
516 }
517
518 ## Usage: isVserverRunning <vdir> [<ctx-varname>]
519 function isVserverRunning
520 {
521     local _ivr_ctx _ivr_procnum
522
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
526     return 0
527 }
528
529 ## Called as 'getFileValue <varname> <filename>+'
530 function getFileValue
531 {
532     local _gfv_var=$1
533     local _gfv_file
534     shift
535
536     findFile _gfv_file "$@" ''
537     test -n "$_gfv_file" -a -r "$_gfv_file" || return 0
538     eval read "$_gfv_var" <"$_gfv_file"
539 }
540
541 ## Called as 'getFileArray <varname> <filename>'
542 function getFileArray
543 {
544     test -r "$2" || return 1
545     
546     local IFS=$_VS_NEWLINE
547     eval "$1"='( $(< "$2") )'
548 }
549
550 function checkComponents
551 {
552     local       i
553     local       msg=$1
554     local       x_failed=
555
556     shift
557     
558     for i; do
559         local failed=
560         case "$i" in
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
566                         return false
567                         ;;
568         esac
569
570         test -z "$failed" || {
571             echo "$msg: $i"
572             x_failed=1
573         } >&2
574     done
575
576     test -z "$x_failed"
577 }
578
579 ## Usage: isKernelAPI <ver> [<cmp-modifier>]
580 function isKernelAPI
581 {
582     local api
583     api=$($_VSERVER_INFO - APIVER) || api=0
584     test $[ $api ] -${2:-ge} $[ $1 ]
585 }
586
587 ## Usage: callInNamespace <vserver> <command> <args>*
588 function callInNamespace
589 {
590     local ctx=
591     
592     isAvoidNamespace "$1" || \
593     ctx=$( $_VSERVER_INFO "$1" CONTEXT f ) || ctx=
594
595     shift
596     if test -n "$ctx"; then
597         $_VNAMESPACE --enter "$ctx" -- "$@"
598     else
599         "$@"
600     fi
601 }
602
603 ## Usage: setDefaultTTY <vdir> [<fallback-tty>]
604 function setDefaultTTY
605 {
606     local cfgdir ttyname
607
608     cfgdir=$($_VSERVER_INFO "$1" APPDIR init) || cfgdir=
609     findObject -e ttyname \
610         ${cfgdir:+"$cfgdir"/tty} \
611         "$__CONFDIR/.defaults/apps/init/tty" \
612         $2 /dev/null
613
614     exec   <$ttyname
615     exec  &>$ttyname
616 }
617
618 ## Usage: killContext <XID> [<SIG>]
619 function killContext
620 {
621     local sig=${2:-9}
622
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 || :
628 }
629
630 ## Usage: pkgmgmt.guessStyle <vserver> <resultvar>
631 function pkgmgmt.guessStyle()
632 {
633     local _pgs_vdir
634     _pgs_vdir=$($_VSERVER_INFO "$1" VDIR) || {
635         echo $"Can not determine vserver-root" >&2
636         return 1
637     }
638     local _pgs_cfgdir=$($_VSERVER_INFO "$1" APPDIR pkgmgmt) || :
639
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
643         style=redhat
644     elif test -e "$_pgs_vdir"/etc/mandrake-release; then
645         style=mandrake
646     elif test -e "$_pgs_vdir"/etc/debian_version; then
647         style=debian
648     elif test -e "$_pgs_vdir"/etc/SuSE-release; then
649         style=suse
650     else
651         echo $"Can not determine packagemanagement style" >&2
652         return 1
653     fi
654
655     eval $2=\$style
656     return 0
657 }
658
659 ## Usage: pkgmgmt.isInternal <vserver>
660 ## returns true iff <vserver> is configured for internal packagemanagement
661 ## A typical application is
662 ## | is_external=
663 ## | pkgmgmt.isInternal "$vserver" || is_external=1
664 function pkgmgmt.isInternal
665 {
666     local cfgdir=$($_VSERVER_INFO "$1" APPDIR pkgmgmt) || :
667
668     test -z "$cfgdir" -o ! -d "$cfgdir" -o -e "$cfgdir"/internal
669 }
670
671 ## Usage: pkgmgmt.isAptAvailable <cfgdir> <vdir> [<is-internal>]
672 function pkgmgmt.isAptAvailable
673 {
674     local cfgdir="$1"
675     local vdir="$2"
676     local is_internal="$3"
677     
678     local have_apt i
679     if test -n "$is_internal"; then
680         have_apt=1
681         test -d "$cfgdir"/base/apt -o -d "$cfgdir"/aptetc || have_apt=
682     else
683         have_apt=
684         for i in /bin /usr/bin /usr/local/bin; do
685             test ! -x "$vdir$i"/apt-get || { have_apt=1; break; }
686         done
687     fi
688
689     test -n "$have_apt" && return 0 || return 1
690 }
691
692 ## Usage: pkgmgmt.isYumAvailable <cfgdir> <vdir> [<is-internal>]
693 function pkgmgmt.isYumAvailable
694 {
695     local cfgdir="$1"
696     local vdir="$2"
697     local is_internal="$3"
698     
699     local have_yum i
700     if test -n "$is_internal"; then
701         have_yum=1
702         test -d "$cfgdir"/base/yum -o -d "$cfgdir"/yumetc || have_yum=
703     else
704         have_yum=
705         for i in /bin /usr/bin /usr/local/bin; do
706             test ! -x "$vdir$i"/yum || { have_yum=1; break; }
707         done
708     fi
709
710     test -n "$have_yum" && return 0 || return 1
711 }
712
713
714 function vshelper.doSanityCheck
715 {
716     local vshelper this_xid i
717     declare -a warnings=()
718     local solution_disable=
719     local solution_sysctl=
720
721     vshelper.isEnabled && vshelper.isEnabled warning || return 0
722     
723     this_xid=$($_VSERVER_INFO - XID) ||
724         panic $"Failed to determine current context; aborting..."
725
726     ## Do nothing in other xid's; the helper will be executed in xid 0 only
727     test "$this_xid" = 0 || return 0
728
729     local proc_file=/proc/sys/kernel/vshelper
730
731     if ! test -r "$proc_file"; then
732         vshelper=
733         warnings=( "${warnings[@]}"
734                    $"File '$proc_file' does not exist but is required for vshelper setup" )
735         solution_disable=1
736     else
737         vshelper=$(cat "$proc_file")
738
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"
743                      )
744             solution_disable=1
745             solution_sysctl=1
746         }
747     fi
748
749     test -d "$__VSHELPERSTATEDIR" || {
750         warnings=( "${warnings[@]}"
751                    $"\
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" )
755         solution_disable=1
756     }
757
758     test "${#warnings[@]}" -eq 0 || {
759         warning $"\
760 The following problem(s) were encountered while verifying vshelper
761 functionality:"
762
763         for i in "${warnings[@]}"; do
764             warning "* $i"
765         done
766
767         warning $"\
768         
769 To fix this, you can:"
770
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\""
776
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"
782
783         warning ""
784
785         return 1
786     }
787
788     return 0
789 }
790
791 ## Usage: vshelper.isEnabled [<style>] [<vserver>]
792 function vshelper.isEnabled
793 {
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
798         local appdir
799         appdir=$($_VSERVER_INFO "$2" APPDIR vshelper)       || return 0
800         test -z "$2" -o ! -e "$appdir/$f"                   || return 1
801     fi
802
803     return 0
804 }
805
806 ## Usage: vshelper.isDebug [<vserver>]
807 function vshelper.isDebug
808 {
809     test ! -e "$__CONFDIR"/.defaults/apps/vshelper/debug    || return 0
810     $_VSERVER_INFO - FEATURE vshelper                       || return 1
811     if test -n "$1"; then
812         local appdir
813         appdir=$($_VSERVER_INFO "$1" APPDIR vshelper)       || return 1
814         test ! -e "$appdir/debug"                           || return 0
815     fi
816
817     return 1
818 }
819
820 function vshelper._getHandlerInternal
821 {
822     local _vghi_var=$1
823     local _vghi_tmp
824     shift
825     shift       ## HACK: see below the note about the 'set -u' mode
826     
827     while test "$#" -ge 2; do
828         local _vghi_mod=$1
829         local _vghi_obj=$2
830         shift 2
831
832         test "$_vghi_mod" "$_vghi_obj" || continue
833         case "$_vghi_mod" in
834             (-x)
835                 eval $_vghi_var=\$_vghi_obj
836                 ;;
837             (-e)
838                 read _vghi_tmp <"$_vghi_obj"
839                 eval $_vghi_var=:\$_vghi_tmp
840                 ;;
841             (*) panic $"Internal error, unexpected modifier '$_vghi_mod'"
842         esac
843         return 0
844     done
845     
846     return 1
847 }
848
849 ## Usage: vshelper.getHandler <result-var> <vserver> <action>
850 function vshelper.getHandler
851 {
852     local _vgh_appdir
853     _vgh_appdir=$($_VSERVER_INFO "$2" APPDIR vshelper) || _vgh_appdir=
854
855     declare -a _vgh_search_list=( X )
856     ## HACK: when we are in 'set -u' mode, empty lists are causing errors
857
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 )
862
863     ! vshelper._getHandlerInternal "$1" "${_vgh_search_list[@]}" || return 0
864     eval $1=':restart'
865 }
866
867 ## Usage: vshelper.init <vserver> [<method> <args>*]
868 function vshelper.doInit
869 {
870     vshelper.isEnabled || return 0
871     
872     local xid
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'"
875         return 1
876     }
877
878     local f="$__VSHELPERSTATEDIR/$xid"
879     
880     set -C
881     $_RM -f "$f"
882     echo "$1" >"$f"
883     set +C
884     
885     if test -n "$2"; then
886         shift 1
887         local i
888         for i; do
889             echo "$i" 
890         done
891     else
892         echo "default"
893     fi >>"$f"
894
895     return 0
896 }
897
898 ## Usage: vshelper.doDestroy <vserver> <xid>
899 function vshelper.doDestroy
900 {
901     vshelper.isEnabled || return 0
902
903     $_RM -f "$__VSHELPERSTATEDIR/$2"
904 }
905
906 ## Usage: vshelper.initSync <vserver> <pipe-varname> [<method>]
907 function vshelper.initSync
908 {
909     local _vis_tmpdir
910     _vis_tmpdir=$($_MKTEMPDIR /tmp/vserver-stop.XXXXXX) || {
911         warning $"Failed to generate temporary directory for vshelper sync"
912         return 1
913     }
914
915     local _vis_fifo="$_vis_tmpdir"/pipe
916     $_MKFIFO -m700 "$_vis_fifo"
917     vshelper.doInit "$1" "${method:-sync}" "$_vis_fifo"
918     eval $2=\$_vis_fifo
919 }
920
921 ## Usage: vshelper.getSyncTimeout <vserver> <varname>
922 function vshelper.getSyncTimeout
923 {
924     local _vgst_appdir _vgst_file _vgst_tmp
925     _vgst_appdir=$($_VSERVER_INFO "$1" APPDIR vshelper) || _vgst_appdir=
926
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"
930     eval $2=\$_vgst_tmp
931 }
932
933
934 function _rpmFake.getCapFlags
935 {
936     local ctx=$1
937     
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 }')
943     else
944         set --
945     fi
946
947     if test -n "$3"; then
948         RPM_FAKE_CAP=$[ ~0x$1 ]
949         RPM_FAKE_FLAGS=$3
950     else
951         RPM_FAKE_CAP=$[ ~0xd40c04ff ]
952         RPM_FAKE_FLAGS=4
953     fi
954 }
955
956 function rpmFake.init
957 {
958     local vdir ctx
959     
960     vdir=$($_VSERVER_INFO "$1" VDIR)    || vdir="$1"
961     ctx=$($_VSERVER_INFO  "$1" CONTEXT) || ctx=
962
963     test -d "$vdir" ||
964         panic $"Can not find chroot environment at '$vdir' for '$1'"
965
966     _rpmFake.getCapFlags "$ctx"
967
968     RPM_FAKE_CHROOT=$vdir
969     RPM_FAKE_CTX=$ctx
970 }
971
972 function rpmFake.exec
973 {
974     export RPM_FAKE_CHROOT RPM_FAKE_CTX RPM_FAKE_CAP RPM_FAKE_FLAGS
975     
976     LD_PRELOAD=$_RPM_FAKE_SO${LD_PRELOAD:+:$LD_PRELOAD} \
977         exec "$@"
978 }