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
  39 import SCons.Action
  40 import SCons.Builder
  41 import SCons.Scanner
  42
  43
  44 def symlink(target, source, env):
  45     target = str(target[0])
  46     source = str(source[0])
  47     if os.path.islink(target) or os.path.exists(target):
  48         os.remove(target)
  49     os.symlink(os.path.basename(source), target)
  50
  51 def install(env, source, subdir):
  52     target_dir = os.path.join(env.Dir('#.').srcnode().abspath, env['build'], subdir)
  53     env.Install(target_dir, source)
  54
  55 def install_program(env, source):
  56     install(env, source, 'bin')
  57
  58 def install_shared_library(env, sources, version = ()):
  59     install_dir = os.path.join(env.Dir('#.').srcnode().abspath, env['build'])
  60     version = tuple(map(str, version))
  61     if env['SHLIBSUFFIX'] == '.dll':
  62         dlls = env.FindIxes(sources, 'SHLIBPREFIX', 'SHLIBSUFFIX')
  63         install(env, dlls, 'bin')
  64         libs = env.FindIxes(sources, 'LIBPREFIX', 'LIBSUFFIX')
  65         install(env, libs, 'lib')
  66     else:
  67         for source in sources:
  68             target_dir =  os.path.join(install_dir, 'lib')
  69             target_name = '.'.join((str(source),) + version)
  70             last = env.InstallAs(os.path.join(target_dir, target_name), source)
  71             while len(version):
  72                 version = version[:-1]
  73                 target_name = '.'.join((str(source),) + version)
  74                 action = SCons.Action.Action(symlink, "$TARGET -> $SOURCE")
  75                 last = env.Command(os.path.join(target_dir, target_name), last, action)
  76
  77 def createInstallMethods(env):
  78     env.AddMethod(install_program, 'InstallProgram')
  79     env.AddMethod(install_shared_library, 'InstallSharedLibrary')
  80
  81
  82 def num_jobs():
  83     try:
  84         return int(os.environ['NUMBER_OF_PROCESSORS'])
  85     except (ValueError, KeyError):
  86         pass
  87
  88     try:
  89         return os.sysconf('SC_NPROCESSORS_ONLN')
  90     except (ValueError, OSError, AttributeError):
  91         pass
  92
  93     try:
  94         return int(os.popen2("sysctl -n hw.ncpu")[1].read())
  95     except ValueError:
  96         pass
  97
  98     return 1
  99
 100
 101 def generate(env):
 102     """Common environment generation code"""
 103
 104     # Toolchain
 105     platform = env['platform']
 106     if env['toolchain'] == 'default':
 107         if platform == 'winddk':
 108             env['toolchain'] = 'winddk'
 109         elif platform == 'wince':
 110             env['toolchain'] = 'wcesdk'
 111     env.Tool(env['toolchain'])
 112
 113     if env['platform'] == 'embedded':
 114         # Allow overriding compiler from environment
 115         if os.environ.has_key('CC'):
 116             env['CC'] = os.environ['CC']
 117             # Update CCVERSION to match
 118             pipe = SCons.Action._subproc(env, [env['CC'], '--version'],
 119                                          stdin = 'devnull',
 120                                          stderr = 'devnull',
 121                                          stdout = subprocess.PIPE)
 122             if pipe.wait() == 0:
 123                 line = pipe.stdout.readline()
 124                 match = re.search(r'[0-9]+(\.[0-9]+)+', line)
 125                 if match:
 126                     env['CCVERSION'] = match.group(0)
 127
 128
 129     env['gcc'] = 'gcc' in os.path.basename(env['CC']).split('-')
 130     env['msvc'] = env['CC'] == 'cl'
 131
 132     # shortcuts
 133     debug = env['debug']
 134     machine = env['machine']
 135     platform = env['platform']
 136     x86 = env['machine'] == 'x86'
 137     ppc = env['machine'] == 'ppc'
 138     gcc = env['gcc']
 139     msvc = env['msvc']
 140
 141     # Put build output in a separate dir, which depends on the current
 142     # configuration. See also http://www.scons.org/wiki/AdvancedBuildExample
 143     build_topdir = 'build'
 144     build_subdir = env['platform']
 145     if env['llvm']:
 146         build_subdir += "-llvm"
 147     if env['machine'] != 'generic':
 148         build_subdir += '-' + env['machine']
 149     if env['debug']:
 150         build_subdir += "-debug"
 151     if env['profile']:
 152         build_subdir += "-profile"
 153     build_dir = os.path.join(build_topdir, build_subdir)
 154     # Place the .sconsign file in the build dir too, to avoid issues with
 155     # different scons versions building the same source file
 156     env['build'] = build_dir
 157     env.SConsignFile(os.path.join(build_dir, '.sconsign'))
 158     if 'SCONS_CACHE_DIR' in os.environ:
 159         print 'scons: Using build cache in %s.' % (os.environ['SCONS_CACHE_DIR'],)
 160         env.CacheDir(os.environ['SCONS_CACHE_DIR'])
 161     env['CONFIGUREDIR'] = os.path.join(build_dir, 'conf')
 162     env['CONFIGURELOG'] = os.path.join(os.path.abspath(build_dir), 'config.log')
 163
 164     # Parallel build
 165     if env.GetOption('num_jobs') <= 1:
 166         env.SetOption('num_jobs', num_jobs())
 167
 168     # C preprocessor options
 169     cppdefines = []
 170     if debug:
 171         cppdefines += ['DEBUG']
 172     else:
 173         cppdefines += ['NDEBUG']
 174     if env['profile']:
 175         cppdefines += ['PROFILE']
 176     if platform == 'windows':
 177         cppdefines += [
 178             'WIN32',
 179             '_WINDOWS',
 180             #'_UNICODE',
 181             #'UNICODE',
 182             # http://msdn.microsoft.com/en-us/library/aa383745.aspx
 183             ('_WIN32_WINNT', '0x0601'),
 184             ('WINVER', '0x0601'),
 185         ]
 186         if msvc and env['toolchain'] != 'winddk':
 187             cppdefines += [
 188                 'VC_EXTRALEAN',
 189                 '_USE_MATH_DEFINES',
 190                 '_CRT_SECURE_NO_WARNINGS',
 191                 '_CRT_SECURE_NO_DEPRECATE',
 192                 '_SCL_SECURE_NO_WARNINGS',
 193                 '_SCL_SECURE_NO_DEPRECATE',
 194             ]
 195         if debug:
 196             cppdefines += ['_DEBUG']
 197     if env['toolchain'] == 'winddk':
 198         # Mimic WINDDK's builtin flags. See also:
 199         # - WINDDK's bin/makefile.new i386mk.inc for more info.
 200         # - buildchk_wxp_x86.log files, generated by the WINDDK's build
 201         # - http://alter.org.ua/docs/nt_kernel/vc8_proj/
 202         if machine == 'x86':
 203             cppdefines += ['_X86_', 'i386']
 204         if machine == 'x86_64':
 205             cppdefines += ['_AMD64_', 'AMD64']
 206     if platform == 'winddk':
 207         cppdefines += [
 208             'STD_CALL',
 209             ('CONDITION_HANDLING', '1'),
 210             ('NT_INST', '0'),
 211             ('WIN32', '100'),
 212             ('_NT1X_', '100'),
 213             ('WINNT', '1'),
 214             ('_WIN32_WINNT', '0x0501'), # minimum required OS version
 215             ('WINVER', '0x0501'),
 216             ('_WIN32_IE', '0x0603'),
 217             ('WIN32_LEAN_AND_MEAN', '1'),
 218             ('DEVL', '1'),
 219             ('__BUILDMACHINE__', 'WinDDK'),
 220             ('FPO', '0'),
 221         ]
 222         if debug:
 223             cppdefines += [('DBG', 1)]
 224     if platform == 'wince':
 225         cppdefines += [
 226             '_CRT_SECURE_NO_DEPRECATE',
 227             '_USE_32BIT_TIME_T',
 228             'UNICODE',
 229             '_UNICODE',
 230             ('UNDER_CE', '600'),
 231             ('_WIN32_WCE', '0x600'),
 232             'WINCEOEM',
 233             'WINCEINTERNAL',
 234             'WIN32',
 235             'STRICT',
 236             'x86',
 237             '_X86_',
 238             'INTERNATIONAL',
 239             ('INTLMSG_CODEPAGE', '1252'),
 240         ]
 241     if platform == 'windows':
 242         cppdefines += ['PIPE_SUBSYSTEM_WINDOWS_USER']
 243     if platform == 'winddk':
 244         cppdefines += ['PIPE_SUBSYSTEM_WINDOWS_DISPLAY']
 245     if platform == 'wince':
 246         cppdefines += ['PIPE_SUBSYSTEM_WINDOWS_CE']
 247         cppdefines += ['PIPE_SUBSYSTEM_WINDOWS_CE_OGL']
 248     if platform == 'embedded':
 249         cppdefines += ['PIPE_OS_EMBEDDED']
 250     env.Append(CPPDEFINES = cppdefines)
 251
 252     # C compiler options
 253     cflags = [] # C
 254     cxxflags = [] # C++
 255     ccflags = [] # C & C++
 256     if gcc:
 257         ccversion = env['CCVERSION']
 258         if debug:
 259             ccflags += ['-O0', '-g3']
 260         elif ccversion.startswith('4.2.'):
 261             # gcc 4.2.x optimizer is broken
 262             print "warning: gcc 4.2.x optimizer is broken -- disabling optimizations"
 263             ccflags += ['-O0', '-g3']
 264         else:
 265             ccflags += ['-O3', '-g3']
 266         if env['profile']:
 267             # See http://code.google.com/p/jrfonseca/wiki/Gprof2Dot#Which_options_should_I_pass_to_gcc_when_compiling_for_profiling?
 268             ccflags += [
 269                 '-fno-omit-frame-pointer',
 270                 '-fno-optimize-sibling-calls',
 271             ]
 272         if env['machine'] == 'x86':
 273             ccflags += [
 274                 '-m32',
 275                 #'-march=pentium4',
 276                 #'-mfpmath=sse',
 277             ]
 278             if platform != 'windows':
 279                 # XXX: -mstackrealign causes stack corruption on MinGW. Ditto
 280                 # for -mincoming-stack-boundary=2.  Still enable it on other
 281                 # platforms for now, but we can't rely on it for cross platform
 282                 # code. We have to use __attribute__((force_align_arg_pointer))
 283                 # instead.
 284                 ccflags += [
 285                     '-mmmx', '-msse', '-msse2', # enable SIMD intrinsics
 286                 ]
 287             if distutils.version.LooseVersion(ccversion) >= distutils.version.LooseVersion('4.2'):
 288                 ccflags += [
 289                     '-mstackrealign', # ensure stack is aligned
 290                 ]
 291         if env['machine'] == 'x86_64':
 292             ccflags += ['-m64']
 293         # See also:
 294         # - http://gcc.gnu.org/onlinedocs/gcc/Warning-Options.html
 295         ccflags += [
 296             '-Wall',
 297             '-Wmissing-field-initializers',
 298             '-Wno-long-long',
 299             '-ffast-math',
 300             '-fmessage-length=0', # be nice to Eclipse
 301         ]
 302         cflags += [
 303             '-Wmissing-prototypes',
 304             '-std=gnu99',
 305         ]
 306         if distutils.version.LooseVersion(ccversion) >= distutils.version.LooseVersion('4.2'):
 307             ccflags += [
 308                 '-Werror=pointer-arith',
 309             ]
 310             cflags += [
 311                 '-Werror=declaration-after-statement',
 312             ]
 313     if msvc:
 314         # See also:
 315         # - http://msdn.microsoft.com/en-us/library/19z1t1wy.aspx
 316         # - cl /?
 317         if debug:
 318             ccflags += [
 319               '/Od', # disable optimizations
 320               '/Oi', # enable intrinsic functions
 321               '/Oy-', # disable frame pointer omission
 322               '/GL-', # disable whole program optimization
 323             ]
 324         else:
 325             ccflags += [
 326                 '/O2', # optimize for speed
 327                 '/GL', # enable whole program optimization
 328             ]
 329         ccflags += [
 330             '/fp:fast', # fast floating point
 331             '/W3', # warning level
 332             #'/Wp64', # enable 64 bit porting warnings
 333         ]
 334         if env['machine'] == 'x86':
 335             ccflags += [
 336                 #'/arch:SSE2', # use the SSE2 instructions
 337             ]
 338         if platform == 'windows':
 339             ccflags += [
 340                 # TODO
 341             ]
 342         if platform == 'winddk':
 343             ccflags += [
 344                 '/Zl', # omit default library name in .OBJ
 345                 '/Zp8', # 8bytes struct member alignment
 346                 '/Gy', # separate functions for linker
 347                 '/Gm-', # disable minimal rebuild
 348                 '/WX', # treat warnings as errors
 349                 '/Gz', # __stdcall Calling convention
 350                 '/GX-', # disable C++ EH
 351                 '/GR-', # disable C++ RTTI
 352                 '/GF', # enable read-only string pooling
 353                 '/G6', # optimize for PPro, P-II, P-III
 354                 '/Ze', # enable extensions
 355                 '/Gi-', # disable incremental compilation
 356                 '/QIfdiv-', # disable Pentium FDIV fix
 357                 '/hotpatch', # prepares an image for hotpatching.
 358                 #'/Z7', #enable old-style debug info
 359             ]
 360         if platform == 'wince':
 361             # See also C:\WINCE600\public\common\oak\misc\makefile.def
 362             ccflags += [
 363                 '/Zl', # omit default library name in .OBJ
 364                 '/GF', # enable read-only string pooling
 365                 '/GR-', # disable C++ RTTI
 366                 '/GS', # enable security checks
 367                 # Allow disabling language conformance to maintain backward compat
 368                 #'/Zc:wchar_t-', # don't force wchar_t as native type, instead of typedef
 369                 #'/Zc:forScope-', # don't enforce Standard C++ for scoping rules
 370                 #'/wd4867',
 371                 #'/wd4430',
 372                 #'/MT',
 373                 #'/U_MT',
 374             ]
 375         # Automatic pdb generation
 376         # See http://scons.tigris.org/issues/show_bug.cgi?id=1656
 377         env.EnsureSConsVersion(0, 98, 0)
 378         env['PDB'] = '${TARGET.base}.pdb'
 379     env.Append(CCFLAGS = ccflags)
 380     env.Append(CFLAGS = cflags)
 381     env.Append(CXXFLAGS = cxxflags)
 382
 383     if env['platform'] == 'windows' and msvc:
 384         # Choose the appropriate MSVC CRT
 385         # http://msdn.microsoft.com/en-us/library/2kzt1wy3.aspx
 386         if env['debug']:
 387             env.Append(CCFLAGS = ['/MTd'])
 388             env.Append(SHCCFLAGS = ['/LDd'])
 389         else:
 390             env.Append(CCFLAGS = ['/MT'])
 391             env.Append(SHCCFLAGS = ['/LD'])
 392
 393     # Assembler options
 394     if gcc:
 395         if env['machine'] == 'x86':
 396             env.Append(ASFLAGS = ['-m32'])
 397         if env['machine'] == 'x86_64':
 398             env.Append(ASFLAGS = ['-m64'])
 399
 400     # Linker options
 401     linkflags = []
 402     shlinkflags = []
 403     if gcc:
 404         if env['machine'] == 'x86':
 405             linkflags += ['-m32']
 406         if env['machine'] == 'x86_64':
 407             linkflags += ['-m64']
 408         if env['platform'] not in ('darwin'):
 409             shlinkflags += [
 410                 '-Wl,-Bsymbolic',
 411             ]
 412         # Handle circular dependencies in the libraries
 413         if env['platform'] in ('darwin'):
 414             pass
 415         else:
 416             env['_LIBFLAGS'] = '-Wl,--start-group ' + env['_LIBFLAGS'] + ' -Wl,--end-group'
 417     if msvc:
 418         if not env['debug']:
 419             # enable Link-time Code Generation
 420             linkflags += ['/LTCG']
 421             env.Append(ARFLAGS = ['/LTCG'])
 422     if platform == 'windows' and msvc:
 423         # See also:
 424         # - http://msdn2.microsoft.com/en-us/library/y0zzbyt4.aspx
 425         linkflags += [
 426             '/fixed:no',
 427             '/incremental:no',
 428         ]
 429     if platform == 'winddk':
 430         linkflags += [
 431             '/merge:_PAGE=PAGE',
 432             '/merge:_TEXT=.text',
 433             '/section:INIT,d',
 434             '/opt:ref',
 435             '/opt:icf',
 436             '/ignore:4198,4010,4037,4039,4065,4070,4078,4087,4089,4221',
 437             '/incremental:no',
 438             '/fullbuild',
 439             '/release',
 440             '/nodefaultlib',
 441             '/wx',
 442             '/debug',
 443             '/debugtype:cv',
 444             '/version:5.1',
 445             '/osversion:5.1',
 446             '/functionpadmin:5',
 447             '/safeseh',
 448             '/pdbcompress',
 449             '/stack:0x40000,0x1000',
 450             '/driver',
 451             '/align:0x80',
 452             '/subsystem:native,5.01',
 453             '/base:0x10000',
 454
 455             '/entry:DrvEnableDriver',
 456         ]
 457         if env['debug'] or env['profile']:
 458             linkflags += [
 459                 '/MAP', # http://msdn.microsoft.com/en-us/library/k7xkk3e2.aspx
 460             ]
 461     if platform == 'wince':
 462         linkflags += [
 463             '/nodefaultlib',
 464             #'/incremental:no',
 465             #'/fullbuild',
 466             '/entry:_DllMainCRTStartup',
 467         ]
 468     env.Append(LINKFLAGS = linkflags)
 469     env.Append(SHLINKFLAGS = shlinkflags)
 470
 471     # Default libs
 472     env.Append(LIBS = [])
 473
 474     # Custom builders and methods
 475     env.Tool('custom')
 476     createInstallMethods(env)
 477
 478     # for debugging
 479     #print env.Dump()
 480
 481
 482 def exists(env):
 483     return 1