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