1#!/usr/bin/env python 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 -analyze -cost-model -S | 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 glob 36import itertools 37import os # Used to advertise this file's name ("autogenerated_note"). 38import string 39import subprocess 40import sys 41import tempfile 42import re 43 44from UpdateTestChecks import common 45 46ADVERT = '; NOTE: Assertions have been autogenerated by ' 47 48# RegEx: this is where the magic happens. 49 50IR_FUNCTION_RE = re.compile('^\s*define\s+(?:internal\s+)?[^@]*@([\w-]+)\s*\(') 51 52def main(): 53 from argparse import RawTextHelpFormatter 54 parser = argparse.ArgumentParser(description=__doc__, formatter_class=RawTextHelpFormatter) 55 parser.add_argument('--opt-binary', default='opt', 56 help='The opt binary used to generate the test case') 57 parser.add_argument( 58 '--function', help='The function in the test file to update') 59 parser.add_argument('tests', nargs='+') 60 args = common.parse_commandline_args(parser) 61 62 script_name = os.path.basename(__file__) 63 autogenerated_note = (ADVERT + 'utils/' + script_name) 64 65 opt_basename = os.path.basename(args.opt_binary) 66 if (opt_basename != "opt"): 67 common.error('Unexpected opt name: ' + opt_basename) 68 sys.exit(1) 69 70 test_paths = [test for pattern in args.tests for test in glob.glob(pattern)] 71 for test in test_paths: 72 with open(test) as f: 73 input_lines = [l.rstrip() for l in f] 74 75 first_line = input_lines[0] if input_lines else "" 76 if 'autogenerated' in first_line and script_name not in first_line: 77 common.warn("Skipping test which wasn't autogenerated by " + script_name + ": " + test) 78 continue 79 80 if args.update_only: 81 if not first_line or 'autogenerated' not in first_line: 82 common.warn("Skipping test which isn't autogenerated: " + test) 83 continue 84 85 run_lines = common.find_run_lines(test, input_lines) 86 prefix_list = [] 87 for l in run_lines: 88 if '|' not in l: 89 common.warn('Skipping unparseable RUN line: ' + l) 90 continue 91 92 (tool_cmd, filecheck_cmd) = tuple([cmd.strip() for cmd in l.split('|', 1)]) 93 common.verify_filecheck_prefixes(filecheck_cmd) 94 95 if not tool_cmd.startswith(opt_basename + ' '): 96 common.warn('WSkipping non-%s RUN line: %s' % (opt_basename, l)) 97 continue 98 99 if not filecheck_cmd.startswith('FileCheck '): 100 common.warn('Skipping non-FileChecked RUN line: ' + l) 101 continue 102 103 tool_cmd_args = tool_cmd[len(opt_basename):].strip() 104 tool_cmd_args = tool_cmd_args.replace('< %s', '').replace('%s', '').strip() 105 106 check_prefixes = [item for m in common.CHECK_PREFIX_RE.finditer(filecheck_cmd) 107 for item in m.group(1).split(',')] 108 if not check_prefixes: 109 check_prefixes = ['CHECK'] 110 111 # FIXME: We should use multiple check prefixes to common check lines. For 112 # now, we just ignore all but the last. 113 prefix_list.append((check_prefixes, tool_cmd_args)) 114 115 func_dict = {} 116 for prefixes, _ in prefix_list: 117 for prefix in prefixes: 118 func_dict.update({prefix: dict()}) 119 for prefixes, opt_args in prefix_list: 120 common.debug('Extracted opt cmd:', opt_basename, opt_args, file=sys.stderr) 121 common.debug('Extracted FileCheck prefixes:', str(prefixes), file=sys.stderr) 122 123 raw_tool_outputs = common.invoke_tool(args.opt_binary, opt_args, test) 124 125 # Split analysis outputs by "Printing analysis " declarations. 126 for raw_tool_output in re.split(r'Printing analysis ', raw_tool_outputs): 127 common.build_function_body_dictionary( 128 common.ANALYZE_FUNCTION_RE, common.scrub_body, [], 129 raw_tool_output, prefixes, func_dict, args.verbose, False) 130 131 is_in_function = False 132 is_in_function_start = False 133 prefix_set = set([prefix for prefixes, _ in prefix_list for prefix in prefixes]) 134 common.debug('Rewriting FileCheck prefixes:', str(prefix_set), file=sys.stderr) 135 output_lines = [] 136 output_lines.append(autogenerated_note) 137 138 for input_line in input_lines: 139 if is_in_function_start: 140 if input_line == '': 141 continue 142 if input_line.lstrip().startswith(';'): 143 m = common.CHECK_RE.match(input_line) 144 if not m or m.group(1) not in prefix_set: 145 output_lines.append(input_line) 146 continue 147 148 # Print out the various check lines here. 149 common.add_analyze_checks(output_lines, ';', prefix_list, func_dict, func_name) 150 is_in_function_start = False 151 152 if is_in_function: 153 if common.should_add_line_to_output(input_line, prefix_set): 154 # This input line of the function body will go as-is into the output. 155 # Except make leading whitespace uniform: 2 spaces. 156 input_line = common.SCRUB_LEADING_WHITESPACE_RE.sub(r' ', input_line) 157 output_lines.append(input_line) 158 else: 159 continue 160 if input_line.strip() == '}': 161 is_in_function = False 162 continue 163 164 # Discard any previous script advertising. 165 if input_line.startswith(ADVERT): 166 continue 167 168 # If it's outside a function, it just gets copied to the output. 169 output_lines.append(input_line) 170 171 m = IR_FUNCTION_RE.match(input_line) 172 if not m: 173 continue 174 func_name = m.group(1) 175 if args.function is not None and func_name != args.function: 176 # When filtering on a specific function, skip all others. 177 continue 178 is_in_function = is_in_function_start = True 179 180 common.debug('Writing %d lines to %s...' % (len(output_lines), test)) 181 182 with open(test, 'wb') as f: 183 f.writelines(['{}\n'.format(l).encode('utf-8') for l in output_lines]) 184 185 186if __name__ == '__main__': 187 main() 188