Envoy源碼是如何分析Dispatcher的

Envoy源碼是如何分析Dispatcher的，相信很多沒有經驗的人對此束手無策，為此本文總結了問題出現的原因和解決方法，通過這篇文章希望你能解決這個問題。

Dispatcher

在Envoy的代碼中Dispatcher是隨處可見的，可以說在Envoy中有著舉足輕重的地位，一個Dispatcher就是一個EventLoop，其承擔了任務隊列、網絡事件處理、定時器、信號處理等核心功能。在Envoy threading model這篇文章所提到的EventLoop(Each worker thread runs a “non-blocking” event loop)指的就是這個Dispatcher對象。這個部分的代碼相對較獨立，和其他模塊耦合也比較少，但重要性卻不言而喻。下面是與Dispatcher相關的類圖，在接下來會對其中的關鍵概念進行介紹。

cdn.nlark.com/lark/0/2018/png/2826/1538970258265-1c4ce7cc-9283-48c4-81d2-ed4c595afb69.png">

Dispatcher 和 Libevent

Dispatcher本質上就是一個EventLoop，Envoy并沒有重新實現，而是復用了Libevent中的event_base，在Libevent的基礎上進行了二次封裝并抽象出一些事件類，比如FileEvent、SignalEvent、Timer等。Libevent是一個C庫，而Envoy是C++，為了避免手動管理這些C結構的內存，Envoy通過繼承unique_ptr的方式重新封裝了這些libevent暴露出來的C結構。

template <class T, void (*deleter)(T*)>
class CSmartPtr : public std::unique_ptr<T, void (*)(T*)> {
public:
  CSmartPtr() : std::unique_ptr<T, void (*)(T*)>(nullptr, deleter) {}
  CSmartPtr(T* object) : std::unique_ptr<T, void (*)(T*)>(object, deleter) {}
};

通過CSmartPtr就可以將Libevent中的一些C數據結構的內存通過RAII機制自動管理起來，使用方式如下:

extern "C">

在Libevent中無論是定時器到期、收到信號、還是文件可讀寫等都是事件，統一使用event類型來表示，Envoy中則將event作為ImplBase的成員，然后讓所有的事件類型的對象都繼承ImplBase，從而實現了事件的抽象。

class ImplBase {
protected:
  ~ImplBase();

  event raw_event_;
};

SignalEvent

SignalEvent的實現很簡單，通過evsignal_assign來初始化事件，然后通過evsignal_add添加事件使事件成為未決狀態(關于Libevent事件狀態見附錄)。

class SignalEventImpl : public SignalEvent, ImplBase {
public:
  // signal_num: 要設置的信號值
  // cb: 信號事件的處理函數
  SignalEventImpl(DispatcherImpl& dispatcher, int signal_num, SignalCb cb);
private:
  SignalCb cb_;
};

SignalEventImpl::SignalEventImpl(DispatcherImpl& dispatcher, 
                                 int signal_num, SignalCb cb) : cb_(cb) {
  evsignal_assign(
      &raw_event_, &dispatcher.base(), signal_num,
      [](evutil_socket_t, short, void* arg) -> void { 
          static_cast<SignalEventImpl*>(arg)->cb_(); },
      this);
  evsignal_add(&raw_event_, nullptr);
}

Timer

Timer事件暴露了兩個接口一個用于關閉Timer，另外一個則用于啟動Timer，需要傳遞一個時間來設置Timer的到期時間間隔。

class Timer {
public:
  virtual ~Timer() {}
  virtual void disableTimer() PURE;
  virtual void enableTimer(const std::chrono::milliseconds& d) PURE;
};

創建Timer的時候會通過evtimer_assgin對event進行初始化，這個時候事件還處于未決狀態而不會觸發，需要通過event_add添加到Dispatcher中才能被觸發。

class TimerImpl : public Timer, ImplBase {
public:
  TimerImpl(Libevent::BasePtr& libevent, TimerCb cb);

  // Timer
  void disableTimer() override;
  void enableTimer(const std::chrono::milliseconds& d) override;

private:
  TimerCb cb_;
};

TimerImpl::TimerImpl(DispatcherImpl& dispatcher, TimerCb cb) : cb_(cb) {
  ASSERT(cb_);
  evtimer_assign(
      &raw_event_, &dispatcher.base(),
      [](evutil_socket_t, short, void* arg) -> void { 
          static_cast<TimerImpl*>(arg)->cb_(); }, 
      this);
}

disableTimer被調用時其內部會調用event_del來刪除事件，使事件成為非未決狀態，enableTimer被調用時則間接調用event_add使事件成為未決狀態，這樣一旦超時時間到了就會觸發超時事件。

void TimerImpl::disableTimer() { event_del(&raw_event_); }
void TimerImpl::enableTimer(const std::chrono::milliseconds& d) {
  if (d.count() == 0) {
    event_active(&raw_event_, EV_TIMEOUT, 0);
  } else {
    std::chrono::microseconds us = 
          std::chrono::duration_cast<std::chrono::microseconds>(d);
    timeval tv;
    tv.tv_sec = us.count() / 1000000;
    tv.tv_usec = us.count() % 1000000;
    event_add(&raw_event_, &tv);
  }
}

上面的代碼在計算timer時間timeval的時候實現的并不優雅，應該避免使用像1000000這樣的不具備可讀性的數字常量，社區中有人建議可以改成如下的形式。

auto secs = std::chrono::duration_cast<std::chrono::seconds>(d);
auto usecs = 
  std::chrono::duration_cast<std::chrono::microseconds>(d - secs);
tv.tv_secs = secs.count();
tv.tv_usecs = usecs.count();

FileEvent

socket套接字相關的事件被封裝為FileEvent，其上暴露了二個接口：activate用于主動觸發事件，典型的使用場景比如: 喚醒EventLoop、Write Buffer有數據，可以主動觸發下可寫事件(Envoy中的典型使用場景)等；setEnabled用于設置事件類型，將事件添加到EventLoop中使其成為未決狀態。

void FileEventImpl::activate(uint32_t events) {
  int libevent_events = 0;
  if (events & FileReadyType::Read) {
    libevent_events |= EV_READ;
  }
  if (events & FileReadyType::Write) {
    libevent_events |= EV_WRITE;
  }
  if (events & FileReadyType::Closed) {
    libevent_events |= EV_CLOSED;
  }
  ASSERT(libevent_events);
  event_active(&raw_event_, libevent_events, 0);
}

void FileEventImpl::setEnabled(uint32_t events) {
  event_del(&raw_event_);
  assignEvents(events);
  event_add(&raw_event_, nullptr);
}

任務隊列

Dispatcher的內部有一個任務隊列，也會創建一個線程專們處理任務隊列中的任務。通過Dispatcher的post方法可以將任務投遞到任務隊列中，交給Dispatcher內的線程去處理。

void DispatcherImpl::post(std::function<void()> callback) {
  bool do_post;
  {
    Thread::LockGuard lock(post_lock_);
    do_post = post_callbacks_.empty();
    post_callbacks_.push_back(callback);
  }
  if (do_post) {
    post_timer_->enableTimer(std::chrono::milliseconds(0));
  }
}

post方法將傳遞進來的callback所代表的任務，添加到post_callbacks_所代表的類型為vector<callback>的成員表變量中。如果post_callbacks_為空的話，說明背后的處理線程是處于非活動狀態，這時通過post_timer_設置一個超時時間時間為0的方式來喚醒它。post_timer_在構造的時候就已經設置好對應的callback為runPostCallbacks，對應代碼如下:

DispatcherImpl::DispatcherImpl(TimeSystem& time_system,
                               Buffer::WatermarkFactoryPtr&& factory)
    : ......
      post_timer_(createTimer([this]() -> void { runPostCallbacks(); })),
      current_to_delete_(&to_delete_1_) {
  RELEASE_ASSERT(Libevent::Global::initialized(), "");
}

runPostCallbacks是一個while循環，每次都從post_callbacks_中取出一個callback所代表的任務去運行，直到post_callbacks_為空。每次運行runPostCallbacks都會確保所有的任務都執行完。顯然，在runPostCallbacks被線程執行的期間如果post進來了新的任務，那么新任務直接追加到post_callbacks_尾部即可，而無需做喚醒線程這一動作。

