scons: builtin_glsl_function on windows needs bundled getopt.
[mesa.git] / scons / gallium.py
1 """gallium
2
3 Frontend-tool for Gallium3D architecture.
4
5 """
6
7 #
8 # Copyright 2008 Tungsten Graphics, Inc., Cedar Park, Texas.
9 # All Rights Reserved.
10 #
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:
18 #
19 # 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.
22 #
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 TUNGSTEN GRAPHICS 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.
30 #
31
32
33 import distutils.version
34 import os
35 import os.path
36 import re
37 import subprocess
38 import platform as _platform
39
40 import SCons.Action
41 import SCons.Builder
42 import SCons.Scanner
43
44
45 def symlink(target, source, env):
46 target = str(target[0])
47 source = str(source[0])
48 if os.path.islink(target) or os.path.exists(target):
49 os.remove(target)
50 os.symlink(os.path.basename(source), target)
51
52 def install(env, source, subdir):
53 target_dir = os.path.join(env.Dir('#.').srcnode().abspath, env['build_dir'], subdir)
54 return env.Install(target_dir, source)
55
56 def install_program(env, source):
57 return install(env, source, 'bin')
58
59 def install_shared_library(env, sources, version = ()):
60 targets = []
61 install_dir = os.path.join(env.Dir('#.').srcnode().abspath, env['build_dir'])
62 version = tuple(map(str, version))
63 if env['SHLIBSUFFIX'] == '.dll':
64 dlls = env.FindIxes(sources, 'SHLIBPREFIX', 'SHLIBSUFFIX')
65 targets += install(env, dlls, 'bin')
66 libs = env.FindIxes(sources, 'LIBPREFIX', 'LIBSUFFIX')
67 targets += install(env, libs, 'lib')
68 else:
69 for source in sources:
70 target_dir = os.path.join(install_dir, 'lib')
71 target_name = '.'.join((str(source),) + version)
72 last = env.InstallAs(os.path.join(target_dir, target_name), source)
73 targets += last
74 while len(version):
75 version = version[:-1]
76 target_name = '.'.join((str(source),) + version)
77 action = SCons.Action.Action(symlink, "$TARGET -> $SOURCE")
78 last = env.Command(os.path.join(target_dir, target_name), last, action)
79 targets += last
80 return targets
81
82
83 def createInstallMethods(env):
84 env.AddMethod(install_program, 'InstallProgram')
85 env.AddMethod(install_shared_library, 'InstallSharedLibrary')
86
87
88 def num_jobs():
89 try:
90 return int(os.environ['NUMBER_OF_PROCESSORS'])
91 except (ValueError, KeyError):
92 pass
93
94 try:
95 return os.sysconf('SC_NPROCESSORS_ONLN')
96 except (ValueError, OSError, AttributeError):
97 pass
98
99 try:
100 return int(os.popen2("sysctl -n hw.ncpu")[1].read())
101 except ValueError:
102 pass
103
104 return 1
105
106
107 def pkg_config_modules(env, name, modules):
108 '''Simple wrapper for pkg-config.'''
109
110 env[name] = False
111
112 if env['platform'] == 'windows':
113 return
114
115 if not env.Detect('pkg-config'):
116 return
117
118 if subprocess.call(["pkg-config", "--exists", ' '.join(modules)]) != 0:
119 return
120
121 # Put -I and -L flags directly into the environment, as these don't affect
122 # the compilation of targets that do not use them
123 try:
124 env.ParseConfig('pkg-config --cflags-only-I --libs-only-L ' + ' '.join(modules))
125 except OSError:
126 return
127
128 # Other flags may affect the compilation of unrelated targets, so store
129 # them with a prefix, (e.g., XXX_CFLAGS, XXX_LIBS, etc)
130 try:
131 flags = env.ParseFlags('!pkg-config --cflags-only-other --libs-only-l --libs-only-other ' + ' '.join(modules))
132 except OSError:
133 return
134 prefix = name.upper() + '_'
135 for flag_name, flag_value in flags.iteritems():
136 env[prefix + flag_name] = flag_value
137
138 env[name] = True
139
140
141
142 def generate(env):
143 """Common environment generation code"""
144
145 # Tell tools which machine to compile for
146 env['TARGET_ARCH'] = env['machine']
147 env['MSVS_ARCH'] = env['machine']
148
149 # Toolchain
150 platform = env['platform']
151 if env['toolchain'] == 'default':
152 if platform == 'winddk':
153 env['toolchain'] = 'winddk'
154 elif platform == 'wince':
155 env['toolchain'] = 'wcesdk'
156 env.Tool(env['toolchain'])
157
158 # Allow override compiler and specify additional flags from environment
159 if os.environ.has_key('CC'):
160 env['CC'] = os.environ['CC']
161 # Update CCVERSION to match
162 pipe = SCons.Action._subproc(env, [env['CC'], '--version'],
163 stdin = 'devnull',
164 stderr = 'devnull',
165 stdout = subprocess.PIPE)
166 if pipe.wait() == 0:
167 line = pipe.stdout.readline()
168 match = re.search(r'[0-9]+(\.[0-9]+)+', line)
169 if match:
170 env['CCVERSION'] = match.group(0)
171 if os.environ.has_key('CFLAGS'):
172 env['CCFLAGS'] += SCons.Util.CLVar(os.environ['CFLAGS'])
173 if os.environ.has_key('CXX'):
174 env['CXX'] = os.environ['CXX']
175 if os.environ.has_key('CXXFLAGS'):
176 env['CXXFLAGS'] += SCons.Util.CLVar(os.environ['CXXFLAGS'])
177 if os.environ.has_key('LDFLAGS'):
178 env['LINKFLAGS'] += SCons.Util.CLVar(os.environ['LDFLAGS'])
179
180 env['gcc'] = 'gcc' in os.path.basename(env['CC']).split('-')
181 env['msvc'] = env['CC'] == 'cl'
182
183 if env['msvc'] and env['toolchain'] == 'default' and env['machine'] == 'x86_64':
184 # MSVC x64 support is broken in earlier versions of scons
185 env.EnsurePythonVersion(2, 0)
186
187 # shortcuts
188 machine = env['machine']
189 platform = env['platform']
190 x86 = env['machine'] == 'x86'
191 ppc = env['machine'] == 'ppc'
192 gcc = env['gcc']
193 msvc = env['msvc']
194
195 # Determine whether we are cross compiling; in particular, whether we need
196 # to compile code generators with a different compiler as the target code.
197 host_platform = _platform.system().lower()
198 host_machine = os.environ.get('PROCESSOR_ARCHITECTURE', _platform.machine())
199 host_machine = {
200 'x86': 'x86',
201 'i386': 'x86',
202 'i486': 'x86',
203 'i586': 'x86',
204 'i686': 'x86',
205 'ppc' : 'ppc',
206 'x86_64': 'x86_64',
207 }.get(host_machine, 'generic')
208 env['crosscompile'] = platform != host_platform
209 if machine == 'x86_64' and host_machine != 'x86_64':
210 env['crosscompile'] = True
211 env['hostonly'] = False
212
213 # Backwards compatability with the debug= profile= options
214 if env['build'] == 'debug':
215 if not env['debug']:
216 print 'scons: warning: debug option is deprecated and will be removed eventually; use instead'
217 print
218 print ' scons build=release'
219 print
220 env['build'] = 'release'
221 if env['profile']:
222 print 'scons: warning: profile option is deprecated and will be removed eventually; use instead'
223 print
224 print ' scons build=profile'
225 print
226 env['build'] = 'profile'
227 if False:
228 # Enforce SConscripts to use the new build variable
229 env.popitem('debug')
230 env.popitem('profile')
231 else:
232 # Backwards portability with older sconscripts
233 if env['build'] in ('debug', 'checked'):
234 env['debug'] = True
235 env['profile'] = False
236 if env['build'] == 'profile':
237 env['debug'] = False
238 env['profile'] = True
239 if env['build'] == 'release':
240 env['debug'] = False
241 env['profile'] = False
242
243 # Put build output in a separate dir, which depends on the current
244 # configuration. See also http://www.scons.org/wiki/AdvancedBuildExample
245 build_topdir = 'build'
246 build_subdir = env['platform']
247 if env['machine'] != 'generic':
248 build_subdir += '-' + env['machine']
249 if env['build'] != 'release':
250 build_subdir += '-' + env['build']
251 build_dir = os.path.join(build_topdir, build_subdir)
252 # Place the .sconsign file in the build dir too, to avoid issues with
253 # different scons versions building the same source file
254 env['build_dir'] = build_dir
255 env.SConsignFile(os.path.join(build_dir, '.sconsign'))
256 if 'SCONS_CACHE_DIR' in os.environ:
257 print 'scons: Using build cache in %s.' % (os.environ['SCONS_CACHE_DIR'],)
258 env.CacheDir(os.environ['SCONS_CACHE_DIR'])
259 env['CONFIGUREDIR'] = os.path.join(build_dir, 'conf')
260 env['CONFIGURELOG'] = os.path.join(os.path.abspath(build_dir), 'config.log')
261
262 # Parallel build
263 if env.GetOption('num_jobs') <= 1:
264 env.SetOption('num_jobs', num_jobs())
265
266 env.Decider('MD5-timestamp')
267 env.SetOption('max_drift', 60)
268
269 # C preprocessor options
270 cppdefines = []
271 if env['build'] in ('debug', 'checked'):
272 cppdefines += ['DEBUG']
273 else:
274 cppdefines += ['NDEBUG']
275 if env['build'] == 'profile':
276 cppdefines += ['PROFILE']
277 if platform == 'windows':
278 cppdefines += [
279 'WIN32',
280 '_WINDOWS',
281 #'_UNICODE',
282 #'UNICODE',
283 # http://msdn.microsoft.com/en-us/library/aa383745.aspx
284 ('_WIN32_WINNT', '0x0601'),
285 ('WINVER', '0x0601'),
286 ]
287 if msvc and env['toolchain'] != 'winddk':
288 cppdefines += [
289 'VC_EXTRALEAN',
290 '_USE_MATH_DEFINES',
291 '_CRT_SECURE_NO_WARNINGS',
292 '_CRT_SECURE_NO_DEPRECATE',
293 '_SCL_SECURE_NO_WARNINGS',
294 '_SCL_SECURE_NO_DEPRECATE',
295 ]
296 if env['build'] in ('debug', 'checked'):
297 cppdefines += ['_DEBUG']
298 if env['toolchain'] == 'winddk':
299 # Mimic WINDDK's builtin flags. See also:
300 # - WINDDK's bin/makefile.new i386mk.inc for more info.
301 # - buildchk_wxp_x86.log files, generated by the WINDDK's build
302 # - http://alter.org.ua/docs/nt_kernel/vc8_proj/
303 if machine == 'x86':
304 cppdefines += ['_X86_', 'i386']
305 if machine == 'x86_64':
306 cppdefines += ['_AMD64_', 'AMD64']
307 if platform == 'winddk':
308 cppdefines += [
309 'STD_CALL',
310 ('CONDITION_HANDLING', '1'),
311 ('NT_INST', '0'),
312 ('WIN32', '100'),
313 ('_NT1X_', '100'),
314 ('WINNT', '1'),
315 ('_WIN32_WINNT', '0x0501'), # minimum required OS version
316 ('WINVER', '0x0501'),
317 ('_WIN32_IE', '0x0603'),
318 ('WIN32_LEAN_AND_MEAN', '1'),
319 ('DEVL', '1'),
320 ('__BUILDMACHINE__', 'WinDDK'),
321 ('FPO', '0'),
322 ]
323 if env['build'] in ('debug', 'checked'):
324 cppdefines += [('DBG', 1)]
325 if platform == 'wince':
326 cppdefines += [
327 '_CRT_SECURE_NO_DEPRECATE',
328 '_USE_32BIT_TIME_T',
329 'UNICODE',
330 '_UNICODE',
331 ('UNDER_CE', '600'),
332 ('_WIN32_WCE', '0x600'),
333 'WINCEOEM',
334 'WINCEINTERNAL',
335 'WIN32',
336 'STRICT',
337 'x86',
338 '_X86_',
339 'INTERNATIONAL',
340 ('INTLMSG_CODEPAGE', '1252'),
341 ]
342 if platform == 'windows':
343 cppdefines += ['PIPE_SUBSYSTEM_WINDOWS_USER']
344 if platform == 'winddk':
345 cppdefines += ['PIPE_SUBSYSTEM_WINDOWS_DISPLAY']
346 if platform == 'wince':
347 cppdefines += ['PIPE_SUBSYSTEM_WINDOWS_CE']
348 cppdefines += ['PIPE_SUBSYSTEM_WINDOWS_CE_OGL']
349 if platform == 'embedded':
350 cppdefines += ['PIPE_OS_EMBEDDED']
351 env.Append(CPPDEFINES = cppdefines)
352
353 # C compiler options
354 cflags = [] # C
355 cxxflags = [] # C++
356 ccflags = [] # C & C++
357 if gcc:
358 ccversion = env['CCVERSION']
359 if env['build'] == 'debug':
360 ccflags += ['-O0']
361 elif ccversion.startswith('4.2.'):
362 # gcc 4.2.x optimizer is broken
363 print "warning: gcc 4.2.x optimizer is broken -- disabling optimizations"
364 ccflags += ['-O0']
365 else:
366 ccflags += ['-O3']
367 ccflags += ['-g3']
368 if env['build'] in ('checked', 'profile'):
369 # See http://code.google.com/p/jrfonseca/wiki/Gprof2Dot#Which_options_should_I_pass_to_gcc_when_compiling_for_profiling?
370 ccflags += [
371 '-fno-omit-frame-pointer',
372 '-fno-optimize-sibling-calls',
373 ]
374 if env['machine'] == 'x86':
375 ccflags += [
376 '-m32',
377 #'-march=pentium4',
378 ]
379 if distutils.version.LooseVersion(ccversion) >= distutils.version.LooseVersion('4.2') \
380 and (platform != 'windows' or env['build'] == 'debug' or True):
381 # NOTE: We need to ensure stack is realigned given that we
382 # produce shared objects, and have no control over the stack
383 # alignment policy of the application. Therefore we need
384 # -mstackrealign ore -mincoming-stack-boundary=2.
385 #
386 # XXX: -O and -mstackrealign causes stack corruption on MinGW
387 #
388 # XXX: We could have SSE without -mstackrealign if we always used
389 # __attribute__((force_align_arg_pointer)), but that's not
390 # always the case.
391 ccflags += [
392 '-mstackrealign', # ensure stack is aligned
393 '-mmmx', '-msse', '-msse2', # enable SIMD intrinsics
394 #'-mfpmath=sse',
395 ]
396 if platform in ['windows', 'darwin']:
397 # Workaround http://gcc.gnu.org/bugzilla/show_bug.cgi?id=37216
398 ccflags += ['-fno-common']
399 if env['machine'] == 'x86_64':
400 ccflags += ['-m64']
401 if platform == 'darwin':
402 ccflags += ['-fno-common']
403 # See also:
404 # - http://gcc.gnu.org/onlinedocs/gcc/Warning-Options.html
405 ccflags += [
406 '-Wall',
407 '-Wno-long-long',
408 '-ffast-math',
409 '-fmessage-length=0', # be nice to Eclipse
410 ]
411 cflags += [
412 '-Wmissing-prototypes',
413 '-std=gnu99',
414 ]
415 if distutils.version.LooseVersion(ccversion) >= distutils.version.LooseVersion('4.0'):
416 ccflags += [
417 '-Wmissing-field-initializers',
418 ]
419 if distutils.version.LooseVersion(ccversion) >= distutils.version.LooseVersion('4.2'):
420 ccflags += [
421 '-Werror=pointer-arith',
422 ]
423 cflags += [
424 '-Werror=declaration-after-statement',
425 ]
426 if msvc:
427 # See also:
428 # - http://msdn.microsoft.com/en-us/library/19z1t1wy.aspx
429 # - cl /?
430 if env['build'] == 'debug':
431 ccflags += [
432 '/Od', # disable optimizations
433 '/Oi', # enable intrinsic functions
434 '/Oy-', # disable frame pointer omission
435 ]
436 else:
437 ccflags += [
438 '/O2', # optimize for speed
439 ]
440 if env['build'] == 'release':
441 ccflags += [
442 '/GL', # enable whole program optimization
443 ]
444 else:
445 ccflags += [
446 '/GL-', # disable whole program optimization
447 ]
448 ccflags += [
449 '/fp:fast', # fast floating point
450 '/W3', # warning level
451 #'/Wp64', # enable 64 bit porting warnings
452 ]
453 if env['machine'] == 'x86':
454 ccflags += [
455 #'/arch:SSE2', # use the SSE2 instructions
456 ]
457 if platform == 'windows':
458 ccflags += [
459 # TODO
460 ]
461 if platform == 'winddk':
462 ccflags += [
463 '/Zl', # omit default library name in .OBJ
464 '/Zp8', # 8bytes struct member alignment
465 '/Gy', # separate functions for linker
466 '/Gm-', # disable minimal rebuild
467 '/WX', # treat warnings as errors
468 '/Gz', # __stdcall Calling convention
469 '/GX-', # disable C++ EH
470 '/GR-', # disable C++ RTTI
471 '/GF', # enable read-only string pooling
472 '/G6', # optimize for PPro, P-II, P-III
473 '/Ze', # enable extensions
474 '/Gi-', # disable incremental compilation
475 '/QIfdiv-', # disable Pentium FDIV fix
476 '/hotpatch', # prepares an image for hotpatching.
477 #'/Z7', #enable old-style debug info
478 ]
479 if platform == 'wince':
480 # See also C:\WINCE600\public\common\oak\misc\makefile.def
481 ccflags += [
482 '/Zl', # omit default library name in .OBJ
483 '/GF', # enable read-only string pooling
484 '/GR-', # disable C++ RTTI
485 '/GS', # enable security checks
486 # Allow disabling language conformance to maintain backward compat
487 #'/Zc:wchar_t-', # don't force wchar_t as native type, instead of typedef
488 #'/Zc:forScope-', # don't enforce Standard C++ for scoping rules
489 #'/wd4867',
490 #'/wd4430',
491 #'/MT',
492 #'/U_MT',
493 ]
494 # Automatic pdb generation
495 # See http://scons.tigris.org/issues/show_bug.cgi?id=1656
496 env.EnsureSConsVersion(0, 98, 0)
497 env['PDB'] = '${TARGET.base}.pdb'
498 env.Append(CCFLAGS = ccflags)
499 env.Append(CFLAGS = cflags)
500 env.Append(CXXFLAGS = cxxflags)
501
502 if env['platform'] == 'windows' and msvc:
503 # Choose the appropriate MSVC CRT
504 # http://msdn.microsoft.com/en-us/library/2kzt1wy3.aspx
505 if env['build'] in ('debug', 'checked'):
506 env.Append(CCFLAGS = ['/MTd'])
507 env.Append(SHCCFLAGS = ['/LDd'])
508 else:
509 env.Append(CCFLAGS = ['/MT'])
510 env.Append(SHCCFLAGS = ['/LD'])
511
512 # Assembler options
513 if gcc:
514 if env['machine'] == 'x86':
515 env.Append(ASFLAGS = ['-m32'])
516 if env['machine'] == 'x86_64':
517 env.Append(ASFLAGS = ['-m64'])
518
519 # Linker options
520 linkflags = []
521 shlinkflags = []
522 if gcc:
523 if env['machine'] == 'x86':
524 linkflags += ['-m32']
525 if env['machine'] == 'x86_64':
526 linkflags += ['-m64']
527 if env['platform'] not in ('darwin'):
528 shlinkflags += [
529 '-Wl,-Bsymbolic',
530 ]
531 # Handle circular dependencies in the libraries
532 if env['platform'] in ('darwin'):
533 pass
534 else:
535 env['_LIBFLAGS'] = '-Wl,--start-group ' + env['_LIBFLAGS'] + ' -Wl,--end-group'
536 if msvc:
537 if env['build'] == 'release':
538 # enable Link-time Code Generation
539 linkflags += ['/LTCG']
540 env.Append(ARFLAGS = ['/LTCG'])
541 if platform == 'windows' and msvc:
542 # See also:
543 # - http://msdn2.microsoft.com/en-us/library/y0zzbyt4.aspx
544 linkflags += [
545 '/fixed:no',
546 '/incremental:no',
547 ]
548 if platform == 'winddk':
549 linkflags += [
550 '/merge:_PAGE=PAGE',
551 '/merge:_TEXT=.text',
552 '/section:INIT,d',
553 '/opt:ref',
554 '/opt:icf',
555 '/ignore:4198,4010,4037,4039,4065,4070,4078,4087,4089,4221',
556 '/incremental:no',
557 '/fullbuild',
558 '/release',
559 '/nodefaultlib',
560 '/wx',
561 '/debug',
562 '/debugtype:cv',
563 '/version:5.1',
564 '/osversion:5.1',
565 '/functionpadmin:5',
566 '/safeseh',
567 '/pdbcompress',
568 '/stack:0x40000,0x1000',
569 '/driver',
570 '/align:0x80',
571 '/subsystem:native,5.01',
572 '/base:0x10000',
573
574 '/entry:DrvEnableDriver',
575 ]
576 if env['build'] != 'release':
577 linkflags += [
578 '/MAP', # http://msdn.microsoft.com/en-us/library/k7xkk3e2.aspx
579 ]
580 if platform == 'wince':
581 linkflags += [
582 '/nodefaultlib',
583 #'/incremental:no',
584 #'/fullbuild',
585 '/entry:_DllMainCRTStartup',
586 ]
587 env.Append(LINKFLAGS = linkflags)
588 env.Append(SHLINKFLAGS = shlinkflags)
589
590 # We have C++ in several libraries, so always link with the C++ compiler
591 if env['gcc']:
592 env['LINK'] = env['CXX']
593
594 # Default libs
595 env.Append(LIBS = [])
596
597 # Load tools
598 if env['llvm']:
599 env.Tool('llvm')
600 env.Tool('udis86')
601
602 pkg_config_modules(env, 'x11', ['x11', 'xext'])
603 pkg_config_modules(env, 'drm', ['libdrm'])
604 pkg_config_modules(env, 'drm_intel', ['libdrm_intel'])
605 pkg_config_modules(env, 'drm_radeon', ['libdrm_radeon'])
606 pkg_config_modules(env, 'xorg', ['xorg-server'])
607 pkg_config_modules(env, 'kms', ['libkms'])
608
609 env['dri'] = env['x11'] and env['drm']
610
611 # Custom builders and methods
612 env.Tool('custom')
613 createInstallMethods(env)
614
615 # for debugging
616 #print env.Dump()
617
618
619 def exists(env):
620 return 1