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