README revision 1028
1131Sstever@eecs.umich.eduThis is release m5_1.0_beta1 of the M5 simulator.
2131Sstever@eecs.umich.edu
3131Sstever@eecs.umich.eduThis file contains brief "getting started" information and release
4131Sstever@eecs.umich.edunotes.  For more information, see http://m5.eecs.umich.edu.  If you
5131Sstever@eecs.umich.eduhave questions, please send mail to m5sim-users@lists.sourceforge.net.
6131Sstever@eecs.umich.edu
7131Sstever@eecs.umich.eduWHAT'S INCLUDED (AND NOT)
8131Sstever@eecs.umich.edu-------------------------
9131Sstever@eecs.umich.edu
10131Sstever@eecs.umich.eduSince you're reading this file, presumably you've managed to untar the
11131Sstever@eecs.umich.edudistribution.  The archive you've unpacked has three subdirectories:
12131Sstever@eecs.umich.edu - m5: the simulator itself
13131Sstever@eecs.umich.edu - m5-test: regression tests and scripts to run them
14131Sstever@eecs.umich.edu - ext: less-common external packages needed to build m5
151028Ssaidi@eecs.umich.edu   (currently ply and libelf)
16131Sstever@eecs.umich.edu
171028Ssaidi@eecs.umich.eduM5 is a capable, full-system simulator that current supports both Linux
181028Ssaidi@eecs.umich.edu2.4/2.6 and the proprietary Compaq/HP Tru64 version of Unix. We are able 
191028Ssaidi@eecs.umich.eduto distribute Linux bootdisks, but we are unable to distribute bootable
201028Ssaidi@eecs.umich.edudisk images of Tru64 Unix. If you have a Tru64 license and are interested 
211028Ssaidi@eecs.umich.eduin obtaining disk images, contact us at m5-dev@eecs.umich.edu.
221028Ssaidi@eecs.umich.edu
231028Ssaidi@eecs.umich.eduWHAT'S NEEDED
241028Ssaidi@eecs.umich.edu-------------
251028Ssaidi@eecs.umich.edu-GCC(3.X)
261028Ssaidi@eecs.umich.edu-Python(2.2.2+)
271028Ssaidi@eecs.umich.edu
281028Ssaidi@eecs.umich.eduWHAT'S RECOMMENDED
291028Ssaidi@eecs.umich.edu------------------
301028Ssaidi@eecs.umich.edu-MySQL (for statistics complex statistics storage/retrieval)
311028Ssaidi@eecs.umich.edu-Python-MysqlDB (for statistics analysis) 
32131Sstever@eecs.umich.edu
33131Sstever@eecs.umich.eduGETTING STARTED
34131Sstever@eecs.umich.edu---------------
35131Sstever@eecs.umich.edu
36131Sstever@eecs.umich.eduThe following steps will build and test the simulator.  The variable
37131Sstever@eecs.umich.edu"$top" refers to the top directory where you've unpacked the files,
38131Sstever@eecs.umich.edui.e., the one containing the m5, m5-test, and ext directories.
39131Sstever@eecs.umich.edu
401028Ssaidi@eecs.umich.eduThere are three different build targets and three optimizations in each level:
411028Ssaidi@eecs.umich.eduTarget:
421028Ssaidi@eecs.umich.edu-------
431028Ssaidi@eecs.umich.eduALPHA  - Syscall emulation simulation
441028Ssaidi@eecs.umich.eduKERNEL - Linux full system simulation
451028Ssaidi@eecs.umich.eduKERNEL_TLASER - Tru64 Unix full system simulation
461028Ssaidi@eecs.umich.edu
471028Ssaidi@eecs.umich.eduOptimization:
481028Ssaidi@eecs.umich.edu-------------
491028Ssaidi@eecs.umich.edum5.debug - debug version of the code with tracing and without optimization
501028Ssaidi@eecs.umich.edum5.opt   - optimized version of code with tracing
511028Ssaidi@eecs.umich.edum5.fast  - optimized version of the code without tracing and asserts
521028Ssaidi@eecs.umich.edu
531028Ssaidi@eecs.umich.educd $top/m5/build
541028Ssaidi@eecs.umich.eduscons TARGET/OPTLEVL  # e.g. KERNEL/m5.opt, use -j N if you have a MP system
55131Sstever@eecs.umich.educd $top/m5-test
56131Sstever@eecs.umich.edu./do-tests.pl -B ALPHA	# test what you just built
571028Ssaidi@eecs.umich.edu./do-tests.pl -B KERNEL	# test what you just built
58131Sstever@eecs.umich.edu# wait for tests to run...
59131Sstever@eecs.umich.edu# should end with "finished do-tests successfully!"
60