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