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/config.h')
76 if not os.path.exists(llvm_config):
77 print 'scons: could not find %s' % llvm_config
79 llvm_version_re = re.compile(r'^#define PACKAGE_VERSION "([^"]*)"')
81 for line in open(llvm_config, 'rt'):
82 mo = llvm_version_re.match(line)
84 llvm_version = mo.group(1)
85 llvm_version = distutils.version.LooseVersion(llvm_version)
87 if llvm_version is None:
88 print 'scons: could not determine the LLVM version from %s' % llvm_config
90 if llvm_version < distutils.version.LooseVersion(required_llvm_version):
91 print 'scons: LLVM version %s found, but %s is required' % (llvm_version, required_llvm_version)
94 env.Prepend(CPPPATH = [os.path.join(llvm_dir, 'include')])
95 env.AppendUnique(CPPDEFINES = [
96 '__STDC_LIMIT_MACROS',
97 '__STDC_CONSTANT_MACROS',
100 env.Prepend(LIBPATH = [os.path.join(llvm_dir, 'lib')])
101 # LIBS should match the output of `llvm-config --libs engine mcjit bitwriter x86asmprinter`
102 if llvm_version >= distutils.version.LooseVersion('3.5'):
104 'LLVMBitWriter', 'LLVMMCJIT', 'LLVMRuntimeDyld',
105 'LLVMX86Disassembler', 'LLVMX86AsmParser', 'LLVMX86CodeGen',
106 'LLVMSelectionDAG', 'LLVMAsmPrinter', 'LLVMX86Desc',
107 'LLVMObject', 'LLVMMCParser', 'LLVMBitReader', 'LLVMX86Info',
108 'LLVMX86AsmPrinter', 'LLVMX86Utils', 'LLVMJIT',
109 'LLVMExecutionEngine', 'LLVMCodeGen', 'LLVMScalarOpts',
110 'LLVMInstCombine', 'LLVMTransformUtils', 'LLVMipa',
111 'LLVMAnalysis', 'LLVMTarget', 'LLVMMC', 'LLVMCore',
116 'LLVMBitWriter', 'LLVMX86Disassembler', 'LLVMX86AsmParser',
117 'LLVMX86CodeGen', 'LLVMX86Desc', 'LLVMSelectionDAG',
118 'LLVMAsmPrinter', 'LLVMMCParser', 'LLVMX86AsmPrinter',
119 'LLVMX86Utils', 'LLVMX86Info', 'LLVMMCJIT', 'LLVMJIT',
120 'LLVMExecutionEngine', 'LLVMCodeGen', 'LLVMScalarOpts',
121 'LLVMInstCombine', 'LLVMTransformUtils', 'LLVMipa',
122 'LLVMAnalysis', 'LLVMTarget', 'LLVMMC', 'LLVMCore',
123 'LLVMSupport', 'LLVMRuntimeDyld', 'LLVMObject'
132 # Some of the LLVM C headers use the inline keyword without
134 env.Append(CPPDEFINES = [('inline', '__inline')])
135 # Match some of the warning options from llvm/cmake/modules/HandleLLVMOptions.cmake
136 env.AppendUnique(CXXFLAGS = [
137 '/wd4355', # 'this' : used in base member initializer list
138 '/wd4624', # 'derived class' : destructor could not be generated because a base class destructor is inaccessible
140 if env['build'] in ('debug', 'checked'):
141 # LLVM libraries are static, build with /MT, and they
142 # automatically link agains LIBCMT. When we're doing a
143 # debug build we'll be linking against LIBCMTD, so disable
145 env.Append(LINKFLAGS = ['/nodefaultlib:LIBCMT'])
147 if not env.Detect('llvm-config'):
148 print 'scons: llvm-config script not found'
151 llvm_version = env.backtick('llvm-config --version').rstrip()
152 llvm_version = distutils.version.LooseVersion(llvm_version)
154 if llvm_version < distutils.version.LooseVersion(required_llvm_version):
155 print 'scons: LLVM version %s found, but %s is required' % (llvm_version, required_llvm_version)
159 # Treat --cppflags specially to prevent NDEBUG from disabling
160 # assertion failures in debug builds.
161 cppflags = env.ParseFlags('!llvm-config --cppflags')
163 cppflags['CPPDEFINES'].remove('NDEBUG')
166 env.MergeFlags(cppflags)
168 # Match llvm --fno-rtti flag
169 cxxflags = env.backtick('llvm-config --cxxflags').split()
170 if '-fno-rtti' in cxxflags:
171 env.Append(CXXFLAGS = ['-fno-rtti'])
173 components = ['engine', 'mcjit', 'bitwriter', 'x86asmprinter']
175 env.ParseConfig('llvm-config --libs ' + ' '.join(components))
176 env.ParseConfig('llvm-config --ldflags')
177 if llvm_version >= distutils.version.LooseVersion('3.5'):
178 env.ParseConfig('llvm-config --system-libs')
179 env.Append(CXXFLAGS = ['-std=c++11'])
181 print 'scons: llvm-config version %s failed' % llvm_version
184 assert llvm_version is not None
187 print 'scons: Found LLVM version %s' % llvm_version
188 env['LLVM_VERSION'] = llvm_version
190 # Define HAVE_LLVM macro with the major/minor version number (e.g., 0x0206 for 2.6)
191 llvm_version_major = int(llvm_version.version[0])
192 llvm_version_minor = int(llvm_version.version[1])
193 llvm_version_hex = '0x%02x%02x' % (llvm_version_major, llvm_version_minor)
194 env.Prepend(CPPDEFINES = [('HAVE_LLVM', llvm_version_hex)])
199 # vim:set ts=4 sw=4 et: