README revision 1704:e1fb036ad788
111012Sandreas.sandberg@arm.comThis is release m5_1.0_beta1 of the M5 simulator.
211012Sandreas.sandberg@arm.com
311012Sandreas.sandberg@arm.comThis file contains brief "getting started" information and release
411012Sandreas.sandberg@arm.comnotes.  For more information, see http://m5.eecs.umich.edu.  If you
511012Sandreas.sandberg@arm.comhave questions, please send mail to m5sim-users@lists.sourceforge.net.
611012Sandreas.sandberg@arm.com
711012Sandreas.sandberg@arm.comWHAT'S INCLUDED (AND NOT)
811012Sandreas.sandberg@arm.com-------------------------
911012Sandreas.sandberg@arm.com
1011012Sandreas.sandberg@arm.comSince you're reading this file, presumably you've managed to untar the
1111012Sandreas.sandberg@arm.comdistribution.  The archive you've unpacked has three subdirectories:
1211012Sandreas.sandberg@arm.com - m5: the simulator itself
1311012Sandreas.sandberg@arm.com - m5-test: regression tests and scripts to run them
1411012Sandreas.sandberg@arm.com - ext: less-common external packages needed to build m5
1511012Sandreas.sandberg@arm.com   (currently ply and libelf)
1611012Sandreas.sandberg@arm.com
1711012Sandreas.sandberg@arm.comM5 is a capable, full-system simulator that current supports both Linux
1811012Sandreas.sandberg@arm.com2.4/2.6 and the proprietary Compaq/HP Tru64 version of Unix. We are able 
1911012Sandreas.sandberg@arm.comto distribute Linux bootdisks, but we are unable to distribute bootable
2011012Sandreas.sandberg@arm.comdisk images of Tru64 Unix. If you have a Tru64 license and are interested 
2111012Sandreas.sandberg@arm.comin obtaining disk images, contact us at m5-dev@eecs.umich.edu.
2211012Sandreas.sandberg@arm.com
2311012Sandreas.sandberg@arm.comWHAT'S NEEDED
2411012Sandreas.sandberg@arm.com-------------
2511012Sandreas.sandberg@arm.com-GCC(3.X)
2611012Sandreas.sandberg@arm.com-Python(2.4+)
2711012Sandreas.sandberg@arm.com
2811012Sandreas.sandberg@arm.comWHAT'S RECOMMENDED
2911012Sandreas.sandberg@arm.com------------------
3011012Sandreas.sandberg@arm.com-MySQL (for statistics complex statistics storage/retrieval)
3111012Sandreas.sandberg@arm.com-Python-MysqlDB (for statistics analysis) 
3211012Sandreas.sandberg@arm.com
3311012Sandreas.sandberg@arm.comGETTING STARTED
3411012Sandreas.sandberg@arm.com---------------
3511012Sandreas.sandberg@arm.com
3611012Sandreas.sandberg@arm.comThe following steps will build and test the simulator.  The variable
3711012Sandreas.sandberg@arm.com"$top" refers to the top directory where you've unpacked the files,
3811012Sandreas.sandberg@arm.comi.e., the one containing the m5, m5-test, and ext directories.
3911012Sandreas.sandberg@arm.com
4011012Sandreas.sandberg@arm.comThere are three different build targets and three optimizations in each level:
4111012Sandreas.sandberg@arm.comTarget:
4211012Sandreas.sandberg@arm.com-------
4311012Sandreas.sandberg@arm.comALPHA_SE - Syscall emulation simulation
4411012Sandreas.sandberg@arm.comALPHA_FS - Linux full system simulation
4511012Sandreas.sandberg@arm.comALPHA_FS_TL - Tru64 (Turbolaser) Unix full system simulation
4611012Sandreas.sandberg@arm.com
4711012Sandreas.sandberg@arm.comOptimization:
4811012Sandreas.sandberg@arm.com-------------
4911012Sandreas.sandberg@arm.comm5.debug - debug version of the code with tracing and without optimization
5011012Sandreas.sandberg@arm.comm5.opt   - optimized version of code with tracing
5111012Sandreas.sandberg@arm.comm5.fast  - optimized version of the code without tracing and asserts
5211012Sandreas.sandberg@arm.com
5311012Sandreas.sandberg@arm.comcd $top/m5/build
5411012Sandreas.sandberg@arm.comscons TARGET/OPTLEVL  # e.g. ALPHA_FS/m5.opt, use -j N if you have a MP system
5511012Sandreas.sandberg@arm.comcd $top/m5-test
5611012Sandreas.sandberg@arm.com./do-tests.pl -B ALPHA_SE	# test what you just built
5711012Sandreas.sandberg@arm.com./do-tests.pl -B ALPHA_FS	# test what you just built
5811012Sandreas.sandberg@arm.com# wait for tests to run...
5911012Sandreas.sandberg@arm.com# should end with "finished do-tests successfully!"
6011012Sandreas.sandberg@arm.com