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 platform as host_platform
  34 import sys
  35 import distutils.version
  36
  37 import SCons.Errors
  38 import SCons.Util
  39
  40
  41 required_llvm_version = '3.9'
  42
  43
  44 def generate(env):
  45     env['llvm'] = False
  46
  47     try:
  48         llvm_dir = os.environ['LLVM']
  49     except KeyError:
  50         # Do nothing -- use the system headers/libs
  51         llvm_dir = None
  52     else:
  53         if not os.path.isdir(llvm_dir):
  54             raise SCons.Errors.InternalError("Specified LLVM directory not found")
  55
  56         if env['debug']:
  57             llvm_subdir = 'Debug'
  58         else:
  59             llvm_subdir = 'Release'
  60
  61         llvm_bin_dir = os.path.join(llvm_dir, llvm_subdir, 'bin')
  62         if not os.path.isdir(llvm_bin_dir):
  63             llvm_bin_dir = os.path.join(llvm_dir, 'bin')
  64             if not os.path.isdir(llvm_bin_dir):
  65                 raise SCons.Errors.InternalError("LLVM binary directory not found")
  66
  67         env.PrependENVPath('PATH', llvm_bin_dir)
  68
  69     if env['platform'] == 'windows':
  70         # XXX: There is no llvm-config on Windows, so assume a standard layout
  71         if llvm_dir is None:
  72             print('scons: LLVM environment variable must be specified when building for windows')
  73             return
  74
  75         # Try to determine the LLVM version from llvm/Config/config.h
  76         llvm_config = os.path.join(llvm_dir, 'include/llvm/Config/llvm-config.h')
  77         if not os.path.exists(llvm_config):
  78             print('scons: could not find %s' % llvm_config)
  79             return
  80         llvm_version_major_re = re.compile(r'^#define LLVM_VERSION_MAJOR ([0-9]+)')
  81         llvm_version_minor_re = re.compile(r'^#define LLVM_VERSION_MINOR ([0-9]+)')
  82         llvm_version = None
  83         llvm_version_major = None
  84         llvm_version_minor = None
  85         for line in open(llvm_config, 'rt'):
  86             mo = llvm_version_major_re.match(line)
  87             if mo:
  88                 llvm_version_major = mo.group(1)
  89             mo = llvm_version_minor_re.match(line)
  90             if mo:
  91                 llvm_version_minor = mo.group(1)
  92         if llvm_version_major is not None and llvm_version_minor is not None:
  93             llvm_version = distutils.version.LooseVersion('%s.%s' % (llvm_version_major, llvm_version_minor))
  94
  95         if llvm_version is None:
  96             print('scons: could not determine the LLVM version from %s' % llvm_config)
  97             return
  98         if llvm_version < distutils.version.LooseVersion(required_llvm_version):
  99             print('scons: LLVM version %s found, but %s is required' % (llvm_version, required_llvm_version))
 100             return
 101
 102         env.Prepend(CPPPATH = [os.path.join(llvm_dir, 'include')])
 103         env.Prepend(LIBPATH = [os.path.join(llvm_dir, 'lib')])
 104
 105         # LLVM 5.0 and newer requires MinGW w/ pthreads due to use of std::thread and friends.
 106         if llvm_version >= distutils.version.LooseVersion('5.0') and env['crosscompile']:
 107             assert env['gcc']
 108             env.AppendUnique(CXXFLAGS = ['-posix'])
 109
 110         # LIBS should match the output of `llvm-config --libs engine mcjit bitwriter x86asmprinter irreader` for LLVM<=7.0
 111         # and `llvm-config --libs engine irreader` for LLVM>=8.0
 112         # LLVMAggressiveInstCombine library part of engine component can be safely omitted as it's not used.
 113         if llvm_version >= distutils.version.LooseVersion('9.0'):
 114             env.Prepend(LIBS = [
 115                 'LLVMX86Disassembler', 'LLVMX86AsmParser',
 116                 'LLVMX86CodeGen', 'LLVMSelectionDAG', 'LLVMAsmPrinter',
 117                 'LLVMDebugInfoCodeView', 'LLVMCodeGen',
 118                 'LLVMScalarOpts', 'LLVMInstCombine',
 119                 'LLVMTransformUtils',
 120                 'LLVMBitWriter', 'LLVMX86Desc',
 121                 'LLVMMCDisassembler', 'LLVMX86Info',
 122                 'LLVMX86Utils',
 123                 'LLVMMCJIT', 'LLVMExecutionEngine', 'LLVMTarget',
 124                 'LLVMAnalysis', 'LLVMProfileData',
 125                 'LLVMRuntimeDyld', 'LLVMObject', 'LLVMMCParser',
 126                 'LLVMBitReader', 'LLVMMC', 'LLVMCore',
 127                 'LLVMSupport',
 128                 'LLVMIRReader', 'LLVMAsmParser',
 129                 'LLVMDemangle', 'LLVMGlobalISel', 'LLVMDebugInfoMSF',
 130                 'LLVMBinaryFormat',
 131                 'LLVMRemarks', 'LLVMBitstreamReader', 'LLVMDebugInfoDWARF',
 132             ])
 133         elif llvm_version >= distutils.version.LooseVersion('5.0'):
 134             env.Prepend(LIBS = [
 135                 'LLVMX86Disassembler', 'LLVMX86AsmParser',
 136                 'LLVMX86CodeGen', 'LLVMSelectionDAG', 'LLVMAsmPrinter',
 137                 'LLVMDebugInfoCodeView', 'LLVMCodeGen',
 138                 'LLVMScalarOpts', 'LLVMInstCombine',
 139                 'LLVMTransformUtils',
 140                 'LLVMBitWriter', 'LLVMX86Desc',
 141                 'LLVMMCDisassembler', 'LLVMX86Info',
 142                 'LLVMX86AsmPrinter', 'LLVMX86Utils',
 143                 'LLVMMCJIT', 'LLVMExecutionEngine', 'LLVMTarget',
 144                 'LLVMAnalysis', 'LLVMProfileData',
 145                 'LLVMRuntimeDyld', 'LLVMObject', 'LLVMMCParser',
 146                 'LLVMBitReader', 'LLVMMC', 'LLVMCore',
 147                 'LLVMSupport',
 148                 'LLVMIRReader', 'LLVMAsmParser',
 149                 'LLVMDemangle', 'LLVMGlobalISel', 'LLVMDebugInfoMSF',
 150                 'LLVMBinaryFormat',
 151             ])
 152         elif llvm_version >= distutils.version.LooseVersion('4.0'):
 153             env.Prepend(LIBS = [
 154                 'LLVMX86Disassembler', 'LLVMX86AsmParser',
 155                 'LLVMX86CodeGen', 'LLVMSelectionDAG', 'LLVMAsmPrinter',
 156                 'LLVMDebugInfoCodeView', 'LLVMCodeGen',
 157                 'LLVMScalarOpts', 'LLVMInstCombine',
 158                 'LLVMTransformUtils',
 159                 'LLVMBitWriter', 'LLVMX86Desc',
 160                 'LLVMMCDisassembler', 'LLVMX86Info',
 161                 'LLVMX86AsmPrinter', 'LLVMX86Utils',
 162                 'LLVMMCJIT', 'LLVMExecutionEngine', 'LLVMTarget',
 163                 'LLVMAnalysis', 'LLVMProfileData',
 164                 'LLVMRuntimeDyld', 'LLVMObject', 'LLVMMCParser',
 165                 'LLVMBitReader', 'LLVMMC', 'LLVMCore',
 166                 'LLVMSupport',
 167                 'LLVMIRReader', 'LLVMAsmParser',
 168                 'LLVMDemangle', 'LLVMGlobalISel', 'LLVMDebugInfoMSF',
 169             ])
 170         else:
 171             env.Prepend(LIBS = [
 172                 'LLVMX86Disassembler', 'LLVMX86AsmParser',
 173                 'LLVMX86CodeGen', 'LLVMSelectionDAG', 'LLVMAsmPrinter',
 174                 'LLVMDebugInfoCodeView', 'LLVMCodeGen',
 175                 'LLVMScalarOpts', 'LLVMInstCombine',
 176                 'LLVMInstrumentation', 'LLVMTransformUtils',
 177                 'LLVMBitWriter', 'LLVMX86Desc',
 178                 'LLVMMCDisassembler', 'LLVMX86Info',
 179                 'LLVMX86AsmPrinter', 'LLVMX86Utils',
 180                 'LLVMMCJIT', 'LLVMExecutionEngine', 'LLVMTarget',
 181                 'LLVMAnalysis', 'LLVMProfileData',
 182                 'LLVMRuntimeDyld', 'LLVMObject', 'LLVMMCParser',
 183                 'LLVMBitReader', 'LLVMMC', 'LLVMCore',
 184                 'LLVMSupport',
 185                 'LLVMIRReader', 'LLVMASMParser'
 186             ])
 187         env.Append(LIBS = [
 188             'imagehlp',
 189             'psapi',
 190             'shell32',
 191             'advapi32',
 192             'ole32',
 193             'uuid',
 194         ])
 195
 196         # Mingw-w64 zlib is required when building with LLVM support in MSYS2 environment
 197         if host_platform.system().lower().startswith('mingw'):
 198             env.Append(LIBS = [
 199                  'z',
 200             ])
 201
 202         if env['msvc']:
 203             # Some of the LLVM C headers use the inline keyword without
 204             # defining it.
 205             env.Append(CPPDEFINES = [('inline', '__inline')])
 206             # Match some of the warning options from llvm/cmake/modules/HandleLLVMOptions.cmake
 207             env.AppendUnique(CXXFLAGS = [
 208                 '/wd4355', # 'this' : used in base member initializer list
 209                 '/wd4624', # 'derived class' : destructor could not be generated because a base class destructor is inaccessible
 210             ])
 211             if env['build'] in ('debug', 'checked'):
 212                 # LLVM libraries are static, build with /MT, and they
 213                 # automatically link agains LIBCMT. When we're doing a
 214                 # debug build we'll be linking against LIBCMTD, so disable
 215                 # that.
 216                 env.Append(LINKFLAGS = ['/nodefaultlib:LIBCMT'])
 217     else:
 218         llvm_config = os.environ.get('LLVM_CONFIG', 'llvm-config')
 219         if not env.Detect(llvm_config):
 220             print('scons: %s script not found' % llvm_config)
 221             return
 222
 223         llvm_version = env.backtick('%s --version' % llvm_config).rstrip()
 224         llvm_version = distutils.version.LooseVersion(llvm_version)
 225
 226         if llvm_version < distutils.version.LooseVersion(required_llvm_version):
 227             print('scons: LLVM version %s found, but %s is required' % (llvm_version, required_llvm_version))
 228             return
 229
 230         try:
 231             # Treat --cppflags specially to prevent NDEBUG from disabling
 232             # assertion failures in debug builds.
 233             cppflags = env.ParseFlags('!%s --cppflags' % llvm_config)
 234             try:
 235                 cppflags['CPPDEFINES'].remove('NDEBUG')
 236             except ValueError:
 237                 pass
 238             env.MergeFlags(cppflags)
 239
 240             # Match llvm --fno-rtti flag
 241             cxxflags = env.backtick('%s --cxxflags' % llvm_config).split()
 242             if '-fno-rtti' in cxxflags:
 243                 env.Append(CXXFLAGS = ['-fno-rtti'])
 244
 245             if llvm_version < distutils.version.LooseVersion('9.0'):
 246                components = ['engine', 'mcjit', 'bitwriter', 'x86asmprinter', 'mcdisassembler', 'irreader']
 247             else:
 248                components = ['engine', 'mcjit', 'bitwriter', 'mcdisassembler', 'irreader']
 249
 250             if llvm_version >= distutils.version.LooseVersion('8.0'):
 251                 components.append('coroutines')
 252
 253             env.ParseConfig('%s --libs ' % llvm_config + ' '.join(components))
 254             env.ParseConfig('%s --ldflags' % llvm_config)
 255             env.ParseConfig('%s --system-libs' % llvm_config)
 256             env.Append(CXXFLAGS = ['-std=c++14'])
 257         except OSError:
 258             print('scons: llvm-config version %s failed' % llvm_version)
 259             return
 260
 261     assert llvm_version is not None
 262     env['llvm'] = True
 263
 264     print('scons: Found LLVM version %s' % llvm_version)
 265     env['LLVM_VERSION'] = llvm_version
 266
 267     # Define LLVM_AVAILABLE macro to guard code blocks, and MESA_LLVM_VERSION_STRING
 268     env.Prepend(CPPDEFINES = [('LLVM_AVAILABLE', 1)])
 269     env.Prepend(CPPDEFINES = [('MESA_LLVM_VERSION_STRING=\\"%s\\"' % llvm_version)])
 270
 271 def exists(env):
 272     return True
 273
 274 # vim:set ts=4 sw=4 et: