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                 '_CRT_SECURE_NO_DEPRECATE',
 267             ]
 268         if debug:
 269             cppdefines += ['_DEBUG']
 270     if env['toolchain'] == 'winddk':
 271         # Mimic WINDDK's builtin flags. See also:
 272         # - WINDDK's bin/makefile.new i386mk.inc for more info.
 273         # - buildchk_wxp_x86.log files, generated by the WINDDK's build
 274         # - http://alter.org.ua/docs/nt_kernel/vc8_proj/
 275         if machine == 'x86':
 276             cppdefines += ['_X86_', 'i386']
 277         if machine == 'x86_64':
 278             cppdefines += ['_AMD64_', 'AMD64']
 279     if platform == 'winddk':
 280         cppdefines += [
 281             'STD_CALL',
 282             ('CONDITION_HANDLING', '1'),
 283             ('NT_INST', '0'),
 284             ('WIN32', '100'),
 285             ('_NT1X_', '100'),
 286             ('WINNT', '1'),
 287             ('_WIN32_WINNT', '0x0501'), # minimum required OS version
 288             ('WINVER', '0x0501'),
 289             ('_WIN32_IE', '0x0603'),
 290             ('WIN32_LEAN_AND_MEAN', '1'),
 291             ('DEVL', '1'),
 292             ('__BUILDMACHINE__', 'WinDDK'),
 293             ('FPO', '0'),
 294         ]
 295         if debug:
 296             cppdefines += [('DBG', 1)]
 297     if platform == 'wince':
 298         cppdefines += [
 299             '_CRT_SECURE_NO_DEPRECATE',
 300             '_USE_32BIT_TIME_T',
 301             'UNICODE',
 302             '_UNICODE',
 303             ('UNDER_CE', '600'),
 304             ('_WIN32_WCE', '0x600'),
 305             'WINCEOEM',
 306             'WINCEINTERNAL',
 307             'WIN32',
 308             'STRICT',
 309             'x86',
 310             '_X86_',
 311             'INTERNATIONAL',
 312             ('INTLMSG_CODEPAGE', '1252'),
 313         ]
 314     if platform == 'windows':
 315         cppdefines += ['PIPE_SUBSYSTEM_WINDOWS_USER']
 316     if platform == 'winddk':
 317         cppdefines += ['PIPE_SUBSYSTEM_WINDOWS_DISPLAY']
 318     if platform == 'wince':
 319         cppdefines += ['PIPE_SUBSYSTEM_WINDOWS_CE']
 320         cppdefines += ['PIPE_SUBSYSTEM_WINDOWS_CE_OGL']
 321     env.Append(CPPDEFINES = cppdefines)
 322
 323     # C compiler options
 324     cflags = [] # C
 325     cxxflags = [] # C++
 326     ccflags = [] # C & C++
 327     if gcc:
 328         if debug:
 329             ccflags += ['-O0', '-g3']
 330         elif env['CCVERSION'].startswith('4.2.'):
 331             # gcc 4.2.x optimizer is broken
 332             print "warning: gcc 4.2.x optimizer is broken -- disabling optimizations"
 333             ccflags += ['-O0', '-g3']
 334         else:
 335             ccflags += ['-O3', '-g3']
 336         if env['profile']:
 337             # See http://code.google.com/p/jrfonseca/wiki/Gprof2Dot#Which_options_should_I_pass_to_gcc_when_compiling_for_profiling?
 338             ccflags += [
 339                 '-fno-omit-frame-pointer',
 340                 '-fno-optimize-sibling-calls',
 341             ]
 342         if env['machine'] == 'x86':
 343             ccflags += [
 344                 '-m32',
 345                 #'-march=pentium4',
 346                 '-mmmx', '-msse', '-msse2', # enable SIMD intrinsics
 347                 '-mstackrealign', # ensure stack is aligned -- do not enabled -msse without it!
 348                 #'-mfpmath=sse',
 349             ]
 350         if env['machine'] == 'x86_64':
 351             ccflags += ['-m64']
 352         # See also:
 353         # - http://gcc.gnu.org/onlinedocs/gcc/Warning-Options.html
 354         ccflags += [
 355             '-Wall',
 356             '-Wmissing-field-initializers',
 357             '-Wpointer-arith',
 358             '-Wno-long-long',
 359             '-ffast-math',
 360             '-fmessage-length=0', # be nice to Eclipse
 361         ]
 362         cflags += [
 363             '-Werror=declaration-after-statement',
 364             '-Wmissing-prototypes',
 365             '-std=gnu99',
 366         ]
 367     if msvc:
 368         # See also:
 369         # - http://msdn.microsoft.com/en-us/library/19z1t1wy.aspx
 370         # - cl /?
 371         if debug:
 372             ccflags += [
 373               '/Od', # disable optimizations
 374               '/Oi', # enable intrinsic functions
 375               '/Oy-', # disable frame pointer omission
 376               '/GL-', # disable whole program optimization
 377             ]
 378         else:
 379             ccflags += [
 380                 '/O2', # optimize for speed
 381                 #'/fp:fast', # fast floating point
 382             ]
 383         if env['profile']:
 384             ccflags += [
 385                 '/Gh', # enable _penter hook function
 386                 '/GH', # enable _pexit hook function
 387             ]
 388         ccflags += [
 389             '/W3', # warning level
 390             #'/Wp64', # enable 64 bit porting warnings
 391         ]
 392         if env['machine'] == 'x86':
 393             ccflags += [
 394                 #'/QIfist', # Suppress _ftol
 395                 #'/arch:SSE2', # use the SSE2 instructions
 396             ]
 397         if platform == 'windows':
 398             ccflags += [
 399                 # TODO
 400             ]
 401         if platform == 'winddk':
 402             ccflags += [
 403                 '/Zl', # omit default library name in .OBJ
 404                 '/Zp8', # 8bytes struct member alignment
 405                 '/Gy', # separate functions for linker
 406                 '/Gm-', # disable minimal rebuild
 407                 '/WX', # treat warnings as errors
 408                 '/Gz', # __stdcall Calling convention
 409                 '/GX-', # disable C++ EH
 410                 '/GR-', # disable C++ RTTI
 411                 '/GF', # enable read-only string pooling
 412                 '/G6', # optimize for PPro, P-II, P-III
 413                 '/Ze', # enable extensions
 414                 '/Gi-', # disable incremental compilation
 415                 '/QIfdiv-', # disable Pentium FDIV fix
 416                 '/hotpatch', # prepares an image for hotpatching.
 417                 #'/Z7', #enable old-style debug info
 418             ]
 419         if platform == 'wince':
 420             # See also C:\WINCE600\public\common\oak\misc\makefile.def
 421             ccflags += [
 422                 '/Zl', # omit default library name in .OBJ
 423                 '/GF', # enable read-only string pooling
 424                 '/GR-', # disable C++ RTTI
 425                 '/GS', # enable security checks
 426                 # Allow disabling language conformance to maintain backward compat
 427                 #'/Zc:wchar_t-', # don't force wchar_t as native type, instead of typedef
 428                 #'/Zc:forScope-', # don't enforce Standard C++ for scoping rules
 429                 #'/wd4867',
 430                 #'/wd4430',
 431                 #'/MT',
 432                 #'/U_MT',
 433             ]
 434         # Automatic pdb generation
 435         # See http://scons.tigris.org/issues/show_bug.cgi?id=1656
 436         env.EnsureSConsVersion(0, 98, 0)
 437         env['PDB'] = '${TARGET.base}.pdb'
 438     env.Append(CCFLAGS = ccflags)
 439     env.Append(CFLAGS = cflags)
 440     env.Append(CXXFLAGS = cxxflags)
 441
 442     if env['platform'] == 'windows' and msvc:
 443         # Choose the appropriate MSVC CRT
 444         # http://msdn.microsoft.com/en-us/library/2kzt1wy3.aspx
 445         if env['debug']:
 446             env.Append(CCFLAGS = ['/MTd'])
 447             env.Append(SHCCFLAGS = ['/LDd'])
 448         else:
 449             env.Append(CCFLAGS = ['/MT'])
 450             env.Append(SHCCFLAGS = ['/LD'])
 451
 452     # Assembler options
 453     if gcc:
 454         if env['machine'] == 'x86':
 455             env.Append(ASFLAGS = ['-m32'])
 456         if env['machine'] == 'x86_64':
 457             env.Append(ASFLAGS = ['-m64'])
 458
 459     # Linker options
 460     linkflags = []
 461     shlinkflags = []
 462     if gcc:
 463         if env['machine'] == 'x86':
 464             linkflags += ['-m32']
 465         if env['machine'] == 'x86_64':
 466             linkflags += ['-m64']
 467         shlinkflags += [
 468             '-Wl,-Bsymbolic',
 469         ]
 470         # Handle circular dependencies in the libraries
 471         env['_LIBFLAGS'] = '-Wl,--start-group ' + env['_LIBFLAGS'] + ' -Wl,--end-group'
 472     if platform == 'windows' and msvc:
 473         # See also:
 474         # - http://msdn2.microsoft.com/en-us/library/y0zzbyt4.aspx
 475         linkflags += [
 476             '/fixed:no',
 477             '/incremental:no',
 478         ]
 479     if platform == 'winddk':
 480         linkflags += [
 481             '/merge:_PAGE=PAGE',
 482             '/merge:_TEXT=.text',
 483             '/section:INIT,d',
 484             '/opt:ref',
 485             '/opt:icf',
 486             '/ignore:4198,4010,4037,4039,4065,4070,4078,4087,4089,4221',
 487             '/incremental:no',
 488             '/fullbuild',
 489             '/release',
 490             '/nodefaultlib',
 491             '/wx',
 492             '/debug',
 493             '/debugtype:cv',
 494             '/version:5.1',
 495             '/osversion:5.1',
 496             '/functionpadmin:5',
 497             '/safeseh',
 498             '/pdbcompress',
 499             '/stack:0x40000,0x1000',
 500             '/driver',
 501             '/align:0x80',
 502             '/subsystem:native,5.01',
 503             '/base:0x10000',
 504
 505             '/entry:DrvEnableDriver',
 506         ]
 507         if env['debug'] or env['profile']:
 508             linkflags += [
 509                 '/MAP', # http://msdn.microsoft.com/en-us/library/k7xkk3e2.aspx
 510             ]
 511     if platform == 'wince':
 512         linkflags += [
 513             '/nodefaultlib',
 514             #'/incremental:no',
 515             #'/fullbuild',
 516             '/entry:_DllMainCRTStartup',
 517         ]
 518     env.Append(LINKFLAGS = linkflags)
 519     env.Append(SHLINKFLAGS = shlinkflags)
 520
 521     # Default libs
 522     env.Append(LIBS = [])
 523
 524     # Custom builders and methods
 525     createConvenienceLibBuilder(env)
 526     createCodeGenerateMethod(env)
 527     createInstallMethods(env)
 528
 529     # for debugging
 530     #print env.Dump()
 531
 532
 533 def exists(env):
 534     return 1