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/>.
20 use warnings (exists $ENV{NOVABOOT_TEST} ? (FATAL => 'all') : ());
21 use Getopt::Long qw(GetOptionsFromString GetOptionsFromArray);
26 use Time::HiRes("usleep");
30 use POSIX qw(:errno_h sysconf);
31 use Cwd qw(getcwd abs_path);
37 my $invocation_dir = $ENV{PWD} || getcwd();
39 ## Configuration file handling
41 # Default configuration
42 $CFG::hypervisor = "";
43 $CFG::hypervisor_params = "serial";
44 $CFG::genisoimage = "genisoimage";
45 $CFG::qemu = 'qemu-system-i386 -cpu coreduo -smp 2';
46 $CFG::default_target = '';
49 "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',
50 "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',
51 "localhost" => '--scriptmod=s/console=tty[A-Z0-9,]+// --server=/boot/novaboot/$NAME --grub2 --grub-prefix=/boot/novaboot/$NAME --grub2-prolog=" set root=\'(hd0,msdos1)\'"',
52 "ryu" => '--uboot --uboot-init="mw f0000b00 \${psc_cfg}; sleep 1" --uboot-addr kernel=800000 --uboot-addr ramdisk=b00000 --uboot-addr fdt=7f0000',
53 "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\""',
54 "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"',
59 $const{linux}->{_SC_NPROCESSORS_CONF} = 83;
60 my $nproc = sysconf($const{$^O}->{_SC_NPROCESSORS_CONF});
62 $CFG::scons = "scons -j$nproc";
63 $CFG::make = "make -j$nproc";
71 package CFG; # Put config data into a separate namespace
77 die("ERROR: Failure compiling '$cfg' - $@");
78 } elsif (! defined($rc)) {
79 die("ERROR: Failure reading '$cfg' - $!");
81 die("ERROR: Failure processing '$cfg'");
84 $builddir = File::Spec->rel2abs($CFG::builddir, dirname($cfg)) if defined $CFG::builddir;
85 print STDERR "novaboot: Read $cfg\n";
90 # We don't use $0 here, because it points to the novaboot itself and
91 # not to the novaboot script. The problem with this approach is that
92 # when a script is run as "novaboot <options> <script>" then $ARGV[0]
93 # contains the first option. Hence the -f check.
94 my $dir = File::Spec->rel2abs($ARGV[0] && -f $ARGV[0] ? dirname($ARGV[0]) : '', $invocation_dir);
95 while ((-d $dir || -l $dir ) && $dir ne "/") {
96 push @cfgs, "$dir/.novaboot" if -r "$dir/.novaboot";
97 my @dirs = File::Spec->splitdir($dir);
98 $dir = File::Spec->catdir(@dirs[0..$#dirs-1]);
100 @cfgs = reverse @cfgs;
102 my $xdg_config_home = $ENV{'XDG_CONFIG_HOME'} || $ENV{'HOME'}.'/.config';
103 unshift(@cfgs, "$xdg_config_home/novaboot") if -r "$xdg_config_home/novaboot";
105 $dir = $ENV{'NOVABOOT_CONFIG_DIR'} || '/etc/novaboot.d';
106 if (opendir(my $dh, $dir)) {
107 my @etccfg = map { "$dir/$_" } grep { /^[-_a-zA-Z0-9]+$/ && -f "$dir/$_" } readdir($dh);
109 @etccfg = sort(@etccfg);
110 @cfgs = ( @etccfg, @cfgs );
113 my $cfg = $ENV{'NOVABOOT_CONFIG'};
114 Getopt::Long::Configure(qw/no_ignore_case pass_through/);
115 GetOptions ("config|c=s" => \$cfg);
116 read_config($_) foreach $cfg or @cfgs;
118 ## Command line handling
120 my $explicit_target = $ENV{'NOVABOOT_TARGET'};
121 GetOptions ("target|t=s" => \$explicit_target);
123 my ($amt, @append, $bender, @chainloaders, $concat, $config_name_opt, $dhcp_tftp, $dump_opt, $dump_config, @exiton, $exiton_timeout, @expect_raw, $final_eol, $gen_only, $grub_config, $grub_prefix, $grub_preamble, $grub2_prolog, $grub2_config, $help, $ider, $interaction, $iprelay, $iso_image, $interactive, $kernel_opt, $make, $man, $netif, $no_file_gen, $off_opt, $on_opt, $pulsar, $pulsar_root, $qemu, $qemu_append, $qemu_flags_cmd, $remote_cmd, $remote_expect, $remote_expect_silent, $reset, $reset_cmd, $rom_prefix, $rsync_flags, @scriptmod, $scons, $serial, $server, $stty, $tftp, $tftp_port, $uboot, %uboot_addr, $uboot_cmd, @uboot_init);
125 # Default values of certain command line options
127 'kernel' => '${kernel_addr_r}',
128 'ramdisk' => '${ramdisk_addr_r}',
129 'fdt' => '${fdt_addr_r}',
132 $rom_prefix = 'rom://';
133 $stty = 'raw -crtscts -onlcr 115200';
134 $reset = 1; # Reset target by default
135 $interaction = 1; # Perform target interaction by default
139 my @expect_seen = ();
143 push(@expect_seen, '-re') if $n eq "expect-re";
144 push(@expect_seen, $v);
150 unless (@expect_seen) { die("No --expect before --send"); }
151 my $ret = ($n eq "sendcont") ? exp_continue : 0;
152 unshift(@expect_raw, sub { shift->send(eval("\"$v\"")); $ret; });
153 unshift(@expect_raw, @expect_seen);
160 "append|a=s" => \@append,
161 "bender|b" => \$bender,
162 "build-dir=s" => sub { my ($n, $v) = @_; $builddir = File::Spec->rel2abs($v); },
163 "concat" => \$concat,
164 "chainloader=s" => \@chainloaders,
165 "dhcp-tftp|d" => \$dhcp_tftp,
166 "dump" => \$dump_opt,
167 "dump-config" => \$dump_config,
168 "exiton=s" => \@exiton,
169 "exiton-timeout=i"=> \$exiton_timeout,
170 "exiton-re=s" => sub { my ($n, $v) = @_; push(@exiton, '-re', $v); },
171 "expect=s" => \&handle_expect,
172 "expect-re=s" => \&handle_expect,
173 "expect-raw=s" => sub { my ($n, $v) = @_; unshift(@expect_raw, eval($v)); },
174 "final-eol!" => \$final_eol,
175 "gen-only" => \$gen_only,
176 "grub|g:s" => \$grub_config,
177 "grub-preamble=s"=> \$grub_preamble,
178 "prefix|grub-prefix=s" => \$grub_prefix,
179 "grub2:s" => \$grub2_config,
180 "grub2-prolog=s" => \$grub2_prolog,
182 "interaction!" => \$interaction,
183 "iprelay=s" => \$iprelay,
184 "iso:s" => \$iso_image,
185 "kernel|k=s" => \$kernel_opt,
186 "interactive|i" => \$interactive,
187 "name=s" => \$config_name_opt,
188 "make|m:s" => \$make,
189 "netif=s" => \$netif,
190 "no-file-gen" => \$no_file_gen,
193 "pulsar|p:s" => \$pulsar,
194 "pulsar-root=s" => \$pulsar_root,
195 "qemu|Q:s" => \$qemu,
196 "qemu-append=s" => \$qemu_append,
197 "qemu-flags|q=s" => \$qemu_flags_cmd,
198 "remote-cmd=s" => \$remote_cmd,
199 "remote-expect=s"=> \$remote_expect,
200 "remote-expect-silent=s"=> sub { $remote_expect=$_[1]; $remote_expect_silent=1; },
202 "reset-cmd=s" => \$reset_cmd,
203 "rsync-flags=s" => \$rsync_flags,
204 "scons:s" => \$scons,
205 "scriptmod=s" => \@scriptmod,
206 "send=s" => \&handle_send,
207 "sendcont=s" => \&handle_send,
208 "serial|s:s" => \$serial,
209 "server:s" => \$server,
210 "strip-rom" => sub { $rom_prefix = ''; },
213 "tftp-port=i" => \$tftp_port,
214 "uboot:s" => \$uboot,
215 "no-uboot" => sub { undef $uboot; },
216 "uboot-addr=s" => \%uboot_addr,
217 "uboot-cmd=s" => \$uboot_cmd,
218 "uboot-init=s" => \@uboot_init,
223 # First process target options
225 my $t = defined($explicit_target) ? $explicit_target : $CFG::default_target;
227 Getopt::Long::Configure(qw/no_ignore_case pass_through/);
229 exists $CFG::targets{$t} or die("Unknown target '$t' (valid targets are: ".join(", ", sort keys(%CFG::targets)).")");
231 undef $explicit_target;
232 my ($ret, $remaining_args) = GetOptionsFromString ($CFG::targets{$t}, ("target|t=s" => \$explicit_target));
233 if (!$ret) { die "Error parsing target $t option"; }
234 push(@target_expanded, @$remaining_args);
235 $t = $explicit_target;
237 Getopt::Long::Configure(qw/no_ignore_case no_pass_through/);
238 GetOptionsFromArray(\@target_expanded, %opt_spec) or die ("Error in target definition");
241 # Then process other command line options - some of them may override
242 # what was specified by the target
243 GetOptions %opt_spec or die("Error in command line arguments");
244 pod2usage(1) if $help;
245 pod2usage(-exitstatus => 0, -verbose => 2) if $man;
247 ### Dump sanitized configuration (if requested)
251 $Data::Dumper::Indent=1;
252 print "# This file is in perl syntax.\n";
253 foreach my $key(sort(keys(%CFG::))) { # See "Symbol Tables" in perlmod(1)
254 if (defined ${$CFG::{$key}}) { print Data::Dumper->Dump([${$CFG::{$key}}], ["*$key"]); }
255 if ( @{$CFG::{$key}}) { print Data::Dumper->Dump([\@{$CFG::{$key}}], ["*$key"]); }
256 if ( %{$CFG::{$key}}) { print Data::Dumper->Dump([\%{$CFG::{$key}}], ["*$key"]); }
262 ### Sanitize configuration
264 if ($interactive && !-t STDIN) {
265 die("novaboot: Interactive mode not supported when not on terminal");
268 if (defined $config_name_opt && scalar(@ARGV) > 1) { die "You cannot use --name with multiple scripts"; }
271 $iso_image //= ''; # IDE-R needs an ISO image
272 if (!defined $amt) { die "Error: --ider requires --amt"; }
276 my %input_opts = ('--iprelay' => \$iprelay,
277 '--serial' => \$serial,
278 '--remote-cmd' => \$remote_cmd,
280 my @opts = grep(defined(${$input_opts{$_}}) , keys %input_opts);
282 die("novaboot: More than one target connection option: ".join(', ', @opts)) if scalar @opts > 1;
286 if (defined $serial) {
287 $serial ||= "/dev/ttyUSB0";
288 $ENV{NB_SERIAL} = $serial;
290 if (defined $grub_config) { $grub_config ||= "menu.lst"; }
291 if (defined $grub2_config) { $grub2_config ||= "grub.cfg"; }
293 ## Parse the novaboot script(s)
298 my ($modules, $variables, $generated, $continuation) = ([], {}, []);
299 my $skip_reading = defined($on_opt) || defined($off_opt);
300 while (!$skip_reading && ($_ = <>)) {
301 if ($ARGV ne $last_fn) { # New script
302 die "Missing EOF in $last_fn" if $file;
303 die "Unfinished line in $last_fn" if $continuation;
305 push @scripts, { 'filename' => $ARGV,
306 'modules' => $modules = [],
307 'variables' => $variables = {},
308 'generated' => $generated = []};
312 next if /^#/ || /^\s*$/; # Skip comments and empty lines
314 $_ =~ s/^[[:space:]]*// if ($continuation);
316 if (/\\$/) { # Line continuation
317 $continuation .= substr($_, 0, length($_)-1);
321 if ($continuation) { # Last continuation line
322 $_ = $continuation . $_;
326 foreach my $mod(@scriptmod) { eval $mod; }
328 if ($file && $_ eq $EOF) { # Heredoc end
332 if ($file) { # Heredoc content
333 push @{$file}, "$_\n";
336 if (/^([A-Z_]+)=(.*)$/) { # Internal variable
337 $$variables{$1} = $2;
338 push(@exiton, $2) if ($1 eq "EXITON");
341 if (s/^load *//) { # Load line
342 die("novaboot: '$last_fn' line $.: Missing file name\n") unless /^[^ <]+/;
343 if (/^([^ ]*)(.*?)[[:space:]]*<<([^ ]*)$/) { # Heredoc start
344 push @$modules, "$1$2";
346 push @$generated, {filename => $1, content => $file};
350 if (/^([^ ]*)(.*?)[[:space:]]*< ?(.*)$/) { # Command substitution
351 push @$modules, "$1$2";
352 push @$generated, {filename => $1, command => $3};
358 if (/^run (.*)/) { # run line
359 push @$generated, {command => $1};
362 if (/^uboot(?::([0-9]+)s)? (.*)/) { # uboot line
363 # TODO: If U-Boot supports some interactive menu, it might
364 # make sense to store uboot lines per novaboot script.
365 if ($1) { # Command with explicit timeout
366 push @uboot_init, { command => $2,
368 } else { # Command without explicit timeout
369 push @uboot_init, $2;
374 die("novaboot: Cannot parse script '$last_fn' line $.. Didn't you forget 'load' keyword?\n");
377 # print Dumper(\@scripts);
379 foreach my $script (@scripts) {
380 $modules = $$script{modules};
381 @$modules[0] =~ s/^[^ ]*/$kernel_opt/ if $kernel_opt;
382 @$modules[0] .= ' ' . join(' ', @append) if @append;
385 if (exists $variables->{KERNEL}) {
386 $kernel = $variables->{KERNEL};
388 if ($CFG::hypervisor) {
389 $kernel = $CFG::hypervisor . " ";
390 if (exists $variables->{HYPERVISOR_PARAMS}) {
391 $kernel .= $variables->{HYPERVISOR_PARAMS};
393 $kernel .= $CFG::hypervisor_params;
397 @$modules = ($kernel, @$modules) if $kernel;
398 @$modules = (@chainloaders, @$modules);
399 @$modules = ("bin/boot/bender", @$modules) if ($bender || defined $ENV{'NOVABOOT_BENDER'});
403 foreach my $script (@scripts) {
404 print join("\n", @{$$script{modules}})."\n";
411 sub generate_configs($$$) {
412 my ($base, $generated, $filename) = @_;
413 if ($base) { $base = "$base/"; };
414 foreach my $g(@$generated) {
415 if (exists $$g{content}) {
416 my $config = $$g{content};
417 my $fn = $$g{filename};
418 open(my $f, '>', $fn) || die("$fn: $!");
419 map { s|\brom://([^ ]*)|$rom_prefix$base$1|g; print $f "$_"; } @{$config};
421 print STDERR "novaboot: Created $fn\n";
422 } elsif (exists $$g{command} && ! $no_file_gen) {
423 $ENV{SRCDIR} = dirname(File::Spec->rel2abs( $filename, $invocation_dir ));
424 if (exists $$g{filename}) {
425 system_verbose("( $$g{command} ) > $$g{filename}");
427 system_verbose($$g{command});
433 sub generate_grub_config($$$$;$)
435 my ($filename, $title, $base, $modules_ref, $preamble) = @_;
436 if ($base) { $base = "$base/"; };
437 open(my $fg, '>', $filename) or die "$filename: $!";
438 print $fg "$preamble\n" if $preamble;
439 print $fg "title $title\n" if $title;
440 #print $fg "root $base\n"; # root doesn't really work for (nd)
442 foreach (@$modules_ref) {
445 my ($kbin, $kcmd) = split(' ', $_, 2);
446 $kcmd = '' if !defined $kcmd;
447 print $fg "kernel ${base}$kbin $kcmd\n";
449 s|\brom://([^ ]*)|$rom_prefix$base$1|g; # Translate rom:// files - needed for vdisk parameter of sigma0
450 print $fg "module $base$_\n";
454 print("novaboot: Created $builddir/$filename\n");
458 sub generate_syslinux_config($$$$)
460 my ($filename, $title, $base, $modules_ref) = @_;
461 if ($base && $base !~ /\/$/) { $base = "$base/"; };
462 open(my $fg, '>', $filename) or die "$filename: $!";
463 print $fg "LABEL $title\n";
464 #TODO print $fg "MENU LABEL $human_readable_title\n";
466 my ($kbin, $kcmd) = split(' ', @$modules_ref[0], 2);
468 if (system("file $kbin|grep 'Linux kernel'") == 0) {
469 my $initrd = @$modules_ref[1];
470 die('To many "load" lines for Linux kernel') if (scalar @$modules_ref > 2);
471 print $fg "LINUX $base$kbin\n";
472 print $fg "APPEND $kcmd\n";
473 print $fg "INITRD $base$initrd\n";
475 print $fg "KERNEL mboot.c32\n";
477 foreach (@$modules_ref) {
478 s|\brom://([^ ]*)|$rom_prefix$base$1|g; # Translate rom:// files - needed for vdisk parameter of sigma0
479 push @append, "$base$_";
480 print $fg "APPEND ".join(' --- ', @append)."\n";
483 #TODO print $fg "TEXT HELP\n";
484 #TODO print $fg "some help here\n";
485 #TODO print $fg "ENDTEXT\n";
487 print("novaboot: Created $builddir/$filename\n");
491 sub generate_grub2_config($$$$;$$)
493 my ($filename, $title, $base, $modules_ref, $preamble, $prolog) = @_;
494 if ($base && substr($base,-1,1) ne '/') { $base = "$base/"; };
495 open(my $fg, '>', $filename) or die "$filename: $!";
496 print $fg "$preamble\n" if $preamble;
497 $title ||= 'novaboot';
498 print $fg "menuentry $title {\n";
499 print $fg "$prolog\n" if $prolog;
501 foreach (@$modules_ref) {
504 my ($kbin, $kcmd) = split(' ', $_, 2);
505 $kcmd = '' if !defined $kcmd;
506 print $fg " multiboot ${base}$kbin $kcmd\n";
509 # GRUB2 doesn't pass filename in multiboot info so we have to duplicate it here
510 $_ = join(' ', ($args[0], @args));
511 s|\brom://|$rom_prefix|g; # We do not need to translate path for GRUB2
512 print $fg " module $base$_\n";
517 print("novaboot: Created $builddir/$filename\n");
521 sub generate_pulsar_config($$)
523 my ($filename, $modules_ref) = @_;
524 open(my $fg, '>', $filename) or die "$filename: $!";
525 print $fg "root $pulsar_root\n" if defined $pulsar_root;
528 foreach (@$modules_ref) {
531 ($kbin, $kcmd) = split(' ', $_, 2);
532 $kcmd = '' if !defined $kcmd;
535 s|\brom://|$rom_prefix|g;
536 print $fg "load $_\n";
539 # Put kernel as last - this is needed for booting Linux and has no influence on non-Linux OSes
540 print $fg "exec $kbin $kcmd\n";
542 print("novaboot: Created $builddir/$filename\n");
546 sub shell_cmd_string(@)
548 return join(' ', map((/^[-_=a-zA-Z0-9\/\.\+]+$/ ? "$_" : "'$_'"), @_));
553 print STDERR "novaboot: Running: ".shell_cmd_string(@_)."\n";
555 exit(1); # should not be reached
558 sub system_verbose($)
561 print STDERR "novaboot: Running: $cmd\n";
562 my $ret = system($cmd);
563 if ($ret & 0x007f) { die("Command terminated by a signal"); }
564 if ($ret & 0xff00) {die("Command exit with non-zero exit code"); }
565 if ($ret) { die("Command failure $ret"); }
570 $str =~ s/^\s+|\s+$//g;
576 if (exists $variables->{WVDESC}) {
577 print STDERR "Testing \"$variables->{WVDESC}\" in $last_fn:\n";
578 } elsif ($last_fn =~ /\.wv$/) {
579 print STDERR "Testing \"all\" in $last_fn:\n";
582 ## Connect to the target and check whether it is not occupied
584 # We have to do this before file generation phase, because file
585 # generation is intermixed with file deployment phase and we want to
586 # check whether the target is not used by somebody else before
587 # deploying files. Otherwise, we may rewrite other user's files on a
590 my $exp; # Expect object to communicate with the target over serial line
592 my ($target_reset, $target_power_on, $target_power_off);
593 my ($amt_user, $amt_password, $amt_host, $amt_port);
595 if (defined $iprelay) {
597 $iprelay =~ /([.0-9]+)(:([0-9]+))?/;
600 my $paddr = sockaddr_in($port, inet_aton($addr));
601 my $proto = getprotobyname('tcp');
602 socket($IPRELAY, PF_INET, SOCK_STREAM, $proto) || die "socket: $!";
603 print STDERR "novaboot: Connecting to IP relay... ";
604 connect($IPRELAY, $paddr) || die "connect: $!";
605 print STDERR "done\n";
606 $exp = Expect->init(\*$IPRELAY);
610 print $exp "\xFF\xF6"; # AYT
611 my $connected = $exp->expect(20, # Timeout in seconds
612 '<iprelayd: connected>',
613 '-re', '<WEB51 HW[^>]*>');
618 my ($relay, $onoff) = @_;
619 die unless ($relay == 1 || $relay == 2);
621 my $cmd = ($relay == 1 ? 0x5 : 0x6) | ($onoff ? 0x20 : 0x10);
622 return "\xFF\xFA\x2C\x32".chr($cmd)."\xFF\xF0";
626 my ($relay, $onoff) = @_;
627 die unless ($relay == 1 || $relay == 2);
628 my $cmd = ($relay == 1 ? 0xdf : 0xbf) | ($onoff ? 0x00 : 0xff);
629 return "\xFF\xFA\x2C\x97".chr($cmd)."\xFF\xF0";
633 my ($relay, $onoff, $can_giveup) = @_;
634 my $confirmation = '';
636 print $exp relaycmd($relay, $onoff);
637 my $confirmed = $exp->expect(20, # Timeout in seconds
638 relayconf($relay, $onoff));
641 print("Relay confirmation timeout - ignoring\n");
643 die "Relay confirmation timeout";
649 $target_reset = sub {
650 relay(2, 1, 1); # Reset the machine
655 $target_power_off = sub {
656 relay(1, 1); # Press power button
657 usleep(6000000); # Long press to switch off
661 $target_power_on = sub {
662 relay(1, 1); # Press power button
663 usleep(100000); # Short press
669 system_verbose("stty -F $serial $stty");
670 open($CONN, "+<", $serial) || die "open $serial: $!";
671 $exp = Expect->init(\*$CONN);
673 elsif ($remote_cmd) {
674 print STDERR "novaboot: Running: $remote_cmd\n";
675 $exp = Expect->spawn($remote_cmd);
677 elsif (defined $amt) {
678 require LWP::UserAgent;
679 require LWP::Authen::Digest;
682 my ($host, $username, $password, $schema, $className, $pstate) = @_;
683 #AMT numbers for PowerStateChange (MNI => bluescreen on windows;-)
684 my %pstates = ("on" => 2,
691 <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">
692 <s:Header><a:To>http://$host:16992/wsman</a:To>
693 <w:ResourceURI s:mustUnderstand="true">$schema</w:ResourceURI>
694 <a:ReplyTo><a:Address s:mustUnderstand="true">http://schemas.xmlsoap.org/ws/2004/08/addressing/role/anonymous</a:Address></a:ReplyTo>
695 <a:Action s:mustUnderstand="true">$schema$className</a:Action>
696 <w:MaxEnvelopeSize s:mustUnderstand="true">153600</w:MaxEnvelopeSize>
697 <a:MessageID>uuid:709072C9-609C-4B43-B301-075004043C7C</a:MessageID>
698 <w:Locale xml:lang="en-US" s:mustUnderstand="false" />
699 <w:OperationTimeout>PT60.000S</w:OperationTimeout>
700 <w:SelectorSet><w:Selector Name="Name">Intel(r) AMT Power Management Service</w:Selector></w:SelectorSet>
702 <p:RequestPowerStateChange_INPUT xmlns:p="http://schemas.dmtf.org/wbem/wscim/1/cim-schema/2/CIM_PowerManagementService">
703 <p:PowerState>$pstates{$pstate}</p:PowerState>
704 <p:ManagedElement><a:Address>http://$host:16992/wsman</a:Address>
705 <a:ReferenceParameters><w:ResourceURI>http://schemas.dmtf.org/wbem/wscim/1/cim-schema/2/CIM_ComputerSystem</w:ResourceURI>
706 <w:SelectorSet><w:Selector Name="Name">ManagedSystem</w:Selector></w:SelectorSet>
707 </a:ReferenceParameters></p:ManagedElement>
708 </p:RequestPowerStateChange_INPUT>
709 </s:Body></s:Envelope>
714 my ($host, $username, $password, $content) = @_;
716 my $ua = LWP::UserAgent->new();
717 $ua->agent("novaboot");
719 my $req = HTTP::Request->new(POST => "http://$host:16992/wsman");
720 my $res = $ua->request($req);
721 die ("Unexpected AMT response: " . $res->status_line) unless $res->code == 401;
723 my ($realm) = $res->header("WWW-Authenticate") =~ /Digest realm="(.*?)"/;
724 $ua->credentials("$host:16992", $realm, $username => $password);
727 $req = HTTP::Request->new(POST => "http://$host:16992/wsman");
728 $req->content_type('application/x-www-form-urlencoded');
729 $req->content($content);
730 $res = $ua->request($req);
731 die ("AMT power change request failed: " . $res->status_line) unless $res->is_success;
732 $res->content() =~ /<g:ReturnValue>(\d+)<\/g:ReturnValue>/;
737 my ($host, $username, $password, $pstate)=@_;
738 my $schema="http://schemas.dmtf.org/wbem/wscim/1/cim-schema/2/CIM_PowerManagementService";
739 my $className="/RequestPowerStateChange";
740 my $content = genXML($host, $username, $password ,$schema, $className, $pstate);
741 return sendPOST($host, $username, $password, $content);
744 ($amt_user,$amt_password,$amt_host,$amt_port) = ($amt =~ /(?:(.*?)(?::(.*))?@)?([^:]*)(?::([0-9]*))?/);;
745 $amt_user ||= "admin";
746 $amt_password ||= $ENV{'AMT_PASSWORD'} || die "AMT password not specified";
747 $amt_host || die "AMT host not specified";
751 $target_power_off = sub {
753 my $result = powerChange($amt_host,$amt_user,$amt_password, "off");
754 die "AMT power off failed (ReturnValue $result)" if $result != 0;
757 $target_power_on = sub {
758 my $result = powerChange($amt_host,$amt_user,$amt_password, "on");
759 die "AMT power on failed (ReturnValue $result)" if $result != 0;
762 $target_reset = sub {
763 my $result = powerChange($amt_host,$amt_user,$amt_password, "reset");
765 print STDERR "Warning: Cannot reset $amt_host, trying power on. ";
766 $result = powerChange($amt_host,$amt_user,$amt_password, "on");
768 die "AMT reset failed (ReturnValue $result)" if $result != 0;
771 my $cmd = "amtterm -u $amt_user -p $amt_password $amt_host $amt_port";
772 print STDERR "novaboot: Running: $cmd\n" =~ s/\Q$amt_password\E/???/r;
773 $exp = Expect->spawn($cmd);
774 $exp->expect(10, "RUN_SOL") || die "Expect for 'RUN_SOL' timed out";
779 if ($remote_expect) {
780 $exp || die("No serial line connection");
781 my $log = $exp->log_stdout;
782 if (defined $remote_expect_silent) {
785 $exp->expect(180, $remote_expect) || die "Expect for '$remote_expect' timed out";
786 if (defined $remote_expect_silent) {
787 $exp->log_stdout($log);
788 print $exp->after() if $log;
792 if (defined $reset_cmd) {
793 $target_reset = sub {
794 system_verbose($reset_cmd);
798 if (defined $on_opt && defined $target_power_on) {
802 if (defined $off_opt && defined $target_power_off) {
803 print STDERR "novaboot: Switching the target off...\n";
804 &$target_power_off();
808 $builddir ||= dirname(File::Spec->rel2abs( ${$scripts[0]}{filename})) if scalar @scripts;
809 if (defined $builddir) {
810 chdir($builddir) or die "Can't change directory to $builddir: $!";
811 print STDERR "novaboot: Entering directory `$builddir'\n";
813 $builddir = $invocation_dir;
816 ## File generation phase
817 my (%files_iso, $menu_iso, $filename);
818 my $config_name = '';
821 foreach my $script (@scripts) {
822 $filename = $$script{filename};
823 $modules = $$script{modules};
824 $generated = $$script{generated};
825 $variables = $$script{variables};
827 ($config_name = $filename) =~ s#.*/##;
828 $config_name = $config_name_opt if (defined $config_name_opt);
830 if (exists $variables->{BUILDDIR}) {
831 $builddir = File::Spec->rel2abs($variables->{BUILDDIR});
832 chdir($builddir) or die "Can't change directory to $builddir: $!";
833 print STDERR "novaboot: Entering directory `$builddir'\n";
837 $prefix = $grub_prefix;
838 $prefix =~ s/\$NAME/$config_name/;
839 $prefix =~ s/\$BUILDDIR/$builddir/;
841 # TODO: use $grub_prefix as first parameter if some switch is given
842 generate_configs('', $generated, $filename);
844 ### Generate bootloader configuration files
845 my @bootloader_configs;
846 push @bootloader_configs, generate_grub_config($grub_config, $config_name, $prefix, $modules, $grub_preamble) if (defined $grub_config);
847 push @bootloader_configs, generate_grub2_config($grub2_config, $config_name, $prefix, $modules, $grub_preamble, $grub2_prolog) if (defined $grub2_config);
848 push @bootloader_configs, generate_pulsar_config('config-'.($pulsar||'novaboot'), $modules) if (defined $pulsar);
850 ### Run scons or make
852 my @files = map({ ($file) = m/([^ ]*)/; $file; } @$modules);
853 # Filter-out generated files
854 my @to_build = grep({ my $file = $_; !scalar(grep($file eq ($$_{filename} || ''), @$generated)) } @files);
856 system_verbose($scons || $CFG::scons." ".join(" ", @to_build)) if (defined $scons);
857 system_verbose($make || $CFG::make ." ".join(" ", @to_build)) if (defined $make);
860 ### Copy files (using rsync)
861 if (defined $server && !defined($gen_only)) {
862 (my $real_server = $server) =~ s/\$NAME/$config_name/;
864 my ($hostname, $path) = split(":", $real_server, 2);
865 if (! defined $path) {
869 my $files = join(" ", map({ ($file) = m/([^ ]*)/; $file; } ( @$modules, @bootloader_configs)));
870 map({ my $file = (split)[0]; die "$file: $!" if ! -f $file; } @$modules);
871 my $istty = -t STDOUT && ($ENV{'TERM'} || 'dumb') ne 'dumb';
872 my $progress = $istty ? "--progress" : "";
874 system_verbose("rsync $progress -RLp $rsync_flags $files $real_server");
875 if ($server =~ m|/\$NAME$| && $concat) {
876 my $cmd = join("; ", map { "( cd $path/.. && cat */$_ > $_ )" } @bootloader_configs);
877 system_verbose($hostname ? "ssh $hostname '$cmd'" : $cmd);
882 ### Prepare ISO image generation
883 if (defined $iso_image) {
884 generate_configs("(cd)", $generated, $filename);
886 generate_syslinux_config(\$menu, $config_name, "/", $modules);
887 $menu_iso .= "$menu\n";
888 map { ($file,undef) = split; $files_iso{$file} = 1; } @$modules;
892 ## Generate ISO image
893 if (defined $iso_image) {
894 system_verbose("mkdir -p isolinux");
897 if (-f '/usr/lib/ISOLINUX/isolinux.bin') {
898 # Newer ISOLINUX version
899 @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);
901 # Older ISOLINUX version
902 @files = qw(/usr/lib/syslinux/isolinux.bin /usr/lib/syslinux/mboot.c32 /usr/lib/syslinux/menu.c32);
904 system_verbose("cp @files isolinux");
905 open(my $fh, ">isolinux/isolinux.cfg");
907 print $fh "TIMEOUT 50\n";
908 print $fh "DEFAULT menu\n";
910 print $fh "DEFAULT $config_name\n";
912 print $fh "$menu_iso";
915 my $files = join(" ", map("$_=$_", (keys(%files_iso), 'isolinux/isolinux.cfg', map(s|.*/|isolinux/|r, @files))));
916 $iso_image ||= "$config_name.iso";
918 # Note: We use -U flag below to "Allow 'untranslated' filenames,
919 # completely violating the ISO9660 standards". Without this
920 # option, isolinux is not able to read files names for example
922 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");
923 print("ISO image created: $builddir/$iso_image\n");
926 exit(0) if defined $gen_only;
928 ## Boot the system using various methods and send serial output to stdout
930 if (scalar(@scripts) > 1 && ( defined $dhcp_tftp || defined $serial || defined $iprelay)) {
931 die "You cannot do this with multiple scripts simultaneously";
934 if ($variables->{WVTEST_TIMEOUT}) {
935 print STDERR "wvtest: timeout ", $variables->{WVTEST_TIMEOUT}, "\n";
942 $qemu ||= $variables->{QEMU} || $CFG::qemu;
943 my @qemu_flags = split(" ", $qemu);
944 $qemu = shift(@qemu_flags);
946 @qemu_flags = split(/ +/, trim($variables->{QEMU_FLAGS})) if exists $variables->{QEMU_FLAGS};
947 @qemu_flags = split(/ +/, trim($qemu_flags_cmd)) if $qemu_flags_cmd;
948 push(@qemu_flags, split(/ +/, trim($qemu_append || '')));
950 if (defined $iso_image) {
951 # Boot NOVA with grub (and test the iso image)
952 push(@qemu_flags, ('-cdrom', $iso_image));
954 # Boot NOVA without GRUB
956 # Non-patched qemu doesn't like commas, but NUL can live with pluses instead of commans
957 foreach (@$modules) {s/,/+/g;}
958 generate_configs("", $generated, $filename);
960 if (scalar @$modules) {
961 my ($kbin, $kcmd) = split(' ', shift(@$modules), 2);
962 $kcmd = '' if !defined $kcmd;
964 @$modules = map { if (/\.dtb$/) { $dtb=$_; (); } else { $_ } } @$modules;
965 my $initrd = join ",", @$modules;
967 push(@qemu_flags, ('-kernel', $kbin, '-append', $kcmd));
968 push(@qemu_flags, ('-initrd', $initrd)) if $initrd;
969 push(@qemu_flags, ('-dtb', $dtb)) if $dtb;
972 push(@qemu_flags, qw(-serial stdio)); # Redirect serial output (for collecting test restuls)
973 unshift(@qemu_flags, ('-name', $config_name));
974 print STDERR "novaboot: Running: ".shell_cmd_string($qemu, @qemu_flags)."\n";
975 $exp = Expect->spawn(($qemu, @qemu_flags)) || die("exec() failed: $!");
978 ### Local DHCPD and TFTPD
980 my ($dhcpd_pid, $tftpd_pid);
982 $tftp=1 if $tftp_port;
984 if (defined $dhcp_tftp)
986 generate_configs("(nd)", $generated, $filename);
987 system_verbose('mkdir -p tftpboot');
988 generate_grub_config("tftpboot/os-menu.lst", $config_name, "(nd)", \@$modules, "timeout 0");
989 open(my $fh, '>', 'dhcpd.conf');
990 my $mac = `cat /sys/class/net/$netif/address`;
992 print $fh "subnet 10.23.23.0 netmask 255.255.255.0 {
993 range 10.23.23.10 10.23.23.100;
994 filename \"bin/boot/grub/pxegrub.pxe\";
995 next-server 10.23.23.1;
998 hardware ethernet $mac;
999 fixed-address 10.23.23.1;
1002 system_verbose("sudo ip a add 10.23.23.1/24 dev $netif;
1003 sudo ip l set dev $netif up;
1004 sudo touch dhcpd.leases");
1006 # We run servers by forking ourselves, because the servers end up
1007 # in our process group and get killed by signals sent to the
1008 # process group (e.g. Ctrl-C on terminal).
1009 $dhcpd_pid = fork();
1010 exec_verbose("sudo dhcpd -d -cf dhcpd.conf -lf dhcpd.leases -pf dhcpd.pid") if ($dhcpd_pid == 0);
1013 if (defined $dhcp_tftp || defined $tftp) {
1015 # Unfortunately, tftpd requires root privileges even with
1016 # non-privileged (>1023) port due to initgroups().
1017 system_verbose("sudo in.tftpd --listen --secure -v -v -v --pidfile tftpd.pid --address :$tftp_port $builddir");
1019 # Kill server when we die
1020 $SIG{__DIE__} = sub { system_verbose('sudo pkill --pidfile=dhcpd.pid') if (defined $dhcp_tftp);
1021 system_verbose('sudo pkill --pidfile=tftpd.pid'); };
1023 # We have to kill tftpd explicitely, because it is not in our process group
1024 $SIG{INT} = sub { system_verbose('sudo pkill --pidfile=tftpd.pid'); exit(0); };
1028 if (defined $ider) {
1029 my $ider_cmd= "amtider -c $iso_image -u $amt_user -p $amt_password $amt_host $amt_port" ;
1030 print STDERR "novaboot: Running: $ider_cmd\n" =~ s/\Q$amt_password\E/???/r;
1031 my $ider_pid = fork();
1032 if ($ider_pid == 0) {
1034 die "IDE redirection failed";
1036 # FIXME: This collides with --tftp option. Hopefully, nobody needs
1037 # to use both simultaneously.
1038 $SIG{__DIE__} = sub { system_verbose('kill $ider_pid'); };
1041 ### Reset target (IP relay, AMT, ...)
1043 if (defined $target_reset && $reset) {
1044 print STDERR "novaboot: Reseting the test box... ";
1046 print STDERR "done\n";
1048 # We don't want to output anything printed by the target
1049 # before reset so we clear the buffers now. This is, however,
1050 # not ideal because we may loose some data that were sent
1051 # after the reset. If this is a problem, one should reset and
1052 # connect to serial line in atomic manner. For example, if
1053 # supported by hardware, use --remote-cmd 'sterm -d ...' and
1054 # do not use separate --reset-cmd.
1055 my $log = $exp->log_stdout;
1056 $exp->log_stdout(0);
1057 $exp->expect(0); # Read data from target
1058 $exp->clear_accum(); # Clear the read data
1059 $exp->log_stdout($log);
1063 ### U-boot conversation
1064 if (defined $uboot) {
1065 my $uboot_prompt = $uboot || '=> ';
1066 print STDERR "novaboot: Waiting for U-Boot prompt...\n";
1067 $exp || die("No serial line connection");
1068 $exp->log_stdout(1);
1069 #$exp->exp_internal(1);
1071 [qr/Hit any key to stop autoboot:/, sub { $exp->send("\n"); exp_continue; }],
1072 $uboot_prompt) || die "No U-Boot prompt deteceted";
1073 foreach my $cmdspec (@uboot_init) {
1074 my ($cmd, $timeout);
1075 if (ref($cmdspec) eq "HASH") {
1076 $cmd = $cmdspec->{command};
1077 $timeout = $cmdspec->{timeout};
1082 if ($cmd =~ /\$NB_MYIP/) {
1083 my $ip = (grep /inet /, `ip addr show $netif`)[0] || die "Problem determining our IP address";
1084 $ip =~ s/\s*inet ([0-9.]*).*/$1/;
1085 $cmd =~ s/\$NB_MYIP/$ip/g;
1087 if ($cmd =~ /\$NB_PREFIX/) {
1090 $cmd =~ s/\$NB_PREFIX/$p/g;
1093 $exp->send("$cmd\n");
1094 $exp->expect($timeout, $uboot_prompt) || die "U-Boot prompt timeout";
1097 # Load files if there are some load lines in the script
1098 if (scalar(@$modules) > 0 && !$variables->{NO_BOOT}) {
1099 my ($kbin, $kcmd) = split(' ', shift(@$modules), 2);
1101 @$modules = map { if (/\.dtb$/) { $dtb=$_; (); } else { $_ } } @$modules;
1102 my $initrd = shift @$modules;
1104 if (defined $kbin) {
1105 die "No '--uboot-addr kernel' given" unless $uboot_addr{kernel};
1106 $exp->send("tftpboot $uboot_addr{kernel} $prefix$kbin\n");
1108 [qr/##/, sub { exp_continue; }],
1109 $uboot_prompt) || die "Kernel load timeout";
1112 die "No '--uboot-addr fdt' given" unless $uboot_addr{fdt};
1113 $exp->send("tftpboot $uboot_addr{fdt} $prefix$dtb\n");
1115 [qr/##/, sub { exp_continue; }],
1116 $uboot_prompt) || die "Device tree load timeout";
1118 if (defined $initrd) {
1119 die "No '--uboot-addr ramdisk' given" unless $uboot_addr{ramdisk};
1120 $exp->send("tftpboot $uboot_addr{ramdisk} $prefix$initrd\n");
1122 [qr/##/, sub { exp_continue; }],
1123 $uboot_prompt) || die "Initrd load timeout";
1125 $uboot_addr{ramdisk} = '-';
1129 $exp->send("setenv bootargs $kcmd\n");
1130 $exp->expect(5, $uboot_prompt) || die "U-Boot prompt timeout";
1133 if (!$variables->{NO_BOOT}) {
1134 $uboot_cmd //= $variables->{UBOOT_CMD} // 'bootm $kernel_addr $ramdisk_addr $fdt_addr';
1135 $uboot_cmd =~ s/\$kernel_addr/$uboot_addr{kernel}/g;
1136 $uboot_cmd =~ s/\$ramdisk_addr/$uboot_addr{ramdisk}/g;
1137 $uboot_cmd =~ s/\$fdt_addr/$uboot_addr{fdt}/g;
1139 $exp->send($uboot_cmd . "\n");
1140 $exp->expect(5, "\n") || die "U-Boot command timeout";
1144 ### Serial line interaction
1145 if ($interaction && defined $exp) {
1146 # Serial line of the target is available
1147 my $interrupt = 'Ctrl-C';
1148 if ($interactive && !@exiton) {
1149 $interrupt = '"~~."';
1151 print STDERR "novaboot: Serial line interaction (press $interrupt to interrupt)...\n";
1152 $exp->log_stdout(1);
1154 $exp->expect($exiton_timeout, @expect_raw, @exiton) || die("exiton timeout");
1156 my @inputs = ($exp);
1157 my $infile = new IO::File;
1158 $infile->IO::File::fdopen(*STDIN,'r');
1159 my $in_object = Expect->exp_init($infile);
1160 $in_object->set_group($exp);
1163 $in_object->set_seq('~~\.', sub { print STDERR "novaboot: Escape sequence detected\r\n"; undef; });
1164 $in_object->manual_stty(0); # Use raw terminal mode
1166 $in_object->manual_stty(1); # Do not modify terminal settings
1168 push(@inputs, $in_object);
1170 #print Dumper(\@expect_raw);
1171 $exp->expect(undef, @expect_raw) if @expect_raw;
1172 Expect::interconnect(@inputs) unless defined($exp->exitstatus);
1176 ## Kill dhcpc or tftpd
1177 if (defined $dhcp_tftp || defined $tftp) {
1178 die("novaboot: This should kill servers on background\n");
1181 # Always finish novaboot output with newline
1182 print "\n" if $final_eol;
1188 novaboot - Boots a locally compiled operating system on a remote
1195 B<novaboot> [option]... [--] script...
1197 B<./script> [option]...
1201 This program makes booting of a locally compiled operating system (OS)
1202 (e.g. NOVA or Linux) on remote targets as simple as running a program
1203 locally. It automates things like copying OS images to a TFTP server,
1204 generation of bootloader configuration files, resetting of target
1205 hardware or redirection of target's serial line to stdin/out. Novaboot
1206 is highly configurable and it makes it easy to boot a single image on
1207 different targets or different images on a single target.
1209 Novaboot operation is controlled by command line options and by a so
1210 called novaboot script, which can be thought as a generalization of
1211 bootloader configuration files (see L</"NOVABOOT SCRIPT SYNTAX">).
1212 Typical way of using novaboot is to make the novaboot script
1213 executable and set its first line to I<#!/usr/bin/env novaboot>. Then,
1214 booting a particular OS configuration becomes the same as executing a
1215 local program - the novaboot script.
1217 Novaboot uses configuration files to, among other things, define
1218 command line options needed for different targets. Users typically use
1219 only the B<-t>/B<--target> command line option to select the target.
1220 Internally, this option expands to the pre-configured options.
1221 Configuration files are searched at multiple places, which allows to
1222 have per-system, per-user or per-project configurations. Configuration
1223 file syntax is described in section L</"CONFIGURATION FILES">.
1225 Simple examples of using C<novaboot>:
1231 Run an OS in Qemu. This is can be specified with the B<--qemu> option.
1232 Thus running C<novaboot --qemu myos> (or C<./myos --qemu> as described
1233 above) will run Qemu and make it boot the configuration specified in
1238 Create a bootloader configuration file (currently supported
1239 bootloaders are GRUB, GRUB2, ISOLINUX, Pulsar and U-Boot) and copy it
1240 with all other files needed for booting to a remote boot server. Then
1241 use a TCP/IP-controlled relay/serial-to-TCP converter to reset the
1242 target and receive its serial output.
1244 ./myos --grub2 --server=192.168.1.1:/tftp --iprelay=192.168.1.2
1248 Run DHCP and TFTP server on developer's machine to boot the target
1253 This is useful when no network infrastructure is in place and
1254 the target is connected directly to developer's box.
1258 Create bootable ISO image.
1260 novaboot --iso -- script1 script2
1262 The created ISO image will have ISOLINUX bootloader installed on it
1263 and the boot menu will allow selecting between I<script1> and
1264 I<script2> configurations.
1268 =head1 PHASES AND OPTIONS
1270 Novaboot performs its work in several phases. Each phase can be
1271 influenced by several command line options, certain phases can be
1272 skipped. The list of phases (in the execution order) is as follows.
1276 =item 1. L<Configuration reading|/Configuration reading phase>
1278 =item 2. L<Command line processing|/Command line processing phase>
1280 =item 3. L<Script preprocessing|/Script preprocessing phase>
1282 =item 4. L<File generation|/File generation phase>
1284 =item 5. L<Target connection|/Target connection check>
1286 =item 6. L<File deployment|/File deployment phase>
1288 =item 7. L<Target power-on and reset|/Target power-on and reset phase>
1290 =item 8. L<Interaction with the bootloader|/Interaction with the bootloader on the target>
1292 =item 9. L<Target interaction|/Target interaction phase>
1296 Each phase is described in the following sections together with the
1297 command line options that control it.
1299 =head2 Configuration reading phase
1301 After starting, novaboot reads configuration files. Their content is
1302 described in section L</"CONFIGURATION FILES">. By default,
1303 configuration is read from multiple locations. First from the system
1304 configuration directory (F</etc/novaboot.d/>), second from the user
1305 configuration file (F<~/.config/novaboot>) and third from F<.novaboot>
1306 files along the path to the current directory. Alternatively, a single
1307 configuration file specified with the B<-c> switch or with the
1308 C<NOVABOOT_CONFIG> environment variable is read. The latter read files
1309 override settings from the former ones.
1311 The system configuration directory is determined by the content of
1312 NOVABOOT_CONFIG_DIR environment variable and defaults to
1313 F</etc/novaboot.d>. Files in this directory with names consisting
1314 solely of English letters, numbers, dashes '-' and underscores '_'
1315 (note that dot '.' is not included) are read in alphabetical order.
1317 Then, the user configuration file is read from
1318 F<$XDG_CONFIG_HOME/novaboot>. If C<$XDG_CONFIG_HOME> environemnt
1319 variable is not set F<~/.config/novaboot> is read instead.
1321 Finally, novaboot searches for files named F<.novaboot> starting from the
1322 directory of the novaboot script (or working directory, see bellow)
1323 and continuing upwards up to the root directory. The found
1324 configuration files are then read in the opposite order (i.e. from the
1325 root directory downwards). This allows to have, for example, a project
1326 specific configuration in F<~/project/.novaboot>.
1328 Note the difference between F<~/.config/novaboot> and F<~/.novaboot>.
1329 The former one is read always, whereas the latter only when novaboot
1330 script or working directory is under the C<$HOME> directory.
1332 In certain cases, the location of the novaboot script cannot be
1333 determined in this early phase. This happens either when the script is
1334 read from the standard input or when novaboot is invoked explicitly as
1335 in the example L</"4."> above. In this case the current working
1336 directory is used as a starting point for configuration file search
1337 instead of the novaboot script directory.
1341 =item -c, --config=I<filename>
1343 Use the specified configuration file instead of the default one(s).
1347 =head2 Command line processing phase
1353 Dump the current configuration to stdout end exit. Useful as an
1354 initial template for a configuration file.
1358 Print short (B<-h>) or long (B<--help>) help.
1360 =item -t, --target=I<target>
1362 This option serves as a user configurable shortcut for other novaboot
1363 options. The effect of this option is the same as specifying the
1364 options stored in the C<%targets> configuration variable under key
1365 I<target>. See also L</"CONFIGURATION FILES">.
1367 When this option is not given, novaboot tries to determine the target
1368 to use from either B<NOVABOOT_TARGET> environment variable or from
1369 B<$default_target> configuration file variable.
1373 =head2 Script preprocessing phase
1375 This phases allows to modify the parsed novaboot script before it is
1376 used in the later phases.
1380 =item -a, --append=I<parameters>
1382 Append a string to the first C<load> line in the novaboot script. This
1383 can be used to append parameters to the kernel's or root task's
1384 command line. This option can appear multiple times.
1388 Use F<bender> chainloader. Bender scans the PCI bus for PCI serial
1389 ports and stores the information about them in the BIOS data area for
1392 =item --chainloader=I<chainloader>
1394 Specifies a chainloader that is loaded before the kernel and other
1395 files specified in the novaboot script. E.g. 'bin/boot/bender
1400 Print the modules to boot and their parameters after this phase
1401 finishes. Then exit. This is useful for seeing the effect of other
1402 options in this section.
1404 =item -k, --kernel=F<file>
1406 Replace the first word on the first C<load> line in the novaboot
1407 script with F<file>.
1409 =item --scriptmod=I<perl expression>
1411 When novaboot script is read, I<perl expression> is executed for every
1412 line (in $_ variable). For example, C<novaboot
1413 --scriptmod=s/sigma0/omega6/g> replaces every occurrence of I<sigma0>
1414 in the script with I<omega6>.
1416 When this option is present, it overrides I<$script_modifier> variable
1417 from the configuration file, which has the same effect. If this option
1418 is given multiple times all expressions are evaluated in the command
1423 =head2 File generation phase
1425 In this phase, files needed for booting are generated in a so called
1426 I<build directory> (see L</--build-dir>). In most cases configuration
1427 for a bootloader is generated automatically by novaboot. It is also
1428 possible to generate other files using I<heredoc> or I<"<"> syntax in
1429 novaboot scripts. Finally, binaries can be generated in this phases by
1430 running C<scons> or C<make>.
1434 =item --build-dir=I<directory>
1436 Overrides the default build directory location.
1438 The default build directory location is determined as follows: If the
1439 configuration file defines the C<$builddir> variable, its value is
1440 used. Otherwise, it is the directory that contains the first processed
1443 See also L</BUILDDIR> variable.
1445 =item -g, --grub[=I<filename>]
1447 Generates grub bootloader menu file. If the I<filename> is not
1448 specified, F<menu.lst> is used. The I<filename> is relative to the
1449 build directory (see B<--build-dir>).
1451 =item --grub-preamble=I<prefix>
1453 Specifies the I<preable> that is at the beginning of the generated
1454 GRUB or GRUB2 config files. This is useful for specifying GRUB's
1457 =item --prefix=I<prefix>
1459 Specifies I<prefix> (e.g. F</srv/tftp>) that is put in front of every
1460 file name in generated bootloader configuration files (or in U-Boot
1463 If the I<prefix> contains string $NAME, it will be replaced with the
1464 name of the novaboot script (see also B<--name>).
1466 If the I<prefix> contains string $BUILDDIR, it will be replaced with
1467 the build directory (see also B<--build-dir>).
1471 Alias for B<--prefix>.
1473 =item --grub2[=I<filename>]
1475 Generate GRUB2 menu entry in I<filename>. If I<filename> is not
1476 specified F<grub.cfg> is used. The content of the menu entry can be
1477 customized with B<--grub-preamble>, B<--grub2-prolog> or
1478 B<--grub_prefix> options.
1480 In order to use the the generated menu entry on your development
1481 machine that uses GRUB2, append the following snippet to
1482 F</etc/grub.d/40_custom> file and regenerate your grub configuration,
1483 i.e. run update-grub on Debian/Ubuntu.
1485 if [ -f /path/to/nul/build/grub.cfg ]; then
1486 source /path/to/nul/build/grub.cfg
1489 =item --grub2-prolog=I<prolog>
1491 Specifies text that is put at the beginning of the GRUB2 menu entry.
1493 =item -m, --make[=make command]
1495 Runs C<make> to build files that are not generated by novaboot itself.
1497 =item --name=I<string>
1499 Use the name I<string> instead of the name of the novaboot script.
1500 This name is used for things like a title of grub menu or for the
1501 server directory where the boot files are copied to.
1505 Do not run external commands to generate files (i.e. "<" syntax and
1506 C<run> keyword). This switch does not influence generation of files
1507 specified with "<<WORD" syntax.
1509 =item -p, --pulsar[=mac]
1511 Generates pulsar bootloader configuration file named F<config-I<mac>>
1512 The I<mac> string is typically a MAC address and defaults to
1515 =item --scons[=scons command]
1517 Runs C<scons> to build files that are not generated by novaboot
1522 Strip I<rom://> prefix from command lines and generated config files.
1523 The I<rom://> prefix is used by NUL. For NRE, it has to be stripped.
1527 Exit novaboot after file generation phase.
1531 =head2 Target connection check
1533 If supported by the target, the connection to it is made and it is
1534 checked whether the target is not occupied by another novaboot
1539 =item --amt=I<"[user[:password]@]host[:port]>
1541 Use Intel AMT technology to control the target machine. WS management
1542 is used to powercycle it and Serial-Over-Lan (SOL) for input/output.
1543 The hostname or (IP address) is given by the I<host> parameter. If
1544 I<password> is not specified, environment variable AMT_PASSWORD is
1545 used. The I<port> specifies a TCP port for SOL. If not specified, the
1546 default is 16992. Default I<user> is admin.
1548 =item --iprelay=I<addr[:port]>
1550 Use TCP/IP relay and serial port to access the target's serial port
1551 and powercycle it. The IP address of the relay is given by I<addr>
1552 parameter. If I<port> is not specified, it default to 23.
1554 Note: This option is supposed to work with HWG-ER02a IP relays.
1556 =item -s, --serial[=device]
1558 Target's serial line is connected to host's serial line (device). The
1559 default value for device is F</dev/ttyUSB0>.
1561 The value of this option is exported in NB_NOVABOOT environment
1562 variable to all subprocesses run by C<novaboot>.
1564 =item --stty=I<settings>
1566 Specifies settings passed to C<stty> invoked on the serial line
1567 specified with B<--serial> option. If this option is not given,
1568 C<stty> is called with C<raw -crtscts -onlcr 115200> settings.
1570 =item --remote-cmd=I<cmd>
1572 Command that mediates connection to the target's serial line. For
1573 example C<ssh server 'cu -l /dev/ttyS0'>.
1575 =item --remote-expect=I<string>
1577 Wait for reception of I<string> after establishing the remote
1580 =item --remote-expect-silent=I<string>
1582 The same as B<--remote-expect> except that the remote output is not
1583 echoed to stdout while waiting for the I<string>. Everything after the
1584 matched string is printed to stdout, so you may want to include line
1585 end characters in the I<string> as well.
1589 =head2 File deployment phase
1591 In some setups, it is necessary to copy the files needed for booting
1592 to a particular location, e.g. to a TFTP boot server or to the
1597 =item -d, --dhcp-tftp
1599 Turns your workstation into a DHCP and TFTP server so that the OS can
1600 be booted via PXE BIOS (or similar mechanism) on the test machine
1601 directly connected by a plain Ethernet cable to your workstation.
1603 The DHCP and TFTP servers requires root privileges and C<novaboot>
1604 uses C<sudo> command to obtain those. You can put the following to
1605 I</etc/sudoers> to allow running the necessary commands without asking
1608 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
1609 your_login ALL=NOPASSWD: NOVABOOT
1613 Starts a TFTP server on your workstation. This is similar to
1614 B<--dhcp-tftp> except that DHCP server is not started.
1616 The TFTP server require root privileges and C<novaboot> uses C<sudo>
1617 command to obtain those. You can put the following to I</etc/sudoers>
1618 to allow running the necessary commands without asking for password.
1620 Cmnd_Alias NOVABOOT = /usr/sbin/in.tftpd --listen --secure -v -v -v --pidfile tftpd.pid *, /usr/bin/pkill --pidfile=tftpd.pid
1621 your_login ALL=NOPASSWD: NOVABOOT
1623 =item --tftp-port=I<port>
1625 Port to run the TFTP server on. Implies B<--tftp>.
1627 =item --netif=I<network interface>
1629 Network interface used to deploy files to the target. Default value is
1630 I<eth0>. This influences the configuration of the DHCP server started
1631 by B<--dhcp-tftp> and the value that B<$NB_MYIP> get replaced with in
1632 U-Boot conversation.
1634 =item --iso[=filename]
1636 Generates the ISO image that boots NOVA system via GRUB. If no filename
1637 is given, the image is stored under I<NAME>.iso, where I<NAME> is the name
1638 of the novaboot script (see also B<--name>).
1640 =item --server[=[[user@]server:]path]
1642 Copy all files needed for booting to another location. The files will
1643 be copied (by B<rsync> tool) to the directory I<path>. If the I<path>
1644 contains string $NAME, it will be replaced with the name of the
1645 novaboot script (see also B<--name>).
1647 =item --rsync-flags=I<flags>
1649 Specifies which I<flags> are appended to F<rsync> command line when
1650 copying files as a result of I<--server> option.
1654 If B<--server> is used and its value ends with $NAME, then after
1655 copying the files, a new bootloader configuration file (e.g. menu.lst)
1656 is created at I<path-wo-name>, i.e. the path specified by B<--server>
1657 with $NAME part removed. The content of the file is created by
1658 concatenating all files of the same name from all subdirectories of
1659 I<path-wo-name> found on the "server".
1663 Use Intel AMT technology for IDE redirection. This allows the target
1664 machine to boot from novaboot created ISO image. Implies B<--iso>.
1666 The experimental C<amtider> utility needed by this option can be
1667 obtained from https://github.com/wentasah/amtterm.
1671 =head2 Target power-on and reset phase
1673 At this point, the target is reset (or switched on/off). There is
1674 several ways how this can be accomplished. Resetting a physical target
1675 can currently be accomplished by the following options: B<--amt>,
1676 B<--iprelay>, B<--reset-cmd>.
1682 Switch on/off the target machine and exit. The script (if any) is
1683 completely ignored. Currently it works only with B<--iprelay> or
1686 =item -Q, --qemu[=I<qemu-binary>]
1688 Boot the configuration in qemu. Optionally, the name of qemu binary
1689 can be specified as a parameter.
1691 =item --qemu-append=I<flags>
1693 Append I<flags> to the default qemu flags (QEMU_FLAGS variable or
1694 C<-cpu coreduo -smp 2>).
1696 =item -q, --qemu-flags=I<flags>
1698 Replace the default qemu flags (QEMU_FLAGS variable or C<-cpu coreduo
1699 -smp 2>) with I<flags> specified here.
1701 =item --reset-cmd=I<cmd>
1703 Command that resets the target.
1705 =item --no-reset, --reset
1707 Disable/enable resetting of the target.
1711 =head2 Interaction with the bootloader on the target
1715 =item --uboot[=I<prompt>]
1717 Interact with U-Boot bootloader to boot the thing described in the
1718 novaboot script. I<prompt> specifies the U-Boot's prompt (default is
1719 "=> ", other common prompts are "U-Boot> " or "U-Boot# ").
1720 Implementation of this option is currently tied to a particular board
1721 that we use. It may be subject to changes in the future!
1725 Disable U-Boot interaction previously enabled with B<--uboot>.
1729 Command(s) to send the U-Boot bootloader before loading the images and
1730 booting them. This option can be given multiple times. After sending
1731 commands from each option novaboot waits for U-Boot I<prompt>.
1733 If the command contains string I<$NB_MYIP> then this string is
1734 replaced by IPv4 address of eth0 interface (see also B<--netif>).
1735 Similarly I<$NB_PREFIX> is replaced with prefix given by B<--prefix>.
1737 See also C<uboot> keyword in L</"NOVABOOT SCRIPT SYNTAX">).
1739 =item --uboot-addr I<name>=I<address>
1741 Load address of U-Boot's C<tftpboot> command for loading I<name>,
1742 where name is one of I<kernel>, I<ramdisk> or I<fdt> (flattened device
1745 The default addresses are ${I<name>_addr_r}, i.e. U-Boot environment
1746 variables used by convention for this purpose.
1748 =item --uboot-cmd=I<command>
1750 Specifies U-Boot command used to execute the OS. If the command
1751 contains strings C<$kernel_addr>, C<$ramdisk_addr>, C<$fdt_addr>,
1752 these are replaced with the addresses configured with B<--uboot-addr>.
1754 The default value is
1756 bootm $kernel_addr $ramdisk_addr $fdt_addr
1758 or the C<UBOOT_CMD> variable if defined in the novaboot script.
1762 =head2 Target interaction phase
1764 In this phase, target's serial output is redirected to stdout and if
1765 stdin is a TTY, it is redirected to the target's serial input allowing
1766 interactive work with the target.
1770 =item --exiton=I<string>
1772 When I<string> is sent by the target, novaboot exits. This option can
1773 be specified multiple times, in which case novaboot exits whenever
1774 either of the specified strings is sent.
1776 If I<string> is C<-re>, then the next B<--exiton>'s I<string> is
1777 treated as regular expression. For example:
1779 --exiton -re --exiton 'error:.*failed'
1781 =item --exiton-re=I<regex>
1783 The same as --exiton -re --exiton I<regex>.
1785 =item --exiton-timeout=I<seconds>
1787 By default B<--exiton> waits for the string match forever. When this
1788 option is specified, "exiton" timeouts after the specifies number of
1789 seconds and novaboot returns non-zero exit code.
1791 =item -i, --interactive
1793 Setup things for interactive use of target. Your terminal will be
1794 switched to raw mode. In raw mode, your system does not process input
1795 in any way (no echoing of entered characters, no interpretation
1796 special characters). This, among others, means that Ctrl-C is passed
1797 to the target and does no longer interrupt novaboot. Use "~~."
1798 sequence to exit novaboot.
1800 =item --no-interaction, --interaction
1802 Skip resp. force target interaction phase. When skipped, novaboot exits
1803 immediately when boot is initiated.
1805 =item --expect=I<string>
1807 When I<string> is received from the target, send the string specified
1808 with the subsequent B<--send*> option to the target.
1810 =item --expect-re=I<regex>
1812 When target's output matches regular expression I<regex>, send the
1813 string specified with the subsequent B<--send*> option to the target.
1815 =item --expect-raw=I<perl-code>
1817 Provides direct control over Perl's Expect module.
1819 =item --send=I<string>
1821 Send I<string> to the target after the previously specified
1822 B<--expect*> was matched in the target's output. The I<string> may
1823 contain escape sequences such as "\n".
1825 Note that I<string> is actually interpreted by Perl, so it can contain
1826 much more that escape sequences. This behavior may change in the
1829 Example: C<--expect='login: ' --send='root\n'>
1831 =item --sendcont=I<string>
1833 Similar to B<--send> but continue expecting more input.
1835 Example: C<--expect='Continue?' --sendcont='yes\n'>
1837 =item --final-eol, --no-final-eol
1839 By default, B<novaboot> always prints an end-of-line character at the
1840 end of its execution in order to ensure that the output of programs
1841 started after novaboot appears at the beginning of the line. When this
1842 is not desired B<--no-final-eol> option can be used to override this
1847 =head1 NOVABOOT SCRIPT SYNTAX
1849 The syntax tries to mimic POSIX shell syntax. The syntax is defined
1850 with the following rules.
1852 Lines starting with "#" and empty lines are ignored.
1854 Lines that end with "\" are concatenated with the following line after
1855 removal of the final "\" and leading whitespace of the following line.
1857 Lines of the form I<VARIABLE=...> (i.e. matching '^[A-Z_]+=' regular
1858 expression) assign values to internal variables. See L</VARIABLES>
1861 Lines starting with C<load> keyword represent modules to boot. The
1862 word after C<load> is a file name (relative to the build directory
1863 (see B<--build-dir>) of the module to load and the remaining words are
1864 passed to it as the command line parameters.
1866 When the C<load> line ends with "<<WORD" then the subsequent lines
1867 until the line containing solely WORD are copied literally to the file
1868 named on that line. This is similar to shell's heredoc feature.
1870 When the C<load> line ends with "< CMD" then command CMD is executed
1871 with F</bin/sh> and its standard output is stored in the file named on
1872 that line. The SRCDIR variable in CMD's environment is set to the
1873 absolute path of the directory containing the interpreted novaboot
1876 Lines starting with C<run> keyword contain shell commands that are run
1877 during file generation phase. This is the same as the "< CMD" syntax
1878 for C<load> keyboard except that the command's output is not
1879 redirected to a file. The ordering of commands is the same as they
1880 appear in the novaboot script.
1882 Lines starting with C<uboot> represent U-Boot commands that are sent
1883 to the target if B<--uboot> option is given. Having a U-Boot line in
1884 the novaboot script is the same as passing an equivalent
1885 B<--uboot-init> option to novaboot. The C<uboot> keyword can be
1886 suffixed with timeout specification. The syntax is C<uboot:Ns>, where
1887 C<N> is the whole number of seconds. If the U-Boot command prompt does
1888 not appear before the timeout, novaboot fails. The default timeout is
1893 #!/usr/bin/env novaboot
1894 load bzImage console=ttyS0,115200
1895 run make -C buildroot
1896 load rootfs.cpio < gen_cpio buildroot/images/rootfs.cpio "myapp->/etc/init.d/S99myapp"
1898 Example (NOVA User Land - NUL):
1900 #!/usr/bin/env novaboot
1901 WVDESC=Example program
1902 load bin/apps/sigma0.nul S0_DEFAULT script_start:1,1 \
1903 verbose hostkeyb:0,0x60,1,12,2
1904 load bin/apps/hello.nul
1905 load hello.nulconfig <<EOF
1906 sigma0::mem:16 name::/s0/log name::/s0/timer name::/s0/fs/rom ||
1907 rom://bin/apps/hello.nul
1910 This example will load three modules: F<sigma0.nul>, F<hello.nul> and
1911 F<hello.nulconfig>. sigma0 receives some command line parameters and
1912 F<hello.nulconfig> file is generated on the fly from the lines between
1913 C<<<EOF> and C<EOF>.
1917 The following variables are interpreted in the novaboot script:
1923 Novaboot chdir()s to this directory before file generation phase. The
1924 directory name specified here is relative to the build directory
1925 specified by other means (see L</--build-dir>).
1929 Assigning this variable has the same effect as specifying L</--exiton>
1932 =item HYPERVISOR_PARAMS
1934 Parameters passed to hypervisor. The default value is "serial", unless
1935 overridden in configuration file.
1939 The kernel to use instead of the hypervisor specified in the
1940 configuration file with the C<$hypervisor> variable. The value should
1941 contain the name of the kernel image as well as its command line
1942 parameters. If this variable is defined and non-empty, the variable
1943 HYPERVISOR_PARAMS is not used.
1947 If this variable is 1, the system is not booted. This is currently
1948 only implemented for U-Boot bootloader where it is useful for
1949 interacting with the bootloader without booting the system - e.g. for
1954 Use a specific qemu binary (can be overridden with B<-Q>) and flags
1955 when booting this script under qemu. If QEMU_FLAGS variable is also
1956 specified flags specified in QEMU variable are replaced by those in
1961 Use specific qemu flags (can be overridden with B<-q>).
1965 See L</--uboot-cmd>.
1969 Description of the WvTest-compliant program.
1971 =item WVTEST_TIMEOUT
1973 The timeout in seconds for WvTest harness. If no complete line appears
1974 in the test output within the time specified here, the test fails. It
1975 is necessary to specify this for long running tests that produce no
1976 intermediate output.
1980 =head1 CONFIGURATION FILES
1982 Novaboot can read its configuration from one or more files. By
1983 default, novaboot looks for files in F</etc/novaboot.d>, file
1984 F<~/.config/novaboot> and files named F<.novaboot> as described in
1985 L</Configuration reading phase>. Alternatively, configuration file
1986 location can be specified with the B<-c> switch or with the
1987 NOVABOOT_CONFIG environment variable. The configuration file has Perl
1988 syntax (i.e. it is better to put C<1;> as the last line) and should set
1989 values of certain Perl variables. The current configuration can be
1990 dumped with the B<--dump-config> switch. Some configuration variables
1991 can be overridden by environment variables (see below) or by command
1994 Supported configuration variables include:
2000 Build directory location relative to the location of the configuration
2003 =item $default_target
2005 Default target (see below) to use when no target is explicitly
2006 specified with the B<--target> command line option or
2007 B<NOVABOOT_TARGET> environment variable.
2011 Hash of target definitions to be used with the B<--target> option. The
2012 key is the identifier of the target, the value is the string with
2013 command line options. For instance, if the configuration file contains:
2015 $targets{'mybox'} = '--server=boot:/tftproot --serial=/dev/ttyUSB0 --grub',
2017 then the following two commands are equivalent:
2019 ./myos --server=boot:/tftproot --serial=/dev/ttyUSB0 --grub
2024 =head1 ENVIRONMENT VARIABLES
2026 Some options can be specified not only via config file or command line
2027 but also through environment variables. Environment variables override
2028 the values from configuration file and command line parameters
2029 override the environment variables.
2033 =item NOVABOOT_CONFIG
2035 Name of the novaboot configuration file to use instead of the default
2038 =item NOVABOOT_CONFIG_DIR
2040 Name of the novaboot configuration directory. When not specified
2041 F</etc/novaboot.d> is used.
2043 =item NOVABOOT_TARGET
2045 Name of the novaboot target to use. This overrides the value of
2046 B<$default_target> from the configuration file and can be overriden
2047 with the B<--target> command line option.
2049 =item NOVABOOT_BENDER
2051 Defining this variable has the same meaning as B<--bender> option.
2057 Michal Sojka <sojka@os.inf.tu-dresden.de>
2061 # LocalWords: novaboot Novaboot NOVABOOT TFTP PXE DHCP filename stty
2062 # LocalWords: chainloader stdout Qemu qemu preprocessing ISOLINUX bootable
2063 # LocalWords: config subprocesses sudo sudoers tftp dhcp IDE stdin
2064 # LocalWords: subdirectories TTY whitespace heredoc POSIX WvTest