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 it easier to boot NOVA or other operating system
 858 (OS) on different targets (machines or emulators). It reads a so
 859 called novaboot script, that specifies the boot configuration, and
 860 setups the target to boot that configuration. Setting up the target
 861 means to generate the bootloader configuration files, deploy the
 862 binaries and other needed files to proper locations, perhaps on a
 863 remote boot server and reset the target. Then, target's serial output
 864 is redirected to standard output if that is possible.
 865
 866 A typical way of using novaboot is to make the novaboot script
 867 executable and set its first line to I<#!/usr/bin/env novaboot>. Then,
 868 booting a particular OS configuration becomes the same as executing a
 869 local program - the novaboot script.
 870
 871 For example, with C<novaboot> you can:
 872
 873 =over 3
 874
 875 =item 1.
 876
 877 Run an OS in Qemu. This is the default action when no other action is
 878 specified by command line switches. Thus running C<novaboot ./script>
 879 (or C<./script> as described above) will run Qemu and make it boot the
 880 configuration specified in the I<script>.
 881
 882 =item 2.
 883
 884 Create a bootloader configuration file (currently supported
 885 bootloaders are GRUB, GRUB2, Pulsar and uBoot) and copy it with all
 886 other files needed for booting to another, perhaps remote, location.
 887
 888  ./script --server=192.168.1.1:/tftp --iprelay=192.168.1.2
 889
 890 This command copies files to the TFTP server and uses
 891 TCP/IP-controlled relay to reset the test box and receive its serial
 892 output.
 893
 894 =item 3.
 895
 896 Run DHCP and TFTP server on developer's machine to PXE-boot the OS
 897 from it. E.g.
 898
 899  ./script --dhcp-tftp
 900
 901 When a PXE-bootable machine is connected via Ethernet to developer's
 902 machine, it will boot the configuration described in I<script>.
 903
 904 =item 4.
 905
 906 Create bootable ISO images. E.g.
 907
 908  novaboot --iso -- script1 script2
 909
 910 The created ISO image will have GRUB bootloader installed on it and
 911 the boot menu will allow selecting between I<script1> and I<script2>
 912 configurations.
 913
 914 =back
 915
 916 Note that the options needed for a specific target can be stored in a
 917 L</"CONFIGURATION FILE"> and then it is sufficient to use only the
 918 B<-t> option to specify the name of the target.
 919
 920 =head1 PHASES AND OPTIONS
 921
 922 Novaboot performs its work in several phases. Each phase can be
 923 influenced by several options, certain phases can be skipped. The list
 924 of phases (in the execution order) and the corresponding options
 925 follow.
 926
 927 =head2 Configuration reading phase
 928
 929 After starting, novaboot reads configuration files. By default, it
 930 searches for files named F<.novaboot> starting from the directory of
 931 the novaboot script (or working directory, see bellow) and continuing
 932 upwards up to the root directory. The configuration files are read in
 933 order from the root directory downwards with latter files overriding
 934 settings from the former ones.
 935
 936 In certain cases, the location of the novaboot script cannot be
 937 determined in this early phase. This happens either when the script is
 938 read from the standard input or when novaboot is invoked explicitly
 939 and options precede the script name, as in the example L</"4."> above.
 940 In this case the current working directory is used as a starting point
 941 for configuration file search.
 942
 943 =over 8
 944
 945 =item -c, --config=I<filename>
 946
 947 Use the specified configuration file instead of the default one(s).
 948
 949 =back
 950
 951 =head2 Command line processing phase
 952
 953 =over 8
 954
 955 =item --dump-config
 956
 957 Dump the current configuration to stdout end exits. Useful as an
 958 initial template for a configuration file.
 959
 960 =item -h, --help
 961
 962 Print short (B<-h>) or long (B<--help>) help.
 963
 964 =item -t, --target=I<target>
 965
 966 This option serves as a user configurable shortcut for other novaboot
 967 options. The effect of this option is the same as the options stored
 968 in the C<%targets> configuration variable under key I<target>. See
 969 also L</"CONFIGURATION FILE">.
 970
 971 =back
 972
 973 =head2 Script preprocessing phase
 974
 975 This phases allows to modify the parsed novaboot script before it is
 976 used in the later phases.
 977
 978 =over 8
 979
 980 =item -a, --append=I<parameters>
 981
 982 Append a string to the first C<load> line in the novaboot script. This
 983 can be used to append parameters to the kernel's or root task's
 984 command line. Can appear multiple times.
 985
 986 =item -b, --bender
 987
 988 Use F<bender> chainloader. Bender scans the PCI bus for PCI serial
 989 ports and stores the information about them in the BIOS data area for
 990 use by the kernel.
 991
 992 =item --chainloader=I<chainloader>
 993
 994 Chainloader that is loaded before the kernel and other files specified
 995 in the novaboot script. E.g. 'bin/boot/bender promisc'.
 996
 997 =item --dump
 998
 999 Print the modules to boot and their parameters after this phase
