README revision 9249
19249SAli.Saidi@ARM.comThis is the gem5 simulator. 2131Sstever@eecs.umich.edu 32987Sstever@eecs.umich.eduFor detailed information about building the simulator and getting 49249SAli.Saidi@ARM.comstarted please refer to: 59249SAli.Saidi@ARM.com* The main website: http://www.gem5.org 69249SAli.Saidi@ARM.com* Documentation wiki: http://www.gem5.org/Documentation 79249SAli.Saidi@ARM.com* Doxygen generated: http://www.gem5.org/docs 89249SAli.Saidi@ARM.com* Tutorials: http://www.gem5.org/Tutorials 99249SAli.Saidi@ARM.com 102815Ssaidi@eecs.umich.edu 112987Sstever@eecs.umich.eduSpecific pages of interest are: 129249SAli.Saidi@ARM.comhttp://www.gem5.org/Introduction 139249SAli.Saidi@ARM.comhttp://www.gem5.org/Build_System 149249SAli.Saidi@ARM.comhttp://www.gem5.org/Dependencies 159249SAli.Saidi@ARM.comhttp://www.gem5.org/Running_gem5 162815Ssaidi@eecs.umich.edu 172987Sstever@eecs.umich.eduShort version: 189249SAli.Saidi@ARM.comExternal tools and required versions 192987Sstever@eecs.umich.edu 209249SAli.Saidi@ARM.comTo build gem5, you will need the following software: 219249SAli.Saidi@ARM.comg++ version 4.3 or newer. 229249SAli.Saidi@ARM.comPython, version 2.4 - 2.7 (we don't support Python 3.X). gem5 links in the 239249SAli.Saidi@ARM.com Python interpreter, so you need the Python header files and shared 249249SAli.Saidi@ARM.com library (e.g., /usr/lib/libpython2.4.so) in addition to the interpreter 259249SAli.Saidi@ARM.com executable. These may or may not be installed by default. For example, 269249SAli.Saidi@ARM.com on Debian/Ubuntu, you need the "python-dev" package in addition to the 279249SAli.Saidi@ARM.com "python" package. If you need a newer or different Python installation 289249SAli.Saidi@ARM.com but can't or don't want to upgrade the default Python on your system, 299249SAli.Saidi@ARM.com see http://www.gem5.org/Using_a_non-default_Python_installation 309249SAli.Saidi@ARM.comSCons, version 0.98.1 or newer. SCons is a powerful replacement for make. 319249SAli.Saidi@ARM.com If you don't have administrator privileges on your machine, you can use the 329249SAli.Saidi@ARM.com "scons-local" package to install scons in your m5 directory, or install SCons 339249SAli.Saidi@ARM.com in your home directory using the '--prefix=' option. 349249SAli.Saidi@ARM.comSWIG, version 1.3.34 or newer 359249SAli.Saidi@ARM.comzlib, any recent version. For Debian/Ubuntu, you will need the "zlib-dev" or 369249SAli.Saidi@ARM.com "zlib1g-dev" package to get the zlib.h header file as well as the library 379249SAli.Saidi@ARM.com itself. 389249SAli.Saidi@ARM.comm4, the macro processor. 392987Sstever@eecs.umich.edu 402987Sstever@eecs.umich.edu 419249SAli.Saidi@ARM.com4. In this directory, type 'scons build/<ARCH>/gem5.opt' where ARCH is one 429249SAli.Saidi@ARM.comof ALPHA, ARM, MIPS, POWER, SPARC, or X86. This will build an optimized version 439249SAli.Saidi@ARM.comof the gem5 binary (gem5.opt) for the the specified architecture. 447974Sgblack@eecs.umich.edu 459249SAli.Saidi@ARM.comIf you have questions, please send mail to gem5-users@gem5.org 46131Sstever@eecs.umich.edu 47131Sstever@eecs.umich.eduWHAT'S INCLUDED (AND NOT) 48131Sstever@eecs.umich.edu------------------------- 49131Sstever@eecs.umich.edu 501905Sstever@eecs.umich.eduThe basic source release includes these subdirectories: 519249SAli.Saidi@ARM.com - gem5: 529249SAli.Saidi@ARM.com - configs: example simulation configuration scripts 539249SAli.Saidi@ARM.com - ext: less-common external packages needed to build gem5 549249SAli.Saidi@ARM.com - src: source code of the gem5 simulator 557974Sgblack@eecs.umich.edu - system: source for some optional system software for simulated systems 562981Sstever@eecs.umich.edu - tests: regression tests 577974Sgblack@eecs.umich.edu - util: useful utility programs and files 58131Sstever@eecs.umich.edu 597974Sgblack@eecs.umich.eduTo run full-system simulations, you will need compiled system firmware 607974Sgblack@eecs.umich.edu(console and PALcode for Alpha), kernel binaries and one or more disk images. 619249SAli.Saidi@ARM.comPlease see the gem5 download page for these items at http://www.gem5.org/Download 62