Skip to content

Commit

Permalink
Updated my name, copyright, and whitespace
Browse files Browse the repository at this point in the history
  • Loading branch information
powerjg committed Dec 16, 2016
1 parent 2326aa2 commit f1cf885
Show file tree
Hide file tree
Showing 12 changed files with 38 additions and 54 deletions.
2 changes: 1 addition & 1 deletion acknowledgements.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
:authors: Jason Power
:authors: Jason Lowe-Power


.. _acknowledgements-chapter:
Expand Down
8 changes: 4 additions & 4 deletions conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@

# General information about the project.
project = u'gem5 Tutorial'
copyright = u'2015, Jason Power'
copyright = u'2016, Jason Lowe-Power'

# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
Expand Down Expand Up @@ -224,7 +224,7 @@
# author, documentclass [howto, manual, or own class]).
latex_documents = [
('index', 'gem5Tutorial.tex', u'gem5 Tutorial Documentation',
u'Jason Power', 'manual'),
u'Jason Lowe-Power', 'manual'),
]

# The name of an image file (relative to this directory) to place at the top of
Expand Down Expand Up @@ -254,7 +254,7 @@
# (source start file, name, description, authors, manual section).
man_pages = [
('index', 'gem5tutorial', u'gem5 Tutorial Documentation',
[u'Jason Power'], 1)
[u'Jason Lowe-Power'], 1)
]

# If true, show URL addresses after external links.
Expand All @@ -268,7 +268,7 @@
# dir menu entry, description, category)
texinfo_documents = [
('index', 'gem5Tutorial', u'gem5 Tutorial Documentation',
u'Jason Power', 'gem5Tutorial', 'One line description of project.',
u'Jason Lowe-Power', 'gem5Tutorial', 'One line description of project.',
'Miscellaneous'),
]

Expand Down
2 changes: 1 addition & 1 deletion part1/building.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@

:authors: Jason Power
:authors: Jason Lowe-Power

.. _building-chapter:

Expand Down
20 changes: 4 additions & 16 deletions part1/cache_config.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@


:authors: Jason Power
:authors: Jason Lowe-Power

.. _cache-config-chapter:

Expand Down Expand Up @@ -271,7 +271,7 @@ And connect the caches to the CPU ports with the helper function we created.
Also, You need to *remove* the previous lines which connected the cache ports directly to the memory bus.

.. code-block:: python
-system.cpu.icache_port = system.membus.slave
-system.cpu.dcache_port = system.membus.slave
Expand Down Expand Up @@ -388,12 +388,12 @@ With these changes, you can now pass the cache sizes into your script from the c

gem5 Simulator System. http://gem5.org
gem5 is copyrighted software; use the --copyright option for details.

gem5 compiled Sep 6 2015 14:17:02
gem5 started Sep 6 2015 15:06:51
gem5 executing on galapagos-09.cs.wisc.edu
command line: build/X86/gem5.opt ../tutorial/_static/scripts/part1/two_level_opts.py --l2_size=1MB --l1d_size=128kB

Global frequency set at 1000000000000 ticks per second
warn: DRAM device capacity (8192 Mbytes) does not match the address range assigned (512 Mbytes)
0: system.remote_gdb.listener: listening for remote gdb #0 on port 7000
Expand All @@ -403,15 +403,3 @@ With these changes, you can now pass the cache sizes into your script from the c
Exiting @ tick 56742000 because target called exit()

The updated configuration script can be downloaded :download:`here <../_static/scripts/part1/two_level_opts.py>` and the updated cache file can be downloaded :download:`here <../_static/scripts/part1/caches_opts.py>`.












26 changes: 13 additions & 13 deletions part1/example_configs.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
:authors: Jason Power
:authors: Jason Lowe-Power

.. _gem5-provided-configs-chapter:

Expand Down Expand Up @@ -30,7 +30,7 @@ The directory structure is shown below:
...

configs/common:
Benchmarks.py cpu2000.py Options.py
Benchmarks.py cpu2000.py Options.py
Caches.py FSConfig.py O3_ARM_v7a.py SysPaths.py
CacheConfig.py CpuConfig.py MemConfig.py Simulation.py

Expand Down Expand Up @@ -115,7 +115,7 @@ To see all of the options, run the configuration script with ``--help``, or read
First, let's simply run the hello world program without any parameters:

.. code-block:: sh
build/X86_MESI_Two_Level/gem5.opt configs/example/se.py --cmd=tests/test-progs/hello/bin/x86/linux/hello
And we get the following as output:
Expand Down Expand Up @@ -159,10 +159,10 @@ To actually run gem5 in timing mode, let's specify a CPU type.
While we're at it, we can also specify sizes for the L1 caches.

.. code-block:: sh
build/X86_MESI_Two_Level/gem5.opt configs/example/se.py --cmd=tests/test-progs/hello/bin/x86/linux/hello --cpu-type=TimingSimpleCPU --l1d_size=64kB --l1i_size=16kB
::
::

gem5 Simulator System. http://gem5.org
gem5 is copyrighted software; use the --copyright option for details.
Expand All @@ -185,7 +185,7 @@ Even though we specified the size of the caches, we didn't specify that the syst
The correct command line should be:

.. code-block:: sh
build/X86_MESI_Two_Level/gem5.opt configs/example/se.py --cmd=tests/test-progs/hello/bin/x86/linux/hello --cpu-type=TimingSimpleCPU --l1d_size=64kB --l1i_size=16kB --caches
::
Expand Down Expand Up @@ -243,13 +243,13 @@ Some common options ``se.py`` and ``fs.py``
All of the possible options are printed when you run:

