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;
94 my $xdg_config_home = $ENV{'XDG_CONFIG_HOME'} || $ENV{'HOME'}.'/.config';
95 unshift(@cfgs, "$xdg_config_home/novaboot") if -r "$xdg_config_home/novaboot";
97 $dir = $ENV{'NOVABOOT_CONFIG_DIR'} || '/etc/novaboot.d';
98 if (opendir(my $dh, $dir)) {
99 my @etccfg = map { "$dir/$_" } grep { /^[-_a-zA-Z0-9]+$/ && -f "$dir/$_" } readdir($dh);
101 @etccfg = sort(@etccfg);
102 @cfgs = ( @etccfg, @cfgs );
105 my $cfg = $ENV{'NOVABOOT_CONFIG'};
106 Getopt::Long::Configure(qw/no_ignore_case pass_through/);
107 GetOptions ("config|c=s" => \$cfg);
108 read_config($_) foreach $cfg or @cfgs;
110 ## Command line handling
113 GetOptions ("target|t=s" => \$explicit_target);
115 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_cmd, @uboot_init);
118 'kernel' => '${kernel_addr_r}',
119 'ramdisk' => '${ramdisk_addr_r}',
120 'fdt' => '${fdt_addr_r}',
124 $rom_prefix = 'rom://';
125 $stty = 'raw -crtscts -onlcr 115200';
126 $reset = 1; # Reset target by default
128 my @expect_seen = ();
132 push(@expect_seen, '-re') if $n eq "expect-re";
133 push(@expect_seen, $v);
139 unless (@expect_seen) { die("No --expect before --send"); }
140 my $ret = ($n eq "sendcont") ? exp_continue : 0;
141 unshift(@expect_raw, sub { shift->send(eval("\"$v\"")); $ret; });
142 unshift(@expect_raw, @expect_seen);
149 "append|a=s" => \@append,
150 "bender|b" => \$bender,
151 "build-dir=s" => sub { my ($n, $v) = @_; $builddir = File::Spec->rel2abs($v); },
152 "concat" => \$concat,
153 "chainloader=s" => \@chainloaders,
154 "dhcp-tftp|d" => \$dhcp_tftp,
155 "dump" => \$dump_opt,
156 "dump-config" => \$dump_config,
157 "exiton=s" => \@exiton,
158 "exiton-timeout=i"=> \$exiton_timeout,
159 "exiton-re=s" => sub { my ($n, $v) = @_; push(@exiton, '-re', $v); },
160 "expect=s" => \&handle_expect,
161 "expect-re=s" => \&handle_expect,
162 "expect-raw=s" => sub { my ($n, $v) = @_; unshift(@expect_raw, eval($v)); },
163 "gen-only" => \$gen_only,
164 "grub|g:s" => \$grub_config,
165 "grub-preamble=s"=> \$grub_preamble,
166 "prefix|grub-prefix=s" => \$grub_prefix,
167 "grub2:s" => \$grub2_config,
168 "grub2-prolog=s" => \$grub2_prolog,
170 "iprelay=s" => \$iprelay,
171 "iso:s" => \$iso_image,
172 "kernel|k=s" => \$kernel_opt,
173 "interactive|i" => \$interactive,
174 "name=s" => \$config_name_opt,
175 "make|m:s" => \$make,
176 "no-file-gen" => \$no_file_gen,
179 "pulsar|p:s" => \$pulsar,
180 "pulsar-root=s" => \$pulsar_root,
181 "qemu|Q:s" => \$qemu,
182 "qemu-append=s" => \$qemu_append,
183 "qemu-flags|q=s" => \$qemu_flags_cmd,
184 "remote-cmd=s" => \$remote_cmd,
185 "remote-expect=s"=> \$remote_expect,
187 "reset-cmd=s" => \$reset_cmd,
188 "rsync-flags=s" => \$rsync_flags,
189 "scons:s" => \$scons,
190 "scriptmod=s" => \@scriptmod,
191 "send=s" => \&handle_send,
192 "sendcont=s" => \&handle_send,
193 "serial|s:s" => \$serial,
194 "server:s" => \$server,
195 "strip-rom" => sub { $rom_prefix = ''; },
198 "tftp-port=i" => \$tftp_port,
199 "uboot:s" => \$uboot,
200 "no-uboot" => sub { undef $uboot; },
201 "uboot-addr=s" => \%uboot_addr,
202 "uboot-cmd=s" => \$uboot_cmd,
203 "uboot-init=s" => \@uboot_init,
208 # First process target options
210 my $t = defined($explicit_target) ? $explicit_target : $CFG::default_target;
212 Getopt::Long::Configure(qw/no_ignore_case pass_through/);
214 exists $CFG::targets{$t} or die("Unknown target '$t' (valid targets are: ".join(", ", sort keys(%CFG::targets)).")");
216 undef $explicit_target;
217 my ($ret, $remaining_args) = GetOptionsFromString ($CFG::targets{$t}, ("target|t=s" => \$explicit_target));
218 if (!$ret) { die "Error parsing target $t option"; }
219 push(@target_expanded, @$remaining_args);
220 $t = $explicit_target;
222 Getopt::Long::Configure(qw/no_ignore_case no_pass_through/);
223 GetOptionsFromArray(\@target_expanded, %opt_spec) or die ("Error in target definition");
226 # Then process other command line options - some of them may override
227 # what was specified by the target
228 GetOptions %opt_spec or die("Error in command line arguments");
229 pod2usage(1) if $help;
230 pod2usage(-exitstatus => 0, -verbose => 2) if $man;
232 ### Dump sanitized configuration (if requested)
236 $Data::Dumper::Indent=1;
237 print "# This file is in perl syntax.\n";
238 foreach my $key(sort(keys(%CFG::))) { # See "Symbol Tables" in perlmod(1)
239 if (defined ${$CFG::{$key}}) { print Data::Dumper->Dump([${$CFG::{$key}}], ["*$key"]); }
240 if ( @{$CFG::{$key}}) { print Data::Dumper->Dump([\@{$CFG::{$key}}], ["*$key"]); }
241 if ( %{$CFG::{$key}}) { print Data::Dumper->Dump([\%{$CFG::{$key}}], ["*$key"]); }
247 ### Sanitize configuration
249 if ($interactive && !-t STDIN) {
250 die("novaboot: Interactive mode not supported when not on terminal");
253 if (defined $config_name_opt && scalar(@ARGV) > 1) { die "You cannot use --name with multiple scripts"; }
256 $iso_image //= ''; # IDE-R needs an ISO image
257 if (!defined $amt) { die "Error: --ider requires --amt"; }
261 my %input_opts = ('--iprelay' => \$iprelay,
262 '--serial' => \$serial,
263 '--remote-cmd' => \$remote_cmd,
265 my @opts = grep(defined(${$input_opts{$_}}) , keys %input_opts);
267 die("novaboot: More than one target connection option: ".join(', ', @opts)) if scalar @opts > 1;
271 if (defined $serial) {
272 $serial ||= "/dev/ttyUSB0";
273 $ENV{NB_SERIAL} = $serial;
275 if (defined $grub_config) { $grub_config ||= "menu.lst"; }
276 if (defined $grub2_config) { $grub2_config ||= "grub.cfg"; }
278 ## Parse the novaboot script(s)
283 my ($modules, $variables, $generated, $continuation) = ([], {}, []);
284 my $skip_reading = defined($on_opt) || defined($off_opt);
285 while (!$skip_reading && ($_ = <>)) {
286 if ($ARGV ne $last_fn) { # New script
287 die "Missing EOF in $last_fn" if $file;
288 die "Unfinished line in $last_fn" if $continuation;
290 push @scripts, { 'filename' => $ARGV,
291 'modules' => $modules = [],
292 'variables' => $variables = {},
293 'generated' => $generated = []};
297 next if /^#/ || /^\s*$/; # Skip comments and empty lines
299 $_ =~ s/^[[:space:]]*// if ($continuation);
301 if (/\\$/) { # Line continuation
302 $continuation .= substr($_, 0, length($_)-1);
306 if ($continuation) { # Last continuation line
307 $_ = $continuation . $_;
311 foreach my $mod(@scriptmod) { eval $mod; }
313 if ($file && $_ eq $EOF) { # Heredoc end
317 if ($file) { # Heredoc content
318 push @{$file}, "$_\n";
321 if (/^([A-Z_]+)=(.*)$/) { # Internal variable
322 $$variables{$1} = $2;
323 push(@exiton, $2) if ($1 eq "EXITON");
326 if (s/^load *//) { # Load line
327 die("novaboot: '$last_fn' line $.: Missing file name\n") unless /^[^ <]+/;
328 if (/^([^ ]*)(.*?)[[:space:]]*<<([^ ]*)$/) { # Heredoc start
329 push @$modules, "$1$2";
331 push @$generated, {filename => $1, content => $file};
335 if (/^([^ ]*)(.*?)[[:space:]]*< ?(.*)$/) { # Command substitution
336 push @$modules, "$1$2";
337 push @$generated, {filename => $1, command => $3};
343 if (/^run (.*)/) { # run line
344 push @$generated, {command => $1};
347 if (/^uboot(?::([0-9]+)s)? (.*)/) { # uboot line
348 # TODO: If U-Boot supports some interactive menu, it might
349 # make sense to store uboot lines per novaboot script.
350 if ($1) { # Command with explicit timeout
351 push @uboot_init, { command => $2,
353 } else { # Command without explicit timeout
354 push @uboot_init, $2;
359 die("novaboot: Cannot parse script '$last_fn' line $.. Didn't you forget 'load' keyword?\n");
362 # print Dumper(\@scripts);
364 foreach my $script (@scripts) {
365 $modules = $$script{modules};
366 @$modules[0] =~ s/^[^ ]*/$kernel_opt/ if $kernel_opt;
367 @$modules[0] .= ' ' . join(' ', @append) if @append;
370 if (exists $variables->{KERNEL}) {
371 $kernel = $variables->{KERNEL};
373 if ($CFG::hypervisor) {
374 $kernel = $CFG::hypervisor . " ";
375 if (exists $variables->{HYPERVISOR_PARAMS}) {
376 $kernel .= $variables->{HYPERVISOR_PARAMS};
378 $kernel .= $CFG::hypervisor_params;
382 @$modules = ($kernel, @$modules) if $kernel;
383 @$modules = (@chainloaders, @$modules);
384 @$modules = ("bin/boot/bender", @$modules) if ($bender || defined $ENV{'NOVABOOT_BENDER'});
388 foreach my $script (@scripts) {
389 print join("\n", @{$$script{modules}})."\n";
396 sub generate_configs($$$) {
397 my ($base, $generated, $filename) = @_;
398 if ($base) { $base = "$base/"; };
399 foreach my $g(@$generated) {
400 if (exists $$g{content}) {
401 my $config = $$g{content};
402 my $fn = $$g{filename};
403 open(my $f, '>', $fn) || die("$fn: $!");
404 map { s|\brom://([^ ]*)|$rom_prefix$base$1|g; print $f "$_"; } @{$config};
406 print "novaboot: Created $fn\n";
407 } elsif (exists $$g{command} && ! $no_file_gen) {
408 $ENV{SRCDIR} = dirname(File::Spec->rel2abs( $filename, $invocation_dir ));
409 if (exists $$g{filename}) {
410 system_verbose("( $$g{command} ) > $$g{filename}");
412 system_verbose($$g{command});
418 sub generate_grub_config($$$$;$)
420 my ($filename, $title, $base, $modules_ref, $preamble) = @_;
421 if ($base) { $base = "$base/"; };
422 open(my $fg, '>', $filename) or die "$filename: $!";
423 print $fg "$preamble\n" if $preamble;
424 print $fg "title $title\n" if $title;
425 #print $fg "root $base\n"; # root doesn't really work for (nd)
427 foreach (@$modules_ref) {
430 my ($kbin, $kcmd) = split(' ', $_, 2);
431 $kcmd = '' if !defined $kcmd;
432 print $fg "kernel ${base}$kbin $kcmd\n";
434 s|\brom://([^ ]*)|$rom_prefix$base$1|g; # Translate rom:// files - needed for vdisk parameter of sigma0
435 print $fg "module $base$_\n";
439 print("novaboot: Created $builddir/$filename\n");
443 sub generate_syslinux_config($$$$)
445 my ($filename, $title, $base, $modules_ref) = @_;
446 if ($base && $base !~ /\/$/) { $base = "$base/"; };
447 open(my $fg, '>', $filename) or die "$filename: $!";
448 print $fg "LABEL $title\n";
449 #TODO print $fg "MENU LABEL $human_readable_title\n";
451 my ($kbin, $kcmd) = split(' ', @$modules_ref[0], 2);
453 if (system("file $kbin|grep 'Linux kernel'") == 0) {
454 my $initrd = @$modules_ref[1];
455 die('To many "load" lines for Linux kernel') if (scalar @$modules_ref > 2);
456 print $fg "LINUX $base$kbin\n";
457 print $fg "APPEND $kcmd\n";
458 print $fg "INITRD $base$initrd\n";
460 print $fg "KERNEL mboot.c32\n";
462 foreach (@$modules_ref) {
463 s|\brom://([^ ]*)|$rom_prefix$base$1|g; # Translate rom:// files - needed for vdisk parameter of sigma0
464 push @append, "$base$_";
465 print $fg "APPEND ".join(' --- ', @append)."\n";
468 #TODO print $fg "TEXT HELP\n";
469 #TODO print $fg "some help here\n";
470 #TODO print $fg "ENDTEXT\n";
472 print("novaboot: Created $builddir/$filename\n");
476 sub generate_grub2_config($$$$;$$)
478 my ($filename, $title, $base, $modules_ref, $preamble, $prolog) = @_;
479 if ($base && substr($base,-1,1) ne '/') { $base = "$base/"; };
480 open(my $fg, '>', $filename) or die "$filename: $!";
481 print $fg "$preamble\n" if $preamble;
482 $title ||= 'novaboot';
483 print $fg "menuentry $title {\n";
484 print $fg "$prolog\n" if $prolog;
486 foreach (@$modules_ref) {
489 my ($kbin, $kcmd) = split(' ', $_, 2);
490 $kcmd = '' if !defined $kcmd;
491 print $fg " multiboot ${base}$kbin $kcmd\n";
494 # GRUB2 doesn't pass filename in multiboot info so we have to duplicate it here
495 $_ = join(' ', ($args[0], @args));
496 s|\brom://|$rom_prefix|g; # We do not need to translate path for GRUB2
497 print $fg " module $base$_\n";
502 print("novaboot: Created $builddir/$filename\n");
506 sub generate_pulsar_config($$)
508 my ($filename, $modules_ref) = @_;
509 open(my $fg, '>', $filename) or die "$filename: $!";
510 print $fg "root $pulsar_root\n" if defined $pulsar_root;
513 foreach (@$modules_ref) {
516 ($kbin, $kcmd) = split(' ', $_, 2);
517 $kcmd = '' if !defined $kcmd;
520 s|\brom://|$rom_prefix|g;
521 print $fg "load $_\n";
524 # Put kernel as last - this is needed for booting Linux and has no influence on non-Linux OSes
525 print $fg "exec $kbin $kcmd\n";
527 print("novaboot: Created $builddir/$filename\n");
531 sub shell_cmd_string(@)
533 return join(' ', map((/^[-_=a-zA-Z0-9\/\.\+]+$/ ? "$_" : "'$_'"), @_));
538 print "novaboot: Running: ".shell_cmd_string(@_)."\n";
540 exit(1); # should not be reached
543 sub system_verbose($)
546 print "novaboot: Running: $cmd\n";
547 my $ret = system($cmd);
548 if ($ret & 0x007f) { die("Command terminated by a signal"); }
549 if ($ret & 0xff00) {die("Command exit with non-zero exit code"); }
550 if ($ret) { die("Command failure $ret"); }
555 if (exists $variables->{WVDESC}) {
556 print "Testing \"$variables->{WVDESC}\" in $last_fn:\n";
557 } elsif ($last_fn =~ /\.wv$/) {
558 print "Testing \"all\" in $last_fn:\n";
561 ## Connect to the target and check whether it is not occupied
563 # We have to do this before file generation phase, because file
564 # generation is intermixed with file deployment phase and we want to
565 # check whether the target is not used by somebody else before
566 # deploying files. Otherwise, we may rewrite other user's files on a
569 my $exp; # Expect object to communicate with the target over serial line
571 my ($target_reset, $target_power_on, $target_power_off);
572 my ($amt_user, $amt_password, $amt_host, $amt_port);
574 if (defined $iprelay) {
576 $iprelay =~ /([.0-9]+)(:([0-9]+))?/;
579 my $paddr = sockaddr_in($port, inet_aton($addr));
580 my $proto = getprotobyname('tcp');
581 socket($IPRELAY, PF_INET, SOCK_STREAM, $proto) || die "socket: $!";
582 print "novaboot: Connecting to IP relay... ";
583 connect($IPRELAY, $paddr) || die "connect: $!";
585 $exp = Expect->init(\*$IPRELAY);
589 print $exp "\xFF\xF6"; # AYT
590 my $connected = $exp->expect(20, # Timeout in seconds
591 '<iprelayd: connected>',
592 '-re', '<WEB51 HW[^>]*>');
597 my ($relay, $onoff) = @_;
598 die unless ($relay == 1 || $relay == 2);
600 my $cmd = ($relay == 1 ? 0x5 : 0x6) | ($onoff ? 0x20 : 0x10);
601 return "\xFF\xFA\x2C\x32".chr($cmd)."\xFF\xF0";
605 my ($relay, $onoff) = @_;
606 die unless ($relay == 1 || $relay == 2);
607 my $cmd = ($relay == 1 ? 0xdf : 0xbf) | ($onoff ? 0x00 : 0xff);
608 return "\xFF\xFA\x2C\x97".chr($cmd)."\xFF\xF0";
612 my ($relay, $onoff, $can_giveup) = @_;
613 my $confirmation = '';
615 print $exp relaycmd($relay, $onoff);
616 my $confirmed = $exp->expect(20, # Timeout in seconds
617 relayconf($relay, $onoff));
620 print("Relay confirmation timeout - ignoring\n");
622 die "Relay confirmation timeout";
628 $target_reset = sub {
629 relay(2, 1, 1); # Reset the machine
634 $target_power_off = sub {
635 relay(1, 1); # Press power button
636 usleep(6000000); # Long press to switch off
640 $target_power_on = sub {
641 relay(1, 1); # Press power button
642 usleep(100000); # Short press
648 system_verbose("stty -F $serial $stty");
649 open($CONN, "+<", $serial) || die "open $serial: $!";
650 $exp = Expect->init(\*$CONN);
652 elsif ($remote_cmd) {
653 print "novaboot: Running: $remote_cmd\n";
654 $exp = Expect->spawn($remote_cmd);
656 elsif (defined $amt) {
657 require LWP::UserAgent;
658 require LWP::Authen::Digest;
661 my ($host, $username, $password, $schema, $className, $pstate) = @_;
662 #AMT numbers for PowerStateChange (MNI => bluescreen on windows;-)
663 my %pstates = ("on" => 2,
670 <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">
671 <s:Header><a:To>http://$host:16992/wsman</a:To>
672 <w:ResourceURI s:mustUnderstand="true">$schema</w:ResourceURI>
673 <a:ReplyTo><a:Address s:mustUnderstand="true">http://schemas.xmlsoap.org/ws/2004/08/addressing/role/anonymous</a:Address></a:ReplyTo>
674 <a:Action s:mustUnderstand="true">$schema$className</a:Action>
675 <w:MaxEnvelopeSize s:mustUnderstand="true">153600</w:MaxEnvelopeSize>
676 <a:MessageID>uuid:709072C9-609C-4B43-B301-075004043C7C</a:MessageID>
677 <w:Locale xml:lang="en-US" s:mustUnderstand="false" />
678 <w:OperationTimeout>PT60.000S</w:OperationTimeout>
679 <w:SelectorSet><w:Selector Name="Name">Intel(r) AMT Power Management Service</w:Selector></w:SelectorSet>
681 <p:RequestPowerStateChange_INPUT xmlns:p="http://schemas.dmtf.org/wbem/wscim/1/cim-schema/2/CIM_PowerManagementService">
682 <p:PowerState>$pstates{$pstate}</p:PowerState>
683 <p:ManagedElement><a:Address>http://$host:16992/wsman</a:Address>
684 <a:ReferenceParameters><w:ResourceURI>http://schemas.dmtf.org/wbem/wscim/1/cim-schema/2/CIM_ComputerSystem</w:ResourceURI>
685 <w:SelectorSet><w:Selector Name="Name">ManagedSystem</w:Selector></w:SelectorSet>
686 </a:ReferenceParameters></p:ManagedElement>
687 </p:RequestPowerStateChange_INPUT>
688 </s:Body></s:Envelope>
693 my ($host, $username, $password, $content) = @_;
695 my $ua = LWP::UserAgent->new();
696 $ua->agent("novaboot");
698 my $req = HTTP::Request->new(POST => "http://$host:16992/wsman");
699 my $res = $ua->request($req);
700 die ("Unexpected AMT response: " . $res->status_line) unless $res->code == 401;
702 my ($realm) = $res->header("WWW-Authenticate") =~ /Digest realm="(.*?)"/;
703 $ua->credentials("$host:16992", $realm, $username => $password);
706 $req = HTTP::Request->new(POST => "http://$host:16992/wsman");
707 $req->content_type('application/x-www-form-urlencoded');
708 $req->content($content);
709 $res = $ua->request($req);
710 die ("AMT power change request failed: " . $res->status_line) unless $res->is_success;
711 $res->content() =~ /<g:ReturnValue>(\d+)<\/g:ReturnValue>/;
716 my ($host, $username, $password, $pstate)=@_;
717 my $schema="http://schemas.dmtf.org/wbem/wscim/1/cim-schema/2/CIM_PowerManagementService";
718 my $className="/RequestPowerStateChange";
719 my $content = genXML($host, $username, $password ,$schema, $className, $pstate);
720 return sendPOST($host, $username, $password, $content);
723 ($amt_user,$amt_password,$amt_host,$amt_port) = ($amt =~ /(?:(.*?)(?::(.*))?@)?([^:]*)(?::([0-9]*))?/);;
724 $amt_user ||= "admin";
725 $amt_password ||= $ENV{'AMT_PASSWORD'} || die "AMT password not specified";
726 $amt_host || die "AMT host not specified";
730 $target_power_off = sub {
732 my $result = powerChange($amt_host,$amt_user,$amt_password, "off");
733 die "AMT power off failed (ReturnValue $result)" if $result != 0;
736 $target_power_on = sub {
737 my $result = powerChange($amt_host,$amt_user,$amt_password, "on");
738 die "AMT power on failed (ReturnValue $result)" if $result != 0;
741 $target_reset = sub {
742 my $result = powerChange($amt_host,$amt_user,$amt_password, "reset");
744 print STDERR "Warning: Cannot reset $amt_host, trying power on. ";
745 $result = powerChange($amt_host,$amt_user,$amt_password, "on");
747 die "AMT reset failed (ReturnValue $result)" if $result != 0;
750 my $cmd = "amtterm -u $amt_user -p $amt_password $amt_host $amt_port";
751 print "novaboot: Running: $cmd\n" =~ s/\Q$amt_password\E/???/r;
752 $exp = Expect->spawn($cmd);
753 $exp->expect(10, "RUN_SOL") || die "Expect for 'RUN_SOL' timed out";
758 if ($remote_expect) {
759 $exp || die("No serial line connection");
760 $exp->expect(180, $remote_expect) || die "Expect for '$remote_expect' timed out";
763 if (defined $reset_cmd) {
764 $target_reset = sub {
765 system_verbose($reset_cmd);
769 if (defined $on_opt && defined $target_power_on) {
773 if (defined $off_opt && defined $target_power_off) {
774 print "novaboot: Switching the target off...\n";
775 &$target_power_off();
779 $builddir ||= dirname(File::Spec->rel2abs( ${$scripts[0]}{filename})) if scalar @scripts;
780 if (defined $builddir) {
781 chdir($builddir) or die "Can't change directory to $builddir: $!";
782 print "novaboot: Entering directory `$builddir'\n";
784 $builddir = $invocation_dir;
787 ## File generation phase
788 my (%files_iso, $menu_iso, $filename);
789 my $config_name = '';
792 foreach my $script (@scripts) {
793 $filename = $$script{filename};
794 $modules = $$script{modules};
795 $generated = $$script{generated};
796 $variables = $$script{variables};
798 ($config_name = $filename) =~ s#.*/##;
799 $config_name = $config_name_opt if (defined $config_name_opt);
801 if (exists $variables->{BUILDDIR}) {
802 $builddir = File::Spec->rel2abs($variables->{BUILDDIR});
803 chdir($builddir) or die "Can't change directory to $builddir: $!";
804 print "novaboot: Entering directory `$builddir'\n";
808 $prefix = $grub_prefix;
809 $prefix =~ s/\$NAME/$config_name/;
810 $prefix =~ s/\$BUILDDIR/$builddir/;
812 # TODO: use $grub_prefix as first parameter if some switch is given
813 generate_configs('', $generated, $filename);
815 ### Generate bootloader configuration files
816 my @bootloader_configs;
817 push @bootloader_configs, generate_grub_config($grub_config, $config_name, $prefix, $modules, $grub_preamble) if (defined $grub_config);
818 push @bootloader_configs, generate_grub2_config($grub2_config, $config_name, $prefix, $modules, $grub_preamble, $grub2_prolog) if (defined $grub2_config);
819 push @bootloader_configs, generate_pulsar_config('config-'.($pulsar||'novaboot'), $modules) if (defined $pulsar);
821 ### Run scons or make
823 my @files = map({ ($file) = m/([^ ]*)/; $file; } @$modules);
824 # Filter-out generated files
825 my @to_build = grep({ my $file = $_; !scalar(grep($file eq ($$_{filename} || ''), @$generated)) } @files);
827 system_verbose($scons || $CFG::scons." ".join(" ", @to_build)) if (defined $scons);
828 system_verbose($make || $CFG::make ." ".join(" ", @to_build)) if (defined $make);
831 ### Copy files (using rsync)
832 if (defined $server && !defined($gen_only)) {
833 (my $real_server = $server) =~ s/\$NAME/$config_name/;
835 my ($hostname, $path) = split(":", $real_server, 2);
836 if (! defined $path) {
840 my $files = join(" ", map({ ($file) = m/([^ ]*)/; $file; } ( @$modules, @bootloader_configs)));
841 map({ my $file = (split)[0]; die "$file: $!" if ! -f $file; } @$modules);
842 my $istty = -t STDOUT && ($ENV{'TERM'} || 'dumb') ne 'dumb';
843 my $progress = $istty ? "--progress" : "";
844 system_verbose("rsync $progress -RLp $rsync_flags $files $real_server");
845 if ($server =~ m|/\$NAME$| && $concat) {
846 my $cmd = join("; ", map { "( cd $path/.. && cat */$_ > $_ )" } @bootloader_configs);
847 system_verbose($hostname ? "ssh $hostname '$cmd'" : $cmd);
851 ### Prepare ISO image generation
852 if (defined $iso_image) {
853 generate_configs("(cd)", $generated, $filename);
855 generate_syslinux_config(\$menu, $config_name, "/", $modules);
856 $menu_iso .= "$menu\n";
857 map { ($file,undef) = split; $files_iso{$file} = 1; } @$modules;
861 ## Generate ISO image
862 if (defined $iso_image) {
863 system_verbose("mkdir -p isolinux");
866 if (-f '/usr/lib/ISOLINUX/isolinux.bin') {
867 # Newer ISOLINUX version
868 @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);
870 # Older ISOLINUX version
871 @files = qw(/usr/lib/syslinux/isolinux.bin /usr/lib/syslinux/mboot.c32 /usr/lib/syslinux/menu.c32);
873 system_verbose("cp @files isolinux");
874 open(my $fh, ">isolinux/isolinux.cfg");
876 print $fh "TIMEOUT 50\n";
877 print $fh "DEFAULT menu\n";
879 print $fh "DEFAULT $config_name\n";
881 print $fh "$menu_iso";
884 my $files = join(" ", map("$_=$_", (keys(%files_iso), 'isolinux/isolinux.cfg', map(s|.*/|isolinux/|r, @files))));
885 $iso_image ||= "$config_name.iso";
887 # Note: We use -U flag below to "Allow 'untranslated' filenames,
888 # completely violating the ISO9660 standards". Without this
889 # option, isolinux is not able to read files names for example
891 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");
892 print("ISO image created: $builddir/$iso_image\n");
895 exit(0) if defined $gen_only;
897 ## Boot the system using various methods and send serial output to stdout
899 if (scalar(@scripts) > 1 && ( defined $dhcp_tftp || defined $serial || defined $iprelay)) {
900 die "You cannot do this with multiple scripts simultaneously";
903 if ($variables->{WVTEST_TIMEOUT}) {
904 print "wvtest: timeout ", $variables->{WVTEST_TIMEOUT}, "\n";
909 $str =~ s/^\s+|\s+$//g;
917 $qemu ||= $variables->{QEMU} || $CFG::qemu;
918 my @qemu_flags = split(" ", $qemu);
919 $qemu = shift(@qemu_flags);
921 @qemu_flags = split(/ +/, trim($variables->{QEMU_FLAGS})) if exists $variables->{QEMU_FLAGS};
922 @qemu_flags = split(/ +/, trim($qemu_flags_cmd)) if $qemu_flags_cmd;
923 push(@qemu_flags, split(/ +/, trim($qemu_append || '')));
925 if (defined $iso_image) {
926 # Boot NOVA with grub (and test the iso image)
927 push(@qemu_flags, ('-cdrom', $iso_image));
929 # Boot NOVA without GRUB
931 # Non-patched qemu doesn't like commas, but NUL can live with pluses instead of commans
932 foreach (@$modules) {s/,/+/g;}
933 generate_configs("", $generated, $filename);
935 if (scalar @$modules) {
936 my ($kbin, $kcmd) = split(' ', shift(@$modules), 2);
937 $kcmd = '' if !defined $kcmd;
939 @$modules = map { if (/\.dtb$/) { $dtb=$_; (); } else { $_ } } @$modules;
940 my $initrd = join ",", @$modules;
942 push(@qemu_flags, ('-kernel', $kbin, '-append', $kcmd));
943 push(@qemu_flags, ('-initrd', $initrd)) if $initrd;
944 push(@qemu_flags, ('-dtb', $dtb)) if $dtb;
947 push(@qemu_flags, qw(-serial stdio)); # Redirect serial output (for collecting test restuls)
948 unshift(@qemu_flags, ('-name', $config_name));
949 print "novaboot: Running: ".shell_cmd_string($qemu, @qemu_flags)."\n";
950 $exp = Expect->spawn(($qemu, @qemu_flags)) || die("exec() failed: $!");
953 ### Local DHCPD and TFTPD
955 my ($dhcpd_pid, $tftpd_pid);
957 $tftp=1 if $tftp_port;
959 if (defined $dhcp_tftp)
961 generate_configs("(nd)", $generated, $filename);
962 system_verbose('mkdir -p tftpboot');
963 generate_grub_config("tftpboot/os-menu.lst", $config_name, "(nd)", \@$modules, "timeout 0");
964 open(my $fh, '>', 'dhcpd.conf');
965 my $mac = `cat /sys/class/net/eth0/address`;
967 print $fh "subnet 10.23.23.0 netmask 255.255.255.0 {
968 range 10.23.23.10 10.23.23.100;
969 filename \"bin/boot/grub/pxegrub.pxe\";
970 next-server 10.23.23.1;
973 hardware ethernet $mac;
974 fixed-address 10.23.23.1;
977 system_verbose("sudo ip a add 10.23.23.1/24 dev eth0;
978 sudo ip l set dev eth0 up;
979 sudo touch dhcpd.leases");
981 # We run servers by forking ourselves, because the servers end up
982 # in our process group and get killed by signals sent to the
983 # process group (e.g. Ctrl-C on terminal).
985 exec_verbose("sudo dhcpd -d -cf dhcpd.conf -lf dhcpd.leases -pf dhcpd.pid") if ($dhcpd_pid == 0);
988 if (defined $dhcp_tftp || defined $tftp) {
990 # Unfortunately, tftpd requires root privileges even with
991 # non-privileged (>1023) port due to initgroups().
992 system_verbose("sudo in.tftpd --listen --secure -v -v -v --pidfile tftpd.pid --address :$tftp_port $builddir");
994 # Kill server when we die
995 $SIG{__DIE__} = sub { system_verbose('sudo pkill --pidfile=dhcpd.pid') if (defined $dhcp_tftp);
996 system_verbose('sudo pkill --pidfile=tftpd.pid'); };
998 # We have to kill tftpd explicitely, because it is not in our process group
999 $SIG{INT} = sub { system_verbose('sudo pkill --pidfile=tftpd.pid'); exit(0); };
1003 if (defined $ider) {
1004 my $ider_cmd= "amtider -c $iso_image -u $amt_user -p $amt_password $amt_host $amt_port" ;
1005 print "novaboot: Running: $ider_cmd\n" =~ s/\Q$amt_password\E/???/r;
1006 my $ider_pid = fork();
1007 if ($ider_pid == 0) {
1009 die "IDE redirection failed";
1011 # FIXME: This collides with --tftp option. Hopefully, nobody needs
1012 # to use both simultaneously.
1013 $SIG{__DIE__} = sub { system_verbose('kill $ider_pid'); };
1016 ### Reset target (IP relay, AMT, ...)
1018 if (defined $target_reset && $reset) {
1019 print "novaboot: Reseting the test box... ";
1024 ### U-boot conversation
1025 if (defined $uboot) {
1026 my $uboot_prompt = $uboot || '=> ';
1027 print "novaboot: Waiting for U-Boot prompt...\n";
1028 $exp || die("No serial line connection");
1029 $exp->log_stdout(1);
1030 #$exp->exp_internal(1);
1032 [qr/Hit any key to stop autoboot:/, sub { $exp->send("\n"); exp_continue; }],
1033 $uboot_prompt) || die "No U-Boot prompt deteceted";
1034 foreach my $cmdspec (@uboot_init) {
1035 my ($cmd, $timeout);
1036 if (ref($cmdspec) eq "HASH") {
1037 $cmd = $cmdspec->{command};
1038 $timeout = $cmdspec->{timeout};
1043 if ($cmd =~ /\$NB_MYIP/) {
1044 my $ip = (grep /inet /, `ip addr show eth0`)[0] || die "Problem determining our IP address";
1045 $ip =~ s/\s*inet ([0-9.]*).*/$1/;
1046 $cmd =~ s/\$NB_MYIP/$ip/g;
1048 if ($cmd =~ /\$NB_PREFIX/) {
1051 $cmd =~ s/\$NB_PREFIX/$p/g;
1054 $exp->send("$cmd\n");
1055 $exp->expect($timeout, $uboot_prompt) || die "U-Boot prompt timeout";
1058 # Boot the system if there are some load lines in the script
1059 if (scalar(@$modules) > 0 && !$variables->{NO_BOOT}) {
1060 my ($kbin, $kcmd) = split(' ', shift(@$modules), 2);
1062 @$modules = map { if (/\.dtb$/) { $dtb=$_; (); } else { $_ } } @$modules;
1063 my $initrd = shift @$modules;
1065 die "No '--uboot-addr kernel' given" unless $uboot_addr{kernel};
1066 $exp->send("tftpboot $uboot_addr{kernel} $prefix$kbin\n");
1068 [qr/##/, sub { exp_continue; }],
1069 $uboot_prompt) || die "Kernel load timeout";
1071 die "No '--uboot-addr fdt' given" unless $uboot_addr{fdt};
1072 $exp->send("tftpboot $uboot_addr{fdt} $prefix$dtb\n");
1074 [qr/##/, sub { exp_continue; }],
1075 $uboot_prompt) || die "Device tree load timeout";
1077 if (defined $initrd) {
1078 die "No '--uboot-addr ramdisk' given" unless $uboot_addr{ramdisk};
1079 $exp->send("tftpboot $uboot_addr{ramdisk} $prefix$initrd\n");
1081 [qr/##/, sub { exp_continue; }],
1082 $uboot_prompt) || die "Initrd load timeout";
1084 $uboot_addr{ramdisk} = '-';
1088 $exp->send("setenv bootargs $kcmd\n");
1089 $exp->expect(5, $uboot_prompt) || die "U-Boot prompt timeout";
1091 $uboot_cmd //= $variables->{UBOOT_CMD} // 'bootm $kernel_addr $ramdisk_addr $fdt_addr';
1092 $uboot_cmd =~ s/\$kernel_addr/$uboot_addr{kernel}/g;
1093 $uboot_cmd =~ s/\$ramdisk_addr/$uboot_addr{ramdisk}/g;
1094 $uboot_cmd =~ s/\$fdt_addr/$uboot_addr{fdt}/g;
1096 $exp->send($uboot_cmd . "\n");
1097 $exp->expect(5, "\n") || die "U-Boot command timeout";
1101 ### Serial line interaction
1103 # Serial line of the target is available
1104 my $interrupt = 'Ctrl-C';
1105 if ($interactive && !@exiton) {
1106 $interrupt = '"~~."';
1108 my $note = (-t STDIN) ? '' : '- only target->host ';
1109 print "novaboot: Serial line interaction $note(press $interrupt to interrupt)...\n";
1110 $exp->log_stdout(1);
1112 $exp->expect($exiton_timeout, @expect_raw, @exiton) || die("exiton timeout");
1115 my @inputs = ($exp);
1116 if (-t STDIN) { # Set up bi-directional communication if we run on terminal
1117 my $infile = new IO::File;
1118 $infile->IO::File::fdopen(*STDIN,'r');
1119 my $in_object = Expect->exp_init($infile);
1120 $in_object->set_group($exp);
1123 $in_object->set_seq('~~\.', sub { print "novaboot: Escape sequence detected\r\n"; undef; });
1124 $in_object->manual_stty(0); # Use raw terminal mode
1126 $in_object->manual_stty(1); # Do not modify terminal settings
1128 push(@inputs, $in_object);
1131 #print Dumper(\@expect_raw);
1132 $exp->expect(undef, @expect_raw) if @expect_raw;
1133 Expect::interconnect(@inputs) unless defined($exp->exitstatus);
1137 ## Kill dhcpc or tftpd
1138 if (defined $dhcp_tftp || defined $tftp) {
1139 die("novaboot: This should kill servers on background\n");
1146 novaboot - Boots a locally compiled operating system on a remote
1153 B<novaboot> [option]... [--] script...
1155 B<./script> [option]...
1159 This program makes booting of a locally compiled operating system (OS)
1160 (e.g. NOVA or Linux) on remote targets as simple as running a program
1161 locally. It automates things like copying OS images to a TFTP server,
1162 generation of bootloader configuration files, resetting of target
1163 hardware or redirection of target's serial line to stdin/out. Novaboot
1164 is highly configurable and it makes it easy to boot a single image on
1165 different targets or different images on a single target.
1167 Novaboot operation is controlled by command line options and by a so
1168 called novaboot script, which can be thought as a generalization of
1169 bootloader configuration files (see L</"NOVABOOT SCRIPT SYNTAX">).
1170 Typical way of using novaboot is to make the novaboot script
1171 executable and set its first line to I<#!/usr/bin/env novaboot>. Then,
1172 booting a particular OS configuration becomes the same as executing a
1173 local program - the novaboot script.
1175 Novaboot uses configuration files to, among other things, define
1176 command line options needed for different targets. Users typically use
1177 only the B<-t>/B<--target> command line option to select the target.
1178 Internally, this option expands to the pre-configured options.
1179 Configuration files are searched at multiple places, which allows to
1180 have per-system, per-user or per-project configurations. Configuration
1181 file syntax is described in section L</"CONFIGURATION FILE">.
1183 Simple examples of using C<novaboot>:
1189 Run an OS in Qemu. This is the default action when no other action is
1190 specified by command line switches. Thus running C<novaboot myos> (or
1191 C<./myos> as described above) will run Qemu and make it boot the
1192 configuration specified in the F<myos> script.
1196 Create a bootloader configuration file (currently supported
1197 bootloaders are GRUB, GRUB2, ISOLINUX, Pulsar and U-Boot) and copy it
1198 with all other files needed for booting to a remote boot server. Then
1199 use a TCP/IP-controlled relay/serial-to-TCP converter to reset the
1200 target and receive its serial output.
1202 ./myos --grub2 --server=192.168.1.1:/tftp --iprelay=192.168.1.2
1206 Run DHCP and TFTP server on developer's machine to boot the target
1211 This is useful when no network infrastructure is in place and
1212 the target is connected directly to developer's box.
1216 Create bootable ISO image.
1218 novaboot --iso -- script1 script2
1220 The created ISO image will have ISOLINUX bootloader installed on it
1221 and the boot menu will allow selecting between I<script1> and
1222 I<script2> configurations.
1226 =head1 PHASES AND OPTIONS
1228 Novaboot performs its work in several phases. Each phase can be
1229 influenced by several command line options, certain phases can be
1230 skipped. The list of phases (in the execution order) and the
1231 corresponding options follows.
1233 =head2 Configuration reading phase
1235 After starting, novaboot reads configuration files. Their content is
1236 described in section L</"CONFIGURATION FILE">. By default,
1237 configuration is read from multiple locations. First from the system
1238 configuration directory (F</etc/novaboot.d/>), second from the user
1239 configuration file (F<~/.config/novaboot>) and third from F<.novaboot>
1240 files along the path to the current directory. Alternatively, a single
1241 configuration file specified with the B<-c> switch or with the
1242 C<NOVABOOT_CONFIG> environment variable is read. The latter read files
1243 override settings from the former ones.
1245 The system configuration directory is determined by the content of
1246 NOVABOOT_CONFIG_DIR environment variable and defaults to
1247 F</etc/novaboot.d>. Files in this directory with names consisting
1248 solely of English letters, numbers, dashes '-' and underscores '_'
1249 (note that dot '.' is not included) are read in alphabetical order.
1251 Then, the user configuration file is read from
1252 F<$XDG_CONFIG_HOME/novaboot>. If C<$XDG_CONFIG_HOME> environemnt
1253 variable is not set F<~/.config/novaboot> is read instead.
1255 Finally, novaboot searches for files named F<.novaboot> starting from the
1256 directory of the novaboot script (or working directory, see bellow)
1257 and continuing upwards up to the root directory. The found
1258 configuration files are then read in the opposite order (i.e. from the
1259 root directory downwards). This allows to have, for example, a project
1260 specific configuration in F<~/project/.novaboot>.
1262 Note the difference between F<~/.config/novaboot> and F<~/.novaboot>.
1263 The former one is read always, whereas the latter only when novaboot
1264 script or working directory is under the C<$HOME> directory.
1266 In certain cases, the location of the novaboot script cannot be
1267 determined in this early phase. This happens either when the script is
1268 read from the standard input or when novaboot is invoked explicitly as
1269 in the example L</"4."> above. In this case the current working
1270 directory is used as a starting point for configuration file search
1271 instead of the novaboot script directory.
1275 =item -c, --config=I<filename>
1277 Use the specified configuration file instead of the default one(s).
1281 =head2 Command line processing phase
1287 Dump the current configuration to stdout end exit. Useful as an
1288 initial template for a configuration file.
1292 Print short (B<-h>) or long (B<--help>) help.
1294 =item -t, --target=I<target>
1296 This option serves as a user configurable shortcut for other novaboot
1297 options. The effect of this option is the same as the options stored
1298 in the C<%targets> configuration variable under key I<target>. See
1299 also L</"CONFIGURATION FILE">.
1303 =head2 Script preprocessing phase
1305 This phases allows to modify the parsed novaboot script before it is
1306 used in the later phases.
1310 =item -a, --append=I<parameters>
1312 Append a string to the first C<load> line in the novaboot script. This
1313 can be used to append parameters to the kernel's or root task's
1314 command line. This option can appear multiple times.
1318 Use F<bender> chainloader. Bender scans the PCI bus for PCI serial
1319 ports and stores the information about them in the BIOS data area for
1322 =item --chainloader=I<chainloader>
1324 Specifies a chainloader that is loaded before the kernel and other
1325 files specified in the novaboot script. E.g. 'bin/boot/bender
1330 Print the modules to boot and their parameters after this phase
1331 finishes. Then exit. This is useful for seeing the effect of other
1332 options in this section.
1334 =item -k, --kernel=F<file>
1336 Replace the first word on the first C<load> line in the novaboot
1337 script with F<file>.
1339 =item --scriptmod=I<perl expression>
1341 When novaboot script is read, I<perl expression> is executed for every
1342 line (in $_ variable). For example, C<novaboot
1343 --scriptmod=s/sigma0/omega6/g> replaces every occurrence of I<sigma0>
1344 in the script with I<omega6>.
1346 When this option is present, it overrides I<$script_modifier> variable
1347 from the configuration file, which has the same effect. If this option
1348 is given multiple times all expressions are evaluated in the command
1353 =head2 File generation phase
1355 In this phase, files needed for booting are generated in a so called
1356 I<build directory> (see L</--build-dir>). In most cases configuration
1357 for a bootloader is generated automatically by novaboot. It is also
1358 possible to generate other files using I<heredoc> or I<"<"> syntax in
1359 novaboot scripts. Finally, binaries can be generated in this phases by
1360 running C<scons> or C<make>.
1364 =item --build-dir=I<directory>
1366 Overrides the default build directory location.
1368 The default build directory location is determined as follows: If the
1369 configuration file defines the C<$builddir> variable, its value is
1370 used. Otherwise, it is the directory that contains the first processed
1373 See also L</BUILDDIR> variable.
1375 =item -g, --grub[=I<filename>]
1377 Generates grub bootloader menu file. If the I<filename> is not
1378 specified, F<menu.lst> is used. The I<filename> is relative to the
1379 build directory (see B<--build-dir>).
1381 =item --grub-preamble=I<prefix>
1383 Specifies the I<preable> that is at the beginning of the generated
1384 GRUB or GRUB2 config files. This is useful for specifying GRUB's
1387 =item --prefix=I<prefix>
1389 Specifies I<prefix> (e.g. F</srv/tftp>) that is put in front of every
1390 file name in generated bootloader configuration files (or in U-Boot
1393 If the I<prefix> contains string $NAME, it will be replaced with the
1394 name of the novaboot script (see also B<--name>).
1396 If the I<prefix> contains string $BUILDDIR, it will be replaced with
1397 the build directory (see also B<--build-dir>).
1401 Alias for B<--prefix>.
1403 =item --grub2[=I<filename>]
1405 Generate GRUB2 menu entry in I<filename>. If I<filename> is not
1406 specified F<grub.cfg> is used. The content of the menu entry can be
1407 customized with B<--grub-preamble>, B<--grub2-prolog> or
1408 B<--grub_prefix> options.
1410 In order to use the the generated menu entry on your development
1411 machine that uses GRUB2, append the following snippet to
1412 F</etc/grub.d/40_custom> file and regenerate your grub configuration,
1413 i.e. run update-grub on Debian/Ubuntu.
1415 if [ -f /path/to/nul/build/grub.cfg ]; then
1416 source /path/to/nul/build/grub.cfg
1419 =item --grub2-prolog=I<prolog>
1421 Specifies text that is put at the beginning of the GRUB2 menu entry.
1423 =item -m, --make[=make command]
1425 Runs C<make> to build files that are not generated by novaboot itself.
1427 =item --name=I<string>
1429 Use the name I<string> instead of the name of the novaboot script.
1430 This name is used for things like a title of grub menu or for the
1431 server directory where the boot files are copied to.
1435 Do not run external commands to generate files (i.e. "<" syntax and
1436 C<run> keyword). This switch does not influence generation of files
1437 specified with "<<WORD" syntax.
1439 =item -p, --pulsar[=mac]
1441 Generates pulsar bootloader configuration file named F<config-I<mac>>
1442 The I<mac> string is typically a MAC address and defaults to
1445 =item --scons[=scons command]
1447 Runs C<scons> to build files that are not generated by novaboot
1452 Strip I<rom://> prefix from command lines and generated config files.
1453 The I<rom://> prefix is used by NUL. For NRE, it has to be stripped.
1457 Exit novaboot after file generation phase.
1461 =head2 Target connection check
1463 If supported by the target, the connection to it is made and it is
1464 checked whether the target is not occupied by another novaboot
1469 =item --amt=I<"[user[:password]@]host[:port]>
1471 Use Intel AMT technology to control the target machine. WS management
1472 is used to powercycle it and Serial-Over-Lan (SOL) for input/output.
1473 The hostname or (IP address) is given by the I<host> parameter. If
1474 I<password> is not specified, environment variable AMT_PASSWORD is
1475 used. The I<port> specifies a TCP port for SOL. If not specified, the
1476 default is 16992. Default I<user> is admin.
1478 =item --iprelay=I<addr[:port]>
1480 Use TCP/IP relay and serial port to access the target's serial port
1481 and powercycle it. The IP address of the relay is given by I<addr>
1482 parameter. If I<port> is not specified, it default to 23.
1484 Note: This option is supposed to work with HWG-ER02a IP relays.
1486 =item -s, --serial[=device]
1488 Target's serial line is connected to host's serial line (device). The
1489 default value for device is F</dev/ttyUSB0>.
1491 The value of this option is exported in NB_NOVABOOT environment
1492 variable to all subprocesses run by C<novaboot>.
1494 =item --stty=I<settings>
1496 Specifies settings passed to C<stty> invoked on the serial line
1497 specified with B<--serial> option. If this option is not given,
1498 C<stty> is called with C<raw -crtscts -onlcr 115200> settings.
1500 =item --remote-cmd=I<cmd>
1502 Command that mediates connection to the target's serial line. For
1503 example C<ssh server 'cu -l /dev/ttyS0'>.
1505 =item --remote-expect=I<string>
1507 Wait for reception of I<string> after establishing the the remote
1508 connection before continuing.
1513 =head2 File deployment phase
1515 In some setups, it is necessary to copy the files needed for booting
1516 to a particular location, e.g. to a TFTP boot server or to the
1521 =item -d, --dhcp-tftp
1523 Turns your workstation into a DHCP and TFTP server so that the OS can
1524 be booted via PXE BIOS (or similar mechanism) on the test machine
1525 directly connected by a plain Ethernet cable to your workstation.
1527 The DHCP and TFTP servers requires root privileges and C<novaboot>
1528 uses C<sudo> command to obtain those. You can put the following to
1529 I</etc/sudoers> to allow running the necessary commands without asking
1532 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
1533 your_login ALL=NOPASSWD: NOVABOOT
1537 Starts a TFTP server on your workstation. This is similar to
1538 B<--dhcp-tftp> except that DHCP server is not started.
1540 The TFTP server require root privileges and C<novaboot> uses C<sudo>
1541 command to obtain those. You can put the following to I</etc/sudoers>
1542 to allow running the necessary commands without asking for password.
1544 Cmnd_Alias NOVABOOT = /usr/sbin/in.tftpd --listen --secure -v -v -v --pidfile tftpd.pid *, /usr/bin/pkill --pidfile=tftpd.pid
1545 your_login ALL=NOPASSWD: NOVABOOT
1547 =item --tftp-port=I<port>
1549 Port to run the TFTP server on. Implies B<--tftp>.
1551 =item --iso[=filename]
1553 Generates the ISO image that boots NOVA system via GRUB. If no filename
1554 is given, the image is stored under I<NAME>.iso, where I<NAME> is the name
1555 of the novaboot script (see also B<--name>).
1557 =item --server[=[[user@]server:]path]
1559 Copy all files needed for booting to another location. The files will
1560 be copied (by B<rsync> tool) to the directory I<path>. If the I<path>
1561 contains string $NAME, it will be replaced with the name of the
1562 novaboot script (see also B<--name>).
1564 =item --rsync-flags=I<flags>
1566 Specifies which I<flags> are appended to F<rsync> command line when
1567 copying files as a result of I<--server> option.
1571 If B<--server> is used and its value ends with $NAME, then after
1572 copying the files, a new bootloader configuration file (e.g. menu.lst)
1573 is created at I<path-wo-name>, i.e. the path specified by B<--server>
1574 with $NAME part removed. The content of the file is created by
1575 concatenating all files of the same name from all subdirectories of
1576 I<path-wo-name> found on the "server".
1580 Use Intel AMT technology for IDE redirection. This allows the target
1581 machine to boot from novaboot created ISO image. Implies B<--iso>.
1583 The experimental C<amtider> utility needed by this option can be
1584 obtained from https://github.com/wentasah/amtterm.
1588 =head2 Target power-on and reset phase
1590 At this point, the target is reset (or switched on/off). There is
1591 several ways how this can be accomplished. Resetting a physical target
1592 can currently be accomplished by the following options: B<--amt>,
1593 B<--iprelay>, B<--reset-cmd>.
1599 Switch on/off the target machine and exit. The script (if any) is
1600 completely ignored. Currently it works only with B<--iprelay> or
1603 =item -Q, --qemu[=I<qemu-binary>]
1605 Boot the configuration in qemu. Optionally, the name of qemu binary
1606 can be specified as a parameter.
1608 =item --qemu-append=I<flags>
1610 Append I<flags> to the default qemu flags (QEMU_FLAGS variable or
1611 C<-cpu coreduo -smp 2>).
1613 =item -q, --qemu-flags=I<flags>
1615 Replace the default qemu flags (QEMU_FLAGS variable or C<-cpu coreduo
1616 -smp 2>) with I<flags> specified here.
1618 =item --reset-cmd=I<cmd>
1620 Command that resets the target.
1622 =item --no-reset, --reset
1624 Disable/enable resetting of the target.
1628 =head2 Interaction with the bootloader on the target
1632 =item --uboot[=I<prompt>]
1634 Interact with U-Boot bootloader to boot the thing described in the
1635 novaboot script. I<prompt> specifies the U-Boot's prompt (default is
1636 "=> ", other common prompts are "U-Boot> " or "U-Boot# ").
1637 Implementation of this option is currently tied to a particular board
1638 that we use. It may be subject to changes in the future!
1642 Disable U-Boot interaction previously enabled with B<--uboot>.
1646 Command(s) to send the U-Boot bootloader before loading the images and
1647 booting them. This option can be given multiple times. After sending
1648 commands from each option novaboot waits for U-Boot I<prompt>.
1650 If the command contains string I<$NB_MYIP> then this string is
1651 replaced by IPv4 address of eth0 interface. Similarly I<$NB_PREFIX> is
1652 replaced with prefix given by B<--prefix>.
1654 See also C<uboot> keyword in L</"NOVABOOT SCRIPT SYNTAX">).
1656 =item --uboot-addr I<name>=I<address>
1658 Load address of U-Boot's C<tftpboot> command for loading I<name>,
1659 where name is one of I<kernel>, I<ramdisk> or I<fdt> (flattened device
1662 The default addresses are ${I<name>_addr_r}, i.e. U-Boot environment
1663 variables used by convention for this purpose.
1665 =item --uboot-cmd=I<command>
1667 Specifies U-Boot command used to execute the OS. If the command
1668 contains strings C<$kernel_addr>, C<$ramdisk_addr>, C<$fdt_addr>,
1669 these are replaced with the addresses configured with B<--uboot-addr>.
1671 The default value is
1673 bootm $kernel_addr $ramdisk_addr $fdt_addr
1675 or the C<UBOOT_CMD> variable if defined in the novaboot script.
1679 =head2 Target interaction phase
1681 In this phase, target's serial output is redirected to stdout and if
1682 stdin is a TTY, it is redirected to the target's serial input allowing
1683 interactive work with the target.
1687 =item --exiton=I<string>
1689 When I<string> is sent by the target, novaboot exits. This option can
1690 be specified multiple times, in which case novaboot exits whenever
1691 either of the specified strings is sent.
1693 If I<string> is C<-re>, then the next B<--exiton>'s I<string> is
1694 treated as regular expression. For example:
1696 --exiton -re --exiton 'error:.*failed'
1698 =item --exiton-re=I<regex>
1700 The same as --exiton -re --exiton I<regex>.
1702 =item --exiton-timeout=I<seconds>
1704 By default B<--exiton> waits for the string match forever. When this
1705 option is specified, "exiton" timeouts after the specifies number of
1706 seconds and novaboot returns non-zero exit code.
1708 =item -i, --interactive
1710 Setup things for interactive use of target. Your terminal will be
1711 switched to raw mode. In raw mode, your system does not process input
1712 in any way (no echoing of entered characters, no interpretation
1713 special characters). This, among others, means that Ctrl-C is passed
1714 to the target and does no longer interrupt novaboot. Use "~~."
1715 sequence to exit novaboot.
1717 =item --expect=I<string>
1719 When I<string> is received from the target, send the string specified
1720 with the subsequent B<--send*> option to the target.
1722 =item --expect-re=I<regex>
1724 When target's output matches regular expression I<regex>, send the
1725 string specified with the subsequent B<--send*> option to the target.
1727 =item --expect-raw=I<perl-code>
1729 Provides direct control over Perl's Expect module.
1731 =item --send=I<string>
1733 Send I<string> to the target after the previously specified
1734 B<--expect*> was matched in the target's output. The I<string> may
1735 contain escape sequences such as "\n".
1737 Note that I<string> is actually interpreted by Perl, so it can contain
1738 much more that escape sequences. This behavior may change in the
1741 Example: C<--expect='login: ' --send='root\n'>
1743 =item --sendcont=I<string>
1745 Similar to B<--send> but continue expecting more input.
1747 Example: C<--expect='Continue?' --sendcont='yes\n'>
1751 =head1 NOVABOOT SCRIPT SYNTAX
1753 The syntax tries to mimic POSIX shell syntax. The syntax is defined
1754 with the following rules.
1756 Lines starting with "#" and empty lines are ignored.
1758 Lines that end with "\" are concatenated with the following line after
1759 removal of the final "\" and leading whitespace of the following line.
1761 Lines of the form I<VARIABLE=...> (i.e. matching '^[A-Z_]+=' regular
1762 expression) assign values to internal variables. See L</VARIABLES>
1765 Lines starting with C<load> keyword represent modules to boot. The
1766 word after C<load> is a file name (relative to the build directory
1767 (see B<--build-dir>) of the module to load and the remaining words are
1768 passed to it as the command line parameters.
1770 When the C<load> line ends with "<<WORD" then the subsequent lines
1771 until the line containing solely WORD are copied literally to the file
1772 named on that line. This is similar to shell's heredoc feature.
1774 When the C<load> line ends with "< CMD" then command CMD is executed
1775 with F</bin/sh> and its standard output is stored in the file named on
1776 that line. The SRCDIR variable in CMD's environment is set to the
1777 absolute path of the directory containing the interpreted novaboot
1780 Lines starting with C<run> keyword contain shell commands that are run
1781 during file generation phase. This is the same as the "< CMD" syntax
1782 for C<load> keyboard except that the command's output is not
1783 redirected to a file. The ordering of commands is the same as they
1784 appear in the novaboot script.
1786 Lines starting with C<uboot> represent U-Boot commands that are sent
1787 to the target if B<--uboot> option is given. Having a U-Boot line in
1788 the novaboot script is the same as passing an equivalent
1789 B<--uboot-init> option to novaboot. The C<uboot> keyword can be
1790 suffixed with timeout specification. The syntax is C<uboot:Ns>, where
1791 C<N> is the whole number of seconds. If the U-Boot command prompt does
1792 not appear before the timeout, novaboot fails. The default timeout is
1797 #!/usr/bin/env novaboot
1798 load bzImage console=ttyS0,115200
1799 run make -C buildroot
1800 load rootfs.cpio < gen_cpio buildroot/images/rootfs.cpio "myapp->/etc/init.d/S99myapp"
1802 Example (NOVA User Land - NUL):
1804 #!/usr/bin/env novaboot
1805 WVDESC=Example program
1806 load bin/apps/sigma0.nul S0_DEFAULT script_start:1,1 \
1807 verbose hostkeyb:0,0x60,1,12,2
1808 load bin/apps/hello.nul
1809 load hello.nulconfig <<EOF
1810 sigma0::mem:16 name::/s0/log name::/s0/timer name::/s0/fs/rom ||
1811 rom://bin/apps/hello.nul
1814 This example will load three modules: F<sigma0.nul>, F<hello.nul> and
1815 F<hello.nulconfig>. sigma0 receives some command line parameters and
1816 F<hello.nulconfig> file is generated on the fly from the lines between
1817 C<<<EOF> and C<EOF>.
1821 The following variables are interpreted in the novaboot script:
1827 Novaboot chdir()s to this directory before file generation phase. The
1828 directory name specified here is relative to the build directory
1829 specified by other means (see L</--build-dir>).
1833 Assigning this variable has the same effect as specifying L</--exiton>
1836 =item HYPERVISOR_PARAMS
1838 Parameters passed to hypervisor. The default value is "serial", unless
1839 overridden in configuration file.
1843 The kernel to use instead of the hypervisor specified in the
1844 configuration file with the C<$hypervisor> variable. The value should
1845 contain the name of the kernel image as well as its command line
1846 parameters. If this variable is defined and non-empty, the variable
1847 HYPERVISOR_PARAMS is not used.
1851 If this variable is 1, the system is not booted. This is currently
1852 only implemented for U-Boot bootloader where it is useful for
1853 interacting with the bootloader without booting the system - e.g. for
1858 Use a specific qemu binary (can be overridden with B<-Q>) and flags
1859 when booting this script under qemu. If QEMU_FLAGS variable is also
1860 specified flags specified in QEMU variable are replaced by those in
1865 Use specific qemu flags (can be overridden with B<-q>).
1869 See L</--uboot-cmd>.
1873 Description of the WvTest-compliant program.
1875 =item WVTEST_TIMEOUT
1877 The timeout in seconds for WvTest harness. If no complete line appears
1878 in the test output within the time specified here, the test fails. It
1879 is necessary to specify this for long running tests that produce no
1880 intermediate output.
1884 =head1 CONFIGURATION FILE
1886 Novaboot can read its configuration from one or more files. By
1887 default, novaboot looks for files in F</etc/novaboot.d>, file
1888 F<~/.config/novaboot> and files named F<.novaboot> as described in
1889 L</Configuration reading phase>. Alternatively, configuration file
1890 location can be specified with the B<-c> switch or with the
1891 NOVABOOT_CONFIG environment variable. The configuration file has Perl
1892 syntax (i.e. it is better to put C<1;> as the last line) and should set
1893 values of certain Perl variables. The current configuration can be
1894 dumped with the B<--dump-config> switch. Some configuration variables
1895 can be overridden by environment variables (see below) or by command
1898 Supported configuration variables include:
1904 Build directory location relative to the location of the configuration
1907 =item $default_target
1909 Default target (see below) to use when no target is explicitly
1910 specified on command line with the B<--target> option.
1914 Hash of target definitions to be used with the B<--target> option. The
1915 key is the identifier of the target, the value is the string with
1916 command line options. For instance, if the configuration file contains:
1918 $targets{'mybox'} = '--server=boot:/tftproot --serial=/dev/ttyUSB0 --grub',
1920 then the following two commands are equivalent:
1922 ./myos --server=boot:/tftproot --serial=/dev/ttyUSB0 --grub
1927 =head1 ENVIRONMENT VARIABLES
1929 Some options can be specified not only via config file or command line
1930 but also through environment variables. Environment variables override
1931 the values from configuration file and command line parameters
1932 override the environment variables.
1936 =item NOVABOOT_CONFIG
1938 Name of the novaboot configuration file to use instead of the default
1941 =item NOVABOOT_CONFIG_DIR
1943 Name of the novaboot configuration directory. When not specified
1944 F</etc/novaboot.d> is used.
1946 =item NOVABOOT_BENDER
1948 Defining this variable has the same meaning as B<--bender> option.
1954 Michal Sojka <sojka@os.inf.tu-dresden.de>
1958 # LocalWords: novaboot Novaboot NOVABOOT TFTP PXE DHCP filename stty
1959 # LocalWords: chainloader stdout Qemu qemu preprocessing ISOLINUX bootable
1960 # LocalWords: config subprocesses sudo sudoers tftp dhcp IDE stdin
1961 # LocalWords: subdirectories TTY whitespace heredoc POSIX WvTest