README revision 131:1a40e60270c1
1 2This is release m5_1.0_beta1 of the M5 simulator. 3 4This file contains brief "getting started" information and release 5notes. For more information, see http://m5.eecs.umich.edu. If you 6have questions, please send mail to m5sim-users@lists.sourceforge.net. 7 8WHAT'S INCLUDED (AND NOT) 9------------------------- 10 11Since you're reading this file, presumably you've managed to untar the 12distribution. The archive you've unpacked has three subdirectories: 13 - m5: the simulator itself 14 - m5-test: regression tests and scripts to run them 15 - ext: less-common external packages needed to build m5 16 (currently just "ply") 17 18Although M5 is capable of full-system simulation, the only OS it 19currently supports is the proprietary Compaq/HP Tru64 version of Unix. 20We are thus unable to distribute bootable disk images freely. If you 21have a Tru64 license and are interested in obtaining disk images, 22contact us at m5-dev@eecs.umich.edu. 23 24GETTING STARTED 25--------------- 26 27The following steps will build and test the simulator. The variable 28"$top" refers to the top directory where you've unpacked the files, 29i.e., the one containing the m5, m5-test, and ext directories. 30 31cd $top/m5/setup 32./setup ALPHA # set up build/ALPHA directory 33cd $top/m5/build/ALPHA 34make m5.opt # use "-j N" if you've got an MP system 35# wait for build... 36cd $top/m5-test 37./do-tests.pl -B ALPHA # test what you just built 38# wait for tests to run... 39# should end with "finished do-tests successfully!" 40 41If you run into errors regarding m5/arch/alpha/decoder.cc, just 42"touch" that file to update its timestamp. This file is generated 43from a compact ISA description using a program written in Python. If 44you have Python 2.2.2 or later installed on your system, you should be 45able to generate it yourself, but if you don't have Python (or have an 46older version), you may run in to trouble. Since we've shipped a 47working copy of decoder.cc, it's not necessary to have Python to build 48M5 (unless you start modifying the ISA decription). Unfortunately, 49sometimes make gets confused and tries to do so anyway. The "touch" 50should convince make to stop trying. 51 52