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