llvm.py revision e6314db0ac537695a20feb5fab8d77a30836eccf 
1"""llvm
2
3Tool-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
30import os
31import os.path
32import re
33import sys
34import distutils.version
35
36import SCons.Errors
37import SCons.Util
38
39
40def 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.7'):
96            # 2.7
97            env.Prepend(LIBS = [
98                'LLVMLinker', 'LLVMipo', 'LLVMInterpreter',
99                'LLVMInstrumentation', 'LLVMJIT', 'LLVMExecutionEngine',
100                'LLVMBitWriter', 'LLVMX86Disassembler', 'LLVMX86AsmParser',
101                'LLVMMCParser', 'LLVMX86AsmPrinter', 'LLVMX86CodeGen',
102                'LLVMSelectionDAG', 'LLVMX86Info', 'LLVMAsmPrinter',
103                'LLVMCodeGen', 'LLVMScalarOpts', 'LLVMInstCombine',
104                'LLVMTransformUtils', 'LLVMipa', 'LLVMAsmParser',
105                'LLVMArchive', 'LLVMBitReader', 'LLVMAnalysis', 'LLVMTarget',
106                'LLVMMC', 'LLVMCore', 'LLVMSupport', 'LLVMSystem',
107            ])
108        else:
109            # 2.6
110            env.Prepend(LIBS = [
111                'LLVMX86AsmParser', 'LLVMX86AsmPrinter', 'LLVMX86CodeGen',
112                'LLVMX86Info', 'LLVMLinker', 'LLVMipo', 'LLVMInterpreter',
113                'LLVMInstrumentation', 'LLVMJIT', 'LLVMExecutionEngine',
114                'LLVMDebugger', 'LLVMBitWriter', 'LLVMAsmParser',
115                'LLVMArchive', 'LLVMBitReader', 'LLVMSelectionDAG',
116                'LLVMAsmPrinter', 'LLVMCodeGen', 'LLVMScalarOpts',
117                'LLVMTransformUtils', 'LLVMipa', 'LLVMAnalysis',
118                'LLVMTarget', 'LLVMMC', 'LLVMCore', 'LLVMSupport',
119                'LLVMSystem',
120            ])
121        env.Append(LIBS = [
122            'imagehlp',
123            'psapi',
124        ])
125        if env['msvc']:
126            # Some of the LLVM C headers use the inline keyword without
127            # defining it.
128            env.Append(CPPDEFINES = [('inline', '__inline')])
129            if env['build'] in ('debug', 'checked'):
130                # LLVM libraries are static, build with /MT, and they
131                # automatically link agains LIBCMT. When we're doing a
132                # debug build we'll be linking against LIBCMTD, so disable
133                # that.
134                env.Append(LINKFLAGS = ['/nodefaultlib:LIBCMT'])
135    else:
136        if not env.Detect('llvm-config'):
137            print 'scons: llvm-config script not found' % llvm_version
138            return
139
140        llvm_version = env.backtick('llvm-config --version').rstrip()
141        llvm_version = distutils.version.LooseVersion(llvm_version)
142
143        try:
144            env.ParseConfig('llvm-config --cppflags')
145            env.ParseConfig('llvm-config --libs')
146            env.ParseConfig('llvm-config --ldflags')
147        except OSError:
148            print 'scons: llvm-config version %s failed' % llvm_version
149            return
150
151    assert llvm_version is not None
152    env['llvm'] = True
153
154    print 'scons: Found LLVM version %s' % llvm_version
155    env['LLVM_VERSION'] = llvm_version
156
157    # Define HAVE_LLVM macro with the major/minor version number (e.g., 0x0206 for 2.6)
158    llvm_version_major = int(llvm_version.version[0])
159    llvm_version_minor = int(llvm_version.version[1])
160    llvm_version_hex = '0x%02x%02x' % (llvm_version_major, llvm_version_minor)
161    env.Prepend(CPPDEFINES = [('HAVE_LLVM', llvm_version_hex)])
162
163def exists(env):
164    return True
165
166# vim:set ts=4 sw=4 et:
167