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