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_dir'], 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_dir'])
  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     machine = env['machine']
 134     platform = env['platform']
 135     x86 = env['machine'] == 'x86'
 136     ppc = env['machine'] == 'ppc'
 137     gcc = env['gcc']
 138     msvc = env['msvc']
 139
 140     # Backwards compatability with the debug= profile= options
 141     if env['build'] == 'debug':
 142         if not env['debug']:
 143             print 'scons: debug option is deprecated: use instead build=release'
 144             env['build'] = 'release'
 145         if env['profile']:
 146             print 'scons: profile option is deprecated: use instead build=profile'
 147             env['build'] = 'profile'
 148     if False:
 149         # Enforce SConscripts to use the new build variable
 150         env.popitem('debug')
 151         env.popitem('profile')
 152     else:
 153         # Backwards portability with older sconscripts
 154         if env['build'] in ('debug', 'checked'):
 155             env['debug'] = True
 156             env['profile'] = False
 157         if env['build'] == 'profile':
 158             env['debug'] = False
 159             env['profile'] = True
 160         if env['build'] == 'release':
 161             env['debug'] = False
 162             env['profile'] = False
 163
 164     # Put build output in a separate dir, which depends on the current
 165     # configuration. See also http://www.scons.org/wiki/AdvancedBuildExample
 166     build_topdir = 'build'
 167     build_subdir = env['platform']
 168     if env['machine'] != 'generic':
 169         build_subdir += '-' + env['machine']
 170     if env['build'] != 'release':
 171         build_subdir += '-' +  env['build']
 172     build_dir = os.path.join(build_topdir, build_subdir)
 173     # Place the .sconsign file in the build dir too, to avoid issues with
 174     # different scons versions building the same source file
 175     env['build_dir'] = build_dir
 176     env.SConsignFile(os.path.join(build_dir, '.sconsign'))
 177     if 'SCONS_CACHE_DIR' in os.environ:
 178         print 'scons: Using build cache in %s.' % (os.environ['SCONS_CACHE_DIR'],)
 179         env.CacheDir(os.environ['SCONS_CACHE_DIR'])
 180     env['CONFIGUREDIR'] = os.path.join(build_dir, 'conf')
 181     env['CONFIGURELOG'] = os.path.join(os.path.abspath(build_dir), 'config.log')
 182
 183     # Parallel build
 184     if env.GetOption('num_jobs') <= 1:
 185         env.SetOption('num_jobs', num_jobs())
 186
 187     # C preprocessor options
 188     cppdefines = []
 189     if env['build'] in ('debug', 'checked'):
 190         cppdefines += ['DEBUG']
 191     else:
 192         cppdefines += ['NDEBUG']
 193     if env['build'] == 'profile':
 194         cppdefines += ['PROFILE']
 195     if platform == 'windows':
 196         cppdefines += [
 197             'WIN32',
 198             '_WINDOWS',
 199             #'_UNICODE',
 200             #'UNICODE',
 201             # http://msdn.microsoft.com/en-us/library/aa383745.aspx
 202             ('_WIN32_WINNT', '0x0601'),
 203             ('WINVER', '0x0601'),
 204         ]
 205         if msvc and env['toolchain'] != 'winddk':
 206             cppdefines += [
 207                 'VC_EXTRALEAN',
 208                 '_USE_MATH_DEFINES',
 209                 '_CRT_SECURE_NO_WARNINGS',
 210                 '_CRT_SECURE_NO_DEPRECATE',
 211                 '_SCL_SECURE_NO_WARNINGS',
 212                 '_SCL_SECURE_NO_DEPRECATE',
 213             ]
 214         if env['build'] in ('debug', 'checked'):
 215             cppdefines += ['_DEBUG']
 216     if env['toolchain'] == 'winddk':
 217         # Mimic WINDDK's builtin flags. See also:
 218         # - WINDDK's bin/makefile.new i386mk.inc for more info.
 219         # - buildchk_wxp_x86.log files, generated by the WINDDK's build
 220         # - http://alter.org.ua/docs/nt_kernel/vc8_proj/
 221         if machine == 'x86':
 222             cppdefines += ['_X86_', 'i386']
 223         if machine == 'x86_64':
 224             cppdefines += ['_AMD64_', 'AMD64']
 225     if platform == 'winddk':
 226         cppdefines += [
 227             'STD_CALL',
 228             ('CONDITION_HANDLING', '1'),
 229             ('NT_INST', '0'),
 230             ('WIN32', '100'),
 231             ('_NT1X_', '100'),
 232             ('WINNT', '1'),
 233             ('_WIN32_WINNT', '0x0501'), # minimum required OS version
 234             ('WINVER', '0x0501'),
 235             ('_WIN32_IE', '0x0603'),
 236             ('WIN32_LEAN_AND_MEAN', '1'),
 237             ('DEVL', '1'),
 238             ('__BUILDMACHINE__', 'WinDDK'),
 239             ('FPO', '0'),
 240         ]
 241         if env['build'] in ('debug', 'checked'):
 242             cppdefines += [('DBG', 1)]
 243     if platform == 'wince':
 244         cppdefines += [
 245             '_CRT_SECURE_NO_DEPRECATE',
 246             '_USE_32BIT_TIME_T',
 247             'UNICODE',
 248             '_UNICODE',
 249             ('UNDER_CE', '600'),
 250             ('_WIN32_WCE', '0x600'),
 251             'WINCEOEM',
 252             'WINCEINTERNAL',
 253             'WIN32',
 254             'STRICT',
 255             'x86',
 256             '_X86_',
 257             'INTERNATIONAL',
 258             ('INTLMSG_CODEPAGE', '1252'),
 259         ]
 260     if platform == 'windows':
 261         cppdefines += ['PIPE_SUBSYSTEM_WINDOWS_USER']
 262     if platform == 'winddk':
 263         cppdefines += ['PIPE_SUBSYSTEM_WINDOWS_DISPLAY']
 264     if platform == 'wince':
 265         cppdefines += ['PIPE_SUBSYSTEM_WINDOWS_CE']
 266         cppdefines += ['PIPE_SUBSYSTEM_WINDOWS_CE_OGL']
 267     if platform == 'embedded':
 268         cppdefines += ['PIPE_OS_EMBEDDED']
 269     env.Append(CPPDEFINES = cppdefines)
 270
 271     # C compiler options
 272     cflags = [] # C
 273     cxxflags = [] # C++
 274     ccflags = [] # C & C++
 275     if gcc:
 276         ccversion = env['CCVERSION']
 277         if env['build'] == 'debug':
 278             ccflags += ['-O0']
 279         elif ccversion.startswith('4.2.'):
 280             # gcc 4.2.x optimizer is broken
 281             print "warning: gcc 4.2.x optimizer is broken -- disabling optimizations"
 282             ccflags += ['-O0']
 283         else:
 284             ccflags += ['-O3']
 285         ccflags += ['-g3']
 286         if env['build'] in ('checked', 'profile'):
 287             # See http://code.google.com/p/jrfonseca/wiki/Gprof2Dot#Which_options_should_I_pass_to_gcc_when_compiling_for_profiling?
 288             ccflags += [
 289                 '-fno-omit-frame-pointer',
 290                 '-fno-optimize-sibling-calls',
 291             ]
 292         if env['machine'] == 'x86':
 293             ccflags += [
 294                 '-m32',
 295                 #'-march=pentium4',
 296             ]
 297             if distutils.version.LooseVersion(ccversion) >= distutils.version.LooseVersion('4.2'):
 298                 # NOTE: We need to ensure stack is realigned given that we
 299                 # produce shared objects, and have no control over the stack
 300                 # alignment policy of the application. Therefore we need
 301                 # -mstackrealign ore -mincoming-stack-boundary=2.
 302                 #
 303                 # XXX: We could have SSE without -mstackrealign if we always used
 304                 # __attribute__((force_align_arg_pointer)), but that's not
 305                 # always the case.
 306                 ccflags += [
 307                     '-mstackrealign', # ensure stack is aligned
 308                     '-mmmx', '-msse', '-msse2', # enable SIMD intrinsics
 309                     #'-mfpmath=sse',
 310                 ]
 311             if platform in ['windows', 'darwin']:
 312                 # Workaround http://gcc.gnu.org/bugzilla/show_bug.cgi?id=37216
 313                 ccflags += ['-fno-common']
 314         if env['machine'] == 'x86_64':
 315             ccflags += ['-m64']
 316             if platform == 'darwin':
 317                 ccflags += ['-fno-common']
 318         # See also:
 319         # - http://gcc.gnu.org/onlinedocs/gcc/Warning-Options.html
 320         ccflags += [
 321             '-Wall',
 322             '-Wno-long-long',
 323             '-ffast-math',
 324             '-fmessage-length=0', # be nice to Eclipse
 325         ]
 326         cflags += [
 327             '-Wmissing-prototypes',
 328             '-std=gnu99',
 329         ]
 330         if distutils.version.LooseVersion(ccversion) >= distutils.version.LooseVersion('4.0'):
 331             ccflags += [
 332                 '-Wmissing-field-initializers',
 333             ]
 334         if distutils.version.LooseVersion(ccversion) >= distutils.version.LooseVersion('4.2'):
 335             ccflags += [
 336                 '-Werror=pointer-arith',
 337             ]
 338             cflags += [
 339                 '-Werror=declaration-after-statement',
 340             ]
 341     if msvc:
 342         # See also:
 343         # - http://msdn.microsoft.com/en-us/library/19z1t1wy.aspx
 344         # - cl /?
 345         if env['build'] == 'debug':
 346             ccflags += [
 347               '/Od', # disable optimizations
 348               '/Oi', # enable intrinsic functions
 349               '/Oy-', # disable frame pointer omission
 350               '/GL-', # disable whole program optimization
 351             ]
 352         else:
 353             ccflags += [
 354                 '/O2', # optimize for speed
 355                 '/GL', # enable whole program optimization
 356             ]
 357         ccflags += [
 358             '/fp:fast', # fast floating point
 359             '/W3', # warning level
 360             #'/Wp64', # enable 64 bit porting warnings
 361         ]
 362         if env['machine'] == 'x86':
 363             ccflags += [
 364                 #'/arch:SSE2', # use the SSE2 instructions
 365             ]
 366         if platform == 'windows':
 367             ccflags += [
 368                 # TODO
 369             ]
 370         if platform == 'winddk':
 371             ccflags += [
 372                 '/Zl', # omit default library name in .OBJ
 373                 '/Zp8', # 8bytes struct member alignment
 374                 '/Gy', # separate functions for linker
 375                 '/Gm-', # disable minimal rebuild
 376                 '/WX', # treat warnings as errors
 377                 '/Gz', # __stdcall Calling convention
 378                 '/GX-', # disable C++ EH
 379                 '/GR-', # disable C++ RTTI
 380                 '/GF', # enable read-only string pooling
 381                 '/G6', # optimize for PPro, P-II, P-III
 382                 '/Ze', # enable extensions
 383                 '/Gi-', # disable incremental compilation
 384                 '/QIfdiv-', # disable Pentium FDIV fix
 385                 '/hotpatch', # prepares an image for hotpatching.
 386                 #'/Z7', #enable old-style debug info
 387             ]
 388         if platform == 'wince':
 389             # See also C:\WINCE600\public\common\oak\misc\makefile.def
 390             ccflags += [
 391                 '/Zl', # omit default library name in .OBJ
 392                 '/GF', # enable read-only string pooling
 393                 '/GR-', # disable C++ RTTI
 394                 '/GS', # enable security checks
 395                 # Allow disabling language conformance to maintain backward compat
 396                 #'/Zc:wchar_t-', # don't force wchar_t as native type, instead of typedef
 397                 #'/Zc:forScope-', # don't enforce Standard C++ for scoping rules
 398                 #'/wd4867',
 399                 #'/wd4430',
 400                 #'/MT',
 401                 #'/U_MT',
 402             ]
 403         # Automatic pdb generation
 404         # See http://scons.tigris.org/issues/show_bug.cgi?id=1656
 405         env.EnsureSConsVersion(0, 98, 0)
 406         env['PDB'] = '${TARGET.base}.pdb'
 407     env.Append(CCFLAGS = ccflags)
 408     env.Append(CFLAGS = cflags)
 409     env.Append(CXXFLAGS = cxxflags)
 410
 411     if env['platform'] == 'windows' and msvc:
 412         # Choose the appropriate MSVC CRT
 413         # http://msdn.microsoft.com/en-us/library/2kzt1wy3.aspx
 414         if env['build'] in ('debug', 'checked'):
 415             env.Append(CCFLAGS = ['/MTd'])
 416             env.Append(SHCCFLAGS = ['/LDd'])
 417         else:
 418             env.Append(CCFLAGS = ['/MT'])
 419             env.Append(SHCCFLAGS = ['/LD'])
 420
 421     # Assembler options
 422     if gcc:
 423         if env['machine'] == 'x86':
 424             env.Append(ASFLAGS = ['-m32'])
 425         if env['machine'] == 'x86_64':
 426             env.Append(ASFLAGS = ['-m64'])
 427
 428     # Linker options
 429     linkflags = []
 430     shlinkflags = []
 431     if gcc:
 432         if env['machine'] == 'x86':
 433             linkflags += ['-m32']
 434         if env['machine'] == 'x86_64':
 435             linkflags += ['-m64']
 436         if env['platform'] not in ('darwin'):
 437             shlinkflags += [
 438                 '-Wl,-Bsymbolic',
 439             ]
 440         # Handle circular dependencies in the libraries
 441         if env['platform'] in ('darwin'):
 442             pass
 443         else:
 444             env['_LIBFLAGS'] = '-Wl,--start-group ' + env['_LIBFLAGS'] + ' -Wl,--end-group'
 445     if msvc:
 446         if env['build'] != 'debug':
 447             # enable Link-time Code Generation
 448             linkflags += ['/LTCG']
 449             env.Append(ARFLAGS = ['/LTCG'])
 450     if platform == 'windows' and msvc:
 451         # See also:
 452         # - http://msdn2.microsoft.com/en-us/library/y0zzbyt4.aspx
 453         linkflags += [
 454             '/fixed:no',
 455             '/incremental:no',
 456         ]
 457     if platform == 'winddk':
 458         linkflags += [
 459             '/merge:_PAGE=PAGE',
 460             '/merge:_TEXT=.text',
 461             '/section:INIT,d',
 462             '/opt:ref',
 463             '/opt:icf',
 464             '/ignore:4198,4010,4037,4039,4065,4070,4078,4087,4089,4221',
 465             '/incremental:no',
 466             '/fullbuild',
 467             '/release',
 468             '/nodefaultlib',
 469             '/wx',
 470             '/debug',
 471             '/debugtype:cv',
 472             '/version:5.1',
 473             '/osversion:5.1',
 474             '/functionpadmin:5',
 475             '/safeseh',
 476             '/pdbcompress',
 477             '/stack:0x40000,0x1000',
 478             '/driver',
 479             '/align:0x80',
 480             '/subsystem:native,5.01',
 481             '/base:0x10000',
 482
 483             '/entry:DrvEnableDriver',
 484         ]
 485         if env['build'] != 'release':
 486             linkflags += [
 487                 '/MAP', # http://msdn.microsoft.com/en-us/library/k7xkk3e2.aspx
 488             ]
 489     if platform == 'wince':
 490         linkflags += [
 491             '/nodefaultlib',
 492             #'/incremental:no',
 493             #'/fullbuild',
 494             '/entry:_DllMainCRTStartup',
 495         ]
 496     env.Append(LINKFLAGS = linkflags)
 497     env.Append(SHLINKFLAGS = shlinkflags)
 498
 499     # Default libs
 500     env.Append(LIBS = [])
 501
 502     # Load LLVM
 503     if env['llvm']:
 504         env.Tool('llvm')
 505
 506     # Custom builders and methods
 507     env.Tool('custom')
 508     createInstallMethods(env)
 509
 510     # for debugging
 511     #print env.Dump()
 512
 513
 514 def exists(env):
 515     return 1