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
|
/*
* Copyright (C) 2024 The Android Open Source Project
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
use super::event::Event;
use super::event_type::EventType;
use super::storage::Storage;
use crate::cxxffi::uptimeMillis;
use once_cell::sync::Lazy;
use std::fmt;
use std::sync::atomic::{AtomicU64, Ordering};
// Lazily initialized static instance of DebugStore.
static INSTANCE: Lazy<DebugStore> = Lazy::new(DebugStore::new);
/// The `DebugStore` struct is responsible for managing debug events and data.
pub struct DebugStore {
/// Atomic counter for generating unique event IDs.
id_generator: AtomicU64,
/// Non-blocking storage for debug events.
event_store: Storage<Event, { DebugStore::DEFAULT_EVENT_LIMIT }>,
}
impl DebugStore {
/// The default limit for the number of events that can be stored.
///
/// This limit is used to initialize the storage for debug events.
const DEFAULT_EVENT_LIMIT: usize = 16;
/// A designated identifier used for events that cannot be closed.
///
/// This ID is used for point/instantaneous events, or events do not have
/// a distinct end.
const NON_CLOSABLE_ID: u64 = 0;
/// The version number for the encoding of debug store data.
///
/// This constant is used as a part of the debug store's data format,
/// allowing for version tracking and compatibility checks.
const ENCODE_VERSION: u32 = 1;
/// Creates a new instance of `DebugStore` with specified event limit and maximum delay.
fn new() -> Self {
Self { id_generator: AtomicU64::new(1), event_store: Storage::new() }
}
/// Returns a shared instance of `DebugStore`.
///
/// This method provides a singleton pattern access to `DebugStore`.
pub fn get_instance() -> &'static DebugStore {
&INSTANCE
}
/// Begins a new debug event with the given name and data.
///
/// This method logs the start of a debug event, assigning it a unique ID and marking its start time.
/// - `name`: The name of the debug event.
/// - `data`: Associated data as key-value pairs.
/// - Returns: A unique ID for the debug event.
pub fn begin(&self, name: String, data: Vec<(String, String)>) -> u64 {
let id = self.generate_id();
self.event_store.insert(Event::new(
id,
Some(name),
uptimeMillis(),
EventType::DurationStart,
data,
));
id
}
/// Records a debug event without a specific duration, with the given name and data.
///
/// This method logs an instantaneous debug event, useful for events that don't have a duration but are significant.
/// - `name`: The name of the debug event.
/// - `data`: Associated data as key-value pairs.
pub fn record(&self, name: String, data: Vec<(String, String)>) {
self.event_store.insert(Event::new(
Self::NON_CLOSABLE_ID,
Some(name),
uptimeMillis(),
EventType::Point,
data,
));
}
/// Ends a debug event that was previously started with the given ID.
///
/// This method marks the end of a debug event, completing its lifecycle.
/// - `id`: The unique ID of the debug event to end.
/// - `data`: Additional data to log at the end of the event.
pub fn end(&self, id: u64, data: Vec<(String, String)>) {
if id != Self::NON_CLOSABLE_ID {
self.event_store.insert(Event::new(
id,
None,
uptimeMillis(),
EventType::DurationEnd,
data,
));
}
}
fn generate_id(&self) -> u64 {
let mut id = self.id_generator.fetch_add(1, Ordering::Relaxed);
while id == Self::NON_CLOSABLE_ID {
id = self.id_generator.fetch_add(1, Ordering::Relaxed);
}
id
}
}
impl fmt::Display for DebugStore {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
let uptime_now = uptimeMillis();
write!(f, "{},{},{}::", Self::ENCODE_VERSION, self.event_store.len(), uptime_now)?;
write!(
f,
"{}",
self.event_store.fold(String::new(), |mut acc, event| {
if !acc.is_empty() {
acc.push_str("||");
}
acc.push_str(&event.to_string());
acc
})
)
}
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn test_begin_event() {
let debug_store = DebugStore::new();
let _event_id = debug_store.begin("test_event".to_string(), vec![]);
let output = debug_store.to_string();
assert!(
output.contains("test_event"),
"The output should contain the event name 'test_event'"
);
}
#[test]
fn test_unique_event_ids() {
let debug_store = DebugStore::new();
let event_id1 = debug_store.begin("event1".to_string(), vec![]);
let event_id2 = debug_store.begin("event2".to_string(), vec![]);
assert_ne!(event_id1, event_id2, "Event IDs should be unique");
}
#[test]
fn test_end_event() {
let debug_store = DebugStore::new();
let event_id = debug_store.begin("test_event".to_string(), vec![]);
debug_store.end(event_id, vec![]);
let output = debug_store.to_string();
let id_pattern = format!("ID:{},", event_id);
assert!(
output.contains("test_event"),
"The output should contain the event name 'test_event'"
);
assert_eq!(
output.matches(&id_pattern).count(),
2,
"The output should contain two events (start and end) associated with the given ID"
);
}
#[test]
fn test_event_data_handling() {
let debug_store = DebugStore::new();
debug_store
.record("data_event".to_string(), vec![("key".to_string(), "value".to_string())]);
let output = debug_store.to_string();
assert!(
output.contains("data_event"),
"The output should contain the event name 'data_event'"
);
assert!(
output.contains("key=value"),
"The output should contain the event data 'key=value'"
);
}
}
|
