Merge pull request #779 from pbalcer/loader-only-apis-2

[ur] refactor more hardcoded loader-specific templates

Author: pbalcer

scripts/YaML.md

@@ -238,12 +238,13 @@ std::function<void(void*)> ur_callback_t;
 * A handle requires the following scalar fields: {`desc`, `name`}
   - `desc` will be used as the handles's description comment
   - `name` must be a unique ISO-C standard identifier, start with `$` tag, be snake_case and end with `_handle_t`
-* A handle may take the following optional scalar fields: {`class`, `alias`, `condition`, `ordinal`, `version`}
+* A handle may take the following optional scalar fields: {`class`, `alias`, `condition`, `ordinal`, `version`, `loader_only`}
   - `class` will be used to scope the handles declaration within the specified C++ class
   - `alias` will be used to declare the handle as an alias of another handle; specifically, aliases in another namespace
   - `condition` will be used as a C/C++ preprocessor `#if` conditional expression
   - `ordinal` will be used to override the default order (in which they appear) the handles appears within its section; `default="1000"`
   - `version` will be used to define the minimum API version in which the handles will appear; `default="1.0"` This will also affect the order in which the handles appears within its section.
+  - `loader_only` will be used to decide whether the handle can be instantiated and managed only by the loader.
 * A handle may take the following optional field which can be a scalar, a sequence of scalars or scalars to sequences: {`details`}
   - `details` will be used as the handle's detailed comment
 

scripts/core/common.yml

@@ -62,6 +62,7 @@ value: uint8_t
 type: handle
 desc: "Handle of a loader config object"
 class: $xLoaderConfig
+loader_only: True
 name: "$x_loader_config_handle_t"
 --- #--------------------------------------------------------------------------
 type: handle

scripts/json2src.py

@@ -23,33 +23,6 @@ def add_argument(parser, name, help, default=False):
     group.add_argument("--skip-" + name, dest=name, help="Skip "+help, action="store_false")
     parser.set_defaults(**{name:default})
 
-"""
-    helpers to strip loader only api constructs from the json
-"""
-def strip_specs_class(specs, strip_class):
-    for spec in specs:
-        remove_obj = []
-        for obj in spec["objects"]:
-            if "class" in obj and strip_class in obj["class"]:
-                remove_obj.append(obj)
-        for obj in remove_obj:
-            spec["objects"].remove(obj)
-
-def strip_meta_entry(meta, entry_name, pattern):
-    loader_entries = []
-    for entry in meta[entry_name]:
-        if pattern in entry:
-            loader_entries.append(entry)
-
-    for entry in loader_entries:
-        del meta[entry_name][entry]
-
-def strip_loader_meta(meta):
-    strip_meta_entry(meta, "class", "Loader")
-    strip_meta_entry(meta, "function", "Loader")
-    strip_meta_entry(meta, "enum", "loader")
-    strip_meta_entry(meta, "handle", "loader")
-
 if __name__ == '__main__':
     parser = argparse.ArgumentParser()
     add_argument(parser, "lib", "generation of lib files.", True)
@@ -75,9 +48,6 @@ def strip_loader_meta(meta):
         if args.sections == None or config['name'] in args.sections:
             if args.lib:
                 generate_code.generate_lib(srcpath, config['name'], config['namespace'], config['tags'], args.ver, specs, input['meta'])
-            # From here only generate code for functions adapters can implement.
-            strip_specs_class(specs, "Loader")
-            strip_loader_meta(input['meta'])
             if args.loader:
                 generate_code.generate_loader(srcpath, config['name'], config['namespace'], config['tags'], args.ver, specs, input['meta'])
             if args.layers:

scripts/templates/helper.py

@@ -32,6 +32,13 @@ def is_class(obj):
         except:
             return False
 
+    @staticmethod
+    def is_handle(obj):
+        try:
+            return True if re.match(r"handle", obj['type']) else False
+        except:
+            return False
+
     @staticmethod
     def is_experimental(obj):
         try:
@@ -46,7 +53,12 @@ def class_name(obj):
         except:
             return None
 
-
+    @staticmethod
+    def is_loader_only(obj):
+        try:
+            return obj['loader_only']
+        except:
+            return False
 
 
 """
@@ -440,13 +452,6 @@ def is_global(item, tags):
         except:
             return False
 
-    @staticmethod
-    def is_loader_only(item):
-        try:
-            return item['loader_only']
-        except:
-            return False
-
 
 """
 Public:
