blob: efe32e06c6c99fcb8d52d8847e92c99c5282c6ad [file] [log] [blame]
José Fonsecab04aa712008-06-06 14:48:57 +09001"""gallium
2
3Frontend-tool for Gallium3D architecture.
4
5"""
6
José Fonseca381e3482008-07-17 11:23:43 +09007#
José Fonseca87712852014-01-17 16:27:50 +00008# Copyright 2008 VMware, Inc.
José Fonsecab04aa712008-06-06 14:48:57 +09009# All Rights Reserved.
José Fonseca381e3482008-07-17 11:23:43 +090010#
José Fonsecab04aa712008-06-06 14:48:57 +090011# 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:
José Fonseca381e3482008-07-17 11:23:43 +090018#
José Fonsecab04aa712008-06-06 14:48:57 +090019# The above copyright notice and this permission notice (including the
20# next paragraph) shall be included in all copies or substantial portions
21# of the Software.
José Fonseca381e3482008-07-17 11:23:43 +090022#
José Fonsecab04aa712008-06-06 14:48:57 +090023# 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.
José Fonseca87712852014-01-17 16:27:50 +000026# IN NO EVENT SHALL VMWARE AND/OR ITS SUPPLIERS BE LIABLE FOR
José Fonsecab04aa712008-06-06 14:48:57 +090027# 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.
José Fonseca381e3482008-07-17 11:23:43 +090030#
José Fonsecab04aa712008-06-06 14:48:57 +090031
Dylan Bakerc7821682018-08-14 10:32:12 -070032from __future__ import print_function
José Fonsecab04aa712008-06-06 14:48:57 +090033
Vinson Lee7d29afb2010-01-26 22:56:58 -080034import distutils.version
José Fonseca27d8d6f2008-07-03 12:42:23 +090035import os
José Fonsecab04aa712008-06-06 14:48:57 +090036import os.path
José Fonseca27d8d6f2008-07-03 12:42:23 +090037import re
Alan Hourihane1ecf5052010-01-27 12:46:46 +000038import subprocess
Jose Fonseca9c1c6572015-03-19 13:30:19 +000039import platform as host_platform
José Fonseca97fa9cd2014-04-16 17:26:05 +010040import sys
41import tempfile
José Fonsecab04aa712008-06-06 14:48:57 +090042
43import SCons.Action
44import SCons.Builder
José Fonseca27d8d6f2008-07-03 12:42:23 +090045import SCons.Scanner
José Fonsecab04aa712008-06-06 14:48:57 +090046
José Fonseca27d8d6f2008-07-03 12:42:23 +090047
José Fonseca52c2dd12008-09-08 07:54:15 +090048def 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):
52 os.remove(target)
53 os.symlink(os.path.basename(source), target)
54
José Fonseca8a318ed2010-01-01 22:35:28 +000055def install(env, source, subdir):
José Fonseca67450f02010-09-29 14:08:53 +010056 target_dir = os.path.join(env.Dir('#.').srcnode().abspath, env['build_dir'], subdir)
José Fonseca265b5392010-11-02 14:20:12 +000057 return env.Install(target_dir, source)
José Fonsecab5a408b2009-12-23 15:21:56 +000058
José Fonseca8a318ed2010-01-01 22:35:28 +000059def install_program(env, source):
José Fonseca265b5392010-11-02 14:20:12 +000060 return install(env, source, 'bin')
José Fonseca8a318ed2010-01-01 22:35:28 +000061
62def install_shared_library(env, sources, version = ()):
José Fonseca265b5392010-11-02 14:20:12 +000063 targets = []
José Fonseca67450f02010-09-29 14:08:53 +010064 install_dir = os.path.join(env.Dir('#.').srcnode().abspath, env['build_dir'])
José Fonseca52c2dd12008-09-08 07:54:15 +090065 version = tuple(map(str, version))
José Fonseca8a318ed2010-01-01 22:35:28 +000066 if env['SHLIBSUFFIX'] == '.dll':
67 dlls = env.FindIxes(sources, 'SHLIBPREFIX', 'SHLIBSUFFIX')
José Fonseca265b5392010-11-02 14:20:12 +000068 targets += install(env, dlls, 'bin')
José Fonseca8a318ed2010-01-01 22:35:28 +000069 libs = env.FindIxes(sources, 'LIBPREFIX', 'LIBSUFFIX')
José Fonseca265b5392010-11-02 14:20:12 +000070 targets += install(env, libs, 'lib')
José Fonsecab2e40642010-01-01 21:54:51 +000071 else:
José Fonseca8a318ed2010-01-01 22:35:28 +000072 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)
José Fonseca265b5392010-11-02 14:20:12 +000076 targets += last
José Fonseca8a318ed2010-01-01 22:35:28 +000077 while len(version):
78 version = version[:-1]
79 target_name = '.'.join((str(source),) + version)
José Fonseca37058c32011-05-04 14:10:24 +010080 action = SCons.Action.Action(symlink, " Symlinking $TARGET ...")
José Fonseca8a318ed2010-01-01 22:35:28 +000081 last = env.Command(os.path.join(target_dir, target_name), last, action)
José Fonseca265b5392010-11-02 14:20:12 +000082 targets += last
83 return targets
84
José Fonseca52c2dd12008-09-08 07:54:15 +090085
Jose Fonseca00faf9f2015-03-04 14:23:52 +000086def msvc2013_compat(env):
87 if env['gcc']:
88 env.Append(CCFLAGS = [
89 '-Werror=vla',
90 '-Werror=pointer-arith',
91 ])
92
Jose Fonseca50ddf032016-04-13 13:31:04 +010093
94def unit_test(env, test_name, program_target, args=None):
95 env.InstallProgram(program_target)
96
97 cmd = [program_target[0].abspath]
98 if args is not None:
99 cmd += args
100 cmd = ' '.join(cmd)
101
102 # http://www.scons.org/wiki/UnitTests
Jose Fonseca7d2151b2016-04-14 13:41:33 +0100103 action = SCons.Action.Action(cmd, " Running $SOURCE ...")
Jose Fonseca50ddf032016-04-13 13:31:04 +0100104 alias = env.Alias(test_name, program_target, action)
105 env.AlwaysBuild(alias)
106 env.Depends('check', alias)
Jose Fonseca00faf9f2015-03-04 14:23:52 +0000107
108
José Fonseca1e8177e2009-02-10 18:11:56 +0000109def num_jobs():
110 try:
111 return int(os.environ['NUMBER_OF_PROCESSORS'])
112 except (ValueError, KeyError):
113 pass
114
115 try:
116 return os.sysconf('SC_NPROCESSORS_ONLN')
117 except (ValueError, OSError, AttributeError):
118 pass
119
120 try:
121 return int(os.popen2("sysctl -n hw.ncpu")[1].read())
122 except ValueError:
123 pass
124
125 return 1
126
127
José Fonseca97fa9cd2014-04-16 17:26:05 +0100128def check_cc(env, cc, expr, cpp_opt = '-E'):
129 # Invoke C-preprocessor to determine whether the specified expression is
130 # true or not.
131
132 sys.stdout.write('Checking for %s ... ' % cc)
133
134 source = tempfile.NamedTemporaryFile(suffix='.c', delete=False)
135 source.write('#if !(%s)\n#error\n#endif\n' % expr)
136 source.close()
137
Jose Fonsecae10dc122018-03-19 16:41:57 +0100138 # sys.stderr.write('%r %s %s\n' % (env['CC'], cpp_opt, source.name));
139
140 pipe = SCons.Action._subproc(env, env.Split(env['CC']) + [cpp_opt, source.name],
José Fonseca97fa9cd2014-04-16 17:26:05 +0100141 stdin = 'devnull',
142 stderr = 'devnull',
143 stdout = 'devnull')
144 result = pipe.wait() == 0
145
146 os.unlink(source.name)
147
148 sys.stdout.write(' %s\n' % ['no', 'yes'][int(bool(result))])
149 return result
150
Eric Engestromb50b4b62017-07-10 13:27:25 +0100151def check_header(env, header):
152 '''Check if the header exist'''
153
154 conf = SCons.Script.Configure(env)
155 have_header = False
156
157 if conf.CheckHeader(header):
158 have_header = True
159
160 env = conf.Finish()
161 return have_header
José Fonseca97fa9cd2014-04-16 17:26:05 +0100162
Eric Engestrom49b42842017-08-31 16:55:56 +0000163def check_functions(env, functions):
164 '''Check if all of the functions exist'''
165
166 conf = SCons.Script.Configure(env)
167 have_functions = True
168
169 for function in functions:
170 if not conf.CheckFunc(function):
171 have_functions = False
172
173 env = conf.Finish()
174 return have_functions
175
Jose Fonseca9c1c6572015-03-19 13:30:19 +0000176def check_prog(env, prog):
177 """Check whether this program exists."""
178
179 sys.stdout.write('Checking for %s ... ' % prog)
180
181 result = env.Detect(prog)
182
183 sys.stdout.write(' %s\n' % ['no', 'yes'][int(bool(result))])
184 return result
185
186
José Fonsecab04aa712008-06-06 14:48:57 +0900187def generate(env):
José Fonseca381e3482008-07-17 11:23:43 +0900188 """Common environment generation code"""
José Fonsecab04aa712008-06-06 14:48:57 +0900189
José Fonseca051f8bb2011-02-11 16:29:01 +0000190 # Tell tools which machine to compile for
191 env['TARGET_ARCH'] = env['machine']
192 env['MSVS_ARCH'] = env['machine']
193
José Fonseca6cf59e12008-11-18 19:13:32 +0900194 # Toolchain
195 platform = env['platform']
José Fonseca6cf59e12008-11-18 19:13:32 +0900196 env.Tool(env['toolchain'])
197
José Fonseca601498a2010-11-01 13:30:22 +0000198 # Allow override compiler and specify additional flags from environment
Eric Engestrom29c8d752017-09-19 14:09:43 +0100199 if 'CC' in os.environ:
José Fonseca601498a2010-11-01 13:30:22 +0000200 env['CC'] = os.environ['CC']
Eric Engestrom29c8d752017-09-19 14:09:43 +0100201 if 'CFLAGS' in os.environ:
José Fonseca601498a2010-11-01 13:30:22 +0000202 env['CCFLAGS'] += SCons.Util.CLVar(os.environ['CFLAGS'])
Eric Engestrom29c8d752017-09-19 14:09:43 +0100203 if 'CXX' in os.environ:
José Fonseca601498a2010-11-01 13:30:22 +0000204 env['CXX'] = os.environ['CXX']
Eric Engestrom29c8d752017-09-19 14:09:43 +0100205 if 'CXXFLAGS' in os.environ:
José Fonseca601498a2010-11-01 13:30:22 +0000206 env['CXXFLAGS'] += SCons.Util.CLVar(os.environ['CXXFLAGS'])
Eric Engestrom29c8d752017-09-19 14:09:43 +0100207 if 'LDFLAGS' in os.environ:
José Fonseca601498a2010-11-01 13:30:22 +0000208 env['LINKFLAGS'] += SCons.Util.CLVar(os.environ['LDFLAGS'])
Alan Hourihane1ecf5052010-01-27 12:46:46 +0000209
José Fonseca97fa9cd2014-04-16 17:26:05 +0100210 # 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.
Jose Fonsecaa2fe35b2016-04-18 16:55:44 +0100213 env['gcc_compat'] = 0
José Fonseca97fa9cd2014-04-16 17:26:05 +0100214 env['clang'] = 0
215 env['msvc'] = 0
Jose Fonseca9c1c6572015-03-19 13:30:19 +0000216 if host_platform.system() == 'Windows':
José Fonseca97fa9cd2014-04-16 17:26:05 +0100217 env['msvc'] = check_cc(env, 'MSVC', 'defined(_MSC_VER)', '/E')
218 if not env['msvc']:
Jose Fonsecaa2fe35b2016-04-18 16:55:44 +0100219 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']
Vinson Leeee996472012-06-16 10:55:20 -0700222 env['suncc'] = env['platform'] == 'sunos' and os.path.basename(env['CC']) == 'cc'
Vinson Lee87345842012-07-31 22:55:39 -0700223 env['icc'] = 'icc' == os.path.basename(env['CC'])
José Fonseca26e27ba2009-03-25 19:24:16 +0000224
José Fonseca381e3482008-07-17 11:23:43 +0900225 # shortcuts
José Fonseca381e3482008-07-17 11:23:43 +0900226 machine = env['machine']
227 platform = env['platform']
228 x86 = env['machine'] == 'x86'
Michel Dänzer6b69e3c2008-10-23 10:28:48 +0200229 ppc = env['machine'] == 'ppc'
Jose Fonsecaa2fe35b2016-04-18 16:55:44 +0100230 gcc_compat = env['gcc_compat']
José Fonseca26e27ba2009-03-25 19:24:16 +0000231 msvc = env['msvc']
Vinson Leeee996472012-06-16 10:55:20 -0700232 suncc = env['suncc']
Vinson Lee87345842012-07-31 22:55:39 -0700233 icc = env['icc']
José Fonsecab04aa712008-06-06 14:48:57 +0900234
José Fonsecaae760272011-02-11 16:44:13 +0000235 # Determine whether we are cross compiling; in particular, whether we need
236 # to compile code generators with a different compiler as the target code.
Jose Fonseca9c1c6572015-03-19 13:30:19 +0000237 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()))
José Fonsecaae760272011-02-11 16:44:13 +0000241 host_machine = {
242 'x86': 'x86',
243 'i386': 'x86',
244 'i486': 'x86',
245 'i586': 'x86',
246 'i686': 'x86',
247 'ppc' : 'ppc',
José Fonseca33d8ff92011-02-15 17:31:31 +0000248 'AMD64': 'x86_64',
José Fonsecaae760272011-02-11 16:44:13 +0000249 'x86_64': 'x86_64',
250 }.get(host_machine, 'generic')
Jose Fonseca9c1c6572015-03-19 13:30:19 +0000251 env['crosscompile'] = platform != hosthost_platform
José Fonsecaae760272011-02-11 16:44:13 +0000252 if machine == 'x86_64' and host_machine != 'x86_64':
253 env['crosscompile'] = True
José Fonseca982609f2011-02-11 17:38:54 +0000254 env['hostonly'] = False
José Fonsecaae760272011-02-11 16:44:13 +0000255
José Fonseca67450f02010-09-29 14:08:53 +0100256 # Backwards compatability with the debug= profile= options
257 if env['build'] == 'debug':
258 if not env['debug']:
Eric Engestrom7d482192017-09-19 13:56:34 +0100259 print('scons: warning: debug option is deprecated and will be removed eventually; use instead')
260 print('')
261 print(' scons build=release')
262 print('')
José Fonseca67450f02010-09-29 14:08:53 +0100263 env['build'] = 'release'
264 if env['profile']:
Eric Engestrom7d482192017-09-19 13:56:34 +0100265 print('scons: warning: profile option is deprecated and will be removed eventually; use instead')
266 print('')
267 print(' scons build=profile')
268 print('')
José Fonseca67450f02010-09-29 14:08:53 +0100269 env['build'] = 'profile'
270 if False:
271 # Enforce SConscripts to use the new build variable
272 env.popitem('debug')
273 env.popitem('profile')
274 else:
275 # Backwards portability with older sconscripts
276 if env['build'] in ('debug', 'checked'):
277 env['debug'] = True
278 env['profile'] = False
279 if env['build'] == 'profile':
280 env['debug'] = False
281 env['profile'] = True
Brian Pauld6be0b52018-10-26 10:23:39 -0600282 if env['build'] == 'release':
José Fonseca67450f02010-09-29 14:08:53 +0100283 env['debug'] = False
284 env['profile'] = False
285
José Fonseca381e3482008-07-17 11:23:43 +0900286 # 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']
José Fonseca41750102011-06-17 14:48:28 +0100290 if env['embedded']:
291 build_subdir = 'embedded-' + build_subdir
José Fonseca381e3482008-07-17 11:23:43 +0900292 if env['machine'] != 'generic':
293 build_subdir += '-' + env['machine']
José Fonseca67450f02010-09-29 14:08:53 +0100294 if env['build'] != 'release':
295 build_subdir += '-' + env['build']
José Fonseca381e3482008-07-17 11:23:43 +0900296 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
José Fonseca67450f02010-09-29 14:08:53 +0100299 env['build_dir'] = build_dir
José Fonseca381e3482008-07-17 11:23:43 +0900300 env.SConsignFile(os.path.join(build_dir, '.sconsign'))
José Fonsecafe889a82010-02-14 15:34:39 +0000301 if 'SCONS_CACHE_DIR' in os.environ:
Eric Engestrom7d482192017-09-19 13:56:34 +0100302 print('scons: Using build cache in %s.' % (os.environ['SCONS_CACHE_DIR'],))
José Fonsecafe889a82010-02-14 15:34:39 +0000303 env.CacheDir(os.environ['SCONS_CACHE_DIR'])
José Fonseca8b755262009-12-25 17:39:47 +0000304 env['CONFIGUREDIR'] = os.path.join(build_dir, 'conf')
305 env['CONFIGURELOG'] = os.path.join(os.path.abspath(build_dir), 'config.log')
José Fonsecab04aa712008-06-06 14:48:57 +0900306
José Fonseca1e8177e2009-02-10 18:11:56 +0000307 # Parallel build
308 if env.GetOption('num_jobs') <= 1:
309 env.SetOption('num_jobs', num_jobs())
310
Jose Fonseca838c0482019-02-28 09:53:28 +0000311 # Speed up dependency checking. See
312 # - https://github.com/SCons/scons/wiki/GoFastButton
313 # - https://bugs.freedesktop.org/show_bug.cgi?id=109443
314 scons_version = distutils.version.StrictVersion(SCons.__version__)
315 if scons_version < distutils.version.StrictVersion('3.0.2') or \
316 scons_version > distutils.version.StrictVersion('3.0.4'):
317 env.Decider('MD5-timestamp')
José Fonseca601498a2010-11-01 13:30:22 +0000318 env.SetOption('max_drift', 60)
319
José Fonseca381e3482008-07-17 11:23:43 +0900320 # C preprocessor options
321 cppdefines = []
Jose Fonsecac0686102016-04-18 11:41:11 +0100322 cppdefines += [
Jose Fonsecac0686102016-04-18 11:41:11 +0100323 '__STDC_CONSTANT_MACROS',
Emil Velikovd68ffa92017-01-26 13:24:03 +0000324 '__STDC_FORMAT_MACROS',
325 '__STDC_LIMIT_MACROS',
Jose Fonsecac0686102016-04-18 11:41:11 +0100326 'HAVE_NO_AUTOCONF',
327 ]
José Fonseca67450f02010-09-29 14:08:53 +0100328 if env['build'] in ('debug', 'checked'):
José Fonseca381e3482008-07-17 11:23:43 +0900329 cppdefines += ['DEBUG']
330 else:
331 cppdefines += ['NDEBUG']
José Fonseca67450f02010-09-29 14:08:53 +0100332 if env['build'] == 'profile':
José Fonseca381e3482008-07-17 11:23:43 +0900333 cppdefines += ['PROFILE']
José Fonseca81734712011-06-17 16:28:27 +0100334 if env['platform'] in ('posix', 'linux', 'freebsd', 'darwin'):
335 cppdefines += [
336 '_POSIX_SOURCE',
337 ('_POSIX_C_SOURCE', '199309L'),
338 '_SVID_SOURCE',
339 '_BSD_SOURCE',
340 '_GNU_SOURCE',
Vinson Leeb77576e2015-03-01 00:41:48 -0800341 '_DEFAULT_SOURCE',
José Fonseca81734712011-06-17 16:28:27 +0100342 ]
José Fonseca2699fce2011-06-17 20:12:18 +0100343 if env['platform'] == 'darwin':
344 cppdefines += [
345 '_DARWIN_C_SOURCE',
346 'GLX_USE_APPLEGL',
347 'GLX_DIRECT_RENDERING',
348 ]
349 else:
350 cppdefines += [
351 'GLX_DIRECT_RENDERING',
352 'GLX_INDIRECT_RENDERING',
353 ]
Chia-I Wub039dbf2014-08-20 14:40:23 +0800354
Eric Engestromb50b4b62017-07-10 13:27:25 +0100355 if check_header(env, 'xlocale.h'):
Chia-I Wub039dbf2014-08-20 14:40:23 +0800356 cppdefines += ['HAVE_XLOCALE_H']
357
Eric Engestromcbee1bf2018-03-21 17:04:06 +0000358 if check_header(env, 'endian.h'):
359 cppdefines += ['HAVE_ENDIAN_H']
360
Eric Engestrom49b42842017-08-31 16:55:56 +0000361 if check_functions(env, ['strtod_l', 'strtof_l']):
362 cppdefines += ['HAVE_STRTOD_L']
363
Nicolai Hähnle2e3d0dd2017-11-15 12:41:58 +0100364 if check_functions(env, ['timespec_get']):
365 cppdefines += ['HAVE_TIMESPEC_GET']
366
José Fonseca381e3482008-07-17 11:23:43 +0900367 if platform == 'windows':
368 cppdefines += [
369 'WIN32',
370 '_WINDOWS',
José Fonseca42be0102009-01-22 14:26:30 +0000371 #'_UNICODE',
372 #'UNICODE',
José Fonseca57617c82010-02-12 13:22:59 +0000373 # http://msdn.microsoft.com/en-us/library/aa383745.aspx
374 ('_WIN32_WINNT', '0x0601'),
375 ('WINVER', '0x0601'),
José Fonseca381e3482008-07-17 11:23:43 +0900376 ]
José Fonseca16879322013-04-24 22:02:18 +0100377 if gcc_compat:
José Fonseca06462462011-09-06 13:13:32 +0100378 cppdefines += [('__MSVCRT_VERSION__', '0x0700')]
José Fonseca10b07662011-11-09 07:05:52 +0000379 if msvc:
José Fonsecab3e03ed2009-03-25 19:32:54 +0000380 cppdefines += [
381 'VC_EXTRALEAN',
José Fonsecaad0975f2009-10-26 15:11:11 +0000382 '_USE_MATH_DEFINES',
José Fonseca1acd8912009-10-21 17:03:52 +0100383 '_CRT_SECURE_NO_WARNINGS',
José Fonsecab3e03ed2009-03-25 19:32:54 +0000384 '_CRT_SECURE_NO_DEPRECATE',
José Fonseca1acd8912009-10-21 17:03:52 +0100385 '_SCL_SECURE_NO_WARNINGS',
386 '_SCL_SECURE_NO_DEPRECATE',
José Fonsecaa35a19a2013-03-14 17:40:14 +0000387 '_ALLOW_KEYWORD_MACROS',
Jose Fonseca357d1fc2015-03-20 06:27:59 +0000388 '_HAS_EXCEPTIONS=0', # Tell C++ STL to not use exceptions
José Fonsecab3e03ed2009-03-25 19:32:54 +0000389 ]
José Fonseca67450f02010-09-29 14:08:53 +0100390 if env['build'] in ('debug', 'checked'):
José Fonseca381e3482008-07-17 11:23:43 +0900391 cppdefines += ['_DEBUG']
José Fonseca381e3482008-07-17 11:23:43 +0900392 if platform == 'windows':
393 cppdefines += ['PIPE_SUBSYSTEM_WINDOWS_USER']
José Fonseca41750102011-06-17 14:48:28 +0100394 if env['embedded']:
395 cppdefines += ['PIPE_SUBSYSTEM_EMBEDDED']
José Fonseca381e3482008-07-17 11:23:43 +0900396 env.Append(CPPDEFINES = cppdefines)
José Fonsecab04aa712008-06-06 14:48:57 +0900397
José Fonseca381e3482008-07-17 11:23:43 +0900398 # C compiler options
José Fonseca25f6c932009-06-26 19:50:12 +0100399 cflags = [] # C
400 cxxflags = [] # C++
401 ccflags = [] # C & C++
José Fonseca16879322013-04-24 22:02:18 +0100402 if gcc_compat:
José Fonseca67450f02010-09-29 14:08:53 +0100403 if env['build'] == 'debug':
404 ccflags += ['-O0']
José Fonseca381e3482008-07-17 11:23:43 +0900405 else:
José Fonseca67450f02010-09-29 14:08:53 +0100406 ccflags += ['-O3']
José Fonseca16879322013-04-24 22:02:18 +0100407 if env['gcc']:
408 # gcc's builtin memcmp is slower than glibc's
409 # http://gcc.gnu.org/bugzilla/show_bug.cgi?id=43052
410 ccflags += ['-fno-builtin-memcmp']
José Fonseca2699fce2011-06-17 20:12:18 +0100411 # Work around aliasing bugs - developers should comment this out
412 ccflags += ['-fno-strict-aliasing']
José Fonseca2864f722011-09-08 09:59:01 +0100413 ccflags += ['-g']
Jose Fonsecafa468482016-04-09 20:26:42 +0100414 if env['build'] in ('checked', 'profile') or env['asan']:
José Fonseca1a9eec82009-09-20 18:07:16 +0100415 # See http://code.google.com/p/jrfonseca/wiki/Gprof2Dot#Which_options_should_I_pass_to_gcc_when_compiling_for_profiling?
416 ccflags += [
417 '-fno-omit-frame-pointer',
José Fonseca1a9eec82009-09-20 18:07:16 +0100418 ]
José Fonseca16879322013-04-24 22:02:18 +0100419 if env['gcc']:
420 ccflags += ['-fno-optimize-sibling-calls']
José Fonseca381e3482008-07-17 11:23:43 +0900421 if env['machine'] == 'x86':
José Fonseca25f6c932009-06-26 19:50:12 +0100422 ccflags += [
José Fonseca381e3482008-07-17 11:23:43 +0900423 '-m32',
424 #'-march=pentium4',
José Fonseca381e3482008-07-17 11:23:43 +0900425 ]
Jose Fonseca6e836d22015-03-04 13:56:35 +0000426 if platform != 'haiku':
José Fonseca30c5d5d2010-09-02 13:44:29 +0100427 # NOTE: We need to ensure stack is realigned given that we
428 # produce shared objects, and have no control over the stack
429 # alignment policy of the application. Therefore we need
430 # -mstackrealign ore -mincoming-stack-boundary=2.
431 #
432 # XXX: We could have SSE without -mstackrealign if we always used
433 # __attribute__((force_align_arg_pointer)), but that's not
434 # always the case.
José Fonseca5ba645f2009-10-14 16:16:40 +0100435 ccflags += [
José Fonseca30c5d5d2010-09-02 13:44:29 +0100436 '-mstackrealign', # ensure stack is aligned
José Fonseca04735772014-11-25 22:11:42 +0000437 '-msse', '-msse2', # enable SIMD intrinsics
José Fonsecaaef3a012014-11-25 22:15:40 +0000438 '-mfpmath=sse', # generate SSE floating-point arithmetic
José Fonseca5ba645f2009-10-14 16:16:40 +0100439 ]
Vinson Lee95ca2202010-07-19 11:31:44 -0700440 if platform in ['windows', 'darwin']:
José Fonseca6f81b782010-07-16 21:26:43 +0100441 # Workaround http://gcc.gnu.org/bugzilla/show_bug.cgi?id=37216
442 ccflags += ['-fno-common']
Alexander von Gluck IVcb3054c2012-06-14 08:08:07 -0700443 if platform in ['haiku']:
444 # Make optimizations compatible with Pentium or higher on Haiku
445 ccflags += [
446 '-mstackrealign', # ensure stack is aligned
447 '-march=i586', # Haiku target is Pentium
Alexander von Gluck IV23595aa2013-01-06 16:09:35 -0600448 '-mtune=i686' # use i686 where we can
Alexander von Gluck IVcb3054c2012-06-14 08:08:07 -0700449 ]
José Fonseca381e3482008-07-17 11:23:43 +0900450 if env['machine'] == 'x86_64':
José Fonseca25f6c932009-06-26 19:50:12 +0100451 ccflags += ['-m64']
Vinson Lee462e8a82010-08-17 00:20:58 -0700452 if platform == 'darwin':
453 ccflags += ['-fno-common']
Vinson Lee016897c2012-10-19 19:33:11 -0700454 if env['platform'] not in ('cygwin', 'haiku', 'windows'):
José Fonseca81734712011-06-17 16:28:27 +0100455 ccflags += ['-fvisibility=hidden']
José Fonseca102cb5c2009-03-13 16:21:30 +0000456 # See also:
457 # - http://gcc.gnu.org/onlinedocs/gcc/Warning-Options.html
José Fonseca25f6c932009-06-26 19:50:12 +0100458 ccflags += [
José Fonseca381e3482008-07-17 11:23:43 +0900459 '-Wall',
José Fonseca381e3482008-07-17 11:23:43 +0900460 '-Wno-long-long',
José Fonseca381e3482008-07-17 11:23:43 +0900461 '-fmessage-length=0', # be nice to Eclipse
462 ]
José Fonseca25f6c932009-06-26 19:50:12 +0100463 cflags += [
José Fonseca25f6c932009-06-26 19:50:12 +0100464 '-Wmissing-prototypes',
465 '-std=gnu99',
466 ]
Vinson Lee87345842012-07-31 22:55:39 -0700467 if icc:
468 cflags += [
469 '-std=gnu99',
470 ]
José Fonseca381e3482008-07-17 11:23:43 +0900471 if msvc:
472 # See also:
José Fonsecaa6c72582008-09-01 09:47:40 +0900473 # - http://msdn.microsoft.com/en-us/library/19z1t1wy.aspx
José Fonseca381e3482008-07-17 11:23:43 +0900474 # - cl /?
José Fonseca67450f02010-09-29 14:08:53 +0100475 if env['build'] == 'debug':
José Fonseca25f6c932009-06-26 19:50:12 +0100476 ccflags += [
José Fonseca381e3482008-07-17 11:23:43 +0900477 '/Od', # disable optimizations
478 '/Oi', # enable intrinsic functions
José Fonseca381e3482008-07-17 11:23:43 +0900479 ]
480 else:
José Fonseca25f6c932009-06-26 19:50:12 +0100481 ccflags += [
José Fonseca78dad272009-06-04 10:34:02 -0700482 '/O2', # optimize for speed
José Fonseca3b8bb7b2011-02-08 10:26:17 +0000483 ]
Brian Pauld6be0b52018-10-26 10:23:39 -0600484 if env['build'] == 'release':
Jose Fonsecaa2fe35b2016-04-18 16:55:44 +0100485 if not env['clang']:
486 ccflags += [
487 '/GL', # enable whole program optimization
488 ]
José Fonseca3b8bb7b2011-02-08 10:26:17 +0000489 else:
490 ccflags += [
José Fonseca9a097302011-03-08 13:18:56 +0000491 '/Oy-', # disable frame pointer omission
José Fonseca3b8bb7b2011-02-08 10:26:17 +0000492 ]
José Fonseca25f6c932009-06-26 19:50:12 +0100493 ccflags += [
José Fonseca381e3482008-07-17 11:23:43 +0900494 '/W3', # warning level
José Fonsecabbac03e2014-11-25 22:27:04 +0000495 '/wd4018', # signed/unsigned mismatch
Jose Fonseca1d30fd82015-03-18 14:18:28 +0000496 '/wd4056', # overflow in floating-point constant arithmetic
José Fonseca42b9f852014-05-01 15:40:43 +0100497 '/wd4244', # conversion from 'type1' to 'type2', possible loss of data
Jose Fonseca06ac7172015-03-20 12:01:23 +0000498 '/wd4267', # 'var' : conversion from 'size_t' to 'type', possible loss of data
José Fonseca42b9f852014-05-01 15:40:43 +0100499 '/wd4305', # truncation from 'type1' to 'type2'
Jose Fonsecae4d95982015-03-19 22:22:26 +0000500 '/wd4351', # new behavior: elements of array 'array' will be default initialized
Jose Fonseca1d30fd82015-03-18 14:18:28 +0000501 '/wd4756', # overflow in constant arithmetic
José Fonseca42b9f852014-05-01 15:40:43 +0100502 '/wd4800', # forcing value to bool 'true' or 'false' (performance warning)
José Fonseca1d1c0fa2011-11-09 10:33:21 +0000503 '/wd4996', # disable deprecated POSIX name warnings
José Fonseca381e3482008-07-17 11:23:43 +0900504 ]
Jose Fonsecaa2fe35b2016-04-18 16:55:44 +0100505 if env['clang']:
506 ccflags += [
507 '-Wno-microsoft-enum-value', # enumerator value is not representable in underlying type 'int'
508 ]
José Fonsecaa6c72582008-09-01 09:47:40 +0900509 if env['machine'] == 'x86':
José Fonseca25f6c932009-06-26 19:50:12 +0100510 ccflags += [
José Fonsecaaef3a012014-11-25 22:15:40 +0000511 '/arch:SSE2', # use the SSE2 instructions (default since MSVC 2012)
José Fonsecaa6c72582008-09-01 09:47:40 +0900512 ]
José Fonseca381e3482008-07-17 11:23:43 +0900513 if platform == 'windows':
José Fonseca25f6c932009-06-26 19:50:12 +0100514 ccflags += [
José Fonseca381e3482008-07-17 11:23:43 +0900515 # TODO
516 ]
José Fonseca381e3482008-07-17 11:23:43 +0900517 # Automatic pdb generation
518 # See http://scons.tigris.org/issues/show_bug.cgi?id=1656
519 env.EnsureSConsVersion(0, 98, 0)
520 env['PDB'] = '${TARGET.base}.pdb'
José Fonseca25f6c932009-06-26 19:50:12 +0100521 env.Append(CCFLAGS = ccflags)
José Fonseca381e3482008-07-17 11:23:43 +0900522 env.Append(CFLAGS = cflags)
José Fonseca25f6c932009-06-26 19:50:12 +0100523 env.Append(CXXFLAGS = cxxflags)
José Fonsecab04aa712008-06-06 14:48:57 +0900524
José Fonseca1781d7f2009-01-06 16:16:38 +0000525 if env['platform'] == 'windows' and msvc:
526 # Choose the appropriate MSVC CRT
527 # http://msdn.microsoft.com/en-us/library/2kzt1wy3.aspx
José Fonsecae3a3a532010-09-29 14:24:52 +0100528 if env['build'] in ('debug', 'checked'):
José Fonseca1781d7f2009-01-06 16:16:38 +0000529 env.Append(CCFLAGS = ['/MTd'])
530 env.Append(SHCCFLAGS = ['/LDd'])
531 else:
532 env.Append(CCFLAGS = ['/MT'])
533 env.Append(SHCCFLAGS = ['/LD'])
534
José Fonsecad3c0e232014-04-14 14:31:02 +0100535 # Static code analysis
536 if env['analyze']:
537 if env['msvc']:
538 # http://msdn.microsoft.com/en-us/library/ms173498.aspx
539 env.Append(CCFLAGS = [
540 '/analyze',
541 #'/analyze:log', '${TARGET.base}.xml',
Jose Fonseca28c54402015-03-24 19:50:48 +0000542 '/wd28251', # Inconsistent annotation for function
José Fonsecad3c0e232014-04-14 14:31:02 +0100543 ])
544 if env['clang']:
545 # scan-build will produce more comprehensive output
546 env.Append(CCFLAGS = ['--analyze'])
547
Jose Fonsecafa468482016-04-09 20:26:42 +0100548 # https://github.com/google/sanitizers/wiki/AddressSanitizer
549 if env['asan']:
550 if gcc_compat:
551 env.Append(CCFLAGS = [
552 '-fsanitize=address',
553 ])
554 env.Append(LINKFLAGS = [
555 '-fsanitize=address',
556 ])
557
José Fonseca381e3482008-07-17 11:23:43 +0900558 # Assembler options
José Fonseca16879322013-04-24 22:02:18 +0100559 if gcc_compat:
José Fonseca381e3482008-07-17 11:23:43 +0900560 if env['machine'] == 'x86':
561 env.Append(ASFLAGS = ['-m32'])
562 if env['machine'] == 'x86_64':
563 env.Append(ASFLAGS = ['-m64'])
José Fonseca27d8d6f2008-07-03 12:42:23 +0900564
José Fonseca381e3482008-07-17 11:23:43 +0900565 # Linker options
566 linkflags = []
José Fonseca72ad0392009-06-28 10:54:23 +0100567 shlinkflags = []
José Fonseca16879322013-04-24 22:02:18 +0100568 if gcc_compat:
José Fonseca381e3482008-07-17 11:23:43 +0900569 if env['machine'] == 'x86':
570 linkflags += ['-m32']
571 if env['machine'] == 'x86_64':
572 linkflags += ['-m64']
Vinson Lee51ab5992010-01-28 01:32:15 -0800573 if env['platform'] not in ('darwin'):
574 shlinkflags += [
575 '-Wl,-Bsymbolic',
576 ]
José Fonseca7b391942009-08-13 16:32:51 +0100577 # Handle circular dependencies in the libraries
Vinson Lee6b55aac2010-01-23 21:43:26 -0800578 if env['platform'] in ('darwin'):
579 pass
580 else:
581 env['_LIBFLAGS'] = '-Wl,--start-group ' + env['_LIBFLAGS'] + ' -Wl,--end-group'
José Fonseca06462462011-09-06 13:13:32 +0100582 if env['platform'] == 'windows':
José Fonseca771ab952014-09-11 11:43:04 +0100583 linkflags += [
584 '-Wl,--nxcompat', # DEP
585 '-Wl,--dynamicbase', # ASLR
586 ]
José Fonseca06462462011-09-06 13:13:32 +0100587 # Avoid depending on gcc runtime DLLs
588 linkflags += ['-static-libgcc']
José Fonseca97213fd2011-11-03 09:58:52 +0000589 if 'w64' in env['CC'].split('-'):
José Fonseca129ace42011-09-06 13:14:09 +0100590 linkflags += ['-static-libstdc++']
José Fonseca06462462011-09-06 13:13:32 +0100591 # Handle the @xx symbol munging of DLL exports
592 shlinkflags += ['-Wl,--enable-stdcall-fixup']
593 #shlinkflags += ['-Wl,--kill-at']
José Fonsecada3bc492009-12-11 15:16:22 +0000594 if msvc:
Brian Pauld6be0b52018-10-26 10:23:39 -0600595 if env['build'] == 'release' and not env['clang']:
José Fonsecada3bc492009-12-11 15:16:22 +0000596 # enable Link-time Code Generation
597 linkflags += ['/LTCG']
598 env.Append(ARFLAGS = ['/LTCG'])
José Fonseca6fe421c2009-02-12 12:59:58 +0000599 if platform == 'windows' and msvc:
José Fonseca381e3482008-07-17 11:23:43 +0900600 # See also:
601 # - http://msdn2.microsoft.com/en-us/library/y0zzbyt4.aspx
602 linkflags += [
José Fonseca73ccabc2009-02-12 11:57:45 +0000603 '/fixed:no',
604 '/incremental:no',
José Fonseca771ab952014-09-11 11:43:04 +0100605 '/dynamicbase', # ASLR
606 '/nxcompat', # DEP
José Fonseca73ccabc2009-02-12 11:57:45 +0000607 ]
José Fonseca381e3482008-07-17 11:23:43 +0900608 env.Append(LINKFLAGS = linkflags)
José Fonseca72ad0392009-06-28 10:54:23 +0100609 env.Append(SHLINKFLAGS = shlinkflags)
José Fonseca381e3482008-07-17 11:23:43 +0900610
José Fonseca11b15c42011-01-30 11:17:07 +0000611 # We have C++ in several libraries, so always link with the C++ compiler
José Fonseca16879322013-04-24 22:02:18 +0100612 if gcc_compat:
José Fonseca11b15c42011-01-30 11:17:07 +0000613 env['LINK'] = env['CXX']
614
José Fonsecac76787a2008-07-17 11:25:20 +0900615 # Default libs
José Fonseca81734712011-06-17 16:28:27 +0100616 libs = []
Vinson Leec57fb032012-08-29 23:16:44 -0700617 if env['platform'] in ('darwin', 'freebsd', 'linux', 'posix', 'sunos'):
José Fonseca81734712011-06-17 16:28:27 +0100618 libs += ['m', 'pthread', 'dl']
José Fonsecad2963262012-12-05 08:59:21 +0000619 if env['platform'] in ('linux',):
José Fonsecaed4dfaa2012-12-04 19:36:52 +0000620 libs += ['rt']
Alexander von Gluck IV765baec2013-10-04 17:28:42 +0000621 if env['platform'] in ('haiku'):
Alexander von Gluck IV50370e42013-10-19 23:31:50 -0500622 libs += ['root', 'be', 'network', 'translation']
José Fonseca81734712011-06-17 16:28:27 +0100623 env.Append(LIBS = libs)
José Fonsecac76787a2008-07-17 11:25:20 +0900624
Andreas Fängere411cd72011-08-10 08:07:29 +0000625 # OpenMP
626 if env['openmp']:
627 if env['msvc']:
628 env.Append(CCFLAGS = ['/openmp'])
629 # When building openmp release VS2008 link.exe crashes with LNK1103 error.
630 # Workaround: overwrite PDB flags with empty value as it isn't required anyways
631 if env['build'] == 'release':
632 env['PDB'] = ''
633 if env['gcc']:
634 env.Append(CCFLAGS = ['-fopenmp'])
635 env.Append(LIBS = ['gomp'])
636
José Fonseca601498a2010-11-01 13:30:22 +0000637 # Load tools
José Fonseca89871092011-03-03 15:28:36 +0000638 env.Tool('lex')
Jose Fonseca015e8b62015-03-19 11:53:36 +0000639 if env['msvc']:
640 env.Append(LEXFLAGS = [
641 # Force flex to use const keyword in prototypes, as relies on
642 # __cplusplus or __STDC__ macro to determine whether it's safe to
643 # use const keyword, but MSVC never defines __STDC__ unless we
644 # disable all MSVC extensions.
645 '-DYY_USE_CONST=',
646 ])
Jose Fonseca15c55952015-03-20 06:53:09 +0000647 # Flex relies on __STDC_VERSION__>=199901L to decide when to include
648 # C99 inttypes.h. We always have inttypes.h available with MSVC
649 # (either the one bundled with MSVC 2013, or the one we bundle
650 # ourselves), but we can't just define __STDC_VERSION__ without
651 # breaking stuff, as MSVC doesn't fully support C99. There's also no
652 # way to premptively include stdint.
653 env.Append(CCFLAGS = ['-FIinttypes.h'])
Jose Fonseca9c1c6572015-03-19 13:30:19 +0000654 if host_platform.system() == 'Windows':
655 # Prefer winflexbison binaries, as not only they are easier to install
656 # (no additional dependencies), but also better Windows support.
657 if check_prog(env, 'win_flex'):
658 env["LEX"] = 'win_flex'
659 env.Append(LEXFLAGS = [
660 # windows compatibility (uses <io.h> instead of <unistd.h> and
661 # _isatty, _fileno functions)
662 '--wincompat'
663 ])
664
José Fonseca89871092011-03-03 15:28:36 +0000665 env.Tool('yacc')
Jose Fonseca9c1c6572015-03-19 13:30:19 +0000666 if host_platform.system() == 'Windows':
667 if check_prog(env, 'win_bison'):
668 env["YACC"] = 'win_bison'
669
José Fonsecaea532f02010-04-10 02:41:39 +0100670 if env['llvm']:
671 env.Tool('llvm')
José Fonseca601498a2010-11-01 13:30:22 +0000672
José Fonseca381e3482008-07-17 11:23:43 +0900673 # Custom builders and methods
José Fonseca97e2c5a2009-12-31 17:58:56 +0000674 env.Tool('custom')
Jose Fonseca50ddf032016-04-13 13:31:04 +0100675 env.AddMethod(install_program, 'InstallProgram')
676 env.AddMethod(install_shared_library, 'InstallSharedLibrary')
677 env.AddMethod(msvc2013_compat, 'MSVC2013Compat')
678 env.AddMethod(unit_test, 'UnitTest')
José Fonseca381e3482008-07-17 11:23:43 +0900679
Emil Velikov87f485e2017-02-09 13:35:50 +0000680 env.PkgCheckModules('X11', ['x11', 'xext', 'xdamage >= 1.1', 'xfixes', 'glproto >= 1.4.13', 'dri2proto >= 2.8'])
José Fonseca78894692014-06-16 11:24:15 +0100681 env.PkgCheckModules('XCB', ['x11-xcb', 'xcb-glx >= 1.8.1', 'xcb-dri2 >= 1.8'])
José Fonseca235225e2011-06-30 17:36:37 +0100682 env.PkgCheckModules('XF86VIDMODE', ['xxf86vm'])
Emil Velikov2c72e782016-12-01 19:48:43 +0000683 env.PkgCheckModules('DRM', ['libdrm >= 2.4.75'])
José Fonseca235225e2011-06-30 17:36:37 +0100684
Dylan Bakerc7821682018-08-14 10:32:12 -0700685 if not os.path.exists("src/util/format_srgb.c"):
686 print("Checking for Python Mako module (>= 0.8.0)... ", end='')
687 try:
688 import mako
689 except ImportError:
690 print("no")
691 exit(1)
692 if distutils.version.StrictVersion(mako.__version__) < distutils.version.StrictVersion('0.8.0'):
693 print("no")
694 exit(1)
695 print("yes")
696
Vinson Lee9db7b122015-01-19 12:54:44 -0800697 if env['x11']:
698 env.Append(CPPPATH = env['X11_CPPPATH'])
699
José Fonseca235225e2011-06-30 17:36:37 +0100700 env['dri'] = env['x11'] and env['drm']
701
José Fonseca381e3482008-07-17 11:23:43 +0900702 # for debugging
703 #print env.Dump()
José Fonsecab04aa712008-06-06 14:48:57 +0900704
705
706def exists(env):
José Fonseca381e3482008-07-17 11:23:43 +0900707 return 1