README

   1 This is release m5_1.0 of the M5 simulator.
   2
   3 This file contains brief "getting started" information and release
   4 notes.  For more information, see http://m5.eecs.umich.edu.  If you
   5 have questions, please send mail to m5sim-users@lists.sourceforge.net.
   6
   7 WHAT'S INCLUDED (AND NOT)
   8 -------------------------
   9
  10 Since you're reading this file, presumably you've managed to untar the
  11 distribution.  The archive you've unpacked has three subdirectories:
  12  - m5: the simulator itself
  13  - m5-test: regression tests and scripts to run them
  14  - ext: less-common external packages needed to build m5
  15    (currently ply and libelf)
  16
  17 M5 is a capable, full-system simulator that current supports both Linux
  18 2.4/2.6 and the proprietary Compaq/HP Tru64 version of Unix. We are able
  19 to distribute Linux bootdisks, but we are unable to distribute bootable
  20 disk images of Tru64 Unix. If you have a Tru64 license and are interested
  21 in obtaining disk images, contact us at m5-dev@eecs.umich.edu.
  22
  23 WHAT'S NEEDED
  24 -------------
  25 -GCC(3.X)
  26 -Python(2.4+)
  27
  28 WHAT'S RECOMMENDED
  29 ------------------
  30 -MySQL (for statistics complex statistics storage/retrieval)
  31 -Python-MysqlDB (for statistics analysis)
  32
  33 GETTING STARTED
  34 ---------------
  35
  36 The following steps will build and test the simulator.  The variable
  37 "$top" refers to the top directory where you've unpacked the files,
  38 i.e., the one containing the m5, m5-test, and ext directories.
  39
  40 There are three different build targets and three optimizations in each level:
  41 Target:
  42 -------
  43 ALPHA_SE - Syscall emulation simulation
  44 ALPHA_FS - Linux full system simulation
  45 ALPHA_FS_TL - Tru64 (Turbolaser) Unix full system simulation
  46
  47 Optimization:
  48 -------------
  49 m5.debug - debug version of the code with tracing and without optimization
  50 m5.opt   - optimized version of code with tracing
  51 m5.fast  - optimized version of the code without tracing and asserts
  52
  53 cd $top/m5/build
  54 scons TARGET/OPTLEVL  # e.g. ALPHA_FS/m5.opt, use -j N if you have a MP system
  55 cd $top/m5-test
  56 ./do-tests.pl -B ALPHA_SE       # test what you just built
  57 ./do-tests.pl -B ALPHA_FS       # test what you just built
  58 # wait for tests to run...
  59 # should end with "finished do-tests successfully!"