tools/tools/nanobsd/defaults.sh

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