1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
|
/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* vim: set ts=8 sts=2 et sw=2 tw=80: */
/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
#ifndef XPCOM_THREADS_EVENTTARGETCAPABILITY_H_
#define XPCOM_THREADS_EVENTTARGETCAPABILITY_H_
#include "mozilla/ThreadSafety.h"
#include "nsIEventTarget.h"
namespace mozilla {
// A helper to ensure that data access and function usage only take place on a
// specific nsIEventTarget.
//
// This class works with Clang's thread safety analysis so that static analysis
// can ensure AssertOnCurrentThread is called before using guarded data and
// functions.
//
// This means using the class is similar to calling
// `MOZ_ASSERT(mTarget->IsOnCurrentThread())`
// prior to accessing things we expect to be on `mTarget`. However, using this
// helper has the added benefit that static analysis will warn you if you
// fail to assert prior to usage.
//
// The following is a basic example of a class using this to ensure
// a data member is only accessed on a specific target.
//
// class SomeMediaHandlerThing {
// public:
// SomeMediaHandlerThing(nsIEventTarget* aTarget) : mTargetCapability(aTarget)
// {}
//
// void UpdateMediaState() {
// mTargetCapability.Dispatch(
// NS_NewRunnableFunction("UpdateMediaState", [this] {
// mTargetCapability.AssertOnCurrentThread();
// IncreaseMediaCount();
// }));
// }
//
// private:
// void IncreaseMediaCount() MOZ_REQUIRES(mTargetCapability) { mMediaCount +=
// 1; }
//
// uint32_t mMediaCount MOZ_GUARDED_BY(mTargetCapability) = 0;
// EventTargetCapability<nsIEventTarget> mTargetCapability;
// };
//
// NOTE: If you need a thread-safety capability for specifically the main
// thread, the static `mozilla::sMainThreadCapability` capability exists, and
// can be asserted using `AssertIsOnMainThread()`.
template <typename T>
class MOZ_CAPABILITY("event target") EventTargetCapability final {
static_assert(std::is_base_of_v<nsIEventTarget, T>,
"T must derive from nsIEventTarget");
public:
explicit EventTargetCapability(T* aTarget) : mTarget(aTarget) {
MOZ_ASSERT(mTarget, "mTarget should be non-null");
}
~EventTargetCapability() = default;
EventTargetCapability(const EventTargetCapability&) = default;
EventTargetCapability(EventTargetCapability&&) = default;
EventTargetCapability& operator=(const EventTargetCapability&) = default;
EventTargetCapability& operator=(EventTargetCapability&&) = default;
void AssertOnCurrentThread() const MOZ_ASSERT_CAPABILITY(this) {
MOZ_ASSERT(IsOnCurrentThread());
}
// Allow users to check if we're on the same thread as the event target.
bool IsOnCurrentThread() const { return mTarget->IsOnCurrentThread(); }
// Allow users to get the event target, so classes don't have to store the
// target as a separate member to use it.
T* GetEventTarget() const { return mTarget; }
// Helper to simplify dispatching to mTarget.
nsresult Dispatch(already_AddRefed<nsIRunnable> aRunnable,
uint32_t aFlags = NS_DISPATCH_NORMAL) const {
return mTarget->Dispatch(std::move(aRunnable), aFlags);
}
private:
RefPtr<T> mTarget;
};
} // namespace mozilla
#endif // XPCOM_THREADS_EVENTTARGETCAPABILITY_H_
|
