============================================================================
Instructions To Build SimpleScalar Visualizer (ss-viz) for Microsoft Windows

Fri Jul  9 16:31:57 CDT 2004

$Revision: 1.1 $
============================================================================
The following instructions have been tested on Microsoft Windows XP and 2000:

1. You need Cygwin on your Windows system to run Linux commands. The Cygwin 
   environment is downloadable from:

   http://www.cygwin.com/ 

   You should install all packages to avoid problems. (A full Cygwin 
   installation requires about 1.5GB space on disk, but is well worth the 
   effort.) 
   
   Afterwards, don't forget to augment the PATH environment variable with 
   C:/cygwin/bin.

2. SimpleScalar requires a version of the Tcl/Tk (tested with version 8.4.6.0).
   You can download the libraries for Linux at:

   http://www.activestate.com/Products/ActiveTcl/

   The following path is a directory which you can use to save and untar Tcl/Tk:

   C:/cygwin/usr/local/lib/Tcl8.4.5

   Note: Be sure that the libs tcl84.lib and tcl84.lib are existing in the 
   /lib directory from the path which is shown above.

3. Download the benchmarks and untar them in C:/cygwin/ then you will have a 
   directory structure like this /p/bin/simplescalar.

4. Now your system will be ready to gunzip and untar ss-viz.tgz.  

   Unzip ss-viz.tgz in the directory C:/cygwin/home.  You will get the file 
   ss-viz-rel1-2.tar. Now use tar -xvf to extract the ss-viz folder.

5. You must configure the include and library definitions in the Makefile. 
   You will find the Makefile in the directory C:/cygwin/home/ss-viz/src

   If you followed all steps exactly, the INCLUDES and LIBS path should look 
   like this:

   INCLUDES = -I/usr/local/include
   LIBS = C:/cygwin/usr/local/lib/Tcl8.4.5/lib/tcl84.lib  C:/cygwin/usr/local/lib/Tcl8.4.5/lib/tk84.lib

6. Next, you must specify the type of machine configuration. The following 
   instructions configure your machine:

   cd /home/ss-viz/src
   make config-pisa

7. After all changes are done we can build the C code executables:

   cd home/ss-viz/src
   make

8. Now you must change the first line in the ss-viz script file because this 
   line indicates the location of the bash shell in your system.

   cd /home/ss-viz

   Open the ss-viz file with an editor. Then change the first line like this:

   #!/bin/bash

9. Modify the following lines also in ss-viz:

   - The BASE_DIR line:
     BASE_DIR=/home/ss-viz

   - The SPEC_DIR line:
     SPEC_DIR=/p/bin/simplescalar/spec95

Now the configuration and installation are finished and you can run the 
SimpleScalar Visualizer (ss-viz). Start with:

  cd /home/ss-viz
  ./ss-viz

Note: It is possible to get an error which is caused by line 5 "package 
requires Tk8.4" in the source.tcl file. You can solve this error if you 
change the line like this:

  catch {package require Tk 8.4.}

Good luck, and have fun!
