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
).encode())
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 # Avoid spurious crosscompilation in MSYS2 environment.
241 if hosthost_platform
.startswith('mingw'):
242 hosthost_platform
= 'windows'
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'] == 'release':
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 # Speed up dependency checking. See
315 # - https://github.com/SCons/scons/wiki/GoFastButton
316 # - https://bugs.freedesktop.org/show_bug.cgi?id=109443
318 # Scons version string has consistently been in this format:
319 # MajorVersion.MinorVersion.Patch[.alpha/beta.yyyymmdd]
320 # so this formula should cover all versions regardless of type
321 # stable, alpha or beta.
322 # For simplicity alpha and beta flags are removed.
324 scons_version
= distutils
.version
.StrictVersion('.'.join(SCons
.__version
__.split('.')[:3]))
325 if scons_version
< distutils
.version
.StrictVersion('3.0.2') or \
326 scons_version
> distutils
.version
.StrictVersion('3.0.4'):
327 env
.Decider('MD5-timestamp')
328 env
.SetOption('max_drift', 60)
330 # C preprocessor options
333 '__STDC_CONSTANT_MACROS',
334 '__STDC_FORMAT_MACROS',
335 '__STDC_LIMIT_MACROS',
338 if env
['build'] in ('debug', 'checked'):
339 cppdefines
+= ['DEBUG']
341 cppdefines
+= ['NDEBUG']
342 if env
['build'] == 'profile':
343 cppdefines
+= ['PROFILE']
344 if env
['platform'] in ('posix', 'linux', 'freebsd', 'darwin'):
347 ('_POSIX_C_SOURCE', '199309L'),
353 if env
['platform'] == 'darwin':
357 'GLX_DIRECT_RENDERING',
362 'GLX_DIRECT_RENDERING',
363 'GLX_INDIRECT_RENDERING',
366 if check_header(env
, 'xlocale.h'):
367 cppdefines
+= ['HAVE_XLOCALE_H']
369 if check_header(env
, 'endian.h'):
370 cppdefines
+= ['HAVE_ENDIAN_H']
372 if check_functions(env
, ['strtod_l', 'strtof_l']):
373 cppdefines
+= ['HAVE_STRTOD_L']
375 if check_functions(env
, ['random_r']):
376 cppdefines
+= ['HAVE_RANDOM_R']
378 if check_functions(env
, ['timespec_get']):
379 cppdefines
+= ['HAVE_TIMESPEC_GET']
381 if check_header(env
, 'sys/shm.h'):
382 cppdefines
+= ['HAVE_SYS_SHM_H']
384 if check_functions(env
, ['strtok_r']):
385 cppdefines
+= ['HAVE_STRTOK_R']
387 #FIXME: we should really be checking for the major()/minor()
388 # functions/macros in these headers, but check_functions()'s
389 # SConf.CheckFunc() doesn't seem to support macros.
390 if check_header(env
, 'sys/mkdev.h'):
391 cppdefines
+= ['MAJOR_IN_MKDEV']
392 if check_header(env
, 'sys/sysmacros.h'):
393 cppdefines
+= ['MAJOR_IN_SYSMACROS']
395 if platform
== 'windows':
401 # http://msdn.microsoft.com/en-us/library/aa383745.aspx
402 ('_WIN32_WINNT', '0x0601'),
403 ('WINVER', '0x0601'),
406 cppdefines
+= [('__MSVCRT_VERSION__', '0x0700')]
411 '_CRT_SECURE_NO_WARNINGS',
412 '_CRT_SECURE_NO_DEPRECATE',
413 '_SCL_SECURE_NO_WARNINGS',
414 '_SCL_SECURE_NO_DEPRECATE',
415 '_ALLOW_KEYWORD_MACROS',
416 '_HAS_EXCEPTIONS=0', # Tell C++ STL to not use exceptions
418 if env
['build'] in ('debug', 'checked'):
419 cppdefines
+= ['_DEBUG']
421 cppdefines
+= ['EMBEDDED_DEVICE']
422 env
.Append(CPPDEFINES
= cppdefines
)
427 ccflags
= [] # C & C++
429 if env
['build'] == 'debug':
434 # gcc's builtin memcmp is slower than glibc's
435 # http://gcc.gnu.org/bugzilla/show_bug.cgi?id=43052
436 ccflags
+= ['-fno-builtin-memcmp']
437 # Work around aliasing bugs - developers should comment this out
438 ccflags
+= ['-fno-strict-aliasing']
440 if env
['build'] in ('checked', 'profile') or env
['asan']:
441 # See http://code.google.com/p/jrfonseca/wiki/Gprof2Dot#Which_options_should_I_pass_to_gcc_when_compiling_for_profiling?
443 '-fno-omit-frame-pointer',
446 ccflags
+= ['-fno-optimize-sibling-calls']
447 if env
['machine'] == 'x86':
452 if platform
!= 'haiku':
453 # NOTE: We need to ensure stack is realigned given that we
454 # produce shared objects, and have no control over the stack
455 # alignment policy of the application. Therefore we need
456 # -mstackrealign ore -mincoming-stack-boundary=2.
458 # XXX: We could have SSE without -mstackrealign if we always used
459 # __attribute__((force_align_arg_pointer)), but that's not
462 '-mstackrealign', # ensure stack is aligned
463 '-msse', '-msse2', # enable SIMD intrinsics
464 '-mfpmath=sse', # generate SSE floating-point arithmetic
466 if platform
in ['windows', 'darwin']:
467 # Workaround http://gcc.gnu.org/bugzilla/show_bug.cgi?id=37216
468 ccflags
+= ['-fno-common']
469 if platform
in ['haiku']:
470 # Make optimizations compatible with Pentium or higher on Haiku
472 '-mstackrealign', # ensure stack is aligned
473 '-march=i586', # Haiku target is Pentium
474 '-mtune=i686' # use i686 where we can
476 if env
['machine'] == 'x86_64':
478 if platform
== 'darwin':
479 ccflags
+= ['-fno-common']
480 if env
['platform'] not in ('cygwin', 'haiku', 'windows'):
481 ccflags
+= ['-fvisibility=hidden']
483 # - http://gcc.gnu.org/onlinedocs/gcc/Warning-Options.html
487 '-fmessage-length=0', # be nice to Eclipse
490 '-Werror=implicit-function-declaration',
491 '-Werror=missing-prototypes',
492 '-Werror=return-type',
493 '-Werror=incompatible-pointer-types',
495 if platform
== 'darwin' and host_platform
.mac_ver()[0] >= '10.15':
496 cflags
+= ['-std=gnu11']
498 cflags
+= ['-std=gnu99']
505 # - http://msdn.microsoft.com/en-us/library/19z1t1wy.aspx
507 if env
['build'] == 'debug':
509 '/Od', # disable optimizations
510 '/Oi', # enable intrinsic functions
514 '/O2', # optimize for speed
516 if env
['build'] == 'release':
519 '/GL', # enable whole program optimization
523 '/Oy-', # disable frame pointer omission
526 '/W3', # warning level
527 '/wd4018', # signed/unsigned mismatch
528 '/wd4056', # overflow in floating-point constant arithmetic
529 '/wd4244', # conversion from 'type1' to 'type2', possible loss of data
530 '/wd4267', # 'var' : conversion from 'size_t' to 'type', possible loss of data
531 '/wd4305', # truncation from 'type1' to 'type2'
532 '/wd4351', # new behavior: elements of array 'array' will be default initialized
533 '/wd4756', # overflow in constant arithmetic
534 '/wd4800', # forcing value to bool 'true' or 'false' (performance warning)
535 '/wd4996', # disable deprecated POSIX name warnings
539 '-Wno-microsoft-enum-value', # enumerator value is not representable in underlying type 'int'
541 if env
['machine'] == 'x86':
543 '/arch:SSE2', # use the SSE2 instructions (default since MSVC 2012)
545 if platform
== 'windows':
549 # Automatic pdb generation
550 # See http://scons.tigris.org/issues/show_bug.cgi?id=1656
551 env
.EnsureSConsVersion(0, 98, 0)
552 env
['PDB'] = '${TARGET.base}.pdb'
553 env
.Append(CCFLAGS
= ccflags
)
554 env
.Append(CFLAGS
= cflags
)
555 env
.Append(CXXFLAGS
= cxxflags
)
557 if env
['platform'] == 'windows' and msvc
:
558 # Choose the appropriate MSVC CRT
559 # http://msdn.microsoft.com/en-us/library/2kzt1wy3.aspx
560 if env
['build'] in ('debug', 'checked'):
561 env
.Append(CCFLAGS
= ['/MTd'])
562 env
.Append(SHCCFLAGS
= ['/LDd'])
564 env
.Append(CCFLAGS
= ['/MT'])
565 env
.Append(SHCCFLAGS
= ['/LD'])
567 # Static code analysis
570 # http://msdn.microsoft.com/en-us/library/ms173498.aspx
571 env
.Append(CCFLAGS
= [
573 #'/analyze:log', '${TARGET.base}.xml',
574 '/wd28251', # Inconsistent annotation for function
577 # scan-build will produce more comprehensive output
578 env
.Append(CCFLAGS
= ['--analyze'])
580 # https://github.com/google/sanitizers/wiki/AddressSanitizer
583 env
.Append(CCFLAGS
= [
584 '-fsanitize=address',
586 env
.Append(LINKFLAGS
= [
587 '-fsanitize=address',
592 if env
['machine'] == 'x86':
593 env
.Append(ASFLAGS
= ['-m32'])
594 if env
['machine'] == 'x86_64':
595 env
.Append(ASFLAGS
= ['-m64'])
601 if env
['machine'] == 'x86':
602 linkflags
+= ['-m32']
603 if env
['machine'] == 'x86_64':
604 linkflags
+= ['-m64']
605 if env
['platform'] not in ('darwin'):
609 # Handle circular dependencies in the libraries
610 if env
['platform'] in ('darwin'):
613 env
['_LIBFLAGS'] = '-Wl,--start-group ' + env
['_LIBFLAGS'] + ' -Wl,--end-group'
614 if env
['platform'] == 'windows':
616 '-Wl,--nxcompat', # DEP
617 '-Wl,--dynamicbase', # ASLR
619 # Avoid depending on gcc runtime DLLs
620 linkflags
+= ['-static-libgcc']
621 if 'w64' in env
['CC'].split('-'):
622 linkflags
+= ['-static-libstdc++']
623 # Handle the @xx symbol munging of DLL exports
624 shlinkflags
+= ['-Wl,--enable-stdcall-fixup']
625 #shlinkflags += ['-Wl,--kill-at']
627 if env
['build'] == 'release' and not env
['clang']:
628 # enable Link-time Code Generation
629 linkflags
+= ['/LTCG']
630 env
.Append(ARFLAGS
= ['/LTCG'])
631 if platform
== 'windows' and msvc
:
633 # - http://msdn2.microsoft.com/en-us/library/y0zzbyt4.aspx
637 '/dynamicbase', # ASLR
640 env
.Append(LINKFLAGS
= linkflags
)
641 env
.Append(SHLINKFLAGS
= shlinkflags
)
643 # We have C++ in several libraries, so always link with the C++ compiler
645 env
['LINK'] = env
['CXX']
649 if env
['platform'] in ('darwin', 'freebsd', 'linux', 'posix', 'sunos'):
650 libs
+= ['m', 'pthread', 'dl']
651 if env
['platform'] in ('linux',):
653 if env
['platform'] in ('haiku'):
654 libs
+= ['root', 'be', 'network', 'translation']
655 env
.Append(LIBS
= libs
)
660 env
.Append(CCFLAGS
= ['/openmp'])
661 # When building openmp release VS2008 link.exe crashes with LNK1103 error.
662 # Workaround: overwrite PDB flags with empty value as it isn't required anyways
663 if env
['build'] == 'release':
666 env
.Append(CCFLAGS
= ['-fopenmp'])
667 env
.Append(LIBS
= ['gomp'])
672 env
.Append(LEXFLAGS
= [
673 # Force flex to use const keyword in prototypes, as relies on
674 # __cplusplus or __STDC__ macro to determine whether it's safe to
675 # use const keyword, but MSVC never defines __STDC__ unless we
676 # disable all MSVC extensions.
679 # Flex relies on __STDC_VERSION__>=199901L to decide when to include
680 # C99 inttypes.h. We always have inttypes.h available with MSVC
681 # (either the one bundled with MSVC 2013, or the one we bundle
682 # ourselves), but we can't just define __STDC_VERSION__ without
683 # breaking stuff, as MSVC doesn't fully support C99. There's also no
684 # way to premptively include stdint.
685 env
.Append(CCFLAGS
= ['-FIinttypes.h'])
686 if host_platform
.system() == 'Windows':
687 # Prefer winflexbison binaries, as not only they are easier to install
688 # (no additional dependencies), but also better Windows support.
689 if check_prog(env
, 'win_flex'):
690 env
["LEX"] = 'win_flex'
691 env
.Append(LEXFLAGS
= [
692 # windows compatibility (uses <io.h> instead of <unistd.h> and
693 # _isatty, _fileno functions)
698 if host_platform
.system() == 'Windows':
699 if check_prog(env
, 'win_bison'):
700 env
["YACC"] = 'win_bison'
705 # Custom builders and methods
707 env
.AddMethod(install_program
, 'InstallProgram')
708 env
.AddMethod(install_shared_library
, 'InstallSharedLibrary')
709 env
.AddMethod(msvc2013_compat
, 'MSVC2013Compat')
710 env
.AddMethod(unit_test
, 'UnitTest')
712 env
.PkgCheckModules('X11', ['x11', 'xext', 'xdamage >= 1.1', 'xfixes', 'glproto >= 1.4.13', 'dri2proto >= 2.8'])
713 env
.PkgCheckModules('XCB', ['x11-xcb', 'xcb-glx >= 1.8.1', 'xcb-dri2 >= 1.8'])
714 env
.PkgCheckModules('XF86VIDMODE', ['xxf86vm'])
715 env
.PkgCheckModules('DRM', ['libdrm >= 2.4.75'])
717 if not os
.path
.exists("src/util/format_srgb.c"):
718 print("Checking for Python Mako module (>= 0.8.0)... ", end
='')
724 if distutils
.version
.StrictVersion(mako
.__version
__) < distutils
.version
.StrictVersion('0.8.0'):
730 env
.Append(CPPPATH
= env
['X11_CPPPATH'])
732 env
['dri'] = env
['x11'] and env
['drm']