4 # Copyright (c) 2015 M. Warner Losh.
5 # Copyright (c) 2010-2011 iXsystems, Inc.
7 # Redistribution and use in source and binary forms, with or without
8 # modification, are permitted provided that the following conditions
10 # 1. Redistributions of source code must retain the above copyright
11 # notice, this list of conditions and the following disclaimer.
12 # 2. Redistributions in binary form must reproduce the above copyright
13 # notice, this list of conditions and the following disclaimer in the
14 # documentation and/or other materials provided with the distribution.
16 # THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17 # ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 # IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 # ARE DISCLAIMED. IN NO EVENT SHALL iXsystems, Inc OR CONTRIBUTORS BE LIABLE
20 # FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21 # DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22 # OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 # HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24 # LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 # OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29 # This file is heavily derived from both Sam Leffler's Avilia config,
30 # as well as the BSDRP project's config file. Neither of these have
31 # an explicit copyright/license statement, but are implicitly BSDL. This
32 # example has been taken from the FreeNAS project (an early version) and
33 # simplified to meet the needs of the example.
36 # NB: You want the other file as the command line arg :)
39 # o mkimg setting active partition
40 # o mkimg starting at arbitrary offset (needed for A10, et al)
41 # o mtools still needed because we have no makefs -t msdos
42 # o nanobsd doesn't record changes to WORLDTEMP in customization
43 # scripts yet, so we have kludge to pick up all files
44 # o easy way for pkg to grab files from other repos and put that
46 # o Need to have some way to create / resize the s4 slice to do ping
47 # pong bouncing between s3 and s4 for an arbitrary image. we can resize
49 # o hints in the uboot ports for how to create the image
52 # o documentation for how to run the qemu images
53 # o msdos mtools fallback
54 # o special boot for !x86 !arm platforms
55 # o qemu image for arm
56 # o qemu image for aarch64
57 # o qemu image for armv6/armv7
58 # o easy support for different image / vm formats
59 # o need to promote much of this to nanobsd.sh and friends
60 # o uses old kludge to build image w/o ownership being right
61 # for many files. Should move to mtree-dedup.awk.
62 # o support for EFI images
63 # o support for GPT partitioning
66 # o common tooling for creating images for odd-ball platforms
67 # o support for boot loaders other than uboot in the image
68 # or via special instructions
69 # o no pony support; sadly, you cannot have a pony
72 if [ -z $NANO_NAME ]; then
73 echo "NANO_NAME not defined. Use foo.cfg instead."
76 NANO_SLICE_FAT_SIZE=32m
77 NANO_SLICE_CFG_SIZE=32m
79 NANO_BOOT2CFG="-h -S115200"
82 NANO_RAM_TMPVARSIZE=8192
85 NANO_PMAKE="make -j $(sysctl -n hw.ncpu)"
88 NANO_CFG_BASE=$(realpath ${NANO_CFG_BASE}/..)
89 NANO_SRC=$(realpath ${NANO_CFG_BASE}/../../..)
91 if [ -z ${NANO_CPUTYPE} ]; then
92 NANO_OBJ=${NANO_SRC}/../embedded/obj
94 # Alas, I can't set OBJTREE to ${MACHINE}.${MACHINE_ARCH}.${CPUTYPE}
95 # so this will have to do until I can.
96 NANO_OBJ=${NANO_SRC}/../embedded/obj.${NANO_CPUTYPE}
98 NANO_LOG=${NANO_OBJ}/../${NANO_NAME}
99 NANO_DISKIMGDIR=${NANO_OBJ}/../images
100 NANO_WORLDDIR=${NANO_LOG}/_.w
103 unset MAKEOBJDIRPREFIX
106 NANO_OBJ=$(realpath ${NANO_OBJ})
108 NANO_LOG=$(realpath ${NANO_LOG})
109 mkdir -p ${NANO_WORLDDIR}
110 NANO_WORLDDIR=$(realpath ${NANO_WORLDDIR})
111 mkdir -p ${NANO_DISKIMGDIR}
112 NANO_DISKIMGDIR=$(realpath ${NANO_DISKIMGDIR})
114 NANO_FAT_DIR=${NANO_LOG}/_.fat
116 customize_cmd cust_allow_ssh_root
118 add_etc_make_conf ( ) (
119 touch ${NANO_WORLDDIR}/etc/make.conf
121 customize_cmd add_etc_make_conf
123 cust_install_machine_files ( ) (
124 echo "cd ${NANO_CFG_BASE}/Files"
125 cd ${NANO_CFG_BASE}/Files
126 find . -print | grep -Ev '/(CVS|\.svn|\.hg|\.git)' | cpio -dumpv ${NANO_WORLDDIR}
128 customize_cmd cust_install_files
129 customize_cmd cust_install_machine_files
131 # NB: leave c++ enabled so devd can be built
133 LOCAL_XTOOL_DIRS=usr.bin/mkimg
137 WITHOUT_BIND_DNSSEC=true
138 WITHOUT_BIND_ETC=true
139 WITHOUT_BIND_LIBS_LWRES=true
140 WITHOUT_BLUETOOTH=true
141 WITHOUT_CALENDAR=true
144 WITHOUT_EXAMPLES=true
151 WITHOUT_IPFILTER=true
160 WITHOUT_NS_CACHING=true
163 WITHOUT_SENDMAIL=true
164 WITHOUT_SHAREDOCS=true
168 WITHOUT_DEBUG_FILES=t
169 WITHOUT_KERNEL_SYMBOLS=t
171 CONF_INSTALL="$CONF_BUILD
174 NO_INSTALL_MANPAGES=t
176 # The following would help...
177 # WITHOUT_TOOLCHAIN=true can't build ports
178 # WITHOUT_INSTALLLIB=true libgcc.a
181 # WITHOUT_INFO=true makeinfo
184 WITHOUT_TOOLCHAIN=true
185 WITHOUT_INSTALLLIB=true
192 # Creates images for all the formats that use MBR / GPT
193 # split later if the #ifdef soup gets too bad.
194 create_diskimage_gpt ( ) (
195 pprint 2 "build diskimage gpt ${NANO_NAME}"
197 create_diskimage_mbr $*
200 create_diskimage_mbr ( ) (
204 [ -z ${NANO_DISKIMAGE_FORMAT} ] || fmt=".${NANO_DISKIMAGE_FORMAT}"
206 pprint 2 "build diskimage ${NANO_NAME}"
207 pprint 3 "log: ${NANO_LOG}/_.di"
208 pprint 3 "image in: ${NANO_DISKIMGDIR}/_.disk.image.${NANO_NAME}${fmt}"
211 local extra i sz fmt fmtarg bootmbr bootbsd skiparg
213 # Tell mtools not to be too picky
214 export MTOOLS_SKIP_CHECK=1
216 [ -z ${NANO_DISKIMAGE_FORMAT} ] || fmtarg="-f ${NANO_DISKIMAGE_FORMAT}"
217 [ -z ${NANO_DISKIMAGE_FORMAT} ] || fmt=".${NANO_DISKIMAGE_FORMAT}"
218 bootmbr=${NANO_BOOT_MBR:+-b ${NANO_BOOT_MBR}}
219 bootbsd=${NANO_BOOT_BSD:+-b ${NANO_BOOT_BSD}}
220 skiparg=${NANO_MBR_FIRST_SKIP:+-S ${NANO_MBR_FIRST_SKIP}}
222 for i in s1 s2 s3 s4 p1 p2 p3 p4 p5 empty; do
223 rm -fr ${NANO_LOG}/_.${i}*
226 # Populate the FAT partition, if needed
227 if [ -n "${NANO_SLICE_FAT}" ]; then
228 echo Creating MSDOS partition for kernel
229 newfs_msdos -C ${NANO_SLICE_FAT_SIZE} -F 16 -L ${NANO_NAME} \
230 ${NANO_LOG}/_.${NANO_SLICE_FAT}
231 if [ -d ${NANO_FAT_DIR} ]; then
232 # Need to copy files from ${NANO_FATDIR} with mtools, or use
233 # makefs -t msdos once that's supported
234 mcopy -i ${NANO_LOG}/_.${NANO_SLICE_FAT} ${NANO_FAT_DIR}/* ::
238 # Populate the Powerpc boot image, if needed
239 if [ "${NANO_LAYOUT}" = powerpc64-ibm ]; then
240 dd if=${NANO_WORLDDIR}/boot/boot1.elf of=${NANO_LOG}/_.s1 bs=800k count=1 conv=sync
243 # Populate the / partition, and place it into a slice with a
245 [ -z ${NANO_NOPRIV_BUILD} ] || extra="-F ${NANO_METALOG}"
246 sz=${NANO_SLICE_ROOT_SIZE:+-s ${NANO_SLICE_ROOT_SIZE}}
247 eval "${NANO_MAKEFS_UFS}" ${extra} $sz "${NANO_LOG}/_.${NANO_ROOT}" \
249 case ${NANO_DISK_SCHEME} in
251 mkimg -s bsd ${bootbsd} -p freebsd-ufs:=${NANO_LOG}/_.${NANO_ROOT} \
252 -o ${NANO_LOG}/_.${NANO_SLICE_ROOT}
253 eval $NANO_SLICE_CFG=freebsd
254 eval $NANO_SLICE_ROOT=freebsd
257 eval $NANO_SLICE_CFG=freebsd-ufs
258 eval $NANO_SLICE_ROOT=freebsd-ufs
262 # Populate the /cfg partition, empty if none given
263 if [ -z "${NANO_CFGDIR}" ]; then
264 echo "Faking cfg dir, it's empty"
265 NANO_CFGDIR=${NANO_LOG}/_.empty
266 mkdir -p ${NANO_CFGDIR}
269 eval "${NANO_MAKEFS_UFS}" -s ${NANO_SLICE_CFG_SIZE} \
270 "${NANO_LOG}/_.${NANO_SLICE_CFG}" "${NANO_CFGDIR}"
272 # data slice not supported since we need the part for FAT for
275 # Now shuffle all the slices together into the proper layout
276 if [ -n "$NANO_SLICE_FAT" ]; then
277 eval $NANO_SLICE_FAT=fat16b
280 out=${NANO_DISKIMGDIR}/_.disk.image.${NANO_NAME}${fmt}
281 # below depends on https://reviews.freebsd.org/D4403 not yet in the tree
282 # but there's problems: it marks all partitions as active, so you have to
283 # boot off partition 3 or 2 by hand if you're playing around with this WIP
284 case ${NANO_LAYOUT} in
286 mkimg -a 3 ${skiparg} ${fmtarg} ${bootmbr} -s mbr -p ${s1}:=${NANO_LOG}/_.s1 \
287 -p ${s2}:=${NANO_LOG}/_.s2 \
288 -p ${s3}:=${NANO_LOG}/_.s3 \
292 # s3 is cfg, s1 is /, s2 is other / (s2 is created in first boot script)
293 mkimg -a 1 ${fmtarg} ${bootmbr} -s mbr -p ${s1}:=${NANO_LOG}/_.s1 \
295 -p ${s3}:=${NANO_LOG}/_.s3 \
301 # s1 is boot, s2 is cfg, s3 is /, not sure how to make that
302 # boot (marked as active) with mkimg yet
303 mkimg -a 2 ${fmtarg} ${bootmbr} -s mbr \
304 -p efi:=${NANO_WORLDDIR}/boot/boot1.efifat \
305 -p ${s2}:=${NANO_LOG}/_.s2 \
306 -p ${s3}:=${NANO_LOG}/_.s3 \
310 # p1 is boot for uefi, p2 is boot for gpt, p3 is cfg, p4 is /
311 # and p5 is alt-root (after resize)
312 mkimg -a 2 ${fmtarg} ${bootmbr} -s gpt \
313 -p efi:=${NANO_WORLDDIR}/boot/boot1.efifat \
314 -p freebsd-boot:=${NAANO_WORLDDIR}/boot/gptboot \
315 -p ${p3}:=${NANO_LOG}/_.p3 \
316 -p ${p4}:=${NANO_LOG}/_.p4 \
320 # A lie to make the boot loader work, it boots the first BSD partition
321 # it finds, regardless of the active flag.
323 # boot image is on a special partition, ala std-embedded, but that
324 # partition isn't FAT with special files, but a copy of the boot
326 mkimg -a 1 ${fmtarg} -s mbr -p prepboot:=${NANO_LOG}/_.s1 \
327 -p ${s2}:=${NANO_LOG}/_.s2 \
328 -p ${s3}:=${NANO_LOG}/_.s3a \
334 ) > ${NANO_LOG}/_.di 2>&1
342 # Automatically include the packaging port here so it is always first so it
343 # builds the port and adds the package so we can add other packages.
344 #XXX Doesn't work for cross build, so punting until I can integreate qemu-static
345 #XXX or poudriere, both of which require priv'd execution. Or qemu-system,
346 #XXX which is super, super slow.
347 #add_port ports-mgmt/pkg
348 #add_port security/sudo
351 rp=$(realpath ${NANO_OBJ}/)
352 __a=`mount | grep ${rp} | awk '{print length($3), $3;}' | sort -rn | awk '{$1=""; print;}'`
353 if [ -n "$__a" ]; then
354 echo "unmounting $__a"
358 if [ "$DEBUG" = 1 ]; then
368 CONF_INSTALL="$CONF_BUILD
371 CONF_INSTALL="$CONF_INSTALL
375 if [ "${NANO_PACKAGE_ONLY}" -eq 1 ]; then
376 CONF_INSTALL="${CONF_INSTALL}
377 ${PKG_ONLY_MAKE_CONF}
379 echo "Automatically building a thin image with packages"
381 echo "Automatically building a * * F A T * * image so we can build ports"
384 VARS="MASTER_SITE_BACKUP MASTER_SITE_OVERRIDE PACKAGEROOT PACKAGESITE"
387 val=$(eval echo "\$$var")
388 if [ -n "$val" ]; then
389 CONF_INSTALL="${CONF_INSTALL}
394 typical_embedded ( ) (
395 # Need to create rc.conf before we copy over /etc to /conf/base/etc
396 # so now's a good time.
398 local rc=${NANO_WORLDDIR}/etc/rc.conf
400 echo "hostname=nanobsd-${NANO_NAME}" > $rc
401 echo "growfs_enable=YES" >> $rc
402 echo "growfs_type=nanobsd-pingpong" >> $rc
403 echo "ntpdate_enable=YES" >> $rc
404 echo "ifconfig_DEFAULT=DHCP" >> $rc
405 echo "ntpdate_hosts='0.freebsd.pool.ntp.org 1.freebsd.pool.ntp.org'" >> $rc
406 # Make sure that firstboot scripts run so growfs works.
407 # Note: still some issues remvoing this XXX
408 touch ${NANO_WORLDDIR}/firstboot
410 customize_cmd typical_embedded
413 chdir ${NANO_WORLDDIR}
417 mkdir -p pkg/tmp # Needed for pkg bootstrap
418 mkdir -p usr/local/etc # Will get moved to local/etc
420 echo 'PKG_DBDIR = "/pkg/db"'
421 echo 'PKG_CACHEDIR = "/pkg/cache"'
422 echo 'DEFAULT_ALWAYS_YES = "yes"'
423 echo 'ASSUME_ALWAYS_YES = "yes"'
424 ) >> usr/local/etc/pkg.conf
425 [ -z ${NANO_NOPRIV_BUILD} ] || (
426 echo "./pkg type=dir uname=root gname=wheel mode=0755"
427 echo "./pkg/cache type=dir uname=root gname=wheel mode=0755"
428 echo "./pkg/db type=dir uname=root gname=wheel mode=0755"
429 echo "./pkg/tmp type=dir uname=root gname=wheel mode=0755"
432 customize_cmd fix_pkg
435 VERSION_FILE=${NANO_WORLDDIR}/etc/version
436 if [ "${SVNREVISION}" = "${REVISION}" ]; then
437 echo "${NANO_NAME}" > "${VERSION_FILE}"
439 echo "${NANO_NAME} (${SVNREVISION})" > "${VERSION_FILE}"
442 customize_cmd save_build
444 shrink_md_fbsize ( ) (
445 # We have a lot of little files on our memory disks. Let's decrease
446 # the block and frag size to fit more little files on them (this
447 # halves our space requirement by ~50% on /etc and /var on 8.x --
448 # and gives us more back on 9.x as the default block and frag size
449 # are 4 times larger).
450 sed -i '' -e 's,-S -i 4096,-S -i 4096 -b 4096 -f 512,' \
451 ${NANO_WORLDDIR}/etc/rc.initdiskless
453 customize_cmd shrink_md_fbsize
455 customize_cmd cust_comconsole
458 local d=/usr/local/share/u-boot/${NANO_BOOT_PKG}
459 local f=${NANO_FAT_DIR}
461 # For now, just copy all the files. However, for iMX6 and Allwinner,
462 # we'll need to put a special boot block at a fixed location
463 # on the disk as well.
469 # Also copy ubldr. u-boot will load it and it will load the kernel
470 # from the ufs partition
471 cp ${NANO_WORLDDIR}/boot/ubldr .
472 cp ${NANO_WORLDDIR}/boot/ubldr.bin .
474 # We have to touch the saveenv file
477 # Now we need to copy over dtb files from the build.
478 cp ${NANO_WORLDDIR}/boot/dtb/*.dtb .
481 if [ -n "$NANO_BOOT_PKG" ]; then
482 d=/usr/local/share/u-boot/${NANO_BOOT_PKG}
483 if [ ! -d ${d} ]; then
484 echo ${NANO_BOOT_PKG} not installed. Sadly, it must be.
487 if [ ! -x /usr/local/bin/mcopy ]; then
488 echo mtools not installed. Sadly, we gotta have it.
491 customize_cmd dos_boot_part
495 # not quite ready to tweak these in nopriv build
496 if [ -z ${NANO_NOPRIV_BUILD} ]; then
497 # Last second tweaks -- generally not needed
498 chown -R root:wheel ${NANO_WORLDDIR}/root
499 chmod 0755 ${NANO_WORLDDIR}/root/*
500 chmod 0755 ${NANO_WORLDDIR}/*
501 chown -R root:wheel ${NANO_WORLDDIR}/etc
502 chown -R root:wheel ${NANO_WORLDDIR}/boot
503 chown root:wheel ${NANO_WORLDDIR}/
504 chown root:wheel ${NANO_WORLDDIR}/usr
507 late_customize_cmd product_custom
510 # Convenience routines to bring up many settings for standard environments
514 # For each architecture, we have a standard set of settings to the extent
515 # it makes sense. For architectures that don't have a standard environment
516 # cfg files need to either define a lot of settings, provide their own disk
517 # imaging, or set which of the variants we support. No subshells, since we
518 # set global variables
542 # Default values, if not overridden in .cfg file
543 : ${NANO_KERNEL:=GENERIC}
544 : ${NANO_DRIVE:=ada0}
545 : ${NANO_LAYOUT:=std-x86}
546 : ${NANO_BOOT_MBR:=${NANO_WORLDDIR}/boot/boot0sio}
547 : ${NANO_BOOT_BSD:=${NANO_WORLDDIR}/boot/boot}
569 NANO_LAYOUT=powerpc64-ibm
578 # QEMU settings for the standard environments
582 NANO_DISKIMAGE_FORMAT=qcow2
585 # other standard environments will go here
587 eval std_${NANO_ARCH}
589 # Slice 1: FAT for ROM loading bootstrap
590 # Slice 2: Config partition
591 # Slice 3: FreeBSD partition (sized exactly)
592 # Slice 4: FreeBSD partition (empty)
593 # on first boot, we resize slice 3 & 4 to be 1/2 of what's
594 # left over on the SD card after slice 1 and 2 are taken
595 # off the top. We also resize the 'a' partion on first boot
596 # to the size of the partition for the ping/pong upgrade.
597 # This feature needs support in the rc.d bootup script.
599 # Ideally, we'd not put BSD labels on the MBR disks.
600 # However, we can't boot off raw MBR disks. First,
601 # boot2 defaults to 'a' partition, and freaks out
602 # unless you tell it to use 'c'. But even if we
603 # hack that, then /boot/loader wants to load off
604 # of 'c' partition. If you fix that, then we'll
605 # try to mount root, but sanity checks prevent
606 # slices from working.
609 : ${NANO_ENDIAN:=little} # make -V something to figure it out?
610 : ${NANO_LAYOUT:=std-embedded}
611 : ${NANO_MAKEFS_UFS:=makefs -t ffs -B ${NANO_ENDIAN}}
612 : ${NANO_DISK_SCHEME:=mbr} # No others really supported ATM (well, gpt)
613 case ${NANO_LAYOUT} in
618 NANO_SLICE_ALTROOT=s4
619 NANO_ROOT=${NANO_SLICE_ROOT}a
620 NANO_ALTROOT=${NANO_SLICE_ALTROOT}a
625 NANO_SLICE_ALTROOT=s2
626 NANO_ROOT=${NANO_SLICE_ROOT}a
627 NANO_ALTROOT=${NANO_SLICE_ALTROOT}a
630 NANO_SLICE_PPCBOOT=s1
633 NANO_SLICE_ALTROOT=s4
634 NANO_ROOT=${NANO_SLICE_ROOT}a
635 NANO_ALTROOT=${NANO_SLICE_ALTROOT}a
645 NANO_SLICE_ALTROOT=s4
646 NANO_ROOT=${NANO_SLICE_ROOT}
647 NANO_ALTROOT=${NANO_SLICE_ALTROOT}
655 NANO_SLICE_ALTROOT=p5
656 NANO_ROOT=${NANO_SLICE_ROOT}
657 NANO_ALTROOT=${NANO_SLICE_ALTROOT}
660 echo Unknown Layout ${NANO_LAYOUT}
666 NANO_SLICE_DATA= # Not included
668 # Each major disk scheme has its own routine. Generally
669 # this is for mbr, gpt, etc. These are generally are widely
670 # shared, but some specialized formats won't be shared.
671 create_diskimage ( ) (
672 eval create_diskimage_${NANO_DISK_SCHEME}
675 # Set the path to the same path we use for buldworld to use latest mkimg
676 NANO_TARGET=$(cd ${NANO_SRC}; ${NANO_MAKE} TARGET_ARCH=${NANO_ARCH} -V _TARGET)
677 NANO_TMPPATH=$(cd ${NANO_SRC}; ${NANO_MAKE} MK_AUTO_OBJ=no TARGET=${NANO_TARGET} TARGET_ARCH=${NANO_ARCH} -f Makefile.inc1 buildenv -V TMPPATH)
678 export PATH="${NANO_TMPPATH}"