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