MemConfig.py revision 9709:fe54045c8670 
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
39import m5.objects
40import inspect
41import sys
42from 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    ("lpddr3-1600", "SimpleLPDDR3"),
56    ("wio-200", "SimpleWideIO"),
57    ]
58
59# Filtered list of aliases. Only aliases for existing memory
60# controllers exist in this list.
61_mem_aliases = {}
62
63
64def is_mem_class(cls):
65    """Determine if a class is a memory controller that can be instantiated"""
66
67    # We can't use the normal inspect.isclass because the ParamFactory
68    # and ProxyFactory classes have a tendency to confuse it.
69    try:
70        return issubclass(cls, m5.objects.AbstractMemory) and \
71            not cls.abstract
72    except TypeError:
73        return False
74
75def get(name):
76    """Get a memory class from a user provided class name or alias."""
77
78    real_name = _mem_aliases.get(name, name)
79
80    try:
81        mem_class = _mem_classes[real_name]
82        return mem_class
83    except KeyError:
84        print "%s is not a valid memory controller." % (name,)
85        sys.exit(1)
86
87def print_mem_list():
88    """Print a list of available memory classes including their aliases."""
89
90    print "Available memory classes:"
91    doc_wrapper = TextWrapper(initial_indent="\t\t", subsequent_indent="\t\t")
92    for name, cls in _mem_classes.items():
93        print "\t%s" % name
94
95        # Try to extract the class documentation from the class help
96        # string.
97        doc = inspect.getdoc(cls)
98        if doc:
99            for line in doc_wrapper.wrap(doc):
100                print line
101
102    if _mem_aliases:
103        print "\nMemory aliases:"
104        for alias, target in _mem_aliases.items():
105            print "\t%s => %s" % (alias, target)
106
107def mem_names():
108    """Return a list of valid memory names."""
109    return _mem_classes.keys() + _mem_aliases.keys()
110
111# Add all memory controllers in the object hierarchy.
112for name, cls in inspect.getmembers(m5.objects, is_mem_class):
113    _mem_classes[name] = cls
114
115for alias, target in _mem_aliases_all:
116    if isinstance(target, tuple):
117        # Some aliases contain a list of memory controller models
118        # sorted in priority order. Use the first target that's
119        # available.
120        for t in target:
121            if t in _mem_classes:
122                _mem_aliases[alias] = t
123                break
124    elif target in _mem_classes:
125        # Normal alias
126        _mem_aliases[alias] = target
127