script/dom/
workletglobalscope.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
5use std::borrow::Cow;
6use std::sync::Arc;
7
8use base::generic_channel::{GenericCallback, GenericSender};
9use base::id::{PipelineId, WebViewId};
10use constellation_traits::{ScriptToConstellationChan, ScriptToConstellationMessage};
11use crossbeam_channel::Sender;
12use devtools_traits::ScriptToDevtoolsControlMsg;
13use dom_struct::dom_struct;
14use embedder_traits::{JavaScriptEvaluationError, ScriptToEmbedderChan};
15use net_traits::ResourceThreads;
16use net_traits::image_cache::ImageCache;
17use profile_traits::{mem, time};
18use script_traits::Painter;
19use servo_url::{ImmutableOrigin, MutableOrigin, ServoUrl};
20use storage_traits::StorageThreads;
21use stylo_atoms::Atom;
22
23use crate::dom::bindings::inheritance::Castable;
24use crate::dom::bindings::root::DomRoot;
25use crate::dom::bindings::trace::CustomTraceable;
26use crate::dom::bindings::utils::define_all_exposed_interfaces;
27use crate::dom::globalscope::GlobalScope;
28use crate::dom::paintworkletglobalscope::{PaintWorkletGlobalScope, PaintWorkletTask};
29#[cfg(feature = "testbinding")]
30use crate::dom::testworkletglobalscope::{TestWorkletGlobalScope, TestWorkletTask};
31#[cfg(feature = "webgpu")]
32use crate::dom::webgpu::identityhub::IdentityHub;
33use crate::dom::worklet::WorkletExecutor;
34use crate::messaging::MainThreadScriptMsg;
35use crate::realms::enter_auto_realm;
36use crate::script_runtime::{IntroductionType, JSContext};
37
38#[dom_struct]
39/// <https://drafts.css-houdini.org/worklets/#workletglobalscope>
40pub(crate) struct WorkletGlobalScope {
41    /// The global for this worklet.
42    globalscope: GlobalScope,
43    /// The base URL for this worklet.
44    #[no_trace]
45    base_url: ServoUrl,
46    /// Sender back to the script thread
47    to_script_thread_sender: Sender<MainThreadScriptMsg>,
48    /// Worklet task executor
49    executor: WorkletExecutor,
50}
51
52impl WorkletGlobalScope {
53    #[expect(clippy::too_many_arguments)]
54    /// Create a new heap-allocated `WorkletGlobalScope`.
55    pub(crate) fn new(
56        scope_type: WorkletGlobalScopeType,
57        webview_id: WebViewId,
58        pipeline_id: PipelineId,
59        base_url: ServoUrl,
60        inherited_secure_context: Option<bool>,
61        executor: WorkletExecutor,
62        init: &WorkletGlobalScopeInit,
63        cx: &mut js::context::JSContext,
64    ) -> DomRoot<WorkletGlobalScope> {
65        let scope: DomRoot<WorkletGlobalScope> = match scope_type {
66            #[cfg(feature = "testbinding")]
67            WorkletGlobalScopeType::Test => DomRoot::upcast(TestWorkletGlobalScope::new(
68                webview_id,
69                pipeline_id,
70                base_url,
71                inherited_secure_context,
72                executor,
73                init,
74                cx,
75            )),
76            WorkletGlobalScopeType::Paint => DomRoot::upcast(PaintWorkletGlobalScope::new(
77                webview_id,
78                pipeline_id,
79                base_url,
80                inherited_secure_context,
81                executor,
82                init,
83                cx,
84            )),
85        };
86
87        let mut realm = enter_auto_realm(cx, &*scope);
88        let mut realm = realm.current_realm();
89        define_all_exposed_interfaces(&mut realm, scope.upcast());
90
91        scope
92    }
93
94    /// Create a new stack-allocated `WorkletGlobalScope`.
95    pub(crate) fn new_inherited(
96        webview_id: WebViewId,
97        pipeline_id: PipelineId,
98        base_url: ServoUrl,
99        inherited_secure_context: Option<bool>,
100        executor: WorkletExecutor,
101        init: &WorkletGlobalScopeInit,
102    ) -> Self {
103        let script_to_constellation_chan = ScriptToConstellationChan {
104            sender: init.to_constellation_sender.clone(),
105            webview_id,
106            pipeline_id,
107        };
108        Self {
109            globalscope: GlobalScope::new_inherited(
110                pipeline_id,
111                init.devtools_chan.clone(),
112                init.mem_profiler_chan.clone(),
113                init.time_profiler_chan.clone(),
114                script_to_constellation_chan,
115                init.to_embedder_sender.clone(),
116                init.resource_threads.clone(),
117                init.storage_threads.clone(),
118                MutableOrigin::new(ImmutableOrigin::new_opaque()),
119                base_url.clone(),
120                None,
121                #[cfg(feature = "webgpu")]
122                init.gpu_id_hub.clone(),
123                inherited_secure_context,
124                false,
125                None, // font_context
126            ),
127            base_url,
128            to_script_thread_sender: init.to_script_thread_sender.clone(),
129            executor,
130        }
131    }
132
133    /// Get the JS context.
134    pub(crate) fn get_cx() -> JSContext {
135        GlobalScope::get_cx()
136    }
137
138    /// Evaluate a JS script in this global.
139    pub(crate) fn evaluate_js(
140        &self,
141        script: Cow<'_, str>,
142        cx: &mut js::context::JSContext,
143    ) -> Result<(), JavaScriptEvaluationError> {
144        let mut realm = enter_auto_realm(cx, self);
145        let cx = &mut realm.current_realm();
146
147        debug!("Evaluating Dom in a worklet.");
148        self.globalscope.evaluate_js_on_global(
149            cx,
150            script,
151            "",
152            Some(IntroductionType::WORKLET),
153            None,
154        )
155    }
156
157    /// Register a paint worklet to the script thread.
158    pub(crate) fn register_paint_worklet(
159        &self,
160        name: Atom,
161        properties: Vec<Atom>,
162        painter: Box<dyn Painter>,
163    ) {
164        self.to_script_thread_sender
165            .send(MainThreadScriptMsg::RegisterPaintWorklet {
166                pipeline_id: self.globalscope.pipeline_id(),
167                name,
168                properties,
169                painter,
170            })
171            .expect("Worklet thread outlived script thread.");
172    }
173
174    /// The base URL of this global.
175    pub(crate) fn base_url(&self) -> ServoUrl {
176        self.base_url.clone()
177    }
178
179    /// The worklet executor.
180    pub(crate) fn executor(&self) -> WorkletExecutor {
181        self.executor.clone()
182    }
183
184    /// Perform a worklet task
185    pub(crate) fn perform_a_worklet_task(&self, task: WorkletTask) {
186        match task {
187            #[cfg(feature = "testbinding")]
188            WorkletTask::Test(task) => match self.downcast::<TestWorkletGlobalScope>() {
189                Some(global) => global.perform_a_worklet_task(task),
190                None => warn!("This is not a test worklet."),
191            },
192            WorkletTask::Paint(task) => match self.downcast::<PaintWorkletGlobalScope>() {
193                Some(global) => global.perform_a_worklet_task(task),
194                None => warn!("This is not a paint worklet."),
195            },
196        }
197    }
198}
199
200/// Resources required by workletglobalscopes
201#[derive(Clone)]
202pub(crate) struct WorkletGlobalScopeInit {
203    /// Channel to the main script thread
204    pub(crate) to_script_thread_sender: Sender<MainThreadScriptMsg>,
205    /// Channel to a resource thread
206    pub(crate) resource_threads: ResourceThreads,
207    /// Channels to the [`StorageThreads`].
208    pub(crate) storage_threads: StorageThreads,
209    /// Channel to the memory profiler
210    pub(crate) mem_profiler_chan: mem::ProfilerChan,
211    /// Channel to the time profiler
212    pub(crate) time_profiler_chan: time::ProfilerChan,
213    /// Channel to devtools
214    pub(crate) devtools_chan: Option<GenericCallback<ScriptToDevtoolsControlMsg>>,
215    /// Messages to send to constellation
216    pub(crate) to_constellation_sender:
217        GenericSender<(WebViewId, PipelineId, ScriptToConstellationMessage)>,
218    /// Messages to send to the Embedder
219    pub(crate) to_embedder_sender: ScriptToEmbedderChan,
220    /// The image cache
221    pub(crate) image_cache: Arc<dyn ImageCache>,
222    /// Identity manager for WebGPU resources
223    #[cfg(feature = "webgpu")]
224    pub(crate) gpu_id_hub: Arc<IdentityHub>,
225}
226
227/// <https://drafts.css-houdini.org/worklets/#worklet-global-scope-type>
228#[derive(Clone, Copy, Debug, JSTraceable, MallocSizeOf)]
229pub(crate) enum WorkletGlobalScopeType {
230    /// A servo-specific testing worklet
231    #[cfg(feature = "testbinding")]
232    Test,
233    /// A paint worklet
234    Paint,
235}
236
237/// A task which can be performed in the context of a worklet global.
238pub(crate) enum WorkletTask {
239    #[cfg(feature = "testbinding")]
240    Test(TestWorkletTask),
241    Paint(PaintWorkletTask),
242}
script/dom/workletglobalscope.rs

script/dom/
workletglobalscope.rs
