190dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles)// Copyright (c) 2012 The Chromium Authors. All rights reserved.
290dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles)// Use of this source code is governed by a BSD-style license that can be
390dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles)// found in the LICENSE file.
490dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles)
590dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles)#include "base/threading/platform_thread.h"
690dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles)
790dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles)#include <errno.h>
890dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles)#include <sched.h>
990dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles)
1090dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles)#include "base/lazy_instance.h"
1190dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles)#include "base/logging.h"
1290dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles)#include "base/memory/scoped_ptr.h"
1390dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles)#include "base/safe_strerror_posix.h"
1490dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles)#include "base/threading/thread_id_name_manager.h"
1590dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles)#include "base/threading/thread_restrictions.h"
1690dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles)#include "base/tracked_objects.h"
1790dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles)
187d4cd473f85ac64c3747c96c277f9e506a0d2246Torne (Richard Coles)#if !defined(OS_NACL)
1990dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles)#include <sys/prctl.h>
2090dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles)#include <sys/resource.h>
2190dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles)#include <sys/syscall.h>
2290dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles)#include <sys/time.h>
2390dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles)#include <unistd.h>
2490dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles)#endif
2590dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles)
2690dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles)namespace base {
2790dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles)
2890dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles)namespace {
295c02ac1a9c1b504631c0a3d2b6e737b5d738bae1Bo Liu
3090dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles)int ThreadNiceValue(ThreadPriority priority) {
3190dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles)  switch (priority) {
3290dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles)    case kThreadPriority_RealtimeAudio:
33424c4d7b64af9d0d8fd9624f381f469654d5e3d2Torne (Richard Coles)      return -10;
3490dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles)    case kThreadPriority_Background:
35424c4d7b64af9d0d8fd9624f381f469654d5e3d2Torne (Richard Coles)      return 10;
3690dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles)    case kThreadPriority_Normal:
37424c4d7b64af9d0d8fd9624f381f469654d5e3d2Torne (Richard Coles)      return 0;
3890dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles)    case kThreadPriority_Display:
39424c4d7b64af9d0d8fd9624f381f469654d5e3d2Torne (Richard Coles)      return -6;
4090dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles)    default:
4190dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles)      NOTREACHED() << "Unknown priority.";
4290dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles)      return 0;
4390dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles)  }
4490dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles)}
455c02ac1a9c1b504631c0a3d2b6e737b5d738bae1Bo Liu
465c02ac1a9c1b504631c0a3d2b6e737b5d738bae1Bo Liu}  // namespace
4790dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles)
4890dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles)// static
4990dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles)void PlatformThread::SetName(const char* name) {
5090dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles)  ThreadIdNameManager::GetInstance()->SetName(CurrentId(), name);
5190dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles)  tracked_objects::ThreadData::InitializeThreadContext(name);
5290dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles)
53424c4d7b64af9d0d8fd9624f381f469654d5e3d2Torne (Richard Coles)#if !defined(OS_NACL)
5490dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles)  // On linux we can get the thread names to show up in the debugger by setting
5590dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles)  // the process name for the LWP.  We don't want to do this for the main
5690dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles)  // thread because that would rename the process, causing tools like killall
5790dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles)  // to stop working.
5890dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles)  if (PlatformThread::CurrentId() == getpid())
5990dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles)    return;
6090dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles)
6190dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles)  // http://0pointer.de/blog/projects/name-your-threads.html
6290dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles)  // Set the name for the LWP (which gets truncated to 15 characters).
6390dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles)  // Note that glibc also has a 'pthread_setname_np' api, but it may not be
6490dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles)  // available everywhere and it's only benefit over using prctl directly is
6590dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles)  // that it can set the name of threads other than the current thread.
6690dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles)  int err = prctl(PR_SET_NAME, name);
6790dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles)  // We expect EPERM failures in sandboxed processes, just ignore those.
6890dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles)  if (err < 0 && errno != EPERM)
6990dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles)    DPLOG(ERROR) << "prctl(PR_SET_NAME)";
70424c4d7b64af9d0d8fd9624f381f469654d5e3d2Torne (Richard Coles)#endif  //  !defined(OS_NACL)
7190dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles)}
7290dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles)
7390dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles)// static
7490dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles)void PlatformThread::SetThreadPriority(PlatformThreadHandle handle,
7590dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles)                                       ThreadPriority priority) {
76868fa2fe829687343ffae624259930155e16dbd8Torne (Richard Coles)#if !defined(OS_NACL)
77868fa2fe829687343ffae624259930155e16dbd8Torne (Richard Coles)  if (priority == kThreadPriority_RealtimeAudio) {
785f1c94371a64b3196d4be9466099bb892df9b88eTorne (Richard Coles)    const struct sched_param kRealTimePrio = {8};
79424c4d7b64af9d0d8fd9624f381f469654d5e3d2Torne (Richard Coles)    if (pthread_setschedparam(pthread_self(), SCHED_RR, &kRealTimePrio) == 0) {
80868fa2fe829687343ffae624259930155e16dbd8Torne (Richard Coles)      // Got real time priority, no need to set nice level.
81868fa2fe829687343ffae624259930155e16dbd8Torne (Richard Coles)      return;
82868fa2fe829687343ffae624259930155e16dbd8Torne (Richard Coles)    }
83868fa2fe829687343ffae624259930155e16dbd8Torne (Richard Coles)  }
84868fa2fe829687343ffae624259930155e16dbd8Torne (Richard Coles)
855f1c94371a64b3196d4be9466099bb892df9b88eTorne (Richard Coles)  // setpriority(2) should change the whole thread group's (i.e. process)
865f1c94371a64b3196d4be9466099bb892df9b88eTorne (Richard Coles)  // priority. however, on linux it will only change the target thread's
875f1c94371a64b3196d4be9466099bb892df9b88eTorne (Richard Coles)  // priority. see the bugs section in
885f1c94371a64b3196d4be9466099bb892df9b88eTorne (Richard Coles)  // http://man7.org/linux/man-pages/man2/getpriority.2.html.
895f1c94371a64b3196d4be9466099bb892df9b88eTorne (Richard Coles)  // we prefer using 0 rather than the current thread id since they are
905f1c94371a64b3196d4be9466099bb892df9b88eTorne (Richard Coles)  // equivalent but it makes sandboxing easier (https://crbug.com/399473).
9190dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles)  DCHECK_NE(handle.id_, kInvalidThreadId);
92424c4d7b64af9d0d8fd9624f381f469654d5e3d2Torne (Richard Coles)  const int kNiceSetting = ThreadNiceValue(priority);
935f1c94371a64b3196d4be9466099bb892df9b88eTorne (Richard Coles)  const PlatformThreadId current_id = PlatformThread::CurrentId();
945f1c94371a64b3196d4be9466099bb892df9b88eTorne (Richard Coles)  if (setpriority(PRIO_PROCESS,
955f1c94371a64b3196d4be9466099bb892df9b88eTorne (Richard Coles)                  handle.id_ == current_id ? 0 : handle.id_,
965f1c94371a64b3196d4be9466099bb892df9b88eTorne (Richard Coles)                  kNiceSetting)) {
975f1c94371a64b3196d4be9466099bb892df9b88eTorne (Richard Coles)    DVPLOG(1) << "Failed to set nice value of thread (" << handle.id_ << ") to "
985f1c94371a64b3196d4be9466099bb892df9b88eTorne (Richard Coles)              << kNiceSetting;
99424c4d7b64af9d0d8fd9624f381f469654d5e3d2Torne (Richard Coles)  }
100424c4d7b64af9d0d8fd9624f381f469654d5e3d2Torne (Richard Coles)#endif  //  !defined(OS_NACL)
10190dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles)}
10290dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles)
103424c4d7b64af9d0d8fd9624f381f469654d5e3d2Torne (Richard Coles)void InitThreading() {}
10490dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles)
105424c4d7b64af9d0d8fd9624f381f469654d5e3d2Torne (Richard Coles)void InitOnThread() {}
10690dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles)
107424c4d7b64af9d0d8fd9624f381f469654d5e3d2Torne (Richard Coles)void TerminateOnThread() {}
10890dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles)
10990dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles)size_t GetDefaultThreadStackSize(const pthread_attr_t& attributes) {
1101320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci#if !defined(THREAD_SANITIZER)
11190dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles)  return 0;
1125d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles)#else
1135d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles)  // ThreadSanitizer bloats the stack heavily. Evidence has been that the
1145d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles)  // default stack size isn't enough for some browser tests.
1155d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles)  return 2 * (1 << 23);  // 2 times 8192K (the default stack size on Linux).
1165d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles)#endif
11790dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles)}
11890dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles)
11990dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles)}  // namespace base
120