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 coroutines` for LLVM>=8.0
 112         # LLVMAggressiveInstCombine library part of engine component since LLVM 6 is only needed by Mesa3D for LLVM>=8.
 113         # While not directly needed by Mesa3D, this library is needed by LLVMipo which is part of coroutines component.
 114         if llvm_version >= distutils.version.LooseVersion('10.0'):
 115             env.Prepend(LIBS = [
 116                 'LLVMX86Disassembler', 'LLVMX86AsmParser',
 117                 'LLVMX86CodeGen', 'LLVMSelectionDAG', 'LLVMAsmPrinter',
 118                 'LLVMDebugInfoCodeView', 'LLVMCodeGen',
 119                 'LLVMScalarOpts', 'LLVMInstCombine',
 120                 'LLVMTransformUtils',
 121                 'LLVMBitWriter', 'LLVMX86Desc',
 122                 'LLVMMCDisassembler', 'LLVMX86Info',
 123                 'LLVMX86Utils',
 124                 'LLVMMCJIT', 'LLVMExecutionEngine', 'LLVMTarget',
 125                 'LLVMAnalysis', 'LLVMProfileData',
 126                 'LLVMRuntimeDyld', 'LLVMObject', 'LLVMMCParser',
 127                 'LLVMBitReader', 'LLVMMC', 'LLVMCore',
 128                 'LLVMSupport',
 129                 'LLVMIRReader', 'LLVMAsmParser',
 130                 'LLVMDemangle', 'LLVMGlobalISel', 'LLVMDebugInfoMSF',
 131                 'LLVMBinaryFormat',
 132                 'LLVMRemarks', 'LLVMBitstreamReader', 'LLVMDebugInfoDWARF',
 133                 'LLVMAggressiveInstCombine','LLVMLinker', 'LLVMVectorize',
 134                 'LLVMInstrumentation', 'LLVMipo', 'LLVMCoroutines',
 135                 'LLVMCFGuard', 'LLVMTextAPI',
 136             ])
 137         elif llvm_version >= distutils.version.LooseVersion('9.0'):
 138             env.Prepend(LIBS = [
 139                 'LLVMX86Disassembler', 'LLVMX86AsmParser',
 140                 'LLVMX86CodeGen', 'LLVMSelectionDAG', 'LLVMAsmPrinter',
 141                 'LLVMDebugInfoCodeView', 'LLVMCodeGen',
 142                 'LLVMScalarOpts', 'LLVMInstCombine',
 143                 'LLVMTransformUtils',
 144                 'LLVMBitWriter', 'LLVMX86Desc',
 145                 'LLVMMCDisassembler', 'LLVMX86Info',
 146                 'LLVMX86Utils',
 147                 'LLVMMCJIT', 'LLVMExecutionEngine', 'LLVMTarget',
 148                 'LLVMAnalysis', 'LLVMProfileData',
 149                 'LLVMRuntimeDyld', 'LLVMObject', 'LLVMMCParser',
 150                 'LLVMBitReader', 'LLVMMC', 'LLVMCore',
 151                 'LLVMSupport',
 152                 'LLVMIRReader', 'LLVMAsmParser',
 153                 'LLVMDemangle', 'LLVMGlobalISel', 'LLVMDebugInfoMSF',
 154                 'LLVMBinaryFormat',
 155                 'LLVMRemarks', 'LLVMBitstreamReader', 'LLVMDebugInfoDWARF',
 156                 # Add these libraries to enable ompute shaders support.
 157                 'LLVMAggressiveInstCombine','LLVMLinker', 'LLVMVectorize',
 158                 'LLVMInstrumentation', 'LLVMipo', 'LLVMCoroutines',
 159             ])
 160         elif llvm_version >= distutils.version.LooseVersion('8.0'):
 161             env.Prepend(LIBS = [
 162                 'LLVMX86Disassembler', 'LLVMX86AsmParser',
 163                 'LLVMX86CodeGen', 'LLVMSelectionDAG', 'LLVMAsmPrinter',
 164                 'LLVMDebugInfoCodeView', 'LLVMCodeGen',
 165                 'LLVMScalarOpts', 'LLVMInstCombine',
 166                 'LLVMTransformUtils',
 167                 'LLVMBitWriter', 'LLVMX86Desc',
 168                 'LLVMMCDisassembler', 'LLVMX86Info',
 169                 'LLVMX86AsmPrinter', 'LLVMX86Utils',
 170                 'LLVMMCJIT', 'LLVMExecutionEngine', 'LLVMTarget',
 171                 'LLVMAnalysis', 'LLVMProfileData',
 172                 'LLVMRuntimeDyld', 'LLVMObject', 'LLVMMCParser',
 173                 'LLVMBitReader', 'LLVMMC', 'LLVMCore',
 174                 'LLVMSupport',
 175                 'LLVMIRReader', 'LLVMAsmParser',
 176                 'LLVMDemangle', 'LLVMGlobalISel', 'LLVMDebugInfoMSF',
 177                 'LLVMBinaryFormat',
 178                 # Add these libraries to enable ompute shaders support.
 179                 'LLVMAggressiveInstCombine', 'LLVMLinker', 'LLVMVectorize',
 180                 'LLVMInstrumentation', 'LLVMipo', 'LLVMCoroutines',
 181             ])
 182         elif llvm_version >= distutils.version.LooseVersion('5.0'):
 183             env.Prepend(LIBS = [
 184                 'LLVMX86Disassembler', 'LLVMX86AsmParser',
 185                 'LLVMX86CodeGen', 'LLVMSelectionDAG', 'LLVMAsmPrinter',
 186                 'LLVMDebugInfoCodeView', 'LLVMCodeGen',
 187                 'LLVMScalarOpts', 'LLVMInstCombine',
 188                 'LLVMTransformUtils',
 189                 'LLVMBitWriter', 'LLVMX86Desc',
 190                 'LLVMMCDisassembler', 'LLVMX86Info',
 191                 'LLVMX86AsmPrinter', 'LLVMX86Utils',
 192                 'LLVMMCJIT', 'LLVMExecutionEngine', 'LLVMTarget',
 193                 'LLVMAnalysis', 'LLVMProfileData',
 194                 'LLVMRuntimeDyld', 'LLVMObject', 'LLVMMCParser',
 195                 'LLVMBitReader', 'LLVMMC', 'LLVMCore',
 196                 'LLVMSupport',
 197                 'LLVMIRReader', 'LLVMAsmParser',
 198                 'LLVMDemangle', 'LLVMGlobalISel', 'LLVMDebugInfoMSF',
 199                 'LLVMBinaryFormat',
 200             ])
 201         elif llvm_version >= distutils.version.LooseVersion('4.0'):
 202             env.Prepend(LIBS = [
 203                 'LLVMX86Disassembler', 'LLVMX86AsmParser',
 204                 'LLVMX86CodeGen', 'LLVMSelectionDAG', 'LLVMAsmPrinter',
 205                 'LLVMDebugInfoCodeView', 'LLVMCodeGen',
 206                 'LLVMScalarOpts', 'LLVMInstCombine',
 207                 'LLVMTransformUtils',
 208                 'LLVMBitWriter', 'LLVMX86Desc',
 209                 'LLVMMCDisassembler', 'LLVMX86Info',
 210                 'LLVMX86AsmPrinter', 'LLVMX86Utils',
 211                 'LLVMMCJIT', 'LLVMExecutionEngine', 'LLVMTarget',
 212                 'LLVMAnalysis', 'LLVMProfileData',
 213                 'LLVMRuntimeDyld', 'LLVMObject', 'LLVMMCParser',
 214                 'LLVMBitReader', 'LLVMMC', 'LLVMCore',
 215                 'LLVMSupport',
 216                 'LLVMIRReader', 'LLVMAsmParser',
 217                 'LLVMDemangle', 'LLVMGlobalISel', 'LLVMDebugInfoMSF',
 218             ])
 219         else:
 220             env.Prepend(LIBS = [
 221                 'LLVMX86Disassembler', 'LLVMX86AsmParser',
 222                 'LLVMX86CodeGen', 'LLVMSelectionDAG', 'LLVMAsmPrinter',
 223                 'LLVMDebugInfoCodeView', 'LLVMCodeGen',
 224                 'LLVMScalarOpts', 'LLVMInstCombine',
 225                 'LLVMInstrumentation', 'LLVMTransformUtils',
 226                 'LLVMBitWriter', 'LLVMX86Desc',
 227                 'LLVMMCDisassembler', 'LLVMX86Info',
 228                 'LLVMX86AsmPrinter', 'LLVMX86Utils',
 229                 'LLVMMCJIT', 'LLVMExecutionEngine', 'LLVMTarget',
 230                 'LLVMAnalysis', 'LLVMProfileData',
 231                 'LLVMRuntimeDyld', 'LLVMObject', 'LLVMMCParser',
 232                 'LLVMBitReader', 'LLVMMC', 'LLVMCore',
 233                 'LLVMSupport',
 234                 'LLVMIRReader', 'LLVMASMParser'
 235             ])
 236         env.Append(LIBS = [
 237             'imagehlp',
 238             'psapi',
 239             'shell32',
 240             'advapi32',
 241             'ole32',
 242             'uuid',
 243         ])
 244
 245         # Mingw-w64 zlib is required when building with LLVM support in MSYS2 environment
 246         if host_platform.system().lower().startswith('mingw'):
 247             env.Append(LIBS = [
 248                  'z',
 249             ])
 250
 251         if env['msvc']:
 252             # Some of the LLVM C headers use the inline keyword without
 253             # defining it.
 254             env.Append(CPPDEFINES = [('inline', '__inline')])
 255             # Match some of the warning options from llvm/cmake/modules/HandleLLVMOptions.cmake
 256             env.AppendUnique(CXXFLAGS = [
 257                 '/wd4355', # 'this' : used in base member initializer list
 258                 '/wd4624', # 'derived class' : destructor could not be generated because a base class destructor is inaccessible
 259             ])
 260             if env['build'] in ('debug', 'checked'):
 261                 # LLVM libraries are static, build with /MT, and they
 262                 # automatically link agains LIBCMT. When we're doing a
 263                 # debug build we'll be linking against LIBCMTD, so disable
 264                 # that.
 265                 env.Append(LINKFLAGS = ['/nodefaultlib:LIBCMT'])
 266     else:
 267         llvm_config = os.environ.get('LLVM_CONFIG', 'llvm-config')
 268         if not env.Detect(llvm_config):
 269             print('scons: %s script not found' % llvm_config)
 270             return
 271
 272         llvm_version = env.backtick('%s --version' % llvm_config).rstrip()
 273         llvm_version = distutils.version.LooseVersion(llvm_version)
 274
 275         if llvm_version < distutils.version.LooseVersion(required_llvm_version):
 276             print('scons: LLVM version %s found, but %s is required' % (llvm_version, required_llvm_version))
 277             return
 278
 279         try:
 280             # Treat --cppflags specially to prevent NDEBUG from disabling
 281             # assertion failures in debug builds.
 282             cppflags = env.ParseFlags('!%s --cppflags' % llvm_config)
 283             try:
 284                 cppflags['CPPDEFINES'].remove('NDEBUG')
 285             except ValueError:
 286                 pass
 287             env.MergeFlags(cppflags)
 288
 289             # Match llvm --fno-rtti flag
 290             cxxflags = env.backtick('%s --cxxflags' % llvm_config).split()
 291             if '-fno-rtti' in cxxflags:
 292                 env.Append(CXXFLAGS = ['-fno-rtti'])
 293
 294             if llvm_version < distutils.version.LooseVersion('9.0'):
 295                components = ['engine', 'mcjit', 'bitwriter', 'x86asmprinter', 'mcdisassembler', 'irreader']
 296             else:
 297                components = ['engine', 'mcjit', 'bitwriter', 'mcdisassembler', 'irreader']
 298
 299             if llvm_version >= distutils.version.LooseVersion('8.0'):
 300                 components.append('coroutines')
 301
 302             env.ParseConfig('%s --libs ' % llvm_config + ' '.join(components))
 303             env.ParseConfig('%s --ldflags' % llvm_config)
 304             env.ParseConfig('%s --system-libs' % llvm_config)
 305             env.Append(CXXFLAGS = ['-std=c++14'])
 306         except OSError:
 307             print('scons: llvm-config version %s failed' % llvm_version)
 308             return
 309
 310     assert llvm_version is not None
 311     env['llvm'] = True
 312
 313     print('scons: Found LLVM version %s' % llvm_version)
 314     env['LLVM_VERSION'] = llvm_version
 315
 316     # Define LLVM_AVAILABLE macro to guard code blocks, and MESA_LLVM_VERSION_STRING
 317     env.Prepend(CPPDEFINES = [('LLVM_AVAILABLE', 1)])
 318     env.Prepend(CPPDEFINES = [('MESA_LLVM_VERSION_STRING=\\"%s\\"' % llvm_version)])
 319
 320 def exists(env):
 321     return True
 322
 323 # vim:set ts=4 sw=4 et: