__init__.py revision 11923 
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
42import os
43import re
44import sys
45
46import convert
47import jobfile
48
49from attrdict import attrdict, multiattrdict, optiondict
50from code_formatter import code_formatter
51from multidict import multidict
52from orderdict import orderdict
53from smartdict import SmartDict
54from sorteddict import SortedDict
55
56# panic() should be called when something happens that should never
57# ever happen regardless of what the user does (i.e., an acutal m5
58# bug).
59def panic(fmt, *args):
60    print >>sys.stderr, 'panic:', fmt % args
61    sys.exit(1)
62
63# fatal() should be called when the simulation cannot continue due to
64# some condition that is the user's fault (bad configuration, invalid
65# arguments, etc.) and not a simulator bug.
66def fatal(fmt, *args):
67    print >>sys.stderr, 'fatal:', fmt % args
68    sys.exit(1)
69
70# warn() should be called when the user should be warned about some condition
71# that may or may not be the user's fault, but that they should be made aware
72# of as it may affect the simulation or results.
73def warn(fmt, *args):
74    print >>sys.stderr, 'warn:', fmt % args
75
76# inform() should be called when the user should be informed about some
77# condition that they may be interested in.
78def inform(fmt, *args):
79    print >>sys.stdout, 'info:', fmt % args
80
81class Singleton(type):
82    def __call__(cls, *args, **kwargs):
83        if hasattr(cls, '_instance'):
84            return cls._instance
85
86        cls._instance = super(Singleton, cls).__call__(*args, **kwargs)
87        return cls._instance
88
89def addToPath(path):
90    """Prepend given directory to system module search path.  We may not
91    need this anymore if we can structure our config library more like a
92    Python package."""
93
94    # if it's a relative path and we know what directory the current
95    # python script is in, make the path relative to that directory.
96    if not os.path.isabs(path) and sys.path[0]:
97        path = os.path.join(sys.path[0], path)
98    path = os.path.realpath(path)
99    # sys.path[0] should always refer to the current script's directory,
100    # so place the new dir right after that.
101    sys.path.insert(1, path)
102
103# Apply method to object.
104# applyMethod(obj, 'meth', <args>) is equivalent to obj.meth(<args>)
105def applyMethod(obj, meth, *args, **kwargs):
106    return getattr(obj, meth)(*args, **kwargs)
107
108# If the first argument is an (non-sequence) object, apply the named
109# method with the given arguments.  If the first argument is a
110# sequence, apply the method to each element of the sequence (a la
111# 'map').
112def applyOrMap(objOrSeq, meth, *args, **kwargs):
113    if not isinstance(objOrSeq, (list, tuple)):
114        return applyMethod(objOrSeq, meth, *args, **kwargs)
115    else:
116        return [applyMethod(o, meth, *args, **kwargs) for o in objOrSeq]
117
118def compareVersions(v1, v2):
119    """helper function: compare arrays or strings of version numbers.
120    E.g., compare_version((1,3,25), (1,4,1)')
121    returns -1, 0, 1 if v1 is <, ==, > v2
122    """
123    def make_version_list(v):
124        if isinstance(v, (list,tuple)):
125            return v
126        elif isinstance(v, str):
127            return map(lambda x: int(re.match('\d+', x).group()), v.split('.'))
128        else:
129            raise TypeError
130
131    v1 = make_version_list(v1)
132    v2 = make_version_list(v2)
133    # Compare corresponding elements of lists
134    for n1,n2 in zip(v1, v2):
135        if n1 < n2: return -1
136        if n1 > n2: return  1
137    # all corresponding values are equal... see if one has extra values
138    if len(v1) < len(v2): return -1
139    if len(v1) > len(v2): return  1
140    return 0
141
142def crossproduct(items):
143    if len(items) == 1:
144        for i in items[0]:
145            yield (i,)
146    else:
147        for i in items[0]:
148            for j in crossproduct(items[1:]):
149                yield (i,) + j
150
151def flatten(items):
152    while items:
153        item = items.pop(0)
154        if isinstance(item, (list, tuple)):
155            items[0:0] = item
156        else:
157            yield item
158
159# force scalars to one-element lists for uniformity
160def makeList(objOrList):
161    if isinstance(objOrList, list):
162        return objOrList
163    return [objOrList]
164
165def printList(items, indent=4):
166    line = ' ' * indent
167    for i,item in enumerate(items):
168        if len(line) + len(item) > 76:
169            print line
170            line = ' ' * indent
171
172        if i < len(items) - 1:
173            line += '%s, ' % item
174        else:
175            line += item
176            print line
177
178def readCommand(cmd, **kwargs):
179    """run the command cmd, read the results and return them
180    this is sorta like `cmd` in shell"""
181    from subprocess import Popen, PIPE, STDOUT
182
183    if isinstance(cmd, str):
184        cmd = cmd.split()
185
186    no_exception = 'exception' in kwargs
187    exception = kwargs.pop('exception', None)
188
189    kwargs.setdefault('shell', False)
190    kwargs.setdefault('stdout', PIPE)
191    kwargs.setdefault('stderr', STDOUT)
192    kwargs.setdefault('close_fds', True)
193    try:
194        subp = Popen(cmd, **kwargs)
195    except Exception, e:
196        if no_exception:
197            return exception
198        raise
199
200    return subp.communicate()[0]
201
202def makeDir(path):
203    """Make a directory if it doesn't exist.  If the path does exist,
204    ensure that it is a directory"""
205    if os.path.exists(path):
206        if not os.path.isdir(path):
207            raise AttributeError, "%s exists but is not directory" % path
208    else:
209        os.mkdir(path)
210
211def isInteractive():
212    """Check if the simulator is run interactively or in a batch environment"""
213
214    return sys.__stdin__.isatty()
215