Difference between revisions of "OldDocumentation"
From gem5
(Added a place to put externally generated reference documentation) |
|||
| (47 intermediate revisions by 7 users not shown) | |||
| Line 1: | Line 1: | ||
| − | This documentation | + | This page is an archive of old M5 documentation predating the GEMS merger and subsequent gem5 renaming. See the [[Documentation]] page for the current documentation. |
| + | |||
| + | Complementary information from our tutorials, including about three hours of video from our last tutorial, is available [[tutorials|here]]. The tutorials provide basic information about using M5 and are time well spent for anyone new to the simulator. | ||
==Starting Out== | ==Starting Out== | ||
| Line 6: | Line 8: | ||
* [[Compiling M5]] - How to compile the simulator | * [[Compiling M5]] - How to compile the simulator | ||
* [[Running M5]] - How to run the simulator | * [[Running M5]] - How to run the simulator | ||
| − | * [[Debugging | + | * [[Debugging]] - Debugging tips and strategies |
| + | * [[Reporting Problems]] - What to do before you report a problem | ||
| + | * [[Adding Functionality]] - How to extend M5 (and update to new versions with almost no work) | ||
==Starting out in Full System== | ==Starting out in Full System== | ||
| Line 12: | Line 16: | ||
* [[Running M5 in Full-System Mode]] - How to run in full-system mode | * [[Running M5 in Full-System Mode]] - How to run in full-system mode | ||
* [[m5term]] - How to use the m5term | * [[m5term]] - How to use the m5term | ||
| + | * [[m5ops]] - Pseudo instructions and a command line interface to them | ||
* [[Using linux-dist to Create Disk Images and Kernels for M5]] - How to create a Linux disk image/kernel | * [[Using linux-dist to Create Disk Images and Kernels for M5]] - How to create a Linux disk image/kernel | ||
| Line 22: | Line 27: | ||
* [[ISA description system]] - The new ISA description primer | * [[ISA description system]] - The new ISA description primer | ||
* [[CPU Models]] - Overview of the various CPU models in M5 | * [[CPU Models]] - Overview of the various CPU models in M5 | ||
| + | * [[Sampling]] - Overview of how to use sampling. | ||
* [[I/O Base Classes]] - Information about the I/O device base classes | * [[I/O Base Classes]] - Information about the I/O device base classes | ||
| + | * [[SimObject Initialization]] - Information about the phases of SimObject creation and initialization, including unserializing | ||
| + | * [[Events]] -- Information about the Event and EventWrapper | ||
| − | == | + | ==Extending M5== |
| − | + | * [[Regression Tests]] - How to Run & Create your own regression tests in M5 | |
* [[Coding Style]] | * [[Coding Style]] | ||
* [[Documentation Guidelines]] | * [[Documentation Guidelines]] | ||
| + | * ''Adding New Features to M5:'' | ||
| + | ** Defining CPU Models - Steps toward defining your own CPU model in M5 | ||
| + | *** [[Defining_CPU_Models_stable_tree_v6230| m5 stable, changeset 6230:240a5a39e56f]] | ||
| + | *** [[Defining_CPU_Models_beta_4 | m5 2.0, beta 4]] | ||
| + | *** [[Defining_CPU_Models_(as_of_M5_2.0_-_beta_3) | m5 2.0, beta 3]] | ||
| + | ** [[Defining ISAs]] - Steps toward defining a new ISA for M5 ''(updated for M5 2.0 beta 3)'' | ||
| + | ==ISAs== | ||
| + | * [[X86]] | ||
| + | ==External Documentation== | ||
This documentation, gathered from outside sources, could be useful as reference when working with M5. | This documentation, gathered from outside sources, could be useful as reference when working with M5. | ||
| + | * [http://en.wikipedia.org/wiki/DEC_Alpha Alpha] | ||
| + | * [[SPARC]] | ||
| + | * [http://www.mips.com/products/resource-library/product-materials/mips-architecture/ MIPS] | ||
| − | == | + | ==Frequently Asked Questions== |
| − | + | [[Frequently Asked Questions]] - Frequently Asked Questions and Answers | |
| − | |||
| − | |||
| − | |||
| − | |||
__NOTOC__ | __NOTOC__ | ||
Latest revision as of 19:38, 4 April 2012
This page is an archive of old M5 documentation predating the GEMS merger and subsequent gem5 renaming. See the Documentation page for the current documentation.
Complementary information from our tutorials, including about three hours of video from our last tutorial, is available here. The tutorials provide basic information about using M5 and are time well spent for anyone new to the simulator.
Starting Out
- Source Tree - Brief tour of the source tree
- Compiling M5 - How to compile the simulator
- Running M5 - How to run the simulator
- Debugging - Debugging tips and strategies
- Reporting Problems - What to do before you report a problem
- Adding Functionality - How to extend M5 (and update to new versions with almost no work)
Starting out in Full System
- Running M5 in Full-System Mode - How to run in full-system mode
- m5term - How to use the m5term
- m5ops - Pseudo instructions and a command line interface to them
- Using linux-dist to Create Disk Images and Kernels for M5 - How to create a Linux disk image/kernel
Simulator Internals
- Doxygen -- Doxygen documentation
- Memory System - Overview of M5's new memory system
- Simulation Scripts Explained - Overview of simulation scripts
- Using the Statistics Package - Using the statistics package
- ISA description system - The new ISA description primer
- CPU Models - Overview of the various CPU models in M5
- Sampling - Overview of how to use sampling.
- I/O Base Classes - Information about the I/O device base classes
- SimObject Initialization - Information about the phases of SimObject creation and initialization, including unserializing
- Events -- Information about the Event and EventWrapper
Extending M5
- Regression Tests - How to Run & Create your own regression tests in M5
- Coding Style
- Documentation Guidelines
- Adding New Features to M5:
- Defining CPU Models - Steps toward defining your own CPU model in M5
- Defining ISAs - Steps toward defining a new ISA for M5 (updated for M5 2.0 beta 3)
ISAs
External Documentation
This documentation, gathered from outside sources, could be useful as reference when working with M5.
Frequently Asked Questions
Frequently Asked Questions - Frequently Asked Questions and Answers
