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