SConscript revision 10259
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 448334Snate@binkert.org# This file defines how to build a particular configuration of gem5 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 548614Sgblack@eecs.umich.edufrom m5.util import code_formatter, compareVersions 557674Snate@binkert.org 566143Snate@binkert.org######################################################################## 576143Snate@binkert.org# Code for adding source files of various types 586143Snate@binkert.org# 598233Snate@binkert.org# When specifying a source file of some type, a set of guards can be 608233Snate@binkert.org# specified for that file. When get() is used to find the files, if 618233Snate@binkert.org# get specifies a set of filters, only files that match those filters 628233Snate@binkert.org# will be accepted (unspecified filters on files are assumed to be 638233Snate@binkert.org# false). Current filters are: 648334Snate@binkert.org# main -- specifies the gem5 main() function 658334Snate@binkert.org# skip_lib -- do not put this file into the gem5 library 668233Snate@binkert.org# <unittest> -- unit tests use filters based on the unit test name 678233Snate@binkert.org# 688233Snate@binkert.org# A parent can now be specified for a source file and default filter 698233Snate@binkert.org# values will be retrieved recursively from parents (children override 708233Snate@binkert.org# parents). 718233Snate@binkert.org# 726143Snate@binkert.orgclass SourceMeta(type): 738233Snate@binkert.org '''Meta class for source files that keeps track of all files of a 748233Snate@binkert.org particular type and has a get function for finding all functions 758233Snate@binkert.org of a certain type that match a set of guards''' 766143Snate@binkert.org def __init__(cls, name, bases, dict): 776143Snate@binkert.org super(SourceMeta, cls).__init__(name, bases, dict) 786143Snate@binkert.org cls.all = [] 796143Snate@binkert.org 808233Snate@binkert.org def get(cls, **guards): 818233Snate@binkert.org '''Find all files that match the specified guards. If a source 828233Snate@binkert.org file does not specify a flag, the default is False''' 836143Snate@binkert.org for src in cls.all: 848233Snate@binkert.org for flag,value in guards.iteritems(): 858233Snate@binkert.org # if the flag is found and has a different value, skip 868233Snate@binkert.org # this file 878233Snate@binkert.org if src.all_guards.get(flag, False) != value: 886143Snate@binkert.org break 896143Snate@binkert.org else: 906143Snate@binkert.org yield src 914762Snate@binkert.org 926143Snate@binkert.orgclass SourceFile(object): 938233Snate@binkert.org '''Base object that encapsulates the notion of a source file. 948233Snate@binkert.org This includes, the source node, target node, various manipulations 958233Snate@binkert.org of those. A source file also specifies a set of guards which 968233Snate@binkert.org describing which builds the source file applies to. A parent can 978233Snate@binkert.org also be specified to get default guards from''' 986143Snate@binkert.org __metaclass__ = SourceMeta 998233Snate@binkert.org def __init__(self, source, parent=None, **guards): 1008233Snate@binkert.org self.guards = guards 1018233Snate@binkert.org self.parent = parent 1028233Snate@binkert.org 1036143Snate@binkert.org tnode = source 1046143Snate@binkert.org if not isinstance(source, SCons.Node.FS.File): 1056143Snate@binkert.org tnode = File(source) 1066143Snate@binkert.org 1076143Snate@binkert.org self.tnode = tnode 1086143Snate@binkert.org self.snode = tnode.srcnode() 1096143Snate@binkert.org 1106143Snate@binkert.org for base in type(self).__mro__: 1116143Snate@binkert.org if issubclass(base, SourceFile): 1127065Snate@binkert.org base.all.append(self) 1136143Snate@binkert.org 1148233Snate@binkert.org @property 1158233Snate@binkert.org def filename(self): 1168233Snate@binkert.org return str(self.tnode) 1178233Snate@binkert.org 1188233Snate@binkert.org @property 1198233Snate@binkert.org def dirname(self): 1208233Snate@binkert.org return dirname(self.filename) 1218233Snate@binkert.org 1228233Snate@binkert.org @property 1238233Snate@binkert.org def basename(self): 1248233Snate@binkert.org return basename(self.filename) 1258233Snate@binkert.org 1268233Snate@binkert.org @property 1278233Snate@binkert.org def extname(self): 1288233Snate@binkert.org index = self.basename.rfind('.') 1298233Snate@binkert.org if index <= 0: 1308233Snate@binkert.org # dot files aren't extensions 1318233Snate@binkert.org return self.basename, None 1328233Snate@binkert.org 1338233Snate@binkert.org return self.basename[:index], self.basename[index+1:] 1348233Snate@binkert.org 1358233Snate@binkert.org @property 1368233Snate@binkert.org def all_guards(self): 1378233Snate@binkert.org '''find all guards for this object getting default values 1388233Snate@binkert.org recursively from its parents''' 1398233Snate@binkert.org guards = {} 1408233Snate@binkert.org if self.parent: 1418233Snate@binkert.org guards.update(self.parent.guards) 1428233Snate@binkert.org guards.update(self.guards) 1438233Snate@binkert.org return guards 1448233Snate@binkert.org 1456143Snate@binkert.org def __lt__(self, other): return self.filename < other.filename 1466143Snate@binkert.org def __le__(self, other): return self.filename <= other.filename 1476143Snate@binkert.org def __gt__(self, other): return self.filename > other.filename 1486143Snate@binkert.org def __ge__(self, other): return self.filename >= other.filename 1496143Snate@binkert.org def __eq__(self, other): return self.filename == other.filename 1506143Snate@binkert.org def __ne__(self, other): return self.filename != other.filename 1519982Satgutier@umich.edu 15210196SCurtis.Dunham@arm.com @staticmethod 15310196SCurtis.Dunham@arm.com def done(): 15410196SCurtis.Dunham@arm.com def disabled(cls, name, *ignored): 15510196SCurtis.Dunham@arm.com raise RuntimeError("Additional SourceFile '%s'" % name,\ 15610196SCurtis.Dunham@arm.com "declared, but targets deps are already fixed.") 15710196SCurtis.Dunham@arm.com SourceFile.__init__ = disabled 15810196SCurtis.Dunham@arm.com 15910196SCurtis.Dunham@arm.com 1606143Snate@binkert.orgclass Source(SourceFile): 1616143Snate@binkert.org '''Add a c/c++ source file to the build''' 1628945Ssteve.reinhardt@amd.com def __init__(self, source, Werror=True, swig=False, **guards): 1638233Snate@binkert.org '''specify the source file, and any guards''' 1648233Snate@binkert.org super(Source, self).__init__(source, **guards) 1656143Snate@binkert.org 1668945Ssteve.reinhardt@amd.com self.Werror = Werror 1676143Snate@binkert.org self.swig = swig 1686143Snate@binkert.org 1696143Snate@binkert.orgclass PySource(SourceFile): 1706143Snate@binkert.org '''Add a python source file to the named package''' 1715522Snate@binkert.org invalid_sym_char = re.compile('[^A-z0-9_]') 1726143Snate@binkert.org modules = {} 1736143Snate@binkert.org tnodes = {} 1746143Snate@binkert.org symnames = {} 1759982Satgutier@umich.edu 1768233Snate@binkert.org def __init__(self, package, source, **guards): 1778233Snate@binkert.org '''specify the python package, the source file, and any guards''' 1788233Snate@binkert.org super(PySource, self).__init__(source, **guards) 1796143Snate@binkert.org 1806143Snate@binkert.org modname,ext = self.extname 1816143Snate@binkert.org assert ext == 'py' 1826143Snate@binkert.org 1835522Snate@binkert.org if package: 1845522Snate@binkert.org path = package.split('.') 1855522Snate@binkert.org else: 1865522Snate@binkert.org path = [] 1875604Snate@binkert.org 1885604Snate@binkert.org modpath = path[:] 1896143Snate@binkert.org if modname != '__init__': 1906143Snate@binkert.org modpath += [ modname ] 1914762Snate@binkert.org modpath = '.'.join(modpath) 1924762Snate@binkert.org 1936143Snate@binkert.org arcpath = path + [ self.basename ] 1946727Ssteve.reinhardt@amd.com abspath = self.snode.abspath 1956727Ssteve.reinhardt@amd.com if not exists(abspath): 1966727Ssteve.reinhardt@amd.com abspath = self.tnode.abspath 1974762Snate@binkert.org 1986143Snate@binkert.org self.package = package 1996143Snate@binkert.org self.modname = modname 2006143Snate@binkert.org self.modpath = modpath 2016143Snate@binkert.org self.arcname = joinpath(*arcpath) 2026727Ssteve.reinhardt@amd.com self.abspath = abspath 2036143Snate@binkert.org self.compiled = File(self.filename + 'c') 2047674Snate@binkert.org self.cpp = File(self.filename + '.cc') 2057674Snate@binkert.org self.symname = PySource.invalid_sym_char.sub('_', modpath) 2065604Snate@binkert.org 2076143Snate@binkert.org PySource.modules[modpath] = self 2086143Snate@binkert.org PySource.tnodes[self.tnode] = self 2096143Snate@binkert.org PySource.symnames[self.symname] = self 2104762Snate@binkert.org 2116143Snate@binkert.orgclass SimObject(PySource): 2124762Snate@binkert.org '''Add a SimObject python file as a python source object and add 2134762Snate@binkert.org it to a list of sim object modules''' 2144762Snate@binkert.org 2156143Snate@binkert.org fixed = False 2166143Snate@binkert.org modnames = [] 2174762Snate@binkert.org 2188233Snate@binkert.org def __init__(self, source, **guards): 2198233Snate@binkert.org '''Specify the source file and any guards (automatically in 2208233Snate@binkert.org the m5.objects package)''' 2218233Snate@binkert.org super(SimObject, self).__init__('m5.objects', source, **guards) 2226143Snate@binkert.org if self.fixed: 2236143Snate@binkert.org raise AttributeError, "Too late to call SimObject now." 2244762Snate@binkert.org 2256143Snate@binkert.org bisect.insort_right(SimObject.modnames, self.modname) 2264762Snate@binkert.org 2276143Snate@binkert.orgclass SwigSource(SourceFile): 2284762Snate@binkert.org '''Add a swig file to build''' 2296143Snate@binkert.org 2308233Snate@binkert.org def __init__(self, package, source, **guards): 2318233Snate@binkert.org '''Specify the python package, the source file, and any guards''' 2328233Snate@binkert.org super(SwigSource, self).__init__(source, **guards) 2336143Snate@binkert.org 2346143Snate@binkert.org modname,ext = self.extname 2356143Snate@binkert.org assert ext == 'i' 2366143Snate@binkert.org 2376143Snate@binkert.org self.module = modname 2386143Snate@binkert.org cc_file = joinpath(self.dirname, modname + '_wrap.cc') 2396143Snate@binkert.org py_file = joinpath(self.dirname, modname + '.py') 2406143Snate@binkert.org 2418233Snate@binkert.org self.cc_source = Source(cc_file, swig=True, parent=self) 2428233Snate@binkert.org self.py_source = PySource(package, py_file, parent=self) 243955SN/A 2449396Sandreas.hansson@arm.comclass ProtoBuf(SourceFile): 2459396Sandreas.hansson@arm.com '''Add a Protocol Buffer to build''' 2469396Sandreas.hansson@arm.com 2479396Sandreas.hansson@arm.com def __init__(self, source, **guards): 2489396Sandreas.hansson@arm.com '''Specify the source file, and any guards''' 2499396Sandreas.hansson@arm.com super(ProtoBuf, self).__init__(source, **guards) 2509396Sandreas.hansson@arm.com 2519396Sandreas.hansson@arm.com # Get the file name and the extension 2529396Sandreas.hansson@arm.com modname,ext = self.extname 2539396Sandreas.hansson@arm.com assert ext == 'proto' 2549396Sandreas.hansson@arm.com 2559396Sandreas.hansson@arm.com # Currently, we stick to generating the C++ headers, so we 2569396Sandreas.hansson@arm.com # only need to track the source and header. 2579930Sandreas.hansson@arm.com self.cc_file = File(modname + '.pb.cc') 2589930Sandreas.hansson@arm.com self.hh_file = File(modname + '.pb.h') 2599396Sandreas.hansson@arm.com 2608235Snate@binkert.orgclass UnitTest(object): 2618235Snate@binkert.org '''Create a UnitTest''' 2626143Snate@binkert.org 2638235Snate@binkert.org all = [] 2649003SAli.Saidi@ARM.com def __init__(self, target, *sources, **kwargs): 2658235Snate@binkert.org '''Specify the target name and any sources. Sources that are 2668235Snate@binkert.org not SourceFiles are evalued with Source(). All files are 2678235Snate@binkert.org guarded with a guard of the same name as the UnitTest 2688235Snate@binkert.org target.''' 2698235Snate@binkert.org 2708235Snate@binkert.org srcs = [] 2718235Snate@binkert.org for src in sources: 2728235Snate@binkert.org if not isinstance(src, SourceFile): 2738235Snate@binkert.org src = Source(src, skip_lib=True) 2748235Snate@binkert.org src.guards[target] = True 2758235Snate@binkert.org srcs.append(src) 2768235Snate@binkert.org 2778235Snate@binkert.org self.sources = srcs 2788235Snate@binkert.org self.target = target 2799003SAli.Saidi@ARM.com self.main = kwargs.get('main', False) 2808235Snate@binkert.org UnitTest.all.append(self) 2815584Snate@binkert.org 2824382Sbinkertn@umich.edu# Children should have access 2834202Sbinkertn@umich.eduExport('Source') 2844382Sbinkertn@umich.eduExport('PySource') 2854382Sbinkertn@umich.eduExport('SimObject') 2864382Sbinkertn@umich.eduExport('SwigSource') 2879396Sandreas.hansson@arm.comExport('ProtoBuf') 2885584Snate@binkert.orgExport('UnitTest') 2894382Sbinkertn@umich.edu 2904382Sbinkertn@umich.edu######################################################################## 2914382Sbinkertn@umich.edu# 2928232Snate@binkert.org# Debug Flags 2935192Ssaidi@eecs.umich.edu# 2948232Snate@binkert.orgdebug_flags = {} 2958232Snate@binkert.orgdef DebugFlag(name, desc=None): 2968232Snate@binkert.org if name in debug_flags: 2975192Ssaidi@eecs.umich.edu raise AttributeError, "Flag %s already specified" % name 2988232Snate@binkert.org debug_flags[name] = (name, (), desc) 2995192Ssaidi@eecs.umich.edu 3005799Snate@binkert.orgdef CompoundFlag(name, flags, desc=None): 3018232Snate@binkert.org if name in debug_flags: 3025192Ssaidi@eecs.umich.edu raise AttributeError, "Flag %s already specified" % name 3035192Ssaidi@eecs.umich.edu 3045192Ssaidi@eecs.umich.edu compound = tuple(flags) 3058232Snate@binkert.org debug_flags[name] = (name, compound, desc) 3065192Ssaidi@eecs.umich.edu 3078232Snate@binkert.orgExport('DebugFlag') 3085192Ssaidi@eecs.umich.eduExport('CompoundFlag') 3095192Ssaidi@eecs.umich.edu 3105192Ssaidi@eecs.umich.edu######################################################################## 3115192Ssaidi@eecs.umich.edu# 3124382Sbinkertn@umich.edu# Set some compiler variables 3134382Sbinkertn@umich.edu# 3144382Sbinkertn@umich.edu 3152667Sstever@eecs.umich.edu# Include file paths are rooted in this directory. SCons will 3162667Sstever@eecs.umich.edu# automatically expand '.' to refer to both the source directory and 3172667Sstever@eecs.umich.edu# the corresponding build directory to pick up generated include 3182667Sstever@eecs.umich.edu# files. 3192667Sstever@eecs.umich.eduenv.Append(CPPPATH=Dir('.')) 3202667Sstever@eecs.umich.edu 3215742Snate@binkert.orgfor extra_dir in extras_dir_list: 3225742Snate@binkert.org env.Append(CPPPATH=Dir(extra_dir)) 3235742Snate@binkert.org 3245793Snate@binkert.org# Workaround for bug in SCons version > 0.97d20071212 3258334Snate@binkert.org# Scons bug id: 2006 gem5 Bug id: 308 3265793Snate@binkert.orgfor root, dirs, files in os.walk(base_dir, topdown=True): 3275793Snate@binkert.org Dir(root[len(base_dir) + 1:]) 3285793Snate@binkert.org 3294382Sbinkertn@umich.edu######################################################################## 3304762Snate@binkert.org# 3315344Sstever@gmail.com# Walk the tree and execute all SConscripts in subdirectories 3324382Sbinkertn@umich.edu# 3335341Sstever@gmail.com 3345742Snate@binkert.orghere = Dir('.').srcnode().abspath 3355742Snate@binkert.orgfor root, dirs, files in os.walk(base_dir, topdown=True): 3365742Snate@binkert.org if root == here: 3375742Snate@binkert.org # we don't want to recurse back into this SConscript 3385742Snate@binkert.org continue 3394762Snate@binkert.org 3405742Snate@binkert.org if 'SConscript' in files: 3415742Snate@binkert.org build_dir = joinpath(env['BUILDDIR'], root[len(base_dir) + 1:]) 3427722Sgblack@eecs.umich.edu SConscript(joinpath(root, 'SConscript'), variant_dir=build_dir) 3435742Snate@binkert.org 3445742Snate@binkert.orgfor extra_dir in extras_dir_list: 3455742Snate@binkert.org prefix_len = len(dirname(extra_dir)) + 1 3469930Sandreas.hansson@arm.com 3479930Sandreas.hansson@arm.com # Also add the corresponding build directory to pick up generated 3489930Sandreas.hansson@arm.com # include files. 3499930Sandreas.hansson@arm.com env.Append(CPPPATH=Dir(joinpath(env['BUILDDIR'], extra_dir[prefix_len:]))) 3509930Sandreas.hansson@arm.com 3515742Snate@binkert.org for root, dirs, files in os.walk(extra_dir, topdown=True): 3528242Sbradley.danofsky@amd.com # if build lives in the extras directory, don't walk down it 3538242Sbradley.danofsky@amd.com if 'build' in dirs: 3548242Sbradley.danofsky@amd.com dirs.remove('build') 3558242Sbradley.danofsky@amd.com 3565341Sstever@gmail.com if 'SConscript' in files: 3575742Snate@binkert.org build_dir = joinpath(env['BUILDDIR'], root[prefix_len:]) 3587722Sgblack@eecs.umich.edu SConscript(joinpath(root, 'SConscript'), variant_dir=build_dir) 3594773Snate@binkert.org 3606108Snate@binkert.orgfor opt in export_vars: 3611858SN/A env.ConfigFile(opt) 3621085SN/A 3636658Snate@binkert.orgdef makeTheISA(source, target, env): 3646658Snate@binkert.org isas = [ src.get_contents() for src in source ] 3657673Snate@binkert.org target_isa = env['TARGET_ISA'] 3666658Snate@binkert.org def define(isa): 3676658Snate@binkert.org return isa.upper() + '_ISA' 3686658Snate@binkert.org 3696658Snate@binkert.org def namespace(isa): 3706658Snate@binkert.org return isa[0].upper() + isa[1:].lower() + 'ISA' 3716658Snate@binkert.org 3726658Snate@binkert.org 3737673Snate@binkert.org code = code_formatter() 3747673Snate@binkert.org code('''\ 3757673Snate@binkert.org#ifndef __CONFIG_THE_ISA_HH__ 3767673Snate@binkert.org#define __CONFIG_THE_ISA_HH__ 3777673Snate@binkert.org 3787673Snate@binkert.org''') 3797673Snate@binkert.org 3806658Snate@binkert.org for i,isa in enumerate(isas): 3817673Snate@binkert.org code('#define $0 $1', define(isa), i + 1) 3827673Snate@binkert.org 3837673Snate@binkert.org code(''' 3847673Snate@binkert.org 3857673Snate@binkert.org#define THE_ISA ${{define(target_isa)}} 3867673Snate@binkert.org#define TheISA ${{namespace(target_isa)}} 3879048SAli.Saidi@ARM.com#define THE_ISA_STR "${{target_isa}}" 3887673Snate@binkert.org 3897673Snate@binkert.org#endif // __CONFIG_THE_ISA_HH__''') 3907673Snate@binkert.org 3917673Snate@binkert.org code.write(str(target[0])) 3926658Snate@binkert.org 3937756SAli.Saidi@ARM.comenv.Command('config/the_isa.hh', map(Value, all_isa_list), 3947816Ssteve.reinhardt@amd.com MakeAction(makeTheISA, Transform("CFG ISA", 0))) 3956658Snate@binkert.org 3964382Sbinkertn@umich.edu######################################################################## 3974382Sbinkertn@umich.edu# 3984762Snate@binkert.org# Prevent any SimObjects from being added after this point, they 3994762Snate@binkert.org# should all have been added in the SConscripts above 4004762Snate@binkert.org# 4016654Snate@binkert.orgSimObject.fixed = True 4026654Snate@binkert.org 4035517Snate@binkert.orgclass DictImporter(object): 4045517Snate@binkert.org '''This importer takes a dictionary of arbitrary module names that 4055517Snate@binkert.org map to arbitrary filenames.''' 4065517Snate@binkert.org def __init__(self, modules): 4075517Snate@binkert.org self.modules = modules 4085517Snate@binkert.org self.installed = set() 4095517Snate@binkert.org 4105517Snate@binkert.org def __del__(self): 4115517Snate@binkert.org self.unload() 4125517Snate@binkert.org 4135517Snate@binkert.org def unload(self): 4145517Snate@binkert.org import sys 4155517Snate@binkert.org for module in self.installed: 4165517Snate@binkert.org del sys.modules[module] 4175517Snate@binkert.org self.installed = set() 4185517Snate@binkert.org 4195517Snate@binkert.org def find_module(self, fullname, path): 4206654Snate@binkert.org if fullname == 'm5.defines': 4215517Snate@binkert.org return self 4225517Snate@binkert.org 4235517Snate@binkert.org if fullname == 'm5.objects': 4245517Snate@binkert.org return self 4255517Snate@binkert.org 4265517Snate@binkert.org if fullname.startswith('m5.internal'): 4275517Snate@binkert.org return None 4285517Snate@binkert.org 4296143Snate@binkert.org source = self.modules.get(fullname, None) 4306654Snate@binkert.org if source is not None and fullname.startswith('m5.objects'): 4315517Snate@binkert.org return self 4325517Snate@binkert.org 4335517Snate@binkert.org return None 4345517Snate@binkert.org 4355517Snate@binkert.org def load_module(self, fullname): 4365517Snate@binkert.org mod = imp.new_module(fullname) 4375517Snate@binkert.org sys.modules[fullname] = mod 4385517Snate@binkert.org self.installed.add(fullname) 4395517Snate@binkert.org 4405517Snate@binkert.org mod.__loader__ = self 4415517Snate@binkert.org if fullname == 'm5.objects': 4425517Snate@binkert.org mod.__path__ = fullname.split('.') 4435517Snate@binkert.org return mod 4445517Snate@binkert.org 4456654Snate@binkert.org if fullname == 'm5.defines': 4466654Snate@binkert.org mod.__dict__['buildEnv'] = m5.util.SmartDict(build_env) 4475517Snate@binkert.org return mod 4485517Snate@binkert.org 4496143Snate@binkert.org source = self.modules[fullname] 4506143Snate@binkert.org if source.modname == '__init__': 4516143Snate@binkert.org mod.__path__ = source.modpath 4526727Ssteve.reinhardt@amd.com mod.__file__ = source.abspath 4535517Snate@binkert.org 4546727Ssteve.reinhardt@amd.com exec file(source.abspath, 'r') in mod.__dict__ 4555517Snate@binkert.org 4565517Snate@binkert.org return mod 4575517Snate@binkert.org 4586654Snate@binkert.orgimport m5.SimObject 4596654Snate@binkert.orgimport m5.params 4607673Snate@binkert.orgfrom m5.util import code_formatter 4616654Snate@binkert.org 4626654Snate@binkert.orgm5.SimObject.clear() 4636654Snate@binkert.orgm5.params.clear() 4646654Snate@binkert.org 4655517Snate@binkert.org# install the python importer so we can grab stuff from the source 4665517Snate@binkert.org# tree itself. We can't have SimObjects added after this point or 4675517Snate@binkert.org# else we won't know about them for the rest of the stuff. 4686143Snate@binkert.orgimporter = DictImporter(PySource.modules) 4695517Snate@binkert.orgsys.meta_path[0:0] = [ importer ] 4704762Snate@binkert.org 4715517Snate@binkert.org# import all sim objects so we can populate the all_objects list 4725517Snate@binkert.org# make sure that we're working with a list, then let's sort it 4736143Snate@binkert.orgfor modname in SimObject.modnames: 4746143Snate@binkert.org exec('from m5.objects import %s' % modname) 4755517Snate@binkert.org 4765517Snate@binkert.org# we need to unload all of the currently imported modules so that they 4775517Snate@binkert.org# will be re-imported the next time the sconscript is run 4785517Snate@binkert.orgimporter.unload() 4795517Snate@binkert.orgsys.meta_path.remove(importer) 4805517Snate@binkert.org 4815517Snate@binkert.orgsim_objects = m5.SimObject.allClasses 4825517Snate@binkert.orgall_enums = m5.params.allEnums 4835517Snate@binkert.org 4849338SAndreas.Sandberg@arm.comif m5.SimObject.noCxxHeader: 4859338SAndreas.Sandberg@arm.com print >> sys.stderr, \ 4869338SAndreas.Sandberg@arm.com "warning: At least one SimObject lacks a header specification. " \ 4879338SAndreas.Sandberg@arm.com "This can cause unexpected results in the generated SWIG " \ 4889338SAndreas.Sandberg@arm.com "wrappers." 4899338SAndreas.Sandberg@arm.com 4908596Ssteve.reinhardt@amd.com# Find param types that need to be explicitly wrapped with swig. 4918596Ssteve.reinhardt@amd.com# These will be recognized because the ParamDesc will have a 4928596Ssteve.reinhardt@amd.com# swig_decl() method. Most param types are based on types that don't 4938596Ssteve.reinhardt@amd.com# need this, either because they're based on native types (like Int) 4948596Ssteve.reinhardt@amd.com# or because they're SimObjects (which get swigged independently). 4958596Ssteve.reinhardt@amd.com# For now the only things handled here are VectorParam types. 4968596Ssteve.reinhardt@amd.comparams_to_swig = {} 4976143Snate@binkert.orgfor name,obj in sorted(sim_objects.iteritems()): 4985517Snate@binkert.org for param in obj._params.local.values(): 4996654Snate@binkert.org # load the ptype attribute now because it depends on the 5006654Snate@binkert.org # current version of SimObject.allClasses, but when scons 5016654Snate@binkert.org # actually uses the value, all versions of 5026654Snate@binkert.org # SimObject.allClasses will have been loaded 5036654Snate@binkert.org param.ptype 5046654Snate@binkert.org 5055517Snate@binkert.org if not hasattr(param, 'swig_decl'): 5065517Snate@binkert.org continue 5075517Snate@binkert.org pname = param.ptype_str 5088596Ssteve.reinhardt@amd.com if pname not in params_to_swig: 5098596Ssteve.reinhardt@amd.com params_to_swig[pname] = param 5104762Snate@binkert.org 5114762Snate@binkert.org######################################################################## 5124762Snate@binkert.org# 5134762Snate@binkert.org# calculate extra dependencies 5144762Snate@binkert.org# 5154762Snate@binkert.orgmodule_depends = ["m5", "m5.SimObject", "m5.params"] 5167675Snate@binkert.orgdepends = [ PySource.modules[dep].snode for dep in module_depends ] 5174762Snate@binkert.org 5184762Snate@binkert.org######################################################################## 5194762Snate@binkert.org# 5204762Snate@binkert.org# Commands for the basic automatically generated python files 5214382Sbinkertn@umich.edu# 5224382Sbinkertn@umich.edu 5235517Snate@binkert.org# Generate Python file containing a dict specifying the current 5246654Snate@binkert.org# buildEnv flags. 5255517Snate@binkert.orgdef makeDefinesPyFile(target, source, env): 5268126Sgblack@eecs.umich.edu build_env = source[0].get_contents() 5276654Snate@binkert.org 5287673Snate@binkert.org code = code_formatter() 5296654Snate@binkert.org code(""" 5306654Snate@binkert.orgimport m5.internal 5316654Snate@binkert.orgimport m5.util 5326654Snate@binkert.org 5336654Snate@binkert.orgbuildEnv = m5.util.SmartDict($build_env) 5346654Snate@binkert.org 5356654Snate@binkert.orgcompileDate = m5.internal.core.compileDate 5366669Snate@binkert.org_globals = globals() 5376669Snate@binkert.orgfor key,val in m5.internal.core.__dict__.iteritems(): 5386669Snate@binkert.org if key.startswith('flag_'): 5396669Snate@binkert.org flag = key[5:] 5406669Snate@binkert.org _globals[flag] = val 5416669Snate@binkert.orgdel _globals 5426654Snate@binkert.org""") 5437673Snate@binkert.org code.write(target[0].abspath) 5445517Snate@binkert.org 5458126Sgblack@eecs.umich.edudefines_info = Value(build_env) 5465798Snate@binkert.org# Generate a file with all of the compile options in it 5477756SAli.Saidi@ARM.comenv.Command('python/m5/defines.py', defines_info, 5487816Ssteve.reinhardt@amd.com MakeAction(makeDefinesPyFile, Transform("DEFINES", 0))) 5495798Snate@binkert.orgPySource('m5', 'python/m5/defines.py') 5505798Snate@binkert.org 5515517Snate@binkert.org# Generate python file containing info about the M5 source code 5525517Snate@binkert.orgdef makeInfoPyFile(target, source, env): 5537673Snate@binkert.org code = code_formatter() 5545517Snate@binkert.org for src in source: 5555517Snate@binkert.org data = ''.join(file(src.srcnode().abspath, 'r').xreadlines()) 5567673Snate@binkert.org code('$src = ${{repr(data)}}') 5577673Snate@binkert.org code.write(str(target[0])) 5585517Snate@binkert.org 5595798Snate@binkert.org# Generate a file that wraps the basic top level files 5605798Snate@binkert.orgenv.Command('python/m5/info.py', 5618333Snate@binkert.org [ '#/COPYING', '#/LICENSE', '#/README', ], 5627816Ssteve.reinhardt@amd.com MakeAction(makeInfoPyFile, Transform("INFO"))) 5635798Snate@binkert.orgPySource('m5', 'python/m5/info.py') 5645798Snate@binkert.org 5654762Snate@binkert.org######################################################################## 5664762Snate@binkert.org# 5674762Snate@binkert.org# Create all of the SimObject param headers and enum headers 5684762Snate@binkert.org# 5694762Snate@binkert.org 5708596Ssteve.reinhardt@amd.comdef createSimObjectParamStruct(target, source, env): 5715517Snate@binkert.org assert len(target) == 1 and len(source) == 1 5725517Snate@binkert.org 5735517Snate@binkert.org name = str(source[0].get_contents()) 5745517Snate@binkert.org obj = sim_objects[name] 5755517Snate@binkert.org 5767673Snate@binkert.org code = code_formatter() 5778596Ssteve.reinhardt@amd.com obj.cxx_param_decl(code) 5787673Snate@binkert.org code.write(target[0].abspath) 5795517Snate@binkert.org 5808596Ssteve.reinhardt@amd.comdef createParamSwigWrapper(target, source, env): 5815517Snate@binkert.org assert len(target) == 1 and len(source) == 1 5825517Snate@binkert.org 5835517Snate@binkert.org name = str(source[0].get_contents()) 5848596Ssteve.reinhardt@amd.com param = params_to_swig[name] 5855517Snate@binkert.org 5867673Snate@binkert.org code = code_formatter() 5877673Snate@binkert.org param.swig_decl(code) 5887673Snate@binkert.org code.write(target[0].abspath) 5895517Snate@binkert.org 5905517Snate@binkert.orgdef createEnumStrings(target, source, env): 5915517Snate@binkert.org assert len(target) == 1 and len(source) == 1 5925517Snate@binkert.org 5935517Snate@binkert.org name = str(source[0].get_contents()) 5945517Snate@binkert.org obj = all_enums[name] 5955517Snate@binkert.org 5967673Snate@binkert.org code = code_formatter() 5977673Snate@binkert.org obj.cxx_def(code) 5987673Snate@binkert.org code.write(target[0].abspath) 5995517Snate@binkert.org 6008596Ssteve.reinhardt@amd.comdef createEnumDecls(target, source, env): 6015517Snate@binkert.org assert len(target) == 1 and len(source) == 1 6025517Snate@binkert.org 6035517Snate@binkert.org name = str(source[0].get_contents()) 6045517Snate@binkert.org obj = all_enums[name] 6055517Snate@binkert.org 6067673Snate@binkert.org code = code_formatter() 6077673Snate@binkert.org obj.cxx_decl(code) 6087673Snate@binkert.org code.write(target[0].abspath) 6095517Snate@binkert.org 6108596Ssteve.reinhardt@amd.comdef createEnumSwigWrapper(target, source, env): 6117675Snate@binkert.org assert len(target) == 1 and len(source) == 1 6127675Snate@binkert.org 6137675Snate@binkert.org name = str(source[0].get_contents()) 6147675Snate@binkert.org obj = all_enums[name] 6157675Snate@binkert.org 6167675Snate@binkert.org code = code_formatter() 6178596Ssteve.reinhardt@amd.com obj.swig_decl(code) 6187675Snate@binkert.org code.write(target[0].abspath) 6197675Snate@binkert.org 6208596Ssteve.reinhardt@amd.comdef createSimObjectSwigWrapper(target, source, env): 6218596Ssteve.reinhardt@amd.com name = source[0].get_contents() 6228596Ssteve.reinhardt@amd.com obj = sim_objects[name] 6238596Ssteve.reinhardt@amd.com 6248596Ssteve.reinhardt@amd.com code = code_formatter() 6258596Ssteve.reinhardt@amd.com obj.swig_decl(code) 6268596Ssteve.reinhardt@amd.com code.write(target[0].abspath) 6278596Ssteve.reinhardt@amd.com 6288596Ssteve.reinhardt@amd.com# Generate all of the SimObject param C++ struct header files 6294762Snate@binkert.orgparams_hh_files = [] 6306143Snate@binkert.orgfor name,simobj in sorted(sim_objects.iteritems()): 6316143Snate@binkert.org py_source = PySource.modules[simobj.__module__] 6326143Snate@binkert.org extra_deps = [ py_source.tnode ] 6334762Snate@binkert.org 6344762Snate@binkert.org hh_file = File('params/%s.hh' % name) 6354762Snate@binkert.org params_hh_files.append(hh_file) 6367756SAli.Saidi@ARM.com env.Command(hh_file, Value(name), 6378596Ssteve.reinhardt@amd.com MakeAction(createSimObjectParamStruct, Transform("SO PARAM"))) 6384762Snate@binkert.org env.Depends(hh_file, depends + extra_deps) 6394762Snate@binkert.org 6408596Ssteve.reinhardt@amd.com# Generate any needed param SWIG wrapper files 6415463Snate@binkert.orgparams_i_files = [] 6428596Ssteve.reinhardt@amd.comfor name,param in params_to_swig.iteritems(): 6438596Ssteve.reinhardt@amd.com i_file = File('python/m5/internal/%s.i' % (param.swig_module_name())) 6445463Snate@binkert.org params_i_files.append(i_file) 6457756SAli.Saidi@ARM.com env.Command(i_file, Value(name), 6468596Ssteve.reinhardt@amd.com MakeAction(createParamSwigWrapper, Transform("SW PARAM"))) 6474762Snate@binkert.org env.Depends(i_file, depends) 6487677Snate@binkert.org SwigSource('m5.internal', i_file) 6494762Snate@binkert.org 6504762Snate@binkert.org# Generate all enum header files 6516143Snate@binkert.orgfor name,enum in sorted(all_enums.iteritems()): 6526143Snate@binkert.org py_source = PySource.modules[enum.__module__] 6536143Snate@binkert.org extra_deps = [ py_source.tnode ] 6544762Snate@binkert.org 6554762Snate@binkert.org cc_file = File('enums/%s.cc' % name) 6567756SAli.Saidi@ARM.com env.Command(cc_file, Value(name), 6577816Ssteve.reinhardt@amd.com MakeAction(createEnumStrings, Transform("ENUM STR"))) 6584762Snate@binkert.org env.Depends(cc_file, depends + extra_deps) 6594762Snate@binkert.org Source(cc_file) 6604762Snate@binkert.org 6614762Snate@binkert.org hh_file = File('enums/%s.hh' % name) 6627756SAli.Saidi@ARM.com env.Command(hh_file, Value(name), 6638596Ssteve.reinhardt@amd.com MakeAction(createEnumDecls, Transform("ENUMDECL"))) 6644762Snate@binkert.org env.Depends(hh_file, depends + extra_deps) 6654762Snate@binkert.org 6667677Snate@binkert.org i_file = File('python/m5/internal/enum_%s.i' % name) 6677756SAli.Saidi@ARM.com env.Command(i_file, Value(name), 6688596Ssteve.reinhardt@amd.com MakeAction(createEnumSwigWrapper, Transform("ENUMSWIG"))) 6697675Snate@binkert.org env.Depends(i_file, depends + extra_deps) 6707677Snate@binkert.org SwigSource('m5.internal', i_file) 6715517Snate@binkert.org 6728596Ssteve.reinhardt@amd.com# Generate SimObject SWIG wrapper files 6739248SAndreas.Sandberg@arm.comfor name,simobj in sim_objects.iteritems(): 6749248SAndreas.Sandberg@arm.com py_source = PySource.modules[simobj.__module__] 6759248SAndreas.Sandberg@arm.com extra_deps = [ py_source.tnode ] 6769248SAndreas.Sandberg@arm.com 6778596Ssteve.reinhardt@amd.com i_file = File('python/m5/internal/param_%s.i' % name) 6788596Ssteve.reinhardt@amd.com env.Command(i_file, Value(name), 6798596Ssteve.reinhardt@amd.com MakeAction(createSimObjectSwigWrapper, Transform("SO SWIG"))) 6809248SAndreas.Sandberg@arm.com env.Depends(i_file, depends + extra_deps) 6818596Ssteve.reinhardt@amd.com SwigSource('m5.internal', i_file) 6824762Snate@binkert.org 6837674Snate@binkert.org# Generate the main swig init file 6847674Snate@binkert.orgdef makeEmbeddedSwigInit(target, source, env): 6857674Snate@binkert.org code = code_formatter() 6867674Snate@binkert.org module = source[0].get_contents() 6877674Snate@binkert.org code('''\ 6887674Snate@binkert.org#include "sim/init.hh" 6897674Snate@binkert.org 6907674Snate@binkert.orgextern "C" { 6917674Snate@binkert.org void init_${module}(); 6927674Snate@binkert.org} 6937674Snate@binkert.org 6947674Snate@binkert.orgEmbeddedSwig embed_swig_${module}(init_${module}); 6957674Snate@binkert.org''') 6967674Snate@binkert.org code.write(str(target[0])) 6977674Snate@binkert.org 6984762Snate@binkert.org# Build all swig modules 6996143Snate@binkert.orgfor swig in SwigSource.all: 7006143Snate@binkert.org env.Command([swig.cc_source.tnode, swig.py_source.tnode], swig.tnode, 7017756SAli.Saidi@ARM.com MakeAction('$SWIG $SWIGFLAGS -outdir ${TARGETS[1].dir} ' 7027816Ssteve.reinhardt@amd.com '-o ${TARGETS[0]} $SOURCES', Transform("SWIG"))) 7038235Snate@binkert.org cc_file = str(swig.tnode) 7048596Ssteve.reinhardt@amd.com init_file = '%s/%s_init.cc' % (dirname(cc_file), basename(cc_file)) 7057756SAli.Saidi@ARM.com env.Command(init_file, Value(swig.module), 7067816Ssteve.reinhardt@amd.com MakeAction(makeEmbeddedSwigInit, Transform("EMBED SW"))) 7078235Snate@binkert.org Source(init_file, **swig.guards) 7084382Sbinkertn@umich.edu 7099396Sandreas.hansson@arm.com# Build all protocol buffers if we have got protoc and protobuf available 7109396Sandreas.hansson@arm.comif env['HAVE_PROTOBUF']: 7119396Sandreas.hansson@arm.com for proto in ProtoBuf.all: 7129396Sandreas.hansson@arm.com # Use both the source and header as the target, and the .proto 7139396Sandreas.hansson@arm.com # file as the source. When executing the protoc compiler, also 7149396Sandreas.hansson@arm.com # specify the proto_path to avoid having the generated files 7159396Sandreas.hansson@arm.com # include the path. 7169396Sandreas.hansson@arm.com env.Command([proto.cc_file, proto.hh_file], proto.tnode, 7179396Sandreas.hansson@arm.com MakeAction('$PROTOC --cpp_out ${TARGET.dir} ' 7189396Sandreas.hansson@arm.com '--proto_path ${SOURCE.dir} $SOURCE', 7199396Sandreas.hansson@arm.com Transform("PROTOC"))) 7209396Sandreas.hansson@arm.com 7219396Sandreas.hansson@arm.com # Add the C++ source file 7229396Sandreas.hansson@arm.com Source(proto.cc_file, **proto.guards) 7239396Sandreas.hansson@arm.comelif ProtoBuf.all: 7249396Sandreas.hansson@arm.com print 'Got protobuf to build, but lacks support!' 7259396Sandreas.hansson@arm.com Exit(1) 7269396Sandreas.hansson@arm.com 7278232Snate@binkert.org# 7288232Snate@binkert.org# Handle debug flags 7298232Snate@binkert.org# 7308232Snate@binkert.orgdef makeDebugFlagCC(target, source, env): 7318232Snate@binkert.org assert(len(target) == 1 and len(source) == 1) 7326229Snate@binkert.org 7338232Snate@binkert.org val = eval(source[0].get_contents()) 7348232Snate@binkert.org name, compound, desc = val 7358232Snate@binkert.org compound = list(sorted(compound)) 7366229Snate@binkert.org 7377673Snate@binkert.org code = code_formatter() 7385517Snate@binkert.org 7395517Snate@binkert.org # file header 7407673Snate@binkert.org code(''' 7415517Snate@binkert.org/* 7425517Snate@binkert.org * DO NOT EDIT THIS FILE! Automatically generated 7435517Snate@binkert.org */ 7445517Snate@binkert.org 7458232Snate@binkert.org#include "base/debug.hh" 7467673Snate@binkert.org''') 7477673Snate@binkert.org 7488232Snate@binkert.org for flag in compound: 7498232Snate@binkert.org code('#include "debug/$flag.hh"') 7508232Snate@binkert.org code() 7518232Snate@binkert.org code('namespace Debug {') 7527673Snate@binkert.org code() 7535517Snate@binkert.org 7548232Snate@binkert.org if not compound: 7558232Snate@binkert.org code('SimpleFlag $name("$name", "$desc");') 7568232Snate@binkert.org else: 7578232Snate@binkert.org code('CompoundFlag $name("$name", "$desc",') 7587673Snate@binkert.org code.indent() 7598232Snate@binkert.org last = len(compound) - 1 7608232Snate@binkert.org for i,flag in enumerate(compound): 7618232Snate@binkert.org if i != last: 7628232Snate@binkert.org code('$flag,') 7638232Snate@binkert.org else: 7648232Snate@binkert.org code('$flag);') 7657673Snate@binkert.org code.dedent() 7665517Snate@binkert.org 7678232Snate@binkert.org code() 7688232Snate@binkert.org code('} // namespace Debug') 7695517Snate@binkert.org 7707673Snate@binkert.org code.write(str(target[0])) 7715517Snate@binkert.org 7728232Snate@binkert.orgdef makeDebugFlagHH(target, source, env): 7738232Snate@binkert.org assert(len(target) == 1 and len(source) == 1) 7745517Snate@binkert.org 7758232Snate@binkert.org val = eval(source[0].get_contents()) 7768232Snate@binkert.org name, compound, desc = val 7778232Snate@binkert.org 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 * 7858232Snate@binkert.org * Automatically generated by SCons 7865517Snate@binkert.org */ 7875517Snate@binkert.org 7888232Snate@binkert.org#ifndef __DEBUG_${name}_HH__ 7898232Snate@binkert.org#define __DEBUG_${name}_HH__ 7905517Snate@binkert.org 7918232Snate@binkert.orgnamespace Debug { 7928232Snate@binkert.org''') 7935517Snate@binkert.org 7948232Snate@binkert.org if compound: 7958232Snate@binkert.org code('class CompoundFlag;') 7968232Snate@binkert.org code('class SimpleFlag;') 7975517Snate@binkert.org 7988232Snate@binkert.org if compound: 7998232Snate@binkert.org code('extern CompoundFlag $name;') 8008232Snate@binkert.org for flag in compound: 8018232Snate@binkert.org code('extern SimpleFlag $flag;') 8028232Snate@binkert.org else: 8038232Snate@binkert.org code('extern SimpleFlag $name;') 8045517Snate@binkert.org 8058232Snate@binkert.org code(''' 8068232Snate@binkert.org} 8075517Snate@binkert.org 8088232Snate@binkert.org#endif // __DEBUG_${name}_HH__ 8097673Snate@binkert.org''') 8105517Snate@binkert.org 8117673Snate@binkert.org code.write(str(target[0])) 8125517Snate@binkert.org 8138232Snate@binkert.orgfor name,flag in sorted(debug_flags.iteritems()): 8148232Snate@binkert.org n, compound, desc = flag 8158232Snate@binkert.org assert n == name 8165192Ssaidi@eecs.umich.edu 8178232Snate@binkert.org env.Command('debug/%s.hh' % name, Value(flag), 8188232Snate@binkert.org MakeAction(makeDebugFlagHH, Transform("TRACING", 0))) 8198232Snate@binkert.org env.Command('debug/%s.cc' % name, Value(flag), 8208232Snate@binkert.org MakeAction(makeDebugFlagCC, Transform("TRACING", 0))) 8218232Snate@binkert.org Source('debug/%s.cc' % name) 8225192Ssaidi@eecs.umich.edu 8237674Snate@binkert.org# Embed python files. All .py files that have been indicated by a 8245522Snate@binkert.org# PySource() call in a SConscript need to be embedded into the M5 8255522Snate@binkert.org# library. To do that, we compile the file to byte code, marshal the 8267674Snate@binkert.org# byte code, compress it, and then generate a c++ file that 8277674Snate@binkert.org# inserts the result into an array. 8287674Snate@binkert.orgdef embedPyFile(target, source, env): 8297674Snate@binkert.org def c_str(string): 8307674Snate@binkert.org if string is None: 8317674Snate@binkert.org return "0" 8327674Snate@binkert.org return '"%s"' % string 8337674Snate@binkert.org 8345522Snate@binkert.org '''Action function to compile a .py into a code object, marshal 8355522Snate@binkert.org it, compress it, and stick it into an asm file so the code appears 8365522Snate@binkert.org as just bytes with a label in the data section''' 8375517Snate@binkert.org 8385522Snate@binkert.org src = file(str(source[0]), 'r').read() 8395517Snate@binkert.org 8406143Snate@binkert.org pysource = PySource.tnodes[source[0]] 8416727Ssteve.reinhardt@amd.com compiled = compile(src, pysource.abspath, 'exec') 8425522Snate@binkert.org marshalled = marshal.dumps(compiled) 8435522Snate@binkert.org compressed = zlib.compress(marshalled) 8445522Snate@binkert.org data = compressed 8457674Snate@binkert.org sym = pysource.symname 8465517Snate@binkert.org 8477673Snate@binkert.org code = code_formatter() 8487673Snate@binkert.org code('''\ 8497674Snate@binkert.org#include "sim/init.hh" 8507673Snate@binkert.org 8517674Snate@binkert.orgnamespace { 8527674Snate@binkert.org 8538946Sandreas.hansson@arm.comconst uint8_t data_${sym}[] = { 8547674Snate@binkert.org''') 8557674Snate@binkert.org code.indent() 8567674Snate@binkert.org step = 16 8575522Snate@binkert.org for i in xrange(0, len(data), step): 8585522Snate@binkert.org x = array.array('B', data[i:i+step]) 8597674Snate@binkert.org code(''.join('%d,' % d for d in x)) 8607674Snate@binkert.org code.dedent() 8617674Snate@binkert.org 8627674Snate@binkert.org code('''}; 8637673Snate@binkert.org 8647674Snate@binkert.orgEmbeddedPython embedded_${sym}( 8657674Snate@binkert.org ${{c_str(pysource.arcname)}}, 8667674Snate@binkert.org ${{c_str(pysource.abspath)}}, 8677674Snate@binkert.org ${{c_str(pysource.modpath)}}, 8687674Snate@binkert.org data_${sym}, 8697674Snate@binkert.org ${{len(data)}}, 8707674Snate@binkert.org ${{len(marshalled)}}); 8717674Snate@binkert.org 8727811Ssteve.reinhardt@amd.com} // anonymous namespace 8737674Snate@binkert.org''') 8747673Snate@binkert.org code.write(str(target[0])) 8755522Snate@binkert.org 8766143Snate@binkert.orgfor source in PySource.all: 8777756SAli.Saidi@ARM.com env.Command(source.cpp, source.tnode, 8787816Ssteve.reinhardt@amd.com MakeAction(embedPyFile, Transform("EMBED PY"))) 8797674Snate@binkert.org Source(source.cpp) 8804382Sbinkertn@umich.edu 8814382Sbinkertn@umich.edu######################################################################## 8824382Sbinkertn@umich.edu# 8834382Sbinkertn@umich.edu# Define binaries. Each different build type (debug, opt, etc.) gets 8844382Sbinkertn@umich.edu# a slightly different build environment. 8854382Sbinkertn@umich.edu# 8864382Sbinkertn@umich.edu 8874382Sbinkertn@umich.edu# List of constructed environments to pass back to SConstruct 88810196SCurtis.Dunham@arm.comdate_source = Source('base/date.cc', skip_lib=True) 8894382Sbinkertn@umich.edu 89010196SCurtis.Dunham@arm.com# Capture this directory for the closure makeEnv, otherwise when it is 89110196SCurtis.Dunham@arm.com# called, it won't know what directory it should use. 89210196SCurtis.Dunham@arm.comvariant_dir = Dir('.').path 89310196SCurtis.Dunham@arm.comdef variant(*path): 89410196SCurtis.Dunham@arm.com return os.path.join(variant_dir, *path) 89510196SCurtis.Dunham@arm.comdef variantd(*path): 89610196SCurtis.Dunham@arm.com return variant(*path)+'/' 897955SN/A 8982655Sstever@eecs.umich.edu# Function to create a new build environment as clone of current 8992655Sstever@eecs.umich.edu# environment 'env' with modified object suffix and optional stripped 9002655Sstever@eecs.umich.edu# binary. Additional keyword arguments are appended to corresponding 9012655Sstever@eecs.umich.edu# build environment vars. 90210196SCurtis.Dunham@arm.comdef makeEnv(env, label, objsfx, strip = False, **kwargs): 9035601Snate@binkert.org # SCons doesn't know to append a library suffix when there is a '.' in the 9045601Snate@binkert.org # name. Use '_' instead. 90510196SCurtis.Dunham@arm.com libname = variant('gem5_' + label) 90610196SCurtis.Dunham@arm.com exename = variant('gem5.' + label) 90710196SCurtis.Dunham@arm.com secondary_exename = variant('m5.' + label) 9085522Snate@binkert.org 9095863Snate@binkert.org new_env = env.Clone(OBJSUFFIX=objsfx, SHOBJSUFFIX=objsfx + 's') 9105601Snate@binkert.org new_env.Label = label 9115601Snate@binkert.org new_env.Append(**kwargs) 9125601Snate@binkert.org 9135863Snate@binkert.org swig_env = new_env.Clone() 9149556Sandreas.hansson@arm.com 9159556Sandreas.hansson@arm.com # Both gcc and clang have issues with unused labels and values in 9169556Sandreas.hansson@arm.com # the SWIG generated code 9179556Sandreas.hansson@arm.com swig_env.Append(CCFLAGS=['-Wno-unused-label', '-Wno-unused-value']) 9189556Sandreas.hansson@arm.com 9199556Sandreas.hansson@arm.com # Add additional warnings here that should not be applied to 9209556Sandreas.hansson@arm.com # the SWIG generated code 9219556Sandreas.hansson@arm.com new_env.Append(CXXFLAGS='-Wmissing-declarations') 9229556Sandreas.hansson@arm.com 9235559Snate@binkert.org if env['GCC']: 9249556Sandreas.hansson@arm.com # Depending on the SWIG version, we also need to supress 9259618Ssteve.reinhardt@amd.com # warnings about uninitialized variables and missing field 9269618Ssteve.reinhardt@amd.com # initializers. 9279618Ssteve.reinhardt@amd.com swig_env.Append(CCFLAGS=['-Wno-uninitialized', 92810238Sandreas.hansson@arm.com '-Wno-missing-field-initializers', 92910238Sandreas.hansson@arm.com '-Wno-unused-but-set-variable']) 9309554Sandreas.hansson@arm.com 9319556Sandreas.hansson@arm.com # If gcc supports it, also warn for deletion of derived 9329556Sandreas.hansson@arm.com # classes with non-virtual desctructors. For gcc >= 4.7 we 9339556Sandreas.hansson@arm.com # also have to disable warnings about the SWIG code having 9349556Sandreas.hansson@arm.com # potentially uninitialized variables. 9359555Sandreas.hansson@arm.com if compareVersions(env['GCC_VERSION'], '4.7') >= 0: 9369555Sandreas.hansson@arm.com new_env.Append(CXXFLAGS='-Wdelete-non-virtual-dtor') 9379556Sandreas.hansson@arm.com swig_env.Append(CCFLAGS='-Wno-maybe-uninitialized') 9388737Skoansin.tan@gmail.com if env['CLANG']: 9399556Sandreas.hansson@arm.com # Always enable the warning for deletion of derived classes 9409556Sandreas.hansson@arm.com # with non-virtual destructors 9419556Sandreas.hansson@arm.com new_env.Append(CXXFLAGS=['-Wdelete-non-virtual-dtor']) 9429554Sandreas.hansson@arm.com 9438945Ssteve.reinhardt@amd.com werror_env = new_env.Clone() 9448945Ssteve.reinhardt@amd.com werror_env.Append(CCFLAGS='-Werror') 9458945Ssteve.reinhardt@amd.com 9466143Snate@binkert.org def make_obj(source, static, extra_deps = None): 9476143Snate@binkert.org '''This function adds the specified source to the correct 9486143Snate@binkert.org build environment, and returns the corresponding SCons Object 9496143Snate@binkert.org nodes''' 9506143Snate@binkert.org 9516143Snate@binkert.org if source.swig: 9526143Snate@binkert.org env = swig_env 9538945Ssteve.reinhardt@amd.com elif source.Werror: 9548945Ssteve.reinhardt@amd.com env = werror_env 9556143Snate@binkert.org else: 9566143Snate@binkert.org env = new_env 9576143Snate@binkert.org 9586143Snate@binkert.org if static: 9596143Snate@binkert.org obj = env.StaticObject(source.tnode) 9606143Snate@binkert.org else: 9616143Snate@binkert.org obj = env.SharedObject(source.tnode) 9626143Snate@binkert.org 9636143Snate@binkert.org if extra_deps: 9646143Snate@binkert.org env.Depends(obj, extra_deps) 9656143Snate@binkert.org 9666143Snate@binkert.org return obj 9676143Snate@binkert.org 9688594Snate@binkert.org static_objs = \ 9698594Snate@binkert.org [ make_obj(s, True) for s in Source.get(main=False, skip_lib=False) ] 9708594Snate@binkert.org shared_objs = \ 9718594Snate@binkert.org [ make_obj(s, False) for s in Source.get(main=False, skip_lib=False) ] 9726143Snate@binkert.org 9736143Snate@binkert.org static_date = make_obj(date_source, static=True, extra_deps=static_objs) 9746143Snate@binkert.org static_objs.append(static_date) 9756143Snate@binkert.org 9766143Snate@binkert.org shared_date = make_obj(date_source, static=False, extra_deps=shared_objs) 9776240Snate@binkert.org shared_objs.append(shared_date) 9785554Snate@binkert.org 9795522Snate@binkert.org # First make a library of everything but main() so other programs can 9805522Snate@binkert.org # link against m5. 9815797Snate@binkert.org static_lib = new_env.StaticLibrary(libname, static_objs) 9825797Snate@binkert.org shared_lib = new_env.SharedLibrary(libname, shared_objs) 9835522Snate@binkert.org 9845601Snate@binkert.org # Now link a stub with main() and the static library. 9858233Snate@binkert.org main_objs = [ make_obj(s, True) for s in Source.get(main=True) ] 9868233Snate@binkert.org 9878235Snate@binkert.org for test in UnitTest.all: 9888235Snate@binkert.org flags = { test.target : True } 9898235Snate@binkert.org test_sources = Source.get(**flags) 9908235Snate@binkert.org test_objs = [ make_obj(s, static=True) for s in test_sources ] 9919003SAli.Saidi@ARM.com if test.main: 9929003SAli.Saidi@ARM.com test_objs += main_objs 99310196SCurtis.Dunham@arm.com path = variant('unittest/%s.%s' % (test.target, label)) 99410196SCurtis.Dunham@arm.com new_env.Program(path, test_objs + static_objs) 9958235Snate@binkert.org 9966143Snate@binkert.org progname = exename 9972655Sstever@eecs.umich.edu if strip: 9986143Snate@binkert.org progname += '.unstripped' 9996143Snate@binkert.org 10008233Snate@binkert.org targets = new_env.Program(progname, main_objs + static_objs) 10016143Snate@binkert.org 10026143Snate@binkert.org if strip: 10034007Ssaidi@eecs.umich.edu if sys.platform == 'sunos5': 10044596Sbinkertn@umich.edu cmd = 'cp $SOURCE $TARGET; strip $TARGET' 10054007Ssaidi@eecs.umich.edu else: 10064596Sbinkertn@umich.edu cmd = 'strip $SOURCE -o $TARGET' 10077756SAli.Saidi@ARM.com targets = new_env.Command(exename, progname, 10087816Ssteve.reinhardt@amd.com MakeAction(cmd, Transform("STRIP"))) 10098334Snate@binkert.org 10108334Snate@binkert.org new_env.Command(secondary_exename, exename, 10118334Snate@binkert.org MakeAction('ln $SOURCE $TARGET', Transform("HARDLINK"))) 10128334Snate@binkert.org 10135601Snate@binkert.org new_env.M5Binary = targets[0] 101410196SCurtis.Dunham@arm.com return new_env 10152655Sstever@eecs.umich.edu 10169225Sandreas.hansson@arm.com# Start out with the compiler flags common to all compilers, 10179225Sandreas.hansson@arm.com# i.e. they all use -g for opt and -g -pg for prof 10189226Sandreas.hansson@arm.comccflags = {'debug' : [], 'opt' : ['-g'], 'fast' : [], 'prof' : ['-g', '-pg'], 10199226Sandreas.hansson@arm.com 'perf' : ['-g']} 10209225Sandreas.hansson@arm.com 10219226Sandreas.hansson@arm.com# Start out with the linker flags common to all linkers, i.e. -pg for 10229226Sandreas.hansson@arm.com# prof, and -lprofiler for perf. The -lprofile flag is surrounded by 10239226Sandreas.hansson@arm.com# no-as-needed and as-needed as the binutils linker is too clever and 10249226Sandreas.hansson@arm.com# simply doesn't link to the library otherwise. 10259226Sandreas.hansson@arm.comldflags = {'debug' : [], 'opt' : [], 'fast' : [], 'prof' : ['-pg'], 10269226Sandreas.hansson@arm.com 'perf' : ['-Wl,--no-as-needed', '-lprofiler', '-Wl,--as-needed']} 10279225Sandreas.hansson@arm.com 10289227Sandreas.hansson@arm.com# For Link Time Optimization, the optimisation flags used to compile 10299227Sandreas.hansson@arm.com# individual files are decoupled from those used at link time 10309227Sandreas.hansson@arm.com# (i.e. you can compile with -O3 and perform LTO with -O0), so we need 10319227Sandreas.hansson@arm.com# to also update the linker flags based on the target. 10328946Sandreas.hansson@arm.comif env['GCC']: 10333918Ssaidi@eecs.umich.edu if sys.platform == 'sunos5': 10349225Sandreas.hansson@arm.com ccflags['debug'] += ['-gstabs+'] 10353918Ssaidi@eecs.umich.edu else: 10369225Sandreas.hansson@arm.com ccflags['debug'] += ['-ggdb3'] 10379225Sandreas.hansson@arm.com ldflags['debug'] += ['-O0'] 10389227Sandreas.hansson@arm.com # opt, fast, prof and perf all share the same cc flags, also add 10399227Sandreas.hansson@arm.com # the optimization to the ldflags as LTO defers the optimization 10409227Sandreas.hansson@arm.com # to link time 10419226Sandreas.hansson@arm.com for target in ['opt', 'fast', 'prof', 'perf']: 10429225Sandreas.hansson@arm.com ccflags[target] += ['-O3'] 10439227Sandreas.hansson@arm.com ldflags[target] += ['-O3'] 10449227Sandreas.hansson@arm.com 10459227Sandreas.hansson@arm.com ccflags['fast'] += env['LTO_CCFLAGS'] 10469227Sandreas.hansson@arm.com ldflags['fast'] += env['LTO_LDFLAGS'] 10478946Sandreas.hansson@arm.comelif env['CLANG']: 10489225Sandreas.hansson@arm.com ccflags['debug'] += ['-g', '-O0'] 10499226Sandreas.hansson@arm.com # opt, fast, prof and perf all share the same cc flags 10509226Sandreas.hansson@arm.com for target in ['opt', 'fast', 'prof', 'perf']: 10519226Sandreas.hansson@arm.com ccflags[target] += ['-O3'] 10523515Ssaidi@eecs.umich.eduelse: 10533918Ssaidi@eecs.umich.edu print 'Unknown compiler, please fix compiler options' 10544762Snate@binkert.org Exit(1) 10553515Ssaidi@eecs.umich.edu 10568881Smarc.orr@gmail.com 10578881Smarc.orr@gmail.com# To speed things up, we only instantiate the build environments we 10588881Smarc.orr@gmail.com# need. We try to identify the needed environment for each target; if 10598881Smarc.orr@gmail.com# we can't, we fall back on instantiating all the environments just to 10608881Smarc.orr@gmail.com# be safe. 10619226Sandreas.hansson@arm.comtarget_types = ['debug', 'opt', 'fast', 'prof', 'perf'] 10629226Sandreas.hansson@arm.comobj2target = {'do': 'debug', 'o': 'opt', 'fo': 'fast', 'po': 'prof', 10639226Sandreas.hansson@arm.com 'gpo' : 'perf'} 10648881Smarc.orr@gmail.com 10658881Smarc.orr@gmail.comdef identifyTarget(t): 10668881Smarc.orr@gmail.com ext = t.split('.')[-1] 10678881Smarc.orr@gmail.com if ext in target_types: 10688881Smarc.orr@gmail.com return ext 10698881Smarc.orr@gmail.com if obj2target.has_key(ext): 10708881Smarc.orr@gmail.com return obj2target[ext] 10718881Smarc.orr@gmail.com match = re.search(r'/tests/([^/]+)/', t) 10728881Smarc.orr@gmail.com if match and match.group(1) in target_types: 10738881Smarc.orr@gmail.com return match.group(1) 10748881Smarc.orr@gmail.com return 'all' 10758881Smarc.orr@gmail.com 10768881Smarc.orr@gmail.comneeded_envs = [identifyTarget(target) for target in BUILD_TARGETS] 10778881Smarc.orr@gmail.comif 'all' in needed_envs: 10788881Smarc.orr@gmail.com needed_envs += target_types 10798881Smarc.orr@gmail.com 108010196SCurtis.Dunham@arm.comgem5_root = Dir('.').up().up().abspath 108110196SCurtis.Dunham@arm.comdef makeEnvirons(target, source, env): 108210196SCurtis.Dunham@arm.com # cause any later Source() calls to be fatal, as a diagnostic. 108310196SCurtis.Dunham@arm.com Source.done() 1084955SN/A 108510196SCurtis.Dunham@arm.com envList = [] 1086955SN/A 108710196SCurtis.Dunham@arm.com # Debug binary 108810196SCurtis.Dunham@arm.com if 'debug' in needed_envs: 108910196SCurtis.Dunham@arm.com envList.append( 109010196SCurtis.Dunham@arm.com makeEnv(env, 'debug', '.do', 109110196SCurtis.Dunham@arm.com CCFLAGS = Split(ccflags['debug']), 109210196SCurtis.Dunham@arm.com CPPDEFINES = ['DEBUG', 'TRACING_ON=1'], 109310196SCurtis.Dunham@arm.com LINKFLAGS = Split(ldflags['debug']))) 1094955SN/A 109510196SCurtis.Dunham@arm.com # Optimized binary 109610196SCurtis.Dunham@arm.com if 'opt' in needed_envs: 109710196SCurtis.Dunham@arm.com envList.append( 109810196SCurtis.Dunham@arm.com makeEnv(env, 'opt', '.o', 109910196SCurtis.Dunham@arm.com CCFLAGS = Split(ccflags['opt']), 110010196SCurtis.Dunham@arm.com CPPDEFINES = ['TRACING_ON=1'], 110110196SCurtis.Dunham@arm.com LINKFLAGS = Split(ldflags['opt']))) 11021869SN/A 110310196SCurtis.Dunham@arm.com # "Fast" binary 110410196SCurtis.Dunham@arm.com if 'fast' in needed_envs: 110510196SCurtis.Dunham@arm.com envList.append( 110610196SCurtis.Dunham@arm.com makeEnv(env, 'fast', '.fo', strip = True, 110710196SCurtis.Dunham@arm.com CCFLAGS = Split(ccflags['fast']), 110810196SCurtis.Dunham@arm.com CPPDEFINES = ['NDEBUG', 'TRACING_ON=0'], 110910196SCurtis.Dunham@arm.com LINKFLAGS = Split(ldflags['fast']))) 11109226Sandreas.hansson@arm.com 111110196SCurtis.Dunham@arm.com # Profiled binary using gprof 111210196SCurtis.Dunham@arm.com if 'prof' in needed_envs: 111310196SCurtis.Dunham@arm.com envList.append( 111410196SCurtis.Dunham@arm.com makeEnv(env, 'prof', '.po', 111510196SCurtis.Dunham@arm.com CCFLAGS = Split(ccflags['prof']), 111610196SCurtis.Dunham@arm.com CPPDEFINES = ['NDEBUG', 'TRACING_ON=0'], 111710196SCurtis.Dunham@arm.com LINKFLAGS = Split(ldflags['prof']))) 111810196SCurtis.Dunham@arm.com 111910196SCurtis.Dunham@arm.com # Profiled binary using google-pprof 112010196SCurtis.Dunham@arm.com if 'perf' in needed_envs: 112110196SCurtis.Dunham@arm.com envList.append( 112210196SCurtis.Dunham@arm.com makeEnv(env, 'perf', '.gpo', 112310196SCurtis.Dunham@arm.com CCFLAGS = Split(ccflags['perf']), 112410196SCurtis.Dunham@arm.com CPPDEFINES = ['NDEBUG', 'TRACING_ON=0'], 112510196SCurtis.Dunham@arm.com LINKFLAGS = Split(ldflags['perf']))) 112610196SCurtis.Dunham@arm.com 112710196SCurtis.Dunham@arm.com # Set up the regression tests for each build. 112810196SCurtis.Dunham@arm.com for e in envList: 112910196SCurtis.Dunham@arm.com SConscript(os.path.join(gem5_root, 'tests', 'SConscript'), 113010196SCurtis.Dunham@arm.com variant_dir = variantd('tests', e.Label), 113110196SCurtis.Dunham@arm.com exports = { 'env' : e }, duplicate = False) 113210196SCurtis.Dunham@arm.com 113310196SCurtis.Dunham@arm.com# The MakeEnvirons Builder defers the full dependency collection until 113410196SCurtis.Dunham@arm.com# after processing the ISA definition (due to dynamically generated 113510196SCurtis.Dunham@arm.com# source files). Add this dependency to all targets so they will wait 113610196SCurtis.Dunham@arm.com# until the environments are completely set up. Otherwise, a second 113710196SCurtis.Dunham@arm.com# process (e.g. -j2 or higher) will try to compile the requested target, 113810196SCurtis.Dunham@arm.com# not know how, and fail. 113910196SCurtis.Dunham@arm.comenv.Append(BUILDERS = {'MakeEnvirons' : 114010196SCurtis.Dunham@arm.com Builder(action=MakeAction(makeEnvirons, 114110196SCurtis.Dunham@arm.com Transform("ENVIRONS", 1)))}) 114210196SCurtis.Dunham@arm.com 114310196SCurtis.Dunham@arm.comisa_target = env['PHONY_BASE'] + '-deps' 114410196SCurtis.Dunham@arm.comenvirons = env['PHONY_BASE'] + '-environs' 114510196SCurtis.Dunham@arm.comenv.Depends('#all-deps', isa_target) 114610196SCurtis.Dunham@arm.comenv.Depends('#all-environs', environs) 114710196SCurtis.Dunham@arm.comenv.ScanISA(isa_target, File('arch/%s/generated/inc.d' % env['TARGET_ISA'])) 114810196SCurtis.Dunham@arm.comenvSetup = env.MakeEnvirons(environs, isa_target) 114910196SCurtis.Dunham@arm.com 115010196SCurtis.Dunham@arm.com# make sure no -deps targets occur before all ISAs are complete 115110196SCurtis.Dunham@arm.comenv.Depends(isa_target, '#all-isas') 115210196SCurtis.Dunham@arm.com# likewise for -environs targets and all the -deps targets 115310196SCurtis.Dunham@arm.comenv.Depends(environs, '#all-deps') 1154