Added in missing portions of the stat structure copying function.
[gem5.git] / SConstruct
index cbbcb07a699108172e0c971530e1626eb27caf5d..50089700a51064790848e75505b7a89cb5feb83a 100644 (file)
@@ -25,6 +25,8 @@
 # THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 # (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+#
+# Authors: Steve Reinhardt
 
 ###################################################
 #
 #
 # You can build M5 in a different directory as long as there is a
 # 'build/<CONFIG>' somewhere along the target path.  The build system
-# expdects that all configs under the same build directory are being
+# expects that all configs under the same build directory are being
 # built for the same host system.
 #
 # Examples:
-#   These two commands are equivalent.  The '-u' option tells scons to
-#   search up the directory tree for this SConstruct file.
+#
+#   The following two commands are equivalent.  The '-u' option tells
+#   scons to search up the directory tree for this SConstruct file.
 #   % cd <path-to-src>/m5 ; scons build/ALPHA_FS/m5.debug
 #   % cd <path-to-src>/m5/build/ALPHA_FS; scons -u m5.debug
-#   These two commands are equivalent and demonstrate building in a
-#   directory outside of the source tree.  The '-C' option tells scons
-#   to chdir to the specified directory to find this SConstruct file.
+#
+#   The following two commands are equivalent and demonstrate building
+#   in a directory outside of the source tree.  The '-C' option tells
+#   scons to chdir to the specified directory to find this SConstruct
+#   file.
 #   % cd <path-to-src>/m5 ; scons /local/foo/build/ALPHA_FS/m5.debug
 #   % cd /local/foo/build/ALPHA_FS; scons -C <path-to-src>/m5 m5.debug
 #
 import sys
 import os
 
-# Check for recent-enough Python and SCons versions
-EnsurePythonVersion(2,3)
+# Check for recent-enough Python and SCons versions.  If your system's
+# default installation of Python is not recent enough, you can use a
+# non-default installation of the Python interpreter by either (1)
+# rearranging your PATH so that scons finds the non-default 'python'
+# first or (2) explicitly invoking an alternative interpreter on the
+# scons script, e.g., "/usr/local/bin/python2.4 `which scons` [args]".
+EnsurePythonVersion(2,4)
 
 # Ironically, SCons 0.96 dies if you give EnsureSconsVersion a
 # 3-element version number.
@@ -109,6 +119,22 @@ def rfind(l, elt, offs = -1):
             return i
     raise ValueError, "element not found"
 
+# helper function: compare dotted version numbers.
+# E.g., compare_version('1.3.25', '1.4.1')
+# returns -1, 0, 1 if v1 is <, ==, > v2
+def compare_versions(v1, v2):
+    # Convert dotted strings to lists
+    v1 = map(int, v1.split('.'))
+    v2 = map(int, v2.split('.'))
+    # Compare corresponding elements of lists
+    for n1,n2 in zip(v1, v2):
+        if n1 < n2: return -1
+        if n1 > n2: return  1
+    # all corresponding values are equal... see if one has extra values
+    if len(v1) < len(v2): return -1
+    if len(v1) > len(v2): return  1
+    return 0
+
 # Each target must have 'build' in the interior of the path; the
 # directory below this will determine the build parameters.  For
 # example, for target 'foo/bar/build/ALPHA_SE/arch/alpha/blah.do' we
@@ -149,7 +175,13 @@ env = Environment(ENV = os.environ,  # inherit user's environment vars
                   ROOT = ROOT,
                   SRCDIR = SRCDIR)
 
-env.SConsignFile("sconsign")
+env.SConsignFile(os.path.join(build_root,"sconsign"))
+
+# Default duplicate option is to use hard links, but this messes up
+# when you use emacs to edit a file in the target dir, as emacs moves
+# file to file~ then copies to file, breaking the link.  Symbolic
+# (soft) links work better.
+env.SetOption('duplicate', 'soft-copy')
 
 # I waffle on this setting... it does avoid a few painful but
 # unnecessary builds, but it also seems to make trivial builds take
@@ -169,8 +201,36 @@ if sys.platform == 'cygwin':
     env.Append(CCFLAGS=Split("-Wno-uninitialized"))
 env.Append(CPPPATH=[Dir('ext/dnet')])
 
