Merge pull request #481 from open-telemetry/main

[BUILD] Cleanup cppcheck warnings (open-telemetry#3619)

Author: malkia

.github/workflows/cppcheck.yml

@@ -1,11 +1,10 @@
-
 name: cppcheck
 
 on:
   push:
-    branches: [ main ]
+    branches: [main]
   pull_request:
-    branches: [ main ]
+    branches: [main]
 
 permissions:
   contents: read
@@ -66,12 +65,7 @@ jobs:
           set +e
           readonly WARNING_COUNT=`grep -c -E "\[.+\]" cppcheck.log`
           echo "cppcheck reported ${WARNING_COUNT} warning(s)"
-          # Acceptable limit, to decrease over time down to 0
-          readonly WARNING_LIMIT=10
-          # FAIL the build if WARNING_COUNT > WARNING_LIMIT
-          if [ $WARNING_COUNT -gt $WARNING_LIMIT ] ; then
-            exit 1
-          # WARN in annotations if WARNING_COUNT > 0
-          elif [ $WARNING_COUNT -gt 0 ] ; then
+          if [ $WARNING_COUNT -gt 0 ] ; then
             echo "::warning::cppcheck reported ${WARNING_COUNT} warning(s)"
+            exit 1
           fi

ext/include/opentelemetry/ext/http/client/curl/http_client_curl.h

@@ -323,6 +323,8 @@ class OPENTELEMETRY_EXPORT_TYPE HttpClient : public opentelemetry::ext::http::cl
 
   void SetMaxSessionsPerConnection(std::size_t max_requests_per_connection) noexcept override;
 
+  bool InternalCancelAllSessions() noexcept;
+
   inline uint64_t GetMaxSessionsPerConnection() const noexcept
   {
     return max_sessions_per_connection_;

ext/src/http/client/curl/http_client_curl.cc

@@ -302,7 +302,7 @@ HttpClient::~HttpClient()
     }
 
     // Force to abort all sessions
-    CancelAllSessions();
+    InternalCancelAllSessions();
 
     if (!background_thread)
     {
@@ -342,27 +342,7 @@ std::shared_ptr<opentelemetry::ext::http::client::Session> HttpClient::CreateSes
 
 bool HttpClient::CancelAllSessions() noexcept
 {
-  // CancelSession may change sessions_, we can not change a container while iterating it.
-  while (true)
-  {
-    std::unordered_map<uint64_t, std::shared_ptr<Session>> sessions;
-    {
-      // We can only cleanup session and curl handles in the IO thread.
-      std::lock_guard<std::mutex> lock_guard{sessions_m_};
-      sessions = sessions_;
-    }
-
-    if (sessions.empty())
-    {
-      break;
-    }
-
-    for (auto &session : sessions)
-    {
-      session.second->CancelSession();
-    }
-  }
-  return true;
+  return InternalCancelAllSessions();
 }
 
 bool HttpClient::FinishAllSessions() noexcept
@@ -435,6 +415,31 @@ void HttpClient::CleanupSession(uint64_t session_id)
   }
 }
 
