mirror of
https://github.com/servo/servo.git
synced 2025-09-23 05:10:09 +01:00
Add direct script to embedder channel (#39039)
This PR **removes** `ScriptToConstellationMessage::ForwardToEmbedder`, and replaces it with an explicit `ScriptToEmbedderChannel`. This new channel is based on `GenericCallback` and in single-process mode will directly send the message the to the embedder and wake it. In multi-process mode, the message is routed via the ROUTER, since waking is only possible from the same process currently. This means in multi-process mode there are likely no direct perf benefits, since we still need to hop the message over the ROUTER (instead of over the constellation). In single-process mode we can directly send the message to the embedder, which should provide a noticable latency improvement in all cases where script is blocked waiting on the embedder to reply. This does not change the way the embedder receives messages - the receiving end is unchanged. ## How was sending messages to the embedder working before? 1. Script wraps it's message to the embedder in `ScriptToConstellationMessage::ForwardToEmbedder` and sends it to constellation. 2. The [constellation event loop] receives the message in [handle_request] 3. If deserialization fails, [an error is logged and the message is ignored] 4. Since our message came from script, it is handle in [handle_request_from_script] 5. The message is logged with trace log level 6. If the pipeline is closed, [a warning is logged and the message ignored] 7. The wrapped `EmbedderMsg` [is forwarded to the embedder]. Sending the message also invokes `wake()` on the embedder eventloop waker. [constellation event loop]:2e1b2e7260/components/constellation/constellation.rs (L755)[handle request]:2e1b2e7260/components/constellation/constellation.rs (L1182)[an error is logged and the message is ignored]:2e1b2e7260/components/constellation/constellation.rs (L1252)[handle_request_from_script]: https://github.com/servo/servo/blob/main/components/constellation/constellation.rs#L1590 [a warning is logged and the message ignored]:2e1b2e7260/components/constellation/constellation.rs (L1599)[is forwarded to the embedder]:2e1b2e7260/components/constellation/constellation.rs (L1701)Testing: Communication between Script and Embedder is extensive, so this should be covered by existing tests. Signed-off-by: Jonathan Schwender <schwenderjonathan@gmail.com>
This commit is contained in:
Jonathan Schwender
GitHub
parent
97c8c83cbb
commit
f4dd2960b8
21 changed files with 120 additions and 113 deletions
|
|
@ -134,8 +134,8 @@ use embedder_traits::{
|
|||
AnimationState, CompositorHitTestResult, EmbedderMsg, EmbedderProxy, FocusId,
|
||||
FocusSequenceNumber, InputEvent, JSValue, JavaScriptEvaluationError, JavaScriptEvaluationId,
|
||||
KeyboardEvent, MediaSessionActionType, MediaSessionEvent, MediaSessionPlaybackState,
|
||||
MouseButton, MouseButtonAction, MouseButtonEvent, Theme, ViewportDetails, WebDriverCommandMsg,
|
||||
WebDriverCommandResponse, WebDriverLoadStatus, WebDriverScriptCommand,
|
||||
MouseButton, MouseButtonAction, MouseButtonEvent, ScriptToEmbedderChan, Theme, ViewportDetails,
|
||||
WebDriverCommandMsg, WebDriverCommandResponse, WebDriverLoadStatus, WebDriverScriptCommand,
|
||||
};
|
||||
use euclid::Size2D;
|
||||
use euclid::default::Size2D as UntypedSize2D;
|
||||
|
|
@ -968,6 +968,10 @@ where
|
|||
self.public_resource_threads.clone()
|
||||
};
|
||||
|
||||
let embedder_chan = self.embedder_proxy.sender.clone();
|
||||
let eventloop_waker = self.embedder_proxy.event_loop_waker.clone();
|
||||
let script_to_embedder_chan = ScriptToEmbedderChan::new(embedder_chan, eventloop_waker);
|
||||
|
||||
let result = Pipeline::spawn::<STF>(InitialPipelineState {
|
||||
id: pipeline_id,
|
||||
browsing_context_id,
|
||||
|
|
@ -978,6 +982,7 @@ where
|
|||
sender: self.script_sender.clone(),
|
||||
pipeline_id,
|
||||
},
|
||||
script_to_embedder_chan,
|
||||
namespace_request_sender: self.namespace_ipc_sender.clone(),
|
||||
pipeline_namespace_id: self.next_pipeline_namespace_id(),
|
||||
background_monitor_register: self.background_monitor_register.clone(),
|
||||
|
|
@ -1702,9 +1707,6 @@ where
|
|||
self.broadcast_channels
|
||||
.schedule_broadcast(router_id, message);
|
||||
},
|
||||
ScriptToConstellationMessage::ForwardToEmbedder(embedder_msg) => {
|
||||
self.embedder_proxy.send(embedder_msg);
|
||||
},
|
||||
ScriptToConstellationMessage::PipelineExited => {
|
||||
self.handle_pipeline_exited(source_pipeline_id);
|
||||
},
|
||||
|
|
|
|||
|
|
@ -27,7 +27,9 @@ use constellation_traits::{LoadData, SWManagerMsg, ScriptToConstellationChan};
|
|||
use crossbeam_channel::{Sender, unbounded};
|
||||
use devtools_traits::{DevtoolsControlMsg, ScriptToDevtoolsControlMsg};
|
||||
use embedder_traits::user_content_manager::UserContentManager;
|
||||
use embedder_traits::{AnimationState, FocusSequenceNumber, Theme, ViewportDetails};
|
||||
use embedder_traits::{
|
||||
AnimationState, FocusSequenceNumber, ScriptToEmbedderChan, Theme, ViewportDetails,
|
||||
};
|
||||
use fonts::{SystemFontServiceProxy, SystemFontServiceProxySender};
|
||||
use ipc_channel::Error;
|
||||
use ipc_channel::ipc::{self, IpcReceiver, IpcSender};
|
||||
|
|
@ -131,6 +133,9 @@ pub struct InitialPipelineState {
|
|||
/// A channel to the associated constellation.
|
||||
pub script_to_constellation_chan: ScriptToConstellationChan,
|
||||
|
||||
/// A channel to the embedder.
|
||||
pub script_to_embedder_chan: ScriptToEmbedderChan,
|
||||
|
||||
/// A sender to request pipeline namespace ids.
|
||||
pub namespace_request_sender: GenericSender<PipelineNamespaceRequest>,
|
||||
|
||||
|
|
@ -277,6 +282,7 @@ impl Pipeline {
|
|||
parent_pipeline_id: state.parent_pipeline_id,
|
||||
opener: state.opener,
|
||||
script_to_constellation_chan: state.script_to_constellation_chan.clone(),
|
||||
script_to_embedder_chan: state.script_to_embedder_chan,
|
||||
namespace_request_sender: state.namespace_request_sender,
|
||||
background_hang_monitor_to_constellation_chan: state
|
||||
.background_hang_monitor_to_constellation_chan
|
||||
|
|
@ -476,6 +482,7 @@ pub struct UnprivilegedPipelineContent {
|
|||
opener: Option<BrowsingContextId>,
|
||||
namespace_request_sender: GenericSender<PipelineNamespaceRequest>,
|
||||
script_to_constellation_chan: ScriptToConstellationChan,
|
||||
script_to_embedder_chan: ScriptToEmbedderChan,
|
||||
background_hang_monitor_to_constellation_chan: IpcSender<HangMonitorAlert>,
|
||||
bhm_control_port: Option<IpcReceiver<BackgroundHangMonitorControlMsg>>,
|
||||
devtools_ipc_sender: Option<IpcSender<ScriptToDevtoolsControlMsg>>,
|
||||
|
|
@ -530,6 +537,7 @@ impl UnprivilegedPipelineContent {
|
|||
constellation_sender: self.script_chan.clone(),
|
||||
constellation_receiver: self.script_port,
|
||||
pipeline_to_constellation_sender: self.script_to_constellation_chan.clone(),
|
||||
pipeline_to_embedder_sender: self.script_to_embedder_chan,
|
||||
background_hang_monitor_register: background_hang_monitor_register.clone(),
|
||||
#[cfg(feature = "bluetooth")]
|
||||
bluetooth_sender: self.bluetooth_thread,
|
||||
|
|
|
|||
|
|
@ -110,8 +110,6 @@ mod from_compositor {
|
|||
}
|
||||
|
||||
mod from_script {
|
||||
use embedder_traits::LoadStatus;
|
||||
|
||||
use super::LogTarget;
|
||||
|
||||
macro_rules! target {
|
||||
|
|
@ -141,7 +139,6 @@ mod from_script {
|
|||
target!("RemoveBroadcastChannelNameInRouter")
|
||||
},
|
||||
Self::ScheduleBroadcast(..) => target!("ScheduleBroadcast"),
|
||||
Self::ForwardToEmbedder(msg) => msg.log_target(),
|
||||
Self::BroadcastStorageEvent(..) => target!("BroadcastStorageEvent"),
|
||||
Self::ChangeRunningAnimationsState(..) => target!("ChangeRunningAnimationsState"),
|
||||
Self::CreateCanvasPaintThread(..) => target!("CreateCanvasPaintThread"),
|
||||
|
|
@ -188,72 +185,4 @@ mod from_script {
|
|||
}
|
||||
}
|
||||
}
|
||||
|
||||
impl LogTarget for embedder_traits::EmbedderMsg {
|
||||
fn log_target(&self) -> &'static str {
|
||||
macro_rules! target_variant {
|
||||
($name:literal) => {
|
||||
target!("ForwardToEmbedder(" $name ")")
|
||||
};
|
||||
}
|
||||
match self {
|
||||
Self::Status(..) => target_variant!("Status"),
|
||||
Self::ChangePageTitle(..) => target_variant!("ChangePageTitle"),
|
||||
Self::MoveTo(..) => target_variant!("MoveTo"),
|
||||
Self::ResizeTo(..) => target_variant!("ResizeTo"),
|
||||
Self::ShowSimpleDialog(..) => target_variant!("ShowSimpleDialog"),
|
||||
Self::RequestAuthentication(..) => target_variant!("RequestAuthentication"),
|
||||
Self::ShowContextMenu(..) => target_variant!("ShowContextMenu"),
|
||||
Self::AllowNavigationRequest(..) => target_variant!("AllowNavigationRequest"),
|
||||
Self::AllowOpeningWebView(..) => target_variant!("AllowOpeningWebView"),
|
||||
Self::WebViewClosed(..) => target_variant!("WebViewClosed"),
|
||||
Self::WebViewFocused(..) => target_variant!("WebViewFocused"),
|
||||
Self::WebViewBlurred => target_variant!("WebViewBlurred"),
|
||||
Self::WebResourceRequested(..) => target_variant!("WebResourceRequested"),
|
||||
Self::AllowUnload(..) => target_variant!("AllowUnload"),
|
||||
Self::Keyboard(..) => target_variant!("Keyboard"),
|
||||
Self::ClearClipboard(..) => target_variant!("ClearClipboard"),
|
||||
Self::GetClipboardText(..) => target_variant!("GetClipboardText"),
|
||||
Self::SetClipboardText(..) => target_variant!("SetClipboardText"),
|
||||
Self::SetCursor(..) => target_variant!("SetCursor"),
|
||||
Self::NewFavicon(..) => target_variant!("NewFavicon"),
|
||||
Self::HistoryChanged(..) => target_variant!("HistoryChanged"),
|
||||
Self::HistoryTraversalComplete(..) => target_variant!("HistoryTraversalComplete"),
|
||||
Self::GetWindowRect(..) => target_variant!("GetWindowRect"),
|
||||
Self::GetScreenMetrics(..) => target_variant!("GetScreenMetrics"),
|
||||
Self::NotifyFullscreenStateChanged(..) => {
|
||||
target_variant!("NotifyFullscreenStateChanged")
|
||||
},
|
||||
Self::NotifyLoadStatusChanged(_, LoadStatus::Started) => {
|
||||
target_variant!("NotifyLoadStatusChanged(LoadStatus::Started)")
|
||||
},
|
||||
Self::NotifyLoadStatusChanged(_, LoadStatus::HeadParsed) => {
|
||||
target_variant!("NotifyLoadStatusChanged(LoadStatus::HeadParsed)")
|
||||
},
|
||||
Self::NotifyLoadStatusChanged(_, LoadStatus::Complete) => {
|
||||
target_variant!("NotifyLoadStatusChanged(LoadStatus::Complete")
|
||||
},
|
||||
Self::Panic(..) => target_variant!("Panic"),
|
||||
Self::GetSelectedBluetoothDevice(..) => {
|
||||
target_variant!("GetSelectedBluetoothDevice")
|
||||
},
|
||||
Self::SelectFiles(..) => target_variant!("SelectFiles"),
|
||||
Self::PromptPermission(..) => target_variant!("PromptPermission"),
|
||||
Self::ShowIME(..) => target_variant!("ShowIME"),
|
||||
Self::HideIME(..) => target_variant!("HideIME"),
|
||||
Self::ReportProfile(..) => target_variant!("ReportProfile"),
|
||||
Self::MediaSessionEvent(..) => target_variant!("MediaSessionEvent"),
|
||||
Self::OnDevtoolsStarted(..) => target_variant!("OnDevtoolsStarted"),
|
||||
Self::RequestDevtoolsConnection(..) => target_variant!("RequestDevtoolsConnection"),
|
||||
Self::PlayGamepadHapticEffect(..) => target_variant!("PlayGamepadHapticEffect"),
|
||||
Self::StopGamepadHapticEffect(..) => target_variant!("StopGamepadHapticEffect"),
|
||||
Self::ShutdownComplete => target_variant!("ShutdownComplete"),
|
||||
Self::ShowNotification(..) => target_variant!("ShowNotification"),
|
||||
Self::ShowFormControl(..) => target_variant!("ShowFormControl"),
|
||||
Self::FinishJavaScriptEvaluation(..) => {
|
||||
target_variant!("FinishJavaScriptEvaluation")
|
||||
},
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue