~ubuntu-branches/ubuntu/edgy/spim/edgy

« back to all changes in this revision

Viewing changes to README

  • Committer: Bazaar Package Importer
  • Author(s): Matej Vela
  • Date: 2006-05-16 19:33:57 UTC
  • mfrom: (1.1.3 upstream)
  • Revision ID: james.westby@ubuntu.com-20060516193357-x2shox50y45dlo0q
Tags: 7.2.1-1
* QA upload.
* New upstream release.
* Package is orphaned (#354501); set maintainer to Debian QA Group.
* Acknowledge NMU.  Closes: #326097, #346936, #349389.
* Add a build dependency on bison.
* Change priority to extra in accordance with the override file.
* Install upstream changelog.
* Switch to debhelper 5.
* spim/Makefile: Allow optimization flags to be overridden.
* debian/rules:
  - Add support for DEB_BUILD_OPTIONS=noopt.
  - Use dh_install rather than (buggy) upstream Makefiles.
* debian/watch: Add.
* Conforms to Standards version 3.7.2.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
                     README FILE FOR SPIM & XSPIM
2
 
                     ============================
 
1
                  README FILE FOR SPIM, XSPIM, and PCSPIM
 
2
                  =======================================
3
3
 
4
4
This directory contains SPIM--an assembly language MIPS R2000/R3000
5
5
simulator.
23
23
 
24
24
 
25
25
 
26
 
                       BUILDING SPIM FOR UNIX SYSTEMS
27
 
                       ==============================
28
 
 
29
 
These instructions explain how to compile and install spim and xspim on a
30
 
Unix system.  It is not necessary to compile spim for PCs, as the web site
31
 
has precompiled versions.
32
 
 
33
 
To make SPIM, you must first run the Configure script:
34
 
 
35
 
        % Configure
36
 
 
37
 
Note: Configure compiles a program with the C compiler (cc).  If you want it
38
 
to use another compiler, set the environment variable CC to its name, e.g.:
39
 
 
40
 
        % setenv CC gcc
41
 
 
42
 
 
43
 
Next, edit the first few non-comment lines of Imakefile (or Makefile.std or
44
 
Makefile.cygwin, if you use one of those instead) to set the pathnames for
45
 
your system:
46
 
 
47
 
        EXCEPTION_DIR  -- The full pathname of the directory in which to
48
 
                     install the SPIM exception handler.
49
 
 
50
 
        BIN_DIR   -- The full pathname of the directory in which spim and
51
 
                     xspim should be installed.
52
 
 
53
 
        MAN_DIR   -- The full pathname of the directory in which the manual
54
 
                     pages for spim and xspim should be installed.
 
26
                               BUILDING SPIM
 
27
                               =============
 
28
 
 
29
These instructions explain how to compile and install spim and xspim.
 
30
 
 
31
It is not necessary to compile PCSpim (the Microsoft Windows version), as
 
32
the spim web site contains a precompiled version.
 
33
 
 
34
To build spim (the terminal version) or xspim (the X-windows and Mac
 
35
version):
 
36
 
 
37
1. Change to the directory "spim" to build spim. Change to the directory
 
38
"xspim" to build xspim
 
39
 
 
40
2. If necessary, edit the first few non-comment lines of the Makefile (or
 
41
the Imakefile if you are building xspim) to set the pathnames for your
 
42
system:
 
43
 
 
44
        EXCEPTION_DIR -- The full pathname of the directory in which to
 
45
                         install the SPIM exception handler.
 
46
 
 
47
        BIN_DIR -- The full pathname of the directory in which spim and
 
48
                   xspim should be installed.
 
49
 
 
50
        MAN_DIR -- The full pathname of the directory in which the manual
 
51
                   pages for spim and xspim should be installed.
55
52
 
56
53
In general, the remaining parameters need not be changed.
57
54
 
58
 
Then, if using Imakefile type:
 
55
 
 
56
3. If you are building spim type:
 
57
 
 
58
        % make
 
59
 
 
60
 
 
61
4. If you are building xspim, type:
59
62
 
60
63
        % xmkmf
61
64
        % make
62
65
 
63
 
If you want an X-window version of SPIM, also type:
64
 
 
65
 
        % make xspim
66
 
 
67
 
 
68
 
If you do not have X-windows or the program xmkmf, edit the makefile in
69
 
Makefile.std or Makefile.cygwin and type:
70
 
 
71
 
        % make -f Makefile.std test
72
 
        % make -f Makefile.std xspim
73
 
 
74
 
 
75
 
To run spim or xspim, the exception handler code must be installed in the
76
 
directory specified by the variable EXCEPTION_DIR in the Makefile.  If the file
77
 
exceptions.s is not installed, spim and xspim fail with a message before
78
 
they start running.  You can either install this file by hand or by typing
 
66
5. To run spim or xspim, the exception handler code must be installed in the
 
67
directory specified by the variable EXCEPTION_DIR in the Makefile.  If the
 
68
file "exceptions."s is not installed, spim and xspim fail with a message
 
69
before they start running.  You can either install this file by hand or by
 
70
typing
79
71
 
80
72
        % make install
81
73
 
82
 
which also installs spim, xspim, and the manual pages in the directories that you set (above).
83
 
 
84
 
 
85
 
To test that spim is correctly built, type
 
74
which also installs spim, xspim, and the manual pages in the directories
 
75
that you set (above).
 
76
 
 
77
 
 
78
6. To test that spim builds correctly, in the "spim" directory type
86
79
 
87
80
        % make test
88
81
 
90
83
installed before running the test.)
91
84
 
