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