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 gem5 style hook, which automatically checks your code
203 against the gem5 style rules on hg commit and qrefresh commands. This
204 script will now install the hook in your .hg/hgrc file.
205 Press enter to continue, or ctrl-c to abort: """
207 mercurial_style_hook
= """
208 # The following lines were automatically added by gem5/SConstruct
209 # to provide the gem5 style-checking hooks
211 style = %s/util/style.py
214 pretxncommit.style = python:style.check_style
215 pre-qrefresh.style = python:style.check_style
216 # End of SConstruct additions
218 """ % (main
.root
.abspath
)
220 mercurial_lib_not_found
= """
221 Mercurial libraries cannot be found, ignoring style hook. If
222 you are a gem5 developer, please fix this and run the style
223 hook. It is important.
226 # Check for style hook and prompt for installation if it's not there.
227 # Skip this if --ignore-style was specified, there's no .hg dir to
228 # install a hook in, or there's no interactive terminal to prompt.
229 if not GetOption('ignore_style') and hgdir
.exists() and sys
.stdin
.isatty():
232 from mercurial
import ui
234 ui
.readconfig(hgdir
.File('hgrc').abspath
)
235 style_hook
= ui
.config('hooks', 'pretxncommit.style', None) and \
236 ui
.config('hooks', 'pre-qrefresh.style', None)
238 print mercurial_lib_not_found
241 print mercurial_style_message
,
242 # continue unless user does ctrl-c/ctrl-d etc.
246 print "Input exception, exiting scons.\n"
248 hgrc_path
= '%s/.hg/hgrc' % main
.root
.abspath
249 print "Adding style hook to", hgrc_path
, "\n"
251 hgrc
= open(hgrc_path
, 'a')
252 hgrc
.write(mercurial_style_hook
)
255 print "Error updating", hgrc_path
259 ###################################################
261 # Figure out which configurations to set up based on the path(s) of
264 ###################################################
266 # Find default configuration & binary.
267 Default(environ
.get('M5_DEFAULT_BINARY', 'build/ALPHA_SE/m5.debug'))
269 # helper function: find last occurrence of element in list
270 def rfind(l
, elt
, offs
= -1):
271 for i
in range(len(l
)+offs
, 0, -1):
274 raise ValueError, "element not found"
276 # Take a list of paths (or SCons Nodes) and return a list with all
277 # paths made absolute and ~-expanded. Paths will be interpreted
278 # relative to the launch directory unless a different root is provided
279 def makePathListAbsolute(path_list
, root
=GetLaunchDir()):
280 return [abspath(joinpath(root
, expanduser(str(p
))))
283 # Each target must have 'build' in the interior of the path; the
284 # directory below this will determine the build parameters. For
285 # example, for target 'foo/bar/build/ALPHA_SE/arch/alpha/blah.do' we
286 # recognize that ALPHA_SE specifies the configuration because it
287 # follow 'build' in the build path.
289 # The funky assignment to "[:]" is needed to replace the list contents
290 # in place rather than reassign the symbol to a new list, which
291 # doesn't work (obviously!).
292 BUILD_TARGETS
[:] = makePathListAbsolute(BUILD_TARGETS
)
294 # Generate a list of the unique build roots and configs that the
295 # collected targets reference.
298 for t
in BUILD_TARGETS
:
299 path_dirs
= t
.split('/')
301 build_top
= rfind(path_dirs
, 'build', -2)
303 print "Error: no non-leaf 'build' dir found on target path", t
305 this_build_root
= joinpath('/',*path_dirs
[:build_top
+1])
307 build_root
= this_build_root
309 if this_build_root
!= build_root
:
310 print "Error: build targets not under same build root\n"\
311 " %s\n %s" % (build_root
, this_build_root
)
313 variant_path
= joinpath('/',*path_dirs
[:build_top
+2])
314 if variant_path
not in variant_paths
:
315 variant_paths
.append(variant_path
)
317 # Make sure build_root exists (might not if this is the first build there)
318 if not isdir(build_root
):
320 main
['BUILDROOT'] = build_root
324 main
.SConsignFile(joinpath(build_root
, "sconsign"))
326 # Default duplicate option is to use hard links, but this messes up
327 # when you use emacs to edit a file in the target dir, as emacs moves
328 # file to file~ then copies to file, breaking the link. Symbolic
329 # (soft) links work better.
330 main
.SetOption('duplicate', 'soft-copy')
333 # Set up global sticky variables... these are common to an entire build
334 # tree (not specific to a particular build like ALPHA_SE)
337 global_vars_file
= joinpath(build_root
, 'variables.global')
339 global_vars
= Variables(global_vars_file
, args
=ARGUMENTS
)
341 global_vars
.AddVariables(
342 ('CC', 'C compiler', environ
.get('CC', main
['CC'])),
343 ('CXX', 'C++ compiler', environ
.get('CXX', main
['CXX'])),
344 ('BATCH', 'Use batch pool for build and tests', False),
345 ('BATCH_CMD', 'Batch pool submission command name', 'qdo'),
346 ('M5_BUILD_CACHE', 'Cache built objects in this directory', False),
347 ('EXTRAS', 'Add extra directories to the compilation', '')
350 # Update main environment with values from ARGUMENTS & global_vars_file
351 global_vars
.Update(main
)
352 help_texts
["global_vars"] += global_vars
.GenerateHelpText(main
)
354 # Save sticky variable settings back to current variables file
355 global_vars
.Save(global_vars_file
, main
)
357 # Parse EXTRAS variable to build list of all directories where we're
358 # look for sources etc. This list is exported as extras_dir_list.
359 base_dir
= main
.srcdir
.abspath
361 extras_dir_list
= makePathListAbsolute(main
['EXTRAS'].split(':'))
366 Export('extras_dir_list')
368 # the ext directory should be on the #includes path
369 main
.Append(CPPPATH
=[Dir('ext')])
371 def strip_build_path(path
, env
):
373 variant_base
= env
['BUILDROOT'] + os
.path
.sep
374 if path
.startswith(variant_base
):
375 path
= path
[len(variant_base
):]
376 elif path
.startswith('build/'):
380 # Generate a string of the form:
381 # common/path/prefix/src1, src2 -> tgt1, tgt2
382 # to print while building.
383 class Transform(object):
384 # all specific color settings should be here and nowhere else
385 tool_color
= termcap
.Normal
386 pfx_color
= termcap
.Yellow
387 srcs_color
= termcap
.Yellow
+ termcap
.Bold
388 arrow_color
= termcap
.Blue
+ termcap
.Bold
389 tgts_color
= termcap
.Yellow
+ termcap
.Bold
391 def __init__(self
, tool
, max_sources
=99):
392 self
.format
= self
.tool_color
+ (" [%8s] " % tool
) \
393 + self
.pfx_color
+ "%s" \
394 + self
.srcs_color
+ "%s" \
395 + self
.arrow_color
+ " -> " \
396 + self
.tgts_color
+ "%s" \
398 self
.max_sources
= max_sources
400 def __call__(self
, target
, source
, env
, for_signature
=None):
401 # truncate source list according to max_sources param
402 source
= source
[0:self
.max_sources
]
404 return strip_build_path(str(f
), env
)
406 srcs
= map(strip
, source
)
409 tgts
= map(strip
, target
)
410 # surprisingly, os.path.commonprefix is a dumb char-by-char string
411 # operation that has nothing to do with paths.
412 com_pfx
= os
.path
.commonprefix(srcs
+ tgts
)
413 com_pfx_len
= len(com_pfx
)
415 # do some cleanup and sanity checking on common prefix
416 if com_pfx
[-1] == ".":
417 # prefix matches all but file extension: ok
418 # back up one to change 'foo.cc -> o' to 'foo.cc -> .o'
419 com_pfx
= com_pfx
[0:-1]
420 elif com_pfx
[-1] == "/":
421 # common prefix is directory path: OK
424 src0_len
= len(srcs
[0])
425 tgt0_len
= len(tgts
[0])
426 if src0_len
== com_pfx_len
:
427 # source is a substring of target, OK
429 elif tgt0_len
== com_pfx_len
:
430 # target is a substring of source, need to back up to
431 # avoid empty string on RHS of arrow
432 sep_idx
= com_pfx
.rfind(".")
434 com_pfx
= com_pfx
[0:sep_idx
]
437 elif src0_len
> com_pfx_len
and srcs
[0][com_pfx_len
] == ".":
438 # still splitting at file extension: ok
441 # probably a fluke; ignore it
443 # recalculate length in case com_pfx was modified
444 com_pfx_len
= len(com_pfx
)
446 f
= map(lambda s
: s
[com_pfx_len
:], files
)
448 return self
.format
% (com_pfx
, fmt(srcs
), fmt(tgts
))
453 if GetOption('verbose'):
454 def MakeAction(action
, string
, *args
, **kwargs
):
455 return Action(action
, *args
, **kwargs
)
458 main
['CCCOMSTR'] = Transform("CC")
459 main
['CXXCOMSTR'] = Transform("CXX")
460 main
['ASCOMSTR'] = Transform("AS")
461 main
['SWIGCOMSTR'] = Transform("SWIG")
462 main
['ARCOMSTR'] = Transform("AR", 0)
463 main
['LINKCOMSTR'] = Transform("LINK", 0)
464 main
['RANLIBCOMSTR'] = Transform("RANLIB", 0)
465 main
['M4COMSTR'] = Transform("M4")
466 main
['SHCCCOMSTR'] = Transform("SHCC")
467 main
['SHCXXCOMSTR'] = Transform("SHCXX")
470 CXX_version
= readCommand([main
['CXX'],'--version'], exception
=False)
471 CXX_V
= readCommand([main
['CXX'],'-V'], exception
=False)
473 main
['GCC'] = CXX_version
and CXX_version
.find('g++') >= 0
474 main
['SUNCC'] = CXX_V
and CXX_V
.find('Sun C++') >= 0
475 main
['ICC'] = CXX_V
and CXX_V
.find('Intel') >= 0
476 if main
['GCC'] + main
['SUNCC'] + main
['ICC'] > 1:
477 print 'Error: How can we have two at the same time?'
480 # Set up default C++ compiler flags
482 main
.Append(CCFLAGS
=['-pipe'])
483 main
.Append(CCFLAGS
=['-fno-strict-aliasing'])
484 main
.Append(CCFLAGS
=['-Wall', '-Wno-sign-compare', '-Wundef'])
485 main
.Append(CXXFLAGS
=['-Wno-deprecated'])
486 # Read the GCC version to check for versions with bugs
487 # Note CCVERSION doesn't work here because it is run with the CC
488 # before we override it from the command line
489 gcc_version
= readCommand([main
['CXX'], '-dumpversion'], exception
=False)
490 main
['GCC_VERSION'] = gcc_version
491 if not compareVersions(gcc_version
, '4.4.1') or \
492 not compareVersions(gcc_version
, '4.4.2'):
493 print 'Info: Tree vectorizer in GCC 4.4.1 & 4.4.2 is buggy, disabling.'
494 main
.Append(CCFLAGS
=['-fno-tree-vectorize'])
496 pass #Fix me... add warning flags once we clean up icc warnings
498 main
.Append(CCFLAGS
=['-Qoption ccfe'])
499 main
.Append(CCFLAGS
=['-features=gcc'])
500 main
.Append(CCFLAGS
=['-features=extensions'])
501 main
.Append(CCFLAGS
=['-library=stlport4'])
502 main
.Append(CCFLAGS
=['-xar'])
503 #main.Append(CCFLAGS=['-instances=semiexplicit'])
505 print 'Error: Don\'t know what compiler options to use for your compiler.'
506 print ' Please fix SConstruct and src/SConscript and try again.'
509 # Set up common yacc/bison flags (needed for Ruby)
510 main
['YACCFLAGS'] = '-d'
511 main
['YACCHXXFILESUFFIX'] = '.hh'
513 # Do this after we save setting back, or else we'll tack on an
514 # extra 'qdo' every time we run scons.
516 main
['CC'] = main
['BATCH_CMD'] + ' ' + main
['CC']
517 main
['CXX'] = main
['BATCH_CMD'] + ' ' + main
['CXX']
518 main
['AS'] = main
['BATCH_CMD'] + ' ' + main
['AS']
519 main
['AR'] = main
['BATCH_CMD'] + ' ' + main
['AR']
520 main
['RANLIB'] = main
['BATCH_CMD'] + ' ' + main
['RANLIB']
522 if sys
.platform
== 'cygwin':
523 # cygwin has some header file issues...
524 main
.Append(CCFLAGS
=["-Wno-uninitialized"])
527 if not main
.has_key('SWIG'):
528 print 'Error: SWIG utility not found.'
529 print ' Please install (see http://www.swig.org) and retry.'
532 # Check for appropriate SWIG version
533 swig_version
= readCommand(('swig', '-version'), exception
='').split()
534 # First 3 words should be "SWIG Version x.y.z"
535 if len(swig_version
) < 3 or \
536 swig_version
[0] != 'SWIG' or swig_version
[1] != 'Version':
537 print 'Error determining SWIG version.'
540 min_swig_version
= '1.3.28'
541 if compareVersions(swig_version
[2], min_swig_version
) < 0:
542 print 'Error: SWIG version', min_swig_version
, 'or newer required.'
543 print ' Installed version:', swig_version
[2]
546 # Set up SWIG flags & scanner
547 swig_flags
=Split('-c++ -python -modern -templatereduce $_CPPINCFLAGS')
548 main
.Append(SWIGFLAGS
=swig_flags
)
550 # filter out all existing swig scanners, they mess up the dependency
551 # stuff for some reason
553 for scanner
in main
['SCANNERS']:
554 skeys
= scanner
.skeys
558 if isinstance(skeys
, (list, tuple)) and '.i' in skeys
:
561 scanners
.append(scanner
)
563 # add the new swig scanner that we like better
564 from SCons
.Scanner
import ClassicCPP
as CPPScanner
565 swig_inc_re
= '^[ \t]*[%,#][ \t]*(?:include|import)[ \t]*(<|")([^>"]+)(>|")'
566 scanners
.append(CPPScanner("SwigScan", [ ".i" ], "CPPPATH", swig_inc_re
))
568 # replace the scanners list that has what we want
569 main
['SCANNERS'] = scanners
571 # Add a custom Check function to the Configure context so that we can
572 # figure out if the compiler adds leading underscores to global
573 # variables. This is needed for the autogenerated asm files that we
574 # use for embedding the python code.
575 def CheckLeading(context
):
576 context
.Message("Checking for leading underscore in global variables...")
577 # 1) Define a global variable called x from asm so the C compiler
578 # won't change the symbol at all.
579 # 2) Declare that variable.
580 # 3) Use the variable
582 # If the compiler prepends an underscore, this will successfully
583 # link because the external symbol 'x' will be called '_x' which
584 # was defined by the asm statement. If the compiler does not
585 # prepend an underscore, this will not successfully link because
586 # '_x' will have been defined by assembly, while the C portion of
587 # the code will be trying to use 'x'
588 ret
= context
.TryLink('''
589 asm(".globl _x; _x: .byte 0");
591 int main() { return x; }
593 context
.env
.Append(LEADING_UNDERSCORE
=ret
)
597 # Platform-specific configuration. Note again that we assume that all
598 # builds under a given build root run on the same host platform.
599 conf
= Configure(main
,
600 conf_dir
= joinpath(build_root
, '.scons_config'),
601 log_file
= joinpath(build_root
, 'scons_config.log'),
602 custom_tests
= { 'CheckLeading' : CheckLeading
})
604 # Check for leading underscores. Don't really need to worry either
605 # way so don't need to check the return code.
608 # Check if we should compile a 64 bit binary on Mac OS X/Darwin
611 uname
= platform
.uname()
612 if uname
[0] == 'Darwin' and compareVersions(uname
[2], '9.0.0') >= 0:
613 if int(readCommand('sysctl -n hw.cpu64bit_capable')[0]):
614 main
.Append(CCFLAGS
=['-arch', 'x86_64'])
615 main
.Append(CFLAGS
=['-arch', 'x86_64'])
616 main
.Append(LINKFLAGS
=['-arch', 'x86_64'])
617 main
.Append(ASFLAGS
=['-arch', 'x86_64'])
621 # Recent versions of scons substitute a "Null" object for Configure()
622 # when configuration isn't necessary, e.g., if the "--help" option is
623 # present. Unfortuantely this Null object always returns false,
624 # breaking all our configuration checks. We replace it with our own
625 # more optimistic null object that returns True instead.
627 def NullCheck(*args
, **kwargs
):
631 def __init__(self
, env
):
635 def __getattr__(self
, mname
):
638 conf
= NullConf(main
)
640 # Find Python include and library directories for embedding the
641 # interpreter. For consistency, we will use the same Python
642 # installation used to run scons (and thus this script). If you want
643 # to link in an alternate version, see above for instructions on how
644 # to invoke scons with a different copy of the Python interpreter.
645 from distutils
import sysconfig
647 py_getvar
= sysconfig
.get_config_var
649 py_debug
= getattr(sys
, 'pydebug', False)
650 py_version
= 'python' + py_getvar('VERSION') + (py_debug
and "_d" or "")
652 py_general_include
= sysconfig
.get_python_inc()
653 py_platform_include
= sysconfig
.get_python_inc(plat_specific
=True)
654 py_includes
= [ py_general_include
]
655 if py_platform_include
!= py_general_include
:
656 py_includes
.append(py_platform_include
)
658 py_lib_path
= [ py_getvar('LIBDIR') ]
659 # add the prefix/lib/pythonX.Y/config dir, but only if there is no
660 # shared library in prefix/lib/.
661 if not py_getvar('Py_ENABLE_SHARED'):
662 py_lib_path
.append(py_getvar('LIBPL'))
665 for lib
in py_getvar('LIBS').split() + py_getvar('SYSLIBS').split():
666 if not lib
.startswith('-l'):
667 # Python requires some special flags to link (e.g. -framework
668 # common on OS X systems), assume appending preserves order
669 main
.Append(LINKFLAGS
=[lib
])
672 if lib
not in py_libs
:
674 py_libs
.append(py_version
)
676 main
.Append(CPPPATH
=py_includes
)
677 main
.Append(LIBPATH
=py_lib_path
)
679 # Cache build files in the supplied directory.
680 if main
['M5_BUILD_CACHE']:
681 print 'Using build cache located at', main
['M5_BUILD_CACHE']
682 CacheDir(main
['M5_BUILD_CACHE'])
685 # verify that this stuff works
686 if not conf
.CheckHeader('Python.h', '<>'):
687 print "Error: can't find Python.h header in", py_includes
691 if not conf
.CheckLib(lib
):
692 print "Error: can't find library %s required by python" % lib
695 # On Solaris you need to use libsocket for socket ops
696 if not conf
.CheckLibWithHeader(None, 'sys/socket.h', 'C++', 'accept(0,0,0);'):
697 if not conf
.CheckLibWithHeader('socket', 'sys/socket.h', 'C++', 'accept(0,0,0);'):
698 print "Can't find library with socket calls (e.g. accept())"
701 # Check for zlib. If the check passes, libz will be automatically
702 # added to the LIBS environment variable.
703 if not conf
.CheckLibWithHeader('z', 'zlib.h', 'C++','zlibVersion();'):
704 print 'Error: did not find needed zlib compression library '\
705 'and/or zlib.h header file.'
706 print ' Please install zlib and try again.'
711 conf
.CheckLibWithHeader(None, 'time.h', 'C',
712 'clock_nanosleep(0,0,NULL,NULL);') or \
713 conf
.CheckLibWithHeader('rt', 'time.h', 'C',
714 'clock_nanosleep(0,0,NULL,NULL);')
716 if not have_posix_clock
:
717 print "Can't find library for POSIX clocks."
719 # Check for <fenv.h> (C99 FP environment control)
720 have_fenv
= conf
.CheckHeader('fenv.h', '<>')
722 print "Warning: Header file <fenv.h> not found."
723 print " This host has no IEEE FP rounding mode control."
725 ######################################################################
727 # Finish the configuration
731 ######################################################################
733 # Collect all non-global variables
736 # Define the universe of supported ISAs
738 Export('all_isa_list')
740 class CpuModel(object):
741 '''The CpuModel class encapsulates everything the ISA parser needs to
742 know about a particular CPU model.'''
744 # Dict of available CPU model objects. Accessible as CpuModel.dict.
749 # Constructor. Automatically adds models to CpuModel.dict.
750 def __init__(self
, name
, filename
, includes
, strings
, default
=False):
751 self
.name
= name
# name of model
752 self
.filename
= filename
# filename for output exec code
753 self
.includes
= includes
# include files needed in exec file
754 # The 'strings' dict holds all the per-CPU symbols we can
755 # substitute into templates etc.
756 self
.strings
= strings
758 # This cpu is enabled by default
759 self
.default
= default
762 if name
in CpuModel
.dict:
763 raise AttributeError, "CpuModel '%s' already registered" % name
764 CpuModel
.dict[name
] = self
765 CpuModel
.list.append(name
)
769 # Sticky variables get saved in the variables file so they persist from
770 # one invocation to the next (unless overridden, in which case the new
771 # value becomes sticky).
772 sticky_vars
= Variables(args
=ARGUMENTS
)
773 Export('sticky_vars')
775 # Sticky variables that should be exported
777 Export('export_vars')
779 # Walk the tree and execute all SConsopts scripts that wil add to the
781 if not GetOption('verbose'):
782 print "Reading SConsopts"
783 for bdir
in [ base_dir
] + extras_dir_list
:
785 print "Error: directory '%s' does not exist" % bdir
787 for root
, dirs
, files
in os
.walk(bdir
):
788 if 'SConsopts' in files
:
789 if GetOption('verbose'):
790 print "Reading", joinpath(root
, 'SConsopts')
791 SConscript(joinpath(root
, 'SConsopts'))
795 sticky_vars
.AddVariables(
796 EnumVariable('TARGET_ISA', 'Target ISA', 'alpha', all_isa_list
),
797 BoolVariable('FULL_SYSTEM', 'Full-system support', False),
798 ListVariable('CPU_MODELS', 'CPU models',
799 sorted(n
for n
,m
in CpuModel
.dict.iteritems() if m
.default
),
800 sorted(CpuModel
.list)),
801 BoolVariable('NO_FAST_ALLOC', 'Disable fast object allocator', False),
802 BoolVariable('FORCE_FAST_ALLOC',
803 'Enable fast object allocator, even for m5.debug', False),
804 BoolVariable('FAST_ALLOC_STATS', 'Enable fast object allocator statistics',
806 BoolVariable('EFENCE', 'Link with Electric Fence malloc debugger',
808 BoolVariable('SS_COMPATIBLE_FP',
809 'Make floating-point results compatible with SimpleScalar',
811 BoolVariable('USE_SSE2',
812 'Compile for SSE2 (-msse2) to get IEEE FP on x86 hosts',
814 BoolVariable('USE_POSIX_CLOCK', 'Use POSIX Clocks', have_posix_clock
),
815 BoolVariable('USE_FENV', 'Use <fenv.h> IEEE mode control', have_fenv
),
816 BoolVariable('USE_CHECKER', 'Use checker for detailed CPU models', False),
817 BoolVariable('CP_ANNOTATE', 'Enable critical path annotation capability', False),
820 # These variables get exported to #defines in config/*.hh (see src/SConscript).
821 export_vars
+= ['FULL_SYSTEM', 'USE_FENV',
822 'NO_FAST_ALLOC', 'FORCE_FAST_ALLOC', 'FAST_ALLOC_STATS',
823 'SS_COMPATIBLE_FP', 'USE_CHECKER', 'TARGET_ISA', 'CP_ANNOTATE',
826 ###################################################
828 # Define a SCons builder for configuration flag headers.
830 ###################################################
832 # This function generates a config header file that #defines the
833 # variable symbol to the current variable setting (0 or 1). The source
834 # operands are the name of the variable and a Value node containing the
835 # value of the variable.
836 def build_config_file(target
, source
, env
):
837 (variable
, value
) = [s
.get_contents() for s
in source
]
838 f
= file(str(target
[0]), 'w')
839 print >> f
, '#define', variable
, value
843 # Combine the two functions into a scons Action object.
844 config_action
= MakeAction(build_config_file
, Transform("CONFIG H", 2))
846 # The emitter munges the source & target node lists to reflect what
847 # we're really doing.
848 def config_emitter(target
, source
, env
):
849 # extract variable name from Builder arg
850 variable
= str(target
[0])
851 # True target is config header file
852 target
= joinpath('config', variable
.lower() + '.hh')
854 if isinstance(val
, bool):
857 elif isinstance(val
, str):
858 val
= '"' + val
+ '"'
860 # Sources are variable name & value (packaged in SCons Value nodes)
861 return ([target
], [Value(variable
), Value(val
)])
863 config_builder
= Builder(emitter
= config_emitter
, action
= config_action
)
865 main
.Append(BUILDERS
= { 'ConfigFile' : config_builder
})
867 # libelf build is shared across all configs in the build root.
868 main
.SConscript('ext/libelf/SConscript',
869 variant_dir
= joinpath(build_root
, 'libelf'))
871 # gzstream build is shared across all configs in the build root.
872 main
.SConscript('ext/gzstream/SConscript',
873 variant_dir
= joinpath(build_root
, 'gzstream'))
875 ###################################################
877 # This function is used to set up a directory with switching headers
879 ###################################################
881 main
['ALL_ISA_LIST'] = all_isa_list
882 def make_switching_dir(dname
, switch_headers
, env
):
883 # Generate the header. target[0] is the full path of the output
884 # header to generate. 'source' is a dummy variable, since we get the
885 # list of ISAs from env['ALL_ISA_LIST'].
886 def gen_switch_hdr(target
, source
, env
):
887 fname
= str(target
[0])
889 isa
= env
['TARGET_ISA'].lower()
890 print >>f
, '#include "%s/%s/%s"' % (dname
, isa
, basename(fname
))
893 # Build SCons Action object. 'varlist' specifies env vars that this
894 # action depends on; when env['ALL_ISA_LIST'] changes these actions
895 # should get re-executed.
896 switch_hdr_action
= MakeAction(gen_switch_hdr
,
897 Transform("GENERATE"), varlist
=['ALL_ISA_LIST'])
899 # Instantiate actions for each header
900 for hdr
in switch_headers
:
901 env
.Command(hdr
, [], switch_hdr_action
)
902 Export('make_switching_dir')
904 ###################################################
906 # Define build environments for selected configurations.
908 ###################################################
910 for variant_path
in variant_paths
:
911 print "Building in", variant_path
913 # Make a copy of the build-root environment to use for this config.
915 env
['BUILDDIR'] = variant_path
917 # variant_dir is the tail component of build path, and is used to
918 # determine the build parameters (e.g., 'ALPHA_SE')
919 (build_root
, variant_dir
) = splitpath(variant_path
)
921 # Set env variables according to the build directory config.
922 sticky_vars
.files
= []
923 # Variables for $BUILD_ROOT/$VARIANT_DIR are stored in
924 # $BUILD_ROOT/variables/$VARIANT_DIR so you can nuke
925 # $BUILD_ROOT/$VARIANT_DIR without losing your variables settings.
926 current_vars_file
= joinpath(build_root
, 'variables', variant_dir
)
927 if isfile(current_vars_file
):
928 sticky_vars
.files
.append(current_vars_file
)
929 print "Using saved variables file %s" % current_vars_file
931 # Build dir-specific variables file doesn't exist.
933 # Make sure the directory is there so we can create it later
934 opt_dir
= dirname(current_vars_file
)
935 if not isdir(opt_dir
):
938 # Get default build variables from source tree. Variables are
939 # normally determined by name of $VARIANT_DIR, but can be
940 # overridden by '--default=' arg on command line.
941 default
= GetOption('default')
942 opts_dir
= joinpath(main
.root
.abspath
, 'build_opts')
944 default_vars_files
= [joinpath(build_root
, 'variables', default
),
945 joinpath(opts_dir
, default
)]
947 default_vars_files
= [joinpath(opts_dir
, variant_dir
)]
948 existing_files
= filter(isfile
, default_vars_files
)
950 default_vars_file
= existing_files
[0]
951 sticky_vars
.files
.append(default_vars_file
)
952 print "Variables file %s not found,\n using defaults in %s" \
953 % (current_vars_file
, default_vars_file
)
955 print "Error: cannot find variables file %s or " \
956 "default file(s) %s" \
957 % (current_vars_file
, ' or '.join(default_vars_files
))
960 # Apply current variable settings to env
961 sticky_vars
.Update(env
)
963 help_texts
["local_vars"] += \
964 "Build variables for %s:\n" % variant_dir \
965 + sticky_vars
.GenerateHelpText(env
)
967 # Process variable settings.
969 if not have_fenv
and env
['USE_FENV']:
970 print "Warning: <fenv.h> not available; " \
971 "forcing USE_FENV to False in", variant_dir
+ "."
972 env
['USE_FENV'] = False
974 if not env
['USE_FENV']:
975 print "Warning: No IEEE FP rounding mode control in", variant_dir
+ "."
976 print " FP results may deviate slightly from other platforms."
979 env
.Append(LIBS
=['efence'])
981 # Save sticky variable settings back to current variables file
982 sticky_vars
.Save(current_vars_file
, env
)
985 env
.Append(CCFLAGS
=['-msse2'])
987 # The src/SConscript file sets up the build rules in 'env' according
988 # to the configured variables. It returns a list of environments,
989 # one for each variant build (debug, opt, etc.)
990 envList
= SConscript('src/SConscript', variant_dir
= variant_path
,
993 # Set up the regression tests for each build.
995 SConscript('tests/SConscript',
996 variant_dir
= joinpath(variant_path
, 'tests', e
.Label
),
997 exports
= { 'env' : e
}, duplicate
= False)
1001 Usage: scons [scons options] [build variables] [target(s)]
1003 Extra scons options:
1006 Global build variables: