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