1# -*- mode:python -*-
2
3# Copyright (c) 2011 Advanced Micro Devices, Inc.
4# Copyright (c) 2009 The Hewlett-Packard Development Company
5# Copyright (c) 2004-2005 The Regents of The University of Michigan
6# All rights reserved.
7#
8# Redistribution and use in source and binary forms, with or without
9# modification, are permitted provided that the following conditions are
10# met: redistributions of source code must retain the above copyright
11# notice, this list of conditions and the following disclaimer;
12# redistributions in binary form must reproduce the above copyright
13# notice, this list of conditions and the following disclaimer in the
14# documentation and/or other materials provided with the distribution;
15# neither the name of the copyright holders nor the names of its
16# contributors may be used to endorse or promote products derived from
17# this software without specific prior written permission.
18#
19# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
20# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
21# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
22# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
23# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
24# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
25# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
26# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
27# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
28# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
29# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30#
31# Authors: Steve Reinhardt
32# Nathan Binkert
33
34###################################################
35#
36# SCons top-level build description (SConstruct) file.
37#
38# While in this directory ('gem5'), just type 'scons' to build the default
39# configuration (see below), or type 'scons build/<CONFIG>/<binary>'
40# to build some other configuration (e.g., 'build/ALPHA/gem5.opt' for
41# the optimized full-system version).
42#
43# You can build gem5 in a different directory as long as there is a
44# 'build/<CONFIG>' somewhere along the target path. The build system
45# expects that all configs under the same build directory are being
46# built for the same host system.
47#
48# Examples:
49#
50# The following two commands are equivalent. The '-u' option tells
51# scons to search up the directory tree for this SConstruct file.
52# % cd <path-to-src>/gem5 ; scons build/ALPHA/gem5.debug
53# % cd <path-to-src>/gem5/build/ALPHA; scons -u gem5.debug
54#
55# The following two commands are equivalent and demonstrate building
56# in a directory outside of the source tree. The '-C' option tells
57# scons to chdir to the specified directory to find this SConstruct
58# file.
59# % cd <path-to-src>/gem5 ; scons /local/foo/build/ALPHA/gem5.debug
60# % cd /local/foo/build/ALPHA; scons -C <path-to-src>/gem5 gem5.debug
61#
62# You can use 'scons -H' to print scons options. If you're in this
63# 'gem5' directory (or use -u or -C to tell scons where to find this
64# file), you can use 'scons -h' to print all the gem5-specific build
65# options as well.
66#
67###################################################
68
69# Check for recent-enough Python and SCons versions.
70try:
71 # Really old versions of scons only take two options for the
72 # function, so check once without the revision and once with the
73 # revision, the first instance will fail for stuff other than
74 # 0.98, and the second will fail for 0.98.0
75 EnsureSConsVersion(0, 98)
76 EnsureSConsVersion(0, 98, 1)
77except SystemExit, e:
78 print """
79For more details, see:
80 http://gem5.org/Dependencies
81"""
82 raise
83
84# We ensure the python version early because we have stuff that
85# requires python 2.4
86try:
87 EnsurePythonVersion(2, 4)
88except SystemExit, e:
89 print """
90You can use a non-default installation of the Python interpreter by
91either (1) rearranging your PATH so that scons finds the non-default
92'python' first or (2) explicitly invoking an alternative interpreter
93on the scons script.
94
95For more details, see:
96 http://gem5.org/wiki/index.php/Using_a_non-default_Python_installation
97"""
98 raise
99
100# Global Python includes
101import os
102import re
103import subprocess
104import sys
105
106from os import mkdir, environ
107from os.path import abspath, basename, dirname, expanduser, normpath
108from os.path import exists, isdir, isfile
109from os.path import join as joinpath, split as splitpath
110
111# SCons includes
112import SCons
113import SCons.Node
114
115extra_python_paths = [
116 Dir('src/python').srcnode().abspath, # gem5 includes
117 Dir('ext/ply').srcnode().abspath, # ply is used by several files
118 ]
119
120sys.path[1:1] = extra_python_paths
121
122from m5.util import compareVersions, readCommand
123from m5.util.terminal import get_termcap
124
125help_texts = {
126 "options" : "",
127 "global_vars" : "",
128 "local_vars" : ""
129}
130
131Export("help_texts")
132
133
134# There's a bug in scons in that (1) by default, the help texts from
135# AddOption() are supposed to be displayed when you type 'scons -h'
136# and (2) you can override the help displayed by 'scons -h' using the
137# Help() function, but these two features are incompatible: once
138# you've overridden the help text using Help(), there's no way to get
139# at the help texts from AddOptions. See:
140# http://scons.tigris.org/issues/show_bug.cgi?id=2356
141# http://scons.tigris.org/issues/show_bug.cgi?id=2611
142# This hack lets us extract the help text from AddOptions and
143# re-inject it via Help(). Ideally someday this bug will be fixed and
144# we can just use AddOption directly.
145def AddLocalOption(*args, **kwargs):
146 col_width = 30
147
148 help = " " + ", ".join(args)
149 if "help" in kwargs:
150 length = len(help)
151 if length >= col_width:
152 help += "\n" + " " * col_width
153 else:
154 help += " " * (col_width - length)
155 help += kwargs["help"]
156 help_texts["options"] += help + "\n"
157
158 AddOption(*args, **kwargs)
159
160AddLocalOption('--colors', dest='use_colors', action='store_true',
161 help="Add color to abbreviated scons output")
162AddLocalOption('--no-colors', dest='use_colors', action='store_false',
163 help="Don't add color to abbreviated scons output")
164AddLocalOption('--default', dest='default', type='string', action='store',
165 help='Override which build_opts file to use for defaults')
166AddLocalOption('--ignore-style', dest='ignore_style', action='store_true',
167 help='Disable style checking hooks')
168AddLocalOption('--no-lto', dest='no_lto', action='store_true',
169 help='Disable Link-Time Optimization for fast')
170AddLocalOption('--update-ref', dest='update_ref', action='store_true',
171 help='Update test reference outputs')
172AddLocalOption('--verbose', dest='verbose', action='store_true',
173 help='Print full tool command lines')
174
175termcap = get_termcap(GetOption('use_colors'))
176
177########################################################################
178#
179# Set up the main build environment.
180#
181########################################################################
182use_vars = set([ 'AS', 'AR', 'CC', 'CXX', 'HOME', 'LD_LIBRARY_PATH',
183 'LIBRARY_PATH', 'PATH', 'PKG_CONFIG_PATH', 'PYTHONPATH',
184 'RANLIB', 'SWIG' ])
185
186use_prefixes = [
187 "M5", # M5 configuration (e.g., path to kernels)
188 "DISTCC_", # distcc (distributed compiler wrapper) configuration
189 "CCACHE_", # ccache (caching compiler wrapper) configuration
190 "CCC_", # clang static analyzer configuration
191 ]
192
193use_env = {}
194for key,val in os.environ.iteritems():
195 if key in use_vars or \
196 any([key.startswith(prefix) for prefix in use_prefixes]):
197 use_env[key] = val
198
199main = Environment(ENV=use_env)
200main.Decider('MD5-timestamp')
201main.root = Dir(".") # The current directory (where this file lives).
202main.srcdir = Dir("src") # The source directory
203
204main_dict_keys = main.Dictionary().keys()
205
206# Check that we have a C/C++ compiler
207if not ('CC' in main_dict_keys and 'CXX' in main_dict_keys):
208 print "No C++ compiler installed (package g++ on Ubuntu and RedHat)"
209 Exit(1)
210
211# Check that swig is present
212if not 'SWIG' in main_dict_keys:
213 print "swig is not installed (package swig on Ubuntu and RedHat)"
214 Exit(1)
215
216# add useful python code PYTHONPATH so it can be used by subprocesses
217# as well
218main.AppendENVPath('PYTHONPATH', extra_python_paths)
219
220########################################################################
221#
222# Mercurial Stuff.
223#
224# If the gem5 directory is a mercurial repository, we should do some
225# extra things.
226#
227########################################################################
228
229hgdir = main.root.Dir(".hg")
230
231mercurial_style_message = """
232You're missing the gem5 style hook, which automatically checks your code
233against the gem5 style rules on hg commit and qrefresh commands. This
234script will now install the hook in your .hg/hgrc file.
235Press enter to continue, or ctrl-c to abort: """
236
237mercurial_style_hook = """
238# The following lines were automatically added by gem5/SConstruct
239# to provide the gem5 style-checking hooks
240[extensions]
241style = %s/util/style.py
242
243[hooks]
244pretxncommit.style = python:style.check_style
245pre-qrefresh.style = python:style.check_style
246# End of SConstruct additions
247
248""" % (main.root.abspath)
249
250mercurial_lib_not_found = """
251Mercurial libraries cannot be found, ignoring style hook. If
252you are a gem5 developer, please fix this and run the style
253hook. It is important.
254"""
255
256# Check for style hook and prompt for installation if it's not there.
257# Skip this if --ignore-style was specified, there's no .hg dir to
258# install a hook in, or there's no interactive terminal to prompt.
259if not GetOption('ignore_style') and hgdir.exists() and sys.stdin.isatty():
260 style_hook = True
261 try:
262 from mercurial import ui
263 ui = ui.ui()
264 ui.readconfig(hgdir.File('hgrc').abspath)
265 style_hook = ui.config('hooks', 'pretxncommit.style', None) and \
266 ui.config('hooks', 'pre-qrefresh.style', None)
267 except ImportError:
268 print mercurial_lib_not_found
269
270 if not style_hook:
271 print mercurial_style_message,
272 # continue unless user does ctrl-c/ctrl-d etc.
273 try:
274 raw_input()
275 except:
276 print "Input exception, exiting scons.\n"
277 sys.exit(1)
278 hgrc_path = '%s/.hg/hgrc' % main.root.abspath
279 print "Adding style hook to", hgrc_path, "\n"
280 try:
281 hgrc = open(hgrc_path, 'a')
282 hgrc.write(mercurial_style_hook)
283 hgrc.close()
284 except:
285 print "Error updating", hgrc_path
286 sys.exit(1)
287
288
289###################################################
290#
291# Figure out which configurations to set up based on the path(s) of
292# the target(s).
293#
294###################################################
295
296# Find default configuration & binary.
297Default(environ.get('M5_DEFAULT_BINARY', 'build/ALPHA/gem5.debug'))
298
299# helper function: find last occurrence of element in list
300def rfind(l, elt, offs = -1):
301 for i in range(len(l)+offs, 0, -1):
302 if l[i] == elt:
303 return i
304 raise ValueError, "element not found"
305
306# Take a list of paths (or SCons Nodes) and return a list with all
307# paths made absolute and ~-expanded. Paths will be interpreted
308# relative to the launch directory unless a different root is provided
309def makePathListAbsolute(path_list, root=GetLaunchDir()):
310 return [abspath(joinpath(root, expanduser(str(p))))
311 for p in path_list]
312
313# Each target must have 'build' in the interior of the path; the
314# directory below this will determine the build parameters. For
315# example, for target 'foo/bar/build/ALPHA_SE/arch/alpha/blah.do' we
316# recognize that ALPHA_SE specifies the configuration because it
317# follow 'build' in the build path.
318
319# The funky assignment to "[:]" is needed to replace the list contents
320# in place rather than reassign the symbol to a new list, which
321# doesn't work (obviously!).
322BUILD_TARGETS[:] = makePathListAbsolute(BUILD_TARGETS)
323
324# Generate a list of the unique build roots and configs that the
325# collected targets reference.
326variant_paths = []
327build_root = None
328for t in BUILD_TARGETS:
329 path_dirs = t.split('/')
330 try:
331 build_top = rfind(path_dirs, 'build', -2)
332 except:
333 print "Error: no non-leaf 'build' dir found on target path", t
334 Exit(1)
335 this_build_root = joinpath('/',*path_dirs[:build_top+1])
336 if not build_root:
337 build_root = this_build_root
338 else:
339 if this_build_root != build_root:
340 print "Error: build targets not under same build root\n"\
341 " %s\n %s" % (build_root, this_build_root)
342 Exit(1)
343 variant_path = joinpath('/',*path_dirs[:build_top+2])
344 if variant_path not in variant_paths:
345 variant_paths.append(variant_path)
346
347# Make sure build_root exists (might not if this is the first build there)
348if not isdir(build_root):
349 mkdir(build_root)
350main['BUILDROOT'] = build_root
351
352Export('main')
353
354main.SConsignFile(joinpath(build_root, "sconsign"))
355
356# Default duplicate option is to use hard links, but this messes up
357# when you use emacs to edit a file in the target dir, as emacs moves
358# file to file~ then copies to file, breaking the link. Symbolic
359# (soft) links work better.
360main.SetOption('duplicate', 'soft-copy')
361
362#
363# Set up global sticky variables... these are common to an entire build
364# tree (not specific to a particular build like ALPHA_SE)
365#
366
367global_vars_file = joinpath(build_root, 'variables.global')
368
369global_vars = Variables(global_vars_file, args=ARGUMENTS)
370
371global_vars.AddVariables(
372 ('CC', 'C compiler', environ.get('CC', main['CC'])),
373 ('CXX', 'C++ compiler', environ.get('CXX', main['CXX'])),
374 ('SWIG', 'SWIG tool', environ.get('SWIG', main['SWIG'])),
375 ('PROTOC', 'protoc tool', environ.get('PROTOC', 'protoc')),
376 ('BATCH', 'Use batch pool for build and tests', False),
377 ('BATCH_CMD', 'Batch pool submission command name', 'qdo'),
378 ('M5_BUILD_CACHE', 'Cache built objects in this directory', False),
379 ('EXTRAS', 'Add extra directories to the compilation', '')
380 )
381
382# Update main environment with values from ARGUMENTS & global_vars_file
383global_vars.Update(main)
384help_texts["global_vars"] += global_vars.GenerateHelpText(main)
385
386# Save sticky variable settings back to current variables file
387global_vars.Save(global_vars_file, main)
388
389# Parse EXTRAS variable to build list of all directories where we're
390# look for sources etc. This list is exported as extras_dir_list.
391base_dir = main.srcdir.abspath
392if main['EXTRAS']:
393 extras_dir_list = makePathListAbsolute(main['EXTRAS'].split(':'))
394else:
395 extras_dir_list = []
396
397Export('base_dir')
398Export('extras_dir_list')
399
400# the ext directory should be on the #includes path
401main.Append(CPPPATH=[Dir('ext')])
402
403def strip_build_path(path, env):
404 path = str(path)
405 variant_base = env['BUILDROOT'] + os.path.sep
406 if path.startswith(variant_base):
407 path = path[len(variant_base):]
408 elif path.startswith('build/'):
409 path = path[6:]
410 return path
411
412# Generate a string of the form:
413# common/path/prefix/src1, src2 -> tgt1, tgt2
414# to print while building.
415class Transform(object):
416 # all specific color settings should be here and nowhere else
417 tool_color = termcap.Normal
418 pfx_color = termcap.Yellow
419 srcs_color = termcap.Yellow + termcap.Bold
420 arrow_color = termcap.Blue + termcap.Bold
421 tgts_color = termcap.Yellow + termcap.Bold
422
423 def __init__(self, tool, max_sources=99):
424 self.format = self.tool_color + (" [%8s] " % tool) \
425 + self.pfx_color + "%s" \
426 + self.srcs_color + "%s" \
427 + self.arrow_color + " -> " \
428 + self.tgts_color + "%s" \
429 + termcap.Normal
430 self.max_sources = max_sources
431
432 def __call__(self, target, source, env, for_signature=None):
433 # truncate source list according to max_sources param
434 source = source[0:self.max_sources]
435 def strip(f):
436 return strip_build_path(str(f), env)
437 if len(source) > 0:
438 srcs = map(strip, source)
439 else:
440 srcs = ['']
441 tgts = map(strip, target)
442 # surprisingly, os.path.commonprefix is a dumb char-by-char string
443 # operation that has nothing to do with paths.
444 com_pfx = os.path.commonprefix(srcs + tgts)
445 com_pfx_len = len(com_pfx)
446 if com_pfx:
447 # do some cleanup and sanity checking on common prefix
448 if com_pfx[-1] == ".":
449 # prefix matches all but file extension: ok
450 # back up one to change 'foo.cc -> o' to 'foo.cc -> .o'
451 com_pfx = com_pfx[0:-1]
452 elif com_pfx[-1] == "/":
453 # common prefix is directory path: OK
454 pass
455 else:
456 src0_len = len(srcs[0])
457 tgt0_len = len(tgts[0])
458 if src0_len == com_pfx_len:
459 # source is a substring of target, OK
460 pass
461 elif tgt0_len == com_pfx_len:
462 # target is a substring of source, need to back up to
463 # avoid empty string on RHS of arrow
464 sep_idx = com_pfx.rfind(".")
465 if sep_idx != -1:
466 com_pfx = com_pfx[0:sep_idx]
467 else:
468 com_pfx = ''
469 elif src0_len > com_pfx_len and srcs[0][com_pfx_len] == ".":
470 # still splitting at file extension: ok
471 pass
472 else:
473 # probably a fluke; ignore it
474 com_pfx = ''
475 # recalculate length in case com_pfx was modified
476 com_pfx_len = len(com_pfx)
477 def fmt(files):
478 f = map(lambda s: s[com_pfx_len:], files)
479 return ', '.join(f)
480 return self.format % (com_pfx, fmt(srcs), fmt(tgts))
481
482Export('Transform')
483
484# enable the regression script to use the termcap
485main['TERMCAP'] = termcap
486
487if GetOption('verbose'):
488 def MakeAction(action, string, *args, **kwargs):
489 return Action(action, *args, **kwargs)
490else:
491 MakeAction = Action
492 main['CCCOMSTR'] = Transform("CC")
493 main['CXXCOMSTR'] = Transform("CXX")
494 main['ASCOMSTR'] = Transform("AS")
495 main['SWIGCOMSTR'] = Transform("SWIG")
496 main['ARCOMSTR'] = Transform("AR", 0)
497 main['LINKCOMSTR'] = Transform("LINK", 0)
498 main['RANLIBCOMSTR'] = Transform("RANLIB", 0)
499 main['M4COMSTR'] = Transform("M4")
500 main['SHCCCOMSTR'] = Transform("SHCC")
501 main['SHCXXCOMSTR'] = Transform("SHCXX")
502Export('MakeAction')
503
504# Initialize the Link-Time Optimization (LTO) flags
505main['LTO_CCFLAGS'] = []
506main['LTO_LDFLAGS'] = []
507
508CXX_version = readCommand([main['CXX'],'--version'], exception=False)
509CXX_V = readCommand([main['CXX'],'-V'], exception=False)
510
511main['GCC'] = CXX_version and CXX_version.find('g++') >= 0
512main['CLANG'] = CXX_version and CXX_version.find('clang') >= 0
513if main['GCC'] + main['CLANG'] > 1:
514 print 'Error: How can we have two at the same time?'
515 Exit(1)
516
517# Set up default C++ compiler flags
518if main['GCC']:
519 # Check for a supported version of gcc, >= 4.4 is needed for c++0x
520 # support. See http://gcc.gnu.org/projects/cxx0x.html for details
521 gcc_version = readCommand([main['CXX'], '-dumpversion'], exception=False)
522 if compareVersions(gcc_version, "4.4") < 0:
523 print 'Error: gcc version 4.4 or newer required.'
524 print ' Installed version:', gcc_version
525 Exit(1)
526
527 main['GCC_VERSION'] = gcc_version
528 main.Append(CCFLAGS=['-pipe'])
529 main.Append(CCFLAGS=['-fno-strict-aliasing'])
530 main.Append(CCFLAGS=['-Wall', '-Wno-sign-compare', '-Wundef'])
531 main.Append(CXXFLAGS=['-std=c++0x'])
532
533 # Check for versions with bugs
534 if not compareVersions(gcc_version, '4.4.1') or \
535 not compareVersions(gcc_version, '4.4.2'):
536 print 'Info: Tree vectorizer in GCC 4.4.1 & 4.4.2 is buggy, disabling.'
537 main.Append(CCFLAGS=['-fno-tree-vectorize'])
538
539 # LTO support is only really working properly from 4.6 and beyond
540 if compareVersions(gcc_version, '4.6') >= 0:
541 # Add the appropriate Link-Time Optimization (LTO) flags
542 # unless LTO is explicitly turned off. Note that these flags
543 # are only used by the fast target.
544 if not GetOption('no_lto'):
545 # Pass the LTO flag when compiling to produce GIMPLE
546 # output, we merely create the flags here and only append
547 # them later/
548 main['LTO_CCFLAGS'] = ['-flto=%d' % GetOption('num_jobs')]
549
550 # Use the same amount of jobs for LTO as we are running
551 # scons with, we hardcode the use of the linker plugin
552 # which requires either gold or GNU ld >= 2.21
553 main['LTO_LDFLAGS'] = ['-flto=%d' % GetOption('num_jobs'),
554 '-fuse-linker-plugin']
555
556elif main['CLANG']:
557 # Check for a supported version of clang, >= 2.9 is needed to
558 # support similar features as gcc 4.4. See
559 # http://clang.llvm.org/cxx_status.html for details
560 clang_version_re = re.compile(".* version (\d+\.\d+)")
561 clang_version_match = clang_version_re.match(CXX_version)
562 if (clang_version_match):
563 clang_version = clang_version_match.groups()[0]
564 if compareVersions(clang_version, "2.9") < 0:
565 print 'Error: clang version 2.9 or newer required.'
566 print ' Installed version:', clang_version
567 Exit(1)
568 else:
569 print 'Error: Unable to determine clang version.'
570 Exit(1)
571
572 main.Append(CCFLAGS=['-pipe'])
573 main.Append(CCFLAGS=['-fno-strict-aliasing'])
574 main.Append(CCFLAGS=['-Wall', '-Wno-sign-compare', '-Wundef'])
575 main.Append(CCFLAGS=['-Wno-tautological-compare'])
576 main.Append(CCFLAGS=['-Wno-self-assign'])
577 # Ruby makes frequent use of extraneous parantheses in the printing
578 # of if-statements
579 main.Append(CCFLAGS=['-Wno-parentheses'])
580 main.Append(CXXFLAGS=['-std=c++0x'])
581 # On Mac OS X/Darwin we need to also use libc++ (part of XCode) as
582 # opposed to libstdc++ to make the transition from TR1 to
583 # C++11. See http://libcxx.llvm.org. However, clang has chosen a
584 # strict implementation of the C++11 standard, and does not allow
585 # incomplete types in template arguments (besides unique_ptr and
586 # shared_ptr), and the libc++ STL containers create problems in
587 # combination with the current gem5 code. For now, we stick with
588 # libstdc++ and use the TR1 namespace.
589 # if sys.platform == "darwin":
590 # main.Append(CXXFLAGS=['-stdlib=libc++'])
591
592else:
593 print termcap.Yellow + termcap.Bold + 'Error' + termcap.Normal,
594 print "Don't know what compiler options to use for your compiler."
595 print termcap.Yellow + ' compiler:' + termcap.Normal, main['CXX']
596 print termcap.Yellow + ' version:' + termcap.Normal,
597 if not CXX_version:
598 print termcap.Yellow + termcap.Bold + "COMMAND NOT FOUND!" +\
599 termcap.Normal
600 else:
601 print CXX_version.replace('\n', '<nl>')
602 print " If you're trying to use a compiler other than GCC"
603 print " or clang, there appears to be something wrong with your"
604 print " environment."
605 print " "
606 print " If you are trying to use a compiler other than those listed"
607 print " above you will need to ease fix SConstruct and "
608 print " src/SConscript to support that compiler."
609 Exit(1)
610
611# Set up common yacc/bison flags (needed for Ruby)
612main['YACCFLAGS'] = '-d'
613main['YACCHXXFILESUFFIX'] = '.hh'
614
615# Do this after we save setting back, or else we'll tack on an
616# extra 'qdo' every time we run scons.
617if main['BATCH']:
618 main['CC'] = main['BATCH_CMD'] + ' ' + main['CC']
619 main['CXX'] = main['BATCH_CMD'] + ' ' + main['CXX']
620 main['AS'] = main['BATCH_CMD'] + ' ' + main['AS']
621 main['AR'] = main['BATCH_CMD'] + ' ' + main['AR']
622 main['RANLIB'] = main['BATCH_CMD'] + ' ' + main['RANLIB']
623
624if sys.platform == 'cygwin':
625 # cygwin has some header file issues...
626 main.Append(CCFLAGS=["-Wno-uninitialized"])
627
628# Check for the protobuf compiler
629protoc_version = readCommand([main['PROTOC'], '--version'],
630 exception='').split()
631
632# First two words should be "libprotoc x.y.z"
633if len(protoc_version) < 2 or protoc_version[0] != 'libprotoc':
634 print termcap.Yellow + termcap.Bold + \
635 'Warning: Protocol buffer compiler (protoc) not found.\n' + \
636 ' Please install protobuf-compiler for tracing support.' + \
637 termcap.Normal
638 main['PROTOC'] = False
639else:
640 # Determine the appropriate include path and library path using
641 # pkg-config, that means we also need to check for pkg-config
642 if not readCommand(['pkg-config', '--version'], exception=''):
643 print 'Error: pkg-config not found. Please install and retry.'
644 Exit(1)
645
646 main.ParseConfig('pkg-config --cflags --libs-only-L protobuf')
647
648 # Based on the availability of the compress stream wrappers,
649 # require 2.1.0
650 min_protoc_version = '2.1.0'
651 if compareVersions(protoc_version[1], min_protoc_version) < 0:
652 print 'Error: protoc version', min_protoc_version, 'or newer required.'
653 print ' Installed version:', protoc_version[1]
654 Exit(1)
655
656# Check for SWIG
657if not main.has_key('SWIG'):
658 print 'Error: SWIG utility not found.'
659 print ' Please install (see http://www.swig.org) and retry.'
660 Exit(1)
661
662# Check for appropriate SWIG version
663swig_version = readCommand([main['SWIG'], '-version'], exception='').split()
664# First 3 words should be "SWIG Version x.y.z"
665if len(swig_version) < 3 or \
666 swig_version[0] != 'SWIG' or swig_version[1] != 'Version':
667 print 'Error determining SWIG version.'
668 Exit(1)
669
670min_swig_version = '1.3.34'
671if compareVersions(swig_version[2], min_swig_version) < 0:
672 print 'Error: SWIG version', min_swig_version, 'or newer required.'
673 print ' Installed version:', swig_version[2]
674 Exit(1)
675
676# Set up SWIG flags & scanner
677swig_flags=Split('-c++ -python -modern -templatereduce $_CPPINCFLAGS')
678main.Append(SWIGFLAGS=swig_flags)
679
680# filter out all existing swig scanners, they mess up the dependency
681# stuff for some reason
682scanners = []
683for scanner in main['SCANNERS']:
684 skeys = scanner.skeys
685 if skeys == '.i':
686 continue
687
688 if isinstance(skeys, (list, tuple)) and '.i' in skeys:
689 continue
690
691 scanners.append(scanner)
692
693# add the new swig scanner that we like better
694from SCons.Scanner import ClassicCPP as CPPScanner
695swig_inc_re = '^[ \t]*[%,#][ \t]*(?:include|import)[ \t]*(<|")([^>"]+)(>|")'
696scanners.append(CPPScanner("SwigScan", [ ".i" ], "CPPPATH", swig_inc_re))
697
698# replace the scanners list that has what we want
699main['SCANNERS'] = scanners
700
701# Add a custom Check function to the Configure context so that we can
702# figure out if the compiler adds leading underscores to global
703# variables. This is needed for the autogenerated asm files that we
704# use for embedding the python code.
705def CheckLeading(context):
706 context.Message("Checking for leading underscore in global variables...")
707 # 1) Define a global variable called x from asm so the C compiler
708 # won't change the symbol at all.
709 # 2) Declare that variable.
710 # 3) Use the variable
711 #
712 # If the compiler prepends an underscore, this will successfully
713 # link because the external symbol 'x' will be called '_x' which
714 # was defined by the asm statement. If the compiler does not
715 # prepend an underscore, this will not successfully link because
716 # '_x' will have been defined by assembly, while the C portion of
717 # the code will be trying to use 'x'
718 ret = context.TryLink('''
719 asm(".globl _x; _x: .byte 0");
720 extern int x;
721 int main() { return x; }
722 ''', extension=".c")
723 context.env.Append(LEADING_UNDERSCORE=ret)
724 context.Result(ret)
725 return ret
726
727# Platform-specific configuration. Note again that we assume that all
728# builds under a given build root run on the same host platform.
729conf = Configure(main,
730 conf_dir = joinpath(build_root, '.scons_config'),
731 log_file = joinpath(build_root, 'scons_config.log'),
732 custom_tests = { 'CheckLeading' : CheckLeading })
733
734# Check for leading underscores. Don't really need to worry either
735# way so don't need to check the return code.
736conf.CheckLeading()
737
738# Check if we should compile a 64 bit binary on Mac OS X/Darwin
739try:
740 import platform
741 uname = platform.uname()
742 if uname[0] == 'Darwin' and compareVersions(uname[2], '9.0.0') >= 0:
743 if int(readCommand('sysctl -n hw.cpu64bit_capable')[0]):
744 main.Append(CCFLAGS=['-arch', 'x86_64'])
745 main.Append(CFLAGS=['-arch', 'x86_64'])
746 main.Append(LINKFLAGS=['-arch', 'x86_64'])
747 main.Append(ASFLAGS=['-arch', 'x86_64'])
748except:
749 pass
750
751# Recent versions of scons substitute a "Null" object for Configure()
752# when configuration isn't necessary, e.g., if the "--help" option is
753# present. Unfortuantely this Null object always returns false,
754# breaking all our configuration checks. We replace it with our own
755# more optimistic null object that returns True instead.
756if not conf:
757 def NullCheck(*args, **kwargs):
758 return True
759
760 class NullConf:
761 def __init__(self, env):
762 self.env = env
763 def Finish(self):
764 return self.env
765 def __getattr__(self, mname):
766 return NullCheck
767
768 conf = NullConf(main)
769
770# Find Python include and library directories for embedding the
771# interpreter. For consistency, we will use the same Python
772# installation used to run scons (and thus this script). If you want
773# to link in an alternate version, see above for instructions on how
774# to invoke scons with a different copy of the Python interpreter.
775from distutils import sysconfig
776
777py_getvar = sysconfig.get_config_var
778
779py_debug = getattr(sys, 'pydebug', False)
780py_version = 'python' + py_getvar('VERSION') + (py_debug and "_d" or "")
781
782py_general_include = sysconfig.get_python_inc()
783py_platform_include = sysconfig.get_python_inc(plat_specific=True)
784py_includes = [ py_general_include ]
785if py_platform_include != py_general_include:
786 py_includes.append(py_platform_include)
787
788py_lib_path = [ py_getvar('LIBDIR') ]
789# add the prefix/lib/pythonX.Y/config dir, but only if there is no
790# shared library in prefix/lib/.
791if not py_getvar('Py_ENABLE_SHARED'):
792 py_lib_path.append(py_getvar('LIBPL'))
793
794py_libs = []
795for lib in py_getvar('LIBS').split() + py_getvar('SYSLIBS').split():
796 if not lib.startswith('-l'):
797 # Python requires some special flags to link (e.g. -framework
798 # common on OS X systems), assume appending preserves order
799 main.Append(LINKFLAGS=[lib])
800 else:
801 lib = lib[2:]
802 if lib not in py_libs:
803 py_libs.append(lib)
804py_libs.append(py_version)
805
806main.Append(CPPPATH=py_includes)
807main.Append(LIBPATH=py_lib_path)
808
809# Cache build files in the supplied directory.
810if main['M5_BUILD_CACHE']:
811 print 'Using build cache located at', main['M5_BUILD_CACHE']
812 CacheDir(main['M5_BUILD_CACHE'])
813
814
815# verify that this stuff works
816if not conf.CheckHeader('Python.h', '<>'):
817 print "Error: can't find Python.h header in", py_includes
818 print "Install Python headers (package python-dev on Ubuntu and RedHat)"
819 Exit(1)
820
821for lib in py_libs:
822 if not conf.CheckLib(lib):
823 print "Error: can't find library %s required by python" % lib
824 Exit(1)
825
826# On Solaris you need to use libsocket for socket ops
827if not conf.CheckLibWithHeader(None, 'sys/socket.h', 'C++', 'accept(0,0,0);'):
828 if not conf.CheckLibWithHeader('socket', 'sys/socket.h', 'C++', 'accept(0,0,0);'):
829 print "Can't find library with socket calls (e.g. accept())"
830 Exit(1)
831
832# Check for zlib. If the check passes, libz will be automatically
833# added to the LIBS environment variable.
834if not conf.CheckLibWithHeader('z', 'zlib.h', 'C++','zlibVersion();'):
835 print 'Error: did not find needed zlib compression library '\
836 'and/or zlib.h header file.'
837 print ' Please install zlib and try again.'
838 Exit(1)
839
840# If we have the protobuf compiler, also make sure we have the
841# development libraries. If the check passes, libprotobuf will be
842# automatically added to the LIBS environment variable. After
843# this, we can use the HAVE_PROTOBUF flag to determine if we have
844# got both protoc and libprotobuf available.
845main['HAVE_PROTOBUF'] = main['PROTOC'] and \
846 conf.CheckLibWithHeader('protobuf', 'google/protobuf/message.h',
847 'C++', 'GOOGLE_PROTOBUF_VERIFY_VERSION;')
848
849# If we have the compiler but not the library, treat it as an error.
850if main['PROTOC'] and not main['HAVE_PROTOBUF']:
851 print 'Error: did not find protocol buffer library and/or headers.'
852 print ' Please install libprotobuf-dev and try again.'
853 Exit(1)
854
855# Check for librt.
856have_posix_clock = \
857 conf.CheckLibWithHeader(None, 'time.h', 'C',
858 'clock_nanosleep(0,0,NULL,NULL);') or \
859 conf.CheckLibWithHeader('rt', 'time.h', 'C',
860 'clock_nanosleep(0,0,NULL,NULL);')
861
862if conf.CheckLib('tcmalloc_minimal'):
863 have_tcmalloc = True
864else:
865 have_tcmalloc = False
866 print termcap.Yellow + termcap.Bold + \
867 "You can get a 12% performance improvement by installing tcmalloc "\
868 "(libgoogle-perftools-dev package on Ubuntu or RedHat)." + \
869 termcap.Normal
870
871if not have_posix_clock:
872 print "Can't find library for POSIX clocks."
873
874# Check for <fenv.h> (C99 FP environment control)
875have_fenv = conf.CheckHeader('fenv.h', '<>')
876if not have_fenv:
877 print "Warning: Header file <fenv.h> not found."
878 print " This host has no IEEE FP rounding mode control."
879
880######################################################################
881#
882# Finish the configuration
883#
884main = conf.Finish()
885
886######################################################################
887#
888# Collect all non-global variables
889#
890
891# Define the universe of supported ISAs
892all_isa_list = [ ]
893Export('all_isa_list')
894
895class CpuModel(object):
896 '''The CpuModel class encapsulates everything the ISA parser needs to
897 know about a particular CPU model.'''
898
899 # Dict of available CPU model objects. Accessible as CpuModel.dict.
900 dict = {}
901 list = []
902 defaults = []
903
904 # Constructor. Automatically adds models to CpuModel.dict.
905 def __init__(self, name, filename, includes, strings, default=False):
906 self.name = name # name of model
907 self.filename = filename # filename for output exec code
908 self.includes = includes # include files needed in exec file
909 # The 'strings' dict holds all the per-CPU symbols we can
910 # substitute into templates etc.
911 self.strings = strings
912
913 # This cpu is enabled by default
914 self.default = default
915
916 # Add self to dict
917 if name in CpuModel.dict:
918 raise AttributeError, "CpuModel '%s' already registered" % name
919 CpuModel.dict[name] = self
920 CpuModel.list.append(name)
921
922Export('CpuModel')
923
924# Sticky variables get saved in the variables file so they persist from
925# one invocation to the next (unless overridden, in which case the new
926# value becomes sticky).
927sticky_vars = Variables(args=ARGUMENTS)
928Export('sticky_vars')
929
930# Sticky variables that should be exported
931export_vars = []
932Export('export_vars')
933
934# For Ruby
935all_protocols = []
936Export('all_protocols')
937protocol_dirs = []
938Export('protocol_dirs')
939slicc_includes = []
940Export('slicc_includes')
941
942# Walk the tree and execute all SConsopts scripts that wil add to the
943# above variables
944if not GetOption('verbose'):
945 print "Reading SConsopts"
946for bdir in [ base_dir ] + extras_dir_list:
947 if not isdir(bdir):
948 print "Error: directory '%s' does not exist" % bdir
949 Exit(1)
950 for root, dirs, files in os.walk(bdir):
951 if 'SConsopts' in files:
952 if GetOption('verbose'):
953 print "Reading", joinpath(root, 'SConsopts')
954 SConscript(joinpath(root, 'SConsopts'))
955
956all_isa_list.sort()
957
958sticky_vars.AddVariables(
959 EnumVariable('TARGET_ISA', 'Target ISA', 'alpha', all_isa_list),
960 ListVariable('CPU_MODELS', 'CPU models',
961 sorted(n for n,m in CpuModel.dict.iteritems() if m.default),
962 sorted(CpuModel.list)),
963 BoolVariable('EFENCE', 'Link with Electric Fence malloc debugger',
964 False),
965 BoolVariable('SS_COMPATIBLE_FP',
966 'Make floating-point results compatible with SimpleScalar',
967 False),
968 BoolVariable('USE_SSE2',
969 'Compile for SSE2 (-msse2) to get IEEE FP on x86 hosts',
970 False),
971 BoolVariable('USE_POSIX_CLOCK', 'Use POSIX Clocks', have_posix_clock),
972 BoolVariable('USE_FENV', 'Use <fenv.h> IEEE mode control', have_fenv),
973 BoolVariable('CP_ANNOTATE', 'Enable critical path annotation capability', False),
974 EnumVariable('PROTOCOL', 'Coherence protocol for Ruby', 'None',
975 all_protocols),
976 )
977
978# These variables get exported to #defines in config/*.hh (see src/SConscript).
979export_vars += ['USE_FENV', 'SS_COMPATIBLE_FP', 'TARGET_ISA', 'CP_ANNOTATE',
980 'USE_POSIX_CLOCK', 'PROTOCOL', 'HAVE_PROTOBUF']
981
982###################################################
983#
984# Define a SCons builder for configuration flag headers.
985#
986###################################################
987
988# This function generates a config header file that #defines the
989# variable symbol to the current variable setting (0 or 1). The source
990# operands are the name of the variable and a Value node containing the
991# value of the variable.
992def build_config_file(target, source, env):
993 (variable, value) = [s.get_contents() for s in source]
994 f = file(str(target[0]), 'w')
995 print >> f, '#define', variable, value
996 f.close()
997 return None
998
999# Combine the two functions into a scons Action object.
1000config_action = MakeAction(build_config_file, Transform("CONFIG H", 2))
1001
1002# The emitter munges the source & target node lists to reflect what
1003# we're really doing.
1004def config_emitter(target, source, env):
1005 # extract variable name from Builder arg
1006 variable = str(target[0])
1007 # True target is config header file
1008 target = joinpath('config', variable.lower() + '.hh')
1009 val = env[variable]
1010 if isinstance(val, bool):
1011 # Force value to 0/1
1012 val = int(val)
1013 elif isinstance(val, str):
1014 val = '"' + val + '"'
1015
1016 # Sources are variable name & value (packaged in SCons Value nodes)
1017 return ([target], [Value(variable), Value(val)])
1018
1019config_builder = Builder(emitter = config_emitter, action = config_action)
1020
1021main.Append(BUILDERS = { 'ConfigFile' : config_builder })
1022
1023# libelf build is shared across all configs in the build root.
1024main.SConscript('ext/libelf/SConscript',
1025 variant_dir = joinpath(build_root, 'libelf'))
1026
1027# gzstream build is shared across all configs in the build root.
1028main.SConscript('ext/gzstream/SConscript',
1029 variant_dir = joinpath(build_root, 'gzstream'))
1030
1031###################################################
1032#
1033# This function is used to set up a directory with switching headers
1034#
1035###################################################
1036
1037main['ALL_ISA_LIST'] = all_isa_list
1038def make_switching_dir(dname, switch_headers, env):
1039 # Generate the header. target[0] is the full path of the output
1040 # header to generate. 'source' is a dummy variable, since we get the
1041 # list of ISAs from env['ALL_ISA_LIST'].
1042 def gen_switch_hdr(target, source, env):
1043 fname = str(target[0])
1044 f = open(fname, 'w')
1045 isa = env['TARGET_ISA'].lower()
1046 print >>f, '#include "%s/%s/%s"' % (dname, isa, basename(fname))
1047 f.close()
1048
1049 # Build SCons Action object. 'varlist' specifies env vars that this
1050 # action depends on; when env['ALL_ISA_LIST'] changes these actions
1051 # should get re-executed.
1052 switch_hdr_action = MakeAction(gen_switch_hdr,
1053 Transform("GENERATE"), varlist=['ALL_ISA_LIST'])
1054
1055 # Instantiate actions for each header
1056 for hdr in switch_headers:
1057 env.Command(hdr, [], switch_hdr_action)
1058Export('make_switching_dir')
1059
1060###################################################
1061#
1062# Define build environments for selected configurations.
1063#
1064###################################################
1065
1066for variant_path in variant_paths:
1067 print "Building in", variant_path
1068
1069 # Make a copy of the build-root environment to use for this config.
1070 env = main.Clone()
1071 env['BUILDDIR'] = variant_path
1072
1073 # variant_dir is the tail component of build path, and is used to
1074 # determine the build parameters (e.g., 'ALPHA_SE')
1075 (build_root, variant_dir) = splitpath(variant_path)
1076
1077 # Set env variables according to the build directory config.
1078 sticky_vars.files = []
1079 # Variables for $BUILD_ROOT/$VARIANT_DIR are stored in
1080 # $BUILD_ROOT/variables/$VARIANT_DIR so you can nuke
1081 # $BUILD_ROOT/$VARIANT_DIR without losing your variables settings.
1082 current_vars_file = joinpath(build_root, 'variables', variant_dir)
1083 if isfile(current_vars_file):
1084 sticky_vars.files.append(current_vars_file)
1085 print "Using saved variables file %s" % current_vars_file
1086 else:
1087 # Build dir-specific variables file doesn't exist.
1088
1089 # Make sure the directory is there so we can create it later
1090 opt_dir = dirname(current_vars_file)
1091 if not isdir(opt_dir):
1092 mkdir(opt_dir)
1093
1094 # Get default build variables from source tree. Variables are
1095 # normally determined by name of $VARIANT_DIR, but can be
1096 # overridden by '--default=' arg on command line.
1097 default = GetOption('default')
1098 opts_dir = joinpath(main.root.abspath, 'build_opts')
1099 if default:
1100 default_vars_files = [joinpath(build_root, 'variables', default),
1101 joinpath(opts_dir, default)]
1102 else:
1103 default_vars_files = [joinpath(opts_dir, variant_dir)]
1104 existing_files = filter(isfile, default_vars_files)
1105 if existing_files:
1106 default_vars_file = existing_files[0]
1107 sticky_vars.files.append(default_vars_file)
1108 print "Variables file %s not found,\n using defaults in %s" \
1109 % (current_vars_file, default_vars_file)
1110 else:
1111 print "Error: cannot find variables file %s or " \
1112 "default file(s) %s" \
1113 % (current_vars_file, ' or '.join(default_vars_files))
1114 Exit(1)
1115
1116 # Apply current variable settings to env
1117 sticky_vars.Update(env)
1118
1119 help_texts["local_vars"] += \
1120 "Build variables for %s:\n" % variant_dir \
1121 + sticky_vars.GenerateHelpText(env)
1122
1123 # Process variable settings.
1124
1125 if not have_fenv and env['USE_FENV']:
1126 print "Warning: <fenv.h> not available; " \
1127 "forcing USE_FENV to False in", variant_dir + "."
1128 env['USE_FENV'] = False
1129
1130 if not env['USE_FENV']:
1131 print "Warning: No IEEE FP rounding mode control in", variant_dir + "."
1132 print " FP results may deviate slightly from other platforms."
1133
1134 if env['EFENCE']:
1135 env.Append(LIBS=['efence'])
1136
1137 # Save sticky variable settings back to current variables file
1138 sticky_vars.Save(current_vars_file, env)
1139
1140 if env['USE_SSE2']:
1141 env.Append(CCFLAGS=['-msse2'])
1142
1143 if have_tcmalloc:
1144 env.Append(LIBS=['tcmalloc_minimal'])
1145
1146 # The src/SConscript file sets up the build rules in 'env' according
1147 # to the configured variables. It returns a list of environments,
1148 # one for each variant build (debug, opt, etc.)
1149 envList = SConscript('src/SConscript', variant_dir = variant_path,
1150 exports = 'env')
1151
1152 # Set up the regression tests for each build.
1153 for e in envList:
1154 SConscript('tests/SConscript',
1155 variant_dir = joinpath(variant_path, 'tests', e.Label),
1156 exports = { 'env' : e }, duplicate = False)
1157
1158# base help text
1159Help('''
1160Usage: scons [scons options] [build variables] [target(s)]
1161
1162Extra scons options:
1163%(options)s
1164
1165Global build variables:
1166%(global_vars)s
1167
1168%(local_vars)s
1169''' % help_texts)
2
3# Copyright (c) 2011 Advanced Micro Devices, Inc.
4# Copyright (c) 2009 The Hewlett-Packard Development Company
5# Copyright (c) 2004-2005 The Regents of The University of Michigan
6# All rights reserved.
7#
8# Redistribution and use in source and binary forms, with or without
9# modification, are permitted provided that the following conditions are
10# met: redistributions of source code must retain the above copyright
11# notice, this list of conditions and the following disclaimer;
12# redistributions in binary form must reproduce the above copyright
13# notice, this list of conditions and the following disclaimer in the
14# documentation and/or other materials provided with the distribution;
15# neither the name of the copyright holders nor the names of its
16# contributors may be used to endorse or promote products derived from
17# this software without specific prior written permission.
18#
19# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
20# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
21# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
22# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
23# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
24# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
25# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
26# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
27# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
28# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
29# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30#
31# Authors: Steve Reinhardt
32# Nathan Binkert
33
34###################################################
35#
36# SCons top-level build description (SConstruct) file.
37#
38# While in this directory ('gem5'), just type 'scons' to build the default
39# configuration (see below), or type 'scons build/<CONFIG>/<binary>'
40# to build some other configuration (e.g., 'build/ALPHA/gem5.opt' for
41# the optimized full-system version).
42#
43# You can build gem5 in a different directory as long as there is a
44# 'build/<CONFIG>' somewhere along the target path. The build system
45# expects that all configs under the same build directory are being
46# built for the same host system.
47#
48# Examples:
49#
50# The following two commands are equivalent. The '-u' option tells
51# scons to search up the directory tree for this SConstruct file.
52# % cd <path-to-src>/gem5 ; scons build/ALPHA/gem5.debug
53# % cd <path-to-src>/gem5/build/ALPHA; scons -u gem5.debug
54#
55# The following two commands are equivalent and demonstrate building
56# in a directory outside of the source tree. The '-C' option tells
57# scons to chdir to the specified directory to find this SConstruct
58# file.
59# % cd <path-to-src>/gem5 ; scons /local/foo/build/ALPHA/gem5.debug
60# % cd /local/foo/build/ALPHA; scons -C <path-to-src>/gem5 gem5.debug
61#
62# You can use 'scons -H' to print scons options. If you're in this
63# 'gem5' directory (or use -u or -C to tell scons where to find this
64# file), you can use 'scons -h' to print all the gem5-specific build
65# options as well.
66#
67###################################################
68
69# Check for recent-enough Python and SCons versions.
70try:
71 # Really old versions of scons only take two options for the
72 # function, so check once without the revision and once with the
73 # revision, the first instance will fail for stuff other than
74 # 0.98, and the second will fail for 0.98.0
75 EnsureSConsVersion(0, 98)
76 EnsureSConsVersion(0, 98, 1)
77except SystemExit, e:
78 print """
79For more details, see:
80 http://gem5.org/Dependencies
81"""
82 raise
83
84# We ensure the python version early because we have stuff that
85# requires python 2.4
86try:
87 EnsurePythonVersion(2, 4)
88except SystemExit, e:
89 print """
90You can use a non-default installation of the Python interpreter by
91either (1) rearranging your PATH so that scons finds the non-default
92'python' first or (2) explicitly invoking an alternative interpreter
93on the scons script.
94
95For more details, see:
96 http://gem5.org/wiki/index.php/Using_a_non-default_Python_installation
97"""
98 raise
99
100# Global Python includes
101import os
102import re
103import subprocess
104import sys
105
106from os import mkdir, environ
107from os.path import abspath, basename, dirname, expanduser, normpath
108from os.path import exists, isdir, isfile
109from os.path import join as joinpath, split as splitpath
110
111# SCons includes
112import SCons
113import SCons.Node
114
115extra_python_paths = [
116 Dir('src/python').srcnode().abspath, # gem5 includes
117 Dir('ext/ply').srcnode().abspath, # ply is used by several files
118 ]
119
120sys.path[1:1] = extra_python_paths
121
122from m5.util import compareVersions, readCommand
123from m5.util.terminal import get_termcap
124
125help_texts = {
126 "options" : "",
127 "global_vars" : "",
128 "local_vars" : ""
129}
130
131Export("help_texts")
132
133
134# There's a bug in scons in that (1) by default, the help texts from
135# AddOption() are supposed to be displayed when you type 'scons -h'
136# and (2) you can override the help displayed by 'scons -h' using the
137# Help() function, but these two features are incompatible: once
138# you've overridden the help text using Help(), there's no way to get
139# at the help texts from AddOptions. See:
140# http://scons.tigris.org/issues/show_bug.cgi?id=2356
141# http://scons.tigris.org/issues/show_bug.cgi?id=2611
142# This hack lets us extract the help text from AddOptions and
143# re-inject it via Help(). Ideally someday this bug will be fixed and
144# we can just use AddOption directly.
145def AddLocalOption(*args, **kwargs):
146 col_width = 30
147
148 help = " " + ", ".join(args)
149 if "help" in kwargs:
150 length = len(help)
151 if length >= col_width:
152 help += "\n" + " " * col_width
153 else:
154 help += " " * (col_width - length)
155 help += kwargs["help"]
156 help_texts["options"] += help + "\n"
157
158 AddOption(*args, **kwargs)
159
160AddLocalOption('--colors', dest='use_colors', action='store_true',
161 help="Add color to abbreviated scons output")
162AddLocalOption('--no-colors', dest='use_colors', action='store_false',
163 help="Don't add color to abbreviated scons output")
164AddLocalOption('--default', dest='default', type='string', action='store',
165 help='Override which build_opts file to use for defaults')
166AddLocalOption('--ignore-style', dest='ignore_style', action='store_true',
167 help='Disable style checking hooks')
168AddLocalOption('--no-lto', dest='no_lto', action='store_true',
169 help='Disable Link-Time Optimization for fast')
170AddLocalOption('--update-ref', dest='update_ref', action='store_true',
171 help='Update test reference outputs')
172AddLocalOption('--verbose', dest='verbose', action='store_true',
173 help='Print full tool command lines')
174
175termcap = get_termcap(GetOption('use_colors'))
176
177########################################################################
178#
179# Set up the main build environment.
180#
181########################################################################
182use_vars = set([ 'AS', 'AR', 'CC', 'CXX', 'HOME', 'LD_LIBRARY_PATH',
183 'LIBRARY_PATH', 'PATH', 'PKG_CONFIG_PATH', 'PYTHONPATH',
184 'RANLIB', 'SWIG' ])
185
186use_prefixes = [
187 "M5", # M5 configuration (e.g., path to kernels)
188 "DISTCC_", # distcc (distributed compiler wrapper) configuration
189 "CCACHE_", # ccache (caching compiler wrapper) configuration
190 "CCC_", # clang static analyzer configuration
191 ]
192
193use_env = {}
194for key,val in os.environ.iteritems():
195 if key in use_vars or \
196 any([key.startswith(prefix) for prefix in use_prefixes]):
197 use_env[key] = val
198
199main = Environment(ENV=use_env)
200main.Decider('MD5-timestamp')
201main.root = Dir(".") # The current directory (where this file lives).
202main.srcdir = Dir("src") # The source directory
203
204main_dict_keys = main.Dictionary().keys()
205
206# Check that we have a C/C++ compiler
207if not ('CC' in main_dict_keys and 'CXX' in main_dict_keys):
208 print "No C++ compiler installed (package g++ on Ubuntu and RedHat)"
209 Exit(1)
210
211# Check that swig is present
212if not 'SWIG' in main_dict_keys:
213 print "swig is not installed (package swig on Ubuntu and RedHat)"
214 Exit(1)
215
216# add useful python code PYTHONPATH so it can be used by subprocesses
217# as well
218main.AppendENVPath('PYTHONPATH', extra_python_paths)
219
220########################################################################
221#
222# Mercurial Stuff.
223#
224# If the gem5 directory is a mercurial repository, we should do some
225# extra things.
226#
227########################################################################
228
229hgdir = main.root.Dir(".hg")
230
231mercurial_style_message = """
232You're missing the gem5 style hook, which automatically checks your code
233against the gem5 style rules on hg commit and qrefresh commands. This
234script will now install the hook in your .hg/hgrc file.
235Press enter to continue, or ctrl-c to abort: """
236
237mercurial_style_hook = """
238# The following lines were automatically added by gem5/SConstruct
239# to provide the gem5 style-checking hooks
240[extensions]
241style = %s/util/style.py
242
243[hooks]
244pretxncommit.style = python:style.check_style
245pre-qrefresh.style = python:style.check_style
246# End of SConstruct additions
247
248""" % (main.root.abspath)
249
250mercurial_lib_not_found = """
251Mercurial libraries cannot be found, ignoring style hook. If
252you are a gem5 developer, please fix this and run the style
253hook. It is important.
254"""
255
256# Check for style hook and prompt for installation if it's not there.
257# Skip this if --ignore-style was specified, there's no .hg dir to
258# install a hook in, or there's no interactive terminal to prompt.
259if not GetOption('ignore_style') and hgdir.exists() and sys.stdin.isatty():
260 style_hook = True
261 try:
262 from mercurial import ui
263 ui = ui.ui()
264 ui.readconfig(hgdir.File('hgrc').abspath)
265 style_hook = ui.config('hooks', 'pretxncommit.style', None) and \
266 ui.config('hooks', 'pre-qrefresh.style', None)
267 except ImportError:
268 print mercurial_lib_not_found
269
270 if not style_hook:
271 print mercurial_style_message,
272 # continue unless user does ctrl-c/ctrl-d etc.
273 try:
274 raw_input()
275 except:
276 print "Input exception, exiting scons.\n"
277 sys.exit(1)
278 hgrc_path = '%s/.hg/hgrc' % main.root.abspath
279 print "Adding style hook to", hgrc_path, "\n"
280 try:
281 hgrc = open(hgrc_path, 'a')
282 hgrc.write(mercurial_style_hook)
283 hgrc.close()
284 except:
285 print "Error updating", hgrc_path
286 sys.exit(1)
287
288
289###################################################
290#
291# Figure out which configurations to set up based on the path(s) of
292# the target(s).
293#
294###################################################
295
296# Find default configuration & binary.
297Default(environ.get('M5_DEFAULT_BINARY', 'build/ALPHA/gem5.debug'))
298
299# helper function: find last occurrence of element in list
300def rfind(l, elt, offs = -1):
301 for i in range(len(l)+offs, 0, -1):
302 if l[i] == elt:
303 return i
304 raise ValueError, "element not found"
305
306# Take a list of paths (or SCons Nodes) and return a list with all
307# paths made absolute and ~-expanded. Paths will be interpreted
308# relative to the launch directory unless a different root is provided
309def makePathListAbsolute(path_list, root=GetLaunchDir()):
310 return [abspath(joinpath(root, expanduser(str(p))))
311 for p in path_list]
312
313# Each target must have 'build' in the interior of the path; the
314# directory below this will determine the build parameters. For
315# example, for target 'foo/bar/build/ALPHA_SE/arch/alpha/blah.do' we
316# recognize that ALPHA_SE specifies the configuration because it
317# follow 'build' in the build path.
318
319# The funky assignment to "[:]" is needed to replace the list contents
320# in place rather than reassign the symbol to a new list, which
321# doesn't work (obviously!).
322BUILD_TARGETS[:] = makePathListAbsolute(BUILD_TARGETS)
323
324# Generate a list of the unique build roots and configs that the
325# collected targets reference.
326variant_paths = []
327build_root = None
328for t in BUILD_TARGETS:
329 path_dirs = t.split('/')
330 try:
331 build_top = rfind(path_dirs, 'build', -2)
332 except:
333 print "Error: no non-leaf 'build' dir found on target path", t
334 Exit(1)
335 this_build_root = joinpath('/',*path_dirs[:build_top+1])
336 if not build_root:
337 build_root = this_build_root
338 else:
339 if this_build_root != build_root:
340 print "Error: build targets not under same build root\n"\
341 " %s\n %s" % (build_root, this_build_root)
342 Exit(1)
343 variant_path = joinpath('/',*path_dirs[:build_top+2])
344 if variant_path not in variant_paths:
345 variant_paths.append(variant_path)
346
347# Make sure build_root exists (might not if this is the first build there)
348if not isdir(build_root):
349 mkdir(build_root)
350main['BUILDROOT'] = build_root
351
352Export('main')
353
354main.SConsignFile(joinpath(build_root, "sconsign"))
355
356# Default duplicate option is to use hard links, but this messes up
357# when you use emacs to edit a file in the target dir, as emacs moves
358# file to file~ then copies to file, breaking the link. Symbolic
359# (soft) links work better.
360main.SetOption('duplicate', 'soft-copy')
361
362#
363# Set up global sticky variables... these are common to an entire build
364# tree (not specific to a particular build like ALPHA_SE)
365#
366
367global_vars_file = joinpath(build_root, 'variables.global')
368
369global_vars = Variables(global_vars_file, args=ARGUMENTS)
370
371global_vars.AddVariables(
372 ('CC', 'C compiler', environ.get('CC', main['CC'])),
373 ('CXX', 'C++ compiler', environ.get('CXX', main['CXX'])),
374 ('SWIG', 'SWIG tool', environ.get('SWIG', main['SWIG'])),
375 ('PROTOC', 'protoc tool', environ.get('PROTOC', 'protoc')),
376 ('BATCH', 'Use batch pool for build and tests', False),
377 ('BATCH_CMD', 'Batch pool submission command name', 'qdo'),
378 ('M5_BUILD_CACHE', 'Cache built objects in this directory', False),
379 ('EXTRAS', 'Add extra directories to the compilation', '')
380 )
381
382# Update main environment with values from ARGUMENTS & global_vars_file
383global_vars.Update(main)
384help_texts["global_vars"] += global_vars.GenerateHelpText(main)
385
386# Save sticky variable settings back to current variables file
387global_vars.Save(global_vars_file, main)
388
389# Parse EXTRAS variable to build list of all directories where we're
390# look for sources etc. This list is exported as extras_dir_list.
391base_dir = main.srcdir.abspath
392if main['EXTRAS']:
393 extras_dir_list = makePathListAbsolute(main['EXTRAS'].split(':'))
394else:
395 extras_dir_list = []
396
397Export('base_dir')
398Export('extras_dir_list')
399
400# the ext directory should be on the #includes path
401main.Append(CPPPATH=[Dir('ext')])
402
403def strip_build_path(path, env):
404 path = str(path)
405 variant_base = env['BUILDROOT'] + os.path.sep
406 if path.startswith(variant_base):
407 path = path[len(variant_base):]
408 elif path.startswith('build/'):
409 path = path[6:]
410 return path
411
412# Generate a string of the form:
413# common/path/prefix/src1, src2 -> tgt1, tgt2
414# to print while building.
415class Transform(object):
416 # all specific color settings should be here and nowhere else
417 tool_color = termcap.Normal
418 pfx_color = termcap.Yellow
419 srcs_color = termcap.Yellow + termcap.Bold
420 arrow_color = termcap.Blue + termcap.Bold
421 tgts_color = termcap.Yellow + termcap.Bold
422
423 def __init__(self, tool, max_sources=99):
424 self.format = self.tool_color + (" [%8s] " % tool) \
425 + self.pfx_color + "%s" \
426 + self.srcs_color + "%s" \
427 + self.arrow_color + " -> " \
428 + self.tgts_color + "%s" \
429 + termcap.Normal
430 self.max_sources = max_sources
431
432 def __call__(self, target, source, env, for_signature=None):
433 # truncate source list according to max_sources param
434 source = source[0:self.max_sources]
435 def strip(f):
436 return strip_build_path(str(f), env)
437 if len(source) > 0:
438 srcs = map(strip, source)
439 else:
440 srcs = ['']
441 tgts = map(strip, target)
442 # surprisingly, os.path.commonprefix is a dumb char-by-char string
443 # operation that has nothing to do with paths.
444 com_pfx = os.path.commonprefix(srcs + tgts)
445 com_pfx_len = len(com_pfx)
446 if com_pfx:
447 # do some cleanup and sanity checking on common prefix
448 if com_pfx[-1] == ".":
449 # prefix matches all but file extension: ok
450 # back up one to change 'foo.cc -> o' to 'foo.cc -> .o'
451 com_pfx = com_pfx[0:-1]
452 elif com_pfx[-1] == "/":
453 # common prefix is directory path: OK
454 pass
455 else:
456 src0_len = len(srcs[0])
457 tgt0_len = len(tgts[0])
458 if src0_len == com_pfx_len:
459 # source is a substring of target, OK
460 pass
461 elif tgt0_len == com_pfx_len:
462 # target is a substring of source, need to back up to
463 # avoid empty string on RHS of arrow
464 sep_idx = com_pfx.rfind(".")
465 if sep_idx != -1:
466 com_pfx = com_pfx[0:sep_idx]
467 else:
468 com_pfx = ''
469 elif src0_len > com_pfx_len and srcs[0][com_pfx_len] == ".":
470 # still splitting at file extension: ok
471 pass
472 else:
473 # probably a fluke; ignore it
474 com_pfx = ''
475 # recalculate length in case com_pfx was modified
476 com_pfx_len = len(com_pfx)
477 def fmt(files):
478 f = map(lambda s: s[com_pfx_len:], files)
479 return ', '.join(f)
480 return self.format % (com_pfx, fmt(srcs), fmt(tgts))
481
482Export('Transform')
483
484# enable the regression script to use the termcap
485main['TERMCAP'] = termcap
486
487if GetOption('verbose'):
488 def MakeAction(action, string, *args, **kwargs):
489 return Action(action, *args, **kwargs)
490else:
491 MakeAction = Action
492 main['CCCOMSTR'] = Transform("CC")
493 main['CXXCOMSTR'] = Transform("CXX")
494 main['ASCOMSTR'] = Transform("AS")
495 main['SWIGCOMSTR'] = Transform("SWIG")
496 main['ARCOMSTR'] = Transform("AR", 0)
497 main['LINKCOMSTR'] = Transform("LINK", 0)
498 main['RANLIBCOMSTR'] = Transform("RANLIB", 0)
499 main['M4COMSTR'] = Transform("M4")
500 main['SHCCCOMSTR'] = Transform("SHCC")
501 main['SHCXXCOMSTR'] = Transform("SHCXX")
502Export('MakeAction')
503
504# Initialize the Link-Time Optimization (LTO) flags
505main['LTO_CCFLAGS'] = []
506main['LTO_LDFLAGS'] = []
507
508CXX_version = readCommand([main['CXX'],'--version'], exception=False)
509CXX_V = readCommand([main['CXX'],'-V'], exception=False)
510
511main['GCC'] = CXX_version and CXX_version.find('g++') >= 0
512main['CLANG'] = CXX_version and CXX_version.find('clang') >= 0
513if main['GCC'] + main['CLANG'] > 1:
514 print 'Error: How can we have two at the same time?'
515 Exit(1)
516
517# Set up default C++ compiler flags
518if main['GCC']:
519 # Check for a supported version of gcc, >= 4.4 is needed for c++0x
520 # support. See http://gcc.gnu.org/projects/cxx0x.html for details
521 gcc_version = readCommand([main['CXX'], '-dumpversion'], exception=False)
522 if compareVersions(gcc_version, "4.4") < 0:
523 print 'Error: gcc version 4.4 or newer required.'
524 print ' Installed version:', gcc_version
525 Exit(1)
526
527 main['GCC_VERSION'] = gcc_version
528 main.Append(CCFLAGS=['-pipe'])
529 main.Append(CCFLAGS=['-fno-strict-aliasing'])
530 main.Append(CCFLAGS=['-Wall', '-Wno-sign-compare', '-Wundef'])
531 main.Append(CXXFLAGS=['-std=c++0x'])
532
533 # Check for versions with bugs
534 if not compareVersions(gcc_version, '4.4.1') or \
535 not compareVersions(gcc_version, '4.4.2'):
536 print 'Info: Tree vectorizer in GCC 4.4.1 & 4.4.2 is buggy, disabling.'
537 main.Append(CCFLAGS=['-fno-tree-vectorize'])
538
539 # LTO support is only really working properly from 4.6 and beyond
540 if compareVersions(gcc_version, '4.6') >= 0:
541 # Add the appropriate Link-Time Optimization (LTO) flags
542 # unless LTO is explicitly turned off. Note that these flags
543 # are only used by the fast target.
544 if not GetOption('no_lto'):
545 # Pass the LTO flag when compiling to produce GIMPLE
546 # output, we merely create the flags here and only append
547 # them later/
548 main['LTO_CCFLAGS'] = ['-flto=%d' % GetOption('num_jobs')]
549
550 # Use the same amount of jobs for LTO as we are running
551 # scons with, we hardcode the use of the linker plugin
552 # which requires either gold or GNU ld >= 2.21
553 main['LTO_LDFLAGS'] = ['-flto=%d' % GetOption('num_jobs'),
554 '-fuse-linker-plugin']
555
556elif main['CLANG']:
557 # Check for a supported version of clang, >= 2.9 is needed to
558 # support similar features as gcc 4.4. See
559 # http://clang.llvm.org/cxx_status.html for details
560 clang_version_re = re.compile(".* version (\d+\.\d+)")
561 clang_version_match = clang_version_re.match(CXX_version)
562 if (clang_version_match):
563 clang_version = clang_version_match.groups()[0]
564 if compareVersions(clang_version, "2.9") < 0:
565 print 'Error: clang version 2.9 or newer required.'
566 print ' Installed version:', clang_version
567 Exit(1)
568 else:
569 print 'Error: Unable to determine clang version.'
570 Exit(1)
571
572 main.Append(CCFLAGS=['-pipe'])
573 main.Append(CCFLAGS=['-fno-strict-aliasing'])
574 main.Append(CCFLAGS=['-Wall', '-Wno-sign-compare', '-Wundef'])
575 main.Append(CCFLAGS=['-Wno-tautological-compare'])
576 main.Append(CCFLAGS=['-Wno-self-assign'])
577 # Ruby makes frequent use of extraneous parantheses in the printing
578 # of if-statements
579 main.Append(CCFLAGS=['-Wno-parentheses'])
580 main.Append(CXXFLAGS=['-std=c++0x'])
581 # On Mac OS X/Darwin we need to also use libc++ (part of XCode) as
582 # opposed to libstdc++ to make the transition from TR1 to
583 # C++11. See http://libcxx.llvm.org. However, clang has chosen a
584 # strict implementation of the C++11 standard, and does not allow
585 # incomplete types in template arguments (besides unique_ptr and
586 # shared_ptr), and the libc++ STL containers create problems in
587 # combination with the current gem5 code. For now, we stick with
588 # libstdc++ and use the TR1 namespace.
589 # if sys.platform == "darwin":
590 # main.Append(CXXFLAGS=['-stdlib=libc++'])
591
592else:
593 print termcap.Yellow + termcap.Bold + 'Error' + termcap.Normal,
594 print "Don't know what compiler options to use for your compiler."
595 print termcap.Yellow + ' compiler:' + termcap.Normal, main['CXX']
596 print termcap.Yellow + ' version:' + termcap.Normal,
597 if not CXX_version:
598 print termcap.Yellow + termcap.Bold + "COMMAND NOT FOUND!" +\
599 termcap.Normal
600 else:
601 print CXX_version.replace('\n', '<nl>')
602 print " If you're trying to use a compiler other than GCC"
603 print " or clang, there appears to be something wrong with your"
604 print " environment."
605 print " "
606 print " If you are trying to use a compiler other than those listed"
607 print " above you will need to ease fix SConstruct and "
608 print " src/SConscript to support that compiler."
609 Exit(1)
610
611# Set up common yacc/bison flags (needed for Ruby)
612main['YACCFLAGS'] = '-d'
613main['YACCHXXFILESUFFIX'] = '.hh'
614
615# Do this after we save setting back, or else we'll tack on an
616# extra 'qdo' every time we run scons.
617if main['BATCH']:
618 main['CC'] = main['BATCH_CMD'] + ' ' + main['CC']
619 main['CXX'] = main['BATCH_CMD'] + ' ' + main['CXX']
620 main['AS'] = main['BATCH_CMD'] + ' ' + main['AS']
621 main['AR'] = main['BATCH_CMD'] + ' ' + main['AR']
622 main['RANLIB'] = main['BATCH_CMD'] + ' ' + main['RANLIB']
623
624if sys.platform == 'cygwin':
625 # cygwin has some header file issues...
626 main.Append(CCFLAGS=["-Wno-uninitialized"])
627
628# Check for the protobuf compiler
629protoc_version = readCommand([main['PROTOC'], '--version'],
630 exception='').split()
631
632# First two words should be "libprotoc x.y.z"
633if len(protoc_version) < 2 or protoc_version[0] != 'libprotoc':
634 print termcap.Yellow + termcap.Bold + \
635 'Warning: Protocol buffer compiler (protoc) not found.\n' + \
636 ' Please install protobuf-compiler for tracing support.' + \
637 termcap.Normal
638 main['PROTOC'] = False
639else:
640 # Determine the appropriate include path and library path using
641 # pkg-config, that means we also need to check for pkg-config
642 if not readCommand(['pkg-config', '--version'], exception=''):
643 print 'Error: pkg-config not found. Please install and retry.'
644 Exit(1)
645
646 main.ParseConfig('pkg-config --cflags --libs-only-L protobuf')
647
648 # Based on the availability of the compress stream wrappers,
649 # require 2.1.0
650 min_protoc_version = '2.1.0'
651 if compareVersions(protoc_version[1], min_protoc_version) < 0:
652 print 'Error: protoc version', min_protoc_version, 'or newer required.'
653 print ' Installed version:', protoc_version[1]
654 Exit(1)
655
656# Check for SWIG
657if not main.has_key('SWIG'):
658 print 'Error: SWIG utility not found.'
659 print ' Please install (see http://www.swig.org) and retry.'
660 Exit(1)
661
662# Check for appropriate SWIG version
663swig_version = readCommand([main['SWIG'], '-version'], exception='').split()
664# First 3 words should be "SWIG Version x.y.z"
665if len(swig_version) < 3 or \
666 swig_version[0] != 'SWIG' or swig_version[1] != 'Version':
667 print 'Error determining SWIG version.'
668 Exit(1)
669
670min_swig_version = '1.3.34'
671if compareVersions(swig_version[2], min_swig_version) < 0:
672 print 'Error: SWIG version', min_swig_version, 'or newer required.'
673 print ' Installed version:', swig_version[2]
674 Exit(1)
675
676# Set up SWIG flags & scanner
677swig_flags=Split('-c++ -python -modern -templatereduce $_CPPINCFLAGS')
678main.Append(SWIGFLAGS=swig_flags)
679
680# filter out all existing swig scanners, they mess up the dependency
681# stuff for some reason
682scanners = []
683for scanner in main['SCANNERS']:
684 skeys = scanner.skeys
685 if skeys == '.i':
686 continue
687
688 if isinstance(skeys, (list, tuple)) and '.i' in skeys:
689 continue
690
691 scanners.append(scanner)
692
693# add the new swig scanner that we like better
694from SCons.Scanner import ClassicCPP as CPPScanner
695swig_inc_re = '^[ \t]*[%,#][ \t]*(?:include|import)[ \t]*(<|")([^>"]+)(>|")'
696scanners.append(CPPScanner("SwigScan", [ ".i" ], "CPPPATH", swig_inc_re))
697
698# replace the scanners list that has what we want
699main['SCANNERS'] = scanners
700
701# Add a custom Check function to the Configure context so that we can
702# figure out if the compiler adds leading underscores to global
703# variables. This is needed for the autogenerated asm files that we
704# use for embedding the python code.
705def CheckLeading(context):
706 context.Message("Checking for leading underscore in global variables...")
707 # 1) Define a global variable called x from asm so the C compiler
708 # won't change the symbol at all.
709 # 2) Declare that variable.
710 # 3) Use the variable
711 #
712 # If the compiler prepends an underscore, this will successfully
713 # link because the external symbol 'x' will be called '_x' which
714 # was defined by the asm statement. If the compiler does not
715 # prepend an underscore, this will not successfully link because
716 # '_x' will have been defined by assembly, while the C portion of
717 # the code will be trying to use 'x'
718 ret = context.TryLink('''
719 asm(".globl _x; _x: .byte 0");
720 extern int x;
721 int main() { return x; }
722 ''', extension=".c")
723 context.env.Append(LEADING_UNDERSCORE=ret)
724 context.Result(ret)
725 return ret
726
727# Platform-specific configuration. Note again that we assume that all
728# builds under a given build root run on the same host platform.
729conf = Configure(main,
730 conf_dir = joinpath(build_root, '.scons_config'),
731 log_file = joinpath(build_root, 'scons_config.log'),
732 custom_tests = { 'CheckLeading' : CheckLeading })
733
734# Check for leading underscores. Don't really need to worry either
735# way so don't need to check the return code.
736conf.CheckLeading()
737
738# Check if we should compile a 64 bit binary on Mac OS X/Darwin
739try:
740 import platform
741 uname = platform.uname()
742 if uname[0] == 'Darwin' and compareVersions(uname[2], '9.0.0') >= 0:
743 if int(readCommand('sysctl -n hw.cpu64bit_capable')[0]):
744 main.Append(CCFLAGS=['-arch', 'x86_64'])
745 main.Append(CFLAGS=['-arch', 'x86_64'])
746 main.Append(LINKFLAGS=['-arch', 'x86_64'])
747 main.Append(ASFLAGS=['-arch', 'x86_64'])
748except:
749 pass
750
751# Recent versions of scons substitute a "Null" object for Configure()
752# when configuration isn't necessary, e.g., if the "--help" option is
753# present. Unfortuantely this Null object always returns false,
754# breaking all our configuration checks. We replace it with our own
755# more optimistic null object that returns True instead.
756if not conf:
757 def NullCheck(*args, **kwargs):
758 return True
759
760 class NullConf:
761 def __init__(self, env):
762 self.env = env
763 def Finish(self):
764 return self.env
765 def __getattr__(self, mname):
766 return NullCheck
767
768 conf = NullConf(main)
769
770# Find Python include and library directories for embedding the
771# interpreter. For consistency, we will use the same Python
772# installation used to run scons (and thus this script). If you want
773# to link in an alternate version, see above for instructions on how
774# to invoke scons with a different copy of the Python interpreter.
775from distutils import sysconfig
776
777py_getvar = sysconfig.get_config_var
778
779py_debug = getattr(sys, 'pydebug', False)
780py_version = 'python' + py_getvar('VERSION') + (py_debug and "_d" or "")
781
782py_general_include = sysconfig.get_python_inc()
783py_platform_include = sysconfig.get_python_inc(plat_specific=True)
784py_includes = [ py_general_include ]
785if py_platform_include != py_general_include:
786 py_includes.append(py_platform_include)
787
788py_lib_path = [ py_getvar('LIBDIR') ]
789# add the prefix/lib/pythonX.Y/config dir, but only if there is no
790# shared library in prefix/lib/.
791if not py_getvar('Py_ENABLE_SHARED'):
792 py_lib_path.append(py_getvar('LIBPL'))
793
794py_libs = []
795for lib in py_getvar('LIBS').split() + py_getvar('SYSLIBS').split():
796 if not lib.startswith('-l'):
797 # Python requires some special flags to link (e.g. -framework
798 # common on OS X systems), assume appending preserves order
799 main.Append(LINKFLAGS=[lib])
800 else:
801 lib = lib[2:]
802 if lib not in py_libs:
803 py_libs.append(lib)
804py_libs.append(py_version)
805
806main.Append(CPPPATH=py_includes)
807main.Append(LIBPATH=py_lib_path)
808
809# Cache build files in the supplied directory.
810if main['M5_BUILD_CACHE']:
811 print 'Using build cache located at', main['M5_BUILD_CACHE']
812 CacheDir(main['M5_BUILD_CACHE'])
813
814
815# verify that this stuff works
816if not conf.CheckHeader('Python.h', '<>'):
817 print "Error: can't find Python.h header in", py_includes
818 print "Install Python headers (package python-dev on Ubuntu and RedHat)"
819 Exit(1)
820
821for lib in py_libs:
822 if not conf.CheckLib(lib):
823 print "Error: can't find library %s required by python" % lib
824 Exit(1)
825
826# On Solaris you need to use libsocket for socket ops
827if not conf.CheckLibWithHeader(None, 'sys/socket.h', 'C++', 'accept(0,0,0);'):
828 if not conf.CheckLibWithHeader('socket', 'sys/socket.h', 'C++', 'accept(0,0,0);'):
829 print "Can't find library with socket calls (e.g. accept())"
830 Exit(1)
831
832# Check for zlib. If the check passes, libz will be automatically
833# added to the LIBS environment variable.
834if not conf.CheckLibWithHeader('z', 'zlib.h', 'C++','zlibVersion();'):
835 print 'Error: did not find needed zlib compression library '\
836 'and/or zlib.h header file.'
837 print ' Please install zlib and try again.'
838 Exit(1)
839
840# If we have the protobuf compiler, also make sure we have the
841# development libraries. If the check passes, libprotobuf will be
842# automatically added to the LIBS environment variable. After
843# this, we can use the HAVE_PROTOBUF flag to determine if we have
844# got both protoc and libprotobuf available.
845main['HAVE_PROTOBUF'] = main['PROTOC'] and \
846 conf.CheckLibWithHeader('protobuf', 'google/protobuf/message.h',
847 'C++', 'GOOGLE_PROTOBUF_VERIFY_VERSION;')
848
849# If we have the compiler but not the library, treat it as an error.
850if main['PROTOC'] and not main['HAVE_PROTOBUF']:
851 print 'Error: did not find protocol buffer library and/or headers.'
852 print ' Please install libprotobuf-dev and try again.'
853 Exit(1)
854
855# Check for librt.
856have_posix_clock = \
857 conf.CheckLibWithHeader(None, 'time.h', 'C',
858 'clock_nanosleep(0,0,NULL,NULL);') or \
859 conf.CheckLibWithHeader('rt', 'time.h', 'C',
860 'clock_nanosleep(0,0,NULL,NULL);')
861
862if conf.CheckLib('tcmalloc_minimal'):
863 have_tcmalloc = True
864else:
865 have_tcmalloc = False
866 print termcap.Yellow + termcap.Bold + \
867 "You can get a 12% performance improvement by installing tcmalloc "\
868 "(libgoogle-perftools-dev package on Ubuntu or RedHat)." + \
869 termcap.Normal
870
871if not have_posix_clock:
872 print "Can't find library for POSIX clocks."
873
874# Check for <fenv.h> (C99 FP environment control)
875have_fenv = conf.CheckHeader('fenv.h', '<>')
876if not have_fenv:
877 print "Warning: Header file <fenv.h> not found."
878 print " This host has no IEEE FP rounding mode control."
879
880######################################################################
881#
882# Finish the configuration
883#
884main = conf.Finish()
885
886######################################################################
887#
888# Collect all non-global variables
889#
890
891# Define the universe of supported ISAs
892all_isa_list = [ ]
893Export('all_isa_list')
894
895class CpuModel(object):
896 '''The CpuModel class encapsulates everything the ISA parser needs to
897 know about a particular CPU model.'''
898
899 # Dict of available CPU model objects. Accessible as CpuModel.dict.
900 dict = {}
901 list = []
902 defaults = []
903
904 # Constructor. Automatically adds models to CpuModel.dict.
905 def __init__(self, name, filename, includes, strings, default=False):
906 self.name = name # name of model
907 self.filename = filename # filename for output exec code
908 self.includes = includes # include files needed in exec file
909 # The 'strings' dict holds all the per-CPU symbols we can
910 # substitute into templates etc.
911 self.strings = strings
912
913 # This cpu is enabled by default
914 self.default = default
915
916 # Add self to dict
917 if name in CpuModel.dict:
918 raise AttributeError, "CpuModel '%s' already registered" % name
919 CpuModel.dict[name] = self
920 CpuModel.list.append(name)
921
922Export('CpuModel')
923
924# Sticky variables get saved in the variables file so they persist from
925# one invocation to the next (unless overridden, in which case the new
926# value becomes sticky).
927sticky_vars = Variables(args=ARGUMENTS)
928Export('sticky_vars')
929
930# Sticky variables that should be exported
931export_vars = []
932Export('export_vars')
933
934# For Ruby
935all_protocols = []
936Export('all_protocols')
937protocol_dirs = []
938Export('protocol_dirs')
939slicc_includes = []
940Export('slicc_includes')
941
942# Walk the tree and execute all SConsopts scripts that wil add to the
943# above variables
944if not GetOption('verbose'):
945 print "Reading SConsopts"
946for bdir in [ base_dir ] + extras_dir_list:
947 if not isdir(bdir):
948 print "Error: directory '%s' does not exist" % bdir
949 Exit(1)
950 for root, dirs, files in os.walk(bdir):
951 if 'SConsopts' in files:
952 if GetOption('verbose'):
953 print "Reading", joinpath(root, 'SConsopts')
954 SConscript(joinpath(root, 'SConsopts'))
955
956all_isa_list.sort()
957
958sticky_vars.AddVariables(
959 EnumVariable('TARGET_ISA', 'Target ISA', 'alpha', all_isa_list),
960 ListVariable('CPU_MODELS', 'CPU models',
961 sorted(n for n,m in CpuModel.dict.iteritems() if m.default),
962 sorted(CpuModel.list)),
963 BoolVariable('EFENCE', 'Link with Electric Fence malloc debugger',
964 False),
965 BoolVariable('SS_COMPATIBLE_FP',
966 'Make floating-point results compatible with SimpleScalar',
967 False),
968 BoolVariable('USE_SSE2',
969 'Compile for SSE2 (-msse2) to get IEEE FP on x86 hosts',
970 False),
971 BoolVariable('USE_POSIX_CLOCK', 'Use POSIX Clocks', have_posix_clock),
972 BoolVariable('USE_FENV', 'Use <fenv.h> IEEE mode control', have_fenv),
973 BoolVariable('CP_ANNOTATE', 'Enable critical path annotation capability', False),
974 EnumVariable('PROTOCOL', 'Coherence protocol for Ruby', 'None',
975 all_protocols),
976 )
977
978# These variables get exported to #defines in config/*.hh (see src/SConscript).
979export_vars += ['USE_FENV', 'SS_COMPATIBLE_FP', 'TARGET_ISA', 'CP_ANNOTATE',
980 'USE_POSIX_CLOCK', 'PROTOCOL', 'HAVE_PROTOBUF']
981
982###################################################
983#
984# Define a SCons builder for configuration flag headers.
985#
986###################################################
987
988# This function generates a config header file that #defines the
989# variable symbol to the current variable setting (0 or 1). The source
990# operands are the name of the variable and a Value node containing the
991# value of the variable.
992def build_config_file(target, source, env):
993 (variable, value) = [s.get_contents() for s in source]
994 f = file(str(target[0]), 'w')
995 print >> f, '#define', variable, value
996 f.close()
997 return None
998
999# Combine the two functions into a scons Action object.
1000config_action = MakeAction(build_config_file, Transform("CONFIG H", 2))
1001
1002# The emitter munges the source & target node lists to reflect what
1003# we're really doing.
1004def config_emitter(target, source, env):
1005 # extract variable name from Builder arg
1006 variable = str(target[0])
1007 # True target is config header file
1008 target = joinpath('config', variable.lower() + '.hh')
1009 val = env[variable]
1010 if isinstance(val, bool):
1011 # Force value to 0/1
1012 val = int(val)
1013 elif isinstance(val, str):
1014 val = '"' + val + '"'
1015
1016 # Sources are variable name & value (packaged in SCons Value nodes)
1017 return ([target], [Value(variable), Value(val)])
1018
1019config_builder = Builder(emitter = config_emitter, action = config_action)
1020
1021main.Append(BUILDERS = { 'ConfigFile' : config_builder })
1022
1023# libelf build is shared across all configs in the build root.
1024main.SConscript('ext/libelf/SConscript',
1025 variant_dir = joinpath(build_root, 'libelf'))
1026
1027# gzstream build is shared across all configs in the build root.
1028main.SConscript('ext/gzstream/SConscript',
1029 variant_dir = joinpath(build_root, 'gzstream'))
1030
1031###################################################
1032#
1033# This function is used to set up a directory with switching headers
1034#
1035###################################################
1036
1037main['ALL_ISA_LIST'] = all_isa_list
1038def make_switching_dir(dname, switch_headers, env):
1039 # Generate the header. target[0] is the full path of the output
1040 # header to generate. 'source' is a dummy variable, since we get the
1041 # list of ISAs from env['ALL_ISA_LIST'].
1042 def gen_switch_hdr(target, source, env):
1043 fname = str(target[0])
1044 f = open(fname, 'w')
1045 isa = env['TARGET_ISA'].lower()
1046 print >>f, '#include "%s/%s/%s"' % (dname, isa, basename(fname))
1047 f.close()
1048
1049 # Build SCons Action object. 'varlist' specifies env vars that this
1050 # action depends on; when env['ALL_ISA_LIST'] changes these actions
1051 # should get re-executed.
1052 switch_hdr_action = MakeAction(gen_switch_hdr,
1053 Transform("GENERATE"), varlist=['ALL_ISA_LIST'])
1054
1055 # Instantiate actions for each header
1056 for hdr in switch_headers:
1057 env.Command(hdr, [], switch_hdr_action)
1058Export('make_switching_dir')
1059
1060###################################################
1061#
1062# Define build environments for selected configurations.
1063#
1064###################################################
1065
1066for variant_path in variant_paths:
1067 print "Building in", variant_path
1068
1069 # Make a copy of the build-root environment to use for this config.
1070 env = main.Clone()
1071 env['BUILDDIR'] = variant_path
1072
1073 # variant_dir is the tail component of build path, and is used to
1074 # determine the build parameters (e.g., 'ALPHA_SE')
1075 (build_root, variant_dir) = splitpath(variant_path)
1076
1077 # Set env variables according to the build directory config.
1078 sticky_vars.files = []
1079 # Variables for $BUILD_ROOT/$VARIANT_DIR are stored in
1080 # $BUILD_ROOT/variables/$VARIANT_DIR so you can nuke
1081 # $BUILD_ROOT/$VARIANT_DIR without losing your variables settings.
1082 current_vars_file = joinpath(build_root, 'variables', variant_dir)
1083 if isfile(current_vars_file):
1084 sticky_vars.files.append(current_vars_file)
1085 print "Using saved variables file %s" % current_vars_file
1086 else:
1087 # Build dir-specific variables file doesn't exist.
1088
1089 # Make sure the directory is there so we can create it later
1090 opt_dir = dirname(current_vars_file)
1091 if not isdir(opt_dir):
1092 mkdir(opt_dir)
1093
1094 # Get default build variables from source tree. Variables are
1095 # normally determined by name of $VARIANT_DIR, but can be
1096 # overridden by '--default=' arg on command line.
1097 default = GetOption('default')
1098 opts_dir = joinpath(main.root.abspath, 'build_opts')
1099 if default:
1100 default_vars_files = [joinpath(build_root, 'variables', default),
1101 joinpath(opts_dir, default)]
1102 else:
1103 default_vars_files = [joinpath(opts_dir, variant_dir)]
1104 existing_files = filter(isfile, default_vars_files)
1105 if existing_files:
1106 default_vars_file = existing_files[0]
1107 sticky_vars.files.append(default_vars_file)
1108 print "Variables file %s not found,\n using defaults in %s" \
1109 % (current_vars_file, default_vars_file)
1110 else:
1111 print "Error: cannot find variables file %s or " \
1112 "default file(s) %s" \
1113 % (current_vars_file, ' or '.join(default_vars_files))
1114 Exit(1)
1115
1116 # Apply current variable settings to env
1117 sticky_vars.Update(env)
1118
1119 help_texts["local_vars"] += \
1120 "Build variables for %s:\n" % variant_dir \
1121 + sticky_vars.GenerateHelpText(env)
1122
1123 # Process variable settings.
1124
1125 if not have_fenv and env['USE_FENV']:
1126 print "Warning: <fenv.h> not available; " \
1127 "forcing USE_FENV to False in", variant_dir + "."
1128 env['USE_FENV'] = False
1129
1130 if not env['USE_FENV']:
1131 print "Warning: No IEEE FP rounding mode control in", variant_dir + "."
1132 print " FP results may deviate slightly from other platforms."
1133
1134 if env['EFENCE']:
1135 env.Append(LIBS=['efence'])
1136
1137 # Save sticky variable settings back to current variables file
1138 sticky_vars.Save(current_vars_file, env)
1139
1140 if env['USE_SSE2']:
1141 env.Append(CCFLAGS=['-msse2'])
1142
1143 if have_tcmalloc:
1144 env.Append(LIBS=['tcmalloc_minimal'])
1145
1146 # The src/SConscript file sets up the build rules in 'env' according
1147 # to the configured variables. It returns a list of environments,
1148 # one for each variant build (debug, opt, etc.)
1149 envList = SConscript('src/SConscript', variant_dir = variant_path,
1150 exports = 'env')
1151
1152 # Set up the regression tests for each build.
1153 for e in envList:
1154 SConscript('tests/SConscript',
1155 variant_dir = joinpath(variant_path, 'tests', e.Label),
1156 exports = { 'env' : e }, duplicate = False)
1157
1158# base help text
1159Help('''
1160Usage: scons [scons options] [build variables] [target(s)]
1161
1162Extra scons options:
1163%(options)s
1164
1165Global build variables:
1166%(global_vars)s
1167
1168%(local_vars)s
1169''' % help_texts)