.. code-block:: sh
build/X86_MESI_Two_Level/gem5.opt configs/example/se.py --help
Below is a few important options from that list.

.. option:: --cpu-type=CPU_TYPE

The type of cpu to run with.
This is an important parameter to always set.
The default is atomic, which doesn't perform a timing simulation.
Expand All @@ -273,11 +273,11 @@ Below is a few important options from that list.
Perform the simulation with classic caches.

.. option:: --l2cache

Perform the simulation with an L2 cache, if using classic caches.

.. option:: --ruby

Use Ruby instead of the classic caches as the cache system simulation.

.. option:: -m TICKS, --abs-max-tick=TICKS
Expand All @@ -291,7 +291,7 @@ Below is a few important options from that list.
This is useful if you want to stop simulation after a certain number of instructions has been executed.

.. option:: -c CMD, --cmd=CMD

The binary to run in syscall emulation mode.

.. option:: -o OPTIONS, --options=OPTIONS
Expand All @@ -301,12 +301,12 @@ Below is a few important options from that list.
You can pass both arguments and options (e.g., --whatever) through this variable.

.. option:: --output=OUTPUT

Redirect stdout to a file.
This is useful if you want to redirect the output of the simulated application to a file instead of printing to the screen.
Note: to redirect gem5 output, you have to pass a parameter *before* the configuration script.

.. option:: --errout=ERROUT

Redirect stderr to a file.
Similar to above.
Similar to above.
10 changes: 4 additions & 6 deletions part1/gem5_stats.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
:authors: Jason Power
:authors: Jason Lowe-Power

.. _gem5-stats-chapter:

Expand Down Expand Up @@ -104,7 +104,7 @@ At the end of simulation, or when special statistic-dumping commands are issued,
First, the statistics file contains general statistics about the execution:

::

---------- Begin Simulation Statistics ----------
sim_seconds 0.000346 # Number of seconds simulated
sim_ticks 345518000 # Number of ticks simulated
Expand Down Expand Up @@ -132,7 +132,7 @@ For instance, the memory controller statistics.
This has information like the bytes read by each component and the average bandwidth used by those components.

::

system.mem_ctrl.bytes_read::cpu.inst 58264 # Number of bytes read from this memory
system.mem_ctrl.bytes_read::cpu.data 7167 # Number of bytes read from this memory
system.mem_ctrl.bytes_read::total 65431 # Number of bytes read from this memory
Expand All @@ -159,7 +159,7 @@ This has information like the bytes read by each component and the average bandw
Later in the file is the CPU statistics, which contains information on the number of syscalls, the number of branches, total committed instructions, etc.

::

system.cpu.apic_clk_domain.clock 16000 # Clock period in ticks
system.cpu.workload.num_syscalls 11 # Number of system calls
system.cpu.numCycles 345518 # number of cpu cycles simulated
Expand Down Expand Up @@ -187,5 +187,3 @@ Later in the file is the CPU statistics, which contains information on the numbe
system.cpu.not_idle_fraction 1.000000 # Percentage of non-idle cycles
system.cpu.idle_fraction 0.000000 # Percentage of idle cycles
system.cpu.Branches 1306 # Number of branches fetched


4 changes: 2 additions & 2 deletions part1/index.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
:authors: Jason Power
:authors: Jason Lowe-Power

=================================
Part I: Getting started with gem5
Expand All @@ -10,4 +10,4 @@ Part I: Getting started with gem5
simple_config
cache_config
gem5_stats
example_configs
example_configs
2 changes: 1 addition & 1 deletion part1/simple_config.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@

:authors: Jason Power
:authors: Jason Lowe-Power

.. _simple-config-chapter:

Expand Down
4 changes: 2 additions & 2 deletions part2/debugging.rst
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@

:authors: Jason Power
:authors: Jason Lowe-Power

.. _debugging-chapter:

------------------------------------------
Debugging gem5
------------------------------------------
------------------------------------------
4 changes: 1 addition & 3 deletions part2/environment.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@


:authors: Jason Power
:authors: Jason Lowe-Power

.. _development-environment-chapter:

Expand Down Expand Up @@ -46,5 +46,3 @@ The `Mercurial book`_ has a great chapter_ describing the details of how to use
.. _Mercuial book: http://hgbook.red-bean.com/

.. _chapter: http://hgbook.red-bean.com/read/managing-change-with-mercurial-queues.html


4 changes: 2 additions & 2 deletions part2/index.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
:authors: Jason Power
:authors: Jason Lowe-Power

=====================================
Part II: Modifying and extending gem5
Expand All @@ -9,4 +9,4 @@ Part II: Modifying and extending gem5
environment
helloobject
simobject-old
debugging
debugging
6 changes: 3 additions & 3 deletions part2/simobject-old.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@

:authors: Jason Power
:authors: Jason Lowe-Power

.. _simple-simobject-chapter:

Expand Down Expand Up @@ -93,7 +93,7 @@ Below is the contents of ``nmru.hh``.

Again, for the implementation we can use similar code to LRU and Random replacement policies.
The basic implementation is that we track the most recently used block by moving the last accessed block to the head of the MRU queue.
On a replacement, we select a random block that is not the most recently used block.
On a replacement, we select a random block that is not the most recently used block.
Below is the implementation in ``nrmu.cc``:

.. todo::
Expand Down Expand Up @@ -262,4 +262,4 @@ If you're using the simple config scripts created in previous chapters, you can
tags = NMRU()
The changeset to add all of the NMRU code can be found :download:`here <../_static/patches/nmru-tags>`.
You can apply this patch by using ``hg qimport``.
You can apply this patch by using ``hg qimport``.

0 comments on commit f1cf885

Please sign in to comment.