-# Default libraries
-env.Append(LIBS=['z'])
+# Check for SWIG
+if not env.has_key('SWIG'):
+    print 'Error: SWIG utility not found.'
+    print '       Please install (see http://www.swig.org) and retry.'
+    Exit(1)
+
+# Check for appropriate SWIG version
+swig_version = os.popen('swig -version').read().split()
+# First 3 words should be "SWIG Version x.y.z"
+if swig_version[0] != 'SWIG' or swig_version[1] != 'Version':
+    print 'Error determining SWIG version.'
+    Exit(1)
+
+min_swig_version = '1.3.28'
+if compare_versions(swig_version[2], min_swig_version) < 0:
+    print 'Error: SWIG version', min_swig_version, 'or newer required.'
+    print '       Installed version:', swig_version[2]
+    Exit(1)
+
+# Set up SWIG flags & scanner
+env.Append(SWIGFLAGS=Split('-c++ -python -modern $_CPPINCFLAGS'))
+
+import SCons.Scanner
+
+swig_inc_re = '^[ \t]*[%,#][ \t]*(?:include|import)[ \t]*(<|")([^>"]+)(>|")'
+
+swig_scanner = SCons.Scanner.ClassicCPP("SwigScan", ".i", "CPPPATH",
+                                        swig_inc_re)
+
+env.Append(SCANNERS = swig_scanner)
 
 # Platform-specific configuration.  Note again that we assume that all
 # builds under a given build root run on the same host platform.
@@ -178,6 +238,46 @@ conf = Configure(env,
                  conf_dir = os.path.join(build_root, '.scons_config'),
                  log_file = os.path.join(build_root, 'scons_config.log'))
 
+# Find Python include and library directories for embedding the
+# interpreter.  For consistency, we will use the same Python
+# installation used to run scons (and thus this script).  If you want
+# to link in an alternate version, see above for instructions on how
+# to invoke scons with a different copy of the Python interpreter.
+
+# Get brief Python version name (e.g., "python2.4") for locating
+# include & library files
+py_version_name = 'python' + sys.version[:3]
+
+# include path, e.g. /usr/local/include/python2.4
+py_header_path = os.path.join(sys.exec_prefix, 'include', py_version_name)
+env.Append(CPPPATH = py_header_path)
+# verify that it works
+if not conf.CheckHeader('Python.h', '<>'):
+    print "Error: can't find Python.h header in", py_header_path
+    Exit(1)
+
+# add library path too if it's not in the default place
+py_lib_path = None
+if sys.exec_prefix != '/usr':
+    py_lib_path = os.path.join(sys.exec_prefix, 'lib')
+elif sys.platform == 'cygwin':
+    # cygwin puts the .dll in /bin for some reason
+    py_lib_path = '/bin'
+if py_lib_path:
+    env.Append(LIBPATH = py_lib_path)
+    print 'Adding', py_lib_path, 'to LIBPATH for', py_version_name
+if not conf.CheckLib(py_version_name):
+    print "Error: can't find Python library", py_version_name
+    Exit(1)
+
+# Check for zlib.  If the check passes, libz will be automatically
+# added to the LIBS environment variable.
+if not conf.CheckLibWithHeader('z', 'zlib.h', 'C++'):
+    print 'Error: did not find needed zlib compression library '\
+          'and/or zlib.h header file.'
+    print '       Please install zlib and try again.'
+    Exit(1)
+
 # Check for <fenv.h> (C99 FP environment control)
 have_fenv = conf.CheckHeader('fenv.h', '<>')
 if not have_fenv:
@@ -191,13 +291,10 @@ have_mysql = mysql_config != None
 # Check MySQL version.
 if have_mysql:
     mysql_version = os.popen(mysql_config + ' --version').read()
-    mysql_version = mysql_version.split('.')
-    mysql_major = int(mysql_version[0])
-    mysql_minor = int(mysql_version[1])
-    # This version check is probably overly conservative, but it deals
-    # with the versions we have installed.
-    if mysql_major < 4 or (mysql_major == 4 and mysql_minor < 1):
-        print "Warning: MySQL v4.1 or newer required."
+    min_mysql_version = '4.1'
+    if compare_versions(mysql_version, min_mysql_version) < 0:
+        print 'Warning: MySQL', min_mysql_version, 'or newer required.'
+        print '         Version', mysql_version, 'detected.'
         have_mysql = False
 
 # Set up mysql_config commands.
