gallium.py revision ee99647e02fe5b947838cfea276f095775eb1537 
1"""gallium
2
3Frontend-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
33import distutils.version
34import os
35import os.path
36import re
37import subprocess
38import platform as _platform
39
40import SCons.Action
41import SCons.Builder
42import SCons.Scanner
43
44
45def 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
52def 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
56def install_program(env, source):
57    return install(env, source, 'bin')
58
59def 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
83def createInstallMethods(env):
84    env.AddMethod(install_program, 'InstallProgram')
85    env.AddMethod(install_shared_library, 'InstallSharedLibrary')
86
87
88def 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
107def 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    env.Tool(env['toolchain'])
117
118    # Allow override compiler and specify additional flags from environment
119    if os.environ.has_key('CC'):
120        env['CC'] = os.environ['CC']
121        # Update CCVERSION to match
122        pipe = SCons.Action._subproc(env, [env['CC'], '--version'],
123                                     stdin = 'devnull',
124                                     stderr = 'devnull',
125                                     stdout = subprocess.PIPE)
126        if pipe.wait() == 0:
127            line = pipe.stdout.readline()
128            match = re.search(r'[0-9]+(\.[0-9]+)+', line)
129            if match:
130                env['CCVERSION'] = match.group(0)
131    if os.environ.has_key('CFLAGS'):
132        env['CCFLAGS'] += SCons.Util.CLVar(os.environ['CFLAGS'])
133    if os.environ.has_key('CXX'):
134        env['CXX'] = os.environ['CXX']
135    if os.environ.has_key('CXXFLAGS'):
136        env['CXXFLAGS'] += SCons.Util.CLVar(os.environ['CXXFLAGS'])
137    if os.environ.has_key('LDFLAGS'):
138        env['LINKFLAGS'] += SCons.Util.CLVar(os.environ['LDFLAGS'])
139
140    env['gcc'] = 'gcc' in os.path.basename(env['CC']).split('-')
141    env['msvc'] = env['CC'] == 'cl'
142    env['suncc'] = env['platform'] == 'sunos' and os.path.basename(env['CC']) == 'cc'
143
144    if env['msvc'] and env['toolchain'] == 'default' and env['machine'] == 'x86_64':
145        # MSVC x64 support is broken in earlier versions of scons
146        env.EnsurePythonVersion(2, 0)
147
148    # shortcuts
149    machine = env['machine']
150    platform = env['platform']
151    x86 = env['machine'] == 'x86'
152    ppc = env['machine'] == 'ppc'
153    gcc = env['gcc']
154    msvc = env['msvc']
155    suncc = env['suncc']
156
157    # Determine whether we are cross compiling; in particular, whether we need
158    # to compile code generators with a different compiler as the target code.
159    host_platform = _platform.system().lower()
160    if host_platform.startswith('cygwin'):
161        host_platform = 'cygwin'
162    host_machine = os.environ.get('PROCESSOR_ARCHITEW6432', os.environ.get('PROCESSOR_ARCHITECTURE', _platform.machine()))
163    host_machine = {
164        'x86': 'x86',
165        'i386': 'x86',
166        'i486': 'x86',
167        'i586': 'x86',
168        'i686': 'x86',
169        'ppc' : 'ppc',
170        'AMD64': 'x86_64',
171        'x86_64': 'x86_64',
172    }.get(host_machine, 'generic')
173    env['crosscompile'] = platform != host_platform
174    if machine == 'x86_64' and host_machine != 'x86_64':
175        env['crosscompile'] = True
176    env['hostonly'] = False
177
178    # Backwards compatability with the debug= profile= options
179    if env['build'] == 'debug':
180        if not env['debug']:
181            print 'scons: warning: debug option is deprecated and will be removed eventually; use instead'
182            print
183            print ' scons build=release'
184            print
185            env['build'] = 'release'
186        if env['profile']:
187            print 'scons: warning: profile option is deprecated and will be removed eventually; use instead'
188            print
189            print ' scons build=profile'
190            print
191            env['build'] = 'profile'
192    if False:
193        # Enforce SConscripts to use the new build variable
194        env.popitem('debug')
195        env.popitem('profile')
196    else:
197        # Backwards portability with older sconscripts
198        if env['build'] in ('debug', 'checked'):
199            env['debug'] = True
200            env['profile'] = False
201        if env['build'] == 'profile':
202            env['debug'] = False
203            env['profile'] = True
204        if env['build'] == 'release':
205            env['debug'] = False
206            env['profile'] = False
207
208    # Put build output in a separate dir, which depends on the current
209    # configuration. See also http://www.scons.org/wiki/AdvancedBuildExample
210    build_topdir = 'build'
211    build_subdir = env['platform']
212    if env['embedded']:
213        build_subdir =  'embedded-' + build_subdir
214    if env['machine'] != 'generic':
215        build_subdir += '-' + env['machine']
216    if env['build'] != 'release':
217        build_subdir += '-' +  env['build']
218    build_dir = os.path.join(build_topdir, build_subdir)
219    # Place the .sconsign file in the build dir too, to avoid issues with
220    # different scons versions building the same source file
221    env['build_dir'] = build_dir
222    env.SConsignFile(os.path.join(build_dir, '.sconsign'))
223    if 'SCONS_CACHE_DIR' in os.environ:
224        print 'scons: Using build cache in %s.' % (os.environ['SCONS_CACHE_DIR'],)
225        env.CacheDir(os.environ['SCONS_CACHE_DIR'])
226    env['CONFIGUREDIR'] = os.path.join(build_dir, 'conf')
227    env['CONFIGURELOG'] = os.path.join(os.path.abspath(build_dir), 'config.log')
228
229    # Parallel build
230    if env.GetOption('num_jobs') <= 1:
231        env.SetOption('num_jobs', num_jobs())
232
233    env.Decider('MD5-timestamp')
234    env.SetOption('max_drift', 60)
235
236    # C preprocessor options
237    cppdefines = []
238    if env['build'] in ('debug', 'checked'):
239        cppdefines += ['DEBUG']
240    else:
241        cppdefines += ['NDEBUG']
242    if env['build'] == 'profile':
243        cppdefines += ['PROFILE']
244    if env['platform'] in ('posix', 'linux', 'freebsd', 'darwin'):
245        cppdefines += [
246            '_POSIX_SOURCE',
247            ('_POSIX_C_SOURCE', '199309L'),
248            '_SVID_SOURCE',
249            '_BSD_SOURCE',
250            '_GNU_SOURCE',
251            'PTHREADS',
252            'HAVE_POSIX_MEMALIGN',
253        ]
254        if env['platform'] == 'darwin':
255            cppdefines += [
256                '_DARWIN_C_SOURCE',
257                'GLX_USE_APPLEGL',
258                'GLX_DIRECT_RENDERING',
259            ]
260        else:
261            cppdefines += [
262                'GLX_DIRECT_RENDERING',
263                'GLX_INDIRECT_RENDERING',
264            ]
265        if env['platform'] in ('linux', 'freebsd'):
266            cppdefines += ['HAVE_ALIAS']
267        else:
268            cppdefines += ['GLX_ALIAS_UNSUPPORTED']
269    if platform == 'windows':
270        cppdefines += [
271            'WIN32',
272            '_WINDOWS',
273            #'_UNICODE',
274            #'UNICODE',
275            # http://msdn.microsoft.com/en-us/library/aa383745.aspx
276            ('_WIN32_WINNT', '0x0601'),
277            ('WINVER', '0x0601'),
278        ]
279        if gcc:
280            cppdefines += [('__MSVCRT_VERSION__', '0x0700')]
281        if msvc:
282            cppdefines += [
283                'VC_EXTRALEAN',
284                '_USE_MATH_DEFINES',
285                '_CRT_SECURE_NO_WARNINGS',
286                '_CRT_SECURE_NO_DEPRECATE',
287                '_SCL_SECURE_NO_WARNINGS',
288                '_SCL_SECURE_NO_DEPRECATE',
289            ]
290        if env['build'] in ('debug', 'checked'):
291            cppdefines += ['_DEBUG']
292    if platform == 'windows':
293        cppdefines += ['PIPE_SUBSYSTEM_WINDOWS_USER']
294    if platform == 'haiku':
295        cppdefines += ['BEOS_THREADS']
296    if env['embedded']:
297        cppdefines += ['PIPE_SUBSYSTEM_EMBEDDED']
298    env.Append(CPPDEFINES = cppdefines)
299
300    # C compiler options
301    cflags = [] # C
302    cxxflags = [] # C++
303    ccflags = [] # C & C++
304    if gcc:
305        ccversion = env['CCVERSION']
306        if env['build'] == 'debug':
307            ccflags += ['-O0']
308        elif ccversion.startswith('4.2.'):
309            # gcc 4.2.x optimizer is broken
310            print "warning: gcc 4.2.x optimizer is broken -- disabling optimizations"
311            ccflags += ['-O0']
312        else:
313            ccflags += ['-O3']
314        # gcc's builtin memcmp is slower than glibc's
315        # http://gcc.gnu.org/bugzilla/show_bug.cgi?id=43052
316        ccflags += ['-fno-builtin-memcmp']
317        # Work around aliasing bugs - developers should comment this out
318        ccflags += ['-fno-strict-aliasing']
319        ccflags += ['-g']
320        if env['build'] in ('checked', 'profile'):
321            # See http://code.google.com/p/jrfonseca/wiki/Gprof2Dot#Which_options_should_I_pass_to_gcc_when_compiling_for_profiling?
322            ccflags += [
323                '-fno-omit-frame-pointer',
324                '-fno-optimize-sibling-calls',
325            ]
326        if env['machine'] == 'x86':
327            ccflags += [
328                '-m32',
329                #'-march=pentium4',
330            ]
331            if distutils.version.LooseVersion(ccversion) >= distutils.version.LooseVersion('4.2') \
332               and (platform != 'windows' or env['build'] == 'debug' or True) \
333               and platform != 'haiku':
334                # NOTE: We need to ensure stack is realigned given that we
335                # produce shared objects, and have no control over the stack
336                # alignment policy of the application. Therefore we need
337                # -mstackrealign ore -mincoming-stack-boundary=2.
338                #
339                # XXX: -O and -mstackrealign causes stack corruption on MinGW
340                #
341                # XXX: We could have SSE without -mstackrealign if we always used
342                # __attribute__((force_align_arg_pointer)), but that's not
343                # always the case.
344                ccflags += [
345                    '-mstackrealign', # ensure stack is aligned
346                    '-mmmx', '-msse', '-msse2', # enable SIMD intrinsics
347                    #'-mfpmath=sse',
348                ]
349            if platform in ['windows', 'darwin']:
350                # Workaround http://gcc.gnu.org/bugzilla/show_bug.cgi?id=37216
351                ccflags += ['-fno-common']
352            if platform in ['haiku']:
353                # Make optimizations compatible with Pentium or higher on Haiku
354                ccflags += [
355                    '-mstackrealign', # ensure stack is aligned
356                    '-march=i586', # Haiku target is Pentium
357                    '-mtune=i686', # use i686 where we can
358                    '-mmmx' # use mmx math where we can
359                ]
360        if env['machine'] == 'x86_64':
361            ccflags += ['-m64']
362            if platform == 'darwin':
363                ccflags += ['-fno-common']
364        if env['platform'] not in ('windows', 'haiku'):
365            ccflags += ['-fvisibility=hidden']
366        # See also:
367        # - http://gcc.gnu.org/onlinedocs/gcc/Warning-Options.html
368        ccflags += [
369            '-Wall',
370            '-Wno-long-long',
371            '-ffast-math',
372            '-fmessage-length=0', # be nice to Eclipse
373        ]
374        cflags += [
375            '-Wmissing-prototypes',
376            '-std=gnu99',
377        ]
378        if distutils.version.LooseVersion(ccversion) >= distutils.version.LooseVersion('4.2'):
379            ccflags += [
380                '-Wpointer-arith',
381            ]
382            cflags += [
383                '-Wdeclaration-after-statement',
384            ]
385    if msvc:
386        # See also:
387        # - http://msdn.microsoft.com/en-us/library/19z1t1wy.aspx
388        # - cl /?
389        if env['build'] == 'debug':
390            ccflags += [
391              '/Od', # disable optimizations
392              '/Oi', # enable intrinsic functions
393              '/Oy-', # disable frame pointer omission
394            ]
395        else:
396            ccflags += [
397                '/O2', # optimize for speed
398            ]
399        if env['build'] == 'release':
400            ccflags += [
401                '/GL', # enable whole program optimization
402            ]
403        else:
404            ccflags += [
405                '/GL-', # disable whole program optimization
406            ]
407        ccflags += [
408            '/fp:fast', # fast floating point
409            '/W3', # warning level
410            #'/Wp64', # enable 64 bit porting warnings
411            '/wd4996', # disable deprecated POSIX name warnings
412        ]
413        if env['machine'] == 'x86':
414            ccflags += [
415                #'/arch:SSE2', # use the SSE2 instructions
416            ]
417        if platform == 'windows':
418            ccflags += [
419                # TODO
420            ]
421        # Automatic pdb generation
422        # See http://scons.tigris.org/issues/show_bug.cgi?id=1656
423        env.EnsureSConsVersion(0, 98, 0)
424        env['PDB'] = '${TARGET.base}.pdb'
425    env.Append(CCFLAGS = ccflags)
426    env.Append(CFLAGS = cflags)
427    env.Append(CXXFLAGS = cxxflags)
428
429    if env['platform'] == 'windows' and msvc:
430        # Choose the appropriate MSVC CRT
431        # http://msdn.microsoft.com/en-us/library/2kzt1wy3.aspx
432        if env['build'] in ('debug', 'checked'):
433            env.Append(CCFLAGS = ['/MTd'])
434            env.Append(SHCCFLAGS = ['/LDd'])
435        else:
436            env.Append(CCFLAGS = ['/MT'])
437            env.Append(SHCCFLAGS = ['/LD'])
438
439    # Assembler options
440    if gcc:
441        if env['machine'] == 'x86':
442            env.Append(ASFLAGS = ['-m32'])
443        if env['machine'] == 'x86_64':
444            env.Append(ASFLAGS = ['-m64'])
445
446    # Linker options
447    linkflags = []
448    shlinkflags = []
449    if gcc:
450        if env['machine'] == 'x86':
451            linkflags += ['-m32']
452        if env['machine'] == 'x86_64':
453            linkflags += ['-m64']
454        if env['platform'] not in ('darwin'):
455            shlinkflags += [
456                '-Wl,-Bsymbolic',
457            ]
458        # Handle circular dependencies in the libraries
459        if env['platform'] in ('darwin'):
460            pass
461        else:
462            env['_LIBFLAGS'] = '-Wl,--start-group ' + env['_LIBFLAGS'] + ' -Wl,--end-group'
463        if env['platform'] == 'windows':
464            # Avoid depending on gcc runtime DLLs
465            linkflags += ['-static-libgcc']
466            if 'w64' in env['CC'].split('-'):
467                linkflags += ['-static-libstdc++']
468            # Handle the @xx symbol munging of DLL exports
469            shlinkflags += ['-Wl,--enable-stdcall-fixup']
470            #shlinkflags += ['-Wl,--kill-at']
471    if msvc:
472        if env['build'] == 'release':
473            # enable Link-time Code Generation
474            linkflags += ['/LTCG']
475            env.Append(ARFLAGS = ['/LTCG'])
476    if platform == 'windows' and msvc:
477        # See also:
478        # - http://msdn2.microsoft.com/en-us/library/y0zzbyt4.aspx
479        linkflags += [
480            '/fixed:no',
481            '/incremental:no',
482        ]
483    env.Append(LINKFLAGS = linkflags)
484    env.Append(SHLINKFLAGS = shlinkflags)
485
486    # We have C++ in several libraries, so always link with the C++ compiler
487    if env['gcc']:
488        env['LINK'] = env['CXX']
489
490    # Default libs
491    libs = []
492    if env['platform'] in ('posix', 'linux', 'freebsd', 'darwin'):
493        libs += ['m', 'pthread', 'dl']
494    env.Append(LIBS = libs)
495
496    # OpenMP
497    if env['openmp']:
498        if env['msvc']:
499            env.Append(CCFLAGS = ['/openmp'])
500            # When building openmp release VS2008 link.exe crashes with LNK1103 error.
501            # Workaround: overwrite PDB flags with empty value as it isn't required anyways
502            if env['build'] == 'release':
503                env['PDB'] = ''
504        if env['gcc']:
505            env.Append(CCFLAGS = ['-fopenmp'])
506            env.Append(LIBS = ['gomp'])
507
508    # Load tools
509    env.Tool('lex')
510    env.Tool('yacc')
511    if env['llvm']:
512        env.Tool('llvm')
513
514    # Custom builders and methods
515    env.Tool('custom')
516    createInstallMethods(env)
517
518    env.PkgCheckModules('X11', ['x11', 'xext', 'xdamage', 'xfixes'])
519    env.PkgCheckModules('XCB', ['x11-xcb', 'xcb-glx'])
520    env.PkgCheckModules('XF86VIDMODE', ['xxf86vm'])
521    env.PkgCheckModules('DRM', ['libdrm >= 2.4.24'])
522    env.PkgCheckModules('DRM_INTEL', ['libdrm_intel >= 2.4.30'])
523    env.PkgCheckModules('DRM_RADEON', ['libdrm_radeon >= 2.4.31'])
524    env.PkgCheckModules('XORG', ['xorg-server >= 1.6.0'])
525    env.PkgCheckModules('KMS', ['libkms >= 2.4.24'])
526    env.PkgCheckModules('UDEV', ['libudev > 150'])
527
528    env['dri'] = env['x11'] and env['drm']
529
530    # for debugging
531    #print env.Dump()
532
533
534def exists(env):
535    return 1
536