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_prog(env
, prog
):
161 """Check whether this program exists."""
163 sys
.stdout
.write('Checking for %s ... ' % prog
)
165 result
= env
.Detect(prog
)
167 sys
.stdout
.write(' %s\n' % ['no', 'yes'][int(bool(result
))])
172 """Common environment generation code"""
174 # Tell tools which machine to compile for
175 env
['TARGET_ARCH'] = env
['machine']
176 env
['MSVS_ARCH'] = env
['machine']
179 platform
= env
['platform']
180 env
.Tool(env
['toolchain'])
182 # Allow override compiler and specify additional flags from environment
183 if os
.environ
.has_key('CC'):
184 env
['CC'] = os
.environ
['CC']
185 if os
.environ
.has_key('CFLAGS'):
186 env
['CCFLAGS'] += SCons
.Util
.CLVar(os
.environ
['CFLAGS'])
187 if os
.environ
.has_key('CXX'):
188 env
['CXX'] = os
.environ
['CXX']
189 if os
.environ
.has_key('CXXFLAGS'):
190 env
['CXXFLAGS'] += SCons
.Util
.CLVar(os
.environ
['CXXFLAGS'])
191 if os
.environ
.has_key('LDFLAGS'):
192 env
['LINKFLAGS'] += SCons
.Util
.CLVar(os
.environ
['LDFLAGS'])
194 # Detect gcc/clang not by executable name, but through pre-defined macros
195 # as autoconf does, to avoid drawing wrong conclusions when using tools
196 # that overrice CC/CXX like scan-build.
197 env
['gcc_compat'] = 0
200 if host_platform
.system() == 'Windows':
201 env
['msvc'] = check_cc(env
, 'MSVC', 'defined(_MSC_VER)', '/E')
203 env
['gcc_compat'] = check_cc(env
, 'GCC', 'defined(__GNUC__)')
204 env
['clang'] = check_cc(env
, 'Clang', '__clang__')
205 env
['gcc'] = env
['gcc_compat'] and not env
['clang']
206 env
['suncc'] = env
['platform'] == 'sunos' and os
.path
.basename(env
['CC']) == 'cc'
207 env
['icc'] = 'icc' == os
.path
.basename(env
['CC'])
209 if env
['msvc'] and env
['toolchain'] == 'default' and env
['machine'] == 'x86_64':
210 # MSVC x64 support is broken in earlier versions of scons
211 env
.EnsurePythonVersion(2, 0)
214 machine
= env
['machine']
215 platform
= env
['platform']
216 x86
= env
['machine'] == 'x86'
217 ppc
= env
['machine'] == 'ppc'
218 gcc_compat
= env
['gcc_compat']
223 # Determine whether we are cross compiling; in particular, whether we need
224 # to compile code generators with a different compiler as the target code.
225 hosthost_platform
= host_platform
.system().lower()
226 if hosthost_platform
.startswith('cygwin'):
227 hosthost_platform
= 'cygwin'
228 host_machine
= os
.environ
.get('PROCESSOR_ARCHITEW6432', os
.environ
.get('PROCESSOR_ARCHITECTURE', host_platform
.machine()))
238 }.get(host_machine
, 'generic')
239 env
['crosscompile'] = platform
!= hosthost_platform
240 if machine
== 'x86_64' and host_machine
!= 'x86_64':
241 env
['crosscompile'] = True
242 env
['hostonly'] = False
244 # Backwards compatability with the debug= profile= options
245 if env
['build'] == 'debug':
247 print 'scons: warning: debug option is deprecated and will be removed eventually; use instead'
249 print ' scons build=release'
251 env
['build'] = 'release'
253 print 'scons: warning: profile option is deprecated and will be removed eventually; use instead'
255 print ' scons build=profile'
257 env
['build'] = 'profile'
259 # Enforce SConscripts to use the new build variable
261 env
.popitem('profile')
263 # Backwards portability with older sconscripts
264 if env
['build'] in ('debug', 'checked'):
266 env
['profile'] = False
267 if env
['build'] == 'profile':
269 env
['profile'] = True
270 if env
['build'] in ('release', 'opt'):
272 env
['profile'] = False
274 # Put build output in a separate dir, which depends on the current
275 # configuration. See also http://www.scons.org/wiki/AdvancedBuildExample
276 build_topdir
= 'build'
277 build_subdir
= env
['platform']
279 build_subdir
= 'embedded-' + build_subdir
280 if env
['machine'] != 'generic':
281 build_subdir
+= '-' + env
['machine']
282 if env
['build'] != 'release':
283 build_subdir
+= '-' + env
['build']
284 build_dir
= os
.path
.join(build_topdir
, build_subdir
)
285 # Place the .sconsign file in the build dir too, to avoid issues with
286 # different scons versions building the same source file
287 env
['build_dir'] = build_dir
288 env
.SConsignFile(os
.path
.join(build_dir
, '.sconsign'))
289 if 'SCONS_CACHE_DIR' in os
.environ
:
290 print 'scons: Using build cache in %s.' % (os
.environ
['SCONS_CACHE_DIR'],)
291 env
.CacheDir(os
.environ
['SCONS_CACHE_DIR'])
292 env
['CONFIGUREDIR'] = os
.path
.join(build_dir
, 'conf')
293 env
['CONFIGURELOG'] = os
.path
.join(os
.path
.abspath(build_dir
), 'config.log')
296 if env
.GetOption('num_jobs') <= 1:
297 env
.SetOption('num_jobs', num_jobs())
299 env
.Decider('MD5-timestamp')
300 env
.SetOption('max_drift', 60)
302 # C preprocessor options
305 '__STDC_CONSTANT_MACROS',
306 '__STDC_FORMAT_MACROS',
307 '__STDC_LIMIT_MACROS',
310 if env
['build'] in ('debug', 'checked'):
311 cppdefines
+= ['DEBUG']
313 cppdefines
+= ['NDEBUG']
314 if env
['build'] == 'profile':
315 cppdefines
+= ['PROFILE']
316 if env
['build'] in ('opt', 'profile'):
317 cppdefines
+= ['VMX86_STATS']
318 if env
['platform'] in ('posix', 'linux', 'freebsd', 'darwin'):
321 ('_POSIX_C_SOURCE', '199309L'),
327 if env
['platform'] == 'darwin':
331 'GLX_DIRECT_RENDERING',
335 'GLX_DIRECT_RENDERING',
336 'GLX_INDIRECT_RENDERING',
339 if check_header(env
, 'xlocale.h'):
340 cppdefines
+= ['HAVE_XLOCALE_H']
342 if platform
== 'windows':
348 # http://msdn.microsoft.com/en-us/library/aa383745.aspx
349 ('_WIN32_WINNT', '0x0601'),
350 ('WINVER', '0x0601'),
353 cppdefines
+= [('__MSVCRT_VERSION__', '0x0700')]
358 '_CRT_SECURE_NO_WARNINGS',
359 '_CRT_SECURE_NO_DEPRECATE',
360 '_SCL_SECURE_NO_WARNINGS',
361 '_SCL_SECURE_NO_DEPRECATE',
362 '_ALLOW_KEYWORD_MACROS',
363 '_HAS_EXCEPTIONS=0', # Tell C++ STL to not use exceptions
365 if env
['build'] in ('debug', 'checked'):
366 cppdefines
+= ['_DEBUG']
367 if platform
== 'windows':
368 cppdefines
+= ['PIPE_SUBSYSTEM_WINDOWS_USER']
370 cppdefines
+= ['PIPE_SUBSYSTEM_EMBEDDED']
371 if env
['texture_float']:
372 print 'warning: Floating-point textures enabled.'
373 print 'warning: Please consult docs/patents.txt with your lawyer before building Mesa.'
374 cppdefines
+= ['TEXTURE_FLOAT_ENABLED']
375 env
.Append(CPPDEFINES
= cppdefines
)
380 ccflags
= [] # C & C++
382 if env
['build'] == 'debug':
387 # gcc's builtin memcmp is slower than glibc's
388 # http://gcc.gnu.org/bugzilla/show_bug.cgi?id=43052
389 ccflags
+= ['-fno-builtin-memcmp']
390 # Work around aliasing bugs - developers should comment this out
391 ccflags
+= ['-fno-strict-aliasing']
393 if env
['build'] in ('checked', 'profile') or env
['asan']:
394 # See http://code.google.com/p/jrfonseca/wiki/Gprof2Dot#Which_options_should_I_pass_to_gcc_when_compiling_for_profiling?
396 '-fno-omit-frame-pointer',
399 ccflags
+= ['-fno-optimize-sibling-calls']
400 if env
['machine'] == 'x86':
405 if platform
!= 'haiku':
406 # NOTE: We need to ensure stack is realigned given that we
407 # produce shared objects, and have no control over the stack
408 # alignment policy of the application. Therefore we need
409 # -mstackrealign ore -mincoming-stack-boundary=2.
411 # XXX: We could have SSE without -mstackrealign if we always used
412 # __attribute__((force_align_arg_pointer)), but that's not
415 '-mstackrealign', # ensure stack is aligned
416 '-msse', '-msse2', # enable SIMD intrinsics
417 '-mfpmath=sse', # generate SSE floating-point arithmetic
419 if platform
in ['windows', 'darwin']:
420 # Workaround http://gcc.gnu.org/bugzilla/show_bug.cgi?id=37216
421 ccflags
+= ['-fno-common']
422 if platform
in ['haiku']:
423 # Make optimizations compatible with Pentium or higher on Haiku
425 '-mstackrealign', # ensure stack is aligned
426 '-march=i586', # Haiku target is Pentium
427 '-mtune=i686' # use i686 where we can
429 if env
['machine'] == 'x86_64':
431 if platform
== 'darwin':
432 ccflags
+= ['-fno-common']
433 if env
['platform'] not in ('cygwin', 'haiku', 'windows'):
434 ccflags
+= ['-fvisibility=hidden']
436 # - http://gcc.gnu.org/onlinedocs/gcc/Warning-Options.html
440 '-fmessage-length=0', # be nice to Eclipse
443 '-Wmissing-prototypes',
452 # - http://msdn.microsoft.com/en-us/library/19z1t1wy.aspx
454 if env
['build'] == 'debug':
456 '/Od', # disable optimizations
457 '/Oi', # enable intrinsic functions
461 '/O2', # optimize for speed
463 if env
['build'] in ('release', 'opt'):
466 '/GL', # enable whole program optimization
470 '/Oy-', # disable frame pointer omission
473 '/W3', # warning level
474 '/wd4018', # signed/unsigned mismatch
475 '/wd4056', # overflow in floating-point constant arithmetic
476 '/wd4244', # conversion from 'type1' to 'type2', possible loss of data
477 '/wd4267', # 'var' : conversion from 'size_t' to 'type', possible loss of data
478 '/wd4305', # truncation from 'type1' to 'type2'
479 '/wd4351', # new behavior: elements of array 'array' will be default initialized
480 '/wd4756', # overflow in constant arithmetic
481 '/wd4800', # forcing value to bool 'true' or 'false' (performance warning)
482 '/wd4996', # disable deprecated POSIX name warnings
486 '-Wno-microsoft-enum-value', # enumerator value is not representable in underlying type 'int'
488 if env
['machine'] == 'x86':
490 '/arch:SSE2', # use the SSE2 instructions (default since MSVC 2012)
492 if platform
== 'windows':
496 # Automatic pdb generation
497 # See http://scons.tigris.org/issues/show_bug.cgi?id=1656
498 env
.EnsureSConsVersion(0, 98, 0)
499 env
['PDB'] = '${TARGET.base}.pdb'
500 env
.Append(CCFLAGS
= ccflags
)
501 env
.Append(CFLAGS
= cflags
)
502 env
.Append(CXXFLAGS
= cxxflags
)
504 if env
['platform'] == 'windows' and msvc
:
505 # Choose the appropriate MSVC CRT
506 # http://msdn.microsoft.com/en-us/library/2kzt1wy3.aspx
507 if env
['build'] in ('debug', 'checked'):
508 env
.Append(CCFLAGS
= ['/MTd'])
509 env
.Append(SHCCFLAGS
= ['/LDd'])
511 env
.Append(CCFLAGS
= ['/MT'])
512 env
.Append(SHCCFLAGS
= ['/LD'])
514 # Static code analysis
517 # http://msdn.microsoft.com/en-us/library/ms173498.aspx
518 env
.Append(CCFLAGS
= [
520 #'/analyze:log', '${TARGET.base}.xml',
521 '/wd28251', # Inconsistent annotation for function
524 # scan-build will produce more comprehensive output
525 env
.Append(CCFLAGS
= ['--analyze'])
527 # https://github.com/google/sanitizers/wiki/AddressSanitizer
530 env
.Append(CCFLAGS
= [
531 '-fsanitize=address',
533 env
.Append(LINKFLAGS
= [
534 '-fsanitize=address',
539 if env
['machine'] == 'x86':
540 env
.Append(ASFLAGS
= ['-m32'])
541 if env
['machine'] == 'x86_64':
542 env
.Append(ASFLAGS
= ['-m64'])
548 if env
['machine'] == 'x86':
549 linkflags
+= ['-m32']
550 if env
['machine'] == 'x86_64':
551 linkflags
+= ['-m64']
552 if env
['platform'] not in ('darwin'):
556 # Handle circular dependencies in the libraries
557 if env
['platform'] in ('darwin'):
560 env
['_LIBFLAGS'] = '-Wl,--start-group ' + env
['_LIBFLAGS'] + ' -Wl,--end-group'
561 if env
['platform'] == 'windows':
563 '-Wl,--nxcompat', # DEP
564 '-Wl,--dynamicbase', # ASLR
566 # Avoid depending on gcc runtime DLLs
567 linkflags
+= ['-static-libgcc']
568 if 'w64' in env
['CC'].split('-'):
569 linkflags
+= ['-static-libstdc++']
570 # Handle the @xx symbol munging of DLL exports
571 shlinkflags
+= ['-Wl,--enable-stdcall-fixup']
572 #shlinkflags += ['-Wl,--kill-at']
574 if env
['build'] in ('release', 'opt') and not env
['clang']:
575 # enable Link-time Code Generation
576 linkflags
+= ['/LTCG']
577 env
.Append(ARFLAGS
= ['/LTCG'])
578 if platform
== 'windows' and msvc
:
580 # - http://msdn2.microsoft.com/en-us/library/y0zzbyt4.aspx
584 '/dynamicbase', # ASLR
587 env
.Append(LINKFLAGS
= linkflags
)
588 env
.Append(SHLINKFLAGS
= shlinkflags
)
590 # We have C++ in several libraries, so always link with the C++ compiler
592 env
['LINK'] = env
['CXX']
596 if env
['platform'] in ('darwin', 'freebsd', 'linux', 'posix', 'sunos'):
597 libs
+= ['m', 'pthread', 'dl']
598 if env
['platform'] in ('linux',):
600 if env
['platform'] in ('haiku'):
601 libs
+= ['root', 'be', 'network', 'translation']
602 env
.Append(LIBS
= libs
)
607 env
.Append(CCFLAGS
= ['/openmp'])
608 # When building openmp release VS2008 link.exe crashes with LNK1103 error.
609 # Workaround: overwrite PDB flags with empty value as it isn't required anyways
610 if env
['build'] == 'release':
613 env
.Append(CCFLAGS
= ['-fopenmp'])
614 env
.Append(LIBS
= ['gomp'])
619 env
.Append(LEXFLAGS
= [
620 # Force flex to use const keyword in prototypes, as relies on
621 # __cplusplus or __STDC__ macro to determine whether it's safe to
622 # use const keyword, but MSVC never defines __STDC__ unless we
623 # disable all MSVC extensions.
626 # Flex relies on __STDC_VERSION__>=199901L to decide when to include
627 # C99 inttypes.h. We always have inttypes.h available with MSVC
628 # (either the one bundled with MSVC 2013, or the one we bundle
629 # ourselves), but we can't just define __STDC_VERSION__ without
630 # breaking stuff, as MSVC doesn't fully support C99. There's also no
631 # way to premptively include stdint.
632 env
.Append(CCFLAGS
= ['-FIinttypes.h'])
633 if host_platform
.system() == 'Windows':
634 # Prefer winflexbison binaries, as not only they are easier to install
635 # (no additional dependencies), but also better Windows support.
636 if check_prog(env
, 'win_flex'):
637 env
["LEX"] = 'win_flex'
638 env
.Append(LEXFLAGS
= [
639 # windows compatibility (uses <io.h> instead of <unistd.h> and
640 # _isatty, _fileno functions)
645 if host_platform
.system() == 'Windows':
646 if check_prog(env
, 'win_bison'):
647 env
["YACC"] = 'win_bison'
652 # Custom builders and methods
654 env
.AddMethod(install_program
, 'InstallProgram')
655 env
.AddMethod(install_shared_library
, 'InstallSharedLibrary')
656 env
.AddMethod(msvc2013_compat
, 'MSVC2013Compat')
657 env
.AddMethod(unit_test
, 'UnitTest')
659 env
.PkgCheckModules('X11', ['x11', 'xext', 'xdamage >= 1.1', 'xfixes', 'glproto >= 1.4.13', 'dri2proto >= 2.8'])
660 env
.PkgCheckModules('XCB', ['x11-xcb', 'xcb-glx >= 1.8.1', 'xcb-dri2 >= 1.8'])
661 env
.PkgCheckModules('XF86VIDMODE', ['xxf86vm'])
662 env
.PkgCheckModules('DRM', ['libdrm >= 2.4.75'])
665 env
.Append(CPPPATH
= env
['X11_CPPPATH'])
667 env
['dri'] = env
['x11'] and env
['drm']