Go to file
Nathan Binkert a40715c98d fix the options stuff
util/stats/stats.py:
    get the options from the options struct now
    gratuitously change the output directory for graphs.

--HG--
extra : convert_revision : 468f34bdc2c8b5fc3a393eaa4da4ec288e35c8c7
2004-09-10 14:34:23 -04:00
arch - Clean up and factor out all of the binning code into a 2004-08-20 11:35:31 -04:00
base - Clean up and factor out all of the binning code into a 2004-08-20 11:35:31 -04:00
build Fix SConstruct file to allow you to override the compilers 2004-08-16 17:27:38 -04:00
configs/boot commented script with various kernel parameter tweaks for better 2004-08-11 10:17:11 -04:00
cpu Update tracing functionality and add an ITX trace writer. 2004-09-02 11:27:38 -04:00
dev Updates to make SMP work. 2004-08-31 23:47:57 -04:00
docs footer.html: 2003-10-15 20:49:12 -04:00
kern std:: 2004-08-20 11:36:19 -04:00
sim Updates to make SMP work. 2004-08-31 23:47:57 -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 Update tracing functionality and add an ITX trace writer. 2004-09-02 11:27:38 -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!"