3 Frontend-tool for Gallium3D architecture.
8 # Copyright 2008 Tungsten Graphics, Inc., Cedar Park, Texas.
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:
19 # The above copyright notice and this permission notice (including the
20 # next paragraph) shall be included in all copies or substantial portions
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.
44 def quietCommandLines(env
):
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 ..."
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.
65 If it is already there, we return the existing one.
67 Based on the stock StaticLibrary and SharedLibrary builders.
71 convenience_lib
= env
['BUILDERS']['ConvenienceLibrary']
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
)
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
86 return convenience_lib
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
)
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
)
101 file = os
.path
.join(str(dir), imp
.replace('.', os
.sep
) + '.py')
102 if os
.path
.exists(file):
103 results
.append(env
.File(file))
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))
111 python_scanner
= SCons
.Scanner
.Scanner(function
= python_scan
, skeys
= ['.py'])
114 def code_generate(env
, script
, target
, source
, command
):
115 """Method to simplify code generation via python scripts.
117 http://www.scons.org/wiki/UsingCodeGenerators
118 http://www.scons.org/doc/0.98.5/HTML/scons-user/c2768.html
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()
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
)
130 # Explicitly mark that the generated code depends on the generator,
131 # and on implicitly imported python modules
132 path
= (script_src
.get_dir(),)
134 deps
+= script_src
.get_implicit_deps(env
, python_scanner
, path
)
135 env
.Depends(code
, deps
)
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
141 pyc
= env
.File(str(dep
) + 'c')
142 env
.SideEffect(pyc
, code
)
147 def createCodeGenerateMethod(env
):
148 env
.Append(SCANNERS
= python_scanner
)
149 env
.AddMethod(code_generate
, 'CodeGenerate')
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
):
157 os
.symlink(os
.path
.basename(source
), target
)
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
)
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
)
171 def createInstallMethods(env
):
172 env
.AddMethod(install_shared_library
, 'InstallSharedLibrary')
177 return int(os
.environ
['NUMBER_OF_PROCESSORS'])
178 except (ValueError, KeyError):
182 return os
.sysconf('SC_NPROCESSORS_ONLN')
183 except (ValueError, OSError, AttributeError):
187 return int(os
.popen2("sysctl -n hw.ncpu")[1].read())
195 """Common environment generation code"""
197 if env
.get('quiet', True):
198 quietCommandLines(env
)
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'])
209 env
['gcc'] = 'gcc' in os
.path
.basename(env
['CC']).split('-')
210 env
['msvc'] = env
['CC'] == 'cl'
214 machine
= env
['machine']
215 platform
= env
['platform']
216 x86
= env
['machine'] == 'x86'
217 ppc
= env
['machine'] == 'ppc'
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']
226 build_subdir
+= "-llvm"
227 if env
['machine'] != 'generic':
228 build_subdir
+= '-' + env
['machine']
230 build_subdir
+= "-debug"
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')
241 if env
.GetOption('num_jobs') <= 1:
242 env
.SetOption('num_jobs', num_jobs())
244 # C preprocessor options
247 cppdefines
+= ['DEBUG']
249 cppdefines
+= ['NDEBUG']
251 cppdefines
+= ['PROFILE']
252 if platform
== 'windows':
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',
263 if msvc
and env
['toolchain'] != 'winddk':
267 '_CRT_SECURE_NO_WARNINGS',
268 '_CRT_SECURE_NO_DEPRECATE',
269 '_SCL_SECURE_NO_WARNINGS',
270 '_SCL_SECURE_NO_DEPRECATE',
273 cppdefines
+= ['_DEBUG']
274 if env
['toolchain'] == 'winddk':
275 # Mimic WINDDK's builtin flags. See also:
276 # - WINDDK's bin/makefile.new i386mk.inc for more info.
277 # - buildchk_wxp_x86.log files, generated by the WINDDK's build
278 # - http://alter.org.ua/docs/nt_kernel/vc8_proj/
280 cppdefines
+= ['_X86_', 'i386']
281 if machine
== 'x86_64':
282 cppdefines
+= ['_AMD64_', 'AMD64']
283 if platform
== 'winddk':
286 ('CONDITION_HANDLING', '1'),
291 ('_WIN32_WINNT', '0x0501'), # minimum required OS version
292 ('WINVER', '0x0501'),
293 ('_WIN32_IE', '0x0603'),
294 ('WIN32_LEAN_AND_MEAN', '1'),
296 ('__BUILDMACHINE__', 'WinDDK'),
300 cppdefines
+= [('DBG', 1)]
301 if platform
== 'wince':
303 '_CRT_SECURE_NO_DEPRECATE',
308 ('_WIN32_WCE', '0x600'),
316 ('INTLMSG_CODEPAGE', '1252'),
318 if platform
== 'windows':
319 cppdefines
+= ['PIPE_SUBSYSTEM_WINDOWS_USER']
320 if platform
== 'winddk':
321 cppdefines
+= ['PIPE_SUBSYSTEM_WINDOWS_DISPLAY']
322 if platform
== 'wince':
323 cppdefines
+= ['PIPE_SUBSYSTEM_WINDOWS_CE']
324 cppdefines
+= ['PIPE_SUBSYSTEM_WINDOWS_CE_OGL']
325 env
.Append(CPPDEFINES
= cppdefines
)
330 ccflags
= [] # C & C++
333 ccflags
+= ['-O0', '-g3']
334 elif env
['CCVERSION'].startswith('4.2.'):
335 # gcc 4.2.x optimizer is broken
336 print "warning: gcc 4.2.x optimizer is broken -- disabling optimizations"
337 ccflags
+= ['-O0', '-g3']
339 ccflags
+= ['-O3', '-g3']
341 # See http://code.google.com/p/jrfonseca/wiki/Gprof2Dot#Which_options_should_I_pass_to_gcc_when_compiling_for_profiling?
343 '-fno-omit-frame-pointer',
344 '-fno-optimize-sibling-calls',
346 if env
['machine'] == 'x86':
352 if platform
!= 'windows':
353 # XXX: -mstackrealign causes stack corruption on MinGW. Ditto
354 # for -mincoming-stack-boundary=2. Still enable it on other
355 # platforms for now, but we can't rely on it for cross platform
356 # code. We have to use __attribute__((force_align_arg_pointer))
359 '-mmmx', '-msse', '-msse2', # enable SIMD intrinsics
360 '-mstackrealign', # ensure stack is aligned
362 if env
['machine'] == 'x86_64':
365 # - http://gcc.gnu.org/onlinedocs/gcc/Warning-Options.html
368 '-Wmissing-field-initializers',
369 '-Werror=pointer-arith',
372 '-fmessage-length=0', # be nice to Eclipse
373 '-fno-strict-aliasing', # we violate strict pointer aliasing rules
376 '-Werror=declaration-after-statement',
377 '-Wmissing-prototypes',
382 # - http://msdn.microsoft.com/en-us/library/19z1t1wy.aspx
386 '/Od', # disable optimizations
387 '/Oi', # enable intrinsic functions
388 '/Oy-', # disable frame pointer omission
389 '/GL-', # disable whole program optimization
393 '/O2', # optimize for speed
394 '/GL', # enable whole program optimization
397 '/fp:fast', # fast floating point
398 '/W3', # warning level
399 #'/Wp64', # enable 64 bit porting warnings
401 if env
['machine'] == 'x86':
403 #'/arch:SSE2', # use the SSE2 instructions
405 if platform
== 'windows':
409 if platform
== 'winddk':
411 '/Zl', # omit default library name in .OBJ
412 '/Zp8', # 8bytes struct member alignment
413 '/Gy', # separate functions for linker
414 '/Gm-', # disable minimal rebuild
415 '/WX', # treat warnings as errors
416 '/Gz', # __stdcall Calling convention
417 '/GX-', # disable C++ EH
418 '/GR-', # disable C++ RTTI
419 '/GF', # enable read-only string pooling
420 '/G6', # optimize for PPro, P-II, P-III
421 '/Ze', # enable extensions
422 '/Gi-', # disable incremental compilation
423 '/QIfdiv-', # disable Pentium FDIV fix
424 '/hotpatch', # prepares an image for hotpatching.
425 #'/Z7', #enable old-style debug info
427 if platform
== 'wince':
428 # See also C:\WINCE600\public\common\oak\misc\makefile.def
430 '/Zl', # omit default library name in .OBJ
431 '/GF', # enable read-only string pooling
432 '/GR-', # disable C++ RTTI
433 '/GS', # enable security checks
434 # Allow disabling language conformance to maintain backward compat
435 #'/Zc:wchar_t-', # don't force wchar_t as native type, instead of typedef
436 #'/Zc:forScope-', # don't enforce Standard C++ for scoping rules
442 # Automatic pdb generation
443 # See http://scons.tigris.org/issues/show_bug.cgi?id=1656
444 env
.EnsureSConsVersion(0, 98, 0)
445 env
['PDB'] = '${TARGET.base}.pdb'
446 env
.Append(CCFLAGS
= ccflags
)
447 env
.Append(CFLAGS
= cflags
)
448 env
.Append(CXXFLAGS
= cxxflags
)
450 if env
['platform'] == 'windows' and msvc
:
451 # Choose the appropriate MSVC CRT
452 # http://msdn.microsoft.com/en-us/library/2kzt1wy3.aspx
454 env
.Append(CCFLAGS
= ['/MTd'])
455 env
.Append(SHCCFLAGS
= ['/LDd'])
457 env
.Append(CCFLAGS
= ['/MT'])
458 env
.Append(SHCCFLAGS
= ['/LD'])
462 if env
['machine'] == 'x86':
463 env
.Append(ASFLAGS
= ['-m32'])
464 if env
['machine'] == 'x86_64':
465 env
.Append(ASFLAGS
= ['-m64'])
471 if env
['machine'] == 'x86':
472 linkflags
+= ['-m32']
473 if env
['machine'] == 'x86_64':
474 linkflags
+= ['-m64']
478 # Handle circular dependencies in the libraries
479 env
['_LIBFLAGS'] = '-Wl,--start-group ' + env
['_LIBFLAGS'] + ' -Wl,--end-group'
482 # enable Link-time Code Generation
483 linkflags
+= ['/LTCG']
484 env
.Append(ARFLAGS
= ['/LTCG'])
485 if platform
== 'windows' and msvc
:
487 # - http://msdn2.microsoft.com/en-us/library/y0zzbyt4.aspx
492 if platform
== 'winddk':
495 '/merge:_TEXT=.text',
499 '/ignore:4198,4010,4037,4039,4065,4070,4078,4087,4089,4221',
512 '/stack:0x40000,0x1000',
515 '/subsystem:native,5.01',
518 '/entry:DrvEnableDriver',
520 if env
['debug'] or env
['profile']:
522 '/MAP', # http://msdn.microsoft.com/en-us/library/k7xkk3e2.aspx
524 if platform
== 'wince':
529 '/entry:_DllMainCRTStartup',
531 env
.Append(LINKFLAGS
= linkflags
)
532 env
.Append(SHLINKFLAGS
= shlinkflags
)
535 env
.Append(LIBS
= [])
537 # Custom builders and methods
538 createConvenienceLibBuilder(env
)
539 createCodeGenerateMethod(env
)
540 createInstallMethods(env
)