You will also add a virtual memory implementation.
Pintos could, theoretically, run on a regular IBM-compatible PC.
-Unfortunately, it is impractical to supply every CS 140 student
+Unfortunately, it is impractical to supply every @value{coursenumber} student
a dedicated PC for use with Pintos. Therefore, we will run Pintos projects
in a system simulator, that is, a program that simulates an 80@var{x}86
CPU and its peripheral devices accurately enough that unmodified operating
systems and software can run under it. In class we will use the
@uref{http://bochs.sourceforge.net, , Bochs} and
@uref{http://fabrice.bellard.free.fr/qemu/, ,
-qemu} simulators. Pintos has also been tested with
+QEMU} simulators. Pintos has also been tested with
@uref{http://www.vmware.com/, , VMware Player}.
-These projects are hard. CS 140 has a reputation of taking a lot of
+These projects are hard. @value{coursenumber} has a reputation of taking a lot of
time, and deservedly so. We will do what we can to reduce the workload, such
as providing a lot of support material, but there is plenty of
hard work that needs to be done. We welcome your
@section Getting Started
To get started, you'll have to log into a machine that Pintos can be
-built on. The CS140 ``officially supported''
-Pintos development machines are the machines in Sweet Hall managed by
-Stanford ITSS, as described on the
-@uref{http://www.stanford.edu/services/cluster/environs/sweet/, , ITSS
-webpage}. You may use the Solaris or Linux machines. We will test your
-code on these machines, and the instructions given here assume this
-environment. However, Pintos and its supporting tools are portable
-enough that it should build ``out of the box'' in other environments.
+built on.
+@localmachines{}
+We will test your code on these machines, and the instructions given
+here assume this environment. We cannot provide support for installing
+and working on Pintos on your own machine, but we provide instructions
+for doing so nonetheless (@pxref{Installing Pintos}).
Once you've logged into one of these machines, either locally or
remotely, start out by adding our binaries directory to your @env{PATH}
-environment. Under @command{csh}, Stanford's login shell, you can do so
-with this command:@footnote{The term @samp{`uname -m`} expands to either
-@file{sun4u} or @file{i686} according to the type of computer you're
-logged into.}
-@example
-set path = ( /usr/class/cs140/`uname -m`/bin $path )
-@end example
-@noindent
-@strong{Notice that both @samp{`} are left single quotes or
-``backticks,'' not apostrophes (@samp{'}).}
-It is a good idea to add this line to the @file{.cshrc} file
-in your home directory. Otherwise, you'll have to type it every time
-you log in.
+environment.
+@localpathsetup{}
@menu
* Source Tree Overview::
Now you can extract the source for Pintos into a directory named
@file{pintos/src}, by executing
@example
-tar xzf /usr/class/cs140/pintos/pintos.tar.gz
+zcat @value{localpintostarpath} | tar x
@end example
Alternatively, fetch
-@uref{http://@/www.stanford.edu/@/class/@/cs140/@/pintos/@/pintos.@/tar.gz}
+@uref{@value{localpintoshttppath}}
and extract it in a similar way.
Let's take a look at what's inside. Here's the directory structure
@item misc/
@itemx utils/
These files may come in handy if you decide to try working with Pintos
-away from the ITSS machines. Otherwise, you can ignore them.
+on your own machine. Otherwise, you can ignore them.
@end table
@node Building Pintos
@file{Makefile} and a few subdirectories, and then build the kernel
inside. The entire build should take less than 30 seconds.
-Watch the commands executed during the build. On the Linux machines,
-the ordinary system tools are used. On a SPARC machine, special build
-tools are used, whose names begin with @samp{i386-elf-}, e.g.@:
-@code{i386-elf-gcc}, @code{i386-elf-ld}. These are ``cross-compiler''
-tools. That is, the build is running on a SPARC machine (called the
-@dfn{host}), but the result will run on a simulated 80@var{x}86 machine
-(called the @dfn{target}). The @samp{i386-elf-@var{program}} tools are
-specially built for this configuration.
+@localcrossbuild{}
Following the build, the following are the interesting files in the
@file{build} directory:
@code{pintos @var{option}@dots{} -- @var{argument}@dots{}}. Invoke
@code{pintos} without any arguments to see a list of available options.
Options can select a simulator to use: the default is Bochs, but
-@option{--qemu} selects qemu. You can run the simulator
+@option{--qemu} selects QEMU. You can run the simulator
with a debugger (@pxref{GDB}). You can set the amount of memory to give
the VM. Finally, you can select how you want VM output to be displayed:
use @option{-v} to turn off the VGA display, @option{-t} to use your
second of real time. Simulation in real-time mode is not reproducible,
and options @option{-j} and @option{-r} are mutually exclusive.
-The qemu simulator is available as an
+The QEMU simulator is available as an
alternative to Bochs (use @option{--qemu} when invoking
-@command{pintos}). The qemu simulator is much faster than Bochs, but it
+@command{pintos}). The QEMU simulator is much faster than Bochs, but it
only supports real-time simulation and does not have a reproducible
mode.
of the test results.
For project 1, the tests will probably run faster in Bochs. For the
-rest of the projects, they will run much faster in qemu.
+rest of the projects, they will run much faster in QEMU.
@command{make check} will select the faster simulator by default, but
you can override its choice by specifying @option{SIMULATOR=--bochs} or
@option{SIMULATOR=--qemu} on the @command{make} command line.
code that you submit. We will read your entire design document and much
of your source code.
-Don't forget that the design document is 50% of your project grade. It
+Don't forget that design quality, including the design document, is 50%
+of your project grade. It
is better to spend one or two hours writing a good design document than
it is to spend that time getting the last 5% of the points for tests and
then trying to rush through writing the design document in the last 15
patchwork of different styles that makes it obvious that three different
people wrote the code. Use horizontal and vertical white space to make
code readable. Add a brief comment on every structure, structure
-member, global or static variable, and function definition. Update
+member, global or static variable, typedef, enumeration, and function
+definition. Update
existing comments as you modify code. Don't comment out or use the
preprocessor to ignore blocks of code (instead, remove it entirely).
Use assertions to document key invariants. Decompose code into
FOR A PARTICULAR PURPOSE.
@xref{License}, for details of the license and lack of warranty.
-In the context of Stanford's CS 140 course, please respect the spirit
-and the letter of the honor code by refraining from reading any homework
-solutions available online or elsewhere. Reading the source code for
-other operating system kernels, such as Linux or FreeBSD, is allowed,
-but do not copy code from them literally. Please cite the code that
-inspired your own in your design documentation.
+@localhonorcodepolicy{}
@node Acknowledgements
@section Acknowledgements
-Pintos and this documentation were written by Ben Pfaff
-@email{blp@@cs.stanford.edu}.
+The Pintos core and this documentation were originally written by Ben
+Pfaff @email{blp@@cs.stanford.edu}.
+
+Additional features were contributed by Anthony Romano
+@email{chz@@vt.edu}.
The GDB macros supplied with Pintos were written by Godmar Back
@email{gback@@cs.vt.edu}, and their documentation is adapted from his
The original structure and form of Pintos was inspired by the Nachos
instructional operating system from the University of California,
-Berkeley.
+Berkeley (@bibref{Christopher}).
A few of the Pintos source files are derived from code used in the
Massachusetts Institute of Technology's 6.828 advanced operating systems
from classroom slides originally by Dawson Engler and updated by Mendel
Rosenblum.
+@localcredits{}
+
@node Trivia
@section Trivia
projects / pintos-anon / blobdiff