92
85
 
93
 
                              SPIM ON WINDOWS
94
 
                              ===============
95
 
 
96
 
SPIM works well on Windows.  You can easily build spim (the non-windowing
97
 
version) using the Cygwin port of the GNU tools (see www.cygwin.com).  The
98
 
Windows version of spim is called PCSpim and is distributed through:
99
 
 
100
 
        www.cs.wisc.edu/~larus/spim.html
 
86
                     BUILDING SPIM ON MICROSOFT WINDOWS
 
87
                     ==================================
 
88
 
 
89
spim (the terminal version) works well on Microsoft Windows.  You can easily
 
90
build it using the Cygwin port of the GNU tools (see www.cygwin.com).
 
91
 
 
92
The Microsoft Windows version of spim is called PCSpim and is built using
 
93
Microsoft Visual Studio. You can get the files separately from
 
94
www.cs.wisc.edu/~larus/spim.html
101
95
 
102
96
 
103
97
 
105
99
                         ===================
106
100
 
107
101
I generally release new version of SPIM once a year, before a semester
108
 
boundary (late August or early January).  The new version are available
109
 
through:
 
102
boundary (late August or early January).  The new version are available on:
110
103
 
111
104
                www.cs.wisc.edu/~larus/spim.html
112
105
 
113
106
 
114
107
 
115
 
The files in this directory are:
116
 
 
117
 
BLURB
118
 
        A short description of SPIM.
119
 
 
120
 
Configure
121
 
        A shell script to configure SPIM.
122
 
 
123
 
Imakefile
124
 
        Input file for the xmkmf program, which produces Makefile for your
125
 
        system.
126
 
 
127
 
Makefile.cygwin
128
 
        This makefile builds spim (but not xspim--use PCSpim instead) under
129
 
        the Cygnus Cygwin tools running on Windows.  Very cool and very
130
 
        convenient.
131
 
 
132
 
Makefile.std
133
 
        A default makefile.  Only use this file if you do not have xmkmf
134
 
        (see Imakefile).
 
108
This directory contains several files and subdirectories:
135
109
 
136
110
README  This file.
137
111
 
138
112
VERSION
139
113
        Version number of system.
140
114
 
141
 
buttons.c, buttons.h
142
 
        X-interface code for command buttons.
143
 
 
144
 
data.c, data.h
145
 
        Code to handle data directives.
146
 
 
147
 
inst.c, inst.h
148
 
        Code to build instructions and manipulate symbol table.
149
 
 
150
 
mem.c, mem.h
151
 
        Code to maintain memory.
152
 
 
153
 
syscall.c, syscall.h
154
 
        Code to handle system calls and exceptions.
155
 
 
156
 
op.h
157
 
        Definition of operations.
158
 
 
159
 
parser.y, parser.h
160
 
        Assembly command parser (YACC).
161
 
 
162
 
reg.h
163
 
        Register access macros.
164
 
 
165
 
run.c, run.h
166
 
        Instruction simulator.
167
 
 
168
 
scanner.l, scanner.h
169
 
        Lexical analyzer (LEX).
170
 
 
171
 
spim-syscall.h
172
 
        System call numbers.
173
 
 
174
 
spim-utils.c, spim-utils.h
175
 
        Misc. routines.
176
 
 
177
 
spim.c, spim.h
178
 
        Top-level interface.
179
 
 
180
 
sym-tbl.c, sym-tbl.h
181
 
        Symbol table.
182
 
 
183
 
windows.c, windows.h
184
 
        X-interface code to build windows.
185
 
 
186
 
xspim.c, xspim.h
187
 
        Top-level X-interface.
188
 
 
189
 
exceptions.s
190
 
        Standard exception handler.
 
115
ChangeLog
 
116
        Record of changes to spim code.
 
117
 
 
118
Documentation/TeX
 
119
        TeX document that describes SPIM.
 
120
 
 
121
Documentation/H_P_AppendixA
 
122
        Copy of Appendix A from Hennessey & Patterson's book "Computer
 
123
Organization and Design". This more up-to-date than the TeX documentation.
 
124
 
 
125
PCSpim
 
126
        Microsoft Windows interface to SPIM
 
127
 
 
128
Setup
 
129
        Installer code for PCSpim.
 
130
 
 
131
spim
 
132
        Terminal interfaces to spim (Microsoft Windows, Unix, and Mac).
191
133
 
192
134
Tests
193
135
        Subdirectory contain torture tests to verify that SPIM works.
194
136
 
195
 
Documentation/spim.tex
196
 
        TeX document that describes SPIM.
197
 
 
198
 
Documentation/spim.ps
199
 
        Postscript version of TeX document.
200
 
 
 
137
xspim
 
138
        X-Windows interface to spim (Unix and Mac).
201
139
 
202
140
 
203
141
 
212
150
James Larus
213
151
Microsoft Research
214
152
(larus@microsoft.com)
215
 
 
216
 
$Header: $