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 compositor at trace level.
6/// - To disable tracing: RUST_LOG='constellation<compositor@=off'
7/// - To enable tracing: RUST_LOG='constellation<compositor@'
8/// - Recommended filters when tracing is enabled:
9///   - constellation<compositor@ForwardEvent(MouseMoveEvent)=off
10///   - constellation<compositor@LogEntry=off
11///   - constellation<compositor@ReadyToPresent=off
12macro_rules! trace_msg_from_compositor {
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_compositor {
39    use embedder_traits::{InputEvent, InputEventAndId};
40
41    use super::LogTarget;
42
43    macro_rules! target {
44        ($($name:literal)+) => {
45            concat!("constellation<compositor@", $($name),+)
46        };
47    }
48
49    impl LogTarget for 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::ClearCache => target!("ClearCache"),
56                Self::TraverseHistory(..) => target!("TraverseHistory"),
57                Self::ChangeViewportDetails(..) => target!("ChangeViewportDetails"),
58                Self::ThemeChange(..) => target!("ThemeChange"),
59                Self::TickAnimation(..) => target!("TickAnimation"),
60                Self::WebDriverCommand(..) => target!("WebDriverCommand"),
61                Self::Reload(..) => target!("Reload"),
62                Self::LogEntry(..) => target!("LogEntry"),
63                Self::NewWebView(..) => target!("NewWebView"),
64                Self::CloseWebView(..) => target!("CloseWebView"),
65                Self::SendError(..) => target!("SendError"),
66                Self::FocusWebView(..) => target!("FocusWebView"),
67                Self::BlurWebView => target!("BlurWebView"),
68                Self::ForwardInputEvent(_webview_id, event, ..) => event.log_target(),
69                Self::RefreshCursor(..) => target!("RefreshCursor"),
70                Self::ToggleProfiler(..) => target!("EnableProfiler"),
71                Self::ExitFullScreen(_) => target!("ExitFullScreen"),
72                Self::MediaSessionAction(_) => target!("MediaSessionAction"),
73                Self::SetWebViewThrottled(_, _) => target!("SetWebViewThrottled"),
74                Self::SetScrollStates(..) => target!("SetScrollStates"),
75                Self::PaintMetric(..) => target!("PaintMetric"),
76                Self::EvaluateJavaScript(..) => target!("EvaluateJavaScript"),
77                Self::CreateMemoryReport(..) => target!("CreateMemoryReport"),
78                Self::SendImageKeysForPipeline(..) => target!("SendImageKeysForPipeline"),
79                Self::PreferencesUpdated(..) => target!("PreferencesUpdated"),
80                Self::NoLongerWaitingOnAsynchronousImageUpdates(..) => {
81                    target!("NoLongerWaitingOnCanvas")
82                },
83                Self::RequestScreenshotReadiness(..) => target!("RequestScreenshotReadiness"),
84                Self::EmbedderControlResponse(..) => target!("EmbedderControlResponse"),
85            }
86        }
87    }
88
89    impl LogTarget for InputEventAndId {
90        fn log_target(&self) -> &'static str {
91            macro_rules! target_variant {
92                ($name:literal) => {
93                    target!("ForwardInputEvent(" $name ")")
94                };
95            }
96            match self.event {
97                InputEvent::EditingAction(..) => target_variant!("EditingAction"),
98                InputEvent::Gamepad(..) => target_variant!("Gamepad"),
99                InputEvent::Ime(..) => target_variant!("Ime"),
100                InputEvent::Keyboard(..) => target_variant!("Keyboard"),
101                InputEvent::MouseButton(..) => target_variant!("MouseButton"),
102                InputEvent::MouseMove(..) => target_variant!("MouseMove"),
103                InputEvent::MouseLeftViewport(..) => target_variant!("MouseLeftViewport"),
104                InputEvent::Touch(..) => target_variant!("Touch"),
105                InputEvent::Wheel(..) => target_variant!("Wheel"),
106                InputEvent::Scroll(..) => target_variant!("Scroll"),
107            }
108        }
109    }
110}
111
112mod from_script {
113    use super::LogTarget;
114
115    macro_rules! target {
116        ($($name:literal)+) => {
117            concat!("constellation<script@", $($name),+)
118        };
119    }
120
121    impl LogTarget for constellation_traits::ScriptToConstellationMessage {
122        fn log_target(&self) -> &'static str {
123            match self {
124                Self::CompleteMessagePortTransfer(..) => target!("CompleteMessagePortTransfer"),
125                Self::MessagePortTransferResult(..) => target!("MessagePortTransferResult"),
126                Self::NewMessagePort(..) => target!("NewMessagePort"),
127                Self::NewMessagePortRouter(..) => target!("NewMessagePortRouter"),
128                Self::RemoveMessagePortRouter(..) => target!("RemoveMessagePortRouter"),
129                Self::RerouteMessagePort(..) => target!("RerouteMessagePort"),
130                Self::MessagePortShipped(..) => target!("MessagePortShipped"),
131                Self::EntanglePorts(..) => target!("EntanglePorts"),
132                Self::DisentanglePorts(..) => target!("DisentanglePorts"),
133                Self::NewBroadcastChannelRouter(..) => target!("NewBroadcastChannelRouter"),
134                Self::RemoveBroadcastChannelRouter(..) => target!("RemoveBroadcastChannelRouter"),
135                Self::NewBroadcastChannelNameInRouter(..) => {
136                    target!("NewBroadcastChannelNameInRouter")
137                },
138                Self::RemoveBroadcastChannelNameInRouter(..) => {
139                    target!("RemoveBroadcastChannelNameInRouter")
140                },
141                Self::ScheduleBroadcast(..) => target!("ScheduleBroadcast"),
142                Self::BroadcastStorageEvent(..) => target!("BroadcastStorageEvent"),
143                Self::ChangeRunningAnimationsState(..) => target!("ChangeRunningAnimationsState"),
144                Self::CreateCanvasPaintThread(..) => target!("CreateCanvasPaintThread"),
145                Self::Focus(..) => target!("Focus"),
146                Self::FocusRemoteDocument(..) => target!("FocusRemoteDocument"),
147                Self::GetTopForBrowsingContext(..) => target!("GetTopForBrowsingContext"),
148                Self::GetBrowsingContextInfo(..) => target!("GetBrowsingContextInfo"),
149                Self::GetChildBrowsingContextId(..) => target!("GetChildBrowsingContextId"),
150                Self::LoadComplete => target!("LoadComplete"),
151                Self::LoadUrl(..) => target!("LoadUrl"),
152                Self::AbortLoadUrl => target!("AbortLoadUrl"),
153                Self::PostMessage { .. } => target!("PostMessage"),
154                Self::NavigatedToFragment(..) => target!("NavigatedToFragment"),
155                Self::TraverseHistory(..) => target!("TraverseHistory"),
156                Self::PushHistoryState(..) => target!("PushHistoryState"),
157                Self::ReplaceHistoryState(..) => target!("ReplaceHistoryState"),
158                Self::JointSessionHistoryLength(..) => target!("JointSessionHistoryLength"),
159                Self::RemoveIFrame(..) => target!("RemoveIFrame"),
160                Self::SetThrottledComplete(..) => target!("SetThrottledComplete"),
161                Self::ScriptLoadedURLInIFrame(..) => target!("ScriptLoadedURLInIFrame"),
162                Self::ScriptNewIFrame(..) => target!("ScriptNewIFrame"),
163                Self::CreateAuxiliaryWebView(..) => target!("ScriptNewAuxiliary"),
164                Self::ActivateDocument => target!("ActivateDocument"),
165                Self::SetDocumentState(..) => target!("SetDocumentState"),
166                Self::SetFinalUrl(..) => target!("SetFinalUrl"),
167                Self::LogEntry(..) => target!("LogEntry"),
168                Self::DiscardDocument => target!("DiscardDocument"),
169                Self::DiscardTopLevelBrowsingContext => target!("DiscardTopLevelBrowsingContext"),
170                Self::PipelineExited => target!("PipelineExited"),
171                Self::ForwardDOMMessage(..) => target!("ForwardDOMMessage"),
172                Self::ScheduleJob(..) => target!("ScheduleJob"),
173                Self::MediaSessionEvent(..) => target!("MediaSessionEvent"),
174                #[cfg(feature = "webgpu")]
175                Self::RequestAdapter(..) => target!("RequestAdapter"),
176                #[cfg(feature = "webgpu")]
177                Self::GetWebGPUChan(..) => target!("GetWebGPUChan"),
178                Self::TitleChanged(..) => target!("TitleChanged"),
179                Self::IFrameSizes(..) => target!("IFrameSizes"),
180                Self::ReportMemory(..) => target!("ReportMemory"),
181                Self::FinishJavaScriptEvaluation(..) => target!("FinishJavaScriptEvaluation"),
182                Self::ForwardKeyboardScroll(..) => target!("ForwardKeyboardScroll"),
183                Self::RespondToScreenshotReadinessRequest(..) => {
184                    target!("RespondToScreenshotReadinessRequest")
185                },
186            }
187        }
188    }
189}
constellation/tracing.rs

constellation/
tracing.rs
