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