(Addon Manager) Add dlclose & show error logs instead of asserting 60/319960/3
authorAdeel Kazmi <adeel.kazmi@samsung.com>
Tue, 5 Nov 2024 12:07:11 +0000 (12:07 +0000)
committerAdeel Kazmi <adeel.kazmi@samsung.com>
Tue, 5 Nov 2024 13:09:56 +0000 (13:09 +0000)
Change-Id: I151a341cb65a27b716eb4e97cc9d3fe92330dd4e

automated-tests/src/dali-adaptor-internal/utc-Dali-AddOns.cpp
dali/internal/addons/linux/addon-manager-impl-linux.cpp

index a08c635a713b6ecc13bae58c9188ce1f0891b30a..5585f2618437a6bbaf19d7874e06dd6752078cc5 100644 (file)
@@ -39,6 +39,7 @@ struct TestAddOn : public Dali::AddOn::AddOnBinder
   }
 
   ADDON_BIND_FUNCTION(GetLifecycleStatus, bool());
+  ADDON_BIND_FUNCTION(FakeFunction, void()); // Function doesn't exist - for a negative test
 };
 
 int UtcDaliTestAddOnInterface(void)
@@ -70,6 +71,20 @@ int UtcDaliTestAddOnInterface(void)
   END_TEST;
 }
 
