1#!/usr/bin/env python3 2 3"""A script to generate FileCheck statements for 'opt' analysis tests. 4 5This script is a utility to update LLVM opt analysis test cases with new 6FileCheck patterns. It can either update all of the tests in the file or 7a single test function. 8 9Example usage: 10$ update_analyze_test_checks.py --opt=../bin/opt test/foo.ll 11 12Workflow: 131. Make a compiler patch that requires updating some number of FileCheck lines 14 in regression test files. 152. Save the patch and revert it from your local work area. 163. Update the RUN-lines in the affected regression tests to look canonical. 17 Example: "; RUN: opt < %s -passes='print<cost-model>' -disable-output 2>&1 | FileCheck %s" 184. Refresh the FileCheck lines for either the entire file or select functions by 19 running this script. 205. Commit the fresh baseline of checks. 216. Apply your patch from step 1 and rebuild your local binaries. 227. Re-run this script on affected regression tests. 238. Check the diffs to ensure the script has done something reasonable. 249. Submit a patch including the regression test diffs for review. 25 26A common pattern is to have the script insert complete checking of every 27instruction. Then, edit it down to only check the relevant instructions. 28The script is designed to make adding checks to a test case fast, it is *not* 29designed to be authoratitive about what constitutes a good test! 30""" 31 32from __future__ import print_function 33 34import argparse 35import os # Used to advertise this file's name ("autogenerated_note"). 36import sys 37import re 38 39from UpdateTestChecks import common 40 41 42def main(): 43 from argparse import RawTextHelpFormatter 44 45 parser = argparse.ArgumentParser( 46 description=__doc__, formatter_class=RawTextHelpFormatter 47 ) 48 parser.add_argument( 49 "--opt-binary", 50 default="opt", 51 help="The opt binary used to generate the test case", 52 ) 53 parser.add_argument("--function", help="The function in the test file to update") 54 parser.add_argument("tests", nargs="+") 55 initial_args = common.parse_commandline_args(parser) 56 57 script_name = os.path.basename(__file__) 58 59 opt_basename = os.path.basename(initial_args.opt_binary) 60 if opt_basename != "opt": 61 common.error("Unexpected opt name: " + opt_basename) 62 sys.exit(1) 63 64 for ti in common.itertests( 65 initial_args.tests, parser, script_name="utils/" + script_name 66 ): 67 triple_in_ir = None 68 for l in ti.input_lines: 69 m = common.TRIPLE_IR_RE.match(l) 70 if m: 71 triple_in_ir = m.groups()[0] 72 break 73 74 prefix_list = [] 75 for l in ti.run_lines: 76 if "|" not in l: 77 common.warn("Skipping unparsable RUN line: " + l) 78 continue 79 80 (tool_cmd, filecheck_cmd) = tuple([cmd.strip() for cmd in l.split("|", 1)]) 81 common.verify_filecheck_prefixes(filecheck_cmd) 82 83 if not tool_cmd.startswith(opt_basename + " "): 84 common.warn("WSkipping non-%s RUN line: %s" % (opt_basename, l)) 85 continue 86 87 if not filecheck_cmd.startswith("FileCheck "): 88 common.warn("Skipping non-FileChecked RUN line: " + l) 89 continue 90 91 tool_cmd_args = tool_cmd[len(opt_basename) :].strip() 92 tool_cmd_args = tool_cmd_args.replace("< %s", "").replace("%s", "").strip() 93 check_prefixes = common.get_check_prefixes(filecheck_cmd) 94 95 # FIXME: We should use multiple check prefixes to common check lines. For 96 # now, we just ignore all but the last. 97 prefix_list.append((check_prefixes, tool_cmd_args)) 98 99 ginfo = common.make_analyze_generalizer(version=1) 100 builder = common.FunctionTestBuilder( 101 run_list=prefix_list, 102 flags=type( 103 "", 104 (object,), 105 { 106 "verbose": ti.args.verbose, 107 "filters": ti.args.filters, 108 "function_signature": False, 109 "check_attributes": False, 110 "replace_value_regex": [], 111 }, 112 ), 113 scrubber_args=[], 114 path=ti.path, 115 ginfo=ginfo, 116 ) 117 118 for prefixes, opt_args in prefix_list: 119 common.debug("Extracted opt cmd:", opt_basename, opt_args, file=sys.stderr) 120 common.debug( 121 "Extracted FileCheck prefixes:", str(prefixes), file=sys.stderr 122 ) 123 124 raw_tool_outputs = common.invoke_tool(ti.args.opt_binary, opt_args, ti.path) 125 126 if re.search(r"Printing analysis ", raw_tool_outputs) is not None: 127 # Split analysis outputs by "Printing analysis " declarations. 128 for raw_tool_output in re.split( 129 r"Printing analysis ", raw_tool_outputs 130 ): 131 builder.process_run_line( 132 common.ANALYZE_FUNCTION_RE, 133 common.scrub_body, 134 raw_tool_output, 135 prefixes, 136 ) 137 elif ( 138 re.search(r"(LV|LDist): Checking a loop in ", raw_tool_outputs) 139 is not None 140 ): 141 for raw_tool_output in re.split( 142 r"(LV|LDist): Checking a loop in ", raw_tool_outputs 143 ): 144 builder.process_run_line( 145 common.LOOP_PASS_DEBUG_RE, 146 common.scrub_body, 147 raw_tool_output, 148 prefixes, 149 ) 150 else: 151 common.warn("Don't know how to deal with this output") 152 continue 153 154 builder.processed_prefixes(prefixes) 155 156 func_dict = builder.finish_and_get_func_dict() 157 is_in_function = False 158 is_in_function_start = False 159 prefix_set = set([prefix for prefixes, _ in prefix_list for prefix in prefixes]) 160 common.debug("Rewriting FileCheck prefixes:", str(prefix_set), file=sys.stderr) 161 output_lines = [] 162 163 generated_prefixes = [] 164 for input_info in ti.iterlines(output_lines): 165 input_line = input_info.line 166 args = input_info.args 167 if is_in_function_start: 168 if input_line == "": 169 continue 170 if input_line.lstrip().startswith(";"): 171 m = common.CHECK_RE.match(input_line) 172 if not m or m.group(1) not in prefix_set: 173 output_lines.append(input_line) 174 continue 175 176 # Print out the various check lines here. 177 generated_prefixes.extend( 178 common.add_analyze_checks( 179 output_lines, 180 ";", 181 prefix_list, 182 func_dict, 183 func_name, 184 ginfo, 185 is_filtered=builder.is_filtered(), 186 ) 187 ) 188 is_in_function_start = False 189 190 if is_in_function: 191 if common.should_add_line_to_output(input_line, prefix_set): 192 # This input line of the function body will go as-is into the output. 193 output_lines.append(input_line) 194 else: 195 continue 196 if input_line.strip() == "}": 197 is_in_function = False 198 continue 199 200 # If it's outside a function, it just gets copied to the output. 201 output_lines.append(input_line) 202 203 m = common.IR_FUNCTION_RE.match(input_line) 204 if not m: 205 continue 206 func_name = m.group(1) 207 if ti.args.function is not None and func_name != ti.args.function: 208 # When filtering on a specific function, skip all others. 209 continue 210 is_in_function = is_in_function_start = True 211 212 if ti.args.gen_unused_prefix_body: 213 output_lines.extend( 214 ti.get_checks_for_unused_prefixes(prefix_list, generated_prefixes) 215 ) 216 217 common.debug("Writing %d lines to %s..." % (len(output_lines), ti.path)) 218 219 with open(ti.path, "wb") as f: 220 f.writelines(["{}\n".format(l).encode("utf-8") for l in output_lines]) 221 222 223if __name__ == "__main__": 224 main() 225