src/sim/Workload.py

   1 # Copyright 2019 Google Inc.
   2 #
   3 # Redistribution and use in source and binary forms, with or without
   4 # modification, are permitted provided that the following conditions are
   5 # met: redistributions of source code must retain the above copyright
   6 # notice, this list of conditions and the following disclaimer;
   7 # redistributions in binary form must reproduce the above copyright
   8 # notice, this list of conditions and the following disclaimer in the
   9 # documentation and/or other materials provided with the distribution;
  10 # neither the name of the copyright holders nor the names of its
  11 # contributors may be used to endorse or promote products derived from
  12 # this software without specific prior written permission.
  13 #
  14 # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  15 # "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  16 # LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  17 # A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  18 # OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  19 # SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  20 # LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  21 # DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  22 # THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  23 # (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  24 # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  25
  26 from m5.params import *
  27 from m5.SimObject import SimObject
  28
  29 from m5.objects.SimpleMemory import *
  30
  31 class Workload(SimObject):
  32     type = 'Workload'
  33     cxx_header = "sim/workload.hh"
  34     abstract = True
  35
  36 class KernelWorkload(Workload):
  37     type = 'KernelWorkload'
  38     cxx_header = "sim/kernel_workload.hh"
  39
  40     object_file = Param.String("", "File that contains the kernel code")
  41     extras = VectorParam.String([], "Additional object files to load")
  42     extras_addrs = VectorParam.Addr([],
  43             "Load addresses for additional object files")
  44
  45     addr_check = Param.Bool(True,
  46         "whether to bounds check kernel addresses (disable for baremetal)")
  47     load_addr_mask = Param.UInt64(0xffffffffffffffff,
  48             "Mask to apply to kernel addresses. If zero, "
  49             "auto-calculated to be the most restrictive.")
  50     load_addr_offset = Param.UInt64(0, "Address to offset the kernel with")
  51
  52     command_line = Param.String("a", "boot flags to pass to the kernel")
  53
  54 class SEWorkloadMeta(type(Workload)):
  55     all_se_workload_classes = []
  56     def __new__(mcls, name, bases, dct):
  57         cls = super(SEWorkloadMeta, mcls).__new__(mcls, name, bases, dct)
  58         SEWorkloadMeta.all_se_workload_classes.append(cls)
  59         return cls
  60
  61 class SEWorkload(Workload, metaclass=SEWorkloadMeta):
  62     type = 'SEWorkload'
  63     cxx_header = "sim/se_workload.hh"
  64     cxx_class = 'SEWorkload'
  65
  66     @classmethod
  67     def _is_compatible_with(cls, obj):
  68         return False
  69
  70     @classmethod
  71     def find_compatible(cls, path):
  72         '''List the SE workloads compatible with the binary at path'''
  73
  74         from _m5 import object_file
  75         obj = object_file.create(path)
  76         options = list(filter(lambda wld: wld._is_compatible_with(obj),
  77                               SEWorkloadMeta.all_se_workload_classes))
  78
  79         return options
  80
  81     @classmethod
  82     def init_compatible(cls, path, *args, **kwargs):
  83         '''Construct the only SE workload compatible with the binary at path'''
  84
  85         options = SEWorkload.find_compatible(path)
  86
  87         if len(options) > 1:
  88             raise ValueError("More than one SE workload is compatible with %s")
  89         elif len(options) < 1:
  90             # For now, fall back to the base class if there are no matches.
  91             # After we've had a chance to implement everything, this default
  92             # can be removed since this should always find exactly one match.
  93             return SEWorkload(*args, **kwargs)
  94             raise ValueError("No SE workload is compatible with %s", path)
  95
  96         return options[0](*args, **kwargs)