rc.initdiskless revision 151914
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 151914 2005-10-31 22:00:44Z brooks $ 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 73127663Sluigi# The contents of the file points to an NFS filesystem. E.g. if 74127663Sluigi# /conf/base/etc/diskless_remount contains "foo.com:/etc", 75127663Sluigi# then foo.com:/etc will be be mounted on /conf/base/etc/ 76127663Sluigi# If the file contains a pathname starting with "/", then 77127663Sluigi# the root path is prepended to it; this allows relocation of 78149556Sbmah# the root filesystem without changing configuration files. 79108191Sdillon# 80127663Sluigi# /conf/T/M/md_size 81127663Sluigi# The contents of the file specifies the size of the memory 82127663Sluigi# filesystem to be created, in 512 byte blocks. 83127663Sluigi# The default size is 10240 blocks (5MB). E.g. if 84127663Sluigi# /conf/base/etc/md_size contains "30000" then a 15MB MFS 85127663Sluigi# will be created. In case of multiple entries for the same 86127663Sluigi# directory M, the last one in the scanning order is used. 87127663Sluigi# NOTE: If you only need to create a memory filesystem but not 88127663Sluigi# initialize it from a template, it is preferrable to specify 89127663Sluigi# it in fstab e.g. as "md /tmp mfs -s=30m,rw 0 0" 90108191Sdillon# 91127663Sluigi# /conf/T/SUBDIR.cpio.gz 92127663Sluigi# The file is cpio'd into /SUBDIR (and a memory filesystem is 93127663Sluigi# created for /SUBDIR if necessary). The presence of this file 94127663Sluigi# prevents the copy from /conf/T/SUBDIR/ 95108191Sdillon# 96127663Sluigi# /conf/T/SUBDIR.remove 97127663Sluigi# The list of paths contained in the file are rm -rf'd 98127663Sluigi# relative to /SUBDIR. 99127663Sluigi# 100127663Sluigi# You will almost universally want to create the following files under /conf 101127663Sluigi# 102127663Sluigi# File Content 103127663Sluigi# ---------------------------- ------------------------------------------ 104127663Sluigi# /conf/base/etc/md_size size of /etc filesystem 105127663Sluigi# /conf/base/diskless_remount "/etc" 106127663Sluigi# /conf/default/etc/rc.conf generic diskless config parameters 107127663Sluigi# /conf/default/etc/fstab generic diskless fstab e.g. like this 108127663Sluigi# 109127663Sluigi# foo:/root_part / nfs ro 0 0 110127663Sluigi# foo:/usr_part /usr nfs ro 0 0 111127663Sluigi# foo:/home_part /home nfs rw 0 0 112127663Sluigi# md /tmp mfs -s=30m,rw 0 0 113127663Sluigi# md /var mfs -s=30m,rw 0 0 114127663Sluigi# proc /proc procfs rw 0 0 115127663Sluigi# 116127663Sluigi# plus, possibly, overrides for password files etc. 117127663Sluigi# 118127663Sluigi# NOTE! /var, /tmp, and /dev will be typically created elsewhere, e.g. 119127663Sluigi# as entries in the fstab as above. 120126868Sbrooks# Those filesystems should not be specified in /conf. 121127663Sluigi# 122127663Sluigi# (end of documentation, now get to the real code) 123108191Sdillon 124100280Sgordondlv=`/sbin/sysctl -n vfs.nfs.diskless_valid 2> /dev/null` 125100280Sgordon 12643803Sdillon# chkerr: 12743803Sdillon# 12843803Sdillon# Routine to check for error 12943803Sdillon# 13043803Sdillon# checks error code and drops into shell on failure. 13143803Sdillon# if shell exits, terminates script as well as /etc/rc. 13251231Ssheldonh# 133108191Sdillonchkerr() { 134108191Sdillon case $1 in 135108191Sdillon 0) 136108191Sdillon ;; 137108191Sdillon *) 138108191Sdillon echo "$2 failed: dropping into /bin/sh" 139108191Sdillon /bin/sh 140108191Sdillon # RESUME 141108191Sdillon ;; 142108191Sdillon esac 14343803Sdillon} 14443803Sdillon 145108191Sdillon# Create a generic memory disk 146108191Sdillon# 147108191Sdillonmount_md() { 148108191Sdillon /sbin/mdmfs -i 4096 -s $1 -M md $2 14975931Simp} 15075931Simp 151108191Sdillon# Create the memory filesystem if it has not already been created 152108191Sdillon# 153108191Sdilloncreate_md() { 154108191Sdillon if [ "x`eval echo \\$md_created_$1`" = "x" ]; then 155110942Sjhay if [ "x`eval echo \\$md_size_$1`" = "x" ]; then 156121014Skris md_size=10240 157108191Sdillon else 158108191Sdillon md_size=`eval echo \\$md_size_$1` 159108191Sdillon fi 160108191Sdillon mount_md $md_size /$1 161108191Sdillon /bin/chmod 755 /$1 162108191Sdillon eval md_created_$1=created 163108191Sdillon fi 164108191Sdillon} 165108191Sdillon 16643803Sdillon# DEBUGGING 16743803Sdillon# 16855520Sluigi# set -v 16943803Sdillon 17051231Ssheldonh# Figure out our interface and IP. 17143803Sdillon# 17255520Sluigibootp_ifc="" 17355520Sluigibootp_ipa="" 17455520Sluigibootp_ipbca="" 175149170Sbrooksclass="" 176126787Sphkif [ ${dlv:=0} -ne 0 ] ; then 177126787Sphk iflist=`ifconfig -l` 178126787Sphk for i in ${iflist} ; do 179128706Sru set -- `ifconfig ${i}` 180126787Sphk while [ $# -ge 1 ] ; do 181126787Sphk if [ "${bootp_ifc}" = "" -a "$1" = "inet" ] ; then 182126787Sphk bootp_ifc=${i} ; bootp_ipa=${2} ; shift 183126787Sphk fi 184126787Sphk if [ "${bootp_ipbca}" = "" -a "$1" = "broadcast" ] ; then 185126787Sphk bootp_ipbca=$2; shift 186126787Sphk fi 187126787Sphk shift 188126787Sphk done 189126787Sphk if [ "${bootp_ifc}" != "" ] ; then 190126787Sphk break 191126787Sphk fi 192126787Sphk done 193149170Sbrooks # Get the values passed with the T134 bootp cookie. 194150169Srwatson class="`/sbin/sysctl -qn kern.bootp_cookie`" 195127657Sluigi 196149170Sbrooks echo "Interface ${bootp_ifc} IP-Address ${bootp_ipa} Broadcast ${bootp_ipbca} ${class}" 197126787Sphkfi 19843803Sdillon 199117087Sbrooks# Figure out our NFS root path 200121067Sdougb# 201128706Sruset -- `mount -t nfs` 202117087Sbrookswhile [ $# -ge 1 ] ; do 203117087Sbrooks if [ "$2" = "on" -a "$3" = "/" ]; then 204117087Sbrooks nfsroot="$1" 205117087Sbrooks break 206117087Sbrooks fi 207117087Sbrooks shift 208117087Sbrooksdone 209117087Sbrooks 210127657Sluigi# The list of directories with template files 211149170Sbrookstemplates="base default" 212149170Sbrooksif [ -n "${bootp_ipbca}" ]; then 213149170Sbrooks templates="${templates} ${bootp_ipbca} bcast/${bootp_ipbca}" 214149170Sbrooksfi 215149170Sbrooksif [ -n "${class}" ]; then 216149170Sbrooks templates="${templates} ${class}" 217149170Sbrooksfi 218149170Sbrooksif [ -n "${bootp_ipa}" ]; then 219149170Sbrooks templates="${templates} ${bootp_ipa} ip/${bootp_ipa}" 220149170Sbrooksfi 221127657Sluigi 222127657Sluigi# The list of filesystems to umount after the copy 223127657Sluigito_umount="" 224127657Sluigi 225126868Sbrooks# If /conf/diskless_remount exists, remount all of /conf. This allows 226126868Sbrooks# multiple roots to share the same conf files. 227126868Sbrooksif [ -d /conf -a -f /conf/diskless_remount ]; then 228126868Sbrooks nfspt=`/bin/cat /conf/diskless_remount` 229126868Sbrooks if [ `expr "$nfspt" : '\(.\)'` = "/" ]; then 230126868Sbrooks nfspt="${nfsroot}${nfspt}" 231126868Sbrooks fi 232126868Sbrooks mount_nfs $nfspt /conf 233126868Sbrooks chkerr $? "mount_nfs $nfspt /conf" 234127657Sluigi to_umount="/conf" 235126868Sbrooksfi 236126868Sbrooks 237108191Sdillon# Resolve templates in /conf/base, /conf/default, /conf/${bootp_ipbca}, 238121067Sdougb# and /conf/${bootp_ipa}. For each subdirectory found within these 239108191Sdillon# directories: 24043803Sdillon# 241108191Sdillon# - calculate memory filesystem sizes. If the subdirectory (prior to 242108191Sdillon# NFS remounting) contains the file 'md_size', the contents specified 243108191Sdillon# in 512 byte sectors will be used to size the memory filesystem. Otherwise 244108191Sdillon# 8192 sectors (4MB) is used. 245108191Sdillon# 246108191Sdillon# - handle NFS remounts. If the subdirectory contains the file 247108191Sdillon# diskless_remount, the contents of the file is NFS mounted over 248108191Sdillon# the directory. For example /conf/base/etc/diskless_remount 249108191Sdillon# might contain 'myserver:/etc'. NFS remounts allow you to avoid 250108191Sdillon# having to dup your system directories in /conf. Your server must 251108191Sdillon# be sure to export those filesystems -alldirs, however. 252117087Sbrooks# If the diskless_remount file contains a string beginning with a 253117087Sbrooks# '/' it is assumed that the local nfsroot should be prepended to 254117087Sbrooks# it before attemping to the remount. This allows the root to be 255117087Sbrooks# relocated without needing to change the remount files. 256108191Sdillon# 257127657Sluigifor i in ${templates} ; do 258108191Sdillon for j in /conf/$i/* ; do 259108191Sdillon # memory filesystem size specification 260108191Sdillon # 261108191Sdillon subdir=${j##*/} 262108191Sdillon if [ -d $j -a -f $j/md_size ]; then 263108191Sdillon eval md_size_$subdir=`cat $j/md_size` 264108191Sdillon fi 26543803Sdillon 266126787Sphk # remount 267126787Sphk # 268126787Sphk if [ -d $j -a -f $j/remount ]; then 269126787Sphk nfspt=`/bin/cat $j/remount` 270126787Sphk $nfspt $j 271126787Sphk chkerr $? "$nfspt $j" 272127657Sluigi to_umount="${to_umount} $j" # XXX hope it is really a mount! 273126787Sphk fi 274126787Sphk 275108191Sdillon # NFS remount 276108191Sdillon # 277108191Sdillon if [ -d $j -a -f $j/diskless_remount ]; then 278108191Sdillon nfspt=`/bin/cat $j/diskless_remount` 279117087Sbrooks if [ `expr "$nfspt" : '\(.\)'` = "/" ]; then 280117087Sbrooks nfspt="${nfsroot}${nfspt}" 281117087Sbrooks fi 282108191Sdillon mount_nfs $nfspt $j 283108191Sdillon chkerr $? "mount_nfs $nfspt $j" 284127657Sluigi to_umount="${to_umount} $j" 28575746Sbsd fi 286108191Sdillon done 28775746Sbsddone 28875746Sbsd 289108191Sdillon# - Create all required MFS filesystems and populate them from 290108191Sdillon# our templates. Support both a direct template and a dir.cpio.gz 291108191Sdillon# archive. Support dir.remove files containing a list of relative 292108191Sdillon# paths to remove. 29395280Sobrien# 294127657Sluigi# The dir.cpio.gz form is there to make the copy process more efficient, 295127657Sluigi# so if the cpio archive is present, it prevents the files from dir/ 296127657Sluigi# from being copied. 29795280Sobrien 298127657Sluigifor i in ${templates} ; do 299108191Sdillon for j in /conf/$i/* ; do 300108191Sdillon subdir=${j##*/} 301127657Sluigi if [ -d $j -a ! -f $j.cpio.gz ]; then 302108191Sdillon create_md $subdir 303108191Sdillon cp -Rp $j/* /$subdir 304108191Sdillon fi 305108191Sdillon done 306108191Sdillon for j in /conf/$i/*.cpio.gz ; do 307108191Sdillon subdir=${j%*.cpio.gz} 308108191Sdillon subdir=${subdir##*/} 309108191Sdillon if [ -f $j ]; then 310108191Sdillon create_md $subdir 311108191Sdillon echo "Loading /$subdir from cpio archive $j" 312151914Sbrooks (cd / ; /rescue/tar -xpf $j) 313108191Sdillon fi 314108191Sdillon done 315108191Sdillon for j in /conf/$i/*.remove ; do 316108191Sdillon subdir=${j%*.remove} 317108191Sdillon subdir=${subdir##*/} 318108191Sdillon if [ -f $j ]; then 319108191Sdillon # doubly sure it is a memory disk before rm -rf'ing 320108191Sdillon create_md $subdir 321108191Sdillon (cd /$subdir; rm -rf `/bin/cat $j`) 322108191Sdillon fi 323108191Sdillon done 324108191Sdillondone 325104334Sdd 326127657Sluigi# umount partitions used to fill the memory filesystems 327127657Sluigi[ -n "${to_umount}" ] && umount $to_umount 328