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