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