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 -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};
292 die("novaboot: Cannot parse script '$last_fn' line $.. Didn't you forget 'load' keyword?\n");
295 # print Dumper(\@scripts);
297 foreach my $script (@scripts) {
298 $modules = $$script{modules};
299 @$modules[0] =~ s/^[^ ]*/$kernel_opt/ if $kernel_opt;
300 @$modules[0] .= ' ' . join(' ', @append) if @append;
303 if (exists $variables->{KERNEL}) {
304 $kernel = $variables->{KERNEL};
306 if ($CFG::hypervisor) {
307 $kernel = $CFG::hypervisor . " ";
308 if (exists $variables->{HYPERVISOR_PARAMS}) {
309 $kernel .= $variables->{HYPERVISOR_PARAMS};
311 $kernel .= $CFG::hypervisor_params;
315 @$modules = ($kernel, @$modules) if $kernel;
316 @$modules = (@chainloaders, @$modules);
317 @$modules = ("bin/boot/bender", @$modules) if ($bender || defined $ENV{'NOVABOOT_BENDER'});
321 foreach my $script (@scripts) {
322 print join("\n", @{$$script{modules}})."\n";
329 sub generate_configs($$$) {
330 my ($base, $generated, $filename) = @_;
331 if ($base) { $base = "$base/"; };
332 foreach my $g(@$generated) {
333 if (exists $$g{content}) {
334 my $config = $$g{content};
335 my $fn = $$g{filename};
336 open(my $f, '>', $fn) || die("$fn: $!");
337 map { s|\brom://([^ ]*)|$rom_prefix$base$1|g; print $f "$_"; } @{$config};
339 print "novaboot: Created $fn\n";
340 } elsif (exists $$g{command} && ! $no_file_gen) {
341 $ENV{SRCDIR} = dirname(File::Spec->rel2abs( $filename, $invocation_dir ));
342 system_verbose("( $$g{command} ) > $$g{filename}");
347 sub generate_grub_config($$$$;$)
349 my ($filename, $title, $base, $modules_ref, $preamble) = @_;
350 if ($base) { $base = "$base/"; };
351 open(my $fg, '>', $filename) or die "$filename: $!";
352 print $fg "$preamble\n" if $preamble;
353 print $fg "title $title\n" if $title;
354 #print $fg "root $base\n"; # root doesn't really work for (nd)
356 foreach (@$modules_ref) {
359 my ($kbin, $kcmd) = split(' ', $_, 2);
360 $kcmd = '' if !defined $kcmd;
361 print $fg "kernel ${base}$kbin $kcmd\n";
363 s|\brom://([^ ]*)|$rom_prefix$base$1|g; # Translate rom:// files - needed for vdisk parameter of sigma0
364 print $fg "module $base$_\n";
368 print("novaboot: Created $builddir/$filename\n");
372 sub generate_grub2_config($$$$;$$)
374 my ($filename, $title, $base, $modules_ref, $preamble, $prolog) = @_;
375 if ($base && substr($base,-1,1) ne '/') { $base = "$base/"; };
376 open(my $fg, '>', $filename) or die "$filename: $!";
377 print $fg "$preamble\n" if $preamble;
378 $title ||= 'novaboot';
379 print $fg "menuentry $title {\n";
380 print $fg "$prolog\n" if $prolog;
382 foreach (@$modules_ref) {
385 my ($kbin, $kcmd) = split(' ', $_, 2);
386 $kcmd = '' if !defined $kcmd;
387 print $fg " multiboot ${base}$kbin $kcmd\n";
390 # GRUB2 doesn't pass filename in multiboot info so we have to duplicate it here
391 $_ = join(' ', ($args[0], @args));
392 s|\brom://|$rom_prefix|g; # We do not need to translate path for GRUB2
393 print $fg " module $base$_\n";
398 print("novaboot: Created $builddir/$filename\n");
402 sub generate_pulsar_config($$)
404 my ($filename, $modules_ref) = @_;
405 open(my $fg, '>', $filename) or die "$filename: $!";
406 print $fg "root $pulsar_root\n" if defined $pulsar_root;
409 foreach (@$modules_ref) {
412 ($kbin, $kcmd) = split(' ', $_, 2);
413 $kcmd = '' if !defined $kcmd;
416 s|\brom://|$rom_prefix|g;
417 print $fg "load $_\n";
420 # Put kernel as last - this is needed for booting Linux and has no influence on non-Linux OSes
421 print $fg "exec $kbin $kcmd\n";
423 print("novaboot: Created $builddir/$filename\n");
427 sub shell_cmd_string(@)
429 return join(' ', map((/^[-_=a-zA-Z0-9\/\.\+]+$/ ? "$_" : "'$_'"), @_));
434 print "novaboot: Running: ".shell_cmd_string(@_)."\n";
438 sub system_verbose($)
441 print "novaboot: Running: $cmd\n";
442 my $ret = system($cmd);
443 if ($ret & 0x007f) { die("Command terminated by a signal"); }
444 if ($ret & 0xff00) {die("Command exit with non-zero exit code"); }
445 if ($ret) { die("Command failure $ret"); }
450 if (exists $variables->{WVDESC}) {
451 print "Testing \"$variables->{WVDESC}\" in $last_fn:\n";
452 } elsif ($last_fn =~ /\.wv$/) {
453 print "Testing \"all\" in $last_fn:\n";
456 ## Connect to the target and check whether it is not occupied
458 # We have to do this before file generation phase, because file
459 # generation is intermixed with file deployment phase and we want to
460 # check whether the target is not used by somebody else before
461 # deploying files. Otherwise, we may rewrite other user's files on a
464 my $exp; # Expect object to communicate with the target over serial line
466 my ($target_reset, $target_power_on, $target_power_off);
468 if (defined $iprelay) {
470 $iprelay =~ /([.0-9]+)(:([0-9]+))?/;
473 my $paddr = sockaddr_in($port, inet_aton($addr));
474 my $proto = getprotobyname('tcp');
475 socket($IPRELAY, PF_INET, SOCK_STREAM, $proto) || die "socket: $!";
476 print "novaboot: Connecting to IP relay... ";
477 connect($IPRELAY, $paddr) || die "connect: $!";
479 $exp = Expect->init(\*$IPRELAY);
483 print $exp "\xFF\xF6"; # AYT
484 my $connected = $exp->expect(20, # Timeout in seconds
485 '<iprelayd: connected>',
486 '-re', '<WEB51 HW[^>]*>');
491 my ($relay, $onoff) = @_;
492 die unless ($relay == 1 || $relay == 2);
494 my $cmd = ($relay == 1 ? 0x5 : 0x6) | ($onoff ? 0x20 : 0x10);
495 return "\xFF\xFA\x2C\x32".chr($cmd)."\xFF\xF0";
499 my ($relay, $onoff) = @_;
500 die unless ($relay == 1 || $relay == 2);
501 my $cmd = ($relay == 1 ? 0xdf : 0xbf) | ($onoff ? 0x00 : 0xff);
502 return "\xFF\xFA\x2C\x97".chr($cmd)."\xFF\xF0";
506 my ($relay, $onoff, $can_giveup) = @_;
507 my $confirmation = '';
509 print $exp relaycmd($relay, $onoff);
510 my $confirmed = $exp->expect(20, # Timeout in seconds
511 relayconf($relay, $onoff));
514 print("Relay confirmation timeout - ignoring\n");
516 die "Relay confirmation timeout";
522 $target_reset = sub {
523 relay(2, 1, 1); # Reset the machine
528 $target_power_off = sub {
529 relay(1, 1); # Press power button
530 usleep(6000000); # Long press to switch off
534 $target_power_on = sub {
535 relay(1, 1); # Press power button
536 usleep(100000); # Short press
542 system_verbose("stty -F $serial $stty");
543 open($CONN, "+<", $serial) || die "open $serial: $!";
544 $exp = Expect->init(\*$CONN);
546 elsif ($remote_cmd) {
547 print "novaboot: Running: $remote_cmd\n";
548 $exp = Expect->spawn($remote_cmd);
550 elsif (defined $amt) {
552 use LWP::Authen::Digest;
555 my ($host, $username, $password, $schema, $className, $pstate) = @_;
556 #AMT numbers for PowerStateChange (MNI => bluescreen on windows;-)
557 my %pstates = ("on" => 2,
564 <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">
565 <s:Header><a:To>http://$host:16992/wsman</a:To>
566 <w:ResourceURI s:mustUnderstand="true">$schema</w:ResourceURI>
567 <a:ReplyTo><a:Address s:mustUnderstand="true">http://schemas.xmlsoap.org/ws/2004/08/addressing/role/anonymous</a:Address></a:ReplyTo>
568 <a:Action s:mustUnderstand="true">$schema$className</a:Action>
569 <w:MaxEnvelopeSize s:mustUnderstand="true">153600</w:MaxEnvelopeSize>
570 <a:MessageID>uuid:709072C9-609C-4B43-B301-075004043C7C</a:MessageID>
571 <w:Locale xml:lang="en-US" s:mustUnderstand="false" />
572 <w:OperationTimeout>PT60.000S</w:OperationTimeout>
573 <w:SelectorSet><w:Selector Name="Name">Intel(r) AMT Power Management Service</w:Selector></w:SelectorSet>
575 <p:RequestPowerStateChange_INPUT xmlns:p="http://schemas.dmtf.org/wbem/wscim/1/cim-schema/2/CIM_PowerManagementService">
576 <p:PowerState>$pstates{$pstate}</p:PowerState>
577 <p:ManagedElement><a:Address>http://$host:16992/wsman</a:Address>
578 <a:ReferenceParameters><w:ResourceURI>http://schemas.dmtf.org/wbem/wscim/1/cim-schema/2/CIM_ComputerSystem</w:ResourceURI>
579 <w:SelectorSet><w:Selector Name="Name">ManagedSystem</w:Selector></w:SelectorSet>
580 </a:ReferenceParameters></p:ManagedElement>
581 </p:RequestPowerStateChange_INPUT>
582 </s:Body></s:Envelope>
587 my ($host, $username, $password, $content) = @_;
589 my $ua = LWP::UserAgent->new();
590 $ua->agent("novaboot");
592 my $req = HTTP::Request->new(POST => "http://$host:16992/wsman");
593 my $res = $ua->request($req);
594 die ("Unexpected AMT response: " . $res->status_line) unless $res->code == 401;
596 my ($realm) = $res->header("WWW-Authenticate") =~ /Digest realm="(.*?)"/;
597 $ua->credentials("$host:16992", $realm, $username => $password);
600 $req = HTTP::Request->new(POST => "http://$host:16992/wsman");
601 $req->content_type('application/x-www-form-urlencoded');
602 $req->content($content);
603 $res = $ua->request($req);
604 die ("AMT power change request failed: " . $res->status_line) unless $res->is_success;
605 $res->content() =~ /<g:ReturnValue>(\d+)<\/g:ReturnValue>/;
610 my ($host, $username, $password, $pstate)=@_;
611 my $schema="http://schemas.dmtf.org/wbem/wscim/1/cim-schema/2/CIM_PowerManagementService";
612 my $className="/RequestPowerStateChange";
613 my $content = genXML($host, $username, $password ,$schema, $className, $pstate);
614 return sendPOST($host, $username, $password, $content);
617 my ($user,$amt_password,$host,$port) = ($amt =~ /(?:(.*?)(?::(.*))?@)?([^:]*)(?::([0-9]*))?/);;
619 $amt_password ||= $ENV{'AMT_PASSWORD'} || die "AMT password not specified";
620 $host || die "AMT host not specified";
623 $target_power_off = sub {
624 my $result = powerChange($host,$user,$amt_password, "off");
625 die "AMT power off failed (ReturnValue $result)" if $result != 0;
628 $target_power_on = sub {
629 my $result = powerChange($host,$user,$amt_password, "on");
630 die "AMT power on failed (ReturnValue $result)" if $result != 0;
633 $target_reset = sub {
634 my $result = powerChange($host,$user,$amt_password, "reset");
636 print STDERR "Warning: Cannot reset $host, trying power on. ";
637 $result = powerChange($host,$user,$amt_password, "on");
639 die "AMT reset failed (ReturnValue $result)" if $result != 0;
641 sleep(2); # Without pause, connection to AMT machine is
642 # initiated before reset and fails after restart
644 # amtterm must be run here because AMT doesn't allow to
645 # reset/on/off computer when somebody is connected
646 $exp = Expect->spawn("amtterm -u $user -p $amt_password $host $port");
650 if ($remote_expect) {
651 $exp->expect(10, $remote_expect) || die "Expect for '$remote_expect' timed out";
654 if (defined $reset_cmd) {
655 $target_reset = sub {
656 system_verbose($reset_cmd);
660 if (defined $on_opt && defined $target_power_on) {
664 if (defined $off_opt && defined $target_power_off) {
665 print "novaboot: Switching the target off...\n";
666 &$target_power_off();
670 $builddir ||= dirname(File::Spec->rel2abs( ${$scripts[0]}{filename})) if scalar @scripts;
671 if (defined $builddir) {
672 chdir($builddir) or die "Can't change directory to $builddir: $!";
673 print "novaboot: Entering directory `$builddir'\n";
676 ## File generation phase
677 my (%files_iso, $menu_iso, $filename);
678 my $config_name = '';
680 foreach my $script (@scripts) {
681 $filename = $$script{filename};
682 $modules = $$script{modules};
683 $generated = $$script{generated};
684 $variables = $$script{variables};
686 ($config_name = $filename) =~ s#.*/##;
687 $config_name = $config_name_opt if (defined $config_name_opt);
689 if (exists $variables->{BUILDDIR}) {
690 $builddir = File::Spec->rel2abs($variables->{BUILDDIR});
691 chdir($builddir) or die "Can't change directory to $builddir: $!";
692 print "novaboot: Entering directory `$builddir'\n";
696 ($prefix = $grub_prefix) =~ s/\$NAME/$config_name/ if defined $grub_prefix;
697 $prefix ||= $builddir;
698 # TODO: use $grub_prefix as first parameter if some switch is given
699 generate_configs('', $generated, $filename);
701 ### Generate bootloader configuration files
702 my @bootloader_configs;
703 push @bootloader_configs, generate_grub_config($grub_config, $config_name, $prefix, $modules, $grub_preamble) if (defined $grub_config);
704 push @bootloader_configs, generate_grub2_config($grub2_config, $config_name, $prefix, $modules, $grub_preamble, $grub2_prolog) if (defined $grub2_config);
705 push @bootloader_configs, generate_pulsar_config('config-'.($pulsar||'novaboot'), $modules) if (defined $pulsar);
707 ### Run scons or make
709 my @files = map({ ($file) = m/([^ ]*)/; $file; } @$modules);
710 # Filter-out generated files
711 my @to_build = grep({ my $file = $_; !scalar(grep($file eq $$_{filename}, @$generated)) } @files);
713 system_verbose($scons || $CFG::scons." ".join(" ", @to_build)) if (defined $scons);
714 system_verbose($make || $CFG::make ." ".join(" ", @to_build)) if (defined $make);
717 ### Copy files (using rsync)
718 if (defined $server && !defined($gen_only)) {
719 (my $real_server = $server) =~ s/\$NAME/$config_name/;
721 my ($hostname, $path) = split(":", $real_server, 2);
722 if (! defined $path) {
726 my $files = join(" ", map({ ($file) = m/([^ ]*)/; $file; } ( @$modules, @bootloader_configs)));
727 map({ my $file = (split)[0]; die "$file: $!" if ! -f $file; } @$modules);
728 my $istty = -t STDOUT && ($ENV{'TERM'} || 'dumb') ne 'dumb';
729 my $progress = $istty ? "--progress" : "";
730 system_verbose("rsync $progress -RLp $rsync_flags $files $real_server");
731 if ($server =~ m|/\$NAME$| && $concat) {
732 my $cmd = join("; ", map { "( cd $path/.. && cat */$_ > $_ )" } @bootloader_configs);
733 system_verbose($hostname ? "ssh $hostname '$cmd'" : $cmd);
737 ### Prepare ISO image generation
738 if (defined $iso_image) {
739 generate_configs("(cd)", $generated, $filename);
741 generate_grub_config(\$menu, $config_name, "(cd)", $modules);
742 $menu_iso .= "$menu\n";
743 map { ($file,undef) = split; $files_iso{$file} = 1; } @$modules;
747 ## Generate ISO image
748 if (defined $iso_image) {
749 open(my $fh, ">menu-iso.lst");
750 print $fh "timeout 5\n\n$menu_iso";
752 my $files = "boot/grub/menu.lst=menu-iso.lst " . join(" ", map("$_=$_", keys(%files_iso)));
753 $iso_image ||= "$config_name.iso";
754 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");
755 print("ISO image created: $builddir/$iso_image\n");
758 exit(0) if defined $gen_only;
760 ## Boot the system using various methods and send serial output to stdout
762 if (scalar(@scripts) > 1 && ( defined $dhcp_tftp || defined $serial || defined $iprelay)) {
763 die "You cannot do this with multiple scripts simultaneously";
766 if ($variables->{WVTEST_TIMEOUT}) {
767 print "wvtest: timeout ", $variables->{WVTEST_TIMEOUT}, "\n";
772 $str =~ s/^\s+|\s+$//g;
780 $qemu ||= $variables->{QEMU} || $CFG::qemu;
781 my @qemu_flags = split(" ", $qemu);
782 $qemu = shift(@qemu_flags);
784 @qemu_flags = split(/ +/, trim($variables->{QEMU_FLAGS})) if exists $variables->{QEMU_FLAGS};
785 @qemu_flags = split(/ +/, trim($qemu_flags_cmd)) if $qemu_flags_cmd;
786 push(@qemu_flags, split(/ +/, trim($qemu_append || '')));
788 if (defined $iso_image) {
789 # Boot NOVA with grub (and test the iso image)
790 push(@qemu_flags, ('-cdrom', "$config_name.iso"));
792 # Boot NOVA without GRUB
794 # Non-patched qemu doesn't like commas, but NUL can live with pluses instead of commans
795 foreach (@$modules) {s/,/+/g;}
796 generate_configs("", $generated, $filename);
798 if (scalar @$modules) {
799 my ($kbin, $kcmd) = split(' ', shift(@$modules), 2);
800 $kcmd = '' if !defined $kcmd;
802 @$modules = map { if (/\.dtb$/) { $dtb=$_; (); } else { $_ } } @$modules;
803 my $initrd = join ",", @$modules;
805 push(@qemu_flags, ('-kernel', $kbin, '-append', $kcmd));
806 push(@qemu_flags, ('-initrd', $initrd)) if $initrd;
807 push(@qemu_flags, ('-dtb', $dtb)) if $dtb;
810 push(@qemu_flags, qw(-serial stdio)); # Redirect serial output (for collecting test restuls)
811 unshift(@qemu_flags, ('-name', $config_name));
812 print "novaboot: Running: ".shell_cmd_string($qemu, @qemu_flags)."\n";
813 $exp = Expect->spawn(($qemu, @qemu_flags)) || die("exec() failed: $!");
816 ### Local DHCPD and TFTPD
818 my ($dhcpd_pid, $tftpd_pid);
820 if (defined $dhcp_tftp)
822 generate_configs("(nd)", $generated, $filename);
823 system_verbose('mkdir -p tftpboot');
824 generate_grub_config("tftpboot/os-menu.lst", $config_name, "(nd)", \@$modules, "timeout 0");
825 open(my $fh, '>', 'dhcpd.conf');
826 my $mac = `cat /sys/class/net/eth0/address`;
828 print $fh "subnet 10.23.23.0 netmask 255.255.255.0 {
829 range 10.23.23.10 10.23.23.100;
830 filename \"bin/boot/grub/pxegrub.pxe\";
831 next-server 10.23.23.1;
834 hardware ethernet $mac;
835 fixed-address 10.23.23.1;
838 system_verbose("sudo ip a add 10.23.23.1/24 dev eth0;
839 sudo ip l set dev eth0 up;
840 sudo touch dhcpd.leases");
842 # We run servers by forking ourselves, because the servers end up
843 # in our process group and get killed by signals sent to the
844 # process group (e.g. Ctrl-C on terminal).
846 exec_verbose("sudo dhcpd -d -cf dhcpd.conf -lf dhcpd.leases -pf dhcpd.pid") if ($dhcpd_pid == 0);
848 exec_verbose("sudo in.tftpd --foreground --secure -v -v -v --pidfile tftpd.pid $builddir") if ($tftpd_pid == 0);
850 # Kill server when we die
851 $SIG{__DIE__} = sub { system_verbose('sudo pkill --pidfile=dhcpd.pid');
852 system_verbose('sudo pkill --pidfile=tftpd.pid'); };
855 ### Reset target (IP relay, AMT, ...)
857 if (defined $target_reset) {
858 print "novaboot: Reseting the test box... ";
863 ### U-boot conversation
864 if (defined $uboot) {
865 print "novaboot: Waiting for uBoot prompt...\n";
867 #$exp->exp_internal(1);
869 [qr/Hit any key to stop autoboot:/, sub { $exp->send("\n"); exp_continue; }],
870 '=> ') || die "No uBoot prompt deteceted";
871 $exp->send("$uboot_init\n") if $uboot_init;
872 $exp->expect(10, '=> ') || die "uBoot prompt timeout";
874 my ($kbin, $kcmd) = split(' ', shift(@$modules), 2);
876 @$modules = map { if (/\.dtb$/) { $dtb=$_; (); } else { $_ } } @$modules;
877 my $initrd = shift @$modules;
879 my $kern_addr = '800000';
880 my $initrd_addr = '-';
883 $exp->send("tftp $kern_addr $kbin\n");
885 [qr/#/, sub { exp_continue; }],
886 '=> ') || die "Kernel load failed";
888 $dtb_addr = '7f0000';
889 $exp->send("tftp $dtb_addr $dtb\n");
891 [qr/#/, sub { exp_continue; }],
892 '=> ') || die "Device tree load failed";
894 if (defined $initrd) {
895 $initrd_addr = 'b00000';
896 $exp->send("tftp $initrd_addr $initrd\n");
898 [qr/#/, sub { exp_continue; }],
899 '=> ') || die "Initrd load failed";
901 $exp->send("set bootargs '$kcmd'\n");
902 $exp->expect(5, '=> ') || die "uBoot prompt timeout";
903 $exp->send("bootm $kern_addr $initrd_addr $dtb_addr\n");
904 $exp->expect(5, "\n") || die "uBoot command timeout";
907 ### Serial line interaction
909 # Serial line of the target is available
910 my $interrupt = 'Ctrl-C';
911 if ($interactive && !@exiton) {
912 $interrupt = '"~~."';
914 print "novaboot: Serial line interaction (press $interrupt to interrupt)...\n";
917 $exp->expect(undef, @expect_raw, @exiton);
920 if (-t STDIN) { # Set up bi-directional communication if we run on terminal
921 my $infile = new IO::File;
922 $infile->IO::File::fdopen(*STDIN,'r');
923 my $in_object = Expect->exp_init($infile);
924 $in_object->set_group($exp);
927 $in_object->set_seq('~~\.', sub { print "novaboot: Escape sequence detected\r\n"; undef; });
928 $in_object->manual_stty(0); # Use raw terminal mode
930 $in_object->manual_stty(1); # Do not modify terminal settings
932 push(@inputs, $in_object);
935 #print Dumper(\@expect_raw);
936 $exp->expect(undef, @expect_raw) if @expect_raw;
937 Expect::interconnect(@inputs) unless defined($exp->exitstatus);
941 ## Kill dhcpc or tftpd
942 if (defined $dhcp_tftp) {
943 die("novaboot: This should kill servers on background\n");
950 novaboot - A tool for booting various operating systems on various hardware or in qemu
956 B<novaboot> [option]... [--] script...
958 B<./script> [option]...
962 This program makes booting of an operating system (e.g. NOVA or Linux)
963 as simple as running a local program. It facilitates booting on local
964 or remote hosts or in emulators such as qemu. Novaboot operation is
965 controlled by command line options and by a so called novaboot script,
966 which can be thought as a generalization of bootloader configuration
967 files (see L</"NOVABOOT SCRIPT SYNTAX">). Based on this input,
968 novaboot setups everything for the target host to boot the desired
969 configuration, i.e. it generates the bootloader configuration file in
970 the proper format, deploy the binaries and other needed files to
971 required locations, perhaps on a remote boot server and reset the
972 target host. Finally, target host's serial output is redirected to
973 standard output if that is possible.
975 Typical way of using novaboot is to make the novaboot script
976 executable and set its first line to I<#!/usr/bin/env novaboot>. Then,
977 booting a particular OS configuration becomes the same as executing a
978 local program - the novaboot script.
980 For example, with C<novaboot> you can:
986 Run an OS in Qemu. This is the default action when no other action is
987 specified by command line switches. Thus running C<novaboot ./script>
988 (or C<./script> as described above) will run Qemu and make it boot the
989 configuration specified in the F<script>.
993 Create a bootloader configuration file (currently supported
994 bootloaders are GRUB, GRUB2, Pulsar and U-Boot) and copy it with all
995 other files needed for booting to a remote boot server.
997 ./script --server=192.168.1.1:/tftp --iprelay=192.168.1.2
999 This command copies files to the TFTP server and uses
1000 TCP/IP-controlled relay to reset the target host and receive its
1005 Run DHCP and TFTP server on developer's machine to PXE-boot the target
1008 ./script --dhcp-tftp
1010 When a PXE-bootable machine is connected via Ethernet to developer's
1011 machine, it will boot the configuration described in I<script>.
1015 Create bootable ISO images. E.g.
1017 novaboot --iso -- script1 script2
1019 The created ISO image will have GRUB bootloader installed on it and
1020 the boot menu will allow selecting between I<script1> and I<script2>
1025 Note that the options needed for a specific target can be stored in a
1026 L</"CONFIGURATION FILE">. Then it is sufficient to use only the B<-t>
1027 option to specify the name of the target.
1029 =head1 PHASES AND OPTIONS
1031 Novaboot performs its work in several phases. Each phase can be
1032 influenced by several options, certain phases can be skipped. The list
1033 of phases (in the execution order) and the corresponding options
1036 =head2 Configuration reading phase
1038 After starting, novaboot reads configuration files. By default, it
1039 searches for files named F<.novaboot> starting from the directory of
1040 the novaboot script (or working directory, see bellow) and continuing
1041 upwards up to the root directory. The configuration files are read in
1042 order from the root directory downwards with latter files overriding
1043 settings from the former ones.
1045 In certain cases, the location of the novaboot script cannot be
1046 determined in this early phase. This happens either when the script is
1047 read from the standard input or when novaboot is invoked explicitly
1048 and options precede the script name, as in the example L</"4."> above.
1049 In this case the current working directory is used as a starting point
1050 for configuration file search.
1054 =item -c, --config=I<filename>
1056 Use the specified configuration file instead of the default one(s).
1060 =head2 Command line processing phase
1066 Dump the current configuration to stdout end exits. Useful as an
1067 initial template for a configuration file.
1071 Print short (B<-h>) or long (B<--help>) help.
1073 =item -t, --target=I<target>
1075 This option serves as a user configurable shortcut for other novaboot
1076 options. The effect of this option is the same as the options stored
1077 in the C<%targets> configuration variable under key I<target>. See
1078 also L</"CONFIGURATION FILE">.
1082 =head2 Script preprocessing phase
1084 This phases allows to modify the parsed novaboot script before it is
1085 used in the later phases.
1089 =item -a, --append=I<parameters>
1091 Append a string to the first C<load> line in the novaboot script. This
1092 can be used to append parameters to the kernel's or root task's
1093 command line. Can appear multiple times.
1097 Use F<bender> chainloader. Bender scans the PCI bus for PCI serial
1098 ports and stores the information about them in the BIOS data area for
1101 =item --chainloader=I<chainloader>
1103 Chainloader that is loaded before the kernel and other files specified
1104 in the novaboot script. E.g. 'bin/boot/bender promisc'.
1108 Print the modules to boot and their parameters after this phase
1109 finishes. Then exit. This is useful for seeing the effect of other
1110 options in this section.
1112 =item -k, --kernel=F<file>
1114 Replace the first word on the first C<load> line in the novaboot
1115 script with F<file>.
1117 =item --scriptmod=I<perl expression>
1119 When novaboot script is read, I<perl expression> is executed for every
1120 line (in $_ variable). For example, C<novaboot
1121 --scriptmod=s/sigma0/omega6/g> replaces every occurrence of I<sigma0>
1122 in the script with I<omega6>.
1124 When this option is present, it overrides I<$script_modifier> variable
1125 from the configuration file, which has the same effect. If this option
1126 is given multiple times all expressions are evaluated in the command
1131 =head2 File generation phase
1133 In this phase, files needed for booting are generated in a so called
1134 I<build directory> (see L</--build-dir>). In most cases configuration
1135 for a bootloader is generated automatically by novaboot. It is also
1136 possible to generate other files using I<heredoc> or I<"<"> syntax in
1137 novaboot scripts. Finally, binaries can be generated in this phases by
1138 running C<scons> or C<make>.
1142 =item --build-dir=I<directory>
1144 Overrides the default build directory location.
1146 The default build directory location is determined as follows: If the
1147 configuration file defines the C<$builddir> variable, its value is
1148 used. Otherwise, it is the directory that contains the first processed
1151 See also L</BUILDDIR> variable.
1153 =item -g, --grub[=I<filename>]
1155 Generates grub bootloader menu file. If the I<filename> is not
1156 specified, F<menu.lst> is used. The I<filename> is relative to the
1157 build directory (see B<--build-dir>).
1159 =item --grub-preamble=I<prefix>
1161 Specifies the I<preable> that is at the beginning of the generated
1162 GRUB or GRUB2 config files. This is useful for specifying GRUB's
1165 =item --grub-prefix=I<prefix>
1167 Specifies I<prefix> that is put in front of every file name in GRUB's
1168 F<menu.lst>. The default value is the absolute path to the build directory.
1170 If the I<prefix> contains string $NAME, it will be replaced with the
1171 name of the novaboot script (see also B<--name>).
1173 =item --grub2[=I<filename>]
1175 Generate GRUB2 menuentry in I<filename>. If I<filename> is not
1176 specified F<grub.cfg> is used. The content of the menuentry can be
1177 customized with B<--grub-preable>, B<--grub2-prolog> or
1178 B<--grub_prefix> options.
1180 In order to use the the generated menuentry on your development
1181 machine that uses GRUB2, append the following snippet to
1182 F</etc/grub.d/40_custom> file and regenerate your grub configuration,
1183 i.e. run update-grub on Debian/Ubuntu.
1185 if [ -f /path/to/nul/build/grub.cfg ]; then
1186 source /path/to/nul/build/grub.cfg
1189 =item --grub2-prolog=I<prolog>
1191 Specifies text I<preable> that is put at the beginning of the entry
1194 =item -m, --make[=make command]
1196 Runs C<make> to build files that are not generated by novaboot itself.
1198 =item --name=I<string>
1200 Use the name I<string> instead of the name of the novaboot script.
1201 This name is used for things like a title of grub menu or for the
1202 server directory where the boot files are copied to.
1206 Do not generate files on the fly (i.e. "<" syntax) except for the
1207 files generated via "<<WORD" syntax.
1209 =item -p, --pulsar[=mac]
1211 Generates pulsar bootloader configuration file named F<config-I<mac>>
1212 The I<mac> string is typically a MAC address and defaults to
1215 =item --scons[=scons command]
1217 Runs C<scons> to build files that are not generated by novaboot
1222 Strip I<rom://> prefix from command lines and generated config files.
1223 The I<rom://> prefix is used by NUL. For NRE, it has to be stripped.
1227 Exit novaboot after file generation phase.
1231 =head2 Target connection check
1233 If supported by the target, the connection to it is made and it is
1234 checked whether the target is not occupied by another novaboot
1239 =item --amt=I<"[user[:password]@]host[:port]>
1241 Use Intel AMT technology to control the target machine. WS management
1242 is used to powercycle it and Serial-Over-Lan (SOL) for input/output.
1243 The hostname or (IP address) is given by the I<host> parameter. If
1244 I<password> is not specified, environment variable AMT_PASSWORD is
1245 used. The I<port> specifies a TCP port for SOL. If not specified, the
1246 default is 16992. Default I<user> is admin.
1248 =item --iprelay=I<addr[:port]>
1250 Use TCP/IP relay and serial port to access the target's serial port
1251 and powercycle it. The IP address of the relay is given by I<addr>
1252 parameter. If I<port> is not specified, it default to 23.
1254 Note: This option is supposed to work with HWG-ER02a IP relays.
1256 =item -s, --serial[=device]
1258 Target's serial line is connected to host's serial line (device). The
1259 default value for device is F</dev/ttyUSB0>.
1261 The value of this option is exported in NB_NOVABOOT environment
1262 variable to all subprocesses run by C<novaboot>.
1264 =item --stty=I<settings>
1266 Specifies settings passed to C<stty> invoked on the serial line
1267 specified with B<--serial> option. If this option is not given,
1268 C<stty> is called with C<raw -crtscts -onlcr 115200> settings.
1270 =item --remote-cmd=I<cmd>
1272 Command that mediates connection to the target's serial line. For
1273 example C<ssh server 'cu -l /dev/ttyS0'>.
1275 =item --remote-expect=I<string>
1277 Wait for reception of I<string> after establishing the the remote
1278 connection before continuing.
1283 =head2 File deployment phase
1285 In some setups, it is necessary to copy the files needed for booting
1286 to a particular location, e.g. to a TFTP boot server or to the
1291 =item -d, --dhcp-tftp
1293 Turns your workstation into a DHCP and TFTP server so that the OS can
1294 be booted via PXE BIOS (or similar mechanism) on the test machine
1295 directly connected by a plain Ethernet cable to your workstation.
1297 The DHCP and TFTP servers require root privileges and C<novaboot>
1298 uses C<sudo> command to obtain those. You can put the following to
1299 I</etc/sudoers> to allow running the necessary commands without
1300 asking for password.
1302 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
1303 your_login ALL=NOPASSWD: NOVABOOT
1305 =item --iso[=filename]
1307 Generates the ISO image that boots NOVA system via GRUB. If no filename
1308 is given, the image is stored under I<NAME>.iso, where I<NAME> is the name
1309 of the novaboot script (see also B<--name>).
1311 =item --server[=[[user@]server:]path]
1313 Copy all files needed for booting to another location (implies B<-g>
1314 unless B<--grub2> is given). The files will be copied (by B<rsync>
1315 tool) to the directory I<path>. If the I<path> contains string $NAME,
1316 it will be replaced with the name of the novaboot script (see also
1321 If B<--server> is used and its value ends with $NAME, then after
1322 copying the files, a new bootloader configuration file (e.g. menu.lst)
1323 is created at I<path-wo-name>, i.e. the path specified by B<--server>
1324 with $NAME part removed. The content of the file is created by
1325 concatenating all files of the same name from all subdirectories of
1326 I<path-wo-name> found on the "server".
1328 =item --rsync-flags=I<flags>
1330 Specifies which I<flags> are appended to F<rsync> command line when
1331 copying files as a result of I<--server> option.
1335 =head2 Target power-on and reset phase
1341 Switch on/off the target machine and exit. The script (if any) is
1342 completely ignored. Currently it works only with B<--iprelay> or
1345 =item -Q, --qemu[=I<qemu-binary>]
1347 Boot the configuration in qemu. Optionally, the name of qemu binary
1348 can be specified as a parameter.
1350 =item --qemu-append=I<flags>
1352 Append I<flags> to the default qemu flags (QEMU_FLAGS variable or
1353 C<-cpu coreduo -smp 2>).
1355 =item -q, --qemu-flags=I<flags>
1357 Replace the default qemu flags (QEMU_FLAGS variable or C<-cpu coreduo
1358 -smp 2>) with I<flags> specified here.
1360 =item --reset-cmd=I<cmd>
1362 Command that resets the target.
1366 =head2 Interaction with the bootloader on the target
1372 Interact with uBoot bootloader to boot the thing described in the
1373 novaboot script. Implementation of this option is currently tied to a
1374 particular board that we use. It may be subject to changes in the
1379 Command(s) to send the U-Boot bootloader before loading the images and
1384 =head2 Target interaction phase
1386 In this phase, target's serial output is redirected to stdout and if
1387 stdin is a TTY, it is redirected to the target's serial input allowing
1388 interactive work with the target.
1392 =item --exiton=I<string>
1394 When I<string> is sent by the target, novaboot exits. This option can
1395 be specified multiple times.
1397 If I<string> is C<-re>, then the next B<--exiton>'s I<string> is
1398 treated as regular expression. For example:
1400 --exiton -re --exiton 'error:.*failed'
1402 =item -i, --interactive
1404 Setup things for interactive use of target. Your terminal will be
1405 switched to raw mode. In raw mode, your system does not process input
1406 in any way (no echoing of entered characters, no interpretation
1407 special characters). This, among others, means that Ctrl-C is passed
1408 to the target and does no longer interrupt novaboot. Use "~~."
1409 sequence to exit novaboot.
1411 =item --expect=I<string>
1413 When I<string> is received from the target, send the string specified
1414 with the subsequent B<--send*> option to the target.
1416 =item --expect-re=I<regex>
1418 When target's output matches regular expression I<regex>, send the
1419 string specified with the subsequent B<--send*> option to the target.
1421 =item --expect-raw=I<perl-code>
1423 Provides direct control over Perl's Expect module.
1425 =item --send=I<string>
1427 Send I<string> to the target after the previously specified
1428 B<--expect*> was matched in the target's output. The I<string> may
1429 contain escape sequences such as "\n".
1431 Note that I<string> is actually interpreted by Perl, so it can contain
1432 much more that escape sequences. This behavior may change in the
1435 Example: C<--expect='login: ' --send='root\n'>
1437 =item --sendcont=I<string>
1439 Similar to B<--send> but continue expecting more input.
1441 Example: C<--expect='Continue?' --sendcont='yes\n'>
1445 =head1 NOVABOOT SCRIPT SYNTAX
1447 The syntax tries to mimic POSIX shell syntax. The syntax is defined
1448 with the following rules.
1450 Lines starting with "#" and empty lines are ignored.
1452 Lines that end with "\" are concatenated with the following line after
1453 removal of the final "\" and leading whitespace of the following line.
1455 Lines of the form I<VARIABLE=...> (i.e. matching '^[A-Z_]+=' regular
1456 expression) assign values to internal variables. See L</VARIABLES>
1459 Lines starting with C<load> keyword represent modules to boot. The
1460 word after C<load> is a file name (relative to the build directory
1461 (see B<--build-dir>) of the module to load and the remaining words are
1462 passed to it as the command line parameters.
1464 When the C<load> line ends with "<<WORD" then the subsequent lines
1465 until the line containing solely WORD are copied literally to the file
1466 named on that line. This is similar to shell's heredoc feature.
1468 When the C<load> line ends with "< CMD" then command CMD is executed
1469 with F</bin/sh> and its standard output is stored in the file named on
1470 that line. The SRCDIR variable in CMD's environment is set to the
1471 absolute path of the directory containing the interpreted novaboot
1476 #!/usr/bin/env novaboot
1477 load bzImage console=ttyS0,115200
1478 load rootfs.cpio < gen_cpio buildroot/images/rootfs.cpio "myapp->/etc/init.d/S99myapp"
1480 Example (NOVA User Land - NUL):
1482 #!/usr/bin/env novaboot
1483 WVDESC=Example program
1484 load bin/apps/sigma0.nul S0_DEFAULT script_start:1,1 \
1485 verbose hostkeyb:0,0x60,1,12,2
1486 load bin/apps/hello.nul
1487 load hello.nulconfig <<EOF
1488 sigma0::mem:16 name::/s0/log name::/s0/timer name::/s0/fs/rom ||
1489 rom://bin/apps/hello.nul
1492 This example will load three modules: F<sigma0.nul>, F<hello.nul> and
1493 F<hello.nulconfig>. sigma0 receives some command line parameters and
1494 F<hello.nulconfig> file is generated on the fly from the lines between
1495 C<<<EOF> and C<EOF>.
1499 The following variables are interpreted in the novaboot script:
1505 Novaboot chdir()s to this directory before file generation phase. The
1506 directory name specified here is relative to the build directory
1507 specified by other means (see L</--build-dir>).
1511 Assigning this variable has the same effect as specifying L</--exiton>
1514 =item HYPERVISOR_PARAMS
1516 Parameters passed to hypervisor. The default value is "serial", unless
1517 overridden in configuration file.
1521 The kernel to use instead of the hypervisor specified in the
1522 configuration file with the C<$hypervisor> variable. The value should
1523 contain the name of the kernel image as well as its command line
1524 parameters. If this variable is defined and non-empty, the variable
1525 HYPERVISOR_PARAMS is not used.
1529 Use a specific qemu binary (can be overridden with B<-Q>) and flags
1530 when booting this script under qemu. If QEMU_FLAGS variable is also
1531 specified flags specified in QEMU variable are replaced by those in
1536 Use specific qemu flags (can be overridden with B<-q>).
1540 Description of the wvtest-compliant program.
1542 =item WVTEST_TIMEOUT
1544 The timeout in seconds for WvTest harness. If no complete line appears
1545 in the test output within the time specified here, the test fails. It
1546 is necessary to specify this for long running tests that produce no
1547 intermediate output.
1551 =head1 CONFIGURATION FILE
1553 Novaboot can read its configuration from one or more files. By
1554 default, novaboot looks for files named F<.novaboot> as described in
1555 L</Configuration reading phase>. Alternatively, its location can be
1556 specified with the B<-c> switch or with the NOVABOOT_CONFIG
1557 environment variable. The configuration file has perl syntax and
1558 should set values of certain Perl variables. The current configuration
1559 can be dumped with the B<--dump-config> switch. Some configuration
1560 variables can be overridden by environment variables (see below) or by
1561 command line switches.
1563 Supported configuration variables include:
1569 Build directory location relative to the location of the configuration
1572 =item $default_target
1574 Default target (see below) to use when no target is explicitly
1575 specified on command line with the B<--target> option.
1579 Hash of shortcuts to be used with the B<--target> option. If the hash
1580 contains, for instance, the following pair of values
1582 'mybox' => '--server=boot:/tftproot --serial=/dev/ttyUSB0 --grub',
1584 then the following two commands are equivalent:
1586 ./script --server=boot:/tftproot --serial=/dev/ttyUSB0 --grub
1591 =head1 ENVIRONMENT VARIABLES
1593 Some options can be specified not only via config file or command line
1594 but also through environment variables. Environment variables override
1595 the values from configuration file and command line parameters
1596 override the environment variables.
1600 =item NOVABOOT_CONFIG
1602 Name of the novaboot configuration file to use instead of the default
1605 =item NOVABOOT_BENDER
1607 Defining this variable has the same meaning as B<--bender> option.
1613 Michal Sojka <sojka@os.inf.tu-dresden.de>