- moved getFileValue/getFileArray from 'vserver.functions' into 'functions'
[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
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=(  --flag fakeinit )
166             CHCONTEXT_DISCONNECT=( --disconnect )
167             test -z "$runlevel_start" || INITCMD_START=( "${INITCMD_START[@]}" "$runlevel_start" )
168             test -z "$runlevel_stop"  || INITCMD_STOP=(  "${INITCMD_STOP[@]}"  "$runlevel_stop"  )
169             ;;
170             
171         xminit)
172             INITCMD_START=( /sbin/minit-start )
173             INITCMD_STOP=(  /sbin/minit-stop  )
174             CHCONTEXT_INIT_OPTS=(  --flag fakeinit )
175             CHCONTEXT_DISCONNECT=( --disconnect )
176             INITCMD_START_SYNC=( "$_INITSYNC_MINIT_START" "$vdir" )
177             INITCMD_STOP_SYNC=(  "$_INITSYNC_MINIT_STOP"  "$vdir" )
178             test -z "$runlevel_start" || INITCMD_START=( "${INITCMD_START[@]}" "$runlevel_start" )
179             test -z "$runlevel_stop"  || INITCMD_STOP=(  "${INITCMD_STOP[@]}"  "$runlevel_stop"  )
180             ;;
181
182         x)  ;;
183         *)  echo "Unknown init-style '$INITSTYLE'; aborting" >&2;
184             exit 1;;
185     esac
186
187     getFileArray INITCMD_START      "$cfgdir"/cmd.start
188     getFileArray INITCMD_STOP       "$cfgdir"/cmd.stop
189     getFileArray INITCMD_START_SYNC "$cfgdir"/cmd.start-sync
190     getFileArray INITCMD_STOP_SYNC  "$cfgdir"/cmd.stop-sync
191     getFileArray INITCMD_PREPARE    "$cfgdir"/cmd.prepare
192
193     
194     test -e "$cfgdir"/sync -o "$OPTION_FORCE_SYNC" || {
195         INITCMD_START_SYNC=()
196         INITCMD_STOP_SYNC=()
197     }
198 }
199
200 function _generateFlagOptions
201 {
202     local vdir=$1
203
204     CHCONTEXT_FLAG_OPTS=()
205
206     test -e "$vdir"/flags || return 0
207
208     while read flag; do
209         case x"$flag" in
210             x|x#)               ;;
211             dummy)              ;;
212             fakeinit)
213                 CHCONTEXT_FLAG_OPTS=( "${CHCONTEXT_FLAG_OPTS[@]}" --flag fakeinit )
214                 CHCONTEXT_DISCONNECT=( --disconnect )
215                 ;;
216             *)
217                 CHCONTEXT_FLAG_OPTS=( "${CHCONTEXT_FLAG_OPTS[@]}"
218                                       --flag "$flag" )
219                 ;;
220         esac
221     done <"$vdir"/flags
222 }
223
224 function _generateChcontextOptions
225 {
226     local vdir=$1
227     local ctx hostname domainname
228     local cap_opts
229     local flag
230
231     {
232         read ctx        <"$vdir"/context
233         read hostname   <"$vdir"/hostname
234         read domainname <"$vdir"/domainname
235     } 2>/dev/null
236
237     test -z "$S_CONTEXT" || ctx=$S_CONTEXT
238
239     _generateCapabilityOptions "$vdir"
240     _generateFlagOptions       "$vdir"
241
242     CHCONTEXT_OPTS=( $SILENT_OPT \
243                      "${CHCONTEXT_FLAG_OPTS[@]}" \
244                      "${CHCONTEXT_INIT_OPTS[@]}" \
245                      "${CAP_OPTS[@]}" \
246                      --secure
247                      ${ctx:+--ctx "$ctx"} \
248                      ${hostname:+--hostname "$hostname"} \
249                      ${domainname:+--domainname "$domainname"} )
250 }
251
252 function _getInterfaceValue
253 {
254     local val=$1
255     local dflt=$2
256     shift 2
257     
258     local i
259     local tmp
260
261     for i; do
262         read tmp  <"$i/$val" && break || :
263     done 2>/dev/null
264
265     : ${tmp:=$dflt}
266     eval $val=\$tmp
267 }
268
269 ## Usage: _transformMask2Prefix <result-varname> <prefix> <mask>
270 function _transformMask2Prefix
271 {
272     local tmp=$2
273     
274     test "$tmp" || {
275         $_MASK2PREFIX "$3" || tmp=$?
276     }
277
278     eval $1=\$tmp
279     return 0
280 }
281
282 function _addInterfaceCmd
283 {
284     eval INTERFACE_CMDS_${INTERFACE_CMDS_IDX}='( "$@" )'
285     let ++INTERFACE_CMDS_IDX
286 }
287
288 ## Usage: _processSingleInterface <interface-directory>
289 function _processSingleInterface
290 {
291     local iface=$1
292
293     local ip
294     local dev
295     local prefix
296     local mask
297     local bcast
298     local name
299     local scope
300
301     _getInterfaceValue ip     '' "$iface"
302     _getInterfaceValue dev    '' "$iface" "$iface/.."
303     _getInterfaceValue prefix '' "$iface" "$iface/.."
304     _getInterfaceValue mask   '' "$iface" "$iface/.."
305     _getInterfaceValue bcast  '' "$iface" "$iface/.."
306     _getInterfaceValue name   '' "$iface"
307     _getInterfaceValue scope  '' "$iface" "$iface/.."
308
309     test "$ip" || { echo $"Can not read ip for '$iface'"; return 1; }
310     
311     test ! -e "$iface"/only_ip   || unset dev
312     
313     if test "$dev"; then
314         _transformMask2Prefix prefix "$prefix" "$mask"
315
316         case "$dev" in
317             *.*)
318                 test -d /proc/net/vlan || {
319                     echo -e $"VLAN device-name used, but vlan subsystem not enabled.\nTry to execute 'modprobe 8021q' before starting the vservers"
320                     return 1
321                 }
322                 test -f /proc/net/vlan || {
323                     _addInterfaceCmd VCONFIG "${dev/./ }"
324                     _addInterfaceCmd IP_ADDR 127.0.0.1/8 broadcast 127.255.255.255 dev "$dev"
325                     _addInterfaceCmd IP_LINK "$dev"
326                 }
327                 ;;
328         esac
329
330         INTERFACES=( "${INTERFACES[@]}" "$ip${prefix:+/$prefix}" )
331         _addInterfaceCmd IP_ADDR  "$ip${prefix:+/$prefix}" broadcast ${bcast:-+} ${name:+label "$dev:$name"} dev "$dev"
332         #_addInterfaceCmd IP_ROUTE "$ip${prefix:+/$prefix}" dev "$dev"
333         _addInterfaceCmd IP_LINK  "$dev"
334     fi
335 }
336
337 ## Usage: _generateInterfaceOptions <vserver-directory>
338 function _generateInterfaceOptions
339 {
340     local iface
341
342     for iface in "$1/interfaces/"*; do
343         test   -d "$iface"          || continue
344         test ! -e "$iface"/disabled || continue
345     
346         _processSingleInterface "$iface"
347     done
348 }
349
350 function enableInterfaces
351 {
352     local i=0
353     declare -a var
354
355     while test $i -lt $INTERFACE_CMDS_IDX; do
356         eval var='( "${INTERFACE_CMDS_'$i'[@]}" )'
357         local type=${var[0]}
358         unset var[0]
359         
360         case "$type" in
361             VCONFIG)    $_VCONFIG  add "${var[@]}";;
362             IP_ADDR)    $_IP addr  add "${var[@]}";;
363             IP_LINK)    $_IP link  set "${var[@]}" up;;
364             IP_ROUTE)   $_IP route add "${var[@]}";;
365             *)          echo "Unknown interface-command type '$type'" >&2; false;;
366         esac
367
368         let ++i
369     done
370 }
371
372 function disableInterfaces
373 {
374     local i=$INTERFACE_CMDS_IDX
375     declare -a var
376
377     while test $i -gt 0; do
378         let --i
379
380         eval var='( "${INTERFACE_CMDS_'$i'[@]}" )'
381         local type=${var[0]}
382         unset var[0]
383         
384         case "$type" in
385             VCONFIG)    $_VCONFIG  rem "${var[@]}";;
386             IP_ADDR)    $_IP addr  del "${var[@]}";;
387             IP_LINK)    ;; ## Ignore the link-down command for now
388             IP_ROUTE)   $_IP route del "${var[@]}";;
389             *)          echo "Unknown interface-command type '$type'" >&2; false;;
390         esac
391     done
392 }
393
394 ## Usage: prepareInit <vserver-directory>
395 function prepareInit
396 {
397     pushd "$1/vdir" >/dev/null
398     case "$INITSTYLE" in
399         sysv)
400             { find var/run  ! -type d -print0; \
401               find var/lock ! -type d -print0; } | xargs -0r $_CHROOT_RM
402             ;;
403         minit)
404             ;;
405     esac
406     "${INITCMD_PREPARE[@]}"
407     popd >/dev/null
408 }
409
410 function generateOptions
411 {
412     _generateInterfaceOptions  "$1"
413     _generateChbindOptions     "$1"
414     _generateNiceCommand       "$1"
415     _generateInitOptions       "$1"
416     _generateChcontextOptions  "$1"
417 }
418
419 function mountVserver
420 {
421     local cfgdir=$1
422     local vdir=$1/vdir
423     local mtab_src
424
425     test -e "$cfgdir"/fstab || return 0
426
427     findObject -r mtab_src "$CONFDIR"/.defaults/init/mtab "$vdir"/apps/init/mtab /dev/null
428     
429     pushd "$vdir" >/dev/null
430     $_CHROOT_CAT /etc/mtab <"$mtab_src"
431     popd >/dev/null
432
433     $_CHBIND "${CHBIND_OPTS[@]}" \
434         $_SECURE_MOUNT -a --chroot "$vdir" --fstab "$cfgdir"/fstab
435 }
436
437 function umountVserver
438 {
439     local cfgdir=$1
440     local vdir=$1/vdir
441
442     is_ok=1
443
444     test -e "$cfgdir"/fstab || return 0
445     
446     pushd "$vdir/" >/dev/null
447     tac "$cfgdir"/fstab | while read src dst tmp; do
448         test "$tmp" || continue
449         case x"$src" in
450             x#*)        continue;;
451         esac
452
453         $_CHBIND "${CHBIND_OPTS[@]}" \
454             $_SECURE_UMOUNT "$dst" || is_ok=
455     done
456     popd >/dev/null
457
458     test "$is_ok"
459 }
460
461 function _sourceWrap
462 {
463     local vdir name flavor start i
464     . "$@"
465 }
466
467 ## Usage: execScriptlets <vserver-cfgdir> <vserver-name> <script-flavor>
468 function execScriptlets
469 {
470     local vdir=$1
471     local name=$2
472     local flavor=$3
473     local start=
474     local i
475
476     for i in "$vdir/scripts/$flavor" "$vdir/scripts/$flavor.d"/*; do
477         test -f "$i" -a -r "$i" || continue
478         test -x "$i" || start=_sourceWrap
479         $start "$i" "$flavor" "$name"
480     done
481 }