4 # Copyright (c) 2015 Warner Losh. All Rights Reserved.
5 # Copyright (c) 2010-2011 iXsystems, Inc., All rights reserved.
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="-P -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
164 WITHOUT_SENDMAIL=true
165 WITHOUT_SHAREDOCS=true
169 WITHOUT_DEBUG_FILES=t
170 WITHOUT_KERNEL_SYMBOLS=t
172 CONF_INSTALL="$CONF_BUILD
175 NO_INSTALL_MANPAGES=t
177 # The following would help...
178 # WITHOUT_TOOLCHAIN=true can't build ports
179 # WITHOUT_INSTALLLIB=true libgcc.a
182 # WITHOUT_INFO=true makeinfo
185 WITHOUT_TOOLCHAIN=true
186 WITHOUT_INSTALLLIB=true
193 # Creates images for all the formats that use MBR / GPT
194 # split later if the #ifdef soup gets too bad.
195 create_diskimage_gpt ( ) (
196 pprint 2 "build diskimage gpt ${NANO_NAME}"
198 create_diskimage_mbr $*
201 create_diskimage_mbr ( ) (
205 [ -z ${NANO_DISKIMAGE_FORMAT} ] || fmt=".${NANO_DISKIMAGE_FORMAT}"
207 pprint 2 "build diskimage ${NANO_NAME}"
208 pprint 3 "log: ${NANO_LOG}/_.di"
209 pprint 3 "image in: ${NANO_DISKIMGDIR}/_.disk.image.${NANO_NAME}${fmt}"
212 local extra i sz fmt fmtarg bootmbr bootbsd skiparg
214 # Tell mtools not to be too picky
215 export MTOOLS_SKIP_CHECK=1
217 [ -z ${NANO_DISKIMAGE_FORMAT} ] || fmtarg="-f ${NANO_DISKIMAGE_FORMAT}"
218 [ -z ${NANO_DISKIMAGE_FORMAT} ] || fmt=".${NANO_DISKIMAGE_FORMAT}"
219 bootmbr=${NANO_BOOT_MBR:+-b ${NANO_BOOT_MBR}}
220 bootbsd=${NANO_BOOT_BSD:+-b ${NANO_BOOT_BSD}}
221 skiparg=${NANO_MBR_FIRST_SKIP:+-S ${NANO_MBR_FIRST_SKIP}}
223 for i in s1 s2 s3 s4 p1 p2 p3 p4 p5 empty; do
224 rm -fr ${NANO_LOG}/_.${i}*
227 # Populate the FAT partition, if needed
228 if [ -n "${NANO_SLICE_FAT}" ]; then
229 echo Creating MSDOS partition for kernel
230 newfs_msdos -C ${NANO_SLICE_FAT_SIZE} -F 16 -L ${NANO_NAME} \
231 ${NANO_LOG}/_.${NANO_SLICE_FAT}
232 if [ -d ${NANO_FAT_DIR} ]; then
233 # Need to copy files from ${NANO_FATDIR} with mtools, or use
234 # makefs -t msdos once that's supported
235 mcopy -i ${NANO_LOG}/_.${NANO_SLICE_FAT} ${NANO_FAT_DIR}/* ::
239 # Populate the Powerpc boot image, if needed
240 if [ "${NANO_LAYOUT}" = powerpc64-ibm ]; then
241 dd if=${NANO_WORLDDIR}/boot/boot1.elf of=${NANO_LOG}/_.s1 bs=800k count=1 conv=sync
244 # Populate the / partition, and place it into a slice with a
246 [ -z ${NANO_NOPRIV_BUILD} ] || extra="-F ${NANO_METALOG}"
247 sz=${NANO_SLICE_ROOT_SIZE:+-s ${NANO_SLICE_ROOT_SIZE}}
248 eval "${NANO_MAKEFS_UFS}" ${extra} $sz "${NANO_LOG}/_.${NANO_ROOT}" \
250 case ${NANO_DISK_SCHEME} in
252 mkimg -s bsd ${bootbsd} -p freebsd-ufs:=${NANO_LOG}/_.${NANO_ROOT} \
253 -o ${NANO_LOG}/_.${NANO_SLICE_ROOT}
254 eval $NANO_SLICE_CFG=freebsd
255 eval $NANO_SLICE_ROOT=freebsd
258 eval $NANO_SLICE_CFG=freebsd-ufs
259 eval $NANO_SLICE_ROOT=freebsd-ufs
263 # Populate the /cfg partition, empty if none given
264 if [ -z "${NANO_CFGDIR}" ]; then
265 echo "Faking cfg dir, it's empty"
266 NANO_CFGDIR=${NANO_LOG}/_.empty
267 mkdir -p ${NANO_CFGDIR}
270 eval "${NANO_MAKEFS_UFS}" -s ${NANO_SLICE_CFG_SIZE} \
271 "${NANO_LOG}/_.${NANO_SLICE_CFG}" "${NANO_CFGDIR}"
273 # data slice not supported since we need the part for FAT for
276 # Now shuffle all the slices together into the proper layout
277 if [ -n "$NANO_SLICE_FAT" ]; then
278 eval $NANO_SLICE_FAT=fat16b
281 out=${NANO_DISKIMGDIR}/_.disk.image.${NANO_NAME}${fmt}
282 # below depends on https://reviews.freebsd.org/D4403 not yet in the tree
283 # but there's problems: it marks all partitions as active, so you have to
284 # boot off partition 3 or 2 by hand if you're playing around with this WIP
285 case ${NANO_LAYOUT} in
287 mkimg -a 3 ${skiparg} ${fmtarg} ${bootmbr} -s mbr -p ${s1}:=${NANO_LOG}/_.s1 \
288 -p ${s2}:=${NANO_LOG}/_.s2 \
289 -p ${s3}:=${NANO_LOG}/_.s3 \
293 # s1 is cfg, s2 is /, not sure how to make that
294 # boot (marked as active) with mkimg yet
295 mkimg -a 2 ${fmtarg} ${bootmbr} -s mbr -p ${s1}:=${NANO_LOG}/_.s1 \
296 -p ${s2}:=${NANO_LOG}/_.s2 \
300 # s1 is boot, s2 is cfg, s3 is /, not sure how to make that
301 # boot (marked as active) with mkimg yet
302 mkimg -a 2 ${fmtarg} ${bootmbr} -s mbr \
303 -p efi:=${NANO_WORLDDIR}/boot/boot1.efifat \
304 -p ${s2}:=${NANO_LOG}/_.s2 \
305 -p ${s3}:=${NANO_LOG}/_.s3 \
309 # p1 is boot for uefi, p2 is boot for gpt, p3 is cfg, p4 is /
310 # and p5 is alt-root (after resize)
311 mkimg -a 2 ${fmtarg} ${bootmbr} -s gpt \
312 -p efi:=${NANO_WORLDDIR}/boot/boot1.efifat \
313 -p freebsd-boot:=${NAANO_WORLDDIR}/boot/gptboot \
314 -p ${p3}:=${NANO_LOG}/_.p3 \
315 -p ${p4}:=${NANO_LOG}/_.p4 \
319 # A lie to make the boot loader work, it boots the first BSD partition
320 # it finds, regardless of the active flag.
322 # boot image is on a special partition, ala std-embedded, but that
323 # partition isn't FAT with special files, but a copy of the boot
325 mkimg -a 1 ${fmtarg} -s mbr -p prepboot:=${NANO_LOG}/_.s1 \
326 -p ${s2}:=${NANO_LOG}/_.s2 \
327 -p ${s3}:=${NANO_LOG}/_.s3a \
333 ) > ${NANO_LOG}/_.di 2>&1
341 # Automatically include the packaging port here so it is always first so it
342 # builds the port and adds the package so we can add other packages.
343 #XXX Doesn't work for cross build, so punting until I can integreate qemu-static
344 #XXX or poudriere, both of which require priv'd execution. Or qemu-system,
345 #XXX which is super, super slow.
346 #add_port ports-mgmt/pkg
347 #add_port security/sudo
350 rp=$(realpath ${NANO_OBJ}/)
351 __a=`mount | grep ${rp} | awk '{print length($3), $3;}' | sort -rn | awk '{$1=""; print;}'`
352 if [ -n "$__a" ]; then
353 echo "unmounting $__a"
357 if [ "$DEBUG" = 1 ]; then
367 CONF_INSTALL="$CONF_BUILD
370 CONF_INSTALL="$CONF_INSTALL
374 if [ "${NANO_PACKAGE_ONLY}" -eq 1 ]; then
375 CONF_INSTALL="${CONF_INSTALL}
376 ${PKG_ONLY_MAKE_CONF}
378 echo "Automatically building a thin image with packages"
380 echo "Automatically building a * * F A T * * image so we can build ports"
383 VARS="MASTER_SITE_BACKUP MASTER_SITE_OVERRIDE PACKAGEROOT PACKAGESITE"
386 val=$(eval echo "\$$var")
387 if [ -n "$val" ]; then
388 CONF_INSTALL="${CONF_INSTALL}
393 typical_embedded ( ) (
394 # Need to create rc.conf before we copy over /etc to /conf/base/etc
395 # so now's a good time.
397 local rc=${NANO_WORLDDIR}/etc/rc.conf
399 echo "hostname=nanobsd-${NANO_NAME}" > $rc
400 echo "growfs_enable=YES" >> $rc
401 echo "growfs_type=nanobsd-pingpong" >> $rc
402 echo "ntpdate_enable=YES" >> $rc
403 echo "ifconfig_DEFAULT=DHCP" >> $rc
404 echo "ntpdate_hosts='0.freebsd.pool.ntp.org 1.freebsd.pool.ntp.org'" >> $rc
405 # Make sure that firstboot scripts run so growfs works.
406 # Note: still some issues remvoing this XXX
407 touch ${NANO_WORLDDIR}/firstboot
409 customize_cmd typical_embedded
412 chdir ${NANO_WORLDDIR}
416 mkdir -p pkg/tmp # Needed for pkg bootstrap
417 mkdir -p usr/local/etc # Will get moved to local/etc
419 echo 'PKG_DBDIR = "/pkg/db"'
420 echo 'PKG_CACHEDIR = "/pkg/cache"'
421 echo 'DEFAULT_ALWAYS_YES = "yes"'
422 echo 'ASSUME_ALWAYS_YES = "yes"'
423 ) >> usr/local/etc/pkg.conf
424 [ -z ${NANO_NOPRIV_BUILD} ] || (
425 echo "./pkg type=dir uname=root gname=wheel mode=0755"
426 echo "./pkg/cache type=dir uname=root gname=wheel mode=0755"
427 echo "./pkg/db type=dir uname=root gname=wheel mode=0755"
428 echo "./pkg/tmp type=dir uname=root gname=wheel mode=0755"
431 customize_cmd fix_pkg
434 VERSION_FILE=${NANO_WORLDDIR}/etc/version
435 if [ "${SVNREVISION}" = "${REVISION}" ]; then
436 echo "${NANO_NAME}" > "${VERSION_FILE}"
438 echo "${NANO_NAME} (${SVNREVISION})" > "${VERSION_FILE}"
441 customize_cmd save_build
443 shrink_md_fbsize ( ) (
444 # We have a lot of little files on our memory disks. Let's decrease
445 # the block and frag size to fit more little files on them (this
446 # halves our space requirement by ~50% on /etc and /var on 8.x --
447 # and gives us more back on 9.x as the default block and frag size
448 # are 4 times larger).
449 sed -i '' -e 's,-S -i 4096,-S -i 4096 -b 4096 -f 512,' \
450 ${NANO_WORLDDIR}/etc/rc.initdiskless
452 customize_cmd shrink_md_fbsize
454 customize_cmd cust_comconsole
457 local d=/usr/local/share/u-boot/${NANO_BOOT_PKG}
458 local f=${NANO_FAT_DIR}
460 # For now, just copy all the files. However, for iMX6 and Allwinner,
461 # we'll need to put a special boot block at a fixed location
462 # on the disk as well.
468 # Also copy ubldr. u-boot will load it and it will load the kernel
469 # from the ufs partition
470 cp ${NANO_WORLDDIR}/boot/ubldr .
471 cp ${NANO_WORLDDIR}/boot/ubldr.bin .
473 # We have to touch the saveenv file
476 # Now we need to copy over dtb files from the build.
477 cp ${NANO_WORLDDIR}/boot/dtb/*.dtb .
480 if [ -n "$NANO_BOOT_PKG" ]; then
481 local d=/usr/local/share/u-boot/${NANO_BOOT_PKG}
482 if [ ! -d ${d} ]; then
483 echo ${NANO_BOOT_PKG} not installed. Sadly, it must be.
486 if [ ! -x /usr/local/bin/mcopy ]; then
487 echo mtools not installed. Sadly, we gotta have it.
490 customize_cmd dos_boot_part
494 # not quite ready to tweak these in nopriv build
495 if [ -z ${NANO_NOPRIV_BUILD} ]; then
496 # Last second tweaks -- generally not needed
497 chown -R root:wheel ${NANO_WORLDDIR}/root
498 chmod 0755 ${NANO_WORLDDIR}/root/*
499 chmod 0755 ${NANO_WORLDDIR}/*
500 chown -R root:wheel ${NANO_WORLDDIR}/etc
501 chown -R root:wheel ${NANO_WORLDDIR}/boot
502 chown root:wheel ${NANO_WORLDDIR}/
503 chown root:wheel ${NANO_WORLDDIR}/usr
506 late_customize_cmd product_custom
509 # Convenience routines to bring up many settings for standard environments
513 # For each architecture, we have a standard set of settings to the extent
514 # it makes sense. For architectures that don't have a standard environment
515 # cfg files need to either define a lot of settings, provide their own disk
516 # imaging, or set which of the variants we support. No subshells, since we
517 # set global variables
538 # Default values, if not overridden in .cfg file
539 : ${NANO_KERNEL:=GENERIC}
540 : ${NANO_DRIVE:=ada0}
541 : ${NANO_LAYOUT:=std-x86}
542 : ${NANO_BOOT_MBR:=${NANO_WORLDDIR}/boot/boot0sio}
543 : ${NANO_BOOT_BSD:=${NANO_WORLDDIR}/boot/boot}
565 NANO_LAYOUT=powerpc64-ibm
574 # QEMU settings for the standard environments
578 NANO_DISKIMAGE_FORMAT=qcow2
581 # other standard environments will go here
583 eval std_${NANO_ARCH}
585 # Slice 1: FAT for ROM loading bootstrap
586 # Slice 2: Config partition
587 # Slice 3: FreeBSD partition (sized exactly)
588 # Slice 4: FreeBSD partition (empty)
589 # on first boot, we resize slice 3 & 4 to be 1/2 of what's
590 # left over on the SD card after slice 1 and 2 are taken
591 # off the top. We also resize the 'a' partion on first boot
592 # to the size of the partition for the ping/pong upgrade.
593 # This feature needs support in the rc.d bootup script.
595 # Ideally, we'd not put BSD labels on the MBR disks.
596 # However, we can't boot off raw MBR disks. First,
597 # boot2 defaults to 'a' partition, and freaks out
598 # unless you tell it to use 'c'. But even if we
599 # hack that, then /boot/loader wants to load off
600 # of 'c' partition. If you fix that, then we'll
601 # try to mount root, but sanity checks prevent
602 # slices from working.
605 : ${NANO_ENDIAN:=little} # make -V something to figure it out?
606 : ${NANO_LAYOUT:=std-embedded}
607 : ${NANO_MAKEFS_UFS:=makefs -t ffs -B ${NANO_ENDIAN}}
608 : ${NANO_DISK_SCHEME:=mbr} # No others really supported ATM (well, gpt)
609 case ${NANO_LAYOUT} in
614 NANO_SLICE_ALTROOT=s4
615 NANO_ROOT=${NANO_SLICE_ROOT}a
616 NANO_ALTROOT=${NANO_SLICE_ALTROOT}a
621 NANO_SLICE_ALTROOT=s3
622 NANO_ROOT=${NANO_SLICE_ROOT}a
623 NANO_ALTROOT=${NANO_SLICE_ALTROOT}a
626 NANO_SLICE_PPCBOOT=s1
629 NANO_SLICE_ALTROOT=s4
630 NANO_ROOT=${NANO_SLICE_ROOT}a
631 NANO_ALTROOT=${NANO_SLICE_ALTROOT}a
641 NANO_SLICE_ALTROOT=s4
642 NANO_ROOT=${NANO_SLICE_ROOT}
643 NANO_ALTROOT=${NANO_SLICE_ALTROOT}
651 NANO_SLICE_ALTROOT=p5
652 NANO_ROOT=${NANO_SLICE_ROOT}
653 NANO_ALTROOT=${NANO_SLICE_ALTROOT}
656 echo Unknown Layout ${NANO_LAYOUT}
662 NANO_SLICE_DATA= # Not included
664 # Each major disk scheme has its own routine. Generally
665 # this is for mbr, gpt, etc. These are generally are widely
666 # shared, but some specialized formats won't be shared.
667 create_diskimage ( ) (
668 eval create_diskimage_${NANO_DISK_SCHEME}
671 # Set the path to the same path we use for buldworld to use latest mkimg
672 NANO_TARGET=$(cd ${NANO_SRC}; ${NANO_MAKE} TARGET_ARCH=${NANO_ARCH} -V _TARGET)
673 NANO_TMPPATH=$(cd ${NANO_SRC}; ${NANO_MAKE} TARGET=${NANO_TARGET} TARGET_ARCH=${NANO_ARCH} -f Makefile.inc1 buildenv -V TMPPATH)
674 export PATH="${NANO_TMPPATH}"