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 irreader`
 107         if llvm_version >= distutils.version.LooseVersion('5.0'):
 108             env.Prepend(LIBS = [
 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',
 121                 'LLVMSupport',
 122                 'LLVMIRReader', 'LLVMAsmParser',
 123                 'LLVMDemangle', 'LLVMGlobalISel', 'LLVMDebugInfoMSF',
 124                 'LLVMBinaryFormat',
 125             ])
 126             if env['platform'] == 'windows' and env['crosscompile']:
 127                 # LLVM 5.0 requires MinGW w/ pthreads due to use of std::thread and friends.
 128                 assert env['gcc']
 129                 env['CXX'] = env['CXX'] + '-posix'
 130         elif llvm_version >= distutils.version.LooseVersion('4.0'):
 131             env.Prepend(LIBS = [
 132                 'LLVMX86Disassembler', 'LLVMX86AsmParser',
 133                 'LLVMX86CodeGen', 'LLVMSelectionDAG', 'LLVMAsmPrinter',
 134                 'LLVMDebugInfoCodeView', 'LLVMCodeGen',
 135                 'LLVMScalarOpts', 'LLVMInstCombine',
 136                 'LLVMTransformUtils',
 137                 'LLVMBitWriter', 'LLVMX86Desc',
 138                 'LLVMMCDisassembler', 'LLVMX86Info',
 139                 'LLVMX86AsmPrinter', 'LLVMX86Utils',
 140                 'LLVMMCJIT', 'LLVMExecutionEngine', 'LLVMTarget',
 141                 'LLVMAnalysis', 'LLVMProfileData',
 142                 'LLVMRuntimeDyld', 'LLVMObject', 'LLVMMCParser',
 143                 'LLVMBitReader', 'LLVMMC', 'LLVMCore',
 144                 'LLVMSupport',
 145                 'LLVMIRReader', 'LLVMAsmParser',
 146                 'LLVMDemangle', 'LLVMGlobalISel', 'LLVMDebugInfoMSF',
 147             ])
 148         elif llvm_version >= distutils.version.LooseVersion('3.9'):
 149             env.Prepend(LIBS = [
 150                 'LLVMX86Disassembler', 'LLVMX86AsmParser',
 151                 'LLVMX86CodeGen', 'LLVMSelectionDAG', 'LLVMAsmPrinter',
 152                 'LLVMDebugInfoCodeView', 'LLVMCodeGen',
 153                 'LLVMScalarOpts', 'LLVMInstCombine',
 154                 'LLVMInstrumentation', 'LLVMTransformUtils',
 155                 'LLVMBitWriter', 'LLVMX86Desc',
 156                 'LLVMMCDisassembler', 'LLVMX86Info',
 157                 'LLVMX86AsmPrinter', 'LLVMX86Utils',
 158                 'LLVMMCJIT', 'LLVMExecutionEngine', 'LLVMTarget',
 159                 'LLVMAnalysis', 'LLVMProfileData',
 160                 'LLVMRuntimeDyld', 'LLVMObject', 'LLVMMCParser',
 161                 'LLVMBitReader', 'LLVMMC', 'LLVMCore',
 162                 'LLVMSupport',
 163                 'LLVMIRReader', 'LLVMASMParser'
 164             ])
 165         elif llvm_version >= distutils.version.LooseVersion('3.7'):
 166             env.Prepend(LIBS = [
 167                 'LLVMBitWriter', 'LLVMX86Disassembler', 'LLVMX86AsmParser',
 168                 'LLVMX86CodeGen', 'LLVMSelectionDAG', 'LLVMAsmPrinter',
 169                 'LLVMCodeGen', 'LLVMScalarOpts', 'LLVMProfileData',
 170                 'LLVMInstCombine', 'LLVMInstrumentation', 'LLVMTransformUtils', 'LLVMipa',
 171                 'LLVMAnalysis', 'LLVMX86Desc', 'LLVMMCDisassembler',
 172                 'LLVMX86Info', 'LLVMX86AsmPrinter', 'LLVMX86Utils',
 173                 'LLVMMCJIT', 'LLVMTarget', 'LLVMExecutionEngine',
 174                 'LLVMRuntimeDyld', 'LLVMObject', 'LLVMMCParser',
 175                 'LLVMBitReader', 'LLVMMC', 'LLVMCore', 'LLVMSupport'
 176             ])
 177         elif llvm_version >= distutils.version.LooseVersion('3.6'):
 178             env.Prepend(LIBS = [
 179                 'LLVMBitWriter', 'LLVMX86Disassembler', 'LLVMX86AsmParser',
 180                 'LLVMX86CodeGen', 'LLVMSelectionDAG', 'LLVMAsmPrinter',
 181                 'LLVMCodeGen', 'LLVMScalarOpts', 'LLVMProfileData',
 182                 'LLVMInstCombine', 'LLVMTransformUtils', 'LLVMipa',
 183                 'LLVMAnalysis', 'LLVMX86Desc', 'LLVMMCDisassembler',
 184                 'LLVMX86Info', 'LLVMX86AsmPrinter', 'LLVMX86Utils',
 185                 'LLVMMCJIT', 'LLVMTarget', 'LLVMExecutionEngine',
 186                 'LLVMRuntimeDyld', 'LLVMObject', 'LLVMMCParser',
 187                 'LLVMBitReader', 'LLVMMC', 'LLVMCore', 'LLVMSupport'
 188             ])
 189         elif llvm_version >= distutils.version.LooseVersion('3.5'):
 190             env.Prepend(LIBS = [
 191                 'LLVMMCDisassembler',
 192                 'LLVMBitWriter', 'LLVMMCJIT', 'LLVMRuntimeDyld',
 193                 'LLVMX86Disassembler', 'LLVMX86AsmParser', 'LLVMX86CodeGen',
 194                 'LLVMSelectionDAG', 'LLVMAsmPrinter', 'LLVMX86Desc',
 195                 'LLVMObject', 'LLVMMCParser', 'LLVMBitReader', 'LLVMX86Info',
 196                 'LLVMX86AsmPrinter', 'LLVMX86Utils', 'LLVMJIT',
 197                 'LLVMExecutionEngine', 'LLVMCodeGen', 'LLVMScalarOpts',
 198                 'LLVMInstCombine', 'LLVMTransformUtils', 'LLVMipa',
 199                 'LLVMAnalysis', 'LLVMTarget', 'LLVMMC', 'LLVMCore',
 200                 'LLVMSupport'
 201             ])
 202         else:
 203             env.Prepend(LIBS = [
 204                 'LLVMMCDisassembler',
 205                 'LLVMBitWriter', 'LLVMX86Disassembler', 'LLVMX86AsmParser',
 206                 'LLVMX86CodeGen', 'LLVMX86Desc', 'LLVMSelectionDAG',
 207                 'LLVMAsmPrinter', 'LLVMMCParser', 'LLVMX86AsmPrinter',
 208                 'LLVMX86Utils', 'LLVMX86Info', 'LLVMMCJIT', 'LLVMJIT',
 209                 'LLVMExecutionEngine', 'LLVMCodeGen', 'LLVMScalarOpts',
 210                 'LLVMInstCombine', 'LLVMTransformUtils', 'LLVMipa',
 211                 'LLVMAnalysis', 'LLVMTarget', 'LLVMMC', 'LLVMCore',
 212                 'LLVMSupport', 'LLVMRuntimeDyld', 'LLVMObject'
 213             ])
 214         env.Append(LIBS = [
 215             'imagehlp',
 216             'psapi',
 217             'shell32',
 218             'advapi32',
 219             'ole32',
 220             'uuid',
 221         ])
 222
 223         if env['msvc']:
 224             # Some of the LLVM C headers use the inline keyword without
 225             # defining it.
 226             env.Append(CPPDEFINES = [('inline', '__inline')])
 227             # Match some of the warning options from llvm/cmake/modules/HandleLLVMOptions.cmake
 228             env.AppendUnique(CXXFLAGS = [
 229                 '/wd4355', # 'this' : used in base member initializer list
 230                 '/wd4624', # 'derived class' : destructor could not be generated because a base class destructor is inaccessible
 231             ])
 232             if env['build'] in ('debug', 'checked'):
 233                 # LLVM libraries are static, build with /MT, and they
 234                 # automatically link agains LIBCMT. When we're doing a
 235                 # debug build we'll be linking against LIBCMTD, so disable
 236                 # that.
 237                 env.Append(LINKFLAGS = ['/nodefaultlib:LIBCMT'])
 238     else:
 239         llvm_config = os.environ.get('LLVM_CONFIG', 'llvm-config')
 240         if not env.Detect(llvm_config):
 241             print('scons: %s script not found' % llvm_config)
 242             return
 243
 244         llvm_version = env.backtick('%s --version' % llvm_config).rstrip()
 245         llvm_version = distutils.version.LooseVersion(llvm_version)
 246
 247         if llvm_version < distutils.version.LooseVersion(required_llvm_version):
 248             print('scons: LLVM version %s found, but %s is required' % (llvm_version, required_llvm_version))
 249             return
 250
 251         try:
 252             # Treat --cppflags specially to prevent NDEBUG from disabling
 253             # assertion failures in debug builds.
 254             cppflags = env.ParseFlags('!%s --cppflags' % llvm_config)
 255             try:
 256                 cppflags['CPPDEFINES'].remove('NDEBUG')
 257             except ValueError:
 258                 pass
 259             env.MergeFlags(cppflags)
 260
 261             # Match llvm --fno-rtti flag
 262             cxxflags = env.backtick('%s --cxxflags' % llvm_config).split()
 263             if '-fno-rtti' in cxxflags:
 264                 env.Append(CXXFLAGS = ['-fno-rtti'])
 265
 266             components = ['engine', 'mcjit', 'bitwriter', 'x86asmprinter', 'mcdisassembler', 'irreader']
 267
 268             env.ParseConfig('%s --libs ' % llvm_config + ' '.join(components))
 269             env.ParseConfig('%s --ldflags' % llvm_config)
 270             if llvm_version >= distutils.version.LooseVersion('3.5'):
 271                 env.ParseConfig('%s --system-libs' % llvm_config)
 272                 env.Append(CXXFLAGS = ['-std=c++11'])
 273         except OSError:
 274             print('scons: llvm-config version %s failed' % llvm_version)
 275             return
 276
 277     assert llvm_version is not None
 278     env['llvm'] = True
 279
 280     print('scons: Found LLVM version %s' % llvm_version)
 281     env['LLVM_VERSION'] = llvm_version
 282
 283     # Define HAVE_LLVM macro with the major/minor version number (e.g., 0x0206 for 2.6)
 284     llvm_version_major = int(llvm_version.version[0])
 285     llvm_version_minor = int(llvm_version.version[1])
 286     llvm_version_hex = '0x%02x%02x' % (llvm_version_major, llvm_version_minor)
 287     env.Prepend(CPPDEFINES = [('HAVE_LLVM', llvm_version_hex)])
 288
 289 def exists(env):
 290     return True
 291
 292 # vim:set ts=4 sw=4 et: