rc.initdiskless revision 130151
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 130151 2004-06-06 11:46:29Z schweikh $ 2851231Ssheldonh# 29128286Sbrooks# REQUIRE: preseedrandom 30100280Sgordon# PROVIDE: initdiskless 31126744Spjd# KEYWORD: FreeBSD nojail 32128713Sphk# BEFORE: ipfw 33100280Sgordon 34121067Sdougb 35108191Sdillon# On entry to this script the entire system consists of a read-only root 36127663Sluigi# mounted via NFS. The kernel has run BOOTP and configured an interface 37108191Sdillon# (otherwise it would not have been able to mount the NFS root!) 38108191Sdillon# 39127663Sluigi# We use the contents of /conf to create and populate memory filesystems 40127663Sluigi# that are mounted on top of this root to implement the writable 41127663Sluigi# (and host-specific) parts of the root filesystem, and other volatile 42127663Sluigi# filesystems. 43108191Sdillon# 44127663Sluigi# The hierarchy in /conf has the form /conf/T/M/ where M are directories 45127663Sluigi# for which memory filesystems will be created and filled, 46127663Sluigi# and T is one of the "template" directories below: 47108191Sdillon# 48127663Sluigi# base universal base, typically a replica of the original root; 49127663Sluigi# default secondary universal base, typically overriding some 50127663Sluigi# of the files in the original root; 51127663Sluigi# ${ipba} where ${ipba} is the assigned broadcast IP address 52127663Sluigi# ${class} where ${class} is a list of directories supplied by 53127663Sluigi# bootp/dhcp through the T134 option. 54127663Sluigi# ${ipba} and ${class} are typicall used to configure features 55127663Sluigi# for group of diskless clients, or even individual features; 56127663Sluigi# ${ip} where ${ip} is the machine's assigned IP address, typically 57127663Sluigi# used to set host-specific features; 58130151Sschweikh# 59127663Sluigi# Template directories are scanned in the order they are listed above, 60127663Sluigi# with each sucessive directory overriding (merged into) the previous one; 61127663Sluigi# non-existing directories are ignored. 62108191Sdillon# 63127663Sluigi# The existence of a directory /conf/T/M causes this script to create a 64127663Sluigi# memory filesystem mounted as /M on the client. 65126787Sphk# 66127663Sluigi# Some files in /conf have special meaning, namely: 67108191Sdillon# 68127663Sluigi# Filename Action 69127663Sluigi# ---------------------------------------------------------------- 70127663Sluigi# /conf/T/M/remount 71127663Sluigi# The contents of the file is a mount command. E.g. if 72127663Sluigi# /conf/1.2.3.4/foo/remount contains "mount -o ro /dev/ad0s3", 73127663Sluigi# then /dev/ad0s3 will be be mounted on /conf/1.2.3.4/foo/ 74108191Sdillon# 75127663Sluigi# /conf/T/M/diskless_remount 76127663Sluigi# The contents of the file points to an NFS filesystem. E.g. if 77127663Sluigi# /conf/base/etc/diskless_remount contains "foo.com:/etc", 78127663Sluigi# then foo.com:/etc will be be mounted on /conf/base/etc/ 79127663Sluigi# If the file contains a pathname starting with "/", then 80127663Sluigi# the root path is prepended to it; this allows relocation of 81127663Sluigi# the root filesystem withouth changing configuration files. 82108191Sdillon# 83127663Sluigi# /conf/T/M/md_size 84127663Sluigi# The contents of the file specifies the size of the memory 85127663Sluigi# filesystem to be created, in 512 byte blocks. 86127663Sluigi# The default size is 10240 blocks (5MB). E.g. if 87127663Sluigi# /conf/base/etc/md_size contains "30000" then a 15MB MFS 88127663Sluigi# will be created. In case of multiple entries for the same 89127663Sluigi# directory M, the last one in the scanning order is used. 90127663Sluigi# NOTE: If you only need to create a memory filesystem but not 91127663Sluigi# initialize it from a template, it is preferrable to specify 92127663Sluigi# it in fstab e.g. as "md /tmp mfs -s=30m,rw 0 0" 93108191Sdillon# 94127663Sluigi# /conf/T/SUBDIR.cpio.gz 95127663Sluigi# The file is cpio'd into /SUBDIR (and a memory filesystem is 96127663Sluigi# created for /SUBDIR if necessary). The presence of this file 97127663Sluigi# prevents the copy from /conf/T/SUBDIR/ 98108191Sdillon# 99127663Sluigi# /conf/T/SUBDIR.remove 100127663Sluigi# The list of paths contained in the file are rm -rf'd 101127663Sluigi# relative to /SUBDIR. 102127663Sluigi# 103127663Sluigi# You will almost universally want to create the following files under /conf 104127663Sluigi# 105127663Sluigi# File Content 106127663Sluigi# ---------------------------- ------------------------------------------ 107127663Sluigi# /conf/base/etc/md_size size of /etc filesystem 108127663Sluigi# /conf/base/diskless_remount "/etc" 109127663Sluigi# /conf/default/etc/rc.conf generic diskless config parameters 110127663Sluigi# /conf/default/etc/fstab generic diskless fstab e.g. like this 111127663Sluigi# 112127663Sluigi# foo:/root_part / nfs ro 0 0 113127663Sluigi# foo:/usr_part /usr nfs ro 0 0 114127663Sluigi# foo:/home_part /home nfs rw 0 0 115127663Sluigi# md /tmp mfs -s=30m,rw 0 0 116127663Sluigi# md /var mfs -s=30m,rw 0 0 117127663Sluigi# proc /proc procfs rw 0 0 118127663Sluigi# 119127663Sluigi# plus, possibly, overrides for password files etc. 120127663Sluigi# 121127663Sluigi# NOTE! /var, /tmp, and /dev will be typically created elsewhere, e.g. 122127663Sluigi# as entries in the fstab as above. 123126868Sbrooks# Those filesystems should not be specified in /conf. 124127663Sluigi# 125127663Sluigi# (end of documentation, now get to the real code) 126108191Sdillon 127100280Sgordondlv=`/sbin/sysctl -n vfs.nfs.diskless_valid 2> /dev/null` 128126787Sphk[ ${dlv:=0} -eq 0 ] && [ ! -f /etc/diskless ] && exit 0 129100280Sgordon 13043803Sdillon# chkerr: 13143803Sdillon# 13243803Sdillon# Routine to check for error 13343803Sdillon# 13443803Sdillon# checks error code and drops into shell on failure. 13543803Sdillon# if shell exits, terminates script as well as /etc/rc. 13651231Ssheldonh# 137108191Sdillonchkerr() { 138108191Sdillon case $1 in 139108191Sdillon 0) 140108191Sdillon ;; 141108191Sdillon *) 142108191Sdillon echo "$2 failed: dropping into /bin/sh" 143108191Sdillon /bin/sh 144108191Sdillon # RESUME 145108191Sdillon ;; 146108191Sdillon esac 14743803Sdillon} 14843803Sdillon 149108191Sdillon# Create a generic memory disk 150108191Sdillon# 151108191Sdillonmount_md() { 152108191Sdillon /sbin/mdmfs -i 4096 -s $1 -M md $2 15375931Simp} 15475931Simp 155108191Sdillon# Create the memory filesystem if it has not already been created 156108191Sdillon# 157108191Sdilloncreate_md() { 158108191Sdillon if [ "x`eval echo \\$md_created_$1`" = "x" ]; then 159110942Sjhay if [ "x`eval echo \\$md_size_$1`" = "x" ]; then 160121014Skris md_size=10240 161108191Sdillon else 162108191Sdillon md_size=`eval echo \\$md_size_$1` 163108191Sdillon fi 164108191Sdillon mount_md $md_size /$1 165108191Sdillon /bin/chmod 755 /$1 166108191Sdillon eval md_created_$1=created 167108191Sdillon fi 168108191Sdillon} 169108191Sdillon 17043803Sdillon# DEBUGGING 17143803Sdillon# 17255520Sluigi# set -v 17343803Sdillon 17451231Ssheldonh# Figure out our interface and IP. 17543803Sdillon# 17655520Sluigibootp_ifc="" 17755520Sluigibootp_ipa="" 17855520Sluigibootp_ipbca="" 179126787Sphkif [ ${dlv:=0} -ne 0 ] ; then 180126787Sphk iflist=`ifconfig -l` 181126787Sphk for i in ${iflist} ; do 182128706Sru set -- `ifconfig ${i}` 183126787Sphk while [ $# -ge 1 ] ; do 184126787Sphk if [ "${bootp_ifc}" = "" -a "$1" = "inet" ] ; then 185126787Sphk bootp_ifc=${i} ; bootp_ipa=${2} ; shift 186126787Sphk fi 187126787Sphk if [ "${bootp_ipbca}" = "" -a "$1" = "broadcast" ] ; then 188126787Sphk bootp_ipbca=$2; shift 189126787Sphk fi 190126787Sphk shift 191126787Sphk done 192126787Sphk if [ "${bootp_ifc}" != "" ] ; then 193126787Sphk break 194126787Sphk fi 195126787Sphk done 196127657Sluigi # Insert the directories passed with the T134 bootp cookie 197127657Sluigi # in the list of paths used for templates. 198127657Sluigi i="`/sbin/sysctl -n kern.bootp_cookie`" 199127657Sluigi [ "${i}" != "" ] && bootp_ipbca="${bootp_ipbca} ${i}" 200127657Sluigi 201126787Sphk echo "Interface ${bootp_ifc} IP-Address ${bootp_ipa} Broadcast ${bootp_ipbca}" 202126787Sphkfi 20343803Sdillon 204117087Sbrooks# Figure out our NFS root path 205121067Sdougb# 206128706Sruset -- `mount -t nfs` 207117087Sbrookswhile [ $# -ge 1 ] ; do 208117087Sbrooks if [ "$2" = "on" -a "$3" = "/" ]; then 209117087Sbrooks nfsroot="$1" 210117087Sbrooks break 211117087Sbrooks fi 212117087Sbrooks shift 213117087Sbrooksdone 214117087Sbrooks 215127657Sluigi# The list of directories with template files 216127657Sluigitemplates="base default ${bootp_ipbca} ${bootp_ipa}" 217127657Sluigi 218127657Sluigi# The list of filesystems to umount after the copy 219127657Sluigito_umount="" 220127657Sluigi 221126868Sbrooks# If /conf/diskless_remount exists, remount all of /conf. This allows 222126868Sbrooks# multiple roots to share the same conf files. 223126868Sbrooksif [ -d /conf -a -f /conf/diskless_remount ]; then 224126868Sbrooks nfspt=`/bin/cat /conf/diskless_remount` 225126868Sbrooks if [ `expr "$nfspt" : '\(.\)'` = "/" ]; then 226126868Sbrooks nfspt="${nfsroot}${nfspt}" 227126868Sbrooks fi 228126868Sbrooks mount_nfs $nfspt /conf 229126868Sbrooks chkerr $? "mount_nfs $nfspt /conf" 230127657Sluigi to_umount="/conf" 231126868Sbrooksfi 232126868Sbrooks 233108191Sdillon# Resolve templates in /conf/base, /conf/default, /conf/${bootp_ipbca}, 234121067Sdougb# and /conf/${bootp_ipa}. For each subdirectory found within these 235108191Sdillon# directories: 23643803Sdillon# 237108191Sdillon# - calculate memory filesystem sizes. If the subdirectory (prior to 238108191Sdillon# NFS remounting) contains the file 'md_size', the contents specified 239108191Sdillon# in 512 byte sectors will be used to size the memory filesystem. Otherwise 240108191Sdillon# 8192 sectors (4MB) is used. 241108191Sdillon# 242108191Sdillon# - handle NFS remounts. If the subdirectory contains the file 243108191Sdillon# diskless_remount, the contents of the file is NFS mounted over 244108191Sdillon# the directory. For example /conf/base/etc/diskless_remount 245108191Sdillon# might contain 'myserver:/etc'. NFS remounts allow you to avoid 246108191Sdillon# having to dup your system directories in /conf. Your server must 247108191Sdillon# be sure to export those filesystems -alldirs, however. 248117087Sbrooks# If the diskless_remount file contains a string beginning with a 249117087Sbrooks# '/' it is assumed that the local nfsroot should be prepended to 250117087Sbrooks# it before attemping to the remount. This allows the root to be 251117087Sbrooks# relocated without needing to change the remount files. 252108191Sdillon# 253127657Sluigifor i in ${templates} ; do 254108191Sdillon for j in /conf/$i/* ; do 255108191Sdillon # memory filesystem size specification 256108191Sdillon # 257108191Sdillon subdir=${j##*/} 258108191Sdillon if [ -d $j -a -f $j/md_size ]; then 259108191Sdillon eval md_size_$subdir=`cat $j/md_size` 260108191Sdillon fi 26143803Sdillon 262126787Sphk # remount 263126787Sphk # 264126787Sphk if [ -d $j -a -f $j/remount ]; then 265126787Sphk nfspt=`/bin/cat $j/remount` 266126787Sphk $nfspt $j 267126787Sphk chkerr $? "$nfspt $j" 268127657Sluigi to_umount="${to_umount} $j" # XXX hope it is really a mount! 269126787Sphk fi 270126787Sphk 271108191Sdillon # NFS remount 272108191Sdillon # 273108191Sdillon if [ -d $j -a -f $j/diskless_remount ]; then 274108191Sdillon nfspt=`/bin/cat $j/diskless_remount` 275117087Sbrooks if [ `expr "$nfspt" : '\(.\)'` = "/" ]; then 276117087Sbrooks nfspt="${nfsroot}${nfspt}" 277117087Sbrooks fi 278108191Sdillon mount_nfs $nfspt $j 279108191Sdillon chkerr $? "mount_nfs $nfspt $j" 280127657Sluigi to_umount="${to_umount} $j" 28175746Sbsd fi 282108191Sdillon done 28375746Sbsddone 28475746Sbsd 285108191Sdillon# - Create all required MFS filesystems and populate them from 286108191Sdillon# our templates. Support both a direct template and a dir.cpio.gz 287108191Sdillon# archive. Support dir.remove files containing a list of relative 288108191Sdillon# paths to remove. 28995280Sobrien# 290127657Sluigi# The dir.cpio.gz form is there to make the copy process more efficient, 291127657Sluigi# so if the cpio archive is present, it prevents the files from dir/ 292127657Sluigi# from being copied. 29395280Sobrien 294127657Sluigifor i in ${templates} ; do 295108191Sdillon for j in /conf/$i/* ; do 296108191Sdillon subdir=${j##*/} 297127657Sluigi if [ -d $j -a ! -f $j.cpio.gz ]; then 298108191Sdillon create_md $subdir 299108191Sdillon cp -Rp $j/* /$subdir 300108191Sdillon fi 301108191Sdillon done 302108191Sdillon for j in /conf/$i/*.cpio.gz ; do 303108191Sdillon subdir=${j%*.cpio.gz} 304108191Sdillon subdir=${subdir##*/} 305108191Sdillon if [ -f $j ]; then 306108191Sdillon create_md $subdir 307108191Sdillon echo "Loading /$subdir from cpio archive $j" 308108191Sdillon (cd / ; /stand/gzip -d < $j | /stand/cpio --extract -d ) 309108191Sdillon fi 310108191Sdillon done 311108191Sdillon for j in /conf/$i/*.remove ; do 312108191Sdillon subdir=${j%*.remove} 313108191Sdillon subdir=${subdir##*/} 314108191Sdillon if [ -f $j ]; then 315108191Sdillon # doubly sure it is a memory disk before rm -rf'ing 316108191Sdillon create_md $subdir 317108191Sdillon (cd /$subdir; rm -rf `/bin/cat $j`) 318108191Sdillon fi 319108191Sdillon done 320108191Sdillondone 321104334Sdd 322127657Sluigi# umount partitions used to fill the memory filesystems 323127657Sluigi[ -n "${to_umount}" ] && umount $to_umount 324