X-Git-Url: https://git.libre-soc.org/?a=blobdiff_plain;f=README;h=0f61a0416ed114ddf78e0f5f14b5609680d16a0e;hb=601822c6b507f6c3145eacf8f9db216522f70733;hp=af105757736e2548271ef8a3a5f557b38d768a03;hpb=ac3b4149eacd994e62721dc9e6cc9f2f3c07c59b;p=gem5.git diff --git a/README b/README index af1057577..0f61a0416 100644 --- a/README +++ b/README @@ -1,77 +1,43 @@ -This is release m5_1.1 of the M5 simulator. +This is release 2.0_beta (patch 1) of the M5 simulator. -This file contains brief "getting started" information and release -notes. For more information, see http://m5.eecs.umich.edu. If you -have questions, please send mail to m5sim-users@lists.sourceforge.net. +For detailed information about building the simulator and getting +started please refer to http://www.m5sim.org. -WHAT'S INCLUDED (AND NOT) -------------------------- - -Since you're reading this file, presumably you've managed to untar the -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 - - alpha-system: source for Alpha console and PALcode - -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 version 3.3 or newer -- Python 2.3 or newer -- SCons 0.96.1 or newer (see http://www.scons.org) - -WHAT'S RECOMMENDED ------------------- -- MySQL (for statistics complex statistics storage/retrieval) -- Python-MysqlDB (for statistics analysis) +Specific pages of interest are: +http://www.m5sim.org/wiki/index.php/Compiling_M5 +http://www.m5sim.org/wiki/index.php/Running_M5 -GETTING STARTED ---------------- +Short version: -There are two different build targets and three optimizations levels: +1. If you don't have SCons version 0.96.91 or newer, get it from +http://wwww.scons.org. -Target: -------- -ALPHA_SE - Syscall emulation simulation -ALPHA_FS - Full system simulation +2. If you don't have SWIG version 1.3.28 or newer, get it from +http://wwww.swig.org. -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 +3. In this directory, type 'scons build/ALPHA_SE/tests/debug/quick'. This +will build the debug version of the m5 binary (m5.debug) for the Alpha +syscall emulation target, and run the quick regression tests on it. -Different targets are built in different subdirectories of m5/build. -Binaries with the same target but different optimization levels share -the same directory. Note that you can build m5 in any directory you -choose by copying the SConstruct file there and creating symbolic links -to the 'm5' and 'ext' directories. +If you have questions, please send mail to m5-users@m5sim.org -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. If you -have a multiprocessor system, you should give scons a "-j N" argument (like -make) to run N jobs in parallel. - -To build and test the syscall-emulation simulator: - - cd $top/m5/build - scons ALPHA_SE/test/opt/quick - -To build and test the full-system simualator: - -1. Unpack the full-system binaries from m5_system_1.1.tar.bz2. This file - is included on the CD release, or you can download it from - http://m5.eecs.umich.edu/dist/ m5_system_1.1.tar.bz2.) This package - includes disk images and kernel, palcode, and console binaries - for Linux and FreeBSD. -2. Edit SYSTEMDIR in $top/m5-test/SysPaths.py to point to your local copy - of the binaries. -3. In $top/m5/build, run "scons ALPHA_FS/opt/test/quick". +WHAT'S INCLUDED (AND NOT) +------------------------- +The basic source release includes these subdirectories: + - m5: + - src: source code of the m5 simulator + - tests: regression tests + - ext: less-common external packages needed to build m5 + - system/alpha: source for Alpha console and PALcode + +To run full-system simulations, you will need compiled console, +PALcode, and kernel binaries and one or more disk images. These files +are collected in a separate archive, m5_system.tar.bz2. This file +can he downloaded separately. + +M5 supports Linux 2.4/2.6, FreeBSD, and the proprietary Compaq/HP +Tru64 version of Unix. We are able to distribute Linux and FreeBSD +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.