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. Their content is
79 described in ["CONFIGURATION FILE"](#configuration-file). By default, configuration is
80 read from two locations. First from the configuration directory and
81 second from `.novaboot` files along the path to the current
82 directory. The later read files override settings from the former
85 Configuration directory is determined by the content of
86 NOVABOOT\_CONFIG\_DIR environment variable defaulting to
87 `/etc/novaboot.d`. Files in this directory with names consisting
88 solely from English letters, numbers, dashes '-' and underscores '\_'
89 (note that dot '.' is not included) are read in alphabetical order.
91 Then novaboot searches for files named `.novaboot` starting
92 from the directory of the novaboot script (or working directory, see
93 bellow) and continuing upwards up to the root directory. The found
94 configuration files are then read in order from the root directory
97 In certain cases, the location of the novaboot script cannot be
98 determined in this early phase. This happens either when the script is
99 read from the standard input or when novaboot is invoked explicitly
100 and options precede the script name, as in the example ["4."](#4) above.
101 In this case the current working directory is used as a starting point
102 for configuration file search instead of the novaboot script
105 - -c, --config=_filename_
107 Use the specified configuration file instead of the default one(s).
109 ## Command line processing phase
113 Dump the current configuration to stdout end exits. Useful as an
114 initial template for a configuration file.
118 Print short (**-h**) or long (**--help**) help.
120 - -t, --target=_target_
122 This option serves as a user configurable shortcut for other novaboot
123 options. The effect of this option is the same as the options stored
124 in the `%targets` configuration variable under key _target_. See
125 also ["CONFIGURATION FILE"](#configuration-file).
127 ## Script preprocessing phase
129 This phases allows to modify the parsed novaboot script before it is
130 used in the later phases.
132 - -a, --append=_parameters_
134 Append a string to the first `load` line in the novaboot script. This
135 can be used to append parameters to the kernel's or root task's
136 command line. Can appear multiple times.
140 Use `bender` chainloader. Bender scans the PCI bus for PCI serial
141 ports and stores the information about them in the BIOS data area for
144 - --chainloader=_chainloader_
146 Chainloader that is loaded before the kernel and other files specified
147 in the novaboot script. E.g. 'bin/boot/bender promisc'.
151 Print the modules to boot and their parameters after this phase
152 finishes. Then exit. This is useful for seeing the effect of other
153 options in this section.
155 - -k, --kernel=`file`
157 Replace the first word on the first `load` line in the novaboot
160 - --scriptmod=_perl expression_
162 When novaboot script is read, _perl expression_ is executed for every
163 line (in $\_ variable). For example, `novaboot
164 \--scriptmod=s/sigma0/omega6/g` replaces every occurrence of _sigma0_
165 in the script with _omega6_.
167 When this option is present, it overrides _$script\_modifier_ variable
168 from the configuration file, which has the same effect. If this option
169 is given multiple times all expressions are evaluated in the command
172 ## File generation phase
174 In this phase, files needed for booting are generated in a so called
175 _build directory_ (see ["--build-dir"](#build-dir)). In most cases configuration
176 for a bootloader is generated automatically by novaboot. It is also
177 possible to generate other files using _heredoc_ or _"<"_ syntax in
178 novaboot scripts. Finally, binaries can be generated in this phases by
179 running `scons` or `make`.
181 - --build-dir=_directory_
183 Overrides the default build directory location.
185 The default build directory location is determined as follows: If the
186 configuration file defines the `$builddir` variable, its value is
187 used. Otherwise, it is the directory that contains the first processed
190 See also ["BUILDDIR"](#builddir) variable.
192 - -g, --grub\[=_filename_\]
194 Generates grub bootloader menu file. If the _filename_ is not
195 specified, `menu.lst` is used. The _filename_ is relative to the
196 build directory (see **--build-dir**).
198 - --grub-preamble=_prefix_
200 Specifies the _preable_ that is at the beginning of the generated
201 GRUB or GRUB2 config files. This is useful for specifying GRUB's
204 - --grub-prefix=_prefix_
206 Specifies _prefix_ that is put in front of every file name in GRUB's
207 `menu.lst`. The default value is the absolute path to the build directory.
209 If the _prefix_ contains string $NAME, it will be replaced with the
210 name of the novaboot script (see also **--name**).
212 - --grub2\[=_filename_\]
214 Generate GRUB2 menuentry in _filename_. If _filename_ is not
215 specified `grub.cfg` is used. The content of the menuentry can be
216 customized with **--grub-preable**, **--grub2-prolog** or
217 **--grub\_prefix** options.
219 In order to use the the generated menuentry on your development
220 machine that uses GRUB2, append the following snippet to
221 `/etc/grub.d/40_custom` file and regenerate your grub configuration,
222 i.e. run update-grub on Debian/Ubuntu.
224 if [ -f /path/to/nul/build/grub.cfg ]; then
225 source /path/to/nul/build/grub.cfg
228 - --grub2-prolog=_prolog_
230 Specifies text _preable_ that is put at the beginning of the entry
233 - -m, --make\[=make command\]
235 Runs `make` to build files that are not generated by novaboot itself.
239 Use the name _string_ instead of the name of the novaboot script.
240 This name is used for things like a title of grub menu or for the
241 server directory where the boot files are copied to.
245 Do not run external commands to generate files (i.e. "<" syntax and
246 `run` keyword). This switch does not influence generation of files
247 specified with "<<WORD" syntax.
249 - -p, --pulsar\[=mac\]
251 Generates pulsar bootloader configuration file named `config-_mac_`
252 The _mac_ string is typically a MAC address and defaults to
255 - --scons\[=scons command\]
257 Runs `scons` to build files that are not generated by novaboot
262 Strip _rom://_ prefix from command lines and generated config files.
263 The _rom://_ prefix is used by NUL. For NRE, it has to be stripped.
267 Exit novaboot after file generation phase.
269 ## Target connection check
271 If supported by the target, the connection to it is made and it is
272 checked whether the target is not occupied by another novaboot
275 - --amt=_"\[user\[:password\]@\]host\[:port\]_
277 Use Intel AMT technology to control the target machine. WS management
278 is used to powercycle it and Serial-Over-Lan (SOL) for input/output.
279 The hostname or (IP address) is given by the _host_ parameter. If
280 _password_ is not specified, environment variable AMT\_PASSWORD is
281 used. The _port_ specifies a TCP port for SOL. If not specified, the
282 default is 16992. Default _user_ is admin.
286 Use Intel AMT technology for IDE redirection. This allows the target
287 machine to boot from nonvaboot created ISO image.
289 The experimental _amtider_ utility needed by this option can be
290 obtained from https://github.com/wentasah/amtterm.
292 - --iprelay=_addr\[:port\]_
294 Use TCP/IP relay and serial port to access the target's serial port
295 and powercycle it. The IP address of the relay is given by _addr_
296 parameter. If _port_ is not specified, it default to 23.
298 Note: This option is supposed to work with HWG-ER02a IP relays.
300 - -s, --serial\[=device\]
302 Target's serial line is connected to host's serial line (device). The
303 default value for device is `/dev/ttyUSB0`.
305 The value of this option is exported in NB\_NOVABOOT environment
306 variable to all subprocesses run by `novaboot`.
310 Specifies settings passed to `stty` invoked on the serial line
311 specified with **--serial** option. If this option is not given,
312 `stty` is called with `raw -crtscts -onlcr 115200` settings.
316 Command that mediates connection to the target's serial line. For
317 example `ssh server 'cu -l /dev/ttyS0'`.
319 - --remote-expect=_string_
321 Wait for reception of _string_ after establishing the the remote
322 connection before continuing.
324 ## File deployment phase
326 In some setups, it is necessary to copy the files needed for booting
327 to a particular location, e.g. to a TFTP boot server or to the
332 Turns your workstation into a DHCP and TFTP server so that the OS can
333 be booted via PXE BIOS (or similar mechanism) on the test machine
334 directly connected by a plain Ethernet cable to your workstation.
336 The DHCP and TFTP servers requires root privileges and `novaboot`
337 uses `sudo` command to obtain those. You can put the following to
338 _/etc/sudoers_ to allow running the necessary commands without asking
341 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
342 your_login ALL=NOPASSWD: NOVABOOT
346 Starts a TFTP server on your workstation. This is similar to
347 **--dhcp-tftp** except that DHCP server is not started.
349 The TFTP server require root privileges and `novaboot` uses `sudo`
350 command to obtain those. You can put the following to _/etc/sudoers_
351 to allow running the necessary commands without asking for password.
353 Cmnd_Alias NOVABOOT = /usr/sbin/in.tftpd --listen --secure -v -v -v --pidfile tftpd.pid *, /usr/bin/pkill --pidfile=tftpd.pid
354 your_login ALL=NOPASSWD: NOVABOOT
358 Port to run the TFTP server on. Implies **--tftp**.
362 Generates the ISO image that boots NOVA system via GRUB. If no filename
363 is given, the image is stored under _NAME_.iso, where _NAME_ is the name
364 of the novaboot script (see also **--name**).
366 - --server\[=\[\[user@\]server:\]path\]
368 Copy all files needed for booting to another location (implies **-g**
369 unless **--grub2** is given). The files will be copied (by **rsync**
370 tool) to the directory _path_. If the _path_ contains string $NAME,
371 it will be replaced with the name of the novaboot script (see also
376 If **--server** is used and its value ends with $NAME, then after
377 copying the files, a new bootloader configuration file (e.g. menu.lst)
378 is created at _path-wo-name_, i.e. the path specified by **--server**
379 with $NAME part removed. The content of the file is created by
380 concatenating all files of the same name from all subdirectories of
381 _path-wo-name_ found on the "server".
383 - --rsync-flags=_flags_
385 Specifies which _flags_ are appended to `rsync` command line when
386 copying files as a result of _--server_ option.
388 ## Target power-on and reset phase
392 Switch on/off the target machine and exit. The script (if any) is
393 completely ignored. Currently it works only with **--iprelay** or
396 - -Q, --qemu\[=_qemu-binary_\]
398 Boot the configuration in qemu. Optionally, the name of qemu binary
399 can be specified as a parameter.
401 - --qemu-append=_flags_
403 Append _flags_ to the default qemu flags (QEMU\_FLAGS variable or
404 `-cpu coreduo -smp 2`).
406 - -q, --qemu-flags=_flags_
408 Replace the default qemu flags (QEMU\_FLAGS variable or `-cpu coreduo
409 \-smp 2`) with _flags_ specified here.
413 Command that resets the target.
415 ## Interaction with the bootloader on the target
417 - --uboot\[=_prompt_\]
419 Interact with uBoot bootloader to boot the thing described in the
420 novaboot script. _prompt_ specifies the U-Boot's prompt (default is
421 "=> ", other common prompts are "U-Boot> " or "U-Boot# ").
422 Implementation of this option is currently tied to a particular board
423 that we use. It may be subject to changes in the future!
427 Command(s) to send the U-Boot bootloader before loading the images and
428 booting them. This option can be given multiple times. After sending
429 commands from each option novaboot waits for U-Boot _prompt_.
431 If the command contains string _$NB\_MYIP_ then this string is
432 replaced by IPv4 address of eth0 interface.
434 ## Target interaction phase
436 In this phase, target's serial output is redirected to stdout and if
437 stdin is a TTY, it is redirected to the target's serial input allowing
438 interactive work with the target.
442 When _string_ is sent by the target, novaboot exits. This option can
443 be specified multiple times.
445 If _string_ is `-re`, then the next **--exiton**'s _string_ is
446 treated as regular expression. For example:
448 --exiton -re --exiton 'error:.*failed'
452 Setup things for interactive use of target. Your terminal will be
453 switched to raw mode. In raw mode, your system does not process input
454 in any way (no echoing of entered characters, no interpretation
455 special characters). This, among others, means that Ctrl-C is passed
456 to the target and does no longer interrupt novaboot. Use "~~."
457 sequence to exit novaboot.
461 When _string_ is received from the target, send the string specified
462 with the subsequent **--send\*** option to the target.
464 - --expect-re=_regex_
466 When target's output matches regular expression _regex_, send the
467 string specified with the subsequent **--send\*** option to the target.
469 - --expect-raw=_perl-code_
471 Provides direct control over Perl's Expect module.
475 Send _string_ to the target after the previously specified
476 **--expect\*** was matched in the target's output. The _string_ may
477 contain escape sequences such as "\\n".
479 Note that _string_ is actually interpreted by Perl, so it can contain
480 much more that escape sequences. This behavior may change in the
483 Example: `--expect='login: ' --send='root\n'`
485 - --sendcont=_string_
487 Similar to **--send** but continue expecting more input.
489 Example: `--expect='Continue?' --sendcont='yes\n'`
491 # NOVABOOT SCRIPT SYNTAX
493 The syntax tries to mimic POSIX shell syntax. The syntax is defined
494 with the following rules.
496 Lines starting with "#" and empty lines are ignored.
498 Lines that end with "\\" are concatenated with the following line after
499 removal of the final "\\" and leading whitespace of the following line.
501 Lines of the form _VARIABLE=..._ (i.e. matching '^\[A-Z\_\]+=' regular
502 expression) assign values to internal variables. See ["VARIABLES"](#variables)
505 Lines starting with `load` keyword represent modules to boot. The
506 word after `load` is a file name (relative to the build directory
507 (see **--build-dir**) of the module to load and the remaining words are
508 passed to it as the command line parameters.
510 When the `load` line ends with "<<WORD" then the subsequent lines
511 until the line containing solely WORD are copied literally to the file
512 named on that line. This is similar to shell's heredoc feature.
514 When the `load` line ends with "< CMD" then command CMD is executed
515 with `/bin/sh` and its standard output is stored in the file named on
516 that line. The SRCDIR variable in CMD's environment is set to the
517 absolute path of the directory containing the interpreted novaboot
520 Lines starting with `run` keyword contain shell commands that are run
521 during file generation phase. This is the same as the "< CMD" syntax
522 for `load` keyboard except that the command's output is not
523 redirected to a file. The ordering of commands is the same as they
524 appear in the novaboot script.
528 #!/usr/bin/env novaboot
529 load bzImage console=ttyS0,115200
530 run make -C buildroot
531 load rootfs.cpio < gen_cpio buildroot/images/rootfs.cpio "myapp->/etc/init.d/S99myapp"
533 Example (NOVA User Land - NUL):
535 #!/usr/bin/env novaboot
536 WVDESC=Example program
537 load bin/apps/sigma0.nul S0_DEFAULT script_start:1,1 \
538 verbose hostkeyb:0,0x60,1,12,2
539 load bin/apps/hello.nul
540 load hello.nulconfig <<EOF
541 sigma0::mem:16 name::/s0/log name::/s0/timer name::/s0/fs/rom ||
542 rom://bin/apps/hello.nul
545 This example will load three modules: `sigma0.nul`, `hello.nul` and
546 `hello.nulconfig`. sigma0 receives some command line parameters and
547 `hello.nulconfig` file is generated on the fly from the lines between
552 The following variables are interpreted in the novaboot script:
556 Novaboot chdir()s to this directory before file generation phase. The
557 directory name specified here is relative to the build directory
558 specified by other means (see ["--build-dir"](#build-dir)).
562 Assigning this variable has the same effect as specifying ["--exiton"](#exiton)
567 Parameters passed to hypervisor. The default value is "serial", unless
568 overridden in configuration file.
572 The kernel to use instead of the hypervisor specified in the
573 configuration file with the `$hypervisor` variable. The value should
574 contain the name of the kernel image as well as its command line
575 parameters. If this variable is defined and non-empty, the variable
576 HYPERVISOR\_PARAMS is not used.
580 Use a specific qemu binary (can be overridden with **-Q**) and flags
581 when booting this script under qemu. If QEMU\_FLAGS variable is also
582 specified flags specified in QEMU variable are replaced by those in
587 Use specific qemu flags (can be overridden with **-q**).
591 Description of the wvtest-compliant program.
595 The timeout in seconds for WvTest harness. If no complete line appears
596 in the test output within the time specified here, the test fails. It
597 is necessary to specify this for long running tests that produce no
602 Novaboot can read its configuration from one or more files. By
603 default, novaboot looks for files named `.novaboot` as described in
604 ["Configuration reading phase"](#configuration-reading-phase). Alternatively, configuration file
605 location can be specified with the **-c** switch or with the
606 NOVABOOT\_CONFIG environment variable. The configuration file has perl
607 syntax and should set values of certain Perl variables. The current
608 configuration can be dumped with the **--dump-config** switch. Some
609 configuration variables can be overridden by environment variables
610 (see below) or by command line switches.
612 Supported configuration variables include:
616 Build directory location relative to the location of the configuration
621 Default target (see below) to use when no target is explicitly
622 specified on command line with the **--target** option.
626 Hash of target definitions to be used with the **--target** option. The
627 key is the identifier of the target, the value is the string with
628 command line options. For instance, if the configuration file contains:
630 $targets{'mybox'} = '--server=boot:/tftproot --serial=/dev/ttyUSB0 --grub',
632 then the following two commands are equivalent:
634 ./script --server=boot:/tftproot --serial=/dev/ttyUSB0 --grub
637 # ENVIRONMENT VARIABLES
639 Some options can be specified not only via config file or command line
640 but also through environment variables. Environment variables override
641 the values from configuration file and command line parameters
642 override the environment variables.
646 Name of the novaboot configuration file to use instead of the default
649 - NOVABOOT\_CONFIG\_DIR
651 Name of the novaboot configuration directory. When not specified
652 `/etc/novaboot.d` is used.
656 Defining this variable has the same meaning as **--bender** option.
660 Michal Sojka <sojka@os.inf.tu-dresden.de>