1000 finishes. Then exit. This is useful for seeing the effect of other
1001 options in this section.
1002
1003 =item -k, --kernel=F<file>
1004
1005 Replace the first word on the first C<load> line in the novaboot
1006 script with F<file>.
1007
1008 =item --scriptmod=I<perl expression>
1009
1010 When novaboot script is read, I<perl expression> is executed for every
1011 line (in $_ variable). For example, C<novaboot
1012 --scriptmod=s/sigma0/omega6/g> replaces every occurrence of I<sigma0>
1013 in the script with I<omega6>.
1014
1015 When this option is present, it overrides I<$script_modifier> variable
1016 from the configuration file, which has the same effect. If this option
1017 is given multiple times all expressions are evaluated in the command
1018 line order.
1019
1020 =back
1021
1022 =head2 File generation phase
1023
1024 In this phase, files needed for booting are generated in a so called
1025 I<build directory> (see L<--build-dir>). In most cases configuration
1026 for a bootloader is generated automatically by novaboot. It is also
1027 possible to generate other files using I<heredoc> or I<"<"> syntax in
1028 novaboot scripts. Finally, binaries can be generated in this phases by
1029 running C<scons> or C<make>.
1030
1031 =over 8
1032
1033 =item --build-dir=I<directory>
1034
1035 Overrides the default build directory location.
1036
1037 The default build directory location is determined as follows: If the
1038 configuration file defines the C<$builddir> variable, its value is
1039 used. Otherwise, it is the directory that contains the first processed
1040 novaboot script.
1041
1042 See also L<BUILDDIR> variable.
1043
1044 =item -g, --grub[=I<filename>]
1045
1046 Generates grub bootloader menu file. If the I<filename> is not
1047 specified, F<menu.lst> is used. The I<filename> is relative to the
1048 build directory (see B<--build-dir>).
1049
1050 =item --grub-preamble=I<prefix>
1051
1052 Specifies the I<preable> that is at the beginning of the generated
1053 GRUB or GRUB2 config files. This is useful for specifying GRUB's
1054 timeout.
1055
1056 =item --grub-prefix=I<prefix>
1057
1058 Specifies I<prefix> that is put in front of every file name in GRUB's
1059 F<menu.lst>. The default value is the absolute path to the build directory.
1060
1061 If the I<prefix> contains string $NAME, it will be replaced with the
1062 name of the novaboot script (see also B<--name>).
1063
1064 =item --grub2[=I<filename>]
1065
1066 Generate GRUB2 menuentry in I<filename>. If I<filename> is not
1067 specified F<grub.cfg> is used. The content of the menuentry can be
1068 customized with B<--grub-preable>, B<--grub2-prolog> or
1069 B<--grub_prefix> options.
1070
1071 In order to use the the generated menuentry on your development
1072 machine that uses GRUB2, append the following snippet to
1073 F</etc/grub.d/40_custom> file and regenerate your grub configuration,
1074 i.e. run update-grub on Debian/Ubuntu.
1075
1076   if [ -f /path/to/nul/build/grub.cfg ]; then
1077     source /path/to/nul/build/grub.cfg
1078   fi
1079
1080 =item --grub2-prolog=I<prolog>
1081
1082 Specifies text I<preable> that is put at the beginning of the entry
1083 GRUB2 entry.
1084
1085 =item -m, --make[=make command]
1086
1087 Runs C<make> to build files that are not generated by novaboot itself.
1088
1089 =item --name=I<string>
1090
1091 Use the name I<string> instead of the name of the novaboot script.
1092 This name is used for things like a title of grub menu or for the
1093 server directory where the boot files are copied to.
1094
1095 =item --no-file-gen
1096
1097 Do not generate files on the fly (i.e. "<" syntax) except for the
1098 files generated via "<<WORD" syntax.
1099
1100 =item -p, --pulsar[=mac]
1101
1102 Generates pulsar bootloader configuration file named F<config-I<mac>>
1103 The I<mac> string is typically a MAC address and defaults to
1104 I<novaboot>.
1105
1106 =item --scons[=scons command]
1107
1108 Runs C<scons> to build files that are not generated by novaboot
1109 itself.
1110
1111 =item --strip-rom
1112
1113 Strip I<rom://> prefix from command lines and generated config files.
1114 The I<rom://> prefix is used by NUL. For NRE, it has to be stripped.
1115
1116 =item --gen-only
1117
1118 Exit novaboot after file generation phase.
1119
1120 =back
1121
1122 =head2 Target connection check
1123
1124 If supported by the target, the connection to it is made and it is
1125 checked whether the target is not occupied by another novaboot
1126 user/instance.
1127
1128 =over 8
1129
1130 =item --iprelay=I<addr[:port]>
1131
1132 Use TCP/IP relay and serial port to access the target's serial port
1133 and powercycle it. The IP address of the relay is given by I<addr>
1134 parameter. If I<port> is not specified, it default to 23.
1135
1136 Note: This option is supposed to work with HWG-ER02a IP relays.
1137
1138 =item -s, --serial[=device]
1139
1140 Target's serial line is connected to host's serial line (device). The
1141 default value for device is F</dev/ttyUSB0>.
1142
1143 The value of this option is exported in NB_NOVABOOT environment
1144 variable to all subprocesses run by C<novaboot>.
1145
1146 =item --stty=I<settings>
1147
1148 Specifies settings passed to C<stty> invoked on the serial line
1149 specified with B<--serial> option. If this option is not given,
1150 C<stty> is called with C<raw -crtscts -onlcr 115200> settings.
1151
1152 =item --remote-cmd=I<cmd>
1153
1154 Command that mediates connection to the target's serial line. For
1155 example C<ssh server 'cu -l /dev/ttyS0'>.
1156
1157 =item --remote-expect=I<string>
1158
1159 Wait for reception of I<string> after establishing the the remote
1160 connection before continuing.
1161
1162 =back
1163
1164 =head2 File deployment phase
1165
1166 In some setups, it is necessary to copy the files needed for booting
1167 to a particular location, e.g. to a TFTP boot server or to the
1168 F</boot> partition.
1169
1170 =over 8
1171
1172 =item -d, --dhcp-tftp
1173
1174 Turns your workstation into a DHCP and TFTP server so that the OS can
1175 be booted via PXE BIOS (or similar mechanism) on the test machine
1176 directly connected by a plain Ethernet cable to your workstation.
1177
1178 The DHCP and TFTP servers require root privileges and C<novaboot>
1179 uses C<sudo> command to obtain those. You can put the following to
1180 I</etc/sudoers> to allow running the necessary commands without
1181 asking for password.
1182
1183  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
1184  your_login ALL=NOPASSWD: NOVABOOT
1185
1186 =item --iso[=filename]
1187
1188 Generates the ISO image that boots NOVA system via GRUB. If no filename
1189 is given, the image is stored under I<NAME>.iso, where I<NAME> is the name
1190 of the novaboot script (see also B<--name>).
1191
1192 =item --server[=[[user@]server:]path]
1193
1194 Copy all files needed for booting to another location (implies B<-g>
1195 unless B<--grub2> is given). The files will be copied (by B<rsync>
1196 tool) to the directory I<path>. If the I<path> contains string $NAME,
1197 it will be replaced with the name of the novaboot script (see also
1198 B<--name>).
1199
1200 =item --concat
1201
1202 If B<--server> is used and its value ends with $NAME, then after
1203 copying the files, a new bootloader configuration file (e.g. menu.lst)
1204 is created at I<path-wo-name>, i.e. the path specified by B<--server>
1205 with $NAME part removed. The content of the file is created by
1206 concatenating all files of the same name from all subdirectories of
1207 I<path-wo-name> found on the "server".
1208
1209 =item --rsync-flags=I<flags>
1210
1211 Specifies which I<flags> are appended to F<rsync> command line when
1212 copying files as a result of I<--server> option.
1213
1214 =back
1215
1216 =head2 Target power-on and reset phase
1217
1218 =over 8
1219
1220 =item --on, --off
1221
1222 Switch on/off the target machine. Currently works only with
1223 B<--iprelay>.
1224
1225 =item -Q, --qemu[=I<qemu-binary>]
1226
1227 Boot the configuration in qemu. Optionally, the name of qemu binary
1228 can be specified as a parameter.
1229
1230 =item --qemu-append=I<flags>
1231
1232 Append I<flags> to the default qemu flags (QEMU_FLAGS variable or
1233 C<-cpu coreduo -smp 2>).
1234
1235 =item -q, --qemu-flags=I<flags>
1236
1237 Replace the default qemu flags (QEMU_FLAGS variable or C<-cpu coreduo
1238 -smp 2>) with I<flags> specified here.
1239
1240 =item --reset-cmd=I<cmd>
1241
1242 Command that resets the target.
1243
1244 =back
1245
1246 =head2 Interaction with the bootloader on the target
1247
1248 =over 8
1249
1250 =item --uboot
1251
1252 Interact with uBoot bootloader to boot the thing described in the
1253 novaboot script. Implementation of this option is currently tied to a
1254 particular board that we use. It may be subject to changes in the
1255 future!
1256
1257 =item --uboot-init
1258
1259 Command(s) to send the U-Boot bootloader before loading the images and
1260 booting them.
1261
1262 =back
1263
1264 =head2 Target interaction phase
1265
1266 In this phase, target's serial output is redirected to stdout and if
1267 stdin is a TTY, it is redirected to the target's serial input allowing
1268 interactive work with the target.
1269
1270 =over 8
1271
1272 =item --exiton=I<string>
1273
1274 When I<string> is sent by the target, novaboot exits. This option can
1275 be specified multiple times.
1276
1277 If I<string> is C<-re>, then the next B<--exiton>'s I<string> is
1278 treated as regular expression. For example:
1279
1280     --exiton -re --exiton 'error:.*failed'
1281
1282 =item -i, --interactive
1283
1284 Setup things for interactive use of target. Your terminal will be
1285 switched to raw mode. In raw mode, your system does not process input
1286 in any way (no echoing of entered characters, no interpretation
1287 special characters). This, among others, means that Ctrl-C is passed
1288 to the target and does no longer interrupt novaboot. Use "~~."
1289 sequence to exit novaboot.
1290
1291 =item --expect=I<string>
1292
1293 When I<string> is received from the target, send the string specified
1294 with the subsequent B<--send*> option to the target.
1295
1296 =item --expect-re=I<regex>
1297
1298 When target's output matches regular expression I<regex>, send the
1299 string specified with the subsequent B<--send*> option to the target.
1300
1301 =item --expect-raw=I<perl-code>
1302
1303 Provides direct control over Perl's Expect module.
1304
1305 =item --send=I<string>
1306
1307 Send I<string> to the target after the previously specified
1308 B<--expect*> was matched in the target's output. The I<string> may
1309 contain escape sequences such as "\n".
1310
1311 Note that I<string> is actually interpreted by Perl, so it can contain
1312 much more that escape sequences. This behavior may change in the
1313 future.
1314
1315 Example: C<--expect='login: ' --send='root\n'>
1316
1317 =item --sendcont=I<string>
1318
1319 Similar to B<--send> but continue expecting more input.
1320
1321 Example: C<--expect='Continue?' --sendcont='yes\n'>
1322
1323 =back
1324
1325 =head1 NOVABOOT SCRIPT SYNTAX
1326
1327 The syntax tries to mimic POSIX shell syntax. The syntax is defined
1328 with the following rules.
1329
1330 Lines starting with "#" and empty lines are ignored.
1331
1332 Lines that end with "\" are concatenated with the following line after
1333 removal of the final "\" and leading whitespace of the following line.
1334
1335 Lines of the form I<VARIABLE=...> (i.e. matching '^[A-Z_]+=' regular
1336 expression) assign values to internal variables. See L<VARIABLES>
1337 section.
1338
1339 Lines starting with C<load> keyword represent modules to boot. The
1340 word after C<load> is a file name (relative to the build directory
1341 (see B<--build-dir>) of the module to load and the remaining words are
1342 passed to it as the command line parameters.
1343
1344 When the C<load> line ends with "<<WORD" then the subsequent lines
1345 until the line containing solely WORD are copied literally to the file
1346 named on that line. This is similar to shell's heredoc feature.
1347
1348 When the C<load> line ends with "< CMD" then command CMD is executed
1349 with C</bin/sh> and its standard output is stored in the file named on
1350 that line. The SRCDIR variable in CMD's environment is set to the
1351 absolute path of the directory containing the interpreted novaboot
1352 script.
1353
1354 Example:
1355   #!/usr/bin/env novaboot
1356   WVDESC=Example program
1357   load bin/apps/sigma0.nul S0_DEFAULT script_start:1,1 \
1358     verbose hostkeyb:0,0x60,1,12,2
1359   load bin/apps/hello.nul
1360   load hello.nulconfig <<EOF
1361   sigma0::mem:16 name::/s0/log name::/s0/timer name::/s0/fs/rom ||
1362   rom://bin/apps/hello.nul
1363   EOF
1364
1365 This example will load three modules: F<sigma0.nul>, F<hello.nul> and
1366 F<hello.nulconfig>. sigma0 receives some command line parameters and
1367 F<hello.nulconfig> file is generated on the fly from the lines between
1368 C<<<EOF> and C<EOF>.
1369
1370 =head2 VARIABLES
1371
1372 The following variables are interpreted in the novaboot script:
1373
1374 =over 8
1375
1376 =item BUILDDIR
1377
1378 Novaboot chdir()s to this directory before file generation phase. The
1379 directory name specified here is relative to the build directory
1380 specified by other means (see L</--build-dir>).
1381
1382 =item EXITON
1383
1384 Assigning this variable has the same effect as specifying L</--exiton>
1385 option.
1386
1387 =item HYPERVISOR_PARAMS
1388
1389 Parameters passed to hypervisor. The default value is "serial", unless
1390 overridden in configuration file.
1391
1392 =item KERNEL
1393
1394 The kernel to use instead of the hypervisor specified in the
1395 configuration file with the C<$hypervisor> variable. The value should
1396 contain the name of the kernel image as well as its command line
1397 parameters. If this variable is defined and non-empty, the variable
1398 HYPERVISOR_PARAMS is not used.
1399
1400 =item QEMU
1401
1402 Use a specific qemu binary (can be overridden with B<-Q>) and flags
1403 when booting this script under qemu. If QEMU_FLAGS variable is also
1404 specified flags specified in QEMU variable are replaced by those in
1405 QEMU_FLAGS.
1406
1407 =item QEMU_FLAGS
1408
1409 Use specific qemu flags (can be overridden with B<-q>).
1410
1411 =item WVDESC
1412
1413 Description of the wvtest-compliant program.
1414
1415 =item WVTEST_TIMEOUT
1416
1417 The timeout in seconds for WvTest harness. If no complete line appears
1418 in the test output within the time specified here, the test fails. It
1419 is necessary to specify this for long running tests that produce no
1420 intermediate output.
1421
1422 =back
1423
1424 =head1 CONFIGURATION FILE
1425
1426 Novaboot can read its configuration from one or more files. By
1427 default, novaboot looks for files named F<.novaboot> as described in
1428 L</Configuration reading phase>. Alternatively, its location can be
1429 specified with the B<-c> switch or with the NOVABOOT_CONFIG
1430 environment variable. The configuration file has perl syntax and
1431 should set values of certain Perl variables. The current configuration
1432 can be dumped with the B<--dump-config> switch. Some configuration
1433 variables can be overridden by environment variables (see below) or by
1434 command line switches.
1435
1436 Supported configuration variables include:
1437
1438 =over 8
1439
1440 =item $builddir
1441
1442 Build directory location relative to the location of the configuration
1443 file.
1444
1445 =item $default_target
1446
1447 Default target (see below) to use when no target is explicitly
1448 specified on command line with the B<--target> option.
1449
1450 =item %targets
1451
1452 Hash of shortcuts to be used with the B<--target> option. If the hash
1453 contains, for instance, the following pair of values
1454
1455  'mybox' => '--server=boot:/tftproot --serial=/dev/ttyUSB0 --grub',
1456
1457 then the following two commands are equivalent:
1458
1459  ./script --server=boot:/tftproot --serial=/dev/ttyUSB0 --grub
1460  ./script -t mybox
1461
1462 =back
1463
1464 =head1 ENVIRONMENT VARIABLES
1465
1466 Some options can be specified not only via config file or command line
1467 but also through environment variables. Environment variables override
1468 the values from configuration file and command line parameters
1469 override the environment variables.
1470
1471 =over 8
1472
1473 =item NOVABOOT_CONFIG
1474
1475 Name of the novaboot configuration file to use instead of the default
1476 one(s).
1477
1478 =item NOVABOOT_BENDER
1479
1480 Defining this variable has the same meaning as B<--bender> option.
1481
1482 =back
1483
1484 =head1 AUTHORS
1485
1486 Michal Sojka <sojka@os.inf.tu-dresden.de>