platform_thread_linux.cc revision 868fa2fe829687343ffae624259930155e16dbd8
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)
1890dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles)#if defined(OS_LINUX)
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 {
2990dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles)int ThreadNiceValue(ThreadPriority priority) {
3090dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles)  static const int threadPriorityAudio = -10;
3190dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles)  static const int threadPriorityBackground = 10;
3290dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles)  static const int threadPriorityDefault = 0;
3390dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles)  static const int threadPriorityDisplay = -6;
3490dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles)  switch (priority) {
3590dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles)    case kThreadPriority_RealtimeAudio:
3690dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles)      return threadPriorityAudio;
3790dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles)    case kThreadPriority_Background:
3890dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles)      return threadPriorityBackground;
3990dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles)    case kThreadPriority_Normal:
4090dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles)      return threadPriorityDefault;
4190dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles)    case kThreadPriority_Display:
4290dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles)      return threadPriorityDisplay;
4390dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles)    default:
4490dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles)      NOTREACHED() << "Unknown priority.";
4590dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles)      return 0;
4690dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles)  }
4790dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles)}
4890dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles)} // namespace
4990dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles)
5090dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles)// static
5190dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles)void PlatformThread::SetName(const char* name) {
5290dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles)  ThreadIdNameManager::GetInstance()->SetName(CurrentId(), name);
5390dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles)  tracked_objects::ThreadData::InitializeThreadContext(name);
5490dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles)
5590dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles)#ifndef OS_NACL
5690dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles)  // On linux we can get the thread names to show up in the debugger by setting
5790dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles)  // the process name for the LWP.  We don't want to do this for the main
5890dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles)  // thread because that would rename the process, causing tools like killall
5990dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles)  // to stop working.
6090dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles)  if (PlatformThread::CurrentId() == getpid())
6190dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles)    return;
6290dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles)
6390dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles)  // http://0pointer.de/blog/projects/name-your-threads.html
6490dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles)  // Set the name for the LWP (which gets truncated to 15 characters).
6590dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles)  // Note that glibc also has a 'pthread_setname_np' api, but it may not be
6690dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles)  // available everywhere and it's only benefit over using prctl directly is
6790dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles)  // that it can set the name of threads other than the current thread.
6890dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles)  int err = prctl(PR_SET_NAME, name);
6990dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles)  // We expect EPERM failures in sandboxed processes, just ignore those.
7090dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles)  if (err < 0 && errno != EPERM)
7190dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles)    DPLOG(ERROR) << "prctl(PR_SET_NAME)";
7290dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles)#endif
7390dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles)}
7490dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles)
7590dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles)// static
7690dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles)void PlatformThread::SetThreadPriority(PlatformThreadHandle handle,
7790dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles)                                       ThreadPriority priority) {
78868fa2fe829687343ffae624259930155e16dbd8Torne (Richard Coles)#if !defined(OS_NACL)
79868fa2fe829687343ffae624259930155e16dbd8Torne (Richard Coles)  if (priority == kThreadPriority_RealtimeAudio) {
80868fa2fe829687343ffae624259930155e16dbd8Torne (Richard Coles)    const int kRealTimePrio = 8;
81868fa2fe829687343ffae624259930155e16dbd8Torne (Richard Coles)
82868fa2fe829687343ffae624259930155e16dbd8Torne (Richard Coles)    struct sched_param sched_param;
83868fa2fe829687343ffae624259930155e16dbd8Torne (Richard Coles)    memset(&sched_param, 0, sizeof(sched_param));
84868fa2fe829687343ffae624259930155e16dbd8Torne (Richard Coles)    sched_param.sched_priority = kRealTimePrio;
85868fa2fe829687343ffae624259930155e16dbd8Torne (Richard Coles)
86868fa2fe829687343ffae624259930155e16dbd8Torne (Richard Coles)    if (pthread_setschedparam(pthread_self(), SCHED_RR, &sched_param) == 0) {
87868fa2fe829687343ffae624259930155e16dbd8Torne (Richard Coles)      // Got real time priority, no need to set nice level.
88868fa2fe829687343ffae624259930155e16dbd8Torne (Richard Coles)      return;
89868fa2fe829687343ffae624259930155e16dbd8Torne (Richard Coles)    }
90868fa2fe829687343ffae624259930155e16dbd8Torne (Richard Coles)  }
91868fa2fe829687343ffae624259930155e16dbd8Torne (Richard Coles)
9290dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles)  // setpriority(2) will set a thread's priority if it is passed a tid as
9390dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles)  // the 'process identifier', not affecting the rest of the threads in the
9490dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles)  // process. Setting this priority will only succeed if the user has been
9590dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles)  // granted permission to adjust nice values on the system.
9690dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles)  DCHECK_NE(handle.id_, kInvalidThreadId);
9790dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles)  int kNiceSetting = ThreadNiceValue(priority);
9890dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles)  if (setpriority(PRIO_PROCESS, handle.id_, kNiceSetting))
9990dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles)    LOG(ERROR) << "Failed to set nice value of thread to " << kNiceSetting;
100868fa2fe829687343ffae624259930155e16dbd8Torne (Richard Coles)#endif  // !OS_NACL
10190dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles)}
10290dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles)
10390dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles)void InitThreading() {
10490dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles)}
10590dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles)
10690dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles)void InitOnThread() {
10790dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles)}
10890dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles)
10990dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles)void TerminateOnThread() {
11090dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles)}
11190dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles)
11290dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles)size_t GetDefaultThreadStackSize(const pthread_attr_t& attributes) {
11390dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles)  return 0;
11490dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles)}
11590dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles)
11690dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles)}  // namespace base
117