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);
26 use Time::HiRes("usleep");
30 use POSIX qw(:errno_h sysconf);
31 use Cwd qw(getcwd abs_path);
37 my $invocation_dir = $ENV{PWD} || getcwd();
39 # We prefer using PWD, to use nicer paths names with symbolic links.
40 # However, when executed from 'make -C dir', PWD may contain the make
41 # invocation path, not the real invocation path with dir at the end.
43 if (abs_path($ENV{PWD}) ne abs_path(getcwd())) {
44 $invocation_dir = getcwd();
47 ## Configuration file handling
49 # Default configuration
50 $CFG::hypervisor = "";
51 $CFG::hypervisor_params = "serial";
52 $CFG::genisoimage = "genisoimage";
53 $CFG::qemu = 'qemu-system-i386 -cpu coreduo -smp 2';
54 $CFG::default_target = '';
57 "tud" => '--server=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',
58 "novabox" => '--ssh=novabox@rtime.felk.cvut.cz',
59 "localhost" => '--scriptmod=s/console=tty[A-Z0-9,]+// --server=/boot/novaboot/$NAME --grub2 --grub-prefix=/boot/novaboot/$NAME --grub2-prolog=" set root=\'(hd0,msdos1)\'"',
60 "ryu" => '--uboot --uboot-init="mw f0000b00 \${psc_cfg}; sleep 1" --uboot-addr kernel=800000 --uboot-addr ramdisk=b00000 --uboot-addr fdt=7f0000',
61 "ryuglab" => '--target ryu --ssh=ryu@pc-sojkam.felk.cvut.cz',
62 "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"',
67 $const{linux}->{_SC_NPROCESSORS_CONF} = 83;
68 my $nproc = sysconf($const{$^O}->{_SC_NPROCESSORS_CONF});
70 $CFG::scons = "scons -j$nproc";
71 $CFG::make = "make -j$nproc";
79 package CFG; # Put config data into a separate namespace
85 die("ERROR: Failure compiling '$cfg' - $@");
86 } elsif (! defined($rc)) {
87 die("ERROR: Failure reading '$cfg' - $!");
89 die("ERROR: Failure processing '$cfg'");
92 $builddir = File::Spec->rel2abs($CFG::builddir, dirname($cfg)) if defined $CFG::builddir;
93 print STDERR "novaboot: Read $cfg\n";
98 # We don't use $0 here, because it points to the novaboot itself and
99 # not to the novaboot script. The problem with this approach is that
100 # when a script is run as "novaboot <options> <script>" then $ARGV[0]
101 # contains the first option. Hence the -f check.
102 my $dir = File::Spec->rel2abs($ARGV[0] && -f $ARGV[0] ? dirname($ARGV[0]) : '', $invocation_dir);
103 while ((-d $dir || -l $dir ) && $dir ne "/") {
104 push @cfgs, "$dir/.novaboot" if -r "$dir/.novaboot";
105 my @dirs = File::Spec->splitdir($dir);
106 $dir = File::Spec->catdir(@dirs[0..$#dirs-1]);
108 @cfgs = reverse @cfgs;
110 my $xdg_config_home = $ENV{'XDG_CONFIG_HOME'} || $ENV{'HOME'}.'/.config';
111 unshift(@cfgs, "$xdg_config_home/novaboot") if -r "$xdg_config_home/novaboot";
113 $dir = $ENV{'NOVABOOT_CONFIG_DIR'} || '/etc/novaboot.d';
114 if (opendir(my $dh, $dir)) {
115 my @etccfg = map { "$dir/$_" } grep { /^[-_a-zA-Z0-9]+$/ && -f "$dir/$_" } readdir($dh);
117 @etccfg = sort(@etccfg);
118 @cfgs = ( @etccfg, @cfgs );
121 my $cfg = $ENV{'NOVABOOT_CONFIG'};
122 Getopt::Long::Configure(qw/no_ignore_case pass_through/);
123 GetOptions ("config|c=s" => \$cfg);
124 read_config($_) foreach $cfg or @cfgs;
126 ## Command line handling
128 my $explicit_target = $ENV{'NOVABOOT_TARGET'};
129 GetOptions ("target|t=s" => \$explicit_target);
131 # Variables for command line options
132 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);
134 my ($target_reset, $target_power_on, $target_power_off);
136 # Default values of certain command line options
138 'kernel' => '${kernel_addr_r}',
139 'ramdisk' => '${ramdisk_addr_r}',
140 'fdt' => '${fdt_addr_r}',
143 $rom_prefix = 'rom://';
144 $stty = 'raw -crtscts -onlcr -echo 115200';
145 $reset = 1; # Reset target by default
146 $interaction = 1; # Perform target interaction by default
149 $remote_expect_timeout = -1;
151 my @expect_seen = ();
155 push(@expect_seen, '-re') if $n eq "expect-re";
156 push(@expect_seen, $v);
162 unless (@expect_seen) { die("No --expect before --send"); }
163 my $ret = ($n eq "sendcont") ? exp_continue : 0;
164 unshift(@expect_raw, sub { shift->send(eval("\"$v\"")); $ret; });
165 unshift(@expect_raw, @expect_seen);
169 # Options which can be safely specified on the server (via --ssh),
170 # i.e. which cannot cause unwanted local code execution etc.
171 my %opt_spec_safe = (
172 "grub|g:s" => \$grub_config,
173 "grub-preamble=s"=> \$grub_preamble,
174 "grub2-prolog=s" => \$grub2_prolog,
175 "grub2:s" => \$grub2_config,
176 "prefix|grub-prefix=s" => \$grub_prefix,
177 "pulsar-root=s" => \$pulsar_root,
178 "pulsar|p:s" => \$pulsar,
179 "remote-expect=s"=> \$remote_expect,
180 "remote-expect-silent=s"=> sub { $remote_expect=$_[1]; $remote_expect_silent=1; },
181 "remote-expect-timeout=i"=> \$remote_expect_timeout,
182 "uboot-addr=s" => \%uboot_addr,
183 "uboot-cmd=s" => \$uboot_cmd,
184 "uboot-stop-key=s" => \$uboot_stop_key,
185 "uboot-init=s" => sub { push @uboot_init, { command => $_[1] }; },
186 "uboot:s" => \$uboot,
192 "append|a=s" => \@append,
193 "bender|b" => \$bender,
194 "build-dir=s" => sub { my ($n, $v) = @_; $builddir = File::Spec->rel2abs($v); },
195 "concat" => \$concat,
196 "chainloader=s" => \@chainloaders,
197 "dhcp-tftp|d" => \$dhcp_tftp,
198 "dump" => \$dump_opt,
199 "dump-config" => \$dump_config,
200 "exiton=s" => \@exiton,
201 "exiton-timeout=i"=> \$exiton_timeout,
202 "exiton-re=s" => sub { my ($n, $v) = @_; push(@exiton, '-re', $v); },
203 "expect=s" => \&handle_expect,
204 "expect-re=s" => \&handle_expect,
205 "expect-raw=s" => sub { my ($n, $v) = @_; unshift(@expect_raw, eval($v)); },
206 "final-eol!" => \$final_eol,
207 "gen-only" => \$gen_only,
209 "interaction!" => \$interaction,
210 "iprelay=s" => \$iprelay,
211 "iprelay-cmd=s" => \$iprelay_cmd,
212 "iso:s" => \$iso_image,
213 "kernel|k=s" => \$kernel_opt,
214 "interactive|i" => \$interactive,
215 "name=s" => \$config_name_opt,
216 "make|m:s" => \$make,
217 "netif=s" => \$netif,
218 "no-file-gen" => \$no_file_gen,
221 "qemu|Q:s" => \$qemu,
222 "qemu-append=s" => \$qemu_append,
223 "qemu-flags|q=s" => \$qemu_flags_cmd,
224 "remote-cmd=s" => sub { @remote_cmd = ($_[1]); },
226 "reset-cmd=s" => sub { @reset_cmd = ($_[1]); },
227 "reset-send=s" => \$reset_send,
228 "rsync-flags=s" => \$rsync_flags,
229 "scons:s" => \$scons,
230 "scriptmod=s" => \@scriptmod,
231 "send=s" => \&handle_send,
232 "sendcont=s" => \&handle_send,
233 "serial|s:s" => \$serial,
234 "server:s" => \$server,
235 "ssh:s" => \&handle_novaboot_server,
236 "strip-rom" => sub { $rom_prefix = ''; },
239 "tftp-port=i" => \$tftp_port,
240 "no-uboot" => sub { undef $uboot; },
245 sub handle_novaboot_server
248 my $xdg_runtime_dir = $ENV{XDG_RUNTIME_DIR} || '/var/run';
249 my $ssh_ctl_path = "${xdg_runtime_dir}/novaboot$$";
251 @remote_cmd = ('ssh', '-tt', '-M', '-S', $ssh_ctl_path, $val, 'console');
252 $remote_expect = "novaboot-shell: Connected";
254 $rsync_flags = "--rsh='ssh -S \'${ssh_ctl_path}\''";
255 ($grub_prefix = $val) =~ s|(.*)@.*|\/$1\/| if index($val, '@') != -1;
256 @reset_cmd = ('ssh', '-tt', '-S', $ssh_ctl_path, $val, 'reset');
258 $target_power_off = sub { system_verbose('ssh', '-tt', '-S', $ssh_ctl_path, $val, 'off'); };
259 $target_power_on = sub { system_verbose('ssh', '-tt', '-S', $ssh_ctl_path, $val, 'on'); };
261 my $cmd = "ssh '${val}' get-config";
262 print STDERR "novaboot: Running: $cmd\n";
263 my @target_config = qx($cmd < /dev/null);
264 if ($?) { die("Cannot get target configuration from the server"); }
265 printf "novaboot: Received configuration from the server:%s\n", (!@target_config) ? " empty" : "";
266 foreach (@target_config) { chomp; print " $_\n"; }
268 my $p = Getopt::Long::Parser->new;
269 $p->configure(qw/no_ignore_case no_pass_through/);
270 $p->getoptionsfromarray(\@target_config, %opt_spec_safe) or die("Error processing configuration from the server");
272 if (scalar @target_config) { die "Unsuported configuration received from the server: ".join(", ", @target_config); }
275 # First process target options
277 my $t = defined($explicit_target) ? $explicit_target : $CFG::default_target;
279 Getopt::Long::Configure(qw/no_ignore_case pass_through/);
281 exists $CFG::targets{$t} or die("Unknown target '$t' (valid targets are: ".join(", ", sort keys(%CFG::targets)).")");
283 undef $explicit_target;
284 my ($ret, $remaining_args) = GetOptionsFromString ($CFG::targets{$t}, ("target|t=s" => \$explicit_target));
285 if (!$ret) { die "Error parsing target $t option"; }
286 push(@target_expanded, @$remaining_args);
287 $t = $explicit_target;
290 my @args = (@target_expanded, @ARGV);
291 print STDERR "novaboot: Effective options: @args\n";
293 Getopt::Long::Configure(qw/no_ignore_case no_pass_through/);
294 GetOptionsFromArray(\@target_expanded, %opt_spec) or die ("Error in target definition");
297 # Then process other command line options - some of them may override
298 # what was specified by the target
299 GetOptions %opt_spec or die("Error in command line arguments");
300 pod2usage(1) if $help;
301 pod2usage(-exitstatus => 0, -verbose => 2) if $man;
303 ### Dump sanitized configuration (if requested)
307 $Data::Dumper::Indent=1;
308 print "# This file is in perl syntax.\n";
309 foreach my $key(sort(keys(%CFG::))) { # See "Symbol Tables" in perlmod(1)
310 if (defined ${$CFG::{$key}}) { print Data::Dumper->Dump([${$CFG::{$key}}], ["*$key"]); }
311 if ( @{$CFG::{$key}}) { print Data::Dumper->Dump([\@{$CFG::{$key}}], ["*$key"]); }
312 if ( %{$CFG::{$key}}) { print Data::Dumper->Dump([\%{$CFG::{$key}}], ["*$key"]); }
318 ### Sanitize configuration
320 if ($interactive && !-t STDIN) {
321 die("novaboot: Interactive mode not supported when not on terminal");
324 if (defined $config_name_opt && scalar(@ARGV) > 1) { die "You cannot use --name with multiple scripts"; }
327 $iso_image //= ''; # IDE-R needs an ISO image
328 if (!defined $amt) { die "Error: --ider requires --amt"; }
332 my %input_opts = ('--iprelay' => \$iprelay,
333 '--iprelay-cmd'=> \$iprelay_cmd,
334 '--serial' => \$serial,
335 '--remote-cmd' => (@remote_cmd ? \$remote_cmd[0] : undef),
337 my @opts = grep(defined(${$input_opts{$_}}) , keys %input_opts);
339 die("novaboot: More than one target connection option: ".join(', ', @opts)) if scalar @opts > 1;
343 if (defined $serial) {
344 $serial ||= "/dev/ttyUSB0";
345 $ENV{NB_SERIAL} = $serial;
347 if (defined $grub_config) { $grub_config ||= "menu.lst"; }
348 if (defined $grub2_config) { $grub2_config ||= "grub.cfg"; }
350 ## Parse the novaboot script(s)
355 my ($modules, $variables, $generated, $copy, $chainload, $continuation) = ([], {}, [], []);
356 my $skip_reading = defined($on_opt) || defined($off_opt);
357 while (!$skip_reading && ($_ = <>)) {
358 if ($ARGV ne $last_fn) { # New script
359 die "Missing EOF in $last_fn" if $file;
360 die "Unfinished line in $last_fn" if $continuation;
362 push @scripts, { 'filename' => $ARGV,
363 'modules' => $modules = [],
364 'variables' => $variables = {},
365 'generated' => $generated = [],
366 'copy' => $copy = [],
367 'chainload' => $chainload = [],
372 next if /^#/ || /^\s*$/; # Skip comments and empty lines
374 $_ =~ s/^[[:space:]]*// if ($continuation);
376 if (/\\$/) { # Line continuation
377 $continuation .= substr($_, 0, length($_)-1);
381 if ($continuation) { # Last continuation line
382 $_ = $continuation . $_;
386 foreach my $mod(@scriptmod) { eval $mod; }
388 if ($file && $_ eq $EOF) { # Heredoc end
392 if ($file) { # Heredoc content
393 push @{$file}, "$_\n";
396 if (/^([A-Z_]+)=(.*)$/) { # Internal variable
397 $$variables{$1} = $2;
398 push(@exiton, $2) if ($1 eq "EXITON");
399 $interaction = $2 if ($1 eq "INTERACTION");
402 sub process_load_copy($) {
403 die("novaboot: '$last_fn' line $.: Missing file name\n") unless /^[^ <]+/;
404 if (/^([^ ]*)(.*?)[[:space:]]*<<([^ ]*)$/) { # Heredoc start
406 push @$generated, {filename => $1, content => $file};
410 if (/^([^ ]*)(.*?)[[:space:]]*< ?(.*)$/) { # Command substitution
411 push @$generated, {filename => $1, command => $3};
416 if (s/^load *//) { # Load line
417 push @$modules, process_load_copy($_);
420 if (s/^copy *//) { # Copy line
421 push @$copy, process_load_copy($_);
424 if (s/^chld *//) { # Chainload line
425 push @$chainload, process_load_copy($_);
428 if (/^run (.*)/) { # run line
429 push @$generated, {command => $1};
432 if (/^uboot(?::([0-9]+)s)? +(< *)?(.*)/) { # uboot line
433 # TODO: If U-Boot supports some interactive menu, it might
434 # make sense to store uboot lines per novaboot script.
435 my ($timeout, $redir, $string, $dest) = ($1, $2, $3);
436 if ($string =~ /(.*) *> *(.*)/) {
440 push @uboot_init, { command => $redir ? "" : $string,
441 system => $redir ? $string : "",
448 die("novaboot: Cannot parse script '$last_fn' line $.. Didn't you forget 'load' keyword?\n");
451 # print Dumper(\@scripts);
453 foreach my $script (@scripts) {
454 $modules = $$script{modules};
455 @$modules[0] =~ s/^[^ ]*/$kernel_opt/ if $kernel_opt;
456 @$modules[0] .= ' ' . join(' ', @append) if @append;
459 if (exists $variables->{KERNEL}) {
460 $kernel = $variables->{KERNEL};
462 if ($CFG::hypervisor) {
463 $kernel = $CFG::hypervisor . " ";
464 if (exists $variables->{HYPERVISOR_PARAMS}) {
465 $kernel .= $variables->{HYPERVISOR_PARAMS};
467 $kernel .= $CFG::hypervisor_params;
471 @$modules = ($kernel, @$modules) if $kernel;
472 @$modules = (@chainloaders, @$modules);
473 @$modules = ("bin/boot/bender", @$modules) if ($bender || defined $ENV{'NOVABOOT_BENDER'});
477 foreach my $script (@scripts) {
478 print join("\n", @{$$script{modules}})."\n";
485 sub generate_configs($$$) {
486 my ($base, $generated, $filename) = @_;
487 if ($base) { $base = "$base/"; };
488 foreach my $g(@$generated) {
489 if (exists $$g{content}) {
490 my $config = $$g{content};
491 my $fn = $$g{filename};
492 open(my $f, '>', $fn) || die("$fn: $!");
493 map { s|\brom://([^ ]*)|$rom_prefix$base$1|g; print $f "$_"; } @{$config};
495 print STDERR "novaboot: Created $fn\n";
496 } elsif (exists $$g{command} && ! $no_file_gen) {
497 $ENV{SRCDIR} = dirname(File::Spec->rel2abs( $filename, $invocation_dir ));
498 if (exists $$g{filename}) {
499 system_verbose("( $$g{command} ) > $$g{filename}");
501 system_verbose($$g{command});
507 sub generate_grub_config($$$$;$)
509 my ($filename, $title, $base, $modules_ref, $preamble) = @_;
510 if ($base) { $base = "$base/"; };
511 open(my $fg, '>', $filename) or die "$filename: $!";
512 print $fg "$preamble\n" if $preamble;
513 print $fg "title $title\n" if $title;
514 #print $fg "root $base\n"; # root doesn't really work for (nd)
516 foreach (@$modules_ref) {
519 my ($kbin, $kcmd) = split(' ', $_, 2);
520 $kcmd = '' if !defined $kcmd;
521 print $fg "kernel ${base}$kbin $kcmd\n";
523 s|\brom://([^ ]*)|$rom_prefix$base$1|g; # Translate rom:// files - needed for vdisk parameter of sigma0
524 print $fg "module $base$_\n";
528 print("novaboot: Created $builddir/$filename\n");
532 sub generate_syslinux_config($$$$)
534 my ($filename, $title, $base, $modules_ref) = @_;
535 if ($base && $base !~ /\/$/) { $base = "$base/"; };
536 open(my $fg, '>', $filename) or die "$filename: $!";
537 print $fg "LABEL $title\n";
538 #TODO print $fg "MENU LABEL $human_readable_title\n";
540 my ($kbin, $kcmd) = split(' ', @$modules_ref[0], 2);
542 if (system("file $kbin|grep 'Linux kernel'") == 0) {
543 my $initrd = @$modules_ref[1];
544 die('To many "load" lines for Linux kernel') if (scalar @$modules_ref > 2);
545 print $fg "LINUX $base$kbin\n";
546 print $fg "APPEND $kcmd\n";
547 print $fg "INITRD $base$initrd\n";
549 print $fg "KERNEL mboot.c32\n";
551 foreach (@$modules_ref) {
552 s|\brom://([^ ]*)|$rom_prefix$base$1|g; # Translate rom:// files - needed for vdisk parameter of sigma0
553 push @append, "$base$_";
554 print $fg "APPEND ".join(' --- ', @append)."\n";
557 #TODO print $fg "TEXT HELP\n";
558 #TODO print $fg "some help here\n";
559 #TODO print $fg "ENDTEXT\n";
561 print("novaboot: Created $builddir/$filename\n");
565 sub generate_grub2_config($$$$;$$)
567 my ($filename, $title, $base, $modules_ref, $preamble, $prolog) = @_;
568 if ($base && substr($base,-1,1) ne '/') { $base = "$base/"; };
569 open(my $fg, '>', $filename) or die "$filename: $!";
570 print $fg "$preamble\n" if $preamble;
571 $title ||= 'novaboot';
572 print $fg "menuentry $title {\n";
573 print $fg "$prolog\n" if $prolog;
575 foreach (@$modules_ref) {
578 my ($kbin, $kcmd) = split(' ', $_, 2);
579 $kcmd = '' if !defined $kcmd;
580 print $fg " multiboot ${base}$kbin $kcmd\n";
583 # GRUB2 doesn't pass filename in multiboot info so we have to duplicate it here
584 $_ = join(' ', ($args[0], @args));
585 s|\brom://|$rom_prefix|g; # We do not need to translate path for GRUB2
586 print $fg " module $base$_\n";
591 print("novaboot: Created $builddir/$filename\n");
595 sub generate_pulsar_config($$$)
597 my ($filename, $modules_ref, $chainload_ref) = @_;
598 open(my $fg, '>', $filename) or die "$filename: $!";
599 print $fg "root $pulsar_root\n" if defined $pulsar_root;
600 if (scalar(@$chainload_ref) > 0) {
601 print $fg "chld $$chainload_ref[0]\n";
605 foreach (@$modules_ref) {
608 ($kbin, $kcmd) = split(' ', $_, 2);
609 $kcmd = '' if !defined $kcmd;
612 s|\brom://|$rom_prefix|g;
613 print $fg "load $_\n";
616 # Put kernel as last - this is needed for booting Linux and has no influence on non-Linux OSes
617 print $fg "exec $kbin $kcmd\n";
620 print("novaboot: Created $builddir/$filename\n");
624 sub shell_cmd_string(@)
626 if (scalar(@_) == 1) {
629 return join(' ', map((/^[-_=a-zA-Z0-9\/\.\+]+$/ ? "$_" : "'$_'"), @_));
635 print STDERR "novaboot: Running: ".shell_cmd_string(@_)."\n";
637 exit(1); # should not be reached
642 print STDERR "novaboot: Running: ".shell_cmd_string(@_)."\n";
643 my $ret = system(@_);
644 if ($ret & 0x007f) { die("Command terminated by a signal"); }
645 if ($ret & 0xff00) {die("Command exit with non-zero exit code"); }
646 if ($ret) { die("Command failure $ret"); }
651 $str =~ s/^\s+|\s+$//g;
657 if (exists $variables->{WVDESC}) {
658 print STDERR "Testing \"$variables->{WVDESC}\" in $last_fn:\n";
659 } elsif ($last_fn =~ /\.wv$/) {
660 print STDERR "Testing \"all\" in $last_fn:\n";
663 ## Connect to the target and check whether it is not occupied
665 # We have to do this before file generation phase, because file
666 # generation is intermixed with file deployment phase and we want to
667 # check whether the target is not used by somebody else before
668 # deploying files. Otherwise, we may rewrite other user's files on a
671 my $exp; # Expect object to communicate with the target over serial line
673 sub kill_exp_on_signal() {
674 # Sometimes, under unclear circumstances (e.g. when running under
675 # both Jenkins and Robotframework), novaboot does not terminate
676 # console command when killed. The console is then blocked by the
677 # stale process forever. Theoretically, this should not happen,
678 # because when novaboot is killed, console command's controlling
679 # terminal sends SIGHUP to the console command and the command
680 # should terminate. It seems that at least SSH sometimes ignores
681 # HUP and does not terminate. The code below seems to work around
682 # that problem by killing the process immediately with SIGTERM,
683 # which is not ignored.
685 sub kill_console { kill TERM => $exp->pid if $exp->pid; die "Terminated by SIG$_[0]"; };
687 # For our Jenkins/Robotframework use case, it was sufficient to
688 # handle the TERM signal, but to be on the safe side, we also
689 # catch other signals.
690 $SIG{TERM} = \&kill_console;
691 $SIG{HUP} = \&kill_console;
692 $SIG{INT} = \&kill_console;
693 $SIG{QUIT} = \&kill_console;
697 my ($amt_user, $amt_password, $amt_host, $amt_port);
699 if (defined $iprelay || defined $iprelay_cmd) {
700 if (defined $iprelay) {
702 $iprelay =~ /([.0-9]+)(:([0-9]+))?/;
705 my $paddr = sockaddr_in($port, inet_aton($addr));
706 my $proto = getprotobyname('tcp');
707 socket($IPRELAY, PF_INET, SOCK_STREAM, $proto) || die "socket: $!";
708 print STDERR "novaboot: Connecting to IP relay... ";
709 connect($IPRELAY, $paddr) || die "connect: $!";
710 print STDERR "done\n";
711 $exp = Expect->init(\*$IPRELAY);
714 if (defined $iprelay_cmd) {
715 print STDERR "novaboot: Running: $iprelay_cmd\n";
718 $exp->spawn($iprelay_cmd);
719 kill_exp_on_signal();
723 print $exp "\xFF\xF6"; # AYT
724 my $connected = $exp->expect(20, # Timeout in seconds
725 '<iprelayd: connected>',
726 '-re', '<WEB51 HW[^>]*>')
727 || die "iprelay connection: " . ($! || "timeout");
732 my ($relay, $onoff) = @_;
733 die unless ($relay == 1 || $relay == 2);
735 my $cmd = ($relay == 1 ? 0x5 : 0x6) | ($onoff ? 0x20 : 0x10);
736 return "\xFF\xFA\x2C\x32".chr($cmd)."\xFF\xF0";
740 my ($relay, $onoff) = @_;
741 die unless ($relay == 1 || $relay == 2);
742 my $cmd = ($relay == 1 ? 0xdf : 0xbf) | ($onoff ? 0x00 : 0xff);
743 return "\xFF\xFA\x2C\x97".chr($cmd)."\xFF\xF0";
747 my ($relay, $onoff, $can_giveup) = @_;
748 my $confirmation = '';
750 print $exp relaycmd($relay, $onoff);
751 my $confirmed = $exp->expect(20, # Timeout in seconds
752 relayconf($relay, $onoff))
753 || die "iprelay command: " . ($! || "timeout");
756 print("Relay confirmation timeout - ignoring\n");
758 die "Relay confirmation timeout";
764 $target_reset = sub {
765 relay(2, 1, 1); # Reset the machine
770 $target_power_off = sub {
771 relay(1, 1); # Press power button
772 usleep(6000000); # Long press to switch off
776 $target_power_on = sub {
777 relay(1, 1); # Press power button
778 usleep(100000); # Short press
784 system_verbose("stty -F $serial $stty");
785 open($CONN, "+<", $serial) || die "open $serial: $!";
786 $exp = Expect->init(\*$CONN);
788 elsif (@remote_cmd) {
789 print STDERR "novaboot: Running: ".shell_cmd_string(@remote_cmd)."\n";
790 $exp = Expect->spawn(@remote_cmd);
791 kill_exp_on_signal();
793 elsif (defined $amt) {
794 require LWP::UserAgent;
795 require LWP::Authen::Digest;
798 my ($host, $username, $password, $schema, $className, $pstate) = @_;
799 #AMT numbers for PowerStateChange (MNI => bluescreen on windows;-)
800 my %pstates = ("on" => 2,
807 <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">
808 <s:Header><a:To>http://$host:16992/wsman</a:To>
809 <w:ResourceURI s:mustUnderstand="true">$schema</w:ResourceURI>
810 <a:ReplyTo><a:Address s:mustUnderstand="true">http://schemas.xmlsoap.org/ws/2004/08/addressing/role/anonymous</a:Address></a:ReplyTo>
811 <a:Action s:mustUnderstand="true">$schema$className</a:Action>
812 <w:MaxEnvelopeSize s:mustUnderstand="true">153600</w:MaxEnvelopeSize>
813 <a:MessageID>uuid:709072C9-609C-4B43-B301-075004043C7C</a:MessageID>
814 <w:Locale xml:lang="en-US" s:mustUnderstand="false" />
815 <w:OperationTimeout>PT60.000S</w:OperationTimeout>
816 <w:SelectorSet><w:Selector Name="Name">Intel(r) AMT Power Management Service</w:Selector></w:SelectorSet>
818 <p:RequestPowerStateChange_INPUT xmlns:p="http://schemas.dmtf.org/wbem/wscim/1/cim-schema/2/CIM_PowerManagementService">
819 <p:PowerState>$pstates{$pstate}</p:PowerState>
820 <p:ManagedElement><a:Address>http://$host:16992/wsman</a:Address>
821 <a:ReferenceParameters><w:ResourceURI>http://schemas.dmtf.org/wbem/wscim/1/cim-schema/2/CIM_ComputerSystem</w:ResourceURI>
822 <w:SelectorSet><w:Selector Name="Name">ManagedSystem</w:Selector></w:SelectorSet>
823 </a:ReferenceParameters></p:ManagedElement>
824 </p:RequestPowerStateChange_INPUT>
825 </s:Body></s:Envelope>
830 my ($host, $username, $password, $content) = @_;
832 my $ua = LWP::UserAgent->new();
833 $ua->agent("novaboot");
835 my $req = HTTP::Request->new(POST => "http://$host:16992/wsman");
836 my $res = $ua->request($req);
837 die ("Unexpected AMT response: " . $res->status_line) unless $res->code == 401;
839 my ($realm) = $res->header("WWW-Authenticate") =~ /Digest realm="(.*?)"/;
840 $ua->credentials("$host:16992", $realm, $username => $password);
843 $req = HTTP::Request->new(POST => "http://$host:16992/wsman");
844 $req->content_type('application/x-www-form-urlencoded');
845 $req->content($content);
846 $res = $ua->request($req);
847 die ("AMT power change request failed: " . $res->status_line) unless $res->is_success;
848 $res->content() =~ /<g:ReturnValue>(\d+)<\/g:ReturnValue>/;
853 my ($host, $username, $password, $pstate)=@_;
854 my $schema="http://schemas.dmtf.org/wbem/wscim/1/cim-schema/2/CIM_PowerManagementService";
855 my $className="/RequestPowerStateChange";
856 my $content = genXML($host, $username, $password ,$schema, $className, $pstate);
857 return sendPOST($host, $username, $password, $content);
860 ($amt_user,$amt_password,$amt_host,$amt_port) = ($amt =~ /(?:(.*?)(?::(.*))?@)?([^:]*)(?::([0-9]*))?/);;
861 $amt_user ||= "admin";
862 $amt_password ||= $ENV{'AMT_PASSWORD'} || die "AMT password not specified";
863 $amt_host || die "AMT host not specified";
867 $target_power_off = sub {
869 my $result = powerChange($amt_host,$amt_user,$amt_password, "off");
870 die "AMT power off failed (ReturnValue $result)" if $result != 0;
873 $target_power_on = sub {
874 my $result = powerChange($amt_host,$amt_user,$amt_password, "on");
875 die "AMT power on failed (ReturnValue $result)" if $result != 0;
878 $target_reset = sub {
879 my $result = powerChange($amt_host,$amt_user,$amt_password, "reset");
881 print STDERR "Warning: Cannot reset $amt_host, trying power on. ";
882 $result = powerChange($amt_host,$amt_user,$amt_password, "on");
884 die "AMT reset failed (ReturnValue $result)" if $result != 0;
887 my $cmd = "amtterm -u $amt_user -p $amt_password $amt_host $amt_port";
888 print STDERR "novaboot: Running: $cmd\n" =~ s/\Q$amt_password\E/???/r;
889 $exp = Expect->spawn($cmd);
890 $exp->expect(10, "RUN_SOL") || die "Expect for 'RUN_SOL': " . ($! || "timeout");
894 if ($remote_expect) {
895 $exp || die("No serial line connection");
896 my $log = $exp->log_stdout;
897 if (defined $remote_expect_silent) {
900 $exp->expect($remote_expect_timeout >= 0 ? $remote_expect_timeout : undef,
901 $remote_expect) || die "Expect for '$remote_expect':" . ($! || "timeout");;
902 if (defined $remote_expect_silent) {
903 $exp->log_stdout($log);
904 print $exp->after() if $log;
909 $target_reset = sub {
910 system_verbose(@reset_cmd);
914 if (defined $reset_send) {
915 $target_reset = sub {
916 $reset_send =~ s/\\n/\n/g;
917 $exp->send($reset_send);
921 if (defined $on_opt && defined $target_power_on) {
925 if (defined $off_opt && defined $target_power_off) {
926 print STDERR "novaboot: Switching the target off...\n";
927 &$target_power_off();
931 $builddir ||= dirname(File::Spec->rel2abs( ${$scripts[0]}{filename})) if scalar @scripts;
932 if (defined $builddir) {
933 chdir($builddir) or die "Can't change directory to $builddir: $!";
934 print STDERR "novaboot: Entering directory `$builddir'\n";
936 $builddir = $invocation_dir;
939 ## File generation phase
940 my (%files_iso, $menu_iso, $filename);
941 my $config_name = '';
944 foreach my $script (@scripts) {
945 $filename = $$script{filename};
946 $modules = $$script{modules};
947 $generated = $$script{generated};
948 $variables = $$script{variables};
950 ($config_name = $filename) =~ s#.*/##;
951 $config_name = $config_name_opt if (defined $config_name_opt);
953 if (exists $variables->{BUILDDIR}) {
954 $builddir = File::Spec->rel2abs($variables->{BUILDDIR});
955 chdir($builddir) or die "Can't change directory to $builddir: $!";
956 print STDERR "novaboot: Entering directory `$builddir'\n";
960 $prefix = $grub_prefix;
961 $prefix =~ s/\$NAME/$config_name/;
962 $prefix =~ s/\$BUILDDIR/$builddir/;
964 # TODO: use $grub_prefix as first parameter if some switch is given
965 generate_configs('', $generated, $filename);
967 ### Generate bootloader configuration files
968 my @bootloader_configs;
969 push @bootloader_configs, generate_grub_config($grub_config, $config_name, $prefix, $modules, $grub_preamble) if (defined $grub_config);
970 push @bootloader_configs, generate_grub2_config($grub2_config, $config_name, $prefix, $modules, $grub_preamble, $grub2_prolog) if (defined $grub2_config);
971 push @bootloader_configs, generate_pulsar_config('config-'.($pulsar||'novaboot'), $modules, $chainload) if (defined $pulsar);
973 ### Run scons or make
976 push @all, @$modules;
978 push @all, @$chainload;
979 my @files = map({ ($file) = m/([^ ]*)/; $file; } @all);
981 # Filter-out generated files
982 my @to_build = grep({ my $file = $_; !scalar(grep($file eq ($$_{filename} || ''), @$generated)) } @files);
984 system_verbose($scons || $CFG::scons." ".join(" ", @to_build)) if (defined $scons);
985 system_verbose($make || $CFG::make ." ".join(" ", @to_build)) if (defined $make);
988 ### Copy files (using rsync)
989 if (defined $server && !defined($gen_only)) {
990 (my $real_server = $server) =~ s/\$NAME/$config_name/;
992 my ($hostname, $path) = split(":", $real_server, 2);
993 if (! defined $path) {
997 my $files = join(" ", map({ ($file) = m/([^ ]*)/; $file; } ( @$modules, @bootloader_configs, @$copy)));
998 map({ my $file = (split)[0]; die "Not a file: $file: $!" if ! -e $file || -d $file; } @$modules);
999 my $istty = -t STDOUT && ($ENV{'TERM'} || 'dumb') ne 'dumb';
1000 my $progress = $istty ? "--progress" : "";
1002 system_verbose("rsync $progress -RLp $rsync_flags $files $real_server");
1003 if ($server =~ m|/\$NAME$| && $concat) {
1004 my $cmd = join("; ", map { "( cd $path/.. && cat */$_ > $_ )" } @bootloader_configs);
1005 system_verbose($hostname ? "ssh $hostname '$cmd'" : $cmd);
1010 ### Prepare ISO image generation
1011 if (defined $iso_image) {
1012 generate_configs("(cd)", $generated, $filename);
1014 generate_syslinux_config(\$menu, $config_name, "/", $modules);
1015 $menu_iso .= "$menu\n";
1016 map { ($file,undef) = split; $files_iso{$file} = 1; } @$modules;
1020 ## Generate ISO image
1021 if (defined $iso_image) {
1022 system_verbose("mkdir -p isolinux");
1025 if (-f '/usr/lib/ISOLINUX/isolinux.bin') {
1026 # Newer ISOLINUX version
1027 @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);
1029 # Older ISOLINUX version
1030 @files = qw(/usr/lib/syslinux/isolinux.bin /usr/lib/syslinux/mboot.c32 /usr/lib/syslinux/menu.c32);
1032 system_verbose("cp @files isolinux");
1033 open(my $fh, ">isolinux/isolinux.cfg");
1035 print $fh "TIMEOUT 50\n";
1036 print $fh "DEFAULT menu\n";
1038 print $fh "DEFAULT $config_name\n";
1040 print $fh "$menu_iso";
1043 my $files = join(" ", map("$_=$_", (keys(%files_iso), 'isolinux/isolinux.cfg', map(s|.*/|isolinux/|r, @files))));
1044 $iso_image ||= "$config_name.iso";
1046 # Note: We use -U flag below to "Allow 'untranslated' filenames,
1047 # completely violating the ISO9660 standards". Without this
1048 # option, isolinux is not able to read files names for example
1050 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");
1051 print("ISO image created: $builddir/$iso_image\n");
1054 exit(0) if defined $gen_only;
1056 ## Boot the system using various methods and send serial output to stdout
1058 if (scalar(@scripts) > 1 && ( defined $dhcp_tftp || defined $serial || defined $iprelay)) {
1059 die "You cannot do this with multiple scripts simultaneously";
1062 if ($variables->{WVTEST_TIMEOUT}) {
1063 print STDERR "wvtest: timeout ", $variables->{WVTEST_TIMEOUT}, "\n";
1068 if (defined $qemu) {
1070 $qemu ||= $variables->{QEMU} || $CFG::qemu;
1071 my @qemu_flags = split(" ", $qemu);
1072 $qemu = shift(@qemu_flags);
1074 @qemu_flags = split(/ +/, trim($variables->{QEMU_FLAGS})) if exists $variables->{QEMU_FLAGS};
1075 @qemu_flags = split(/ +/, trim($qemu_flags_cmd)) if $qemu_flags_cmd;
1076 push(@qemu_flags, split(/ +/, trim($qemu_append || '')));
1078 if (defined $iso_image) {
1079 # Boot NOVA with grub (and test the iso image)
1080 push(@qemu_flags, ('-cdrom', $iso_image));
1082 # Boot NOVA without GRUB
1084 # Non-patched qemu doesn't like commas, but NUL can live with pluses instead of commans
1085 foreach (@$modules) {s/,/+/g;}
1086 generate_configs("", $generated, $filename);
1088 if (scalar @$modules) {
1089 my ($kbin, $kcmd) = split(' ', shift(@$modules), 2);
1090 $kcmd = '' if !defined $kcmd;
1092 @$modules = map { if (/\.dtb$/) { $dtb=$_; (); } else { $_ } } @$modules;
1093 my $initrd = join ",", @$modules;
1095 push(@qemu_flags, ('-kernel', $kbin, '-append', $kcmd));
1096 push(@qemu_flags, ('-initrd', $initrd)) if $initrd;
1097 push(@qemu_flags, ('-dtb', $dtb)) if $dtb;
1100 if (!grep /^-serial$/, @qemu_flags) {
1101 push(@qemu_flags, qw(-serial stdio)); # Redirect serial output (for collecting test restuls)
1103 unshift(@qemu_flags, ('-name', $config_name));
1104 print STDERR "novaboot: Running: ".shell_cmd_string($qemu, @qemu_flags)."\n";
1105 $exp = Expect->spawn(($qemu, @qemu_flags)) || die("exec() failed: $!");
1108 ### Local DHCPD and TFTPD
1110 my ($dhcpd_pid, $tftpd_pid);
1112 $tftp=1 if $tftp_port;
1114 if (defined $dhcp_tftp)
1116 generate_configs("(nd)", $generated, $filename);
1117 system_verbose('mkdir -p tftpboot');
1118 generate_grub_config("tftpboot/os-menu.lst", $config_name, "(nd)", \@$modules, "timeout 0");
1119 open(my $fh, '>', 'dhcpd.conf');
1120 my $mac = `cat /sys/class/net/$netif/address`;
1122 print $fh "subnet 10.23.23.0 netmask 255.255.255.0 {
1123 range 10.23.23.10 10.23.23.100;
1124 filename \"bin/boot/grub/pxegrub.pxe\";
1125 next-server 10.23.23.1;
1128 hardware ethernet $mac;
1129 fixed-address 10.23.23.1;
1132 system_verbose("sudo ip a add 10.23.23.1/24 dev $netif;
1133 sudo ip l set dev $netif up;
1134 sudo touch dhcpd.leases");
1136 # We run servers by forking ourselves, because the servers end up
1137 # in our process group and get killed by signals sent to the
1138 # process group (e.g. Ctrl-C on terminal).
1139 $dhcpd_pid = fork();
1140 exec_verbose("sudo dhcpd -d -cf dhcpd.conf -lf dhcpd.leases -pf dhcpd.pid") if ($dhcpd_pid == 0);
1143 if (defined $dhcp_tftp || defined $tftp) {
1145 # Unfortunately, tftpd requires root privileges even with
1146 # non-privileged (>1023) port due to initgroups().
1147 system_verbose("sudo in.tftpd --listen --secure -v -v -v --pidfile tftpd.pid --address :$tftp_port $builddir");
1149 # Kill server when we die
1150 $SIG{__DIE__} = sub { system_verbose('sudo pkill --pidfile=dhcpd.pid') if (defined $dhcp_tftp);
1151 system_verbose('sudo pkill --pidfile=tftpd.pid'); };
1153 # We have to kill tftpd explicitely, because it is not in our process group
1154 $SIG{INT} = sub { system_verbose('sudo pkill --pidfile=tftpd.pid'); exit(0); };
1158 if (defined $ider) {
1159 my $ider_cmd= "amtider -c $iso_image -u $amt_user -p $amt_password $amt_host $amt_port" ;
1160 print STDERR "novaboot: Running: $ider_cmd\n" =~ s/\Q$amt_password\E/???/r;
1161 my $ider_pid = fork();
1162 if ($ider_pid == 0) {
1164 die "IDE redirection failed";
1166 # FIXME: This collides with --tftp option. Hopefully, nobody needs
1167 # to use both simultaneously.
1168 $SIG{__DIE__} = sub { system_verbose('kill $ider_pid'); };
1171 ### Reset target (IP relay, AMT, ...)
1173 if (defined $target_reset && $reset) {
1174 print STDERR "novaboot: Resetting the test box... ";
1176 print STDERR "done\n";
1178 # We don't want to output anything printed by the target
1179 # before reset so we clear the buffers now. This is, however,
1180 # not ideal because we may loose some data that were sent
1181 # after the reset. If this is a problem, one should reset and
1182 # connect to serial line in atomic manner. For example, if
1183 # supported by hardware, use --remote-cmd 'sterm -d ...' and
1184 # do not use separate --reset-cmd.
1185 my $log = $exp->log_stdout;
1186 $exp->log_stdout(0);
1187 $exp->expect(0); # Read data from target
1188 $exp->clear_accum(); # Clear the read data
1189 $exp->log_stdout($log);
1193 ### U-boot conversation
1194 if (defined $uboot) {
1195 my $uboot_prompt = $uboot || '=> ';
1196 print STDERR "novaboot: Waiting for U-Boot prompt...\n";
1197 $exp || die("No serial line connection");
1198 $exp->log_stdout(1);
1199 #$exp->exp_internal(1);
1201 [qr/Hit any key to stop autoboot:/, sub {
1202 $exp->send($uboot_stop_key // "\n");
1204 $uboot_prompt) || die "No U-Boot prompt deteceted";
1205 foreach my $cmdspec (@uboot_init) {
1206 my ($cmd, $timeout);
1207 die "Internal error - please report a bug" unless ref($cmdspec) eq "HASH";
1209 if ($cmdspec->{system}) {
1210 $cmd = `$cmdspec->{system}`;
1212 $cmd = $cmdspec->{command};
1214 $timeout = $cmdspec->{timeout} // 10;
1216 if ($cmd =~ /\$NB_MYIP/) {
1217 my $ip = (grep /inet /, `ip addr show $netif`)[0] || die "Problem determining IP address of $netif";
1218 $ip =~ s/\s*inet ([0-9.]*).*/$1/;
1219 $cmd =~ s/\$NB_MYIP/$ip/g;
1221 if ($cmd =~ /\$NB_PREFIX/) {
1224 $cmd =~ s/\$NB_PREFIX/$p/g;
1227 $exp->send("$cmd\n");
1229 my ($matched_pattern_position, $error,
1230 $successfully_matching_string,
1231 $before_match, $after_match) =
1232 $exp->expect($timeout, $uboot_prompt);
1233 die "No U-Boot prompt: $error" if $error;
1235 if ($cmdspec->{dest}) {
1236 open(my $fh, ">", $cmdspec->{dest}) or die "Cannot open '$cmdspec->{dest}': $!";
1237 print $fh $before_match;
1242 # Load files if there are some load lines in the script
1243 if (scalar(@$modules) > 0 && !$variables->{NO_BOOT}) {
1244 my ($kbin, $kcmd) = split(' ', shift(@$modules), 2);
1246 @$modules = map { if (/\.dtb$/) { $dtb=$_; (); } else { $_ } } @$modules;
1247 my $initrd = shift @$modules;
1249 if (defined $kbin && $kbin ne '/dev/null') {
1250 die "No '--uboot-addr kernel' given" unless $uboot_addr{kernel};
1251 $exp->send("tftpboot $uboot_addr{kernel} $prefix$kbin\n");
1253 [qr/##/, sub { exp_continue; }],
1254 $uboot_prompt) || die "Kernel load: " . ($! || "timeout");
1257 die "No '--uboot-addr fdt' given" unless $uboot_addr{fdt};
1258 $exp->send("tftpboot $uboot_addr{fdt} $prefix$dtb\n");
1260 [qr/##/, sub { exp_continue; }],
1261 $uboot_prompt) || die "Device tree load: " . ($! || "timeout");
1263 $uboot_addr{fdt} = '';
1265 if (defined $initrd) {
1266 die "No '--uboot-addr ramdisk' given" unless $uboot_addr{ramdisk};
1267 $exp->send("tftpboot $uboot_addr{ramdisk} $prefix$initrd\n");
1269 [qr/##/, sub { exp_continue; }],
1270 $uboot_prompt) || die "Initrd load: " . ($! || "timeout");
1272 $uboot_addr{ramdisk} = '-';
1276 $exp->send("setenv bootargs $kcmd\n");
1277 $exp->expect(5, $uboot_prompt) || die "U-Boot prompt: " . ($! || "timeout");
1280 $uboot_cmd //= $variables->{UBOOT_CMD} // 'bootm $kernel_addr $ramdisk_addr $fdt_addr';
1281 if (!$variables->{NO_BOOT} && $uboot_cmd ne '') {
1282 $uboot_cmd =~ s/\$kernel_addr/$uboot_addr{kernel}/g;
1283 $uboot_cmd =~ s/\$ramdisk_addr/$uboot_addr{ramdisk}/g;
1284 $uboot_cmd =~ s/\$fdt_addr/$uboot_addr{fdt}/g;
1286 $exp->send($uboot_cmd . "\n");
1287 $exp->expect(5, "\n") || die "U-Boot command: " . ($! || "timeout");
1291 ### Serial line interaction
1292 if ($interaction && defined $exp) {
1293 # Serial line of the target is available
1294 my $interrupt = 'Ctrl-C';
1295 if ($interactive && !@exiton) {
1296 $interrupt = '"~~."';
1298 print STDERR "novaboot: Serial line interaction (press $interrupt to interrupt)...\n";
1299 $exp->log_stdout(1);
1301 $exp->expect($exiton_timeout, @expect_raw, @exiton) || die("exiton: " . ($! || "timeout"));
1303 my @inputs = ($exp);
1304 my $infile = new IO::File;
1305 $infile->IO::File::fdopen(*STDIN,'r');
1306 my $in_object = Expect->exp_init($infile);
1307 $in_object->set_group($exp);
1310 $in_object->set_seq('~~\.', sub { print STDERR "novaboot: Escape sequence detected\r\n"; undef; });
1311 $in_object->manual_stty(0); # Use raw terminal mode
1313 $in_object->manual_stty(1); # Do not modify terminal settings
1315 push(@inputs, $in_object);
1317 #print Dumper(\@expect_raw);
1318 $exp->expect(undef, @expect_raw) if @expect_raw;
1320 $^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.
1321 Expect::interconnect(@inputs) unless defined($exp->exitstatus);
1326 # When exp-spawned command ignores SIGHUP, Expect waits 5 seconds
1327 # before killing it. We kill it by SIGTERM immediately.
1328 kill TERM => $exp->pid if defined $exp && $exp->pid;
1330 ## Kill dhcpc or tftpd
1331 if (defined $dhcp_tftp || defined $tftp) {
1332 die("novaboot: This should kill servers on background\n");
1335 # Always finish novaboot output with newline
1336 print "\n" if $final_eol;
1344 novaboot - Boots a locally compiled operating system on a remote
1351 B<novaboot> [option]... [--] script...
1353 B<./script> [option]...
1357 Novaboot makes booting of a locally compiled operating system (OS)
1358 (e.g. NOVA or Linux) on remote targets as simple as running a program
1359 locally. It automates things like copying OS images to a TFTP server,
1360 generation of bootloader configuration files, resetting of target
1361 hardware or redirection of target's serial line to stdin/out. Novaboot
1362 is highly configurable and makes it easy to boot a single image on
1363 different targets or different images on a single target.
1365 Novaboot operation is controlled by configuration files, command line
1366 options and by a so-called novaboot script, which can be thought as a
1367 generalization of bootloader configuration files (see L</"NOVABOOT
1368 SCRIPT SYNTAX">). The typical way of using novaboot is to make the
1369 novaboot script executable and set its first line to I<#!/usr/bin/env
1370 novaboot>. Then, booting a particular OS configuration becomes the
1371 same as executing a local program – the novaboot script.
1373 Novaboot uses configuration files to, among other things, define
1374 command line options needed for different targets. Users typically use
1375 only the B<-t>/B<--target> command line option to select the target.
1376 Internally, this option expands to the pre-configured options.
1377 Novaboot searches configuration files at multiple places, which allows
1378 having per-system, per-user or per-project configurations.
1379 Configuration file syntax is described in section L</"CONFIGURATION
1382 Novaboot newcomers may be confused by a large number of configuration
1383 options. Understanding all these options is not always needed,
1384 depending on the used setup. The L<figure from the doc directory
1385 |https://github.com/wentasah/novaboot/blob/master/doc/typical-setups.svg>
1386 shows different setups that vary in how much effort is needed
1387 configure novaboot for them. The setups are:
1391 =item A: Laptop and target device only
1393 This requires to configure everything on the laptop side, including a
1394 serial line connection (L</--serial>, L</--remote-cmd>, ...), power
1395 on/off/reset commands (L</--reset-cmd>, ...), TFTP server
1396 (L</--server>, L</--prefix>...), device IP addresses, etc.
1398 =item B: Laptop, target device and external TFTP server
1400 Like the previous setup, but the TFTP (and maybe DHCP) configuration
1401 is handled by a server. Novaboot users need to understand where to
1402 copy their files to the TFTP server (L</--server>) and which IP
1403 addresses their target will get, but do not need to configure the
1406 =item C: Novaboot server running novaboot-shell
1408 With this setup, the configuration is done on the server. Users only
1409 need to know the SSH account (L</--ssh>) used to communicate between
1410 novaboot and novaboot server. The server is implemented as a
1411 restricted shell (L<novaboot-shell(1)>) on the server. No need to give
1412 full shell access to novaboot users on the server.
1416 =head2 Simple examples of using C<novaboot>:
1418 To boot Linux (files F<bzImage> and F<rootfs.cpio> in current
1419 directory), create F<mylinux> file with this content:
1421 #!/usr/bin/env novaboot
1422 load bzImage console=ttyS0,115200
1429 Booting an OS in Qemu can be accomplished by giving the B<--qemu> option.
1432 novaboot --qemu mylinux
1434 (or C<./mylinux --qemu> as described above) will run Qemu and make it
1435 boot the configuration specified in the F<mylinux> script. How is qemu
1436 started can be configured in various ways (see below).
1440 Create a bootloader configuration file (currently supported
1441 bootloaders are GRUB, GRUB2, ISOLINUX, Pulsar, and U-Boot) and copy it
1442 with all other files needed for booting to a remote TFTP server. Then
1443 use a TCP/IP-controlled relay/serial-to-TCP converter to reset the
1444 target and receive its serial output.
1446 ./mylinux --grub2 --server=192.168.1.1:/tftp --iprelay=192.168.1.2
1448 Alternatively, you can put these switches to the configuration file
1451 ./mylinux --target mytarget
1455 Specifying all the options needed by novaboot to successfully control
1456 the target, either on command line or in configuration files, can be
1457 difficult for users. Novaboot supports configuring the target
1458 centrally via L<novaboot-shell(1)> on a server. With such a
1459 configuration, users only need to use the B<--ssh> option to specify
1460 where to boot their OS:
1462 ./mylinux --ssh myboard@example.com
1464 Typically, the server is the computer connected to and controlling the
1465 target board and running the TFTP server.
1469 Run DHCP and TFTP server on developer's machine to boot the target
1472 ./mylinux --dhcp-tftp
1474 This usage is useful when no network infrastructure is in place, and
1475 the target is connected directly to developer's box.
1479 Create bootable ISO image.
1481 novaboot --iso -- script1 script2
1483 The created ISO image will have ISOLINUX bootloader installed on it,
1484 and the boot menu will allow selecting between I<script1> and
1485 I<script2> configurations.
1489 =head1 PHASES AND OPTIONS
1491 Novaboot performs its work in several phases. Command line options
1492 described bellow influence the execution of each phase or allow their
1493 skipping. The list of phases (in the execution order) is as follows.
1497 =item 1. L<Configuration reading|/Configuration reading phase>
1499 =item 2. L<Command line processing|/Command line processing phase>
1501 =item 3. L<Script preprocessing|/Script preprocessing phase>
1503 =item 4. L<File generation|/File generation phase>
1505 =item 5. L<Target connection|/Target connection check>
1507 =item 6. L<File deployment|/File deployment phase>
1509 =item 7. L<Target power-on and reset|/Target power-on and reset phase>
1511 =item 8. L<Interaction with the bootloader|/Interaction with the bootloader on the target>
1513 =item 9. L<Target interaction|/Target interaction phase>
1517 Each phase is described in the following sections together with the
1518 command line options that control it.
1520 =head2 Configuration reading phase
1522 After starting, novaboot reads zero or more configuration files. We
1523 describe their content in section L</"CONFIGURATION FILES">. By default, the
1524 configuration is read from multiple locations. First from the system
1525 configuration directory (F</etc/novaboot.d/>), second from the user
1526 configuration file (F<~/.config/novaboot>) and third from F<.novaboot>
1527 files along the path to the current directory. Alternatively, a single
1528 configuration file specified with the B<-c> switch or with the
1529 C<NOVABOOT_CONFIG> environment variable is read. The latter read files
1530 override settings from the former ones.
1532 The system configuration directory is determined by the content of
1533 NOVABOOT_CONFIG_DIR environment variable and defaults to
1534 F</etc/novaboot.d>. Files in this directory with names consisting
1535 solely of English letters, numbers, dashes '-' and underscores '_'
1536 (note that dot '.' is not included) are read in alphabetical order.
1538 Then, the user configuration file is read from
1539 F<$XDG_CONFIG_HOME/novaboot>. If C<$XDG_CONFIG_HOME> environment
1540 variable is not set F<~/.config/novaboot> is read instead.
1542 Finally, novaboot searches for files named F<.novaboot> starting from the
1543 directory of the novaboot script (or working directory, see bellow)
1544 and continuing upwards up to the root directory. The found
1545 configuration files are then read in the opposite order (i.e. from the
1546 root directory downwards). This ordering allows having, for example, a project
1547 specific configuration in F<~/project/.novaboot>.
1549 Note the difference between F<~/.config/novaboot> and F<~/.novaboot>.
1550 The former one is always read, whereas the latter only when novaboot
1551 script or working directory is under the C<$HOME> directory.
1553 In certain cases, the location of the novaboot script cannot be
1554 determined in this early phase. This situation happens either when the script is
1555 read from the standard input or when novaboot is invoked explicitly as
1556 in the example L</"4."> above. In this case, the current working
1557 directory is used as a starting point for configuration file search
1558 instead of the novaboot script directory.
1562 =item -c, --config=I<filename>
1564 Use the specified configuration file instead of the default one(s).
1568 =head2 Command line processing phase
1574 Dump the current configuration to stdout end exit. Useful as an
1575 initial template for a configuration file.
1579 Print short (B<-h>) or long (B<--help>) help.
1581 =item -t, --target=I<target>
1583 This option serves as a user configurable shortcut for other novaboot
1584 options. The effect of this option is the same as specifying the
1585 options stored in the C<%targets> configuration variable under key
1586 I<target>. See also L</"CONFIGURATION FILES">.
1588 When this option is not given, novaboot tries to determine the target
1589 to use from either B<NOVABOOT_TARGET> environment variable or
1590 B<$default_target> configuration file variable.
1592 =item --ssh=I<user@hostname>
1594 Configures novaboot to control the target via C<novaboot-shell>
1595 running remotely via SSH.
1597 Using this option is the same as specifying B<--remote-cmd>,
1598 B<--remote-expect>, B<--server> B<--rsync-flags>, B<--prefix> and
1599 B<--reset-cmd> manually in a way compatible with C<novaboot-shell>.
1600 The server can be configured to provide other, safe bootloader-related
1601 options, to the client. When this happens, novaboot prints them to
1604 Currently, this in an initial experimental implementation. We plan to
1605 change/extend this feature soon!
1609 =head2 Script preprocessing phase
1611 This phase allows modifying the parsed novaboot script before it is
1612 used in the later phases.
1616 =item -a, --append=I<parameters>
1618 Append a string to the first C<load> line in the novaboot script. This option
1619 can be used to append parameters to the kernel's or root task's
1620 command line. This option can appear multiple times.
1624 Use L<Bender|https://github.com/TUD-OS/morbo/blob/master/standalone/bender.c>
1625 chainloader. Bender scans the PCI bus for PCI serial ports and stores
1626 the information about them in the BIOS data area for use by the
1629 =item --chainloader=I<chainloader>
1631 Specifies a chainloader that is loaded before the kernel and other
1632 files specified in the novaboot script. E.g. 'bin/boot/bender
1637 Print the modules to boot and their parameters, after this phase
1638 finishes. Then exit. This is useful for seeing the effect of other
1639 options in this section.
1641 =item -k, --kernel=F<file>
1643 Replace the first word on the first C<load> line in the novaboot
1644 script with F<file>.
1646 =item --scriptmod=I<Perl expression>
1648 When novaboot reads the script, I<Perl expression> is executed for every
1649 line (in $_ variable). For example, C<novaboot
1650 --scriptmod=s/sigma0/omega6/g> replaces every occurrence of I<sigma0>
1651 in the script with I<omega6>.
1653 When this option is present, it overrides I<$script_modifier> variable
1654 from the configuration file, which has the same effect. If this option
1655 is given multiple times all expressions are evaluated in the command
1660 =head2 File generation phase
1662 In this phase, files needed for booting are generated in a so-called
1663 I<build directory> (see L</--build-dir>). In most cases configuration
1664 for a bootloader is generated automatically by novaboot. It is also
1665 possible to generate other files using I<heredoc> or I<"<"> syntax in
1666 novaboot scripts. Finally, novaboot can generate binaries in this phases by
1667 running C<scons> or C<make>.
1671 =item --build-dir=I<directory>
1673 Overrides the default build directory location.
1675 The default build directory location is determined as follows: If the
1676 configuration file defines the C<$builddir> variable, its value is
1677 used. Otherwise, it is the directory that contains the first processed
1680 See also L</BUILDDIR> variable.
1682 =item -g, --grub[=I<filename>]
1684 Generates grub bootloader menu file. If the I<filename> is not
1685 specified, F<menu.lst> is used. The I<filename> is relative to the
1686 build directory (see B<--build-dir>).
1688 =item --grub-preamble=I<prefix>
1690 Specifies the I<preamble> that is at the beginning of the generated
1691 GRUB or GRUB2 config files. This is useful for specifying GRUB's
1694 =item --prefix=I<prefix>
1696 Specifies I<prefix> (e.g. F</srv/tftp>) that is put in front of every
1697 filename in generated bootloader configuration files (or in U-Boot
1700 If the I<prefix> contains string $NAME, it will be replaced with the
1701 name of the novaboot script (see also B<--name>).
1703 If the I<prefix> contains string $BUILDDIR, it will be replaced with
1704 the build directory (see also B<--build-dir>).
1708 Alias for B<--prefix>.
1710 =item --grub2[=I<filename>]
1712 Generate GRUB2 menu entry in I<filename>. If I<filename> is not
1713 specified F<grub.cfg> is used. The content of the menu entry can be
1714 customized with B<--grub-preamble>, B<--grub2-prolog> or
1715 B<--grub_prefix> options.
1717 To use the generated menu entry on your development
1718 machine that uses GRUB2, append the following snippet to
1719 F</etc/grub.d/40_custom> file and regenerate your grub configuration,
1720 i.e. run update-grub on Debian/Ubuntu.
1722 if [ -f /path/to/nul/build/grub.cfg ]; then
1723 source /path/to/nul/build/grub.cfg
1726 =item --grub2-prolog=I<prolog>
1728 Specifies the text that novaboot puts at the beginning of the GRUB2 menu entry.
1730 =item -m, --make[=make command]
1732 Runs C<make> to build files that are not generated by novaboot itself.
1734 =item --name=I<string>
1736 Use the name I<string> instead of the name of the novaboot script.
1737 This name is used for things like a title of grub menu or for the
1738 server directory where the boot files are copied to.
1742 Do not run external commands to generate files (i.e. "<" syntax and
1743 C<run> keyword). This switch does not influence the generation of files
1744 specified with "<<WORD" syntax.
1746 =item -p, --pulsar[=mac]
1748 Generates pulsar bootloader configuration file named F<config-I<mac>>
1749 The I<mac> string is typically a MAC address and defaults to
1752 =item --scons[=scons command]
1754 Runs C<scons> to build files that are not generated by novaboot
1759 Strip I<rom://> prefix from command lines and generated config files.
1760 The I<rom://> prefix is used by NUL. For NRE, it has to be stripped.
1764 Exit novaboot after file generation phase.
1768 =head2 Target connection check
1770 In this phase novaboot connects to target's serial port (if it has
1771 one). If another novaboot user/instance occupies the target, novaboot
1772 exits here with an error message.
1776 =item --amt=I<"[user[:password]@]host[:port]>
1778 Use Intel AMT technology to control the target machine. WS management
1779 is used to powercycle it and Serial-Over-Lan (SOL) for input/output.
1780 The hostname or (IP address) is given by the I<host> parameter. If the
1781 I<password> is not specified, environment variable AMT_PASSWORD is
1782 used. The I<port> specifies a TCP port for SOL. If not specified, the
1783 default is 16992. The default I<user> is admin.
1785 =item --iprelay=I<addr[:port]>
1787 Use TCP/IP relay and serial port to access the target's serial port
1788 and powercycle it. The I<addr> parameter specifies the IP address of
1789 the relay. If I<port> is not specified, it defaults to 23.
1791 Note: This option is supposed to work with HWG-ER02a IP relays.
1793 =item --iprelay-cmd=I<command>
1795 Similar to B<--iprelay> but uses I<command> to talk to the iprelay
1796 rather than direct network connection.
1798 =item -s, --serial[=device]
1800 Target's serial line is connected to host's serial line (device). The
1801 default value for device is F</dev/ttyUSB0>.
1803 The value of this option is exported in NB_NOVABOOT environment
1804 variable to all subprocesses run by C<novaboot>.
1806 =item --stty=I<settings>
1808 Specifies settings passed to C<stty> invoked on the serial line
1809 specified with B<--serial> option. If this option is not given,
1810 C<stty> is called with C<raw -crtscts -onlcr 115200> settings.
1812 =item --remote-cmd=I<cmd>
1814 Command that mediates connection to the target's serial line. For
1815 example C<ssh server 'cu -l /dev/ttyS0'>.
1817 =item --remote-expect=I<string>
1819 Wait for reception of I<string> after establishing the remote serial
1820 line connection. Novaboot assumes that after establishing the serial
1821 line connection, the user running novaboot has exclusive access to the
1822 target. If establishing of the serial line connection happens
1823 asynchronously (e.g. running a command remotely via SSH), we need this
1824 option to wait until the exclusive access is confirmed by the remote
1827 Depending on target configuration, this option can solve two practical
1828 problems: 1) Overwriting of files deployed by another user currently
1829 using the target. 2) Resetting the target board before serial line
1830 connection is established and thus missing bootloader interaction.
1832 Example of usage with the L<sterm
1833 tool|https://rtime.felk.cvut.cz/gitweb/sojka/sterm.git>:
1835 --remote-cmd='ssh -tt example.com sterm -v /dev/ttyUSB0' --remote-expect='sterm: Connected'
1837 =item --remote-expect-silent=I<string>
1839 The same as B<--remote-expect> except that the remote output is not
1840 echoed to stdout while waiting for the I<string>. Everything after the
1841 matched string is printed to stdout, so you may want to include line
1842 end characters in the I<string> as well.
1844 =item --remote-expect-timeout=I<seconds>
1846 Timeout in seconds for B<--remote-expect> or
1847 B<--remote-expect-seconds>. When negative, waits forever. The default
1852 =head2 File deployment phase
1854 In some setups, it is necessary to copy the files needed for booting
1855 to a particular location, e.g. to a TFTP boot server or to the
1860 =item -d, --dhcp-tftp
1862 Turns your workstation into a DHCP and TFTP server so that the OS can
1863 be booted via PXE BIOS (or similar mechanism) on the test machine
1864 directly connected by a plain Ethernet cable to your workstation.
1866 The DHCP and TFTP servers require root privileges and C<novaboot>
1867 uses C<sudo> command to obtain those. You can put the following to
1868 I</etc/sudoers> to allow running the necessary commands without asking
1871 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
1872 your_login ALL=NOPASSWD: NOVABOOT
1876 Starts a TFTP server on your workstation. This is similar to
1877 B<--dhcp-tftp> except that DHCP server is not started.
1879 The TFTP server requires root privileges and C<novaboot> uses C<sudo>
1880 command to obtain those. You can put the following to I</etc/sudoers>
1881 to allow running the necessary commands without asking for a password.
1883 Cmnd_Alias NOVABOOT = /usr/sbin/in.tftpd --listen --secure -v -v -v --pidfile tftpd.pid *, /usr/bin/pkill --pidfile=tftpd.pid
1884 your_login ALL=NOPASSWD: NOVABOOT
1886 =item --tftp-port=I<port>
1888 Port to run the TFTP server on. Implies B<--tftp>.
1890 =item --netif=I<network interface>
1892 Network interface used to deploy files to the target. The default value is
1893 I<eth0>. This option influences the configuration of the DHCP server started
1894 by B<--dhcp-tftp> and the value that B<$NB_MYIP> get replaced with during
1895 U-Boot conversation.
1897 =item --iso[=filename]
1899 Generates the ISO image that boots NOVA system via GRUB. If no filename
1900 is given, the image is stored under I<NAME>.iso, where I<NAME> is the name
1901 of the novaboot script (see also B<--name>).
1903 =item --server[=[[user@]server:]path]
1905 Copy all files needed for booting to another location. The files will
1906 be copied (by B<rsync> tool) to the directory I<path>. If the I<path>
1907 contains string $NAME, it will be replaced with the name of the
1908 novaboot script (see also B<--name>).
1910 =item --rsync-flags=I<flags>
1912 Specifies I<flags> to append to F<rsync> command line when
1913 copying files as a result of I<--server> option.
1917 If B<--server> is used and its value ends with $NAME, then after
1918 copying the files, a new bootloader configuration file (e.g. menu.lst)
1919 is created at I<path-wo-name>, i.e. the path specified by B<--server>
1920 with $NAME part removed. The content of the file is created by
1921 concatenating all files of the same name from all subdirectories of
1922 I<path-wo-name> found on the "server".
1926 Use Intel AMT technology for IDE redirection. This allows the target
1927 machine to boot from novaboot created ISO image. Implies B<--iso>.
1929 The experimental C<amtider> utility needed by this option can be
1930 obtained from https://github.com/wentasah/amtterm.
1934 =head2 Target power-on and reset phase
1936 At this point, the target is reset (or switched on/off). There are
1937 several ways how this can be accomplished. Resetting a physical target
1938 can currently be accomplished by the following options: B<--amt>,
1939 B<--iprelay>, B<--reset-cmd> and B<--reset-send>.
1945 Switch on/off the target machine and exit. The script (if any) is
1946 completely ignored. Currently, it works only with the following
1947 options: B<--iprelay>, B<--amt>, B<--ssh>.
1949 =item -Q, --qemu[=I<qemu-binary>]
1951 Boot the configuration in qemu. Optionally, the name of qemu binary
1952 can be specified as a parameter.
1954 =item --qemu-append=I<flags>
1956 Append I<flags> to the default qemu flags (QEMU_FLAGS variable or
1957 C<-cpu coreduo -smp 2>).
1959 =item -q, --qemu-flags=I<flags>
1961 Replace the default qemu flags (QEMU_FLAGS variable or C<-cpu coreduo
1962 -smp 2>) with I<flags> specified here.
1964 =item --reset-cmd=I<cmd>
1966 Runs command I<cmd> to reset the target.
1968 =item --reset-send=I<string>
1970 Reset the target by sending the given I<string> to the remote serial
1971 line. "\n" sequences are replaced with the newline character.
1973 =item --no-reset, --reset
1975 Disable/enable resetting of the target.
1979 =head2 Interaction with the bootloader on the target
1983 =item --uboot[=I<prompt>]
1985 Interact with U-Boot bootloader to boot the thing described in the
1986 novaboot script. I<prompt> specifies the U-Boot's prompt (default is
1987 "=> ", other common prompts are "U-Boot> " or "U-Boot# ").
1991 Disable U-Boot interaction previously enabled with B<--uboot>.
1993 =item --uboot-stop-key=I<key>
1995 Character, which is sent as a response to U-Boot's "Hit any key to
1996 stop autoboot" message. The default value is newline, but some devices
1997 (e.g. TP-Link TD-W8970) require a specific key to be pressed.
2001 Command(s) to send the U-Boot bootloader before loading the images and
2002 booting them. This option can be given multiple times. After sending
2003 commands from each option novaboot waits for U-Boot I<prompt>.
2005 If the command contains string I<$NB_MYIP> then this string is
2006 replaced by IPv4 address of eth0 interface (see also B<--netif>).
2007 Similarly, I<$NB_PREFIX> is replaced with prefix given by B<--prefix>.
2009 See also C<uboot> keyword in L</"NOVABOOT SCRIPT SYNTAX">).
2011 =item --uboot-addr I<name>=I<address>
2013 Load address of U-Boot's C<tftpboot> command for loading I<name>,
2014 where name is one of I<kernel>, I<ramdisk> or I<fdt> (flattened device
2017 The default addresses are ${I<name>_addr_r}, i.e. U-Boot environment
2018 variables used by convention for this purpose.
2020 =item --uboot-cmd=I<command>
2022 Specifies U-Boot command used to execute the OS. If the command
2023 contains strings C<$kernel_addr>, C<$ramdisk_addr>, C<$fdt_addr>,
2024 these are replaced with the addresses configured with B<--uboot-addr>.
2026 The default value is
2028 bootm $kernel_addr $ramdisk_addr $fdt_addr
2030 or the C<UBOOT_CMD> variable if defined in the novaboot script.
2034 =head2 Target interaction phase
2036 In this phase, target's serial output is redirected to stdout and if
2037 stdin is a TTY, it is redirected to the target's serial input allowing
2038 interactive work with the target.
2042 =item --exiton=I<string>
2044 When the I<string> is sent by the target, novaboot exits. This option can
2045 be specified multiple times, in which case novaboot exits whenever
2046 either of the specified strings is sent.
2048 If the I<string> is C<-re>, then the next B<--exiton>'s I<string> is
2049 treated as a regular expression. For example:
2051 --exiton -re --exiton 'error:.*failed'
2053 =item --exiton-re=I<regex>
2055 The same as --exiton -re --exiton I<regex>.
2057 =item --exiton-timeout=I<seconds>
2059 By default B<--exiton> waits for the string match forever. When this
2060 option is specified, "exiton" timeouts after the specified number of
2061 seconds and novaboot returns non-zero exit code.
2063 =item -i, --interactive
2065 Setup things for the interactive use of the target. Your terminal will
2066 be switched to raw mode. In raw mode, your local terminal does not
2067 process input in any way (no echoing of entered characters, no
2068 interpretation of special characters). This, among others, means that
2069 Ctrl-C is passed to the target and does not interrupt novaboot. To
2070 exit from novaboot interactive mode type "~~.".
2072 =item --no-interaction, --interaction
2074 Skip resp. force target interaction phase. When skipped, novaboot exits
2075 immediately after the boot is initiated.
2077 =item --expect=I<string>
2079 When the I<string> is received from the target, send the string specified
2080 with the subsequent B<--send*> option to the target.
2082 =item --expect-re=I<regex>
2084 When target's output matches regular expression I<regex>, send the
2085 string specified with the subsequent B<--send*> option to the target.
2087 =item --expect-raw=I<perl-code>
2089 Provides direct control over Perl's Expect module.
2091 =item --send=I<string>
2093 Send I<string> to the target after the previously specified
2094 B<--expect*> was matched in the target's output. The I<string> may
2095 contain escape sequences such as "\n".
2097 Note that I<string> is actually interpreted by Perl, so it can contain
2098 much more that escape sequences. This behavior may change in the
2101 Example: C<--expect='login: ' --send='root\n'>
2103 =item --sendcont=I<string>
2105 Similar to B<--send> but continue expecting more input.
2107 Example: C<--expect='Continue?' --sendcont='yes\n'>
2109 =item --final-eol, --no-final-eol
2111 By default, B<novaboot> always prints an end-of-line character at the
2112 end of its execution in order to ensure that the output of programs
2113 started after novaboot appears at the beginning of the line. When this
2114 is not desired B<--no-final-eol> option can be used to override this
2119 =head1 NOVABOOT SCRIPT SYNTAX
2121 The syntax tries to mimic POSIX shell syntax. The syntax is defined
2122 by the following rules.
2124 Lines starting with "#" and empty lines are ignored.
2126 Lines that end with "\" are concatenated with the following line after
2127 removal of the final "\" and leading whitespace of the following line.
2129 Lines of the form I<VARIABLE=...> (i.e. matching '^[A-Z_]+=' regular
2130 expression) assign values to internal variables. See L</VARIABLES>
2133 Otherwise, the first word on the line defines the meaning of the line.
2134 The following keywords are supported:
2140 These lines represent modules to boot. The
2141 word after C<load> is a file name (relative to the build directory
2142 (see B<--build-dir>) of the module to load and the remaining words are
2143 passed to it as the command line parameters.
2145 When the C<load> line ends with "<<WORD" then the subsequent lines
2146 until the line containing solely WORD are copied literally to the file
2147 named on that line. This is similar to shell's heredoc feature.
2149 When the C<load> line ends with "< CMD" then command CMD is executed
2150 with F</bin/sh> and its standard output is stored in the file named on
2151 that line. The SRCDIR variable in CMD's environment is set to the
2152 absolute path of the directory containing the interpreted novaboot
2157 These lines are similar to C<load> lines. The
2158 file mentioned there is copied to the same place as in the case of C<load>
2159 (e.g. tftp server), but the file is not used in the bootloader
2160 configuration. Such a file can be used by the target for other
2161 purposes than booting, e.g. at OS runtime or for firmware update.
2165 Chainload another bootloader. Instead of loading multiboot modules
2166 identified with C<load> keyword, run another bootloader. This is
2167 currently supported only by pulsar and can be used to load e.g. Grub
2168 as in the example below:
2170 chld boot/grub/i386-pc/core.0
2175 Lines starting with C<run> keyword contain shell commands that are run
2176 during file generation phase. This is the same as the "< CMD" syntax
2177 for C<load> keyboard except that the command's output is not
2178 redirected to a file. The ordering of commands is the same as they
2179 appear in the novaboot script.
2183 These lines represent U-Boot commands that are sent to the target if
2184 B<--uboot> option is given. Having a U-Boot line in the novaboot
2185 script is the same as giving B<--uboot-init> option to novaboot. The
2186 following syntax variants are supported:
2189 uboot[:<timeout>] <string> [> <file>]
2190 uboot[:<timeout>] < <shell> [> <file>]
2192 C<string> is the literal U-Boot command.
2194 The C<uboot> keyword can be suffixed with timeout specification. The
2195 syntax is C<uboot:Ns>, where C<N> is the whole number of seconds. If
2196 the U-Boot command prompt does not appear before the timeout, novaboot
2197 fails. The default timeout is 10 seconds.
2199 In the second variant with the C<<> character the shell code is
2200 executed and its standard output is sent to U-Boot. Example:
2202 uboot < printf "mmc write \$loadaddr 1 %x" $(($(/usr/bin/stat -c%s rootfs.ext4) / 512))
2204 When C<E<gt> file> part is present, the output of the U-Boot command
2205 is written into the given file.
2211 #!/usr/bin/env novaboot
2212 load bzImage console=ttyS0,115200
2213 run make -C buildroot
2214 load rootfs.cpio < gen_cpio buildroot/images/rootfs.cpio "myapp->/etc/init.d/S99myapp"
2216 Example (NOVA User Land - NUL):
2218 #!/usr/bin/env novaboot
2219 WVDESC=Example program
2220 load bin/apps/sigma0.nul S0_DEFAULT script_start:1,1 \
2221 verbose hostkeyb:0,0x60,1,12,2
2222 load bin/apps/hello.nul
2223 load hello.nulconfig <<EOF
2224 sigma0::mem:16 name::/s0/log name::/s0/timer name::/s0/fs/rom ||
2225 rom://bin/apps/hello.nul
2228 This example will load three modules: F<sigma0.nul>, F<hello.nul> and
2229 F<hello.nulconfig>. sigma0 receives some command line parameters and
2230 F<hello.nulconfig> file is generated on the fly from the lines between
2231 C<<<EOF> and C<EOF>.
2233 Example (Zynq system update via U-Boot):
2235 #!/usr/bin/env novaboot
2239 # Write kernel to FAT filesystem on the 1st SD card partition
2240 run mkimage -f uboot-image.its image.ub
2242 uboot:60s tftpboot ${loadaddr} $NB_PREFIX/image.ub
2243 uboot fatwrite mmc 0:1 ${loadaddr} image.ub $filesize
2244 uboot set bootargs console=ttyPS0,115200 root=/dev/mmcblk0p2
2246 # Write root FS image to the 2nd SD card partition
2247 copy rootfs/images/rootfs.ext4
2248 uboot:60s tftpboot ${loadaddr} $NB_PREFIX/rootfs/images/rootfs.ext4
2249 uboot mmc part > mmc-part.txt
2250 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))
2257 The following variables are interpreted in the novaboot script:
2263 Novaboot chdir()s to this directory before file generation phase. The
2264 directory name specified here is relative to the build directory
2265 specified by other means (see L</--build-dir>).
2269 Assigning this variable has the same effect as specifying L</--exiton>
2274 Setting this variable to zero is the same as giving
2275 L</--no-interaction>, specifying to one corresponds to
2278 =item HYPERVISOR_PARAMS
2280 Parameters passed to the hypervisor. The default value is "serial", unless
2281 overridden in the configuration file.
2285 The kernel to use instead of the hypervisor specified in the
2286 configuration file with the C<$hypervisor> variable. The value should
2287 contain the name of the kernel image as well as its command line
2288 parameters. If this variable is defined and non-empty, the variable
2289 HYPERVISOR_PARAMS is not used.
2293 If this variable is 1, the system is not booted. This is currently
2294 only implemented for U-Boot bootloader where it is useful for
2295 interacting with the bootloader without booting the system - e.g. for
2300 Use a specific qemu binary (can be overridden with B<-Q>) and flags
2301 when booting this script under qemu. If QEMU_FLAGS variable is also
2302 specified flags specified in QEMU variable are replaced by those in
2307 Use specific qemu flags (can be overridden with B<-q>).
2311 See L</--uboot-cmd>.
2315 Description of the WvTest-compliant program.
2317 =item WVTEST_TIMEOUT
2319 The timeout in seconds for WvTest harness. If no complete line appears
2320 in the test output within the time specified here, the test fails. It
2321 is necessary to specify this for long running tests that produce no
2322 intermediate output.
2326 =head1 CONFIGURATION FILES
2328 Novaboot can read its configuration from one or more files. By
2329 default, novaboot looks for files in F</etc/novaboot.d>, file
2330 F<~/.config/novaboot> and files named F<.novaboot> as described in
2331 L</Configuration reading phase>. Alternatively, configuration file
2332 location can be specified with the B<-c> switch or with the
2333 NOVABOOT_CONFIG environment variable. The configuration file has Perl
2334 syntax (i.e. it is better to put C<1;> as the last line) and should set
2335 values of certain Perl variables. The current configuration can be
2336 dumped with the B<--dump-config> switch. Some configuration variables
2337 can be overridden by environment variables (see below) or by command
2340 Supported configuration variables include:
2346 Build directory location relative to the location of the configuration
2349 =item $default_target
2351 Default target (see below) to use when no target is explicitly
2352 specified with the B<--target> command line option or
2353 B<NOVABOOT_TARGET> environment variable.
2357 Hash of target definitions to be used with the B<--target> option. The
2358 key is the identifier of the target, the value is the string with
2359 command line options. For instance, if the configuration file contains:
2361 $targets{'mybox'} = '--server=boot:/tftproot --serial=/dev/ttyUSB0 --grub',
2363 then the following two commands are equivalent:
2365 ./myos --server=boot:/tftproot --serial=/dev/ttyUSB0 --grub
2370 =head1 ENVIRONMENT VARIABLES
2372 Some options can be specified not only via config file or command line
2373 but also through environment variables. Environment variables override
2374 the values from the configuration file and command line parameters
2375 override the environment variables.
2379 =item NOVABOOT_CONFIG
2381 Name of the novaboot configuration file to use instead of the default
2384 =item NOVABOOT_CONFIG_DIR
2386 Name of the novaboot configuration directory. When not specified
2387 F</etc/novaboot.d> is used.
2389 =item NOVABOOT_TARGET
2391 Name of the novaboot target to use. This overrides the value of
2392 B<$default_target> from the configuration file and can be overridden
2393 with the B<--target> command line option.
2395 =item NOVABOOT_BENDER
2397 Defining this variable has the same effect as using B<--bender>
2404 Michal Sojka <sojka@os.inf.tu-dresden.de>
2406 Latest novaboot version can be found at
2407 L<https://github.com/wentasah/novaboot>.
2411 # LocalWords: novaboot Novaboot NOVABOOT TFTP PXE DHCP filename stty
2412 # LocalWords: chainloader stdout Qemu qemu preprocessing ISOLINUX bootable
2413 # LocalWords: config subprocesses sudo sudoers tftp dhcp IDE stdin
2414 # LocalWords: subdirectories TTY whitespace heredoc POSIX WvTest