+bool HttpClient::InternalCancelAllSessions() noexcept
+{
+  // CancelSession may change sessions_, we can not change a container while iterating it.
+  while (true)
+  {
+    std::unordered_map<uint64_t, std::shared_ptr<Session>> sessions;
+    {
+      // We can only cleanup session and curl handles in the IO thread.
+      std::lock_guard<std::mutex> lock_guard{sessions_m_};
+      sessions = sessions_;
+    }
+
+    if (sessions.empty())
+    {
+      break;
+    }
+
+    for (auto &session : sessions)
+    {
+      session.second->CancelSession();
+    }
+  }
+  return true;
+}
+
 bool HttpClient::MaybeSpawnBackgroundThread()
 {
   std::lock_guard<std::mutex> lock_guard{background_thread_m_};

sdk/include/opentelemetry/sdk/common/circular_buffer.h

@@ -181,7 +181,7 @@ class CircularBuffer
     {
       return {};
     }
-    auto data = data_.get();
+    AtomicUniquePtr<T> *data = data_.get();
     if (tail_index < head_index)
     {
       return CircularBufferRange<AtomicUniquePtr<T>>{nostd::span<AtomicUniquePtr<T>>{

sdk/include/opentelemetry/sdk/logs/batch_log_record_processor.h

@@ -93,10 +93,11 @@ class OPENTELEMETRY_EXPORT_TYPE BatchLogRecordProcessor : public LogRecordProces
 
   /**
    * Shuts down the processor and does any cleanup required. Completely drains the buffer/queue of
-   * all its logs and passes them to the exporter. Any subsequent calls to
-   * ForceFlush or Shutdown will return immediately without doing anything.
+   * all its logs and passes them to the exporter.
    *
-   * NOTE: Timeout functionality not supported yet.
+   * @param timeout minimum amount of microseconds to wait for shutdown before giving up and
+   * returning failure.
+   * @return true if the shutdown succeeded, false otherwise
    */
   bool Shutdown(
       std::chrono::microseconds timeout = (std::chrono::microseconds::max)()) noexcept override;
@@ -107,6 +108,13 @@ class OPENTELEMETRY_EXPORT_TYPE BatchLogRecordProcessor : public LogRecordProces
   ~BatchLogRecordProcessor() override;
 
 protected:
+  /**
+   * Shuts down the processor and does any cleanup required. Completely drains the buffer/queue of
+   * all its logs and passes them to the exporter.
+   */
+  bool InternalShutdown(
+      std::chrono::microseconds timeout = (std::chrono::microseconds::max)()) noexcept;
+
   /**
    * The background routine performed by the worker thread.
    */

sdk/include/opentelemetry/sdk/logs/multi_log_record_processor.h

@@ -51,13 +51,32 @@ class OPENTELEMETRY_EXPORT_TYPE MultiLogRecordProcessor : public LogRecordProces
   /**
    * Shuts down the processor and does any cleanup required.
    * ShutDown should only be called once for each processor.
-   * @param timeout minimum amount of microseconds to wait for
-   * shutdown before giving up and returning failure.
+   * @param timeout minimum amount of microseconds to wait for shutdown before giving up and
+   * returning failure.
    * @return true if the shutdown succeeded, false otherwise
    */
   bool Shutdown(
       std::chrono::microseconds timeout = (std::chrono::microseconds::max)()) noexcept override;
 
+protected:
+  /**
+   * Exports all log records that have not yet been exported to the configured Exporter.
+   * @param timeout that the forceflush is required to finish within.
+   * @return a result code indicating whether it succeeded, failed or timed out
+   */
+  bool InternalForceFlush(
+      std::chrono::microseconds timeout = (std::chrono::microseconds::max)()) noexcept;
+
+  /**
+   * Shuts down the processor and does any cleanup required.
+   * ShutDown should only be called once for each processor.
+   * @param timeout minimum amount of microseconds to wait for shutdown before giving up and
+   * returning failure.
+   * @return true if the shutdown succeeded, false otherwise
+   */
+  bool InternalShutdown(
+      std::chrono::microseconds timeout = (std::chrono::microseconds::max)()) noexcept;
+
 private:
   std::vector<std::unique_ptr<LogRecordProcessor>> processors_;
 };

sdk/include/opentelemetry/sdk/trace/batch_span_processor.h

@@ -91,10 +91,11 @@ class OPENTELEMETRY_EXPORT_TYPE BatchSpanProcessor : public SpanProcessor
 
   /**
    * Shuts down the processor and does any cleanup required. Completely drains the buffer/queue of
-   * all its ended spans and passes them to the exporter. Any subsequent calls to OnStart, OnEnd,
-   * ForceFlush or Shutdown will return immediately without doing anything.
+   * all its ended spans and passes them to the exporter.
    *
-   * NOTE: Timeout functionality not supported yet.
+   * @param timeout minimum amount of microseconds to wait for shutdown before giving up and
+   * returning failure.
+   * @return true if the shutdown succeeded, false otherwise
    */
   bool Shutdown(
       std::chrono::microseconds timeout = (std::chrono::microseconds::max)()) noexcept override;
@@ -108,6 +109,17 @@ class OPENTELEMETRY_EXPORT_TYPE BatchSpanProcessor : public SpanProcessor
   ~BatchSpanProcessor() override;
 
 protected:
+  /**
+   * Shuts down the processor and does any cleanup required. Completely drains the buffer/queue of
+   * all its ended spans and passes them to the exporter.
+   *
+   * @param timeout minimum amount of microseconds to wait for shutdown before giving up and
+   * returning failure.
+   * @return true if the shutdown succeeded, false otherwise
+   */
+  bool InternalShutdown(
+      std::chrono::microseconds timeout = (std::chrono::microseconds::max)()) noexcept;
+
   /**
    * The background routine performed by the worker thread.
    */

sdk/include/opentelemetry/sdk/trace/multi_span_processor.h

@@ -123,6 +123,19 @@ class MultiSpanProcessor : public SpanProcessor
 
   bool Shutdown(
       std::chrono::microseconds timeout = (std::chrono::microseconds::max)()) noexcept override
+  {
+    return InternalShutdown(timeout);
+  }
+
+  ~MultiSpanProcessor() override
+  {
+    InternalShutdown();
+    Cleanup();
+  }
+
+protected:
+  bool InternalShutdown(
+      std::chrono::microseconds timeout = (std::chrono::microseconds::max)()) noexcept
   {
     bool result         = true;
     ProcessorNode *node = head_;
@@ -135,12 +148,6 @@ class MultiSpanProcessor : public SpanProcessor
     return result;
   }
 
-  ~MultiSpanProcessor() override
-  {
-    Shutdown();
-    Cleanup();
-  }
-
 private:
   struct ProcessorNode
   {

sdk/include/opentelemetry/sdk/trace/simple_processor.h

@@ -76,6 +76,15 @@ class SimpleSpanProcessor : public SpanProcessor
 
   bool Shutdown(
       std::chrono::microseconds timeout = (std::chrono::microseconds::max)()) noexcept override
+  {
+    return InternalShutdown(timeout);
+  }
+
+  ~SimpleSpanProcessor() override { InternalShutdown(); }
+
+protected:
+  bool InternalShutdown(
+      std::chrono::microseconds timeout = (std::chrono::microseconds::max)()) noexcept
   {
     // We only call shutdown ONCE.
     if (exporter_ != nullptr && !shutdown_latch_.test_and_set(std::memory_order_acquire))
@@ -85,8 +94,6 @@ class SimpleSpanProcessor : public SpanProcessor
     return true;
   }
 
-  ~SimpleSpanProcessor() override { Shutdown(); }
-
 private:
   std::unique_ptr<SpanExporter> exporter_;
   opentelemetry::common::SpinLockMutex lock_;

sdk/src/logs/batch_log_record_processor.cc

@@ -368,6 +368,19 @@ void BatchLogRecordProcessor::GetWaitAdjustedTime(
 }
 
 bool BatchLogRecordProcessor::Shutdown(std::chrono::microseconds timeout) noexcept
+{
+  return InternalShutdown(timeout);
+}
+
+BatchLogRecordProcessor::~BatchLogRecordProcessor()
+{
+  if (synchronization_data_->is_shutdown.load() == false)
+  {
+    InternalShutdown();
+  }
+}
+
+bool BatchLogRecordProcessor::InternalShutdown(std::chrono::microseconds timeout) noexcept
 {
   auto start_time = std::chrono::system_clock::now();
 
@@ -391,14 +404,6 @@ bool BatchLogRecordProcessor::Shutdown(std::chrono::microseconds timeout) noexce
   return true;
 }
 
-BatchLogRecordProcessor::~BatchLogRecordProcessor()
-{
-  if (synchronization_data_->is_shutdown.load() == false)
-  {
-    Shutdown();
-  }
-}
-
 }  // namespace logs
 }  // namespace sdk
 OPENTELEMETRY_END_NAMESPACE