proxy.py revision 10195
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# Proxy object support. 333101Sstever@eecs.umich.edu# 343101Sstever@eecs.umich.edu##################################################################### 353101Sstever@eecs.umich.edu 363179Sstever@eecs.umich.eduimport copy 373179Sstever@eecs.umich.edu 383101Sstever@eecs.umich.educlass BaseProxy(object): 393101Sstever@eecs.umich.edu def __init__(self, search_self, search_up): 403101Sstever@eecs.umich.edu self._search_self = search_self 413101Sstever@eecs.umich.edu self._search_up = search_up 423101Sstever@eecs.umich.edu self._multiplier = None 433101Sstever@eecs.umich.edu 443109Sstever@eecs.umich.edu def __str__(self): 453109Sstever@eecs.umich.edu if self._search_self and not self._search_up: 463109Sstever@eecs.umich.edu s = 'Self' 473109Sstever@eecs.umich.edu elif not self._search_self and self._search_up: 483109Sstever@eecs.umich.edu s = 'Parent' 493109Sstever@eecs.umich.edu else: 503109Sstever@eecs.umich.edu s = 'ConfusedProxy' 513109Sstever@eecs.umich.edu return s + '.' + self.path() 523109Sstever@eecs.umich.edu 533101Sstever@eecs.umich.edu def __setattr__(self, attr, value): 543101Sstever@eecs.umich.edu if not attr.startswith('_'): 553105Sstever@eecs.umich.edu raise AttributeError, \ 563105Sstever@eecs.umich.edu "cannot set attribute '%s' on proxy object" % attr 573101Sstever@eecs.umich.edu super(BaseProxy, self).__setattr__(attr, value) 583101Sstever@eecs.umich.edu 593101Sstever@eecs.umich.edu # support multiplying proxies by constants 603101Sstever@eecs.umich.edu def __mul__(self, other): 613101Sstever@eecs.umich.edu if not isinstance(other, (int, long, float)): 623101Sstever@eecs.umich.edu raise TypeError, "Proxy multiplier must be integer" 633101Sstever@eecs.umich.edu if self._multiplier == None: 643101Sstever@eecs.umich.edu self._multiplier = other 653101Sstever@eecs.umich.edu else: 663101Sstever@eecs.umich.edu # support chained multipliers 673101Sstever@eecs.umich.edu self._multiplier *= other 683101Sstever@eecs.umich.edu return self 693101Sstever@eecs.umich.edu 703101Sstever@eecs.umich.edu __rmul__ = __mul__ 713101Sstever@eecs.umich.edu 723101Sstever@eecs.umich.edu def _mulcheck(self, result): 733101Sstever@eecs.umich.edu if self._multiplier == None: 743101Sstever@eecs.umich.edu return result 753101Sstever@eecs.umich.edu return result * self._multiplier 763101Sstever@eecs.umich.edu 773101Sstever@eecs.umich.edu def unproxy(self, base): 783101Sstever@eecs.umich.edu obj = base 793101Sstever@eecs.umich.edu done = False 803101Sstever@eecs.umich.edu 813101Sstever@eecs.umich.edu if self._search_self: 823101Sstever@eecs.umich.edu result, done = self.find(obj) 833101Sstever@eecs.umich.edu 843101Sstever@eecs.umich.edu if self._search_up: 8510195SGeoffrey.Blake@arm.com # Search up the tree but mark ourself 8610195SGeoffrey.Blake@arm.com # as visited to avoid a self-reference 8710195SGeoffrey.Blake@arm.com self._visited = True 8810195SGeoffrey.Blake@arm.com obj._visited = True 893101Sstever@eecs.umich.edu while not done: 903101Sstever@eecs.umich.edu obj = obj._parent 913101Sstever@eecs.umich.edu if not obj: 923101Sstever@eecs.umich.edu break 933101Sstever@eecs.umich.edu result, done = self.find(obj) 943101Sstever@eecs.umich.edu 9510195SGeoffrey.Blake@arm.com self._visited = False 9610195SGeoffrey.Blake@arm.com base._visited = False 9710195SGeoffrey.Blake@arm.com 983101Sstever@eecs.umich.edu if not done: 993101Sstever@eecs.umich.edu raise AttributeError, \ 1003101Sstever@eecs.umich.edu "Can't resolve proxy '%s' of type '%s' from '%s'" % \ 1013101Sstever@eecs.umich.edu (self.path(), self._pdesc.ptype_str, base.path()) 1023101Sstever@eecs.umich.edu 1033101Sstever@eecs.umich.edu if isinstance(result, BaseProxy): 1043101Sstever@eecs.umich.edu if result == self: 1053101Sstever@eecs.umich.edu raise RuntimeError, "Cycle in unproxy" 1063101Sstever@eecs.umich.edu result = result.unproxy(obj) 1073101Sstever@eecs.umich.edu 1083101Sstever@eecs.umich.edu return self._mulcheck(result) 1093101Sstever@eecs.umich.edu 1103101Sstever@eecs.umich.edu def getindex(obj, index): 1113101Sstever@eecs.umich.edu if index == None: 1123101Sstever@eecs.umich.edu return obj 1133101Sstever@eecs.umich.edu try: 1143101Sstever@eecs.umich.edu obj = obj[index] 1153101Sstever@eecs.umich.edu except TypeError: 1163101Sstever@eecs.umich.edu if index != 0: 1173101Sstever@eecs.umich.edu raise 1183101Sstever@eecs.umich.edu # if index is 0 and item is not subscriptable, just 1193101Sstever@eecs.umich.edu # use item itself (so cpu[0] works on uniprocessors) 1203101Sstever@eecs.umich.edu return obj 1213101Sstever@eecs.umich.edu getindex = staticmethod(getindex) 1223101Sstever@eecs.umich.edu 1233109Sstever@eecs.umich.edu # This method should be called once the proxy is assigned to a 1243109Sstever@eecs.umich.edu # particular parameter or port to set the expected type of the 1253109Sstever@eecs.umich.edu # resolved proxy 1263101Sstever@eecs.umich.edu def set_param_desc(self, pdesc): 1273101Sstever@eecs.umich.edu self._pdesc = pdesc 1283101Sstever@eecs.umich.edu 1293101Sstever@eecs.umich.educlass AttrProxy(BaseProxy): 1303101Sstever@eecs.umich.edu def __init__(self, search_self, search_up, attr): 1313101Sstever@eecs.umich.edu super(AttrProxy, self).__init__(search_self, search_up) 1323101Sstever@eecs.umich.edu self._attr = attr 1333101Sstever@eecs.umich.edu self._modifiers = [] 1343101Sstever@eecs.umich.edu 1353101Sstever@eecs.umich.edu def __getattr__(self, attr): 1363101Sstever@eecs.umich.edu # python uses __bases__ internally for inheritance 1373101Sstever@eecs.umich.edu if attr.startswith('_'): 1383101Sstever@eecs.umich.edu return super(AttrProxy, self).__getattr__(self, attr) 1393101Sstever@eecs.umich.edu if hasattr(self, '_pdesc'): 1403101Sstever@eecs.umich.edu raise AttributeError, "Attribute reference on bound proxy" 1413179Sstever@eecs.umich.edu # Return a copy of self rather than modifying self in place 1423179Sstever@eecs.umich.edu # since self could be an indirect reference via a variable or 1433179Sstever@eecs.umich.edu # parameter 1443179Sstever@eecs.umich.edu new_self = copy.deepcopy(self) 1453179Sstever@eecs.umich.edu new_self._modifiers.append(attr) 1463179Sstever@eecs.umich.edu return new_self 1473101Sstever@eecs.umich.edu 1483101Sstever@eecs.umich.edu # support indexing on proxies (e.g., Self.cpu[0]) 1493101Sstever@eecs.umich.edu def __getitem__(self, key): 1503101Sstever@eecs.umich.edu if not isinstance(key, int): 1513101Sstever@eecs.umich.edu raise TypeError, "Proxy object requires integer index" 1523179Sstever@eecs.umich.edu if hasattr(self, '_pdesc'): 1533179Sstever@eecs.umich.edu raise AttributeError, "Index operation on bound proxy" 1543179Sstever@eecs.umich.edu new_self = copy.deepcopy(self) 1553179Sstever@eecs.umich.edu new_self._modifiers.append(key) 1563179Sstever@eecs.umich.edu return new_self 1573101Sstever@eecs.umich.edu 1583101Sstever@eecs.umich.edu def find(self, obj): 1593101Sstever@eecs.umich.edu try: 1603101Sstever@eecs.umich.edu val = getattr(obj, self._attr) 16110195SGeoffrey.Blake@arm.com visited = False 16210195SGeoffrey.Blake@arm.com if hasattr(val, '_visited'): 16310195SGeoffrey.Blake@arm.com visited = getattr(val, '_visited') 16410195SGeoffrey.Blake@arm.com 16510195SGeoffrey.Blake@arm.com if not visited: 16610195SGeoffrey.Blake@arm.com # for any additional unproxying to be done, pass the 16710195SGeoffrey.Blake@arm.com # current, rather than the original object so that proxy 16810195SGeoffrey.Blake@arm.com # has the right context 16910195SGeoffrey.Blake@arm.com obj = val 17010195SGeoffrey.Blake@arm.com else: 17110195SGeoffrey.Blake@arm.com return None, False 1723101Sstever@eecs.umich.edu except: 1733101Sstever@eecs.umich.edu return None, False 1743101Sstever@eecs.umich.edu while isproxy(val): 1753101Sstever@eecs.umich.edu val = val.unproxy(obj) 1763101Sstever@eecs.umich.edu for m in self._modifiers: 1773101Sstever@eecs.umich.edu if isinstance(m, str): 1783101Sstever@eecs.umich.edu val = getattr(val, m) 1793101Sstever@eecs.umich.edu elif isinstance(m, int): 1803101Sstever@eecs.umich.edu val = val[m] 1813101Sstever@eecs.umich.edu else: 1823101Sstever@eecs.umich.edu assert("Item must be string or integer") 1833101Sstever@eecs.umich.edu while isproxy(val): 1843101Sstever@eecs.umich.edu val = val.unproxy(obj) 1853101Sstever@eecs.umich.edu return val, True 1863101Sstever@eecs.umich.edu 1873101Sstever@eecs.umich.edu def path(self): 1883101Sstever@eecs.umich.edu p = self._attr 1893101Sstever@eecs.umich.edu for m in self._modifiers: 1903101Sstever@eecs.umich.edu if isinstance(m, str): 1913101Sstever@eecs.umich.edu p += '.%s' % m 1923101Sstever@eecs.umich.edu elif isinstance(m, int): 1933101Sstever@eecs.umich.edu p += '[%d]' % m 1943101Sstever@eecs.umich.edu else: 1953101Sstever@eecs.umich.edu assert("Item must be string or integer") 1963101Sstever@eecs.umich.edu return p 1973101Sstever@eecs.umich.edu 1983101Sstever@eecs.umich.educlass AnyProxy(BaseProxy): 1993101Sstever@eecs.umich.edu def find(self, obj): 2003101Sstever@eecs.umich.edu return obj.find_any(self._pdesc.ptype) 2013101Sstever@eecs.umich.edu 2023101Sstever@eecs.umich.edu def path(self): 2033101Sstever@eecs.umich.edu return 'any' 2043101Sstever@eecs.umich.edu 2058927Sandreas.hansson@arm.com# The AllProxy traverses the entire sub-tree (not only the children) 2068927Sandreas.hansson@arm.com# and adds all objects of a specific type 2078459SAli.Saidi@ARM.comclass AllProxy(BaseProxy): 2088459SAli.Saidi@ARM.com def find(self, obj): 2098459SAli.Saidi@ARM.com return obj.find_all(self._pdesc.ptype) 2108459SAli.Saidi@ARM.com 2118459SAli.Saidi@ARM.com def path(self): 2128459SAli.Saidi@ARM.com return 'all' 2138459SAli.Saidi@ARM.com 2143101Sstever@eecs.umich.edudef isproxy(obj): 2153101Sstever@eecs.umich.edu if isinstance(obj, (BaseProxy, params.EthernetAddr)): 2163101Sstever@eecs.umich.edu return True 2173101Sstever@eecs.umich.edu elif isinstance(obj, (list, tuple)): 2183101Sstever@eecs.umich.edu for v in obj: 2193101Sstever@eecs.umich.edu if isproxy(v): 2203101Sstever@eecs.umich.edu return True 2213101Sstever@eecs.umich.edu return False 2223101Sstever@eecs.umich.edu 2233101Sstever@eecs.umich.educlass ProxyFactory(object): 2243101Sstever@eecs.umich.edu def __init__(self, search_self, search_up): 2253101Sstever@eecs.umich.edu self.search_self = search_self 2263101Sstever@eecs.umich.edu self.search_up = search_up 2273101Sstever@eecs.umich.edu 2283101Sstever@eecs.umich.edu def __getattr__(self, attr): 2293101Sstever@eecs.umich.edu if attr == 'any': 2303101Sstever@eecs.umich.edu return AnyProxy(self.search_self, self.search_up) 2318459SAli.Saidi@ARM.com elif attr == 'all': 2328459SAli.Saidi@ARM.com if self.search_up: 2338459SAli.Saidi@ARM.com assert("Parant.all is not supported") 2348459SAli.Saidi@ARM.com return AllProxy(self.search_self, self.search_up) 2353101Sstever@eecs.umich.edu else: 2363101Sstever@eecs.umich.edu return AttrProxy(self.search_self, self.search_up, attr) 2373101Sstever@eecs.umich.edu 2383101Sstever@eecs.umich.edu# global objects for handling proxies 2393101Sstever@eecs.umich.eduParent = ProxyFactory(search_self = False, search_up = True) 2403101Sstever@eecs.umich.eduSelf = ProxyFactory(search_self = True, search_up = False) 2413101Sstever@eecs.umich.edu 2423101Sstever@eecs.umich.edu# limit exports on 'from proxy import *' 2433101Sstever@eecs.umich.edu__all__ = ['Parent', 'Self'] 2443101Sstever@eecs.umich.edu 2453101Sstever@eecs.umich.edu# see comment on imports at end of __init__.py. 2463101Sstever@eecs.umich.eduimport params # for EthernetAddr 247