X-Git-Url: https://pintos-os.org/cgi-bin/gitweb.cgi?p=pintos-anon;a=blobdiff_plain;f=src%2Futils%2Fpintos;h=fca610a15c83d6c4cdd1e80062d04b1812f5d1f8;hp=079ab5a34d22e8970a631203acdf6913e2a7a4fe;hb=8349a4cbeec56e4b497d98064ce51aba80c1f258;hpb=94e3568f3303b757f9e4133524b647163792662d

diff --git a/src/utils/pintos b/src/utils/pintos
index 079ab5a..fca610a 100755
--- a/src/utils/pintos
+++ b/src/utils/pintos
@@ -8,10 +8,10 @@ use Getopt::Long qw(:config bundling);
 
 # Command-line options.
 our ($start_time) = time ();
-our ($sim);			# Simulator: bochs, qemu, or gsx.
+our ($sim);			# Simulator: bochs, qemu, or player.
 our ($debug) = "none";		# Debugger: none, monitor, or gdb.
 our ($mem) = 4;			# Physical RAM in MB.
-our ($serial_out) = 1;		# Send output to serial port?
+our ($serial) = 1;		# Use serial port for input and output?
 our ($vga);			# VGA output: window, terminal, or none.
 our ($jitter);			# Seed for random timer interrupts, if set.
 our ($realtime);		# Synchronize timer interrupts with real time?
