configs/common/MemConfig.py

   1 # Copyright (c) 2013 ARM Limited
   2 # All rights reserved.
   3 #
   4 # The license below extends only to copyright in the software and shall
   5 # not be construed as granting a license to any other intellectual
   6 # property including but not limited to intellectual property relating
   7 # to a hardware implementation of the functionality of the software
   8 # licensed hereunder.  You may use the software subject to the license
   9 # terms below provided that you ensure that this notice is replicated
  10 # unmodified and in its entirety in all distributions of the software,
  11 # modified or unmodified, in source code or in binary form.
  12 #
  13 # Redistribution and use in source and binary forms, with or without
  14 # modification, are permitted provided that the following conditions are
  15 # met: redistributions of source code must retain the above copyright
  16 # notice, this list of conditions and the following disclaimer;
  17 # redistributions in binary form must reproduce the above copyright
  18 # notice, this list of conditions and the following disclaimer in the
  19 # documentation and/or other materials provided with the distribution;
  20 # neither the name of the copyright holders nor the names of its
  21 # contributors may be used to endorse or promote products derived from
  22 # this software without specific prior written permission.
  23 #
  24 # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  25 # "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  26 # LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  27 # A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  28 # OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  29 # SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  30 # LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  31 # DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  32 # THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  33 # (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  34 # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  35 #
  36 # Authors: Andreas Sandberg
  37 #          Andreas Hansson
  38
  39 import m5.objects
  40 import inspect
  41 import sys
  42 from textwrap import  TextWrapper
  43
  44 # Dictionary of mapping names of real memory controller models to
  45 # classes.
  46 _mem_classes = {}
  47
  48 # Memory aliases. We make sure they exist before we add them to the
  49 # fina; list. A target may be specified as a tuple, in which case the
  50 # first available memory controller model in the tuple will be used.
  51 _mem_aliases_all = [
  52     ("simple_mem", "SimpleMemory"),
  53     ("ddr3-1600", "SimpleDDR3"),
  54     ("lpddr2_s4-1066", "SimpleLPDDR2_S4"),
  55     ("wio-200", "SimpleWideIO"),
  56     ]
  57
  58 # Filtered list of aliases. Only aliases for existing memory
  59 # controllers exist in this list.
  60 _mem_aliases = {}
  61
  62
  63 def is_mem_class(cls):
  64     """Determine if a class is a memory controller that can be instantiated"""
  65
  66     # We can't use the normal inspect.isclass because the ParamFactory
  67     # and ProxyFactory classes have a tendency to confuse it.
  68     try:
  69         return issubclass(cls, m5.objects.AbstractMemory) and \
  70             not cls.abstract
  71     except TypeError:
  72         return False
  73
  74 def get(name):
  75     """Get a memory class from a user provided class name or alias."""
  76
  77     real_name = _mem_aliases.get(name, name)
  78
  79     try:
  80         mem_class = _mem_classes[real_name]
  81         return mem_class
  82     except KeyError:
  83         print "%s is not a valid memory controller." % (name,)
  84         sys.exit(1)
  85
  86 def print_mem_list():
  87     """Print a list of available memory classes including their aliases."""
  88
  89     print "Available memory classes:"
  90     doc_wrapper = TextWrapper(initial_indent="\t\t", subsequent_indent="\t\t")
  91     for name, cls in _mem_classes.items():
  92         print "\t%s" % name
  93
  94         # Try to extract the class documentation from the class help
  95         # string.
  96         doc = inspect.getdoc(cls)
  97         if doc:
  98             for line in doc_wrapper.wrap(doc):
  99                 print line
 100
 101     if _mem_aliases:
 102         print "\nMemory aliases:"
 103         for alias, target in _mem_aliases.items():
 104             print "\t%s => %s" % (alias, target)
 105
 106 def mem_names():
 107     """Return a list of valid memory names."""
 108     return _mem_classes.keys() + _mem_aliases.keys()
 109
 110 # Add all memory controllers in the object hierarchy.
 111 for name, cls in inspect.getmembers(m5.objects, is_mem_class):
 112     _mem_classes[name] = cls
 113
 114 for alias, target in _mem_aliases_all:
 115     if isinstance(target, tuple):
 116         # Some aliases contain a list of memory controller models
 117         # sorted in priority order. Use the first target that's
 118         # available.
 119         for t in target:
 120             if t in _mem_classes:
 121                 _mem_aliases[alias] = t
 122                 break
 123     elif target in _mem_classes:
 124         # Normal alias
 125         _mem_aliases[alias] = target