33505f794477be470fe7ebc97c7815aa9faada30
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.
34 import distutils
.version
40 required_llvm_version
= '3.9'
47 llvm_dir
= os
.environ
['LLVM']
49 # Do nothing -- use the system headers/libs
52 if not os
.path
.isdir(llvm_dir
):
53 raise SCons
.Errors
.InternalError("Specified LLVM directory not found")
58 llvm_subdir
= 'Release'
60 llvm_bin_dir
= os
.path
.join(llvm_dir
, llvm_subdir
, 'bin')
61 if not os
.path
.isdir(llvm_bin_dir
):
62 llvm_bin_dir
= os
.path
.join(llvm_dir
, 'bin')
63 if not os
.path
.isdir(llvm_bin_dir
):
64 raise SCons
.Errors
.InternalError("LLVM binary directory not found")
66 env
.PrependENVPath('PATH', llvm_bin_dir
)
68 if env
['platform'] == 'windows':
69 # XXX: There is no llvm-config on Windows, so assume a standard layout
71 print('scons: LLVM environment variable must be specified when building for windows')
74 # Try to determine the LLVM version from llvm/Config/config.h
75 llvm_config
= os
.path
.join(llvm_dir
, 'include/llvm/Config/llvm-config.h')
76 if not os
.path
.exists(llvm_config
):
77 print('scons: could not find %s' % llvm_config
)
79 llvm_version_major_re
= re
.compile(r
'^#define LLVM_VERSION_MAJOR ([0-9]+)')
80 llvm_version_minor_re
= re
.compile(r
'^#define LLVM_VERSION_MINOR ([0-9]+)')
82 llvm_version_major
= None
83 llvm_version_minor
= None
84 for line
in open(llvm_config
, 'rt'):
85 mo
= llvm_version_major_re
.match(line
)
87 llvm_version_major
= mo
.group(1)
88 mo
= llvm_version_minor_re
.match(line
)
90 llvm_version_minor
= mo
.group(1)
91 if llvm_version_major
is not None and llvm_version_minor
is not None:
92 llvm_version
= distutils
.version
.LooseVersion('%s.%s' % (llvm_version_major
, llvm_version_minor
))
94 if llvm_version
is None:
95 print('scons: could not determine the LLVM version from %s' % llvm_config
)
97 if llvm_version
< distutils
.version
.LooseVersion(required_llvm_version
):
98 print('scons: LLVM version %s found, but %s is required' % (llvm_version
, required_llvm_version
))
101 env
.Prepend(CPPPATH
= [os
.path
.join(llvm_dir
, 'include')])
102 env
.Prepend(LIBPATH
= [os
.path
.join(llvm_dir
, 'lib')])
104 # LLVM 5.0 and newer requires MinGW w/ pthreads due to use of std::thread and friends.
105 if llvm_version
>= distutils
.version
.LooseVersion('5.0') and env
['crosscompile']:
107 env
.AppendUnique(CXXFLAGS
= ['-posix'])
109 # LIBS should match the output of `llvm-config --libs engine mcjit bitwriter x86asmprinter irreader` for LLVM<=7.0
110 # and `llvm-config --libs engine irreader` for LLVM>=8.0
111 # LLVMAggressiveInstCombine library part of engine component can be safely omitted as it's not used.
112 if llvm_version
>= distutils
.version
.LooseVersion('9.0'):
114 'LLVMX86Disassembler', 'LLVMX86AsmParser',
115 'LLVMX86CodeGen', 'LLVMSelectionDAG', 'LLVMAsmPrinter',
116 'LLVMDebugInfoCodeView', 'LLVMCodeGen',
117 'LLVMScalarOpts', 'LLVMInstCombine',
118 'LLVMTransformUtils',
119 'LLVMBitWriter', 'LLVMX86Desc',
120 'LLVMMCDisassembler', 'LLVMX86Info',
122 'LLVMMCJIT', 'LLVMExecutionEngine', 'LLVMTarget',
123 'LLVMAnalysis', 'LLVMProfileData',
124 'LLVMRuntimeDyld', 'LLVMObject', 'LLVMMCParser',
125 'LLVMBitReader', 'LLVMMC', 'LLVMCore',
127 'LLVMIRReader', 'LLVMAsmParser',
128 'LLVMDemangle', 'LLVMGlobalISel', 'LLVMDebugInfoMSF',
130 'LLVMRemarks', 'LLVMBitstreamReader', 'LLVMDebugInfoDWARF',
132 elif llvm_version
>= distutils
.version
.LooseVersion('5.0'):
134 'LLVMX86Disassembler', 'LLVMX86AsmParser',
135 'LLVMX86CodeGen', 'LLVMSelectionDAG', 'LLVMAsmPrinter',
136 'LLVMDebugInfoCodeView', 'LLVMCodeGen',
137 'LLVMScalarOpts', 'LLVMInstCombine',
138 'LLVMTransformUtils',
139 'LLVMBitWriter', 'LLVMX86Desc',
140 'LLVMMCDisassembler', 'LLVMX86Info',
141 'LLVMX86AsmPrinter', 'LLVMX86Utils',
142 'LLVMMCJIT', 'LLVMExecutionEngine', 'LLVMTarget',
143 'LLVMAnalysis', 'LLVMProfileData',
144 'LLVMRuntimeDyld', 'LLVMObject', 'LLVMMCParser',
145 'LLVMBitReader', 'LLVMMC', 'LLVMCore',
147 'LLVMIRReader', 'LLVMAsmParser',
148 'LLVMDemangle', 'LLVMGlobalISel', 'LLVMDebugInfoMSF',
151 elif llvm_version
>= distutils
.version
.LooseVersion('4.0'):
153 'LLVMX86Disassembler', 'LLVMX86AsmParser',
154 'LLVMX86CodeGen', 'LLVMSelectionDAG', 'LLVMAsmPrinter',
155 'LLVMDebugInfoCodeView', 'LLVMCodeGen',
156 'LLVMScalarOpts', 'LLVMInstCombine',
157 'LLVMTransformUtils',
158 'LLVMBitWriter', 'LLVMX86Desc',
159 'LLVMMCDisassembler', 'LLVMX86Info',
160 'LLVMX86AsmPrinter', 'LLVMX86Utils',
161 'LLVMMCJIT', 'LLVMExecutionEngine', 'LLVMTarget',
162 'LLVMAnalysis', 'LLVMProfileData',
163 'LLVMRuntimeDyld', 'LLVMObject', 'LLVMMCParser',
164 'LLVMBitReader', 'LLVMMC', 'LLVMCore',
166 'LLVMIRReader', 'LLVMAsmParser',
167 'LLVMDemangle', 'LLVMGlobalISel', 'LLVMDebugInfoMSF',
171 'LLVMX86Disassembler', 'LLVMX86AsmParser',
172 'LLVMX86CodeGen', 'LLVMSelectionDAG', 'LLVMAsmPrinter',
173 'LLVMDebugInfoCodeView', 'LLVMCodeGen',
174 'LLVMScalarOpts', 'LLVMInstCombine',
175 'LLVMInstrumentation', 'LLVMTransformUtils',
176 'LLVMBitWriter', 'LLVMX86Desc',
177 'LLVMMCDisassembler', 'LLVMX86Info',
178 'LLVMX86AsmPrinter', 'LLVMX86Utils',
179 'LLVMMCJIT', 'LLVMExecutionEngine', 'LLVMTarget',
180 'LLVMAnalysis', 'LLVMProfileData',
181 'LLVMRuntimeDyld', 'LLVMObject', 'LLVMMCParser',
182 'LLVMBitReader', 'LLVMMC', 'LLVMCore',
184 'LLVMIRReader', 'LLVMASMParser'
196 # Some of the LLVM C headers use the inline keyword without
198 env
.Append(CPPDEFINES
= [('inline', '__inline')])
199 # Match some of the warning options from llvm/cmake/modules/HandleLLVMOptions.cmake
200 env
.AppendUnique(CXXFLAGS
= [
201 '/wd4355', # 'this' : used in base member initializer list
202 '/wd4624', # 'derived class' : destructor could not be generated because a base class destructor is inaccessible
204 if env
['build'] in ('debug', 'checked'):
205 # LLVM libraries are static, build with /MT, and they
206 # automatically link agains LIBCMT. When we're doing a
207 # debug build we'll be linking against LIBCMTD, so disable
209 env
.Append(LINKFLAGS
= ['/nodefaultlib:LIBCMT'])
211 llvm_config
= os
.environ
.get('LLVM_CONFIG', 'llvm-config')
212 if not env
.Detect(llvm_config
):
213 print('scons: %s script not found' % llvm_config
)
216 llvm_version
= env
.backtick('%s --version' % llvm_config
).rstrip()
217 llvm_version
= distutils
.version
.LooseVersion(llvm_version
)
219 if llvm_version
< distutils
.version
.LooseVersion(required_llvm_version
):
220 print('scons: LLVM version %s found, but %s is required' % (llvm_version
, required_llvm_version
))
224 # Treat --cppflags specially to prevent NDEBUG from disabling
225 # assertion failures in debug builds.
226 cppflags
= env
.ParseFlags('!%s --cppflags' % llvm_config
)
228 cppflags
['CPPDEFINES'].remove('NDEBUG')
231 env
.MergeFlags(cppflags
)
233 # Match llvm --fno-rtti flag
234 cxxflags
= env
.backtick('%s --cxxflags' % llvm_config
).split()
235 if '-fno-rtti' in cxxflags
:
236 env
.Append(CXXFLAGS
= ['-fno-rtti'])
238 if llvm_version
< distutils
.version
.LooseVersion('9.0'):
239 components
= ['engine', 'mcjit', 'bitwriter', 'x86asmprinter', 'mcdisassembler', 'irreader']
241 components
= ['engine', 'mcjit', 'bitwriter', 'mcdisassembler', 'irreader']
243 if llvm_version
>= distutils
.version
.LooseVersion('8.0'):
244 components
.append('coroutines')
246 env
.ParseConfig('%s --libs ' % llvm_config
+ ' '.join(components
))
247 env
.ParseConfig('%s --ldflags' % llvm_config
)
248 env
.ParseConfig('%s --system-libs' % llvm_config
)
249 env
.Append(CXXFLAGS
= ['-std=c++14'])
251 print('scons: llvm-config version %s failed' % llvm_version
)
254 assert llvm_version
is not None
257 print('scons: Found LLVM version %s' % llvm_version
)
258 env
['LLVM_VERSION'] = llvm_version
260 # Define LLVM_AVAILABLE macro to guard code blocks, and MESA_LLVM_VERSION_STRING
261 env
.Prepend(CPPDEFINES
= [('LLVM_AVAILABLE', 1)])
262 env
.Prepend(CPPDEFINES
= [('MESA_LLVM_VERSION_STRING=\\"%s\\"' % llvm_version
)])
267 # vim:set ts=4 sw=4 et: