handle fakeinit separately
[util-vserver.git] / util-vserver / scripts / vserver.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 ## Expected env:
19 #  $VSERVER_DIR   ... path to vserver-cfg dir
20 #  $VSERVER_NAME  ... name of vserver
21
22 declare -a NICE_CMD=()
23 declare -a CHBIND_OPTS=()
24 declare -a CAP_OPTS=()
25 declare -a CHCONTEXT_INIT_OPTS=()
26 declare -a CHCONTEXT_FLAG_OPTS=()
27 declare -a CHCONTEXT_OPTS=()
28 declare -a CAPCHROOT_OPTS=()
29 declare -a INTERFACES=()
30
31 declare -a INITCMD_START=()
32 declare -a INITCMD_START_SYNC=()
33 declare -a INITCMD_STOP=()
34 declare -a INITCMD_STOP_SYNC=()
35 declare -a INITCMD_PREPARE=()
36 declare -a INITKILL_SEQ=()
37 declare -a ENTER_SHELL=()
38
39 declare -a OPTS_VCONTEXT_CREATE=()
40 declare -a OPTS_VCONTEXT_MIGRATE=()
41 declare -a OPTS_VATTRIBUTE=()
42 USE_VNAMESPACE=
43
44 INTERFACE_CMDS_IDX=0
45 _HAVE_INTERFACE_OPTIONS=
46 _HAVE_CHBIND_OPTIONS=
47 _IS_FAKEINIT=
48
49 INITSTYLE=sysv
50
51 S_CONTEXT=
52
53 SILENT_OPT=
54
55 : ${VSERVER_NAME:=$(basename "$VSERVER_DIR")}
56
57 if test -e "$VSERVER_DIR"/noisy -o "$OPTION_VERBOSE"; then
58     SILENT_OPT=
59 else
60     SILENT_OPT='--silent'
61 fi
62
63 function _generateChbindOptions
64 {
65     local vdir="$1"
66     local i
67     local bcast=
68
69     test "$_HAVE_INTERFACE_OPTIONS" || _generateInterfaceOptions "$vdir"
70
71     local f=$vdir/interfaces/bcast
72     getFileValue bcast "$f"
73     
74     CHBIND_OPTS=( $SILENT_OPT ${bcast:+--bcast "$bcast"} )
75
76     for i in "${INTERFACES[@]}"; do
77         CHBIND_OPTS=( "${CHBIND_OPTS[@]}" --ip "$i" )
78     done
79
80     _HAVE_CHBIND_OPTIONS=1
81 }
82
83 function _generateNiceCommand
84 {
85     local vdir=$1
86     local nice
87
88     test -r "$vdir/nice" || return 0;
89     read nice <"$vdir"/nice
90
91     NICE_CMD=( $_NICE -$nice )
92 }
93
94 function _generateCCapabilityOptions
95 {
96     local vdir=$1
97     local cap
98     local f="$vdir"/ccapabilities
99     
100     test -e "$f" || return 0
101     while read cap; do
102         case x"$cap" in
103             (x|x\#)     ;;
104             (*)         OPTS_VATTRIBUTE=( "${OPTS_VATTRIBUTE[@]}" --ccap "$cap" );;
105         esac
106     done <"$f"
107 }
108
109 function _generateBCapabilityOptions
110 {
111     local vdir=$1
112     local cap
113     local f="$vdir"/bcapabilities
114     
115     test -e "$f" || return 0
116     while read cap; do
117         case x"$cap" in
118             (x|x\#)     ;;
119             (*)         OPTS_VATTRIBUTE=( "${OPTS_VATTRIBUTE[@]}" --bcap "$cap" );;
120         esac
121     done <"$f"
122 }
123
124 function _generateCapabilityOptions
125 {
126     local vdir=$1
127     local cap
128
129     _generateBCapabilityOptions "$vdir"
130     _generateCCapabilityOptions "$vdir"
131     
132     test -e "$vdir"/capabilities || return 0
133
134     CAP_OPTS=()
135     CAPCHROOT_OPTS=()
136
137     while read cap; do
138         case x"$cap" in
139             (x|x\#)     ;;
140             (!CAP_SYSCHROOT)
141                 CAP_OPTS=( "${CAP_OPTS[@]}" --cap "$cap" )
142                 CAPCHROOT_OPTS=( "${CAPCHROOT_OPTS[@]}" --nochroot )
143                 ;;
144             (*)
145                 CAP_OPTS=( "${CAP_OPTS[@]}" --cap "$cap" )
146                 ;;
147         esac
148     done <"$vdir"/capabilities
149 }
150
151 function getEnterShell
152 {
153     local vdir=$1
154
155     ENTER_SHELL=()
156     
157     getFileValue ENTER_SHELL     "$vdir"/shell
158     
159     test "$ENTER_SHELL" || {
160         local i
161         for i in "/bin/bash -login" "/bin/sh -l" /bin/csh; do
162             set -- $i
163             test -x "$vdir/vdir/$1" || continue
164             ENTER_SHELL=( "$@" )
165             break
166         done
167     }
168 }
169
170 ## Usage: sendKillSequence <ctx> <signal> [<wait> <signal>]*
171 function sendKillSequence
172 {
173     local ctx=$1
174     local wait=
175     shift
176
177     while isCtxRunning "$ctx"; do
178         test -z "$wait" || sleep "$wait"
179         
180         $_VKILL -c "$ctx" ${1:+-s "$1"}
181         test "$2" || break
182         wait="$2"
183         shift 2
184     done
185 }
186
187 function _generateInitOptions
188 {
189     local vdir=$1
190     local cfgdir=$vdir/apps/init
191     local runlevel_start
192     local runlevel_stop
193     local i f
194
195     INITCMD_START=()
196     INITCMD_STOP=()
197     INITCMD_START_SYNC=()
198     INITCMD_STOP_SYNC=()
199     INITCMD_PREPARE=()
200
201     INITKILL_SEQ=( 15 5 9 )
202     CHCONTEXT_INIT_OPTS=()
203
204
205     getFileValue INITSTYLE      "$cfgdir"/style
206     getFileValue runlevel_start "$cfgdir"/runlevel
207     getFileValue runlevel_start "$cfgdir"/runlevel.start
208     getFileValue runlevel_stop  "$cfgdir"/runlevel.stop
209     getFileArray INITKILL_SEQ   "$cfgdir"/killseq
210
211     case x"$INITSTYLE" in
212         (xsysv)
213             test "$runlevel_start" || runlevel_start=3
214             test "$runlevel_stop"  || runlevel_stop=6
215
216             for i in /etc/init.d/rc /etc/rc.d/rc; do
217                 test -x "$vdir/vdir/$i" || continue
218                 INITCMD_START=( "$i" "$runlevel_start" )
219                 INITCMD_STOP=(  "$i" "$runlevel_stop"  )
220             done
221             INITCMD_PREPARE=( $_FAKE_RUNLEVEL "$runlevel_start" /var/run/utmp )
222             ;;
223             
224         (xplain)
225             INITCMD_START=( /sbin/init )
226             INITCMD_STOP=(  /sbin/init )
227             _IS_FAKEINIT=1
228             test -z "$runlevel_start" || INITCMD_START=( "${INITCMD_START[@]}" "$runlevel_start" )
229             test -z "$runlevel_stop"  || INITCMD_STOP=(  "${INITCMD_STOP[@]}"  "$runlevel_stop"  )
230             ;;
231             
232         (xminit)
233             INITCMD_START=( /sbin/minit-start )
234             INITCMD_STOP=(  /sbin/minit-stop  )
235             _IS_FAKEINIT=1
236             INITCMD_START_SYNC=( "$_INITSYNC_MINIT_START" "$vdir" )
237             INITCMD_STOP_SYNC=(  "$_INITSYNC_MINIT_STOP"  "$vdir" )
238             test -z "$runlevel_start" || INITCMD_START=( "${INITCMD_START[@]}" "$runlevel_start" )
239             test -z "$runlevel_stop"  || INITCMD_STOP=(  "${INITCMD_STOP[@]}"  "$runlevel_stop"  )
240             ;;
241
242         (xgentoo)
243             INITCMD_START=( /sbin/rc default  )
244             INITCMD_STOP=(  /sbin/rc shutdown )
245             ;;
246
247         (x) ;;
248         (*) echo "Unknown init-style '$INITSTYLE'; aborting" >&2;
249             exit 1;;
250     esac
251
252     getFileArray INITCMD_START      "$cfgdir"/cmd.start
253     getFileArray INITCMD_STOP       "$cfgdir"/cmd.stop
254     getFileArray INITCMD_START_SYNC "$cfgdir"/cmd.start-sync
255     getFileArray INITCMD_STOP_SYNC  "$cfgdir"/cmd.stop-sync
256     getFileArray INITCMD_PREPARE    "$cfgdir"/cmd.prepare
257
258     
259     test -e "$cfgdir"/sync -o "$OPTION_FORCE_SYNC" || {
260         INITCMD_START_SYNC=()
261         INITCMD_STOP_SYNC=()
262     }
263 }
264
265 function _generateFlagOptions
266 {
267     local vdir=$1
268
269     CHCONTEXT_FLAG_OPTS=()
270
271     test ! -e "$vdir"/flags || \
272     while read flag; do
273         case x"$flag" in
274             (x|x\#)             ;;
275             (xnamespace)        ;;
276             (xfakeinit)
277                 _IS_FAKEINIT=1
278                 ;;
279             (*)
280                 OPTS_VATTRIBUTE=( "${OPTS_VATTRIBUTE[@]}" --flag "$flag" )
281                 CHCONTEXT_FLAG_OPTS=( "${CHCONTEXT_FLAG_OPTS[@]}"
282                                       --flag "$flag" )
283                 ;;
284         esac
285     done <"$vdir"/flags
286
287     isAvoidNamespace "$vdir" || {
288         USE_VNAMESPACE=1
289         CHCONTEXT_FLAG_OPTS=( "${CHCONTEXT_FLAG_OPTS[@]}" --flag namespace )
290     }
291 }
292
293 function _generateChcontextOptions
294 {
295     local vdir=$1
296     local ctx hostname domainname
297     local cap_opts
298     local flag
299
300     {
301         read ctx        <"$vdir"/context     || :
302         read hostname   <"$vdir"/hostname    || :
303         read domainname <"$vdir"/domainname  || :
304     } 2>/dev/null
305
306     test -z "$S_CONTEXT" || ctx=$S_CONTEXT
307
308     _generateCapabilityOptions "$vdir"
309     _generateFlagOptions       "$vdir"
310
311     CHCONTEXT_OPTS=( $SILENT_OPT \
312                      "${CHCONTEXT_FLAG_OPTS[@]}" \
313                      "${CAP_OPTS[@]}" \
314                      --secure
315                      ${ctx:+--ctx "$ctx"} \
316                      ${hostname:+--hostname "$hostname"} \
317                      ${domainname:+--domainname "$domainname"} )
318
319     OPTS_VCONTEXT_CREATE=( $SILENT_OPT \
320                            ${ctx:+--xid "$ctx"} )
321     ## put '--secure' at front so that it can be overridden
322     OPTS_VATTRIBUTE=( --secure "${OPTS_VATTRIBUTE[@]}" )
323 }
324
325 function _getInterfaceValue
326 {
327     local val=$1
328     local dflt=$2
329     shift 2
330     
331     local i
332     local tmp
333
334     for i; do
335         read tmp  <"$i/$val" && break || :
336     done 2>/dev/null
337
338     : ${tmp:=$dflt}
339     eval $val=\$tmp
340 }
341
342 ## Usage: _transformMask2Prefix <result-varname> <prefix> <mask>
343 function _transformMask2Prefix
344 {
345     local tmp=$2
346     
347     test "$tmp" || {
348         $_MASK2PREFIX "$3" || tmp=$?
349     }
350
351     eval $1=\$tmp
352     return 0
353 }
354
355 function _addInterfaceCmd
356 {
357     eval INTERFACE_CMDS_${INTERFACE_CMDS_IDX}='( "$@" )'
358     let ++INTERFACE_CMDS_IDX
359 }
360
361 ## Usage: _processSingleInterface <interface-directory>
362 function _processSingleInterface
363 {
364     local iface=$1
365
366     local ip
367     local dev
368     local prefix
369     local mask
370     local bcast
371     local name
372     local scope
373
374     _getInterfaceValue ip     '' "$iface"
375     _getInterfaceValue dev    '' "$iface" "$iface/.."
376     _getInterfaceValue prefix '' "$iface" "$iface/.."
377     _getInterfaceValue mask   '' "$iface" "$iface/.."
378     _getInterfaceValue bcast  '' "$iface" "$iface/.."
379     _getInterfaceValue name   '' "$iface"
380     _getInterfaceValue scope  '' "$iface" "$iface/.."
381
382     test "$ip" || { echo $"Can not read ip for '$iface'"  >&2; return 1; }
383     
384     test ! -e "$iface"/only_ip || {
385         echo $"The 'only_ip' flag for interface '$iface' is deprecated; use 'nodev' instead of" >&2
386         unset dev
387     }
388     test ! -e "$iface"/nodev   || unset dev
389     
390     if test "$dev"; then
391         _transformMask2Prefix prefix "$prefix" "$mask"
392
393         case "$dev" in
394             (*.*)
395                 test -d /proc/net/vlan || {
396                     echo -e $"VLAN device-name used, but vlan subsystem not enabled.\nTry to execute 'modprobe 8021q' before starting the vservers"  >&2
397                     return 1
398                 }
399                 test -f /proc/net/vlan || {
400                     _addInterfaceCmd VCONFIG "${dev/./ }"
401                     _addInterfaceCmd IP_ADDR 127.0.0.1/8 broadcast 127.255.255.255 dev "$dev"
402                     _addInterfaceCmd IP_LINK "$dev"
403                 }
404                 ;;
405         esac
406
407         INTERFACES=( "${INTERFACES[@]}" "$ip${prefix:+/$prefix}" )
408         _addInterfaceCmd IP_ADDR  "$ip${prefix:+/$prefix}" broadcast ${bcast:-+} ${name:+label "$dev:$name"} dev "$dev"
409         #_addInterfaceCmd IP_ROUTE "$ip${prefix:+/$prefix}" dev "$dev"
410         _addInterfaceCmd IP_LINK  "$dev"
411     fi
412 }
413
414 ## Usage: _generateInterfaceOptions <vserver-directory>
415 function _generateInterfaceOptions
416 {
417     local iface
418
419     for iface in "$1/interfaces/"*; do
420         test   -d "$iface"          || continue
421         test ! -e "$iface"/disabled || continue
422     
423         _processSingleInterface "$iface"
424     done
425     _HAVE_INTERFACE_OPTIONS=1
426 }
427
428 function enableInterfaces
429 {
430     local i=0
431     declare -a var
432
433     while test $i -lt $INTERFACE_CMDS_IDX; do
434         eval var='( "${INTERFACE_CMDS_'$i'[@]}" )'
435         local type=${var[0]}
436         unset var[0]
437         
438         case "$type" in
439             VCONFIG)    $_VCONFIG  add "${var[@]}";;
440             IP_ADDR)    $_IP addr  add "${var[@]}";;
441             IP_LINK)    $_IP link  set "${var[@]}" up;;
442             IP_ROUTE)   $_IP route add "${var[@]}";;
443             *)          echo "Unknown interface-command type '$type'" >&2; false;;
444         esac
445
446         let ++i
447     done
448 }
449
450 function disableInterfaces
451 {
452     test "$_HAVE_INTERFACE_OPTIONS" || _generateInterfaceOptions "$1"
453
454     local i=$INTERFACE_CMDS_IDX
455     declare -a var
456
457     while test $i -gt 0; do
458         let --i || :
459
460         eval var='( "${INTERFACE_CMDS_'$i'[@]}" )'
461         local type=${var[0]}
462         unset var[0]
463         
464         case "$type" in
465             VCONFIG)    $_VCONFIG  rem "${var[@]}";;
466             IP_ADDR)    $_IP addr  del "${var[@]}";;
467             IP_LINK)    ;; ## Ignore the link-down command for now
468             IP_ROUTE)   $_IP route del "${var[@]}";;
469             *)          echo "Unknown interface-command type '$type'" >&2; false;;
470         esac
471     done
472 }
473
474 ## Usage: prepareInit <vserver-directory>
475 function prepareInit
476 {
477     pushd "$1/vdir" >/dev/null
478     case "$INITSTYLE" in
479         sysv)
480             { find var/run  ! -type d -print0; \
481               find var/lock ! -type d -print0; } | xargs -0r $_CHROOT_RM
482             ;;
483         minit)
484             ;;
485     esac
486     "${INITCMD_PREPARE[@]}"
487     popd >/dev/null
488 }
489
490 function generateOptions
491 {
492     _generateInterfaceOptions  "$1"
493     test "$_HAVE_CHBIND_OPTIONS" || _generateChbindOptions "$1" 
494     _generateNiceCommand       "$1"
495     _generateInitOptions       "$1"
496     _generateChcontextOptions  "$1"
497
498     if test "$_IS_FAKEINIT"; then
499         CHCONTEXT_INIT_OPTS=( --disconnect --flag fakeinit )
500         OPTS_VCONTEXT_MIGRATE=( "${OPTS_VCONTEXT_MIGRATE[@]}" --fakeinit --disconnect )
501     fi
502 }
503
504 function _mountVserverInternal
505 {
506     local fstab="$1"
507     test -e "$fstab" || return 0
508     shift
509     
510     "$@" $_SECURE_MOUNT -a --chroot "$vdir" --fstab "$fstab"
511 }
512
513 function mountVserver
514 {
515     local cfgdir=$1
516     local ns_opt=$2
517     local vdir=$1/vdir
518     local mtab_src
519
520     test -e "$cfgdir"/fstab -o \
521          -e "$cfgdir"/fstab.local || return 0
522
523     findObject -r mtab_src "$vdir"/apps/init/mtab "$CONFDIR"/.defaults/init/mtab "$PKGLIBDEFAULTDIR"/mtab /dev/null
524     
525     pushd "$vdir" >/dev/null
526     $_CHROOT_CAT /etc/mtab <"$mtab_src"
527     popd >/dev/null
528
529     test "$_HAVE_CHBIND_OPTIONS" || _generateChbindOptions "$cfgdir"
530
531     test -z "$NAMESPACE_CLEANUP" || isAvoidNamespace "$cfgdir" || \
532         $_VNAMESPACE --cleanup
533
534     _mountVserverInternal "$cfgdir"/fstab       $_CHBIND "${CHBIND_OPTS[@]}"
535     _mountVserverInternal "$cfgdir"/fstab.local
536
537     isAvoidNamespace "$cfgdir" || \
538         $_SECURE_MOUNT --rbind -n "$vdir" "/"
539 }
540
541 function _umountVserverInternal
542 {
543     local fstab="$1"
544     test -e "$fstab" || return 0
545     shift
546
547     tac "$fstab" | {
548         is_ok=1
549         while read src dst tmp; do
550             test "$tmp" || continue
551             case x"$src" in
552                 (x\#*)  continue;;
553             esac
554
555         
556             "$@" $_EXEC_CD "$dst" $_UMOUNT -lfn . || is_ok=
557         done
558         test "$is_ok"
559     }
560 }
561
562 function umountVserver
563 {
564     local cfgdir=$1
565     local vdir=$1/vdir
566     local is_ok=1
567
568     isAvoidNamespace "$cfgdir"    || return 0
569     test -e "$cfgdir"/fstab -o \
570          -e "$cfgdir"/fstab.local || return 0
571     test "$_HAVE_CHBIND_OPTIONS"  || _generateChbindOptions "$cfgdir"
572     
573     pushd "$vdir/" >/dev/null || return 1
574         _umountVserverInternal  "$cfgdir"/fstab.local                              || is_ok=
575         _umountVserverInternal  "$cfgdir"/fstab       $_CHBIND "${CHBIND_OPTS[@]}" || is_ok=
576     popd >/dev/null           || return 1
577
578     test "$is_ok"
579 }
580
581 function _sourceWrap
582 {
583     local vdir name flavor start i
584     . "$@"
585 }
586
587 ## Usage: execScriptlets <vserver-cfgdir> <vserver-name> <script-flavor>
588 function execScriptlets
589 {
590     local vdir=$1
591     local name=$2
592     local flavor=$3
593     local start=
594     local i
595
596     for i in "$vdir/scripts/$flavor" "$vdir/scripts/$flavor.d"/*; do
597         test -f "$i" -a -r "$i" || continue
598         test -x "$i" || start=_sourceWrap
599         $start "$i" "$flavor" "$name"
600     done
601 }