__init__.py revision 5822:05ffa2c3c800 
1# Copyright (c) 2005 The Regents of The University of Michigan
2# All rights reserved.
3#
4# Redistribution and use in source and binary forms, with or without
5# modification, are permitted provided that the following conditions are
6# met: redistributions of source code must retain the above copyright
7# notice, this list of conditions and the following disclaimer;
8# redistributions in binary form must reproduce the above copyright
9# notice, this list of conditions and the following disclaimer in the
10# documentation and/or other materials provided with the distribution;
11# neither the name of the copyright holders nor the names of its
12# contributors may be used to endorse or promote products derived from
13# this software without specific prior written permission.
14#
15# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
16# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
17# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
18# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
19# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
20# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
21# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
22# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
23# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
25# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26#
27# Authors: Nathan Binkert
28#          Steve Reinhardt
29
30import os
31import sys
32
33import smartdict
34
35# define a MaxTick parameter
36MaxTick = 2**63 - 1
37
38# define this here so we can use it right away if necessary
39
40def errorURL(prefix, s):
41    try:
42        import zlib
43        hashstr = "%x" % zlib.crc32(s)
44    except:
45        hashstr = "UnableToHash"
46    return "For more information see: http://www.m5sim.org/%s/%s" % \
47            (prefix, hashstr)
48
49
50# panic() should be called when something happens that should never
51# ever happen regardless of what the user does (i.e., an acutal m5
52# bug).
53def panic(fmt, *args):
54    print >>sys.stderr, 'panic:', fmt % args
55    print >>sys.stderr, errorURL('panic',fmt)
56    sys.exit(1)
57
58# fatal() should be called when the simulation cannot continue due to
59# some condition that is the user's fault (bad configuration, invalid
60# arguments, etc.) and not a simulator bug.
61def fatal(fmt, *args):
62    print >>sys.stderr, 'fatal:', fmt % args
63    print >>sys.stderr, errorURL('fatal',fmt)
64    sys.exit(1)
65
66# force scalars to one-element lists for uniformity
67def makeList(objOrList):
68    if isinstance(objOrList, list):
69        return objOrList
70    return [objOrList]
71
72# Prepend given directory to system module search path.  We may not
73# need this anymore if we can structure our config library more like a
74# Python package.
75def AddToPath(path):
76    # if it's a relative path and we know what directory the current
77    # python script is in, make the path relative to that directory.
78    if not os.path.isabs(path) and sys.path[0]:
79        path = os.path.join(sys.path[0], path)
80    path = os.path.realpath(path)
81    # sys.path[0] should always refer to the current script's directory,
82    # so place the new dir right after that.
83    sys.path.insert(1, path)
84
85# make a SmartDict out of the build options for our local use
86build_env = smartdict.SmartDict()
87
88# make a SmartDict out of the OS environment too
89env = smartdict.SmartDict()
90env.update(os.environ)
91
92# Since we have so many mutual imports in this package, we should:
93# 1. Put all intra-package imports at the *bottom* of the file, unless
94#    they're absolutely needed before that (for top-level statements
95#    or class attributes).  Imports of "trivial" packages that don't
96#    import other packages (e.g., 'smartdict') can be at the top.
97# 2. Never use 'from foo import *' on an intra-package import since
98#    you can get the wrong result if foo is only partially imported
99#    at the point you do that (i.e., because foo is in the middle of
100#    importing *you*).
101try:
102    import internal
103except ImportError:
104    internal = None
105
106import defines
107build_env.update(defines.buildEnv)
108
109if internal:
110    defines.compileDate = internal.core.compileDate
111    for k,v in internal.core.__dict__.iteritems():
112        if k.startswith('flag_'):
113            setattr(defines, k[5:], v)
114
115    from event import *
116    from simulate import *
117    from main import options, main
118    import stats
119    import core
120
121import SimObject
122import params
123import objects
124