3 novaboot - A tool for booting various operating systems on various hardware or in qemu
7 __novaboot__ \[ options \] \[--\] script...
9 __./script__ \[ options \]
13 This program makes it easier to boot NOVA or other operating system
14 (OS) on different targets (machines or emulators). It reads a so
15 called novaboot script, that specifies the boot configuration, and
16 setups the target to boot that configuration. Setting up the target
17 means to generate the bootloader configuration files, deploy the
18 binaries and other needed files to proper locations, perhaps on a
19 remote boot server and reset the target. Then, target's serial output
20 is redirected to standard output if that is possible.
22 A typical way of using novaboot is to make the novaboot script
23 executable and set its first line to _\#!/usr/bin/env novaboot_. Then,
24 booting a particular OS configuration becomes the same as executing a
25 local program - the novaboot script.
27 For example, with `novaboot` you can:
29 1. Run an OS in Qemu. This is the default action when no other action is
30 specified by command line switches. Thus running `novaboot ./script`
31 (or `./script` as described above) will run Qemu and make it boot the
32 configuration specified in the _script_.
33 2. Create a bootloader configuration file (currently supported
34 bootloaders are GRUB, GRUB2, Pulsar and uBoot) and copy it with all
35 other files needed for booting to another, perhaps remote, location.
37 ./script --server=192.168.1.1:/tftp --iprelay=192.168.1.2
39 This command copies files to the TFTP server and uses
40 TCP/IP-controlled relay to reset the test box and receive its serial
43 3. Run DHCP and TFTP server on developer's machine to PXE-boot the OS
48 When a PXE-bootable machine is connected via Ethernet to developer's
49 machine, it will boot the configuration described in _script_.
51 4. Create bootable ISO images. E.g.
53 novaboot --iso -- script1 script2
55 The created ISO image will have GRUB bootloader installed on it and
56 the boot menu will allow selecting between _script1_ and _script2_
59 Note that the options needed for a specific target can be stored in a
60 ["CONFIGURATION FILE"](#configuration-file) and then it is sufficient to use only the
61 __\-t__ option to specify the name of the target.
65 Novaboot performs its work in several phases. Each phase can be
66 influenced by several options, certain phases can be skipped. The list
67 of phases (in the execution order) and the corresponding options
70 ## Configuration reading phase
72 After starting, novaboot reads configuration files. By default, it
73 searches for files named `.novaboot` starting from the directory of
74 the novaboot script (or working directory, see bellow) and continuing
75 upwards up to the root directory. The configuration files are read in
76 order from the root directory downwards with latter files overriding
77 settings from the former ones.
79 In certain cases, the location of the novaboot script cannot be
80 determined in this early phase. This happens either when the script is
81 read from the standard input or when novaboot is invoked explicitly
82 and options precede the script name, as in the example ["4."](#4) above.
83 In this case the current working directory is used as a starting point
84 for configuration file search.
86 - \-c, --config=_filename_
88 Use the specified configuration file instead of the default one(s).
90 ## Command line processing phase
94 Dump the current configuration to stdout end exits. Useful as an
95 initial template for a configuration file.
99 Print short (__\-h__) or long (__\--help__) help.
101 - \-t, --target=_target_
103 This option serves as a user configurable shortcut for other novaboot
104 options. The effect of this option is the same as the options stored
105 in the `%targets` configuration variable under key _target_. See
106 also ["CONFIGURATION FILE"](#configuration-file).
108 ## Script preprocessing phase
110 This phases allows to modify the parsed novaboot script before it is
111 used in the later phases.
113 - \-a, --append=_parameters_
115 Appends a string to the first "filename" line in the novaboot script.
116 This can be used to append parameters to the kernel's or root task's
121 Use `bender` chainloader. Bender scans the PCI bus for PCI serial
122 ports and stores the information about them in the BIOS data area for
125 - \--chainloader=_chainloader_
127 Chainloader that is loaded before the kernel and other files specified
128 in the novaboot script. E.g. 'bin/boot/bender promisc'.
132 Prints the content of the novaboot script after removing comments and
133 evaluating all _\--scriptmod_ expressions. Exit after reading (and
136 - \--scriptmod=_perl expression_
138 When novaboot script is read, _perl expression_ is executed for every
139 line (in $\_ variable). For example, `novaboot
140 --scriptmod=s/sigma0/omega6/g` replaces every occurrence of _sigma0_
141 in the script with _omega6_.
143 When this option is present, it overrides _$script\_modifier_ variable
144 from the configuration file, which has the same effect. If this option
145 is given multiple times all expressions are evaluated in the command
150 Strip _rom://_ prefix from command lines and generated config files.
151 The _rom://_ prefix is used by NUL. For NRE, it has to be stripped.
153 ## File generation phase
155 In this phase, files needed for booting are generated in a so called
156 _build directory_ (see TODO). In most cases configuration for a
157 bootloader is generated automatically by novaboot. It is also possible
158 to generate other files using _heredoc_ or _"<"_ syntax in novaboot
159 scripts. Finally, binaries can be generated in this phases by running
162 - \--build-dir=_directory_
164 Overrides the default build directory location.
166 The default build directory location is determined as follows: If the
167 configuration file defines the `$builddir` variable, its value is
168 used. Otherwise, it is the directory that contains the first processed
171 - \-g, --grub\[=_filename_\]
173 Generates grub bootloader menu file. If the _filename_ is not
174 specified, `menu.lst` is used. The _filename_ is relative to the
175 build directory (see __\--build-dir__).
177 - \--grub-preamble=_prefix_
179 Specifies the _preable_ that is at the beginning of the generated
180 GRUB or GRUB2 config files. This is useful for specifying GRUB's
183 - \--grub-prefix=_prefix_
185 Specifies _prefix_ that is put in front of every file name in GRUB's
186 `menu.lst`. The default value is the absolute path to the build directory.
188 If the _prefix_ contains string $NAME, it will be replaced with the
189 name of the novaboot script (see also __\--name__).
191 - \--grub2\[=_filename_\]
193 Generate GRUB2 menuentry in _filename_. If _filename_ is not
194 specified `grub.cfg` is used. The content of the menuentry can be
195 customized with __\--grub-preable__, __\--grub2-prolog__ or
196 __\--grub\_prefix__ options.
198 In order to use the the generated menuentry on your development
199 machine that uses GRUB2, append the following snippet to
200 `/etc/grub.d/40_custom` file and regenerate your grub configuration,
201 i.e. run update-grub on Debian/Ubuntu.
203 if [ -f /path/to/nul/build/grub.cfg ]; then
204 source /path/to/nul/build/grub.cfg
207 - \--grub2-prolog=_prolog_
209 Specifies text _preable_ that is put at the beginning of the entry
212 - \-m, --make\[=make command\]
214 Runs `make` to build files that are not generated by novaboot itself.
218 Use the name _string_ instead of the name of the novaboot script.
219 This name is used for things like a title of grub menu or for the
220 server directory where the boot files are copied to.
224 Do not generate files on the fly (i.e. "<" syntax) except for the
225 files generated via "<<WORD" syntax.
227 - \-p, --pulsar\[=mac\]
229 Generates pulsar bootloader configuration file named `config-_mac_`
230 The _mac_ string is typically a MAC address and defaults to
233 - \--scons\[=scons command\]
235 Runs `scons` to build files that are not generated by novaboot
240 Exit novaboot after file generation phase.
242 ## Target connection check
244 If supported by the target, the connection to it is made and it is
245 checked whether the target is not occupied by another novaboot
248 - \--iprelay=_addr\[:port\]_
250 Use TCP/IP relay and serial port to access the target's serial port
251 and powercycle it. The IP address of the relay is given by _addr_
252 parameter. If _port_ is not specified, it default to 23.
254 Note: This option is supposed to work with HWG-ER02a IP relays.
256 - \-s, --serial\[=device\]
258 Target's serial line is connected to host's serial line (device). The
259 default value for device is `/dev/ttyUSB0`.
261 The value of this option is exported in NB\_NOVABOOT environment
262 variable to all subprocesses run by `novaboot`.
266 Specifies settings passed to `stty` invoked on the serial line
267 specified with __\--serial__ option. If this option is not given,
268 `stty` is called with `raw -crtscts -onlcr 115200` settings.
270 - \--remote-cmd=_cmd_
272 Command that mediates connection to the target's serial line. For
273 example `ssh server 'cu -l /dev/ttyS0'`.
275 - \--remote-expect=_string_
277 Wait for reception of _string_ on the remote connection before
280 ## File deployment phase
282 In some setups, it is necessary to copy the files needed for booting
283 to a particular location, e.g. to a TFTP boot server or to the
288 Turns your workstation into a DHCP and TFTP server so that the OS can
289 be booted via PXE BIOS (or similar mechanism) on the test machine
290 directly connected by a plain Ethernet cable to your workstation.
292 The DHCP and TFTP servers require root privileges and `novaboot`
293 uses `sudo` command to obtain those. You can put the following to
294 _/etc/sudoers_ to allow running the necessary commands without
297 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
298 your_login ALL=NOPASSWD: NOVABOOT
300 - \-i, --iso\[=filename\]
302 Generates the ISO image that boots NOVA system via GRUB. If no filename
303 is given, the image is stored under _NAME_.iso, where _NAME_ is the name
304 of the novaboot script (see also __\--name__).
306 - \--server\[=\[\[user@\]server:\]path\]
308 Copy all files needed for booting to another location (implies __\-g__
309 unless __\--grub2__ is given). The files will be copied (by __rsync__
310 tool) to the directory _path_. If the _path_ contains string $NAME,
311 it will be replaced with the name of the novaboot script (see also
316 If __\--server__ is used and its value ends with $NAME, then after
317 copying the files, a new bootloader configuration file (e.g. menu.lst)
318 is created at _path-wo-name_, i.e. the path specified by __\--server__
319 with $NAME part removed. The content of the file is created by
320 concatenating all files of the same name from all subdirectories of
321 _path-wo-name_ found on the "server".
323 - \--rsync-flags=_flags_
325 Specifies which _flags_ are appended to `rsync` command line when
326 copying files as a result of _\--server_ option.
328 ## Target power-on and reset phase
332 Switch on/off the target machine. Currently works only with
335 - \-Q, --qemu\[=_qemu-binary_\]
337 Boot the configuration in qemu. Optionally, the name of qemu binary
338 can be specified as a parameter.
340 - \--qemu-append=_flags_
342 Append _flags_ to the default qemu flags (QEMU\_FLAGS variable or
343 `-cpu coreduo -smp 2`).
345 - \-q, --qemu-flags=_flags_
347 Replace the default qemu flags (QEMU\_FLAGS variable or `-cpu coreduo
348 -smp 2`) with _flags_ specified here.
352 Command that resets the target.
354 ## Interaction with the bootloader on the target
358 Interact with uBoot bootloader to boot the thing described in the
359 novaboot script. Implementation of this option is currently tied to a
360 particular board that we use. It may be subject to changes in the
365 Command(s) to send the uBoot bootloader before loading the images and
368 ## Target interaction phase
370 In this phase, target's serial output is passed to `novaboot` stdout.
371 If `novaboot`'s stdin is on TTY, the stdin is passed to the target
372 allowing interactive work with the target.
374 This phase end when the target hangs up or when Ctrl-C is pressed.
376 # NOVABOOT SCRIPT SYNTAX
378 The syntax tries to mimic POSIX shell syntax. The syntax is defined with the following rules.
380 Lines starting with "\#" are ignored.
382 Lines that end with "\\" are concatenated with the following line after
383 removal of the final "\\" and leading whitespace of the following line.
385 Lines in the form _VARIABLE=..._ (i.e. matching '^\[A-Z\_\]+=' regular
386 expression) assign values to internal variables. See VARIABLES
389 Otherwise, the first word on the line represents the filename
390 (relative to the build directory (see __\--build-dir__) of the module to
391 load and the remaining words are passed as the command line
394 When the line ends with "<<WORD" then the subsequent lines until the
395 line containing only WORD are copied literally to the file named on
398 When the line ends with "< CMD" the command CMD is executed with
399 `/bin/sh` and its standard output is stored in the file named on that
400 line. The SRCDIR variable in CMD's environment is set to the absolute
401 path of the directory containing the interpreted novaboot script.
404 \#!/usr/bin/env novaboot
405 WVDESC=Example program
406 bin/apps/sigma0.nul S0\_DEFAULT script\_start:1,1 \\
407 verbose hostkeyb:0,0x60,1,12,2
409 hello.nulconfig <<EOF
410 sigma0::mem:16 name::/s0/log name::/s0/timer name::/s0/fs/rom ||
411 rom://bin/apps/hello.nul
414 This example will load three modules: sigma0.nul, hello.nul and
415 hello.nulconfig. sigma0 gets some command line parameters and
416 hello.nulconfig file is generated on the fly from the lines between
421 The following variables are interpreted in the novaboot script:
425 Novaboot chdir()s to this directory before file generation phase. The
426 directory name specified here is relative to the build directory
427 specified by other means (see ["--build-dir"](#build-dir)).
431 Description of the wvtest-compliant program.
435 The timeout in seconds for WvTest harness. If no complete line appears
436 in the test output within the time specified here, the test fails. It
437 is necessary to specify this for long running tests that produce no
442 Use a specific qemu binary (can be overriden with __\-Q__) and flags
443 when booting this script under qemu. If QEMU\_FLAGS variable is also
444 specified flags specified in QEMU variable are replaced by those in
449 Use specific qemu flags (can be overriden with __\-q__).
453 Parameters passed to hypervisor. The default value is "serial", unless
454 overriden in configuration file.
458 The kernel to use instead of NOVA hypervisor specified in the
459 configuration file. The value should contain the name of the kernel
460 image as well as its command line parameters. If this variable is
461 defined and non-empty, the variable HYPERVISOR\_PARAMS is not used.
465 Novaboot can read its configuration from one or more files. By
466 default, novaboot looks for files named `.novaboot` as described in
467 ["Configuration reading phase"](#configuration-reading-phase). Alternatively, its location can be
468 specified with the __\-c__ switch or with the NOVABOOT\_CONFIG
469 environment variable. The configuration file has perl syntax and
470 should set values of certain Perl variables. The current configuration
471 can be dumped with the __\--dump-config__ switch. Some configuration
472 variables can be overriden by environment variables (see below) or by
473 command line switches.
475 Supported configuration variables include:
479 Build directory location relative to the location of the configuration
484 Default target (see below) to use when no target is explicitly
485 specified on command line with the __\--target__ option.
489 Hash of shortcuts to be used with the __\--target__ option. If the hash
490 contains, for instance, the following pair of values
492 'mybox' => '--server=boot:/tftproot --serial=/dev/ttyUSB0 --grub',
494 then the following two commands are equivalent:
496 ./script --server=boot:/tftproot --serial=/dev/ttyUSB0 --grub
499 # ENVIRONMENT VARIABLES
501 Some options can be specified not only via config file or command line
502 but also through environment variables. Environment variables override
503 the values from configuration file and command line parameters
504 override the environment variables.
508 Name of the novaboot configuration file to use instead of the default
513 Defining this variable has the same meaning as __\--bender__ option.
517 Michal Sojka <sojka@os.inf.tu-dresden.de>