No description
Find a file
Nathan Binkert e9acc88e36 Merge zizzer.eecs.umich.edu:/z/m5/Bitkeeper/m5
into ziff.eecs.umich.edu:/z/binkertn/research/m5/current

--HG--
extra : convert_revision : 92785367bd1ae71505c5ac0491ed8e18b21ad577
2004-10-22 02:11:59 -04:00
arch Fixes for bigendian platforms 2004-10-16 19:10:51 -05:00
base Clean up the Range class and associated usages. The code was 2004-10-22 01:34:40 -04:00
build make all signatures go into a single file that's at the top 2004-10-22 02:11:51 -04:00
configs/boot commented script with various kernel parameter tweaks for better 2004-08-11 10:17:11 -04:00
cpu Bunch of little changes for tracking copies and getting OPT right. 2004-10-17 00:07:21 -04:00
dev Clean up the Range class and associated usages. The code was 2004-10-22 01:34:40 -04:00
docs footer.html: 2003-10-15 20:49:12 -04:00
kern few more stat items to serialize 2004-10-02 12:43:59 -04:00
sim Clean up/standardize handling of various output files. 2004-10-19 20:00:20 -04:00
test Updated Copyright with information in bitkeeper changelogs 2004-06-08 13:37:27 -04:00
util fix the options stuff 2004-09-10 14:34:23 -04: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 opt cpu and fix page copy warnings 2004-09-28 16:55:55 -04: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!"