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