3 Frontend-tool for Gallium3D architecture.
8 # Copyright 2008 VMware, Inc.
11 # Permission is hereby granted, free of charge, to any person obtaining a
12 # copy of this software and associated documentation files (the
13 # "Software"), to deal in the Software without restriction, including
14 # without limitation the rights to use, copy, modify, merge, publish,
15 # distribute, sub license, and/or sell copies of the Software, and to
16 # permit persons to whom the Software is furnished to do so, subject to
17 # the following conditions:
19 # The above copyright notice and this permission notice (including the
20 # next paragraph) shall be included in all copies or substantial portions
23 # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
24 # OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
25 # MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT.
26 # IN NO EVENT SHALL VMWARE AND/OR ITS SUPPLIERS BE LIABLE FOR
27 # ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
28 # TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
29 # SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
33 import distutils.version
38 import platform as host_platform
47 def symlink(target, source, env):
48 target = str(target[0])
49 source = str(source[0])
50 if os.path.islink(target) or os.path.exists(target):
52 os.symlink(os.path.basename(source), target)
54 def install(env, source, subdir):
55 target_dir = os.path.join(env.Dir('#.').srcnode().abspath, env['build_dir'], subdir)
56 return env.Install(target_dir, source)
58 def install_program(env, source):
59 return install(env, source, 'bin')
61 def install_shared_library(env, sources, version = ()):
63 install_dir = os.path.join(env.Dir('#.').srcnode().abspath, env['build_dir'])
64 version = tuple(map(str, version))
65 if env['SHLIBSUFFIX'] == '.dll':
66 dlls = env.FindIxes(sources, 'SHLIBPREFIX', 'SHLIBSUFFIX')
67 targets += install(env, dlls, 'bin')
68 libs = env.FindIxes(sources, 'LIBPREFIX', 'LIBSUFFIX')
69 targets += install(env, libs, 'lib')
71 for source in sources:
72 target_dir = os.path.join(install_dir, 'lib')
73 target_name = '.'.join((str(source),) + version)
74 last = env.InstallAs(os.path.join(target_dir, target_name), source)
77 version = version[:-1]
78 target_name = '.'.join((str(source),) + version)
79 action = SCons.Action.Action(symlink, " Symlinking $TARGET ...")
80 last = env.Command(os.path.join(target_dir, target_name), last, action)
85 def msvc2013_compat(env):
87 env.Append(CCFLAGS = [
89 '-Werror=pointer-arith',
93 def unit_test(env, test_name, program_target, args=None):
94 env.InstallProgram(program_target)
96 cmd = [program_target[0].abspath]
101 # http://www.scons.org/wiki/UnitTests
102 action = SCons.Action.Action(cmd, " Running $SOURCE ...")
103 alias = env.Alias(test_name, program_target, action)
104 env.AlwaysBuild(alias)
105 env.Depends('check', alias)
110 return int(os.environ['NUMBER_OF_PROCESSORS'])
111 except (ValueError, KeyError):
115 return os.sysconf('SC_NPROCESSORS_ONLN')
116 except (ValueError, OSError, AttributeError):
120 return int(os.popen2("sysctl -n hw.ncpu")[1].read())
127 def check_cc(env, cc, expr, cpp_opt = '-E'):
128 # Invoke C-preprocessor to determine whether the specified expression is
131 sys.stdout.write('Checking for %s ... ' % cc)
133 source = tempfile.NamedTemporaryFile(suffix='.c', delete=False)
134 source.write('#if !(%s)\n#error\n#endif\n' % expr)
137 # sys.stderr.write('%r %s %s\n' % (env['CC'], cpp_opt, source.name));
139 pipe = SCons.Action._subproc(env, env.Split(env['CC']) + [cpp_opt, source.name],
143 result = pipe.wait() == 0
145 os.unlink(source.name)
147 sys.stdout.write(' %s\n' % ['no', 'yes'][int(bool(result))])
150 def check_header(env, header):
151 '''Check if the header exist'''
153 conf = SCons.Script.Configure(env)
156 if conf.CheckHeader(header):
162 def check_functions(env, functions):
163 '''Check if all of the functions exist'''
165 conf = SCons.Script.Configure(env)
166 have_functions = True
168 for function in functions:
169 if not conf.CheckFunc(function):
170 have_functions = False
173 return have_functions
175 def check_prog(env, prog):
176 """Check whether this program exists."""
178 sys.stdout.write('Checking for %s ... ' % prog)
180 result = env.Detect(prog)
182 sys.stdout.write(' %s\n' % ['no', 'yes'][int(bool(result))])
187 """Common environment generation code"""
189 # Tell tools which machine to compile for
190 env['TARGET_ARCH'] = env['machine']
191 env['MSVS_ARCH'] = env['machine']
194 platform = env['platform']
195 env.Tool(env['toolchain'])
197 # Allow override compiler and specify additional flags from environment
198 if 'CC' in os.environ:
199 env['CC'] = os.environ['CC']
200 if 'CFLAGS' in os.environ:
201 env['CCFLAGS'] += SCons.Util.CLVar(os.environ['CFLAGS'])
202 if 'CXX' in os.environ:
203 env['CXX'] = os.environ['CXX']
204 if 'CXXFLAGS' in os.environ:
205 env['CXXFLAGS'] += SCons.Util.CLVar(os.environ['CXXFLAGS'])
206 if 'LDFLAGS' in os.environ:
207 env['LINKFLAGS'] += SCons.Util.CLVar(os.environ['LDFLAGS'])
209 # Detect gcc/clang not by executable name, but through pre-defined macros
210 # as autoconf does, to avoid drawing wrong conclusions when using tools
211 # that overrice CC/CXX like scan-build.
212 env['gcc_compat'] = 0
215 if host_platform.system() == 'Windows':
216 env['msvc'] = check_cc(env, 'MSVC', 'defined(_MSC_VER)', '/E')
218 env['gcc_compat'] = check_cc(env, 'GCC', 'defined(__GNUC__)')
219 env['clang'] = check_cc(env, 'Clang', '__clang__')
220 env['gcc'] = env['gcc_compat'] and not env['clang']
221 env['suncc'] = env['platform'] == 'sunos' and os.path.basename(env['CC']) == 'cc'
222 env['icc'] = 'icc' == os.path.basename(env['CC'])
224 if env['msvc'] and env['toolchain'] == 'default' and env['machine'] == 'x86_64':
225 # MSVC x64 support is broken in earlier versions of scons
226 env.EnsurePythonVersion(2, 0)
229 machine = env['machine']
230 platform = env['platform']
231 x86 = env['machine'] == 'x86'
232 ppc = env['machine'] == 'ppc'
233 gcc_compat = env['gcc_compat']
238 # Determine whether we are cross compiling; in particular, whether we need
239 # to compile code generators with a different compiler as the target code.
240 hosthost_platform = host_platform.system().lower()
241 if hosthost_platform.startswith('cygwin'):
242 hosthost_platform = 'cygwin'
243 host_machine = os.environ.get('PROCESSOR_ARCHITEW6432', os.environ.get('PROCESSOR_ARCHITECTURE', host_platform.machine()))
253 }.get(host_machine, 'generic')
254 env['crosscompile'] = platform != hosthost_platform
255 if machine == 'x86_64' and host_machine != 'x86_64':
256 env['crosscompile'] = True
257 env['hostonly'] = False
259 # Backwards compatability with the debug= profile= options
260 if env['build'] == 'debug':
262 print('scons: warning: debug option is deprecated and will be removed eventually; use instead')
264 print(' scons build=release')
266 env['build'] = 'release'
268 print('scons: warning: profile option is deprecated and will be removed eventually; use instead')
270 print(' scons build=profile')
272 env['build'] = 'profile'
274 # Enforce SConscripts to use the new build variable
276 env.popitem('profile')
278 # Backwards portability with older sconscripts
279 if env['build'] in ('debug', 'checked'):
281 env['profile'] = False
282 if env['build'] == 'profile':
284 env['profile'] = True
285 if env['build'] in ('release', 'opt'):
287 env['profile'] = False
289 # Put build output in a separate dir, which depends on the current
290 # configuration. See also http://www.scons.org/wiki/AdvancedBuildExample
291 build_topdir = 'build'
292 build_subdir = env['platform']
294 build_subdir = 'embedded-' + build_subdir
295 if env['machine'] != 'generic':
296 build_subdir += '-' + env['machine']
297 if env['build'] != 'release':
298 build_subdir += '-' + env['build']
299 build_dir = os.path.join(build_topdir, build_subdir)
300 # Place the .sconsign file in the build dir too, to avoid issues with
301 # different scons versions building the same source file
302 env['build_dir'] = build_dir
303 env.SConsignFile(os.path.join(build_dir, '.sconsign'))
304 if 'SCONS_CACHE_DIR' in os.environ:
305 print('scons: Using build cache in %s.' % (os.environ['SCONS_CACHE_DIR'],))
306 env.CacheDir(os.environ['SCONS_CACHE_DIR'])
307 env['CONFIGUREDIR'] = os.path.join(build_dir, 'conf')
308 env['CONFIGURELOG'] = os.path.join(os.path.abspath(build_dir), 'config.log')
311 if env.GetOption('num_jobs') <= 1:
312 env.SetOption('num_jobs', num_jobs())
314 env.Decider('MD5-timestamp')
315 env.SetOption('max_drift', 60)
317 # C preprocessor options
320 '__STDC_CONSTANT_MACROS',
321 '__STDC_FORMAT_MACROS',
322 '__STDC_LIMIT_MACROS',
325 if env['build'] in ('debug', 'checked'):
326 cppdefines += ['DEBUG']
328 cppdefines += ['NDEBUG']
329 if env['build'] == 'profile':
330 cppdefines += ['PROFILE']
331 if env['build'] in ('opt', 'profile'):
332 cppdefines += ['VMX86_STATS']
333 if env['platform'] in ('posix', 'linux', 'freebsd', 'darwin'):
336 ('_POSIX_C_SOURCE', '199309L'),
342 if env['platform'] == 'darwin':
346 'GLX_DIRECT_RENDERING',
350 'GLX_DIRECT_RENDERING',
351 'GLX_INDIRECT_RENDERING',
354 if check_header(env, 'xlocale.h'):
355 cppdefines += ['HAVE_XLOCALE_H']
357 if check_header(env, 'endian.h'):
358 cppdefines += ['HAVE_ENDIAN_H']
360 if check_functions(env, ['strtod_l', 'strtof_l']):
361 cppdefines += ['HAVE_STRTOD_L']
363 if check_functions(env, ['timespec_get']):
364 cppdefines += ['HAVE_TIMESPEC_GET']
366 if platform == 'windows':
372 # http://msdn.microsoft.com/en-us/library/aa383745.aspx
373 ('_WIN32_WINNT', '0x0601'),
374 ('WINVER', '0x0601'),
377 cppdefines += [('__MSVCRT_VERSION__', '0x0700')]
382 '_CRT_SECURE_NO_WARNINGS',
383 '_CRT_SECURE_NO_DEPRECATE',
384 '_SCL_SECURE_NO_WARNINGS',
385 '_SCL_SECURE_NO_DEPRECATE',
386 '_ALLOW_KEYWORD_MACROS',
387 '_HAS_EXCEPTIONS=0', # Tell C++ STL to not use exceptions
389 if env['build'] in ('debug', 'checked'):
390 cppdefines += ['_DEBUG']
391 if platform == 'windows':
392 cppdefines += ['PIPE_SUBSYSTEM_WINDOWS_USER']
394 cppdefines += ['PIPE_SUBSYSTEM_EMBEDDED']
395 env.Append(CPPDEFINES = cppdefines)
400 ccflags = [] # C & C++
402 if env['build'] == 'debug':
407 # gcc's builtin memcmp is slower than glibc's
408 # http://gcc.gnu.org/bugzilla/show_bug.cgi?id=43052
409 ccflags += ['-fno-builtin-memcmp']
410 # Work around aliasing bugs - developers should comment this out
411 ccflags += ['-fno-strict-aliasing']
413 if env['build'] in ('checked', 'profile') or env['asan']:
414 # See http://code.google.com/p/jrfonseca/wiki/Gprof2Dot#Which_options_should_I_pass_to_gcc_when_compiling_for_profiling?
416 '-fno-omit-frame-pointer',
419 ccflags += ['-fno-optimize-sibling-calls']
420 if env['machine'] == 'x86':
425 if platform != 'haiku':
426 # NOTE: We need to ensure stack is realigned given that we
427 # produce shared objects, and have no control over the stack
428 # alignment policy of the application. Therefore we need
429 # -mstackrealign ore -mincoming-stack-boundary=2.
431 # XXX: We could have SSE without -mstackrealign if we always used
432 # __attribute__((force_align_arg_pointer)), but that's not
435 '-mstackrealign', # ensure stack is aligned
436 '-msse', '-msse2', # enable SIMD intrinsics
437 '-mfpmath=sse', # generate SSE floating-point arithmetic
439 if platform in ['windows', 'darwin']:
440 # Workaround http://gcc.gnu.org/bugzilla/show_bug.cgi?id=37216
441 ccflags += ['-fno-common']
442 if platform in ['haiku']:
443 # Make optimizations compatible with Pentium or higher on Haiku
445 '-mstackrealign', # ensure stack is aligned
446 '-march=i586', # Haiku target is Pentium
447 '-mtune=i686' # use i686 where we can
449 if env['machine'] == 'x86_64':
451 if platform == 'darwin':
452 ccflags += ['-fno-common']
453 if env['platform'] not in ('cygwin', 'haiku', 'windows'):
454 ccflags += ['-fvisibility=hidden']
456 # - http://gcc.gnu.org/onlinedocs/gcc/Warning-Options.html
460 '-fmessage-length=0', # be nice to Eclipse
463 '-Wmissing-prototypes',
472 # - http://msdn.microsoft.com/en-us/library/19z1t1wy.aspx
474 if env['build'] == 'debug':
476 '/Od', # disable optimizations
477 '/Oi', # enable intrinsic functions
481 '/O2', # optimize for speed
483 if env['build'] in ('release', 'opt'):
486 '/GL', # enable whole program optimization
490 '/Oy-', # disable frame pointer omission
493 '/W3', # warning level
494 '/wd4018', # signed/unsigned mismatch
495 '/wd4056', # overflow in floating-point constant arithmetic
496 '/wd4244', # conversion from 'type1' to 'type2', possible loss of data
497 '/wd4267', # 'var' : conversion from 'size_t' to 'type', possible loss of data
498 '/wd4305', # truncation from 'type1' to 'type2'
499 '/wd4351', # new behavior: elements of array 'array' will be default initialized
500 '/wd4756', # overflow in constant arithmetic
501 '/wd4800', # forcing value to bool 'true' or 'false' (performance warning)
502 '/wd4996', # disable deprecated POSIX name warnings
506 '-Wno-microsoft-enum-value', # enumerator value is not representable in underlying type 'int'
508 if env['machine'] == 'x86':
510 '/arch:SSE2', # use the SSE2 instructions (default since MSVC 2012)
512 if platform == 'windows':
516 # Automatic pdb generation
517 # See http://scons.tigris.org/issues/show_bug.cgi?id=1656
518 env.EnsureSConsVersion(0, 98, 0)
519 env['PDB'] = '${TARGET.base}.pdb'
520 env.Append(CCFLAGS = ccflags)
521 env.Append(CFLAGS = cflags)
522 env.Append(CXXFLAGS = cxxflags)
524 if env['platform'] == 'windows' and msvc:
525 # Choose the appropriate MSVC CRT
526 # http://msdn.microsoft.com/en-us/library/2kzt1wy3.aspx
527 if env['build'] in ('debug', 'checked'):
528 env.Append(CCFLAGS = ['/MTd'])
529 env.Append(SHCCFLAGS = ['/LDd'])
531 env.Append(CCFLAGS = ['/MT'])
532 env.Append(SHCCFLAGS = ['/LD'])
534 # Static code analysis
537 # http://msdn.microsoft.com/en-us/library/ms173498.aspx
538 env.Append(CCFLAGS = [
540 #'/analyze:log', '${TARGET.base}.xml',
541 '/wd28251', # Inconsistent annotation for function
544 # scan-build will produce more comprehensive output
545 env.Append(CCFLAGS = ['--analyze'])
547 # https://github.com/google/sanitizers/wiki/AddressSanitizer
550 env.Append(CCFLAGS = [
551 '-fsanitize=address',
553 env.Append(LINKFLAGS = [
554 '-fsanitize=address',
559 if env['machine'] == 'x86':
560 env.Append(ASFLAGS = ['-m32'])
561 if env['machine'] == 'x86_64':
562 env.Append(ASFLAGS = ['-m64'])
568 if env['machine'] == 'x86':
569 linkflags += ['-m32']
570 if env['machine'] == 'x86_64':
571 linkflags += ['-m64']
572 if env['platform'] not in ('darwin'):
576 # Handle circular dependencies in the libraries
577 if env['platform'] in ('darwin'):
580 env['_LIBFLAGS'] = '-Wl,--start-group ' + env['_LIBFLAGS'] + ' -Wl,--end-group'
581 if env['platform'] == 'windows':
583 '-Wl,--nxcompat', # DEP
584 '-Wl,--dynamicbase', # ASLR
586 # Avoid depending on gcc runtime DLLs
587 linkflags += ['-static-libgcc']
588 if 'w64' in env['CC'].split('-'):
589 linkflags += ['-static-libstdc++']
590 # Handle the @xx symbol munging of DLL exports
591 shlinkflags += ['-Wl,--enable-stdcall-fixup']
592 #shlinkflags += ['-Wl,--kill-at']
594 if env['build'] in ('release', 'opt') and not env['clang']:
595 # enable Link-time Code Generation
596 linkflags += ['/LTCG']
597 env.Append(ARFLAGS = ['/LTCG'])
598 if platform == 'windows' and msvc:
600 # - http://msdn2.microsoft.com/en-us/library/y0zzbyt4.aspx
604 '/dynamicbase', # ASLR
607 env.Append(LINKFLAGS = linkflags)
608 env.Append(SHLINKFLAGS = shlinkflags)
610 # We have C++ in several libraries, so always link with the C++ compiler
612 env['LINK'] = env['CXX']
616 if env['platform'] in ('darwin', 'freebsd', 'linux', 'posix', 'sunos'):
617 libs += ['m', 'pthread', 'dl']
618 if env['platform'] in ('linux',):
620 if env['platform'] in ('haiku'):
621 libs += ['root', 'be', 'network', 'translation']
622 env.Append(LIBS = libs)
627 env.Append(CCFLAGS = ['/openmp'])
628 # When building openmp release VS2008 link.exe crashes with LNK1103 error.
629 # Workaround: overwrite PDB flags with empty value as it isn't required anyways
630 if env['build'] == 'release':
633 env.Append(CCFLAGS = ['-fopenmp'])
634 env.Append(LIBS = ['gomp'])
639 env.Append(LEXFLAGS = [
640 # Force flex to use const keyword in prototypes, as relies on
641 # __cplusplus or __STDC__ macro to determine whether it's safe to
642 # use const keyword, but MSVC never defines __STDC__ unless we
643 # disable all MSVC extensions.
646 # Flex relies on __STDC_VERSION__>=199901L to decide when to include
647 # C99 inttypes.h. We always have inttypes.h available with MSVC
648 # (either the one bundled with MSVC 2013, or the one we bundle
649 # ourselves), but we can't just define __STDC_VERSION__ without
650 # breaking stuff, as MSVC doesn't fully support C99. There's also no
651 # way to premptively include stdint.
652 env.Append(CCFLAGS = ['-FIinttypes.h'])
653 if host_platform.system() == 'Windows':
654 # Prefer winflexbison binaries, as not only they are easier to install
655 # (no additional dependencies), but also better Windows support.
656 if check_prog(env, 'win_flex'):
657 env["LEX"] = 'win_flex'
658 env.Append(LEXFLAGS = [
659 # windows compatibility (uses <io.h> instead of <unistd.h> and
660 # _isatty, _fileno functions)
665 if host_platform.system() == 'Windows':
666 if check_prog(env, 'win_bison'):
667 env["YACC"] = 'win_bison'
672 # Custom builders and methods
674 env.AddMethod(install_program, 'InstallProgram')
675 env.AddMethod(install_shared_library, 'InstallSharedLibrary')
676 env.AddMethod(msvc2013_compat, 'MSVC2013Compat')
677 env.AddMethod(unit_test, 'UnitTest')
679 env.PkgCheckModules('X11', ['x11', 'xext', 'xdamage >= 1.1', 'xfixes', 'glproto >= 1.4.13', 'dri2proto >= 2.8'])
680 env.PkgCheckModules('XCB', ['x11-xcb', 'xcb-glx >= 1.8.1', 'xcb-dri2 >= 1.8'])
681 env.PkgCheckModules('XF86VIDMODE', ['xxf86vm'])
682 env.PkgCheckModules('DRM', ['libdrm >= 2.4.75'])
685 env.Append(CPPPATH = env['X11_CPPPATH'])
687 env['dri'] = env['x11'] and env['drm']