+int UtcDaliTestAddOnInterfaceN(void)
+{
+  TestApplication application;
+  // Create AddOnManager using internal factory
+  auto addOnManager = CreateAddOnManager();
+
+  TestAddOn addon;
+
+  DALI_TEST_EQUALS(addon.IsValid(), true, TEST_LOCATION);
+  DALI_TEST_CHECK(addon.FakeFunction == nullptr); // Function should not exist
+
+  END_TEST;
+}
+
 int UtcDaliTestAddOnManager(void)
 {
   TestApplication application;
index 13bff75b0a152a30dae7a8b41fe2ec72b1944ff0..4f142f924bf212e91bca2ddecacbdc65c28fe64d 100644 (file)
 #include <iterator>
 #include <sstream>
 
-namespace Dali
-{
-namespace Internal
+namespace Dali::Internal
 {
 AddOnManagerLinux::AddOnManagerLinux() = default;
 
-AddOnManagerLinux::~AddOnManagerLinux() = default;
+AddOnManagerLinux::~AddOnManagerLinux()
+{
+  // Close all the libraries
+  for(auto& addon : mAddOnCache)
+  {
+    if(addon.libHandle)
+    {
+      dlclose(addon.libHandle);
+    }
+  }
+}
 
 void AddOnManagerLinux::RegisterAddOnDispatchTable(const AddOnDispatchTable* dispatchTable)
 {
@@ -97,20 +105,30 @@ std::vector<std::string> AddOnManagerLinux::EnumerateAddOns()
       fullPath += "/";
       fullPath += name;
 
+      // Get cache count before we load the library to ensure the library does indeed load an addon
+      const auto cacheCountBeforeLibraryLoad = mAddOnCache.size();
+
       // open lib, look for essential symbols. The libary is opened with RTLD_DEEPBIND flag
       // to make sure the local symbol table is going to be used during lookup first.
       auto* handle = dlopen(fullPath.c_str(), RTLD_DEEPBIND | RTLD_LAZY);
       if(handle)
       {
-        DALI_ASSERT_ALWAYS(!mAddOnCache.empty() && "AddOnCache should not be empty!");
-
-        auto&     cacheEntry = mAddOnCache.back();
-        AddOnInfo info{};
-        cacheEntry.GetAddOnInfo(info);
-        cacheEntry.info      = info;
-        cacheEntry.addOnLib  = fullPath;
-        cacheEntry.libHandle = handle;
-        cacheEntry.opened    = false;
+        // Addon Cache size should have increased by 1
+        const auto cacheCountAfterLibraryLoad = mAddOnCache.size();
+        if((cacheCountBeforeLibraryLoad + 1) == cacheCountAfterLibraryLoad)
+        {
+          auto&     cacheEntry = mAddOnCache.back();
+          AddOnInfo info{};
+          cacheEntry.GetAddOnInfo(info);
+          cacheEntry.info      = info;
+          cacheEntry.addOnLib  = fullPath;
+          cacheEntry.libHandle = handle;
+          cacheEntry.opened    = false;
+        }
+        else
+        {
+          DALI_LOG_ERROR("Can't find any addon in %s library\n", fullPath.c_str());
+        }
       }
       else
       {
@@ -208,25 +226,32 @@ AddOnLibrary AddOnManagerLinux::LoadAddOn(const std::string& addonName, const st
   }
   else
   {
+    // Get cache count before we load the library to ensure the library does indeed load an addon
+    const auto cacheCountBeforeLibraryLoad = mAddOnCache.size();
+
     // Attempt to load the library if not found in the cache
     auto* handle = dlopen(libraryName.c_str(), RTLD_DEEPBIND | RTLD_LAZY);
     if(handle)
     {
-      // Can only have one addon per library so just check if the last added item to the cache is the addon we want
-      DALI_ASSERT_ALWAYS(!mAddOnCache.empty() && "AddOnCache should not be empty!");
-
-      auto&     cacheEntry = mAddOnCache.back();
-      AddOnInfo info{};
-      cacheEntry.GetAddOnInfo(info);
-      if(info.name == addonName)
+      // Addon Cache size should have increased by 1
+      const auto cacheCountAfterLibraryLoad = mAddOnCache.size();
+      if((cacheCountBeforeLibraryLoad + 1) == cacheCountAfterLibraryLoad)
       {
-        cacheEntry.info      = info;
-        cacheEntry.addOnLib  = libraryName;
-        cacheEntry.libHandle = handle;
-        cacheEntry.opened    = true;
-        addOnLibrary         = reinterpret_cast<void*>(mAddOnCache.size());
+        // Can only have one addon per library so just check if the last added item to the cache is the addon we want
+        auto&     cacheEntry = mAddOnCache.back();
+        AddOnInfo info{};
+        cacheEntry.GetAddOnInfo(info);
+        if(info.name == addonName)
+        {
+          cacheEntry.info      = info;
+          cacheEntry.addOnLib  = libraryName;
+          cacheEntry.libHandle = handle;
+          cacheEntry.opened    = true;
+          addOnLibrary         = reinterpret_cast<void*>(cacheCountAfterLibraryLoad);
+        }
       }
-      else
+
+      if(!addOnLibrary)
       {
         DALI_LOG_ERROR("Can't find %s addon in %s library\n", addonName.c_str(), libraryName.c_str());
       }
@@ -241,16 +266,14 @@ AddOnLibrary AddOnManagerLinux::LoadAddOn(const std::string& addonName, const st
 
 void* AddOnManagerLinux::GetGlobalProc(const Dali::AddOnLibrary& addonHandle, const char* procName)
 {
-  if(!addonHandle)
+  auto index = (intptr_t(addonHandle));
+  if(index < 1 && index > static_cast<intptr_t>(mAddOnCache.size()))
   {
+    DALI_LOG_ERROR("Invalid AddOn handle!\n");
     return nullptr;
   }
 
-  auto index = (intptr_t(addonHandle));
-  DALI_ASSERT_ALWAYS(index >= 1 && index <= static_cast<intptr_t>(mAddOnCache.size()) && "Invalid AddOn handle!");
-
   const auto& entry = mAddOnCache[index - 1];
-
   if(entry.opened && entry.libHandle)
   {
     // First call into dispatch table
@@ -262,23 +285,20 @@ void* AddOnManagerLinux::GetGlobalProc(const Dali::AddOnLibrary& addonHandle, co
     }
     return retval;
   }
-  else
-  {
-    DALI_LOG_ERROR("AddOn: GetGlobalProc() library failed!\n");
-  }
+
+  DALI_LOG_ERROR("AddOn: GetGlobalProc() library failed!\n");
   return nullptr;
 }
 
 void* AddOnManagerLinux::GetInstanceProc(const Dali::AddOnLibrary& addonHandle, const char* procName)
 {
-  if(!addonHandle)
+  auto index = (intptr_t(addonHandle));
+  if(index < 1 && index > static_cast<intptr_t>(mAddOnCache.size()))
   {
+    DALI_LOG_ERROR("Invalid AddOn handle!\n");
     return nullptr;
   }
 
-  auto index = (intptr_t(addonHandle));
-  DALI_ASSERT_ALWAYS(index >= 1 && index <= static_cast<intptr_t>(mAddOnCache.size()) && "Invalid AddOn handle!");
-
   const auto& entry = mAddOnCache[index - 1];
   if(entry.opened && entry.libHandle)
   {
@@ -291,6 +311,8 @@ void* AddOnManagerLinux::GetInstanceProc(const Dali::AddOnLibrary& addonHandle,
     }
     return retval;
   }
+
+  DALI_LOG_ERROR("AddOn: GetInstanceProc() library failed!\n");
   return nullptr;
 }
 
@@ -334,5 +356,4 @@ void AddOnManagerLinux::InvokeLifecycleFunction(uint32_t lifecycleEvent)
   }
 }
 
-} // namespace Internal
-} // namespace Dali
\ No newline at end of file
+} // namespace Dali::Internal
\ No newline at end of file