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['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         print os.path.join(target_dir, target_name), last
 161         last = env.Command(os.path.join(target_dir, target_name), last, action)
 162
 163 def createInstallMethods(env):
 164     env.AddMethod(install_shared_library, 'InstallSharedLibrary')
 165
 166
 167 def generate(env):
 168     """Common environment generation code"""
 169
 170     # FIXME: this is already too late
 171     #if env.get('quiet', False):
 172     #    quietCommandLines(env)
 173
 174     # shortcuts
 175     debug = env['debug']
 176     machine = env['machine']
 177     platform = env['platform']
 178     x86 = env['machine'] == 'x86'
 179     gcc = env['platform'] in ('linux', 'freebsd', 'darwin')
 180     msvc = env['platform'] in ('windows', 'winddk', 'wince')
 181
 182     # Tool
 183     if platform == 'winddk':
 184         env.Tool('winddk')
 185     elif platform == 'wince':
 186         env.Tool('wcesdk')
 187     else:
 188         env.Tool('default')
 189
 190     # Put build output in a separate dir, which depends on the current
 191     # configuration. See also http://www.scons.org/wiki/AdvancedBuildExample
 192     build_topdir = 'build'
 193     build_subdir = env['platform']
 194     if env['dri']:
 195         build_subdir += "-dri"
 196     if env['llvm']:
 197         build_subdir += "-llvm"
 198     if env['machine'] != 'generic':
 199         build_subdir += '-' + env['machine']
 200     if env['debug']:
 201         build_subdir += "-debug"
 202     if env['profile']:
 203         build_subdir += "-profile"
 204     build_dir = os.path.join(build_topdir, build_subdir)
 205     # Place the .sconsign file in the build dir too, to avoid issues with
 206     # different scons versions building the same source file
 207     env['build'] = build_dir
 208     env.SConsignFile(os.path.join(build_dir, '.sconsign'))
 209
 210     # C preprocessor options
 211     cppdefines = []
 212     if debug:
 213         cppdefines += ['DEBUG']
 214     else:
 215         cppdefines += ['NDEBUG']
 216     if env['profile']:
 217         cppdefines += ['PROFILE']
 218     if platform == 'windows':
 219         cppdefines += [
 220             'WIN32',
 221             '_WINDOWS',
 222             '_UNICODE',
 223             'UNICODE',
 224             # http://msdn2.microsoft.com/en-us/library/6dwk3a1z.aspx,
 225             'WIN32_LEAN_AND_MEAN',
 226             'VC_EXTRALEAN',
 227             '_CRT_SECURE_NO_DEPRECATE',
 228         ]
 229         if debug:
 230             cppdefines += ['_DEBUG']
 231     if platform == 'winddk':
 232         # Mimic WINDDK's builtin flags. See also:
 233         # - WINDDK's bin/makefile.new i386mk.inc for more info.
 234         # - buildchk_wxp_x86.log files, generated by the WINDDK's build
 235         # - http://alter.org.ua/docs/nt_kernel/vc8_proj/
 236         cppdefines += [
 237             ('_X86_', '1'),
 238             ('i386', '1'),
 239             'STD_CALL',
 240             ('CONDITION_HANDLING', '1'),
 241             ('NT_INST', '0'),
 242             ('WIN32', '100'),
 243             ('_NT1X_', '100'),
 244             ('WINNT', '1'),
 245             ('_WIN32_WINNT', '0x0501'), # minimum required OS version
 246             ('WINVER', '0x0501'),
 247             ('_WIN32_IE', '0x0603'),
 248             ('WIN32_LEAN_AND_MEAN', '1'),
 249             ('DEVL', '1'),
 250             ('__BUILDMACHINE__', 'WinDDK'),
 251             ('FPO', '0'),
 252         ]
 253         if debug:
 254             cppdefines += [('DBG', 1)]
 255     if platform == 'wince':
 256         cppdefines += [
 257             '_CRT_SECURE_NO_DEPRECATE',
 258             '_USE_32BIT_TIME_T',
 259             'UNICODE',
 260             '_UNICODE',
 261             ('UNDER_CE', '600'),
 262             ('_WIN32_WCE', '0x600'),
 263             'WINCEOEM',
 264             'WINCEINTERNAL',
 265             'WIN32',
 266             'STRICT',
 267             'x86',
 268             '_X86_',
 269             'INTERNATIONAL',
 270             ('INTLMSG_CODEPAGE', '1252'),
 271         ]
 272     if platform == 'windows':
 273         cppdefines += ['PIPE_SUBSYSTEM_WINDOWS_USER']
 274     if platform == 'winddk':
 275         cppdefines += ['PIPE_SUBSYSTEM_WINDOWS_DISPLAY']
 276     if platform == 'wince':
 277         cppdefines += ['PIPE_SUBSYSTEM_WINDOWS_CE']
 278     env.Append(CPPDEFINES = cppdefines)
 279
 280     # C preprocessor includes
 281     if platform == 'winddk':
 282         env.Append(CPPPATH = [
 283             env['SDK_INC_PATH'],
 284             env['DDK_INC_PATH'],
 285             env['WDM_INC_PATH'],
 286             env['CRT_INC_PATH'],
 287         ])
 288
 289     # C compiler options
 290     cflags = []
 291     if gcc:
 292         if debug:
 293             cflags += ['-O0', '-g3']
 294         else:
 295             cflags += ['-O3', '-g3']
 296         if env['profile']:
 297             cflags += ['-pg']
 298         if env['machine'] == 'x86':
 299             cflags += [
 300                 '-m32',
 301                 #'-march=pentium4',
 302                 '-mmmx', '-msse', '-msse2', # enable SIMD intrinsics
 303                 #'-mfpmath=sse',
 304             ]
 305         if env['machine'] == 'x86_64':
 306             cflags += ['-m64']
 307         cflags += [
 308             '-Wall',
 309             '-Wmissing-prototypes',
 310             '-Wno-long-long',
 311             '-ffast-math',
 312             '-pedantic',
 313             '-fmessage-length=0', # be nice to Eclipse
 314         ]
 315     if msvc:
 316         # See also:
 317         # - http://msdn.microsoft.com/en-us/library/19z1t1wy.aspx
 318         # - cl /?
 319         if debug:
 320             cflags += [
 321               '/Od', # disable optimizations
 322               '/Oi', # enable intrinsic functions
 323               '/Oy-', # disable frame pointer omission
 324             ]
 325         else:
 326             cflags += [
 327               '/Ox', # maximum optimizations
 328               '/Oi', # enable intrinsic functions
 329               '/Ot', # favor code speed
 330               #'/fp:fast', # fast floating point
 331             ]
 332         if env['profile']:
 333             cflags += [
 334                 '/Gh', # enable _penter hook function
 335                 '/GH', # enable _pexit hook function
 336             ]
 337         cflags += [
 338             '/W3', # warning level
 339             #'/Wp64', # enable 64 bit porting warnings
 340         ]
 341         if env['machine'] == 'x86':
 342             cflags += [
 343                 #'/QIfist', # Suppress _ftol
 344                 #'/arch:SSE2', # use the SSE2 instructions
 345             ]
 346         if platform == 'windows':
 347             cflags += [
 348                 # TODO
 349             ]
 350         if platform == 'winddk':
 351             cflags += [
 352                 '/Zl', # omit default library name in .OBJ
 353                 '/Zp8', # 8bytes struct member alignment
 354                 '/Gy', # separate functions for linker
 355                 '/Gm-', # disable minimal rebuild
 356                 '/WX', # treat warnings as errors
 357                 '/Gz', # __stdcall Calling convention
 358                 '/GX-', # disable C++ EH
 359                 '/GR-', # disable C++ RTTI
 360                 '/GF', # enable read-only string pooling
 361                 '/G6', # optimize for PPro, P-II, P-III
 362                 '/Ze', # enable extensions
 363                 '/Gi-', # disable incremental compilation
 364                 '/QIfdiv-', # disable Pentium FDIV fix
 365                 '/hotpatch', # prepares an image for hotpatching.
 366                 #'/Z7', #enable old-style debug info
 367             ]
 368         if platform == 'wince':
 369             # See also C:\WINCE600\public\common\oak\misc\makefile.def
 370             cflags += [
 371                 '/Zl', # omit default library name in .OBJ
 372                 '/GF', # enable read-only string pooling
 373                 '/GR-', # disable C++ RTTI
 374                 '/GS', # enable security checks
 375                 # Allow disabling language conformance to maintain backward compat
 376                 #'/Zc:wchar_t-', # don't force wchar_t as native type, instead of typedef
 377                 #'/Zc:forScope-', # don't enforce Standard C++ for scoping rules
 378                 #'/wd4867',
 379                 #'/wd4430',
 380                 #'/MT',
 381                 #'/U_MT',
 382             ]
 383         # Automatic pdb generation
 384         # See http://scons.tigris.org/issues/show_bug.cgi?id=1656
 385         env.EnsureSConsVersion(0, 98, 0)
 386         env['PDB'] = '${TARGET.base}.pdb'
 387     env.Append(CFLAGS = cflags)
 388     env.Append(CXXFLAGS = cflags)
 389
 390     # Assembler options
 391     if gcc:
 392         if env['machine'] == 'x86':
 393             env.Append(ASFLAGS = ['-m32'])
 394         if env['machine'] == 'x86_64':
 395             env.Append(ASFLAGS = ['-m64'])
 396
 397     # Linker options
 398     linkflags = []
 399     if gcc:
 400         if env['machine'] == 'x86':
 401             linkflags += ['-m32']
 402         if env['machine'] == 'x86_64':
 403             linkflags += ['-m64']
 404     if platform == 'winddk':
 405         # See also:
 406         # - http://msdn2.microsoft.com/en-us/library/y0zzbyt4.aspx
 407         linkflags += [
 408             '/merge:_PAGE=PAGE',
 409             '/merge:_TEXT=.text',
 410             '/section:INIT,d',
 411             '/opt:ref',
 412             '/opt:icf',
 413             '/ignore:4198,4010,4037,4039,4065,4070,4078,4087,4089,4221',
 414             '/incremental:no',
 415             '/fullbuild',
 416             '/release',
 417             '/nodefaultlib',
 418             '/wx',
 419             '/debug',
 420             '/debugtype:cv',
 421             '/version:5.1',
 422             '/osversion:5.1',
 423             '/functionpadmin:5',
 424             '/safeseh',
 425             '/pdbcompress',
 426             '/stack:0x40000,0x1000',
 427             '/driver',
 428             '/align:0x80',
 429             '/subsystem:native,5.01',
 430             '/base:0x10000',
 431
 432             '/entry:DrvEnableDriver',
 433         ]
 434         if env['profile']:
 435             linkflags += [
 436                 '/MAP', # http://msdn.microsoft.com/en-us/library/k7xkk3e2.aspx
 437             ]
 438     if platform == 'wince':
 439         linkflags += [
 440             '/nodefaultlib',
 441             #'/incremental:no',
 442             #'/fullbuild',
 443             '/entry:_DllMainCRTStartup',
 444         ]
 445     env.Append(LINKFLAGS = linkflags)
 446
 447     # Default libs
 448     env.Append(LIBS = [])
 449
 450     # Custom builders and methods
 451     createConvenienceLibBuilder(env)
 452     createCodeGenerateMethod(env)
 453     createInstallMethods(env)
 454
 455     # for debugging
 456     #print env.Dump()
 457
 458
 459 def exists(env):
 460     return 1