use std::borrow::ToOwned;
use std::cell::{Cell, OnceCell, RefCell};
use std::collections::hash_map::Entry;
use std::collections::{HashMap, HashSet, VecDeque};
use std::marker::PhantomData;
use std::mem::replace;
use std::rc::{Rc, Weak};
use std::sync::Arc;
use std::thread::JoinHandle;
use std::{process, thread};
use background_hang_monitor_api::{
BackgroundHangMonitorControlMsg, BackgroundHangMonitorRegister, HangMonitorAlert,
};
use content_security_policy::sandboxing_directive::SandboxingFlagSet;
use crossbeam_channel::{Receiver, Select, Sender, unbounded};
use devtools_traits::{
ChromeToDevtoolsControlMsg, DevtoolsControlMsg, DevtoolsPageInfo, NavigationState,
ScriptToDevtoolsControlMsg,
};
use embedder_traits::resources::{self, Resource};
use embedder_traits::user_contents::{UserContentManagerId, UserContents};
use embedder_traits::{
AnimationState, EmbedderControlId, EmbedderControlResponse, EmbedderProxy, FocusSequenceNumber,
GenericEmbedderProxy, InputEvent, InputEventAndId, InputEventOutcome, JSValue,
JavaScriptEvaluationError, JavaScriptEvaluationId, KeyboardEvent, MediaSessionActionType,
MediaSessionEvent, MediaSessionPlaybackState, MouseButton, MouseButtonAction, MouseButtonEvent,
NewWebViewDetails, PaintHitTestResult, Theme, ViewportDetails, WakeLockDelegate, WakeLockType,
WebDriverCommandMsg, WebDriverLoadStatus, WebDriverScriptCommand,
};
use euclid::Size2D;
use euclid::default::Size2D as UntypedSize2D;
use fonts::SystemFontServiceProxy;
use ipc_channel::IpcError;
use ipc_channel::router::ROUTER;
use keyboard_types::{Key, KeyState, Modifiers, NamedKey};
use layout_api::{LayoutFactory, ScriptThreadFactory};
use log::{debug, error, info, trace, warn};
use media::WindowGLContext;
use net::image_cache::ImageCacheFactoryImpl;
use net_traits::pub_domains::registered_domain_name;
use net_traits::{self, AsyncRuntime, ResourceThreads, exit_fetch_thread, start_fetch_thread};
use paint_api::{
PaintMessage, PaintProxy, PinchZoomInfos, PipelineExitSource, SendableFrameTree,
WebRenderExternalImageIdManager,
};
use profile_traits::mem::ProfilerMsg;
use profile_traits::{mem, time};
use rand::rngs::SmallRng;
use rand::seq::IndexedRandom;
use rand::{Rng, SeedableRng};
use rustc_hash::{FxHashMap, FxHashSet};
use script_traits::{
ConstellationInputEvent, DiscardBrowsingContext, DocumentActivity, NewPipelineInfo,
ProgressiveWebMetricType, ScriptThreadMessage, UpdatePipelineIdReason,
};
use servo_background_hang_monitor::HangMonitorRegister;
use servo_base::generic_channel::{
GenericCallback, GenericSend, GenericSender, RoutedReceiver, SendError,
};
use servo_base::id::{
BrowsingContextGroupId, BrowsingContextId, CONSTELLATION_PIPELINE_NAMESPACE_ID,
FIRST_CONTENT_PIPELINE_NAMESPACE_ID, HistoryStateId, MessagePortId, MessagePortRouterId,
PainterId, PipelineId, PipelineNamespace, PipelineNamespaceId, PipelineNamespaceRequest,
ScriptEventLoopId, WebViewId,
};
use servo_base::{Epoch, generic_channel};
#[cfg(feature = "bluetooth")]
use servo_bluetooth_traits::BluetoothRequest;
use servo_canvas::canvas_paint_thread::CanvasPaintThread;
use servo_canvas_traits::ConstellationCanvasMsg;
use servo_canvas_traits::canvas::{CanvasId, CanvasMsg};
use servo_canvas_traits::webgl::WebGLThreads;
use servo_config::{opts, pref};
use servo_constellation_traits::{
AuxiliaryWebViewCreationRequest, AuxiliaryWebViewCreationResponse, ConstellationInterest,
DocumentState, EmbedderToConstellationMessage, IFrameLoadInfo, IFrameLoadInfoWithData,
IFrameSizeMsg, Job, LoadData, LogEntry, MessagePortMsg, NavigationHistoryBehavior,
PaintMetricEvent, PortMessageTask, PortTransferInfo, RemoteFocusOperation, SWManagerMsg,
SWManagerSenders, ScreenshotReadinessResponse, ScriptToConstellationMessage, ScrollStateUpdate,
ServiceWorkerManagerFactory, ServiceWorkerMsg, StructuredSerializedData, TargetSnapshotParams,
TraversalDirection, UserContentManagerAction, WindowSizeType,
};
use servo_url::{Host, ImmutableOrigin, ServoUrl};
use storage_traits::StorageThreads;
use storage_traits::client_storage::ClientStorageThreadMessage;
use storage_traits::indexeddb::{IndexedDBThreadMsg, SyncOperation};
use storage_traits::webstorage_thread::{WebStorageThreadMsg, WebStorageType};
use style::global_style_data::StyleThreadPool;
#[cfg(feature = "webgpu")]
use webgpu::canvas_context::WebGpuExternalImageMap;
#[cfg(feature = "webgpu")]
use webgpu_traits::{WebGPU, WebGPURequest};
use super::embedder::ConstellationToEmbedderMsg;
use crate::broadcastchannel::BroadcastChannels;
use crate::browsingcontext::{
AllBrowsingContextsIterator, BrowsingContext, FullyActiveBrowsingContextsIterator,
NewBrowsingContextInfo,
};
use crate::constellation_webview::ConstellationWebView;
use crate::event_loop::EventLoop;
use crate::pipeline::Pipeline;
use crate::process_manager::ProcessManager;
use crate::serviceworker::ServiceWorkerUnprivilegedContent;
use crate::session_history::{NeedsToReload, SessionHistoryChange, SessionHistoryDiff};
struct PendingApprovalNavigation {
load_data: LoadData,
history_behaviour: NavigationHistoryBehavior,
target_snapshot_params: TargetSnapshotParams,
}
type PendingApprovalNavigations = FxHashMap<PipelineId, PendingApprovalNavigation>;
#[derive(Debug)]
enum TransferState {
Managed(MessagePortRouterId),
TransferInProgress(VecDeque<PortMessageTask>),
CompletionInProgress(MessagePortRouterId),
CompletionFailed(VecDeque<PortMessageTask>),
CompletionRequested(MessagePortRouterId, VecDeque<PortMessageTask>),
}
#[derive(Debug)]
struct MessagePortInfo {
state: TransferState,
entangled_with: Option<MessagePortId>,
}
#[cfg(feature = "webgpu")]
struct WebRenderWGPU {
webrender_external_image_id_manager: WebRenderExternalImageIdManager,
wgpu_image_map: WebGpuExternalImageMap,
}
#[derive(Clone, Default)]
struct BrowsingContextGroup {
top_level_browsing_context_set: FxHashSet<WebViewId>,
event_loops: HashMap<Host, Weak<EventLoop>>,
#[cfg(feature = "webgpu")]
webgpus: HashMap<Host, WebGPU>,
}
pub struct Constellation<STF, SWF> {
namespace_receiver: RoutedReceiver<PipelineNamespaceRequest>,
pub(crate) namespace_ipc_sender: GenericSender<PipelineNamespaceRequest>,
event_loops: Vec<Weak<EventLoop>>,
pub(crate) script_sender: GenericSender<(WebViewId, PipelineId, ScriptToConstellationMessage)>,
script_receiver:
Receiver<Result<(WebViewId, PipelineId, ScriptToConstellationMessage), IpcError>>,
pub(crate) background_monitor_register: Option<Box<dyn BackgroundHangMonitorRegister>>,
background_monitor_register_join_handle: Option<JoinHandle<()>>,
background_monitor_control_sender: Option<GenericSender<BackgroundHangMonitorControlMsg>>,
pub(crate) background_hang_monitor_sender: GenericSender<HangMonitorAlert>,
background_hang_monitor_receiver: RoutedReceiver<HangMonitorAlert>,
pub(crate) layout_factory: Arc<dyn LayoutFactory>,
embedder_to_constellation_receiver: Receiver<EmbedderToConstellationMessage>,
pub(crate) embedder_proxy: EmbedderProxy,
pub(crate) constellation_to_embedder_proxy: GenericEmbedderProxy<ConstellationToEmbedderMsg>,
pub(crate) paint_proxy: PaintProxy,
webviews: FxHashMap<WebViewId, ConstellationWebView>,
pub(crate) public_resource_threads: ResourceThreads,
pub(crate) private_resource_threads: ResourceThreads,
pub(crate) public_storage_threads: StorageThreads,
pub(crate) private_storage_threads: StorageThreads,
pub(crate) system_font_service: Arc<SystemFontServiceProxy>,
pub(crate) devtools_sender: Option<Sender<DevtoolsControlMsg>>,
pub script_to_devtools_callback: OnceCell<Option<GenericCallback<ScriptToDevtoolsControlMsg>>>,
#[cfg(feature = "bluetooth")]
pub(crate) bluetooth_ipc_sender: GenericSender<BluetoothRequest>,
sw_managers: HashMap<ImmutableOrigin, GenericSender<ServiceWorkerMsg>>,
swmanager_ipc_sender: GenericSender<SWManagerMsg>,
swmanager_receiver: RoutedReceiver<SWManagerMsg>,
pub(crate) time_profiler_chan: time::ProfilerChan,
pub(crate) mem_profiler_chan: mem::ProfilerChan,
#[cfg(feature = "webgpu")]
webrender_wgpu: WebRenderWGPU,
message_ports: FxHashMap<MessagePortId, MessagePortInfo>,
message_port_routers: FxHashMap<MessagePortRouterId, GenericCallback<MessagePortMsg>>,
broadcast_channels: BroadcastChannels,
pipeline_interests: FxHashMap<ConstellationInterest, FxHashSet<PipelineId>>,
pipelines: FxHashMap<PipelineId, Pipeline>,
browsing_contexts: FxHashMap<BrowsingContextId, BrowsingContext>,
browsing_context_group_set: FxHashMap<BrowsingContextGroupId, BrowsingContextGroup>,
browsing_context_group_next_id: u32,
pending_changes: Vec<SessionHistoryChange>,
next_pipeline_namespace_id: Cell<PipelineNamespaceId>,
webdriver_load_status_sender: Option<(GenericSender<WebDriverLoadStatus>, PipelineId)>,
document_states: FxHashMap<PipelineId, DocumentState>,
shutting_down: bool,
handled_warnings: VecDeque<(Option<String>, String)>,
random_pipeline_closure: Option<(SmallRng, f32)>,
phantom: PhantomData<(STF, SWF)>,
pub(crate) webgl_threads: Option<WebGLThreads>,
pub(crate) webxr_registry: Option<webxr_api::Registry>,
canvas: OnceCell<(Sender<ConstellationCanvasMsg>, GenericSender<CanvasMsg>)>,
pending_approval_navigations: PendingApprovalNavigations,
pressed_mouse_buttons: u16,
active_keyboard_modifiers: Modifiers,
hard_fail: bool,
active_media_session: Option<PipelineId>,
screen_wake_lock_count: u32,
wake_lock_provider: Box<dyn WakeLockDelegate>,
pub(crate) broken_image_icon_data: Vec<u8>,
pub(crate) process_manager: ProcessManager,
async_runtime: Box<dyn AsyncRuntime>,
event_loop_join_handles: Vec<JoinHandle<()>>,
pub(crate) privileged_urls: Vec<ServoUrl>,
pub(crate) image_cache_factory: Arc<ImageCacheFactoryImpl>,
pending_viewport_changes: HashMap<BrowsingContextId, ViewportDetails>,
screenshot_readiness_requests: Vec<ScreenshotReadinessRequest>,
pub(crate) user_contents_for_manager_id: FxHashMap<UserContentManagerId, UserContents>,
}
pub struct InitialConstellationState {
pub embedder_proxy: EmbedderProxy,
pub constellation_to_embedder_proxy: GenericEmbedderProxy<ConstellationToEmbedderMsg>,
pub paint_proxy: PaintProxy,
pub devtools_sender: Option<Sender<DevtoolsControlMsg>>,
#[cfg(feature = "bluetooth")]
pub bluetooth_thread: GenericSender<BluetoothRequest>,
pub system_font_service: Arc<SystemFontServiceProxy>,
pub public_resource_threads: ResourceThreads,
pub private_resource_threads: ResourceThreads,
pub public_storage_threads: StorageThreads,
pub private_storage_threads: StorageThreads,
pub time_profiler_chan: time::ProfilerChan,
pub mem_profiler_chan: mem::ProfilerChan,
pub webrender_external_image_id_manager: WebRenderExternalImageIdManager,
pub webgl_threads: Option<WebGLThreads>,
pub webxr_registry: Option<webxr_api::Registry>,
#[cfg(feature = "webgpu")]
pub wgpu_image_map: WebGpuExternalImageMap,
pub privileged_urls: Vec<ServoUrl>,
pub async_runtime: Box<dyn AsyncRuntime>,
pub wake_lock_provider: Box<dyn WakeLockDelegate>,
}
#[derive(Clone, Copy, Debug)]
enum ExitPipelineMode {
Normal,
Force,
}
const WARNINGS_BUFFER_SIZE: usize = 32;
impl<STF, SWF> Constellation<STF, SWF>
where
STF: ScriptThreadFactory,
SWF: ServiceWorkerManagerFactory,
{
#[servo_tracing::instrument(skip(state, layout_factory))]
pub fn start(
embedder_to_constellation_receiver: Receiver<EmbedderToConstellationMessage>,
state: InitialConstellationState,
layout_factory: Arc<dyn LayoutFactory>,
random_pipeline_closure_probability: Option<f32>,
random_pipeline_closure_seed: Option<usize>,
hard_fail: bool,
) {
let (swmanager_ipc_sender, swmanager_ipc_receiver) =
generic_channel::channel().expect("ipc channel failure");
thread::Builder::new()
.name("Constellation".to_owned())
.spawn(move || {
let (script_ipc_sender, script_ipc_receiver) =
generic_channel::channel().expect("ipc channel failure");
let script_receiver = script_ipc_receiver.route_preserving_errors();
let (namespace_ipc_sender, namespace_ipc_receiver) =
generic_channel::channel().expect("ipc channel failure");
let namespace_receiver = namespace_ipc_receiver.route_preserving_errors();
let (background_hang_monitor_ipc_sender, background_hang_monitor_ipc_receiver) =
generic_channel::channel().expect("ipc channel failure");
let background_hang_monitor_receiver =
background_hang_monitor_ipc_receiver.route_preserving_errors();
let (
background_monitor_register,
background_monitor_register_join_handle,
background_monitor_control_sender
) = if opts::get().multiprocess {
(None, None, None)
} else {
let (
background_hang_monitor_control_ipc_sender,
background_hang_monitor_control_ipc_receiver,
) = generic_channel::channel().expect("ipc channel failure");
let (register, join_handle) = HangMonitorRegister::init(
background_hang_monitor_ipc_sender.clone(),
background_hang_monitor_control_ipc_receiver,
opts::get().background_hang_monitor,
);
(
Some(register),
Some(join_handle),
Some(background_hang_monitor_control_ipc_sender),
)
};
let swmanager_receiver = swmanager_ipc_receiver.route_preserving_errors();
PipelineNamespace::install(CONSTELLATION_PIPELINE_NAMESPACE_ID);
#[cfg(feature = "webgpu")]
let webrender_wgpu = WebRenderWGPU {
webrender_external_image_id_manager: state.webrender_external_image_id_manager,
wgpu_image_map: state.wgpu_image_map,
};
let broken_image_icon_data = resources::read_bytes(Resource::BrokenImageIcon);
let mut constellation: Constellation<STF, SWF> = Constellation {
event_loops: Default::default(),
namespace_receiver,
namespace_ipc_sender,
script_sender: script_ipc_sender,
background_hang_monitor_sender: background_hang_monitor_ipc_sender,
background_hang_monitor_receiver,
background_monitor_register,
background_monitor_register_join_handle,
background_monitor_control_sender,
script_receiver,
embedder_to_constellation_receiver,
layout_factory,
embedder_proxy: state.embedder_proxy,
constellation_to_embedder_proxy: state.constellation_to_embedder_proxy,
paint_proxy: state.paint_proxy,
webviews: Default::default(),
devtools_sender: state.devtools_sender,
script_to_devtools_callback: Default::default(),
#[cfg(feature = "bluetooth")]
bluetooth_ipc_sender: state.bluetooth_thread,
public_resource_threads: state.public_resource_threads,
private_resource_threads: state.private_resource_threads,
public_storage_threads: state.public_storage_threads,
private_storage_threads: state.private_storage_threads,
system_font_service: state.system_font_service,
sw_managers: Default::default(),
swmanager_receiver,
swmanager_ipc_sender,
browsing_context_group_set: Default::default(),
browsing_context_group_next_id: Default::default(),
message_ports: Default::default(),
message_port_routers: Default::default(),
broadcast_channels: Default::default(),
pipeline_interests: Default::default(),
pipelines: Default::default(),
browsing_contexts: Default::default(),
pending_changes: vec![],
next_pipeline_namespace_id: Cell::new(FIRST_CONTENT_PIPELINE_NAMESPACE_ID),
time_profiler_chan: state.time_profiler_chan,
mem_profiler_chan: state.mem_profiler_chan.clone(),
phantom: PhantomData,
webdriver_load_status_sender: None,
document_states: Default::default(),
#[cfg(feature = "webgpu")]
webrender_wgpu,
shutting_down: false,
handled_warnings: VecDeque::new(),
random_pipeline_closure: random_pipeline_closure_probability.map(|probability| {
let rng = random_pipeline_closure_seed
.map(|seed| SmallRng::seed_from_u64(seed as u64))
.unwrap_or_else(SmallRng::from_os_rng);
warn!("Randomly closing pipelines using seed {random_pipeline_closure_seed:?}.");
(rng, probability)
}),
webgl_threads: state.webgl_threads,
webxr_registry: state.webxr_registry,
canvas: OnceCell::new(),
pending_approval_navigations: Default::default(),
pressed_mouse_buttons: 0,
active_keyboard_modifiers: Modifiers::empty(),
hard_fail,
active_media_session: None,
screen_wake_lock_count: 0,
wake_lock_provider: state.wake_lock_provider,
broken_image_icon_data: broken_image_icon_data.clone(),
process_manager: ProcessManager::new(state.mem_profiler_chan),
async_runtime: state.async_runtime,
event_loop_join_handles: Default::default(),
privileged_urls: state.privileged_urls,
image_cache_factory: Arc::new(ImageCacheFactoryImpl::new(
broken_image_icon_data,
)),
pending_viewport_changes: Default::default(),
screenshot_readiness_requests: Vec::new(),
user_contents_for_manager_id: Default::default(),
};
constellation.run();
})
.expect("Thread spawning failed");
}
fn event_loops(&self) -> Vec<Rc<EventLoop>> {
self.event_loops
.iter()
.filter_map(|weak_event_loop| weak_event_loop.upgrade())
.collect()
}
pub(crate) fn add_event_loop(&mut self, event_loop: &Rc<EventLoop>) {
self.event_loops.push(Rc::downgrade(event_loop));
}
pub(crate) fn add_event_loop_join_handle(&mut self, join_handle: JoinHandle<()>) {
self.event_loop_join_handles.push(join_handle);
}
fn clean_up_finished_script_event_loops(&mut self) {
self.event_loop_join_handles
.retain(|join_handle| !join_handle.is_finished());
self.event_loops
.retain(|event_loop| event_loop.upgrade().is_some());
}
fn run(&mut self) {
let join_handle = start_fetch_thread();
while !self.shutting_down || !self.pipelines.is_empty() {
self.maybe_close_random_pipeline();
self.handle_request();
self.clean_up_finished_script_event_loops();
}
self.handle_shutdown();
if !opts::get().multiprocess {
StyleThreadPool::shutdown();
}
exit_fetch_thread();
join_handle
.join()
.expect("Failed to join on the fetch thread in the constellation");
debug!("Asking embedding layer to complete shutdown.");
self.constellation_to_embedder_proxy
.send(ConstellationToEmbedderMsg::ShutdownComplete);
}
fn send_message_to_pipeline(
&mut self,
pipeline_id: PipelineId,
message: ScriptThreadMessage,
failure_message: &str,
) -> bool {
let result = match self.pipelines.get(&pipeline_id) {
Some(pipeline) => pipeline.event_loop.send(message),
None => {
warn!("{pipeline_id}: {failure_message}");
return false;
},
};
if let Err(err) = result {
self.handle_send_error(pipeline_id, err);
}
true
}
pub(crate) fn next_pipeline_namespace_id(&self) -> PipelineNamespaceId {
let pipeline_namespace_id = self.next_pipeline_namespace_id.get();
self.next_pipeline_namespace_id
.set(PipelineNamespaceId(pipeline_namespace_id.0 + 1));
pipeline_namespace_id
}
fn next_browsing_context_group_id(&mut self) -> BrowsingContextGroupId {
let id = self.browsing_context_group_next_id;
self.browsing_context_group_next_id += 1;
BrowsingContextGroupId(id)
}
fn get_event_loop(
&self,
host: &Host,
webview_id: &WebViewId,
opener: &Option<BrowsingContextId>,
) -> Result<Weak<EventLoop>, &'static str> {
let bc_group = match opener {
Some(browsing_context_id) => {
let opener = self
.browsing_contexts
.get(browsing_context_id)
.ok_or("Opener was closed before the openee started")?;
self.browsing_context_group_set
.get(&opener.bc_group_id)
.ok_or("Opener belongs to an unknown browsing context group")?
},
None => self
.browsing_context_group_set
.values()
.filter(|bc_group| {
bc_group
.top_level_browsing_context_set
.contains(webview_id)
})
.last()
.ok_or(
"Trying to get an event-loop for a top-level belonging to an unknown browsing context group",
)?,
};
bc_group
.event_loops
.get(host)
.ok_or("Trying to get an event-loop from an unknown browsing context group")
.cloned()
}
fn set_event_loop(
&mut self,
event_loop: &Rc<EventLoop>,
host: Host,
webview_id: WebViewId,
opener: Option<BrowsingContextId>,
) {
let relevant_top_level = if let Some(opener) = opener {
match self.browsing_contexts.get(&opener) {
Some(opener) => opener.webview_id,
None => {
warn!("Setting event-loop for an unknown auxiliary");
return;
},
}
} else {
webview_id
};
let maybe_bc_group_id = self
.browsing_context_group_set
.iter()
.filter_map(|(id, bc_group)| {
if bc_group
.top_level_browsing_context_set
.contains(&webview_id)
{
Some(*id)
} else {
None
}
})
.last();
let Some(bc_group_id) = maybe_bc_group_id else {
return warn!("Trying to add an event-loop to an unknown browsing context group");
};
if let Some(bc_group) = self.browsing_context_group_set.get_mut(&bc_group_id) {
if bc_group
.event_loops
.insert(host.clone(), Rc::downgrade(event_loop))
.is_some()
{
warn!(
"Double-setting an event-loop for {:?} at {:?}",
host, relevant_top_level
);
}
}
}
fn get_event_loop_for_new_pipeline(
&self,
load_data: &LoadData,
webview_id: WebViewId,
opener: Option<BrowsingContextId>,
parent_pipeline_id: Option<PipelineId>,
registered_domain_name: &Option<Host>,
) -> Option<Rc<EventLoop>> {
if load_data
.creation_sandboxing_flag_set
.contains(SandboxingFlagSet::SANDBOXED_ORIGIN_BROWSING_CONTEXT_FLAG)
{
return None;
}
if load_data.url.as_str() == "about:blank" || load_data.url.as_str() == "about:srcdoc" {
if let Some(parent) =
parent_pipeline_id.and_then(|pipeline_id| self.pipelines.get(&pipeline_id))
{
return Some(parent.event_loop.clone());
}
if let Some(creator) = load_data
.creator_pipeline_id
.and_then(|pipeline_id| self.pipelines.get(&pipeline_id))
{
return Some(creator.event_loop.clone());
}
return None;
}
let Some(registered_domain_name) = registered_domain_name else {
return None;
};
self.get_event_loop(registered_domain_name, &webview_id, &opener)
.ok()?
.upgrade()
}
fn get_or_create_event_loop_for_new_pipeline(
&mut self,
webview_id: WebViewId,
opener: Option<BrowsingContextId>,
parent_pipeline_id: Option<PipelineId>,
load_data: &LoadData,
is_private: bool,
) -> Result<Rc<EventLoop>, IpcError> {
let registered_domain_name = if load_data
.creation_sandboxing_flag_set
.contains(SandboxingFlagSet::SANDBOXED_ORIGIN_BROWSING_CONTEXT_FLAG)
{
None
} else {
registered_domain_name(&load_data.url)
};
if let Some(event_loop) = self.get_event_loop_for_new_pipeline(
load_data,
webview_id,
opener,
parent_pipeline_id,
®istered_domain_name,
) {
return Ok(event_loop);
}
let event_loop = EventLoop::spawn(self, is_private)?;
if let Some(registered_domain_name) = registered_domain_name {
self.set_event_loop(&event_loop, registered_domain_name, webview_id, opener);
}
Ok(event_loop)
}
#[expect(clippy::too_many_arguments)]
fn new_pipeline(
&mut self,
new_pipeline_id: PipelineId,
browsing_context_id: BrowsingContextId,
webview_id: WebViewId,
parent_pipeline_id: Option<PipelineId>,
opener: Option<BrowsingContextId>,
initial_viewport_details: ViewportDetails,
load_data: LoadData,
is_private: bool,
throttled: bool,
target_snapshot_params: TargetSnapshotParams,
) {
if self.shutting_down {
return;
}
debug!("Creating new pipeline ({new_pipeline_id:?}) in {browsing_context_id}");
let Some(theme) = self
.webviews
.get(&webview_id)
.map(ConstellationWebView::theme)
else {
warn!("Tried to create Pipeline for uknown WebViewId: {webview_id:?}");
return;
};
let event_loop = match self.get_or_create_event_loop_for_new_pipeline(
webview_id,
opener,
parent_pipeline_id,
&load_data,
is_private,
) {
Ok(event_loop) => event_loop,
Err(error) => return self.handle_send_error(new_pipeline_id, error.into()),
};
let user_content_manager_id = self
.webviews
.get(&webview_id)
.and_then(|webview| webview.user_content_manager_id);
let new_pipeline_info = NewPipelineInfo {
parent_info: parent_pipeline_id,
new_pipeline_id,
browsing_context_id,
webview_id,
opener,
load_data,
viewport_details: initial_viewport_details,
user_content_manager_id,
theme,
target_snapshot_params,
};
let pipeline = match Pipeline::spawn(new_pipeline_info, event_loop, self, throttled) {
Ok(pipeline) => pipeline,
Err(error) => return self.handle_send_error(new_pipeline_id, error),
};
assert!(!self.pipelines.contains_key(&new_pipeline_id));
self.pipelines.insert(new_pipeline_id, pipeline);
}
fn fully_active_descendant_browsing_contexts_iter(
&self,
browsing_context_id: BrowsingContextId,
) -> FullyActiveBrowsingContextsIterator<'_> {
FullyActiveBrowsingContextsIterator {
stack: vec![browsing_context_id],
pipelines: &self.pipelines,
browsing_contexts: &self.browsing_contexts,
}
}
fn fully_active_browsing_contexts_iter(
&self,
webview_id: WebViewId,
) -> FullyActiveBrowsingContextsIterator<'_> {
self.fully_active_descendant_browsing_contexts_iter(BrowsingContextId::from(webview_id))
}
fn all_descendant_browsing_contexts_iter(
&self,
browsing_context_id: BrowsingContextId,
) -> AllBrowsingContextsIterator<'_> {
AllBrowsingContextsIterator {
stack: vec![browsing_context_id],
pipelines: &self.pipelines,
browsing_contexts: &self.browsing_contexts,
}
}
fn ancestor_pipelines_of_browsing_context_iter(
&self,
browsing_context_id: BrowsingContextId,
) -> impl Iterator<Item = &Pipeline> + '_ {
let mut state: Option<PipelineId> = self
.browsing_contexts
.get(&browsing_context_id)
.and_then(|browsing_context| browsing_context.parent_pipeline_id);
std::iter::from_fn(move || {
if let Some(pipeline_id) = state {
let pipeline = self.pipelines.get(&pipeline_id)?;
let browsing_context = self.browsing_contexts.get(&pipeline.browsing_context_id)?;
state = browsing_context.parent_pipeline_id;
Some(pipeline)
} else {
None
}
})
}
fn ancestor_or_self_pipelines_of_browsing_context_iter(
&self,
browsing_context_id: BrowsingContextId,
) -> impl Iterator<Item = &Pipeline> + '_ {
let this_pipeline = self
.browsing_contexts
.get(&browsing_context_id)
.map(|browsing_context| browsing_context.pipeline_id)
.and_then(|pipeline_id| self.pipelines.get(&pipeline_id));
this_pipeline
.into_iter()
.chain(self.ancestor_pipelines_of_browsing_context_iter(browsing_context_id))
}
#[expect(clippy::too_many_arguments)]
fn new_browsing_context(
&mut self,
browsing_context_id: BrowsingContextId,
webview_id: WebViewId,
pipeline_id: PipelineId,
parent_pipeline_id: Option<PipelineId>,
viewport_details: ViewportDetails,
is_private: bool,
inherited_secure_context: Option<bool>,
throttled: bool,
) {
debug!("{browsing_context_id}: Creating new browsing context");
let bc_group_id = match self
.browsing_context_group_set
.iter_mut()
.filter_map(|(id, bc_group)| {
if bc_group
.top_level_browsing_context_set
.contains(&webview_id)
{
Some(id)
} else {
None
}
})
.last()
{
Some(id) => *id,
None => {
warn!("Top-level was unexpectedly removed from its top_level_browsing_context_set");
return;
},
};
let viewport_details = self
.pending_viewport_changes
.remove(&browsing_context_id)
.unwrap_or(viewport_details);
let browsing_context = BrowsingContext::new(
bc_group_id,
browsing_context_id,
webview_id,
pipeline_id,
parent_pipeline_id,
viewport_details,
is_private,
inherited_secure_context,
throttled,
);
self.browsing_contexts
.insert(browsing_context_id, browsing_context);
if let Some(parent_pipeline_id) = parent_pipeline_id {
if let Some(parent) = self.pipelines.get_mut(&parent_pipeline_id) {
parent.add_child(browsing_context_id);
}
}
}
fn add_pending_change(&mut self, change: SessionHistoryChange) {
debug!(
"adding pending session history change with {}",
if change.replace.is_some() {
"replacement"
} else {
"no replacement"
},
);
self.pending_changes.push(change);
}
#[servo_tracing::instrument(skip_all)]
fn handle_request(&mut self) {
#[expect(clippy::large_enum_variant)]
#[derive(Debug)]
enum Request {
PipelineNamespace(PipelineNamespaceRequest),
Script((WebViewId, PipelineId, ScriptToConstellationMessage)),
BackgroundHangMonitor(HangMonitorAlert),
Embedder(EmbedderToConstellationMessage),
FromSWManager(SWManagerMsg),
RemoveProcess(usize),
}
let mut sel = Select::new();
sel.recv(&self.namespace_receiver);
sel.recv(&self.script_receiver);
sel.recv(&self.background_hang_monitor_receiver);
sel.recv(&self.embedder_to_constellation_receiver);
sel.recv(&self.swmanager_receiver);
self.process_manager.register(&mut sel);
let request = {
let oper = {
let _span = profile_traits::trace_span!("handle_request::select").entered();
sel.select()
};
let index = oper.index();
match index {
0 => oper
.recv(&self.namespace_receiver)
.expect("Unexpected script channel panic in constellation")
.map(Request::PipelineNamespace),
1 => oper
.recv(&self.script_receiver)
.expect("Unexpected script channel panic in constellation")
.map(Request::Script),
2 => oper
.recv(&self.background_hang_monitor_receiver)
.expect("Unexpected BHM channel panic in constellation")
.map(Request::BackgroundHangMonitor),
3 => Ok(Request::Embedder(
oper.recv(&self.embedder_to_constellation_receiver)
.expect("Unexpected embedder channel panic in constellation"),
)),
4 => oper
.recv(&self.swmanager_receiver)
.expect("Unexpected SW channel panic in constellation")
.map(Request::FromSWManager),
_ => {
let process_index = index - 5;
let _ = oper.recv(self.process_manager.receiver_at(process_index));
Ok(Request::RemoveProcess(process_index))
},
}
};
let request = match request {
Ok(request) => request,
Err(err) => return error!("Deserialization failed ({}).", err),
};
match request {
Request::PipelineNamespace(message) => {
self.handle_request_for_pipeline_namespace(message)
},
Request::Embedder(message) => self.handle_request_from_embedder(message),
Request::Script(message) => {
self.handle_request_from_script(message);
},
Request::BackgroundHangMonitor(message) => {
self.handle_request_from_background_hang_monitor(message);
},
Request::FromSWManager(message) => {
self.handle_request_from_swmanager(message);
},
Request::RemoveProcess(index) => self.process_manager.remove(index),
}
}
#[servo_tracing::instrument(skip_all)]
fn handle_request_for_pipeline_namespace(&mut self, request: PipelineNamespaceRequest) {
let PipelineNamespaceRequest(sender) = request;
let _ = sender.send(self.next_pipeline_namespace_id());
}
#[servo_tracing::instrument(skip_all)]
fn handle_request_from_background_hang_monitor(&self, message: HangMonitorAlert) {
match message {
HangMonitorAlert::Profile(bytes) => self
.constellation_to_embedder_proxy
.send(ConstellationToEmbedderMsg::ReportProfile(bytes)),
HangMonitorAlert::Hang(hang) => {
warn!("Component hang alert: {:?}", hang);
},
}
}
#[servo_tracing::instrument(skip_all)]
fn handle_request_from_swmanager(&mut self, message: SWManagerMsg) {
match message {
SWManagerMsg::PostMessageToClient => {
},
}
}
#[servo_tracing::instrument(skip_all)]
fn handle_request_from_embedder(&mut self, message: EmbedderToConstellationMessage) {
trace_msg_from_embedder!(message, "{message:?}");
match message {
EmbedderToConstellationMessage::Exit => {
self.handle_exit();
},
EmbedderToConstellationMessage::AllowNavigationResponse(pipeline_id, allowed) => {
let pending = self.pending_approval_navigations.remove(&pipeline_id);
let webview_id = match self.pipelines.get(&pipeline_id) {
Some(pipeline) => pipeline.webview_id,
None => return warn!("{}: Attempted to navigate after closure", pipeline_id),
};
match pending {
Some(pending) => {
if allowed {
self.load_url(
webview_id,
pipeline_id,
pending.load_data,
pending.history_behaviour,
pending.target_snapshot_params,
);
} else {
if let Some((sender, id)) = &self.webdriver_load_status_sender {
if pipeline_id == *id {
let _ = sender.send(WebDriverLoadStatus::NavigationStop);
}
}
let pipeline_is_top_level_pipeline = self
.browsing_contexts
.get(&BrowsingContextId::from(webview_id))
.is_some_and(|ctx| ctx.pipeline_id == pipeline_id);
if !pipeline_is_top_level_pipeline {
self.send_message_to_pipeline(
pipeline_id,
ScriptThreadMessage::StopDelayingLoadEventsMode(pipeline_id),
"Attempted to navigate after closure",
);
}
}
},
None => {
warn!(
"{}: AllowNavigationResponse for unknown request",
pipeline_id
)
},
}
},
EmbedderToConstellationMessage::LoadUrl(webview_id, url_request) => {
let mut load_data = LoadData::new_for_new_unrelated_webview(url_request.url);
if !url_request.headers.is_empty() {
load_data.headers.extend(url_request.headers);
}
let ctx_id = BrowsingContextId::from(webview_id);
let pipeline_id = match self.browsing_contexts.get(&ctx_id) {
Some(ctx) => ctx.pipeline_id,
None => {
return warn!("{}: LoadUrl for unknown browsing context", webview_id);
},
};
self.load_url(
webview_id,
pipeline_id,
load_data,
NavigationHistoryBehavior::Push,
TargetSnapshotParams::default(),
);
},
EmbedderToConstellationMessage::NewWebView(url, new_webview_details) => {
self.handle_new_top_level_browsing_context(url, new_webview_details);
},
EmbedderToConstellationMessage::CloseWebView(webview_id) => {
self.handle_close_top_level_browsing_context(webview_id);
},
EmbedderToConstellationMessage::SendError(webview_id, error) => {
warn!("Constellation got a SendError message from WebView {webview_id:?}: {error}");
let Some(webview_id) = webview_id else {
return;
};
self.handle_panic_in_webview(webview_id, &error, &None);
},
EmbedderToConstellationMessage::FocusWebView(webview_id) => {
self.handle_focus_web_view(webview_id);
},
EmbedderToConstellationMessage::BlurWebView => {
self.constellation_to_embedder_proxy
.send(ConstellationToEmbedderMsg::WebViewBlurred);
},
EmbedderToConstellationMessage::TraverseHistory(
webview_id,
direction,
traversal_id,
) => {
self.handle_traverse_history_msg(webview_id, direction);
self.constellation_to_embedder_proxy.send(
ConstellationToEmbedderMsg::HistoryTraversalComplete(webview_id, traversal_id),
);
},
EmbedderToConstellationMessage::ChangeViewportDetails(
webview_id,
new_viewport_details,
size_type,
) => {
self.handle_change_viewport_details_msg(
webview_id,
new_viewport_details,
size_type,
);
},
EmbedderToConstellationMessage::ThemeChange(webview_id, theme) => {
self.handle_theme_change(webview_id, theme);
},
EmbedderToConstellationMessage::TickAnimation(webview_ids) => {
self.handle_tick_animation(webview_ids)
},
EmbedderToConstellationMessage::NoLongerWaitingOnAsynchronousImageUpdates(
pipeline_ids,
) => self.handle_no_longer_waiting_on_asynchronous_image_updates(pipeline_ids),
EmbedderToConstellationMessage::WebDriverCommand(command) => {
self.handle_webdriver_msg(command);
},
EmbedderToConstellationMessage::Reload(webview_id) => {
self.handle_reload_msg(webview_id);
},
EmbedderToConstellationMessage::LogEntry(event_loop_id, thread_name, entry) => {
self.handle_log_entry(event_loop_id, thread_name, entry);
},
EmbedderToConstellationMessage::ForwardInputEvent(webview_id, event, hit_test) => {
self.forward_input_event(webview_id, event, hit_test);
},
EmbedderToConstellationMessage::RefreshCursor(pipeline_id) => {
self.handle_refresh_cursor(pipeline_id)
},
EmbedderToConstellationMessage::ToggleProfiler(rate, max_duration) => {
self.send_message_to_all_background_hang_monitors(
BackgroundHangMonitorControlMsg::ToggleSampler(rate, max_duration),
);
},
EmbedderToConstellationMessage::ExitFullScreen(webview_id) => {
self.handle_exit_fullscreen_msg(webview_id);
},
EmbedderToConstellationMessage::MediaSessionAction(action) => {
self.handle_media_session_action_msg(action);
},
EmbedderToConstellationMessage::SetWebViewThrottled(webview_id, throttled) => {
self.set_webview_throttled(webview_id, throttled);
},
EmbedderToConstellationMessage::SetScrollStates(pipeline_id, scroll_states) => {
self.handle_set_scroll_states(pipeline_id, scroll_states)
},
EmbedderToConstellationMessage::PaintMetric(pipeline_id, paint_metric_event) => {
self.handle_paint_metric(pipeline_id, paint_metric_event);
},
EmbedderToConstellationMessage::EvaluateJavaScript(
webview_id,
evaluation_id,
script,
) => {
self.handle_evaluate_javascript(webview_id, evaluation_id, script);
},
EmbedderToConstellationMessage::CreateMemoryReport(sender) => {
self.mem_profiler_chan.send(ProfilerMsg::Report(sender));
},
EmbedderToConstellationMessage::SendImageKeysForPipeline(pipeline_id, image_keys) => {
if let Some(pipeline) = self.pipelines.get(&pipeline_id) {
if pipeline
.event_loop
.send(ScriptThreadMessage::SendImageKeysBatch(
pipeline_id,
image_keys,
))
.is_err()
{
warn!("Could not send image keys to pipeline {:?}", pipeline_id);
}
} else {
warn!(
"Keys were generated for a pipeline ({:?}) that was
closed before the request could be fulfilled.",
pipeline_id
)
}
},
EmbedderToConstellationMessage::PreferencesUpdated(updates) => {
let event_loops = self
.pipelines
.values()
.map(|pipeline| pipeline.event_loop.clone());
for event_loop in event_loops {
let _ = event_loop.send(ScriptThreadMessage::PreferencesUpdated(
updates
.iter()
.map(|(name, value)| (String::from(*name), value.clone()))
.collect(),
));
}
},
EmbedderToConstellationMessage::RequestScreenshotReadiness(webview_id) => {
self.handle_request_screenshot_readiness(webview_id)
},
EmbedderToConstellationMessage::EmbedderControlResponse(id, response) => {
self.handle_embedder_control_response(id, response);
},
EmbedderToConstellationMessage::UserContentManagerAction(
user_content_manager_id,
action,
) => {
self.handle_user_content_manager_action(user_content_manager_id, action);
},
EmbedderToConstellationMessage::UpdatePinchZoomInfos(pipeline_id, pinch_zoom) => {
self.handle_update_pinch_zoom_infos(pipeline_id, pinch_zoom);
},
EmbedderToConstellationMessage::SetAccessibilityActive(webview_id, active) => {
self.set_accessibility_active(webview_id, active);
},
}
}
fn mutate_user_contents_for_manager_id_and_notify_script_threads(
&mut self,
user_content_manager_id: UserContentManagerId,
callback: impl FnOnce(&mut UserContents),
) {
let event_loops = self.event_loops();
let user_contents = self
.user_contents_for_manager_id
.entry(user_content_manager_id)
.or_default();
callback(user_contents);
for event_loop in event_loops {
let _ = event_loop.send(ScriptThreadMessage::SetUserContents(
user_content_manager_id,
user_contents.clone(),
));
}
}
fn handle_user_content_manager_action(
&mut self,
user_content_manager_id: UserContentManagerId,
action: UserContentManagerAction,
) {
match action {
UserContentManagerAction::AddUserScript(user_script) => {
self.mutate_user_contents_for_manager_id_and_notify_script_threads(
user_content_manager_id,
|user_contents| {
user_contents.scripts.push(user_script);
},
);
},
UserContentManagerAction::RemoveUserScript(user_script_id) => {
self.mutate_user_contents_for_manager_id_and_notify_script_threads(
user_content_manager_id,
|user_contents| {
user_contents
.scripts
.retain(|user_script| user_script.id() != user_script_id);
},
);
},
UserContentManagerAction::AddUserStyleSheet(user_stylesheet) => {
self.mutate_user_contents_for_manager_id_and_notify_script_threads(
user_content_manager_id,
|user_contents| {
user_contents.stylesheets.push(user_stylesheet);
},
);
},
UserContentManagerAction::RemoveUserStyleSheet(user_stylesheet_id) => {
self.mutate_user_contents_for_manager_id_and_notify_script_threads(
user_content_manager_id,
|user_contents| {
user_contents
.stylesheets
.retain(|user_stylesheet| user_stylesheet.id() != user_stylesheet_id);
},
);
},
UserContentManagerAction::DestroyUserContentManager => {
self.user_contents_for_manager_id
.remove(&user_content_manager_id);
for event_loop in self.event_loops() {
let _ = event_loop.send(ScriptThreadMessage::DestroyUserContentManager(
user_content_manager_id,
));
}
},
}
}
fn send_message_to_all_background_hang_monitors(
&self,
message: BackgroundHangMonitorControlMsg,
) {
if let Some(background_monitor_control_sender) = &self.background_monitor_control_sender {
if let Err(error) = background_monitor_control_sender.send(message.clone()) {
error!("Could not send message ({message:?}) to BHM: {error}");
}
}
for event_loop in self.event_loops() {
event_loop.send_message_to_background_hang_monitor(&message);
}
}
#[servo_tracing::instrument(skip_all)]
fn handle_evaluate_javascript(
&mut self,
webview_id: WebViewId,
evaluation_id: JavaScriptEvaluationId,
script: String,
) {
let browsing_context_id = BrowsingContextId::from(webview_id);
let Some(pipeline) = self
.browsing_contexts
.get(&browsing_context_id)
.and_then(|browsing_context| self.pipelines.get(&browsing_context.pipeline_id))
else {
self.handle_finish_javascript_evaluation(
evaluation_id,
Err(JavaScriptEvaluationError::InternalError),
);
return;
};
if pipeline
.event_loop
.send(ScriptThreadMessage::EvaluateJavaScript(
webview_id,
pipeline.id,
evaluation_id,
script,
))
.is_err()
{
self.handle_finish_javascript_evaluation(
evaluation_id,
Err(JavaScriptEvaluationError::InternalError),
);
}
}
#[servo_tracing::instrument(skip_all)]
fn handle_request_from_script(
&mut self,
message: (WebViewId, PipelineId, ScriptToConstellationMessage),
) {
let (webview_id, source_pipeline_id, content) = message;
trace_script_msg!(content, "{source_pipeline_id}: {content:?}");
match content {
ScriptToConstellationMessage::CompleteMessagePortTransfer(router_id, ports) => {
self.handle_complete_message_port_transfer(router_id, ports);
},
ScriptToConstellationMessage::MessagePortTransferResult(
router_id,
succeeded,
failed,
) => {
self.handle_message_port_transfer_completed(router_id, succeeded);
self.handle_message_port_transfer_failed(failed);
},
ScriptToConstellationMessage::RerouteMessagePort(port_id, task) => {
self.handle_reroute_messageport(port_id, task);
},
ScriptToConstellationMessage::MessagePortShipped(port_id) => {
self.handle_messageport_shipped(port_id);
},
ScriptToConstellationMessage::NewMessagePortRouter(router_id, callback) => {
self.handle_new_messageport_router(router_id, callback);
},
ScriptToConstellationMessage::RemoveMessagePortRouter(router_id) => {
self.handle_remove_messageport_router(router_id);
},
ScriptToConstellationMessage::NewMessagePort(router_id, port_id) => {
self.handle_new_messageport(router_id, port_id);
},
ScriptToConstellationMessage::EntanglePorts(port1, port2) => {
self.handle_entangle_messageports(port1, port2);
},
ScriptToConstellationMessage::DisentanglePorts(port1, port2) => {
self.handle_disentangle_messageports(port1, port2);
},
ScriptToConstellationMessage::NewBroadcastChannelRouter(
router_id,
response_sender,
origin,
) => {
if self
.check_origin_against_pipeline(&source_pipeline_id, &origin)
.is_err()
{
return warn!("Attempt to add broadcast router from an unexpected origin.");
}
self.broadcast_channels
.new_broadcast_channel_router(router_id, response_sender);
},
ScriptToConstellationMessage::NewBroadcastChannelNameInRouter(
router_id,
channel_name,
origin,
) => {
if self
.check_origin_against_pipeline(&source_pipeline_id, &origin)
.is_err()
{
return warn!("Attempt to add channel name from an unexpected origin.");
}
self.broadcast_channels
.new_broadcast_channel_name_in_router(router_id, channel_name, origin);
},
ScriptToConstellationMessage::RemoveBroadcastChannelNameInRouter(
router_id,
channel_name,
origin,
) => {
if self
.check_origin_against_pipeline(&source_pipeline_id, &origin)
.is_err()
{
return warn!("Attempt to remove channel name from an unexpected origin.");
}
self.broadcast_channels
.remove_broadcast_channel_name_in_router(router_id, channel_name, origin);
},
ScriptToConstellationMessage::RemoveBroadcastChannelRouter(router_id, origin) => {
if self
.check_origin_against_pipeline(&source_pipeline_id, &origin)
.is_err()
{
return warn!("Attempt to remove broadcast router from an unexpected origin.");
}
self.broadcast_channels
.remove_broadcast_channel_router(router_id);
},
ScriptToConstellationMessage::ScheduleBroadcast(router_id, message) => {
if self
.check_origin_against_pipeline(&source_pipeline_id, &message.origin)
.is_err()
{
return warn!(
"Attempt to schedule broadcast from an origin not matching the origin of the msg."
);
}
self.broadcast_channels
.schedule_broadcast(router_id, message);
},
ScriptToConstellationMessage::PipelineExited => {
self.handle_pipeline_exited(source_pipeline_id);
},
ScriptToConstellationMessage::DiscardDocument => {
self.handle_discard_document(webview_id, source_pipeline_id);
},
ScriptToConstellationMessage::DiscardTopLevelBrowsingContext => {
self.handle_close_top_level_browsing_context(webview_id);
},
ScriptToConstellationMessage::ScriptLoadedURLInIFrame(load_info) => {
self.handle_script_loaded_url_in_iframe_msg(load_info);
},
ScriptToConstellationMessage::ScriptNewIFrame(load_info) => {
self.handle_script_new_iframe(load_info);
},
ScriptToConstellationMessage::CreateAuxiliaryWebView(load_info) => {
self.handle_script_new_auxiliary(load_info);
},
ScriptToConstellationMessage::ChangeRunningAnimationsState(animation_state) => {
self.handle_change_running_animations_state(source_pipeline_id, animation_state)
},
ScriptToConstellationMessage::LoadUrl(
load_data,
history_handling,
target_snapshot_params,
) => {
self.schedule_navigation(
webview_id,
source_pipeline_id,
load_data,
history_handling,
target_snapshot_params,
);
},
ScriptToConstellationMessage::AbortLoadUrl => {
self.handle_abort_load_url_msg(source_pipeline_id);
},
ScriptToConstellationMessage::LoadComplete => {
self.handle_load_complete_msg(webview_id, source_pipeline_id)
},
ScriptToConstellationMessage::NavigatedToFragment(new_url, replacement_enabled) => {
self.handle_navigated_to_fragment(source_pipeline_id, new_url, replacement_enabled);
},
ScriptToConstellationMessage::TraverseHistory(direction) => {
self.handle_traverse_history_msg(webview_id, direction);
},
ScriptToConstellationMessage::PushHistoryState(history_state_id, url) => {
self.handle_push_history_state_msg(source_pipeline_id, history_state_id, url);
},
ScriptToConstellationMessage::ReplaceHistoryState(history_state_id, url) => {
self.handle_replace_history_state_msg(source_pipeline_id, history_state_id, url);
},
ScriptToConstellationMessage::JointSessionHistoryLength(response_sender) => {
self.handle_joint_session_history_length(webview_id, response_sender);
},
ScriptToConstellationMessage::ActivateDocument => {
self.handle_activate_document_msg(source_pipeline_id);
},
ScriptToConstellationMessage::SetFinalUrl(final_url) => {
if let Some(ref mut pipeline) = self.pipelines.get_mut(&source_pipeline_id) {
pipeline.url = final_url;
} else {
warn!("constellation got set final url message for dead pipeline");
}
},
ScriptToConstellationMessage::PostMessage {
target: browsing_context_id,
source: source_pipeline_id,
target_origin: origin,
source_origin,
data,
} => {
self.handle_post_message_msg(
browsing_context_id,
source_pipeline_id,
origin,
source_origin,
data,
);
},
ScriptToConstellationMessage::FocusAncestorBrowsingContextsForFocusingSteps(
focused_child_browsing_context_id,
sequence,
) => {
self.handle_focus_ancestor_browsing_contexts_for_focusing_steps(
source_pipeline_id,
focused_child_browsing_context_id,
sequence,
);
},
ScriptToConstellationMessage::FocusRemoteBrowsingContext(
focused_browsing_context_id,
remote_focus_operation,
) => {
self.handle_focus_remote_browsing_context(
focused_browsing_context_id,
remote_focus_operation,
);
},
ScriptToConstellationMessage::SetThrottledComplete(throttled) => {
self.handle_set_throttled_complete(source_pipeline_id, throttled);
},
ScriptToConstellationMessage::RemoveIFrame(browsing_context_id, response_sender) => {
let removed_pipeline_ids = self.handle_remove_iframe_msg(browsing_context_id);
if let Err(e) = response_sender.send(removed_pipeline_ids) {
warn!("Error replying to remove iframe ({})", e);
}
},
ScriptToConstellationMessage::CreateCanvasPaintThread(size, response_sender) => {
self.handle_create_canvas_paint_thread_msg(size, response_sender)
},
ScriptToConstellationMessage::SetDocumentState(state) => {
self.document_states.insert(source_pipeline_id, state);
},
ScriptToConstellationMessage::LogEntry(event_loop_id, thread_name, entry) => {
self.handle_log_entry(event_loop_id, thread_name, entry);
},
ScriptToConstellationMessage::GetBrowsingContextInfo(pipeline_id, response_sender) => {
let result = self
.pipelines
.get(&pipeline_id)
.and_then(|pipeline| self.browsing_contexts.get(&pipeline.browsing_context_id))
.map(|ctx| (ctx.id, ctx.parent_pipeline_id));
if let Err(e) = response_sender.send(result) {
warn!(
"Sending reply to get browsing context info failed ({:?}).",
e
);
}
},
ScriptToConstellationMessage::GetTopForBrowsingContext(
browsing_context_id,
response_sender,
) => {
let result = self
.browsing_contexts
.get(&browsing_context_id)
.map(|bc| bc.webview_id);
if let Err(e) = response_sender.send(result) {
warn!(
"Sending reply to get top for browsing context info failed ({:?}).",
e
);
}
},
ScriptToConstellationMessage::GetChildBrowsingContextId(
browsing_context_id,
index,
response_sender,
) => {
let result = self
.browsing_contexts
.get(&browsing_context_id)
.and_then(|bc| self.pipelines.get(&bc.pipeline_id))
.and_then(|pipeline| pipeline.children.get(index))
.copied();
if let Err(e) = response_sender.send(result) {
warn!(
"Sending reply to get child browsing context ID failed ({:?}).",
e
);
}
},
ScriptToConstellationMessage::GetDocumentOrigin(pipeline_id, response_sender) => {
self.send_message_to_pipeline(
pipeline_id,
ScriptThreadMessage::GetDocumentOrigin(pipeline_id, response_sender),
"Document origin retrieval after closure",
);
},
ScriptToConstellationMessage::ScheduleJob(job) => {
self.handle_schedule_serviceworker_job(source_pipeline_id, job);
},
ScriptToConstellationMessage::ForwardDOMMessage(msg_vec, scope_url) => {
if let Some(mgr) = self.sw_managers.get(&scope_url.origin()) {
let _ = mgr.send(ServiceWorkerMsg::ForwardDOMMessage(msg_vec, scope_url));
} else {
warn!("Unable to forward DOMMessage for postMessage call");
}
},
ScriptToConstellationMessage::RegisterInterest(interest) => {
self.pipeline_interests
.entry(interest)
.or_default()
.insert(source_pipeline_id);
},
ScriptToConstellationMessage::UnregisterInterest(interest) => {
if let Some(set) = self.pipeline_interests.get_mut(&interest) {
set.remove(&source_pipeline_id);
if set.is_empty() {
self.pipeline_interests.remove(&interest);
}
}
},
ScriptToConstellationMessage::BroadcastStorageEvent(
storage,
url,
key,
old_value,
new_value,
) => {
self.handle_broadcast_storage_event(
source_pipeline_id,
storage,
url,
key,
old_value,
new_value,
);
},
ScriptToConstellationMessage::MediaSessionEvent(pipeline_id, event) => {
if self.active_media_session.is_some() {
if let MediaSessionEvent::PlaybackStateChange(ref state) = event {
if !matches!(
state,
MediaSessionPlaybackState::Playing | MediaSessionPlaybackState::Paused
) {
return;
}
};
}
self.active_media_session = Some(pipeline_id);
self.constellation_to_embedder_proxy.send(
ConstellationToEmbedderMsg::MediaSessionEvent(webview_id, event),
);
},
#[cfg(feature = "webgpu")]
ScriptToConstellationMessage::RequestAdapter(response_sender, options, ids) => self
.handle_wgpu_request(
source_pipeline_id,
BrowsingContextId::from(webview_id),
ScriptToConstellationMessage::RequestAdapter(response_sender, options, ids),
),
#[cfg(feature = "webgpu")]
ScriptToConstellationMessage::GetWebGPUChan(response_sender) => self
.handle_wgpu_request(
source_pipeline_id,
BrowsingContextId::from(webview_id),
ScriptToConstellationMessage::GetWebGPUChan(response_sender),
),
ScriptToConstellationMessage::TitleChanged(pipeline, title) => {
if let Some(pipeline) = self.pipelines.get_mut(&pipeline) {
pipeline.title = title;
}
},
ScriptToConstellationMessage::IFrameSizes(iframe_sizes) => {
self.handle_iframe_size_msg(iframe_sizes)
},
ScriptToConstellationMessage::ReportMemory(sender) => {
self.mem_profiler_chan
.send(mem::ProfilerMsg::Report(sender));
},
ScriptToConstellationMessage::FinishJavaScriptEvaluation(evaluation_id, result) => {
self.handle_finish_javascript_evaluation(evaluation_id, result)
},
ScriptToConstellationMessage::ForwardKeyboardScroll(pipeline_id, scroll) => {
if let Some(pipeline) = self.pipelines.get(&pipeline_id) {
if let Err(error) =
pipeline
.event_loop
.send(ScriptThreadMessage::ForwardKeyboardScroll(
pipeline_id,
scroll,
))
{
warn!("Could not forward {scroll:?} to {pipeline_id}: {error:?}");
}
}
},
ScriptToConstellationMessage::RespondToScreenshotReadinessRequest(response) => {
self.handle_screenshot_readiness_response(source_pipeline_id, response);
},
ScriptToConstellationMessage::TriggerGarbageCollection => {
for event_loop in self.event_loops() {
let _ = event_loop.send(ScriptThreadMessage::TriggerGarbageCollection);
}
},
ScriptToConstellationMessage::AcquireWakeLock(type_) => match type_ {
WakeLockType::Screen => {
self.screen_wake_lock_count += 1;
if self.screen_wake_lock_count == 1 {
if let Err(e) = self.wake_lock_provider.acquire(type_) {
warn!("Failed to acquire screen wake lock: {e}");
}
}
},
},
ScriptToConstellationMessage::ReleaseWakeLock(type_) => match type_ {
WakeLockType::Screen => {
self.screen_wake_lock_count = self.screen_wake_lock_count.saturating_sub(1);
if self.screen_wake_lock_count == 0 {
if let Err(e) = self.wake_lock_provider.release(type_) {
warn!("Failed to release screen wake lock: {e}");
}
}
},
},
}
}
fn check_origin_against_pipeline(
&self,
pipeline_id: &PipelineId,
origin: &ImmutableOrigin,
) -> Result<(), ()> {
let pipeline_origin = match self.pipelines.get(pipeline_id) {
Some(pipeline) => pipeline.load_data.url.origin(),
None => {
warn!("Received message from closed or unknown pipeline.");
return Err(());
},
};
if &pipeline_origin == origin {
return Ok(());
}
Err(())
}
#[servo_tracing::instrument(skip_all)]
#[cfg(feature = "webgpu")]
fn handle_wgpu_request(
&mut self,
source_pipeline_id: PipelineId,
browsing_context_id: BrowsingContextId,
request: ScriptToConstellationMessage,
) {
use webgpu::start_webgpu_thread;
let browsing_context_group_id = match self.browsing_contexts.get(&browsing_context_id) {
Some(bc) => &bc.bc_group_id,
None => return warn!("Browsing context not found"),
};
let Some(source_pipeline) = self.pipelines.get(&source_pipeline_id) else {
return warn!("{source_pipeline_id}: ScriptMsg from closed pipeline");
};
let Some(host) = registered_domain_name(&source_pipeline.url) else {
return warn!("Invalid host url");
};
let browsing_context_group = if let Some(bcg) = self
.browsing_context_group_set
.get_mut(browsing_context_group_id)
{
bcg
} else {
return warn!("Browsing context group not found");
};
let webgpu_chan = match browsing_context_group.webgpus.entry(host) {
Entry::Vacant(v) => start_webgpu_thread(
self.paint_proxy.cross_process_paint_api.clone(),
self.webrender_wgpu
.webrender_external_image_id_manager
.clone(),
self.webrender_wgpu.wgpu_image_map.clone(),
)
.map(|webgpu| {
let msg = ScriptThreadMessage::SetWebGPUPort(webgpu.1);
if let Err(e) = source_pipeline.event_loop.send(msg) {
warn!(
"{}: Failed to send SetWebGPUPort to pipeline ({:?})",
source_pipeline_id, e
);
}
v.insert(webgpu.0).clone()
}),
Entry::Occupied(o) => Some(o.get().clone()),
};
match request {
ScriptToConstellationMessage::RequestAdapter(response_sender, options, adapter_id) => {
match webgpu_chan {
None => {
if let Err(e) = response_sender.send(None) {
warn!("Failed to send request adapter message: {}", e)
}
},
Some(webgpu_chan) => {
let adapter_request = WebGPURequest::RequestAdapter {
sender: response_sender,
options,
adapter_id,
};
if webgpu_chan.0.send(adapter_request).is_err() {
warn!("Failed to send request adapter message on WebGPU channel");
}
},
}
},
ScriptToConstellationMessage::GetWebGPUChan(response_sender) => {
if response_sender.send(webgpu_chan).is_err() {
warn!(
"{}: Failed to send WebGPU channel to pipeline",
source_pipeline_id
)
}
},
_ => warn!("Wrong message type in handle_wgpu_request"),
}
}
#[servo_tracing::instrument(skip_all)]
fn handle_message_port_transfer_completed(
&mut self,
router_id: Option<MessagePortRouterId>,
ports: Vec<MessagePortId>,
) {
let Some(router_id) = router_id else {
if !ports.is_empty() {
warn!(
"Constellation unable to process port transfer successes, since no router id was received"
);
}
return;
};
for port_id in ports.into_iter() {
let mut entry = match self.message_ports.entry(port_id) {
Entry::Vacant(_) => {
warn!(
"Constellation received a port transfer completed msg for unknown messageport {port_id:?}",
);
continue;
},
Entry::Occupied(entry) => entry,
};
match entry.get().state {
TransferState::CompletionInProgress(expected_router_id) => {
if expected_router_id != router_id {
return warn!(
"Transfer completed by an unexpected router: {:?}",
router_id
);
}
let new_info = MessagePortInfo {
state: TransferState::Managed(router_id),
entangled_with: entry.get().entangled_with,
};
entry.insert(new_info);
},
_ => warn!("Constellation received unexpected port transfer completed message"),
}
}
}
fn handle_message_port_transfer_failed(
&mut self,
ports: FxHashMap<MessagePortId, PortTransferInfo>,
) {
for (port_id, mut transfer_info) in ports.into_iter() {
let Some(entry) = self.message_ports.remove(&port_id) else {
warn!(
"Constellation received a port transfer completed msg for unknown messageport {port_id:?}",
);
continue;
};
let new_info = match entry.state {
TransferState::CompletionFailed(mut current_buffer) => {
while let Some(task) = transfer_info.port_message_queue.pop_back() {
current_buffer.push_front(task);
}
MessagePortInfo {
state: TransferState::TransferInProgress(current_buffer),
entangled_with: entry.entangled_with,
}
},
TransferState::CompletionRequested(target_router_id, mut current_buffer) => {
while let Some(task) = transfer_info.port_message_queue.pop_back() {
current_buffer.push_front(task);
}
if let Some(ipc_sender) = self.message_port_routers.get(&target_router_id) {
if ipc_sender
.send(MessagePortMsg::CompletePendingTransfer(
port_id,
PortTransferInfo {
port_message_queue: current_buffer,
disentangled: entry.entangled_with.is_none(),
},
))
.is_err()
{
warn!("Constellation failed to send complete port transfer response.");
}
} else {
warn!("No message-port sender for {:?}", target_router_id);
}
MessagePortInfo {
state: TransferState::CompletionInProgress(target_router_id),
entangled_with: entry.entangled_with,
}
},
_ => {
warn!("Unexpected port transfer failed message received");
continue;
},
};
self.message_ports.insert(port_id, new_info);
}
}
#[servo_tracing::instrument(skip_all)]
fn handle_complete_message_port_transfer(
&mut self,
router_id: MessagePortRouterId,
ports: Vec<MessagePortId>,
) {
let mut response = FxHashMap::default();
for port_id in ports.into_iter() {
let Some(entry) = self.message_ports.remove(&port_id) else {
warn!(
"Constellation asked to complete transfer for unknown messageport {port_id:?}",
);
continue;
};
let new_info = match entry.state {
TransferState::TransferInProgress(buffer) => {
response.insert(
port_id,
PortTransferInfo {
port_message_queue: buffer,
disentangled: entry.entangled_with.is_none(),
},
);
MessagePortInfo {
state: TransferState::CompletionInProgress(router_id),
entangled_with: entry.entangled_with,
}
},
TransferState::CompletionFailed(buffer) |
TransferState::CompletionRequested(_, buffer) => {
MessagePortInfo {
state: TransferState::CompletionRequested(router_id, buffer),
entangled_with: entry.entangled_with,
}
},
_ => {
warn!("Unexpected complete port transfer message received");
continue;
},
};
self.message_ports.insert(port_id, new_info);
}
if !response.is_empty() {
if let Some(ipc_sender) = self.message_port_routers.get(&router_id) {
if ipc_sender
.send(MessagePortMsg::CompleteTransfer(response))
.is_err()
{
warn!("Constellation failed to send complete port transfer response.");
}
} else {
warn!("No message-port sender for {:?}", router_id);
}
}
}
#[servo_tracing::instrument(skip_all)]
fn handle_reroute_messageport(&mut self, port_id: MessagePortId, task: PortMessageTask) {
let Some(info) = self.message_ports.get_mut(&port_id) else {
return warn!(
"Constellation asked to re-route msg to unknown messageport {:?}",
port_id
);
};
match &mut info.state {
TransferState::Managed(router_id) | TransferState::CompletionInProgress(router_id) => {
if let Some(ipc_sender) = self.message_port_routers.get(router_id) {
let _ = ipc_sender.send(MessagePortMsg::NewTask(port_id, task));
} else {
warn!("No message-port sender for {:?}", router_id);
}
},
TransferState::TransferInProgress(queue) => queue.push_back(task),
TransferState::CompletionFailed(queue) => queue.push_back(task),
TransferState::CompletionRequested(_, queue) => queue.push_back(task),
}
}
#[servo_tracing::instrument(skip_all)]
fn handle_messageport_shipped(&mut self, port_id: MessagePortId) {
if let Some(info) = self.message_ports.get_mut(&port_id) {
match info.state {
TransferState::Managed(_) => {
info.state = TransferState::TransferInProgress(VecDeque::new());
},
TransferState::CompletionInProgress(_) => {
info.state = TransferState::CompletionFailed(VecDeque::new());
},
_ => warn!("Unexpected messageport shipped received"),
}
} else {
warn!(
"Constellation asked to mark unknown messageport as shipped {:?}",
port_id
);
}
}
fn handle_new_messageport_router(
&mut self,
router_id: MessagePortRouterId,
message_port_callbacks: GenericCallback<MessagePortMsg>,
) {
self.message_port_routers
.insert(router_id, message_port_callbacks);
}
fn handle_remove_messageport_router(&mut self, router_id: MessagePortRouterId) {
self.message_port_routers.remove(&router_id);
}
fn handle_new_messageport(&mut self, router_id: MessagePortRouterId, port_id: MessagePortId) {
match self.message_ports.entry(port_id) {
Entry::Occupied(_) => warn!(
"Constellation asked to start tracking an existing messageport {:?}",
port_id
),
Entry::Vacant(entry) => {
let info = MessagePortInfo {
state: TransferState::Managed(router_id),
entangled_with: None,
};
entry.insert(info);
},
}
}
#[servo_tracing::instrument(skip_all)]
fn handle_entangle_messageports(&mut self, port1: MessagePortId, port2: MessagePortId) {
if let Some(info) = self.message_ports.get_mut(&port1) {
info.entangled_with = Some(port2);
} else {
warn!(
"Constellation asked to entangle unknown messageport: {:?}",
port1
);
}
if let Some(info) = self.message_ports.get_mut(&port2) {
info.entangled_with = Some(port1);
} else {
warn!(
"Constellation asked to entangle unknown messageport: {:?}",
port2
);
}
}
#[servo_tracing::instrument(skip_all)]
fn handle_disentangle_messageports(
&mut self,
port1: MessagePortId,
port2: Option<MessagePortId>,
) {
let _ = self.message_ports.remove(&port1);
let Some(port2) = port2 else {
return;
};
if let Some(info) = self.message_ports.get_mut(&port2) {
info.entangled_with = None;
match &mut info.state {
TransferState::Managed(router_id) |
TransferState::CompletionInProgress(router_id) => {
if let Some(ipc_sender) = self.message_port_routers.get(router_id) {
let _ = ipc_sender.send(MessagePortMsg::CompleteDisentanglement(port2));
} else {
warn!("No message-port sender for {:?}", router_id);
}
},
_ => {
},
}
} else {
warn!(
"Constellation asked to disentangle unknown messageport: {:?}",
port2
);
}
}
#[servo_tracing::instrument(skip_all)]
fn handle_schedule_serviceworker_job(&mut self, pipeline_id: PipelineId, job: Job) {
let origin = job.scope_url.origin();
if self
.check_origin_against_pipeline(&pipeline_id, &origin)
.is_err()
{
return warn!(
"Attempt to schedule a serviceworker job from an origin not matching the origin of the job."
);
}
let sw_manager = match self.sw_managers.entry(origin.clone()) {
Entry::Occupied(entry) => entry.into_mut(),
Entry::Vacant(entry) => {
let (own_sender, receiver) =
generic_channel::channel().expect("Failed to create IPC channel!");
let sw_senders = SWManagerSenders {
swmanager_sender: self.swmanager_ipc_sender.clone(),
resource_threads: self.public_resource_threads.clone(),
own_sender: own_sender.clone(),
receiver,
paint_api: self.paint_proxy.cross_process_paint_api.clone(),
system_font_service_sender: self.system_font_service.to_sender(),
};
if opts::get().multiprocess {
let (sender, receiver) = generic_channel::channel()
.expect("Failed to create lifeline channel for sw");
let content =
ServiceWorkerUnprivilegedContent::new(sw_senders, origin, Some(sender));
if let Ok(process) = content.spawn_multiprocess() {
let crossbeam_receiver = receiver.route_preserving_errors();
self.process_manager.add(crossbeam_receiver, process);
} else {
return warn!("Failed to spawn process for SW manager.");
}
} else {
let content = ServiceWorkerUnprivilegedContent::new(sw_senders, origin, None);
content.start::<SWF>();
}
entry.insert(own_sender)
},
};
let _ = sw_manager.send(ServiceWorkerMsg::ScheduleJob(job));
}
#[servo_tracing::instrument(skip_all)]
fn handle_broadcast_storage_event(
&self,
pipeline_id: PipelineId,
storage: WebStorageType,
url: ServoUrl,
key: Option<String>,
old_value: Option<String>,
new_value: Option<String>,
) {
let origin = url.origin();
let Some(source_pipeline) = self.pipelines.get(&pipeline_id) else {
warn!("Received storage event broadcast request from closed pipeline.");
return;
};
if source_pipeline.url.origin() != origin {
return warn!(
"Attempt to broadcast storage event from an origin not matching the source pipeline origin."
);
}
let interested = match self
.pipeline_interests
.get(&ConstellationInterest::StorageEvent)
{
Some(set) => set,
None => return,
}
.iter()
.filter_map(|interested_id| self.pipelines.get(interested_id));
for pipeline in interested {
if pipeline.id == pipeline_id || pipeline.url.origin() != origin {
continue;
}
if storage == WebStorageType::Session &&
pipeline.webview_id != source_pipeline.webview_id
{
continue;
}
let msg = ScriptThreadMessage::DispatchStorageEvent(
pipeline.id,
storage,
url.clone(),
key.clone(),
old_value.clone(),
new_value.clone(),
);
if let Err(err) = pipeline.event_loop.send(msg) {
warn!(
"{}: Failed to broadcast storage event to pipeline ({:?}).",
pipeline.id, err
);
}
}
}
#[servo_tracing::instrument(skip_all)]
fn handle_exit(&mut self) {
debug!("Handling exit.");
if self.shutting_down {
return;
}
self.shutting_down = true;
self.mem_profiler_chan.send(mem::ProfilerMsg::Exit);
self.send_message_to_all_background_hang_monitors(BackgroundHangMonitorControlMsg::Exit);
let browsing_context_ids: Vec<BrowsingContextId> = self
.browsing_contexts
.values()
.filter(|browsing_context| browsing_context.is_top_level())
.map(|browsing_context| browsing_context.id)
.collect();
for browsing_context_id in browsing_context_ids {
debug!(
"{}: Removing top-level browsing context",
browsing_context_id
);
self.close_browsing_context(browsing_context_id, ExitPipelineMode::Normal);
}
while let Some(pending) = self.pending_changes.pop() {
debug!(
"{}: Removing pending browsing context",
pending.browsing_context_id
);
self.close_browsing_context(pending.browsing_context_id, ExitPipelineMode::Normal);
debug!("{}: Removing pending pipeline", pending.new_pipeline_id);
self.close_pipeline(
pending.new_pipeline_id,
DiscardBrowsingContext::Yes,
ExitPipelineMode::Normal,
);
}
let browsing_context_ids: Vec<BrowsingContextId> =
self.browsing_contexts.keys().cloned().collect();
for browsing_context_id in browsing_context_ids {
debug!(
"{}: Removing detached browsing context",
browsing_context_id
);
self.close_browsing_context(browsing_context_id, ExitPipelineMode::Normal);
}
let pipeline_ids: Vec<PipelineId> = self.pipelines.keys().cloned().collect();
for pipeline_id in pipeline_ids {
debug!("{}: Removing detached pipeline", pipeline_id);
self.close_pipeline(
pipeline_id,
DiscardBrowsingContext::Yes,
ExitPipelineMode::Normal,
);
}
}
#[servo_tracing::instrument(skip_all)]
fn handle_shutdown(&mut self) {
debug!("Handling shutdown.");
for join_handle in self.event_loop_join_handles.drain(..) {
if join_handle.join().is_err() {
error!("Failed to join on a script-thread.");
}
}
drop(self.background_monitor_register.take());
if let Some(join_handle) = self.background_monitor_register_join_handle.take() {
if join_handle.join().is_err() {
error!("Failed to join on the bhm background thread.");
}
}
let (core_ipc_sender, core_ipc_receiver) =
generic_channel::oneshot().expect("Failed to create IPC channel!");
let (public_client_storage_generic_sender, public_client_storage_generic_receiver) =
generic_channel::channel().expect("Failed to create generic channel!");
let (private_client_storage_generic_sender, private_client_storage_generic_receiver) =
generic_channel::channel().expect("Failed to create generic channel!");
let (public_indexeddb_ipc_sender, public_indexeddb_ipc_receiver) =
generic_channel::channel().expect("Failed to create generic channel!");
let (private_indexeddb_ipc_sender, private_indexeddb_ipc_receiver) =
generic_channel::channel().expect("Failed to create generic channel!");
let (public_web_storage_generic_sender, public_web_storage_generic_receiver) =
generic_channel::channel().expect("Failed to create generic channel!");
let (private_web_storage_generic_sender, private_web_storage_generic_receiver) =
generic_channel::channel().expect("Failed to create generic channel!");
debug!("Exiting core resource threads.");
if let Err(e) = self
.public_resource_threads
.send(net_traits::CoreResourceMsg::Exit(core_ipc_sender))
{
warn!("Exit resource thread failed ({})", e);
}
if let Some(ref chan) = self.devtools_sender {
debug!("Exiting devtools.");
let msg = DevtoolsControlMsg::FromChrome(ChromeToDevtoolsControlMsg::ServerExitMsg);
if let Err(e) = chan.send(msg) {
warn!("Exit devtools failed ({:?})", e);
}
}
debug!("Exiting public client storage thread.");
if let Err(e) = generic_channel::GenericSend::send(
&self.public_storage_threads,
ClientStorageThreadMessage::Exit(public_client_storage_generic_sender),
) {
warn!("Exit public client storage thread failed ({})", e);
}
debug!("Exiting private client storage thread.");
if let Err(e) = generic_channel::GenericSend::send(
&self.private_storage_threads,
ClientStorageThreadMessage::Exit(private_client_storage_generic_sender),
) {
warn!("Exit private client storage thread failed ({})", e);
}
debug!("Exiting public indexeddb resource threads.");
if let Err(e) =
self.public_storage_threads
.send(IndexedDBThreadMsg::Sync(SyncOperation::Exit(
public_indexeddb_ipc_sender,
)))
{
warn!("Exit public indexeddb thread failed ({})", e);
}
debug!("Exiting private indexeddb resource threads.");
if let Err(e) =
self.private_storage_threads
.send(IndexedDBThreadMsg::Sync(SyncOperation::Exit(
private_indexeddb_ipc_sender,
)))
{
warn!("Exit private indexeddb thread failed ({})", e);
}
debug!("Exiting public web storage thread.");
if let Err(e) = generic_channel::GenericSend::send(
&self.public_storage_threads,
WebStorageThreadMsg::Exit(public_web_storage_generic_sender),
) {
warn!("Exit public web storage thread failed ({})", e);
}
debug!("Exiting private web storage thread.");
if let Err(e) = generic_channel::GenericSend::send(
&self.private_storage_threads,
WebStorageThreadMsg::Exit(private_web_storage_generic_sender),
) {
warn!("Exit private web storage thread failed ({})", e);
}
#[cfg(feature = "bluetooth")]
{
debug!("Exiting bluetooth thread.");
if let Err(e) = self.bluetooth_ipc_sender.send(BluetoothRequest::Exit) {
warn!("Exit bluetooth thread failed ({})", e);
}
}
debug!("Exiting service worker manager thread.");
for (_, mgr) in self.sw_managers.drain() {
if let Err(e) = mgr.send(ServiceWorkerMsg::Exit) {
warn!("Exit service worker manager failed ({})", e);
}
}
let canvas_exit_receiver = if let Some((canvas_sender, _)) = self.canvas.get() {
debug!("Exiting Canvas Paint thread.");
let (canvas_exit_sender, canvas_exit_receiver) = unbounded();
if let Err(e) = canvas_sender.send(ConstellationCanvasMsg::Exit(canvas_exit_sender)) {
warn!("Exit Canvas Paint thread failed ({})", e);
}
Some(canvas_exit_receiver)
} else {
None
};
debug!("Exiting WebGPU threads.");
#[cfg(feature = "webgpu")]
let receivers = self
.browsing_context_group_set
.values()
.flat_map(|browsing_context_group| {
browsing_context_group.webgpus.values().map(|webgpu| {
let (sender, receiver) =
generic_channel::oneshot().expect("Failed to create IPC channel!");
if let Err(e) = webgpu.exit(sender) {
warn!("Exit WebGPU Thread failed ({})", e);
None
} else {
Some(receiver)
}
})
})
.flatten();
#[cfg(feature = "webgpu")]
for receiver in receivers {
if let Err(e) = receiver.recv() {
warn!("Failed to receive exit response from WebGPU ({:?})", e);
}
}
debug!("Exiting GLPlayer thread.");
WindowGLContext::get().exit();
if let Some(canvas_exit_receiver) = canvas_exit_receiver {
let _ = canvas_exit_receiver.recv();
}
debug!("Exiting the system font service thread.");
self.system_font_service.exit();
if let Err(e) = core_ipc_receiver.recv() {
warn!("Exit resource thread failed ({:?})", e);
}
if let Err(e) = public_client_storage_generic_receiver.recv() {
warn!("Exit public client storage thread failed ({:?})", e);
}
if let Err(e) = private_client_storage_generic_receiver.recv() {
warn!("Exit private client storage thread failed ({:?})", e);
}
if let Err(e) = public_indexeddb_ipc_receiver.recv() {
warn!("Exit public indexeddb thread failed ({:?})", e);
}
if let Err(e) = private_indexeddb_ipc_receiver.recv() {
warn!("Exit private indexeddb thread failed ({:?})", e);
}
if let Err(e) = public_web_storage_generic_receiver.recv() {
warn!("Exit public web storage thread failed ({:?})", e);
}
if let Err(e) = private_web_storage_generic_receiver.recv() {
warn!("Exit private web storage thread failed ({:?})", e);
}
debug!("Shutting-down IPC router thread in constellation.");
ROUTER.shutdown();
debug!("Shutting-down the async runtime in constellation.");
self.async_runtime.shutdown();
}
fn handle_pipeline_exited(&mut self, pipeline_id: PipelineId) {
debug!("{}: Exited", pipeline_id);
let Some(pipeline) = self.pipelines.remove(&pipeline_id) else {
return;
};
self.pipeline_interests.retain(|_, set| {
set.remove(&pipeline_id);
!set.is_empty()
});
self.paint_proxy.send(PaintMessage::PipelineExited(
pipeline.webview_id,
pipeline.id,
PipelineExitSource::Constellation,
));
}
#[servo_tracing::instrument(skip_all)]
fn handle_send_error(&mut self, pipeline_id: PipelineId, error: SendError) {
error!("Error sending message to {pipeline_id:?}: {error}",);
let Some(pipeline) = self.pipelines.get(&pipeline_id) else {
return;
};
self.handle_panic_in_webview(
pipeline.webview_id,
&format!("Send failed ({error})"),
&None,
);
}
#[servo_tracing::instrument(skip_all)]
fn handle_panic(
&mut self,
event_loop_id: Option<ScriptEventLoopId>,
reason: String,
backtrace: Option<String>,
) {
if self.hard_fail {
error!("Pipeline failed in hard-fail mode. Crashing!");
process::exit(1);
}
let Some(event_loop_id) = event_loop_id else {
return;
};
debug!("Panic handler for {event_loop_id:?}: {reason:?}",);
let mut webview_ids = HashSet::new();
for pipeline in self.pipelines.values() {
if pipeline.event_loop.id() == event_loop_id {
webview_ids.insert(pipeline.webview_id);
}
}
for webview_id in webview_ids {
self.handle_panic_in_webview(webview_id, &reason, &backtrace);
}
}
fn handle_panic_in_webview(
&mut self,
webview_id: WebViewId,
reason: &String,
backtrace: &Option<String>,
) {
let browsing_context_id = BrowsingContextId::from(webview_id);
self.constellation_to_embedder_proxy
.send(ConstellationToEmbedderMsg::Panic(
webview_id,
reason.clone(),
backtrace.clone(),
));
let Some(browsing_context) = self.browsing_contexts.get(&browsing_context_id) else {
return warn!("failed browsing context is missing");
};
let viewport_details = browsing_context.viewport_details;
let pipeline_id = browsing_context.pipeline_id;
let throttled = browsing_context.throttled;
let Some(pipeline) = self.pipelines.get(&pipeline_id) else {
return warn!("failed pipeline is missing");
};
let opener = pipeline.opener;
self.close_browsing_context_children(
browsing_context_id,
DiscardBrowsingContext::No,
ExitPipelineMode::Force,
);
let old_pipeline_id = pipeline_id;
let Some(old_load_data) = self.refresh_load_data(pipeline_id) else {
return warn!("failed pipeline is missing");
};
if old_load_data.crash.is_some() {
return error!("crash page crashed");
}
warn!("creating replacement pipeline for crash page");
let new_pipeline_id = PipelineId::new();
let new_load_data = LoadData {
crash: Some(
backtrace
.clone()
.map(|backtrace| format!("{reason}\n{backtrace}"))
.unwrap_or_else(|| reason.clone()),
),
creation_sandboxing_flag_set: SandboxingFlagSet::all(),
..old_load_data.clone()
};
let is_private = false;
self.new_pipeline(
new_pipeline_id,
browsing_context_id,
webview_id,
None,
opener,
viewport_details,
new_load_data,
is_private,
throttled,
TargetSnapshotParams::default(),
);
self.add_pending_change(SessionHistoryChange {
webview_id,
browsing_context_id,
new_pipeline_id,
replace: Some(NeedsToReload::Yes(old_pipeline_id, old_load_data)),
new_browsing_context_info: None,
viewport_details,
});
}
#[servo_tracing::instrument(skip_all)]
fn handle_focus_web_view(&mut self, webview_id: WebViewId) {
self.constellation_to_embedder_proxy
.send(ConstellationToEmbedderMsg::WebViewFocused(webview_id, true));
}
#[servo_tracing::instrument(skip_all)]
fn handle_log_entry(
&mut self,
event_loop_id: Option<ScriptEventLoopId>,
thread_name: Option<String>,
entry: LogEntry,
) {
if let LogEntry::Panic(ref reason, ref backtrace) = entry {
self.handle_panic(event_loop_id, reason.clone(), Some(backtrace.clone()));
}
match entry {
LogEntry::Panic(reason, _) | LogEntry::Error(reason) | LogEntry::Warn(reason) => {
if WARNINGS_BUFFER_SIZE <= self.handled_warnings.len() {
self.handled_warnings.pop_front();
}
self.handled_warnings.push_back((thread_name, reason));
},
}
}
fn update_pressed_mouse_buttons(&mut self, event: &MouseButtonEvent) {
let button_as_bitmask = match event.button {
MouseButton::Left => 1,
MouseButton::Right => 2,
MouseButton::Middle => 4,
MouseButton::Back => 8,
MouseButton::Forward => 16,
MouseButton::Other(_) => return,
};
match event.action {
MouseButtonAction::Down => {
self.pressed_mouse_buttons |= button_as_bitmask;
},
MouseButtonAction::Up => {
self.pressed_mouse_buttons &= !(button_as_bitmask);
},
}
}
#[expect(deprecated)]
fn update_active_keybord_modifiers(&mut self, event: &KeyboardEvent) {
self.active_keyboard_modifiers = event.event.modifiers;
let Key::Named(named_key) = event.event.key else {
return;
};
let modified_modifier = match named_key {
NamedKey::Alt => Modifiers::ALT,
NamedKey::AltGraph => Modifiers::ALT_GRAPH,
NamedKey::CapsLock => Modifiers::CAPS_LOCK,
NamedKey::Control => Modifiers::CONTROL,
NamedKey::Fn => Modifiers::FN,
NamedKey::FnLock => Modifiers::FN_LOCK,
NamedKey::Meta => Modifiers::META,
NamedKey::NumLock => Modifiers::NUM_LOCK,
NamedKey::ScrollLock => Modifiers::SCROLL_LOCK,
NamedKey::Shift => Modifiers::SHIFT,
NamedKey::Symbol => Modifiers::SYMBOL,
NamedKey::SymbolLock => Modifiers::SYMBOL_LOCK,
NamedKey::Hyper => Modifiers::HYPER,
NamedKey::Super => Modifiers::META,
_ => return,
};
match event.event.state {
KeyState::Down => self.active_keyboard_modifiers.insert(modified_modifier),
KeyState::Up => self.active_keyboard_modifiers.remove(modified_modifier),
}
}
fn set_accessibility_active(&mut self, webview_id: WebViewId, active: bool) {
if !(pref!(accessibility_enabled)) {
return;
}
let Some(webview) = self.webviews.get_mut(&webview_id) else {
return;
};
webview.accessibility_active = active;
let Some(pipeline_id) = webview.active_top_level_pipeline_id else {
return;
};
let epoch = webview.active_top_level_pipeline_epoch;
self.send_message_to_pipeline(
pipeline_id,
ScriptThreadMessage::SetAccessibilityActive(pipeline_id, active, epoch),
"Set accessibility active after closure",
);
}
fn forward_input_event(
&mut self,
webview_id: WebViewId,
event: InputEventAndId,
hit_test_result: Option<PaintHitTestResult>,
) {
if let InputEvent::MouseButton(event) = &event.event {
self.update_pressed_mouse_buttons(event);
}
if let InputEvent::Keyboard(event) = &event.event {
self.update_active_keybord_modifiers(event);
}
let pressed_mouse_buttons = self.pressed_mouse_buttons;
let active_keyboard_modifiers = self.active_keyboard_modifiers;
let event_id = event.id;
let Some(webview) = self.webviews.get_mut(&webview_id) else {
warn!("Got input event for unknown WebViewId: {webview_id:?}");
self.constellation_to_embedder_proxy.send(
ConstellationToEmbedderMsg::InputEventsHandled(
webview_id,
vec![InputEventOutcome {
id: event_id,
result: Default::default(),
}],
),
);
return;
};
let event = ConstellationInputEvent {
hit_test_result,
pressed_mouse_buttons,
active_keyboard_modifiers,
event,
};
if !webview.forward_input_event(event, &self.pipelines, &self.browsing_contexts) {
self.constellation_to_embedder_proxy.send(
ConstellationToEmbedderMsg::InputEventsHandled(
webview_id,
vec![InputEventOutcome {
id: event_id,
result: Default::default(),
}],
),
);
}
}
#[servo_tracing::instrument(skip_all)]
fn handle_new_top_level_browsing_context(
&mut self,
url: ServoUrl,
NewWebViewDetails {
webview_id,
viewport_details,
user_content_manager_id,
}: NewWebViewDetails,
) {
let pipeline_id = PipelineId::new();
let browsing_context_id = BrowsingContextId::from(webview_id);
let load_data = LoadData::new_for_new_unrelated_webview(url);
let is_private = false;
let throttled = false;
self.webviews.insert(
webview_id,
ConstellationWebView::new(webview_id, browsing_context_id, user_content_manager_id),
);
let mut new_bc_group: BrowsingContextGroup = Default::default();
let new_bc_group_id = self.next_browsing_context_group_id();
new_bc_group
.top_level_browsing_context_set
.insert(webview_id);
self.browsing_context_group_set
.insert(new_bc_group_id, new_bc_group);
self.new_pipeline(
pipeline_id,
browsing_context_id,
webview_id,
None,
None,
viewport_details,
load_data,
is_private,
throttled,
TargetSnapshotParams::default(),
);
self.add_pending_change(SessionHistoryChange {
webview_id,
browsing_context_id,
new_pipeline_id: pipeline_id,
replace: None,
new_browsing_context_info: Some(NewBrowsingContextInfo {
parent_pipeline_id: None,
is_private,
inherited_secure_context: None,
throttled,
}),
viewport_details,
});
let painter_id = PainterId::from(webview_id);
self.system_font_service
.prefetch_font_keys_for_painter(painter_id);
}
#[servo_tracing::instrument(skip_all)]
fn handle_close_top_level_browsing_context(&mut self, webview_id: WebViewId) {
debug!("{webview_id}: Closing");
let browsing_context_id = BrowsingContextId::from(webview_id);
let browsing_context =
self.close_browsing_context(browsing_context_id, ExitPipelineMode::Normal);
self.webviews.remove(&webview_id);
self.constellation_to_embedder_proxy
.send(ConstellationToEmbedderMsg::WebViewClosed(webview_id));
let Some(browsing_context) = browsing_context else {
return warn!(
"fn handle_close_top_level_browsing_context {}: Closing twice",
browsing_context_id
);
};
let bc_group_id = browsing_context.bc_group_id;
let Some(bc_group) = self.browsing_context_group_set.get_mut(&bc_group_id) else {
warn!("{}: Browsing context group not found!", bc_group_id);
return;
};
if !bc_group.top_level_browsing_context_set.remove(&webview_id) {
warn!("{webview_id}: Top-level browsing context not found in {bc_group_id}",);
}
if bc_group.top_level_browsing_context_set.is_empty() {
self.browsing_context_group_set
.remove(&browsing_context.bc_group_id);
}
debug!("{webview_id}: Closed");
}
#[servo_tracing::instrument(skip_all)]
fn handle_iframe_size_msg(&mut self, iframe_sizes: Vec<IFrameSizeMsg>) {
for IFrameSizeMsg {
browsing_context_id,
size,
type_,
} in iframe_sizes
{
self.resize_browsing_context(size, type_, browsing_context_id);
}
}
#[servo_tracing::instrument(skip_all)]
fn handle_finish_javascript_evaluation(
&mut self,
evaluation_id: JavaScriptEvaluationId,
result: Result<JSValue, JavaScriptEvaluationError>,
) {
self.constellation_to_embedder_proxy.send(
ConstellationToEmbedderMsg::FinishJavaScriptEvaluation(evaluation_id, result),
);
}
#[servo_tracing::instrument(skip_all)]
fn handle_subframe_loaded(&mut self, pipeline_id: PipelineId) {
let browsing_context_id = match self.pipelines.get(&pipeline_id) {
Some(pipeline) => pipeline.browsing_context_id,
None => return warn!("{}: Subframe loaded after closure", pipeline_id),
};
let parent_pipeline_id = match self.browsing_contexts.get(&browsing_context_id) {
Some(browsing_context) => browsing_context.parent_pipeline_id,
None => {
return warn!(
"{}: Subframe loaded in closed {}",
pipeline_id, browsing_context_id,
);
},
};
let Some(parent_pipeline_id) = parent_pipeline_id else {
return warn!("{}: Subframe has no parent", pipeline_id);
};
let msg = ScriptThreadMessage::DispatchIFrameLoadEvent {
target: browsing_context_id,
parent: parent_pipeline_id,
child: pipeline_id,
};
let result = match self.pipelines.get(&parent_pipeline_id) {
Some(parent) => parent.event_loop.send(msg),
None => {
return warn!(
"{}: Parent pipeline browsing context loaded after closure",
parent_pipeline_id
);
},
};
if let Err(e) = result {
self.handle_send_error(parent_pipeline_id, e);
}
}
#[servo_tracing::instrument(skip_all)]
fn handle_script_loaded_url_in_iframe_msg(&mut self, load_info: IFrameLoadInfoWithData) {
let IFrameLoadInfo {
parent_pipeline_id,
browsing_context_id,
webview_id,
new_pipeline_id,
is_private,
mut history_handling,
target_snapshot_params,
..
} = load_info.info;
let old_pipeline = load_info
.old_pipeline_id
.and_then(|id| self.pipelines.get(&id));
if let Some(old_pipeline) = old_pipeline {
if !old_pipeline.completely_loaded {
history_handling = NavigationHistoryBehavior::Replace;
}
debug!(
"{:?}: Old pipeline is {}completely loaded",
load_info.old_pipeline_id,
if old_pipeline.completely_loaded {
""
} else {
"not "
}
);
}
let is_parent_private = {
let parent_browsing_context_id = match self.pipelines.get(&parent_pipeline_id) {
Some(pipeline) => pipeline.browsing_context_id,
None => {
return warn!(
"{parent_pipeline_id}: Script loaded url in iframe \
{browsing_context_id} in closed parent pipeline",
);
},
};
let Some(ctx) = self.browsing_contexts.get(&parent_browsing_context_id) else {
return warn!(
"{parent_browsing_context_id}: Script loaded url in \
iframe {browsing_context_id} in closed parent browsing context",
);
};
ctx.is_private
};
let is_private = is_private || is_parent_private;
let Some(browsing_context) = self.browsing_contexts.get(&browsing_context_id) else {
return warn!(
"{browsing_context_id}: Script loaded url in iframe with closed browsing context",
);
};
let replace = if history_handling == NavigationHistoryBehavior::Replace {
Some(NeedsToReload::No(browsing_context.pipeline_id))
} else {
None
};
let browsing_context_size = browsing_context.viewport_details;
let browsing_context_throttled = browsing_context.throttled;
#[cfg(debug_assertions)]
if !(browsing_context_size == load_info.viewport_details) {
log::warn!(
"debug assertion failed! browsing_context_size == load_info.viewport_details.initial_viewport"
);
}
self.new_pipeline(
new_pipeline_id,
browsing_context_id,
webview_id,
Some(parent_pipeline_id),
None,
browsing_context_size,
load_info.load_data,
is_private,
browsing_context_throttled,
target_snapshot_params,
);
self.add_pending_change(SessionHistoryChange {
webview_id,
browsing_context_id,
new_pipeline_id,
replace,
new_browsing_context_info: None,
viewport_details: load_info.viewport_details,
});
}
#[servo_tracing::instrument(skip_all)]
fn handle_script_new_iframe(&mut self, load_info: IFrameLoadInfoWithData) {
let IFrameLoadInfo {
parent_pipeline_id,
new_pipeline_id,
browsing_context_id,
webview_id,
is_private,
..
} = load_info.info;
let (script_sender, parent_browsing_context_id) =
match self.pipelines.get(&parent_pipeline_id) {
Some(pipeline) => (pipeline.event_loop.clone(), pipeline.browsing_context_id),
None => {
return warn!(
"{}: Script loaded url in closed iframe pipeline",
parent_pipeline_id
);
},
};
let (is_parent_private, is_parent_throttled, is_parent_secure) =
match self.browsing_contexts.get(&parent_browsing_context_id) {
Some(ctx) => (ctx.is_private, ctx.throttled, ctx.inherited_secure_context),
None => {
return warn!(
"{}: New iframe {} loaded in closed parent browsing context",
parent_browsing_context_id, browsing_context_id,
);
},
};
let is_private = is_private || is_parent_private;
let pipeline = Pipeline::new_already_spawned(
new_pipeline_id,
browsing_context_id,
webview_id,
None,
script_sender,
self.paint_proxy.clone(),
is_parent_throttled,
load_info.load_data,
);
assert!(!self.pipelines.contains_key(&new_pipeline_id));
self.pipelines.insert(new_pipeline_id, pipeline);
self.add_pending_change(SessionHistoryChange {
webview_id,
browsing_context_id,
new_pipeline_id,
replace: None,
new_browsing_context_info: Some(NewBrowsingContextInfo {
parent_pipeline_id: Some(parent_pipeline_id),
is_private,
inherited_secure_context: is_parent_secure,
throttled: is_parent_throttled,
}),
viewport_details: load_info.viewport_details,
});
}
#[servo_tracing::instrument(skip_all)]
fn handle_script_new_auxiliary(&mut self, load_info: AuxiliaryWebViewCreationRequest) {
let AuxiliaryWebViewCreationRequest {
load_data,
opener_webview_id,
opener_pipeline_id,
response_sender,
} = load_info;
let Some((webview_id_sender, webview_id_receiver)) = generic_channel::channel() else {
warn!("Failed to create channel");
let _ = response_sender.send(None);
return;
};
self.constellation_to_embedder_proxy
.send(ConstellationToEmbedderMsg::AllowOpeningWebView(
opener_webview_id,
webview_id_sender,
));
let NewWebViewDetails {
webview_id: new_webview_id,
viewport_details,
user_content_manager_id,
} = match webview_id_receiver.recv() {
Ok(Some(new_webview_details)) => new_webview_details,
Ok(None) | Err(_) => {
let _ = response_sender.send(None);
return;
},
};
let new_browsing_context_id = BrowsingContextId::from(new_webview_id);
let (script_sender, opener_browsing_context_id) =
match self.pipelines.get(&opener_pipeline_id) {
Some(pipeline) => (pipeline.event_loop.clone(), pipeline.browsing_context_id),
None => {
return warn!(
"{}: Auxiliary loaded url in closed iframe pipeline",
opener_pipeline_id
);
},
};
let (is_opener_private, is_opener_throttled, is_opener_secure) =
match self.browsing_contexts.get(&opener_browsing_context_id) {
Some(ctx) => (ctx.is_private, ctx.throttled, ctx.inherited_secure_context),
None => {
return warn!(
"{}: New auxiliary {} loaded in closed opener browsing context",
opener_browsing_context_id, new_browsing_context_id,
);
},
};
let new_pipeline_id = PipelineId::new();
let pipeline = Pipeline::new_already_spawned(
new_pipeline_id,
new_browsing_context_id,
new_webview_id,
Some(opener_browsing_context_id),
script_sender,
self.paint_proxy.clone(),
is_opener_throttled,
load_data,
);
let _ = response_sender.send(Some(AuxiliaryWebViewCreationResponse {
new_webview_id,
new_pipeline_id,
user_content_manager_id,
}));
assert!(!self.pipelines.contains_key(&new_pipeline_id));
self.pipelines.insert(new_pipeline_id, pipeline);
self.webviews.insert(
new_webview_id,
ConstellationWebView::new(
new_webview_id,
new_browsing_context_id,
user_content_manager_id,
),
);
let Some(opener) = self.browsing_contexts.get(&opener_browsing_context_id) else {
return warn!("Trying to append an unknown auxiliary to a browsing context group");
};
let Some(bc_group) = self.browsing_context_group_set.get_mut(&opener.bc_group_id) else {
return warn!("Trying to add a top-level to an unknown group.");
};
bc_group
.top_level_browsing_context_set
.insert(new_webview_id);
self.add_pending_change(SessionHistoryChange {
webview_id: new_webview_id,
browsing_context_id: new_browsing_context_id,
new_pipeline_id,
replace: None,
new_browsing_context_info: Some(NewBrowsingContextInfo {
parent_pipeline_id: None,
is_private: is_opener_private,
inherited_secure_context: is_opener_secure,
throttled: is_opener_throttled,
}),
viewport_details,
});
}
#[servo_tracing::instrument(skip_all)]
fn handle_refresh_cursor(&self, pipeline_id: PipelineId) {
let Some(pipeline) = self.pipelines.get(&pipeline_id) else {
return;
};
if let Err(error) = pipeline
.event_loop
.send(ScriptThreadMessage::RefreshCursor(pipeline_id))
{
warn!("Could not send RefreshCursor message to pipeline: {error:?}");
}
}
#[servo_tracing::instrument(skip_all)]
fn handle_change_running_animations_state(
&mut self,
pipeline_id: PipelineId,
animation_state: AnimationState,
) {
if let Some(pipeline) = self.pipelines.get_mut(&pipeline_id) {
if pipeline.animation_state != animation_state {
pipeline.animation_state = animation_state;
self.paint_proxy
.send(PaintMessage::ChangeRunningAnimationsState(
pipeline.webview_id,
pipeline_id,
animation_state,
))
}
}
}
#[servo_tracing::instrument(skip_all)]
fn handle_tick_animation(&mut self, webview_ids: Vec<WebViewId>) {
let mut animating_event_loops = HashSet::new();
for webview_id in webview_ids.iter() {
for browsing_context in self.fully_active_browsing_contexts_iter(*webview_id) {
let Some(pipeline) = self.pipelines.get(&browsing_context.pipeline_id) else {
continue;
};
let event_loop = &pipeline.event_loop;
if !animating_event_loops.contains(&event_loop.id()) {
let _ = event_loop
.send(ScriptThreadMessage::TickAllAnimations(webview_ids.clone()));
animating_event_loops.insert(event_loop.id());
}
}
}
}
#[servo_tracing::instrument(skip_all)]
fn handle_no_longer_waiting_on_asynchronous_image_updates(
&mut self,
pipeline_ids: Vec<PipelineId>,
) {
for pipeline_id in pipeline_ids.into_iter() {
if let Some(pipeline) = self.pipelines.get(&pipeline_id) {
let _ = pipeline.event_loop.send(
ScriptThreadMessage::NoLongerWaitingOnAsychronousImageUpdates(pipeline_id),
);
}
}
}
#[servo_tracing::instrument(skip_all)]
fn schedule_navigation(
&mut self,
webview_id: WebViewId,
source_id: PipelineId,
load_data: LoadData,
history_handling: NavigationHistoryBehavior,
target_snapshot_params: TargetSnapshotParams,
) {
match self.pending_approval_navigations.entry(source_id) {
Entry::Occupied(_) => {
return warn!(
"{}: Tried to schedule a navigation while one is already pending",
source_id
);
},
Entry::Vacant(entry) => {
let _ = entry.insert(PendingApprovalNavigation {
load_data: load_data.clone(),
history_behaviour: history_handling,
target_snapshot_params,
});
},
};
self.constellation_to_embedder_proxy.send(
ConstellationToEmbedderMsg::AllowNavigationRequest(
webview_id,
source_id,
load_data.url,
),
);
}
#[servo_tracing::instrument(skip_all)]
fn load_url(
&mut self,
webview_id: WebViewId,
source_id: PipelineId,
load_data: LoadData,
history_handling: NavigationHistoryBehavior,
target_snapshot_params: TargetSnapshotParams,
) -> Option<PipelineId> {
debug!(
"{}: Loading ({}replacing): {}",
source_id,
match history_handling {
NavigationHistoryBehavior::Push => "not ",
NavigationHistoryBehavior::Replace => "",
NavigationHistoryBehavior::Auto => "unsure if ",
},
load_data.url,
);
let (browsing_context_id, opener) = match self.pipelines.get(&source_id) {
Some(pipeline) => (pipeline.browsing_context_id, pipeline.opener),
None => {
warn!("{}: Loaded after closure", source_id);
return None;
},
};
let (viewport_details, pipeline_id, parent_pipeline_id, is_private, is_throttled) =
match self.browsing_contexts.get(&browsing_context_id) {
Some(ctx) => (
ctx.viewport_details,
ctx.pipeline_id,
ctx.parent_pipeline_id,
ctx.is_private,
ctx.throttled,
),
None => {
warn!(
"{}: Loaded url in closed {}",
source_id, browsing_context_id,
);
return None;
},
};
if let Some(ref chan) = self.devtools_sender {
let state = NavigationState::Start(load_data.url.clone());
let _ = chan.send(DevtoolsControlMsg::FromScript(
ScriptToDevtoolsControlMsg::Navigate(browsing_context_id, state),
));
}
match parent_pipeline_id {
Some(parent_pipeline_id) => {
let msg = ScriptThreadMessage::NavigateIframe(
parent_pipeline_id,
browsing_context_id,
load_data,
history_handling,
target_snapshot_params,
);
let result = match self.pipelines.get(&parent_pipeline_id) {
Some(parent_pipeline) => parent_pipeline.event_loop.send(msg),
None => {
warn!("{}: Child loaded after closure", parent_pipeline_id);
return None;
},
};
if let Err(e) = result {
self.handle_send_error(parent_pipeline_id, e);
} else if let Some((sender, id)) = &self.webdriver_load_status_sender {
if source_id == *id {
let _ = sender.send(WebDriverLoadStatus::NavigationStop);
}
}
None
},
None => {
for change in &self.pending_changes {
if change.browsing_context_id == browsing_context_id {
return None;
}
}
if self.get_activity(source_id) == DocumentActivity::Inactive {
return None;
}
let replace = if history_handling == NavigationHistoryBehavior::Replace {
Some(NeedsToReload::No(pipeline_id))
} else {
None
};
let new_pipeline_id = PipelineId::new();
self.new_pipeline(
new_pipeline_id,
browsing_context_id,
webview_id,
None,
opener,
viewport_details,
load_data,
is_private,
is_throttled,
target_snapshot_params,
);
self.add_pending_change(SessionHistoryChange {
webview_id,
browsing_context_id,
new_pipeline_id,
replace,
new_browsing_context_info: None,
viewport_details,
});
self.paint_proxy
.send(PaintMessage::EnableLCPCalculation(webview_id));
Some(new_pipeline_id)
},
}
}
#[servo_tracing::instrument(skip_all)]
fn handle_abort_load_url_msg(&mut self, new_pipeline_id: PipelineId) {
let pending_index = self
.pending_changes
.iter()
.rposition(|change| change.new_pipeline_id == new_pipeline_id);
if let Some(pending_index) = pending_index {
self.pending_changes.remove(pending_index);
self.close_pipeline(
new_pipeline_id,
DiscardBrowsingContext::No,
ExitPipelineMode::Normal,
);
}
self.send_screenshot_readiness_requests_to_pipelines();
}
#[servo_tracing::instrument(skip_all)]
fn handle_load_complete_msg(&mut self, webview_id: WebViewId, pipeline_id: PipelineId) {
if let Some(pipeline) = self.pipelines.get_mut(&pipeline_id) {
debug!("{}: Marking as loaded", pipeline_id);
pipeline.completely_loaded = true;
}
let pipeline_is_top_level_pipeline = self
.browsing_contexts
.get(&BrowsingContextId::from(webview_id))
.is_some_and(|ctx| ctx.pipeline_id == pipeline_id);
if !pipeline_is_top_level_pipeline {
self.handle_subframe_loaded(pipeline_id);
}
}
#[servo_tracing::instrument(skip_all)]
fn handle_navigated_to_fragment(
&mut self,
pipeline_id: PipelineId,
new_url: ServoUrl,
history_handling: NavigationHistoryBehavior,
) {
let (webview_id, old_url) = match self.pipelines.get_mut(&pipeline_id) {
Some(pipeline) => {
let old_url = replace(&mut pipeline.url, new_url.clone());
(pipeline.webview_id, old_url)
},
None => {
return warn!("{}: Navigated to fragment after closure", pipeline_id);
},
};
let Some(webview) = self.webviews.get_mut(&webview_id) else {
return warn!("Ignoring navigation in non-existent WebView ({webview_id:?}).");
};
match history_handling {
NavigationHistoryBehavior::Replace => {},
_ => {
let diff = SessionHistoryDiff::Hash {
pipeline_reloader: NeedsToReload::No(pipeline_id),
new_url,
old_url,
};
webview.session_history.push_diff(diff);
self.notify_history_changed(webview_id);
},
}
}
#[servo_tracing::instrument(skip_all)]
fn handle_traverse_history_msg(
&mut self,
webview_id: WebViewId,
direction: TraversalDirection,
) {
let mut browsing_context_changes = FxHashMap::<BrowsingContextId, NeedsToReload>::default();
let mut pipeline_changes =
FxHashMap::<PipelineId, (Option<HistoryStateId>, ServoUrl)>::default();
let mut url_to_load = FxHashMap::<PipelineId, ServoUrl>::default();
{
let Some(webview) = self.webviews.get_mut(&webview_id) else {
return warn!(
"Ignoring history traversal in non-existent WebView ({webview_id:?})."
);
};
match direction {
TraversalDirection::Forward(forward) => {
let future_length = webview.session_history.future.len();
if future_length < forward {
return warn!("Cannot traverse that far into the future.");
}
for diff in webview
.session_history
.future
.drain(future_length - forward..)
.rev()
{
match diff {
SessionHistoryDiff::BrowsingContext {
browsing_context_id,
ref new_reloader,
..
} => {
browsing_context_changes
.insert(browsing_context_id, new_reloader.clone());
},
SessionHistoryDiff::Pipeline {
ref pipeline_reloader,
new_history_state_id,
ref new_url,
..
} => match *pipeline_reloader {
NeedsToReload::No(pipeline_id) => {
pipeline_changes.insert(
pipeline_id,
(Some(new_history_state_id), new_url.clone()),
);
},
NeedsToReload::Yes(pipeline_id, ..) => {
url_to_load.insert(pipeline_id, new_url.clone());
},
},
SessionHistoryDiff::Hash {
ref pipeline_reloader,
ref new_url,
..
} => match *pipeline_reloader {
NeedsToReload::No(pipeline_id) => {
let state = pipeline_changes
.get(&pipeline_id)
.and_then(|change| change.0);
pipeline_changes.insert(pipeline_id, (state, new_url.clone()));
},
NeedsToReload::Yes(pipeline_id, ..) => {
url_to_load.insert(pipeline_id, new_url.clone());
},
},
}
webview.session_history.past.push(diff);
}
},
TraversalDirection::Back(back) => {
let past_length = webview.session_history.past.len();
if past_length < back {
return warn!("Cannot traverse that far into the past.");
}
for diff in webview
.session_history
.past
.drain(past_length - back..)
.rev()
{
match diff {
SessionHistoryDiff::BrowsingContext {
browsing_context_id,
ref old_reloader,
..
} => {
browsing_context_changes
.insert(browsing_context_id, old_reloader.clone());
},
SessionHistoryDiff::Pipeline {
ref pipeline_reloader,
old_history_state_id,
ref old_url,
..
} => match *pipeline_reloader {
NeedsToReload::No(pipeline_id) => {
pipeline_changes.insert(
pipeline_id,
(old_history_state_id, old_url.clone()),
);
},
NeedsToReload::Yes(pipeline_id, ..) => {
url_to_load.insert(pipeline_id, old_url.clone());
},
},
SessionHistoryDiff::Hash {
ref pipeline_reloader,
ref old_url,
..
} => match *pipeline_reloader {
NeedsToReload::No(pipeline_id) => {
let state = pipeline_changes
.get(&pipeline_id)
.and_then(|change| change.0);
pipeline_changes.insert(pipeline_id, (state, old_url.clone()));
},
NeedsToReload::Yes(pipeline_id, ..) => {
url_to_load.insert(pipeline_id, old_url.clone());
},
},
}
webview.session_history.future.push(diff);
}
},
}
}
for (browsing_context_id, mut pipeline_reloader) in browsing_context_changes.drain() {
if let NeedsToReload::Yes(pipeline_id, ref mut load_data) = pipeline_reloader {
if let Some(url) = url_to_load.get(&pipeline_id) {
load_data.url = url.clone();
}
}
self.update_browsing_context(browsing_context_id, pipeline_reloader);
}
for (pipeline_id, (history_state_id, url)) in pipeline_changes.drain() {
self.update_pipeline(pipeline_id, history_state_id, url);
}
self.notify_history_changed(webview_id);
self.trim_history(webview_id);
self.set_frame_tree_for_webview(webview_id);
}
#[servo_tracing::instrument(skip_all)]
fn update_browsing_context(
&mut self,
browsing_context_id: BrowsingContextId,
new_reloader: NeedsToReload,
) {
let new_pipeline_id = match new_reloader {
NeedsToReload::No(pipeline_id) => pipeline_id,
NeedsToReload::Yes(pipeline_id, load_data) => {
debug!(
"{}: Reloading document {}",
browsing_context_id, pipeline_id,
);
let (
webview_id,
old_pipeline_id,
parent_pipeline_id,
viewport_details,
is_private,
throttled,
) = match self.browsing_contexts.get(&browsing_context_id) {
Some(ctx) => (
ctx.webview_id,
ctx.pipeline_id,
ctx.parent_pipeline_id,
ctx.viewport_details,
ctx.is_private,
ctx.throttled,
),
None => return warn!("No browsing context to traverse!"),
};
let opener = match self.pipelines.get(&old_pipeline_id) {
Some(pipeline) => pipeline.opener,
None => None,
};
let new_pipeline_id = PipelineId::new();
self.new_pipeline(
new_pipeline_id,
browsing_context_id,
webview_id,
parent_pipeline_id,
opener,
viewport_details,
load_data.clone(),
is_private,
throttled,
TargetSnapshotParams::default(),
);
self.add_pending_change(SessionHistoryChange {
webview_id,
browsing_context_id,
new_pipeline_id,
replace: Some(NeedsToReload::Yes(pipeline_id, load_data)),
new_browsing_context_info: None,
viewport_details,
});
return;
},
};
let (old_pipeline_id, parent_pipeline_id, webview_id) =
match self.browsing_contexts.get_mut(&browsing_context_id) {
Some(browsing_context) => {
let old_pipeline_id = browsing_context.pipeline_id;
browsing_context.update_current_entry(new_pipeline_id);
(
old_pipeline_id,
browsing_context.parent_pipeline_id,
browsing_context.webview_id,
)
},
None => {
return warn!("{}: Closed during traversal", browsing_context_id);
},
};
self.unload_document(old_pipeline_id);
if let Some(new_pipeline) = self.pipelines.get(&new_pipeline_id) {
if let Some(ref chan) = self.devtools_sender {
let state = NavigationState::Start(new_pipeline.url.clone());
let _ = chan.send(DevtoolsControlMsg::FromScript(
ScriptToDevtoolsControlMsg::Navigate(browsing_context_id, state),
));
let page_info = DevtoolsPageInfo {
title: new_pipeline.title.clone(),
url: new_pipeline.url.clone(),
is_top_level_global: webview_id == browsing_context_id,
is_service_worker: false,
};
let state = NavigationState::Stop(new_pipeline.id, page_info);
let _ = chan.send(DevtoolsControlMsg::FromScript(
ScriptToDevtoolsControlMsg::Navigate(browsing_context_id, state),
));
}
new_pipeline.set_throttled(false);
self.notify_focus_state(new_pipeline_id);
}
self.update_activity(old_pipeline_id);
self.update_activity(new_pipeline_id);
if let Some(parent_pipeline_id) = parent_pipeline_id {
let msg = ScriptThreadMessage::UpdatePipelineId(
parent_pipeline_id,
browsing_context_id,
webview_id,
new_pipeline_id,
UpdatePipelineIdReason::Traversal,
);
self.send_message_to_pipeline(parent_pipeline_id, msg, "Child traversed after closure");
}
}
#[servo_tracing::instrument(skip_all)]
fn update_pipeline(
&mut self,
pipeline_id: PipelineId,
history_state_id: Option<HistoryStateId>,
url: ServoUrl,
) {
let msg = ScriptThreadMessage::UpdateHistoryState(pipeline_id, history_state_id, url);
self.send_message_to_pipeline(pipeline_id, msg, "History state updated after closure");
}
#[servo_tracing::instrument(skip_all)]
fn handle_joint_session_history_length(
&self,
webview_id: WebViewId,
response_sender: GenericSender<u32>,
) {
let length = self
.webviews
.get(&webview_id)
.map(|webview| webview.session_history.history_length())
.unwrap_or(1);
let _ = response_sender.send(length as u32);
}
#[servo_tracing::instrument(skip_all)]
fn handle_push_history_state_msg(
&mut self,
pipeline_id: PipelineId,
history_state_id: HistoryStateId,
url: ServoUrl,
) {
let (webview_id, old_state_id, old_url) = match self.pipelines.get_mut(&pipeline_id) {
Some(pipeline) => {
let old_history_state_id = pipeline.history_state_id;
let old_url = replace(&mut pipeline.url, url.clone());
pipeline.history_state_id = Some(history_state_id);
pipeline.history_states.insert(history_state_id);
(pipeline.webview_id, old_history_state_id, old_url)
},
None => {
return warn!(
"{}: Push history state {} for closed pipeline",
pipeline_id, history_state_id,
);
},
};
let Some(webview) = self.webviews.get_mut(&webview_id) else {
return warn!("Ignoring history change in non-existent WebView ({webview_id:?}).");
};
let diff = SessionHistoryDiff::Pipeline {
pipeline_reloader: NeedsToReload::No(pipeline_id),
new_history_state_id: history_state_id,
new_url: url,
old_history_state_id: old_state_id,
old_url,
};
webview.session_history.push_diff(diff);
self.notify_history_changed(webview_id);
}
#[servo_tracing::instrument(skip_all)]
fn handle_replace_history_state_msg(
&mut self,
pipeline_id: PipelineId,
history_state_id: HistoryStateId,
url: ServoUrl,
) {
let webview_id = match self.pipelines.get_mut(&pipeline_id) {
Some(pipeline) => {
pipeline.history_state_id = Some(history_state_id);
pipeline.url = url.clone();
pipeline.webview_id
},
None => {
return warn!(
"{}: Replace history state {} for closed pipeline",
history_state_id, pipeline_id
);
},
};
let Some(webview) = self.webviews.get_mut(&webview_id) else {
return warn!("Ignoring history change in non-existent WebView ({webview_id:?}).");
};
webview
.session_history
.replace_history_state(pipeline_id, history_state_id, url);
self.notify_history_changed(webview_id);
}
#[servo_tracing::instrument(skip_all)]
fn handle_reload_msg(&mut self, webview_id: WebViewId) {
let browsing_context_id = BrowsingContextId::from(webview_id);
let pipeline_id = match self.browsing_contexts.get(&browsing_context_id) {
Some(browsing_context) => browsing_context.pipeline_id,
None => {
return warn!("{}: Got reload event after closure", browsing_context_id);
},
};
self.send_message_to_pipeline(
pipeline_id,
ScriptThreadMessage::Reload(pipeline_id),
"Got reload event after closure",
);
self.paint_proxy
.send(PaintMessage::EnableLCPCalculation(webview_id));
}
#[servo_tracing::instrument(skip_all)]
fn handle_post_message_msg(
&mut self,
browsing_context_id: BrowsingContextId,
source_pipeline: PipelineId,
origin: Option<ImmutableOrigin>,
source_origin: ImmutableOrigin,
data: StructuredSerializedData,
) {
let pipeline_id = match self.browsing_contexts.get(&browsing_context_id) {
None => {
return warn!(
"{}: PostMessage to closed browsing context",
browsing_context_id
);
},
Some(browsing_context) => browsing_context.pipeline_id,
};
let source_webview = match self.pipelines.get(&source_pipeline) {
Some(pipeline) => pipeline.webview_id,
None => return warn!("{}: PostMessage from closed pipeline", source_pipeline),
};
let browsing_context_for_pipeline = |pipeline_id| {
self.pipelines
.get(&pipeline_id)
.and_then(|pipeline| self.browsing_contexts.get(&pipeline.browsing_context_id))
};
let mut maybe_browsing_context = browsing_context_for_pipeline(source_pipeline);
if maybe_browsing_context.is_none() {
return warn!("{source_pipeline}: PostMessage from pipeline with closed parent");
}
let mut source_with_ancestry = vec![];
while let Some(browsing_context) = maybe_browsing_context {
source_with_ancestry.push(browsing_context.id);
maybe_browsing_context = browsing_context
.parent_pipeline_id
.and_then(browsing_context_for_pipeline);
}
let msg = ScriptThreadMessage::PostMessage {
target: pipeline_id,
source_webview,
source_with_ancestry,
target_origin: origin,
source_origin,
data: Box::new(data),
};
self.send_message_to_pipeline(pipeline_id, msg, "PostMessage to closed pipeline");
}
#[servo_tracing::instrument(skip_all)]
fn handle_focus_ancestor_browsing_contexts_for_focusing_steps(
&mut self,
pipeline_id: PipelineId,
focused_child_browsing_context_id: Option<BrowsingContextId>,
sequence: FocusSequenceNumber,
) {
let (browsing_context_id, webview_id) = match self.pipelines.get_mut(&pipeline_id) {
Some(pipeline) => {
pipeline.focus_sequence = sequence;
(pipeline.browsing_context_id, pipeline.webview_id)
},
None => return warn!("{}: Focus parent after closure", pipeline_id),
};
if self.get_activity(pipeline_id) != DocumentActivity::FullyActive {
debug!(
"Ignoring the focus request because pipeline {} is not \
fully active",
pipeline_id
);
return;
}
self.constellation_to_embedder_proxy
.send(ConstellationToEmbedderMsg::WebViewFocused(webview_id, true));
let focused_browsing_context_id =
focused_child_browsing_context_id.unwrap_or(browsing_context_id);
self.focus_browsing_context(Some(pipeline_id), focused_browsing_context_id);
}
fn handle_focus_remote_browsing_context(
&mut self,
target: BrowsingContextId,
operation: RemoteFocusOperation,
) {
let Some(browsing_context) = self.browsing_contexts.get(&target) else {
return warn!("{target:?} not found for focus message");
};
let pipeline_id = browsing_context.pipeline_id;
let Some(pipeline) = self.pipelines.get(&pipeline_id) else {
return warn!("{pipeline_id:?} not found for focus message");
};
if let Err(error) = pipeline
.event_loop
.send(ScriptThreadMessage::FocusDocument(pipeline_id, operation))
{
self.handle_send_error(pipeline_id, error);
}
}
#[servo_tracing::instrument(skip_all)]
fn focus_browsing_context(
&mut self,
initiator_pipeline_id: Option<PipelineId>,
focused_browsing_context_id: BrowsingContextId,
) {
let webview_id = match self.browsing_contexts.get(&focused_browsing_context_id) {
Some(browsing_context) => browsing_context.webview_id,
None => return warn!("Browsing context {} not found", focused_browsing_context_id),
};
let old_focused_browsing_context_id = match self.webviews.get_mut(&webview_id) {
Some(browser) => replace(
&mut browser.focused_browsing_context_id,
focused_browsing_context_id,
),
None => {
return warn!(
"{}: Browsing context for focus msg does not exist",
webview_id
);
},
};
let mut old_focus_chain_pipelines: Vec<&Pipeline> = self
.ancestor_or_self_pipelines_of_browsing_context_iter(old_focused_browsing_context_id)
.collect();
let mut new_focus_chain_pipelines: Vec<&Pipeline> = self
.ancestor_or_self_pipelines_of_browsing_context_iter(focused_browsing_context_id)
.collect();
debug!(
"old_focus_chain_pipelines = {:?}",
old_focus_chain_pipelines
.iter()
.map(|p| p.id.to_string())
.collect::<Vec<_>>()
);
debug!(
"new_focus_chain_pipelines = {:?}",
new_focus_chain_pipelines
.iter()
.map(|p| p.id.to_string())
.collect::<Vec<_>>()
);
match (
&old_focus_chain_pipelines[..],
&new_focus_chain_pipelines[..],
) {
([.., p1], [.., p2]) if p1.id == p2.id => {},
_ => {
warn!("Aborting the focus operation - focus chain sanity check failed");
return;
},
}
let mut first_common_pipeline_in_chain = None;
while let ([.., p1], [.., p2]) = (
&old_focus_chain_pipelines[..],
&new_focus_chain_pipelines[..],
) {
if p1.id != p2.id {
break;
}
old_focus_chain_pipelines.pop();
first_common_pipeline_in_chain = new_focus_chain_pipelines.pop();
}
let mut send_errors = Vec::new();
for &pipeline in old_focus_chain_pipelines.iter() {
if Some(pipeline.id) != initiator_pipeline_id {
let msg = ScriptThreadMessage::UnfocusDocumentAsPartOfFocusingSteps(
pipeline.id,
pipeline.focus_sequence,
);
trace!("Sending {:?} to {}", msg, pipeline.id);
if let Err(e) = pipeline.event_loop.send(msg) {
send_errors.push((pipeline.id, e));
}
} else {
trace!(
"Not notifying {} - it's the initiator of this focus operation",
pipeline.id
);
}
}
let mut child_browsing_context_id = None;
for &pipeline in new_focus_chain_pipelines.iter().rev() {
if Some(pipeline.id) != initiator_pipeline_id {
if let Err(error) = pipeline.event_loop.send(
ScriptThreadMessage::FocusDocumentAsPartOfFocusingSteps(
pipeline.id,
pipeline.focus_sequence,
child_browsing_context_id,
),
) {
send_errors.push((pipeline.id, error));
}
}
child_browsing_context_id = Some(pipeline.browsing_context_id);
}
if let Some(pipeline) = first_common_pipeline_in_chain {
if Some(pipeline.id) != initiator_pipeline_id {
if let Err(error) = pipeline.event_loop.send(
ScriptThreadMessage::FocusDocumentAsPartOfFocusingSteps(
pipeline.id,
pipeline.focus_sequence,
child_browsing_context_id,
),
) {
send_errors.push((pipeline.id, error));
}
}
}
for (pipeline_id, error) in send_errors {
self.handle_send_error(pipeline_id, error);
}
}
#[servo_tracing::instrument(skip_all)]
fn handle_remove_iframe_msg(
&mut self,
browsing_context_id: BrowsingContextId,
) -> Vec<PipelineId> {
let result = self
.all_descendant_browsing_contexts_iter(browsing_context_id)
.flat_map(|browsing_context| browsing_context.pipelines.iter().cloned())
.collect();
self.close_browsing_context(browsing_context_id, ExitPipelineMode::Normal);
result
}
#[servo_tracing::instrument(skip_all)]
fn handle_set_throttled_complete(&mut self, pipeline_id: PipelineId, throttled: bool) {
let Some(pipeline) = self.pipelines.get(&pipeline_id) else {
return warn!("{pipeline_id}: Visibility change for closed browsing context",);
};
let Some(browsing_context) = self.browsing_contexts.get(&pipeline.browsing_context_id)
else {
return warn!("{}: Visibility change for closed pipeline", pipeline_id);
};
let Some(parent_pipeline_id) = browsing_context.parent_pipeline_id else {
return;
};
let msg = ScriptThreadMessage::SetThrottledInContainingIframe(
pipeline.webview_id,
parent_pipeline_id,
browsing_context.id,
throttled,
);
self.send_message_to_pipeline(parent_pipeline_id, msg, "Parent pipeline closed");
}
#[servo_tracing::instrument(skip_all)]
fn handle_create_canvas_paint_thread_msg(
&mut self,
size: UntypedSize2D<u64>,
response_sender: GenericSender<Option<(GenericSender<CanvasMsg>, CanvasId)>>,
) {
let (canvas_data_sender, canvas_data_receiver) = unbounded();
let (canvas_sender, canvas_ipc_sender) = self
.canvas
.get_or_init(|| self.create_canvas_paint_thread());
let response = if let Err(e) = canvas_sender.send(ConstellationCanvasMsg::Create {
sender: canvas_data_sender,
size,
}) {
warn!("Create canvas paint thread failed ({})", e);
None
} else {
match canvas_data_receiver.recv() {
Ok(Some(canvas_id)) => Some((canvas_ipc_sender.clone(), canvas_id)),
Ok(None) => None,
Err(e) => {
warn!("Create canvas paint thread id response failed ({})", e);
None
},
}
};
if let Err(e) = response_sender.send(response) {
warn!("Create canvas paint thread response failed ({})", e);
}
}
#[servo_tracing::instrument(skip_all)]
fn handle_webdriver_msg(&mut self, msg: WebDriverCommandMsg) {
match msg {
WebDriverCommandMsg::IsBrowsingContextOpen(browsing_context_id, response_sender) => {
let is_open = self.browsing_contexts.contains_key(&browsing_context_id);
let _ = response_sender.send(is_open);
},
WebDriverCommandMsg::FocusBrowsingContext(browsing_context_id) => {
self.handle_focus_remote_browsing_context(
browsing_context_id,
RemoteFocusOperation::Viewport,
);
},
WebDriverCommandMsg::ScriptCommand(browsing_context_id, cmd) => {
let pipeline_id = if let Some(browsing_context) =
self.browsing_contexts.get(&browsing_context_id)
{
browsing_context.pipeline_id
} else {
return warn!("{}: Browsing context is not ready", browsing_context_id);
};
match &cmd {
WebDriverScriptCommand::AddLoadStatusSender(_, sender) => {
self.webdriver_load_status_sender = Some((sender.clone(), pipeline_id));
},
WebDriverScriptCommand::RemoveLoadStatusSender(_) => {
self.webdriver_load_status_sender = None;
},
_ => {},
};
let control_msg = ScriptThreadMessage::WebDriverScriptCommand(pipeline_id, cmd);
self.send_message_to_pipeline(
pipeline_id,
control_msg,
"ScriptCommand after closure",
);
},
WebDriverCommandMsg::CloseWebView(..) |
WebDriverCommandMsg::NewWindow(..) |
WebDriverCommandMsg::FocusWebView(..) |
WebDriverCommandMsg::IsWebViewOpen(..) |
WebDriverCommandMsg::GetWindowRect(..) |
WebDriverCommandMsg::GetViewportSize(..) |
WebDriverCommandMsg::SetWindowRect(..) |
WebDriverCommandMsg::MaximizeWebView(..) |
WebDriverCommandMsg::LoadUrl(..) |
WebDriverCommandMsg::Refresh(..) |
WebDriverCommandMsg::InputEvent(..) |
WebDriverCommandMsg::TakeScreenshot(..) => {
unreachable!("This command should be send directly to the embedder.");
},
_ => {
warn!("Unhandled WebDriver command: {:?}", msg);
},
}
}
#[servo_tracing::instrument(skip_all)]
fn set_webview_throttled(&mut self, webview_id: WebViewId, throttled: bool) {
let browsing_context_id = BrowsingContextId::from(webview_id);
let pipeline_id = match self.browsing_contexts.get(&browsing_context_id) {
Some(browsing_context) => browsing_context.pipeline_id,
None => {
return warn!("{browsing_context_id}: Tried to SetWebViewThrottled after closure");
},
};
match self.pipelines.get(&pipeline_id) {
None => warn!("{pipeline_id}: Tried to SetWebViewThrottled after closure"),
Some(pipeline) => pipeline.set_throttled(throttled),
}
}
#[servo_tracing::instrument(skip_all)]
fn notify_history_changed(&self, webview_id: WebViewId) {
let session_history = match self.webviews.get(&webview_id) {
Some(webview) => &webview.session_history,
None => {
return warn!(
"{}: Session history does not exist for browsing context",
webview_id
);
},
};
let browsing_context_id = BrowsingContextId::from(webview_id);
let Some(browsing_context) = self.browsing_contexts.get(&browsing_context_id) else {
return warn!("notify_history_changed error after top-level browsing context closed.");
};
let current_url = match self.pipelines.get(&browsing_context.pipeline_id) {
Some(pipeline) => pipeline.url.clone(),
None => {
return warn!("{}: Refresh after closure", browsing_context.pipeline_id);
},
};
let resolve_url_future =
|previous_url: &mut ServoUrl, diff: &SessionHistoryDiff| match *diff {
SessionHistoryDiff::BrowsingContext {
browsing_context_id,
ref new_reloader,
..
} => {
if browsing_context_id == webview_id {
let url = match *new_reloader {
NeedsToReload::No(pipeline_id) => {
match self.pipelines.get(&pipeline_id) {
Some(pipeline) => pipeline.url.clone(),
None => previous_url.clone(),
}
},
NeedsToReload::Yes(_, ref load_data) => load_data.url.clone(),
};
*previous_url = url.clone();
Some(url)
} else {
Some(previous_url.clone())
}
},
_ => Some(previous_url.clone()),
};
let resolve_url_past = |previous_url: &mut ServoUrl, diff: &SessionHistoryDiff| match *diff
{
SessionHistoryDiff::BrowsingContext {
browsing_context_id,
ref old_reloader,
..
} => {
if browsing_context_id == webview_id {
let url = match *old_reloader {
NeedsToReload::No(pipeline_id) => match self.pipelines.get(&pipeline_id) {
Some(pipeline) => pipeline.url.clone(),
None => previous_url.clone(),
},
NeedsToReload::Yes(_, ref load_data) => load_data.url.clone(),
};
*previous_url = url.clone();
Some(url)
} else {
Some(previous_url.clone())
}
},
_ => Some(previous_url.clone()),
};
let mut entries: Vec<ServoUrl> = session_history
.past
.iter()
.rev()
.scan(current_url.clone(), &resolve_url_past)
.collect();
entries.reverse();
let current_index = entries.len();
entries.push(current_url.clone());
entries.extend(
session_history
.future
.iter()
.rev()
.scan(current_url, &resolve_url_future),
);
self.constellation_to_embedder_proxy
.send(ConstellationToEmbedderMsg::HistoryChanged(
webview_id,
entries,
current_index,
));
}
#[servo_tracing::instrument(skip_all)]
fn change_session_history(&mut self, change: SessionHistoryChange) {
debug!(
"{}: Setting to {}",
change.browsing_context_id, change.new_pipeline_id
);
if self.focused_browsing_context_is_descendant_of(&change) {
if let Some(webview) = self.webviews.get_mut(&change.webview_id) {
webview.focused_browsing_context_id = change.browsing_context_id;
}
}
let (old_pipeline_id, webview_id) =
match self.browsing_contexts.get_mut(&change.browsing_context_id) {
Some(browsing_context) => {
debug!("Adding pipeline to existing browsing context.");
let old_pipeline_id = browsing_context.pipeline_id;
browsing_context.pipelines.insert(change.new_pipeline_id);
browsing_context.update_current_entry(change.new_pipeline_id);
(Some(old_pipeline_id), Some(browsing_context.webview_id))
},
None => {
debug!("Adding pipeline to new browsing context.");
(None, None)
},
};
if let Some(old_pipeline_id) = old_pipeline_id {
self.unload_document(old_pipeline_id);
}
let Some(webview) = self.webviews.get_mut(&change.webview_id) else {
return warn!("Ignoring history change in non-existent WebView ({webview_id:?}).");
};
match old_pipeline_id {
None => {
let Some(new_context_info) = change.new_browsing_context_info else {
return warn!(
"{}: No NewBrowsingContextInfo for browsing context",
change.browsing_context_id,
);
};
self.new_browsing_context(
change.browsing_context_id,
change.webview_id,
change.new_pipeline_id,
new_context_info.parent_pipeline_id,
change.viewport_details,
new_context_info.is_private,
new_context_info.inherited_secure_context,
new_context_info.throttled,
);
self.update_activity(change.new_pipeline_id);
},
Some(old_pipeline_id) => {
let (pipelines_to_close, states_to_close) = if let Some(replace_reloader) =
change.replace
{
webview.session_history.replace_reloader(
replace_reloader.clone(),
NeedsToReload::No(change.new_pipeline_id),
);
match replace_reloader {
NeedsToReload::No(pipeline_id) => (Some(vec![pipeline_id]), None),
NeedsToReload::Yes(..) => (None, None),
}
} else {
let diff = SessionHistoryDiff::BrowsingContext {
browsing_context_id: change.browsing_context_id,
new_reloader: NeedsToReload::No(change.new_pipeline_id),
old_reloader: NeedsToReload::No(old_pipeline_id),
};
let mut pipelines_to_close = vec![];
let mut states_to_close = FxHashMap::default();
let diffs_to_close = webview.session_history.push_diff(diff);
for diff in diffs_to_close {
match diff {
SessionHistoryDiff::BrowsingContext { new_reloader, .. } => {
if let Some(pipeline_id) = new_reloader.alive_pipeline_id() {
pipelines_to_close.push(pipeline_id);
}
},
SessionHistoryDiff::Pipeline {
pipeline_reloader,
new_history_state_id,
..
} => {
if let Some(pipeline_id) = pipeline_reloader.alive_pipeline_id() {
let states =
states_to_close.entry(pipeline_id).or_insert(Vec::new());
states.push(new_history_state_id);
}
},
_ => {},
}
}
(Some(pipelines_to_close), Some(states_to_close))
};
self.update_activity(old_pipeline_id);
self.update_activity(change.new_pipeline_id);
if let Some(states_to_close) = states_to_close {
for (pipeline_id, states) in states_to_close {
let msg = ScriptThreadMessage::RemoveHistoryStates(pipeline_id, states);
if !self.send_message_to_pipeline(
pipeline_id,
msg,
"Removed history states after closure",
) {
return;
}
}
}
if let Some(pipelines_to_close) = pipelines_to_close {
for pipeline_id in pipelines_to_close {
self.close_pipeline(
pipeline_id,
DiscardBrowsingContext::No,
ExitPipelineMode::Normal,
);
}
}
},
}
if let Some(webview_id) = webview_id {
self.trim_history(webview_id);
}
self.notify_focus_state(change.new_pipeline_id);
self.notify_history_changed(change.webview_id);
self.set_frame_tree_for_webview(change.webview_id);
}
fn notify_focus_state(&mut self, pipeline_id: PipelineId) {
let Some(pipeline) = self.pipelines.get(&pipeline_id) else {
return warn!("Pipeline {pipeline_id} is closed");
};
let is_focused = match self.webviews.get(&pipeline.webview_id) {
Some(webview) => webview.focused_browsing_context_id == pipeline.browsing_context_id,
None => {
return warn!(
"Pipeline {pipeline_id}'s top-level browsing context {} is closed",
pipeline.webview_id
);
},
};
let msg = if is_focused {
ScriptThreadMessage::FocusDocumentAsPartOfFocusingSteps(
pipeline_id,
pipeline.focus_sequence,
None,
)
} else {
ScriptThreadMessage::UnfocusDocumentAsPartOfFocusingSteps(
pipeline_id,
pipeline.focus_sequence,
)
};
if let Err(e) = pipeline.event_loop.send(msg) {
self.handle_send_error(pipeline_id, e);
}
}
#[servo_tracing::instrument(skip_all)]
fn focused_browsing_context_is_descendant_of(&self, change: &SessionHistoryChange) -> bool {
let focused_browsing_context_id = self
.webviews
.get(&change.webview_id)
.map(|webview| webview.focused_browsing_context_id);
focused_browsing_context_id.is_some_and(|focused_browsing_context_id| {
focused_browsing_context_id == change.browsing_context_id ||
self.fully_active_descendant_browsing_contexts_iter(change.browsing_context_id)
.any(|nested_ctx| nested_ctx.id == focused_browsing_context_id)
})
}
#[servo_tracing::instrument(skip_all)]
fn trim_history(&mut self, webview_id: WebViewId) {
let pipelines_to_evict = {
let Some(webview) = self.webviews.get_mut(&webview_id) else {
return warn!("Not trimming history for non-existent WebView ({webview_id:}");
};
let history_length = pref!(session_history_max_length) as usize;
let past_trim = webview
.session_history
.past
.iter()
.rev()
.map(|diff| diff.alive_old_pipeline())
.skip(history_length)
.flatten();
let future_trim = webview
.session_history
.future
.iter()
.rev()
.map(|diff| diff.alive_new_pipeline())
.skip(history_length)
.flatten();
past_trim.chain(future_trim).collect::<Vec<_>>()
};
let mut dead_pipelines = vec![];
for evicted_id in pipelines_to_evict {
let Some(load_data) = self.refresh_load_data(evicted_id) else {
continue;
};
dead_pipelines.push((evicted_id, NeedsToReload::Yes(evicted_id, load_data)));
self.close_pipeline(
evicted_id,
DiscardBrowsingContext::No,
ExitPipelineMode::Normal,
);
}
if let Some(webview) = self.webviews.get_mut(&webview_id) {
for (alive_id, dead) in dead_pipelines {
webview
.session_history
.replace_reloader(NeedsToReload::No(alive_id), dead);
}
};
}
#[servo_tracing::instrument(skip_all)]
fn handle_activate_document_msg(&mut self, pipeline_id: PipelineId) {
debug!("{}: Document ready to activate", pipeline_id);
let Some(pending_index) = self
.pending_changes
.iter()
.rposition(|change| change.new_pipeline_id == pipeline_id)
else {
return;
};
let change = self.pending_changes.swap_remove(pending_index);
self.send_screenshot_readiness_requests_to_pipelines();
let parent_pipeline_id = match change.new_browsing_context_info {
Some(ref info) => info.parent_pipeline_id,
None => match self.browsing_contexts.get(&change.browsing_context_id) {
Some(ctx) => ctx.parent_pipeline_id,
None => {
return warn!(
"{}: Activated document after closure of {}",
change.new_pipeline_id, change.browsing_context_id,
);
},
},
};
if let Some(parent_pipeline_id) = parent_pipeline_id {
if let Some(parent_pipeline) = self.pipelines.get(&parent_pipeline_id) {
let msg = ScriptThreadMessage::UpdatePipelineId(
parent_pipeline_id,
change.browsing_context_id,
change.webview_id,
pipeline_id,
UpdatePipelineIdReason::Navigation,
);
let _ = parent_pipeline.event_loop.send(msg);
}
}
self.change_session_history(change);
}
#[servo_tracing::instrument(skip_all)]
fn handle_change_viewport_details_msg(
&mut self,
webview_id: WebViewId,
new_viewport_details: ViewportDetails,
size_type: WindowSizeType,
) {
debug!(
"handle_change_viewport_details_msg: {:?}",
new_viewport_details
);
let browsing_context_id = BrowsingContextId::from(webview_id);
self.resize_browsing_context(new_viewport_details, size_type, browsing_context_id);
}
#[servo_tracing::instrument(skip_all)]
fn handle_exit_fullscreen_msg(&mut self, webview_id: WebViewId) {
let browsing_context_id = BrowsingContextId::from(webview_id);
self.switch_fullscreen_mode(browsing_context_id);
}
#[servo_tracing::instrument(skip_all)]
fn handle_request_screenshot_readiness(&mut self, webview_id: WebViewId) {
self.screenshot_readiness_requests
.push(ScreenshotReadinessRequest {
webview_id,
pipeline_states: Default::default(),
state: Default::default(),
});
self.send_screenshot_readiness_requests_to_pipelines();
}
fn send_screenshot_readiness_requests_to_pipelines(&mut self) {
if !self.pending_changes.is_empty() {
return;
}
for screenshot_request in &self.screenshot_readiness_requests {
if screenshot_request.state.get() != ScreenshotRequestState::Pending {
return;
}
*screenshot_request.pipeline_states.borrow_mut() =
self.fully_active_browsing_contexts_iter(screenshot_request.webview_id)
.filter_map(|browsing_context| {
let pipeline_id = browsing_context.pipeline_id;
let Some(pipeline) = self.pipelines.get(&pipeline_id) else {
return None;
};
if browsing_context.viewport_details.size == Size2D::zero() {
return None;
}
let _ = pipeline.event_loop.send(
ScriptThreadMessage::RequestScreenshotReadiness(
pipeline.webview_id,
pipeline_id,
),
);
Some((pipeline_id, None))
})
.collect();
screenshot_request
.state
.set(ScreenshotRequestState::WaitingOnScript);
}
}
#[servo_tracing::instrument(skip_all)]
fn handle_screenshot_readiness_response(
&mut self,
updated_pipeline_id: PipelineId,
response: ScreenshotReadinessResponse,
) {
if self.screenshot_readiness_requests.is_empty() {
return;
}
self.screenshot_readiness_requests
.retain(|screenshot_request| {
if screenshot_request.state.get() != ScreenshotRequestState::WaitingOnScript {
return true;
}
let mut has_pending_pipeline = false;
let mut pipeline_states = screenshot_request.pipeline_states.borrow_mut();
pipeline_states.retain(|pipeline_id, state| {
if *pipeline_id != updated_pipeline_id {
has_pending_pipeline |= state.is_none();
return true;
}
match response {
ScreenshotReadinessResponse::Ready(epoch) => {
*state = Some(epoch);
true
},
ScreenshotReadinessResponse::NoLongerActive => false,
}
});
if has_pending_pipeline {
return true;
}
let pipelines_and_epochs = pipeline_states
.iter()
.map(|(pipeline_id, epoch)| {
(
*pipeline_id,
epoch.expect("Should have an epoch when pipeline is ready."),
)
})
.collect();
self.paint_proxy
.send(PaintMessage::ScreenshotReadinessReponse(
screenshot_request.webview_id,
pipelines_and_epochs,
));
false
});
}
#[servo_tracing::instrument(skip_all)]
fn get_activity(&self, pipeline_id: PipelineId) -> DocumentActivity {
let mut ancestor_id = pipeline_id;
loop {
if let Some(ancestor) = self.pipelines.get(&ancestor_id) {
if let Some(browsing_context) =
self.browsing_contexts.get(&ancestor.browsing_context_id)
{
if browsing_context.pipeline_id == ancestor_id {
if let Some(parent_pipeline_id) = browsing_context.parent_pipeline_id {
ancestor_id = parent_pipeline_id;
continue;
} else {
return DocumentActivity::FullyActive;
}
}
}
}
if pipeline_id == ancestor_id {
return DocumentActivity::Inactive;
} else {
return DocumentActivity::Active;
}
}
}
#[servo_tracing::instrument(skip_all)]
fn set_activity(&self, pipeline_id: PipelineId, activity: DocumentActivity) {
debug!("{}: Setting activity to {:?}", pipeline_id, activity);
if let Some(pipeline) = self.pipelines.get(&pipeline_id) {
pipeline.set_activity(activity);
let child_activity = if activity == DocumentActivity::Inactive {
DocumentActivity::Active
} else {
activity
};
for child_id in &pipeline.children {
if let Some(child) = self.browsing_contexts.get(child_id) {
self.set_activity(child.pipeline_id, child_activity);
}
}
}
}
#[servo_tracing::instrument(skip_all)]
fn update_activity(&self, pipeline_id: PipelineId) {
self.set_activity(pipeline_id, self.get_activity(pipeline_id));
}
#[servo_tracing::instrument(skip_all)]
fn resize_browsing_context(
&mut self,
new_viewport_details: ViewportDetails,
size_type: WindowSizeType,
browsing_context_id: BrowsingContextId,
) {
if let Some(browsing_context) = self.browsing_contexts.get_mut(&browsing_context_id) {
browsing_context.viewport_details = new_viewport_details;
let pipeline_id = browsing_context.pipeline_id;
let Some(pipeline) = self.pipelines.get(&pipeline_id) else {
return warn!("{}: Resized after closing", pipeline_id);
};
let _ = pipeline.event_loop.send(ScriptThreadMessage::Resize(
pipeline.id,
new_viewport_details,
size_type,
));
let pipeline_ids = browsing_context
.pipelines
.iter()
.filter(|pipeline_id| **pipeline_id != pipeline.id);
for id in pipeline_ids {
if let Some(pipeline) = self.pipelines.get(id) {
let _ = pipeline
.event_loop
.send(ScriptThreadMessage::ResizeInactive(
pipeline.id,
new_viewport_details,
));
}
}
} else {
self.pending_viewport_changes
.insert(browsing_context_id, new_viewport_details);
}
for change in &self.pending_changes {
let pipeline_id = change.new_pipeline_id;
let Some(pipeline) = self.pipelines.get(&pipeline_id) else {
warn!("{}: Pending pipeline is closed", pipeline_id);
continue;
};
if pipeline.browsing_context_id == browsing_context_id {
let _ = pipeline.event_loop.send(ScriptThreadMessage::Resize(
pipeline.id,
new_viewport_details,
size_type,
));
}
}
}
#[servo_tracing::instrument(skip_all)]
fn handle_theme_change(&mut self, webview_id: WebViewId, theme: Theme) {
let Some(webview) = self.webviews.get_mut(&webview_id) else {
warn!("Received theme change request for uknown WebViewId: {webview_id:?}");
return;
};
if !webview.set_theme(theme) {
return;
}
for pipeline in self.pipelines.values() {
if pipeline.webview_id != webview_id {
continue;
}
if let Err(error) = pipeline
.event_loop
.send(ScriptThreadMessage::ThemeChange(pipeline.id, theme))
{
warn!(
"{}: Failed to send theme change event to pipeline ({error:?}).",
pipeline.id,
);
}
}
}
#[servo_tracing::instrument(skip_all)]
fn switch_fullscreen_mode(&mut self, browsing_context_id: BrowsingContextId) {
if let Some(browsing_context) = self.browsing_contexts.get(&browsing_context_id) {
let pipeline_id = browsing_context.pipeline_id;
let Some(pipeline) = self.pipelines.get(&pipeline_id) else {
return warn!("{pipeline_id}: Switched from fullscreen mode after closing",);
};
let _ = pipeline
.event_loop
.send(ScriptThreadMessage::ExitFullScreen(pipeline.id));
}
}
#[servo_tracing::instrument(skip_all)]
fn close_browsing_context(
&mut self,
browsing_context_id: BrowsingContextId,
exit_mode: ExitPipelineMode,
) -> Option<BrowsingContext> {
debug!("{}: Closing", browsing_context_id);
self.close_browsing_context_children(
browsing_context_id,
DiscardBrowsingContext::Yes,
exit_mode,
);
let _ = self.pending_viewport_changes.remove(&browsing_context_id);
let Some(browsing_context) = self.browsing_contexts.remove(&browsing_context_id) else {
warn!("fn close_browsing_context: {browsing_context_id}: Closing twice");
return None;
};
if let Some(webview) = self.webviews.get_mut(&browsing_context.webview_id) {
webview
.session_history
.remove_entries_for_browsing_context(browsing_context_id);
}
if let Some(parent_pipeline_id) = browsing_context.parent_pipeline_id {
match self.pipelines.get_mut(&parent_pipeline_id) {
None => {
warn!("{parent_pipeline_id}: Child closed after parent");
},
Some(parent_pipeline) => {
parent_pipeline.remove_child(browsing_context_id);
if let Some(webview) = self.webviews.get_mut(&browsing_context.webview_id) {
if webview.focused_browsing_context_id == browsing_context_id {
trace!(
"About-to-be-closed browsing context {} is currently focused, so \
focusing its parent {}",
browsing_context_id, parent_pipeline.browsing_context_id
);
webview.focused_browsing_context_id =
parent_pipeline.browsing_context_id;
}
} else {
warn!(
"Browsing context {} contains a reference to \
a non-existent top-level browsing context {}",
browsing_context_id, browsing_context.webview_id
);
}
},
};
}
debug!("{}: Closed", browsing_context_id);
Some(browsing_context)
}
#[servo_tracing::instrument(skip_all)]
fn close_browsing_context_children(
&mut self,
browsing_context_id: BrowsingContextId,
dbc: DiscardBrowsingContext,
exit_mode: ExitPipelineMode,
) {
debug!("{}: Closing browsing context children", browsing_context_id);
let mut pipelines_to_close: Vec<PipelineId> = self
.pending_changes
.iter()
.filter(|change| change.browsing_context_id == browsing_context_id)
.map(|change| change.new_pipeline_id)
.collect();
if let Some(browsing_context) = self.browsing_contexts.get(&browsing_context_id) {
pipelines_to_close.extend(&browsing_context.pipelines)
}
for pipeline_id in pipelines_to_close {
self.close_pipeline(pipeline_id, dbc, exit_mode);
}
debug!("{}: Closed browsing context children", browsing_context_id);
}
fn refresh_load_data(&self, pipeline_id: PipelineId) -> Option<LoadData> {
self.pipelines.get(&pipeline_id).map(|pipeline| {
let mut load_data = pipeline.load_data.clone();
load_data.url = pipeline.url.clone();
load_data
})
}
#[servo_tracing::instrument(skip_all)]
fn handle_discard_document(&mut self, webview_id: WebViewId, pipeline_id: PipelineId) {
let Some(load_data) = self.refresh_load_data(pipeline_id) else {
return warn!("{}: Discarding closed pipeline", pipeline_id);
};
match self.webviews.get_mut(&webview_id) {
Some(webview) => {
webview.session_history.replace_reloader(
NeedsToReload::No(pipeline_id),
NeedsToReload::Yes(pipeline_id, load_data),
);
},
None => {
return warn!("{pipeline_id}: Discarding after closure of {webview_id}",);
},
};
self.close_pipeline(
pipeline_id,
DiscardBrowsingContext::No,
ExitPipelineMode::Normal,
);
}
#[servo_tracing::instrument(skip_all)]
fn unload_document(&self, pipeline_id: PipelineId) {
if let Some(pipeline) = self.pipelines.get(&pipeline_id) {
pipeline.set_throttled(true);
let msg = ScriptThreadMessage::UnloadDocument(pipeline_id);
let _ = pipeline.event_loop.send(msg);
}
}
#[servo_tracing::instrument(skip_all)]
fn close_pipeline(
&mut self,
pipeline_id: PipelineId,
dbc: DiscardBrowsingContext,
exit_mode: ExitPipelineMode,
) {
debug!("{}: Closing", pipeline_id);
let browsing_context_id = self
.pipelines
.get(&pipeline_id)
.map(|pipeline| pipeline.browsing_context_id);
if let Some(browsing_context) = browsing_context_id
.and_then(|browsing_context_id| self.browsing_contexts.get_mut(&browsing_context_id))
{
browsing_context.pipelines.remove(&pipeline_id);
}
let browsing_contexts_to_close = {
let mut browsing_contexts_to_close = vec![];
if let Some(pipeline) = self.pipelines.get(&pipeline_id) {
browsing_contexts_to_close.extend_from_slice(&pipeline.children);
}
browsing_contexts_to_close
};
for child_browsing_context in &browsing_contexts_to_close {
self.close_browsing_context(*child_browsing_context, exit_mode);
}
let Some(pipeline) = self.pipelines.get(&pipeline_id) else {
return warn!("fn close_pipeline: {pipeline_id}: Closing twice");
};
let pending_index = self
.pending_changes
.iter()
.position(|change| change.new_pipeline_id == pipeline_id);
if let Some(pending_index) = pending_index {
self.pending_changes.remove(pending_index);
}
pipeline.send_exit_message_to_script(dbc);
self.send_screenshot_readiness_requests_to_pipelines();
self.handle_screenshot_readiness_response(
pipeline_id,
ScreenshotReadinessResponse::NoLongerActive,
);
debug!("{}: Closed", pipeline_id);
}
fn maybe_close_random_pipeline(&mut self) {
match self.random_pipeline_closure {
Some((ref mut rng, probability)) => {
if probability <= rng.random::<f32>() {
return;
}
},
_ => return,
};
let mut pipeline_ids: Vec<&PipelineId> = self.pipelines.keys().collect();
pipeline_ids.sort_unstable();
if let Some((ref mut rng, probability)) = self.random_pipeline_closure {
if let Some(pipeline_id) = pipeline_ids.choose(rng) {
if let Some(pipeline) = self.pipelines.get(pipeline_id) {
if self
.pending_changes
.iter()
.any(|change| change.new_pipeline_id == pipeline.id) &&
probability <= rng.random::<f32>()
{
info!("{}: Not closing pending pipeline", pipeline_id);
} else {
warn!("{}: Randomly closing pipeline", pipeline_id);
pipeline.send_exit_message_to_script(DiscardBrowsingContext::No);
}
}
}
}
}
#[servo_tracing::instrument(skip_all)]
fn browsing_context_to_sendable(
&self,
browsing_context_id: BrowsingContextId,
) -> Option<SendableFrameTree> {
self.browsing_contexts
.get(&browsing_context_id)
.and_then(|browsing_context| {
self.pipelines
.get(&browsing_context.pipeline_id)
.map(|pipeline| {
let mut frame_tree = SendableFrameTree {
pipeline: pipeline.to_sendable(),
children: vec![],
};
for child_browsing_context_id in &pipeline.children {
if let Some(child) =
self.browsing_context_to_sendable(*child_browsing_context_id)
{
frame_tree.children.push(child);
}
}
frame_tree
})
})
}
#[servo_tracing::instrument(skip_all)]
fn set_frame_tree_for_webview(&mut self, webview_id: WebViewId) {
let browsing_context_id = BrowsingContextId::from(webview_id);
let Some(frame_tree) = self.browsing_context_to_sendable(browsing_context_id) else {
return;
};
let new_pipeline_id = frame_tree.pipeline.id;
debug!("{}: Sending frame tree", browsing_context_id);
self.paint_proxy
.send(PaintMessage::SetFrameTreeForWebView(webview_id, frame_tree));
let Some(webview) = self.webviews.get_mut(&webview_id) else {
return;
};
if webview.active_top_level_pipeline_id == Some(new_pipeline_id) {
return;
}
let old_pipeline_id = webview.active_top_level_pipeline_id;
let old_epoch = webview.active_top_level_pipeline_epoch;
let new_epoch = old_epoch.next();
let accessibility_active = webview.accessibility_active;
webview.active_top_level_pipeline_id = Some(new_pipeline_id);
webview.active_top_level_pipeline_epoch = new_epoch;
if let Some(old_pipeline_id) = old_pipeline_id {
self.send_message_to_pipeline(
old_pipeline_id,
ScriptThreadMessage::SetAccessibilityActive(old_pipeline_id, false, old_epoch),
"Set accessibility active after closure",
);
}
self.send_message_to_pipeline(
new_pipeline_id,
ScriptThreadMessage::SetAccessibilityActive(
new_pipeline_id,
accessibility_active,
new_epoch,
),
"Set accessibility active after closure",
);
}
#[servo_tracing::instrument(skip_all)]
fn handle_media_session_action_msg(&mut self, action: MediaSessionActionType) {
if let Some(media_session_pipeline_id) = self.active_media_session {
self.send_message_to_pipeline(
media_session_pipeline_id,
ScriptThreadMessage::MediaSessionAction(media_session_pipeline_id, action),
"Got media session action request after closure",
);
} else {
error!("Got a media session action but no active media session is registered");
}
}
#[servo_tracing::instrument(skip_all)]
fn handle_set_scroll_states(&self, pipeline_id: PipelineId, scroll_states: ScrollStateUpdate) {
let Some(pipeline) = self.pipelines.get(&pipeline_id) else {
warn!("Discarding scroll offset update for unknown pipeline");
return;
};
if let Err(error) = pipeline
.event_loop
.send(ScriptThreadMessage::SetScrollStates(
pipeline_id,
scroll_states,
))
{
warn!("Could not send scroll offsets to pipeline: {pipeline_id:?}: {error:?}");
}
}
#[servo_tracing::instrument(skip_all)]
fn handle_paint_metric(&mut self, pipeline_id: PipelineId, event: PaintMetricEvent) {
let Some(pipeline) = self.pipelines.get(&pipeline_id) else {
warn!("Discarding paint metric event for unknown pipeline");
return;
};
let (metric_type, metric_value, first_reflow) = match event {
PaintMetricEvent::FirstPaint(metric_value, first_reflow) => (
ProgressiveWebMetricType::FirstPaint,
metric_value,
first_reflow,
),
PaintMetricEvent::FirstContentfulPaint(metric_value, first_reflow) => (
ProgressiveWebMetricType::FirstContentfulPaint,
metric_value,
first_reflow,
),
PaintMetricEvent::LargestContentfulPaint(metric_value, area, url) => (
ProgressiveWebMetricType::LargestContentfulPaint { area, url },
metric_value,
false, ),
};
if let Err(error) = pipeline.event_loop.send(ScriptThreadMessage::PaintMetric(
pipeline_id,
metric_type,
metric_value,
first_reflow,
)) {
warn!("Could not sent paint metric event to pipeline: {pipeline_id:?}: {error:?}");
}
}
fn create_canvas_paint_thread(
&self,
) -> (Sender<ConstellationCanvasMsg>, GenericSender<CanvasMsg>) {
CanvasPaintThread::start(self.paint_proxy.cross_process_paint_api.clone())
}
fn handle_embedder_control_response(
&self,
id: EmbedderControlId,
response: EmbedderControlResponse,
) {
let pipeline_id = id.pipeline_id;
let Some(pipeline) = self.pipelines.get(&pipeline_id) else {
warn!("Not sending embedder control response for unknown pipeline {pipeline_id:?}");
return;
};
if let Err(error) = pipeline
.event_loop
.send(ScriptThreadMessage::EmbedderControlResponse(id, response))
{
warn!(
"Could not send embedder control response to pipeline {pipeline_id:?}: {error:?}"
);
}
}
fn handle_update_pinch_zoom_infos(
&self,
pipeline_id: PipelineId,
pinch_zoom_infos: PinchZoomInfos,
) {
let Some(pipeline) = self.pipelines.get(&pipeline_id) else {
warn!("Discarding pinch zoom update for unknown pipeline");
return;
};
if let Err(error) = pipeline
.event_loop
.send(ScriptThreadMessage::UpdatePinchZoomInfos(
pipeline_id,
pinch_zoom_infos,
))
{
warn!("Could not send pinch zoom update to pipeline: {pipeline_id:?}: {error:?}");
}
}
pub(crate) fn script_to_devtools_callback(
&self,
) -> Option<GenericCallback<ScriptToDevtoolsControlMsg>> {
self.script_to_devtools_callback
.get_or_init(|| {
self.devtools_sender.as_ref().and_then(|devtools_sender| {
let devtools_sender = devtools_sender.clone();
let callback = GenericCallback::new(move |message| match message {
Err(error) => {
error!("Cast to ScriptToDevtoolsControlMsg failed ({error}).")
},
Ok(message) => {
if let Err(error) =
devtools_sender.send(DevtoolsControlMsg::FromScript(message))
{
warn!("Sending to devtools failed ({error:?})")
}
},
});
match callback {
Ok(callback) => Some(callback),
Err(error) => {
error!("Could not create Devtools communication channel: {error}");
None
},
}
})
})
.clone()
}
}
#[derive(Clone, Copy, Default, PartialEq)]
enum ScreenshotRequestState {
#[default]
Pending,
WaitingOnScript,
}
struct ScreenshotReadinessRequest {
webview_id: WebViewId,
state: Cell<ScreenshotRequestState>,
pipeline_states: RefCell<FxHashMap<PipelineId, Option<Epoch>>>,
}