mirror of
https://github.com/mollyim/webrtc.git
synced 2025-05-14 14:20:45 +01:00
4086721e6a
ExpectationToString is used to explain why RTC_DCHECK_RUN_ON is triggered. Unfortunately, the current implementation only generates verbose strings when SequenceCheckerImpl is passed as an argument. Modify ExpectationToString to generate detailed messages even for derived classes of SequenceCheckerImpl. Bug: None Change-Id: I55f76d44ad59dbe6f21cee7d7d8e19188e0f3088 Reviewed-on: https://webrtc-review.googlesource.com/c/src/+/276061 Commit-Queue: Daniel.L (Byoungchan) Lee <daniel.l@hpcnt.com> Reviewed-by: Harald Alvestrand <hta@webrtc.org> Cr-Commit-Position: refs/heads/main@{#38211}
108 lines
3.6 KiB
C++
108 lines
3.6 KiB
C++
/*
|
|
* Copyright 2019 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.
|
|
*/
|
|
#include "rtc_base/synchronization/sequence_checker_internal.h"
|
|
|
|
#include <string>
|
|
|
|
#if defined(WEBRTC_MAC)
|
|
#include <dispatch/dispatch.h>
|
|
#endif
|
|
|
|
#include "rtc_base/checks.h"
|
|
#include "rtc_base/strings/string_builder.h"
|
|
|
|
namespace webrtc {
|
|
namespace webrtc_sequence_checker_internal {
|
|
namespace {
|
|
// On Mac, returns the label of the current dispatch queue; elsewhere, return
|
|
// null.
|
|
const void* GetSystemQueueRef() {
|
|
#if defined(WEBRTC_MAC)
|
|
return dispatch_queue_get_label(DISPATCH_CURRENT_QUEUE_LABEL);
|
|
#else
|
|
return nullptr;
|
|
#endif
|
|
}
|
|
|
|
} // namespace
|
|
|
|
SequenceCheckerImpl::SequenceCheckerImpl()
|
|
: attached_(true),
|
|
valid_thread_(rtc::CurrentThreadRef()),
|
|
valid_queue_(TaskQueueBase::Current()),
|
|
valid_system_queue_(GetSystemQueueRef()) {}
|
|
|
|
bool SequenceCheckerImpl::IsCurrent() const {
|
|
const TaskQueueBase* const current_queue = TaskQueueBase::Current();
|
|
const rtc::PlatformThreadRef current_thread = rtc::CurrentThreadRef();
|
|
const void* const current_system_queue = GetSystemQueueRef();
|
|
MutexLock scoped_lock(&lock_);
|
|
if (!attached_) { // Previously detached.
|
|
attached_ = true;
|
|
valid_thread_ = current_thread;
|
|
valid_queue_ = current_queue;
|
|
valid_system_queue_ = current_system_queue;
|
|
return true;
|
|
}
|
|
if (valid_queue_) {
|
|
return valid_queue_ == current_queue;
|
|
}
|
|
if (valid_system_queue_ && valid_system_queue_ == current_system_queue) {
|
|
return true;
|
|
}
|
|
return rtc::IsThreadRefEqual(valid_thread_, current_thread);
|
|
}
|
|
|
|
void SequenceCheckerImpl::Detach() {
|
|
MutexLock scoped_lock(&lock_);
|
|
attached_ = false;
|
|
// We don't need to touch the other members here, they will be
|
|
// reset on the next call to IsCurrent().
|
|
}
|
|
|
|
#if RTC_DCHECK_IS_ON
|
|
std::string SequenceCheckerImpl::ExpectationToString() const {
|
|
const TaskQueueBase* const current_queue = TaskQueueBase::Current();
|
|
const rtc::PlatformThreadRef current_thread = rtc::CurrentThreadRef();
|
|
const void* const current_system_queue = GetSystemQueueRef();
|
|
MutexLock scoped_lock(&lock_);
|
|
if (!attached_)
|
|
return "Checker currently not attached.";
|
|
|
|
// The format of the string is meant to compliment the one we have inside of
|
|
// FatalLog() (checks.cc). Example:
|
|
//
|
|
// # Expected: TQ: 0x0 SysQ: 0x7fff69541330 Thread: 0x11dcf6dc0
|
|
// # Actual: TQ: 0x7fa8f0604190 SysQ: 0x7fa8f0604a30 Thread: 0x700006f1a000
|
|
// TaskQueue doesn't match
|
|
|
|
rtc::StringBuilder message;
|
|
message.AppendFormat(
|
|
"# Expected: TQ: %p SysQ: %p Thread: %p\n"
|
|
"# Actual: TQ: %p SysQ: %p Thread: %p\n",
|
|
valid_queue_, valid_system_queue_,
|
|
reinterpret_cast<const void*>(valid_thread_), current_queue,
|
|
current_system_queue, reinterpret_cast<const void*>(current_thread));
|
|
|
|
if ((valid_queue_ || current_queue) && valid_queue_ != current_queue) {
|
|
message << "TaskQueue doesn't match\n";
|
|
} else if (valid_system_queue_ &&
|
|
valid_system_queue_ != current_system_queue) {
|
|
message << "System queue doesn't match\n";
|
|
} else if (!rtc::IsThreadRefEqual(valid_thread_, current_thread)) {
|
|
message << "Threads don't match\n";
|
|
}
|
|
|
|
return message.Release();
|
|
}
|
|
#endif // RTC_DCHECK_IS_ON
|
|
|
|
} // namespace webrtc_sequence_checker_internal
|
|
} // namespace webrtc
|