91d6edef35
We must remove dependency on Chromium, i.e. we can't use Chromium's base/logging.h. That means we need to define these macros in WebRTC also when doing Chromium builds. And this causes redefinition. Alternative solutions: * Check if we already have defined e.g. CHECK, and don't define them in that case. This makes us depend on include order in Chromium, which is not acceptable. * Don't allow using the macros in WebRTC headers. Error prone since if someone adds it there by mistake it may compile fine, but later break if a header in added or order is changed in Chromium. That will be confusing and hard to enforce. * Ensure that headers that are included by an embedder don't include our macros. This would require some heavy refactoring to be maintainable and enforcable. * Changes in Chromium for this is obviously not an option. BUG=chromium:468375 NOTRY=true Review URL: https://codereview.webrtc.org/1335923002 Cr-Commit-Position: refs/heads/master@{#9964}
92 lines
3.0 KiB
C++
92 lines
3.0 KiB
C++
/*
|
|
* Copyright (c) 2014 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.
|
|
*/
|
|
|
|
// Borrowed from Chromium's src/base/threading/thread_checker.h.
|
|
|
|
#ifndef WEBRTC_BASE_THREAD_CHECKER_H_
|
|
#define WEBRTC_BASE_THREAD_CHECKER_H_
|
|
|
|
// Apart from debug builds, we also enable the thread checker in
|
|
// builds with DCHECK_ALWAYS_ON so that trybots and waterfall bots
|
|
// with this define will get the same level of thread checking as
|
|
// debug bots.
|
|
//
|
|
// Note that this does not perfectly match situations where RTC_DCHECK is
|
|
// enabled. For example a non-official release build may have
|
|
// DCHECK_ALWAYS_ON undefined (and therefore ThreadChecker would be
|
|
// disabled) but have RTC_DCHECKs enabled at runtime.
|
|
#if (!defined(NDEBUG) || defined(DCHECK_ALWAYS_ON))
|
|
#define ENABLE_THREAD_CHECKER 1
|
|
#else
|
|
#define ENABLE_THREAD_CHECKER 0
|
|
#endif
|
|
|
|
#include "webrtc/base/thread_checker_impl.h"
|
|
|
|
namespace rtc {
|
|
|
|
// Do nothing implementation, for use in release mode.
|
|
//
|
|
// Note: You should almost always use the ThreadChecker class to get the
|
|
// right version for your build configuration.
|
|
class ThreadCheckerDoNothing {
|
|
public:
|
|
bool CalledOnValidThread() const {
|
|
return true;
|
|
}
|
|
|
|
void DetachFromThread() {}
|
|
};
|
|
|
|
// ThreadChecker is a helper class used to help verify that some methods of a
|
|
// class are called from the same thread. It provides identical functionality to
|
|
// base::NonThreadSafe, but it is meant to be held as a member variable, rather
|
|
// than inherited from base::NonThreadSafe.
|
|
//
|
|
// While inheriting from base::NonThreadSafe may give a clear indication about
|
|
// the thread-safety of a class, it may also lead to violations of the style
|
|
// guide with regard to multiple inheritance. The choice between having a
|
|
// ThreadChecker member and inheriting from base::NonThreadSafe should be based
|
|
// on whether:
|
|
// - Derived classes need to know the thread they belong to, as opposed to
|
|
// having that functionality fully encapsulated in the base class.
|
|
// - Derived classes should be able to reassign the base class to another
|
|
// thread, via DetachFromThread.
|
|
//
|
|
// If neither of these are true, then having a ThreadChecker member and calling
|
|
// CalledOnValidThread is the preferable solution.
|
|
//
|
|
// Example:
|
|
// class MyClass {
|
|
// public:
|
|
// void Foo() {
|
|
// RTC_DCHECK(thread_checker_.CalledOnValidThread());
|
|
// ... (do stuff) ...
|
|
// }
|
|
//
|
|
// private:
|
|
// ThreadChecker thread_checker_;
|
|
// }
|
|
//
|
|
// In Release mode, CalledOnValidThread will always return true.
|
|
#if ENABLE_THREAD_CHECKER
|
|
class ThreadChecker : public ThreadCheckerImpl {
|
|
};
|
|
#else
|
|
class ThreadChecker : public ThreadCheckerDoNothing {
|
|
};
|
|
#endif // ENABLE_THREAD_CHECKER
|
|
|
|
#undef ENABLE_THREAD_CHECKER
|
|
|
|
} // namespace rtc
|
|
|
|
#endif // WEBRTC_BASE_THREAD_CHECKER_H_
|