README revision 2999
11897Sstever@eecs.umich.eduThis is release 2.0_beta of the M5 simulator.
24130Ssaidi@eecs.umich.edu
31897Sstever@eecs.umich.eduFor detailed information about building the simulator and getting
41897Sstever@eecs.umich.edustarted please refer to http://www.m5sim.org.
51897Sstever@eecs.umich.edu
61897Sstever@eecs.umich.eduSpecific pages of interest are:
71897Sstever@eecs.umich.eduhttp://www.m5sim.org/wiki/index.php/Compiling_M5
81897Sstever@eecs.umich.eduhttp://www.m5sim.org/wiki/index.php/Running_M5
91897Sstever@eecs.umich.edu
101897Sstever@eecs.umich.eduShort version:
111897Sstever@eecs.umich.edu
121897Sstever@eecs.umich.edu1. If you don't have SCons version 0.96.91 or newer, get it from
131897Sstever@eecs.umich.eduhttp://wwww.scons.org.
141897Sstever@eecs.umich.edu
151897Sstever@eecs.umich.edu2. If you don't have SWIG version 1.3.28 or newer, get it from
161897Sstever@eecs.umich.eduhttp://wwww.swig.org.
171897Sstever@eecs.umich.edu
181897Sstever@eecs.umich.edu3. In this directory, type 'scons build/ALPHA_SE/tests/debug/quick'.  This
191897Sstever@eecs.umich.eduwill build the debug version of the m5 binary (m5.debug) for the Alpha
201897Sstever@eecs.umich.edusyscall emulation target, and run the quick regression tests on it.
211897Sstever@eecs.umich.edu
221897Sstever@eecs.umich.eduIf you have questions, please send mail to m5-users@m5sim.org
231897Sstever@eecs.umich.edu
241897Sstever@eecs.umich.eduWHAT'S INCLUDED (AND NOT)
251897Sstever@eecs.umich.edu-------------------------
261897Sstever@eecs.umich.edu
271897Sstever@eecs.umich.eduThe basic source release includes these subdirectories:
281897Sstever@eecs.umich.edu - m5: 
291897Sstever@eecs.umich.edu   - src: source code of the m5 simulator
301897Sstever@eecs.umich.edu   - tests: regression tests
311897Sstever@eecs.umich.edu   - ext: less-common external packages needed to build m5
321897Sstever@eecs.umich.edu   - system/alpha: source for Alpha console and PALcode
331897Sstever@eecs.umich.edu
344961Ssaidi@eecs.umich.eduTo run full-system simulations, you will need compiled console,
351897Sstever@eecs.umich.eduPALcode, and kernel binaries and one or more disk images.  These files
361897Sstever@eecs.umich.eduare collected in a separate archive, m5_system.tar.bz2.  This file
371897Sstever@eecs.umich.educan he downloaded separately.
381897Sstever@eecs.umich.edu
397047Snate@binkert.orgM5 supports Linux 2.4/2.6, FreeBSD, and the proprietary Compaq/HP
408319Ssteve.reinhardt@amd.comTru64 version of Unix. We are able to distribute Linux and FreeBSD
417047Snate@binkert.orgbootdisks, but we are unable to distribute bootable disk images of
428319Ssteve.reinhardt@amd.comTru64 Unix. If you have a Tru64 license and are interested in
4311706Sandreas.hansson@arm.comobtaining disk images, contact us at m5-dev@eecs.umich.edu.
448811Sandreas.hansson@arm.com