README revision 1028
12810SN/AThis is release m5_1.0_beta1 of the M5 simulator.
29614Srene.dejong@arm.com
38856Sandreas.hansson@arm.comThis file contains brief "getting started" information and release
48856Sandreas.hansson@arm.comnotes.  For more information, see http://m5.eecs.umich.edu.  If you
58856Sandreas.hansson@arm.comhave questions, please send mail to m5sim-users@lists.sourceforge.net.
68856Sandreas.hansson@arm.com
78856Sandreas.hansson@arm.comWHAT'S INCLUDED (AND NOT)
88856Sandreas.hansson@arm.com-------------------------
98856Sandreas.hansson@arm.com
108856Sandreas.hansson@arm.comSince you're reading this file, presumably you've managed to untar the
118856Sandreas.hansson@arm.comdistribution.  The archive you've unpacked has three subdirectories:
128856Sandreas.hansson@arm.com - m5: the simulator itself
138856Sandreas.hansson@arm.com - m5-test: regression tests and scripts to run them
142810SN/A - ext: less-common external packages needed to build m5
152810SN/A   (currently ply and libelf)
162810SN/A
172810SN/AM5 is a capable, full-system simulator that current supports both Linux
182810SN/A2.4/2.6 and the proprietary Compaq/HP Tru64 version of Unix. We are able 
192810SN/Ato distribute Linux bootdisks, but we are unable to distribute bootable
202810SN/Adisk images of Tru64 Unix. If you have a Tru64 license and are interested 
212810SN/Ain obtaining disk images, contact us at m5-dev@eecs.umich.edu.
222810SN/A
232810SN/AWHAT'S NEEDED
242810SN/A-------------
252810SN/A-GCC(3.X)
262810SN/A-Python(2.2.2+)
272810SN/A
282810SN/AWHAT'S RECOMMENDED
292810SN/A------------------
302810SN/A-MySQL (for statistics complex statistics storage/retrieval)
312810SN/A-Python-MysqlDB (for statistics analysis) 
322810SN/A
332810SN/AGETTING STARTED
342810SN/A---------------
352810SN/A
362810SN/AThe following steps will build and test the simulator.  The variable
372810SN/A"$top" refers to the top directory where you've unpacked the files,
382810SN/Ai.e., the one containing the m5, m5-test, and ext directories.
392810SN/A
402810SN/AThere are three different build targets and three optimizations in each level:
412810SN/ATarget:
422810SN/A-------
432810SN/AALPHA  - Syscall emulation simulation
442810SN/AKERNEL - Linux full system simulation
452810SN/AKERNEL_TLASER - Tru64 Unix full system simulation
462810SN/A
472810SN/AOptimization:
488232Snate@binkert.org-------------
499152Satgutier@umich.edum5.debug - debug version of the code with tracing and without optimization
509795Sandreas.hansson@arm.comm5.opt   - optimized version of code with tracing
519795Sandreas.hansson@arm.comm5.fast  - optimized version of the code without tracing and asserts
5210263Satgutier@umich.edu
535338Sstever@gmail.comcd $top/m5/build
549795Sandreas.hansson@arm.comscons TARGET/OPTLEVL  # e.g. KERNEL/m5.opt, use -j N if you have a MP system
555338Sstever@gmail.comcd $top/m5-test
568786Sgblack@eecs.umich.edu./do-tests.pl -B ALPHA	# test what you just built
572810SN/A./do-tests.pl -B KERNEL	# test what you just built
582810SN/A# wait for tests to run...
592810SN/A# should end with "finished do-tests successfully!"
608856Sandreas.hansson@arm.com