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
))])
148 def check_header(env
, header
):
149 '''Check if the header exist'''
151 conf
= SCons
.Script
.Configure(env
)
154 if conf
.CheckHeader(header
):
160 def check_functions(env
, functions
):
161 '''Check if all of the functions exist'''
163 conf
= SCons
.Script
.Configure(env
)
164 have_functions
= True
166 for function
in functions
:
167 if not conf
.CheckFunc(function
):
168 have_functions
= False
171 return have_functions
173 def check_prog(env
, prog
):
174 """Check whether this program exists."""
176 sys
.stdout
.write('Checking for %s ... ' % prog
)
178 result
= env
.Detect(prog
)
180 sys
.stdout
.write(' %s\n' % ['no', 'yes'][int(bool(result
))])
185 """Common environment generation code"""
187 # Tell tools which machine to compile for
188 env
['TARGET_ARCH'] = env
['machine']
189 env
['MSVS_ARCH'] = env
['machine']
192 platform
= env
['platform']
193 env
.Tool(env
['toolchain'])
195 # Allow override compiler and specify additional flags from environment
196 if 'CC' in os
.environ
:
197 env
['CC'] = os
.environ
['CC']
198 if 'CFLAGS' in os
.environ
:
199 env
['CCFLAGS'] += SCons
.Util
.CLVar(os
.environ
['CFLAGS'])
200 if 'CXX' in os
.environ
:
201 env
['CXX'] = os
.environ
['CXX']
202 if 'CXXFLAGS' in os
.environ
:
203 env
['CXXFLAGS'] += SCons
.Util
.CLVar(os
.environ
['CXXFLAGS'])
204 if 'LDFLAGS' in os
.environ
:
205 env
['LINKFLAGS'] += SCons
.Util
.CLVar(os
.environ
['LDFLAGS'])
207 # Detect gcc/clang not by executable name, but through pre-defined macros
208 # as autoconf does, to avoid drawing wrong conclusions when using tools
209 # that overrice CC/CXX like scan-build.
210 env
['gcc_compat'] = 0
213 if host_platform
.system() == 'Windows':
214 env
['msvc'] = check_cc(env
, 'MSVC', 'defined(_MSC_VER)', '/E')
216 env
['gcc_compat'] = check_cc(env
, 'GCC', 'defined(__GNUC__)')
217 env
['clang'] = check_cc(env
, 'Clang', '__clang__')
218 env
['gcc'] = env
['gcc_compat'] and not env
['clang']
219 env
['suncc'] = env
['platform'] == 'sunos' and os
.path
.basename(env
['CC']) == 'cc'
220 env
['icc'] = 'icc' == os
.path
.basename(env
['CC'])
222 if env
['msvc'] and env
['toolchain'] == 'default' and env
['machine'] == 'x86_64':
223 # MSVC x64 support is broken in earlier versions of scons
224 env
.EnsurePythonVersion(2, 0)
227 machine
= env
['machine']
228 platform
= env
['platform']
229 x86
= env
['machine'] == 'x86'
230 ppc
= env
['machine'] == 'ppc'
231 gcc_compat
= env
['gcc_compat']
236 # Determine whether we are cross compiling; in particular, whether we need
237 # to compile code generators with a different compiler as the target code.
238 hosthost_platform
= host_platform
.system().lower()
239 if hosthost_platform
.startswith('cygwin'):
240 hosthost_platform
= 'cygwin'
241 host_machine
= os
.environ
.get('PROCESSOR_ARCHITEW6432', os
.environ
.get('PROCESSOR_ARCHITECTURE', host_platform
.machine()))
251 }.get(host_machine
, 'generic')
252 env
['crosscompile'] = platform
!= hosthost_platform
253 if machine
== 'x86_64' and host_machine
!= 'x86_64':
254 env
['crosscompile'] = True
255 env
['hostonly'] = False
257 # Backwards compatability with the debug= profile= options
258 if env
['build'] == 'debug':
260 print('scons: warning: debug option is deprecated and will be removed eventually; use instead')
262 print(' scons build=release')
264 env
['build'] = 'release'
266 print('scons: warning: profile option is deprecated and will be removed eventually; use instead')
268 print(' scons build=profile')
270 env
['build'] = 'profile'
272 # Enforce SConscripts to use the new build variable
274 env
.popitem('profile')
276 # Backwards portability with older sconscripts
277 if env
['build'] in ('debug', 'checked'):
279 env
['profile'] = False
280 if env
['build'] == 'profile':
282 env
['profile'] = True
283 if env
['build'] in ('release', 'opt'):
285 env
['profile'] = False
287 # Put build output in a separate dir, which depends on the current
288 # configuration. See also http://www.scons.org/wiki/AdvancedBuildExample
289 build_topdir
= 'build'
290 build_subdir
= env
['platform']
292 build_subdir
= 'embedded-' + build_subdir
293 if env
['machine'] != 'generic':
294 build_subdir
+= '-' + env
['machine']
295 if env
['build'] != 'release':
296 build_subdir
+= '-' + env
['build']
297 build_dir
= os
.path
.join(build_topdir
, build_subdir
)
298 # Place the .sconsign file in the build dir too, to avoid issues with
299 # different scons versions building the same source file
300 env
['build_dir'] = build_dir
301 env
.SConsignFile(os
.path
.join(build_dir
, '.sconsign'))
302 if 'SCONS_CACHE_DIR' in os
.environ
:
303 print('scons: Using build cache in %s.' % (os
.environ
['SCONS_CACHE_DIR'],))
304 env
.CacheDir(os
.environ
['SCONS_CACHE_DIR'])
305 env
['CONFIGUREDIR'] = os
.path
.join(build_dir
, 'conf')
306 env
['CONFIGURELOG'] = os
.path
.join(os
.path
.abspath(build_dir
), 'config.log')
309 if env
.GetOption('num_jobs') <= 1:
310 env
.SetOption('num_jobs', num_jobs())
312 env
.Decider('MD5-timestamp')
313 env
.SetOption('max_drift', 60)
315 # C preprocessor options
318 '__STDC_CONSTANT_MACROS',
319 '__STDC_FORMAT_MACROS',
320 '__STDC_LIMIT_MACROS',
323 if env
['build'] in ('debug', 'checked'):
324 cppdefines
+= ['DEBUG']
326 cppdefines
+= ['NDEBUG']
327 if env
['build'] == 'profile':
328 cppdefines
+= ['PROFILE']
329 if env
['build'] in ('opt', 'profile'):
330 cppdefines
+= ['VMX86_STATS']
331 if env
['platform'] in ('posix', 'linux', 'freebsd', 'darwin'):
334 ('_POSIX_C_SOURCE', '199309L'),
340 if env
['platform'] == 'darwin':
344 'GLX_DIRECT_RENDERING',
348 'GLX_DIRECT_RENDERING',
349 'GLX_INDIRECT_RENDERING',
352 if check_header(env
, 'xlocale.h'):
353 cppdefines
+= ['HAVE_XLOCALE_H']
355 if check_functions(env
, ['strtod_l', 'strtof_l']):
356 cppdefines
+= ['HAVE_STRTOD_L']
358 if check_functions(env
, ['timespec_get']):
359 cppdefines
+= ['HAVE_TIMESPEC_GET']
361 if platform
== 'windows':
367 # http://msdn.microsoft.com/en-us/library/aa383745.aspx
368 ('_WIN32_WINNT', '0x0601'),
369 ('WINVER', '0x0601'),
372 cppdefines
+= [('__MSVCRT_VERSION__', '0x0700')]
377 '_CRT_SECURE_NO_WARNINGS',
378 '_CRT_SECURE_NO_DEPRECATE',
379 '_SCL_SECURE_NO_WARNINGS',
380 '_SCL_SECURE_NO_DEPRECATE',
381 '_ALLOW_KEYWORD_MACROS',
382 '_HAS_EXCEPTIONS=0', # Tell C++ STL to not use exceptions
384 if env
['build'] in ('debug', 'checked'):
385 cppdefines
+= ['_DEBUG']
386 if platform
== 'windows':
387 cppdefines
+= ['PIPE_SUBSYSTEM_WINDOWS_USER']
389 cppdefines
+= ['PIPE_SUBSYSTEM_EMBEDDED']
390 if env
['texture_float']:
391 print('warning: Floating-point textures enabled.')
392 print('warning: Please consult docs/patents.txt with your lawyer before building Mesa.')
393 cppdefines
+= ['TEXTURE_FLOAT_ENABLED']
394 env
.Append(CPPDEFINES
= cppdefines
)
399 ccflags
= [] # C & C++
401 if env
['build'] == 'debug':
406 # gcc's builtin memcmp is slower than glibc's
407 # http://gcc.gnu.org/bugzilla/show_bug.cgi?id=43052
408 ccflags
+= ['-fno-builtin-memcmp']
409 # Work around aliasing bugs - developers should comment this out
410 ccflags
+= ['-fno-strict-aliasing']
412 if env
['build'] in ('checked', 'profile') or env
['asan']:
413 # See http://code.google.com/p/jrfonseca/wiki/Gprof2Dot#Which_options_should_I_pass_to_gcc_when_compiling_for_profiling?
415 '-fno-omit-frame-pointer',
418 ccflags
+= ['-fno-optimize-sibling-calls']
419 if env
['machine'] == 'x86':
424 if platform
!= 'haiku':
425 # NOTE: We need to ensure stack is realigned given that we
426 # produce shared objects, and have no control over the stack
427 # alignment policy of the application. Therefore we need
428 # -mstackrealign ore -mincoming-stack-boundary=2.
430 # XXX: We could have SSE without -mstackrealign if we always used
431 # __attribute__((force_align_arg_pointer)), but that's not
434 '-mstackrealign', # ensure stack is aligned
435 '-msse', '-msse2', # enable SIMD intrinsics
436 '-mfpmath=sse', # generate SSE floating-point arithmetic
438 if platform
in ['windows', 'darwin']:
439 # Workaround http://gcc.gnu.org/bugzilla/show_bug.cgi?id=37216
440 ccflags
+= ['-fno-common']
441 if platform
in ['haiku']:
442 # Make optimizations compatible with Pentium or higher on Haiku
444 '-mstackrealign', # ensure stack is aligned
445 '-march=i586', # Haiku target is Pentium
446 '-mtune=i686' # use i686 where we can
448 if env
['machine'] == 'x86_64':
450 if platform
== 'darwin':
451 ccflags
+= ['-fno-common']
452 if env
['platform'] not in ('cygwin', 'haiku', 'windows'):
453 ccflags
+= ['-fvisibility=hidden']
455 # - http://gcc.gnu.org/onlinedocs/gcc/Warning-Options.html
459 '-fmessage-length=0', # be nice to Eclipse
462 '-Wmissing-prototypes',
471 # - http://msdn.microsoft.com/en-us/library/19z1t1wy.aspx
473 if env
['build'] == 'debug':
475 '/Od', # disable optimizations
476 '/Oi', # enable intrinsic functions
480 '/O2', # optimize for speed
482 if env
['build'] in ('release', 'opt'):
485 '/GL', # enable whole program optimization
489 '/Oy-', # disable frame pointer omission
492 '/W3', # warning level
493 '/wd4018', # signed/unsigned mismatch
494 '/wd4056', # overflow in floating-point constant arithmetic
495 '/wd4244', # conversion from 'type1' to 'type2', possible loss of data
496 '/wd4267', # 'var' : conversion from 'size_t' to 'type', possible loss of data
497 '/wd4305', # truncation from 'type1' to 'type2'
498 '/wd4351', # new behavior: elements of array 'array' will be default initialized
499 '/wd4756', # overflow in constant arithmetic
500 '/wd4800', # forcing value to bool 'true' or 'false' (performance warning)
501 '/wd4996', # disable deprecated POSIX name warnings
505 '-Wno-microsoft-enum-value', # enumerator value is not representable in underlying type 'int'
507 if env
['machine'] == 'x86':
509 '/arch:SSE2', # use the SSE2 instructions (default since MSVC 2012)
511 if platform
== 'windows':
515 # Automatic pdb generation
516 # See http://scons.tigris.org/issues/show_bug.cgi?id=1656
517 env
.EnsureSConsVersion(0, 98, 0)
518 env
['PDB'] = '${TARGET.base}.pdb'
519 env
.Append(CCFLAGS
= ccflags
)
520 env
.Append(CFLAGS
= cflags
)
521 env
.Append(CXXFLAGS
= cxxflags
)
523 if env
['platform'] == 'windows' and msvc
:
524 # Choose the appropriate MSVC CRT
525 # http://msdn.microsoft.com/en-us/library/2kzt1wy3.aspx
526 if env
['build'] in ('debug', 'checked'):
527 env
.Append(CCFLAGS
= ['/MTd'])
528 env
.Append(SHCCFLAGS
= ['/LDd'])
530 env
.Append(CCFLAGS
= ['/MT'])
531 env
.Append(SHCCFLAGS
= ['/LD'])
533 # Static code analysis
536 # http://msdn.microsoft.com/en-us/library/ms173498.aspx
537 env
.Append(CCFLAGS
= [
539 #'/analyze:log', '${TARGET.base}.xml',
540 '/wd28251', # Inconsistent annotation for function
543 # scan-build will produce more comprehensive output
544 env
.Append(CCFLAGS
= ['--analyze'])
546 # https://github.com/google/sanitizers/wiki/AddressSanitizer
549 env
.Append(CCFLAGS
= [
550 '-fsanitize=address',
552 env
.Append(LINKFLAGS
= [
553 '-fsanitize=address',
558 if env
['machine'] == 'x86':
559 env
.Append(ASFLAGS
= ['-m32'])
560 if env
['machine'] == 'x86_64':
561 env
.Append(ASFLAGS
= ['-m64'])
567 if env
['machine'] == 'x86':
568 linkflags
+= ['-m32']
569 if env
['machine'] == 'x86_64':
570 linkflags
+= ['-m64']
571 if env
['platform'] not in ('darwin'):
575 # Handle circular dependencies in the libraries
576 if env
['platform'] in ('darwin'):
579 env
['_LIBFLAGS'] = '-Wl,--start-group ' + env
['_LIBFLAGS'] + ' -Wl,--end-group'
580 if env
['platform'] == 'windows':
582 '-Wl,--nxcompat', # DEP
583 '-Wl,--dynamicbase', # ASLR
585 # Avoid depending on gcc runtime DLLs
586 linkflags
+= ['-static-libgcc']
587 if 'w64' in env
['CC'].split('-'):
588 linkflags
+= ['-static-libstdc++']
589 # Handle the @xx symbol munging of DLL exports
590 shlinkflags
+= ['-Wl,--enable-stdcall-fixup']
591 #shlinkflags += ['-Wl,--kill-at']
593 if env
['build'] in ('release', 'opt') and not env
['clang']:
594 # enable Link-time Code Generation
595 linkflags
+= ['/LTCG']
596 env
.Append(ARFLAGS
= ['/LTCG'])
597 if platform
== 'windows' and msvc
:
599 # - http://msdn2.microsoft.com/en-us/library/y0zzbyt4.aspx
603 '/dynamicbase', # ASLR
606 env
.Append(LINKFLAGS
= linkflags
)
607 env
.Append(SHLINKFLAGS
= shlinkflags
)
609 # We have C++ in several libraries, so always link with the C++ compiler
611 env
['LINK'] = env
['CXX']
615 if env
['platform'] in ('darwin', 'freebsd', 'linux', 'posix', 'sunos'):
616 libs
+= ['m', 'pthread', 'dl']
617 if env
['platform'] in ('linux',):
619 if env
['platform'] in ('haiku'):
620 libs
+= ['root', 'be', 'network', 'translation']
621 env
.Append(LIBS
= libs
)
626 env
.Append(CCFLAGS
= ['/openmp'])
627 # When building openmp release VS2008 link.exe crashes with LNK1103 error.
628 # Workaround: overwrite PDB flags with empty value as it isn't required anyways
629 if env
['build'] == 'release':
632 env
.Append(CCFLAGS
= ['-fopenmp'])
633 env
.Append(LIBS
= ['gomp'])
638 env
.Append(LEXFLAGS
= [
639 # Force flex to use const keyword in prototypes, as relies on
640 # __cplusplus or __STDC__ macro to determine whether it's safe to
641 # use const keyword, but MSVC never defines __STDC__ unless we
642 # disable all MSVC extensions.
645 # Flex relies on __STDC_VERSION__>=199901L to decide when to include
646 # C99 inttypes.h. We always have inttypes.h available with MSVC
647 # (either the one bundled with MSVC 2013, or the one we bundle
648 # ourselves), but we can't just define __STDC_VERSION__ without
649 # breaking stuff, as MSVC doesn't fully support C99. There's also no
650 # way to premptively include stdint.
651 env
.Append(CCFLAGS
= ['-FIinttypes.h'])
652 if host_platform
.system() == 'Windows':
653 # Prefer winflexbison binaries, as not only they are easier to install
654 # (no additional dependencies), but also better Windows support.
655 if check_prog(env
, 'win_flex'):
656 env
["LEX"] = 'win_flex'
657 env
.Append(LEXFLAGS
= [
658 # windows compatibility (uses <io.h> instead of <unistd.h> and
659 # _isatty, _fileno functions)
664 if host_platform
.system() == 'Windows':
665 if check_prog(env
, 'win_bison'):
666 env
["YACC"] = 'win_bison'
671 # Custom builders and methods
673 env
.AddMethod(install_program
, 'InstallProgram')
674 env
.AddMethod(install_shared_library
, 'InstallSharedLibrary')
675 env
.AddMethod(msvc2013_compat
, 'MSVC2013Compat')
676 env
.AddMethod(unit_test
, 'UnitTest')
678 env
.PkgCheckModules('X11', ['x11', 'xext', 'xdamage >= 1.1', 'xfixes', 'glproto >= 1.4.13', 'dri2proto >= 2.8'])
679 env
.PkgCheckModules('XCB', ['x11-xcb', 'xcb-glx >= 1.8.1', 'xcb-dri2 >= 1.8'])
680 env
.PkgCheckModules('XF86VIDMODE', ['xxf86vm'])
681 env
.PkgCheckModules('DRM', ['libdrm >= 2.4.75'])
684 env
.Append(CPPPATH
= env
['X11_CPPPATH'])
686 env
['dri'] = env
['x11'] and env
['drm']