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