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