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 use strict;
  17 use warnings;
  18 use warnings (exists $ENV{NOVABOOT_TEST} ? (FATAL => 'all') : ());
  19 use Getopt::Long qw(GetOptionsFromString);
  20 use Pod::Usage;
  21 use File::Basename;
  22 use File::Spec;
  23 use IO::Handle;
  24 use Time::HiRes("usleep");
  25 use Socket;
  26 use FileHandle;
  27 use IPC::Open2;
  28 use POSIX qw(:errno_h);
  29 use Cwd qw(getcwd abs_path);
  30 use Expect;
  31
  32 # always flush
  33 $| = 1;
  34
  35 my $invocation_dir = $ENV{PWD} || getcwd();
  36
  37 ## Configuration file handling
  38
  39 # Default configuration
  40 $CFG::hypervisor = "";
  41 $CFG::hypervisor_params = "serial";
  42 $CFG::genisoimage = "genisoimage";
  43 $CFG::qemu = 'qemu -cpu coreduo -smp 2';
  44 $CFG::default_target = 'qemu';
  45 %CFG::targets = (
  46     'qemu' => '--qemu',
  47     "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',
  48     "novabox" => '--server=rtime.felk.cvut.cz:/srv/tftp/novaboot --rsync-flags="--chmod=Dg+s,ug+w,o-w,+rX --rsync-path=\"umask 002 && rsync\"" --pulsar --iprelay=147.32.86.92:2324',
  49     "localhost" => '--scriptmod=s/console=tty[A-Z0-9,]+// --server=/boot/novaboot/$NAME --grub2 --grub-prefix=/boot/novaboot/$NAME --grub2-prolog="  set root=\'(hd0,msdos1)\'"',
  50     "ryuglab" => '--server=pc-sojkam.felk.cvut.cz:/srv/tftp --uboot --uboot-init="mw f0000b00 \${psc_cfg}; sleep 1" --remote-cmd="ssh -t pc-sojkam.felk.cvut.cz \"cu -l /dev/ttyUSB0 -s 115200\"" --remote-expect="Connected." --reset-cmd="ssh -t pc-sojkam.felk.cvut.cz \"dtrrts /dev/ttyUSB0 1 1\""',
  51     "ryulocal" => '--dhcp-tftp --serial --uboot --uboot-init="dhcp; mw f0000b00 \${psc_cfg}; sleep 1" --reset-cmd="if which dtrrts; then dtrrts $NB_SERIAL 0 1; sleep 0.1; dtrrts $NB_SERIAL 1 1; fi"',
  52
  53     );
  54 chomp(my $nproc = `nproc`);
  55 $CFG::scons = "scons -j$nproc";
  56 $CFG::make = "make -j$nproc";
  57
  58 my $builddir;
  59
  60 sub read_config($) {
  61     my ($cfg) = @_;
  62     {
  63         package CFG; # Put config data into a separate namespace
  64         my $rc = do($cfg);
  65
  66         # Check for errors
  67         if ($@) {
  68             die("ERROR: Failure compiling '$cfg' - $@");
  69         } elsif (! defined($rc)) {
  70             die("ERROR: Failure reading '$cfg' - $!");
  71         } elsif (! $rc) {
  72             die("ERROR: Failure processing '$cfg'");
  73         }
  74     }
  75     $builddir = File::Spec->rel2abs($CFG::builddir, dirname($cfg)) if defined $CFG::builddir;
  76     print STDERR "novaboot: Read $cfg\n";
  77 }
  78
  79 my @cfgs;
  80 {
  81     # We don't use $0 here, because it points to the novaboot itself and
  82     # not to the novaboot script. The problem with this approach is that
  83     # when a script is run as "novaboot <options> <script>" then $ARGV[0]
  84     # contains the first option. Hence the -f check.
  85     my $dir = File::Spec->rel2abs($ARGV[0] && -f $ARGV[0] ? dirname($ARGV[0]) : '', $invocation_dir);
  86     while ((-d $dir || -l $dir ) && $dir ne "/") {
  87         push @cfgs, "$dir/.novaboot" if -r "$dir/.novaboot";
  88         my @dirs = File::Spec->splitdir($dir);
  89         $dir = File::Spec->catdir(@dirs[0..$#dirs-1]);
  90     }
  91 }
  92 my $cfg = $ENV{'NOVABOOT_CONFIG'};
  93 Getopt::Long::Configure(qw/no_ignore_case pass_through/);
  94 GetOptions ("config|c=s" => \$cfg);
  95 read_config($_) foreach $cfg or reverse @cfgs;
  96
  97 ## Command line handling
  98
  99 my $explicit_target;
 100 GetOptions ("target|t=s" => \$explicit_target);
 101
 102 my (@append, $bender, @chainloaders, $concat, $config_name_opt, $dhcp_tftp, $dump_opt, $dump_config, @exiton, @expect_raw, $gen_only, $grub_config, $grub_prefix, $grub_preamble, $grub2_prolog, $grub2_config, $help, $iprelay, $iso_image, $interactive, $kernel_opt, $make, $man, $no_file_gen, $off_opt, $on_opt, $pulsar, $pulsar_root, $qemu, $qemu_append, $qemu_flags_cmd, $remote_cmd, $remote_expect, $reset_cmd, $rom_prefix, $rsync_flags, @scriptmod, $scons, $serial, $server, $stty, $uboot, $uboot_init);
 103
 104 $rsync_flags = '';
 105 $rom_prefix = 'rom://';
 106 $stty = 'raw -crtscts -onlcr 115200';
 107
 108 my @expect_seen = ();
 109 sub handle_expect
 110 {
 111     my ($n, $v) = @_;
 112     push(@expect_seen, '-re') if $n eq "expect-re";
 113     push(@expect_seen, $v);
 114 }
 115
 116 sub handle_send
 117 {
 118     my ($n, $v) = @_;
 119     unless (@expect_seen) { die("No --expect before --send"); }
 120     my $ret = ($n eq "sendcont") ? exp_continue : 0;
 121     unshift(@expect_raw, sub { shift->send(eval("\"$v\"")); $ret; });
 122     unshift(@expect_raw, @expect_seen);
 123     @expect_seen = ();
 124 }
 125
 126 Getopt::Long::Configure(qw/no_ignore_case no_pass_through/);
 127 my %opt_spec;
 128 %opt_spec = (
 129     "append|a=s"     => \@append,
 130     "bender|b"       => \$bender,
 131     "build-dir=s"    => sub { my ($n, $v) = @_; $builddir = File::Spec->rel2abs($v); },
 132     "concat"         => \$concat,
 133     "chainloader=s"  => \@chainloaders,
 134     "dhcp-tftp|d"    => \$dhcp_tftp,
 135     "dump"           => \$dump_opt,
 136     "dump-config"    => \$dump_config,
 137     "exiton=s"       => \@exiton,
 138     "expect=s"       => \&handle_expect,
 139     "expect-re=s"    => \&handle_expect,
 140     "expect-raw=s"   => sub { my ($n, $v) = @_; unshift(@expect_raw, eval($v)); },
 141     "gen-only"       => \$gen_only,
 142     "grub|g:s"       => \$grub_config,
 143     "grub-preamble=s"=> \$grub_preamble,
 144     "grub-prefix=s"  => \$grub_prefix,
 145     "grub2:s"        => \$grub2_config,
 146     "grub2-prolog=s" => \$grub2_prolog,
 147     "iprelay=s"      => \$iprelay,
 148     "iso:s"          => \$iso_image,
 149     "kernel|k=s"     => \$kernel_opt,
 150     "interactive|i"  => \$interactive,
 151     "name=s"         => \$config_name_opt,
 152     "make|m:s"       => \$make,
 153     "no-file-gen"    => \$no_file_gen,
 154     "off"            => \$off_opt,
 155     "on"             => \$on_opt,
 156     "pulsar|p:s"     => \$pulsar,
 157     "pulsar-root=s"  => \$pulsar_root,
 158     "qemu|Q:s"       => \$qemu,
 159     "qemu-append=s"  => \$qemu_append,
 160     "qemu-flags|q=s" => \$qemu_flags_cmd,
 161     "remote-cmd=s"   => \$remote_cmd,
 162     "remote-expect=s"=> \$remote_expect,
 163     "reset-cmd=s"    => \$reset_cmd,
 164     "rsync-flags=s"  => \$rsync_flags,
 165     "scons:s"        => \$scons,
 166     "scriptmod=s"    => \@scriptmod,
 167     "send=s"         => \&handle_send,
 168     "sendcont=s"     => \&handle_send,
 169     "serial|s:s"     => \$serial,
 170     "server:s"       => \$server,
 171     "strip-rom"      => sub { $rom_prefix = ''; },
 172     "stty=s"         => \$stty,
 173     "uboot"          => \$uboot,
 174     "uboot-init=s"   => \$uboot_init,
 175     "h"              => \$help,
 176     "help"           => \$man,
 177     );
 178
 179 # First process target options
 180 {
 181     my $t = defined($explicit_target) ? $explicit_target : $CFG::default_target;
 182     if ($t) {
 183         exists $CFG::targets{$t} or die("Unknown target '$t' (valid targets are: ".join(", ", sort keys(%CFG::targets)).")");
 184         GetOptionsFromString($CFG::targets{$t}, %opt_spec);
 185     }
 186 }
 187
 188 # Then process other command line options - some of them may override
 189 # what was specified by the target
 190 GetOptions %opt_spec or die("Error in command line arguments");
 191 pod2usage(1) if $help;
 192 pod2usage(-exitstatus => 0, -verbose => 2) if $man;
 193
 194 ### Dump sanitized configuration (if requested)
 195
 196 if ($dump_config) {
 197     use Data::Dumper;
 198     $Data::Dumper::Indent=1;
 199     print "# This file is in perl syntax.\n";
 200     foreach my $key(sort(keys(%CFG::))) { # See "Symbol Tables" in perlmod(1)
 201         if (defined ${$CFG::{$key}}) { print Data::Dumper->Dump([${$CFG::{$key}}], ["*$key"]); }
 202         if (        @{$CFG::{$key}}) { print Data::Dumper->Dump([\@{$CFG::{$key}}], ["*$key"]); }
 203         if (        %{$CFG::{$key}}) { print Data::Dumper->Dump([\%{$CFG::{$key}}], ["*$key"]); }
 204     }
 205     print "1;\n";
 206     exit;
 207 }
 208
 209 ### Sanitize configuration
 210
 211 if ($interactive && !-t STDIN) {
 212     die("novaboot: Interactive mode not supported when not on terminal");
 213 }
 214
 215 if (defined $config_name_opt && scalar(@ARGV) > 1) { die "You cannot use --name with multiple scripts"; }
 216
 217 # Default options
 218 if (defined $serial) {
 219     $serial ||= "/dev/ttyUSB0";
 220     $ENV{NB_SERIAL} = $serial;
 221 }
 222 if (defined $grub_config) { $grub_config ||= "menu.lst"; }
 223 if (defined $grub2_config) { $grub2_config ||= "grub.cfg"; }
 224
 225 ## Parse the novaboot script(s)
 226 my @scripts;
 227 my $file;
 228 my $EOF;
 229 my $last_fn = '';
 230 my ($modules, $variables, $generated, $continuation);
 231 while (<>) {
 232     if ($ARGV ne $last_fn) { # New script
 233         die "Missing EOF in $last_fn" if $file;
 234         die "Unfinished line in $last_fn" if $continuation;
 235         $last_fn = $ARGV;
 236         push @scripts, { 'filename' => $ARGV,
 237                          'modules' => $modules = [],
 238                          'variables' => $variables = {},
 239                          'generated' => $generated = []};
 240
 241     }
 242     chomp();
 243     next if /^#/ || /^\s*$/;    # Skip comments and empty lines
 244
 245     $_ =~ s/^[[:space:]]*// if ($continuation);
 246
 247     if (/\\$/) {                # Line continuation
 248         $continuation .= substr($_, 0, length($_)-1);
 249         next;
 250     }
 251
 252     if ($continuation) {        # Last continuation line
 253         $_ = $continuation . $_;
 254         $continuation = '';
 255     }
 256
 257     foreach my $mod(@scriptmod) { eval $mod; }
 258
 259     if (/^([A-Z_]+)=(.*)$/) {   # Internal variable
 260         $$variables{$1} = $2;
 261         push(@exiton, $2) if ($1 eq "EXITON");
 262         next;
 263     }
 264     if (s/^load *//) {          # Load line
 265         if (/^([^ ]*)(.*?)[[:space:]]*<<([^ ]*)$/) { # Heredoc start
 266             push @$modules, "$1$2";
 267             $file = [];
 268             push @$generated, {filename => $1, content => $file};
 269             $EOF = $3;
 270             next;
 271         }
 272         if (/^([^ ]*)(.*?)[[:space:]]*< ?(.*)$/) { # Command substitution
 273             push @$modules, "$1$2";
 274             push @$generated, {filename => $1, command => $3};
 275             next;
 276         }
 277         push @$modules, $_;
 278         next;
 279     }
 280     if ($file && $_ eq $EOF) {  # Heredoc end
 281         undef $file;
 282         next;
 283     }
 284     if ($file) {                # Heredoc content
 285         push @{$file}, "$_\n";
 286         next;
 287     }
 288
 289     die("novaboot: Cannot parse script '$last_fn' line $.. Didn't you forget 'load' keyword?\n");
 290 }
 291 # use Data::Dumper;
 292 # print Dumper(\@scripts);
 293
 294 foreach my $script (@scripts) {
 295     $modules = $$script{modules};
 296     @$modules[0] =~ s/^[^ ]*/$kernel_opt/ if $kernel_opt;
 297     @$modules[0] .= ' ' . join(' ', @append) if @append;
 298
 299     my $kernel;
 300     if (exists $variables->{KERNEL}) {
 301         $kernel = $variables->{KERNEL};
 302     } else {
 303         if ($CFG::hypervisor) {
 304             $kernel = $CFG::hypervisor . " ";
 305             if (exists $variables->{HYPERVISOR_PARAMS}) {
 306                 $kernel .= $variables->{HYPERVISOR_PARAMS};
 307             } else {
 308                 $kernel .= $CFG::hypervisor_params;
 309             }
 310         }
 311     }
 312     @$modules = ($kernel, @$modules) if $kernel;
 313     @$modules = (@chainloaders, @$modules);
 314     @$modules = ("bin/boot/bender", @$modules) if ($bender || defined $ENV{'NOVABOOT_BENDER'});
 315 }
 316
 317 if ($dump_opt) {
 318     foreach my $script (@scripts) {
 319         print join("\n", @{$$script{modules}})."\n";
 320     }
 321     exit(0);
 322 }
 323
 324 ## Helper functions
 325
 326 sub generate_configs($$$) {
 327     my ($base, $generated, $filename) = @_;
 328     if ($base) { $base = "$base/"; };
 329     foreach my $g(@$generated) {
 330       if (exists $$g{content}) {
 331         my $config = $$g{content};
 332         my $fn = $$g{filename};
 333         open(my $f, '>', $fn) || die("$fn: $!");
 334         map { s|\brom://([^ ]*)|$rom_prefix$base$1|g; print $f "$_"; } @{$config};
 335         close($f);
 336         print "novaboot: Created $fn\n";
 337       } elsif (exists $$g{command} && ! $no_file_gen) {
 338         $ENV{SRCDIR} = dirname(File::Spec->rel2abs( $filename, $invocation_dir ));
 339         system_verbose("( $$g{command} ) > $$g{filename}");
 340       }
 341     }
 342 }
 343
 344 sub generate_grub_config($$$$;$)
 345 {
 346     my ($filename, $title, $base, $modules_ref, $preamble) = @_;
 347     if ($base) { $base = "$base/"; };
 348     open(my $fg, '>', $filename) or die "$filename: $!";
 349     print $fg "$preamble\n" if $preamble;
 350     print $fg "title $title\n" if $title;
 351     #print $fg "root $base\n"; # root doesn't really work for (nd)
 352     my $first = 1;
 353     foreach (@$modules_ref) {
 354         if ($first) {
 355             $first = 0;
 356             my ($kbin, $kcmd) = split(' ', $_, 2);
 357             $kcmd = '' if !defined $kcmd;
 358             print $fg "kernel ${base}$kbin $kcmd\n";
 359         } else {
 360             s|\brom://([^ ]*)|$rom_prefix$base$1|g; # Translate rom:// files - needed for vdisk parameter of sigma0
 361             print $fg "module $base$_\n";
 362         }
 363     }
 364     close($fg);
 365     print("novaboot: Created $builddir/$filename\n");
 366     return $filename;
 367 }
 368
 369 sub generate_grub2_config($$$$;$$)
 370 {
 371     my ($filename, $title, $base, $modules_ref, $preamble, $prolog) = @_;
 372     if ($base && substr($base,-1,1) ne '/') { $base = "$base/"; };
 373     open(my $fg, '>', $filename) or die "$filename: $!";
 374     print $fg "$preamble\n" if $preamble;
 375     $title ||= 'novaboot';
 376     print $fg "menuentry $title {\n";
 377     print $fg "$prolog\n" if $prolog;
 378     my $first = 1;
 379     foreach (@$modules_ref) {
 380         if ($first) {
 381             $first = 0;
 382             my ($kbin, $kcmd) = split(' ', $_, 2);
 383             $kcmd = '' if !defined $kcmd;
 384             print $fg "  multiboot ${base}$kbin $kcmd\n";
 385         } else {
 386             my @args = split;
 387             # GRUB2 doesn't pass filename in multiboot info so we have to duplicate it here
 388             $_ = join(' ', ($args[0], @args));
 389             s|\brom://|$rom_prefix|g; # We do not need to translate path for GRUB2
 390             print $fg "  module $base$_\n";
 391         }
 392     }
 393     print $fg "}\n";
 394     close($fg);
 395     print("novaboot: Created $builddir/$filename\n");
 396     return $filename;
 397 }
 398
 399 sub generate_pulsar_config($$)
 400 {
 401     my ($filename, $modules_ref) = @_;
 402     open(my $fg, '>', $filename) or die "$filename: $!";
 403     print $fg "root $pulsar_root\n" if defined $pulsar_root;
 404     my $first = 1;
 405     my ($kbin, $kcmd);
 406     foreach (@$modules_ref) {
 407         if ($first) {
 408             $first = 0;
 409             ($kbin, $kcmd) = split(' ', $_, 2);
 410             $kcmd = '' if !defined $kcmd;
 411         } else {
 412             my @args = split;
 413             s|\brom://|$rom_prefix|g;
 414             print $fg "load $_\n";
 415         }
 416     }
 417     # Put kernel as last - this is needed for booting Linux and has no influence on non-Linux OSes
 418     print $fg "exec $kbin $kcmd\n";
 419     close($fg);
 420     print("novaboot: Created $builddir/$filename\n");
 421     return $filename;
 422 }
 423
 424 sub shell_cmd_string(@)
 425 {
 426     return join(' ', map((/^[-_=a-zA-Z0-9\/\.\+]+$/ ? "$_" : "'$_'"), @_));
 427 }
 428
 429 sub exec_verbose(@)
 430 {
 431     print "novaboot: Running: ".shell_cmd_string(@_)."\n";
 432     exec(@_);
 433 }
 434
 435 sub system_verbose($)
 436 {
 437     my $cmd = shift;
 438     print "novaboot: Running: $cmd\n";
 439     my $ret = system($cmd);
 440     if ($ret & 0x007f) { die("Command terminated by a signal"); }
 441     if ($ret & 0xff00) {die("Command exit with non-zero exit code"); }
 442     if ($ret) { die("Command failure $ret"); }
 443 }
 444
 445 ## WvTest handline
 446
 447 if (exists $variables->{WVDESC}) {
 448     print "Testing \"$variables->{WVDESC}\" in $last_fn:\n";
 449 } elsif ($last_fn =~ /\.wv$/) {
 450     print "Testing \"all\" in $last_fn:\n";
 451 }
 452
 453 ## Connect to the target and check whether is not occupied
 454
 455 # We have to do this before file generation phase, because file
 456 # generation is intermixed with file deployment phase and we want to
 457 # check whether the target is not used by somebody else before
 458 # deploying files. Otherwise, we may rewrite other user's files on a
 459 # boot server.
 460
 461 my $exp; # Expect object to communicate with the target over serial line
 462
 463 my ($target_reset, $target_power_on, $target_power_off);
 464
 465 if (defined $iprelay) {
 466     my $IPRELAY;
 467     $iprelay =~ /([.0-9]+)(:([0-9]+))?/;
 468     my $addr = $1;
 469     my $port = $3 || 23;
 470     my $paddr   = sockaddr_in($port, inet_aton($addr));
 471     my $proto   = getprotobyname('tcp');
 472     socket($IPRELAY, PF_INET, SOCK_STREAM, $proto)  || die "socket: $!";
 473     print "novaboot: Connecting to IP relay... ";
 474     connect($IPRELAY, $paddr)    || die "connect: $!";
 475     print "done\n";
 476     $exp = Expect->init(\*$IPRELAY);
 477     $exp->log_stdout(1);
 478
 479     while (1) {
 480         print $exp "\xFF\xF6";  # AYT
 481         my $connected = $exp->expect(20, # Timeout in seconds
 482                                      '<iprelayd: connected>',
 483                                      '-re', '<WEB51 HW[^>]*>');
 484         last if $connected;
 485     }
 486
 487     sub relaycmd($$) {
 488         my ($relay, $onoff) = @_;
 489         die unless ($relay == 1 || $relay == 2);
 490
 491         my $cmd = ($relay == 1 ? 0x5 : 0x6) | ($onoff ? 0x20 : 0x10);
 492         return "\xFF\xFA\x2C\x32".chr($cmd)."\xFF\xF0";
 493     }
 494
 495     sub relayconf($$) {
 496         my ($relay, $onoff) = @_;
 497         die unless ($relay == 1 || $relay == 2);
 498         my $cmd = ($relay == 1 ? 0xdf : 0xbf) | ($onoff ? 0x00 : 0xff);
 499         return "\xFF\xFA\x2C\x97".chr($cmd)."\xFF\xF0";
 500     }
 501
 502     sub relay($$;$) {
 503         my ($relay, $onoff, $can_giveup) = @_;
 504         my $confirmation = '';
 505         $exp->log_stdout(0);
 506         print $exp relaycmd($relay, $onoff);
 507         my $confirmed = $exp->expect(20, # Timeout in seconds
 508                                      relayconf($relay, $onoff));
 509         if (!$confirmed) {
 510             if ($can_giveup) {
 511                 print("Relay confirmation timeout - ignoring\n");
 512             } else {
 513                 die "Relay confirmation timeout";
 514             }
 515         }
 516         $exp->log_stdout(1);
 517     }
 518
 519     $target_reset = sub {
 520         relay(2, 1, 1); # Reset the machine
 521         usleep(100000);
 522         relay(2, 0);
 523     };
 524
 525     $target_power_off = sub {
 526         relay(1, 1);            # Press power button
 527         usleep(6000000);        # Long press to switch off
 528         relay(1, 0);
 529     };
 530
 531     $target_power_on = sub {
 532         relay(1, 1);            # Press power button
 533         usleep(100000);         # Short press
 534         relay(1, 0);
 535     };
 536 }
 537 elsif ($serial) {
 538     my $CONN;
 539     system_verbose("stty -F $serial $stty");
 540     open($CONN, "+<", $serial) || die "open $serial: $!";
 541     $exp = Expect->init(\*$CONN);
 542 } elsif ($remote_cmd) {
 543     print "novaboot: Running: $remote_cmd\n";
 544     $exp = Expect->spawn($remote_cmd);
 545 }
 546
 547 if ($remote_expect) {
 548     $exp->expect(10, $remote_expect) || die "Expect for '$remote_expect' timed out";
 549 }
 550
 551 if (defined $reset_cmd) {
 552     $target_reset = sub {
 553         system_verbose($reset_cmd);
 554     };
 555 }
 556
 557 if (defined $on_opt && defined $target_power_on) {
 558     &$target_power_on();
 559     exit;
 560 }
 561 if (defined $off_opt && defined $target_power_off) {
 562     print "novaboot: Switching the target off...\n";
 563     &$target_power_off();
 564     exit;
 565 }
 566
 567 $builddir ||= dirname(File::Spec->rel2abs( ${$scripts[0]}{filename})) if scalar @scripts;
 568 if (defined $builddir) {
 569     chdir($builddir) or die "Can't change directory to $builddir: $!";
 570     print "novaboot: Entering directory `$builddir'\n";
 571 }
 572
 573 ## File generation phase
 574 my (%files_iso, $menu_iso, $filename);
 575 my $config_name = '';
 576
 577 foreach my $script (@scripts) {
 578     $filename = $$script{filename};
 579     $modules = $$script{modules};
 580     $generated = $$script{generated};
 581     $variables = $$script{variables};
 582
 583     ($config_name = $filename) =~ s#.*/##;
 584     $config_name = $config_name_opt if (defined $config_name_opt);
 585
 586     if (exists $variables->{BUILDDIR}) {
 587         $builddir = File::Spec->rel2abs($variables->{BUILDDIR});
 588         chdir($builddir) or die "Can't change directory to $builddir: $!";
 589         print "novaboot: Entering directory `$builddir'\n";
 590     }
 591
 592     my $prefix;
 593     ($prefix = $grub_prefix) =~ s/\$NAME/$config_name/ if defined $grub_prefix;
 594     $prefix ||= $builddir;
 595     # TODO: use $grub_prefix as first parameter if some switch is given
 596     generate_configs('', $generated, $filename);
 597
 598 ### Generate bootloader configuration files
 599     my @bootloader_configs;
 600     push @bootloader_configs, generate_grub_config($grub_config, $config_name, $prefix, $modules, $grub_preamble) if (defined $grub_config);
 601     push @bootloader_configs, generate_grub2_config($grub2_config, $config_name, $prefix, $modules, $grub_preamble, $grub2_prolog) if (defined $grub2_config);
 602     push @bootloader_configs, generate_pulsar_config('config-'.($pulsar||'novaboot'), $modules) if (defined $pulsar);
 603
 604 ### Run scons or make
 605     {
 606         my @files = map({ ($file) = m/([^ ]*)/; $file; } @$modules);
 607         # Filter-out generated files
 608         my @to_build = grep({ my $file = $_; !scalar(grep($file eq $$_{filename}, @$generated)) } @files);
 609
 610         system_verbose($scons || $CFG::scons." ".join(" ", @to_build)) if (defined $scons);
 611         system_verbose($make  || $CFG::make ." ".join(" ", @to_build)) if (defined $make);
 612     }
 613
 614 ### Copy files (using rsync)
 615     if (defined $server && !defined($gen_only)) {
 616         (my $real_server = $server) =~ s/\$NAME/$config_name/;
 617
 618         my ($hostname, $path) = split(":", $real_server, 2);
 619         if (! defined $path) {
 620             $path = $hostname;
 621             $hostname = "";
 622         }
 623         my $files = join(" ", map({ ($file) = m/([^ ]*)/; $file; } ( @$modules, @bootloader_configs)));
 624         map({ my $file = (split)[0]; die "$file: $!" if ! -f $file; } @$modules);
 625         my $istty = -t STDOUT && ($ENV{'TERM'} || 'dumb') ne 'dumb';
 626         my $progress = $istty ? "--progress" : "";
 627         system_verbose("rsync $progress -RLp $rsync_flags $files $real_server");
 628         if ($server =~ m|/\$NAME$| && $concat) {
 629             my $cmd = join("; ", map { "( cd $path/.. && cat */$_ > $_ )" } @bootloader_configs);
 630             system_verbose($hostname ? "ssh $hostname '$cmd'" : $cmd);
 631         }
 632     }
 633
 634 ### Prepare ISO image generation
 635     if (defined $iso_image) {
 636         generate_configs("(cd)", $generated, $filename);
 637         my $menu;
 638         generate_grub_config(\$menu, $config_name, "(cd)", $modules);
 639         $menu_iso .= "$menu\n";
 640         map { ($file,undef) = split; $files_iso{$file} = 1; } @$modules;
 641     }
 642 }
 643
 644 ## Generate ISO image
 645 if (defined $iso_image) {
 646     open(my $fh, ">menu-iso.lst");
 647     print $fh "timeout 5\n\n$menu_iso";
 648     close($fh);
 649     my $files = "boot/grub/menu.lst=menu-iso.lst " . join(" ", map("$_=$_", keys(%files_iso)));
 650     $iso_image ||= "$config_name.iso";
 651     system_verbose("$CFG::genisoimage -R -b stage2_eltorito -no-emul-boot -boot-load-size 4 -boot-info-table -hide-rr-moved -J -joliet-long -o $iso_image -graft-points bin/boot/grub/ $files");
 652     print("ISO image created: $builddir/$iso_image\n");
 653 }
 654
 655 exit(0) if defined $gen_only;
 656
 657 ## Boot the system using various methods and send serial output to stdout
 658
 659 if (scalar(@scripts) > 1 && ( defined $dhcp_tftp || defined $serial || defined $iprelay)) {
 660     die "You cannot do this with multiple scripts simultaneously";
 661 }
 662
 663 if ($variables->{WVTEST_TIMEOUT}) {
 664     print "wvtest: timeout ", $variables->{WVTEST_TIMEOUT}, "\n";
 665 }
 666
 667 sub trim($) {
 668     my ($str) = @_;
 669     $str =~ s/^\s+|\s+$//g;
 670     return $str
 671 }
 672
 673 ### Qemu
 674
 675 if (defined $qemu) {
 676     # Qemu
 677     $qemu ||= $variables->{QEMU} || $CFG::qemu;
 678     my @qemu_flags = split(" ", $qemu);
 679     $qemu = shift(@qemu_flags);
 680
 681     @qemu_flags = split(/ +/, trim($variables->{QEMU_FLAGS})) if exists $variables->{QEMU_FLAGS};
 682     @qemu_flags = split(/ +/, trim($qemu_flags_cmd)) if $qemu_flags_cmd;
 683     push(@qemu_flags, split(/ +/, trim($qemu_append || '')));
 684
 685     if (defined $iso_image) {
 686         # Boot NOVA with grub (and test the iso image)
 687         push(@qemu_flags, ('-cdrom', "$config_name.iso"));
 688     } else {
 689         # Boot NOVA without GRUB
 690
 691         # Non-patched qemu doesn't like commas, but NUL can live with pluses instead of commans
 692         foreach (@$modules) {s/,/+/g;}
 693         generate_configs("", $generated, $filename);
 694
 695         if (scalar @$modules) {
 696             my ($kbin, $kcmd) = split(' ', shift(@$modules), 2);
 697             $kcmd = '' if !defined $kcmd;
 698             my $dtb;
 699             @$modules = map { if (/\.dtb$/) { $dtb=$_; (); } else { $_ } } @$modules;
 700             my $initrd = join ",", @$modules;
 701
 702             push(@qemu_flags, ('-kernel', $kbin, '-append', $kcmd));
 703             push(@qemu_flags, ('-initrd', $initrd)) if $initrd;
 704             push(@qemu_flags, ('-dtb', $dtb)) if $dtb;
 705         }
 706     }
 707     push(@qemu_flags,  qw(-serial stdio)); # Redirect serial output (for collecting test restuls)
 708     unshift(@qemu_flags, ('-name', $config_name));
 709     print "novaboot: Running: ".shell_cmd_string($qemu, @qemu_flags)."\n";
 710     $exp = Expect->spawn(($qemu, @qemu_flags)) || die("exec() failed: $!");
 711 }
 712
 713 ### Local DHCPD and TFTPD
 714
 715 my ($dhcpd_pid, $tftpd_pid);
 716
 717 if (defined $dhcp_tftp)
 718 {
 719     generate_configs("(nd)", $generated, $filename);
 720     system_verbose('mkdir -p tftpboot');
 721     generate_grub_config("tftpboot/os-menu.lst", $config_name, "(nd)", \@$modules, "timeout 0");
 722     open(my $fh, '>', 'dhcpd.conf');
 723     my $mac = `cat /sys/class/net/eth0/address`;
 724     chomp $mac;
 725     print $fh "subnet 10.23.23.0 netmask 255.255.255.0 {
 726                       range 10.23.23.10 10.23.23.100;
 727                       filename \"bin/boot/grub/pxegrub.pxe\";
 728                       next-server 10.23.23.1;
 729 }
 730 host server {
 731         hardware ethernet $mac;
 732         fixed-address 10.23.23.1;
 733 }";
 734     close($fh);
 735     system_verbose("sudo ip a add 10.23.23.1/24 dev eth0;
 736             sudo ip l set dev eth0 up;
 737             sudo touch dhcpd.leases");
 738
 739     # We run servers by forking ourselves, because the servers end up
 740     # in our process group and get killed by signals sent to the
 741     # process group (e.g. Ctrl-C on terminal).
 742     $dhcpd_pid = fork();
 743     exec_verbose("sudo dhcpd -d -cf dhcpd.conf -lf dhcpd.leases -pf dhcpd.pid") if ($dhcpd_pid == 0);
 744     $tftpd_pid = fork();
 745     exec_verbose("sudo in.tftpd --foreground --secure -v -v -v --pidfile tftpd.pid $builddir") if ($tftpd_pid == 0);
 746
 747     # Kill server when we die
 748     $SIG{__DIE__} = sub { system_verbose('sudo pkill --pidfile=dhcpd.pid');
 749                           system_verbose('sudo pkill --pidfile=tftpd.pid'); };
 750 }
 751
 752 ### Serial line or IP relay
 753
 754 if (defined $target_reset) {
 755     print "novaboot: Reseting the test box... ";
 756     &$target_reset();
 757     print "done\n";
 758 }
 759
 760 if (defined $uboot) {
 761     print "novaboot: Waiting for uBoot prompt...\n";
 762     $exp->log_stdout(1);
 763     #$exp->exp_internal(1);
 764     $exp->expect(20,
 765                  [qr/Hit any key to stop autoboot:/, sub { $exp->send("\n"); exp_continue; }],
 766                  '=> ') || die "No uBoot prompt deteceted";
 767     $exp->send("$uboot_init\n") if $uboot_init;
 768     $exp->expect(10, '=> ') || die "uBoot prompt timeout";
 769
 770     my ($kbin, $kcmd) = split(' ', shift(@$modules), 2);
 771     my $dtb;
 772     @$modules = map { if (/\.dtb$/) { $dtb=$_; (); } else { $_ } } @$modules;
 773     my $initrd = shift @$modules;
 774
 775     my $kern_addr = '800000';
 776     my $initrd_addr = '-';
 777     my $dtb_addr = '';
 778
 779     $exp->send("tftp $kern_addr $kbin\n");
 780     $exp->expect(10,
 781                  [qr/#/, sub { exp_continue; }],
 782                  '=> ') || die "Kernel load failed";
 783     if (defined $dtb) {
 784         $dtb_addr = '7f0000';
 785         $exp->send("tftp $dtb_addr $dtb\n");
 786         $exp->expect(10,
 787                      [qr/#/, sub { exp_continue; }],
 788                      '=> ') || die "Device tree load failed";
 789     }
 790     if (defined $initrd) {
 791         $initrd_addr = 'b00000';
 792         $exp->send("tftp $initrd_addr $initrd\n");
 793         $exp->expect(10,
 794                      [qr/#/, sub { exp_continue; }],
 795                      '=> ') || die "Initrd load failed";
 796     }
 797     $exp->send("set bootargs '$kcmd'\n");
 798     $exp->expect(5, '=> ')  || die "uBoot prompt timeout";
 799     $exp->send("bootm $kern_addr $initrd_addr $dtb_addr\n");
 800     $exp->expect(5, "\n")  || die "uBoot command timeout";
 801 }
 802
 803 if (defined $exp) {
 804     # Serial line of the target is available
 805     my $interrupt = 'Ctrl-C';
 806     if ($interactive && !@exiton) {
 807         $interrupt = '"~~."';
 808     }
 809     print "novaboot: Serial line interaction (press $interrupt to interrupt)...\n";
 810     $exp->log_stdout(1);
 811     if (@exiton) {
 812         $exp->expect(undef, @expect_raw, @exiton);
 813     } else {
 814         my @inputs = ($exp);
 815         if (-t STDIN) { # Set up bi-directional communication if we run on terminal
 816             my $infile = new IO::File;
 817             $infile->IO::File::fdopen(*STDIN,'r');
 818             my $in_object = Expect->exp_init($infile);
 819             $in_object->set_group($exp);
 820
 821             if ($interactive) {
 822                 $in_object->set_seq('~~\.', sub { print "novaboot: Escape sequence detected\r\n"; undef; });
 823                 $in_object->manual_stty(0);       # Use raw terminal mode
 824             } else {
 825                 $in_object->manual_stty(1);       # Do not modify terminal settings
 826             }
 827             push(@inputs, $in_object);
 828         }
 829         #use Data::Dumper;
 830         #print Dumper(\@expect_raw);
 831         $exp->expect(undef, @expect_raw) if @expect_raw;
 832         Expect::interconnect(@inputs) unless defined($exp->exitstatus);
 833     }
 834 }
 835
 836 ## Kill dhcpc or tftpd
 837 if (defined $dhcp_tftp) {
 838     die("novaboot: This should kill servers on background\n");
 839 }
 840
 841 ## Documentation
 842
 843 =head1 NAME
 844
 845 novaboot - A tool for booting various operating systems on various hardware or in qemu
 846
 847 =head1 SYNOPSIS
 848
 849 B<novaboot> --help
 850
 851 B<novaboot> [option]... [--] script...
 852
 853 B<./script> [option]...
 854
 855 =head1 DESCRIPTION
 856
 857 This program makes booting of an operating system (e.g. NOVA or Linux)
 858 as simple as running a local program. It facilitates booting on local
 859 or remote hosts or in emulators such as qemu. Novaboot operation is
 860 controlled by command line options and by a so called novaboot script,
 861 which can be thought as a generalization of bootloader configuration
 862 files. Based on this input, novaboot setups everything for the target
 863 host to boot the desired configuration, i.e. it generates the
 864 bootloader configuration file in the proper format, deploy the
 865 binaries and other needed files to required locations, perhaps on a
 866 remote boot server and reset the target host. Finally, target host's
 867 serial output is redirected to standard output if that is possible.
 868
 869 Typical way of using novaboot is to make the novaboot script
 870 executable and set its first line to I<#!/usr/bin/env novaboot>. Then,
 871 booting a particular OS configuration becomes the same as executing a
 872 local program - the novaboot script.
 873
 874 For example, with C<novaboot> you can:
 875
 876 =over 3
 877
 878 =item 1.
 879
 880 Run an OS in Qemu. This is the default action when no other action is
 881 specified by command line switches. Thus running C<novaboot ./script>
 882 (or C<./script> as described above) will run Qemu and make it boot the
 883 configuration specified in the F<script>.
 884
 885 =item 2.
 886
 887 Create a bootloader configuration file (currently supported
 888 bootloaders are GRUB, GRUB2, Pulsar and U-Boot) and copy it with all
 889 other files needed for booting to a remote boot server.
 890
 891  ./script --server=192.168.1.1:/tftp --iprelay=192.168.1.2
 892
 893 This command copies files to the TFTP server and uses
 894 TCP/IP-controlled relay to reset the target host and receive its
 895 serial output.
 896
 897 =item 3.
 898
 899 Run DHCP and TFTP server on developer's machine to PXE-boot the target
 900 host from it. E.g.
 901
 902  ./script --dhcp-tftp
 903
 904 When a PXE-bootable machine is connected via Ethernet to developer's
 905 machine, it will boot the configuration described in I<script>.
 906
 907 =item 4.
 908
 909 Create bootable ISO images. E.g.
 910
 911  novaboot --iso -- script1 script2
 912
 913 The created ISO image will have GRUB bootloader installed on it and
 914 the boot menu will allow selecting between I<script1> and I<script2>
 915 configurations.
 916
 917 =back
 918
 919 Note that the options needed for a specific target can be stored in a
 920 L</"CONFIGURATION FILE">. Then it is sufficient to use only the B<-t>
 921 option to specify the name of the target.
 922
 923 =head1 PHASES AND OPTIONS
 924
 925 Novaboot performs its work in several phases. Each phase can be
 926 influenced by several options, certain phases can be skipped. The list
 927 of phases (in the execution order) and the corresponding options
 928 follow.
 929
 930 =head2 Configuration reading phase
 931
 932 After starting, novaboot reads configuration files. By default, it
 933 searches for files named F<.novaboot> starting from the directory of
 934 the novaboot script (or working directory, see bellow) and continuing
 935 upwards up to the root directory. The configuration files are read in
 936 order from the root directory downwards with latter files overriding
 937 settings from the former ones.
 938
 939 In certain cases, the location of the novaboot script cannot be
 940 determined in this early phase. This happens either when the script is
 941 read from the standard input or when novaboot is invoked explicitly
 942 and options precede the script name, as in the example L</"4."> above.
 943 In this case the current working directory is used as a starting point
 944 for configuration file search.
 945
 946 =over 8
 947
 948 =item -c, --config=I<filename>
 949
 950 Use the specified configuration file instead of the default one(s).
 951
 952 =back
 953
 954 =head2 Command line processing phase
 955
 956 =over 8
 957
 958 =item --dump-config
 959
 960 Dump the current configuration to stdout end exits. Useful as an
 961 initial template for a configuration file.
 962
 963 =item -h, --help
 964
 965 Print short (B<-h>) or long (B<--help>) help.
 966
 967 =item -t, --target=I<target>
 968
 969 This option serves as a user configurable shortcut for other novaboot
 970 options. The effect of this option is the same as the options stored
 971 in the C<%targets> configuration variable under key I<target>. See
 972 also L</"CONFIGURATION FILE">.
 973
 974 =back
 975
 976 =head2 Script preprocessing phase
 977
 978 This phases allows to modify the parsed novaboot script before it is
 979 used in the later phases.
 980
 981 =over 8
 982
 983 =item -a, --append=I<parameters>
 984
 985 Append a string to the first C<load> line in the novaboot script. This
 986 can be used to append parameters to the kernel's or root task's
 987 command line. Can appear multiple times.
 988
 989 =item -b, --bender
 990
 991 Use F<bender> chainloader. Bender scans the PCI bus for PCI serial
 992 ports and stores the information about them in the BIOS data area for
 993 use by the kernel.
 994
 995 =item --chainloader=I<chainloader>
 996
 997 Chainloader that is loaded before the kernel and other files specified
 998 in the novaboot script. E.g. 'bin/boot/bender promisc'.
 999
1000 =item --dump
1001
1002 Print the modules to boot and their parameters after this phase
1003 finishes. Then exit. This is useful for seeing the effect of other
1004 options in this section.
1005
1006 =item -k, --kernel=F<file>
1007
1008 Replace the first word on the first C<load> line in the novaboot
1009 script with F<file>.
1010
1011 =item --scriptmod=I<perl expression>
1012
1013 When novaboot script is read, I<perl expression> is executed for every
1014 line (in $_ variable). For example, C<novaboot
1015 --scriptmod=s/sigma0/omega6/g> replaces every occurrence of I<sigma0>
1016 in the script with I<omega6>.
1017
1018 When this option is present, it overrides I<$script_modifier> variable
1019 from the configuration file, which has the same effect. If this option
1020 is given multiple times all expressions are evaluated in the command
1021 line order.
1022
1023 =back
1024
1025 =head2 File generation phase
1026
1027 In this phase, files needed for booting are generated in a so called
1028 I<build directory> (see L</--build-dir>). In most cases configuration
1029 for a bootloader is generated automatically by novaboot. It is also
1030 possible to generate other files using I<heredoc> or I<"<"> syntax in
1031 novaboot scripts. Finally, binaries can be generated in this phases by
1032 running C<scons> or C<make>.
1033
1034 =over 8
1035
1036 =item --build-dir=I<directory>
1037
1038 Overrides the default build directory location.
1039
1040 The default build directory location is determined as follows: If the
1041 configuration file defines the C<$builddir> variable, its value is
1042 used. Otherwise, it is the directory that contains the first processed
1043 novaboot script.
1044
1045 See also L</BUILDDIR> variable.
1046
1047 =item -g, --grub[=I<filename>]
1048
1049 Generates grub bootloader menu file. If the I<filename> is not
1050 specified, F<menu.lst> is used. The I<filename> is relative to the
1051 build directory (see B<--build-dir>).
1052
1053 =item --grub-preamble=I<prefix>
1054
1055 Specifies the I<preable> that is at the beginning of the generated
1056 GRUB or GRUB2 config files. This is useful for specifying GRUB's
1057 timeout.
1058
1059 =item --grub-prefix=I<prefix>
1060
1061 Specifies I<prefix> that is put in front of every file name in GRUB's
1062 F<menu.lst>. The default value is the absolute path to the build directory.
1063
1064 If the I<prefix> contains string $NAME, it will be replaced with the
1065 name of the novaboot script (see also B<--name>).
1066
1067 =item --grub2[=I<filename>]
1068
1069 Generate GRUB2 menuentry in I<filename>. If I<filename> is not
1070 specified F<grub.cfg> is used. The content of the menuentry can be
1071 customized with B<--grub-preable>, B<--grub2-prolog> or
1072 B<--grub_prefix> options.
1073
1074 In order to use the the generated menuentry on your development
1075 machine that uses GRUB2, append the following snippet to
1076 F</etc/grub.d/40_custom> file and regenerate your grub configuration,
1077 i.e. run update-grub on Debian/Ubuntu.
1078
1079   if [ -f /path/to/nul/build/grub.cfg ]; then
1080     source /path/to/nul/build/grub.cfg
1081   fi
1082
1083 =item --grub2-prolog=I<prolog>
1084
1085 Specifies text I<preable> that is put at the beginning of the entry
1086 GRUB2 entry.
1087
1088 =item -m, --make[=make command]
1089
1090 Runs C<make> to build files that are not generated by novaboot itself.
1091
1092 =item --name=I<string>
1093
1094 Use the name I<string> instead of the name of the novaboot script.
1095 This name is used for things like a title of grub menu or for the
1096 server directory where the boot files are copied to.
1097
1098 =item --no-file-gen
1099
1100 Do not generate files on the fly (i.e. "<" syntax) except for the
1101 files generated via "<<WORD" syntax.
1102
1103 =item -p, --pulsar[=mac]
1104
1105 Generates pulsar bootloader configuration file named F<config-I<mac>>
1106 The I<mac> string is typically a MAC address and defaults to
1107 I<novaboot>.
1108
1109 =item --scons[=scons command]
1110
1111 Runs C<scons> to build files that are not generated by novaboot
1112 itself.
1113
1114 =item --strip-rom
1115
1116 Strip I<rom://> prefix from command lines and generated config files.
1117 The I<rom://> prefix is used by NUL. For NRE, it has to be stripped.
1118
1119 =item --gen-only
1120
1121 Exit novaboot after file generation phase.
1122
1123 =back
1124
1125 =head2 Target connection check
1126
1127 If supported by the target, the connection to it is made and it is
1128 checked whether the target is not occupied by another novaboot
1129 user/instance.
1130
1131 =over 8
1132
1133 =item --iprelay=I<addr[:port]>
1134
1135 Use TCP/IP relay and serial port to access the target's serial port
1136 and powercycle it. The IP address of the relay is given by I<addr>
1137 parameter. If I<port> is not specified, it default to 23.
1138
1139 Note: This option is supposed to work with HWG-ER02a IP relays.
1140
1141 =item -s, --serial[=device]
1142
1143 Target's serial line is connected to host's serial line (device). The
1144 default value for device is F</dev/ttyUSB0>.
1145
1146 The value of this option is exported in NB_NOVABOOT environment
1147 variable to all subprocesses run by C<novaboot>.
1148
1149 =item --stty=I<settings>
1150
1151 Specifies settings passed to C<stty> invoked on the serial line
1152 specified with B<--serial> option. If this option is not given,
1153 C<stty> is called with C<raw -crtscts -onlcr 115200> settings.
1154
1155 =item --remote-cmd=I<cmd>
1156
1157 Command that mediates connection to the target's serial line. For
1158 example C<ssh server 'cu -l /dev/ttyS0'>.
1159
1160 =item --remote-expect=I<string>
1161
1162 Wait for reception of I<string> after establishing the the remote
1163 connection before continuing.
1164
1165 =back
1166
1167 =head2 File deployment phase
1168
1169 In some setups, it is necessary to copy the files needed for booting
1170 to a particular location, e.g. to a TFTP boot server or to the
1171 F</boot> partition.
1172
1173 =over 8
1174
1175 =item -d, --dhcp-tftp
1176
1177 Turns your workstation into a DHCP and TFTP server so that the OS can
1178 be booted via PXE BIOS (or similar mechanism) on the test machine
1179 directly connected by a plain Ethernet cable to your workstation.
1180
1181 The DHCP and TFTP servers require root privileges and C<novaboot>
1182 uses C<sudo> command to obtain those. You can put the following to
1183 I</etc/sudoers> to allow running the necessary commands without
1184 asking for password.
1185
1186  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 --foreground --secure -v -v -v --pidfile tftpd.pid *, /usr/bin/touch dhcpd.leases, /usr/bin/pkill --pidfile=dhcpd.pid, /usr/bin/pkill --pidfile=tftpd.pid
1187  your_login ALL=NOPASSWD: NOVABOOT
1188
1189 =item --iso[=filename]
1190
1191 Generates the ISO image that boots NOVA system via GRUB. If no filename
1192 is given, the image is stored under I<NAME>.iso, where I<NAME> is the name
1193 of the novaboot script (see also B<--name>).
1194
1195 =item --server[=[[user@]server:]path]
1196
1197 Copy all files needed for booting to another location (implies B<-g>
1198 unless B<--grub2> is given). The files will be copied (by B<rsync>
1199 tool) to the directory I<path>. If the I<path> contains string $NAME,
1200 it will be replaced with the name of the novaboot script (see also
1201 B<--name>).
1202
1203 =item --concat
1204
1205 If B<--server> is used and its value ends with $NAME, then after
1206 copying the files, a new bootloader configuration file (e.g. menu.lst)
1207 is created at I<path-wo-name>, i.e. the path specified by B<--server>
1208 with $NAME part removed. The content of the file is created by
1209 concatenating all files of the same name from all subdirectories of
1210 I<path-wo-name> found on the "server".
1211
1212 =item --rsync-flags=I<flags>
1213
1214 Specifies which I<flags> are appended to F<rsync> command line when
1215 copying files as a result of I<--server> option.
1216
1217 =back
1218
1219 =head2 Target power-on and reset phase
1220
1221 =over 8
1222
1223 =item --on, --off
1224
1225 Switch on/off the target machine. Currently works only with
1226 B<--iprelay>.
1227
1228 =item -Q, --qemu[=I<qemu-binary>]
1229
1230 Boot the configuration in qemu. Optionally, the name of qemu binary
1231 can be specified as a parameter.
1232
1233 =item --qemu-append=I<flags>
1234
1235 Append I<flags> to the default qemu flags (QEMU_FLAGS variable or
1236 C<-cpu coreduo -smp 2>).
1237
1238 =item -q, --qemu-flags=I<flags>
1239
1240 Replace the default qemu flags (QEMU_FLAGS variable or C<-cpu coreduo
1241 -smp 2>) with I<flags> specified here.
1242
1243 =item --reset-cmd=I<cmd>
1244
1245 Command that resets the target.
1246
1247 =back
1248
1249 =head2 Interaction with the bootloader on the target
1250
1251 =over 8
1252
1253 =item --uboot
1254
1255 Interact with uBoot bootloader to boot the thing described in the
1256 novaboot script. Implementation of this option is currently tied to a
1257 particular board that we use. It may be subject to changes in the
1258 future!
1259
1260 =item --uboot-init
1261
1262 Command(s) to send the U-Boot bootloader before loading the images and
1263 booting them.
1264
1265 =back
1266
1267 =head2 Target interaction phase
1268
1269 In this phase, target's serial output is redirected to stdout and if
1270 stdin is a TTY, it is redirected to the target's serial input allowing
1271 interactive work with the target.
1272
1273 =over 8
1274
1275 =item --exiton=I<string>
1276
1277 When I<string> is sent by the target, novaboot exits. This option can
1278 be specified multiple times.
1279
1280 If I<string> is C<-re>, then the next B<--exiton>'s I<string> is
1281 treated as regular expression. For example:
1282
1283     --exiton -re --exiton 'error:.*failed'
1284
1285 =item -i, --interactive
1286
1287 Setup things for interactive use of target. Your terminal will be
1288 switched to raw mode. In raw mode, your system does not process input
1289 in any way (no echoing of entered characters, no interpretation
1290 special characters). This, among others, means that Ctrl-C is passed
1291 to the target and does no longer interrupt novaboot. Use "~~."
1292 sequence to exit novaboot.
1293
1294 =item --expect=I<string>
1295
1296 When I<string> is received from the target, send the string specified
1297 with the subsequent B<--send*> option to the target.
1298
1299 =item --expect-re=I<regex>
1300
1301 When target's output matches regular expression I<regex>, send the
1302 string specified with the subsequent B<--send*> option to the target.
1303
1304 =item --expect-raw=I<perl-code>
1305
1306 Provides direct control over Perl's Expect module.
1307
1308 =item --send=I<string>
1309
1310 Send I<string> to the target after the previously specified
1311 B<--expect*> was matched in the target's output. The I<string> may
1312 contain escape sequences such as "\n".
1313
1314 Note that I<string> is actually interpreted by Perl, so it can contain
1315 much more that escape sequences. This behavior may change in the
1316 future.
1317
1318 Example: C<--expect='login: ' --send='root\n'>
1319
1320 =item --sendcont=I<string>
1321
1322 Similar to B<--send> but continue expecting more input.
1323
1324 Example: C<--expect='Continue?' --sendcont='yes\n'>
1325
1326 =back
1327
1328 =head1 NOVABOOT SCRIPT SYNTAX
1329
1330 The syntax tries to mimic POSIX shell syntax. The syntax is defined
1331 with the following rules.
1332
1333 Lines starting with "#" and empty lines are ignored.
1334
1335 Lines that end with "\" are concatenated with the following line after
1336 removal of the final "\" and leading whitespace of the following line.
1337
1338 Lines of the form I<VARIABLE=...> (i.e. matching '^[A-Z_]+=' regular
1339 expression) assign values to internal variables. See L</VARIABLES>
1340 section.
1341
1342 Lines starting with C<load> keyword represent modules to boot. The
1343 word after C<load> is a file name (relative to the build directory
1344 (see B<--build-dir>) of the module to load and the remaining words are
1345 passed to it as the command line parameters.
1346
1347 When the C<load> line ends with "<<WORD" then the subsequent lines
1348 until the line containing solely WORD are copied literally to the file
1349 named on that line. This is similar to shell's heredoc feature.
1350
1351 When the C<load> line ends with "< CMD" then command CMD is executed
1352 with C</bin/sh> and its standard output is stored in the file named on
1353 that line. The SRCDIR variable in CMD's environment is set to the
1354 absolute path of the directory containing the interpreted novaboot
1355 script.
1356
1357 Example:
1358   #!/usr/bin/env novaboot
1359   WVDESC=Example program
1360   load bin/apps/sigma0.nul S0_DEFAULT script_start:1,1 \
1361     verbose hostkeyb:0,0x60,1,12,2
1362   load bin/apps/hello.nul
1363   load hello.nulconfig <<EOF
1364   sigma0::mem:16 name::/s0/log name::/s0/timer name::/s0/fs/rom ||
1365   rom://bin/apps/hello.nul
1366   EOF
1367
1368 This example will load three modules: F<sigma0.nul>, F<hello.nul> and
1369 F<hello.nulconfig>. sigma0 receives some command line parameters and
1370 F<hello.nulconfig> file is generated on the fly from the lines between
1371 C<<<EOF> and C<EOF>.
1372
1373 =head2 VARIABLES
1374
1375 The following variables are interpreted in the novaboot script:
1376
1377 =over 8
1378
1379 =item BUILDDIR
1380
1381 Novaboot chdir()s to this directory before file generation phase. The
1382 directory name specified here is relative to the build directory
1383 specified by other means (see L</--build-dir>).
1384
1385 =item EXITON
1386
1387 Assigning this variable has the same effect as specifying L</--exiton>
1388 option.
1389
1390 =item HYPERVISOR_PARAMS
1391
1392 Parameters passed to hypervisor. The default value is "serial", unless
1393 overridden in configuration file.
1394
1395 =item KERNEL
1396
1397 The kernel to use instead of the hypervisor specified in the
1398 configuration file with the C<$hypervisor> variable. The value should
1399 contain the name of the kernel image as well as its command line
1400 parameters. If this variable is defined and non-empty, the variable
1401 HYPERVISOR_PARAMS is not used.
1402
1403 =item QEMU
1404
1405 Use a specific qemu binary (can be overridden with B<-Q>) and flags
1406 when booting this script under qemu. If QEMU_FLAGS variable is also
1407 specified flags specified in QEMU variable are replaced by those in
1408 QEMU_FLAGS.
1409
1410 =item QEMU_FLAGS
1411
1412 Use specific qemu flags (can be overridden with B<-q>).
1413
1414 =item WVDESC
1415
1416 Description of the wvtest-compliant program.
1417
1418 =item WVTEST_TIMEOUT
1419
1420 The timeout in seconds for WvTest harness. If no complete line appears
1421 in the test output within the time specified here, the test fails. It
1422 is necessary to specify this for long running tests that produce no
1423 intermediate output.
1424
1425 =back
1426
1427 =head1 CONFIGURATION FILE
1428
1429 Novaboot can read its configuration from one or more files. By
1430 default, novaboot looks for files named F<.novaboot> as described in
1431 L</Configuration reading phase>. Alternatively, its location can be
1432 specified with the B<-c> switch or with the NOVABOOT_CONFIG
1433 environment variable. The configuration file has perl syntax and
1434 should set values of certain Perl variables. The current configuration
1435 can be dumped with the B<--dump-config> switch. Some configuration
1436 variables can be overridden by environment variables (see below) or by
1437 command line switches.
1438
1439 Supported configuration variables include:
1440
1441 =over 8
1442
1443 =item $builddir
1444
1445 Build directory location relative to the location of the configuration
1446 file.
1447
1448 =item $default_target
1449
1450 Default target (see below) to use when no target is explicitly
1451 specified on command line with the B<--target> option.
1452
1453 =item %targets
1454
1455 Hash of shortcuts to be used with the B<--target> option. If the hash
1456 contains, for instance, the following pair of values
1457
1458  'mybox' => '--server=boot:/tftproot --serial=/dev/ttyUSB0 --grub',
1459
1460 then the following two commands are equivalent:
1461
1462  ./script --server=boot:/tftproot --serial=/dev/ttyUSB0 --grub
1463  ./script -t mybox
1464
1465 =back
1466
1467 =head1 ENVIRONMENT VARIABLES
1468
1469 Some options can be specified not only via config file or command line
1470 but also through environment variables. Environment variables override
1471 the values from configuration file and command line parameters
1472 override the environment variables.
1473
1474 =over 8
1475
1476 =item NOVABOOT_CONFIG
1477
1478 Name of the novaboot configuration file to use instead of the default
1479 one(s).
1480
1481 =item NOVABOOT_BENDER
1482
1483 Defining this variable has the same meaning as B<--bender> option.
1484
1485 =back
1486
1487 =head1 AUTHORS
1488
1489 Michal Sojka <sojka@os.inf.tu-dresden.de>