blob: 5b0452bd3237df2aa2c3be8bdfac52ab7afa2fc7 [file] [log] [blame]
Ali Saidi17aa2b02012-09-25 11:49:40 -05001This is the gem5 simulator.
Steve Reinhardt73f78b92003-10-17 09:32:00 -07002
Andreas Hansson4a3abf32014-08-26 10:12:04 -04003The main website can be found at http://www.gem5.org
Ali Saidi17aa2b02012-09-25 11:49:40 -05004
Andreas Hansson4a3abf32014-08-26 10:12:04 -04005A good starting point is http://www.gem5.org/Introduction, and for
6more information about building the simulator and getting started
7please see http://www.gem5.org/Documentation and
8http://www.gem5.org/Tutorials.
Ali Saidide90be32006-06-29 16:52:47 -04009
Andreas Hansson4a3abf32014-08-26 10:12:04 -040010To build gem5, you will need the following software: g++ or clang,
11Python (gem5 links in the Python interpreter), SCons, SWIG, zlib, m4,
12and lastly protobuf if you want trace capture and playback
13support. Please see http://www.gem5.org/Dependencies for more details
14concerning the minimum versions of the aforementioned tools.
Ali Saidide90be32006-06-29 16:52:47 -040015
Andreas Hansson4a3abf32014-08-26 10:12:04 -040016Once you have all dependencies resolved, type 'scons
17build/<ARCH>/gem5.opt' where ARCH is one of ALPHA, ARM, NULL, MIPS,
18POWER, SPARC, or X86. This will build an optimized version of the gem5
19binary (gem5.opt) for the the specified architecture. See
20http://www.gem5.org/Build_System for more details and options.
Steve Reinhardt07488512006-08-15 08:49:15 -070021
Andreas Hansson4a3abf32014-08-26 10:12:04 -040022With the simulator built, have a look at
23http://www.gem5.org/Running_gem5 for more information on how to use
24gem5.
Steve Reinhardt73f78b92003-10-17 09:32:00 -070025
Steve Reinhardta7974ee2005-10-06 13:59:05 -040026The basic source release includes these subdirectories:
Ali Saidi17aa2b02012-09-25 11:49:40 -050027 - configs: example simulation configuration scripts
28 - ext: less-common external packages needed to build gem5
29 - src: source code of the gem5 simulator
Gabe Black98913892011-02-14 21:36:37 -080030 - system: source for some optional system software for simulated systems
31 - tests: regression tests
32 - util: useful utility programs and files
Steve Reinhardt73f78b92003-10-17 09:32:00 -070033
Gabe Black98913892011-02-14 21:36:37 -080034To run full-system simulations, you will need compiled system firmware
Andreas Hansson4a3abf32014-08-26 10:12:04 -040035(console and PALcode for Alpha), kernel binaries and one or more disk
36images. Please see the gem5 download page for these items at
37http://www.gem5.org/Download
38
39If you have questions, please send mail to gem5-users@gem5.org
40
41Enjoy using gem5 and please share your modifications and extensions.