novaboot

   1 #!/usr/bin/env perl
   2
   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.
   7
   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.
  12
  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/>.
  15
  16 ## Initialization
  17
  18 use strict;
  19 use warnings;
  20 use warnings (exists $ENV{NOVABOOT_TEST} ? (FATAL => 'all') : ());
  21 use Getopt::Long qw(GetOptionsFromString GetOptionsFromArray);
  22 use Pod::Usage;
  23 use File::Basename;
  24 use File::Spec;
  25 use File::Path qw(make_path);
  26 use IO::Handle;
  27 use Time::HiRes("usleep");
  28 use Socket;
  29 use FileHandle;
  30 use IPC::Open2;
  31 use POSIX qw(:errno_h sysconf);
  32 use Cwd qw(getcwd abs_path);
  33 use Expect;
  34
  35 # always flush
  36 $| = 1;
  37
  38 my $invocation_dir = $ENV{PWD} || getcwd();
  39
  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.
  43 # We fix that here.
  44 if (abs_path($ENV{PWD}) ne abs_path(getcwd())) {
  45     $invocation_dir = getcwd();
  46 }
  47
  48 ## Configuration file handling
  49
  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 = '';
  56 $CFG::netif = 'eth0';
  57 %CFG::targets = (
  58     'qemu' => '--qemu',
  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"',
  65     );
  66
  67 {
  68     my %const;
  69     $const{linux}->{_SC_NPROCESSORS_CONF} = 83;
  70     my $nproc = sysconf($const{$^O}->{_SC_NPROCESSORS_CONF});
  71
  72     $CFG::scons = "scons -j$nproc";
  73     $CFG::make = "make -j$nproc";
  74 }
  75
  76 my $builddir;
  77
  78 sub read_config($) {
  79     my ($cfg) = @_;
  80     {
  81         package CFG; # Put config data into a separate namespace
  82
  83         my $rc = do($cfg);
  84
  85         # Check for errors
  86         if ($@) {
  87             die("ERROR: Failure compiling '$cfg' - $@");
  88         } elsif (! defined($rc)) {
  89             die("ERROR: Failure reading '$cfg' - $!");
  90         } elsif (! $rc) {
  91             die("ERROR: Failure processing '$cfg'");
  92         }
  93     }
  94     $builddir = File::Spec->rel2abs($CFG::builddir, dirname($cfg)) if defined $CFG::builddir;
  95     print STDERR "novaboot: Read $cfg\n";
  96 }
  97
  98 my @cfgs;
  99 {
 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]);
 109     }
 110     @cfgs = reverse @cfgs;
 111
 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";
 114
 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);
 118         closedir $dh;
 119         @etccfg = sort(@etccfg);
 120         @cfgs = ( @etccfg, @cfgs );
 121     }
 122 }
 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;
 127
 128 ## Command line handling
 129
 130 my $explicit_target = $ENV{'NOVABOOT_TARGET'};
 131 GetOptions ("target|t=s" => \$explicit_target);
 132
 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);
 135
 136 my ($target_reset, $target_power_on, $target_power_off);
 137
 138 # Default values of certain command line options
 139 %uboot_addr = (
 140     'kernel'  => '${kernel_addr_r}',
 141     'ramdisk' => '${ramdisk_addr_r}',
 142     'fdt'     => '${fdt_addr_r}',
 143     );
 144 $rsync_flags = '';
 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
 149 $final_eol = 1;
 150 $netif = $CFG::netif;
 151 $remote_expect_timeout = -1;
 152
 153 my @expect_seen = ();
 154 sub handle_expect
 155 {
 156     my ($n, $v) = @_;
 157     push(@expect_seen, '-re') if $n eq "expect-re";
 158     push(@expect_seen, $v);
 159 }
 160
 161 sub handle_send
 162 {
 163     my ($n, $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);
 168     @expect_seen = ();
 169 }
 170
 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,
 189     );
 190
 191 my %opt_spec = (
 192     %opt_spec_safe,
 193     "amt=s"          => \$amt,
 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,
 210     "ider"           => \$ider,
 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,
 221     "off"            => \$off_opt,
 222     "on"             => \$on_opt,
 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]); },
 227     "reset!"         => \$reset,
 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 = ''; },
 240     "stty=s"         => \$stty,
 241     "tftp"           => \$tftp,
 242     "tftp-port=i"    => \$tftp_port,
 243     "no-uboot"       => sub { undef $uboot; },
 244     "h"              => \$help,
 245     "help"           => \$man,
 246     );
 247
 248 sub handle_novaboot_server
 249 {
 250     my ($n, $val) = @_;
 251     my $xdg_runtime_dir = $ENV{XDG_RUNTIME_DIR} || '/var/run';
 252     my $ssh_ctl_path = "${xdg_runtime_dir}/novaboot$$";
 253
 254     @remote_cmd = ('ssh', '-tt', '-M', '-S', $ssh_ctl_path, $val, 'console');
 255     $remote_expect = "novaboot-shell: Connected";
 256     $server = "$val:";
 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');
 260
 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'); };
 263
 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"; }
 270
 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");
 274
 275     if (scalar @target_config) { die "Unsuported configuration received from the server: ".join(", ", @target_config); }
 276 }
 277
 278 # First process target options
 279 {
 280     my $t = defined($explicit_target) ? $explicit_target : $CFG::default_target;
 281     my @target_expanded;
 282     Getopt::Long::Configure(qw/no_ignore_case pass_through/);
 283     while ($t) {
 284         exists $CFG::targets{$t} or die("Unknown target '$t' (valid targets are: ".join(", ", sort keys(%CFG::targets)).")");
 285
 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;
 291     }
 292
 293     my @args = (@target_expanded, @ARGV);
 294     print STDERR "novaboot: Effective options: @args\n";
 295
 296     Getopt::Long::Configure(qw/no_ignore_case no_pass_through/);
 297     GetOptionsFromArray(\@target_expanded, %opt_spec) or die ("Error in target definition");
 298 }
 299
 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;
 305
 306 ### Dump sanitized configuration (if requested)
 307
 308 if ($dump_config) {
 309     use Data::Dumper;
 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"]); }
 316     }
 317     print "1;\n";
 318     exit;
 319 }
 320
 321 ### Sanitize configuration
 322
 323 if ($interactive && !-t STDIN) {
 324     die("novaboot: Interactive mode not supported when not on terminal");
 325 }
 326
 327 if (defined $config_name_opt && scalar(@ARGV) > 1) { die "You cannot use --name with multiple scripts"; }
 328
 329 if ($ider) {
 330     $iso_image //= ''; # IDE-R needs an ISO image
 331     if (!defined $amt) { die "Error: --ider requires --amt"; }
 332 }
 333
 334 {
 335     my %input_opts = ('--iprelay'    => \$iprelay,
 336                       '--iprelay-cmd'=> \$iprelay_cmd,
 337                       '--serial'     => \$serial,
 338                       '--remote-cmd' => (@remote_cmd ? \$remote_cmd[0] : undef),
 339                       '--amt'        => \$amt);
 340     my @opts = grep(defined(${$input_opts{$_}}) , keys %input_opts);
 341
 342     die("novaboot: More than one target connection option: ".join(', ', @opts)) if scalar @opts > 1;
 343 }
 344
 345 # Default options
 346 if (defined $serial) {
 347     $serial ||= "/dev/ttyUSB0";
 348     $ENV{NB_SERIAL} = $serial;
 349 }
 350 if (defined $grub_config) { $grub_config ||= "menu.lst"; }
 351 if (defined $grub2_config) { $grub2_config ||= "./boot/grub/grub.cfg"; }
 352
 353 ## Parse the novaboot script(s)
 354 my @scripts;
 355 my $file;
 356 my $EOF;
 357 my $last_fn = '';
 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;
 364         $last_fn = $ARGV;
 365         push @scripts, { 'filename' => $ARGV,
 366                          'modules' => $modules = [],
 367                          'variables' => $variables = {},
 368                          'generated' => $generated = [],
 369                          'copy' => $copy = [],
 370                          'chainload' => $chainload = [],
 371         };
 372
 373     }
 374     chomp();
 375     next if /^#/ || /^\s*$/;    # Skip comments and empty lines
 376
 377     $_ =~ s/^[[:space:]]*// if ($continuation);
 378
 379     if (/\\$/) {                # Line continuation
 380         $continuation .= substr($_, 0, length($_)-1);
 381         next;
 382     }
 383
 384     if ($continuation) {        # Last continuation line
 385         $_ = $continuation . $_;
 386         $continuation = '';
 387     }
 388
 389     foreach my $mod(@scriptmod) { eval $mod; }
 390
 391     if ($file && $_ eq $EOF) {  # Heredoc end
 392         undef $file;
 393         next;
 394     }
 395     if ($file) {                # Heredoc content
 396         push @{$file}, "$_\n";
 397         next;
 398     }
 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");
 403         next;
 404     }
 405     sub process_load_copy($) {
 406         die("novaboot: '$last_fn' line $.: Missing file name\n") unless /^[^ <]+/;
 407         if (/^([^ ]*)(.*?)[[:space:]]*<<([^ ]*)$/) { # Heredoc start
 408             $file = [];
 409             push @$generated, {filename => $1, content => $file};
 410             $EOF = $3;
 411             return "$1$2";
 412         }
 413         if (/^([^ ]*)(.*?)[[:space:]]*< ?(.*)$/) { # Command substitution
 414             push @$generated, {filename => $1, command => $3};
 415             return "$1$2";
 416         }
 417         s/\s*$//;               # Strip trailing whitespace
 418         return $_;
 419     }
 420     if (s/^load *//) {          # Load line
 421         push @$modules, process_load_copy($_);
 422         next;
 423     }
 424     if (s/^copy *//) {          # Copy line
 425         push @$copy, process_load_copy($_);
 426         next;
 427     }
 428     if (s/^chld *//) {          # Chainload line
 429         push @$chainload, process_load_copy($_);
 430         next;
 431     }
 432     if (/^run (.*)/) {          # run line
 433         push @$generated, {command => $1};
 434         next;
 435     }
 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 =~ /(.*) *> *(.*)/) {
 441             $string = $1;
 442             $dest = $2;
 443         }
 444         push @uboot_init, { command => $redir ? "" : $string,
 445                             system =>  $redir ? $string : "",
 446                             timeout => $timeout,
 447                             dest => $dest,
 448         };
 449         next;
 450     }
 451
 452     die("novaboot: Cannot parse script '$last_fn' line $.. Didn't you forget 'load' keyword?\n");
 453 }
 454 # use Data::Dumper;
 455 # print Dumper(\@scripts);
 456
 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;
 461
 462     my $kernel;
 463     if (exists $variables->{KERNEL}) {
 464         $kernel = $variables->{KERNEL};
 465     } else {
 466         if ($CFG::hypervisor) {
 467             $kernel = $CFG::hypervisor . " ";
 468             if (exists $variables->{HYPERVISOR_PARAMS}) {
 469                 $kernel .= $variables->{HYPERVISOR_PARAMS};
 470             } else {
 471                 $kernel .= $CFG::hypervisor_params;
 472             }
 473         }
 474     }
 475     @$modules = ($kernel, @$modules) if $kernel;
 476     @$modules = (@chainloaders, @$modules);
 477     @$modules = ("bin/boot/bender", @$modules) if ($bender || defined $ENV{'NOVABOOT_BENDER'});
 478 }
 479
 480 if ($dump_opt) {
 481     foreach my $script (@scripts) {
 482         print join("\n", @{$$script{modules}})."\n";
 483     }
 484     exit(0);
 485 }
 486
 487 ## Helper functions
 488
 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};
 498         close($f);
 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}");
 504         } else {
 505             system_verbose($$g{command});
 506         }
 507       }
 508     }
 509 }
 510
 511 sub generate_grub_config($$$$;$)
 512 {
 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)
 519     my $first = 1;
 520     foreach (@$modules_ref) {
 521         if ($first) {
 522             $first = 0;
 523             my ($kbin, $kcmd) = split(' ', $_, 2);
 524             $kcmd = '' if !defined $kcmd;
 525             print $fg "kernel ${base}$kbin $kcmd\n";
 526         } else {
 527             s|\brom://([^ ]*)|$rom_prefix$base$1|g; # Translate rom:// files - needed for vdisk parameter of sigma0
 528             print $fg "module $base$_\n";
 529         }
 530     }
 531     close($fg);
 532     print("novaboot: Created $builddir/$filename\n");
 533     return $filename;
 534 }
 535
 536 sub generate_syslinux_config($$$$)
 537 {
 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";
 543
 544     my ($kbin, $kcmd) = split(' ', @$modules_ref[0], 2);
 545
 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";
 552     } else {
 553         print $fg "KERNEL mboot.c32\n";
 554         my @append;
 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";
 559         }
 560     }
 561     #TODO print $fg "TEXT HELP\n";
 562     #TODO print $fg "some help here\n";
 563     #TODO print $fg "ENDTEXT\n";
 564     close($fg);
 565     print("novaboot: Created $builddir/$filename\n");
 566     return $filename;
 567 }
 568
 569 sub generate_grub2_config($$$$;$$)
 570 {
 571     my ($filename, $title, $base, $modules_ref, $preamble, $prolog) = @_;
 572     if ($base && substr($base,-1,1) ne '/') { $base = "$base/"; };
 573     my $dir = dirname($filename);
 574     make_path($dir, {
 575                 chmod => 0755,
 576     });
 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;
 582     my $first = 1;
 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";
 587         die('Too many "load" lines for Linux kernel') if (scalar(@$modules_ref) > 2);
 588     }
 589     foreach (@$modules_ref) {
 590         if ($first) {
 591             $first = 0;
 592             my ($kbin, $kcmd) = split(' ', $_, 2);
 593             $kcmd = '' if !defined $kcmd;
 594             print $fg "  $boot_method ${base}$kbin $kcmd\n";
 595         } else {
 596             my @args = split;
 597             if ($boot_method eq "multiboot") {
 598                 # GRUB2 doesn't pass filename in multiboot info so we have to duplicate it here
 599                 $_ = join(' ', ($args[0], @args));
 600                 s|\brom://|$rom_prefix|g; # We do not need to translate path for GRUB2
 601             }
 602             print $fg "  $module_load_method $base$_\n";
 603         }
 604     }
 605     print $fg "}\n";
 606     close($fg);
 607     print("novaboot: Created $builddir/$filename\n");
 608     return $filename;
 609 }
 610
 611 sub generate_pulsar_config($$$)
 612 {
 613     my ($filename, $modules_ref, $chainload_ref) = @_;
 614     open(my $fg, '>', $filename) or die "$filename: $!";
 615     print $fg "root $pulsar_root\n" if defined $pulsar_root;
 616     if (scalar(@$chainload_ref) > 0) {
 617         print $fg "chld $$chainload_ref[0]\n";
 618     } else {
 619         my $first = 1;
 620         my ($kbin, $kcmd);
 621         foreach (@$modules_ref) {
 622             if ($first) {
 623                 $first = 0;
 624                 ($kbin, $kcmd) = split(' ', $_, 2);
 625                 $kcmd = '' if !defined $kcmd;
 626             } else {
 627                 my @args = split;
 628                 s|\brom://|$rom_prefix|g;
 629                 print $fg "load $_\n";
 630             }
 631         }
 632         # Put kernel as last - this is needed for booting Linux and has no influence on non-Linux OSes
 633         print $fg "exec $kbin $kcmd\n";
 634     }
 635     close($fg);
 636     print("novaboot: Created $builddir/$filename\n");
 637     return $filename;
 638 }
 639
 640 sub shell_cmd_string(@)
 641 {
 642     if (scalar(@_) == 1) {
 643         return $_[0];
 644     } else {
 645         return join(' ', map((/^[-_=a-zA-Z0-9\/\.\+]+$/ ? "$_" : "'$_'"), @_));
 646     }
 647 }
 648
 649 sub exec_verbose(@)
 650 {
 651     print STDERR "novaboot: Running: ".shell_cmd_string(@_)."\n";
 652     exec(@_);
 653     exit(1); # should not be reached
 654 }
 655
 656 sub system_verbose
 657 {
 658     print STDERR "novaboot: Running: ".shell_cmd_string(@_)."\n";
 659     my $ret = system(@_);
 660     if ($ret & 0x007f) { die("Command terminated by a signal"); }
 661     if ($ret & 0xff00) {die("Command exit with non-zero exit code"); }
 662     if ($ret) { die("Command failure $ret"); }
 663 }
 664
 665 sub trim($) {
 666     my ($str) = @_;
 667     $str =~ s/^\s+|\s+$//g;
 668     return $str
 669 }
 670
 671 ## WvTest headline
 672
 673 if (exists $variables->{WVDESC}) {
 674     print STDERR "Testing \"$variables->{WVDESC}\" in $last_fn:\n";
 675 } elsif ($last_fn =~ /\.wv$/) {
 676     print STDERR "Testing \"all\" in $last_fn:\n";
 677 }
 678
 679 ## Connect to the target and check whether it is not occupied
 680
 681 # We have to do this before file generation phase, because file
 682 # generation is intermixed with file deployment phase and we want to
 683 # check whether the target is not used by somebody else before
 684 # deploying files. Otherwise, we may rewrite other user's files on a
 685 # boot server.
 686
 687 my $exp; # Expect object to communicate with the target over serial line
 688
 689 sub kill_exp_on_signal() {
 690     # Sometimes, under unclear circumstances (e.g. when running under
 691     # both Jenkins and Robotframework), novaboot does not terminate
 692     # console command when killed. The console is then blocked by the
 693     # stale process forever. Theoretically, this should not happen,
 694     # because when novaboot is killed, console command's controlling
 695     # terminal sends SIGHUP to the console command and the command
 696     # should terminate. It seems that at least SSH sometimes ignores
 697     # HUP and does not terminate. The code below seems to work around
 698     # that problem by killing the process immediately with SIGTERM,
 699     # which is not ignored.
 700
 701     sub kill_console { kill TERM => $exp->pid if $exp->pid; die "Terminated by SIG$_[0]"; };
 702
 703     # For our Jenkins/Robotframework use case, it was sufficient to
 704     # handle the TERM signal, but to be on the safe side, we also
 705     # catch other signals.
 706     $SIG{TERM} = \&kill_console;
 707     $SIG{HUP} = \&kill_console;
 708     $SIG{INT} = \&kill_console;
 709     $SIG{QUIT} = \&kill_console;
 710 }
 711
 712
 713 my ($amt_user, $amt_password, $amt_host, $amt_port);
 714
 715 if (defined $iprelay || defined $iprelay_cmd) {
 716     if (defined $iprelay) {
 717         my $IPRELAY;
 718         $iprelay =~ /([.0-9]+)(:([0-9]+))?/;
 719         my $addr = $1;
 720         my $port = $3 || 23;
 721         my $paddr   = sockaddr_in($port, inet_aton($addr));
 722         my $proto   = getprotobyname('tcp');
 723         socket($IPRELAY, PF_INET, SOCK_STREAM, $proto)  || die "socket: $!";
 724         print STDERR "novaboot: Connecting to IP relay... ";
 725         connect($IPRELAY, $paddr)    || die "connect: $!";
 726         print STDERR "done\n";
 727         $exp = Expect->init(\*$IPRELAY);
 728         $exp->log_stdout(1);
 729     }
 730     if (defined $iprelay_cmd) {
 731         print STDERR "novaboot: Running: $iprelay_cmd\n";
 732         $exp = new Expect;
 733         $exp->raw_pty(1);
 734         $exp->spawn($iprelay_cmd);
 735         kill_exp_on_signal();
 736     }
 737
 738     while (1) {
 739         print $exp "\xFF\xF6";  # AYT
 740         my $connected = $exp->expect(20, # Timeout in seconds
 741                                      '<iprelayd: connected>',
 742                                      '-re', '<WEB51 HW[^>]*>')
 743             || die "iprelay connection: " . ($! || "timeout");
 744         last if $connected;
 745     }
 746
 747     sub relaycmd($$) {
 748         my ($relay, $onoff) = @_;
 749         die unless ($relay == 1 || $relay == 2);
 750
 751         my $cmd = ($relay == 1 ? 0x5 : 0x6) | ($onoff ? 0x20 : 0x10);
 752         return "\xFF\xFA\x2C\x32".chr($cmd)."\xFF\xF0";
 753     }
 754
 755     sub relayconf($$) {
 756         my ($relay, $onoff) = @_;
 757         die unless ($relay == 1 || $relay == 2);
 758         my $cmd = ($relay == 1 ? 0xdf : 0xbf) | ($onoff ? 0x00 : 0xff);
 759         return "\xFF\xFA\x2C\x97".chr($cmd)."\xFF\xF0";
 760     }
 761
 762     sub relay($$;$) {
 763         my ($relay, $onoff, $can_giveup) = @_;
 764         my $confirmation = '';
 765         $exp->log_stdout(0);
 766         print $exp relaycmd($relay, $onoff);
 767         my $confirmed = $exp->expect(20, # Timeout in seconds
 768                                      relayconf($relay, $onoff))
 769             || die "iprelay command: " . ($! || "timeout");
 770         if (!$confirmed) {
 771             if ($can_giveup) {
 772                 print("Relay confirmation timeout - ignoring\n");
 773             } else {
 774                 die "Relay confirmation timeout";
 775             }
 776         }
 777         $exp->log_stdout(1);
 778     }
 779
 780     $target_reset = sub {
 781         relay(2, 1, 1); # Reset the machine
 782         usleep(100000);
 783         relay(2, 0);
 784     };
 785
 786     $target_power_off = sub {
 787         relay(1, 1);            # Press power button
 788         usleep(6000000);        # Long press to switch off
 789         relay(1, 0);
 790     };
 791
 792     $target_power_on = sub {
 793         relay(1, 1);            # Press power button
 794         usleep(100000);         # Short press
 795         relay(1, 0);
 796     };
 797 }
 798 elsif ($serial) {
 799     my $CONN;
 800     system_verbose("stty -F $serial $stty");
 801     open($CONN, "+<", $serial) || die "open $serial: $!";
 802     $exp = Expect->init(\*$CONN);
 803 }
 804 elsif (@remote_cmd) {
 805     print STDERR "novaboot: Running: ".shell_cmd_string(@remote_cmd)."\n";
 806     $exp = Expect->spawn(@remote_cmd);
 807     kill_exp_on_signal();
 808 }
 809 elsif (defined $amt) {
 810     require LWP::UserAgent;
 811     require LWP::Authen::Digest;
 812
 813     sub genXML {
 814         my ($host, $username, $password, $schema, $className, $pstate) = @_;
 815         #AMT numbers for PowerStateChange (MNI => bluescreen on windows;-)
 816         my %pstates = ("on"        => 2,
 817                        "standby"   => 4,
 818                        "hibernate" => 7,
 819                        "off"       => 8,
 820                        "reset"     => 10,
 821                        "MNI"       => 11);
 822         return <<END;
 823                 <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">
 824                 <s:Header><a:To>http://$host:16992/wsman</a:To>
 825                 <w:ResourceURI s:mustUnderstand="true">$schema</w:ResourceURI>
 826                 <a:ReplyTo><a:Address s:mustUnderstand="true">http://schemas.xmlsoap.org/ws/2004/08/addressing/role/anonymous</a:Address></a:ReplyTo>
 827                 <a:Action s:mustUnderstand="true">$schema$className</a:Action>
 828                 <w:MaxEnvelopeSize s:mustUnderstand="true">153600</w:MaxEnvelopeSize>
 829                 <a:MessageID>uuid:709072C9-609C-4B43-B301-075004043C7C</a:MessageID>
 830                 <w:Locale xml:lang="en-US" s:mustUnderstand="false" />
 831                 <w:OperationTimeout>PT60.000S</w:OperationTimeout>
 832                 <w:SelectorSet><w:Selector Name="Name">Intel(r) AMT Power Management Service</w:Selector></w:SelectorSet>
 833                 </s:Header><s:Body>
 834                 <p:RequestPowerStateChange_INPUT xmlns:p="http://schemas.dmtf.org/wbem/wscim/1/cim-schema/2/CIM_PowerManagementService">
 835                 <p:PowerState>$pstates{$pstate}</p:PowerState>
 836                 <p:ManagedElement><a:Address>http://$host:16992/wsman</a:Address>
 837                 <a:ReferenceParameters><w:ResourceURI>http://schemas.dmtf.org/wbem/wscim/1/cim-schema/2/CIM_ComputerSystem</w:ResourceURI>
 838                 <w:SelectorSet><w:Selector Name="Name">ManagedSystem</w:Selector></w:SelectorSet>
 839                 </a:ReferenceParameters></p:ManagedElement>
 840                 </p:RequestPowerStateChange_INPUT>
 841                 </s:Body></s:Envelope>
 842 END
 843     }
 844
 845     sub sendPOST {
 846         my ($host, $username, $password, $content) = @_;
 847
 848         my $ua = LWP::UserAgent->new();
 849         $ua->agent("novaboot");
 850
 851         my $req = HTTP::Request->new(POST => "http://$host:16992/wsman");
 852         my $res = $ua->request($req);
 853         die ("Unexpected AMT response: " . $res->status_line) unless $res->code == 401;
 854
 855         my ($realm) = $res->header("WWW-Authenticate") =~ /Digest realm="(.*?)"/;
 856         $ua->credentials("$host:16992", $realm, $username => $password);
 857
 858         # Create a request
 859         $req = HTTP::Request->new(POST => "http://$host:16992/wsman");
 860         $req->content_type('application/x-www-form-urlencoded');
 861         $req->content($content);
 862         $res = $ua->request($req);
 863         die ("AMT power change request failed: " . $res->status_line) unless $res->is_success;
 864         $res->content() =~ /<g:ReturnValue>(\d+)<\/g:ReturnValue>/;
 865         return $1;
 866     }
 867
 868     sub powerChange  {
 869         my ($host, $username, $password, $pstate)=@_;
 870         my $schema="http://schemas.dmtf.org/wbem/wscim/1/cim-schema/2/CIM_PowerManagementService";
 871         my $className="/RequestPowerStateChange";
 872         my $content = genXML($host, $username, $password ,$schema, $className, $pstate);
 873         return sendPOST($host, $username, $password, $content);
 874     }
 875
 876     ($amt_user,$amt_password,$amt_host,$amt_port) = ($amt =~ /(?:(.*?)(?::(.*))?@)?([^:]*)(?::([0-9]*))?/);;
 877     $amt_user ||= "admin";
 878     $amt_password ||= $ENV{'AMT_PASSWORD'} || die "AMT password not specified";
 879     $amt_host || die "AMT host not specified";
 880     $amt_port ||= 16994;
 881
 882
 883     $target_power_off = sub {
 884         $exp->close();
 885         my $result = powerChange($amt_host,$amt_user,$amt_password, "off");
 886         die "AMT power off failed (ReturnValue $result)" if $result != 0;
 887     };
 888
 889     $target_power_on = sub {
 890         my $result = powerChange($amt_host,$amt_user,$amt_password, "on");
 891         die "AMT power on failed (ReturnValue $result)" if $result != 0;
 892     };
 893
 894     $target_reset = sub {
 895         my $result = powerChange($amt_host,$amt_user,$amt_password, "reset");
 896         if ($result != 0) {
 897             print STDERR "Warning: Cannot reset $amt_host, trying power on. ";
 898             $result = powerChange($amt_host,$amt_user,$amt_password, "on");
 899         }
 900         die "AMT reset failed (ReturnValue $result)" if $result != 0;
 901     };
 902
 903     my $cmd = "amtterm -u $amt_user -p $amt_password $amt_host $amt_port";
 904     print STDERR "novaboot: Running: $cmd\n" =~ s/\Q$amt_password\E/???/r;
 905     $exp = Expect->spawn($cmd);
 906     $exp->expect(10, "RUN_SOL") || die "Expect for 'RUN_SOL': " . ($! || "timeout");
 907 }
 908
 909
 910 if ($remote_expect) {
 911     $exp || die("No serial line connection");
 912     my $log = $exp->log_stdout;
 913     if (defined $remote_expect_silent) {
 914         $exp->log_stdout(0);
 915     }
 916     $exp->expect($remote_expect_timeout >= 0 ? $remote_expect_timeout : undef,
 917                  $remote_expect) || die "Expect for '$remote_expect':" . ($! || "timeout");;
 918     if (defined $remote_expect_silent) {
 919         $exp->log_stdout($log);
 920         print $exp->after() if $log;
 921     }
 922 }
 923
 924 if (@reset_cmd) {
 925     $target_reset = sub {
 926         system_verbose(@reset_cmd);
 927     };
 928 }
 929
 930 if (defined $reset_send) {
 931     $target_reset = sub {
 932         $reset_send =~ s/\\n/\n/g;
 933         $exp->send($reset_send);
 934     };
 935 }
 936
 937 if (defined $on_opt && defined $target_power_on) {
 938     &$target_power_on();
 939     exit;
 940 }
 941 if (defined $off_opt && defined $target_power_off) {
 942     print STDERR "novaboot: Switching the target off...\n";
 943     &$target_power_off();
 944     exit;
 945 }
 946
 947 $builddir ||= dirname(File::Spec->rel2abs( ${$scripts[0]}{filename})) if scalar @scripts;
 948 if (defined $builddir) {
 949     chdir($builddir) or die "Can't change directory to $builddir: $!";
 950     print STDERR "novaboot: Entering directory `$builddir'\n";
 951 } else {
 952     $builddir = $invocation_dir;
 953 }
 954
 955 ## File generation phase
 956 my (%files_iso, $menu_iso, $filename);
 957 my $config_name = '';
 958 my $prefix = '';
 959
 960 foreach my $script (@scripts) {
 961     $filename = $$script{filename};
 962     $modules = $$script{modules};
 963     $generated = $$script{generated};
 964     $variables = $$script{variables};
 965
 966     ($config_name = $filename) =~ s#.*/##;
 967     $config_name = $config_name_opt if (defined $config_name_opt);
 968
 969     if (exists $variables->{BUILDDIR}) {
 970         $builddir = File::Spec->rel2abs($variables->{BUILDDIR});
 971         chdir($builddir) or die "Can't change directory to $builddir: $!";
 972         print STDERR "novaboot: Entering directory `$builddir'\n";
 973     }
 974
 975     if ($grub_prefix) {
 976         $prefix = $grub_prefix;
 977         $prefix =~ s/\$NAME/$config_name/;
 978         $prefix =~ s/\$BUILDDIR/$builddir/;
 979     }
 980     # TODO: use $grub_prefix as first parameter if some switch is given
 981     generate_configs('', $generated, $filename);
 982
 983 ### Generate bootloader configuration files
 984     my @bootloader_configs;
 985     push @bootloader_configs, generate_grub_config($grub_config, $config_name, $prefix, $modules, $grub_preamble) if (defined $grub_config);
 986     push @bootloader_configs, generate_grub2_config($grub2_config, $config_name, $prefix, $modules, $grub_preamble, $grub2_prolog) if (defined $grub2_config);
 987     push @bootloader_configs, generate_pulsar_config('config-'.($pulsar||'novaboot'), $modules, $chainload) if (defined $pulsar);
 988
 989 ### Run scons or make
 990     {
 991         my @all;
 992         push @all, @$modules;
 993         push @all, @$copy;
 994         push @all, @$chainload;
 995         my @files = map({ ($file) = m/([^ ]*)/; $file; } @all);
 996
 997         # Filter-out generated files
 998         my @to_build = grep({ my $file = $_; !scalar(grep($file eq ($$_{filename} || ''), @$generated)) } @files);
 999
1000         system_verbose($scons || $CFG::scons." ".join(" ", @to_build)) if (defined $scons);
1001         system_verbose($make  || $CFG::make ." ".join(" ", @to_build)) if (defined $make);
1002     }
1003
1004 ### Copy files (using rsync)
1005     if (defined $server && !defined($gen_only)) {
1006         (my $real_server = $server) =~ s/\$NAME/$config_name/;
1007
1008         my ($hostname, $path) = split(":", $real_server, 2);
1009         if (! defined $path) {
1010             $path = $hostname;
1011             $hostname = "";
1012         }
1013         my $files = join(" ", map({ ($file) = m/([^ ]*)/; $file; } ( @$modules, @bootloader_configs, @$copy)));
1014         map({ my $file = (split)[0]; die "Not a file: $file: $!" if ! -e $file || -d $file; } @$modules);
1015         my $istty = -t STDOUT && ($ENV{'TERM'} || 'dumb') ne 'dumb';
1016         my $progress = $istty ? "--progress" : "";
1017         if ($files) {
1018             system_verbose("rsync $progress -RL --chmod=ugo=rwX $rsync_flags $files $real_server");
1019             if ($server =~ m|/\$NAME$| && $concat) {
1020                 my $cmd = join("; ", map { "( cd $path/.. && cat */$_ > $_ )" } @bootloader_configs);
1021                 system_verbose($hostname ? "ssh $hostname '$cmd'" : $cmd);
1022             }
1023         }
1024     }
1025
1026 ### Prepare ISO image generation
1027     if (defined $iso_image) {
1028         generate_configs("(cd)", $generated, $filename);
1029         my $menu;
1030         generate_syslinux_config(\$menu, $config_name, "/", $modules);
1031         $menu_iso .= "$menu\n";
1032         map { ($file,undef) = split; $files_iso{$file} = 1; } @$modules;
1033     }
1034 }
1035
1036 ## Generate ISO image
1037 if (defined $iso_image) {
1038     system_verbose("mkdir -p isolinux");
1039
1040     my @files;
1041     if (-f '/usr/lib/ISOLINUX/isolinux.bin') {
1042         # Newer ISOLINUX version
1043         @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);
1044     } elsif (-f '/usr/lib/syslinux/isolinux.bin') {
1045         # Older ISOLINUX version
1046         @files = qw(/usr/lib/syslinux/isolinux.bin /usr/lib/syslinux/mboot.c32 /usr/lib/syslinux/menu.c32);
1047     } else {
1048         # NixOS and maybe others
1049         my $syslinux = `which syslinux` || die "Cannot find syslinux";
1050         chomp $syslinux;
1051         $syslinux =~ s,/bin/syslinux$,,;
1052         @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");
1053     }
1054     system_verbose("cp @files isolinux && chmod +w isolinux/*");
1055     open(my $fh, ">isolinux/isolinux.cfg");
1056     if ($#scripts) {
1057         print $fh "TIMEOUT 50\n";
1058         print $fh "DEFAULT menu\n";
1059     } else {
1060         print $fh "DEFAULT $config_name\n";
1061     }
1062     print $fh "$menu_iso";
1063     close($fh);
1064
1065     my $files = join(" ", map("$_=$_", (keys(%files_iso), 'isolinux/isolinux.cfg', map(s|.*/|isolinux/|r, @files))));
1066     $iso_image ||= "$config_name.iso";
1067
1068     # Note: We use -U flag below to "Allow 'untranslated' filenames,
1069     # completely violating the ISO9660 standards". Without this
1070     # option, isolinux is not able to read files names for example
1071     # bzImage-3.0.
1072     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");
1073     print("ISO image created: $builddir/$iso_image\n");
1074 }
1075
1076 exit(0) if defined $gen_only;
1077
1078 ## Boot the system using various methods and send serial output to stdout
1079
1080 if (scalar(@scripts) > 1 && ( defined $dhcp_tftp || defined $serial || defined $iprelay)) {
1081     die "You cannot do this with multiple scripts simultaneously";
1082 }
1083
1084 if ($variables->{WVTEST_TIMEOUT}) {
1085     print STDERR "wvtest: timeout ", $variables->{WVTEST_TIMEOUT}, "\n";
1086 }
1087
1088 ### Start in Qemu
1089
1090 if (defined $qemu) {
1091     # Qemu
1092     $qemu ||= $variables->{QEMU} || $CFG::qemu;
1093     my @qemu_flags = split(" ", $qemu);
1094     $qemu = shift(@qemu_flags);
1095
1096     @qemu_flags = split(/ +/, trim($variables->{QEMU_FLAGS})) if exists $variables->{QEMU_FLAGS};
1097     @qemu_flags = split(/ +/, trim($qemu_flags_cmd)) if $qemu_flags_cmd;
1098     push(@qemu_flags, split(/ +/, trim($qemu_append || '')));
1099
1100     if (defined $iso_image) {
1101         # Boot NOVA with grub (and test the iso image)
1102         push(@qemu_flags, ('-cdrom', $iso_image));
1103     } else {
1104         # Boot NOVA without GRUB
1105
1106         # Non-patched qemu doesn't like commas, but NUL can live with pluses instead of commans
1107         foreach (@$modules) {s/,/+/g;}
1108         generate_configs("", $generated, $filename);
1109
1110         if (scalar @$modules) {
1111             my ($kbin, $kcmd) = split(' ', shift(@$modules), 2);
1112             $kcmd = '' if !defined $kcmd;
1113             my $dtb;
1114             @$modules = map { if (/\.dtb$/) { $dtb=$_; (); } else { $_ } } @$modules;
1115             my $initrd = join ",", @$modules;
1116
1117             push(@qemu_flags, ('-kernel', $kbin, '-append', $kcmd));
1118             push(@qemu_flags, ('-initrd', $initrd)) if $initrd;
1119             push(@qemu_flags, ('-dtb', $dtb)) if $dtb;
1120         }
1121     }
1122     if (!grep /^-serial$/, @qemu_flags) {
1123         push(@qemu_flags,  qw(-serial stdio)); # Redirect serial output (for collecting test restuls)
1124     }
1125     unshift(@qemu_flags, ('-name', $config_name));
1126     print STDERR "novaboot: Running: ".shell_cmd_string($qemu, @qemu_flags)."\n";
1127     $exp = Expect->spawn(($qemu, @qemu_flags)) || die("exec() failed: $!");
1128 }
1129
1130 ### Local DHCPD and TFTPD
1131
1132 my ($dhcpd_pid, $tftpd_pid);
1133
1134 $tftp=1 if $tftp_port;
1135
1136 if (defined $dhcp_tftp)
1137 {
1138     generate_configs("(nd)", $generated, $filename);
1139     system_verbose('mkdir -p tftpboot');
1140     generate_grub_config("tftpboot/os-menu.lst", $config_name, "(nd)", \@$modules, "timeout 0");
1141     open(my $fh, '>', 'dhcpd.conf');
1142     my $mac = `cat /sys/class/net/$netif/address`;
1143     chomp $mac;
1144     print $fh "
1145 subnet 10.23.23.0 netmask 255.255.255.0 {
1146         range 10.23.23.10 10.23.23.100;
1147         next-server 10.23.23.1;
1148 }
1149 class \"pxe-clients\" {
1150      match option vendor-class-identifier;
1151 }
1152 subclass \"pxe-clients\"  \"PXEClient:Arch:00000:UNDI:002001\" {
1153      option bootfile-name \"boot/grub/i386-pc/core.0\";
1154 }
1155 subclass \"pxe-clients\"  \"PXEClient:Arch:00007:UNDI:003016\" {
1156      option bootfile-name \"boot/grub/x86_64-efi/core.efi\";
1157 }
1158 host server {
1159         hardware ethernet $mac;
1160         fixed-address 10.23.23.1;
1161 }";
1162     close($fh);
1163     system_verbose("sudo ip a add 10.23.23.1/24 dev $netif;
1164             sudo ip l set dev $netif up;
1165             sudo touch dhcpd.leases");
1166
1167     # We run servers by forking ourselves, because the servers end up
1168     # in our process group and get killed by signals sent to the
1169     # process group (e.g. Ctrl-C on terminal).
1170     $dhcpd_pid = fork();
1171     exec_verbose("sudo dhcpd -d -cf dhcpd.conf -lf dhcpd.leases -pf dhcpd.pid") if ($dhcpd_pid == 0);
1172 }
1173
1174 if (defined $dhcp_tftp || defined $tftp) {
1175     $tftp_port ||= 69;
1176     my $tftp_root = "$builddir";
1177     $tftp_root = "$server" if(defined $server);
1178
1179     # Prepare a GRUB netboot directory
1180     system_verbose("grub-mknetdir --net-directory=$tftp_root") if (defined $grub2_config);
1181
1182     # Generate TFTP mapfile
1183     open(my $fh, '>', "$tftp_root/mapfile");
1184     print $fh "# Some PXE clients (mainly UEFI) have bug. They add zero byte to the end of the
1185 # path name. This rule removes it
1186 r     \\.efi.*   \\.efi";
1187     close($fh);
1188     # Unfortunately, tftpd requires root privileges even with
1189     # non-privileged (>1023) port due to initgroups().
1190     system_verbose("sudo in.tftpd --listen --secure -v -v -v --pidfile tftpd.pid -m mapfile --address :$tftp_port $tftp_root");
1191
1192     # Kill server when we die
1193     $SIG{__DIE__} = sub { system_verbose('sudo pkill --pidfile=dhcpd.pid') if (defined $dhcp_tftp);
1194                           system_verbose("sudo pkill --pidfile=$tftp_root/tftpd.pid"); };
1195
1196     # We have to kill tftpd explicitely, because it is not in our process group
1197     $SIG{INT} = sub { system_verbose("sudo pkill --pidfile=$tftp_root/tftpd.pid"); exit(0); };
1198 }
1199
1200 ### AMT IDE-R
1201 if (defined $ider) {
1202     my $ider_cmd= "amtider -c $iso_image -u $amt_user -p $amt_password $amt_host $amt_port"  ;
1203     print STDERR "novaboot: Running: $ider_cmd\n" =~ s/\Q$amt_password\E/???/r;
1204     my $ider_pid = fork();
1205     if ($ider_pid == 0) {
1206         exec($ider_cmd);
1207         die "IDE redirection failed";
1208     }
1209     # FIXME: This collides with --tftp option. Hopefully, nobody needs
1210     # to use both simultaneously.
1211     $SIG{__DIE__} = sub { system_verbose('kill $ider_pid'); };
1212 }
1213
1214 ### Reset target (IP relay, AMT, ...)
1215
1216 if (defined $target_reset && $reset) {
1217     print STDERR "novaboot: Resetting the test box... ";
1218     &$target_reset();
1219     print STDERR "done\n";
1220     if (defined $exp) {
1221         # We don't want to output anything printed by the target
1222         # before reset so we clear the buffers now. This is, however,
1223         # not ideal because we may loose some data that were sent
1224         # after the reset. If this is a problem, one should reset and
1225         # connect to serial line in atomic manner. For example, if
1226         # supported by hardware, use --remote-cmd 'sterm -d ...' and
1227         # do not use separate --reset-cmd.
1228         my $log = $exp->log_stdout;
1229         $exp->log_stdout(0);
1230         $exp->expect(0); # Read data from target
1231         $exp->clear_accum();    # Clear the read data
1232         $exp->log_stdout($log);
1233     }
1234 }
1235
1236 ### U-boot conversation
1237 if (defined $uboot) {
1238     my $uboot_prompt = $uboot || '=> ';
1239     print STDERR "novaboot: Waiting for U-Boot prompt...\n";
1240     $exp || die("No serial line connection");
1241     $exp->log_stdout(1);
1242     #$exp->exp_internal(1);
1243     $exp->expect(20,
1244                  [qr/Hit any key to stop autoboot:/, sub {
1245                      $exp->send($uboot_stop_key // "\n");
1246                      exp_continue; }],
1247                  $uboot_prompt) || die "No U-Boot prompt deteceted";
1248     foreach my $cmdspec (@uboot_init) {
1249         my ($cmd, $timeout);
1250         die "Internal error - please report a bug" unless ref($cmdspec) eq "HASH";
1251
1252         if ($cmdspec->{system}) {
1253             $cmd = `$cmdspec->{system}`;
1254         } else {
1255             $cmd = $cmdspec->{command};
1256         }
1257         $timeout = $cmdspec->{timeout} // 10;
1258
1259         if ($cmd =~ /\$NB_MYIP/) {
1260             my $ip = (grep /inet /, `ip addr show $netif`)[0] || die "Problem determining IP address of $netif";
1261             $ip =~ s/\s*inet ([0-9.]*).*/$1/;
1262             $cmd =~ s/\$NB_MYIP/$ip/g;
1263         }
1264         if ($cmd =~ /\$NB_PREFIX/) {
1265             my $p = $prefix;
1266             $p =~ s|/*$||;
1267             $cmd =~ s/\$NB_PREFIX/$p/g;
1268         }
1269         chomp($cmd);
1270         $exp->send("$cmd\n");
1271
1272         my ($matched_pattern_position, $error,
1273             $successfully_matching_string,
1274             $before_match, $after_match) =
1275                 $exp->expect($timeout, $uboot_prompt);
1276         die "No U-Boot prompt: $error" if $error;
1277
1278         if ($cmdspec->{dest}) {
1279             open(my $fh, ">", $cmdspec->{dest}) or die "Cannot open '$cmdspec->{dest}': $!";
1280             print $fh $before_match;
1281             close($fh);
1282         }
1283     }
1284
1285     # Load files if there are some load lines in the script
1286     if (scalar(@$modules) > 0  && !$variables->{NO_BOOT}) {
1287         my ($kbin, $kcmd) = split(' ', shift(@$modules), 2);
1288         my $dtb;
1289         @$modules = map { if (/\.dtb$/) { $dtb=$_; (); } else { $_ } } @$modules;
1290         my $initrd = shift @$modules;
1291
1292         if (defined $kbin && $kbin ne '/dev/null') {
1293             die "No '--uboot-addr kernel' given" unless $uboot_addr{kernel};
1294             $exp->send("tftpboot $uboot_addr{kernel} $prefix$kbin\n");
1295             $exp->expect(15,
1296                          [qr/##/, sub { exp_continue; }],
1297                          $uboot_prompt) || die "Kernel load: " . ($! || "timeout");
1298         }
1299         if (defined $dtb) {
1300             die "No '--uboot-addr fdt' given" unless $uboot_addr{fdt};
1301             $exp->send("tftpboot $uboot_addr{fdt} $prefix$dtb\n");
1302             $exp->expect(15,
1303                          [qr/##/, sub { exp_continue; }],
1304                          $uboot_prompt) || die "Device tree load: " . ($! || "timeout");
1305         } else  {
1306             $uboot_addr{fdt} = '';
1307         }
1308         if (defined $initrd) {
1309             die "No '--uboot-addr ramdisk' given" unless $uboot_addr{ramdisk};
1310             $exp->send("tftpboot $uboot_addr{ramdisk} $prefix$initrd\n");
1311             $exp->expect(15,
1312                          [qr/##/, sub { exp_continue; }],
1313                          $uboot_prompt) || die "Initrd load: " . ($! || "timeout");
1314         } else {
1315             $uboot_addr{ramdisk} = '-';
1316         }
1317
1318         $kcmd //= '';
1319         $exp->send("setenv bootargs $kcmd\n");
1320         $exp->expect(5, $uboot_prompt)  || die "U-Boot prompt: " . ($! || "timeout");
1321
1322     }
1323     $uboot_cmd //= $variables->{UBOOT_CMD} // 'bootm $kernel_addr $ramdisk_addr $fdt_addr';
1324     if (!$variables->{NO_BOOT} && $uboot_cmd ne '') {
1325         $uboot_cmd =~ s/\$kernel_addr/$uboot_addr{kernel}/g;
1326         $uboot_cmd =~ s/\$ramdisk_addr/$uboot_addr{ramdisk}/g;
1327         $uboot_cmd =~ s/\$fdt_addr/$uboot_addr{fdt}/g;
1328
1329         $exp->send($uboot_cmd . "\n");
1330         $exp->expect(5, "\n")  || die "U-Boot command: " . ($! || "timeout");
1331     }
1332 }
1333
1334 ### Serial line interaction
1335 if ($interaction && defined $exp) {
1336     # Serial line of the target is available
1337     my $interrupt = 'Ctrl-C';
1338     if ($interactive && !@exiton) {
1339         $interrupt = '"~~."';
1340     }
1341     print STDERR "novaboot: Serial line interaction (press $interrupt to interrupt)...\n";
1342     $exp->log_stdout(1);
1343     if (@exiton) {
1344         $exp->expect($exiton_timeout, @exiton, @expect_raw) || die("exiton: " . ($! || "timeout"));
1345     } else {
1346         my @inputs = ($exp);
1347         my $infile = new IO::File;
1348         $infile->IO::File::fdopen(*STDIN,'r');
1349         my $in_object = Expect->exp_init($infile);
1350         $in_object->set_group($exp);
1351
1352         if ($interactive) {
1353             $in_object->set_seq('~~\.', sub { print STDERR "novaboot: Escape sequence detected\r\n"; undef; });
1354             $in_object->manual_stty(0);   # Use raw terminal mode
1355         } else {
1356             $in_object->manual_stty(1);   # Do not modify terminal settings
1357         }
1358         push(@inputs, $in_object);
1359         #use Data::Dumper;
1360         #print Dumper(\@expect_raw);
1361         $exp->expect(undef, @expect_raw) if @expect_raw;
1362
1363         $^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.
1364         Expect::interconnect(@inputs) unless defined($exp->exitstatus);
1365         $^W = 1;
1366     }
1367 }
1368
1369 # When exp-spawned command ignores SIGHUP, Expect waits 5 seconds
1370 # before killing it. We kill it by SIGTERM immediately.
1371 kill TERM => $exp->pid if defined $exp && $exp->pid;
1372
1373 ## Kill dhcpc or tftpd
1374 if (defined $dhcp_tftp || defined $tftp) {
1375     die("novaboot: This should kill servers on background\n");
1376 }
1377
1378 # Always finish novaboot output with newline
1379 print "\n" if $final_eol;
1380
1381 ## Documentation
1382
1383 =encoding utf8
1384
1385 =head1 NAME
1386
1387 novaboot - Boots a locally compiled operating system on a remote
1388 target or in qemu
1389
1390 =head1 SYNOPSIS
1391
1392 B<novaboot> --help
1393
1394 B<novaboot> [option]... [--] script...
1395
1396 B<./script> [option]...
1397
1398 =head1 DESCRIPTION
1399
1400 Novaboot makes booting of a locally compiled operating system (OS)
1401 (e.g. NOVA or Linux) on remote targets as simple as running a program
1402 locally. It automates things like copying OS images to a TFTP server,
1403 generation of bootloader configuration files, resetting of target
1404 hardware or redirection of target's serial line to stdin/out. Novaboot
1405 is highly configurable and makes it easy to boot a single image on
1406 different targets or different images on a single target.
1407
1408 Novaboot operation is controlled by configuration files, command line
1409 options and by a so-called novaboot script, which can be thought as a
1410 generalization of bootloader configuration files (see L</"NOVABOOT
1411 SCRIPT SYNTAX">). The typical way of using novaboot is to make the
1412 novaboot script executable and set its first line to I<#!/usr/bin/env
1413 novaboot>. Then, booting a particular OS configuration becomes the
1414 same as executing a local program – the novaboot script.
1415
1416 Novaboot uses configuration files to, among other things, define
1417 command line options needed for different targets. Users typically use
1418 only the B<-t>/B<--target> command line option to select the target.
1419 Internally, this option expands to the pre-configured options.
1420 Novaboot searches configuration files at multiple places, which allows
1421 having per-system, per-user or per-project configurations.
1422 Configuration file syntax is described in section L</"CONFIGURATION
1423 FILES">.
1424
1425 Novaboot newcomers may be confused by a large number of configuration
1426 options. Understanding all these options is not always needed,
1427 depending on the used setup. The L<figure from the doc directory
1428 |https://github.com/wentasah/novaboot/blob/master/doc/typical-setups.svg>
1429 shows different setups that vary in how much effort is needed
1430 to configure novaboot for them. The setups are:
1431
1432 =over 3
1433
1434 =item A: Laptop and target device only
1435
1436 This requires to configure everything on the laptop side, including a
1437 serial line connection (L</--serial>, L</--remote-cmd>, ...), power
1438 on/off/reset commands (L</--reset-cmd>, ...), TFTP server
1439 (L</--copy>, L</--prefix>...), device IP addresses, etc.
1440
1441 =item B: Laptop, target device and external TFTP server
1442
1443 Like the previous setup, but the TFTP (and maybe DHCP) configuration
1444 is handled by a server. Novaboot users need to understand where to
1445 copy their files to the TFTP server (L</--copy>) and which IP
1446 addresses their target will get, but do not need to configure the
1447 servers themselves.
1448
1449 =item C: Novaboot server running novaboot-shell
1450
1451 With this setup, the configuration is done on the server. Users only
1452 need to know the SSH account (L</--ssh>) used to communicate between
1453 novaboot and novaboot server. The server is implemented as a
1454 restricted shell (L<novaboot-shell(1)>) on the server. No need to give
1455 full shell access to novaboot users on the server.
1456
1457 =back
1458
1459 =head2 Simple examples of using C<novaboot>:
1460
1461 To boot Linux (files F<bzImage> and F<rootfs.cpio> in current
1462 directory), create F<mylinux> file with this content:
1463
1464     #!/usr/bin/env novaboot
1465     load bzImage console=ttyS0,115200
1466     load rootfs.cpio
1467
1468 =over 3
1469
1470 =item 1.
1471
1472 Booting an OS in Qemu can be accomplished by giving the B<--qemu> option.
1473 Thus running
1474
1475  novaboot --qemu mylinux
1476
1477 (or C<./mylinux --qemu> as described above) will run Qemu and make it
1478 boot the configuration specified in the F<mylinux> script. How is qemu
1479 started can be configured in various ways (see below).
1480
1481 =item 2.
1482
1483 Create a bootloader configuration file (currently supported
1484 bootloaders are GRUB, GRUB2, ISOLINUX, Pulsar, and U-Boot) and copy it
1485 with all other files needed for booting to a remote TFTP server. Then
1486 use a TCP/IP-controlled relay/serial-to-TCP converter to reset the
1487 target and receive its serial output.
1488
1489  ./mylinux --grub2 --copy=192.168.1.1:/tftp --iprelay=192.168.1.2
1490
1491 Alternatively, you can put these switches to the configuration file
1492 and run:
1493
1494  ./mylinux --target mytarget
1495
1496 =item 3.
1497
1498 Specifying all the options needed by novaboot to successfully control
1499 the target, either on command line or in configuration files, can be
1500 difficult for users. Novaboot supports configuring the target
1501 centrally via L<novaboot-shell(1)> on a server. With such a
1502 configuration, users only need to use the B<--ssh> option to specify
1503 where to boot their OS:
1504
1505  ./mylinux --ssh myboard@example.com
1506
1507 Typically, the server is the computer connected to and controlling the
1508 target board and running the TFTP server.
1509
1510 =item 4.
1511
1512 Run DHCP and TFTP server on developer's machine to boot the target
1513 from it.
1514
1515  ./mylinux --dhcp-tftp
1516
1517 This usage is useful when no network infrastructure is in place, and
1518 the target is connected directly to developer's box.
1519
1520 =item 5.
1521
1522 Create bootable ISO image.
1523
1524  novaboot --iso -- script1 script2
1525
1526 The created ISO image will have ISOLINUX bootloader installed on it,
1527 and the boot menu will allow selecting between I<script1> and
1528 I<script2> configurations.
1529
1530 =back
1531
1532 =head1 OPTIONS AND PHASES
1533
1534 Novaboot performs its work in several phases. Command line options
1535 described bellow influence the execution of each phase or allow their
1536 skipping. The list of phases (in the execution order) is as follows.
1537
1538 =over
1539
1540 =item 1. L<Configuration reading|/Configuration reading phase>
1541
1542 =item 2. L<Command line processing|/Command line processing phase>
1543
1544 =item 3. L<Script preprocessing|/Script preprocessing phase>
1545
1546 =item 4. L<File generation|/File generation phase>
1547
1548 =item 5. L<Target connection|/Target connection check>
1549
1550 =item 6. L<File deployment|/File deployment phase>
1551
1552 =item 7. L<Target power-on and reset|/Target power-on and reset phase>
1553
1554 =item 8. L<Interaction with the bootloader|/Interaction with the bootloader on the target>
1555
1556 =item 9. L<Target interaction|/Target interaction phase>
1557
1558 =back
1559
1560 Each phase is described in the following sections together with the
1561 command line options that control it.
1562
1563 =head2 Configuration reading phase
1564
1565 After starting, novaboot reads zero or more configuration files. We
1566 describe their content in section L</"CONFIGURATION FILES">. By default, the
1567 configuration is read from multiple locations. First from the system
1568 configuration directory (F</etc/novaboot.d/>), second from the user
1569 configuration file (F<~/.config/novaboot>) and third from F<.novaboot>
1570 files along the path to the current directory. Alternatively, a single
1571 configuration file specified with the B<-c> switch or with the
1572 C<NOVABOOT_CONFIG> environment variable is read. The latter read files
1573 override settings from the former ones.
1574
1575 The system configuration directory is determined by the content of
1576 NOVABOOT_CONFIG_DIR environment variable and defaults to
1577 F</etc/novaboot.d>. Files in this directory with names consisting
1578 solely of English letters, numbers, dashes '-' and underscores '_'
1579 (note that dot '.' is not included) are read in alphabetical order.
1580
1581 Then, the user configuration file is read from
1582 F<$XDG_CONFIG_HOME/novaboot>. If C<$XDG_CONFIG_HOME> environment
1583 variable is not set F<~/.config/novaboot> is read instead.
1584
1585 Finally, novaboot searches for files named F<.novaboot> starting from the
1586 directory of the novaboot script (or working directory, see bellow)
1587 and continuing upwards up to the root directory. The found
1588 configuration files are then read in the opposite order (i.e. from the
1589 root directory downwards). This ordering allows having, for example, a project
1590 specific configuration in F<~/project/.novaboot>.
1591
1592 Note the difference between F<~/.config/novaboot> and F<~/.novaboot>.
1593 The former one is always read, whereas the latter only when novaboot
1594 script or working directory is under the C<$HOME> directory.
1595
1596 In certain cases, the location of the novaboot script cannot be
1597 determined in this early phase. This situation happens either when the script is
1598 read from the standard input or when novaboot is invoked explicitly as
1599 in the example L</"4."> above. In this case, the current working
1600 directory is used as a starting point for configuration file search
1601 instead of the novaboot script directory.
1602
1603 =over 8
1604
1605 =item -c, --config=I<filename>
1606
1607 Use the specified configuration file instead of the default one(s).
1608
1609 =back
1610
1611 =head2 Command line processing phase
1612
1613 =over 8
1614
1615 =item --dump-config
1616
1617 Dump the current configuration to stdout end exit. Useful as an
1618 initial template for a configuration file.
1619
1620 =item -h, --help
1621
1622 Print short (B<-h>) or long (B<--help>) help.
1623
1624 =item -t, --target=I<target>
1625
1626 This option serves as a user configurable shortcut for other novaboot
1627 options. The effect of this option is the same as specifying the
1628 options stored in the C<%targets> configuration variable under key
1629 I<target>. See also L</"CONFIGURATION FILES">.
1630
1631 When this option is not given, novaboot tries to determine the target
1632 to use from either B<NOVABOOT_TARGET> environment variable or
1633 B<$default_target> configuration file variable.
1634
1635 =item --ssh=I<user@hostname>
1636
1637 Configures novaboot to control the target via C<novaboot-shell>
1638 running remotely via SSH.
1639
1640 Using this option is the same as specifying B<--remote-cmd>,
1641 B<--remote-expect>, B<--copy> B<--rsync-flags>, B<--prefix> and
1642 B<--reset-cmd> manually in a way compatible with C<novaboot-shell>.
1643 The server can be configured to provide other, safe bootloader-related
1644 options, to the client. When this happens, novaboot prints them to
1645 stdout.
1646
1647 Currently, this in an initial experimental implementation. We plan to
1648 change/extend this feature soon!
1649
1650 =back
1651
1652 =head2 Script preprocessing phase
1653
1654 This phase allows modifying the parsed novaboot script before it is
1655 used in the later phases.
1656
1657 =over 8
1658
1659 =item -a, --append=I<parameters>
1660
1661 Append a string to the first C<load> line in the novaboot script. This option
1662 can be used to append parameters to the kernel's or root task's
1663 command line. This option can appear multiple times.
1664
1665 =item -b, --bender
1666
1667 Use L<Bender|https://github.com/TUD-OS/morbo/blob/master/standalone/bender.c>
1668 chainloader. Bender scans the PCI bus for PCI serial ports and stores
1669 the information about them in the BIOS data area for use by the
1670 kernel.
1671
1672 =item --chainloader=I<chainloader>
1673
1674 Specifies a chainloader that is loaded before the kernel and other
1675 files specified in the novaboot script. E.g. 'bin/boot/bender
1676 promisc'.
1677
1678 =item --dump
1679
1680 Print the modules to boot and their parameters, after this phase
1681 finishes. Then exit. This is useful for seeing the effect of other
1682 options in this section.
1683
1684 =item -k, --kernel=F<file>
1685
1686 Replace the first word on the first C<load> line in the novaboot
1687 script with F<file>.
1688
1689 =item --scriptmod=I<Perl expression>
1690
1691 When novaboot reads the script, I<Perl expression> is executed for every
1692 line (in $_ variable). For example, C<novaboot
1693 --scriptmod=s/sigma0/omega6/g> replaces every occurrence of I<sigma0>
1694 in the script with I<omega6>.
1695
1696 When this option is present, it overrides I<$script_modifier> variable
1697 from the configuration file, which has the same effect. If this option
1698 is given multiple times all expressions are evaluated in the command
1699 line order.
1700
1701 =back
1702
1703 =head2 File generation phase
1704
1705 In this phase, files needed for booting are generated in a so-called
1706 I<build directory> (see L</--build-dir>). In most cases configuration
1707 for a bootloader is generated automatically by novaboot. It is also
1708 possible to generate other files using I<heredoc> or I<"<"> syntax in
1709 novaboot scripts. Finally, novaboot can generate binaries in this phases by
1710 running C<scons> or C<make>.
1711
1712 =over 8
1713
1714 =item --build-dir=I<directory>
1715
1716 Overrides the default build directory location.
1717
1718 The default build directory location is determined as follows: If the
1719 configuration file defines the C<$builddir> variable, its value is
1720 used. Otherwise, it is the directory that contains the first processed
1721 novaboot script.
1722
1723 See also L</BUILDDIR> variable.
1724
1725 =item -g, --grub[=I<filename>]
1726
1727 Generates grub bootloader menu file. If the I<filename> is not
1728 specified, F<menu.lst> is used. The I<filename> is relative to the
1729 build directory (see B<--build-dir>).
1730
1731 =item --grub-preamble=I<prefix>
1732
1733 Specifies the I<preamble> that is at the beginning of the generated
1734 GRUB or GRUB2 config files. This is useful for specifying GRUB's
1735 timeout.
1736
1737 =item --prefix=I<prefix>
1738
1739 Specifies I<prefix> (e.g. F</srv/tftp>) that is put in front of every
1740 filename in generated bootloader configuration files (or in U-Boot
1741 commands).
1742
1743 If the I<prefix> contains string $NAME, it will be replaced with the
1744 name of the novaboot script (see also B<--name>).
1745
1746 If the I<prefix> contains string $BUILDDIR, it will be replaced with
1747 the build directory (see also B<--build-dir>).
1748
1749 =item --grub-prefix
1750
1751 Alias for B<--prefix>.
1752
1753 =item --grub2[=I<filename>]
1754
1755 Generate GRUB2 menu entry in I<filename>. If I<filename> is not
1756 specified F<./boot/grub/grub.cfg> is used. The content of the menu entry can be
1757 customized with B<--grub-preamble>, B<--grub2-prolog> or
1758 B<--grub_prefix> options.
1759
1760 GRUB2 can boot multiboot-compliant kernels and a few kernels with specific
1761 support. L</BOOT_METHOD> could be used to specify the command used by GRUB2 to
1762 load the kernel. See L<GNU GRUB Manual|https://www.gnu.org/software/grub/manual/grub/grub.html#Booting>.
1763
1764 To use the generated menu entry on your development
1765 machine that uses GRUB2, append the following snippet to
1766 F</etc/grub.d/40_custom> file and regenerate your grub configuration,
1767 i.e. run update-grub on Debian/Ubuntu.
1768
1769   if [ -f /path/to/nul/build/grub.cfg ]; then
1770     source /path/to/nul/build/grub.cfg
1771   fi
1772
1773 =item --grub2-prolog=I<prolog>
1774
1775 Specifies the text that novaboot puts at the beginning of the GRUB2 menu entry.
1776
1777 =item -m, --make[=make command]
1778
1779 Runs C<make> to build files that are not generated by novaboot itself.
1780
1781 =item --name=I<string>
1782
1783 Use the name I<string> instead of the name of the novaboot script.
1784 This name is used for things like a title of grub menu or for the
1785 server directory where the boot files are copied to.
1786
1787 =item --no-file-gen
1788
1789 Do not run external commands to generate files (i.e. "<" syntax and
1790 C<run> keyword). This switch does not influence the generation of files
1791 specified with "<<WORD" syntax.
1792
1793 =item -p, --pulsar[=mac]
1794
1795 Generates pulsar bootloader configuration file named F<config-I<mac>>
1796 The I<mac> string is typically a MAC address and defaults to
1797 I<novaboot>.
1798
1799 =item --scons[=scons command]
1800
1801 Runs C<scons> to build files that are not generated by novaboot
1802 itself.
1803
1804 =item --strip-rom
1805
1806 Strip I<rom://> prefix from command lines and generated config files.
1807 The I<rom://> prefix is used by NUL. For NRE, it has to be stripped.
1808
1809 =item --gen-only
1810
1811 Exit novaboot after file generation phase.
1812
1813 =back
1814
1815 =head2 Target connection check
1816
1817 In this phase novaboot connects to target's serial port (if it has
1818 one). If another novaboot user/instance occupies the target, novaboot
1819 exits here with an error message.
1820
1821 =over 8
1822
1823 =item --amt=I<"[user[:password]@]host[:port]>
1824
1825 Use Intel AMT technology to control the target machine. WS management
1826 is used to powercycle it and Serial-Over-Lan (SOL) for input/output.
1827 The hostname or (IP address) is given by the I<host> parameter. If the
1828 I<password> is not specified, environment variable AMT_PASSWORD is
1829 used. The I<port> specifies a TCP port for SOL. If not specified, the
1830 default is 16992. The default I<user> is admin.
1831
1832 =item --iprelay=I<addr[:port]>
1833
1834 Use TCP/IP relay and serial port to access the target's serial port
1835 and powercycle it. The I<addr> parameter specifies the IP address of
1836 the relay. If I<port> is not specified, it defaults to 23.
1837
1838 Note: This option is supposed to work with HWG-ER02a IP relays.
1839
1840 =item --iprelay-cmd=I<command>
1841
1842 Similar to B<--iprelay> but uses I<command> to talk to the iprelay
1843 rather than direct network connection.
1844
1845 =item -s, --serial[=device]
1846
1847 Target's serial line is connected to host's serial line (device). The
1848 default value for device is F</dev/ttyUSB0>.
1849
1850 The value of this option is exported in NB_NOVABOOT environment
1851 variable to all subprocesses run by C<novaboot>.
1852
1853 =item --stty=I<settings>
1854
1855 Specifies settings passed to C<stty> invoked on the serial line
1856 specified with B<--serial> option. If this option is not given,
1857 C<stty> is called with C<raw -crtscts -onlcr 115200> settings.
1858
1859 =item --remote-cmd=I<cmd>
1860
1861 Command that mediates connection to the target's serial line. For
1862 example C<ssh server 'cu -l /dev/ttyS0'>.
1863
1864 =item --remote-expect=I<string>
1865
1866 Wait for reception of I<string> after establishing the remote serial
1867 line connection. Novaboot assumes that after establishing the serial
1868 line connection, the user running novaboot has exclusive access to the
1869 target. If establishing of the serial line connection happens
1870 asynchronously (e.g. running a command remotely via SSH), we need this
1871 option to wait until the exclusive access is confirmed by the remote
1872 side.
1873
1874 Depending on target configuration, this option can solve two practical
1875 problems: 1) Overwriting of files deployed by another user currently
1876 using the target. 2) Resetting the target board before serial line
1877 connection is established and thus missing bootloader interaction.
1878
1879 Example of usage with the L<sterm
1880 tool|https://rtime.felk.cvut.cz/gitweb/sojka/sterm.git>:
1881
1882   --remote-cmd='ssh -tt example.com sterm -v /dev/ttyUSB0' --remote-expect='sterm: Connected'
1883
1884 =item --remote-expect-silent=I<string>
1885
1886 The same as B<--remote-expect> except that the remote output is not
1887 echoed to stdout while waiting for the I<string>. Everything after the
1888 matched string is printed to stdout, so you may want to include line
1889 end characters in the I<string> as well.
1890
1891 =item --remote-expect-timeout=I<seconds>
1892
1893 Timeout in seconds for B<--remote-expect> or
1894 B<--remote-expect-seconds>. When negative, waits forever. The default
1895 is -1 seconds.
1896
1897 =back
1898
1899 =head2 File deployment phase
1900
1901 In some setups, it is necessary to copy the files needed for booting
1902 to a particular location, e.g. to a TFTP boot server or to the
1903 F</boot> partition.
1904
1905 =over 8
1906
1907 =item -d, --dhcp-tftp
1908
1909 Turns your workstation into a DHCP and TFTP server so that the OS can
1910 be booted via PXE BIOS (or similar mechanism) on the test machine
1911 directly connected by a plain Ethernet cable to your workstation.
1912
1913 The DHCP and TFTP servers require root privileges and C<novaboot>
1914 uses C<sudo> command to obtain those. You can put the following to
1915 I</etc/sudoers> to allow running the necessary commands without asking
1916 for a password.
1917
1918  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
1919  your_login ALL=NOPASSWD: NOVABOOT
1920
1921 =item --tftp
1922
1923 Starts a TFTP server on your workstation. This is similar to
1924 B<--dhcp-tftp> except that DHCP server is not started.
1925
1926 The TFTP server requires root privileges and C<novaboot> uses C<sudo>
1927 command to obtain those. You can put the following to I</etc/sudoers>
1928 to allow running the necessary commands without asking for a password.
1929
1930  Cmnd_Alias NOVABOOT =  /usr/sbin/in.tftpd --listen --secure -v -v -v --pidfile tftpd.pid *, /usr/bin/pkill --pidfile=tftpd.pid
1931  your_login ALL=NOPASSWD: NOVABOOT
1932
1933 =item --tftp-port=I<port>
1934
1935 Port to run the TFTP server on. Implies B<--tftp>.
1936
1937 =item --netif=I<network interface>
1938
1939 Network interface used to deploy files to the target. This option
1940 influences the configuration of the DHCP server started by
1941 B<--dhcp-tftp> and the value that B<$NB_MYIP> get replaced with during
1942 U-Boot conversation. The default value is C<$netif> variable from
1943 configuration files, which defaults to I<eth0>.
1944
1945 =item --iso[=filename]
1946
1947 Generates the ISO image that boots NOVA system via GRUB. If no filename
1948 is given, the image is stored under I<NAME>.iso, where I<NAME> is the name
1949 of the novaboot script (see also B<--name>).
1950
1951 =item --server[=[[user@]server:]path]
1952
1953 Alias of B<--copy> (kept for backward compatibility).
1954
1955 =item --copy[=[[user@]server:]path]
1956
1957 Copy all files needed for booting to another location. The files will
1958 be copied (by B<rsync> tool) to the directory I<path>. If the I<path>
1959 contains string $NAME, it will be replaced with the name of the
1960 novaboot script (see also B<--name>).
1961
1962 =item --rsync-flags=I<flags>
1963
1964 Specifies I<flags> to append to F<rsync> command line when
1965 copying files as a result of I<--copy> option.
1966
1967 =item --concat
1968
1969 If B<--copy> is used and its value ends with $NAME, then after
1970 copying the files, a new bootloader configuration file (e.g. menu.lst)
1971 is created at I<path-wo-name>, i.e. the path specified by B<--copy>
1972 with $NAME part removed. The content of the file is created by
1973 concatenating all files of the same name from all subdirectories of
1974 I<path-wo-name> found on the "server".
1975
1976 =item --ider
1977
1978 Use Intel AMT technology for IDE redirection. This allows the target
1979 machine to boot from novaboot created ISO image. Implies B<--iso>.
1980
1981 The experimental C<amtider> utility needed by this option can be
1982 obtained from https://github.com/wentasah/amtterm.
1983
1984 =back
1985
1986 =head2 Target power-on and reset phase
1987
1988 At this point, the target is reset (or switched on/off). There are
1989 several ways how this can be accomplished. Resetting a physical target
1990 can currently be accomplished by the following options: B<--amt>,
1991 B<--iprelay>, B<--reset-cmd> and B<--reset-send>.
1992
1993 =over 8
1994
1995 =item --on, --off
1996
1997 Switch on/off the target machine and exit. The script (if any) is
1998 completely ignored. Currently, it works only with the following
1999 options: B<--iprelay>, B<--amt>, B<--ssh>.
2000
2001 =item -Q, --qemu[=I<qemu-binary>]
2002
2003 Boot the configuration in qemu. Optionally, the name of qemu binary
2004 can be specified as a parameter.
2005
2006 =item --qemu-append=I<flags>
2007
2008 Append I<flags> to the default qemu flags (QEMU_FLAGS variable or
2009 C<-cpu coreduo -smp 2>).
2010
2011 =item -q, --qemu-flags=I<flags>
2012
2013 Replace the default qemu flags (QEMU_FLAGS variable or C<-cpu coreduo
2014 -smp 2>) with I<flags> specified here.
2015
2016 =item --reset-cmd=I<cmd>
2017
2018 Runs command I<cmd> to reset the target.
2019
2020 =item --reset-send=I<string>
2021
2022 Reset the target by sending the given I<string> to the remote serial
2023 line. "\n" sequences are replaced with the newline character.
2024
2025 =item --no-reset, --reset
2026
2027 Disable/enable resetting of the target.
2028
2029 =back
2030
2031 =head2 Interaction with the bootloader on the target
2032
2033 =over 8
2034
2035 =item --uboot[=I<prompt>]
2036
2037 Interact with U-Boot bootloader to boot the thing described in the
2038 novaboot script. I<prompt> specifies the U-Boot's prompt (default is
2039 "=> ", other common prompts are "U-Boot> " or "U-Boot# ").
2040
2041 =item --no-uboot
2042
2043 Disable U-Boot interaction previously enabled with B<--uboot>.
2044
2045 =item --uboot-stop-key=I<key>
2046
2047 Character, which is sent as a response to U-Boot's "Hit any key to
2048 stop autoboot" message. The default value is newline, but some devices
2049 (e.g. TP-Link TD-W8970) require a specific key to be pressed.
2050
2051 =item --uboot-init
2052
2053 Command(s) to send the U-Boot bootloader before loading the images and
2054 booting them. This option can be given multiple times. After sending
2055 commands from each option novaboot waits for U-Boot I<prompt>.
2056
2057 If the command contains string I<$NB_MYIP> then this string is
2058 replaced by IPv4 address of eth0 interface (see also B<--netif>).
2059 Similarly, I<$NB_PREFIX> is replaced with prefix given by B<--prefix>.
2060
2061 See also C<uboot> keyword in L</"NOVABOOT SCRIPT SYNTAX">).
2062
2063 =item --uboot-addr I<name>=I<address>
2064
2065 Load address of U-Boot's C<tftpboot> command for loading I<name>,
2066 where name is one of I<kernel>, I<ramdisk> or I<fdt> (flattened device
2067 tree).
2068
2069 The default addresses are ${I<name>_addr_r}, i.e. U-Boot environment
2070 variables used by convention for this purpose.
2071
2072 =item --uboot-cmd=I<command>
2073
2074 Specifies U-Boot command used to execute the OS. If the command
2075 contains strings C<$kernel_addr>, C<$ramdisk_addr>, C<$fdt_addr>,
2076 these are replaced with the addresses configured with B<--uboot-addr>.
2077
2078 The default value is
2079
2080     bootm $kernel_addr $ramdisk_addr $fdt_addr
2081
2082 or the C<UBOOT_CMD> variable if defined in the novaboot script.
2083
2084 =back
2085
2086 =head2 Target interaction phase
2087
2088 In this phase, target's serial output is redirected to stdout and if
2089 stdin is a TTY, it is redirected to the target's serial input allowing
2090 interactive work with the target.
2091
2092 =over 8
2093
2094 =item --exiton=I<string>
2095
2096 When the I<string> is sent by the target, novaboot exits. This option can
2097 be specified multiple times, in which case novaboot exits whenever
2098 either of the specified strings is sent.
2099
2100 If the I<string> is C<-re>, then the next B<--exiton>'s I<string> is
2101 treated as a regular expression. For example:
2102
2103     --exiton -re --exiton 'error:.*failed'
2104
2105 =item --exiton-re=I<regex>
2106
2107 The same as --exiton -re --exiton I<regex>.
2108
2109 =item --exiton-timeout=I<seconds>
2110
2111 By default B<--exiton> waits for the string match forever. When this
2112 option is specified, "exiton" timeouts after the specified number of
2113 seconds and novaboot returns non-zero exit code.
2114
2115 =item -i, --interactive
2116
2117 Setup things for the interactive use of the target. Your terminal will
2118 be switched to raw mode. In raw mode, your local terminal does not
2119 process input in any way (no echoing of entered characters, no
2120 interpretation of special characters). This, among others, means that
2121 Ctrl-C is passed to the target and does not interrupt novaboot. To
2122 exit from novaboot interactive mode type "~~.".
2123
2124 =item --no-interaction, --interaction
2125
2126 Skip resp. force target interaction phase. When skipped, novaboot exits
2127 immediately after the boot is initiated.
2128
2129 =item --expect=I<string>
2130
2131 When the I<string> is received from the target, send the string specified
2132 with the subsequent B<--send*> option to the target.
2133
2134 =item --expect-re=I<regex>
2135
2136 When target's output matches regular expression I<regex>, send the
2137 string specified with the subsequent B<--send*> option to the target.
2138
2139 =item --expect-raw=I<perl-code>
2140
2141 Provides direct control over Perl's Expect module.
2142
2143 =item --send=I<string>
2144
2145 Send I<string> to the target after the previously specified
2146 B<--expect*> was matched in the target's output. The I<string> may
2147 contain escape sequences such as "\n".
2148
2149 Note that I<string> is actually interpreted by Perl, so it can contain
2150 much more that escape sequences. This behavior may change in the
2151 future.
2152
2153 Example: C<--expect='login: ' --send='root\n'>
2154
2155 =item --sendcont=I<string>
2156
2157 Similar to B<--send> but continue expecting more input.
2158
2159 Example: C<--expect='Continue?' --sendcont='yes\n'>
2160
2161 =item --final-eol, --no-final-eol
2162
2163 By default, B<novaboot> always prints an end-of-line character at the
2164 end of its execution in order to ensure that the output of programs
2165 started after novaboot appears at the beginning of the line. When this
2166 is not desired B<--no-final-eol> option can be used to override this
2167 behavior.
2168
2169 =back
2170
2171 =head1 NOVABOOT SCRIPT SYNTAX
2172
2173 The syntax tries to mimic POSIX shell syntax. The syntax is defined
2174 by the following rules.
2175
2176 Lines starting with "#" and empty lines are ignored.
2177
2178 Lines that end with "\" are concatenated with the following line after
2179 removal of the final "\" and leading whitespace of the following line.
2180
2181 Lines of the form I<VARIABLE=...> (i.e. matching '^[A-Z_]+=' regular
2182 expression) assign values to internal variables. See L</VARIABLES>
2183 section.
2184
2185 Otherwise, the first word on the line defines the meaning of the line.
2186 The following keywords are supported:
2187
2188 =over 4
2189
2190 =item C<load>
2191
2192 These lines represent modules to boot. The
2193 word after C<load> is a file name (relative to the build directory
2194 (see B<--build-dir>) of the module to load and the remaining words are
2195 passed to it as the command line parameters.
2196
2197 When booting Linux, the first C<load> line usually refers to the
2198 kernel image and its command line parameters (unless you use some
2199 special pre-loader). Other C<load> lines may refer to an initramfs
2200 image and/or a device tree blob. Their order is not important, as the
2201 device tree is recognized as the file name ending with C<.dtb>.
2202
2203 When the C<load> line ends with "<<WORD" then the subsequent lines
2204 until the line containing solely WORD are copied literally to the file
2205 named on that line. This is similar to the heredoc feature of UNIX
2206 shells.
2207
2208 When the C<load> line ends with "< CMD" then command CMD is executed
2209 with F</bin/sh> and its standard output is stored in the file named on
2210 that line. The SRCDIR variable in CMD's environment is set to the
2211 absolute path of the directory containing the interpreted novaboot
2212 script.
2213
2214 =item C<copy>
2215
2216 These lines are similar to C<load> lines. The
2217 file mentioned there is copied to the same place as in the case of C<load>
2218 (e.g. tftp server), but the file is not used in the bootloader
2219 configuration. Such a file can be used by the target for other
2220 purposes than booting, e.g. at OS runtime or for firmware update.
2221
2222 =item C<chld>
2223
2224 Chainload another bootloader. Instead of loading multiboot modules
2225 identified with C<load> keyword, run another bootloader. This is
2226 currently supported only by pulsar and can be used to load e.g. Grub
2227 as in the example below:
2228
2229  chld boot/grub/i386-pc/core.0
2230
2231
2232 =item C<run>
2233
2234 Lines starting with C<run> keyword contain shell commands that are run
2235 during file generation phase. This is the same as the "< CMD" syntax
2236 for C<load> keyboard except that the command's output is not
2237 redirected to a file. The ordering of commands is the same as they
2238 appear in the novaboot script.
2239
2240 =item C<uboot>
2241
2242 These lines represent U-Boot commands that are sent to the target if
2243 B<--uboot> option is given. Having a U-Boot line in the novaboot
2244 script is the same as giving B<--uboot-init> option to novaboot. The
2245 following syntax variants are supported:
2246
2247
2248   uboot[:<timeout>] <string> [> <file>]
2249   uboot[:<timeout>] < <shell> [> <file>]
2250
2251 C<string> is the literal U-Boot command.
2252
2253 The C<uboot> keyword can be suffixed with timeout specification. The
2254 syntax is C<uboot:Ns>, where C<N> is the whole number of seconds. If
2255 the U-Boot command prompt does not appear before the timeout, novaboot
2256 fails. The default timeout is 10 seconds.
2257
2258 In the second variant with the C<<> character the shell code is
2259 executed and its standard output is sent to U-Boot. Example:
2260
2261   uboot < printf "mmc write \$loadaddr 1 %x" $(($(/usr/bin/stat -c%s rootfs.ext4) / 512))
2262
2263 When C<E<gt> file> part is present, the output of the U-Boot command
2264 is written into the given file.
2265
2266 =back
2267
2268 Example (Linux):
2269
2270   #!/usr/bin/env novaboot
2271   load bzImage console=ttyS0,115200
2272   run  make -C buildroot
2273   load rootfs.cpio < gen_cpio buildroot/images/rootfs.cpio "myapp->/etc/init.d/S99myapp"
2274
2275 Example (NOVA User Land - NUL):
2276
2277   #!/usr/bin/env novaboot
2278   WVDESC=Example program
2279   load bin/apps/sigma0.nul S0_DEFAULT script_start:1,1 \
2280                            verbose hostkeyb:0,0x60,1,12,2
2281   load bin/apps/hello.nul
2282   load hello.nulconfig <<EOF
2283   sigma0::mem:16 name::/s0/log name::/s0/timer name::/s0/fs/rom ||
2284   rom://bin/apps/hello.nul
2285   EOF
2286
2287 This example will load three modules: F<sigma0.nul>, F<hello.nul> and
2288 F<hello.nulconfig>. sigma0 receives some command line parameters and
2289 F<hello.nulconfig> file is generated on the fly from the lines between
2290 C<<<EOF> and C<EOF>.
2291
2292 Example (Zynq system update via U-Boot):
2293
2294   #!/usr/bin/env novaboot
2295
2296   uboot dhcp
2297
2298   # Write kernel to FAT filesystem on the 1st SD card partition
2299   run mkimage -f uboot-image.its image.ub
2300   copy image.ub
2301   uboot:60s tftpboot ${loadaddr} $NB_PREFIX/image.ub
2302   uboot fatwrite mmc 0:1 ${loadaddr} image.ub $filesize
2303   uboot set bootargs console=ttyPS0,115200 root=/dev/mmcblk0p2
2304
2305   # Write root FS image to the 2nd SD card partition
2306   copy rootfs/images/rootfs.ext4
2307   uboot:60s tftpboot ${loadaddr} $NB_PREFIX/rootfs/images/rootfs.ext4
2308   uboot mmc part > mmc-part.txt
2309   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))
2310
2311   UBOOT_CMD=boot
2312
2313
2314 =head2 VARIABLES
2315
2316 The following variables are interpreted in the novaboot script:
2317
2318 =over 8
2319
2320 =item BOOT_METHOD
2321
2322 Specifies the way GRUB2 boots the kernel. For kernels with multiboot
2323 support use C<multiboot> method (the default). For Linux kernel use C<linux> method.
2324
2325 =item BUILDDIR
2326
2327 Novaboot chdir()s to this directory before file generation phase. The
2328 directory name specified here is relative to the build directory
2329 specified by other means (see L</--build-dir>).
2330
2331 =item EXITON
2332
2333 Assigning this variable has the same effect as specifying L</--exiton>
2334 option.
2335
2336 =item INTERACTION
2337
2338 Setting this variable to zero is the same as giving
2339 L</--no-interaction>, specifying to one corresponds to
2340 L</--interaction>.
2341
2342 =item HYPERVISOR_PARAMS
2343
2344 Parameters passed to the hypervisor. The default value is "serial", unless
2345 overridden in the configuration file.
2346
2347 =item KERNEL
2348
2349 The kernel to use instead of the hypervisor specified in the
2350 configuration file with the C<$hypervisor> variable. The value should
2351 contain the name of the kernel image as well as its command line
2352 parameters. If this variable is defined and non-empty, the variable
2353 HYPERVISOR_PARAMS is not used.
2354
2355 =item NO_BOOT
2356
2357 If this variable is 1, the system is not booted. This is currently
2358 only implemented for U-Boot bootloader where it is useful for
2359 interacting with the bootloader without booting the system - e.g. for
2360 flashing.
2361
2362 =item QEMU
2363
2364 Use a specific qemu binary (can be overridden with B<-Q>) and flags
2365 when booting this script under qemu. If QEMU_FLAGS variable is also
2366 specified flags specified in QEMU variable are replaced by those in
2367 QEMU_FLAGS.
2368
2369 =item QEMU_FLAGS
2370
2371 Use specific qemu flags (can be overridden with B<-q>).
2372
2373 =item UBOOT_CMD
2374
2375 See L</--uboot-cmd>.
2376
2377 =item WVDESC
2378
2379 Description of the WvTest-compliant program.
2380
2381 =item WVTEST_TIMEOUT
2382
2383 The timeout in seconds for WvTest harness. If no complete line appears
2384 in the test output within the time specified here, the test fails. It
2385 is necessary to specify this for long running tests that produce no
2386 intermediate output.
2387
2388 =back
2389
2390 =head1 CONFIGURATION FILES
2391
2392 Novaboot can read its configuration from one or more files. By
2393 default, novaboot looks for files in F</etc/novaboot.d>, file
2394 F<~/.config/novaboot> and files named F<.novaboot> as described in
2395 L</Configuration reading phase>. Alternatively, configuration file
2396 location can be specified with the B<-c> switch or with the
2397 NOVABOOT_CONFIG environment variable. The configuration file has Perl
2398 syntax (i.e. it is better to put C<1;> as the last line) and should set
2399 values of certain Perl variables. The current configuration can be
2400 dumped with the B<--dump-config> switch. Some configuration variables
2401 can be overridden by environment variables (see below) or by command
2402 line switches.
2403
2404 Supported configuration variables include:
2405
2406 =over 8
2407
2408 =item $builddir
2409
2410 Build directory location relative to the location of the configuration
2411 file.
2412
2413 =item $default_target
2414
2415 Default target (see below) to use when no target is explicitly
2416 specified with the B<--target> command line option or
2417 B<NOVABOOT_TARGET> environment variable.
2418
2419 =item $netif
2420
2421 Default value for the B<--netif> option. If not specified, it defaults
2422 to I<eth0>.
2423
2424 =item %targets
2425
2426 Hash of target definitions to be used with the B<--target> option. The
2427 key is the identifier of the target, the value is the string with
2428 command line options. For instance, if the configuration file contains:
2429
2430  $targets{'mybox'} = '--copy=boot:/tftproot --serial=/dev/ttyUSB0 --grub',
2431
2432 then the following two commands are equivalent:
2433
2434  ./myos --copy=boot:/tftproot --serial=/dev/ttyUSB0 --grub
2435  ./myos -t mybox
2436
2437 =back
2438
2439 =head1 ENVIRONMENT VARIABLES
2440
2441 Some options can be specified not only via config file or command line
2442 but also through environment variables. Environment variables override
2443 the values from the configuration file and command line parameters
2444 override the environment variables.
2445
2446 =over 8
2447
2448 =item NOVABOOT_CONFIG
2449
2450 Name of the novaboot configuration file to use instead of the default
2451 one(s).
2452
2453 =item NOVABOOT_CONFIG_DIR
2454
2455 Name of the novaboot configuration directory. When not specified
2456 F</etc/novaboot.d> is used.
2457
2458 =item NOVABOOT_TARGET
2459
2460 Name of the novaboot target to use. This overrides the value of
2461 B<$default_target> from the configuration file and can be overridden
2462 with the B<--target> command line option.
2463
2464 =item NOVABOOT_BENDER
2465
2466 Defining this variable has the same effect as using B<--bender>
2467 option.
2468
2469 =back
2470
2471 =head1 AUTHORS
2472
2473 Michal Sojka <sojka@os.inf.tu-dresden.de>
2474
2475 Latest novaboot version can be found at
2476 L<https://github.com/wentasah/novaboot>.
2477
2478 =cut
2479
2480 # LocalWords:  novaboot Novaboot NOVABOOT TFTP PXE DHCP filename stty
2481 # LocalWords:  chainloader stdout Qemu qemu preprocessing ISOLINUX bootable
2482 # LocalWords:  config subprocesses sudo sudoers tftp dhcp IDE stdin
2483 # LocalWords:  subdirectories TTY whitespace heredoc POSIX WvTest