[UR] Integrate registry.yml

Author: Petr Vesely

include/ur.py

@@ -1,7 +1,7 @@
 ---
 type: header
 desc: "Intel $OneApi Unified Runtime function registry"
-ordinal: "9"
+ordinal: "-1"
 ---
 name: $x_function_t
 type: enum
@@ -502,3 +502,110 @@ etors:
 - name: COMMAND_BUFFER_APPEND_MEMBUFFER_READ_RECT_EXP
   desc: Enumerator for $xCommandBufferAppendMembufferReadRectExp
   value: '171'
+---
+type: enum
+desc: Defines structure types
+name: $x_structure_type_t
+etors:
+- name: CONTEXT_PROPERTIES
+  desc: $x_context_properties_t
+  value: '0'
+- name: IMAGE_DESC
+  desc: $x_image_desc_t
+  value: '1'
+- name: BUFFER_PROPERTIES
+  desc: $x_buffer_properties_t
+  value: '2'
+- name: BUFFER_REGION
+  desc: $x_buffer_region_t
+  value: '3'
+- name: BUFFER_CHANNEL_PROPERTIES
+  desc: $x_buffer_channel_properties_t
+  value: '4'
+- name: BUFFER_ALLOC_LOCATION_PROPERTIES
+  desc: $x_buffer_alloc_location_properties_t
+  value: '5'
+- name: PROGRAM_PROPERTIES
+  desc: $x_program_properties_t
+  value: '6'
+- name: USM_DESC
+  desc: $x_usm_desc_t
+  value: '7'
+- name: USM_HOST_DESC
+  desc: $x_usm_host_desc_t
+  value: '8'
+- name: USM_DEVICE_DESC
+  desc: $x_usm_device_desc_t
+  value: '9'
+- name: USM_POOL_DESC
+  desc: $x_usm_pool_desc_t
+  value: '10'
+- name: USM_POOL_LIMITS_DESC
+  desc: $x_usm_pool_limits_desc_t
+  value: '11'
+- name: DEVICE_BINARY
+  desc: $x_device_binary_t
+  value: '12'
+- name: SAMPLER_DESC
+  desc: $x_sampler_desc_t
+  value: '13'
+- name: QUEUE_PROPERTIES
+  desc: $x_queue_properties_t
+  value: '14'
+- name: QUEUE_INDEX_PROPERTIES
+  desc: $x_queue_index_properties_t
+  value: '15'
+- name: CONTEXT_NATIVE_PROPERTIES
+  desc: $x_context_native_properties_t
+  value: '16'
+- name: KERNEL_NATIVE_PROPERTIES
+  desc: $x_kernel_native_properties_t
+  value: '17'
+- name: QUEUE_NATIVE_PROPERTIES
+  desc: $x_queue_native_properties_t
+  value: '18'
+- name: MEM_NATIVE_PROPERTIES
+  desc: $x_mem_native_properties_t
+  value: '19'
+- name: EVENT_NATIVE_PROPERTIES
+  desc: $x_event_native_properties_t
+  value: '20'
+- name: PLATFORM_NATIVE_PROPERTIES
+  desc: $x_platform_native_properties_t
+  value: '21'
+- name: DEVICE_NATIVE_PROPERTIES
+  desc: $x_device_native_properties_t
+  value: '22'
+- name: PROGRAM_NATIVE_PROPERTIES
+  desc: $x_program_native_properties_t
+  value: '23'
+- name: SAMPLER_NATIVE_PROPERTIES
+  desc: $x_sampler_native_properties_t
+  value: '24'
+- name: QUEUE_NATIVE_DESC
+  desc: $x_queue_native_desc_t
+  value: '25'
+- name: DEVICE_PARTITION_PROPERTIES
+  desc: $x_device_partition_properties_t
+  value: '26'
+- name: KERNEL_ARG_MEM_OBJ_PROPERTIES
+  desc: $x_kernel_arg_mem_obj_properties_t
+  value: '27'
+- name: PHYSICAL_MEM_PROPERTIES
+  desc: $x_physical_mem_properties_t
+  value: '28'
+- name: KERNEL_ARG_POINTER_PROPERTIES
+  desc: $x_kernel_arg_pointer_properties_t
+  value: '29'
+- name: KERNEL_ARG_SAMPLER_PROPERTIES
+  desc: $x_kernel_arg_sampler_properties_t
+  value: '30'
+- name: KERNEL_EXEC_INFO_PROPERTIES
+  desc: $x_kernel_exec_info_properties_t
+  value: '31'
+- name: KERNEL_ARG_VALUE_PROPERTIES
+  desc: $x_kernel_arg_value_properties_t
+  value: '32'
+- name: KERNEL_ARG_LOCAL_PROPERTIES
+  desc: $x_kernel_arg_local_properties_t
+  value: '33'

include/ur_api.h

@@ -18,9 +18,21 @@ class quoted(str):
 def quoted_presenter(dumper, data):
     return dumper.represent_scalar('tag:yaml.org,2002:str', data, style='"')
 
