6 use File::Temp 'tempfile';
7 use Getopt::Long qw(:config bundling);
9 # Command-line options.
10 our ($start_time) = time ();
11 our ($sim) = $ENV{PINTOSSIM}; # Simulator: bochs, qemu, or gsx.
12 our ($debug) = "none"; # Debugger: none, monitor, or gdb.
13 our ($mem) = 4; # Physical RAM in MB.
14 our ($serial_out) = 1; # Send output to serial port?
15 our ($vga); # VGA output: window, terminal, or none.
16 our ($jitter); # Seed for random timer interrupts, if set.
17 our ($realtime); # Synchronize timer interrupts with real time?
18 our ($timeout); # Maximum runtime in seconds, if set.
19 our (@puts); # Files to copy into the VM.
20 our (@gets); # Files to copy out of the VM.
21 our ($as_ref); # Reference to last addition to @gets or @puts.
22 our (@kernel_args); # Arguments to pass to kernel.
23 our (%disks) = (OS => {DEF_FN => 'os.dsk'}, # Disks to give VM.
24 FS => {DEF_FN => 'fs.dsk'},
25 SCRATCH => {DEF_FN => 'scratch.dsk'},
26 SWAP => {DEF_FN => 'swap.dsk'});
27 our (@disks_by_iface) = @disks{qw (OS FS SCRATCH SWAP)};
29 parse_command_line ();
31 prepare_scratch_disk ();
34 finish_scratch_disk ();
38 # Parses the command line.
39 sub parse_command_line {
40 usage (0) if @ARGV == 0 || (@ARGV == 1 && $ARGV[0] eq '--help');
43 if (grep ($_ eq '--', @kernel_args)) {
45 while ((my $arg = shift (@kernel_args)) ne '--') {
48 GetOptions ("sim=s" => sub { set_sim (@_) },
49 "bochs" => sub { set_sim ("bochs") },
50 "qemu" => sub { set_sim ("qemu") },
51 "gsx" => sub { set_sim ("gsx") },
53 "debug=s" => sub { set_debug (@_) },
54 "no-debug" => sub { set_debug ("none") },
55 "monitor" => sub { set_debug ("monitor") },
56 "gdb" => sub { set_debug ("gdb") },
58 "m|memory=i" => \$mem,
59 "j|jitter=i" => sub { set_jitter (@_) },
60 "r|realtime" => sub { set_realtime () },
61 "T|timeout=i" => \$timeout,
63 "v|no-vga" => sub { set_vga ('none'); },
64 "s|no-serial" => sub { $serial_out = 0; },
65 "t|terminal" => sub { set_vga ('terminal'); },
67 "p|put-file=s" => sub { add_file (\@puts, $_[1]); },
68 "g|get-file=s" => sub { add_file (\@gets, $_[1]); },
69 "a|as=s" => sub { set_as ($_[1]); },
71 "h|help" => sub { usage (0); },
73 "os-disk=s" => \$disks{OS}{FILENAME},
74 "fs-disk=s" => \$disks{FS}{FILENAME},
75 "scratch-disk=s" => \$disks{SCRATCH}{FILENAME},
76 "swap-disk=s" => \$disks{SWAP}{FILENAME},
78 "0|disk-0|hda=s" => \$disks_by_iface[0]{FILENAME},
79 "1|disk-1|hdb=s" => \$disks_by_iface[1]{FILENAME},
80 "2|disk-2|hdc=s" => \$disks_by_iface[2]{FILENAME},
81 "3|disk-3|hdd=s" => \$disks_by_iface[3]{FILENAME})
85 $sim = "bochs" if !defined $sim;
86 $debug = "none" if !defined $debug;
87 $vga = "window" if !defined $vga;
89 print "warning: -T or --timeout should not be used with --$debug\n"
90 if defined ($timeout) && $debug ne 'none';
94 # Prints a usage message and exits with $exitcode.
97 $exitcode = 1 unless defined $exitcode;
99 pintos, a utility for running Pintos in a simulator
100 Usage: pintos [OPTION...] -- [ARGUMENT...]
101 where each OPTION is one of the following options
102 and each ARGUMENT is passed to Pintos kernel verbatim.
104 --bochs (default) Use Bochs as simulator
105 --qemu Use qemu as simulator
106 --gsx Use VMware GSX Server 3.x as simulator
108 --no-debug (default) No debugger
109 --monitor Debug with simulator's monitor
111 Display options: (default is both VGA and serial)
112 -v, --no-vga No VGA display
113 -s, --no-serial No serial output
114 -t, --terminal Display VGA in terminal (Bochs only)
115 Timing options: (Bochs only)
116 -j SEED Randomize timer interrupts
117 -r, --realtime Use realistic, not reproducible, timings
118 -T, --timeout=N Kill Pintos after N seconds CPU time or N*load_avg
119 seconds wall-clock time (whichever comes first)
120 Configuration options:
121 -m, --mem=N Give Pintos N MB physical RAM (default: 4)
122 File system commands (for `run' command):
123 -p, --put-file=HOSTFN Copy HOSTFN into VM, by default under same name
124 -g, --get-file=GUESTFN Copy GUESTFN out of VM, by default under same name
125 -a, --as=FILENAME Specifies guest (for -p) or host (for -g) file name
126 Disk options: (name an existing FILE or specify SIZE in MB for a temp disk)
127 --os-disk=FILE Set OS disk file (default: os.dsk)
128 --fs-disk=FILE|SIZE Set FS disk file (default: fs.dsk)
129 --scratch-disk=FILE|SIZE Set scratch disk (default: scratch.dsk)
130 --swap-disk=FILE|SIZE Set swap disk file (default: swap.dsk)
132 -h, --help Display this help message.
133 Environment variables:
134 PINTOSSIM Select default simulator.
139 # Sets the simulator.
142 die "--$new_sim conflicts with --$sim\n"
143 if defined ($sim) && $sim ne $new_sim;
149 my ($new_debug) = @_;
150 die "--$new_debug conflicts with --$debug\n"
151 if $debug ne 'none' && $new_debug ne 'none' && $debug ne $new_debug;
155 # Sets VGA output destination.
158 if (defined ($vga) && $vga ne $new_vga) {
159 print "warning: conflicting vga display options\n";
164 # Sets randomized timer interrupts.
166 my ($new_jitter) = @_;
167 die "--realtime conflicts with --jitter\n" if defined $realtime;
168 die "different --jitter already defined\n"
169 if defined $jitter && $jitter != $new_jitter;
170 $jitter = $new_jitter;
173 # Sets real-time timer interrupts.
175 die "--realtime conflicts with --jitter\n" if defined $jitter;
179 # add_file(\@list, $file)
181 # Adds [$file] to @list, which should be @puts or @gets.
182 # Sets $as_ref to point to the added element.
184 my ($list, $file) = @_;
186 push (@$list, $as_ref);
189 # Sets the guest/host name for the previous put/get.
192 die "-a (or --as) is only allowed after -p or -g\n" if !defined $as_ref;
193 die "Only one -a (or --as) is allowed after -p or -g\n"
194 if defined $as_ref->[1];
198 # Locates the files used to back each of the virtual disks,
199 # and creates temporary disks.
201 for my $disk (values %disks) {
202 # If there's no assigned file name but the default file exists,
203 # try to assign a default file name.
204 if (!defined ($disk->{FILENAME})) {
205 for my $try_fn ($disk->{DEF_FN}, "build/" . $disk->{DEF_FN}) {
206 $disk->{FILENAME} = $try_fn, last
211 # If there's no file name, we're done.
212 next if !defined ($disk->{FILENAME});
214 if ($disk->{FILENAME} =~ /^\d+(\.\d+)?|\.\d+$/) {
215 # Create a temporary disk of approximately the specified
217 die "OS disk can't be temporary\n" if $disk == $disks{OS};
219 my ($mb) = $disk->{FILENAME};
220 undef $disk->{FILENAME};
222 my ($cyl_size) = 512 * 16 * 63;
223 extend_disk ($disk, ceil ($mb * 2) * $cyl_size);
225 # The file must exist and have nonzero size.
226 -e $disk->{FILENAME} or die "$disk->{FILENAME}: stat: $!\n";
227 -s _ or die "$disk->{FILENAME}: disk has zero size\n";
231 # Warn about (potentially) missing disks.
232 die "Cannot find OS disk\n" if !defined $disks{OS}{FILENAME};
233 if (my ($project) = `pwd` =~ /\b(threads|userprog|vm|filesys)\b/) {
234 if ((grep ($project eq $_, qw (userprog vm filesys)))
235 && !defined ($disks{FS}{FILENAME})) {
236 print STDERR "warning: it looks like you're running the $project ";
237 print STDERR "project, but no file system disk is present\n";
239 if ($project eq 'vm' && !defined $disks{SWAP}{FILENAME}) {
240 print STDERR "warning: it looks like you're running the $project ";
241 print STDERR "project, but no swap disk is present\n";
246 # Prepare the scratch disk for gets and puts.
247 sub prepare_scratch_disk {
248 # Copy the files to put onto the scratch disk.
249 put_scratch_file ($_->[0]) foreach @puts;
251 # Make sure the scratch disk is big enough to get big files.
252 extend_disk ($disks{SCRATCH}, @gets * 1024 * 1024) if @gets;
255 # Read "get" files from the scratch disk.
256 sub finish_scratch_disk {
257 # We need to start reading the scratch disk from the beginning again.
259 close ($disks{SCRATCH}{HANDLE});
260 undef ($disks{SCRATCH}{HANDLE});
264 get_scratch_file (defined ($_->[1]) ? $_->[1] : $_->[0]) foreach @gets;
267 # put_scratch_file($file).
269 # Copies $file into the scratch disk.
270 sub put_scratch_file {
271 my ($put_filename) = @_;
272 my ($disk_handle, $disk_filename) = open_disk ($disks{SCRATCH});
274 print "Copying $put_filename into $disk_filename...\n";
276 # Write metadata sector, which consists of a 4-byte signature
277 # followed by the file size.
278 stat $put_filename or die "$put_filename: stat: $!\n";
280 my ($metadata) = pack ("a4 V x504", "PUT\0", $size);
281 write_fully ($disk_handle, $disk_filename, $metadata);
285 sysopen ($put_handle, $put_filename, O_RDONLY)
286 or die "$put_filename: open: $!\n";
287 copy_file ($put_handle, $put_filename, $disk_handle, $disk_filename,
291 # Round up disk data to beginning of next sector.
292 write_fully ($disk_handle, $disk_filename, "\0" x (512 - $size % 512))
296 # get_scratch_file($file).
298 # Copies from the scratch disk to $file.
299 sub get_scratch_file {
300 my ($get_filename) = @_;
301 my ($disk_handle, $disk_filename) = open_disk ($disks{SCRATCH});
303 print "Copying $get_filename out of $disk_filename...\n";
305 # Read metadata sector, which has a 4-byte signature followed by
307 my ($metadata) = read_fully ($disk_handle, $disk_filename, 512);
308 my ($signature, $size) = unpack ("a4 V", $metadata);
309 die "bad signature reading scratch disk--did Pintos run correctly?\n"
310 if $signature ne "GET\0";
314 sysopen ($get_handle, $get_filename, O_WRONLY | O_CREAT | O_EXCL, 0666)
315 or die "$get_filename: create: $!\n";
316 copy_file ($disk_handle, $disk_filename, $get_handle, $get_filename,
320 # Skip forward in disk up to beginning of next sector.
321 read_fully ($disk_handle, $disk_filename, 512 - $size % 512)
325 # Prepares the arguments to pass to the Pintos kernel,
326 # and then write them into Pintos bootloader.
327 sub prepare_arguments {
329 push (@args, shift (@kernel_args))
330 while @kernel_args && $kernel_args[0] =~ /^-/;
331 push (@args, 'put', defined $_->[1] ? $_->[1] : $_->[0]) foreach @puts;
332 push (@args, @kernel_args);
333 push (@args, 'get', $_->[0]) foreach @gets;
334 write_cmd_line ($disks{OS}, @args);
337 # Writes @args into the Pintos bootloader at the beginning of $disk.
339 my ($disk, @args) = @_;
341 # Figure out command line to write.
342 my ($arg_cnt) = pack ("V", scalar (@args));
343 my ($args) = join ('', map ("$_\0", @args));
344 die "command line exceeds 128 bytes" if length ($args) > 128;
345 $args .= "\0" x (128 - length ($args));
347 # Write command line.
348 my ($handle, $filename) = open_disk_copy ($disk);
349 print "Writing command line to $filename...\n";
350 sysseek ($handle, 0x17a, 0) == 0x17a or die "$filename: seek: $!\n";
351 syswrite ($handle, "$arg_cnt$args") or die "$filename: write: $!\n";
354 # Running simulators.
356 # Runs the selected simulator.
358 if ($sim eq 'bochs') {
360 } elsif ($sim eq 'qemu') {
362 } elsif ($sim eq 'gsx') {
365 die "unknown simulator `$sim'\n";
371 # Select Bochs binary based on the chosen debugger.
372 my ($bin) = $debug eq 'monitor' ? 'bochs-dbg' : 'bochs';
374 # Write bochsrc.txt configuration file.
375 open (BOCHSRC, ">", "bochsrc.txt") or die "bochsrc.txt: create: $!\n";
377 romimage: file=\$BXSHARE/BIOS-bochs-latest, address=0xf0000
378 vgaromimage: file=\$BXSHARE/VGABIOS-lgpl-latest
385 print BOCHSRC "gdbstub: enabled=1\n" if $debug eq 'gdb';
386 print BOCHSRC "clock: sync=", $realtime ? 'realtime' : 'none',
388 print_bochs_disk_line ("ata0-master", 0);
389 print_bochs_disk_line ("ata0-slave", 1);
390 if (defined ($disks_by_iface[2]{FILENAME})
391 || defined ($disks_by_iface[3]{FILENAME})) {
392 print BOCHSRC "ata1: enabled=1, ioaddr1=0x170, ",
393 "ioaddr2=0x370, irq=15\n";
394 print_bochs_disk_line ("ata1-master", 2);
395 print_bochs_disk_line ("ata1-slave", 3);
397 if ($vga ne 'terminal') {
398 print BOCHSRC "com1: enabled=1, mode=file, dev=/dev/stdout\n"
400 print BOCHSRC "display_library: nogui\n" if $vga eq 'none';
402 print BOCHSRC "display_library: term\n";
406 # Compose Bochs command line.
407 my (@cmd) = ($bin, '-q');
408 push (@cmd, '-j', $jitter) if defined $jitter;
411 print join (' ', @cmd), "\n";
412 my ($exit) = xsystem (@cmd);
413 if (WIFEXITED ($exit)) {
414 # Bochs exited normally.
415 # Ignore the exit code; Bochs normally exits with status 1,
417 } elsif (WIFSIGNALED ($exit)) {
418 die "Bochs died with signal ", WTERMSIG ($exit), "\n";
420 die "Bochs died: code $exit\n";
424 # print_bochs_disk_line($device, $iface)
426 # If IDE interface $iface has a disk attached, prints a bochsrc.txt
427 # line for attaching it to $device.
428 sub print_bochs_disk_line {
429 my ($device, $iface) = @_;
430 my ($disk) = $disks_by_iface[$iface];
431 my ($file) = $disk->{FILENAME};
433 my (%geom) = disk_geometry ($disk);
434 print BOCHSRC "$device: type=disk, path=$file, mode=flat, ";
435 print BOCHSRC "cylinders=$geom{C}, heads=$geom{H}, spt=$geom{S}, ";
436 print BOCHSRC "translation=none\n";
442 print "warning: qemu doesn't support --terminal\n"
443 if $vga eq 'terminal';
444 print "warning: qemu doesn't support jitter\n"
446 my (@cmd) = ('qemu');
447 for my $iface (0...3) {
448 my ($option) = ('-hda', '-hdb', '-hdc', '-hdd')[$iface];
449 push (@cmd, $option, $disks_by_iface[$iface]{FILENAME})
450 if defined $disks_by_iface[$iface]{FILENAME};
452 push (@cmd, '-m', $mem, '-nics', '0');
453 push (@cmd, '-nographic') if $vga eq 'none';
454 push (@cmd, '-serial', 'stdio') if $serial_out && $vga ne 'none';
455 push (@cmd, '-S') if $debug eq 'monitor';
456 push (@cmd, '-s', '-S') if $debug eq 'gdb';
457 push (@cmd, '-monitor', 'null') if $vga eq 'none' && $debug eq 'none';
463 # Prints a message that $flag is unsupported by GSX Server.
466 print "warning: no support for $flag with VMware GSX Server\n";
469 # Runs VMware GSX Server.
471 gsx_unsup ("--$debug") if $debug ne 'none';
472 gsx_unsup ("--no-vga") if $vga eq 'none';
473 gsx_unsup ("--terminal") if $vga eq 'terminal';
474 gsx_unsup ("--jitter") if defined $jitter;
476 unlink ("pintos.out");
478 open (VMX, ">", "pintos.vmx") or die "pintos.vmx: create: $!\n";
479 chmod 0777 & ~umask, "pintos.vmx";
481 #! /usr/bin/vmware -G
484 floppy0.present = FALSE
487 serial0.present = TRUE
488 serial0.fileType = "file"
489 serial0.fileName = "pintos.out"
492 for (my ($i) = 0; $i < 4; $i++) {
493 my ($disk) = $disks_by_iface[$i];
494 my ($dsk) = $disk->{FILENAME};
495 next if !defined $dsk;
501 my ($device) = "ide" . int ($i / 2) . ":" . ($i % 2);
504 $device.present = TRUE
505 $device.deviceType = "plainDisk"
506 $device.fileName = "$pln"
509 my (%geom) = disk_geometry ($disk);
510 open (PLN, ">", $pln) or die "$pln: create: $!\n";
518 #vm|CAPACITY $geom{CAPACITY}
519 ACCESS "$dsk" 0 $geom{CAPACITY}
525 my ($vmx) = getcwd () . "/pintos.vmx";
526 system ("vmware-cmd -s register $vmx >&/dev/null");
527 system ("vmware-cmd $vmx stop hard >&/dev/null");
528 system ("vmware -l -G -x -q $vmx");
529 system ("vmware-cmd $vmx stop hard >&/dev/null");
530 system ("vmware-cmd -s unregister $vmx >&/dev/null");
537 # Opens $disk, if it is not already open, and returns its file handle
541 if (!defined ($disk->{HANDLE})) {
542 if ($disk->{FILENAME}) {
543 sysopen ($disk->{HANDLE}, $disk->{FILENAME}, O_RDWR)
544 or die "$disk->{FILENAME}: open: $!\n";
546 ($disk->{HANDLE}, $disk->{FILENAME}) = tempfile (UNLINK => 1,
550 return ($disk->{HANDLE}, $disk->{FILENAME});
553 # open_disk_copy($disk)
555 # Makes a temporary copy of $disk and returns its file handle and file name.
558 die if !$disk->{FILENAME};
560 my ($orig_handle, $orig_filename) = open_disk ($disk);
561 my ($cp_handle, $cp_filename) = tempfile (UNLINK => 1, SUFFIX => '.dsk');
562 copy_file ($orig_handle, $orig_filename, $cp_handle, $cp_filename,
564 return ($disk->{HANDLE}, $disk->{FILENAME}) = ($cp_handle, $cp_filename);
567 # extend_disk($disk, $size)
569 # Extends $disk, if necessary, so that it is at least $size bytes
572 my ($disk, $size) = @_;
573 my ($handle, $filename) = open_disk ($disk);
574 if (-s ($handle) < $size) {
575 sysseek ($handle, $size - 1, 0) == $size - 1
576 or die "$filename: seek: $!\n";
577 syswrite ($handle, "\0") == 1
578 or die "$filename: write: $!\n";
582 # disk_geometry($file)
584 # Examines $file and returns a valid IDE disk geometry for it, as a
588 my ($file) = $disk->{FILENAME};
589 my ($size) = -s $file;
590 die "$file: stat: $!\n" if !defined $size;
591 die "$file: size not a multiple of 512 bytes\n" if $size % 512;
592 my ($cyl_size) = 512 * 16 * 63;
593 my ($cylinders) = ceil ($size / $cyl_size);
594 extend_disk ($disk, $cylinders * $cyl_size) if $size % $cyl_size;
596 return (CAPACITY => $size / 512,
602 # copy_file($from_handle, $from_filename, $to_handle, $to_filename, $size)
604 # Copies $size bytes from $from_handle to $to_handle.
605 # $from_filename and $to_filename are used in error messages.
607 my ($from_handle, $from_filename, $to_handle, $to_filename, $size) = @_;
610 my ($chunk_size) = 4096;
611 $chunk_size = $size if $chunk_size > $size;
612 $size -= $chunk_size;
614 my ($data) = read_fully ($from_handle, $from_filename, $chunk_size);
615 write_fully ($to_handle, $to_filename, $data);
619 # read_fully($handle, $filename, $bytes)
621 # Reads exactly $bytes bytes from $handle and returns the data read.
622 # $filename is used in error messages.
624 my ($handle, $filename, $bytes) = @_;
626 my ($read_bytes) = sysread ($handle, $data, $bytes);
627 die "$filename: read: $!\n" if !defined $read_bytes;
628 die "$filename: unexpected end of file\n" if $read_bytes != $bytes;
632 # write_fully($handle, $filename, $data)
634 # Write $data to $handle.
635 # $filename is used in error messages.
637 my ($handle, $filename, $data) = @_;
638 my ($written_bytes) = syswrite ($handle, $data);
639 die "$filename: write: $!\n" if !defined $written_bytes;
640 die "$filename: short write\n" if $written_bytes != length $data;
643 # Subprocess utilities.
647 # Runs xsystem(@args).
648 # Also prints the command it's running and checks that it succeeded.
650 print join (' ', @_), "\n";
651 die "command failed\n" if xsystem (@_);
656 # Creates a subprocess via exec(@args) and waits for it to complete.
657 # Relays common signals to the subprocess.
658 # If $timeout is set then the subprocess will be killed after that long.
661 if (!defined ($pid)) {
665 # Running in child process.
668 # Running in parent process.
669 local $SIG{ALRM} = sub { timeout ($pid); };
670 local $SIG{INT} = sub { relay_signal ($pid, "INT"); };
671 local $SIG{TERM} = sub { relay_signal ($pid, "TERM"); };
672 alarm ($timeout * get_load_average () + 1) if defined ($timeout);
676 if (WIFSIGNALED ($?) && WTERMSIG ($?) == SIGVTALRM ()) {
678 print "\nTIMEOUT after $timeout seconds of host CPU time\n";
686 # relay_signal($pid, $signal)
688 # Relays $signal to $pid and then reinvokes it for us with the default
689 # handler. Also cleans up temporary files.
691 my ($pid, $signal) = @_;
693 File::Temp::cleanup();
694 $SIG{$signal} = 'DEFAULT';
695 kill $signal, getpid ();
700 # Interrupts $pid and dies with a timeout error message.
706 my ($load_avg) = `uptime` =~ /(load average:.*)$/i;
707 print "\nTIMEOUT after ", time () - $start_time,
708 " seconds of wall-clock time";
709 print " - $load_avg" if defined $load_avg;
714 # Returns the system load average over the last minute.
715 # If the load average is less than 1.0 or cannot be determined, returns 1.0.
716 sub get_load_average {
717 my ($avg) = `uptime` =~ /load average:\s*([^,]+),/;
718 return $avg >= 1.0 ? $avg : 1.0;
721 # Calls setitimer to set a timeout, then execs what was passed to us.
723 if (defined $timeout) {
726 use Time::HiRes qw(setitimer ITIMER_VIRTUAL);
727 setitimer (ITIMER_VIRTUAL, $timeout, 0);
730 { exec ("setitimer-helper", $timeout, @_); };
731 exit 1 if !$!{ENOENT};
732 print STDERR "warning: setitimer-helper is not installed, so ",
733 "CPU time limit will not be enforced\n";
743 foreach my $name (split(' ', $Config{sig_name})) {
744 return $i if $name eq 'VTALRM';