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 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351
|
/* -*- 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/. */
#include "TelemetryIPCAccumulator.h"
#include "core/TelemetryScalar.h"
#include "mozilla/TelemetryProcessEnums.h"
#include "mozilla/dom/ContentChild.h"
#include "mozilla/gfx/GPUParent.h"
#include "mozilla/RDDParent.h"
#include "mozilla/net/SocketProcessChild.h"
#include "mozilla/ipc/UtilityProcessChild.h"
#include "mozilla/SchedulerGroup.h"
#include "mozilla/StaticMutex.h"
#include "mozilla/StaticPrefs_toolkit.h"
#include "mozilla/StaticPtr.h"
#include "mozilla/Unused.h"
#include "nsITimer.h"
#include "nsThreadUtils.h"
using mozilla::StaticAutoPtr;
using mozilla::StaticMutex;
using mozilla::StaticMutexAutoLock;
using mozilla::Telemetry::ChildEventData;
using mozilla::Telemetry::DiscardedData;
using mozilla::Telemetry::HistogramAccumulation;
using mozilla::Telemetry::KeyedHistogramAccumulation;
using mozilla::Telemetry::KeyedScalarAction;
using mozilla::Telemetry::ScalarAction;
using mozilla::Telemetry::ScalarActionType;
using mozilla::Telemetry::ScalarVariant;
namespace TelemetryIPCAccumulator = mozilla::TelemetryIPCAccumulator;
// To stop growing unbounded in memory while waiting for
// StaticPrefs::toolkit_telemetry_ipcBatchTimeout() milliseconds to drain the
// probe accumulation arrays, we request an immediate flush if the arrays
// manage to reach certain high water mark of elements.
const size_t kHistogramAccumulationsArrayHighWaterMark = 5 * 1024;
const size_t kScalarActionsArrayHighWaterMark = 10000;
// With the current limits, events cost us about 1100 bytes each.
// This limits memory use to about 10MB.
const size_t kEventsArrayHighWaterMark = 10000;
// If we are starved we can overshoot the watermark.
// This is the multiplier over which we will discard data.
const size_t kWaterMarkDiscardFactor = 5;
// Counts of how many pieces of data we have discarded.
DiscardedData gDiscardedData = {0};
// This timer is used for batching and sending child process accumulations to
// the parent.
nsITimer* gIPCTimer = nullptr;
mozilla::Atomic<bool, mozilla::Relaxed> gIPCTimerArmed(false);
mozilla::Atomic<bool, mozilla::Relaxed> gIPCTimerArming(false);
// This batches child process accumulations that should be sent to the parent.
StaticAutoPtr<nsTArray<HistogramAccumulation>> gHistogramAccumulations;
StaticAutoPtr<nsTArray<KeyedHistogramAccumulation>>
gKeyedHistogramAccumulations;
StaticAutoPtr<nsTArray<ScalarAction>> gChildScalarsActions;
StaticAutoPtr<nsTArray<KeyedScalarAction>> gChildKeyedScalarsActions;
StaticAutoPtr<nsTArray<ChildEventData>> gChildEvents;
// This is a StaticMutex rather than a plain Mutex so that (1)
// it gets initialised in a thread-safe manner the first time
// it is used, and (2) because it is never de-initialised, and
// a normal Mutex would show up as a leak in BloatView. StaticMutex
// also has the "OffTheBooks" property, so it won't show as a leak
// in BloatView.
static StaticMutex gTelemetryIPCAccumulatorMutex MOZ_UNANNOTATED;
namespace {
void DoArmIPCTimerMainThread(const StaticMutexAutoLock& lock) {
MOZ_ASSERT(NS_IsMainThread());
gIPCTimerArming = false;
if (gIPCTimerArmed) {
return;
}
if (!gIPCTimer) {
gIPCTimer = NS_NewTimer().take();
}
if (gIPCTimer) {
gIPCTimer->InitWithNamedFuncCallback(
TelemetryIPCAccumulator::IPCTimerFired, nullptr,
mozilla::StaticPrefs::toolkit_telemetry_ipcBatchTimeout(),
nsITimer::TYPE_ONE_SHOT_LOW_PRIORITY,
"TelemetryIPCAccumulator::IPCTimerFired");
gIPCTimerArmed = true;
}
}
void ArmIPCTimer(const StaticMutexAutoLock& lock) {
if (gIPCTimerArmed || gIPCTimerArming) {
return;
}
gIPCTimerArming = true;
if (NS_IsMainThread()) {
DoArmIPCTimerMainThread(lock);
} else {
TelemetryIPCAccumulator::DispatchToMainThread(NS_NewRunnableFunction(
"TelemetryIPCAccumulator::ArmIPCTimer", []() -> void {
StaticMutexAutoLock locker(gTelemetryIPCAccumulatorMutex);
DoArmIPCTimerMainThread(locker);
}));
}
}
void DispatchIPCTimerFired() {
TelemetryIPCAccumulator::DispatchToMainThread(NS_NewRunnableFunction(
"TelemetryIPCAccumulator::IPCTimerFired", []() -> void {
TelemetryIPCAccumulator::IPCTimerFired(nullptr, nullptr);
}));
}
} // anonymous namespace
////////////////////////////////////////////////////////////////////////
////////////////////////////////////////////////////////////////////////
//
// EXTERNALLY VISIBLE FUNCTIONS in namespace TelemetryIPCAccumulator::
void TelemetryIPCAccumulator::AccumulateChildHistogram(
mozilla::Telemetry::HistogramID aId, uint32_t aSample) {
StaticMutexAutoLock locker(gTelemetryIPCAccumulatorMutex);
if (!gHistogramAccumulations) {
gHistogramAccumulations = new nsTArray<HistogramAccumulation>();
}
if (gHistogramAccumulations->Length() >=
kWaterMarkDiscardFactor * kHistogramAccumulationsArrayHighWaterMark) {
gDiscardedData.mDiscardedHistogramAccumulations++;
return;
}
if (gHistogramAccumulations->Length() ==
kHistogramAccumulationsArrayHighWaterMark) {
DispatchIPCTimerFired();
}
gHistogramAccumulations->AppendElement(HistogramAccumulation{aId, aSample});
ArmIPCTimer(locker);
}
void TelemetryIPCAccumulator::AccumulateChildKeyedHistogram(
mozilla::Telemetry::HistogramID aId, const nsCString& aKey,
uint32_t aSample) {
StaticMutexAutoLock locker(gTelemetryIPCAccumulatorMutex);
if (!gKeyedHistogramAccumulations) {
gKeyedHistogramAccumulations = new nsTArray<KeyedHistogramAccumulation>();
}
if (gKeyedHistogramAccumulations->Length() >=
kWaterMarkDiscardFactor * kHistogramAccumulationsArrayHighWaterMark) {
gDiscardedData.mDiscardedKeyedHistogramAccumulations++;
return;
}
if (gKeyedHistogramAccumulations->Length() ==
kHistogramAccumulationsArrayHighWaterMark) {
DispatchIPCTimerFired();
}
gKeyedHistogramAccumulations->AppendElement(
KeyedHistogramAccumulation{aId, aSample, aKey});
ArmIPCTimer(locker);
}
void TelemetryIPCAccumulator::RecordChildScalarAction(
uint32_t aId, bool aDynamic, ScalarActionType aAction,
const ScalarVariant& aValue) {
StaticMutexAutoLock locker(gTelemetryIPCAccumulatorMutex);
// Make sure to have the storage.
if (!gChildScalarsActions) {
gChildScalarsActions = new nsTArray<ScalarAction>();
}
if (gChildScalarsActions->Length() >=
kWaterMarkDiscardFactor * kScalarActionsArrayHighWaterMark) {
gDiscardedData.mDiscardedScalarActions++;
return;
}
if (gChildScalarsActions->Length() == kScalarActionsArrayHighWaterMark) {
DispatchIPCTimerFired();
}
// Store the action. The ProcessID will be determined by the receiver.
gChildScalarsActions->AppendElement(ScalarAction{
aId, aDynamic, aAction, Some(aValue), Telemetry::ProcessID::Count});
ArmIPCTimer(locker);
}
void TelemetryIPCAccumulator::RecordChildKeyedScalarAction(
uint32_t aId, bool aDynamic, const nsAString& aKey,
ScalarActionType aAction, const ScalarVariant& aValue) {
StaticMutexAutoLock locker(gTelemetryIPCAccumulatorMutex);
// Make sure to have the storage.
if (!gChildKeyedScalarsActions) {
gChildKeyedScalarsActions = new nsTArray<KeyedScalarAction>();
}
if (gChildKeyedScalarsActions->Length() >=
kWaterMarkDiscardFactor * kScalarActionsArrayHighWaterMark) {
gDiscardedData.mDiscardedKeyedScalarActions++;
return;
}
if (gChildKeyedScalarsActions->Length() == kScalarActionsArrayHighWaterMark) {
DispatchIPCTimerFired();
}
// Store the action. The ProcessID will be determined by the receiver.
gChildKeyedScalarsActions->AppendElement(
KeyedScalarAction{aId, aDynamic, aAction, NS_ConvertUTF16toUTF8(aKey),
Some(aValue), Telemetry::ProcessID::Count});
ArmIPCTimer(locker);
}
void TelemetryIPCAccumulator::RecordChildEvent(
const mozilla::TimeStamp& timestamp, const nsACString& category,
const nsACString& method, const nsACString& object,
const mozilla::Maybe<nsCString>& value,
const nsTArray<mozilla::Telemetry::EventExtraEntry>& extra) {
StaticMutexAutoLock locker(gTelemetryIPCAccumulatorMutex);
if (!gChildEvents) {
gChildEvents = new nsTArray<ChildEventData>();
}
if (gChildEvents->Length() >=
kWaterMarkDiscardFactor * kEventsArrayHighWaterMark) {
gDiscardedData.mDiscardedChildEvents++;
return;
}
if (gChildEvents->Length() == kEventsArrayHighWaterMark) {
DispatchIPCTimerFired();
}
// Store the event.
gChildEvents->AppendElement(
ChildEventData{timestamp, nsCString(category), nsCString(method),
nsCString(object), value, extra.Clone()});
ArmIPCTimer(locker);
}
// This method takes the lock only to double-buffer the batched telemetry.
// It releases the lock before calling out to IPC code which can (and does)
// Accumulate (which would deadlock)
template <class TActor>
static void SendAccumulatedData(TActor* ipcActor) {
// Get the accumulated data and free the storage buffers.
nsTArray<HistogramAccumulation> histogramsToSend;
nsTArray<KeyedHistogramAccumulation> keyedHistogramsToSend;
nsTArray<ScalarAction> scalarsToSend;
nsTArray<KeyedScalarAction> keyedScalarsToSend;
nsTArray<ChildEventData> eventsToSend;
DiscardedData discardedData;
{
StaticMutexAutoLock locker(gTelemetryIPCAccumulatorMutex);
if (gHistogramAccumulations) {
histogramsToSend = std::move(*gHistogramAccumulations);
}
if (gKeyedHistogramAccumulations) {
keyedHistogramsToSend = std::move(*gKeyedHistogramAccumulations);
}
if (gChildScalarsActions) {
scalarsToSend = std::move(*gChildScalarsActions);
}
if (gChildKeyedScalarsActions) {
keyedScalarsToSend = std::move(*gChildKeyedScalarsActions);
}
if (gChildEvents) {
eventsToSend = std::move(*gChildEvents);
}
discardedData = gDiscardedData;
gDiscardedData = {0};
}
// Send the accumulated data to the parent process.
MOZ_ASSERT(ipcActor);
if (histogramsToSend.Length()) {
mozilla::Unused << NS_WARN_IF(
!ipcActor->SendAccumulateChildHistograms(histogramsToSend));
}
if (keyedHistogramsToSend.Length()) {
mozilla::Unused << NS_WARN_IF(
!ipcActor->SendAccumulateChildKeyedHistograms(keyedHistogramsToSend));
}
if (scalarsToSend.Length()) {
mozilla::Unused << NS_WARN_IF(
!ipcActor->SendUpdateChildScalars(scalarsToSend));
}
if (keyedScalarsToSend.Length()) {
mozilla::Unused << NS_WARN_IF(
!ipcActor->SendUpdateChildKeyedScalars(keyedScalarsToSend));
}
if (eventsToSend.Length()) {
mozilla::Unused << NS_WARN_IF(
!ipcActor->SendRecordChildEvents(eventsToSend));
}
mozilla::Unused << NS_WARN_IF(
!ipcActor->SendRecordDiscardedData(discardedData));
}
// To ensure we don't loop IPCTimerFired->AccumulateChild->arm timer, we don't
// unset gIPCTimerArmed until the IPC completes
//
// This function must be called on the main thread, otherwise IPC will fail.
void TelemetryIPCAccumulator::IPCTimerFired(nsITimer* aTimer, void* aClosure) {
MOZ_ASSERT(NS_IsMainThread());
// Send accumulated data to the correct parent process.
switch (XRE_GetProcessType()) {
case GeckoProcessType_Content:
SendAccumulatedData(mozilla::dom::ContentChild::GetSingleton());
break;
case GeckoProcessType_GPU:
SendAccumulatedData(mozilla::gfx::GPUParent::GetSingleton());
break;
case GeckoProcessType_RDD:
SendAccumulatedData(mozilla::RDDParent::GetSingleton());
break;
case GeckoProcessType_Socket:
SendAccumulatedData(mozilla::net::SocketProcessChild::GetSingleton());
break;
case GeckoProcessType_Utility:
SendAccumulatedData(
mozilla::ipc::UtilityProcessChild::GetSingleton().get());
break;
default:
MOZ_ASSERT_UNREACHABLE("Unsupported process type");
break;
}
gIPCTimerArmed = false;
}
void TelemetryIPCAccumulator::DeInitializeGlobalState() {
MOZ_ASSERT(NS_IsMainThread());
StaticMutexAutoLock locker(gTelemetryIPCAccumulatorMutex);
if (gIPCTimer) {
NS_RELEASE(gIPCTimer);
}
gHistogramAccumulations = nullptr;
gKeyedHistogramAccumulations = nullptr;
gChildScalarsActions = nullptr;
gChildKeyedScalarsActions = nullptr;
gChildEvents = nullptr;
}
void TelemetryIPCAccumulator::DispatchToMainThread(
already_AddRefed<nsIRunnable>&& aEvent) {
SchedulerGroup::Dispatch(std::move(aEvent));
}
|