SConscript revision 9618
12689Sktlim@umich.edu# -*- mode:python -*-
22689Sktlim@umich.edu
32689Sktlim@umich.edu# Copyright (c) 2004-2005 The Regents of The University of Michigan
42689Sktlim@umich.edu# All rights reserved.
52689Sktlim@umich.edu#
62689Sktlim@umich.edu# Redistribution and use in source and binary forms, with or without
72689Sktlim@umich.edu# modification, are permitted provided that the following conditions are
82689Sktlim@umich.edu# met: redistributions of source code must retain the above copyright
92689Sktlim@umich.edu# notice, this list of conditions and the following disclaimer;
102689Sktlim@umich.edu# redistributions in binary form must reproduce the above copyright
112689Sktlim@umich.edu# notice, this list of conditions and the following disclaimer in the
122689Sktlim@umich.edu# documentation and/or other materials provided with the distribution;
132689Sktlim@umich.edu# neither the name of the copyright holders nor the names of its
142689Sktlim@umich.edu# contributors may be used to endorse or promote products derived from
152689Sktlim@umich.edu# this software without specific prior written permission.
162689Sktlim@umich.edu#
172689Sktlim@umich.edu# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
182689Sktlim@umich.edu# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
192689Sktlim@umich.edu# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
202689Sktlim@umich.edu# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
212689Sktlim@umich.edu# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
222689Sktlim@umich.edu# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
232689Sktlim@umich.edu# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
242689Sktlim@umich.edu# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
252689Sktlim@umich.edu# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
262689Sktlim@umich.edu# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
272689Sktlim@umich.edu# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
282689Sktlim@umich.edu#
292689Sktlim@umich.edu# Authors: Nathan Binkert
302689Sktlim@umich.edu
312689Sktlim@umich.eduimport array
322689Sktlim@umich.eduimport bisect
332689Sktlim@umich.eduimport imp
342521SN/Aimport marshal
353960Sgblack@eecs.umich.eduimport os
364194Ssaidi@eecs.umich.eduimport re
371070SN/Aimport sys
381070SN/Aimport zlib
392521SN/A
402680Sktlim@umich.edufrom os.path import basename, dirname, exists, isdir, isfile, join as joinpath
412521SN/A
422522SN/Aimport SCons
432037SN/A
4456SN/A# This file defines how to build a particular configuration of gem5
452378SN/A# based on variable settings in the 'env' build environment.
462521SN/A
472378SN/AImport('*')
484762Snate@binkert.org
494762Snate@binkert.org# Children need to see the environment
502378SN/AExport('env')
512SN/A
522SN/Abuild_env = [(opt, env[opt]) for opt in export_vars]
532107SN/A
542SN/Afrom m5.util import code_formatter, compareVersions
552SN/A
562SN/A########################################################################
572SN/A# Code for adding source files of various types
582SN/A#
591070SN/A# When specifying a source file of some type, a set of guards can be
602378SN/A# specified for that file.  When get() is used to find the files, if
612378SN/A# get specifies a set of filters, only files that match those filters
622521SN/A# will be accepted (unspecified filters on files are assumed to be
632640Sstever@eecs.umich.edu# false).  Current filters are:
642640Sstever@eecs.umich.edu#     main -- specifies the gem5 main() function
652378SN/A#     skip_lib -- do not put this file into the gem5 library
662378SN/A#     <unittest> -- unit tests use filters based on the unit test name
672378SN/A#
682902Ssaidi@eecs.umich.edu# A parent can now be specified for a source file and default filter
692SN/A# values will be retrieved recursively from parents (children override
701070SN/A# parents).
711070SN/A#
721070SN/Aclass SourceMeta(type):
732378SN/A    '''Meta class for source files that keeps track of all files of a
741070SN/A    particular type and has a get function for finding all functions
754838Ssaidi@eecs.umich.edu    of a certain type that match a set of guards'''
764838Ssaidi@eecs.umich.edu    def __init__(cls, name, bases, dict):
771070SN/A        super(SourceMeta, cls).__init__(name, bases, dict)
782520SN/A        cls.all = []
792520SN/A        
802520SN/A    def get(cls, **guards):
812520SN/A        '''Find all files that match the specified guards.  If a source
822520SN/A        file does not specify a flag, the default is False'''
832520SN/A        for src in cls.all:
842520SN/A            for flag,value in guards.iteritems():
852520SN/A                # if the flag is found and has a different value, skip
862520SN/A                # this file
872521SN/A                if src.all_guards.get(flag, False) != value:
882521SN/A                    break
892521SN/A            else:
902521SN/A                yield src
912520SN/A
921070SN/Aclass SourceFile(object):
932158SN/A    '''Base object that encapsulates the notion of a source file.
941070SN/A    This includes, the source node, target node, various manipulations
954762Snate@binkert.org    of those.  A source file also specifies a set of guards which
963812Ssaidi@eecs.umich.edu    describing which builds the source file applies to.  A parent can
973812Ssaidi@eecs.umich.edu    also be specified to get default guards from'''
983812Ssaidi@eecs.umich.edu    __metaclass__ = SourceMeta
993812Ssaidi@eecs.umich.edu    def __init__(self, source, parent=None, **guards):
1004762Snate@binkert.org        self.guards = guards
1013812Ssaidi@eecs.umich.edu        self.parent = parent
1024762Snate@binkert.org
1031070SN/A        tnode = source
1043812Ssaidi@eecs.umich.edu        if not isinstance(source, SCons.Node.FS.File):
1053812Ssaidi@eecs.umich.edu            tnode = File(source)
1061070SN/A
1073812Ssaidi@eecs.umich.edu        self.tnode = tnode
1083812Ssaidi@eecs.umich.edu        self.snode = tnode.srcnode()
1093812Ssaidi@eecs.umich.edu
1103812Ssaidi@eecs.umich.edu        for base in type(self).__mro__:
1111070SN/A            if issubclass(base, SourceFile):
1123812Ssaidi@eecs.umich.edu                base.all.append(self)
1133812Ssaidi@eecs.umich.edu
1143812Ssaidi@eecs.umich.edu    @property
1151070SN/A    def filename(self):
1163812Ssaidi@eecs.umich.edu        return str(self.tnode)
1173812Ssaidi@eecs.umich.edu
1181070SN/A    @property
1193812Ssaidi@eecs.umich.edu    def dirname(self):
1203812Ssaidi@eecs.umich.edu        return dirname(self.filename)
1211074SN/A
1223812Ssaidi@eecs.umich.edu    @property
1233812Ssaidi@eecs.umich.edu    def basename(self):
1241074SN/A        return basename(self.filename)
1253812Ssaidi@eecs.umich.edu
1263812Ssaidi@eecs.umich.edu    @property
1273812Ssaidi@eecs.umich.edu    def extname(self):
1283812Ssaidi@eecs.umich.edu        index = self.basename.rfind('.')
1293812Ssaidi@eecs.umich.edu        if index <= 0:
1302378SN/A            # dot files aren't extensions
1312378SN/A            return self.basename, None
1321070SN/A
133878SN/A        return self.basename[:index], self.basename[index+1:]
1342SN/A
1352SN/A    @property
1362SN/A    def all_guards(self):
1372SN/A        '''find all guards for this object getting default values
1382378SN/A        recursively from its parents'''
1391070SN/A        guards = {}
1401070SN/A        if self.parent:
1412378SN/A            guards.update(self.parent.guards)
1422378SN/A        guards.update(self.guards)
1432378SN/A        return guards
1442378SN/A
1452SN/A    def __lt__(self, other): return self.filename < other.filename
1462SN/A    def __le__(self, other): return self.filename <= other.filename
1471808SN/A    def __gt__(self, other): return self.filename > other.filename
1484095Sbinkertn@umich.edu    def __ge__(self, other): return self.filename >= other.filename
1491808SN/A    def __eq__(self, other): return self.filename == other.filename
1502901Ssaidi@eecs.umich.edu    def __ne__(self, other): return self.filename != other.filename
1514762Snate@binkert.org        
1522901Ssaidi@eecs.umich.educlass Source(SourceFile):
1532901Ssaidi@eecs.umich.edu    '''Add a c/c++ source file to the build'''
1542901Ssaidi@eecs.umich.edu    def __init__(self, source, Werror=True, swig=False, **guards):
1552901Ssaidi@eecs.umich.edu        '''specify the source file, and any guards'''
1562901Ssaidi@eecs.umich.edu        super(Source, self).__init__(source, **guards)
1573960Sgblack@eecs.umich.edu
1583960Sgblack@eecs.umich.edu        self.Werror = Werror
1594095Sbinkertn@umich.edu        self.swig = swig
1604095Sbinkertn@umich.edu
1614095Sbinkertn@umich.educlass PySource(SourceFile):
1623960Sgblack@eecs.umich.edu    '''Add a python source file to the named package'''
1633960Sgblack@eecs.umich.edu    invalid_sym_char = re.compile('[^A-z0-9_]')
164180SN/A    modules = {}
1652680Sktlim@umich.edu    tnodes = {}
1662SN/A    symnames = {}
1671806SN/A    
1682680Sktlim@umich.edu    def __init__(self, package, source, **guards):
1692680Sktlim@umich.edu        '''specify the python package, the source file, and any guards'''
1701806SN/A        super(PySource, self).__init__(source, **guards)
1711806SN/A
1721806SN/A        modname,ext = self.extname
1731806SN/A        assert ext == 'py'
1742680Sktlim@umich.edu
1752680Sktlim@umich.edu        if package:
1761806SN/A            path = package.split('.')
1772680Sktlim@umich.edu        else:
1781806SN/A            path = []
1791806SN/A
1802680Sktlim@umich.edu        modpath = path[:]
1811806SN/A        if modname != '__init__':
1821070SN/A            modpath += [ modname ]
1834095Sbinkertn@umich.edu        modpath = '.'.join(modpath)
1844095Sbinkertn@umich.edu
1854095Sbinkertn@umich.edu        arcpath = path + [ self.basename ]
1864095Sbinkertn@umich.edu        abspath = self.snode.abspath
1874095Sbinkertn@umich.edu        if not exists(abspath):
1884095Sbinkertn@umich.edu            abspath = self.tnode.abspath
1894095Sbinkertn@umich.edu
1904095Sbinkertn@umich.edu        self.package = package
1914095Sbinkertn@umich.edu        self.modname = modname
1924095Sbinkertn@umich.edu        self.modpath = modpath
1931070SN/A        self.arcname = joinpath(*arcpath)
1944095Sbinkertn@umich.edu        self.abspath = abspath
1954095Sbinkertn@umich.edu        self.compiled = File(self.filename + 'c')
1964095Sbinkertn@umich.edu        self.cpp = File(self.filename + '.cc')
1974095Sbinkertn@umich.edu        self.symname = PySource.invalid_sym_char.sub('_', modpath)
1984095Sbinkertn@umich.edu
1991070SN/A        PySource.modules[modpath] = self
2001070SN/A        PySource.tnodes[self.tnode] = self
2011806SN/A        PySource.symnames[self.symname] = self
202180SN/A
20375SN/Aclass SimObject(PySource):
204180SN/A    '''Add a SimObject python file as a python source object and add
2051129SN/A    it to a list of sim object modules'''
2061129SN/A
2072114SN/A    fixed = False
2082680Sktlim@umich.edu    modnames = []
2094194Ssaidi@eecs.umich.edu
2101129SN/A    def __init__(self, source, **guards):
2111129SN/A        '''Specify the source file and any guards (automatically in
2121129SN/A        the m5.objects package)'''
2132680Sktlim@umich.edu        super(SimObject, self).__init__('m5.objects', source, **guards)
214180SN/A        if self.fixed:
2152680Sktlim@umich.edu            raise AttributeError, "Too late to call SimObject now."
2162680Sktlim@umich.edu
2172680Sktlim@umich.edu        bisect.insort_right(SimObject.modnames, self.modname)
218180SN/A
219180SN/Aclass SwigSource(SourceFile):
2202680Sktlim@umich.edu    '''Add a swig file to build'''
2214095Sbinkertn@umich.edu
2224095Sbinkertn@umich.edu    def __init__(self, package, source, **guards):
2232SN/A        '''Specify the python package, the source file, and any guards'''
2242SN/A        super(SwigSource, self).__init__(source, **guards)
2252378SN/A
2262378SN/A        modname,ext = self.extname
2272378SN/A        assert ext == 'i'
2282378SN/A
2292378SN/A        self.module = modname
2302378SN/A        cc_file = joinpath(self.dirname, modname + '_wrap.cc')
2313162Ssaidi@eecs.umich.edu        py_file = joinpath(self.dirname, modname + '.py')
2323162Ssaidi@eecs.umich.edu
2332378SN/A        self.cc_source = Source(cc_file, swig=True, parent=self)
2342378SN/A        self.py_source = PySource(package, py_file, parent=self)
2352378SN/A
2362378SN/Aclass ProtoBuf(SourceFile):
2371070SN/A    '''Add a Protocol Buffer to build'''
2381070SN/A
2391070SN/A    def __init__(self, source, **guards):
2402378SN/A        '''Specify the source file, and any guards'''
2411984SN/A        super(ProtoBuf, self).__init__(source, **guards)
2422378SN/A
2431070SN/A        # Get the file name and the extension
2441070SN/A        modname,ext = self.extname
2451070SN/A        assert ext == 'proto'
2461070SN/A
2471070SN/A        # Currently, we stick to generating the C++ headers, so we
2481070SN/A        # only need to track the source and header.
2492378SN/A        self.cc_file = File(joinpath(self.dirname, modname + '.pb.cc'))
2501984SN/A        self.hh_file = File(joinpath(self.dirname, modname + '.pb.h'))
2512378SN/A
2521070SN/Aclass UnitTest(object):
2532SN/A    '''Create a UnitTest'''
2542SN/A
2552SN/A    all = []
2562SN/A    def __init__(self, target, *sources, **kwargs):
2572SN/A        '''Specify the target name and any sources.  Sources that are
2582SN/A        not SourceFiles are evalued with Source().  All files are
2592SN/A        guarded with a guard of the same name as the UnitTest
2602SN/A        target.'''
2612SN/A
2622SN/A        srcs = []
2632SN/A        for src in sources:
2642SN/A            if not isinstance(src, SourceFile):
2652SN/A                src = Source(src, skip_lib=True)
2662SN/A            src.guards[target] = True
2672SN/A            srcs.append(src)
2682SN/A
2692SN/A        self.sources = srcs
2702SN/A        self.target = target
2712902Ssaidi@eecs.umich.edu        self.main = kwargs.get('main', False)
2722902Ssaidi@eecs.umich.edu        UnitTest.all.append(self)
2732902Ssaidi@eecs.umich.edu
2744762Snate@binkert.org# Children should have access
2752424SN/AExport('Source')
2764762Snate@binkert.orgExport('PySource')
2774762Snate@binkert.orgExport('SimObject')
2782424SN/AExport('SwigSource')
2792424SN/AExport('ProtoBuf')
2804762Snate@binkert.orgExport('UnitTest')
2812424SN/A
2822902Ssaidi@eecs.umich.edu########################################################################
2832424SN/A#
2842424SN/A# Debug Flags
2852424SN/A#
2862424SN/Adebug_flags = {}
287def DebugFlag(name, desc=None):
288    if name in debug_flags:
289        raise AttributeError, "Flag %s already specified" % name
290    debug_flags[name] = (name, (), desc)
291
292def CompoundFlag(name, flags, desc=None):
293    if name in debug_flags:
294        raise AttributeError, "Flag %s already specified" % name
295
296    compound = tuple(flags)
297    debug_flags[name] = (name, compound, desc)
298
299Export('DebugFlag')
300Export('CompoundFlag')
301
302########################################################################
303#
304# Set some compiler variables
305#
306
307# Include file paths are rooted in this directory.  SCons will
308# automatically expand '.' to refer to both the source directory and
309# the corresponding build directory to pick up generated include
310# files.
311env.Append(CPPPATH=Dir('.'))
312
313for extra_dir in extras_dir_list:
314    env.Append(CPPPATH=Dir(extra_dir))
315
316# Workaround for bug in SCons version > 0.97d20071212
317# Scons bug id: 2006 gem5 Bug id: 308
318for root, dirs, files in os.walk(base_dir, topdown=True):
319    Dir(root[len(base_dir) + 1:])
320
321########################################################################
322#
323# Walk the tree and execute all SConscripts in subdirectories
324#
325
326here = Dir('.').srcnode().abspath
327for root, dirs, files in os.walk(base_dir, topdown=True):
328    if root == here:
329        # we don't want to recurse back into this SConscript
330        continue
331
332    if 'SConscript' in files:
333        build_dir = joinpath(env['BUILDDIR'], root[len(base_dir) + 1:])
334        SConscript(joinpath(root, 'SConscript'), variant_dir=build_dir)
335
336for extra_dir in extras_dir_list:
337    prefix_len = len(dirname(extra_dir)) + 1
338    for root, dirs, files in os.walk(extra_dir, topdown=True):
339        # if build lives in the extras directory, don't walk down it
340        if 'build' in dirs:
341            dirs.remove('build')
342
343        if 'SConscript' in files:
344            build_dir = joinpath(env['BUILDDIR'], root[prefix_len:])
345            SConscript(joinpath(root, 'SConscript'), variant_dir=build_dir)
346
347for opt in export_vars:
348    env.ConfigFile(opt)
349
350def makeTheISA(source, target, env):
351    isas = [ src.get_contents() for src in source ]
352    target_isa = env['TARGET_ISA']
353    def define(isa):
354        return isa.upper() + '_ISA'
355    
356    def namespace(isa):
357        return isa[0].upper() + isa[1:].lower() + 'ISA' 
358
359
360    code = code_formatter()
361    code('''\
362#ifndef __CONFIG_THE_ISA_HH__
363#define __CONFIG_THE_ISA_HH__
364
365''')
366
367    for i,isa in enumerate(isas):
368        code('#define $0 $1', define(isa), i + 1)
369
370    code('''
371
372#define THE_ISA ${{define(target_isa)}}
373#define TheISA ${{namespace(target_isa)}}
374#define THE_ISA_STR "${{target_isa}}"
375
376#endif // __CONFIG_THE_ISA_HH__''')
377
378    code.write(str(target[0]))
379
380env.Command('config/the_isa.hh', map(Value, all_isa_list),
381            MakeAction(makeTheISA, Transform("CFG ISA", 0)))
382
383########################################################################
384#
385# Prevent any SimObjects from being added after this point, they
386# should all have been added in the SConscripts above
387#
388SimObject.fixed = True
389
390class DictImporter(object):
391    '''This importer takes a dictionary of arbitrary module names that
392    map to arbitrary filenames.'''
393    def __init__(self, modules):
394        self.modules = modules
395        self.installed = set()
396
397    def __del__(self):
398        self.unload()
399
400    def unload(self):
401        import sys
402        for module in self.installed:
403            del sys.modules[module]
404        self.installed = set()
405
406    def find_module(self, fullname, path):
407        if fullname == 'm5.defines':
408            return self
409
410        if fullname == 'm5.objects':
411            return self
412
413        if fullname.startswith('m5.internal'):
414            return None
415
416        source = self.modules.get(fullname, None)
417        if source is not None and fullname.startswith('m5.objects'):
418            return self
419
420        return None
421
422    def load_module(self, fullname):
423        mod = imp.new_module(fullname)
424        sys.modules[fullname] = mod
425        self.installed.add(fullname)
426
427        mod.__loader__ = self
428        if fullname == 'm5.objects':
429            mod.__path__ = fullname.split('.')
430            return mod
431
432        if fullname == 'm5.defines':
433            mod.__dict__['buildEnv'] = m5.util.SmartDict(build_env)
434            return mod
435
436        source = self.modules[fullname]
437        if source.modname == '__init__':
438            mod.__path__ = source.modpath
439        mod.__file__ = source.abspath
440
441        exec file(source.abspath, 'r') in mod.__dict__
442
443        return mod
444
445import m5.SimObject
446import m5.params
447from m5.util import code_formatter
448
449m5.SimObject.clear()
450m5.params.clear()
451
452# install the python importer so we can grab stuff from the source
453# tree itself.  We can't have SimObjects added after this point or
454# else we won't know about them for the rest of the stuff.
455importer = DictImporter(PySource.modules)
456sys.meta_path[0:0] = [ importer ]
457
458# import all sim objects so we can populate the all_objects list
459# make sure that we're working with a list, then let's sort it
460for modname in SimObject.modnames:
461    exec('from m5.objects import %s' % modname)
462
463# we need to unload all of the currently imported modules so that they
464# will be re-imported the next time the sconscript is run
465importer.unload()
466sys.meta_path.remove(importer)
467
468sim_objects = m5.SimObject.allClasses
469all_enums = m5.params.allEnums
470
471if m5.SimObject.noCxxHeader:
472    print >> sys.stderr, \
473        "warning: At least one SimObject lacks a header specification. " \
474        "This can cause unexpected results in the generated SWIG " \
475        "wrappers."
476
477# Find param types that need to be explicitly wrapped with swig.
478# These will be recognized because the ParamDesc will have a
479# swig_decl() method.  Most param types are based on types that don't
480# need this, either because they're based on native types (like Int)
481# or because they're SimObjects (which get swigged independently).
482# For now the only things handled here are VectorParam types.
483params_to_swig = {}
484for name,obj in sorted(sim_objects.iteritems()):
485    for param in obj._params.local.values():
486        # load the ptype attribute now because it depends on the
487        # current version of SimObject.allClasses, but when scons
488        # actually uses the value, all versions of
489        # SimObject.allClasses will have been loaded
490        param.ptype
491
492        if not hasattr(param, 'swig_decl'):
493            continue
494        pname = param.ptype_str
495        if pname not in params_to_swig:
496            params_to_swig[pname] = param
497
498########################################################################
499#
500# calculate extra dependencies
501#
502module_depends = ["m5", "m5.SimObject", "m5.params"]
503depends = [ PySource.modules[dep].snode for dep in module_depends ]
504
505########################################################################
506#
507# Commands for the basic automatically generated python files
508#
509
510# Generate Python file containing a dict specifying the current
511# buildEnv flags.
512def makeDefinesPyFile(target, source, env):
513    build_env = source[0].get_contents()
514
515    code = code_formatter()
516    code("""
517import m5.internal
518import m5.util
519
520buildEnv = m5.util.SmartDict($build_env)
521
522compileDate = m5.internal.core.compileDate
523_globals = globals()
524for key,val in m5.internal.core.__dict__.iteritems():
525    if key.startswith('flag_'):
526        flag = key[5:]
527        _globals[flag] = val
528del _globals
529""")
530    code.write(target[0].abspath)
531
532defines_info = Value(build_env)
533# Generate a file with all of the compile options in it
534env.Command('python/m5/defines.py', defines_info,
535            MakeAction(makeDefinesPyFile, Transform("DEFINES", 0)))
536PySource('m5', 'python/m5/defines.py')
537
538# Generate python file containing info about the M5 source code
539def makeInfoPyFile(target, source, env):
540    code = code_formatter()
541    for src in source:
542        data = ''.join(file(src.srcnode().abspath, 'r').xreadlines())
543        code('$src = ${{repr(data)}}')
544    code.write(str(target[0]))
545
546# Generate a file that wraps the basic top level files
547env.Command('python/m5/info.py',
548            [ '#/COPYING', '#/LICENSE', '#/README', ],
549            MakeAction(makeInfoPyFile, Transform("INFO")))
550PySource('m5', 'python/m5/info.py')
551
552########################################################################
553#
554# Create all of the SimObject param headers and enum headers
555#
556
557def createSimObjectParamStruct(target, source, env):
558    assert len(target) == 1 and len(source) == 1
559
560    name = str(source[0].get_contents())
561    obj = sim_objects[name]
562
563    code = code_formatter()
564    obj.cxx_param_decl(code)
565    code.write(target[0].abspath)
566
567def createParamSwigWrapper(target, source, env):
568    assert len(target) == 1 and len(source) == 1
569
570    name = str(source[0].get_contents())
571    param = params_to_swig[name]
572
573    code = code_formatter()
574    param.swig_decl(code)
575    code.write(target[0].abspath)
576
577def createEnumStrings(target, source, env):
578    assert len(target) == 1 and len(source) == 1
579
580    name = str(source[0].get_contents())
581    obj = all_enums[name]
582
583    code = code_formatter()
584    obj.cxx_def(code)
585    code.write(target[0].abspath)
586
587def createEnumDecls(target, source, env):
588    assert len(target) == 1 and len(source) == 1
589
590    name = str(source[0].get_contents())
591    obj = all_enums[name]
592
593    code = code_formatter()
594    obj.cxx_decl(code)
595    code.write(target[0].abspath)
596
597def createEnumSwigWrapper(target, source, env):
598    assert len(target) == 1 and len(source) == 1
599
600    name = str(source[0].get_contents())
601    obj = all_enums[name]
602
603    code = code_formatter()
604    obj.swig_decl(code)
605    code.write(target[0].abspath)
606
607def createSimObjectSwigWrapper(target, source, env):
608    name = source[0].get_contents()
609    obj = sim_objects[name]
610
611    code = code_formatter()
612    obj.swig_decl(code)
613    code.write(target[0].abspath)
614
615# Generate all of the SimObject param C++ struct header files
616params_hh_files = []
617for name,simobj in sorted(sim_objects.iteritems()):
618    py_source = PySource.modules[simobj.__module__]
619    extra_deps = [ py_source.tnode ]
620
621    hh_file = File('params/%s.hh' % name)
622    params_hh_files.append(hh_file)
623    env.Command(hh_file, Value(name),
624                MakeAction(createSimObjectParamStruct, Transform("SO PARAM")))
625    env.Depends(hh_file, depends + extra_deps)
626
627# Generate any needed param SWIG wrapper files
628params_i_files = []
629for name,param in params_to_swig.iteritems():
630    i_file = File('python/m5/internal/%s.i' % (param.swig_module_name()))
631    params_i_files.append(i_file)
632    env.Command(i_file, Value(name),
633                MakeAction(createParamSwigWrapper, Transform("SW PARAM")))
634    env.Depends(i_file, depends)
635    SwigSource('m5.internal', i_file)
636
637# Generate all enum header files
638for name,enum in sorted(all_enums.iteritems()):
639    py_source = PySource.modules[enum.__module__]
640    extra_deps = [ py_source.tnode ]
641
642    cc_file = File('enums/%s.cc' % name)
643    env.Command(cc_file, Value(name),
644                MakeAction(createEnumStrings, Transform("ENUM STR")))
645    env.Depends(cc_file, depends + extra_deps)
646    Source(cc_file)
647
648    hh_file = File('enums/%s.hh' % name)
649    env.Command(hh_file, Value(name),
650                MakeAction(createEnumDecls, Transform("ENUMDECL")))
651    env.Depends(hh_file, depends + extra_deps)
652
653    i_file = File('python/m5/internal/enum_%s.i' % name)
654    env.Command(i_file, Value(name),
655                MakeAction(createEnumSwigWrapper, Transform("ENUMSWIG")))
656    env.Depends(i_file, depends + extra_deps)
657    SwigSource('m5.internal', i_file)
658
659# Generate SimObject SWIG wrapper files
660for name,simobj in sim_objects.iteritems():
661    py_source = PySource.modules[simobj.__module__]
662    extra_deps = [ py_source.tnode ]
663
664    i_file = File('python/m5/internal/param_%s.i' % name)
665    env.Command(i_file, Value(name),
666                MakeAction(createSimObjectSwigWrapper, Transform("SO SWIG")))
667    env.Depends(i_file, depends + extra_deps)
668    SwigSource('m5.internal', i_file)
669
670# Generate the main swig init file
671def makeEmbeddedSwigInit(target, source, env):
672    code = code_formatter()
673    module = source[0].get_contents()
674    code('''\
675#include "sim/init.hh"
676
677extern "C" {
678    void init_${module}();
679}
680
681EmbeddedSwig embed_swig_${module}(init_${module});
682''')
683    code.write(str(target[0]))
684    
685# Build all swig modules
686for swig in SwigSource.all:
687    env.Command([swig.cc_source.tnode, swig.py_source.tnode], swig.tnode,
688                MakeAction('$SWIG $SWIGFLAGS -outdir ${TARGETS[1].dir} '
689                '-o ${TARGETS[0]} $SOURCES', Transform("SWIG")))
690    cc_file = str(swig.tnode)
691    init_file = '%s/%s_init.cc' % (dirname(cc_file), basename(cc_file))
692    env.Command(init_file, Value(swig.module),
693                MakeAction(makeEmbeddedSwigInit, Transform("EMBED SW")))
694    Source(init_file, **swig.guards)
695
696# Build all protocol buffers if we have got protoc and protobuf available
697if env['HAVE_PROTOBUF']:
698    for proto in ProtoBuf.all:
699        # Use both the source and header as the target, and the .proto
700        # file as the source. When executing the protoc compiler, also
701        # specify the proto_path to avoid having the generated files
702        # include the path.
703        env.Command([proto.cc_file, proto.hh_file], proto.tnode,
704                    MakeAction('$PROTOC --cpp_out ${TARGET.dir} '
705                               '--proto_path ${SOURCE.dir} $SOURCE',
706                               Transform("PROTOC")))
707
708        # Add the C++ source file
709        Source(proto.cc_file, **proto.guards)
710elif ProtoBuf.all:
711    print 'Got protobuf to build, but lacks support!'
712    Exit(1)
713
714#
715# Handle debug flags
716#
717def makeDebugFlagCC(target, source, env):
718    assert(len(target) == 1 and len(source) == 1)
719
720    val = eval(source[0].get_contents())
721    name, compound, desc = val
722    compound = list(sorted(compound))
723
724    code = code_formatter()
725
726    # file header
727    code('''
728/*
729 * DO NOT EDIT THIS FILE! Automatically generated
730 */
731
732#include "base/debug.hh"
733''')
734
735    for flag in compound:
736        code('#include "debug/$flag.hh"')
737    code()
738    code('namespace Debug {')
739    code()
740
741    if not compound:
742        code('SimpleFlag $name("$name", "$desc");')
743    else:
744        code('CompoundFlag $name("$name", "$desc",')
745        code.indent()
746        last = len(compound) - 1
747        for i,flag in enumerate(compound):
748            if i != last:
749                code('$flag,')
750            else:
751                code('$flag);')
752        code.dedent()
753
754    code()
755    code('} // namespace Debug')
756
757    code.write(str(target[0]))
758
759def makeDebugFlagHH(target, source, env):
760    assert(len(target) == 1 and len(source) == 1)
761
762    val = eval(source[0].get_contents())
763    name, compound, desc = val
764
765    code = code_formatter()
766
767    # file header boilerplate
768    code('''\
769/*
770 * DO NOT EDIT THIS FILE!
771 *
772 * Automatically generated by SCons
773 */
774
775#ifndef __DEBUG_${name}_HH__
776#define __DEBUG_${name}_HH__
777
778namespace Debug {
779''')
780
781    if compound:
782        code('class CompoundFlag;')
783    code('class SimpleFlag;')
784
785    if compound:
786        code('extern CompoundFlag $name;')
787        for flag in compound:
788            code('extern SimpleFlag $flag;')
789    else:
790        code('extern SimpleFlag $name;')
791
792    code('''
793}
794
795#endif // __DEBUG_${name}_HH__
796''')
797
798    code.write(str(target[0]))
799
800for name,flag in sorted(debug_flags.iteritems()):
801    n, compound, desc = flag
802    assert n == name
803
804    env.Command('debug/%s.hh' % name, Value(flag),
805                MakeAction(makeDebugFlagHH, Transform("TRACING", 0)))
806    env.Command('debug/%s.cc' % name, Value(flag),
807                MakeAction(makeDebugFlagCC, Transform("TRACING", 0)))
808    Source('debug/%s.cc' % name)
809
810# Embed python files.  All .py files that have been indicated by a
811# PySource() call in a SConscript need to be embedded into the M5
812# library.  To do that, we compile the file to byte code, marshal the
813# byte code, compress it, and then generate a c++ file that
814# inserts the result into an array.
815def embedPyFile(target, source, env):
816    def c_str(string):
817        if string is None:
818            return "0"
819        return '"%s"' % string
820
821    '''Action function to compile a .py into a code object, marshal
822    it, compress it, and stick it into an asm file so the code appears
823    as just bytes with a label in the data section'''
824
825    src = file(str(source[0]), 'r').read()
826
827    pysource = PySource.tnodes[source[0]]
828    compiled = compile(src, pysource.abspath, 'exec')
829    marshalled = marshal.dumps(compiled)
830    compressed = zlib.compress(marshalled)
831    data = compressed
832    sym = pysource.symname
833
834    code = code_formatter()
835    code('''\
836#include "sim/init.hh"
837
838namespace {
839
840const uint8_t data_${sym}[] = {
841''')
842    code.indent()
843    step = 16
844    for i in xrange(0, len(data), step):
845        x = array.array('B', data[i:i+step])
846        code(''.join('%d,' % d for d in x))
847    code.dedent()
848    
849    code('''};
850
851EmbeddedPython embedded_${sym}(
852    ${{c_str(pysource.arcname)}},
853    ${{c_str(pysource.abspath)}},
854    ${{c_str(pysource.modpath)}},
855    data_${sym},
856    ${{len(data)}},
857    ${{len(marshalled)}});
858
859} // anonymous namespace
860''')
861    code.write(str(target[0]))
862
863for source in PySource.all:
864    env.Command(source.cpp, source.tnode, 
865                MakeAction(embedPyFile, Transform("EMBED PY")))
866    Source(source.cpp)
867
868########################################################################
869#
870# Define binaries.  Each different build type (debug, opt, etc.) gets
871# a slightly different build environment.
872#
873
874# List of constructed environments to pass back to SConstruct
875envList = []
876
877date_source = Source('base/date.cc', skip_lib=True)
878
879# Function to create a new build environment as clone of current
880# environment 'env' with modified object suffix and optional stripped
881# binary.  Additional keyword arguments are appended to corresponding
882# build environment vars.
883def makeEnv(label, objsfx, strip = False, **kwargs):
884    # SCons doesn't know to append a library suffix when there is a '.' in the
885    # name.  Use '_' instead.
886    libname = 'gem5_' + label
887    exename = 'gem5.' + label
888    secondary_exename = 'm5.' + label
889
890    new_env = env.Clone(OBJSUFFIX=objsfx, SHOBJSUFFIX=objsfx + 's')
891    new_env.Label = label
892    new_env.Append(**kwargs)
893
894    swig_env = new_env.Clone()
895
896    # Both gcc and clang have issues with unused labels and values in
897    # the SWIG generated code
898    swig_env.Append(CCFLAGS=['-Wno-unused-label', '-Wno-unused-value'])
899
900    # Add additional warnings here that should not be applied to
901    # the SWIG generated code
902    new_env.Append(CXXFLAGS='-Wmissing-declarations')
903
904    if env['GCC']:
905        # Depending on the SWIG version, we also need to supress
906        # warnings about uninitialized variables and missing field
907        # initializers.
908        swig_env.Append(CCFLAGS=['-Wno-uninitialized',
909                                 '-Wno-missing-field-initializers'])
910
911        if compareVersions(env['GCC_VERSION'], '4.6') >= 0:
912            swig_env.Append(CCFLAGS='-Wno-unused-but-set-variable')
913
914        # If gcc supports it, also warn for deletion of derived
915        # classes with non-virtual desctructors. For gcc >= 4.7 we
916        # also have to disable warnings about the SWIG code having
917        # potentially uninitialized variables.
918        if compareVersions(env['GCC_VERSION'], '4.7') >= 0:
919            new_env.Append(CXXFLAGS='-Wdelete-non-virtual-dtor')
920            swig_env.Append(CCFLAGS='-Wno-maybe-uninitialized')
921    if env['CLANG']:
922        # Always enable the warning for deletion of derived classes
923        # with non-virtual destructors
924        new_env.Append(CXXFLAGS=['-Wdelete-non-virtual-dtor'])
925
926    werror_env = new_env.Clone()
927    werror_env.Append(CCFLAGS='-Werror')
928
929    def make_obj(source, static, extra_deps = None):
930        '''This function adds the specified source to the correct
931        build environment, and returns the corresponding SCons Object
932        nodes'''
933
934        if source.swig:
935            env = swig_env
936        elif source.Werror:
937            env = werror_env
938        else:
939            env = new_env
940
941        if static:
942            obj = env.StaticObject(source.tnode)
943        else:
944            obj = env.SharedObject(source.tnode)
945
946        if extra_deps:
947            env.Depends(obj, extra_deps)
948
949        return obj
950
951    static_objs = \
952        [ make_obj(s, True) for s in Source.get(main=False, skip_lib=False) ]
953    shared_objs = \
954        [ make_obj(s, False) for s in Source.get(main=False, skip_lib=False) ]
955
956    static_date = make_obj(date_source, static=True, extra_deps=static_objs)
957    static_objs.append(static_date)
958    
959    shared_date = make_obj(date_source, static=False, extra_deps=shared_objs)
960    shared_objs.append(shared_date)
961
962    # First make a library of everything but main() so other programs can
963    # link against m5.
964    static_lib = new_env.StaticLibrary(libname, static_objs)
965    shared_lib = new_env.SharedLibrary(libname, shared_objs)
966
967    # Now link a stub with main() and the static library.
968    main_objs = [ make_obj(s, True) for s in Source.get(main=True) ]
969
970    for test in UnitTest.all:
971        flags = { test.target : True }
972        test_sources = Source.get(**flags)
973        test_objs = [ make_obj(s, static=True) for s in test_sources ]
974        if test.main:
975            test_objs += main_objs
976        testname = "unittest/%s.%s" % (test.target, label)
977        new_env.Program(testname, test_objs + static_objs)
978
979    progname = exename
980    if strip:
981        progname += '.unstripped'
982
983    targets = new_env.Program(progname, main_objs + static_objs)
984
985    if strip:
986        if sys.platform == 'sunos5':
987            cmd = 'cp $SOURCE $TARGET; strip $TARGET'
988        else:
989            cmd = 'strip $SOURCE -o $TARGET'
990        targets = new_env.Command(exename, progname,
991                    MakeAction(cmd, Transform("STRIP")))
992
993    new_env.Command(secondary_exename, exename,
994            MakeAction('ln $SOURCE $TARGET', Transform("HARDLINK")))
995
996    new_env.M5Binary = targets[0]
997    envList.append(new_env)
998
999# Start out with the compiler flags common to all compilers,
1000# i.e. they all use -g for opt and -g -pg for prof
1001ccflags = {'debug' : [], 'opt' : ['-g'], 'fast' : [], 'prof' : ['-g', '-pg'],
1002           'perf' : ['-g']}
1003
1004# Start out with the linker flags common to all linkers, i.e. -pg for
1005# prof, and -lprofiler for perf. The -lprofile flag is surrounded by
1006# no-as-needed and as-needed as the binutils linker is too clever and
1007# simply doesn't link to the library otherwise.
1008ldflags = {'debug' : [], 'opt' : [], 'fast' : [], 'prof' : ['-pg'],
1009           'perf' : ['-Wl,--no-as-needed', '-lprofiler', '-Wl,--as-needed']}
1010
1011# For Link Time Optimization, the optimisation flags used to compile
1012# individual files are decoupled from those used at link time
1013# (i.e. you can compile with -O3 and perform LTO with -O0), so we need
1014# to also update the linker flags based on the target.
1015if env['GCC']:
1016    if sys.platform == 'sunos5':
1017        ccflags['debug'] += ['-gstabs+']
1018    else:
1019        ccflags['debug'] += ['-ggdb3']
1020    ldflags['debug'] += ['-O0']
1021    # opt, fast, prof and perf all share the same cc flags, also add
1022    # the optimization to the ldflags as LTO defers the optimization
1023    # to link time
1024    for target in ['opt', 'fast', 'prof', 'perf']:
1025        ccflags[target] += ['-O3']
1026        ldflags[target] += ['-O3']
1027
1028    ccflags['fast'] += env['LTO_CCFLAGS']
1029    ldflags['fast'] += env['LTO_LDFLAGS']
1030elif env['CLANG']:
1031    ccflags['debug'] += ['-g', '-O0']
1032    # opt, fast, prof and perf all share the same cc flags
1033    for target in ['opt', 'fast', 'prof', 'perf']:
1034        ccflags[target] += ['-O3']
1035else:
1036    print 'Unknown compiler, please fix compiler options'
1037    Exit(1)
1038
1039
1040# To speed things up, we only instantiate the build environments we
1041# need.  We try to identify the needed environment for each target; if
1042# we can't, we fall back on instantiating all the environments just to
1043# be safe.
1044target_types = ['debug', 'opt', 'fast', 'prof', 'perf']
1045obj2target = {'do': 'debug', 'o': 'opt', 'fo': 'fast', 'po': 'prof',
1046              'gpo' : 'perf'}
1047
1048def identifyTarget(t):
1049    ext = t.split('.')[-1]
1050    if ext in target_types:
1051        return ext
1052    if obj2target.has_key(ext):
1053        return obj2target[ext]
1054    match = re.search(r'/tests/([^/]+)/', t)
1055    if match and match.group(1) in target_types:
1056        return match.group(1)
1057    return 'all'
1058
1059needed_envs = [identifyTarget(target) for target in BUILD_TARGETS]
1060if 'all' in needed_envs:
1061    needed_envs += target_types
1062
1063# Debug binary
1064if 'debug' in needed_envs:
1065    makeEnv('debug', '.do',
1066            CCFLAGS = Split(ccflags['debug']),
1067            CPPDEFINES = ['DEBUG', 'TRACING_ON=1'],
1068            LINKFLAGS = Split(ldflags['debug']))
1069
1070# Optimized binary
1071if 'opt' in needed_envs:
1072    makeEnv('opt', '.o',
1073            CCFLAGS = Split(ccflags['opt']),
1074            CPPDEFINES = ['TRACING_ON=1'],
1075            LINKFLAGS = Split(ldflags['opt']))
1076
1077# "Fast" binary
1078if 'fast' in needed_envs:
1079    makeEnv('fast', '.fo', strip = True,
1080            CCFLAGS = Split(ccflags['fast']),
1081            CPPDEFINES = ['NDEBUG', 'TRACING_ON=0'],
1082            LINKFLAGS = Split(ldflags['fast']))
1083
1084# Profiled binary using gprof
1085if 'prof' in needed_envs:
1086    makeEnv('prof', '.po',
1087            CCFLAGS = Split(ccflags['prof']),
1088            CPPDEFINES = ['NDEBUG', 'TRACING_ON=0'],
1089            LINKFLAGS = Split(ldflags['prof']))
1090
1091# Profiled binary using google-pprof
1092if 'perf' in needed_envs:
1093    makeEnv('perf', '.gpo',
1094            CCFLAGS = Split(ccflags['perf']),
1095            CPPDEFINES = ['NDEBUG', 'TRACING_ON=0'],
1096            LINKFLAGS = Split(ldflags['perf']))
1097
1098Return('envList')
1099