spdlog: do not drop logger in destructor

For static objects, the order of destruction is in reverse of the order
of construction, but the latter is hard to control except among static
objects defined within the same translation unit. This means that spdlog
may be destructed before spdlog::drop() is invoked in the destructor,
which leads to a segmentation fault due to memory use-after-free.

Move call of spdlog::drop() from destructor to main() function, to
ensure the logger may be re-registered with the same name in tests.

Link: ros2/rclcpp#933
Link: gabime/spdlog#1738
Closes: https://hsdes.intel.com/appstore/article/#/22019839238
Signed-off-by: Peter Colberg <[email protected]>

libraries/afu-test/afu_test.h

@@ -186,8 +186,6 @@ class afu {
     app_.add_option("-t,--timeout", timeout_msec_, "test timeout (msec)")->default_str(std::to_string(timeout_msec_));
   }
   virtual ~afu() {
-    if (logger_)
-      spdlog::drop(logger_->name());
   }
 
   CLI::App & cli() { return app_; }
@@ -315,10 +313,16 @@ class afu {
 
     int res = open_handle(test->afu_id());
     if (res != exit_codes::not_run) {
-      return res;
+      goto done;
     }
 
-    return run(app, test);
+    res = run(app, test);
+
+done:
+    // Dropping a logger is optional, but not doing so will cause an exception
+    // when re-registering a logger with the same name, i.e., in test runs.
+    spdlog::drop(logger_->name());
+    return res;
   }
 
   virtual int run(CLI::App *app, command::ptr_t test)

samples/cxl_hello_fpga/he_cache_test.h

@@ -297,7 +297,6 @@ class afu {
   }
   virtual ~afu() {
     if (fd_ > 0) close(fd_);
-    if (logger_) spdlog::drop(logger_->name());
   }
 
   CLI::App &cli() { return app_; }

samples/cxl_host_exerciser/he_cache_test.h

@@ -304,8 +304,6 @@ class afu {
 
     if (fd_ > 0)
         close(fd_);
-    if (logger_)
-      spdlog::drop(logger_->name());
   }
 
   CLI::App &cli() { return app_; }