__init__.py revision 4762:c94e103c83ad 
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
39def panic(string):
40    print >>sys.stderr, 'panic:', string
41    sys.exit(1)
42
43# force scalars to one-element lists for uniformity
44def makeList(objOrList):
45    if isinstance(objOrList, list):
46        return objOrList
47    return [objOrList]
48
49# Prepend given directory to system module search path.  We may not
50# need this anymore if we can structure our config library more like a
51# Python package.
52def AddToPath(path):
53    # if it's a relative path and we know what directory the current
54    # python script is in, make the path relative to that directory.
55    if not os.path.isabs(path) and sys.path[0]:
56        path = os.path.join(sys.path[0], path)
57    path = os.path.realpath(path)
58    # sys.path[0] should always refer to the current script's directory,
59    # so place the new dir right after that.
60    sys.path.insert(1, path)
61
62# make a SmartDict out of the build options for our local use
63build_env = smartdict.SmartDict()
64
65# make a SmartDict out of the OS environment too
66env = smartdict.SmartDict()
67env.update(os.environ)
68
69# Since we have so many mutual imports in this package, we should:
70# 1. Put all intra-package imports at the *bottom* of the file, unless
71#    they're absolutely needed before that (for top-level statements
72#    or class attributes).  Imports of "trivial" packages that don't
73#    import other packages (e.g., 'smartdict') can be at the top.
74# 2. Never use 'from foo import *' on an intra-package import since
75#    you can get the wrong result if foo is only partially imported
76#    at the point you do that (i.e., because foo is in the middle of
77#    importing *you*).
78try:
79    import internal
80    running_m5 = True
81except ImportError:
82    running_m5 = False
83
84if running_m5:
85    from event import *
86    from simulate import *
87    from main import options
88
89if running_m5:
90    import defines
91    build_env.update(defines.m5_build_env)
92else:
93    import __scons
94    build_env.update(__scons.m5_build_env)
95
96import SimObject
97import params
98import objects
99