README (7974:13692327bb0b) README (9249:1f43ff3d9bc6)
1This is the M5 simulator.
1This is the gem5 simulator.
2
3For detailed information about building the simulator and getting
2
3For detailed information about building the simulator and getting
4started please refer to http://www.m5sim.org.
4started please refer to:
5* The main website: http://www.gem5.org
6* Documentation wiki: http://www.gem5.org/Documentation
7* Doxygen generated: http://www.gem5.org/docs
8* Tutorials: http://www.gem5.org/Tutorials
5
9
10
6Specific pages of interest are:
11Specific pages of interest are:
7http://www.m5sim.org/wiki/index.php/Compiling_M5
8http://www.m5sim.org/wiki/index.php/Running_M5
12http://www.gem5.org/Introduction
13http://www.gem5.org/Build_System
14http://www.gem5.org/Dependencies
15http://www.gem5.org/Running_gem5
9
10Short version:
16
17Short version:
18External tools and required versions
11
19
121. If you don't have SCons version 0.98.1 or newer, get it from
13http://wwww.scons.org.
20To build gem5, you will need the following software:
21g++ version 4.3 or newer.
22Python, version 2.4 - 2.7 (we don't support Python 3.X). gem5 links in the
23 Python interpreter, so you need the Python header files and shared
24 library (e.g., /usr/lib/libpython2.4.so) in addition to the interpreter
25 executable. These may or may not be installed by default. For example,
26 on Debian/Ubuntu, you need the "python-dev" package in addition to the
27 "python" package. If you need a newer or different Python installation
28 but can't or don't want to upgrade the default Python on your system,
29 see http://www.gem5.org/Using_a_non-default_Python_installation
30SCons, version 0.98.1 or newer. SCons is a powerful replacement for make.
31 If you don't have administrator privileges on your machine, you can use the
32 "scons-local" package to install scons in your m5 directory, or install SCons
33 in your home directory using the '--prefix=' option.
34SWIG, version 1.3.34 or newer
35zlib, any recent version. For Debian/Ubuntu, you will need the "zlib-dev" or
36 "zlib1g-dev" package to get the zlib.h header file as well as the library
37 itself.
38m4, the macro processor.
14
39
152. If you don't have SWIG version 1.3.31 or newer, get it from
16http://wwww.swig.org.
17
40
183. Make sure you also have gcc version 3.4.6 or newer, Python 2.4 or newer
19(the dev version with header files), zlib, and the m4 preprocessor.
414. In this directory, type 'scons build/<ARCH>/gem5.opt' where ARCH is one
42of ALPHA, ARM, MIPS, POWER, SPARC, or X86. This will build an optimized version
43of the gem5 binary (gem5.opt) for the the specified architecture.
20
44
214. In this directory, type 'scons build/ALPHA_SE/tests/debug/quick'. This
22will build the debug version of the m5 binary (m5.debug) for the Alpha
23syscall emulation target, and run the quick regression tests on it.
45If you have questions, please send mail to gem5-users@gem5.org
24
46
25If you have questions, please send mail to m5-users@m5sim.org
26
27WHAT'S INCLUDED (AND NOT)
28-------------------------
29
30The basic source release includes these subdirectories:
47WHAT'S INCLUDED (AND NOT)
48-------------------------
49
50The basic source release includes these subdirectories:
31 - m5:
32 - configs: simulation configuration scripts
33 - ext: less-common external packages needed to build m5
34 - src: source code of the m5 simulator
51 - gem5:
52 - configs: example simulation configuration scripts
53 - ext: less-common external packages needed to build gem5
54 - src: source code of the gem5 simulator
35 - system: source for some optional system software for simulated systems
36 - tests: regression tests
37 - util: useful utility programs and files
38
39To run full-system simulations, you will need compiled system firmware
40(console and PALcode for Alpha), kernel binaries and one or more disk images.
55 - system: source for some optional system software for simulated systems
56 - tests: regression tests
57 - util: useful utility programs and files
58
59To run full-system simulations, you will need compiled system firmware
60(console and PALcode for Alpha), kernel binaries and one or more disk images.
41These files for Alpha are collected in a separate archive, m5_system.tar.bz2.
42This file can he downloaded separately.
43
44Depending on the ISA used, M5 may support Linux 2.4/2.6, FreeBSD, and the
45proprietary Compaq/HP Tru64 version of Unix. We are able to distribute Linux
46and FreeBSD bootdisks, but we are unable to distribute bootable disk images of
47Tru64 Unix. If you have a Tru64 license and are interested in
48obtaining disk images, contact us at m5-users@m5sim.org
61Please see the gem5 download page for these items at http://www.gem5.org/Download