F. Installing Pintos

This chapter explains how to install a Pintos development environment on your own machine, rather than in the VM provided. Much of the process is the same, excepting the possible need to resolve required dependencies.

The Pintos development environment is targeted at Unix-like systems. It has been most extensively tested on GNU/Linux, in particular the Debian and Ubuntu distributions, and Solaris. It is not designed to install under any form of Windows.

Prerequisites for installing a Pintos development environment include the following, on top of standard Unix utilities:

• Required: GCC. Version 4.0 or later is preferred. Version 3.3 or later should work. If the host machine has an 80x86 processor, then GCC should be available as gcc; otherwise, an 80x86 cross-compiler should be available as i386-elf-gcc. A sample set of commands for installing GCC 3.3.6 as a cross-compiler are included in src/misc/gcc-3.3.6-cross-howto.

• Required: GNU binutils. Pintos uses addr2line, ar, ld, objcopy, and ranlib. If the host machine is not an 80x86, versions targeting 80x86 should be available with an i386-elf- prefix.

• Required: Perl. Version 5.8.0 or later is preferred. Version 5.6.1 or later should work.

• Required: GNU make, version 3.80 or later.

• Recommended: QEMU, version 0.11.0 or later. If QEMU is not available, Bochs can be used, but its slowness is frustrating.

• Recommended: GDB. GDB is helpful in debugging (see section D.5 GDB). If the host machine is not an 80x86, a version of GDB targeting 80x86 should be available as i386-elf-gdb.

• Recommended: X. Being able to use an X server makes the virtual machine feel more like a physical machine, but it is not strictly necessary.

• Optional: Texinfo, version 4.5 or later. Texinfo is required to build the PDF version of the documentation.

• Optional: TeX. Also required to build the PDF version of the documentation.

• Optional: VMware Player. This is a third platform that can also be used to test Pintos.

Once these prerequisites are available, follow these instructions to install Pintos:

1. Get Pintos. Then install Bochs, compiling it from source using our script as described in the introduction. See section 1. Introduction.

2. Install scripts from src/utils. Copy backtrace, pintos, pintos-gdb, pintos-mkdisk, pintos-set-cmdline, and Pintos.pm into the default PATH.

3. Compile the remaining Pintos utilities by typing make in src/utils. Install squish-pty somewhere in PATH. To support VMware Player, install squish-unix. If your Perl is older than version 5.8.0, also install setitimer-helper; otherwise, it is unneeded.

4. Pintos should now be ready for use. If you have the Pintos reference solutions, which are provided only to faculty and their teaching assistants, then you may test your installation by running make check in the top-level tests directory. The tests take between 20 minutes and 1 hour to run, depending on the speed of your hardware.

5. Optional: Build the documentation, by running make dist in the top-level doc directory. This creates a WWW subdirectory within doc that contains HTML and PDF versions of the documentation, plus the design document templates and various hardware specifications referenced by the documentation. Building the PDF version of the manual requires Texinfo and TeX (see above). You may install WWW wherever you find most useful.

   The doc directory is not included in the .tar.gz distributed for Pintos. It is in the Pintos CVS tree available via :pserver:anonymous@footstool.stanford.edu:/var/lib/cvs, in the pintos module. The CVS tree is not the authoritative source for Stanford course materials, which should be obtained from the course website.