how to create code changes, upload your changes, have your changes
reviewed, and finally push your changes to gem5. More information can be found
from the following sources:
- * http://gem5.org/Submitting_Contributions
+ * http://gem5.org/contributing
* https://gerrit-review.googlesource.com/Documentation/index.html
* https://git-scm.com/book
the patch can be merged. The patch will receive a +1 if gem5 builds and
runs, and it will receive a +2 if the stats match.
* Style-Check: This is automatically generated and tests the patch against the
- gem5 code style (http://www.gem5.org/Coding_Style). The patch must receive a
- +1 from the style checker to be pushed.
+ gem5 code style
+ (http://www.gem5.org/documentation/general_docs/development/coding_style/).
+ The patch must receive a +1 from the style checker to be pushed.
Note: Whenever the patch creator updates the patch all reviewers must re-review
the patch. There is no longer a "Fix it, then Ship It" option.
The main website can be found at http://www.gem5.org
-A good starting point is http://www.gem5.org/Introduction, and for
+A good starting point is http://www.gem5.org/about, and for
more information about building the simulator and getting started
-please see http://www.gem5.org/Documentation and
-http://www.gem5.org/Tutorials.
+please see http://www.gem5.org/documentation and
+http://www.gem5.org/documentation/learning_gem5/introduction.
To build gem5, you will need the following software: g++ or clang,
Python (gem5 links in the Python interpreter), SCons, SWIG, zlib, m4,
and lastly protobuf if you want trace capture and playback
-support. Please see http://www.gem5.org/Dependencies for more details
-concerning the minimum versions of the aforementioned tools.
+support. Please see http://www.gem5.org/documentation/general_docs/building
+for more details concerning the minimum versions of the aforementioned tools.
Once you have all dependencies resolved, type 'scons
build/<ARCH>/gem5.opt' where ARCH is one of ALPHA, ARM, NULL, MIPS,
POWER, SPARC, or X86. This will build an optimized version of the gem5
binary (gem5.opt) for the the specified architecture. See
-http://www.gem5.org/Build_System for more details and options.
-
-With the simulator built, have a look at
-http://www.gem5.org/Running_gem5 for more information on how to use
-gem5.
+http://www.gem5.org/documentation/general_docs/building for more details and
+options.
The basic source release includes these subdirectories:
- configs: example simulation configuration scripts
To run full-system simulations, you will need compiled system firmware
(console and PALcode for Alpha), kernel binaries and one or more disk
-images. Please see the gem5 download page for these items at
-http://www.gem5.org/Download
+images.
If you have questions, please send mail to gem5-users@gem5.org
"Learning gem5" is a work-in-progress book that is frequently updated. For the
most up-to-date version of the book, see the website.
-http://learning.gem5.org/book/
+http://gem5.org/documentation/learning_gem5/introduction
This directory is broken into one subdirectory per part of the book.
""" This file creates a set of Ruby caches, the Ruby network, and a simple
point-to-point topology.
-See Part 3 in the Learning gem5 book: learning.gem5.org/book/part3
+See Part 3 in the Learning gem5 book:
+http://gem5.org/documentation/learning_gem5/part3/MSIintro
IMPORTANT: If you modify this file, it's likely that the Learning gem5 book
also needs to be updated. For now, email Jason <jason@lowepower.com>
""" This file creates a set of Ruby caches, the Ruby network, and a simple
point-to-point topology.
-See Part 3 in the Learning gem5 book: learning.gem5.org/book/part3
+See Part 3 in the Learning gem5 book:
+http://gem5.org/Documentation/learning_gem5/part3/MSIintro
You can change simple_ruby to import from this file instead of from msi_caches
to use the MI_example protocol instead of MSI.
# Authors: Jason Lowe-Power
""" This file creates a system with Ruby caches and runs the ruby random tester
-See Part 3 in the Learning gem5 book: learning.gem5.org/book/part3
+See Part 3 in the Learning gem5 book:
+http://gem5.org/documentation/learning_gem5/part3/MSIintro
IMPORTANT: If you modify this file, it's likely that the Learning gem5 book
also needs to be updated. For now, email Jason <jason@lowepower.com>
simple multi-threaded application with false sharing to stress the Ruby
protocol.
-See Part 3 in the Learning gem5 book: learning.gem5.org/book/part3
+See Part 3 in the Learning gem5 book:
+http://gem5.org/documentation/learning_gem5/part3/MSIintro
IMPORTANT: If you modify this file, it's likely that the Learning gem5 book
also needs to be updated. For now, email Jason <jason@lowepower.com>
""" This file creates a set of Ruby caches, the Ruby network, and a simple
point-to-point topology for the RubyRandomTester to use.
-See Part 3 in the Learning gem5 book: learning.gem5.org/book/part3
+See Part 3 in the Learning gem5 book:
+http://gem5.org/documentation/learning_gem5/part3/MSIintro
IMPORTANT: If you modify this file, it's likely that the Learning gem5 book
also needs to be updated. For now, email Jason <jason@lowepower.com>
[sysc]: http://accellera.org/downloads/standards/systemc
-[gem5]: http://www.gem5.org/Main_Page
+[gem5]: http://www.gem5.org/
[doulos]: https://www.doulos.com/knowhow/systemc/tlm2/base_protocol_checker/
[strip]: https://github.com/tud-ccc/systemc-scons/commit/913a7451939dc4d4bd752df7081064f9f870517a
```
[sysc]: http://accellera.org/downloads/standards/systemc
-[gem5]: http://www.gem5.org/Main_Page
+[gem5]: http://www.gem5.org/
[doulos]: https://www.doulos.com/knowhow/systemc/tlm2/base_protocol_checker/
except SystemExit as e:
print("""
For more details, see:
- http://gem5.org/Dependencies
+ http://gem5.org/documentation/general_docs/building
""")
raise
You can use a non-default installation of the Python interpreter by
rearranging your PATH so that scons finds the non-default 'python' and
'python-config' first.
-
-For more details, see:
- http://gem5.org/wiki/index.php/Using_a_non-default_Python_installation
""")
raise
# This script converts gem5 output to ARM DS-5 Streamline .apc project file
# (Requires the gem5 runs to be run with ContextSwitchStatsDump enabled and
# some patches applied to target Linux kernel.)
-# Visit http://www.gem5.org/Streamline for more details.
#
# Usage:
# m5stats2streamline.py <stat_config.ini> <gem5 run folder> <dest .apc folder>
(NOTE: Requires gem5 runs to be run with ContextSwitchStatsDump
enabled and some patches applied to the target Linux kernel.)
- Visit http://www.gem5.org/Streamline for more details.
-
APC project generation based on Gator v17 (DS-5 v5.17)
Subsequent versions should be backward compatible
""")
Elastic traces can also be replayed into the SystemC world.
For more information on elastic traces please refer to:
- - http://www.gem5.org/TraceCPU
+ - http://www.gem5.org/documentation/general_docs/cpu_models/TraceCPU
- Exploring System Performance using Elastic Traces:
Fast, Accurate and Portable
" this vimrc file helps users follow the gem5 style guide see:
-" www.gem5.org/Coding_Style
+" www.gem5.org/documentation/general_docs/development/coding_style
" it highlights extraneaous whitespace and tabs (so you can easily remove
" them), sets column length to a max of 78 characters, expands tabs, and sets
" a tab width of 4 spaces.