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