servo_constellation/
tracing.rs

1/* This Source Code Form is subject to the terms of the Mozilla Public
2 * License, v. 2.0. If a copy of the MPL was not distributed with this
3 * file, You can obtain one at https://mozilla.org/MPL/2.0/. */
4
5/// Log an event from embedder at trace level.
6/// - To disable tracing: RUST_LOG='constellation<embedder@=off'
7/// - To enable tracing: RUST_LOG='constellation<embedder@'
8/// - Recommended filters when tracing is enabled:
9///   - constellation<embedder@ForwardEvent(MouseMoveEvent)=off
10///   - constellation<embedder@LogEntry=off
11///   - constellation<embedder@ReadyToPresent=off
12macro_rules! trace_msg_from_embedder {
13    // This macro only exists to put the docs in the same file as the target prefix,
14    // so the macro definition is always the same.
15    ($event:expr, $($rest:tt)+) => {
16        ::log::trace!(target: $crate::tracing::LogTarget::log_target(&$event), $($rest)+)
17    };
18}
19
20/// Log an event from script at trace level.
21/// - To disable tracing: RUST_LOG='constellation<script@=off'
22/// - To enable tracing: RUST_LOG='constellation<script@'
23/// - Recommended filters when tracing is enabled:
24///   - constellation<script@LogEntry=off
25macro_rules! trace_script_msg {
26    // This macro only exists to put the docs in the same file as the target prefix,
27    // so the macro definition is always the same.
28    ($event:expr, $($rest:tt)+) => {
29        ::log::trace!(target: $crate::tracing::LogTarget::log_target(&$event), $($rest)+)
30    };
31}
32
33/// Get the log target for an event, as a static string.
34pub(crate) trait LogTarget {
35    fn log_target(&self) -> &'static str;
36}
37
38mod from_embedder {
39    use embedder_traits::{InputEvent, InputEventAndId};
40
41    use super::LogTarget;
42
43    macro_rules! target {
44        ($($name:literal)+) => {
45            concat!("constellation<embedder@", $($name),+)
46        };
47    }
48
49    impl LogTarget for servo_constellation_traits::EmbedderToConstellationMessage {
50        fn log_target(&self) -> &'static str {
51            match self {
52                Self::Exit => target!("Exit"),
53                Self::AllowNavigationResponse(..) => target!("AllowNavigationResponse"),
54                Self::LoadUrl(..) => target!("LoadUrl"),
55                Self::TraverseHistory(..) => target!("TraverseHistory"),
56                Self::ChangeViewportDetails(..) => target!("ChangeViewportDetails"),
57                Self::ThemeChange(..) => target!("ThemeChange"),
58                Self::TickAnimation(..) => target!("TickAnimation"),
59                Self::WebDriverCommand(..) => target!("WebDriverCommand"),
60                Self::Reload(..) => target!("Reload"),
61                Self::LogEntry(..) => target!("LogEntry"),
62                Self::NewWebView(..) => target!("NewWebView"),
63                Self::CloseWebView(..) => target!("CloseWebView"),
64                Self::SetWebViewHasSystemFocus(..) => target!("SetWebViewHasSystemFocus"),
65                Self::ForwardInputEvent(_webview_id, event, ..) => event.log_target(),
66                Self::RefreshCursor(..) => target!("RefreshCursor"),
67                Self::ExitFullScreen(_) => target!("ExitFullScreen"),
68                Self::MediaSessionAction(_) => target!("MediaSessionAction"),
69                Self::SetWebViewHidden(_, _) => target!("SetWebViewHidden"),
70                Self::SetScrollStates(..) => target!("SetScrollStates"),
71                Self::PaintMetric(..) => target!("PaintMetric"),
72                Self::EvaluateJavaScript(..) => target!("EvaluateJavaScript"),
73                Self::CreateMemoryReport(..) => target!("CreateMemoryReport"),
74                Self::SendImageKeysForPipeline(..) => target!("SendImageKeysForPipeline"),
75                Self::PreferencesUpdated(..) => target!("PreferencesUpdated"),
76                Self::NoLongerWaitingOnAsynchronousImageUpdates(..) => {
77                    target!("NoLongerWaitingOnCanvas")
78                },
79                Self::RequestScreenshotReadiness(..) => target!("RequestScreenshotReadiness"),
80                Self::EmbedderControlResponse(..) => target!("EmbedderControlResponse"),
81                Self::UserContentManagerAction(..) => target!("UserContentManagerAction"),
82                Self::UpdatePinchZoomInfos(..) => target!("UpdatePinchZoomInfos"),
83                Self::SetAccessibilityActive(..) => target!("SetAccessibilityActive"),
84                Self::ForwardAccessibilityAction(..) => target!("ForwardAccessibilityAction"),
85                Self::ClearSessionHistory(..) => target!("ClearHistory"),
86            }
87        }
88    }
89
90    impl LogTarget for InputEventAndId {
91        fn log_target(&self) -> &'static str {
92            macro_rules! target_variant {
93                ($name:literal) => {
94                    target!("ForwardInputEvent(" $name ")")
95                };
96            }
97            match self.event {
98                InputEvent::EditingAction(..) => target_variant!("EditingAction"),
99                #[cfg(feature = "gamepad")]
100                InputEvent::Gamepad(..) => target_variant!("Gamepad"),
101                InputEvent::Ime(..) => target_variant!("Ime"),
102                InputEvent::Keyboard(..) => target_variant!("Keyboard"),
103                InputEvent::MouseButton(..) => target_variant!("MouseButton"),
104                InputEvent::MouseMove(..) => target_variant!("MouseMove"),
105                InputEvent::MouseLeftViewport(..) => target_variant!("MouseLeftViewport"),
106                InputEvent::Touch(..) => target_variant!("Touch"),
107                InputEvent::Wheel(..) => target_variant!("Wheel"),
108            }
109        }
110    }
111}
112
113mod from_script {
114    use super::LogTarget;
115
116    macro_rules! target {
117        ($($name:literal)+) => {
118            concat!("constellation<script@", $($name),+)
119        };
120    }
121
122    impl LogTarget for servo_constellation_traits::ScriptToConstellationMessage {
123        fn log_target(&self) -> &'static str {
124            match self {
125                Self::ServiceWorkerAlgorithm(..) => target!("ServiceWorkerAlgorithm"),
126                Self::CompleteMessagePortTransfer(..) => target!("CompleteMessagePortTransfer"),
127                Self::MessagePortTransferResult(..) => target!("MessagePortTransferResult"),
128                Self::NewMessagePort(..) => target!("NewMessagePort"),
129                Self::NewMessagePortRouter(..) => target!("NewMessagePortRouter"),
130                Self::RemoveMessagePortRouter(..) => target!("RemoveMessagePortRouter"),
131                Self::RerouteMessagePort(..) => target!("RerouteMessagePort"),
132                Self::MessagePortShipped(..) => target!("MessagePortShipped"),
133                Self::EntanglePorts(..) => target!("EntanglePorts"),
134                Self::DisentanglePorts(..) => target!("DisentanglePorts"),
135                Self::NewBroadcastChannelRouter(..) => target!("NewBroadcastChannelRouter"),
136                Self::RemoveBroadcastChannelRouter(..) => target!("RemoveBroadcastChannelRouter"),
137                Self::NewBroadcastChannelNameInRouter(..) => {
138                    target!("NewBroadcastChannelNameInRouter")
139                },
140                Self::RemoveBroadcastChannelNameInRouter(..) => {
141                    target!("RemoveBroadcastChannelNameInRouter")
142                },
143                Self::ScheduleBroadcast(..) => target!("ScheduleBroadcast"),
144                Self::RegisterInterest(..) => target!("RegisterInterest"),
145                Self::UnregisterInterest(..) => target!("UnregisterInterest"),
146                Self::BroadcastStorageEvent(..) => target!("BroadcastStorageEvent"),
147                Self::ChangeRunningAnimationsState(..) => target!("ChangeRunningAnimationsState"),
148                Self::RegisterWorkerAnimationFrameProvider(..) => {
149                    target!("RegisterWorkerAnimationFrameProvider")
150                },
151                Self::UnregisterWorkerAnimationFrameProvider(..) => {
152                    target!("UnregisterWorkerAnimationFrameProvider")
153                },
154                Self::ChangeWorkerAnimationFrameProviderState(..) => {
155                    target!("ChangeWorkerAnimationFrameProviderState")
156                },
157                Self::CreateCanvasPaintThread(..) => target!("CreateCanvasPaintThread"),
158                Self::FocusAncestorBrowsingContextsForFocusingSteps(..) => {
159                    target!("FocusAncestorBrowsingContextsForFocusingSteps")
160                },
161                Self::FocusRemoteBrowsingContext(..) => target!("FocusRemoteBrowsingContext"),
162                Self::GetTopForBrowsingContext(..) => target!("GetTopForBrowsingContext"),
163                Self::GetBrowsingContextInfo(..) => target!("GetBrowsingContextInfo"),
164                Self::GetDocumentOrigin(..) => target!("GetDocumentOrigin"),
165                Self::IsCurrentlyFullyActive(..) => target!("IsCurrentlyFullyActive"),
166                Self::GetDocumentOriginDetails(..) => {
167                    target!("GetDocumentOriginDetails")
168                },
169                Self::GetChildBrowsingContextCount(..) => target!("GetChildBrowsingContextCount"),
170                Self::GetChildBrowsingContextId(..) => target!("GetChildBrowsingContextId"),
171                Self::LoadComplete => target!("LoadComplete"),
172                Self::LoadUrl(..) => target!("LoadUrl"),
173                Self::AbortLoadUrl => target!("AbortLoadUrl"),
174                Self::PostMessage { .. } => target!("PostMessage"),
175                Self::NavigatedToFragment(..) => target!("NavigatedToFragment"),
176                Self::TraverseHistory(..) => target!("TraverseHistory"),
177                Self::PushHistoryState(..) => target!("PushHistoryState"),
178                Self::ReplaceHistoryState(..) => target!("ReplaceHistoryState"),
179                Self::JointSessionHistoryLength(..) => target!("JointSessionHistoryLength"),
180                Self::RemoveIFrame(..) => target!("RemoveIFrame"),
181                Self::ScriptLoadedURLInIFrame(..) => target!("ScriptLoadedURLInIFrame"),
182                Self::ScriptNewIFrame(..) => target!("ScriptNewIFrame"),
183                Self::CreateAuxiliaryWebView(..) => target!("ScriptNewAuxiliary"),
184                Self::ActivateDocument => target!("ActivateDocument"),
185                Self::SetFinalUrl(..) => target!("SetFinalUrl"),
186                Self::LogEntry(..) => target!("LogEntry"),
187                Self::DiscardDocument => target!("DiscardDocument"),
188                Self::DiscardTopLevelBrowsingContext => target!("DiscardTopLevelBrowsingContext"),
189                Self::PipelineExited => target!("PipelineExited"),
190                Self::ForwardDOMMessage(..) => target!("ForwardDOMMessage"),
191                Self::MediaSessionEvent(..) => target!("MediaSessionEvent"),
192                #[cfg(feature = "webgpu")]
193                Self::RequestAdapter(..) => target!("RequestAdapter"),
194                #[cfg(feature = "webgpu")]
195                Self::GetWebGPUChan(..) => target!("GetWebGPUChan"),
196                Self::TitleChanged(..) => target!("TitleChanged"),
197                Self::IFrameSizes(..) => target!("IFrameSizes"),
198                Self::ReportMemory(..) => target!("ReportMemory"),
199                Self::FinishJavaScriptEvaluation(..) => target!("FinishJavaScriptEvaluation"),
200                Self::ForwardKeyboardScroll(..) => target!("ForwardKeyboardScroll"),
201                Self::RespondToScreenshotReadinessRequest(..) => {
202                    target!("RespondToScreenshotReadinessRequest")
203                },
204                Self::TriggerGarbageCollection => target!("TriggerGarbageCollection"),
205                Self::AcquireWakeLock(..) => target!("AcquireWakeLock"),
206                Self::ReleaseWakeLock(..) => target!("ReleaseWakeLock"),
207            }
208        }
209    }
210}
servo_constellation/tracing.rs

servo_constellation/
tracing.rs
