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