@@ -555,6 +560,31 @@ def extract_objs(specs, value):
                 objs.append(obj)
     return objs
 
+"""
+Public:
+    returns a list of all adapter functions
+"""
+def get_adapter_functions(specs):
+    objs = []
+    for s in specs:
+        for obj in s['objects']:
+            if obj_traits.is_function(obj) and not obj_traits.is_loader_only(obj):
+                objs.append(obj)
+    return objs
+
+"""
+Public:
+    returns a list of all adapter handles
+"""
+def get_adapter_handles(specs):
+    objs = []
+    for s in specs:
+        for obj in s['objects']:
+            if obj_traits.is_handle(obj) and not obj_traits.is_loader_only(obj):
+                objs.append(obj)
+
+    return objs
+
 """
 Private:
     removes 'const' from c++ type
@@ -1055,8 +1085,8 @@ def get_pfntables(specs, meta, namespace, tags):
     tables = []
     for cname in sorted(meta['class'], key=lambda x: meta['class'][x]['ordinal']):
         objs, exp_objs = get_class_function_objs_exp(specs, cname)
-        objs = list(filter(lambda obj: not function_traits.is_loader_only(obj), objs))
-        exp_objs = list(filter(lambda obj: not function_traits.is_loader_only(obj), exp_objs))
+        objs = list(filter(lambda obj: not obj_traits.is_loader_only(obj), objs))
+        exp_objs = list(filter(lambda obj: not obj_traits.is_loader_only(obj), exp_objs))
 
         if len(objs) > 0:
             name = get_table_name(namespace, tags, objs[0])

scripts/templates/ldrddi.cpp.mako

@@ -24,7 +24,7 @@ from templates import helper as th
 namespace ur_loader
 {
     ///////////////////////////////////////////////////////////////////////////////
-    %for obj in th.extract_objs(specs, r"handle"):
+    %for obj in th.get_adapter_handles(specs):
     %if 'class' in obj:
     <%
         _handle_t = th.subt(n, tags, obj['name'])
@@ -34,7 +34,7 @@ namespace ur_loader
     %endif
     %endfor
 
-    %for obj in th.extract_objs(specs, r"function"):
+    %for obj in th.get_adapter_functions(specs):
     ///////////////////////////////////////////////////////////////////////////////
     /// @brief Intercept function for ${th.make_func_name(n, tags, obj)}
     %if 'condition' in obj:

scripts/templates/ldrddi.hpp.mako

@@ -27,7 +27,7 @@ from templates import helper as th
 namespace ur_loader
 {
     ///////////////////////////////////////////////////////////////////////////////
-    %for obj in th.extract_objs(specs, r"handle"):
+    %for obj in th.get_adapter_handles(specs):
     %if 'class' in obj:
     <%
         _handle_t = th.subt(n, tags, obj['name'])

scripts/templates/libapi.cpp.mako

@@ -56,7 +56,7 @@ ${th.make_func_name(n, tags, obj)}(
     %endfor
     )
 try {
-%if th.function_traits.is_loader_only(obj):
+%if th.obj_traits.is_loader_only(obj):
     return ur_lib::${th.make_func_name(n, tags, obj)}(${", ".join(th.make_param_lines(n, tags, obj, format=["name"]))} );
 %else:
 %if re.match("Init", obj['name']):

scripts/templates/nullddi.cpp.mako

@@ -22,7 +22,7 @@ from templates import helper as th
 
 namespace driver
 {
-    %for obj in th.extract_objs(specs, r"function"):
+    %for obj in th.get_adapter_functions(specs):
     ///////////////////////////////////////////////////////////////////////////////
     <%
         fname = th.make_func_name(n, tags, obj)

scripts/templates/trcddi.cpp.mako

@@ -24,7 +24,7 @@ from templates import helper as th
 
 namespace ur_tracing_layer
 {
-    %for obj in th.extract_objs(specs, r"function"):
+    %for obj in th.get_adapter_functions(specs):
     ///////////////////////////////////////////////////////////////////////////////
     /// @brief Intercept function for ${th.make_func_name(n, tags, obj)}
     %if 'condition' in obj:

scripts/templates/valddi.cpp.mako

@@ -24,7 +24,7 @@ from templates import helper as th
 
 namespace ur_validation_layer
 {
-    %for obj in th.extract_objs(specs, r"function"):
+    %for obj in th.get_adapter_functions(specs):
     <%
         func_name=th.make_func_name(n, tags, obj)
         object_param=th.make_param_lines(n, tags, obj, format=["name"])[-1]