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