@@ -46,25 +46,25 @@ sub parse_command_line {
 	while ((my $arg = shift (@kernel_args)) ne '--') {
 	    push (@ARGV, $arg);
 	}
-	GetOptions ("sim=s" => sub { set_sim (@_) },
+	GetOptions ("sim=s" => sub { set_sim ($_[1]) },
 		    "bochs" => sub { set_sim ("bochs") },
 		    "qemu" => sub { set_sim ("qemu") },
-		    "gsx" => sub { set_sim ("gsx") },
+		    "player" => sub { set_sim ("player") },
 
-		    "debug=s" => sub { set_debug (@_) },
+		    "debug=s" => sub { set_debug ($_[1]) },
 		    "no-debug" => sub { set_debug ("none") },
 		    "monitor" => sub { set_debug ("monitor") },
 		    "gdb" => sub { set_debug ("gdb") },
 
 		    "m|memory=i" => \$mem,
-		    "j|jitter=i" => sub { set_jitter (@_) },
+		    "j|jitter=i" => sub { set_jitter ($_[1]) },
 		    "r|realtime" => sub { set_realtime () },
 
 		    "T|timeout=i" => \$timeout,
 		    "k|kill-on-failure" => \$kill_on_failure,
 
 		    "v|no-vga" => sub { set_vga ('none'); },
-		    "s|no-serial" => sub { $serial_out = 0; },
+		    "s|no-serial" => sub { $serial = 0; },
 		    "t|terminal" => sub { set_vga ('terminal'); },
 
 		    "p|put-file=s" => sub { add_file (\@puts, $_[1]); },
@@ -92,8 +92,8 @@ sub parse_command_line {
     undef $timeout, print "warning: disabling timeout with --$debug\n"
       if defined ($timeout) && $debug ne 'none';
 
-    print "warning: enabling serial output for -k or --kill-on-failure\n"
-      if $kill_on_failure && !$serial_out;
+    print "warning: enabling serial port for -k or --kill-on-failure\n"
+      if $kill_on_failure && !$serial;
 }
 
 # usage($exitcode).
@@ -108,15 +108,15 @@ where each OPTION is one of the following options
   and each ARGUMENT is passed to Pintos kernel verbatim.
 Simulator selection:
   --bochs                  (default) Use Bochs as simulator
-  --qemu                   Use qemu as simulator
-  --gsx                    Use VMware GSX Server 3.x as simulator
+  --qemu                   Use QEMU as simulator
+  --player                 Use VMware Player as simulator
 Debugger selection:
   --no-debug               (default) No debugger
   --monitor                Debug with simulator's monitor
   --gdb                    Debug with gdb
 Display options: (default is both VGA and serial)
-  -v, --no-vga             No VGA display
-  -s, --no-serial          No serial output
+  -v, --no-vga             No VGA display or keyboard
+  -s, --no-serial          No serial input or output
   -t, --terminal           Display VGA in terminal (Bochs only)
 Timing options: (Bochs only)
   -j SEED                  Randomize timer interrupts
@@ -252,8 +252,16 @@ sub find_disks {
 
 # Prepare the scratch disk for gets and puts.
 sub prepare_scratch_disk {
-    # Copy the files to put onto the scratch disk.
-    put_scratch_file ($_->[0]) foreach @puts;
+    if (@puts) {
+	# Write ustar header and data for each file.
+	put_scratch_file ($_->[0],
+			  defined $_->[1] ? $_->[1] : $_->[0])
+	  foreach @puts;
+
+	# Write end-of-archive marker.
+	write_fully ($disks{SCRATCH}{HANDLE}, $disks{SCRATCH}{FILE_NAME},
+		     "\0" x 1024);
+    }
 
     # Make sure the scratch disk is big enough to get big files.
     extend_disk ($disks{SCRATCH}, @gets * 1024 * 1024) if @gets;
@@ -268,31 +276,90 @@ sub finish_scratch_disk {
     }
 
     # Read each file.
-    get_scratch_file (defined ($_->[1]) ? $_->[1] : $_->[0]) foreach @gets;
+    # If reading fails, delete that file and all subsequent files.
+    my ($ok) = 1;
+    foreach my $get (@gets) {
+	my ($name) = defined ($get->[1]) ? $get->[1] : $get->[0];
+	my ($error) = get_scratch_file ($name);
+	if ($error) {
+	    print STDERR "getting $name failed ($error)\n";
+	    die "$name: unlink: $!\n" if !unlink ($name) && !$!{ENOENT};
+	    $ok = 0;
+	}
+    }
 }
 
-# put_scratch_file($file).
+# mk_ustar_field($number, $size)
 #
-# Copies $file into the scratch disk.
+# Returns $number in a $size-byte numeric field in the format used by
+# the standard ustar archive header.
+sub mk_ustar_field {
+    my ($number, $size) = @_;
+    my ($len) = $size - 1;
+    my ($out) = sprintf ("%0${len}o", $number) . "\0";
+    die "$number: too large for $size-byte octal ustar field\n"
+      if length ($out) != $size;
+    return $out;
+}
+
+# calc_ustar_chksum($s)
+#
+# Calculates and returns the ustar checksum of 512-byte ustar archive
+# header $s.
+sub calc_ustar_chksum {
+    my ($s) = @_;
+    die if length ($s) != 512;
+    substr ($s, 148, 8, ' ' x 8);
+    return unpack ("%32a*", $s);
+}
+
+# put_scratch_file($src_file_name, $dst_file_name).
+#
+# Copies $src_file_name into the scratch disk for extraction as
+# $dst_file_name.
 sub put_scratch_file {
-    my ($put_file_name) = @_;
+    my ($src_file_name, $dst_file_name) = @_;
     my ($disk_handle, $disk_file_name) = open_disk ($disks{SCRATCH});
 
-    print "Copying $put_file_name into $disk_file_name...\n";
+    print "Copying $src_file_name to scratch partition...\n";
 
-    # Write metadata sector, which consists of a 4-byte signature
-    # followed by the file size.
-    stat $put_file_name or die "$put_file_name: stat: $!\n";
+    # ustar format supports up to 100 characters for a file name, and
+    # even longer names given some common properties, but our code in
+    # the Pintos kernel only supports at most 99 characters.
+    die "$dst_file_name: name too long (max 99 characters)\n"
+      if length ($dst_file_name) > 99;
+
+    # Compose and write ustar header.
+    stat $src_file_name or die "$src_file_name: stat: $!\n";
     my ($size) = -s _;
-    my ($metadata) = pack ("a4 V x504", "PUT\0", $size);
-    write_fully ($disk_handle, $disk_file_name, $metadata);
+    my ($header) = (pack ("a100", $dst_file_name)	# name
+		    . mk_ustar_field (0644, 8)		# mode
+		    . mk_ustar_field (0, 8)		# uid
+		    . mk_ustar_field (0, 8)		# gid
+		    . mk_ustar_field ($size, 12)	# size
+		    . mk_ustar_field (1136102400, 12)	# mtime
+		    . (' ' x 8)				# chksum
+		    . '0'				# typeflag
+		    . ("\0" x 100)			# linkname
+		    . "ustar\0"				# magic
+		    . "00"				# version
+		    . "root" . ("\0" x 28)		# uname
+		    . "root" . ("\0" x 28)		# gname
+		    . "\0" x 8				# devmajor
+		    . "\0" x 8				# devminor
+		    . ("\0" x 155))			# prefix
+                    . "\0" x 12;			# pad to 512 bytes
+    substr ($header, 148, 8) = mk_ustar_field (calc_ustar_chksum ($header), 8);
+    write_fully ($disk_handle, $disk_file_name, $header);
 
     # Copy file data.
     my ($put_handle);
-    sysopen ($put_handle, $put_file_name, O_RDONLY)
-      or die "$put_file_name: open: $!\n";
-    copy_file ($put_handle, $put_file_name, $disk_handle, $disk_file_name,
+    sysopen ($put_handle, $src_file_name, O_RDONLY)
+      or die "$src_file_name: open: $!\n";
+    copy_file ($put_handle, $src_file_name, $disk_handle, $disk_file_name,
 	       $size);
+    die "$src_file_name: changed size while being read\n"
+      if $size != -s $put_handle;
     close ($put_handle);
 
     # Round up disk data to beginning of next sector.
@@ -303,22 +370,38 @@ sub put_scratch_file {
 # get_scratch_file($file).
 #
 # Copies from the scratch disk to $file.
+# Returns 1 if successful, 0 on failure.
 sub get_scratch_file {
     my ($get_file_name) = @_;
     my ($disk_handle, $disk_file_name) = open_disk ($disks{SCRATCH});
 
     print "Copying $get_file_name out of $disk_file_name...\n";
 
-    # Read metadata sector, which has a 4-byte signature followed by
-    # the file size.
-    my ($metadata) = read_fully ($disk_handle, $disk_file_name, 512);
-    my ($signature, $size) = unpack ("a4 V", $metadata);
-    die "bad signature reading scratch disk--did Pintos run correctly?\n"
-      if $signature ne "GET\0";
+    # Read ustar header sector.
+    my ($header) = read_fully ($disk_handle, $disk_file_name, 512);
+    return "scratch disk tar archive ends unexpectedly"
+      if $header eq ("\0" x 512);
+
+    # Verify magic numbers.
+    return "corrupt ustar signature" if substr ($header, 257, 6) ne "ustar\0";
+    return "invalid ustar version" if substr ($header, 263, 2) ne '00';
+
+    # Verify checksum.
+    my ($chksum) = oct (unpack ("Z*", substr ($header, 148, 8)));
+    my ($correct_chksum) = calc_ustar_chksum ($header);
+    return "checksum mismatch" if $chksum != $correct_chksum;
+
+    # Get type.
+    my ($typeflag) = substr ($header, 156, 1);
+    return "not a regular file" if $typeflag ne '0' && $typeflag ne "\0";
+
+    # Get size.
+    my ($size) = oct (unpack ("Z*", substr ($header, 124, 12)));
+    return "bad size $size\n" if $size < 0;
 
     # Copy file data.
     my ($get_handle);
-    sysopen ($get_handle, $get_file_name, O_WRONLY | O_CREAT | O_EXCL, 0666)
+    sysopen ($get_handle, $get_file_name, O_WRONLY | O_CREAT, 0666)
       or die "$get_file_name: create: $!\n";
     copy_file ($disk_handle, $disk_file_name, $get_handle, $get_file_name,
 	       $size);
@@ -327,6 +410,8 @@ sub get_scratch_file {
     # Skip forward in disk up to beginning of next sector.
     read_fully ($disk_handle, $disk_file_name, 512 - $size % 512)
       if $size % 512;
+
+    return 0;
 }
 
 # Prepares the arguments to pass to the Pintos kernel,
@@ -335,9 +420,9 @@ sub prepare_arguments {
     my (@args);
     push (@args, shift (@kernel_args))
       while @kernel_args && $kernel_args[0] =~ /^-/;
-    push (@args, 'put', defined $_->[1] ? $_->[1] : $_->[0]) foreach @puts;
+    push (@args, 'extract') if @puts;
     push (@args, @kernel_args);
-    push (@args, 'get', $_->[0]) foreach @gets;
+    push (@args, 'append', $_->[0]) foreach @gets;
     write_cmd_line ($disks{OS}, @args);
 }
 
@@ -366,8 +451,8 @@ sub run_vm {
 	run_bochs ();
     } elsif ($sim eq 'qemu') {
 	run_qemu ();
-    } elsif ($sim eq 'gsx') {
-	run_gsx ();
+    } elsif ($sim eq 'player') {
+	run_player ();
     } else {
 	die "unknown simulator `$sim'\n";
     }
@@ -378,10 +463,17 @@ sub run_bochs {
     # Select Bochs binary based on the chosen debugger.
     my ($bin) = $debug eq 'monitor' ? 'bochs-dbg' : 'bochs';
 
+    my ($squish_pty);
+    if ($serial) {
+	$squish_pty = find_in_path ("squish-pty");
+	print "warning: can't find squish-pty, so terminal input will fail\n"
+	  if !defined $squish_pty;
+    }
+
     # Write bochsrc.txt configuration file.
     open (BOCHSRC, ">", "bochsrc.txt") or die "bochsrc.txt: create: $!\n";
     print BOCHSRC <<EOF;
-romimage: file=\$BXSHARE/BIOS-bochs-latest, address=0xf0000
+romimage: file=\$BXSHARE/BIOS-bochs-latest
 vgaromimage: file=\$BXSHARE/VGABIOS-lgpl-latest
 boot: disk
 cpu: ips=1000000
@@ -390,8 +482,11 @@ log: bochsout.txt
 panic: action=fatal
 EOF
     print BOCHSRC "gdbstub: enabled=1\n" if $debug eq 'gdb';
-    print BOCHSRC "clock: sync=", $realtime ? 'realtime' : 'none',
-      " time0=0\n";
+    if ($realtime) {
+	print BOCHSRC "clock: sync=realtime\n";
+    } else {
+	print BOCHSRC "clock: sync=none, time0=0\n";
+    }
     print_bochs_disk_line ("ata0-master", 0);
     print_bochs_disk_line ("ata0-slave", 1);
     if (defined ($disks_by_iface[2]{FILE_NAME})
@@ -402,8 +497,10 @@ EOF
 	print_bochs_disk_line ("ata1-slave", 3);
     }
     if ($vga ne 'terminal') {
-	print BOCHSRC "com1: enabled=1, mode=file, dev=/dev/stdout\n"
-	  if $serial_out;
+	if ($serial) {
+	    my $mode = defined ($squish_pty) ? "term" : "file";
+	    print BOCHSRC "com1: enabled=1, mode=$mode, dev=/dev/stdout\n";
+	}
 	print BOCHSRC "display_library: nogui\n" if $vga eq 'none';
     } else {
 	print BOCHSRC "display_library: term\n";
@@ -412,6 +509,7 @@ EOF
 
     # Compose Bochs command line.
     my (@cmd) = ($bin, '-q');
+    unshift (@cmd, $squish_pty) if defined $squish_pty;
     push (@cmd, '-j', $jitter) if defined $jitter;
 
     # Run Bochs.
@@ -444,7 +542,7 @@ sub print_bochs_disk_line {
     }
 }
 
-# Runs qemu.
+# Runs QEMU.
 sub run_qemu {
     print "warning: qemu doesn't support --terminal\n"
       if $vga eq 'terminal';
@@ -459,43 +557,57 @@ sub run_qemu {
     push (@cmd, '-m', $mem);
     push (@cmd, '-net', 'none');
     push (@cmd, '-nographic') if $vga eq 'none';
-    push (@cmd, '-serial', 'stdio') if $serial_out && $vga ne 'none';
+    push (@cmd, '-serial', 'stdio') if $serial && $vga ne 'none';
     push (@cmd, '-S') if $debug eq 'monitor';
     push (@cmd, '-s', '-S') if $debug eq 'gdb';
     push (@cmd, '-monitor', 'null') if $vga eq 'none' && $debug eq 'none';
     run_command (@cmd);
 }
 
-# gsx_unsup($flag)
+# player_unsup($flag)
 #
-# Prints a message that $flag is unsupported by GSX Server.
-sub gsx_unsup {
+# Prints a message that $flag is unsupported by VMware Player.
+sub player_unsup {
     my ($flag) = @_;
-    print "warning: no support for $flag with VMware GSX Server\n";
+    print "warning: no support for $flag with VMware Player\n";
 }
 
-# Runs VMware GSX Server.
-sub run_gsx {
-    gsx_unsup ("--$debug") if $debug ne 'none';
-    gsx_unsup ("--no-vga") if $vga eq 'none';
-    gsx_unsup ("--terminal") if $vga eq 'terminal';
-    gsx_unsup ("--jitter") if defined $jitter;
-    gsx_unsup ("--kill-on-failure") if defined $kill_on_failure;
+# Runs VMware Player.
+sub run_player {
+    player_unsup ("--$debug") if $debug ne 'none';
+    player_unsup ("--no-vga") if $vga eq 'none';
+    player_unsup ("--terminal") if $vga eq 'terminal';
+    player_unsup ("--jitter") if defined $jitter;
+    player_unsup ("--timeout"), undef $timeout if defined $timeout;
+    player_unsup ("--kill-on-failure"), undef $kill_on_failure
+      if defined $kill_on_failure;
 
-    unlink ("pintos.out");
+    # Memory size must be multiple of 4.
+    $mem = int (($mem + 3) / 4) * 4;
 
     open (VMX, ">", "pintos.vmx") or die "pintos.vmx: create: $!\n";
     chmod 0777 & ~umask, "pintos.vmx";
     print VMX <<EOF;
 #! /usr/bin/vmware -G
-config.version = 6
+config.version = 8
 guestOS = "linux"
-floppy0.present = FALSE
 memsize = $mem
+floppy0.present = FALSE
+usb.present = FALSE
+sound.present = FALSE
+gui.exitAtPowerOff = TRUE
+gui.exitOnCLIHLT = TRUE
+gui.powerOnAtStartUp = TRUE
+EOF
+
 
+
+    print VMX <<EOF if $serial;
 serial0.present = TRUE
-serial0.fileType = "file"
-serial0.fileName = "pintos.out"
+serial0.fileType = "pipe"
+serial0.fileName = "pintos.socket"
+serial0.pipe.endPoint = "client"
+serial0.tryNoRxLoss = "TRUE"
 EOF
 
     for (my ($i) = 0; $i < 4; $i++) {
@@ -503,11 +615,8 @@ EOF
 	my ($dsk) = $disk->{FILE_NAME};
 	next if !defined $dsk;
 
-	my ($pln) = $dsk;
-	$pln =~ s/\.dsk//;
-	$pln .= ".pln";
-
 	my ($device) = "ide" . int ($i / 2) . ":" . ($i % 2);
+	my ($pln) = "$device.pln";
 	print VMX <<EOF;
 
 $device.present = TRUE
@@ -515,28 +624,48 @@ $device.deviceType = "plainDisk"
 $device.fileName = "$pln"
 EOF
 
+	open (URANDOM, '<', '/dev/urandom') or die "/dev/urandom: open: $!\n";
+	my ($bytes);
+	sysread (URANDOM, $bytes, 4) == 4 or die "/dev/urandom: read: $!\n";
+	close (URANDOM);
+	my ($cid) = unpack ("L", $bytes);
+
 	my (%geom) = disk_geometry ($disk);
 	open (PLN, ">", $pln) or die "$pln: create: $!\n";
 	print PLN <<EOF;
-DRIVETYPE	ide
-#vm|VERSION	2
-#vm|TOOLSVERSION	2
-CYLINDERS	$geom{C}
-HEADS		$geom{H}
-SECTORS		$geom{S}
-#vm|CAPACITY	$geom{CAPACITY}
-ACCESS "$dsk" 0 $geom{CAPACITY}
+version=1
+CID=$cid
+parentCID=ffffffff
+createType="monolithicFlat"
+
+RW $geom{CAPACITY} FLAT "$dsk" 0
+
+# The Disk Data Base
+#DDB
+
+ddb.adapterType = "ide"
+ddb.virtualHWVersion = "4"
+ddb.toolsVersion = "2"
+ddb.geometry.cylinders = "$geom{C}"
+ddb.geometry.heads = "$geom{H}"
+ddb.geometry.sectors = "$geom{S}"
 EOF
 	close (PLN);
     }
     close (VMX);
 
+    my ($squish_unix);
+    if ($serial) {
+	$squish_unix = find_in_path ("squish-unix");
+	print "warning: can't find squish-unix, so terminal input ",
+	  "and output will fail\n" if !defined $squish_unix;
+    }
+
     my ($vmx) = getcwd () . "/pintos.vmx";
-    system ("vmware-cmd -s register $vmx >&/dev/null");
-    system ("vmware-cmd $vmx stop hard >&/dev/null");
-    system ("vmware -l -G -x -q $vmx");
-    system ("vmware-cmd $vmx stop hard >&/dev/null");
-    system ("vmware-cmd -s unregister $vmx >&/dev/null");
+    my (@cmd) = ("vmplayer", $vmx);
+    unshift (@cmd, $squish_unix, "pintos.socket") if $squish_unix;
+    print join (' ', @cmd), "\n";
+    xsystem (@cmd);
 }
 
 # Disk utilities.
@@ -666,7 +795,7 @@ sub run_command {
 # Relays common signals to the subprocess.
 # If $timeout is set then the subprocess will be killed after that long.
 sub xsystem {
-    # qemu turns off local echo and does not restore it if killed by a signal.
+    # QEMU turns off local echo and does not restore it if killed by a signal.
     # We compensate by restoring it ourselves.
     my $cleanup = sub {};
     if (isatty (0)) {
@@ -703,7 +832,7 @@ sub xsystem {
 	    my ($boots) = 0;
 	    local ($|) = 1;
 	    for (;;) {
-		if (waitpid ($pid, WNOHANG) == 0) {
+		if (waitpid ($pid, WNOHANG) != 0) {
 		    # Subprocess died.  Pass through any remaining data.
 		    print $buf while sysread ($in, $buf, 4096) > 0;
 		    last;
@@ -711,7 +840,8 @@ sub xsystem {
 
 		# Read and print out pipe data.
 		my ($len) = length ($buf);
-		last if sysread ($in, $buf, 4096, $len) <= 0;
+		waitpid ($pid, 0), last
+		  if sysread ($in, $buf, 4096, $len) <= 0;
 		print substr ($buf, $len);
 
 		# Remove full lines from $buf and scan them for keywords.
@@ -730,8 +860,9 @@ sub xsystem {
 		    }
 		}
 	    }
+	} else {
+	    waitpid ($pid, 0);
 	}
-	waitpid ($pid, 0);
 	alarm (0);
 	&$cleanup ();
 
@@ -752,7 +883,7 @@ sub xsystem {
 sub relay_signal {
     my ($pid, $signal, $cleanup) = @_;
     kill $signal, $pid;
-    File::Temp::cleanup();
+    eval { File::Temp::cleanup() };	# Not defined in old File::Temp.
     &$cleanup ();
     $SIG{$signal} = 'DEFAULT';
     kill $signal, getpid ();
@@ -815,3 +946,13 @@ sub SIGVTALRM {
     }
     return 0;
 }
+
+# find_in_path ($program)
+#
+# Searches for $program in $ENV{PATH}.
+# Returns $program if found, otherwise undef.
+sub find_in_path {
+    my ($program) = @_;
+    -x "$_/$program" and return $program foreach split (':', $ENV{PATH});
+    return;
+}