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