summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorAli Saidi <saidi@eecs.umich.edu>2004-07-28 17:56:36 -0400
committerAli Saidi <saidi@eecs.umich.edu>2004-07-28 17:56:36 -0400
commitdf61a1d3ef548aab24f065f6086621a09b5eea0d (patch)
tree4d0d55d1f4c1e8057a36e9d39dd438fea07aa651 /README
parent2f973954ca9d55dd958571256b5b0d189d0eee5c (diff)
downloadgem5-df61a1d3ef548aab24f065f6086621a09b5eea0d.tar.xz
updated readme to reflect linux/scons changes
Put correct date in copyright headers based on bk changesets LICENSE: Updated copyright on license file README: Updaded readme to reflect shift to scons and linux support cpu/trace/reader/ibm_reader.cc: cpu/trace/reader/ibm_reader.hh: cpu/trace/reader/itx_reader.cc: cpu/trace/reader/itx_reader.hh: cpu/trace/reader/m5_reader.cc: cpu/trace/reader/m5_reader.hh: cpu/trace/reader/mem_trace_reader.cc: cpu/trace/reader/mem_trace_reader.hh: cpu/trace/trace_cpu.cc: cpu/trace/trace_cpu.hh: updated copyright (only changeset in 2004) kern/kernel_stats.cc: kern/kernel_stats.hh: updated copyright --HG-- extra : convert_revision : 726aed4b38ff4d230c63a570df83c63075b3c76f
Diffstat (limited to 'README')
-rw-r--r--README56
1 files changed, 32 insertions, 24 deletions
diff --git a/README b/README
index f5651ec00..fe5b99f23 100644
--- a/README
+++ b/README
@@ -1,4 +1,3 @@
-
This is release m5_1.0_beta1 of the M5 simulator.
This file contains brief "getting started" information and release
@@ -13,13 +12,23 @@ distribution. The archive you've unpacked has three subdirectories:
- m5: the simulator itself
- m5-test: regression tests and scripts to run them
- ext: less-common external packages needed to build m5
- (currently just "ply")
+ (currently ply and libelf)
+
+M5 is a capable, full-system simulator that current supports both Linux
+2.4/2.6 and the proprietary Compaq/HP Tru64 version of Unix. We are able
+to distribute Linux bootdisks, but we are unable to distribute bootable
+disk images of Tru64 Unix. If you have a Tru64 license and are interested
+in obtaining disk images, contact us at m5-dev@eecs.umich.edu.
+
+WHAT'S NEEDED
+-------------
+-GCC(3.X)
+-Python(2.2.2+)
-Although M5 is capable of full-system simulation, the only OS it
-currently supports is the proprietary Compaq/HP Tru64 version of Unix.
-We are thus unable to distribute bootable disk images freely. If you
-have a Tru64 license and are interested in obtaining disk images,
-contact us at m5-dev@eecs.umich.edu.
+WHAT'S RECOMMENDED
+------------------
+-MySQL (for statistics complex statistics storage/retrieval)
+-Python-MysqlDB (for statistics analysis)
GETTING STARTED
---------------
@@ -28,24 +37,23 @@ The following steps will build and test the simulator. The variable
"$top" refers to the top directory where you've unpacked the files,
i.e., the one containing the m5, m5-test, and ext directories.
-cd $top/m5/setup
-./setup ALPHA # set up build/ALPHA directory
-cd $top/m5/build/ALPHA
-make m5.opt # use "-j N" if you've got an MP system
-# wait for build...
+There are three different build targets and three optimizations in each level:
+Target:
+-------
+ALPHA - Syscall emulation simulation
+KERNEL - Linux full system simulation
+KERNEL_TLASER - Tru64 Unix full system simulation
+
+Optimization:
+-------------
+m5.debug - debug version of the code with tracing and without optimization
+m5.opt - optimized version of code with tracing
+m5.fast - optimized version of the code without tracing and asserts
+
+cd $top/m5/build
+scons TARGET/OPTLEVL # e.g. KERNEL/m5.opt, use -j N if you have a MP system
cd $top/m5-test
./do-tests.pl -B ALPHA # test what you just built
+./do-tests.pl -B KERNEL # test what you just built
# wait for tests to run...
# should end with "finished do-tests successfully!"
-
-If you run into errors regarding m5/arch/alpha/decoder.cc, just
-"touch" that file to update its timestamp. This file is generated
-from a compact ISA description using a program written in Python. If
-you have Python 2.2.2 or later installed on your system, you should be
-able to generate it yourself, but if you don't have Python (or have an
-older version), you may run in to trouble. Since we've shipped a
-working copy of decoder.cc, it's not necessary to have Python to build
-M5 (unless you start modifying the ISA decription). Unfortunately,
-sometimes make gets confused and tries to do so anyway. The "touch"
-should convince make to stop trying.
-