3 # Copyright (c) 2013 ARM Limited
6 # The license below extends only to copyright in the software and shall
7 # not be construed as granting a license to any other intellectual
8 # property including but not limited to intellectual property relating
9 # to a hardware implementation of the functionality of the software
10 # licensed hereunder. You may use the software subject to the license
11 # terms below provided that you ensure that this notice is replicated
12 # unmodified and in its entirety in all distributions of the software,
13 # modified or unmodified, in source code or in binary form.
15 # Copyright (c) 2011 Advanced Micro Devices, Inc.
16 # Copyright (c) 2009 The Hewlett-Packard Development Company
17 # Copyright (c) 2004-2005 The Regents of The University of Michigan
18 # All rights reserved.
20 # Redistribution and use in source and binary forms, with or without
21 # modification, are permitted provided that the following conditions are
22 # met: redistributions of source code must retain the above copyright
23 # notice, this list of conditions and the following disclaimer;
24 # redistributions in binary form must reproduce the above copyright
25 # notice, this list of conditions and the following disclaimer in the
26 # documentation and/or other materials provided with the distribution;
27 # neither the name of the copyright holders nor the names of its
28 # contributors may be used to endorse or promote products derived from
29 # this software without specific prior written permission.
31 # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
32 # "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
33 # LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
34 # A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
35 # OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
36 # SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
37 # LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
38 # DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
39 # THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
40 # (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
41 # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
43 # Authors: Steve Reinhardt
46 ###################################################
48 # SCons top-level build description (SConstruct) file.
50 # While in this directory ('gem5'), just type 'scons' to build the default
51 # configuration (see below), or type 'scons build/<CONFIG>/<binary>'
52 # to build some other configuration (e.g., 'build/ALPHA/gem5.opt' for
53 # the optimized full-system version).
55 # You can build gem5 in a different directory as long as there is a
56 # 'build/<CONFIG>' somewhere along the target path. The build system
57 # expects that all configs under the same build directory are being
58 # built for the same host system.
62 # The following two commands are equivalent. The '-u' option tells
63 # scons to search up the directory tree for this SConstruct file.
64 # % cd <path-to-src>/gem5 ; scons build/ALPHA/gem5.debug
65 # % cd <path-to-src>/gem5/build/ALPHA; scons -u gem5.debug
67 # The following two commands are equivalent and demonstrate building
68 # in a directory outside of the source tree. The '-C' option tells
69 # scons to chdir to the specified directory to find this SConstruct
71 # % cd <path-to-src>/gem5 ; scons /local/foo/build/ALPHA/gem5.debug
72 # % cd /local/foo/build/ALPHA; scons -C <path-to-src>/gem5 gem5.debug
74 # You can use 'scons -H' to print scons options. If you're in this
75 # 'gem5' directory (or use -u or -C to tell scons where to find this
76 # file), you can use 'scons -h' to print all the gem5-specific build
79 ###################################################
81 # Check for recent-enough Python and SCons versions.
83 # Really old versions of scons only take two options for the
84 # function, so check once without the revision and once with the
85 # revision, the first instance will fail for stuff other than
86 # 0.98, and the second will fail for 0.98.0
87 EnsureSConsVersion(0, 98)
88 EnsureSConsVersion(0, 98, 1)
91 For more details, see:
92 http://gem5.org/Dependencies
96 # We ensure the python version early because because python-config
99 EnsurePythonVersion(2, 5)
100 except SystemExit, e
:
102 You can use a non-default installation of the Python interpreter by
103 rearranging your PATH so that scons finds the non-default 'python' and
104 'python-config' first.
106 For more details, see:
107 http://gem5.org/wiki/index.php/Using_a_non-default_Python_installation
111 # Global Python includes
117 from os
import mkdir
, environ
118 from os
.path
import abspath
, basename
, dirname
, expanduser
, normpath
119 from os
.path
import exists
, isdir
, isfile
120 from os
.path
import join
as joinpath
, split
as splitpath
126 extra_python_paths
= [
127 Dir('src/python').srcnode().abspath
, # gem5 includes
128 Dir('ext/ply').srcnode().abspath
, # ply is used by several files
131 sys
.path
[1:1] = extra_python_paths
133 from m5
.util
import compareVersions
, readCommand
134 from m5
.util
.terminal
import get_termcap
145 # There's a bug in scons in that (1) by default, the help texts from
146 # AddOption() are supposed to be displayed when you type 'scons -h'
147 # and (2) you can override the help displayed by 'scons -h' using the
148 # Help() function, but these two features are incompatible: once
149 # you've overridden the help text using Help(), there's no way to get
150 # at the help texts from AddOptions. See:
151 # http://scons.tigris.org/issues/show_bug.cgi?id=2356
152 # http://scons.tigris.org/issues/show_bug.cgi?id=2611
153 # This hack lets us extract the help text from AddOptions and
154 # re-inject it via Help(). Ideally someday this bug will be fixed and
155 # we can just use AddOption directly.
156 def AddLocalOption(*args
, **kwargs
):
159 help = " " + ", ".join(args
)
162 if length
>= col_width
:
163 help += "\n" + " " * col_width
165 help += " " * (col_width
- length
)
166 help += kwargs
["help"]
167 help_texts
["options"] += help + "\n"
169 AddOption(*args
, **kwargs
)
171 AddLocalOption('--colors', dest
='use_colors', action
='store_true',
172 help="Add color to abbreviated scons output")
173 AddLocalOption('--no-colors', dest
='use_colors', action
='store_false',
174 help="Don't add color to abbreviated scons output")
175 AddLocalOption('--default', dest
='default', type='string', action
='store',
176 help='Override which build_opts file to use for defaults')
177 AddLocalOption('--ignore-style', dest
='ignore_style', action
='store_true',
178 help='Disable style checking hooks')
179 AddLocalOption('--no-lto', dest
='no_lto', action
='store_true',
180 help='Disable Link-Time Optimization for fast')
181 AddLocalOption('--update-ref', dest
='update_ref', action
='store_true',
182 help='Update test reference outputs')
183 AddLocalOption('--verbose', dest
='verbose', action
='store_true',
184 help='Print full tool command lines')
186 termcap
= get_termcap(GetOption('use_colors'))
188 ########################################################################
190 # Set up the main build environment.
192 ########################################################################
193 use_vars
= set([ 'AS', 'AR', 'CC', 'CXX', 'HOME', 'LD_LIBRARY_PATH',
194 'LIBRARY_PATH', 'PATH', 'PKG_CONFIG_PATH', 'PYTHONPATH',
198 "M5", # M5 configuration (e.g., path to kernels)
199 "DISTCC_", # distcc (distributed compiler wrapper) configuration
200 "CCACHE_", # ccache (caching compiler wrapper) configuration
201 "CCC_", # clang static analyzer configuration
205 for key
,val
in os
.environ
.iteritems():
206 if key
in use_vars
or \
207 any([key
.startswith(prefix
) for prefix
in use_prefixes
]):
210 main
= Environment(ENV
=use_env
)
211 main
.Decider('MD5-timestamp')
212 main
.root
= Dir(".") # The current directory (where this file lives).
213 main
.srcdir
= Dir("src") # The source directory
215 main_dict_keys
= main
.Dictionary().keys()
217 # Check that we have a C/C++ compiler
218 if not ('CC' in main_dict_keys
and 'CXX' in main_dict_keys
):
219 print "No C++ compiler installed (package g++ on Ubuntu and RedHat)"
222 # Check that swig is present
223 if not 'SWIG' in main_dict_keys
:
224 print "swig is not installed (package swig on Ubuntu and RedHat)"
227 # add useful python code PYTHONPATH so it can be used by subprocesses
229 main
.AppendENVPath('PYTHONPATH', extra_python_paths
)
231 ########################################################################
235 # If the gem5 directory is a mercurial repository, we should do some
238 ########################################################################
240 hgdir
= main
.root
.Dir(".hg")
242 mercurial_style_message
= """
243 You're missing the gem5 style hook, which automatically checks your code
244 against the gem5 style rules on hg commit and qrefresh commands. This
245 script will now install the hook in your .hg/hgrc file.
246 Press enter to continue, or ctrl-c to abort: """
248 mercurial_style_hook
= """
249 # The following lines were automatically added by gem5/SConstruct
250 # to provide the gem5 style-checking hooks
252 style = %s/util/style.py
255 pretxncommit.style = python:style.check_style
256 pre-qrefresh.style = python:style.check_style
257 # End of SConstruct additions
259 """ % (main
.root
.abspath
)
261 mercurial_lib_not_found
= """
262 Mercurial libraries cannot be found, ignoring style hook. If
263 you are a gem5 developer, please fix this and run the style
264 hook. It is important.
267 # Check for style hook and prompt for installation if it's not there.
268 # Skip this if --ignore-style was specified, there's no .hg dir to
269 # install a hook in, or there's no interactive terminal to prompt.
270 if not GetOption('ignore_style') and hgdir
.exists() and sys
.stdin
.isatty():
273 from mercurial
import ui
275 ui
.readconfig(hgdir
.File('hgrc').abspath
)
276 style_hook
= ui
.config('hooks', 'pretxncommit.style', None) and \
277 ui
.config('hooks', 'pre-qrefresh.style', None)
279 print mercurial_lib_not_found
282 print mercurial_style_message
,
283 # continue unless user does ctrl-c/ctrl-d etc.
287 print "Input exception, exiting scons.\n"
289 hgrc_path
= '%s/.hg/hgrc' % main
.root
.abspath
290 print "Adding style hook to", hgrc_path
, "\n"
292 hgrc
= open(hgrc_path
, 'a')
293 hgrc
.write(mercurial_style_hook
)
296 print "Error updating", hgrc_path
300 ###################################################
302 # Figure out which configurations to set up based on the path(s) of
305 ###################################################
307 # Find default configuration & binary.
308 Default(environ
.get('M5_DEFAULT_BINARY', 'build/ALPHA/gem5.debug'))
310 # helper function: find last occurrence of element in list
311 def rfind(l
, elt
, offs
= -1):
312 for i
in range(len(l
)+offs
, 0, -1):
315 raise ValueError, "element not found"
317 # Take a list of paths (or SCons Nodes) and return a list with all
318 # paths made absolute and ~-expanded. Paths will be interpreted
319 # relative to the launch directory unless a different root is provided
320 def makePathListAbsolute(path_list
, root
=GetLaunchDir()):
321 return [abspath(joinpath(root
, expanduser(str(p
))))
324 # Each target must have 'build' in the interior of the path; the
325 # directory below this will determine the build parameters. For
326 # example, for target 'foo/bar/build/ALPHA_SE/arch/alpha/blah.do' we
327 # recognize that ALPHA_SE specifies the configuration because it
328 # follow 'build' in the build path.
330 # The funky assignment to "[:]" is needed to replace the list contents
331 # in place rather than reassign the symbol to a new list, which
332 # doesn't work (obviously!).
333 BUILD_TARGETS
[:] = makePathListAbsolute(BUILD_TARGETS
)
335 # Generate a list of the unique build roots and configs that the
336 # collected targets reference.
339 for t
in BUILD_TARGETS
:
340 path_dirs
= t
.split('/')
342 build_top
= rfind(path_dirs
, 'build', -2)
344 print "Error: no non-leaf 'build' dir found on target path", t
346 this_build_root
= joinpath('/',*path_dirs
[:build_top
+1])
348 build_root
= this_build_root
350 if this_build_root
!= build_root
:
351 print "Error: build targets not under same build root\n"\
352 " %s\n %s" % (build_root
, this_build_root
)
354 variant_path
= joinpath('/',*path_dirs
[:build_top
+2])
355 if variant_path
not in variant_paths
:
356 variant_paths
.append(variant_path
)
358 # Make sure build_root exists (might not if this is the first build there)
359 if not isdir(build_root
):
361 main
['BUILDROOT'] = build_root
365 main
.SConsignFile(joinpath(build_root
, "sconsign"))
367 # Default duplicate option is to use hard links, but this messes up
368 # when you use emacs to edit a file in the target dir, as emacs moves
369 # file to file~ then copies to file, breaking the link. Symbolic
370 # (soft) links work better.
371 main
.SetOption('duplicate', 'soft-copy')
374 # Set up global sticky variables... these are common to an entire build
375 # tree (not specific to a particular build like ALPHA_SE)
378 global_vars_file
= joinpath(build_root
, 'variables.global')
380 global_vars
= Variables(global_vars_file
, args
=ARGUMENTS
)
382 global_vars
.AddVariables(
383 ('CC', 'C compiler', environ
.get('CC', main
['CC'])),
384 ('CXX', 'C++ compiler', environ
.get('CXX', main
['CXX'])),
385 ('SWIG', 'SWIG tool', environ
.get('SWIG', main
['SWIG'])),
386 ('PROTOC', 'protoc tool', environ
.get('PROTOC', 'protoc')),
387 ('BATCH', 'Use batch pool for build and tests', False),
388 ('BATCH_CMD', 'Batch pool submission command name', 'qdo'),
389 ('M5_BUILD_CACHE', 'Cache built objects in this directory', False),
390 ('EXTRAS', 'Add extra directories to the compilation', '')
393 # Update main environment with values from ARGUMENTS & global_vars_file
394 global_vars
.Update(main
)
395 help_texts
["global_vars"] += global_vars
.GenerateHelpText(main
)
397 # Save sticky variable settings back to current variables file
398 global_vars
.Save(global_vars_file
, main
)
400 # Parse EXTRAS variable to build list of all directories where we're
401 # look for sources etc. This list is exported as extras_dir_list.
402 base_dir
= main
.srcdir
.abspath
404 extras_dir_list
= makePathListAbsolute(main
['EXTRAS'].split(':'))
409 Export('extras_dir_list')
411 # the ext directory should be on the #includes path
412 main
.Append(CPPPATH
=[Dir('ext')])
414 def strip_build_path(path
, env
):
416 variant_base
= env
['BUILDROOT'] + os
.path
.sep
417 if path
.startswith(variant_base
):
418 path
= path
[len(variant_base
):]
419 elif path
.startswith('build/'):
423 # Generate a string of the form:
424 # common/path/prefix/src1, src2 -> tgt1, tgt2
425 # to print while building.
426 class Transform(object):
427 # all specific color settings should be here and nowhere else
428 tool_color
= termcap
.Normal
429 pfx_color
= termcap
.Yellow
430 srcs_color
= termcap
.Yellow
+ termcap
.Bold
431 arrow_color
= termcap
.Blue
+ termcap
.Bold
432 tgts_color
= termcap
.Yellow
+ termcap
.Bold
434 def __init__(self
, tool
, max_sources
=99):
435 self
.format
= self
.tool_color
+ (" [%8s] " % tool
) \
436 + self
.pfx_color
+ "%s" \
437 + self
.srcs_color
+ "%s" \
438 + self
.arrow_color
+ " -> " \
439 + self
.tgts_color
+ "%s" \
441 self
.max_sources
= max_sources
443 def __call__(self
, target
, source
, env
, for_signature
=None):
444 # truncate source list according to max_sources param
445 source
= source
[0:self
.max_sources
]
447 return strip_build_path(str(f
), env
)
449 srcs
= map(strip
, source
)
452 tgts
= map(strip
, target
)
453 # surprisingly, os.path.commonprefix is a dumb char-by-char string
454 # operation that has nothing to do with paths.
455 com_pfx
= os
.path
.commonprefix(srcs
+ tgts
)
456 com_pfx_len
= len(com_pfx
)
458 # do some cleanup and sanity checking on common prefix
459 if com_pfx
[-1] == ".":
460 # prefix matches all but file extension: ok
461 # back up one to change 'foo.cc -> o' to 'foo.cc -> .o'
462 com_pfx
= com_pfx
[0:-1]
463 elif com_pfx
[-1] == "/":
464 # common prefix is directory path: OK
467 src0_len
= len(srcs
[0])
468 tgt0_len
= len(tgts
[0])
469 if src0_len
== com_pfx_len
:
470 # source is a substring of target, OK
472 elif tgt0_len
== com_pfx_len
:
473 # target is a substring of source, need to back up to
474 # avoid empty string on RHS of arrow
475 sep_idx
= com_pfx
.rfind(".")
477 com_pfx
= com_pfx
[0:sep_idx
]
480 elif src0_len
> com_pfx_len
and srcs
[0][com_pfx_len
] == ".":
481 # still splitting at file extension: ok
484 # probably a fluke; ignore it
486 # recalculate length in case com_pfx was modified
487 com_pfx_len
= len(com_pfx
)
489 f
= map(lambda s
: s
[com_pfx_len
:], files
)
491 return self
.format
% (com_pfx
, fmt(srcs
), fmt(tgts
))
495 # enable the regression script to use the termcap
496 main
['TERMCAP'] = termcap
498 if GetOption('verbose'):
499 def MakeAction(action
, string
, *args
, **kwargs
):
500 return Action(action
, *args
, **kwargs
)
503 main
['CCCOMSTR'] = Transform("CC")
504 main
['CXXCOMSTR'] = Transform("CXX")
505 main
['ASCOMSTR'] = Transform("AS")
506 main
['SWIGCOMSTR'] = Transform("SWIG")
507 main
['ARCOMSTR'] = Transform("AR", 0)
508 main
['LINKCOMSTR'] = Transform("LINK", 0)
509 main
['RANLIBCOMSTR'] = Transform("RANLIB", 0)
510 main
['M4COMSTR'] = Transform("M4")
511 main
['SHCCCOMSTR'] = Transform("SHCC")
512 main
['SHCXXCOMSTR'] = Transform("SHCXX")
515 # Initialize the Link-Time Optimization (LTO) flags
516 main
['LTO_CCFLAGS'] = []
517 main
['LTO_LDFLAGS'] = []
519 # According to the readme, tcmalloc works best if the compiler doesn't
520 # assume that we're using the builtin malloc and friends. These flags
521 # are compiler-specific, so we need to set them after we detect which
522 # compiler we're using.
523 main
['TCMALLOC_CCFLAGS'] = []
525 CXX_version
= readCommand([main
['CXX'],'--version'], exception
=False)
526 CXX_V
= readCommand([main
['CXX'],'-V'], exception
=False)
528 main
['GCC'] = CXX_version
and CXX_version
.find('g++') >= 0
529 main
['CLANG'] = CXX_version
and CXX_version
.find('clang') >= 0
530 if main
['GCC'] + main
['CLANG'] > 1:
531 print 'Error: How can we have two at the same time?'
534 # Set up default C++ compiler flags
535 if main
['GCC'] or main
['CLANG']:
536 # As gcc and clang share many flags, do the common parts here
537 main
.Append(CCFLAGS
=['-pipe'])
538 main
.Append(CCFLAGS
=['-fno-strict-aliasing'])
539 # Enable -Wall and then disable the few warnings that we
540 # consistently violate
541 main
.Append(CCFLAGS
=['-Wall', '-Wno-sign-compare', '-Wundef'])
542 # We always compile using C++11, but only gcc >= 4.7 and clang 3.1
543 # actually use that name, so we stick with c++0x
544 main
.Append(CXXFLAGS
=['-std=c++0x'])
545 # Add selected sanity checks from -Wextra
546 main
.Append(CXXFLAGS
=['-Wmissing-field-initializers',
547 '-Woverloaded-virtual'])
549 print termcap
.Yellow
+ termcap
.Bold
+ 'Error' + termcap
.Normal
,
550 print "Don't know what compiler options to use for your compiler."
551 print termcap
.Yellow
+ ' compiler:' + termcap
.Normal
, main
['CXX']
552 print termcap
.Yellow
+ ' version:' + termcap
.Normal
,
554 print termcap
.Yellow
+ termcap
.Bold
+ "COMMAND NOT FOUND!" +\
557 print CXX_version
.replace('\n', '<nl>')
558 print " If you're trying to use a compiler other than GCC"
559 print " or clang, there appears to be something wrong with your"
560 print " environment."
562 print " If you are trying to use a compiler other than those listed"
563 print " above you will need to ease fix SConstruct and "
564 print " src/SConscript to support that compiler."
568 # Check for a supported version of gcc, >= 4.4 is needed for c++0x
569 # support. See http://gcc.gnu.org/projects/cxx0x.html for details
570 gcc_version
= readCommand([main
['CXX'], '-dumpversion'], exception
=False)
571 if compareVersions(gcc_version
, "4.4") < 0:
572 print 'Error: gcc version 4.4 or newer required.'
573 print ' Installed version:', gcc_version
576 main
['GCC_VERSION'] = gcc_version
578 # Check for versions with bugs
579 if not compareVersions(gcc_version
, '4.4.1') or \
580 not compareVersions(gcc_version
, '4.4.2'):
581 print 'Info: Tree vectorizer in GCC 4.4.1 & 4.4.2 is buggy, disabling.'
582 main
.Append(CCFLAGS
=['-fno-tree-vectorize'])
584 # LTO support is only really working properly from 4.6 and beyond
585 if compareVersions(gcc_version
, '4.6') >= 0:
586 # Add the appropriate Link-Time Optimization (LTO) flags
587 # unless LTO is explicitly turned off. Note that these flags
588 # are only used by the fast target.
589 if not GetOption('no_lto'):
590 # Pass the LTO flag when compiling to produce GIMPLE
591 # output, we merely create the flags here and only append
593 main
['LTO_CCFLAGS'] = ['-flto=%d' % GetOption('num_jobs')]
595 # Use the same amount of jobs for LTO as we are running
596 # scons with, we hardcode the use of the linker plugin
597 # which requires either gold or GNU ld >= 2.21
598 main
['LTO_LDFLAGS'] = ['-flto=%d' % GetOption('num_jobs'),
599 '-fuse-linker-plugin']
601 main
.Append(TCMALLOC_CCFLAGS
=['-fno-builtin-malloc', '-fno-builtin-calloc',
602 '-fno-builtin-realloc', '-fno-builtin-free'])
605 # Check for a supported version of clang, >= 2.9 is needed to
606 # support similar features as gcc 4.4. See
607 # http://clang.llvm.org/cxx_status.html for details
608 clang_version_re
= re
.compile(".* version (\d+\.\d+)")
609 clang_version_match
= clang_version_re
.match(CXX_version
)
610 if (clang_version_match
):
611 clang_version
= clang_version_match
.groups()[0]
612 if compareVersions(clang_version
, "2.9") < 0:
613 print 'Error: clang version 2.9 or newer required.'
614 print ' Installed version:', clang_version
617 print 'Error: Unable to determine clang version.'
620 # clang has a few additional warnings that we disable,
621 # tautological comparisons are allowed due to unsigned integers
622 # being compared to constants that happen to be 0, and extraneous
623 # parantheses are allowed due to Ruby's printing of the AST,
624 # finally self assignments are allowed as the generated CPU code
626 main
.Append(CCFLAGS
=['-Wno-tautological-compare',
630 main
.Append(TCMALLOC_CCFLAGS
=['-fno-builtin'])
632 # On Mac OS X/Darwin we need to also use libc++ (part of XCode) as
633 # opposed to libstdc++, as the later is dated.
634 if sys
.platform
== "darwin":
635 main
.Append(CXXFLAGS
=['-stdlib=libc++'])
636 main
.Append(LIBS
=['c++'])
639 print termcap
.Yellow
+ termcap
.Bold
+ 'Error' + termcap
.Normal
,
640 print "Don't know what compiler options to use for your compiler."
641 print termcap
.Yellow
+ ' compiler:' + termcap
.Normal
, main
['CXX']
642 print termcap
.Yellow
+ ' version:' + termcap
.Normal
,
644 print termcap
.Yellow
+ termcap
.Bold
+ "COMMAND NOT FOUND!" +\
647 print CXX_version
.replace('\n', '<nl>')
648 print " If you're trying to use a compiler other than GCC"
649 print " or clang, there appears to be something wrong with your"
650 print " environment."
652 print " If you are trying to use a compiler other than those listed"
653 print " above you will need to ease fix SConstruct and "
654 print " src/SConscript to support that compiler."
657 # Set up common yacc/bison flags (needed for Ruby)
658 main
['YACCFLAGS'] = '-d'
659 main
['YACCHXXFILESUFFIX'] = '.hh'
661 # Do this after we save setting back, or else we'll tack on an
662 # extra 'qdo' every time we run scons.
664 main
['CC'] = main
['BATCH_CMD'] + ' ' + main
['CC']
665 main
['CXX'] = main
['BATCH_CMD'] + ' ' + main
['CXX']
666 main
['AS'] = main
['BATCH_CMD'] + ' ' + main
['AS']
667 main
['AR'] = main
['BATCH_CMD'] + ' ' + main
['AR']
668 main
['RANLIB'] = main
['BATCH_CMD'] + ' ' + main
['RANLIB']
670 if sys
.platform
== 'cygwin':
671 # cygwin has some header file issues...
672 main
.Append(CCFLAGS
=["-Wno-uninitialized"])
674 # Check for the protobuf compiler
675 protoc_version
= readCommand([main
['PROTOC'], '--version'],
676 exception
='').split()
678 # First two words should be "libprotoc x.y.z"
679 if len(protoc_version
) < 2 or protoc_version
[0] != 'libprotoc':
680 print termcap
.Yellow
+ termcap
.Bold
+ \
681 'Warning: Protocol buffer compiler (protoc) not found.\n' + \
682 ' Please install protobuf-compiler for tracing support.' + \
684 main
['PROTOC'] = False
686 # Based on the availability of the compress stream wrappers,
688 min_protoc_version
= '2.1.0'
689 if compareVersions(protoc_version
[1], min_protoc_version
) < 0:
690 print termcap
.Yellow
+ termcap
.Bold
+ \
691 'Warning: protoc version', min_protoc_version
, \
692 'or newer required.\n' + \
693 ' Installed version:', protoc_version
[1], \
695 main
['PROTOC'] = False
697 # Attempt to determine the appropriate include path and
698 # library path using pkg-config, that means we also need to
699 # check for pkg-config. Note that it is possible to use
700 # protobuf without the involvement of pkg-config. Later on we
701 # check go a library config check and at that point the test
702 # will fail if libprotobuf cannot be found.
703 if readCommand(['pkg-config', '--version'], exception
=''):
705 # Attempt to establish what linking flags to add for protobuf
707 main
.ParseConfig('pkg-config --cflags --libs-only-L protobuf')
709 print termcap
.Yellow
+ termcap
.Bold
+ \
710 'Warning: pkg-config could not get protobuf flags.' + \
714 if not main
.has_key('SWIG'):
715 print 'Error: SWIG utility not found.'
716 print ' Please install (see http://www.swig.org) and retry.'
719 # Check for appropriate SWIG version
720 swig_version
= readCommand([main
['SWIG'], '-version'], exception
='').split()
721 # First 3 words should be "SWIG Version x.y.z"
722 if len(swig_version
) < 3 or \
723 swig_version
[0] != 'SWIG' or swig_version
[1] != 'Version':
724 print 'Error determining SWIG version.'
727 min_swig_version
= '1.3.34'
728 if compareVersions(swig_version
[2], min_swig_version
) < 0:
729 print 'Error: SWIG version', min_swig_version
, 'or newer required.'
730 print ' Installed version:', swig_version
[2]
733 # Older versions of swig do not play well with more recent versions of
734 # gcc due to assumptions on implicit includes (cstddef) and use of
736 if main
['GCC'] and compareVersions(gcc_version
, '4.6') > 0 and \
737 compareVersions(swig_version
[2], '2') < 0:
738 print '\n' + termcap
.Yellow
+ termcap
.Bold
+ \
739 'Warning: SWIG 1.x cause issues with gcc 4.6 and later.\n' + \
741 'Use SWIG 2.x to avoid assumptions on implicit includes\n' + \
742 'and use of namespaces\n'
744 # Set up SWIG flags & scanner
745 swig_flags
=Split('-c++ -python -modern -templatereduce $_CPPINCFLAGS')
746 main
.Append(SWIGFLAGS
=swig_flags
)
748 # filter out all existing swig scanners, they mess up the dependency
749 # stuff for some reason
751 for scanner
in main
['SCANNERS']:
752 skeys
= scanner
.skeys
756 if isinstance(skeys
, (list, tuple)) and '.i' in skeys
:
759 scanners
.append(scanner
)
761 # add the new swig scanner that we like better
762 from SCons
.Scanner
import ClassicCPP
as CPPScanner
763 swig_inc_re
= '^[ \t]*[%,#][ \t]*(?:include|import)[ \t]*(<|")([^>"]+)(>|")'
764 scanners
.append(CPPScanner("SwigScan", [ ".i" ], "CPPPATH", swig_inc_re
))
766 # replace the scanners list that has what we want
767 main
['SCANNERS'] = scanners
769 # Add a custom Check function to the Configure context so that we can
770 # figure out if the compiler adds leading underscores to global
771 # variables. This is needed for the autogenerated asm files that we
772 # use for embedding the python code.
773 def CheckLeading(context
):
774 context
.Message("Checking for leading underscore in global variables...")
775 # 1) Define a global variable called x from asm so the C compiler
776 # won't change the symbol at all.
777 # 2) Declare that variable.
778 # 3) Use the variable
780 # If the compiler prepends an underscore, this will successfully
781 # link because the external symbol 'x' will be called '_x' which
782 # was defined by the asm statement. If the compiler does not
783 # prepend an underscore, this will not successfully link because
784 # '_x' will have been defined by assembly, while the C portion of
785 # the code will be trying to use 'x'
786 ret
= context
.TryLink('''
787 asm(".globl _x; _x: .byte 0");
789 int main() { return x; }
791 context
.env
.Append(LEADING_UNDERSCORE
=ret
)
795 # Platform-specific configuration. Note again that we assume that all
796 # builds under a given build root run on the same host platform.
797 conf
= Configure(main
,
798 conf_dir
= joinpath(build_root
, '.scons_config'),
799 log_file
= joinpath(build_root
, 'scons_config.log'),
800 custom_tests
= { 'CheckLeading' : CheckLeading
})
802 # Check for leading underscores. Don't really need to worry either
803 # way so don't need to check the return code.
806 # Check if we should compile a 64 bit binary on Mac OS X/Darwin
809 uname
= platform
.uname()
810 if uname
[0] == 'Darwin' and compareVersions(uname
[2], '9.0.0') >= 0:
811 if int(readCommand('sysctl -n hw.cpu64bit_capable')[0]):
812 main
.Append(CCFLAGS
=['-arch', 'x86_64'])
813 main
.Append(CFLAGS
=['-arch', 'x86_64'])
814 main
.Append(LINKFLAGS
=['-arch', 'x86_64'])
815 main
.Append(ASFLAGS
=['-arch', 'x86_64'])
819 # Recent versions of scons substitute a "Null" object for Configure()
820 # when configuration isn't necessary, e.g., if the "--help" option is
821 # present. Unfortuantely this Null object always returns false,
822 # breaking all our configuration checks. We replace it with our own
823 # more optimistic null object that returns True instead.
825 def NullCheck(*args
, **kwargs
):
829 def __init__(self
, env
):
833 def __getattr__(self
, mname
):
836 conf
= NullConf(main
)
838 # Cache build files in the supplied directory.
839 if main
['M5_BUILD_CACHE']:
840 print 'Using build cache located at', main
['M5_BUILD_CACHE']
841 CacheDir(main
['M5_BUILD_CACHE'])
843 # Find Python include and library directories for embedding the
844 # interpreter. We rely on python-config to resolve the appropriate
845 # includes and linker flags. ParseConfig does not seem to understand
846 # the more exotic linker flags such as -Xlinker and -export-dynamic so
847 # we add them explicitly below. If you want to link in an alternate
848 # version of python, see above for instructions on how to invoke
849 # scons with the appropriate PATH set.
850 py_includes
= readCommand(['python-config', '--includes'],
851 exception
='').split()
852 # Strip the -I from the include folders before adding them to the
854 main
.Append(CPPPATH
=map(lambda inc
: inc
[2:], py_includes
))
856 # Read the linker flags and split them into libraries and other link
857 # flags. The libraries are added later through the call the CheckLib.
858 py_ld_flags
= readCommand(['python-config', '--ldflags'], exception
='').split()
860 for lib
in py_ld_flags
:
861 if not lib
.startswith('-l'):
862 main
.Append(LINKFLAGS
=[lib
])
865 if lib
not in py_libs
:
868 # verify that this stuff works
869 if not conf
.CheckHeader('Python.h', '<>'):
870 print "Error: can't find Python.h header in", py_includes
871 print "Install Python headers (package python-dev on Ubuntu and RedHat)"
875 if not conf
.CheckLib(lib
):
876 print "Error: can't find library %s required by python" % lib
879 # On Solaris you need to use libsocket for socket ops
880 if not conf
.CheckLibWithHeader(None, 'sys/socket.h', 'C++', 'accept(0,0,0);'):
881 if not conf
.CheckLibWithHeader('socket', 'sys/socket.h', 'C++', 'accept(0,0,0);'):
882 print "Can't find library with socket calls (e.g. accept())"
885 # Check for zlib. If the check passes, libz will be automatically
886 # added to the LIBS environment variable.
887 if not conf
.CheckLibWithHeader('z', 'zlib.h', 'C++','zlibVersion();'):
888 print 'Error: did not find needed zlib compression library '\
889 'and/or zlib.h header file.'
890 print ' Please install zlib and try again.'
893 # If we have the protobuf compiler, also make sure we have the
894 # development libraries. If the check passes, libprotobuf will be
895 # automatically added to the LIBS environment variable. After
896 # this, we can use the HAVE_PROTOBUF flag to determine if we have
897 # got both protoc and libprotobuf available.
898 main
['HAVE_PROTOBUF'] = main
['PROTOC'] and \
899 conf
.CheckLibWithHeader('protobuf', 'google/protobuf/message.h',
900 'C++', 'GOOGLE_PROTOBUF_VERIFY_VERSION;')
902 # If we have the compiler but not the library, print another warning.
903 if main
['PROTOC'] and not main
['HAVE_PROTOBUF']:
904 print termcap
.Yellow
+ termcap
.Bold
+ \
905 'Warning: did not find protocol buffer library and/or headers.\n' + \
906 ' Please install libprotobuf-dev for tracing support.' + \
911 conf
.CheckLibWithHeader(None, 'time.h', 'C',
912 'clock_nanosleep(0,0,NULL,NULL);') or \
913 conf
.CheckLibWithHeader('rt', 'time.h', 'C',
914 'clock_nanosleep(0,0,NULL,NULL);')
916 if conf
.CheckLib('tcmalloc'):
917 main
.Append(CCFLAGS
=main
['TCMALLOC_CCFLAGS'])
918 elif conf
.CheckLib('tcmalloc_minimal'):
919 main
.Append(CCFLAGS
=main
['TCMALLOC_CCFLAGS'])
921 print termcap
.Yellow
+ termcap
.Bold
+ \
922 "You can get a 12% performance improvement by installing tcmalloc "\
923 "(libgoogle-perftools-dev package on Ubuntu or RedHat)." + \
926 if not have_posix_clock
:
927 print "Can't find library for POSIX clocks."
929 # Check for <fenv.h> (C99 FP environment control)
930 have_fenv
= conf
.CheckHeader('fenv.h', '<>')
932 print "Warning: Header file <fenv.h> not found."
933 print " This host has no IEEE FP rounding mode control."
935 # Check if we should enable KVM-based hardware virtualization
936 have_kvm
= conf
.CheckHeader('linux/kvm.h', '<>')
938 print "Info: Header file <linux/kvm.h> not found, " \
939 "disabling KVM support."
941 # Check if the requested target ISA is compatible with the host
942 def is_isa_kvm_compatible(isa
):
944 "arm" : ( "armv7l" ),
945 "x86" : ( "x86_64" ),
949 host_isa
= platform
.machine()
951 print "Warning: Failed to determine host ISA."
954 return host_isa
in isa_comp_table
.get(isa
, [])
957 ######################################################################
959 # Finish the configuration
963 ######################################################################
965 # Collect all non-global variables
968 # Define the universe of supported ISAs
970 Export('all_isa_list')
972 class CpuModel(object):
973 '''The CpuModel class encapsulates everything the ISA parser needs to
974 know about a particular CPU model.'''
976 # Dict of available CPU model objects. Accessible as CpuModel.dict.
981 # Constructor. Automatically adds models to CpuModel.dict.
982 def __init__(self
, name
, filename
, includes
, strings
, default
=False):
983 self
.name
= name
# name of model
984 self
.filename
= filename
# filename for output exec code
985 self
.includes
= includes
# include files needed in exec file
986 # The 'strings' dict holds all the per-CPU symbols we can
987 # substitute into templates etc.
988 self
.strings
= strings
990 # This cpu is enabled by default
991 self
.default
= default
994 if name
in CpuModel
.dict:
995 raise AttributeError, "CpuModel '%s' already registered" % name
996 CpuModel
.dict[name
] = self
997 CpuModel
.list.append(name
)
1001 # Sticky variables get saved in the variables file so they persist from
1002 # one invocation to the next (unless overridden, in which case the new
1003 # value becomes sticky).
1004 sticky_vars
= Variables(args
=ARGUMENTS
)
1005 Export('sticky_vars')
1007 # Sticky variables that should be exported
1009 Export('export_vars')
1013 Export('all_protocols')
1015 Export('protocol_dirs')
1017 Export('slicc_includes')
1019 # Walk the tree and execute all SConsopts scripts that wil add to the
1021 if not GetOption('verbose'):
1022 print "Reading SConsopts"
1023 for bdir
in [ base_dir
] + extras_dir_list
:
1025 print "Error: directory '%s' does not exist" % bdir
1027 for root
, dirs
, files
in os
.walk(bdir
):
1028 if 'SConsopts' in files
:
1029 if GetOption('verbose'):
1030 print "Reading", joinpath(root
, 'SConsopts')
1031 SConscript(joinpath(root
, 'SConsopts'))
1035 sticky_vars
.AddVariables(
1036 EnumVariable('TARGET_ISA', 'Target ISA', 'alpha', all_isa_list
),
1037 ListVariable('CPU_MODELS', 'CPU models',
1038 sorted(n
for n
,m
in CpuModel
.dict.iteritems() if m
.default
),
1039 sorted(CpuModel
.list)),
1040 BoolVariable('EFENCE', 'Link with Electric Fence malloc debugger',
1042 BoolVariable('SS_COMPATIBLE_FP',
1043 'Make floating-point results compatible with SimpleScalar',
1045 BoolVariable('USE_SSE2',
1046 'Compile for SSE2 (-msse2) to get IEEE FP on x86 hosts',
1048 BoolVariable('USE_POSIX_CLOCK', 'Use POSIX Clocks', have_posix_clock
),
1049 BoolVariable('USE_FENV', 'Use <fenv.h> IEEE mode control', have_fenv
),
1050 BoolVariable('CP_ANNOTATE', 'Enable critical path annotation capability', False),
1051 BoolVariable('USE_KVM', 'Enable hardware virtualized (KVM) CPU models', have_kvm
),
1052 EnumVariable('PROTOCOL', 'Coherence protocol for Ruby', 'None',
1056 # These variables get exported to #defines in config/*.hh (see src/SConscript).
1057 export_vars
+= ['USE_FENV', 'SS_COMPATIBLE_FP', 'TARGET_ISA', 'CP_ANNOTATE',
1058 'USE_POSIX_CLOCK', 'PROTOCOL', 'HAVE_PROTOBUF']
1060 ###################################################
1062 # Define a SCons builder for configuration flag headers.
1064 ###################################################
1066 # This function generates a config header file that #defines the
1067 # variable symbol to the current variable setting (0 or 1). The source
1068 # operands are the name of the variable and a Value node containing the
1069 # value of the variable.
1070 def build_config_file(target
, source
, env
):
1071 (variable
, value
) = [s
.get_contents() for s
in source
]
1072 f
= file(str(target
[0]), 'w')
1073 print >> f
, '#define', variable
, value
1077 # Combine the two functions into a scons Action object.
1078 config_action
= MakeAction(build_config_file
, Transform("CONFIG H", 2))
1080 # The emitter munges the source & target node lists to reflect what
1081 # we're really doing.
1082 def config_emitter(target
, source
, env
):
1083 # extract variable name from Builder arg
1084 variable
= str(target
[0])
1085 # True target is config header file
1086 target
= joinpath('config', variable
.lower() + '.hh')
1088 if isinstance(val
, bool):
1089 # Force value to 0/1
1091 elif isinstance(val
, str):
1092 val
= '"' + val
+ '"'
1094 # Sources are variable name & value (packaged in SCons Value nodes)
1095 return ([target
], [Value(variable
), Value(val
)])
1097 config_builder
= Builder(emitter
= config_emitter
, action
= config_action
)
1099 main
.Append(BUILDERS
= { 'ConfigFile' : config_builder
})
1101 # libelf build is shared across all configs in the build root.
1102 main
.SConscript('ext/libelf/SConscript',
1103 variant_dir
= joinpath(build_root
, 'libelf'))
1105 # gzstream build is shared across all configs in the build root.
1106 main
.SConscript('ext/gzstream/SConscript',
1107 variant_dir
= joinpath(build_root
, 'gzstream'))
1109 # libfdt build is shared across all configs in the build root.
1110 main
.SConscript('ext/libfdt/SConscript',
1111 variant_dir
= joinpath(build_root
, 'libfdt'))
1113 ###################################################
1115 # This function is used to set up a directory with switching headers
1117 ###################################################
1119 main
['ALL_ISA_LIST'] = all_isa_list
1120 def make_switching_dir(dname
, switch_headers
, env
):
1121 # Generate the header. target[0] is the full path of the output
1122 # header to generate. 'source' is a dummy variable, since we get the
1123 # list of ISAs from env['ALL_ISA_LIST'].
1124 def gen_switch_hdr(target
, source
, env
):
1125 fname
= str(target
[0])
1126 f
= open(fname
, 'w')
1127 isa
= env
['TARGET_ISA'].lower()
1128 print >>f
, '#include "%s/%s/%s"' % (dname
, isa
, basename(fname
))
1131 # Build SCons Action object. 'varlist' specifies env vars that this
1132 # action depends on; when env['ALL_ISA_LIST'] changes these actions
1133 # should get re-executed.
1134 switch_hdr_action
= MakeAction(gen_switch_hdr
,
1135 Transform("GENERATE"), varlist
=['ALL_ISA_LIST'])
1137 # Instantiate actions for each header
1138 for hdr
in switch_headers
:
1139 env
.Command(hdr
, [], switch_hdr_action
)
1140 Export('make_switching_dir')
1142 ###################################################
1144 # Define build environments for selected configurations.
1146 ###################################################
1148 for variant_path
in variant_paths
:
1149 print "Building in", variant_path
1151 # Make a copy of the build-root environment to use for this config.
1153 env
['BUILDDIR'] = variant_path
1155 # variant_dir is the tail component of build path, and is used to
1156 # determine the build parameters (e.g., 'ALPHA_SE')
1157 (build_root
, variant_dir
) = splitpath(variant_path
)
1159 # Set env variables according to the build directory config.
1160 sticky_vars
.files
= []
1161 # Variables for $BUILD_ROOT/$VARIANT_DIR are stored in
1162 # $BUILD_ROOT/variables/$VARIANT_DIR so you can nuke
1163 # $BUILD_ROOT/$VARIANT_DIR without losing your variables settings.
1164 current_vars_file
= joinpath(build_root
, 'variables', variant_dir
)
1165 if isfile(current_vars_file
):
1166 sticky_vars
.files
.append(current_vars_file
)
1167 print "Using saved variables file %s" % current_vars_file
1169 # Build dir-specific variables file doesn't exist.
1171 # Make sure the directory is there so we can create it later
1172 opt_dir
= dirname(current_vars_file
)
1173 if not isdir(opt_dir
):
1176 # Get default build variables from source tree. Variables are
1177 # normally determined by name of $VARIANT_DIR, but can be
1178 # overridden by '--default=' arg on command line.
1179 default
= GetOption('default')
1180 opts_dir
= joinpath(main
.root
.abspath
, 'build_opts')
1182 default_vars_files
= [joinpath(build_root
, 'variables', default
),
1183 joinpath(opts_dir
, default
)]
1185 default_vars_files
= [joinpath(opts_dir
, variant_dir
)]
1186 existing_files
= filter(isfile
, default_vars_files
)
1188 default_vars_file
= existing_files
[0]
1189 sticky_vars
.files
.append(default_vars_file
)
1190 print "Variables file %s not found,\n using defaults in %s" \
1191 % (current_vars_file
, default_vars_file
)
1193 print "Error: cannot find variables file %s or " \
1194 "default file(s) %s" \
1195 % (current_vars_file
, ' or '.join(default_vars_files
))
1198 # Apply current variable settings to env
1199 sticky_vars
.Update(env
)
1201 help_texts
["local_vars"] += \
1202 "Build variables for %s:\n" % variant_dir \
1203 + sticky_vars
.GenerateHelpText(env
)
1205 # Process variable settings.
1207 if not have_fenv
and env
['USE_FENV']:
1208 print "Warning: <fenv.h> not available; " \
1209 "forcing USE_FENV to False in", variant_dir
+ "."
1210 env
['USE_FENV'] = False
1212 if not env
['USE_FENV']:
1213 print "Warning: No IEEE FP rounding mode control in", variant_dir
+ "."
1214 print " FP results may deviate slightly from other platforms."
1217 env
.Append(LIBS
=['efence'])
1221 print "Warning: Can not enable KVM, host seems to lack KVM support"
1222 env
['USE_KVM'] = False
1223 elif not is_isa_kvm_compatible(env
['TARGET_ISA']):
1224 print "Info: KVM support disabled due to unsupported host and " \
1225 "target ISA combination"
1226 env
['USE_KVM'] = False
1228 # Save sticky variable settings back to current variables file
1229 sticky_vars
.Save(current_vars_file
, env
)
1232 env
.Append(CCFLAGS
=['-msse2'])
1234 # The src/SConscript file sets up the build rules in 'env' according
1235 # to the configured variables. It returns a list of environments,
1236 # one for each variant build (debug, opt, etc.)
1237 envList
= SConscript('src/SConscript', variant_dir
= variant_path
,
1240 # Set up the regression tests for each build.
1242 SConscript('tests/SConscript',
1243 variant_dir
= joinpath(variant_path
, 'tests', e
.Label
),
1244 exports
= { 'env' : e
}, duplicate
= False)
1248 Usage: scons [scons options] [build variables] [target(s)]
1250 Extra scons options:
1253 Global build variables: