Skip to content

Latest commit

 

History

History
612 lines (412 loc) · 21 KB

README.md

File metadata and controls

612 lines (412 loc) · 21 KB
Raw

NAME

novaboot - A tool for booting various operating systems on various hardware or in qemu

SYNOPSIS

novaboot --help

novaboot [option]... [--] script...

./script [option]...

DESCRIPTION

This program makes booting of an operating system (e.g. NOVA or Linux) as simple as running a local program. It facilitates booting on local or remote hosts or in emulators such as qemu. Novaboot operation is controlled by command line options and by a so called novaboot script, which can be thought as a generalization of bootloader configuration files (see "NOVABOOT SCRIPT SYNTAX"). Based on this input, novaboot setups everything for the target host to boot the desired configuration, i.e. it generates the bootloader configuration file in the proper format, deploy the binaries and other needed files to required locations, perhaps on a remote boot server and reset the target host. Finally, target host's serial output is redirected to standard output if that is possible.

Typical way of using novaboot is to make the novaboot script executable and set its first line to #!/usr/bin/env novaboot. Then, booting a particular OS configuration becomes the same as executing a local program - the novaboot script.

For example, with novaboot you can:

  1. Run an OS in Qemu. This is the default action when no other action is specified by command line switches. Thus running novaboot ./script (or ./script as described above) will run Qemu and make it boot the configuration specified in the script.

  2. Create a bootloader configuration file (currently supported bootloaders are GRUB, GRUB2, Pulsar and U-Boot) and copy it with all other files needed for booting to a remote boot server.

     ./script --server=192.168.1.1:/tftp --iprelay=192.168.1.2

    This command copies files to the TFTP server and uses TCP/IP-controlled relay to reset the target host and receive its serial output.

  3. Run DHCP and TFTP server on developer's machine to PXE-boot the target host from it. E.g.

     ./script --dhcp-tftp

    When a PXE-bootable machine is connected via Ethernet to developer's machine, it will boot the configuration described in script.

  4. Create bootable ISO images. E.g.

     novaboot --iso -- script1 script2

    The created ISO image will have GRUB bootloader installed on it and the boot menu will allow selecting between script1 and script2 configurations.

Note that the options needed for a specific target can be stored in a "CONFIGURATION FILE". Then it is sufficient to use only the -t option to specify the name of the target.

PHASES AND OPTIONS

Novaboot performs its work in several phases. Each phase can be influenced by several options, certain phases can be skipped. The list of phases (in the execution order) and the corresponding options follow.

Configuration reading phase

After starting, novaboot reads configuration files. By default, it searches for files named .novaboot starting from the directory of the novaboot script (or working directory, see bellow) and continuing upwards up to the root directory. The configuration files are read in order from the root directory downwards with latter files overriding settings from the former ones.

In certain cases, the location of the novaboot script cannot be determined in this early phase. This happens either when the script is read from the standard input or when novaboot is invoked explicitly and options precede the script name, as in the example "4." above. In this case the current working directory is used as a starting point for configuration file search.

  • -c, --config=filename

    Use the specified configuration file instead of the default one(s).

Command line processing phase

  • --dump-config

    Dump the current configuration to stdout end exits. Useful as an initial template for a configuration file.

  • -h, --help

    Print short (-h) or long (--help) help.

  • -t, --target=target

    This option serves as a user configurable shortcut for other novaboot options. The effect of this option is the same as the options stored in the %targets configuration variable under key target. See also "CONFIGURATION FILE".

Script preprocessing phase

This phases allows to modify the parsed novaboot script before it is used in the later phases.

  • -a, --append=parameters

    Append a string to the first load line in the novaboot script. This can be used to append parameters to the kernel's or root task's command line. Can appear multiple times.

  • -b, --bender

    Use bender chainloader. Bender scans the PCI bus for PCI serial ports and stores the information about them in the BIOS data area for use by the kernel.

  • --chainloader=chainloader

    Chainloader that is loaded before the kernel and other files specified in the novaboot script. E.g. 'bin/boot/bender promisc'.

  • --dump

    Print the modules to boot and their parameters after this phase finishes. Then exit. This is useful for seeing the effect of other options in this section.

  • -k, --kernel=file

    Replace the first word on the first load line in the novaboot script with file.

  • --scriptmod=perl expression

    When novaboot script is read, perl expression is executed for every line (in $_ variable). For example, novaboot \--scriptmod=s/sigma0/omega6/g replaces every occurrence of sigma0 in the script with omega6.

    When this option is present, it overrides $script_modifier variable from the configuration file, which has the same effect. If this option is given multiple times all expressions are evaluated in the command line order.

