No description
Find a file
Ali Saidi 8bbaaa7478 Fix doxgyen comments
Use openbsd ide/atapi header files

dev/alpha_console.cc:
dev/alpha_console.hh:
dev/baddev.cc:
dev/baddev.hh:
dev/disk_image.cc:
dev/disk_image.hh:
dev/tsunami_cchip.hh:
dev/tsunami_io.hh:
dev/tsunami_pchip.hh:
    Fix Doxygen comments
dev/ide_disk.cc:
    Use BSD atapi/ide header files
dev/ide_disk.hh:
    use ide/atapi header files

--HG--
extra : convert_revision : a15e40c7d7cc52af6867821e9574ba5c47021721
2005-06-04 23:56:53 -04:00
arch Remove the inorder CPU 2005-06-04 18:41:44 -04:00
base more portable 2005-06-04 14:16:04 -04:00
build Rename builds more descriptively: 2005-06-02 16:15:43 -04:00
configs Clean up to work with recent python config changes. 2005-06-04 23:08:26 -04:00
cpu more portable 2005-06-04 14:16:04 -04:00
dev Fix doxgyen comments 2005-06-04 23:56:53 -04:00
docs footer.html: 2003-10-15 20:49:12 -04:00
kern Merge ktlim@zizzer:/bk/m5 into zamp.eecs.umich.edu:/z/ktlim2/current/m5 2005-05-04 14:41:36 -04:00
python Get rid of vestiges of .mpy file handling. 2005-06-04 18:41:43 -04:00
sim Get rid of broken "long help" option. 2005-06-04 23:13:09 -04:00
test Major cleanup of python config code. 2005-05-29 01:14:50 -04:00
util Get rid of vestiges of .mpy file handling. 2005-06-04 18:41:43 -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 Rename builds more descriptively: 2005-06-02 16:15:43 -04:00
SConscript Remove the inorder CPU 2005-06-04 18:41:44 -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.4+)

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_SE - Syscall emulation simulation
ALPHA_FS - Linux full system simulation
ALPHA_FS_TL - Tru64 (Turbolaser) 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. ALPHA_FS/m5.opt, use -j N if you have a MP system
cd $top/m5-test
./do-tests.pl -B ALPHA_SE	# test what you just built
./do-tests.pl -B ALPHA_FS	# test what you just built
# wait for tests to run...
# should end with "finished do-tests successfully!"