novaboot

   1 #!/usr/bin/perl -w
   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 IO::Handle;
  26 use Time::HiRes("usleep");
  27 use Socket;
  28 use FileHandle;
  29 use IPC::Open2;
  30 use POSIX qw(:errno_h sysconf);
  31 use Cwd qw(getcwd abs_path);
  32 use Expect;
  33
  34 # always flush
  35 $| = 1;
  36
  37 my $invocation_dir = $ENV{PWD} || getcwd();
  38
  39 ## Configuration file handling
  40
  41 # Default configuration
  42 $CFG::hypervisor = "";
  43 $CFG::hypervisor_params = "serial";
  44 $CFG::genisoimage = "genisoimage";
  45 $CFG::qemu = 'qemu-system-i386 -cpu coreduo -smp 2';
  46 $CFG::default_target = '';
  47 %CFG::targets = (
  48     'qemu' => '--qemu',
  49     "tud" => '--server=erwin.inf.tu-dresden.de:~sojka/boot/novaboot --rsync-flags="--chmod=Dg+s,ug+w,o-w,+rX --rsync-path=\"umask 002 && rsync\"" --grub --grub-prefix=(nd)/tftpboot/sojka/novaboot --grub-preamble="timeout 0" --concat --iprelay=141.76.48.80:2324 --scriptmod=s/\\\\bhostserial\\\\b/hostserialpci/g',
  50     "novabox" => '--server=rtime.felk.cvut.cz:/srv/tftp/novaboot --rsync-flags="--chmod=Dg+s,ug+w,o-w,+rX --rsync-path=\"umask 002 && rsync\"" --pulsar --iprelay=147.32.86.92:2324',
  51     "localhost" => '--scriptmod=s/console=tty[A-Z0-9,]+// --server=/boot/novaboot/$NAME --grub2 --grub-prefix=/boot/novaboot/$NAME --grub2-prolog="  set root=\'(hd0,msdos1)\'"',
  52     "ryu" =>  '--uboot --uboot-init="mw f0000b00 \${psc_cfg}; sleep 1" --uboot-addr kernel=800000 --uboot-addr ramdisk=b00000 --uboot-addr fdt=7f0000',
  53     "ryuglab" => '--target ryu --server=pc-sojkam.felk.cvut.cz:/srv/tftp --remote-cmd="ssh -tt pc-sojkam.felk.cvut.cz \"sterm -d -s 115200 /dev/ttyUSB0\""',
  54     "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"',
  55     );
  56
  57 {
  58     my %const;
  59     $const{linux}->{_SC_NPROCESSORS_CONF} = 83;
  60     my $nproc = sysconf($const{$^O}->{_SC_NPROCESSORS_CONF});
  61
  62     $CFG::scons = "scons -j$nproc";
  63     $CFG::make = "make -j$nproc";
  64 }
  65
  66 my $builddir;
  67
  68 sub read_config($) {
  69     my ($cfg) = @_;
  70     {
  71         package CFG; # Put config data into a separate namespace
  72
  73         my $rc = do($cfg);
  74
  75         # Check for errors
  76         if ($@) {
  77             die("ERROR: Failure compiling '$cfg' - $@");
  78         } elsif (! defined($rc)) {
  79             die("ERROR: Failure reading '$cfg' - $!");
  80         } elsif (! $rc) {
  81             die("ERROR: Failure processing '$cfg'");
  82         }
  83     }
  84     $builddir = File::Spec->rel2abs($CFG::builddir, dirname($cfg)) if defined $CFG::builddir;
  85     print STDERR "novaboot: Read $cfg\n";
  86 }
  87
  88 my @cfgs;
  89 {
  90     # We don't use $0 here, because it points to the novaboot itself and
  91     # not to the novaboot script. The problem with this approach is that
  92     # when a script is run as "novaboot <options> <script>" then $ARGV[0]
  93     # contains the first option. Hence the -f check.
  94     my $dir = File::Spec->rel2abs($ARGV[0] && -f $ARGV[0] ? dirname($ARGV[0]) : '', $invocation_dir);
  95     while ((-d $dir || -l $dir ) && $dir ne "/") {
  96         push @cfgs, "$dir/.novaboot" if -r "$dir/.novaboot";
  97         my @dirs = File::Spec->splitdir($dir);
  98         $dir = File::Spec->catdir(@dirs[0..$#dirs-1]);
  99     }
 100     @cfgs = reverse @cfgs;
 101
 102     my $xdg_config_home = $ENV{'XDG_CONFIG_HOME'} || $ENV{'HOME'}.'/.config';
 103     unshift(@cfgs, "$xdg_config_home/novaboot") if -r "$xdg_config_home/novaboot";
 104
 105     $dir = $ENV{'NOVABOOT_CONFIG_DIR'} || '/etc/novaboot.d';
 106     if (opendir(my $dh, $dir)) {
 107         my @etccfg = map { "$dir/$_" } grep { /^[-_a-zA-Z0-9]+$/ && -f "$dir/$_" } readdir($dh);
 108         closedir $dh;
 109         @etccfg = sort(@etccfg);
 110         @cfgs = ( @etccfg, @cfgs );
 111     }
 112 }
 113 my $cfg = $ENV{'NOVABOOT_CONFIG'};
 114 Getopt::Long::Configure(qw/no_ignore_case pass_through/);
 115 GetOptions ("config|c=s" => \$cfg);
 116 read_config($_) foreach $cfg or @cfgs;
 117
 118 ## Command line handling
 119
 120 my $explicit_target = $ENV{'NOVABOOT_TARGET'};
 121 GetOptions ("target|t=s" => \$explicit_target);
 122
 123 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, $iso_image, $interactive, $kernel_opt, $make, $man, $no_file_gen, $off_opt, $on_opt, $pulsar, $pulsar_root, $qemu, $qemu_append, $qemu_flags_cmd, $remote_cmd, $remote_expect, $remote_expect_silent, $reset, $reset_cmd, $rom_prefix, $rsync_flags, @scriptmod, $scons, $serial, $server, $stty, $tftp, $tftp_port, $uboot, %uboot_addr, $uboot_cmd, @uboot_init);
 124
 125 # Default values of certain command line options
 126 %uboot_addr = (
 127     'kernel'  => '${kernel_addr_r}',
 128     'ramdisk' => '${ramdisk_addr_r}',
 129     'fdt'     => '${fdt_addr_r}',
 130     );
 131 $rsync_flags = '';
 132 $rom_prefix = 'rom://';
 133 $stty = 'raw -crtscts -onlcr 115200';
 134 $reset = 1;                     # Reset target by default
 135 $interaction = 1;               # Perform target interaction by default
 136 $final_eol = 1;
 137
 138 my @expect_seen = ();
 139 sub handle_expect
 140 {
 141     my ($n, $v) = @_;
 142     push(@expect_seen, '-re') if $n eq "expect-re";
 143     push(@expect_seen, $v);
 144 }
 145
 146 sub handle_send
 147 {
 148     my ($n, $v) = @_;
 149     unless (@expect_seen) { die("No --expect before --send"); }
 150     my $ret = ($n eq "sendcont") ? exp_continue : 0;
 151     unshift(@expect_raw, sub { shift->send(eval("\"$v\"")); $ret; });
 152     unshift(@expect_raw, @expect_seen);
 153     @expect_seen = ();
 154 }
 155
 156 my %opt_spec;
 157 %opt_spec = (
 158     "amt=s"          => \$amt,
 159     "append|a=s"     => \@append,
 160     "bender|b"       => \$bender,
 161     "build-dir=s"    => sub { my ($n, $v) = @_; $builddir = File::Spec->rel2abs($v); },
 162     "concat"         => \$concat,
 163     "chainloader=s"  => \@chainloaders,
 164     "dhcp-tftp|d"    => \$dhcp_tftp,
 165     "dump"           => \$dump_opt,
 166     "dump-config"    => \$dump_config,
 167     "exiton=s"       => \@exiton,
 168     "exiton-timeout=i"=> \$exiton_timeout,
 169     "exiton-re=s"    => sub { my ($n, $v) = @_; push(@exiton, '-re', $v); },
 170     "expect=s"       => \&handle_expect,
 171     "expect-re=s"    => \&handle_expect,
 172     "expect-raw=s"   => sub { my ($n, $v) = @_; unshift(@expect_raw, eval($v)); },
 173     "final-eol!"     => \$final_eol,
 174     "gen-only"       => \$gen_only,
 175     "grub|g:s"       => \$grub_config,
 176     "grub-preamble=s"=> \$grub_preamble,
 177     "prefix|grub-prefix=s" => \$grub_prefix,
 178     "grub2:s"        => \$grub2_config,
 179     "grub2-prolog=s" => \$grub2_prolog,
 180     "ider"           => \$ider,
 181     "interaction!"   => \$interaction,
 182     "iprelay=s"      => \$iprelay,
 183     "iso:s"          => \$iso_image,
 184     "kernel|k=s"     => \$kernel_opt,
 185     "interactive|i"  => \$interactive,
 186     "name=s"         => \$config_name_opt,
 187     "make|m:s"       => \$make,
 188     "no-file-gen"    => \$no_file_gen,
 189     "off"            => \$off_opt,
 190     "on"             => \$on_opt,
 191     "pulsar|p:s"     => \$pulsar,
 192     "pulsar-root=s"  => \$pulsar_root,
 193     "qemu|Q:s"       => \$qemu,
 194     "qemu-append=s"  => \$qemu_append,
 195     "qemu-flags|q=s" => \$qemu_flags_cmd,
 196     "remote-cmd=s"   => \$remote_cmd,
 197     "remote-expect=s"=> \$remote_expect,
 198     "remote-expect-silent=s"=> sub { $remote_expect=$_[1]; $remote_expect_silent=1; },
 199     "reset!"         => \$reset,
 200     "reset-cmd=s"    => \$reset_cmd,
 201     "rsync-flags=s"  => \$rsync_flags,
 202     "scons:s"        => \$scons,
 203     "scriptmod=s"    => \@scriptmod,
 204     "send=s"         => \&handle_send,
 205     "sendcont=s"     => \&handle_send,
 206     "serial|s:s"     => \$serial,
 207     "server:s"       => \$server,
 208     "strip-rom"      => sub { $rom_prefix = ''; },
 209     "stty=s"         => \$stty,
 210     "tftp"           => \$tftp,
 211     "tftp-port=i"    => \$tftp_port,
 212     "uboot:s"        => \$uboot,
 213     "no-uboot"       => sub { undef $uboot; },
 214     "uboot-addr=s"   => \%uboot_addr,
 215     "uboot-cmd=s"    => \$uboot_cmd,
 216     "uboot-init=s"   => \@uboot_init,
 217     "h"              => \$help,
 218     "help"           => \$man,
 219     );
 220
 221 # First process target options
 222 {
 223     my $t = defined($explicit_target) ? $explicit_target : $CFG::default_target;
 224     my @target_expanded;
 225     Getopt::Long::Configure(qw/no_ignore_case pass_through/);
 226     while ($t) {
 227         exists $CFG::targets{$t} or die("Unknown target '$t' (valid targets are: ".join(", ", sort keys(%CFG::targets)).")");
 228
 229         undef $explicit_target;
 230         my ($ret, $remaining_args) = GetOptionsFromString ($CFG::targets{$t}, ("target|t=s" => \$explicit_target));
 231         if (!$ret) { die "Error parsing target $t option"; }
 232         push(@target_expanded, @$remaining_args);
 233         $t = $explicit_target;
 234     }
 235     Getopt::Long::Configure(qw/no_ignore_case no_pass_through/);
 236     GetOptionsFromArray(\@target_expanded, %opt_spec) or die ("Error in target definition");
 237 }
 238
 239 # Then process other command line options - some of them may override
 240 # what was specified by the target
 241 GetOptions %opt_spec or die("Error in command line arguments");
 242 pod2usage(1) if $help;
 243 pod2usage(-exitstatus => 0, -verbose => 2) if $man;
 244
 245 ### Dump sanitized configuration (if requested)
 246
 247 if ($dump_config) {
 248     use Data::Dumper;
 249     $Data::Dumper::Indent=1;
 250     print "# This file is in perl syntax.\n";
 251     foreach my $key(sort(keys(%CFG::))) { # See "Symbol Tables" in perlmod(1)
 252         if (defined ${$CFG::{$key}}) { print Data::Dumper->Dump([${$CFG::{$key}}], ["*$key"]); }
 253         if (        @{$CFG::{$key}}) { print Data::Dumper->Dump([\@{$CFG::{$key}}], ["*$key"]); }
 254         if (        %{$CFG::{$key}}) { print Data::Dumper->Dump([\%{$CFG::{$key}}], ["*$key"]); }
 255     }
 256     print "1;\n";
 257     exit;
 258 }
 259
 260 ### Sanitize configuration
 261
 262 if ($interactive && !-t STDIN) {
 263     die("novaboot: Interactive mode not supported when not on terminal");
 264 }
 265
 266 if (defined $config_name_opt && scalar(@ARGV) > 1) { die "You cannot use --name with multiple scripts"; }
 267
 268 if ($ider) {
 269     $iso_image //= ''; # IDE-R needs an ISO image
 270     if (!defined $amt) { die "Error: --ider requires --amt"; }
 271 }
 272
 273 {
 274     my %input_opts = ('--iprelay'    => \$iprelay,
 275                       '--serial'     => \$serial,
 276                       '--remote-cmd' => \$remote_cmd,
 277                       '--amt'        => \$amt);
 278     my @opts = grep(defined(${$input_opts{$_}}) , keys %input_opts);
 279
 280     die("novaboot: More than one target connection option: ".join(', ', @opts)) if scalar @opts > 1;
 281 }
 282
 283 # Default options
 284 if (defined $serial) {
 285     $serial ||= "/dev/ttyUSB0";
 286     $ENV{NB_SERIAL} = $serial;
 287 }
 288 if (defined $grub_config) { $grub_config ||= "menu.lst"; }
 289 if (defined $grub2_config) { $grub2_config ||= "grub.cfg"; }
 290
 291 ## Parse the novaboot script(s)
 292 my @scripts;
 293 my $file;
 294 my $EOF;
 295 my $last_fn = '';
 296 my ($modules, $variables, $generated, $continuation) = ([], {}, []);
 297 my $skip_reading = defined($on_opt) || defined($off_opt);
 298 while (!$skip_reading && ($_ = <>)) {
 299     if ($ARGV ne $last_fn) { # New script
 300         die "Missing EOF in $last_fn" if $file;
 301         die "Unfinished line in $last_fn" if $continuation;
 302         $last_fn = $ARGV;
 303         push @scripts, { 'filename' => $ARGV,
 304                          'modules' => $modules = [],
 305                          'variables' => $variables = {},
 306                          'generated' => $generated = []};
 307
 308     }
 309     chomp();
 310     next if /^#/ || /^\s*$/;    # Skip comments and empty lines
 311
 312     $_ =~ s/^[[:space:]]*// if ($continuation);
 313
 314     if (/\\$/) {                # Line continuation
 315         $continuation .= substr($_, 0, length($_)-1);
 316         next;
 317     }
 318
 319     if ($continuation) {        # Last continuation line
 320         $_ = $continuation . $_;
 321         $continuation = '';
 322     }
 323
 324     foreach my $mod(@scriptmod) { eval $mod; }
 325
 326     if ($file && $_ eq $EOF) {  # Heredoc end
 327         undef $file;
 328         next;
 329     }
 330     if ($file) {                # Heredoc content
 331         push @{$file}, "$_\n";
 332         next;
 333     }
 334     if (/^([A-Z_]+)=(.*)$/) {   # Internal variable
 335         $$variables{$1} = $2;
 336         push(@exiton, $2) if ($1 eq "EXITON");
 337         next;
 338     }
 339     if (s/^load *//) {          # Load line
 340         die("novaboot: '$last_fn' line $.: Missing file name\n") unless /^[^ <]+/;
 341         if (/^([^ ]*)(.*?)[[:space:]]*<<([^ ]*)$/) { # Heredoc start
 342             push @$modules, "$1$2";
 343             $file = [];
 344             push @$generated, {filename => $1, content => $file};
 345             $EOF = $3;
 346             next;
 347         }
 348         if (/^([^ ]*)(.*?)[[:space:]]*< ?(.*)$/) { # Command substitution
 349             push @$modules, "$1$2";
 350             push @$generated, {filename => $1, command => $3};
 351             next;
 352         }
 353         push @$modules, $_;
 354         next;
 355     }
 356     if (/^run (.*)/) {          # run line
 357         push @$generated, {command => $1};
 358         next;
 359     }
 360     if (/^uboot(?::([0-9]+)s)? (.*)/) { # uboot line
 361         # TODO: If U-Boot supports some interactive menu, it might
 362         # make sense to store uboot lines per novaboot script.
 363         if ($1) {               # Command with explicit timeout
 364             push @uboot_init, { command => $2,
 365                                 timeout => $1 };
 366         } else {                # Command without explicit timeout
 367             push @uboot_init, $2;
 368         }
 369         next;
 370     }
 371
 372     die("novaboot: Cannot parse script '$last_fn' line $.. Didn't you forget 'load' keyword?\n");
 373 }
 374 # use Data::Dumper;
 375 # print Dumper(\@scripts);
 376
 377 foreach my $script (@scripts) {
 378     $modules = $$script{modules};
 379     @$modules[0] =~ s/^[^ ]*/$kernel_opt/ if $kernel_opt;
 380     @$modules[0] .= ' ' . join(' ', @append) if @append;
 381
 382     my $kernel;
 383     if (exists $variables->{KERNEL}) {
 384         $kernel = $variables->{KERNEL};
 385     } else {
 386         if ($CFG::hypervisor) {
 387             $kernel = $CFG::hypervisor . " ";
 388             if (exists $variables->{HYPERVISOR_PARAMS}) {
 389                 $kernel .= $variables->{HYPERVISOR_PARAMS};
 390             } else {
 391                 $kernel .= $CFG::hypervisor_params;
 392             }
 393         }
 394     }
 395     @$modules = ($kernel, @$modules) if $kernel;
 396     @$modules = (@chainloaders, @$modules);
 397     @$modules = ("bin/boot/bender", @$modules) if ($bender || defined $ENV{'NOVABOOT_BENDER'});
 398 }
 399
 400 if ($dump_opt) {
 401     foreach my $script (@scripts) {
 402         print join("\n", @{$$script{modules}})."\n";
 403     }
 404     exit(0);
 405 }
 406
 407 ## Helper functions
 408
 409 sub generate_configs($$$) {
 410     my ($base, $generated, $filename) = @_;
 411     if ($base) { $base = "$base/"; };
 412     foreach my $g(@$generated) {
 413       if (exists $$g{content}) {
 414         my $config = $$g{content};
 415         my $fn = $$g{filename};
 416         open(my $f, '>', $fn) || die("$fn: $!");
 417         map { s|\brom://([^ ]*)|$rom_prefix$base$1|g; print $f "$_"; } @{$config};
 418         close($f);
 419         print STDERR "novaboot: Created $fn\n";
 420       } elsif (exists $$g{command} && ! $no_file_gen) {
 421         $ENV{SRCDIR} = dirname(File::Spec->rel2abs( $filename, $invocation_dir ));
 422         if (exists $$g{filename}) {
 423             system_verbose("( $$g{command} ) > $$g{filename}");
 424         } else {
 425             system_verbose($$g{command});
 426         }
 427       }
 428     }
 429 }
 430
 431 sub generate_grub_config($$$$;$)
 432 {
 433     my ($filename, $title, $base, $modules_ref, $preamble) = @_;
 434     if ($base) { $base = "$base/"; };
 435     open(my $fg, '>', $filename) or die "$filename: $!";
 436     print $fg "$preamble\n" if $preamble;
 437     print $fg "title $title\n" if $title;
 438     #print $fg "root $base\n"; # root doesn't really work for (nd)
 439     my $first = 1;
 440     foreach (@$modules_ref) {
 441         if ($first) {
 442             $first = 0;
 443             my ($kbin, $kcmd) = split(' ', $_, 2);
 444             $kcmd = '' if !defined $kcmd;
 445             print $fg "kernel ${base}$kbin $kcmd\n";
 446         } else {
 447             s|\brom://([^ ]*)|$rom_prefix$base$1|g; # Translate rom:// files - needed for vdisk parameter of sigma0
 448             print $fg "module $base$_\n";
 449         }
 450     }
 451     close($fg);
 452     print("novaboot: Created $builddir/$filename\n");
 453     return $filename;
 454 }
 455
 456 sub generate_syslinux_config($$$$)
 457 {
 458     my ($filename, $title, $base, $modules_ref) = @_;
 459     if ($base && $base !~ /\/$/) { $base = "$base/"; };
 460     open(my $fg, '>', $filename) or die "$filename: $!";
 461     print $fg "LABEL $title\n";
 462     #TODO print $fg "MENU LABEL $human_readable_title\n";
 463
 464     my ($kbin, $kcmd) = split(' ', @$modules_ref[0], 2);
 465
 466     if (system("file $kbin|grep 'Linux kernel'") == 0) {
 467         my $initrd = @$modules_ref[1];
 468         die('To many "load" lines for Linux kernel') if (scalar @$modules_ref > 2);
 469         print $fg "LINUX $base$kbin\n";
 470         print $fg "APPEND $kcmd\n";
 471         print $fg "INITRD $base$initrd\n";
 472     } else {
 473         print $fg "KERNEL mboot.c32\n";
 474         my @append;
 475         foreach (@$modules_ref) {
 476             s|\brom://([^ ]*)|$rom_prefix$base$1|g; # Translate rom:// files - needed for vdisk parameter of sigma0
 477             push @append, "$base$_";
 478             print $fg "APPEND ".join(' --- ', @append)."\n";
 479         }
 480     }
 481     #TODO print $fg "TEXT HELP\n";
 482     #TODO print $fg "some help here\n";
 483     #TODO print $fg "ENDTEXT\n";
 484     close($fg);
 485     print("novaboot: Created $builddir/$filename\n");
 486     return $filename;
 487 }
 488
 489 sub generate_grub2_config($$$$;$$)
 490 {
 491     my ($filename, $title, $base, $modules_ref, $preamble, $prolog) = @_;
 492     if ($base && substr($base,-1,1) ne '/') { $base = "$base/"; };
 493     open(my $fg, '>', $filename) or die "$filename: $!";
 494     print $fg "$preamble\n" if $preamble;
 495     $title ||= 'novaboot';
 496     print $fg "menuentry $title {\n";
 497     print $fg "$prolog\n" if $prolog;
 498     my $first = 1;
 499     foreach (@$modules_ref) {
 500         if ($first) {
 501             $first = 0;
 502             my ($kbin, $kcmd) = split(' ', $_, 2);
 503             $kcmd = '' if !defined $kcmd;
 504             print $fg "  multiboot ${base}$kbin $kcmd\n";
 505         } else {
 506             my @args = split;
 507             # GRUB2 doesn't pass filename in multiboot info so we have to duplicate it here
 508             $_ = join(' ', ($args[0], @args));
 509             s|\brom://|$rom_prefix|g; # We do not need to translate path for GRUB2
 510             print $fg "  module $base$_\n";
 511         }
 512     }
 513     print $fg "}\n";
 514     close($fg);
 515     print("novaboot: Created $builddir/$filename\n");
 516     return $filename;
 517 }
 518
 519 sub generate_pulsar_config($$)
 520 {
 521     my ($filename, $modules_ref) = @_;
 522     open(my $fg, '>', $filename) or die "$filename: $!";
 523     print $fg "root $pulsar_root\n" if defined $pulsar_root;
 524     my $first = 1;
 525     my ($kbin, $kcmd);
 526     foreach (@$modules_ref) {
 527         if ($first) {
 528             $first = 0;
 529             ($kbin, $kcmd) = split(' ', $_, 2);
 530             $kcmd = '' if !defined $kcmd;
 531         } else {
 532             my @args = split;
 533             s|\brom://|$rom_prefix|g;
 534             print $fg "load $_\n";
 535         }
 536     }
 537     # Put kernel as last - this is needed for booting Linux and has no influence on non-Linux OSes
 538     print $fg "exec $kbin $kcmd\n";
 539     close($fg);
 540     print("novaboot: Created $builddir/$filename\n");
 541     return $filename;
 542 }
 543
 544 sub shell_cmd_string(@)
 545 {
 546     return join(' ', map((/^[-_=a-zA-Z0-9\/\.\+]+$/ ? "$_" : "'$_'"), @_));
 547 }
 548
 549 sub exec_verbose(@)
 550 {
 551     print STDERR "novaboot: Running: ".shell_cmd_string(@_)."\n";
 552     exec(@_);
 553     exit(1); # should not be reached
 554 }
 555
 556 sub system_verbose($)
 557 {
 558     my $cmd = shift;
 559     print STDERR "novaboot: Running: $cmd\n";
 560     my $ret = system($cmd);
 561     if ($ret & 0x007f) { die("Command terminated by a signal"); }
 562     if ($ret & 0xff00) {die("Command exit with non-zero exit code"); }
 563     if ($ret) { die("Command failure $ret"); }
 564 }
 565
 566 sub trim($) {
 567     my ($str) = @_;
 568     $str =~ s/^\s+|\s+$//g;
 569     return $str
 570 }
 571
 572 ## WvTest headline
 573
 574 if (exists $variables->{WVDESC}) {
 575     print STDERR "Testing \"$variables->{WVDESC}\" in $last_fn:\n";
 576 } elsif ($last_fn =~ /\.wv$/) {
 577     print STDERR "Testing \"all\" in $last_fn:\n";
 578 }
 579
 580 ## Connect to the target and check whether it is not occupied
 581
 582 # We have to do this before file generation phase, because file
 583 # generation is intermixed with file deployment phase and we want to
 584 # check whether the target is not used by somebody else before
 585 # deploying files. Otherwise, we may rewrite other user's files on a
 586 # boot server.
 587
 588 my $exp; # Expect object to communicate with the target over serial line
 589
 590 my ($target_reset, $target_power_on, $target_power_off);
 591 my ($amt_user, $amt_password, $amt_host, $amt_port);
 592
 593 if (defined $iprelay) {
 594     my $IPRELAY;
 595     $iprelay =~ /([.0-9]+)(:([0-9]+))?/;
 596     my $addr = $1;
 597     my $port = $3 || 23;
 598     my $paddr   = sockaddr_in($port, inet_aton($addr));
 599     my $proto   = getprotobyname('tcp');
 600     socket($IPRELAY, PF_INET, SOCK_STREAM, $proto)  || die "socket: $!";
 601     print STDERR "novaboot: Connecting to IP relay... ";
 602     connect($IPRELAY, $paddr)    || die "connect: $!";
 603     print STDERR "done\n";
 604     $exp = Expect->init(\*$IPRELAY);
 605     $exp->log_stdout(1);
 606
 607     while (1) {
 608         print $exp "\xFF\xF6";  # AYT
 609         my $connected = $exp->expect(20, # Timeout in seconds
 610                                      '<iprelayd: connected>',
 611                                      '-re', '<WEB51 HW[^>]*>');
 612         last if $connected;
 613     }
 614
 615     sub relaycmd($$) {
 616         my ($relay, $onoff) = @_;
 617         die unless ($relay == 1 || $relay == 2);
 618
 619         my $cmd = ($relay == 1 ? 0x5 : 0x6) | ($onoff ? 0x20 : 0x10);
 620         return "\xFF\xFA\x2C\x32".chr($cmd)."\xFF\xF0";
 621     }
 622
 623     sub relayconf($$) {
 624         my ($relay, $onoff) = @_;
 625         die unless ($relay == 1 || $relay == 2);
 626         my $cmd = ($relay == 1 ? 0xdf : 0xbf) | ($onoff ? 0x00 : 0xff);
 627         return "\xFF\xFA\x2C\x97".chr($cmd)."\xFF\xF0";
 628     }
 629
 630     sub relay($$;$) {
 631         my ($relay, $onoff, $can_giveup) = @_;
 632         my $confirmation = '';
 633         $exp->log_stdout(0);
 634         print $exp relaycmd($relay, $onoff);
 635         my $confirmed = $exp->expect(20, # Timeout in seconds
 636                                      relayconf($relay, $onoff));
 637         if (!$confirmed) {
 638             if ($can_giveup) {
 639                 print("Relay confirmation timeout - ignoring\n");
 640             } else {
 641                 die "Relay confirmation timeout";
 642             }
 643         }
 644         $exp->log_stdout(1);
 645     }
 646
 647     $target_reset = sub {
 648         relay(2, 1, 1); # Reset the machine
 649         usleep(100000);
 650         relay(2, 0);
 651     };
 652
 653     $target_power_off = sub {
 654         relay(1, 1);            # Press power button
 655         usleep(6000000);        # Long press to switch off
 656         relay(1, 0);
 657     };
 658
 659     $target_power_on = sub {
 660         relay(1, 1);            # Press power button
 661         usleep(100000);         # Short press
 662         relay(1, 0);
 663     };
 664 }
 665 elsif ($serial) {
 666     my $CONN;
 667     system_verbose("stty -F $serial $stty");
 668     open($CONN, "+<", $serial) || die "open $serial: $!";
 669     $exp = Expect->init(\*$CONN);
 670 }
 671 elsif ($remote_cmd) {
 672     print STDERR "novaboot: Running: $remote_cmd\n";
 673     $exp = Expect->spawn($remote_cmd);
 674 }
 675 elsif (defined $amt) {
 676     require LWP::UserAgent;
 677     require LWP::Authen::Digest;
 678
 679     sub genXML {
 680         my ($host, $username, $password, $schema, $className, $pstate) = @_;
 681         #AMT numbers for PowerStateChange (MNI => bluescreen on windows;-)
 682         my %pstates = ("on"        => 2,
 683                        "standby"   => 4,
 684                        "hibernate" => 7,
 685                        "off"       => 8,
 686                        "reset"     => 10,
 687                        "MNI"       => 11);
 688         return <<END;
 689                 <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">
 690                 <s:Header><a:To>http://$host:16992/wsman</a:To>
 691                 <w:ResourceURI s:mustUnderstand="true">$schema</w:ResourceURI>
 692                 <a:ReplyTo><a:Address s:mustUnderstand="true">http://schemas.xmlsoap.org/ws/2004/08/addressing/role/anonymous</a:Address></a:ReplyTo>
 693                 <a:Action s:mustUnderstand="true">$schema$className</a:Action>
 694                 <w:MaxEnvelopeSize s:mustUnderstand="true">153600</w:MaxEnvelopeSize>
 695                 <a:MessageID>uuid:709072C9-609C-4B43-B301-075004043C7C</a:MessageID>
 696                 <w:Locale xml:lang="en-US" s:mustUnderstand="false" />
 697                 <w:OperationTimeout>PT60.000S</w:OperationTimeout>
 698                 <w:SelectorSet><w:Selector Name="Name">Intel(r) AMT Power Management Service</w:Selector></w:SelectorSet>
 699                 </s:Header><s:Body>
 700                 <p:RequestPowerStateChange_INPUT xmlns:p="http://schemas.dmtf.org/wbem/wscim/1/cim-schema/2/CIM_PowerManagementService">
 701                 <p:PowerState>$pstates{$pstate}</p:PowerState>
 702                 <p:ManagedElement><a:Address>http://$host:16992/wsman</a:Address>
 703                 <a:ReferenceParameters><w:ResourceURI>http://schemas.dmtf.org/wbem/wscim/1/cim-schema/2/CIM_ComputerSystem</w:ResourceURI>
 704                 <w:SelectorSet><w:Selector Name="Name">ManagedSystem</w:Selector></w:SelectorSet>
 705                 </a:ReferenceParameters></p:ManagedElement>
 706                 </p:RequestPowerStateChange_INPUT>
 707                 </s:Body></s:Envelope>
 708 END
 709     }
 710
 711     sub sendPOST {
 712         my ($host, $username, $password, $content) = @_;
 713
 714         my $ua = LWP::UserAgent->new();
 715         $ua->agent("novaboot");
 716
 717         my $req = HTTP::Request->new(POST => "http://$host:16992/wsman");
 718         my $res = $ua->request($req);
 719         die ("Unexpected AMT response: " . $res->status_line) unless $res->code == 401;
 720
 721         my ($realm) = $res->header("WWW-Authenticate") =~ /Digest realm="(.*?)"/;
 722         $ua->credentials("$host:16992", $realm, $username => $password);
 723
 724         # Create a request
 725         $req = HTTP::Request->new(POST => "http://$host:16992/wsman");
 726         $req->content_type('application/x-www-form-urlencoded');
 727         $req->content($content);
 728         $res = $ua->request($req);
 729         die ("AMT power change request failed: " . $res->status_line) unless $res->is_success;
 730         $res->content() =~ /<g:ReturnValue>(\d+)<\/g:ReturnValue>/;
 731         return $1;
 732     }
 733
 734     sub powerChange  {
 735         my ($host, $username, $password, $pstate)=@_;
 736         my $schema="http://schemas.dmtf.org/wbem/wscim/1/cim-schema/2/CIM_PowerManagementService";
 737         my $className="/RequestPowerStateChange";
 738         my $content = genXML($host, $username, $password ,$schema, $className, $pstate);
 739         return sendPOST($host, $username, $password, $content);
 740     }
 741
 742     ($amt_user,$amt_password,$amt_host,$amt_port) = ($amt =~ /(?:(.*?)(?::(.*))?@)?([^:]*)(?::([0-9]*))?/);;
 743     $amt_user ||= "admin";
 744     $amt_password ||= $ENV{'AMT_PASSWORD'} || die "AMT password not specified";
 745     $amt_host || die "AMT host not specified";
 746     $amt_port ||= 16994;
 747
 748
 749     $target_power_off = sub {
 750         $exp->close();
 751         my $result = powerChange($amt_host,$amt_user,$amt_password, "off");
 752         die "AMT power off failed (ReturnValue $result)" if $result != 0;
 753     };
 754
 755     $target_power_on = sub {
 756         my $result = powerChange($amt_host,$amt_user,$amt_password, "on");
 757         die "AMT power on failed (ReturnValue $result)" if $result != 0;
 758     };
 759
 760     $target_reset = sub {
 761         my $result = powerChange($amt_host,$amt_user,$amt_password, "reset");
 762         if ($result != 0) {
 763             print STDERR "Warning: Cannot reset $amt_host, trying power on. ";
 764             $result = powerChange($amt_host,$amt_user,$amt_password, "on");
 765         }
 766         die "AMT reset failed (ReturnValue $result)" if $result != 0;
 767     };
 768
 769     my $cmd = "amtterm -u $amt_user -p $amt_password $amt_host $amt_port";
 770     print STDERR "novaboot: Running: $cmd\n" =~ s/\Q$amt_password\E/???/r;
 771     $exp = Expect->spawn($cmd);
 772     $exp->expect(10, "RUN_SOL") || die "Expect for 'RUN_SOL' timed out";
 773
 774 }
 775
 776
 777 if ($remote_expect) {
 778     $exp || die("No serial line connection");
 779     my $log = $exp->log_stdout;
 780     if (defined $remote_expect_silent) {
 781         $exp->log_stdout(0);
 782     }
 783     $exp->expect(180, $remote_expect) || die "Expect for '$remote_expect' timed out";
 784     if (defined $remote_expect_silent) {
 785         $exp->log_stdout($log);
 786         print $exp->after() if $log;
 787     }
 788 }
 789
 790 if (defined $reset_cmd) {
 791     $target_reset = sub {
 792         system_verbose($reset_cmd);
 793     };
 794 }
 795
 796 if (defined $on_opt && defined $target_power_on) {
 797     &$target_power_on();
 798     exit;
 799 }
 800 if (defined $off_opt && defined $target_power_off) {
 801     print STDERR "novaboot: Switching the target off...\n";
 802     &$target_power_off();
 803     exit;
 804 }
 805
 806 $builddir ||= dirname(File::Spec->rel2abs( ${$scripts[0]}{filename})) if scalar @scripts;
 807 if (defined $builddir) {
 808     chdir($builddir) or die "Can't change directory to $builddir: $!";
 809     print STDERR "novaboot: Entering directory `$builddir'\n";
 810 } else {
 811     $builddir = $invocation_dir;
 812 }
 813
 814 ## File generation phase
 815 my (%files_iso, $menu_iso, $filename);
 816 my $config_name = '';
 817 my $prefix = '';
 818
 819 foreach my $script (@scripts) {
 820     $filename = $$script{filename};
 821     $modules = $$script{modules};
 822     $generated = $$script{generated};
 823     $variables = $$script{variables};
 824
 825     ($config_name = $filename) =~ s#.*/##;
 826     $config_name = $config_name_opt if (defined $config_name_opt);
 827
 828     if (exists $variables->{BUILDDIR}) {
 829         $builddir = File::Spec->rel2abs($variables->{BUILDDIR});
 830         chdir($builddir) or die "Can't change directory to $builddir: $!";
 831         print STDERR "novaboot: Entering directory `$builddir'\n";
 832     }
 833
 834     if ($grub_prefix) {
 835         $prefix = $grub_prefix;
 836         $prefix =~ s/\$NAME/$config_name/;
 837         $prefix =~ s/\$BUILDDIR/$builddir/;
 838     }
 839     # TODO: use $grub_prefix as first parameter if some switch is given
 840     generate_configs('', $generated, $filename);
 841
 842 ### Generate bootloader configuration files
 843     my @bootloader_configs;
 844     push @bootloader_configs, generate_grub_config($grub_config, $config_name, $prefix, $modules, $grub_preamble) if (defined $grub_config);
 845     push @bootloader_configs, generate_grub2_config($grub2_config, $config_name, $prefix, $modules, $grub_preamble, $grub2_prolog) if (defined $grub2_config);
 846     push @bootloader_configs, generate_pulsar_config('config-'.($pulsar||'novaboot'), $modules) if (defined $pulsar);
 847
 848 ### Run scons or make
 849     {
 850         my @files = map({ ($file) = m/([^ ]*)/; $file; } @$modules);
 851         # Filter-out generated files
 852         my @to_build = grep({ my $file = $_; !scalar(grep($file eq ($$_{filename} || ''), @$generated)) } @files);
 853
 854         system_verbose($scons || $CFG::scons." ".join(" ", @to_build)) if (defined $scons);
 855         system_verbose($make  || $CFG::make ." ".join(" ", @to_build)) if (defined $make);
 856     }
 857
 858 ### Copy files (using rsync)
 859     if (defined $server && !defined($gen_only)) {
 860         (my $real_server = $server) =~ s/\$NAME/$config_name/;
 861
 862         my ($hostname, $path) = split(":", $real_server, 2);
 863         if (! defined $path) {
 864             $path = $hostname;
 865             $hostname = "";
 866         }
 867         my $files = join(" ", map({ ($file) = m/([^ ]*)/; $file; } ( @$modules, @bootloader_configs)));
 868         map({ my $file = (split)[0]; die "$file: $!" if ! -f $file; } @$modules);
 869         my $istty = -t STDOUT && ($ENV{'TERM'} || 'dumb') ne 'dumb';
 870         my $progress = $istty ? "--progress" : "";
 871         system_verbose("rsync $progress -RLp $rsync_flags $files $real_server");
 872         if ($server =~ m|/\$NAME$| && $concat) {
 873             my $cmd = join("; ", map { "( cd $path/.. && cat */$_ > $_ )" } @bootloader_configs);
 874             system_verbose($hostname ? "ssh $hostname '$cmd'" : $cmd);
 875         }
 876     }
 877
 878 ### Prepare ISO image generation
 879     if (defined $iso_image) {
 880         generate_configs("(cd)", $generated, $filename);
 881         my $menu;
 882         generate_syslinux_config(\$menu, $config_name, "/", $modules);
 883         $menu_iso .= "$menu\n";
 884         map { ($file,undef) = split; $files_iso{$file} = 1; } @$modules;
 885     }
 886 }
 887
 888 ## Generate ISO image
 889 if (defined $iso_image) {
 890     system_verbose("mkdir -p isolinux");
 891
 892     my @files;
 893     if (-f '/usr/lib/ISOLINUX/isolinux.bin') {
 894         # Newer ISOLINUX version
 895         @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);
 896     } else {
 897         # Older ISOLINUX version
 898         @files = qw(/usr/lib/syslinux/isolinux.bin /usr/lib/syslinux/mboot.c32 /usr/lib/syslinux/menu.c32);
 899     }
 900     system_verbose("cp @files isolinux");
 901     open(my $fh, ">isolinux/isolinux.cfg");
 902     if ($#scripts) {
 903         print $fh "TIMEOUT 50\n";
 904         print $fh "DEFAULT menu\n";
 905     } else {
 906         print $fh "DEFAULT $config_name\n";
 907     }
 908     print $fh "$menu_iso";
 909     close($fh);
 910
 911     my $files = join(" ", map("$_=$_", (keys(%files_iso), 'isolinux/isolinux.cfg', map(s|.*/|isolinux/|r, @files))));
 912     $iso_image ||= "$config_name.iso";
 913
 914     # Note: We use -U flag below to "Allow 'untranslated' filenames,
 915     # completely violating the ISO9660 standards". Without this
 916     # option, isolinux is not able to read files names for example
 917     # bzImage-3.0.
 918     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");
 919     print("ISO image created: $builddir/$iso_image\n");
 920 }
 921
 922 exit(0) if defined $gen_only;
 923
 924 ## Boot the system using various methods and send serial output to stdout
 925
 926 if (scalar(@scripts) > 1 && ( defined $dhcp_tftp || defined $serial || defined $iprelay)) {
 927     die "You cannot do this with multiple scripts simultaneously";
 928 }
 929
 930 if ($variables->{WVTEST_TIMEOUT}) {
 931     print STDERR "wvtest: timeout ", $variables->{WVTEST_TIMEOUT}, "\n";
 932 }
 933
 934 ### Start in Qemu
 935
 936 if (defined $qemu) {
 937     # Qemu
 938     $qemu ||= $variables->{QEMU} || $CFG::qemu;
 939     my @qemu_flags = split(" ", $qemu);
 940     $qemu = shift(@qemu_flags);
 941
 942     @qemu_flags = split(/ +/, trim($variables->{QEMU_FLAGS})) if exists $variables->{QEMU_FLAGS};
 943     @qemu_flags = split(/ +/, trim($qemu_flags_cmd)) if $qemu_flags_cmd;
 944     push(@qemu_flags, split(/ +/, trim($qemu_append || '')));
 945
 946     if (defined $iso_image) {
 947         # Boot NOVA with grub (and test the iso image)
 948         push(@qemu_flags, ('-cdrom', $iso_image));
 949     } else {
 950         # Boot NOVA without GRUB
 951
 952         # Non-patched qemu doesn't like commas, but NUL can live with pluses instead of commans
 953         foreach (@$modules) {s/,/+/g;}
 954         generate_configs("", $generated, $filename);
 955
 956         if (scalar @$modules) {
 957             my ($kbin, $kcmd) = split(' ', shift(@$modules), 2);
 958             $kcmd = '' if !defined $kcmd;
 959             my $dtb;
 960             @$modules = map { if (/\.dtb$/) { $dtb=$_; (); } else { $_ } } @$modules;
 961             my $initrd = join ",", @$modules;
 962
 963             push(@qemu_flags, ('-kernel', $kbin, '-append', $kcmd));
 964             push(@qemu_flags, ('-initrd', $initrd)) if $initrd;
 965             push(@qemu_flags, ('-dtb', $dtb)) if $dtb;
 966         }
 967     }
 968     push(@qemu_flags,  qw(-serial stdio)); # Redirect serial output (for collecting test restuls)
 969     unshift(@qemu_flags, ('-name', $config_name));
 970     print STDERR "novaboot: Running: ".shell_cmd_string($qemu, @qemu_flags)."\n";
 971     $exp = Expect->spawn(($qemu, @qemu_flags)) || die("exec() failed: $!");
 972 }
 973
 974 ### Local DHCPD and TFTPD
 975
 976 my ($dhcpd_pid, $tftpd_pid);
 977
 978 $tftp=1 if $tftp_port;
 979
 980 if (defined $dhcp_tftp)
 981 {
 982     generate_configs("(nd)", $generated, $filename);
 983     system_verbose('mkdir -p tftpboot');
 984     generate_grub_config("tftpboot/os-menu.lst", $config_name, "(nd)", \@$modules, "timeout 0");
 985     open(my $fh, '>', 'dhcpd.conf');
 986     my $mac = `cat /sys/class/net/eth0/address`;
 987     chomp $mac;
 988     print $fh "subnet 10.23.23.0 netmask 255.255.255.0 {
 989                       range 10.23.23.10 10.23.23.100;
 990                       filename \"bin/boot/grub/pxegrub.pxe\";
 991                       next-server 10.23.23.1;
 992 }
 993 host server {
 994         hardware ethernet $mac;
 995         fixed-address 10.23.23.1;
 996 }";
 997     close($fh);
 998     system_verbose("sudo ip a add 10.23.23.1/24 dev eth0;
 999             sudo ip l set dev eth0 up;
1000             sudo touch dhcpd.leases");
1001
1002     # We run servers by forking ourselves, because the servers end up
1003     # in our process group and get killed by signals sent to the
1004     # process group (e.g. Ctrl-C on terminal).
1005     $dhcpd_pid = fork();
1006     exec_verbose("sudo dhcpd -d -cf dhcpd.conf -lf dhcpd.leases -pf dhcpd.pid") if ($dhcpd_pid == 0);
1007 }
1008
1009 if (defined $dhcp_tftp || defined $tftp) {
1010     $tftp_port ||= 69;
1011     # Unfortunately, tftpd requires root privileges even with
1012     # non-privileged (>1023) port due to initgroups().
1013     system_verbose("sudo in.tftpd --listen --secure -v -v -v --pidfile tftpd.pid  --address :$tftp_port $builddir");
1014
1015     # Kill server when we die
1016     $SIG{__DIE__} = sub { system_verbose('sudo pkill --pidfile=dhcpd.pid') if (defined $dhcp_tftp);
1017                           system_verbose('sudo pkill --pidfile=tftpd.pid'); };
1018
1019     # We have to kill tftpd explicitely, because it is not in our process group
1020     $SIG{INT} = sub { system_verbose('sudo pkill --pidfile=tftpd.pid'); exit(0); };
1021 }
1022
1023 ### AMT IDE-R
1024 if (defined $ider) {
1025     my $ider_cmd= "amtider -c $iso_image -u $amt_user -p $amt_password $amt_host $amt_port"  ;
1026     print STDERR "novaboot: Running: $ider_cmd\n" =~ s/\Q$amt_password\E/???/r;
1027     my $ider_pid = fork();
1028     if ($ider_pid == 0) {
1029         exec($ider_cmd);
1030         die "IDE redirection failed";
1031     }
1032     # FIXME: This collides with --tftp option. Hopefully, nobody needs
1033     # to use both simultaneously.
1034     $SIG{__DIE__} = sub { system_verbose('kill $ider_pid'); };
1035 }
1036
1037 ### Reset target (IP relay, AMT, ...)
1038
1039 if (defined $target_reset && $reset) {
1040     print STDERR "novaboot: Reseting the test box... ";
1041     &$target_reset();
1042     print STDERR "done\n";
1043     if (defined $exp) {
1044         # We don't want to output anything printed by the target
1045         # before reset so we clear the buffers now. This is, however,
1046         # not ideal because we may loose some data that were sent
1047         # after the reset. If this is a problem, one should reset and
1048         # connect to serial line in atomic manner. For example, if
1049         # supported by hardware, use --remote-cmd 'sterm -d ...' and
1050         # do not use separate --reset-cmd.
1051         my $log = $exp->log_stdout;
1052         $exp->log_stdout(0);
1053         $exp->expect(0); # Read data from target
1054         $exp->clear_accum();    # Clear the read data
1055         $exp->log_stdout($log);
1056     }
1057 }
1058
1059 ### U-boot conversation
1060 if (defined $uboot) {
1061     my $uboot_prompt = $uboot || '=> ';
1062     print STDERR "novaboot: Waiting for U-Boot prompt...\n";
1063     $exp || die("No serial line connection");
1064     $exp->log_stdout(1);
1065     #$exp->exp_internal(1);
1066     $exp->expect(20,
1067                  [qr/Hit any key to stop autoboot:/, sub { $exp->send("\n"); exp_continue; }],
1068                  $uboot_prompt) || die "No U-Boot prompt deteceted";
1069     foreach my $cmdspec (@uboot_init) {
1070         my ($cmd, $timeout);
1071         if (ref($cmdspec) eq "HASH") {
1072             $cmd = $cmdspec->{command};
1073             $timeout = $cmdspec->{timeout};
1074         } else {
1075             $cmd = $cmdspec;
1076             $timeout = 10;
1077         }
1078         if ($cmd =~ /\$NB_MYIP/) {
1079             my $ip = (grep /inet /, `ip addr show eth0`)[0] || die "Problem determining our IP address";
1080             $ip =~ s/\s*inet ([0-9.]*).*/$1/;
1081             $cmd =~ s/\$NB_MYIP/$ip/g;
1082         }
1083         if ($cmd =~ /\$NB_PREFIX/) {
1084             my $p = $prefix;
1085             $p =~ s|/*$||;
1086             $cmd =~ s/\$NB_PREFIX/$p/g;
1087         }
1088         chomp($cmd);
1089         $exp->send("$cmd\n");
1090         $exp->expect($timeout, $uboot_prompt) || die "U-Boot prompt timeout";
1091     }
1092
1093     # Boot the system if there are some load lines in the script
1094     if ((scalar(@$modules) > 0 && !$variables->{NO_BOOT}) ||
1095         defined $uboot_cmd) {
1096         my ($kbin, $kcmd) = split(' ', shift(@$modules), 2);
1097         my $dtb;
1098         @$modules = map { if (/\.dtb$/) { $dtb=$_; (); } else { $_ } } @$modules;
1099         my $initrd = shift @$modules;
1100
1101         if (defined $kbin) {
1102             die "No '--uboot-addr kernel' given" unless $uboot_addr{kernel};
1103             $exp->send("tftpboot $uboot_addr{kernel} $prefix$kbin\n");
1104             $exp->expect(10,
1105                          [qr/##/, sub { exp_continue; }],
1106                          $uboot_prompt) || die "Kernel load timeout";
1107         }
1108         if (defined $dtb) {
1109             die "No '--uboot-addr fdt' given" unless $uboot_addr{fdt};
1110             $exp->send("tftpboot $uboot_addr{fdt} $prefix$dtb\n");
1111             $exp->expect(10,
1112                          [qr/##/, sub { exp_continue; }],
1113                          $uboot_prompt) || die "Device tree load timeout";
1114         }
1115         if (defined $initrd) {
1116             die "No '--uboot-addr ramdisk' given" unless $uboot_addr{ramdisk};
1117             $exp->send("tftpboot $uboot_addr{ramdisk} $prefix$initrd\n");
1118             $exp->expect(10,
1119                          [qr/##/, sub { exp_continue; }],
1120                          $uboot_prompt) || die "Initrd load timeout";
1121         } else {
1122             $uboot_addr{ramdisk} = '-';
1123         }
1124
1125         $kcmd //= '';
1126         $exp->send("setenv bootargs $kcmd\n");
1127         $exp->expect(5, $uboot_prompt)  || die "U-Boot prompt timeout";
1128
1129         $uboot_cmd //= $variables->{UBOOT_CMD} // 'bootm $kernel_addr $ramdisk_addr $fdt_addr';
1130         $uboot_cmd =~ s/\$kernel_addr/$uboot_addr{kernel}/g;
1131         $uboot_cmd =~ s/\$ramdisk_addr/$uboot_addr{ramdisk}/g;
1132         $uboot_cmd =~ s/\$fdt_addr/$uboot_addr{fdt}/g;
1133
1134         $exp->send($uboot_cmd . "\n");
1135         $exp->expect(5, "\n")  || die "U-Boot command timeout";
1136     }
1137 }
1138
1139 ### Serial line interaction
1140 if ($interaction && defined $exp) {
1141     # Serial line of the target is available
1142     my $interrupt = 'Ctrl-C';
1143     if ($interactive && !@exiton) {
1144         $interrupt = '"~~."';
1145     }
1146     print STDERR "novaboot: Serial line interaction (press $interrupt to interrupt)...\n";
1147     $exp->log_stdout(1);
1148     if (@exiton) {
1149         $exp->expect($exiton_timeout, @expect_raw, @exiton) || die("exiton timeout");
1150     } else {
1151         my @inputs = ($exp);
1152         my $infile = new IO::File;
1153         $infile->IO::File::fdopen(*STDIN,'r');
1154         my $in_object = Expect->exp_init($infile);
1155         $in_object->set_group($exp);
1156
1157         if ($interactive) {
1158             $in_object->set_seq('~~\.', sub { print STDERR "novaboot: Escape sequence detected\r\n"; undef; });
1159             $in_object->manual_stty(0);   # Use raw terminal mode
1160         } else {
1161             $in_object->manual_stty(1);   # Do not modify terminal settings
1162         }
1163         push(@inputs, $in_object);
1164         #use Data::Dumper;
1165         #print Dumper(\@expect_raw);
1166         $exp->expect(undef, @expect_raw) if @expect_raw;
1167         Expect::interconnect(@inputs) unless defined($exp->exitstatus);
1168     }
1169 }
1170
1171 ## Kill dhcpc or tftpd
1172 if (defined $dhcp_tftp || defined $tftp) {
1173     die("novaboot: This should kill servers on background\n");
1174 }
1175
1176 # Always finish novaboot output with newline
1177 print "\n" if $final_eol;
1178
1179 ## Documentation
1180
1181 =head1 NAME
1182
1183 novaboot - Boots a locally compiled operating system on a remote
1184 target or in qemu
1185
1186 =head1 SYNOPSIS
1187
1188 B<novaboot> --help
1189
1190 B<novaboot> [option]... [--] script...
1191
1192 B<./script> [option]...
1193
1194 =head1 DESCRIPTION
1195
1196 This program makes booting of a locally compiled operating system (OS)
1197 (e.g. NOVA or Linux) on remote targets as simple as running a program
1198 locally. It automates things like copying OS images to a TFTP server,
1199 generation of bootloader configuration files, resetting of target
1200 hardware or redirection of target's serial line to stdin/out. Novaboot
1201 is highly configurable and it makes it easy to boot a single image on
1202 different targets or different images on a single target.
1203
1204 Novaboot operation is controlled by command line options and by a so
1205 called novaboot script, which can be thought as a generalization of
1206 bootloader configuration files (see L</"NOVABOOT SCRIPT SYNTAX">).
1207 Typical way of using novaboot is to make the novaboot script
1208 executable and set its first line to I<#!/usr/bin/env novaboot>. Then,
1209 booting a particular OS configuration becomes the same as executing a
1210 local program - the novaboot script.
1211
1212 Novaboot uses configuration files to, among other things, define
1213 command line options needed for different targets. Users typically use
1214 only the B<-t>/B<--target> command line option to select the target.
1215 Internally, this option expands to the pre-configured options.
1216 Configuration files are searched at multiple places, which allows to
1217 have per-system, per-user or per-project configurations. Configuration
1218 file syntax is described in section L</"CONFIGURATION FILES">.
1219
1220 Simple examples of using C<novaboot>:
1221
1222 =over 3
1223
1224 =item 1.
1225
1226 Run an OS in Qemu. This is can be specified with the B<--qemu> option.
1227 Thus running C<novaboot --qemu myos> (or C<./myos --qemu> as described
1228 above) will run Qemu and make it boot the configuration specified in
1229 the F<myos> script.
1230
1231 =item 2.
1232
1233 Create a bootloader configuration file (currently supported
1234 bootloaders are GRUB, GRUB2, ISOLINUX, Pulsar and U-Boot) and copy it
1235 with all other files needed for booting to a remote boot server. Then
1236 use a TCP/IP-controlled relay/serial-to-TCP converter to reset the
1237 target and receive its serial output.
1238
1239  ./myos --grub2 --server=192.168.1.1:/tftp --iprelay=192.168.1.2
1240
1241 =item 3.
1242
1243 Run DHCP and TFTP server on developer's machine to boot the target
1244 from it.
1245
1246  ./myos --dhcp-tftp
1247
1248 This is useful when no network infrastructure is in place and
1249 the target is connected directly to developer's box.
1250
1251 =item 4.
1252
1253 Create bootable ISO image.
1254
1255  novaboot --iso -- script1 script2
1256
1257 The created ISO image will have ISOLINUX bootloader installed on it
1258 and the boot menu will allow selecting between I<script1> and
1259 I<script2> configurations.
1260
1261 =back
1262
1263 =head1 PHASES AND OPTIONS
1264
1265 Novaboot performs its work in several phases. Each phase can be
1266 influenced by several command line options, certain phases can be
1267 skipped. The list of phases (in the execution order) is as follows.
1268
1269 =over
1270
1271 =item 1. L<Configuration reading|/Configuration reading phase>
1272
1273 =item 2. L<Command line processing|/Command line processing phase>
1274
1275 =item 3. L<Script preprocessing|/Script preprocessing phase>
1276
1277 =item 4. L<File generation|/File generation phase>
1278
1279 =item 5. L<Target connection|/Target connection check>
1280
1281 =item 6. L<File deployment|/File deployment phase>
1282
1283 =item 7. L<Target power-on and reset|/Target power-on and reset phase>
1284
1285 =item 8. L<Interaction with the bootloader|/Interaction with the bootloader on the target>
1286
1287 =item 9. L<Target interaction|/Target interaction phase>
1288
1289 =back
1290
1291 Each phase is described in the following sections together with the
1292 command line options that control it.
1293
1294 =head2 Configuration reading phase
1295
1296 After starting, novaboot reads configuration files. Their content is
1297 described in section L</"CONFIGURATION FILES">. By default,
1298 configuration is read from multiple locations. First from the system
1299 configuration directory (F</etc/novaboot.d/>), second from the user
1300 configuration file (F<~/.config/novaboot>) and third from F<.novaboot>
1301 files along the path to the current directory. Alternatively, a single
1302 configuration file specified with the B<-c> switch or with the
1303 C<NOVABOOT_CONFIG> environment variable is read. The latter read files
1304 override settings from the former ones.
1305
1306 The system configuration directory is determined by the content of
1307 NOVABOOT_CONFIG_DIR environment variable and defaults to
1308 F</etc/novaboot.d>. Files in this directory with names consisting
1309 solely of English letters, numbers, dashes '-' and underscores '_'
1310 (note that dot '.' is not included) are read in alphabetical order.
1311
1312 Then, the user configuration file is read from
1313 F<$XDG_CONFIG_HOME/novaboot>. If C<$XDG_CONFIG_HOME> environemnt
1314 variable is not set F<~/.config/novaboot> is read instead.
1315
1316 Finally, novaboot searches for files named F<.novaboot> starting from the
1317 directory of the novaboot script (or working directory, see bellow)
1318 and continuing upwards up to the root directory. The found
1319 configuration files are then read in the opposite order (i.e. from the
1320 root directory downwards). This allows to have, for example, a project
1321 specific configuration in F<~/project/.novaboot>.
1322
1323 Note the difference between F<~/.config/novaboot> and F<~/.novaboot>.
1324 The former one is read always, whereas the latter only when novaboot
1325 script or working directory is under the C<$HOME> directory.
1326
1327 In certain cases, the location of the novaboot script cannot be
1328 determined in this early phase. This happens either when the script is
1329 read from the standard input or when novaboot is invoked explicitly as
1330 in the example L</"4."> above. In this case the current working
1331 directory is used as a starting point for configuration file search
1332 instead of the novaboot script directory.
1333
1334 =over 8
1335
1336 =item -c, --config=I<filename>
1337
1338 Use the specified configuration file instead of the default one(s).
1339
1340 =back
1341
1342 =head2 Command line processing phase
1343
1344 =over 8
1345
1346 =item --dump-config
1347
1348 Dump the current configuration to stdout end exit. Useful as an
1349 initial template for a configuration file.
1350
1351 =item -h, --help
1352
1353 Print short (B<-h>) or long (B<--help>) help.
1354
1355 =item -t, --target=I<target>
1356
1357 This option serves as a user configurable shortcut for other novaboot
1358 options. The effect of this option is the same as specifying the
1359 options stored in the C<%targets> configuration variable under key
1360 I<target>. See also L</"CONFIGURATION FILES">.
1361
1362 When this option is not given, novaboot tries to determine the target
1363 to use from either B<NOVABOOT_TARGET> environment variable or from
1364 B<$default_target> configuration file variable.
1365
1366 =back
1367
1368 =head2 Script preprocessing phase
1369
1370 This phases allows to modify the parsed novaboot script before it is
1371 used in the later phases.
1372
1373 =over 8
1374
1375 =item -a, --append=I<parameters>
1376
1377 Append a string to the first C<load> line in the novaboot script. This
1378 can be used to append parameters to the kernel's or root task's
1379 command line. This option can appear multiple times.
1380
1381 =item -b, --bender
1382
1383 Use F<bender> chainloader. Bender scans the PCI bus for PCI serial
1384 ports and stores the information about them in the BIOS data area for
1385 use by the kernel.
1386
1387 =item --chainloader=I<chainloader>
1388
1389 Specifies a chainloader that is loaded before the kernel and other
1390 files specified in the novaboot script. E.g. 'bin/boot/bender
1391 promisc'.
1392
1393 =item --dump
1394
1395 Print the modules to boot and their parameters after this phase
1396 finishes. Then exit. This is useful for seeing the effect of other
1397 options in this section.
1398
1399 =item -k, --kernel=F<file>
1400
1401 Replace the first word on the first C<load> line in the novaboot
1402 script with F<file>.
1403
1404 =item --scriptmod=I<perl expression>
1405
1406 When novaboot script is read, I<perl expression> is executed for every
1407 line (in $_ variable). For example, C<novaboot
1408 --scriptmod=s/sigma0/omega6/g> replaces every occurrence of I<sigma0>
1409 in the script with I<omega6>.
1410
1411 When this option is present, it overrides I<$script_modifier> variable
1412 from the configuration file, which has the same effect. If this option
1413 is given multiple times all expressions are evaluated in the command
1414 line order.
1415
1416 =back
1417
1418 =head2 File generation phase
1419
1420 In this phase, files needed for booting are generated in a so called
1421 I<build directory> (see L</--build-dir>). In most cases configuration
1422 for a bootloader is generated automatically by novaboot. It is also
1423 possible to generate other files using I<heredoc> or I<"<"> syntax in
1424 novaboot scripts. Finally, binaries can be generated in this phases by
1425 running C<scons> or C<make>.
1426
1427 =over 8
1428
1429 =item --build-dir=I<directory>
1430
1431 Overrides the default build directory location.
1432
1433 The default build directory location is determined as follows: If the
1434 configuration file defines the C<$builddir> variable, its value is
1435 used. Otherwise, it is the directory that contains the first processed
1436 novaboot script.
1437
1438 See also L</BUILDDIR> variable.
1439
1440 =item -g, --grub[=I<filename>]
1441
1442 Generates grub bootloader menu file. If the I<filename> is not
1443 specified, F<menu.lst> is used. The I<filename> is relative to the
1444 build directory (see B<--build-dir>).
1445
1446 =item --grub-preamble=I<prefix>
1447
1448 Specifies the I<preable> that is at the beginning of the generated
1449 GRUB or GRUB2 config files. This is useful for specifying GRUB's
1450 timeout.
1451
1452 =item --prefix=I<prefix>
1453
1454 Specifies I<prefix> (e.g. F</srv/tftp>) that is put in front of every
1455 file name in generated bootloader configuration files (or in U-Boot
1456 commands).
1457
1458 If the I<prefix> contains string $NAME, it will be replaced with the
1459 name of the novaboot script (see also B<--name>).
1460
1461 If the I<prefix> contains string $BUILDDIR, it will be replaced with
1462 the build directory (see also B<--build-dir>).
1463
1464 =item --grub-prefix
1465
1466 Alias for B<--prefix>.
1467
1468 =item --grub2[=I<filename>]
1469
1470 Generate GRUB2 menu entry in I<filename>. If I<filename> is not
1471 specified F<grub.cfg> is used. The content of the menu entry can be
1472 customized with B<--grub-preamble>, B<--grub2-prolog> or
1473 B<--grub_prefix> options.
1474
1475 In order to use the the generated menu entry on your development
1476 machine that uses GRUB2, append the following snippet to
1477 F</etc/grub.d/40_custom> file and regenerate your grub configuration,
1478 i.e. run update-grub on Debian/Ubuntu.
1479
1480   if [ -f /path/to/nul/build/grub.cfg ]; then
1481     source /path/to/nul/build/grub.cfg
1482   fi
1483
1484 =item --grub2-prolog=I<prolog>
1485
1486 Specifies text that is put at the beginning of the GRUB2 menu entry.
1487
1488 =item -m, --make[=make command]
1489
1490 Runs C<make> to build files that are not generated by novaboot itself.
1491
1492 =item --name=I<string>
1493
1494 Use the name I<string> instead of the name of the novaboot script.
1495 This name is used for things like a title of grub menu or for the
1496 server directory where the boot files are copied to.
1497
1498 =item --no-file-gen
1499
1500 Do not run external commands to generate files (i.e. "<" syntax and
1501 C<run> keyword). This switch does not influence generation of files
1502 specified with "<<WORD" syntax.
1503
1504 =item -p, --pulsar[=mac]
1505
1506 Generates pulsar bootloader configuration file named F<config-I<mac>>
1507 The I<mac> string is typically a MAC address and defaults to
1508 I<novaboot>.
1509
1510 =item --scons[=scons command]
1511
1512 Runs C<scons> to build files that are not generated by novaboot
1513 itself.
1514
1515 =item --strip-rom
1516
1517 Strip I<rom://> prefix from command lines and generated config files.
1518 The I<rom://> prefix is used by NUL. For NRE, it has to be stripped.
1519
1520 =item --gen-only
1521
1522 Exit novaboot after file generation phase.
1523
1524 =back
1525
1526 =head2 Target connection check
1527
1528 If supported by the target, the connection to it is made and it is
1529 checked whether the target is not occupied by another novaboot
1530 user/instance.
1531
1532 =over 8
1533
1534 =item --amt=I<"[user[:password]@]host[:port]>
1535
1536 Use Intel AMT technology to control the target machine. WS management
1537 is used to powercycle it and Serial-Over-Lan (SOL) for input/output.
1538 The hostname or (IP address) is given by the I<host> parameter. If
1539 I<password> is not specified, environment variable AMT_PASSWORD is
1540 used. The I<port> specifies a TCP port for SOL. If not specified, the
1541 default is 16992. Default I<user> is admin.
1542
1543 =item --iprelay=I<addr[:port]>
1544
1545 Use TCP/IP relay and serial port to access the target's serial port
1546 and powercycle it. The IP address of the relay is given by I<addr>
1547 parameter. If I<port> is not specified, it default to 23.
1548
1549 Note: This option is supposed to work with HWG-ER02a IP relays.
1550
1551 =item -s, --serial[=device]
1552
1553 Target's serial line is connected to host's serial line (device). The
1554 default value for device is F</dev/ttyUSB0>.
1555
1556 The value of this option is exported in NB_NOVABOOT environment
1557 variable to all subprocesses run by C<novaboot>.
1558
1559 =item --stty=I<settings>
1560
1561 Specifies settings passed to C<stty> invoked on the serial line
1562 specified with B<--serial> option. If this option is not given,
1563 C<stty> is called with C<raw -crtscts -onlcr 115200> settings.
1564
1565 =item --remote-cmd=I<cmd>
1566
1567 Command that mediates connection to the target's serial line. For
1568 example C<ssh server 'cu -l /dev/ttyS0'>.
1569
1570 =item --remote-expect=I<string>
1571
1572 Wait for reception of I<string> after establishing the remote
1573 connection.
1574
1575 =item --remote-expect-silent=I<string>
1576
1577 The same as B<--remote-expect> except that the remote output is not
1578 echoed to stdout while waiting for the I<string>. Everything after the
1579 matched string is printed to stdout, so you may want to include line
1580 end characters in the I<string> as well.
1581
1582 =back
1583
1584 =head2 File deployment phase
1585
1586 In some setups, it is necessary to copy the files needed for booting
1587 to a particular location, e.g. to a TFTP boot server or to the
1588 F</boot> partition.
1589
1590 =over 8
1591
1592 =item -d, --dhcp-tftp
1593
1594 Turns your workstation into a DHCP and TFTP server so that the OS can
1595 be booted via PXE BIOS (or similar mechanism) on the test machine
1596 directly connected by a plain Ethernet cable to your workstation.
1597
1598 The DHCP and TFTP servers requires root privileges and C<novaboot>
1599 uses C<sudo> command to obtain those. You can put the following to
1600 I</etc/sudoers> to allow running the necessary commands without asking
1601 for password.
1602
1603  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
1604  your_login ALL=NOPASSWD: NOVABOOT
1605
1606 =item --tftp
1607
1608 Starts a TFTP server on your workstation. This is similar to
1609 B<--dhcp-tftp> except that DHCP server is not started.
1610
1611 The TFTP server require root privileges and C<novaboot> uses C<sudo>
1612 command to obtain those. You can put the following to I</etc/sudoers>
1613 to allow running the necessary commands without asking for password.
1614
1615  Cmnd_Alias NOVABOOT =  /usr/sbin/in.tftpd --listen --secure -v -v -v --pidfile tftpd.pid *, /usr/bin/pkill --pidfile=tftpd.pid
1616  your_login ALL=NOPASSWD: NOVABOOT
1617
1618 =item --tftp-port=I<port>
1619
1620 Port to run the TFTP server on. Implies B<--tftp>.
1621
1622 =item --iso[=filename]
1623
1624 Generates the ISO image that boots NOVA system via GRUB. If no filename
1625 is given, the image is stored under I<NAME>.iso, where I<NAME> is the name
1626 of the novaboot script (see also B<--name>).
1627
1628 =item --server[=[[user@]server:]path]
1629
1630 Copy all files needed for booting to another location. The files will
1631 be copied (by B<rsync> tool) to the directory I<path>. If the I<path>
1632 contains string $NAME, it will be replaced with the name of the
1633 novaboot script (see also B<--name>).
1634
1635 =item --rsync-flags=I<flags>
1636
1637 Specifies which I<flags> are appended to F<rsync> command line when
1638 copying files as a result of I<--server> option.
1639
1640 =item --concat
1641
1642 If B<--server> is used and its value ends with $NAME, then after
1643 copying the files, a new bootloader configuration file (e.g. menu.lst)
1644 is created at I<path-wo-name>, i.e. the path specified by B<--server>
1645 with $NAME part removed. The content of the file is created by
1646 concatenating all files of the same name from all subdirectories of
1647 I<path-wo-name> found on the "server".
1648
1649 =item --ider
1650
1651 Use Intel AMT technology for IDE redirection. This allows the target
1652 machine to boot from novaboot created ISO image. Implies B<--iso>.
1653
1654 The experimental C<amtider> utility needed by this option can be
1655 obtained from https://github.com/wentasah/amtterm.
1656
1657 =back
1658
1659 =head2 Target power-on and reset phase
1660
1661 At this point, the target is reset (or switched on/off). There is
1662 several ways how this can be accomplished. Resetting a physical target
1663 can currently be accomplished by the following options: B<--amt>,
1664 B<--iprelay>, B<--reset-cmd>.
1665
1666 =over 8
1667
1668 =item --on, --off
1669
1670 Switch on/off the target machine and exit. The script (if any) is
1671 completely ignored. Currently it works only with B<--iprelay> or
1672 B<--amt>.
1673
1674 =item -Q, --qemu[=I<qemu-binary>]
1675
1676 Boot the configuration in qemu. Optionally, the name of qemu binary
1677 can be specified as a parameter.
1678
1679 =item --qemu-append=I<flags>
1680
1681 Append I<flags> to the default qemu flags (QEMU_FLAGS variable or
1682 C<-cpu coreduo -smp 2>).
1683
1684 =item -q, --qemu-flags=I<flags>
1685
1686 Replace the default qemu flags (QEMU_FLAGS variable or C<-cpu coreduo
1687 -smp 2>) with I<flags> specified here.
1688
1689 =item --reset-cmd=I<cmd>
1690
1691 Command that resets the target.
1692
1693 =item --no-reset, --reset
1694
1695 Disable/enable resetting of the target.
1696
1697 =back
1698
1699 =head2 Interaction with the bootloader on the target
1700
1701 =over 8
1702
1703 =item --uboot[=I<prompt>]
1704
1705 Interact with U-Boot bootloader to boot the thing described in the
1706 novaboot script. I<prompt> specifies the U-Boot's prompt (default is
1707 "=> ", other common prompts are "U-Boot> " or "U-Boot# ").
1708 Implementation of this option is currently tied to a particular board
1709 that we use. It may be subject to changes in the future!
1710
1711 =item --no-uboot
1712
1713 Disable U-Boot interaction previously enabled with B<--uboot>.
1714
1715 =item --uboot-init
1716
1717 Command(s) to send the U-Boot bootloader before loading the images and
1718 booting them. This option can be given multiple times. After sending
1719 commands from each option novaboot waits for U-Boot I<prompt>.
1720
1721 If the command contains string I<$NB_MYIP> then this string is
1722 replaced by IPv4 address of eth0 interface. Similarly I<$NB_PREFIX> is
1723 replaced with prefix given by B<--prefix>.
1724
1725 See also C<uboot> keyword in L</"NOVABOOT SCRIPT SYNTAX">).
1726
1727 =item --uboot-addr I<name>=I<address>
1728
1729 Load address of U-Boot's C<tftpboot> command for loading I<name>,
1730 where name is one of I<kernel>, I<ramdisk> or I<fdt> (flattened device
1731 tree).
1732
1733 The default addresses are ${I<name>_addr_r}, i.e. U-Boot environment
1734 variables used by convention for this purpose.
1735
1736 =item --uboot-cmd=I<command>
1737
1738 Specifies U-Boot command used to execute the OS. If the command
1739 contains strings C<$kernel_addr>, C<$ramdisk_addr>, C<$fdt_addr>,
1740 these are replaced with the addresses configured with B<--uboot-addr>.
1741
1742 The default value is
1743
1744     bootm $kernel_addr $ramdisk_addr $fdt_addr
1745
1746 or the C<UBOOT_CMD> variable if defined in the novaboot script.
1747
1748 =back
1749
1750 =head2 Target interaction phase
1751
1752 In this phase, target's serial output is redirected to stdout and if
1753 stdin is a TTY, it is redirected to the target's serial input allowing
1754 interactive work with the target.
1755
1756 =over 8
1757
1758 =item --exiton=I<string>
1759
1760 When I<string> is sent by the target, novaboot exits. This option can
1761 be specified multiple times, in which case novaboot exits whenever
1762 either of the specified strings is sent.
1763
1764 If I<string> is C<-re>, then the next B<--exiton>'s I<string> is
1765 treated as regular expression. For example:
1766
1767     --exiton -re --exiton 'error:.*failed'
1768
1769 =item --exiton-re=I<regex>
1770
1771 The same as --exiton -re --exiton I<regex>.
1772
1773 =item --exiton-timeout=I<seconds>
1774
1775 By default B<--exiton> waits for the string match forever. When this
1776 option is specified, "exiton" timeouts after the specifies number of
1777 seconds and novaboot returns non-zero exit code.
1778
1779 =item -i, --interactive
1780
1781 Setup things for interactive use of target. Your terminal will be
1782 switched to raw mode. In raw mode, your system does not process input
1783 in any way (no echoing of entered characters, no interpretation
1784 special characters). This, among others, means that Ctrl-C is passed
1785 to the target and does no longer interrupt novaboot. Use "~~."
1786 sequence to exit novaboot.
1787
1788 =item --no-interaction, --interaction
1789
1790 Skip resp. force target interaction phase. When skipped, novaboot exits
1791 immediately when boot is initiated.
1792
1793 =item --expect=I<string>
1794
1795 When I<string> is received from the target, send the string specified
1796 with the subsequent B<--send*> option to the target.
1797
1798 =item --expect-re=I<regex>
1799
1800 When target's output matches regular expression I<regex>, send the
1801 string specified with the subsequent B<--send*> option to the target.
1802
1803 =item --expect-raw=I<perl-code>
1804
1805 Provides direct control over Perl's Expect module.
1806
1807 =item --send=I<string>
1808
1809 Send I<string> to the target after the previously specified
1810 B<--expect*> was matched in the target's output. The I<string> may
1811 contain escape sequences such as "\n".
1812
1813 Note that I<string> is actually interpreted by Perl, so it can contain
1814 much more that escape sequences. This behavior may change in the
1815 future.
1816
1817 Example: C<--expect='login: ' --send='root\n'>
1818
1819 =item --sendcont=I<string>
1820
1821 Similar to B<--send> but continue expecting more input.
1822
1823 Example: C<--expect='Continue?' --sendcont='yes\n'>
1824
1825 =item --final-eol, --no-final-eol
1826
1827 By default, B<novaboot> always prints an end-of-line character at the
1828 end of its execution in order to ensure that the output of programs
1829 started after novaboot appears at the beginning of the line. When this
1830 is not desired B<--no-final-eol> option can be used to override this
1831 behavior.
1832
1833 =back
1834
1835 =head1 NOVABOOT SCRIPT SYNTAX
1836
1837 The syntax tries to mimic POSIX shell syntax. The syntax is defined
1838 with the following rules.
1839
1840 Lines starting with "#" and empty lines are ignored.
1841
1842 Lines that end with "\" are concatenated with the following line after
1843 removal of the final "\" and leading whitespace of the following line.
1844
1845 Lines of the form I<VARIABLE=...> (i.e. matching '^[A-Z_]+=' regular
1846 expression) assign values to internal variables. See L</VARIABLES>
1847 section.
1848
1849 Lines starting with C<load> keyword represent modules to boot. The
1850 word after C<load> is a file name (relative to the build directory
1851 (see B<--build-dir>) of the module to load and the remaining words are
1852 passed to it as the command line parameters.
1853
1854 When the C<load> line ends with "<<WORD" then the subsequent lines
1855 until the line containing solely WORD are copied literally to the file
1856 named on that line. This is similar to shell's heredoc feature.
1857
1858 When the C<load> line ends with "< CMD" then command CMD is executed
1859 with F</bin/sh> and its standard output is stored in the file named on
1860 that line. The SRCDIR variable in CMD's environment is set to the
1861 absolute path of the directory containing the interpreted novaboot
1862 script.
1863
1864 Lines starting with C<run> keyword contain shell commands that are run
1865 during file generation phase. This is the same as the "< CMD" syntax
1866 for C<load> keyboard except that the command's output is not
1867 redirected to a file. The ordering of commands is the same as they
1868 appear in the novaboot script.
1869
1870 Lines starting with C<uboot> represent U-Boot commands that are sent
1871 to the target if B<--uboot> option is given. Having a U-Boot line in
1872 the novaboot script is the same as passing an equivalent
1873 B<--uboot-init> option to novaboot. The C<uboot> keyword can be
1874 suffixed with timeout specification. The syntax is C<uboot:Ns>, where
1875 C<N> is the whole number of seconds. If the U-Boot command prompt does
1876 not appear before the timeout, novaboot fails. The default timeout is
1877 10 seconds.
1878
1879 Example (Linux):
1880
1881   #!/usr/bin/env novaboot
1882   load bzImage console=ttyS0,115200
1883   run  make -C buildroot
1884   load rootfs.cpio < gen_cpio buildroot/images/rootfs.cpio "myapp->/etc/init.d/S99myapp"
1885
1886 Example (NOVA User Land - NUL):
1887
1888   #!/usr/bin/env novaboot
1889   WVDESC=Example program
1890   load bin/apps/sigma0.nul S0_DEFAULT script_start:1,1 \
1891                            verbose hostkeyb:0,0x60,1,12,2
1892   load bin/apps/hello.nul
1893   load hello.nulconfig <<EOF
1894   sigma0::mem:16 name::/s0/log name::/s0/timer name::/s0/fs/rom ||
1895   rom://bin/apps/hello.nul
1896   EOF
1897
1898 This example will load three modules: F<sigma0.nul>, F<hello.nul> and
1899 F<hello.nulconfig>. sigma0 receives some command line parameters and
1900 F<hello.nulconfig> file is generated on the fly from the lines between
1901 C<<<EOF> and C<EOF>.
1902
1903 =head2 VARIABLES
1904
1905 The following variables are interpreted in the novaboot script:
1906
1907 =over 8
1908
1909 =item BUILDDIR
1910
1911 Novaboot chdir()s to this directory before file generation phase. The
1912 directory name specified here is relative to the build directory
1913 specified by other means (see L</--build-dir>).
1914
1915 =item EXITON
1916
1917 Assigning this variable has the same effect as specifying L</--exiton>
1918 option.
1919
1920 =item HYPERVISOR_PARAMS
1921
1922 Parameters passed to hypervisor. The default value is "serial", unless
1923 overridden in configuration file.
1924
1925 =item KERNEL
1926
1927 The kernel to use instead of the hypervisor specified in the
1928 configuration file with the C<$hypervisor> variable. The value should
1929 contain the name of the kernel image as well as its command line
1930 parameters. If this variable is defined and non-empty, the variable
1931 HYPERVISOR_PARAMS is not used.
1932
1933 =item NO_BOOT
1934
1935 If this variable is 1, the system is not booted. This is currently
1936 only implemented for U-Boot bootloader where it is useful for
1937 interacting with the bootloader without booting the system - e.g. for
1938 flashing.
1939
1940 =item QEMU
1941
1942 Use a specific qemu binary (can be overridden with B<-Q>) and flags
1943 when booting this script under qemu. If QEMU_FLAGS variable is also
1944 specified flags specified in QEMU variable are replaced by those in
1945 QEMU_FLAGS.
1946
1947 =item QEMU_FLAGS
1948
1949 Use specific qemu flags (can be overridden with B<-q>).
1950
1951 =item UBOOT_CMD
1952
1953 See L</--uboot-cmd>.
1954
1955 =item WVDESC
1956
1957 Description of the WvTest-compliant program.
1958
1959 =item WVTEST_TIMEOUT
1960
1961 The timeout in seconds for WvTest harness. If no complete line appears
1962 in the test output within the time specified here, the test fails. It
1963 is necessary to specify this for long running tests that produce no
1964 intermediate output.
1965
1966 =back
1967
1968 =head1 CONFIGURATION FILES
1969
1970 Novaboot can read its configuration from one or more files. By
1971 default, novaboot looks for files in F</etc/novaboot.d>, file
1972 F<~/.config/novaboot> and files named F<.novaboot> as described in
1973 L</Configuration reading phase>. Alternatively, configuration file
1974 location can be specified with the B<-c> switch or with the
1975 NOVABOOT_CONFIG environment variable. The configuration file has Perl
1976 syntax (i.e. it is better to put C<1;> as the last line) and should set
1977 values of certain Perl variables. The current configuration can be
1978 dumped with the B<--dump-config> switch. Some configuration variables
1979 can be overridden by environment variables (see below) or by command
1980 line switches.
1981
1982 Supported configuration variables include:
1983
1984 =over 8
1985
1986 =item $builddir
1987
1988 Build directory location relative to the location of the configuration
1989 file.
1990
1991 =item $default_target
1992
1993 Default target (see below) to use when no target is explicitly
1994 specified with the B<--target> command line option or
1995 B<NOVABOOT_TARGET> environment variable.
1996
1997 =item %targets
1998
1999 Hash of target definitions to be used with the B<--target> option. The
2000 key is the identifier of the target, the value is the string with
2001 command line options. For instance, if the configuration file contains:
2002
2003  $targets{'mybox'} = '--server=boot:/tftproot --serial=/dev/ttyUSB0 --grub',
2004
2005 then the following two commands are equivalent:
2006
2007  ./myos --server=boot:/tftproot --serial=/dev/ttyUSB0 --grub
2008  ./myos -t mybox
2009
2010 =back
2011
2012 =head1 ENVIRONMENT VARIABLES
2013
2014 Some options can be specified not only via config file or command line
2015 but also through environment variables. Environment variables override
2016 the values from configuration file and command line parameters
2017 override the environment variables.
2018
2019 =over 8
2020
2021 =item NOVABOOT_CONFIG
2022
2023 Name of the novaboot configuration file to use instead of the default
2024 one(s).
2025
2026 =item NOVABOOT_CONFIG_DIR
2027
2028 Name of the novaboot configuration directory. When not specified
2029 F</etc/novaboot.d> is used.
2030
2031 =item NOVABOOT_TARGET
2032
2033 Name of the novaboot target to use. This overrides the value of
2034 B<$default_target> from the configuration file and can be overriden
2035 with the B<--target> command line option.
2036
2037 =item NOVABOOT_BENDER
2038
2039 Defining this variable has the same meaning as B<--bender> option.
2040
2041 =back
2042
2043 =head1 AUTHORS
2044
2045 Michal Sojka <sojka@os.inf.tu-dresden.de>
2046
2047 =cut
2048
2049 # LocalWords:  novaboot Novaboot NOVABOOT TFTP PXE DHCP filename stty
2050 # LocalWords:  chainloader stdout Qemu qemu preprocessing ISOLINUX bootable
2051 # LocalWords:  config subprocesses sudo sudoers tftp dhcp IDE stdin
2052 # LocalWords:  subdirectories TTY whitespace heredoc POSIX WvTest