README revision 10284
19249SAli.Saidi@ARM.comThis is the gem5 simulator.
2131Sstever@eecs.umich.edu
310284Sandreas.hansson@arm.comThe main website can be found at http://www.gem5.org
49249SAli.Saidi@ARM.com
510284Sandreas.hansson@arm.comA good starting point is http://www.gem5.org/Introduction, and for
610284Sandreas.hansson@arm.commore information about building the simulator and getting started
710284Sandreas.hansson@arm.complease see http://www.gem5.org/Documentation and
810284Sandreas.hansson@arm.comhttp://www.gem5.org/Tutorials.
92815Ssaidi@eecs.umich.edu
1010284Sandreas.hansson@arm.comTo build gem5, you will need the following software: g++ or clang,
1110284Sandreas.hansson@arm.comPython (gem5 links in the Python interpreter), SCons, SWIG, zlib, m4,
1210284Sandreas.hansson@arm.comand lastly protobuf if you want trace capture and playback
1310284Sandreas.hansson@arm.comsupport. Please see http://www.gem5.org/Dependencies for more details
1410284Sandreas.hansson@arm.comconcerning the minimum versions of the aforementioned tools.
152815Ssaidi@eecs.umich.edu
1610284Sandreas.hansson@arm.comOnce you have all dependencies resolved, type 'scons
1710284Sandreas.hansson@arm.combuild/<ARCH>/gem5.opt' where ARCH is one of ALPHA, ARM, NULL, MIPS,
1810284Sandreas.hansson@arm.comPOWER, SPARC, or X86. This will build an optimized version of the gem5
1910284Sandreas.hansson@arm.combinary (gem5.opt) for the the specified architecture. See
2010284Sandreas.hansson@arm.comhttp://www.gem5.org/Build_System for more details and options.
212987Sstever@eecs.umich.edu
2210284Sandreas.hansson@arm.comWith the simulator built, have a look at
2310284Sandreas.hansson@arm.comhttp://www.gem5.org/Running_gem5 for more information on how to use
2410284Sandreas.hansson@arm.comgem5.
25131Sstever@eecs.umich.edu
261905Sstever@eecs.umich.eduThe basic source release includes these subdirectories:
279249SAli.Saidi@ARM.com   - configs: example simulation configuration scripts
289249SAli.Saidi@ARM.com   - ext: less-common external packages needed to build gem5
299249SAli.Saidi@ARM.com   - src: source code of the gem5 simulator
307974Sgblack@eecs.umich.edu   - system: source for some optional system software for simulated systems
312981Sstever@eecs.umich.edu   - tests: regression tests
327974Sgblack@eecs.umich.edu   - util: useful utility programs and files
33131Sstever@eecs.umich.edu
347974Sgblack@eecs.umich.eduTo run full-system simulations, you will need compiled system firmware
3510284Sandreas.hansson@arm.com(console and PALcode for Alpha), kernel binaries and one or more disk
3610284Sandreas.hansson@arm.comimages. Please see the gem5 download page for these items at
3710284Sandreas.hansson@arm.comhttp://www.gem5.org/Download
3810284Sandreas.hansson@arm.com
3910284Sandreas.hansson@arm.comIf you have questions, please send mail to gem5-users@gem5.org
4010284Sandreas.hansson@arm.com
4110284Sandreas.hansson@arm.comEnjoy using gem5 and please share your modifications and extensions.
42