src/python/m5/util/__init__.py

   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 from __future__ import print_function
  41
  42 import os
  43 import re
  44 import sys
  45
  46 from six import string_types
  47
  48 from . import convert
  49 from . import jobfile
  50
  51 from .attrdict import attrdict, multiattrdict, optiondict
  52 from .code_formatter import code_formatter
  53 from .multidict import multidict
  54 from .smartdict import SmartDict
  55 from .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).
  60 def 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.
  67 def 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.
  74 def 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.
  79 def inform(fmt, *args):
  80     print('info:', fmt % args, file=sys.stdout)
  81
  82 class 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
  90 def 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>)
 106 def 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').
 113 def 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
 119 def 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, string_types):
 128             return list(map(lambda x: int(re.match('\d+', x).group()),
 129                             v.split('.')))
 130         else:
 131             raise TypeError()
 132
 133     v1 = make_version_list(v1)
 134     v2 = make_version_list(v2)
 135     # Compare corresponding elements of lists
 136     for n1,n2 in zip(v1, v2):
 137         if n1 < n2: return -1
 138         if n1 > n2: return  1
 139     # all corresponding values are equal... see if one has extra values
 140     if len(v1) < len(v2): return -1
 141     if len(v1) > len(v2): return  1
 142     return 0
 143
 144 def crossproduct(items):
 145     if len(items) == 1:
 146         for i in items[0]:
 147             yield (i,)
 148     else:
 149         for i in items[0]:
 150             for j in crossproduct(items[1:]):
 151                 yield (i,) + j
 152
 153 def flatten(items):
 154     while items:
 155         item = items.pop(0)
 156         if isinstance(item, (list, tuple)):
 157             items[0:0] = item
 158         else:
 159             yield item
 160
 161 # force scalars to one-element lists for uniformity
 162 def makeList(objOrList):
 163     if isinstance(objOrList, list):
 164         return objOrList
 165     return [objOrList]
 166
 167 def printList(items, indent=4):
 168     line = ' ' * indent
 169     for i,item in enumerate(items):
 170         if len(line) + len(item) > 76:
 171             print(line)
 172             line = ' ' * indent
 173
 174         if i < len(items) - 1:
 175             line += '%s, ' % item
 176         else:
 177             line += item
 178             print(line)
 179
 180 def readCommand(cmd, **kwargs):
 181     """run the command cmd, read the results and return them
 182     this is sorta like `cmd` in shell"""
 183     from subprocess import Popen, PIPE, STDOUT
 184
 185     if isinstance(cmd, str):
 186         cmd = cmd.split()
 187
 188     no_exception = 'exception' in kwargs
 189     exception = kwargs.pop('exception', None)
 190
 191     kwargs.setdefault('shell', False)
 192     kwargs.setdefault('stdout', PIPE)
 193     kwargs.setdefault('stderr', STDOUT)
 194     kwargs.setdefault('close_fds', True)
 195     try:
 196         subp = Popen(cmd, **kwargs)
 197     except Exception as e:
 198         if no_exception:
 199             return exception
 200         raise
 201
 202     return subp.communicate()[0].decode('utf-8')
 203
 204 def makeDir(path):
 205     """Make a directory if it doesn't exist.  If the path does exist,
 206     ensure that it is a directory"""
 207     if os.path.exists(path):
 208         if not os.path.isdir(path):
 209             raise AttributeError("%s exists but is not directory" % path)
 210     else:
 211         os.mkdir(path)
 212
 213 def isInteractive():
 214     """Check if the simulator is run interactively or in a batch environment"""
 215
 216     return sys.__stdin__.isatty()