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 os
  34 import os.path
  35 import re
  36
  37 import SCons.Action
  38 import SCons.Builder
  39 import SCons.Scanner
  40
  41 import fixes
  42
  43
  44 def quietCommandLines(env):
  45     # Quiet command lines
  46     # See also http://www.scons.org/wiki/HidingCommandLinesInOutput
  47     env['ASCOMSTR'] = "  Assembling $SOURCE ..."
  48     env['ASPPCOMSTR'] = "  Assembling $SOURCE ..."
  49     env['CCCOMSTR'] = "  Compiling $SOURCE ..."
  50     env['SHCCCOMSTR'] = "  Compiling $SOURCE ..."
  51     env['CXXCOMSTR'] = "  Compiling $SOURCE ..."
  52     env['SHCXXCOMSTR'] = "  Compiling $SOURCE ..."
  53     env['ARCOMSTR'] = "  Archiving $TARGET ..."
  54     env['RANLIBCOMSTR'] = "  Indexing $TARGET ..."
  55     env['LINKCOMSTR'] = "  Linking $TARGET ..."
  56     env['SHLINKCOMSTR'] = "  Linking $TARGET ..."
  57     env['LDMODULECOMSTR'] = "  Linking $TARGET ..."
  58     env['SWIGCOMSTR'] = "  Generating $TARGET ..."
  59
  60
  61 def createConvenienceLibBuilder(env):
  62     """This is a utility function that creates the ConvenienceLibrary
  63     Builder in an Environment if it is not there already.
  64
  65     If it is already there, we return the existing one.
  66
  67     Based on the stock StaticLibrary and SharedLibrary builders.
  68     """
  69
  70     try:
  71         convenience_lib = env['BUILDERS']['ConvenienceLibrary']
  72     except KeyError:
  73         action_list = [ SCons.Action.Action("$ARCOM", "$ARCOMSTR") ]
  74         if env.Detect('ranlib'):
  75             ranlib_action = SCons.Action.Action("$RANLIBCOM", "$RANLIBCOMSTR")
  76             action_list.append(ranlib_action)
  77
  78         convenience_lib = SCons.Builder.Builder(action = action_list,
  79                                   emitter = '$LIBEMITTER',
  80                                   prefix = '$LIBPREFIX',
  81                                   suffix = '$LIBSUFFIX',
  82                                   src_suffix = '$SHOBJSUFFIX',
  83                                   src_builder = 'SharedObject')
  84         env['BUILDERS']['ConvenienceLibrary'] = convenience_lib
  85
  86     return convenience_lib
  87
  88
  89 # TODO: handle import statements with multiple modules
  90 # TODO: handle from import statements
  91 import_re = re.compile(r'^import\s+(\S+)$', re.M)
  92
  93 def python_scan(node, env, path):
  94     # http://www.scons.org/doc/0.98.5/HTML/scons-user/c2781.html#AEN2789
  95     contents = node.get_contents()
  96     source_dir = node.get_dir()
  97     imports = import_re.findall(contents)
  98     results = []
  99     for imp in imports:
 100         for dir in path:
 101             file = os.path.join(str(dir), imp.replace('.', os.sep) + '.py')
 102             if os.path.exists(file):
 103                 results.append(env.File(file))
 104                 break
 105             file = os.path.join(str(dir), imp.replace('.', os.sep), '__init__.py')
 106             if os.path.exists(file):
 107                 results.append(env.File(file))
 108                 break
 109     return results
 110
 111 python_scanner = SCons.Scanner.Scanner(function = python_scan, skeys = ['.py'])
 112
 113
 114 def code_generate(env, script, target, source, command):
 115     """Method to simplify code generation via python scripts.
 116
 117     http://www.scons.org/wiki/UsingCodeGenerators
 118     http://www.scons.org/doc/0.98.5/HTML/scons-user/c2768.html
 119     """
 120
 121     # We're generating code using Python scripts, so we have to be
 122     # careful with our scons elements.  This entry represents
 123     # the generator file *in the source directory*.
 124     script_src = env.File(script).srcnode()
 125
 126     # This command creates generated code *in the build directory*.
 127     command = command.replace('$SCRIPT', script_src.path)
 128     code = env.Command(target, source, command)
 129
 130     # Explicitly mark that the generated code depends on the generator,
 131     # and on implicitly imported python modules
 132     path = (script_src.get_dir(),)
 133     deps = [script_src]
 134     deps += script_src.get_implicit_deps(env, python_scanner, path)
 135     env.Depends(code, deps)
 136
 137     # Running the Python script causes .pyc files to be generated in the
 138     # source directory.  When we clean up, they should go too. So add side
 139     # effects for .pyc files
 140     for dep in deps:
 141         pyc = env.File(str(dep) + 'c')
 142         env.SideEffect(pyc, code)
 143
 144     return code
 145
 146
 147 def createCodeGenerateMethod(env):
 148     env.Append(SCANNERS = python_scanner)
 149     env.AddMethod(code_generate, 'CodeGenerate')
 150
 151
 152 def symlink(target, source, env):
 153     target = str(target[0])
 154     source = str(source[0])
 155     if os.path.islink(target) or os.path.exists(target):
 156         os.remove(target)
 157     os.symlink(os.path.basename(source), target)
 158
 159 def install_shared_library(env, source, version = ()):
 160     source = str(source[0])
 161     version = tuple(map(str, version))
 162     target_dir =  os.path.join(env.Dir('#.').srcnode().abspath, env['build'], 'lib')
 163     target_name = '.'.join((str(source),) + version)
 164     last = env.InstallAs(os.path.join(target_dir, target_name), source)
 165     while len(version):
 166         version = version[:-1]
 167         target_name = '.'.join((str(source),) + version)
 168         action = SCons.Action.Action(symlink, "$TARGET -> $SOURCE")
 169         last = env.Command(os.path.join(target_dir, target_name), last, action)
 170
 171 def createInstallMethods(env):
 172     env.AddMethod(install_shared_library, 'InstallSharedLibrary')
 173
 174
 175 def num_jobs():
 176     try:
 177         return int(os.environ['NUMBER_OF_PROCESSORS'])
 178     except (ValueError, KeyError):
 179         pass
 180
 181     try:
 182         return os.sysconf('SC_NPROCESSORS_ONLN')
 183     except (ValueError, OSError, AttributeError):
 184         pass
 185
 186     try:
 187         return int(os.popen2("sysctl -n hw.ncpu")[1].read())
 188     except ValueError:
 189         pass
 190
 191     return 1
 192
 193
 194 def generate(env):
 195     """Common environment generation code"""
 196
 197     if env.get('quiet', True):
 198         quietCommandLines(env)
 199
 200     # Toolchain
 201     platform = env['platform']
 202     if env['toolchain'] == 'default':
 203         if platform == 'winddk':
 204             env['toolchain'] = 'winddk'
 205         elif platform == 'wince':
 206             env['toolchain'] = 'wcesdk'
 207     env.Tool(env['toolchain'])
 208
 209     env['gcc'] = 'gcc' in os.path.basename(env['CC']).split('-')
 210     env['msvc'] = env['CC'] == 'cl'
 211
 212     # shortcuts
 213     debug = env['debug']
 214     machine = env['machine']
 215     platform = env['platform']
 216     x86 = env['machine'] == 'x86'
 217     ppc = env['machine'] == 'ppc'
 218     gcc = env['gcc']
 219     msvc = env['msvc']
 220
 221     # Put build output in a separate dir, which depends on the current
 222     # configuration. See also http://www.scons.org/wiki/AdvancedBuildExample
 223     build_topdir = 'build'
 224     build_subdir = env['platform']
 225     if env['llvm']:
 226         build_subdir += "-llvm"
 227     if env['machine'] != 'generic':
 228         build_subdir += '-' + env['machine']
 229     if env['debug']:
 230         build_subdir += "-debug"
 231     if env['profile']:
 232         build_subdir += "-profile"
 233     build_dir = os.path.join(build_topdir, build_subdir)
 234     # Place the .sconsign file in the build dir too, to avoid issues with
 235     # different scons versions building the same source file
 236     env['build'] = build_dir
 237     env.SConsignFile(os.path.join(build_dir, '.sconsign'))
 238     env.CacheDir('build/cache')
 239
 240     # Parallel build
 241     if env.GetOption('num_jobs') <= 1:
 242         env.SetOption('num_jobs', num_jobs())
 243
 244     # C preprocessor options
 245     cppdefines = []
 246     if debug:
 247         cppdefines += ['DEBUG']
 248     else:
 249         cppdefines += ['NDEBUG']
 250     if env['profile']:
 251         cppdefines += ['PROFILE']
 252     if platform == 'windows':
 253         cppdefines += [
 254             'WIN32',
 255             '_WINDOWS',
 256             #'_UNICODE',
 257             #'UNICODE',
 258             ('_WIN32_WINNT', '0x0501'), # minimum required OS version
 259             ('WINVER', '0x0501'),
 260             # http://msdn2.microsoft.com/en-us/library/6dwk3a1z.aspx,
 261             'WIN32_LEAN_AND_MEAN',
 262         ]
 263         if msvc and env['toolchain'] != 'winddk':
 264             cppdefines += [
 265                 'VC_EXTRALEAN',
 266                 '_USE_MATH_DEFINES',
 267                 '_CRT_SECURE_NO_DEPRECATE',
 268             ]
 269         if debug:
 270             cppdefines += ['_DEBUG']
 271     if env['toolchain'] == 'winddk':
 272         # Mimic WINDDK's builtin flags. See also:
 273         # - WINDDK's bin/makefile.new i386mk.inc for more info.
 274         # - buildchk_wxp_x86.log files, generated by the WINDDK's build
 275         # - http://alter.org.ua/docs/nt_kernel/vc8_proj/
 276         if machine == 'x86':
 277             cppdefines += ['_X86_', 'i386']
 278         if machine == 'x86_64':
 279             cppdefines += ['_AMD64_', 'AMD64']
 280     if platform == 'winddk':
 281         cppdefines += [
 282             'STD_CALL',
 283             ('CONDITION_HANDLING', '1'),
 284             ('NT_INST', '0'),
 285             ('WIN32', '100'),
 286             ('_NT1X_', '100'),
 287             ('WINNT', '1'),
 288             ('_WIN32_WINNT', '0x0501'), # minimum required OS version
 289             ('WINVER', '0x0501'),
 290             ('_WIN32_IE', '0x0603'),
 291             ('WIN32_LEAN_AND_MEAN', '1'),
 292             ('DEVL', '1'),
 293             ('__BUILDMACHINE__', 'WinDDK'),
 294             ('FPO', '0'),
 295         ]
 296         if debug:
 297             cppdefines += [('DBG', 1)]
 298     if platform == 'wince':
 299         cppdefines += [
 300             '_CRT_SECURE_NO_DEPRECATE',
 301             '_USE_32BIT_TIME_T',
 302             'UNICODE',
 303             '_UNICODE',
 304             ('UNDER_CE', '600'),
 305             ('_WIN32_WCE', '0x600'),
 306             'WINCEOEM',
 307             'WINCEINTERNAL',
 308             'WIN32',
 309             'STRICT',
 310             'x86',
 311             '_X86_',
 312             'INTERNATIONAL',
 313             ('INTLMSG_CODEPAGE', '1252'),
 314         ]
 315     if platform == 'windows':
 316         cppdefines += ['PIPE_SUBSYSTEM_WINDOWS_USER']
 317     if platform == 'winddk':
 318         cppdefines += ['PIPE_SUBSYSTEM_WINDOWS_DISPLAY']
 319     if platform == 'wince':
 320         cppdefines += ['PIPE_SUBSYSTEM_WINDOWS_CE']
 321         cppdefines += ['PIPE_SUBSYSTEM_WINDOWS_CE_OGL']
 322     env.Append(CPPDEFINES = cppdefines)
 323
 324     # C compiler options
 325     cflags = [] # C
 326     cxxflags = [] # C++
 327     ccflags = [] # C & C++
 328     if gcc:
 329         if debug:
 330             ccflags += ['-O0', '-g3']
 331         elif env['CCVERSION'].startswith('4.2.'):
 332             # gcc 4.2.x optimizer is broken
 333             print "warning: gcc 4.2.x optimizer is broken -- disabling optimizations"
 334             ccflags += ['-O0', '-g3']
 335         else:
 336             ccflags += ['-O3', '-g3']
 337         if env['profile']:
 338             ccflags += ['-pg']
 339         if env['machine'] == 'x86':
 340             ccflags += [
 341                 '-m32',
 342                 #'-march=pentium4',
 343                 '-mmmx', '-msse', '-msse2', # enable SIMD intrinsics
 344                 #'-mfpmath=sse',
 345             ]
 346         if env['machine'] == 'x86_64':
 347             ccflags += ['-m64']
 348         # See also:
 349         # - http://gcc.gnu.org/onlinedocs/gcc/Warning-Options.html
 350         ccflags += [
 351             '-Wall',
 352             '-Wmissing-field-initializers',
 353             '-Wpointer-arith',
 354             '-Wno-long-long',
 355             '-ffast-math',
 356             '-fmessage-length=0', # be nice to Eclipse
 357         ]
 358         cflags += [
 359             '-Werror=declaration-after-statement',
 360             '-Wmissing-prototypes',
 361             '-std=gnu99',
 362         ]
 363     if msvc:
 364         # See also:
 365         # - http://msdn.microsoft.com/en-us/library/19z1t1wy.aspx
 366         # - cl /?
 367         if debug:
 368             ccflags += [
 369               '/Od', # disable optimizations
 370               '/Oi', # enable intrinsic functions
 371               '/Oy-', # disable frame pointer omission
 372               '/GL-', # disable whole program optimization
 373             ]
 374         else:
 375             ccflags += [
 376                 '/O2', # optimize for speed
 377                 #'/fp:fast', # fast floating point
 378             ]
 379         if env['profile']:
 380             ccflags += [
 381                 '/Gh', # enable _penter hook function
 382                 '/GH', # enable _pexit hook function
 383             ]
 384         ccflags += [
 385             '/W3', # warning level
 386             #'/Wp64', # enable 64 bit porting warnings
 387         ]
 388         if env['machine'] == 'x86':
 389             ccflags += [
 390                 #'/QIfist', # Suppress _ftol
 391                 #'/arch:SSE2', # use the SSE2 instructions
 392             ]
 393         if platform == 'windows':
 394             ccflags += [
 395                 # TODO
 396             ]
 397         if platform == 'winddk':
 398             ccflags += [
 399                 '/Zl', # omit default library name in .OBJ
 400                 '/Zp8', # 8bytes struct member alignment
 401                 '/Gy', # separate functions for linker
 402                 '/Gm-', # disable minimal rebuild
 403                 '/WX', # treat warnings as errors
 404                 '/Gz', # __stdcall Calling convention
 405                 '/GX-', # disable C++ EH
 406                 '/GR-', # disable C++ RTTI
 407                 '/GF', # enable read-only string pooling
 408                 '/G6', # optimize for PPro, P-II, P-III
 409                 '/Ze', # enable extensions
 410                 '/Gi-', # disable incremental compilation
 411                 '/QIfdiv-', # disable Pentium FDIV fix
 412                 '/hotpatch', # prepares an image for hotpatching.
 413                 #'/Z7', #enable old-style debug info
 414             ]
 415         if platform == 'wince':
 416             # See also C:\WINCE600\public\common\oak\misc\makefile.def
 417             ccflags += [
 418                 '/Zl', # omit default library name in .OBJ
 419                 '/GF', # enable read-only string pooling
 420                 '/GR-', # disable C++ RTTI
 421                 '/GS', # enable security checks
 422                 # Allow disabling language conformance to maintain backward compat
 423                 #'/Zc:wchar_t-', # don't force wchar_t as native type, instead of typedef
 424                 #'/Zc:forScope-', # don't enforce Standard C++ for scoping rules
 425                 #'/wd4867',
 426                 #'/wd4430',
 427                 #'/MT',
 428                 #'/U_MT',
 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['debug']:
 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         shlinkflags += [
 464             '-Wl,-Bsymbolic',
 465         ]
 466         # Handle circular dependencies in the libraries
 467         env['_LIBFLAGS'] = '-Wl,--start-group ' + env['_LIBFLAGS'] + ' -Wl,--end-group'
 468     if platform == 'windows' and msvc:
 469         # See also:
 470         # - http://msdn2.microsoft.com/en-us/library/y0zzbyt4.aspx
 471         linkflags += [
 472             '/fixed:no',
 473             '/incremental:no',
 474         ]
 475     if platform == 'winddk':
 476         linkflags += [
 477             '/merge:_PAGE=PAGE',
 478             '/merge:_TEXT=.text',
 479             '/section:INIT,d',
 480             '/opt:ref',
 481             '/opt:icf',
 482             '/ignore:4198,4010,4037,4039,4065,4070,4078,4087,4089,4221',
 483             '/incremental:no',
 484             '/fullbuild',
 485             '/release',
 486             '/nodefaultlib',
 487             '/wx',
 488             '/debug',
 489             '/debugtype:cv',
 490             '/version:5.1',
 491             '/osversion:5.1',
 492             '/functionpadmin:5',
 493             '/safeseh',
 494             '/pdbcompress',
 495             '/stack:0x40000,0x1000',
 496             '/driver',
 497             '/align:0x80',
 498             '/subsystem:native,5.01',
 499             '/base:0x10000',
 500
 501             '/entry:DrvEnableDriver',
 502         ]
 503         if env['debug'] or env['profile']:
 504             linkflags += [
 505                 '/MAP', # http://msdn.microsoft.com/en-us/library/k7xkk3e2.aspx
 506             ]
 507     if platform == 'wince':
 508         linkflags += [
 509             '/nodefaultlib',
 510             #'/incremental:no',
 511             #'/fullbuild',
 512             '/entry:_DllMainCRTStartup',
 513         ]
 514     env.Append(LINKFLAGS = linkflags)
 515     env.Append(SHLINKFLAGS = shlinkflags)
 516
 517     # Default libs
 518     env.Append(LIBS = [])
 519
 520     # Custom builders and methods
 521     createConvenienceLibBuilder(env)
 522     createCodeGenerateMethod(env)
 523     createInstallMethods(env)
 524
 525     # for debugging
 526     #print env.Dump()
 527
 528
 529 def exists(env):
 530     return 1