@@ -217,7 +314,8 @@ env['ALL_ISA_LIST'] = ['alpha', 'sparc', 'mips']
 
 # Define the universe of supported CPU models
 env['ALL_CPU_LIST'] = ['AtomicSimpleCPU', 'TimingSimpleCPU',
-                       'FullCPU', 'AlphaFullCPU']
+                       'FullCPU', 'O3CPU',
+                       'OzoneCPU']
 
 # Sticky options get saved in the options file so they persist from
 # one invocation to the next (unless overridden, in which case the new
@@ -243,9 +341,9 @@ sticky_opts.AddOptions(
     BoolOption('USE_SSE2',
                'Compile for SSE2 (-msse2) to get IEEE FP on x86 hosts',
                False),
-    BoolOption('STATS_BINNING', 'Bin statistics by CPU mode', have_mysql),
     BoolOption('USE_MYSQL', 'Use MySQL for stats output', have_mysql),
     BoolOption('USE_FENV', 'Use <fenv.h> IEEE mode control', have_fenv),
+    BoolOption('USE_CHECKER', 'Use checker for detailed CPU models', False),
     ('CC', 'C compiler', os.environ.get('CC', env['CC'])),
     ('CXX', 'C++ compiler', os.environ.get('CXX', env['CXX'])),
     BoolOption('BATCH', 'Use batch pool for build and tests', False),
@@ -258,10 +356,10 @@ nonsticky_opts.AddOptions(
     BoolOption('update_ref', 'Update test reference outputs', False)
     )
 
-# These options get exported to #defines in config/*.hh (see m5/SConscript).
+# These options get exported to #defines in config/*.hh (see src/SConscript).
 env.ExportOptions = ['FULL_SYSTEM', 'ALPHA_TLASER', 'USE_FENV', \
                      'USE_MYSQL', 'NO_FAST_ALLOC', 'SS_COMPATIBLE_FP', \
-                     'STATS_BINNING']
+                     'USE_CHECKER']
 
 # Define a handy 'no-op' action
 def no_action(target, source, env):
@@ -310,6 +408,32 @@ config_builder = Builder(emitter = config_emitter, action = config_action)
 
 env.Append(BUILDERS = { 'ConfigFile' : config_builder })
 
+###################################################
+#
+# Define a SCons builder for copying files.  This is used by the
+# Python zipfile code in src/python/SConscript, but is placed up here
+# since it's potentially more generally applicable.
+#
+###################################################
+
+copy_builder = Builder(action = Copy("$TARGET", "$SOURCE"))
+
+env.Append(BUILDERS = { 'CopyFile' : copy_builder })
+
+###################################################
+#
+# Define a simple SCons builder to concatenate files.
+#
+# Used to append the Python zip archive to the executable.
+#
+###################################################
+
+concat_builder = Builder(action = Action(['cat $SOURCES > $TARGET',
+                                          'chmod +x $TARGET']))
+
+env.Append(BUILDERS = { 'Concat' : concat_builder })
+
+
 # base help text
 help_text = '''
 Usage: scons [scons options] [build options] [target(s)]
@@ -414,17 +538,17 @@ for build_path in build_paths:
     if env['USE_SSE2']:
         env.Append(CCFLAGS='-msse2')
 
-    # The m5/SConscript file sets up the build rules in 'env' according
+    # The src/SConscript file sets up the build rules in 'env' according
     # to the configured options.  It returns a list of environments,
     # one for each variant build (debug, opt, etc.)
     envList = SConscript('src/SConscript', build_dir = build_path,
-                         exports = 'env', duplicate = False)
+                         exports = 'env')
 
     # Set up the regression tests for each build.
-#    for e in envList:
-#        SConscript('m5-test/SConscript',
-#                   build_dir = os.path.join(build_dir, 'test', e.Label),
-#                   exports = { 'env' : e }, duplicate = False)
+    for e in envList:
+        SConscript('tests/SConscript',
+                   build_dir = os.path.join(build_path, 'tests', e.Label),
+                   exports = { 'env' : e }, duplicate = False)
 
 Help(help_text)