README revision 7974
17974Sgblack@eecs.umich.eduThis is the M5 simulator.
2131Sstever@eecs.umich.edu
32987Sstever@eecs.umich.eduFor detailed information about building the simulator and getting
42987Sstever@eecs.umich.edustarted please refer to http://www.m5sim.org.
52815Ssaidi@eecs.umich.edu
62987Sstever@eecs.umich.eduSpecific pages of interest are:
72981Sstever@eecs.umich.eduhttp://www.m5sim.org/wiki/index.php/Compiling_M5
82981Sstever@eecs.umich.eduhttp://www.m5sim.org/wiki/index.php/Running_M5
92815Ssaidi@eecs.umich.edu
102987Sstever@eecs.umich.eduShort version:
112987Sstever@eecs.umich.edu
127974Sgblack@eecs.umich.edu1. If you don't have SCons version 0.98.1 or newer, get it from
132987Sstever@eecs.umich.eduhttp://wwww.scons.org.
142987Sstever@eecs.umich.edu
157974Sgblack@eecs.umich.edu2. If you don't have SWIG version 1.3.31 or newer, get it from
162987Sstever@eecs.umich.eduhttp://wwww.swig.org.
172987Sstever@eecs.umich.edu
187974Sgblack@eecs.umich.edu3. Make sure you also have gcc version 3.4.6 or newer, Python 2.4 or newer
197974Sgblack@eecs.umich.edu(the dev version with header files), zlib, and the m4 preprocessor.
207974Sgblack@eecs.umich.edu
217974Sgblack@eecs.umich.edu4. In this directory, type 'scons build/ALPHA_SE/tests/debug/quick'.  This
222987Sstever@eecs.umich.eduwill build the debug version of the m5 binary (m5.debug) for the Alpha
232987Sstever@eecs.umich.edusyscall emulation target, and run the quick regression tests on it.
242987Sstever@eecs.umich.edu
252999Ssaidi@eecs.umich.eduIf you have questions, please send mail to m5-users@m5sim.org
26131Sstever@eecs.umich.edu
27131Sstever@eecs.umich.eduWHAT'S INCLUDED (AND NOT)
28131Sstever@eecs.umich.edu-------------------------
29131Sstever@eecs.umich.edu
301905Sstever@eecs.umich.eduThe basic source release includes these subdirectories:
317974Sgblack@eecs.umich.edu - m5:
327974Sgblack@eecs.umich.edu   - configs: simulation configuration scripts
337974Sgblack@eecs.umich.edu   - ext: less-common external packages needed to build m5
342815Ssaidi@eecs.umich.edu   - src: source code of the m5 simulator
357974Sgblack@eecs.umich.edu   - system: source for some optional system software for simulated systems
362981Sstever@eecs.umich.edu   - tests: regression tests
377974Sgblack@eecs.umich.edu   - util: useful utility programs and files
38131Sstever@eecs.umich.edu
397974Sgblack@eecs.umich.eduTo run full-system simulations, you will need compiled system firmware
407974Sgblack@eecs.umich.edu(console and PALcode for Alpha), kernel binaries and one or more disk images. 
417974Sgblack@eecs.umich.eduThese files for Alpha are collected in a separate archive, m5_system.tar.bz2.
427974Sgblack@eecs.umich.eduThis file can he downloaded separately.
431905Sstever@eecs.umich.edu
447974Sgblack@eecs.umich.eduDepending on the ISA used, M5 may support Linux 2.4/2.6, FreeBSD, and the
457974Sgblack@eecs.umich.eduproprietary Compaq/HP Tru64 version of Unix. We are able to distribute Linux
467974Sgblack@eecs.umich.eduand FreeBSD bootdisks, but we are unable to distribute bootable disk images of
471905Sstever@eecs.umich.eduTru64 Unix. If you have a Tru64 license and are interested in
485193Ssaidi@eecs.umich.eduobtaining disk images, contact us at m5-users@m5sim.org
49