File generation phase

In this phase, files needed for booting are generated in a so called build directory (see "--build-dir"). In most cases configuration for a bootloader is generated automatically by novaboot. It is also possible to generate other files using heredoc or "<" syntax in novaboot scripts. Finally, binaries can be generated in this phases by running scons or make.

  • --build-dir=directory

    Overrides the default build directory location.

    The default build directory location is determined as follows: If the configuration file defines the $builddir variable, its value is used. Otherwise, it is the directory that contains the first processed novaboot script.

    See also "BUILDDIR" variable.

  • -g, --grub[=filename]

    Generates grub bootloader menu file. If the filename is not specified, menu.lst is used. The filename is relative to the build directory (see --build-dir).

  • --grub-preamble=prefix

    Specifies the preable that is at the beginning of the generated GRUB or GRUB2 config files. This is useful for specifying GRUB's timeout.

  • --grub-prefix=prefix

    Specifies prefix that is put in front of every file name in GRUB's menu.lst. The default value is the absolute path to the build directory.

    If the prefix contains string $NAME, it will be replaced with the name of the novaboot script (see also --name).

  • --grub2[=filename]

    Generate GRUB2 menuentry in filename. If filename is not specified grub.cfg is used. The content of the menuentry can be customized with --grub-preable, --grub2-prolog or --grub_prefix options.

    In order to use the the generated menuentry on your development machine that uses GRUB2, append the following snippet to /etc/grub.d/40_custom file and regenerate your grub configuration, i.e. run update-grub on Debian/Ubuntu.

      if [ -f /path/to/nul/build/grub.cfg ]; then
    source /path/to/nul/build/grub.cfg
  fi

  • --grub2-prolog=prolog

    Specifies text preable that is put at the beginning of the entry GRUB2 entry.

  • -m, --make[=make command]

    Runs make to build files that are not generated by novaboot itself.

  • --name=string

    Use the name string instead of the name of the novaboot script. This name is used for things like a title of grub menu or for the server directory where the boot files are copied to.

  • --no-file-gen

    Do not run external commands to generate files (i.e. "<" syntax and run keyword). This switch does not influence generation of files specified with "<<WORD" syntax.

  • -p, --pulsar[=mac]

    Generates pulsar bootloader configuration file named config-_mac_ The mac string is typically a MAC address and defaults to novaboot.

  • --scons[=scons command]

    Runs scons to build files that are not generated by novaboot itself.

  • --strip-rom

    Strip rom:// prefix from command lines and generated config files. The rom:// prefix is used by NUL. For NRE, it has to be stripped.

  • --gen-only

    Exit novaboot after file generation phase.

Target connection check

If supported by the target, the connection to it is made and it is checked whether the target is not occupied by another novaboot user/instance.

  • --amt="[user[:password]@]host[:port]

    Use Intel AMT technology to control the target machine. WS management is used to powercycle it and Serial-Over-Lan (SOL) for input/output. The hostname or (IP address) is given by the host parameter. If password is not specified, environment variable AMT_PASSWORD is used. The port specifies a TCP port for SOL. If not specified, the default is 16992. Default user is admin.

  • --iprelay=addr[:port]

    Use TCP/IP relay and serial port to access the target's serial port and powercycle it. The IP address of the relay is given by addr parameter. If port is not specified, it default to 23.

    Note: This option is supposed to work with HWG-ER02a IP relays.

  • -s, --serial[=device]

    Target's serial line is connected to host's serial line (device). The default value for device is /dev/ttyUSB0.

    The value of this option is exported in NB_NOVABOOT environment variable to all subprocesses run by novaboot.

  • --stty=settings

    Specifies settings passed to stty invoked on the serial line specified with --serial option. If this option is not given, stty is called with raw -crtscts -onlcr 115200 settings.

  • --remote-cmd=cmd

    Command that mediates connection to the target's serial line. For example ssh server 'cu -l /dev/ttyS0'.

  • --remote-expect=string

    Wait for reception of string after establishing the the remote connection before continuing.

File deployment phase

