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