update_llc_test_checks.py

#!/usr/bin/env python3

"""A test case update script.

This script is a utility to update LLVM 'llc' based test cases with new
FileCheck patterns. It can either update all of the tests in the file or
a single test function.
"""

from __future__ importprint_function

importargparse
importos# Used to advertise this file's name ("autogenerated_note").

fromUpdateTestChecksimportasm, common

# llc is the only llc-like in the LLVM tree but downstream forks can add
# additional ones here if they have them.
LLC_LIKE_TOOLS= ('llc',)

defmain():
parser=argparse.ArgumentParser(description=__doc__)
parser.add_argument('--llc-binary', default=None,
help='The "llc" binary to use to generate the test case')
parser.add_argument(
'--function', help='The function in the test file to update')
parser.add_argument(
'--extra_scrub', action='store_true',
help='Always use additional regex to further reduce diffs between various subtargets')
parser.add_argument(
'--x86_scrub_rip', action='store_true', default=True,
help='Use more regex for x86 matching to reduce diffs between various subtargets')
parser.add_argument(
'--no_x86_scrub_rip', action='store_false', dest='x86_scrub_rip')
parser.add_argument(
'--no_x86_scrub_mem_shuffle', action='store_true', default=False,
help='Reduce scrubbing shuffles with memory operands')
parser.add_argument('tests', nargs='+')
initial_args=common.parse_commandline_args(parser)

script_name=os.path.basename(__file__)

fortiincommon.itertests(initial_args.tests, parser,
script_name='utils/'+script_name):
triple_in_ir=None
forlinti.input_lines:
m=common.TRIPLE_IR_RE.match(l)
ifm:
triple_in_ir=m.groups()[0]
break

run_list= []
forlinti.run_lines:
if'|'notinl:
common.warn('Skipping unparseable RUN line: '+l)
continue

commands= [cmd.strip() forcmdinl.split('|', 1)]
llc_cmd=commands[0]
llc_tool=llc_cmd.split(' ')[0]

triple_in_cmd=None
m=common.TRIPLE_ARG_RE.search(llc_cmd)
ifm:
triple_in_cmd=m.groups()[0]

march_in_cmd=None
m=common.MARCH_ARG_RE.search(llc_cmd)
ifm:
march_in_cmd=m.groups()[0]

filecheck_cmd=''
iflen(commands) >1:
filecheck_cmd=commands[1]
common.verify_filecheck_prefixes(filecheck_cmd)
ifllc_toolnotinLLC_LIKE_TOOLS:
common.warn('Skipping non-llc RUN line: '+l)
continue

ifnotfilecheck_cmd.startswith('FileCheck '):
common.warn('Skipping non-FileChecked RUN line: '+l)
continue

llc_cmd_args=llc_cmd[len(llc_tool):].strip()
llc_cmd_args=llc_cmd_args.replace('< %s', '').replace('%s', '').strip()
ifti.path.endswith('.mir'):
llc_cmd_args+=' -x mir'
check_prefixes= [itemformincommon.CHECK_PREFIX_RE.finditer(filecheck_cmd)
foriteminm.group(1).split(',')]
ifnotcheck_prefixes:
check_prefixes= ['CHECK']

# FIXME: We should use multiple check prefixes to common check lines. For
# now, we just ignore all but the last.
run_list.append((check_prefixes, llc_cmd_args, triple_in_cmd, march_in_cmd))

ifti.path.endswith('.mir'):
check_indent=' '
else:
check_indent=''

func_dict= {}
forpinrun_list:
prefixes=p[0]
forprefixinprefixes:
func_dict.update({prefix: dict()})
forprefixes, llc_args, triple_in_cmd, march_in_cmdinrun_list:
common.debug('Extracted LLC cmd:', llc_tool, llc_args)
common.debug('Extracted FileCheck prefixes:', str(prefixes))

raw_tool_output=common.invoke_tool(ti.args.llc_binaryorllc_tool, llc_args, ti.path)
triple=triple_in_cmdortriple_in_ir
ifnottriple:
triple=asm.get_triple_from_march(march_in_cmd)

asm.build_function_body_dictionary_for_triple(ti.args, raw_tool_output,
triple, prefixes, func_dict)

is_in_function=False
is_in_function_start=False
func_name=None
prefix_set=set([prefixforpinrun_listforprefixinp[0]])
common.debug('Rewriting FileCheck prefixes:', str(prefix_set))
output_lines= []
forinput_infointi.iterlines(output_lines):
input_line=input_info.line
args=input_info.args
ifis_in_function_start:
ifinput_line=='':
continue
ifinput_line.lstrip().startswith(';'):
m=common.CHECK_RE.match(input_line)
ifnotmorm.group(1) notinprefix_set:
output_lines.append(input_line)
continue

# Print out the various check lines here.
asm.add_asm_checks(output_lines, check_indent+';', run_list, func_dict, func_name)
is_in_function_start=False

ifis_in_function:
ifcommon.should_add_line_to_output(input_line, prefix_set):
# This input line of the function body will go as-is into the output.
output_lines.append(input_line)
else:
continue
ifinput_line.strip() =='}':
is_in_function=False
continue

# If it's outside a function, it just gets copied to the output.
output_lines.append(input_line)

m=common.IR_FUNCTION_RE.match(input_line)
ifnotm:
continue
func_name=m.group(1)
ifargs.functionisnotNoneandfunc_name!=args.function:
# When filtering on a specific function, skip all others.
continue
is_in_function=is_in_function_start=True

common.debug('Writing %d lines to %s...'% (len(output_lines), ti.path))

withopen(ti.path, 'wb') asf:
f.writelines(['{}\n'.format(l).encode('utf-8') forlinoutput_lines])


if__name__=='__main__':
main()