3 novaboot - Boots a locally compiled operating system on a remote
10 **novaboot** \[option\]... \[--\] script...
12 **./script** \[option\]...
16 This program makes booting of a locally compiled operating system (OS)
17 (e.g. NOVA or Linux) on remote targets as simple as running a program
18 locally. It automates things like copying OS images to a TFTP server,
19 generation of bootloader configuration files, resetting of target
20 hardware or redirection of target's serial line to stdin/out. Novaboot
21 is highly configurable and it makes it easy to boot a single image on
22 different targets or different images on a single target.
24 Novaboot operation is controlled by command line options and by a so
25 called novaboot script, which can be thought as a generalization of
26 bootloader configuration files (see ["NOVABOOT SCRIPT SYNTAX"](#novaboot-script-syntax)).
27 Typical way of using novaboot is to make the novaboot script
28 executable and set its first line to _#!/usr/bin/env novaboot_. Then,
29 booting a particular OS configuration becomes the same as executing a
30 local program - the novaboot script.
32 Novaboot uses configuration files to, among other things, define
33 command line options needed for different targets. Users typically use
34 only the **-t**/**--target** command line option to select the target.
35 Internally, this option expands to the pre-configured options.
36 Configuration files are searched at multiple places, which allows to
37 have per-system, per-user or per-project configurations. Configuration
38 file syntax is described in section ["CONFIGURATION FILE"](#configuration-file).
40 Simple examples of using `novaboot`:
42 1. Run an OS in Qemu. This is the default action when no other action is
43 specified by command line switches. Thus running `novaboot myos` (or
44 `./myos` as described above) will run Qemu and make it boot the
45 configuration specified in the `myos` script.
46 2. Create a bootloader configuration file (currently supported
47 bootloaders are GRUB, GRUB2, ISOLINUX, Pulsar and U-Boot) and copy it
48 with all other files needed for booting to a remote boot server. Then
49 use a TCP/IP-controlled relay/serial-to-TCP converter to reset the
50 target and receive its serial output.
52 ./myos --grub2 --server=192.168.1.1:/tftp --iprelay=192.168.1.2
54 3. Run DHCP and TFTP server on developer's machine to boot the target
59 This is useful when no network infrastructure is in place and
60 the target is connected directly to developer's box.
62 4. Create bootable ISO image.
64 novaboot --iso -- script1 script2
66 The created ISO image will have ISOLINUX bootloader installed on it
67 and the boot menu will allow selecting between _script1_ and
68 _script2_ configurations.
72 Novaboot performs its work in several phases. Each phase can be
73 influenced by several command line options, certain phases can be
74 skipped. The list of phases (in the execution order) and the
75 corresponding options follows.
77 ## Configuration reading phase
79 After starting, novaboot reads configuration files. Their content is
80 described in section ["CONFIGURATION FILE"](#configuration-file). By default,
81 configuration is read from multiple locations. First from the system
82 configuration directory (`/etc/novaboot.d/`), second from the user
83 configuration file (`~/.config/novaboot`) and third from `.novaboot`
84 files along the path to the current directory. Alternatively, a single
85 configuration file specified with the **-c** switch or with the
86 `NOVABOOT_CONFIG` environment variable is read. The latter read files
87 override settings from the former ones.
89 The system configuration directory is determined by the content of
90 NOVABOOT\_CONFIG\_DIR environment variable and defaults to
91 `/etc/novaboot.d`. Files in this directory with names consisting
92 solely of English letters, numbers, dashes '-' and underscores '\_'
93 (note that dot '.' is not included) are read in alphabetical order.
95 Then, the user configuration file is read from
96 `$XDG_CONFIG_HOME/novaboot`. If `$XDG_CONFIG_HOME` environemnt
97 variable is not set `~/.config/novaboot` is read instead.
99 Finally, novaboot searches for files named `.novaboot` starting from the
100 directory of the novaboot script (or working directory, see bellow)
101 and continuing upwards up to the root directory. The found
102 configuration files are then read in the opposite order (i.e. from the
103 root directory downwards). This allows to have, for example, a project
104 specific configuration in `~/project/.novaboot`.
106 Note the difference between `~/.config/novaboot` and `~/.novaboot`.
107 The former one is read always, whereas the latter only when novaboot
108 script or working directory is under the `$HOME` directory.
110 In certain cases, the location of the novaboot script cannot be
111 determined in this early phase. This happens either when the script is
112 read from the standard input or when novaboot is invoked explicitly as
113 in the example ["4."](#4) above. In this case the current working
114 directory is used as a starting point for configuration file search
115 instead of the novaboot script directory.
117 - -c, --config=_filename_
119 Use the specified configuration file instead of the default one(s).
121 ## Command line processing phase
125 Dump the current configuration to stdout end exit. Useful as an
126 initial template for a configuration file.
130 Print short (**-h**) or long (**--help**) help.
132 - -t, --target=_target_
134 This option serves as a user configurable shortcut for other novaboot
135 options. The effect of this option is the same as the options stored
136 in the `%targets` configuration variable under key _target_. See
137 also ["CONFIGURATION FILE"](#configuration-file).
139 ## Script preprocessing phase
141 This phases allows to modify the parsed novaboot script before it is
142 used in the later phases.
144 - -a, --append=_parameters_
146 Append a string to the first `load` line in the novaboot script. This
147 can be used to append parameters to the kernel's or root task's
148 command line. This option can appear multiple times.
152 Use `bender` chainloader. Bender scans the PCI bus for PCI serial
153 ports and stores the information about them in the BIOS data area for
156 - --chainloader=_chainloader_
158 Specifies a chainloader that is loaded before the kernel and other
159 files specified in the novaboot script. E.g. 'bin/boot/bender
164 Print the modules to boot and their parameters after this phase
165 finishes. Then exit. This is useful for seeing the effect of other
166 options in this section.
168 - -k, --kernel=`file`
170 Replace the first word on the first `load` line in the novaboot
173 - --scriptmod=_perl expression_
175 When novaboot script is read, _perl expression_ is executed for every
176 line (in $\_ variable). For example, `novaboot
177 \--scriptmod=s/sigma0/omega6/g` replaces every occurrence of _sigma0_
178 in the script with _omega6_.
180 When this option is present, it overrides _$script\_modifier_ variable
181 from the configuration file, which has the same effect. If this option
182 is given multiple times all expressions are evaluated in the command
185 ## File generation phase
187 In this phase, files needed for booting are generated in a so called
188 _build directory_ (see ["--build-dir"](#build-dir)). In most cases configuration
189 for a bootloader is generated automatically by novaboot. It is also
190 possible to generate other files using _heredoc_ or _"<"_ syntax in
191 novaboot scripts. Finally, binaries can be generated in this phases by
192 running `scons` or `make`.
194 - --build-dir=_directory_
196 Overrides the default build directory location.
198 The default build directory location is determined as follows: If the
199 configuration file defines the `$builddir` variable, its value is
200 used. Otherwise, it is the directory that contains the first processed
203 See also ["BUILDDIR"](#builddir) variable.
205 - -g, --grub\[=_filename_\]
207 Generates grub bootloader menu file. If the _filename_ is not
208 specified, `menu.lst` is used. The _filename_ is relative to the
209 build directory (see **--build-dir**).
211 - --grub-preamble=_prefix_
213 Specifies the _preable_ that is at the beginning of the generated
214 GRUB or GRUB2 config files. This is useful for specifying GRUB's
219 Specifies _prefix_ (e.g. `/srv/tftp`) that is put in front of every
220 file name in generated bootloader configuration files (or in U-Boot
223 If the _prefix_ contains string $NAME, it will be replaced with the
224 name of the novaboot script (see also **--name**).
226 If the _prefix_ contains string $BUILDDIR, it will be replaced with
227 the build directory (see also **--build-dir**).
231 Alias for **--prefix**.
233 - --grub2\[=_filename_\]
235 Generate GRUB2 menu entry in _filename_. If _filename_ is not
236 specified `grub.cfg` is used. The content of the menu entry can be
237 customized with **--grub-preamble**, **--grub2-prolog** or
238 **--grub\_prefix** options.
240 In order to use the the generated menu entry on your development
241 machine that uses GRUB2, append the following snippet to
242 `/etc/grub.d/40_custom` file and regenerate your grub configuration,
243 i.e. run update-grub on Debian/Ubuntu.
245 if [ -f /path/to/nul/build/grub.cfg ]; then
246 source /path/to/nul/build/grub.cfg
249 - --grub2-prolog=_prolog_
251 Specifies text that is put at the beginning of the GRUB2 menu entry.
253 - -m, --make\[=make command\]
255 Runs `make` to build files that are not generated by novaboot itself.
259 Use the name _string_ instead of the name of the novaboot script.
260 This name is used for things like a title of grub menu or for the
261 server directory where the boot files are copied to.
265 Do not run external commands to generate files (i.e. "<" syntax and
266 `run` keyword). This switch does not influence generation of files
267 specified with "<<WORD" syntax.
269 - -p, --pulsar\[=mac\]
271 Generates pulsar bootloader configuration file named `config-_mac_`
272 The _mac_ string is typically a MAC address and defaults to
275 - --scons\[=scons command\]
277 Runs `scons` to build files that are not generated by novaboot
282 Strip _rom://_ prefix from command lines and generated config files.
283 The _rom://_ prefix is used by NUL. For NRE, it has to be stripped.
287 Exit novaboot after file generation phase.
289 ## Target connection check
291 If supported by the target, the connection to it is made and it is
292 checked whether the target is not occupied by another novaboot
295 - --amt=_"\[user\[:password\]@\]host\[:port\]_
297 Use Intel AMT technology to control the target machine. WS management
298 is used to powercycle it and Serial-Over-Lan (SOL) for input/output.
299 The hostname or (IP address) is given by the _host_ parameter. If
300 _password_ is not specified, environment variable AMT\_PASSWORD is
301 used. The _port_ specifies a TCP port for SOL. If not specified, the
302 default is 16992. Default _user_ is admin.
304 - --iprelay=_addr\[:port\]_
306 Use TCP/IP relay and serial port to access the target's serial port
307 and powercycle it. The IP address of the relay is given by _addr_
308 parameter. If _port_ is not specified, it default to 23.
310 Note: This option is supposed to work with HWG-ER02a IP relays.
312 - -s, --serial\[=device\]
314 Target's serial line is connected to host's serial line (device). The
315 default value for device is `/dev/ttyUSB0`.
317 The value of this option is exported in NB\_NOVABOOT environment
318 variable to all subprocesses run by `novaboot`.
322 Specifies settings passed to `stty` invoked on the serial line
323 specified with **--serial** option. If this option is not given,
324 `stty` is called with `raw -crtscts -onlcr 115200` settings.
328 Command that mediates connection to the target's serial line. For
329 example `ssh server 'cu -l /dev/ttyS0'`.
331 - --remote-expect=_string_
333 Wait for reception of _string_ after establishing the remote
336 - --remote-expect-silent=_string_
338 The same as **--remote-expect** except that the remote output is not
339 echoed to stdout while waiting for the _string_. Everything after the
340 matched string is printed to stdout, so you may want to include line
341 end characters in the _string_ as well.
343 ## File deployment phase
345 In some setups, it is necessary to copy the files needed for booting
346 to a particular location, e.g. to a TFTP boot server or to the
351 Turns your workstation into a DHCP and TFTP server so that the OS can
352 be booted via PXE BIOS (or similar mechanism) on the test machine
353 directly connected by a plain Ethernet cable to your workstation.
355 The DHCP and TFTP servers requires root privileges and `novaboot`
356 uses `sudo` command to obtain those. You can put the following to
357 _/etc/sudoers_ to allow running the necessary commands without asking
360 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
361 your_login ALL=NOPASSWD: NOVABOOT
365 Starts a TFTP server on your workstation. This is similar to
366 **--dhcp-tftp** except that DHCP server is not started.
368 The TFTP server require root privileges and `novaboot` uses `sudo`
369 command to obtain those. You can put the following to _/etc/sudoers_
370 to allow running the necessary commands without asking for password.
372 Cmnd_Alias NOVABOOT = /usr/sbin/in.tftpd --listen --secure -v -v -v --pidfile tftpd.pid *, /usr/bin/pkill --pidfile=tftpd.pid
373 your_login ALL=NOPASSWD: NOVABOOT
377 Port to run the TFTP server on. Implies **--tftp**.
381 Generates the ISO image that boots NOVA system via GRUB. If no filename
382 is given, the image is stored under _NAME_.iso, where _NAME_ is the name
383 of the novaboot script (see also **--name**).
385 - --server\[=\[\[user@\]server:\]path\]
387 Copy all files needed for booting to another location. The files will
388 be copied (by **rsync** tool) to the directory _path_. If the _path_
389 contains string $NAME, it will be replaced with the name of the
390 novaboot script (see also **--name**).
392 - --rsync-flags=_flags_
394 Specifies which _flags_ are appended to `rsync` command line when
395 copying files as a result of _--server_ option.
399 If **--server** is used and its value ends with $NAME, then after
400 copying the files, a new bootloader configuration file (e.g. menu.lst)
401 is created at _path-wo-name_, i.e. the path specified by **--server**
402 with $NAME part removed. The content of the file is created by
403 concatenating all files of the same name from all subdirectories of
404 _path-wo-name_ found on the "server".
408 Use Intel AMT technology for IDE redirection. This allows the target
409 machine to boot from novaboot created ISO image. Implies **--iso**.
411 The experimental `amtider` utility needed by this option can be
412 obtained from https://github.com/wentasah/amtterm.
414 ## Target power-on and reset phase
416 At this point, the target is reset (or switched on/off). There is
417 several ways how this can be accomplished. Resetting a physical target
418 can currently be accomplished by the following options: **--amt**,
419 **--iprelay**, **--reset-cmd**.
423 Switch on/off the target machine and exit. The script (if any) is
424 completely ignored. Currently it works only with **--iprelay** or
427 - -Q, --qemu\[=_qemu-binary_\]
429 Boot the configuration in qemu. Optionally, the name of qemu binary
430 can be specified as a parameter.
432 - --qemu-append=_flags_
434 Append _flags_ to the default qemu flags (QEMU\_FLAGS variable or
435 `-cpu coreduo -smp 2`).
437 - -q, --qemu-flags=_flags_
439 Replace the default qemu flags (QEMU\_FLAGS variable or `-cpu coreduo
440 \-smp 2`) with _flags_ specified here.
444 Command that resets the target.
446 - --no-reset, --reset
448 Disable/enable resetting of the target.
450 ## Interaction with the bootloader on the target
452 - --uboot\[=_prompt_\]
454 Interact with U-Boot bootloader to boot the thing described in the
455 novaboot script. _prompt_ specifies the U-Boot's prompt (default is
456 "=> ", other common prompts are "U-Boot> " or "U-Boot# ").
457 Implementation of this option is currently tied to a particular board
458 that we use. It may be subject to changes in the future!
462 Disable U-Boot interaction previously enabled with **--uboot**.
466 Command(s) to send the U-Boot bootloader before loading the images and
467 booting them. This option can be given multiple times. After sending
468 commands from each option novaboot waits for U-Boot _prompt_.
470 If the command contains string _$NB\_MYIP_ then this string is
471 replaced by IPv4 address of eth0 interface. Similarly _$NB\_PREFIX_ is
472 replaced with prefix given by **--prefix**.
474 See also `uboot` keyword in ["NOVABOOT SCRIPT SYNTAX"](#novaboot-script-syntax)).
476 - --uboot-addr _name_=_address_
478 Load address of U-Boot's `tftpboot` command for loading _name_,
479 where name is one of _kernel_, _ramdisk_ or _fdt_ (flattened device
482 The default addresses are ${_name_\_addr\_r}, i.e. U-Boot environment
483 variables used by convention for this purpose.
485 - --uboot-cmd=_command_
487 Specifies U-Boot command used to execute the OS. If the command
488 contains strings `$kernel_addr`, `$ramdisk_addr`, `$fdt_addr`,
489 these are replaced with the addresses configured with **--uboot-addr**.
493 bootm $kernel_addr $ramdisk_addr $fdt_addr
495 or the `UBOOT_CMD` variable if defined in the novaboot script.
497 ## Target interaction phase
499 In this phase, target's serial output is redirected to stdout and if
500 stdin is a TTY, it is redirected to the target's serial input allowing
501 interactive work with the target.
505 When _string_ is sent by the target, novaboot exits. This option can
506 be specified multiple times, in which case novaboot exits whenever
507 either of the specified strings is sent.
509 If _string_ is `-re`, then the next **--exiton**'s _string_ is
510 treated as regular expression. For example:
512 --exiton -re --exiton 'error:.*failed'
514 - --exiton-re=_regex_
516 The same as --exiton -re --exiton _regex_.
518 - --exiton-timeout=_seconds_
520 By default **--exiton** waits for the string match forever. When this
521 option is specified, "exiton" timeouts after the specifies number of
522 seconds and novaboot returns non-zero exit code.
526 Setup things for interactive use of target. Your terminal will be
527 switched to raw mode. In raw mode, your system does not process input
528 in any way (no echoing of entered characters, no interpretation
529 special characters). This, among others, means that Ctrl-C is passed
530 to the target and does no longer interrupt novaboot. Use "~~."
531 sequence to exit novaboot.
533 - --no-interaction, --interaction
535 Skip resp. force target interaction phase. When skipped, novaboot exits
536 immediately when boot is initiated.
540 When _string_ is received from the target, send the string specified
541 with the subsequent **--send\*** option to the target.
543 - --expect-re=_regex_
545 When target's output matches regular expression _regex_, send the
546 string specified with the subsequent **--send\*** option to the target.
548 - --expect-raw=_perl-code_
550 Provides direct control over Perl's Expect module.
554 Send _string_ to the target after the previously specified
555 **--expect\*** was matched in the target's output. The _string_ may
556 contain escape sequences such as "\\n".
558 Note that _string_ is actually interpreted by Perl, so it can contain
559 much more that escape sequences. This behavior may change in the
562 Example: `--expect='login: ' --send='root\n'`
564 - --sendcont=_string_
566 Similar to **--send** but continue expecting more input.
568 Example: `--expect='Continue?' --sendcont='yes\n'`
570 # NOVABOOT SCRIPT SYNTAX
572 The syntax tries to mimic POSIX shell syntax. The syntax is defined
573 with the following rules.
575 Lines starting with "#" and empty lines are ignored.
577 Lines that end with "\\" are concatenated with the following line after
578 removal of the final "\\" and leading whitespace of the following line.
580 Lines of the form _VARIABLE=..._ (i.e. matching '^\[A-Z\_\]+=' regular
581 expression) assign values to internal variables. See ["VARIABLES"](#variables)
584 Lines starting with `load` keyword represent modules to boot. The
585 word after `load` is a file name (relative to the build directory
586 (see **--build-dir**) of the module to load and the remaining words are
587 passed to it as the command line parameters.
589 When the `load` line ends with "<<WORD" then the subsequent lines
590 until the line containing solely WORD are copied literally to the file
591 named on that line. This is similar to shell's heredoc feature.
593 When the `load` line ends with "< CMD" then command CMD is executed
594 with `/bin/sh` and its standard output is stored in the file named on
595 that line. The SRCDIR variable in CMD's environment is set to the
596 absolute path of the directory containing the interpreted novaboot
599 Lines starting with `run` keyword contain shell commands that are run
600 during file generation phase. This is the same as the "< CMD" syntax
601 for `load` keyboard except that the command's output is not
602 redirected to a file. The ordering of commands is the same as they
603 appear in the novaboot script.
605 Lines starting with `uboot` represent U-Boot commands that are sent
606 to the target if **--uboot** option is given. Having a U-Boot line in
607 the novaboot script is the same as passing an equivalent
608 **--uboot-init** option to novaboot. The `uboot` keyword can be
609 suffixed with timeout specification. The syntax is `uboot:Ns`, where
610 `N` is the whole number of seconds. If the U-Boot command prompt does
611 not appear before the timeout, novaboot fails. The default timeout is
616 #!/usr/bin/env novaboot
617 load bzImage console=ttyS0,115200
618 run make -C buildroot
619 load rootfs.cpio < gen_cpio buildroot/images/rootfs.cpio "myapp->/etc/init.d/S99myapp"
621 Example (NOVA User Land - NUL):
623 #!/usr/bin/env novaboot
624 WVDESC=Example program
625 load bin/apps/sigma0.nul S0_DEFAULT script_start:1,1 \
626 verbose hostkeyb:0,0x60,1,12,2
627 load bin/apps/hello.nul
628 load hello.nulconfig <<EOF
629 sigma0::mem:16 name::/s0/log name::/s0/timer name::/s0/fs/rom ||
630 rom://bin/apps/hello.nul
633 This example will load three modules: `sigma0.nul`, `hello.nul` and
634 `hello.nulconfig`. sigma0 receives some command line parameters and
635 `hello.nulconfig` file is generated on the fly from the lines between
640 The following variables are interpreted in the novaboot script:
644 Novaboot chdir()s to this directory before file generation phase. The
645 directory name specified here is relative to the build directory
646 specified by other means (see ["--build-dir"](#build-dir)).
650 Assigning this variable has the same effect as specifying ["--exiton"](#exiton)
655 Parameters passed to hypervisor. The default value is "serial", unless
656 overridden in configuration file.
660 The kernel to use instead of the hypervisor specified in the
661 configuration file with the `$hypervisor` variable. The value should
662 contain the name of the kernel image as well as its command line
663 parameters. If this variable is defined and non-empty, the variable
664 HYPERVISOR\_PARAMS is not used.
668 If this variable is 1, the system is not booted. This is currently
669 only implemented for U-Boot bootloader where it is useful for
670 interacting with the bootloader without booting the system - e.g. for
675 Use a specific qemu binary (can be overridden with **-Q**) and flags
676 when booting this script under qemu. If QEMU\_FLAGS variable is also
677 specified flags specified in QEMU variable are replaced by those in
682 Use specific qemu flags (can be overridden with **-q**).
686 See ["--uboot-cmd"](#uboot-cmd).
690 Description of the WvTest-compliant program.
694 The timeout in seconds for WvTest harness. If no complete line appears
695 in the test output within the time specified here, the test fails. It
696 is necessary to specify this for long running tests that produce no
701 Novaboot can read its configuration from one or more files. By
702 default, novaboot looks for files in `/etc/novaboot.d`, file
703 `~/.config/novaboot` and files named `.novaboot` as described in
704 ["Configuration reading phase"](#configuration-reading-phase). Alternatively, configuration file
705 location can be specified with the **-c** switch or with the
706 NOVABOOT\_CONFIG environment variable. The configuration file has Perl
707 syntax (i.e. it is better to put `1;` as the last line) and should set
708 values of certain Perl variables. The current configuration can be
709 dumped with the **--dump-config** switch. Some configuration variables
710 can be overridden by environment variables (see below) or by command
713 Supported configuration variables include:
717 Build directory location relative to the location of the configuration
722 Default target (see below) to use when no target is explicitly
723 specified on command line with the **--target** option.
727 Hash of target definitions to be used with the **--target** option. The
728 key is the identifier of the target, the value is the string with
729 command line options. For instance, if the configuration file contains:
731 $targets{'mybox'} = '--server=boot:/tftproot --serial=/dev/ttyUSB0 --grub',
733 then the following two commands are equivalent:
735 ./myos --server=boot:/tftproot --serial=/dev/ttyUSB0 --grub
738 # ENVIRONMENT VARIABLES
740 Some options can be specified not only via config file or command line
741 but also through environment variables. Environment variables override
742 the values from configuration file and command line parameters
743 override the environment variables.
747 Name of the novaboot configuration file to use instead of the default
750 - NOVABOOT\_CONFIG\_DIR
752 Name of the novaboot configuration directory. When not specified
753 `/etc/novaboot.d` is used.
757 Defining this variable has the same meaning as **--bender** option.
761 Michal Sojka <sojka@os.inf.tu-dresden.de>