3 novaboot - A tool for booting various operating systems on various hardware or in qemu
9 **novaboot** \[option\]... \[--\] script...
11 **./script** \[option\]...
15 This program makes booting of an operating system (e.g. NOVA or Linux)
16 as simple as running a local program. It facilitates booting on local
17 or remote hosts or in emulators such as qemu. Novaboot operation is
18 controlled by command line options and by a so called novaboot script,
19 which can be thought as a generalization of bootloader configuration
20 files (see ["NOVABOOT SCRIPT SYNTAX"](#novaboot-script-syntax)). Based on this input,
21 novaboot setups everything for the target host to boot the desired
22 configuration, i.e. it generates the bootloader configuration file in
23 the proper format, deploy the binaries and other needed files to
24 required locations, perhaps on a remote boot server and reset the
25 target host. Finally, target host's serial output is redirected to
26 standard output if that is possible.
28 Typical way of using novaboot is to make the novaboot script
29 executable and set its first line to _#!/usr/bin/env novaboot_. Then,
30 booting a particular OS configuration becomes the same as executing a
31 local program - the novaboot script.
33 For example, with `novaboot` you can:
35 1. Run an OS in Qemu. This is the default action when no other action is
36 specified by command line switches. Thus running `novaboot ./script`
37 (or `./script` as described above) will run Qemu and make it boot the
38 configuration specified in the `script`.
39 2. Create a bootloader configuration file (currently supported
40 bootloaders are GRUB, GRUB2, Pulsar and U-Boot) and copy it with all
41 other files needed for booting to a remote boot server.
43 ./script --server=192.168.1.1:/tftp --iprelay=192.168.1.2
45 This command copies files to the TFTP server and uses
46 TCP/IP-controlled relay to reset the target host and receive its
49 3. Run DHCP and TFTP server on developer's machine to PXE-boot the target
54 When a PXE-bootable machine is connected via Ethernet to developer's
55 machine, it will boot the configuration described in _script_.
57 4. Create bootable ISO images. E.g.
59 novaboot --iso -- script1 script2
61 The created ISO image will have GRUB bootloader installed on it and
62 the boot menu will allow selecting between _script1_ and _script2_
65 Note that the options needed for a specific target can be stored in a
66 ["CONFIGURATION FILE"](#configuration-file). Then it is sufficient to use only the **-t**
67 option to specify the name of the target.
71 Novaboot performs its work in several phases. Each phase can be
72 influenced by several options, certain phases can be skipped. The list
73 of phases (in the execution order) and the corresponding options
76 ## Configuration reading phase
78 After starting, novaboot reads configuration files. By default, it
79 searches for files named `.novaboot` starting from the directory of
80 the novaboot script (or working directory, see bellow) and continuing
81 upwards up to the root directory. The configuration files are read in
82 order from the root directory downwards with latter files overriding
83 settings from the former ones.
85 In certain cases, the location of the novaboot script cannot be
86 determined in this early phase. This happens either when the script is
87 read from the standard input or when novaboot is invoked explicitly
88 and options precede the script name, as in the example ["4."](#4) above.
89 In this case the current working directory is used as a starting point
90 for configuration file search.
92 - -c, --config=_filename_
94 Use the specified configuration file instead of the default one(s).
96 ## Command line processing phase
100 Dump the current configuration to stdout end exits. Useful as an
101 initial template for a configuration file.
105 Print short (**-h**) or long (**--help**) help.
107 - -t, --target=_target_
109 This option serves as a user configurable shortcut for other novaboot
110 options. The effect of this option is the same as the options stored
111 in the `%targets` configuration variable under key _target_. See
112 also ["CONFIGURATION FILE"](#configuration-file).
114 ## Script preprocessing phase
116 This phases allows to modify the parsed novaboot script before it is
117 used in the later phases.
119 - -a, --append=_parameters_
121 Append a string to the first `load` line in the novaboot script. This
122 can be used to append parameters to the kernel's or root task's
123 command line. Can appear multiple times.
127 Use `bender` chainloader. Bender scans the PCI bus for PCI serial
128 ports and stores the information about them in the BIOS data area for
131 - --chainloader=_chainloader_
133 Chainloader that is loaded before the kernel and other files specified
134 in the novaboot script. E.g. 'bin/boot/bender promisc'.
138 Print the modules to boot and their parameters after this phase
139 finishes. Then exit. This is useful for seeing the effect of other
140 options in this section.
142 - -k, --kernel=`file`
144 Replace the first word on the first `load` line in the novaboot
147 - --scriptmod=_perl expression_
149 When novaboot script is read, _perl expression_ is executed for every
150 line (in $\_ variable). For example, `novaboot
151 \--scriptmod=s/sigma0/omega6/g` replaces every occurrence of _sigma0_
152 in the script with _omega6_.
154 When this option is present, it overrides _$script\_modifier_ variable
155 from the configuration file, which has the same effect. If this option
156 is given multiple times all expressions are evaluated in the command
159 ## File generation phase
161 In this phase, files needed for booting are generated in a so called
162 _build directory_ (see ["--build-dir"](#build-dir)). In most cases configuration
163 for a bootloader is generated automatically by novaboot. It is also
164 possible to generate other files using _heredoc_ or _"<"_ syntax in
165 novaboot scripts. Finally, binaries can be generated in this phases by
166 running `scons` or `make`.
168 - --build-dir=_directory_
170 Overrides the default build directory location.
172 The default build directory location is determined as follows: If the
173 configuration file defines the `$builddir` variable, its value is
174 used. Otherwise, it is the directory that contains the first processed
177 See also ["BUILDDIR"](#builddir) variable.
179 - -g, --grub\[=_filename_\]
181 Generates grub bootloader menu file. If the _filename_ is not
182 specified, `menu.lst` is used. The _filename_ is relative to the
183 build directory (see **--build-dir**).
185 - --grub-preamble=_prefix_
187 Specifies the _preable_ that is at the beginning of the generated
188 GRUB or GRUB2 config files. This is useful for specifying GRUB's
191 - --grub-prefix=_prefix_
193 Specifies _prefix_ that is put in front of every file name in GRUB's
194 `menu.lst`. The default value is the absolute path to the build directory.
196 If the _prefix_ contains string $NAME, it will be replaced with the
197 name of the novaboot script (see also **--name**).
199 - --grub2\[=_filename_\]
201 Generate GRUB2 menuentry in _filename_. If _filename_ is not
202 specified `grub.cfg` is used. The content of the menuentry can be
203 customized with **--grub-preable**, **--grub2-prolog** or
204 **--grub\_prefix** options.
206 In order to use the the generated menuentry on your development
207 machine that uses GRUB2, append the following snippet to
208 `/etc/grub.d/40_custom` file and regenerate your grub configuration,
209 i.e. run update-grub on Debian/Ubuntu.
211 if [ -f /path/to/nul/build/grub.cfg ]; then
212 source /path/to/nul/build/grub.cfg
215 - --grub2-prolog=_prolog_
217 Specifies text _preable_ that is put at the beginning of the entry
220 - -m, --make\[=make command\]
222 Runs `make` to build files that are not generated by novaboot itself.
226 Use the name _string_ instead of the name of the novaboot script.
227 This name is used for things like a title of grub menu or for the
228 server directory where the boot files are copied to.
232 Do not run external commands to generate files (i.e. "<" syntax and
233 `run` keyword). This switch does not influence generation of files
234 specified with "<<WORD" syntax.
236 - -p, --pulsar\[=mac\]
238 Generates pulsar bootloader configuration file named `config-_mac_`
239 The _mac_ string is typically a MAC address and defaults to
242 - --scons\[=scons command\]
244 Runs `scons` to build files that are not generated by novaboot
249 Strip _rom://_ prefix from command lines and generated config files.
250 The _rom://_ prefix is used by NUL. For NRE, it has to be stripped.
254 Exit novaboot after file generation phase.
256 ## Target connection check
258 If supported by the target, the connection to it is made and it is
259 checked whether the target is not occupied by another novaboot
262 - --amt=_"\[user\[:password\]@\]host\[:port\]_
264 Use Intel AMT technology to control the target machine. WS management
265 is used to powercycle it and Serial-Over-Lan (SOL) for input/output.
266 The hostname or (IP address) is given by the _host_ parameter. If
267 _password_ is not specified, environment variable AMT\_PASSWORD is
268 used. The _port_ specifies a TCP port for SOL. If not specified, the
269 default is 16992. Default _user_ is admin.
273 Use Intel AMT technology for IDE redirection. This allows the target
274 machine to boot from nonvaboot created ISO image.
276 The experimental _amtider_ utility needed by this option can be
277 obtained from https://github.com/wentasah/amtterm.
279 - --iprelay=_addr\[:port\]_
281 Use TCP/IP relay and serial port to access the target's serial port
282 and powercycle it. The IP address of the relay is given by _addr_
283 parameter. If _port_ is not specified, it default to 23.
285 Note: This option is supposed to work with HWG-ER02a IP relays.
287 - -s, --serial\[=device\]
289 Target's serial line is connected to host's serial line (device). The
290 default value for device is `/dev/ttyUSB0`.
292 The value of this option is exported in NB\_NOVABOOT environment
293 variable to all subprocesses run by `novaboot`.
297 Specifies settings passed to `stty` invoked on the serial line
298 specified with **--serial** option. If this option is not given,
299 `stty` is called with `raw -crtscts -onlcr 115200` settings.
303 Command that mediates connection to the target's serial line. For
304 example `ssh server 'cu -l /dev/ttyS0'`.
306 - --remote-expect=_string_
308 Wait for reception of _string_ after establishing the the remote
309 connection before continuing.
311 ## File deployment phase
313 In some setups, it is necessary to copy the files needed for booting
314 to a particular location, e.g. to a TFTP boot server or to the
319 Turns your workstation into a DHCP and TFTP server so that the OS can
320 be booted via PXE BIOS (or similar mechanism) on the test machine
321 directly connected by a plain Ethernet cable to your workstation.
323 The DHCP and TFTP servers requires root privileges and `novaboot`
324 uses `sudo` command to obtain those. You can put the following to
325 _/etc/sudoers_ to allow running the necessary commands without asking
328 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 --listen --secure -v -v -v --pidfile tftpd.pid *, /usr/bin/touch dhcpd.leases, /usr/bin/pkill --pidfile=dhcpd.pid, /usr/bin/pkill --pidfile=tftpd.pid
329 your_login ALL=NOPASSWD: NOVABOOT
333 Starts a TFTP server on your workstation. This is similar to
334 **--dhcp-tftp** except that DHCP server is not started.
336 The TFTP server require root privileges and `novaboot` uses `sudo`
337 command to obtain those. You can put the following to _/etc/sudoers_
338 to allow running the necessary commands without asking for password.
340 Cmnd_Alias NOVABOOT = /usr/sbin/in.tftpd --listen --secure -v -v -v --pidfile tftpd.pid *, /usr/bin/pkill --pidfile=tftpd.pid
341 your_login ALL=NOPASSWD: NOVABOOT
345 Port to run the TFTP server on. Implies **--tftp**.
349 Generates the ISO image that boots NOVA system via GRUB. If no filename
350 is given, the image is stored under _NAME_.iso, where _NAME_ is the name
351 of the novaboot script (see also **--name**).
353 - --server\[=\[\[user@\]server:\]path\]
355 Copy all files needed for booting to another location (implies **-g**
356 unless **--grub2** is given). The files will be copied (by **rsync**
357 tool) to the directory _path_. If the _path_ contains string $NAME,
358 it will be replaced with the name of the novaboot script (see also
363 If **--server** is used and its value ends with $NAME, then after
364 copying the files, a new bootloader configuration file (e.g. menu.lst)
365 is created at _path-wo-name_, i.e. the path specified by **--server**
366 with $NAME part removed. The content of the file is created by
367 concatenating all files of the same name from all subdirectories of
368 _path-wo-name_ found on the "server".
370 - --rsync-flags=_flags_
372 Specifies which _flags_ are appended to `rsync` command line when
373 copying files as a result of _--server_ option.
375 ## Target power-on and reset phase
379 Switch on/off the target machine and exit. The script (if any) is
380 completely ignored. Currently it works only with **--iprelay** or
383 - -Q, --qemu\[=_qemu-binary_\]
385 Boot the configuration in qemu. Optionally, the name of qemu binary
386 can be specified as a parameter.
388 - --qemu-append=_flags_
390 Append _flags_ to the default qemu flags (QEMU\_FLAGS variable or
391 `-cpu coreduo -smp 2`).
393 - -q, --qemu-flags=_flags_
395 Replace the default qemu flags (QEMU\_FLAGS variable or `-cpu coreduo
396 \-smp 2`) with _flags_ specified here.
400 Command that resets the target.
402 ## Interaction with the bootloader on the target
404 - --uboot\[=_prompt_\]
406 Interact with uBoot bootloader to boot the thing described in the
407 novaboot script. _prompt_ specifies the U-Boot's prompt (default is
408 "=> ", other common prompts are "U-Boot> " or "U-Boot# ").
409 Implementation of this option is currently tied to a particular board
410 that we use. It may be subject to changes in the future!
414 Command(s) to send the U-Boot bootloader before loading the images and
415 booting them. This option can be given multiple times. After sending
416 commands from each option novaboot waits for U-Boot _prompt_.
418 ## Target interaction phase
420 In this phase, target's serial output is redirected to stdout and if
421 stdin is a TTY, it is redirected to the target's serial input allowing
422 interactive work with the target.
426 When _string_ is sent by the target, novaboot exits. This option can
427 be specified multiple times.
429 If _string_ is `-re`, then the next **--exiton**'s _string_ is
430 treated as regular expression. For example:
432 --exiton -re --exiton 'error:.*failed'
436 Setup things for interactive use of target. Your terminal will be
437 switched to raw mode. In raw mode, your system does not process input
438 in any way (no echoing of entered characters, no interpretation
439 special characters). This, among others, means that Ctrl-C is passed
440 to the target and does no longer interrupt novaboot. Use "~~."
441 sequence to exit novaboot.
445 When _string_ is received from the target, send the string specified
446 with the subsequent **--send\*** option to the target.
448 - --expect-re=_regex_
450 When target's output matches regular expression _regex_, send the
451 string specified with the subsequent **--send\*** option to the target.
453 - --expect-raw=_perl-code_
455 Provides direct control over Perl's Expect module.
459 Send _string_ to the target after the previously specified
460 **--expect\*** was matched in the target's output. The _string_ may
461 contain escape sequences such as "\\n".
463 Note that _string_ is actually interpreted by Perl, so it can contain
464 much more that escape sequences. This behavior may change in the
467 Example: `--expect='login: ' --send='root\n'`
469 - --sendcont=_string_
471 Similar to **--send** but continue expecting more input.
473 Example: `--expect='Continue?' --sendcont='yes\n'`
475 # NOVABOOT SCRIPT SYNTAX
477 The syntax tries to mimic POSIX shell syntax. The syntax is defined
478 with the following rules.
480 Lines starting with "#" and empty lines are ignored.
482 Lines that end with "\\" are concatenated with the following line after
483 removal of the final "\\" and leading whitespace of the following line.
485 Lines of the form _VARIABLE=..._ (i.e. matching '^\[A-Z\_\]+=' regular
486 expression) assign values to internal variables. See ["VARIABLES"](#variables)
489 Lines starting with `load` keyword represent modules to boot. The
490 word after `load` is a file name (relative to the build directory
491 (see **--build-dir**) of the module to load and the remaining words are
492 passed to it as the command line parameters.
494 When the `load` line ends with "<<WORD" then the subsequent lines
495 until the line containing solely WORD are copied literally to the file
496 named on that line. This is similar to shell's heredoc feature.
498 When the `load` line ends with "< CMD" then command CMD is executed
499 with `/bin/sh` and its standard output is stored in the file named on
500 that line. The SRCDIR variable in CMD's environment is set to the
501 absolute path of the directory containing the interpreted novaboot
504 Lines starting with `run` keyword contain shell commands that are run
505 during file generation phase. This is the same as the "< CMD" syntax
506 for `load` keyboard except that the command's output is not
507 redirected to a file. The ordering of commands is the same as they
508 appear in the novaboot script.
512 #!/usr/bin/env novaboot
513 load bzImage console=ttyS0,115200
514 run make -C buildroot
515 load rootfs.cpio < gen_cpio buildroot/images/rootfs.cpio "myapp->/etc/init.d/S99myapp"
517 Example (NOVA User Land - NUL):
519 #!/usr/bin/env novaboot
520 WVDESC=Example program
521 load bin/apps/sigma0.nul S0_DEFAULT script_start:1,1 \
522 verbose hostkeyb:0,0x60,1,12,2
523 load bin/apps/hello.nul
524 load hello.nulconfig <<EOF
525 sigma0::mem:16 name::/s0/log name::/s0/timer name::/s0/fs/rom ||
526 rom://bin/apps/hello.nul
529 This example will load three modules: `sigma0.nul`, `hello.nul` and
530 `hello.nulconfig`. sigma0 receives some command line parameters and
531 `hello.nulconfig` file is generated on the fly from the lines between
536 The following variables are interpreted in the novaboot script:
540 Novaboot chdir()s to this directory before file generation phase. The
541 directory name specified here is relative to the build directory
542 specified by other means (see ["--build-dir"](#build-dir)).
546 Assigning this variable has the same effect as specifying ["--exiton"](#exiton)
551 Parameters passed to hypervisor. The default value is "serial", unless
552 overridden in configuration file.
556 The kernel to use instead of the hypervisor specified in the
557 configuration file with the `$hypervisor` variable. The value should
558 contain the name of the kernel image as well as its command line
559 parameters. If this variable is defined and non-empty, the variable
560 HYPERVISOR\_PARAMS is not used.
564 Use a specific qemu binary (can be overridden with **-Q**) and flags
565 when booting this script under qemu. If QEMU\_FLAGS variable is also
566 specified flags specified in QEMU variable are replaced by those in
571 Use specific qemu flags (can be overridden with **-q**).
575 Description of the wvtest-compliant program.
579 The timeout in seconds for WvTest harness. If no complete line appears
580 in the test output within the time specified here, the test fails. It
581 is necessary to specify this for long running tests that produce no
586 Novaboot can read its configuration from one or more files. By
587 default, novaboot looks for files named `.novaboot` as described in
588 ["Configuration reading phase"](#configuration-reading-phase). Alternatively, its location can be
589 specified with the **-c** switch or with the NOVABOOT\_CONFIG
590 environment variable. The configuration file has perl syntax and
591 should set values of certain Perl variables. The current configuration
592 can be dumped with the **--dump-config** switch. Some configuration
593 variables can be overridden by environment variables (see below) or by
594 command line switches.
596 Supported configuration variables include:
600 Build directory location relative to the location of the configuration
605 Default target (see below) to use when no target is explicitly
606 specified on command line with the **--target** option.
610 Hash of shortcuts to be used with the **--target** option. If the hash
611 contains, for instance, the following pair of values
613 'mybox' => '--server=boot:/tftproot --serial=/dev/ttyUSB0 --grub',
615 then the following two commands are equivalent:
617 ./script --server=boot:/tftproot --serial=/dev/ttyUSB0 --grub
620 # ENVIRONMENT VARIABLES
622 Some options can be specified not only via config file or command line
623 but also through environment variables. Environment variables override
624 the values from configuration file and command line parameters
625 override the environment variables.
629 Name of the novaboot configuration file to use instead of the default
634 Defining this variable has the same meaning as **--bender** option.
638 Michal Sojka <sojka@os.inf.tu-dresden.de>