793bac569f
This reverts commit c89fdd716c4c8af608017c76f75bf27e4c3d602e. Reason for revert: Causes rare compilation error on win-libfuzzer-asan trybot. See https://ci.chromium.org/p/chromium/builders/try/win-libfuzzer-asan-rel/713745? Original change's description: > Refactor the PlatformThread API. > > PlatformThread's API is using old style function pointers, causes > casting, is unintuitive and forces artificial call sequences, and > is additionally possible to misuse in release mode. > > Fix this by an API face lift: > 1. The class is turned into a handle, which can be empty. > 2. The only way of getting a non-empty PlatformThread is by calling > SpawnJoinable or SpawnDetached, clearly conveying the semantics to the > code reader. > 3. Handles can be Finalized, which works differently for joinable and > detached threads: > a) Handles for detached threads are simply closed where applicable. > b) Joinable threads are joined before handles are closed. > 4. The destructor finalizes handles. No explicit call is needed. > > Fixed: webrtc:12727 > Change-Id: Id00a0464edf4fc9e552b6a1fbb5d2e1280e88811 > Reviewed-on: https://webrtc-review.googlesource.com/c/src/+/215075 > Commit-Queue: Markus Handell <handellm@webrtc.org> > Reviewed-by: Harald Alvestrand <hta@webrtc.org> > Reviewed-by: Mirko Bonadei <mbonadei@webrtc.org> > Reviewed-by: Tommi <tommi@webrtc.org> > Cr-Commit-Position: refs/heads/master@{#33923} # Not skipping CQ checks because original CL landed > 1 day ago. TBR=handellm@webrtc.org Bug: webrtc:12727 Change-Id: Ic0146be8866f6dd3ad9c364fb8646650b8e07419 Reviewed-on: https://webrtc-review.googlesource.com/c/src/+/217583 Reviewed-by: Guido Urdaneta <guidou@webrtc.org> Reviewed-by: Markus Handell <handellm@webrtc.org> Commit-Queue: Guido Urdaneta <guidou@webrtc.org> Cr-Commit-Position: refs/heads/master@{#33936}
116 lines
3.4 KiB
C++
116 lines
3.4 KiB
C++
/*
|
|
* Copyright (c) 2015 The WebRTC project authors. All Rights Reserved.
|
|
*
|
|
* Use of this source code is governed by a BSD-style license
|
|
* that can be found in the LICENSE file in the root of the source
|
|
* tree. An additional intellectual property rights grant can be found
|
|
* in the file PATENTS. All contributing project authors may
|
|
* be found in the AUTHORS file in the root of the source tree.
|
|
*/
|
|
|
|
#ifndef RTC_BASE_PLATFORM_THREAD_H_
|
|
#define RTC_BASE_PLATFORM_THREAD_H_
|
|
|
|
#ifndef WEBRTC_WIN
|
|
#include <pthread.h>
|
|
#endif
|
|
#include <string>
|
|
|
|
#include "absl/strings/string_view.h"
|
|
#include "api/sequence_checker.h"
|
|
#include "rtc_base/constructor_magic.h"
|
|
#include "rtc_base/platform_thread_types.h"
|
|
|
|
namespace rtc {
|
|
|
|
// Callback function that the spawned thread will enter once spawned.
|
|
typedef void (*ThreadRunFunction)(void*);
|
|
|
|
enum ThreadPriority {
|
|
#ifdef WEBRTC_WIN
|
|
kLowPriority = THREAD_PRIORITY_BELOW_NORMAL,
|
|
kNormalPriority = THREAD_PRIORITY_NORMAL,
|
|
kHighPriority = THREAD_PRIORITY_ABOVE_NORMAL,
|
|
kHighestPriority = THREAD_PRIORITY_HIGHEST,
|
|
kRealtimePriority = THREAD_PRIORITY_TIME_CRITICAL
|
|
#else
|
|
kLowPriority = 1,
|
|
kNormalPriority = 2,
|
|
kHighPriority = 3,
|
|
kHighestPriority = 4,
|
|
kRealtimePriority = 5
|
|
#endif
|
|
};
|
|
|
|
struct ThreadAttributes {
|
|
ThreadPriority priority = kNormalPriority;
|
|
bool joinable = true;
|
|
|
|
ThreadAttributes& SetPriority(ThreadPriority priority_param) {
|
|
priority = priority_param;
|
|
return *this;
|
|
}
|
|
ThreadAttributes& SetDetached() {
|
|
joinable = false;
|
|
return *this;
|
|
}
|
|
};
|
|
|
|
// Represents a simple worker thread. The implementation must be assumed
|
|
// to be single threaded, meaning that all methods of the class, must be
|
|
// called from the same thread, including instantiation.
|
|
class PlatformThread {
|
|
public:
|
|
PlatformThread(ThreadRunFunction func,
|
|
void* obj,
|
|
absl::string_view thread_name,
|
|
ThreadAttributes attributes = ThreadAttributes());
|
|
virtual ~PlatformThread();
|
|
|
|
const std::string& name() const { return name_; }
|
|
|
|
// Spawns a thread and tries to set thread priority according to the priority
|
|
// from when CreateThread was called.
|
|
// Start can only be called after the constructor or after a call to Stop().
|
|
void Start();
|
|
|
|
bool IsRunning() const;
|
|
|
|
// Returns an identifier for the worker thread that can be used to do
|
|
// thread checks.
|
|
PlatformThreadRef GetThreadRef() const;
|
|
|
|
// Stop() prepares the PlatformThread for destruction or another call to
|
|
// Start(). For a PlatformThread that's been created with
|
|
// ThreadAttributes::joinable true (the default), Stop() suspends the calling
|
|
// thread until the created thread exits unless the thread has already exited.
|
|
// Stop() can only be called after calling Start().
|
|
void Stop();
|
|
|
|
protected:
|
|
#if defined(WEBRTC_WIN)
|
|
// Exposed to derived classes to allow for special cases specific to Windows.
|
|
bool QueueAPC(PAPCFUNC apc_function, ULONG_PTR data);
|
|
#endif
|
|
|
|
private:
|
|
ThreadRunFunction const run_function_ = nullptr;
|
|
const ThreadAttributes attributes_;
|
|
void* const obj_;
|
|
// TODO(pbos): Make sure call sites use string literals and update to a const
|
|
// char* instead of a std::string.
|
|
const std::string name_;
|
|
webrtc::SequenceChecker thread_checker_;
|
|
#if defined(WEBRTC_WIN)
|
|
HANDLE thread_ = nullptr;
|
|
DWORD thread_id_ = 0;
|
|
#else
|
|
pthread_t thread_ = 0;
|
|
#endif // defined(WEBRTC_WIN)
|
|
RTC_DISALLOW_COPY_AND_ASSIGN(PlatformThread);
|
|
};
|
|
|
|
} // namespace rtc
|
|
|
|
#endif // RTC_BASE_PLATFORM_THREAD_H_
|