xref: /freebsd/tools/tools/nanobsd/defaults.sh (revision 1c05a6ea6b849ff95e539c31adea887c644a6a01)
1#!/bin/sh
2#
3# Copyright (c) 2005 Poul-Henning Kamp.
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
30set -e
31
32#######################################################################
33#
34# Setup default values for all controlling variables.
35# These values can be overridden from the config file(s)
36#
37#######################################################################
38
39# Name of this NanoBSD build.  (Used to construct workdir names)
40NANO_NAME=full
41
42# Source tree directory
43NANO_SRC=/usr/src
44
45# Where nanobsd additional files live under the source tree
46NANO_TOOLS=tools/tools/nanobsd
47
48# Where cust_pkgng() finds packages to install
49NANO_PACKAGE_DIR=${NANO_SRC}/${NANO_TOOLS}/Pkg
50NANO_PACKAGE_LIST="*"
51
52# where package metadata gets placed
53NANO_PKG_META_BASE=/var/db
54
55# Path to mtree file to apply to anything copied by cust_install_files().
56# If you specify this, the mtree file *must* have an entry for every file and
57# directory located in Files.
58#NANO_CUST_FILES_MTREE=""
59
60# Object tree directory
61# default is subdir of /usr/obj
62#NANO_OBJ=""
63
64# The directory to put the final images
65# default is ${NANO_OBJ}
66#NANO_DISKIMGDIR=""
67
68# Make & parallel Make
69NANO_MAKE="make"
70NANO_PMAKE="make -j 3"
71
72# The default name for any image we create.
73NANO_IMGNAME="_.disk.full"
74NANO_IMG1NAME="_.disk.image"
75
76# Options to put in make.conf during buildworld only
77CONF_BUILD=' '
78
79# Options to put in make.conf during installworld only
80CONF_INSTALL=' '
81
82# Options to put in make.conf during both build- & installworld.
83CONF_WORLD=' '
84
85# Kernel config file to use
86NANO_KERNEL=GENERIC
87
88# Kernel modules to install. If empty, no modules are installed.
89# Use "default" to install all built modules.
90NANO_MODULES=
91
92# Early customize commands.
93NANO_EARLY_CUSTOMIZE=""
94
95# Customize commands.
96NANO_CUSTOMIZE=""
97
98# Late customize commands.
99NANO_LATE_CUSTOMIZE=""
100
101# Newfs parameters to use
102NANO_NEWFS="-b 4096 -f 512 -i 8192 -U"
103
104# The drive name of the media at runtime
105NANO_DRIVE=ada0
106
107# Target media size in 512 bytes sectors
108NANO_MEDIASIZE=2000000
109
110# Number of code images on media (1 or 2)
111NANO_IMAGES=2
112
113# 0 -> Leave second image all zeroes so it compresses better.
114# 1 -> Initialize second image with a copy of the first
115NANO_INIT_IMG2=1
116
117# Size of code file system in 512 bytes sectors
118# If zero, size will be as large as possible.
119NANO_CODESIZE=0
120
121# Size of configuration file system in 512 bytes sectors
122# Cannot be zero.
123NANO_CONFSIZE=2048
124
125# Size of data file system in 512 bytes sectors
126# If zero: no partition configured.
127# If negative: max size possible
128NANO_DATASIZE=0
129
130# Size of the /etc ramdisk in 512 bytes sectors
131NANO_RAM_ETCSIZE=10240
132
133# Size of the /tmp+/var ramdisk in 512 bytes sectors
134NANO_RAM_TMPVARSIZE=10240
135
136# boot0 flags/options and configuration
137NANO_BOOT0CFG="-o packet -s 1 -m 3"
138NANO_BOOTLOADER="boot/boot0sio"
139
140# boot2 flags/options
141# default force serial console
142NANO_BOOT2CFG="-h -S115200"
143
144# Backing type of md(4) device
145# Can be "file" or "swap"
146NANO_MD_BACKING="file"
147
148# for swap type md(4) backing, write out the mbr only
149NANO_IMAGE_MBRONLY=true
150
151# Progress Print level
152PPLEVEL=3
153
154# Set NANO_LABEL to non-blank to form the basis for using /dev/ufs/label
155# in preference to /dev/${NANO_DRIVE}
156# Root partition will be ${NANO_LABEL}s{1,2}
157# /cfg partition will be ${NANO_LABEL}s3
158# /data partition will be ${NANO_LABEL}s4
159NANO_LABEL=""
160NANO_SLICE_ROOT=s1
161NANO_SLICE_ALTROOT=s2
162NANO_SLICE_CFG=s3
163NANO_SLICE_DATA=s4
164NANO_ROOT=s1a
165NANO_ALTROOT=s2a
166
167# Default ownwership for nopriv build
168NANO_DEF_UNAME=root
169NANO_DEF_GNAME=wheel
170
171#######################################################################
172# Architecture to build.  Corresponds to TARGET_ARCH in a buildworld.
173# Unfortunately, there's no way to set TARGET at this time, and it
174# conflates the two, so architectures where TARGET != TARGET_ARCH and
175# TARGET can't be guessed from TARGET_ARCH do not work.  This defaults
176# to the arch of the current machine.
177NANO_ARCH=`uname -p`
178
179# CPUTYPE defaults to "" which is the default when CPUTYPE isn't
180# defined.
181NANO_CPUTYPE=""
182
183# Directory to populate /cfg from
184NANO_CFGDIR=""
185
186# Directory to populate /data from
187NANO_DATADIR=""
188
189# We don't need SRCCONF or SRC_ENV_CONF. NanoBSD puts everything we
190# need for the build in files included with __MAKE_CONF. Override in your
191# config file if you really must. We set them unconditionally here, though
192# in case they are stray in the build environment
193SRCCONF=/dev/null
194SRC_ENV_CONF=/dev/null
195
196#######################################################################
197#
198# The functions which do the real work.
199# Can be overridden from the config file(s)
200#
201#######################################################################
202
203# Export values into the shell. Must use { } instead of ( ) like
204# other functions to avoid a subshell.
205# We set __MAKE_CONF as a global since it is easier to get quoting
206# right for paths with spaces in them.
207make_export ( ) {
208	# Similar to export_var, except puts the data out to stdout
209	var=$1
210	eval val=\$$var
211	echo "Setting variable: $var=\"$val\""
212	export $1
213}
214
215nano_make_build_env ( ) {
216	__MAKE_CONF="${NANO_MAKE_CONF_BUILD}"
217	make_export __MAKE_CONF
218}
219
220nano_make_install_env ( ) {
221	__MAKE_CONF="${NANO_MAKE_CONF_INSTALL}"
222	make_export __MAKE_CONF
223}
224
225# Extra environment variables for kernel builds
226nano_make_kernel_env ( ) {
227	if [ -f "${NANO_KERNEL}" ] ; then
228		KERNCONFDIR="$(realpath $(dirname ${NANO_KERNEL}))"
229		KERNCONF="$(basename ${NANO_KERNEL})"
230		make_export KERNCONFDIR
231		make_export KERNCONF
232	else
233		export KERNCONF="${NANO_KERNEL}"
234		make_export KERNCONF
235	fi
236}
237
238nano_global_make_env ( ) (
239	# global settings for the make.conf file, if set
240	[ -z "${NANO_ARCH}" ] || echo TARGET_ARCH="${NANO_ARCH}"
241	[ -z "${NANO_CPUTYPE}" ] || echo TARGET_CPUTYPE="${NANO_CPUTYPE}"
242)
243
244# rm doesn't know -x prior to FreeBSD 10, so cope with a variety of build
245# hosts for now. This will go away when support in the base goes away.
246rm ( ) {
247    echo "NANO RM $*"
248	case $(uname -r) in
249	7*|8*|9*) command rm $* ;;
250	*) command rm -x $* ;;
251	esac
252}
253
254#
255# Create empty files in the target tree, and record the fact.  All paths
256# are relative to NANO_WORLDDIR.
257#
258tgt_touch ( ) (
259	cd "${NANO_WORLDDIR}"
260	for i; do
261		touch $i
262		echo "./${i} type=file" >> ${NANO_METALOG}
263	done
264)
265
266#
267# Convert a directory into a symlink. Takes two arguments, the
268# current directory and what it should become a symlink to. The
269# directory is removed and a symlink is created. If we're doing
270# a nopriv build, then append this fact to the metalog
271#
272tgt_dir2symlink ( ) (
273	dir=$1
274	symlink=$2
275
276	cd "${NANO_WORLDDIR}"
277	rm -rf "$dir"
278	ln -s "$symlink" "$dir"
279	if [ -n "$NANO_METALOG" ]; then
280		echo "./${dir} type=link mode=0777 link=${symlink}" >> ${NANO_METALOG}
281	fi
282)
283
284# run in the world chroot, errors fatal
285CR ( ) {
286	chroot "${NANO_WORLDDIR}" /bin/sh -exc "$*"
287}
288
289# run in the world chroot, errors not fatal
290CR0 ( ) {
291	chroot "${NANO_WORLDDIR}" /bin/sh -c "$*" || true
292}
293
294clean_build ( ) (
295	pprint 2 "Clean and create object directory (${MAKEOBJDIRPREFIX})"
296
297	if ! rm -rf ${MAKEOBJDIRPREFIX}/ > /dev/null 2>&1 ; then
298		chflags -R noschg ${MAKEOBJDIRPREFIX}/
299		rm -r ${MAKEOBJDIRPREFIX}/
300	fi
301)
302
303make_conf_build ( ) (
304	pprint 2 "Construct build make.conf ($NANO_MAKE_CONF_BUILD)"
305
306	mkdir -p ${MAKEOBJDIRPREFIX}
307	printenv > ${MAKEOBJDIRPREFIX}/_.env
308
309	# Make sure we get all the global settings that NanoBSD wants
310	# in addition to the user's global settings
311	(
312	nano_global_make_env
313	echo "${CONF_WORLD}"
314	echo "${CONF_BUILD}"
315	) > ${NANO_MAKE_CONF_BUILD}
316)
317
318build_world ( ) (
319	pprint 2 "run buildworld"
320	pprint 3 "log: ${MAKEOBJDIRPREFIX}/_.bw"
321
322	(
323	nano_make_build_env
324	set -o xtrace
325	cd "${NANO_SRC}"
326	${NANO_PMAKE} buildworld
327	) > ${MAKEOBJDIRPREFIX}/_.bw 2>&1
328)
329
330build_kernel ( ) (
331	pprint 2 "build kernel ($NANO_KERNEL)"
332	pprint 3 "log: ${MAKEOBJDIRPREFIX}/_.bk"
333
334	(
335	nano_make_build_env
336	nano_make_kernel_env
337
338	# Note: We intentionally build all modules, not only the ones in
339	# NANO_MODULES so the built world can be reused by multiple images.
340	# Although MODULES_OVERRIDE can be defined in the kernel config
341	# file to override this behavior. Just set NANO_MODULES=default.
342	set -o xtrace
343	cd "${NANO_SRC}"
344	${NANO_PMAKE} buildkernel
345	) > ${MAKEOBJDIRPREFIX}/_.bk 2>&1
346)
347
348clean_world ( ) (
349	if [ "${NANO_OBJ}" != "${MAKEOBJDIRPREFIX}" ]; then
350		pprint 2 "Clean and create object directory (${NANO_OBJ})"
351		if ! rm -rf ${NANO_OBJ}/ > /dev/null 2>&1 ; then
352			chflags -R noschg ${NANO_OBJ}
353			rm -r ${NANO_OBJ}/
354		fi
355		mkdir -p "${NANO_OBJ}" "${NANO_WORLDDIR}"
356		printenv > ${NANO_LOG}/_.env
357	else
358		pprint 2 "Clean and create world directory (${NANO_WORLDDIR})"
359		if ! rm -rf "${NANO_WORLDDIR}/" > /dev/null 2>&1 ; then
360			chflags -R noschg "${NANO_WORLDDIR}"
361			rm -rf "${NANO_WORLDDIR}/"
362		fi
363		mkdir -p "${NANO_WORLDDIR}"
364	fi
365)
366
367make_conf_install ( ) (
368	pprint 2 "Construct install make.conf ($NANO_MAKE_CONF_INSTALL)"
369
370	# Make sure we get all the global settings that NanoBSD wants
371	# in addition to the user's global settings
372	(
373	nano_global_make_env
374	echo "${CONF_WORLD}"
375	echo "${CONF_INSTALL}"
376	if [ -n "${NANO_NOPRIV_BUILD}" ]; then
377	    echo NO_ROOT=t
378	    echo METALOG=${NANO_METALOG}
379	fi
380	) >  ${NANO_MAKE_CONF_INSTALL}
381)
382
383install_world ( ) (
384	pprint 2 "installworld"
385	pprint 3 "log: ${NANO_LOG}/_.iw"
386
387	(
388	nano_make_install_env
389	set -o xtrace
390	cd "${NANO_SRC}"
391	${NANO_MAKE} installworld DESTDIR="${NANO_WORLDDIR}"
392	chflags -R noschg "${NANO_WORLDDIR}"
393	) > ${NANO_LOG}/_.iw 2>&1
394)
395
396install_etc ( ) (
397	pprint 2 "install /etc"
398	pprint 3 "log: ${NANO_LOG}/_.etc"
399
400	(
401	nano_make_install_env
402	set -o xtrace
403	cd "${NANO_SRC}"
404	${NANO_MAKE} distribution DESTDIR="${NANO_WORLDDIR}"
405	# make.conf doesn't get created by default, but some ports need it
406	# so they can spam it.
407	cp /dev/null "${NANO_WORLDDIR}"/etc/make.conf
408	) > ${NANO_LOG}/_.etc 2>&1
409)
410
411install_kernel ( ) (
412	pprint 2 "install kernel ($NANO_KERNEL)"
413	pprint 3 "log: ${NANO_LOG}/_.ik"
414
415	(
416
417	nano_make_install_env
418	nano_make_kernel_env
419
420	if [ "${NANO_MODULES}" != "default" ]; then
421		MODULES_OVERRIDE="${NANO_MODULES}"
422		make_export MODULES_OVERRIDE
423	fi
424
425	set -o xtrace
426	cd "${NANO_SRC}"
427	${NANO_MAKE} installkernel DESTDIR="${NANO_WORLDDIR}"
428
429	) > ${NANO_LOG}/_.ik 2>&1
430)
431
432native_xtools ( ) (
433	print 2 "Installing the optimized native build tools for cross env"
434	pprint 3 "log: ${NANO_LOG}/_.native_xtools"
435
436	(
437
438	nano_make_install_env
439	set -o xtrace
440	cd "${NANO_SRC}"
441	${NANO_MAKE} native-xtools NXBDESTDIR="${NANO_WORLDDIR}"
442
443	) > ${NANO_LOG}/_.native_xtools 2>&1
444)
445
446#
447# Run the requested set of early customization scripts, run before
448# buildworld.
449#
450run_early_customize ( ) {
451	pprint 2 "run early customize scripts"
452	for c in $NANO_EARLY_CUSTOMIZE
453	do
454		pprint 2 "early customize \"$c\""
455		pprint 3 "log: ${NANO_LOG}/_.early_cust.$c"
456		pprint 4 "`type $c`"
457		{ set -x ; $c ; set +x ; } >${NANO_LOG}/_.early_cust.$c 2>&1
458	done
459}
460
461#
462# Run the requested set of customization scripts, run after we've
463# done an installworld, installed the etc files, installed the kernel
464# and tweaked them in the standard way.
465#
466run_customize ( ) (
467
468	pprint 2 "run customize scripts"
469	for c in $NANO_CUSTOMIZE
470	do
471		pprint 2 "customize \"$c\""
472		pprint 3 "log: ${NANO_LOG}/_.cust.$c"
473		pprint 4 "`type $c`"
474		( set -x ; $c ) > ${NANO_LOG}/_.cust.$c 2>&1
475	done
476)
477
478#
479# Run any last-minute customization commands after we've had a chance to
480# setup nanobsd, prune empty dirs from /usr, etc
481#
482run_late_customize ( ) (
483	pprint 2 "run late customize scripts"
484	for c in $NANO_LATE_CUSTOMIZE
485	do
486		pprint 2 "late customize \"$c\""
487		pprint 3 "log: ${NANO_LOG}/_.late_cust.$c"
488		pprint 4 "`type $c`"
489		( set -x ; $c ) > ${NANO_LOG}/_.late_cust.$c 2>&1
490	done
491)
492
493#
494# Hook called after we run all the late customize commands, but
495# before we invoke the disk imager. The nopriv build uses it to
496# read in the meta log, apply the changes other parts of nanobsd
497# have been recording their actions. It's not anticipated that
498# a user's cfg file would override this.
499#
500fixup_before_diskimage ( ) (
501	# Run the deduplication script that takes the matalog journal and
502	# combines multiple entries for the same file (see source for
503	# details). We take the extra step of removing the size keywords. This
504	# script, and many of the user scripts, copies, appeneds and otherwise
505	# modifies files in the build, changing their sizes.  These actions are
506	# impossible to trap, so go ahead remove the size= keyword. For this
507	# narrow use, it doesn't buy us any protection and just gets in the way.
508	# The dedup tool's output must be sorted due to limitations in awk.
509	if [ -n "${NANO_METALOG}" ]; then
510		pprint 2 "Fixing metalog"
511		cp ${NANO_METALOG} ${NANO_METALOG}.pre
512		echo "/set uname=${NANO_DEF_UNAME} gname=${NANO_DEF_GNAME}" > ${NANO_METALOG}
513		cat ${NANO_METALOG}.pre | ${NANO_TOOLS}/mtree-dedup.awk | \
514		    sed -e 's/ size=[0-9][0-9]*//' | sort >> ${NANO_METALOG}
515	fi
516)
517
518setup_nanobsd ( ) (
519	pprint 2 "configure nanobsd setup"
520	pprint 3 "log: ${NANO_LOG}/_.dl"
521
522	(
523	cd "${NANO_WORLDDIR}"
524
525	# Move /usr/local/etc to /etc/local so that the /cfg stuff
526	# can stomp on it.  Otherwise packages like ipsec-tools which
527	# have hardcoded paths under ${prefix}/etc are not tweakable.
528	if [ -d usr/local/etc ] ; then
529		(
530		cd usr/local/etc
531		find . -print | cpio -dumpl ../../../etc/local
532		cd ..
533		rm -rf etc
534		)
535	fi
536
537	# Always setup the usr/local/etc -> etc/local symlink.
538	# usr/local/etc gets created by packages, but if no packages
539	# are installed by this point, but are later in the process,
540	# the symlink not being here causes problems. It never hurts
541	# to have the symlink in error though.
542	ln -s ../../etc/local usr/local/etc
543
544	for d in var etc
545	do
546		# link /$d under /conf
547		# we use hard links so we have them both places.
548		# the files in /$d will be hidden by the mount.
549		mkdir -p conf/base/$d conf/default/$d
550		find $d -print | cpio -dumpl conf/base/
551	done
552
553	echo "$NANO_RAM_ETCSIZE" > conf/base/etc/md_size
554	echo "$NANO_RAM_TMPVARSIZE" > conf/base/var/md_size
555
556	# pick up config files from the special partition
557	echo "mount -o ro /dev/${NANO_DRIVE}${NANO_SLICE_CFG}" > conf/default/etc/remount
558
559	# Put /tmp on the /var ramdisk (could be symlink already)
560	tgt_dir2symlink tmp var/tmp
561
562	) > ${NANO_LOG}/_.dl 2>&1
563)
564
565setup_nanobsd_etc ( ) (
566	pprint 2 "configure nanobsd /etc"
567
568	(
569	cd "${NANO_WORLDDIR}"
570
571	# create diskless marker file
572	touch etc/diskless
573
574	[ -n "${NANO_NOPRIV_BUILD}" ] && chmod 666 etc/defaults/rc.conf
575
576	# Make root filesystem R/O by default
577	echo "root_rw_mount=NO" >> etc/defaults/rc.conf
578	# Disable entropy file, since / is read-only /var/db/entropy should be enough?
579	echo "entropy_file=NO" >> etc/defaults/rc.conf
580
581	[ -n "${NANO_NOPRIV_BUILD}" ] && chmod 444 etc/defaults/rc.conf
582
583	# save config file for scripts
584	echo "NANO_DRIVE=${NANO_DRIVE}" > etc/nanobsd.conf
585
586	echo "/dev/${NANO_DRIVE}${NANO_ROOT} / ufs ro 1 1" > etc/fstab
587	echo "/dev/${NANO_DRIVE}${NANO_SLICE_CFG} /cfg ufs rw,noauto 2 2" >> etc/fstab
588	mkdir -p cfg
589
590	# Create directory for eventual /usr/local/etc contents
591	mkdir -p etc/local
592	)
593)
594
595prune_usr ( ) (
596	# Remove all empty directories in /usr
597	find "${NANO_WORLDDIR}"/usr -type d -depth -print |
598		while read d
599		do
600			rmdir $d > /dev/null 2>&1 || true
601		done
602)
603
604newfs_part ( ) (
605	local dev mnt lbl
606	dev=$1
607	mnt=$2
608	lbl=$3
609	echo newfs ${NANO_NEWFS} ${NANO_LABEL:+-L${NANO_LABEL}${lbl}} ${dev}
610	newfs ${NANO_NEWFS} ${NANO_LABEL:+-L${NANO_LABEL}${lbl}} ${dev}
611	mount -o async ${dev} ${mnt}
612)
613
614# Convenient spot to work around any umount issues that your build environment
615# hits by overriding this method.
616nano_umount ( ) (
617	umount ${1}
618)
619
620populate_slice ( ) (
621	local dev dir mnt lbl
622	dev=$1
623	dir=$2
624	mnt=$3
625	lbl=$4
626	echo "Creating ${dev} (mounting on ${mnt})"
627	newfs_part ${dev} ${mnt} ${lbl}
628	if [ -n "${dir}" -a -d "${dir}" ]; then
629		echo "Populating ${lbl} from ${dir}"
630		cd "${dir}"
631		find . -print | grep -Ev '/(CVS|\.svn|\.hg|\.git)/' | cpio -dumpv ${mnt}
632	fi
633	df -i ${mnt}
634	nano_umount ${mnt}
635)
636
637populate_cfg_slice ( ) (
638	populate_slice "$1" "$2" "$3" "$4"
639)
640
641populate_data_slice ( ) (
642	populate_slice "$1" "$2" "$3" "$4"
643)
644
645last_orders ( ) (
646	# Redefine this function with any last orders you may have
647	# after the build completed, for instance to copy the finished
648	# image to a more convenient place:
649	# cp ${NANO_DISKIMGDIR}/${NANO_IMG1NAME} /home/ftp/pub/nanobsd.disk
650	true
651)
652
653#######################################################################
654#
655# Optional convenience functions.
656#
657#######################################################################
658
659#######################################################################
660# Common Flash device geometries
661#
662
663FlashDevice ( ) {
664	if [ -d ${NANO_TOOLS} ] ; then
665		. ${NANO_TOOLS}/FlashDevice.sub
666	else
667		. ${NANO_SRC}/${NANO_TOOLS}/FlashDevice.sub
668	fi
669	sub_FlashDevice $1 $2
670}
671
672#######################################################################
673# USB device geometries
674#
675# Usage:
676#	UsbDevice Generic 1000	# a generic flash key sold as having 1GB
677#
678# This function will set NANO_MEDIASIZE, NANO_HEADS and NANO_SECTS for you.
679#
680# Note that the capacity of a flash key is usually advertised in MB or
681# GB, *not* MiB/GiB. As such, the precise number of cylinders available
682# for C/H/S geometry may vary depending on the actual flash geometry.
683#
684# The following generic device layouts are understood:
685#  generic           An alias for generic-hdd.
686#  generic-hdd       255H 63S/T xxxxC with no MBR restrictions.
687#  generic-fdd       64H 32S/T xxxxC with no MBR restrictions.
688#
689# The generic-hdd device is preferred for flash devices larger than 1GB.
690#
691
692UsbDevice ( ) {
693	a1=`echo $1 | tr '[:upper:]' '[:lower:]'`
694	case $a1 in
695	generic-fdd)
696		NANO_HEADS=64
697		NANO_SECTS=32
698		NANO_MEDIASIZE=$(( $2 * 1000 * 1000 / 512 ))
699		;;
700	generic|generic-hdd)
701		NANO_HEADS=255
702		NANO_SECTS=63
703		NANO_MEDIASIZE=$(( $2 * 1000 * 1000 / 512 ))
704		;;
705	*)
706		echo "Unknown USB flash device"
707		exit 2
708		;;
709	esac
710}
711
712#######################################################################
713# Setup serial console
714
715cust_comconsole ( ) (
716	# Enable getty on console
717	sed -i "" -e /tty[du]0/s/off/on/ ${NANO_WORLDDIR}/etc/ttys
718
719	# Disable getty on syscons devices
720	sed -i "" -e '/^ttyv[0-8]/s/	on/	off/' ${NANO_WORLDDIR}/etc/ttys
721
722	# Tell loader to use serial console early.
723	echo "${NANO_BOOT2CFG}" > ${NANO_WORLDDIR}/boot.config
724)
725
726#######################################################################
727# Allow root login via ssh
728
729cust_allow_ssh_root ( ) (
730	sed -i "" -e '/PermitRootLogin/s/.*/PermitRootLogin yes/' \
731	    ${NANO_WORLDDIR}/etc/ssh/sshd_config
732)
733
734#######################################################################
735# Install the stuff under ./Files
736
737cust_install_files ( ) (
738	cd "${NANO_TOOLS}/Files"
739	find . -print | grep -Ev '/(CVS|\.svn|\.hg|\.git)/' | cpio -Ldumpv ${NANO_WORLDDIR}
740
741	if [ -n "${NANO_CUST_FILES_MTREE}" -a -f ${NANO_CUST_FILES_MTREE} ]; then
742		CR "mtree -eiU -p /" <${NANO_CUST_FILES_MTREE}
743	fi
744)
745
746#######################################################################
747# Install packages from ${NANO_PACKAGE_DIR}
748
749cust_pkgng ( ) (
750	mkdir -p ${NANO_WORLDDIR}/usr/local/etc
751	local PKG_CONF="${NANO_WORLDDIR}/usr/local/etc/pkg.conf"
752	local PKGCMD="env BATCH=YES ASSUME_ALWAYS_YES=YES PKG_DBDIR=${NANO_PKG_META_BASE}/pkg SIGNATURE_TYPE=none /usr/sbin/pkg"
753
754	# Ensure pkg.conf points pkg to where the package meta data lives.
755	touch ${PKG_CONF}
756	if grep -Eiq '^PKG_DBDIR:.*' ${PKG_CONF}; then
757		sed -i -e "\|^PKG_DBDIR:.*|Is||PKG_DBDIR: "\"${NANO_PKG_META_BASE}/pkg\""|" ${PKG_CONF}
758	else
759		echo "PKG_DBDIR: \"${NANO_PKG_META_BASE}/pkg\"" >> ${PKG_CONF}
760	fi
761
762	# If the package directory doesn't exist, we're done.
763	if [ ! -d ${NANO_PACKAGE_DIR} ]; then
764		echo "DONE 0 packages"
765		return 0
766	fi
767
768	# Find a pkg-* package
769	for x in `find -s ${NANO_PACKAGE_DIR} -iname 'pkg-*'`; do
770		_NANO_PKG_PACKAGE=`basename "$x"`
771	done
772	if [ -z "${_NANO_PKG_PACKAGE}" -o ! -f "${NANO_PACKAGE_DIR}/${_NANO_PKG_PACKAGE}" ]; then
773		echo "FAILED: need a pkg/ package for bootstrapping"
774		exit 2
775	fi
776
777	# Mount packages into chroot
778	mkdir -p ${NANO_WORLDDIR}/_.p
779	mount -t nullfs -o noatime -o ro ${NANO_PACKAGE_DIR} ${NANO_WORLDDIR}/_.p
780
781	trap "umount ${NANO_WORLDDIR}/_.p ; rm -rf ${NANO_WORLDDIR}/_.p" 1 2 15 EXIT
782
783	# Install pkg-* package
784	CR "${PKGCMD} add /_.p/${_NANO_PKG_PACKAGE}"
785
786	(
787		# Expand any glob characters in pacakge list
788		cd "${NANO_PACKAGE_DIR}"
789		_PKGS=`find ${NANO_PACKAGE_LIST} -not -name "${_NANO_PKG_PACKAGE}" -print | sort | uniq`
790
791		# Show todo
792		todo=`echo "$_PKGS" | wc -l`
793		echo "=== TODO: $todo"
794		echo "$_PKGS"
795		echo "==="
796
797		# Install packages
798		for _PKG in $_PKGS; do
799			CR "${PKGCMD} add /_.p/${_PKG}"
800		done
801	)
802
803	CR0 "${PKGCMD} info"
804
805	trap - 1 2 15 EXIT
806	umount ${NANO_WORLDDIR}/_.p
807	rm -rf ${NANO_WORLDDIR}/_.p
808)
809
810#######################################################################
811# Convenience function:
812#	Register all args as early customize function to run just before
813#	build commences.
814
815early_customize_cmd ( ) {
816	NANO_EARLY_CUSTOMIZE="$NANO_EARLY_CUSTOMIZE $*"
817}
818
819#######################################################################
820# Convenience function:
821# 	Register all args as customize function.
822
823customize_cmd ( ) {
824	NANO_CUSTOMIZE="$NANO_CUSTOMIZE $*"
825}
826
827#######################################################################
828# Convenience function:
829# 	Register all args as late customize function to run just before
830#	image creation.
831
832late_customize_cmd ( ) {
833	NANO_LATE_CUSTOMIZE="$NANO_LATE_CUSTOMIZE $*"
834}
835
836#######################################################################
837#
838# All set up to go...
839#
840#######################################################################
841
842# Progress Print
843#	Print $2 at level $1.
844pprint ( ) (
845    if [ "$1" -le $PPLEVEL ]; then
846	runtime=$(( `date +%s` - $NANO_STARTTIME ))
847	printf "%s %.${1}s %s\n" "`date -u -r $runtime +%H:%M:%S`" "#####" "$2" 1>&3
848    fi
849)
850
851usage ( ) {
852	(
853	echo "Usage: $0 [-bfhiKknqvwX] [-c config_file]"
854	echo "	-b	suppress builds (both kernel and world)"
855	echo "	-c	specify config file"
856	echo "	-f	suppress code slice extraction"
857	echo "	-h	print this help summary page"
858	echo "	-i	suppress disk image build"
859	echo "	-K	suppress installkernel"
860	echo "	-k	suppress buildkernel"
861	echo "	-n	add -DNO_CLEAN to buildworld, buildkernel, etc"
862	echo "	-q	make output more quiet"
863	echo "	-v	make output more verbose"
864	echo "	-w	suppress buildworld"
865	echo "	-X	make native-xtools"
866	) 1>&2
867	exit 2
868}
869
870#######################################################################
871# Setup and Export Internal variables
872#
873
874export_var ( ) {		# Don't wawnt a subshell
875	var=$1
876	# Lookup value of the variable.
877	eval val=\$$var
878	pprint 3 "Setting variable: $var=\"$val\""
879	export $1
880}
881
882# Call this function to set defaults _after_ parsing options.
883# dont want a subshell otherwise variable setting is thrown away.
884set_defaults_and_export ( ) {
885	: ${NANO_OBJ:=/usr/obj/nanobsd.${NANO_NAME}}
886	: ${MAKEOBJDIRPREFIX:=${NANO_OBJ}}
887	: ${NANO_DISKIMGDIR:=${NANO_OBJ}}
888	: ${NANO_WORLDDIR:=${NANO_OBJ}/_.w}
889	: ${NANO_LOG:=${NANO_OBJ}}
890	NANO_MAKE_CONF_BUILD=${MAKEOBJDIRPREFIX}/make.conf.build
891	NANO_MAKE_CONF_INSTALL=${NANO_OBJ}/make.conf.install
892
893	# Override user's NANO_DRIVE if they specified a NANO_LABEL
894	[ -n "${NANO_LABEL}" ] && NANO_DRIVE="ufs/${NANO_LABEL}" || true
895
896	# Set a default NANO_TOOLS to NANO_SRC/NANO_TOOLS if it exists.
897	[ ! -d "${NANO_TOOLS}" ] && [ -d "${NANO_SRC}/${NANO_TOOLS}" ] && \
898		NANO_TOOLS="${NANO_SRC}/${NANO_TOOLS}" || true
899
900	[ -n "${NANO_NOPRIV_BUILD}" ] && [ -z "${NANO_METALOG}" ] && \
901		NANO_METALOG=${NANO_OBJ}/_.metalog || true
902
903	NANO_STARTTIME=`date +%s`
904	pprint 3 "Exporting NanoBSD variables"
905	export_var MAKEOBJDIRPREFIX
906	export_var NANO_ARCH
907	export_var NANO_CODESIZE
908	export_var NANO_CONFSIZE
909	export_var NANO_CUSTOMIZE
910	export_var NANO_DATASIZE
911	export_var NANO_DRIVE
912	export_var NANO_HEADS
913	export_var NANO_IMAGES
914	export_var NANO_IMGNAME
915	export_var NANO_IMG1NAME
916	export_var NANO_MAKE
917	export_var NANO_MAKE_CONF_BUILD
918	export_var NANO_MAKE_CONF_INSTALL
919	export_var NANO_MEDIASIZE
920	export_var NANO_NAME
921	export_var NANO_NEWFS
922	export_var NANO_OBJ
923	export_var NANO_PMAKE
924	export_var NANO_SECTS
925	export_var NANO_SRC
926	export_var NANO_TOOLS
927	export_var NANO_WORLDDIR
928	export_var NANO_BOOT0CFG
929	export_var NANO_BOOTLOADER
930	export_var NANO_LABEL
931	export_var NANO_MODULES
932	export_var NANO_NOPRIV_BUILD
933	export_var NANO_METALOG
934	export_var NANO_LOG
935	export_var SRCCONF
936	export_var SRC_ENV_CONF
937}
938