3 # This program is free software: you can redistribute it and/or modify
4 # it under the terms of the GNU General Public License as published by
5 # the Free Software Foundation, either version 2 of the License, or
6 # (at your option) any later version.
8 # This program is distributed in the hope that it will be useful,
9 # but WITHOUT ANY WARRANTY; without even the implied warranty of
10 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 # GNU General Public License for more details.
13 # You should have received a copy of the GNU General Public License
14 # along with this program. If not, see <http://www.gnu.org/licenses/>.
18 use warnings (exists $ENV{NOVABOOT_TEST} ? (FATAL => 'all') : ());
19 use Getopt::Long qw(GetOptionsFromString);
24 use Time::HiRes("usleep");
28 use POSIX qw(:errno_h);
29 use Cwd qw(getcwd abs_path);
35 my $invocation_dir = $ENV{PWD} || getcwd();
37 ## Configuration file handling
39 # Default configuration
40 $CFG::hypervisor = "";
41 $CFG::hypervisor_params = "serial";
42 $CFG::genisoimage = "genisoimage";
43 $CFG::qemu = 'qemu -cpu coreduo -smp 2';
44 $CFG::default_target = 'qemu';
47 "tud" => '--server=erwin.inf.tu-dresden.de:~sojka/boot/novaboot --rsync-flags="--chmod=Dg+s,ug+w,o-w,+rX --rsync-path=\"umask 002 && rsync\"" --grub --grub-prefix=(nd)/tftpboot/sojka/novaboot --grub-preamble="timeout 0" --concat --iprelay=141.76.48.80:2324 --scriptmod=s/\\\\bhostserial\\\\b/hostserialpci/g',
48 "novabox" => '--server=rtime.felk.cvut.cz:/srv/tftp/novaboot --rsync-flags="--chmod=Dg+s,ug+w,o-w,+rX --rsync-path=\"umask 002 && rsync\"" --pulsar --iprelay=147.32.86.92:2324',
49 "localhost" => '--scriptmod=s/console=tty[A-Z0-9,]+// --server=/boot/novaboot/$NAME --grub2 --grub-prefix=/boot/novaboot/$NAME --grub2-prolog=" set root=\'(hd0,msdos1)\'"',
50 "ryuglab" => '--server=pc-sojkam.felk.cvut.cz:/srv/tftp --uboot --uboot-init="mw f0000b00 \${psc_cfg}; sleep 1" --remote-cmd="ssh -t pc-sojkam.felk.cvut.cz \"cu -l /dev/ttyUSB0 -s 115200\"" --remote-expect="Connected." --reset-cmd="ssh -t pc-sojkam.felk.cvut.cz \"dtrrts /dev/ttyUSB0 1 1\""',
51 "ryulocal" => '--dhcp-tftp --serial --uboot --uboot-init="dhcp; mw f0000b00 \${psc_cfg}; sleep 1" --reset-cmd="if which dtrrts; then dtrrts $NB_SERIAL 0 1; sleep 0.1; dtrrts $NB_SERIAL 1 1; fi"',
54 chomp(my $nproc = `nproc`);
55 $CFG::scons = "scons -j$nproc";
56 $CFG::make = "make -j$nproc";
63 package CFG; # Put config data into a separate namespace
68 die("ERROR: Failure compiling '$cfg' - $@");
69 } elsif (! defined($rc)) {
70 die("ERROR: Failure reading '$cfg' - $!");
72 die("ERROR: Failure processing '$cfg'");
75 $builddir = File::Spec->rel2abs($CFG::builddir, dirname($cfg)) if defined $CFG::builddir;
76 print STDERR "novaboot: Read $cfg\n";
81 # We don't use $0 here, because it points to the novaboot itself and
82 # not to the novaboot script. The problem with this approach is that
83 # when a script is run as "novaboot <options> <script>" then $ARGV[0]
84 # contains the first option. Hence the -f check.
85 my $dir = File::Spec->rel2abs($ARGV[0] && -f $ARGV[0] ? dirname($ARGV[0]) : '', $invocation_dir);
86 while ((-d $dir || -l $dir ) && $dir ne "/") {
87 push @cfgs, "$dir/.novaboot" if -r "$dir/.novaboot";
88 my @dirs = File::Spec->splitdir($dir);
89 $dir = File::Spec->catdir(@dirs[0..$#dirs-1]);
92 my $cfg = $ENV{'NOVABOOT_CONFIG'};
93 Getopt::Long::Configure(qw/no_ignore_case pass_through/);
94 GetOptions ("config|c=s" => \$cfg);
95 read_config($_) foreach $cfg or reverse @cfgs;
97 ## Command line handling
100 GetOptions ("target|t=s" => \$explicit_target);
102 my (@append, $bender, @chainloaders, $concat, $config_name_opt, $dhcp_tftp, $dump_opt, $dump_config, @exiton, @expect_raw, $gen_only, $grub_config, $grub_prefix, $grub_preamble, $grub2_prolog, $grub2_config, $help, $iprelay, $iso_image, $interactive, $kernel_opt, $make, $man, $no_file_gen, $off_opt, $on_opt, $pulsar, $pulsar_root, $qemu, $qemu_append, $qemu_flags_cmd, $remote_cmd, $remote_expect, $reset_cmd, $rom_prefix, $rsync_flags, @scriptmod, $scons, $serial, $server, $stty, $uboot, $uboot_init);
105 $rom_prefix = 'rom://';
106 $stty = 'raw -crtscts -onlcr 115200';
108 my @expect_seen = ();
112 push(@expect_seen, '-re') if $n eq "expect-re";
113 push(@expect_seen, $v);
119 unless (@expect_seen) { die("No --expect before --send"); }
120 my $ret = ($n eq "sendcont") ? exp_continue : 0;
121 unshift(@expect_raw, sub { shift->send(eval("\"$v\"")); $ret; });
122 unshift(@expect_raw, @expect_seen);
126 Getopt::Long::Configure(qw/no_ignore_case no_pass_through/);
129 "append|a=s" => \@append,
130 "bender|b" => \$bender,
131 "build-dir=s" => sub { my ($n, $v) = @_; $builddir = File::Spec->rel2abs($v); },
132 "concat" => \$concat,
133 "chainloader=s" => \@chainloaders,
134 "dhcp-tftp|d" => \$dhcp_tftp,
135 "dump" => \$dump_opt,
136 "dump-config" => \$dump_config,
137 "exiton=s" => \@exiton,
138 "expect=s" => \&handle_expect,
139 "expect-re=s" => \&handle_expect,
140 "expect-raw=s" => sub { my ($n, $v) = @_; unshift(@expect_raw, eval($v)); },
141 "gen-only" => \$gen_only,
142 "grub|g:s" => \$grub_config,
143 "grub-preamble=s"=> \$grub_preamble,
144 "grub-prefix=s" => \$grub_prefix,
145 "grub2:s" => \$grub2_config,
146 "grub2-prolog=s" => \$grub2_prolog,
147 "iprelay=s" => \$iprelay,
148 "iso:s" => \$iso_image,
149 "kernel|k=s" => \$kernel_opt,
150 "interactive|i" => \$interactive,
151 "name=s" => \$config_name_opt,
152 "make|m:s" => \$make,
153 "no-file-gen" => \$no_file_gen,
156 "pulsar|p:s" => \$pulsar,
157 "pulsar-root=s" => \$pulsar_root,
158 "qemu|Q:s" => \$qemu,
159 "qemu-append=s" => \$qemu_append,
160 "qemu-flags|q=s" => \$qemu_flags_cmd,
161 "remote-cmd=s" => \$remote_cmd,
162 "remote-expect=s"=> \$remote_expect,
163 "reset-cmd=s" => \$reset_cmd,
164 "rsync-flags=s" => \$rsync_flags,
165 "scons:s" => \$scons,
166 "scriptmod=s" => \@scriptmod,
167 "send=s" => \&handle_send,
168 "sendcont=s" => \&handle_send,
169 "serial|s:s" => \$serial,
170 "server:s" => \$server,
171 "strip-rom" => sub { $rom_prefix = ''; },
174 "uboot-init=s" => \$uboot_init,
179 # First process target options
181 my $t = defined($explicit_target) ? $explicit_target : $CFG::default_target;
183 exists $CFG::targets{$t} or die("Unknown target '$t' (valid targets are: ".join(", ", sort keys(%CFG::targets)).")");
184 GetOptionsFromString($CFG::targets{$t}, %opt_spec);
188 # Then process other command line options - some of them may override
189 # what was specified by the target
190 GetOptions %opt_spec or die("Error in command line arguments");
191 pod2usage(1) if $help;
192 pod2usage(-exitstatus => 0, -verbose => 2) if $man;
194 ### Dump sanitized configuration (if requested)
198 $Data::Dumper::Indent=1;
199 print "# This file is in perl syntax.\n";
200 foreach my $key(sort(keys(%CFG::))) { # See "Symbol Tables" in perlmod(1)
201 if (defined ${$CFG::{$key}}) { print Data::Dumper->Dump([${$CFG::{$key}}], ["*$key"]); }
202 if ( @{$CFG::{$key}}) { print Data::Dumper->Dump([\@{$CFG::{$key}}], ["*$key"]); }
203 if ( %{$CFG::{$key}}) { print Data::Dumper->Dump([\%{$CFG::{$key}}], ["*$key"]); }
209 ### Sanitize configuration
211 if ($interactive && !-t STDIN) {
212 die("novaboot: Interactive mode not supported when not on terminal");
215 if (defined $config_name_opt && scalar(@ARGV) > 1) { die "You cannot use --name with multiple scripts"; }
218 if (defined $serial) {
219 $serial ||= "/dev/ttyUSB0";
220 $ENV{NB_SERIAL} = $serial;
222 if (defined $grub_config) { $grub_config ||= "menu.lst"; }
223 if (defined $grub2_config) { $grub2_config ||= "grub.cfg"; }
225 ## Parse the novaboot script(s)
230 my ($modules, $variables, $generated, $continuation);
232 if ($ARGV ne $last_fn) { # New script
233 die "Missing EOF in $last_fn" if $file;
234 die "Unfinished line in $last_fn" if $continuation;
236 push @scripts, { 'filename' => $ARGV,
237 'modules' => $modules = [],
238 'variables' => $variables = {},
239 'generated' => $generated = []};
243 next if /^#/ || /^\s*$/; # Skip comments and empty lines
245 $_ =~ s/^[[:space:]]*// if ($continuation);
247 if (/\\$/) { # Line continuation
248 $continuation .= substr($_, 0, length($_)-1);
252 if ($continuation) { # Last continuation line
253 $_ = $continuation . $_;
257 foreach my $mod(@scriptmod) { eval $mod; }
259 if (/^([A-Z_]+)=(.*)$/) { # Internal variable
260 $$variables{$1} = $2;
261 push(@exiton, $2) if ($1 eq "EXITON");
264 if (s/^load *//) { # Load line
265 if (/^([^ ]*)(.*?)[[:space:]]*<<([^ ]*)$/) { # Heredoc start
266 push @$modules, "$1$2";
268 push @$generated, {filename => $1, content => $file};
272 if (/^([^ ]*)(.*?)[[:space:]]*< ?(.*)$/) { # Command substitution
273 push @$modules, "$1$2";
274 push @$generated, {filename => $1, command => $3};
280 if ($file && $_ eq $EOF) { # Heredoc end
284 if ($file) { # Heredoc content
285 push @{$file}, "$_\n";
289 die("novaboot: Cannot parse script '$last_fn' line $.. Didn't you forget 'load' keyword?\n");
292 # print Dumper(\@scripts);
295 foreach my $script (@scripts) {
296 $$script{modules}[0] =~ s/^[^ ]*/$kernel_opt/ if $kernel_opt;
297 $$script{modules}[0] .= ' ' . join(' ', @append) if @append;
303 foreach my $script (@scripts) {
304 print join("\n", @{$$script{modules}})."\n";
311 sub generate_configs($$$) {
312 my ($base, $generated, $filename) = @_;
313 if ($base) { $base = "$base/"; };
314 foreach my $g(@$generated) {
315 if (exists $$g{content}) {
316 my $config = $$g{content};
317 my $fn = $$g{filename};
318 open(my $f, '>', $fn) || die("$fn: $!");
319 map { s|\brom://([^ ]*)|$rom_prefix$base$1|g; print $f "$_"; } @{$config};
321 print "novaboot: Created $fn\n";
322 } elsif (exists $$g{command} && ! $no_file_gen) {
323 $ENV{SRCDIR} = dirname(File::Spec->rel2abs( $filename, $invocation_dir ));
324 system_verbose("( $$g{command} ) > $$g{filename}");
329 sub generate_grub_config($$$$;$)
331 my ($filename, $title, $base, $modules_ref, $preamble) = @_;
332 if ($base) { $base = "$base/"; };
333 open(my $fg, '>', $filename) or die "$filename: $!";
334 print $fg "$preamble\n" if $preamble;
335 print $fg "title $title\n" if $title;
336 #print $fg "root $base\n"; # root doesn't really work for (nd)
338 foreach (@$modules_ref) {
341 my ($kbin, $kcmd) = split(' ', $_, 2);
342 $kcmd = '' if !defined $kcmd;
343 print $fg "kernel ${base}$kbin $kcmd\n";
345 s|\brom://([^ ]*)|$rom_prefix$base$1|g; # Translate rom:// files - needed for vdisk parameter of sigma0
346 print $fg "module $base$_\n";
350 print("novaboot: Created $builddir/$filename\n");
354 sub generate_grub2_config($$$$;$$)
356 my ($filename, $title, $base, $modules_ref, $preamble, $prolog) = @_;
357 if ($base && substr($base,-1,1) ne '/') { $base = "$base/"; };
358 open(my $fg, '>', $filename) or die "$filename: $!";
359 print $fg "$preamble\n" if $preamble;
360 $title ||= 'novaboot';
361 print $fg "menuentry $title {\n";
362 print $fg "$prolog\n" if $prolog;
364 foreach (@$modules_ref) {
367 my ($kbin, $kcmd) = split(' ', $_, 2);
368 $kcmd = '' if !defined $kcmd;
369 print $fg " multiboot ${base}$kbin $kcmd\n";
372 # GRUB2 doesn't pass filename in multiboot info so we have to duplicate it here
373 $_ = join(' ', ($args[0], @args));
374 s|\brom://|$rom_prefix|g; # We do not need to translate path for GRUB2
375 print $fg " module $base$_\n";
380 print("novaboot: Created $builddir/$filename\n");
384 sub generate_pulsar_config($$)
386 my ($filename, $modules_ref) = @_;
387 open(my $fg, '>', $filename) or die "$filename: $!";
388 print $fg "root $pulsar_root\n" if defined $pulsar_root;
391 foreach (@$modules_ref) {
394 ($kbin, $kcmd) = split(' ', $_, 2);
395 $kcmd = '' if !defined $kcmd;
398 s|\brom://|$rom_prefix|g;
399 print $fg "load $_\n";
402 # Put kernel as last - this is needed for booting Linux and has no influence on non-Linux OSes
403 print $fg "exec $kbin $kcmd\n";
405 print("novaboot: Created $builddir/$filename\n");
409 sub shell_cmd_string(@)
411 return join(' ', map((/^[-_=a-zA-Z0-9\/\.\+]+$/ ? "$_" : "'$_'"), @_));
416 print "novaboot: Running: ".shell_cmd_string(@_)."\n";
420 sub system_verbose($)
423 print "novaboot: Running: $cmd\n";
424 my $ret = system($cmd);
425 if ($ret & 0x007f) { die("Command terminated by a signal"); }
426 if ($ret & 0xff00) {die("Command exit with non-zero exit code"); }
427 if ($ret) { die("Command failure $ret"); }
432 if (exists $variables->{WVDESC}) {
433 print "Testing \"$variables->{WVDESC}\" in $last_fn:\n";
434 } elsif ($last_fn =~ /\.wv$/) {
435 print "Testing \"all\" in $last_fn:\n";
438 ## Connect to the target and check whether is not occupied
440 # We have to do this before file generation phase, because file
441 # generation is intermixed with file deployment phase and we want to
442 # check whether the target is not used by somebody else before
443 # deploying files. Otherwise, we may rewrite other user's files on a
446 my $exp; # Expect object to communicate with the target over serial line
448 my ($target_reset, $target_power_on, $target_power_off);
450 if (defined $iprelay) {
452 $iprelay =~ /([.0-9]+)(:([0-9]+))?/;
455 my $paddr = sockaddr_in($port, inet_aton($addr));
456 my $proto = getprotobyname('tcp');
457 socket($IPRELAY, PF_INET, SOCK_STREAM, $proto) || die "socket: $!";
458 print "novaboot: Connecting to IP relay... ";
459 connect($IPRELAY, $paddr) || die "connect: $!";
461 $exp = Expect->init(\*$IPRELAY);
465 print $exp "\xFF\xF6"; # AYT
466 my $connected = $exp->expect(20, # Timeout in seconds
467 '<iprelayd: connected>',
468 '-re', '<WEB51 HW[^>]*>');
473 my ($relay, $onoff) = @_;
474 die unless ($relay == 1 || $relay == 2);
476 my $cmd = ($relay == 1 ? 0x5 : 0x6) | ($onoff ? 0x20 : 0x10);
477 return "\xFF\xFA\x2C\x32".chr($cmd)."\xFF\xF0";
481 my ($relay, $onoff) = @_;
482 die unless ($relay == 1 || $relay == 2);
483 my $cmd = ($relay == 1 ? 0xdf : 0xbf) | ($onoff ? 0x00 : 0xff);
484 return "\xFF\xFA\x2C\x97".chr($cmd)."\xFF\xF0";
488 my ($relay, $onoff, $can_giveup) = @_;
489 my $confirmation = '';
491 print $exp relaycmd($relay, $onoff);
492 my $confirmed = $exp->expect(20, # Timeout in seconds
493 relayconf($relay, $onoff));
496 print("Relay confirmation timeout - ignoring\n");
498 die "Relay confirmation timeout";
504 $target_reset = sub {
505 relay(2, 1, 1); # Reset the machine
510 $target_power_off = sub {
511 relay(1, 1); # Press power button
512 usleep(6000000); # Long press to switch off
516 $target_power_on = sub {
517 relay(1, 1); # Press power button
518 usleep(100000); # Short press
524 system_verbose("stty -F $serial $stty");
525 open($CONN, "+<", $serial) || die "open $serial: $!";
526 $exp = Expect->init(\*$CONN);
527 } elsif ($remote_cmd) {
528 print "novaboot: Running: $remote_cmd\n";
529 $exp = Expect->spawn($remote_cmd);
532 if ($remote_expect) {
533 $exp->expect(10, $remote_expect) || die "Expect for '$remote_expect' timed out";
536 if (defined $reset_cmd) {
537 $target_reset = sub {
538 system_verbose($reset_cmd);
542 if (defined $on_opt && defined $target_power_on) {
546 if (defined $off_opt && defined $target_power_off) {
547 print "novaboot: Switching the target off...\n";
548 &$target_power_off();
552 $builddir ||= dirname(File::Spec->rel2abs( ${$scripts[0]}{filename})) if scalar @scripts;
553 if (defined $builddir) {
554 chdir($builddir) or die "Can't change directory to $builddir: $!";
555 print "novaboot: Entering directory `$builddir'\n";
558 ## File generation phase
559 my (%files_iso, $menu_iso, $filename);
560 my $config_name = '';
562 foreach my $script (@scripts) {
563 $filename = $$script{filename};
564 $modules = $$script{modules};
565 $generated = $$script{generated};
566 $variables = $$script{variables};
568 ($config_name = $filename) =~ s#.*/##;
569 $config_name = $config_name_opt if (defined $config_name_opt);
571 if (exists $variables->{BUILDDIR}) {
572 $builddir = File::Spec->rel2abs($variables->{BUILDDIR});
573 chdir($builddir) or die "Can't change directory to $builddir: $!";
574 print "novaboot: Entering directory `$builddir'\n";
578 if (exists $variables->{KERNEL}) {
579 $kernel = $variables->{KERNEL};
581 if ($CFG::hypervisor) {
582 $kernel = $CFG::hypervisor . " ";
583 if (exists $variables->{HYPERVISOR_PARAMS}) {
584 $kernel .= $variables->{HYPERVISOR_PARAMS};
586 $kernel .= $CFG::hypervisor_params;
590 @$modules = ($kernel, @$modules) if $kernel;
591 @$modules = (@chainloaders, @$modules);
592 @$modules = ("bin/boot/bender", @$modules) if ($bender || defined $ENV{'NOVABOOT_BENDER'});
595 ($prefix = $grub_prefix) =~ s/\$NAME/$config_name/ if defined $grub_prefix;
596 $prefix ||= $builddir;
597 # TODO: use $grub_prefix as first parameter if some switch is given
598 generate_configs('', $generated, $filename);
600 ### Generate bootloader configuration files
601 my @bootloader_configs;
602 push @bootloader_configs, generate_grub_config($grub_config, $config_name, $prefix, $modules, $grub_preamble) if (defined $grub_config);
603 push @bootloader_configs, generate_grub2_config($grub2_config, $config_name, $prefix, $modules, $grub_preamble, $grub2_prolog) if (defined $grub2_config);
604 push @bootloader_configs, generate_pulsar_config('config-'.($pulsar||'novaboot'), $modules) if (defined $pulsar);
606 ### Run scons or make
608 my @files = map({ ($file) = m/([^ ]*)/; $file; } @$modules);
609 # Filter-out generated files
610 my @to_build = grep({ my $file = $_; !scalar(grep($file eq $$_{filename}, @$generated)) } @files);
612 system_verbose($scons || $CFG::scons." ".join(" ", @to_build)) if (defined $scons);
613 system_verbose($make || $CFG::make ." ".join(" ", @to_build)) if (defined $make);
616 ### Copy files (using rsync)
617 if (defined $server && !defined($gen_only)) {
618 (my $real_server = $server) =~ s/\$NAME/$config_name/;
620 my ($hostname, $path) = split(":", $real_server, 2);
621 if (! defined $path) {
625 my $files = join(" ", map({ ($file) = m/([^ ]*)/; $file; } ( @$modules, @bootloader_configs)));
626 map({ my $file = (split)[0]; die "$file: $!" if ! -f $file; } @$modules);
627 my $istty = -t STDOUT && ($ENV{'TERM'} || 'dumb') ne 'dumb';
628 my $progress = $istty ? "--progress" : "";
629 system_verbose("rsync $progress -RLp $rsync_flags $files $real_server");
630 if ($server =~ m|/\$NAME$| && $concat) {
631 my $cmd = join("; ", map { "( cd $path/.. && cat */$_ > $_ )" } @bootloader_configs);
632 system_verbose($hostname ? "ssh $hostname '$cmd'" : $cmd);
636 ### Prepare ISO image generation
637 if (defined $iso_image) {
638 generate_configs("(cd)", $generated, $filename);
640 generate_grub_config(\$menu, $config_name, "(cd)", $modules);
641 $menu_iso .= "$menu\n";
642 map { ($file,undef) = split; $files_iso{$file} = 1; } @$modules;
646 ## Generate ISO image
647 if (defined $iso_image) {
648 open(my $fh, ">menu-iso.lst");
649 print $fh "timeout 5\n\n$menu_iso";
651 my $files = "boot/grub/menu.lst=menu-iso.lst " . join(" ", map("$_=$_", keys(%files_iso)));
652 $iso_image ||= "$config_name.iso";
653 system_verbose("$CFG::genisoimage -R -b stage2_eltorito -no-emul-boot -boot-load-size 4 -boot-info-table -hide-rr-moved -J -joliet-long -o $iso_image -graft-points bin/boot/grub/ $files");
654 print("ISO image created: $builddir/$iso_image\n");
657 exit(0) if defined $gen_only;
659 ## Boot the system using various methods and send serial output to stdout
661 if (scalar(@scripts) > 1 && ( defined $dhcp_tftp || defined $serial || defined $iprelay)) {
662 die "You cannot do this with multiple scripts simultaneously";
665 if ($variables->{WVTEST_TIMEOUT}) {
666 print "wvtest: timeout ", $variables->{WVTEST_TIMEOUT}, "\n";
671 $str =~ s/^\s+|\s+$//g;
679 $qemu ||= $variables->{QEMU} || $CFG::qemu;
680 my @qemu_flags = split(" ", $qemu);
681 $qemu = shift(@qemu_flags);
683 @qemu_flags = split(/ +/, trim($variables->{QEMU_FLAGS})) if exists $variables->{QEMU_FLAGS};
684 @qemu_flags = split(/ +/, trim($qemu_flags_cmd)) if $qemu_flags_cmd;
685 push(@qemu_flags, split(/ +/, trim($qemu_append || '')));
687 if (defined $iso_image) {
688 # Boot NOVA with grub (and test the iso image)
689 push(@qemu_flags, ('-cdrom', "$config_name.iso"));
691 # Boot NOVA without GRUB
693 # Non-patched qemu doesn't like commas, but NUL can live with pluses instead of commans
694 foreach (@$modules) {s/,/+/g;}
695 generate_configs("", $generated, $filename);
697 if (scalar @$modules) {
698 my ($kbin, $kcmd) = split(' ', shift(@$modules), 2);
699 $kcmd = '' if !defined $kcmd;
701 @$modules = map { if (/\.dtb$/) { $dtb=$_; (); } else { $_ } } @$modules;
702 my $initrd = join ",", @$modules;
704 push(@qemu_flags, ('-kernel', $kbin, '-append', $kcmd));
705 push(@qemu_flags, ('-initrd', $initrd)) if $initrd;
706 push(@qemu_flags, ('-dtb', $dtb)) if $dtb;
709 push(@qemu_flags, qw(-serial stdio)); # Redirect serial output (for collecting test restuls)
710 unshift(@qemu_flags, ('-name', $config_name));
711 print "novaboot: Running: ".shell_cmd_string($qemu, @qemu_flags)."\n";
712 $exp = Expect->spawn(($qemu, @qemu_flags)) || die("exec() failed: $!");
715 ### Local DHCPD and TFTPD
717 my ($dhcpd_pid, $tftpd_pid);
719 if (defined $dhcp_tftp)
721 generate_configs("(nd)", $generated, $filename);
722 system_verbose('mkdir -p tftpboot');
723 generate_grub_config("tftpboot/os-menu.lst", $config_name, "(nd)", \@$modules, "timeout 0");
724 open(my $fh, '>', 'dhcpd.conf');
725 my $mac = `cat /sys/class/net/eth0/address`;
727 print $fh "subnet 10.23.23.0 netmask 255.255.255.0 {
728 range 10.23.23.10 10.23.23.100;
729 filename \"bin/boot/grub/pxegrub.pxe\";
730 next-server 10.23.23.1;
733 hardware ethernet $mac;
734 fixed-address 10.23.23.1;
737 system_verbose("sudo ip a add 10.23.23.1/24 dev eth0;
738 sudo ip l set dev eth0 up;
739 sudo touch dhcpd.leases");
741 # We run servers by forking ourselves, because the servers end up
742 # in our process group and get killed by signals sent to the
743 # process group (e.g. Ctrl-C on terminal).
745 exec_verbose("sudo dhcpd -d -cf dhcpd.conf -lf dhcpd.leases -pf dhcpd.pid") if ($dhcpd_pid == 0);
747 exec_verbose("sudo in.tftpd --foreground --secure -v -v -v --pidfile tftpd.pid $builddir") if ($tftpd_pid == 0);
749 # Kill server when we die
750 $SIG{__DIE__} = sub { system_verbose('sudo pkill --pidfile=dhcpd.pid');
751 system_verbose('sudo pkill --pidfile=tftpd.pid'); };
754 ### Serial line or IP relay
756 if (defined $target_reset) {
757 print "novaboot: Reseting the test box... ";
762 if (defined $uboot) {
763 print "novaboot: Waiting for uBoot prompt...\n";
765 #$exp->exp_internal(1);
767 [qr/Hit any key to stop autoboot:/, sub { $exp->send("\n"); exp_continue; }],
768 '=> ') || die "No uBoot prompt deteceted";
769 $exp->send("$uboot_init\n") if $uboot_init;
770 $exp->expect(10, '=> ') || die "uBoot prompt timeout";
772 my ($kbin, $kcmd) = split(' ', shift(@$modules), 2);
774 @$modules = map { if (/\.dtb$/) { $dtb=$_; (); } else { $_ } } @$modules;
775 my $initrd = shift @$modules;
777 my $kern_addr = '800000';
778 my $initrd_addr = '-';
781 $exp->send("tftp $kern_addr $kbin\n");
783 [qr/#/, sub { exp_continue; }],
784 '=> ') || die "Kernel load failed";
786 $dtb_addr = '7f0000';
787 $exp->send("tftp $dtb_addr $dtb\n");
789 [qr/#/, sub { exp_continue; }],
790 '=> ') || die "Device tree load failed";
792 if (defined $initrd) {
793 $initrd_addr = 'b00000';
794 $exp->send("tftp $initrd_addr $initrd\n");
796 [qr/#/, sub { exp_continue; }],
797 '=> ') || die "Initrd load failed";
799 $exp->send("set bootargs '$kcmd'\n");
800 $exp->expect(5, '=> ') || die "uBoot prompt timeout";
801 $exp->send("bootm $kern_addr $initrd_addr $dtb_addr\n");
802 $exp->expect(5, "\n") || die "uBoot command timeout";
806 # Serial line of the target is available
807 my $interrupt = 'Ctrl-C';
808 if ($interactive && !@exiton) {
809 $interrupt = '"~~."';
811 print "novaboot: Serial line interaction (press $interrupt to interrupt)...\n";
814 $exp->expect(undef, @expect_raw, @exiton);
817 if (-t STDIN) { # Set up bi-directional communication if we run on terminal
818 my $infile = new IO::File;
819 $infile->IO::File::fdopen(*STDIN,'r');
820 my $in_object = Expect->exp_init($infile);
821 $in_object->set_group($exp);
824 $in_object->set_seq('~~\.', sub { print "novaboot: Escape sequence detected\r\n"; undef; });
825 $in_object->manual_stty(0); # Use raw terminal mode
827 $in_object->manual_stty(1); # Do not modify terminal settings
829 push(@inputs, $in_object);
832 #print Dumper(\@expect_raw);
833 $exp->expect(undef, @expect_raw) if @expect_raw;
834 Expect::interconnect(@inputs) unless defined($exp->exitstatus);
838 ## Kill dhcpc or tftpd
839 if (defined $dhcp_tftp) {
840 die("novaboot: This should kill servers on background\n");
847 novaboot - A tool for booting various operating systems on various hardware or in qemu
853 B<novaboot> [option]... [--] script...
855 B<./script> [option]...
859 This program makes it easier to boot NOVA or other operating system
860 (OS) on different targets (machines or emulators). It reads a so
861 called novaboot script, that specifies the boot configuration, and
862 setups the target to boot that configuration. Setting up the target
863 means to generate the bootloader configuration files, deploy the
864 binaries and other needed files to proper locations, perhaps on a
865 remote boot server and reset the target. Then, target's serial output
866 is redirected to standard output if that is possible.
868 A typical way of using novaboot is to make the novaboot script
869 executable and set its first line to I<#!/usr/bin/env novaboot>. Then,
870 booting a particular OS configuration becomes the same as executing a
871 local program - the novaboot script.
873 For example, with C<novaboot> you can:
879 Run an OS in Qemu. This is the default action when no other action is
880 specified by command line switches. Thus running C<novaboot ./script>
881 (or C<./script> as described above) will run Qemu and make it boot the
882 configuration specified in the I<script>.
886 Create a bootloader configuration file (currently supported
887 bootloaders are GRUB, GRUB2, Pulsar and uBoot) and copy it with all
888 other files needed for booting to another, perhaps remote, location.
890 ./script --server=192.168.1.1:/tftp --iprelay=192.168.1.2
892 This command copies files to the TFTP server and uses
893 TCP/IP-controlled relay to reset the test box and receive its serial
898 Run DHCP and TFTP server on developer's machine to PXE-boot the OS
903 When a PXE-bootable machine is connected via Ethernet to developer's
904 machine, it will boot the configuration described in I<script>.
908 Create bootable ISO images. E.g.
910 novaboot --iso -- script1 script2
912 The created ISO image will have GRUB bootloader installed on it and
913 the boot menu will allow selecting between I<script1> and I<script2>
918 Note that the options needed for a specific target can be stored in a
919 L</"CONFIGURATION FILE"> and then it is sufficient to use only the
920 B<-t> option to specify the name of the target.
922 =head1 PHASES AND OPTIONS
924 Novaboot performs its work in several phases. Each phase can be
925 influenced by several options, certain phases can be skipped. The list
926 of phases (in the execution order) and the corresponding options
929 =head2 Configuration reading phase
931 After starting, novaboot reads configuration files. By default, it
932 searches for files named F<.novaboot> starting from the directory of
933 the novaboot script (or working directory, see bellow) and continuing
934 upwards up to the root directory. The configuration files are read in
935 order from the root directory downwards with latter files overriding
936 settings from the former ones.
938 In certain cases, the location of the novaboot script cannot be
939 determined in this early phase. This happens either when the script is
940 read from the standard input or when novaboot is invoked explicitly
941 and options precede the script name, as in the example L</"4."> above.
942 In this case the current working directory is used as a starting point
943 for configuration file search.
947 =item -c, --config=I<filename>
949 Use the specified configuration file instead of the default one(s).
953 =head2 Command line processing phase
959 Dump the current configuration to stdout end exits. Useful as an
960 initial template for a configuration file.
964 Print short (B<-h>) or long (B<--help>) help.
966 =item -t, --target=I<target>
968 This option serves as a user configurable shortcut for other novaboot
969 options. The effect of this option is the same as the options stored
970 in the C<%targets> configuration variable under key I<target>. See
971 also L</"CONFIGURATION FILE">.
975 =head2 Script preprocessing phase
977 This phases allows to modify the parsed novaboot script before it is
978 used in the later phases.
982 =item -a, --append=I<parameters>
984 Append a string to the first C<load> line in the novaboot script. This
985 can be used to append parameters to the kernel's or root task's
986 command line. Can appear multiple times.
990 Use F<bender> chainloader. Bender scans the PCI bus for PCI serial
991 ports and stores the information about them in the BIOS data area for
994 =item --chainloader=I<chainloader>
996 Chainloader that is loaded before the kernel and other files specified
997 in the novaboot script. E.g. 'bin/boot/bender promisc'.
1001 Print the modules to boot and their parameters. This happens after
1002 parsing the novaboot script, i.e. after evaluating all I<--scriptmod>
1003 expressions etc. Exit after reading (and dumping) the script.
1005 =item -k, --kernel=F<file>
1007 Replace the first word on the first C<load> line in the novaboot
1008 script with F<file>.
1010 =item --scriptmod=I<perl expression>
1012 When novaboot script is read, I<perl expression> is executed for every
1013 line (in $_ variable). For example, C<novaboot
1014 --scriptmod=s/sigma0/omega6/g> replaces every occurrence of I<sigma0>
1015 in the script with I<omega6>.
1017 When this option is present, it overrides I<$script_modifier> variable
1018 from the configuration file, which has the same effect. If this option
1019 is given multiple times all expressions are evaluated in the command
1024 Strip I<rom://> prefix from command lines and generated config files.
1025 The I<rom://> prefix is used by NUL. For NRE, it has to be stripped.
1029 =head2 File generation phase
1031 In this phase, files needed for booting are generated in a so called
1032 I<build directory> (see TODO). In most cases configuration for a
1033 bootloader is generated automatically by novaboot. It is also possible
1034 to generate other files using I<heredoc> or I<"<"> syntax in novaboot
1035 scripts. Finally, binaries can be generated in this phases by running
1036 C<scons> or C<make>.
1040 =item --build-dir=I<directory>
1042 Overrides the default build directory location.
1044 The default build directory location is determined as follows: If the
1045 configuration file defines the C<$builddir> variable, its value is
1046 used. Otherwise, it is the directory that contains the first processed
1049 See also L<BUILDDIR> variable.
1051 =item -g, --grub[=I<filename>]
1053 Generates grub bootloader menu file. If the I<filename> is not
1054 specified, F<menu.lst> is used. The I<filename> is relative to the
1055 build directory (see B<--build-dir>).
1057 =item --grub-preamble=I<prefix>
1059 Specifies the I<preable> that is at the beginning of the generated
1060 GRUB or GRUB2 config files. This is useful for specifying GRUB's
1063 =item --grub-prefix=I<prefix>
1065 Specifies I<prefix> that is put in front of every file name in GRUB's
1066 F<menu.lst>. The default value is the absolute path to the build directory.
1068 If the I<prefix> contains string $NAME, it will be replaced with the
1069 name of the novaboot script (see also B<--name>).
1071 =item --grub2[=I<filename>]
1073 Generate GRUB2 menuentry in I<filename>. If I<filename> is not
1074 specified F<grub.cfg> is used. The content of the menuentry can be
1075 customized with B<--grub-preable>, B<--grub2-prolog> or
1076 B<--grub_prefix> options.
1078 In order to use the the generated menuentry on your development
1079 machine that uses GRUB2, append the following snippet to
1080 F</etc/grub.d/40_custom> file and regenerate your grub configuration,
1081 i.e. run update-grub on Debian/Ubuntu.
1083 if [ -f /path/to/nul/build/grub.cfg ]; then
1084 source /path/to/nul/build/grub.cfg
1087 =item --grub2-prolog=I<prolog>
1089 Specifies text I<preable> that is put at the beginning of the entry
1092 =item -m, --make[=make command]
1094 Runs C<make> to build files that are not generated by novaboot itself.
1096 =item --name=I<string>
1098 Use the name I<string> instead of the name of the novaboot script.
1099 This name is used for things like a title of grub menu or for the
1100 server directory where the boot files are copied to.
1104 Do not generate files on the fly (i.e. "<" syntax) except for the
1105 files generated via "<<WORD" syntax.
1107 =item -p, --pulsar[=mac]
1109 Generates pulsar bootloader configuration file named F<config-I<mac>>
1110 The I<mac> string is typically a MAC address and defaults to
1113 =item --scons[=scons command]
1115 Runs C<scons> to build files that are not generated by novaboot
1120 Exit novaboot after file generation phase.
1124 =head2 Target connection check
1126 If supported by the target, the connection to it is made and it is
1127 checked whether the target is not occupied by another novaboot
1132 =item --iprelay=I<addr[:port]>
1134 Use TCP/IP relay and serial port to access the target's serial port
1135 and powercycle it. The IP address of the relay is given by I<addr>
1136 parameter. If I<port> is not specified, it default to 23.
1138 Note: This option is supposed to work with HWG-ER02a IP relays.
1140 =item -s, --serial[=device]
1142 Target's serial line is connected to host's serial line (device). The
1143 default value for device is F</dev/ttyUSB0>.
1145 The value of this option is exported in NB_NOVABOOT environment
1146 variable to all subprocesses run by C<novaboot>.
1148 =item --stty=I<settings>
1150 Specifies settings passed to C<stty> invoked on the serial line
1151 specified with B<--serial> option. If this option is not given,
1152 C<stty> is called with C<raw -crtscts -onlcr 115200> settings.
1154 =item --remote-cmd=I<cmd>
1156 Command that mediates connection to the target's serial line. For
1157 example C<ssh server 'cu -l /dev/ttyS0'>.
1159 =item --remote-expect=I<string>
1161 Wait for reception of I<string> after establishing the the remote
1162 connection before continuing.
1166 =head2 File deployment phase
1168 In some setups, it is necessary to copy the files needed for booting
1169 to a particular location, e.g. to a TFTP boot server or to the
1174 =item -d, --dhcp-tftp
1176 Turns your workstation into a DHCP and TFTP server so that the OS can
1177 be booted via PXE BIOS (or similar mechanism) on the test machine
1178 directly connected by a plain Ethernet cable to your workstation.
1180 The DHCP and TFTP servers require root privileges and C<novaboot>
1181 uses C<sudo> command to obtain those. You can put the following to
1182 I</etc/sudoers> to allow running the necessary commands without
1183 asking for password.
1185 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 --foreground --secure -v -v -v --pidfile tftpd.pid *, /usr/bin/touch dhcpd.leases, /usr/bin/pkill --pidfile=dhcpd.pid, /usr/bin/pkill --pidfile=tftpd.pid
1186 your_login ALL=NOPASSWD: NOVABOOT
1188 =item --iso[=filename]
1190 Generates the ISO image that boots NOVA system via GRUB. If no filename
1191 is given, the image is stored under I<NAME>.iso, where I<NAME> is the name
1192 of the novaboot script (see also B<--name>).
1194 =item --server[=[[user@]server:]path]
1196 Copy all files needed for booting to another location (implies B<-g>
1197 unless B<--grub2> is given). The files will be copied (by B<rsync>
1198 tool) to the directory I<path>. If the I<path> contains string $NAME,
1199 it will be replaced with the name of the novaboot script (see also
1204 If B<--server> is used and its value ends with $NAME, then after
1205 copying the files, a new bootloader configuration file (e.g. menu.lst)
1206 is created at I<path-wo-name>, i.e. the path specified by B<--server>
1207 with $NAME part removed. The content of the file is created by
1208 concatenating all files of the same name from all subdirectories of
1209 I<path-wo-name> found on the "server".
1211 =item --rsync-flags=I<flags>
1213 Specifies which I<flags> are appended to F<rsync> command line when
1214 copying files as a result of I<--server> option.
1218 =head2 Target power-on and reset phase
1224 Switch on/off the target machine. Currently works only with
1227 =item -Q, --qemu[=I<qemu-binary>]
1229 Boot the configuration in qemu. Optionally, the name of qemu binary
1230 can be specified as a parameter.
1232 =item --qemu-append=I<flags>
1234 Append I<flags> to the default qemu flags (QEMU_FLAGS variable or
1235 C<-cpu coreduo -smp 2>).
1237 =item -q, --qemu-flags=I<flags>
1239 Replace the default qemu flags (QEMU_FLAGS variable or C<-cpu coreduo
1240 -smp 2>) with I<flags> specified here.
1242 =item --reset-cmd=I<cmd>
1244 Command that resets the target.
1248 =head2 Interaction with the bootloader on the target
1254 Interact with uBoot bootloader to boot the thing described in the
1255 novaboot script. Implementation of this option is currently tied to a
1256 particular board that we use. It may be subject to changes in the
1261 Command(s) to send the U-Boot bootloader before loading the images and
1266 =head2 Target interaction phase
1268 In this phase, target's serial output is redirected to stdout and if
1269 stdin is a TTY, it is redirected to the target's serial input allowing
1270 interactive work with the target.
1274 =item --exiton=I<string>
1276 When I<string> is sent by the target, novaboot exits. This option can
1277 be specified multiple times.
1279 If I<string> is C<-re>, then the next B<--exiton>'s I<string> is
1280 treated as regular expression. For example:
1282 --exiton -re --exiton 'error:.*failed'
1284 =item -i, --interactive
1286 Setup things for interactive use of target. Your terminal will be
1287 switched to raw mode. In raw mode, your system does not process input
1288 in any way (no echoing of entered characters, no interpretation
1289 special characters). This, among others, means that Ctrl-C is passed
1290 to the target and does no longer interrupt novaboot. Use "~~."
1291 sequence to exit novaboot.
1293 =item --expect=I<string>
1295 When I<string> is received from the target, send the string specified
1296 with the subsequent B<--send*> option to the target.
1298 =item --expect-re=I<regex>
1300 When target's output matches regular expression I<regex>, send the
1301 string specified with the subsequent B<--send*> option to the target.
1303 =item --expect-raw=I<perl-code>
1305 Provides direct control over Perl's Expect module.
1307 =item --send=I<string>
1309 Send I<string> to the target after the previously specified
1310 B<--expect*> was matched in the target's output. The I<string> may
1311 contain escape sequences such as "\n".
1313 Note that I<string> is actually interpreted by Perl, so it can contain
1314 much more that escape sequences. This behavior may change in the
1317 Example: C<--expect='login: ' --send='root\n'>
1319 =item --sendcont=I<string>
1321 Similar to B<--send> but continue expecting more input.
1323 Example: C<--expect='Continue?' --sendcont='yes\n'>
1327 =head1 NOVABOOT SCRIPT SYNTAX
1329 The syntax tries to mimic POSIX shell syntax. The syntax is defined
1330 with the following rules.
1332 Lines starting with "#" and empty lines are ignored.
1334 Lines that end with "\" are concatenated with the following line after
1335 removal of the final "\" and leading whitespace of the following line.
1337 Lines of the form I<VARIABLE=...> (i.e. matching '^[A-Z_]+=' regular
1338 expression) assign values to internal variables. See L<VARIABLES>
1341 Lines starting with C<load> keyword represent modules to boot. The
1342 word after C<load> is a file name (relative to the build directory
1343 (see B<--build-dir>) of the module to load and the remaining words are
1344 passed to it as the command line parameters.
1346 When the C<load> line ends with "<<WORD" then the subsequent lines
1347 until the line containing solely WORD are copied literally to the file
1348 named on that line. This is similar to shell's heredoc feature.
1350 When the C<load> line ends with "< CMD" then command CMD is executed
1351 with C</bin/sh> and its standard output is stored in the file named on
1352 that line. The SRCDIR variable in CMD's environment is set to the
1353 absolute path of the directory containing the interpreted novaboot
1357 #!/usr/bin/env novaboot
1358 WVDESC=Example program
1359 load bin/apps/sigma0.nul S0_DEFAULT script_start:1,1 \
1360 verbose hostkeyb:0,0x60,1,12,2
1361 load bin/apps/hello.nul
1362 load hello.nulconfig <<EOF
1363 sigma0::mem:16 name::/s0/log name::/s0/timer name::/s0/fs/rom ||
1364 rom://bin/apps/hello.nul
1367 This example will load three modules: F<sigma0.nul>, F<hello.nul> and
1368 F<hello.nulconfig>. sigma0 receives some command line parameters and
1369 F<hello.nulconfig> file is generated on the fly from the lines between
1370 C<<<EOF> and C<EOF>.
1374 The following variables are interpreted in the novaboot script:
1380 Novaboot chdir()s to this directory before file generation phase. The
1381 directory name specified here is relative to the build directory
1382 specified by other means (see L</--build-dir>).
1386 Assigning this variable has the same effect as specifying L</--exiton>
1389 =item HYPERVISOR_PARAMS
1391 Parameters passed to hypervisor. The default value is "serial", unless
1392 overridden in configuration file.
1396 The kernel to use instead of the hypervisor specified in the
1397 configuration file with the C<$hypervisor> variable. The value should
1398 contain the name of the kernel image as well as its command line
1399 parameters. If this variable is defined and non-empty, the variable
1400 HYPERVISOR_PARAMS is not used.
1404 Use a specific qemu binary (can be overridden with B<-Q>) and flags
1405 when booting this script under qemu. If QEMU_FLAGS variable is also
1406 specified flags specified in QEMU variable are replaced by those in
1411 Use specific qemu flags (can be overridden with B<-q>).
1415 Description of the wvtest-compliant program.
1417 =item WVTEST_TIMEOUT
1419 The timeout in seconds for WvTest harness. If no complete line appears
1420 in the test output within the time specified here, the test fails. It
1421 is necessary to specify this for long running tests that produce no
1422 intermediate output.
1426 =head1 CONFIGURATION FILE
1428 Novaboot can read its configuration from one or more files. By
1429 default, novaboot looks for files named F<.novaboot> as described in
1430 L</Configuration reading phase>. Alternatively, its location can be
1431 specified with the B<-c> switch or with the NOVABOOT_CONFIG
1432 environment variable. The configuration file has perl syntax and
1433 should set values of certain Perl variables. The current configuration
1434 can be dumped with the B<--dump-config> switch. Some configuration
1435 variables can be overridden by environment variables (see below) or by
1436 command line switches.
1438 Supported configuration variables include:
1444 Build directory location relative to the location of the configuration
1447 =item $default_target
1449 Default target (see below) to use when no target is explicitly
1450 specified on command line with the B<--target> option.
1454 Hash of shortcuts to be used with the B<--target> option. If the hash
1455 contains, for instance, the following pair of values
1457 'mybox' => '--server=boot:/tftproot --serial=/dev/ttyUSB0 --grub',
1459 then the following two commands are equivalent:
1461 ./script --server=boot:/tftproot --serial=/dev/ttyUSB0 --grub
1466 =head1 ENVIRONMENT VARIABLES
1468 Some options can be specified not only via config file or command line
1469 but also through environment variables. Environment variables override
1470 the values from configuration file and command line parameters
1471 override the environment variables.
1475 =item NOVABOOT_CONFIG
1477 Name of the novaboot configuration file to use instead of the default
1480 =item NOVABOOT_BENDER
1482 Defining this variable has the same meaning as B<--bender> option.
1488 Michal Sojka <sojka@os.inf.tu-dresden.de>