scons: Override the "default" tool to set up the default env.

This imports various environment variables into the scons environment,
and sets some general properties on it. These are basically just copied
directly from the SConstruct and have the same behavior here.

gem5_tool_list will be used later on to add scons "tools" which should
be automatically added to new Environment objects.

Change-Id: Ib255955090c7b1e1cb80c703c18a9c867fcf1c9e
Reviewed-on: https://gem5-review.googlesource.com/5562
Reviewed-by: Gabe Black <gabeblack@google.com>
Maintainer: Gabe Black <gabeblack@google.com>

1 files changed, 84 insertions, 0 deletions

diff --git a/site_scons/site_tools/default.py b/site_scons/site_tools/default.py
new file mode 100644
index 000000000..f7eeb28f6
--- /dev/null
+++ b/site_scons/site_tools/default.py
@@ -0,0 +1,84 @@
+# Copyright (c) 2013, 2015-2017 ARM Limited
+# All rights reserved.
+#
+# The license below extends only to copyright in the software and shall
+# not be construed as granting a license to any other intellectual
+# property including but not limited to intellectual property relating
+# to a hardware implementation of the functionality of the software
+# licensed hereunder.  You may use the software subject to the license
+# terms below provided that you ensure that this notice is replicated
+# unmodified and in its entirety in all distributions of the software,
+# modified or unmodified, in source code or in binary form.
+#
+# Copyright (c) 2011 Advanced Micro Devices, Inc.
+# Copyright (c) 2009 The Hewlett-Packard Development Company
+# Copyright (c) 2004-2005 The Regents of The University of Michigan
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are
+# met: redistributions of source code must retain the above copyright
+# notice, this list of conditions and the following disclaimer;
+# redistributions in binary form must reproduce the above copyright
+# notice, this list of conditions and the following disclaimer in the
+# documentation and/or other materials provided with the distribution;
+# neither the name of the copyright holders nor the names of its
+# contributors may be used to endorse or promote products derived from
+# this software without specific prior written permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+# 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.
+
+import os
+
+import SCons.Tool
+import SCons.Tool.default
+
+def common_config(env):
+    # export TERM so that clang reports errors in color
+    use_vars = set([ 'AS', 'AR', 'CC', 'CXX', 'HOME', 'LD_LIBRARY_PATH',
+                     'LIBRARY_PATH', 'PATH', 'PKG_CONFIG_PATH', 'PROTOC',
+                     'PYTHONPATH', 'RANLIB', 'TERM' ])
+
+    use_prefixes = [
+        "ASAN_",           # address sanitizer symbolizer path and settings
+        "CCACHE_",         # ccache (caching compiler wrapper) configuration
+        "CCC_",            # clang static analyzer configuration
+        "DISTCC_",         # distcc (distributed compiler wrapper) config
+        "INCLUDE_SERVER_", # distcc pump server settings
+        "M5",              # M5 configuration (e.g., path to kernels)
+        ]
+
+    for key,val in sorted(os.environ.iteritems()):
+        if key in use_vars or \
+                any([key.startswith(prefix) for prefix in use_prefixes]):
+            env[key] = val
+
+    # Tell scons to avoid implicit command dependencies to avoid issues
+    # with the param wrappes being compiled twice (see
+    # http://scons.tigris.org/issues/show_bug.cgi?id=2811)
+    env['IMPLICIT_COMMAND_DEPENDENCIES'] = 0
+    env.Decider('MD5-timestamp')
+    env.root = env.Dir('#')
+    env.srcdir = env.root.Dir('src')
+
+gem5_tool_list = [
+]
+
+def generate(env):
+    common_config(env)
+    SCons.Tool.default.generate(env)
+    for tool in gem5_tool_list:
+        SCons.Tool.Tool(tool)(env)
+
+def exists(env):
+    return 1