Make things compile in SE again.
[gem5.git] / SConstruct
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: Steve Reinhardt
30
31 ###################################################
32 #
33 # SCons top-level build description (SConstruct) file.
34 #
35 # While in this directory ('m5'), just type 'scons' to build the default
36 # configuration (see below), or type 'scons build/<CONFIG>/<binary>'
37 # to build some other configuration (e.g., 'build/ALPHA_FS/m5.opt' for
38 # the optimized full-system version).
39 #
40 # You can build M5 in a different directory as long as there is a
41 # 'build/<CONFIG>' somewhere along the target path. The build system
42 # expects that all configs under the same build directory are being
43 # built for the same host system.
44 #
45 # Examples:
46 #
47 # The following two commands are equivalent. The '-u' option tells
48 # scons to search up the directory tree for this SConstruct file.
49 # % cd <path-to-src>/m5 ; scons build/ALPHA_FS/m5.debug
50 # % cd <path-to-src>/m5/build/ALPHA_FS; scons -u m5.debug
51 #
52 # The following two commands are equivalent and demonstrate building
53 # in a directory outside of the source tree. The '-C' option tells
54 # scons to chdir to the specified directory to find this SConstruct
55 # file.
56 # % cd <path-to-src>/m5 ; scons /local/foo/build/ALPHA_FS/m5.debug
57 # % cd /local/foo/build/ALPHA_FS; scons -C <path-to-src>/m5 m5.debug
58 #
59 # You can use 'scons -H' to print scons options. If you're in this
60 # 'm5' directory (or use -u or -C to tell scons where to find this
61 # file), you can use 'scons -h' to print all the M5-specific build
62 # options as well.
63 #
64 ###################################################
65
66 # Python library imports
67 import sys
68 import os
69
70 # Check for recent-enough Python and SCons versions. If your system's
71 # default installation of Python is not recent enough, you can use a
72 # non-default installation of the Python interpreter by either (1)
73 # rearranging your PATH so that scons finds the non-default 'python'
74 # first or (2) explicitly invoking an alternative interpreter on the
75 # scons script, e.g., "/usr/local/bin/python2.4 `which scons` [args]".
76 EnsurePythonVersion(2,4)
77
78 # Ironically, SCons 0.96 dies if you give EnsureSconsVersion a
79 # 3-element version number.
80 min_scons_version = (0,96,91)
81 try:
82 EnsureSConsVersion(*min_scons_version)
83 except:
84 print "Error checking current SCons version."
85 print "SCons", ".".join(map(str,min_scons_version)), "or greater required."
86 Exit(2)
87
88
89 # The absolute path to the current directory (where this file lives).
90 ROOT = Dir('.').abspath
91
92 # Paths to the M5 and external source trees.
93 SRCDIR = os.path.join(ROOT, 'src')
94
95 # tell python where to find m5 python code
96 sys.path.append(os.path.join(ROOT, 'src/python'))
97
98 ###################################################
99 #
100 # Figure out which configurations to set up based on the path(s) of
101 # the target(s).
102 #
103 ###################################################
104
105 # Find default configuration & binary.
106 Default(os.environ.get('M5_DEFAULT_BINARY', 'build/ALPHA_SE/m5.debug'))
107
108 # Ask SCons which directory it was invoked from.
109 launch_dir = GetLaunchDir()
110
111 # Make targets relative to invocation directory
112 abs_targets = map(lambda x: os.path.normpath(os.path.join(launch_dir, str(x))),
113 BUILD_TARGETS)
114
115 # helper function: find last occurrence of element in list
116 def rfind(l, elt, offs = -1):
117 for i in range(len(l)+offs, 0, -1):
118 if l[i] == elt:
119 return i
120 raise ValueError, "element not found"
121
122 # helper function: compare dotted version numbers.
123 # E.g., compare_version('1.3.25', '1.4.1')
124 # returns -1, 0, 1 if v1 is <, ==, > v2
125 def compare_versions(v1, v2):
126 # Convert dotted strings to lists
127 v1 = map(int, v1.split('.'))
128 v2 = map(int, v2.split('.'))
129 # Compare corresponding elements of lists
130 for n1,n2 in zip(v1, v2):
131 if n1 < n2: return -1
132 if n1 > n2: return 1
133 # all corresponding values are equal... see if one has extra values
134 if len(v1) < len(v2): return -1
135 if len(v1) > len(v2): return 1
136 return 0
137
138 # Each target must have 'build' in the interior of the path; the
139 # directory below this will determine the build parameters. For
140 # example, for target 'foo/bar/build/ALPHA_SE/arch/alpha/blah.do' we
141 # recognize that ALPHA_SE specifies the configuration because it
142 # follow 'build' in the bulid path.
143
144 # Generate a list of the unique build roots and configs that the
145 # collected targets reference.
146 build_paths = []
147 build_root = None
148 for t in abs_targets:
149 path_dirs = t.split('/')
150 try:
151 build_top = rfind(path_dirs, 'build', -2)
152 except:
153 print "Error: no non-leaf 'build' dir found on target path", t
154 Exit(1)
155 this_build_root = os.path.join('/',*path_dirs[:build_top+1])
156 if not build_root:
157 build_root = this_build_root
158 else:
159 if this_build_root != build_root:
160 print "Error: build targets not under same build root\n"\
161 " %s\n %s" % (build_root, this_build_root)
162 Exit(1)
163 build_path = os.path.join('/',*path_dirs[:build_top+2])
164 if build_path not in build_paths:
165 build_paths.append(build_path)
166
167 ###################################################
168 #
169 # Set up the default build environment. This environment is copied
170 # and modified according to each selected configuration.
171 #
172 ###################################################
173
174 env = Environment(ENV = os.environ, # inherit user's environment vars
175 ROOT = ROOT,
176 SRCDIR = SRCDIR)
177
178 env.SConsignFile(os.path.join(build_root,"sconsign"))
179
180 # Default duplicate option is to use hard links, but this messes up
181 # when you use emacs to edit a file in the target dir, as emacs moves
182 # file to file~ then copies to file, breaking the link. Symbolic
183 # (soft) links work better.
184 env.SetOption('duplicate', 'soft-copy')
185
186 # I waffle on this setting... it does avoid a few painful but
187 # unnecessary builds, but it also seems to make trivial builds take
188 # noticeably longer.
189 if False:
190 env.TargetSignatures('content')
191
192 # M5_PLY is used by isa_parser.py to find the PLY package.
193 env.Append(ENV = { 'M5_PLY' : Dir('ext/ply') })
194
195 # Set up default C++ compiler flags
196 env.Append(CCFLAGS='-pipe')
197 env.Append(CCFLAGS='-fno-strict-aliasing')
198 env.Append(CCFLAGS=Split('-Wall -Wno-sign-compare -Werror -Wundef'))
199 if sys.platform == 'cygwin':
200 # cygwin has some header file issues...
201 env.Append(CCFLAGS=Split("-Wno-uninitialized"))
202 env.Append(CPPPATH=[Dir('ext/dnet')])
203
204 # Check for SWIG
205 if not env.has_key('SWIG'):
206 print 'Error: SWIG utility not found.'
207 print ' Please install (see http://www.swig.org) and retry.'
208 Exit(1)
209
210 # Check for appropriate SWIG version
211 swig_version = os.popen('swig -version').read().split()
212 # First 3 words should be "SWIG Version x.y.z"
213 if swig_version[0] != 'SWIG' or swig_version[1] != 'Version':
214 print 'Error determining SWIG version.'
215 Exit(1)
216
217 min_swig_version = '1.3.28'
218 if compare_versions(swig_version[2], min_swig_version) < 0:
219 print 'Error: SWIG version', min_swig_version, 'or newer required.'
220 print ' Installed version:', swig_version[2]
221 Exit(1)
222
223 # Set up SWIG flags & scanner
224 env.Append(SWIGFLAGS=Split('-c++ -python -modern $_CPPINCFLAGS'))
225
226 import SCons.Scanner
227
228 swig_inc_re = '^[ \t]*[%,#][ \t]*(?:include|import)[ \t]*(<|")([^>"]+)(>|")'
229
230 swig_scanner = SCons.Scanner.ClassicCPP("SwigScan", ".i", "CPPPATH",
231 swig_inc_re)
232
233 env.Append(SCANNERS = swig_scanner)
234
235 # Platform-specific configuration. Note again that we assume that all
236 # builds under a given build root run on the same host platform.
237 conf = Configure(env,
238 conf_dir = os.path.join(build_root, '.scons_config'),
239 log_file = os.path.join(build_root, 'scons_config.log'))
240
241 # Find Python include and library directories for embedding the
242 # interpreter. For consistency, we will use the same Python
243 # installation used to run scons (and thus this script). If you want
244 # to link in an alternate version, see above for instructions on how
245 # to invoke scons with a different copy of the Python interpreter.
246
247 # Get brief Python version name (e.g., "python2.4") for locating
248 # include & library files
249 py_version_name = 'python' + sys.version[:3]
250
251 # include path, e.g. /usr/local/include/python2.4
252 py_header_path = os.path.join(sys.exec_prefix, 'include', py_version_name)
253 env.Append(CPPPATH = py_header_path)
254 # verify that it works
255 if not conf.CheckHeader('Python.h', '<>'):
256 print "Error: can't find Python.h header in", py_header_path
257 Exit(1)
258
259 # add library path too if it's not in the default place
260 py_lib_path = None
261 if sys.exec_prefix != '/usr':
262 py_lib_path = os.path.join(sys.exec_prefix, 'lib')
263 elif sys.platform == 'cygwin':
264 # cygwin puts the .dll in /bin for some reason
265 py_lib_path = '/bin'
266 if py_lib_path:
267 env.Append(LIBPATH = py_lib_path)
268 print 'Adding', py_lib_path, 'to LIBPATH for', py_version_name
269 if not conf.CheckLib(py_version_name):
270 print "Error: can't find Python library", py_version_name
271 Exit(1)
272
273 # Check for zlib. If the check passes, libz will be automatically
274 # added to the LIBS environment variable.
275 if not conf.CheckLibWithHeader('z', 'zlib.h', 'C++'):
276 print 'Error: did not find needed zlib compression library '\
277 'and/or zlib.h header file.'
278 print ' Please install zlib and try again.'
279 Exit(1)
280
281 # Check for <fenv.h> (C99 FP environment control)
282 have_fenv = conf.CheckHeader('fenv.h', '<>')
283 if not have_fenv:
284 print "Warning: Header file <fenv.h> not found."
285 print " This host has no IEEE FP rounding mode control."
286
287 # Check for mysql.
288 mysql_config = WhereIs('mysql_config')
289 have_mysql = mysql_config != None
290
291 # Check MySQL version.
292 if have_mysql:
293 mysql_version = os.popen(mysql_config + ' --version').read()
294 min_mysql_version = '4.1'
295 if compare_versions(mysql_version, min_mysql_version) < 0:
296 print 'Warning: MySQL', min_mysql_version, 'or newer required.'
297 print ' Version', mysql_version, 'detected.'
298 have_mysql = False
299
300 # Set up mysql_config commands.
301 if have_mysql:
302 mysql_config_include = mysql_config + ' --include'
303 if os.system(mysql_config_include + ' > /dev/null') != 0:
304 # older mysql_config versions don't support --include, use
305 # --cflags instead
306 mysql_config_include = mysql_config + ' --cflags | sed s/\\\'//g'
307 # This seems to work in all versions
308 mysql_config_libs = mysql_config + ' --libs'
309
310 env = conf.Finish()
311
312 # Define the universe of supported ISAs
313 env['ALL_ISA_LIST'] = ['alpha', 'sparc', 'mips']
314
315 # Define the universe of supported CPU models
316 env['ALL_CPU_LIST'] = ['AtomicSimpleCPU', 'TimingSimpleCPU',
317 'FullCPU', 'O3CPU',
318 'OzoneCPU']
319
320 # Sticky options get saved in the options file so they persist from
321 # one invocation to the next (unless overridden, in which case the new
322 # value becomes sticky).
323 sticky_opts = Options(args=ARGUMENTS)
324 sticky_opts.AddOptions(
325 EnumOption('TARGET_ISA', 'Target ISA', 'alpha', env['ALL_ISA_LIST']),
326 BoolOption('FULL_SYSTEM', 'Full-system support', False),
327 # There's a bug in scons 0.96.1 that causes ListOptions with list
328 # values (more than one value) not to be able to be restored from
329 # a saved option file. If this causes trouble then upgrade to
330 # scons 0.96.90 or later.
331 ListOption('CPU_MODELS', 'CPU models', 'AtomicSimpleCPU,TimingSimpleCPU',
332 env['ALL_CPU_LIST']),
333 BoolOption('ALPHA_TLASER',
334 'Model Alpha TurboLaser platform (vs. Tsunami)', False),
335 BoolOption('NO_FAST_ALLOC', 'Disable fast object allocator', False),
336 BoolOption('EFENCE', 'Link with Electric Fence malloc debugger',
337 False),
338 BoolOption('SS_COMPATIBLE_FP',
339 'Make floating-point results compatible with SimpleScalar',
340 False),
341 BoolOption('USE_SSE2',
342 'Compile for SSE2 (-msse2) to get IEEE FP on x86 hosts',
343 False),
344 BoolOption('USE_MYSQL', 'Use MySQL for stats output', have_mysql),
345 BoolOption('USE_FENV', 'Use <fenv.h> IEEE mode control', have_fenv),
346 BoolOption('USE_CHECKER', 'Use checker for detailed CPU models', False),
347 ('CC', 'C compiler', os.environ.get('CC', env['CC'])),
348 ('CXX', 'C++ compiler', os.environ.get('CXX', env['CXX'])),
349 BoolOption('BATCH', 'Use batch pool for build and tests', False),
350 ('BATCH_CMD', 'Batch pool submission command name', 'qdo'),
351 ('PYTHONHOME',
352 'Override the default PYTHONHOME for this system (use with caution)',
353 '%s:%s' % (sys.prefix, sys.exec_prefix))
354 )
355
356 # Non-sticky options only apply to the current build.
357 nonsticky_opts = Options(args=ARGUMENTS)
358 nonsticky_opts.AddOptions(
359 BoolOption('update_ref', 'Update test reference outputs', False)
360 )
361
362 # These options get exported to #defines in config/*.hh (see src/SConscript).
363 env.ExportOptions = ['FULL_SYSTEM', 'ALPHA_TLASER', 'USE_FENV', \
364 'USE_MYSQL', 'NO_FAST_ALLOC', 'SS_COMPATIBLE_FP', \
365 'USE_CHECKER', 'PYTHONHOME']
366
367 # Define a handy 'no-op' action
368 def no_action(target, source, env):
369 return 0
370
371 env.NoAction = Action(no_action, None)
372
373 ###################################################
374 #
375 # Define a SCons builder for configuration flag headers.
376 #
377 ###################################################
378
379 # This function generates a config header file that #defines the
380 # option symbol to the current option setting (0 or 1). The source
381 # operands are the name of the option and a Value node containing the
382 # value of the option.
383 def build_config_file(target, source, env):
384 (option, value) = [s.get_contents() for s in source]
385 f = file(str(target[0]), 'w')
386 print >> f, '#define', option, value
387 f.close()
388 return None
389
390 # Generate the message to be printed when building the config file.
391 def build_config_file_string(target, source, env):
392 (option, value) = [s.get_contents() for s in source]
393 return "Defining %s as %s in %s." % (option, value, target[0])
394
395 # Combine the two functions into a scons Action object.
396 config_action = Action(build_config_file, build_config_file_string)
397
398 # The emitter munges the source & target node lists to reflect what
399 # we're really doing.
400 def config_emitter(target, source, env):
401 # extract option name from Builder arg
402 option = str(target[0])
403 # True target is config header file
404 target = os.path.join('config', option.lower() + '.hh')
405 val = env[option]
406 if isinstance(val, bool):
407 # Force value to 0/1
408 val = int(val)
409 elif isinstance(val, str):
410 val = '"' + val + '"'
411
412 # Sources are option name & value (packaged in SCons Value nodes)
413 return ([target], [Value(option), Value(val)])
414
415 config_builder = Builder(emitter = config_emitter, action = config_action)
416
417 env.Append(BUILDERS = { 'ConfigFile' : config_builder })
418
419 ###################################################
420 #
421 # Define a SCons builder for copying files. This is used by the
422 # Python zipfile code in src/python/SConscript, but is placed up here
423 # since it's potentially more generally applicable.
424 #
425 ###################################################
426
427 copy_builder = Builder(action = Copy("$TARGET", "$SOURCE"))
428
429 env.Append(BUILDERS = { 'CopyFile' : copy_builder })
430
431 ###################################################
432 #
433 # Define a simple SCons builder to concatenate files.
434 #
435 # Used to append the Python zip archive to the executable.
436 #
437 ###################################################
438
439 concat_builder = Builder(action = Action(['cat $SOURCES > $TARGET',
440 'chmod +x $TARGET']))
441
442 env.Append(BUILDERS = { 'Concat' : concat_builder })
443
444
445 # base help text
446 help_text = '''
447 Usage: scons [scons options] [build options] [target(s)]
448
449 '''
450
451 # libelf build is shared across all configs in the build root.
452 env.SConscript('ext/libelf/SConscript',
453 build_dir = os.path.join(build_root, 'libelf'),
454 exports = 'env')
455
456 ###################################################
457 #
458 # Define build environments for selected configurations.
459 #
460 ###################################################
461
462 # rename base env
463 base_env = env
464
465 for build_path in build_paths:
466 print "Building in", build_path
467 # build_dir is the tail component of build path, and is used to
468 # determine the build parameters (e.g., 'ALPHA_SE')
469 (build_root, build_dir) = os.path.split(build_path)
470 # Make a copy of the build-root environment to use for this config.
471 env = base_env.Copy()
472
473 # Set env options according to the build directory config.
474 sticky_opts.files = []
475 # Options for $BUILD_ROOT/$BUILD_DIR are stored in
476 # $BUILD_ROOT/options/$BUILD_DIR so you can nuke
477 # $BUILD_ROOT/$BUILD_DIR without losing your options settings.
478 current_opts_file = os.path.join(build_root, 'options', build_dir)
479 if os.path.isfile(current_opts_file):
480 sticky_opts.files.append(current_opts_file)
481 print "Using saved options file %s" % current_opts_file
482 else:
483 # Build dir-specific options file doesn't exist.
484
485 # Make sure the directory is there so we can create it later
486 opt_dir = os.path.dirname(current_opts_file)
487 if not os.path.isdir(opt_dir):
488 os.mkdir(opt_dir)
489
490 # Get default build options from source tree. Options are
491 # normally determined by name of $BUILD_DIR, but can be
492 # overriden by 'default=' arg on command line.
493 default_opts_file = os.path.join('build_opts',
494 ARGUMENTS.get('default', build_dir))
495 if os.path.isfile(default_opts_file):
496 sticky_opts.files.append(default_opts_file)
497 print "Options file %s not found,\n using defaults in %s" \
498 % (current_opts_file, default_opts_file)
499 else:
500 print "Error: cannot find options file %s or %s" \
501 % (current_opts_file, default_opts_file)
502 Exit(1)
503
504 # Apply current option settings to env
505 sticky_opts.Update(env)
506 nonsticky_opts.Update(env)
507
508 help_text += "Sticky options for %s:\n" % build_dir \
509 + sticky_opts.GenerateHelpText(env) \
510 + "\nNon-sticky options for %s:\n" % build_dir \
511 + nonsticky_opts.GenerateHelpText(env)
512
513 # Process option settings.
514
515 if not have_fenv and env['USE_FENV']:
516 print "Warning: <fenv.h> not available; " \
517 "forcing USE_FENV to False in", build_dir + "."
518 env['USE_FENV'] = False
519
520 if not env['USE_FENV']:
521 print "Warning: No IEEE FP rounding mode control in", build_dir + "."
522 print " FP results may deviate slightly from other platforms."
523
524 if env['EFENCE']:
525 env.Append(LIBS=['efence'])
526
527 if env['USE_MYSQL']:
528 if not have_mysql:
529 print "Warning: MySQL not available; " \
530 "forcing USE_MYSQL to False in", build_dir + "."
531 env['USE_MYSQL'] = False
532 else:
533 print "Compiling in", build_dir, "with MySQL support."
534 env.ParseConfig(mysql_config_libs)
535 env.ParseConfig(mysql_config_include)
536
537 # Save sticky option settings back to current options file
538 sticky_opts.Save(current_opts_file, env)
539
540 # Do this after we save setting back, or else we'll tack on an
541 # extra 'qdo' every time we run scons.
542 if env['BATCH']:
543 env['CC'] = env['BATCH_CMD'] + ' ' + env['CC']
544 env['CXX'] = env['BATCH_CMD'] + ' ' + env['CXX']
545
546 if env['USE_SSE2']:
547 env.Append(CCFLAGS='-msse2')
548
549 # The src/SConscript file sets up the build rules in 'env' according
550 # to the configured options. It returns a list of environments,
551 # one for each variant build (debug, opt, etc.)
552 envList = SConscript('src/SConscript', build_dir = build_path,
553 exports = 'env')
554
555 # Set up the regression tests for each build.
556 for e in envList:
557 SConscript('tests/SConscript',
558 build_dir = os.path.join(build_path, 'tests', e.Label),
559 exports = { 'env' : e }, duplicate = False)
560
561 Help(help_text)
562
563 ###################################################
564 #
565 # Let SCons do its thing. At this point SCons will use the defined
566 # build environments to build the requested targets.
567 #
568 ###################################################
569