params.py revision 7534
13101Sstever@eecs.umich.edu# Copyright (c) 2004-2006 The Regents of The University of Michigan 27534Ssteve.reinhardt@amd.com# Copyright (c) 2010 Advanced Micro Devices, Inc. 33101Sstever@eecs.umich.edu# All rights reserved. 43101Sstever@eecs.umich.edu# 53101Sstever@eecs.umich.edu# Redistribution and use in source and binary forms, with or without 63101Sstever@eecs.umich.edu# modification, are permitted provided that the following conditions are 73101Sstever@eecs.umich.edu# met: redistributions of source code must retain the above copyright 83101Sstever@eecs.umich.edu# notice, this list of conditions and the following disclaimer; 93101Sstever@eecs.umich.edu# redistributions in binary form must reproduce the above copyright 103101Sstever@eecs.umich.edu# notice, this list of conditions and the following disclaimer in the 113101Sstever@eecs.umich.edu# documentation and/or other materials provided with the distribution; 123101Sstever@eecs.umich.edu# neither the name of the copyright holders nor the names of its 133101Sstever@eecs.umich.edu# contributors may be used to endorse or promote products derived from 143101Sstever@eecs.umich.edu# this software without specific prior written permission. 153101Sstever@eecs.umich.edu# 163101Sstever@eecs.umich.edu# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 173101Sstever@eecs.umich.edu# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 183101Sstever@eecs.umich.edu# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 193101Sstever@eecs.umich.edu# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 203101Sstever@eecs.umich.edu# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 213101Sstever@eecs.umich.edu# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 223101Sstever@eecs.umich.edu# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 233101Sstever@eecs.umich.edu# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 243101Sstever@eecs.umich.edu# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 253101Sstever@eecs.umich.edu# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 263101Sstever@eecs.umich.edu# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 273101Sstever@eecs.umich.edu# 283101Sstever@eecs.umich.edu# Authors: Steve Reinhardt 293101Sstever@eecs.umich.edu# Nathan Binkert 303101Sstever@eecs.umich.edu 313101Sstever@eecs.umich.edu##################################################################### 323101Sstever@eecs.umich.edu# 333101Sstever@eecs.umich.edu# Parameter description classes 343101Sstever@eecs.umich.edu# 353101Sstever@eecs.umich.edu# The _params dictionary in each class maps parameter names to either 363101Sstever@eecs.umich.edu# a Param or a VectorParam object. These objects contain the 373101Sstever@eecs.umich.edu# parameter description string, the parameter type, and the default 383101Sstever@eecs.umich.edu# value (if any). The convert() method on these objects is used to 393101Sstever@eecs.umich.edu# force whatever value is assigned to the parameter to the appropriate 403101Sstever@eecs.umich.edu# type. 413101Sstever@eecs.umich.edu# 423101Sstever@eecs.umich.edu# Note that the default values are loaded into the class's attribute 433101Sstever@eecs.umich.edu# space when the parameter dictionary is initialized (in 443101Sstever@eecs.umich.edu# MetaSimObject._new_param()); after that point they aren't used. 453101Sstever@eecs.umich.edu# 463101Sstever@eecs.umich.edu##################################################################### 473101Sstever@eecs.umich.edu 483885Sbinkertn@umich.eduimport copy 493885Sbinkertn@umich.eduimport datetime 504762Snate@binkert.orgimport re 513885Sbinkertn@umich.eduimport sys 523885Sbinkertn@umich.eduimport time 537528Ssteve.reinhardt@amd.comimport math 543885Sbinkertn@umich.edu 554380Sbinkertn@umich.eduimport proxy 564167Sbinkertn@umich.eduimport ticks 573102Sstever@eecs.umich.edufrom util import * 583101Sstever@eecs.umich.edu 594762Snate@binkert.orgdef isSimObject(*args, **kwargs): 604762Snate@binkert.org return SimObject.isSimObject(*args, **kwargs) 614762Snate@binkert.org 624762Snate@binkert.orgdef isSimObjectSequence(*args, **kwargs): 634762Snate@binkert.org return SimObject.isSimObjectSequence(*args, **kwargs) 644762Snate@binkert.org 654762Snate@binkert.orgdef isSimObjectClass(*args, **kwargs): 664762Snate@binkert.org return SimObject.isSimObjectClass(*args, **kwargs) 674762Snate@binkert.org 685033Smilesck@eecs.umich.eduallParams = {} 695033Smilesck@eecs.umich.edu 705033Smilesck@eecs.umich.educlass MetaParamValue(type): 715033Smilesck@eecs.umich.edu def __new__(mcls, name, bases, dct): 725033Smilesck@eecs.umich.edu cls = super(MetaParamValue, mcls).__new__(mcls, name, bases, dct) 735033Smilesck@eecs.umich.edu assert name not in allParams 745033Smilesck@eecs.umich.edu allParams[name] = cls 755033Smilesck@eecs.umich.edu return cls 765033Smilesck@eecs.umich.edu 775033Smilesck@eecs.umich.edu 783101Sstever@eecs.umich.edu# Dummy base class to identify types that are legitimate for SimObject 793101Sstever@eecs.umich.edu# parameters. 803101Sstever@eecs.umich.educlass ParamValue(object): 815033Smilesck@eecs.umich.edu __metaclass__ = MetaParamValue 823101Sstever@eecs.umich.edu 833101Sstever@eecs.umich.edu cxx_predecls = [] 843101Sstever@eecs.umich.edu swig_predecls = [] 853101Sstever@eecs.umich.edu 863101Sstever@eecs.umich.edu # default for printing to .ini file is regular string conversion. 873101Sstever@eecs.umich.edu # will be overridden in some cases 883101Sstever@eecs.umich.edu def ini_str(self): 893101Sstever@eecs.umich.edu return str(self) 903101Sstever@eecs.umich.edu 913101Sstever@eecs.umich.edu # allows us to blithely call unproxy() on things without checking 923101Sstever@eecs.umich.edu # if they're really proxies or not 933101Sstever@eecs.umich.edu def unproxy(self, base): 943101Sstever@eecs.umich.edu return self 953101Sstever@eecs.umich.edu 963101Sstever@eecs.umich.edu# Regular parameter description. 973101Sstever@eecs.umich.educlass ParamDesc(object): 986656Snate@binkert.org file_ext = 'ptype' 996656Snate@binkert.org 1003101Sstever@eecs.umich.edu def __init__(self, ptype_str, ptype, *args, **kwargs): 1013101Sstever@eecs.umich.edu self.ptype_str = ptype_str 1023101Sstever@eecs.umich.edu # remember ptype only if it is provided 1033101Sstever@eecs.umich.edu if ptype != None: 1043101Sstever@eecs.umich.edu self.ptype = ptype 1053101Sstever@eecs.umich.edu 1063101Sstever@eecs.umich.edu if args: 1073101Sstever@eecs.umich.edu if len(args) == 1: 1083101Sstever@eecs.umich.edu self.desc = args[0] 1093101Sstever@eecs.umich.edu elif len(args) == 2: 1103101Sstever@eecs.umich.edu self.default = args[0] 1113101Sstever@eecs.umich.edu self.desc = args[1] 1123101Sstever@eecs.umich.edu else: 1133101Sstever@eecs.umich.edu raise TypeError, 'too many arguments' 1143101Sstever@eecs.umich.edu 1153101Sstever@eecs.umich.edu if kwargs.has_key('desc'): 1163101Sstever@eecs.umich.edu assert(not hasattr(self, 'desc')) 1173101Sstever@eecs.umich.edu self.desc = kwargs['desc'] 1183101Sstever@eecs.umich.edu del kwargs['desc'] 1193101Sstever@eecs.umich.edu 1203101Sstever@eecs.umich.edu if kwargs.has_key('default'): 1213101Sstever@eecs.umich.edu assert(not hasattr(self, 'default')) 1223101Sstever@eecs.umich.edu self.default = kwargs['default'] 1233101Sstever@eecs.umich.edu del kwargs['default'] 1243101Sstever@eecs.umich.edu 1253101Sstever@eecs.umich.edu if kwargs: 1263101Sstever@eecs.umich.edu raise TypeError, 'extra unknown kwargs %s' % kwargs 1273101Sstever@eecs.umich.edu 1283101Sstever@eecs.umich.edu if not hasattr(self, 'desc'): 1293101Sstever@eecs.umich.edu raise TypeError, 'desc attribute missing' 1303101Sstever@eecs.umich.edu 1313101Sstever@eecs.umich.edu def __getattr__(self, attr): 1323101Sstever@eecs.umich.edu if attr == 'ptype': 1335033Smilesck@eecs.umich.edu ptype = SimObject.allClasses[self.ptype_str] 1346656Snate@binkert.org assert isSimObjectClass(ptype) 1355033Smilesck@eecs.umich.edu self.ptype = ptype 1365033Smilesck@eecs.umich.edu return ptype 1375033Smilesck@eecs.umich.edu 1383101Sstever@eecs.umich.edu raise AttributeError, "'%s' object has no attribute '%s'" % \ 1393101Sstever@eecs.umich.edu (type(self).__name__, attr) 1403101Sstever@eecs.umich.edu 1413101Sstever@eecs.umich.edu def convert(self, value): 1423101Sstever@eecs.umich.edu if isinstance(value, proxy.BaseProxy): 1433101Sstever@eecs.umich.edu value.set_param_desc(self) 1443101Sstever@eecs.umich.edu return value 1453101Sstever@eecs.umich.edu if not hasattr(self, 'ptype') and isNullPointer(value): 1463101Sstever@eecs.umich.edu # deferred evaluation of SimObject; continue to defer if 1473101Sstever@eecs.umich.edu # we're just assigning a null pointer 1483101Sstever@eecs.umich.edu return value 1493101Sstever@eecs.umich.edu if isinstance(value, self.ptype): 1503101Sstever@eecs.umich.edu return value 1513102Sstever@eecs.umich.edu if isNullPointer(value) and isSimObjectClass(self.ptype): 1523101Sstever@eecs.umich.edu return value 1533101Sstever@eecs.umich.edu return self.ptype(value) 1543101Sstever@eecs.umich.edu 1553101Sstever@eecs.umich.edu def cxx_predecls(self): 1563101Sstever@eecs.umich.edu return self.ptype.cxx_predecls 1573101Sstever@eecs.umich.edu 1583101Sstever@eecs.umich.edu def swig_predecls(self): 1593101Sstever@eecs.umich.edu return self.ptype.swig_predecls 1603101Sstever@eecs.umich.edu 1613101Sstever@eecs.umich.edu def cxx_decl(self): 1623101Sstever@eecs.umich.edu return '%s %s;' % (self.ptype.cxx_type, self.name) 1633101Sstever@eecs.umich.edu 1643101Sstever@eecs.umich.edu# Vector-valued parameter description. Just like ParamDesc, except 1653101Sstever@eecs.umich.edu# that the value is a vector (list) of the specified type instead of a 1663101Sstever@eecs.umich.edu# single value. 1673101Sstever@eecs.umich.edu 1683101Sstever@eecs.umich.educlass VectorParamValue(list): 1695033Smilesck@eecs.umich.edu __metaclass__ = MetaParamValue 1705475Snate@binkert.org def __setattr__(self, attr, value): 1715475Snate@binkert.org raise AttributeError, \ 1725475Snate@binkert.org "Not allowed to set %s on '%s'" % (attr, type(self).__name__) 1735475Snate@binkert.org 1743101Sstever@eecs.umich.edu def ini_str(self): 1753101Sstever@eecs.umich.edu return ' '.join([v.ini_str() for v in self]) 1763101Sstever@eecs.umich.edu 1774762Snate@binkert.org def getValue(self): 1784762Snate@binkert.org return [ v.getValue() for v in self ] 1794762Snate@binkert.org 1803101Sstever@eecs.umich.edu def unproxy(self, base): 1813101Sstever@eecs.umich.edu return [v.unproxy(base) for v in self] 1823101Sstever@eecs.umich.edu 1837528Ssteve.reinhardt@amd.comclass SimObjectVector(VectorParamValue): 1847528Ssteve.reinhardt@amd.com # support clone operation 1857528Ssteve.reinhardt@amd.com def __call__(self, **kwargs): 1867528Ssteve.reinhardt@amd.com return SimObjectVector([v(**kwargs) for v in self]) 1877528Ssteve.reinhardt@amd.com 1887528Ssteve.reinhardt@amd.com def clear_parent(self, old_parent): 1893101Sstever@eecs.umich.edu for v in self: 1907528Ssteve.reinhardt@amd.com v.clear_parent(old_parent) 1917528Ssteve.reinhardt@amd.com 1927528Ssteve.reinhardt@amd.com def set_parent(self, parent, name): 1937528Ssteve.reinhardt@amd.com if len(self) == 1: 1947528Ssteve.reinhardt@amd.com self[0].set_parent(parent, name) 1957528Ssteve.reinhardt@amd.com else: 1967528Ssteve.reinhardt@amd.com width = int(math.ceil(math.log(len(self))/math.log(10))) 1977528Ssteve.reinhardt@amd.com for i,v in enumerate(self): 1987528Ssteve.reinhardt@amd.com v.set_parent(parent, "%s%0*d" % (name, width, i)) 1997528Ssteve.reinhardt@amd.com 2007528Ssteve.reinhardt@amd.com def get_parent(self): 2017528Ssteve.reinhardt@amd.com parent_set = set(v._parent for v in self) 2027528Ssteve.reinhardt@amd.com if len(parent_set) != 1: 2037528Ssteve.reinhardt@amd.com raise RuntimeError, \ 2047528Ssteve.reinhardt@amd.com "SimObjectVector elements have inconsistent parent value." 2057528Ssteve.reinhardt@amd.com return parent_set.pop() 2067528Ssteve.reinhardt@amd.com 2077528Ssteve.reinhardt@amd.com # return 'cpu0 cpu1' etc. for print_ini() 2087528Ssteve.reinhardt@amd.com def get_name(self): 2097528Ssteve.reinhardt@amd.com return ' '.join([v._name for v in self]) 2107528Ssteve.reinhardt@amd.com 2117528Ssteve.reinhardt@amd.com # By iterating through the constituent members of the vector here 2127528Ssteve.reinhardt@amd.com # we can nicely handle iterating over all a SimObject's children 2137528Ssteve.reinhardt@amd.com # without having to provide lots of special functions on 2147528Ssteve.reinhardt@amd.com # SimObjectVector directly. 2157528Ssteve.reinhardt@amd.com def descendants(self): 2167528Ssteve.reinhardt@amd.com for v in self: 2177528Ssteve.reinhardt@amd.com for obj in v.descendants(): 2187528Ssteve.reinhardt@amd.com yield obj 2193101Sstever@eecs.umich.edu 2203101Sstever@eecs.umich.educlass VectorParamDesc(ParamDesc): 2216656Snate@binkert.org file_ext = 'vptype' 2226656Snate@binkert.org 2233101Sstever@eecs.umich.edu # Convert assigned value to appropriate type. If the RHS is not a 2243101Sstever@eecs.umich.edu # list or tuple, it generates a single-element list. 2253101Sstever@eecs.umich.edu def convert(self, value): 2263101Sstever@eecs.umich.edu if isinstance(value, (list, tuple)): 2273101Sstever@eecs.umich.edu # list: coerce each element into new list 2283101Sstever@eecs.umich.edu tmp_list = [ ParamDesc.convert(self, v) for v in value ] 2293101Sstever@eecs.umich.edu else: 2304762Snate@binkert.org # singleton: coerce to a single-element list 2314762Snate@binkert.org tmp_list = [ ParamDesc.convert(self, value) ] 2324762Snate@binkert.org 2334762Snate@binkert.org if isSimObjectSequence(tmp_list): 2347528Ssteve.reinhardt@amd.com return SimObjectVector(tmp_list) 2354762Snate@binkert.org else: 2364762Snate@binkert.org return VectorParamValue(tmp_list) 2374762Snate@binkert.org 2384762Snate@binkert.org def swig_predecls(self): 2394762Snate@binkert.org return ['%%include "%s_vptype.i"' % self.ptype_str] 2404762Snate@binkert.org 2414762Snate@binkert.org def swig_decl(self): 2424762Snate@binkert.org cxx_type = re.sub('std::', '', self.ptype.cxx_type) 2434762Snate@binkert.org vdecl = 'namespace std { %%template(vector_%s) vector< %s >; }' % \ 2444762Snate@binkert.org (self.ptype_str, cxx_type) 2454762Snate@binkert.org return ['%include "std_vector.i"'] + self.ptype.swig_predecls + [vdecl] 2463101Sstever@eecs.umich.edu 2473101Sstever@eecs.umich.edu def cxx_predecls(self): 2483101Sstever@eecs.umich.edu return ['#include <vector>'] + self.ptype.cxx_predecls 2493101Sstever@eecs.umich.edu 2503101Sstever@eecs.umich.edu def cxx_decl(self): 2513101Sstever@eecs.umich.edu return 'std::vector< %s > %s;' % (self.ptype.cxx_type, self.name) 2523101Sstever@eecs.umich.edu 2533101Sstever@eecs.umich.educlass ParamFactory(object): 2543101Sstever@eecs.umich.edu def __init__(self, param_desc_class, ptype_str = None): 2553101Sstever@eecs.umich.edu self.param_desc_class = param_desc_class 2563101Sstever@eecs.umich.edu self.ptype_str = ptype_str 2573101Sstever@eecs.umich.edu 2583101Sstever@eecs.umich.edu def __getattr__(self, attr): 2593101Sstever@eecs.umich.edu if self.ptype_str: 2603101Sstever@eecs.umich.edu attr = self.ptype_str + '.' + attr 2613101Sstever@eecs.umich.edu return ParamFactory(self.param_desc_class, attr) 2623101Sstever@eecs.umich.edu 2633101Sstever@eecs.umich.edu # E.g., Param.Int(5, "number of widgets") 2643101Sstever@eecs.umich.edu def __call__(self, *args, **kwargs): 2653101Sstever@eecs.umich.edu ptype = None 2663101Sstever@eecs.umich.edu try: 2675033Smilesck@eecs.umich.edu ptype = allParams[self.ptype_str] 2685033Smilesck@eecs.umich.edu except KeyError: 2693101Sstever@eecs.umich.edu # if name isn't defined yet, assume it's a SimObject, and 2703101Sstever@eecs.umich.edu # try to resolve it later 2713101Sstever@eecs.umich.edu pass 2723101Sstever@eecs.umich.edu return self.param_desc_class(self.ptype_str, ptype, *args, **kwargs) 2733101Sstever@eecs.umich.edu 2743101Sstever@eecs.umich.eduParam = ParamFactory(ParamDesc) 2753101Sstever@eecs.umich.eduVectorParam = ParamFactory(VectorParamDesc) 2763101Sstever@eecs.umich.edu 2773101Sstever@eecs.umich.edu##################################################################### 2783101Sstever@eecs.umich.edu# 2793101Sstever@eecs.umich.edu# Parameter Types 2803101Sstever@eecs.umich.edu# 2813101Sstever@eecs.umich.edu# Though native Python types could be used to specify parameter types 2823101Sstever@eecs.umich.edu# (the 'ptype' field of the Param and VectorParam classes), it's more 2833101Sstever@eecs.umich.edu# flexible to define our own set of types. This gives us more control 2843101Sstever@eecs.umich.edu# over how Python expressions are converted to values (via the 2853101Sstever@eecs.umich.edu# __init__() constructor) and how these values are printed out (via 2863101Sstever@eecs.umich.edu# the __str__() conversion method). 2873101Sstever@eecs.umich.edu# 2883101Sstever@eecs.umich.edu##################################################################### 2893101Sstever@eecs.umich.edu 2903101Sstever@eecs.umich.edu# String-valued parameter. Just mixin the ParamValue class with the 2913101Sstever@eecs.umich.edu# built-in str class. 2923101Sstever@eecs.umich.educlass String(ParamValue,str): 2933101Sstever@eecs.umich.edu cxx_type = 'std::string' 2943101Sstever@eecs.umich.edu cxx_predecls = ['#include <string>'] 2953101Sstever@eecs.umich.edu swig_predecls = ['%include "std_string.i"\n' + 2963101Sstever@eecs.umich.edu '%apply const std::string& {std::string *};'] 2974762Snate@binkert.org swig_predecls = ['%include "std_string.i"' ] 2984762Snate@binkert.org 2994762Snate@binkert.org def getValue(self): 3004762Snate@binkert.org return self 3013101Sstever@eecs.umich.edu 3023101Sstever@eecs.umich.edu# superclass for "numeric" parameter values, to emulate math 3033101Sstever@eecs.umich.edu# operations in a type-safe way. e.g., a Latency times an int returns 3043101Sstever@eecs.umich.edu# a new Latency object. 3053101Sstever@eecs.umich.educlass NumericParamValue(ParamValue): 3063101Sstever@eecs.umich.edu def __str__(self): 3073101Sstever@eecs.umich.edu return str(self.value) 3083101Sstever@eecs.umich.edu 3093101Sstever@eecs.umich.edu def __float__(self): 3103101Sstever@eecs.umich.edu return float(self.value) 3113101Sstever@eecs.umich.edu 3123714Sstever@eecs.umich.edu def __long__(self): 3133714Sstever@eecs.umich.edu return long(self.value) 3143714Sstever@eecs.umich.edu 3153714Sstever@eecs.umich.edu def __int__(self): 3163714Sstever@eecs.umich.edu return int(self.value) 3173714Sstever@eecs.umich.edu 3183101Sstever@eecs.umich.edu # hook for bounds checking 3193101Sstever@eecs.umich.edu def _check(self): 3203101Sstever@eecs.umich.edu return 3213101Sstever@eecs.umich.edu 3223101Sstever@eecs.umich.edu def __mul__(self, other): 3233101Sstever@eecs.umich.edu newobj = self.__class__(self) 3243101Sstever@eecs.umich.edu newobj.value *= other 3253101Sstever@eecs.umich.edu newobj._check() 3263101Sstever@eecs.umich.edu return newobj 3273101Sstever@eecs.umich.edu 3283101Sstever@eecs.umich.edu __rmul__ = __mul__ 3293101Sstever@eecs.umich.edu 3303101Sstever@eecs.umich.edu def __div__(self, other): 3313101Sstever@eecs.umich.edu newobj = self.__class__(self) 3323101Sstever@eecs.umich.edu newobj.value /= other 3333101Sstever@eecs.umich.edu newobj._check() 3343101Sstever@eecs.umich.edu return newobj 3353101Sstever@eecs.umich.edu 3363101Sstever@eecs.umich.edu def __sub__(self, other): 3373101Sstever@eecs.umich.edu newobj = self.__class__(self) 3383101Sstever@eecs.umich.edu newobj.value -= other 3393101Sstever@eecs.umich.edu newobj._check() 3403101Sstever@eecs.umich.edu return newobj 3413101Sstever@eecs.umich.edu 3423101Sstever@eecs.umich.edu# Metaclass for bounds-checked integer parameters. See CheckedInt. 3435033Smilesck@eecs.umich.educlass CheckedIntType(MetaParamValue): 3443101Sstever@eecs.umich.edu def __init__(cls, name, bases, dict): 3453101Sstever@eecs.umich.edu super(CheckedIntType, cls).__init__(name, bases, dict) 3463101Sstever@eecs.umich.edu 3473101Sstever@eecs.umich.edu # CheckedInt is an abstract base class, so we actually don't 3483101Sstever@eecs.umich.edu # want to do any processing on it... the rest of this code is 3493101Sstever@eecs.umich.edu # just for classes that derive from CheckedInt. 3503101Sstever@eecs.umich.edu if name == 'CheckedInt': 3513101Sstever@eecs.umich.edu return 3523101Sstever@eecs.umich.edu 3533101Sstever@eecs.umich.edu if not cls.cxx_predecls: 3543101Sstever@eecs.umich.edu # most derived types require this, so we just do it here once 3556214Snate@binkert.org cls.cxx_predecls = ['#include "base/types.hh"'] 3563101Sstever@eecs.umich.edu 3573101Sstever@eecs.umich.edu if not cls.swig_predecls: 3583101Sstever@eecs.umich.edu # most derived types require this, so we just do it here once 3594762Snate@binkert.org cls.swig_predecls = ['%import "stdint.i"\n' + 3606214Snate@binkert.org '%import "base/types.hh"'] 3613101Sstever@eecs.umich.edu 3623101Sstever@eecs.umich.edu if not (hasattr(cls, 'min') and hasattr(cls, 'max')): 3633101Sstever@eecs.umich.edu if not (hasattr(cls, 'size') and hasattr(cls, 'unsigned')): 3643101Sstever@eecs.umich.edu panic("CheckedInt subclass %s must define either\n" \ 3655822Ssaidi@eecs.umich.edu " 'min' and 'max' or 'size' and 'unsigned'\n", 3665822Ssaidi@eecs.umich.edu name); 3673101Sstever@eecs.umich.edu if cls.unsigned: 3683101Sstever@eecs.umich.edu cls.min = 0 3693101Sstever@eecs.umich.edu cls.max = 2 ** cls.size - 1 3703101Sstever@eecs.umich.edu else: 3713101Sstever@eecs.umich.edu cls.min = -(2 ** (cls.size - 1)) 3723101Sstever@eecs.umich.edu cls.max = (2 ** (cls.size - 1)) - 1 3733101Sstever@eecs.umich.edu 3743101Sstever@eecs.umich.edu# Abstract superclass for bounds-checked integer parameters. This 3753101Sstever@eecs.umich.edu# class is subclassed to generate parameter classes with specific 3763101Sstever@eecs.umich.edu# bounds. Initialization of the min and max bounds is done in the 3773101Sstever@eecs.umich.edu# metaclass CheckedIntType.__init__. 3783101Sstever@eecs.umich.educlass CheckedInt(NumericParamValue): 3793101Sstever@eecs.umich.edu __metaclass__ = CheckedIntType 3803101Sstever@eecs.umich.edu 3813101Sstever@eecs.umich.edu def _check(self): 3823101Sstever@eecs.umich.edu if not self.min <= self.value <= self.max: 3833101Sstever@eecs.umich.edu raise TypeError, 'Integer param out of bounds %d < %d < %d' % \ 3843101Sstever@eecs.umich.edu (self.min, self.value, self.max) 3853101Sstever@eecs.umich.edu 3863101Sstever@eecs.umich.edu def __init__(self, value): 3873101Sstever@eecs.umich.edu if isinstance(value, str): 3883102Sstever@eecs.umich.edu self.value = convert.toInteger(value) 3893714Sstever@eecs.umich.edu elif isinstance(value, (int, long, float, NumericParamValue)): 3903101Sstever@eecs.umich.edu self.value = long(value) 3913714Sstever@eecs.umich.edu else: 3923714Sstever@eecs.umich.edu raise TypeError, "Can't convert object of type %s to CheckedInt" \ 3933714Sstever@eecs.umich.edu % type(value).__name__ 3943101Sstever@eecs.umich.edu self._check() 3953101Sstever@eecs.umich.edu 3964762Snate@binkert.org def getValue(self): 3974762Snate@binkert.org return long(self.value) 3984762Snate@binkert.org 3993101Sstever@eecs.umich.educlass Int(CheckedInt): cxx_type = 'int'; size = 32; unsigned = False 4003101Sstever@eecs.umich.educlass Unsigned(CheckedInt): cxx_type = 'unsigned'; size = 32; unsigned = True 4013101Sstever@eecs.umich.edu 4023101Sstever@eecs.umich.educlass Int8(CheckedInt): cxx_type = 'int8_t'; size = 8; unsigned = False 4033101Sstever@eecs.umich.educlass UInt8(CheckedInt): cxx_type = 'uint8_t'; size = 8; unsigned = True 4043101Sstever@eecs.umich.educlass Int16(CheckedInt): cxx_type = 'int16_t'; size = 16; unsigned = False 4053101Sstever@eecs.umich.educlass UInt16(CheckedInt): cxx_type = 'uint16_t'; size = 16; unsigned = True 4063101Sstever@eecs.umich.educlass Int32(CheckedInt): cxx_type = 'int32_t'; size = 32; unsigned = False 4073101Sstever@eecs.umich.educlass UInt32(CheckedInt): cxx_type = 'uint32_t'; size = 32; unsigned = True 4083101Sstever@eecs.umich.educlass Int64(CheckedInt): cxx_type = 'int64_t'; size = 64; unsigned = False 4093101Sstever@eecs.umich.educlass UInt64(CheckedInt): cxx_type = 'uint64_t'; size = 64; unsigned = True 4103101Sstever@eecs.umich.edu 4113101Sstever@eecs.umich.educlass Counter(CheckedInt): cxx_type = 'Counter'; size = 64; unsigned = True 4123101Sstever@eecs.umich.educlass Tick(CheckedInt): cxx_type = 'Tick'; size = 64; unsigned = True 4133101Sstever@eecs.umich.educlass TcpPort(CheckedInt): cxx_type = 'uint16_t'; size = 16; unsigned = True 4143101Sstever@eecs.umich.educlass UdpPort(CheckedInt): cxx_type = 'uint16_t'; size = 16; unsigned = True 4153101Sstever@eecs.umich.edu 4163101Sstever@eecs.umich.educlass Percent(CheckedInt): cxx_type = 'int'; min = 0; max = 100 4173101Sstever@eecs.umich.edu 4183101Sstever@eecs.umich.educlass Float(ParamValue, float): 4194446Sbinkertn@umich.edu cxx_type = 'double' 4203101Sstever@eecs.umich.edu 4215468Snate@binkert.org def __init__(self, value): 4225468Snate@binkert.org if isinstance(value, (int, long, float, NumericParamValue, Float)): 4235468Snate@binkert.org self.value = float(value) 4245468Snate@binkert.org else: 4255468Snate@binkert.org raise TypeError, "Can't convert object of type %s to Float" \ 4265468Snate@binkert.org % type(value).__name__ 4275468Snate@binkert.org 4284762Snate@binkert.org def getValue(self): 4294762Snate@binkert.org return float(self.value) 4304762Snate@binkert.org 4313101Sstever@eecs.umich.educlass MemorySize(CheckedInt): 4323101Sstever@eecs.umich.edu cxx_type = 'uint64_t' 4333101Sstever@eecs.umich.edu size = 64 4343101Sstever@eecs.umich.edu unsigned = True 4353101Sstever@eecs.umich.edu def __init__(self, value): 4363101Sstever@eecs.umich.edu if isinstance(value, MemorySize): 4373101Sstever@eecs.umich.edu self.value = value.value 4383101Sstever@eecs.umich.edu else: 4393102Sstever@eecs.umich.edu self.value = convert.toMemorySize(value) 4403101Sstever@eecs.umich.edu self._check() 4413101Sstever@eecs.umich.edu 4423101Sstever@eecs.umich.educlass MemorySize32(CheckedInt): 4434168Sbinkertn@umich.edu cxx_type = 'uint32_t' 4443101Sstever@eecs.umich.edu size = 32 4453101Sstever@eecs.umich.edu unsigned = True 4463101Sstever@eecs.umich.edu def __init__(self, value): 4473101Sstever@eecs.umich.edu if isinstance(value, MemorySize): 4483101Sstever@eecs.umich.edu self.value = value.value 4493101Sstever@eecs.umich.edu else: 4503102Sstever@eecs.umich.edu self.value = convert.toMemorySize(value) 4513101Sstever@eecs.umich.edu self._check() 4523101Sstever@eecs.umich.edu 4533101Sstever@eecs.umich.educlass Addr(CheckedInt): 4543101Sstever@eecs.umich.edu cxx_type = 'Addr' 4553101Sstever@eecs.umich.edu size = 64 4563101Sstever@eecs.umich.edu unsigned = True 4573101Sstever@eecs.umich.edu def __init__(self, value): 4583101Sstever@eecs.umich.edu if isinstance(value, Addr): 4593101Sstever@eecs.umich.edu self.value = value.value 4603101Sstever@eecs.umich.edu else: 4613101Sstever@eecs.umich.edu try: 4623102Sstever@eecs.umich.edu self.value = convert.toMemorySize(value) 4633101Sstever@eecs.umich.edu except TypeError: 4643101Sstever@eecs.umich.edu self.value = long(value) 4653101Sstever@eecs.umich.edu self._check() 4663584Ssaidi@eecs.umich.edu def __add__(self, other): 4673584Ssaidi@eecs.umich.edu if isinstance(other, Addr): 4683584Ssaidi@eecs.umich.edu return self.value + other.value 4693584Ssaidi@eecs.umich.edu else: 4703584Ssaidi@eecs.umich.edu return self.value + other 4713101Sstever@eecs.umich.edu 4723101Sstever@eecs.umich.edu 4735033Smilesck@eecs.umich.educlass MetaRange(MetaParamValue): 4743101Sstever@eecs.umich.edu def __init__(cls, name, bases, dict): 4753101Sstever@eecs.umich.edu super(MetaRange, cls).__init__(name, bases, dict) 4763101Sstever@eecs.umich.edu if name == 'Range': 4773101Sstever@eecs.umich.edu return 4783101Sstever@eecs.umich.edu cls.cxx_type = 'Range< %s >' % cls.type.cxx_type 4793101Sstever@eecs.umich.edu cls.cxx_predecls = \ 4803101Sstever@eecs.umich.edu ['#include "base/range.hh"'] + cls.type.cxx_predecls 4813101Sstever@eecs.umich.edu 4823101Sstever@eecs.umich.educlass Range(ParamValue): 4833101Sstever@eecs.umich.edu __metaclass__ = MetaRange 4843101Sstever@eecs.umich.edu type = Int # default; can be overridden in subclasses 4853101Sstever@eecs.umich.edu def __init__(self, *args, **kwargs): 4863101Sstever@eecs.umich.edu def handle_kwargs(self, kwargs): 4873101Sstever@eecs.umich.edu if 'end' in kwargs: 4883101Sstever@eecs.umich.edu self.second = self.type(kwargs.pop('end')) 4893101Sstever@eecs.umich.edu elif 'size' in kwargs: 4903101Sstever@eecs.umich.edu self.second = self.first + self.type(kwargs.pop('size')) - 1 4913101Sstever@eecs.umich.edu else: 4923101Sstever@eecs.umich.edu raise TypeError, "Either end or size must be specified" 4933101Sstever@eecs.umich.edu 4943101Sstever@eecs.umich.edu if len(args) == 0: 4953101Sstever@eecs.umich.edu self.first = self.type(kwargs.pop('start')) 4963101Sstever@eecs.umich.edu handle_kwargs(self, kwargs) 4973101Sstever@eecs.umich.edu 4983101Sstever@eecs.umich.edu elif len(args) == 1: 4993101Sstever@eecs.umich.edu if kwargs: 5003101Sstever@eecs.umich.edu self.first = self.type(args[0]) 5013101Sstever@eecs.umich.edu handle_kwargs(self, kwargs) 5023101Sstever@eecs.umich.edu elif isinstance(args[0], Range): 5033101Sstever@eecs.umich.edu self.first = self.type(args[0].first) 5043101Sstever@eecs.umich.edu self.second = self.type(args[0].second) 5055219Ssaidi@eecs.umich.edu elif isinstance(args[0], (list, tuple)): 5065219Ssaidi@eecs.umich.edu self.first = self.type(args[0][0]) 5075219Ssaidi@eecs.umich.edu self.second = self.type(args[0][1]) 5083101Sstever@eecs.umich.edu else: 5093101Sstever@eecs.umich.edu self.first = self.type(0) 5103101Sstever@eecs.umich.edu self.second = self.type(args[0]) - 1 5113101Sstever@eecs.umich.edu 5123101Sstever@eecs.umich.edu elif len(args) == 2: 5133101Sstever@eecs.umich.edu self.first = self.type(args[0]) 5143101Sstever@eecs.umich.edu self.second = self.type(args[1]) 5153101Sstever@eecs.umich.edu else: 5163101Sstever@eecs.umich.edu raise TypeError, "Too many arguments specified" 5173101Sstever@eecs.umich.edu 5183101Sstever@eecs.umich.edu if kwargs: 5193101Sstever@eecs.umich.edu raise TypeError, "too many keywords: %s" % kwargs.keys() 5203101Sstever@eecs.umich.edu 5213101Sstever@eecs.umich.edu def __str__(self): 5223101Sstever@eecs.umich.edu return '%s:%s' % (self.first, self.second) 5233101Sstever@eecs.umich.edu 5243101Sstever@eecs.umich.educlass AddrRange(Range): 5253101Sstever@eecs.umich.edu type = Addr 5264762Snate@binkert.org swig_predecls = ['%include "python/swig/range.i"'] 5274762Snate@binkert.org 5284762Snate@binkert.org def getValue(self): 5294762Snate@binkert.org from m5.objects.params import AddrRange 5304762Snate@binkert.org 5314762Snate@binkert.org value = AddrRange() 5324762Snate@binkert.org value.start = long(self.first) 5334762Snate@binkert.org value.end = long(self.second) 5344762Snate@binkert.org return value 5353101Sstever@eecs.umich.edu 5363101Sstever@eecs.umich.educlass TickRange(Range): 5373101Sstever@eecs.umich.edu type = Tick 5384762Snate@binkert.org swig_predecls = ['%include "python/swig/range.i"'] 5394762Snate@binkert.org 5404762Snate@binkert.org def getValue(self): 5414762Snate@binkert.org from m5.objects.params import TickRange 5424762Snate@binkert.org 5434762Snate@binkert.org value = TickRange() 5444762Snate@binkert.org value.start = long(self.first) 5454762Snate@binkert.org value.end = long(self.second) 5464762Snate@binkert.org return value 5473101Sstever@eecs.umich.edu 5483101Sstever@eecs.umich.edu# Boolean parameter type. Python doesn't let you subclass bool, since 5493101Sstever@eecs.umich.edu# it doesn't want to let you create multiple instances of True and 5503101Sstever@eecs.umich.edu# False. Thus this is a little more complicated than String. 5513101Sstever@eecs.umich.educlass Bool(ParamValue): 5523101Sstever@eecs.umich.edu cxx_type = 'bool' 5533101Sstever@eecs.umich.edu def __init__(self, value): 5543101Sstever@eecs.umich.edu try: 5553102Sstever@eecs.umich.edu self.value = convert.toBool(value) 5563101Sstever@eecs.umich.edu except TypeError: 5573101Sstever@eecs.umich.edu self.value = bool(value) 5583101Sstever@eecs.umich.edu 5594762Snate@binkert.org def getValue(self): 5604762Snate@binkert.org return bool(self.value) 5614762Snate@binkert.org 5623101Sstever@eecs.umich.edu def __str__(self): 5633101Sstever@eecs.umich.edu return str(self.value) 5643101Sstever@eecs.umich.edu 5653101Sstever@eecs.umich.edu def ini_str(self): 5663101Sstever@eecs.umich.edu if self.value: 5673101Sstever@eecs.umich.edu return 'true' 5683101Sstever@eecs.umich.edu return 'false' 5693101Sstever@eecs.umich.edu 5703101Sstever@eecs.umich.edudef IncEthernetAddr(addr, val = 1): 5713101Sstever@eecs.umich.edu bytes = map(lambda x: int(x, 16), addr.split(':')) 5723101Sstever@eecs.umich.edu bytes[5] += val 5733101Sstever@eecs.umich.edu for i in (5, 4, 3, 2, 1): 5743101Sstever@eecs.umich.edu val,rem = divmod(bytes[i], 256) 5753101Sstever@eecs.umich.edu bytes[i] = rem 5763101Sstever@eecs.umich.edu if val == 0: 5773101Sstever@eecs.umich.edu break 5783101Sstever@eecs.umich.edu bytes[i - 1] += val 5793101Sstever@eecs.umich.edu assert(bytes[0] <= 255) 5803101Sstever@eecs.umich.edu return ':'.join(map(lambda x: '%02x' % x, bytes)) 5813101Sstever@eecs.umich.edu 5824380Sbinkertn@umich.edu_NextEthernetAddr = "00:90:00:00:00:01" 5834380Sbinkertn@umich.edudef NextEthernetAddr(): 5844380Sbinkertn@umich.edu global _NextEthernetAddr 5853101Sstever@eecs.umich.edu 5864380Sbinkertn@umich.edu value = _NextEthernetAddr 5874380Sbinkertn@umich.edu _NextEthernetAddr = IncEthernetAddr(_NextEthernetAddr, 1) 5884380Sbinkertn@umich.edu return value 5893101Sstever@eecs.umich.edu 5903101Sstever@eecs.umich.educlass EthernetAddr(ParamValue): 5913101Sstever@eecs.umich.edu cxx_type = 'Net::EthAddr' 5923101Sstever@eecs.umich.edu cxx_predecls = ['#include "base/inet.hh"'] 5934762Snate@binkert.org swig_predecls = ['%include "python/swig/inet.i"'] 5943101Sstever@eecs.umich.edu def __init__(self, value): 5953101Sstever@eecs.umich.edu if value == NextEthernetAddr: 5963101Sstever@eecs.umich.edu self.value = value 5973101Sstever@eecs.umich.edu return 5983101Sstever@eecs.umich.edu 5993101Sstever@eecs.umich.edu if not isinstance(value, str): 6003101Sstever@eecs.umich.edu raise TypeError, "expected an ethernet address and didn't get one" 6013101Sstever@eecs.umich.edu 6023101Sstever@eecs.umich.edu bytes = value.split(':') 6033101Sstever@eecs.umich.edu if len(bytes) != 6: 6043101Sstever@eecs.umich.edu raise TypeError, 'invalid ethernet address %s' % value 6053101Sstever@eecs.umich.edu 6063101Sstever@eecs.umich.edu for byte in bytes: 6073101Sstever@eecs.umich.edu if not 0 <= int(byte) <= 256: 6083101Sstever@eecs.umich.edu raise TypeError, 'invalid ethernet address %s' % value 6093101Sstever@eecs.umich.edu 6103101Sstever@eecs.umich.edu self.value = value 6113101Sstever@eecs.umich.edu 6123101Sstever@eecs.umich.edu def unproxy(self, base): 6133101Sstever@eecs.umich.edu if self.value == NextEthernetAddr: 6144380Sbinkertn@umich.edu return EthernetAddr(self.value()) 6153101Sstever@eecs.umich.edu return self 6163101Sstever@eecs.umich.edu 6174762Snate@binkert.org def getValue(self): 6184762Snate@binkert.org from m5.objects.params import EthAddr 6194762Snate@binkert.org return EthAddr(self.value) 6204762Snate@binkert.org 6214380Sbinkertn@umich.edu def ini_str(self): 6224380Sbinkertn@umich.edu return self.value 6233101Sstever@eecs.umich.edu 6243932Sbinkertn@umich.edutime_formats = [ "%a %b %d %H:%M:%S %Z %Y", 6253932Sbinkertn@umich.edu "%a %b %d %H:%M:%S %Z %Y", 6263932Sbinkertn@umich.edu "%Y/%m/%d %H:%M:%S", 6273932Sbinkertn@umich.edu "%Y/%m/%d %H:%M", 6283932Sbinkertn@umich.edu "%Y/%m/%d", 6293932Sbinkertn@umich.edu "%m/%d/%Y %H:%M:%S", 6303932Sbinkertn@umich.edu "%m/%d/%Y %H:%M", 6313932Sbinkertn@umich.edu "%m/%d/%Y", 6323932Sbinkertn@umich.edu "%m/%d/%y %H:%M:%S", 6333932Sbinkertn@umich.edu "%m/%d/%y %H:%M", 6343932Sbinkertn@umich.edu "%m/%d/%y"] 6353932Sbinkertn@umich.edu 6363932Sbinkertn@umich.edu 6373885Sbinkertn@umich.edudef parse_time(value): 6383932Sbinkertn@umich.edu from time import gmtime, strptime, struct_time, time 6393932Sbinkertn@umich.edu from datetime import datetime, date 6403885Sbinkertn@umich.edu 6413932Sbinkertn@umich.edu if isinstance(value, struct_time): 6423932Sbinkertn@umich.edu return value 6433932Sbinkertn@umich.edu 6443932Sbinkertn@umich.edu if isinstance(value, (int, long)): 6453932Sbinkertn@umich.edu return gmtime(value) 6463932Sbinkertn@umich.edu 6473932Sbinkertn@umich.edu if isinstance(value, (datetime, date)): 6483932Sbinkertn@umich.edu return value.timetuple() 6493932Sbinkertn@umich.edu 6503932Sbinkertn@umich.edu if isinstance(value, str): 6513932Sbinkertn@umich.edu if value in ('Now', 'Today'): 6523932Sbinkertn@umich.edu return time.gmtime(time.time()) 6533932Sbinkertn@umich.edu 6543932Sbinkertn@umich.edu for format in time_formats: 6553932Sbinkertn@umich.edu try: 6563932Sbinkertn@umich.edu return strptime(value, format) 6573932Sbinkertn@umich.edu except ValueError: 6583932Sbinkertn@umich.edu pass 6593885Sbinkertn@umich.edu 6603885Sbinkertn@umich.edu raise ValueError, "Could not parse '%s' as a time" % value 6613885Sbinkertn@umich.edu 6623885Sbinkertn@umich.educlass Time(ParamValue): 6634762Snate@binkert.org cxx_type = 'tm' 6644762Snate@binkert.org cxx_predecls = [ '#include <time.h>' ] 6654762Snate@binkert.org swig_predecls = [ '%include "python/swig/time.i"' ] 6663885Sbinkertn@umich.edu def __init__(self, value): 6673932Sbinkertn@umich.edu self.value = parse_time(value) 6683885Sbinkertn@umich.edu 6694762Snate@binkert.org def getValue(self): 6704762Snate@binkert.org from m5.objects.params import tm 6714762Snate@binkert.org 6724762Snate@binkert.org c_time = tm() 6734762Snate@binkert.org py_time = self.value 6744762Snate@binkert.org 6754762Snate@binkert.org # UNIX is years since 1900 6764762Snate@binkert.org c_time.tm_year = py_time.tm_year - 1900; 6774762Snate@binkert.org 6784762Snate@binkert.org # Python starts at 1, UNIX starts at 0 6794762Snate@binkert.org c_time.tm_mon = py_time.tm_mon - 1; 6804762Snate@binkert.org c_time.tm_mday = py_time.tm_mday; 6814762Snate@binkert.org c_time.tm_hour = py_time.tm_hour; 6824762Snate@binkert.org c_time.tm_min = py_time.tm_min; 6834762Snate@binkert.org c_time.tm_sec = py_time.tm_sec; 6844762Snate@binkert.org 6854762Snate@binkert.org # Python has 0 as Monday, UNIX is 0 as sunday 6864762Snate@binkert.org c_time.tm_wday = py_time.tm_wday + 1 6874762Snate@binkert.org if c_time.tm_wday > 6: 6884762Snate@binkert.org c_time.tm_wday -= 7; 6894762Snate@binkert.org 6904762Snate@binkert.org # Python starts at 1, Unix starts at 0 6914762Snate@binkert.org c_time.tm_yday = py_time.tm_yday - 1; 6924762Snate@binkert.org 6934762Snate@binkert.org return c_time 6944762Snate@binkert.org 6953885Sbinkertn@umich.edu def __str__(self): 6964762Snate@binkert.org return time.asctime(self.value) 6973885Sbinkertn@umich.edu 6983885Sbinkertn@umich.edu def ini_str(self): 6993932Sbinkertn@umich.edu return str(self) 7003885Sbinkertn@umich.edu 7013101Sstever@eecs.umich.edu# Enumerated types are a little more complex. The user specifies the 7023101Sstever@eecs.umich.edu# type as Enum(foo) where foo is either a list or dictionary of 7033101Sstever@eecs.umich.edu# alternatives (typically strings, but not necessarily so). (In the 7043101Sstever@eecs.umich.edu# long run, the integer value of the parameter will be the list index 7053101Sstever@eecs.umich.edu# or the corresponding dictionary value. For now, since we only check 7063101Sstever@eecs.umich.edu# that the alternative is valid and then spit it into a .ini file, 7073101Sstever@eecs.umich.edu# there's not much point in using the dictionary.) 7083101Sstever@eecs.umich.edu 7093101Sstever@eecs.umich.edu# What Enum() must do is generate a new type encapsulating the 7103101Sstever@eecs.umich.edu# provided list/dictionary so that specific values of the parameter 7113101Sstever@eecs.umich.edu# can be instances of that type. We define two hidden internal 7123101Sstever@eecs.umich.edu# classes (_ListEnum and _DictEnum) to serve as base classes, then 7133101Sstever@eecs.umich.edu# derive the new type from the appropriate base class on the fly. 7143101Sstever@eecs.umich.edu 7154762Snate@binkert.orgallEnums = {} 7163101Sstever@eecs.umich.edu# Metaclass for Enum types 7175033Smilesck@eecs.umich.educlass MetaEnum(MetaParamValue): 7184762Snate@binkert.org def __new__(mcls, name, bases, dict): 7194762Snate@binkert.org assert name not in allEnums 7204762Snate@binkert.org 7214762Snate@binkert.org cls = super(MetaEnum, mcls).__new__(mcls, name, bases, dict) 7224762Snate@binkert.org allEnums[name] = cls 7234762Snate@binkert.org return cls 7244762Snate@binkert.org 7253101Sstever@eecs.umich.edu def __init__(cls, name, bases, init_dict): 7263101Sstever@eecs.umich.edu if init_dict.has_key('map'): 7273101Sstever@eecs.umich.edu if not isinstance(cls.map, dict): 7283101Sstever@eecs.umich.edu raise TypeError, "Enum-derived class attribute 'map' " \ 7293101Sstever@eecs.umich.edu "must be of type dict" 7303101Sstever@eecs.umich.edu # build list of value strings from map 7313101Sstever@eecs.umich.edu cls.vals = cls.map.keys() 7323101Sstever@eecs.umich.edu cls.vals.sort() 7333101Sstever@eecs.umich.edu elif init_dict.has_key('vals'): 7343101Sstever@eecs.umich.edu if not isinstance(cls.vals, list): 7353101Sstever@eecs.umich.edu raise TypeError, "Enum-derived class attribute 'vals' " \ 7363101Sstever@eecs.umich.edu "must be of type list" 7373101Sstever@eecs.umich.edu # build string->value map from vals sequence 7383101Sstever@eecs.umich.edu cls.map = {} 7393101Sstever@eecs.umich.edu for idx,val in enumerate(cls.vals): 7403101Sstever@eecs.umich.edu cls.map[val] = idx 7413101Sstever@eecs.umich.edu else: 7423101Sstever@eecs.umich.edu raise TypeError, "Enum-derived class must define "\ 7433101Sstever@eecs.umich.edu "attribute 'map' or 'vals'" 7443101Sstever@eecs.umich.edu 7454762Snate@binkert.org cls.cxx_type = 'Enums::%s' % name 7463101Sstever@eecs.umich.edu 7473101Sstever@eecs.umich.edu super(MetaEnum, cls).__init__(name, bases, init_dict) 7483101Sstever@eecs.umich.edu 7493101Sstever@eecs.umich.edu # Generate C++ class declaration for this enum type. 7503101Sstever@eecs.umich.edu # Note that we wrap the enum in a class/struct to act as a namespace, 7513101Sstever@eecs.umich.edu # so that the enum strings can be brief w/o worrying about collisions. 7523101Sstever@eecs.umich.edu def cxx_decl(cls): 7536654Snate@binkert.org name = cls.__name__ 7546654Snate@binkert.org code = "#ifndef __ENUM__%s\n" % name 7556654Snate@binkert.org code += '#define __ENUM__%s\n' % name 7564762Snate@binkert.org code += '\n' 7574762Snate@binkert.org code += 'namespace Enums {\n' 7586654Snate@binkert.org code += ' enum %s {\n' % name 7594762Snate@binkert.org for val in cls.vals: 7604762Snate@binkert.org code += ' %s = %d,\n' % (val, cls.map[val]) 7616654Snate@binkert.org code += ' Num_%s = %d,\n' % (name, len(cls.vals)) 7624762Snate@binkert.org code += ' };\n' 7636654Snate@binkert.org code += ' extern const char *%sStrings[Num_%s];\n' % (name, name) 7644762Snate@binkert.org code += '}\n' 7654762Snate@binkert.org code += '\n' 7664762Snate@binkert.org code += '#endif\n' 7674762Snate@binkert.org return code 7684762Snate@binkert.org 7694762Snate@binkert.org def cxx_def(cls): 7706654Snate@binkert.org name = cls.__name__ 7716654Snate@binkert.org code = '#include "enums/%s.hh"\n' % name 7724762Snate@binkert.org code += 'namespace Enums {\n' 7736654Snate@binkert.org code += ' const char *%sStrings[Num_%s] =\n' % (name, name) 7744762Snate@binkert.org code += ' {\n' 7754762Snate@binkert.org for val in cls.vals: 7764762Snate@binkert.org code += ' "%s",\n' % val 7774762Snate@binkert.org code += ' };\n' 7784762Snate@binkert.org code += '}\n' 7794762Snate@binkert.org return code 7803101Sstever@eecs.umich.edu 7813101Sstever@eecs.umich.edu# Base class for enum types. 7823101Sstever@eecs.umich.educlass Enum(ParamValue): 7833101Sstever@eecs.umich.edu __metaclass__ = MetaEnum 7843101Sstever@eecs.umich.edu vals = [] 7853101Sstever@eecs.umich.edu 7863101Sstever@eecs.umich.edu def __init__(self, value): 7873101Sstever@eecs.umich.edu if value not in self.map: 7883101Sstever@eecs.umich.edu raise TypeError, "Enum param got bad value '%s' (not in %s)" \ 7893101Sstever@eecs.umich.edu % (value, self.vals) 7903101Sstever@eecs.umich.edu self.value = value 7913101Sstever@eecs.umich.edu 7924762Snate@binkert.org def getValue(self): 7934762Snate@binkert.org return int(self.map[self.value]) 7944762Snate@binkert.org 7953101Sstever@eecs.umich.edu def __str__(self): 7963101Sstever@eecs.umich.edu return self.value 7973101Sstever@eecs.umich.edu 7983101Sstever@eecs.umich.edu# how big does a rounding error need to be before we warn about it? 7993101Sstever@eecs.umich.edufrequency_tolerance = 0.001 # 0.1% 8003101Sstever@eecs.umich.edu 8014167Sbinkertn@umich.educlass TickParamValue(NumericParamValue): 8023101Sstever@eecs.umich.edu cxx_type = 'Tick' 8036214Snate@binkert.org cxx_predecls = ['#include "base/types.hh"'] 8044762Snate@binkert.org swig_predecls = ['%import "stdint.i"\n' + 8056214Snate@binkert.org '%import "base/types.hh"'] 8064167Sbinkertn@umich.edu 8074762Snate@binkert.org def getValue(self): 8084762Snate@binkert.org return long(self.value) 8094762Snate@binkert.org 8104167Sbinkertn@umich.educlass Latency(TickParamValue): 8113101Sstever@eecs.umich.edu def __init__(self, value): 8124167Sbinkertn@umich.edu if isinstance(value, (Latency, Clock)): 8134167Sbinkertn@umich.edu self.ticks = value.ticks 8144167Sbinkertn@umich.edu self.value = value.value 8154167Sbinkertn@umich.edu elif isinstance(value, Frequency): 8164167Sbinkertn@umich.edu self.ticks = value.ticks 8174167Sbinkertn@umich.edu self.value = 1.0 / value.value 8184167Sbinkertn@umich.edu elif value.endswith('t'): 8194167Sbinkertn@umich.edu self.ticks = True 8204167Sbinkertn@umich.edu self.value = int(value[:-1]) 8214167Sbinkertn@umich.edu else: 8224167Sbinkertn@umich.edu self.ticks = False 8234167Sbinkertn@umich.edu self.value = convert.toLatency(value) 8243101Sstever@eecs.umich.edu 8253101Sstever@eecs.umich.edu def __getattr__(self, attr): 8263101Sstever@eecs.umich.edu if attr in ('latency', 'period'): 8273101Sstever@eecs.umich.edu return self 8283101Sstever@eecs.umich.edu if attr == 'frequency': 8293101Sstever@eecs.umich.edu return Frequency(self) 8303101Sstever@eecs.umich.edu raise AttributeError, "Latency object has no attribute '%s'" % attr 8313101Sstever@eecs.umich.edu 8324762Snate@binkert.org def getValue(self): 8334762Snate@binkert.org if self.ticks or self.value == 0: 8344762Snate@binkert.org value = self.value 8354762Snate@binkert.org else: 8364762Snate@binkert.org value = ticks.fromSeconds(self.value) 8374762Snate@binkert.org return long(value) 8384762Snate@binkert.org 8393101Sstever@eecs.umich.edu # convert latency to ticks 8403101Sstever@eecs.umich.edu def ini_str(self): 8414762Snate@binkert.org return '%d' % self.getValue() 8423101Sstever@eecs.umich.edu 8434167Sbinkertn@umich.educlass Frequency(TickParamValue): 8443101Sstever@eecs.umich.edu def __init__(self, value): 8454167Sbinkertn@umich.edu if isinstance(value, (Latency, Clock)): 8464167Sbinkertn@umich.edu if value.value == 0: 8474167Sbinkertn@umich.edu self.value = 0 8484167Sbinkertn@umich.edu else: 8494167Sbinkertn@umich.edu self.value = 1.0 / value.value 8504167Sbinkertn@umich.edu self.ticks = value.ticks 8514167Sbinkertn@umich.edu elif isinstance(value, Frequency): 8524167Sbinkertn@umich.edu self.value = value.value 8534167Sbinkertn@umich.edu self.ticks = value.ticks 8544167Sbinkertn@umich.edu else: 8554167Sbinkertn@umich.edu self.ticks = False 8564167Sbinkertn@umich.edu self.value = convert.toFrequency(value) 8573101Sstever@eecs.umich.edu 8583101Sstever@eecs.umich.edu def __getattr__(self, attr): 8593101Sstever@eecs.umich.edu if attr == 'frequency': 8603101Sstever@eecs.umich.edu return self 8613101Sstever@eecs.umich.edu if attr in ('latency', 'period'): 8623101Sstever@eecs.umich.edu return Latency(self) 8633101Sstever@eecs.umich.edu raise AttributeError, "Frequency object has no attribute '%s'" % attr 8643101Sstever@eecs.umich.edu 8654167Sbinkertn@umich.edu # convert latency to ticks 8664762Snate@binkert.org def getValue(self): 8674762Snate@binkert.org if self.ticks or self.value == 0: 8684762Snate@binkert.org value = self.value 8694762Snate@binkert.org else: 8704762Snate@binkert.org value = ticks.fromSeconds(1.0 / self.value) 8714762Snate@binkert.org return long(value) 8724762Snate@binkert.org 8733101Sstever@eecs.umich.edu def ini_str(self): 8744762Snate@binkert.org return '%d' % self.getValue() 8753101Sstever@eecs.umich.edu 8763101Sstever@eecs.umich.edu# A generic frequency and/or Latency value. Value is stored as a latency, 8773101Sstever@eecs.umich.edu# but to avoid ambiguity this object does not support numeric ops (* or /). 8783101Sstever@eecs.umich.edu# An explicit conversion to a Latency or Frequency must be made first. 8793101Sstever@eecs.umich.educlass Clock(ParamValue): 8803101Sstever@eecs.umich.edu cxx_type = 'Tick' 8816214Snate@binkert.org cxx_predecls = ['#include "base/types.hh"'] 8824762Snate@binkert.org swig_predecls = ['%import "stdint.i"\n' + 8836214Snate@binkert.org '%import "base/types.hh"'] 8843101Sstever@eecs.umich.edu def __init__(self, value): 8854167Sbinkertn@umich.edu if isinstance(value, (Latency, Clock)): 8864167Sbinkertn@umich.edu self.ticks = value.ticks 8874167Sbinkertn@umich.edu self.value = value.value 8884167Sbinkertn@umich.edu elif isinstance(value, Frequency): 8894167Sbinkertn@umich.edu self.ticks = value.ticks 8904167Sbinkertn@umich.edu self.value = 1.0 / value.value 8914167Sbinkertn@umich.edu elif value.endswith('t'): 8924167Sbinkertn@umich.edu self.ticks = True 8934167Sbinkertn@umich.edu self.value = int(value[:-1]) 8944167Sbinkertn@umich.edu else: 8954167Sbinkertn@umich.edu self.ticks = False 8964167Sbinkertn@umich.edu self.value = convert.anyToLatency(value) 8973101Sstever@eecs.umich.edu 8983101Sstever@eecs.umich.edu def __getattr__(self, attr): 8993101Sstever@eecs.umich.edu if attr == 'frequency': 9003101Sstever@eecs.umich.edu return Frequency(self) 9013101Sstever@eecs.umich.edu if attr in ('latency', 'period'): 9023101Sstever@eecs.umich.edu return Latency(self) 9033101Sstever@eecs.umich.edu raise AttributeError, "Frequency object has no attribute '%s'" % attr 9043101Sstever@eecs.umich.edu 9054762Snate@binkert.org def getValue(self): 9064762Snate@binkert.org return self.period.getValue() 9074762Snate@binkert.org 9083101Sstever@eecs.umich.edu def ini_str(self): 9093101Sstever@eecs.umich.edu return self.period.ini_str() 9103101Sstever@eecs.umich.edu 9113101Sstever@eecs.umich.educlass NetworkBandwidth(float,ParamValue): 9123101Sstever@eecs.umich.edu cxx_type = 'float' 9133101Sstever@eecs.umich.edu def __new__(cls, value): 9144167Sbinkertn@umich.edu # convert to bits per second 9154167Sbinkertn@umich.edu val = convert.toNetworkBandwidth(value) 9163101Sstever@eecs.umich.edu return super(cls, NetworkBandwidth).__new__(cls, val) 9173101Sstever@eecs.umich.edu 9183101Sstever@eecs.umich.edu def __str__(self): 9193101Sstever@eecs.umich.edu return str(self.val) 9203101Sstever@eecs.umich.edu 9214762Snate@binkert.org def getValue(self): 9224167Sbinkertn@umich.edu # convert to seconds per byte 9234167Sbinkertn@umich.edu value = 8.0 / float(self) 9244167Sbinkertn@umich.edu # convert to ticks per byte 9254762Snate@binkert.org value = ticks.fromSeconds(value) 9264762Snate@binkert.org return float(value) 9274762Snate@binkert.org 9284762Snate@binkert.org def ini_str(self): 9294762Snate@binkert.org return '%f' % self.getValue() 9303101Sstever@eecs.umich.edu 9313101Sstever@eecs.umich.educlass MemoryBandwidth(float,ParamValue): 9323101Sstever@eecs.umich.edu cxx_type = 'float' 9335469Snate@binkert.org def __new__(cls, value): 9344167Sbinkertn@umich.edu # we want the number of ticks per byte of data 9353102Sstever@eecs.umich.edu val = convert.toMemoryBandwidth(value) 9363101Sstever@eecs.umich.edu return super(cls, MemoryBandwidth).__new__(cls, val) 9373101Sstever@eecs.umich.edu 9383101Sstever@eecs.umich.edu def __str__(self): 9393101Sstever@eecs.umich.edu return str(self.val) 9403101Sstever@eecs.umich.edu 9414762Snate@binkert.org def getValue(self): 9424167Sbinkertn@umich.edu # convert to seconds per byte 9435468Snate@binkert.org value = float(self) 9445468Snate@binkert.org if value: 9455468Snate@binkert.org value = 1.0 / float(self) 9464167Sbinkertn@umich.edu # convert to ticks per byte 9474762Snate@binkert.org value = ticks.fromSeconds(value) 9484762Snate@binkert.org return float(value) 9494762Snate@binkert.org 9504762Snate@binkert.org def ini_str(self): 9514762Snate@binkert.org return '%f' % self.getValue() 9523101Sstever@eecs.umich.edu 9533101Sstever@eecs.umich.edu# 9543101Sstever@eecs.umich.edu# "Constants"... handy aliases for various values. 9553101Sstever@eecs.umich.edu# 9563101Sstever@eecs.umich.edu 9573102Sstever@eecs.umich.edu# Special class for NULL pointers. Note the special check in 9583102Sstever@eecs.umich.edu# make_param_value() above that lets these be assigned where a 9593102Sstever@eecs.umich.edu# SimObject is required. 9603102Sstever@eecs.umich.edu# only one copy of a particular node 9613102Sstever@eecs.umich.educlass NullSimObject(object): 9623102Sstever@eecs.umich.edu __metaclass__ = Singleton 9633102Sstever@eecs.umich.edu 9643102Sstever@eecs.umich.edu def __call__(cls): 9653102Sstever@eecs.umich.edu return cls 9663102Sstever@eecs.umich.edu 9673102Sstever@eecs.umich.edu def _instantiate(self, parent = None, path = ''): 9683102Sstever@eecs.umich.edu pass 9693102Sstever@eecs.umich.edu 9703102Sstever@eecs.umich.edu def ini_str(self): 9713102Sstever@eecs.umich.edu return 'Null' 9723102Sstever@eecs.umich.edu 9733102Sstever@eecs.umich.edu def unproxy(self, base): 9743102Sstever@eecs.umich.edu return self 9753102Sstever@eecs.umich.edu 9763102Sstever@eecs.umich.edu def set_path(self, parent, name): 9773102Sstever@eecs.umich.edu pass 9784762Snate@binkert.org 9793102Sstever@eecs.umich.edu def __str__(self): 9803102Sstever@eecs.umich.edu return 'Null' 9813102Sstever@eecs.umich.edu 9824762Snate@binkert.org def getValue(self): 9834762Snate@binkert.org return None 9844762Snate@binkert.org 9853102Sstever@eecs.umich.edu# The only instance you'll ever need... 9863102Sstever@eecs.umich.eduNULL = NullSimObject() 9873102Sstever@eecs.umich.edu 9883102Sstever@eecs.umich.edudef isNullPointer(value): 9893102Sstever@eecs.umich.edu return isinstance(value, NullSimObject) 9903102Sstever@eecs.umich.edu 9913101Sstever@eecs.umich.edu# Some memory range specifications use this as a default upper bound. 9923101Sstever@eecs.umich.eduMaxAddr = Addr.max 9933101Sstever@eecs.umich.eduMaxTick = Tick.max 9943101Sstever@eecs.umich.eduAllMemory = AddrRange(0, MaxAddr) 9953101Sstever@eecs.umich.edu 9963101Sstever@eecs.umich.edu 9973101Sstever@eecs.umich.edu##################################################################### 9983101Sstever@eecs.umich.edu# 9993101Sstever@eecs.umich.edu# Port objects 10003101Sstever@eecs.umich.edu# 10013101Sstever@eecs.umich.edu# Ports are used to interconnect objects in the memory system. 10023101Sstever@eecs.umich.edu# 10033101Sstever@eecs.umich.edu##################################################################### 10043101Sstever@eecs.umich.edu 10053101Sstever@eecs.umich.edu# Port reference: encapsulates a reference to a particular port on a 10063101Sstever@eecs.umich.edu# particular SimObject. 10073101Sstever@eecs.umich.educlass PortRef(object): 10083105Sstever@eecs.umich.edu def __init__(self, simobj, name): 10093105Sstever@eecs.umich.edu assert(isSimObject(simobj) or isSimObjectClass(simobj)) 10103101Sstever@eecs.umich.edu self.simobj = simobj 10113101Sstever@eecs.umich.edu self.name = name 10123101Sstever@eecs.umich.edu self.peer = None # not associated with another port yet 10133101Sstever@eecs.umich.edu self.ccConnected = False # C++ port connection done? 10143105Sstever@eecs.umich.edu self.index = -1 # always -1 for non-vector ports 10153101Sstever@eecs.umich.edu 10163103Sstever@eecs.umich.edu def __str__(self): 10173105Sstever@eecs.umich.edu return '%s.%s' % (self.simobj, self.name) 10183103Sstever@eecs.umich.edu 10193105Sstever@eecs.umich.edu # for config.ini, print peer's name (not ours) 10203105Sstever@eecs.umich.edu def ini_str(self): 10213105Sstever@eecs.umich.edu return str(self.peer) 10223105Sstever@eecs.umich.edu 10233105Sstever@eecs.umich.edu def __getattr__(self, attr): 10243105Sstever@eecs.umich.edu if attr == 'peerObj': 10253105Sstever@eecs.umich.edu # shorthand for proxies 10263105Sstever@eecs.umich.edu return self.peer.simobj 10273105Sstever@eecs.umich.edu raise AttributeError, "'%s' object has no attribute '%s'" % \ 10283105Sstever@eecs.umich.edu (self.__class__.__name__, attr) 10293105Sstever@eecs.umich.edu 10303105Sstever@eecs.umich.edu # Full connection is symmetric (both ways). Called via 10313105Sstever@eecs.umich.edu # SimObject.__setattr__ as a result of a port assignment, e.g., 10323109Sstever@eecs.umich.edu # "obj1.portA = obj2.portB", or via VectorPortElementRef.__setitem__, 10333105Sstever@eecs.umich.edu # e.g., "obj1.portA[3] = obj2.portB". 10343105Sstever@eecs.umich.edu def connect(self, other): 10353105Sstever@eecs.umich.edu if isinstance(other, VectorPortRef): 10363105Sstever@eecs.umich.edu # reference to plain VectorPort is implicit append 10373105Sstever@eecs.umich.edu other = other._get_next() 10383105Sstever@eecs.umich.edu if self.peer and not proxy.isproxy(self.peer): 10393105Sstever@eecs.umich.edu print "warning: overwriting port", self, \ 10403105Sstever@eecs.umich.edu "value", self.peer, "with", other 10415578SSteve.Reinhardt@amd.com self.peer.peer = None 10423101Sstever@eecs.umich.edu self.peer = other 10433109Sstever@eecs.umich.edu if proxy.isproxy(other): 10443109Sstever@eecs.umich.edu other.set_param_desc(PortParamDesc()) 10453109Sstever@eecs.umich.edu elif isinstance(other, PortRef): 10463109Sstever@eecs.umich.edu if other.peer is not self: 10473109Sstever@eecs.umich.edu other.connect(self) 10483109Sstever@eecs.umich.edu else: 10493109Sstever@eecs.umich.edu raise TypeError, \ 10503109Sstever@eecs.umich.edu "assigning non-port reference '%s' to port '%s'" \ 10513109Sstever@eecs.umich.edu % (other, self) 10523101Sstever@eecs.umich.edu 10533105Sstever@eecs.umich.edu def clone(self, simobj, memo): 10543105Sstever@eecs.umich.edu if memo.has_key(self): 10553105Sstever@eecs.umich.edu return memo[self] 10563101Sstever@eecs.umich.edu newRef = copy.copy(self) 10573105Sstever@eecs.umich.edu memo[self] = newRef 10583105Sstever@eecs.umich.edu newRef.simobj = simobj 10593101Sstever@eecs.umich.edu assert(isSimObject(newRef.simobj)) 10603105Sstever@eecs.umich.edu if self.peer and not proxy.isproxy(self.peer): 10613179Sstever@eecs.umich.edu peerObj = self.peer.simobj(_memo=memo) 10623105Sstever@eecs.umich.edu newRef.peer = self.peer.clone(peerObj, memo) 10633105Sstever@eecs.umich.edu assert(not isinstance(newRef.peer, VectorPortRef)) 10643101Sstever@eecs.umich.edu return newRef 10653101Sstever@eecs.umich.edu 10663105Sstever@eecs.umich.edu def unproxy(self, simobj): 10673105Sstever@eecs.umich.edu assert(simobj is self.simobj) 10683105Sstever@eecs.umich.edu if proxy.isproxy(self.peer): 10693105Sstever@eecs.umich.edu try: 10703105Sstever@eecs.umich.edu realPeer = self.peer.unproxy(self.simobj) 10713105Sstever@eecs.umich.edu except: 10723105Sstever@eecs.umich.edu print "Error in unproxying port '%s' of %s" % \ 10733105Sstever@eecs.umich.edu (self.name, self.simobj.path()) 10743105Sstever@eecs.umich.edu raise 10753105Sstever@eecs.umich.edu self.connect(realPeer) 10763105Sstever@eecs.umich.edu 10773101Sstever@eecs.umich.edu # Call C++ to create corresponding port connection between C++ objects 10783101Sstever@eecs.umich.edu def ccConnect(self): 10794859Snate@binkert.org from m5.objects.params import connectPorts 10804762Snate@binkert.org 10813101Sstever@eecs.umich.edu if self.ccConnected: # already done this 10823101Sstever@eecs.umich.edu return 10833101Sstever@eecs.umich.edu peer = self.peer 10845578SSteve.Reinhardt@amd.com if not self.peer: # nothing to connect to 10855578SSteve.Reinhardt@amd.com return 10867526Ssteve.reinhardt@amd.com try: 10877526Ssteve.reinhardt@amd.com connectPorts(self.simobj.getCCObject(), self.name, self.index, 10887526Ssteve.reinhardt@amd.com peer.simobj.getCCObject(), peer.name, peer.index) 10897526Ssteve.reinhardt@amd.com except: 10907526Ssteve.reinhardt@amd.com print "Error connecting port %s.%s to %s.%s" % \ 10917526Ssteve.reinhardt@amd.com (self.simobj.path(), self.name, 10927526Ssteve.reinhardt@amd.com peer.simobj.path(), peer.name) 10937526Ssteve.reinhardt@amd.com raise 10943101Sstever@eecs.umich.edu self.ccConnected = True 10953101Sstever@eecs.umich.edu peer.ccConnected = True 10963101Sstever@eecs.umich.edu 10973105Sstever@eecs.umich.edu# A reference to an individual element of a VectorPort... much like a 10983105Sstever@eecs.umich.edu# PortRef, but has an index. 10993105Sstever@eecs.umich.educlass VectorPortElementRef(PortRef): 11003105Sstever@eecs.umich.edu def __init__(self, simobj, name, index): 11013105Sstever@eecs.umich.edu PortRef.__init__(self, simobj, name) 11023105Sstever@eecs.umich.edu self.index = index 11033105Sstever@eecs.umich.edu 11043105Sstever@eecs.umich.edu def __str__(self): 11053105Sstever@eecs.umich.edu return '%s.%s[%d]' % (self.simobj, self.name, self.index) 11063105Sstever@eecs.umich.edu 11073105Sstever@eecs.umich.edu# A reference to a complete vector-valued port (not just a single element). 11083105Sstever@eecs.umich.edu# Can be indexed to retrieve individual VectorPortElementRef instances. 11093105Sstever@eecs.umich.educlass VectorPortRef(object): 11103105Sstever@eecs.umich.edu def __init__(self, simobj, name): 11113105Sstever@eecs.umich.edu assert(isSimObject(simobj) or isSimObjectClass(simobj)) 11123105Sstever@eecs.umich.edu self.simobj = simobj 11133105Sstever@eecs.umich.edu self.name = name 11143105Sstever@eecs.umich.edu self.elements = [] 11153105Sstever@eecs.umich.edu 11163109Sstever@eecs.umich.edu def __str__(self): 11173109Sstever@eecs.umich.edu return '%s.%s[:]' % (self.simobj, self.name) 11183109Sstever@eecs.umich.edu 11193105Sstever@eecs.umich.edu # for config.ini, print peer's name (not ours) 11203105Sstever@eecs.umich.edu def ini_str(self): 11213105Sstever@eecs.umich.edu return ' '.join([el.ini_str() for el in self.elements]) 11223105Sstever@eecs.umich.edu 11233105Sstever@eecs.umich.edu def __getitem__(self, key): 11243105Sstever@eecs.umich.edu if not isinstance(key, int): 11253105Sstever@eecs.umich.edu raise TypeError, "VectorPort index must be integer" 11263105Sstever@eecs.umich.edu if key >= len(self.elements): 11273105Sstever@eecs.umich.edu # need to extend list 11283105Sstever@eecs.umich.edu ext = [VectorPortElementRef(self.simobj, self.name, i) 11293105Sstever@eecs.umich.edu for i in range(len(self.elements), key+1)] 11303105Sstever@eecs.umich.edu self.elements.extend(ext) 11313105Sstever@eecs.umich.edu return self.elements[key] 11323105Sstever@eecs.umich.edu 11333105Sstever@eecs.umich.edu def _get_next(self): 11343105Sstever@eecs.umich.edu return self[len(self.elements)] 11353105Sstever@eecs.umich.edu 11363105Sstever@eecs.umich.edu def __setitem__(self, key, value): 11373105Sstever@eecs.umich.edu if not isinstance(key, int): 11383105Sstever@eecs.umich.edu raise TypeError, "VectorPort index must be integer" 11393105Sstever@eecs.umich.edu self[key].connect(value) 11403105Sstever@eecs.umich.edu 11413105Sstever@eecs.umich.edu def connect(self, other): 11423109Sstever@eecs.umich.edu if isinstance(other, (list, tuple)): 11433109Sstever@eecs.umich.edu # Assign list of port refs to vector port. 11443109Sstever@eecs.umich.edu # For now, append them... not sure if that's the right semantics 11453109Sstever@eecs.umich.edu # or if it should replace the current vector. 11463109Sstever@eecs.umich.edu for ref in other: 11473109Sstever@eecs.umich.edu self._get_next().connect(ref) 11483109Sstever@eecs.umich.edu else: 11493109Sstever@eecs.umich.edu # scalar assignment to plain VectorPort is implicit append 11503109Sstever@eecs.umich.edu self._get_next().connect(other) 11513109Sstever@eecs.umich.edu 11523109Sstever@eecs.umich.edu def clone(self, simobj, memo): 11533109Sstever@eecs.umich.edu if memo.has_key(self): 11543109Sstever@eecs.umich.edu return memo[self] 11553109Sstever@eecs.umich.edu newRef = copy.copy(self) 11563109Sstever@eecs.umich.edu memo[self] = newRef 11573109Sstever@eecs.umich.edu newRef.simobj = simobj 11583109Sstever@eecs.umich.edu assert(isSimObject(newRef.simobj)) 11593109Sstever@eecs.umich.edu newRef.elements = [el.clone(simobj, memo) for el in self.elements] 11603109Sstever@eecs.umich.edu return newRef 11613105Sstever@eecs.umich.edu 11623105Sstever@eecs.umich.edu def unproxy(self, simobj): 11633105Sstever@eecs.umich.edu [el.unproxy(simobj) for el in self.elements] 11643105Sstever@eecs.umich.edu 11653105Sstever@eecs.umich.edu def ccConnect(self): 11663105Sstever@eecs.umich.edu [el.ccConnect() for el in self.elements] 11673105Sstever@eecs.umich.edu 11683101Sstever@eecs.umich.edu# Port description object. Like a ParamDesc object, this represents a 11693101Sstever@eecs.umich.edu# logical port in the SimObject class, not a particular port on a 11703101Sstever@eecs.umich.edu# SimObject instance. The latter are represented by PortRef objects. 11713101Sstever@eecs.umich.educlass Port(object): 11723105Sstever@eecs.umich.edu # Port("description") or Port(default, "description") 11733105Sstever@eecs.umich.edu def __init__(self, *args): 11743105Sstever@eecs.umich.edu if len(args) == 1: 11753105Sstever@eecs.umich.edu self.desc = args[0] 11763105Sstever@eecs.umich.edu elif len(args) == 2: 11773105Sstever@eecs.umich.edu self.default = args[0] 11783105Sstever@eecs.umich.edu self.desc = args[1] 11793105Sstever@eecs.umich.edu else: 11803105Sstever@eecs.umich.edu raise TypeError, 'wrong number of arguments' 11813105Sstever@eecs.umich.edu # self.name is set by SimObject class on assignment 11823105Sstever@eecs.umich.edu # e.g., pio_port = Port("blah") sets self.name to 'pio_port' 11833101Sstever@eecs.umich.edu 11843101Sstever@eecs.umich.edu # Generate a PortRef for this port on the given SimObject with the 11853101Sstever@eecs.umich.edu # given name 11863105Sstever@eecs.umich.edu def makeRef(self, simobj): 11873105Sstever@eecs.umich.edu return PortRef(simobj, self.name) 11883101Sstever@eecs.umich.edu 11893101Sstever@eecs.umich.edu # Connect an instance of this port (on the given SimObject with 11903101Sstever@eecs.umich.edu # the given name) with the port described by the supplied PortRef 11913105Sstever@eecs.umich.edu def connect(self, simobj, ref): 11923105Sstever@eecs.umich.edu self.makeRef(simobj).connect(ref) 11933101Sstever@eecs.umich.edu 11943101Sstever@eecs.umich.edu# VectorPort description object. Like Port, but represents a vector 11953101Sstever@eecs.umich.edu# of connections (e.g., as on a Bus). 11963101Sstever@eecs.umich.educlass VectorPort(Port): 11973105Sstever@eecs.umich.edu def __init__(self, *args): 11983105Sstever@eecs.umich.edu Port.__init__(self, *args) 11993101Sstever@eecs.umich.edu self.isVec = True 12003101Sstever@eecs.umich.edu 12013105Sstever@eecs.umich.edu def makeRef(self, simobj): 12023105Sstever@eecs.umich.edu return VectorPortRef(simobj, self.name) 12033105Sstever@eecs.umich.edu 12043109Sstever@eecs.umich.edu# 'Fake' ParamDesc for Port references to assign to the _pdesc slot of 12053109Sstever@eecs.umich.edu# proxy objects (via set_param_desc()) so that proxy error messages 12063109Sstever@eecs.umich.edu# make sense. 12073109Sstever@eecs.umich.educlass PortParamDesc(object): 12083109Sstever@eecs.umich.edu __metaclass__ = Singleton 12093109Sstever@eecs.umich.edu 12103109Sstever@eecs.umich.edu ptype_str = 'Port' 12113109Sstever@eecs.umich.edu ptype = Port 12123105Sstever@eecs.umich.edu 12136654Snate@binkert.orgbaseEnums = allEnums.copy() 12146654Snate@binkert.orgbaseParams = allParams.copy() 12156654Snate@binkert.org 12166654Snate@binkert.orgdef clear(): 12176654Snate@binkert.org global allEnums, allParams 12186654Snate@binkert.org 12196654Snate@binkert.org allEnums = baseEnums.copy() 12206654Snate@binkert.org allParams = baseParams.copy() 12216654Snate@binkert.org 12223101Sstever@eecs.umich.edu__all__ = ['Param', 'VectorParam', 12233101Sstever@eecs.umich.edu 'Enum', 'Bool', 'String', 'Float', 12243101Sstever@eecs.umich.edu 'Int', 'Unsigned', 'Int8', 'UInt8', 'Int16', 'UInt16', 12253101Sstever@eecs.umich.edu 'Int32', 'UInt32', 'Int64', 'UInt64', 12263101Sstever@eecs.umich.edu 'Counter', 'Addr', 'Tick', 'Percent', 12273101Sstever@eecs.umich.edu 'TcpPort', 'UdpPort', 'EthernetAddr', 12283101Sstever@eecs.umich.edu 'MemorySize', 'MemorySize32', 12294167Sbinkertn@umich.edu 'Latency', 'Frequency', 'Clock', 12303101Sstever@eecs.umich.edu 'NetworkBandwidth', 'MemoryBandwidth', 12313101Sstever@eecs.umich.edu 'Range', 'AddrRange', 'TickRange', 12323101Sstever@eecs.umich.edu 'MaxAddr', 'MaxTick', 'AllMemory', 12333885Sbinkertn@umich.edu 'Time', 12343102Sstever@eecs.umich.edu 'NextEthernetAddr', 'NULL', 12353101Sstever@eecs.umich.edu 'Port', 'VectorPort'] 12366654Snate@binkert.org 12376654Snate@binkert.orgimport SimObject 1238