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
  21 #include <folly/Range.h>
  22 #include <folly/portability/Config.h>
  23 #include <folly/portability/PThread.h>
  24
  25 namespace folly {
  26 /**
  27  * This returns true if the current platform supports setting the name of the
  28  * current thread.
  29  */
  30 bool canSetCurrentThreadName();
  31 /**
  32  * This returns true if the current platform supports setting the name of
  33  * threads other than the one currently executing.
  34  */
  35 bool canSetOtherThreadName();
  36
  37 bool setThreadName(std::thread::id tid, StringPiece name);
  38 #if FOLLY_HAVE_PTHREAD
  39 bool setThreadName(pthread_t pid, StringPiece name);
  40 #endif
  41 bool setThreadName(StringPiece name);
  42 }