+def write_registry(data, path):
+    header = {'type': 'header', 'desc': quoted('Intel $OneApi Unified Runtime function registry'), 'ordinal': quoted(-1)}
+    data.insert(0, header)
+    with open(path, 'w') as fout:
+        yaml.add_representer(quoted, quoted_presenter)
+        yaml.dump_all(data, fout,
+            default_flow_style=False,
+            sort_keys=False,
+            explicit_start=True)
+        
+
 def generate_registry(path, specs):
     try:
-        existing_registry = list(util.yamlRead(path))[1]['etors']
+        contents = list(util.yamlRead(path))
+        existing_registry = contents[1]['etors']
         existing_etors = {etor["name"]: etor["value"] for etor in existing_registry}
         max_etor = int(max(existing_registry, key = lambda x : int(x["value"]))["value"])
         functions = [obj['class'][len('$x'):] + obj['name'] for s in specs for obj in s['objects'] if obj['type'] == 'function']
@@ -34,13 +46,9 @@ def generate_registry(path, specs):
             registry.append({'name': util.to_snake_case(fname).upper(), 'desc': 'Enumerator for $x'+fname, 'value': str(id)})
         registry = sorted(registry, key=lambda x: int(x['value']))
         wrapper = { 'name': ENUM_NAME, 'type': 'enum', 'desc': 'Defines unique stable identifiers for all functions' , 'etors': registry}
-        header = {'type': 'header', 'desc': quoted('Intel $OneApi Unified Runtime function registry'), 'ordinal': quoted(9)}
-        with open(path, 'w') as fout:
-            yaml.add_representer(quoted, quoted_presenter)
-            yaml.dump_all([header, wrapper], fout,
-                default_flow_style=False,
-                sort_keys=False,
-                explicit_start=True)
+        contents[1] =  wrapper
+        write_registry(contents[1:], path)
+
     except BaseException as e:
         print("Failed to generate registry.yml... %s", e)
         raise e

scripts/core/registry.yml

@@ -853,26 +853,54 @@ def sort_etors(x):
             return value
         matching_enum['etors'] = sorted(matching_enum['etors'], key=sort_etors)
 
-def _generate_structure_type_t(specs, meta):
+def _generate_structure_type_t(specs, meta, registry):
     extended_structs = [obj for s in specs for obj in s['objects'] if re.match(r"struct|union", obj['type']) and 'base' in obj]
-    ur_structure_type_t = {
-        "type": "enum",
-        "desc": "Defines structure types",
-        "name": "$x_structure_type_t",
-        "etors": []
-    }
+    ur_structure_type_t = [obj for s in specs for obj in s['objects'] if obj['name'] == "$x_structure_type_t"][0]
+    existing_etors = ur_structure_type_t['etors']
+    max_enum = int(max(ur_structure_type_t['etors'], key= lambda x : int(x['value']))['value'])
+
+    out_etors = []
     for struct in extended_structs:
+        # skip experimental enumerations
         if struct['name'].startswith("$x_exp_"):
             continue
-        stype = [mem for mem in struct['members'] if mem['name'] == 'stype'][0]
-        etor = stype['init']
-        ur_structure_type_t['etors'].append({"name": etor, "desc": struct['name']})
-    
-    common_header = [s for s in specs if s['header']['desc'].endswith("common types")][0]
-    result_t_index = [i for i, obj in enumerate(common_header['objects']) if obj['name'] == "$x_result_t"][0]
-    common_header['objects'].insert(result_t_index + 1, ur_structure_type_t)
+
+        # name of the etor
+        etor = [mem for mem in struct['members'] if mem['name'] == 'stype'][0]['init']
+
+        # try and match the etor
+        matched_etor = [e for e in existing_etors if e['name'] == etor]
+        
+        # if no match exists then we have to add it
+        if len(matched_etor) == 0:
+            max_enum += 1
+            out_etors.append({
+                "name": etor,
+                "desc": struct['name'],
+                "value": str(max_enum)
+            })
+        else:
+            out_etors.append({
+                "name": etor,
+                "desc": struct['name'],
+                "value": matched_etor[0]['value']
+            })
+
+    out_etors = sorted(out_etors, key = lambda x : int(x['value']))
+    ur_structure_type_t['etors'] = out_etors
     _refresh_enum_meta(ur_structure_type_t, meta)
 
+    ## write the result out to the yml file
+    try:
+        contents = list(util.yamlRead(registry))
+        cpy = copy.deepcopy(ur_structure_type_t)
+        for e in cpy['etors']:
+            e['name'] = e['name'][len("$X_STRUCTURE_TYPE_"):]
+        contents[2] = cpy
+        generate_ids.write_registry(contents[1:], registry)
+    except:
+        raise
+
 """
 Entry-point:
     Reads each YML file and extracts data
@@ -942,7 +970,8 @@ def parse(section, version, tags, meta, ref):
 
     specs = sorted(specs, key=lambda s: s['header']['ordinal'])
     _inline_extended_structs(specs, meta)
-    _generate_structure_type_t(specs, meta)
+    registry = [f for f in files if f.endswith('registry.yml')][0]
+    _generate_structure_type_t(specs, meta, registry)
     _extend_enums(enum_extensions, specs, meta)
     _generate_extra(specs, meta)