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     env['icc'] = 'icc' == os.path.basename(env['CC'])
 145
 146     if env['msvc'] and env['toolchain'] == 'default' and env['machine'] == 'x86_64':
 147         # MSVC x64 support is broken in earlier versions of scons
 148         env.EnsurePythonVersion(2, 0)
 149
 150     # shortcuts
 151     machine = env['machine']
 152     platform = env['platform']
 153     x86 = env['machine'] == 'x86'
 154     ppc = env['machine'] == 'ppc'
 155     gcc = env['gcc']
 156     msvc = env['msvc']
 157     suncc = env['suncc']
 158     icc = env['icc']
 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 gcc:
 283             cppdefines += [('__MSVCRT_VERSION__', '0x0700')]
 284         if msvc:
 285             cppdefines += [
 286                 'VC_EXTRALEAN',
 287                 '_USE_MATH_DEFINES',
 288                 '_CRT_SECURE_NO_WARNINGS',
 289                 '_CRT_SECURE_NO_DEPRECATE',
 290                 '_SCL_SECURE_NO_WARNINGS',
 291                 '_SCL_SECURE_NO_DEPRECATE',
 292             ]
 293         if env['build'] in ('debug', 'checked'):
 294             cppdefines += ['_DEBUG']
 295     if platform == 'windows':
 296         cppdefines += ['PIPE_SUBSYSTEM_WINDOWS_USER']
 297     if platform == 'haiku':
 298         cppdefines += ['BEOS_THREADS']
 299     if env['embedded']:
 300         cppdefines += ['PIPE_SUBSYSTEM_EMBEDDED']
 301     env.Append(CPPDEFINES = cppdefines)
 302
 303     # C compiler options
 304     cflags = [] # C
 305     cxxflags = [] # C++
 306     ccflags = [] # C & C++
 307     if gcc:
 308         ccversion = env['CCVERSION']
 309         if env['build'] == 'debug':
 310             ccflags += ['-O0']
 311         elif ccversion.startswith('4.2.'):
 312             # gcc 4.2.x optimizer is broken
 313             print "warning: gcc 4.2.x optimizer is broken -- disabling optimizations"
 314             ccflags += ['-O0']
 315         else:
 316             ccflags += ['-O3']
 317         # gcc's builtin memcmp is slower than glibc's
 318         # http://gcc.gnu.org/bugzilla/show_bug.cgi?id=43052
 319         ccflags += ['-fno-builtin-memcmp']
 320         # Work around aliasing bugs - developers should comment this out
 321         ccflags += ['-fno-strict-aliasing']
 322         ccflags += ['-g']
 323         if env['build'] in ('checked', 'profile'):
 324             # See http://code.google.com/p/jrfonseca/wiki/Gprof2Dot#Which_options_should_I_pass_to_gcc_when_compiling_for_profiling?
 325             ccflags += [
 326                 '-fno-omit-frame-pointer',
 327                 '-fno-optimize-sibling-calls',
 328             ]
 329         if env['machine'] == 'x86':
 330             ccflags += [
 331                 '-m32',
 332                 #'-march=pentium4',
 333             ]
 334             if distutils.version.LooseVersion(ccversion) >= distutils.version.LooseVersion('4.2') \
 335                and (platform != 'windows' or env['build'] == 'debug' or True) \
 336                and platform != 'haiku':
 337                 # NOTE: We need to ensure stack is realigned given that we
 338                 # produce shared objects, and have no control over the stack
 339                 # alignment policy of the application. Therefore we need
 340                 # -mstackrealign ore -mincoming-stack-boundary=2.
 341                 #
 342                 # XXX: -O and -mstackrealign causes stack corruption on MinGW
 343                 #
 344                 # XXX: We could have SSE without -mstackrealign if we always used
 345                 # __attribute__((force_align_arg_pointer)), but that's not
 346                 # always the case.
 347                 ccflags += [
 348                     '-mstackrealign', # ensure stack is aligned
 349                     '-mmmx', '-msse', '-msse2', # enable SIMD intrinsics
 350                     #'-mfpmath=sse',
 351                 ]
 352             if platform in ['windows', 'darwin']:
 353                 # Workaround http://gcc.gnu.org/bugzilla/show_bug.cgi?id=37216
 354                 ccflags += ['-fno-common']
 355             if platform in ['haiku']:
 356                 # Make optimizations compatible with Pentium or higher on Haiku
 357                 ccflags += [
 358                     '-mstackrealign', # ensure stack is aligned
 359                     '-march=i586', # Haiku target is Pentium
 360                     '-mtune=i686', # use i686 where we can
 361                     '-mmmx' # use mmx math where we can
 362                 ]
 363         if env['machine'] == 'x86_64':
 364             ccflags += ['-m64']
 365             if platform == 'darwin':
 366                 ccflags += ['-fno-common']
 367         if env['platform'] not in ('windows', 'haiku'):
 368             ccflags += ['-fvisibility=hidden']
 369         # See also:
 370         # - http://gcc.gnu.org/onlinedocs/gcc/Warning-Options.html
 371         ccflags += [
 372             '-Wall',
 373             '-Wno-long-long',
 374             '-fmessage-length=0', # be nice to Eclipse
 375         ]
 376         cflags += [
 377             '-Wmissing-prototypes',
 378             '-std=gnu99',
 379         ]
 380         if distutils.version.LooseVersion(ccversion) >= distutils.version.LooseVersion('4.2'):
 381             ccflags += [
 382                 '-Wpointer-arith',
 383             ]
 384             cflags += [
 385                 '-Wdeclaration-after-statement',
 386             ]
 387     if icc:
 388         cflags += [
 389             '-std=gnu99',
 390         ]
 391     if msvc:
 392         # See also:
 393         # - http://msdn.microsoft.com/en-us/library/19z1t1wy.aspx
 394         # - cl /?
 395         if env['build'] == 'debug':
 396             ccflags += [
 397               '/Od', # disable optimizations
 398               '/Oi', # enable intrinsic functions
 399               '/Oy-', # disable frame pointer omission
 400             ]
 401         else:
 402             ccflags += [
 403                 '/O2', # optimize for speed
 404             ]
 405         if env['build'] == 'release':
 406             ccflags += [
 407                 '/GL', # enable whole program optimization
 408             ]
 409         else:
 410             ccflags += [
 411                 '/GL-', # disable whole program optimization
 412             ]
 413         ccflags += [
 414             '/W3', # warning level
 415             #'/Wp64', # enable 64 bit porting warnings
 416             '/wd4996', # disable deprecated POSIX name warnings
 417         ]
 418         if env['machine'] == 'x86':
 419             ccflags += [
 420                 #'/arch:SSE2', # use the SSE2 instructions
 421             ]
 422         if platform == 'windows':
 423             ccflags += [
 424                 # TODO
 425             ]
 426         # Automatic pdb generation
 427         # See http://scons.tigris.org/issues/show_bug.cgi?id=1656
 428         env.EnsureSConsVersion(0, 98, 0)
 429         env['PDB'] = '${TARGET.base}.pdb'
 430     env.Append(CCFLAGS = ccflags)
 431     env.Append(CFLAGS = cflags)
 432     env.Append(CXXFLAGS = cxxflags)
 433
 434     if env['platform'] == 'windows' and msvc:
 435         # Choose the appropriate MSVC CRT
 436         # http://msdn.microsoft.com/en-us/library/2kzt1wy3.aspx
 437         if env['build'] in ('debug', 'checked'):
 438             env.Append(CCFLAGS = ['/MTd'])
 439             env.Append(SHCCFLAGS = ['/LDd'])
 440         else:
 441             env.Append(CCFLAGS = ['/MT'])
 442             env.Append(SHCCFLAGS = ['/LD'])
 443
 444     # Assembler options
 445     if gcc:
 446         if env['machine'] == 'x86':
 447             env.Append(ASFLAGS = ['-m32'])
 448         if env['machine'] == 'x86_64':
 449             env.Append(ASFLAGS = ['-m64'])
 450
 451     # Linker options
 452     linkflags = []
 453     shlinkflags = []
 454     if gcc:
 455         if env['machine'] == 'x86':
 456             linkflags += ['-m32']
 457         if env['machine'] == 'x86_64':
 458             linkflags += ['-m64']
 459         if env['platform'] not in ('darwin'):
 460             shlinkflags += [
 461                 '-Wl,-Bsymbolic',
 462             ]
 463         # Handle circular dependencies in the libraries
 464         if env['platform'] in ('darwin'):
 465             pass
 466         else:
 467             env['_LIBFLAGS'] = '-Wl,--start-group ' + env['_LIBFLAGS'] + ' -Wl,--end-group'
 468         if env['platform'] == 'windows':
 469             # Avoid depending on gcc runtime DLLs
 470             linkflags += ['-static-libgcc']
 471             if 'w64' in env['CC'].split('-'):
 472                 linkflags += ['-static-libstdc++']
 473             # Handle the @xx symbol munging of DLL exports
 474             shlinkflags += ['-Wl,--enable-stdcall-fixup']
 475             #shlinkflags += ['-Wl,--kill-at']
 476     if msvc:
 477         if env['build'] == 'release':
 478             # enable Link-time Code Generation
 479             linkflags += ['/LTCG']
 480             env.Append(ARFLAGS = ['/LTCG'])
 481     if platform == 'windows' and msvc:
 482         # See also:
 483         # - http://msdn2.microsoft.com/en-us/library/y0zzbyt4.aspx
 484         linkflags += [
 485             '/fixed:no',
 486             '/incremental:no',
 487         ]
 488     env.Append(LINKFLAGS = linkflags)
 489     env.Append(SHLINKFLAGS = shlinkflags)
 490
 491     # We have C++ in several libraries, so always link with the C++ compiler
 492     if env['gcc'] or env['clang']:
 493         env['LINK'] = env['CXX']
 494
 495     # Default libs
 496     libs = []
 497     if env['platform'] in ('posix', 'linux', 'freebsd', 'darwin'):
 498         libs += ['m', 'pthread', 'dl']
 499     env.Append(LIBS = libs)
 500
 501     # OpenMP
 502     if env['openmp']:
 503         if env['msvc']:
 504             env.Append(CCFLAGS = ['/openmp'])
 505             # When building openmp release VS2008 link.exe crashes with LNK1103 error.
 506             # Workaround: overwrite PDB flags with empty value as it isn't required anyways
 507             if env['build'] == 'release':
 508                 env['PDB'] = ''
 509         if env['gcc']:
 510             env.Append(CCFLAGS = ['-fopenmp'])
 511             env.Append(LIBS = ['gomp'])
 512
 513     # Load tools
 514     env.Tool('lex')
 515     env.Tool('yacc')
 516     if env['llvm']:
 517         env.Tool('llvm')
 518
 519     # Custom builders and methods
 520     env.Tool('custom')
 521     createInstallMethods(env)
 522
 523     env.PkgCheckModules('X11', ['x11', 'xext', 'xdamage', 'xfixes'])
 524     env.PkgCheckModules('XCB', ['x11-xcb', 'xcb-glx >= 1.8.1'])
 525     env.PkgCheckModules('XF86VIDMODE', ['xxf86vm'])
 526     env.PkgCheckModules('DRM', ['libdrm >= 2.4.24'])
 527     env.PkgCheckModules('DRM_INTEL', ['libdrm_intel >= 2.4.30'])
 528     env.PkgCheckModules('DRM_RADEON', ['libdrm_radeon >= 2.4.31'])
 529     env.PkgCheckModules('XORG', ['xorg-server >= 1.6.0'])
 530     env.PkgCheckModules('KMS', ['libkms >= 2.4.24'])
 531     env.PkgCheckModules('UDEV', ['libudev > 150'])
 532
 533     env['dri'] = env['x11'] and env['drm']
 534
 535     # for debugging
 536     #print env.Dump()
 537
 538
 539 def exists(env):
 540     return 1