folly/ThreadName.h

   1 /*
   2  * Copyright 2016 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 <pthread.h>
  21 #include <folly/Range.h>
  22
  23 namespace folly {
  24
  25 // This looks a bit weird, but it's necessary to avoid
  26 // having an undefined compiler function called.
  27 #if defined(__GLIBC__) && !defined(__APPLE__) && !defined(__ANDROID__)
  28 #if __GLIBC_PREREQ(2, 12)
  29 // has pthread_setname_np(pthread_t, const char*) (2 params)
  30 #define FOLLY_HAS_PTHREAD_SETNAME_NP_THREAD_NAME 1
  31 #endif
  32 #endif
  33 #if defined(__APPLE__) && defined(__MAC_OS_X_VERSION_MIN_REQUIRED)
  34 #if __MAC_OS_X_VERSION_MIN_REQUIRED >= 1060
  35 // has pthread_setname_np(const char*) (1 param)
  36 #define FOLLY_HAS_PTHREAD_SETNAME_NP_NAME 1
  37 #endif
  38 #endif
  39
  40 template <typename T>
  41 inline bool setThreadName(T /* id */, StringPiece /* name */) {
  42   static_assert(
  43       std::is_same<T, pthread_t>::value ||
  44       std::is_same<T, std::thread::native_handle_type>::value,
  45       "type must be pthread_t or std::thread::native_handle_type");
  46   return false;
  47 }
  48
  49 #ifdef FOLLY_HAS_PTHREAD_SETNAME_NP_THREAD_NAME
  50 template <>
  51 inline bool setThreadName(pthread_t id, StringPiece name) {
  52   return 0 == pthread_setname_np(id, name.fbstr().substr(0, 15).c_str());
  53 }
  54 #endif
  55
  56 #ifdef FOLLY_HAS_PTHREAD_SETNAME_NP_NAME
  57 template <>
  58 inline bool setThreadName(pthread_t id, StringPiece name) {
  59   // Since OS X 10.6 it is possible for a thread to set its own name,
  60   // but not that of some other thread.
  61   if (pthread_equal(pthread_self(), id)) {
  62     return 0 == pthread_setname_np(name.fbstr().c_str());
  63   }
  64   return false;
  65 }
  66 #endif
  67
  68 inline bool setThreadName(StringPiece name) {
  69   return setThreadName(pthread_self(), name);
  70 }
  71
  72 }