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 ('m5'), 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_FS/m5.opt' for
41 # the optimized full-system version).
43 # You can build M5 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>/m5 ; scons build/ALPHA_FS/m5.debug
53 # % cd <path-to-src>/m5/build/ALPHA_FS; scons -u m5.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>/m5 ; scons /local/foo/build/ALPHA_FS/m5.debug
60 # % cd /local/foo/build/ALPHA_FS; scons -C <path-to-src>/m5 m5.debug
62 # You can use 'scons -H' to print scons options. If you're in this
63 # 'm5' directory (or use -u or -C to tell scons where to find this
64 # file), you can use 'scons -h' to print all the M5-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://m5sim.org/wiki/index.php/Compiling_M5
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://m5sim.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
, # M5 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
132 def AddM5Option(*args
, **kwargs
):
135 help = " " + ", ".join(args
)
138 if length
>= col_width
:
139 help += "\n" + " " * col_width
141 help += " " * (col_width
- length
)
142 help += kwargs
["help"]
143 help_texts
["options"] += help + "\n"
145 AddOption(*args
, **kwargs
)
147 AddM5Option('--colors', dest
='use_colors', action
='store_true',
148 help="Add color to abbreviated scons output")
149 AddM5Option('--no-colors', dest
='use_colors', action
='store_false',
150 help="Don't add color to abbreviated scons output")
151 AddM5Option('--default', dest
='default', type='string', action
='store',
152 help='Override which build_opts file to use for defaults')
153 AddM5Option('--ignore-style', dest
='ignore_style', action
='store_true',
154 help='Disable style checking hooks')
155 AddM5Option('--update-ref', dest
='update_ref', action
='store_true',
156 help='Update test reference outputs')
157 AddM5Option('--verbose', dest
='verbose', action
='store_true',
158 help='Print full tool command lines')
160 use_colors
= GetOption('use_colors')
162 from m5
.util
.terminal
import termcap
163 elif use_colors
is None:
164 # option unspecified; default behavior is to use colors iff isatty
165 from m5
.util
.terminal
import tty_termcap
as termcap
167 from m5
.util
.terminal
import no_termcap
as termcap
169 ########################################################################
171 # Set up the main build environment.
173 ########################################################################
174 use_vars
= set([ 'AS', 'AR', 'CC', 'CXX', 'HOME', 'LD_LIBRARY_PATH', 'PATH',
175 'PYTHONPATH', 'RANLIB' ])
178 for key
,val
in os
.environ
.iteritems():
179 if key
in use_vars
or key
.startswith("M5"):
182 main
= Environment(ENV
=use_env
)
183 main
.root
= Dir(".") # The current directory (where this file lives).
184 main
.srcdir
= Dir("src") # The source directory
186 # add useful python code PYTHONPATH so it can be used by subprocesses
188 main
.AppendENVPath('PYTHONPATH', extra_python_paths
)
190 ########################################################################
194 # If the M5 directory is a mercurial repository, we should do some
197 ########################################################################
199 hgdir
= main
.root
.Dir(".hg")
201 mercurial_style_message
= """
202 You're missing the M5 style hook.
203 Please install the hook so we can ensure that all code fits a common style.
205 All you'd need to do is add the following lines to your repository .hg/hgrc
206 or your personal .hgrc
210 style = %s/util/style.py
213 pretxncommit.style = python:style.check_style
214 pre-qrefresh.style = python:style.check_style
217 mercurial_bin_not_found
= """
218 Mercurial binary cannot be found, unfortunately this means that we
219 cannot easily determine the version of M5 that you are running and
220 this makes error messages more difficult to collect. Please consider
221 installing mercurial if you choose to post an error message
224 mercurial_lib_not_found
= """
225 Mercurial libraries cannot be found, ignoring style hook
226 If you are actually a M5 developer, please fix this and
227 run the style hook. It is important.
231 # Ensure that the style hook is in place.
234 if not GetOption('ignore_style'):
235 from mercurial
import ui
238 print mercurial_lib_not_found
241 ui
.readconfig(hgdir
.File('hgrc').abspath
)
242 style_hook
= ui
.config('hooks', 'pretxncommit.style', None)
245 print mercurial_style_message
248 print ".hg directory not found"
250 ###################################################
252 # Figure out which configurations to set up based on the path(s) of
255 ###################################################
257 # Find default configuration & binary.
258 Default(environ
.get('M5_DEFAULT_BINARY', 'build/ALPHA_SE/m5.debug'))
260 # helper function: find last occurrence of element in list
261 def rfind(l
, elt
, offs
= -1):
262 for i
in range(len(l
)+offs
, 0, -1):
265 raise ValueError, "element not found"
267 # Take a list of paths (or SCons Nodes) and return a list with all
268 # paths made absolute and ~-expanded. Paths will be interpreted
269 # relative to the launch directory unless a different root is provided
270 def makePathListAbsolute(path_list
, root
=GetLaunchDir()):
271 return [abspath(joinpath(root
, expanduser(str(p
))))
274 # Each target must have 'build' in the interior of the path; the
275 # directory below this will determine the build parameters. For
276 # example, for target 'foo/bar/build/ALPHA_SE/arch/alpha/blah.do' we
277 # recognize that ALPHA_SE specifies the configuration because it
278 # follow 'build' in the build path.
280 # The funky assignment to "[:]" is needed to replace the list contents
281 # in place rather than reassign the symbol to a new list, which
282 # doesn't work (obviously!).
283 BUILD_TARGETS
[:] = makePathListAbsolute(BUILD_TARGETS
)
285 # Generate a list of the unique build roots and configs that the
286 # collected targets reference.
289 for t
in BUILD_TARGETS
:
290 path_dirs
= t
.split('/')
292 build_top
= rfind(path_dirs
, 'build', -2)
294 print "Error: no non-leaf 'build' dir found on target path", t
296 this_build_root
= joinpath('/',*path_dirs
[:build_top
+1])
298 build_root
= this_build_root
300 if this_build_root
!= build_root
:
301 print "Error: build targets not under same build root\n"\
302 " %s\n %s" % (build_root
, this_build_root
)
304 variant_path
= joinpath('/',*path_dirs
[:build_top
+2])
305 if variant_path
not in variant_paths
:
306 variant_paths
.append(variant_path
)
308 # Make sure build_root exists (might not if this is the first build there)
309 if not isdir(build_root
):
311 main
['BUILDROOT'] = build_root
315 main
.SConsignFile(joinpath(build_root
, "sconsign"))
317 # Default duplicate option is to use hard links, but this messes up
318 # when you use emacs to edit a file in the target dir, as emacs moves
319 # file to file~ then copies to file, breaking the link. Symbolic
320 # (soft) links work better.
321 main
.SetOption('duplicate', 'soft-copy')
324 # Set up global sticky variables... these are common to an entire build
325 # tree (not specific to a particular build like ALPHA_SE)
328 global_vars_file
= joinpath(build_root
, 'variables.global')
330 global_vars
= Variables(global_vars_file
, args
=ARGUMENTS
)
332 global_vars
.AddVariables(
333 ('CC', 'C compiler', environ
.get('CC', main
['CC'])),
334 ('CXX', 'C++ compiler', environ
.get('CXX', main
['CXX'])),
335 ('BATCH', 'Use batch pool for build and tests', False),
336 ('BATCH_CMD', 'Batch pool submission command name', 'qdo'),
337 ('M5_BUILD_CACHE', 'Cache built objects in this directory', False),
338 ('EXTRAS', 'Add extra directories to the compilation', '')
341 # Update main environment with values from ARGUMENTS & global_vars_file
342 global_vars
.Update(main
)
343 help_texts
["global_vars"] += global_vars
.GenerateHelpText(main
)
345 # Save sticky variable settings back to current variables file
346 global_vars
.Save(global_vars_file
, main
)
348 # Parse EXTRAS variable to build list of all directories where we're
349 # look for sources etc. This list is exported as extras_dir_list.
350 base_dir
= main
.srcdir
.abspath
352 extras_dir_list
= makePathListAbsolute(main
['EXTRAS'].split(':'))
357 Export('extras_dir_list')
359 # the ext directory should be on the #includes path
360 main
.Append(CPPPATH
=[Dir('ext')])
362 def strip_build_path(path
, env
):
364 variant_base
= env
['BUILDROOT'] + os
.path
.sep
365 if path
.startswith(variant_base
):
366 path
= path
[len(variant_base
):]
367 elif path
.startswith('build/'):
371 # Generate a string of the form:
372 # common/path/prefix/src1, src2 -> tgt1, tgt2
373 # to print while building.
374 class Transform(object):
375 # all specific color settings should be here and nowhere else
376 tool_color
= termcap
.Normal
377 pfx_color
= termcap
.Yellow
378 srcs_color
= termcap
.Yellow
+ termcap
.Bold
379 arrow_color
= termcap
.Blue
+ termcap
.Bold
380 tgts_color
= termcap
.Yellow
+ termcap
.Bold
382 def __init__(self
, tool
, max_sources
=99):
383 self
.format
= self
.tool_color
+ (" [%8s] " % tool
) \
384 + self
.pfx_color
+ "%s" \
385 + self
.srcs_color
+ "%s" \
386 + self
.arrow_color
+ " -> " \
387 + self
.tgts_color
+ "%s" \
389 self
.max_sources
= max_sources
391 def __call__(self
, target
, source
, env
, for_signature
=None):
392 # truncate source list according to max_sources param
393 source
= source
[0:self
.max_sources
]
395 return strip_build_path(str(f
), env
)
397 srcs
= map(strip
, source
)
400 tgts
= map(strip
, target
)
401 # surprisingly, os.path.commonprefix is a dumb char-by-char string
402 # operation that has nothing to do with paths.
403 com_pfx
= os
.path
.commonprefix(srcs
+ tgts
)
404 com_pfx_len
= len(com_pfx
)
406 # do some cleanup and sanity checking on common prefix
407 if com_pfx
[-1] == ".":
408 # prefix matches all but file extension: ok
409 # back up one to change 'foo.cc -> o' to 'foo.cc -> .o'
410 com_pfx
= com_pfx
[0:-1]
411 elif com_pfx
[-1] == "/":
412 # common prefix is directory path: OK
415 src0_len
= len(srcs
[0])
416 tgt0_len
= len(tgts
[0])
417 if src0_len
== com_pfx_len
:
418 # source is a substring of target, OK
420 elif tgt0_len
== com_pfx_len
:
421 # target is a substring of source, need to back up to
422 # avoid empty string on RHS of arrow
423 sep_idx
= com_pfx
.rfind(".")
425 com_pfx
= com_pfx
[0:sep_idx
]
428 elif src0_len
> com_pfx_len
and srcs
[0][com_pfx_len
] == ".":
429 # still splitting at file extension: ok
432 # probably a fluke; ignore it
434 # recalculate length in case com_pfx was modified
435 com_pfx_len
= len(com_pfx
)
437 f
= map(lambda s
: s
[com_pfx_len
:], files
)
439 return self
.format
% (com_pfx
, fmt(srcs
), fmt(tgts
))
444 if GetOption('verbose'):
445 def MakeAction(action
, string
, *args
, **kwargs
):
446 return Action(action
, *args
, **kwargs
)
449 main
['CCCOMSTR'] = Transform("CC")
450 main
['CXXCOMSTR'] = Transform("CXX")
451 main
['ASCOMSTR'] = Transform("AS")
452 main
['SWIGCOMSTR'] = Transform("SWIG")
453 main
['ARCOMSTR'] = Transform("AR", 0)
454 main
['LINKCOMSTR'] = Transform("LINK", 0)
455 main
['RANLIBCOMSTR'] = Transform("RANLIB", 0)
456 main
['M4COMSTR'] = Transform("M4")
457 main
['SHCCCOMSTR'] = Transform("SHCC")
458 main
['SHCXXCOMSTR'] = Transform("SHCXX")
461 CXX_version
= readCommand([main
['CXX'],'--version'], exception
=False)
462 CXX_V
= readCommand([main
['CXX'],'-V'], exception
=False)
464 main
['GCC'] = CXX_version
and CXX_version
.find('g++') >= 0
465 main
['SUNCC'] = CXX_V
and CXX_V
.find('Sun C++') >= 0
466 main
['ICC'] = CXX_V
and CXX_V
.find('Intel') >= 0
467 if main
['GCC'] + main
['SUNCC'] + main
['ICC'] > 1:
468 print 'Error: How can we have two at the same time?'
471 # Set up default C++ compiler flags
473 main
.Append(CCFLAGS
=['-pipe'])
474 main
.Append(CCFLAGS
=['-fno-strict-aliasing'])
475 main
.Append(CCFLAGS
=['-Wall', '-Wno-sign-compare', '-Wundef'])
476 main
.Append(CXXFLAGS
=['-Wno-deprecated'])
477 # Read the GCC version to check for versions with bugs
478 # Note CCVERSION doesn't work here because it is run with the CC
479 # before we override it from the command line
480 gcc_version
= readCommand([main
['CXX'], '-dumpversion'], exception
=False)
481 if not compareVersions(gcc_version
, '4.4.1') or \
482 not compareVersions(gcc_version
, '4.4.2'):
483 print 'Info: Tree vectorizer in GCC 4.4.1 & 4.4.2 is buggy, disabling.'
484 main
.Append(CCFLAGS
=['-fno-tree-vectorize'])
486 pass #Fix me... add warning flags once we clean up icc warnings
488 main
.Append(CCFLAGS
=['-Qoption ccfe'])
489 main
.Append(CCFLAGS
=['-features=gcc'])
490 main
.Append(CCFLAGS
=['-features=extensions'])
491 main
.Append(CCFLAGS
=['-library=stlport4'])
492 main
.Append(CCFLAGS
=['-xar'])
493 #main.Append(CCFLAGS=['-instances=semiexplicit'])
495 print 'Error: Don\'t know what compiler options to use for your compiler.'
496 print ' Please fix SConstruct and src/SConscript and try again.'
499 # Set up common yacc/bison flags (needed for Ruby)
500 main
['YACCFLAGS'] = '-d'
501 main
['YACCHXXFILESUFFIX'] = '.hh'
503 # Do this after we save setting back, or else we'll tack on an
504 # extra 'qdo' every time we run scons.
506 main
['CC'] = main
['BATCH_CMD'] + ' ' + main
['CC']
507 main
['CXX'] = main
['BATCH_CMD'] + ' ' + main
['CXX']
508 main
['AS'] = main
['BATCH_CMD'] + ' ' + main
['AS']
509 main
['AR'] = main
['BATCH_CMD'] + ' ' + main
['AR']
510 main
['RANLIB'] = main
['BATCH_CMD'] + ' ' + main
['RANLIB']
512 if sys
.platform
== 'cygwin':
513 # cygwin has some header file issues...
514 main
.Append(CCFLAGS
=["-Wno-uninitialized"])
517 if not main
.has_key('SWIG'):
518 print 'Error: SWIG utility not found.'
519 print ' Please install (see http://www.swig.org) and retry.'
522 # Check for appropriate SWIG version
523 swig_version
= readCommand(('swig', '-version'), exception
='').split()
524 # First 3 words should be "SWIG Version x.y.z"
525 if len(swig_version
) < 3 or \
526 swig_version
[0] != 'SWIG' or swig_version
[1] != 'Version':
527 print 'Error determining SWIG version.'
530 min_swig_version
= '1.3.28'
531 if compareVersions(swig_version
[2], min_swig_version
) < 0:
532 print 'Error: SWIG version', min_swig_version
, 'or newer required.'
533 print ' Installed version:', swig_version
[2]
536 # Set up SWIG flags & scanner
537 swig_flags
=Split('-c++ -python -modern -templatereduce $_CPPINCFLAGS')
538 main
.Append(SWIGFLAGS
=swig_flags
)
540 # filter out all existing swig scanners, they mess up the dependency
541 # stuff for some reason
543 for scanner
in main
['SCANNERS']:
544 skeys
= scanner
.skeys
548 if isinstance(skeys
, (list, tuple)) and '.i' in skeys
:
551 scanners
.append(scanner
)
553 # add the new swig scanner that we like better
554 from SCons
.Scanner
import ClassicCPP
as CPPScanner
555 swig_inc_re
= '^[ \t]*[%,#][ \t]*(?:include|import)[ \t]*(<|")([^>"]+)(>|")'
556 scanners
.append(CPPScanner("SwigScan", [ ".i" ], "CPPPATH", swig_inc_re
))
558 # replace the scanners list that has what we want
559 main
['SCANNERS'] = scanners
561 # Add a custom Check function to the Configure context so that we can
562 # figure out if the compiler adds leading underscores to global
563 # variables. This is needed for the autogenerated asm files that we
564 # use for embedding the python code.
565 def CheckLeading(context
):
566 context
.Message("Checking for leading underscore in global variables...")
567 # 1) Define a global variable called x from asm so the C compiler
568 # won't change the symbol at all.
569 # 2) Declare that variable.
570 # 3) Use the variable
572 # If the compiler prepends an underscore, this will successfully
573 # link because the external symbol 'x' will be called '_x' which
574 # was defined by the asm statement. If the compiler does not
575 # prepend an underscore, this will not successfully link because
576 # '_x' will have been defined by assembly, while the C portion of
577 # the code will be trying to use 'x'
578 ret
= context
.TryLink('''
579 asm(".globl _x; _x: .byte 0");
581 int main() { return x; }
583 context
.env
.Append(LEADING_UNDERSCORE
=ret
)
587 # Platform-specific configuration. Note again that we assume that all
588 # builds under a given build root run on the same host platform.
589 conf
= Configure(main
,
590 conf_dir
= joinpath(build_root
, '.scons_config'),
591 log_file
= joinpath(build_root
, 'scons_config.log'),
592 custom_tests
= { 'CheckLeading' : CheckLeading
})
594 # Check for leading underscores. Don't really need to worry either
595 # way so don't need to check the return code.
598 # Check if we should compile a 64 bit binary on Mac OS X/Darwin
601 uname
= platform
.uname()
602 if uname
[0] == 'Darwin' and compareVersions(uname
[2], '9.0.0') >= 0:
603 if int(readCommand('sysctl -n hw.cpu64bit_capable')[0]):
604 main
.Append(CCFLAGS
=['-arch', 'x86_64'])
605 main
.Append(CFLAGS
=['-arch', 'x86_64'])
606 main
.Append(LINKFLAGS
=['-arch', 'x86_64'])
607 main
.Append(ASFLAGS
=['-arch', 'x86_64'])
611 # Recent versions of scons substitute a "Null" object for Configure()
612 # when configuration isn't necessary, e.g., if the "--help" option is
613 # present. Unfortuantely this Null object always returns false,
614 # breaking all our configuration checks. We replace it with our own
615 # more optimistic null object that returns True instead.
617 def NullCheck(*args
, **kwargs
):
621 def __init__(self
, env
):
625 def __getattr__(self
, mname
):
628 conf
= NullConf(main
)
630 # Find Python include and library directories for embedding the
631 # interpreter. For consistency, we will use the same Python
632 # installation used to run scons (and thus this script). If you want
633 # to link in an alternate version, see above for instructions on how
634 # to invoke scons with a different copy of the Python interpreter.
635 from distutils
import sysconfig
637 py_getvar
= sysconfig
.get_config_var
639 py_debug
= getattr(sys
, 'pydebug', False)
640 py_version
= 'python' + py_getvar('VERSION') + (py_debug
and "_d" or "")
642 py_general_include
= sysconfig
.get_python_inc()
643 py_platform_include
= sysconfig
.get_python_inc(plat_specific
=True)
644 py_includes
= [ py_general_include
]
645 if py_platform_include
!= py_general_include
:
646 py_includes
.append(py_platform_include
)
648 py_lib_path
= [ py_getvar('LIBDIR') ]
649 # add the prefix/lib/pythonX.Y/config dir, but only if there is no
650 # shared library in prefix/lib/.
651 if not py_getvar('Py_ENABLE_SHARED'):
652 py_lib_path
.append(py_getvar('LIBPL'))
655 for lib
in py_getvar('LIBS').split() + py_getvar('SYSLIBS').split():
656 assert lib
.startswith('-l')
658 if lib
not in py_libs
:
660 py_libs
.append(py_version
)
662 main
.Append(CPPPATH
=py_includes
)
663 main
.Append(LIBPATH
=py_lib_path
)
665 # Cache build files in the supplied directory.
666 if main
['M5_BUILD_CACHE']:
667 print 'Using build cache located at', main
['M5_BUILD_CACHE']
668 CacheDir(main
['M5_BUILD_CACHE'])
671 # verify that this stuff works
672 if not conf
.CheckHeader('Python.h', '<>'):
673 print "Error: can't find Python.h header in", py_includes
677 if not conf
.CheckLib(lib
):
678 print "Error: can't find library %s required by python" % lib
681 # On Solaris you need to use libsocket for socket ops
682 if not conf
.CheckLibWithHeader(None, 'sys/socket.h', 'C++', 'accept(0,0,0);'):
683 if not conf
.CheckLibWithHeader('socket', 'sys/socket.h', 'C++', 'accept(0,0,0);'):
684 print "Can't find library with socket calls (e.g. accept())"
687 # Check for zlib. If the check passes, libz will be automatically
688 # added to the LIBS environment variable.
689 if not conf
.CheckLibWithHeader('z', 'zlib.h', 'C++','zlibVersion();'):
690 print 'Error: did not find needed zlib compression library '\
691 'and/or zlib.h header file.'
692 print ' Please install zlib and try again.'
697 conf
.CheckLibWithHeader(None, 'time.h', 'C',
698 'clock_nanosleep(0,0,NULL,NULL);') or \
699 conf
.CheckLibWithHeader('rt', 'time.h', 'C',
700 'clock_nanosleep(0,0,NULL,NULL);')
702 if not have_posix_clock
:
703 print "Can't find library for POSIX clocks."
705 # Check for <fenv.h> (C99 FP environment control)
706 have_fenv
= conf
.CheckHeader('fenv.h', '<>')
708 print "Warning: Header file <fenv.h> not found."
709 print " This host has no IEEE FP rounding mode control."
711 ######################################################################
713 # Finish the configuration
717 ######################################################################
719 # Collect all non-global variables
722 # Define the universe of supported ISAs
724 Export('all_isa_list')
726 class CpuModel(object):
727 '''The CpuModel class encapsulates everything the ISA parser needs to
728 know about a particular CPU model.'''
730 # Dict of available CPU model objects. Accessible as CpuModel.dict.
735 # Constructor. Automatically adds models to CpuModel.dict.
736 def __init__(self
, name
, filename
, includes
, strings
, default
=False):
737 self
.name
= name
# name of model
738 self
.filename
= filename
# filename for output exec code
739 self
.includes
= includes
# include files needed in exec file
740 # The 'strings' dict holds all the per-CPU symbols we can
741 # substitute into templates etc.
742 self
.strings
= strings
744 # This cpu is enabled by default
745 self
.default
= default
748 if name
in CpuModel
.dict:
749 raise AttributeError, "CpuModel '%s' already registered" % name
750 CpuModel
.dict[name
] = self
751 CpuModel
.list.append(name
)
755 # Sticky variables get saved in the variables file so they persist from
756 # one invocation to the next (unless overridden, in which case the new
757 # value becomes sticky).
758 sticky_vars
= Variables(args
=ARGUMENTS
)
759 Export('sticky_vars')
761 # Sticky variables that should be exported
763 Export('export_vars')
765 # Walk the tree and execute all SConsopts scripts that wil add to the
767 for bdir
in [ base_dir
] + extras_dir_list
:
769 print "Error: directory '%s' does not exist" % bdir
771 for root
, dirs
, files
in os
.walk(bdir
):
772 if 'SConsopts' in files
:
773 print "Reading", joinpath(root
, 'SConsopts')
774 SConscript(joinpath(root
, 'SConsopts'))
778 sticky_vars
.AddVariables(
779 EnumVariable('TARGET_ISA', 'Target ISA', 'alpha', all_isa_list
),
780 BoolVariable('FULL_SYSTEM', 'Full-system support', False),
781 ListVariable('CPU_MODELS', 'CPU models',
782 sorted(n
for n
,m
in CpuModel
.dict.iteritems() if m
.default
),
783 sorted(CpuModel
.list)),
784 BoolVariable('NO_FAST_ALLOC', 'Disable fast object allocator', False),
785 BoolVariable('FORCE_FAST_ALLOC',
786 'Enable fast object allocator, even for m5.debug', False),
787 BoolVariable('FAST_ALLOC_STATS', 'Enable fast object allocator statistics',
789 BoolVariable('EFENCE', 'Link with Electric Fence malloc debugger',
791 BoolVariable('SS_COMPATIBLE_FP',
792 'Make floating-point results compatible with SimpleScalar',
794 BoolVariable('USE_SSE2',
795 'Compile for SSE2 (-msse2) to get IEEE FP on x86 hosts',
797 BoolVariable('USE_POSIX_CLOCK', 'Use POSIX Clocks', have_posix_clock
),
798 BoolVariable('USE_FENV', 'Use <fenv.h> IEEE mode control', have_fenv
),
799 BoolVariable('USE_CHECKER', 'Use checker for detailed CPU models', False),
800 BoolVariable('CP_ANNOTATE', 'Enable critical path annotation capability', False),
801 BoolVariable('RUBY', 'Build with Ruby', False),
804 # These variables get exported to #defines in config/*.hh (see src/SConscript).
805 export_vars
+= ['FULL_SYSTEM', 'USE_FENV',
806 'NO_FAST_ALLOC', 'FORCE_FAST_ALLOC', 'FAST_ALLOC_STATS',
807 'SS_COMPATIBLE_FP', 'USE_CHECKER', 'TARGET_ISA', 'CP_ANNOTATE',
810 ###################################################
812 # Define a SCons builder for configuration flag headers.
814 ###################################################
816 # This function generates a config header file that #defines the
817 # variable symbol to the current variable setting (0 or 1). The source
818 # operands are the name of the variable and a Value node containing the
819 # value of the variable.
820 def build_config_file(target
, source
, env
):
821 (variable
, value
) = [s
.get_contents() for s
in source
]
822 f
= file(str(target
[0]), 'w')
823 print >> f
, '#define', variable
, value
827 # Generate the message to be printed when building the config file.
828 def build_config_file_string(target
, source
, env
):
829 (variable
, value
) = [s
.get_contents() for s
in source
]
830 return "Defining %s as %s in %s." % (variable
, value
, target
[0])
832 # Combine the two functions into a scons Action object.
833 config_action
= Action(build_config_file
, build_config_file_string
)
835 # The emitter munges the source & target node lists to reflect what
836 # we're really doing.
837 def config_emitter(target
, source
, env
):
838 # extract variable name from Builder arg
839 variable
= str(target
[0])
840 # True target is config header file
841 target
= joinpath('config', variable
.lower() + '.hh')
843 if isinstance(val
, bool):
846 elif isinstance(val
, str):
847 val
= '"' + val
+ '"'
849 # Sources are variable name & value (packaged in SCons Value nodes)
850 return ([target
], [Value(variable
), Value(val
)])
852 config_builder
= Builder(emitter
= config_emitter
, action
= config_action
)
854 main
.Append(BUILDERS
= { 'ConfigFile' : config_builder
})
856 # libelf build is shared across all configs in the build root.
857 main
.SConscript('ext/libelf/SConscript',
858 variant_dir
= joinpath(build_root
, 'libelf'))
860 # gzstream build is shared across all configs in the build root.
861 main
.SConscript('ext/gzstream/SConscript',
862 variant_dir
= joinpath(build_root
, 'gzstream'))
864 ###################################################
866 # This function is used to set up a directory with switching headers
868 ###################################################
870 main
['ALL_ISA_LIST'] = all_isa_list
871 def make_switching_dir(dname
, switch_headers
, env
):
872 # Generate the header. target[0] is the full path of the output
873 # header to generate. 'source' is a dummy variable, since we get the
874 # list of ISAs from env['ALL_ISA_LIST'].
875 def gen_switch_hdr(target
, source
, env
):
876 fname
= str(target
[0])
878 isa
= env
['TARGET_ISA'].lower()
879 print >>f
, '#include "%s/%s/%s"' % (dname
, isa
, basename(fname
))
882 # Build SCons Action object. 'varlist' specifies env vars that this
883 # action depends on; when env['ALL_ISA_LIST'] changes these actions
884 # should get re-executed.
885 switch_hdr_action
= MakeAction(gen_switch_hdr
,
886 Transform("GENERATE"), varlist
=['ALL_ISA_LIST'])
888 # Instantiate actions for each header
889 for hdr
in switch_headers
:
890 env
.Command(hdr
, [], switch_hdr_action
)
891 Export('make_switching_dir')
893 ###################################################
895 # Define build environments for selected configurations.
897 ###################################################
899 for variant_path
in variant_paths
:
900 print "Building in", variant_path
902 # Make a copy of the build-root environment to use for this config.
904 env
['BUILDDIR'] = variant_path
906 # variant_dir is the tail component of build path, and is used to
907 # determine the build parameters (e.g., 'ALPHA_SE')
908 (build_root
, variant_dir
) = splitpath(variant_path
)
910 # Set env variables according to the build directory config.
911 sticky_vars
.files
= []
912 # Variables for $BUILD_ROOT/$VARIANT_DIR are stored in
913 # $BUILD_ROOT/variables/$VARIANT_DIR so you can nuke
914 # $BUILD_ROOT/$VARIANT_DIR without losing your variables settings.
915 current_vars_file
= joinpath(build_root
, 'variables', variant_dir
)
916 if isfile(current_vars_file
):
917 sticky_vars
.files
.append(current_vars_file
)
918 print "Using saved variables file %s" % current_vars_file
920 # Build dir-specific variables file doesn't exist.
922 # Make sure the directory is there so we can create it later
923 opt_dir
= dirname(current_vars_file
)
924 if not isdir(opt_dir
):
927 # Get default build variables from source tree. Variables are
928 # normally determined by name of $VARIANT_DIR, but can be
929 # overridden by '--default=' arg on command line.
930 default
= GetOption('default')
931 opts_dir
= joinpath(main
.root
.abspath
, 'build_opts')
933 default_vars_files
= [joinpath(build_root
, 'variables', default
),
934 joinpath(opts_dir
, default
)]
936 default_vars_files
= [joinpath(opts_dir
, variant_dir
)]
937 existing_files
= filter(isfile
, default_vars_files
)
939 default_vars_file
= existing_files
[0]
940 sticky_vars
.files
.append(default_vars_file
)
941 print "Variables file %s not found,\n using defaults in %s" \
942 % (current_vars_file
, default_vars_file
)
944 print "Error: cannot find variables file %s or " \
945 "default file(s) %s" \
946 % (current_vars_file
, ' or '.join(default_vars_files
))
949 # Apply current variable settings to env
950 sticky_vars
.Update(env
)
952 help_texts
["local_vars"] += \
953 "Build variables for %s:\n" % variant_dir \
954 + sticky_vars
.GenerateHelpText(env
)
956 # Process variable settings.
958 if not have_fenv
and env
['USE_FENV']:
959 print "Warning: <fenv.h> not available; " \
960 "forcing USE_FENV to False in", variant_dir
+ "."
961 env
['USE_FENV'] = False
963 if not env
['USE_FENV']:
964 print "Warning: No IEEE FP rounding mode control in", variant_dir
+ "."
965 print " FP results may deviate slightly from other platforms."
968 env
.Append(LIBS
=['efence'])
970 # Save sticky variable settings back to current variables file
971 sticky_vars
.Save(current_vars_file
, env
)
974 env
.Append(CCFLAGS
=['-msse2'])
976 # The src/SConscript file sets up the build rules in 'env' according
977 # to the configured variables. It returns a list of environments,
978 # one for each variant build (debug, opt, etc.)
979 envList
= SConscript('src/SConscript', variant_dir
= variant_path
,
982 # Set up the regression tests for each build.
984 SConscript('tests/SConscript',
985 variant_dir
= joinpath(variant_path
, 'tests', e
.Label
),
986 exports
= { 'env' : e
}, duplicate
= False)
990 Usage: scons [scons options] [build variables] [target(s)]
995 Global build variables: