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 "ryu" => '--uboot --uboot-init="mw f0000b00 \${psc_cfg}; sleep 1" --uboot-addr kernel=800000 --uboot-addr ramdisk=b00000 --uboot-addr fdt=7f0000',
51 "ryuglab" => '--target ryu --server=pc-sojkam.felk.cvut.cz:/srv/tftp --remote-cmd="ssh -tt pc-sojkam.felk.cvut.cz \"sterm -d -s 115200 /dev/ttyUSB0\""',
52 "ryulocal" => '--target ryu --dhcp-tftp --serial --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
69 die("ERROR: Failure compiling '$cfg' - $@");
70 } elsif (! defined($rc)) {
71 die("ERROR: Failure reading '$cfg' - $!");
73 die("ERROR: Failure processing '$cfg'");
76 $builddir = File::Spec->rel2abs($CFG::builddir, dirname($cfg)) if defined $CFG::builddir;
77 print STDERR "novaboot: Read $cfg\n";
82 # We don't use $0 here, because it points to the novaboot itself and
83 # not to the novaboot script. The problem with this approach is that
84 # when a script is run as "novaboot <options> <script>" then $ARGV[0]
85 # contains the first option. Hence the -f check.
86 my $dir = File::Spec->rel2abs($ARGV[0] && -f $ARGV[0] ? dirname($ARGV[0]) : '', $invocation_dir);
87 while ((-d $dir || -l $dir ) && $dir ne "/") {
88 push @cfgs, "$dir/.novaboot" if -r "$dir/.novaboot";
89 my @dirs = File::Spec->splitdir($dir);
90 $dir = File::Spec->catdir(@dirs[0..$#dirs-1]);
92 @cfgs = reverse @cfgs;
93 $dir = $ENV{'NOVABOOT_CONFIG_DIR'} || '/etc/novaboot.d';
94 if (opendir(my $dh, $dir)) {
95 my @etccfg = map { "$dir/$_" } grep { /^[-_a-zA-Z0-9]+$/ && -f "$dir/$_" } readdir($dh);
97 @etccfg = sort(@etccfg);
98 @cfgs = ( @etccfg, @cfgs );
101 my $cfg = $ENV{'NOVABOOT_CONFIG'};
102 Getopt::Long::Configure(qw/no_ignore_case pass_through/);
103 GetOptions ("config|c=s" => \$cfg);
104 read_config($_) foreach $cfg or @cfgs;
106 ## Command line handling
109 GetOptions ("target|t=s" => \$explicit_target);
111 my ($amt, @append, $bender, @chainloaders, $concat, $config_name_opt, $dhcp_tftp, $dump_opt, $dump_config, @exiton, $exiton_timeout, @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, $reset_cmd, $rom_prefix, $rsync_flags, @scriptmod, $scons, $serial, $server, $stty, $tftp, $tftp_port, $uboot, %uboot_addr, @uboot_init);
114 $rom_prefix = 'rom://';
115 $stty = 'raw -crtscts -onlcr 115200';
116 $reset = 1; # Reset target by default
118 my @expect_seen = ();
122 push(@expect_seen, '-re') if $n eq "expect-re";
123 push(@expect_seen, $v);
129 unless (@expect_seen) { die("No --expect before --send"); }
130 my $ret = ($n eq "sendcont") ? exp_continue : 0;
131 unshift(@expect_raw, sub { shift->send(eval("\"$v\"")); $ret; });
132 unshift(@expect_raw, @expect_seen);
139 "append|a=s" => \@append,
140 "bender|b" => \$bender,
141 "build-dir=s" => sub { my ($n, $v) = @_; $builddir = File::Spec->rel2abs($v); },
142 "concat" => \$concat,
143 "chainloader=s" => \@chainloaders,
144 "dhcp-tftp|d" => \$dhcp_tftp,
145 "dump" => \$dump_opt,
146 "dump-config" => \$dump_config,
147 "exiton=s" => \@exiton,
148 "exiton-timeout=i"=> \$exiton_timeout,
149 "exiton-re=s" => sub { my ($n, $v) = @_; push(@exiton, '-re', $v); },
150 "expect=s" => \&handle_expect,
151 "expect-re=s" => \&handle_expect,
152 "expect-raw=s" => sub { my ($n, $v) = @_; unshift(@expect_raw, eval($v)); },
153 "gen-only" => \$gen_only,
154 "grub|g:s" => \$grub_config,
155 "grub-preamble=s"=> \$grub_preamble,
156 "prefix|grub-prefix=s" => \$grub_prefix,
157 "grub2:s" => \$grub2_config,
158 "grub2-prolog=s" => \$grub2_prolog,
160 "iprelay=s" => \$iprelay,
161 "iso:s" => \$iso_image,
162 "kernel|k=s" => \$kernel_opt,
163 "interactive|i" => \$interactive,
164 "name=s" => \$config_name_opt,
165 "make|m:s" => \$make,
166 "no-file-gen" => \$no_file_gen,
169 "pulsar|p:s" => \$pulsar,
170 "pulsar-root=s" => \$pulsar_root,
171 "qemu|Q:s" => \$qemu,
172 "qemu-append=s" => \$qemu_append,
173 "qemu-flags|q=s" => \$qemu_flags_cmd,
174 "remote-cmd=s" => \$remote_cmd,
175 "remote-expect=s"=> \$remote_expect,
177 "reset-cmd=s" => \$reset_cmd,
178 "rsync-flags=s" => \$rsync_flags,
179 "scons:s" => \$scons,
180 "scriptmod=s" => \@scriptmod,
181 "send=s" => \&handle_send,
182 "sendcont=s" => \&handle_send,
183 "serial|s:s" => \$serial,
184 "server:s" => \$server,
185 "strip-rom" => sub { $rom_prefix = ''; },
188 "tftp-port=i" => \$tftp_port,
189 "uboot:s" => \$uboot,
190 "uboot-addr=s" => \%uboot_addr,
191 "uboot-init=s" => \@uboot_init,
196 # First process target options
198 my $t = defined($explicit_target) ? $explicit_target : $CFG::default_target;
200 Getopt::Long::Configure(qw/no_ignore_case pass_through/);
202 exists $CFG::targets{$t} or die("Unknown target '$t' (valid targets are: ".join(", ", sort keys(%CFG::targets)).")");
204 undef $explicit_target;
205 my ($ret, $remaining_args) = GetOptionsFromString ($CFG::targets{$t}, ("target|t=s" => \$explicit_target));
206 if (!$ret) { die "Error parsing target $t option"; }
207 push(@target_expanded, @$remaining_args);
208 $t = $explicit_target;
210 Getopt::Long::Configure(qw/no_ignore_case no_pass_through/);
211 GetOptionsFromArray(\@target_expanded, %opt_spec) or die ("Error in target definition");
214 # Then process other command line options - some of them may override
215 # what was specified by the target
216 GetOptions %opt_spec or die("Error in command line arguments");
217 pod2usage(1) if $help;
218 pod2usage(-exitstatus => 0, -verbose => 2) if $man;
220 ### Dump sanitized configuration (if requested)
224 $Data::Dumper::Indent=1;
225 print "# This file is in perl syntax.\n";
226 foreach my $key(sort(keys(%CFG::))) { # See "Symbol Tables" in perlmod(1)
227 if (defined ${$CFG::{$key}}) { print Data::Dumper->Dump([${$CFG::{$key}}], ["*$key"]); }
228 if ( @{$CFG::{$key}}) { print Data::Dumper->Dump([\@{$CFG::{$key}}], ["*$key"]); }
229 if ( %{$CFG::{$key}}) { print Data::Dumper->Dump([\%{$CFG::{$key}}], ["*$key"]); }
235 ### Sanitize configuration
237 if ($interactive && !-t STDIN) {
238 die("novaboot: Interactive mode not supported when not on terminal");
241 if (defined $config_name_opt && scalar(@ARGV) > 1) { die "You cannot use --name with multiple scripts"; }
244 $iso_image //= ''; # IDE-R needs an ISO image
245 if (!defined $amt) { die "Error: --ider requires --amt"; }
249 if (defined $serial) {
250 $serial ||= "/dev/ttyUSB0";
251 $ENV{NB_SERIAL} = $serial;
253 if (defined $grub_config) { $grub_config ||= "menu.lst"; }
254 if (defined $grub2_config) { $grub2_config ||= "grub.cfg"; }
256 ## Parse the novaboot script(s)
261 my ($modules, $variables, $generated, $continuation) = ([], {}, []);
262 my $skip_reading = defined($on_opt) || defined($off_opt);
263 while (!$skip_reading && ($_ = <>)) {
264 if ($ARGV ne $last_fn) { # New script
265 die "Missing EOF in $last_fn" if $file;
266 die "Unfinished line in $last_fn" if $continuation;
268 push @scripts, { 'filename' => $ARGV,
269 'modules' => $modules = [],
270 'variables' => $variables = {},
271 'generated' => $generated = []};
275 next if /^#/ || /^\s*$/; # Skip comments and empty lines
277 $_ =~ s/^[[:space:]]*// if ($continuation);
279 if (/\\$/) { # Line continuation
280 $continuation .= substr($_, 0, length($_)-1);
284 if ($continuation) { # Last continuation line
285 $_ = $continuation . $_;
289 foreach my $mod(@scriptmod) { eval $mod; }
291 if ($file && $_ eq $EOF) { # Heredoc end
295 if ($file) { # Heredoc content
296 push @{$file}, "$_\n";
299 if (/^([A-Z_]+)=(.*)$/) { # Internal variable
300 $$variables{$1} = $2;
301 push(@exiton, $2) if ($1 eq "EXITON");
304 if (s/^load *//) { # Load line
305 die("novaboot: '$last_fn' line $.: Missing file name\n") unless /^[^ <]+/;
306 if (/^([^ ]*)(.*?)[[:space:]]*<<([^ ]*)$/) { # Heredoc start
307 push @$modules, "$1$2";
309 push @$generated, {filename => $1, content => $file};
313 if (/^([^ ]*)(.*?)[[:space:]]*< ?(.*)$/) { # Command substitution
314 push @$modules, "$1$2";
315 push @$generated, {filename => $1, command => $3};
321 if (/^run (.*)/) { # run line
322 push @$generated, {command => $1};
325 if (/^uboot(?::([0-9]+)s)? (.*)/) { # uboot line
326 # TODO: If U-Boot supports some interactive menu, it might
327 # make sense to store uboot lines per novaboot script.
328 if ($1) { # Command with explicit timeout
329 push @uboot_init, { command => $2,
331 } else { # Command without explicit timeout
332 push @uboot_init, $2;
337 die("novaboot: Cannot parse script '$last_fn' line $.. Didn't you forget 'load' keyword?\n");
340 # print Dumper(\@scripts);
342 foreach my $script (@scripts) {
343 $modules = $$script{modules};
344 @$modules[0] =~ s/^[^ ]*/$kernel_opt/ if $kernel_opt;
345 @$modules[0] .= ' ' . join(' ', @append) if @append;
348 if (exists $variables->{KERNEL}) {
349 $kernel = $variables->{KERNEL};
351 if ($CFG::hypervisor) {
352 $kernel = $CFG::hypervisor . " ";
353 if (exists $variables->{HYPERVISOR_PARAMS}) {
354 $kernel .= $variables->{HYPERVISOR_PARAMS};
356 $kernel .= $CFG::hypervisor_params;
360 @$modules = ($kernel, @$modules) if $kernel;
361 @$modules = (@chainloaders, @$modules);
362 @$modules = ("bin/boot/bender", @$modules) if ($bender || defined $ENV{'NOVABOOT_BENDER'});
366 foreach my $script (@scripts) {
367 print join("\n", @{$$script{modules}})."\n";
374 sub generate_configs($$$) {
375 my ($base, $generated, $filename) = @_;
376 if ($base) { $base = "$base/"; };
377 foreach my $g(@$generated) {
378 if (exists $$g{content}) {
379 my $config = $$g{content};
380 my $fn = $$g{filename};
381 open(my $f, '>', $fn) || die("$fn: $!");
382 map { s|\brom://([^ ]*)|$rom_prefix$base$1|g; print $f "$_"; } @{$config};
384 print "novaboot: Created $fn\n";
385 } elsif (exists $$g{command} && ! $no_file_gen) {
386 $ENV{SRCDIR} = dirname(File::Spec->rel2abs( $filename, $invocation_dir ));
387 if (exists $$g{filename}) {
388 system_verbose("( $$g{command} ) > $$g{filename}");
390 system_verbose($$g{command});
396 sub generate_grub_config($$$$;$)
398 my ($filename, $title, $base, $modules_ref, $preamble) = @_;
399 if ($base) { $base = "$base/"; };
400 open(my $fg, '>', $filename) or die "$filename: $!";
401 print $fg "$preamble\n" if $preamble;
402 print $fg "title $title\n" if $title;
403 #print $fg "root $base\n"; # root doesn't really work for (nd)
405 foreach (@$modules_ref) {
408 my ($kbin, $kcmd) = split(' ', $_, 2);
409 $kcmd = '' if !defined $kcmd;
410 print $fg "kernel ${base}$kbin $kcmd\n";
412 s|\brom://([^ ]*)|$rom_prefix$base$1|g; # Translate rom:// files - needed for vdisk parameter of sigma0
413 print $fg "module $base$_\n";
417 print("novaboot: Created $builddir/$filename\n");
421 sub generate_syslinux_config($$$$)
423 my ($filename, $title, $base, $modules_ref) = @_;
424 if ($base && $base !~ /\/$/) { $base = "$base/"; };
425 open(my $fg, '>', $filename) or die "$filename: $!";
426 print $fg "LABEL $title\n";
427 #TODO print $fg "MENU LABEL $human_readable_title\n";
429 my ($kbin, $kcmd) = split(' ', @$modules_ref[0], 2);
431 if (system("file $kbin|grep 'Linux kernel'") == 0) {
432 my $initrd = @$modules_ref[1];
433 die('To many "load" lines for Linux kernel') if (scalar @$modules_ref > 2);
434 print $fg "LINUX $base$kbin\n";
435 print $fg "APPEND $kcmd\n";
436 print $fg "INITRD $base$initrd\n";
438 print $fg "KERNEL mboot.c32\n";
440 foreach (@$modules_ref) {
441 s|\brom://([^ ]*)|$rom_prefix$base$1|g; # Translate rom:// files - needed for vdisk parameter of sigma0
442 push @append, "$base$_";
443 print $fg "APPEND ".join(' --- ', @append)."\n";
446 #TODO print $fg "TEXT HELP\n";
447 #TODO print $fg "some help here\n";
448 #TODO print $fg "ENDTEXT\n";
450 print("novaboot: Created $builddir/$filename\n");
454 sub generate_grub2_config($$$$;$$)
456 my ($filename, $title, $base, $modules_ref, $preamble, $prolog) = @_;
457 if ($base && substr($base,-1,1) ne '/') { $base = "$base/"; };
458 open(my $fg, '>', $filename) or die "$filename: $!";
459 print $fg "$preamble\n" if $preamble;
460 $title ||= 'novaboot';
461 print $fg "menuentry $title {\n";
462 print $fg "$prolog\n" if $prolog;
464 foreach (@$modules_ref) {
467 my ($kbin, $kcmd) = split(' ', $_, 2);
468 $kcmd = '' if !defined $kcmd;
469 print $fg " multiboot ${base}$kbin $kcmd\n";
472 # GRUB2 doesn't pass filename in multiboot info so we have to duplicate it here
473 $_ = join(' ', ($args[0], @args));
474 s|\brom://|$rom_prefix|g; # We do not need to translate path for GRUB2
475 print $fg " module $base$_\n";
480 print("novaboot: Created $builddir/$filename\n");
484 sub generate_pulsar_config($$)
486 my ($filename, $modules_ref) = @_;
487 open(my $fg, '>', $filename) or die "$filename: $!";
488 print $fg "root $pulsar_root\n" if defined $pulsar_root;
491 foreach (@$modules_ref) {
494 ($kbin, $kcmd) = split(' ', $_, 2);
495 $kcmd = '' if !defined $kcmd;
498 s|\brom://|$rom_prefix|g;
499 print $fg "load $_\n";
502 # Put kernel as last - this is needed for booting Linux and has no influence on non-Linux OSes
503 print $fg "exec $kbin $kcmd\n";
505 print("novaboot: Created $builddir/$filename\n");
509 sub shell_cmd_string(@)
511 return join(' ', map((/^[-_=a-zA-Z0-9\/\.\+]+$/ ? "$_" : "'$_'"), @_));
516 print "novaboot: Running: ".shell_cmd_string(@_)."\n";
518 exit(1); # should not be reached
521 sub system_verbose($)
524 print "novaboot: Running: $cmd\n";
525 my $ret = system($cmd);
526 if ($ret & 0x007f) { die("Command terminated by a signal"); }
527 if ($ret & 0xff00) {die("Command exit with non-zero exit code"); }
528 if ($ret) { die("Command failure $ret"); }
533 if (exists $variables->{WVDESC}) {
534 print "Testing \"$variables->{WVDESC}\" in $last_fn:\n";
535 } elsif ($last_fn =~ /\.wv$/) {
536 print "Testing \"all\" in $last_fn:\n";
539 ## Connect to the target and check whether it is not occupied
541 # We have to do this before file generation phase, because file
542 # generation is intermixed with file deployment phase and we want to
543 # check whether the target is not used by somebody else before
544 # deploying files. Otherwise, we may rewrite other user's files on a
547 my $exp; # Expect object to communicate with the target over serial line
549 my ($target_reset, $target_power_on, $target_power_off);
550 my ($amt_user, $amt_password, $amt_host, $amt_port);
552 if (defined $iprelay) {
554 $iprelay =~ /([.0-9]+)(:([0-9]+))?/;
557 my $paddr = sockaddr_in($port, inet_aton($addr));
558 my $proto = getprotobyname('tcp');
559 socket($IPRELAY, PF_INET, SOCK_STREAM, $proto) || die "socket: $!";
560 print "novaboot: Connecting to IP relay... ";
561 connect($IPRELAY, $paddr) || die "connect: $!";
563 $exp = Expect->init(\*$IPRELAY);
567 print $exp "\xFF\xF6"; # AYT
568 my $connected = $exp->expect(20, # Timeout in seconds
569 '<iprelayd: connected>',
570 '-re', '<WEB51 HW[^>]*>');
575 my ($relay, $onoff) = @_;
576 die unless ($relay == 1 || $relay == 2);
578 my $cmd = ($relay == 1 ? 0x5 : 0x6) | ($onoff ? 0x20 : 0x10);
579 return "\xFF\xFA\x2C\x32".chr($cmd)."\xFF\xF0";
583 my ($relay, $onoff) = @_;
584 die unless ($relay == 1 || $relay == 2);
585 my $cmd = ($relay == 1 ? 0xdf : 0xbf) | ($onoff ? 0x00 : 0xff);
586 return "\xFF\xFA\x2C\x97".chr($cmd)."\xFF\xF0";
590 my ($relay, $onoff, $can_giveup) = @_;
591 my $confirmation = '';
593 print $exp relaycmd($relay, $onoff);
594 my $confirmed = $exp->expect(20, # Timeout in seconds
595 relayconf($relay, $onoff));
598 print("Relay confirmation timeout - ignoring\n");
600 die "Relay confirmation timeout";
606 $target_reset = sub {
607 relay(2, 1, 1); # Reset the machine
612 $target_power_off = sub {
613 relay(1, 1); # Press power button
614 usleep(6000000); # Long press to switch off
618 $target_power_on = sub {
619 relay(1, 1); # Press power button
620 usleep(100000); # Short press
626 system_verbose("stty -F $serial $stty");
627 open($CONN, "+<", $serial) || die "open $serial: $!";
628 $exp = Expect->init(\*$CONN);
630 elsif ($remote_cmd) {
631 print "novaboot: Running: $remote_cmd\n";
632 $exp = Expect->spawn($remote_cmd);
634 elsif (defined $amt) {
635 require LWP::UserAgent;
636 require LWP::Authen::Digest;
639 my ($host, $username, $password, $schema, $className, $pstate) = @_;
640 #AMT numbers for PowerStateChange (MNI => bluescreen on windows;-)
641 my %pstates = ("on" => 2,
648 <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">
649 <s:Header><a:To>http://$host:16992/wsman</a:To>
650 <w:ResourceURI s:mustUnderstand="true">$schema</w:ResourceURI>
651 <a:ReplyTo><a:Address s:mustUnderstand="true">http://schemas.xmlsoap.org/ws/2004/08/addressing/role/anonymous</a:Address></a:ReplyTo>
652 <a:Action s:mustUnderstand="true">$schema$className</a:Action>
653 <w:MaxEnvelopeSize s:mustUnderstand="true">153600</w:MaxEnvelopeSize>
654 <a:MessageID>uuid:709072C9-609C-4B43-B301-075004043C7C</a:MessageID>
655 <w:Locale xml:lang="en-US" s:mustUnderstand="false" />
656 <w:OperationTimeout>PT60.000S</w:OperationTimeout>
657 <w:SelectorSet><w:Selector Name="Name">Intel(r) AMT Power Management Service</w:Selector></w:SelectorSet>
659 <p:RequestPowerStateChange_INPUT xmlns:p="http://schemas.dmtf.org/wbem/wscim/1/cim-schema/2/CIM_PowerManagementService">
660 <p:PowerState>$pstates{$pstate}</p:PowerState>
661 <p:ManagedElement><a:Address>http://$host:16992/wsman</a:Address>
662 <a:ReferenceParameters><w:ResourceURI>http://schemas.dmtf.org/wbem/wscim/1/cim-schema/2/CIM_ComputerSystem</w:ResourceURI>
663 <w:SelectorSet><w:Selector Name="Name">ManagedSystem</w:Selector></w:SelectorSet>
664 </a:ReferenceParameters></p:ManagedElement>
665 </p:RequestPowerStateChange_INPUT>
666 </s:Body></s:Envelope>
671 my ($host, $username, $password, $content) = @_;
673 my $ua = LWP::UserAgent->new();
674 $ua->agent("novaboot");
676 my $req = HTTP::Request->new(POST => "http://$host:16992/wsman");
677 my $res = $ua->request($req);
678 die ("Unexpected AMT response: " . $res->status_line) unless $res->code == 401;
680 my ($realm) = $res->header("WWW-Authenticate") =~ /Digest realm="(.*?)"/;
681 $ua->credentials("$host:16992", $realm, $username => $password);
684 $req = HTTP::Request->new(POST => "http://$host:16992/wsman");
685 $req->content_type('application/x-www-form-urlencoded');
686 $req->content($content);
687 $res = $ua->request($req);
688 die ("AMT power change request failed: " . $res->status_line) unless $res->is_success;
689 $res->content() =~ /<g:ReturnValue>(\d+)<\/g:ReturnValue>/;
694 my ($host, $username, $password, $pstate)=@_;
695 my $schema="http://schemas.dmtf.org/wbem/wscim/1/cim-schema/2/CIM_PowerManagementService";
696 my $className="/RequestPowerStateChange";
697 my $content = genXML($host, $username, $password ,$schema, $className, $pstate);
698 return sendPOST($host, $username, $password, $content);
701 ($amt_user,$amt_password,$amt_host,$amt_port) = ($amt =~ /(?:(.*?)(?::(.*))?@)?([^:]*)(?::([0-9]*))?/);;
702 $amt_user ||= "admin";
703 $amt_password ||= $ENV{'AMT_PASSWORD'} || die "AMT password not specified";
704 $amt_host || die "AMT host not specified";
708 $target_power_off = sub {
710 my $result = powerChange($amt_host,$amt_user,$amt_password, "off");
711 die "AMT power off failed (ReturnValue $result)" if $result != 0;
714 $target_power_on = sub {
715 my $result = powerChange($amt_host,$amt_user,$amt_password, "on");
716 die "AMT power on failed (ReturnValue $result)" if $result != 0;
719 $target_reset = sub {
720 my $result = powerChange($amt_host,$amt_user,$amt_password, "reset");
722 print STDERR "Warning: Cannot reset $amt_host, trying power on. ";
723 $result = powerChange($amt_host,$amt_user,$amt_password, "on");
725 die "AMT reset failed (ReturnValue $result)" if $result != 0;
728 my $cmd = "amtterm -u $amt_user -p $amt_password $amt_host $amt_port";
729 print "novaboot: Running: $cmd\n" =~ s/\Q$amt_password\E/???/r;
730 $exp = Expect->spawn($cmd);
731 $exp->expect(10, "RUN_SOL") || die "Expect for 'RUN_SOL' timed out";
736 if ($remote_expect) {
737 $exp || die("No serial line connection");
738 $exp->expect(180, $remote_expect) || die "Expect for '$remote_expect' timed out";
741 if (defined $reset_cmd) {
742 $target_reset = sub {
743 system_verbose($reset_cmd);
747 if (defined $on_opt && defined $target_power_on) {
751 if (defined $off_opt && defined $target_power_off) {
752 print "novaboot: Switching the target off...\n";
753 &$target_power_off();
757 $builddir ||= dirname(File::Spec->rel2abs( ${$scripts[0]}{filename})) if scalar @scripts;
758 if (defined $builddir) {
759 chdir($builddir) or die "Can't change directory to $builddir: $!";
760 print "novaboot: Entering directory `$builddir'\n";
762 $builddir = $invocation_dir;
765 ## File generation phase
766 my (%files_iso, $menu_iso, $filename);
767 my $config_name = '';
770 foreach my $script (@scripts) {
771 $filename = $$script{filename};
772 $modules = $$script{modules};
773 $generated = $$script{generated};
774 $variables = $$script{variables};
776 ($config_name = $filename) =~ s#.*/##;
777 $config_name = $config_name_opt if (defined $config_name_opt);
779 if (exists $variables->{BUILDDIR}) {
780 $builddir = File::Spec->rel2abs($variables->{BUILDDIR});
781 chdir($builddir) or die "Can't change directory to $builddir: $!";
782 print "novaboot: Entering directory `$builddir'\n";
786 $prefix = $grub_prefix;
787 $prefix =~ s/\$NAME/$config_name/;
788 $prefix =~ s/\$BUILDDIR/$builddir/;
790 # TODO: use $grub_prefix as first parameter if some switch is given
791 generate_configs('', $generated, $filename);
793 ### Generate bootloader configuration files
794 my @bootloader_configs;
795 push @bootloader_configs, generate_grub_config($grub_config, $config_name, $prefix, $modules, $grub_preamble) if (defined $grub_config);
796 push @bootloader_configs, generate_grub2_config($grub2_config, $config_name, $prefix, $modules, $grub_preamble, $grub2_prolog) if (defined $grub2_config);
797 push @bootloader_configs, generate_pulsar_config('config-'.($pulsar||'novaboot'), $modules) if (defined $pulsar);
799 ### Run scons or make
801 my @files = map({ ($file) = m/([^ ]*)/; $file; } @$modules);
802 # Filter-out generated files
803 my @to_build = grep({ my $file = $_; !scalar(grep($file eq ($$_{filename} || ''), @$generated)) } @files);
805 system_verbose($scons || $CFG::scons." ".join(" ", @to_build)) if (defined $scons);
806 system_verbose($make || $CFG::make ." ".join(" ", @to_build)) if (defined $make);
809 ### Copy files (using rsync)
810 if (defined $server && !defined($gen_only)) {
811 (my $real_server = $server) =~ s/\$NAME/$config_name/;
813 my ($hostname, $path) = split(":", $real_server, 2);
814 if (! defined $path) {
818 my $files = join(" ", map({ ($file) = m/([^ ]*)/; $file; } ( @$modules, @bootloader_configs)));
819 map({ my $file = (split)[0]; die "$file: $!" if ! -f $file; } @$modules);
820 my $istty = -t STDOUT && ($ENV{'TERM'} || 'dumb') ne 'dumb';
821 my $progress = $istty ? "--progress" : "";
822 system_verbose("rsync $progress -RLp $rsync_flags $files $real_server");
823 if ($server =~ m|/\$NAME$| && $concat) {
824 my $cmd = join("; ", map { "( cd $path/.. && cat */$_ > $_ )" } @bootloader_configs);
825 system_verbose($hostname ? "ssh $hostname '$cmd'" : $cmd);
829 ### Prepare ISO image generation
830 if (defined $iso_image) {
831 generate_configs("(cd)", $generated, $filename);
833 generate_syslinux_config(\$menu, $config_name, "/", $modules);
834 $menu_iso .= "$menu\n";
835 map { ($file,undef) = split; $files_iso{$file} = 1; } @$modules;
839 ## Generate ISO image
840 if (defined $iso_image) {
841 system_verbose("mkdir -p isolinux");
844 if (-f '/usr/lib/ISOLINUX/isolinux.bin') {
845 # Newer ISOLINUX version
846 @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);
848 # Older ISOLINUX version
849 @files = qw(/usr/lib/syslinux/isolinux.bin /usr/lib/syslinux/mboot.c32 /usr/lib/syslinux/menu.c32);
851 system_verbose("cp @files isolinux");
852 open(my $fh, ">isolinux/isolinux.cfg");
854 print $fh "TIMEOUT 50\n";
855 print $fh "DEFAULT menu\n";
857 print $fh "DEFAULT $config_name\n";
859 print $fh "$menu_iso";
862 my $files = join(" ", map("$_=$_", (keys(%files_iso), 'isolinux/isolinux.cfg', map(s|.*/|isolinux/|r, @files))));
863 $iso_image ||= "$config_name.iso";
865 # Note: We use -U flag below to "Allow 'untranslated' filenames,
866 # completely violating the ISO9660 standards". Without this
867 # option, isolinux is not able to read files names for example
869 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");
870 print("ISO image created: $builddir/$iso_image\n");
873 exit(0) if defined $gen_only;
875 ## Boot the system using various methods and send serial output to stdout
877 if (scalar(@scripts) > 1 && ( defined $dhcp_tftp || defined $serial || defined $iprelay)) {
878 die "You cannot do this with multiple scripts simultaneously";
881 if ($variables->{WVTEST_TIMEOUT}) {
882 print "wvtest: timeout ", $variables->{WVTEST_TIMEOUT}, "\n";
887 $str =~ s/^\s+|\s+$//g;
895 $qemu ||= $variables->{QEMU} || $CFG::qemu;
896 my @qemu_flags = split(" ", $qemu);
897 $qemu = shift(@qemu_flags);
899 @qemu_flags = split(/ +/, trim($variables->{QEMU_FLAGS})) if exists $variables->{QEMU_FLAGS};
900 @qemu_flags = split(/ +/, trim($qemu_flags_cmd)) if $qemu_flags_cmd;
901 push(@qemu_flags, split(/ +/, trim($qemu_append || '')));
903 if (defined $iso_image) {
904 # Boot NOVA with grub (and test the iso image)
905 push(@qemu_flags, ('-cdrom', $iso_image));
907 # Boot NOVA without GRUB
909 # Non-patched qemu doesn't like commas, but NUL can live with pluses instead of commans
910 foreach (@$modules) {s/,/+/g;}
911 generate_configs("", $generated, $filename);
913 if (scalar @$modules) {
914 my ($kbin, $kcmd) = split(' ', shift(@$modules), 2);
915 $kcmd = '' if !defined $kcmd;
917 @$modules = map { if (/\.dtb$/) { $dtb=$_; (); } else { $_ } } @$modules;
918 my $initrd = join ",", @$modules;
920 push(@qemu_flags, ('-kernel', $kbin, '-append', $kcmd));
921 push(@qemu_flags, ('-initrd', $initrd)) if $initrd;
922 push(@qemu_flags, ('-dtb', $dtb)) if $dtb;
925 push(@qemu_flags, qw(-serial stdio)); # Redirect serial output (for collecting test restuls)
926 unshift(@qemu_flags, ('-name', $config_name));
927 print "novaboot: Running: ".shell_cmd_string($qemu, @qemu_flags)."\n";
928 $exp = Expect->spawn(($qemu, @qemu_flags)) || die("exec() failed: $!");
931 ### Local DHCPD and TFTPD
933 my ($dhcpd_pid, $tftpd_pid);
935 $tftp=1 if $tftp_port;
937 if (defined $dhcp_tftp)
939 generate_configs("(nd)", $generated, $filename);
940 system_verbose('mkdir -p tftpboot');
941 generate_grub_config("tftpboot/os-menu.lst", $config_name, "(nd)", \@$modules, "timeout 0");
942 open(my $fh, '>', 'dhcpd.conf');
943 my $mac = `cat /sys/class/net/eth0/address`;
945 print $fh "subnet 10.23.23.0 netmask 255.255.255.0 {
946 range 10.23.23.10 10.23.23.100;
947 filename \"bin/boot/grub/pxegrub.pxe\";
948 next-server 10.23.23.1;
951 hardware ethernet $mac;
952 fixed-address 10.23.23.1;
955 system_verbose("sudo ip a add 10.23.23.1/24 dev eth0;
956 sudo ip l set dev eth0 up;
957 sudo touch dhcpd.leases");
959 # We run servers by forking ourselves, because the servers end up
960 # in our process group and get killed by signals sent to the
961 # process group (e.g. Ctrl-C on terminal).
963 exec_verbose("sudo dhcpd -d -cf dhcpd.conf -lf dhcpd.leases -pf dhcpd.pid") if ($dhcpd_pid == 0);
966 if (defined $dhcp_tftp || defined $tftp) {
968 # Unfortunately, tftpd requires root privileges even with
969 # non-privileged (>1023) port due to initgroups().
970 system_verbose("sudo in.tftpd --listen --secure -v -v -v --pidfile tftpd.pid --address :$tftp_port $builddir");
972 # Kill server when we die
973 $SIG{__DIE__} = sub { system_verbose('sudo pkill --pidfile=dhcpd.pid') if (defined $dhcp_tftp);
974 system_verbose('sudo pkill --pidfile=tftpd.pid'); };
976 # We have to kill tftpd explicitely, because it is not in our process group
977 $SIG{INT} = sub { system_verbose('sudo pkill --pidfile=tftpd.pid'); exit(0); };
982 my $ider_cmd= "amtider -c $iso_image -u $amt_user -p $amt_password $amt_host $amt_port" ;
983 print "novaboot: Running: $ider_cmd\n" =~ s/\Q$amt_password\E/???/r;
984 my $ider_pid = fork();
985 if ($ider_pid == 0) {
987 die "IDE redirection failed";
989 # FIXME: This collides with --tftp option. Hopefully, nobody needs
990 # to use both simultaneously.
991 $SIG{__DIE__} = sub { system_verbose('kill $ider_pid'); };
994 ### Reset target (IP relay, AMT, ...)
996 if (defined $target_reset && $reset) {
997 print "novaboot: Reseting the test box... ";
1002 ### U-boot conversation
1003 if (defined $uboot) {
1004 my $uboot_prompt = $uboot || '=> ';
1005 print "novaboot: Waiting for U-Boot prompt...\n";
1006 $exp || die("No serial line connection");
1007 $exp->log_stdout(1);
1008 #$exp->exp_internal(1);
1010 [qr/Hit any key to stop autoboot:/, sub { $exp->send("\n"); exp_continue; }],
1011 $uboot_prompt) || die "No U-Boot prompt deteceted";
1012 foreach my $cmdspec (@uboot_init) {
1013 my ($cmd, $timeout);
1014 if (ref($cmdspec) eq "HASH") {
1015 $cmd = $cmdspec->{command};
1016 $timeout = $cmdspec->{timeout};
1021 if ($cmd =~ /\$NB_MYIP/) {
1022 my $ip = (grep /inet /, `ip addr show eth0`)[0] || die "Problem determining our IP address";
1023 $ip =~ s/\s*inet ([0-9.]*).*/$1/;
1024 $cmd =~ s/\$NB_MYIP/$ip/g;
1026 if ($cmd =~ /\$NB_PREFIX/) {
1029 $cmd =~ s/\$NB_PREFIX/$p/g;
1032 $exp->send("$cmd\n");
1033 $exp->expect($timeout, $uboot_prompt) || die "U-Boot prompt timeout";
1036 # Boot the system if there are some load lines in the script
1037 if (scalar(@$modules) > 0 && !$variables->{NO_BOOT}) {
1038 my ($kbin, $kcmd) = split(' ', shift(@$modules), 2);
1040 @$modules = map { if (/\.dtb$/) { $dtb=$_; (); } else { $_ } } @$modules;
1041 my $initrd = shift @$modules;
1043 die "No '--uboot-addr kernel' given" unless $uboot_addr{kernel};
1044 $exp->send("tftpboot $uboot_addr{kernel} $prefix$kbin\n");
1046 [qr/##/, sub { exp_continue; }],
1047 $uboot_prompt) || die "Kernel load timeout";
1049 die "No '--uboot-addr fdt' given" unless $uboot_addr{fdt};
1050 $exp->send("tftpboot $uboot_addr{fdt} $prefix$dtb\n");
1052 [qr/##/, sub { exp_continue; }],
1053 $uboot_prompt) || die "Device tree load timeout";
1055 if (defined $initrd) {
1056 die "No '--uboot-addr ramdisk' given" unless $uboot_addr{ramdisk};
1057 $exp->send("tftpboot $uboot_addr{ramdisk} $prefix$initrd\n");
1059 [qr/#/, sub { exp_continue; }],
1060 $uboot_prompt) || die "Initrd load timeout";
1062 $uboot_addr{ramdisk} = '-';
1064 $exp->send("echo $kcmd\n");
1065 $exp->expect(1, '-re', qr{echo .*\n(.*)\n$uboot_prompt}) || die "Command line test timeout";
1066 my $args = ($exp->matchlist)[0];
1067 if ($args =~ /^setenv\s+bootargs/) {
1068 $exp->send("$args\n");
1070 $exp->send("setenv bootargs $kcmd\n");
1072 $exp->expect(5, $uboot_prompt) || die "U-Boot prompt timeout";
1073 $exp->send("bootm $uboot_addr{kernel} $uboot_addr{ramdisk} $uboot_addr{fdt}\n");
1074 $exp->expect(5, "\n") || die "U-Boot command timeout";
1078 ### Serial line interaction
1080 # Serial line of the target is available
1081 my $interrupt = 'Ctrl-C';
1082 if ($interactive && !@exiton) {
1083 $interrupt = '"~~."';
1085 my $note = (-t STDIN) ? '' : '- only target->host ';
1086 print "novaboot: Serial line interaction $note(press $interrupt to interrupt)...\n";
1087 $exp->log_stdout(1);
1089 $exp->expect($exiton_timeout, @expect_raw, @exiton) || die("exiton timeout");
1091 my @inputs = ($exp);
1092 if (-t STDIN) { # Set up bi-directional communication if we run on terminal
1093 my $infile = new IO::File;
1094 $infile->IO::File::fdopen(*STDIN,'r');
1095 my $in_object = Expect->exp_init($infile);
1096 $in_object->set_group($exp);
1099 $in_object->set_seq('~~\.', sub { print "novaboot: Escape sequence detected\r\n"; undef; });
1100 $in_object->manual_stty(0); # Use raw terminal mode
1102 $in_object->manual_stty(1); # Do not modify terminal settings
1104 push(@inputs, $in_object);
1107 #print Dumper(\@expect_raw);
1108 $exp->expect(undef, @expect_raw) if @expect_raw;
1109 Expect::interconnect(@inputs) unless defined($exp->exitstatus);
1113 ## Kill dhcpc or tftpd
1114 if (defined $dhcp_tftp || defined $tftp) {
1115 die("novaboot: This should kill servers on background\n");
1122 novaboot - Boots a locally compiled operating system on a remote
1129 B<novaboot> [option]... [--] script...
1131 B<./script> [option]...
1135 This program makes booting of a locally compiled operating system (OS)
1136 (e.g. NOVA or Linux) on remote targets as simple as running a program
1137 locally. It automates things like copying OS images to a TFTP server,
1138 generation of bootloader configuration files, resetting of target
1139 hardware or redirection of target's serial line to stdin/out. Novaboot
1140 is highly configurable and it makes it easy to boot a single image on
1141 different targets or different images on a single target.
1143 Novaboot operation is controlled by command line options and by a so
1144 called novaboot script, which can be thought as a generalization of
1145 bootloader configuration files (see L</"NOVABOOT SCRIPT SYNTAX">).
1146 Typical way of using novaboot is to make the novaboot script
1147 executable and set its first line to I<#!/usr/bin/env novaboot>. Then,
1148 booting a particular OS configuration becomes the same as executing a
1149 local program - the novaboot script.
1151 Novaboot uses configuration files to, among other things, define
1152 command line options needed for different targets. Users typically use
1153 only the B<-t>/B<--target> command line option to select the target.
1154 Internally, this option expands to the pre-configured options.
1155 Configuration files are searched at multiple places, which allows to
1156 have per-system, per-user or per-project configurations. Configuration
1157 file syntax is described in section L</"CONFIGURATION FILE">.
1159 Simple examples of using C<novaboot>:
1165 Run an OS in Qemu. This is the default action when no other action is
1166 specified by command line switches. Thus running C<novaboot myos> (or
1167 C<./myos> as described above) will run Qemu and make it boot the
1168 configuration specified in the F<myos> script.
1172 Create a bootloader configuration file (currently supported
1173 bootloaders are GRUB, GRUB2, ISOLINUX, Pulsar and U-Boot) and copy it
1174 with all other files needed for booting to a remote boot server. Then
1175 use a TCP/IP-controlled relay/serial-to-TCP converter to reset the
1176 target and receive its serial output.
1178 ./myos --grub2 --server=192.168.1.1:/tftp --iprelay=192.168.1.2
1182 Run DHCP and TFTP server on developer's machine to boot the target
1187 This is useful when no network infrastructure is in place and
1188 the target is connected directly to developer's box.
1192 Create bootable ISO image.
1194 novaboot --iso -- script1 script2
1196 The created ISO image will have ISOLINUX bootloader installed on it
1197 and the boot menu will allow selecting between I<script1> and
1198 I<script2> configurations.
1202 =head1 PHASES AND OPTIONS
1204 Novaboot performs its work in several phases. Each phase can be
1205 influenced by several command line options, certain phases can be
1206 skipped. The list of phases (in the execution order) and the
1207 corresponding options follows.
1209 =head2 Configuration reading phase
1211 After starting, novaboot reads configuration files. Their content is
1212 described in section L</"CONFIGURATION FILE">. By default,
1213 configuration is read from two locations. First from the configuration
1214 directory and second from F<.novaboot> files along the path to the
1215 current directory. The latter read files override settings from the
1218 Configuration directory is determined by the content of
1219 NOVABOOT_CONFIG_DIR environment variable and defaults to
1220 F</etc/novaboot.d>. Files in this directory with names consisting
1221 solely of English letters, numbers, dashes '-' and underscores '_'
1222 (note that dot '.' is not included) are read in alphabetical order.
1224 Then novaboot searches for files named F<.novaboot> starting from the
1225 directory of the novaboot script (or working directory, see bellow)
1226 and continuing upwards up to the root directory. The found
1227 configuration files are then read in the opposite order (i.e. from the
1228 root directory downwards). This allows to have, for example, user
1229 specific configuration in F<~/.novaboot> and project specific one in
1230 F<~/project/.novaboot>.
1232 In certain cases, the location of the novaboot script cannot be
1233 determined in this early phase. This happens either when the script is
1234 read from the standard input or when novaboot is invoked explicitly as
1235 in the example L</"4."> above. In this case the current working
1236 directory is used as a starting point for configuration file search
1237 instead of the novaboot script directory.
1241 =item -c, --config=I<filename>
1243 Use the specified configuration file instead of the default one(s).
1247 =head2 Command line processing phase
1253 Dump the current configuration to stdout end exit. Useful as an
1254 initial template for a configuration file.
1258 Print short (B<-h>) or long (B<--help>) help.
1260 =item -t, --target=I<target>
1262 This option serves as a user configurable shortcut for other novaboot
1263 options. The effect of this option is the same as the options stored
1264 in the C<%targets> configuration variable under key I<target>. See
1265 also L</"CONFIGURATION FILE">.
1269 =head2 Script preprocessing phase
1271 This phases allows to modify the parsed novaboot script before it is
1272 used in the later phases.
1276 =item -a, --append=I<parameters>
1278 Append a string to the first C<load> line in the novaboot script. This
1279 can be used to append parameters to the kernel's or root task's
1280 command line. This option can appear multiple times.
1284 Use F<bender> chainloader. Bender scans the PCI bus for PCI serial
1285 ports and stores the information about them in the BIOS data area for
1288 =item --chainloader=I<chainloader>
1290 Specifies a chainloader that is loaded before the kernel and other
1291 files specified in the novaboot script. E.g. 'bin/boot/bender
1296 Print the modules to boot and their parameters after this phase
1297 finishes. Then exit. This is useful for seeing the effect of other
1298 options in this section.
1300 =item -k, --kernel=F<file>
1302 Replace the first word on the first C<load> line in the novaboot
1303 script with F<file>.
1305 =item --scriptmod=I<perl expression>
1307 When novaboot script is read, I<perl expression> is executed for every
1308 line (in $_ variable). For example, C<novaboot
1309 --scriptmod=s/sigma0/omega6/g> replaces every occurrence of I<sigma0>
1310 in the script with I<omega6>.
1312 When this option is present, it overrides I<$script_modifier> variable
1313 from the configuration file, which has the same effect. If this option
1314 is given multiple times all expressions are evaluated in the command
1319 =head2 File generation phase
1321 In this phase, files needed for booting are generated in a so called
1322 I<build directory> (see L</--build-dir>). In most cases configuration
1323 for a bootloader is generated automatically by novaboot. It is also
1324 possible to generate other files using I<heredoc> or I<"<"> syntax in
1325 novaboot scripts. Finally, binaries can be generated in this phases by
1326 running C<scons> or C<make>.
1330 =item --build-dir=I<directory>
1332 Overrides the default build directory location.
1334 The default build directory location is determined as follows: If the
1335 configuration file defines the C<$builddir> variable, its value is
1336 used. Otherwise, it is the directory that contains the first processed
1339 See also L</BUILDDIR> variable.
1341 =item -g, --grub[=I<filename>]
1343 Generates grub bootloader menu file. If the I<filename> is not
1344 specified, F<menu.lst> is used. The I<filename> is relative to the
1345 build directory (see B<--build-dir>).
1347 =item --grub-preamble=I<prefix>
1349 Specifies the I<preable> that is at the beginning of the generated
1350 GRUB or GRUB2 config files. This is useful for specifying GRUB's
1353 =item --prefix=I<prefix>
1355 Specifies I<prefix> (e.g. F</srv/tftp>) that is put in front of every
1356 file name in generated bootloader configuration files (or in U-Boot
1359 If the I<prefix> contains string $NAME, it will be replaced with the
1360 name of the novaboot script (see also B<--name>).
1362 If the I<prefix> contains string $BUILDDIR, it will be replaced with
1363 the build directory (see also B<--build-dir>).
1367 Alias for B<--prefix>.
1369 =item --grub2[=I<filename>]
1371 Generate GRUB2 menu entry in I<filename>. If I<filename> is not
1372 specified F<grub.cfg> is used. The content of the menu entry can be
1373 customized with B<--grub-preamble>, B<--grub2-prolog> or
1374 B<--grub_prefix> options.
1376 In order to use the the generated menu entry on your development
1377 machine that uses GRUB2, append the following snippet to
1378 F</etc/grub.d/40_custom> file and regenerate your grub configuration,
1379 i.e. run update-grub on Debian/Ubuntu.
1381 if [ -f /path/to/nul/build/grub.cfg ]; then
1382 source /path/to/nul/build/grub.cfg
1385 =item --grub2-prolog=I<prolog>
1387 Specifies text that is put at the beginning of the GRUB2 menu entry.
1389 =item -m, --make[=make command]
1391 Runs C<make> to build files that are not generated by novaboot itself.
1393 =item --name=I<string>
1395 Use the name I<string> instead of the name of the novaboot script.
1396 This name is used for things like a title of grub menu or for the
1397 server directory where the boot files are copied to.
1401 Do not run external commands to generate files (i.e. "<" syntax and
1402 C<run> keyword). This switch does not influence generation of files
1403 specified with "<<WORD" syntax.
1405 =item -p, --pulsar[=mac]
1407 Generates pulsar bootloader configuration file named F<config-I<mac>>
1408 The I<mac> string is typically a MAC address and defaults to
1411 =item --scons[=scons command]
1413 Runs C<scons> to build files that are not generated by novaboot
1418 Strip I<rom://> prefix from command lines and generated config files.
1419 The I<rom://> prefix is used by NUL. For NRE, it has to be stripped.
1423 Exit novaboot after file generation phase.
1427 =head2 Target connection check
1429 If supported by the target, the connection to it is made and it is
1430 checked whether the target is not occupied by another novaboot
1435 =item --amt=I<"[user[:password]@]host[:port]>
1437 Use Intel AMT technology to control the target machine. WS management
1438 is used to powercycle it and Serial-Over-Lan (SOL) for input/output.
1439 The hostname or (IP address) is given by the I<host> parameter. If
1440 I<password> is not specified, environment variable AMT_PASSWORD is
1441 used. The I<port> specifies a TCP port for SOL. If not specified, the
1442 default is 16992. Default I<user> is admin.
1444 =item --iprelay=I<addr[:port]>
1446 Use TCP/IP relay and serial port to access the target's serial port
1447 and powercycle it. The IP address of the relay is given by I<addr>
1448 parameter. If I<port> is not specified, it default to 23.
1450 Note: This option is supposed to work with HWG-ER02a IP relays.
1452 =item -s, --serial[=device]
1454 Target's serial line is connected to host's serial line (device). The
1455 default value for device is F</dev/ttyUSB0>.
1457 The value of this option is exported in NB_NOVABOOT environment
1458 variable to all subprocesses run by C<novaboot>.
1460 =item --stty=I<settings>
1462 Specifies settings passed to C<stty> invoked on the serial line
1463 specified with B<--serial> option. If this option is not given,
1464 C<stty> is called with C<raw -crtscts -onlcr 115200> settings.
1466 =item --remote-cmd=I<cmd>
1468 Command that mediates connection to the target's serial line. For
1469 example C<ssh server 'cu -l /dev/ttyS0'>.
1471 =item --remote-expect=I<string>
1473 Wait for reception of I<string> after establishing the the remote
1474 connection before continuing.
1479 =head2 File deployment phase
1481 In some setups, it is necessary to copy the files needed for booting
1482 to a particular location, e.g. to a TFTP boot server or to the
1487 =item -d, --dhcp-tftp
1489 Turns your workstation into a DHCP and TFTP server so that the OS can
1490 be booted via PXE BIOS (or similar mechanism) on the test machine
1491 directly connected by a plain Ethernet cable to your workstation.
1493 The DHCP and TFTP servers requires root privileges and C<novaboot>
1494 uses C<sudo> command to obtain those. You can put the following to
1495 I</etc/sudoers> to allow running the necessary commands without asking
1498 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
1499 your_login ALL=NOPASSWD: NOVABOOT
1503 Starts a TFTP server on your workstation. This is similar to
1504 B<--dhcp-tftp> except that DHCP server is not started.
1506 The TFTP server require root privileges and C<novaboot> uses C<sudo>
1507 command to obtain those. You can put the following to I</etc/sudoers>
1508 to allow running the necessary commands without asking for password.
1510 Cmnd_Alias NOVABOOT = /usr/sbin/in.tftpd --listen --secure -v -v -v --pidfile tftpd.pid *, /usr/bin/pkill --pidfile=tftpd.pid
1511 your_login ALL=NOPASSWD: NOVABOOT
1513 =item --tftp-port=I<port>
1515 Port to run the TFTP server on. Implies B<--tftp>.
1517 =item --iso[=filename]
1519 Generates the ISO image that boots NOVA system via GRUB. If no filename
1520 is given, the image is stored under I<NAME>.iso, where I<NAME> is the name
1521 of the novaboot script (see also B<--name>).
1523 =item --server[=[[user@]server:]path]
1525 Copy all files needed for booting to another location. The files will
1526 be copied (by B<rsync> tool) to the directory I<path>. If the I<path>
1527 contains string $NAME, it will be replaced with the name of the
1528 novaboot script (see also B<--name>).
1530 =item --rsync-flags=I<flags>
1532 Specifies which I<flags> are appended to F<rsync> command line when
1533 copying files as a result of I<--server> option.
1537 If B<--server> is used and its value ends with $NAME, then after
1538 copying the files, a new bootloader configuration file (e.g. menu.lst)
1539 is created at I<path-wo-name>, i.e. the path specified by B<--server>
1540 with $NAME part removed. The content of the file is created by
1541 concatenating all files of the same name from all subdirectories of
1542 I<path-wo-name> found on the "server".
1546 Use Intel AMT technology for IDE redirection. This allows the target
1547 machine to boot from novaboot created ISO image. Implies B<--iso>.
1549 The experimental C<amtider> utility needed by this option can be
1550 obtained from https://github.com/wentasah/amtterm.
1554 =head2 Target power-on and reset phase
1556 At this point, the target is reset (or switched on/off). There is
1557 several ways how this can be accomplished. Resetting a physical target
1558 can currently be accomplished by the following options: B<--amt>,
1559 B<--iprelay>, B<--reset-cmd>.
1565 Switch on/off the target machine and exit. The script (if any) is
1566 completely ignored. Currently it works only with B<--iprelay> or
1569 =item -Q, --qemu[=I<qemu-binary>]
1571 Boot the configuration in qemu. Optionally, the name of qemu binary
1572 can be specified as a parameter.
1574 =item --qemu-append=I<flags>
1576 Append I<flags> to the default qemu flags (QEMU_FLAGS variable or
1577 C<-cpu coreduo -smp 2>).
1579 =item -q, --qemu-flags=I<flags>
1581 Replace the default qemu flags (QEMU_FLAGS variable or C<-cpu coreduo
1582 -smp 2>) with I<flags> specified here.
1584 =item --reset-cmd=I<cmd>
1586 Command that resets the target.
1588 =item --no-reset, --reset
1590 Disable/enable reseting of the target.
1594 =head2 Interaction with the bootloader on the target
1598 =item --uboot[=I<prompt>]
1600 Interact with U-Boot bootloader to boot the thing described in the
1601 novaboot script. I<prompt> specifies the U-Boot's prompt (default is
1602 "=> ", other common prompts are "U-Boot> " or "U-Boot# ").
1603 Implementation of this option is currently tied to a particular board
1604 that we use. It may be subject to changes in the future!
1608 Command(s) to send the U-Boot bootloader before loading the images and
1609 booting them. This option can be given multiple times. After sending
1610 commands from each option novaboot waits for U-Boot I<prompt>.
1612 If the command contains string I<$NB_MYIP> then this string is
1613 replaced by IPv4 address of eth0 interface. Similarly I<$NB_PREFIX> is
1614 replaced with prefix given by B<--prefix>.
1616 See also C<uboot> keyword in L</"NOVABOOT SCRIPT SYNTAX">).
1618 =item --uboot-addr I<name>=I<address>
1620 Load address of U-Boot's C<tftpboot> command for loading I<name>,
1621 where name is one of I<kernel>, I<ramdisk> or I<fdt> (flattened device
1626 =head2 Target interaction phase
1628 In this phase, target's serial output is redirected to stdout and if
1629 stdin is a TTY, it is redirected to the target's serial input allowing
1630 interactive work with the target.
1634 =item --exiton=I<string>
1636 When I<string> is sent by the target, novaboot exits. This option can
1637 be specified multiple times, in which case novaboot exits whenever
1638 either of the specified strings is sent.
1640 If I<string> is C<-re>, then the next B<--exiton>'s I<string> is
1641 treated as regular expression. For example:
1643 --exiton -re --exiton 'error:.*failed'
1645 =item --exiton-re=I<regex>
1647 The same as --exiton -re --exiton I<regex>.
1649 =item --exiton-timeout=I<seconds>
1651 By default B<--exiton> waits for the string match forever. When this
1652 option is specified, "exiton" timeouts after the specifies number of
1653 seconds and novaboot returns non-zero exit code.
1655 =item -i, --interactive
1657 Setup things for interactive use of target. Your terminal will be
1658 switched to raw mode. In raw mode, your system does not process input
1659 in any way (no echoing of entered characters, no interpretation
1660 special characters). This, among others, means that Ctrl-C is passed
1661 to the target and does no longer interrupt novaboot. Use "~~."
1662 sequence to exit novaboot.
1664 =item --expect=I<string>
1666 When I<string> is received from the target, send the string specified
1667 with the subsequent B<--send*> option to the target.
1669 =item --expect-re=I<regex>
1671 When target's output matches regular expression I<regex>, send the
1672 string specified with the subsequent B<--send*> option to the target.
1674 =item --expect-raw=I<perl-code>
1676 Provides direct control over Perl's Expect module.
1678 =item --send=I<string>
1680 Send I<string> to the target after the previously specified
1681 B<--expect*> was matched in the target's output. The I<string> may
1682 contain escape sequences such as "\n".
1684 Note that I<string> is actually interpreted by Perl, so it can contain
1685 much more that escape sequences. This behavior may change in the
1688 Example: C<--expect='login: ' --send='root\n'>
1690 =item --sendcont=I<string>
1692 Similar to B<--send> but continue expecting more input.
1694 Example: C<--expect='Continue?' --sendcont='yes\n'>
1698 =head1 NOVABOOT SCRIPT SYNTAX
1700 The syntax tries to mimic POSIX shell syntax. The syntax is defined
1701 with the following rules.
1703 Lines starting with "#" and empty lines are ignored.
1705 Lines that end with "\" are concatenated with the following line after
1706 removal of the final "\" and leading whitespace of the following line.
1708 Lines of the form I<VARIABLE=...> (i.e. matching '^[A-Z_]+=' regular
1709 expression) assign values to internal variables. See L</VARIABLES>
1712 Lines starting with C<load> keyword represent modules to boot. The
1713 word after C<load> is a file name (relative to the build directory
1714 (see B<--build-dir>) of the module to load and the remaining words are
1715 passed to it as the command line parameters.
1717 When the C<load> line ends with "<<WORD" then the subsequent lines
1718 until the line containing solely WORD are copied literally to the file
1719 named on that line. This is similar to shell's heredoc feature.
1721 When the C<load> line ends with "< CMD" then command CMD is executed
1722 with F</bin/sh> and its standard output is stored in the file named on
1723 that line. The SRCDIR variable in CMD's environment is set to the
1724 absolute path of the directory containing the interpreted novaboot
1727 Lines starting with C<run> keyword contain shell commands that are run
1728 during file generation phase. This is the same as the "< CMD" syntax
1729 for C<load> keyboard except that the command's output is not
1730 redirected to a file. The ordering of commands is the same as they
1731 appear in the novaboot script.
1733 Lines starting with C<uboot> represent U-Boot commands that are sent
1734 to the target if B<--uboot> option is given. Having a U-Boot line in
1735 the novaboot script is the same as passing an equivalent
1736 B<--uboot-init> option to novaboot. The C<uboot> keyword can be
1737 suffixed with timeout specification. The syntax is C<uboot:Ns>, where
1738 C<N> is the whole number of seconds. If the U-Boot command prompt does
1739 not appear before the timeout, novaboot fails. The default timeout is
1744 #!/usr/bin/env novaboot
1745 load bzImage console=ttyS0,115200
1746 run make -C buildroot
1747 load rootfs.cpio < gen_cpio buildroot/images/rootfs.cpio "myapp->/etc/init.d/S99myapp"
1749 Example (NOVA User Land - NUL):
1751 #!/usr/bin/env novaboot
1752 WVDESC=Example program
1753 load bin/apps/sigma0.nul S0_DEFAULT script_start:1,1 \
1754 verbose hostkeyb:0,0x60,1,12,2
1755 load bin/apps/hello.nul
1756 load hello.nulconfig <<EOF
1757 sigma0::mem:16 name::/s0/log name::/s0/timer name::/s0/fs/rom ||
1758 rom://bin/apps/hello.nul
1761 This example will load three modules: F<sigma0.nul>, F<hello.nul> and
1762 F<hello.nulconfig>. sigma0 receives some command line parameters and
1763 F<hello.nulconfig> file is generated on the fly from the lines between
1764 C<<<EOF> and C<EOF>.
1768 The following variables are interpreted in the novaboot script:
1774 Novaboot chdir()s to this directory before file generation phase. The
1775 directory name specified here is relative to the build directory
1776 specified by other means (see L</--build-dir>).
1780 Assigning this variable has the same effect as specifying L</--exiton>
1783 =item HYPERVISOR_PARAMS
1785 Parameters passed to hypervisor. The default value is "serial", unless
1786 overridden in configuration file.
1790 The kernel to use instead of the hypervisor specified in the
1791 configuration file with the C<$hypervisor> variable. The value should
1792 contain the name of the kernel image as well as its command line
1793 parameters. If this variable is defined and non-empty, the variable
1794 HYPERVISOR_PARAMS is not used.
1798 If this variable is 1, the system is not booted. This is currently
1799 only implemented for U-Boot bootloader where it is useful for
1800 interacting with the bootloader without booting the system - e.g. for
1805 Use a specific qemu binary (can be overridden with B<-Q>) and flags
1806 when booting this script under qemu. If QEMU_FLAGS variable is also
1807 specified flags specified in QEMU variable are replaced by those in
1812 Use specific qemu flags (can be overridden with B<-q>).
1816 Description of the WvTest-compliant program.
1818 =item WVTEST_TIMEOUT
1820 The timeout in seconds for WvTest harness. If no complete line appears
1821 in the test output within the time specified here, the test fails. It
1822 is necessary to specify this for long running tests that produce no
1823 intermediate output.
1827 =head1 CONFIGURATION FILE
1829 Novaboot can read its configuration from one or more files. By
1830 default, novaboot looks for files in F</etc/novaboot.d> and files
1831 named F<.novaboot> as described in L</Configuration reading phase>.
1832 Alternatively, configuration file location can be specified with the
1833 B<-c> switch or with the NOVABOOT_CONFIG environment variable. The
1834 configuration file has Perl syntax (i.e. it is better to put C<1;> as
1835 a last line) and should set values of certain Perl variables. The
1836 current configuration can be dumped with the B<--dump-config> switch.
1837 Some configuration variables can be overridden by environment
1838 variables (see below) or by command line switches.
1840 Supported configuration variables include:
1846 Build directory location relative to the location of the configuration
1849 =item $default_target
1851 Default target (see below) to use when no target is explicitly
1852 specified on command line with the B<--target> option.
1856 Hash of target definitions to be used with the B<--target> option. The
1857 key is the identifier of the target, the value is the string with
1858 command line options. For instance, if the configuration file contains:
1860 $targets{'mybox'} = '--server=boot:/tftproot --serial=/dev/ttyUSB0 --grub',
1862 then the following two commands are equivalent:
1864 ./myos --server=boot:/tftproot --serial=/dev/ttyUSB0 --grub
1869 =head1 ENVIRONMENT VARIABLES
1871 Some options can be specified not only via config file or command line
1872 but also through environment variables. Environment variables override
1873 the values from configuration file and command line parameters
1874 override the environment variables.
1878 =item NOVABOOT_CONFIG
1880 Name of the novaboot configuration file to use instead of the default
1883 =item NOVABOOT_CONFIG_DIR
1885 Name of the novaboot configuration directory. When not specified
1886 F</etc/novaboot.d> is used.
1888 =item NOVABOOT_BENDER
1890 Defining this variable has the same meaning as B<--bender> option.
1896 Michal Sojka <sojka@os.inf.tu-dresden.de>
1900 # LocalWords: novaboot Novaboot NOVABOOT TFTP PXE DHCP filename stty
1901 # LocalWords: chainloader stdout Qemu qemu preprocessing ISOLINUX bootable
1902 # LocalWords: config subprocesses sudo sudoers tftp dhcp IDE stdin
1903 # LocalWords: subdirectories TTY whitespace heredoc POSIX WvTest