No description
Find a file
Ali Saidi 2aae3636ee Merge zizzer:/bk/m5 into zeep.eecs.umich.edu:/z/saidi/work/m5
--HG--
extra : convert_revision : ed089f6062639ae5be930fbaea3dd7f7622653cc
2005-01-27 16:01:32 -05:00
arch Merge zizzer.eecs.umich.edu:/bk/m5 2005-01-21 18:31:30 -05:00
base Merge zizzer.eecs.umich.edu:/bk/m5 2005-01-21 18:31:30 -05:00
build defining SYSTEM_EV5 isn't all that necessary 2004-11-13 11:32:17 -05:00
configs/boot add a no touch stream benchmark clean up a little 2004-11-18 16:23:28 -05:00
cpu Move trace data function to .cc file. 2005-01-18 11:43:45 -05:00
dev Merge zizzer.eecs.umich.edu:/bk/m5 2005-01-21 18:31:30 -05:00
docs footer.html: 2003-10-15 20:49:12 -04:00
kern Merge changes to make m5 g++ 3.4 compatible. 2005-01-18 13:02:47 -05:00
objects Fixup checkpointing with the new config stuff. 2005-01-21 15:09:42 -05:00
sim Merge zizzer:/bk/m5 into zeep.eecs.umich.edu:/z/saidi/work/m5 2005-01-27 16:01:32 -05:00
test Config cleanups 2005-01-17 23:41:35 -05:00
util added total bytes/bandwidth/packets formulas to nics 2005-01-19 18:40:02 -05:00
Doxyfile Update for doxygen 1.3.6 2004-05-04 16:32:43 -04:00
LICENSE updated readme to reflect linux/scons changes 2004-07-28 17:56:36 -04:00
README updated readme to reflect linux/scons changes 2004-07-28 17:56:36 -04:00
SConscript New and improved configuration mechanism. No more writing of 2005-01-15 04:12:25 -05:00

This is release m5_1.0_beta1 of the M5 simulator.

This file contains brief "getting started" information and release
notes.  For more information, see http://m5.eecs.umich.edu.  If you
have questions, please send mail to m5sim-users@lists.sourceforge.net.

WHAT'S INCLUDED (AND NOT)
-------------------------

Since you're reading this file, presumably you've managed to untar the
distribution.  The archive you've unpacked has three subdirectories:
 - m5: the simulator itself
 - m5-test: regression tests and scripts to run them
 - ext: less-common external packages needed to build m5
   (currently ply and libelf)

M5 is a capable, full-system simulator that current supports both Linux
2.4/2.6 and the proprietary Compaq/HP Tru64 version of Unix. We are able 
to distribute Linux bootdisks, but we are unable to distribute bootable
disk images of Tru64 Unix. If you have a Tru64 license and are interested 
in obtaining disk images, contact us at m5-dev@eecs.umich.edu.

WHAT'S NEEDED
-------------
-GCC(3.X)
-Python(2.2.2+)

WHAT'S RECOMMENDED
------------------
-MySQL (for statistics complex statistics storage/retrieval)
-Python-MysqlDB (for statistics analysis) 

GETTING STARTED
---------------

The following steps will build and test the simulator.  The variable
"$top" refers to the top directory where you've unpacked the files,
i.e., the one containing the m5, m5-test, and ext directories.

There are three different build targets and three optimizations in each level:
Target:
-------
ALPHA  - Syscall emulation simulation
KERNEL - Linux full system simulation
KERNEL_TLASER - Tru64 Unix full system simulation

Optimization:
-------------
m5.debug - debug version of the code with tracing and without optimization
m5.opt   - optimized version of code with tracing
m5.fast  - optimized version of the code without tracing and asserts

cd $top/m5/build
scons TARGET/OPTLEVL  # e.g. KERNEL/m5.opt, use -j N if you have a MP system
cd $top/m5-test
./do-tests.pl -B ALPHA	# test what you just built
./do-tests.pl -B KERNEL	# test what you just built
# wait for tests to run...
# should end with "finished do-tests successfully!"