[UR] Add lifetime validation to validation layer

oneapi-src · Dec 4, 2023 · 5e75b54 · 5e75b54
1 parent e20c7df
commit 5e75b54
Show file tree

Hide file tree

Showing 4 changed files with 1,548 additions and 1 deletion.
diff --git a/scripts/templates/valddi.cpp.mako b/scripts/templates/valddi.cpp.mako
@@ -74,6 +74,21 @@ namespace ur_validation_layer
 
         }
 
+        if( context.enableLifetimeValidation ) {
+            %for tp in tracked_params:
+            <%
+                tp_input_handle_funcs = next((hf for hf in handle_create_get_retain_release_funcs if th.subt(n, tags, tp['type']) == hf['handle'] and "[in]" in tp['desc']), {})
+                is_related_create_get_retain_release_func = any(func_name in funcs for funcs in tp_input_handle_funcs.values())
+            %>
+            %if tp_input_handle_funcs and not is_related_create_get_retain_release_func:
+            if (!refCountContext.isReferenceValid(${tp['name']})) {
+                refCountContext.logInvalidReference(${tp['name']});
+                return UR_RESULT_ERROR_INVALID_ARGUMENT;
+            }
+            %endif
+            %endfor
+        }
+
         ${x}_result_t result = ${th.make_pfn_name(n, tags, obj)}( ${", ".join(th.make_param_lines(n, tags, obj, format=["name"]))} );
 
         %for tp in tracked_params:
@@ -167,13 +182,18 @@ namespace ur_validation_layer
         if (enabledLayerNames.count(nameFullValidation)) {
             enableParameterValidation = true;
             enableLeakChecking = true;
+            enableLifetimeValidation = true;
         } else {
             if (enabledLayerNames.count(nameParameterValidation)) {
                 enableParameterValidation = true;
             }
             if (enabledLayerNames.count(nameLeakChecking)) {
                 enableLeakChecking = true;
             }
+            if (enabledLayerNames.count(nameLifetimeValidation)) {
+                // Handle lifetime validation requires leak checking feature.
+                enableLifetimeValidation = enableLeakChecking;
+            }
         }
 
         if(!enableParameterValidation && !enableLeakChecking) {

diff --git a/source/loader/layers/validation/ur_leak_check.hpp b/source/loader/layers/validation/ur_leak_check.hpp
@@ -115,6 +115,8 @@ struct RefCountContext {
 
     void clear() { counts.clear(); }
 
+    bool isReferenceValid(void *ptr) { return counts.count(ptr) > 0; }
+
     void logInvalidReferences() {
         for (auto &[ptr, refRuntimeInfo] : counts) {
             context.logger.error("Retained {} reference(s) to handle {}",
@@ -128,6 +130,10 @@ struct RefCountContext {
         }
     }
 
+    void logInvalidReference(void *ptr) {
+        context.logger.error("There are no valid references to handle {}", ptr);
+    }
+
 } refCountContext;
 
 } // namespace ur_validation_layer