SConscript revision 7811
1955SN/A# -*- mode:python -*-
2955SN/A
31762SN/A# Copyright (c) 2004-2005 The Regents of The University of Michigan
4955SN/A# All rights reserved.
5955SN/A#
6955SN/A# Redistribution and use in source and binary forms, with or without
7955SN/A# modification, are permitted provided that the following conditions are
8955SN/A# met: redistributions of source code must retain the above copyright
9955SN/A# notice, this list of conditions and the following disclaimer;
10955SN/A# redistributions in binary form must reproduce the above copyright
11955SN/A# notice, this list of conditions and the following disclaimer in the
12955SN/A# documentation and/or other materials provided with the distribution;
13955SN/A# neither the name of the copyright holders nor the names of its
14955SN/A# contributors may be used to endorse or promote products derived from
15955SN/A# this software without specific prior written permission.
16955SN/A#
17955SN/A# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
18955SN/A# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
19955SN/A# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
20955SN/A# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
21955SN/A# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
22955SN/A# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
23955SN/A# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24955SN/A# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25955SN/A# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26955SN/A# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
27955SN/A# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
282665Ssaidi@eecs.umich.edu#
294762Snate@binkert.org# Authors: Nathan Binkert
30955SN/A
315522Snate@binkert.orgimport array
326143Snate@binkert.orgimport bisect
334762Snate@binkert.orgimport imp
345522Snate@binkert.orgimport marshal
35955SN/Aimport os
365522Snate@binkert.orgimport re
37955SN/Aimport sys
385522Snate@binkert.orgimport zlib
394202Sbinkertn@umich.edu
405742Snate@binkert.orgfrom os.path import basename, dirname, exists, isdir, isfile, join as joinpath
41955SN/A
424381Sbinkertn@umich.eduimport SCons
434381Sbinkertn@umich.edu
44955SN/A# This file defines how to build a particular configuration of M5
45955SN/A# based on variable settings in the 'env' build environment.
46955SN/A
474202Sbinkertn@umich.eduImport('*')
48955SN/A
494382Sbinkertn@umich.edu# Children need to see the environment
504382Sbinkertn@umich.eduExport('env')
514382Sbinkertn@umich.edu
526654Snate@binkert.orgbuild_env = [(opt, env[opt]) for opt in export_vars]
535517Snate@binkert.org
547674Snate@binkert.orgfrom m5.util import code_formatter
557674Snate@binkert.org
566143Snate@binkert.org########################################################################
576143Snate@binkert.org# Code for adding source files of various types
586143Snate@binkert.org#
596143Snate@binkert.orgclass SourceMeta(type):
606143Snate@binkert.org    def __init__(cls, name, bases, dict):
616143Snate@binkert.org        super(SourceMeta, cls).__init__(name, bases, dict)
626143Snate@binkert.org        cls.all = []
636143Snate@binkert.org        
646143Snate@binkert.org    def get(cls, **kwargs):
656143Snate@binkert.org        for src in cls.all:
666143Snate@binkert.org            for attr,value in kwargs.iteritems():
676143Snate@binkert.org                if getattr(src, attr) != value:
686143Snate@binkert.org                    break
696143Snate@binkert.org            else:
706143Snate@binkert.org                yield src
714762Snate@binkert.org
726143Snate@binkert.orgclass SourceFile(object):
736143Snate@binkert.org    __metaclass__ = SourceMeta
746143Snate@binkert.org    def __init__(self, source):
756143Snate@binkert.org        tnode = source
766143Snate@binkert.org        if not isinstance(source, SCons.Node.FS.File):
776143Snate@binkert.org            tnode = File(source)
786143Snate@binkert.org
796143Snate@binkert.org        self.tnode = tnode
806143Snate@binkert.org        self.snode = tnode.srcnode()
816143Snate@binkert.org        self.filename = str(tnode)
826143Snate@binkert.org        self.dirname = dirname(self.filename)
836143Snate@binkert.org        self.basename = basename(self.filename)
846143Snate@binkert.org        index = self.basename.rfind('.')
856143Snate@binkert.org        if index <= 0:
866143Snate@binkert.org            # dot files aren't extensions
876143Snate@binkert.org            self.extname = self.basename, None
886143Snate@binkert.org        else:
896143Snate@binkert.org            self.extname = self.basename[:index], self.basename[index+1:]
906143Snate@binkert.org
916143Snate@binkert.org        for base in type(self).__mro__:
926143Snate@binkert.org            if issubclass(base, SourceFile):
937065Snate@binkert.org                base.all.append(self)
946143Snate@binkert.org
956143Snate@binkert.org    def __lt__(self, other): return self.filename < other.filename
966143Snate@binkert.org    def __le__(self, other): return self.filename <= other.filename
976143Snate@binkert.org    def __gt__(self, other): return self.filename > other.filename
986143Snate@binkert.org    def __ge__(self, other): return self.filename >= other.filename
996143Snate@binkert.org    def __eq__(self, other): return self.filename == other.filename
1006143Snate@binkert.org    def __ne__(self, other): return self.filename != other.filename
1016143Snate@binkert.org        
1026143Snate@binkert.orgclass Source(SourceFile):
1036143Snate@binkert.org    '''Add a c/c++ source file to the build'''
1046143Snate@binkert.org    def __init__(self, source, Werror=True, swig=False, bin_only=False,
1056143Snate@binkert.org                 skip_lib=False):
1066143Snate@binkert.org        super(Source, self).__init__(source)
1076143Snate@binkert.org
1086143Snate@binkert.org        self.Werror = Werror
1096143Snate@binkert.org        self.swig = swig
1106143Snate@binkert.org        self.bin_only = bin_only
1116143Snate@binkert.org        self.skip_lib = bin_only or skip_lib
1126143Snate@binkert.org
1136143Snate@binkert.orgclass PySource(SourceFile):
1146143Snate@binkert.org    '''Add a python source file to the named package'''
1155522Snate@binkert.org    invalid_sym_char = re.compile('[^A-z0-9_]')
1166143Snate@binkert.org    modules = {}
1176143Snate@binkert.org    tnodes = {}
1186143Snate@binkert.org    symnames = {}
1196143Snate@binkert.org    
1206143Snate@binkert.org    def __init__(self, package, source):
1216143Snate@binkert.org        super(PySource, self).__init__(source)
1226143Snate@binkert.org
1236143Snate@binkert.org        modname,ext = self.extname
1246143Snate@binkert.org        assert ext == 'py'
1256143Snate@binkert.org
1265522Snate@binkert.org        if package:
1275522Snate@binkert.org            path = package.split('.')
1285522Snate@binkert.org        else:
1295522Snate@binkert.org            path = []
1305604Snate@binkert.org
1315604Snate@binkert.org        modpath = path[:]
1326143Snate@binkert.org        if modname != '__init__':
1336143Snate@binkert.org            modpath += [ modname ]
1344762Snate@binkert.org        modpath = '.'.join(modpath)
1354762Snate@binkert.org
1366143Snate@binkert.org        arcpath = path + [ self.basename ]
1376727Ssteve.reinhardt@amd.com        abspath = self.snode.abspath
1386727Ssteve.reinhardt@amd.com        if not exists(abspath):
1396727Ssteve.reinhardt@amd.com            abspath = self.tnode.abspath
1404762Snate@binkert.org
1416143Snate@binkert.org        self.package = package
1426143Snate@binkert.org        self.modname = modname
1436143Snate@binkert.org        self.modpath = modpath
1446143Snate@binkert.org        self.arcname = joinpath(*arcpath)
1456727Ssteve.reinhardt@amd.com        self.abspath = abspath
1466143Snate@binkert.org        self.compiled = File(self.filename + 'c')
1477674Snate@binkert.org        self.cpp = File(self.filename + '.cc')
1487674Snate@binkert.org        self.symname = PySource.invalid_sym_char.sub('_', modpath)
1495604Snate@binkert.org
1506143Snate@binkert.org        PySource.modules[modpath] = self
1516143Snate@binkert.org        PySource.tnodes[self.tnode] = self
1526143Snate@binkert.org        PySource.symnames[self.symname] = self
1534762Snate@binkert.org
1546143Snate@binkert.orgclass SimObject(PySource):
1554762Snate@binkert.org    '''Add a SimObject python file as a python source object and add
1564762Snate@binkert.org    it to a list of sim object modules'''
1574762Snate@binkert.org
1586143Snate@binkert.org    fixed = False
1596143Snate@binkert.org    modnames = []
1604762Snate@binkert.org
1616143Snate@binkert.org    def __init__(self, source):
1626143Snate@binkert.org        super(SimObject, self).__init__('m5.objects', source)
1636143Snate@binkert.org        if self.fixed:
1646143Snate@binkert.org            raise AttributeError, "Too late to call SimObject now."
1654762Snate@binkert.org
1666143Snate@binkert.org        bisect.insort_right(SimObject.modnames, self.modname)
1674762Snate@binkert.org
1686143Snate@binkert.orgclass SwigSource(SourceFile):
1694762Snate@binkert.org    '''Add a swig file to build'''
1706143Snate@binkert.org
1716143Snate@binkert.org    def __init__(self, package, source):
1726143Snate@binkert.org        super(SwigSource, self).__init__(source)
1736143Snate@binkert.org
1746143Snate@binkert.org        modname,ext = self.extname
1756143Snate@binkert.org        assert ext == 'i'
1766143Snate@binkert.org
1776143Snate@binkert.org        self.module = modname
1786143Snate@binkert.org        cc_file = joinpath(self.dirname, modname + '_wrap.cc')
1796143Snate@binkert.org        py_file = joinpath(self.dirname, modname + '.py')
1806143Snate@binkert.org
1816143Snate@binkert.org        self.cc_source = Source(cc_file, swig=True)
1826143Snate@binkert.org        self.py_source = PySource(package, py_file)
183955SN/A
1845584Snate@binkert.orgunit_tests = []
1855584Snate@binkert.orgdef UnitTest(target, sources):
1865584Snate@binkert.org    if not isinstance(sources, (list, tuple)):
1875584Snate@binkert.org        sources = [ sources ]
1886143Snate@binkert.org
1896143Snate@binkert.org    sources = [ Source(src, skip_lib=True) for src in sources ]
1906143Snate@binkert.org    unit_tests.append((target, sources))
1915584Snate@binkert.org
1924382Sbinkertn@umich.edu# Children should have access
1934202Sbinkertn@umich.eduExport('Source')
1944382Sbinkertn@umich.eduExport('PySource')
1954382Sbinkertn@umich.eduExport('SimObject')
1964382Sbinkertn@umich.eduExport('SwigSource')
1975584Snate@binkert.orgExport('UnitTest')
1984382Sbinkertn@umich.edu
1994382Sbinkertn@umich.edu########################################################################
2004382Sbinkertn@umich.edu#
2015192Ssaidi@eecs.umich.edu# Trace Flags
2025192Ssaidi@eecs.umich.edu#
2035799Snate@binkert.orgtrace_flags = {}
2045799Snate@binkert.orgdef TraceFlag(name, desc=None):
2055799Snate@binkert.org    if name in trace_flags:
2065192Ssaidi@eecs.umich.edu        raise AttributeError, "Flag %s already specified" % name
2075799Snate@binkert.org    trace_flags[name] = (name, (), desc)
2085192Ssaidi@eecs.umich.edu
2095799Snate@binkert.orgdef CompoundFlag(name, flags, desc=None):
2105799Snate@binkert.org    if name in trace_flags:
2115192Ssaidi@eecs.umich.edu        raise AttributeError, "Flag %s already specified" % name
2125192Ssaidi@eecs.umich.edu
2135192Ssaidi@eecs.umich.edu    compound = tuple(flags)
2145799Snate@binkert.org    trace_flags[name] = (name, compound, desc)
2155192Ssaidi@eecs.umich.edu
2165192Ssaidi@eecs.umich.eduExport('TraceFlag')
2175192Ssaidi@eecs.umich.eduExport('CompoundFlag')
2185192Ssaidi@eecs.umich.edu
2195192Ssaidi@eecs.umich.edu########################################################################
2205192Ssaidi@eecs.umich.edu#
2214382Sbinkertn@umich.edu# Set some compiler variables
2224382Sbinkertn@umich.edu#
2234382Sbinkertn@umich.edu
2242667Sstever@eecs.umich.edu# Include file paths are rooted in this directory.  SCons will
2252667Sstever@eecs.umich.edu# automatically expand '.' to refer to both the source directory and
2262667Sstever@eecs.umich.edu# the corresponding build directory to pick up generated include
2272667Sstever@eecs.umich.edu# files.
2282667Sstever@eecs.umich.eduenv.Append(CPPPATH=Dir('.'))
2292667Sstever@eecs.umich.edu
2305742Snate@binkert.orgfor extra_dir in extras_dir_list:
2315742Snate@binkert.org    env.Append(CPPPATH=Dir(extra_dir))
2325742Snate@binkert.org
2335793Snate@binkert.org# Workaround for bug in SCons version > 0.97d20071212
2345793Snate@binkert.org# Scons bug id: 2006 M5 Bug id: 308 
2355793Snate@binkert.orgfor root, dirs, files in os.walk(base_dir, topdown=True):
2365793Snate@binkert.org    Dir(root[len(base_dir) + 1:])
2375793Snate@binkert.org
2384382Sbinkertn@umich.edu########################################################################
2394762Snate@binkert.org#
2405344Sstever@gmail.com# Walk the tree and execute all SConscripts in subdirectories
2414382Sbinkertn@umich.edu#
2425341Sstever@gmail.com
2435742Snate@binkert.orghere = Dir('.').srcnode().abspath
2445742Snate@binkert.orgfor root, dirs, files in os.walk(base_dir, topdown=True):
2455742Snate@binkert.org    if root == here:
2465742Snate@binkert.org        # we don't want to recurse back into this SConscript
2475742Snate@binkert.org        continue
2484762Snate@binkert.org
2495742Snate@binkert.org    if 'SConscript' in files:
2505742Snate@binkert.org        build_dir = joinpath(env['BUILDDIR'], root[len(base_dir) + 1:])
2517722Sgblack@eecs.umich.edu        SConscript(joinpath(root, 'SConscript'), variant_dir=build_dir)
2525742Snate@binkert.org
2535742Snate@binkert.orgfor extra_dir in extras_dir_list:
2545742Snate@binkert.org    prefix_len = len(dirname(extra_dir)) + 1
2555742Snate@binkert.org    for root, dirs, files in os.walk(extra_dir, topdown=True):
2565341Sstever@gmail.com        if 'SConscript' in files:
2575742Snate@binkert.org            build_dir = joinpath(env['BUILDDIR'], root[prefix_len:])
2587722Sgblack@eecs.umich.edu            SConscript(joinpath(root, 'SConscript'), variant_dir=build_dir)
2594773Snate@binkert.org
2606108Snate@binkert.orgfor opt in export_vars:
2611858SN/A    env.ConfigFile(opt)
2621085SN/A
2636658Snate@binkert.orgdef makeTheISA(source, target, env):
2646658Snate@binkert.org    isas = [ src.get_contents() for src in source ]
2657673Snate@binkert.org    target_isa = env['TARGET_ISA']
2666658Snate@binkert.org    def define(isa):
2676658Snate@binkert.org        return isa.upper() + '_ISA'
2686658Snate@binkert.org    
2696658Snate@binkert.org    def namespace(isa):
2706658Snate@binkert.org        return isa[0].upper() + isa[1:].lower() + 'ISA' 
2716658Snate@binkert.org
2726658Snate@binkert.org
2737673Snate@binkert.org    code = code_formatter()
2747673Snate@binkert.org    code('''\
2757673Snate@binkert.org#ifndef __CONFIG_THE_ISA_HH__
2767673Snate@binkert.org#define __CONFIG_THE_ISA_HH__
2777673Snate@binkert.org
2787673Snate@binkert.org''')
2797673Snate@binkert.org
2806658Snate@binkert.org    for i,isa in enumerate(isas):
2817673Snate@binkert.org        code('#define $0 $1', define(isa), i + 1)
2827673Snate@binkert.org
2837673Snate@binkert.org    code('''
2847673Snate@binkert.org
2857673Snate@binkert.org#define THE_ISA ${{define(target_isa)}}
2867673Snate@binkert.org#define TheISA ${{namespace(target_isa)}}
2877673Snate@binkert.org
2887673Snate@binkert.org#endif // __CONFIG_THE_ISA_HH__''')
2897673Snate@binkert.org
2907673Snate@binkert.org    code.write(str(target[0]))
2916658Snate@binkert.org
2927756SAli.Saidi@ARM.comenv.Command('config/the_isa.hh', map(Value, all_isa_list),
2937756SAli.Saidi@ARM.com            MakeAction(makeTheISA, " [ CFG ISA] $STRIP_TARGET"))
2946658Snate@binkert.org
2954382Sbinkertn@umich.edu########################################################################
2964382Sbinkertn@umich.edu#
2974762Snate@binkert.org# Prevent any SimObjects from being added after this point, they
2984762Snate@binkert.org# should all have been added in the SConscripts above
2994762Snate@binkert.org#
3006654Snate@binkert.orgSimObject.fixed = True
3016654Snate@binkert.org
3025517Snate@binkert.orgclass DictImporter(object):
3035517Snate@binkert.org    '''This importer takes a dictionary of arbitrary module names that
3045517Snate@binkert.org    map to arbitrary filenames.'''
3055517Snate@binkert.org    def __init__(self, modules):
3065517Snate@binkert.org        self.modules = modules
3075517Snate@binkert.org        self.installed = set()
3085517Snate@binkert.org
3095517Snate@binkert.org    def __del__(self):
3105517Snate@binkert.org        self.unload()
3115517Snate@binkert.org
3125517Snate@binkert.org    def unload(self):
3135517Snate@binkert.org        import sys
3145517Snate@binkert.org        for module in self.installed:
3155517Snate@binkert.org            del sys.modules[module]
3165517Snate@binkert.org        self.installed = set()
3175517Snate@binkert.org
3185517Snate@binkert.org    def find_module(self, fullname, path):
3196654Snate@binkert.org        if fullname == 'm5.defines':
3205517Snate@binkert.org            return self
3215517Snate@binkert.org
3225517Snate@binkert.org        if fullname == 'm5.objects':
3235517Snate@binkert.org            return self
3245517Snate@binkert.org
3255517Snate@binkert.org        if fullname.startswith('m5.internal'):
3265517Snate@binkert.org            return None
3275517Snate@binkert.org
3286143Snate@binkert.org        source = self.modules.get(fullname, None)
3296654Snate@binkert.org        if source is not None and fullname.startswith('m5.objects'):
3305517Snate@binkert.org            return self
3315517Snate@binkert.org
3325517Snate@binkert.org        return None
3335517Snate@binkert.org
3345517Snate@binkert.org    def load_module(self, fullname):
3355517Snate@binkert.org        mod = imp.new_module(fullname)
3365517Snate@binkert.org        sys.modules[fullname] = mod
3375517Snate@binkert.org        self.installed.add(fullname)
3385517Snate@binkert.org
3395517Snate@binkert.org        mod.__loader__ = self
3405517Snate@binkert.org        if fullname == 'm5.objects':
3415517Snate@binkert.org            mod.__path__ = fullname.split('.')
3425517Snate@binkert.org            return mod
3435517Snate@binkert.org
3446654Snate@binkert.org        if fullname == 'm5.defines':
3456654Snate@binkert.org            mod.__dict__['buildEnv'] = m5.util.SmartDict(build_env)
3465517Snate@binkert.org            return mod
3475517Snate@binkert.org
3486143Snate@binkert.org        source = self.modules[fullname]
3496143Snate@binkert.org        if source.modname == '__init__':
3506143Snate@binkert.org            mod.__path__ = source.modpath
3516727Ssteve.reinhardt@amd.com        mod.__file__ = source.abspath
3525517Snate@binkert.org
3536727Ssteve.reinhardt@amd.com        exec file(source.abspath, 'r') in mod.__dict__
3545517Snate@binkert.org
3555517Snate@binkert.org        return mod
3565517Snate@binkert.org
3576654Snate@binkert.orgimport m5.SimObject
3586654Snate@binkert.orgimport m5.params
3597673Snate@binkert.orgfrom m5.util import code_formatter
3606654Snate@binkert.org
3616654Snate@binkert.orgm5.SimObject.clear()
3626654Snate@binkert.orgm5.params.clear()
3636654Snate@binkert.org
3645517Snate@binkert.org# install the python importer so we can grab stuff from the source
3655517Snate@binkert.org# tree itself.  We can't have SimObjects added after this point or
3665517Snate@binkert.org# else we won't know about them for the rest of the stuff.
3676143Snate@binkert.orgimporter = DictImporter(PySource.modules)
3685517Snate@binkert.orgsys.meta_path[0:0] = [ importer ]
3694762Snate@binkert.org
3705517Snate@binkert.org# import all sim objects so we can populate the all_objects list
3715517Snate@binkert.org# make sure that we're working with a list, then let's sort it
3726143Snate@binkert.orgfor modname in SimObject.modnames:
3736143Snate@binkert.org    exec('from m5.objects import %s' % modname)
3745517Snate@binkert.org
3755517Snate@binkert.org# we need to unload all of the currently imported modules so that they
3765517Snate@binkert.org# will be re-imported the next time the sconscript is run
3775517Snate@binkert.orgimporter.unload()
3785517Snate@binkert.orgsys.meta_path.remove(importer)
3795517Snate@binkert.org
3805517Snate@binkert.orgsim_objects = m5.SimObject.allClasses
3815517Snate@binkert.orgall_enums = m5.params.allEnums
3825517Snate@binkert.org
3835517Snate@binkert.orgall_params = {}
3846143Snate@binkert.orgfor name,obj in sorted(sim_objects.iteritems()):
3855517Snate@binkert.org    for param in obj._params.local.values():
3866654Snate@binkert.org        # load the ptype attribute now because it depends on the
3876654Snate@binkert.org        # current version of SimObject.allClasses, but when scons
3886654Snate@binkert.org        # actually uses the value, all versions of
3896654Snate@binkert.org        # SimObject.allClasses will have been loaded
3906654Snate@binkert.org        param.ptype
3916654Snate@binkert.org
3925517Snate@binkert.org        if not hasattr(param, 'swig_decl'):
3935517Snate@binkert.org            continue
3945517Snate@binkert.org        pname = param.ptype_str
3955517Snate@binkert.org        if pname not in all_params:
3965517Snate@binkert.org            all_params[pname] = param
3974762Snate@binkert.org
3984762Snate@binkert.org########################################################################
3994762Snate@binkert.org#
4004762Snate@binkert.org# calculate extra dependencies
4014762Snate@binkert.org#
4024762Snate@binkert.orgmodule_depends = ["m5", "m5.SimObject", "m5.params"]
4037675Snate@binkert.orgdepends = [ PySource.modules[dep].snode for dep in module_depends ]
4044762Snate@binkert.org
4054762Snate@binkert.org########################################################################
4064762Snate@binkert.org#
4074762Snate@binkert.org# Commands for the basic automatically generated python files
4084382Sbinkertn@umich.edu#
4094382Sbinkertn@umich.edu
4105517Snate@binkert.org# Generate Python file containing a dict specifying the current
4116654Snate@binkert.org# buildEnv flags.
4125517Snate@binkert.orgdef makeDefinesPyFile(target, source, env):
4135798Snate@binkert.org    build_env, hg_info = [ x.get_contents() for x in source ]
4146654Snate@binkert.org
4157673Snate@binkert.org    code = code_formatter()
4166654Snate@binkert.org    code("""
4176654Snate@binkert.orgimport m5.internal
4186654Snate@binkert.orgimport m5.util
4196654Snate@binkert.org
4206654Snate@binkert.orgbuildEnv = m5.util.SmartDict($build_env)
4216654Snate@binkert.orghgRev = '$hg_info'
4226654Snate@binkert.org
4236654Snate@binkert.orgcompileDate = m5.internal.core.compileDate
4246669Snate@binkert.org_globals = globals()
4256669Snate@binkert.orgfor key,val in m5.internal.core.__dict__.iteritems():
4266669Snate@binkert.org    if key.startswith('flag_'):
4276669Snate@binkert.org        flag = key[5:]
4286669Snate@binkert.org        _globals[flag] = val
4296669Snate@binkert.orgdel _globals
4306654Snate@binkert.org""")
4317673Snate@binkert.org    code.write(target[0].abspath)
4325517Snate@binkert.org
4335863Snate@binkert.orgdefines_info = [ Value(build_env), Value(env['HG_INFO']) ]
4345798Snate@binkert.org# Generate a file with all of the compile options in it
4357756SAli.Saidi@ARM.comenv.Command('python/m5/defines.py', defines_info,
4367756SAli.Saidi@ARM.com            MakeAction(makeDefinesPyFile, " [ DEFINES] $STRIP_TARGET"))
4375798Snate@binkert.orgPySource('m5', 'python/m5/defines.py')
4385798Snate@binkert.org
4395517Snate@binkert.org# Generate python file containing info about the M5 source code
4405517Snate@binkert.orgdef makeInfoPyFile(target, source, env):
4417673Snate@binkert.org    code = code_formatter()
4425517Snate@binkert.org    for src in source:
4435517Snate@binkert.org        data = ''.join(file(src.srcnode().abspath, 'r').xreadlines())
4447673Snate@binkert.org        code('$src = ${{repr(data)}}')
4457673Snate@binkert.org    code.write(str(target[0]))
4465517Snate@binkert.org
4475798Snate@binkert.org# Generate a file that wraps the basic top level files
4485798Snate@binkert.orgenv.Command('python/m5/info.py',
4495798Snate@binkert.org            [ '#/AUTHORS', '#/LICENSE', '#/README', '#/RELEASE_NOTES' ],
4507756SAli.Saidi@ARM.com            MakeAction(makeInfoPyFile, " [    INFO] $STRIP_TARGET"))
4515798Snate@binkert.orgPySource('m5', 'python/m5/info.py')
4525798Snate@binkert.org
4534762Snate@binkert.org########################################################################
4544762Snate@binkert.org#
4554762Snate@binkert.org# Create all of the SimObject param headers and enum headers
4564762Snate@binkert.org#
4574762Snate@binkert.org
4585517Snate@binkert.orgdef createSimObjectParam(target, source, env):
4595517Snate@binkert.org    assert len(target) == 1 and len(source) == 1
4605517Snate@binkert.org
4615517Snate@binkert.org    name = str(source[0].get_contents())
4625517Snate@binkert.org    obj = sim_objects[name]
4635517Snate@binkert.org
4647673Snate@binkert.org    code = code_formatter()
4657673Snate@binkert.org    obj.cxx_decl(code)
4667673Snate@binkert.org    code.write(target[0].abspath)
4675517Snate@binkert.org
4685517Snate@binkert.orgdef createSwigParam(target, source, env):
4695517Snate@binkert.org    assert len(target) == 1 and len(source) == 1
4705517Snate@binkert.org
4715517Snate@binkert.org    name = str(source[0].get_contents())
4725517Snate@binkert.org    param = all_params[name]
4735517Snate@binkert.org
4747673Snate@binkert.org    code = code_formatter()
4757677Snate@binkert.org    code('%module(package="m5.internal") $0_${name}', param.file_ext)
4767673Snate@binkert.org    param.swig_decl(code)
4777673Snate@binkert.org    code.write(target[0].abspath)
4785517Snate@binkert.org
4795517Snate@binkert.orgdef createEnumStrings(target, source, env):
4805517Snate@binkert.org    assert len(target) == 1 and len(source) == 1
4815517Snate@binkert.org
4825517Snate@binkert.org    name = str(source[0].get_contents())
4835517Snate@binkert.org    obj = all_enums[name]
4845517Snate@binkert.org
4857673Snate@binkert.org    code = code_formatter()
4867673Snate@binkert.org    obj.cxx_def(code)
4877673Snate@binkert.org    code.write(target[0].abspath)
4885517Snate@binkert.org
4895517Snate@binkert.orgdef createEnumParam(target, source, env):
4905517Snate@binkert.org    assert len(target) == 1 and len(source) == 1
4915517Snate@binkert.org
4925517Snate@binkert.org    name = str(source[0].get_contents())
4935517Snate@binkert.org    obj = all_enums[name]
4945517Snate@binkert.org
4957673Snate@binkert.org    code = code_formatter()
4967673Snate@binkert.org    obj.cxx_decl(code)
4977673Snate@binkert.org    code.write(target[0].abspath)
4985517Snate@binkert.org
4997675Snate@binkert.orgdef createEnumSwig(target, source, env):
5007675Snate@binkert.org    assert len(target) == 1 and len(source) == 1
5017675Snate@binkert.org
5027675Snate@binkert.org    name = str(source[0].get_contents())
5037675Snate@binkert.org    obj = all_enums[name]
5047675Snate@binkert.org
5057675Snate@binkert.org    code = code_formatter()
5067675Snate@binkert.org    code('''\
5077677Snate@binkert.org%module(package="m5.internal") enum_$name
5087675Snate@binkert.org
5097675Snate@binkert.org%{
5107675Snate@binkert.org#include "enums/$name.hh"
5117675Snate@binkert.org%}
5127675Snate@binkert.org
5137675Snate@binkert.org%include "enums/$name.hh"
5147675Snate@binkert.org''')
5157675Snate@binkert.org    code.write(target[0].abspath)
5167675Snate@binkert.org
5174762Snate@binkert.org# Generate all of the SimObject param struct header files
5184762Snate@binkert.orgparams_hh_files = []
5196143Snate@binkert.orgfor name,simobj in sorted(sim_objects.iteritems()):
5206143Snate@binkert.org    py_source = PySource.modules[simobj.__module__]
5216143Snate@binkert.org    extra_deps = [ py_source.tnode ]
5224762Snate@binkert.org
5234762Snate@binkert.org    hh_file = File('params/%s.hh' % name)
5244762Snate@binkert.org    params_hh_files.append(hh_file)
5257756SAli.Saidi@ARM.com    env.Command(hh_file, Value(name),
5267756SAli.Saidi@ARM.com                MakeAction(createSimObjectParam, " [SO PARAM] $STRIP_TARGET"))
5274762Snate@binkert.org    env.Depends(hh_file, depends + extra_deps)
5284762Snate@binkert.org
5294762Snate@binkert.org# Generate any parameter header files needed
5305463Snate@binkert.orgparams_i_files = []
5315517Snate@binkert.orgfor name,param in all_params.iteritems():
5327677Snate@binkert.org    i_file = File('python/m5/internal/%s_%s.i' % (param.file_ext, name))
5335463Snate@binkert.org    params_i_files.append(i_file)
5347756SAli.Saidi@ARM.com    env.Command(i_file, Value(name),
5357756SAli.Saidi@ARM.com                MakeAction(createSwigParam, " [SW PARAM] $STRIP_TARGET"))
5364762Snate@binkert.org    env.Depends(i_file, depends)
5377677Snate@binkert.org    SwigSource('m5.internal', i_file)
5384762Snate@binkert.org
5394762Snate@binkert.org# Generate all enum header files
5406143Snate@binkert.orgfor name,enum in sorted(all_enums.iteritems()):
5416143Snate@binkert.org    py_source = PySource.modules[enum.__module__]
5426143Snate@binkert.org    extra_deps = [ py_source.tnode ]
5434762Snate@binkert.org
5444762Snate@binkert.org    cc_file = File('enums/%s.cc' % name)
5457756SAli.Saidi@ARM.com    env.Command(cc_file, Value(name),
5467756SAli.Saidi@ARM.com                MakeAction(createEnumStrings, " [ENUM STR] $STRIP_TARGET"))
5474762Snate@binkert.org    env.Depends(cc_file, depends + extra_deps)
5484762Snate@binkert.org    Source(cc_file)
5494762Snate@binkert.org
5504762Snate@binkert.org    hh_file = File('enums/%s.hh' % name)
5517756SAli.Saidi@ARM.com    env.Command(hh_file, Value(name),
5527756SAli.Saidi@ARM.com                MakeAction(createEnumParam, " [EN PARAM] $STRIP_TARGET"))
5534762Snate@binkert.org    env.Depends(hh_file, depends + extra_deps)
5544762Snate@binkert.org
5557677Snate@binkert.org    i_file = File('python/m5/internal/enum_%s.i' % name)
5567756SAli.Saidi@ARM.com    env.Command(i_file, Value(name),
5577756SAli.Saidi@ARM.com                MakeAction(createEnumSwig, " [ENUMSWIG] $STRIP_TARGET"))
5587675Snate@binkert.org    env.Depends(i_file, depends + extra_deps)
5597677Snate@binkert.org    SwigSource('m5.internal', i_file)
5605517Snate@binkert.org
5617675Snate@binkert.orgdef buildParam(target, source, env):
5627675Snate@binkert.org    name = source[0].get_contents()
5637675Snate@binkert.org    obj = sim_objects[name]
5647675Snate@binkert.org    class_path = obj.cxx_class.split('::')
5657675Snate@binkert.org    classname = class_path[-1]
5667675Snate@binkert.org    namespaces = class_path[:-1]
5677675Snate@binkert.org    params = obj._params.local.values()
5685517Snate@binkert.org
5697673Snate@binkert.org    code = code_formatter()
5705517Snate@binkert.org
5717677Snate@binkert.org    code('%module(package="m5.internal") param_$name')
5727675Snate@binkert.org    code()
5737673Snate@binkert.org    code('%{')
5747675Snate@binkert.org    code('#include "params/$obj.hh"')
5757675Snate@binkert.org    for param in params:
5767675Snate@binkert.org        param.cxx_predecls(code)
5777673Snate@binkert.org    code('%}')
5787675Snate@binkert.org    code()
5795517Snate@binkert.org
5807675Snate@binkert.org    for param in params:
5817675Snate@binkert.org        param.swig_predecls(code)
5827673Snate@binkert.org
5837675Snate@binkert.org    code()
5847675Snate@binkert.org    if obj._base:
5857677Snate@binkert.org        code('%import "python/m5/internal/param_${{obj._base}}.i"')
5867675Snate@binkert.org    code()
5877675Snate@binkert.org    obj.swig_objdecls(code)
5887675Snate@binkert.org    code()
5895517Snate@binkert.org
5907675Snate@binkert.org    code('%include "params/$obj.hh"')
5915517Snate@binkert.org
5927673Snate@binkert.org    code.write(target[0].abspath)
5935517Snate@binkert.org
5947675Snate@binkert.orgfor name in sim_objects.iterkeys():
5957677Snate@binkert.org    params_file = File('python/m5/internal/param_%s.i' % name)
5967756SAli.Saidi@ARM.com    env.Command(params_file, Value(name),
5977756SAli.Saidi@ARM.com                MakeAction(buildParam, " [BLDPARAM] $STRIP_TARGET"))
5987675Snate@binkert.org    env.Depends(params_file, depends)
5997677Snate@binkert.org    SwigSource('m5.internal', params_file)
6004762Snate@binkert.org
6017674Snate@binkert.org# Generate the main swig init file
6027674Snate@binkert.orgdef makeEmbeddedSwigInit(target, source, env):
6037674Snate@binkert.org    code = code_formatter()
6047674Snate@binkert.org    module = source[0].get_contents()
6057674Snate@binkert.org    code('''\
6067674Snate@binkert.org#include "sim/init.hh"
6077674Snate@binkert.org
6087674Snate@binkert.orgextern "C" {
6097674Snate@binkert.org    void init_${module}();
6107674Snate@binkert.org}
6117674Snate@binkert.org
6127674Snate@binkert.orgEmbeddedSwig embed_swig_${module}(init_${module});
6137674Snate@binkert.org''')
6147674Snate@binkert.org    code.write(str(target[0]))
6157674Snate@binkert.org    
6164762Snate@binkert.org# Build all swig modules
6176143Snate@binkert.orgfor swig in SwigSource.all:
6186143Snate@binkert.org    env.Command([swig.cc_source.tnode, swig.py_source.tnode], swig.tnode,
6197756SAli.Saidi@ARM.com                MakeAction('$SWIG $SWIGFLAGS -outdir ${TARGETS[1].dir} '
6207756SAli.Saidi@ARM.com                '-o ${TARGETS[0]} $SOURCES', " [    SWIG] $STRIP_TARGET"))
6217674Snate@binkert.org    init_file = 'python/swig/init_%s.cc' % swig.module
6227756SAli.Saidi@ARM.com    env.Command(init_file, Value(swig.module),
6237756SAli.Saidi@ARM.com                MakeAction(makeEmbeddedSwigInit, " [EMBED SW] $STRIP_TARGET"))
6247674Snate@binkert.org    Source(init_file)
6254382Sbinkertn@umich.edu
6266229Snate@binkert.orgdef getFlags(source_flags):
6276229Snate@binkert.org    flagsMap = {}
6286229Snate@binkert.org    flagsList = []
6296229Snate@binkert.org    for s in source_flags:
6306229Snate@binkert.org        val = eval(s.get_contents())
6316229Snate@binkert.org        name, compound, desc = val
6326229Snate@binkert.org        flagsList.append(val)
6336229Snate@binkert.org        flagsMap[name] = bool(compound)
6346229Snate@binkert.org    
6356229Snate@binkert.org    for name, compound, desc in flagsList:
6366229Snate@binkert.org        for flag in compound:
6376229Snate@binkert.org            if flag not in flagsMap:
6386229Snate@binkert.org                raise AttributeError, "Trace flag %s not found" % flag
6396229Snate@binkert.org            if flagsMap[flag]:
6406229Snate@binkert.org                raise AttributeError, \
6416229Snate@binkert.org                    "Compound flag can't point to another compound flag"
6426229Snate@binkert.org
6436229Snate@binkert.org    flagsList.sort()
6446229Snate@binkert.org    return flagsList
6456229Snate@binkert.org
6466229Snate@binkert.org
6475192Ssaidi@eecs.umich.edu# Generate traceflags.py
6485517Snate@binkert.orgdef traceFlagsPy(target, source, env):
6495517Snate@binkert.org    assert(len(target) == 1)
6507673Snate@binkert.org    code = code_formatter()
6515517Snate@binkert.org
6526229Snate@binkert.org    allFlags = getFlags(source)
6535799Snate@binkert.org
6547673Snate@binkert.org    code('basic = [')
6557673Snate@binkert.org    code.indent()
6565517Snate@binkert.org    for flag, compound, desc in allFlags:
6575517Snate@binkert.org        if not compound:
6587673Snate@binkert.org            code("'$flag',")
6597673Snate@binkert.org    code(']')
6607673Snate@binkert.org    code.dedent()
6617673Snate@binkert.org    code()
6625517Snate@binkert.org
6637673Snate@binkert.org    code('compound = [')
6647673Snate@binkert.org    code.indent()
6657673Snate@binkert.org    code("'All',")
6665517Snate@binkert.org    for flag, compound, desc in allFlags:
6675517Snate@binkert.org        if compound:
6687673Snate@binkert.org            code("'$flag',")
6697673Snate@binkert.org    code("]")
6707673Snate@binkert.org    code.dedent()
6717673Snate@binkert.org    code()
6725517Snate@binkert.org
6737673Snate@binkert.org    code("all = frozenset(basic + compound)")
6747673Snate@binkert.org    code()
6755517Snate@binkert.org
6767673Snate@binkert.org    code('compoundMap = {')
6777673Snate@binkert.org    code.indent()
6785517Snate@binkert.org    all = tuple([flag for flag,compound,desc in allFlags if not compound])
6797673Snate@binkert.org    code("'All' : $all,")
6805517Snate@binkert.org    for flag, compound, desc in allFlags:
6815517Snate@binkert.org        if compound:
6827673Snate@binkert.org            code("'$flag' : $compound,")
6837673Snate@binkert.org    code('}')
6847673Snate@binkert.org    code.dedent()
6857673Snate@binkert.org    code()
6865517Snate@binkert.org
6877673Snate@binkert.org    code('descriptions = {')
6887673Snate@binkert.org    code.indent()
6897673Snate@binkert.org    code("'All' : 'All flags',")
6905517Snate@binkert.org    for flag, compound, desc in allFlags:
6917673Snate@binkert.org        code("'$flag' : '$desc',")
6927673Snate@binkert.org    code("}")
6937673Snate@binkert.org    code.dedent()
6945517Snate@binkert.org
6957673Snate@binkert.org    code.write(str(target[0]))
6965517Snate@binkert.org
6975517Snate@binkert.orgdef traceFlagsCC(target, source, env):
6985517Snate@binkert.org    assert(len(target) == 1)
6995517Snate@binkert.org
7006229Snate@binkert.org    allFlags = getFlags(source)
7017673Snate@binkert.org    code = code_formatter()
7025517Snate@binkert.org
7035517Snate@binkert.org    # file header
7047673Snate@binkert.org    code('''
7055517Snate@binkert.org/*
7065517Snate@binkert.org * DO NOT EDIT THIS FILE! Automatically generated
7075517Snate@binkert.org */
7085517Snate@binkert.org
7095517Snate@binkert.org#include "base/traceflags.hh"
7105517Snate@binkert.org
7115517Snate@binkert.orgusing namespace Trace;
7125517Snate@binkert.org
7135517Snate@binkert.orgconst char *Trace::flagStrings[] =
7147673Snate@binkert.org{''')
7155517Snate@binkert.org
7167673Snate@binkert.org    code.indent()
7175517Snate@binkert.org    # The string array is used by SimpleEnumParam to map the strings
7185517Snate@binkert.org    # provided by the user to enum values.
7195517Snate@binkert.org    for flag, compound, desc in allFlags:
7205517Snate@binkert.org        if not compound:
7217673Snate@binkert.org            code('"$flag",')
7225517Snate@binkert.org
7237673Snate@binkert.org    code('"All",')
7245517Snate@binkert.org    for flag, compound, desc in allFlags:
7255517Snate@binkert.org        if compound:
7267673Snate@binkert.org            code('"$flag",')
7277673Snate@binkert.org    code.dedent()
7285517Snate@binkert.org
7297673Snate@binkert.org    code('''\
7307673Snate@binkert.org};
7315517Snate@binkert.org
7327673Snate@binkert.orgconst int Trace::numFlagStrings = ${{len(allFlags) + 1}};
7337673Snate@binkert.org
7347673Snate@binkert.org''')
7357673Snate@binkert.org
7365517Snate@binkert.org    # Now define the individual compound flag arrays.  There is an array
7375517Snate@binkert.org    # for each compound flag listing the component base flags.
7385517Snate@binkert.org    all = tuple([flag for flag,compound,desc in allFlags if not compound])
7397673Snate@binkert.org    code('static const Flags AllMap[] = {')
7407673Snate@binkert.org    code.indent()
7415517Snate@binkert.org    for flag, compound, desc in allFlags:
7425517Snate@binkert.org        if not compound:
7437673Snate@binkert.org            code('$flag,')
7447673Snate@binkert.org    code.dedent()
7457673Snate@binkert.org    code('};')
7467673Snate@binkert.org    code()
7475517Snate@binkert.org
7485517Snate@binkert.org    for flag, compound, desc in allFlags:
7495517Snate@binkert.org        if not compound:
7505517Snate@binkert.org            continue
7517673Snate@binkert.org        code('static const Flags ${flag}Map[] = {')
7527673Snate@binkert.org        code.indent()
7535517Snate@binkert.org        for flag in compound:
7547673Snate@binkert.org            code('$flag,')
7557673Snate@binkert.org        code('(Flags)-1')
7567673Snate@binkert.org        code.dedent()
7577673Snate@binkert.org        code('};')
7587673Snate@binkert.org        code()
7595517Snate@binkert.org
7605517Snate@binkert.org    # Finally the compoundFlags[] array maps the compound flags
7615517Snate@binkert.org    # to their individual arrays/
7627673Snate@binkert.org    code('const Flags *Trace::compoundFlags[] = {')
7637673Snate@binkert.org    code.indent()
7647673Snate@binkert.org    code('AllMap,')
7655517Snate@binkert.org    for flag, compound, desc in allFlags:
7665517Snate@binkert.org        if compound:
7677673Snate@binkert.org            code('${flag}Map,')
7685517Snate@binkert.org    # file trailer
7697673Snate@binkert.org    code.dedent()
7707673Snate@binkert.org    code('};')
7715517Snate@binkert.org
7727673Snate@binkert.org    code.write(str(target[0]))
7735517Snate@binkert.org
7745517Snate@binkert.orgdef traceFlagsHH(target, source, env):
7755517Snate@binkert.org    assert(len(target) == 1)
7765517Snate@binkert.org
7776229Snate@binkert.org    allFlags = getFlags(source)
7787673Snate@binkert.org    code = code_formatter()
7795517Snate@binkert.org
7805517Snate@binkert.org    # file header boilerplate
7817673Snate@binkert.org    code('''\
7825517Snate@binkert.org/*
7835517Snate@binkert.org * DO NOT EDIT THIS FILE!
7845517Snate@binkert.org *
7855517Snate@binkert.org * Automatically generated from traceflags.py
7865517Snate@binkert.org */
7875517Snate@binkert.org
7885517Snate@binkert.org#ifndef __BASE_TRACE_FLAGS_HH__
7895517Snate@binkert.org#define __BASE_TRACE_FLAGS_HH__
7905517Snate@binkert.org
7915517Snate@binkert.orgnamespace Trace {
7925517Snate@binkert.org
7937673Snate@binkert.orgenum Flags {''')
7945517Snate@binkert.org
7955517Snate@binkert.org    # Generate the enum.  Base flags come first, then compound flags.
7965517Snate@binkert.org    idx = 0
7977673Snate@binkert.org    code.indent()
7985517Snate@binkert.org    for flag, compound, desc in allFlags:
7995517Snate@binkert.org        if not compound:
8007673Snate@binkert.org            code('$flag = $idx,')
8015517Snate@binkert.org            idx += 1
8025517Snate@binkert.org
8035517Snate@binkert.org    numBaseFlags = idx
8047673Snate@binkert.org    code('NumFlags = $idx,')
8057673Snate@binkert.org    code.dedent()
8067673Snate@binkert.org    code()
8075517Snate@binkert.org
8085517Snate@binkert.org    # put a comment in here to separate base from compound flags
8097673Snate@binkert.org    code('''
8105517Snate@binkert.org// The remaining enum values are *not* valid indices for Trace::flags.
8115517Snate@binkert.org// They are "compound" flags, which correspond to sets of base
8127673Snate@binkert.org// flags, and are used by changeFlag.''')
8135517Snate@binkert.org
8147673Snate@binkert.org    code.indent()
8157673Snate@binkert.org    code('All = $idx,')
8165517Snate@binkert.org    idx += 1
8175517Snate@binkert.org    for flag, compound, desc in allFlags:
8185517Snate@binkert.org        if compound:
8197673Snate@binkert.org            code('$flag = $idx,')
8205517Snate@binkert.org            idx += 1
8215517Snate@binkert.org
8225517Snate@binkert.org    numCompoundFlags = idx - numBaseFlags
8237673Snate@binkert.org    code('NumCompoundFlags = $numCompoundFlags')
8247673Snate@binkert.org    code.dedent()
8255517Snate@binkert.org
8265517Snate@binkert.org    # trailer boilerplate
8277673Snate@binkert.org    code('''\
8285517Snate@binkert.org}; // enum Flags
8295517Snate@binkert.org
8305517Snate@binkert.org// Array of strings for SimpleEnumParam
8315517Snate@binkert.orgextern const char *flagStrings[];
8325517Snate@binkert.orgextern const int numFlagStrings;
8335517Snate@binkert.org
8345517Snate@binkert.org// Array of arraay pointers: for each compound flag, gives the list of
8355517Snate@binkert.org// base flags to set.  Inidividual flag arrays are terminated by -1.
8365517Snate@binkert.orgextern const Flags *compoundFlags[];
8375517Snate@binkert.org
8387811Ssteve.reinhardt@amd.com} // namespace Trace
8395517Snate@binkert.org
8405517Snate@binkert.org#endif // __BASE_TRACE_FLAGS_HH__
8417673Snate@binkert.org''')
8425517Snate@binkert.org
8437673Snate@binkert.org    code.write(str(target[0]))
8445517Snate@binkert.org
8456143Snate@binkert.orgflags = map(Value, trace_flags.values())
8467756SAli.Saidi@ARM.comenv.Command('base/traceflags.py', flags, 
8477756SAli.Saidi@ARM.com            MakeAction(traceFlagsPy, " [ TRACING] $STRIP_TARGET"))
8485192Ssaidi@eecs.umich.eduPySource('m5', 'base/traceflags.py')
8495192Ssaidi@eecs.umich.edu
8507756SAli.Saidi@ARM.comenv.Command('base/traceflags.hh', flags,
8517756SAli.Saidi@ARM.com            MakeAction(traceFlagsHH, " [ TRACING] $STRIP_TARGET"))
8527756SAli.Saidi@ARM.comenv.Command('base/traceflags.cc', flags, 
8537756SAli.Saidi@ARM.com            MakeAction(traceFlagsCC, " [ TRACING] $STRIP_TARGET"))
8545192Ssaidi@eecs.umich.eduSource('base/traceflags.cc')
8555192Ssaidi@eecs.umich.edu
8567674Snate@binkert.org# Embed python files.  All .py files that have been indicated by a
8575522Snate@binkert.org# PySource() call in a SConscript need to be embedded into the M5
8585522Snate@binkert.org# library.  To do that, we compile the file to byte code, marshal the
8597674Snate@binkert.org# byte code, compress it, and then generate a c++ file that
8607674Snate@binkert.org# inserts the result into an array.
8617674Snate@binkert.orgdef embedPyFile(target, source, env):
8627674Snate@binkert.org    def c_str(string):
8637674Snate@binkert.org        if string is None:
8647674Snate@binkert.org            return "0"
8657674Snate@binkert.org        return '"%s"' % string
8667674Snate@binkert.org
8675522Snate@binkert.org    '''Action function to compile a .py into a code object, marshal
8685522Snate@binkert.org    it, compress it, and stick it into an asm file so the code appears
8695522Snate@binkert.org    as just bytes with a label in the data section'''
8705517Snate@binkert.org
8715522Snate@binkert.org    src = file(str(source[0]), 'r').read()
8725517Snate@binkert.org
8736143Snate@binkert.org    pysource = PySource.tnodes[source[0]]
8746727Ssteve.reinhardt@amd.com    compiled = compile(src, pysource.abspath, 'exec')
8755522Snate@binkert.org    marshalled = marshal.dumps(compiled)
8765522Snate@binkert.org    compressed = zlib.compress(marshalled)
8775522Snate@binkert.org    data = compressed
8787674Snate@binkert.org    sym = pysource.symname
8795517Snate@binkert.org
8807673Snate@binkert.org    code = code_formatter()
8817673Snate@binkert.org    code('''\
8827674Snate@binkert.org#include "sim/init.hh"
8837673Snate@binkert.org
8847674Snate@binkert.orgnamespace {
8857674Snate@binkert.org
8867674Snate@binkert.orgconst char data_${sym}[] = {
8877674Snate@binkert.org''')
8887674Snate@binkert.org    code.indent()
8897674Snate@binkert.org    step = 16
8905522Snate@binkert.org    for i in xrange(0, len(data), step):
8915522Snate@binkert.org        x = array.array('B', data[i:i+step])
8927674Snate@binkert.org        code(''.join('%d,' % d for d in x))
8937674Snate@binkert.org    code.dedent()
8947674Snate@binkert.org    
8957674Snate@binkert.org    code('''};
8967673Snate@binkert.org
8977674Snate@binkert.orgEmbeddedPython embedded_${sym}(
8987674Snate@binkert.org    ${{c_str(pysource.arcname)}},
8997674Snate@binkert.org    ${{c_str(pysource.abspath)}},
9007674Snate@binkert.org    ${{c_str(pysource.modpath)}},
9017674Snate@binkert.org    data_${sym},
9027674Snate@binkert.org    ${{len(data)}},
9037674Snate@binkert.org    ${{len(marshalled)}});
9047674Snate@binkert.org
9057811Ssteve.reinhardt@amd.com} // anonymous namespace
9067674Snate@binkert.org''')
9077673Snate@binkert.org    code.write(str(target[0]))
9085522Snate@binkert.org
9096143Snate@binkert.orgfor source in PySource.all:
9107756SAli.Saidi@ARM.com    env.Command(source.cpp, source.tnode, 
9117756SAli.Saidi@ARM.com                MakeAction(embedPyFile, " [EMBED PY] $STRIP_TARGET"))
9127674Snate@binkert.org    Source(source.cpp)
9134382Sbinkertn@umich.edu
9144382Sbinkertn@umich.edu########################################################################
9154382Sbinkertn@umich.edu#
9164382Sbinkertn@umich.edu# Define binaries.  Each different build type (debug, opt, etc.) gets
9174382Sbinkertn@umich.edu# a slightly different build environment.
9184382Sbinkertn@umich.edu#
9194382Sbinkertn@umich.edu
9204382Sbinkertn@umich.edu# List of constructed environments to pass back to SConstruct
9214382Sbinkertn@umich.eduenvList = []
9224382Sbinkertn@umich.edu
9236143Snate@binkert.orgdate_source = Source('base/date.cc', skip_lib=True)
924955SN/A
9252655Sstever@eecs.umich.edu# Function to create a new build environment as clone of current
9262655Sstever@eecs.umich.edu# environment 'env' with modified object suffix and optional stripped
9272655Sstever@eecs.umich.edu# binary.  Additional keyword arguments are appended to corresponding
9282655Sstever@eecs.umich.edu# build environment vars.
9292655Sstever@eecs.umich.edudef makeEnv(label, objsfx, strip = False, **kwargs):
9305601Snate@binkert.org    # SCons doesn't know to append a library suffix when there is a '.' in the
9315601Snate@binkert.org    # name.  Use '_' instead.
9325601Snate@binkert.org    libname = 'm5_' + label
9335601Snate@binkert.org    exename = 'm5.' + label
9345522Snate@binkert.org
9355863Snate@binkert.org    new_env = env.Clone(OBJSUFFIX=objsfx, SHOBJSUFFIX=objsfx + 's')
9365601Snate@binkert.org    new_env.Label = label
9375601Snate@binkert.org    new_env.Append(**kwargs)
9385601Snate@binkert.org
9395863Snate@binkert.org    swig_env = new_env.Clone()
9406143Snate@binkert.org    swig_env.Append(CCFLAGS='-Werror')
9415559Snate@binkert.org    if env['GCC']:
9425559Snate@binkert.org        swig_env.Append(CCFLAGS='-Wno-uninitialized')
9435559Snate@binkert.org        swig_env.Append(CCFLAGS='-Wno-sign-compare')
9445559Snate@binkert.org        swig_env.Append(CCFLAGS='-Wno-parentheses')
9455601Snate@binkert.org
9466143Snate@binkert.org    werror_env = new_env.Clone()
9476143Snate@binkert.org    werror_env.Append(CCFLAGS='-Werror')
9486143Snate@binkert.org
9496143Snate@binkert.org    def make_obj(source, static, extra_deps = None):
9506143Snate@binkert.org        '''This function adds the specified source to the correct
9516143Snate@binkert.org        build environment, and returns the corresponding SCons Object
9526143Snate@binkert.org        nodes'''
9536143Snate@binkert.org
9546143Snate@binkert.org        if source.swig:
9556143Snate@binkert.org            env = swig_env
9566143Snate@binkert.org        elif source.Werror:
9576143Snate@binkert.org            env = werror_env
9586143Snate@binkert.org        else:
9596143Snate@binkert.org            env = new_env
9606143Snate@binkert.org
9616143Snate@binkert.org        if static:
9626143Snate@binkert.org            obj = env.StaticObject(source.tnode)
9636143Snate@binkert.org        else:
9646143Snate@binkert.org            obj = env.SharedObject(source.tnode)
9656143Snate@binkert.org
9666143Snate@binkert.org        if extra_deps:
9676143Snate@binkert.org            env.Depends(obj, extra_deps)
9686143Snate@binkert.org
9696143Snate@binkert.org        return obj
9706143Snate@binkert.org
9716143Snate@binkert.org    static_objs = [ make_obj(s, True) for s in Source.get(skip_lib=False)]
9726143Snate@binkert.org    shared_objs = [ make_obj(s, False) for s in Source.get(skip_lib=False)]
9736143Snate@binkert.org
9746143Snate@binkert.org    static_date = make_obj(date_source, static=True, extra_deps=static_objs)
9756143Snate@binkert.org    static_objs.append(static_date)
9766143Snate@binkert.org    
9776143Snate@binkert.org    shared_date = make_obj(date_source, static=False, extra_deps=shared_objs)
9786240Snate@binkert.org    shared_objs.append(shared_date)
9795554Snate@binkert.org
9805522Snate@binkert.org    # First make a library of everything but main() so other programs can
9815522Snate@binkert.org    # link against m5.
9825797Snate@binkert.org    static_lib = new_env.StaticLibrary(libname, static_objs)
9835797Snate@binkert.org    shared_lib = new_env.SharedLibrary(libname, shared_objs)
9845522Snate@binkert.org
9855584Snate@binkert.org    for target, sources in unit_tests:
9866143Snate@binkert.org        objs = [ make_obj(s, static=True) for s in sources ]
9875862Snate@binkert.org        new_env.Program("unittest/%s.%s" % (target, label), objs + static_objs)
9885584Snate@binkert.org
9895601Snate@binkert.org    # Now link a stub with main() and the static library.
9906143Snate@binkert.org    bin_objs = [make_obj(s, True) for s in Source.get(bin_only=True) ]
9916143Snate@binkert.org    progname = exename
9922655Sstever@eecs.umich.edu    if strip:
9936143Snate@binkert.org        progname += '.unstripped'
9946143Snate@binkert.org
9956143Snate@binkert.org    targets = new_env.Program(progname, bin_objs + static_objs)
9966143Snate@binkert.org
9976143Snate@binkert.org    if strip:
9984007Ssaidi@eecs.umich.edu        if sys.platform == 'sunos5':
9994596Sbinkertn@umich.edu            cmd = 'cp $SOURCE $TARGET; strip $TARGET'
10004007Ssaidi@eecs.umich.edu        else:
10014596Sbinkertn@umich.edu            cmd = 'strip $SOURCE -o $TARGET'
10027756SAli.Saidi@ARM.com        targets = new_env.Command(exename, progname,
10037756SAli.Saidi@ARM.com                    MakeAction(cmd, " [   STRIP] $STRIP_TARGET"))
10045522Snate@binkert.org            
10055601Snate@binkert.org    new_env.M5Binary = targets[0]
10065601Snate@binkert.org    envList.append(new_env)
10072655Sstever@eecs.umich.edu
1008955SN/A# Debug binary
10093918Ssaidi@eecs.umich.educcflags = {}
10103918Ssaidi@eecs.umich.eduif env['GCC']:
10113918Ssaidi@eecs.umich.edu    if sys.platform == 'sunos5':
10123918Ssaidi@eecs.umich.edu        ccflags['debug'] = '-gstabs+'
10133918Ssaidi@eecs.umich.edu    else:
10143918Ssaidi@eecs.umich.edu        ccflags['debug'] = '-ggdb3'
10153918Ssaidi@eecs.umich.edu    ccflags['opt'] = '-g -O3'
10163918Ssaidi@eecs.umich.edu    ccflags['fast'] = '-O3'
10173918Ssaidi@eecs.umich.edu    ccflags['prof'] = '-O3 -g -pg'
10183918Ssaidi@eecs.umich.eduelif env['SUNCC']:
10193918Ssaidi@eecs.umich.edu    ccflags['debug'] = '-g0'
10203918Ssaidi@eecs.umich.edu    ccflags['opt'] = '-g -O'
10213918Ssaidi@eecs.umich.edu    ccflags['fast'] = '-fast'
10223918Ssaidi@eecs.umich.edu    ccflags['prof'] = '-fast -g -pg'
10233940Ssaidi@eecs.umich.eduelif env['ICC']:
10243940Ssaidi@eecs.umich.edu    ccflags['debug'] = '-g -O0'
10253940Ssaidi@eecs.umich.edu    ccflags['opt'] = '-g -O'
10263942Ssaidi@eecs.umich.edu    ccflags['fast'] = '-fast'
10273940Ssaidi@eecs.umich.edu    ccflags['prof'] = '-fast -g -pg'
10283515Ssaidi@eecs.umich.eduelse:
10293918Ssaidi@eecs.umich.edu    print 'Unknown compiler, please fix compiler options'
10304762Snate@binkert.org    Exit(1)
10313515Ssaidi@eecs.umich.edu
10322655Sstever@eecs.umich.edumakeEnv('debug', '.do',
10333918Ssaidi@eecs.umich.edu        CCFLAGS = Split(ccflags['debug']),
10343619Sbinkertn@umich.edu        CPPDEFINES = ['DEBUG', 'TRACING_ON=1'])
1035955SN/A
1036955SN/A# Optimized binary
10372655Sstever@eecs.umich.edumakeEnv('opt', '.o',
10383918Ssaidi@eecs.umich.edu        CCFLAGS = Split(ccflags['opt']),
10393619Sbinkertn@umich.edu        CPPDEFINES = ['TRACING_ON=1'])
1040955SN/A
1041955SN/A# "Fast" binary
10422655Sstever@eecs.umich.edumakeEnv('fast', '.fo', strip = True,
10433918Ssaidi@eecs.umich.edu        CCFLAGS = Split(ccflags['fast']),
10443619Sbinkertn@umich.edu        CPPDEFINES = ['NDEBUG', 'TRACING_ON=0'])
1045955SN/A
1046955SN/A# Profiled binary
10472655Sstever@eecs.umich.edumakeEnv('prof', '.po',
10483918Ssaidi@eecs.umich.edu        CCFLAGS = Split(ccflags['prof']),
10493683Sstever@eecs.umich.edu        CPPDEFINES = ['NDEBUG', 'TRACING_ON=0'],
10502655Sstever@eecs.umich.edu        LINKFLAGS = '-pg')
10511869SN/A
10521869SN/AReturn('envList')
1053