In some setups, it is necessary to copy the files needed for booting to a particular location, e.g. to a TFTP boot server or to the /boot partition.

  • -d, --dhcp-tftp

    Turns your workstation into a DHCP and TFTP server so that the OS can be booted via PXE BIOS (or similar mechanism) on the test machine directly connected by a plain Ethernet cable to your workstation.

    The DHCP and TFTP servers require root privileges and novaboot uses sudo command to obtain those. You can put the following to /etc/sudoers to allow running the necessary commands without asking for password.

      Cmnd_Alias NOVABOOT = /bin/ip a add 10.23.23.1/24 dev eth0, /bin/ip l set dev eth0 up, /usr/sbin/dhcpd -d -cf dhcpd.conf -lf dhcpd.leases -pf dhcpd.pid, /usr/sbin/in.tftpd --foreground --secure -v -v -v --pidfile tftpd.pid *, /usr/bin/touch dhcpd.leases, /usr/bin/pkill --pidfile=dhcpd.pid, /usr/bin/pkill --pidfile=tftpd.pid
  your_login ALL=NOPASSWD: NOVABOOT

  • --iso[=filename]

    Generates the ISO image that boots NOVA system via GRUB. If no filename is given, the image is stored under NAME.iso, where NAME is the name of the novaboot script (see also --name).

  • --server[=[[user@]server:]path]

    Copy all files needed for booting to another location (implies -g unless --grub2 is given). The files will be copied (by rsync tool) to the directory path. If the path contains string $NAME, it will be replaced with the name of the novaboot script (see also --name).

  • --concat

    If --server is used and its value ends with $NAME, then after copying the files, a new bootloader configuration file (e.g. menu.lst) is created at path-wo-name, i.e. the path specified by --server with $NAME part removed. The content of the file is created by concatenating all files of the same name from all subdirectories of path-wo-name found on the "server".

  • --rsync-flags=flags

    Specifies which flags are appended to rsync command line when copying files as a result of --server option.

Target power-on and reset phase

  • --on, --off

    Switch on/off the target machine and exit. The script (if any) is completely ignored. Currently it works only with --iprelay or --amt.

  • -Q, --qemu[=qemu-binary]

    Boot the configuration in qemu. Optionally, the name of qemu binary can be specified as a parameter.

  • --qemu-append=flags

    Append flags to the default qemu flags (QEMU_FLAGS variable or -cpu coreduo -smp 2).

  • -q, --qemu-flags=flags

    Replace the default qemu flags (QEMU_FLAGS variable or -cpu coreduo \-smp 2) with flags specified here.

  • --reset-cmd=cmd

    Command that resets the target.

Interaction with the bootloader on the target

  • --uboot

    Interact with uBoot bootloader to boot the thing described in the novaboot script. Implementation of this option is currently tied to a particular board that we use. It may be subject to changes in the future!

  • --uboot-init

    Command(s) to send the U-Boot bootloader before loading the images and booting them.

Target interaction phase

In this phase, target's serial output is redirected to stdout and if stdin is a TTY, it is redirected to the target's serial input allowing interactive work with the target.

  • --exiton=string

    When string is sent by the target, novaboot exits. This option can be specified multiple times.

    If string is -re, then the next --exiton's string is treated as regular expression. For example:

      --exiton -re --exiton 'error:.*failed'

  • -i, --interactive

    Setup things for interactive use of target. Your terminal will be switched to raw mode. In raw mode, your system does not process input in any way (no echoing of entered characters, no interpretation special characters). This, among others, means that Ctrl-C is passed to the target and does no longer interrupt novaboot. Use "~~." sequence to exit novaboot.

  • --expect=string

    When string is received from the target, send the string specified with the subsequent --send* option to the target.

  • --expect-re=regex

    When target's output matches regular expression regex, send the string specified with the subsequent --send* option to the target.

  • --expect-raw=perl-code

    Provides direct control over Perl's Expect module.

  • --send=string

    Send string to the target after the previously specified --expect* was matched in the target's output. The string may contain escape sequences such as "\n".

    Note that string is actually interpreted by Perl, so it can contain much more that escape sequences. This behavior may change in the future.

    Example: --expect='login: ' --send='root\n'

  • --sendcont=string

    Similar to --send but continue expecting more input.

    Example: --expect='Continue?' --sendcont='yes\n'

NOVABOOT SCRIPT SYNTAX

The syntax tries to mimic POSIX shell syntax. The syntax is defined with the following rules.

Lines starting with "#" and empty lines are ignored.

Lines that end with "\" are concatenated with the following line after removal of the final "\" and leading whitespace of the following line.

