Cleanup documentation and comments

Signed-off-by: Neil R. Spruit <neil.r.spruit@intel.com>

Author: nrspruit

include/loader/ze_loader.h

@@ -95,17 +95,19 @@ ZE_DLLEXPORT bool ZE_APICALL
 zelCheckIsLoaderInTearDown();
 
 ///////////////////////////////////////////////////////////////////////////////
-/// @brief Exported function for registering a callback to indicate teardown.
-/// @details The callback function will be invoked when the loader is in teardown.
-///
+/// @brief Exported function for registering a teardown callback.
+/// @details The provided application callback will be invoked when the loader enters teardown.
+///          The loader's callback and the index for this application's callback reference are returned for later reference.
+///          The loader's callback will be invoked when the application is torndown to inform the loader that the application
+///          is being torn down and cannot be called to inform the loader of its teardown.
 typedef void (*zel_loader_teardown_callback_t)();
 typedef void (*zel_application_teardown_callback_t)(uint32_t index);
 
 ZE_DLLEXPORT ze_result_t ZE_APICALL
 zelRegisterTeardownCallback(
-   zel_loader_teardown_callback_t application_callback, // [in] Pointer to the user's application callback function
-   zel_application_teardown_callback_t *loader_callback,      // [out] Pointer to the L0 Loader's callback function 
-   uint32_t *index // [out] Index of the callback function
+   zel_loader_teardown_callback_t application_callback, // [in] Application's callback function to be called during loader teardown
+   zel_application_teardown_callback_t *loader_callback, // [out] Pointer to the loader's callback function
+   uint32_t *index // [out] Index assigned to the registered callback
 );
 
 ///////////////////////////////////////////////////////////////////////////////

source/lib/ze_lib.cpp

@@ -29,12 +29,10 @@ namespace ze_lib
     bool delayContextDestruction = false;
     bool loaderTeardownCallbackReceived = false;
     void staticLoaderTeardownCallback() {
-        printf("ze_lib Static Teardown Callback\n");
         loaderTeardownCallbackReceived = true;
     }
     #endif
     void applicationTeardownCallback(uint32_t index) {
-        printf("ze_lib Application Teardown Callback %d\n", index);
         if (ze_lib::context->teardownCallbacks.find(index) != ze_lib::context->teardownCallbacks.end()) {
             ze_lib::context->teardownCallbacks.erase(index);
         }
@@ -50,9 +48,6 @@ namespace ze_lib
     ///////////////////////////////////////////////////////////////////////////////
     __zedlllocal context_t::~context_t()
     {
-        if (debugTraceEnabled) {
-            debug_trace_message("ze_lib Context Destructor", "");
-        }
 #ifdef DYNAMIC_LOAD_LOADER
         if (!loaderTeardownCallbackReceived) {
             loaderTeardownCallback(loaderTeardownCallbackIndex);
@@ -372,8 +367,8 @@ namespace ze_lib
             }
             // Get the function pointer for zelRegisterTeardownCallback from the loader
             typedef ze_result_t (ZE_APICALL *zelRegisterTeardownCallback_t)(
-                zel_loader_teardown_callback_t, 
-                zel_application_teardown_callback_t*, 
+                zel_loader_teardown_callback_t,
+                zel_application_teardown_callback_t*,
                 uint32_t*);
             auto pfnZelRegisterTeardownCallback = reinterpret_cast<zelRegisterTeardownCallback_t>(
                 GET_FUNCTION_PTR(loader, "zelRegisterTeardownCallback"));
@@ -518,11 +513,11 @@ void stabilityCheck(std::promise<int> stabilityPromise) {
 }
 #endif
 
-ZE_DLLEXPORT ze_result_t ZE_APICALL
+ze_result_t ZE_APICALL
 zelRegisterTeardownCallback(
-   zel_loader_teardown_callback_t application_callback, // [in] Pointer to the user's application callback function
-   zel_application_teardown_callback_t *loader_callback,      // [out] Pointer to the L0 Loader's callback function 
-   uint32_t *index // [out] Index of the callback function
+   zel_loader_teardown_callback_t application_callback, // [in] Application's callback function to be called during loader teardown
+   zel_application_teardown_callback_t *loader_callback, // [out] Pointer to the loader's callback function
+   uint32_t *index // [out] Index assigned to the registered callback
 ) {
     ze_result_t result = ZE_RESULT_SUCCESS;
     if (nullptr == application_callback) {

source/lib/ze_lib.h

@@ -17,16 +17,14 @@
 #include "layers/zel_tracing_api.h"
 #include "layers/zel_tracing_ddi.h"
 #include "../utils/logging.h"
+#include "loader/ze_loader.h"
 #include "ze_util.h"
 #include <vector>
 #include <mutex>
 #include <atomic>
 #include <typeinfo>
 #include <iostream>
 
-typedef void (*zel_loader_teardown_callback_t)();
-typedef void (*zel_application_teardown_callback_t)(uint32_t index);
-
 namespace ze_lib
 {
     ///////////////////////////////////////////////////////////////////////////////