3 Tool-specific initialization for LLVM
8 # Copyright (c) 2009 VMware, Inc.
10 # Permission is hereby granted, free of charge, to any person obtaining
11 # a copy of this software and associated documentation files (the
12 # "Software"), to deal in the Software without restriction, including
13 # without limitation the rights to use, copy, modify, merge, publish,
14 # distribute, sublicense, and/or sell copies of the Software, and to
15 # permit persons to whom the Software is furnished to do so, subject to
16 # the following conditions:
18 # The above copyright notice and this permission notice shall be included
19 # in all copies or substantial portions of the Software.
21 # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY
22 # KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
23 # WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
24 # NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
25 # LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
26 # OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
27 # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
33 import platform
as host_platform
35 import distutils
.version
41 required_llvm_version
= '3.9'
48 llvm_dir
= os
.environ
['LLVM']
50 # Do nothing -- use the system headers/libs
53 if not os
.path
.isdir(llvm_dir
):
54 raise SCons
.Errors
.InternalError("Specified LLVM directory not found")
59 llvm_subdir
= 'Release'
61 llvm_bin_dir
= os
.path
.join(llvm_dir
, llvm_subdir
, 'bin')
62 if not os
.path
.isdir(llvm_bin_dir
):
63 llvm_bin_dir
= os
.path
.join(llvm_dir
, 'bin')
64 if not os
.path
.isdir(llvm_bin_dir
):
65 raise SCons
.Errors
.InternalError("LLVM binary directory not found")
67 env
.PrependENVPath('PATH', llvm_bin_dir
)
69 if env
['platform'] == 'windows':
70 # XXX: There is no llvm-config on Windows, so assume a standard layout
72 print('scons: LLVM environment variable must be specified when building for windows')
75 # Try to determine the LLVM version from llvm/Config/config.h
76 llvm_config
= os
.path
.join(llvm_dir
, 'include/llvm/Config/llvm-config.h')
77 if not os
.path
.exists(llvm_config
):
78 print('scons: could not find %s' % llvm_config
)
80 llvm_version_major_re
= re
.compile(r
'^#define LLVM_VERSION_MAJOR ([0-9]+)')
81 llvm_version_minor_re
= re
.compile(r
'^#define LLVM_VERSION_MINOR ([0-9]+)')
83 llvm_version_major
= None
84 llvm_version_minor
= None
85 for line
in open(llvm_config
, 'rt'):
86 mo
= llvm_version_major_re
.match(line
)
88 llvm_version_major
= mo
.group(1)
89 mo
= llvm_version_minor_re
.match(line
)
91 llvm_version_minor
= mo
.group(1)
92 if llvm_version_major
is not None and llvm_version_minor
is not None:
93 llvm_version
= distutils
.version
.LooseVersion('%s.%s' % (llvm_version_major
, llvm_version_minor
))
95 if llvm_version
is None:
96 print('scons: could not determine the LLVM version from %s' % llvm_config
)
98 if llvm_version
< distutils
.version
.LooseVersion(required_llvm_version
):
99 print('scons: LLVM version %s found, but %s is required' % (llvm_version
, required_llvm_version
))
102 env
.Prepend(CPPPATH
= [os
.path
.join(llvm_dir
, 'include')])
103 env
.Prepend(LIBPATH
= [os
.path
.join(llvm_dir
, 'lib')])
105 # LLVM 5.0 and newer requires MinGW w/ pthreads due to use of std::thread and friends.
106 if llvm_version
>= distutils
.version
.LooseVersion('5.0') and env
['crosscompile']:
108 env
.AppendUnique(CXXFLAGS
= ['-posix'])
110 # LIBS should match the output of `llvm-config --libs engine mcjit bitwriter x86asmprinter irreader` for LLVM<=7.0
111 # and `llvm-config --libs engine coroutines` for LLVM>=8.0
112 # LLVMAggressiveInstCombine library part of engine component since LLVM 6 is only needed by Mesa3D for LLVM>=8.
113 # While not directly needed by Mesa3D, this library is needed by LLVMipo which is part of coroutines component.
114 if llvm_version
>= distutils
.version
.LooseVersion('10.0'):
116 'LLVMX86Disassembler', 'LLVMX86AsmParser',
117 'LLVMX86CodeGen', 'LLVMSelectionDAG', 'LLVMAsmPrinter',
118 'LLVMDebugInfoCodeView', 'LLVMCodeGen',
119 'LLVMScalarOpts', 'LLVMInstCombine',
120 'LLVMTransformUtils',
121 'LLVMBitWriter', 'LLVMX86Desc',
122 'LLVMMCDisassembler', 'LLVMX86Info',
124 'LLVMMCJIT', 'LLVMExecutionEngine', 'LLVMTarget',
125 'LLVMAnalysis', 'LLVMProfileData',
126 'LLVMRuntimeDyld', 'LLVMObject', 'LLVMMCParser',
127 'LLVMBitReader', 'LLVMMC', 'LLVMCore',
129 'LLVMIRReader', 'LLVMAsmParser',
130 'LLVMDemangle', 'LLVMGlobalISel', 'LLVMDebugInfoMSF',
132 'LLVMRemarks', 'LLVMBitstreamReader', 'LLVMDebugInfoDWARF',
133 'LLVMAggressiveInstCombine','LLVMLinker', 'LLVMVectorize',
134 'LLVMInstrumentation', 'LLVMipo', 'LLVMCoroutines',
135 'LLVMCFGuard', 'LLVMTextAPI',
137 elif llvm_version
>= distutils
.version
.LooseVersion('9.0'):
139 'LLVMX86Disassembler', 'LLVMX86AsmParser',
140 'LLVMX86CodeGen', 'LLVMSelectionDAG', 'LLVMAsmPrinter',
141 'LLVMDebugInfoCodeView', 'LLVMCodeGen',
142 'LLVMScalarOpts', 'LLVMInstCombine',
143 'LLVMTransformUtils',
144 'LLVMBitWriter', 'LLVMX86Desc',
145 'LLVMMCDisassembler', 'LLVMX86Info',
147 'LLVMMCJIT', 'LLVMExecutionEngine', 'LLVMTarget',
148 'LLVMAnalysis', 'LLVMProfileData',
149 'LLVMRuntimeDyld', 'LLVMObject', 'LLVMMCParser',
150 'LLVMBitReader', 'LLVMMC', 'LLVMCore',
152 'LLVMIRReader', 'LLVMAsmParser',
153 'LLVMDemangle', 'LLVMGlobalISel', 'LLVMDebugInfoMSF',
155 'LLVMRemarks', 'LLVMBitstreamReader', 'LLVMDebugInfoDWARF',
156 # Add these libraries to enable ompute shaders support.
157 'LLVMAggressiveInstCombine','LLVMLinker', 'LLVMVectorize',
158 'LLVMInstrumentation', 'LLVMipo', 'LLVMCoroutines',
160 elif llvm_version
>= distutils
.version
.LooseVersion('8.0'):
162 'LLVMX86Disassembler', 'LLVMX86AsmParser',
163 'LLVMX86CodeGen', 'LLVMSelectionDAG', 'LLVMAsmPrinter',
164 'LLVMDebugInfoCodeView', 'LLVMCodeGen',
165 'LLVMScalarOpts', 'LLVMInstCombine',
166 'LLVMTransformUtils',
167 'LLVMBitWriter', 'LLVMX86Desc',
168 'LLVMMCDisassembler', 'LLVMX86Info',
169 'LLVMX86AsmPrinter', 'LLVMX86Utils',
170 'LLVMMCJIT', 'LLVMExecutionEngine', 'LLVMTarget',
171 'LLVMAnalysis', 'LLVMProfileData',
172 'LLVMRuntimeDyld', 'LLVMObject', 'LLVMMCParser',
173 'LLVMBitReader', 'LLVMMC', 'LLVMCore',
175 'LLVMIRReader', 'LLVMAsmParser',
176 'LLVMDemangle', 'LLVMGlobalISel', 'LLVMDebugInfoMSF',
178 # Add these libraries to enable ompute shaders support.
179 'LLVMAggressiveInstCombine', 'LLVMLinker', 'LLVMVectorize',
180 'LLVMInstrumentation', 'LLVMipo', 'LLVMCoroutines',
182 elif llvm_version
>= distutils
.version
.LooseVersion('5.0'):
184 'LLVMX86Disassembler', 'LLVMX86AsmParser',
185 'LLVMX86CodeGen', 'LLVMSelectionDAG', 'LLVMAsmPrinter',
186 'LLVMDebugInfoCodeView', 'LLVMCodeGen',
187 'LLVMScalarOpts', 'LLVMInstCombine',
188 'LLVMTransformUtils',
189 'LLVMBitWriter', 'LLVMX86Desc',
190 'LLVMMCDisassembler', 'LLVMX86Info',
191 'LLVMX86AsmPrinter', 'LLVMX86Utils',
192 'LLVMMCJIT', 'LLVMExecutionEngine', 'LLVMTarget',
193 'LLVMAnalysis', 'LLVMProfileData',
194 'LLVMRuntimeDyld', 'LLVMObject', 'LLVMMCParser',
195 'LLVMBitReader', 'LLVMMC', 'LLVMCore',
197 'LLVMIRReader', 'LLVMAsmParser',
198 'LLVMDemangle', 'LLVMGlobalISel', 'LLVMDebugInfoMSF',
201 elif llvm_version
>= distutils
.version
.LooseVersion('4.0'):
203 'LLVMX86Disassembler', 'LLVMX86AsmParser',
204 'LLVMX86CodeGen', 'LLVMSelectionDAG', 'LLVMAsmPrinter',
205 'LLVMDebugInfoCodeView', 'LLVMCodeGen',
206 'LLVMScalarOpts', 'LLVMInstCombine',
207 'LLVMTransformUtils',
208 'LLVMBitWriter', 'LLVMX86Desc',
209 'LLVMMCDisassembler', 'LLVMX86Info',
210 'LLVMX86AsmPrinter', 'LLVMX86Utils',
211 'LLVMMCJIT', 'LLVMExecutionEngine', 'LLVMTarget',
212 'LLVMAnalysis', 'LLVMProfileData',
213 'LLVMRuntimeDyld', 'LLVMObject', 'LLVMMCParser',
214 'LLVMBitReader', 'LLVMMC', 'LLVMCore',
216 'LLVMIRReader', 'LLVMAsmParser',
217 'LLVMDemangle', 'LLVMGlobalISel', 'LLVMDebugInfoMSF',
221 'LLVMX86Disassembler', 'LLVMX86AsmParser',
222 'LLVMX86CodeGen', 'LLVMSelectionDAG', 'LLVMAsmPrinter',
223 'LLVMDebugInfoCodeView', 'LLVMCodeGen',
224 'LLVMScalarOpts', 'LLVMInstCombine',
225 'LLVMInstrumentation', 'LLVMTransformUtils',
226 'LLVMBitWriter', 'LLVMX86Desc',
227 'LLVMMCDisassembler', 'LLVMX86Info',
228 'LLVMX86AsmPrinter', 'LLVMX86Utils',
229 'LLVMMCJIT', 'LLVMExecutionEngine', 'LLVMTarget',
230 'LLVMAnalysis', 'LLVMProfileData',
231 'LLVMRuntimeDyld', 'LLVMObject', 'LLVMMCParser',
232 'LLVMBitReader', 'LLVMMC', 'LLVMCore',
234 'LLVMIRReader', 'LLVMASMParser'
245 # Mingw-w64 zlib is required when building with LLVM support in MSYS2 environment
246 if host_platform
.system().lower().startswith('mingw'):
252 # Some of the LLVM C headers use the inline keyword without
254 env
.Append(CPPDEFINES
= [('inline', '__inline')])
255 # Match some of the warning options from llvm/cmake/modules/HandleLLVMOptions.cmake
256 env
.AppendUnique(CXXFLAGS
= [
257 '/wd4355', # 'this' : used in base member initializer list
258 '/wd4624', # 'derived class' : destructor could not be generated because a base class destructor is inaccessible
260 if env
['build'] in ('debug', 'checked'):
261 # LLVM libraries are static, build with /MT, and they
262 # automatically link agains LIBCMT. When we're doing a
263 # debug build we'll be linking against LIBCMTD, so disable
265 env
.Append(LINKFLAGS
= ['/nodefaultlib:LIBCMT'])
267 llvm_config
= os
.environ
.get('LLVM_CONFIG', 'llvm-config')
268 if not env
.Detect(llvm_config
):
269 print('scons: %s script not found' % llvm_config
)
272 llvm_version
= env
.backtick('%s --version' % llvm_config
).rstrip()
273 llvm_version
= distutils
.version
.LooseVersion(llvm_version
)
275 if llvm_version
< distutils
.version
.LooseVersion(required_llvm_version
):
276 print('scons: LLVM version %s found, but %s is required' % (llvm_version
, required_llvm_version
))
280 # Treat --cppflags specially to prevent NDEBUG from disabling
281 # assertion failures in debug builds.
282 cppflags
= env
.ParseFlags('!%s --cppflags' % llvm_config
)
284 cppflags
['CPPDEFINES'].remove('NDEBUG')
287 env
.MergeFlags(cppflags
)
289 # Match llvm --fno-rtti flag
290 cxxflags
= env
.backtick('%s --cxxflags' % llvm_config
).split()
291 if '-fno-rtti' in cxxflags
:
292 env
.Append(CXXFLAGS
= ['-fno-rtti'])
294 if llvm_version
< distutils
.version
.LooseVersion('9.0'):
295 components
= ['engine', 'mcjit', 'bitwriter', 'x86asmprinter', 'mcdisassembler', 'irreader']
297 components
= ['engine', 'mcjit', 'bitwriter', 'mcdisassembler', 'irreader']
299 if llvm_version
>= distutils
.version
.LooseVersion('8.0'):
300 components
.append('coroutines')
302 env
.ParseConfig('%s --libs ' % llvm_config
+ ' '.join(components
))
303 env
.ParseConfig('%s --ldflags' % llvm_config
)
304 env
.ParseConfig('%s --system-libs' % llvm_config
)
305 env
.Append(CXXFLAGS
= ['-std=c++14'])
307 print('scons: llvm-config version %s failed' % llvm_version
)
310 assert llvm_version
is not None
313 print('scons: Found LLVM version %s' % llvm_version
)
314 env
['LLVM_VERSION'] = llvm_version
316 # Define LLVM_AVAILABLE macro to guard code blocks, and MESA_LLVM_VERSION_STRING
317 env
.Prepend(CPPDEFINES
= [('LLVM_AVAILABLE', 1)])
318 env
.Prepend(CPPDEFINES
= [('MESA_LLVM_VERSION_STRING=\\"%s\\"' % llvm_version
)])
323 # vim:set ts=4 sw=4 et: