Support naming a ScopedEventBaseThread

Summary:
The setThreadName API is in the process of being changed to not accept a thread id, which means the thread itself needs to set the name.
There are times where a `ScopedEventBaseThread` needs to be named, and this makes that possible.

Reviewed By: yfeldblum

Differential Revision: D4916781

fbshipit-source-id: dab05b520a715183ce069151ed16864fa1331abc

diff --git a/folly/io/async/ScopedEventBaseThread.cpp b/folly/io/async/ScopedEventBaseThread.cpp
index 25f0cba757bc59b6f735f734c44e1cc1e4792d06..9f14b9186f2e3c3813000be7d969b77ce00371b1 100644 (file)
--- a/folly/io/async/ScopedEventBaseThread.cpp
+++ b/folly/io/async/ScopedEventBaseThread.cpp
@@ -19,13 +19,19 @@
 #include <thread>
 
 #include <folly/Function.h>
+#include <folly/Range.h>
+#include <folly/ThreadName.h>
 #include <folly/io/async/EventBaseManager.h>
 
 using namespace std;
 
 namespace folly {
 
-static void run(EventBaseManager* ebm, EventBase* eb) {
+static void run(EventBaseManager* ebm, EventBase* eb, const StringPiece& name) {
+  if (name.size()) {
+    folly::setThreadName(name);
+  }
+
   ebm->setEventBase(eb, false);
   eb->loopForever();
 
@@ -36,12 +42,20 @@ static void run(EventBaseManager* ebm, EventBase* eb) {
 }
 
 ScopedEventBaseThread::ScopedEventBaseThread()
-    : ScopedEventBaseThread(nullptr) {}
+    : ScopedEventBaseThread(nullptr, "") {}
+
+ScopedEventBaseThread::ScopedEventBaseThread(const StringPiece& name)
+    : ScopedEventBaseThread(nullptr, name) {}
 
 ScopedEventBaseThread::ScopedEventBaseThread(EventBaseManager* ebm)
+    : ScopedEventBaseThread(ebm, "") {}
+
+ScopedEventBaseThread::ScopedEventBaseThread(
+    EventBaseManager* ebm,
+    const StringPiece& name)
     : ebm_(ebm ? ebm : EventBaseManager::get()) {
   new (&eb_) EventBase();
-  th_ = thread(run, ebm_, &eb_);
+  th_ = thread(run, ebm_, &eb_, name);
   eb_.waitUntilRunning();
 }
 

diff --git a/folly/io/async/ScopedEventBaseThread.h b/folly/io/async/ScopedEventBaseThread.h
index 52824cd810d122baf634889e9c60ac603998a7d7..0a8775c6cc86276ac6d888f39ca1ac6141153c19 100644 (file)
--- a/folly/io/async/ScopedEventBaseThread.h
+++ b/folly/io/async/ScopedEventBaseThread.h
@@ -24,6 +24,9 @@
 namespace folly {
 
 class EventBaseManager;
+template <class Iter>
+class Range;
+typedef Range<const char*> StringPiece;
 
 /**
  * A helper class to start a new thread running a EventBase loop.
@@ -35,7 +38,11 @@ class EventBaseManager;
 class ScopedEventBaseThread {
  public:
   ScopedEventBaseThread();
+  explicit ScopedEventBaseThread(const StringPiece& name);
   explicit ScopedEventBaseThread(EventBaseManager* ebm);
+  explicit ScopedEventBaseThread(
+      EventBaseManager* ebm,
+      const StringPiece& name);
   ~ScopedEventBaseThread();
 
   EventBase* getEventBase() const {

diff --git a/folly/io/async/test/ScopedEventBaseThreadTest.cpp b/folly/io/async/test/ScopedEventBaseThreadTest.cpp
index 02fd24dfb3ed1b9dbaeaa0ef512c0bcd020528eb..79dbe6ff935bf4a40f8c8af5d663749c683ec71a 100644 (file)
--- a/folly/io/async/test/ScopedEventBaseThreadTest.cpp
+++ b/folly/io/async/test/ScopedEventBaseThreadTest.cpp
@@ -17,9 +17,11 @@
 #include <folly/io/async/ScopedEventBaseThread.h>
 
 #include <chrono>
+#include <string>
 
 #include <folly/Baton.h>
 #include <folly/Optional.h>
+#include <folly/ThreadName.h>
 #include <folly/io/async/EventBaseManager.h>
 #include <folly/portability/GTest.h>
 
@@ -37,6 +39,24 @@ TEST_F(ScopedEventBaseThreadTest, example) {
   ASSERT_TRUE(done.timed_wait(seconds(1)));
 }
 
+TEST_F(ScopedEventBaseThreadTest, named_example) {
+  static constexpr StringPiece kThreadName{"named_example"};
+
+  Optional<std::string> createdThreadName;
+  Baton<> done;
+
+  ScopedEventBaseThread sebt{kThreadName};
+  sebt.getEventBase()->runInEventBaseThread([&] {
+    createdThreadName = folly::getCurrentThreadName();
+    done.post();
+  });
+
+  ASSERT_TRUE(done.timed_wait(seconds(1)));
+  if (createdThreadName) {
+    ASSERT_EQ(kThreadName.toString(), createdThreadName.value());
+  }
+}
+
 TEST_F(ScopedEventBaseThreadTest, default_manager) {
   auto ebm = EventBaseManager::get();
   ScopedEventBaseThread sebt;