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