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, $tftp, $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:s" => \$uboot,
176 "uboot-init=s" => \@uboot_init,
181 # First process target options
183 my $t = defined($explicit_target) ? $explicit_target : $CFG::default_target;
185 exists $CFG::targets{$t} or die("Unknown target '$t' (valid targets are: ".join(", ", sort keys(%CFG::targets)).")");
186 GetOptionsFromString($CFG::targets{$t}, %opt_spec);
190 # Then process other command line options - some of them may override
191 # what was specified by the target
192 GetOptions %opt_spec or die("Error in command line arguments");
193 pod2usage(1) if $help;
194 pod2usage(-exitstatus => 0, -verbose => 2) if $man;
196 ### Dump sanitized configuration (if requested)
200 $Data::Dumper::Indent=1;
201 print "# This file is in perl syntax.\n";
202 foreach my $key(sort(keys(%CFG::))) { # See "Symbol Tables" in perlmod(1)
203 if (defined ${$CFG::{$key}}) { print Data::Dumper->Dump([${$CFG::{$key}}], ["*$key"]); }
204 if ( @{$CFG::{$key}}) { print Data::Dumper->Dump([\@{$CFG::{$key}}], ["*$key"]); }
205 if ( %{$CFG::{$key}}) { print Data::Dumper->Dump([\%{$CFG::{$key}}], ["*$key"]); }
211 ### Sanitize configuration
213 if ($interactive && !-t STDIN) {
214 die("novaboot: Interactive mode not supported when not on terminal");
217 if (defined $config_name_opt && scalar(@ARGV) > 1) { die "You cannot use --name with multiple scripts"; }
220 if (defined $serial) {
221 $serial ||= "/dev/ttyUSB0";
222 $ENV{NB_SERIAL} = $serial;
224 if (defined $grub_config) { $grub_config ||= "menu.lst"; }
225 if (defined $grub2_config) { $grub2_config ||= "grub.cfg"; }
227 ## Parse the novaboot script(s)
232 my ($modules, $variables, $generated, $continuation);
233 my $skip_reading = defined($on_opt) || defined($off_opt);
234 while (!$skip_reading && ($_ = <>)) {
235 if ($ARGV ne $last_fn) { # New script
236 die "Missing EOF in $last_fn" if $file;
237 die "Unfinished line in $last_fn" if $continuation;
239 push @scripts, { 'filename' => $ARGV,
240 'modules' => $modules = [],
241 'variables' => $variables = {},
242 'generated' => $generated = []};
246 next if /^#/ || /^\s*$/; # Skip comments and empty lines
248 $_ =~ s/^[[:space:]]*// if ($continuation);
250 if (/\\$/) { # Line continuation
251 $continuation .= substr($_, 0, length($_)-1);
255 if ($continuation) { # Last continuation line
256 $_ = $continuation . $_;
260 foreach my $mod(@scriptmod) { eval $mod; }
262 if ($file && $_ eq $EOF) { # Heredoc end
266 if ($file) { # Heredoc content
267 push @{$file}, "$_\n";
270 if (/^([A-Z_]+)=(.*)$/) { # Internal variable
271 $$variables{$1} = $2;
272 push(@exiton, $2) if ($1 eq "EXITON");
275 if (s/^load *//) { # Load line
276 die("novaboot: '$last_fn' line $.: Missing file name\n") unless /^[^ <]+/;
277 if (/^([^ ]*)(.*?)[[:space:]]*<<([^ ]*)$/) { # Heredoc start
278 push @$modules, "$1$2";
280 push @$generated, {filename => $1, content => $file};
284 if (/^([^ ]*)(.*?)[[:space:]]*< ?(.*)$/) { # Command substitution
285 push @$modules, "$1$2";
286 push @$generated, {filename => $1, command => $3};
292 if (/^run (.*)/) { # run line
293 push @$generated, {command => $1};
297 die("novaboot: Cannot parse script '$last_fn' line $.. Didn't you forget 'load' keyword?\n");
300 # print Dumper(\@scripts);
302 foreach my $script (@scripts) {
303 $modules = $$script{modules};
304 @$modules[0] =~ s/^[^ ]*/$kernel_opt/ if $kernel_opt;
305 @$modules[0] .= ' ' . join(' ', @append) if @append;
308 if (exists $variables->{KERNEL}) {
309 $kernel = $variables->{KERNEL};
311 if ($CFG::hypervisor) {
312 $kernel = $CFG::hypervisor . " ";
313 if (exists $variables->{HYPERVISOR_PARAMS}) {
314 $kernel .= $variables->{HYPERVISOR_PARAMS};
316 $kernel .= $CFG::hypervisor_params;
320 @$modules = ($kernel, @$modules) if $kernel;
321 @$modules = (@chainloaders, @$modules);
322 @$modules = ("bin/boot/bender", @$modules) if ($bender || defined $ENV{'NOVABOOT_BENDER'});
326 foreach my $script (@scripts) {
327 print join("\n", @{$$script{modules}})."\n";
334 sub generate_configs($$$) {
335 my ($base, $generated, $filename) = @_;
336 if ($base) { $base = "$base/"; };
337 foreach my $g(@$generated) {
338 if (exists $$g{content}) {
339 my $config = $$g{content};
340 my $fn = $$g{filename};
341 open(my $f, '>', $fn) || die("$fn: $!");
342 map { s|\brom://([^ ]*)|$rom_prefix$base$1|g; print $f "$_"; } @{$config};
344 print "novaboot: Created $fn\n";
345 } elsif (exists $$g{command} && ! $no_file_gen) {
346 $ENV{SRCDIR} = dirname(File::Spec->rel2abs( $filename, $invocation_dir ));
347 if (exists $$g{filename}) {
348 system_verbose("( $$g{command} ) > $$g{filename}");
350 system_verbose($$g{command});
356 sub generate_grub_config($$$$;$)
358 my ($filename, $title, $base, $modules_ref, $preamble) = @_;
359 if ($base) { $base = "$base/"; };
360 open(my $fg, '>', $filename) or die "$filename: $!";
361 print $fg "$preamble\n" if $preamble;
362 print $fg "title $title\n" if $title;
363 #print $fg "root $base\n"; # root doesn't really work for (nd)
365 foreach (@$modules_ref) {
368 my ($kbin, $kcmd) = split(' ', $_, 2);
369 $kcmd = '' if !defined $kcmd;
370 print $fg "kernel ${base}$kbin $kcmd\n";
372 s|\brom://([^ ]*)|$rom_prefix$base$1|g; # Translate rom:// files - needed for vdisk parameter of sigma0
373 print $fg "module $base$_\n";
377 print("novaboot: Created $builddir/$filename\n");
381 sub generate_syslinux_config($$$$)
383 my ($filename, $title, $base, $modules_ref) = @_;
384 if ($base && $base !~ /\/$/) { $base = "$base/"; };
385 open(my $fg, '>', $filename) or die "$filename: $!";
386 print $fg "LABEL $title\n";
387 #TODO print $fg "MENU LABEL $human_readable_title\n";
389 my ($kbin, $kcmd) = split(' ', @$modules_ref[0], 2);
391 if (system("file $kbin|grep 'Linux kernel'") == 0) {
392 my $initrd = @$modules_ref[1];
393 die('To many "load" lines for Linux kernel') if (scalar @$modules_ref > 2);
394 print $fg "LINUX $base$kbin\n";
395 print $fg "APPEND $kcmd\n";
396 print $fg "INITRD $base$initrd\n";
398 print $fg "KERNEL mboot.c32\n";
400 foreach (@$modules_ref) {
401 s|\brom://([^ ]*)|$rom_prefix$base$1|g; # Translate rom:// files - needed for vdisk parameter of sigma0
402 push @append, "$base$_";
403 print $fg "APPEND ".join(' --- ', @append)."\n";
406 #TODO print $fg "TEXT HELP\n";
407 #TODO print $fg "some help here\n";
408 #TODO print $fg "ENDTEXT\n";
410 print("novaboot: Created $builddir/$filename\n");
414 sub generate_grub2_config($$$$;$$)
416 my ($filename, $title, $base, $modules_ref, $preamble, $prolog) = @_;
417 if ($base && substr($base,-1,1) ne '/') { $base = "$base/"; };
418 open(my $fg, '>', $filename) or die "$filename: $!";
419 print $fg "$preamble\n" if $preamble;
420 $title ||= 'novaboot';
421 print $fg "menuentry $title {\n";
422 print $fg "$prolog\n" if $prolog;
424 foreach (@$modules_ref) {
427 my ($kbin, $kcmd) = split(' ', $_, 2);
428 $kcmd = '' if !defined $kcmd;
429 print $fg " multiboot ${base}$kbin $kcmd\n";
432 # GRUB2 doesn't pass filename in multiboot info so we have to duplicate it here
433 $_ = join(' ', ($args[0], @args));
434 s|\brom://|$rom_prefix|g; # We do not need to translate path for GRUB2
435 print $fg " module $base$_\n";
440 print("novaboot: Created $builddir/$filename\n");
444 sub generate_pulsar_config($$)
446 my ($filename, $modules_ref) = @_;
447 open(my $fg, '>', $filename) or die "$filename: $!";
448 print $fg "root $pulsar_root\n" if defined $pulsar_root;
451 foreach (@$modules_ref) {
454 ($kbin, $kcmd) = split(' ', $_, 2);
455 $kcmd = '' if !defined $kcmd;
458 s|\brom://|$rom_prefix|g;
459 print $fg "load $_\n";
462 # Put kernel as last - this is needed for booting Linux and has no influence on non-Linux OSes
463 print $fg "exec $kbin $kcmd\n";
465 print("novaboot: Created $builddir/$filename\n");
469 sub shell_cmd_string(@)
471 return join(' ', map((/^[-_=a-zA-Z0-9\/\.\+]+$/ ? "$_" : "'$_'"), @_));
476 print "novaboot: Running: ".shell_cmd_string(@_)."\n";
478 exit(1); # should not be reached
481 sub system_verbose($)
484 print "novaboot: Running: $cmd\n";
485 my $ret = system($cmd);
486 if ($ret & 0x007f) { die("Command terminated by a signal"); }
487 if ($ret & 0xff00) {die("Command exit with non-zero exit code"); }
488 if ($ret) { die("Command failure $ret"); }
493 if (exists $variables->{WVDESC}) {
494 print "Testing \"$variables->{WVDESC}\" in $last_fn:\n";
495 } elsif ($last_fn =~ /\.wv$/) {
496 print "Testing \"all\" in $last_fn:\n";
499 ## Connect to the target and check whether it is not occupied
501 # We have to do this before file generation phase, because file
502 # generation is intermixed with file deployment phase and we want to
503 # check whether the target is not used by somebody else before
504 # deploying files. Otherwise, we may rewrite other user's files on a
507 my $exp; # Expect object to communicate with the target over serial line
509 my ($target_reset, $target_power_on, $target_power_off);
511 if (defined $iprelay) {
513 $iprelay =~ /([.0-9]+)(:([0-9]+))?/;
516 my $paddr = sockaddr_in($port, inet_aton($addr));
517 my $proto = getprotobyname('tcp');
518 socket($IPRELAY, PF_INET, SOCK_STREAM, $proto) || die "socket: $!";
519 print "novaboot: Connecting to IP relay... ";
520 connect($IPRELAY, $paddr) || die "connect: $!";
522 $exp = Expect->init(\*$IPRELAY);
526 print $exp "\xFF\xF6"; # AYT
527 my $connected = $exp->expect(20, # Timeout in seconds
528 '<iprelayd: connected>',
529 '-re', '<WEB51 HW[^>]*>');
534 my ($relay, $onoff) = @_;
535 die unless ($relay == 1 || $relay == 2);
537 my $cmd = ($relay == 1 ? 0x5 : 0x6) | ($onoff ? 0x20 : 0x10);
538 return "\xFF\xFA\x2C\x32".chr($cmd)."\xFF\xF0";
542 my ($relay, $onoff) = @_;
543 die unless ($relay == 1 || $relay == 2);
544 my $cmd = ($relay == 1 ? 0xdf : 0xbf) | ($onoff ? 0x00 : 0xff);
545 return "\xFF\xFA\x2C\x97".chr($cmd)."\xFF\xF0";
549 my ($relay, $onoff, $can_giveup) = @_;
550 my $confirmation = '';
552 print $exp relaycmd($relay, $onoff);
553 my $confirmed = $exp->expect(20, # Timeout in seconds
554 relayconf($relay, $onoff));
557 print("Relay confirmation timeout - ignoring\n");
559 die "Relay confirmation timeout";
565 $target_reset = sub {
566 relay(2, 1, 1); # Reset the machine
571 $target_power_off = sub {
572 relay(1, 1); # Press power button
573 usleep(6000000); # Long press to switch off
577 $target_power_on = sub {
578 relay(1, 1); # Press power button
579 usleep(100000); # Short press
585 system_verbose("stty -F $serial $stty");
586 open($CONN, "+<", $serial) || die "open $serial: $!";
587 $exp = Expect->init(\*$CONN);
589 elsif ($remote_cmd) {
590 print "novaboot: Running: $remote_cmd\n";
591 $exp = Expect->spawn($remote_cmd);
593 elsif (defined $amt) {
594 require LWP::UserAgent;
595 require LWP::Authen::Digest;
598 my ($host, $username, $password, $schema, $className, $pstate) = @_;
599 #AMT numbers for PowerStateChange (MNI => bluescreen on windows;-)
600 my %pstates = ("on" => 2,
607 <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">
608 <s:Header><a:To>http://$host:16992/wsman</a:To>
609 <w:ResourceURI s:mustUnderstand="true">$schema</w:ResourceURI>
610 <a:ReplyTo><a:Address s:mustUnderstand="true">http://schemas.xmlsoap.org/ws/2004/08/addressing/role/anonymous</a:Address></a:ReplyTo>
611 <a:Action s:mustUnderstand="true">$schema$className</a:Action>
612 <w:MaxEnvelopeSize s:mustUnderstand="true">153600</w:MaxEnvelopeSize>
613 <a:MessageID>uuid:709072C9-609C-4B43-B301-075004043C7C</a:MessageID>
614 <w:Locale xml:lang="en-US" s:mustUnderstand="false" />
615 <w:OperationTimeout>PT60.000S</w:OperationTimeout>
616 <w:SelectorSet><w:Selector Name="Name">Intel(r) AMT Power Management Service</w:Selector></w:SelectorSet>
618 <p:RequestPowerStateChange_INPUT xmlns:p="http://schemas.dmtf.org/wbem/wscim/1/cim-schema/2/CIM_PowerManagementService">
619 <p:PowerState>$pstates{$pstate}</p:PowerState>
620 <p:ManagedElement><a:Address>http://$host:16992/wsman</a:Address>
621 <a:ReferenceParameters><w:ResourceURI>http://schemas.dmtf.org/wbem/wscim/1/cim-schema/2/CIM_ComputerSystem</w:ResourceURI>
622 <w:SelectorSet><w:Selector Name="Name">ManagedSystem</w:Selector></w:SelectorSet>
623 </a:ReferenceParameters></p:ManagedElement>
624 </p:RequestPowerStateChange_INPUT>
625 </s:Body></s:Envelope>
630 my ($host, $username, $password, $content) = @_;
632 my $ua = LWP::UserAgent->new();
633 $ua->agent("novaboot");
635 my $req = HTTP::Request->new(POST => "http://$host:16992/wsman");
636 my $res = $ua->request($req);
637 die ("Unexpected AMT response: " . $res->status_line) unless $res->code == 401;
639 my ($realm) = $res->header("WWW-Authenticate") =~ /Digest realm="(.*?)"/;
640 $ua->credentials("$host:16992", $realm, $username => $password);
643 $req = HTTP::Request->new(POST => "http://$host:16992/wsman");
644 $req->content_type('application/x-www-form-urlencoded');
645 $req->content($content);
646 $res = $ua->request($req);
647 die ("AMT power change request failed: " . $res->status_line) unless $res->is_success;
648 $res->content() =~ /<g:ReturnValue>(\d+)<\/g:ReturnValue>/;
653 my ($host, $username, $password, $pstate)=@_;
654 my $schema="http://schemas.dmtf.org/wbem/wscim/1/cim-schema/2/CIM_PowerManagementService";
655 my $className="/RequestPowerStateChange";
656 my $content = genXML($host, $username, $password ,$schema, $className, $pstate);
657 return sendPOST($host, $username, $password, $content);
660 my ($user,$amt_password,$host,$port) = ($amt =~ /(?:(.*?)(?::(.*))?@)?([^:]*)(?::([0-9]*))?/);;
662 $amt_password ||= $ENV{'AMT_PASSWORD'} || die "AMT password not specified";
663 $host || die "AMT host not specified";
666 $target_power_off = sub {
668 my $result = powerChange($host,$user,$amt_password, "off");
669 die "AMT power off failed (ReturnValue $result)" if $result != 0;
672 $target_power_on = sub {
673 my $result = powerChange($host,$user,$amt_password, "on");
674 die "AMT power on failed (ReturnValue $result)" if $result != 0;
677 $target_reset = sub {
678 my $result = powerChange($host,$user,$amt_password, "reset");
680 print STDERR "Warning: Cannot reset $host, trying power on. ";
681 $result = powerChange($host,$user,$amt_password, "on");
683 die "AMT reset failed (ReturnValue $result)" if $result != 0;
686 my $cmd = "amtterm -u $user -p $amt_password $host $port";
687 print "novaboot: Running: $cmd\n" =~ s/\Q$amt_password\E/???/r;
688 $exp = Expect->spawn($cmd);
689 $exp->expect(10, "RUN_SOL") || die "Expect for 'RUN_SOL' timed out";
692 if ($remote_expect) {
693 $exp->expect(10, $remote_expect) || die "Expect for '$remote_expect' timed out";
696 if (defined $reset_cmd) {
697 $target_reset = sub {
698 system_verbose($reset_cmd);
702 if (defined $on_opt && defined $target_power_on) {
706 if (defined $off_opt && defined $target_power_off) {
707 print "novaboot: Switching the target off...\n";
708 &$target_power_off();
712 $builddir ||= dirname(File::Spec->rel2abs( ${$scripts[0]}{filename})) if scalar @scripts;
713 if (defined $builddir) {
714 chdir($builddir) or die "Can't change directory to $builddir: $!";
715 print "novaboot: Entering directory `$builddir'\n";
718 ## File generation phase
719 my (%files_iso, $menu_iso, $filename);
720 my $config_name = '';
722 foreach my $script (@scripts) {
723 $filename = $$script{filename};
724 $modules = $$script{modules};
725 $generated = $$script{generated};
726 $variables = $$script{variables};
728 ($config_name = $filename) =~ s#.*/##;
729 $config_name = $config_name_opt if (defined $config_name_opt);
731 if (exists $variables->{BUILDDIR}) {
732 $builddir = File::Spec->rel2abs($variables->{BUILDDIR});
733 chdir($builddir) or die "Can't change directory to $builddir: $!";
734 print "novaboot: Entering directory `$builddir'\n";
738 ($prefix = $grub_prefix) =~ s/\$NAME/$config_name/ if defined $grub_prefix;
739 $prefix ||= $builddir;
740 # TODO: use $grub_prefix as first parameter if some switch is given
741 generate_configs('', $generated, $filename);
743 ### Generate bootloader configuration files
744 my @bootloader_configs;
745 push @bootloader_configs, generate_grub_config($grub_config, $config_name, $prefix, $modules, $grub_preamble) if (defined $grub_config);
746 push @bootloader_configs, generate_grub2_config($grub2_config, $config_name, $prefix, $modules, $grub_preamble, $grub2_prolog) if (defined $grub2_config);
747 push @bootloader_configs, generate_pulsar_config('config-'.($pulsar||'novaboot'), $modules) if (defined $pulsar);
749 ### Run scons or make
751 my @files = map({ ($file) = m/([^ ]*)/; $file; } @$modules);
752 # Filter-out generated files
753 my @to_build = grep({ my $file = $_; !scalar(grep($file eq ($$_{filename} || ''), @$generated)) } @files);
755 system_verbose($scons || $CFG::scons." ".join(" ", @to_build)) if (defined $scons);
756 system_verbose($make || $CFG::make ." ".join(" ", @to_build)) if (defined $make);
759 ### Copy files (using rsync)
760 if (defined $server && !defined($gen_only)) {
761 (my $real_server = $server) =~ s/\$NAME/$config_name/;
763 my ($hostname, $path) = split(":", $real_server, 2);
764 if (! defined $path) {
768 my $files = join(" ", map({ ($file) = m/([^ ]*)/; $file; } ( @$modules, @bootloader_configs)));
769 map({ my $file = (split)[0]; die "$file: $!" if ! -f $file; } @$modules);
770 my $istty = -t STDOUT && ($ENV{'TERM'} || 'dumb') ne 'dumb';
771 my $progress = $istty ? "--progress" : "";
772 system_verbose("rsync $progress -RLp $rsync_flags $files $real_server");
773 if ($server =~ m|/\$NAME$| && $concat) {
774 my $cmd = join("; ", map { "( cd $path/.. && cat */$_ > $_ )" } @bootloader_configs);
775 system_verbose($hostname ? "ssh $hostname '$cmd'" : $cmd);
779 ### Prepare ISO image generation
780 if (defined $iso_image) {
781 generate_configs("(cd)", $generated, $filename);
783 generate_syslinux_config(\$menu, $config_name, "/", $modules);
784 $menu_iso .= "$menu\n";
785 map { ($file,undef) = split; $files_iso{$file} = 1; } @$modules;
789 ## Generate ISO image
790 if (defined $iso_image) {
791 system_verbose("mkdir -p isolinux");
792 system_verbose('cp /usr/lib/syslinux/isolinux.bin /usr/lib/syslinux/mboot.c32 /usr/lib/syslinux/menu.c32 isolinux');
793 open(my $fh, ">isolinux/isolinux.cfg");
795 print $fh "TIMEOUT 50\n";
796 print $fh "DEFAULT menu\n";
798 print $fh "DEFAULT $config_name\n";
800 print $fh "$menu_iso";
803 my $files = join(" ", map("$_=$_", (keys(%files_iso), 'isolinux/isolinux.bin', 'isolinux/isolinux.cfg', 'isolinux/mboot.c32', 'isolinux/menu.c32')));
804 $iso_image ||= "$config_name.iso";
806 # Note: We use -U flag below to "Allow 'untranslated' filenames,
807 # completely violating the ISO9660 standards". Without this
808 # option, isolinux is not able to read files names for example
810 system_verbose("$CFG::genisoimage -R -b isolinux/isolinux.bin -c isolinux/boot.cat -no-emul-boot -boot-load-size 4 -boot-info-table -hide-rr-moved -U -o $iso_image -graft-points $files");
811 print("ISO image created: $builddir/$iso_image\n");
814 exit(0) if defined $gen_only;
816 ## Boot the system using various methods and send serial output to stdout
818 if (scalar(@scripts) > 1 && ( defined $dhcp_tftp || defined $serial || defined $iprelay)) {
819 die "You cannot do this with multiple scripts simultaneously";
822 if ($variables->{WVTEST_TIMEOUT}) {
823 print "wvtest: timeout ", $variables->{WVTEST_TIMEOUT}, "\n";
828 $str =~ s/^\s+|\s+$//g;
836 $qemu ||= $variables->{QEMU} || $CFG::qemu;
837 my @qemu_flags = split(" ", $qemu);
838 $qemu = shift(@qemu_flags);
840 @qemu_flags = split(/ +/, trim($variables->{QEMU_FLAGS})) if exists $variables->{QEMU_FLAGS};
841 @qemu_flags = split(/ +/, trim($qemu_flags_cmd)) if $qemu_flags_cmd;
842 push(@qemu_flags, split(/ +/, trim($qemu_append || '')));
844 if (defined $iso_image) {
845 # Boot NOVA with grub (and test the iso image)
846 push(@qemu_flags, ('-cdrom', $iso_image));
848 # Boot NOVA without GRUB
850 # Non-patched qemu doesn't like commas, but NUL can live with pluses instead of commans
851 foreach (@$modules) {s/,/+/g;}
852 generate_configs("", $generated, $filename);
854 if (scalar @$modules) {
855 my ($kbin, $kcmd) = split(' ', shift(@$modules), 2);
856 $kcmd = '' if !defined $kcmd;
858 @$modules = map { if (/\.dtb$/) { $dtb=$_; (); } else { $_ } } @$modules;
859 my $initrd = join ",", @$modules;
861 push(@qemu_flags, ('-kernel', $kbin, '-append', $kcmd));
862 push(@qemu_flags, ('-initrd', $initrd)) if $initrd;
863 push(@qemu_flags, ('-dtb', $dtb)) if $dtb;
866 push(@qemu_flags, qw(-serial stdio)); # Redirect serial output (for collecting test restuls)
867 unshift(@qemu_flags, ('-name', $config_name));
868 print "novaboot: Running: ".shell_cmd_string($qemu, @qemu_flags)."\n";
869 $exp = Expect->spawn(($qemu, @qemu_flags)) || die("exec() failed: $!");
872 ### Local DHCPD and TFTPD
874 my ($dhcpd_pid, $tftpd_pid);
876 if (defined $dhcp_tftp)
878 generate_configs("(nd)", $generated, $filename);
879 system_verbose('mkdir -p tftpboot');
880 generate_grub_config("tftpboot/os-menu.lst", $config_name, "(nd)", \@$modules, "timeout 0");
881 open(my $fh, '>', 'dhcpd.conf');
882 my $mac = `cat /sys/class/net/eth0/address`;
884 print $fh "subnet 10.23.23.0 netmask 255.255.255.0 {
885 range 10.23.23.10 10.23.23.100;
886 filename \"bin/boot/grub/pxegrub.pxe\";
887 next-server 10.23.23.1;
890 hardware ethernet $mac;
891 fixed-address 10.23.23.1;
894 system_verbose("sudo ip a add 10.23.23.1/24 dev eth0;
895 sudo ip l set dev eth0 up;
896 sudo touch dhcpd.leases");
898 # We run servers by forking ourselves, because the servers end up
899 # in our process group and get killed by signals sent to the
900 # process group (e.g. Ctrl-C on terminal).
902 exec_verbose("sudo dhcpd -d -cf dhcpd.conf -lf dhcpd.leases -pf dhcpd.pid") if ($dhcpd_pid == 0);
905 if (defined $dhcp_tftp || defined $tftp) {
906 system_verbose("sudo in.tftpd --listen --secure -v -v -v --pidfile tftpd.pid $builddir");
908 # Kill server when we die
909 $SIG{__DIE__} = sub { system_verbose('sudo pkill --pidfile=dhcpd.pid') if (defined $dhcp_tftp);
910 system_verbose('sudo pkill --pidfile=tftpd.pid'); };
912 # We have to kill tftpd explicitely, because it is not in our process group
913 $SIG{INT} = sub { system_verbose('sudo pkill --pidfile=tftpd.pid'); exit(0); };
916 ### Reset target (IP relay, AMT, ...)
918 if (defined $target_reset) {
919 print "novaboot: Reseting the test box... ";
924 ### U-boot conversation
925 if (defined $uboot) {
926 my $uboot_prompt = $uboot || '=> ';
927 print "novaboot: Waiting for uBoot prompt...\n";
929 #$exp->exp_internal(1);
931 [qr/Hit any key to stop autoboot:/, sub { $exp->send("\n"); exp_continue; }],
932 $uboot_prompt) || die "No uBoot prompt deteceted";
933 while (@uboot_init) {
934 my $cmd = shift @uboot_init;
935 $exp->send("$cmd\n");
936 $exp->expect(10, $uboot_prompt) || die "uBoot prompt timeout";
939 # Boot the system if there are some load lines in the script
940 if (scalar(@$modules) > 0) {
941 my ($kbin, $kcmd) = split(' ', shift(@$modules), 2);
943 @$modules = map { if (/\.dtb$/) { $dtb=$_; (); } else { $_ } } @$modules;
944 my $initrd = shift @$modules;
946 my $kern_addr = '800000';
947 my $initrd_addr = '-';
950 $exp->send("tftp $kern_addr $kbin\n");
952 [qr/#/, sub { exp_continue; }],
953 $uboot_prompt) || die "Kernel load failed";
955 $dtb_addr = '7f0000';
956 $exp->send("tftp $dtb_addr $dtb\n");
958 [qr/#/, sub { exp_continue; }],
959 $uboot_prompt) || die "Device tree load failed";
961 if (defined $initrd) {
962 $initrd_addr = 'b00000';
963 $exp->send("tftp $initrd_addr $initrd\n");
965 [qr/#/, sub { exp_continue; }],
966 $uboot_prompt) || die "Initrd load failed";
968 $exp->send("set bootargs '$kcmd'\n");
969 $exp->expect(5, $uboot_prompt) || die "uBoot prompt timeout";
970 $exp->send("bootm $kern_addr $initrd_addr $dtb_addr\n");
971 $exp->expect(5, "\n") || die "uBoot command timeout";
975 ### Serial line interaction
977 # Serial line of the target is available
978 my $interrupt = 'Ctrl-C';
979 if ($interactive && !@exiton) {
980 $interrupt = '"~~."';
982 my $note = (-t STDIN) ? '' : '- only target->host ';
983 print "novaboot: Serial line interaction $note(press $interrupt to interrupt)...\n";
986 $exp->expect(undef, @expect_raw, @exiton);
989 if (-t STDIN) { # Set up bi-directional communication if we run on terminal
990 my $infile = new IO::File;
991 $infile->IO::File::fdopen(*STDIN,'r');
992 my $in_object = Expect->exp_init($infile);
993 $in_object->set_group($exp);
996 $in_object->set_seq('~~\.', sub { print "novaboot: Escape sequence detected\r\n"; undef; });
997 $in_object->manual_stty(0); # Use raw terminal mode
999 $in_object->manual_stty(1); # Do not modify terminal settings
1001 push(@inputs, $in_object);
1004 #print Dumper(\@expect_raw);
1005 $exp->expect(undef, @expect_raw) if @expect_raw;
1006 Expect::interconnect(@inputs) unless defined($exp->exitstatus);
1010 ## Kill dhcpc or tftpd
1011 if (defined $dhcp_tftp || defined $tftp) {
1012 die("novaboot: This should kill servers on background\n");
1019 novaboot - A tool for booting various operating systems on various hardware or in qemu
1025 B<novaboot> [option]... [--] script...
1027 B<./script> [option]...
1031 This program makes booting of an operating system (e.g. NOVA or Linux)
1032 as simple as running a local program. It facilitates booting on local
1033 or remote hosts or in emulators such as qemu. Novaboot operation is
1034 controlled by command line options and by a so called novaboot script,
1035 which can be thought as a generalization of bootloader configuration
1036 files (see L</"NOVABOOT SCRIPT SYNTAX">). Based on this input,
1037 novaboot setups everything for the target host to boot the desired
1038 configuration, i.e. it generates the bootloader configuration file in
1039 the proper format, deploy the binaries and other needed files to
1040 required locations, perhaps on a remote boot server and reset the
1041 target host. Finally, target host's serial output is redirected to
1042 standard output if that is possible.
1044 Typical way of using novaboot is to make the novaboot script
1045 executable and set its first line to I<#!/usr/bin/env novaboot>. Then,
1046 booting a particular OS configuration becomes the same as executing a
1047 local program - the novaboot script.
1049 For example, with C<novaboot> you can:
1055 Run an OS in Qemu. This is the default action when no other action is
1056 specified by command line switches. Thus running C<novaboot ./script>
1057 (or C<./script> as described above) will run Qemu and make it boot the
1058 configuration specified in the F<script>.
1062 Create a bootloader configuration file (currently supported
1063 bootloaders are GRUB, GRUB2, Pulsar and U-Boot) and copy it with all
1064 other files needed for booting to a remote boot server.
1066 ./script --server=192.168.1.1:/tftp --iprelay=192.168.1.2
1068 This command copies files to the TFTP server and uses
1069 TCP/IP-controlled relay to reset the target host and receive its
1074 Run DHCP and TFTP server on developer's machine to PXE-boot the target
1077 ./script --dhcp-tftp
1079 When a PXE-bootable machine is connected via Ethernet to developer's
1080 machine, it will boot the configuration described in I<script>.
1084 Create bootable ISO images. E.g.
1086 novaboot --iso -- script1 script2
1088 The created ISO image will have GRUB bootloader installed on it and
1089 the boot menu will allow selecting between I<script1> and I<script2>
1094 Note that the options needed for a specific target can be stored in a
1095 L</"CONFIGURATION FILE">. Then it is sufficient to use only the B<-t>
1096 option to specify the name of the target.
1098 =head1 PHASES AND OPTIONS
1100 Novaboot performs its work in several phases. Each phase can be
1101 influenced by several options, certain phases can be skipped. The list
1102 of phases (in the execution order) and the corresponding options
1105 =head2 Configuration reading phase
1107 After starting, novaboot reads configuration files. By default, it
1108 searches for files named F<.novaboot> starting from the directory of
1109 the novaboot script (or working directory, see bellow) and continuing
1110 upwards up to the root directory. The configuration files are read in
1111 order from the root directory downwards with latter files overriding
1112 settings from the former ones.
1114 In certain cases, the location of the novaboot script cannot be
1115 determined in this early phase. This happens either when the script is
1116 read from the standard input or when novaboot is invoked explicitly
1117 and options precede the script name, as in the example L</"4."> above.
1118 In this case the current working directory is used as a starting point
1119 for configuration file search.
1123 =item -c, --config=I<filename>
1125 Use the specified configuration file instead of the default one(s).
1129 =head2 Command line processing phase
1135 Dump the current configuration to stdout end exits. Useful as an
1136 initial template for a configuration file.
1140 Print short (B<-h>) or long (B<--help>) help.
1142 =item -t, --target=I<target>
1144 This option serves as a user configurable shortcut for other novaboot
1145 options. The effect of this option is the same as the options stored
1146 in the C<%targets> configuration variable under key I<target>. See
1147 also L</"CONFIGURATION FILE">.
1151 =head2 Script preprocessing phase
1153 This phases allows to modify the parsed novaboot script before it is
1154 used in the later phases.
1158 =item -a, --append=I<parameters>
1160 Append a string to the first C<load> line in the novaboot script. This
1161 can be used to append parameters to the kernel's or root task's
1162 command line. Can appear multiple times.
1166 Use F<bender> chainloader. Bender scans the PCI bus for PCI serial
1167 ports and stores the information about them in the BIOS data area for
1170 =item --chainloader=I<chainloader>
1172 Chainloader that is loaded before the kernel and other files specified
1173 in the novaboot script. E.g. 'bin/boot/bender promisc'.
1177 Print the modules to boot and their parameters after this phase
1178 finishes. Then exit. This is useful for seeing the effect of other
1179 options in this section.
1181 =item -k, --kernel=F<file>
1183 Replace the first word on the first C<load> line in the novaboot
1184 script with F<file>.
1186 =item --scriptmod=I<perl expression>
1188 When novaboot script is read, I<perl expression> is executed for every
1189 line (in $_ variable). For example, C<novaboot
1190 --scriptmod=s/sigma0/omega6/g> replaces every occurrence of I<sigma0>
1191 in the script with I<omega6>.
1193 When this option is present, it overrides I<$script_modifier> variable
1194 from the configuration file, which has the same effect. If this option
1195 is given multiple times all expressions are evaluated in the command
1200 =head2 File generation phase
1202 In this phase, files needed for booting are generated in a so called
1203 I<build directory> (see L</--build-dir>). In most cases configuration
1204 for a bootloader is generated automatically by novaboot. It is also
1205 possible to generate other files using I<heredoc> or I<"<"> syntax in
1206 novaboot scripts. Finally, binaries can be generated in this phases by
1207 running C<scons> or C<make>.
1211 =item --build-dir=I<directory>
1213 Overrides the default build directory location.
1215 The default build directory location is determined as follows: If the
1216 configuration file defines the C<$builddir> variable, its value is
1217 used. Otherwise, it is the directory that contains the first processed
1220 See also L</BUILDDIR> variable.
1222 =item -g, --grub[=I<filename>]
1224 Generates grub bootloader menu file. If the I<filename> is not
1225 specified, F<menu.lst> is used. The I<filename> is relative to the
1226 build directory (see B<--build-dir>).
1228 =item --grub-preamble=I<prefix>
1230 Specifies the I<preable> that is at the beginning of the generated
1231 GRUB or GRUB2 config files. This is useful for specifying GRUB's
1234 =item --grub-prefix=I<prefix>
1236 Specifies I<prefix> that is put in front of every file name in GRUB's
1237 F<menu.lst>. The default value is the absolute path to the build directory.
1239 If the I<prefix> contains string $NAME, it will be replaced with the
1240 name of the novaboot script (see also B<--name>).
1242 =item --grub2[=I<filename>]
1244 Generate GRUB2 menuentry in I<filename>. If I<filename> is not
1245 specified F<grub.cfg> is used. The content of the menuentry can be
1246 customized with B<--grub-preable>, B<--grub2-prolog> or
1247 B<--grub_prefix> options.
1249 In order to use the the generated menuentry on your development
1250 machine that uses GRUB2, append the following snippet to
1251 F</etc/grub.d/40_custom> file and regenerate your grub configuration,
1252 i.e. run update-grub on Debian/Ubuntu.
1254 if [ -f /path/to/nul/build/grub.cfg ]; then
1255 source /path/to/nul/build/grub.cfg
1258 =item --grub2-prolog=I<prolog>
1260 Specifies text I<preable> that is put at the beginning of the entry
1263 =item -m, --make[=make command]
1265 Runs C<make> to build files that are not generated by novaboot itself.
1267 =item --name=I<string>
1269 Use the name I<string> instead of the name of the novaboot script.
1270 This name is used for things like a title of grub menu or for the
1271 server directory where the boot files are copied to.
1275 Do not run external commands to generate files (i.e. "<" syntax and
1276 C<run> keyword). This switch does not influence generation of files
1277 specified with "<<WORD" syntax.
1279 =item -p, --pulsar[=mac]
1281 Generates pulsar bootloader configuration file named F<config-I<mac>>
1282 The I<mac> string is typically a MAC address and defaults to
1285 =item --scons[=scons command]
1287 Runs C<scons> to build files that are not generated by novaboot
1292 Strip I<rom://> prefix from command lines and generated config files.
1293 The I<rom://> prefix is used by NUL. For NRE, it has to be stripped.
1297 Exit novaboot after file generation phase.
1301 =head2 Target connection check
1303 If supported by the target, the connection to it is made and it is
1304 checked whether the target is not occupied by another novaboot
1309 =item --amt=I<"[user[:password]@]host[:port]>
1311 Use Intel AMT technology to control the target machine. WS management
1312 is used to powercycle it and Serial-Over-Lan (SOL) for input/output.
1313 The hostname or (IP address) is given by the I<host> parameter. If
1314 I<password> is not specified, environment variable AMT_PASSWORD is
1315 used. The I<port> specifies a TCP port for SOL. If not specified, the
1316 default is 16992. Default I<user> is admin.
1318 =item --iprelay=I<addr[:port]>
1320 Use TCP/IP relay and serial port to access the target's serial port
1321 and powercycle it. The IP address of the relay is given by I<addr>
1322 parameter. If I<port> is not specified, it default to 23.
1324 Note: This option is supposed to work with HWG-ER02a IP relays.
1326 =item -s, --serial[=device]
1328 Target's serial line is connected to host's serial line (device). The
1329 default value for device is F</dev/ttyUSB0>.
1331 The value of this option is exported in NB_NOVABOOT environment
1332 variable to all subprocesses run by C<novaboot>.
1334 =item --stty=I<settings>
1336 Specifies settings passed to C<stty> invoked on the serial line
1337 specified with B<--serial> option. If this option is not given,
1338 C<stty> is called with C<raw -crtscts -onlcr 115200> settings.
1340 =item --remote-cmd=I<cmd>
1342 Command that mediates connection to the target's serial line. For
1343 example C<ssh server 'cu -l /dev/ttyS0'>.
1345 =item --remote-expect=I<string>
1347 Wait for reception of I<string> after establishing the the remote
1348 connection before continuing.
1353 =head2 File deployment phase
1355 In some setups, it is necessary to copy the files needed for booting
1356 to a particular location, e.g. to a TFTP boot server or to the
1361 =item -d, --dhcp-tftp
1363 Turns your workstation into a DHCP and TFTP server so that the OS can
1364 be booted via PXE BIOS (or similar mechanism) on the test machine
1365 directly connected by a plain Ethernet cable to your workstation.
1367 The DHCP and TFTP servers require root privileges and C<novaboot>
1368 uses C<sudo> command to obtain those. You can put the following to
1369 I</etc/sudoers> to allow running the necessary commands without
1370 asking for password.
1372 Cmnd_Alias NOVABOOT = /bin/ip a add 10.23.23.1/24 dev eth0, /bin/ip l set dev eth0 up, /usr/sbin/dhcpd -d -cf dhcpd.conf -lf dhcpd.leases -pf dhcpd.pid, /usr/sbin/in.tftpd --listen --secure -v -v -v --pidfile tftpd.pid *, /usr/bin/touch dhcpd.leases, /usr/bin/pkill --pidfile=dhcpd.pid, /usr/bin/pkill --pidfile=tftpd.pid
1373 your_login ALL=NOPASSWD: NOVABOOT
1377 Starts a TFTP server on your workstation. This is similar to
1378 B<--dhcp-tftp> except that DHCP server is not started.
1380 The TFTP server require root privileges in order to listen on TFTP
1381 port and C<novaboot> uses C<sudo> command to obtain those. You can put
1382 the following to I</etc/sudoers> to allow running the necessary
1383 commands without asking for password.
1385 Cmnd_Alias NOVABOOT = /usr/sbin/in.tftpd --listen --secure -v -v -v --pidfile tftpd.pid *, /usr/bin/pkill --pidfile=tftpd.pid
1386 your_login ALL=NOPASSWD: NOVABOOT
1388 =item --iso[=filename]
1390 Generates the ISO image that boots NOVA system via GRUB. If no filename
1391 is given, the image is stored under I<NAME>.iso, where I<NAME> is the name
1392 of the novaboot script (see also B<--name>).
1394 =item --server[=[[user@]server:]path]
1396 Copy all files needed for booting to another location (implies B<-g>
1397 unless B<--grub2> is given). The files will be copied (by B<rsync>
1398 tool) to the directory I<path>. If the I<path> contains string $NAME,
1399 it will be replaced with the name of the novaboot script (see also
1404 If B<--server> is used and its value ends with $NAME, then after
1405 copying the files, a new bootloader configuration file (e.g. menu.lst)
1406 is created at I<path-wo-name>, i.e. the path specified by B<--server>
1407 with $NAME part removed. The content of the file is created by
1408 concatenating all files of the same name from all subdirectories of
1409 I<path-wo-name> found on the "server".
1411 =item --rsync-flags=I<flags>
1413 Specifies which I<flags> are appended to F<rsync> command line when
1414 copying files as a result of I<--server> option.
1418 =head2 Target power-on and reset phase
1424 Switch on/off the target machine and exit. The script (if any) is
1425 completely ignored. Currently it works only with B<--iprelay> or
1428 =item -Q, --qemu[=I<qemu-binary>]
1430 Boot the configuration in qemu. Optionally, the name of qemu binary
1431 can be specified as a parameter.
1433 =item --qemu-append=I<flags>
1435 Append I<flags> to the default qemu flags (QEMU_FLAGS variable or
1436 C<-cpu coreduo -smp 2>).
1438 =item -q, --qemu-flags=I<flags>
1440 Replace the default qemu flags (QEMU_FLAGS variable or C<-cpu coreduo
1441 -smp 2>) with I<flags> specified here.
1443 =item --reset-cmd=I<cmd>
1445 Command that resets the target.
1449 =head2 Interaction with the bootloader on the target
1453 =item --uboot[=I<prompt>]
1455 Interact with uBoot bootloader to boot the thing described in the
1456 novaboot script. I<prompt> specifies the U-Boot's prompt (default is
1457 "=> ", other common prompts are "U-Boot> " or "U-Boot# ").
1458 Implementation of this option is currently tied to a particular board
1459 that we use. It may be subject to changes in the future!
1463 Command(s) to send the U-Boot bootloader before loading the images and
1464 booting them. This option can be given multiple times. After sending
1465 commands from each option novaboot waits for U-Boot I<prompt>.
1469 =head2 Target interaction phase
1471 In this phase, target's serial output is redirected to stdout and if
1472 stdin is a TTY, it is redirected to the target's serial input allowing
1473 interactive work with the target.
1477 =item --exiton=I<string>
1479 When I<string> is sent by the target, novaboot exits. This option can
1480 be specified multiple times.
1482 If I<string> is C<-re>, then the next B<--exiton>'s I<string> is
1483 treated as regular expression. For example:
1485 --exiton -re --exiton 'error:.*failed'
1487 =item -i, --interactive
1489 Setup things for interactive use of target. Your terminal will be
1490 switched to raw mode. In raw mode, your system does not process input
1491 in any way (no echoing of entered characters, no interpretation
1492 special characters). This, among others, means that Ctrl-C is passed
1493 to the target and does no longer interrupt novaboot. Use "~~."
1494 sequence to exit novaboot.
1496 =item --expect=I<string>
1498 When I<string> is received from the target, send the string specified
1499 with the subsequent B<--send*> option to the target.
1501 =item --expect-re=I<regex>
1503 When target's output matches regular expression I<regex>, send the
1504 string specified with the subsequent B<--send*> option to the target.
1506 =item --expect-raw=I<perl-code>
1508 Provides direct control over Perl's Expect module.
1510 =item --send=I<string>
1512 Send I<string> to the target after the previously specified
1513 B<--expect*> was matched in the target's output. The I<string> may
1514 contain escape sequences such as "\n".
1516 Note that I<string> is actually interpreted by Perl, so it can contain
1517 much more that escape sequences. This behavior may change in the
1520 Example: C<--expect='login: ' --send='root\n'>
1522 =item --sendcont=I<string>
1524 Similar to B<--send> but continue expecting more input.
1526 Example: C<--expect='Continue?' --sendcont='yes\n'>
1530 =head1 NOVABOOT SCRIPT SYNTAX
1532 The syntax tries to mimic POSIX shell syntax. The syntax is defined
1533 with the following rules.
1535 Lines starting with "#" and empty lines are ignored.
1537 Lines that end with "\" are concatenated with the following line after
1538 removal of the final "\" and leading whitespace of the following line.
1540 Lines of the form I<VARIABLE=...> (i.e. matching '^[A-Z_]+=' regular
1541 expression) assign values to internal variables. See L</VARIABLES>
1544 Lines starting with C<load> keyword represent modules to boot. The
1545 word after C<load> is a file name (relative to the build directory
1546 (see B<--build-dir>) of the module to load and the remaining words are
1547 passed to it as the command line parameters.
1549 When the C<load> line ends with "<<WORD" then the subsequent lines
1550 until the line containing solely WORD are copied literally to the file
1551 named on that line. This is similar to shell's heredoc feature.
1553 When the C<load> line ends with "< CMD" then command CMD is executed
1554 with F</bin/sh> and its standard output is stored in the file named on
1555 that line. The SRCDIR variable in CMD's environment is set to the
1556 absolute path of the directory containing the interpreted novaboot
1559 Lines starting with C<run> keyword contain shell commands that are run
1560 during file generation phase. This is the same as the "< CMD" syntax
1561 for C<load> keyboard except that the command's output is not
1562 redirected to a file. The ordering of commands is the same as they
1563 appear in the novaboot script.
1567 #!/usr/bin/env novaboot
1568 load bzImage console=ttyS0,115200
1569 run make -C buildroot
1570 load rootfs.cpio < gen_cpio buildroot/images/rootfs.cpio "myapp->/etc/init.d/S99myapp"
1572 Example (NOVA User Land - NUL):
1574 #!/usr/bin/env novaboot
1575 WVDESC=Example program
1576 load bin/apps/sigma0.nul S0_DEFAULT script_start:1,1 \
1577 verbose hostkeyb:0,0x60,1,12,2
1578 load bin/apps/hello.nul
1579 load hello.nulconfig <<EOF
1580 sigma0::mem:16 name::/s0/log name::/s0/timer name::/s0/fs/rom ||
1581 rom://bin/apps/hello.nul
1584 This example will load three modules: F<sigma0.nul>, F<hello.nul> and
1585 F<hello.nulconfig>. sigma0 receives some command line parameters and
1586 F<hello.nulconfig> file is generated on the fly from the lines between
1587 C<<<EOF> and C<EOF>.
1591 The following variables are interpreted in the novaboot script:
1597 Novaboot chdir()s to this directory before file generation phase. The
1598 directory name specified here is relative to the build directory
1599 specified by other means (see L</--build-dir>).
1603 Assigning this variable has the same effect as specifying L</--exiton>
1606 =item HYPERVISOR_PARAMS
1608 Parameters passed to hypervisor. The default value is "serial", unless
1609 overridden in configuration file.
1613 The kernel to use instead of the hypervisor specified in the
1614 configuration file with the C<$hypervisor> variable. The value should
1615 contain the name of the kernel image as well as its command line
1616 parameters. If this variable is defined and non-empty, the variable
1617 HYPERVISOR_PARAMS is not used.
1621 Use a specific qemu binary (can be overridden with B<-Q>) and flags
1622 when booting this script under qemu. If QEMU_FLAGS variable is also
1623 specified flags specified in QEMU variable are replaced by those in
1628 Use specific qemu flags (can be overridden with B<-q>).
1632 Description of the wvtest-compliant program.
1634 =item WVTEST_TIMEOUT
1636 The timeout in seconds for WvTest harness. If no complete line appears
1637 in the test output within the time specified here, the test fails. It
1638 is necessary to specify this for long running tests that produce no
1639 intermediate output.
1643 =head1 CONFIGURATION FILE
1645 Novaboot can read its configuration from one or more files. By
1646 default, novaboot looks for files named F<.novaboot> as described in
1647 L</Configuration reading phase>. Alternatively, its location can be
1648 specified with the B<-c> switch or with the NOVABOOT_CONFIG
1649 environment variable. The configuration file has perl syntax and
1650 should set values of certain Perl variables. The current configuration
1651 can be dumped with the B<--dump-config> switch. Some configuration
1652 variables can be overridden by environment variables (see below) or by
1653 command line switches.
1655 Supported configuration variables include:
1661 Build directory location relative to the location of the configuration
1664 =item $default_target
1666 Default target (see below) to use when no target is explicitly
1667 specified on command line with the B<--target> option.
1671 Hash of shortcuts to be used with the B<--target> option. If the hash
1672 contains, for instance, the following pair of values
1674 'mybox' => '--server=boot:/tftproot --serial=/dev/ttyUSB0 --grub',
1676 then the following two commands are equivalent:
1678 ./script --server=boot:/tftproot --serial=/dev/ttyUSB0 --grub
1683 =head1 ENVIRONMENT VARIABLES
1685 Some options can be specified not only via config file or command line
1686 but also through environment variables. Environment variables override
1687 the values from configuration file and command line parameters
1688 override the environment variables.
1692 =item NOVABOOT_CONFIG
1694 Name of the novaboot configuration file to use instead of the default
1697 =item NOVABOOT_BENDER
1699 Defining this variable has the same meaning as B<--bender> option.
1705 Michal Sojka <sojka@os.inf.tu-dresden.de>