Go to file
Nathan Binkert 52403a5ddf get rid of defined and just access the env dict directly
get rid of the alias for true to True and false to False to keep
consistent python syntax.

util/stats/info.py:
    Fix typo

--HG--
extra : convert_revision : e69588a8de52424e043315e70008ca3a3ede7d5b
2005-02-03 17:04:54 -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 make nat runs used vegas congestion avoidance implementation. 2005-01-28 15:57:40 -05:00
cpu Move trace data function to .cc file. 2005-01-18 11:43:45 -05:00
dev small python config related fixes. 2005-02-03 14:33:02 -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 get rid of defined and just access the env dict directly 2005-02-03 17:04:54 -05:00
sim get rid of defined and just access the env dict directly 2005-02-03 17:04:54 -05:00
test Update config file language to take simobj and no longer use siminst 2005-02-02 21:13:01 -05:00
util get rid of defined and just access the env dict directly 2005-02-03 17:04:54 -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!"