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.
271 - \--iprelay=_addr\[:port\]_
273 Use TCP/IP relay and serial port to access the target's serial port
274 and powercycle it. The IP address of the relay is given by _addr_
275 parameter. If _port_ is not specified, it default to 23.
277 Note: This option is supposed to work with HWG-ER02a IP relays.
279 - \-s, --serial\[=device\]
281 Target's serial line is connected to host's serial line (device). The
282 default value for device is `/dev/ttyUSB0`.
284 The value of this option is exported in NB\_NOVABOOT environment
285 variable to all subprocesses run by `novaboot`.
289 Specifies settings passed to `stty` invoked on the serial line
290 specified with __\--serial__ option. If this option is not given,
291 `stty` is called with `raw -crtscts -onlcr 115200` settings.
293 - \--remote-cmd=_cmd_
295 Command that mediates connection to the target's serial line. For
296 example `ssh server 'cu -l /dev/ttyS0'`.
298 - \--remote-expect=_string_
300 Wait for reception of _string_ after establishing the the remote
301 connection before continuing.
305 ## File deployment phase
307 In some setups, it is necessary to copy the files needed for booting
308 to a particular location, e.g. to a TFTP boot server or to the
313 Turns your workstation into a DHCP and TFTP server so that the OS can
314 be booted via PXE BIOS (or similar mechanism) on the test machine
315 directly connected by a plain Ethernet cable to your workstation.
317 The DHCP and TFTP servers require root privileges and `novaboot`
318 uses `sudo` command to obtain those. You can put the following to
319 _/etc/sudoers_ to allow running the necessary commands without
322 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
323 your_login ALL=NOPASSWD: NOVABOOT
325 - \--iso\[=filename\]
327 Generates the ISO image that boots NOVA system via GRUB. If no filename
328 is given, the image is stored under _NAME_.iso, where _NAME_ is the name
329 of the novaboot script (see also __\--name__).
331 - \--server\[=\[\[user@\]server:\]path\]
333 Copy all files needed for booting to another location (implies __\-g__
334 unless __\--grub2__ is given). The files will be copied (by __rsync__
335 tool) to the directory _path_. If the _path_ contains string $NAME,
336 it will be replaced with the name of the novaboot script (see also
341 If __\--server__ is used and its value ends with $NAME, then after
342 copying the files, a new bootloader configuration file (e.g. menu.lst)
343 is created at _path-wo-name_, i.e. the path specified by __\--server__
344 with $NAME part removed. The content of the file is created by
345 concatenating all files of the same name from all subdirectories of
346 _path-wo-name_ found on the "server".
348 - \--rsync-flags=_flags_
350 Specifies which _flags_ are appended to `rsync` command line when
351 copying files as a result of _\--server_ option.
353 ## Target power-on and reset phase
357 Switch on/off the target machine and exit. The script (if any) is
358 completely ignored. Currently it works only with __\--iprelay__ or
361 - \-Q, --qemu\[=_qemu-binary_\]
363 Boot the configuration in qemu. Optionally, the name of qemu binary
364 can be specified as a parameter.
366 - \--qemu-append=_flags_
368 Append _flags_ to the default qemu flags (QEMU\_FLAGS variable or
369 `-cpu coreduo -smp 2`).
371 - \-q, --qemu-flags=_flags_
373 Replace the default qemu flags (QEMU\_FLAGS variable or `-cpu coreduo
374 -smp 2`) with _flags_ specified here.
378 Command that resets the target.
380 ## Interaction with the bootloader on the target
384 Interact with uBoot bootloader to boot the thing described in the
385 novaboot script. Implementation of this option is currently tied to a
386 particular board that we use. It may be subject to changes in the
391 Command(s) to send the U-Boot bootloader before loading the images and
394 ## Target interaction phase
396 In this phase, target's serial output is redirected to stdout and if
397 stdin is a TTY, it is redirected to the target's serial input allowing
398 interactive work with the target.
402 When _string_ is sent by the target, novaboot exits. This option can
403 be specified multiple times.
405 If _string_ is `-re`, then the next __\--exiton__'s _string_ is
406 treated as regular expression. For example:
408 --exiton -re --exiton 'error:.*failed'
412 Setup things for interactive use of target. Your terminal will be
413 switched to raw mode. In raw mode, your system does not process input
414 in any way (no echoing of entered characters, no interpretation
415 special characters). This, among others, means that Ctrl-C is passed
416 to the target and does no longer interrupt novaboot. Use "~~."
417 sequence to exit novaboot.
421 When _string_ is received from the target, send the string specified
422 with the subsequent __\--send\*__ option to the target.
424 - \--expect-re=_regex_
426 When target's output matches regular expression _regex_, send the
427 string specified with the subsequent __\--send\*__ option to the target.
429 - \--expect-raw=_perl-code_
431 Provides direct control over Perl's Expect module.
435 Send _string_ to the target after the previously specified
436 __\--expect\*__ was matched in the target's output. The _string_ may
437 contain escape sequences such as "\\n".
439 Note that _string_ is actually interpreted by Perl, so it can contain
440 much more that escape sequences. This behavior may change in the
443 Example: `--expect='login: ' --send='root\n'`
445 - \--sendcont=_string_
447 Similar to __\--send__ but continue expecting more input.
449 Example: `--expect='Continue?' --sendcont='yes\n'`
451 # NOVABOOT SCRIPT SYNTAX
453 The syntax tries to mimic POSIX shell syntax. The syntax is defined
454 with the following rules.
456 Lines starting with "\#" and empty lines are ignored.
458 Lines that end with "\\" are concatenated with the following line after
459 removal of the final "\\" and leading whitespace of the following line.
461 Lines of the form _VARIABLE=..._ (i.e. matching '^\[A-Z\_\]+=' regular
462 expression) assign values to internal variables. See ["VARIABLES"](#variables)
465 Lines starting with `load` keyword represent modules to boot. The
466 word after `load` is a file name (relative to the build directory
467 (see __\--build-dir__) of the module to load and the remaining words are
468 passed to it as the command line parameters.
470 When the `load` line ends with "<<WORD" then the subsequent lines
471 until the line containing solely WORD are copied literally to the file
472 named on that line. This is similar to shell's heredoc feature.
474 When the `load` line ends with "< CMD" then command CMD is executed
475 with `/bin/sh` and its standard output is stored in the file named on
476 that line. The SRCDIR variable in CMD's environment is set to the
477 absolute path of the directory containing the interpreted novaboot
480 Lines starting with `run` keyword contain shell commands that are run
481 during file generation phase. This is the same as the "< CMD" syntax
482 for `load` keyboard except that the command's output is not
483 redirected to a file. The ordering of commands is the same as they
484 appear in the novaboot script.
488 #!/usr/bin/env novaboot
489 load bzImage console=ttyS0,115200
490 run make -C buildroot
491 load rootfs.cpio < gen_cpio buildroot/images/rootfs.cpio "myapp->/etc/init.d/S99myapp"
493 Example (NOVA User Land - NUL):
495 #!/usr/bin/env novaboot
496 WVDESC=Example program
497 load bin/apps/sigma0.nul S0_DEFAULT script_start:1,1 \
498 verbose hostkeyb:0,0x60,1,12,2
499 load bin/apps/hello.nul
500 load hello.nulconfig <<EOF
501 sigma0::mem:16 name::/s0/log name::/s0/timer name::/s0/fs/rom ||
502 rom://bin/apps/hello.nul
505 This example will load three modules: `sigma0.nul`, `hello.nul` and
506 `hello.nulconfig`. sigma0 receives some command line parameters and
507 `hello.nulconfig` file is generated on the fly from the lines between
512 The following variables are interpreted in the novaboot script:
516 Novaboot chdir()s to this directory before file generation phase. The
517 directory name specified here is relative to the build directory
518 specified by other means (see ["--build-dir"](#build-dir)).
522 Assigning this variable has the same effect as specifying ["--exiton"](#exiton)
527 Parameters passed to hypervisor. The default value is "serial", unless
528 overridden in configuration file.
532 The kernel to use instead of the hypervisor specified in the
533 configuration file with the `$hypervisor` variable. The value should
534 contain the name of the kernel image as well as its command line
535 parameters. If this variable is defined and non-empty, the variable
536 HYPERVISOR\_PARAMS is not used.
540 Use a specific qemu binary (can be overridden with __\-Q__) and flags
541 when booting this script under qemu. If QEMU\_FLAGS variable is also
542 specified flags specified in QEMU variable are replaced by those in
547 Use specific qemu flags (can be overridden with __\-q__).
551 Description of the wvtest-compliant program.
555 The timeout in seconds for WvTest harness. If no complete line appears
556 in the test output within the time specified here, the test fails. It
557 is necessary to specify this for long running tests that produce no
562 Novaboot can read its configuration from one or more files. By
563 default, novaboot looks for files named `.novaboot` as described in
564 ["Configuration reading phase"](#configuration-reading-phase). Alternatively, its location can be
565 specified with the __\-c__ switch or with the NOVABOOT\_CONFIG
566 environment variable. The configuration file has perl syntax and
567 should set values of certain Perl variables. The current configuration
568 can be dumped with the __\--dump-config__ switch. Some configuration
569 variables can be overridden by environment variables (see below) or by
570 command line switches.
572 Supported configuration variables include:
576 Build directory location relative to the location of the configuration
581 Default target (see below) to use when no target is explicitly
582 specified on command line with the __\--target__ option.
586 Hash of shortcuts to be used with the __\--target__ option. If the hash
587 contains, for instance, the following pair of values
589 'mybox' => '--server=boot:/tftproot --serial=/dev/ttyUSB0 --grub',
591 then the following two commands are equivalent:
593 ./script --server=boot:/tftproot --serial=/dev/ttyUSB0 --grub
596 # ENVIRONMENT VARIABLES
598 Some options can be specified not only via config file or command line
599 but also through environment variables. Environment variables override
600 the values from configuration file and command line parameters
601 override the environment variables.
605 Name of the novaboot configuration file to use instead of the default
610 Defining this variable has the same meaning as __\--bender__ option.
614 Michal Sojka <sojka@os.inf.tu-dresden.de>