changeset 2d537040a4b9 in /z/repo/gem5
details: http://repo.gem5.org/gem5?cmd=changeset;node=2d537040a4b9
description:
config: Add configs scripts used in Learning gem5
Added a new directory in configs (learning_gem5) to hold the scripts
that are
used in the book. See http://lowepower.com/jason/learning_gem5/ for a
working
copy. For now, only the scripts in Part 1: Getting started with gem5
have been added. A separate patch adds tests for these scripts.
Committed by: Nilay Vaish <[email protected]>
diffstat:
configs/common/SimpleOpts.py | 73 ++++++++++++++
configs/learning_gem5/README | 29 +++++
configs/learning_gem5/part1/caches.py | 127 ++++++++++++++++++++++++++
configs/learning_gem5/part1/simple.py | 107 +++++++++++++++++++++
configs/learning_gem5/part1/two_level.py | 151 +++++++++++++++++++++++++++++++
5 files changed, 487 insertions(+), 0 deletions(-)
diffs (truncated from 507 to 300 lines):
diff -r 38f6188421e0 -r 2d537040a4b9 configs/common/SimpleOpts.py
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/configs/common/SimpleOpts.py Wed Sep 16 09:35:36 2015 -0500
@@ -0,0 +1,73 @@
+# -*- coding: utf-8 -*-
+# Copyright (c) 2015 Jason Power
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are
+# met: redistributions of source code must retain the above copyright
+# notice, this list of conditions and the following disclaimer;
+# redistributions in binary form must reproduce the above copyright
+# notice, this list of conditions and the following disclaimer in the
+# documentation and/or other materials provided with the distribution;
+# neither the name of the copyright holders nor the names of its
+# contributors may be used to endorse or promote products derived from
+# this software without specific prior written permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+#
+# Authors: Jason Power
+
+""" Options wrapper for simple gem5 configuration scripts
+
+This module wraps the optparse class so that we can register options
+from each class instead of only from the configuration script.
+
+"""
+
+# Module-level variable to track if we've called the parse_args function yet
+called_parse_args = False
+
+# For fatal
+import m5
+
+# import the options parser
+from optparse import OptionParser
+
+# add the options we want to be able to control from the command line
+parser = OptionParser()
+
+def add_option(*args, **kwargs):
+ """Call "add_option" to the global options parser
+ """
+
+ if (parser.has_option(args[0]) or
+ (len(args) > 1 and parser.has_option(args[1])) ):
+ m5.fatal("Duplicate option: %s" % str(args))
+
+ if called_parse_args:
+ m5.fatal("Can't add an option after calling SimpleOpts.parse_args")
+
+ parser.add_option(*args, **kwargs)
+
+def parse_args():
+ global called_parse_args
+ called_parse_args = True
+
+ return parser.parse_args()
+
+def set_usage(*args, **kwargs):
+ parser.set_usage(*args, **kwargs)
+
+def print_help(*args, **kwargs):
+ parser.print_help(*args, **kwargs)
+
diff -r 38f6188421e0 -r 2d537040a4b9 configs/learning_gem5/README
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/configs/learning_gem5/README Wed Sep 16 09:35:36 2015 -0500
@@ -0,0 +1,29 @@
+
+Learning_gem README
+-------------------
+This directory contains the configuration scripts used in the "Learning gem5"
+book. The scripts contained in these directories are for educational purposes
+only and should not be used for architectural research as-is.
+
+"Learning gem5" is currently in early development stages. A pre-alpha working
+version of the book can be found at the following URL.
+
+http://lowepower.com/jason/learning_gem5/
+
+This directory is broken into one subdirectory per part of the book.
+
+Goals of these scripts
+~~~~~~~~~~~~~~~~~~~~~~
+These scripts are not necessarily useful outside the scope of the learning
+gem5 book. The goal is to include the learning gem5 scripts, following the
+book as closely as possible, so that the regression tester will catch any
+changes that affect the book.
+
+For general users, these are *not* good scripts to use for running complex
+architectural experiments. These scripts *are* a good starting point example
+of how to write your own scripts for experiments.
+
+Feedback
+~~~~~~~~
+Send mail to [email protected] to provide feedback.
+
diff -r 38f6188421e0 -r 2d537040a4b9 configs/learning_gem5/part1/caches.py
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/configs/learning_gem5/part1/caches.py Wed Sep 16 09:35:36 2015 -0500
@@ -0,0 +1,127 @@
+# -*- coding: utf-8 -*-
+# Copyright (c) 2015 Jason Power
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are
+# met: redistributions of source code must retain the above copyright
+# notice, this list of conditions and the following disclaimer;
+# redistributions in binary form must reproduce the above copyright
+# notice, this list of conditions and the following disclaimer in the
+# documentation and/or other materials provided with the distribution;
+# neither the name of the copyright holders nor the names of its
+# contributors may be used to endorse or promote products derived from
+# this software without specific prior written permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+#
+# Authors: Jason Power
+
+""" Caches with options for a simple gem5 configuration script
+
+This file contains L1 I/D and L2 caches to be used in the simple
+gem5 configuration script. It uses the SimpleOpts wrapper to set up command
+line options from each individual class.
+"""
+
+from m5.objects import Cache
+
+import SimpleOpts
+
+# Some specific options for caches
+# For all options see src/mem/cache/BaseCache.py
+
+class L1Cache(Cache):
+ """Simple L1 Cache with default values"""
+
+ assoc = 2
+ hit_latency = 2
+ response_latency = 2
+ mshrs = 4
+ tgts_per_mshr = 20
+
+ def __init__(self, options=None):
+ super(L1Cache, self).__init__()
+ pass
+
+ def connectBus(self, bus):
+ """Connect this cache to a memory-side bus"""
+ self.mem_side = bus.slave
+
+ def connectCPU(self, cpu):
+ """Connect this cache's port to a CPU-side port
+ This must be defined in a subclass"""
+ raise NotImplementedError
+
+class L1ICache(L1Cache):
+ """Simple L1 instruction cache with default values"""
+
+ # Set the default size
+ size = '16kB'
+
+ SimpleOpts.add_option('--l1i_size',
+ help="L1 instruction cache size. Default: %s" % size)
+
+ def __init__(self, opts=None):
+ super(L1ICache, self).__init__(opts)
+ if not opts or not opts.l1i_size:
+ return
+ self.size = opts.l1i_size
+
+ def connectCPU(self, cpu):
+ """Connect this cache's port to a CPU icache port"""
+ self.cpu_side = cpu.icache_port
+
+class L1DCache(L1Cache):
+ """Simple L1 data cache with default values"""
+
+ # Set the default size
+ size = '64kB'
+
+ SimpleOpts.add_option('--l1d_size',
+ help="L1 data cache size. Default: %s" % size)
+
+ def __init__(self, opts=None):
+ super(L1DCache, self).__init__(opts)
+ if not opts or not opts.l1d_size:
+ return
+ self.size = opts.l1d_size
+
+ def connectCPU(self, cpu):
+ """Connect this cache's port to a CPU dcache port"""
+ self.cpu_side = cpu.dcache_port
+
+class L2Cache(Cache):
+ """Simple L2 Cache with default values"""
+
+ # Default parameters
+ size = '256kB'
+ assoc = 8
+ hit_latency = 20
+ response_latency = 20
+ mshrs = 20
+ tgts_per_mshr = 12
+
+ SimpleOpts.add_option('--l2_size', help="L2 cache size. Default: %s" %
size)
+
+ def __init__(self, opts=None):
+ super(L2Cache, self).__init__()
+ if not opts or not opts.l2_size:
+ return
+ self.size = opts.l2_size
+
+ def connectCPUSideBus(self, bus):
+ self.cpu_side = bus.master
+
+ def connectMemSideBus(self, bus):
+ self.mem_side = bus.slave
diff -r 38f6188421e0 -r 2d537040a4b9 configs/learning_gem5/part1/simple.py
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/configs/learning_gem5/part1/simple.py Wed Sep 16 09:35:36 2015 -0500
@@ -0,0 +1,107 @@
+# -*- coding: utf-8 -*-
+# Copyright (c) 2015 Jason Power
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are
+# met: redistributions of source code must retain the above copyright
+# notice, this list of conditions and the following disclaimer;
+# redistributions in binary form must reproduce the above copyright
+# notice, this list of conditions and the following disclaimer in the
+# documentation and/or other materials provided with the distribution;
+# neither the name of the copyright holders nor the names of its
+# contributors may be used to endorse or promote products derived from
+# this software without specific prior written permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+#
+# Authors: Jason Power
+
+""" This file creates a barebones system and executes 'hello', a simple Hello
+World application.
+See Part 1, Chapter 2: Creating a simple configuration script in the
+learning_gem5 book for more information about this script.
+
+IMPORTANT: If you modify this file, it's likely that the Learning gem5 book
+ also needs to be updated. For now, email Jason <[email protected]>
+
+"""
+
+# import the m5 (gem5) library created when gem5 is built
+import m5
+# import all of the SimObjects
+from m5.objects import *
+
+# create the system we are going to simulate
+system = System()
+
+# Set the clock fequency of the system (and all of its children)
+system.clk_domain = SrcClockDomain()
+system.clk_domain.clock = '1GHz'
+system.clk_domain.voltage_domain = VoltageDomain()
+
+# Set up the system
+system.mem_mode = 'timing' # Use timing accesses
+system.mem_ranges = [AddrRange('512MB')] # Create an address range
_______________________________________________
gem5-dev mailing list
[email protected]
http://m5sim.org/mailman/listinfo/gem5-dev