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 pipe = SCons.Action._subproc(env, [env['CC'], cpp_opt, source.name],
141 result = pipe.wait() == 0
143 os.unlink(source.name)
145 sys.stdout.write(' %s\n' % ['no', 'yes'][int(bool(result))])
149 def check_prog(env, prog):
150 """Check whether this program exists."""
152 sys.stdout.write('Checking for %s ... ' % prog)
154 result = env.Detect(prog)
156 sys.stdout.write(' %s\n' % ['no', 'yes'][int(bool(result))])
161 """Common environment generation code"""
163 # Tell tools which machine to compile for
164 env['TARGET_ARCH'] = env['machine']
165 env['MSVS_ARCH'] = env['machine']
168 platform = env['platform']
169 env.Tool(env['toolchain'])
171 # Allow override compiler and specify additional flags from environment
172 if os.environ.has_key('CC'):
173 env['CC'] = os.environ['CC']
174 if os.environ.has_key('CFLAGS'):
175 env['CCFLAGS'] += SCons.Util.CLVar(os.environ['CFLAGS'])
176 if os.environ.has_key('CXX'):
177 env['CXX'] = os.environ['CXX']
178 if os.environ.has_key('CXXFLAGS'):
179 env['CXXFLAGS'] += SCons.Util.CLVar(os.environ['CXXFLAGS'])
180 if os.environ.has_key('LDFLAGS'):
181 env['LINKFLAGS'] += SCons.Util.CLVar(os.environ['LDFLAGS'])
183 # Detect gcc/clang not by executable name, but through pre-defined macros
184 # as autoconf does, to avoid drawing wrong conclusions when using tools
185 # that overrice CC/CXX like scan-build.
186 env['gcc_compat'] = 0
189 if host_platform.system() == 'Windows':
190 env['msvc'] = check_cc(env, 'MSVC', 'defined(_MSC_VER)', '/E')
192 env['gcc_compat'] = check_cc(env, 'GCC', 'defined(__GNUC__)')
193 env['clang'] = check_cc(env, 'Clang', '__clang__')
194 env['gcc'] = env['gcc_compat'] and not env['clang']
195 env['suncc'] = env['platform'] == 'sunos' and os.path.basename(env['CC']) == 'cc'
196 env['icc'] = 'icc' == os.path.basename(env['CC'])
198 if env['msvc'] and env['toolchain'] == 'default' and env['machine'] == 'x86_64':
199 # MSVC x64 support is broken in earlier versions of scons
200 env.EnsurePythonVersion(2, 0)
203 machine = env['machine']
204 platform = env['platform']
205 x86 = env['machine'] == 'x86'
206 ppc = env['machine'] == 'ppc'
207 gcc_compat = env['gcc_compat']
212 # Determine whether we are cross compiling; in particular, whether we need
213 # to compile code generators with a different compiler as the target code.
214 hosthost_platform = host_platform.system().lower()
215 if hosthost_platform.startswith('cygwin'):
216 hosthost_platform = 'cygwin'
217 host_machine = os.environ.get('PROCESSOR_ARCHITEW6432', os.environ.get('PROCESSOR_ARCHITECTURE', host_platform.machine()))
227 }.get(host_machine, 'generic')
228 env['crosscompile'] = platform != hosthost_platform
229 if machine == 'x86_64' and host_machine != 'x86_64':
230 env['crosscompile'] = True
231 env['hostonly'] = False
233 # Backwards compatability with the debug= profile= options
234 if env['build'] == 'debug':
236 print 'scons: warning: debug option is deprecated and will be removed eventually; use instead'
238 print ' scons build=release'
240 env['build'] = 'release'
242 print 'scons: warning: profile option is deprecated and will be removed eventually; use instead'
244 print ' scons build=profile'
246 env['build'] = 'profile'
248 # Enforce SConscripts to use the new build variable
250 env.popitem('profile')
252 # Backwards portability with older sconscripts
253 if env['build'] in ('debug', 'checked'):
255 env['profile'] = False
256 if env['build'] == 'profile':
258 env['profile'] = True
259 if env['build'] == 'release':
261 env['profile'] = False
263 # Put build output in a separate dir, which depends on the current
264 # configuration. See also http://www.scons.org/wiki/AdvancedBuildExample
265 build_topdir = 'build'
266 build_subdir = env['platform']
268 build_subdir = 'embedded-' + build_subdir
269 if env['machine'] != 'generic':
270 build_subdir += '-' + env['machine']
271 if env['build'] != 'release':
272 build_subdir += '-' + env['build']
273 build_dir = os.path.join(build_topdir, build_subdir)
274 # Place the .sconsign file in the build dir too, to avoid issues with
275 # different scons versions building the same source file
276 env['build_dir'] = build_dir
277 env.SConsignFile(os.path.join(build_dir, '.sconsign'))
278 if 'SCONS_CACHE_DIR' in os.environ:
279 print 'scons: Using build cache in %s.' % (os.environ['SCONS_CACHE_DIR'],)
280 env.CacheDir(os.environ['SCONS_CACHE_DIR'])
281 env['CONFIGUREDIR'] = os.path.join(build_dir, 'conf')
282 env['CONFIGURELOG'] = os.path.join(os.path.abspath(build_dir), 'config.log')
285 if env.GetOption('num_jobs') <= 1:
286 env.SetOption('num_jobs', num_jobs())
288 env.Decider('MD5-timestamp')
289 env.SetOption('max_drift', 60)
291 # C preprocessor options
294 '__STDC_LIMIT_MACROS',
295 '__STDC_CONSTANT_MACROS',
298 if env['build'] in ('debug', 'checked'):
299 cppdefines += ['DEBUG']
301 cppdefines += ['NDEBUG']
302 if env['build'] == 'profile':
303 cppdefines += ['PROFILE']
304 if env['platform'] in ('posix', 'linux', 'freebsd', 'darwin'):
307 ('_POSIX_C_SOURCE', '199309L'),
313 if env['platform'] == 'darwin':
317 'GLX_DIRECT_RENDERING',
321 'GLX_DIRECT_RENDERING',
322 'GLX_INDIRECT_RENDERING',
324 if env['platform'] in ('linux', 'freebsd'):
325 cppdefines += ['HAVE_ALIAS']
327 cppdefines += ['GLX_ALIAS_UNSUPPORTED']
329 if env['platform'] in ('linux', 'darwin'):
330 cppdefines += ['HAVE_XLOCALE_H']
332 if platform == 'windows':
338 # http://msdn.microsoft.com/en-us/library/aa383745.aspx
339 ('_WIN32_WINNT', '0x0601'),
340 ('WINVER', '0x0601'),
343 cppdefines += [('__MSVCRT_VERSION__', '0x0700')]
348 '_CRT_SECURE_NO_WARNINGS',
349 '_CRT_SECURE_NO_DEPRECATE',
350 '_SCL_SECURE_NO_WARNINGS',
351 '_SCL_SECURE_NO_DEPRECATE',
352 '_ALLOW_KEYWORD_MACROS',
353 '_HAS_EXCEPTIONS=0', # Tell C++ STL to not use exceptions
355 if env['build'] in ('debug', 'checked'):
356 cppdefines += ['_DEBUG']
357 if platform == 'windows':
358 cppdefines += ['PIPE_SUBSYSTEM_WINDOWS_USER']
360 cppdefines += ['PIPE_SUBSYSTEM_EMBEDDED']
361 if env['texture_float']:
362 print 'warning: Floating-point textures enabled.'
363 print 'warning: Please consult docs/patents.txt with your lawyer before building Mesa.'
364 cppdefines += ['TEXTURE_FLOAT_ENABLED']
365 env.Append(CPPDEFINES = cppdefines)
370 ccflags = [] # C & C++
372 if env['build'] == 'debug':
377 # gcc's builtin memcmp is slower than glibc's
378 # http://gcc.gnu.org/bugzilla/show_bug.cgi?id=43052
379 ccflags += ['-fno-builtin-memcmp']
380 # Work around aliasing bugs - developers should comment this out
381 ccflags += ['-fno-strict-aliasing']
383 if env['build'] in ('checked', 'profile') or env['asan']:
384 # See http://code.google.com/p/jrfonseca/wiki/Gprof2Dot#Which_options_should_I_pass_to_gcc_when_compiling_for_profiling?
386 '-fno-omit-frame-pointer',
389 ccflags += ['-fno-optimize-sibling-calls']
390 if env['machine'] == 'x86':
395 if platform != 'haiku':
396 # NOTE: We need to ensure stack is realigned given that we
397 # produce shared objects, and have no control over the stack
398 # alignment policy of the application. Therefore we need
399 # -mstackrealign ore -mincoming-stack-boundary=2.
401 # XXX: We could have SSE without -mstackrealign if we always used
402 # __attribute__((force_align_arg_pointer)), but that's not
405 '-mstackrealign', # ensure stack is aligned
406 '-msse', '-msse2', # enable SIMD intrinsics
407 '-mfpmath=sse', # generate SSE floating-point arithmetic
409 if platform in ['windows', 'darwin']:
410 # Workaround http://gcc.gnu.org/bugzilla/show_bug.cgi?id=37216
411 ccflags += ['-fno-common']
412 if platform in ['haiku']:
413 # Make optimizations compatible with Pentium or higher on Haiku
415 '-mstackrealign', # ensure stack is aligned
416 '-march=i586', # Haiku target is Pentium
417 '-mtune=i686' # use i686 where we can
419 if env['machine'] == 'x86_64':
421 if platform == 'darwin':
422 ccflags += ['-fno-common']
423 if env['platform'] not in ('cygwin', 'haiku', 'windows'):
424 ccflags += ['-fvisibility=hidden']
426 # - http://gcc.gnu.org/onlinedocs/gcc/Warning-Options.html
430 '-fmessage-length=0', # be nice to Eclipse
433 '-Wmissing-prototypes',
442 # - http://msdn.microsoft.com/en-us/library/19z1t1wy.aspx
444 if env['build'] == 'debug':
446 '/Od', # disable optimizations
447 '/Oi', # enable intrinsic functions
451 '/O2', # optimize for speed
453 if env['build'] == 'release':
456 '/GL', # enable whole program optimization
460 '/Oy-', # disable frame pointer omission
463 '/W3', # warning level
464 '/wd4018', # signed/unsigned mismatch
465 '/wd4056', # overflow in floating-point constant arithmetic
466 '/wd4244', # conversion from 'type1' to 'type2', possible loss of data
467 '/wd4267', # 'var' : conversion from 'size_t' to 'type', possible loss of data
468 '/wd4305', # truncation from 'type1' to 'type2'
469 '/wd4351', # new behavior: elements of array 'array' will be default initialized
470 '/wd4756', # overflow in constant arithmetic
471 '/wd4800', # forcing value to bool 'true' or 'false' (performance warning)
472 '/wd4996', # disable deprecated POSIX name warnings
476 '-Wno-microsoft-enum-value', # enumerator value is not representable in underlying type 'int'
478 if env['machine'] == 'x86':
480 '/arch:SSE2', # use the SSE2 instructions (default since MSVC 2012)
482 if platform == 'windows':
486 # Automatic pdb generation
487 # See http://scons.tigris.org/issues/show_bug.cgi?id=1656
488 env.EnsureSConsVersion(0, 98, 0)
489 env['PDB'] = '${TARGET.base}.pdb'
490 env.Append(CCFLAGS = ccflags)
491 env.Append(CFLAGS = cflags)
492 env.Append(CXXFLAGS = cxxflags)
494 if env['platform'] == 'windows' and msvc:
495 # Choose the appropriate MSVC CRT
496 # http://msdn.microsoft.com/en-us/library/2kzt1wy3.aspx
497 if env['build'] in ('debug', 'checked'):
498 env.Append(CCFLAGS = ['/MTd'])
499 env.Append(SHCCFLAGS = ['/LDd'])
501 env.Append(CCFLAGS = ['/MT'])
502 env.Append(SHCCFLAGS = ['/LD'])
504 # Static code analysis
507 # http://msdn.microsoft.com/en-us/library/ms173498.aspx
508 env.Append(CCFLAGS = [
510 #'/analyze:log', '${TARGET.base}.xml',
511 '/wd28251', # Inconsistent annotation for function
514 # scan-build will produce more comprehensive output
515 env.Append(CCFLAGS = ['--analyze'])
517 # https://github.com/google/sanitizers/wiki/AddressSanitizer
520 env.Append(CCFLAGS = [
521 '-fsanitize=address',
523 env.Append(LINKFLAGS = [
524 '-fsanitize=address',
529 if env['machine'] == 'x86':
530 env.Append(ASFLAGS = ['-m32'])
531 if env['machine'] == 'x86_64':
532 env.Append(ASFLAGS = ['-m64'])
538 if env['machine'] == 'x86':
539 linkflags += ['-m32']
540 if env['machine'] == 'x86_64':
541 linkflags += ['-m64']
542 if env['platform'] not in ('darwin'):
546 # Handle circular dependencies in the libraries
547 if env['platform'] in ('darwin'):
550 env['_LIBFLAGS'] = '-Wl,--start-group ' + env['_LIBFLAGS'] + ' -Wl,--end-group'
551 if env['platform'] == 'windows':
553 '-Wl,--nxcompat', # DEP
554 '-Wl,--dynamicbase', # ASLR
556 # Avoid depending on gcc runtime DLLs
557 linkflags += ['-static-libgcc']
558 if 'w64' in env['CC'].split('-'):
559 linkflags += ['-static-libstdc++']
560 # Handle the @xx symbol munging of DLL exports
561 shlinkflags += ['-Wl,--enable-stdcall-fixup']
562 #shlinkflags += ['-Wl,--kill-at']
564 if env['build'] == 'release' and not env['clang']:
565 # enable Link-time Code Generation
566 linkflags += ['/LTCG']
567 env.Append(ARFLAGS = ['/LTCG'])
568 if platform == 'windows' and msvc:
570 # - http://msdn2.microsoft.com/en-us/library/y0zzbyt4.aspx
574 '/dynamicbase', # ASLR
577 env.Append(LINKFLAGS = linkflags)
578 env.Append(SHLINKFLAGS = shlinkflags)
580 # We have C++ in several libraries, so always link with the C++ compiler
582 env['LINK'] = env['CXX']
586 if env['platform'] in ('darwin', 'freebsd', 'linux', 'posix', 'sunos'):
587 libs += ['m', 'pthread', 'dl']
588 if env['platform'] in ('linux',):
590 if env['platform'] in ('haiku'):
591 libs += ['root', 'be', 'network', 'translation']
592 env.Append(LIBS = libs)
597 env.Append(CCFLAGS = ['/openmp'])
598 # When building openmp release VS2008 link.exe crashes with LNK1103 error.
599 # Workaround: overwrite PDB flags with empty value as it isn't required anyways
600 if env['build'] == 'release':
603 env.Append(CCFLAGS = ['-fopenmp'])
604 env.Append(LIBS = ['gomp'])
609 env.Append(LEXFLAGS = [
610 # Force flex to use const keyword in prototypes, as relies on
611 # __cplusplus or __STDC__ macro to determine whether it's safe to
612 # use const keyword, but MSVC never defines __STDC__ unless we
613 # disable all MSVC extensions.
616 # Flex relies on __STDC_VERSION__>=199901L to decide when to include
617 # C99 inttypes.h. We always have inttypes.h available with MSVC
618 # (either the one bundled with MSVC 2013, or the one we bundle
619 # ourselves), but we can't just define __STDC_VERSION__ without
620 # breaking stuff, as MSVC doesn't fully support C99. There's also no
621 # way to premptively include stdint.
622 env.Append(CCFLAGS = ['-FIinttypes.h'])
623 if host_platform.system() == 'Windows':
624 # Prefer winflexbison binaries, as not only they are easier to install
625 # (no additional dependencies), but also better Windows support.
626 if check_prog(env, 'win_flex'):
627 env["LEX"] = 'win_flex'
628 env.Append(LEXFLAGS = [
629 # windows compatibility (uses <io.h> instead of <unistd.h> and
630 # _isatty, _fileno functions)
635 if host_platform.system() == 'Windows':
636 if check_prog(env, 'win_bison'):
637 env["YACC"] = 'win_bison'
642 # Custom builders and methods
644 env.AddMethod(install_program, 'InstallProgram')
645 env.AddMethod(install_shared_library, 'InstallSharedLibrary')
646 env.AddMethod(msvc2013_compat, 'MSVC2013Compat')
647 env.AddMethod(unit_test, 'UnitTest')
649 env.PkgCheckModules('X11', ['x11', 'xext', 'xdamage', 'xfixes', 'glproto >= 1.4.13'])
650 env.PkgCheckModules('XCB', ['x11-xcb', 'xcb-glx >= 1.8.1', 'xcb-dri2 >= 1.8'])
651 env.PkgCheckModules('XF86VIDMODE', ['xxf86vm'])
652 env.PkgCheckModules('DRM', ['libdrm >= 2.4.38'])
653 env.PkgCheckModules('UDEV', ['libudev >= 151'])
656 env.Append(CPPPATH = env['X11_CPPPATH'])
658 env['dri'] = env['x11'] and env['drm']