blob: 726e861b4a86c4ffd31bad5c0e8b300857bfa8d1 [file] [log] [blame]
Daniel Dunbar1db467f2009-07-31 05:54:17 +00001# -*- Python -*-
2
Daniel Dunbar5e01e3c2009-09-22 05:16:02 +00003import os
Daniel Dunbarb850ddd2009-09-22 10:08:03 +00004import platform
Chandler Carruthb40fd3f2011-11-05 20:55:50 +00005import re
6import subprocess
7
Daniel Dunbar724827f2009-09-08 16:39:23 +00008
Daniel Dunbar1db467f2009-07-31 05:54:17 +00009# Configuration file for the 'lit' test runner.
10
Daniel Dunbar5e01e3c2009-09-22 05:16:02 +000011# name: The name of this test suite.
12config.name = 'Clang'
Daniel Dunbar724827f2009-09-08 16:39:23 +000013
NAKAMURA Takumi98af1ac2011-02-09 04:19:57 +000014# Tweak PATH for Win32
15if platform.system() == 'Windows':
16 # Seek sane tools in directories and set to $PATH.
17 path = getattr(config, 'lit_tools_dir', None)
18 path = lit.getToolsPath(path,
19 config.environment['PATH'],
20 ['cmp.exe', 'grep.exe', 'sed.exe'])
21 if path is not None:
22 path = os.path.pathsep.join((path,
23 config.environment['PATH']))
24 config.environment['PATH'] = path
25
Daniel Dunbar5e01e3c2009-09-22 05:16:02 +000026# testFormat: The test format to use to interpret tests.
Daniel Dunbar1db467f2009-07-31 05:54:17 +000027#
Daniel Dunbar5e01e3c2009-09-22 05:16:02 +000028# For now we require '&&' between commands, until they get globally killed and
29# the test runner updated.
NAKAMURA Takumi9085e6f2011-03-05 11:16:06 +000030execute_external = (platform.system() != 'Windows'
31 or lit.getBashPath() not in [None, ""])
Daniel Dunbarbc20ef32009-11-08 01:47:35 +000032config.test_format = lit.formats.ShTest(execute_external)
Daniel Dunbar6827f3f2009-09-06 01:31:12 +000033
Daniel Dunbar5e01e3c2009-09-22 05:16:02 +000034# suffixes: A list of file extensions to treat as test files.
Peter Collingbournee2f82f72011-02-11 19:59:54 +000035config.suffixes = ['.c', '.cpp', '.m', '.mm', '.cu', '.ll', '.cl']
Daniel Dunbar5e01e3c2009-09-22 05:16:02 +000036
37# test_source_root: The root path where tests are located.
38config.test_source_root = os.path.dirname(__file__)
39
40# test_exec_root: The root path where tests should be run.
41clang_obj_root = getattr(config, 'clang_obj_root', None)
42if clang_obj_root is not None:
43 config.test_exec_root = os.path.join(clang_obj_root, 'test')
44
45# Set llvm_{src,obj}_root for use by others.
46config.llvm_src_root = getattr(config, 'llvm_src_root', None)
47config.llvm_obj_root = getattr(config, 'llvm_obj_root', None)
48
49# Tweak the PATH to include the tools dir and the scripts dir.
50if clang_obj_root is not None:
51 llvm_tools_dir = getattr(config, 'llvm_tools_dir', None)
52 if not llvm_tools_dir:
53 lit.fatal('No LLVM tools dir set!')
Daniel Dunbaree45d6d2009-09-24 06:31:08 +000054 path = os.path.pathsep.join((llvm_tools_dir, config.environment['PATH']))
Daniel Dunbar5e01e3c2009-09-22 05:16:02 +000055 config.environment['PATH'] = path
56
Daniel Dunbar9e10cc72009-09-26 07:36:09 +000057 llvm_libs_dir = getattr(config, 'llvm_libs_dir', None)
58 if not llvm_libs_dir:
59 lit.fatal('No LLVM libs dir set!')
60 path = os.path.pathsep.join((llvm_libs_dir,
61 config.environment.get('LD_LIBRARY_PATH','')))
62 config.environment['LD_LIBRARY_PATH'] = path
63
Daniel Dunbar5e01e3c2009-09-22 05:16:02 +000064###
65
66# Check that the object root is known.
67if config.test_exec_root is None:
68 # Otherwise, we haven't loaded the site specific configuration (the user is
69 # probably trying to run on a test file directly, and either the site
70 # configuration hasn't been created by the build system, or we are in an
71 # out-of-tree build situation).
72
Daniel Dunbarb258d8f2009-11-05 16:36:19 +000073 # Check for 'clang_site_config' user parameter, and use that if available.
74 site_cfg = lit.params.get('clang_site_config', None)
75 if site_cfg and os.path.exists(site_cfg):
76 lit.load_config(config, site_cfg)
77 raise SystemExit
78
Daniel Dunbar5e01e3c2009-09-22 05:16:02 +000079 # Try to detect the situation where we are using an out-of-tree build by
80 # looking for 'llvm-config'.
81 #
82 # FIXME: I debated (i.e., wrote and threw away) adding logic to
83 # automagically generate the lit.site.cfg if we are in some kind of fresh
Daniel Dunbar23354212009-11-07 23:53:17 +000084 # build situation. This means knowing how to invoke the build system though,
85 # and I decided it was too much magic. We should solve this by just having
86 # the .cfg files generated during the configuration step.
Daniel Dunbar5e01e3c2009-09-22 05:16:02 +000087
88 llvm_config = lit.util.which('llvm-config', config.environment['PATH'])
89 if not llvm_config:
90 lit.fatal('No site specific configuration available!')
91
92 # Get the source and object roots.
93 llvm_src_root = lit.util.capture(['llvm-config', '--src-root']).strip()
94 llvm_obj_root = lit.util.capture(['llvm-config', '--obj-root']).strip()
95 clang_src_root = os.path.join(llvm_src_root, "tools", "clang")
96 clang_obj_root = os.path.join(llvm_obj_root, "tools", "clang")
97
98 # Validate that we got a tree which points to here, using the standard
99 # tools/clang layout.
100 this_src_root = os.path.dirname(config.test_source_root)
101 if os.path.realpath(clang_src_root) != os.path.realpath(this_src_root):
102 lit.fatal('No site specific configuration available!')
103
104 # Check that the site specific configuration exists.
105 site_cfg = os.path.join(clang_obj_root, 'test', 'lit.site.cfg')
106 if not os.path.exists(site_cfg):
Nico Weberb4a88ef2010-09-27 20:40:32 +0000107 lit.fatal('No site specific configuration available! You may need to '
108 'run "make test" in your Clang build directory.')
Daniel Dunbar5e01e3c2009-09-22 05:16:02 +0000109
110 # Okay, that worked. Notify the user of the automagic, and reconfigure.
111 lit.note('using out-of-tree build at %r' % clang_obj_root)
112 lit.load_config(config, site_cfg)
113 raise SystemExit
114
115###
116
117# Discover the 'clang' and 'clangcc' to use.
118
119import os
120
121def inferClang(PATH):
122 # Determine which clang to use.
123 clang = os.getenv('CLANG')
124
125 # If the user set clang in the environment, definitely use that and don't
126 # try to validate.
127 if clang:
128 return clang
129
130 # Otherwise look in the path.
131 clang = lit.util.which('clang', PATH)
132
133 if not clang:
134 lit.fatal("couldn't find 'clang' program, try setting "
135 "CLANG in your environment")
136
137 return clang
138
Daniel Dunbare1fa0962010-03-20 21:13:08 +0000139# When running under valgrind, we mangle '-vg' onto the end of the triple so we
140# can check it with XFAIL and XTARGET.
141if lit.useValgrind:
142 config.target_triple += '-vg'
143
NAKAMURA Takumi9085e6f2011-03-05 11:16:06 +0000144config.clang = inferClang(config.environment['PATH']).replace('\\', '/')
Daniel Dunbar5e01e3c2009-09-22 05:16:02 +0000145if not lit.quiet:
146 lit.note('using clang: %r' % config.clang)
Chandler Carruth044a790c2011-11-05 10:15:27 +0000147
148# Note that when substituting %clang_cc1 also fill in the include directory of
149# the builtin headers. Those are part of even a freestanding environment, but
150# Clang relies on the driver to locate them.
Chandler Carruthdf0a4c32011-11-05 23:29:28 +0000151def getClangBuiltinIncludeDir(clang):
Chandler Carruthb40fd3f2011-11-05 20:55:50 +0000152 # FIXME: Rather than just getting the version, we should have clang print
153 # out its resource dir here in an easy to scrape form.
Chandler Carruthdf0a4c32011-11-05 23:29:28 +0000154 cmd = subprocess.Popen([clang, '-print-file-name=include'],
155 stdout=subprocess.PIPE)
156 if not cmd.stdout:
157 lit.fatal("Couldn't find the include dir for Clang ('%s')" % clang)
158 return cmd.stdout.read().strip()
Chandler Carruthb40fd3f2011-11-05 20:55:50 +0000159
Chandler Carruth07643082011-11-07 09:17:31 +0000160config.substitutions.append( ('%clang_cc1', '%s -cc1 -internal-isystem %s'
Chandler Carruthdf0a4c32011-11-05 23:29:28 +0000161 % (config.clang,
162 getClangBuiltinIncludeDir(config.clang))) )
Chandler Carruth044a790c2011-11-05 10:15:27 +0000163
Daniel Dunbar9fde9c42010-06-29 16:52:24 +0000164config.substitutions.append( ('%clangxx', ' ' + config.clang +
165 ' -ccc-clang-cxx -ccc-cxx '))
Daniel Dunbar80737ad2009-12-15 22:01:24 +0000166config.substitutions.append( ('%clang', ' ' + config.clang + ' ') )
Devang Patel8c6b9132010-09-13 20:46:23 +0000167config.substitutions.append( ('%test_debuginfo', ' ' + config.llvm_src_root + '/utils/test_debuginfo.pl ') )
Daniel Dunbara5728872009-12-15 20:14:24 +0000168
Daniel Dunbar80737ad2009-12-15 22:01:24 +0000169# FIXME: Find nicer way to prohibit this.
170config.substitutions.append(
171 (' clang ', """*** Do not use 'clang' in tests, use '%clang'. ***""") )
172config.substitutions.append(
David Greene431feb52011-01-03 17:28:52 +0000173 (' clang\+\+ ', """*** Do not use 'clang++' in tests, use '%clangxx'. ***"""))
Daniel Dunbar679d6052010-02-17 20:31:01 +0000174config.substitutions.append(
Daniel Dunbar80737ad2009-12-15 22:01:24 +0000175 (' clang-cc ',
176 """*** Do not use 'clang-cc' in tests, use '%clang_cc1'. ***""") )
177config.substitutions.append(
178 (' clang -cc1 ',
179 """*** Do not use 'clang -cc1' in tests, use '%clang_cc1'. ***""") )
Daniel Dunbar9fde9c42010-06-29 16:52:24 +0000180config.substitutions.append(
181 (' %clang-cc1 ',
182 """*** invalid substitution, use '%clang_cc1'. ***""") )
Daniel Dunbardb918642010-08-24 21:39:55 +0000183
184###
185
186# Set available features we allow tests to conditionalize on.
Andrew Trick6da28e22011-08-26 22:46:31 +0000187#
188# As of 2011.08, crash-recovery tests still do not pass on FreeBSD.
189if platform.system() not in ['FreeBSD']:
190 config.available_features.add('crash-recovery')
NAKAMURA Takumief34d772011-02-28 09:41:07 +0000191
192# Shell execution
193if platform.system() not in ['Windows'] or lit.getBashPath() != '':
194 config.available_features.add('shell')
Galina Kistanovaee226972011-06-03 18:36:30 +0000195
196# Registered Targets
NAKAMURA Takumi60796762011-11-28 05:09:42 +0000197def get_llc_props(tool):
Galina Kistanovaee226972011-06-03 18:36:30 +0000198 set_of_targets = set()
NAKAMURA Takumi60796762011-11-28 05:09:42 +0000199 enable_assertions = False
Galina Kistanovaee226972011-06-03 18:36:30 +0000200
201 cmd = subprocess.Popen([tool, '-version'], stdout=subprocess.PIPE)
202
203 # Parse the stdout to get the list of registered targets.
204 parse_targets = False
205 for line in cmd.stdout:
206 if parse_targets:
207 m = re.match( r'(.*) - ', line)
208 if m is not None:
209 set_of_targets.add(m.group(1).strip() + '-registered-target')
210 else:
211 break
212 elif "Registered Targets:" in line:
213 parse_targets = True
214
NAKAMURA Takumi60796762011-11-28 05:09:42 +0000215 if re.search(r'with assertions', line):
216 enable_assertions = True
Galina Kistanovaee226972011-06-03 18:36:30 +0000217
NAKAMURA Takumi60796762011-11-28 05:09:42 +0000218 return {"set_of_targets": set_of_targets,
219 "enable_assertions": enable_assertions}
220
221llc_props = get_llc_props(os.path.join(llvm_tools_dir, 'llc'))
222if len(llc_props['set_of_targets']) > 0:
223 config.available_features.update(llc_props['set_of_targets'])
Galina Kistanovaee226972011-06-03 18:36:30 +0000224else:
225 lit.fatal('No Targets Registered with the LLVM Tools!')
NAKAMURA Takumi60796762011-11-28 05:09:42 +0000226
227if llc_props['enable_assertions']:
228 config.available_features.add('asserts')