X-Git-Url: https://git.libre-soc.org/?a=blobdiff_plain;f=README;h=5b0452bd3237df2aa2c3be8bdfac52ab7afa2fc7;hb=5a1ad990a64adccaa6116288771628103e47157c;hp=af105757736e2548271ef8a3a5f557b38d768a03;hpb=ac3b4149eacd994e62721dc9e6cc9f2f3c07c59b;p=gem5.git diff --git a/README b/README index af1057577..5b0452bd3 100644 --- a/README +++ b/README @@ -1,77 +1,41 @@ -This is release m5_1.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. - -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) - -GETTING STARTED ---------------- - -There are two different build targets and three optimizations levels: - -Target: -------- -ALPHA_SE - Syscall emulation simulation -ALPHA_FS - 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 - -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. - -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". - +This is the gem5 simulator. + +The main website can be found at http://www.gem5.org + +A good starting point is http://www.gem5.org/Introduction, and for +more information about building the simulator and getting started +please see http://www.gem5.org/Documentation and +http://www.gem5.org/Tutorials. + +To build gem5, you will need the following software: g++ or clang, +Python (gem5 links in the Python interpreter), SCons, SWIG, zlib, m4, +and lastly protobuf if you want trace capture and playback +support. Please see http://www.gem5.org/Dependencies for more details +concerning the minimum versions of the aforementioned tools. + +Once you have all dependencies resolved, type 'scons +build//gem5.opt' where ARCH is one of ALPHA, ARM, NULL, MIPS, +POWER, SPARC, or X86. This will build an optimized version of the gem5 +binary (gem5.opt) for the the specified architecture. See +http://www.gem5.org/Build_System for more details and options. + +With the simulator built, have a look at +http://www.gem5.org/Running_gem5 for more information on how to use +gem5. + +The basic source release includes these subdirectories: + - configs: example simulation configuration scripts + - ext: less-common external packages needed to build gem5 + - src: source code of the gem5 simulator + - system: source for some optional system software for simulated systems + - tests: regression tests + - util: useful utility programs and files + +To run full-system simulations, you will need compiled system firmware +(console and PALcode for Alpha), kernel binaries and one or more disk +images. Please see the gem5 download page for these items at +http://www.gem5.org/Download + +If you have questions, please send mail to gem5-users@gem5.org + +Enjoy using gem5 and please share your modifications and extensions.