[Mlir-commits] [mlir] 20bd6fb - [mlir] gen_spirv_dialect.py: Some support for OCL ops generation
llvmlistbot at llvm.org
llvmlistbot at llvm.org
Wed Oct 27 04:55:09 PDT 2021
Author: Caitlyn Cano
Date: 2021-10-27T14:54:47+03:00
New Revision: 20bd6fb99ab0e55da9d6553aab9a5a6972a8e7f0
URL: https://github.com/llvm/llvm-project/commit/20bd6fb99ab0e55da9d6553aab9a5a6972a8e7f0
DIFF: https://github.com/llvm/llvm-project/commit/20bd6fb99ab0e55da9d6553aab9a5a6972a8e7f0.diff
LOG: [mlir] gen_spirv_dialect.py: Some support for OCL ops generation
It is not complete and disabled by default, but it can be still useful.
Differential Revision: https://reviews.llvm.org/D111886
Added:
Modified:
mlir/utils/spirv/gen_spirv_dialect.py
Removed:
################################################################################
diff --git a/mlir/utils/spirv/gen_spirv_dialect.py b/mlir/utils/spirv/gen_spirv_dialect.py
index ce1bff031bed9..2d0c7649f34f1 100755
--- a/mlir/utils/spirv/gen_spirv_dialect.py
+++ b/mlir/utils/spirv/gen_spirv_dialect.py
@@ -25,39 +25,52 @@
SPIRV_HTML_SPEC_URL = 'https://www.khronos.org/registry/spir-v/specs/unified1/SPIRV.html'
SPIRV_JSON_SPEC_URL = 'https://raw.githubusercontent.com/KhronosGroup/SPIRV-Headers/master/include/spirv/unified1/spirv.core.grammar.json'
+SPIRV_OCL_EXT_HTML_SPEC_URL = 'https://www.khronos.org/registry/SPIR-V/specs/unified1/OpenCL.ExtendedInstructionSet.100.html'
+SPIRV_OCL_EXT_JSON_SPEC_URL = 'https://raw.githubusercontent.com/KhronosGroup/SPIRV-Headers/master/include/spirv/unified1/extinst.opencl.std.100.grammar.json'
+
AUTOGEN_OP_DEF_SEPARATOR = '\n// -----\n\n'
AUTOGEN_ENUM_SECTION_MARKER = 'enum section. Generated from SPIR-V spec; DO NOT MODIFY!'
AUTOGEN_OPCODE_SECTION_MARKER = (
'opcode section. Generated from SPIR-V spec; DO NOT MODIFY!')
-
-def get_spirv_doc_from_html_spec():
+def get_spirv_doc_from_html_spec(url, settings):
"""Extracts instruction documentation from SPIR-V HTML spec.
Returns:
- A dict mapping from instruction opcode to documentation.
"""
- response = requests.get(SPIRV_HTML_SPEC_URL)
+ if url is None:
+ url = SPIRV_HTML_SPEC_URL
+
+ response = requests.get(url)
spec = response.content
from bs4 import BeautifulSoup
spirv = BeautifulSoup(spec, 'html.parser')
- section_anchor = spirv.find('h3', {'id': '_a_id_instructions_a_instructions'})
-
doc = {}
- for section in section_anchor.parent.find_all('div', {'class': 'sect3'}):
- for table in section.find_all('table'):
- inst_html = table.tbody.tr.td.p
- opname = inst_html.a['id']
- # Ignore the first line, which is just the opname.
- doc[opname] = inst_html.text.split('\n', 1)[1].strip()
+ if settings.gen_ocl_ops:
+ section_anchor = spirv.find('h2', {'id': '_a_id_binary_a_binary_form'})
+ for section in section_anchor.parent.find_all('div', {'class': 'sect2'}):
+ for table in section.find_all('table'):
+ inst_html = table.tbody.tr.td
+ opname = inst_html.a['id']
+ # Ignore the first line, which is just the opname.
+ doc[opname] = inst_html.text.split('\n', 1)[1].strip()
+ else:
+ section_anchor = spirv.find('h3', {'id': '_a_id_instructions_a_instructions'})
+ for section in section_anchor.parent.find_all('div', {'class': 'sect3'}):
+ for table in section.find_all('table'):
+ inst_html = table.tbody.tr.td.p
+ opname = inst_html.a['id']
+ # Ignore the first line, which is just the opname.
+ doc[opname] = inst_html.text.split('\n', 1)[1].strip()
return doc
-def get_spirv_grammar_from_json_spec():
+def get_spirv_grammar_from_json_spec(url):
"""Extracts operand kind and instruction grammar from SPIR-V JSON spec.
Returns:
@@ -70,7 +83,14 @@ def get_spirv_grammar_from_json_spec():
import json
spirv = json.loads(spec)
- return spirv['operand_kinds'], spirv['instructions']
+ if url is None:
+ return spirv['operand_kinds'], spirv['instructions']
+
+ response_ext = requests.get(url)
+ spec_ext = response_ext.content
+ spirv_ext = json.loads(spec_ext)
+
+ return spirv['operand_kinds'], spirv_ext['instructions']
def split_list_into_sublists(items):
@@ -669,7 +689,7 @@ def get_description(text, appendix):
return fmt_str.format(text=text, appendix=appendix)
-def get_op_definition(instruction, doc, existing_info, capability_mapping):
+def get_op_definition(instruction, opname, doc, existing_info, capability_mapping, settings):
"""Generates the TableGen op definition for the given SPIR-V instruction.
Arguments:
@@ -683,10 +703,17 @@ def get_op_definition(instruction, doc, existing_info, capability_mapping):
Returns:
- A string containing the TableGen op definition
"""
- fmt_str = ('def SPV_{opname}Op : '
- 'SPV_{inst_category}<"{opname}"{category_args}[{traits}]> '
- '{{\n let summary = {summary};\n\n let description = '
- '[{{\n{description}}}];{availability}\n')
+ if settings.gen_ocl_ops:
+ fmt_str = ('def SPV_{opname}Op : '
+ 'SPV_{inst_category}<"{opname_src}", {opcode}, <<Insert result type>> > '
+ '{{\n let summary = {summary};\n\n let description = '
+ '[{{\n{description}}}];{availability}\n')
+ else:
+ fmt_str = ('def SPV_{opname_src}Op : '
+ 'SPV_{inst_category}<"{opname_src}"{category_args}[{traits}]> '
+ '{{\n let summary = {summary};\n\n let description = '
+ '[{{\n{description}}}];{availability}\n')
+
inst_category = existing_info.get('inst_category', 'Op')
if inst_category == 'Op':
fmt_str +='\n let arguments = (ins{args});\n\n'\
@@ -695,7 +722,10 @@ def get_op_definition(instruction, doc, existing_info, capability_mapping):
fmt_str +='{extras}'\
'}}\n'
- opname = instruction['opname'][2:]
+ opname_src = instruction['opname']
+ if opname.startswith('Op'):
+ opname_src = opname_src[2:]
+
category_args = existing_info.get('category_args', '')
if '\n' in doc:
@@ -760,6 +790,8 @@ def get_op_definition(instruction, doc, existing_info, capability_mapping):
return fmt_str.format(
opname=opname,
+ opname_src=opname_src,
+ opcode=instruction['opcode'],
category_args=category_args,
inst_category=inst_category,
traits=existing_info.get('traits', ''),
@@ -889,7 +921,7 @@ def extract_td_op_info(op_def):
def update_td_op_definitions(path, instructions, docs, filter_list,
- inst_category, capability_mapping):
+ inst_category, capability_mapping, settings):
"""Updates SPIRVOps.td with newly generated op definition.
Arguments:
@@ -926,16 +958,24 @@ def update_td_op_definitions(path, instructions, docs, filter_list,
filter_list = sorted(list(set(filter_list)))
op_defs = []
+
+ if settings.gen_ocl_ops:
+ fix_opname = lambda src: src.replace('OCL','').lower()
+ else:
+ fix_opname = lambda src: src
+
for opname in filter_list:
# Find the grammar spec for this op
try:
+ fixed_opname = fix_opname(opname)
instruction = next(
- inst for inst in instructions if inst['opname'] == opname)
+ inst for inst in instructions if inst['opname'] == fixed_opname)
+
op_defs.append(
get_op_definition(
- instruction, docs[opname],
+ instruction, opname, docs[fixed_opname],
op_info_dict.get(opname, {'inst_category': inst_category}),
- capability_mapping))
+ capability_mapping, settings))
except StopIteration:
# This is an op added by us; use the existing ODS definition.
op_defs.append(name_op_map[opname])
@@ -994,12 +1034,25 @@ def update_td_op_definitions(path, instructions, docs, filter_list,
default='Op',
help='SPIR-V instruction category used for choosing '\
'the TableGen base class to define this op')
+ cli_parser.add_argument(
+ '--gen-ocl-ops',
+ dest='gen_ocl_ops',
+ help='Generate OpenCL Extended Instruction Set op',
+ action='store_true')
+ cli_parser.set_defaults(gen_ocl_ops=False)
cli_parser.add_argument('--gen-inst-coverage', dest='gen_inst_coverage', action='store_true')
cli_parser.set_defaults(gen_inst_coverage=False)
args = cli_parser.parse_args()
- operand_kinds, instructions = get_spirv_grammar_from_json_spec()
+ if args.gen_ocl_ops:
+ ext_html_url = SPIRV_OCL_EXT_HTML_SPEC_URL
+ ext_json_url = SPIRV_OCL_EXT_JSON_SPEC_URL
+ else:
+ ext_html_url = None
+ ext_json_url = None
+
+ operand_kinds, instructions = get_spirv_grammar_from_json_spec(ext_json_url)
# Define new enum attr
if args.new_enum is not None:
@@ -1015,10 +1068,10 @@ def update_td_op_definitions(path, instructions, docs, filter_list,
# Define new op
if args.new_inst is not None:
assert args.op_td_path is not None
- docs = get_spirv_doc_from_html_spec()
+ docs = get_spirv_doc_from_html_spec(ext_html_url, args)
capability_mapping = get_capability_mapping(operand_kinds)
update_td_op_definitions(args.op_td_path, instructions, docs, args.new_inst,
- args.inst_category, capability_mapping)
+ args.inst_category, capability_mapping, args)
print('Done. Note that this script just generates a template; ', end='')
print('please read the spec and update traits, arguments, and ', end='')
print('results accordingly.')
More information about the Mlir-commits
mailing list