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
|
// -*- 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 "nsIThread.h"
#include "nsThreadUtils.h"
#ifndef mozilla_glean_HistogramGifftMap_h
#define mozilla_glean_HistogramGifftMap_h
#define DYNAMIC_METRIC_BIT (26)
#define GLEAN_METRIC_ID(id) ((id) & ((1ULL << 27) - 1))
namespace mozilla::glean {
using Telemetry::HistogramID;
using MetricId = uint32_t; // Same type as in api/src/private/mod.rs
using TimerId = uint64_t; // Same as in TimingDistribution.h.
struct MetricTimerTuple {
MetricId mMetricId;
TimerId mTimerId;
};
class MetricTimerTupleHashKey : public PLDHashEntryHdr {
public:
using KeyType = const MetricTimerTuple&;
using KeyTypePointer = const MetricTimerTuple*;
explicit MetricTimerTupleHashKey(KeyTypePointer aKey) : mValue(*aKey) {}
MetricTimerTupleHashKey(MetricTimerTupleHashKey&& aOther)
: PLDHashEntryHdr(std::move(aOther)),
mValue(std::move(aOther.mValue)) {}
~MetricTimerTupleHashKey() = default;
KeyType GetKey() const { return mValue; }
bool KeyEquals(KeyTypePointer aKey) const {
return aKey->mMetricId == mValue.mMetricId &&
aKey->mTimerId == mValue.mTimerId;
}
static KeyTypePointer KeyToPointer(KeyType aKey) { return &aKey; }
static PLDHashNumber HashKey(KeyTypePointer aKey) {
// Chosen because this is how nsIntegralHashKey does it.
return HashGeneric(aKey->mMetricId, aKey->mTimerId);
}
enum { ALLOW_MEMMOVE = true };
static_assert(std::is_trivially_copyable_v<MetricTimerTuple>);
private:
const MetricTimerTuple mValue;
};
typedef StaticDataMutex<UniquePtr<nsTHashMap<MetricTimerTupleHashKey, TimeStamp>>> TimerToStampMutex;
static inline Maybe<TimerToStampMutex::AutoLock> GetTimerIdToStartsLock() {
static TimerToStampMutex sTimerIdToStarts("sTimerIdToStarts");
auto lock = sTimerIdToStarts.Lock();
// GIFFT will work up to the end of AppShutdownTelemetry.
if (AppShutdown::IsInOrBeyond(ShutdownPhase::XPCOMWillShutdown)) {
return Nothing();
}
if (!*lock) {
*lock = MakeUnique<nsTHashMap<MetricTimerTupleHashKey, TimeStamp>>();
RefPtr<nsIRunnable> cleanupFn = NS_NewRunnableFunction(__func__, [&] {
if (AppShutdown::IsInOrBeyond(ShutdownPhase::XPCOMWillShutdown)) {
auto lock = sTimerIdToStarts.Lock();
*lock = nullptr; // deletes, see UniquePtr.h
return;
}
RunOnShutdown([&] {
auto lock = sTimerIdToStarts.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 Maybe<HistogramID> HistogramIdForMetric(uint32_t aId) {
switch(aId) {
case 3: { // test.custom_distribution_metric
return Some(HistogramID::SOME_LINEAR_HISTOGRAM);
}
case 10: { // test.memory_distribution_metric
return Some(HistogramID::SOME_MEM_HISTOGRAM_KB);
}
case 15: { // test.timing_distribution_metric
return Some(HistogramID::SOME_TIME_HISTOGRAM_MS);
}
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 HistogramIdForMetric(staticId);
}
}
}
return Nothing();
}
}
}
} // namespace mozilla::glean
#undef GLEAN_METRIC_ID
#undef DYNAMIC_METRIC_BIT
#endif // mozilla_glean_HistogramGifftMaps_h
|
