No description
Find a file
Ron Dreslinski e51850f1d2 Merge zizzer:/z/m5/Bitkeeper/m5
into zizzer.eecs.umich.edu:/.automount/zazzer/z/rdreslin/m5bk/timing_L1

--HG--
extra : convert_revision : a5ee8e5187503203058da35ca44918f1ff7ae1eb
2005-03-10 11:56:07 -05:00
arch fix typo in SyscallReturn Object 2005-03-10 02:01:43 -05:00
base Fix stats incompatibility with g++ 3.4. 2005-03-01 00:41:19 -05:00
build defining SYSTEM_EV5 isn't all that necessary 2004-11-13 11:32:17 -05:00
configs/boot Merge zizzer:/bk/m5 into zeep.eecs.umich.edu:/z/saidi/work/m5 2005-03-09 15:56:29 -05:00
cpu Merge zizzer:/z/m5/Bitkeeper/m5 2005-03-10 11:56:07 -05:00
dev fix typo in the fixed etherlink serialization. 2005-03-09 11:04:19 -05:00
docs footer.html: 2003-10-15 20:49:12 -04:00
kern Merger 2005-02-09 12:56:24 -05:00
objects Add support for using the variables that m5 was compiled with for 2005-03-09 14:42:30 -05:00
sim Merge zizzer:/bk/m5 into zeep.eecs.umich.edu:/z/saidi/work/m5 2005-03-09 15:56:29 -05:00
test Small initial steps toward generating C++ param structs 2005-02-22 23:53:34 -05:00
util Fix tracediff to work with new parameter and output directory structure. 2005-03-09 00:22:42 -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 undoing change per nates request 2005-02-14 20:47:05 -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!"