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 GetOptionsFromArray);
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]);
91 @cfgs = reverse @cfgs;
92 $dir = $ENV{'NOVABOOT_CONFIG_DIR'} || '/etc/novaboot.d';
93 if (opendir(my $dh, $dir)) {
94 my @etccfg = map { "$dir/$_" } grep { /^[-_a-zA-Z0-9]+$/ && -f "$dir/$_" } readdir($dh);
96 @etccfg = sort(@etccfg);
97 @cfgs = ( @etccfg, @cfgs );
100 my $cfg = $ENV{'NOVABOOT_CONFIG'};
101 Getopt::Long::Configure(qw/no_ignore_case pass_through/);
102 GetOptions ("config|c=s" => \$cfg);
103 read_config($_) foreach $cfg or @cfgs;
105 ## Command line handling
108 GetOptions ("target|t=s" => \$explicit_target);
110 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, $ider, $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, $tftp_port, $uboot, @uboot_init);
113 $rom_prefix = 'rom://';
114 $stty = 'raw -crtscts -onlcr 115200';
116 my @expect_seen = ();
120 push(@expect_seen, '-re') if $n eq "expect-re";
121 push(@expect_seen, $v);
127 unless (@expect_seen) { die("No --expect before --send"); }
128 my $ret = ($n eq "sendcont") ? exp_continue : 0;
129 unshift(@expect_raw, sub { shift->send(eval("\"$v\"")); $ret; });
130 unshift(@expect_raw, @expect_seen);
137 "append|a=s" => \@append,
138 "bender|b" => \$bender,
139 "build-dir=s" => sub { my ($n, $v) = @_; $builddir = File::Spec->rel2abs($v); },
140 "concat" => \$concat,
141 "chainloader=s" => \@chainloaders,
142 "dhcp-tftp|d" => \$dhcp_tftp,
143 "dump" => \$dump_opt,
144 "dump-config" => \$dump_config,
145 "exiton=s" => \@exiton,
146 "expect=s" => \&handle_expect,
147 "expect-re=s" => \&handle_expect,
148 "expect-raw=s" => sub { my ($n, $v) = @_; unshift(@expect_raw, eval($v)); },
149 "gen-only" => \$gen_only,
150 "grub|g:s" => \$grub_config,
151 "grub-preamble=s"=> \$grub_preamble,
152 "grub-prefix=s" => \$grub_prefix,
153 "grub2:s" => \$grub2_config,
154 "grub2-prolog=s" => \$grub2_prolog,
156 "iprelay=s" => \$iprelay,
157 "iso:s" => \$iso_image,
158 "kernel|k=s" => \$kernel_opt,
159 "interactive|i" => \$interactive,
160 "name=s" => \$config_name_opt,
161 "make|m:s" => \$make,
162 "no-file-gen" => \$no_file_gen,
165 "pulsar|p:s" => \$pulsar,
166 "pulsar-root=s" => \$pulsar_root,
167 "qemu|Q:s" => \$qemu,
168 "qemu-append=s" => \$qemu_append,
169 "qemu-flags|q=s" => \$qemu_flags_cmd,
170 "remote-cmd=s" => \$remote_cmd,
171 "remote-expect=s"=> \$remote_expect,
172 "reset-cmd=s" => \$reset_cmd,
173 "rsync-flags=s" => \$rsync_flags,
174 "scons:s" => \$scons,
175 "scriptmod=s" => \@scriptmod,
176 "send=s" => \&handle_send,
177 "sendcont=s" => \&handle_send,
178 "serial|s:s" => \$serial,
179 "server:s" => \$server,
180 "strip-rom" => sub { $rom_prefix = ''; },
183 "tftp-port=i" => \$tftp_port,
184 "uboot:s" => \$uboot,
185 "uboot-init=s" => \@uboot_init,
190 # First process target options
192 my $t = defined($explicit_target) ? $explicit_target : $CFG::default_target;
194 Getopt::Long::Configure(qw/no_ignore_case pass_through/);
196 exists $CFG::targets{$t} or die("Unknown target '$t' (valid targets are: ".join(", ", sort keys(%CFG::targets)).")");
198 undef $explicit_target;
199 my ($ret, $remaining_args) = GetOptionsFromString ($CFG::targets{$t}, ("target|t=s" => \$explicit_target));
200 if (!$ret) { die "Error parsing target $t option"; }
201 push(@target_expanded, @$remaining_args);
202 $t = $explicit_target;
204 Getopt::Long::Configure(qw/no_ignore_case no_pass_through/);
205 GetOptionsFromArray(\@target_expanded, %opt_spec) or die ("Error in target definition");
208 # Then process other command line options - some of them may override
209 # what was specified by the target
210 GetOptions %opt_spec or die("Error in command line arguments");
211 pod2usage(1) if $help;
212 pod2usage(-exitstatus => 0, -verbose => 2) if $man;
214 ### Dump sanitized configuration (if requested)
218 $Data::Dumper::Indent=1;
219 print "# This file is in perl syntax.\n";
220 foreach my $key(sort(keys(%CFG::))) { # See "Symbol Tables" in perlmod(1)
221 if (defined ${$CFG::{$key}}) { print Data::Dumper->Dump([${$CFG::{$key}}], ["*$key"]); }
222 if ( @{$CFG::{$key}}) { print Data::Dumper->Dump([\@{$CFG::{$key}}], ["*$key"]); }
223 if ( %{$CFG::{$key}}) { print Data::Dumper->Dump([\%{$CFG::{$key}}], ["*$key"]); }
229 ### Sanitize configuration
231 if ($interactive && !-t STDIN) {
232 die("novaboot: Interactive mode not supported when not on terminal");
235 if (defined $config_name_opt && scalar(@ARGV) > 1) { die "You cannot use --name with multiple scripts"; }
238 $iso_image //= ''; # IDE-R needs an ISO image
239 if (!defined $amt) { die "Error: --ider requires --amt"; }
243 if (defined $serial) {
244 $serial ||= "/dev/ttyUSB0";
245 $ENV{NB_SERIAL} = $serial;
247 if (defined $grub_config) { $grub_config ||= "menu.lst"; }
248 if (defined $grub2_config) { $grub2_config ||= "grub.cfg"; }
250 ## Parse the novaboot script(s)
255 my ($modules, $variables, $generated, $continuation);
256 my $skip_reading = defined($on_opt) || defined($off_opt);
257 while (!$skip_reading && ($_ = <>)) {
258 if ($ARGV ne $last_fn) { # New script
259 die "Missing EOF in $last_fn" if $file;
260 die "Unfinished line in $last_fn" if $continuation;
262 push @scripts, { 'filename' => $ARGV,
263 'modules' => $modules = [],
264 'variables' => $variables = {},
265 'generated' => $generated = []};
269 next if /^#/ || /^\s*$/; # Skip comments and empty lines
271 $_ =~ s/^[[:space:]]*// if ($continuation);
273 if (/\\$/) { # Line continuation
274 $continuation .= substr($_, 0, length($_)-1);
278 if ($continuation) { # Last continuation line
279 $_ = $continuation . $_;
283 foreach my $mod(@scriptmod) { eval $mod; }
285 if ($file && $_ eq $EOF) { # Heredoc end
289 if ($file) { # Heredoc content
290 push @{$file}, "$_\n";
293 if (/^([A-Z_]+)=(.*)$/) { # Internal variable
294 $$variables{$1} = $2;
295 push(@exiton, $2) if ($1 eq "EXITON");
298 if (s/^load *//) { # Load line
299 die("novaboot: '$last_fn' line $.: Missing file name\n") unless /^[^ <]+/;
300 if (/^([^ ]*)(.*?)[[:space:]]*<<([^ ]*)$/) { # Heredoc start
301 push @$modules, "$1$2";
303 push @$generated, {filename => $1, content => $file};
307 if (/^([^ ]*)(.*?)[[:space:]]*< ?(.*)$/) { # Command substitution
308 push @$modules, "$1$2";
309 push @$generated, {filename => $1, command => $3};
315 if (/^run (.*)/) { # run line
316 push @$generated, {command => $1};
320 die("novaboot: Cannot parse script '$last_fn' line $.. Didn't you forget 'load' keyword?\n");
323 # print Dumper(\@scripts);
325 foreach my $script (@scripts) {
326 $modules = $$script{modules};
327 @$modules[0] =~ s/^[^ ]*/$kernel_opt/ if $kernel_opt;
328 @$modules[0] .= ' ' . join(' ', @append) if @append;
331 if (exists $variables->{KERNEL}) {
332 $kernel = $variables->{KERNEL};
334 if ($CFG::hypervisor) {
335 $kernel = $CFG::hypervisor . " ";
336 if (exists $variables->{HYPERVISOR_PARAMS}) {
337 $kernel .= $variables->{HYPERVISOR_PARAMS};
339 $kernel .= $CFG::hypervisor_params;
343 @$modules = ($kernel, @$modules) if $kernel;
344 @$modules = (@chainloaders, @$modules);
345 @$modules = ("bin/boot/bender", @$modules) if ($bender || defined $ENV{'NOVABOOT_BENDER'});
349 foreach my $script (@scripts) {
350 print join("\n", @{$$script{modules}})."\n";
357 sub generate_configs($$$) {
358 my ($base, $generated, $filename) = @_;
359 if ($base) { $base = "$base/"; };
360 foreach my $g(@$generated) {
361 if (exists $$g{content}) {
362 my $config = $$g{content};
363 my $fn = $$g{filename};
364 open(my $f, '>', $fn) || die("$fn: $!");
365 map { s|\brom://([^ ]*)|$rom_prefix$base$1|g; print $f "$_"; } @{$config};
367 print "novaboot: Created $fn\n";
368 } elsif (exists $$g{command} && ! $no_file_gen) {
369 $ENV{SRCDIR} = dirname(File::Spec->rel2abs( $filename, $invocation_dir ));
370 if (exists $$g{filename}) {
371 system_verbose("( $$g{command} ) > $$g{filename}");
373 system_verbose($$g{command});
379 sub generate_grub_config($$$$;$)
381 my ($filename, $title, $base, $modules_ref, $preamble) = @_;
382 if ($base) { $base = "$base/"; };
383 open(my $fg, '>', $filename) or die "$filename: $!";
384 print $fg "$preamble\n" if $preamble;
385 print $fg "title $title\n" if $title;
386 #print $fg "root $base\n"; # root doesn't really work for (nd)
388 foreach (@$modules_ref) {
391 my ($kbin, $kcmd) = split(' ', $_, 2);
392 $kcmd = '' if !defined $kcmd;
393 print $fg "kernel ${base}$kbin $kcmd\n";
395 s|\brom://([^ ]*)|$rom_prefix$base$1|g; # Translate rom:// files - needed for vdisk parameter of sigma0
396 print $fg "module $base$_\n";
400 print("novaboot: Created $builddir/$filename\n");
404 sub generate_syslinux_config($$$$)
406 my ($filename, $title, $base, $modules_ref) = @_;
407 if ($base && $base !~ /\/$/) { $base = "$base/"; };
408 open(my $fg, '>', $filename) or die "$filename: $!";
409 print $fg "LABEL $title\n";
410 #TODO print $fg "MENU LABEL $human_readable_title\n";
412 my ($kbin, $kcmd) = split(' ', @$modules_ref[0], 2);
414 if (system("file $kbin|grep 'Linux kernel'") == 0) {
415 my $initrd = @$modules_ref[1];
416 die('To many "load" lines for Linux kernel') if (scalar @$modules_ref > 2);
417 print $fg "LINUX $base$kbin\n";
418 print $fg "APPEND $kcmd\n";
419 print $fg "INITRD $base$initrd\n";
421 print $fg "KERNEL mboot.c32\n";
423 foreach (@$modules_ref) {
424 s|\brom://([^ ]*)|$rom_prefix$base$1|g; # Translate rom:// files - needed for vdisk parameter of sigma0
425 push @append, "$base$_";
426 print $fg "APPEND ".join(' --- ', @append)."\n";
429 #TODO print $fg "TEXT HELP\n";
430 #TODO print $fg "some help here\n";
431 #TODO print $fg "ENDTEXT\n";
433 print("novaboot: Created $builddir/$filename\n");
437 sub generate_grub2_config($$$$;$$)
439 my ($filename, $title, $base, $modules_ref, $preamble, $prolog) = @_;
440 if ($base && substr($base,-1,1) ne '/') { $base = "$base/"; };
441 open(my $fg, '>', $filename) or die "$filename: $!";
442 print $fg "$preamble\n" if $preamble;
443 $title ||= 'novaboot';
444 print $fg "menuentry $title {\n";
445 print $fg "$prolog\n" if $prolog;
447 foreach (@$modules_ref) {
450 my ($kbin, $kcmd) = split(' ', $_, 2);
451 $kcmd = '' if !defined $kcmd;
452 print $fg " multiboot ${base}$kbin $kcmd\n";
455 # GRUB2 doesn't pass filename in multiboot info so we have to duplicate it here
456 $_ = join(' ', ($args[0], @args));
457 s|\brom://|$rom_prefix|g; # We do not need to translate path for GRUB2
458 print $fg " module $base$_\n";
463 print("novaboot: Created $builddir/$filename\n");
467 sub generate_pulsar_config($$)
469 my ($filename, $modules_ref) = @_;
470 open(my $fg, '>', $filename) or die "$filename: $!";
471 print $fg "root $pulsar_root\n" if defined $pulsar_root;
474 foreach (@$modules_ref) {
477 ($kbin, $kcmd) = split(' ', $_, 2);
478 $kcmd = '' if !defined $kcmd;
481 s|\brom://|$rom_prefix|g;
482 print $fg "load $_\n";
485 # Put kernel as last - this is needed for booting Linux and has no influence on non-Linux OSes
486 print $fg "exec $kbin $kcmd\n";
488 print("novaboot: Created $builddir/$filename\n");
492 sub shell_cmd_string(@)
494 return join(' ', map((/^[-_=a-zA-Z0-9\/\.\+]+$/ ? "$_" : "'$_'"), @_));
499 print "novaboot: Running: ".shell_cmd_string(@_)."\n";
501 exit(1); # should not be reached
504 sub system_verbose($)
507 print "novaboot: Running: $cmd\n";
508 my $ret = system($cmd);
509 if ($ret & 0x007f) { die("Command terminated by a signal"); }
510 if ($ret & 0xff00) {die("Command exit with non-zero exit code"); }
511 if ($ret) { die("Command failure $ret"); }
516 if (exists $variables->{WVDESC}) {
517 print "Testing \"$variables->{WVDESC}\" in $last_fn:\n";
518 } elsif ($last_fn =~ /\.wv$/) {
519 print "Testing \"all\" in $last_fn:\n";
522 ## Connect to the target and check whether it is not occupied
524 # We have to do this before file generation phase, because file
525 # generation is intermixed with file deployment phase and we want to
526 # check whether the target is not used by somebody else before
527 # deploying files. Otherwise, we may rewrite other user's files on a
530 my $exp; # Expect object to communicate with the target over serial line
532 my ($target_reset, $target_power_on, $target_power_off);
533 my ($amt_user, $amt_password, $amt_host, $amt_port);
535 if (defined $iprelay) {
537 $iprelay =~ /([.0-9]+)(:([0-9]+))?/;
540 my $paddr = sockaddr_in($port, inet_aton($addr));
541 my $proto = getprotobyname('tcp');
542 socket($IPRELAY, PF_INET, SOCK_STREAM, $proto) || die "socket: $!";
543 print "novaboot: Connecting to IP relay... ";
544 connect($IPRELAY, $paddr) || die "connect: $!";
546 $exp = Expect->init(\*$IPRELAY);
550 print $exp "\xFF\xF6"; # AYT
551 my $connected = $exp->expect(20, # Timeout in seconds
552 '<iprelayd: connected>',
553 '-re', '<WEB51 HW[^>]*>');
558 my ($relay, $onoff) = @_;
559 die unless ($relay == 1 || $relay == 2);
561 my $cmd = ($relay == 1 ? 0x5 : 0x6) | ($onoff ? 0x20 : 0x10);
562 return "\xFF\xFA\x2C\x32".chr($cmd)."\xFF\xF0";
566 my ($relay, $onoff) = @_;
567 die unless ($relay == 1 || $relay == 2);
568 my $cmd = ($relay == 1 ? 0xdf : 0xbf) | ($onoff ? 0x00 : 0xff);
569 return "\xFF\xFA\x2C\x97".chr($cmd)."\xFF\xF0";
573 my ($relay, $onoff, $can_giveup) = @_;
574 my $confirmation = '';
576 print $exp relaycmd($relay, $onoff);
577 my $confirmed = $exp->expect(20, # Timeout in seconds
578 relayconf($relay, $onoff));
581 print("Relay confirmation timeout - ignoring\n");
583 die "Relay confirmation timeout";
589 $target_reset = sub {
590 relay(2, 1, 1); # Reset the machine
595 $target_power_off = sub {
596 relay(1, 1); # Press power button
597 usleep(6000000); # Long press to switch off
601 $target_power_on = sub {
602 relay(1, 1); # Press power button
603 usleep(100000); # Short press
609 system_verbose("stty -F $serial $stty");
610 open($CONN, "+<", $serial) || die "open $serial: $!";
611 $exp = Expect->init(\*$CONN);
613 elsif ($remote_cmd) {
614 print "novaboot: Running: $remote_cmd\n";
615 $exp = Expect->spawn($remote_cmd);
617 elsif (defined $amt) {
618 require LWP::UserAgent;
619 require LWP::Authen::Digest;
622 my ($host, $username, $password, $schema, $className, $pstate) = @_;
623 #AMT numbers for PowerStateChange (MNI => bluescreen on windows;-)
624 my %pstates = ("on" => 2,
631 <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">
632 <s:Header><a:To>http://$host:16992/wsman</a:To>
633 <w:ResourceURI s:mustUnderstand="true">$schema</w:ResourceURI>
634 <a:ReplyTo><a:Address s:mustUnderstand="true">http://schemas.xmlsoap.org/ws/2004/08/addressing/role/anonymous</a:Address></a:ReplyTo>
635 <a:Action s:mustUnderstand="true">$schema$className</a:Action>
636 <w:MaxEnvelopeSize s:mustUnderstand="true">153600</w:MaxEnvelopeSize>
637 <a:MessageID>uuid:709072C9-609C-4B43-B301-075004043C7C</a:MessageID>
638 <w:Locale xml:lang="en-US" s:mustUnderstand="false" />
639 <w:OperationTimeout>PT60.000S</w:OperationTimeout>
640 <w:SelectorSet><w:Selector Name="Name">Intel(r) AMT Power Management Service</w:Selector></w:SelectorSet>
642 <p:RequestPowerStateChange_INPUT xmlns:p="http://schemas.dmtf.org/wbem/wscim/1/cim-schema/2/CIM_PowerManagementService">
643 <p:PowerState>$pstates{$pstate}</p:PowerState>
644 <p:ManagedElement><a:Address>http://$host:16992/wsman</a:Address>
645 <a:ReferenceParameters><w:ResourceURI>http://schemas.dmtf.org/wbem/wscim/1/cim-schema/2/CIM_ComputerSystem</w:ResourceURI>
646 <w:SelectorSet><w:Selector Name="Name">ManagedSystem</w:Selector></w:SelectorSet>
647 </a:ReferenceParameters></p:ManagedElement>
648 </p:RequestPowerStateChange_INPUT>
649 </s:Body></s:Envelope>
654 my ($host, $username, $password, $content) = @_;
656 my $ua = LWP::UserAgent->new();
657 $ua->agent("novaboot");
659 my $req = HTTP::Request->new(POST => "http://$host:16992/wsman");
660 my $res = $ua->request($req);
661 die ("Unexpected AMT response: " . $res->status_line) unless $res->code == 401;
663 my ($realm) = $res->header("WWW-Authenticate") =~ /Digest realm="(.*?)"/;
664 $ua->credentials("$host:16992", $realm, $username => $password);
667 $req = HTTP::Request->new(POST => "http://$host:16992/wsman");
668 $req->content_type('application/x-www-form-urlencoded');
669 $req->content($content);
670 $res = $ua->request($req);
671 die ("AMT power change request failed: " . $res->status_line) unless $res->is_success;
672 $res->content() =~ /<g:ReturnValue>(\d+)<\/g:ReturnValue>/;
677 my ($host, $username, $password, $pstate)=@_;
678 my $schema="http://schemas.dmtf.org/wbem/wscim/1/cim-schema/2/CIM_PowerManagementService";
679 my $className="/RequestPowerStateChange";
680 my $content = genXML($host, $username, $password ,$schema, $className, $pstate);
681 return sendPOST($host, $username, $password, $content);
684 ($amt_user,$amt_password,$amt_host,$amt_port) = ($amt =~ /(?:(.*?)(?::(.*))?@)?([^:]*)(?::([0-9]*))?/);;
685 $amt_user ||= "admin";
686 $amt_password ||= $ENV{'AMT_PASSWORD'} || die "AMT password not specified";
687 $amt_host || die "AMT host not specified";
691 $target_power_off = sub {
693 my $result = powerChange($amt_host,$amt_user,$amt_password, "off");
694 die "AMT power off failed (ReturnValue $result)" if $result != 0;
697 $target_power_on = sub {
698 my $result = powerChange($amt_host,$amt_user,$amt_password, "on");
699 die "AMT power on failed (ReturnValue $result)" if $result != 0;
702 $target_reset = sub {
703 my $result = powerChange($amt_host,$amt_user,$amt_password, "reset");
705 print STDERR "Warning: Cannot reset $amt_host, trying power on. ";
706 $result = powerChange($amt_host,$amt_user,$amt_password, "on");
708 die "AMT reset failed (ReturnValue $result)" if $result != 0;
711 my $cmd = "amtterm -u $amt_user -p $amt_password $amt_host $amt_port";
712 print "novaboot: Running: $cmd\n" =~ s/\Q$amt_password\E/???/r;
713 $exp = Expect->spawn($cmd);
714 $exp->expect(10, "RUN_SOL") || die "Expect for 'RUN_SOL' timed out";
719 if ($remote_expect) {
720 $exp->expect(10, $remote_expect) || die "Expect for '$remote_expect' timed out";
723 if (defined $reset_cmd) {
724 $target_reset = sub {
725 system_verbose($reset_cmd);
729 if (defined $on_opt && defined $target_power_on) {
733 if (defined $off_opt && defined $target_power_off) {
734 print "novaboot: Switching the target off...\n";
735 &$target_power_off();
739 $builddir ||= dirname(File::Spec->rel2abs( ${$scripts[0]}{filename})) if scalar @scripts;
740 if (defined $builddir) {
741 chdir($builddir) or die "Can't change directory to $builddir: $!";
742 print "novaboot: Entering directory `$builddir'\n";
745 ## File generation phase
746 my (%files_iso, $menu_iso, $filename);
747 my $config_name = '';
749 foreach my $script (@scripts) {
750 $filename = $$script{filename};
751 $modules = $$script{modules};
752 $generated = $$script{generated};
753 $variables = $$script{variables};
755 ($config_name = $filename) =~ s#.*/##;
756 $config_name = $config_name_opt if (defined $config_name_opt);
758 if (exists $variables->{BUILDDIR}) {
759 $builddir = File::Spec->rel2abs($variables->{BUILDDIR});
760 chdir($builddir) or die "Can't change directory to $builddir: $!";
761 print "novaboot: Entering directory `$builddir'\n";
765 ($prefix = $grub_prefix) =~ s/\$NAME/$config_name/ if defined $grub_prefix;
766 $prefix ||= $builddir;
767 # TODO: use $grub_prefix as first parameter if some switch is given
768 generate_configs('', $generated, $filename);
770 ### Generate bootloader configuration files
771 my @bootloader_configs;
772 push @bootloader_configs, generate_grub_config($grub_config, $config_name, $prefix, $modules, $grub_preamble) if (defined $grub_config);
773 push @bootloader_configs, generate_grub2_config($grub2_config, $config_name, $prefix, $modules, $grub_preamble, $grub2_prolog) if (defined $grub2_config);
774 push @bootloader_configs, generate_pulsar_config('config-'.($pulsar||'novaboot'), $modules) if (defined $pulsar);
776 ### Run scons or make
778 my @files = map({ ($file) = m/([^ ]*)/; $file; } @$modules);
779 # Filter-out generated files
780 my @to_build = grep({ my $file = $_; !scalar(grep($file eq ($$_{filename} || ''), @$generated)) } @files);
782 system_verbose($scons || $CFG::scons." ".join(" ", @to_build)) if (defined $scons);
783 system_verbose($make || $CFG::make ." ".join(" ", @to_build)) if (defined $make);
786 ### Copy files (using rsync)
787 if (defined $server && !defined($gen_only)) {
788 (my $real_server = $server) =~ s/\$NAME/$config_name/;
790 my ($hostname, $path) = split(":", $real_server, 2);
791 if (! defined $path) {
795 my $files = join(" ", map({ ($file) = m/([^ ]*)/; $file; } ( @$modules, @bootloader_configs)));
796 map({ my $file = (split)[0]; die "$file: $!" if ! -f $file; } @$modules);
797 my $istty = -t STDOUT && ($ENV{'TERM'} || 'dumb') ne 'dumb';
798 my $progress = $istty ? "--progress" : "";
799 system_verbose("rsync $progress -RLp $rsync_flags $files $real_server");
800 if ($server =~ m|/\$NAME$| && $concat) {
801 my $cmd = join("; ", map { "( cd $path/.. && cat */$_ > $_ )" } @bootloader_configs);
802 system_verbose($hostname ? "ssh $hostname '$cmd'" : $cmd);
806 ### Prepare ISO image generation
807 if (defined $iso_image) {
808 generate_configs("(cd)", $generated, $filename);
810 generate_syslinux_config(\$menu, $config_name, "/", $modules);
811 $menu_iso .= "$menu\n";
812 map { ($file,undef) = split; $files_iso{$file} = 1; } @$modules;
816 ## Generate ISO image
817 if (defined $iso_image) {
818 system_verbose("mkdir -p isolinux");
821 if (-f '/usr/lib/ISOLINUX/isolinux.bin') {
822 # Newer ISOLINUX version
823 @files = qw(/usr/lib/ISOLINUX/isolinux.bin /usr/lib/syslinux/modules/bios/mboot.c32 /usr/lib/syslinux/modules/bios/libcom32.c32 /usr/lib/syslinux/modules/bios/menu.c32 /usr/lib/syslinux/modules/bios/ldlinux.c32);
825 # Older ISOLINUX version
826 @files = qw(/usr/lib/syslinux/isolinux.bin /usr/lib/syslinux/mboot.c32 /usr/lib/syslinux/menu.c32);
828 system_verbose("cp @files isolinux");
829 open(my $fh, ">isolinux/isolinux.cfg");
831 print $fh "TIMEOUT 50\n";
832 print $fh "DEFAULT menu\n";
834 print $fh "DEFAULT $config_name\n";
836 print $fh "$menu_iso";
839 my $files = join(" ", map("$_=$_", (keys(%files_iso), 'isolinux/isolinux.cfg', map(s|.*/|isolinux/|r, @files))));
840 $iso_image ||= "$config_name.iso";
842 # Note: We use -U flag below to "Allow 'untranslated' filenames,
843 # completely violating the ISO9660 standards". Without this
844 # option, isolinux is not able to read files names for example
846 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");
847 print("ISO image created: $builddir/$iso_image\n");
850 exit(0) if defined $gen_only;
852 ## Boot the system using various methods and send serial output to stdout
854 if (scalar(@scripts) > 1 && ( defined $dhcp_tftp || defined $serial || defined $iprelay)) {
855 die "You cannot do this with multiple scripts simultaneously";
858 if ($variables->{WVTEST_TIMEOUT}) {
859 print "wvtest: timeout ", $variables->{WVTEST_TIMEOUT}, "\n";
864 $str =~ s/^\s+|\s+$//g;
872 $qemu ||= $variables->{QEMU} || $CFG::qemu;
873 my @qemu_flags = split(" ", $qemu);
874 $qemu = shift(@qemu_flags);
876 @qemu_flags = split(/ +/, trim($variables->{QEMU_FLAGS})) if exists $variables->{QEMU_FLAGS};
877 @qemu_flags = split(/ +/, trim($qemu_flags_cmd)) if $qemu_flags_cmd;
878 push(@qemu_flags, split(/ +/, trim($qemu_append || '')));
880 if (defined $iso_image) {
881 # Boot NOVA with grub (and test the iso image)
882 push(@qemu_flags, ('-cdrom', $iso_image));
884 # Boot NOVA without GRUB
886 # Non-patched qemu doesn't like commas, but NUL can live with pluses instead of commans
887 foreach (@$modules) {s/,/+/g;}
888 generate_configs("", $generated, $filename);
890 if (scalar @$modules) {
891 my ($kbin, $kcmd) = split(' ', shift(@$modules), 2);
892 $kcmd = '' if !defined $kcmd;
894 @$modules = map { if (/\.dtb$/) { $dtb=$_; (); } else { $_ } } @$modules;
895 my $initrd = join ",", @$modules;
897 push(@qemu_flags, ('-kernel', $kbin, '-append', $kcmd));
898 push(@qemu_flags, ('-initrd', $initrd)) if $initrd;
899 push(@qemu_flags, ('-dtb', $dtb)) if $dtb;
902 push(@qemu_flags, qw(-serial stdio)); # Redirect serial output (for collecting test restuls)
903 unshift(@qemu_flags, ('-name', $config_name));
904 print "novaboot: Running: ".shell_cmd_string($qemu, @qemu_flags)."\n";
905 $exp = Expect->spawn(($qemu, @qemu_flags)) || die("exec() failed: $!");
908 ### Local DHCPD and TFTPD
910 my ($dhcpd_pid, $tftpd_pid);
912 $tftp=1 if $tftp_port;
914 if (defined $dhcp_tftp)
916 generate_configs("(nd)", $generated, $filename);
917 system_verbose('mkdir -p tftpboot');
918 generate_grub_config("tftpboot/os-menu.lst", $config_name, "(nd)", \@$modules, "timeout 0");
919 open(my $fh, '>', 'dhcpd.conf');
920 my $mac = `cat /sys/class/net/eth0/address`;
922 print $fh "subnet 10.23.23.0 netmask 255.255.255.0 {
923 range 10.23.23.10 10.23.23.100;
924 filename \"bin/boot/grub/pxegrub.pxe\";
925 next-server 10.23.23.1;
928 hardware ethernet $mac;
929 fixed-address 10.23.23.1;
932 system_verbose("sudo ip a add 10.23.23.1/24 dev eth0;
933 sudo ip l set dev eth0 up;
934 sudo touch dhcpd.leases");
936 # We run servers by forking ourselves, because the servers end up
937 # in our process group and get killed by signals sent to the
938 # process group (e.g. Ctrl-C on terminal).
940 exec_verbose("sudo dhcpd -d -cf dhcpd.conf -lf dhcpd.leases -pf dhcpd.pid") if ($dhcpd_pid == 0);
943 if (defined $dhcp_tftp || defined $tftp) {
945 # Unfortunately, tftpd requires root privileges even with
946 # non-privileged (>1023) port due to initgroups().
947 system_verbose("sudo in.tftpd --listen --secure -v -v -v --pidfile tftpd.pid --address :$tftp_port $builddir");
949 # Kill server when we die
950 $SIG{__DIE__} = sub { system_verbose('sudo pkill --pidfile=dhcpd.pid') if (defined $dhcp_tftp);
951 system_verbose('sudo pkill --pidfile=tftpd.pid'); };
953 # We have to kill tftpd explicitely, because it is not in our process group
954 $SIG{INT} = sub { system_verbose('sudo pkill --pidfile=tftpd.pid'); exit(0); };
959 my $ider_cmd= "amtider -c $iso_image -u $amt_user -p $amt_password $amt_host $amt_port" ;
960 print "novaboot: Running: $ider_cmd\n" =~ s/\Q$amt_password\E/???/r;
961 my $ider_pid = fork();
962 if ($ider_pid == 0) {
964 die "IDE redirection failed";
966 # FIXME: This collides with --tftp option. Hopefully, nobody needs
967 # to use both simultaneously.
968 $SIG{__DIE__} = sub { system_verbose('kill $ider_pid'); };
971 ### Reset target (IP relay, AMT, ...)
973 if (defined $target_reset) {
974 print "novaboot: Reseting the test box... ";
979 ### U-boot conversation
980 if (defined $uboot) {
981 my $uboot_prompt = $uboot || '=> ';
982 print "novaboot: Waiting for uBoot prompt...\n";
984 #$exp->exp_internal(1);
986 [qr/Hit any key to stop autoboot:/, sub { $exp->send("\n"); exp_continue; }],
987 $uboot_prompt) || die "No uBoot prompt deteceted";
988 foreach my $cmd (@uboot_init) {
990 $exp->send("$cmd\n");
991 $exp->expect(10, $uboot_prompt) || die "uBoot prompt timeout";
994 # Boot the system if there are some load lines in the script
995 if (scalar(@$modules) > 0) {
996 my ($kbin, $kcmd) = split(' ', shift(@$modules), 2);
998 @$modules = map { if (/\.dtb$/) { $dtb=$_; (); } else { $_ } } @$modules;
999 my $initrd = shift @$modules;
1001 my $kern_addr = '800000';
1002 my $initrd_addr = '-';
1005 $exp->send("tftp $kern_addr $kbin\n");
1007 [qr/#/, sub { exp_continue; }],
1008 $uboot_prompt) || die "Kernel load failed";
1010 $dtb_addr = '7f0000';
1011 $exp->send("tftp $dtb_addr $dtb\n");
1013 [qr/#/, sub { exp_continue; }],
1014 $uboot_prompt) || die "Device tree load failed";
1016 if (defined $initrd) {
1017 $initrd_addr = 'b00000';
1018 $exp->send("tftp $initrd_addr $initrd\n");
1020 [qr/#/, sub { exp_continue; }],
1021 $uboot_prompt) || die "Initrd load failed";
1023 $exp->send("set bootargs '$kcmd'\n");
1024 $exp->expect(5, $uboot_prompt) || die "uBoot prompt timeout";
1025 $exp->send("bootm $kern_addr $initrd_addr $dtb_addr\n");
1026 $exp->expect(5, "\n") || die "uBoot command timeout";
1030 ### Serial line interaction
1032 # Serial line of the target is available
1033 my $interrupt = 'Ctrl-C';
1034 if ($interactive && !@exiton) {
1035 $interrupt = '"~~."';
1037 my $note = (-t STDIN) ? '' : '- only target->host ';
1038 print "novaboot: Serial line interaction $note(press $interrupt to interrupt)...\n";
1039 $exp->log_stdout(1);
1041 $exp->expect(undef, @expect_raw, @exiton);
1043 my @inputs = ($exp);
1044 if (-t STDIN) { # Set up bi-directional communication if we run on terminal
1045 my $infile = new IO::File;
1046 $infile->IO::File::fdopen(*STDIN,'r');
1047 my $in_object = Expect->exp_init($infile);
1048 $in_object->set_group($exp);
1051 $in_object->set_seq('~~\.', sub { print "novaboot: Escape sequence detected\r\n"; undef; });
1052 $in_object->manual_stty(0); # Use raw terminal mode
1054 $in_object->manual_stty(1); # Do not modify terminal settings
1056 push(@inputs, $in_object);
1059 #print Dumper(\@expect_raw);
1060 $exp->expect(undef, @expect_raw) if @expect_raw;
1061 Expect::interconnect(@inputs) unless defined($exp->exitstatus);
1065 ## Kill dhcpc or tftpd
1066 if (defined $dhcp_tftp || defined $tftp) {
1067 die("novaboot: This should kill servers on background\n");
1074 novaboot - A tool for booting various operating systems on various hardware or in qemu
1080 B<novaboot> [option]... [--] script...
1082 B<./script> [option]...
1086 This program makes booting of an operating system (e.g. NOVA or Linux)
1087 as simple as running a local program. It facilitates booting on local
1088 or remote hosts or in emulators such as qemu. Novaboot operation is
1089 controlled by command line options and by a so called novaboot script,
1090 which can be thought as a generalization of bootloader configuration
1091 files (see L</"NOVABOOT SCRIPT SYNTAX">). Based on this input,
1092 novaboot setups everything for the target host to boot the desired
1093 configuration, i.e. it generates the bootloader configuration file in
1094 the proper format, deploy the binaries and other needed files to
1095 required locations, perhaps on a remote boot server and reset the
1096 target host. Finally, target host's serial output is redirected to
1097 standard output if that is possible.
1099 Typical way of using novaboot is to make the novaboot script
1100 executable and set its first line to I<#!/usr/bin/env novaboot>. Then,
1101 booting a particular OS configuration becomes the same as executing a
1102 local program - the novaboot script.
1104 For example, with C<novaboot> you can:
1110 Run an OS in Qemu. This is the default action when no other action is
1111 specified by command line switches. Thus running C<novaboot ./script>
1112 (or C<./script> as described above) will run Qemu and make it boot the
1113 configuration specified in the F<script>.
1117 Create a bootloader configuration file (currently supported
1118 bootloaders are GRUB, GRUB2, Pulsar and U-Boot) and copy it with all
1119 other files needed for booting to a remote boot server.
1121 ./script --server=192.168.1.1:/tftp --iprelay=192.168.1.2
1123 This command copies files to the TFTP server and uses
1124 TCP/IP-controlled relay to reset the target host and receive its
1129 Run DHCP and TFTP server on developer's machine to PXE-boot the target
1132 ./script --dhcp-tftp
1134 When a PXE-bootable machine is connected via Ethernet to developer's
1135 machine, it will boot the configuration described in I<script>.
1139 Create bootable ISO images. E.g.
1141 novaboot --iso -- script1 script2
1143 The created ISO image will have GRUB bootloader installed on it and
1144 the boot menu will allow selecting between I<script1> and I<script2>
1149 Note that the options needed for a specific target can be stored in a
1150 L</"CONFIGURATION FILE">. Then it is sufficient to use only the B<-t>
1151 option to specify the name of the target.
1153 =head1 PHASES AND OPTIONS
1155 Novaboot performs its work in several phases. Each phase can be
1156 influenced by several options, certain phases can be skipped. The list
1157 of phases (in the execution order) and the corresponding options
1160 =head2 Configuration reading phase
1162 After starting, novaboot reads configuration files. Their content is
1163 described in L</"CONFIGURATION FILE">. By default, configuration is
1164 read from two locations. First from the configuration directory and
1165 second from F<.novaboot> files along the path to the current
1166 directory. The later read files override settings from the former
1169 Configuration directory is determined by the content of
1170 NOVABOOT_CONFIG_DIR environment variable defaulting to
1171 F</etc/novaboot.d>. Files in this directory with names consisting
1172 solely from English letters, numbers, dashes '-' and underscores '_'
1173 (note that dot '.' is not included) are read in alphabetical order.
1175 Then novaboot searches for files named F<.novaboot> starting
1176 from the directory of the novaboot script (or working directory, see
1177 bellow) and continuing upwards up to the root directory. The found
1178 configuration files are then read in order from the root directory
1181 In certain cases, the location of the novaboot script cannot be
1182 determined in this early phase. This happens either when the script is
1183 read from the standard input or when novaboot is invoked explicitly
1184 and options precede the script name, as in the example L</"4."> above.
1185 In this case the current working directory is used as a starting point
1186 for configuration file search instead of the novaboot script
1191 =item -c, --config=I<filename>
1193 Use the specified configuration file instead of the default one(s).
1197 =head2 Command line processing phase
1203 Dump the current configuration to stdout end exits. Useful as an
1204 initial template for a configuration file.
1208 Print short (B<-h>) or long (B<--help>) help.
1210 =item -t, --target=I<target>
1212 This option serves as a user configurable shortcut for other novaboot
1213 options. The effect of this option is the same as the options stored
1214 in the C<%targets> configuration variable under key I<target>. See
1215 also L</"CONFIGURATION FILE">.
1219 =head2 Script preprocessing phase
1221 This phases allows to modify the parsed novaboot script before it is
1222 used in the later phases.
1226 =item -a, --append=I<parameters>
1228 Append a string to the first C<load> line in the novaboot script. This
1229 can be used to append parameters to the kernel's or root task's
1230 command line. Can appear multiple times.
1234 Use F<bender> chainloader. Bender scans the PCI bus for PCI serial
1235 ports and stores the information about them in the BIOS data area for
1238 =item --chainloader=I<chainloader>
1240 Chainloader that is loaded before the kernel and other files specified
1241 in the novaboot script. E.g. 'bin/boot/bender promisc'.
1245 Print the modules to boot and their parameters after this phase
1246 finishes. Then exit. This is useful for seeing the effect of other
1247 options in this section.
1249 =item -k, --kernel=F<file>
1251 Replace the first word on the first C<load> line in the novaboot
1252 script with F<file>.
1254 =item --scriptmod=I<perl expression>
1256 When novaboot script is read, I<perl expression> is executed for every
1257 line (in $_ variable). For example, C<novaboot
1258 --scriptmod=s/sigma0/omega6/g> replaces every occurrence of I<sigma0>
1259 in the script with I<omega6>.
1261 When this option is present, it overrides I<$script_modifier> variable
1262 from the configuration file, which has the same effect. If this option
1263 is given multiple times all expressions are evaluated in the command
1268 =head2 File generation phase
1270 In this phase, files needed for booting are generated in a so called
1271 I<build directory> (see L</--build-dir>). In most cases configuration
1272 for a bootloader is generated automatically by novaboot. It is also
1273 possible to generate other files using I<heredoc> or I<"<"> syntax in
1274 novaboot scripts. Finally, binaries can be generated in this phases by
1275 running C<scons> or C<make>.
1279 =item --build-dir=I<directory>
1281 Overrides the default build directory location.
1283 The default build directory location is determined as follows: If the
1284 configuration file defines the C<$builddir> variable, its value is
1285 used. Otherwise, it is the directory that contains the first processed
1288 See also L</BUILDDIR> variable.
1290 =item -g, --grub[=I<filename>]
1292 Generates grub bootloader menu file. If the I<filename> is not
1293 specified, F<menu.lst> is used. The I<filename> is relative to the
1294 build directory (see B<--build-dir>).
1296 =item --grub-preamble=I<prefix>
1298 Specifies the I<preable> that is at the beginning of the generated
1299 GRUB or GRUB2 config files. This is useful for specifying GRUB's
1302 =item --grub-prefix=I<prefix>
1304 Specifies I<prefix> that is put in front of every file name in GRUB's
1305 F<menu.lst>. The default value is the absolute path to the build directory.
1307 If the I<prefix> contains string $NAME, it will be replaced with the
1308 name of the novaboot script (see also B<--name>).
1310 =item --grub2[=I<filename>]
1312 Generate GRUB2 menuentry in I<filename>. If I<filename> is not
1313 specified F<grub.cfg> is used. The content of the menuentry can be
1314 customized with B<--grub-preable>, B<--grub2-prolog> or
1315 B<--grub_prefix> options.
1317 In order to use the the generated menuentry on your development
1318 machine that uses GRUB2, append the following snippet to
1319 F</etc/grub.d/40_custom> file and regenerate your grub configuration,
1320 i.e. run update-grub on Debian/Ubuntu.
1322 if [ -f /path/to/nul/build/grub.cfg ]; then
1323 source /path/to/nul/build/grub.cfg
1326 =item --grub2-prolog=I<prolog>
1328 Specifies text I<preable> that is put at the beginning of the entry
1331 =item -m, --make[=make command]
1333 Runs C<make> to build files that are not generated by novaboot itself.
1335 =item --name=I<string>
1337 Use the name I<string> instead of the name of the novaboot script.
1338 This name is used for things like a title of grub menu or for the
1339 server directory where the boot files are copied to.
1343 Do not run external commands to generate files (i.e. "<" syntax and
1344 C<run> keyword). This switch does not influence generation of files
1345 specified with "<<WORD" syntax.
1347 =item -p, --pulsar[=mac]
1349 Generates pulsar bootloader configuration file named F<config-I<mac>>
1350 The I<mac> string is typically a MAC address and defaults to
1353 =item --scons[=scons command]
1355 Runs C<scons> to build files that are not generated by novaboot
1360 Strip I<rom://> prefix from command lines and generated config files.
1361 The I<rom://> prefix is used by NUL. For NRE, it has to be stripped.
1365 Exit novaboot after file generation phase.
1369 =head2 Target connection check
1371 If supported by the target, the connection to it is made and it is
1372 checked whether the target is not occupied by another novaboot
1377 =item --amt=I<"[user[:password]@]host[:port]>
1379 Use Intel AMT technology to control the target machine. WS management
1380 is used to powercycle it and Serial-Over-Lan (SOL) for input/output.
1381 The hostname or (IP address) is given by the I<host> parameter. If
1382 I<password> is not specified, environment variable AMT_PASSWORD is
1383 used. The I<port> specifies a TCP port for SOL. If not specified, the
1384 default is 16992. Default I<user> is admin.
1388 Use Intel AMT technology for IDE redirection. This allows the target
1389 machine to boot from nonvaboot created ISO image.
1391 The experimental I<amtider> utility needed by this option can be
1392 obtained from https://github.com/wentasah/amtterm.
1394 =item --iprelay=I<addr[:port]>
1396 Use TCP/IP relay and serial port to access the target's serial port
1397 and powercycle it. The IP address of the relay is given by I<addr>
1398 parameter. If I<port> is not specified, it default to 23.
1400 Note: This option is supposed to work with HWG-ER02a IP relays.
1402 =item -s, --serial[=device]
1404 Target's serial line is connected to host's serial line (device). The
1405 default value for device is F</dev/ttyUSB0>.
1407 The value of this option is exported in NB_NOVABOOT environment
1408 variable to all subprocesses run by C<novaboot>.
1410 =item --stty=I<settings>
1412 Specifies settings passed to C<stty> invoked on the serial line
1413 specified with B<--serial> option. If this option is not given,
1414 C<stty> is called with C<raw -crtscts -onlcr 115200> settings.
1416 =item --remote-cmd=I<cmd>
1418 Command that mediates connection to the target's serial line. For
1419 example C<ssh server 'cu -l /dev/ttyS0'>.
1421 =item --remote-expect=I<string>
1423 Wait for reception of I<string> after establishing the the remote
1424 connection before continuing.
1429 =head2 File deployment phase
1431 In some setups, it is necessary to copy the files needed for booting
1432 to a particular location, e.g. to a TFTP boot server or to the
1437 =item -d, --dhcp-tftp
1439 Turns your workstation into a DHCP and TFTP server so that the OS can
1440 be booted via PXE BIOS (or similar mechanism) on the test machine
1441 directly connected by a plain Ethernet cable to your workstation.
1443 The DHCP and TFTP servers requires root privileges and C<novaboot>
1444 uses C<sudo> command to obtain those. You can put the following to
1445 I</etc/sudoers> to allow running the necessary commands without asking
1448 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
1449 your_login ALL=NOPASSWD: NOVABOOT
1453 Starts a TFTP server on your workstation. This is similar to
1454 B<--dhcp-tftp> except that DHCP server is not started.
1456 The TFTP server require root privileges and C<novaboot> uses C<sudo>
1457 command to obtain those. You can put the following to I</etc/sudoers>
1458 to allow running the necessary commands without asking for password.
1460 Cmnd_Alias NOVABOOT = /usr/sbin/in.tftpd --listen --secure -v -v -v --pidfile tftpd.pid *, /usr/bin/pkill --pidfile=tftpd.pid
1461 your_login ALL=NOPASSWD: NOVABOOT
1463 =item --tftp-port=I<port>
1465 Port to run the TFTP server on. Implies B<--tftp>.
1467 =item --iso[=filename]
1469 Generates the ISO image that boots NOVA system via GRUB. If no filename
1470 is given, the image is stored under I<NAME>.iso, where I<NAME> is the name
1471 of the novaboot script (see also B<--name>).
1473 =item --server[=[[user@]server:]path]
1475 Copy all files needed for booting to another location (implies B<-g>
1476 unless B<--grub2> is given). The files will be copied (by B<rsync>
1477 tool) to the directory I<path>. If the I<path> contains string $NAME,
1478 it will be replaced with the name of the novaboot script (see also
1483 If B<--server> is used and its value ends with $NAME, then after
1484 copying the files, a new bootloader configuration file (e.g. menu.lst)
1485 is created at I<path-wo-name>, i.e. the path specified by B<--server>
1486 with $NAME part removed. The content of the file is created by
1487 concatenating all files of the same name from all subdirectories of
1488 I<path-wo-name> found on the "server".
1490 =item --rsync-flags=I<flags>
1492 Specifies which I<flags> are appended to F<rsync> command line when
1493 copying files as a result of I<--server> option.
1497 =head2 Target power-on and reset phase
1503 Switch on/off the target machine and exit. The script (if any) is
1504 completely ignored. Currently it works only with B<--iprelay> or
1507 =item -Q, --qemu[=I<qemu-binary>]
1509 Boot the configuration in qemu. Optionally, the name of qemu binary
1510 can be specified as a parameter.
1512 =item --qemu-append=I<flags>
1514 Append I<flags> to the default qemu flags (QEMU_FLAGS variable or
1515 C<-cpu coreduo -smp 2>).
1517 =item -q, --qemu-flags=I<flags>
1519 Replace the default qemu flags (QEMU_FLAGS variable or C<-cpu coreduo
1520 -smp 2>) with I<flags> specified here.
1522 =item --reset-cmd=I<cmd>
1524 Command that resets the target.
1528 =head2 Interaction with the bootloader on the target
1532 =item --uboot[=I<prompt>]
1534 Interact with uBoot bootloader to boot the thing described in the
1535 novaboot script. I<prompt> specifies the U-Boot's prompt (default is
1536 "=> ", other common prompts are "U-Boot> " or "U-Boot# ").
1537 Implementation of this option is currently tied to a particular board
1538 that we use. It may be subject to changes in the future!
1542 Command(s) to send the U-Boot bootloader before loading the images and
1543 booting them. This option can be given multiple times. After sending
1544 commands from each option novaboot waits for U-Boot I<prompt>.
1548 =head2 Target interaction phase
1550 In this phase, target's serial output is redirected to stdout and if
1551 stdin is a TTY, it is redirected to the target's serial input allowing
1552 interactive work with the target.
1556 =item --exiton=I<string>
1558 When I<string> is sent by the target, novaboot exits. This option can
1559 be specified multiple times.
1561 If I<string> is C<-re>, then the next B<--exiton>'s I<string> is
1562 treated as regular expression. For example:
1564 --exiton -re --exiton 'error:.*failed'
1566 =item -i, --interactive
1568 Setup things for interactive use of target. Your terminal will be
1569 switched to raw mode. In raw mode, your system does not process input
1570 in any way (no echoing of entered characters, no interpretation
1571 special characters). This, among others, means that Ctrl-C is passed
1572 to the target and does no longer interrupt novaboot. Use "~~."
1573 sequence to exit novaboot.
1575 =item --expect=I<string>
1577 When I<string> is received from the target, send the string specified
1578 with the subsequent B<--send*> option to the target.
1580 =item --expect-re=I<regex>
1582 When target's output matches regular expression I<regex>, send the
1583 string specified with the subsequent B<--send*> option to the target.
1585 =item --expect-raw=I<perl-code>
1587 Provides direct control over Perl's Expect module.
1589 =item --send=I<string>
1591 Send I<string> to the target after the previously specified
1592 B<--expect*> was matched in the target's output. The I<string> may
1593 contain escape sequences such as "\n".
1595 Note that I<string> is actually interpreted by Perl, so it can contain
1596 much more that escape sequences. This behavior may change in the
1599 Example: C<--expect='login: ' --send='root\n'>
1601 =item --sendcont=I<string>
1603 Similar to B<--send> but continue expecting more input.
1605 Example: C<--expect='Continue?' --sendcont='yes\n'>
1609 =head1 NOVABOOT SCRIPT SYNTAX
1611 The syntax tries to mimic POSIX shell syntax. The syntax is defined
1612 with the following rules.
1614 Lines starting with "#" and empty lines are ignored.
1616 Lines that end with "\" are concatenated with the following line after
1617 removal of the final "\" and leading whitespace of the following line.
1619 Lines of the form I<VARIABLE=...> (i.e. matching '^[A-Z_]+=' regular
1620 expression) assign values to internal variables. See L</VARIABLES>
1623 Lines starting with C<load> keyword represent modules to boot. The
1624 word after C<load> is a file name (relative to the build directory
1625 (see B<--build-dir>) of the module to load and the remaining words are
1626 passed to it as the command line parameters.
1628 When the C<load> line ends with "<<WORD" then the subsequent lines
1629 until the line containing solely WORD are copied literally to the file
1630 named on that line. This is similar to shell's heredoc feature.
1632 When the C<load> line ends with "< CMD" then command CMD is executed
1633 with F</bin/sh> and its standard output is stored in the file named on
1634 that line. The SRCDIR variable in CMD's environment is set to the
1635 absolute path of the directory containing the interpreted novaboot
1638 Lines starting with C<run> keyword contain shell commands that are run
1639 during file generation phase. This is the same as the "< CMD" syntax
1640 for C<load> keyboard except that the command's output is not
1641 redirected to a file. The ordering of commands is the same as they
1642 appear in the novaboot script.
1646 #!/usr/bin/env novaboot
1647 load bzImage console=ttyS0,115200
1648 run make -C buildroot
1649 load rootfs.cpio < gen_cpio buildroot/images/rootfs.cpio "myapp->/etc/init.d/S99myapp"
1651 Example (NOVA User Land - NUL):
1653 #!/usr/bin/env novaboot
1654 WVDESC=Example program
1655 load bin/apps/sigma0.nul S0_DEFAULT script_start:1,1 \
1656 verbose hostkeyb:0,0x60,1,12,2
1657 load bin/apps/hello.nul
1658 load hello.nulconfig <<EOF
1659 sigma0::mem:16 name::/s0/log name::/s0/timer name::/s0/fs/rom ||
1660 rom://bin/apps/hello.nul
1663 This example will load three modules: F<sigma0.nul>, F<hello.nul> and
1664 F<hello.nulconfig>. sigma0 receives some command line parameters and
1665 F<hello.nulconfig> file is generated on the fly from the lines between
1666 C<<<EOF> and C<EOF>.
1670 The following variables are interpreted in the novaboot script:
1676 Novaboot chdir()s to this directory before file generation phase. The
1677 directory name specified here is relative to the build directory
1678 specified by other means (see L</--build-dir>).
1682 Assigning this variable has the same effect as specifying L</--exiton>
1685 =item HYPERVISOR_PARAMS
1687 Parameters passed to hypervisor. The default value is "serial", unless
1688 overridden in configuration file.
1692 The kernel to use instead of the hypervisor specified in the
1693 configuration file with the C<$hypervisor> variable. The value should
1694 contain the name of the kernel image as well as its command line
1695 parameters. If this variable is defined and non-empty, the variable
1696 HYPERVISOR_PARAMS is not used.
1700 Use a specific qemu binary (can be overridden with B<-Q>) and flags
1701 when booting this script under qemu. If QEMU_FLAGS variable is also
1702 specified flags specified in QEMU variable are replaced by those in
1707 Use specific qemu flags (can be overridden with B<-q>).
1711 Description of the wvtest-compliant program.
1713 =item WVTEST_TIMEOUT
1715 The timeout in seconds for WvTest harness. If no complete line appears
1716 in the test output within the time specified here, the test fails. It
1717 is necessary to specify this for long running tests that produce no
1718 intermediate output.
1722 =head1 CONFIGURATION FILE
1724 Novaboot can read its configuration from one or more files. By
1725 default, novaboot looks for files named F<.novaboot> as described in
1726 L</Configuration reading phase>. Alternatively, configuration file
1727 location can be specified with the B<-c> switch or with the
1728 NOVABOOT_CONFIG environment variable. The configuration file has perl
1729 syntax and should set values of certain Perl variables. The current
1730 configuration can be dumped with the B<--dump-config> switch. Some
1731 configuration variables can be overridden by environment variables
1732 (see below) or by command line switches.
1734 Supported configuration variables include:
1740 Build directory location relative to the location of the configuration
1743 =item $default_target
1745 Default target (see below) to use when no target is explicitly
1746 specified on command line with the B<--target> option.
1750 Hash of target definitions to be used with the B<--target> option. The
1751 key is the identifier of the target, the value is the string with
1752 command line options. For instance, if the configuration file contains:
1754 $targets{'mybox'} = '--server=boot:/tftproot --serial=/dev/ttyUSB0 --grub',
1756 then the following two commands are equivalent:
1758 ./script --server=boot:/tftproot --serial=/dev/ttyUSB0 --grub
1763 =head1 ENVIRONMENT VARIABLES
1765 Some options can be specified not only via config file or command line
1766 but also through environment variables. Environment variables override
1767 the values from configuration file and command line parameters
1768 override the environment variables.
1772 =item NOVABOOT_CONFIG
1774 Name of the novaboot configuration file to use instead of the default
1777 =item NOVABOOT_CONFIG_DIR
1779 Name of the novaboot configuration directory. When not specified
1780 F</etc/novaboot.d> is used.
1782 =item NOVABOOT_BENDER
1784 Defining this variable has the same meaning as B<--bender> option.
1790 Michal Sojka <sojka@os.inf.tu-dresden.de>