README revision 131
1131Sstever@eecs.umich.edu
2131Sstever@eecs.umich.eduThis is release m5_1.0_beta1 of the M5 simulator.
3131Sstever@eecs.umich.edu
4131Sstever@eecs.umich.eduThis file contains brief "getting started" information and release
5131Sstever@eecs.umich.edunotes.  For more information, see http://m5.eecs.umich.edu.  If you
6131Sstever@eecs.umich.eduhave questions, please send mail to m5sim-users@lists.sourceforge.net.
7131Sstever@eecs.umich.edu
8131Sstever@eecs.umich.eduWHAT'S INCLUDED (AND NOT)
9131Sstever@eecs.umich.edu-------------------------
10131Sstever@eecs.umich.edu
11131Sstever@eecs.umich.eduSince you're reading this file, presumably you've managed to untar the
12131Sstever@eecs.umich.edudistribution.  The archive you've unpacked has three subdirectories:
13131Sstever@eecs.umich.edu - m5: the simulator itself
14131Sstever@eecs.umich.edu - m5-test: regression tests and scripts to run them
15131Sstever@eecs.umich.edu - ext: less-common external packages needed to build m5
16131Sstever@eecs.umich.edu   (currently just "ply")
17131Sstever@eecs.umich.edu
18131Sstever@eecs.umich.eduAlthough M5 is capable of full-system simulation, the only OS it
19131Sstever@eecs.umich.educurrently supports is the proprietary Compaq/HP Tru64 version of Unix.
20131Sstever@eecs.umich.eduWe are thus unable to distribute bootable disk images freely.  If you
21131Sstever@eecs.umich.eduhave a Tru64 license and are interested in obtaining disk images,
22131Sstever@eecs.umich.educontact us at m5-dev@eecs.umich.edu.
23131Sstever@eecs.umich.edu
24131Sstever@eecs.umich.eduGETTING STARTED
25131Sstever@eecs.umich.edu---------------
26131Sstever@eecs.umich.edu
27131Sstever@eecs.umich.eduThe following steps will build and test the simulator.  The variable
28131Sstever@eecs.umich.edu"$top" refers to the top directory where you've unpacked the files,
29131Sstever@eecs.umich.edui.e., the one containing the m5, m5-test, and ext directories.
30131Sstever@eecs.umich.edu
31131Sstever@eecs.umich.educd $top/m5/setup
32131Sstever@eecs.umich.edu./setup ALPHA		# set up build/ALPHA directory
33131Sstever@eecs.umich.educd $top/m5/build/ALPHA
34131Sstever@eecs.umich.edumake m5.opt		# use "-j N" if you've got an MP system
35131Sstever@eecs.umich.edu# wait for build...
36131Sstever@eecs.umich.educd $top/m5-test
37131Sstever@eecs.umich.edu./do-tests.pl -B ALPHA	# test what you just built
38131Sstever@eecs.umich.edu# wait for tests to run...
39131Sstever@eecs.umich.edu# should end with "finished do-tests successfully!"
40131Sstever@eecs.umich.edu
41131Sstever@eecs.umich.eduIf you run into errors regarding m5/arch/alpha/decoder.cc, just
42131Sstever@eecs.umich.edu"touch" that file to update its timestamp.  This file is generated
43131Sstever@eecs.umich.edufrom a compact ISA description using a program written in Python.  If
44131Sstever@eecs.umich.eduyou have Python 2.2.2 or later installed on your system, you should be
45131Sstever@eecs.umich.eduable to generate it yourself, but if you don't have Python (or have an
46131Sstever@eecs.umich.eduolder version), you may run in to trouble.  Since we've shipped a
47131Sstever@eecs.umich.eduworking copy of decoder.cc, it's not necessary to have Python to build
48131Sstever@eecs.umich.eduM5 (unless you start modifying the ISA decription).  Unfortunately,
49131Sstever@eecs.umich.edusometimes make gets confused and tries to do so anyway.  The "touch"
50131Sstever@eecs.umich.edushould convince make to stop trying.
51131Sstever@eecs.umich.edu
52