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
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.
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.
31 # Authors: Steve Reinhardt
34 ###################################################
36 # SCons top-level build description (SConstruct) file.
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).
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.
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
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
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
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
67 ###################################################
69 # Check for recent-enough Python and SCons versions.
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)
79 For more details, see:
80 http://gem5.org/Dependencies
84 # We ensure the python version early because we have stuff that
87 EnsurePythonVersion(2, 4)
90 You can use a non-default installation of the Python interpreter by
91 either (1) rearranging your PATH so that scons finds the non-default
92 'python' first or (2) explicitly invoking an alternative interpreter
95 For more details, see:
96 http://gem5.org/wiki/index.php/Using_a_non-default_Python_installation
100 # Global Python includes
106 from os
import mkdir
, environ
107 from os
.path
import abspath
, basename
, dirname
, expanduser
, normpath
108 from os
.path
import exists
, isdir
, isfile
109 from os
.path
import join
as joinpath
, split
as splitpath
115 extra_python_paths
= [
116 Dir('src/python').srcnode().abspath
, # gem5 includes
117 Dir('ext/ply').srcnode().abspath
, # ply is used by several files
120 sys
.path
[1:1] = extra_python_paths
122 from m5
.util
import compareVersions
, readCommand
123 from m5
.util
.terminal
import get_termcap
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.
145 def AddLocalOption(*args
, **kwargs
):
148 help = " " + ", ".join(args
)
151 if length
>= col_width
:
152 help += "\n" + " " * col_width
154 help += " " * (col_width
- length
)
155 help += kwargs
["help"]
156 help_texts
["options"] += help + "\n"
158 AddOption(*args
, **kwargs
)
160 AddLocalOption('--colors', dest
='use_colors', action
='store_true',
161 help="Add color to abbreviated scons output")
162 AddLocalOption('--no-colors', dest
='use_colors', action
='store_false',
163 help="Don't add color to abbreviated scons output")
164 AddLocalOption('--default', dest
='default', type='string', action
='store',
165 help='Override which build_opts file to use for defaults')
166 AddLocalOption('--ignore-style', dest
='ignore_style', action
='store_true',
167 help='Disable style checking hooks')
168 AddLocalOption('--no-lto', dest
='no_lto', action
='store_true',
169 help='Disable Link-Time Optimization for fast')
170 AddLocalOption('--update-ref', dest
='update_ref', action
='store_true',
171 help='Update test reference outputs')
172 AddLocalOption('--verbose', dest
='verbose', action
='store_true',
173 help='Print full tool command lines')
175 termcap
= get_termcap(GetOption('use_colors'))
177 ########################################################################
179 # Set up the main build environment.
181 ########################################################################
182 use_vars
= set([ 'AS', 'AR', 'CC', 'CXX', 'HOME', 'LD_LIBRARY_PATH',
183 'LIBRARY_PATH', 'PATH', 'PKG_CONFIG_PATH', 'PYTHONPATH',
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
194 for key
,val
in os
.environ
.iteritems():
195 if key
in use_vars
or \
196 any([key
.startswith(prefix
) for prefix
in use_prefixes
]):
199 main
= Environment(ENV
=use_env
)
200 main
.Decider('MD5-timestamp')
201 main
.root
= Dir(".") # The current directory (where this file lives).
202 main
.srcdir
= Dir("src") # The source directory
204 main_dict_keys
= main
.Dictionary().keys()
206 # Check that we have a C/C++ compiler
207 if not ('CC' in main_dict_keys
and 'CXX' in main_dict_keys
):
208 print "No C++ compiler installed (package g++ on Ubuntu and RedHat)"
211 # Check that swig is present
212 if not 'SWIG' in main_dict_keys
:
213 print "swig is not installed (package swig on Ubuntu and RedHat)"
216 # add useful python code PYTHONPATH so it can be used by subprocesses
218 main
.AppendENVPath('PYTHONPATH', extra_python_paths
)
220 ########################################################################
224 # If the gem5 directory is a mercurial repository, we should do some
227 ########################################################################
229 hgdir
= main
.root
.Dir(".hg")
231 mercurial_style_message
= """
232 You're missing the gem5 style hook, which automatically checks your code
233 against the gem5 style rules on hg commit and qrefresh commands. This
234 script will now install the hook in your .hg/hgrc file.
235 Press enter to continue, or ctrl-c to abort: """
237 mercurial_style_hook
= """
238 # The following lines were automatically added by gem5/SConstruct
239 # to provide the gem5 style-checking hooks
241 style = %s/util/style.py
244 pretxncommit.style = python:style.check_style
245 pre-qrefresh.style = python:style.check_style
246 # End of SConstruct additions
248 """ % (main
.root
.abspath
)
250 mercurial_lib_not_found
= """
251 Mercurial libraries cannot be found, ignoring style hook. If
252 you are a gem5 developer, please fix this and run the style
253 hook. It is important.
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.
259 if not GetOption('ignore_style') and hgdir
.exists() and sys
.stdin
.isatty():
262 from mercurial
import 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)
268 print mercurial_lib_not_found
271 print mercurial_style_message
,
272 # continue unless user does ctrl-c/ctrl-d etc.
276 print "Input exception, exiting scons.\n"
278 hgrc_path
= '%s/.hg/hgrc' % main
.root
.abspath
279 print "Adding style hook to", hgrc_path
, "\n"
281 hgrc
= open(hgrc_path
, 'a')
282 hgrc
.write(mercurial_style_hook
)
285 print "Error updating", hgrc_path
289 ###################################################
291 # Figure out which configurations to set up based on the path(s) of
294 ###################################################
296 # Find default configuration & binary.
297 Default(environ
.get('M5_DEFAULT_BINARY', 'build/ALPHA/gem5.debug'))
299 # helper function: find last occurrence of element in list
300 def rfind(l
, elt
, offs
= -1):
301 for i
in range(len(l
)+offs
, 0, -1):
304 raise ValueError, "element not found"
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
309 def makePathListAbsolute(path_list
, root
=GetLaunchDir()):
310 return [abspath(joinpath(root
, expanduser(str(p
))))
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.
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!).
322 BUILD_TARGETS
[:] = makePathListAbsolute(BUILD_TARGETS
)
324 # Generate a list of the unique build roots and configs that the
325 # collected targets reference.
328 for t
in BUILD_TARGETS
:
329 path_dirs
= t
.split('/')
331 build_top
= rfind(path_dirs
, 'build', -2)
333 print "Error: no non-leaf 'build' dir found on target path", t
335 this_build_root
= joinpath('/',*path_dirs
[:build_top
+1])
337 build_root
= this_build_root
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
)
343 variant_path
= joinpath('/',*path_dirs
[:build_top
+2])
344 if variant_path
not in variant_paths
:
345 variant_paths
.append(variant_path
)
347 # Make sure build_root exists (might not if this is the first build there)
348 if not isdir(build_root
):
350 main
['BUILDROOT'] = build_root
354 main
.SConsignFile(joinpath(build_root
, "sconsign"))
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.
360 main
.SetOption('duplicate', 'soft-copy')
363 # Set up global sticky variables... these are common to an entire build
364 # tree (not specific to a particular build like ALPHA_SE)
367 global_vars_file
= joinpath(build_root
, 'variables.global')
369 global_vars
= Variables(global_vars_file
, args
=ARGUMENTS
)
371 global_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', '')
382 # Update main environment with values from ARGUMENTS & global_vars_file
383 global_vars
.Update(main
)
384 help_texts
["global_vars"] += global_vars
.GenerateHelpText(main
)
386 # Save sticky variable settings back to current variables file
387 global_vars
.Save(global_vars_file
, main
)
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.
391 base_dir
= main
.srcdir
.abspath
393 extras_dir_list
= makePathListAbsolute(main
['EXTRAS'].split(':'))
398 Export('extras_dir_list')
400 # the ext directory should be on the #includes path
401 main
.Append(CPPPATH
=[Dir('ext')])
403 def strip_build_path(path
, env
):
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/'):
412 # Generate a string of the form:
413 # common/path/prefix/src1, src2 -> tgt1, tgt2
414 # to print while building.
415 class 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
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" \
430 self
.max_sources
= max_sources
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
]
436 return strip_build_path(str(f
), env
)
438 srcs
= map(strip
, source
)
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
)
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
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
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(".")
466 com_pfx
= com_pfx
[0:sep_idx
]
469 elif src0_len
> com_pfx_len
and srcs
[0][com_pfx_len
] == ".":
470 # still splitting at file extension: ok
473 # probably a fluke; ignore it
475 # recalculate length in case com_pfx was modified
476 com_pfx_len
= len(com_pfx
)
478 f
= map(lambda s
: s
[com_pfx_len
:], files
)
480 return self
.format
% (com_pfx
, fmt(srcs
), fmt(tgts
))
484 # enable the regression script to use the termcap
485 main
['TERMCAP'] = termcap
487 if GetOption('verbose'):
488 def MakeAction(action
, string
, *args
, **kwargs
):
489 return Action(action
, *args
, **kwargs
)
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")
504 # Initialize the Link-Time Optimization (LTO) flags
505 main
['LTO_CCFLAGS'] = []
506 main
['LTO_LDFLAGS'] = []
508 CXX_version
= readCommand([main
['CXX'],'--version'], exception
=False)
509 CXX_V
= readCommand([main
['CXX'],'-V'], exception
=False)
511 main
['GCC'] = CXX_version
and CXX_version
.find('g++') >= 0
512 main
['CLANG'] = CXX_version
and CXX_version
.find('clang') >= 0
513 if main
['GCC'] + main
['CLANG'] > 1:
514 print 'Error: How can we have two at the same time?'
517 # Set up default C++ compiler flags
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
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'])
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'])
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
548 main
['LTO_CCFLAGS'] = ['-flto=%d' % GetOption('num_jobs')]
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']
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
569 print 'Error: Unable to determine clang version.'
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
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++'])
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
,
598 print termcap
.Yellow
+ termcap
.Bold
+ "COMMAND NOT FOUND!" +\
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."
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."
611 # Set up common yacc/bison flags (needed for Ruby)
612 main
['YACCFLAGS'] = '-d'
613 main
['YACCHXXFILESUFFIX'] = '.hh'
615 # Do this after we save setting back, or else we'll tack on an
616 # extra 'qdo' every time we run scons.
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']
624 if sys
.platform
== 'cygwin':
625 # cygwin has some header file issues...
626 main
.Append(CCFLAGS
=["-Wno-uninitialized"])
628 # Check for the protobuf compiler
629 protoc_version
= readCommand([main
['PROTOC'], '--version'],
630 exception
='').split()
632 # First two words should be "libprotoc x.y.z"
633 if 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.' + \
638 main
['PROTOC'] = False
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.'
646 main
.ParseConfig('pkg-config --cflags --libs-only-L protobuf')
648 # Based on the availability of the compress stream wrappers,
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]
657 if not main
.has_key('SWIG'):
658 print 'Error: SWIG utility not found.'
659 print ' Please install (see http://www.swig.org) and retry.'
662 # Check for appropriate SWIG version
663 swig_version
= readCommand([main
['SWIG'], '-version'], exception
='').split()
664 # First 3 words should be "SWIG Version x.y.z"
665 if len(swig_version
) < 3 or \
666 swig_version
[0] != 'SWIG' or swig_version
[1] != 'Version':
667 print 'Error determining SWIG version.'
670 min_swig_version
= '1.3.34'
671 if 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]
676 # Set up SWIG flags & scanner
677 swig_flags
=Split('-c++ -python -modern -templatereduce $_CPPINCFLAGS')
678 main
.Append(SWIGFLAGS
=swig_flags
)
680 # filter out all existing swig scanners, they mess up the dependency
681 # stuff for some reason
683 for scanner
in main
['SCANNERS']:
684 skeys
= scanner
.skeys
688 if isinstance(skeys
, (list, tuple)) and '.i' in skeys
:
691 scanners
.append(scanner
)
693 # add the new swig scanner that we like better
694 from SCons
.Scanner
import ClassicCPP
as CPPScanner
695 swig_inc_re
= '^[ \t]*[%,#][ \t]*(?:include|import)[ \t]*(<|")([^>"]+)(>|")'
696 scanners
.append(CPPScanner("SwigScan", [ ".i" ], "CPPPATH", swig_inc_re
))
698 # replace the scanners list that has what we want
699 main
['SCANNERS'] = scanners
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.
705 def 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
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");
721 int main() { return x; }
723 context
.env
.Append(LEADING_UNDERSCORE
=ret
)
727 # Platform-specific configuration. Note again that we assume that all
728 # builds under a given build root run on the same host platform.
729 conf
= Configure(main
,
730 conf_dir
= joinpath(build_root
, '.scons_config'),
731 log_file
= joinpath(build_root
, 'scons_config.log'),
732 custom_tests
= { 'CheckLeading' : CheckLeading
})
734 # Check for leading underscores. Don't really need to worry either
735 # way so don't need to check the return code.
738 # Check if we should compile a 64 bit binary on Mac OS X/Darwin
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'])
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.
757 def NullCheck(*args
, **kwargs
):
761 def __init__(self
, env
):
765 def __getattr__(self
, mname
):
768 conf
= NullConf(main
)
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.
775 from distutils
import sysconfig
777 py_getvar
= sysconfig
.get_config_var
779 py_debug
= getattr(sys
, 'pydebug', False)
780 py_version
= 'python' + py_getvar('VERSION') + (py_debug
and "_d" or "")
782 py_general_include
= sysconfig
.get_python_inc()
783 py_platform_include
= sysconfig
.get_python_inc(plat_specific
=True)
784 py_includes
= [ py_general_include
]
785 if py_platform_include
!= py_general_include
:
786 py_includes
.append(py_platform_include
)
788 py_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/.
791 if not py_getvar('Py_ENABLE_SHARED'):
792 py_lib_path
.append(py_getvar('LIBPL'))
795 for 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
])
802 if lib
not in py_libs
:
804 py_libs
.append(py_version
)
806 main
.Append(CPPPATH
=py_includes
)
807 main
.Append(LIBPATH
=py_lib_path
)
809 # Cache build files in the supplied directory.
810 if main
['M5_BUILD_CACHE']:
811 print 'Using build cache located at', main
['M5_BUILD_CACHE']
812 CacheDir(main
['M5_BUILD_CACHE'])
815 # verify that this stuff works
816 if 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)"
822 if not conf
.CheckLib(lib
):
823 print "Error: can't find library %s required by python" % lib
826 # On Solaris you need to use libsocket for socket ops
827 if 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())"
832 # Check for zlib. If the check passes, libz will be automatically
833 # added to the LIBS environment variable.
834 if 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.'
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.
845 main
['HAVE_PROTOBUF'] = main
['PROTOC'] and \
846 conf
.CheckLibWithHeader('protobuf', 'google/protobuf/message.h',
847 'C++', 'GOOGLE_PROTOBUF_VERIFY_VERSION;')
849 # If we have the compiler but not the library, treat it as an error.
850 if 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.'
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);')
862 if conf
.CheckLib('tcmalloc_minimal'):
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)." + \
871 if not have_posix_clock
:
872 print "Can't find library for POSIX clocks."
874 # Check for <fenv.h> (C99 FP environment control)
875 have_fenv
= conf
.CheckHeader('fenv.h', '<>')
877 print "Warning: Header file <fenv.h> not found."
878 print " This host has no IEEE FP rounding mode control."
880 ######################################################################
882 # Finish the configuration
886 ######################################################################
888 # Collect all non-global variables
891 # Define the universe of supported ISAs
893 Export('all_isa_list')
895 class CpuModel(object):
896 '''The CpuModel class encapsulates everything the ISA parser needs to
897 know about a particular CPU model.'''
899 # Dict of available CPU model objects. Accessible as CpuModel.dict.
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
913 # This cpu is enabled by default
914 self
.default
= default
917 if name
in CpuModel
.dict:
918 raise AttributeError, "CpuModel '%s' already registered" % name
919 CpuModel
.dict[name
] = self
920 CpuModel
.list.append(name
)
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).
927 sticky_vars
= Variables(args
=ARGUMENTS
)
928 Export('sticky_vars')
930 # Sticky variables that should be exported
932 Export('export_vars')
936 Export('all_protocols')
938 Export('protocol_dirs')
940 Export('slicc_includes')
942 # Walk the tree and execute all SConsopts scripts that wil add to the
944 if not GetOption('verbose'):
945 print "Reading SConsopts"
946 for bdir
in [ base_dir
] + extras_dir_list
:
948 print "Error: directory '%s' does not exist" % bdir
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'))
958 sticky_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',
965 BoolVariable('SS_COMPATIBLE_FP',
966 'Make floating-point results compatible with SimpleScalar',
968 BoolVariable('USE_SSE2',
969 'Compile for SSE2 (-msse2) to get IEEE FP on x86 hosts',
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',
978 # These variables get exported to #defines in config/*.hh (see src/SConscript).
979 export_vars
+= ['USE_FENV', 'SS_COMPATIBLE_FP', 'TARGET_ISA', 'CP_ANNOTATE',
980 'USE_POSIX_CLOCK', 'PROTOCOL', 'HAVE_PROTOBUF']
982 ###################################################
984 # Define a SCons builder for configuration flag headers.
986 ###################################################
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.
992 def 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
999 # Combine the two functions into a scons Action object.
1000 config_action
= MakeAction(build_config_file
, Transform("CONFIG H", 2))
1002 # The emitter munges the source & target node lists to reflect what
1003 # we're really doing.
1004 def 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')
1010 if isinstance(val
, bool):
1011 # Force value to 0/1
1013 elif isinstance(val
, str):
1014 val
= '"' + val
+ '"'
1016 # Sources are variable name & value (packaged in SCons Value nodes)
1017 return ([target
], [Value(variable
), Value(val
)])
1019 config_builder
= Builder(emitter
= config_emitter
, action
= config_action
)
1021 main
.Append(BUILDERS
= { 'ConfigFile' : config_builder
})
1023 # libelf build is shared across all configs in the build root.
1024 main
.SConscript('ext/libelf/SConscript',
1025 variant_dir
= joinpath(build_root
, 'libelf'))
1027 # gzstream build is shared across all configs in the build root.
1028 main
.SConscript('ext/gzstream/SConscript',
1029 variant_dir
= joinpath(build_root
, 'gzstream'))
1031 ###################################################
1033 # This function is used to set up a directory with switching headers
1035 ###################################################
1037 main
['ALL_ISA_LIST'] = all_isa_list
1038 def 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
))
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'])
1055 # Instantiate actions for each header
1056 for hdr
in switch_headers
:
1057 env
.Command(hdr
, [], switch_hdr_action
)
1058 Export('make_switching_dir')
1060 ###################################################
1062 # Define build environments for selected configurations.
1064 ###################################################
1066 for variant_path
in variant_paths
:
1067 print "Building in", variant_path
1069 # Make a copy of the build-root environment to use for this config.
1071 env
['BUILDDIR'] = variant_path
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
)
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
1087 # Build dir-specific variables file doesn't exist.
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
):
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')
1100 default_vars_files
= [joinpath(build_root
, 'variables', default
),
1101 joinpath(opts_dir
, default
)]
1103 default_vars_files
= [joinpath(opts_dir
, variant_dir
)]
1104 existing_files
= filter(isfile
, default_vars_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
)
1111 print "Error: cannot find variables file %s or " \
1112 "default file(s) %s" \
1113 % (current_vars_file
, ' or '.join(default_vars_files
))
1116 # Apply current variable settings to env
1117 sticky_vars
.Update(env
)
1119 help_texts
["local_vars"] += \
1120 "Build variables for %s:\n" % variant_dir \
1121 + sticky_vars
.GenerateHelpText(env
)
1123 # Process variable settings.
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
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."
1135 env
.Append(LIBS
=['efence'])
1137 # Save sticky variable settings back to current variables file
1138 sticky_vars
.Save(current_vars_file
, env
)
1141 env
.Append(CCFLAGS
=['-msse2'])
1144 env
.Append(LIBS
=['tcmalloc_minimal'])
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
,
1152 # Set up the regression tests for each build.
1154 SConscript('tests/SConscript',
1155 variant_dir
= joinpath(variant_path
, 'tests', e
.Label
),
1156 exports
= { 'env' : e
}, duplicate
= False)
1160 Usage: scons [scons options] [build variables] [target(s)]
1162 Extra scons options:
1165 Global build variables: