__init__.py revision 13672:2969e4d5abf4
1# Copyright (c) 2016 ARM Limited 2# All rights reserved. 3# 4# The license below extends only to copyright in the software and shall 5# not be construed as granting a license to any other intellectual 6# property including but not limited to intellectual property relating 7# to a hardware implementation of the functionality of the software 8# licensed hereunder. You may use the software subject to the license 9# terms below provided that you ensure that this notice is replicated 10# unmodified and in its entirety in all distributions of the software, 11# modified or unmodified, in source code or in binary form. 12# 13# Copyright (c) 2008-2009 The Hewlett-Packard Development Company 14# Copyright (c) 2004-2006 The Regents of The University of Michigan 15# All rights reserved. 16# 17# Redistribution and use in source and binary forms, with or without 18# modification, are permitted provided that the following conditions are 19# met: redistributions of source code must retain the above copyright 20# notice, this list of conditions and the following disclaimer; 21# redistributions in binary form must reproduce the above copyright 22# notice, this list of conditions and the following disclaimer in the 23# documentation and/or other materials provided with the distribution; 24# neither the name of the copyright holders nor the names of its 25# contributors may be used to endorse or promote products derived from 26# this software without specific prior written permission. 27# 28# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 29# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 30# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 31# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 32# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 33# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 34# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 35# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 36# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 37# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 38# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 39# 40# Authors: Nathan Binkert 41 42from __future__ import print_function 43 44import os 45import re 46import sys 47 48import convert 49import jobfile 50 51from attrdict import attrdict, multiattrdict, optiondict 52from code_formatter import code_formatter 53from multidict import multidict 54from smartdict import SmartDict 55from sorteddict import SortedDict 56 57# panic() should be called when something happens that should never 58# ever happen regardless of what the user does (i.e., an acutal m5 59# bug). 60def panic(fmt, *args): 61 print('panic:', fmt % args, file=sys.stderr) 62 sys.exit(1) 63 64# fatal() should be called when the simulation cannot continue due to 65# some condition that is the user's fault (bad configuration, invalid 66# arguments, etc.) and not a simulator bug. 67def fatal(fmt, *args): 68 print('fatal:', fmt % args, file=sys.stderr) 69 sys.exit(1) 70 71# warn() should be called when the user should be warned about some condition 72# that may or may not be the user's fault, but that they should be made aware 73# of as it may affect the simulation or results. 74def warn(fmt, *args): 75 print('warn:', fmt % args, file=sys.stderr) 76 77# inform() should be called when the user should be informed about some 78# condition that they may be interested in. 79def inform(fmt, *args): 80 print('info:', fmt % args, file=sys.stdout) 81 82class Singleton(type): 83 def __call__(cls, *args, **kwargs): 84 if hasattr(cls, '_instance'): 85 return cls._instance 86 87 cls._instance = super(Singleton, cls).__call__(*args, **kwargs) 88 return cls._instance 89 90def addToPath(path): 91 """Prepend given directory to system module search path. We may not 92 need this anymore if we can structure our config library more like a 93 Python package.""" 94 95 # if it's a relative path and we know what directory the current 96 # python script is in, make the path relative to that directory. 97 if not os.path.isabs(path) and sys.path[0]: 98 path = os.path.join(sys.path[0], path) 99 path = os.path.realpath(path) 100 # sys.path[0] should always refer to the current script's directory, 101 # so place the new dir right after that. 102 sys.path.insert(1, path) 103 104# Apply method to object. 105# applyMethod(obj, 'meth', <args>) is equivalent to obj.meth(<args>) 106def applyMethod(obj, meth, *args, **kwargs): 107 return getattr(obj, meth)(*args, **kwargs) 108 109# If the first argument is an (non-sequence) object, apply the named 110# method with the given arguments. If the first argument is a 111# sequence, apply the method to each element of the sequence (a la 112# 'map'). 113def applyOrMap(objOrSeq, meth, *args, **kwargs): 114 if not isinstance(objOrSeq, (list, tuple)): 115 return applyMethod(objOrSeq, meth, *args, **kwargs) 116 else: 117 return [applyMethod(o, meth, *args, **kwargs) for o in objOrSeq] 118 119def compareVersions(v1, v2): 120 """helper function: compare arrays or strings of version numbers. 121 E.g., compare_version((1,3,25), (1,4,1)') 122 returns -1, 0, 1 if v1 is <, ==, > v2 123 """ 124 def make_version_list(v): 125 if isinstance(v, (list,tuple)): 126 return v 127 elif isinstance(v, str): 128 return map(lambda x: int(re.match('\d+', x).group()), v.split('.')) 129 else: 130 raise TypeError() 131 132 v1 = make_version_list(v1) 133 v2 = make_version_list(v2) 134 # Compare corresponding elements of lists 135 for n1,n2 in zip(v1, v2): 136 if n1 < n2: return -1 137 if n1 > n2: return 1 138 # all corresponding values are equal... see if one has extra values 139 if len(v1) < len(v2): return -1 140 if len(v1) > len(v2): return 1 141 return 0 142 143def crossproduct(items): 144 if len(items) == 1: 145 for i in items[0]: 146 yield (i,) 147 else: 148 for i in items[0]: 149 for j in crossproduct(items[1:]): 150 yield (i,) + j 151 152def flatten(items): 153 while items: 154 item = items.pop(0) 155 if isinstance(item, (list, tuple)): 156 items[0:0] = item 157 else: 158 yield item 159 160# force scalars to one-element lists for uniformity 161def makeList(objOrList): 162 if isinstance(objOrList, list): 163 return objOrList 164 return [objOrList] 165 166def printList(items, indent=4): 167 line = ' ' * indent 168 for i,item in enumerate(items): 169 if len(line) + len(item) > 76: 170 print(line) 171 line = ' ' * indent 172 173 if i < len(items) - 1: 174 line += '%s, ' % item 175 else: 176 line += item 177 print(line) 178 179def readCommand(cmd, **kwargs): 180 """run the command cmd, read the results and return them 181 this is sorta like `cmd` in shell""" 182 from subprocess import Popen, PIPE, STDOUT 183 184 if isinstance(cmd, str): 185 cmd = cmd.split() 186 187 no_exception = 'exception' in kwargs 188 exception = kwargs.pop('exception', None) 189 190 kwargs.setdefault('shell', False) 191 kwargs.setdefault('stdout', PIPE) 192 kwargs.setdefault('stderr', STDOUT) 193 kwargs.setdefault('close_fds', True) 194 try: 195 subp = Popen(cmd, **kwargs) 196 except Exception as e: 197 if no_exception: 198 return exception 199 raise 200 201 return subp.communicate()[0] 202 203def makeDir(path): 204 """Make a directory if it doesn't exist. If the path does exist, 205 ensure that it is a directory""" 206 if os.path.exists(path): 207 if not os.path.isdir(path): 208 raise AttributeError("%s exists but is not directory" % path) 209 else: 210 os.mkdir(path) 211 212def isInteractive(): 213 """Check if the simulator is run interactively or in a batch environment""" 214 215 return sys.__stdin__.isatty() 216