Documentation

Getting Started

1. Introduction - A quick introduction to gem5.
2. Source Code - Information about the source code itself.
3. External Dependencies - Things you'll need that aren't part of gem5 itself.
4. Build System - How to run or modify gem5's build system.

Running M5

1. Running M5 - Usage, FS/SE mode simulation, Checkpointing, and FastForwarding
2. Getting a Cross Compiler - Need to build a binary and don't have a machine that runs that ISA? This page can help.
3. Regression Tests
4. SimObjects
5. Configuration Scripts
6. Simulation Scripts Explained
7. Summary gem5 Capabilities
8. m5ops -- Instructions to control the simulation

Development

1. Functional Testers
   1. directedtest
   2. memtest
   3. networktest
   4. rubytest
2. Debugging
3. Coding Style
4. Tools and Contributing
5. Source Code Documentation
6. Commit Access

Infrastructure

1. Events
2. Statistics
3. Utility Code
4. Pseudo Instructions
5. Serialization

Memory System

1. General Memory System
2. Classic Memory System
3. Ruby

Full System

1. Devices
   1. IDE Devices
   2. NIC Devices
   3. Timers
   4. UARTs and serial terminals
2. Disks and Disk Images
3. Interrupts

Syscall Emulation

1. SE Mode

CPUs and Execution

1. Execution Basics
2. Architectural State
3. Address Translation
4. CPU Models
   1. Simple CPU Model
   2. Out-of-Order CPU Model
   3. In Order CPU Model
   4. Adding a New CPU Model

ISA Implementations

1. Multiple ISA Support
2. ISA Parser
3. Alpha Implementation
4. ARM Implementation
5. MIPS Implementation
6. Power Implementation
7. SPARC Implementation
8. X86 Implementation
9. Defining ISAs