9d144bb5992a1351ad749790ed75aac337242ffd
[lldb.git] / lldb / test / Shell / helper / toolchain.py
1 import os
2 import itertools
3 import platform
4 import subprocess
5 import sys
6
7 import lit.util
8 from lit.llvm import llvm_config
9 from lit.llvm.subst import FindTool
10 from lit.llvm.subst import ToolSubst
11
12 def use_lldb_substitutions(config):
13     # Set up substitutions for primary tools.  These tools must come from config.lldb_tools_dir
14     # which is basically the build output directory.  We do not want to find these in path or
15     # anywhere else, since they are specifically the programs which are actually being tested.
16
17     dsname = 'debugserver' if platform.system() in ['Darwin'] else 'lldb-server'
18     dsargs = [] if platform.system() in ['Darwin'] else ['gdbserver']
19
20     build_script = os.path.dirname(__file__)
21     build_script = os.path.join(build_script, 'build.py')
22     build_script_args = [build_script,
23                         '--compiler=any', # Default to best compiler
24                         '--arch=' + str(config.lldb_bitness)]
25     if config.lldb_lit_tools_dir:
26         build_script_args.append('--tools-dir={0}'.format(config.lldb_lit_tools_dir))
27     if config.lldb_tools_dir:
28         build_script_args.append('--tools-dir={0}'.format(config.lldb_tools_dir))
29     if config.llvm_libs_dir:
30         build_script_args.append('--libs-dir={0}'.format(config.llvm_libs_dir))
31
32     lldb_init = os.path.join(config.test_exec_root, 'Shell', 'lit-lldb-init')
33
34     primary_tools = [
35         ToolSubst('%lldb',
36                   command=FindTool('lldb'),
37                   extra_args=['--no-lldbinit', '-S', lldb_init]),
38         ToolSubst('%lldb-init',
39                   command=FindTool('lldb'),
40                   extra_args=['-S', lldb_init]),
41         ToolSubst('%debugserver',
42                   command=FindTool(dsname),
43                   extra_args=dsargs,
44                   unresolved='ignore'),
45         ToolSubst('%platformserver',
46                   command=FindTool('lldb-server'),
47                   extra_args=['platform'],
48                   unresolved='ignore'),
49         'lldb-test',
50         'lldb-instr',
51         ToolSubst('%build',
52                   command="'" + sys.executable + "'",
53                   extra_args=build_script_args)
54         ]
55
56     llvm_config.add_tool_substitutions(primary_tools,
57                                        [config.lldb_tools_dir])
58
59 def _use_msvc_substitutions(config):
60     # If running from a Visual Studio Command prompt (e.g. vcvars), this will
61     # detect the include and lib paths, and find cl.exe and link.exe and create
62     # substitutions for each of them that explicitly specify /I and /L paths
63     cl = lit.util.which('cl')
64     link = lit.util.which('link')
65
66     if not cl or not link:
67         return
68
69     cl = '"' + cl + '"'
70     link = '"' + link + '"'
71     includes = os.getenv('INCLUDE', '').split(';')
72     libs = os.getenv('LIB', '').split(';')
73
74     config.available_features.add('msvc')
75     compiler_flags = ['"/I{}"'.format(x) for x in includes if os.path.exists(x)]
76     linker_flags = ['"/LIBPATH:{}"'.format(x) for x in libs if os.path.exists(x)]
77
78     tools = [
79         ToolSubst('%msvc_cl', command=cl, extra_args=compiler_flags),
80         ToolSubst('%msvc_link', command=link, extra_args=linker_flags)]
81     llvm_config.add_tool_substitutions(tools)
82     return
83
84 def use_support_substitutions(config):
85     # Set up substitutions for support tools.  These tools can be overridden at the CMake
86     # level (by specifying -DLLDB_LIT_TOOLS_DIR), installed, or as a last resort, we can use
87     # the just-built version.
88     host_flags = ['--target=' + config.host_triple]
89     if platform.system() in ['Darwin']:
90         try:
91             out = subprocess.check_output(['xcrun', '--show-sdk-path']).strip()
92             res = 0
93         except OSError:
94             res = -1
95         if res == 0 and out:
96             sdk_path = lit.util.to_string(out)
97             llvm_config.lit_config.note('using SDKROOT: %r' % sdk_path)
98             host_flags += ['-isysroot', sdk_path]
99     elif platform.system() in ['NetBSD', 'OpenBSD', 'Linux']:
100         host_flags += ['-pthread']
101
102     if sys.platform.startswith('netbsd'):
103         # needed e.g. to use freshly built libc++
104         host_flags += ['-L' + config.llvm_libs_dir,
105                   '-Wl,-rpath,' + config.llvm_libs_dir]
106
107     # The clang module cache is used for building inferiors.
108     host_flags += ['-fmodules-cache-path={}'.format(config.clang_module_cache)]
109
110     host_flags = ' '.join(host_flags)
111     config.substitutions.append(('%clang_host', '%clang ' + host_flags))
112     config.substitutions.append(('%clangxx_host', '%clangxx ' + host_flags))
113     config.substitutions.append(('%clang_cl_host', '%clang_cl --target='+config.host_triple))
114
115     additional_tool_dirs=[]
116     if config.lldb_lit_tools_dir:
117         additional_tool_dirs.append(config.lldb_lit_tools_dir)
118
119     llvm_config.use_clang(additional_flags=['--target=specify-a-target-or-use-a-_host-substitution'],
120                           additional_tool_dirs=additional_tool_dirs,
121                           required=True)
122
123
124     if sys.platform == 'win32':
125         _use_msvc_substitutions(config)
126
127     have_lld = llvm_config.use_lld(additional_tool_dirs=additional_tool_dirs,
128                                    required=False)
129     if have_lld:
130         config.available_features.add('lld')
131
132
133     support_tools = ['yaml2obj', 'obj2yaml', 'llvm-pdbutil',
134                      'llvm-mc', 'llvm-readobj', 'llvm-objdump',
135                      'llvm-objcopy', 'lli']
136     additional_tool_dirs += [config.lldb_tools_dir, config.llvm_tools_dir]
137     llvm_config.add_tool_substitutions(support_tools, additional_tool_dirs)