System.py revision 11838:0b311345ac72 
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 SimObject
32from m5.params import *
33from m5.proxy import *
34
35from DVFSHandler import *
36from SimpleMemory import *
37
38class MemoryMode(Enum): vals = ['invalid', 'atomic', 'timing',
39                                'atomic_noncaching']
40
41class System(MemObject):
42    type = 'System'
43    cxx_header = "sim/system.hh"
44    system_port = MasterPort("System port")
45
46    @classmethod
47    def export_methods(cls, code):
48        code('''
49      Enums::MemoryMode getMemoryMode() const;
50      void setMemoryMode(Enums::MemoryMode mode);
51''')
52
53    memories = VectorParam.AbstractMemory(Self.all,
54                                          "All memories in the system")
55    mem_mode = Param.MemoryMode('atomic', "The mode the memory system is in")
56
57    thermal_model = Param.ThermalModel(NULL, "Thermal model")
58    thermal_components = VectorParam.SimObject([],
59            "A collection of all thermal components in the system.")
60
61    # When reserving memory on the host, we have the option of
62    # reserving swap space or not (by passing MAP_NORESERVE to
63    # mmap). By enabling this flag, we accommodate cases where a large
64    # (but sparse) memory is simulated.
65    mmap_using_noreserve = Param.Bool(False, "mmap the backing store " \
66                                          "without reserving swap")
67
68    # The memory ranges are to be populated when creating the system
69    # such that these can be passed from the I/O subsystem through an
70    # I/O bridge or cache
71    mem_ranges = VectorParam.AddrRange([], "Ranges that constitute main memory")
72
73    cache_line_size = Param.Unsigned(64, "Cache line size in bytes")
74
75    exit_on_work_items = Param.Bool(False, "Exit from the simulation loop when "
76                                    "encountering work item annotations.")
77    work_item_id = Param.Int(-1, "specific work item id")
78    num_work_ids = Param.Int(16, "Number of distinct work item types")
79    work_begin_cpu_id_exit = Param.Int(-1,
80        "work started on specific id, now exit simulation")
81    work_begin_ckpt_count = Param.Counter(0,
82        "create checkpoint when work items begin count value is reached")
83    work_begin_exit_count = Param.Counter(0,
84        "exit simulation when work items begin count value is reached")
85    work_end_ckpt_count = Param.Counter(0,
86        "create checkpoint when work items end count value is reached")
87    work_end_exit_count = Param.Counter(0,
88        "exit simulation when work items end count value is reached")
89    work_cpus_ckpt_count = Param.Counter(0,
90        "create checkpoint when active cpu count value is reached")
91
92    init_param = Param.UInt64(0, "numerical value to pass into simulator")
93    boot_osflags = Param.String("a", "boot flags to pass to the kernel")
94    kernel = Param.String("", "file that contains the kernel code")
95    kernel_addr_check = Param.Bool(True,
96        "whether to address check on kernel (disable for baremetal)")
97    readfile = Param.String("", "file to read startup script from")
98    symbolfile = Param.String("", "file to get the symbols from")
99    load_addr_mask = Param.UInt64(0xffffffffff,
100            "Address to mask loading binaries with")
101    load_offset = Param.UInt64(0, "Address to offset loading binaries with")
102
103    multi_thread = Param.Bool(False,
104            "Supports multi-threaded CPUs? Impacts Thread/Context IDs")
105
106    # Dynamic voltage and frequency handler for the system, disabled by default
107    # Provide list of domains that need to be controlled by the handler
108    dvfs_handler = DVFSHandler()
109