Ali Saidi | 17aa2b0 | 2012-09-25 11:49:40 -0500 | [diff] [blame] | 1 | This is the gem5 simulator. |
Steve Reinhardt | 73f78b9 | 2003-10-17 09:32:00 -0700 | [diff] [blame] | 2 | |
Andreas Hansson | 4a3abf3 | 2014-08-26 10:12:04 -0400 | [diff] [blame] | 3 | The main website can be found at http://www.gem5.org |
Ali Saidi | 17aa2b0 | 2012-09-25 11:49:40 -0500 | [diff] [blame] | 4 | |
Andreas Hansson | 4a3abf3 | 2014-08-26 10:12:04 -0400 | [diff] [blame] | 5 | A good starting point is http://www.gem5.org/Introduction, and for |
| 6 | more information about building the simulator and getting started |
| 7 | please see http://www.gem5.org/Documentation and |
| 8 | http://www.gem5.org/Tutorials. |
Ali Saidi | de90be3 | 2006-06-29 16:52:47 -0400 | [diff] [blame] | 9 | |
Andreas Hansson | 4a3abf3 | 2014-08-26 10:12:04 -0400 | [diff] [blame] | 10 | To build gem5, you will need the following software: g++ or clang, |
| 11 | Python (gem5 links in the Python interpreter), SCons, SWIG, zlib, m4, |
| 12 | and lastly protobuf if you want trace capture and playback |
| 13 | support. Please see http://www.gem5.org/Dependencies for more details |
| 14 | concerning the minimum versions of the aforementioned tools. |
Ali Saidi | de90be3 | 2006-06-29 16:52:47 -0400 | [diff] [blame] | 15 | |
Andreas Hansson | 4a3abf3 | 2014-08-26 10:12:04 -0400 | [diff] [blame] | 16 | Once you have all dependencies resolved, type 'scons |
| 17 | build/<ARCH>/gem5.opt' where ARCH is one of ALPHA, ARM, NULL, MIPS, |
| 18 | POWER, SPARC, or X86. This will build an optimized version of the gem5 |
| 19 | binary (gem5.opt) for the the specified architecture. See |
| 20 | http://www.gem5.org/Build_System for more details and options. |
Steve Reinhardt | 0748851 | 2006-08-15 08:49:15 -0700 | [diff] [blame] | 21 | |
Andreas Hansson | 4a3abf3 | 2014-08-26 10:12:04 -0400 | [diff] [blame] | 22 | With the simulator built, have a look at |
| 23 | http://www.gem5.org/Running_gem5 for more information on how to use |
| 24 | gem5. |
Steve Reinhardt | 73f78b9 | 2003-10-17 09:32:00 -0700 | [diff] [blame] | 25 | |
Steve Reinhardt | a7974ee | 2005-10-06 13:59:05 -0400 | [diff] [blame] | 26 | The basic source release includes these subdirectories: |
Ali Saidi | 17aa2b0 | 2012-09-25 11:49:40 -0500 | [diff] [blame] | 27 | - configs: example simulation configuration scripts |
| 28 | - ext: less-common external packages needed to build gem5 |
| 29 | - src: source code of the gem5 simulator |
Gabe Black | 9891389 | 2011-02-14 21:36:37 -0800 | [diff] [blame] | 30 | - system: source for some optional system software for simulated systems |
| 31 | - tests: regression tests |
| 32 | - util: useful utility programs and files |
Steve Reinhardt | 73f78b9 | 2003-10-17 09:32:00 -0700 | [diff] [blame] | 33 | |
Gabe Black | 9891389 | 2011-02-14 21:36:37 -0800 | [diff] [blame] | 34 | To run full-system simulations, you will need compiled system firmware |
Andreas Hansson | 4a3abf3 | 2014-08-26 10:12:04 -0400 | [diff] [blame] | 35 | (console and PALcode for Alpha), kernel binaries and one or more disk |
| 36 | images. Please see the gem5 download page for these items at |
| 37 | http://www.gem5.org/Download |
| 38 | |
| 39 | If you have questions, please send mail to gem5-users@gem5.org |
| 40 | |
| 41 | Enjoy using gem5 and please share your modifications and extensions. |