use new vc_set_sched structure
[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     pushd "$VDIR" >/dev/null
295
296     "$_SECURE_MOUNT" --chroot -n --bind "$RPMSTATEDIR" "$_rpmdb_mntpoint"
297     test -z "$WORKAROUND_106057" || mount -n --bind "$RPMSTATEDIR" "$_rpmdb_mntpoint"
298
299     test -e "$VDIR"/proc/self/status || \
300         "$_SECURE_MOUNT" --chroot -n -t proc none /proc
301
302     popd >/dev/null
303 }
304
305 function _pkgSetEnvBase
306 {
307     test "$EXECDIR"   = "/" || {
308         PATH=$EXECDIR:$PATH
309         LD_LIBRARY_PATH=$EXECDIR${LD_LIBRARY_PATH:+:$LD_LIBRARY_PATH}
310     }
311
312     export PATH LD_LIBRARY_PATH
313 }
314
315 function _pkgSetEnvApt
316 {
317     :
318 }
319
320 function _pkgSetEnvRPM
321 {
322     CUR_VSERVER=$vserver
323     RPM_FAKE_NAMESPACE_MOUNTS=$_rpmdb_mntpoint
324     RPM_BINARY=$_VRPM_PRELOAD
325
326     export CUR_VSERVER RPM_FAKE_NAMESPACE_MOUNTS RPM_BINARY
327 }
328
329 function pkgInit
330 {
331     local i
332     local vserver=$1
333     shift
334     
335     _pkgSetVarsBase
336     for i; do
337         case "$i" in
338             rpm)        _pkgSetVarsRPM;;
339             apt)        _pkgSetVarsApt;;
340             *)          echo "Unknown packaging flavor" >&2; exit 1;;
341         esac
342     done
343
344     _pkgMountBase
345     for i; do
346         case "$i" in
347             rpm)        _pkgMountRPM;;
348             apt)        _pkgMountApt;;
349         esac
350     done
351
352     _pkgSetEnvBase
353     for i; do
354         case "$i" in
355             rpm)        _pkgSetEnvRPM;;
356             apt)        _pkgSetEnvApt;;
357         esac
358     done
359
360     _PKG_FLAVORS="$@"
361     _PKG_VSERVER=$vserver
362 }
363
364 function isAvoidNamespace
365 {
366     local cfgdir
367
368     $_VSERVER_INFO - FEATURE namespace   || return 0
369     cfgdir=$($_VSERVER_INFO "$1" CFGDIR) || return 0
370     test ! -e "$cfgdir"/namespace        || return 1
371     test -e "$CONFDIR"/.defaults/nonamespace -o \
372          -e "$cfgdir"/nonamespace
373 }
374
375 function getAllVservers
376 {
377     local i
378     declare -a _tmp=()
379
380     for i in $CONFDIR/*; do
381         test   -d "$i"          || continue
382         test ! -e "$i"/disabled || continue
383         test   -d "$i"/vdir     || continue
384         case "$i" in
385             *.~*~) continue;;
386         esac
387
388         _tmp=( "${_tmp[@]}" "${i##$CONFDIR/}")
389     done
390
391     eval $1='( "${_tmp[@]}" )'
392 }
393
394 ## Usage: getVserverCtx <vdir> <result-varname> [<procnumber-varname> [<do-cleanup>]]
395 ## Returns: 0 iff vserver is running
396 function getVserverStatus
397 {
398     test -r "$1"/run || return 1
399
400     local _ctx
401     read _ctx <"$1"/run
402     eval "$2"=\$_ctx
403
404     test "$3"        || return 0
405     local _tmp=$($_VPS ax | $_AWK '{print $2}' | $_GREP -x "$_ctx" | $_WC -l )
406     let _tmp=_tmp+0
407     eval "$3"=\$_tmp
408
409     if test "$_tmp" = 0; then
410         local runfile=$($_READLINK "$1/run")
411         test -z "$4" || rm -f "$runfile"
412         return 1
413     fi
414
415     return 0
416 }
417
418 ## Usage: isCtxRunning <ctx>
419 function isCtxRunning
420 {
421     local _tmp=$($_VPS ax | $_AWK '{print $2}' | $_GREP -x "$1" | $_WC -l )
422     test $_tmp -gt 0
423 }
424
425 ## Usage: isVserverRunning <vdir> [<ctx-varname>]
426 function isVserverRunning
427 {
428     local ctx procnum
429
430     getVserverStatus "$1" ctx procnum 1 || return 1
431     test $procnum != 0                  || return 1
432     test -z "$2" || eval "$2"=\$ctx
433     return 0
434 }
435
436 ## Called as 'getFileValue <varname> <filename>'
437 function getFileValue
438 {
439     test -r "$2" || return 0
440     eval read "$1" <"$2"
441 }
442
443 ## Called as 'getFileArray <varname> <filename>'
444 function getFileArray
445 {
446     test -r "$2" || return 1
447     
448     local IFS=$_VS_NEWLINE
449     eval "$1"='( $(< "$2") )'
450 }
451
452 function checkComponents
453 {
454     local       i
455     local       msg=$1
456     local       x_failed=
457
458     shift
459     
460     for i; do
461         local failed=
462         case "$i" in
463             core)       test -x "$_CHBIND"           || failed=1;;
464             build)      test -x "$_VSERVER_BUILD"    || failed=1;;
465             sysv)       test -x "$INITRDDIR/vserver" || failed=1;;
466             devel)      test -d "$INCLUDEDIR/vserver.h" || failed=1;;
467             *)          echo "Unknown component '$i'" >&2
468                         return false
469                         ;;
470         esac
471
472         test -z "$failed" || {
473             echo "$msg: $i"
474             x_failed=1
475         } >&2
476     done
477
478     test -z "$x_failed"
479 }
480
481 ## Usage: isKernelAPI <ver> [<cmp-modifier>]
482 function isKernelAPI
483 {
484     local api=$($_VSERVER_INFO - APIVER) || api=0
485     test $[ $api ] -${2:-ge} $[ $1 ]
486 }
487
488 ## Usage: callInNamespace <vserver> <command> <args>*
489 function callInNamespace
490 {
491     local ctx=
492     
493     isAvoidNamespace "$1" || \
494     ctx=$( $_VSERVER_INFO "$1" CONTEXT f ) || ctx=
495
496     shift
497     if test "$ctx"; then
498         $_VNAMESPACE --enter "$ctx" -- "$@"
499     else
500         "$@"
501     fi
502 }
503
504 ## Usage: setDefaultTTY <vdir> [<fallback-tty>]
505 function setDefaultTTY
506 {
507     local cfgdir ttyname
508
509     cfgdir=$($_VSERVER_INFO "$1" APPDIR init) || cfgdir=
510     findObject -e ttyname \
511         ${cfgdir:+"$cfgdir"/tty} \
512         "$CONFDIR/.defaults/apps/init/tty" \
513         $2 /dev/null
514
515     exec   <$ttyname
516     exec  &>$ttyname
517 }
518
519 ## Usage: pkgmgmt.guessStyle <vserver> <resultvar>
520 function pkgmgmt.guessStyle()
521 {
522     local vdir=$($_VSERVER_INFO "$1" VDIR) || {
523         echo $"Can not determine vserver-root" >&2
524         return 1
525     }
526     local cfgdir=$($_VSERVER_INFO "$1" APPDIR pkgmgmt) || :
527
528     if test "$cfgdir" -a -e "$cfgdir"/style; then
529         read style <"$cfgdir"/style
530     elif test -e "$vdir"/etc/redhat-release -o -e "$vdir"/etc/fedora-release; then
531         style=redhat
532     elif test -e "$vdir"/etc/mandrake-release; then
533         style=mandrake
534     elif test -e "$vdir"/etc/debian_version; then
535         style=debian
536     elif test -e "$vdir"/etc/SuSE-release; then
537         style=suse
538     else
539         echo $"Can not determine packagemanagement style" >&2
540         return 1
541     fi
542
543     eval $2=\$style
544     return 0
545 }
546
547 ## Usage: pkgmgmt.isInternal <vserver>
548 ## returns true iff <vserver> is configured for internal packagemanagement
549 ## A typical application is
550 ## | is_external=
551 ## | pkgmgmt.isInternal "$vserver" || is_external=1
552 function pkgmgmt.isInternal
553 {
554     local cfgdir=$($_VSERVER_INFO "$1" APPDIR pkgmgmt) || :
555
556     test -z "$cfgdir" -o ! -d "$cfgdir" -o -e "$cfgdir"/internal
557 }
558
559 ## Usage: pkgmgmt.isAptAvailable <cfgdir> <vdir> [<is-internal>]
560 function pkgmgmt.isAptAvailable
561 {
562     local cfgdir="$1"
563     local vdir="$2"
564     local is_internal="$3"
565     
566     local have_apt i
567     if test "$is_internal"; then
568         have_apt=1
569         test -d "$cfgdir"/base/apt -o -d "$cfgdir"/aptetc || have_apt=
570     else
571         have_apt=
572         for i in /bin /usr/bin /usr/local/bin; do
573             test ! -x "$vdir$i"/apt-get || { have_apt=1; break; }
574         done
575     fi
576
577     test "$have_apt" && return 0 || return 1
578 }
579
580 function vshelper.doSanityCheck
581 {
582     local vshelper this_xid i
583     declare -a warnings=()
584     local solution_disable=
585     local solution_sysctl=
586
587     vshelper.isEnabled && vshelper.isEnabled warning || return 0
588     
589     this_xid=$($_VSERVER_INFO - XID) ||
590         panic $"Failed to determine current context; aborting..."
591
592     ## Do nothing in other xid's; the helper will be executed in xid 0 only
593     test "$this_xid" = 0 || return 0
594
595     local proc_file=/proc/sys/kernel/vshelper
596
597     if ! test -r "$proc_file"; then
598         vshelper=
599         warnings=( "${warnings[@]}"
600                    $"File '$proc_file' does not exists but is required for vshelper setup" )
601         solution_disable=1
602     else
603         vshelper=$(cat "$proc_file")
604
605         cmp -s "$vshelper" "$_VSHELPER" || {
606             warnings=( "${warnings[@]}"
607                        $"The configured vshelper '$vshelper' does not match the 'vshelper'
608   script of the util-vserver package"
609                      )
610             solution_disable=1
611             solution_sysctl=1
612         }
613     fi
614
615     test -d "$VSHELPERSTATEDIR" || {
616         warnings=( "${warnings[@]}"
617                    $"\
618 The vshelper state-directory '$VSHELPERSTATEDIR' does not exist; since
619 it is created by 'make install', this indicates a serious problem with
620 your util-vserver installation" )
621         solution_disable=1
622     }
623
624     test "${#warnings[@]}" -eq 0 || {
625         warning $"\
626 The following problem(s) were encountered while verifying vshelper
627 functionality:"
628
629         for i in "${warnings[@]}"; do
630             warning "* $i"
631         done
632
633         warning $"\
634         
635 To fix this, you can:"
636
637         test -z "$solution_disable" || warning $"\
638 * disable vshelper entirely by executing
639   | touch \"$CONFDIR/.defaults/apps/vshelper/disabled\"
640 * disable only this message by executing
641   | touch \"$CONFDIR/.defaults/apps/vshelper/warning-disabled\""
642
643         test -x "$solution_sysctl" || warning $"\
644 * configure the util-vserver vshelper script, e.g. by adding
645   | kernel.vshelper = \"$_VSHELPER\"
646   to /etc/sysctl.conf and rebooting the machine, or by executing
647   | echo \"$_VSHELPER\" >$proc_file"
648
649         warning ""
650
651         return 1
652     }
653
654     return 0
655 }
656
657 ## Usage: vshelper.isEnabled [<style>] [<vserver>]
658 function vshelper.isEnabled
659 {
660     local f=${1:+$1-}disabled
661     test ! -e "$CONFDIR"/.defaults/apps/vshelper/"$f"       || return 1
662     $_VSERVER_INFO - FEATURE vshelper                       || return 1
663     if test "$2"; then
664         local appdir=$($_VSERVER_INFO "$2" APPDIR vshelper) || return 0
665         test -z "$2" -o ! -e "$appdir/$f"                   || return 1
666     fi
667
668     return 0
669 }
670
671 function vshelper._getHandlerInternal
672 {
673     local var=$1
674     local tmp
675     shift
676     shift       ## HACK: see below the note about the 'set -u' mode
677     
678     while test "$#" -ge 2; do
679         local mod=$1
680         local obj=$2
681         shift 2
682
683         test "$mod" "$obj" || continue
684         case "$mod" in
685             (-x)
686                 eval $var=\$obj
687                 ;;
688             (-e)
689                 read tmp <"$obj"
690                 eval $var=:\$tmp
691                 ;;
692             (*) panic $"Internal error, unexpected modifier '$mod'"
693         esac
694         return 0
695     done
696     
697     return 1
698 }
699
700 ## Usage: vshelper.getHandler <result-var> <vserver> <action>
701 function vshelper.getHandler
702 {
703     local appdir=$($_VSERVER_INFO "$2" APPDIR vshelper) || appdir=
704     local script
705     declare -a search_list=( X )
706     ## HACK: when we are in 'set -u' mode, empty lists are causing errors
707
708     test -z "$appdir" || search_list=( "${search_list[@]}" -x "$appdir/$3" )
709     test -z "$appdir" || search_list=( "${search_list[@]}" -e "$appdir/action" )
710     search_list=( "${search_list[@]}" -x "$CONFDIR"/.defaults/apps/vshelper/"$3" )
711     search_list=( "${search_list[@]}" -e "$CONFDIR"/.defaults/apps/vshelper/action )
712
713     ! vshelper._getHandlerInternal "$1" "${search_list[@]}" || return 0
714     eval $1=':restart'
715 }
716
717 ## Usage: vshelper.init <vserver> [<method> <args>*]
718 function vshelper.doInit
719 {
720     vshelper.isEnabled || return 0
721     
722     local xid=$($_VSERVER_INFO "$1" CONTEXT false) && test "$xid" || {
723         warning $"vshelper.init: can not determine xid of vserver '$vserver'; returned value was '$xid'"
724         return 1
725     }
726
727     local f="$VSHELPERSTATEDIR/$xid"
728     
729     set -C
730     rm -f "$f"
731     echo "$1" >"$f"
732     set +C
733     
734     if test "$2"; then
735         shift 1
736         local i
737         for i; do
738             echo "$i" 
739         done
740     else
741         echo "default"
742     fi >>"$f"
743
744     return 0
745 }
746
747 ## Usage: vshelper.doDestroy <vserver> <xid>
748 function vshelper.doDestroy
749 {
750     vshelper.isEnabled || return 0
751
752     rm -f "$VSHELPERSTATEDIR/$2"
753 }
754
755 ## Usage: vshelper.initSync <vserver> <pipe-varname>
756 function vshelper.initSync
757 {
758     local tmpdir=$(mktemp -d /tmp/vserver-stop.XXXXXX) || {
759         warning $"Failed to generate temporary directory for vshelper sync"
760         return 1
761     }
762
763     local fifo="$tmpdir"/pipe
764     mkfifo -m700 "$fifo"
765     vshelper.doInit "$1" sync "$fifo"
766     eval $2=\$fifo
767 }
768
769 ## Usage: vshelper.getSyncTimeout <vserver> <varname>
770 function vshelper.getSyncTimeout
771 {
772     local appdir=$($_VSERVER_INFO "$1" APPDIR vshelper) || appdir=
773     local file tmp
774
775     findFile file ${appdir:+"$appdir"/sync-timeout} "$CONFDIR"/.defaults/apps/vshelper/sync-timeout ''
776     test "$file" || return 1
777     read tmp <"$file"
778     eval $2=\$tmp
779 }