1"""llvm
2
3Tool-specific initialization for LLVM
4
5"""
6
7#
8# Copyright (c) 2009 VMware, Inc.
9#
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:
17#
18# The above copyright notice and this permission notice shall be included
19# in all copies or substantial portions of the Software.
20#
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.
28#
29
30import os
31import os.path
32import re
33import sys
34import distutils.version
35
36import SCons.Errors
37import SCons.Util
38
39
40required_llvm_version = '3.3'
41
42
43def generate(env):
44    env['llvm'] = False
45
46    try:
47        llvm_dir = os.environ['LLVM']
48    except KeyError:
49        # Do nothing -- use the system headers/libs
50        llvm_dir = None
51    else:
52        if not os.path.isdir(llvm_dir):
53            raise SCons.Errors.InternalError, "Specified LLVM directory not found"
54
55        if env['debug']:
56            llvm_subdir = 'Debug'
57        else:
58            llvm_subdir = 'Release'
59
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"
65
66        env.PrependENVPath('PATH', llvm_bin_dir)
67
68    if env['platform'] == 'windows':
69        # XXX: There is no llvm-config on Windows, so assume a standard layout
70        if llvm_dir is None:
71            print 'scons: LLVM environment variable must be specified when building for windows'
72            return
73
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
78            return
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]+)')
81        llvm_version = None
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)
86            if mo:
87                llvm_version_major = mo.group(1)
88            mo = llvm_version_minor_re.match(line)
89            if mo:
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))
93
94        if llvm_version is None:
95            print 'scons: could not determine the LLVM version from %s' % llvm_config
96            return
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)
99            return
100
101        env.Prepend(CPPPATH = [os.path.join(llvm_dir, 'include')])
102        env.AppendUnique(CPPDEFINES = [
103            '__STDC_LIMIT_MACROS',
104            '__STDC_CONSTANT_MACROS',
105            'HAVE_STDINT_H',
106        ])
107        env.Prepend(LIBPATH = [os.path.join(llvm_dir, 'lib')])
108        # LIBS should match the output of `llvm-config --libs engine mcjit bitwriter x86asmprinter`
109        if llvm_version >= distutils.version.LooseVersion('3.9'):
110            env.Prepend(LIBS = [
111                'LLVMX86Disassembler', 'LLVMX86AsmParser',
112                'LLVMX86CodeGen', 'LLVMSelectionDAG', 'LLVMAsmPrinter',
113                'LLVMDebugInfoCodeView', 'LLVMCodeGen',
114                'LLVMScalarOpts', 'LLVMInstCombine',
115                'LLVMInstrumentation', 'LLVMTransformUtils',
116                'LLVMBitWriter', 'LLVMX86Desc',
117                'LLVMMCDisassembler', 'LLVMX86Info',
118                'LLVMX86AsmPrinter', 'LLVMX86Utils',
119                'LLVMMCJIT', 'LLVMExecutionEngine', 'LLVMTarget',
120                'LLVMAnalysis', 'LLVMProfileData',
121                'LLVMRuntimeDyld', 'LLVMObject', 'LLVMMCParser',
122                'LLVMBitReader', 'LLVMMC', 'LLVMCore',
123                'LLVMSupport',
124                'LLVMIRReader', 'LLVMASMParser'
125            ])
126        elif llvm_version >= distutils.version.LooseVersion('3.7'):
127            env.Prepend(LIBS = [
128                'LLVMBitWriter', 'LLVMX86Disassembler', 'LLVMX86AsmParser',
129                'LLVMX86CodeGen', 'LLVMSelectionDAG', 'LLVMAsmPrinter',
130                'LLVMCodeGen', 'LLVMScalarOpts', 'LLVMProfileData',
131                'LLVMInstCombine', 'LLVMInstrumentation', 'LLVMTransformUtils', 'LLVMipa',
132                'LLVMAnalysis', 'LLVMX86Desc', 'LLVMMCDisassembler',
133                'LLVMX86Info', 'LLVMX86AsmPrinter', 'LLVMX86Utils',
134                'LLVMMCJIT', 'LLVMTarget', 'LLVMExecutionEngine',
135                'LLVMRuntimeDyld', 'LLVMObject', 'LLVMMCParser',
136                'LLVMBitReader', 'LLVMMC', 'LLVMCore', 'LLVMSupport'
137            ])
138        elif llvm_version >= distutils.version.LooseVersion('3.6'):
139            env.Prepend(LIBS = [
140                'LLVMBitWriter', 'LLVMX86Disassembler', 'LLVMX86AsmParser',
141                'LLVMX86CodeGen', 'LLVMSelectionDAG', 'LLVMAsmPrinter',
142                'LLVMCodeGen', 'LLVMScalarOpts', 'LLVMProfileData',
143                'LLVMInstCombine', 'LLVMTransformUtils', 'LLVMipa',
144                'LLVMAnalysis', 'LLVMX86Desc', 'LLVMMCDisassembler',
145                'LLVMX86Info', 'LLVMX86AsmPrinter', 'LLVMX86Utils',
146                'LLVMMCJIT', 'LLVMTarget', 'LLVMExecutionEngine',
147                'LLVMRuntimeDyld', 'LLVMObject', 'LLVMMCParser',
148                'LLVMBitReader', 'LLVMMC', 'LLVMCore', 'LLVMSupport'
149            ])
150        elif llvm_version >= distutils.version.LooseVersion('3.5'):
151            env.Prepend(LIBS = [
152                'LLVMMCDisassembler',
153                'LLVMBitWriter', 'LLVMMCJIT', 'LLVMRuntimeDyld',
154                'LLVMX86Disassembler', 'LLVMX86AsmParser', 'LLVMX86CodeGen',
155                'LLVMSelectionDAG', 'LLVMAsmPrinter', 'LLVMX86Desc',
156                'LLVMObject', 'LLVMMCParser', 'LLVMBitReader', 'LLVMX86Info',
157                'LLVMX86AsmPrinter', 'LLVMX86Utils', 'LLVMJIT',
158                'LLVMExecutionEngine', 'LLVMCodeGen', 'LLVMScalarOpts',
159                'LLVMInstCombine', 'LLVMTransformUtils', 'LLVMipa',
160                'LLVMAnalysis', 'LLVMTarget', 'LLVMMC', 'LLVMCore',
161                'LLVMSupport'
162            ])
163        else:
164            env.Prepend(LIBS = [
165                'LLVMMCDisassembler',
166                'LLVMBitWriter', 'LLVMX86Disassembler', 'LLVMX86AsmParser',
167                'LLVMX86CodeGen', 'LLVMX86Desc', 'LLVMSelectionDAG',
168                'LLVMAsmPrinter', 'LLVMMCParser', 'LLVMX86AsmPrinter',
169                'LLVMX86Utils', 'LLVMX86Info', 'LLVMMCJIT', 'LLVMJIT',
170                'LLVMExecutionEngine', 'LLVMCodeGen', 'LLVMScalarOpts',
171                'LLVMInstCombine', 'LLVMTransformUtils', 'LLVMipa',
172                'LLVMAnalysis', 'LLVMTarget', 'LLVMMC', 'LLVMCore',
173                'LLVMSupport', 'LLVMRuntimeDyld', 'LLVMObject'
174            ])
175        env.Append(LIBS = [
176            'imagehlp',
177            'psapi',
178            'shell32',
179            'advapi32'
180        ])
181        if env['msvc']:
182            # Some of the LLVM C headers use the inline keyword without
183            # defining it.
184            env.Append(CPPDEFINES = [('inline', '__inline')])
185            # Match some of the warning options from llvm/cmake/modules/HandleLLVMOptions.cmake
186            env.AppendUnique(CXXFLAGS = [
187                '/wd4355', # 'this' : used in base member initializer list
188                '/wd4624', # 'derived class' : destructor could not be generated because a base class destructor is inaccessible
189            ])
190            if env['build'] in ('debug', 'checked'):
191                # LLVM libraries are static, build with /MT, and they
192                # automatically link agains LIBCMT. When we're doing a
193                # debug build we'll be linking against LIBCMTD, so disable
194                # that.
195                env.Append(LINKFLAGS = ['/nodefaultlib:LIBCMT'])
196    else:
197        llvm_config = os.environ.get('LLVM_CONFIG', 'llvm-config')
198        if not env.Detect(llvm_config):
199            print 'scons: %s script not found' % llvm_config
200            return
201
202        llvm_version = env.backtick('%s --version' % llvm_config).rstrip()
203        llvm_version = distutils.version.LooseVersion(llvm_version)
204
205        if llvm_version < distutils.version.LooseVersion(required_llvm_version):
206            print 'scons: LLVM version %s found, but %s is required' % (llvm_version, required_llvm_version)
207            return
208
209        try:
210            # Treat --cppflags specially to prevent NDEBUG from disabling
211            # assertion failures in debug builds.
212            cppflags = env.ParseFlags('!%s --cppflags' % llvm_config)
213            try:
214                cppflags['CPPDEFINES'].remove('NDEBUG')
215            except ValueError:
216                pass
217            env.MergeFlags(cppflags)
218
219            # Match llvm --fno-rtti flag
220            cxxflags = env.backtick('%s --cxxflags' % llvm_config).split()
221            if '-fno-rtti' in cxxflags:
222                env.Append(CXXFLAGS = ['-fno-rtti'])
223
224            components = ['engine', 'mcjit', 'bitwriter', 'x86asmprinter', 'mcdisassembler', 'irreader']
225
226            env.ParseConfig('%s --libs ' % llvm_config + ' '.join(components))
227            env.ParseConfig('%s --ldflags' % llvm_config)
228            if llvm_version >= distutils.version.LooseVersion('3.5'):
229                env.ParseConfig('%s --system-libs' % llvm_config)
230                env.Append(CXXFLAGS = ['-std=c++11'])
231        except OSError:
232            print 'scons: llvm-config version %s failed' % llvm_version
233            return
234
235    assert llvm_version is not None
236    env['llvm'] = True
237
238    print 'scons: Found LLVM version %s' % llvm_version
239    env['LLVM_VERSION'] = llvm_version
240
241    # Define HAVE_LLVM macro with the major/minor version number (e.g., 0x0206 for 2.6)
242    llvm_version_major = int(llvm_version.version[0])
243    llvm_version_minor = int(llvm_version.version[1])
244    llvm_version_hex = '0x%02x%02x' % (llvm_version_major, llvm_version_minor)
245    env.Prepend(CPPDEFINES = [('HAVE_LLVM', llvm_version_hex)])
246
247def exists(env):
248    return True
249
250# vim:set ts=4 sw=4 et:
251