1#!/usr/bin/env python3 2 3"""A script to generate FileCheck statements for 'opt' regression tests. 4 5This script is a utility to update LLVM opt 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_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 -instcombine -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 os # Used to advertise this file's name ("autogenerated_note"). 36import re 37import sys 38 39from UpdateTestChecks import common 40 41 42def main(): 43 from argparse import RawTextHelpFormatter 44 parser = argparse.ArgumentParser(description=__doc__, formatter_class=RawTextHelpFormatter) 45 parser.add_argument('--opt-binary', default='opt', 46 help='The opt binary used to generate the test case') 47 parser.add_argument( 48 '--function', help='The function in the test file to update') 49 parser.add_argument('-p', '--preserve-names', action='store_true', 50 help='Do not scrub IR names') 51 parser.add_argument('--function-signature', action='store_true', 52 help='Keep function signature information around for the check line') 53 parser.add_argument('--scrub-attributes', action='store_true', 54 help='Remove attribute annotations (#0) from the end of check line') 55 parser.add_argument('tests', nargs='+') 56 initial_args = common.parse_commandline_args(parser) 57 58 script_name = os.path.basename(__file__) 59 opt_basename = os.path.basename(initial_args.opt_binary) 60 if not re.match(r'^opt(-\d+)?$', opt_basename): 61 common.error('Unexpected opt name: ' + opt_basename) 62 sys.exit(1) 63 opt_basename = 'opt' 64 65 for ti in common.itertests(initial_args.tests, parser, 66 script_name='utils/' + script_name): 67 # If requested we scrub trailing attribute annotations, e.g., '#0', together with whitespaces 68 if ti.args.scrub_attributes: 69 common.SCRUB_TRAILING_WHITESPACE_TEST_RE = common.SCRUB_TRAILING_WHITESPACE_AND_ATTRIBUTES_RE 70 else: 71 common.SCRUB_TRAILING_WHITESPACE_TEST_RE = common.SCRUB_TRAILING_WHITESPACE_RE 72 73 prefix_list = [] 74 for l in ti.run_lines: 75 if '|' not in l: 76 common.warn('Skipping unparseable RUN line: ' + l) 77 continue 78 79 (tool_cmd, filecheck_cmd) = tuple([cmd.strip() for cmd in l.split('|', 1)]) 80 common.verify_filecheck_prefixes(filecheck_cmd) 81 if not tool_cmd.startswith(opt_basename + ' '): 82 common.warn('Skipping non-%s RUN line: %s' % (opt_basename, l)) 83 continue 84 85 if not filecheck_cmd.startswith('FileCheck '): 86 common.warn('Skipping non-FileChecked RUN line: ' + l) 87 continue 88 89 tool_cmd_args = tool_cmd[len(opt_basename):].strip() 90 tool_cmd_args = tool_cmd_args.replace('< %s', '').replace('%s', '').strip() 91 92 check_prefixes = [item for m in 93 common.CHECK_PREFIX_RE.finditer(filecheck_cmd) 94 for item in m.group(1).split(',')] 95 if not check_prefixes: 96 check_prefixes = ['CHECK'] 97 98 # FIXME: We should use multiple check prefixes to common check lines. For 99 # now, we just ignore all but the last. 100 prefix_list.append((check_prefixes, tool_cmd_args)) 101 102 func_dict = {} 103 for prefixes, _ in prefix_list: 104 for prefix in prefixes: 105 func_dict.update({prefix: dict()}) 106 for prefixes, opt_args in prefix_list: 107 common.debug('Extracted opt cmd: ' + opt_basename + ' ' + opt_args) 108 common.debug('Extracted FileCheck prefixes: ' + str(prefixes)) 109 110 raw_tool_output = common.invoke_tool(ti.args.opt_binary, opt_args, ti.path) 111 common.build_function_body_dictionary( 112 common.OPT_FUNCTION_RE, common.scrub_body, [], 113 raw_tool_output, prefixes, func_dict, ti.args.verbose, 114 ti.args.function_signature) 115 116 is_in_function = False 117 is_in_function_start = False 118 prefix_set = set([prefix for prefixes, _ in prefix_list for prefix in prefixes]) 119 common.debug('Rewriting FileCheck prefixes:', str(prefix_set)) 120 output_lines = [] 121 for input_line_info in ti.iterlines(output_lines): 122 input_line = input_line_info.line 123 args = input_line_info.args 124 if is_in_function_start: 125 if input_line == '': 126 continue 127 if input_line.lstrip().startswith(';'): 128 m = common.CHECK_RE.match(input_line) 129 if not m or m.group(1) not in prefix_set: 130 output_lines.append(input_line) 131 continue 132 133 # Print out the various check lines here. 134 common.add_ir_checks(output_lines, ';', prefix_list, func_dict, 135 func_name, args.preserve_names, args.function_signature) 136 is_in_function_start = False 137 138 if is_in_function: 139 if common.should_add_line_to_output(input_line, prefix_set): 140 # This input line of the function body will go as-is into the output. 141 # Except make leading whitespace uniform: 2 spaces. 142 input_line = common.SCRUB_LEADING_WHITESPACE_RE.sub(r' ', input_line) 143 output_lines.append(input_line) 144 else: 145 continue 146 if input_line.strip() == '}': 147 is_in_function = False 148 continue 149 150 # If it's outside a function, it just gets copied to the output. 151 output_lines.append(input_line) 152 153 m = common.IR_FUNCTION_RE.match(input_line) 154 if not m: 155 continue 156 func_name = m.group(1) 157 if args.function is not None and func_name != args.function: 158 # When filtering on a specific function, skip all others. 159 continue 160 is_in_function = is_in_function_start = True 161 162 common.debug('Writing %d lines to %s...' % (len(output_lines), ti.path)) 163 164 with open(ti.path, 'wb') as f: 165 f.writelines(['{}\n'.format(l).encode('utf-8') for l in output_lines]) 166 167 168if __name__ == '__main__': 169 main() 170