sanchayanmaity/gem5
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
gem5/README

76 lines
2.8 KiB
Text
Raw Normal View History

Minor tweaks for 1.1 release. README: Updated for release 1.1. Clarified several minor things (I hope). --HG-- extra : convert_revision : a088f670739d33765611ce413b96854a1b51bb0f
2005-08-19 06:10:45 +02:00
This is release m5_1.1 of the M5 simulator.
Add a README for the release. Ideally we would move this up a level (to the top-level release dir) before shipping it. --HG-- extra : convert_revision : 3013379ec6dc95217f35aeef9df2e4ac0a33b69f
2003-10-17 18:32:00 +02:00
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
Minor tweaks for 1.1 release. README: Updated for release 1.1. Clarified several minor things (I hope). --HG-- extra : convert_revision : a088f670739d33765611ce413b96854a1b51bb0f
2005-08-19 06:10:45 +02:00
- alpha-system: source for Alpha console and PALcode
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
2004-07-28 23:56:36 +02:00
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
-------------
Minor tweaks for 1.1 release. README: Updated for release 1.1. Clarified several minor things (I hope). --HG-- extra : convert_revision : a088f670739d33765611ce413b96854a1b51bb0f
2005-08-19 06:10:45 +02:00
- GCC (version 3.3 or 3.4 recommended)
- Python 2.3 or newer
- SCons 0.96.1 (see http://www.scons.org)
Add a README for the release. Ideally we would move this up a level (to the top-level release dir) before shipping it. --HG-- extra : convert_revision : 3013379ec6dc95217f35aeef9df2e4ac0a33b69f
2003-10-17 18:32:00 +02:00
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
2004-07-28 23:56:36 +02:00
WHAT'S RECOMMENDED
------------------
Minor tweaks for 1.1 release. README: Updated for release 1.1. Clarified several minor things (I hope). --HG-- extra : convert_revision : a088f670739d33765611ce413b96854a1b51bb0f
2005-08-19 06:10:45 +02:00
- MySQL (for statistics complex statistics storage/retrieval)
- Python-MysqlDB (for statistics analysis)
Add a README for the release. Ideally we would move this up a level (to the top-level release dir) before shipping it. --HG-- extra : convert_revision : 3013379ec6dc95217f35aeef9df2e4ac0a33b69f
2003-10-17 18:32:00 +02:00
GETTING STARTED
---------------
Minor tweaks for 1.1 release. README: Updated for release 1.1. Clarified several minor things (I hope). --HG-- extra : convert_revision : a088f670739d33765611ce413b96854a1b51bb0f
2005-08-19 06:10:45 +02:00
There are two different build targets and three optimizations levels:
Add a README for the release. Ideally we would move this up a level (to the top-level release dir) before shipping it. --HG-- extra : convert_revision : 3013379ec6dc95217f35aeef9df2e4ac0a33b69f
2003-10-17 18:32:00 +02:00
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
2004-07-28 23:56:36 +02:00
Target:
-------
Rename builds more descriptively: ALPHA -> ALPHA_SE (for Syscall Emulation) KERNEL -> ALPHA_FS KERN_TLASER -> ALPHA_FS_TL Also renamed configs/kernel dir to configs/fullsys. README: build/SConstruct: Rename builds more descriptively. --HG-- extra : convert_revision : f2bffb3ad0fc5068cc7fa20661ed9e4e7bc5b202
2005-06-02 22:15:43 +02:00
ALPHA_SE - Syscall emulation simulation
Minor tweaks for 1.1 release. README: Updated for release 1.1. Clarified several minor things (I hope). --HG-- extra : convert_revision : a088f670739d33765611ce413b96854a1b51bb0f
2005-08-19 06:10:45 +02:00
ALPHA_FS - Full system simulation
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
2004-07-28 23:56:36 +02:00
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
Minor tweaks for 1.1 release. README: Updated for release 1.1. Clarified several minor things (I hope). --HG-- extra : convert_revision : a088f670739d33765611ce413b96854a1b51bb0f
2005-08-19 06:10:45 +02:00
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:
Regression tests now run under scons! For example, 'scons ALPHA_SE/test/opt/quick' will build ALPHA_SE/m5.opt if necessary and run all the self-identified "quick" tests on it. Other possibilities: - Run just test1: scons ALPHA_SE/test/opt/test1 - Run all tests: scons ALPHA_SE/test/opt - Run all tests on debug build: scons ALPHA_SE/test/debug - Update test1 reference outputs in m5-test: scons update_ref=y ALPHA_SE/test/opt/test1 The proper tests will be selected based on the setting of FULL_SYSTEM, ALPHA_TLASER, etc. README: Update directions to use scons-based test invocation. SConscript: Return list of generated build environments to SConstruct so it can associate tests with each of them. Set 'M5Binary' attribute on each env to record name of generated binary to be tested. build/SConstruct: - Support invoking m5-test tests via scons. - Add new non-sticky option category, for 'update_ref'. - Move existing "sticky" option definitions out of build_dir loop. Someday we can generate help text from these. - Make 'CC' and 'CXX' sticky options; use environment vars as defaults if available. - Make config builder more scons-y. python/m5/__init__.py: Make AddToPath() correctly handle relative path arguments. Assumes that sys.path[0] has the directory where the current Python file lives; new m5execfile() function sets this up properly for exec'd files. --HG-- extra : convert_revision : 48896688592e210d8e63f96c34e57474853d0e66
2005-09-05 22:31:27 +02:00
cd $top/m5/build
scons ALPHA_SE/test/opt/quick
Minor tweaks for 1.1 release. README: Updated for release 1.1. Clarified several minor things (I hope). --HG-- extra : convert_revision : a088f670739d33765611ce413b96854a1b51bb0f
2005-08-19 06:10:45 +02:00
To build and test the full-system simualator:
Regression tests now run under scons! For example, 'scons ALPHA_SE/test/opt/quick' will build ALPHA_SE/m5.opt if necessary and run all the self-identified "quick" tests on it. Other possibilities: - Run just test1: scons ALPHA_SE/test/opt/test1 - Run all tests: scons ALPHA_SE/test/opt - Run all tests on debug build: scons ALPHA_SE/test/debug - Update test1 reference outputs in m5-test: scons update_ref=y ALPHA_SE/test/opt/test1 The proper tests will be selected based on the setting of FULL_SYSTEM, ALPHA_TLASER, etc. README: Update directions to use scons-based test invocation. SConscript: Return list of generated build environments to SConstruct so it can associate tests with each of them. Set 'M5Binary' attribute on each env to record name of generated binary to be tested. build/SConstruct: - Support invoking m5-test tests via scons. - Add new non-sticky option category, for 'update_ref'. - Move existing "sticky" option definitions out of build_dir loop. Someday we can generate help text from these. - Make 'CC' and 'CXX' sticky options; use environment vars as defaults if available. - Make config builder more scons-y. python/m5/__init__.py: Make AddToPath() correctly handle relative path arguments. Assumes that sys.path[0] has the directory where the current Python file lives; new m5execfile() function sets this up properly for exec'd files. --HG-- extra : convert_revision : 48896688592e210d8e63f96c34e57474853d0e66
2005-09-05 22:31:27 +02:00
1. Download the full-system binary package from
http://m5.eecs.umich.edu/dist/m5_system_1.1.tar.bz2. This package includes
Minor tweaks for 1.1 release. README: Updated for release 1.1. Clarified several minor things (I hope). --HG-- extra : convert_revision : a088f670739d33765611ce413b96854a1b51bb0f
2005-08-19 06:10:45 +02:00
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.
Regression tests now run under scons! For example, 'scons ALPHA_SE/test/opt/quick' will build ALPHA_SE/m5.opt if necessary and run all the self-identified "quick" tests on it. Other possibilities: - Run just test1: scons ALPHA_SE/test/opt/test1 - Run all tests: scons ALPHA_SE/test/opt - Run all tests on debug build: scons ALPHA_SE/test/debug - Update test1 reference outputs in m5-test: scons update_ref=y ALPHA_SE/test/opt/test1 The proper tests will be selected based on the setting of FULL_SYSTEM, ALPHA_TLASER, etc. README: Update directions to use scons-based test invocation. SConscript: Return list of generated build environments to SConstruct so it can associate tests with each of them. Set 'M5Binary' attribute on each env to record name of generated binary to be tested. build/SConstruct: - Support invoking m5-test tests via scons. - Add new non-sticky option category, for 'update_ref'. - Move existing "sticky" option definitions out of build_dir loop. Someday we can generate help text from these. - Make 'CC' and 'CXX' sticky options; use environment vars as defaults if available. - Make config builder more scons-y. python/m5/__init__.py: Make AddToPath() correctly handle relative path arguments. Assumes that sys.path[0] has the directory where the current Python file lives; new m5execfile() function sets this up properly for exec'd files. --HG-- extra : convert_revision : 48896688592e210d8e63f96c34e57474853d0e66
2005-09-05 22:31:27 +02:00
3. In $top/m5/build, run "scons ALPHA_FS/opt/test/quick".
Minor tweaks for 1.1 release. README: Updated for release 1.1. Clarified several minor things (I hope). --HG-- extra : convert_revision : a088f670739d33765611ce413b96854a1b51bb0f
2005-08-19 06:10:45 +02:00
Reference in a new issue Copy permalink