folly/ThreadName.h

   1 /*
   2  * Copyright 2017 Facebook, Inc.
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  *   http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 #pragma once
  18
  19 #include <thread>
  20 #include <type_traits>
  21
  22 #include <folly/Range.h>
  23 #include <folly/Traits.h>
  24 #include <folly/portability/Config.h>
  25 #include <folly/portability/PThread.h>
  26
  27 namespace folly {
  28
  29 // This looks a bit weird, but it's necessary to avoid
  30 // having an undefined compiler function called.
  31 #if defined(__GLIBC__) && !defined(__APPLE__) && !defined(__ANDROID__)
  32 #if __GLIBC_PREREQ(2, 12)
  33 // has pthread_setname_np(pthread_t, const char*) (2 params)
  34 #define FOLLY_HAS_PTHREAD_SETNAME_NP_THREAD_NAME 1
  35 #endif
  36 #endif
  37 #if defined(__APPLE__) && defined(__MAC_OS_X_VERSION_MIN_REQUIRED)
  38 #if __MAC_OS_X_VERSION_MIN_REQUIRED >= 1060
  39 // has pthread_setname_np(const char*) (1 param)
  40 #define FOLLY_HAS_PTHREAD_SETNAME_NP_NAME 1
  41 #endif
  42 #endif
  43
  44 template <typename T>
  45 inline bool setThreadName(T /* id */, StringPiece /* name */) {
  46   static_assert(
  47 #if FOLLY_HAVE_PTHREAD
  48       std::is_same<T, pthread_t>::value ||
  49 #endif
  50       std::is_same<T, std::thread::id>::value ||
  51       std::is_same<T, std::thread::native_handle_type>::value,
  52       "type must be pthread_t, std::thread::id or "
  53       "std::thread::native_handle_type");
  54   return false;
  55 }
  56
  57 #ifdef FOLLY_HAS_PTHREAD_SETNAME_NP_THREAD_NAME
  58 template <>
  59 inline bool setThreadName(pthread_t id, StringPiece name) {
  60   return 0 == pthread_setname_np(id, name.fbstr().substr(0, 15).c_str());
  61 }
  62 #endif
  63
  64 #ifdef FOLLY_HAS_PTHREAD_SETNAME_NP_NAME
  65 template <>
  66 inline bool setThreadName(pthread_t id, StringPiece name) {
  67   // Since OS X 10.6 it is possible for a thread to set its own name,
  68   // but not that of some other thread.
  69   if (pthread_equal(pthread_self(), id)) {
  70     return 0 == pthread_setname_np(name.fbstr().c_str());
  71   }
  72   return false;
  73 }
  74 #endif
  75
  76 #if FOLLY_HAVE_PTHREAD
  77 template <
  78     typename = folly::_t<std::enable_if<
  79         std::is_same<pthread_t, std::thread::native_handle_type>::value>>>
  80 inline bool setThreadName(std::thread::id id, StringPiece name) {
  81   static_assert(
  82       sizeof(std::thread::native_handle_type) == sizeof(decltype(id)),
  83       "This assumes std::thread::id is a thin wrapper around "
  84       "std::thread::native_handle_type, but that doesn't appear to be true.");
  85   // In most implementations, std::thread::id is a thin wrapper around
  86   // std::thread::native_handle_type, which means we can do unsafe things to
  87   // extract it.
  88   pthread_t ptid = *reinterpret_cast<pthread_t*>(&id);
  89   return setThreadName(ptid, name);
  90 }
  91
  92 inline bool setThreadName(StringPiece name) {
  93   return setThreadName(pthread_self(), name);
  94 }
  95 #else
  96 inline bool setThreadName(StringPiece name) {
  97   return false;
  98 }
  99 #endif
 100
 101 }