SConscript revision 6654
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
546143Snate@binkert.org########################################################################
556143Snate@binkert.org# Code for adding source files of various types
566143Snate@binkert.org#
576143Snate@binkert.orgclass SourceMeta(type):
586143Snate@binkert.org    def __init__(cls, name, bases, dict):
596143Snate@binkert.org        super(SourceMeta, cls).__init__(name, bases, dict)
606143Snate@binkert.org        cls.all = []
616143Snate@binkert.org        
626143Snate@binkert.org    def get(cls, **kwargs):
636143Snate@binkert.org        for src in cls.all:
646143Snate@binkert.org            for attr,value in kwargs.iteritems():
656143Snate@binkert.org                if getattr(src, attr) != value:
666143Snate@binkert.org                    break
676143Snate@binkert.org            else:
686143Snate@binkert.org                yield src
694762Snate@binkert.org
706143Snate@binkert.orgclass SourceFile(object):
716143Snate@binkert.org    __metaclass__ = SourceMeta
726143Snate@binkert.org    def __init__(self, source):
736143Snate@binkert.org        tnode = source
746143Snate@binkert.org        if not isinstance(source, SCons.Node.FS.File):
756143Snate@binkert.org            tnode = File(source)
766143Snate@binkert.org
776143Snate@binkert.org        self.tnode = tnode
786143Snate@binkert.org        self.snode = tnode.srcnode()
796143Snate@binkert.org        self.filename = str(tnode)
806143Snate@binkert.org        self.dirname = dirname(self.filename)
816143Snate@binkert.org        self.basename = basename(self.filename)
826143Snate@binkert.org        index = self.basename.rfind('.')
836143Snate@binkert.org        if index <= 0:
846143Snate@binkert.org            # dot files aren't extensions
856143Snate@binkert.org            self.extname = self.basename, None
866143Snate@binkert.org        else:
876143Snate@binkert.org            self.extname = self.basename[:index], self.basename[index+1:]
886143Snate@binkert.org
896143Snate@binkert.org        for base in type(self).__mro__:
906143Snate@binkert.org            if issubclass(base, SourceFile):
916143Snate@binkert.org                bisect.insort_right(base.all, self)       
926143Snate@binkert.org
936143Snate@binkert.org    def __lt__(self, other): return self.filename < other.filename
946143Snate@binkert.org    def __le__(self, other): return self.filename <= other.filename
956143Snate@binkert.org    def __gt__(self, other): return self.filename > other.filename
966143Snate@binkert.org    def __ge__(self, other): return self.filename >= other.filename
976143Snate@binkert.org    def __eq__(self, other): return self.filename == other.filename
986143Snate@binkert.org    def __ne__(self, other): return self.filename != other.filename
996143Snate@binkert.org        
1006143Snate@binkert.orgclass Source(SourceFile):
1016143Snate@binkert.org    '''Add a c/c++ source file to the build'''
1026143Snate@binkert.org    def __init__(self, source, Werror=True, swig=False, bin_only=False,
1036143Snate@binkert.org                 skip_lib=False):
1046143Snate@binkert.org        super(Source, self).__init__(source)
1056143Snate@binkert.org
1066143Snate@binkert.org        self.Werror = Werror
1076143Snate@binkert.org        self.swig = swig
1086143Snate@binkert.org        self.bin_only = bin_only
1096143Snate@binkert.org        self.skip_lib = bin_only or skip_lib
1106143Snate@binkert.org
1116143Snate@binkert.orgclass PySource(SourceFile):
1126143Snate@binkert.org    '''Add a python source file to the named package'''
1135522Snate@binkert.org    invalid_sym_char = re.compile('[^A-z0-9_]')
1146143Snate@binkert.org    modules = {}
1156143Snate@binkert.org    tnodes = {}
1166143Snate@binkert.org    symnames = {}
1176143Snate@binkert.org    
1186143Snate@binkert.org    def __init__(self, package, source):
1196143Snate@binkert.org        super(PySource, self).__init__(source)
1206143Snate@binkert.org
1216143Snate@binkert.org        modname,ext = self.extname
1226143Snate@binkert.org        assert ext == 'py'
1236143Snate@binkert.org
1245522Snate@binkert.org        if package:
1255522Snate@binkert.org            path = package.split('.')
1265522Snate@binkert.org        else:
1275522Snate@binkert.org            path = []
1285604Snate@binkert.org
1295604Snate@binkert.org        modpath = path[:]
1306143Snate@binkert.org        if modname != '__init__':
1316143Snate@binkert.org            modpath += [ modname ]
1324762Snate@binkert.org        modpath = '.'.join(modpath)
1334762Snate@binkert.org
1346143Snate@binkert.org        arcpath = path + [ self.basename ]
1356143Snate@binkert.org        debugname = self.snode.abspath
1366143Snate@binkert.org        if not exists(debugname):
1376143Snate@binkert.org            debugname = self.tnode.abspath
1384762Snate@binkert.org
1396143Snate@binkert.org        self.package = package
1406143Snate@binkert.org        self.modname = modname
1416143Snate@binkert.org        self.modpath = modpath
1426143Snate@binkert.org        self.arcname = joinpath(*arcpath)
1436143Snate@binkert.org        self.debugname = debugname
1446143Snate@binkert.org        self.compiled = File(self.filename + 'c')
1456143Snate@binkert.org        self.assembly = File(self.filename + '.s')
1466143Snate@binkert.org        self.symname = "PyEMB_" + PySource.invalid_sym_char.sub('_', modpath)
1475604Snate@binkert.org
1486143Snate@binkert.org        PySource.modules[modpath] = self
1496143Snate@binkert.org        PySource.tnodes[self.tnode] = self
1506143Snate@binkert.org        PySource.symnames[self.symname] = self
1514762Snate@binkert.org
1526143Snate@binkert.orgclass SimObject(PySource):
1534762Snate@binkert.org    '''Add a SimObject python file as a python source object and add
1544762Snate@binkert.org    it to a list of sim object modules'''
1554762Snate@binkert.org
1566143Snate@binkert.org    fixed = False
1576143Snate@binkert.org    modnames = []
1584762Snate@binkert.org
1596143Snate@binkert.org    def __init__(self, source):
1606143Snate@binkert.org        super(SimObject, self).__init__('m5.objects', source)
1616143Snate@binkert.org        if self.fixed:
1626143Snate@binkert.org            raise AttributeError, "Too late to call SimObject now."
1634762Snate@binkert.org
1646143Snate@binkert.org        bisect.insort_right(SimObject.modnames, self.modname)
1654762Snate@binkert.org
1666143Snate@binkert.orgclass SwigSource(SourceFile):
1674762Snate@binkert.org    '''Add a swig file to build'''
1686143Snate@binkert.org
1696143Snate@binkert.org    def __init__(self, package, source):
1706143Snate@binkert.org        super(SwigSource, self).__init__(source)
1716143Snate@binkert.org
1726143Snate@binkert.org        modname,ext = self.extname
1736143Snate@binkert.org        assert ext == 'i'
1746143Snate@binkert.org
1756143Snate@binkert.org        self.module = modname
1766143Snate@binkert.org        cc_file = joinpath(self.dirname, modname + '_wrap.cc')
1776143Snate@binkert.org        py_file = joinpath(self.dirname, modname + '.py')
1786143Snate@binkert.org
1796143Snate@binkert.org        self.cc_source = Source(cc_file, swig=True)
1806143Snate@binkert.org        self.py_source = PySource(package, py_file)
181955SN/A
1825584Snate@binkert.orgunit_tests = []
1835584Snate@binkert.orgdef UnitTest(target, sources):
1845584Snate@binkert.org    if not isinstance(sources, (list, tuple)):
1855584Snate@binkert.org        sources = [ sources ]
1866143Snate@binkert.org
1876143Snate@binkert.org    sources = [ Source(src, skip_lib=True) for src in sources ]
1886143Snate@binkert.org    unit_tests.append((target, sources))
1895584Snate@binkert.org
1904382Sbinkertn@umich.edu# Children should have access
1914202Sbinkertn@umich.eduExport('Source')
1924382Sbinkertn@umich.eduExport('PySource')
1934382Sbinkertn@umich.eduExport('SimObject')
1944382Sbinkertn@umich.eduExport('SwigSource')
1955584Snate@binkert.orgExport('UnitTest')
1964382Sbinkertn@umich.edu
1974382Sbinkertn@umich.edu########################################################################
1984382Sbinkertn@umich.edu#
1995192Ssaidi@eecs.umich.edu# Trace Flags
2005192Ssaidi@eecs.umich.edu#
2015799Snate@binkert.orgtrace_flags = {}
2025799Snate@binkert.orgdef TraceFlag(name, desc=None):
2035799Snate@binkert.org    if name in trace_flags:
2045192Ssaidi@eecs.umich.edu        raise AttributeError, "Flag %s already specified" % name
2055799Snate@binkert.org    trace_flags[name] = (name, (), desc)
2065192Ssaidi@eecs.umich.edu
2075799Snate@binkert.orgdef CompoundFlag(name, flags, desc=None):
2085799Snate@binkert.org    if name in trace_flags:
2095192Ssaidi@eecs.umich.edu        raise AttributeError, "Flag %s already specified" % name
2105192Ssaidi@eecs.umich.edu
2115192Ssaidi@eecs.umich.edu    compound = tuple(flags)
2125799Snate@binkert.org    trace_flags[name] = (name, compound, desc)
2135192Ssaidi@eecs.umich.edu
2145192Ssaidi@eecs.umich.eduExport('TraceFlag')
2155192Ssaidi@eecs.umich.eduExport('CompoundFlag')
2165192Ssaidi@eecs.umich.edu
2175192Ssaidi@eecs.umich.edu########################################################################
2185192Ssaidi@eecs.umich.edu#
2194382Sbinkertn@umich.edu# Set some compiler variables
2204382Sbinkertn@umich.edu#
2214382Sbinkertn@umich.edu
2222667Sstever@eecs.umich.edu# Include file paths are rooted in this directory.  SCons will
2232667Sstever@eecs.umich.edu# automatically expand '.' to refer to both the source directory and
2242667Sstever@eecs.umich.edu# the corresponding build directory to pick up generated include
2252667Sstever@eecs.umich.edu# files.
2262667Sstever@eecs.umich.eduenv.Append(CPPPATH=Dir('.'))
2272667Sstever@eecs.umich.edu
2285742Snate@binkert.orgfor extra_dir in extras_dir_list:
2295742Snate@binkert.org    env.Append(CPPPATH=Dir(extra_dir))
2305742Snate@binkert.org
2312037SN/A# Add a flag defining what THE_ISA should be for all compilation
2322037SN/Aenv.Append(CPPDEFINES=[('THE_ISA','%s_ISA' % env['TARGET_ISA'].upper())])
2332037SN/A
2345793Snate@binkert.org# Workaround for bug in SCons version > 0.97d20071212
2355793Snate@binkert.org# Scons bug id: 2006 M5 Bug id: 308 
2365793Snate@binkert.orgfor root, dirs, files in os.walk(base_dir, topdown=True):
2375793Snate@binkert.org    Dir(root[len(base_dir) + 1:])
2385793Snate@binkert.org
2394382Sbinkertn@umich.edu########################################################################
2404762Snate@binkert.org#
2415344Sstever@gmail.com# Walk the tree and execute all SConscripts in subdirectories
2424382Sbinkertn@umich.edu#
2435341Sstever@gmail.com
2445742Snate@binkert.orghere = Dir('.').srcnode().abspath
2455742Snate@binkert.orgfor root, dirs, files in os.walk(base_dir, topdown=True):
2465742Snate@binkert.org    if root == here:
2475742Snate@binkert.org        # we don't want to recurse back into this SConscript
2485742Snate@binkert.org        continue
2494762Snate@binkert.org
2505742Snate@binkert.org    if 'SConscript' in files:
2515742Snate@binkert.org        build_dir = joinpath(env['BUILDDIR'], root[len(base_dir) + 1:])
2525742Snate@binkert.org        SConscript(joinpath(root, 'SConscript'), build_dir=build_dir)
2535742Snate@binkert.org
2545742Snate@binkert.orgfor extra_dir in extras_dir_list:
2555742Snate@binkert.org    prefix_len = len(dirname(extra_dir)) + 1
2565742Snate@binkert.org    for root, dirs, files in os.walk(extra_dir, topdown=True):
2575341Sstever@gmail.com        if 'SConscript' in files:
2585742Snate@binkert.org            build_dir = joinpath(env['BUILDDIR'], root[prefix_len:])
2595341Sstever@gmail.com            SConscript(joinpath(root, 'SConscript'), build_dir=build_dir)
2604773Snate@binkert.org
2616108Snate@binkert.orgfor opt in export_vars:
2621858SN/A    env.ConfigFile(opt)
2631085SN/A
2644382Sbinkertn@umich.edu########################################################################
2654382Sbinkertn@umich.edu#
2664762Snate@binkert.org# Prevent any SimObjects from being added after this point, they
2674762Snate@binkert.org# should all have been added in the SConscripts above
2684762Snate@binkert.org#
2696654Snate@binkert.orgSimObject.fixed = True
2706654Snate@binkert.org
2715517Snate@binkert.orgclass DictImporter(object):
2725517Snate@binkert.org    '''This importer takes a dictionary of arbitrary module names that
2735517Snate@binkert.org    map to arbitrary filenames.'''
2745517Snate@binkert.org    def __init__(self, modules):
2755517Snate@binkert.org        self.modules = modules
2765517Snate@binkert.org        self.installed = set()
2775517Snate@binkert.org
2785517Snate@binkert.org    def __del__(self):
2795517Snate@binkert.org        self.unload()
2805517Snate@binkert.org
2815517Snate@binkert.org    def unload(self):
2825517Snate@binkert.org        import sys
2835517Snate@binkert.org        for module in self.installed:
2845517Snate@binkert.org            del sys.modules[module]
2855517Snate@binkert.org        self.installed = set()
2865517Snate@binkert.org
2875517Snate@binkert.org    def find_module(self, fullname, path):
2886654Snate@binkert.org        if fullname == 'm5.defines':
2895517Snate@binkert.org            return self
2905517Snate@binkert.org
2915517Snate@binkert.org        if fullname == 'm5.objects':
2925517Snate@binkert.org            return self
2935517Snate@binkert.org
2945517Snate@binkert.org        if fullname.startswith('m5.internal'):
2955517Snate@binkert.org            return None
2965517Snate@binkert.org
2976143Snate@binkert.org        source = self.modules.get(fullname, None)
2986654Snate@binkert.org        if source is not None and fullname.startswith('m5.objects'):
2995517Snate@binkert.org            return self
3005517Snate@binkert.org
3015517Snate@binkert.org        return None
3025517Snate@binkert.org
3035517Snate@binkert.org    def load_module(self, fullname):
3045517Snate@binkert.org        mod = imp.new_module(fullname)
3055517Snate@binkert.org        sys.modules[fullname] = mod
3065517Snate@binkert.org        self.installed.add(fullname)
3075517Snate@binkert.org
3085517Snate@binkert.org        mod.__loader__ = self
3095517Snate@binkert.org        if fullname == 'm5.objects':
3105517Snate@binkert.org            mod.__path__ = fullname.split('.')
3115517Snate@binkert.org            return mod
3125517Snate@binkert.org
3136654Snate@binkert.org        if fullname == 'm5.defines':
3146654Snate@binkert.org            mod.__dict__['buildEnv'] = m5.util.SmartDict(build_env)
3155517Snate@binkert.org            return mod
3165517Snate@binkert.org
3176143Snate@binkert.org        source = self.modules[fullname]
3186143Snate@binkert.org        if source.modname == '__init__':
3196143Snate@binkert.org            mod.__path__ = source.modpath
3206143Snate@binkert.org        mod.__file__ = source.snode.abspath
3215517Snate@binkert.org
3226143Snate@binkert.org        exec file(source.snode.abspath, 'r') in mod.__dict__
3235517Snate@binkert.org
3245517Snate@binkert.org        return mod
3255517Snate@binkert.org
3266654Snate@binkert.orgimport m5.SimObject
3276654Snate@binkert.orgimport m5.params
3286654Snate@binkert.org
3296654Snate@binkert.orgm5.SimObject.clear()
3306654Snate@binkert.orgm5.params.clear()
3316654Snate@binkert.org
3325517Snate@binkert.org# install the python importer so we can grab stuff from the source
3335517Snate@binkert.org# tree itself.  We can't have SimObjects added after this point or
3345517Snate@binkert.org# else we won't know about them for the rest of the stuff.
3356143Snate@binkert.orgimporter = DictImporter(PySource.modules)
3365517Snate@binkert.orgsys.meta_path[0:0] = [ importer ]
3374762Snate@binkert.org
3385517Snate@binkert.org# import all sim objects so we can populate the all_objects list
3395517Snate@binkert.org# make sure that we're working with a list, then let's sort it
3406143Snate@binkert.orgfor modname in SimObject.modnames:
3416143Snate@binkert.org    exec('from m5.objects import %s' % modname)
3425517Snate@binkert.org
3435517Snate@binkert.org# we need to unload all of the currently imported modules so that they
3445517Snate@binkert.org# will be re-imported the next time the sconscript is run
3455517Snate@binkert.orgimporter.unload()
3465517Snate@binkert.orgsys.meta_path.remove(importer)
3475517Snate@binkert.org
3485517Snate@binkert.orgsim_objects = m5.SimObject.allClasses
3495517Snate@binkert.orgall_enums = m5.params.allEnums
3505517Snate@binkert.org
3515517Snate@binkert.orgall_params = {}
3526143Snate@binkert.orgfor name,obj in sorted(sim_objects.iteritems()):
3535517Snate@binkert.org    for param in obj._params.local.values():
3546654Snate@binkert.org        # load the ptype attribute now because it depends on the
3556654Snate@binkert.org        # current version of SimObject.allClasses, but when scons
3566654Snate@binkert.org        # actually uses the value, all versions of
3576654Snate@binkert.org        # SimObject.allClasses will have been loaded
3586654Snate@binkert.org        param.ptype
3596654Snate@binkert.org
3605517Snate@binkert.org        if not hasattr(param, 'swig_decl'):
3615517Snate@binkert.org            continue
3625517Snate@binkert.org        pname = param.ptype_str
3635517Snate@binkert.org        if pname not in all_params:
3645517Snate@binkert.org            all_params[pname] = param
3654762Snate@binkert.org
3664762Snate@binkert.org########################################################################
3674762Snate@binkert.org#
3684762Snate@binkert.org# calculate extra dependencies
3694762Snate@binkert.org#
3704762Snate@binkert.orgmodule_depends = ["m5", "m5.SimObject", "m5.params"]
3716143Snate@binkert.orgdepends = [ PySource.modules[dep].tnode for dep in module_depends ]
3724762Snate@binkert.org
3734762Snate@binkert.org########################################################################
3744762Snate@binkert.org#
3754762Snate@binkert.org# Commands for the basic automatically generated python files
3764382Sbinkertn@umich.edu#
3774382Sbinkertn@umich.edu
3785517Snate@binkert.org# Generate Python file containing a dict specifying the current
3796654Snate@binkert.org# buildEnv flags.
3805517Snate@binkert.orgdef makeDefinesPyFile(target, source, env):
3815798Snate@binkert.org    build_env, hg_info = [ x.get_contents() for x in source ]
3826654Snate@binkert.org
3836654Snate@binkert.org    code = m5.util.code_formatter()
3846654Snate@binkert.org    code("""
3856654Snate@binkert.orgimport m5.internal
3866654Snate@binkert.orgimport m5.util
3876654Snate@binkert.org
3886654Snate@binkert.orgbuildEnv = m5.util.SmartDict($build_env)
3896654Snate@binkert.orghgRev = '$hg_info'
3906654Snate@binkert.org
3916654Snate@binkert.orgcompileDate = m5.internal.core.compileDate
3926654Snate@binkert.orgfor k,v in m5.internal.core.__dict__.iteritems():
3936654Snate@binkert.org    if k.startswith('flag_'):
3946654Snate@binkert.org        setattr(buildEnv, k[5:], v)
3956654Snate@binkert.org""")
3966654Snate@binkert.org    code.write(str(target[0]))
3975517Snate@binkert.org
3985863Snate@binkert.orgdefines_info = [ Value(build_env), Value(env['HG_INFO']) ]
3995798Snate@binkert.org# Generate a file with all of the compile options in it
4005798Snate@binkert.orgenv.Command('python/m5/defines.py', defines_info, makeDefinesPyFile)
4015798Snate@binkert.orgPySource('m5', 'python/m5/defines.py')
4025798Snate@binkert.org
4035517Snate@binkert.org# Generate python file containing info about the M5 source code
4045517Snate@binkert.orgdef makeInfoPyFile(target, source, env):
4055517Snate@binkert.org    f = file(str(target[0]), 'w')
4065517Snate@binkert.org    for src in source:
4075517Snate@binkert.org        data = ''.join(file(src.srcnode().abspath, 'r').xreadlines())
4085517Snate@binkert.org        print >>f, "%s = %s" % (src, repr(data))
4095517Snate@binkert.org    f.close()
4105517Snate@binkert.org
4115798Snate@binkert.org# Generate a file that wraps the basic top level files
4125798Snate@binkert.orgenv.Command('python/m5/info.py',
4135798Snate@binkert.org            [ '#/AUTHORS', '#/LICENSE', '#/README', '#/RELEASE_NOTES' ],
4145798Snate@binkert.org            makeInfoPyFile)
4155798Snate@binkert.orgPySource('m5', 'python/m5/info.py')
4165798Snate@binkert.org
4175517Snate@binkert.org# Generate the __init__.py file for m5.objects
4185517Snate@binkert.orgdef makeObjectsInitFile(target, source, env):
4195517Snate@binkert.org    f = file(str(target[0]), 'w')
4205517Snate@binkert.org    print >>f, 'from params import *'
4215517Snate@binkert.org    print >>f, 'from m5.SimObject import *'
4225517Snate@binkert.org    for module in source:
4235517Snate@binkert.org        print >>f, 'from %s import *' % module.get_contents()
4245517Snate@binkert.org    f.close()
4255517Snate@binkert.org
4264762Snate@binkert.org# Generate an __init__.py file for the objects package
4274382Sbinkertn@umich.eduenv.Command('python/m5/objects/__init__.py',
4286143Snate@binkert.org            map(Value, SimObject.modnames),
4295517Snate@binkert.org            makeObjectsInitFile)
4304382Sbinkertn@umich.eduPySource('m5.objects', 'python/m5/objects/__init__.py')
4314382Sbinkertn@umich.edu
4324762Snate@binkert.org########################################################################
4334762Snate@binkert.org#
4344762Snate@binkert.org# Create all of the SimObject param headers and enum headers
4354762Snate@binkert.org#
4364762Snate@binkert.org
4375517Snate@binkert.orgdef createSimObjectParam(target, source, env):
4385517Snate@binkert.org    assert len(target) == 1 and len(source) == 1
4395517Snate@binkert.org
4405517Snate@binkert.org    hh_file = file(target[0].abspath, 'w')
4415517Snate@binkert.org    name = str(source[0].get_contents())
4425517Snate@binkert.org    obj = sim_objects[name]
4435517Snate@binkert.org
4445517Snate@binkert.org    print >>hh_file, obj.cxx_decl()
4456143Snate@binkert.org    hh_file.close()
4465517Snate@binkert.org
4475517Snate@binkert.orgdef createSwigParam(target, source, env):
4485517Snate@binkert.org    assert len(target) == 1 and len(source) == 1
4495517Snate@binkert.org
4505517Snate@binkert.org    i_file = file(target[0].abspath, 'w')
4515517Snate@binkert.org    name = str(source[0].get_contents())
4525517Snate@binkert.org    param = all_params[name]
4535517Snate@binkert.org
4545517Snate@binkert.org    for line in param.swig_decl():
4555517Snate@binkert.org        print >>i_file, line
4566143Snate@binkert.org    i_file.close()
4575517Snate@binkert.org
4585517Snate@binkert.orgdef createEnumStrings(target, source, env):
4595517Snate@binkert.org    assert len(target) == 1 and len(source) == 1
4605517Snate@binkert.org
4615517Snate@binkert.org    cc_file = file(target[0].abspath, 'w')
4625517Snate@binkert.org    name = str(source[0].get_contents())
4635517Snate@binkert.org    obj = all_enums[name]
4645517Snate@binkert.org
4655517Snate@binkert.org    print >>cc_file, obj.cxx_def()
4665517Snate@binkert.org    cc_file.close()
4675517Snate@binkert.org
4685517Snate@binkert.orgdef createEnumParam(target, source, env):
4695517Snate@binkert.org    assert len(target) == 1 and len(source) == 1
4705517Snate@binkert.org
4715517Snate@binkert.org    hh_file = file(target[0].abspath, 'w')
4725517Snate@binkert.org    name = str(source[0].get_contents())
4735517Snate@binkert.org    obj = all_enums[name]
4745517Snate@binkert.org
4755517Snate@binkert.org    print >>hh_file, obj.cxx_decl()
4766143Snate@binkert.org    hh_file.close()
4775517Snate@binkert.org
4784762Snate@binkert.org# Generate all of the SimObject param struct header files
4794762Snate@binkert.orgparams_hh_files = []
4806143Snate@binkert.orgfor name,simobj in sorted(sim_objects.iteritems()):
4816143Snate@binkert.org    py_source = PySource.modules[simobj.__module__]
4826143Snate@binkert.org    extra_deps = [ py_source.tnode ]
4834762Snate@binkert.org
4844762Snate@binkert.org    hh_file = File('params/%s.hh' % name)
4854762Snate@binkert.org    params_hh_files.append(hh_file)
4865517Snate@binkert.org    env.Command(hh_file, Value(name), createSimObjectParam)
4874762Snate@binkert.org    env.Depends(hh_file, depends + extra_deps)
4884762Snate@binkert.org
4894762Snate@binkert.org# Generate any parameter header files needed
4905463Snate@binkert.orgparams_i_files = []
4915517Snate@binkert.orgfor name,param in all_params.iteritems():
4924762Snate@binkert.org    if isinstance(param, m5.params.VectorParamDesc):
4934762Snate@binkert.org        ext = 'vptype'
4944762Snate@binkert.org    else:
4954762Snate@binkert.org        ext = 'ptype'
4964762Snate@binkert.org
4974762Snate@binkert.org    i_file = File('params/%s_%s.i' % (name, ext))
4985463Snate@binkert.org    params_i_files.append(i_file)
4995517Snate@binkert.org    env.Command(i_file, Value(name), createSwigParam)
5004762Snate@binkert.org    env.Depends(i_file, depends)
5014762Snate@binkert.org
5024762Snate@binkert.org# Generate all enum header files
5036143Snate@binkert.orgfor name,enum in sorted(all_enums.iteritems()):
5046143Snate@binkert.org    py_source = PySource.modules[enum.__module__]
5056143Snate@binkert.org    extra_deps = [ py_source.tnode ]
5064762Snate@binkert.org
5074762Snate@binkert.org    cc_file = File('enums/%s.cc' % name)
5085517Snate@binkert.org    env.Command(cc_file, Value(name), createEnumStrings)
5094762Snate@binkert.org    env.Depends(cc_file, depends + extra_deps)
5104762Snate@binkert.org    Source(cc_file)
5114762Snate@binkert.org
5124762Snate@binkert.org    hh_file = File('enums/%s.hh' % name)
5135517Snate@binkert.org    env.Command(hh_file, Value(name), createEnumParam)
5144762Snate@binkert.org    env.Depends(hh_file, depends + extra_deps)
5154762Snate@binkert.org
5164762Snate@binkert.org# Build the big monolithic swigged params module (wraps all SimObject
5174762Snate@binkert.org# param structs and enum structs)
5185517Snate@binkert.orgdef buildParams(target, source, env):
5195517Snate@binkert.org    names = [ s.get_contents() for s in source ]
5205517Snate@binkert.org    objs = [ sim_objects[name] for name in names ]
5215517Snate@binkert.org    out = file(target[0].abspath, 'w')
5225517Snate@binkert.org
5235517Snate@binkert.org    ordered_objs = []
5245517Snate@binkert.org    obj_seen = set()
5255517Snate@binkert.org    def order_obj(obj):
5265517Snate@binkert.org        name = str(obj)
5275517Snate@binkert.org        if name in obj_seen:
5285517Snate@binkert.org            return
5295517Snate@binkert.org
5305517Snate@binkert.org        obj_seen.add(name)
5315517Snate@binkert.org        if str(obj) != 'SimObject':
5325517Snate@binkert.org            order_obj(obj.__bases__[0])
5335517Snate@binkert.org
5345517Snate@binkert.org        ordered_objs.append(obj)
5355517Snate@binkert.org
5365517Snate@binkert.org    for obj in objs:
5375517Snate@binkert.org        order_obj(obj)
5385517Snate@binkert.org
5395517Snate@binkert.org    enums = set()
5405517Snate@binkert.org    predecls = []
5415517Snate@binkert.org    pd_seen = set()
5425517Snate@binkert.org
5435517Snate@binkert.org    def add_pds(*pds):
5445517Snate@binkert.org        for pd in pds:
5455517Snate@binkert.org            if pd not in pd_seen:
5465517Snate@binkert.org                predecls.append(pd)
5475517Snate@binkert.org                pd_seen.add(pd)
5485517Snate@binkert.org
5495517Snate@binkert.org    for obj in ordered_objs:
5505517Snate@binkert.org        params = obj._params.local.values()
5515517Snate@binkert.org        for param in params:
5525517Snate@binkert.org            ptype = param.ptype
5535517Snate@binkert.org            if issubclass(ptype, m5.params.Enum):
5545517Snate@binkert.org                if ptype not in enums:
5555517Snate@binkert.org                    enums.add(ptype)
5565517Snate@binkert.org            pds = param.swig_predecls()
5575517Snate@binkert.org            if isinstance(pds, (list, tuple)):
5585517Snate@binkert.org                add_pds(*pds)
5595517Snate@binkert.org            else:
5605517Snate@binkert.org                add_pds(pds)
5615517Snate@binkert.org
5625517Snate@binkert.org    print >>out, '%module params'
5635517Snate@binkert.org
5645517Snate@binkert.org    print >>out, '%{'
5655517Snate@binkert.org    for obj in ordered_objs:
5665517Snate@binkert.org        print >>out, '#include "params/%s.hh"' % obj
5675517Snate@binkert.org    print >>out, '%}'
5685517Snate@binkert.org
5695517Snate@binkert.org    for pd in predecls:
5705517Snate@binkert.org        print >>out, pd
5715517Snate@binkert.org
5725517Snate@binkert.org    enums = list(enums)
5735517Snate@binkert.org    enums.sort()
5745517Snate@binkert.org    for enum in enums:
5755517Snate@binkert.org        print >>out, '%%include "enums/%s.hh"' % enum.__name__
5765517Snate@binkert.org    print >>out
5775517Snate@binkert.org
5785517Snate@binkert.org    for obj in ordered_objs:
5795517Snate@binkert.org        if obj.swig_objdecls:
5805517Snate@binkert.org            for decl in obj.swig_objdecls:
5815517Snate@binkert.org                print >>out, decl
5825517Snate@binkert.org            continue
5835517Snate@binkert.org
5845610Snate@binkert.org        class_path = obj.cxx_class.split('::')
5855623Snate@binkert.org        classname = class_path[-1]
5865623Snate@binkert.org        namespaces = class_path[:-1]
5875623Snate@binkert.org        namespaces.reverse()
5885610Snate@binkert.org
5895517Snate@binkert.org        code = ''
5905623Snate@binkert.org
5915623Snate@binkert.org        if namespaces:
5925623Snate@binkert.org            code += '// avoid name conflicts\n'
5935623Snate@binkert.org            sep_string = '_COLONS_'
5945623Snate@binkert.org            flat_name = sep_string.join(class_path)
5955623Snate@binkert.org            code += '%%rename(%s) %s;\n' % (flat_name, classname)
5965623Snate@binkert.org
5975517Snate@binkert.org        code += '// stop swig from creating/wrapping default ctor/dtor\n'
5985610Snate@binkert.org        code += '%%nodefault %s;\n' % classname
5995610Snate@binkert.org        code += 'class %s ' % classname
6005610Snate@binkert.org        if obj._base:
6015610Snate@binkert.org            code += ': public %s' % obj._base.cxx_class
6025517Snate@binkert.org        code += ' {};\n'
6035517Snate@binkert.org
6045610Snate@binkert.org        for ns in namespaces:
6055610Snate@binkert.org            new_code = 'namespace %s {\n' % ns
6065517Snate@binkert.org            new_code += code
6075517Snate@binkert.org            new_code += '}\n'
6085517Snate@binkert.org            code = new_code
6095517Snate@binkert.org
6105517Snate@binkert.org        print >>out, code
6115517Snate@binkert.org
6125517Snate@binkert.org    print >>out, '%%include "src/sim/sim_object_params.hh"' % obj
6135517Snate@binkert.org    for obj in ordered_objs:
6145517Snate@binkert.org        print >>out, '%%include "params/%s.hh"' % obj
6155517Snate@binkert.org
6164762Snate@binkert.orgparams_file = File('params/params.i')
6176143Snate@binkert.orgnames = sorted(sim_objects.keys())
6186143Snate@binkert.orgenv.Command(params_file, map(Value, names), buildParams)
6195463Snate@binkert.orgenv.Depends(params_file, params_hh_files + params_i_files + depends)
6204762Snate@binkert.orgSwigSource('m5.objects', params_file)
6214762Snate@binkert.org
6224762Snate@binkert.org# Build all swig modules
6236143Snate@binkert.orgfor swig in SwigSource.all:
6246143Snate@binkert.org    env.Command([swig.cc_source.tnode, swig.py_source.tnode], swig.tnode,
6254382Sbinkertn@umich.edu                '$SWIG $SWIGFLAGS -outdir ${TARGETS[1].dir} '
6264382Sbinkertn@umich.edu                '-o ${TARGETS[0]} $SOURCES')
6276143Snate@binkert.org    env.Depends(swig.py_source.tnode, swig.tnode)
6286143Snate@binkert.org    env.Depends(swig.cc_source.tnode, swig.tnode)
6294382Sbinkertn@umich.edu
6304762Snate@binkert.org# Generate the main swig init file
6315517Snate@binkert.orgdef makeSwigInit(target, source, env):
6325517Snate@binkert.org    f = file(str(target[0]), 'w')
6335517Snate@binkert.org    print >>f, 'extern "C" {'
6345517Snate@binkert.org    for module in source:
6355517Snate@binkert.org        print >>f, '    void init_%s();' % module.get_contents()
6365517Snate@binkert.org    print >>f, '}'
6375522Snate@binkert.org    print >>f, 'void initSwig() {'
6385517Snate@binkert.org    for module in source:
6395517Snate@binkert.org        print >>f, '    init_%s();' % module.get_contents()
6405517Snate@binkert.org    print >>f, '}'
6415517Snate@binkert.org    f.close()
6425517Snate@binkert.org
6436143Snate@binkert.orgenv.Command('python/swig/init.cc',
6446143Snate@binkert.org            map(Value, sorted(s.module for s in SwigSource.all)),
6456143Snate@binkert.org            makeSwigInit)
6465522Snate@binkert.orgSource('python/swig/init.cc')
6474382Sbinkertn@umich.edu
6486229Snate@binkert.orgdef getFlags(source_flags):
6496229Snate@binkert.org    flagsMap = {}
6506229Snate@binkert.org    flagsList = []
6516229Snate@binkert.org    for s in source_flags:
6526229Snate@binkert.org        val = eval(s.get_contents())
6536229Snate@binkert.org        name, compound, desc = val
6546229Snate@binkert.org        flagsList.append(val)
6556229Snate@binkert.org        flagsMap[name] = bool(compound)
6566229Snate@binkert.org    
6576229Snate@binkert.org    for name, compound, desc in flagsList:
6586229Snate@binkert.org        for flag in compound:
6596229Snate@binkert.org            if flag not in flagsMap:
6606229Snate@binkert.org                raise AttributeError, "Trace flag %s not found" % flag
6616229Snate@binkert.org            if flagsMap[flag]:
6626229Snate@binkert.org                raise AttributeError, \
6636229Snate@binkert.org                    "Compound flag can't point to another compound flag"
6646229Snate@binkert.org
6656229Snate@binkert.org    flagsList.sort()
6666229Snate@binkert.org    return flagsList
6676229Snate@binkert.org
6686229Snate@binkert.org
6695192Ssaidi@eecs.umich.edu# Generate traceflags.py
6705517Snate@binkert.orgdef traceFlagsPy(target, source, env):
6715517Snate@binkert.org    assert(len(target) == 1)
6725517Snate@binkert.org
6735517Snate@binkert.org    f = file(str(target[0]), 'w')
6746229Snate@binkert.org   
6756229Snate@binkert.org    allFlags = getFlags(source)
6765799Snate@binkert.org
6775799Snate@binkert.org    print >>f, 'basic = ['
6785517Snate@binkert.org    for flag, compound, desc in allFlags:
6795517Snate@binkert.org        if not compound:
6805517Snate@binkert.org            print >>f, "    '%s'," % flag
6815517Snate@binkert.org    print >>f, "    ]"
6825517Snate@binkert.org    print >>f
6835517Snate@binkert.org
6845799Snate@binkert.org    print >>f, 'compound = ['
6855517Snate@binkert.org    print >>f, "    'All',"
6865517Snate@binkert.org    for flag, compound, desc in allFlags:
6875517Snate@binkert.org        if compound:
6885517Snate@binkert.org            print >>f, "    '%s'," % flag
6895517Snate@binkert.org    print >>f, "    ]"
6905517Snate@binkert.org    print >>f
6915517Snate@binkert.org
6925799Snate@binkert.org    print >>f, "all = frozenset(basic + compound)"
6935517Snate@binkert.org    print >>f
6945517Snate@binkert.org
6955799Snate@binkert.org    print >>f, 'compoundMap = {'
6965517Snate@binkert.org    all = tuple([flag for flag,compound,desc in allFlags if not compound])
6975517Snate@binkert.org    print >>f, "    'All' : %s," % (all, )
6985517Snate@binkert.org    for flag, compound, desc in allFlags:
6995517Snate@binkert.org        if compound:
7005517Snate@binkert.org            print >>f, "    '%s' : %s," % (flag, compound)
7015517Snate@binkert.org    print >>f, "    }"
7025517Snate@binkert.org    print >>f
7035517Snate@binkert.org
7045799Snate@binkert.org    print >>f, 'descriptions = {'
7055517Snate@binkert.org    print >>f, "    'All' : 'All flags',"
7065517Snate@binkert.org    for flag, compound, desc in allFlags:
7075517Snate@binkert.org        print >>f, "    '%s' : '%s'," % (flag, desc)
7085517Snate@binkert.org    print >>f, "    }"
7095517Snate@binkert.org
7105517Snate@binkert.org    f.close()
7115517Snate@binkert.org
7125517Snate@binkert.orgdef traceFlagsCC(target, source, env):
7135517Snate@binkert.org    assert(len(target) == 1)
7145517Snate@binkert.org
7155517Snate@binkert.org    f = file(str(target[0]), 'w')
7165517Snate@binkert.org
7176229Snate@binkert.org    allFlags = getFlags(source)
7185517Snate@binkert.org
7195517Snate@binkert.org    # file header
7205517Snate@binkert.org    print >>f, '''
7215517Snate@binkert.org/*
7225517Snate@binkert.org * DO NOT EDIT THIS FILE! Automatically generated
7235517Snate@binkert.org */
7245517Snate@binkert.org
7255517Snate@binkert.org#include "base/traceflags.hh"
7265517Snate@binkert.org
7275517Snate@binkert.orgusing namespace Trace;
7285517Snate@binkert.org
7295517Snate@binkert.orgconst char *Trace::flagStrings[] =
7305517Snate@binkert.org{'''
7315517Snate@binkert.org
7325517Snate@binkert.org    # The string array is used by SimpleEnumParam to map the strings
7335517Snate@binkert.org    # provided by the user to enum values.
7345517Snate@binkert.org    for flag, compound, desc in allFlags:
7355517Snate@binkert.org        if not compound:
7365517Snate@binkert.org            print >>f, '    "%s",' % flag
7375517Snate@binkert.org
7385517Snate@binkert.org    print >>f, '    "All",'
7395517Snate@binkert.org    for flag, compound, desc in allFlags:
7405517Snate@binkert.org        if compound:
7415517Snate@binkert.org            print >>f, '    "%s",' % flag
7425517Snate@binkert.org
7435517Snate@binkert.org    print >>f, '};'
7445517Snate@binkert.org    print >>f
7455517Snate@binkert.org    print >>f, 'const int Trace::numFlagStrings = %d;' % (len(allFlags) + 1)
7465517Snate@binkert.org    print >>f
7475517Snate@binkert.org
7485517Snate@binkert.org    #
7495517Snate@binkert.org    # Now define the individual compound flag arrays.  There is an array
7505517Snate@binkert.org    # for each compound flag listing the component base flags.
7515517Snate@binkert.org    #
7525517Snate@binkert.org    all = tuple([flag for flag,compound,desc in allFlags if not compound])
7535517Snate@binkert.org    print >>f, 'static const Flags AllMap[] = {'
7545517Snate@binkert.org    for flag, compound, desc in allFlags:
7555517Snate@binkert.org        if not compound:
7565517Snate@binkert.org            print >>f, "    %s," % flag
7575517Snate@binkert.org    print >>f, '};'
7585517Snate@binkert.org    print >>f
7595517Snate@binkert.org
7605517Snate@binkert.org    for flag, compound, desc in allFlags:
7615517Snate@binkert.org        if not compound:
7625517Snate@binkert.org            continue
7635517Snate@binkert.org        print >>f, 'static const Flags %sMap[] = {' % flag
7645517Snate@binkert.org        for flag in compound:
7655517Snate@binkert.org            print >>f, "    %s," % flag
7665517Snate@binkert.org        print >>f, "    (Flags)-1"
7675517Snate@binkert.org        print >>f, '};'
7685517Snate@binkert.org        print >>f
7695517Snate@binkert.org
7705517Snate@binkert.org    #
7715517Snate@binkert.org    # Finally the compoundFlags[] array maps the compound flags
7725517Snate@binkert.org    # to their individual arrays/
7735517Snate@binkert.org    #
7745517Snate@binkert.org    print >>f, 'const Flags *Trace::compoundFlags[] ='
7755517Snate@binkert.org    print >>f, '{'
7765517Snate@binkert.org    print >>f, '    AllMap,'
7775517Snate@binkert.org    for flag, compound, desc in allFlags:
7785517Snate@binkert.org        if compound:
7795517Snate@binkert.org            print >>f, '    %sMap,' % flag
7805517Snate@binkert.org    # file trailer
7815517Snate@binkert.org    print >>f, '};'
7825517Snate@binkert.org
7835517Snate@binkert.org    f.close()
7845517Snate@binkert.org
7855517Snate@binkert.orgdef traceFlagsHH(target, source, env):
7865517Snate@binkert.org    assert(len(target) == 1)
7875517Snate@binkert.org
7885517Snate@binkert.org    f = file(str(target[0]), 'w')
7895517Snate@binkert.org
7906229Snate@binkert.org    allFlags = getFlags(source)
7915517Snate@binkert.org
7925517Snate@binkert.org    # file header boilerplate
7935517Snate@binkert.org    print >>f, '''
7945517Snate@binkert.org/*
7955517Snate@binkert.org * DO NOT EDIT THIS FILE!
7965517Snate@binkert.org *
7975517Snate@binkert.org * Automatically generated from traceflags.py
7985517Snate@binkert.org */
7995517Snate@binkert.org
8005517Snate@binkert.org#ifndef __BASE_TRACE_FLAGS_HH__
8015517Snate@binkert.org#define __BASE_TRACE_FLAGS_HH__
8025517Snate@binkert.org
8035517Snate@binkert.orgnamespace Trace {
8045517Snate@binkert.org
8055517Snate@binkert.orgenum Flags {'''
8065517Snate@binkert.org
8075517Snate@binkert.org    # Generate the enum.  Base flags come first, then compound flags.
8085517Snate@binkert.org    idx = 0
8095517Snate@binkert.org    for flag, compound, desc in allFlags:
8105517Snate@binkert.org        if not compound:
8115517Snate@binkert.org            print >>f, '    %s = %d,' % (flag, idx)
8125517Snate@binkert.org            idx += 1
8135517Snate@binkert.org
8145517Snate@binkert.org    numBaseFlags = idx
8155517Snate@binkert.org    print >>f, '    NumFlags = %d,' % idx
8165517Snate@binkert.org
8175517Snate@binkert.org    # put a comment in here to separate base from compound flags
8185517Snate@binkert.org    print >>f, '''
8195517Snate@binkert.org// The remaining enum values are *not* valid indices for Trace::flags.
8205517Snate@binkert.org// They are "compound" flags, which correspond to sets of base
8215517Snate@binkert.org// flags, and are used by changeFlag.'''
8225517Snate@binkert.org
8235517Snate@binkert.org    print >>f, '    All = %d,' % idx
8245517Snate@binkert.org    idx += 1
8255517Snate@binkert.org    for flag, compound, desc in allFlags:
8265517Snate@binkert.org        if compound:
8275517Snate@binkert.org            print >>f, '    %s = %d,' % (flag, idx)
8285517Snate@binkert.org            idx += 1
8295517Snate@binkert.org
8305517Snate@binkert.org    numCompoundFlags = idx - numBaseFlags
8315517Snate@binkert.org    print >>f, '    NumCompoundFlags = %d' % numCompoundFlags
8325517Snate@binkert.org
8335517Snate@binkert.org    # trailer boilerplate
8345517Snate@binkert.org    print >>f, '''\
8355517Snate@binkert.org}; // enum Flags
8365517Snate@binkert.org
8375517Snate@binkert.org// Array of strings for SimpleEnumParam
8385517Snate@binkert.orgextern const char *flagStrings[];
8395517Snate@binkert.orgextern const int numFlagStrings;
8405517Snate@binkert.org
8415517Snate@binkert.org// Array of arraay pointers: for each compound flag, gives the list of
8425517Snate@binkert.org// base flags to set.  Inidividual flag arrays are terminated by -1.
8435517Snate@binkert.orgextern const Flags *compoundFlags[];
8445517Snate@binkert.org
8455517Snate@binkert.org/* namespace Trace */ }
8465517Snate@binkert.org
8475517Snate@binkert.org#endif // __BASE_TRACE_FLAGS_HH__
8485517Snate@binkert.org'''
8495517Snate@binkert.org
8505517Snate@binkert.org    f.close()
8515517Snate@binkert.org
8526143Snate@binkert.orgflags = map(Value, trace_flags.values())
8535517Snate@binkert.orgenv.Command('base/traceflags.py', flags, traceFlagsPy)
8545192Ssaidi@eecs.umich.eduPySource('m5', 'base/traceflags.py')
8555192Ssaidi@eecs.umich.edu
8565517Snate@binkert.orgenv.Command('base/traceflags.hh', flags, traceFlagsHH)
8575517Snate@binkert.orgenv.Command('base/traceflags.cc', flags, traceFlagsCC)
8585192Ssaidi@eecs.umich.eduSource('base/traceflags.cc')
8595192Ssaidi@eecs.umich.edu
8605522Snate@binkert.org# embed python files.  All .py files that have been indicated by a
8615522Snate@binkert.org# PySource() call in a SConscript need to be embedded into the M5
8625522Snate@binkert.org# library.  To do that, we compile the file to byte code, marshal the
8635522Snate@binkert.org# byte code, compress it, and then generate an assembly file that
8645522Snate@binkert.org# inserts the result into the data section with symbols indicating the
8655522Snate@binkert.org# beginning, and end (and with the size at the end)
8665522Snate@binkert.orgdef objectifyPyFile(target, source, env):
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()
8725522Snate@binkert.org    dst = file(str(target[0]), 'w')
8735517Snate@binkert.org
8746143Snate@binkert.org    pysource = PySource.tnodes[source[0]]
8755604Snate@binkert.org    compiled = compile(src, pysource.debugname, 'exec')
8765522Snate@binkert.org    marshalled = marshal.dumps(compiled)
8775522Snate@binkert.org    compressed = zlib.compress(marshalled)
8785522Snate@binkert.org    data = compressed
8795517Snate@binkert.org
8805522Snate@binkert.org    # Some C/C++ compilers prepend an underscore to global symbol
8815522Snate@binkert.org    # names, so if they're going to do that, we need to prepend that
8825522Snate@binkert.org    # leading underscore to globals in the assembly file.
8835522Snate@binkert.org    if env['LEADING_UNDERSCORE']:
8845522Snate@binkert.org        sym = '_' + pysource.symname
8855522Snate@binkert.org    else:
8865522Snate@binkert.org        sym = pysource.symname
8875522Snate@binkert.org
8885522Snate@binkert.org    step = 16
8895522Snate@binkert.org    print >>dst, ".data"
8905522Snate@binkert.org    print >>dst, ".globl %s_beg" % sym
8915522Snate@binkert.org    print >>dst, ".globl %s_end" % sym
8925522Snate@binkert.org    print >>dst, "%s_beg:" % sym
8935522Snate@binkert.org    for i in xrange(0, len(data), step):
8945522Snate@binkert.org        x = array.array('B', data[i:i+step])
8955522Snate@binkert.org        print >>dst, ".byte", ','.join([str(d) for d in x])
8965522Snate@binkert.org    print >>dst, "%s_end:" % sym
8975522Snate@binkert.org    print >>dst, ".long %d" % len(marshalled)
8985522Snate@binkert.org
8996143Snate@binkert.orgfor source in PySource.all:
9005522Snate@binkert.org    env.Command(source.assembly, source.tnode, objectifyPyFile)
9015522Snate@binkert.org    Source(source.assembly)
9024382Sbinkertn@umich.edu
9035522Snate@binkert.org# Generate init_python.cc which creates a bunch of EmbeddedPyModule
9045522Snate@binkert.org# structs that describe the embedded python code.  One such struct
9055522Snate@binkert.org# contains information about the importer that python uses to get at
9065522Snate@binkert.org# the embedded files, and then there's a list of all of the rest that
9075522Snate@binkert.org# the importer uses to load the rest on demand.
9085522Snate@binkert.orgdef pythonInit(target, source, env):
9095522Snate@binkert.org    dst = file(str(target[0]), 'w')
9104382Sbinkertn@umich.edu
9115522Snate@binkert.org    def dump_mod(sym, endchar=','):
9126143Snate@binkert.org        pysource = PySource.symnames[sym]
9135522Snate@binkert.org        print >>dst, '    { "%s",' % pysource.arcname
9145522Snate@binkert.org        print >>dst, '      "%s",' % pysource.modpath
9155522Snate@binkert.org        print >>dst, '       %s_beg, %s_end,' % (sym, sym)
9165522Snate@binkert.org        print >>dst, '       %s_end - %s_beg,' % (sym, sym)
9175522Snate@binkert.org        print >>dst, '       *(int *)%s_end }%s'  % (sym, endchar)
9185522Snate@binkert.org    
9195522Snate@binkert.org    print >>dst, '#include "sim/init.hh"'
9205522Snate@binkert.org
9215522Snate@binkert.org    for sym in source:
9225522Snate@binkert.org        sym = sym.get_contents()
9235522Snate@binkert.org        print >>dst, "extern const char %s_beg[], %s_end[];" % (sym, sym)
9245522Snate@binkert.org
9255522Snate@binkert.org    print >>dst, "const EmbeddedPyModule embeddedPyImporter = "
9265522Snate@binkert.org    dump_mod("PyEMB_importer", endchar=';');
9275522Snate@binkert.org    print >>dst
9285522Snate@binkert.org
9295522Snate@binkert.org    print >>dst, "const EmbeddedPyModule embeddedPyModules[] = {"
9305522Snate@binkert.org    for i,sym in enumerate(source):
9315522Snate@binkert.org        sym = sym.get_contents()
9325522Snate@binkert.org        if sym == "PyEMB_importer":
9335522Snate@binkert.org            # Skip the importer since we've already exported it
9345522Snate@binkert.org            continue
9355522Snate@binkert.org        dump_mod(sym)
9365522Snate@binkert.org    print >>dst, "    { 0, 0, 0, 0, 0, 0 }"
9375522Snate@binkert.org    print >>dst, "};"
9385522Snate@binkert.org
9396143Snate@binkert.org
9406143Snate@binkert.orgenv.Command('sim/init_python.cc',
9416143Snate@binkert.org            map(Value, (s.symname for s in PySource.all)),
9426143Snate@binkert.org            pythonInit)
9435522Snate@binkert.orgSource('sim/init_python.cc')
9444382Sbinkertn@umich.edu
9454382Sbinkertn@umich.edu########################################################################
9464382Sbinkertn@umich.edu#
9474382Sbinkertn@umich.edu# Define binaries.  Each different build type (debug, opt, etc.) gets
9484382Sbinkertn@umich.edu# a slightly different build environment.
9494382Sbinkertn@umich.edu#
9504382Sbinkertn@umich.edu
9514382Sbinkertn@umich.edu# List of constructed environments to pass back to SConstruct
9524382Sbinkertn@umich.eduenvList = []
9534382Sbinkertn@umich.edu
9546143Snate@binkert.orgdate_source = Source('base/date.cc', skip_lib=True)
955955SN/A
9562655Sstever@eecs.umich.edu# Function to create a new build environment as clone of current
9572655Sstever@eecs.umich.edu# environment 'env' with modified object suffix and optional stripped
9582655Sstever@eecs.umich.edu# binary.  Additional keyword arguments are appended to corresponding
9592655Sstever@eecs.umich.edu# build environment vars.
9602655Sstever@eecs.umich.edudef makeEnv(label, objsfx, strip = False, **kwargs):
9615601Snate@binkert.org    # SCons doesn't know to append a library suffix when there is a '.' in the
9625601Snate@binkert.org    # name.  Use '_' instead.
9635601Snate@binkert.org    libname = 'm5_' + label
9645601Snate@binkert.org    exename = 'm5.' + label
9655522Snate@binkert.org
9665863Snate@binkert.org    new_env = env.Clone(OBJSUFFIX=objsfx, SHOBJSUFFIX=objsfx + 's')
9675601Snate@binkert.org    new_env.Label = label
9685601Snate@binkert.org    new_env.Append(**kwargs)
9695601Snate@binkert.org
9705863Snate@binkert.org    swig_env = new_env.Clone()
9716143Snate@binkert.org    swig_env.Append(CCFLAGS='-Werror')
9725559Snate@binkert.org    if env['GCC']:
9735559Snate@binkert.org        swig_env.Append(CCFLAGS='-Wno-uninitialized')
9745559Snate@binkert.org        swig_env.Append(CCFLAGS='-Wno-sign-compare')
9755559Snate@binkert.org        swig_env.Append(CCFLAGS='-Wno-parentheses')
9765601Snate@binkert.org
9776143Snate@binkert.org    werror_env = new_env.Clone()
9786143Snate@binkert.org    werror_env.Append(CCFLAGS='-Werror')
9796143Snate@binkert.org
9806143Snate@binkert.org    def make_obj(source, static, extra_deps = None):
9816143Snate@binkert.org        '''This function adds the specified source to the correct
9826143Snate@binkert.org        build environment, and returns the corresponding SCons Object
9836143Snate@binkert.org        nodes'''
9846143Snate@binkert.org
9856143Snate@binkert.org        if source.swig:
9866143Snate@binkert.org            env = swig_env
9876143Snate@binkert.org        elif source.Werror:
9886143Snate@binkert.org            env = werror_env
9896143Snate@binkert.org        else:
9906143Snate@binkert.org            env = new_env
9916143Snate@binkert.org
9926143Snate@binkert.org        if static:
9936143Snate@binkert.org            obj = env.StaticObject(source.tnode)
9946143Snate@binkert.org        else:
9956143Snate@binkert.org            obj = env.SharedObject(source.tnode)
9966143Snate@binkert.org
9976143Snate@binkert.org        if extra_deps:
9986143Snate@binkert.org            env.Depends(obj, extra_deps)
9996143Snate@binkert.org
10006143Snate@binkert.org        return obj
10016143Snate@binkert.org
10026143Snate@binkert.org    static_objs = [ make_obj(s, True) for s in Source.get(skip_lib=False)]
10036143Snate@binkert.org    shared_objs = [ make_obj(s, False) for s in Source.get(skip_lib=False)]
10046143Snate@binkert.org
10056143Snate@binkert.org    static_date = make_obj(date_source, static=True, extra_deps=static_objs)
10066143Snate@binkert.org    static_objs.append(static_date)
10076143Snate@binkert.org    
10086143Snate@binkert.org    shared_date = make_obj(date_source, static=False, extra_deps=shared_objs)
10096240Snate@binkert.org    shared_objs.append(shared_date)
10105554Snate@binkert.org
10115522Snate@binkert.org    # First make a library of everything but main() so other programs can
10125522Snate@binkert.org    # link against m5.
10135797Snate@binkert.org    static_lib = new_env.StaticLibrary(libname, static_objs)
10145797Snate@binkert.org    shared_lib = new_env.SharedLibrary(libname, shared_objs)
10155522Snate@binkert.org
10165584Snate@binkert.org    for target, sources in unit_tests:
10176143Snate@binkert.org        objs = [ make_obj(s, static=True) for s in sources ]
10185862Snate@binkert.org        new_env.Program("unittest/%s.%s" % (target, label), objs + static_objs)
10195584Snate@binkert.org
10205601Snate@binkert.org    # Now link a stub with main() and the static library.
10216143Snate@binkert.org    bin_objs = [make_obj(s, True) for s in Source.get(bin_only=True) ]
10226143Snate@binkert.org    progname = exename
10232655Sstever@eecs.umich.edu    if strip:
10246143Snate@binkert.org        progname += '.unstripped'
10256143Snate@binkert.org
10266143Snate@binkert.org    targets = new_env.Program(progname, bin_objs + static_objs)
10276143Snate@binkert.org
10286143Snate@binkert.org    if strip:
10294007Ssaidi@eecs.umich.edu        if sys.platform == 'sunos5':
10304596Sbinkertn@umich.edu            cmd = 'cp $SOURCE $TARGET; strip $TARGET'
10314007Ssaidi@eecs.umich.edu        else:
10324596Sbinkertn@umich.edu            cmd = 'strip $SOURCE -o $TARGET'
10336143Snate@binkert.org        targets = new_env.Command(exename, progname, cmd)
10345522Snate@binkert.org            
10355601Snate@binkert.org    new_env.M5Binary = targets[0]
10365601Snate@binkert.org    envList.append(new_env)
10372655Sstever@eecs.umich.edu
1038955SN/A# Debug binary
10393918Ssaidi@eecs.umich.educcflags = {}
10403918Ssaidi@eecs.umich.eduif env['GCC']:
10413918Ssaidi@eecs.umich.edu    if sys.platform == 'sunos5':
10423918Ssaidi@eecs.umich.edu        ccflags['debug'] = '-gstabs+'
10433918Ssaidi@eecs.umich.edu    else:
10443918Ssaidi@eecs.umich.edu        ccflags['debug'] = '-ggdb3'
10453918Ssaidi@eecs.umich.edu    ccflags['opt'] = '-g -O3'
10463918Ssaidi@eecs.umich.edu    ccflags['fast'] = '-O3'
10473918Ssaidi@eecs.umich.edu    ccflags['prof'] = '-O3 -g -pg'
10483918Ssaidi@eecs.umich.eduelif env['SUNCC']:
10493918Ssaidi@eecs.umich.edu    ccflags['debug'] = '-g0'
10503918Ssaidi@eecs.umich.edu    ccflags['opt'] = '-g -O'
10513918Ssaidi@eecs.umich.edu    ccflags['fast'] = '-fast'
10523918Ssaidi@eecs.umich.edu    ccflags['prof'] = '-fast -g -pg'
10533940Ssaidi@eecs.umich.eduelif env['ICC']:
10543940Ssaidi@eecs.umich.edu    ccflags['debug'] = '-g -O0'
10553940Ssaidi@eecs.umich.edu    ccflags['opt'] = '-g -O'
10563942Ssaidi@eecs.umich.edu    ccflags['fast'] = '-fast'
10573940Ssaidi@eecs.umich.edu    ccflags['prof'] = '-fast -g -pg'
10583515Ssaidi@eecs.umich.eduelse:
10593918Ssaidi@eecs.umich.edu    print 'Unknown compiler, please fix compiler options'
10604762Snate@binkert.org    Exit(1)
10613515Ssaidi@eecs.umich.edu
10622655Sstever@eecs.umich.edumakeEnv('debug', '.do',
10633918Ssaidi@eecs.umich.edu        CCFLAGS = Split(ccflags['debug']),
10643619Sbinkertn@umich.edu        CPPDEFINES = ['DEBUG', 'TRACING_ON=1'])
1065955SN/A
1066955SN/A# Optimized binary
10672655Sstever@eecs.umich.edumakeEnv('opt', '.o',
10683918Ssaidi@eecs.umich.edu        CCFLAGS = Split(ccflags['opt']),
10693619Sbinkertn@umich.edu        CPPDEFINES = ['TRACING_ON=1'])
1070955SN/A
1071955SN/A# "Fast" binary
10722655Sstever@eecs.umich.edumakeEnv('fast', '.fo', strip = True,
10733918Ssaidi@eecs.umich.edu        CCFLAGS = Split(ccflags['fast']),
10743619Sbinkertn@umich.edu        CPPDEFINES = ['NDEBUG', 'TRACING_ON=0'])
1075955SN/A
1076955SN/A# Profiled binary
10772655Sstever@eecs.umich.edumakeEnv('prof', '.po',
10783918Ssaidi@eecs.umich.edu        CCFLAGS = Split(ccflags['prof']),
10793683Sstever@eecs.umich.edu        CPPDEFINES = ['NDEBUG', 'TRACING_ON=0'],
10802655Sstever@eecs.umich.edu        LINKFLAGS = '-pg')
10811869SN/A
10821869SN/AReturn('envList')
1083