README revision 1028
12SN/AThis is release m5_1.0_beta1 of the M5 simulator.
24039Sbinkertn@umich.edu
32SN/AThis file contains brief "getting started" information and release
42SN/Anotes.  For more information, see http://m5.eecs.umich.edu.  If you
52SN/Ahave questions, please send mail to m5sim-users@lists.sourceforge.net.
62SN/A
72SN/AWHAT'S INCLUDED (AND NOT)
82SN/A-------------------------
92SN/A
102SN/ASince you're reading this file, presumably you've managed to untar the
112SN/Adistribution.  The archive you've unpacked has three subdirectories:
122SN/A - m5: the simulator itself
132SN/A - m5-test: regression tests and scripts to run them
142SN/A - ext: less-common external packages needed to build m5
152SN/A   (currently ply and libelf)
162SN/A
172SN/AM5 is a capable, full-system simulator that current supports both Linux
182SN/A2.4/2.6 and the proprietary Compaq/HP Tru64 version of Unix. We are able 
192SN/Ato distribute Linux bootdisks, but we are unable to distribute bootable
202SN/Adisk images of Tru64 Unix. If you have a Tru64 license and are interested 
212SN/Ain obtaining disk images, contact us at m5-dev@eecs.umich.edu.
222SN/A
232SN/AWHAT'S NEEDED
242SN/A-------------
252SN/A-GCC(3.X)
262SN/A-Python(2.2.2+)
272665Ssaidi@eecs.umich.edu
282665Ssaidi@eecs.umich.eduWHAT'S RECOMMENDED
292665Ssaidi@eecs.umich.edu------------------
302SN/A-MySQL (for statistics complex statistics storage/retrieval)
312SN/A-Python-MysqlDB (for statistics analysis) 
321354SN/A
331354SN/AGETTING STARTED
342SN/A---------------
354046Sbinkertn@umich.edu
362SN/AThe following steps will build and test the simulator.  The variable
372SN/A"$top" refers to the top directory where you've unpacked the files,
3856SN/Ai.e., the one containing the m5, m5-test, and ext directories.
391031SN/A
404046Sbinkertn@umich.eduThere are three different build targets and three optimizations in each level:
416214Snate@binkert.orgTarget:
424167Sbinkertn@umich.edu-------
432SN/AALPHA  - Syscall emulation simulation
442SN/AKERNEL - Linux full system simulation
452SN/AKERNEL_TLASER - Tru64 Unix full system simulation
464046Sbinkertn@umich.edu
474046Sbinkertn@umich.eduOptimization:
482SN/A-------------
494046Sbinkertn@umich.edum5.debug - debug version of the code with tracing and without optimization
504046Sbinkertn@umich.edum5.opt   - optimized version of code with tracing
514046Sbinkertn@umich.edum5.fast  - optimized version of the code without tracing and asserts
524046Sbinkertn@umich.edu
534046Sbinkertn@umich.educd $top/m5/build
544046Sbinkertn@umich.eduscons TARGET/OPTLEVL  # e.g. KERNEL/m5.opt, use -j N if you have a MP system
552SN/Acd $top/m5-test
564046Sbinkertn@umich.edu./do-tests.pl -B ALPHA	# test what you just built
574046Sbinkertn@umich.edu./do-tests.pl -B KERNEL	# test what you just built
582SN/A# wait for tests to run...
594046Sbinkertn@umich.edu# should end with "finished do-tests successfully!"
604046Sbinkertn@umich.edu