void DispatcherImpl::runPostCallbacks() {
  while (true) {
    std::function<void()> callback;
    {
      Thread::LockGuard lock(post_lock_);
      if (post_callbacks_.empty()) {
        return;
      }
      callback = post_callbacks_.front();
      post_callbacks_.pop_front();
    }
    callback();
  }
}

DeferredDeletable

最后講一下Dispatcher中比較難理解也很重要的DeferredDeletable，它是一個空接口，所有要進行延遲析構的對象都要繼承自這個空接口。在Envoy的代碼中像下面這樣繼承自DeferredDeletable的類隨處可見。

class DeferredDeletable {
public:
  virtual ~DeferredDeletable() {}
};

那何為延遲析構呢？用在哪個場景呢?延遲析構指的是將析構的動作交由Dispatcher來完成，所以DeferredDeletable和Dispatcher密切相關。Dispatcher對象有一個vector保存了所有要延遲析構的對象。

class DispatcherImpl : public Dispatcher {
  ......
 private:
  ........
  std::vector<DeferredDeletablePtr> to_delete_1_;
  std::vector<DeferredDeletablePtr> to_delete_2_;
  std::vector<DeferredDeletablePtr>* current_to_delete_;
 }

to_delete_1_和to_delete_2_就是用來存放所有的要延遲析構的對象，這里使用兩個vector存放，為什么要這樣做呢?。current_to_delete_始終指向當前正要析構的對象列表，每次執行完析構后就交替指向另外一個對象列表，來回交替。

void DispatcherImpl::clearDeferredDeleteList() {
  ASSERT(isThreadSafe());
  std::vector<DeferredDeletablePtr>* to_delete = current_to_delete_;
  size_t num_to_delete = to_delete->size();
  if (deferred_deleting_ || !num_to_delete) {
    return;
  }
  ENVOY_LOG(trace, "clearing deferred deletion list (size={})", num_to_delete);
  if (current_to_delete_ == &to_delete_1_) {
    current_to_delete_ = &to_delete_2_;
  } else {
    current_to_delete_ = &to_delete_1_;
  }
  deferred_deleting_ = true;
  for (size_t i = 0; i < num_to_delete; i++) {
    (*to_delete)[i].reset();
  }

  to_delete->clear();
  deferred_deleting_ = false;
}

上面的代碼在執行對象析構的時候先使用to_delete來指向當前正要析構的對象列表，然后將current_to_delete_指向另外一個列表，這樣在添加延遲刪除的對象時，就可以做到安全的把對象添加到列表中了。因為deferredDelete和clearDeferredDeleteList都是在同一個線程中運行，所以current_to_delete_是一個普通的指針，可以安全的更改指針指向另外一個，而不用擔心有線程安全問題。

void DispatcherImpl::deferredDelete(DeferredDeletablePtr&& to_delete) {
  ASSERT(isThreadSafe());
  current_to_delete_->emplace_back(std::move(to_delete));
  ENVOY_LOG(trace, "item added to deferred deletion list (size={})", current_to_delete_->size());
  if (1 == current_to_delete_->size()) {
    deferred_delete_timer_->enableTimer(std::chrono::milliseconds(0));
  }
}

當有要進行延遲析構的對象時，調用deferredDelete即可，這個函數內部會通過current_to_delete_把對象放到要延遲析構的列表中，最后判斷下當前要延遲析構的列表大小是否是1，如果是1表明這是第一次添加延遲析構的對象，那么就需要通過deferred_delete_timer_把背后的線程喚醒執行clearDeferredDeleteList函數。這樣做的原因是避免多次喚醒，因為有一種情況是線程已經喚醒了正在執行clearDeferredDeleteList，在這個過程中又有其他的對象需要析構而加入到vector中。

到此為止deferredDelete的實現原理就基本分析完了，可以看出它的實現和任務隊列的實現很類似，只不過一個是循環執行callback所代表的任務，另一個是對對象進行析構。最后我們來看一下deferredDelete的應用場景，卻“為何要進行延遲析構?”在Envoy的源代碼中經常會看到像下面這樣的代碼片段。