Lines of the form VARIABLE=... (i.e. matching '^[A-Z_]+=' regular expression) assign values to internal variables. See "VARIABLES" section.

Lines starting with load keyword represent modules to boot. The word after load is a file name (relative to the build directory (see --build-dir) of the module to load and the remaining words are passed to it as the command line parameters.

When the load line ends with "<<WORD" then the subsequent lines until the line containing solely WORD are copied literally to the file named on that line. This is similar to shell's heredoc feature.

When the load line ends with "< CMD" then command CMD is executed with /bin/sh and its standard output is stored in the file named on that line. The SRCDIR variable in CMD's environment is set to the absolute path of the directory containing the interpreted novaboot script.

Lines starting with run keyword contain shell commands that are run during file generation phase. This is the same as the "< CMD" syntax for load keyboard except that the command's output is not redirected to a file. The ordering of commands is the same as they appear in the novaboot script.

Example (Linux):

#!/usr/bin/env novaboot
load bzImage console=ttyS0,115200
run  make -C buildroot
load rootfs.cpio < gen_cpio buildroot/images/rootfs.cpio "myapp->/etc/init.d/S99myapp"

Example (NOVA User Land - NUL):

#!/usr/bin/env novaboot
WVDESC=Example program
load bin/apps/sigma0.nul S0_DEFAULT script_start:1,1 \
                         verbose hostkeyb:0,0x60,1,12,2
load bin/apps/hello.nul
load hello.nulconfig <<EOF
sigma0::mem:16 name::/s0/log name::/s0/timer name::/s0/fs/rom ||
rom://bin/apps/hello.nul
EOF

This example will load three modules: sigma0.nul, hello.nul and hello.nulconfig. sigma0 receives some command line parameters and hello.nulconfig file is generated on the fly from the lines between <<EOF and EOF.

VARIABLES

The following variables are interpreted in the novaboot script:

  • BUILDDIR

    Novaboot chdir()s to this directory before file generation phase. The directory name specified here is relative to the build directory specified by other means (see "--build-dir").

  • EXITON

    Assigning this variable has the same effect as specifying "--exiton" option.

  • HYPERVISOR_PARAMS

    Parameters passed to hypervisor. The default value is "serial", unless overridden in configuration file.

  • KERNEL

    The kernel to use instead of the hypervisor specified in the configuration file with the $hypervisor variable. The value should contain the name of the kernel image as well as its command line parameters. If this variable is defined and non-empty, the variable HYPERVISOR_PARAMS is not used.

  • QEMU

    Use a specific qemu binary (can be overridden with -Q) and flags when booting this script under qemu. If QEMU_FLAGS variable is also specified flags specified in QEMU variable are replaced by those in QEMU_FLAGS.

  • QEMU_FLAGS

    Use specific qemu flags (can be overridden with -q).

  • WVDESC

    Description of the wvtest-compliant program.

  • WVTEST_TIMEOUT

    The timeout in seconds for WvTest harness. If no complete line appears in the test output within the time specified here, the test fails. It is necessary to specify this for long running tests that produce no intermediate output.

CONFIGURATION FILE

Novaboot can read its configuration from one or more files. By default, novaboot looks for files named .novaboot as described in "Configuration reading phase". Alternatively, its location can be specified with the -c switch or with the NOVABOOT_CONFIG environment variable. The configuration file has perl syntax and should set values of certain Perl variables. The current configuration can be dumped with the --dump-config switch. Some configuration variables can be overridden by environment variables (see below) or by command line switches.

Supported configuration variables include:

  • $builddir

    Build directory location relative to the location of the configuration file.

  • $default_target

    Default target (see below) to use when no target is explicitly specified on command line with the --target option.

  • %targets

    Hash of shortcuts to be used with the --target option. If the hash contains, for instance, the following pair of values

      'mybox' => '--server=boot:/tftproot --serial=/dev/ttyUSB0 --grub',

    then the following two commands are equivalent:

      ./script --server=boot:/tftproot --serial=/dev/ttyUSB0 --grub
  ./script -t mybox

ENVIRONMENT VARIABLES

Some options can be specified not only via config file or command line but also through environment variables. Environment variables override the values from configuration file and command line parameters override the environment variables.

  • NOVABOOT_CONFIG

    Name of the novaboot configuration file to use instead of the default one(s).

  • NOVABOOT_BENDER

    Defining this variable has the same meaning as --bender option.

AUTHORS

Michal Sojka sojka@os.inf.tu-dresden.de