manual

The Pintos study edition by Huawen Yu.

ref
Please change the $HOME '/home/wilson' to your own home directory.
Now the qemu hang on 'Powering Off ...', so use bochs as our default simulator.

$ cd ~; mkdir proj; cd ~/proj
$ git clone https://github.com/huawenyu/pintos.git

Fedora, qemu is called qemu-system-i386

$ sudo yum install qemu
$ sudo ln -s /bin/qemu-system-i386 /bin/qemu

If install from fedora using 'sudo yum install bochs', there have serval error when start bochs.
So we can install it from source. If download the latest tar from bochs, even have compile error.
So we use svn checkout the developing code and import it here.

###build from newest version

### get the source
$ svn co http://svn.code.sf.net/p/bochs/code/trunk/bochs bochs
$ cd bochs
<or>
$ cd /home/wilson/proj/pintos/tools
$ tar xjf bochs.tar.bz2
$ cd bochs

### $ ./configure LDFLAGS='-pthread'  <<< fedora gui/libgui.a(x.o): undefined reference to symbol 'XSetForeground'
$ ./configure LDFLAGS='-pthread' --enable-gdb-stub --with-x --with-x11 --with-term --with-nogui

### install the devel lib for fedora
$ sudo yum install libX11-devel libXrandr-devel xorg-x11-server-devel
$ make
$ sudo make install

###build from version 2.2.6

Using Bochs as a simulator
Install Pintos
Solve compile error

index- bochs-2.2.6/bx_debug/symbol.cc:97
using namespace std;  
  
+ #ifdef __GNUC__
+ using namespace __gnu_cxx;
+ #endif

struct symbol_entry_t
{

$ cd proj/pintos/src/misc
$ sudo yum install SDL-devel byacc dev86 docbook-utils gtk2-devel iasl libXpm-devel libXt-devel readline-devel svgalib-devel
$ sudo yum groupinstall "Development Tools" "Development Libraries"
$ ./boshs-2.2.6-build.sh
env SRCDIR=<srcdir> PINTOSDIR=<srcdir> DSTDIR=<dstdir> sh ./bochs-2.2.6-build.sh
$ env SRCDIR=/home/wilson/proj/pintos/tools PINTOSDIR=/home/wilson/proj/pintos DSTDIR=/home/wilson/local sh ./bochs-2.2.6-build.sh

### using the current ver-2.2.6 to check our test
$ PATH=/home/wilson/local/bin:$PATH
$ cd /home/wilson/proj/pintos/src/threads/build
$ make check

$ patch src/utils/pintos-gdb

-GDBMACROS=/usr/class/cs140/pintos/pintos/src/misc/gdb-macros
+GDBMACROS=/home/wilson/proj/pintos/src/misc/gdb-macros

$ patch src/utils/pintos

-    $sim = "bochs" if !defined $sim;   <<< if using simulator-bochs
+    $sim = "qemu" if !defined $sim;    <<< if using simulator-qemu
  
-	my $name = find_file ('kernel.bin');
+	my $name = find_file ('/home/wilson/proj/pintos/src/threads/build/kernel.b<

$ patch src/utils/Pintos.pm

-    $name = find_file ("loader.bin") if !defined $name;
+    $name = find_file ("/home/wilson/proj/pintos/src/threads/build/loader.bin") if !defined $name;

$ cd src/utils
$ make
squish-pty.c:10:21: fatal error: stropts.h: No such file or directory
#include <stropts.h>

$ patch src/utils/squish-pty.c

+/*
 #include <stropts.h>
+*/

   /* System V implementations need STREAMS configuration for the
      slave. */
+  /*
   if (isastream (slave))
     {
       if (ioctl (slave, I_PUSH, "ptem") < 0
           || ioctl (slave, I_PUSH, "ldterm") < 0)
         fail_io ("ioctl");
     }
+  */

$ patch src/utils/squish-unix.c

+/*
 #include <stropts.h>
+*/

$ cd src/utils
$ make
$ PATH=$PATH:~/proj/pintos/src/utils

Please sure the dir 'utils' have setted in $PATH

$ patch src/threads/Make.vars

-SIMULATOR = --bochs   <<< if using simulator-bochs
+SIMULATOR = --qemu    <<< if using simulator-qemu

$ cd ~/proj/pinto/src/threads
$ make

Please sure the dir 'utils' have setted in $PATH

$ pintos -h
pintos run alarm-multiple, which passes the arguments 'run alarm-multiple' to the Pintos kernel.
In these arguments, run instructs the kernel to run a test and alarm-multiple is the test to run.

$ pintos run alarm-multiple

you can use the -v option to disable X output, -q let simulator auto-quit:
$ pintos -v -- run alarm-multiple.
$ pintos -v -- -q run alarm-single <<< -v no-gui, -q after run and quit
$ pintos -vk -T 60 --bochs -- -q run alarm-single <<< -T 60 timeout 60s and kill simulator if it's not quit.

Pintos uses the Bochs simulator by default. We can change qemu to be the default simulator. Do the following to change qemu to be the default simulator:

• In "$HOME/pintos/src/utils/pintos" change line no. 103 to "$sim = "qemu" if !defined $sim;"
• Open the file "$HOME/pintos/src/threads/Make.vars" and change the last line to be "SIMULATOR = --qemu"

Now you can run alarm-multiple like 'pintos -q run alarm-multiple'
Notice we still need the '-q' option. This is because qemu won't exit without the option. It will simply hang after completing alarm-multiple. This option simply says to shutdown qemu after running alarm-multiple.

Please sure the dir 'utils' have setted in $PATH

$ cd src/threads/build

$ make check
$ make check VERBOSE=1    <<< output more detail info

### select different simulator
$ make check SIMULATOR=--qemu
$ make check SIMULATOR=--bochs

### run specific test
$ touch ../../lib/debug.c
$ make tests/threads/alarm-multiple.result
$ cat tests/threads/alarm-multiple.result
PASS

To debug pintos you need two terminals. One to run pintos and one to run the debugger.
Be sure to start all commands from your pintos build sub-folder.

First, we should in the build sub-dir, and run pintos with --gdb option.  
It will prepare pintos as usual, but stop and wait for the debugger to connect.  

$ cd pintos/src/threads/build
$ pintos --gdb -- run mytest

Second, open a second terminal on the same machine and use pintos-gdb to invoke GDB on 'kernel.o':

$ cd pintos/src/threads/build
$ pintos-gdb kernel.o

It starts gdb configured for pintos. In the debugger, enter the commands:

(gdb) target remote localhost:1234
(gdb) 
(gdb) debugpintos
(gdb) break main
(gdb) continue
(gdb) continue
(gdb) quit

code ref1
code ref project-1
code ref project-2
code ref project-3
code ref project-4