Fixed coverity in acl_hal_mmd.cpp: Resource leak (RESOURCE_LEAK)

mmd_libraries were not closed after execution, which causes memory leaks. But mmd_libraries cannot be closed trivially since closing the library invalidates the symbol return by dlsym(), which means calling the function further down is undefined behaviour.
To solve this issues, I added a `dl_wrapper_t` vector as a global initialized vector that would be deallocated when closing the runtime library. This vector would contain all the opened libraries that would be closed by the destructor of `dl_wrapper_t` once the vector deallocates.

Author: haoxian2

include/acl_hal_mmd.h

@@ -151,6 +151,38 @@ typedef struct {
       int handle, const std::string &signal_name, unsigned int &finish_counter);
 } acl_mmd_dispatch_t;
 
+// Helper function needed for dl libraries wrapper
+void *my_dlopen(const char *library_name, char **error_msg);
+void *my_dlsym(void *library, const char *function_name, char **error_msg);
+
+// Wrapper for dl libraries
+struct dl_wrapper_t {
+  void *mmd_lib;
+  dl_wrapper_t(const char *library_name, char **error_msg) {
+    this->mmd_lib = my_dlopen(library_name, error_msg);
+  }
+  ~dl_wrapper_t() {
+    if (this->mmd_lib) {
+#ifdef _WIN32
+      FreeLibrary((HMODULE)this->mmd_lib);
+#else
+      dlclose(this->mmd_lib);
+#endif
+    }
+  }
+  // prohibit copying to avoid double-close of handle
+  dl_wrapper_t(const dl_wrapper_t &) = delete;
+  dl_wrapper_t &operator=(const dl_wrapper_t &) = delete;
+
+  // enable move for vector operations
+  dl_wrapper_t(dl_wrapper_t &&) noexcept {};
+
+  // return symbol
+  void *sym(const char *function_name, char **error_msg) {
+    return my_dlsym(this->mmd_lib, function_name, error_msg);
+  }
+};
+
 typedef struct {
   int handle;
   std::string name;

src/acl_hal_mmd.cpp

@@ -189,6 +189,7 @@ const static size_t MIN_SOF_SIZE = 1;
 const static size_t MIN_PLL_CONFIG_SIZE = 1;
 
 std::vector<acl_mmd_dispatch_t> internal_mmd_dispatch;
+std::vector<dl_wrapper_t> dl_wrapper_list;
 
 // Dynamically load board mmd & symbols
 static size_t num_board_pkgs;
@@ -568,8 +569,9 @@ cl_bool l_load_single_board_library(const char *library_name,
       return CL_FALSE;
   }
 #endif
-  auto *mmd_library = my_dlopen(library_name, &error_msg);
-  if (!mmd_library) {
+  dl_wrapper_list.emplace_back(library_name, &error_msg);
+  if (!dl_wrapper_list.back().mmd_lib) {
+    dl_wrapper_list.pop_back();
     std::cout << "Error: Could not load board library " << library_name;
     if (error_msg && error_msg[0] != '\0') {
       std::cout << " (error_msg: " << error_msg << ")";
@@ -579,17 +581,18 @@ cl_bool l_load_single_board_library(const char *library_name,
   }
 
   auto *test_symbol =
-      my_dlsym(mmd_library, "aocl_mmd_get_offline_info", &error_msg);
+      dl_wrapper_list.back().sym("aocl_mmd_get_offline_info", &error_msg);
   if (!test_symbol) {
     // On Linux, for custom libraries close the library (which was opened
     // locally) and then reopen globally. For Windows, there is no option (i.e.
     // it is always global)
 #ifdef __linux__
-    my_dlclose(mmd_library);
+    my_dlclose(dl_wrapper_list.back().mmd_lib);
     ACL_HAL_DEBUG_MSG_VERBOSE(
         1, "This library is a custom library. Opening globally.\n");
-    mmd_library = my_dlopen_global(library_name, &error_msg);
-    if (!mmd_library) {
+    dl_wrapper_list.back().mmd_lib = my_dlopen_global(library_name, &error_msg);
+    if (!dl_wrapper_list.back().mmd_lib) {
+      dl_wrapper_list.pop_back();
       std::cout << "Error: Could not load custom library " << library_name;
       if (error_msg && error_msg[0] != '\0') {
         std::cout << " (error_msg: " << error_msg << ")";
@@ -600,9 +603,9 @@ cl_bool l_load_single_board_library(const char *library_name,
 #endif
   } else {
     if (load_libraries) {
-      auto result =
-          l_load_board_functions(&(internal_mmd_dispatch[num_boards_found]),
-                                 library_name, mmd_library, error_msg);
+      auto result = l_load_board_functions(
+          &(internal_mmd_dispatch[num_boards_found]), library_name,
+          dl_wrapper_list.back().mmd_lib, error_msg);
       if (result == CL_FALSE) {
         std::cout << "Error: Could not load board library " << library_name
                   << " due to failure to load symbols\n";
@@ -611,7 +614,7 @@ cl_bool l_load_single_board_library(const char *library_name,
     }
     ++num_boards_found;
   }
-
+  
   return CL_TRUE;
 }
 
@@ -855,6 +858,7 @@ cl_bool l_load_board_libraries(cl_bool load_libraries) {
       }
       fin.close();
     }
+    closedir(dir);
   }
 
   if (num_vendor_files_found == 0) {
@@ -876,8 +880,6 @@ cl_bool l_load_board_libraries(cl_bool load_libraries) {
     }
   }
 
-  if (dir)
-    closedir(dir);
   return num_boards_found == 0 ? CL_FALSE : CL_TRUE;
 }
 #endif
@@ -1156,9 +1158,10 @@ static acl_mmd_dispatch_t *get_msim_mmd_layer() {
       ipa_simulator ? mmd_lib_name_ipa : mmd_lib_name_aoc;
 
   char *error_msg = nullptr;
-  auto *mmd_lib = my_dlopen(mmd_lib_name, &error_msg);
+  dl_wrapper_list.emplace_back(mmd_lib_name, &error_msg);
   typedef acl_mmd_dispatch_t *(*fcn_type)();
-  if (!mmd_lib) {
+  if (!dl_wrapper_list.back().mmd_lib) {
+    dl_wrapper_list.pop_back();
     std::cout << "Error: Could not load simulation MMD library "
               << mmd_lib_name;
     if (error_msg && error_msg[0] != '\0') {
@@ -1167,8 +1170,9 @@ static acl_mmd_dispatch_t *get_msim_mmd_layer() {
     std::cout << "\n";
     return nullptr;
   }
-  auto *sym = my_dlsym(mmd_lib, sym_name, &error_msg);
+  auto *sym = dl_wrapper_list.back().sym(sym_name, &error_msg);
   if (!sym) {
+    dl_wrapper_list.pop_back();
     std::cout << "Error: Symbol " << sym_name
               << " not found in simulation MMD library ";
     if (error_msg && error_msg[0] != '\0') {