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.
32 from __future__ import print_function
34 import distutils.version
39 import platform as host_platform
48 def symlink(target, source, env):
49 target = str(target[0])
50 source = str(source[0])
51 if os.path.islink(target) or os.path.exists(target):
53 os.symlink(os.path.basename(source), target)
55 def install(env, source, subdir):
56 target_dir = os.path.join(env.Dir('#.').srcnode().abspath, env['build_dir'], subdir)
57 return env.Install(target_dir, source)
59 def install_program(env, source):
60 return install(env, source, 'bin')
62 def install_shared_library(env, sources, version = ()):
64 install_dir = os.path.join(env.Dir('#.').srcnode().abspath, env['build_dir'])
65 version = tuple(map(str, version))
66 if env['SHLIBSUFFIX'] == '.dll':
67 dlls = env.FindIxes(sources, 'SHLIBPREFIX', 'SHLIBSUFFIX')
68 targets += install(env, dlls, 'bin')
69 libs = env.FindIxes(sources, 'LIBPREFIX', 'LIBSUFFIX')
70 targets += install(env, libs, 'lib')
72 for source in sources:
73 target_dir = os.path.join(install_dir, 'lib')
74 target_name = '.'.join((str(source),) + version)
75 last = env.InstallAs(os.path.join(target_dir, target_name), source)
78 version = version[:-1]
79 target_name = '.'.join((str(source),) + version)
80 action = SCons.Action.Action(symlink, " Symlinking $TARGET ...")
81 last = env.Command(os.path.join(target_dir, target_name), last, action)
86 def msvc2013_compat(env):
88 env.Append(CCFLAGS = [
90 '-Werror=pointer-arith',
94 def unit_test(env, test_name, program_target, args=None):
95 env.InstallProgram(program_target)
97 cmd = [program_target[0].abspath]
102 # http://www.scons.org/wiki/UnitTests
103 action = SCons.Action.Action(cmd, " Running $SOURCE ...")
104 alias = env.Alias(test_name, program_target, action)
105 env.AlwaysBuild(alias)
106 env.Depends('check', alias)
111 return int(os.environ['NUMBER_OF_PROCESSORS'])
112 except (ValueError, KeyError):
116 return os.sysconf('SC_NPROCESSORS_ONLN')
117 except (ValueError, OSError, AttributeError):
121 return int(os.popen2("sysctl -n hw.ncpu")[1].read())
128 def check_cc(env, cc, expr, cpp_opt = '-E'):
129 # Invoke C-preprocessor to determine whether the specified expression is
132 sys.stdout.write('Checking for %s ... ' % cc)
134 source = tempfile.NamedTemporaryFile(suffix='.c', delete=False)
135 source.write('#if !(%s)\n#error\n#endif\n' % expr)
138 # sys.stderr.write('%r %s %s\n' % (env['CC'], cpp_opt, source.name));
140 pipe = SCons.Action._subproc(env, env.Split(env['CC']) + [cpp_opt, source.name],
144 result = pipe.wait() == 0
146 os.unlink(source.name)
148 sys.stdout.write(' %s\n' % ['no', 'yes'][int(bool(result))])
151 def check_header(env, header):
152 '''Check if the header exist'''
154 conf = SCons.Script.Configure(env)
157 if conf.CheckHeader(header):
163 def check_functions(env, functions):
164 '''Check if all of the functions exist'''
166 conf = SCons.Script.Configure(env)
167 have_functions = True
169 for function in functions:
170 if not conf.CheckFunc(function):
171 have_functions = False
174 return have_functions
176 def check_prog(env, prog):
177 """Check whether this program exists."""
179 sys.stdout.write('Checking for %s ... ' % prog)
181 result = env.Detect(prog)
183 sys.stdout.write(' %s\n' % ['no', 'yes'][int(bool(result))])
188 """Common environment generation code"""
190 # Tell tools which machine to compile for
191 env['TARGET_ARCH'] = env['machine']
192 env['MSVS_ARCH'] = env['machine']
195 platform = env['platform']
196 env.Tool(env['toolchain'])
198 # Allow override compiler and specify additional flags from environment
199 if 'CC' in os.environ:
200 env['CC'] = os.environ['CC']
201 if 'CFLAGS' in os.environ:
202 env['CCFLAGS'] += SCons.Util.CLVar(os.environ['CFLAGS'])
203 if 'CXX' in os.environ:
204 env['CXX'] = os.environ['CXX']
205 if 'CXXFLAGS' in os.environ:
206 env['CXXFLAGS'] += SCons.Util.CLVar(os.environ['CXXFLAGS'])
207 if 'LDFLAGS' in os.environ:
208 env['LINKFLAGS'] += SCons.Util.CLVar(os.environ['LDFLAGS'])
210 # Detect gcc/clang not by executable name, but through pre-defined macros
211 # as autoconf does, to avoid drawing wrong conclusions when using tools
212 # that overrice CC/CXX like scan-build.
213 env['gcc_compat'] = 0
216 if host_platform.system() == 'Windows':
217 env['msvc'] = check_cc(env, 'MSVC', 'defined(_MSC_VER)', '/E')
219 env['gcc_compat'] = check_cc(env, 'GCC', 'defined(__GNUC__)')
220 env['clang'] = check_cc(env, 'Clang', '__clang__')
221 env['gcc'] = env['gcc_compat'] and not env['clang']
222 env['suncc'] = env['platform'] == 'sunos' and os.path.basename(env['CC']) == 'cc'
223 env['icc'] = 'icc' == os.path.basename(env['CC'])
226 machine = env['machine']
227 platform = env['platform']
228 x86 = env['machine'] == 'x86'
229 ppc = env['machine'] == 'ppc'
230 gcc_compat = env['gcc_compat']
235 # Determine whether we are cross compiling; in particular, whether we need
236 # to compile code generators with a different compiler as the target code.
237 hosthost_platform = host_platform.system().lower()
238 if hosthost_platform.startswith('cygwin'):
239 hosthost_platform = 'cygwin'
240 host_machine = os.environ.get('PROCESSOR_ARCHITEW6432', os.environ.get('PROCESSOR_ARCHITECTURE', host_platform.machine()))
250 }.get(host_machine, 'generic')
251 env['crosscompile'] = platform != hosthost_platform
252 if machine == 'x86_64' and host_machine != 'x86_64':
253 env['crosscompile'] = True
254 env['hostonly'] = False
256 # Backwards compatability with the debug= profile= options
257 if env['build'] == 'debug':
259 print('scons: warning: debug option is deprecated and will be removed eventually; use instead')
261 print(' scons build=release')
263 env['build'] = 'release'
265 print('scons: warning: profile option is deprecated and will be removed eventually; use instead')
267 print(' scons build=profile')
269 env['build'] = 'profile'
271 # Enforce SConscripts to use the new build variable
273 env.popitem('profile')
275 # Backwards portability with older sconscripts
276 if env['build'] in ('debug', 'checked'):
278 env['profile'] = False
279 if env['build'] == 'profile':
281 env['profile'] = True
282 if env['build'] == 'release':
284 env['profile'] = False
286 # Put build output in a separate dir, which depends on the current
287 # configuration. See also http://www.scons.org/wiki/AdvancedBuildExample
288 build_topdir = 'build'
289 build_subdir = env['platform']
291 build_subdir = 'embedded-' + build_subdir
292 if env['machine'] != 'generic':
293 build_subdir += '-' + env['machine']
294 if env['build'] != 'release':
295 build_subdir += '-' + env['build']
296 build_dir = os.path.join(build_topdir, build_subdir)
297 # Place the .sconsign file in the build dir too, to avoid issues with
298 # different scons versions building the same source file
299 env['build_dir'] = build_dir
300 env.SConsignFile(os.path.join(build_dir, '.sconsign'))
301 if 'SCONS_CACHE_DIR' in os.environ:
302 print('scons: Using build cache in %s.' % (os.environ['SCONS_CACHE_DIR'],))
303 env.CacheDir(os.environ['SCONS_CACHE_DIR'])
304 env['CONFIGUREDIR'] = os.path.join(build_dir, 'conf')
305 env['CONFIGURELOG'] = os.path.join(os.path.abspath(build_dir), 'config.log')
308 if env.GetOption('num_jobs') <= 1:
309 env.SetOption('num_jobs', num_jobs())
311 # Speed up dependency checking. See
312 # - https://github.com/SCons/scons/wiki/GoFastButton
313 # - https://bugs.freedesktop.org/show_bug.cgi?id=109443
315 # Scons version string has consistently been in this format:
316 # MajorVersion.MinorVersion.Patch[.alpha/beta.yyyymmdd]
317 # so this formula should cover all versions regardless of type
318 # stable, alpha or beta.
319 # For simplicity alpha and beta flags are removed.
321 scons_version = distutils.version.StrictVersion('.'.join(SCons.__version__.split('.')[:3]))
322 if scons_version < distutils.version.StrictVersion('3.0.2') or \
323 scons_version > distutils.version.StrictVersion('3.0.4'):
324 env.Decider('MD5-timestamp')
325 env.SetOption('max_drift', 60)
327 # C preprocessor options
330 '__STDC_CONSTANT_MACROS',
331 '__STDC_FORMAT_MACROS',
332 '__STDC_LIMIT_MACROS',
335 if env['build'] in ('debug', 'checked'):
336 cppdefines += ['DEBUG']
338 cppdefines += ['NDEBUG']
339 if env['build'] == 'profile':
340 cppdefines += ['PROFILE']
341 if env['platform'] in ('posix', 'linux', 'freebsd', 'darwin'):
344 ('_POSIX_C_SOURCE', '199309L'),
350 if env['platform'] == 'darwin':
354 'GLX_DIRECT_RENDERING',
358 'GLX_DIRECT_RENDERING',
359 'GLX_INDIRECT_RENDERING',
362 if check_header(env, 'xlocale.h'):
363 cppdefines += ['HAVE_XLOCALE_H']
365 if check_header(env, 'endian.h'):
366 cppdefines += ['HAVE_ENDIAN_H']
368 if check_functions(env, ['strtod_l', 'strtof_l']):
369 cppdefines += ['HAVE_STRTOD_L']
371 if check_functions(env, ['timespec_get']):
372 cppdefines += ['HAVE_TIMESPEC_GET']
374 if platform == 'windows':
380 # http://msdn.microsoft.com/en-us/library/aa383745.aspx
381 ('_WIN32_WINNT', '0x0601'),
382 ('WINVER', '0x0601'),
385 cppdefines += [('__MSVCRT_VERSION__', '0x0700')]
390 '_CRT_SECURE_NO_WARNINGS',
391 '_CRT_SECURE_NO_DEPRECATE',
392 '_SCL_SECURE_NO_WARNINGS',
393 '_SCL_SECURE_NO_DEPRECATE',
394 '_ALLOW_KEYWORD_MACROS',
395 '_HAS_EXCEPTIONS=0', # Tell C++ STL to not use exceptions
397 if env['build'] in ('debug', 'checked'):
398 cppdefines += ['_DEBUG']
399 if platform == 'windows':
400 cppdefines += ['PIPE_SUBSYSTEM_WINDOWS_USER']
402 cppdefines += ['PIPE_SUBSYSTEM_EMBEDDED']
403 env.Append(CPPDEFINES = cppdefines)
408 ccflags = [] # C & C++
410 if env['build'] == 'debug':
415 # gcc's builtin memcmp is slower than glibc's
416 # http://gcc.gnu.org/bugzilla/show_bug.cgi?id=43052
417 ccflags += ['-fno-builtin-memcmp']
418 # Work around aliasing bugs - developers should comment this out
419 ccflags += ['-fno-strict-aliasing']
421 if env['build'] in ('checked', 'profile') or env['asan']:
422 # See http://code.google.com/p/jrfonseca/wiki/Gprof2Dot#Which_options_should_I_pass_to_gcc_when_compiling_for_profiling?
424 '-fno-omit-frame-pointer',
427 ccflags += ['-fno-optimize-sibling-calls']
428 if env['machine'] == 'x86':
433 if platform != 'haiku':
434 # NOTE: We need to ensure stack is realigned given that we
435 # produce shared objects, and have no control over the stack
436 # alignment policy of the application. Therefore we need
437 # -mstackrealign ore -mincoming-stack-boundary=2.
439 # XXX: We could have SSE without -mstackrealign if we always used
440 # __attribute__((force_align_arg_pointer)), but that's not
443 '-mstackrealign', # ensure stack is aligned
444 '-msse', '-msse2', # enable SIMD intrinsics
445 '-mfpmath=sse', # generate SSE floating-point arithmetic
447 if platform in ['windows', 'darwin']:
448 # Workaround http://gcc.gnu.org/bugzilla/show_bug.cgi?id=37216
449 ccflags += ['-fno-common']
450 if platform in ['haiku']:
451 # Make optimizations compatible with Pentium or higher on Haiku
453 '-mstackrealign', # ensure stack is aligned
454 '-march=i586', # Haiku target is Pentium
455 '-mtune=i686' # use i686 where we can
457 if env['machine'] == 'x86_64':
459 if platform == 'darwin':
460 ccflags += ['-fno-common']
461 if env['platform'] not in ('cygwin', 'haiku', 'windows'):
462 ccflags += ['-fvisibility=hidden']
464 # - http://gcc.gnu.org/onlinedocs/gcc/Warning-Options.html
468 '-fmessage-length=0', # be nice to Eclipse
471 '-Wmissing-prototypes',
480 # - http://msdn.microsoft.com/en-us/library/19z1t1wy.aspx
482 if env['build'] == 'debug':
484 '/Od', # disable optimizations
485 '/Oi', # enable intrinsic functions
489 '/O2', # optimize for speed
491 if env['build'] == 'release':
494 '/GL', # enable whole program optimization
498 '/Oy-', # disable frame pointer omission
501 '/W3', # warning level
502 '/wd4018', # signed/unsigned mismatch
503 '/wd4056', # overflow in floating-point constant arithmetic
504 '/wd4244', # conversion from 'type1' to 'type2', possible loss of data
505 '/wd4267', # 'var' : conversion from 'size_t' to 'type', possible loss of data
506 '/wd4305', # truncation from 'type1' to 'type2'
507 '/wd4351', # new behavior: elements of array 'array' will be default initialized
508 '/wd4756', # overflow in constant arithmetic
509 '/wd4800', # forcing value to bool 'true' or 'false' (performance warning)
510 '/wd4996', # disable deprecated POSIX name warnings
514 '-Wno-microsoft-enum-value', # enumerator value is not representable in underlying type 'int'
516 if env['machine'] == 'x86':
518 '/arch:SSE2', # use the SSE2 instructions (default since MSVC 2012)
520 if platform == 'windows':
524 # Automatic pdb generation
525 # See http://scons.tigris.org/issues/show_bug.cgi?id=1656
526 env.EnsureSConsVersion(0, 98, 0)
527 env['PDB'] = '${TARGET.base}.pdb'
528 env.Append(CCFLAGS = ccflags)
529 env.Append(CFLAGS = cflags)
530 env.Append(CXXFLAGS = cxxflags)
532 if env['platform'] == 'windows' and msvc:
533 # Choose the appropriate MSVC CRT
534 # http://msdn.microsoft.com/en-us/library/2kzt1wy3.aspx
535 if env['build'] in ('debug', 'checked'):
536 env.Append(CCFLAGS = ['/MTd'])
537 env.Append(SHCCFLAGS = ['/LDd'])
539 env.Append(CCFLAGS = ['/MT'])
540 env.Append(SHCCFLAGS = ['/LD'])
542 # Static code analysis
545 # http://msdn.microsoft.com/en-us/library/ms173498.aspx
546 env.Append(CCFLAGS = [
548 #'/analyze:log', '${TARGET.base}.xml',
549 '/wd28251', # Inconsistent annotation for function
552 # scan-build will produce more comprehensive output
553 env.Append(CCFLAGS = ['--analyze'])
555 # https://github.com/google/sanitizers/wiki/AddressSanitizer
558 env.Append(CCFLAGS = [
559 '-fsanitize=address',
561 env.Append(LINKFLAGS = [
562 '-fsanitize=address',
567 if env['machine'] == 'x86':
568 env.Append(ASFLAGS = ['-m32'])
569 if env['machine'] == 'x86_64':
570 env.Append(ASFLAGS = ['-m64'])
576 if env['machine'] == 'x86':
577 linkflags += ['-m32']
578 if env['machine'] == 'x86_64':
579 linkflags += ['-m64']
580 if env['platform'] not in ('darwin'):
584 # Handle circular dependencies in the libraries
585 if env['platform'] in ('darwin'):
588 env['_LIBFLAGS'] = '-Wl,--start-group ' + env['_LIBFLAGS'] + ' -Wl,--end-group'
589 if env['platform'] == 'windows':
591 '-Wl,--nxcompat', # DEP
592 '-Wl,--dynamicbase', # ASLR
594 # Avoid depending on gcc runtime DLLs
595 linkflags += ['-static-libgcc']
596 if 'w64' in env['CC'].split('-'):
597 linkflags += ['-static-libstdc++']
598 # Handle the @xx symbol munging of DLL exports
599 shlinkflags += ['-Wl,--enable-stdcall-fixup']
600 #shlinkflags += ['-Wl,--kill-at']
602 if env['build'] == 'release' and not env['clang']:
603 # enable Link-time Code Generation
604 linkflags += ['/LTCG']
605 env.Append(ARFLAGS = ['/LTCG'])
606 if platform == 'windows' and msvc:
608 # - http://msdn2.microsoft.com/en-us/library/y0zzbyt4.aspx
612 '/dynamicbase', # ASLR
615 env.Append(LINKFLAGS = linkflags)
616 env.Append(SHLINKFLAGS = shlinkflags)
618 # We have C++ in several libraries, so always link with the C++ compiler
620 env['LINK'] = env['CXX']
624 if env['platform'] in ('darwin', 'freebsd', 'linux', 'posix', 'sunos'):
625 libs += ['m', 'pthread', 'dl']
626 if env['platform'] in ('linux',):
628 if env['platform'] in ('haiku'):
629 libs += ['root', 'be', 'network', 'translation']
630 env.Append(LIBS = libs)
635 env.Append(CCFLAGS = ['/openmp'])
636 # When building openmp release VS2008 link.exe crashes with LNK1103 error.
637 # Workaround: overwrite PDB flags with empty value as it isn't required anyways
638 if env['build'] == 'release':
641 env.Append(CCFLAGS = ['-fopenmp'])
642 env.Append(LIBS = ['gomp'])
647 env.Append(LEXFLAGS = [
648 # Force flex to use const keyword in prototypes, as relies on
649 # __cplusplus or __STDC__ macro to determine whether it's safe to
650 # use const keyword, but MSVC never defines __STDC__ unless we
651 # disable all MSVC extensions.
654 # Flex relies on __STDC_VERSION__>=199901L to decide when to include
655 # C99 inttypes.h. We always have inttypes.h available with MSVC
656 # (either the one bundled with MSVC 2013, or the one we bundle
657 # ourselves), but we can't just define __STDC_VERSION__ without
658 # breaking stuff, as MSVC doesn't fully support C99. There's also no
659 # way to premptively include stdint.
660 env.Append(CCFLAGS = ['-FIinttypes.h'])
661 if host_platform.system() == 'Windows':
662 # Prefer winflexbison binaries, as not only they are easier to install
663 # (no additional dependencies), but also better Windows support.
664 if check_prog(env, 'win_flex'):
665 env["LEX"] = 'win_flex'
666 env.Append(LEXFLAGS = [
667 # windows compatibility (uses <io.h> instead of <unistd.h> and
668 # _isatty, _fileno functions)
673 if host_platform.system() == 'Windows':
674 if check_prog(env, 'win_bison'):
675 env["YACC"] = 'win_bison'
680 # Custom builders and methods
682 env.AddMethod(install_program, 'InstallProgram')
683 env.AddMethod(install_shared_library, 'InstallSharedLibrary')
684 env.AddMethod(msvc2013_compat, 'MSVC2013Compat')
685 env.AddMethod(unit_test, 'UnitTest')
687 env.PkgCheckModules('X11', ['x11', 'xext', 'xdamage >= 1.1', 'xfixes', 'glproto >= 1.4.13', 'dri2proto >= 2.8'])
688 env.PkgCheckModules('XCB', ['x11-xcb', 'xcb-glx >= 1.8.1', 'xcb-dri2 >= 1.8'])
689 env.PkgCheckModules('XF86VIDMODE', ['xxf86vm'])
690 env.PkgCheckModules('DRM', ['libdrm >= 2.4.75'])
692 if not os.path.exists("src/util/format_srgb.c"):
693 print("Checking for Python Mako module (>= 0.8.0)... ", end='')
699 if distutils.version.StrictVersion(mako.__version__) < distutils.version.StrictVersion('0.8.0'):
705 env.Append(CPPPATH = env['X11_CPPPATH'])
707 env['dri'] = env['x11'] and env['drm']