README revision 10284
14170SN/AThis is the gem5 simulator.
24170SN/A
34170SN/AThe main website can be found at http://www.gem5.org
410036SAli.Saidi@ARM.com
58835SAli.Saidi@ARM.comA good starting point is http://www.gem5.org/Introduction, and for
610036SAli.Saidi@ARM.commore information about building the simulator and getting started
77935SN/Aplease see http://www.gem5.org/Documentation and
87935SN/Ahttp://www.gem5.org/Tutorials.
97935SN/A
104170SN/ATo build gem5, you will need the following software: g++ or clang,
114170SN/APython (gem5 links in the Python interpreter), SCons, SWIG, zlib, m4,
124170SN/Aand lastly protobuf if you want trace capture and playback
1310315Snilay@cs.wisc.edusupport. Please see http://www.gem5.org/Dependencies for more details
148835SAli.Saidi@ARM.comconcerning the minimum versions of the aforementioned tools.
159885Sstever@gmail.com
169885Sstever@gmail.comOnce you have all dependencies resolved, type 'scons
1710036SAli.Saidi@ARM.combuild/<ARCH>/gem5.opt' where ARCH is one of ALPHA, ARM, NULL, MIPS,
188835SAli.Saidi@ARM.comPOWER, SPARC, or X86. This will build an optimized version of the gem5
198835SAli.Saidi@ARM.combinary (gem5.opt) for the the specified architecture. See
2010315Snilay@cs.wisc.eduhttp://www.gem5.org/Build_System for more details and options.
218835SAli.Saidi@ARM.com
2210315Snilay@cs.wisc.eduWith the simulator built, have a look at
234170SN/Ahttp://www.gem5.org/Running_gem5 for more information on how to use
249481Snilay@cs.wisc.edugem5.
258721SN/A
2610736Snilay@cs.wisc.eduThe basic source release includes these subdirectories:
2711219Snilay@cs.wisc.edu   - configs: example simulation configuration scripts
288721SN/A   - ext: less-common external packages needed to build gem5
298835SAli.Saidi@ARM.com   - src: source code of the gem5 simulator
308835SAli.Saidi@ARM.com   - system: source for some optional system software for simulated systems
317935SN/A   - tests: regression tests
327935SN/A   - util: useful utility programs and files
337935SN/A
347935SN/ATo run full-system simulations, you will need compiled system firmware
357935SN/A(console and PALcode for Alpha), kernel binaries and one or more disk
367935SN/Aimages. Please see the gem5 download page for these items at
377935SN/Ahttp://www.gem5.org/Download
388983Snate@binkert.org
394170SN/AIf you have questions, please send mail to gem5-users@gem5.org
409885Sstever@gmail.com
419885Sstever@gmail.comEnjoy using gem5 and please share your modifications and extensions.
429885Sstever@gmail.com