params.py revision 4168
13101Sstever@eecs.umich.edu# Copyright (c) 2004-2006 The Regents of The University of Michigan 23101Sstever@eecs.umich.edu# All rights reserved. 33101Sstever@eecs.umich.edu# 43101Sstever@eecs.umich.edu# Redistribution and use in source and binary forms, with or without 53101Sstever@eecs.umich.edu# modification, are permitted provided that the following conditions are 63101Sstever@eecs.umich.edu# met: redistributions of source code must retain the above copyright 73101Sstever@eecs.umich.edu# notice, this list of conditions and the following disclaimer; 83101Sstever@eecs.umich.edu# redistributions in binary form must reproduce the above copyright 93101Sstever@eecs.umich.edu# notice, this list of conditions and the following disclaimer in the 103101Sstever@eecs.umich.edu# documentation and/or other materials provided with the distribution; 113101Sstever@eecs.umich.edu# neither the name of the copyright holders nor the names of its 123101Sstever@eecs.umich.edu# contributors may be used to endorse or promote products derived from 133101Sstever@eecs.umich.edu# this software without specific prior written permission. 143101Sstever@eecs.umich.edu# 153101Sstever@eecs.umich.edu# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 163101Sstever@eecs.umich.edu# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 173101Sstever@eecs.umich.edu# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 183101Sstever@eecs.umich.edu# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 193101Sstever@eecs.umich.edu# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 203101Sstever@eecs.umich.edu# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 213101Sstever@eecs.umich.edu# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 223101Sstever@eecs.umich.edu# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 233101Sstever@eecs.umich.edu# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 243101Sstever@eecs.umich.edu# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 253101Sstever@eecs.umich.edu# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 263101Sstever@eecs.umich.edu# 273101Sstever@eecs.umich.edu# Authors: Steve Reinhardt 283101Sstever@eecs.umich.edu# Nathan Binkert 293101Sstever@eecs.umich.edu 303101Sstever@eecs.umich.edu##################################################################### 313101Sstever@eecs.umich.edu# 323101Sstever@eecs.umich.edu# Parameter description classes 333101Sstever@eecs.umich.edu# 343101Sstever@eecs.umich.edu# The _params dictionary in each class maps parameter names to either 353101Sstever@eecs.umich.edu# a Param or a VectorParam object. These objects contain the 363101Sstever@eecs.umich.edu# parameter description string, the parameter type, and the default 373101Sstever@eecs.umich.edu# value (if any). The convert() method on these objects is used to 383101Sstever@eecs.umich.edu# force whatever value is assigned to the parameter to the appropriate 393101Sstever@eecs.umich.edu# type. 403101Sstever@eecs.umich.edu# 413101Sstever@eecs.umich.edu# Note that the default values are loaded into the class's attribute 423101Sstever@eecs.umich.edu# space when the parameter dictionary is initialized (in 433101Sstever@eecs.umich.edu# MetaSimObject._new_param()); after that point they aren't used. 443101Sstever@eecs.umich.edu# 453101Sstever@eecs.umich.edu##################################################################### 463101Sstever@eecs.umich.edu 473885Sbinkertn@umich.eduimport copy 483885Sbinkertn@umich.eduimport datetime 493885Sbinkertn@umich.eduimport inspect 504762Snate@binkert.orgimport sys 513885Sbinkertn@umich.eduimport time 523885Sbinkertn@umich.edu 533885Sbinkertn@umich.eduimport convert 543101Sstever@eecs.umich.eduimport ticks 554380Sbinkertn@umich.edufrom util import * 564167Sbinkertn@umich.edu 573102Sstever@eecs.umich.edu# Dummy base class to identify types that are legitimate for SimObject 583101Sstever@eecs.umich.edu# parameters. 594762Snate@binkert.orgclass ParamValue(object): 604762Snate@binkert.org 614762Snate@binkert.org cxx_predecls = [] 624762Snate@binkert.org swig_predecls = [] 634762Snate@binkert.org 644762Snate@binkert.org # default for printing to .ini file is regular string conversion. 654762Snate@binkert.org # will be overridden in some cases 664762Snate@binkert.org def ini_str(self): 674762Snate@binkert.org return str(self) 684762Snate@binkert.org 694762Snate@binkert.org # allows us to blithely call unproxy() on things without checking 703101Sstever@eecs.umich.edu # if they're really proxies or not 713101Sstever@eecs.umich.edu def unproxy(self, base): 723101Sstever@eecs.umich.edu return self 733101Sstever@eecs.umich.edu 743101Sstever@eecs.umich.edu# Regular parameter description. 753101Sstever@eecs.umich.educlass ParamDesc(object): 763101Sstever@eecs.umich.edu def __init__(self, ptype_str, ptype, *args, **kwargs): 773101Sstever@eecs.umich.edu self.ptype_str = ptype_str 783101Sstever@eecs.umich.edu # remember ptype only if it is provided 793101Sstever@eecs.umich.edu if ptype != None: 803101Sstever@eecs.umich.edu self.ptype = ptype 813101Sstever@eecs.umich.edu 823101Sstever@eecs.umich.edu if args: 833101Sstever@eecs.umich.edu if len(args) == 1: 843101Sstever@eecs.umich.edu self.desc = args[0] 853101Sstever@eecs.umich.edu elif len(args) == 2: 863101Sstever@eecs.umich.edu self.default = args[0] 873101Sstever@eecs.umich.edu self.desc = args[1] 883101Sstever@eecs.umich.edu else: 893101Sstever@eecs.umich.edu raise TypeError, 'too many arguments' 903101Sstever@eecs.umich.edu 913101Sstever@eecs.umich.edu if kwargs.has_key('desc'): 923101Sstever@eecs.umich.edu assert(not hasattr(self, 'desc')) 933101Sstever@eecs.umich.edu self.desc = kwargs['desc'] 943101Sstever@eecs.umich.edu del kwargs['desc'] 953101Sstever@eecs.umich.edu 963101Sstever@eecs.umich.edu if kwargs.has_key('default'): 973101Sstever@eecs.umich.edu assert(not hasattr(self, 'default')) 983101Sstever@eecs.umich.edu self.default = kwargs['default'] 993101Sstever@eecs.umich.edu del kwargs['default'] 1003101Sstever@eecs.umich.edu 1013101Sstever@eecs.umich.edu if kwargs: 1023101Sstever@eecs.umich.edu raise TypeError, 'extra unknown kwargs %s' % kwargs 1033101Sstever@eecs.umich.edu 1043101Sstever@eecs.umich.edu if not hasattr(self, 'desc'): 1053101Sstever@eecs.umich.edu raise TypeError, 'desc attribute missing' 1063101Sstever@eecs.umich.edu 1073101Sstever@eecs.umich.edu def __getattr__(self, attr): 1083101Sstever@eecs.umich.edu if attr == 'ptype': 1093101Sstever@eecs.umich.edu try: 1103101Sstever@eecs.umich.edu ptype = eval(self.ptype_str, objects.__dict__) 1113101Sstever@eecs.umich.edu if not isinstance(ptype, type): 1123101Sstever@eecs.umich.edu raise NameError 1133101Sstever@eecs.umich.edu self.ptype = ptype 1143101Sstever@eecs.umich.edu return ptype 1153101Sstever@eecs.umich.edu except NameError: 1163101Sstever@eecs.umich.edu raise TypeError, \ 1173101Sstever@eecs.umich.edu "Param qualifier '%s' is not a type" % self.ptype_str 1183101Sstever@eecs.umich.edu raise AttributeError, "'%s' object has no attribute '%s'" % \ 1193101Sstever@eecs.umich.edu (type(self).__name__, attr) 1203101Sstever@eecs.umich.edu 1213101Sstever@eecs.umich.edu def convert(self, value): 1223101Sstever@eecs.umich.edu if isinstance(value, proxy.BaseProxy): 1234762Snate@binkert.org value.set_param_desc(self) 1243101Sstever@eecs.umich.edu return value 1253102Sstever@eecs.umich.edu if not hasattr(self, 'ptype') and isNullPointer(value): 1263101Sstever@eecs.umich.edu # deferred evaluation of SimObject; continue to defer if 1273101Sstever@eecs.umich.edu # we're just assigning a null pointer 1283101Sstever@eecs.umich.edu return value 1294762Snate@binkert.org if isinstance(value, self.ptype): 1304762Snate@binkert.org return value 1314762Snate@binkert.org if isNullPointer(value) and isSimObjectClass(self.ptype): 1323101Sstever@eecs.umich.edu return value 1333101Sstever@eecs.umich.edu return self.ptype(value) 1343101Sstever@eecs.umich.edu 1353101Sstever@eecs.umich.edu def cxx_predecls(self): 1363101Sstever@eecs.umich.edu return self.ptype.cxx_predecls 1373101Sstever@eecs.umich.edu 1383101Sstever@eecs.umich.edu def swig_predecls(self): 1393101Sstever@eecs.umich.edu return self.ptype.swig_predecls 1403101Sstever@eecs.umich.edu 1413101Sstever@eecs.umich.edu def cxx_decl(self): 1423101Sstever@eecs.umich.edu return '%s %s;' % (self.ptype.cxx_type, self.name) 1433101Sstever@eecs.umich.edu 1443101Sstever@eecs.umich.edu# Vector-valued parameter description. Just like ParamDesc, except 1453102Sstever@eecs.umich.edu# that the value is a vector (list) of the specified type instead of a 1463101Sstever@eecs.umich.edu# single value. 1473101Sstever@eecs.umich.edu 1483101Sstever@eecs.umich.educlass VectorParamValue(list): 1493101Sstever@eecs.umich.edu def ini_str(self): 1503101Sstever@eecs.umich.edu return ' '.join([v.ini_str() for v in self]) 1513101Sstever@eecs.umich.edu 1523101Sstever@eecs.umich.edu def unproxy(self, base): 1533101Sstever@eecs.umich.edu return [v.unproxy(base) for v in self] 1543101Sstever@eecs.umich.edu 1553101Sstever@eecs.umich.educlass SimObjVector(VectorParamValue): 1563101Sstever@eecs.umich.edu def print_ini(self): 1573101Sstever@eecs.umich.edu for v in self: 1583101Sstever@eecs.umich.edu v.print_ini() 1593101Sstever@eecs.umich.edu 1603101Sstever@eecs.umich.educlass VectorParamDesc(ParamDesc): 1613101Sstever@eecs.umich.edu # Convert assigned value to appropriate type. If the RHS is not a 1623101Sstever@eecs.umich.edu # list or tuple, it generates a single-element list. 1633101Sstever@eecs.umich.edu def convert(self, value): 1643101Sstever@eecs.umich.edu if isinstance(value, (list, tuple)): 1653101Sstever@eecs.umich.edu # list: coerce each element into new list 1664762Snate@binkert.org tmp_list = [ ParamDesc.convert(self, v) for v in value ] 1674762Snate@binkert.org if isSimObjectSequence(tmp_list): 1684762Snate@binkert.org return SimObjVector(tmp_list) 1693101Sstever@eecs.umich.edu else: 1703101Sstever@eecs.umich.edu return VectorParamValue(tmp_list) 1713101Sstever@eecs.umich.edu else: 1723101Sstever@eecs.umich.edu # singleton: leave it be (could coerce to a single-element 1733101Sstever@eecs.umich.edu # list here, but for some historical reason we don't... 1743101Sstever@eecs.umich.edu return ParamDesc.convert(self, value) 1753101Sstever@eecs.umich.edu 1763101Sstever@eecs.umich.edu def cxx_predecls(self): 1773101Sstever@eecs.umich.edu return ['#include <vector>'] + self.ptype.cxx_predecls 1783101Sstever@eecs.umich.edu 1793101Sstever@eecs.umich.edu def swig_predecls(self): 1803101Sstever@eecs.umich.edu return ['%include "std_vector.i"'] + self.ptype.swig_predecls 1813101Sstever@eecs.umich.edu 1823101Sstever@eecs.umich.edu def cxx_decl(self): 1833101Sstever@eecs.umich.edu return 'std::vector< %s > %s;' % (self.ptype.cxx_type, self.name) 1843101Sstever@eecs.umich.edu 1854762Snate@binkert.orgclass ParamFactory(object): 1864762Snate@binkert.org def __init__(self, param_desc_class, ptype_str = None): 1874762Snate@binkert.org self.param_desc_class = param_desc_class 1884762Snate@binkert.org self.ptype_str = ptype_str 1894762Snate@binkert.org 1904762Snate@binkert.org def __getattr__(self, attr): 1914762Snate@binkert.org if self.ptype_str: 1924762Snate@binkert.org attr = self.ptype_str + '.' + attr 1934762Snate@binkert.org return ParamFactory(self.param_desc_class, attr) 1944762Snate@binkert.org 1954762Snate@binkert.org # E.g., Param.Int(5, "number of widgets") 1964762Snate@binkert.org def __call__(self, *args, **kwargs): 1974762Snate@binkert.org caller_frame = inspect.currentframe().f_back 1984762Snate@binkert.org ptype = None 1994762Snate@binkert.org try: 2004762Snate@binkert.org ptype = eval(self.ptype_str, 2013101Sstever@eecs.umich.edu caller_frame.f_globals, caller_frame.f_locals) 2023101Sstever@eecs.umich.edu if not isinstance(ptype, type): 2033101Sstever@eecs.umich.edu raise TypeError, \ 2043101Sstever@eecs.umich.edu "Param qualifier is not a type: %s" % ptype 2053101Sstever@eecs.umich.edu except NameError: 2063101Sstever@eecs.umich.edu # if name isn't defined yet, assume it's a SimObject, and 2073101Sstever@eecs.umich.edu # try to resolve it later 2083101Sstever@eecs.umich.edu pass 2093101Sstever@eecs.umich.edu return self.param_desc_class(self.ptype_str, ptype, *args, **kwargs) 2103101Sstever@eecs.umich.edu 2113101Sstever@eecs.umich.eduParam = ParamFactory(ParamDesc) 2123101Sstever@eecs.umich.eduVectorParam = ParamFactory(VectorParamDesc) 2133101Sstever@eecs.umich.edu 2143101Sstever@eecs.umich.edu##################################################################### 2153101Sstever@eecs.umich.edu# 2163101Sstever@eecs.umich.edu# Parameter Types 2173101Sstever@eecs.umich.edu# 2183101Sstever@eecs.umich.edu# Though native Python types could be used to specify parameter types 2193101Sstever@eecs.umich.edu# (the 'ptype' field of the Param and VectorParam classes), it's more 2203101Sstever@eecs.umich.edu# flexible to define our own set of types. This gives us more control 2213101Sstever@eecs.umich.edu# over how Python expressions are converted to values (via the 2223101Sstever@eecs.umich.edu# __init__() constructor) and how these values are printed out (via 2233101Sstever@eecs.umich.edu# the __str__() conversion method). 2243101Sstever@eecs.umich.edu# 2253101Sstever@eecs.umich.edu##################################################################### 2263101Sstever@eecs.umich.edu 2273101Sstever@eecs.umich.edu# String-valued parameter. Just mixin the ParamValue class with the 2283101Sstever@eecs.umich.edu# built-in str class. 2293101Sstever@eecs.umich.educlass String(ParamValue,str): 2303101Sstever@eecs.umich.edu cxx_type = 'std::string' 2313101Sstever@eecs.umich.edu cxx_predecls = ['#include <string>'] 2323101Sstever@eecs.umich.edu swig_predecls = ['%include "std_string.i"\n' + 2333101Sstever@eecs.umich.edu '%apply const std::string& {std::string *};'] 2343101Sstever@eecs.umich.edu pass 2353101Sstever@eecs.umich.edu 2363101Sstever@eecs.umich.edu# superclass for "numeric" parameter values, to emulate math 2373101Sstever@eecs.umich.edu# operations in a type-safe way. e.g., a Latency times an int returns 2383101Sstever@eecs.umich.edu# a new Latency object. 2393101Sstever@eecs.umich.educlass NumericParamValue(ParamValue): 2403101Sstever@eecs.umich.edu def __str__(self): 2413101Sstever@eecs.umich.edu return str(self.value) 2423101Sstever@eecs.umich.edu 2433101Sstever@eecs.umich.edu def __float__(self): 2443101Sstever@eecs.umich.edu return float(self.value) 2453101Sstever@eecs.umich.edu 2463101Sstever@eecs.umich.edu def __long__(self): 2473101Sstever@eecs.umich.edu return long(self.value) 2483101Sstever@eecs.umich.edu 2493101Sstever@eecs.umich.edu def __int__(self): 2503101Sstever@eecs.umich.edu return int(self.value) 2513101Sstever@eecs.umich.edu 2523101Sstever@eecs.umich.edu # hook for bounds checking 2533101Sstever@eecs.umich.edu def _check(self): 2543101Sstever@eecs.umich.edu return 2553101Sstever@eecs.umich.edu 2563101Sstever@eecs.umich.edu def __mul__(self, other): 2574762Snate@binkert.org newobj = self.__class__(self) 2584762Snate@binkert.org newobj.value *= other 2594762Snate@binkert.org newobj._check() 2604762Snate@binkert.org return newobj 2613101Sstever@eecs.umich.edu 2623101Sstever@eecs.umich.edu __rmul__ = __mul__ 2633101Sstever@eecs.umich.edu 2643101Sstever@eecs.umich.edu def __div__(self, other): 2653101Sstever@eecs.umich.edu newobj = self.__class__(self) 2663101Sstever@eecs.umich.edu newobj.value /= other 2673101Sstever@eecs.umich.edu newobj._check() 2683101Sstever@eecs.umich.edu return newobj 2693101Sstever@eecs.umich.edu 2703101Sstever@eecs.umich.edu def __sub__(self, other): 2713101Sstever@eecs.umich.edu newobj = self.__class__(self) 2723714Sstever@eecs.umich.edu newobj.value -= other 2733714Sstever@eecs.umich.edu newobj._check() 2743714Sstever@eecs.umich.edu return newobj 2753714Sstever@eecs.umich.edu 2763714Sstever@eecs.umich.edu# Metaclass for bounds-checked integer parameters. See CheckedInt. 2773714Sstever@eecs.umich.educlass CheckedIntType(type): 2783101Sstever@eecs.umich.edu def __init__(cls, name, bases, dict): 2793101Sstever@eecs.umich.edu super(CheckedIntType, cls).__init__(name, bases, dict) 2803101Sstever@eecs.umich.edu 2813101Sstever@eecs.umich.edu # CheckedInt is an abstract base class, so we actually don't 2823101Sstever@eecs.umich.edu # want to do any processing on it... the rest of this code is 2833101Sstever@eecs.umich.edu # just for classes that derive from CheckedInt. 2843101Sstever@eecs.umich.edu if name == 'CheckedInt': 2853101Sstever@eecs.umich.edu return 2863101Sstever@eecs.umich.edu 2873101Sstever@eecs.umich.edu if not cls.cxx_predecls: 2883101Sstever@eecs.umich.edu # most derived types require this, so we just do it here once 2893101Sstever@eecs.umich.edu cls.cxx_predecls = ['#include "sim/host.hh"'] 2903101Sstever@eecs.umich.edu 2913101Sstever@eecs.umich.edu if not cls.swig_predecls: 2923101Sstever@eecs.umich.edu # most derived types require this, so we just do it here once 2933101Sstever@eecs.umich.edu cls.swig_predecls = ['%import "python/m5/swig/stdint.i"\n' + 2943101Sstever@eecs.umich.edu '%import "sim/host.hh"'] 2953101Sstever@eecs.umich.edu 2963101Sstever@eecs.umich.edu if not (hasattr(cls, 'min') and hasattr(cls, 'max')): 2973101Sstever@eecs.umich.edu if not (hasattr(cls, 'size') and hasattr(cls, 'unsigned')): 2983101Sstever@eecs.umich.edu panic("CheckedInt subclass %s must define either\n" \ 2993101Sstever@eecs.umich.edu " 'min' and 'max' or 'size' and 'unsigned'\n" \ 3003101Sstever@eecs.umich.edu % name); 3013101Sstever@eecs.umich.edu if cls.unsigned: 3023101Sstever@eecs.umich.edu cls.min = 0 3033101Sstever@eecs.umich.edu cls.max = 2 ** cls.size - 1 3043101Sstever@eecs.umich.edu else: 3053101Sstever@eecs.umich.edu cls.min = -(2 ** (cls.size - 1)) 3063101Sstever@eecs.umich.edu cls.max = (2 ** (cls.size - 1)) - 1 3073101Sstever@eecs.umich.edu 3083101Sstever@eecs.umich.edu# Abstract superclass for bounds-checked integer parameters. This 3093101Sstever@eecs.umich.edu# class is subclassed to generate parameter classes with specific 3103101Sstever@eecs.umich.edu# bounds. Initialization of the min and max bounds is done in the 3113101Sstever@eecs.umich.edu# metaclass CheckedIntType.__init__. 3123101Sstever@eecs.umich.educlass CheckedInt(NumericParamValue): 3133101Sstever@eecs.umich.edu __metaclass__ = CheckedIntType 3143101Sstever@eecs.umich.edu 3153101Sstever@eecs.umich.edu def _check(self): 3163101Sstever@eecs.umich.edu if not self.min <= self.value <= self.max: 3173101Sstever@eecs.umich.edu raise TypeError, 'Integer param out of bounds %d < %d < %d' % \ 3183101Sstever@eecs.umich.edu (self.min, self.value, self.max) 3194762Snate@binkert.org 3203101Sstever@eecs.umich.edu def __init__(self, value): 3213101Sstever@eecs.umich.edu if isinstance(value, str): 3223101Sstever@eecs.umich.edu self.value = convert.toInteger(value) 3233101Sstever@eecs.umich.edu elif isinstance(value, (int, long, float, NumericParamValue)): 3243101Sstever@eecs.umich.edu self.value = long(value) 3253101Sstever@eecs.umich.edu else: 3263101Sstever@eecs.umich.edu raise TypeError, "Can't convert object of type %s to CheckedInt" \ 3273101Sstever@eecs.umich.edu % type(value).__name__ 3283101Sstever@eecs.umich.edu self._check() 3293101Sstever@eecs.umich.edu 3303101Sstever@eecs.umich.educlass Int(CheckedInt): cxx_type = 'int'; size = 32; unsigned = False 3313101Sstever@eecs.umich.educlass Unsigned(CheckedInt): cxx_type = 'unsigned'; size = 32; unsigned = True 3323101Sstever@eecs.umich.edu 3333101Sstever@eecs.umich.educlass Int8(CheckedInt): cxx_type = 'int8_t'; size = 8; unsigned = False 3343101Sstever@eecs.umich.educlass UInt8(CheckedInt): cxx_type = 'uint8_t'; size = 8; unsigned = True 3353101Sstever@eecs.umich.educlass Int16(CheckedInt): cxx_type = 'int16_t'; size = 16; unsigned = False 3363101Sstever@eecs.umich.educlass UInt16(CheckedInt): cxx_type = 'uint16_t'; size = 16; unsigned = True 3373101Sstever@eecs.umich.educlass Int32(CheckedInt): cxx_type = 'int32_t'; size = 32; unsigned = False 3383101Sstever@eecs.umich.educlass UInt32(CheckedInt): cxx_type = 'uint32_t'; size = 32; unsigned = True 3393101Sstever@eecs.umich.educlass Int64(CheckedInt): cxx_type = 'int64_t'; size = 64; unsigned = False 3403101Sstever@eecs.umich.educlass UInt64(CheckedInt): cxx_type = 'uint64_t'; size = 64; unsigned = True 3413101Sstever@eecs.umich.edu 3423101Sstever@eecs.umich.educlass Counter(CheckedInt): cxx_type = 'Counter'; size = 64; unsigned = True 3433101Sstever@eecs.umich.educlass Tick(CheckedInt): cxx_type = 'Tick'; size = 64; unsigned = True 3443101Sstever@eecs.umich.educlass TcpPort(CheckedInt): cxx_type = 'uint16_t'; size = 16; unsigned = True 3453101Sstever@eecs.umich.educlass UdpPort(CheckedInt): cxx_type = 'uint16_t'; size = 16; unsigned = True 3463101Sstever@eecs.umich.edu 3473101Sstever@eecs.umich.educlass Percent(CheckedInt): cxx_type = 'int'; min = 0; max = 100 3483102Sstever@eecs.umich.edu 3493714Sstever@eecs.umich.educlass Float(ParamValue, float): 3503101Sstever@eecs.umich.edu pass 3513714Sstever@eecs.umich.edu 3523714Sstever@eecs.umich.educlass MemorySize(CheckedInt): 3533714Sstever@eecs.umich.edu cxx_type = 'uint64_t' 3543101Sstever@eecs.umich.edu size = 64 3553101Sstever@eecs.umich.edu unsigned = True 3564762Snate@binkert.org def __init__(self, value): 3574762Snate@binkert.org if isinstance(value, MemorySize): 3584762Snate@binkert.org self.value = value.value 3593101Sstever@eecs.umich.edu else: 3603101Sstever@eecs.umich.edu self.value = convert.toMemorySize(value) 3613101Sstever@eecs.umich.edu self._check() 3623101Sstever@eecs.umich.edu 3633101Sstever@eecs.umich.educlass MemorySize32(CheckedInt): 3643101Sstever@eecs.umich.edu cxx_type = 'uint32_t' 3653101Sstever@eecs.umich.edu size = 32 3663101Sstever@eecs.umich.edu unsigned = True 3673101Sstever@eecs.umich.edu def __init__(self, value): 3683101Sstever@eecs.umich.edu if isinstance(value, MemorySize): 3693101Sstever@eecs.umich.edu self.value = value.value 3703101Sstever@eecs.umich.edu else: 3713101Sstever@eecs.umich.edu self.value = convert.toMemorySize(value) 3723101Sstever@eecs.umich.edu self._check() 3733101Sstever@eecs.umich.edu 3743101Sstever@eecs.umich.educlass Addr(CheckedInt): 3753101Sstever@eecs.umich.edu cxx_type = 'Addr' 3763101Sstever@eecs.umich.edu cxx_predecls = ['#include "targetarch/isa_traits.hh"'] 3773101Sstever@eecs.umich.edu size = 64 3783101Sstever@eecs.umich.edu unsigned = True 3794446Sbinkertn@umich.edu def __init__(self, value): 3803101Sstever@eecs.umich.edu if isinstance(value, Addr): 3814762Snate@binkert.org self.value = value.value 3824762Snate@binkert.org else: 3834762Snate@binkert.org try: 3843101Sstever@eecs.umich.edu self.value = convert.toMemorySize(value) 3853101Sstever@eecs.umich.edu except TypeError: 3863101Sstever@eecs.umich.edu self.value = long(value) 3873101Sstever@eecs.umich.edu self._check() 3883101Sstever@eecs.umich.edu def __add__(self, other): 3893101Sstever@eecs.umich.edu if isinstance(other, Addr): 3903101Sstever@eecs.umich.edu return self.value + other.value 3913101Sstever@eecs.umich.edu else: 3923102Sstever@eecs.umich.edu return self.value + other 3933101Sstever@eecs.umich.edu 3943101Sstever@eecs.umich.edu 3953101Sstever@eecs.umich.educlass MetaRange(type): 3964168Sbinkertn@umich.edu def __init__(cls, name, bases, dict): 3973101Sstever@eecs.umich.edu super(MetaRange, cls).__init__(name, bases, dict) 3983101Sstever@eecs.umich.edu if name == 'Range': 3993101Sstever@eecs.umich.edu return 4003101Sstever@eecs.umich.edu cls.cxx_type = 'Range< %s >' % cls.type.cxx_type 4013101Sstever@eecs.umich.edu cls.cxx_predecls = \ 4023101Sstever@eecs.umich.edu ['#include "base/range.hh"'] + cls.type.cxx_predecls 4033102Sstever@eecs.umich.edu 4043101Sstever@eecs.umich.educlass Range(ParamValue): 4053101Sstever@eecs.umich.edu __metaclass__ = MetaRange 4063101Sstever@eecs.umich.edu type = Int # default; can be overridden in subclasses 4073101Sstever@eecs.umich.edu def __init__(self, *args, **kwargs): 4084762Snate@binkert.org def handle_kwargs(self, kwargs): 4093101Sstever@eecs.umich.edu if 'end' in kwargs: 4103101Sstever@eecs.umich.edu self.second = self.type(kwargs.pop('end')) 4113101Sstever@eecs.umich.edu elif 'size' in kwargs: 4123101Sstever@eecs.umich.edu self.second = self.first + self.type(kwargs.pop('size')) - 1 4133101Sstever@eecs.umich.edu else: 4143101Sstever@eecs.umich.edu raise TypeError, "Either end or size must be specified" 4153101Sstever@eecs.umich.edu 4163102Sstever@eecs.umich.edu if len(args) == 0: 4173101Sstever@eecs.umich.edu self.first = self.type(kwargs.pop('start')) 4183101Sstever@eecs.umich.edu handle_kwargs(self, kwargs) 4193101Sstever@eecs.umich.edu 4203584Ssaidi@eecs.umich.edu elif len(args) == 1: 4213584Ssaidi@eecs.umich.edu if kwargs: 4223584Ssaidi@eecs.umich.edu self.first = self.type(args[0]) 4233584Ssaidi@eecs.umich.edu handle_kwargs(self, kwargs) 4243584Ssaidi@eecs.umich.edu elif isinstance(args[0], Range): 4253101Sstever@eecs.umich.edu self.first = self.type(args[0].first) 4263101Sstever@eecs.umich.edu self.second = self.type(args[0].second) 4273101Sstever@eecs.umich.edu else: 4283101Sstever@eecs.umich.edu self.first = self.type(0) 4293101Sstever@eecs.umich.edu self.second = self.type(args[0]) - 1 4303101Sstever@eecs.umich.edu 4313101Sstever@eecs.umich.edu elif len(args) == 2: 4323101Sstever@eecs.umich.edu self.first = self.type(args[0]) 4333101Sstever@eecs.umich.edu self.second = self.type(args[1]) 4343101Sstever@eecs.umich.edu else: 4353101Sstever@eecs.umich.edu raise TypeError, "Too many arguments specified" 4363101Sstever@eecs.umich.edu 4373101Sstever@eecs.umich.edu if kwargs: 4383101Sstever@eecs.umich.edu raise TypeError, "too many keywords: %s" % kwargs.keys() 4393101Sstever@eecs.umich.edu 4403101Sstever@eecs.umich.edu def __str__(self): 4413101Sstever@eecs.umich.edu return '%s:%s' % (self.first, self.second) 4423101Sstever@eecs.umich.edu 4433101Sstever@eecs.umich.educlass AddrRange(Range): 4443101Sstever@eecs.umich.edu type = Addr 4453101Sstever@eecs.umich.edu 4463101Sstever@eecs.umich.educlass TickRange(Range): 4473101Sstever@eecs.umich.edu type = Tick 4483101Sstever@eecs.umich.edu 4493101Sstever@eecs.umich.edu# Boolean parameter type. Python doesn't let you subclass bool, since 4503101Sstever@eecs.umich.edu# it doesn't want to let you create multiple instances of True and 4513101Sstever@eecs.umich.edu# False. Thus this is a little more complicated than String. 4523101Sstever@eecs.umich.educlass Bool(ParamValue): 4533101Sstever@eecs.umich.edu cxx_type = 'bool' 4543101Sstever@eecs.umich.edu def __init__(self, value): 4553101Sstever@eecs.umich.edu try: 4563101Sstever@eecs.umich.edu self.value = convert.toBool(value) 4573101Sstever@eecs.umich.edu except TypeError: 4583101Sstever@eecs.umich.edu self.value = bool(value) 4593101Sstever@eecs.umich.edu 4603101Sstever@eecs.umich.edu def __str__(self): 4613101Sstever@eecs.umich.edu return str(self.value) 4623101Sstever@eecs.umich.edu 4633101Sstever@eecs.umich.edu def ini_str(self): 4643101Sstever@eecs.umich.edu if self.value: 4653101Sstever@eecs.umich.edu return 'true' 4663101Sstever@eecs.umich.edu return 'false' 4673101Sstever@eecs.umich.edu 4683101Sstever@eecs.umich.edudef IncEthernetAddr(addr, val = 1): 4693101Sstever@eecs.umich.edu bytes = map(lambda x: int(x, 16), addr.split(':')) 4703101Sstever@eecs.umich.edu bytes[5] += val 4713101Sstever@eecs.umich.edu for i in (5, 4, 3, 2, 1): 4723101Sstever@eecs.umich.edu val,rem = divmod(bytes[i], 256) 4733101Sstever@eecs.umich.edu bytes[i] = rem 4743101Sstever@eecs.umich.edu if val == 0: 4753101Sstever@eecs.umich.edu break 4763101Sstever@eecs.umich.edu bytes[i - 1] += val 4774762Snate@binkert.org assert(bytes[0] <= 255) 4784762Snate@binkert.org return ':'.join(map(lambda x: '%02x' % x, bytes)) 4794762Snate@binkert.org 4804762Snate@binkert.orgclass NextEthernetAddr(object): 4814762Snate@binkert.org addr = "00:90:00:00:00:01" 4824762Snate@binkert.org 4834762Snate@binkert.org def __init__(self, inc = 1): 4844762Snate@binkert.org self.value = NextEthernetAddr.addr 4854762Snate@binkert.org NextEthernetAddr.addr = IncEthernetAddr(NextEthernetAddr.addr, inc) 4863101Sstever@eecs.umich.edu 4873101Sstever@eecs.umich.educlass EthernetAddr(ParamValue): 4883101Sstever@eecs.umich.edu cxx_type = 'Net::EthAddr' 4894762Snate@binkert.org cxx_predecls = ['#include "base/inet.hh"'] 4904762Snate@binkert.org swig_predecls = ['class Net::EthAddr;'] 4914762Snate@binkert.org def __init__(self, value): 4924762Snate@binkert.org if value == NextEthernetAddr: 4934762Snate@binkert.org self.value = value 4944762Snate@binkert.org return 4954762Snate@binkert.org 4964762Snate@binkert.org if not isinstance(value, str): 4974762Snate@binkert.org raise TypeError, "expected an ethernet address and didn't get one" 4983101Sstever@eecs.umich.edu 4993101Sstever@eecs.umich.edu bytes = value.split(':') 5003101Sstever@eecs.umich.edu if len(bytes) != 6: 5013101Sstever@eecs.umich.edu raise TypeError, 'invalid ethernet address %s' % value 5023101Sstever@eecs.umich.edu 5033101Sstever@eecs.umich.edu for byte in bytes: 5043101Sstever@eecs.umich.edu if not 0 <= int(byte) <= 256: 5053101Sstever@eecs.umich.edu raise TypeError, 'invalid ethernet address %s' % value 5063102Sstever@eecs.umich.edu 5073101Sstever@eecs.umich.edu self.value = value 5083101Sstever@eecs.umich.edu 5093101Sstever@eecs.umich.edu def unproxy(self, base): 5104762Snate@binkert.org if self.value == NextEthernetAddr: 5114762Snate@binkert.org self.addr = self.value().value 5124762Snate@binkert.org return self 5133101Sstever@eecs.umich.edu 5143101Sstever@eecs.umich.edu def __str__(self): 5153101Sstever@eecs.umich.edu if self.value == NextEthernetAddr: 5163101Sstever@eecs.umich.edu if hasattr(self, 'addr'): 5173101Sstever@eecs.umich.edu return self.addr 5183101Sstever@eecs.umich.edu else: 5193101Sstever@eecs.umich.edu return "NextEthernetAddr (unresolved)" 5203101Sstever@eecs.umich.edu else: 5213101Sstever@eecs.umich.edu return self.value 5223101Sstever@eecs.umich.edu 5233101Sstever@eecs.umich.edutime_formats = [ "%a %b %d %H:%M:%S %Z %Y", 5243101Sstever@eecs.umich.edu "%a %b %d %H:%M:%S %Z %Y", 5253101Sstever@eecs.umich.edu "%Y/%m/%d %H:%M:%S", 5263101Sstever@eecs.umich.edu "%Y/%m/%d %H:%M", 5273101Sstever@eecs.umich.edu "%Y/%m/%d", 5283101Sstever@eecs.umich.edu "%m/%d/%Y %H:%M:%S", 5293101Sstever@eecs.umich.edu "%m/%d/%Y %H:%M", 5303101Sstever@eecs.umich.edu "%m/%d/%Y", 5313101Sstever@eecs.umich.edu "%m/%d/%y %H:%M:%S", 5323101Sstever@eecs.umich.edu "%m/%d/%y %H:%M", 5334380Sbinkertn@umich.edu "%m/%d/%y"] 5344380Sbinkertn@umich.edu 5354380Sbinkertn@umich.edu 5363101Sstever@eecs.umich.edudef parse_time(value): 5374380Sbinkertn@umich.edu from time import gmtime, strptime, struct_time, time 5384380Sbinkertn@umich.edu from datetime import datetime, date 5394380Sbinkertn@umich.edu 5403101Sstever@eecs.umich.edu if isinstance(value, struct_time): 5413101Sstever@eecs.umich.edu return value 5423101Sstever@eecs.umich.edu 5433101Sstever@eecs.umich.edu if isinstance(value, (int, long)): 5444762Snate@binkert.org return gmtime(value) 5453101Sstever@eecs.umich.edu 5463101Sstever@eecs.umich.edu if isinstance(value, (datetime, date)): 5473101Sstever@eecs.umich.edu return value.timetuple() 5483101Sstever@eecs.umich.edu 5493101Sstever@eecs.umich.edu if isinstance(value, str): 5503101Sstever@eecs.umich.edu if value in ('Now', 'Today'): 5513101Sstever@eecs.umich.edu return time.gmtime(time.time()) 5523101Sstever@eecs.umich.edu 5533101Sstever@eecs.umich.edu for format in time_formats: 5543101Sstever@eecs.umich.edu try: 5553101Sstever@eecs.umich.edu return strptime(value, format) 5563101Sstever@eecs.umich.edu except ValueError: 5573101Sstever@eecs.umich.edu pass 5583101Sstever@eecs.umich.edu 5593101Sstever@eecs.umich.edu raise ValueError, "Could not parse '%s' as a time" % value 5603101Sstever@eecs.umich.edu 5613101Sstever@eecs.umich.educlass Time(ParamValue): 5623101Sstever@eecs.umich.edu cxx_type = 'time_t' 5633101Sstever@eecs.umich.edu def __init__(self, value): 5643101Sstever@eecs.umich.edu self.value = parse_time(value) 5654380Sbinkertn@umich.edu 5663101Sstever@eecs.umich.edu def __str__(self): 5673101Sstever@eecs.umich.edu tm = self.value 5684762Snate@binkert.org return ' '.join([ str(tm[i]) for i in xrange(8)]) 5694762Snate@binkert.org 5704762Snate@binkert.org def ini_str(self): 5714762Snate@binkert.org return str(self) 5724380Sbinkertn@umich.edu 5734380Sbinkertn@umich.edu# Enumerated types are a little more complex. The user specifies the 5743101Sstever@eecs.umich.edu# type as Enum(foo) where foo is either a list or dictionary of 5753932Sbinkertn@umich.edu# alternatives (typically strings, but not necessarily so). (In the 5763932Sbinkertn@umich.edu# long run, the integer value of the parameter will be the list index 5773932Sbinkertn@umich.edu# or the corresponding dictionary value. For now, since we only check 5783932Sbinkertn@umich.edu# that the alternative is valid and then spit it into a .ini file, 5793932Sbinkertn@umich.edu# there's not much point in using the dictionary.) 5803932Sbinkertn@umich.edu 5813932Sbinkertn@umich.edu# What Enum() must do is generate a new type encapsulating the 5823932Sbinkertn@umich.edu# provided list/dictionary so that specific values of the parameter 5833932Sbinkertn@umich.edu# can be instances of that type. We define two hidden internal 5843932Sbinkertn@umich.edu# classes (_ListEnum and _DictEnum) to serve as base classes, then 5853932Sbinkertn@umich.edu# derive the new type from the appropriate base class on the fly. 5863932Sbinkertn@umich.edu 5873932Sbinkertn@umich.edu 5883885Sbinkertn@umich.edu# Metaclass for Enum types 5893932Sbinkertn@umich.educlass MetaEnum(type): 5903932Sbinkertn@umich.edu def __init__(cls, name, bases, init_dict): 5913885Sbinkertn@umich.edu if init_dict.has_key('map'): 5923932Sbinkertn@umich.edu if not isinstance(cls.map, dict): 5933932Sbinkertn@umich.edu raise TypeError, "Enum-derived class attribute 'map' " \ 5943932Sbinkertn@umich.edu "must be of type dict" 5953932Sbinkertn@umich.edu # build list of value strings from map 5963932Sbinkertn@umich.edu cls.vals = cls.map.keys() 5973932Sbinkertn@umich.edu cls.vals.sort() 5983932Sbinkertn@umich.edu elif init_dict.has_key('vals'): 5993932Sbinkertn@umich.edu if not isinstance(cls.vals, list): 6003932Sbinkertn@umich.edu raise TypeError, "Enum-derived class attribute 'vals' " \ 6013932Sbinkertn@umich.edu "must be of type list" 6023932Sbinkertn@umich.edu # build string->value map from vals sequence 6033932Sbinkertn@umich.edu cls.map = {} 6043932Sbinkertn@umich.edu for idx,val in enumerate(cls.vals): 6053932Sbinkertn@umich.edu cls.map[val] = idx 6063932Sbinkertn@umich.edu else: 6073932Sbinkertn@umich.edu raise TypeError, "Enum-derived class must define "\ 6083932Sbinkertn@umich.edu "attribute 'map' or 'vals'" 6093932Sbinkertn@umich.edu 6103885Sbinkertn@umich.edu cls.cxx_type = name + '::Enum' 6113885Sbinkertn@umich.edu 6123885Sbinkertn@umich.edu super(MetaEnum, cls).__init__(name, bases, init_dict) 6133885Sbinkertn@umich.edu 6144762Snate@binkert.org # Generate C++ class declaration for this enum type. 6154762Snate@binkert.org # Note that we wrap the enum in a class/struct to act as a namespace, 6164762Snate@binkert.org # so that the enum strings can be brief w/o worrying about collisions. 6173885Sbinkertn@umich.edu def cxx_decl(cls): 6183932Sbinkertn@umich.edu s = 'struct %s {\n enum Enum {\n ' % cls.__name__ 6193885Sbinkertn@umich.edu s += ',\n '.join(['%s = %d' % (v,cls.map[v]) for v in cls.vals]) 6204762Snate@binkert.org s += '\n };\n};\n' 6214762Snate@binkert.org return s 6224762Snate@binkert.org 6234762Snate@binkert.org# Base class for enum types. 6244762Snate@binkert.orgclass Enum(ParamValue): 6254762Snate@binkert.org __metaclass__ = MetaEnum 6264762Snate@binkert.org vals = [] 6274762Snate@binkert.org 6284762Snate@binkert.org def __init__(self, value): 6294762Snate@binkert.org if value not in self.map: 6304762Snate@binkert.org raise TypeError, "Enum param got bad value '%s' (not in %s)" \ 6314762Snate@binkert.org % (value, self.vals) 6324762Snate@binkert.org self.value = value 6334762Snate@binkert.org 6344762Snate@binkert.org def __str__(self): 6354762Snate@binkert.org return self.value 6364762Snate@binkert.org 6374762Snate@binkert.org# how big does a rounding error need to be before we warn about it? 6384762Snate@binkert.orgfrequency_tolerance = 0.001 # 0.1% 6394762Snate@binkert.org 6404762Snate@binkert.orgclass TickParamValue(NumericParamValue): 6414762Snate@binkert.org cxx_type = 'Tick' 6424762Snate@binkert.org cxx_predecls = ['#include "sim/host.hh"'] 6434762Snate@binkert.org swig_predecls = ['%import "python/m5/swig/stdint.i"\n' + 6444762Snate@binkert.org '%import "sim/host.hh"'] 6454762Snate@binkert.org 6463885Sbinkertn@umich.educlass Latency(TickParamValue): 6474762Snate@binkert.org def __init__(self, value): 6483885Sbinkertn@umich.edu if isinstance(value, (Latency, Clock)): 6493885Sbinkertn@umich.edu self.ticks = value.ticks 6503932Sbinkertn@umich.edu self.value = value.value 6513885Sbinkertn@umich.edu elif isinstance(value, Frequency): 6523101Sstever@eecs.umich.edu self.ticks = value.ticks 6533101Sstever@eecs.umich.edu self.value = 1.0 / value.value 6543101Sstever@eecs.umich.edu elif value.endswith('t'): 6553101Sstever@eecs.umich.edu self.ticks = True 6563101Sstever@eecs.umich.edu self.value = int(value[:-1]) 6573101Sstever@eecs.umich.edu else: 6583101Sstever@eecs.umich.edu self.ticks = False 6593101Sstever@eecs.umich.edu self.value = convert.toLatency(value) 6603101Sstever@eecs.umich.edu 6613101Sstever@eecs.umich.edu def __getattr__(self, attr): 6623101Sstever@eecs.umich.edu if attr in ('latency', 'period'): 6633101Sstever@eecs.umich.edu return self 6643101Sstever@eecs.umich.edu if attr == 'frequency': 6653101Sstever@eecs.umich.edu return Frequency(self) 6664762Snate@binkert.org raise AttributeError, "Latency object has no attribute '%s'" % attr 6673101Sstever@eecs.umich.edu 6683101Sstever@eecs.umich.edu # convert latency to ticks 6694762Snate@binkert.org def ini_str(self): 6704762Snate@binkert.org if self.ticks or self.value == 0: 6714762Snate@binkert.org return '%d' % self.value 6724762Snate@binkert.org else: 6734762Snate@binkert.org return '%d' % (ticks.fromSeconds(self.value)) 6744762Snate@binkert.org 6754762Snate@binkert.orgclass Frequency(TickParamValue): 6763101Sstever@eecs.umich.edu def __init__(self, value): 6773101Sstever@eecs.umich.edu if isinstance(value, (Latency, Clock)): 6783101Sstever@eecs.umich.edu if value.value == 0: 6793101Sstever@eecs.umich.edu self.value = 0 6803101Sstever@eecs.umich.edu else: 6813101Sstever@eecs.umich.edu self.value = 1.0 / value.value 6823101Sstever@eecs.umich.edu self.ticks = value.ticks 6833101Sstever@eecs.umich.edu elif isinstance(value, Frequency): 6843101Sstever@eecs.umich.edu self.value = value.value 6853101Sstever@eecs.umich.edu self.ticks = value.ticks 6863101Sstever@eecs.umich.edu else: 6873101Sstever@eecs.umich.edu self.ticks = False 6883101Sstever@eecs.umich.edu self.value = convert.toFrequency(value) 6893101Sstever@eecs.umich.edu 6903101Sstever@eecs.umich.edu def __getattr__(self, attr): 6913101Sstever@eecs.umich.edu if attr == 'frequency': 6923101Sstever@eecs.umich.edu return self 6933101Sstever@eecs.umich.edu if attr in ('latency', 'period'): 6943101Sstever@eecs.umich.edu return Latency(self) 6953101Sstever@eecs.umich.edu raise AttributeError, "Frequency object has no attribute '%s'" % attr 6964762Snate@binkert.org 6973101Sstever@eecs.umich.edu # convert latency to ticks 6983101Sstever@eecs.umich.edu def ini_str(self): 6993101Sstever@eecs.umich.edu if self.ticks or self.value == 0: 7004762Snate@binkert.org return '%d' % self.value 7014762Snate@binkert.org else: 7024762Snate@binkert.org return '%d' % (ticks.fromSeconds(1.0 / self.value)) 7033101Sstever@eecs.umich.edu 7043101Sstever@eecs.umich.edu# A generic frequency and/or Latency value. Value is stored as a latency, 7053101Sstever@eecs.umich.edu# but to avoid ambiguity this object does not support numeric ops (* or /). 7063101Sstever@eecs.umich.edu# An explicit conversion to a Latency or Frequency must be made first. 7074762Snate@binkert.orgclass Clock(ParamValue): 7084762Snate@binkert.org cxx_type = 'Tick' 7094762Snate@binkert.org cxx_predecls = ['#include "sim/host.hh"'] 7104762Snate@binkert.org swig_predecls = ['%import "python/m5/swig/stdint.i"\n' + 7114762Snate@binkert.org '%import "sim/host.hh"'] 7124762Snate@binkert.org def __init__(self, value): 7134762Snate@binkert.org if isinstance(value, (Latency, Clock)): 7144762Snate@binkert.org self.ticks = value.ticks 7154762Snate@binkert.org self.value = value.value 7164762Snate@binkert.org elif isinstance(value, Frequency): 7174762Snate@binkert.org self.ticks = value.ticks 7184762Snate@binkert.org self.value = 1.0 / value.value 7194762Snate@binkert.org elif value.endswith('t'): 7204762Snate@binkert.org self.ticks = True 7214762Snate@binkert.org self.value = int(value[:-1]) 7224762Snate@binkert.org else: 7234762Snate@binkert.org self.ticks = False 7244762Snate@binkert.org self.value = convert.anyToLatency(value) 7254762Snate@binkert.org 7264762Snate@binkert.org def __getattr__(self, attr): 7274762Snate@binkert.org if attr == 'frequency': 7284762Snate@binkert.org return Frequency(self) 7294762Snate@binkert.org if attr in ('latency', 'period'): 7304762Snate@binkert.org return Latency(self) 7314762Snate@binkert.org raise AttributeError, "Frequency object has no attribute '%s'" % attr 7323101Sstever@eecs.umich.edu 7333101Sstever@eecs.umich.edu def ini_str(self): 7343101Sstever@eecs.umich.edu return self.period.ini_str() 7353101Sstever@eecs.umich.edu 7363101Sstever@eecs.umich.educlass NetworkBandwidth(float,ParamValue): 7373101Sstever@eecs.umich.edu cxx_type = 'float' 7383101Sstever@eecs.umich.edu def __new__(cls, value): 7393101Sstever@eecs.umich.edu # convert to bits per second 7403101Sstever@eecs.umich.edu val = convert.toNetworkBandwidth(value) 7413101Sstever@eecs.umich.edu return super(cls, NetworkBandwidth).__new__(cls, val) 7423101Sstever@eecs.umich.edu 7433101Sstever@eecs.umich.edu def __str__(self): 7444762Snate@binkert.org return str(self.val) 7454762Snate@binkert.org 7464762Snate@binkert.org def ini_str(self): 7473101Sstever@eecs.umich.edu # convert to seconds per byte 7483101Sstever@eecs.umich.edu value = 8.0 / float(self) 7493101Sstever@eecs.umich.edu # convert to ticks per byte 7503101Sstever@eecs.umich.edu return '%f' % (ticks.fromSeconds(value)) 7513101Sstever@eecs.umich.edu 7523101Sstever@eecs.umich.educlass MemoryBandwidth(float,ParamValue): 7534167Sbinkertn@umich.edu cxx_type = 'float' 7543101Sstever@eecs.umich.edu def __new__(self, value): 7553101Sstever@eecs.umich.edu # we want the number of ticks per byte of data 7564762Snate@binkert.org val = convert.toMemoryBandwidth(value) 7573101Sstever@eecs.umich.edu return super(cls, MemoryBandwidth).__new__(cls, val) 7584167Sbinkertn@umich.edu 7594762Snate@binkert.org def __str__(self): 7604762Snate@binkert.org return str(self.val) 7614762Snate@binkert.org 7624167Sbinkertn@umich.edu def ini_str(self): 7633101Sstever@eecs.umich.edu # convert to seconds per byte 7644167Sbinkertn@umich.edu value = 1.0 / float(self) 7654167Sbinkertn@umich.edu # convert to ticks per byte 7664167Sbinkertn@umich.edu return '%f' % (ticks.fromSeconds(value)) 7674167Sbinkertn@umich.edu 7684167Sbinkertn@umich.edu# 7694167Sbinkertn@umich.edu# "Constants"... handy aliases for various values. 7704167Sbinkertn@umich.edu# 7714167Sbinkertn@umich.edu 7724167Sbinkertn@umich.edu# Special class for NULL pointers. Note the special check in 7734167Sbinkertn@umich.edu# make_param_value() above that lets these be assigned where a 7744167Sbinkertn@umich.edu# SimObject is required. 7754167Sbinkertn@umich.edu# only one copy of a particular node 7763101Sstever@eecs.umich.educlass NullSimObject(object): 7773101Sstever@eecs.umich.edu __metaclass__ = Singleton 7783101Sstever@eecs.umich.edu 7793101Sstever@eecs.umich.edu def __call__(cls): 7803101Sstever@eecs.umich.edu return cls 7813101Sstever@eecs.umich.edu 7823101Sstever@eecs.umich.edu def _instantiate(self, parent = None, path = ''): 7833101Sstever@eecs.umich.edu pass 7844762Snate@binkert.org 7854762Snate@binkert.org def ini_str(self): 7864762Snate@binkert.org return 'Null' 7874762Snate@binkert.org 7884762Snate@binkert.org def unproxy(self, base): 7894762Snate@binkert.org return self 7904762Snate@binkert.org 7913101Sstever@eecs.umich.edu def set_path(self, parent, name): 7923101Sstever@eecs.umich.edu pass 7934762Snate@binkert.org def __str__(self): 7943101Sstever@eecs.umich.edu return 'Null' 7954167Sbinkertn@umich.edu 7963101Sstever@eecs.umich.edu# The only instance you'll ever need... 7974167Sbinkertn@umich.eduNULL = NullSimObject() 7984167Sbinkertn@umich.edu 7994167Sbinkertn@umich.edudef isNullPointer(value): 8004167Sbinkertn@umich.edu return isinstance(value, NullSimObject) 8014167Sbinkertn@umich.edu 8024167Sbinkertn@umich.edu# Some memory range specifications use this as a default upper bound. 8034167Sbinkertn@umich.eduMaxAddr = Addr.max 8044167Sbinkertn@umich.eduMaxTick = Tick.max 8054167Sbinkertn@umich.eduAllMemory = AddrRange(0, MaxAddr) 8064167Sbinkertn@umich.edu 8074167Sbinkertn@umich.edu 8084167Sbinkertn@umich.edu##################################################################### 8093101Sstever@eecs.umich.edu# 8103101Sstever@eecs.umich.edu# Port objects 8113101Sstever@eecs.umich.edu# 8123101Sstever@eecs.umich.edu# Ports are used to interconnect objects in the memory system. 8133101Sstever@eecs.umich.edu# 8143101Sstever@eecs.umich.edu##################################################################### 8153101Sstever@eecs.umich.edu 8163101Sstever@eecs.umich.edu# Port reference: encapsulates a reference to a particular port on a 8174167Sbinkertn@umich.edu# particular SimObject. 8184762Snate@binkert.orgclass PortRef(object): 8194762Snate@binkert.org def __init__(self, simobj, name): 8204762Snate@binkert.org assert(isSimObject(simobj) or isSimObjectClass(simobj)) 8214762Snate@binkert.org self.simobj = simobj 8224762Snate@binkert.org self.name = name 8234762Snate@binkert.org self.peer = None # not associated with another port yet 8244762Snate@binkert.org self.ccConnected = False # C++ port connection done? 8253101Sstever@eecs.umich.edu self.index = -1 # always -1 for non-vector ports 8264762Snate@binkert.org 8273101Sstever@eecs.umich.edu def __str__(self): 8283101Sstever@eecs.umich.edu return '%s.%s' % (self.simobj, self.name) 8293101Sstever@eecs.umich.edu 8303101Sstever@eecs.umich.edu # for config.ini, print peer's name (not ours) 8313101Sstever@eecs.umich.edu def ini_str(self): 8323101Sstever@eecs.umich.edu return str(self.peer) 8333101Sstever@eecs.umich.edu 8344762Snate@binkert.org def __getattr__(self, attr): 8353101Sstever@eecs.umich.edu if attr == 'peerObj': 8363101Sstever@eecs.umich.edu # shorthand for proxies 8374167Sbinkertn@umich.edu return self.peer.simobj 8384167Sbinkertn@umich.edu raise AttributeError, "'%s' object has no attribute '%s'" % \ 8394167Sbinkertn@umich.edu (self.__class__.__name__, attr) 8404167Sbinkertn@umich.edu 8414167Sbinkertn@umich.edu # Full connection is symmetric (both ways). Called via 8424167Sbinkertn@umich.edu # SimObject.__setattr__ as a result of a port assignment, e.g., 8434167Sbinkertn@umich.edu # "obj1.portA = obj2.portB", or via VectorPortElementRef.__setitem__, 8444167Sbinkertn@umich.edu # e.g., "obj1.portA[3] = obj2.portB". 8454167Sbinkertn@umich.edu def connect(self, other): 8464167Sbinkertn@umich.edu if isinstance(other, VectorPortRef): 8474167Sbinkertn@umich.edu # reference to plain VectorPort is implicit append 8484167Sbinkertn@umich.edu other = other._get_next() 8493101Sstever@eecs.umich.edu if self.peer and not proxy.isproxy(self.peer): 8503101Sstever@eecs.umich.edu print "warning: overwriting port", self, \ 8513101Sstever@eecs.umich.edu "value", self.peer, "with", other 8523101Sstever@eecs.umich.edu self.peer = other 8533101Sstever@eecs.umich.edu if proxy.isproxy(other): 8543101Sstever@eecs.umich.edu other.set_param_desc(PortParamDesc()) 8553101Sstever@eecs.umich.edu elif isinstance(other, PortRef): 8563101Sstever@eecs.umich.edu if other.peer is not self: 8574762Snate@binkert.org other.connect(self) 8584762Snate@binkert.org else: 8594762Snate@binkert.org raise TypeError, \ 8603101Sstever@eecs.umich.edu "assigning non-port reference '%s' to port '%s'" \ 8613101Sstever@eecs.umich.edu % (other, self) 8623101Sstever@eecs.umich.edu 8633101Sstever@eecs.umich.edu def clone(self, simobj, memo): 8643101Sstever@eecs.umich.edu if memo.has_key(self): 8653101Sstever@eecs.umich.edu return memo[self] 8664167Sbinkertn@umich.edu newRef = copy.copy(self) 8674167Sbinkertn@umich.edu memo[self] = newRef 8683101Sstever@eecs.umich.edu newRef.simobj = simobj 8693101Sstever@eecs.umich.edu assert(isSimObject(newRef.simobj)) 8703101Sstever@eecs.umich.edu if self.peer and not proxy.isproxy(self.peer): 8713101Sstever@eecs.umich.edu peerObj = self.peer.simobj(_memo=memo) 8723101Sstever@eecs.umich.edu newRef.peer = self.peer.clone(peerObj, memo) 8734762Snate@binkert.org assert(not isinstance(newRef.peer, VectorPortRef)) 8744167Sbinkertn@umich.edu return newRef 8754167Sbinkertn@umich.edu 8764167Sbinkertn@umich.edu def unproxy(self, simobj): 8774762Snate@binkert.org assert(simobj is self.simobj) 8784762Snate@binkert.org if proxy.isproxy(self.peer): 8794762Snate@binkert.org try: 8804762Snate@binkert.org realPeer = self.peer.unproxy(self.simobj) 8814762Snate@binkert.org except: 8823101Sstever@eecs.umich.edu print "Error in unproxying port '%s' of %s" % \ 8833101Sstever@eecs.umich.edu (self.name, self.simobj.path()) 8843101Sstever@eecs.umich.edu raise 8853101Sstever@eecs.umich.edu self.connect(realPeer) 8864167Sbinkertn@umich.edu 8873102Sstever@eecs.umich.edu # Call C++ to create corresponding port connection between C++ objects 8883101Sstever@eecs.umich.edu def ccConnect(self): 8893101Sstever@eecs.umich.edu if self.ccConnected: # already done this 8903101Sstever@eecs.umich.edu return 8913101Sstever@eecs.umich.edu peer = self.peer 8923101Sstever@eecs.umich.edu internal.sim_object.connectPorts(self.simobj.getCCObject(), self.name, 8934762Snate@binkert.org self.index, peer.simobj.getCCObject(), peer.name, peer.index) 8944167Sbinkertn@umich.edu self.ccConnected = True 8954167Sbinkertn@umich.edu peer.ccConnected = True 8964167Sbinkertn@umich.edu 8974762Snate@binkert.org# A reference to an individual element of a VectorPort... much like a 8984762Snate@binkert.org# PortRef, but has an index. 8994762Snate@binkert.orgclass VectorPortElementRef(PortRef): 9004762Snate@binkert.org def __init__(self, simobj, name, index): 9014762Snate@binkert.org PortRef.__init__(self, simobj, name) 9023101Sstever@eecs.umich.edu self.index = index 9033101Sstever@eecs.umich.edu 9043101Sstever@eecs.umich.edu def __str__(self): 9053101Sstever@eecs.umich.edu return '%s.%s[%d]' % (self.simobj, self.name, self.index) 9063101Sstever@eecs.umich.edu 9073102Sstever@eecs.umich.edu# A reference to a complete vector-valued port (not just a single element). 9083102Sstever@eecs.umich.edu# Can be indexed to retrieve individual VectorPortElementRef instances. 9093102Sstever@eecs.umich.educlass VectorPortRef(object): 9103102Sstever@eecs.umich.edu def __init__(self, simobj, name): 9113102Sstever@eecs.umich.edu assert(isSimObject(simobj) or isSimObjectClass(simobj)) 9123102Sstever@eecs.umich.edu self.simobj = simobj 9133102Sstever@eecs.umich.edu self.name = name 9143102Sstever@eecs.umich.edu self.elements = [] 9153102Sstever@eecs.umich.edu 9163102Sstever@eecs.umich.edu def __str__(self): 9173102Sstever@eecs.umich.edu return '%s.%s[:]' % (self.simobj, self.name) 9183102Sstever@eecs.umich.edu 9193102Sstever@eecs.umich.edu # for config.ini, print peer's name (not ours) 9203102Sstever@eecs.umich.edu def ini_str(self): 9213102Sstever@eecs.umich.edu return ' '.join([el.ini_str() for el in self.elements]) 9223102Sstever@eecs.umich.edu 9233102Sstever@eecs.umich.edu def __getitem__(self, key): 9243102Sstever@eecs.umich.edu if not isinstance(key, int): 9253102Sstever@eecs.umich.edu raise TypeError, "VectorPort index must be integer" 9263102Sstever@eecs.umich.edu if key >= len(self.elements): 9273102Sstever@eecs.umich.edu # need to extend list 9284762Snate@binkert.org ext = [VectorPortElementRef(self.simobj, self.name, i) 9293102Sstever@eecs.umich.edu for i in range(len(self.elements), key+1)] 9303102Sstever@eecs.umich.edu self.elements.extend(ext) 9313102Sstever@eecs.umich.edu return self.elements[key] 9324762Snate@binkert.org 9334762Snate@binkert.org def _get_next(self): 9344762Snate@binkert.org return self[len(self.elements)] 9353102Sstever@eecs.umich.edu 9363102Sstever@eecs.umich.edu def __setitem__(self, key, value): 9373102Sstever@eecs.umich.edu if not isinstance(key, int): 9383102Sstever@eecs.umich.edu raise TypeError, "VectorPort index must be integer" 9393102Sstever@eecs.umich.edu self[key].connect(value) 9403102Sstever@eecs.umich.edu 9413101Sstever@eecs.umich.edu def connect(self, other): 9423101Sstever@eecs.umich.edu if isinstance(other, (list, tuple)): 9433101Sstever@eecs.umich.edu # Assign list of port refs to vector port. 9443101Sstever@eecs.umich.edu # For now, append them... not sure if that's the right semantics 9453101Sstever@eecs.umich.edu # or if it should replace the current vector. 9463101Sstever@eecs.umich.edu for ref in other: 9473101Sstever@eecs.umich.edu self._get_next().connect(ref) 9483101Sstever@eecs.umich.edu else: 9493101Sstever@eecs.umich.edu # scalar assignment to plain VectorPort is implicit append 9503101Sstever@eecs.umich.edu self._get_next().connect(other) 9513101Sstever@eecs.umich.edu 9523101Sstever@eecs.umich.edu def clone(self, simobj, memo): 9533101Sstever@eecs.umich.edu if memo.has_key(self): 9543101Sstever@eecs.umich.edu return memo[self] 9553101Sstever@eecs.umich.edu newRef = copy.copy(self) 9563101Sstever@eecs.umich.edu memo[self] = newRef 9573101Sstever@eecs.umich.edu newRef.simobj = simobj 9583105Sstever@eecs.umich.edu assert(isSimObject(newRef.simobj)) 9593105Sstever@eecs.umich.edu newRef.elements = [el.clone(simobj, memo) for el in self.elements] 9603101Sstever@eecs.umich.edu return newRef 9613101Sstever@eecs.umich.edu 9623101Sstever@eecs.umich.edu def unproxy(self, simobj): 9633101Sstever@eecs.umich.edu [el.unproxy(simobj) for el in self.elements] 9643105Sstever@eecs.umich.edu 9653101Sstever@eecs.umich.edu def ccConnect(self): 9663103Sstever@eecs.umich.edu [el.ccConnect() for el in self.elements] 9673105Sstever@eecs.umich.edu 9683103Sstever@eecs.umich.edu# Port description object. Like a ParamDesc object, this represents a 9693105Sstever@eecs.umich.edu# logical port in the SimObject class, not a particular port on a 9703105Sstever@eecs.umich.edu# SimObject instance. The latter are represented by PortRef objects. 9713105Sstever@eecs.umich.educlass Port(object): 9723105Sstever@eecs.umich.edu # Port("description") or Port(default, "description") 9733105Sstever@eecs.umich.edu def __init__(self, *args): 9743105Sstever@eecs.umich.edu if len(args) == 1: 9753105Sstever@eecs.umich.edu self.desc = args[0] 9763105Sstever@eecs.umich.edu elif len(args) == 2: 9773105Sstever@eecs.umich.edu self.default = args[0] 9783105Sstever@eecs.umich.edu self.desc = args[1] 9793105Sstever@eecs.umich.edu else: 9803105Sstever@eecs.umich.edu raise TypeError, 'wrong number of arguments' 9813105Sstever@eecs.umich.edu # self.name is set by SimObject class on assignment 9823109Sstever@eecs.umich.edu # e.g., pio_port = Port("blah") sets self.name to 'pio_port' 9833105Sstever@eecs.umich.edu 9843105Sstever@eecs.umich.edu # Generate a PortRef for this port on the given SimObject with the 9853105Sstever@eecs.umich.edu # given name 9863105Sstever@eecs.umich.edu def makeRef(self, simobj): 9873105Sstever@eecs.umich.edu return PortRef(simobj, self.name) 9883105Sstever@eecs.umich.edu 9893105Sstever@eecs.umich.edu # Connect an instance of this port (on the given SimObject with 9903105Sstever@eecs.umich.edu # the given name) with the port described by the supplied PortRef 9913101Sstever@eecs.umich.edu def connect(self, simobj, ref): 9923109Sstever@eecs.umich.edu self.makeRef(simobj).connect(ref) 9933109Sstever@eecs.umich.edu 9943109Sstever@eecs.umich.edu# VectorPort description object. Like Port, but represents a vector 9953109Sstever@eecs.umich.edu# of connections (e.g., as on a Bus). 9963109Sstever@eecs.umich.educlass VectorPort(Port): 9973109Sstever@eecs.umich.edu def __init__(self, *args): 9983109Sstever@eecs.umich.edu Port.__init__(self, *args) 9993109Sstever@eecs.umich.edu self.isVec = True 10003109Sstever@eecs.umich.edu 10013101Sstever@eecs.umich.edu def makeRef(self, simobj): 10023105Sstever@eecs.umich.edu return VectorPortRef(simobj, self.name) 10033105Sstever@eecs.umich.edu 10043105Sstever@eecs.umich.edu# 'Fake' ParamDesc for Port references to assign to the _pdesc slot of 10053101Sstever@eecs.umich.edu# proxy objects (via set_param_desc()) so that proxy error messages 10063105Sstever@eecs.umich.edu# make sense. 10073105Sstever@eecs.umich.educlass PortParamDesc(object): 10083101Sstever@eecs.umich.edu __metaclass__ = Singleton 10093105Sstever@eecs.umich.edu 10103179Sstever@eecs.umich.edu ptype_str = 'Port' 10113105Sstever@eecs.umich.edu ptype = Port 10123105Sstever@eecs.umich.edu 10133101Sstever@eecs.umich.edu 10143101Sstever@eecs.umich.edu__all__ = ['Param', 'VectorParam', 10153105Sstever@eecs.umich.edu 'Enum', 'Bool', 'String', 'Float', 10163105Sstever@eecs.umich.edu 'Int', 'Unsigned', 'Int8', 'UInt8', 'Int16', 'UInt16', 10173105Sstever@eecs.umich.edu 'Int32', 'UInt32', 'Int64', 'UInt64', 10183105Sstever@eecs.umich.edu 'Counter', 'Addr', 'Tick', 'Percent', 10193105Sstever@eecs.umich.edu 'TcpPort', 'UdpPort', 'EthernetAddr', 10203105Sstever@eecs.umich.edu 'MemorySize', 'MemorySize32', 10213105Sstever@eecs.umich.edu 'Latency', 'Frequency', 'Clock', 10223105Sstever@eecs.umich.edu 'NetworkBandwidth', 'MemoryBandwidth', 10233105Sstever@eecs.umich.edu 'Range', 'AddrRange', 'TickRange', 10243105Sstever@eecs.umich.edu 'MaxAddr', 'MaxTick', 'AllMemory', 10253105Sstever@eecs.umich.edu 'Time', 10263101Sstever@eecs.umich.edu 'NextEthernetAddr', 'NULL', 10273101Sstever@eecs.umich.edu 'Port', 'VectorPort'] 10284859Snate@binkert.org 10294762Snate@binkert.org# see comment on imports at end of __init__.py. 10303101Sstever@eecs.umich.edufrom SimObject import isSimObject, isSimObjectSequence, isSimObjectClass 10313101Sstever@eecs.umich.eduimport proxy 10323101Sstever@eecs.umich.eduimport objects 10334859Snate@binkert.orgimport internal 10344859Snate@binkert.org