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 def generate(env):
  41     env['llvm'] = False
  42
  43     try:
  44         llvm_dir = os.environ['LLVM']
  45     except KeyError:
  46         # Do nothing -- use the system headers/libs
  47         llvm_dir = None
  48     else:
  49         if not os.path.isdir(llvm_dir):
  50             raise SCons.Errors.InternalError, "Specified LLVM directory not found"
  51
  52         if env['debug']:
  53             llvm_subdir = 'Debug'
  54         else:
  55             llvm_subdir = 'Release'
  56
  57         llvm_bin_dir = os.path.join(llvm_dir, llvm_subdir, 'bin')
  58         if not os.path.isdir(llvm_bin_dir):
  59             llvm_bin_dir = os.path.join(llvm_dir, 'bin')
  60             if not os.path.isdir(llvm_bin_dir):
  61                 raise SCons.Errors.InternalError, "LLVM binary directory not found"
  62
  63         env.PrependENVPath('PATH', llvm_bin_dir)
  64
  65     if env['platform'] == 'windows':
  66         # XXX: There is no llvm-config on Windows, so assume a standard layout
  67         if llvm_dir is None:
  68             print 'scons: LLVM environment variable must be specified when building for windows'
  69             return
  70
  71         # Try to determine the LLVM version from llvm/Config/config.h
  72         llvm_config = os.path.join(llvm_dir, 'include/llvm/Config/config.h')
  73         if not os.path.exists(llvm_config):
  74             print 'scons: could not find %s' % llvm_config
  75             return
  76         llvm_version_re = re.compile(r'^#define PACKAGE_VERSION "([^"]*)"')
  77         llvm_version = None
  78         for line in open(llvm_config, 'rt'):
  79             mo = llvm_version_re.match(line)
  80             if mo:
  81                 llvm_version = mo.group(1)
  82                 llvm_version = distutils.version.LooseVersion(llvm_version)
  83                 break
  84         if llvm_version is None:
  85             print 'scons: could not determine the LLVM version from %s' % llvm_config
  86             return
  87
  88         env.Prepend(CPPPATH = [os.path.join(llvm_dir, 'include')])
  89         env.AppendUnique(CPPDEFINES = [
  90             '__STDC_LIMIT_MACROS',
  91             '__STDC_CONSTANT_MACROS',
  92             'HAVE_STDINT_H',
  93         ])
  94         env.Prepend(LIBPATH = [os.path.join(llvm_dir, 'lib')])
  95         if llvm_version >= distutils.version.LooseVersion('2.9'):
  96             # 2.9
  97             env.Prepend(LIBS = [
  98                 'LLVMObject', 'LLVMMCJIT', 'LLVMMCDisassembler',
  99                 'LLVMLinker', 'LLVMipo', 'LLVMInterpreter',
 100                 'LLVMInstrumentation', 'LLVMJIT', 'LLVMExecutionEngine',
 101                 'LLVMBitWriter', 'LLVMX86Disassembler', 'LLVMX86AsmParser',
 102                 'LLVMMCParser', 'LLVMX86AsmPrinter', 'LLVMX86CodeGen',
 103                 'LLVMSelectionDAG', 'LLVMX86Utils', 'LLVMX86Info', 'LLVMAsmPrinter',
 104                 'LLVMCodeGen', 'LLVMScalarOpts', 'LLVMInstCombine',
 105                 'LLVMTransformUtils', 'LLVMipa', 'LLVMAsmParser',
 106                 'LLVMArchive', 'LLVMBitReader', 'LLVMAnalysis', 'LLVMTarget',
 107                 'LLVMCore', 'LLVMMC', 'LLVMSupport',
 108             ])
 109         elif llvm_version >= distutils.version.LooseVersion('2.7'):
 110             # 2.7
 111             env.Prepend(LIBS = [
 112                 'LLVMLinker', 'LLVMipo', 'LLVMInterpreter',
 113                 'LLVMInstrumentation', 'LLVMJIT', 'LLVMExecutionEngine',
 114                 'LLVMBitWriter', 'LLVMX86Disassembler', 'LLVMX86AsmParser',
 115                 'LLVMMCParser', 'LLVMX86AsmPrinter', 'LLVMX86CodeGen',
 116                 'LLVMSelectionDAG', 'LLVMX86Info', 'LLVMAsmPrinter',
 117                 'LLVMCodeGen', 'LLVMScalarOpts', 'LLVMInstCombine',
 118                 'LLVMTransformUtils', 'LLVMipa', 'LLVMAsmParser',
 119                 'LLVMArchive', 'LLVMBitReader', 'LLVMAnalysis', 'LLVMTarget',
 120                 'LLVMMC', 'LLVMCore', 'LLVMSupport', 'LLVMSystem',
 121             ])
 122         else:
 123             # 2.6
 124             env.Prepend(LIBS = [
 125                 'LLVMX86AsmParser', 'LLVMX86AsmPrinter', 'LLVMX86CodeGen',
 126                 'LLVMX86Info', 'LLVMLinker', 'LLVMipo', 'LLVMInterpreter',
 127                 'LLVMInstrumentation', 'LLVMJIT', 'LLVMExecutionEngine',
 128                 'LLVMDebugger', 'LLVMBitWriter', 'LLVMAsmParser',
 129                 'LLVMArchive', 'LLVMBitReader', 'LLVMSelectionDAG',
 130                 'LLVMAsmPrinter', 'LLVMCodeGen', 'LLVMScalarOpts',
 131                 'LLVMTransformUtils', 'LLVMipa', 'LLVMAnalysis',
 132                 'LLVMTarget', 'LLVMMC', 'LLVMCore', 'LLVMSupport',
 133                 'LLVMSystem',
 134             ])
 135         env.Append(LIBS = [
 136             'imagehlp',
 137             'psapi',
 138             'shell32',
 139             'advapi32'
 140         ])
 141         if env['msvc']:
 142             # Some of the LLVM C headers use the inline keyword without
 143             # defining it.
 144             env.Append(CPPDEFINES = [('inline', '__inline')])
 145             if env['build'] in ('debug', 'checked'):
 146                 # LLVM libraries are static, build with /MT, and they
 147                 # automatically link agains LIBCMT. When we're doing a
 148                 # debug build we'll be linking against LIBCMTD, so disable
 149                 # that.
 150                 env.Append(LINKFLAGS = ['/nodefaultlib:LIBCMT'])
 151     else:
 152         if not env.Detect('llvm-config'):
 153             print 'scons: llvm-config script not found' % llvm_version
 154             return
 155
 156         llvm_version = env.backtick('llvm-config --version').rstrip()
 157         llvm_version = distutils.version.LooseVersion(llvm_version)
 158
 159         try:
 160             # Treat --cppflags specially to prevent NDEBUG from disabling
 161             # assertion failures in debug builds.
 162             cppflags = env.ParseFlags('!llvm-config --cppflags')
 163             try:
 164                 cppflags['CPPDEFINES'].remove('NDEBUG')
 165             except ValueError:
 166                 pass
 167             env.MergeFlags(cppflags)
 168
 169             env.ParseConfig('llvm-config --libs engine bitwriter')
 170             env.ParseConfig('llvm-config --ldflags')
 171         except OSError:
 172             print 'scons: llvm-config version %s failed' % llvm_version
 173             return
 174
 175     assert llvm_version is not None
 176     env['llvm'] = True
 177
 178     print 'scons: Found LLVM version %s' % llvm_version
 179     env['LLVM_VERSION'] = llvm_version
 180
 181     # Define HAVE_LLVM macro with the major/minor version number (e.g., 0x0206 for 2.6)
 182     llvm_version_major = int(llvm_version.version[0])
 183     llvm_version_minor = int(llvm_version.version[1])
 184     llvm_version_hex = '0x%02x%02x' % (llvm_version_major, llvm_version_minor)
 185     env.Prepend(CPPDEFINES = [('HAVE_LLVM', llvm_version_hex)])
 186
 187 def exists(env):
 188     return True
 189
 190 # vim:set ts=4 sw=4 et: