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
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
|
// -*- mode: C++ -*-
/* This file is auto-generated by run_glean_parser.py.
It is only for internal use by types in
toolkit/components/glean/bindings/private */
#include "mozilla/AppShutdown.h"
#include "mozilla/ClearOnShutdown.h"
#include "mozilla/glean/bindings/GleanJSMetricsLookup.h"
#include "mozilla/glean/bindings/jog/JOG.h"
#include "mozilla/Maybe.h"
#include "mozilla/Telemetry.h"
#include <tuple>
#include "mozilla/DataMutex.h"
#include "nsClassHashtable.h"
#include "nsTHashMap.h"
#include "nsIThread.h"
#include "nsThreadUtils.h"
#ifndef mozilla_glean_ScalarGifftMap_h
#define mozilla_glean_ScalarGifftMap_h
#define DYNAMIC_METRIC_BIT (26)
#define GLEAN_METRIC_ID(id) ((id) & ((1ULL << 27) - 1))
namespace mozilla::glean {
using Telemetry::ScalarID;
typedef nsUint32HashKey SubmetricIdHashKey;
typedef nsTHashMap<SubmetricIdHashKey, std::tuple<ScalarID, nsString>>
SubmetricToLabeledMirrorMapType;
typedef StaticDataMutex<UniquePtr<SubmetricToLabeledMirrorMapType>>
SubmetricToMirrorMutex;
static inline Maybe<SubmetricToMirrorMutex::AutoLock> GetLabeledMirrorLock() {
static SubmetricToMirrorMutex sLabeledMirrors("sLabeledMirrors");
auto lock = sLabeledMirrors.Lock();
// GIFFT will work up to the end of AppShutdownTelemetry.
if (AppShutdown::IsInOrBeyond(ShutdownPhase::XPCOMWillShutdown)) {
return Nothing();
}
if (!*lock) {
*lock = MakeUnique<SubmetricToLabeledMirrorMapType>();
RefPtr<nsIRunnable> cleanupFn = NS_NewRunnableFunction(__func__, [&] {
if (AppShutdown::IsInOrBeyond(ShutdownPhase::XPCOMWillShutdown)) {
auto lock = sLabeledMirrors.Lock();
*lock = nullptr; // deletes, see UniquePtr.h
return;
}
RunOnShutdown([&] {
auto lock = sLabeledMirrors.Lock();
*lock = nullptr; // deletes, see UniquePtr.h
}, ShutdownPhase::XPCOMWillShutdown);
});
// Both getting the main thread and dispatching to it can fail.
// In that event we leak. Grab a pointer so we have something to NS_RELEASE
// in that case.
nsIRunnable* temp = cleanupFn.get();
nsCOMPtr<nsIThread> mainThread;
if (NS_FAILED(NS_GetMainThread(getter_AddRefs(mainThread)))
|| NS_FAILED(mainThread->Dispatch(cleanupFn.forget(), nsIThread::DISPATCH_NORMAL))
) {
// Failed to dispatch cleanup routine.
// First, un-leak the runnable (but only if we actually attempted dispatch)
if (!cleanupFn) {
NS_RELEASE(temp);
}
// Next, cleanup immediately, and allow metrics to try again later.
*lock = nullptr;
return Nothing();
}
}
return Some(std::move(lock));
}
namespace {
class ScalarIDHashKey : public PLDHashEntryHdr {
public:
typedef const ScalarID& KeyType;
typedef const ScalarID* KeyTypePointer;
explicit ScalarIDHashKey(KeyTypePointer aKey) : mValue(*aKey) {}
ScalarIDHashKey(ScalarIDHashKey&& aOther)
: PLDHashEntryHdr(std::move(aOther)), mValue(std::move(aOther.mValue)) {}
~ScalarIDHashKey() = default;
KeyType GetKey() const { return mValue; }
bool KeyEquals(KeyTypePointer aKey) const { return *aKey == mValue; }
static KeyTypePointer KeyToPointer(KeyType aKey) { return &aKey; }
static PLDHashNumber HashKey(KeyTypePointer aKey) {
return static_cast<std::underlying_type<ScalarID>::type>(*aKey);
}
enum { ALLOW_MEMMOVE = true };
private:
const ScalarID mValue;
};
} // namespace
typedef StaticDataMutex<UniquePtr<nsTHashMap<ScalarIDHashKey, TimeStamp>>> TimesToStartsMutex;
static inline Maybe<TimesToStartsMutex::AutoLock> GetTimesToStartsLock() {
static TimesToStartsMutex sTimespanStarts("sTimespanStarts");
auto lock = sTimespanStarts.Lock();
// GIFFT will work up to the end of AppShutdownTelemetry.
if (AppShutdown::IsInOrBeyond(ShutdownPhase::XPCOMWillShutdown)) {
return Nothing();
}
if (!*lock) {
*lock = MakeUnique<nsTHashMap<ScalarIDHashKey, TimeStamp>>();
RefPtr<nsIRunnable> cleanupFn = NS_NewRunnableFunction(__func__, [&] {
if (AppShutdown::IsInOrBeyond(ShutdownPhase::XPCOMWillShutdown)) {
auto lock = sTimespanStarts.Lock();
*lock = nullptr; // deletes, see UniquePtr.h
return;
}
RunOnShutdown([&] {
auto lock = sTimespanStarts.Lock();
*lock = nullptr; // deletes, see UniquePtr.h
}, ShutdownPhase::XPCOMWillShutdown);
});
// Both getting the main thread and dispatching to it can fail.
// In that event we leak. Grab a pointer so we have something to NS_RELEASE
// in that case.
nsIRunnable* temp = cleanupFn.get();
nsCOMPtr<nsIThread> mainThread;
if (NS_FAILED(NS_GetMainThread(getter_AddRefs(mainThread)))
|| NS_FAILED(mainThread->Dispatch(cleanupFn.forget(), nsIThread::DISPATCH_NORMAL))
) {
// Failed to dispatch cleanup routine.
// First, un-leak the runnable (but only if we actually attempted dispatch)
if (!cleanupFn) {
NS_RELEASE(temp);
}
// Next, cleanup immediately, and allow metrics to try again later.
*lock = nullptr;
return Nothing();
}
}
return Some(std::move(lock));
}
static inline bool IsSubmetricId(uint32_t aId) {
// Submetrics have the 2^25 bit set.
// (ID_BITS - ID_SIGNAL_BITS, keep it in sync with js.py).
return (aId & (1 << 25)) > 0;
}
static inline Maybe<ScalarID> ScalarIdForMetric(uint32_t aId) {
switch(aId) {
case 1: { // test.boolean_metric
return Some(ScalarID::SOME_BOOL_SCALAR);
}
case 2: { // test.counter_metric
return Some(ScalarID::SOME_UINT_SCALAR);
}
case 4: { // test.labeled_boolean_metric
return Some(ScalarID::SOME_KEYED_BOOL_SCALAR);
}
case 5: { // test.labeled_boolean_metric_labels
return Some(ScalarID::SOME_OTHER_KEYED_BOOL_SCALAR);
}
case 6: { // test.labeled_counter_metric
return Some(ScalarID::SOME_KEYED_UINT_SCALAR);
}
case 7: { // test.labeled_counter_metric_labels
return Some(ScalarID::SOME_OTHER_KEYED_UINT_SCALAR);
}
case 11: { // test.string_list_metric
return Some(ScalarID::YET_ANOTHER_KEYED_BOOL_SCALAR);
}
case 12: { // test.string_metric
return Some(ScalarID::SOME_STRING_SCALAR);
}
case 14: { // test.timespan_metric
return Some(ScalarID::SOME_OTHER_UINT_SCALAR);
}
case 16: { // test.nested.datetime_metric
return Some(ScalarID::SOME_STILL_OTHER_STRING_SCALAR);
}
case 20: { // test.nested.quantity_metric
return Some(ScalarID::TELEMETRY_TEST_MIRROR_FOR_QUANTITY);
}
case 23: { // test.nested.uuid_metric
return Some(ScalarID::SOME_OTHER_STRING_SCALAR);
}
default: {
if (MOZ_UNLIKELY(aId & (1 << DYNAMIC_METRIC_BIT))) {
// Dynamic (runtime-registered) metric. Use its static (compiletime-
// registered) metric's telemetry_mirror mapping.
// ...if applicable.
// Only JS can use dynamic (runtime-registered) metric ids.
MOZ_ASSERT(NS_IsMainThread());
auto metricName = JOG::GetMetricName(aId);
// All of these should have names, but the storage only lasts until
// XPCOMWillShutdown, so it might return `Nothing()`.
if (metricName.isSome()) {
auto maybeMetric = MetricByNameLookup(metricName.ref());
if (maybeMetric.isSome()) {
uint32_t staticId = GLEAN_METRIC_ID(maybeMetric.value());
// Let's ensure we don't infinite loop, huh.
MOZ_ASSERT(!(staticId & (1 << DYNAMIC_METRIC_BIT)));
return ScalarIdForMetric(staticId);
}
}
}
return Nothing();
}
}
}
} // namespace mozilla::glean
#undef GLEAN_METRIC_ID
#undef DYNAMIC_METRIC_BIT
#endif // mozilla_glean_ScalarGifftMaps_h
|
