scons/llvm.py

   1 """llvm
   2
   3 Tool-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
  30 import os
  31 import os.path
  32 import re
  33 import sys
  34 import distutils.version
  35
  36 import SCons.Errors
  37 import SCons.Util
  38
  39
  40 required_llvm_version = '3.3'
  41
  42
  43 def 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             'HAVE_STDINT_H',
 104         ])
 105         env.Prepend(LIBPATH = [os.path.join(llvm_dir, 'lib')])
 106         # LIBS should match the output of `llvm-config --libs engine mcjit bitwriter x86asmprinter`
 107         if llvm_version >= distutils.version.LooseVersion('3.9'):
 108             env.Prepend(LIBS = [
 109                 'LLVMX86Disassembler', 'LLVMX86AsmParser',
 110                 'LLVMX86CodeGen', 'LLVMSelectionDAG', 'LLVMAsmPrinter',
 111                 'LLVMDebugInfoCodeView', 'LLVMCodeGen',
 112                 'LLVMScalarOpts', 'LLVMInstCombine',
 113                 'LLVMInstrumentation', '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',
 121                 'LLVMSupport',
 122                 'LLVMIRReader', 'LLVMASMParser'
 123             ])
 124         elif llvm_version >= distutils.version.LooseVersion('3.7'):
 125             env.Prepend(LIBS = [
 126                 'LLVMBitWriter', 'LLVMX86Disassembler', 'LLVMX86AsmParser',
 127                 'LLVMX86CodeGen', 'LLVMSelectionDAG', 'LLVMAsmPrinter',
 128                 'LLVMCodeGen', 'LLVMScalarOpts', 'LLVMProfileData',
 129                 'LLVMInstCombine', 'LLVMInstrumentation', 'LLVMTransformUtils', 'LLVMipa',
 130                 'LLVMAnalysis', 'LLVMX86Desc', 'LLVMMCDisassembler',
 131                 'LLVMX86Info', 'LLVMX86AsmPrinter', 'LLVMX86Utils',
 132                 'LLVMMCJIT', 'LLVMTarget', 'LLVMExecutionEngine',
 133                 'LLVMRuntimeDyld', 'LLVMObject', 'LLVMMCParser',
 134                 'LLVMBitReader', 'LLVMMC', 'LLVMCore', 'LLVMSupport'
 135             ])
 136         elif llvm_version >= distutils.version.LooseVersion('3.6'):
 137             env.Prepend(LIBS = [
 138                 'LLVMBitWriter', 'LLVMX86Disassembler', 'LLVMX86AsmParser',
 139                 'LLVMX86CodeGen', 'LLVMSelectionDAG', 'LLVMAsmPrinter',
 140                 'LLVMCodeGen', 'LLVMScalarOpts', 'LLVMProfileData',
 141                 'LLVMInstCombine', 'LLVMTransformUtils', 'LLVMipa',
 142                 'LLVMAnalysis', 'LLVMX86Desc', 'LLVMMCDisassembler',
 143                 'LLVMX86Info', 'LLVMX86AsmPrinter', 'LLVMX86Utils',
 144                 'LLVMMCJIT', 'LLVMTarget', 'LLVMExecutionEngine',
 145                 'LLVMRuntimeDyld', 'LLVMObject', 'LLVMMCParser',
 146                 'LLVMBitReader', 'LLVMMC', 'LLVMCore', 'LLVMSupport'
 147             ])
 148         elif llvm_version >= distutils.version.LooseVersion('3.5'):
 149             env.Prepend(LIBS = [
 150                 'LLVMMCDisassembler',
 151                 'LLVMBitWriter', 'LLVMMCJIT', 'LLVMRuntimeDyld',
 152                 'LLVMX86Disassembler', 'LLVMX86AsmParser', 'LLVMX86CodeGen',
 153                 'LLVMSelectionDAG', 'LLVMAsmPrinter', 'LLVMX86Desc',
 154                 'LLVMObject', 'LLVMMCParser', 'LLVMBitReader', 'LLVMX86Info',
 155                 'LLVMX86AsmPrinter', 'LLVMX86Utils', 'LLVMJIT',
 156                 'LLVMExecutionEngine', 'LLVMCodeGen', 'LLVMScalarOpts',
 157                 'LLVMInstCombine', 'LLVMTransformUtils', 'LLVMipa',
 158                 'LLVMAnalysis', 'LLVMTarget', 'LLVMMC', 'LLVMCore',
 159                 'LLVMSupport'
 160             ])
 161         else:
 162             env.Prepend(LIBS = [
 163                 'LLVMMCDisassembler',
 164                 'LLVMBitWriter', 'LLVMX86Disassembler', 'LLVMX86AsmParser',
 165                 'LLVMX86CodeGen', 'LLVMX86Desc', 'LLVMSelectionDAG',
 166                 'LLVMAsmPrinter', 'LLVMMCParser', 'LLVMX86AsmPrinter',
 167                 'LLVMX86Utils', 'LLVMX86Info', 'LLVMMCJIT', 'LLVMJIT',
 168                 'LLVMExecutionEngine', 'LLVMCodeGen', 'LLVMScalarOpts',
 169                 'LLVMInstCombine', 'LLVMTransformUtils', 'LLVMipa',
 170                 'LLVMAnalysis', 'LLVMTarget', 'LLVMMC', 'LLVMCore',
 171                 'LLVMSupport', 'LLVMRuntimeDyld', 'LLVMObject'
 172             ])
 173         env.Append(LIBS = [
 174             'imagehlp',
 175             'psapi',
 176             'shell32',
 177             'advapi32'
 178         ])
 179         if env['msvc']:
 180             # Some of the LLVM C headers use the inline keyword without
 181             # defining it.
 182             env.Append(CPPDEFINES = [('inline', '__inline')])
 183             # Match some of the warning options from llvm/cmake/modules/HandleLLVMOptions.cmake
 184             env.AppendUnique(CXXFLAGS = [
 185                 '/wd4355', # 'this' : used in base member initializer list
 186                 '/wd4624', # 'derived class' : destructor could not be generated because a base class destructor is inaccessible
 187             ])
 188             if env['build'] in ('debug', 'checked'):
 189                 # LLVM libraries are static, build with /MT, and they
 190                 # automatically link agains LIBCMT. When we're doing a
 191                 # debug build we'll be linking against LIBCMTD, so disable
 192                 # that.
 193                 env.Append(LINKFLAGS = ['/nodefaultlib:LIBCMT'])
 194     else:
 195         llvm_config = os.environ.get('LLVM_CONFIG', 'llvm-config')
 196         if not env.Detect(llvm_config):
 197             print 'scons: %s script not found' % llvm_config
 198             return
 199
 200         llvm_version = env.backtick('%s --version' % llvm_config).rstrip()
 201         llvm_version = distutils.version.LooseVersion(llvm_version)
 202
 203         if llvm_version < distutils.version.LooseVersion(required_llvm_version):
 204             print 'scons: LLVM version %s found, but %s is required' % (llvm_version, required_llvm_version)
 205             return
 206
 207         try:
 208             # Treat --cppflags specially to prevent NDEBUG from disabling
 209             # assertion failures in debug builds.
 210             cppflags = env.ParseFlags('!%s --cppflags' % llvm_config)
 211             try:
 212                 cppflags['CPPDEFINES'].remove('NDEBUG')
 213             except ValueError:
 214                 pass
 215             env.MergeFlags(cppflags)
 216
 217             # Match llvm --fno-rtti flag
 218             cxxflags = env.backtick('%s --cxxflags' % llvm_config).split()
 219             if '-fno-rtti' in cxxflags:
 220                 env.Append(CXXFLAGS = ['-fno-rtti'])
 221
 222             components = ['engine', 'mcjit', 'bitwriter', 'x86asmprinter', 'mcdisassembler', 'irreader']
 223
 224             env.ParseConfig('%s --libs ' % llvm_config + ' '.join(components))
 225             env.ParseConfig('%s --ldflags' % llvm_config)
 226             if llvm_version >= distutils.version.LooseVersion('3.5'):
 227                 env.ParseConfig('%s --system-libs' % llvm_config)
 228                 env.Append(CXXFLAGS = ['-std=c++11'])
 229         except OSError:
 230             print 'scons: llvm-config version %s failed' % llvm_version
 231             return
 232
 233     assert llvm_version is not None
 234     env['llvm'] = True
 235
 236     print 'scons: Found LLVM version %s' % llvm_version
 237     env['LLVM_VERSION'] = llvm_version
 238
 239     # Define HAVE_LLVM macro with the major/minor version number (e.g., 0x0206 for 2.6)
 240     llvm_version_major = int(llvm_version.version[0])
 241     llvm_version_minor = int(llvm_version.version[1])
 242     llvm_version_hex = '0x%02x%02x' % (llvm_version_major, llvm_version_minor)
 243     env.Prepend(CPPDEFINES = [('HAVE_LLVM', llvm_version_hex)])
 244
 245 def exists(env):
 246     return True
 247
 248 # vim:set ts=4 sw=4 et: