rename pushRingBuffer to processAnyTask and add comments

Author: a114j0y

orchagent/orch.cpp

@@ -335,36 +335,44 @@ void Consumer::execute()
     auto entries = std::make_shared<std::deque<KeyOpFieldsValuesTuple>>();
     getConsumerTable()->pops(*entries);
 
-    pushRingBuffer([=](){
-        addToSync(entries);
-    });
-
-    pushRingBuffer([=](){
-        drain();
-    });
+    processAnyTask(
+        // bundle tasks into a lambda function which takes no argument and returns void
+        // this lambda captures variables by value from the surrounding scope
+        [=](){
+            addToSync(entries);
+            drain();
+        }
+    );
 }
 
-void Executor::pushRingBuffer(AnyTask&& task)
+void Executor::processAnyTask(AnyTask&& task)
 {
+    // if either gRingBuffer isn't initialized or the ring thread isn't created
     if (!gRingBuffer || !gRingBuffer->thread_created) 
     {
-        // execute the task right now in this thread if gRingBuffer is not initialized
-        // or the ring thread is not created, or this executor is not served by gRingBuffer
+        // execute the input task immediately
         task();
     }
-    else if (!gRingBuffer->serves(getName())) // not served by ring thread
+
+    // Ring Buffer Logic
+
+    // if this executor isn't served by ring buffer
+    else if (!gRingBuffer->serves(getName()))
     {
+        // this executor should execute the input task in the main thread
+        // but to avoid thread issue, it should wait when the ring buffer is actively working
         while (!gRingBuffer->IsEmpty() || !gRingBuffer->IsIdle()) {
             gRingBuffer->notify();
             std::this_thread::sleep_for(std::chrono::milliseconds(SLEEP_MSECONDS));
         }
-        // if ring thread is enabled, make sure to execute task after the ring finishes its work
+        // execute task()
         task();
     }
     else
     {
-        // if this executor is served by gRingBuffer, push the task to gRingBuffer
-        // and notify the ring thread to flush gRingBuffer
+        // if this executor is served by ring buffer, 
+        // push the task to gRingBuffer
+        // this task would be executed in the ring thread, not here
         while (!gRingBuffer->push(task)) {
             gRingBuffer->notify();
             SWSS_LOG_WARN("ring is full...push again");

orchagent/orch.h

@@ -93,7 +93,7 @@ typedef std::pair<std::string, int> table_name_with_pri_t;
 
 class Orch;
 
-using AnyTask = std::function<void()>;
+using AnyTask = std::function<void()>; // represents a function with no argument and returns void
 
 class RingBuffer;
 
@@ -135,7 +135,7 @@ class Executor : public swss::Selectable
 
     Orch *getOrch() const { return m_orch; }
     static std::shared_ptr<RingBuffer> gRingBuffer;
-    void pushRingBuffer(AnyTask&& func);
+    void processAnyTask(AnyTask&& func);
 
 protected:
     swss::Selectable *m_selectable;

tests/mock_tests/orchdaemon_ut.cpp

@@ -141,18 +141,18 @@ namespace orchdaemon_test
         EXPECT_FALSE(gRingBuffer->serves("OTHER_TABLE"));
 
         int x = 0;
-        route_consumer->pushRingBuffer([&](){x=3;});
-        // verify `pushRingBuffer` is equivalent to executing the task immediately
+        route_consumer->processAnyTask([&](){x=3;});
+        // verify `processAnyTask` is equivalent to executing the task immediately
         EXPECT_TRUE(gRingBuffer->IsEmpty() && gRingBuffer->IsIdle() && !gRingBuffer->thread_created && x==3);
 
         gRingBuffer->thread_created = true; // set the flag to assume the ring thread is created (actually not)
 
-        // verify `pushRingBuffer` is equivalent to executing the task immediately when ring is empty and idle
-        other_consumer->pushRingBuffer([&](){x=4;});
+        // verify `processAnyTask` is equivalent to executing the task immediately when ring is empty and idle
+        other_consumer->processAnyTask([&](){x=4;});
         EXPECT_TRUE(gRingBuffer->IsEmpty() && gRingBuffer->IsIdle() && x==4);
 
-        route_consumer->pushRingBuffer([&](){x=5;});
-        // verify `pushRingBuffer` would not execute the task if thread_created is true
+        route_consumer->processAnyTask([&](){x=5;});
+        // verify `processAnyTask` would not execute the task if thread_created is true
         // it only pushes the task to the ring buffer, without executing it
         EXPECT_TRUE(!gRingBuffer->IsEmpty() && x==4);