c119e802dfc328a394a70403cbfc8e35b0d443d2
[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 mod=$1
28     local var=$2
29     local file=
30     local i=X
31     shift 2
32     
33     for i; do
34         test "$i"        || continue
35         test ! $mod "$i" || { file=$i; break; }
36     done
37
38     test -z "$i" -o "$file" || {
39         echo "Can not find file for '$var'; aborting"
40         exit 1
41     } >&2
42
43     eval "$var=\"$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 "$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 "$_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 "$_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 "$_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 ## Usage: isNumber <arg>
115 function isNumber
116 {
117     local tmp
118     let tmp=$1+0 2>/dev/null || test -z "${1//0/}" -a "$1" || return 1
119     return 0
120 }
121
122 _VS_LOCKS=''
123 ## Usage: lock <lockfile> [<timeout>]
124 function lock
125 {
126     local tmp=$(mktemp /tmp/vserver-lock.XXXXXX)
127     rm -f $tmp
128     mkfifo -m600 $tmp
129
130     $_LOCKFILE "$1" $tmp $2 &
131     grep -q true $tmp 2>/dev/null || return 1
132     
133     _VS_LOCKS="$! $_VS_LOCKS"
134 }
135
136 ## Usage: unlock [<num>]
137 function unlock
138 {
139     local num=$1
140     local i
141
142     set -- $_VS_LOCKS
143     while test "$#" -gt 0; do
144         kill -HUP "$1" >/dev/null || :
145         shift
146         test "$num" != 1 || break
147         test -z "$num"   || let --num
148     done
149     _VS_LOCKS="$@"
150 }
151
152 function _pkgMountBindDir()
153 {
154     test "$1" != "$2" || return 0
155
156     mount -n --bind "$1" "$2"
157 }
158
159 function _pkgSetVarsBase
160 {
161     case "$vserver" in
162         ./*|/*)
163             if test -d "$vserver/vdir"; then
164                 BASEDIR=$vserver
165                 VDIR=$(getPhysicalDir "$vserver/vdir")
166                 
167                 PKGDIR=$BASEDIR/apps/pkgmgmt
168                 test -d "$PKGDIR" || {
169                     echo "Can not find configuration-directory for package-managment tools"
170                     exit 1
171                 } >&2
172                 findDir EXECDIR      $PKGDIR/execdir     /
173             else
174                 VDIR=$(getPhysicalDir "$vserver")
175                 PKGDIR=
176             fi
177             ;;
178         *)
179             BASEDIR=$CONFDIR/$vserver
180             test -d "$BASEDIR" || {
181                 echo "Can not find configuration-directory"
182                 exit 1
183             } >&2
184             
185             VDIR=$BASEDIR/vdir
186             test -d "$VDIR"   || VDIR=$DEFAULT_VSERVERDIR/$vserver
187             VDIR=$(getPhysicalDir "$VDIR")
188             
189             PKGDIR=$BASEDIR/apps/pkgmgmt
190             test -d "$PKGDIR" || {
191                 echo "Can not find configuration-directory for package-managment tools"
192                 exit 1
193             } >&2
194
195             findDir EXECDIR      $PKGDIR/execdir     /
196
197             ;;
198     esac
199
200     if test -z "$WORKAROUND_106057"; then
201         _rpmdb_mntpoint=/dev
202     else
203         _rpmdb_mntpoint=/.rpmdb
204     fi
205 }
206
207 function _pkgSetVarsRPM
208 {
209     if test "$PKGDIR"; then
210         findDir RPMETCDIR    $PKGDIR/rpmetc      $PKGDIR/base/rpm/etc       /etc/rpm
211         findDir RPMSTATEDIR  $PKGDIR/rpmstate    $PKGDIR/base/rpm/state
212
213         findDir RPMLIBDIR    $PKGDIR/rpmlib      /
214
215     else
216         findDir RPMETCDIR    "$VDIR"/etc/rpm     /etc/rpm
217         findDir RPMSTATEDIR  "$VDIR"/var/lib/rpm
218         RPMLIBDIR=/
219     fi
220     
221     RPMSTATEDIR=$(getPhysicalDir "$RPMSTATEDIR")
222     RPMETCDIR=$(getPhysicalDir "$RPMETCDIR")
223 }
224
225 function _pkgSetVarsApt
226 {
227     if test "$PKGDIR"; then
228         findDir APTETCDIR    $PKGDIR/aptetc      $PKGDIR/base/apt/etc       /etc/apt
229         findDir APTSTATEDIR  $PKGDIR/aptstate    $PKGDIR/base/apt/state
230         findDir APTCACHEDIR  $PKGDIR/aptcache    $PKGDIR/base/apt/cache
231         findDir APTARCHIVDIR $PKGDIR/aptarchives $PKGDIR/base/apt/archives  /var/cache/apt/archives
232     else
233         findDir APTETCDIR    "$VDIR"/etc/apt            /etc/apt
234         findDir APTSTATEDIR  "$VDIR"/var/state/apt
235         findDir APTCACHEDIR  "$VDIR"/var/cache/apt
236         findDir APTARCHIVDIR "$VDIR"/var/cache/apt/archives /var/cache/apt/archives
237     fi
238
239     findFile APT_CONFIG "$APTETCDIR"/apt.conf ""
240     test -z "$APT_CONFIG" || export APT_CONFIG
241 }
242
243 function _pkgMountBase
244 {
245     :
246 }
247
248 function _pkgMountApt
249 {
250     :
251 }
252
253 function _pkgMountRPM
254 {
255     _pkgMountBindDir "$RPMETCDIR" /etc/rpm
256     test "$RPMLIBDIR" = "/" || _pkgMountBindDir "$RPMLIBDIR" /usr/lib/rpm
257
258     "$_SECURE_MOUNT" --chroot "$VDIR" -n --secure --bind "$RPMSTATEDIR" "$_rpmdb_mntpoint"
259     test -z "$WORKAROUND_106057" || mount -n --bind "$RPMSTATEDIR" "$_rpmdb_mntpoint"
260
261     test -e "$VDIR"/proc/self/status || \
262         "$_SECURE_MOUNT" --chroot "$VDIR" -n --secure -t proc none /proc
263 }
264
265 function _pkgSetEnvBase
266 {
267     test "$EXECDIR"   = "/" || {
268         PATH=$EXECDIR:$PATH
269         LD_LIBRARY_PATH=$EXECDIR${LD_LIBRARY_PATH:+:$LD_LIBRARY_PATH}
270     }
271
272     export PATH LD_LIBRARY_PATH
273 }
274
275 function _pkgSetEnvApt
276 {
277     :
278 }
279
280 function _pkgSetEnvRPM
281 {
282     CUR_VSERVER=$vserver
283     RPM_FAKE_NAMESPACE_MOUNTS=$_rpmdb_mntpoint
284     RPM_BINARY=$_VRPM_PRELOAD
285
286     export CUR_VSERVER RPM_FAKE_NAMESPACE_MOUNTS RPM_BINARY
287 }
288
289 function pkgInit
290 {
291     local i
292     local vserver=$1
293     shift
294     
295     _pkgSetVarsBase
296     for i; do
297         case "$i" in
298             rpm)        _pkgSetVarsRPM;;
299             apt)        _pkgSetVarsApt;;
300             *)          echo "Unknown packaging flavor" >&2; exit 1;;
301         esac
302     done
303
304     _pkgMountBase
305     for i; do
306         case "$i" in
307             rpm)        _pkgMountRPM;;
308             apt)        _pkgMountApt;;
309         esac
310     done
311
312     _pkgSetEnvBase
313     for i; do
314         case "$i" in
315             rpm)        _pkgSetEnvRPM;;
316             apt)        _pkgSetEnvApt;;
317         esac
318     done
319
320     _PKG_FLAVORS="$@"
321     _PKG_VSERVER=$vserver
322 }
323
324 function isAvoidNamespace
325 {
326     local cfgdir
327
328     $_VSERVER_INFO - FEATURE namespace   || return 0
329     cfgdir=$($_VSERVER_INFO "$1" CFGDIR) || return 0
330     test ! -e "$cfgdir"/namespace        || return 1
331     test -e "$CONFDIR"/.defaults/nonamespace -o \
332          -e "$cfgdir"/nonamespace
333 }
334
335 function getAllVservers
336 {
337     local i
338     declare -a _tmp=()
339
340     for i in $CONFDIR/*; do
341         test   -d "$i"          || continue
342         test ! -e "$i"/disabled || continue
343         test   -d "$i"/vdir     || continue
344         case "$i" in
345             *.~*~) continue;;
346         esac
347
348         _tmp=( "${_tmp[@]}" "${i##$CONFDIR/}")
349     done
350
351     eval $1='( "${_tmp[@]}" )'
352 }
353
354 ## Usage: getVserverCtx <vdir> <result-varname> [<procnumber-varname> [<do-cleanup>]]
355 ## Returns: 0 iff vserver is running
356 function getVserverStatus
357 {
358     test -r "$1"/run || return 1
359
360     local _ctx
361     read _ctx <"$1"/run
362     eval "$2"=\$_ctx
363
364     test "$3"        || return 0
365     local _tmp=$($_VPS ax | $_AWK '{print $2}' | $_GREP -x "$_ctx" | $_WC -l )
366     let _tmp=_tmp+0
367     eval "$3"=\$_tmp
368
369     if test "$_tmp" = 0; then
370         local runfile=$($_READLINK "$1/run")
371         test -z "$4" || rm -f "$runfile"
372         return 1
373     fi
374
375     return 0
376 }
377
378 ## Usage: isCtxRunning <ctx>
379 function isCtxRunning
380 {
381     local _tmp=$($_VPS ax | $_AWK '{print $2}' | $_GREP -x "$1" | $_WC -l )
382     test $_tmp -gt 0
383 }
384
385 ## Usage: isVserverRunning <vdir> [<ctx-varname>]
386 function isVserverRunning
387 {
388     local ctx procnum
389
390     getVserverStatus "$1" ctx procnum 1 || return 1
391     test $procnum != 0                  || return 1
392     test -z "$2" || eval "$2"=\$ctx
393     return 0
394 }
395
396 ## Called as 'getFileValue <varname> <filename>'
397 function getFileValue
398 {
399     test -r "$2" || return 0
400     eval read "$1" <"$2"
401 }
402
403 ## Called as 'getFileArray <varname> <filename>'
404 function getFileArray
405 {
406     test -r "$2" || return 1
407     
408     local IFS=$_VS_NEWLINE
409     eval "$1"='( $(< "$2") )'
410 }
411
412 function checkComponents
413 {
414     local       i
415     local       msg=$1
416     local       x_failed=
417
418     shift
419     
420     for i; do
421         local failed=
422         case "$i" in
423             core)       test -x "$_CHBIND"           || failed=1;;
424             build)      test -x "$_VSERVER_BUILD"    || failed=1;;
425             sysv)       test -x "$INITRDDIR/vserver" || failed=1;;
426             devel)      test -d "$INCLUDEDIR/vserver.h" || failed=1;;
427             *)          echo "Unknown component '$i'" >&2
428                         return false
429                         ;;
430         esac
431
432         test -z "$failed" || {
433             echo "$msg: $i"
434             x_failed=1
435         } >&2
436     done
437
438     test -z "$x_failed"
439 }
440
441 ## Usage: isKernelAPI <ver> [<cmp-modifier>]
442 function isKernelAPI
443 {
444     local api=$($_VSERVER_INFO - APIVER) || api=0
445     test $[ $api ] -${2:-ge} $[ $1 ]
446 }
447
448 ## Usage: callInNamespace <vserver> <command> <args>*
449 function callInNamespace
450 {
451     local ctx=
452     
453     isAvoidNamespace "$1" || \
454     ctx=$( $_VSERVER_INFO "$1" CONTEXT f ) || ctx=
455
456     shift
457     if test "$ctx"; then
458         $_VNAMESPACE --enter "$ctx" -- "$@"
459     else
460         "$@"
461     fi
462 }
463
464 ## Usage: pkgmgmt.guessStyle <vserver> <resultvar>
465 function pkgmgmt.guessStyle()
466 {
467     local vdir=$($_VSERVER_INFO "$1" VDIR) || {
468         echo $"Can not determine vserver-root" >&2
469         return 1
470     }
471     local cfgdir=$($_VSERVER_INFO "$1" APPDIR pkgmgmt) || :
472
473     if test "$cfgdir" -a -e "$cfgdir"/style; then
474         read style <"$cfgdir"/style
475     elif test -e "$vdir"/etc/redhat-release -o -e "$vdir"/etc/fedora-release; then
476         style=redhat
477     elif test -e "$vdir"/etc/mandrake-release; then
478         style=mandrake
479     elif test -e "$vdir"/etc/debian_version; then
480         style=debian
481     elif test -e "$vdir"/etc/SuSE-release; then
482         style=suse
483     else
484         echo $"Can not determine packagemanagement style" >&2
485         return 1
486     fi
487
488     eval $2=\$style
489     return 0
490 }
491
492 ## Usage: pkgmgmt.isInternal <vserver>
493 ## returns true iff <vserver> is configured for internal packagemanagement
494 ## A typical application is
495 ## | is_external=
496 ## | pkgmgmt.isInternal "$vserver" || is_external=1
497 function pkgmgmt.isInternal
498 {
499     local cfgdir=$($_VSERVER_INFO "$1" APPDIR pkgmgmt) || :
500
501     test -z "$cfgdir" -o ! -d "$cfgdir" -o -e "$cfgdir"/internal
502 }
503
504 ## Usage: pkgmgmt.isAptAvailable <cfgdir> <vdir> [<is-internal>]
505 function pkgmgmt.isAptAvailable
506 {
507     local cfgdir="$1"
508     local vdir="$2"
509     local is_internal="$3"
510     
511     local have_apt i
512     if test "$is_internal"; then
513         have_apt=1
514         test -d "$cfgdir"/base/apt -o -d "$cfgdir"/aptetc || have_apt=
515     else
516         have_apt=
517         for i in /bin /usr/bin /usr/local/bin; do
518             test ! -x "$vdir$i"/apt-get || { have_apt=1; break; }
519         done
520     fi
521
522     test "$have_apt" && return 0 || return 1
523 }
524
525 function vshelper.doSanityCheck
526 {
527     local vshelper this_xid i
528     declare -a warnings=()
529     local solution_disable=
530     local solution_sysctl=
531
532     vshelper.isEnabled && vshelper.isEnabled warning || return 0
533     
534     this_xid=$($_VSERVER_INFO - XID) ||
535         panic $"Failed to determine current context; aborting..."
536
537     ## Do nothing in other xid's; the helper will be executed in xid 0 only
538     test "$this_xid" = 0 || return 0
539
540     local proc_file=/proc/sys/kernel/vshelper
541
542     if ! test -r "$proc_file"; then
543         vshelper=
544         warnings=( "${warnings[@]}"
545                    $"File '$proc_file' does not exists but is required for vshelper setup" )
546         solution_disable=1
547     else
548         vshelper=$(cat "$proc_file")
549
550         cmp -s "$vshelper" "$_VSHELPER" || {
551             warnings=( "${warnings[@]}"
552                        $"The configured vshelper '$vshelper' does not match the 'vshelper'
553   script of the util-vserver package"
554                      )
555             solution_disable=1
556             solution_sysctl=1
557         }
558     fi
559
560     test -d "$VSHELPERSTATEDIR" || {
561         warnings=( "${warnings[@]}"
562                    $"\
563 The vshelper state-directory '$VSHELPERSTATEDIR' does not exist; since
564 it is created by 'make install', this indicates a serious problem with
565 your util-vserver installation" )
566         solution_disable=1
567     }
568
569     test "${#warnings[@]}" -eq 0 || {
570         warning $"\
571 The following problem(s) were encountered while verifying vshelper
572 functionality:"
573
574         for i in "${warnings[@]}"; do
575             warning "* $i"
576         done
577
578         warning $"\
579         
580 To fix this, you can:"
581
582         test -z "$solution_disable" || warning $"\
583 * disable vshelper entirely by executing
584   | touch \"$CONFDIR/.defaults/apps/vshelper/disabled\"
585 * disable only this message by executing
586   | touch \"$CONFDIR/.defaults/apps/vshelper/warning-disabled\""
587
588         test -x "$solution_sysctl" || warning $"\
589 * configure the util-vserver vshelper script, e.g. by adding
590   | kernel.vshelper = \"$_VSHELPER\"
591   to /etc/sysctl.conf and rebooting the machine, or by executing
592   | echo \"$_VSHELPER\" >$proc_file"
593
594         warning ""
595
596         return 1
597     }
598
599     return 0
600 }
601
602 ## Usage: vshelper.isEnabled [<style>] [<vserver>]
603 function vshelper.isEnabled
604 {
605     local f=${1:+$1-}disabled
606     test ! -e "$CONFDIR"/.defaults/apps/vshelper/"$f"       || return 1
607     $_VSERVER_INFO - FEATURE vshelper                       || return 1
608     if test "$2"; then
609         local appdir=$($_VSERVER_INFO "$2" APPDIR vshelper) || return 0
610         test -z "$2" -o ! -e "$appdir/$f"                   || return 1
611     fi
612
613     return 0
614 }
615
616 function vshelper._getHandlerInternal
617 {
618     local var=$1
619     local tmp
620     shift
621     shift       ## HACK: see below the note about the 'set -u' mode
622     
623     while test "$#" -ge 2; do
624         local mod=$1
625         local obj=$2
626         shift 2
627
628         test "$mod" "$obj" || continue
629         case "$mod" in
630             (-x)
631                 eval $var=\$obj
632                 ;;
633             (-e)
634                 read tmp <"$obj"
635                 eval $var=:\$tmp
636                 ;;
637             (*) panic $"Internal error, unexpected modifier '$mod'"
638         esac
639         return 0
640     done
641     
642     return 1
643 }
644
645 ## Usage: vshelper.getHandler <result-var> <vserver> <action>
646 function vshelper.getHandler
647 {
648     local appdir=$($_VSERVER_INFO "$2" APPDIR vshelper) || appdir=
649     local script
650     declare -a search_list=( X )
651     ## HACK: when we are in 'set -u' mode, empty lists are causing errors
652
653     test -z "$appdir" || search_list=( "${search_list[@]}" -x "$appdir/$3" )
654     test -z "$appdir" || search_list=( "${search_list[@]}" -e "$appdir/action" )
655     search_list=( "${search_list[@]}" -x "$CONFDIR"/.defaults/apps/vshelper/"$3" )
656     search_list=( "${search_list[@]}" -e "$CONFDIR"/.defaults/apps/vshelper/action )
657
658     ! vshelper._getHandlerInternal "$1" "${search_list[@]}" || return 0
659     eval $1=':restart'
660 }
661
662 ## Usage: vshelper.init <vserver> [<method> <args>*]
663 function vshelper.doInit
664 {
665     vshelper.isEnabled || return 0
666     
667     local xid=$($_VSERVER_INFO "$1" CONTEXT false) && test "$xid" || {
668         warning $"vshelper.init: can not determine xid of vserver '$vserver'; returned value was '$xid'"
669         return 1
670     }
671
672     local f="$VSHELPERSTATEDIR/$xid"
673     
674     set -C
675     rm -f "$f"
676     echo "$1" >"$f"
677     set +C
678     
679     if test "$2"; then
680         shift 1
681         local i
682         for i; do
683             echo "$i" 
684         done
685     else
686         echo "default"
687     fi >>"$f"
688
689     return 0
690 }
691
692 ## Usage: vshelper.doDestroy <vserver> <xid>
693 function vshelper.doDestroy
694 {
695     vshelper.isEnabled || return 0
696
697     rm -f "$VSHELPERSTATEDIR/$2"
698 }
699
700 ## Usage: vshelper.initSync <vserver> <pipe-varname>
701 function vshelper.initSync
702 {
703     local tmpdir=$(mktemp -d /tmp/vserver-stop.XXXXXX) || {
704         warning $"Failed to generate temporary directory for vshelper sync"
705         return 1
706     }
707
708     local fifo="$tmpdir"/pipe
709     mkfifo -m700 "$fifo"
710     vshelper.doInit "$VSERVER_DIR" sync "$fifo"
711     eval $2=\$fifo
712 }
713
714 ## Usage: vshelper.getSyncTimeout <vserver> <varname>
715 function vshelper.getSyncTimeout
716 {
717     local appdir=$($_VSERVER_INFO "$1" APPDIR vshelper) || appdir=
718     local file tmp
719
720     findFile file ${appdir:+"$appdir"/sync-timeout} "$CONFDIR"/.defaults/apps/vshelper/sync-timeout ''
721     test "$file" || return 1
722     read tmp <"$file"
723     eval $2=\$tmp
724 }