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
|
/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2; -*- */
/* 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 TelemetryScalar_h__
#define TelemetryScalar_h__
#include <stdint.h>
#include "mozilla/TelemetryProcessEnums.h"
#include "mozilla/TelemetryScalarEnums.h"
#include "nsTArray.h"
#include "TelemetryCommon.h"
// This module is internal to Telemetry. It encapsulates Telemetry's
// scalar accumulation and storage logic. It should only be used by
// Telemetry.cpp. These functions should not be used anywhere else.
// For the public interface to Telemetry functionality, see Telemetry.h.
namespace mozilla {
namespace Telemetry {
struct ScalarAction;
struct KeyedScalarAction;
struct DiscardedData;
struct DynamicScalarDefinition;
} // namespace Telemetry
} // namespace mozilla
namespace TelemetryScalar {
void InitializeGlobalState(bool canRecordBase, bool canRecordExtended);
void DeInitializeGlobalState();
void SetCanRecordBase(bool b);
void SetCanRecordExtended(bool b);
// JS API Endpoints.
nsresult Add(const nsACString& aName, JS::Handle<JS::Value> aVal,
JSContext* aCx);
nsresult Set(const nsACString& aName, JS::Handle<JS::Value> aVal,
JSContext* aCx);
nsresult SetMaximum(const nsACString& aName, JS::Handle<JS::Value> aVal,
JSContext* aCx);
nsresult CreateSnapshots(unsigned int aDataset, bool aClearScalars,
JSContext* aCx, uint8_t optional_argc,
JS::MutableHandle<JS::Value> aResult, bool aFilterTest,
const nsACString& aStoreName);
// Keyed JS API Endpoints.
nsresult Add(const nsACString& aName, const nsAString& aKey,
JS::Handle<JS::Value> aVal, JSContext* aCx);
nsresult Set(const nsACString& aName, const nsAString& aKey,
JS::Handle<JS::Value> aVal, JSContext* aCx);
nsresult SetMaximum(const nsACString& aName, const nsAString& aKey,
JS::Handle<JS::Value> aVal, JSContext* aCx);
nsresult CreateKeyedSnapshots(unsigned int aDataset, bool aClearScalars,
JSContext* aCx, uint8_t optional_argc,
JS::MutableHandle<JS::Value> aResult,
bool aFilterTest, const nsACString& aStoreName);
// C++ API Endpoints.
void Add(mozilla::Telemetry::ScalarID aId, uint32_t aValue);
void Set(mozilla::Telemetry::ScalarID aId, uint32_t aValue);
void Set(mozilla::Telemetry::ScalarID aId, const nsAString& aValue);
void Set(mozilla::Telemetry::ScalarID aId, bool aValue);
void SetMaximum(mozilla::Telemetry::ScalarID aId, uint32_t aValue);
// Keyed C++ API Endpoints.
void Add(mozilla::Telemetry::ScalarID aId, const nsAString& aKey,
uint32_t aValue);
void Set(mozilla::Telemetry::ScalarID aId, const nsAString& aKey,
uint32_t aValue);
void Set(mozilla::Telemetry::ScalarID aId, const nsAString& aKey, bool aValue);
void SetMaximum(mozilla::Telemetry::ScalarID aId, const nsAString& aKey,
uint32_t aValue);
nsresult RegisterScalars(const nsACString& aCategoryName,
JS::Handle<JS::Value> aScalarData, bool aBuiltin,
JSContext* cx);
// Event Summary
void SummarizeEvent(const nsCString& aUniqueEventName,
mozilla::Telemetry::ProcessID aProcessType, bool aDynamic);
// Only to be used for testing.
void ClearScalars();
size_t GetMapShallowSizesOfExcludingThis(mozilla::MallocSizeOf aMallocSizeOf);
size_t GetScalarSizesOfIncludingThis(mozilla::MallocSizeOf aMallocSizeOf);
void UpdateChildData(
mozilla::Telemetry::ProcessID aProcessType,
const nsTArray<mozilla::Telemetry::ScalarAction>& aScalarActions);
void UpdateChildKeyedData(
mozilla::Telemetry::ProcessID aProcessType,
const nsTArray<mozilla::Telemetry::KeyedScalarAction>& aScalarActions);
void RecordDiscardedData(
mozilla::Telemetry::ProcessID aProcessType,
const mozilla::Telemetry::DiscardedData& aDiscardedData);
void GetDynamicScalarDefinitions(
nsTArray<mozilla::Telemetry::DynamicScalarDefinition>&);
void AddDynamicScalarDefinitions(
const nsTArray<mozilla::Telemetry::DynamicScalarDefinition>&);
/**
* Append the list of registered stores to the given set.
* This includes dynamic stores.
*/
nsresult GetAllStores(mozilla::Telemetry::Common::StringHashSet& set);
} // namespace TelemetryScalar
#endif // TelemetryScalar_h__
|
