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