src/sim/System.py

   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
  31 from m5.SimObject import SimObject
  32 from m5.defines import buildEnv
  33 from m5.params import *
  34 from m5.proxy import *
  35
  36 from DVFSHandler import *
  37 from SimpleMemory import *
  38
  39 class MemoryMode(Enum): vals = ['invalid', 'atomic', 'timing',
  40                                 'atomic_noncaching']
  41
  42 class System(MemObject):
  43     type = 'System'
  44     cxx_header = "sim/system.hh"
  45     system_port = MasterPort("System port")
  46
  47     @classmethod
  48     def export_method_cxx_predecls(cls, code):
  49         code('#include "sim/system.hh"')
  50
  51     @classmethod
  52     def export_methods(cls, code):
  53         code('''
  54       Enums::MemoryMode getMemoryMode() const;
  55       void setMemoryMode(Enums::MemoryMode mode);
  56 ''')
  57
  58     memories = VectorParam.AbstractMemory(Self.all,
  59                                           "All memories in the system")
  60     mem_mode = Param.MemoryMode('atomic', "The mode the memory system is in")
  61
  62     # The memory ranges are to be populated when creating the system
  63     # such that these can be passed from the I/O subsystem through an
  64     # I/O bridge or cache
  65     mem_ranges = VectorParam.AddrRange([], "Ranges that constitute main memory")
  66
  67     cache_line_size = Param.Unsigned(64, "Cache line size in bytes")
  68
  69     work_item_id = Param.Int(-1, "specific work item id")
  70     num_work_ids = Param.Int(16, "Number of distinct work item types")
  71     work_begin_cpu_id_exit = Param.Int(-1,
  72         "work started on specific id, now exit simulation")
  73     work_begin_ckpt_count = Param.Counter(0,
  74         "create checkpoint when work items begin count value is reached")
  75     work_begin_exit_count = Param.Counter(0,
  76         "exit simulation when work items begin count value is reached")
  77     work_end_ckpt_count = Param.Counter(0,
  78         "create checkpoint when work items end count value is reached")
  79     work_end_exit_count = Param.Counter(0,
  80         "exit simulation when work items end count value is reached")
  81     work_cpus_ckpt_count = Param.Counter(0,
  82         "create checkpoint when active cpu count value is reached")
  83
  84     init_param = Param.UInt64(0, "numerical value to pass into simulator")
  85     boot_osflags = Param.String("a", "boot flags to pass to the kernel")
  86     kernel = Param.String("", "file that contains the kernel code")
  87     readfile = Param.String("", "file to read startup script from")
  88     symbolfile = Param.String("", "file to get the symbols from")
  89     load_addr_mask = Param.UInt64(0xffffffffff,
  90             "Address to mask loading binaries with")
  91     load_offset = Param.UInt64(0, "Address to offset loading binaries with")
  92
  93     # Dynamic voltage and frequency handler for the system, disabled by default
  94     # Provide list of domains that need to be controlled by the handler
  95     dvfs_handler = DVFSHandler()