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::SendError(..) => target!("SendError"),
65                Self::FocusWebView(..) => target!("FocusWebView"),
66                Self::BlurWebView => target!("BlurWebView"),
67                Self::ForwardInputEvent(_webview_id, event, ..) => event.log_target(),
68                Self::RefreshCursor(..) => target!("RefreshCursor"),
69                Self::ToggleProfiler(..) => target!("EnableProfiler"),
70                Self::ExitFullScreen(_) => target!("ExitFullScreen"),
71                Self::MediaSessionAction(_) => target!("MediaSessionAction"),
72                Self::SetWebViewThrottled(_, _) => target!("SetWebViewThrottled"),
73                Self::SetScrollStates(..) => target!("SetScrollStates"),
74                Self::PaintMetric(..) => target!("PaintMetric"),
75                Self::EvaluateJavaScript(..) => target!("EvaluateJavaScript"),
76                Self::CreateMemoryReport(..) => target!("CreateMemoryReport"),
77                Self::SendImageKeysForPipeline(..) => target!("SendImageKeysForPipeline"),
78                Self::PreferencesUpdated(..) => target!("PreferencesUpdated"),
79                Self::NoLongerWaitingOnAsynchronousImageUpdates(..) => {
80                    target!("NoLongerWaitingOnCanvas")
81                },
82                Self::RequestScreenshotReadiness(..) => target!("RequestScreenshotReadiness"),
83                Self::EmbedderControlResponse(..) => target!("EmbedderControlResponse"),
84                Self::UserContentManagerAction(..) => target!("UserContentManagerAction"),
85                Self::UpdatePinchZoomInfos(..) => target!("UpdatePinchZoomInfos"),
86                Self::SetAccessibilityActive(..) => target!("SetAccessibilityActive"),
87            }
88        }
89    }
90
91    impl LogTarget for InputEventAndId {
92        fn log_target(&self) -> &'static str {
93            macro_rules! target_variant {
94                ($name:literal) => {
95                    target!("ForwardInputEvent(" $name ")")
96                };
97            }
98            match self.event {
99                InputEvent::EditingAction(..) => target_variant!("EditingAction"),
100                #[cfg(feature = "gamepad")]
101                InputEvent::Gamepad(..) => target_variant!("Gamepad"),
102                InputEvent::Ime(..) => target_variant!("Ime"),
103                InputEvent::Keyboard(..) => target_variant!("Keyboard"),
104                InputEvent::MouseButton(..) => target_variant!("MouseButton"),
105                InputEvent::MouseMove(..) => target_variant!("MouseMove"),
106                InputEvent::MouseLeftViewport(..) => target_variant!("MouseLeftViewport"),
107                InputEvent::Touch(..) => target_variant!("Touch"),
108                InputEvent::Wheel(..) => target_variant!("Wheel"),
109            }
110        }
111    }
112}
113
114mod from_script {
115    use super::LogTarget;
116
117    macro_rules! target {
118        ($($name:literal)+) => {
119            concat!("constellation<script@", $($name),+)
120        };
121    }
122
123    impl LogTarget for servo_constellation_traits::ScriptToConstellationMessage {
124        fn log_target(&self) -> &'static str {
125            match self {
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::CreateCanvasPaintThread(..) => target!("CreateCanvasPaintThread"),
149                Self::FocusAncestorBrowsingContextsForFocusingSteps(..) => {
150                    target!("FocusAncestorBrowsingContextsForFocusingSteps")
151                },
152                Self::FocusRemoteBrowsingContext(..) => target!("FocusRemoteBrowsingContext"),
153                Self::GetTopForBrowsingContext(..) => target!("GetTopForBrowsingContext"),
154                Self::GetBrowsingContextInfo(..) => target!("GetBrowsingContextInfo"),
155                Self::GetDocumentOrigin(..) => target!("GetDocumentOrigin"),
156                Self::GetChildBrowsingContextId(..) => target!("GetChildBrowsingContextId"),
157                Self::LoadComplete => target!("LoadComplete"),
158                Self::LoadUrl(..) => target!("LoadUrl"),
159                Self::AbortLoadUrl => target!("AbortLoadUrl"),
160                Self::PostMessage { .. } => target!("PostMessage"),
161                Self::NavigatedToFragment(..) => target!("NavigatedToFragment"),
162                Self::TraverseHistory(..) => target!("TraverseHistory"),
163                Self::PushHistoryState(..) => target!("PushHistoryState"),
164                Self::ReplaceHistoryState(..) => target!("ReplaceHistoryState"),
165                Self::JointSessionHistoryLength(..) => target!("JointSessionHistoryLength"),
166                Self::RemoveIFrame(..) => target!("RemoveIFrame"),
167                Self::SetThrottledComplete(..) => target!("SetThrottledComplete"),
168                Self::ScriptLoadedURLInIFrame(..) => target!("ScriptLoadedURLInIFrame"),
169                Self::ScriptNewIFrame(..) => target!("ScriptNewIFrame"),
170                Self::CreateAuxiliaryWebView(..) => target!("ScriptNewAuxiliary"),
171                Self::ActivateDocument => target!("ActivateDocument"),
172                Self::SetDocumentState(..) => target!("SetDocumentState"),
173                Self::SetFinalUrl(..) => target!("SetFinalUrl"),
174                Self::LogEntry(..) => target!("LogEntry"),
175                Self::DiscardDocument => target!("DiscardDocument"),
176                Self::DiscardTopLevelBrowsingContext => target!("DiscardTopLevelBrowsingContext"),
177                Self::PipelineExited => target!("PipelineExited"),
178                Self::ForwardDOMMessage(..) => target!("ForwardDOMMessage"),
179                Self::ScheduleJob(..) => target!("ScheduleJob"),
180                Self::MediaSessionEvent(..) => target!("MediaSessionEvent"),
181                #[cfg(feature = "webgpu")]
182                Self::RequestAdapter(..) => target!("RequestAdapter"),
183                #[cfg(feature = "webgpu")]
184                Self::GetWebGPUChan(..) => target!("GetWebGPUChan"),
185                Self::TitleChanged(..) => target!("TitleChanged"),
186                Self::IFrameSizes(..) => target!("IFrameSizes"),
187                Self::ReportMemory(..) => target!("ReportMemory"),
188                Self::FinishJavaScriptEvaluation(..) => target!("FinishJavaScriptEvaluation"),
189                Self::ForwardKeyboardScroll(..) => target!("ForwardKeyboardScroll"),
190                Self::RespondToScreenshotReadinessRequest(..) => {
191                    target!("RespondToScreenshotReadinessRequest")
192                },
193                Self::TriggerGarbageCollection => target!("TriggerGarbageCollection"),
194                Self::AcquireWakeLock(..) => target!("AcquireWakeLock"),
195                Self::ReleaseWakeLock(..) => target!("ReleaseWakeLock"),
196            }
197        }
198    }
199}
servo_constellation/tracing.rs

servo_constellation/
tracing.rs
