etc/rc.initdiskless

   1 #!/bin/sh
   2 #
   3 # Copyright (c) 1999  Matt Dillon
   4 # All rights reserved.
   5 #
   6 # Redistribution and use in source and binary forms, with or without
   7 # modification, are permitted provided that the following conditions
   8 # are met:
   9 # 1. Redistributions of source code must retain the above copyright
  10 #    notice, this list of conditions and the following disclaimer.
  11 # 2. Redistributions in binary form must reproduce the above copyright
  12 #    notice, this list of conditions and the following disclaimer in the
  13 #    documentation and/or other materials provided with the distribution.
  14 #
  15 # THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  16 # ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  17 # IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  18 # ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  19 # FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  20 # DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  21 # OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  22 # HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  23 # LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  24 # OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  25 # SUCH DAMAGE.
  26 #
  27 # $FreeBSD$
  28
  29 # On entry to this script the entire system consists of a read-only root
  30 # mounted via NFS. The kernel has run BOOTP and configured an interface
  31 # (otherwise it would not have been able to mount the NFS root!)
  32 #
  33 # We use the contents of /conf to create and populate memory filesystems
  34 # that are mounted on top of this root to implement the writable
  35 # (and host-specific) parts of the root filesystem, and other volatile
  36 # filesystems.
  37 #
  38 # The hierarchy in /conf has the form /conf/T/M/ where M are directories
  39 # for which memory filesystems will be created and filled,
  40 # and T is one of the "template" directories below:
  41 #
  42 #  base         universal base, typically a replica of the original root;
  43 #  default      secondary universal base, typically overriding some
  44 #               of the files in the original root;
  45 #  ${ipba}      where ${ipba} is the assigned broadcast IP address
  46 #  bcast/${ipba} same as above
  47 #  ${class}     where ${class} is a list of directories supplied by
  48 #               bootp/dhcp through the T134 option.
  49 #               ${ipba} and ${class} are typically used to configure features
  50 #               for group of diskless clients, or even individual features;
  51 #  ${ip}        where ${ip} is the machine's assigned IP address, typically
  52 #               used to set host-specific features;
  53 #  ip/${ip}     same as above
  54 #
  55 # Template directories are scanned in the order they are listed above,
  56 # with each successive directory overriding (merged into) the previous one;
  57 # non-existing directories are ignored.  The subdirectory forms exist to
  58 # help keep the top level /conf manageable in large installations.
  59 #
  60 # The existence of a directory /conf/T/M causes this script to create a
  61 # memory filesystem mounted as /M on the client.
  62 #
  63 # Some files in /conf have special meaning, namely:
  64 #
  65 # Filename      Action
  66 # ----------------------------------------------------------------
  67 # /conf/T/M/remount
  68 #               The contents of the file is a mount command. E.g. if
  69 #               /conf/1.2.3.4/foo/remount contains "mount -o ro /dev/ad0s3",
  70 #               then /dev/ad0s3 will be be mounted on /conf/1.2.3.4/foo/
  71 #
  72 # /conf/T/M/remount_optional
  73 #               If this file exists, then failure to execute the mount
  74 #               command contained in /conf/T/M/remount is non-fatal.
  75 #
  76 # /conf/T/M/remount_subdir
  77 #               If this file exists, then the behaviour of /conf/T/M/remount
  78 #               changes as follows:
  79 #                1. /conf/T/M/remount is invoked to mount the root of the
  80 #                   filesystem where the configuration data exists on a
  81 #                   temporary mountpoint.
  82 #                2. /conf/T/M/remount_subdir is then invoked to mount a
  83 #                   *subdirectory* of the filesystem mounted by
  84 #                   /conf/T/M/remount on /conf/T/M/.
  85 #
  86 # /conf/T/M/diskless_remount
  87 #               The contents of the file points to an NFS filesystem,
  88 #               possibly followed by mount_nfs options. If the server name
  89 #               is omitted, the script will prepend the root path used when
  90 #               booting. E.g. if you booted from foo.com:/path/to/root,
  91 #               an entry for /conf/base/etc/diskless_remount could be any of
  92 #                       foo.com:/path/to/root/etc
  93 #                       /etc -o ro
  94 #               Because mount_nfs understands ".." in paths, it is
  95 #               possible to mount from locations above the NFS root with
  96 #               paths such as "/../../etc".
  97 #
  98 # /conf/T/M/md_size
  99 #               The contents of the file specifies the size of the memory
 100 #               filesystem to be created, in 512 byte blocks.
 101 #               The default size is 10240 blocks (5MB). E.g. if
 102 #               /conf/base/etc/md_size contains "30000" then a 15MB MFS
 103 #               will be created. In case of multiple entries for the same
 104 #               directory M, the last one in the scanning order is used.
 105 #               NOTE: If you only need to create a memory filesystem but not
 106 #               initialize it from a template, it is preferable to specify
 107 #               it in fstab e.g. as  "md /tmp mfs -s=30m,rw 0 0"
 108 #
 109 # /conf/T/SUBDIR.cpio.gz
 110 #               The file is cpio'd into /SUBDIR (and a memory filesystem is
 111 #               created for /SUBDIR if necessary). The presence of this file
 112 #               prevents the copy from /conf/T/SUBDIR/
 113 #
 114 # /conf/T/M/extract
 115 #               This is alternative to SUBDIR.cpio.gz and remount.
 116 #               Similar to remount case, a memory filesystem is created
 117 #               for /M and initialized from a template but no mounting
 118 #               performed. Instead, this file is run passing /M as single
 119 #               argument. It is expected to extract template override to /M
 120 #               using auxiliary storage found in some embedded systems
 121 #               having NVRAM too small to hold mountable file system.
 122 #
 123 # /conf/T/SUBDIR.remove
 124 #               The list of paths contained in the file are rm -rf'd
 125 #               relative to /SUBDIR.
 126 #
 127 # /conf/diskless_remount
 128 #               Similar to /conf/T/M/diskless_remount above, but allows
 129 #               all of /conf to be remounted.  This can be used to allow
 130 #               multiple roots to share the same /conf.
 131 #
 132 #
 133 # You will almost universally want to create the following files under /conf
 134 #
 135 # File                                  Content
 136 # ----------------------------          ----------------------------------
 137 # /conf/base/etc/md_size                size of /etc filesystem
 138 # /conf/base/etc/diskless_remount       "/etc"
 139 # /conf/default/etc/rc.conf             generic diskless config parameters
 140 # /conf/default/etc/fstab               generic diskless fstab e.g. like this
 141 #
 142 #       foo:/root_part                  /       nfs     ro              0 0
 143 #       foo:/usr_part                   /usr    nfs     ro              0 0
 144 #       foo:/home_part                  /home   nfs     rw              0 0
 145 #       md                              /tmp    mfs     -s=30m,rw       0 0
 146 #       md                              /var    mfs     -s=30m,rw       0 0
 147 #       proc                            /proc   procfs  rw              0 0
 148 #
 149 # plus, possibly, overrides for password files etc.
 150 #
 151 # NOTE!  /var, /tmp, and /dev will be typically created elsewhere, e.g.
 152 # as entries in the fstab as above.
 153 # Those filesystems should not be specified in /conf.
 154 #
 155 # (end of documentation, now get to the real code)
 156
 157 dlv=`/sbin/sysctl -n vfs.nfs.diskless_valid 2> /dev/null`
 158
 159 # DEBUGGING
 160 # log something on stdout if verbose.
 161 o_verbose=0     # set to 1 or 2 if you want more debugging
 162 log() {
 163     [ ${o_verbose} -gt 0 ] && echo "*** $* ***"
 164     [ ${o_verbose} -gt 1 ] && read -p "=== Press enter to continue" foo
 165 }
 166
 167 # chkerr:
 168 #
 169 # Routine to check for error
 170 #
 171 #       checks error code and drops into shell on failure.
 172 #       if shell exits, terminates script as well as /etc/rc.
 173 #       if remount_optional exists under the mountpoint, skip this check.
 174 #
 175 chkerr() {
 176     lastitem () ( n=$(($# - 1)) ; shift $n ; echo $1 )
 177     mountpoint="$(lastitem $2)"
 178     [ -r $mountpoint/remount_optional ] && ( echo "$2 failed: ignoring due to remount_optional" ; return )
 179     case $1 in
 180     0)
 181         ;;
 182     *)
 183         echo "$2 failed: dropping into /bin/sh"
 184         /bin/sh
 185         # RESUME
 186         ;;
 187     esac
 188 }
 189
 190 # The list of filesystems to umount after the copy
 191 to_umount=""
 192
 193 handle_remount() { # $1 = mount point
 194     local nfspt mountopts b
 195     b=$1
 196     log handle_remount $1
 197     [ -d $b -a -f $b/diskless_remount ] || return
 198     read nfspt mountopts < $b/diskless_remount
 199     log "nfspt ${nfspt} mountopts ${mountopts}"
 200     # prepend the nfs root if not present
 201     [ `expr "$nfspt" : '\(.\)'` = "/" ] && nfspt="${nfsroot}${nfspt}"
 202     mount_nfs $mountopts $nfspt $b
 203     chkerr $? "mount_nfs $nfspt $b"
 204     to_umount="$b ${to_umount}"
 205 }
 206
 207 # Create a generic memory disk
 208 #
 209 mount_md() {
 210     /sbin/mdmfs -S -i 4096 -s $1 -M md $2
 211 }
 212
 213 # Create the memory filesystem if it has not already been created
 214 #
 215 create_md() {
 216         [ "x`eval echo \\$md_created_$1`" = "x" ] || return # only once
 217         if [ "x`eval echo \\$md_size_$1`" = "x" ]; then
 218             md_size=10240
 219         else
 220             md_size=`eval echo \\$md_size_$1`
 221         fi
 222         log create_md $1 with size $md_size
 223         mount_md $md_size /$1
 224         /bin/chmod 755 /$1
 225         eval md_created_$1=created
 226 }
 227
 228 # DEBUGGING
 229 #
 230 # set -v
 231
 232 # Figure out our interface and IP.
 233 #
 234 bootp_ifc=""
 235 bootp_ipa=""
 236 bootp_ipbca=""
 237 class=""
 238 if [ ${dlv:=0} -ne 0 ] ; then
 239         iflist=`ifconfig -l`
 240         for i in ${iflist} ; do
 241             set -- `ifconfig ${i}`
 242             while [ $# -ge 1 ] ; do
 243                 if [ "${bootp_ifc}" = "" -a "$1" = "inet" ] ; then
 244                     bootp_ifc=${i} ; bootp_ipa=${2} ; shift
 245                 fi
 246                 if [ "${bootp_ipbca}" = "" -a "$1" = "broadcast" ] ; then
 247                     bootp_ipbca=$2; shift
 248                 fi
 249                 shift
 250             done
 251             if [ "${bootp_ifc}" != "" ] ; then
 252                 break
 253             fi
 254         done
 255         # Get the values passed with the T134 bootp cookie.
 256         class="`/sbin/sysctl -qn kern.bootp_cookie`"
 257
 258         echo "Interface ${bootp_ifc} IP-Address ${bootp_ipa} Broadcast ${bootp_ipbca} ${class}"
 259 fi
 260
 261 log Figure out our NFS root path
 262 #
 263 set -- `mount -t nfs`
 264 while [ $# -ge 1 ] ; do
 265     if [ "$2" = "on" -a "$3" = "/" ]; then
 266         nfsroot="$1"
 267         break
 268     fi
 269     shift
 270 done
 271
 272 # The list of directories with template files
 273 templates="base default"
 274 if [ -n "${bootp_ipbca}" ]; then
 275         templates="${templates} ${bootp_ipbca} bcast/${bootp_ipbca}"
 276 fi
 277 if [ -n "${class}" ]; then
 278         templates="${templates} ${class}"
 279 fi
 280 if [ -n "${bootp_ipa}" ]; then
 281         templates="${templates} ${bootp_ipa} ip/${bootp_ipa}"
 282 fi
 283
 284 # If /conf/diskless_remount exists, remount all of /conf.
 285 handle_remount /conf
 286
 287 # Resolve templates in /conf/base, /conf/default, /conf/${bootp_ipbca},
 288 # and /conf/${bootp_ipa}.  For each subdirectory found within these
 289 # directories:
 290 #
 291 # - calculate memory filesystem sizes.  If the subdirectory (prior to
 292 #   NFS remounting) contains the file 'md_size', the contents specified
 293 #   in 512 byte sectors will be used to size the memory filesystem.  Otherwise
 294 #   8192 sectors (4MB) is used.
 295 #
 296 # - handle NFS remounts.  If the subdirectory contains the file
 297 #   diskless_remount, the contents of the file is NFS mounted over
 298 #   the directory.  For example /conf/base/etc/diskless_remount
 299 #   might contain 'myserver:/etc'.  NFS remounts allow you to avoid
 300 #   having to dup your system directories in /conf.  Your server must
 301 #   be sure to export those filesystems -alldirs, however.
 302 #   If the diskless_remount file contains a string beginning with a
 303 #   '/' it is assumed that the local nfsroot should be prepended to
 304 #   it before attemping to the remount.  This allows the root to be
 305 #   relocated without needing to change the remount files.
 306 #
 307 log "templates are ${templates}"
 308 for i in ${templates} ; do
 309     for j in /conf/$i/* ; do
 310         [ -d $j ] || continue
 311
 312         # memory filesystem size specification
 313         subdir=${j##*/}
 314         [ -f $j/md_size ] && eval md_size_$subdir=`cat $j/md_size`
 315
 316         # remount. Beware, the command is in the file itself!
 317         if [ -f $j/remount ]; then
 318             if [ -f $j/remount_subdir ]; then
 319                 k="/conf.tmp/$i/$subdir"
 320                 [ -d $k ] || continue
 321
 322                 # Mount the filesystem root where the config data is
 323                 # on the temporary mount point.
 324                 nfspt=`/bin/cat $j/remount`
 325                 $nfspt $k
 326                 chkerr $? "$nfspt $k"
 327
 328                 # Now use a nullfs mount to get the data where we
 329                 # really want to see it.
 330                 remount_subdir=`/bin/cat $j/remount_subdir`
 331                 remount_subdir_cmd="mount -t nullfs $k/$remount_subdir"
 332
 333                 $remount_subdir_cmd $j
 334                 chkerr $? "$remount_subdir_cmd $j"
 335
 336                 # XXX check order -- we must force $k to be unmounted
 337                 # after j, as j depends on k.
 338                 to_umount="$j $k ${to_umount}"
 339             else
 340                 nfspt=`/bin/cat $j/remount`
 341                 $nfspt $j
 342                 chkerr $? "$nfspt $j"
 343                 to_umount="$j ${to_umount}" # XXX hope it is really a mount!
 344             fi
 345         fi
 346
 347         # NFS remount
 348         handle_remount $j
 349     done
 350 done
 351
 352 # - Create all required MFS filesystems and populate them from
 353 #   our templates.  Support both a direct template and a dir.cpio.gz
 354 #   archive. Support for auxiliary NVRAM. Support dir.remove files containing
 355 #   a list of relative paths to remove.
 356 #
 357 # The dir.cpio.gz form is there to make the copy process more efficient,
 358 # so if the cpio archive is present, it prevents the files from dir/
 359 # from being copied.
 360
 361 for i in ${templates} ; do
 362     for j in /conf/$i/* ; do
 363         subdir=${j##*/}
 364         if [ -d $j -a ! -f $j.cpio.gz  ]; then
 365             create_md $subdir
 366             cp -Rp $j/ /$subdir
 367         fi
 368     done
 369     for j in /conf/$i/*.cpio.gz ; do
 370         subdir=${j%*.cpio.gz}
 371         subdir=${subdir##*/}
 372         if [ -f $j ]; then
 373             create_md $subdir
 374             echo "Loading /$subdir from cpio archive $j"
 375             (cd / ; /rescue/tar -xpf $j)
 376         fi
 377     done
 378     for j in /conf/$i/*/extract ; do
 379         if [ -x $j ]; then
 380             subdir=${j%*/extract}
 381             subdir=${subdir##*/}
 382             create_md $subdir
 383             echo "Loading /$subdir using auxiliary command $j"
 384             $j /$subdir
 385         fi
 386     done
 387     for j in /conf/$i/*.remove ; do
 388         subdir=${j%*.remove}
 389         subdir=${subdir##*/}
 390         if [ -f $j ]; then
 391             # doubly sure it is a memory disk before rm -rf'ing
 392             create_md $subdir
 393             (cd /$subdir; rm -rf `/bin/cat $j`)
 394         fi
 395     done
 396 done
 397
 398 # umount partitions used to fill the memory filesystems
 399 [ -n "${to_umount}" ] && umount $to_umount