3 # This program is free software: you can redistribute it and/or modify
4 # it under the terms of the GNU General Public License as published by
5 # the Free Software Foundation, either version 2 of the License, or
6 # (at your option) any later version.
8 # This program is distributed in the hope that it will be useful,
9 # but WITHOUT ANY WARRANTY; without even the implied warranty of
10 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 # GNU General Public License for more details.
13 # You should have received a copy of the GNU General Public License
14 # along with this program. If not, see <http://www.gnu.org/licenses/>.
20 use warnings (exists $ENV{NOVABOOT_TEST} ? (FATAL => 'all') : ());
21 use Getopt::Long qw(GetOptionsFromString GetOptionsFromArray);
25 use File::Path qw(make_path);
27 use Time::HiRes("usleep");
31 use POSIX qw(:errno_h sysconf);
32 use Cwd qw(getcwd abs_path);
38 my $invocation_dir = $ENV{PWD} || getcwd();
40 # We prefer using PWD, to use nicer paths names with symbolic links.
41 # However, when executed from 'make -C dir', PWD may contain the make
42 # invocation path, not the real invocation path with dir at the end.
44 if (abs_path($ENV{PWD}) ne abs_path(getcwd())) {
45 $invocation_dir = getcwd();
48 ## Configuration file handling
50 # Default configuration
51 $CFG::hypervisor = "";
52 $CFG::hypervisor_params = "serial";
53 $CFG::genisoimage = "genisoimage";
54 $CFG::qemu = 'qemu-system-i386 -cpu coreduo -smp 2';
55 $CFG::default_target = '';
59 "tud" => '--copy=erwin.inf.tu-dresden.de:~sojka/boot/novaboot --rsync-flags="--chmod=Dg+s,ug+w,o-w,+rX --rsync-path=\"umask 002 && rsync\"" --grub --grub-prefix=(nd)/tftpboot/sojka/novaboot --grub-preamble="timeout 0" --concat --iprelay=141.76.48.80:2324 --scriptmod=s/\\\\bhostserial\\\\b/hostserialpci/g',
60 "novabox" => '--ssh=novabox@rtime.felk.cvut.cz',
61 "localhost" => '--scriptmod=s/console=tty[A-Z0-9,]+// --copy=/boot/novaboot/$NAME --grub2 --grub-prefix=/boot/novaboot/$NAME --grub2-prolog=" set root=\'(hd0,msdos1)\'"',
62 "ryu" => '--uboot --uboot-init="mw f0000b00 \${psc_cfg}; sleep 1" --uboot-addr kernel=800000 --uboot-addr ramdisk=b00000 --uboot-addr fdt=7f0000',
63 "ryuglab" => '--target ryu --ssh=ryu@pc-sojkam.felk.cvut.cz',
64 "ryulocal" => '--target ryu --dhcp-tftp --serial --reset-cmd="if which dtrrts; then dtrrts $NB_SERIAL 0 1; sleep 0.1; dtrrts $NB_SERIAL 1 1; fi"',
69 $const{linux}->{_SC_NPROCESSORS_CONF} = 83;
70 my $nproc = sysconf($const{$^O}->{_SC_NPROCESSORS_CONF});
72 $CFG::scons = "scons -j$nproc";
73 $CFG::make = "make -j$nproc";
81 package CFG; # Put config data into a separate namespace
87 die("ERROR: Failure compiling '$cfg' - $@");
88 } elsif (! defined($rc)) {
89 die("ERROR: Failure reading '$cfg' - $!");
91 die("ERROR: Failure processing '$cfg'");
94 $builddir = File::Spec->rel2abs($CFG::builddir, dirname($cfg)) if defined $CFG::builddir;
95 print STDERR "novaboot: Read $cfg\n";
100 # We don't use $0 here, because it points to the novaboot itself and
101 # not to the novaboot script. The problem with this approach is that
102 # when a script is run as "novaboot <options> <script>" then $ARGV[0]
103 # contains the first option. Hence the -f check.
104 my $dir = File::Spec->rel2abs($ARGV[0] && -f $ARGV[0] ? dirname($ARGV[0]) : '', $invocation_dir);
105 while ((-d $dir || -l $dir ) && $dir ne "/") {
106 push @cfgs, "$dir/.novaboot" if -r "$dir/.novaboot";
107 my @dirs = File::Spec->splitdir($dir);
108 $dir = File::Spec->catdir(@dirs[0..$#dirs-1]);
110 @cfgs = reverse @cfgs;
112 my $xdg_config_home = $ENV{'XDG_CONFIG_HOME'} || $ENV{'HOME'}.'/.config';
113 unshift(@cfgs, "$xdg_config_home/novaboot") if -r "$xdg_config_home/novaboot";
115 $dir = $ENV{'NOVABOOT_CONFIG_DIR'} || '/etc/novaboot.d';
116 if (opendir(my $dh, $dir)) {
117 my @etccfg = map { "$dir/$_" } grep { /^[-_a-zA-Z0-9]+$/ && -f "$dir/$_" } readdir($dh);
119 @etccfg = sort(@etccfg);
120 @cfgs = ( @etccfg, @cfgs );
123 my $cfg = $ENV{'NOVABOOT_CONFIG'};
124 Getopt::Long::Configure(qw/no_ignore_case pass_through/);
125 GetOptions ("config|c=s" => \$cfg);
126 read_config($_) foreach $cfg or @cfgs;
128 ## Command line handling
130 my $explicit_target = $ENV{'NOVABOOT_TARGET'};
131 GetOptions ("target|t=s" => \$explicit_target);
133 # Variables for command line options
134 my ($amt, @append, $bender, @chainloaders, $concat, $config_name_opt, $dhcp_tftp, $dump_opt, $dump_config, @exiton, $exiton_timeout, @expect_raw, $final_eol, $gen_only, $grub_config, $grub_prefix, $grub_preamble, $grub2_prolog, $grub2_config, $help, $ider, $interaction, $iprelay, $iprelay_cmd, $iso_image, $interactive, $kernel_opt, $make, $man, $netif, $no_file_gen, $off_opt, $on_opt, $pulsar, $pulsar_root, $qemu, $qemu_append, $qemu_flags_cmd, @remote_cmd, $remote_expect, $remote_expect_silent, $remote_expect_timeout, $reset, @reset_cmd, $reset_send, $rom_prefix, $rsync_flags, @scriptmod, $scons, $serial, $server, $stty, $tftp, $tftp_port, $uboot, %uboot_addr, $uboot_cmd, @uboot_init, $uboot_stop_key);
136 my ($target_reset, $target_power_on, $target_power_off);
138 # Default values of certain command line options
140 'kernel' => '${kernel_addr_r}',
141 'ramdisk' => '${ramdisk_addr_r}',
142 'fdt' => '${fdt_addr_r}',
145 $rom_prefix = 'rom://';
146 $stty = 'raw -crtscts -onlcr -echo 115200';
147 $reset = 1; # Reset target by default
148 $interaction = 1; # Perform target interaction by default
150 $netif = $CFG::netif;
151 $remote_expect_timeout = -1;
153 my @expect_seen = ();
157 push(@expect_seen, '-re') if $n eq "expect-re";
158 push(@expect_seen, $v);
164 unless (@expect_seen) { die("No --expect before --send"); }
165 my $ret = ($n eq "sendcont") ? exp_continue : 0;
166 unshift(@expect_raw, sub { shift->send(eval("\"$v\"")); $ret; });
167 unshift(@expect_raw, @expect_seen);
171 # Options which can be safely specified on the server (via --ssh),
172 # i.e. which cannot cause unwanted local code execution etc.
173 my %opt_spec_safe = (
174 "grub|g:s" => \$grub_config,
175 "grub-preamble=s"=> \$grub_preamble,
176 "grub2-prolog=s" => \$grub2_prolog,
177 "grub2:s" => \$grub2_config,
178 "prefix|grub-prefix=s" => \$grub_prefix,
179 "pulsar-root=s" => \$pulsar_root,
180 "pulsar|p:s" => \$pulsar,
181 "remote-expect=s"=> \$remote_expect,
182 "remote-expect-silent=s"=> sub { $remote_expect=$_[1]; $remote_expect_silent=1; },
183 "remote-expect-timeout=i"=> \$remote_expect_timeout,
184 "uboot-addr=s" => \%uboot_addr,
185 "uboot-cmd=s" => \$uboot_cmd,
186 "uboot-stop-key=s" => \$uboot_stop_key,
187 "uboot-init=s" => sub { push @uboot_init, { command => $_[1] }; },
188 "uboot:s" => \$uboot,
194 "append|a=s" => \@append,
195 "bender|b" => \$bender,
196 "build-dir=s" => sub { my ($n, $v) = @_; $builddir = File::Spec->rel2abs($v); },
197 "concat" => \$concat,
198 "chainloader=s" => \@chainloaders,
199 "dhcp-tftp|d" => \$dhcp_tftp,
200 "dump" => \$dump_opt,
201 "dump-config" => \$dump_config,
202 "exiton=s" => \@exiton,
203 "exiton-timeout=i"=> \$exiton_timeout,
204 "exiton-re=s" => sub { my ($n, $v) = @_; push(@exiton, '-re', $v); },
205 "expect=s" => \&handle_expect,
206 "expect-re=s" => \&handle_expect,
207 "expect-raw=s" => sub { my ($n, $v) = @_; unshift(@expect_raw, eval($v)); },
208 "final-eol!" => \$final_eol,
209 "gen-only" => \$gen_only,
211 "interaction!" => \$interaction,
212 "iprelay=s" => \$iprelay,
213 "iprelay-cmd=s" => \$iprelay_cmd,
214 "iso:s" => \$iso_image,
215 "kernel|k=s" => \$kernel_opt,
216 "interactive|i" => \$interactive,
217 "name=s" => \$config_name_opt,
218 "make|m:s" => \$make,
219 "netif=s" => \$netif,
220 "no-file-gen" => \$no_file_gen,
223 "qemu|Q:s" => \$qemu,
224 "qemu-append=s" => \$qemu_append,
225 "qemu-flags|q=s" => \$qemu_flags_cmd,
226 "remote-cmd=s" => sub { @remote_cmd = ($_[1]); },
228 "reset-cmd=s" => sub { @reset_cmd = ($_[1]); },
229 "reset-send=s" => \$reset_send,
230 "rsync-flags=s" => \$rsync_flags,
231 "scons:s" => \$scons,
232 "scriptmod=s" => \@scriptmod,
233 "send=s" => \&handle_send,
234 "sendcont=s" => \&handle_send,
235 "serial|s:s" => \$serial,
236 "server:s" => \$server,
237 "copy:s" => \$server,
238 "ssh:s" => \&handle_novaboot_server,
239 "strip-rom" => sub { $rom_prefix = ''; },
242 "tftp-port=i" => \$tftp_port,
243 "no-uboot" => sub { undef $uboot; },
248 sub handle_novaboot_server
251 my $xdg_runtime_dir = $ENV{XDG_RUNTIME_DIR} || '/var/run';
252 my $ssh_ctl_path = "${xdg_runtime_dir}/novaboot$$";
254 @remote_cmd = ('ssh', '-tt', '-M', '-S', $ssh_ctl_path, $val, 'console');
255 $remote_expect = "novaboot-shell: Connected";
257 $rsync_flags = "--rsh='ssh -S \'${ssh_ctl_path}\''";
258 ($grub_prefix = $val) =~ s|(.*)@.*|\/$1\/| if index($val, '@') != -1;
259 @reset_cmd = ('ssh', '-tt', '-S', $ssh_ctl_path, $val, 'reset');
261 $target_power_off = sub { system_verbose('ssh', '-tt', '-S', $ssh_ctl_path, $val, 'off'); };
262 $target_power_on = sub { system_verbose('ssh', '-tt', '-S', $ssh_ctl_path, $val, 'on'); };
264 my $cmd = "ssh '${val}' get-config";
265 print STDERR "novaboot: Running: $cmd\n";
266 my @target_config = qx($cmd < /dev/null);
267 if ($?) { die("Cannot get target configuration from the server"); }
268 printf "novaboot: Received configuration from the server:%s\n", (!@target_config) ? " empty" : "";
269 foreach (@target_config) { chomp; print " $_\n"; }
271 my $p = Getopt::Long::Parser->new;
272 $p->configure(qw/no_ignore_case no_pass_through/);
273 $p->getoptionsfromarray(\@target_config, %opt_spec_safe) or die("Error processing configuration from the server");
275 if (scalar @target_config) { die "Unsuported configuration received from the server: ".join(", ", @target_config); }
278 # First process target options
280 my $t = defined($explicit_target) ? $explicit_target : $CFG::default_target;
282 Getopt::Long::Configure(qw/no_ignore_case pass_through/);
284 exists $CFG::targets{$t} or die("Unknown target '$t' (valid targets are: ".join(", ", sort keys(%CFG::targets)).")");
286 undef $explicit_target;
287 my ($ret, $remaining_args) = GetOptionsFromString ($CFG::targets{$t}, ("target|t=s" => \$explicit_target));
288 if (!$ret) { die "Error parsing target $t option"; }
289 push(@target_expanded, @$remaining_args);
290 $t = $explicit_target;
293 my @args = (@target_expanded, @ARGV);
294 print STDERR "novaboot: Effective options: @args\n";
296 Getopt::Long::Configure(qw/no_ignore_case no_pass_through/);
297 GetOptionsFromArray(\@target_expanded, %opt_spec) or die ("Error in target definition");
300 # Then process other command line options - some of them may override
301 # what was specified by the target
302 GetOptions %opt_spec or die("Error in command line arguments");
303 pod2usage(1) if $help;
304 pod2usage(-exitstatus => 0, -verbose => 2) if $man;
306 ### Dump sanitized configuration (if requested)
310 $Data::Dumper::Indent=1;
311 print "# This file is in perl syntax.\n";
312 foreach my $key(sort(keys(%CFG::))) { # See "Symbol Tables" in perlmod(1)
313 if (defined ${$CFG::{$key}}) { print Data::Dumper->Dump([${$CFG::{$key}}], ["*$key"]); }
314 if ( @{$CFG::{$key}}) { print Data::Dumper->Dump([\@{$CFG::{$key}}], ["*$key"]); }
315 if ( %{$CFG::{$key}}) { print Data::Dumper->Dump([\%{$CFG::{$key}}], ["*$key"]); }
321 ### Sanitize configuration
323 if ($interactive && !-t STDIN) {
324 die("novaboot: Interactive mode not supported when not on terminal");
327 if (defined $config_name_opt && scalar(@ARGV) > 1) { die "You cannot use --name with multiple scripts"; }
330 $iso_image //= ''; # IDE-R needs an ISO image
331 if (!defined $amt) { die "Error: --ider requires --amt"; }
335 my %input_opts = ('--iprelay' => \$iprelay,
336 '--iprelay-cmd'=> \$iprelay_cmd,
337 '--serial' => \$serial,
338 '--remote-cmd' => (@remote_cmd ? \$remote_cmd[0] : undef),
340 my @opts = grep(defined(${$input_opts{$_}}) , keys %input_opts);
342 die("novaboot: More than one target connection option: ".join(', ', @opts)) if scalar @opts > 1;
346 if (defined $serial) {
347 $serial ||= "/dev/ttyUSB0";
348 $ENV{NB_SERIAL} = $serial;
350 if (defined $grub_config) { $grub_config ||= "menu.lst"; }
351 if (defined $grub2_config) { $grub2_config ||= "./boot/grub/grub.cfg"; }
353 ## Parse the novaboot script(s)
358 my ($modules, $variables, $generated, $copy, $chainload, $continuation) = ([], {}, [], []);
359 my $skip_reading = defined($on_opt) || defined($off_opt);
360 while (!$skip_reading && ($_ = <>)) {
361 if ($ARGV ne $last_fn) { # New script
362 die "Missing EOF in $last_fn" if $file;
363 die "Unfinished line in $last_fn" if $continuation;
365 push @scripts, { 'filename' => $ARGV,
366 'modules' => $modules = [],
367 'variables' => $variables = {},
368 'generated' => $generated = [],
369 'copy' => $copy = [],
370 'chainload' => $chainload = [],
375 next if /^#/ || /^\s*$/; # Skip comments and empty lines
377 $_ =~ s/^[[:space:]]*// if ($continuation);
379 if (/\\$/) { # Line continuation
380 $continuation .= substr($_, 0, length($_)-1);
384 if ($continuation) { # Last continuation line
385 $_ = $continuation . $_;
389 foreach my $mod(@scriptmod) { eval $mod; }
391 if ($file && $_ eq $EOF) { # Heredoc end
395 if ($file) { # Heredoc content
396 push @{$file}, "$_\n";
399 if (/^([A-Z_]+)=(.*)$/) { # Internal variable
400 $$variables{$1} = $2;
401 push(@exiton, $2) if ($1 eq "EXITON");
402 $interaction = $2 if ($1 eq "INTERACTION");
405 sub process_load_copy($) {
406 die("novaboot: '$last_fn' line $.: Missing file name\n") unless /^[^ <]+/;
407 if (/^([^ ]*)(.*?)[[:space:]]*<<([^ ]*)$/) { # Heredoc start
409 push @$generated, {filename => $1, content => $file};
413 if (/^([^ ]*)(.*?)[[:space:]]*< ?(.*)$/) { # Command substitution
414 push @$generated, {filename => $1, command => $3};
417 s/\s*$//; # Strip trailing whitespace
420 if (s/^load *//) { # Load line
421 push @$modules, process_load_copy($_);
424 if (s/^copy *//) { # Copy line
425 push @$copy, process_load_copy($_);
428 if (s/^chld *//) { # Chainload line
429 push @$chainload, process_load_copy($_);
432 if (/^run (.*)/) { # run line
433 push @$generated, {command => $1};
436 if (/^uboot(?::([0-9]+)s)? +(< *)?(.*)/) { # uboot line
437 # TODO: If U-Boot supports some interactive menu, it might
438 # make sense to store uboot lines per novaboot script.
439 my ($timeout, $redir, $string, $dest) = ($1, $2, $3);
440 if ($string =~ /(.*) *> *(.*)/) {
444 push @uboot_init, { command => $redir ? "" : $string,
445 system => $redir ? $string : "",
452 die("novaboot: Cannot parse script '$last_fn' line $.. Didn't you forget 'load' keyword?\n");
455 # print Dumper(\@scripts);
457 foreach my $script (@scripts) {
458 $modules = $$script{modules};
459 @$modules[0] =~ s/^[^ ]*/$kernel_opt/ if $kernel_opt;
460 @$modules[0] .= ' ' . join(' ', @append) if @append;
463 if (exists $variables->{KERNEL}) {
464 $kernel = $variables->{KERNEL};
466 if ($CFG::hypervisor) {
467 $kernel = $CFG::hypervisor . " ";
468 if (exists $variables->{HYPERVISOR_PARAMS}) {
469 $kernel .= $variables->{HYPERVISOR_PARAMS};
471 $kernel .= $CFG::hypervisor_params;
475 @$modules = ($kernel, @$modules) if $kernel;
476 @$modules = (@chainloaders, @$modules);
477 @$modules = ("bin/boot/bender", @$modules) if ($bender || defined $ENV{'NOVABOOT_BENDER'});
481 foreach my $script (@scripts) {
482 print join("\n", @{$$script{modules}})."\n";
489 sub generate_configs($$$) {
490 my ($base, $generated, $filename) = @_;
491 if ($base) { $base = "$base/"; };
492 foreach my $g(@$generated) {
493 if (exists $$g{content}) {
494 my $config = $$g{content};
495 my $fn = $$g{filename};
496 open(my $f, '>', $fn) || die("$fn: $!");
497 map { s|\brom://([^ ]*)|$rom_prefix$base$1|g; print $f "$_"; } @{$config};
499 print STDERR "novaboot: Created $fn\n";
500 } elsif (exists $$g{command} && ! $no_file_gen) {
501 $ENV{SRCDIR} = dirname(File::Spec->rel2abs( $filename, $invocation_dir ));
502 if (exists $$g{filename}) {
503 system_verbose("( $$g{command} ) > $$g{filename}");
505 system_verbose($$g{command});
511 sub generate_grub_config($$$$;$)
513 my ($filename, $title, $base, $modules_ref, $preamble) = @_;
514 if ($base) { $base = "$base/"; };
515 open(my $fg, '>', $filename) or die "$filename: $!";
516 print $fg "$preamble\n" if $preamble;
517 print $fg "title $title\n" if $title;
518 #print $fg "root $base\n"; # root doesn't really work for (nd)
520 foreach (@$modules_ref) {
523 my ($kbin, $kcmd) = split(' ', $_, 2);
524 $kcmd = '' if !defined $kcmd;
525 print $fg "kernel ${base}$kbin $kcmd\n";
527 s|\brom://([^ ]*)|$rom_prefix$base$1|g; # Translate rom:// files - needed for vdisk parameter of sigma0
528 print $fg "module $base$_\n";
532 print("novaboot: Created $builddir/$filename\n");
536 sub generate_syslinux_config($$$$)
538 my ($filename, $title, $base, $modules_ref) = @_;
539 if ($base && $base !~ /\/$/) { $base = "$base/"; };
540 open(my $fg, '>', $filename) or die "$filename: $!";
541 print $fg "LABEL $title\n";
542 #TODO print $fg "MENU LABEL $human_readable_title\n";
544 my ($kbin, $kcmd) = split(' ', @$modules_ref[0], 2);
546 if (system("file $kbin|grep 'Linux kernel'") == 0) {
547 my $initrd = @$modules_ref[1];
548 die('Too many "load" lines for Linux kernel') if (scalar @$modules_ref > 2);
549 print $fg "LINUX $base$kbin\n";
550 print $fg "APPEND $kcmd\n";
551 print $fg "INITRD $base$initrd\n";
553 print $fg "KERNEL mboot.c32\n";
555 foreach (@$modules_ref) {
556 s|\brom://([^ ]*)|$rom_prefix$base$1|g; # Translate rom:// files - needed for vdisk parameter of sigma0
557 push @append, "$base$_";
558 print $fg "APPEND ".join(' --- ', @append)."\n";
561 #TODO print $fg "TEXT HELP\n";
562 #TODO print $fg "some help here\n";
563 #TODO print $fg "ENDTEXT\n";
565 print("novaboot: Created $builddir/$filename\n");
569 sub generate_grub2_config($$$$;$$)
571 my ($filename, $title, $base, $modules_ref, $preamble, $prolog) = @_;
572 if ($base && substr($base,-1,1) ne '/') { $base = "$base/"; };
573 my $dir = dirname($filename);
577 open(my $fg, '>', $filename) or die "$filename: $!";
578 print $fg "$preamble\n" if $preamble;
579 $title ||= 'novaboot';
580 print $fg "menuentry $title {\n";
581 print $fg "$prolog\n" if $prolog;
583 my $boot_method = $variables->{BOOT_METHOD} // "multiboot";
584 my $module_load_method = "module";
585 if ($boot_method eq "linux") {
586 $module_load_method = "initrd";
588 foreach (@$modules_ref) {
591 my ($kbin, $kcmd) = split(' ', $_, 2);
592 $kcmd = '' if !defined $kcmd;
593 print $fg " $boot_method ${base}$kbin $kcmd\n";
596 # GRUB2 doesn't pass filename in multiboot info so we have to duplicate it here
597 $_ = join(' ', ($args[0], @args));
598 s|\brom://|$rom_prefix|g; # We do not need to translate path for GRUB2
599 print $fg " $module_load_method $base$_\n";
604 print("novaboot: Created $builddir/$filename\n");
608 sub generate_pulsar_config($$$)
610 my ($filename, $modules_ref, $chainload_ref) = @_;
611 open(my $fg, '>', $filename) or die "$filename: $!";
612 print $fg "root $pulsar_root\n" if defined $pulsar_root;
613 if (scalar(@$chainload_ref) > 0) {
614 print $fg "chld $$chainload_ref[0]\n";
618 foreach (@$modules_ref) {
621 ($kbin, $kcmd) = split(' ', $_, 2);
622 $kcmd = '' if !defined $kcmd;
625 s|\brom://|$rom_prefix|g;
626 print $fg "load $_\n";
629 # Put kernel as last - this is needed for booting Linux and has no influence on non-Linux OSes
630 print $fg "exec $kbin $kcmd\n";
633 print("novaboot: Created $builddir/$filename\n");
637 sub shell_cmd_string(@)
639 if (scalar(@_) == 1) {
642 return join(' ', map((/^[-_=a-zA-Z0-9\/\.\+]+$/ ? "$_" : "'$_'"), @_));
648 print STDERR "novaboot: Running: ".shell_cmd_string(@_)."\n";
650 exit(1); # should not be reached
655 print STDERR "novaboot: Running: ".shell_cmd_string(@_)."\n";
656 my $ret = system(@_);
657 if ($ret & 0x007f) { die("Command terminated by a signal"); }
658 if ($ret & 0xff00) {die("Command exit with non-zero exit code"); }
659 if ($ret) { die("Command failure $ret"); }
664 $str =~ s/^\s+|\s+$//g;
670 if (exists $variables->{WVDESC}) {
671 print STDERR "Testing \"$variables->{WVDESC}\" in $last_fn:\n";
672 } elsif ($last_fn =~ /\.wv$/) {
673 print STDERR "Testing \"all\" in $last_fn:\n";
676 ## Connect to the target and check whether it is not occupied
678 # We have to do this before file generation phase, because file
679 # generation is intermixed with file deployment phase and we want to
680 # check whether the target is not used by somebody else before
681 # deploying files. Otherwise, we may rewrite other user's files on a
684 my $exp; # Expect object to communicate with the target over serial line
686 sub kill_exp_on_signal() {
687 # Sometimes, under unclear circumstances (e.g. when running under
688 # both Jenkins and Robotframework), novaboot does not terminate
689 # console command when killed. The console is then blocked by the
690 # stale process forever. Theoretically, this should not happen,
691 # because when novaboot is killed, console command's controlling
692 # terminal sends SIGHUP to the console command and the command
693 # should terminate. It seems that at least SSH sometimes ignores
694 # HUP and does not terminate. The code below seems to work around
695 # that problem by killing the process immediately with SIGTERM,
696 # which is not ignored.
698 sub kill_console { kill TERM => $exp->pid if $exp->pid; die "Terminated by SIG$_[0]"; };
700 # For our Jenkins/Robotframework use case, it was sufficient to
701 # handle the TERM signal, but to be on the safe side, we also
702 # catch other signals.
703 $SIG{TERM} = \&kill_console;
704 $SIG{HUP} = \&kill_console;
705 $SIG{INT} = \&kill_console;
706 $SIG{QUIT} = \&kill_console;
710 my ($amt_user, $amt_password, $amt_host, $amt_port);
712 if (defined $iprelay || defined $iprelay_cmd) {
713 if (defined $iprelay) {
715 $iprelay =~ /([.0-9]+)(:([0-9]+))?/;
718 my $paddr = sockaddr_in($port, inet_aton($addr));
719 my $proto = getprotobyname('tcp');
720 socket($IPRELAY, PF_INET, SOCK_STREAM, $proto) || die "socket: $!";
721 print STDERR "novaboot: Connecting to IP relay... ";
722 connect($IPRELAY, $paddr) || die "connect: $!";
723 print STDERR "done\n";
724 $exp = Expect->init(\*$IPRELAY);
727 if (defined $iprelay_cmd) {
728 print STDERR "novaboot: Running: $iprelay_cmd\n";
731 $exp->spawn($iprelay_cmd);
732 kill_exp_on_signal();
736 print $exp "\xFF\xF6"; # AYT
737 my $connected = $exp->expect(20, # Timeout in seconds
738 '<iprelayd: connected>',
739 '-re', '<WEB51 HW[^>]*>')
740 || die "iprelay connection: " . ($! || "timeout");
745 my ($relay, $onoff) = @_;
746 die unless ($relay == 1 || $relay == 2);
748 my $cmd = ($relay == 1 ? 0x5 : 0x6) | ($onoff ? 0x20 : 0x10);
749 return "\xFF\xFA\x2C\x32".chr($cmd)."\xFF\xF0";
753 my ($relay, $onoff) = @_;
754 die unless ($relay == 1 || $relay == 2);
755 my $cmd = ($relay == 1 ? 0xdf : 0xbf) | ($onoff ? 0x00 : 0xff);
756 return "\xFF\xFA\x2C\x97".chr($cmd)."\xFF\xF0";
760 my ($relay, $onoff, $can_giveup) = @_;
761 my $confirmation = '';
763 print $exp relaycmd($relay, $onoff);
764 my $confirmed = $exp->expect(20, # Timeout in seconds
765 relayconf($relay, $onoff))
766 || die "iprelay command: " . ($! || "timeout");
769 print("Relay confirmation timeout - ignoring\n");
771 die "Relay confirmation timeout";
777 $target_reset = sub {
778 relay(2, 1, 1); # Reset the machine
783 $target_power_off = sub {
784 relay(1, 1); # Press power button
785 usleep(6000000); # Long press to switch off
789 $target_power_on = sub {
790 relay(1, 1); # Press power button
791 usleep(100000); # Short press
797 system_verbose("stty -F $serial $stty");
798 open($CONN, "+<", $serial) || die "open $serial: $!";
799 $exp = Expect->init(\*$CONN);
801 elsif (@remote_cmd) {
802 print STDERR "novaboot: Running: ".shell_cmd_string(@remote_cmd)."\n";
803 $exp = Expect->spawn(@remote_cmd);
804 kill_exp_on_signal();
806 elsif (defined $amt) {
807 require LWP::UserAgent;
808 require LWP::Authen::Digest;
811 my ($host, $username, $password, $schema, $className, $pstate) = @_;
812 #AMT numbers for PowerStateChange (MNI => bluescreen on windows;-)
813 my %pstates = ("on" => 2,
820 <s:Envelope xmlns:s="http://www.w3.org/2003/05/soap-envelope" xmlns:a="http://schemas.xmlsoap.org/ws/2004/08/addressing" xmlns:w="http://schemas.dmtf.org/wbem/wsman/1/wsman.xsd">
821 <s:Header><a:To>http://$host:16992/wsman</a:To>
822 <w:ResourceURI s:mustUnderstand="true">$schema</w:ResourceURI>
823 <a:ReplyTo><a:Address s:mustUnderstand="true">http://schemas.xmlsoap.org/ws/2004/08/addressing/role/anonymous</a:Address></a:ReplyTo>
824 <a:Action s:mustUnderstand="true">$schema$className</a:Action>
825 <w:MaxEnvelopeSize s:mustUnderstand="true">153600</w:MaxEnvelopeSize>
826 <a:MessageID>uuid:709072C9-609C-4B43-B301-075004043C7C</a:MessageID>
827 <w:Locale xml:lang="en-US" s:mustUnderstand="false" />
828 <w:OperationTimeout>PT60.000S</w:OperationTimeout>
829 <w:SelectorSet><w:Selector Name="Name">Intel(r) AMT Power Management Service</w:Selector></w:SelectorSet>
831 <p:RequestPowerStateChange_INPUT xmlns:p="http://schemas.dmtf.org/wbem/wscim/1/cim-schema/2/CIM_PowerManagementService">
832 <p:PowerState>$pstates{$pstate}</p:PowerState>
833 <p:ManagedElement><a:Address>http://$host:16992/wsman</a:Address>
834 <a:ReferenceParameters><w:ResourceURI>http://schemas.dmtf.org/wbem/wscim/1/cim-schema/2/CIM_ComputerSystem</w:ResourceURI>
835 <w:SelectorSet><w:Selector Name="Name">ManagedSystem</w:Selector></w:SelectorSet>
836 </a:ReferenceParameters></p:ManagedElement>
837 </p:RequestPowerStateChange_INPUT>
838 </s:Body></s:Envelope>
843 my ($host, $username, $password, $content) = @_;
845 my $ua = LWP::UserAgent->new();
846 $ua->agent("novaboot");
848 my $req = HTTP::Request->new(POST => "http://$host:16992/wsman");
849 my $res = $ua->request($req);
850 die ("Unexpected AMT response: " . $res->status_line) unless $res->code == 401;
852 my ($realm) = $res->header("WWW-Authenticate") =~ /Digest realm="(.*?)"/;
853 $ua->credentials("$host:16992", $realm, $username => $password);
856 $req = HTTP::Request->new(POST => "http://$host:16992/wsman");
857 $req->content_type('application/x-www-form-urlencoded');
858 $req->content($content);
859 $res = $ua->request($req);
860 die ("AMT power change request failed: " . $res->status_line) unless $res->is_success;
861 $res->content() =~ /<g:ReturnValue>(\d+)<\/g:ReturnValue>/;
866 my ($host, $username, $password, $pstate)=@_;
867 my $schema="http://schemas.dmtf.org/wbem/wscim/1/cim-schema/2/CIM_PowerManagementService";
868 my $className="/RequestPowerStateChange";
869 my $content = genXML($host, $username, $password ,$schema, $className, $pstate);
870 return sendPOST($host, $username, $password, $content);
873 ($amt_user,$amt_password,$amt_host,$amt_port) = ($amt =~ /(?:(.*?)(?::(.*))?@)?([^:]*)(?::([0-9]*))?/);;
874 $amt_user ||= "admin";
875 $amt_password ||= $ENV{'AMT_PASSWORD'} || die "AMT password not specified";
876 $amt_host || die "AMT host not specified";
880 $target_power_off = sub {
882 my $result = powerChange($amt_host,$amt_user,$amt_password, "off");
883 die "AMT power off failed (ReturnValue $result)" if $result != 0;
886 $target_power_on = sub {
887 my $result = powerChange($amt_host,$amt_user,$amt_password, "on");
888 die "AMT power on failed (ReturnValue $result)" if $result != 0;
891 $target_reset = sub {
892 my $result = powerChange($amt_host,$amt_user,$amt_password, "reset");
894 print STDERR "Warning: Cannot reset $amt_host, trying power on. ";
895 $result = powerChange($amt_host,$amt_user,$amt_password, "on");
897 die "AMT reset failed (ReturnValue $result)" if $result != 0;
900 my $cmd = "amtterm -u $amt_user -p $amt_password $amt_host $amt_port";
901 print STDERR "novaboot: Running: $cmd\n" =~ s/\Q$amt_password\E/???/r;
902 $exp = Expect->spawn($cmd);
903 $exp->expect(10, "RUN_SOL") || die "Expect for 'RUN_SOL': " . ($! || "timeout");
907 if ($remote_expect) {
908 $exp || die("No serial line connection");
909 my $log = $exp->log_stdout;
910 if (defined $remote_expect_silent) {
913 $exp->expect($remote_expect_timeout >= 0 ? $remote_expect_timeout : undef,
914 $remote_expect) || die "Expect for '$remote_expect':" . ($! || "timeout");;
915 if (defined $remote_expect_silent) {
916 $exp->log_stdout($log);
917 print $exp->after() if $log;
922 $target_reset = sub {
923 system_verbose(@reset_cmd);
927 if (defined $reset_send) {
928 $target_reset = sub {
929 $reset_send =~ s/\\n/\n/g;
930 $exp->send($reset_send);
934 if (defined $on_opt && defined $target_power_on) {
938 if (defined $off_opt && defined $target_power_off) {
939 print STDERR "novaboot: Switching the target off...\n";
940 &$target_power_off();
944 $builddir ||= dirname(File::Spec->rel2abs( ${$scripts[0]}{filename})) if scalar @scripts;
945 if (defined $builddir) {
946 chdir($builddir) or die "Can't change directory to $builddir: $!";
947 print STDERR "novaboot: Entering directory `$builddir'\n";
949 $builddir = $invocation_dir;
952 ## File generation phase
953 my (%files_iso, $menu_iso, $filename);
954 my $config_name = '';
957 foreach my $script (@scripts) {
958 $filename = $$script{filename};
959 $modules = $$script{modules};
960 $generated = $$script{generated};
961 $variables = $$script{variables};
963 ($config_name = $filename) =~ s#.*/##;
964 $config_name = $config_name_opt if (defined $config_name_opt);
966 if (exists $variables->{BUILDDIR}) {
967 $builddir = File::Spec->rel2abs($variables->{BUILDDIR});
968 chdir($builddir) or die "Can't change directory to $builddir: $!";
969 print STDERR "novaboot: Entering directory `$builddir'\n";
973 $prefix = $grub_prefix;
974 $prefix =~ s/\$NAME/$config_name/;
975 $prefix =~ s/\$BUILDDIR/$builddir/;
977 # TODO: use $grub_prefix as first parameter if some switch is given
978 generate_configs('', $generated, $filename);
980 ### Generate bootloader configuration files
981 my @bootloader_configs;
982 push @bootloader_configs, generate_grub_config($grub_config, $config_name, $prefix, $modules, $grub_preamble) if (defined $grub_config);
983 push @bootloader_configs, generate_grub2_config($grub2_config, $config_name, $prefix, $modules, $grub_preamble, $grub2_prolog) if (defined $grub2_config);
984 push @bootloader_configs, generate_pulsar_config('config-'.($pulsar||'novaboot'), $modules, $chainload) if (defined $pulsar);
986 ### Run scons or make
989 push @all, @$modules;
991 push @all, @$chainload;
992 my @files = map({ ($file) = m/([^ ]*)/; $file; } @all);
994 # Filter-out generated files
995 my @to_build = grep({ my $file = $_; !scalar(grep($file eq ($$_{filename} || ''), @$generated)) } @files);
997 system_verbose($scons || $CFG::scons." ".join(" ", @to_build)) if (defined $scons);
998 system_verbose($make || $CFG::make ." ".join(" ", @to_build)) if (defined $make);
1001 ### Copy files (using rsync)
1002 if (defined $server && !defined($gen_only)) {
1003 (my $real_server = $server) =~ s/\$NAME/$config_name/;
1005 my ($hostname, $path) = split(":", $real_server, 2);
1006 if (! defined $path) {
1010 my $files = join(" ", map({ ($file) = m/([^ ]*)/; $file; } ( @$modules, @bootloader_configs, @$copy)));
1011 map({ my $file = (split)[0]; die "Not a file: $file: $!" if ! -e $file || -d $file; } @$modules);
1012 my $istty = -t STDOUT && ($ENV{'TERM'} || 'dumb') ne 'dumb';
1013 my $progress = $istty ? "--progress" : "";
1015 system_verbose("rsync $progress -RL --chmod=ugo=rwX $rsync_flags $files $real_server");
1016 if ($server =~ m|/\$NAME$| && $concat) {
1017 my $cmd = join("; ", map { "( cd $path/.. && cat */$_ > $_ )" } @bootloader_configs);
1018 system_verbose($hostname ? "ssh $hostname '$cmd'" : $cmd);
1023 ### Prepare ISO image generation
1024 if (defined $iso_image) {
1025 generate_configs("(cd)", $generated, $filename);
1027 generate_syslinux_config(\$menu, $config_name, "/", $modules);
1028 $menu_iso .= "$menu\n";
1029 map { ($file,undef) = split; $files_iso{$file} = 1; } @$modules;
1033 ## Generate ISO image
1034 if (defined $iso_image) {
1035 system_verbose("mkdir -p isolinux");
1038 if (-f '/usr/lib/ISOLINUX/isolinux.bin') {
1039 # Newer ISOLINUX version
1040 @files = qw(/usr/lib/ISOLINUX/isolinux.bin /usr/lib/syslinux/modules/bios/mboot.c32 /usr/lib/syslinux/modules/bios/libcom32.c32 /usr/lib/syslinux/modules/bios/menu.c32 /usr/lib/syslinux/modules/bios/ldlinux.c32);
1041 } elsif (-f '/usr/lib/syslinux/isolinux.bin') {
1042 # Older ISOLINUX version
1043 @files = qw(/usr/lib/syslinux/isolinux.bin /usr/lib/syslinux/mboot.c32 /usr/lib/syslinux/menu.c32);
1045 # NixOS and maybe others
1046 my $syslinux = `which syslinux` || die "Cannot find syslinux";
1048 $syslinux =~ s,/bin/syslinux$,,;
1049 @files = ("$syslinux/share/syslinux/isolinux.bin", "$syslinux/share/syslinux/mboot.c32", "$syslinux/share/syslinux/libcom32.c32", "$syslinux/share/syslinux/menu.c32", "$syslinux/share/syslinux/ldlinux.c32");
1051 system_verbose("cp @files isolinux && chmod +w isolinux/*");
1052 open(my $fh, ">isolinux/isolinux.cfg");
1054 print $fh "TIMEOUT 50\n";
1055 print $fh "DEFAULT menu\n";
1057 print $fh "DEFAULT $config_name\n";
1059 print $fh "$menu_iso";
1062 my $files = join(" ", map("$_=$_", (keys(%files_iso), 'isolinux/isolinux.cfg', map(s|.*/|isolinux/|r, @files))));
1063 $iso_image ||= "$config_name.iso";
1065 # Note: We use -U flag below to "Allow 'untranslated' filenames,
1066 # completely violating the ISO9660 standards". Without this
1067 # option, isolinux is not able to read files names for example
1069 system_verbose("$CFG::genisoimage -R -b isolinux/isolinux.bin -c isolinux/boot.cat -no-emul-boot -boot-load-size 4 -boot-info-table -hide-rr-moved -U -o $iso_image -graft-points $files");
1070 print("ISO image created: $builddir/$iso_image\n");
1073 exit(0) if defined $gen_only;
1075 ## Boot the system using various methods and send serial output to stdout
1077 if (scalar(@scripts) > 1 && ( defined $dhcp_tftp || defined $serial || defined $iprelay)) {
1078 die "You cannot do this with multiple scripts simultaneously";
1081 if ($variables->{WVTEST_TIMEOUT}) {
1082 print STDERR "wvtest: timeout ", $variables->{WVTEST_TIMEOUT}, "\n";
1087 if (defined $qemu) {
1089 $qemu ||= $variables->{QEMU} || $CFG::qemu;
1090 my @qemu_flags = split(" ", $qemu);
1091 $qemu = shift(@qemu_flags);
1093 @qemu_flags = split(/ +/, trim($variables->{QEMU_FLAGS})) if exists $variables->{QEMU_FLAGS};
1094 @qemu_flags = split(/ +/, trim($qemu_flags_cmd)) if $qemu_flags_cmd;
1095 push(@qemu_flags, split(/ +/, trim($qemu_append || '')));
1097 if (defined $iso_image) {
1098 # Boot NOVA with grub (and test the iso image)
1099 push(@qemu_flags, ('-cdrom', $iso_image));
1101 # Boot NOVA without GRUB
1103 # Non-patched qemu doesn't like commas, but NUL can live with pluses instead of commans
1104 foreach (@$modules) {s/,/+/g;}
1105 generate_configs("", $generated, $filename);
1107 if (scalar @$modules) {
1108 my ($kbin, $kcmd) = split(' ', shift(@$modules), 2);
1109 $kcmd = '' if !defined $kcmd;
1111 @$modules = map { if (/\.dtb$/) { $dtb=$_; (); } else { $_ } } @$modules;
1112 my $initrd = join ",", @$modules;
1114 push(@qemu_flags, ('-kernel', $kbin, '-append', $kcmd));
1115 push(@qemu_flags, ('-initrd', $initrd)) if $initrd;
1116 push(@qemu_flags, ('-dtb', $dtb)) if $dtb;
1119 if (!grep /^-serial$/, @qemu_flags) {
1120 push(@qemu_flags, qw(-serial stdio)); # Redirect serial output (for collecting test restuls)
1122 unshift(@qemu_flags, ('-name', $config_name));
1123 print STDERR "novaboot: Running: ".shell_cmd_string($qemu, @qemu_flags)."\n";
1124 $exp = Expect->spawn(($qemu, @qemu_flags)) || die("exec() failed: $!");
1127 ### Local DHCPD and TFTPD
1129 my ($dhcpd_pid, $tftpd_pid);
1131 $tftp=1 if $tftp_port;
1133 if (defined $dhcp_tftp)
1135 generate_configs("(nd)", $generated, $filename);
1136 system_verbose('mkdir -p tftpboot');
1137 generate_grub_config("tftpboot/os-menu.lst", $config_name, "(nd)", \@$modules, "timeout 0");
1138 open(my $fh, '>', 'dhcpd.conf');
1139 my $mac = `cat /sys/class/net/$netif/address`;
1141 print $fh "subnet 10.23.23.0 netmask 255.255.255.0 {
1142 range 10.23.23.10 10.23.23.100;
1143 filename \"bin/boot/grub/pxegrub.pxe\";
1144 next-server 10.23.23.1;
1147 hardware ethernet $mac;
1148 fixed-address 10.23.23.1;
1151 system_verbose("sudo ip a add 10.23.23.1/24 dev $netif;
1152 sudo ip l set dev $netif up;
1153 sudo touch dhcpd.leases");
1155 # We run servers by forking ourselves, because the servers end up
1156 # in our process group and get killed by signals sent to the
1157 # process group (e.g. Ctrl-C on terminal).
1158 $dhcpd_pid = fork();
1159 exec_verbose("sudo dhcpd -d -cf dhcpd.conf -lf dhcpd.leases -pf dhcpd.pid") if ($dhcpd_pid == 0);
1162 if (defined $dhcp_tftp || defined $tftp) {
1165 # Prepare a GRUB netboot directory
1166 system_verbose("grub-mknetdir --net-directory=$builddir") if (defined $grub2_config);
1168 # Generate TFTP mapfile
1169 open(my $fh, '>', "$builddir/mapfile");
1170 print $fh "# Some PXE clients (mainly UEFI) have bug. They add zero byte to the end of the
1171 # path name. This rule removes it
1174 # Unfortunately, tftpd requires root privileges even with
1175 # non-privileged (>1023) port due to initgroups().
1176 system_verbose("sudo in.tftpd --listen --secure -v -v -v --pidfile tftpd.pid -m mapfile --address :$tftp_port $builddir");
1178 # Kill server when we die
1179 $SIG{__DIE__} = sub { system_verbose('sudo pkill --pidfile=dhcpd.pid') if (defined $dhcp_tftp);
1180 system_verbose('sudo pkill --pidfile=tftpd.pid'); };
1182 # We have to kill tftpd explicitely, because it is not in our process group
1183 $SIG{INT} = sub { system_verbose('sudo pkill --pidfile=tftpd.pid'); exit(0); };
1187 if (defined $ider) {
1188 my $ider_cmd= "amtider -c $iso_image -u $amt_user -p $amt_password $amt_host $amt_port" ;
1189 print STDERR "novaboot: Running: $ider_cmd\n" =~ s/\Q$amt_password\E/???/r;
1190 my $ider_pid = fork();
1191 if ($ider_pid == 0) {
1193 die "IDE redirection failed";
1195 # FIXME: This collides with --tftp option. Hopefully, nobody needs
1196 # to use both simultaneously.
1197 $SIG{__DIE__} = sub { system_verbose('kill $ider_pid'); };
1200 ### Reset target (IP relay, AMT, ...)
1202 if (defined $target_reset && $reset) {
1203 print STDERR "novaboot: Resetting the test box... ";
1205 print STDERR "done\n";
1207 # We don't want to output anything printed by the target
1208 # before reset so we clear the buffers now. This is, however,
1209 # not ideal because we may loose some data that were sent
1210 # after the reset. If this is a problem, one should reset and
1211 # connect to serial line in atomic manner. For example, if
1212 # supported by hardware, use --remote-cmd 'sterm -d ...' and
1213 # do not use separate --reset-cmd.
1214 my $log = $exp->log_stdout;
1215 $exp->log_stdout(0);
1216 $exp->expect(0); # Read data from target
1217 $exp->clear_accum(); # Clear the read data
1218 $exp->log_stdout($log);
1222 ### U-boot conversation
1223 if (defined $uboot) {
1224 my $uboot_prompt = $uboot || '=> ';
1225 print STDERR "novaboot: Waiting for U-Boot prompt...\n";
1226 $exp || die("No serial line connection");
1227 $exp->log_stdout(1);
1228 #$exp->exp_internal(1);
1230 [qr/Hit any key to stop autoboot:/, sub {
1231 $exp->send($uboot_stop_key // "\n");
1233 $uboot_prompt) || die "No U-Boot prompt deteceted";
1234 foreach my $cmdspec (@uboot_init) {
1235 my ($cmd, $timeout);
1236 die "Internal error - please report a bug" unless ref($cmdspec) eq "HASH";
1238 if ($cmdspec->{system}) {
1239 $cmd = `$cmdspec->{system}`;
1241 $cmd = $cmdspec->{command};
1243 $timeout = $cmdspec->{timeout} // 10;
1245 if ($cmd =~ /\$NB_MYIP/) {
1246 my $ip = (grep /inet /, `ip addr show $netif`)[0] || die "Problem determining IP address of $netif";
1247 $ip =~ s/\s*inet ([0-9.]*).*/$1/;
1248 $cmd =~ s/\$NB_MYIP/$ip/g;
1250 if ($cmd =~ /\$NB_PREFIX/) {
1253 $cmd =~ s/\$NB_PREFIX/$p/g;
1256 $exp->send("$cmd\n");
1258 my ($matched_pattern_position, $error,
1259 $successfully_matching_string,
1260 $before_match, $after_match) =
1261 $exp->expect($timeout, $uboot_prompt);
1262 die "No U-Boot prompt: $error" if $error;
1264 if ($cmdspec->{dest}) {
1265 open(my $fh, ">", $cmdspec->{dest}) or die "Cannot open '$cmdspec->{dest}': $!";
1266 print $fh $before_match;
1271 # Load files if there are some load lines in the script
1272 if (scalar(@$modules) > 0 && !$variables->{NO_BOOT}) {
1273 my ($kbin, $kcmd) = split(' ', shift(@$modules), 2);
1275 @$modules = map { if (/\.dtb$/) { $dtb=$_; (); } else { $_ } } @$modules;
1276 my $initrd = shift @$modules;
1278 if (defined $kbin && $kbin ne '/dev/null') {
1279 die "No '--uboot-addr kernel' given" unless $uboot_addr{kernel};
1280 $exp->send("tftpboot $uboot_addr{kernel} $prefix$kbin\n");
1282 [qr/##/, sub { exp_continue; }],
1283 $uboot_prompt) || die "Kernel load: " . ($! || "timeout");
1286 die "No '--uboot-addr fdt' given" unless $uboot_addr{fdt};
1287 $exp->send("tftpboot $uboot_addr{fdt} $prefix$dtb\n");
1289 [qr/##/, sub { exp_continue; }],
1290 $uboot_prompt) || die "Device tree load: " . ($! || "timeout");
1292 $uboot_addr{fdt} = '';
1294 if (defined $initrd) {
1295 die "No '--uboot-addr ramdisk' given" unless $uboot_addr{ramdisk};
1296 $exp->send("tftpboot $uboot_addr{ramdisk} $prefix$initrd\n");
1298 [qr/##/, sub { exp_continue; }],
1299 $uboot_prompt) || die "Initrd load: " . ($! || "timeout");
1301 $uboot_addr{ramdisk} = '-';
1305 $exp->send("setenv bootargs $kcmd\n");
1306 $exp->expect(5, $uboot_prompt) || die "U-Boot prompt: " . ($! || "timeout");
1309 $uboot_cmd //= $variables->{UBOOT_CMD} // 'bootm $kernel_addr $ramdisk_addr $fdt_addr';
1310 if (!$variables->{NO_BOOT} && $uboot_cmd ne '') {
1311 $uboot_cmd =~ s/\$kernel_addr/$uboot_addr{kernel}/g;
1312 $uboot_cmd =~ s/\$ramdisk_addr/$uboot_addr{ramdisk}/g;
1313 $uboot_cmd =~ s/\$fdt_addr/$uboot_addr{fdt}/g;
1315 $exp->send($uboot_cmd . "\n");
1316 $exp->expect(5, "\n") || die "U-Boot command: " . ($! || "timeout");
1320 ### Serial line interaction
1321 if ($interaction && defined $exp) {
1322 # Serial line of the target is available
1323 my $interrupt = 'Ctrl-C';
1324 if ($interactive && !@exiton) {
1325 $interrupt = '"~~."';
1327 print STDERR "novaboot: Serial line interaction (press $interrupt to interrupt)...\n";
1328 $exp->log_stdout(1);
1330 $exp->expect($exiton_timeout, @exiton, @expect_raw) || die("exiton: " . ($! || "timeout"));
1332 my @inputs = ($exp);
1333 my $infile = new IO::File;
1334 $infile->IO::File::fdopen(*STDIN,'r');
1335 my $in_object = Expect->exp_init($infile);
1336 $in_object->set_group($exp);
1339 $in_object->set_seq('~~\.', sub { print STDERR "novaboot: Escape sequence detected\r\n"; undef; });
1340 $in_object->manual_stty(0); # Use raw terminal mode
1342 $in_object->manual_stty(1); # Do not modify terminal settings
1344 push(@inputs, $in_object);
1346 #print Dumper(\@expect_raw);
1347 $exp->expect(undef, @expect_raw) if @expect_raw;
1349 $^W = 0; # Suppress Expect warning: handle id(3) is not a tty. Not changing mode at /usr/share/perl5/Expect.pm line 393, <> line 8.
1350 Expect::interconnect(@inputs) unless defined($exp->exitstatus);
1355 # When exp-spawned command ignores SIGHUP, Expect waits 5 seconds
1356 # before killing it. We kill it by SIGTERM immediately.
1357 kill TERM => $exp->pid if defined $exp && $exp->pid;
1359 ## Kill dhcpc or tftpd
1360 if (defined $dhcp_tftp || defined $tftp) {
1361 die("novaboot: This should kill servers on background\n");
1364 # Always finish novaboot output with newline
1365 print "\n" if $final_eol;
1373 novaboot - Boots a locally compiled operating system on a remote
1380 B<novaboot> [option]... [--] script...
1382 B<./script> [option]...
1386 Novaboot makes booting of a locally compiled operating system (OS)
1387 (e.g. NOVA or Linux) on remote targets as simple as running a program
1388 locally. It automates things like copying OS images to a TFTP server,
1389 generation of bootloader configuration files, resetting of target
1390 hardware or redirection of target's serial line to stdin/out. Novaboot
1391 is highly configurable and makes it easy to boot a single image on
1392 different targets or different images on a single target.
1394 Novaboot operation is controlled by configuration files, command line
1395 options and by a so-called novaboot script, which can be thought as a
1396 generalization of bootloader configuration files (see L</"NOVABOOT
1397 SCRIPT SYNTAX">). The typical way of using novaboot is to make the
1398 novaboot script executable and set its first line to I<#!/usr/bin/env
1399 novaboot>. Then, booting a particular OS configuration becomes the
1400 same as executing a local program – the novaboot script.
1402 Novaboot uses configuration files to, among other things, define
1403 command line options needed for different targets. Users typically use
1404 only the B<-t>/B<--target> command line option to select the target.
1405 Internally, this option expands to the pre-configured options.
1406 Novaboot searches configuration files at multiple places, which allows
1407 having per-system, per-user or per-project configurations.
1408 Configuration file syntax is described in section L</"CONFIGURATION
1411 Novaboot newcomers may be confused by a large number of configuration
1412 options. Understanding all these options is not always needed,
1413 depending on the used setup. The L<figure from the doc directory
1414 |https://github.com/wentasah/novaboot/blob/master/doc/typical-setups.svg>
1415 shows different setups that vary in how much effort is needed
1416 to configure novaboot for them. The setups are:
1420 =item A: Laptop and target device only
1422 This requires to configure everything on the laptop side, including a
1423 serial line connection (L</--serial>, L</--remote-cmd>, ...), power
1424 on/off/reset commands (L</--reset-cmd>, ...), TFTP server
1425 (L</--copy>, L</--prefix>...), device IP addresses, etc.
1427 =item B: Laptop, target device and external TFTP server
1429 Like the previous setup, but the TFTP (and maybe DHCP) configuration
1430 is handled by a server. Novaboot users need to understand where to
1431 copy their files to the TFTP server (L</--copy>) and which IP
1432 addresses their target will get, but do not need to configure the
1435 =item C: Novaboot server running novaboot-shell
1437 With this setup, the configuration is done on the server. Users only
1438 need to know the SSH account (L</--ssh>) used to communicate between
1439 novaboot and novaboot server. The server is implemented as a
1440 restricted shell (L<novaboot-shell(1)>) on the server. No need to give
1441 full shell access to novaboot users on the server.
1445 =head2 Simple examples of using C<novaboot>:
1447 To boot Linux (files F<bzImage> and F<rootfs.cpio> in current
1448 directory), create F<mylinux> file with this content:
1450 #!/usr/bin/env novaboot
1451 load bzImage console=ttyS0,115200
1458 Booting an OS in Qemu can be accomplished by giving the B<--qemu> option.
1461 novaboot --qemu mylinux
1463 (or C<./mylinux --qemu> as described above) will run Qemu and make it
1464 boot the configuration specified in the F<mylinux> script. How is qemu
1465 started can be configured in various ways (see below).
1469 Create a bootloader configuration file (currently supported
1470 bootloaders are GRUB, GRUB2, ISOLINUX, Pulsar, and U-Boot) and copy it
1471 with all other files needed for booting to a remote TFTP server. Then
1472 use a TCP/IP-controlled relay/serial-to-TCP converter to reset the
1473 target and receive its serial output.
1475 ./mylinux --grub2 --copy=192.168.1.1:/tftp --iprelay=192.168.1.2
1477 Alternatively, you can put these switches to the configuration file
1480 ./mylinux --target mytarget
1484 Specifying all the options needed by novaboot to successfully control
1485 the target, either on command line or in configuration files, can be
1486 difficult for users. Novaboot supports configuring the target
1487 centrally via L<novaboot-shell(1)> on a server. With such a
1488 configuration, users only need to use the B<--ssh> option to specify
1489 where to boot their OS:
1491 ./mylinux --ssh myboard@example.com
1493 Typically, the server is the computer connected to and controlling the
1494 target board and running the TFTP server.
1498 Run DHCP and TFTP server on developer's machine to boot the target
1501 ./mylinux --dhcp-tftp
1503 This usage is useful when no network infrastructure is in place, and
1504 the target is connected directly to developer's box.
1508 Create bootable ISO image.
1510 novaboot --iso -- script1 script2
1512 The created ISO image will have ISOLINUX bootloader installed on it,
1513 and the boot menu will allow selecting between I<script1> and
1514 I<script2> configurations.
1518 =head1 OPTIONS AND PHASES
1520 Novaboot performs its work in several phases. Command line options
1521 described bellow influence the execution of each phase or allow their
1522 skipping. The list of phases (in the execution order) is as follows.
1526 =item 1. L<Configuration reading|/Configuration reading phase>
1528 =item 2. L<Command line processing|/Command line processing phase>
1530 =item 3. L<Script preprocessing|/Script preprocessing phase>
1532 =item 4. L<File generation|/File generation phase>
1534 =item 5. L<Target connection|/Target connection check>
1536 =item 6. L<File deployment|/File deployment phase>
1538 =item 7. L<Target power-on and reset|/Target power-on and reset phase>
1540 =item 8. L<Interaction with the bootloader|/Interaction with the bootloader on the target>
1542 =item 9. L<Target interaction|/Target interaction phase>
1546 Each phase is described in the following sections together with the
1547 command line options that control it.
1549 =head2 Configuration reading phase
1551 After starting, novaboot reads zero or more configuration files. We
1552 describe their content in section L</"CONFIGURATION FILES">. By default, the
1553 configuration is read from multiple locations. First from the system
1554 configuration directory (F</etc/novaboot.d/>), second from the user
1555 configuration file (F<~/.config/novaboot>) and third from F<.novaboot>
1556 files along the path to the current directory. Alternatively, a single
1557 configuration file specified with the B<-c> switch or with the
1558 C<NOVABOOT_CONFIG> environment variable is read. The latter read files
1559 override settings from the former ones.
1561 The system configuration directory is determined by the content of
1562 NOVABOOT_CONFIG_DIR environment variable and defaults to
1563 F</etc/novaboot.d>. Files in this directory with names consisting
1564 solely of English letters, numbers, dashes '-' and underscores '_'
1565 (note that dot '.' is not included) are read in alphabetical order.
1567 Then, the user configuration file is read from
1568 F<$XDG_CONFIG_HOME/novaboot>. If C<$XDG_CONFIG_HOME> environment
1569 variable is not set F<~/.config/novaboot> is read instead.
1571 Finally, novaboot searches for files named F<.novaboot> starting from the
1572 directory of the novaboot script (or working directory, see bellow)
1573 and continuing upwards up to the root directory. The found
1574 configuration files are then read in the opposite order (i.e. from the
1575 root directory downwards). This ordering allows having, for example, a project
1576 specific configuration in F<~/project/.novaboot>.
1578 Note the difference between F<~/.config/novaboot> and F<~/.novaboot>.
1579 The former one is always read, whereas the latter only when novaboot
1580 script or working directory is under the C<$HOME> directory.
1582 In certain cases, the location of the novaboot script cannot be
1583 determined in this early phase. This situation happens either when the script is
1584 read from the standard input or when novaboot is invoked explicitly as
1585 in the example L</"4."> above. In this case, the current working
1586 directory is used as a starting point for configuration file search
1587 instead of the novaboot script directory.
1591 =item -c, --config=I<filename>
1593 Use the specified configuration file instead of the default one(s).
1597 =head2 Command line processing phase
1603 Dump the current configuration to stdout end exit. Useful as an
1604 initial template for a configuration file.
1608 Print short (B<-h>) or long (B<--help>) help.
1610 =item -t, --target=I<target>
1612 This option serves as a user configurable shortcut for other novaboot
1613 options. The effect of this option is the same as specifying the
1614 options stored in the C<%targets> configuration variable under key
1615 I<target>. See also L</"CONFIGURATION FILES">.
1617 When this option is not given, novaboot tries to determine the target
1618 to use from either B<NOVABOOT_TARGET> environment variable or
1619 B<$default_target> configuration file variable.
1621 =item --ssh=I<user@hostname>
1623 Configures novaboot to control the target via C<novaboot-shell>
1624 running remotely via SSH.
1626 Using this option is the same as specifying B<--remote-cmd>,
1627 B<--remote-expect>, B<--copy> B<--rsync-flags>, B<--prefix> and
1628 B<--reset-cmd> manually in a way compatible with C<novaboot-shell>.
1629 The server can be configured to provide other, safe bootloader-related
1630 options, to the client. When this happens, novaboot prints them to
1633 Currently, this in an initial experimental implementation. We plan to
1634 change/extend this feature soon!
1638 =head2 Script preprocessing phase
1640 This phase allows modifying the parsed novaboot script before it is
1641 used in the later phases.
1645 =item -a, --append=I<parameters>
1647 Append a string to the first C<load> line in the novaboot script. This option
1648 can be used to append parameters to the kernel's or root task's
1649 command line. This option can appear multiple times.
1653 Use L<Bender|https://github.com/TUD-OS/morbo/blob/master/standalone/bender.c>
1654 chainloader. Bender scans the PCI bus for PCI serial ports and stores
1655 the information about them in the BIOS data area for use by the
1658 =item --chainloader=I<chainloader>
1660 Specifies a chainloader that is loaded before the kernel and other
1661 files specified in the novaboot script. E.g. 'bin/boot/bender
1666 Print the modules to boot and their parameters, after this phase
1667 finishes. Then exit. This is useful for seeing the effect of other
1668 options in this section.
1670 =item -k, --kernel=F<file>
1672 Replace the first word on the first C<load> line in the novaboot
1673 script with F<file>.
1675 =item --scriptmod=I<Perl expression>
1677 When novaboot reads the script, I<Perl expression> is executed for every
1678 line (in $_ variable). For example, C<novaboot
1679 --scriptmod=s/sigma0/omega6/g> replaces every occurrence of I<sigma0>
1680 in the script with I<omega6>.
1682 When this option is present, it overrides I<$script_modifier> variable
1683 from the configuration file, which has the same effect. If this option
1684 is given multiple times all expressions are evaluated in the command
1689 =head2 File generation phase
1691 In this phase, files needed for booting are generated in a so-called
1692 I<build directory> (see L</--build-dir>). In most cases configuration
1693 for a bootloader is generated automatically by novaboot. It is also
1694 possible to generate other files using I<heredoc> or I<"<"> syntax in
1695 novaboot scripts. Finally, novaboot can generate binaries in this phases by
1696 running C<scons> or C<make>.
1700 =item --build-dir=I<directory>
1702 Overrides the default build directory location.
1704 The default build directory location is determined as follows: If the
1705 configuration file defines the C<$builddir> variable, its value is
1706 used. Otherwise, it is the directory that contains the first processed
1709 See also L</BUILDDIR> variable.
1711 =item -g, --grub[=I<filename>]
1713 Generates grub bootloader menu file. If the I<filename> is not
1714 specified, F<menu.lst> is used. The I<filename> is relative to the
1715 build directory (see B<--build-dir>).
1717 =item --grub-preamble=I<prefix>
1719 Specifies the I<preamble> that is at the beginning of the generated
1720 GRUB or GRUB2 config files. This is useful for specifying GRUB's
1723 =item --prefix=I<prefix>
1725 Specifies I<prefix> (e.g. F</srv/tftp>) that is put in front of every
1726 filename in generated bootloader configuration files (or in U-Boot
1729 If the I<prefix> contains string $NAME, it will be replaced with the
1730 name of the novaboot script (see also B<--name>).
1732 If the I<prefix> contains string $BUILDDIR, it will be replaced with
1733 the build directory (see also B<--build-dir>).
1737 Alias for B<--prefix>.
1739 =item --grub2[=I<filename>]
1741 Generate GRUB2 menu entry in I<filename>. If I<filename> is not
1742 specified F<./boot/grub/grub.cfg> is used. The content of the menu entry can be
1743 customized with B<--grub-preamble>, B<--grub2-prolog> or
1744 B<--grub_prefix> options.
1746 GRUB2 can boot multiboot-compliant kernels and a few kernels with specific
1747 support. L</BOOT_METHOD> could be used to specify the command used by GRUB2 to
1748 load the kernel. See L<GNU GRUB Manual|https://www.gnu.org/software/grub/manual/grub/grub.html#Booting>.
1750 To use the generated menu entry on your development
1751 machine that uses GRUB2, append the following snippet to
1752 F</etc/grub.d/40_custom> file and regenerate your grub configuration,
1753 i.e. run update-grub on Debian/Ubuntu.
1755 if [ -f /path/to/nul/build/grub.cfg ]; then
1756 source /path/to/nul/build/grub.cfg
1759 =item --grub2-prolog=I<prolog>
1761 Specifies the text that novaboot puts at the beginning of the GRUB2 menu entry.
1763 =item -m, --make[=make command]
1765 Runs C<make> to build files that are not generated by novaboot itself.
1767 =item --name=I<string>
1769 Use the name I<string> instead of the name of the novaboot script.
1770 This name is used for things like a title of grub menu or for the
1771 server directory where the boot files are copied to.
1775 Do not run external commands to generate files (i.e. "<" syntax and
1776 C<run> keyword). This switch does not influence the generation of files
1777 specified with "<<WORD" syntax.
1779 =item -p, --pulsar[=mac]
1781 Generates pulsar bootloader configuration file named F<config-I<mac>>
1782 The I<mac> string is typically a MAC address and defaults to
1785 =item --scons[=scons command]
1787 Runs C<scons> to build files that are not generated by novaboot
1792 Strip I<rom://> prefix from command lines and generated config files.
1793 The I<rom://> prefix is used by NUL. For NRE, it has to be stripped.
1797 Exit novaboot after file generation phase.
1801 =head2 Target connection check
1803 In this phase novaboot connects to target's serial port (if it has
1804 one). If another novaboot user/instance occupies the target, novaboot
1805 exits here with an error message.
1809 =item --amt=I<"[user[:password]@]host[:port]>
1811 Use Intel AMT technology to control the target machine. WS management
1812 is used to powercycle it and Serial-Over-Lan (SOL) for input/output.
1813 The hostname or (IP address) is given by the I<host> parameter. If the
1814 I<password> is not specified, environment variable AMT_PASSWORD is
1815 used. The I<port> specifies a TCP port for SOL. If not specified, the
1816 default is 16992. The default I<user> is admin.
1818 =item --iprelay=I<addr[:port]>
1820 Use TCP/IP relay and serial port to access the target's serial port
1821 and powercycle it. The I<addr> parameter specifies the IP address of
1822 the relay. If I<port> is not specified, it defaults to 23.
1824 Note: This option is supposed to work with HWG-ER02a IP relays.
1826 =item --iprelay-cmd=I<command>
1828 Similar to B<--iprelay> but uses I<command> to talk to the iprelay
1829 rather than direct network connection.
1831 =item -s, --serial[=device]
1833 Target's serial line is connected to host's serial line (device). The
1834 default value for device is F</dev/ttyUSB0>.
1836 The value of this option is exported in NB_NOVABOOT environment
1837 variable to all subprocesses run by C<novaboot>.
1839 =item --stty=I<settings>
1841 Specifies settings passed to C<stty> invoked on the serial line
1842 specified with B<--serial> option. If this option is not given,
1843 C<stty> is called with C<raw -crtscts -onlcr 115200> settings.
1845 =item --remote-cmd=I<cmd>
1847 Command that mediates connection to the target's serial line. For
1848 example C<ssh server 'cu -l /dev/ttyS0'>.
1850 =item --remote-expect=I<string>
1852 Wait for reception of I<string> after establishing the remote serial
1853 line connection. Novaboot assumes that after establishing the serial
1854 line connection, the user running novaboot has exclusive access to the
1855 target. If establishing of the serial line connection happens
1856 asynchronously (e.g. running a command remotely via SSH), we need this
1857 option to wait until the exclusive access is confirmed by the remote
1860 Depending on target configuration, this option can solve two practical
1861 problems: 1) Overwriting of files deployed by another user currently
1862 using the target. 2) Resetting the target board before serial line
1863 connection is established and thus missing bootloader interaction.
1865 Example of usage with the L<sterm
1866 tool|https://rtime.felk.cvut.cz/gitweb/sojka/sterm.git>:
1868 --remote-cmd='ssh -tt example.com sterm -v /dev/ttyUSB0' --remote-expect='sterm: Connected'
1870 =item --remote-expect-silent=I<string>
1872 The same as B<--remote-expect> except that the remote output is not
1873 echoed to stdout while waiting for the I<string>. Everything after the
1874 matched string is printed to stdout, so you may want to include line
1875 end characters in the I<string> as well.
1877 =item --remote-expect-timeout=I<seconds>
1879 Timeout in seconds for B<--remote-expect> or
1880 B<--remote-expect-seconds>. When negative, waits forever. The default
1885 =head2 File deployment phase
1887 In some setups, it is necessary to copy the files needed for booting
1888 to a particular location, e.g. to a TFTP boot server or to the
1893 =item -d, --dhcp-tftp
1895 Turns your workstation into a DHCP and TFTP server so that the OS can
1896 be booted via PXE BIOS (or similar mechanism) on the test machine
1897 directly connected by a plain Ethernet cable to your workstation.
1899 The DHCP and TFTP servers require root privileges and C<novaboot>
1900 uses C<sudo> command to obtain those. You can put the following to
1901 I</etc/sudoers> to allow running the necessary commands without asking
1904 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
1905 your_login ALL=NOPASSWD: NOVABOOT
1909 Starts a TFTP server on your workstation. This is similar to
1910 B<--dhcp-tftp> except that DHCP server is not started.
1912 The TFTP server requires root privileges and C<novaboot> uses C<sudo>
1913 command to obtain those. You can put the following to I</etc/sudoers>
1914 to allow running the necessary commands without asking for a password.
1916 Cmnd_Alias NOVABOOT = /usr/sbin/in.tftpd --listen --secure -v -v -v --pidfile tftpd.pid *, /usr/bin/pkill --pidfile=tftpd.pid
1917 your_login ALL=NOPASSWD: NOVABOOT
1919 =item --tftp-port=I<port>
1921 Port to run the TFTP server on. Implies B<--tftp>.
1923 =item --netif=I<network interface>
1925 Network interface used to deploy files to the target. This option
1926 influences the configuration of the DHCP server started by
1927 B<--dhcp-tftp> and the value that B<$NB_MYIP> get replaced with during
1928 U-Boot conversation. The default value is C<$netif> variable from
1929 configuration files, which defaults to I<eth0>.
1931 =item --iso[=filename]
1933 Generates the ISO image that boots NOVA system via GRUB. If no filename
1934 is given, the image is stored under I<NAME>.iso, where I<NAME> is the name
1935 of the novaboot script (see also B<--name>).
1937 =item --server[=[[user@]server:]path]
1939 Alias of B<--copy> (kept for backward compatibility).
1941 =item --copy[=[[user@]server:]path]
1943 Copy all files needed for booting to another location. The files will
1944 be copied (by B<rsync> tool) to the directory I<path>. If the I<path>
1945 contains string $NAME, it will be replaced with the name of the
1946 novaboot script (see also B<--name>).
1948 =item --rsync-flags=I<flags>
1950 Specifies I<flags> to append to F<rsync> command line when
1951 copying files as a result of I<--copy> option.
1955 If B<--copy> is used and its value ends with $NAME, then after
1956 copying the files, a new bootloader configuration file (e.g. menu.lst)
1957 is created at I<path-wo-name>, i.e. the path specified by B<--copy>
1958 with $NAME part removed. The content of the file is created by
1959 concatenating all files of the same name from all subdirectories of
1960 I<path-wo-name> found on the "server".
1964 Use Intel AMT technology for IDE redirection. This allows the target
1965 machine to boot from novaboot created ISO image. Implies B<--iso>.
1967 The experimental C<amtider> utility needed by this option can be
1968 obtained from https://github.com/wentasah/amtterm.
1972 =head2 Target power-on and reset phase
1974 At this point, the target is reset (or switched on/off). There are
1975 several ways how this can be accomplished. Resetting a physical target
1976 can currently be accomplished by the following options: B<--amt>,
1977 B<--iprelay>, B<--reset-cmd> and B<--reset-send>.
1983 Switch on/off the target machine and exit. The script (if any) is
1984 completely ignored. Currently, it works only with the following
1985 options: B<--iprelay>, B<--amt>, B<--ssh>.
1987 =item -Q, --qemu[=I<qemu-binary>]
1989 Boot the configuration in qemu. Optionally, the name of qemu binary
1990 can be specified as a parameter.
1992 =item --qemu-append=I<flags>
1994 Append I<flags> to the default qemu flags (QEMU_FLAGS variable or
1995 C<-cpu coreduo -smp 2>).
1997 =item -q, --qemu-flags=I<flags>
1999 Replace the default qemu flags (QEMU_FLAGS variable or C<-cpu coreduo
2000 -smp 2>) with I<flags> specified here.
2002 =item --reset-cmd=I<cmd>
2004 Runs command I<cmd> to reset the target.
2006 =item --reset-send=I<string>
2008 Reset the target by sending the given I<string> to the remote serial
2009 line. "\n" sequences are replaced with the newline character.
2011 =item --no-reset, --reset
2013 Disable/enable resetting of the target.
2017 =head2 Interaction with the bootloader on the target
2021 =item --uboot[=I<prompt>]
2023 Interact with U-Boot bootloader to boot the thing described in the
2024 novaboot script. I<prompt> specifies the U-Boot's prompt (default is
2025 "=> ", other common prompts are "U-Boot> " or "U-Boot# ").
2029 Disable U-Boot interaction previously enabled with B<--uboot>.
2031 =item --uboot-stop-key=I<key>
2033 Character, which is sent as a response to U-Boot's "Hit any key to
2034 stop autoboot" message. The default value is newline, but some devices
2035 (e.g. TP-Link TD-W8970) require a specific key to be pressed.
2039 Command(s) to send the U-Boot bootloader before loading the images and
2040 booting them. This option can be given multiple times. After sending
2041 commands from each option novaboot waits for U-Boot I<prompt>.
2043 If the command contains string I<$NB_MYIP> then this string is
2044 replaced by IPv4 address of eth0 interface (see also B<--netif>).
2045 Similarly, I<$NB_PREFIX> is replaced with prefix given by B<--prefix>.
2047 See also C<uboot> keyword in L</"NOVABOOT SCRIPT SYNTAX">).
2049 =item --uboot-addr I<name>=I<address>
2051 Load address of U-Boot's C<tftpboot> command for loading I<name>,
2052 where name is one of I<kernel>, I<ramdisk> or I<fdt> (flattened device
2055 The default addresses are ${I<name>_addr_r}, i.e. U-Boot environment
2056 variables used by convention for this purpose.
2058 =item --uboot-cmd=I<command>
2060 Specifies U-Boot command used to execute the OS. If the command
2061 contains strings C<$kernel_addr>, C<$ramdisk_addr>, C<$fdt_addr>,
2062 these are replaced with the addresses configured with B<--uboot-addr>.
2064 The default value is
2066 bootm $kernel_addr $ramdisk_addr $fdt_addr
2068 or the C<UBOOT_CMD> variable if defined in the novaboot script.
2072 =head2 Target interaction phase
2074 In this phase, target's serial output is redirected to stdout and if
2075 stdin is a TTY, it is redirected to the target's serial input allowing
2076 interactive work with the target.
2080 =item --exiton=I<string>
2082 When the I<string> is sent by the target, novaboot exits. This option can
2083 be specified multiple times, in which case novaboot exits whenever
2084 either of the specified strings is sent.
2086 If the I<string> is C<-re>, then the next B<--exiton>'s I<string> is
2087 treated as a regular expression. For example:
2089 --exiton -re --exiton 'error:.*failed'
2091 =item --exiton-re=I<regex>
2093 The same as --exiton -re --exiton I<regex>.
2095 =item --exiton-timeout=I<seconds>
2097 By default B<--exiton> waits for the string match forever. When this
2098 option is specified, "exiton" timeouts after the specified number of
2099 seconds and novaboot returns non-zero exit code.
2101 =item -i, --interactive
2103 Setup things for the interactive use of the target. Your terminal will
2104 be switched to raw mode. In raw mode, your local terminal does not
2105 process input in any way (no echoing of entered characters, no
2106 interpretation of special characters). This, among others, means that
2107 Ctrl-C is passed to the target and does not interrupt novaboot. To
2108 exit from novaboot interactive mode type "~~.".
2110 =item --no-interaction, --interaction
2112 Skip resp. force target interaction phase. When skipped, novaboot exits
2113 immediately after the boot is initiated.
2115 =item --expect=I<string>
2117 When the I<string> is received from the target, send the string specified
2118 with the subsequent B<--send*> option to the target.
2120 =item --expect-re=I<regex>
2122 When target's output matches regular expression I<regex>, send the
2123 string specified with the subsequent B<--send*> option to the target.
2125 =item --expect-raw=I<perl-code>
2127 Provides direct control over Perl's Expect module.
2129 =item --send=I<string>
2131 Send I<string> to the target after the previously specified
2132 B<--expect*> was matched in the target's output. The I<string> may
2133 contain escape sequences such as "\n".
2135 Note that I<string> is actually interpreted by Perl, so it can contain
2136 much more that escape sequences. This behavior may change in the
2139 Example: C<--expect='login: ' --send='root\n'>
2141 =item --sendcont=I<string>
2143 Similar to B<--send> but continue expecting more input.
2145 Example: C<--expect='Continue?' --sendcont='yes\n'>
2147 =item --final-eol, --no-final-eol
2149 By default, B<novaboot> always prints an end-of-line character at the
2150 end of its execution in order to ensure that the output of programs
2151 started after novaboot appears at the beginning of the line. When this
2152 is not desired B<--no-final-eol> option can be used to override this
2157 =head1 NOVABOOT SCRIPT SYNTAX
2159 The syntax tries to mimic POSIX shell syntax. The syntax is defined
2160 by the following rules.
2162 Lines starting with "#" and empty lines are ignored.
2164 Lines that end with "\" are concatenated with the following line after
2165 removal of the final "\" and leading whitespace of the following line.
2167 Lines of the form I<VARIABLE=...> (i.e. matching '^[A-Z_]+=' regular
2168 expression) assign values to internal variables. See L</VARIABLES>
2171 Otherwise, the first word on the line defines the meaning of the line.
2172 The following keywords are supported:
2178 These lines represent modules to boot. The
2179 word after C<load> is a file name (relative to the build directory
2180 (see B<--build-dir>) of the module to load and the remaining words are
2181 passed to it as the command line parameters.
2183 When booting Linux, the first C<load> line usually refers to the
2184 kernel image and its command line parameters (unless you use some
2185 special pre-loader). Other C<load> lines may refer to an initramfs
2186 image and/or a device tree blob. Their order is not important, as the
2187 device tree is recognized as the file name ending with C<.dtb>.
2189 When the C<load> line ends with "<<WORD" then the subsequent lines
2190 until the line containing solely WORD are copied literally to the file
2191 named on that line. This is similar to the heredoc feature of UNIX
2194 When the C<load> line ends with "< CMD" then command CMD is executed
2195 with F</bin/sh> and its standard output is stored in the file named on
2196 that line. The SRCDIR variable in CMD's environment is set to the
2197 absolute path of the directory containing the interpreted novaboot
2202 These lines are similar to C<load> lines. The
2203 file mentioned there is copied to the same place as in the case of C<load>
2204 (e.g. tftp server), but the file is not used in the bootloader
2205 configuration. Such a file can be used by the target for other
2206 purposes than booting, e.g. at OS runtime or for firmware update.
2210 Chainload another bootloader. Instead of loading multiboot modules
2211 identified with C<load> keyword, run another bootloader. This is
2212 currently supported only by pulsar and can be used to load e.g. Grub
2213 as in the example below:
2215 chld boot/grub/i386-pc/core.0
2220 Lines starting with C<run> keyword contain shell commands that are run
2221 during file generation phase. This is the same as the "< CMD" syntax
2222 for C<load> keyboard except that the command's output is not
2223 redirected to a file. The ordering of commands is the same as they
2224 appear in the novaboot script.
2228 These lines represent U-Boot commands that are sent to the target if
2229 B<--uboot> option is given. Having a U-Boot line in the novaboot
2230 script is the same as giving B<--uboot-init> option to novaboot. The
2231 following syntax variants are supported:
2234 uboot[:<timeout>] <string> [> <file>]
2235 uboot[:<timeout>] < <shell> [> <file>]
2237 C<string> is the literal U-Boot command.
2239 The C<uboot> keyword can be suffixed with timeout specification. The
2240 syntax is C<uboot:Ns>, where C<N> is the whole number of seconds. If
2241 the U-Boot command prompt does not appear before the timeout, novaboot
2242 fails. The default timeout is 10 seconds.
2244 In the second variant with the C<<> character the shell code is
2245 executed and its standard output is sent to U-Boot. Example:
2247 uboot < printf "mmc write \$loadaddr 1 %x" $(($(/usr/bin/stat -c%s rootfs.ext4) / 512))
2249 When C<E<gt> file> part is present, the output of the U-Boot command
2250 is written into the given file.
2256 #!/usr/bin/env novaboot
2257 load bzImage console=ttyS0,115200
2258 run make -C buildroot
2259 load rootfs.cpio < gen_cpio buildroot/images/rootfs.cpio "myapp->/etc/init.d/S99myapp"
2261 Example (NOVA User Land - NUL):
2263 #!/usr/bin/env novaboot
2264 WVDESC=Example program
2265 load bin/apps/sigma0.nul S0_DEFAULT script_start:1,1 \
2266 verbose hostkeyb:0,0x60,1,12,2
2267 load bin/apps/hello.nul
2268 load hello.nulconfig <<EOF
2269 sigma0::mem:16 name::/s0/log name::/s0/timer name::/s0/fs/rom ||
2270 rom://bin/apps/hello.nul
2273 This example will load three modules: F<sigma0.nul>, F<hello.nul> and
2274 F<hello.nulconfig>. sigma0 receives some command line parameters and
2275 F<hello.nulconfig> file is generated on the fly from the lines between
2276 C<<<EOF> and C<EOF>.
2278 Example (Zynq system update via U-Boot):
2280 #!/usr/bin/env novaboot
2284 # Write kernel to FAT filesystem on the 1st SD card partition
2285 run mkimage -f uboot-image.its image.ub
2287 uboot:60s tftpboot ${loadaddr} $NB_PREFIX/image.ub
2288 uboot fatwrite mmc 0:1 ${loadaddr} image.ub $filesize
2289 uboot set bootargs console=ttyPS0,115200 root=/dev/mmcblk0p2
2291 # Write root FS image to the 2nd SD card partition
2292 copy rootfs/images/rootfs.ext4
2293 uboot:60s tftpboot ${loadaddr} $NB_PREFIX/rootfs/images/rootfs.ext4
2294 uboot mmc part > mmc-part.txt
2295 uboot < printf "mmc write \$loadaddr %x %x" $(awk '{ if ($1 == "2") { print $2 }}' mmc-part.txt) $(($(/usr/bin/stat -L --printf=%s rootfs/images/rootfs.ext4) / 512))
2302 The following variables are interpreted in the novaboot script:
2308 Specifies the way GRUB2 boots the kernel. For kernels with multiboot
2309 support use C<multiboot> method (the default). For Linux kernel use C<linux> method.
2313 Novaboot chdir()s to this directory before file generation phase. The
2314 directory name specified here is relative to the build directory
2315 specified by other means (see L</--build-dir>).
2319 Assigning this variable has the same effect as specifying L</--exiton>
2324 Setting this variable to zero is the same as giving
2325 L</--no-interaction>, specifying to one corresponds to
2328 =item HYPERVISOR_PARAMS
2330 Parameters passed to the hypervisor. The default value is "serial", unless
2331 overridden in the configuration file.
2335 The kernel to use instead of the hypervisor specified in the
2336 configuration file with the C<$hypervisor> variable. The value should
2337 contain the name of the kernel image as well as its command line
2338 parameters. If this variable is defined and non-empty, the variable
2339 HYPERVISOR_PARAMS is not used.
2343 If this variable is 1, the system is not booted. This is currently
2344 only implemented for U-Boot bootloader where it is useful for
2345 interacting with the bootloader without booting the system - e.g. for
2350 Use a specific qemu binary (can be overridden with B<-Q>) and flags
2351 when booting this script under qemu. If QEMU_FLAGS variable is also
2352 specified flags specified in QEMU variable are replaced by those in
2357 Use specific qemu flags (can be overridden with B<-q>).
2361 See L</--uboot-cmd>.
2365 Description of the WvTest-compliant program.
2367 =item WVTEST_TIMEOUT
2369 The timeout in seconds for WvTest harness. If no complete line appears
2370 in the test output within the time specified here, the test fails. It
2371 is necessary to specify this for long running tests that produce no
2372 intermediate output.
2376 =head1 CONFIGURATION FILES
2378 Novaboot can read its configuration from one or more files. By
2379 default, novaboot looks for files in F</etc/novaboot.d>, file
2380 F<~/.config/novaboot> and files named F<.novaboot> as described in
2381 L</Configuration reading phase>. Alternatively, configuration file
2382 location can be specified with the B<-c> switch or with the
2383 NOVABOOT_CONFIG environment variable. The configuration file has Perl
2384 syntax (i.e. it is better to put C<1;> as the last line) and should set
2385 values of certain Perl variables. The current configuration can be
2386 dumped with the B<--dump-config> switch. Some configuration variables
2387 can be overridden by environment variables (see below) or by command
2390 Supported configuration variables include:
2396 Build directory location relative to the location of the configuration
2399 =item $default_target
2401 Default target (see below) to use when no target is explicitly
2402 specified with the B<--target> command line option or
2403 B<NOVABOOT_TARGET> environment variable.
2407 Default value for the B<--netif> option. If not specified, it defaults
2412 Hash of target definitions to be used with the B<--target> option. The
2413 key is the identifier of the target, the value is the string with
2414 command line options. For instance, if the configuration file contains:
2416 $targets{'mybox'} = '--copy=boot:/tftproot --serial=/dev/ttyUSB0 --grub',
2418 then the following two commands are equivalent:
2420 ./myos --copy=boot:/tftproot --serial=/dev/ttyUSB0 --grub
2425 =head1 ENVIRONMENT VARIABLES
2427 Some options can be specified not only via config file or command line
2428 but also through environment variables. Environment variables override
2429 the values from the configuration file and command line parameters
2430 override the environment variables.
2434 =item NOVABOOT_CONFIG
2436 Name of the novaboot configuration file to use instead of the default
2439 =item NOVABOOT_CONFIG_DIR
2441 Name of the novaboot configuration directory. When not specified
2442 F</etc/novaboot.d> is used.
2444 =item NOVABOOT_TARGET
2446 Name of the novaboot target to use. This overrides the value of
2447 B<$default_target> from the configuration file and can be overridden
2448 with the B<--target> command line option.
2450 =item NOVABOOT_BENDER
2452 Defining this variable has the same effect as using B<--bender>
2459 Michal Sojka <sojka@os.inf.tu-dresden.de>
2461 Latest novaboot version can be found at
2462 L<https://github.com/wentasah/novaboot>.
2466 # LocalWords: novaboot Novaboot NOVABOOT TFTP PXE DHCP filename stty
2467 # LocalWords: chainloader stdout Qemu qemu preprocessing ISOLINUX bootable
2468 # LocalWords: config subprocesses sudo sudoers tftp dhcp IDE stdin
2469 # LocalWords: subdirectories TTY whitespace heredoc POSIX WvTest