No description
Find a file
Ron Dreslinski dc26d69b7d Temporary fixes so that upgrades and writebacks function properly with timing coherence
Eventually we can change this so that we don't evict something we have an MSHR for

--HG--
extra : convert_revision : 2311fb47e51fbdc0e33e01c387b07eabd1f559b4
2004-11-17 13:32:10 -05:00
arch Macros are nasty, so let's get rid of them. Convert all 2004-11-13 14:01:38 -05:00
base Minor cleanup of symtab code/includes. 2004-11-15 20:30:51 -05:00
build defining SYSTEM_EV5 isn't all that necessary 2004-11-13 11:32:17 -05:00
configs/boot added small block nfs script 2004-11-17 02:08:27 -05:00
cpu Merge zizzer:/z/m5/Bitkeeper/m5 2004-11-17 09:54:38 -05:00
dev properly implement the fifo _reserved stuff. 2004-11-17 01:27:08 -05:00
docs footer.html: 2003-10-15 20:49:12 -04:00
kern Minor cleanup of symtab code/includes. 2004-11-15 20:30:51 -05:00
sim Minor cleanup of symtab code/includes. 2004-11-15 20:30:51 -05:00
test Updated Copyright with information in bitkeeper changelogs 2004-06-08 13:37:27 -04:00
util Fix some commands. 2004-11-17 00:03:59 -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 Add support for sampled PC profiling to FullCPU. 2004-11-15 01:56:40 -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!"