blob: 2a0a53ff7d6479029ebdee7e1e780fbf94c1209e [file] [log] [blame]
title: Documentation
docs:
- title: gem5 documentation
items:
- title: gem5 documentation
id: gem5_documentation
url: /documentation
- title: Development
id: development
subitems:
- page: Code Style
url: /documentation/general_docs/development/coding_style/
- page: Release Procedures
url: /documentation/general_docs/development/release_procedures/
- title: Building
id: building
subitems:
- page: Building
url: /documentation/general_docs/building
- page: Building EXTRAS
url: /documentation/general_docs/building/EXTRAS
- title: Doxygen
id: doxygen-docs
subitems:
- page: Develop Branch
url: http://doxygen.gem5.org/develop/index.html
- page: v19.0.0.0
url: http://doxygen.gem5.org/release/v19-0-0-0/index.html
- page: v20.0.0.0
url: http://doxygen.gem5.org/release/v20-0-0-0/index.html
- page: v20.0.0.2
url: http://doxygen.gem5.org/release/v20-0-0-2/index.html
- page: v20.0.0.3
url: http://doxygen.gem5.org/release/v20-0-0-3/index.html
- page: v20.1.0.0
url: http://doxygen.gem5.org/release/v20-1-0-0/index.html
- page: v20.1.0.1
url: http://doxygen.gem5.org/release/v20-1-0-1/index.html
- page: v20.1.0.5
url: http://doxygen.gem5.org/release/v20-1-0-5/index.html
- page: v21.0.0.0
url: http://doxygen.gem5.org/release/v21-0-0-0/index.html
- page: v21.0.1.0
url: http://doxygen.gem5.org/release/v21-0-1-0/index.html
- page: v21.1.0.0
url: http://doxygen.gem5.org/release/v21-1-0-0/index.html
- page: v21.1.0.1
url: http://doxygen.gem5.org/release/v21-1-0-1/index.html
- page: v21.1.0.2
url: http://doxygen.gem5.org/release/v21-1-0-2/index.html
- page: v21.2.0.0
url: http://doxygen.gem5.org/release/v21-2-0-0/index.html
- page: v21.2.1.0
url: http://doxygen.gem5.org/release/v21-2-1-0/index.html
- page: v21.2.1.1
url: http://doxygen.gem5.org/release/v21-2-1-1/index.html
- page: v22.0.0.0
url: http://doxygen.gem5.org/release/v22-0-0-0/index.html
- page: v22.0.0.1
url: http://doxygen.gem5.org/release/v22-0-0-1/index.html
- page: v22.1.0.0
url: http://doxygen.gem5.org/release/v22-1-0-0/index.html
- title: gem5 standard library
id: gem5-standard-library
subitems:
- page: Standard Library Overview
url: /documentation/gem5-stdlib/overview
- page: Hello World Tutorial
url: /documentation/gem5-stdlib/hello-world-tutorial
- page: X86 Full-System Tutorial
url: /documentation/gem5-stdlib/x86-full-system-tutorial
- page: Developing Your Own Components Tutorial
url: /documentation/gem5-stdlib/develop-own-components-tutorial
- page: How To Create Your Own Board Using The gem5 Standard Library
url: /documentation/gem5-stdlib/develop-stdlib-board
- title: gem5 Resources
id: gem5_resources
url: /documentation/general_docs/gem5_resources
- title: gem5 APIs
id: gem5-apis
url: /documentation/general_docs/gem5-apis
- title: Full System
id: fullsystem
subitems:
- page: Creating Disk Images
url: /documentation/general_docs/fullsystem/disks
- page: Devices
url: /documentation/general_docs/fullsystem/devices
- page: m5term
url: /documentation/general_docs/fullsystem/m5term
- page: Building Linux ARM Kernel
url: /documentation/general_docs/fullsystem/building_arm_kernel
- page: Building Android Marshmallow
url: /documentation/general_docs/fullsystem/building_android_m
- page: Guest binaries
url: /documentation/general_docs/fullsystem/guest_binaries
- title: Memory System
id: memory_system
subitems:
- page: Memory System
url: /documentation/general_docs/memory_system/
- page: gem5 Memory System
url: /documentation/general_docs/memory_system/gem5_memory_system
- page: Replacement Policies
url: /documentation/general_docs/memory_system/replacement_policies
- page: Indexing Policies
url: /documentation/general_docs/memory_system/indexing_policies
- page: Classic memory system coherence
url: /documentation/general_docs/memory_system/classic-coherence-protocol
- page: Classic caches
url: /documentation/general_docs/memory_system/classic_caches
- title: Ruby Memory System
id: ruby
subitems:
- page: Ruby
url: /documentation/general_docs/ruby
- page: Cache Coherence Protocols
url: /documentation/general_docs/ruby/cache-coherence-protocols
- page: Garnet 2.0
url: /documentation/general_docs/ruby/garnet-2
- page: HeteroGarnet
url: /documentation/general_docs/ruby/heterogarnet
- page: MOESI CMP directory
url: /documentation/general_docs/ruby/MOESI_CMP_directory
- page: Garnet Synthetic Traffic
url: /documentation/general_docs/ruby/garnet_synthetic_traffic
- page: SLICC
url: /documentation/general_docs/ruby/slicc
- page: MI example
url: /documentation/general_docs/ruby/MI_example
- page: Garnet standalone
url: /documentation/general_docs/ruby/Garnet_standalone
- page: Interconnection network
url: /documentation/general_docs/ruby/interconnection-network
- page: MOESI hammer
url: /documentation/general_docs/ruby/MOESI_hammer
- page: MOESI CMP token
url: /documentation/general_docs/ruby/MOESI_CMP_token
- page: MESI two level
url: /documentation/general_docs/ruby/MESI_Two_Level
- page: CHI
url: /documentation/general_docs/ruby/CHI
- page: Replacement Policies
url: /documentation/general_docs/memory_system/replacement_policies
- title: CPU Models
id: cpu_models
url: /documentation/general_docs/cpu_models/
subitems:
- page: SimpleCPU
url: /documentation/general_docs/cpu_models/SimpleCPU
- page: O3CPU
url: /documentation/general_docs/cpu_models/O3CPU
- page: TraceCPU
url: /documentation/general_docs/cpu_models/TraceCPU
- page: Minor CPU Model
url: /documentation/general_docs/cpu_models/minor_cpu
- page: Execution Basics
url: /documentation/general_docs/cpu_models/execution_basics
- page: Visualization
url: /documentation/general_docs/cpu_models/visualization
- title: GPU Models
id: gpu_models
subitems:
- page: GCN3
url: /documentation/general_docs/gpu_models/GCN3
- title: M5ops
id: m5ops
url: /documentation/general_docs/m5ops
- title: Checkpoints
id: checkpoints
url: /documentation/general_docs/checkpoints
- title: Directed Testers
id: directed_testers
subitems:
- page: Garnet Synthetic Traffic
url: /documentation/general_docs/debugging_and_testing/directed_testers/garnet_synthetic_traffic
- page: Ruby Random Tester
url: /documentation/general_docs/debugging_and_testing/directed_testers/ruby_random_tester
- title: Debugging
id: debugging
subitems:
- page: Trace-based Debugging
url: /documentation/general_docs/debugging_and_testing/debugging/trace_based_debugging
- page: Debugger-based Debugging
url: /documentation/general_docs/debugging_and_testing/debugging/debugger_based_debugging
- page: Debugging Simulated Code
url: /documentation/general_docs/debugging_and_testing/debugging/debugging_simulated_code
- page: Reporting Problems
url: /documentation/reporting_problems
- title: Architecture Support
id: architecture_support
subitems:
- page: Architecture Support
url: /documentation/general_docs/architecture_support/
- page: ARM Implementation
url: /documentation/general_docs/architecture_support/arm_implementation/
- page: ISA Parser
url: /documentation/general_docs/architecture_support/isa_parser/
- page: X86 microop ISA
url: /documentation/general_docs/architecture_support/x86_microop_isa/
- title: Power and Thermal Model
url: /documentation/general_docs/thermal_model
- title: Compiling Workloads
id: compiling_workloads
url: /documentation/general_docs/compiling_workloads/
- title: Stats Package
id: statistics
url: /documentation/general_docs/statistics/
- title: Stats API
id: statistics-api
url: /documentation/general_docs/statistics/api
- title: Learning gem5
items:
- title: Introduction
id: introduction
url: /documentation/learning_gem5/introduction
- title: Getting Started
id: part1
subitems:
- page: Building gem5
url: /documentation/learning_gem5/part1/building
- page: Creating a simple configuration script
url: /documentation/learning_gem5/part1/simple_config
- page: Adding cache to configuration script
url: /documentation/learning_gem5/part1/cache_config
- page: Understanding gem5 statistics and output
url: /documentation/learning_gem5/part1/gem5_stats
- page: Using the default configuration scripts
url: /documentation/learning_gem5/part1/example_configs
- page: Extending gem5 for ARM
url: /documentation/learning_gem5/part1/extending_configs
- title: Modifying/Extending
id: part2
subitems:
- page: Setting up your development environment
url: /documentation/learning_gem5/part2/environment
- page: Creating a very simple SimObject
url: /documentation/learning_gem5/part2/helloobject
- page: Debugging gem5
url: /documentation/learning_gem5/part2/debugging
- page: Event-driven programming
url: /documentation/learning_gem5/part2/events
- page: Adding parameters to SimObjects and more events
url: /documentation/learning_gem5/part2/parameters
- page: Creating SimObjects in the memory system
url: /documentation/learning_gem5/part2/memoryobject
- page: Creating a simple cache object
url: /documentation/learning_gem5/part2/simplecache
- page: ARM Power Modelling
url: /documentation/learning_gem5/part2/arm_power_modelling
- page: ARM DVFS Support
url: /documentation/learning_gem5/part2/arm_dvfs_support
- title: Modeling Cache Coherence with Ruby
id: part3
subitems:
- page: Introduction to Ruby
url: /documentation/learning_gem5/part3/MSIintro
- page: MSI example cache protocol
url: /documentation/learning_gem5/part3/cache-intro
- page: Declaring a state machine
url: /documentation/learning_gem5/part3/cache-declarations
- page: In port code blocks
url: /documentation/learning_gem5/part3/cache-in-ports
- page: Action code blocks
url: /documentation/learning_gem5/part3/cache-actions
- page: Transition code blocks
url: /documentation/learning_gem5/part3/cache-transitions
- page: MSI Directory implementation
url: /documentation/learning_gem5/part3/directory
- page: Compiling a SLICC protocol
url: /documentation/learning_gem5/part3/MSIbuilding
- page: Configuring a simple Ruby system
url: /documentation/learning_gem5/part3/configuration
- page: Running the simple Ruby system
url: /documentation/learning_gem5/part3/running
- page: Debugging SLICC Protocols
url: /documentation/learning_gem5/part3/MSIdebugging
- page: Configuring for a standard protocol
url: /documentation/learning_gem5/part3/simple-MI_example
- title: gem5 101
id: gem5_101
subitems:
- page: gem5 101
url: /documentation/learning_gem5/gem5_101
- page: Homework 1
url: /documentation/learning_gem5/gem5_101/homework-1
- page: Homework 2
url: /documentation/learning_gem5/gem5_101/homework-2
- page: Homework 3
url: /documentation/learning_gem5/gem5_101/homework-3
- page: Homework 4
url: /documentation/learning_gem5/gem5_101/homework-4
- page: Homework 5
url: /documentation/learning_gem5/gem5_101/homework-5
- page: Homework 6
url: /documentation/learning_gem5/gem5_101/homework-6
- title: gem5 Doxygen
items:
- title: gem5 Doxygen
id: doxygen
url: http://doxygen.gem5.org/release/current/index.html
- title: gem5art
items:
- title: Introduction
id: introduction
url: /documentation/gem5art/introduction
- title: Details
id: main
subitems:
- page: Summary
url: /documentation/gem5art/main/summary
- page: Artifacts
url: /documentation/gem5art/main/artifacts
- page: Runs
url: /documentation/gem5art/main/run
- page: Tasks
url: /documentation/gem5art/main/tasks
- page: Disk Images
url: /documentation/gem5art/main/disks
- page: FAQ
url: /documentation/gem5art/main/faq
- title: Tutorials
id: tutorial
subitems:
- page: Boot Tutorial
url: /documentation/gem5art/tutorials/boot-tutorial
- page: NPB Tutorial
url: /documentation/gem5art/tutorials/npb-tutorial
- page: PARSEC Tutorial
url: /documentation/gem5art/tutorials/parsec-tutorial
- page: SPEC Tutorial
url: /documentation/gem5art/tutorials/spec-tutorial
- page: Microbench Tutorial
url: /documentation/gem5art/tutorials/microbench-tutorial
- title: Reporting Problems
items:
- title: Reporting Problems
id: reporting_problems
url: /documentation/reporting_problems