rc.initdiskless revision 179014
1100280Sgordon#!/bin/sh 2100280Sgordon# 3118638Sfjoe# Copyright (c) 1999 Matt Dillon 466830Sobrien# All rights reserved. 566830Sobrien# 666830Sobrien# Redistribution and use in source and binary forms, with or without 766830Sobrien# modification, are permitted provided that the following conditions 866830Sobrien# are met: 966830Sobrien# 1. Redistributions of source code must retain the above copyright 1066830Sobrien# notice, this list of conditions and the following disclaimer. 1166830Sobrien# 2. Redistributions in binary form must reproduce the above copyright 1266830Sobrien# notice, this list of conditions and the following disclaimer in the 1366830Sobrien# documentation and/or other materials provided with the distribution. 1466830Sobrien# 1566830Sobrien# THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 1666830Sobrien# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 1766830Sobrien# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 1866830Sobrien# ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 1966830Sobrien# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 2066830Sobrien# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 2166830Sobrien# OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 2266830Sobrien# HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 2366830Sobrien# LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 2466830Sobrien# OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 2566830Sobrien# SUCH DAMAGE. 2666830Sobrien# 2751231Ssheldonh# $FreeBSD: head/etc/rc.initdiskless 179014 2008-05-15 11:00:23Z bms $ 28100280Sgordon 29108191Sdillon# On entry to this script the entire system consists of a read-only root 30127663Sluigi# mounted via NFS. The kernel has run BOOTP and configured an interface 31108191Sdillon# (otherwise it would not have been able to mount the NFS root!) 32108191Sdillon# 33127663Sluigi# We use the contents of /conf to create and populate memory filesystems 34127663Sluigi# that are mounted on top of this root to implement the writable 35127663Sluigi# (and host-specific) parts of the root filesystem, and other volatile 36127663Sluigi# filesystems. 37108191Sdillon# 38127663Sluigi# The hierarchy in /conf has the form /conf/T/M/ where M are directories 39127663Sluigi# for which memory filesystems will be created and filled, 40127663Sluigi# and T is one of the "template" directories below: 41108191Sdillon# 42127663Sluigi# base universal base, typically a replica of the original root; 43127663Sluigi# default secondary universal base, typically overriding some 44127663Sluigi# of the files in the original root; 45127663Sluigi# ${ipba} where ${ipba} is the assigned broadcast IP address 46149170Sbrooks# bcast/${ipba} same as above 47127663Sluigi# ${class} where ${class} is a list of directories supplied by 48127663Sluigi# bootp/dhcp through the T134 option. 49127663Sluigi# ${ipba} and ${class} are typicall used to configure features 50127663Sluigi# for group of diskless clients, or even individual features; 51127663Sluigi# ${ip} where ${ip} is the machine's assigned IP address, typically 52127663Sluigi# used to set host-specific features; 53149170Sbrooks# ip/${ip} same as above 54130151Sschweikh# 55127663Sluigi# Template directories are scanned in the order they are listed above, 56127663Sluigi# with each sucessive directory overriding (merged into) the previous one; 57149170Sbrooks# non-existing directories are ignored. The subdirectory forms exist to 58149170Sbrooks# help keep the top level /conf managable in large installations. 59108191Sdillon# 60127663Sluigi# The existence of a directory /conf/T/M causes this script to create a 61127663Sluigi# memory filesystem mounted as /M on the client. 62126787Sphk# 63127663Sluigi# Some files in /conf have special meaning, namely: 64108191Sdillon# 65127663Sluigi# Filename Action 66127663Sluigi# ---------------------------------------------------------------- 67127663Sluigi# /conf/T/M/remount 68127663Sluigi# The contents of the file is a mount command. E.g. if 69127663Sluigi# /conf/1.2.3.4/foo/remount contains "mount -o ro /dev/ad0s3", 70127663Sluigi# then /dev/ad0s3 will be be mounted on /conf/1.2.3.4/foo/ 71108191Sdillon# 72179014Sbms# /conf/T/M/remount_optional 73179014Sbms# If this file exists, then failure to execute the mount 74179014Sbms# command contained in /conf/T/M/remount is non-fatal. 75179014Sbms# 76127663Sluigi# /conf/T/M/diskless_remount 77164862Sluigi# The contents of the file points to an NFS filesystem, 78164862Sluigi# possibly followed by mount_nfs options. If the server name 79164862Sluigi# is omitted, the script will prepend the root path used when 80164862Sluigi# booting. E.g. if you booted from foo.com:/path/to/root, 81164862Sluigi# an entry for /conf/base/etc/diskless_remount could be any of 82164862Sluigi# foo.com:/path/to/root/etc 83164862Sluigi# /etc -o ro 84161824Sbrooks# Because mount_nfs understands ".." in paths, it is 85161824Sbrooks# possible to mount from locations above the NFS root with 86161824Sbrooks# paths such as "/../../etc". 87108191Sdillon# 88127663Sluigi# /conf/T/M/md_size 89127663Sluigi# The contents of the file specifies the size of the memory 90127663Sluigi# filesystem to be created, in 512 byte blocks. 91127663Sluigi# The default size is 10240 blocks (5MB). E.g. if 92127663Sluigi# /conf/base/etc/md_size contains "30000" then a 15MB MFS 93127663Sluigi# will be created. In case of multiple entries for the same 94127663Sluigi# directory M, the last one in the scanning order is used. 95127663Sluigi# NOTE: If you only need to create a memory filesystem but not 96127663Sluigi# initialize it from a template, it is preferrable to specify 97127663Sluigi# it in fstab e.g. as "md /tmp mfs -s=30m,rw 0 0" 98108191Sdillon# 99127663Sluigi# /conf/T/SUBDIR.cpio.gz 100127663Sluigi# The file is cpio'd into /SUBDIR (and a memory filesystem is 101127663Sluigi# created for /SUBDIR if necessary). The presence of this file 102127663Sluigi# prevents the copy from /conf/T/SUBDIR/ 103108191Sdillon# 104127663Sluigi# /conf/T/SUBDIR.remove 105127663Sluigi# The list of paths contained in the file are rm -rf'd 106127663Sluigi# relative to /SUBDIR. 107127663Sluigi# 108161824Sbrooks# /conf/diskless_remount 109161824Sbrooks# Similar to /conf/T/M/diskless_remount above, but allows 110161824Sbrooks# all of /conf to be remounted. This can be used to allow 111161824Sbrooks# multiple roots to share the same /conf. 112161824Sbrooks# 113161824Sbrooks# 114127663Sluigi# You will almost universally want to create the following files under /conf 115127663Sluigi# 116161533Sru# File Content 117161533Sru# ---------------------------- ---------------------------------- 118161533Sru# /conf/base/etc/md_size size of /etc filesystem 119161533Sru# /conf/base/etc/diskless_remount "/etc" 120161533Sru# /conf/default/etc/rc.conf generic diskless config parameters 121161533Sru# /conf/default/etc/fstab generic diskless fstab e.g. like this 122127663Sluigi# 123161533Sru# foo:/root_part / nfs ro 0 0 124161533Sru# foo:/usr_part /usr nfs ro 0 0 125161533Sru# foo:/home_part /home nfs rw 0 0 126161533Sru# md /tmp mfs -s=30m,rw 0 0 127161533Sru# md /var mfs -s=30m,rw 0 0 128161533Sru# proc /proc procfs rw 0 0 129127663Sluigi# 130127663Sluigi# plus, possibly, overrides for password files etc. 131127663Sluigi# 132127663Sluigi# NOTE! /var, /tmp, and /dev will be typically created elsewhere, e.g. 133127663Sluigi# as entries in the fstab as above. 134126868Sbrooks# Those filesystems should not be specified in /conf. 135127663Sluigi# 136127663Sluigi# (end of documentation, now get to the real code) 137108191Sdillon 138100280Sgordondlv=`/sbin/sysctl -n vfs.nfs.diskless_valid 2> /dev/null` 139100280Sgordon 140164862Sluigi# DEBUGGING 141164862Sluigi# log something on stdout if verbose. 142164862Sluigio_verbose=0 # set to 1 or 2 if you want more debugging 143164862Sluigilog() { 144164862Sluigi [ ${o_verbose} -gt 0 ] && echo "*** $* ***" 145164862Sluigi [ ${o_verbose} -gt 1 ] && read -p "=== Press enter to continue" foo 146164862Sluigi} 147164862Sluigi 14843803Sdillon# chkerr: 14943803Sdillon# 15043803Sdillon# Routine to check for error 15143803Sdillon# 15243803Sdillon# checks error code and drops into shell on failure. 15343803Sdillon# if shell exits, terminates script as well as /etc/rc. 154179014Sbms# if remount_optional exists under the mountpoint, skip this check. 15551231Ssheldonh# 156108191Sdillonchkerr() { 157179014Sbms lastitem () ( n=$(($# - 1)) ; shift $n ; echo $1 ) 158179014Sbms mountpoint="$(lastitem $2)" 159179014Sbms [ -r $mountpoint/remount_optional ] && ( echo "$2 failed: ignoring due to remount_optional" ; return ) 160108191Sdillon case $1 in 161108191Sdillon 0) 162108191Sdillon ;; 163108191Sdillon *) 164108191Sdillon echo "$2 failed: dropping into /bin/sh" 165108191Sdillon /bin/sh 166108191Sdillon # RESUME 167108191Sdillon ;; 168108191Sdillon esac 16943803Sdillon} 17043803Sdillon 171164862Sluigi# The list of filesystems to umount after the copy 172164862Sluigito_umount="" 173164862Sluigi 174164862Sluigihandle_remount() { # $1 = mount point 175164862Sluigi local nfspt mountopts b 176164862Sluigi b=$1 177164862Sluigi log handle_remount $1 178164862Sluigi [ -d $b -a -f $b/diskless_remount ] || return 179164862Sluigi read nfspt mountopts < $b/diskless_remount 180164862Sluigi log "nfspt ${nfspt} mountopts ${mountopts}" 181164862Sluigi # prepend the nfs root if not present 182164862Sluigi [ `expr "$nfspt" : '\(.\)'` = "/" ] && nfspt="${nfsroot}${nfspt}" 183164862Sluigi mount_nfs $mountopts $nfspt $b 184164862Sluigi chkerr $? "mount_nfs $nfspt $b" 185164862Sluigi to_umount="$b ${to_umount}" 186164862Sluigi} 187164862Sluigi 188108191Sdillon# Create a generic memory disk 189108191Sdillon# 190108191Sdillonmount_md() { 191154239Sbrooks /sbin/mdmfs -S -i 4096 -s $1 -M md $2 19275931Simp} 19375931Simp 194108191Sdillon# Create the memory filesystem if it has not already been created 195108191Sdillon# 196108191Sdilloncreate_md() { 197164862Sluigi [ "x`eval echo \\$md_created_$1`" = "x" ] || return # only once 198110942Sjhay if [ "x`eval echo \\$md_size_$1`" = "x" ]; then 199121014Skris md_size=10240 200108191Sdillon else 201108191Sdillon md_size=`eval echo \\$md_size_$1` 202108191Sdillon fi 203164862Sluigi log create_md $1 with size $md_size 204108191Sdillon mount_md $md_size /$1 205108191Sdillon /bin/chmod 755 /$1 206108191Sdillon eval md_created_$1=created 207108191Sdillon} 208108191Sdillon 20943803Sdillon# DEBUGGING 21043803Sdillon# 21155520Sluigi# set -v 21243803Sdillon 21351231Ssheldonh# Figure out our interface and IP. 21443803Sdillon# 21555520Sluigibootp_ifc="" 21655520Sluigibootp_ipa="" 21755520Sluigibootp_ipbca="" 218149170Sbrooksclass="" 219126787Sphkif [ ${dlv:=0} -ne 0 ] ; then 220126787Sphk iflist=`ifconfig -l` 221126787Sphk for i in ${iflist} ; do 222128706Sru set -- `ifconfig ${i}` 223126787Sphk while [ $# -ge 1 ] ; do 224126787Sphk if [ "${bootp_ifc}" = "" -a "$1" = "inet" ] ; then 225126787Sphk bootp_ifc=${i} ; bootp_ipa=${2} ; shift 226126787Sphk fi 227126787Sphk if [ "${bootp_ipbca}" = "" -a "$1" = "broadcast" ] ; then 228126787Sphk bootp_ipbca=$2; shift 229126787Sphk fi 230126787Sphk shift 231126787Sphk done 232126787Sphk if [ "${bootp_ifc}" != "" ] ; then 233126787Sphk break 234126787Sphk fi 235126787Sphk done 236149170Sbrooks # Get the values passed with the T134 bootp cookie. 237150169Srwatson class="`/sbin/sysctl -qn kern.bootp_cookie`" 238127657Sluigi 239149170Sbrooks echo "Interface ${bootp_ifc} IP-Address ${bootp_ipa} Broadcast ${bootp_ipbca} ${class}" 240126787Sphkfi 24143803Sdillon 242164862Sluigilog Figure out our NFS root path 243121067Sdougb# 244128706Sruset -- `mount -t nfs` 245117087Sbrookswhile [ $# -ge 1 ] ; do 246117087Sbrooks if [ "$2" = "on" -a "$3" = "/" ]; then 247117087Sbrooks nfsroot="$1" 248117087Sbrooks break 249117087Sbrooks fi 250117087Sbrooks shift 251117087Sbrooksdone 252117087Sbrooks 253127657Sluigi# The list of directories with template files 254149170Sbrookstemplates="base default" 255149170Sbrooksif [ -n "${bootp_ipbca}" ]; then 256149170Sbrooks templates="${templates} ${bootp_ipbca} bcast/${bootp_ipbca}" 257149170Sbrooksfi 258149170Sbrooksif [ -n "${class}" ]; then 259149170Sbrooks templates="${templates} ${class}" 260149170Sbrooksfi 261149170Sbrooksif [ -n "${bootp_ipa}" ]; then 262149170Sbrooks templates="${templates} ${bootp_ipa} ip/${bootp_ipa}" 263149170Sbrooksfi 264127657Sluigi 265161824Sbrooks# If /conf/diskless_remount exists, remount all of /conf. 266164862Sluigihandle_remount /conf 267126868Sbrooks 268108191Sdillon# Resolve templates in /conf/base, /conf/default, /conf/${bootp_ipbca}, 269121067Sdougb# and /conf/${bootp_ipa}. For each subdirectory found within these 270108191Sdillon# directories: 27143803Sdillon# 272108191Sdillon# - calculate memory filesystem sizes. If the subdirectory (prior to 273108191Sdillon# NFS remounting) contains the file 'md_size', the contents specified 274108191Sdillon# in 512 byte sectors will be used to size the memory filesystem. Otherwise 275108191Sdillon# 8192 sectors (4MB) is used. 276108191Sdillon# 277108191Sdillon# - handle NFS remounts. If the subdirectory contains the file 278108191Sdillon# diskless_remount, the contents of the file is NFS mounted over 279108191Sdillon# the directory. For example /conf/base/etc/diskless_remount 280108191Sdillon# might contain 'myserver:/etc'. NFS remounts allow you to avoid 281108191Sdillon# having to dup your system directories in /conf. Your server must 282108191Sdillon# be sure to export those filesystems -alldirs, however. 283117087Sbrooks# If the diskless_remount file contains a string beginning with a 284117087Sbrooks# '/' it is assumed that the local nfsroot should be prepended to 285117087Sbrooks# it before attemping to the remount. This allows the root to be 286117087Sbrooks# relocated without needing to change the remount files. 287108191Sdillon# 288164862Sluigilog "templates are ${templates}" 289127657Sluigifor i in ${templates} ; do 290108191Sdillon for j in /conf/$i/* ; do 291164862Sluigi [ -d $j ] || continue 292164862Sluigi 293108191Sdillon # memory filesystem size specification 294108191Sdillon subdir=${j##*/} 295164862Sluigi [ -f $j/md_size ] && eval md_size_$subdir=`cat $j/md_size` 29643803Sdillon 297164862Sluigi # remount. Beware, the command is in the file itself! 298164862Sluigi if [ -f $j/remount ]; then 299126787Sphk nfspt=`/bin/cat $j/remount` 300126787Sphk $nfspt $j 301126787Sphk chkerr $? "$nfspt $j" 302151916Sbrooks to_umount="$j ${to_umount}" # XXX hope it is really a mount! 303126787Sphk fi 304126787Sphk 305108191Sdillon # NFS remount 306164862Sluigi handle_remount $j 307108191Sdillon done 30875746Sbsddone 30975746Sbsd 310108191Sdillon# - Create all required MFS filesystems and populate them from 311108191Sdillon# our templates. Support both a direct template and a dir.cpio.gz 312108191Sdillon# archive. Support dir.remove files containing a list of relative 313108191Sdillon# paths to remove. 31495280Sobrien# 315127657Sluigi# The dir.cpio.gz form is there to make the copy process more efficient, 316127657Sluigi# so if the cpio archive is present, it prevents the files from dir/ 317127657Sluigi# from being copied. 31895280Sobrien 319127657Sluigifor i in ${templates} ; do 320108191Sdillon for j in /conf/$i/* ; do 321108191Sdillon subdir=${j##*/} 322127657Sluigi if [ -d $j -a ! -f $j.cpio.gz ]; then 323108191Sdillon create_md $subdir 324161824Sbrooks cp -Rp $j/ /$subdir 325108191Sdillon fi 326108191Sdillon done 327108191Sdillon for j in /conf/$i/*.cpio.gz ; do 328108191Sdillon subdir=${j%*.cpio.gz} 329108191Sdillon subdir=${subdir##*/} 330108191Sdillon if [ -f $j ]; then 331108191Sdillon create_md $subdir 332108191Sdillon echo "Loading /$subdir from cpio archive $j" 333151914Sbrooks (cd / ; /rescue/tar -xpf $j) 334108191Sdillon fi 335108191Sdillon done 336108191Sdillon for j in /conf/$i/*.remove ; do 337108191Sdillon subdir=${j%*.remove} 338108191Sdillon subdir=${subdir##*/} 339108191Sdillon if [ -f $j ]; then 340108191Sdillon # doubly sure it is a memory disk before rm -rf'ing 341108191Sdillon create_md $subdir 342108191Sdillon (cd /$subdir; rm -rf `/bin/cat $j`) 343108191Sdillon fi 344108191Sdillon done 345108191Sdillondone 346104334Sdd 347127657Sluigi# umount partitions used to fill the memory filesystems 348127657Sluigi[ -n "${to_umount}" ] && umount $to_umount 349