servo_constellation/
event_loop.rs

1/* This Source Code Form is subject to the terms of the Mozilla Public
2 * License, v. 2.0. If a copy of the MPL was not distributed with this
3 * file, You can obtain one at https://mozilla.org/MPL/2.0/. */
4
5//! This module contains the `EventLoop` type, which is the constellation's
6//! view of a script thread. When an `EventLoop` is dropped, an `ExitScriptThread`
7//! message is sent to the script thread, asking it to shut down.
8
9use std::hash::Hash;
10use std::marker::PhantomData;
11use std::rc::Rc;
12
13use background_hang_monitor_api::{BackgroundHangMonitorControlMsg, HangAlert};
14use embedder_traits::ScriptToEmbedderChan;
15use layout_api::ScriptThreadFactory;
16use log::error;
17use media::WindowGLContext;
18use script_traits::{InitialScriptState, ScriptThreadMessage};
19use serde::{Deserialize, Serialize};
20use servo_base::generic_channel::{GenericReceiver, GenericSender, SendError};
21use servo_base::id::ScriptEventLoopId;
22#[cfg(feature = "multiprocess")]
23use servo_config::opts::{self, Opts};
24#[cfg(feature = "multiprocess")]
25use servo_config::prefs::{self, Preferences};
26use servo_constellation_traits::ServiceWorkerManagerFactory;
27
28use crate::Constellation;
29
30/// <https://html.spec.whatwg.org/multipage/#event-loop>
31pub struct EventLoop {
32    script_chan: GenericSender<ScriptThreadMessage>,
33    id: ScriptEventLoopId,
34    /// When running in another process, this is an `IpcSender` to the BackgroundHangMonitor
35    /// on the other side of the process boundary. When running in the same process, the
36    /// BackgroundHangMonitor is shared among all [`EventLoop`]s so this will be `None`.
37    background_hang_monitor_sender: Option<GenericSender<BackgroundHangMonitorControlMsg>>,
38    dont_send_or_sync: PhantomData<Rc<()>>,
39}
40
41impl PartialEq for EventLoop {
42    fn eq(&self, other: &Self) -> bool {
43        self.id == other.id
44    }
45}
46
47impl Eq for EventLoop {}
48
49impl Hash for EventLoop {
50    fn hash<H: std::hash::Hasher>(&self, state: &mut H) {
51        self.id.hash(state);
52    }
53}
54
55impl Drop for EventLoop {
56    fn drop(&mut self) {
57        self.send_message_to_background_hang_monitor(&BackgroundHangMonitorControlMsg::Exit);
58
59        if let Err(error) = self.script_chan.send(ScriptThreadMessage::ExitScriptThread) {
60            error!("Did not successfully request EventLoop exit: {error}");
61        }
62    }
63}
64
65impl EventLoop {
66    pub(crate) fn spawn<STF: ScriptThreadFactory, SWF: ServiceWorkerManagerFactory>(
67        constellation: &mut Constellation<STF, SWF>,
68        is_private: bool,
69    ) -> Result<Rc<Self>, SendError> {
70        let (script_chan, script_port) =
71            servo_base::generic_channel::channel().expect("Pipeline script chan");
72
73        let embedder_chan = constellation.embedder_proxy.sender.clone();
74        let eventloop_waker = constellation.embedder_proxy.event_loop_waker.clone();
75        let script_to_embedder_sender = ScriptToEmbedderChan::new(embedder_chan, eventloop_waker);
76
77        let resource_threads = if is_private {
78            constellation.private_resource_threads.clone()
79        } else {
80            constellation.public_resource_threads.clone()
81        };
82        let storage_threads = if is_private {
83            constellation.private_storage_threads.clone()
84        } else {
85            constellation.public_storage_threads.clone()
86        };
87
88        let event_loop_id = ScriptEventLoopId::new();
89        let initial_script_state = InitialScriptState {
90            id: event_loop_id,
91            script_to_constellation_sender: constellation.script_sender.clone(),
92            script_to_embedder_sender,
93            namespace_request_sender: constellation.namespace_ipc_sender.clone(),
94            #[cfg(feature = "devtools")]
95            devtools_server_sender: constellation.script_to_devtools_callback(),
96            #[cfg(feature = "bluetooth")]
97            bluetooth_sender: constellation.bluetooth_ipc_sender.clone(),
98            system_font_service: constellation.system_font_service.to_sender(),
99            resource_threads,
100            storage_threads,
101            time_profiler_sender: constellation.time_profiler_chan.clone(),
102            memory_profiler_sender: constellation.mem_profiler_chan.clone(),
103            constellation_to_script_sender: script_chan,
104            constellation_to_script_receiver: script_port,
105            pipeline_namespace_id: constellation.next_pipeline_namespace_id(),
106            cross_process_paint_api: constellation.paint_proxy.cross_process_paint_api.clone(),
107            #[cfg(feature = "webgl")]
108            webgl_chan: constellation
109                .webgl_threads
110                .as_ref()
111                .map(|threads| threads.pipeline()),
112            webxr_registry: constellation.webxr_registry.clone(),
113            player_context: WindowGLContext::get(),
114            privileged_urls: constellation.privileged_urls.clone(),
115            user_contents_for_manager_id: constellation.user_contents_for_manager_id.clone(),
116        };
117
118        #[cfg(feature = "multiprocess")]
119        let event_loop = if opts::get().multiprocess {
120            Self::spawn_in_process(constellation, initial_script_state)?
121        } else {
122            Self::spawn_in_thread(constellation, initial_script_state)
123        };
124        #[cfg(not(feature = "multiprocess"))]
125        let event_loop = Self::spawn_in_thread(constellation, initial_script_state);
126
127        let event_loop = Rc::new(event_loop);
128        constellation.add_event_loop(&event_loop);
129        Ok(event_loop)
130    }
131
132    fn spawn_in_thread<STF: ScriptThreadFactory, SWF: ServiceWorkerManagerFactory>(
133        constellation: &mut Constellation<STF, SWF>,
134        initial_script_state: InitialScriptState,
135    ) -> Self {
136        let script_chan = initial_script_state.constellation_to_script_sender.clone();
137        let id = initial_script_state.id;
138        let background_hang_monitor_register = constellation
139            .background_monitor_register
140            .clone()
141            .expect("Couldn't start content, no background monitor has been initiated");
142        let join_handle = STF::create(
143            initial_script_state,
144            constellation.layout_factory.clone(),
145            constellation.image_cache_factory.clone(),
146            background_hang_monitor_register,
147        );
148        constellation.add_event_loop_join_handle(join_handle);
149
150        Self {
151            script_chan,
152            id,
153            background_hang_monitor_sender: None,
154            dont_send_or_sync: PhantomData,
155        }
156    }
157
158    #[cfg(feature = "multiprocess")]
159    fn spawn_in_process<STF: ScriptThreadFactory, SWF: ServiceWorkerManagerFactory>(
160        constellation: &mut Constellation<STF, SWF>,
161        initial_script_state: InitialScriptState,
162    ) -> Result<Self, SendError> {
163        let script_chan = initial_script_state.constellation_to_script_sender.clone();
164        let id = initial_script_state.id;
165
166        let (background_hand_monitor_sender, backgrond_hand_monitor_receiver) =
167            servo_base::generic_channel::channel().expect("Sampler chan");
168        let (lifeline_sender, lifeline_receiver) =
169            servo_base::generic_channel::channel().expect("Failed to create lifeline channel");
170
171        let process = crate::sandboxing::spawn_multiprocess(
172            crate::UnprivilegedContent::ScriptEventLoop(NewScriptEventLoopProcessInfo {
173                initial_script_state,
174                constellation_to_bhm_receiver: backgrond_hand_monitor_receiver,
175                bhm_to_constellation_sender: constellation.background_hang_monitor_sender.clone(),
176                lifeline_sender,
177                opts: (*opts::get()).clone(),
178                prefs: Box::new(prefs::get().clone()),
179                broken_image_icon_data: constellation.broken_image_icon_data.clone(),
180            }),
181        )?;
182
183        let crossbeam_receiver = lifeline_receiver.route_preserving_errors();
184        constellation
185            .process_manager
186            .add(crossbeam_receiver, process);
187
188        Ok(Self {
189            script_chan,
190            id,
191            background_hang_monitor_sender: Some(background_hand_monitor_sender),
192            dont_send_or_sync: PhantomData,
193        })
194    }
195
196    pub(crate) fn id(&self) -> ScriptEventLoopId {
197        self.id
198    }
199
200    /// Send a message to the event loop.
201    pub fn send(&self, msg: ScriptThreadMessage) -> Result<(), SendError> {
202        self.script_chan.send(msg)
203    }
204
205    /// If this is [`EventLoop`] is in another process, send a message to its `BackgroundHangMonitor`,
206    /// otherwise do nothing.
207    pub(crate) fn send_message_to_background_hang_monitor(
208        &self,
209        message: &BackgroundHangMonitorControlMsg,
210    ) {
211        if let Some(background_hang_monitor_sender) = &self.background_hang_monitor_sender &&
212            let Err(error) = background_hang_monitor_sender.send(message.clone())
213        {
214            error!("Could not send message ({message:?}) to BHM: {error}");
215        }
216    }
217}
218
219/// All of the information necessary to create a new script [`EventLoop`] in a new process.
220#[derive(Deserialize, Serialize)]
221#[cfg(feature = "multiprocess")]
222pub struct NewScriptEventLoopProcessInfo {
223    pub initial_script_state: InitialScriptState,
224    pub constellation_to_bhm_receiver: GenericReceiver<BackgroundHangMonitorControlMsg>,
225    pub bhm_to_constellation_sender: GenericSender<HangAlert>,
226    pub lifeline_sender: GenericSender<()>,
227    pub opts: Opts,
228    pub prefs: Box<Preferences>,
229    /// The broken image icon data that is used to create an image to show in place of broken images.
230    pub broken_image_icon_data: Vec<u8>,
231}
servo_constellation/event_loop.rs

servo_constellation/
event_loop.rs
