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 = 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';
45 "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',
46 "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',
47 "localhost" => '--scriptmod=s/console=tty[A-Z0-9,]+// --server=/boot/novaboot/$NAME --grub2 --grub-prefix=/boot/novaboot/$NAME --grub2-prolog=" set root=\'(hd0,msdos1)\'"',
48 "ryuglab" => '--server=pc-sojkam.felk.cvut.cz:/srv/tftp --uboot --uboot-init="mw f0000b00 \${psc_cfg}" --remote-cmd="ssh pc-sojkam.felk.cvut.cz \"cu -l /dev/ttyUSB0 -s 115200\"" --reset-cmd="ssh pc-sojkam.felk.cvut.cz \"dtrrts /dev/ttyUSB0 1 1\""',
49 "ryulocal" => '--dhcp-tftp --serial --uboot --uboot-init="dhcp; mw f0000b00 \${psc_cfg}" --reset-cmd="if which dtrrts; then dtrrts $NB_SERIAL 0 1; sleep 0.1; dtrrts $NB_SERIAL 1 1; fi"',
52 chomp(my $nproc = `nproc`);
53 $CFG::scons = "scons -j$nproc";
54 $CFG::make = "make -j$nproc";
61 package CFG; # Put config data into a separate namespace
66 die("ERROR: Failure compiling '$cfg' - $@");
67 } elsif (! defined($rc)) {
68 die("ERROR: Failure reading '$cfg' - $!");
70 die("ERROR: Failure processing '$cfg'");
73 $builddir = File::Spec->rel2abs($CFG::builddir, dirname($cfg)) if defined $CFG::builddir;
74 print STDERR "novaboot: Read $cfg\n";
79 # We don't use $0 here, because it points to the novaboot itself and
80 # not to the novaboot script. The problem with this approach is that
81 # when a script is run as "novaboot <options> <script>" then $ARGV[0]
82 # contains the first option. Hence the -f check.
83 my $dir = File::Spec->rel2abs($ARGV[0] && -f $ARGV[0] ? dirname($ARGV[0]) : '', $invocation_dir);
84 while (-d $dir && $dir ne "/") {
85 push @cfgs, "$dir/.novaboot" if -r "$dir/.novaboot";
86 $dir = abs_path($dir."/..");
89 my $cfg = $ENV{'NOVABOOT_CONFIG'};
90 Getopt::Long::Configure(qw/no_ignore_case pass_through/);
91 GetOptions ("config|c=s" => \$cfg);
92 read_config($_) foreach $cfg or reverse @cfgs;
94 ## Command line handling
96 my ($append, $bender, @chainloaders, $concat, $config_name_opt, $dhcp_tftp, $dump_opt, $dump_config, $gen_only, $grub_config, $grub_prefix, $grub_preamble, $grub2_prolog, $grub2_config, $help, $iprelay, $iso_image, $make, $man, $no_file_gen, $off_opt, $on_opt, $pulsar, $pulsar_root, $qemu, $qemu_append, $qemu_flags_cmd, $remote_cmd, $reset_cmd, $rom_prefix, $rsync_flags, @scriptmod, $scons, $serial, $server, $stty, $uboot, $uboot_init);
99 $rom_prefix = 'rom://';
100 $stty = 'raw -crtscts -onlcr 115200';
102 Getopt::Long::Configure(qw/no_ignore_case no_pass_through/);
105 "append|a=s" => \$append,
106 "bender|b" => \$bender,
107 "build-dir=s" => sub { my ($n, $v) = @_; $builddir = File::Spec->rel2abs($v); },
108 "concat" => \$concat,
109 "chainloader=s" => \@chainloaders,
110 "dhcp-tftp|d" => \$dhcp_tftp,
111 "dump" => \$dump_opt,
112 "dump-config" => \$dump_config,
113 "gen-only" => \$gen_only,
114 "grub|g:s" => \$grub_config,
115 "grub-preamble=s"=> \$grub_preamble,
116 "grub-prefix=s" => \$grub_prefix,
117 "grub2:s" => \$grub2_config,
118 "grub2-prolog=s" => \$grub2_prolog,
119 "iprelay=s" => \$iprelay,
120 "iso|i:s" => \$iso_image,
121 "name=s" => \$config_name_opt,
122 "make|m:s" => \$make,
123 "no-file-gen" => \$no_file_gen,
126 "pulsar|p:s" => \$pulsar,
127 "pulsar-root=s" => \$pulsar_root,
128 "qemu|Q:s" => \$qemu,
129 "qemu-append=s" => \$qemu_append,
130 "qemu-flags|q=s" => \$qemu_flags_cmd,
131 "remote-cmd=s" => \$remote_cmd,
132 "reset-cmd=s" => \$reset_cmd,
133 "rsync-flags=s" => \$rsync_flags,
134 "scons:s" => \$scons,
135 "scriptmod=s" => \@scriptmod,
136 "serial|s:s" => \$serial,
137 "server:s" => \$server,
138 "strip-rom" => sub { $rom_prefix = ''; },
140 "target|t=s" => sub { my ($opt_name, $opt_value) = @_;
141 exists $CFG::targets{$opt_value} or die("Unknown target '$opt_value' (valid targets are: ".join(", ", sort keys(%CFG::targets)).")");
142 GetOptionsFromString($CFG::targets{$opt_value}, %opt_spec); },
144 "uboot-init=s" => \$uboot_init,
148 GetOptions %opt_spec;
149 pod2usage(1) if $help;
150 pod2usage(-exitstatus => 0, -verbose => 2) if $man;
152 ### Dump sanitized configuration (if requested)
156 $Data::Dumper::Indent=1;
157 print "# This file is in perl syntax.\n";
158 foreach my $key(sort(keys(%CFG::))) { # See "Symbol Tables" in perlmod(1)
159 if (defined ${$CFG::{$key}}) { print Data::Dumper->Dump([${$CFG::{$key}}], ["*$key"]); }
160 if ( @{$CFG::{$key}}) { print Data::Dumper->Dump([\@{$CFG::{$key}}], ["*$key"]); }
161 if ( %{$CFG::{$key}}) { print Data::Dumper->Dump([\%{$CFG::{$key}}], ["*$key"]); }
167 ### Sanitize configuration
169 if (defined $config_name_opt && scalar(@ARGV) > 1) { die "You cannot use --name with multiple scripts"; }
172 if (defined $serial) {
173 $serial ||= "/dev/ttyUSB0";
174 $ENV{NB_SERIAL} = $serial;
176 if (defined $grub_config) { $grub_config ||= "menu.lst"; }
177 if (defined $grub2_config) { $grub2_config ||= "grub.cfg"; }
179 ## Parse the novaboot script(s)
185 my ($modules, $variables, $generated, $continuation);
187 if ($ARGV ne $last_fn) { # New script
188 die "Missing EOF in $last_fn" if $file;
189 die "Unfinished line in $last_fn" if $line;
191 push @scripts, { 'filename' => $ARGV,
192 'modules' => $modules = [],
193 'variables' => $variables = {},
194 'generated' => $generated = []};
198 next if /^#/ || /^\s*$/; # Skip comments and empty lines
200 foreach my $mod(@scriptmod) { eval $mod; }
202 print "$_\n" if $dump_opt;
204 if (/^([A-Z_]+)=(.*)$/) { # Internal variable
205 $$variables{$1} = $2;
208 if (/^([^ ]*)(.*?)[[:space:]]*<<([^ ]*)$/) { # Heredoc start
209 push @$modules, "$1$2";
211 push @$generated, {filename => $1, content => $file};
215 if ($file && $_ eq $EOF) { # Heredoc end
219 if ($file) { # Heredoc content
220 push @{$file}, "$_\n";
223 $_ =~ s/^[[:space:]]*// if ($continuation);
224 if (/\\$/) { # Line continuation
225 $line .= substr($_, 0, length($_)-1);
231 $line .= " $append" if ($append && scalar(@$modules) == 0);
233 if ($line =~ /^([^ ]*)(.*?)[[:space:]]*< ?(.*)$/) { # Command substitution
234 push @$modules, "$1$2";
235 push @$generated, {filename => $1, command => $3};
239 push @$modules, $line;
243 #print Dumper(\@scripts);
249 sub generate_configs($$$) {
250 my ($base, $generated, $filename) = @_;
251 if ($base) { $base = "$base/"; };
252 foreach my $g(@$generated) {
253 if (exists $$g{content}) {
254 my $config = $$g{content};
255 my $fn = $$g{filename};
256 open(my $f, '>', $fn) || die("$fn: $!");
257 map { s|\brom://([^ ]*)|$rom_prefix$base$1|g; print $f "$_"; } @{$config};
259 print "novaboot: Created $fn\n";
260 } elsif (exists $$g{command} && ! $no_file_gen) {
261 $ENV{SRCDIR} = dirname(File::Spec->rel2abs( $filename, $invocation_dir ));
262 system_verbose("( $$g{command} ) > $$g{filename}");
267 sub generate_grub_config($$$$;$)
269 my ($filename, $title, $base, $modules_ref, $preamble) = @_;
270 if ($base) { $base = "$base/"; };
271 open(my $fg, '>', $filename) or die "$filename: $!";
272 print $fg "$preamble\n" if $preamble;
273 print $fg "title $title\n" if $title;
274 #print $fg "root $base\n"; # root doesn't really work for (nd)
276 foreach (@$modules_ref) {
279 my ($kbin, $kcmd) = split(' ', $_, 2);
280 $kcmd = '' if !defined $kcmd;
281 print $fg "kernel ${base}$kbin $kcmd\n";
283 s|\brom://([^ ]*)|$rom_prefix$base$1|g; # Translate rom:// files - needed for vdisk parameter of sigma0
284 print $fg "module $base$_\n";
288 print("novaboot: Created $builddir/$filename\n");
292 sub generate_grub2_config($$$$;$$)
294 my ($filename, $title, $base, $modules_ref, $preamble, $prolog) = @_;
295 if ($base && substr($base,-1,1) ne '/') { $base = "$base/"; };
296 open(my $fg, '>', $filename) or die "$filename: $!";
297 print $fg "$preamble\n" if $preamble;
298 $title ||= 'novaboot';
299 print $fg "menuentry $title {\n";
300 print $fg "$prolog\n" if $prolog;
302 foreach (@$modules_ref) {
305 my ($kbin, $kcmd) = split(' ', $_, 2);
306 $kcmd = '' if !defined $kcmd;
307 print $fg " multiboot ${base}$kbin $kcmd\n";
310 # GRUB2 doesn't pass filename in multiboot info so we have to duplicate it here
311 $_ = join(' ', ($args[0], @args));
312 s|\brom://|$rom_prefix|g; # We do not need to translate path for GRUB2
313 print $fg " module $base$_\n";
318 print("novaboot: Created $builddir/$filename\n");
322 sub generate_pulsar_config($$)
324 my ($filename, $modules_ref) = @_;
325 open(my $fg, '>', $filename) or die "$filename: $!";
326 print $fg "root $pulsar_root\n" if defined $pulsar_root;
329 foreach (@$modules_ref) {
332 ($kbin, $kcmd) = split(' ', $_, 2);
333 $kcmd = '' if !defined $kcmd;
336 s|\brom://|$rom_prefix|g;
337 print $fg "load $_\n";
340 # Put kernel as last - this is needed for booting Linux and has no influence on non-Linux OSes
341 print $fg "exec $kbin $kcmd\n";
343 print("novaboot: Created $builddir/$filename\n");
347 sub shell_cmd_string(@)
349 return join(' ', map((/^[-_=a-zA-Z0-9\/\.\+]+$/ ? "$_" : "'$_'"), @_));
354 print "novaboot: Running: ".shell_cmd_string(@_)."\n";
358 sub system_verbose($)
361 print "novaboot: Running: $cmd\n";
362 my $ret = system($cmd);
363 if ($ret & 0x007f) { die("Command terminated by a signal"); }
364 if ($ret & 0xff00) {die("Command exit with non-zero exit code"); }
365 if ($ret) { die("Command failure $ret"); }
370 if (exists $variables->{WVDESC}) {
371 print "Testing \"$variables->{WVDESC}\" in $last_fn:\n";
372 } elsif ($last_fn =~ /\.wv$/) {
373 print "Testing \"all\" in $last_fn:\n";
376 ## Connect to the target and check whether is not occupied
378 # We have to do this before file generation phase, because file
379 # generation is intermixed with file deployment phase and we want to
380 # check whether the target is not used by somebody else before
381 # deploying files. Otherwise, we may rewrite other user's files on a
384 my $exp; # Expect object to communicate with the target over serial line
386 my ($target_reset, $target_power_on, $target_power_off);
388 if (defined $iprelay) {
390 $iprelay =~ /([.0-9]+)(:([0-9]+))?/;
393 my $paddr = sockaddr_in($port, inet_aton($addr));
394 my $proto = getprotobyname('tcp');
395 socket($IPRELAY, PF_INET, SOCK_STREAM, $proto) || die "socket: $!";
396 print "novaboot: Connecting to IP relay... ";
397 connect($IPRELAY, $paddr) || die "connect: $!";
399 $exp = Expect->init(\*$IPRELAY);
403 print $exp "\xFF\xF6"; # AYT
404 my $connected = $exp->expect(20, # Timeout in seconds
405 '<iprelayd: connected>',
406 '-re', '<WEB51 HW[^>]*>');
411 my ($relay, $onoff) = @_;
412 die unless ($relay == 1 || $relay == 2);
414 my $cmd = ($relay == 1 ? 0x5 : 0x6) | ($onoff ? 0x20 : 0x10);
415 return "\xFF\xFA\x2C\x32".chr($cmd)."\xFF\xF0";
419 my ($relay, $onoff) = @_;
420 die unless ($relay == 1 || $relay == 2);
421 my $cmd = ($relay == 1 ? 0xdf : 0xbf) | ($onoff ? 0x00 : 0xff);
422 return "\xFF\xFA\x2C\x97".chr($cmd)."\xFF\xF0";
426 my ($relay, $onoff, $can_giveup) = @_;
427 my $confirmation = '';
429 print $exp relaycmd($relay, $onoff);
430 my $confirmed = $exp->expect(20, # Timeout in seconds
431 relayconf($relay, $onoff));
434 print("Relay confirmation timeout - ignoring\n");
436 die "Relay confirmation timeout";
442 $target_reset = sub {
443 relay(2, 1, 1); # Reset the machine
448 $target_power_off = sub {
449 relay(1, 1); # Press power button
450 usleep(6000000); # Long press to switch off
454 $target_power_on = sub {
455 relay(1, 1); # Press power button
456 usleep(100000); # Short press
462 system_verbose("stty -F $serial $stty");
463 open($CONN, "+<", $serial) || die "open $serial: $!";
464 $exp = Expect->init(\*$CONN);
466 $exp = new Expect(); # Make $exp ready for calling $exp->spawn() later
469 print "novaboot: Running: $remote_cmd\n";
470 $exp->spawn($remote_cmd);
474 if (defined $reset_cmd) {
475 $target_reset = sub {
476 system_verbose($reset_cmd);
480 if (defined $on_opt && defined $target_power_on) {
484 if (defined $off_opt && defined $target_power_off) {
485 print "novaboot: Switching the target off...\n";
486 &$target_power_off();
490 $builddir ||= dirname(File::Spec->rel2abs( ${$scripts[0]}{filename})) if scalar @scripts;
491 if (defined $builddir) {
492 chdir($builddir) or die "Can't change directory to $builddir: $!";
493 print "novaboot: Entering directory `$builddir'\n";
496 ## File generation phase
497 my (%files_iso, $menu_iso, $filename);
498 my $config_name = '';
500 foreach my $script (@scripts) {
501 $filename = $$script{filename};
502 $modules = $$script{modules};
503 $generated = $$script{generated};
504 $variables = $$script{variables};
506 ($config_name = $filename) =~ s#.*/##;
507 $config_name = $config_name_opt if (defined $config_name_opt);
509 if (exists $variables->{BUILDDIR}) {
510 $builddir = File::Spec->rel2abs($variables->{BUILDDIR});
511 chdir($builddir) or die "Can't change directory to $builddir: $!";
512 print "novaboot: Entering directory `$builddir'\n";
516 if (exists $variables->{KERNEL}) {
517 $kernel = $variables->{KERNEL};
519 if ($CFG::hypervisor) {
520 $kernel = $CFG::hypervisor . " ";
521 if (exists $variables->{HYPERVISOR_PARAMS}) {
522 $kernel .= $variables->{HYPERVISOR_PARAMS};
524 $kernel .= $CFG::hypervisor_params;
528 @$modules = ($kernel, @$modules) if $kernel;
529 @$modules = (@chainloaders, @$modules);
530 @$modules = ("bin/boot/bender", @$modules) if ($bender || defined $ENV{'NOVABOOT_BENDER'});
533 ($prefix = $grub_prefix) =~ s/\$NAME/$config_name/ if defined $grub_prefix;
534 $prefix ||= $builddir;
535 # TODO: use $grub_prefix as first parameter if some switch is given
536 generate_configs('', $generated, $filename);
538 ### Generate bootloader configuration files
539 my @bootloader_configs;
540 push @bootloader_configs, generate_grub_config($grub_config, $config_name, $prefix, $modules, $grub_preamble) if (defined $grub_config);
541 push @bootloader_configs, generate_grub2_config($grub2_config, $config_name, $prefix, $modules, $grub_preamble, $grub2_prolog) if (defined $grub2_config);
542 push @bootloader_configs, generate_pulsar_config('config-'.($pulsar||'novaboot'), $modules) if (defined $pulsar);
544 ### Run scons or make
546 my @files = map({ ($file) = m/([^ ]*)/; $file; } @$modules);
547 # Filter-out generated files
548 my @to_build = grep({ my $file = $_; !scalar(grep($file eq $$_{filename}, @$generated)) } @files);
550 system_verbose($scons || $CFG::scons." ".join(" ", @to_build)) if (defined $scons);
551 system_verbose($make || $CFG::make ." ".join(" ", @to_build)) if (defined $make);
554 ### Copy files (using rsync)
555 if (defined $server && !defined($gen_only)) {
556 (my $real_server = $server) =~ s/\$NAME/$config_name/;
558 my ($hostname, $path) = split(":", $real_server, 2);
559 if (! defined $path) {
563 my $files = join(" ", map({ ($file) = m/([^ ]*)/; $file; } ( @$modules, @bootloader_configs)));
564 map({ my $file = (split)[0]; die "$file: $!" if ! -f $file; } @$modules);
565 my $istty = -t STDOUT && ($ENV{'TERM'} || 'dumb') ne 'dumb';
566 my $progress = $istty ? "--progress" : "";
567 system_verbose("rsync $progress -RLp $rsync_flags $files $real_server");
568 if ($server =~ m|/\$NAME$| && $concat) {
569 my $cmd = join("; ", map { "( cd $path/.. && cat */$_ > $_ )" } @bootloader_configs);
570 system_verbose($hostname ? "ssh $hostname '$cmd'" : $cmd);
574 ### Prepare ISO image generation
575 if (defined $iso_image) {
576 generate_configs("(cd)", $generated, $filename);
578 generate_grub_config(\$menu, $config_name, "(cd)", $modules);
579 $menu_iso .= "$menu\n";
580 map { ($file,undef) = split; $files_iso{$file} = 1; } @$modules;
584 ## Generate ISO image
585 if (defined $iso_image) {
586 open(my $fh, ">menu-iso.lst");
587 print $fh "timeout 5\n\n$menu_iso";
589 my $files = "boot/grub/menu.lst=menu-iso.lst " . join(" ", map("$_=$_", keys(%files_iso)));
590 $iso_image ||= "$config_name.iso";
591 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");
592 print("ISO image created: $builddir/$iso_image\n");
595 exit(0) if defined $gen_only;
597 ## Boot the system using various methods and send serial output to stdout
599 if (scalar(@scripts) > 1 && ( defined $dhcp_tftp || defined $serial || defined $iprelay)) {
600 die "You cannot do this with multiple scripts simultaneously";
603 if ($variables->{WVTEST_TIMEOUT}) {
604 print "wvtest: timeout ", $variables->{WVTEST_TIMEOUT}, "\n";
609 $str =~ s/^\s+|\s+$//g;
617 $qemu ||= $variables->{QEMU} || $CFG::qemu;
618 my @qemu_flags = split(" ", $qemu);
619 $qemu = shift(@qemu_flags);
621 @qemu_flags = split(/ +/, trim($variables->{QEMU_FLAGS})) if exists $variables->{QEMU_FLAGS};
622 @qemu_flags = split(/ +/, trim($qemu_flags_cmd)) if $qemu_flags_cmd;
623 push(@qemu_flags, split(/ +/, trim($qemu_append || '')));
625 if (defined $iso_image) {
626 # Boot NOVA with grub (and test the iso image)
627 push(@qemu_flags, ('-cdrom', "$config_name.iso"));
629 # Boot NOVA without GRUB
631 # Non-patched qemu doesn't like commas, but NUL can live with pluses instead of commans
632 foreach (@$modules) {s/,/+/g;}
633 generate_configs("", $generated, $filename);
635 if (scalar @$modules) {
636 my ($kbin, $kcmd) = split(' ', shift(@$modules), 2);
637 $kcmd = '' if !defined $kcmd;
639 @$modules = map { if (/\.dtb$/) { $dtb=$_; (); } else { $_ } } @$modules;
640 my $initrd = join ",", @$modules;
642 push(@qemu_flags, ('-kernel', $kbin, '-append', $kcmd));
643 push(@qemu_flags, ('-initrd', $initrd)) if $initrd;
644 push(@qemu_flags, ('-dtb', $dtb)) if $dtb;
647 push(@qemu_flags, qw(-serial stdio)); # Redirect serial output (for collecting test restuls)
648 unshift(@qemu_flags, ('-name', $config_name));
649 print "novaboot: Running: ".shell_cmd_string($qemu, @qemu_flags)."\n";
650 $exp->spawn(($qemu, @qemu_flags)) || die("exec() failed: $!");
653 ### Local DHCPD and TFTPD
655 my ($dhcpd_pid, $tftpd_pid);
657 if (defined $dhcp_tftp)
659 generate_configs("(nd)", $generated, $filename);
660 system_verbose('mkdir -p tftpboot');
661 generate_grub_config("tftpboot/os-menu.lst", $config_name, "(nd)", \@$modules, "timeout 0");
662 open(my $fh, '>', 'dhcpd.conf');
663 my $mac = `cat /sys/class/net/eth0/address`;
665 print $fh "subnet 10.23.23.0 netmask 255.255.255.0 {
666 range 10.23.23.10 10.23.23.100;
667 filename \"bin/boot/grub/pxegrub.pxe\";
668 next-server 10.23.23.1;
671 hardware ethernet $mac;
672 fixed-address 10.23.23.1;
675 system_verbose("sudo ip a add 10.23.23.1/24 dev eth0;
676 sudo ip l set dev eth0 up;
677 sudo touch dhcpd.leases");
679 # We run servers by forking ourselves, because the servers end up
680 # in our process group and get killed by signals sent to the
681 # process group (e.g. Ctrl-C on terminal).
683 exec_verbose("sudo dhcpd -d -cf dhcpd.conf -lf dhcpd.leases -pf dhcpd.pid") if ($dhcpd_pid == 0);
685 exec_verbose("sudo in.tftpd --foreground --secure -v -v -v --pidfile tftpd.pid $builddir") if ($tftpd_pid == 0);
687 # Kill server when we die
688 $SIG{__DIE__} = sub { system_verbose('sudo pkill --pidfile=dhcpd.pid');
689 system_verbose('sudo pkill --pidfile=tftpd.pid'); };
692 ### Serial line or IP relay
694 if (defined $target_reset) {
695 print "novaboot: Reseting the test box... ";
700 if (defined $uboot) {
701 print "novaboot: Waiting for uBoot prompt...\n";
704 [qr/Hit any key to stop autoboot:/, sub { $exp->send("\n"); exp_continue; }],
705 '=> ') || die "No uBoot prompt deteceted";
706 $exp->send("$uboot_init\n") if $uboot_init;
707 $exp->expect(10, '=> ') || die "uBoot prompt timeout";
709 my ($kbin, $kcmd) = split(' ', shift(@$modules), 2);
711 @$modules = map { if (/\.dtb$/) { $dtb=$_; (); } else { $_ } } @$modules;
712 my $initrd = shift @$modules;
714 my $kern_addr = '800000';
715 my $initrd_addr = '-';
718 $exp->send("tftp $kern_addr $kbin\n");
720 [qr/#/, sub { exp_continue; }],
721 '=> ') || die "Kernel load failed";
723 $dtb_addr = '7f0000';
724 $exp->send("tftp $dtb_addr $dtb\n");
726 [qr/#/, sub { exp_continue; }],
727 '=> ') || die "Device tree load failed";
729 if (defined $initrd) {
730 $initrd_addr = 'b00000';
731 $exp->send("tftp $initrd_addr $initrd\n");
733 [qr/#/, sub { exp_continue; }],
734 '=> ') || die "Initrd load failed";
736 $exp->send("set bootargs $kcmd\n");
737 $exp->expect(1, '=> ') || die "uBoot prompt timeout";
738 $exp->send("bootm $kern_addr $initrd_addr $dtb_addr\n");
739 $exp->expect(1, "\n") || die "uBoot command timeout";
743 # Serial line of the target is available
744 print "novaboot: Serial line interaction (press Ctrl-C to interrupt)...\n";
747 if (-t STDIN) { # Set up bi-directional communication if we run on terminal
748 my $infile = new IO::File;
749 $infile->IO::File::fdopen(*STDIN,'r');
750 my $in_object = Expect->exp_init($infile);
751 $in_object->set_group($exp);
752 #$in_object->set_seq("\cC",undef);
754 # I'm not sure when to use raw mode and when not. With
755 # --dhcp-tftp, I want the output of daemons to be normally
756 # formated (no raw mode). On the other hand, I don't want
757 # input for qemu to be echoed. Need to think more about this.
758 $in_object->manual_stty(1);
759 push(@inputs, $in_object);
761 Expect::interconnect(@inputs);
764 ## Kill dhcpc or tftpd
765 if (defined $dhcp_tftp) {
766 die("novaboot: This should kill servers on background\n");
773 novaboot - A tool for booting various operating systems on various hardware or in qemu
777 B<novaboot> [ options ] [--] script...
779 B<./script> [ options ]
783 This program makes it easier to boot NOVA or other operating system
784 (OS) on different targets (machines or emulators). It reads a so
785 called novaboot script, that specifies the boot configuration, and
786 setups the target to boot that configuration. Setting up the target
787 means to generate the bootloader configuration files, deploy the
788 binaries and other needed files to proper locations, perhaps on a
789 remote boot server and reset the target. Then, target's serial output
790 is redirected to standard output if that is possible.
792 A typical way of using novaboot is to make the novaboot script
793 executable and set its first line to I<#!/usr/bin/env novaboot>. Then,
794 booting a particular OS configuration becomes the same as executing a
795 local program - the novaboot script.
797 For example, with C<novaboot> you can:
803 Run an OS in Qemu. This is the default action when no other action is
804 specified by command line switches. Thus running C<novaboot ./script>
805 (or C<./script> as described above) will run Qemu and make it boot the
806 configuration specified in the I<script>.
810 Create a bootloader configuration file (currently supported
811 bootloaders are GRUB, GRUB2, Pulsar and uBoot) and copy it with all
812 other files needed for booting to another, perhaps remote, location.
814 ./script --server --iprelay=192.168.1.2
816 This command copies files to a TFTP server specified in the
817 configuration file and uses TCP/IP-controlled relay to reset the test
818 box and receive its serial output.
822 Run DHCP and TFTP server on developer's machine to PXE-boot the OS
827 When a PXE-bootable machine is connected via Ethernet to developer's
828 machine, it will boot the configuration described in I<script>.
832 Create bootable ISO images. E.g.
834 novaboot --iso -- script1 script2
836 The created ISO image will have GRUB bootloader installed on it and
837 the boot menu will allow selecting between I<script1> and I<script2>
842 =head1 PHASES AND OPTIONS
844 Novaboot performs its work in several phases. Each phase can be
845 influenced by several options, certain phases can be skipped. The list
846 of phases (in the execution order) and the corresponding options
849 =head2 Configuration reading phase
851 After starting, novaboot reads configuration files. By default, it
852 searches for files named F<.novaboot> starting from the directory of
853 the novaboot script (or working directory, see bellow) and continuing
854 upwards up to the root directory. The configuration files are read in
855 order from the root directory downwards with latter files overriding
856 settings from the former ones.
858 In certain cases, the location of the novaboot script cannot be
859 determined in this early phase. This happens either when the script is
860 read from the standard input or when novaboot is invoked explicitly
861 and options precede the script name, as in the example L</"4."> above.
862 In this case the current working directory is used as a starting point
863 for configuration file search.
867 =item -c, --config=I<filename>
869 Use the specified configuration file instead of the default one(s).
873 =head2 Command line processing phase
879 Dump the current configuration to stdout end exits. Useful as an
880 initial template for a configuration file.
884 Print short (B<-h>) or long (B<--help>) help.
886 =item -t, --target=I<target>
888 This option serves as a user configurable shortcut for other novaboot
889 options. The effect of this option is the same as the options stored
890 in the C<%targets> configuration variable under key I<target>. See
891 also L</"CONFIGURATION FILE">.
895 =head2 Script preprocessing phase
897 This phases allows to modify the parsed novaboot script before it is
898 used in the later phases.
902 =item -a, --append=I<parameters>
904 Appends a string to the first "filename" line in the novaboot script.
905 This can be used to append parameters to the kernel's or root task's
910 Use F<bender> chainloader. Bender scans the PCI bus for PCI serial
911 ports and stores the information about them in the BIOS data area for
914 =item --chainloader=I<chainloader>
916 Chainloader that is loaded before the kernel and other files specified
917 in the novaboot script. E.g. 'bin/boot/bender promisc'.
921 Prints the content of the novaboot script after removing comments and
922 evaluating all I<--scriptmod> expressions. Exit after reading (and
925 =item --scriptmod=I<perl expression>
927 When novaboot script is read, I<perl expression> is executed for every
928 line (in $_ variable). For example, C<novaboot
929 --scriptmod=s/sigma0/omega6/g> replaces every occurrence of I<sigma0>
930 in the script with I<omega6>.
932 When this option is present, it overrides I<$script_modifier> variable
933 from the configuration file, which has the same effect. If this option
934 is given multiple times all expressions are evaluated in the command
939 Strip I<rom://> prefix from command lines and generated config files.
940 The I<rom://> prefix is used by NUL. For NRE, it has to be stripped.
944 =head2 File generation phase
946 In this phase, files needed for booting are generated in a so called
947 I<build directory> (see TODO). In most cases configuration for a
948 bootloader is generated automatically by novaboot. It is also possible
949 to generate other files using I<heredoc> or I<"<"> syntax in novaboot
950 scripts. Finally, binaries can be generated in this phases by running
955 =item --build-dir=I<directory>
957 Overrides the default build directory location.
959 The default build directory location is determined as follows: If the
960 configuration file defines the C<$builddir> variable, its value is
961 used. Otherwise, it is the directory that contains the first processed
964 =item -g, --grub[=I<filename>]
966 Generates grub bootloader menu file. If the I<filename> is not
967 specified, F<menu.lst> is used. The I<filename> is relative to the
968 build directory (see B<--build-dir>).
970 =item --grub-preamble=I<prefix>
972 Specifies the I<preable> that is at the beginning of the generated
973 GRUB or GRUB2 config files. This is useful for specifying GRUB's
976 =item --grub-prefix=I<prefix>
978 Specifies I<prefix> that is put in front of every file name in GRUB's
979 F<menu.lst>. The default value is the absolute path to the build directory.
981 If the I<prefix> contains string $NAME, it will be replaced with the
982 name of the novaboot script (see also B<--name>).
984 =item --grub2[=I<filename>]
986 Generate GRUB2 menuentry in I<filename>. If I<filename> is not
987 specified F<grub.cfg> is used. The content of the menuentry can be
988 customized with B<--grub-preable>, B<--grub2-prolog> or
989 B<--grub_prefix> options.
991 In order to use the the generated menuentry on your development
992 machine that uses GRUB2, append the following snippet to
993 F</etc/grub.d/40_custom> file and regenerate your grub configuration,
994 i.e. run update-grub on Debian/Ubuntu.
996 if [ -f /path/to/nul/build/grub.cfg ]; then
997 source /path/to/nul/build/grub.cfg
1000 =item --grub2-prolog=I<prolog>
1002 Specifies text I<preable> that is put at the begiging of the entry
1005 =item -m, --make[=make command]
1007 Runs C<make> to build files that are not generated by novaboot itself.
1009 =item --name=I<string>
1011 Use the name I<string> instead of the name of the novaboot script.
1012 This name is used for things like a title of grub menu or for the
1013 server directory where the boot files are copied to.
1017 Do not generate files on the fly (i.e. "<" syntax) except for the
1018 files generated via "<<WORD" syntax.
1020 =item -p, --pulsar[=mac]
1022 Generates pulsar bootloader configuration file named F<config-I<mac>>
1023 The I<mac> string is typically a MAC address and defaults to
1026 =item --scons[=scons command]
1028 Runs C<scons> to build files that are not generated by novaboot
1033 Exit novaboot after file generation phase.
1037 =head2 Target connection check
1039 If supported by the target, the connection to it is made and it is
1040 checked whether the target is not occupied by another novaboot
1045 =item --iprelay=I<addr[:port]>
1047 Use TCP/IP relay and serial port to access the target's serial port
1048 and powercycle it. The IP address of the relay is given by I<addr>
1049 parameter. If I<port> is not specified, it default to 23.
1051 Note: This option is supposed to work with HWG-ER02a IP relays.
1053 =item -s, --serial[=device]
1055 Target's serial line is connected to host's serial line (device). The
1056 default value for device is F</dev/ttyUSB0>.
1058 The value of this option is exported in NB_NOVABOOT environment
1059 variable to all subprocesses run by C<novaboot>.
1061 =item --stty=I<settings>
1063 Specifies settings passed to C<stty> invoked on the serial line
1064 specified with B<--serial> option. If this option is not given,
1065 C<stty> is called with C<raw -crtscts -onlcr 115200> settings.
1067 =item --remote-cmd=I<cmd>
1069 Command that mediates connection to the target's serial line. For
1070 example C<ssh server 'cu -l /dev/ttyS0'>.
1074 =head2 File deployment phase
1076 In some setups, it is necessary to copy the files needed for booting
1077 to a particular location, e.g. to a TFTP boot server or to the
1082 =item -d, --dhcp-tftp
1084 Turns your workstation into a DHCP and TFTP server so that the OS can
1085 be booted via PXE BIOS (or similar mechanism) on the test machine
1086 directly connected by a plain Ethernet cable to your workstation.
1088 The DHCP and TFTP servers require root privileges and C<novaboot>
1089 uses C<sudo> command to obtain those. You can put the following to
1090 I</etc/sudoers> to allow running the necessary commands without
1091 asking for password.
1093 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
1094 your_login ALL=NOPASSWD: NOVABOOT
1096 =item -i, --iso[=filename]
1098 Generates the ISO image that boots NOVA system via GRUB. If no filename
1099 is given, the image is stored under I<NAME>.iso, where I<NAME> is the name
1100 of the novaboot script (see also B<--name>).
1102 =item --server[=[[user@]server:]path]
1104 Copy all files needed for booting to another location (implies B<-g>
1105 unless B<--grub2> is given). The files will be copied (by B<rsync>
1106 tool) to the directory I<path>. If the I<path> contains string $NAME,
1107 it will be replaced with the name of the novaboot script (see also
1112 If B<--server> is used and its value ends with $NAME, then after
1113 copying the files, a new bootloader configuration file (e.g. menu.lst)
1114 is created at I<path-wo-name>, i.e. the path specified by B<--server>
1115 with $NAME part removed. The content of the file is created by
1116 concatenating all files of the same name from all subdirectories of
1117 I<path-wo-name> found on the "server".
1119 =item --rsync-flags=I<flags>
1121 Specifies which I<flags> are appended to F<rsync> command line when
1122 copying files as a result of I<--server> option.
1126 =head2 Target power-on and reset phase
1132 Switch on/off the target machine. Currently works only with
1135 =item -Q, --qemu[=I<qemu-binary>]
1137 Boot the configuration in qemu. Optionally, the name of qemu binary
1138 can be specified as a parameter.
1140 =item --qemu-append=I<flags>
1142 Append I<flags> to the default qemu flags (QEMU_FLAGS variable or
1143 C<-cpu coreduo -smp 2>).
1145 =item -q, --qemu-flags=I<flags>
1147 Replace the default qemu flags (QEMU_FLAGS variable or C<-cpu coreduo
1148 -smp 2>) with I<flags> specified here.
1150 =item --reset-cmd=I<cmd>
1152 Command that resets the target.
1156 =head2 Interaction with the bootloader on the target
1162 Interact with uBoot bootloader to boot the thing described in the
1163 novaboot script. Implementation of this option is currently tied to a
1164 particular board that we use. It may be subject to changes in the
1169 Command(s) to send the uBoot bootloader before loading the images and
1174 =head2 Target interaction phase
1176 In this phase, target's serial output is passed to C<novaboot> stdout.
1177 If C<novaboot>'s stdin is on TTY, the stdin is passed to the target
1178 allowing interactive work with the target.
1180 This phase end when the target hangs up or when Ctrl-C is pressed.
1182 =head1 NOVABOOT SCRIPT SYNTAX
1184 The syntax tries to mimic POSIX shell syntax. The syntax is defined with the following rules.
1186 Lines starting with "#" are ignored.
1188 Lines that end with "\" are concatenated with the following line after
1189 removal of the final "\" and leading whitespace of the following line.
1191 Lines in the form I<VARIABLE=...> (i.e. matching '^[A-Z_]+=' regular
1192 expression) assign values to internal variables. See VARIABLES
1195 Otherwise, the first word on the line represents the filename
1196 (relative to the build directory (see B<--build-dir>) of the module to
1197 load and the remaining words are passed as the command line
1200 When the line ends with "<<WORD" then the subsequent lines until the
1201 line containing only WORD are copied literally to the file named on
1204 When the line ends with "< CMD" the command CMD is executed with
1205 C</bin/sh> and its standard output is stored in the file named on that
1206 line. The SRCDIR variable in CMD's environment is set to the absolute
1207 path of the directory containing the interpreted novaboot script.
1210 #!/usr/bin/env novaboot
1211 WVDESC=Example program
1212 bin/apps/sigma0.nul S0_DEFAULT script_start:1,1 \
1213 verbose hostkeyb:0,0x60,1,12,2
1215 hello.nulconfig <<EOF
1216 sigma0::mem:16 name::/s0/log name::/s0/timer name::/s0/fs/rom ||
1217 rom://bin/apps/hello.nul
1220 This example will load three modules: sigma0.nul, hello.nul and
1221 hello.nulconfig. sigma0 gets some command line parameters and
1222 hello.nulconfig file is generated on the fly from the lines between
1227 The following variables are interpreted in the novaboot script:
1233 Novaboot chdir()s to this directory before file generation phase. The
1234 directory name specified here is relative to the build directory
1235 specified by other means (see L</--build-dir>).
1239 Description of the wvtest-compliant program.
1241 =item WVTEST_TIMEOUT
1243 The timeout in seconds for WvTest harness. If no complete line appears
1244 in the test output within the time specified here, the test fails. It
1245 is necessary to specify this for long running tests that produce no
1246 intermediate output.
1250 Use a specific qemu binary (can be overriden with B<-Q>) and flags
1251 when booting this script under qemu. If QEMU_FLAGS variable is also
1252 specified flags specified in QEMU variable are replaced by those in
1257 Use specific qemu flags (can be overriden with B<-q>).
1259 =item HYPERVISOR_PARAMS
1261 Parameters passed to hypervisor. The default value is "serial", unless
1262 overriden in configuration file.
1266 The kernel to use instead of NOVA hypervisor specified in the
1267 configuration file. The value should contain the name of the kernel
1268 image as well as its command line parameters. If this variable is
1269 defined and non-empty, the variable HYPERVISOR_PARAMS is not used.
1273 =head1 CONFIGURATION FILE
1275 Novaboot can read its configuration from a file. Configuration file
1276 was necessary in early days of novaboot. Nowadays, an attempt is made
1277 to not use the configuration file because it makes certain novaboot
1278 scripts unusable on systems without (or with different) configuration
1279 file. The only recommended use of the configuration file is to specify
1280 custom_options (see bellow).
1282 If you decide to use the configuration file, it is looked up, by
1283 default, in files named F<.novaboot> as described in L</Configuration
1284 reading phase>. Alternatively, its location can be specified with the
1285 B<-c> switch or with the NOVABOOT_CONFIG environment variable. The
1286 configuration file has perl syntax and should set values of certain
1287 Perl variables. The current configuration can be dumped with the
1288 B<--dump-config> switch. Some configuration variables can be overriden
1289 by environment variables (see below) or by command line switches.
1291 Documentation of some configuration variables follows:
1297 Build directory location relative to the location of the configuration
1302 Hash of shortcuts to be used with the B<--target> option. If the hash
1303 contains, for instance, the following pair of values
1305 'mybox' => '--server=boot:/tftproot --serial=/dev/ttyUSB0 --grub',
1307 then the following two commands are equivalent:
1309 ./script --server=boot:/tftproot --serial=/dev/ttyUSB0 --grub
1314 =head1 ENVIRONMENT VARIABLES
1316 Some options can be specified not only via config file or command line
1317 but also through environment variables. Environment variables override
1318 the values from configuration file and command line parameters
1319 override the environment variables.
1323 =item NOVABOOT_CONFIG
1325 Name of the novaboot configuration file to use instead of the default
1328 =item NOVABOOT_BENDER
1330 Defining this variable has the same meaning as B<--bender> option.
1336 Michal Sojka <sojka@os.inf.tu-dresden.de>