ConnectionImpl::ConnectionImpl(Event::Dispatcher& dispatcher, 
                               ConnectionSocketPtr&& socket,
                               TransportSocketPtr&& transport_socket,
                               bool connected) {
......
  }
  // 傳遞裸指針到回調中
  file_event_ = dispatcher_.createFileEvent(
      fd(), [this](uint32_t events) -> void { onFileEvent(events); }, 
      Event::FileTriggerType::Edge,
      Event::FileReadyType::Read | Event::FileReadyType::Write);
    ......
}

傳遞給Dispatcher的callback都是通過裸指針的方式進行回調，如果進行回調的時候對象已經析構了，就會出現野指針的問題，我相信C++水平還可以的同學都會看出這個問題，除非能在邏輯上保證Dispatcher的生命周期比所有對象都短，這樣就能保證在回調的時候對象肯定不會析構，但是這不可能成立的，因為Dispatcher是EventLoop的核心。

一個線程運行一個EventLoop直到線程結束，Dispatcher對象才會析構，這意味著Dispatcher對象的生命周期是最長的。所以從邏輯上沒辦法保證進行回調的時候對象沒有析構。可能有人會有疑問，對象在析構的時候把注冊的事件取消不就可以避免野指針的問題嗎? 那如果事件已經觸發了，callback正在等待運行呢？ 又或者callback運行了一半呢？前者libevent是可以保證的，在調用event_del的時候可以把處于等待運行的事件取消掉，但是后者就無能為力了，這個時候如果對象析構了，那行為就是未定義了。沿著這個思路想一想，是不是只要保證對象析構的時候沒有callback正在運行就可以解決問題了呢？是的，只要保證所有在執行中的callback執行完了，再做對象析構就可以了。可以利用Dispatcher是順序執行所有callback的特點，向Dispatcher中插入一個任務就是用來對象析構的，那么當這個任務執行的時候是可以保證沒有其他任何callback在運行。通過這個方法就完美解決了這里遇到的野指針問題了。

或許有人又會想，這里是不是可以用shared_ptr和shared_from_this來解這個呢? 是的，這是解決多線程環境下對象析構的秘密武器，通過延長對象的生命周期，把對象的生命周期延長到和callback一樣，等callback執行完再進行析構，同樣可以達到效果，但是這帶來了兩個問題，第一就是對象生命周期被無限拉長，雖然延遲析構也拉長了生命周期，但是時間是可預期的，一旦EventLoop執行了clearDeferredDeleteList任務就會立刻被回收，而通過shared_ptr的方式其生命周期取決于callback何時運行，而callback何時運行這個是沒辦法保證的，比如一個等待socket的可讀事件進行回調，如果對端一直不發送數據，那么callback就一直不會被運行，對象就一直無法被析構，長時間累積會導致內存使用率上漲。第二就是在使用方式上侵入性較強，需要強制使用shared_ptr的方式創建對象。

Dispatcher總的來說其實現還是比較簡單明了的，比較容易驗證其正確性，同樣功能也相對較弱，和chromium的MessageLoop、boost的asio都是相似的用途，但是功能上差得比較多。好在這是專門給Envoy設計的，而且Envoy的場景也比較單一，不必做成那么通用的。另外一個我覺得比較奇怪的是，為什么在DeferredDeletable的實現中要用to_delete_1_和to_delete_2_兩個隊列交替來存放，其實按照我的理解一個隊列即可，因為clearDeferredDeleteList和deferredDelete是保證在同一個線程中執行的，就和Dispatcher的任務隊列一樣，用一個隊列保存所有要執行的任務，循環的執行即可。但是Envoy中沒有這樣做，我理解這樣設計的原因可能是因為相比于任務隊列來說延遲析構的重要性更低一些，大量對象的析構如果保存在一個隊列中循環的進行析構勢必會影響其他關鍵任務的執行，所以這里拆分成兩個隊列，多個任務交替的執行，就好比把一個大任務拆分成了好幾個小任務順序來執行。

看完上述內容，你們掌握Envoy源碼是如何分析Dispatcher的的方法了嗎？如果還想學到更多技能或想了解更多相關內容，歡迎關注億速云行業資訊頻道，感謝各位的閱讀！