README revision 131
19397Sandreas.hansson@arm.com
29397Sandreas.hansson@arm.comThis is release m5_1.0_beta1 of the M5 simulator.
39397Sandreas.hansson@arm.com
49397Sandreas.hansson@arm.comThis file contains brief "getting started" information and release
59397Sandreas.hansson@arm.comnotes.  For more information, see http://m5.eecs.umich.edu.  If you
69397Sandreas.hansson@arm.comhave questions, please send mail to m5sim-users@lists.sourceforge.net.
79397Sandreas.hansson@arm.com
89397Sandreas.hansson@arm.comWHAT'S INCLUDED (AND NOT)
99397Sandreas.hansson@arm.com-------------------------
109397Sandreas.hansson@arm.com
119397Sandreas.hansson@arm.comSince you're reading this file, presumably you've managed to untar the
129397Sandreas.hansson@arm.comdistribution.  The archive you've unpacked has three subdirectories:
139397Sandreas.hansson@arm.com - m5: the simulator itself
149397Sandreas.hansson@arm.com - m5-test: regression tests and scripts to run them
159397Sandreas.hansson@arm.com - ext: less-common external packages needed to build m5
169397Sandreas.hansson@arm.com   (currently just "ply")
179397Sandreas.hansson@arm.com
189397Sandreas.hansson@arm.comAlthough M5 is capable of full-system simulation, the only OS it
199397Sandreas.hansson@arm.comcurrently supports is the proprietary Compaq/HP Tru64 version of Unix.
209397Sandreas.hansson@arm.comWe are thus unable to distribute bootable disk images freely.  If you
219397Sandreas.hansson@arm.comhave a Tru64 license and are interested in obtaining disk images,
229397Sandreas.hansson@arm.comcontact us at m5-dev@eecs.umich.edu.
239397Sandreas.hansson@arm.com
249397Sandreas.hansson@arm.comGETTING STARTED
259397Sandreas.hansson@arm.com---------------
269397Sandreas.hansson@arm.com
279397Sandreas.hansson@arm.comThe following steps will build and test the simulator.  The variable
289397Sandreas.hansson@arm.com"$top" refers to the top directory where you've unpacked the files,
299397Sandreas.hansson@arm.comi.e., the one containing the m5, m5-test, and ext directories.
309397Sandreas.hansson@arm.com
319397Sandreas.hansson@arm.comcd $top/m5/setup
329397Sandreas.hansson@arm.com./setup ALPHA		# set up build/ALPHA directory
339397Sandreas.hansson@arm.comcd $top/m5/build/ALPHA
349397Sandreas.hansson@arm.commake m5.opt		# use "-j N" if you've got an MP system
359397Sandreas.hansson@arm.com# wait for build...
369397Sandreas.hansson@arm.comcd $top/m5-test
379397Sandreas.hansson@arm.com./do-tests.pl -B ALPHA	# test what you just built
389397Sandreas.hansson@arm.com# wait for tests to run...
399397Sandreas.hansson@arm.com# should end with "finished do-tests successfully!"
409397Sandreas.hansson@arm.com
419397Sandreas.hansson@arm.comIf you run into errors regarding m5/arch/alpha/decoder.cc, just
429397Sandreas.hansson@arm.com"touch" that file to update its timestamp.  This file is generated
439397Sandreas.hansson@arm.comfrom a compact ISA description using a program written in Python.  If
449397Sandreas.hansson@arm.comyou have Python 2.2.2 or later installed on your system, you should be
459397Sandreas.hansson@arm.comable to generate it yourself, but if you don't have Python (or have an
469397Sandreas.hansson@arm.comolder version), you may run in to trouble.  Since we've shipped a
479397Sandreas.hansson@arm.comworking copy of decoder.cc, it's not necessary to have Python to build
489397Sandreas.hansson@arm.comM5 (unless you start modifying the ISA decription).  Unfortunately,
499397Sandreas.hansson@arm.comsometimes make gets confused and tries to do so anyway.  The "touch"
509397Sandreas.hansson@arm.comshould convince make to stop trying.
519397Sandreas.hansson@arm.com
529397Sandreas.hansson@arm.com