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.3'
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
.AppendUnique(CPPDEFINES
= [
105 env
.Prepend(LIBPATH
= [os
.path
.join(llvm_dir
, 'lib')])
106 # LIBS should match the output of `llvm-config --libs engine mcjit bitwriter x86asmprinter irreader`
107 if llvm_version
>= distutils
.version
.LooseVersion('4.0'):
109 'LLVMX86Disassembler', 'LLVMX86AsmParser',
110 'LLVMX86CodeGen', 'LLVMSelectionDAG', 'LLVMAsmPrinter',
111 'LLVMDebugInfoCodeView', 'LLVMCodeGen',
112 'LLVMScalarOpts', 'LLVMInstCombine',
113 'LLVMTransformUtils',
114 'LLVMBitWriter', 'LLVMX86Desc',
115 'LLVMMCDisassembler', 'LLVMX86Info',
116 'LLVMX86AsmPrinter', 'LLVMX86Utils',
117 'LLVMMCJIT', 'LLVMExecutionEngine', 'LLVMTarget',
118 'LLVMAnalysis', 'LLVMProfileData',
119 'LLVMRuntimeDyld', 'LLVMObject', 'LLVMMCParser',
120 'LLVMBitReader', 'LLVMMC', 'LLVMCore',
122 'LLVMIRReader', 'LLVMAsmParser',
123 'LLVMDemangle', 'LLVMGlobalISel', 'LLVMDebugInfoMSF',
125 elif llvm_version
>= distutils
.version
.LooseVersion('3.9'):
127 'LLVMX86Disassembler', 'LLVMX86AsmParser',
128 'LLVMX86CodeGen', 'LLVMSelectionDAG', 'LLVMAsmPrinter',
129 'LLVMDebugInfoCodeView', 'LLVMCodeGen',
130 'LLVMScalarOpts', 'LLVMInstCombine',
131 'LLVMInstrumentation', 'LLVMTransformUtils',
132 'LLVMBitWriter', 'LLVMX86Desc',
133 'LLVMMCDisassembler', 'LLVMX86Info',
134 'LLVMX86AsmPrinter', 'LLVMX86Utils',
135 'LLVMMCJIT', 'LLVMExecutionEngine', 'LLVMTarget',
136 'LLVMAnalysis', 'LLVMProfileData',
137 'LLVMRuntimeDyld', 'LLVMObject', 'LLVMMCParser',
138 'LLVMBitReader', 'LLVMMC', 'LLVMCore',
140 'LLVMIRReader', 'LLVMASMParser'
142 elif llvm_version
>= distutils
.version
.LooseVersion('3.7'):
144 'LLVMBitWriter', 'LLVMX86Disassembler', 'LLVMX86AsmParser',
145 'LLVMX86CodeGen', 'LLVMSelectionDAG', 'LLVMAsmPrinter',
146 'LLVMCodeGen', 'LLVMScalarOpts', 'LLVMProfileData',
147 'LLVMInstCombine', 'LLVMInstrumentation', 'LLVMTransformUtils', 'LLVMipa',
148 'LLVMAnalysis', 'LLVMX86Desc', 'LLVMMCDisassembler',
149 'LLVMX86Info', 'LLVMX86AsmPrinter', 'LLVMX86Utils',
150 'LLVMMCJIT', 'LLVMTarget', 'LLVMExecutionEngine',
151 'LLVMRuntimeDyld', 'LLVMObject', 'LLVMMCParser',
152 'LLVMBitReader', 'LLVMMC', 'LLVMCore', 'LLVMSupport'
154 elif llvm_version
>= distutils
.version
.LooseVersion('3.6'):
156 'LLVMBitWriter', 'LLVMX86Disassembler', 'LLVMX86AsmParser',
157 'LLVMX86CodeGen', 'LLVMSelectionDAG', 'LLVMAsmPrinter',
158 'LLVMCodeGen', 'LLVMScalarOpts', 'LLVMProfileData',
159 'LLVMInstCombine', 'LLVMTransformUtils', 'LLVMipa',
160 'LLVMAnalysis', 'LLVMX86Desc', 'LLVMMCDisassembler',
161 'LLVMX86Info', 'LLVMX86AsmPrinter', 'LLVMX86Utils',
162 'LLVMMCJIT', 'LLVMTarget', 'LLVMExecutionEngine',
163 'LLVMRuntimeDyld', 'LLVMObject', 'LLVMMCParser',
164 'LLVMBitReader', 'LLVMMC', 'LLVMCore', 'LLVMSupport'
166 elif llvm_version
>= distutils
.version
.LooseVersion('3.5'):
168 'LLVMMCDisassembler',
169 'LLVMBitWriter', 'LLVMMCJIT', 'LLVMRuntimeDyld',
170 'LLVMX86Disassembler', 'LLVMX86AsmParser', 'LLVMX86CodeGen',
171 'LLVMSelectionDAG', 'LLVMAsmPrinter', 'LLVMX86Desc',
172 'LLVMObject', 'LLVMMCParser', 'LLVMBitReader', 'LLVMX86Info',
173 'LLVMX86AsmPrinter', 'LLVMX86Utils', 'LLVMJIT',
174 'LLVMExecutionEngine', 'LLVMCodeGen', 'LLVMScalarOpts',
175 'LLVMInstCombine', 'LLVMTransformUtils', 'LLVMipa',
176 'LLVMAnalysis', 'LLVMTarget', 'LLVMMC', 'LLVMCore',
181 'LLVMMCDisassembler',
182 'LLVMBitWriter', 'LLVMX86Disassembler', 'LLVMX86AsmParser',
183 'LLVMX86CodeGen', 'LLVMX86Desc', 'LLVMSelectionDAG',
184 'LLVMAsmPrinter', 'LLVMMCParser', 'LLVMX86AsmPrinter',
185 'LLVMX86Utils', 'LLVMX86Info', 'LLVMMCJIT', 'LLVMJIT',
186 'LLVMExecutionEngine', 'LLVMCodeGen', 'LLVMScalarOpts',
187 'LLVMInstCombine', 'LLVMTransformUtils', 'LLVMipa',
188 'LLVMAnalysis', 'LLVMTarget', 'LLVMMC', 'LLVMCore',
189 'LLVMSupport', 'LLVMRuntimeDyld', 'LLVMObject'
198 # Some of the LLVM C headers use the inline keyword without
200 env
.Append(CPPDEFINES
= [('inline', '__inline')])
201 # Match some of the warning options from llvm/cmake/modules/HandleLLVMOptions.cmake
202 env
.AppendUnique(CXXFLAGS
= [
203 '/wd4355', # 'this' : used in base member initializer list
204 '/wd4624', # 'derived class' : destructor could not be generated because a base class destructor is inaccessible
206 if env
['build'] in ('debug', 'checked'):
207 # LLVM libraries are static, build with /MT, and they
208 # automatically link agains LIBCMT. When we're doing a
209 # debug build we'll be linking against LIBCMTD, so disable
211 env
.Append(LINKFLAGS
= ['/nodefaultlib:LIBCMT'])
213 llvm_config
= os
.environ
.get('LLVM_CONFIG', 'llvm-config')
214 if not env
.Detect(llvm_config
):
215 print 'scons: %s script not found' % llvm_config
218 llvm_version
= env
.backtick('%s --version' % llvm_config
).rstrip()
219 llvm_version
= distutils
.version
.LooseVersion(llvm_version
)
221 if llvm_version
< distutils
.version
.LooseVersion(required_llvm_version
):
222 print 'scons: LLVM version %s found, but %s is required' % (llvm_version
, required_llvm_version
)
226 # Treat --cppflags specially to prevent NDEBUG from disabling
227 # assertion failures in debug builds.
228 cppflags
= env
.ParseFlags('!%s --cppflags' % llvm_config
)
230 cppflags
['CPPDEFINES'].remove('NDEBUG')
233 env
.MergeFlags(cppflags
)
235 # Match llvm --fno-rtti flag
236 cxxflags
= env
.backtick('%s --cxxflags' % llvm_config
).split()
237 if '-fno-rtti' in cxxflags
:
238 env
.Append(CXXFLAGS
= ['-fno-rtti'])
240 components
= ['engine', 'mcjit', 'bitwriter', 'x86asmprinter', 'mcdisassembler', 'irreader']
242 env
.ParseConfig('%s --libs ' % llvm_config
+ ' '.join(components
))
243 env
.ParseConfig('%s --ldflags' % llvm_config
)
244 if llvm_version
>= distutils
.version
.LooseVersion('3.5'):
245 env
.ParseConfig('%s --system-libs' % llvm_config
)
246 env
.Append(CXXFLAGS
= ['-std=c++11'])
248 print 'scons: llvm-config version %s failed' % llvm_version
251 assert llvm_version
is not None
254 print 'scons: Found LLVM version %s' % llvm_version
255 env
['LLVM_VERSION'] = llvm_version
257 # Define HAVE_LLVM macro with the major/minor version number (e.g., 0x0206 for 2.6)
258 llvm_version_major
= int(llvm_version
.version
[0])
259 llvm_version_minor
= int(llvm_version
.version
[1])
260 llvm_version_hex
= '0x%02x%02x' % (llvm_version_major
, llvm_version_minor
)
261 env
.Prepend(CPPDEFINES
= [('HAVE_LLVM', llvm_version_hex
)])
266 # vim:set ts=4 sw=4 et: