Installing OS/161 On Your Own

Machine
The following instructions describe how to install OS/161 on machines that are
outside of the student.cs computing environment. These instructions assume
that the target machine is running Linux.
If you are trying to install OS/161 in the student.cs computing environment,
then these are not the instructions for you. There is another set of instructions,
much simpler than this set, for working in the student.cs environment.
For marking purposes, your code will be compiled and executed in the
CSCF undergraduate (student.cs) environment. You are responsible for
ensuring that your code runs there.
Getting OS/161 and related tools running on your Linux machine should
not be too diicult. However, this is not a guarantee - there are too
many variables beyond our control. Ensuring that OS/161 runs in the
student.cs environment is our responsibility. Getting it running on your
machine is yours.
Setting up OS/161 on your own machine is more involved than setting it up in
your account in the student.cs environment. In the student.cs enviroment, both
the sys/161 simulator (on which OS/161 runs) and the associated toolchain
(compiler, debugger, binary utilities) are set up in the CS350 course account
and can be used from there. To run OS/161 on your home machine, you will
need to download and build your own copies of the simulator and the toolchain
before you can work with OS/161.
Step 0: Please be aware of the FAQ
If things go wrong please have a look at the FAQ for answers and solutions. In
particular most systems require the installation of additional software and/or
libraries. This will vary by Linux distro and/or Mac OS X version and we'll try to
collect information in the FAQ.
OS161 and Toolchain FAQ
Step 1: Download
Start by downloading the necessary les, which are described in the following
table:
Installing OS/161 On Your Own Machine https://www.student.cs.uwaterloo.ca/~cs350/co...
1 of 6 14-07-23 04:43 PM
What Download Link
Approx. Download
Size (MB)
Approx. Unpacked
Size (MB)
Binutils for MIPS
os161-
binutils.tar.gz
18 113
GCC MIPS Cross-
Compiler
os161-gcc.tar.gz 23 95
GDB for Use with
OS/161
os161-gdb.tar.gz 20 116
bmake for use
with OS/161
os161-
bmake.tar.gz
1 2
mk for use with
OS/161
os161-mk.tar.gz 1 1
sys/161 sys161.tar.gz 1 2
OS/161 os161.tar.gz 1 3
Step 2: Build and Install the Binary Utilities (Binutils)
Unpack the binutils archive:
tar -xzf os161-binutils.tar.gz
Move into the newly-created directory:
cd binutils-2.17+os161-2.0.1
Congure binutils:
./configure --nfp --disable-werror --target=mips-harvard-os161 --prefix=$HOME/sys161/tools
Make binutils:
make
If the make command fails because of a problem related to makeinfo, try running
the following command:
find . -name '*.info' | xargs touch
and then re-run make.
Finally, once make has succeeded, install the binutils into their nal location:
make install
This will create the directory $HOME/sys161/tools/ and populate it.
Step 3: Adjust Your Shell's Command Path
First, make the directory in which your shell will eventually nd the toolchain
binaries:
mkdir $HOME/sys161/bin
Next, add two directories ($HOME/sys161/bin and $HOME/sys161/tools/bin) to your
shell's search path. Users of bash should do something like this in your .bashrc le
Installing OS/161 On Your Own Machine https://www.student.cs.uwaterloo.ca/~cs350/co...
2 of 6 14-07-23 04:43 PM
in your home directory:
export PATH=$HOME/sys161/bin:$HOME/sys161/tools/bin:$PATH
while users of csh or tcsh would typically use .cshrc (in your home directory):
setenv PATH $HOME/sys161/bin:$HOME/sys161/tools/bin:${PATH}
Note that setting these variables only works in the shell or window in which you
issue the above commands in. You will need to ensure that the proper path is
set and used for future logins and for other newly created shells.
A bit more information about setting up your shell.
Note that you may need to log out and log back in again so that this PATH change
will take eect. You can check the current setting of the PATH environment
variable using the command
printenv PATH
Step 4: Install the GCC MIPS Cross-Compiler
Unpack the gcc archive:
tar -xzf os161-gcc.tar.gz
Move into the newly-created directory:
cd gcc-4.1.2+os161-2.0
Congure gcc
./configure -nfp --disable-shared --disable-threads --disable-libmudflap --disable-libssp
--target=mips-harvard-os161 --prefix=$HOME/sys161/tools
Make it and install it:
make
make install
Step 5: Install GDB
Unpack the gdb archive:
tar -xzf os161-gdb.tar.gz
Move into the newly-created directory:
cd gdb-6.6+os161-2.0
Congure gdb
./configure --target=mips-harvard-os161 --prefix=$HOME/sys161/tools --disable-werror
Make it and install it:
make
make install
Note: Compiling this version of GDB may fail when newer versions of the
texinfo package are installed (version 5.2-1, for instance). If you encounter an
issue with this step, install an older version of texinfo (such as 4.13-4) and try
again. Also make sure that the libncurses-devel library is installed, as it is
additionally required for compilation.
Installing OS/161 On Your Own Machine https://www.student.cs.uwaterloo.ca/~cs350/co...
3 of 6 14-07-23 04:43 PM
Step 6: Install bmake
Unpack the bmake archive:
tar -xzf os161-bmake.tar.gz
Move into the newly-created directory:
cd bmake
Unpack mk within the bmake directory:
tar -xzf ../os161-mk.tar.gz
Run the bmake bootstrap script
./boot-strap --prefix=$HOME/sys161/tools
As the boot-strap script nishes, it should print a list of commands that you can
run to install bmake under $HOME/sys161/tools. The list should look something like
this:
mkdir -p /home/kmsalem/sys161/tools/bin
cp /home/kmsalem/bmake/Linux/bmake /home/kmsalem/sys161/tools/bin/bmake-20101215
rm -f /home/kmsalem/sys161/tools/bin/bmake
ln -s bmake-20101215 /home/kmsalem/sys161/tools/bin/bmake
mkdir -p /home/kmsalem/sys161/tools/share/man/cat1
cp /home/kmsalem/bmake/bmake.cat1 /home/kmsalem/sys161/tools/share/man/cat1/bmake.1
sh /home/kmsalem/bmake/mk/install-mk /home/kmsalem/sys161/tools/share/mk
Of course, your output will refer to your directories, not to /home/kmsalem.
Run the commands printed by boot-strap in the order in which they are listed.
Step 7: Set Up Links for Toolchain Binaries
mkdir $HOME/sys161/bin
cd $HOME/sys161/tools/bin
sh -c 'for i in mips-*; do ln -s $HOME/sys161/tools/bin/$i $HOME/sys161/bin/cs350-`echo $i
| cut -d- -f4-`; done'
ln -s $HOME/sys161/tools/bin/bmake $HOME/sys161/bin/bmake
Cygwin Users: Shells under Cygwin sometimes have diiculty handling shell
commands in a string input as given above. If you nd yourself unable to get the
second command to work, copy and paste the entire second line into a shell
script in $HOME/sys161/tools/bin and run it from there. You will likely need to
change the permissions on the shell script to allow it to run, as follows:
chmod 755 myscript.sh
When you are nished with these steps, a listing of the directory $HOME/sys161/bin
should look similar to this:
bmake@ cs350-gcc@ cs350-ld@ cs350-run@
cs350-addr2line@ cs350-gcc-4.1.2@ cs350-nm@ cs350-size@
cs350-ar@ cs350-gccbug@ cs350-objcopy@ cs350-strings@
cs350-as@ cs350-gcov@ cs350-objdump@ cs350-strip@
cs350-c++filt@ cs350-gdb@ cs350-ranlib@
cs350-cpp@ cs350-gdbtui@ cs350-readelf@
Installing OS/161 On Your Own Machine https://www.student.cs.uwaterloo.ca/~cs350/co...
4 of 6 14-07-23 04:43 PM
Step 8: Build and Install the sys161 Simulator
Unpack the sys161 archive:
tar -xzf sys161.tar.gz
Move into the newly-created directory:
cd sys161-1.99.06
Next, congure sys161:
./configure --prefix=$HOME/sys161 mipseb
Build sys161 and install it:
make
make install
Finally, set up a link to a sample sys161 conguration le
cd $HOME/sys161
ln -s share/examples/sys161/sys161.conf.sample sys161.conf
Step 9: Install OS/161
First, create a directory to hold the OS/161 source code, your compiled OS/161
kernels, and related test programs.
cd $HOME
mkdir cs350-os161
Next, move the OS/161 archive into your new directory and unpack it:
mv os161.tar.gz cs350-os161
cd cs350-os161
tar -xzf os161.tar.gz
This will create a directory called os161-1.99 (under cs350-os161) containing the
OS/161 source code. You should now be able build, install, and run an OS/161
kernel and related application and test programs by following steps similar to
those used to install OS/161 in the student.cs computing environment, starting
with the step "Congure and Build OS/161".
Step 10: Cleanup (optional)
Once you have completed the above steps, your OS/161-related development
tools (binutils, gcc, gdb) and the sys/161 simulator will be installed under
$HOME/sys161, and OS/161 itself will be installed under $HOME/cs350-os161. The
archive les (lenames ending in .tar.gz) that you downloaded in Step 1 are no
longer needed, so feel free to remove them if you want to save space or reduce
clutter. You can also remove the directories in which you unpacked the archives
and built the software: binutils-2.17+os161-2.0.1, gcc-4.1.2+os161-2.0, gdb-6.6+os161-2.0,
bmake and sys161-1.99.06. However, do not delete the OS/161 source code (under
$HOME/cs350-os161/os161-1.99), since you will be making use of it for your
assignments.
Optionally, you may also remove the directory $HOME/sys161/tools/bin from your
shell command path, as it is needed only during the process of building the
Installing OS/161 On Your Own Machine https://www.student.cs.uwaterloo.ca/~cs350/co...
5 of 6 14-07-23 04:43 PM
toolchain. However, you be sure to leave $HOME/sys161/bin in your path, as that is
the home of the toolchain binaries that you will be using as you work with
OS/161.
Installing OS/161 On Your Own Machine https://www.student.cs.uwaterloo.ca/~cs350/co...
6 of 6 14-07-23 04:43 PM