System.py revision 11988 
1# Copyright (c) 2005-2007 The Regents of The University of Michigan
2# Copyright (c) 2011 Regents of the University of California
3# All rights reserved.
4#
5# Redistribution and use in source and binary forms, with or without
6# modification, are permitted provided that the following conditions are
7# met: redistributions of source code must retain the above copyright
8# notice, this list of conditions and the following disclaimer;
9# redistributions in binary form must reproduce the above copyright
10# notice, this list of conditions and the following disclaimer in the
11# documentation and/or other materials provided with the distribution;
12# neither the name of the copyright holders nor the names of its
13# contributors may be used to endorse or promote products derived from
14# this software without specific prior written permission.
15#
16# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
17# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
18# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
19# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
20# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
21# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
22# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
26# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27#
28# Authors: Nathan Binkert
29#          Rick Strong
30
31from m5.SimObject import *
32from m5.defines import buildEnv
33from m5.params import *
34from m5.proxy import *
35
36from DVFSHandler import *
37from SimpleMemory import *
38
39class MemoryMode(Enum): vals = ['invalid', 'atomic', 'timing',
40                                'atomic_noncaching']
41
42class System(MemObject):
43    type = 'System'
44    cxx_header = "sim/system.hh"
45    system_port = MasterPort("System port")
46
47    cxx_exports = [
48        PyBindMethod("getMemoryMode"),
49        PyBindMethod("setMemoryMode"),
50    ]
51
52    memories = VectorParam.AbstractMemory(Self.all,
53                                          "All memories in the system")
54    mem_mode = Param.MemoryMode('atomic', "The mode the memory system is in")
55
56    thermal_model = Param.ThermalModel(NULL, "Thermal model")
57    thermal_components = VectorParam.SimObject([],
58            "A collection of all thermal components in the system.")
59
60    # When reserving memory on the host, we have the option of
61    # reserving swap space or not (by passing MAP_NORESERVE to
62    # mmap). By enabling this flag, we accommodate cases where a large
63    # (but sparse) memory is simulated.
64    mmap_using_noreserve = Param.Bool(False, "mmap the backing store " \
65                                          "without reserving swap")
66
67    # The memory ranges are to be populated when creating the system
68    # such that these can be passed from the I/O subsystem through an
69    # I/O bridge or cache
70    mem_ranges = VectorParam.AddrRange([], "Ranges that constitute main memory")
71
72    cache_line_size = Param.Unsigned(64, "Cache line size in bytes")
73
74    exit_on_work_items = Param.Bool(False, "Exit from the simulation loop when "
75                                    "encountering work item annotations.")
76    work_item_id = Param.Int(-1, "specific work item id")
77    num_work_ids = Param.Int(16, "Number of distinct work item types")
78    work_begin_cpu_id_exit = Param.Int(-1,
79        "work started on specific id, now exit simulation")
80    work_begin_ckpt_count = Param.Counter(0,
81        "create checkpoint when work items begin count value is reached")
82    work_begin_exit_count = Param.Counter(0,
83        "exit simulation when work items begin count value is reached")
84    work_end_ckpt_count = Param.Counter(0,
85        "create checkpoint when work items end count value is reached")
86    work_end_exit_count = Param.Counter(0,
87        "exit simulation when work items end count value is reached")
88    work_cpus_ckpt_count = Param.Counter(0,
89        "create checkpoint when active cpu count value is reached")
90
91    init_param = Param.UInt64(0, "numerical value to pass into simulator")
92    boot_osflags = Param.String("a", "boot flags to pass to the kernel")
93    kernel = Param.String("", "file that contains the kernel code")
94    kernel_addr_check = Param.Bool(True,
95        "whether to address check on kernel (disable for baremetal)")
96    readfile = Param.String("", "file to read startup script from")
97    symbolfile = Param.String("", "file to get the symbols from")
98    load_addr_mask = Param.UInt64(0xffffffffff,
99            "Address to mask loading binaries with")
100    load_offset = Param.UInt64(0, "Address to offset loading binaries with")
101
102    multi_thread = Param.Bool(False,
103            "Supports multi-threaded CPUs? Impacts Thread/Context IDs")
104
105    # Dynamic voltage and frequency handler for the system, disabled by default
106    # Provide list of domains that need to be controlled by the handler
107    dvfs_handler = DVFSHandler()
108
109    if buildEnv['USE_KVM']:
110        kvm_vm = Param.KvmVM(NULL, 'KVM VM (i.e., shared memory domain)')
111