Shift the implementation of setThreadName out of the header
[folly.git] / folly / ThreadName.h
index 52b0cdaca63d625ad41aa94c94ff9a251e4c9baf..b55793ce5b9a06a7db319360c699680494b4a146 100644 (file)
 #pragma once
 
 #include <thread>
-#include <type_traits>
 
 #include <folly/Range.h>
-#include <folly/Traits.h>
 #include <folly/portability/Config.h>
 #include <folly/portability/PThread.h>
 
 namespace folly {
+/**
+ * This returns true if the current platform supports setting the name of the
+ * current thread.
+ */
+bool canSetCurrentThreadName();
+/**
+ * This returns true if the current platform supports setting the name of
+ * threads other than the one currently executing.
+ */
+bool canSetOtherThreadName();
 
-// This looks a bit weird, but it's necessary to avoid
-// having an undefined compiler function called.
-#if defined(__GLIBC__) && !defined(__APPLE__) && !defined(__ANDROID__)
-#if __GLIBC_PREREQ(2, 12)
-// has pthread_setname_np(pthread_t, const char*) (2 params)
-#define FOLLY_HAS_PTHREAD_SETNAME_NP_THREAD_NAME 1
-#endif
-#endif
-
-#if defined(__APPLE__) && defined(__MAC_OS_X_VERSION_MIN_REQUIRED)
-#if __MAC_OS_X_VERSION_MIN_REQUIRED >= 1060
-// has pthread_setname_np(const char*) (1 param)
-#define FOLLY_HAS_PTHREAD_SETNAME_NP_NAME 1
-#endif
-#endif
-
-template <typename T>
-inline bool setThreadName(T /* id */, StringPiece /* name */) {
-  static_assert(
-#if FOLLY_HAVE_PTHREAD
-      std::is_same<T, pthread_t>::value ||
-#endif
-      std::is_same<T, std::thread::id>::value ||
-      std::is_same<T, std::thread::native_handle_type>::value,
-      "type must be pthread_t, std::thread::id or "
-      "std::thread::native_handle_type");
-  return false;
-}
-
-template <>
-inline bool setThreadName(std::thread::id tid, StringPiece name) {
-#if !FOLLY_HAVE_PTHREAD
-  return false;
-#else
-  static_assert(
-      std::is_same<pthread_t, std::thread::native_handle_type>::value,
-      "This assumes that the native handle type is pthread_t");
-  static_assert(
-      sizeof(std::thread::native_handle_type) == sizeof(std::thread::id),
-      "This assumes std::thread::id is a thin wrapper around "
-      "std::thread::native_handle_type, but that doesn't appear to be true.");
-  // In most implementations, std::thread::id is a thin wrapper around
-  // std::thread::native_handle_type, which means we can do unsafe things to
-  // extract it.
-  pthread_t id;
-  std::memcpy(&id, &tid, sizeof(id));
-#if FOLLY_HAS_PTHREAD_SETNAME_NP_THREAD_NAME
-  return 0 == pthread_setname_np(id, name.fbstr().substr(0, 15).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)) {
-    return 0 == pthread_setname_np(name.fbstr().c_str());
-  }
-  return false;
-#else
-  return false;
-#endif
-#endif
-}
-
+bool setThreadName(std::thread::id tid, StringPiece name);
 #if FOLLY_HAVE_PTHREAD
-template <>
-inline bool setThreadName(pthread_t pid, StringPiece name) {
-  static_assert(
-      std::is_same<pthread_t, std::thread::native_handle_type>::value,
-      "This assumes that the native handle type is pthread_t");
-  static_assert(
-      sizeof(std::thread::native_handle_type) == sizeof(std::thread::id),
-      "This assumes std::thread::id is a thin wrapper around "
-      "std::thread::native_handle_type, but that doesn't appear to be true.");
-  // In most implementations, std::thread::id is a thin wrapper around
-  // std::thread::native_handle_type, which means we can do unsafe things to
-  // extract it.
-  std::thread::id id;
-  std::memcpy(&id, &pid, sizeof(id));
-  return setThreadName(id, name);
-}
+bool setThreadName(pthread_t pid, StringPiece name);
 #endif
-
-inline bool setThreadName(StringPiece name) {
-  return setThreadName(std::this_thread::get_id(), name);
-}
+bool setThreadName(StringPiece name);
 }