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