1# -*- mode:python -*-
2
3# Copyright (c) 2004-2005 The Regents of The University of Michigan
4# All rights reserved.
5#
6# Redistribution and use in source and binary forms, with or without
7# modification, are permitted provided that the following conditions are
8# met: redistributions of source code must retain the above copyright
9# notice, this list of conditions and the following disclaimer;
10# redistributions in binary form must reproduce the above copyright
11# notice, this list of conditions and the following disclaimer in the
12# documentation and/or other materials provided with the distribution;
13# neither the name of the copyright holders nor the names of its
14# contributors may be used to endorse or promote products derived from
15# this software without specific prior written permission.
16#
17# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
18# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
19# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
20# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
21# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
22# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
23# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
27# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28#
29# Authors: Nathan Binkert
30
31import array
32import bisect
33import imp
34import marshal
35import os
36import re
37import sys
38import zlib
39
40from os.path import basename, dirname, exists, isdir, isfile, join as joinpath
41
42import SCons
43
44# This file defines how to build a particular configuration of gem5
45# based on variable settings in the 'env' build environment.
46
47Import('*')
48
49# Children need to see the environment
50Export('env')
51
52build_env = [(opt, env[opt]) for opt in export_vars]
53
54from m5.util import code_formatter, compareVersions
55
56########################################################################
57# Code for adding source files of various types
58#
59# When specifying a source file of some type, a set of guards can be
60# specified for that file. When get() is used to find the files, if
61# get specifies a set of filters, only files that match those filters
62# will be accepted (unspecified filters on files are assumed to be
63# false). Current filters are:
64# main -- specifies the gem5 main() function
65# skip_lib -- do not put this file into the gem5 library
66# skip_no_python -- do not put this file into a no_python library
67# as it embeds compiled Python
68# <unittest> -- unit tests use filters based on the unit test name
69#
70# A parent can now be specified for a source file and default filter
71# values will be retrieved recursively from parents (children override
72# parents).
73#
74class SourceMeta(type):
75 '''Meta class for source files that keeps track of all files of a
76 particular type and has a get function for finding all functions
77 of a certain type that match a set of guards'''
78 def __init__(cls, name, bases, dict):
79 super(SourceMeta, cls).__init__(name, bases, dict)
80 cls.all = []
81
82 def get(cls, **guards):
83 '''Find all files that match the specified guards. If a source
84 file does not specify a flag, the default is False'''
85 for src in cls.all:
86 for flag,value in guards.iteritems():
87 # if the flag is found and has a different value, skip
88 # this file
89 if src.all_guards.get(flag, False) != value:
90 break
91 else:
92 yield src
93
94class SourceFile(object):
95 '''Base object that encapsulates the notion of a source file.
96 This includes, the source node, target node, various manipulations
97 of those. A source file also specifies a set of guards which
98 describing which builds the source file applies to. A parent can
99 also be specified to get default guards from'''
100 __metaclass__ = SourceMeta
101 def __init__(self, source, parent=None, **guards):
102 self.guards = guards
103 self.parent = parent
104
105 tnode = source
106 if not isinstance(source, SCons.Node.FS.File):
107 tnode = File(source)
108
109 self.tnode = tnode
110 self.snode = tnode.srcnode()
111
112 for base in type(self).__mro__:
113 if issubclass(base, SourceFile):
114 base.all.append(self)
115
116 @property
117 def filename(self):
118 return str(self.tnode)
119
120 @property
121 def dirname(self):
122 return dirname(self.filename)
123
124 @property
125 def basename(self):
126 return basename(self.filename)
127
128 @property
129 def extname(self):
130 index = self.basename.rfind('.')
131 if index <= 0:
132 # dot files aren't extensions
133 return self.basename, None
134
135 return self.basename[:index], self.basename[index+1:]
136
137 @property
138 def all_guards(self):
139 '''find all guards for this object getting default values
140 recursively from its parents'''
141 guards = {}
142 if self.parent:
143 guards.update(self.parent.guards)
144 guards.update(self.guards)
145 return guards
146
147 def __lt__(self, other): return self.filename < other.filename
148 def __le__(self, other): return self.filename <= other.filename
149 def __gt__(self, other): return self.filename > other.filename
150 def __ge__(self, other): return self.filename >= other.filename
151 def __eq__(self, other): return self.filename == other.filename
152 def __ne__(self, other): return self.filename != other.filename
153
154 @staticmethod
155 def done():
156 def disabled(cls, name, *ignored):
157 raise RuntimeError("Additional SourceFile '%s'" % name,\
158 "declared, but targets deps are already fixed.")
159 SourceFile.__init__ = disabled
160
161
162class Source(SourceFile):
163 '''Add a c/c++ source file to the build'''
164 def __init__(self, source, Werror=True, swig=False, **guards):
165 '''specify the source file, and any guards'''
166 super(Source, self).__init__(source, **guards)
167
168 self.Werror = Werror
169 self.swig = swig
170
171class PySource(SourceFile):
172 '''Add a python source file to the named package'''
173 invalid_sym_char = re.compile('[^A-z0-9_]')
174 modules = {}
175 tnodes = {}
176 symnames = {}
177
178 def __init__(self, package, source, **guards):
179 '''specify the python package, the source file, and any guards'''
180 super(PySource, self).__init__(source, **guards)
181
182 modname,ext = self.extname
183 assert ext == 'py'
184
185 if package:
186 path = package.split('.')
187 else:
188 path = []
189
190 modpath = path[:]
191 if modname != '__init__':
192 modpath += [ modname ]
193 modpath = '.'.join(modpath)
194
195 arcpath = path + [ self.basename ]
196 abspath = self.snode.abspath
197 if not exists(abspath):
198 abspath = self.tnode.abspath
199
200 self.package = package
201 self.modname = modname
202 self.modpath = modpath
203 self.arcname = joinpath(*arcpath)
204 self.abspath = abspath
205 self.compiled = File(self.filename + 'c')
206 self.cpp = File(self.filename + '.cc')
207 self.symname = PySource.invalid_sym_char.sub('_', modpath)
208
209 PySource.modules[modpath] = self
210 PySource.tnodes[self.tnode] = self
211 PySource.symnames[self.symname] = self
212
213class SimObject(PySource):
214 '''Add a SimObject python file as a python source object and add
215 it to a list of sim object modules'''
216
217 fixed = False
218 modnames = []
219
220 def __init__(self, source, **guards):
221 '''Specify the source file and any guards (automatically in
222 the m5.objects package)'''
223 super(SimObject, self).__init__('m5.objects', source, **guards)
224 if self.fixed:
225 raise AttributeError, "Too late to call SimObject now."
226
227 bisect.insort_right(SimObject.modnames, self.modname)
228
229class SwigSource(SourceFile):
230 '''Add a swig file to build'''
231
232 def __init__(self, package, source, **guards):
233 '''Specify the python package, the source file, and any guards'''
234 super(SwigSource, self).__init__(source, skip_no_python=True, **guards)
235
236 modname,ext = self.extname
237 assert ext == 'i'
238
| 1# -*- mode:python -*-
2
3# Copyright (c) 2004-2005 The Regents of The University of Michigan
4# All rights reserved.
5#
6# Redistribution and use in source and binary forms, with or without
7# modification, are permitted provided that the following conditions are
8# met: redistributions of source code must retain the above copyright
9# notice, this list of conditions and the following disclaimer;
10# redistributions in binary form must reproduce the above copyright
11# notice, this list of conditions and the following disclaimer in the
12# documentation and/or other materials provided with the distribution;
13# neither the name of the copyright holders nor the names of its
14# contributors may be used to endorse or promote products derived from
15# this software without specific prior written permission.
16#
17# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
18# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
19# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
20# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
21# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
22# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
23# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
27# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28#
29# Authors: Nathan Binkert
30
31import array
32import bisect
33import imp
34import marshal
35import os
36import re
37import sys
38import zlib
39
40from os.path import basename, dirname, exists, isdir, isfile, join as joinpath
41
42import SCons
43
44# This file defines how to build a particular configuration of gem5
45# based on variable settings in the 'env' build environment.
46
47Import('*')
48
49# Children need to see the environment
50Export('env')
51
52build_env = [(opt, env[opt]) for opt in export_vars]
53
54from m5.util import code_formatter, compareVersions
55
56########################################################################
57# Code for adding source files of various types
58#
59# When specifying a source file of some type, a set of guards can be
60# specified for that file. When get() is used to find the files, if
61# get specifies a set of filters, only files that match those filters
62# will be accepted (unspecified filters on files are assumed to be
63# false). Current filters are:
64# main -- specifies the gem5 main() function
65# skip_lib -- do not put this file into the gem5 library
66# skip_no_python -- do not put this file into a no_python library
67# as it embeds compiled Python
68# <unittest> -- unit tests use filters based on the unit test name
69#
70# A parent can now be specified for a source file and default filter
71# values will be retrieved recursively from parents (children override
72# parents).
73#
74class SourceMeta(type):
75 '''Meta class for source files that keeps track of all files of a
76 particular type and has a get function for finding all functions
77 of a certain type that match a set of guards'''
78 def __init__(cls, name, bases, dict):
79 super(SourceMeta, cls).__init__(name, bases, dict)
80 cls.all = []
81
82 def get(cls, **guards):
83 '''Find all files that match the specified guards. If a source
84 file does not specify a flag, the default is False'''
85 for src in cls.all:
86 for flag,value in guards.iteritems():
87 # if the flag is found and has a different value, skip
88 # this file
89 if src.all_guards.get(flag, False) != value:
90 break
91 else:
92 yield src
93
94class SourceFile(object):
95 '''Base object that encapsulates the notion of a source file.
96 This includes, the source node, target node, various manipulations
97 of those. A source file also specifies a set of guards which
98 describing which builds the source file applies to. A parent can
99 also be specified to get default guards from'''
100 __metaclass__ = SourceMeta
101 def __init__(self, source, parent=None, **guards):
102 self.guards = guards
103 self.parent = parent
104
105 tnode = source
106 if not isinstance(source, SCons.Node.FS.File):
107 tnode = File(source)
108
109 self.tnode = tnode
110 self.snode = tnode.srcnode()
111
112 for base in type(self).__mro__:
113 if issubclass(base, SourceFile):
114 base.all.append(self)
115
116 @property
117 def filename(self):
118 return str(self.tnode)
119
120 @property
121 def dirname(self):
122 return dirname(self.filename)
123
124 @property
125 def basename(self):
126 return basename(self.filename)
127
128 @property
129 def extname(self):
130 index = self.basename.rfind('.')
131 if index <= 0:
132 # dot files aren't extensions
133 return self.basename, None
134
135 return self.basename[:index], self.basename[index+1:]
136
137 @property
138 def all_guards(self):
139 '''find all guards for this object getting default values
140 recursively from its parents'''
141 guards = {}
142 if self.parent:
143 guards.update(self.parent.guards)
144 guards.update(self.guards)
145 return guards
146
147 def __lt__(self, other): return self.filename < other.filename
148 def __le__(self, other): return self.filename <= other.filename
149 def __gt__(self, other): return self.filename > other.filename
150 def __ge__(self, other): return self.filename >= other.filename
151 def __eq__(self, other): return self.filename == other.filename
152 def __ne__(self, other): return self.filename != other.filename
153
154 @staticmethod
155 def done():
156 def disabled(cls, name, *ignored):
157 raise RuntimeError("Additional SourceFile '%s'" % name,\
158 "declared, but targets deps are already fixed.")
159 SourceFile.__init__ = disabled
160
161
162class Source(SourceFile):
163 '''Add a c/c++ source file to the build'''
164 def __init__(self, source, Werror=True, swig=False, **guards):
165 '''specify the source file, and any guards'''
166 super(Source, self).__init__(source, **guards)
167
168 self.Werror = Werror
169 self.swig = swig
170
171class PySource(SourceFile):
172 '''Add a python source file to the named package'''
173 invalid_sym_char = re.compile('[^A-z0-9_]')
174 modules = {}
175 tnodes = {}
176 symnames = {}
177
178 def __init__(self, package, source, **guards):
179 '''specify the python package, the source file, and any guards'''
180 super(PySource, self).__init__(source, **guards)
181
182 modname,ext = self.extname
183 assert ext == 'py'
184
185 if package:
186 path = package.split('.')
187 else:
188 path = []
189
190 modpath = path[:]
191 if modname != '__init__':
192 modpath += [ modname ]
193 modpath = '.'.join(modpath)
194
195 arcpath = path + [ self.basename ]
196 abspath = self.snode.abspath
197 if not exists(abspath):
198 abspath = self.tnode.abspath
199
200 self.package = package
201 self.modname = modname
202 self.modpath = modpath
203 self.arcname = joinpath(*arcpath)
204 self.abspath = abspath
205 self.compiled = File(self.filename + 'c')
206 self.cpp = File(self.filename + '.cc')
207 self.symname = PySource.invalid_sym_char.sub('_', modpath)
208
209 PySource.modules[modpath] = self
210 PySource.tnodes[self.tnode] = self
211 PySource.symnames[self.symname] = self
212
213class SimObject(PySource):
214 '''Add a SimObject python file as a python source object and add
215 it to a list of sim object modules'''
216
217 fixed = False
218 modnames = []
219
220 def __init__(self, source, **guards):
221 '''Specify the source file and any guards (automatically in
222 the m5.objects package)'''
223 super(SimObject, self).__init__('m5.objects', source, **guards)
224 if self.fixed:
225 raise AttributeError, "Too late to call SimObject now."
226
227 bisect.insort_right(SimObject.modnames, self.modname)
228
229class SwigSource(SourceFile):
230 '''Add a swig file to build'''
231
232 def __init__(self, package, source, **guards):
233 '''Specify the python package, the source file, and any guards'''
234 super(SwigSource, self).__init__(source, skip_no_python=True, **guards)
235
236 modname,ext = self.extname
237 assert ext == 'i'
238
|
| 239 self.package = package
|
239 self.module = modname
240 cc_file = joinpath(self.dirname, modname + '_wrap.cc')
241 py_file = joinpath(self.dirname, modname + '.py')
242
243 self.cc_source = Source(cc_file, swig=True, parent=self, **guards)
244 self.py_source = PySource(package, py_file, parent=self, **guards)
245
246class ProtoBuf(SourceFile):
247 '''Add a Protocol Buffer to build'''
248
249 def __init__(self, source, **guards):
250 '''Specify the source file, and any guards'''
251 super(ProtoBuf, self).__init__(source, **guards)
252
253 # Get the file name and the extension
254 modname,ext = self.extname
255 assert ext == 'proto'
256
257 # Currently, we stick to generating the C++ headers, so we
258 # only need to track the source and header.
259 self.cc_file = File(modname + '.pb.cc')
260 self.hh_file = File(modname + '.pb.h')
261
262class UnitTest(object):
263 '''Create a UnitTest'''
264
265 all = []
266 def __init__(self, target, *sources, **kwargs):
267 '''Specify the target name and any sources. Sources that are
268 not SourceFiles are evalued with Source(). All files are
269 guarded with a guard of the same name as the UnitTest
270 target.'''
271
272 srcs = []
273 for src in sources:
274 if not isinstance(src, SourceFile):
275 src = Source(src, skip_lib=True)
276 src.guards[target] = True
277 srcs.append(src)
278
279 self.sources = srcs
280 self.target = target
281 self.main = kwargs.get('main', False)
282 UnitTest.all.append(self)
283
284# Children should have access
285Export('Source')
286Export('PySource')
287Export('SimObject')
288Export('SwigSource')
289Export('ProtoBuf')
290Export('UnitTest')
291
292########################################################################
293#
294# Debug Flags
295#
296debug_flags = {}
297def DebugFlag(name, desc=None):
298 if name in debug_flags:
299 raise AttributeError, "Flag %s already specified" % name
300 debug_flags[name] = (name, (), desc)
301
302def CompoundFlag(name, flags, desc=None):
303 if name in debug_flags:
304 raise AttributeError, "Flag %s already specified" % name
305
306 compound = tuple(flags)
307 debug_flags[name] = (name, compound, desc)
308
309Export('DebugFlag')
310Export('CompoundFlag')
311
312########################################################################
313#
314# Set some compiler variables
315#
316
317# Include file paths are rooted in this directory. SCons will
318# automatically expand '.' to refer to both the source directory and
319# the corresponding build directory to pick up generated include
320# files.
321env.Append(CPPPATH=Dir('.'))
322
323for extra_dir in extras_dir_list:
324 env.Append(CPPPATH=Dir(extra_dir))
325
326# Workaround for bug in SCons version > 0.97d20071212
327# Scons bug id: 2006 gem5 Bug id: 308
328for root, dirs, files in os.walk(base_dir, topdown=True):
329 Dir(root[len(base_dir) + 1:])
330
331########################################################################
332#
333# Walk the tree and execute all SConscripts in subdirectories
334#
335
336here = Dir('.').srcnode().abspath
337for root, dirs, files in os.walk(base_dir, topdown=True):
338 if root == here:
339 # we don't want to recurse back into this SConscript
340 continue
341
342 if 'SConscript' in files:
343 build_dir = joinpath(env['BUILDDIR'], root[len(base_dir) + 1:])
344 SConscript(joinpath(root, 'SConscript'), variant_dir=build_dir)
345
346for extra_dir in extras_dir_list:
347 prefix_len = len(dirname(extra_dir)) + 1
348
349 # Also add the corresponding build directory to pick up generated
350 # include files.
351 env.Append(CPPPATH=Dir(joinpath(env['BUILDDIR'], extra_dir[prefix_len:])))
352
353 for root, dirs, files in os.walk(extra_dir, topdown=True):
354 # if build lives in the extras directory, don't walk down it
355 if 'build' in dirs:
356 dirs.remove('build')
357
358 if 'SConscript' in files:
359 build_dir = joinpath(env['BUILDDIR'], root[prefix_len:])
360 SConscript(joinpath(root, 'SConscript'), variant_dir=build_dir)
361
362for opt in export_vars:
363 env.ConfigFile(opt)
364
365def makeTheISA(source, target, env):
366 isas = [ src.get_contents() for src in source ]
367 target_isa = env['TARGET_ISA']
368 def define(isa):
369 return isa.upper() + '_ISA'
370
371 def namespace(isa):
372 return isa[0].upper() + isa[1:].lower() + 'ISA'
373
374
375 code = code_formatter()
376 code('''\
377#ifndef __CONFIG_THE_ISA_HH__
378#define __CONFIG_THE_ISA_HH__
379
380''')
381
382 # create defines for the preprocessing and compile-time determination
383 for i,isa in enumerate(isas):
384 code('#define $0 $1', define(isa), i + 1)
385 code()
386
387 # create an enum for any run-time determination of the ISA, we
388 # reuse the same name as the namespaces
389 code('enum class Arch {')
390 for i,isa in enumerate(isas):
391 if i + 1 == len(isas):
392 code(' $0 = $1', namespace(isa), define(isa))
393 else:
394 code(' $0 = $1,', namespace(isa), define(isa))
395 code('};')
396
397 code('''
398
399#define THE_ISA ${{define(target_isa)}}
400#define TheISA ${{namespace(target_isa)}}
401#define THE_ISA_STR "${{target_isa}}"
402
403#endif // __CONFIG_THE_ISA_HH__''')
404
405 code.write(str(target[0]))
406
407env.Command('config/the_isa.hh', map(Value, all_isa_list),
408 MakeAction(makeTheISA, Transform("CFG ISA", 0)))
409
410def makeTheGPUISA(source, target, env):
411 isas = [ src.get_contents() for src in source ]
412 target_gpu_isa = env['TARGET_GPU_ISA']
413 def define(isa):
414 return isa.upper() + '_ISA'
415
416 def namespace(isa):
417 return isa[0].upper() + isa[1:].lower() + 'ISA'
418
419
420 code = code_formatter()
421 code('''\
422#ifndef __CONFIG_THE_GPU_ISA_HH__
423#define __CONFIG_THE_GPU_ISA_HH__
424
425''')
426
427 # create defines for the preprocessing and compile-time determination
428 for i,isa in enumerate(isas):
429 code('#define $0 $1', define(isa), i + 1)
430 code()
431
432 # create an enum for any run-time determination of the ISA, we
433 # reuse the same name as the namespaces
434 code('enum class GPUArch {')
435 for i,isa in enumerate(isas):
436 if i + 1 == len(isas):
437 code(' $0 = $1', namespace(isa), define(isa))
438 else:
439 code(' $0 = $1,', namespace(isa), define(isa))
440 code('};')
441
442 code('''
443
444#define THE_GPU_ISA ${{define(target_gpu_isa)}}
445#define TheGpuISA ${{namespace(target_gpu_isa)}}
446#define THE_GPU_ISA_STR "${{target_gpu_isa}}"
447
448#endif // __CONFIG_THE_GPU_ISA_HH__''')
449
450 code.write(str(target[0]))
451
452env.Command('config/the_gpu_isa.hh', map(Value, all_gpu_isa_list),
453 MakeAction(makeTheGPUISA, Transform("CFG ISA", 0)))
454
455########################################################################
456#
457# Prevent any SimObjects from being added after this point, they
458# should all have been added in the SConscripts above
459#
460SimObject.fixed = True
461
462class DictImporter(object):
463 '''This importer takes a dictionary of arbitrary module names that
464 map to arbitrary filenames.'''
465 def __init__(self, modules):
466 self.modules = modules
467 self.installed = set()
468
469 def __del__(self):
470 self.unload()
471
472 def unload(self):
473 import sys
474 for module in self.installed:
475 del sys.modules[module]
476 self.installed = set()
477
478 def find_module(self, fullname, path):
479 if fullname == 'm5.defines':
480 return self
481
482 if fullname == 'm5.objects':
483 return self
484
485 if fullname.startswith('m5.internal'):
486 return None
487
488 source = self.modules.get(fullname, None)
489 if source is not None and fullname.startswith('m5.objects'):
490 return self
491
492 return None
493
494 def load_module(self, fullname):
495 mod = imp.new_module(fullname)
496 sys.modules[fullname] = mod
497 self.installed.add(fullname)
498
499 mod.__loader__ = self
500 if fullname == 'm5.objects':
501 mod.__path__ = fullname.split('.')
502 return mod
503
504 if fullname == 'm5.defines':
505 mod.__dict__['buildEnv'] = m5.util.SmartDict(build_env)
506 return mod
507
508 source = self.modules[fullname]
509 if source.modname == '__init__':
510 mod.__path__ = source.modpath
511 mod.__file__ = source.abspath
512
513 exec file(source.abspath, 'r') in mod.__dict__
514
515 return mod
516
517import m5.SimObject
518import m5.params
519from m5.util import code_formatter
520
521m5.SimObject.clear()
522m5.params.clear()
523
524# install the python importer so we can grab stuff from the source
525# tree itself. We can't have SimObjects added after this point or
526# else we won't know about them for the rest of the stuff.
527importer = DictImporter(PySource.modules)
528sys.meta_path[0:0] = [ importer ]
529
530# import all sim objects so we can populate the all_objects list
531# make sure that we're working with a list, then let's sort it
532for modname in SimObject.modnames:
533 exec('from m5.objects import %s' % modname)
534
535# we need to unload all of the currently imported modules so that they
536# will be re-imported the next time the sconscript is run
537importer.unload()
538sys.meta_path.remove(importer)
539
540sim_objects = m5.SimObject.allClasses
541all_enums = m5.params.allEnums
542
543if m5.SimObject.noCxxHeader:
544 print >> sys.stderr, \
545 "warning: At least one SimObject lacks a header specification. " \
546 "This can cause unexpected results in the generated SWIG " \
547 "wrappers."
548
549# Find param types that need to be explicitly wrapped with swig.
550# These will be recognized because the ParamDesc will have a
551# swig_decl() method. Most param types are based on types that don't
552# need this, either because they're based on native types (like Int)
553# or because they're SimObjects (which get swigged independently).
554# For now the only things handled here are VectorParam types.
555params_to_swig = {}
556for name,obj in sorted(sim_objects.iteritems()):
557 for param in obj._params.local.values():
558 # load the ptype attribute now because it depends on the
559 # current version of SimObject.allClasses, but when scons
560 # actually uses the value, all versions of
561 # SimObject.allClasses will have been loaded
562 param.ptype
563
564 if not hasattr(param, 'swig_decl'):
565 continue
566 pname = param.ptype_str
567 if pname not in params_to_swig:
568 params_to_swig[pname] = param
569
570########################################################################
571#
572# calculate extra dependencies
573#
574module_depends = ["m5", "m5.SimObject", "m5.params"]
575depends = [ PySource.modules[dep].snode for dep in module_depends ]
576depends.sort(key = lambda x: x.name)
577
578########################################################################
579#
580# Commands for the basic automatically generated python files
581#
582
583# Generate Python file containing a dict specifying the current
584# buildEnv flags.
585def makeDefinesPyFile(target, source, env):
586 build_env = source[0].get_contents()
587
588 code = code_formatter()
589 code("""
590import m5.internal
591import m5.util
592
593buildEnv = m5.util.SmartDict($build_env)
594
595compileDate = m5.internal.core.compileDate
596_globals = globals()
597for key,val in m5.internal.core.__dict__.iteritems():
598 if key.startswith('flag_'):
599 flag = key[5:]
600 _globals[flag] = val
601del _globals
602""")
603 code.write(target[0].abspath)
604
605defines_info = Value(build_env)
606# Generate a file with all of the compile options in it
607env.Command('python/m5/defines.py', defines_info,
608 MakeAction(makeDefinesPyFile, Transform("DEFINES", 0)))
609PySource('m5', 'python/m5/defines.py')
610
611# Generate python file containing info about the M5 source code
612def makeInfoPyFile(target, source, env):
613 code = code_formatter()
614 for src in source:
615 data = ''.join(file(src.srcnode().abspath, 'r').xreadlines())
616 code('$src = ${{repr(data)}}')
617 code.write(str(target[0]))
618
619# Generate a file that wraps the basic top level files
620env.Command('python/m5/info.py',
621 [ '#/COPYING', '#/LICENSE', '#/README', ],
622 MakeAction(makeInfoPyFile, Transform("INFO")))
623PySource('m5', 'python/m5/info.py')
624
625########################################################################
626#
627# Create all of the SimObject param headers and enum headers
628#
629
630def createSimObjectParamStruct(target, source, env):
631 assert len(target) == 1 and len(source) == 1
632
633 name = str(source[0].get_contents())
634 obj = sim_objects[name]
635
636 code = code_formatter()
637 obj.cxx_param_decl(code)
638 code.write(target[0].abspath)
639
640def createSimObjectCxxConfig(is_header):
641 def body(target, source, env):
642 assert len(target) == 1 and len(source) == 1
643
644 name = str(source[0].get_contents())
645 obj = sim_objects[name]
646
647 code = code_formatter()
648 obj.cxx_config_param_file(code, is_header)
649 code.write(target[0].abspath)
650 return body
651
652def createParamSwigWrapper(target, source, env):
653 assert len(target) == 1 and len(source) == 1
654
655 name = str(source[0].get_contents())
656 param = params_to_swig[name]
657
658 code = code_formatter()
659 param.swig_decl(code)
660 code.write(target[0].abspath)
661
662def createEnumStrings(target, source, env):
663 assert len(target) == 1 and len(source) == 1
664
665 name = str(source[0].get_contents())
666 obj = all_enums[name]
667
668 code = code_formatter()
669 obj.cxx_def(code)
670 code.write(target[0].abspath)
671
672def createEnumDecls(target, source, env):
673 assert len(target) == 1 and len(source) == 1
674
675 name = str(source[0].get_contents())
676 obj = all_enums[name]
677
678 code = code_formatter()
679 obj.cxx_decl(code)
680 code.write(target[0].abspath)
681
682def createEnumSwigWrapper(target, source, env):
683 assert len(target) == 1 and len(source) == 1
684
685 name = str(source[0].get_contents())
686 obj = all_enums[name]
687
688 code = code_formatter()
689 obj.swig_decl(code)
690 code.write(target[0].abspath)
691
692def createSimObjectSwigWrapper(target, source, env):
693 name = source[0].get_contents()
694 obj = sim_objects[name]
695
696 code = code_formatter()
697 obj.swig_decl(code)
698 code.write(target[0].abspath)
699
700# dummy target for generated code
701# we start out with all the Source files so they get copied to build/*/ also.
702SWIG = env.Dummy('swig', [s.tnode for s in Source.get()])
703
704# Generate all of the SimObject param C++ struct header files
705params_hh_files = []
706for name,simobj in sorted(sim_objects.iteritems()):
707 py_source = PySource.modules[simobj.__module__]
708 extra_deps = [ py_source.tnode ]
709
710 hh_file = File('params/%s.hh' % name)
711 params_hh_files.append(hh_file)
712 env.Command(hh_file, Value(name),
713 MakeAction(createSimObjectParamStruct, Transform("SO PARAM")))
714 env.Depends(hh_file, depends + extra_deps)
715 env.Depends(SWIG, hh_file)
716
717# C++ parameter description files
718if GetOption('with_cxx_config'):
719 for name,simobj in sorted(sim_objects.iteritems()):
720 py_source = PySource.modules[simobj.__module__]
721 extra_deps = [ py_source.tnode ]
722
723 cxx_config_hh_file = File('cxx_config/%s.hh' % name)
724 cxx_config_cc_file = File('cxx_config/%s.cc' % name)
725 env.Command(cxx_config_hh_file, Value(name),
726 MakeAction(createSimObjectCxxConfig(True),
727 Transform("CXXCPRHH")))
728 env.Command(cxx_config_cc_file, Value(name),
729 MakeAction(createSimObjectCxxConfig(False),
730 Transform("CXXCPRCC")))
731 env.Depends(cxx_config_hh_file, depends + extra_deps +
732 [File('params/%s.hh' % name), File('sim/cxx_config.hh')])
733 env.Depends(cxx_config_cc_file, depends + extra_deps +
734 [cxx_config_hh_file])
735 Source(cxx_config_cc_file)
736
737 cxx_config_init_cc_file = File('cxx_config/init.cc')
738
739 def createCxxConfigInitCC(target, source, env):
740 assert len(target) == 1 and len(source) == 1
741
742 code = code_formatter()
743
744 for name,simobj in sorted(sim_objects.iteritems()):
745 if not hasattr(simobj, 'abstract') or not simobj.abstract:
746 code('#include "cxx_config/${name}.hh"')
747 code()
748 code('void cxxConfigInit()')
749 code('{')
750 code.indent()
751 for name,simobj in sorted(sim_objects.iteritems()):
752 not_abstract = not hasattr(simobj, 'abstract') or \
753 not simobj.abstract
754 if not_abstract and 'type' in simobj.__dict__:
755 code('cxx_config_directory["${name}"] = '
756 '${name}CxxConfigParams::makeDirectoryEntry();')
757 code.dedent()
758 code('}')
759 code.write(target[0].abspath)
760
761 py_source = PySource.modules[simobj.__module__]
762 extra_deps = [ py_source.tnode ]
763 env.Command(cxx_config_init_cc_file, Value(name),
764 MakeAction(createCxxConfigInitCC, Transform("CXXCINIT")))
765 cxx_param_hh_files = ["cxx_config/%s.hh" % simobj
766 for name,simobj in sorted(sim_objects.iteritems())
767 if not hasattr(simobj, 'abstract') or not simobj.abstract]
768 Depends(cxx_config_init_cc_file, cxx_param_hh_files +
769 [File('sim/cxx_config.hh')])
770 Source(cxx_config_init_cc_file)
771
772# Generate any needed param SWIG wrapper files
773params_i_files = []
774for name,param in sorted(params_to_swig.iteritems()):
775 i_file = File('python/m5/internal/%s.i' % (param.swig_module_name()))
776 params_i_files.append(i_file)
777 env.Command(i_file, Value(name),
778 MakeAction(createParamSwigWrapper, Transform("SW PARAM")))
779 env.Depends(i_file, depends)
780 env.Depends(SWIG, i_file)
781 SwigSource('m5.internal', i_file)
782
783# Generate all enum header files
784for name,enum in sorted(all_enums.iteritems()):
785 py_source = PySource.modules[enum.__module__]
786 extra_deps = [ py_source.tnode ]
787
788 cc_file = File('enums/%s.cc' % name)
789 env.Command(cc_file, Value(name),
790 MakeAction(createEnumStrings, Transform("ENUM STR")))
791 env.Depends(cc_file, depends + extra_deps)
792 env.Depends(SWIG, cc_file)
793 Source(cc_file)
794
795 hh_file = File('enums/%s.hh' % name)
796 env.Command(hh_file, Value(name),
797 MakeAction(createEnumDecls, Transform("ENUMDECL")))
798 env.Depends(hh_file, depends + extra_deps)
799 env.Depends(SWIG, hh_file)
800
801 i_file = File('python/m5/internal/enum_%s.i' % name)
802 env.Command(i_file, Value(name),
803 MakeAction(createEnumSwigWrapper, Transform("ENUMSWIG")))
804 env.Depends(i_file, depends + extra_deps)
805 env.Depends(SWIG, i_file)
806 SwigSource('m5.internal', i_file)
807
808# Generate SimObject SWIG wrapper files
809for name,simobj in sorted(sim_objects.iteritems()):
810 py_source = PySource.modules[simobj.__module__]
811 extra_deps = [ py_source.tnode ]
812 i_file = File('python/m5/internal/param_%s.i' % name)
813 env.Command(i_file, Value(name),
814 MakeAction(createSimObjectSwigWrapper, Transform("SO SWIG")))
815 env.Depends(i_file, depends + extra_deps)
816 SwigSource('m5.internal', i_file)
817
818# Generate the main swig init file
| 240 self.module = modname
241 cc_file = joinpath(self.dirname, modname + '_wrap.cc')
242 py_file = joinpath(self.dirname, modname + '.py')
243
244 self.cc_source = Source(cc_file, swig=True, parent=self, **guards)
245 self.py_source = PySource(package, py_file, parent=self, **guards)
246
247class ProtoBuf(SourceFile):
248 '''Add a Protocol Buffer to build'''
249
250 def __init__(self, source, **guards):
251 '''Specify the source file, and any guards'''
252 super(ProtoBuf, self).__init__(source, **guards)
253
254 # Get the file name and the extension
255 modname,ext = self.extname
256 assert ext == 'proto'
257
258 # Currently, we stick to generating the C++ headers, so we
259 # only need to track the source and header.
260 self.cc_file = File(modname + '.pb.cc')
261 self.hh_file = File(modname + '.pb.h')
262
263class UnitTest(object):
264 '''Create a UnitTest'''
265
266 all = []
267 def __init__(self, target, *sources, **kwargs):
268 '''Specify the target name and any sources. Sources that are
269 not SourceFiles are evalued with Source(). All files are
270 guarded with a guard of the same name as the UnitTest
271 target.'''
272
273 srcs = []
274 for src in sources:
275 if not isinstance(src, SourceFile):
276 src = Source(src, skip_lib=True)
277 src.guards[target] = True
278 srcs.append(src)
279
280 self.sources = srcs
281 self.target = target
282 self.main = kwargs.get('main', False)
283 UnitTest.all.append(self)
284
285# Children should have access
286Export('Source')
287Export('PySource')
288Export('SimObject')
289Export('SwigSource')
290Export('ProtoBuf')
291Export('UnitTest')
292
293########################################################################
294#
295# Debug Flags
296#
297debug_flags = {}
298def DebugFlag(name, desc=None):
299 if name in debug_flags:
300 raise AttributeError, "Flag %s already specified" % name
301 debug_flags[name] = (name, (), desc)
302
303def CompoundFlag(name, flags, desc=None):
304 if name in debug_flags:
305 raise AttributeError, "Flag %s already specified" % name
306
307 compound = tuple(flags)
308 debug_flags[name] = (name, compound, desc)
309
310Export('DebugFlag')
311Export('CompoundFlag')
312
313########################################################################
314#
315# Set some compiler variables
316#
317
318# Include file paths are rooted in this directory. SCons will
319# automatically expand '.' to refer to both the source directory and
320# the corresponding build directory to pick up generated include
321# files.
322env.Append(CPPPATH=Dir('.'))
323
324for extra_dir in extras_dir_list:
325 env.Append(CPPPATH=Dir(extra_dir))
326
327# Workaround for bug in SCons version > 0.97d20071212
328# Scons bug id: 2006 gem5 Bug id: 308
329for root, dirs, files in os.walk(base_dir, topdown=True):
330 Dir(root[len(base_dir) + 1:])
331
332########################################################################
333#
334# Walk the tree and execute all SConscripts in subdirectories
335#
336
337here = Dir('.').srcnode().abspath
338for root, dirs, files in os.walk(base_dir, topdown=True):
339 if root == here:
340 # we don't want to recurse back into this SConscript
341 continue
342
343 if 'SConscript' in files:
344 build_dir = joinpath(env['BUILDDIR'], root[len(base_dir) + 1:])
345 SConscript(joinpath(root, 'SConscript'), variant_dir=build_dir)
346
347for extra_dir in extras_dir_list:
348 prefix_len = len(dirname(extra_dir)) + 1
349
350 # Also add the corresponding build directory to pick up generated
351 # include files.
352 env.Append(CPPPATH=Dir(joinpath(env['BUILDDIR'], extra_dir[prefix_len:])))
353
354 for root, dirs, files in os.walk(extra_dir, topdown=True):
355 # if build lives in the extras directory, don't walk down it
356 if 'build' in dirs:
357 dirs.remove('build')
358
359 if 'SConscript' in files:
360 build_dir = joinpath(env['BUILDDIR'], root[prefix_len:])
361 SConscript(joinpath(root, 'SConscript'), variant_dir=build_dir)
362
363for opt in export_vars:
364 env.ConfigFile(opt)
365
366def makeTheISA(source, target, env):
367 isas = [ src.get_contents() for src in source ]
368 target_isa = env['TARGET_ISA']
369 def define(isa):
370 return isa.upper() + '_ISA'
371
372 def namespace(isa):
373 return isa[0].upper() + isa[1:].lower() + 'ISA'
374
375
376 code = code_formatter()
377 code('''\
378#ifndef __CONFIG_THE_ISA_HH__
379#define __CONFIG_THE_ISA_HH__
380
381''')
382
383 # create defines for the preprocessing and compile-time determination
384 for i,isa in enumerate(isas):
385 code('#define $0 $1', define(isa), i + 1)
386 code()
387
388 # create an enum for any run-time determination of the ISA, we
389 # reuse the same name as the namespaces
390 code('enum class Arch {')
391 for i,isa in enumerate(isas):
392 if i + 1 == len(isas):
393 code(' $0 = $1', namespace(isa), define(isa))
394 else:
395 code(' $0 = $1,', namespace(isa), define(isa))
396 code('};')
397
398 code('''
399
400#define THE_ISA ${{define(target_isa)}}
401#define TheISA ${{namespace(target_isa)}}
402#define THE_ISA_STR "${{target_isa}}"
403
404#endif // __CONFIG_THE_ISA_HH__''')
405
406 code.write(str(target[0]))
407
408env.Command('config/the_isa.hh', map(Value, all_isa_list),
409 MakeAction(makeTheISA, Transform("CFG ISA", 0)))
410
411def makeTheGPUISA(source, target, env):
412 isas = [ src.get_contents() for src in source ]
413 target_gpu_isa = env['TARGET_GPU_ISA']
414 def define(isa):
415 return isa.upper() + '_ISA'
416
417 def namespace(isa):
418 return isa[0].upper() + isa[1:].lower() + 'ISA'
419
420
421 code = code_formatter()
422 code('''\
423#ifndef __CONFIG_THE_GPU_ISA_HH__
424#define __CONFIG_THE_GPU_ISA_HH__
425
426''')
427
428 # create defines for the preprocessing and compile-time determination
429 for i,isa in enumerate(isas):
430 code('#define $0 $1', define(isa), i + 1)
431 code()
432
433 # create an enum for any run-time determination of the ISA, we
434 # reuse the same name as the namespaces
435 code('enum class GPUArch {')
436 for i,isa in enumerate(isas):
437 if i + 1 == len(isas):
438 code(' $0 = $1', namespace(isa), define(isa))
439 else:
440 code(' $0 = $1,', namespace(isa), define(isa))
441 code('};')
442
443 code('''
444
445#define THE_GPU_ISA ${{define(target_gpu_isa)}}
446#define TheGpuISA ${{namespace(target_gpu_isa)}}
447#define THE_GPU_ISA_STR "${{target_gpu_isa}}"
448
449#endif // __CONFIG_THE_GPU_ISA_HH__''')
450
451 code.write(str(target[0]))
452
453env.Command('config/the_gpu_isa.hh', map(Value, all_gpu_isa_list),
454 MakeAction(makeTheGPUISA, Transform("CFG ISA", 0)))
455
456########################################################################
457#
458# Prevent any SimObjects from being added after this point, they
459# should all have been added in the SConscripts above
460#
461SimObject.fixed = True
462
463class DictImporter(object):
464 '''This importer takes a dictionary of arbitrary module names that
465 map to arbitrary filenames.'''
466 def __init__(self, modules):
467 self.modules = modules
468 self.installed = set()
469
470 def __del__(self):
471 self.unload()
472
473 def unload(self):
474 import sys
475 for module in self.installed:
476 del sys.modules[module]
477 self.installed = set()
478
479 def find_module(self, fullname, path):
480 if fullname == 'm5.defines':
481 return self
482
483 if fullname == 'm5.objects':
484 return self
485
486 if fullname.startswith('m5.internal'):
487 return None
488
489 source = self.modules.get(fullname, None)
490 if source is not None and fullname.startswith('m5.objects'):
491 return self
492
493 return None
494
495 def load_module(self, fullname):
496 mod = imp.new_module(fullname)
497 sys.modules[fullname] = mod
498 self.installed.add(fullname)
499
500 mod.__loader__ = self
501 if fullname == 'm5.objects':
502 mod.__path__ = fullname.split('.')
503 return mod
504
505 if fullname == 'm5.defines':
506 mod.__dict__['buildEnv'] = m5.util.SmartDict(build_env)
507 return mod
508
509 source = self.modules[fullname]
510 if source.modname == '__init__':
511 mod.__path__ = source.modpath
512 mod.__file__ = source.abspath
513
514 exec file(source.abspath, 'r') in mod.__dict__
515
516 return mod
517
518import m5.SimObject
519import m5.params
520from m5.util import code_formatter
521
522m5.SimObject.clear()
523m5.params.clear()
524
525# install the python importer so we can grab stuff from the source
526# tree itself. We can't have SimObjects added after this point or
527# else we won't know about them for the rest of the stuff.
528importer = DictImporter(PySource.modules)
529sys.meta_path[0:0] = [ importer ]
530
531# import all sim objects so we can populate the all_objects list
532# make sure that we're working with a list, then let's sort it
533for modname in SimObject.modnames:
534 exec('from m5.objects import %s' % modname)
535
536# we need to unload all of the currently imported modules so that they
537# will be re-imported the next time the sconscript is run
538importer.unload()
539sys.meta_path.remove(importer)
540
541sim_objects = m5.SimObject.allClasses
542all_enums = m5.params.allEnums
543
544if m5.SimObject.noCxxHeader:
545 print >> sys.stderr, \
546 "warning: At least one SimObject lacks a header specification. " \
547 "This can cause unexpected results in the generated SWIG " \
548 "wrappers."
549
550# Find param types that need to be explicitly wrapped with swig.
551# These will be recognized because the ParamDesc will have a
552# swig_decl() method. Most param types are based on types that don't
553# need this, either because they're based on native types (like Int)
554# or because they're SimObjects (which get swigged independently).
555# For now the only things handled here are VectorParam types.
556params_to_swig = {}
557for name,obj in sorted(sim_objects.iteritems()):
558 for param in obj._params.local.values():
559 # load the ptype attribute now because it depends on the
560 # current version of SimObject.allClasses, but when scons
561 # actually uses the value, all versions of
562 # SimObject.allClasses will have been loaded
563 param.ptype
564
565 if not hasattr(param, 'swig_decl'):
566 continue
567 pname = param.ptype_str
568 if pname not in params_to_swig:
569 params_to_swig[pname] = param
570
571########################################################################
572#
573# calculate extra dependencies
574#
575module_depends = ["m5", "m5.SimObject", "m5.params"]
576depends = [ PySource.modules[dep].snode for dep in module_depends ]
577depends.sort(key = lambda x: x.name)
578
579########################################################################
580#
581# Commands for the basic automatically generated python files
582#
583
584# Generate Python file containing a dict specifying the current
585# buildEnv flags.
586def makeDefinesPyFile(target, source, env):
587 build_env = source[0].get_contents()
588
589 code = code_formatter()
590 code("""
591import m5.internal
592import m5.util
593
594buildEnv = m5.util.SmartDict($build_env)
595
596compileDate = m5.internal.core.compileDate
597_globals = globals()
598for key,val in m5.internal.core.__dict__.iteritems():
599 if key.startswith('flag_'):
600 flag = key[5:]
601 _globals[flag] = val
602del _globals
603""")
604 code.write(target[0].abspath)
605
606defines_info = Value(build_env)
607# Generate a file with all of the compile options in it
608env.Command('python/m5/defines.py', defines_info,
609 MakeAction(makeDefinesPyFile, Transform("DEFINES", 0)))
610PySource('m5', 'python/m5/defines.py')
611
612# Generate python file containing info about the M5 source code
613def makeInfoPyFile(target, source, env):
614 code = code_formatter()
615 for src in source:
616 data = ''.join(file(src.srcnode().abspath, 'r').xreadlines())
617 code('$src = ${{repr(data)}}')
618 code.write(str(target[0]))
619
620# Generate a file that wraps the basic top level files
621env.Command('python/m5/info.py',
622 [ '#/COPYING', '#/LICENSE', '#/README', ],
623 MakeAction(makeInfoPyFile, Transform("INFO")))
624PySource('m5', 'python/m5/info.py')
625
626########################################################################
627#
628# Create all of the SimObject param headers and enum headers
629#
630
631def createSimObjectParamStruct(target, source, env):
632 assert len(target) == 1 and len(source) == 1
633
634 name = str(source[0].get_contents())
635 obj = sim_objects[name]
636
637 code = code_formatter()
638 obj.cxx_param_decl(code)
639 code.write(target[0].abspath)
640
641def createSimObjectCxxConfig(is_header):
642 def body(target, source, env):
643 assert len(target) == 1 and len(source) == 1
644
645 name = str(source[0].get_contents())
646 obj = sim_objects[name]
647
648 code = code_formatter()
649 obj.cxx_config_param_file(code, is_header)
650 code.write(target[0].abspath)
651 return body
652
653def createParamSwigWrapper(target, source, env):
654 assert len(target) == 1 and len(source) == 1
655
656 name = str(source[0].get_contents())
657 param = params_to_swig[name]
658
659 code = code_formatter()
660 param.swig_decl(code)
661 code.write(target[0].abspath)
662
663def createEnumStrings(target, source, env):
664 assert len(target) == 1 and len(source) == 1
665
666 name = str(source[0].get_contents())
667 obj = all_enums[name]
668
669 code = code_formatter()
670 obj.cxx_def(code)
671 code.write(target[0].abspath)
672
673def createEnumDecls(target, source, env):
674 assert len(target) == 1 and len(source) == 1
675
676 name = str(source[0].get_contents())
677 obj = all_enums[name]
678
679 code = code_formatter()
680 obj.cxx_decl(code)
681 code.write(target[0].abspath)
682
683def createEnumSwigWrapper(target, source, env):
684 assert len(target) == 1 and len(source) == 1
685
686 name = str(source[0].get_contents())
687 obj = all_enums[name]
688
689 code = code_formatter()
690 obj.swig_decl(code)
691 code.write(target[0].abspath)
692
693def createSimObjectSwigWrapper(target, source, env):
694 name = source[0].get_contents()
695 obj = sim_objects[name]
696
697 code = code_formatter()
698 obj.swig_decl(code)
699 code.write(target[0].abspath)
700
701# dummy target for generated code
702# we start out with all the Source files so they get copied to build/*/ also.
703SWIG = env.Dummy('swig', [s.tnode for s in Source.get()])
704
705# Generate all of the SimObject param C++ struct header files
706params_hh_files = []
707for name,simobj in sorted(sim_objects.iteritems()):
708 py_source = PySource.modules[simobj.__module__]
709 extra_deps = [ py_source.tnode ]
710
711 hh_file = File('params/%s.hh' % name)
712 params_hh_files.append(hh_file)
713 env.Command(hh_file, Value(name),
714 MakeAction(createSimObjectParamStruct, Transform("SO PARAM")))
715 env.Depends(hh_file, depends + extra_deps)
716 env.Depends(SWIG, hh_file)
717
718# C++ parameter description files
719if GetOption('with_cxx_config'):
720 for name,simobj in sorted(sim_objects.iteritems()):
721 py_source = PySource.modules[simobj.__module__]
722 extra_deps = [ py_source.tnode ]
723
724 cxx_config_hh_file = File('cxx_config/%s.hh' % name)
725 cxx_config_cc_file = File('cxx_config/%s.cc' % name)
726 env.Command(cxx_config_hh_file, Value(name),
727 MakeAction(createSimObjectCxxConfig(True),
728 Transform("CXXCPRHH")))
729 env.Command(cxx_config_cc_file, Value(name),
730 MakeAction(createSimObjectCxxConfig(False),
731 Transform("CXXCPRCC")))
732 env.Depends(cxx_config_hh_file, depends + extra_deps +
733 [File('params/%s.hh' % name), File('sim/cxx_config.hh')])
734 env.Depends(cxx_config_cc_file, depends + extra_deps +
735 [cxx_config_hh_file])
736 Source(cxx_config_cc_file)
737
738 cxx_config_init_cc_file = File('cxx_config/init.cc')
739
740 def createCxxConfigInitCC(target, source, env):
741 assert len(target) == 1 and len(source) == 1
742
743 code = code_formatter()
744
745 for name,simobj in sorted(sim_objects.iteritems()):
746 if not hasattr(simobj, 'abstract') or not simobj.abstract:
747 code('#include "cxx_config/${name}.hh"')
748 code()
749 code('void cxxConfigInit()')
750 code('{')
751 code.indent()
752 for name,simobj in sorted(sim_objects.iteritems()):
753 not_abstract = not hasattr(simobj, 'abstract') or \
754 not simobj.abstract
755 if not_abstract and 'type' in simobj.__dict__:
756 code('cxx_config_directory["${name}"] = '
757 '${name}CxxConfigParams::makeDirectoryEntry();')
758 code.dedent()
759 code('}')
760 code.write(target[0].abspath)
761
762 py_source = PySource.modules[simobj.__module__]
763 extra_deps = [ py_source.tnode ]
764 env.Command(cxx_config_init_cc_file, Value(name),
765 MakeAction(createCxxConfigInitCC, Transform("CXXCINIT")))
766 cxx_param_hh_files = ["cxx_config/%s.hh" % simobj
767 for name,simobj in sorted(sim_objects.iteritems())
768 if not hasattr(simobj, 'abstract') or not simobj.abstract]
769 Depends(cxx_config_init_cc_file, cxx_param_hh_files +
770 [File('sim/cxx_config.hh')])
771 Source(cxx_config_init_cc_file)
772
773# Generate any needed param SWIG wrapper files
774params_i_files = []
775for name,param in sorted(params_to_swig.iteritems()):
776 i_file = File('python/m5/internal/%s.i' % (param.swig_module_name()))
777 params_i_files.append(i_file)
778 env.Command(i_file, Value(name),
779 MakeAction(createParamSwigWrapper, Transform("SW PARAM")))
780 env.Depends(i_file, depends)
781 env.Depends(SWIG, i_file)
782 SwigSource('m5.internal', i_file)
783
784# Generate all enum header files
785for name,enum in sorted(all_enums.iteritems()):
786 py_source = PySource.modules[enum.__module__]
787 extra_deps = [ py_source.tnode ]
788
789 cc_file = File('enums/%s.cc' % name)
790 env.Command(cc_file, Value(name),
791 MakeAction(createEnumStrings, Transform("ENUM STR")))
792 env.Depends(cc_file, depends + extra_deps)
793 env.Depends(SWIG, cc_file)
794 Source(cc_file)
795
796 hh_file = File('enums/%s.hh' % name)
797 env.Command(hh_file, Value(name),
798 MakeAction(createEnumDecls, Transform("ENUMDECL")))
799 env.Depends(hh_file, depends + extra_deps)
800 env.Depends(SWIG, hh_file)
801
802 i_file = File('python/m5/internal/enum_%s.i' % name)
803 env.Command(i_file, Value(name),
804 MakeAction(createEnumSwigWrapper, Transform("ENUMSWIG")))
805 env.Depends(i_file, depends + extra_deps)
806 env.Depends(SWIG, i_file)
807 SwigSource('m5.internal', i_file)
808
809# Generate SimObject SWIG wrapper files
810for name,simobj in sorted(sim_objects.iteritems()):
811 py_source = PySource.modules[simobj.__module__]
812 extra_deps = [ py_source.tnode ]
813 i_file = File('python/m5/internal/param_%s.i' % name)
814 env.Command(i_file, Value(name),
815 MakeAction(createSimObjectSwigWrapper, Transform("SO SWIG")))
816 env.Depends(i_file, depends + extra_deps)
817 SwigSource('m5.internal', i_file)
818
819# Generate the main swig init file
|
819def makeEmbeddedSwigInit(target, source, env):
820 code = code_formatter()
821 module = source[0].get_contents()
822 code('''\
823#include "sim/init.hh"
| 820def makeEmbeddedSwigInit(package):
821 def body(target, source, env):
822 assert len(target) == 1 and len(source) == 1
|
824
| 823
|
825extern "C" {
826 void init_${module}();
827}
| 824 code = code_formatter()
825 module = source[0].get_contents()
826 # Provide the full context so that the swig-generated call to
827 # Py_InitModule ends up placing the embedded module in the
828 # right package.
829 context = str(package) + "._" + str(module)
830 code('''\
831 #include "sim/init.hh"
|
828
| 832
|
829EmbeddedSwig embed_swig_${module}(init_${module});
830''')
831 code.write(str(target[0]))
| 833 extern "C" {
834 void init_${module}();
835 }
|
832
| 836
|
| 837 EmbeddedSwig embed_swig_${module}(init_${module}, "${context}");
838 ''')
839 code.write(str(target[0]))
840 return body
841
|
833# Build all swig modules
834for swig in SwigSource.all:
835 env.Command([swig.cc_source.tnode, swig.py_source.tnode], swig.tnode,
836 MakeAction('$SWIG $SWIGFLAGS -outdir ${TARGETS[1].dir} '
837 '-o ${TARGETS[0]} $SOURCES', Transform("SWIG")))
838 cc_file = str(swig.tnode)
839 init_file = '%s/%s_init.cc' % (dirname(cc_file), basename(cc_file))
840 env.Command(init_file, Value(swig.module),
| 842# Build all swig modules
843for swig in SwigSource.all:
844 env.Command([swig.cc_source.tnode, swig.py_source.tnode], swig.tnode,
845 MakeAction('$SWIG $SWIGFLAGS -outdir ${TARGETS[1].dir} '
846 '-o ${TARGETS[0]} $SOURCES', Transform("SWIG")))
847 cc_file = str(swig.tnode)
848 init_file = '%s/%s_init.cc' % (dirname(cc_file), basename(cc_file))
849 env.Command(init_file, Value(swig.module),
|
841 MakeAction(makeEmbeddedSwigInit, Transform("EMBED SW")))
| 850 MakeAction(makeEmbeddedSwigInit(swig.package),
851 Transform("EMBED SW")))
|
842 env.Depends(SWIG, init_file)
843 Source(init_file, **swig.guards)
844
845# Build all protocol buffers if we have got protoc and protobuf available
846if env['HAVE_PROTOBUF']:
847 for proto in ProtoBuf.all:
848 # Use both the source and header as the target, and the .proto
849 # file as the source. When executing the protoc compiler, also
850 # specify the proto_path to avoid having the generated files
851 # include the path.
852 env.Command([proto.cc_file, proto.hh_file], proto.tnode,
853 MakeAction('$PROTOC --cpp_out ${TARGET.dir} '
854 '--proto_path ${SOURCE.dir} $SOURCE',
855 Transform("PROTOC")))
856
857 env.Depends(SWIG, [proto.cc_file, proto.hh_file])
858 # Add the C++ source file
859 Source(proto.cc_file, **proto.guards)
860elif ProtoBuf.all:
861 print 'Got protobuf to build, but lacks support!'
862 Exit(1)
863
864#
865# Handle debug flags
866#
867def makeDebugFlagCC(target, source, env):
868 assert(len(target) == 1 and len(source) == 1)
869
870 code = code_formatter()
871
872 # delay definition of CompoundFlags until after all the definition
873 # of all constituent SimpleFlags
874 comp_code = code_formatter()
875
876 # file header
877 code('''
878/*
879 * DO NOT EDIT THIS FILE! Automatically generated by SCons.
880 */
881
882#include "base/debug.hh"
883
884namespace Debug {
885
886''')
887
888 for name, flag in sorted(source[0].read().iteritems()):
889 n, compound, desc = flag
890 assert n == name
891
892 if not compound:
893 code('SimpleFlag $name("$name", "$desc");')
894 else:
895 comp_code('CompoundFlag $name("$name", "$desc",')
896 comp_code.indent()
897 last = len(compound) - 1
898 for i,flag in enumerate(compound):
899 if i != last:
900 comp_code('&$flag,')
901 else:
902 comp_code('&$flag);')
903 comp_code.dedent()
904
905 code.append(comp_code)
906 code()
907 code('} // namespace Debug')
908
909 code.write(str(target[0]))
910
911def makeDebugFlagHH(target, source, env):
912 assert(len(target) == 1 and len(source) == 1)
913
914 val = eval(source[0].get_contents())
915 name, compound, desc = val
916
917 code = code_formatter()
918
919 # file header boilerplate
920 code('''\
921/*
922 * DO NOT EDIT THIS FILE! Automatically generated by SCons.
923 */
924
925#ifndef __DEBUG_${name}_HH__
926#define __DEBUG_${name}_HH__
927
928namespace Debug {
929''')
930
931 if compound:
932 code('class CompoundFlag;')
933 code('class SimpleFlag;')
934
935 if compound:
936 code('extern CompoundFlag $name;')
937 for flag in compound:
938 code('extern SimpleFlag $flag;')
939 else:
940 code('extern SimpleFlag $name;')
941
942 code('''
943}
944
945#endif // __DEBUG_${name}_HH__
946''')
947
948 code.write(str(target[0]))
949
950for name,flag in sorted(debug_flags.iteritems()):
951 n, compound, desc = flag
952 assert n == name
953
954 hh_file = 'debug/%s.hh' % name
955 env.Command(hh_file, Value(flag),
956 MakeAction(makeDebugFlagHH, Transform("TRACING", 0)))
957 env.Depends(SWIG, hh_file)
958
959env.Command('debug/flags.cc', Value(debug_flags),
960 MakeAction(makeDebugFlagCC, Transform("TRACING", 0)))
961env.Depends(SWIG, 'debug/flags.cc')
962Source('debug/flags.cc')
963
964# version tags
965tags = \
966env.Command('sim/tags.cc', None,
967 MakeAction('util/cpt_upgrader.py --get-cc-file > $TARGET',
968 Transform("VER TAGS")))
969env.AlwaysBuild(tags)
970
971# Embed python files. All .py files that have been indicated by a
972# PySource() call in a SConscript need to be embedded into the M5
973# library. To do that, we compile the file to byte code, marshal the
974# byte code, compress it, and then generate a c++ file that
975# inserts the result into an array.
976def embedPyFile(target, source, env):
977 def c_str(string):
978 if string is None:
979 return "0"
980 return '"%s"' % string
981
982 '''Action function to compile a .py into a code object, marshal
983 it, compress it, and stick it into an asm file so the code appears
984 as just bytes with a label in the data section'''
985
986 src = file(str(source[0]), 'r').read()
987
988 pysource = PySource.tnodes[source[0]]
989 compiled = compile(src, pysource.abspath, 'exec')
990 marshalled = marshal.dumps(compiled)
991 compressed = zlib.compress(marshalled)
992 data = compressed
993 sym = pysource.symname
994
995 code = code_formatter()
996 code('''\
997#include "sim/init.hh"
998
999namespace {
1000
1001const uint8_t data_${sym}[] = {
1002''')
1003 code.indent()
1004 step = 16
1005 for i in xrange(0, len(data), step):
1006 x = array.array('B', data[i:i+step])
1007 code(''.join('%d,' % d for d in x))
1008 code.dedent()
1009
1010 code('''};
1011
1012EmbeddedPython embedded_${sym}(
1013 ${{c_str(pysource.arcname)}},
1014 ${{c_str(pysource.abspath)}},
1015 ${{c_str(pysource.modpath)}},
1016 data_${sym},
1017 ${{len(data)}},
1018 ${{len(marshalled)}});
1019
1020} // anonymous namespace
1021''')
1022 code.write(str(target[0]))
1023
1024for source in PySource.all:
1025 env.Command(source.cpp, source.tnode,
1026 MakeAction(embedPyFile, Transform("EMBED PY")))
1027 env.Depends(SWIG, source.cpp)
1028 Source(source.cpp, skip_no_python=True)
1029
1030########################################################################
1031#
1032# Define binaries. Each different build type (debug, opt, etc.) gets
1033# a slightly different build environment.
1034#
1035
1036# List of constructed environments to pass back to SConstruct
1037date_source = Source('base/date.cc', skip_lib=True)
1038
1039# Capture this directory for the closure makeEnv, otherwise when it is
1040# called, it won't know what directory it should use.
1041variant_dir = Dir('.').path
1042def variant(*path):
1043 return os.path.join(variant_dir, *path)
1044def variantd(*path):
1045 return variant(*path)+'/'
1046
1047# Function to create a new build environment as clone of current
1048# environment 'env' with modified object suffix and optional stripped
1049# binary. Additional keyword arguments are appended to corresponding
1050# build environment vars.
1051def makeEnv(env, label, objsfx, strip = False, **kwargs):
1052 # SCons doesn't know to append a library suffix when there is a '.' in the
1053 # name. Use '_' instead.
1054 libname = variant('gem5_' + label)
1055 exename = variant('gem5.' + label)
1056 secondary_exename = variant('m5.' + label)
1057
1058 new_env = env.Clone(OBJSUFFIX=objsfx, SHOBJSUFFIX=objsfx + 's')
1059 new_env.Label = label
1060 new_env.Append(**kwargs)
1061
1062 swig_env = new_env.Clone()
1063
1064 # Both gcc and clang have issues with unused labels and values in
1065 # the SWIG generated code
1066 swig_env.Append(CCFLAGS=['-Wno-unused-label', '-Wno-unused-value'])
1067
1068 if env['GCC']:
1069 # Depending on the SWIG version, we also need to supress
1070 # warnings about uninitialized variables and missing field
1071 # initializers.
1072 swig_env.Append(CCFLAGS=['-Wno-uninitialized',
1073 '-Wno-missing-field-initializers',
1074 '-Wno-unused-but-set-variable',
1075 '-Wno-maybe-uninitialized',
1076 '-Wno-type-limits'])
1077
1078 # Only gcc >= 4.9 supports UBSan, so check both the version
1079 # and the command-line option before adding the compiler and
1080 # linker flags.
1081 if GetOption('with_ubsan') and \
1082 compareVersions(env['GCC_VERSION'], '4.9') >= 0:
1083 new_env.Append(CCFLAGS='-fsanitize=undefined')
1084 new_env.Append(LINKFLAGS='-fsanitize=undefined')
1085
1086 # The address sanitizer is available for gcc >= 4.8
1087 if GetOption('with_asan'):
1088 new_env.Append(CCFLAGS=['-fsanitize=address',
1089 '-fno-omit-frame-pointer'])
1090 new_env.Append(LINKFLAGS='-fsanitize=address')
1091
1092 if env['CLANG']:
1093 swig_env.Append(CCFLAGS=['-Wno-sometimes-uninitialized',
1094 '-Wno-deprecated-register',
1095 '-Wno-tautological-compare'])
1096
1097 # We require clang >= 3.1, so there is no need to check any
1098 # versions here.
1099 if GetOption('with_ubsan'):
1100 new_env.Append(CCFLAGS='-fsanitize=undefined')
1101 new_env.Append(LINKFLAGS='-fsanitize=undefined')
1102
1103 if GetOption('with_asan'):
1104 new_env.Append(CCFLAGS=['-fsanitize=address',
1105 '-fno-omit-frame-pointer'])
1106 new_env.Append(LINKFLAGS='-fsanitize=address')
1107
1108 werror_env = new_env.Clone()
1109 # Treat warnings as errors but white list some warnings that we
1110 # want to allow (e.g., deprecation warnings).
1111 werror_env.Append(CCFLAGS=['-Werror',
1112 '-Wno-error=deprecated-declarations',
1113 '-Wno-error=deprecated',
1114 ])
1115
1116 def make_obj(source, static, extra_deps = None):
1117 '''This function adds the specified source to the correct
1118 build environment, and returns the corresponding SCons Object
1119 nodes'''
1120
1121 if source.swig:
1122 env = swig_env
1123 elif source.Werror:
1124 env = werror_env
1125 else:
1126 env = new_env
1127
1128 if static:
1129 obj = env.StaticObject(source.tnode)
1130 else:
1131 obj = env.SharedObject(source.tnode)
1132
1133 if extra_deps:
1134 env.Depends(obj, extra_deps)
1135
1136 return obj
1137
1138 lib_guards = {'main': False, 'skip_lib': False}
1139
1140 # Without Python, leave out all SWIG and Python content from the
1141 # library builds. The option doesn't affect gem5 built as a program
1142 if GetOption('without_python'):
1143 lib_guards['skip_no_python'] = False
1144
1145 static_objs = [ make_obj(s, True) for s in Source.get(**lib_guards) ]
1146 shared_objs = [ make_obj(s, False) for s in Source.get(**lib_guards) ]
1147
1148 static_date = make_obj(date_source, static=True, extra_deps=static_objs)
1149 static_objs.append(static_date)
1150
1151 shared_date = make_obj(date_source, static=False, extra_deps=shared_objs)
1152 shared_objs.append(shared_date)
1153
1154 # First make a library of everything but main() so other programs can
1155 # link against m5.
1156 static_lib = new_env.StaticLibrary(libname, static_objs)
1157 shared_lib = new_env.SharedLibrary(libname, shared_objs)
1158
1159 # Now link a stub with main() and the static library.
1160 main_objs = [ make_obj(s, True) for s in Source.get(main=True) ]
1161
1162 for test in UnitTest.all:
1163 flags = { test.target : True }
1164 test_sources = Source.get(**flags)
1165 test_objs = [ make_obj(s, static=True) for s in test_sources ]
1166 if test.main:
1167 test_objs += main_objs
1168 path = variant('unittest/%s.%s' % (test.target, label))
1169 new_env.Program(path, test_objs + static_objs)
1170
1171 progname = exename
1172 if strip:
1173 progname += '.unstripped'
1174
1175 targets = new_env.Program(progname, main_objs + static_objs)
1176
1177 if strip:
1178 if sys.platform == 'sunos5':
1179 cmd = 'cp $SOURCE $TARGET; strip $TARGET'
1180 else:
1181 cmd = 'strip $SOURCE -o $TARGET'
1182 targets = new_env.Command(exename, progname,
1183 MakeAction(cmd, Transform("STRIP")))
1184
1185 new_env.Command(secondary_exename, exename,
1186 MakeAction('ln $SOURCE $TARGET', Transform("HARDLINK")))
1187
1188 new_env.M5Binary = targets[0]
1189 return new_env
1190
1191# Start out with the compiler flags common to all compilers,
1192# i.e. they all use -g for opt and -g -pg for prof
1193ccflags = {'debug' : [], 'opt' : ['-g'], 'fast' : [], 'prof' : ['-g', '-pg'],
1194 'perf' : ['-g']}
1195
1196# Start out with the linker flags common to all linkers, i.e. -pg for
1197# prof, and -lprofiler for perf. The -lprofile flag is surrounded by
1198# no-as-needed and as-needed as the binutils linker is too clever and
1199# simply doesn't link to the library otherwise.
1200ldflags = {'debug' : [], 'opt' : [], 'fast' : [], 'prof' : ['-pg'],
1201 'perf' : ['-Wl,--no-as-needed', '-lprofiler', '-Wl,--as-needed']}
1202
1203# For Link Time Optimization, the optimisation flags used to compile
1204# individual files are decoupled from those used at link time
1205# (i.e. you can compile with -O3 and perform LTO with -O0), so we need
1206# to also update the linker flags based on the target.
1207if env['GCC']:
1208 if sys.platform == 'sunos5':
1209 ccflags['debug'] += ['-gstabs+']
1210 else:
1211 ccflags['debug'] += ['-ggdb3']
1212 ldflags['debug'] += ['-O0']
1213 # opt, fast, prof and perf all share the same cc flags, also add
1214 # the optimization to the ldflags as LTO defers the optimization
1215 # to link time
1216 for target in ['opt', 'fast', 'prof', 'perf']:
1217 ccflags[target] += ['-O3']
1218 ldflags[target] += ['-O3']
1219
1220 ccflags['fast'] += env['LTO_CCFLAGS']
1221 ldflags['fast'] += env['LTO_LDFLAGS']
1222elif env['CLANG']:
1223 ccflags['debug'] += ['-g', '-O0']
1224 # opt, fast, prof and perf all share the same cc flags
1225 for target in ['opt', 'fast', 'prof', 'perf']:
1226 ccflags[target] += ['-O3']
1227else:
1228 print 'Unknown compiler, please fix compiler options'
1229 Exit(1)
1230
1231
1232# To speed things up, we only instantiate the build environments we
1233# need. We try to identify the needed environment for each target; if
1234# we can't, we fall back on instantiating all the environments just to
1235# be safe.
1236target_types = ['debug', 'opt', 'fast', 'prof', 'perf']
1237obj2target = {'do': 'debug', 'o': 'opt', 'fo': 'fast', 'po': 'prof',
1238 'gpo' : 'perf'}
1239
1240def identifyTarget(t):
1241 ext = t.split('.')[-1]
1242 if ext in target_types:
1243 return ext
1244 if obj2target.has_key(ext):
1245 return obj2target[ext]
1246 match = re.search(r'/tests/([^/]+)/', t)
1247 if match and match.group(1) in target_types:
1248 return match.group(1)
1249 return 'all'
1250
1251needed_envs = [identifyTarget(target) for target in BUILD_TARGETS]
1252if 'all' in needed_envs:
1253 needed_envs += target_types
1254
1255def makeEnvirons(target, source, env):
1256 # cause any later Source() calls to be fatal, as a diagnostic.
1257 Source.done()
1258
1259 envList = []
1260
1261 # Debug binary
1262 if 'debug' in needed_envs:
1263 envList.append(
1264 makeEnv(env, 'debug', '.do',
1265 CCFLAGS = Split(ccflags['debug']),
1266 CPPDEFINES = ['DEBUG', 'TRACING_ON=1'],
1267 LINKFLAGS = Split(ldflags['debug'])))
1268
1269 # Optimized binary
1270 if 'opt' in needed_envs:
1271 envList.append(
1272 makeEnv(env, 'opt', '.o',
1273 CCFLAGS = Split(ccflags['opt']),
1274 CPPDEFINES = ['TRACING_ON=1'],
1275 LINKFLAGS = Split(ldflags['opt'])))
1276
1277 # "Fast" binary
1278 if 'fast' in needed_envs:
1279 envList.append(
1280 makeEnv(env, 'fast', '.fo', strip = True,
1281 CCFLAGS = Split(ccflags['fast']),
1282 CPPDEFINES = ['NDEBUG', 'TRACING_ON=0'],
1283 LINKFLAGS = Split(ldflags['fast'])))
1284
1285 # Profiled binary using gprof
1286 if 'prof' in needed_envs:
1287 envList.append(
1288 makeEnv(env, 'prof', '.po',
1289 CCFLAGS = Split(ccflags['prof']),
1290 CPPDEFINES = ['NDEBUG', 'TRACING_ON=0'],
1291 LINKFLAGS = Split(ldflags['prof'])))
1292
1293 # Profiled binary using google-pprof
1294 if 'perf' in needed_envs:
1295 envList.append(
1296 makeEnv(env, 'perf', '.gpo',
1297 CCFLAGS = Split(ccflags['perf']),
1298 CPPDEFINES = ['NDEBUG', 'TRACING_ON=0'],
1299 LINKFLAGS = Split(ldflags['perf'])))
1300
1301 # Set up the regression tests for each build.
1302 for e in envList:
1303 SConscript(os.path.join(env.root.abspath, 'tests', 'SConscript'),
1304 variant_dir = variantd('tests', e.Label),
1305 exports = { 'env' : e }, duplicate = False)
1306
1307# The MakeEnvirons Builder defers the full dependency collection until
1308# after processing the ISA definition (due to dynamically generated
1309# source files). Add this dependency to all targets so they will wait
1310# until the environments are completely set up. Otherwise, a second
1311# process (e.g. -j2 or higher) will try to compile the requested target,
1312# not know how, and fail.
1313env.Append(BUILDERS = {'MakeEnvirons' :
1314 Builder(action=MakeAction(makeEnvirons,
1315 Transform("ENVIRONS", 1)))})
1316
1317isa_target = env['PHONY_BASE'] + '-deps'
1318environs = env['PHONY_BASE'] + '-environs'
1319env.Depends('#all-deps', isa_target)
1320env.Depends('#all-environs', environs)
1321env.ScanISA(isa_target, File('arch/%s/generated/inc.d' % env['TARGET_ISA']))
1322envSetup = env.MakeEnvirons(environs, isa_target)
1323
1324# make sure no -deps targets occur before all ISAs are complete
1325env.Depends(isa_target, '#all-isas')
1326# likewise for -environs targets and all the -deps targets
1327env.Depends(environs, '#all-deps')
| 852 env.Depends(SWIG, init_file)
853 Source(init_file, **swig.guards)
854
855# Build all protocol buffers if we have got protoc and protobuf available
856if env['HAVE_PROTOBUF']:
857 for proto in ProtoBuf.all:
858 # Use both the source and header as the target, and the .proto
859 # file as the source. When executing the protoc compiler, also
860 # specify the proto_path to avoid having the generated files
861 # include the path.
862 env.Command([proto.cc_file, proto.hh_file], proto.tnode,
863 MakeAction('$PROTOC --cpp_out ${TARGET.dir} '
864 '--proto_path ${SOURCE.dir} $SOURCE',
865 Transform("PROTOC")))
866
867 env.Depends(SWIG, [proto.cc_file, proto.hh_file])
868 # Add the C++ source file
869 Source(proto.cc_file, **proto.guards)
870elif ProtoBuf.all:
871 print 'Got protobuf to build, but lacks support!'
872 Exit(1)
873
874#
875# Handle debug flags
876#
877def makeDebugFlagCC(target, source, env):
878 assert(len(target) == 1 and len(source) == 1)
879
880 code = code_formatter()
881
882 # delay definition of CompoundFlags until after all the definition
883 # of all constituent SimpleFlags
884 comp_code = code_formatter()
885
886 # file header
887 code('''
888/*
889 * DO NOT EDIT THIS FILE! Automatically generated by SCons.
890 */
891
892#include "base/debug.hh"
893
894namespace Debug {
895
896''')
897
898 for name, flag in sorted(source[0].read().iteritems()):
899 n, compound, desc = flag
900 assert n == name
901
902 if not compound:
903 code('SimpleFlag $name("$name", "$desc");')
904 else:
905 comp_code('CompoundFlag $name("$name", "$desc",')
906 comp_code.indent()
907 last = len(compound) - 1
908 for i,flag in enumerate(compound):
909 if i != last:
910 comp_code('&$flag,')
911 else:
912 comp_code('&$flag);')
913 comp_code.dedent()
914
915 code.append(comp_code)
916 code()
917 code('} // namespace Debug')
918
919 code.write(str(target[0]))
920
921def makeDebugFlagHH(target, source, env):
922 assert(len(target) == 1 and len(source) == 1)
923
924 val = eval(source[0].get_contents())
925 name, compound, desc = val
926
927 code = code_formatter()
928
929 # file header boilerplate
930 code('''\
931/*
932 * DO NOT EDIT THIS FILE! Automatically generated by SCons.
933 */
934
935#ifndef __DEBUG_${name}_HH__
936#define __DEBUG_${name}_HH__
937
938namespace Debug {
939''')
940
941 if compound:
942 code('class CompoundFlag;')
943 code('class SimpleFlag;')
944
945 if compound:
946 code('extern CompoundFlag $name;')
947 for flag in compound:
948 code('extern SimpleFlag $flag;')
949 else:
950 code('extern SimpleFlag $name;')
951
952 code('''
953}
954
955#endif // __DEBUG_${name}_HH__
956''')
957
958 code.write(str(target[0]))
959
960for name,flag in sorted(debug_flags.iteritems()):
961 n, compound, desc = flag
962 assert n == name
963
964 hh_file = 'debug/%s.hh' % name
965 env.Command(hh_file, Value(flag),
966 MakeAction(makeDebugFlagHH, Transform("TRACING", 0)))
967 env.Depends(SWIG, hh_file)
968
969env.Command('debug/flags.cc', Value(debug_flags),
970 MakeAction(makeDebugFlagCC, Transform("TRACING", 0)))
971env.Depends(SWIG, 'debug/flags.cc')
972Source('debug/flags.cc')
973
974# version tags
975tags = \
976env.Command('sim/tags.cc', None,
977 MakeAction('util/cpt_upgrader.py --get-cc-file > $TARGET',
978 Transform("VER TAGS")))
979env.AlwaysBuild(tags)
980
981# Embed python files. All .py files that have been indicated by a
982# PySource() call in a SConscript need to be embedded into the M5
983# library. To do that, we compile the file to byte code, marshal the
984# byte code, compress it, and then generate a c++ file that
985# inserts the result into an array.
986def embedPyFile(target, source, env):
987 def c_str(string):
988 if string is None:
989 return "0"
990 return '"%s"' % string
991
992 '''Action function to compile a .py into a code object, marshal
993 it, compress it, and stick it into an asm file so the code appears
994 as just bytes with a label in the data section'''
995
996 src = file(str(source[0]), 'r').read()
997
998 pysource = PySource.tnodes[source[0]]
999 compiled = compile(src, pysource.abspath, 'exec')
1000 marshalled = marshal.dumps(compiled)
1001 compressed = zlib.compress(marshalled)
1002 data = compressed
1003 sym = pysource.symname
1004
1005 code = code_formatter()
1006 code('''\
1007#include "sim/init.hh"
1008
1009namespace {
1010
1011const uint8_t data_${sym}[] = {
1012''')
1013 code.indent()
1014 step = 16
1015 for i in xrange(0, len(data), step):
1016 x = array.array('B', data[i:i+step])
1017 code(''.join('%d,' % d for d in x))
1018 code.dedent()
1019
1020 code('''};
1021
1022EmbeddedPython embedded_${sym}(
1023 ${{c_str(pysource.arcname)}},
1024 ${{c_str(pysource.abspath)}},
1025 ${{c_str(pysource.modpath)}},
1026 data_${sym},
1027 ${{len(data)}},
1028 ${{len(marshalled)}});
1029
1030} // anonymous namespace
1031''')
1032 code.write(str(target[0]))
1033
1034for source in PySource.all:
1035 env.Command(source.cpp, source.tnode,
1036 MakeAction(embedPyFile, Transform("EMBED PY")))
1037 env.Depends(SWIG, source.cpp)
1038 Source(source.cpp, skip_no_python=True)
1039
1040########################################################################
1041#
1042# Define binaries. Each different build type (debug, opt, etc.) gets
1043# a slightly different build environment.
1044#
1045
1046# List of constructed environments to pass back to SConstruct
1047date_source = Source('base/date.cc', skip_lib=True)
1048
1049# Capture this directory for the closure makeEnv, otherwise when it is
1050# called, it won't know what directory it should use.
1051variant_dir = Dir('.').path
1052def variant(*path):
1053 return os.path.join(variant_dir, *path)
1054def variantd(*path):
1055 return variant(*path)+'/'
1056
1057# Function to create a new build environment as clone of current
1058# environment 'env' with modified object suffix and optional stripped
1059# binary. Additional keyword arguments are appended to corresponding
1060# build environment vars.
1061def makeEnv(env, label, objsfx, strip = False, **kwargs):
1062 # SCons doesn't know to append a library suffix when there is a '.' in the
1063 # name. Use '_' instead.
1064 libname = variant('gem5_' + label)
1065 exename = variant('gem5.' + label)
1066 secondary_exename = variant('m5.' + label)
1067
1068 new_env = env.Clone(OBJSUFFIX=objsfx, SHOBJSUFFIX=objsfx + 's')
1069 new_env.Label = label
1070 new_env.Append(**kwargs)
1071
1072 swig_env = new_env.Clone()
1073
1074 # Both gcc and clang have issues with unused labels and values in
1075 # the SWIG generated code
1076 swig_env.Append(CCFLAGS=['-Wno-unused-label', '-Wno-unused-value'])
1077
1078 if env['GCC']:
1079 # Depending on the SWIG version, we also need to supress
1080 # warnings about uninitialized variables and missing field
1081 # initializers.
1082 swig_env.Append(CCFLAGS=['-Wno-uninitialized',
1083 '-Wno-missing-field-initializers',
1084 '-Wno-unused-but-set-variable',
1085 '-Wno-maybe-uninitialized',
1086 '-Wno-type-limits'])
1087
1088 # Only gcc >= 4.9 supports UBSan, so check both the version
1089 # and the command-line option before adding the compiler and
1090 # linker flags.
1091 if GetOption('with_ubsan') and \
1092 compareVersions(env['GCC_VERSION'], '4.9') >= 0:
1093 new_env.Append(CCFLAGS='-fsanitize=undefined')
1094 new_env.Append(LINKFLAGS='-fsanitize=undefined')
1095
1096 # The address sanitizer is available for gcc >= 4.8
1097 if GetOption('with_asan'):
1098 new_env.Append(CCFLAGS=['-fsanitize=address',
1099 '-fno-omit-frame-pointer'])
1100 new_env.Append(LINKFLAGS='-fsanitize=address')
1101
1102 if env['CLANG']:
1103 swig_env.Append(CCFLAGS=['-Wno-sometimes-uninitialized',
1104 '-Wno-deprecated-register',
1105 '-Wno-tautological-compare'])
1106
1107 # We require clang >= 3.1, so there is no need to check any
1108 # versions here.
1109 if GetOption('with_ubsan'):
1110 new_env.Append(CCFLAGS='-fsanitize=undefined')
1111 new_env.Append(LINKFLAGS='-fsanitize=undefined')
1112
1113 if GetOption('with_asan'):
1114 new_env.Append(CCFLAGS=['-fsanitize=address',
1115 '-fno-omit-frame-pointer'])
1116 new_env.Append(LINKFLAGS='-fsanitize=address')
1117
1118 werror_env = new_env.Clone()
1119 # Treat warnings as errors but white list some warnings that we
1120 # want to allow (e.g., deprecation warnings).
1121 werror_env.Append(CCFLAGS=['-Werror',
1122 '-Wno-error=deprecated-declarations',
1123 '-Wno-error=deprecated',
1124 ])
1125
1126 def make_obj(source, static, extra_deps = None):
1127 '''This function adds the specified source to the correct
1128 build environment, and returns the corresponding SCons Object
1129 nodes'''
1130
1131 if source.swig:
1132 env = swig_env
1133 elif source.Werror:
1134 env = werror_env
1135 else:
1136 env = new_env
1137
1138 if static:
1139 obj = env.StaticObject(source.tnode)
1140 else:
1141 obj = env.SharedObject(source.tnode)
1142
1143 if extra_deps:
1144 env.Depends(obj, extra_deps)
1145
1146 return obj
1147
1148 lib_guards = {'main': False, 'skip_lib': False}
1149
1150 # Without Python, leave out all SWIG and Python content from the
1151 # library builds. The option doesn't affect gem5 built as a program
1152 if GetOption('without_python'):
1153 lib_guards['skip_no_python'] = False
1154
1155 static_objs = [ make_obj(s, True) for s in Source.get(**lib_guards) ]
1156 shared_objs = [ make_obj(s, False) for s in Source.get(**lib_guards) ]
1157
1158 static_date = make_obj(date_source, static=True, extra_deps=static_objs)
1159 static_objs.append(static_date)
1160
1161 shared_date = make_obj(date_source, static=False, extra_deps=shared_objs)
1162 shared_objs.append(shared_date)
1163
1164 # First make a library of everything but main() so other programs can
1165 # link against m5.
1166 static_lib = new_env.StaticLibrary(libname, static_objs)
1167 shared_lib = new_env.SharedLibrary(libname, shared_objs)
1168
1169 # Now link a stub with main() and the static library.
1170 main_objs = [ make_obj(s, True) for s in Source.get(main=True) ]
1171
1172 for test in UnitTest.all:
1173 flags = { test.target : True }
1174 test_sources = Source.get(**flags)
1175 test_objs = [ make_obj(s, static=True) for s in test_sources ]
1176 if test.main:
1177 test_objs += main_objs
1178 path = variant('unittest/%s.%s' % (test.target, label))
1179 new_env.Program(path, test_objs + static_objs)
1180
1181 progname = exename
1182 if strip:
1183 progname += '.unstripped'
1184
1185 targets = new_env.Program(progname, main_objs + static_objs)
1186
1187 if strip:
1188 if sys.platform == 'sunos5':
1189 cmd = 'cp $SOURCE $TARGET; strip $TARGET'
1190 else:
1191 cmd = 'strip $SOURCE -o $TARGET'
1192 targets = new_env.Command(exename, progname,
1193 MakeAction(cmd, Transform("STRIP")))
1194
1195 new_env.Command(secondary_exename, exename,
1196 MakeAction('ln $SOURCE $TARGET', Transform("HARDLINK")))
1197
1198 new_env.M5Binary = targets[0]
1199 return new_env
1200
1201# Start out with the compiler flags common to all compilers,
1202# i.e. they all use -g for opt and -g -pg for prof
1203ccflags = {'debug' : [], 'opt' : ['-g'], 'fast' : [], 'prof' : ['-g', '-pg'],
1204 'perf' : ['-g']}
1205
1206# Start out with the linker flags common to all linkers, i.e. -pg for
1207# prof, and -lprofiler for perf. The -lprofile flag is surrounded by
1208# no-as-needed and as-needed as the binutils linker is too clever and
1209# simply doesn't link to the library otherwise.
1210ldflags = {'debug' : [], 'opt' : [], 'fast' : [], 'prof' : ['-pg'],
1211 'perf' : ['-Wl,--no-as-needed', '-lprofiler', '-Wl,--as-needed']}
1212
1213# For Link Time Optimization, the optimisation flags used to compile
1214# individual files are decoupled from those used at link time
1215# (i.e. you can compile with -O3 and perform LTO with -O0), so we need
1216# to also update the linker flags based on the target.
1217if env['GCC']:
1218 if sys.platform == 'sunos5':
1219 ccflags['debug'] += ['-gstabs+']
1220 else:
1221 ccflags['debug'] += ['-ggdb3']
1222 ldflags['debug'] += ['-O0']
1223 # opt, fast, prof and perf all share the same cc flags, also add
1224 # the optimization to the ldflags as LTO defers the optimization
1225 # to link time
1226 for target in ['opt', 'fast', 'prof', 'perf']:
1227 ccflags[target] += ['-O3']
1228 ldflags[target] += ['-O3']
1229
1230 ccflags['fast'] += env['LTO_CCFLAGS']
1231 ldflags['fast'] += env['LTO_LDFLAGS']
1232elif env['CLANG']:
1233 ccflags['debug'] += ['-g', '-O0']
1234 # opt, fast, prof and perf all share the same cc flags
1235 for target in ['opt', 'fast', 'prof', 'perf']:
1236 ccflags[target] += ['-O3']
1237else:
1238 print 'Unknown compiler, please fix compiler options'
1239 Exit(1)
1240
1241
1242# To speed things up, we only instantiate the build environments we
1243# need. We try to identify the needed environment for each target; if
1244# we can't, we fall back on instantiating all the environments just to
1245# be safe.
1246target_types = ['debug', 'opt', 'fast', 'prof', 'perf']
1247obj2target = {'do': 'debug', 'o': 'opt', 'fo': 'fast', 'po': 'prof',
1248 'gpo' : 'perf'}
1249
1250def identifyTarget(t):
1251 ext = t.split('.')[-1]
1252 if ext in target_types:
1253 return ext
1254 if obj2target.has_key(ext):
1255 return obj2target[ext]
1256 match = re.search(r'/tests/([^/]+)/', t)
1257 if match and match.group(1) in target_types:
1258 return match.group(1)
1259 return 'all'
1260
1261needed_envs = [identifyTarget(target) for target in BUILD_TARGETS]
1262if 'all' in needed_envs:
1263 needed_envs += target_types
1264
1265def makeEnvirons(target, source, env):
1266 # cause any later Source() calls to be fatal, as a diagnostic.
1267 Source.done()
1268
1269 envList = []
1270
1271 # Debug binary
1272 if 'debug' in needed_envs:
1273 envList.append(
1274 makeEnv(env, 'debug', '.do',
1275 CCFLAGS = Split(ccflags['debug']),
1276 CPPDEFINES = ['DEBUG', 'TRACING_ON=1'],
1277 LINKFLAGS = Split(ldflags['debug'])))
1278
1279 # Optimized binary
1280 if 'opt' in needed_envs:
1281 envList.append(
1282 makeEnv(env, 'opt', '.o',
1283 CCFLAGS = Split(ccflags['opt']),
1284 CPPDEFINES = ['TRACING_ON=1'],
1285 LINKFLAGS = Split(ldflags['opt'])))
1286
1287 # "Fast" binary
1288 if 'fast' in needed_envs:
1289 envList.append(
1290 makeEnv(env, 'fast', '.fo', strip = True,
1291 CCFLAGS = Split(ccflags['fast']),
1292 CPPDEFINES = ['NDEBUG', 'TRACING_ON=0'],
1293 LINKFLAGS = Split(ldflags['fast'])))
1294
1295 # Profiled binary using gprof
1296 if 'prof' in needed_envs:
1297 envList.append(
1298 makeEnv(env, 'prof', '.po',
1299 CCFLAGS = Split(ccflags['prof']),
1300 CPPDEFINES = ['NDEBUG', 'TRACING_ON=0'],
1301 LINKFLAGS = Split(ldflags['prof'])))
1302
1303 # Profiled binary using google-pprof
1304 if 'perf' in needed_envs:
1305 envList.append(
1306 makeEnv(env, 'perf', '.gpo',
1307 CCFLAGS = Split(ccflags['perf']),
1308 CPPDEFINES = ['NDEBUG', 'TRACING_ON=0'],
1309 LINKFLAGS = Split(ldflags['perf'])))
1310
1311 # Set up the regression tests for each build.
1312 for e in envList:
1313 SConscript(os.path.join(env.root.abspath, 'tests', 'SConscript'),
1314 variant_dir = variantd('tests', e.Label),
1315 exports = { 'env' : e }, duplicate = False)
1316
1317# The MakeEnvirons Builder defers the full dependency collection until
1318# after processing the ISA definition (due to dynamically generated
1319# source files). Add this dependency to all targets so they will wait
1320# until the environments are completely set up. Otherwise, a second
1321# process (e.g. -j2 or higher) will try to compile the requested target,
1322# not know how, and fail.
1323env.Append(BUILDERS = {'MakeEnvirons' :
1324 Builder(action=MakeAction(makeEnvirons,
1325 Transform("ENVIRONS", 1)))})
1326
1327isa_target = env['PHONY_BASE'] + '-deps'
1328environs = env['PHONY_BASE'] + '-environs'
1329env.Depends('#all-deps', isa_target)
1330env.Depends('#all-environs', environs)
1331env.ScanISA(isa_target, File('arch/%s/generated/inc.d' % env['TARGET_ISA']))
1332envSetup = env.MakeEnvirons(environs, isa_target)
1333
1334# make sure no -deps targets occur before all ISAs are complete
1335env.Depends(isa_target, '#all-isas')
1336# likewise for -environs targets and all the -deps targets
1337env.Depends(environs, '#all-deps')
|