Add support for getting the current thread's name

Summary: It's primarily for use in testing, but is useful for log output as well.

Reviewed By: yfeldblum

Differential Revision: D4943072

fbshipit-source-id: 0ca259d6c90f439e733a6179e7cba85dcd1ec9e7

diff --git a/folly/ThreadName.cpp b/folly/ThreadName.cpp
index a24a6b8bd1fe1dfe38e61c1fb9529c4c56ca9379..97db551f8c5c9dbd2b763849d1eab38b0b4be693 100644 (file)
--- a/folly/ThreadName.cpp
+++ b/folly/ThreadName.cpp
@@ -57,6 +57,30 @@ bool canSetOtherThreadName() {
 #endif
 }
 
 #endif
 }
 

+static constexpr size_t kMaxThreadNameLength = 16;
+
+Optional<std::string> getCurrentThreadName() {
+#if !FOLLY_HAVE_PTHREAD
+  return Optional<std::string>();
+#else
+#if FOLLY_HAS_PTHREAD_SETNAME_NP_THREAD_NAME
+  std::array<char, kMaxThreadNameLength> buf;
+  if (pthread_getname_np(pthread_self(), buf.data(), buf.size()) != 0) {
+    return Optional<std::string>();
+  }
+  return make_optional(std::string(buf.data()));
+#elif FOLLY_HAS_PTHREAD_SETNAME_NP_NAME
+  std::array<char, kMaxThreadNameLength> buf;
+  if (pthread_getname_np(buf.data(), buf.size()) != 0) {
+    return Optional<std::string>();
+  }
+  return make_optional(std::string(buf.data()));
+#else
+  return Optional<std::string>();
+#endif
+#endif
+}
+

 bool setThreadName(std::thread::id tid, StringPiece name) {
 #if !FOLLY_HAVE_PTHREAD || _WIN32
   return false;
 bool setThreadName(std::thread::id tid, StringPiece name) {
 #if !FOLLY_HAVE_PTHREAD || _WIN32
   return false;


@@ -73,13 +97,14 @@ bool setThreadName(std::thread::id tid, StringPiece name) {
   // extract it.
   pthread_t id;
   std::memcpy(&id, &tid, sizeof(id));
   // extract it.
   pthread_t id;
   std::memcpy(&id, &tid, sizeof(id));

+  auto trimmedName = name.fbstr().substr(0, kMaxThreadNameLength - 1);

 #if FOLLY_HAS_PTHREAD_SETNAME_NP_THREAD_NAME
 #if FOLLY_HAS_PTHREAD_SETNAME_NP_THREAD_NAME

-  return 0 == pthread_setname_np(id, name.fbstr().substr(0, 15).c_str());
+  return 0 == pthread_setname_np(id, trimmedName.c_str());

 #elif FOLLY_HAS_PTHREAD_SETNAME_NP_NAME
   // Since OS X 10.6 it is possible for a thread to set its own name,
   // but not that of some other thread.
   if (pthread_equal(pthread_self(), id)) {
 #elif FOLLY_HAS_PTHREAD_SETNAME_NP_NAME
   // Since OS X 10.6 it is possible for a thread to set its own name,
   // but not that of some other thread.
   if (pthread_equal(pthread_self(), id)) {

-    return 0 == pthread_setname_np(name.fbstr().c_str());
+    return 0 == pthread_setname_np(trimmedName.c_str());

   }
   return false;
 #else
   }
   return false;
 #else

diff --git a/folly/ThreadName.h b/folly/ThreadName.h
index b55793ce5b9a06a7db319360c699680494b4a146..d78e2fa17a5430e52ca67664dcb3b676210aef2d 100644 (file)
--- a/folly/ThreadName.h
+++ b/folly/ThreadName.h
@@ -16,8 +16,10 @@
 
 #pragma once
 
 
 #pragma once
 

+#include <string>

 #include <thread>
 
 #include <thread>
 

+#include <folly/Optional.h>

 #include <folly/Range.h>
 #include <folly/portability/Config.h>
 #include <folly/portability/PThread.h>
 #include <folly/Range.h>
 #include <folly/portability/Config.h>
 #include <folly/portability/PThread.h>


@@ -33,6 +35,10 @@ bool canSetCurrentThreadName();
  * threads other than the one currently executing.
  */
 bool canSetOtherThreadName();
  * threads other than the one currently executing.
  */
 bool canSetOtherThreadName();

+/**
+ * Get the name of the current string, or nothing if an error occurs.
+ */
+Optional<std::string> getCurrentThreadName();

 
 bool setThreadName(std::thread::id tid, StringPiece name);
 #if FOLLY_HAVE_PTHREAD
 
 bool setThreadName(std::thread::id tid, StringPiece name);
 #if FOLLY_HAVE_PTHREAD

diff --git a/folly/test/ThreadNameTest.cpp b/folly/test/ThreadNameTest.cpp
index 57eae214578a7ecf960a770269b9ade4a2221114..b804bbb156c3dfa5ae6cd2a4f6cc1ac1c677edca 100644 (file)
--- a/folly/test/ThreadNameTest.cpp
+++ b/folly/test/ThreadNameTest.cpp
@@ -27,6 +27,17 @@ using namespace folly;
 static bool expectedSetOtherThreadNameResult = folly::canSetOtherThreadName();
 static bool expectedSetSelfThreadNameResult = folly::canSetCurrentThreadName();
 
 static bool expectedSetOtherThreadNameResult = folly::canSetOtherThreadName();
 static bool expectedSetSelfThreadNameResult = folly::canSetCurrentThreadName();
 

+TEST(ThreadName, getCurrentThreadName) {
+  static constexpr StringPiece kThreadName{"rockin-thread"};
+  thread th([] {
+    EXPECT_EQ(expectedSetSelfThreadNameResult, setThreadName(kThreadName));
+    if (expectedSetSelfThreadNameResult) {
+      EXPECT_EQ(kThreadName.toString(), getCurrentThreadName().value());
+    }
+  });
+  SCOPE_EXIT { th.join(); };
+}
+

 TEST(ThreadName, setThreadName_self) {
   thread th([] {
     EXPECT_EQ(expectedSetSelfThreadNameResult, setThreadName("rockin-thread"));
 TEST(ThreadName, setThreadName_self) {
   thread th([] {
     EXPECT_EQ(expectedSetSelfThreadNameResult, setThreadName("rockin-thread"));