import SCons
import SCons.Node
-extra_python_paths = [
- Dir('src/python').srcnode().abspath, # gem5 includes
- Dir('ext/ply').srcnode().abspath, # ply is used by several files
- ]
-
-sys.path[1:1] = extra_python_paths
-
from m5.util import compareVersions, readCommand
-from m5.util.terminal import get_termcap
help_texts = {
"options" : "",
print '--no-lto and --force-lto are mutually exclusive'
Exit(1)
-termcap = get_termcap(GetOption('use_colors'))
-
########################################################################
#
# Set up the main build environment.
#
########################################################################
-# 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) configuration
- "INCLUDE_SERVER_", # distcc pump server settings
- "M5", # M5 configuration (e.g., path to kernels)
- ]
-
-use_env = {}
-for key,val in sorted(os.environ.iteritems()):
- if key in use_vars or \
- any([key.startswith(prefix) for prefix in use_prefixes]):
- use_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)
-main = Environment(ENV=use_env, IMPLICIT_COMMAND_DEPENDENCIES=0)
-main.Decider('MD5-timestamp')
-main.root = Dir(".") # The current directory (where this file lives).
-main.srcdir = Dir("src") # The source directory
+main = Environment()
+
+from gem5_scons import Transform
+from gem5_scons.util import get_termcap
+termcap = get_termcap()
main_dict_keys = main.Dictionary().keys()
print "No C++ compiler installed (package g++ on Ubuntu and RedHat)"
Exit(1)
-# add useful python code PYTHONPATH so it can be used by subprocesses
-# as well
-main.AppendENVPath('PYTHONPATH', extra_python_paths)
-
-########################################################################
-#
-# Mercurial Stuff.
-#
-# If the gem5 directory is a mercurial repository, we should do some
-# extra things.
-#
-########################################################################
-
-hgdir = main.root.Dir(".hg")
-
-
-style_message = """
-You're missing the gem5 style hook, which automatically checks your code
-against the gem5 style rules on %s.
-This script will now install the hook in your %s.
-Press enter to continue, or ctrl-c to abort: """
-
-mercurial_style_message = """
-You're missing the gem5 style hook, which automatically checks your code
-against the gem5 style rules on hg commit and qrefresh commands.
-This script will now install the hook in your .hg/hgrc file.
-Press enter to continue, or ctrl-c to abort: """
-
-git_style_message = """
-You're missing the gem5 style or commit message hook. These hooks help
-to ensure that your code follows gem5's style rules on git commit.
-This script will now install the hook in your .git/hooks/ directory.
-Press enter to continue, or ctrl-c to abort: """
-
-mercurial_style_upgrade_message = """
-Your Mercurial style hooks are not up-to-date. This script will now
-try to automatically update them. A backup of your hgrc will be saved
-in .hg/hgrc.old.
-Press enter to continue, or ctrl-c to abort: """
-
-mercurial_style_hook = """
-# The following lines were automatically added by gem5/SConstruct
-# to provide the gem5 style-checking hooks
-[extensions]
-hgstyle = %s/util/hgstyle.py
-
-[hooks]
-pretxncommit.style = python:hgstyle.check_style
-pre-qrefresh.style = python:hgstyle.check_style
-# End of SConstruct additions
-
-""" % (main.root.abspath)
-
-mercurial_lib_not_found = """
-Mercurial libraries cannot be found, ignoring style hook. If
-you are a gem5 developer, please fix this and run the style
-hook. It is important.
-"""
-
-# Check for style hook and prompt for installation if it's not there.
-# Skip this if --ignore-style was specified, there's no interactive
-# terminal to prompt, or no recognized revision control system can be
-# found.
-ignore_style = GetOption('ignore_style') or not sys.stdin.isatty()
-
-# Try wire up Mercurial to the style hooks
-if not ignore_style and hgdir.exists():
- style_hook = True
- style_hooks = tuple()
- hgrc = hgdir.File('hgrc')
- hgrc_old = hgdir.File('hgrc.old')
- try:
- from mercurial import ui
- ui = ui.ui()
- ui.readconfig(hgrc.abspath)
- style_hooks = (ui.config('hooks', 'pretxncommit.style', None),
- ui.config('hooks', 'pre-qrefresh.style', None))
- style_hook = all(style_hooks)
- style_extension = ui.config('extensions', 'style', None)
- except ImportError:
- print mercurial_lib_not_found
-
- if "python:style.check_style" in style_hooks:
- # Try to upgrade the style hooks
- print mercurial_style_upgrade_message
- # continue unless user does ctrl-c/ctrl-d etc.
- try:
- raw_input()
- except:
- print "Input exception, exiting scons.\n"
- sys.exit(1)
- shutil.copyfile(hgrc.abspath, hgrc_old.abspath)
- re_style_hook = re.compile(r"^([^=#]+)\.style\s*=\s*([^#\s]+).*")
- re_style_extension = re.compile("style\s*=\s*([^#\s]+).*")
- old, new = open(hgrc_old.abspath, 'r'), open(hgrc.abspath, 'w')
- for l in old:
- m_hook = re_style_hook.match(l)
- m_ext = re_style_extension.match(l)
- if m_hook:
- hook, check = m_hook.groups()
- if check != "python:style.check_style":
- print "Warning: %s.style is using a non-default " \
- "checker: %s" % (hook, check)
- if hook not in ("pretxncommit", "pre-qrefresh"):
- print "Warning: Updating unknown style hook: %s" % hook
-
- l = "%s.style = python:hgstyle.check_style\n" % hook
- elif m_ext and m_ext.group(1) == style_extension:
- l = "hgstyle = %s/util/hgstyle.py\n" % main.root.abspath
-
- new.write(l)
- elif not style_hook:
- print mercurial_style_message,
- # continue unless user does ctrl-c/ctrl-d etc.
- try:
- raw_input()
- except:
- print "Input exception, exiting scons.\n"
- sys.exit(1)
- hgrc_path = '%s/.hg/hgrc' % main.root.abspath
- print "Adding style hook to", hgrc_path, "\n"
- try:
- with open(hgrc_path, 'a') as f:
- f.write(mercurial_style_hook)
- except:
- print "Error updating", hgrc_path
- sys.exit(1)
-
-def install_git_style_hooks():
- try:
- gitdir = Dir(readCommand(
- ["git", "rev-parse", "--git-dir"]).strip("\n"))
- except Exception, e:
- print "Warning: Failed to find git repo directory: %s" % e
- return
-
- git_hooks = gitdir.Dir("hooks")
- def hook_exists(hook_name):
- hook = git_hooks.File(hook_name)
- return hook.exists()
-
- def hook_install(hook_name, script):
- hook = git_hooks.File(hook_name)
- if hook.exists():
- print "Warning: Can't install %s, hook already exists." % hook_name
- return
-
- if hook.islink():
- print "Warning: Removing broken symlink for hook %s." % hook_name
- os.unlink(hook.get_abspath())
-
- if not git_hooks.exists():
- mkdir(git_hooks.get_abspath())
- git_hooks.clear()
-
- abs_symlink_hooks = git_hooks.islink() and \
- os.path.isabs(os.readlink(git_hooks.get_abspath()))
-
- # Use a relative symlink if the hooks live in the source directory,
- # and the hooks directory is not a symlink to an absolute path.
- if hook.is_under(main.root) and not abs_symlink_hooks:
- script_path = os.path.relpath(
- os.path.realpath(script.get_abspath()),
- os.path.realpath(hook.Dir(".").get_abspath()))
- else:
- script_path = script.get_abspath()
-
- try:
- os.symlink(script_path, hook.get_abspath())
- except:
- print "Error updating git %s hook" % hook_name
- raise
-
- if hook_exists("pre-commit") and hook_exists("commit-msg"):
- return
-
- print git_style_message,
- try:
- raw_input()
- except:
- print "Input exception, exiting scons.\n"
- sys.exit(1)
-
- git_style_script = File("util/git-pre-commit.py")
- git_msg_script = File("ext/git-commit-msg")
-
- hook_install("pre-commit", git_style_script)
- hook_install("commit-msg", git_msg_script)
-
-# Try to wire up git to the style hooks
-if not ignore_style and main.root.Entry(".git").exists():
- install_git_style_hooks()
-
###################################################
#
# Figure out which configurations to set up based on the path(s) of
# Add shared top-level headers
main.Prepend(CPPPATH=Dir('include'))
-def strip_build_path(path, env):
- path = str(path)
- variant_base = env['BUILDROOT'] + os.path.sep
- if path.startswith(variant_base):
- path = path[len(variant_base):]
- elif path.startswith('build/'):
- path = path[6:]
- return path
-
-# Generate a string of the form:
-# common/path/prefix/src1, src2 -> tgt1, tgt2
-# to print while building.
-class Transform(object):
- # all specific color settings should be here and nowhere else
- tool_color = termcap.Normal
- pfx_color = termcap.Yellow
- srcs_color = termcap.Yellow + termcap.Bold
- arrow_color = termcap.Blue + termcap.Bold
- tgts_color = termcap.Yellow + termcap.Bold
-
- def __init__(self, tool, max_sources=99):
- self.format = self.tool_color + (" [%8s] " % tool) \
- + self.pfx_color + "%s" \
- + self.srcs_color + "%s" \
- + self.arrow_color + " -> " \
- + self.tgts_color + "%s" \
- + termcap.Normal
- self.max_sources = max_sources
-
- def __call__(self, target, source, env, for_signature=None):
- # truncate source list according to max_sources param
- source = source[0:self.max_sources]
- def strip(f):
- return strip_build_path(str(f), env)
- if len(source) > 0:
- srcs = map(strip, source)
- else:
- srcs = ['']
- tgts = map(strip, target)
- # surprisingly, os.path.commonprefix is a dumb char-by-char string
- # operation that has nothing to do with paths.
- com_pfx = os.path.commonprefix(srcs + tgts)
- com_pfx_len = len(com_pfx)
- if com_pfx:
- # do some cleanup and sanity checking on common prefix
- if com_pfx[-1] == ".":
- # prefix matches all but file extension: ok
- # back up one to change 'foo.cc -> o' to 'foo.cc -> .o'
- com_pfx = com_pfx[0:-1]
- elif com_pfx[-1] == "/":
- # common prefix is directory path: OK
- pass
- else:
- src0_len = len(srcs[0])
- tgt0_len = len(tgts[0])
- if src0_len == com_pfx_len:
- # source is a substring of target, OK
- pass
- elif tgt0_len == com_pfx_len:
- # target is a substring of source, need to back up to
- # avoid empty string on RHS of arrow
- sep_idx = com_pfx.rfind(".")
- if sep_idx != -1:
- com_pfx = com_pfx[0:sep_idx]
- else:
- com_pfx = ''
- elif src0_len > com_pfx_len and srcs[0][com_pfx_len] == ".":
- # still splitting at file extension: ok
- pass
- else:
- # probably a fluke; ignore it
- com_pfx = ''
- # recalculate length in case com_pfx was modified
- com_pfx_len = len(com_pfx)
- def fmt(files):
- f = map(lambda s: s[com_pfx_len:], files)
- return ', '.join(f)
- return self.format % (com_pfx, fmt(srcs), fmt(tgts))
-
-Export('Transform')
-
-# enable the regression script to use the termcap
-main['TERMCAP'] = termcap
-
if GetOption('verbose'):
def MakeAction(action, string, *args, **kwargs):
return Action(action, *args, **kwargs)
shared_partial_flags = ['-r', '-nostdlib']
main.Append(PSHLINKFLAGS=shared_partial_flags)
main.Append(PLINKFLAGS=shared_partial_flags)
+
+ # Treat warnings as errors but white list some warnings that we
+ # want to allow (e.g., deprecation warnings).
+ main.Append(CCFLAGS=['-Werror',
+ '-Wno-error=deprecated-declarations',
+ '-Wno-error=deprecated',
+ ])
else:
print termcap.Yellow + termcap.Bold + 'Error' + termcap.Normal,
print "Don't know what compiler options to use for your compiler."
if compareVersions(gcc_version, "5.0") > 0:
main.Append(CCFLAGS=['-Wno-error=suggest-override'])
+ # The address sanitizer is available for gcc >= 4.8
+ if GetOption('with_asan'):
+ if GetOption('with_ubsan') and \
+ compareVersions(env['GCC_VERSION'], '4.9') >= 0:
+ env.Append(CCFLAGS=['-fsanitize=address,undefined',
+ '-fno-omit-frame-pointer'],
+ LINKFLAGS='-fsanitize=address,undefined')
+ else:
+ env.Append(CCFLAGS=['-fsanitize=address',
+ '-fno-omit-frame-pointer'],
+ LINKFLAGS='-fsanitize=address')
+ # Only gcc >= 4.9 supports UBSan, so check both the version
+ # and the command-line option before adding the compiler and
+ # linker flags.
+ elif GetOption('with_ubsan') and \
+ compareVersions(env['GCC_VERSION'], '4.9') >= 0:
+ env.Append(CCFLAGS='-fsanitize=undefined')
+ env.Append(LINKFLAGS='-fsanitize=undefined')
+
elif main['CLANG']:
# Check for a supported version of clang, >= 3.1 is needed to
# support similar features as gcc 4.8. See
if sys.platform.startswith('freebsd'):
main.Append(LIBS=['thr'])
+ # We require clang >= 3.1, so there is no need to check any
+ # versions here.
+ if GetOption('with_ubsan'):
+ if GetOption('with_asan'):
+ env.Append(CCFLAGS=['-fsanitize=address,undefined',
+ '-fno-omit-frame-pointer'],
+ LINKFLAGS='-fsanitize=address,undefined')
+ else:
+ env.Append(CCFLAGS='-fsanitize=undefined',
+ LINKFLAGS='-fsanitize=undefined')
+
+ elif GetOption('with_asan'):
+ env.Append(CCFLAGS=['-fsanitize=address',
+ '-fno-omit-frame-pointer'],
+ LINKFLAGS='-fsanitize=address')
+
else:
print termcap.Yellow + termcap.Bold + 'Error' + termcap.Normal,
print "Don't know what compiler options to use for your compiler."
projects / gem5.git / blobdiff