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
|
// 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 https://mozilla.org/MPL/2.0/.
//! Firefox on Glean (FOG) is the name of the layer that integrates the [Glean SDK][glean-sdk] into Firefox Desktop.
//! It is currently being designed and implemented.
//!
//! The [Glean SDK][glean-sdk] is a data collection library built by Mozilla for use in its products.
//! Like [Telemetry][telemetry], it can be used to
//! (in accordance with our [Privacy Policy][privacy-policy])
//! send anonymous usage statistics to Mozilla in order to make better decisions.
//!
//! Documentation can be found online in the [Firefox Source Docs][docs].
//!
//! [glean-sdk]: https://github.com/mozilla/glean/
//! [book-of-glean]: https://mozilla.github.io/glean/book/index.html
//! [privacy-policy]: https://www.mozilla.org/privacy/
//! [docs]: https://firefox-source-docs.mozilla.org/toolkit/components/glean/
use firefox_on_glean::{ipc, metrics, pings};
use nserror::{nsresult, NS_ERROR_FAILURE, NS_OK};
use nsstring::{nsACString, nsCString};
use thin_vec::ThinVec;
#[macro_use]
extern crate cstr;
#[cfg_attr(not(target_os = "android"), macro_use)]
extern crate xpcom;
mod init;
mod ohttp_pings;
pub use init::fog_init;
#[no_mangle]
pub extern "C" fn fog_shutdown() {
glean::shutdown();
}
#[no_mangle]
pub extern "C" fn fog_register_pings() {
pings::register_pings(None);
}
static mut PENDING_BUF: Vec<u8> = Vec::new();
// IPC serialization/deserialization methods
// Crucially important that the first two not be called on multiple threads.
/// # Safety
/// Only safe if only called on a single thread (the same single thread you call
/// fog_give_ipc_buf on).
#[no_mangle]
pub unsafe extern "C" fn fog_serialize_ipc_buf() -> usize {
if let Some(buf) = ipc::take_buf() {
PENDING_BUF = buf;
PENDING_BUF.len()
} else {
PENDING_BUF = vec![];
0
}
}
/// # Safety
/// Only safe if called on a single thread (the same single thread you call
/// fog_serialize_ipc_buf on), and if buf points to an allocated buffer of at
/// least buf_len bytes.
#[no_mangle]
pub unsafe extern "C" fn fog_give_ipc_buf(buf: *mut u8, buf_len: usize) -> usize {
let pending_len = PENDING_BUF.len();
if buf.is_null() || buf_len < pending_len {
return 0;
}
std::ptr::copy_nonoverlapping(PENDING_BUF.as_ptr(), buf, pending_len);
PENDING_BUF = Vec::new();
pending_len
}
/// # Safety
/// Only safe if buf points to an allocated buffer of at least buf_len bytes.
/// No ownership is transfered to Rust by this method: caller owns the memory at
/// buf before and after this call.
#[no_mangle]
pub unsafe extern "C" fn fog_use_ipc_buf(buf: *const u8, buf_len: usize) {
let slice = std::slice::from_raw_parts(buf, buf_len);
let res = ipc::replay_from_buf(slice);
if res.is_err() {
log::warn!("Unable to replay ipc buffer. This will result in data loss.");
metrics::fog_ipc::replay_failures.add(1);
}
}
/// Sets the debug tag for pings assembled in the future.
/// Returns an error result if the provided value is not a valid tag.
#[no_mangle]
pub extern "C" fn fog_set_debug_view_tag(value: &nsACString) -> nsresult {
let result = glean::set_debug_view_tag(&value.to_string());
if result {
NS_OK
} else {
NS_ERROR_FAILURE
}
}
/// Submits a ping by name.
#[no_mangle]
pub extern "C" fn fog_submit_ping(ping_name: &nsACString) -> nsresult {
glean::submit_ping_by_name(&ping_name.to_string(), None);
NS_OK
}
/// Turns ping logging on or off.
/// Returns an error if the logging failed to be configured.
#[no_mangle]
pub extern "C" fn fog_set_log_pings(value: bool) -> nsresult {
glean::set_log_pings(value);
NS_OK
}
/// Flushes ping-lifetime data to the db when delay_ping_lifetime_io is true.
#[no_mangle]
pub extern "C" fn fog_persist_ping_lifetime_data() -> nsresult {
glean::persist_ping_lifetime_data();
NS_OK
}
/// Indicate that an experiment is running.
/// Glean will add an experiment annotation which is sent with pings.
/// This information is not persisted between runs.
///
/// See [`glean_core::Glean::set_experiment_active`].
#[no_mangle]
pub extern "C" fn fog_set_experiment_active(
experiment_id: &nsACString,
branch: &nsACString,
extra_keys: &ThinVec<nsCString>,
extra_values: &ThinVec<nsCString>,
) {
assert_eq!(
extra_keys.len(),
extra_values.len(),
"Experiment extra keys and values differ in length."
);
let extra = if extra_keys.is_empty() {
None
} else {
Some(
extra_keys
.iter()
.zip(extra_values.iter())
.map(|(k, v)| (k.to_string(), v.to_string()))
.collect(),
)
};
glean::set_experiment_active(experiment_id.to_string(), branch.to_string(), extra);
}
/// Indicate that an experiment is no longer running.
///
/// See [`glean_core::Glean::set_experiment_inactive`].
#[no_mangle]
pub extern "C" fn fog_set_experiment_inactive(experiment_id: &nsACString) {
glean::set_experiment_inactive(experiment_id.to_string());
}
/// TEST ONLY FUNCTION
///
/// Returns true if the identified experiment is active.
#[no_mangle]
pub extern "C" fn fog_test_is_experiment_active(experiment_id: &nsACString) -> bool {
glean::test_is_experiment_active(experiment_id.to_string())
}
/// TEST ONLY FUNCTION
///
/// Fills `branch`, `extra_keys`, and `extra_values` with the identified experiment's data.
/// Panics if the identified experiment isn't active.
#[no_mangle]
pub extern "C" fn fog_test_get_experiment_data(
experiment_id: &nsACString,
branch: &mut nsACString,
extra_keys: &mut ThinVec<nsCString>,
extra_values: &mut ThinVec<nsCString>,
) {
let data = glean::test_get_experiment_data(experiment_id.to_string());
if let Some(data) = data {
branch.assign(&data.branch);
if let Some(extra) = data.extra {
let (data_keys, data_values): (Vec<_>, Vec<_>) = extra.iter().unzip();
extra_keys.extend(data_keys.into_iter().map(|key| key.into()));
extra_values.extend(data_values.into_iter().map(|value| value.into()));
}
}
}
/// Sets the remote feature configuration.
///
/// See [`glean_core::Glean::set_metrics_disabled_config`].
#[no_mangle]
pub extern "C" fn fog_set_metrics_feature_config(config_json: &nsACString) {
// Normalize null and empty strings to a stringified empty map
if config_json == "null" || config_json.is_empty() {
glean::glean_set_metrics_enabled_config("{}".to_owned());
}
glean::glean_set_metrics_enabled_config(config_json.to_string());
}
/// Performs Glean tasks when client state changes to inactive
///
/// See [`glean_core::Glean::handle_client_inactive`].
#[no_mangle]
pub extern "C" fn fog_internal_glean_handle_client_inactive() {
glean::handle_client_inactive();
}
|
