rc.initdiskless revision 164862
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 164862 2006-12-03 23:50:29Z luigi $ 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# 72127663Sluigi# /conf/T/M/diskless_remount 73164862Sluigi# The contents of the file points to an NFS filesystem, 74164862Sluigi# possibly followed by mount_nfs options. If the server name 75164862Sluigi# is omitted, the script will prepend the root path used when 76164862Sluigi# booting. E.g. if you booted from foo.com:/path/to/root, 77164862Sluigi# an entry for /conf/base/etc/diskless_remount could be any of 78164862Sluigi# foo.com:/path/to/root/etc 79164862Sluigi# /etc -o ro 80161824Sbrooks# Because mount_nfs understands ".." in paths, it is 81161824Sbrooks# possible to mount from locations above the NFS root with 82161824Sbrooks# paths such as "/../../etc". 83108191Sdillon# 84127663Sluigi# /conf/T/M/md_size 85127663Sluigi# The contents of the file specifies the size of the memory 86127663Sluigi# filesystem to be created, in 512 byte blocks. 87127663Sluigi# The default size is 10240 blocks (5MB). E.g. if 88127663Sluigi# /conf/base/etc/md_size contains "30000" then a 15MB MFS 89127663Sluigi# will be created. In case of multiple entries for the same 90127663Sluigi# directory M, the last one in the scanning order is used. 91127663Sluigi# NOTE: If you only need to create a memory filesystem but not 92127663Sluigi# initialize it from a template, it is preferrable to specify 93127663Sluigi# it in fstab e.g. as "md /tmp mfs -s=30m,rw 0 0" 94108191Sdillon# 95127663Sluigi# /conf/T/SUBDIR.cpio.gz 96127663Sluigi# The file is cpio'd into /SUBDIR (and a memory filesystem is 97127663Sluigi# created for /SUBDIR if necessary). The presence of this file 98127663Sluigi# prevents the copy from /conf/T/SUBDIR/ 99108191Sdillon# 100127663Sluigi# /conf/T/SUBDIR.remove 101127663Sluigi# The list of paths contained in the file are rm -rf'd 102127663Sluigi# relative to /SUBDIR. 103127663Sluigi# 104161824Sbrooks# /conf/diskless_remount 105161824Sbrooks# Similar to /conf/T/M/diskless_remount above, but allows 106161824Sbrooks# all of /conf to be remounted. This can be used to allow 107161824Sbrooks# multiple roots to share the same /conf. 108161824Sbrooks# 109161824Sbrooks# 110127663Sluigi# You will almost universally want to create the following files under /conf 111127663Sluigi# 112161533Sru# File Content 113161533Sru# ---------------------------- ---------------------------------- 114161533Sru# /conf/base/etc/md_size size of /etc filesystem 115161533Sru# /conf/base/etc/diskless_remount "/etc" 116161533Sru# /conf/default/etc/rc.conf generic diskless config parameters 117161533Sru# /conf/default/etc/fstab generic diskless fstab e.g. like this 118127663Sluigi# 119161533Sru# foo:/root_part / nfs ro 0 0 120161533Sru# foo:/usr_part /usr nfs ro 0 0 121161533Sru# foo:/home_part /home nfs rw 0 0 122161533Sru# md /tmp mfs -s=30m,rw 0 0 123161533Sru# md /var mfs -s=30m,rw 0 0 124161533Sru# proc /proc procfs rw 0 0 125127663Sluigi# 126127663Sluigi# plus, possibly, overrides for password files etc. 127127663Sluigi# 128127663Sluigi# NOTE! /var, /tmp, and /dev will be typically created elsewhere, e.g. 129127663Sluigi# as entries in the fstab as above. 130126868Sbrooks# Those filesystems should not be specified in /conf. 131127663Sluigi# 132127663Sluigi# (end of documentation, now get to the real code) 133108191Sdillon 134100280Sgordondlv=`/sbin/sysctl -n vfs.nfs.diskless_valid 2> /dev/null` 135100280Sgordon 136164862Sluigi# DEBUGGING 137164862Sluigi# log something on stdout if verbose. 138164862Sluigio_verbose=0 # set to 1 or 2 if you want more debugging 139164862Sluigilog() { 140164862Sluigi [ ${o_verbose} -gt 0 ] && echo "*** $* ***" 141164862Sluigi [ ${o_verbose} -gt 1 ] && read -p "=== Press enter to continue" foo 142164862Sluigi} 143164862Sluigi 14443803Sdillon# chkerr: 14543803Sdillon# 14643803Sdillon# Routine to check for error 14743803Sdillon# 14843803Sdillon# checks error code and drops into shell on failure. 14943803Sdillon# if shell exits, terminates script as well as /etc/rc. 15051231Ssheldonh# 151108191Sdillonchkerr() { 152108191Sdillon case $1 in 153108191Sdillon 0) 154108191Sdillon ;; 155108191Sdillon *) 156108191Sdillon echo "$2 failed: dropping into /bin/sh" 157108191Sdillon /bin/sh 158108191Sdillon # RESUME 159108191Sdillon ;; 160108191Sdillon esac 16143803Sdillon} 16243803Sdillon 163164862Sluigi# The list of filesystems to umount after the copy 164164862Sluigito_umount="" 165164862Sluigi 166164862Sluigihandle_remount() { # $1 = mount point 167164862Sluigi local nfspt mountopts b 168164862Sluigi b=$1 169164862Sluigi log handle_remount $1 170164862Sluigi [ -d $b -a -f $b/diskless_remount ] || return 171164862Sluigi read nfspt mountopts < $b/diskless_remount 172164862Sluigi log "nfspt ${nfspt} mountopts ${mountopts}" 173164862Sluigi # prepend the nfs root if not present 174164862Sluigi [ `expr "$nfspt" : '\(.\)'` = "/" ] && nfspt="${nfsroot}${nfspt}" 175164862Sluigi mount_nfs $mountopts $nfspt $b 176164862Sluigi chkerr $? "mount_nfs $nfspt $b" 177164862Sluigi to_umount="$b ${to_umount}" 178164862Sluigi} 179164862Sluigi 180108191Sdillon# Create a generic memory disk 181108191Sdillon# 182108191Sdillonmount_md() { 183154239Sbrooks /sbin/mdmfs -S -i 4096 -s $1 -M md $2 18475931Simp} 18575931Simp 186108191Sdillon# Create the memory filesystem if it has not already been created 187108191Sdillon# 188108191Sdilloncreate_md() { 189164862Sluigi [ "x`eval echo \\$md_created_$1`" = "x" ] || return # only once 190110942Sjhay if [ "x`eval echo \\$md_size_$1`" = "x" ]; then 191121014Skris md_size=10240 192108191Sdillon else 193108191Sdillon md_size=`eval echo \\$md_size_$1` 194108191Sdillon fi 195164862Sluigi log create_md $1 with size $md_size 196108191Sdillon mount_md $md_size /$1 197108191Sdillon /bin/chmod 755 /$1 198108191Sdillon eval md_created_$1=created 199108191Sdillon} 200108191Sdillon 20143803Sdillon# DEBUGGING 20243803Sdillon# 20355520Sluigi# set -v 20443803Sdillon 20551231Ssheldonh# Figure out our interface and IP. 20643803Sdillon# 20755520Sluigibootp_ifc="" 20855520Sluigibootp_ipa="" 20955520Sluigibootp_ipbca="" 210149170Sbrooksclass="" 211126787Sphkif [ ${dlv:=0} -ne 0 ] ; then 212126787Sphk iflist=`ifconfig -l` 213126787Sphk for i in ${iflist} ; do 214128706Sru set -- `ifconfig ${i}` 215126787Sphk while [ $# -ge 1 ] ; do 216126787Sphk if [ "${bootp_ifc}" = "" -a "$1" = "inet" ] ; then 217126787Sphk bootp_ifc=${i} ; bootp_ipa=${2} ; shift 218126787Sphk fi 219126787Sphk if [ "${bootp_ipbca}" = "" -a "$1" = "broadcast" ] ; then 220126787Sphk bootp_ipbca=$2; shift 221126787Sphk fi 222126787Sphk shift 223126787Sphk done 224126787Sphk if [ "${bootp_ifc}" != "" ] ; then 225126787Sphk break 226126787Sphk fi 227126787Sphk done 228149170Sbrooks # Get the values passed with the T134 bootp cookie. 229150169Srwatson class="`/sbin/sysctl -qn kern.bootp_cookie`" 230127657Sluigi 231149170Sbrooks echo "Interface ${bootp_ifc} IP-Address ${bootp_ipa} Broadcast ${bootp_ipbca} ${class}" 232126787Sphkfi 23343803Sdillon 234164862Sluigilog Figure out our NFS root path 235121067Sdougb# 236128706Sruset -- `mount -t nfs` 237117087Sbrookswhile [ $# -ge 1 ] ; do 238117087Sbrooks if [ "$2" = "on" -a "$3" = "/" ]; then 239117087Sbrooks nfsroot="$1" 240117087Sbrooks break 241117087Sbrooks fi 242117087Sbrooks shift 243117087Sbrooksdone 244117087Sbrooks 245127657Sluigi# The list of directories with template files 246149170Sbrookstemplates="base default" 247149170Sbrooksif [ -n "${bootp_ipbca}" ]; then 248149170Sbrooks templates="${templates} ${bootp_ipbca} bcast/${bootp_ipbca}" 249149170Sbrooksfi 250149170Sbrooksif [ -n "${class}" ]; then 251149170Sbrooks templates="${templates} ${class}" 252149170Sbrooksfi 253149170Sbrooksif [ -n "${bootp_ipa}" ]; then 254149170Sbrooks templates="${templates} ${bootp_ipa} ip/${bootp_ipa}" 255149170Sbrooksfi 256127657Sluigi 257161824Sbrooks# If /conf/diskless_remount exists, remount all of /conf. 258164862Sluigihandle_remount /conf 259126868Sbrooks 260108191Sdillon# Resolve templates in /conf/base, /conf/default, /conf/${bootp_ipbca}, 261121067Sdougb# and /conf/${bootp_ipa}. For each subdirectory found within these 262108191Sdillon# directories: 26343803Sdillon# 264108191Sdillon# - calculate memory filesystem sizes. If the subdirectory (prior to 265108191Sdillon# NFS remounting) contains the file 'md_size', the contents specified 266108191Sdillon# in 512 byte sectors will be used to size the memory filesystem. Otherwise 267108191Sdillon# 8192 sectors (4MB) is used. 268108191Sdillon# 269108191Sdillon# - handle NFS remounts. If the subdirectory contains the file 270108191Sdillon# diskless_remount, the contents of the file is NFS mounted over 271108191Sdillon# the directory. For example /conf/base/etc/diskless_remount 272108191Sdillon# might contain 'myserver:/etc'. NFS remounts allow you to avoid 273108191Sdillon# having to dup your system directories in /conf. Your server must 274108191Sdillon# be sure to export those filesystems -alldirs, however. 275117087Sbrooks# If the diskless_remount file contains a string beginning with a 276117087Sbrooks# '/' it is assumed that the local nfsroot should be prepended to 277117087Sbrooks# it before attemping to the remount. This allows the root to be 278117087Sbrooks# relocated without needing to change the remount files. 279108191Sdillon# 280164862Sluigilog "templates are ${templates}" 281127657Sluigifor i in ${templates} ; do 282108191Sdillon for j in /conf/$i/* ; do 283164862Sluigi [ -d $j ] || continue 284164862Sluigi 285108191Sdillon # memory filesystem size specification 286108191Sdillon subdir=${j##*/} 287164862Sluigi [ -f $j/md_size ] && eval md_size_$subdir=`cat $j/md_size` 28843803Sdillon 289164862Sluigi # remount. Beware, the command is in the file itself! 290164862Sluigi if [ -f $j/remount ]; then 291126787Sphk nfspt=`/bin/cat $j/remount` 292126787Sphk $nfspt $j 293126787Sphk chkerr $? "$nfspt $j" 294151916Sbrooks to_umount="$j ${to_umount}" # XXX hope it is really a mount! 295126787Sphk fi 296126787Sphk 297108191Sdillon # NFS remount 298164862Sluigi handle_remount $j 299108191Sdillon done 30075746Sbsddone 30175746Sbsd 302108191Sdillon# - Create all required MFS filesystems and populate them from 303108191Sdillon# our templates. Support both a direct template and a dir.cpio.gz 304108191Sdillon# archive. Support dir.remove files containing a list of relative 305108191Sdillon# paths to remove. 30695280Sobrien# 307127657Sluigi# The dir.cpio.gz form is there to make the copy process more efficient, 308127657Sluigi# so if the cpio archive is present, it prevents the files from dir/ 309127657Sluigi# from being copied. 31095280Sobrien 311127657Sluigifor i in ${templates} ; do 312108191Sdillon for j in /conf/$i/* ; do 313108191Sdillon subdir=${j##*/} 314127657Sluigi if [ -d $j -a ! -f $j.cpio.gz ]; then 315108191Sdillon create_md $subdir 316161824Sbrooks cp -Rp $j/ /$subdir 317108191Sdillon fi 318108191Sdillon done 319108191Sdillon for j in /conf/$i/*.cpio.gz ; do 320108191Sdillon subdir=${j%*.cpio.gz} 321108191Sdillon subdir=${subdir##*/} 322108191Sdillon if [ -f $j ]; then 323108191Sdillon create_md $subdir 324108191Sdillon echo "Loading /$subdir from cpio archive $j" 325151914Sbrooks (cd / ; /rescue/tar -xpf $j) 326108191Sdillon fi 327108191Sdillon done 328108191Sdillon for j in /conf/$i/*.remove ; do 329108191Sdillon subdir=${j%*.remove} 330108191Sdillon subdir=${subdir##*/} 331108191Sdillon if [ -f $j ]; then 332108191Sdillon # doubly sure it is a memory disk before rm -rf'ing 333108191Sdillon create_md $subdir 334108191Sdillon (cd /$subdir; rm -rf `/bin/cat $j`) 335108191Sdillon fi 336108191Sdillon done 337108191Sdillondone 338104334Sdd 339127657Sluigi# umount partitions used to fill the memory filesystems 340127657Sluigi[ -n "${to_umount}" ] && umount $to_umount 341