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.
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.
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/>.
18 use warnings (exists $ENV{NOVABOOT_TEST} ? (FATAL => 'all') : ());
19 use Getopt::Long qw(GetOptionsFromString);
24 use Time::HiRes("usleep");
28 use POSIX qw(:errno_h);
29 use Cwd qw(getcwd abs_path);
35 my $invocation_dir = $ENV{PWD} || getcwd();
37 ## Configuration file handling
39 # Default configuration
40 $CFG::hypervisor = "";
41 $CFG::hypervisor_params = "serial";
42 $CFG::genisoimage = "genisoimage";
43 $CFG::qemu = 'qemu-system-i386 -cpu coreduo -smp 2';
44 $CFG::default_target = '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 -tt pc-sojkam.felk.cvut.cz \"sterm -d -s 115200 /dev/ttyUSB0\""',
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"',
54 chomp(my $nproc = `nproc`);
55 $CFG::scons = "scons -j$nproc";
56 $CFG::make = "make -j$nproc";
63 package CFG; # Put config data into a separate namespace
68 die("ERROR: Failure compiling '$cfg' - $@");
69 } elsif (! defined($rc)) {
70 die("ERROR: Failure reading '$cfg' - $!");
72 die("ERROR: Failure processing '$cfg'");
75 $builddir = File::Spec->rel2abs($CFG::builddir, dirname($cfg)) if defined $CFG::builddir;
76 print STDERR "novaboot: Read $cfg\n";
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]);
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;
97 ## Command line handling
100 GetOptions ("target|t=s" => \$explicit_target);
102 my ($amt, @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);
105 $rom_prefix = 'rom://';
106 $stty = 'raw -crtscts -onlcr 115200';
108 my @expect_seen = ();
112 push(@expect_seen, '-re') if $n eq "expect-re";
113 push(@expect_seen, $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);
126 Getopt::Long::Configure(qw/no_ignore_case no_pass_through/);
130 "append|a=s" => \@append,
131 "bender|b" => \$bender,
132 "build-dir=s" => sub { my ($n, $v) = @_; $builddir = File::Spec->rel2abs($v); },
133 "concat" => \$concat,
134 "chainloader=s" => \@chainloaders,
135 "dhcp-tftp|d" => \$dhcp_tftp,
136 "dump" => \$dump_opt,
137 "dump-config" => \$dump_config,
138 "exiton=s" => \@exiton,
139 "expect=s" => \&handle_expect,
140 "expect-re=s" => \&handle_expect,
141 "expect-raw=s" => sub { my ($n, $v) = @_; unshift(@expect_raw, eval($v)); },
142 "gen-only" => \$gen_only,
143 "grub|g:s" => \$grub_config,
144 "grub-preamble=s"=> \$grub_preamble,
145 "grub-prefix=s" => \$grub_prefix,
146 "grub2:s" => \$grub2_config,
147 "grub2-prolog=s" => \$grub2_prolog,
148 "iprelay=s" => \$iprelay,
149 "iso:s" => \$iso_image,
150 "kernel|k=s" => \$kernel_opt,
151 "interactive|i" => \$interactive,
152 "name=s" => \$config_name_opt,
153 "make|m:s" => \$make,
154 "no-file-gen" => \$no_file_gen,
157 "pulsar|p:s" => \$pulsar,
158 "pulsar-root=s" => \$pulsar_root,
159 "qemu|Q:s" => \$qemu,
160 "qemu-append=s" => \$qemu_append,
161 "qemu-flags|q=s" => \$qemu_flags_cmd,
162 "remote-cmd=s" => \$remote_cmd,
163 "remote-expect=s"=> \$remote_expect,
164 "reset-cmd=s" => \$reset_cmd,
165 "rsync-flags=s" => \$rsync_flags,
166 "scons:s" => \$scons,
167 "scriptmod=s" => \@scriptmod,
168 "send=s" => \&handle_send,
169 "sendcont=s" => \&handle_send,
170 "serial|s:s" => \$serial,
171 "server:s" => \$server,
172 "strip-rom" => sub { $rom_prefix = ''; },
175 "uboot-init=s" => \$uboot_init,
180 # First process target options
182 my $t = defined($explicit_target) ? $explicit_target : $CFG::default_target;
184 exists $CFG::targets{$t} or die("Unknown target '$t' (valid targets are: ".join(", ", sort keys(%CFG::targets)).")");
185 GetOptionsFromString($CFG::targets{$t}, %opt_spec);
189 # Then process other command line options - some of them may override
190 # what was specified by the target
191 GetOptions %opt_spec or die("Error in command line arguments");
192 pod2usage(1) if $help;
193 pod2usage(-exitstatus => 0, -verbose => 2) if $man;
195 ### Dump sanitized configuration (if requested)
199 $Data::Dumper::Indent=1;
200 print "# This file is in perl syntax.\n";
201 foreach my $key(sort(keys(%CFG::))) { # See "Symbol Tables" in perlmod(1)
202 if (defined ${$CFG::{$key}}) { print Data::Dumper->Dump([${$CFG::{$key}}], ["*$key"]); }
203 if ( @{$CFG::{$key}}) { print Data::Dumper->Dump([\@{$CFG::{$key}}], ["*$key"]); }
204 if ( %{$CFG::{$key}}) { print Data::Dumper->Dump([\%{$CFG::{$key}}], ["*$key"]); }
210 ### Sanitize configuration
212 if ($interactive && !-t STDIN) {
213 die("novaboot: Interactive mode not supported when not on terminal");
216 if (defined $config_name_opt && scalar(@ARGV) > 1) { die "You cannot use --name with multiple scripts"; }
219 if (defined $serial) {
220 $serial ||= "/dev/ttyUSB0";
221 $ENV{NB_SERIAL} = $serial;
223 if (defined $grub_config) { $grub_config ||= "menu.lst"; }
224 if (defined $grub2_config) { $grub2_config ||= "grub.cfg"; }
226 ## Parse the novaboot script(s)
231 my ($modules, $variables, $generated, $continuation);
232 my $skip_reading = defined($on_opt) || defined($off_opt);
233 while (!$skip_reading && ($_ = <>)) {
234 if ($ARGV ne $last_fn) { # New script
235 die "Missing EOF in $last_fn" if $file;
236 die "Unfinished line in $last_fn" if $continuation;
238 push @scripts, { 'filename' => $ARGV,
239 'modules' => $modules = [],
240 'variables' => $variables = {},
241 'generated' => $generated = []};
245 next if /^#/ || /^\s*$/; # Skip comments and empty lines
247 $_ =~ s/^[[:space:]]*// if ($continuation);
249 if (/\\$/) { # Line continuation
250 $continuation .= substr($_, 0, length($_)-1);
254 if ($continuation) { # Last continuation line
255 $_ = $continuation . $_;
259 foreach my $mod(@scriptmod) { eval $mod; }
261 if ($file && $_ eq $EOF) { # Heredoc end
265 if ($file) { # Heredoc content
266 push @{$file}, "$_\n";
269 if (/^([A-Z_]+)=(.*)$/) { # Internal variable
270 $$variables{$1} = $2;
271 push(@exiton, $2) if ($1 eq "EXITON");
274 if (s/^load *//) { # Load line
275 die("novaboot: '$last_fn' line $.: Missing file name\n") unless /^[^ <]+/;
276 if (/^([^ ]*)(.*?)[[:space:]]*<<([^ ]*)$/) { # Heredoc start
277 push @$modules, "$1$2";
279 push @$generated, {filename => $1, content => $file};
283 if (/^([^ ]*)(.*?)[[:space:]]*< ?(.*)$/) { # Command substitution
284 push @$modules, "$1$2";
285 push @$generated, {filename => $1, command => $3};
291 if (/^run (.*)/) { # run line
292 push @$generated, {command => $1};
296 die("novaboot: Cannot parse script '$last_fn' line $.. Didn't you forget 'load' keyword?\n");
299 # print Dumper(\@scripts);
301 foreach my $script (@scripts) {
302 $modules = $$script{modules};
303 @$modules[0] =~ s/^[^ ]*/$kernel_opt/ if $kernel_opt;
304 @$modules[0] .= ' ' . join(' ', @append) if @append;
307 if (exists $variables->{KERNEL}) {
308 $kernel = $variables->{KERNEL};
310 if ($CFG::hypervisor) {
311 $kernel = $CFG::hypervisor . " ";
312 if (exists $variables->{HYPERVISOR_PARAMS}) {
313 $kernel .= $variables->{HYPERVISOR_PARAMS};
315 $kernel .= $CFG::hypervisor_params;
319 @$modules = ($kernel, @$modules) if $kernel;
320 @$modules = (@chainloaders, @$modules);
321 @$modules = ("bin/boot/bender", @$modules) if ($bender || defined $ENV{'NOVABOOT_BENDER'});
325 foreach my $script (@scripts) {
326 print join("\n", @{$$script{modules}})."\n";
333 sub generate_configs($$$) {
334 my ($base, $generated, $filename) = @_;
335 if ($base) { $base = "$base/"; };
336 foreach my $g(@$generated) {
337 if (exists $$g{content}) {
338 my $config = $$g{content};
339 my $fn = $$g{filename};
340 open(my $f, '>', $fn) || die("$fn: $!");
341 map { s|\brom://([^ ]*)|$rom_prefix$base$1|g; print $f "$_"; } @{$config};
343 print "novaboot: Created $fn\n";
344 } elsif (exists $$g{command} && ! $no_file_gen) {
345 $ENV{SRCDIR} = dirname(File::Spec->rel2abs( $filename, $invocation_dir ));
346 if (exists $$g{filename}) {
347 system_verbose("( $$g{command} ) > $$g{filename}");
349 system_verbose($$g{command});
355 sub generate_grub_config($$$$;$)
357 my ($filename, $title, $base, $modules_ref, $preamble) = @_;
358 if ($base) { $base = "$base/"; };
359 open(my $fg, '>', $filename) or die "$filename: $!";
360 print $fg "$preamble\n" if $preamble;
361 print $fg "title $title\n" if $title;
362 #print $fg "root $base\n"; # root doesn't really work for (nd)
364 foreach (@$modules_ref) {
367 my ($kbin, $kcmd) = split(' ', $_, 2);
368 $kcmd = '' if !defined $kcmd;
369 print $fg "kernel ${base}$kbin $kcmd\n";
371 s|\brom://([^ ]*)|$rom_prefix$base$1|g; # Translate rom:// files - needed for vdisk parameter of sigma0
372 print $fg "module $base$_\n";
376 print("novaboot: Created $builddir/$filename\n");
380 sub generate_grub2_config($$$$;$$)
382 my ($filename, $title, $base, $modules_ref, $preamble, $prolog) = @_;
383 if ($base && substr($base,-1,1) ne '/') { $base = "$base/"; };
384 open(my $fg, '>', $filename) or die "$filename: $!";
385 print $fg "$preamble\n" if $preamble;
386 $title ||= 'novaboot';
387 print $fg "menuentry $title {\n";
388 print $fg "$prolog\n" if $prolog;
390 foreach (@$modules_ref) {
393 my ($kbin, $kcmd) = split(' ', $_, 2);
394 $kcmd = '' if !defined $kcmd;
395 print $fg " multiboot ${base}$kbin $kcmd\n";
398 # GRUB2 doesn't pass filename in multiboot info so we have to duplicate it here
399 $_ = join(' ', ($args[0], @args));
400 s|\brom://|$rom_prefix|g; # We do not need to translate path for GRUB2
401 print $fg " module $base$_\n";
406 print("novaboot: Created $builddir/$filename\n");
410 sub generate_pulsar_config($$)
412 my ($filename, $modules_ref) = @_;
413 open(my $fg, '>', $filename) or die "$filename: $!";
414 print $fg "root $pulsar_root\n" if defined $pulsar_root;
417 foreach (@$modules_ref) {
420 ($kbin, $kcmd) = split(' ', $_, 2);
421 $kcmd = '' if !defined $kcmd;
424 s|\brom://|$rom_prefix|g;
425 print $fg "load $_\n";
428 # Put kernel as last - this is needed for booting Linux and has no influence on non-Linux OSes
429 print $fg "exec $kbin $kcmd\n";
431 print("novaboot: Created $builddir/$filename\n");
435 sub shell_cmd_string(@)
437 return join(' ', map((/^[-_=a-zA-Z0-9\/\.\+]+$/ ? "$_" : "'$_'"), @_));
442 print "novaboot: Running: ".shell_cmd_string(@_)."\n";
446 sub system_verbose($)
449 print "novaboot: Running: $cmd\n";
450 my $ret = system($cmd);
451 if ($ret & 0x007f) { die("Command terminated by a signal"); }
452 if ($ret & 0xff00) {die("Command exit with non-zero exit code"); }
453 if ($ret) { die("Command failure $ret"); }
458 if (exists $variables->{WVDESC}) {
459 print "Testing \"$variables->{WVDESC}\" in $last_fn:\n";
460 } elsif ($last_fn =~ /\.wv$/) {
461 print "Testing \"all\" in $last_fn:\n";
464 ## Connect to the target and check whether it is not occupied
466 # We have to do this before file generation phase, because file
467 # generation is intermixed with file deployment phase and we want to
468 # check whether the target is not used by somebody else before
469 # deploying files. Otherwise, we may rewrite other user's files on a
472 my $exp; # Expect object to communicate with the target over serial line
474 my ($target_reset, $target_power_on, $target_power_off);
476 if (defined $iprelay) {
478 $iprelay =~ /([.0-9]+)(:([0-9]+))?/;
481 my $paddr = sockaddr_in($port, inet_aton($addr));
482 my $proto = getprotobyname('tcp');
483 socket($IPRELAY, PF_INET, SOCK_STREAM, $proto) || die "socket: $!";
484 print "novaboot: Connecting to IP relay... ";
485 connect($IPRELAY, $paddr) || die "connect: $!";
487 $exp = Expect->init(\*$IPRELAY);
491 print $exp "\xFF\xF6"; # AYT
492 my $connected = $exp->expect(20, # Timeout in seconds
493 '<iprelayd: connected>',
494 '-re', '<WEB51 HW[^>]*>');
499 my ($relay, $onoff) = @_;
500 die unless ($relay == 1 || $relay == 2);
502 my $cmd = ($relay == 1 ? 0x5 : 0x6) | ($onoff ? 0x20 : 0x10);
503 return "\xFF\xFA\x2C\x32".chr($cmd)."\xFF\xF0";
507 my ($relay, $onoff) = @_;
508 die unless ($relay == 1 || $relay == 2);
509 my $cmd = ($relay == 1 ? 0xdf : 0xbf) | ($onoff ? 0x00 : 0xff);
510 return "\xFF\xFA\x2C\x97".chr($cmd)."\xFF\xF0";
514 my ($relay, $onoff, $can_giveup) = @_;
515 my $confirmation = '';
517 print $exp relaycmd($relay, $onoff);
518 my $confirmed = $exp->expect(20, # Timeout in seconds
519 relayconf($relay, $onoff));
522 print("Relay confirmation timeout - ignoring\n");
524 die "Relay confirmation timeout";
530 $target_reset = sub {
531 relay(2, 1, 1); # Reset the machine
536 $target_power_off = sub {
537 relay(1, 1); # Press power button
538 usleep(6000000); # Long press to switch off
542 $target_power_on = sub {
543 relay(1, 1); # Press power button
544 usleep(100000); # Short press
550 system_verbose("stty -F $serial $stty");
551 open($CONN, "+<", $serial) || die "open $serial: $!";
552 $exp = Expect->init(\*$CONN);
554 elsif ($remote_cmd) {
555 print "novaboot: Running: $remote_cmd\n";
556 $exp = Expect->spawn($remote_cmd);
558 elsif (defined $amt) {
560 use LWP::Authen::Digest;
563 my ($host, $username, $password, $schema, $className, $pstate) = @_;
564 #AMT numbers for PowerStateChange (MNI => bluescreen on windows;-)
565 my %pstates = ("on" => 2,
572 <s:Envelope xmlns:s="http://www.w3.org/2003/05/soap-envelope" xmlns:a="http://schemas.xmlsoap.org/ws/2004/08/addressing" xmlns:w="http://schemas.dmtf.org/wbem/wsman/1/wsman.xsd">
573 <s:Header><a:To>http://$host:16992/wsman</a:To>
574 <w:ResourceURI s:mustUnderstand="true">$schema</w:ResourceURI>
575 <a:ReplyTo><a:Address s:mustUnderstand="true">http://schemas.xmlsoap.org/ws/2004/08/addressing/role/anonymous</a:Address></a:ReplyTo>
576 <a:Action s:mustUnderstand="true">$schema$className</a:Action>
577 <w:MaxEnvelopeSize s:mustUnderstand="true">153600</w:MaxEnvelopeSize>
578 <a:MessageID>uuid:709072C9-609C-4B43-B301-075004043C7C</a:MessageID>
579 <w:Locale xml:lang="en-US" s:mustUnderstand="false" />
580 <w:OperationTimeout>PT60.000S</w:OperationTimeout>
581 <w:SelectorSet><w:Selector Name="Name">Intel(r) AMT Power Management Service</w:Selector></w:SelectorSet>
583 <p:RequestPowerStateChange_INPUT xmlns:p="http://schemas.dmtf.org/wbem/wscim/1/cim-schema/2/CIM_PowerManagementService">
584 <p:PowerState>$pstates{$pstate}</p:PowerState>
585 <p:ManagedElement><a:Address>http://$host:16992/wsman</a:Address>
586 <a:ReferenceParameters><w:ResourceURI>http://schemas.dmtf.org/wbem/wscim/1/cim-schema/2/CIM_ComputerSystem</w:ResourceURI>
587 <w:SelectorSet><w:Selector Name="Name">ManagedSystem</w:Selector></w:SelectorSet>
588 </a:ReferenceParameters></p:ManagedElement>
589 </p:RequestPowerStateChange_INPUT>
590 </s:Body></s:Envelope>
595 my ($host, $username, $password, $content) = @_;
597 my $ua = LWP::UserAgent->new();
598 $ua->agent("novaboot");
600 my $req = HTTP::Request->new(POST => "http://$host:16992/wsman");
601 my $res = $ua->request($req);
602 die ("Unexpected AMT response: " . $res->status_line) unless $res->code == 401;
604 my ($realm) = $res->header("WWW-Authenticate") =~ /Digest realm="(.*?)"/;
605 $ua->credentials("$host:16992", $realm, $username => $password);
608 $req = HTTP::Request->new(POST => "http://$host:16992/wsman");
609 $req->content_type('application/x-www-form-urlencoded');
610 $req->content($content);
611 $res = $ua->request($req);
612 die ("AMT power change request failed: " . $res->status_line) unless $res->is_success;
613 $res->content() =~ /<g:ReturnValue>(\d+)<\/g:ReturnValue>/;
618 my ($host, $username, $password, $pstate)=@_;
619 my $schema="http://schemas.dmtf.org/wbem/wscim/1/cim-schema/2/CIM_PowerManagementService";
620 my $className="/RequestPowerStateChange";
621 my $content = genXML($host, $username, $password ,$schema, $className, $pstate);
622 return sendPOST($host, $username, $password, $content);
625 my ($user,$amt_password,$host,$port) = ($amt =~ /(?:(.*?)(?::(.*))?@)?([^:]*)(?::([0-9]*))?/);;
627 $amt_password ||= $ENV{'AMT_PASSWORD'} || die "AMT password not specified";
628 $host || die "AMT host not specified";
631 $target_power_off = sub {
633 my $result = powerChange($host,$user,$amt_password, "off");
634 die "AMT power off failed (ReturnValue $result)" if $result != 0;
637 $target_power_on = sub {
638 my $result = powerChange($host,$user,$amt_password, "on");
639 die "AMT power on failed (ReturnValue $result)" if $result != 0;
642 $target_reset = sub {
643 my $result = powerChange($host,$user,$amt_password, "reset");
645 print STDERR "Warning: Cannot reset $host, trying power on. ";
646 $result = powerChange($host,$user,$amt_password, "on");
648 die "AMT reset failed (ReturnValue $result)" if $result != 0;
651 my $cmd = "amtterm -u $user -p $amt_password $host $port";
652 print "novaboot: Running: $cmd\n" =~ s/\Q$amt_password\E/???/r;
653 $exp = Expect->spawn($cmd);
654 $exp->expect(10, "RUN_SOL") || die "Expect for 'RUN_SOL' timed out";
657 if ($remote_expect) {
658 $exp->expect(10, $remote_expect) || die "Expect for '$remote_expect' timed out";
661 if (defined $reset_cmd) {
662 $target_reset = sub {
663 system_verbose($reset_cmd);
667 if (defined $on_opt && defined $target_power_on) {
671 if (defined $off_opt && defined $target_power_off) {
672 print "novaboot: Switching the target off...\n";
673 &$target_power_off();
677 $builddir ||= dirname(File::Spec->rel2abs( ${$scripts[0]}{filename})) if scalar @scripts;
678 if (defined $builddir) {
679 chdir($builddir) or die "Can't change directory to $builddir: $!";
680 print "novaboot: Entering directory `$builddir'\n";
683 ## File generation phase
684 my (%files_iso, $menu_iso, $filename);
685 my $config_name = '';
687 foreach my $script (@scripts) {
688 $filename = $$script{filename};
689 $modules = $$script{modules};
690 $generated = $$script{generated};
691 $variables = $$script{variables};
693 ($config_name = $filename) =~ s#.*/##;
694 $config_name = $config_name_opt if (defined $config_name_opt);
696 if (exists $variables->{BUILDDIR}) {
697 $builddir = File::Spec->rel2abs($variables->{BUILDDIR});
698 chdir($builddir) or die "Can't change directory to $builddir: $!";
699 print "novaboot: Entering directory `$builddir'\n";
703 ($prefix = $grub_prefix) =~ s/\$NAME/$config_name/ if defined $grub_prefix;
704 $prefix ||= $builddir;
705 # TODO: use $grub_prefix as first parameter if some switch is given
706 generate_configs('', $generated, $filename);
708 ### Generate bootloader configuration files
709 my @bootloader_configs;
710 push @bootloader_configs, generate_grub_config($grub_config, $config_name, $prefix, $modules, $grub_preamble) if (defined $grub_config);
711 push @bootloader_configs, generate_grub2_config($grub2_config, $config_name, $prefix, $modules, $grub_preamble, $grub2_prolog) if (defined $grub2_config);
712 push @bootloader_configs, generate_pulsar_config('config-'.($pulsar||'novaboot'), $modules) if (defined $pulsar);
714 ### Run scons or make
716 my @files = map({ ($file) = m/([^ ]*)/; $file; } @$modules);
717 # Filter-out generated files
718 my @to_build = grep({ my $file = $_; !scalar(grep($file eq ($$_{filename} || ''), @$generated)) } @files);
720 system_verbose($scons || $CFG::scons." ".join(" ", @to_build)) if (defined $scons);
721 system_verbose($make || $CFG::make ." ".join(" ", @to_build)) if (defined $make);
724 ### Copy files (using rsync)
725 if (defined $server && !defined($gen_only)) {
726 (my $real_server = $server) =~ s/\$NAME/$config_name/;
728 my ($hostname, $path) = split(":", $real_server, 2);
729 if (! defined $path) {
733 my $files = join(" ", map({ ($file) = m/([^ ]*)/; $file; } ( @$modules, @bootloader_configs)));
734 map({ my $file = (split)[0]; die "$file: $!" if ! -f $file; } @$modules);
735 my $istty = -t STDOUT && ($ENV{'TERM'} || 'dumb') ne 'dumb';
736 my $progress = $istty ? "--progress" : "";
737 system_verbose("rsync $progress -RLp $rsync_flags $files $real_server");
738 if ($server =~ m|/\$NAME$| && $concat) {
739 my $cmd = join("; ", map { "( cd $path/.. && cat */$_ > $_ )" } @bootloader_configs);
740 system_verbose($hostname ? "ssh $hostname '$cmd'" : $cmd);
744 ### Prepare ISO image generation
745 if (defined $iso_image) {
746 generate_configs("(cd)", $generated, $filename);
748 generate_grub_config(\$menu, $config_name, "(cd)", $modules);
749 $menu_iso .= "$menu\n";
750 map { ($file,undef) = split; $files_iso{$file} = 1; } @$modules;
754 ## Generate ISO image
755 if (defined $iso_image) {
756 open(my $fh, ">menu-iso.lst");
757 print $fh "timeout 5\n\n$menu_iso";
759 my $files = "boot/grub/menu.lst=menu-iso.lst " . join(" ", map("$_=$_", keys(%files_iso)));
760 $iso_image ||= "$config_name.iso";
761 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");
762 print("ISO image created: $builddir/$iso_image\n");
765 exit(0) if defined $gen_only;
767 ## Boot the system using various methods and send serial output to stdout
769 if (scalar(@scripts) > 1 && ( defined $dhcp_tftp || defined $serial || defined $iprelay)) {
770 die "You cannot do this with multiple scripts simultaneously";
773 if ($variables->{WVTEST_TIMEOUT}) {
774 print "wvtest: timeout ", $variables->{WVTEST_TIMEOUT}, "\n";
779 $str =~ s/^\s+|\s+$//g;
787 $qemu ||= $variables->{QEMU} || $CFG::qemu;
788 my @qemu_flags = split(" ", $qemu);
789 $qemu = shift(@qemu_flags);
791 @qemu_flags = split(/ +/, trim($variables->{QEMU_FLAGS})) if exists $variables->{QEMU_FLAGS};
792 @qemu_flags = split(/ +/, trim($qemu_flags_cmd)) if $qemu_flags_cmd;
793 push(@qemu_flags, split(/ +/, trim($qemu_append || '')));
795 if (defined $iso_image) {
796 # Boot NOVA with grub (and test the iso image)
797 push(@qemu_flags, ('-cdrom', "$config_name.iso"));
799 # Boot NOVA without GRUB
801 # Non-patched qemu doesn't like commas, but NUL can live with pluses instead of commans
802 foreach (@$modules) {s/,/+/g;}
803 generate_configs("", $generated, $filename);
805 if (scalar @$modules) {
806 my ($kbin, $kcmd) = split(' ', shift(@$modules), 2);
807 $kcmd = '' if !defined $kcmd;
809 @$modules = map { if (/\.dtb$/) { $dtb=$_; (); } else { $_ } } @$modules;
810 my $initrd = join ",", @$modules;
812 push(@qemu_flags, ('-kernel', $kbin, '-append', $kcmd));
813 push(@qemu_flags, ('-initrd', $initrd)) if $initrd;
814 push(@qemu_flags, ('-dtb', $dtb)) if $dtb;
817 push(@qemu_flags, qw(-serial stdio)); # Redirect serial output (for collecting test restuls)
818 unshift(@qemu_flags, ('-name', $config_name));
819 print "novaboot: Running: ".shell_cmd_string($qemu, @qemu_flags)."\n";
820 $exp = Expect->spawn(($qemu, @qemu_flags)) || die("exec() failed: $!");
823 ### Local DHCPD and TFTPD
825 my ($dhcpd_pid, $tftpd_pid);
827 if (defined $dhcp_tftp)
829 generate_configs("(nd)", $generated, $filename);
830 system_verbose('mkdir -p tftpboot');
831 generate_grub_config("tftpboot/os-menu.lst", $config_name, "(nd)", \@$modules, "timeout 0");
832 open(my $fh, '>', 'dhcpd.conf');
833 my $mac = `cat /sys/class/net/eth0/address`;
835 print $fh "subnet 10.23.23.0 netmask 255.255.255.0 {
836 range 10.23.23.10 10.23.23.100;
837 filename \"bin/boot/grub/pxegrub.pxe\";
838 next-server 10.23.23.1;
841 hardware ethernet $mac;
842 fixed-address 10.23.23.1;
845 system_verbose("sudo ip a add 10.23.23.1/24 dev eth0;
846 sudo ip l set dev eth0 up;
847 sudo touch dhcpd.leases");
849 # We run servers by forking ourselves, because the servers end up
850 # in our process group and get killed by signals sent to the
851 # process group (e.g. Ctrl-C on terminal).
853 exec_verbose("sudo dhcpd -d -cf dhcpd.conf -lf dhcpd.leases -pf dhcpd.pid") if ($dhcpd_pid == 0);
855 exec_verbose("sudo in.tftpd --foreground --secure -v -v -v --pidfile tftpd.pid $builddir") if ($tftpd_pid == 0);
857 # Kill server when we die
858 $SIG{__DIE__} = sub { system_verbose('sudo pkill --pidfile=dhcpd.pid');
859 system_verbose('sudo pkill --pidfile=tftpd.pid'); };
862 ### Reset target (IP relay, AMT, ...)
864 if (defined $target_reset) {
865 print "novaboot: Reseting the test box... ";
870 ### U-boot conversation
871 if (defined $uboot) {
872 print "novaboot: Waiting for uBoot prompt...\n";
874 #$exp->exp_internal(1);
876 [qr/Hit any key to stop autoboot:/, sub { $exp->send("\n"); exp_continue; }],
877 '=> ') || die "No uBoot prompt deteceted";
878 $exp->send("$uboot_init\n") if $uboot_init;
879 $exp->expect(10, '=> ') || die "uBoot prompt timeout";
881 my ($kbin, $kcmd) = split(' ', shift(@$modules), 2);
883 @$modules = map { if (/\.dtb$/) { $dtb=$_; (); } else { $_ } } @$modules;
884 my $initrd = shift @$modules;
886 my $kern_addr = '800000';
887 my $initrd_addr = '-';
890 $exp->send("tftp $kern_addr $kbin\n");
892 [qr/#/, sub { exp_continue; }],
893 '=> ') || die "Kernel load failed";
895 $dtb_addr = '7f0000';
896 $exp->send("tftp $dtb_addr $dtb\n");
898 [qr/#/, sub { exp_continue; }],
899 '=> ') || die "Device tree load failed";
901 if (defined $initrd) {
902 $initrd_addr = 'b00000';
903 $exp->send("tftp $initrd_addr $initrd\n");
905 [qr/#/, sub { exp_continue; }],
906 '=> ') || die "Initrd load failed";
908 $exp->send("set bootargs '$kcmd'\n");
909 $exp->expect(5, '=> ') || die "uBoot prompt timeout";
910 $exp->send("bootm $kern_addr $initrd_addr $dtb_addr\n");
911 $exp->expect(5, "\n") || die "uBoot command timeout";
914 ### Serial line interaction
916 # Serial line of the target is available
917 my $interrupt = 'Ctrl-C';
918 if ($interactive && !@exiton) {
919 $interrupt = '"~~."';
921 print "novaboot: Serial line interaction (press $interrupt to interrupt)...\n";
924 $exp->expect(undef, @expect_raw, @exiton);
927 if (-t STDIN) { # Set up bi-directional communication if we run on terminal
928 my $infile = new IO::File;
929 $infile->IO::File::fdopen(*STDIN,'r');
930 my $in_object = Expect->exp_init($infile);
931 $in_object->set_group($exp);
934 $in_object->set_seq('~~\.', sub { print "novaboot: Escape sequence detected\r\n"; undef; });
935 $in_object->manual_stty(0); # Use raw terminal mode
937 $in_object->manual_stty(1); # Do not modify terminal settings
939 push(@inputs, $in_object);
942 #print Dumper(\@expect_raw);
943 $exp->expect(undef, @expect_raw) if @expect_raw;
944 Expect::interconnect(@inputs) unless defined($exp->exitstatus);
948 ## Kill dhcpc or tftpd
949 if (defined $dhcp_tftp) {
950 die("novaboot: This should kill servers on background\n");
957 novaboot - A tool for booting various operating systems on various hardware or in qemu
963 B<novaboot> [option]... [--] script...
965 B<./script> [option]...
969 This program makes booting of an operating system (e.g. NOVA or Linux)
970 as simple as running a local program. It facilitates booting on local
971 or remote hosts or in emulators such as qemu. Novaboot operation is
972 controlled by command line options and by a so called novaboot script,
973 which can be thought as a generalization of bootloader configuration
974 files (see L</"NOVABOOT SCRIPT SYNTAX">). Based on this input,
975 novaboot setups everything for the target host to boot the desired
976 configuration, i.e. it generates the bootloader configuration file in
977 the proper format, deploy the binaries and other needed files to
978 required locations, perhaps on a remote boot server and reset the
979 target host. Finally, target host's serial output is redirected to
980 standard output if that is possible.
982 Typical way of using novaboot is to make the novaboot script
983 executable and set its first line to I<#!/usr/bin/env novaboot>. Then,
984 booting a particular OS configuration becomes the same as executing a
985 local program - the novaboot script.
987 For example, with C<novaboot> you can:
993 Run an OS in Qemu. This is the default action when no other action is
994 specified by command line switches. Thus running C<novaboot ./script>
995 (or C<./script> as described above) will run Qemu and make it boot the
996 configuration specified in the F<script>.
1000 Create a bootloader configuration file (currently supported
1001 bootloaders are GRUB, GRUB2, Pulsar and U-Boot) and copy it with all
1002 other files needed for booting to a remote boot server.
1004 ./script --server=192.168.1.1:/tftp --iprelay=192.168.1.2
1006 This command copies files to the TFTP server and uses
1007 TCP/IP-controlled relay to reset the target host and receive its
1012 Run DHCP and TFTP server on developer's machine to PXE-boot the target
1015 ./script --dhcp-tftp
1017 When a PXE-bootable machine is connected via Ethernet to developer's
1018 machine, it will boot the configuration described in I<script>.
1022 Create bootable ISO images. E.g.
1024 novaboot --iso -- script1 script2
1026 The created ISO image will have GRUB bootloader installed on it and
1027 the boot menu will allow selecting between I<script1> and I<script2>
1032 Note that the options needed for a specific target can be stored in a
1033 L</"CONFIGURATION FILE">. Then it is sufficient to use only the B<-t>
1034 option to specify the name of the target.
1036 =head1 PHASES AND OPTIONS
1038 Novaboot performs its work in several phases. Each phase can be
1039 influenced by several options, certain phases can be skipped. The list
1040 of phases (in the execution order) and the corresponding options
1043 =head2 Configuration reading phase
1045 After starting, novaboot reads configuration files. By default, it
1046 searches for files named F<.novaboot> starting from the directory of
1047 the novaboot script (or working directory, see bellow) and continuing
1048 upwards up to the root directory. The configuration files are read in
1049 order from the root directory downwards with latter files overriding
1050 settings from the former ones.
1052 In certain cases, the location of the novaboot script cannot be
1053 determined in this early phase. This happens either when the script is
1054 read from the standard input or when novaboot is invoked explicitly
1055 and options precede the script name, as in the example L</"4."> above.
1056 In this case the current working directory is used as a starting point
1057 for configuration file search.
1061 =item -c, --config=I<filename>
1063 Use the specified configuration file instead of the default one(s).
1067 =head2 Command line processing phase
1073 Dump the current configuration to stdout end exits. Useful as an
1074 initial template for a configuration file.
1078 Print short (B<-h>) or long (B<--help>) help.
1080 =item -t, --target=I<target>
1082 This option serves as a user configurable shortcut for other novaboot
1083 options. The effect of this option is the same as the options stored
1084 in the C<%targets> configuration variable under key I<target>. See
1085 also L</"CONFIGURATION FILE">.
1089 =head2 Script preprocessing phase
1091 This phases allows to modify the parsed novaboot script before it is
1092 used in the later phases.
1096 =item -a, --append=I<parameters>
1098 Append a string to the first C<load> line in the novaboot script. This
1099 can be used to append parameters to the kernel's or root task's
1100 command line. Can appear multiple times.
1104 Use F<bender> chainloader. Bender scans the PCI bus for PCI serial
1105 ports and stores the information about them in the BIOS data area for
1108 =item --chainloader=I<chainloader>
1110 Chainloader that is loaded before the kernel and other files specified
1111 in the novaboot script. E.g. 'bin/boot/bender promisc'.
1115 Print the modules to boot and their parameters after this phase
1116 finishes. Then exit. This is useful for seeing the effect of other
1117 options in this section.
1119 =item -k, --kernel=F<file>
1121 Replace the first word on the first C<load> line in the novaboot
1122 script with F<file>.
1124 =item --scriptmod=I<perl expression>
1126 When novaboot script is read, I<perl expression> is executed for every
1127 line (in $_ variable). For example, C<novaboot
1128 --scriptmod=s/sigma0/omega6/g> replaces every occurrence of I<sigma0>
1129 in the script with I<omega6>.
1131 When this option is present, it overrides I<$script_modifier> variable
1132 from the configuration file, which has the same effect. If this option
1133 is given multiple times all expressions are evaluated in the command
1138 =head2 File generation phase
1140 In this phase, files needed for booting are generated in a so called
1141 I<build directory> (see L</--build-dir>). In most cases configuration
1142 for a bootloader is generated automatically by novaboot. It is also
1143 possible to generate other files using I<heredoc> or I<"<"> syntax in
1144 novaboot scripts. Finally, binaries can be generated in this phases by
1145 running C<scons> or C<make>.
1149 =item --build-dir=I<directory>
1151 Overrides the default build directory location.
1153 The default build directory location is determined as follows: If the
1154 configuration file defines the C<$builddir> variable, its value is
1155 used. Otherwise, it is the directory that contains the first processed
1158 See also L</BUILDDIR> variable.
1160 =item -g, --grub[=I<filename>]
1162 Generates grub bootloader menu file. If the I<filename> is not
1163 specified, F<menu.lst> is used. The I<filename> is relative to the
1164 build directory (see B<--build-dir>).
1166 =item --grub-preamble=I<prefix>
1168 Specifies the I<preable> that is at the beginning of the generated
1169 GRUB or GRUB2 config files. This is useful for specifying GRUB's
1172 =item --grub-prefix=I<prefix>
1174 Specifies I<prefix> that is put in front of every file name in GRUB's
1175 F<menu.lst>. The default value is the absolute path to the build directory.
1177 If the I<prefix> contains string $NAME, it will be replaced with the
1178 name of the novaboot script (see also B<--name>).
1180 =item --grub2[=I<filename>]
1182 Generate GRUB2 menuentry in I<filename>. If I<filename> is not
1183 specified F<grub.cfg> is used. The content of the menuentry can be
1184 customized with B<--grub-preable>, B<--grub2-prolog> or
1185 B<--grub_prefix> options.
1187 In order to use the the generated menuentry on your development
1188 machine that uses GRUB2, append the following snippet to
1189 F</etc/grub.d/40_custom> file and regenerate your grub configuration,
1190 i.e. run update-grub on Debian/Ubuntu.
1192 if [ -f /path/to/nul/build/grub.cfg ]; then
1193 source /path/to/nul/build/grub.cfg
1196 =item --grub2-prolog=I<prolog>
1198 Specifies text I<preable> that is put at the beginning of the entry
1201 =item -m, --make[=make command]
1203 Runs C<make> to build files that are not generated by novaboot itself.
1205 =item --name=I<string>
1207 Use the name I<string> instead of the name of the novaboot script.
1208 This name is used for things like a title of grub menu or for the
1209 server directory where the boot files are copied to.
1213 Do not run external commands to generate files (i.e. "<" syntax and
1214 C<run> keyword). This switch does not influence generation of files
1215 specified with "<<WORD" syntax.
1217 =item -p, --pulsar[=mac]
1219 Generates pulsar bootloader configuration file named F<config-I<mac>>
1220 The I<mac> string is typically a MAC address and defaults to
1223 =item --scons[=scons command]
1225 Runs C<scons> to build files that are not generated by novaboot
1230 Strip I<rom://> prefix from command lines and generated config files.
1231 The I<rom://> prefix is used by NUL. For NRE, it has to be stripped.
1235 Exit novaboot after file generation phase.
1239 =head2 Target connection check
1241 If supported by the target, the connection to it is made and it is
1242 checked whether the target is not occupied by another novaboot
1247 =item --amt=I<"[user[:password]@]host[:port]>
1249 Use Intel AMT technology to control the target machine. WS management
1250 is used to powercycle it and Serial-Over-Lan (SOL) for input/output.
1251 The hostname or (IP address) is given by the I<host> parameter. If
1252 I<password> is not specified, environment variable AMT_PASSWORD is
1253 used. The I<port> specifies a TCP port for SOL. If not specified, the
1254 default is 16992. Default I<user> is admin.
1256 =item --iprelay=I<addr[:port]>
1258 Use TCP/IP relay and serial port to access the target's serial port
1259 and powercycle it. The IP address of the relay is given by I<addr>
1260 parameter. If I<port> is not specified, it default to 23.
1262 Note: This option is supposed to work with HWG-ER02a IP relays.
1264 =item -s, --serial[=device]
1266 Target's serial line is connected to host's serial line (device). The
1267 default value for device is F</dev/ttyUSB0>.
1269 The value of this option is exported in NB_NOVABOOT environment
1270 variable to all subprocesses run by C<novaboot>.
1272 =item --stty=I<settings>
1274 Specifies settings passed to C<stty> invoked on the serial line
1275 specified with B<--serial> option. If this option is not given,
1276 C<stty> is called with C<raw -crtscts -onlcr 115200> settings.
1278 =item --remote-cmd=I<cmd>
1280 Command that mediates connection to the target's serial line. For
1281 example C<ssh server 'cu -l /dev/ttyS0'>.
1283 =item --remote-expect=I<string>
1285 Wait for reception of I<string> after establishing the the remote
1286 connection before continuing.
1291 =head2 File deployment phase
1293 In some setups, it is necessary to copy the files needed for booting
1294 to a particular location, e.g. to a TFTP boot server or to the
1299 =item -d, --dhcp-tftp
1301 Turns your workstation into a DHCP and TFTP server so that the OS can
1302 be booted via PXE BIOS (or similar mechanism) on the test machine
1303 directly connected by a plain Ethernet cable to your workstation.
1305 The DHCP and TFTP servers require root privileges and C<novaboot>
1306 uses C<sudo> command to obtain those. You can put the following to
1307 I</etc/sudoers> to allow running the necessary commands without
1308 asking for password.
1310 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
1311 your_login ALL=NOPASSWD: NOVABOOT
1313 =item --iso[=filename]
1315 Generates the ISO image that boots NOVA system via GRUB. If no filename
1316 is given, the image is stored under I<NAME>.iso, where I<NAME> is the name
1317 of the novaboot script (see also B<--name>).
1319 =item --server[=[[user@]server:]path]
1321 Copy all files needed for booting to another location (implies B<-g>
1322 unless B<--grub2> is given). The files will be copied (by B<rsync>
1323 tool) to the directory I<path>. If the I<path> contains string $NAME,
1324 it will be replaced with the name of the novaboot script (see also
1329 If B<--server> is used and its value ends with $NAME, then after
1330 copying the files, a new bootloader configuration file (e.g. menu.lst)
1331 is created at I<path-wo-name>, i.e. the path specified by B<--server>
1332 with $NAME part removed. The content of the file is created by
1333 concatenating all files of the same name from all subdirectories of
1334 I<path-wo-name> found on the "server".
1336 =item --rsync-flags=I<flags>
1338 Specifies which I<flags> are appended to F<rsync> command line when
1339 copying files as a result of I<--server> option.
1343 =head2 Target power-on and reset phase
1349 Switch on/off the target machine and exit. The script (if any) is
1350 completely ignored. Currently it works only with B<--iprelay> or
1353 =item -Q, --qemu[=I<qemu-binary>]
1355 Boot the configuration in qemu. Optionally, the name of qemu binary
1356 can be specified as a parameter.
1358 =item --qemu-append=I<flags>
1360 Append I<flags> to the default qemu flags (QEMU_FLAGS variable or
1361 C<-cpu coreduo -smp 2>).
1363 =item -q, --qemu-flags=I<flags>
1365 Replace the default qemu flags (QEMU_FLAGS variable or C<-cpu coreduo
1366 -smp 2>) with I<flags> specified here.
1368 =item --reset-cmd=I<cmd>
1370 Command that resets the target.
1374 =head2 Interaction with the bootloader on the target
1380 Interact with uBoot bootloader to boot the thing described in the
1381 novaboot script. Implementation of this option is currently tied to a
1382 particular board that we use. It may be subject to changes in the
1387 Command(s) to send the U-Boot bootloader before loading the images and
1392 =head2 Target interaction phase
1394 In this phase, target's serial output is redirected to stdout and if
1395 stdin is a TTY, it is redirected to the target's serial input allowing
1396 interactive work with the target.
1400 =item --exiton=I<string>
1402 When I<string> is sent by the target, novaboot exits. This option can
1403 be specified multiple times.
1405 If I<string> is C<-re>, then the next B<--exiton>'s I<string> is
1406 treated as regular expression. For example:
1408 --exiton -re --exiton 'error:.*failed'
1410 =item -i, --interactive
1412 Setup things for interactive use of target. Your terminal will be
1413 switched to raw mode. In raw mode, your system does not process input
1414 in any way (no echoing of entered characters, no interpretation
1415 special characters). This, among others, means that Ctrl-C is passed
1416 to the target and does no longer interrupt novaboot. Use "~~."
1417 sequence to exit novaboot.
1419 =item --expect=I<string>
1421 When I<string> is received from the target, send the string specified
1422 with the subsequent B<--send*> option to the target.
1424 =item --expect-re=I<regex>
1426 When target's output matches regular expression I<regex>, send the
1427 string specified with the subsequent B<--send*> option to the target.
1429 =item --expect-raw=I<perl-code>
1431 Provides direct control over Perl's Expect module.
1433 =item --send=I<string>
1435 Send I<string> to the target after the previously specified
1436 B<--expect*> was matched in the target's output. The I<string> may
1437 contain escape sequences such as "\n".
1439 Note that I<string> is actually interpreted by Perl, so it can contain
1440 much more that escape sequences. This behavior may change in the
1443 Example: C<--expect='login: ' --send='root\n'>
1445 =item --sendcont=I<string>
1447 Similar to B<--send> but continue expecting more input.
1449 Example: C<--expect='Continue?' --sendcont='yes\n'>
1453 =head1 NOVABOOT SCRIPT SYNTAX
1455 The syntax tries to mimic POSIX shell syntax. The syntax is defined
1456 with the following rules.
1458 Lines starting with "#" and empty lines are ignored.
1460 Lines that end with "\" are concatenated with the following line after
1461 removal of the final "\" and leading whitespace of the following line.
1463 Lines of the form I<VARIABLE=...> (i.e. matching '^[A-Z_]+=' regular
1464 expression) assign values to internal variables. See L</VARIABLES>
1467 Lines starting with C<load> keyword represent modules to boot. The
1468 word after C<load> is a file name (relative to the build directory
1469 (see B<--build-dir>) of the module to load and the remaining words are
1470 passed to it as the command line parameters.
1472 When the C<load> line ends with "<<WORD" then the subsequent lines
1473 until the line containing solely WORD are copied literally to the file
1474 named on that line. This is similar to shell's heredoc feature.
1476 When the C<load> line ends with "< CMD" then command CMD is executed
1477 with F</bin/sh> and its standard output is stored in the file named on
1478 that line. The SRCDIR variable in CMD's environment is set to the
1479 absolute path of the directory containing the interpreted novaboot
1482 Lines starting with C<run> keyword contain shell commands that are run
1483 during file generation phase. This is the same as the "< CMD" syntax
1484 for C<load> keyboard except that the command's output is not
1485 redirected to a file. The ordering of commands is the same as they
1486 appear in the novaboot script.
1490 #!/usr/bin/env novaboot
1491 load bzImage console=ttyS0,115200
1492 run make -C buildroot
1493 load rootfs.cpio < gen_cpio buildroot/images/rootfs.cpio "myapp->/etc/init.d/S99myapp"
1495 Example (NOVA User Land - NUL):
1497 #!/usr/bin/env novaboot
1498 WVDESC=Example program
1499 load bin/apps/sigma0.nul S0_DEFAULT script_start:1,1 \
1500 verbose hostkeyb:0,0x60,1,12,2
1501 load bin/apps/hello.nul
1502 load hello.nulconfig <<EOF
1503 sigma0::mem:16 name::/s0/log name::/s0/timer name::/s0/fs/rom ||
1504 rom://bin/apps/hello.nul
1507 This example will load three modules: F<sigma0.nul>, F<hello.nul> and
1508 F<hello.nulconfig>. sigma0 receives some command line parameters and
1509 F<hello.nulconfig> file is generated on the fly from the lines between
1510 C<<<EOF> and C<EOF>.
1514 The following variables are interpreted in the novaboot script:
1520 Novaboot chdir()s to this directory before file generation phase. The
1521 directory name specified here is relative to the build directory
1522 specified by other means (see L</--build-dir>).
1526 Assigning this variable has the same effect as specifying L</--exiton>
1529 =item HYPERVISOR_PARAMS
1531 Parameters passed to hypervisor. The default value is "serial", unless
1532 overridden in configuration file.
1536 The kernel to use instead of the hypervisor specified in the
1537 configuration file with the C<$hypervisor> variable. The value should
1538 contain the name of the kernel image as well as its command line
1539 parameters. If this variable is defined and non-empty, the variable
1540 HYPERVISOR_PARAMS is not used.
1544 Use a specific qemu binary (can be overridden with B<-Q>) and flags
1545 when booting this script under qemu. If QEMU_FLAGS variable is also
1546 specified flags specified in QEMU variable are replaced by those in
1551 Use specific qemu flags (can be overridden with B<-q>).
1555 Description of the wvtest-compliant program.
1557 =item WVTEST_TIMEOUT
1559 The timeout in seconds for WvTest harness. If no complete line appears
1560 in the test output within the time specified here, the test fails. It
1561 is necessary to specify this for long running tests that produce no
1562 intermediate output.
1566 =head1 CONFIGURATION FILE
1568 Novaboot can read its configuration from one or more files. By
1569 default, novaboot looks for files named F<.novaboot> as described in
1570 L</Configuration reading phase>. Alternatively, its location can be
1571 specified with the B<-c> switch or with the NOVABOOT_CONFIG
1572 environment variable. The configuration file has perl syntax and
1573 should set values of certain Perl variables. The current configuration
1574 can be dumped with the B<--dump-config> switch. Some configuration
1575 variables can be overridden by environment variables (see below) or by
1576 command line switches.
1578 Supported configuration variables include:
1584 Build directory location relative to the location of the configuration
1587 =item $default_target
1589 Default target (see below) to use when no target is explicitly
1590 specified on command line with the B<--target> option.
1594 Hash of shortcuts to be used with the B<--target> option. If the hash
1595 contains, for instance, the following pair of values
1597 'mybox' => '--server=boot:/tftproot --serial=/dev/ttyUSB0 --grub',
1599 then the following two commands are equivalent:
1601 ./script --server=boot:/tftproot --serial=/dev/ttyUSB0 --grub
1606 =head1 ENVIRONMENT VARIABLES
1608 Some options can be specified not only via config file or command line
1609 but also through environment variables. Environment variables override
1610 the values from configuration file and command line parameters
1611 override the environment variables.
1615 =item NOVABOOT_CONFIG
1617 Name of the novaboot configuration file to use instead of the default
1620 =item NOVABOOT_BENDER
1622 Defining this variable has the same meaning as B<--bender> option.
1628 Michal Sojka <sojka@os.inf.tu-dresden.de>