servo_config/
prefs.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::env::consts::ARCH;
6use std::sync::{RwLock, RwLockReadGuard};
7
8use serde::{Deserialize, Serialize};
9use servo_config_macro::ServoPreferences;
10
11pub use crate::pref_util::PrefValue;
12
13static PREFERENCES: RwLock<Preferences> = RwLock::new(Preferences::const_default());
14
15pub trait PreferencesObserver: Send + Sync {
16    fn prefs_changed(&self, _changes: &[(&'static str, PrefValue)]) {}
17}
18
19static OBSERVERS: RwLock<Vec<Box<dyn PreferencesObserver>>> = RwLock::new(Vec::new());
20
21#[inline]
22/// Get the current set of global preferences for Servo.
23pub fn get() -> RwLockReadGuard<'static, Preferences> {
24    PREFERENCES.read().unwrap()
25}
26
27pub fn add_observer(observer: Box<dyn PreferencesObserver>) {
28    OBSERVERS.write().unwrap().push(observer);
29}
30
31pub fn set(preferences: Preferences) {
32    // Map between Stylo preference names and Servo preference names as the This should be
33    // kept in sync with components/script/dom/bindings/codegen/run.py which generates the
34    // DOM CSS style accessors.
35    stylo_config::set_bool("layout.unimplemented", preferences.layout_unimplemented);
36    stylo_config::set_i32("layout.threads", preferences.layout_threads as i32);
37    stylo_config::set_bool("layout.flexbox.enabled", preferences.layout_flexbox_enabled);
38    stylo_config::set_bool("layout.columns.enabled", preferences.layout_columns_enabled);
39    stylo_config::set_bool("layout.grid.enabled", preferences.layout_grid_enabled);
40    stylo_config::set_bool(
41        "layout.css.transition-behavior.enabled",
42        preferences.layout_css_transition_behavior_enabled,
43    );
44    stylo_config::set_bool(
45        "layout.writing-mode.enabled",
46        preferences.layout_writing_mode_enabled,
47    );
48    stylo_config::set_bool(
49        "layout.container-queries.enabled",
50        preferences.layout_container_queries_enabled,
51    );
52    stylo_config::set_bool(
53        "layout.variable_fonts.enabled",
54        preferences.layout_variable_fonts_enabled,
55    );
56
57    let changed = preferences.diff(&PREFERENCES.read().unwrap());
58
59    *PREFERENCES.write().unwrap() = preferences;
60
61    for observer in &*OBSERVERS.read().unwrap() {
62        observer.prefs_changed(&changed);
63    }
64}
65
66/// A convenience macro for accessing a preference value using its static path.
67/// Passing an invalid path is a compile-time error.
68#[macro_export]
69macro_rules! pref {
70    ($name: ident) => {
71        $crate::prefs::get().$name.clone()
72    };
73}
74
75#[derive(Clone, Deserialize, Serialize, ServoPreferences)]
76pub struct Preferences {
77    pub fonts_default: String,
78    pub fonts_serif: String,
79    pub fonts_sans_serif: String,
80    pub fonts_monospace: String,
81    pub fonts_default_size: i64,
82    pub fonts_default_monospace_size: i64,
83    pub css_animations_testing_enabled: bool,
84    /// Start the devtools server at startup
85    pub devtools_server_enabled: bool,
86    /// Port number to start a server to listen to remote Firefox devtools connections.
87    /// 0 for random port.
88    pub devtools_server_port: i64,
89    pub dom_webgpu_enabled: bool,
90    /// List of comma-separated backends to be used by wgpu.
91    pub dom_webgpu_wgpu_backend: String,
92    pub dom_abort_controller_enabled: bool,
93    pub dom_adoptedstylesheet_enabled: bool,
94    pub dom_async_clipboard_enabled: bool,
95    pub dom_bluetooth_enabled: bool,
96    pub dom_bluetooth_testing_enabled: bool,
97    pub dom_allow_scripts_to_close_windows: bool,
98    pub dom_canvas_capture_enabled: bool,
99    pub dom_canvas_text_enabled: bool,
100    /// Selects canvas backend
101    ///
102    /// Available values:
103    /// - ` `/`auto`
104    /// - vello
105    /// - vello_cpu
106    pub dom_canvas_backend: String,
107    pub dom_clipboardevent_enabled: bool,
108    pub dom_composition_event_enabled: bool,
109    pub dom_cookiestore_enabled: bool,
110    pub dom_credential_management_enabled: bool,
111    pub dom_crypto_subtle_enabled: bool,
112    pub dom_customelements_enabled: bool,
113    pub dom_document_dblclick_timeout: i64,
114    pub dom_document_dblclick_dist: i64,
115    pub dom_fontface_enabled: bool,
116    pub dom_fullscreen_test: bool,
117    pub dom_gamepad_enabled: bool,
118    pub dom_geolocation_enabled: bool,
119    pub dom_indexeddb_enabled: bool,
120    pub dom_intersection_observer_enabled: bool,
121    pub dom_microdata_testing_enabled: bool,
122    pub dom_uievent_which_enabled: bool,
123    pub dom_mutation_observer_enabled: bool,
124    pub dom_navigator_sendbeacon_enabled: bool,
125    pub dom_notification_enabled: bool,
126    pub dom_offscreen_canvas_enabled: bool,
127    pub dom_permissions_enabled: bool,
128    pub dom_permissions_testing_allowed_in_nonsecure_contexts: bool,
129    pub dom_resize_observer_enabled: bool,
130    pub dom_script_asynch: bool,
131    pub dom_serviceworker_enabled: bool,
132    pub dom_serviceworker_timeout_seconds: i64,
133    pub dom_servo_helpers_enabled: bool,
134    pub dom_servoparser_async_html_tokenizer_enabled: bool,
135    pub dom_testable_crash_enabled: bool,
136    pub dom_testbinding_enabled: bool,
137    pub dom_testbinding_prefcontrolled_enabled: bool,
138    pub dom_testbinding_prefcontrolled2_enabled: bool,
139    pub dom_testbinding_preference_value_falsy: bool,
140    pub dom_testbinding_preference_value_quote_string_test: String,
141    pub dom_testbinding_preference_value_space_string_test: String,
142    pub dom_testbinding_preference_value_string_empty: String,
143    pub dom_testbinding_preference_value_string_test: String,
144    pub dom_testbinding_preference_value_truthy: bool,
145    pub dom_testing_element_activation_enabled: bool,
146    pub dom_testing_html_input_element_select_files_enabled: bool,
147    pub dom_testperf_enabled: bool,
148    // https://testutils.spec.whatwg.org#availability
149    pub dom_testutils_enabled: bool,
150    /// Enable WebGL2 APIs.
151    pub dom_webgl2_enabled: bool,
152    pub dom_webrtc_enabled: bool,
153    pub dom_webrtc_transceiver_enabled: bool,
154    pub dom_webvtt_enabled: bool,
155    pub dom_webxr_enabled: bool,
156    pub dom_webxr_test: bool,
157    pub dom_webxr_first_person_observer_view: bool,
158    pub dom_webxr_glwindow_enabled: bool,
159    pub dom_webxr_glwindow_left_right: bool,
160    pub dom_webxr_glwindow_red_cyan: bool,
161    pub dom_webxr_glwindow_spherical: bool,
162    pub dom_webxr_glwindow_cubemap: bool,
163    pub dom_webxr_hands_enabled: bool,
164    pub dom_webxr_layers_enabled: bool,
165    pub dom_webxr_openxr_enabled: bool,
166    pub dom_webxr_sessionavailable: bool,
167    pub dom_webxr_unsafe_assume_user_intent: bool,
168    pub dom_worklet_enabled: bool,
169    pub dom_worklet_blockingsleep: bool,
170    pub dom_worklet_testing_enabled: bool,
171    pub dom_worklet_timeout_ms: i64,
172    /// True to compile all WebRender shaders when Servo initializes. This is mostly
173    /// useful when modifying the shaders, to ensure they all compile after each change is
174    /// made.
175    pub gfx_precache_shaders: bool,
176    /// Whether or not antialiasing is enabled for text rendering.
177    pub gfx_text_antialiasing_enabled: bool,
178    /// Whether or not subpixel antialiasing is enabled for text rendering.
179    pub gfx_subpixel_text_antialiasing_enabled: bool,
180    pub gfx_texture_swizzling_enabled: bool,
181    /// The amount of image keys we request per batch for the image cache.
182    pub image_key_batch_size: i64,
183    /// Whether or not the DOM inspector should show shadow roots of user-agent shadow trees
184    pub inspector_show_servo_internal_shadow_roots: bool,
185    pub js_asmjs_enabled: bool,
186    pub js_asyncstack: bool,
187    pub js_baseline_interpreter_enabled: bool,
188    /// Whether to disable the jit within SpiderMonkey
189    pub js_disable_jit: bool,
190    pub js_baseline_jit_enabled: bool,
191    pub js_baseline_jit_unsafe_eager_compilation_enabled: bool,
192    pub js_discard_system_source: bool,
193    pub js_dump_stack_on_debuggee_would_run: bool,
194    pub js_ion_enabled: bool,
195    pub js_ion_offthread_compilation_enabled: bool,
196    pub js_ion_unsafe_eager_compilation_enabled: bool,
197    pub js_mem_gc_allocation_threshold_mb: i64,
198    pub js_mem_gc_allocation_threshold_factor: i64,
199    pub js_mem_gc_allocation_threshold_avoid_interrupt_factor: i64,
200    pub js_mem_gc_compacting_enabled: bool,
201    pub js_mem_gc_decommit_threshold_mb: i64,
202    pub js_mem_gc_dynamic_heap_growth_enabled: bool,
203    pub js_mem_gc_dynamic_mark_slice_enabled: bool,
204    pub js_mem_gc_empty_chunk_count_min: i64,
205    pub js_mem_gc_high_frequency_heap_growth_max: i64,
206    pub js_mem_gc_high_frequency_heap_growth_min: i64,
207    pub js_mem_gc_high_frequency_high_limit_mb: i64,
208    pub js_mem_gc_high_frequency_low_limit_mb: i64,
209    pub js_mem_gc_high_frequency_time_limit_ms: i64,
210    pub js_mem_gc_incremental_enabled: bool,
211    pub js_mem_gc_incremental_slice_ms: i64,
212    pub js_mem_gc_low_frequency_heap_growth: i64,
213    pub js_mem_gc_per_zone_enabled: bool,
214    pub js_mem_gc_zeal_frequency: i64,
215    pub js_mem_gc_zeal_level: i64,
216    pub js_mem_max: i64,
217    pub js_native_regex_enabled: bool,
218    pub js_offthread_compilation_enabled: bool,
219    pub js_shared_memory: bool,
220    pub js_throw_on_asmjs_validation_failure: bool,
221    pub js_throw_on_debuggee_would_run: bool,
222    pub js_timers_minimum_duration: i64,
223    pub js_wasm_baseline_enabled: bool,
224    pub js_wasm_enabled: bool,
225    pub js_wasm_ion_enabled: bool,
226    pub js_werror_enabled: bool,
227    pub largest_contentful_paint_enabled: bool,
228    pub layout_animations_test_enabled: bool,
229    pub layout_columns_enabled: bool,
230    pub layout_grid_enabled: bool,
231    pub layout_container_queries_enabled: bool,
232    pub layout_css_transition_behavior_enabled: bool,
233    pub layout_flexbox_enabled: bool,
234    pub layout_threads: i64,
235    pub layout_unimplemented: bool,
236    pub layout_variable_fonts_enabled: bool,
237    pub layout_writing_mode_enabled: bool,
238    /// Enable hardware acceleration for video playback.
239    pub media_glvideo_enabled: bool,
240    /// Enable a non-standard event handler for verifying behavior of media elements during tests.
241    pub media_testing_enabled: bool,
242    pub network_enforce_tls_enabled: bool,
243    pub network_enforce_tls_localhost: bool,
244    pub network_enforce_tls_onion: bool,
245    pub network_http_cache_disabled: bool,
246    pub network_local_directory_listing_enabled: bool,
247    pub network_mime_sniff: bool,
248    pub session_history_max_length: i64,
249    /// The background color of shell's viewport. This will be used by OpenGL's `glClearColor`.
250    pub shell_background_color_rgba: [f64; 4],
251    pub webgl_testing_context_creation_error: bool,
252    /// Number of workers per threadpool, if we fail to detect how much
253    /// parallelism is available at runtime.
254    pub threadpools_fallback_worker_num: i64,
255    /// Maximum number of workers for the Image Cache thread pool
256    pub threadpools_image_cache_workers_max: i64,
257    /// Maximum number of workers for the IndexedDB thread pool
258    pub threadpools_indexeddb_workers_max: i64,
259    /// Maximum number of workers for the Web Storage thread pool
260    pub threadpools_webstorage_workers_max: i64,
261    /// Maximum number of workers for the Networking async runtime thread pool
262    pub threadpools_async_runtime_workers_max: i64,
263    /// Maximum number of workers for the Core Resource Manager
264    pub threadpools_resource_workers_max: i64,
265    /// Maximum number of workers for webrender
266    pub threadpools_webrender_workers_max: i64,
267    /// The user-agent to use for Servo. This can also be set via [`UserAgentPlatform`] in
268    /// order to set the value to the default value for the given platform.
269    pub user_agent: String,
270    /// Whether or not the viewport meta tag is enabled.
271    pub viewport_meta_enabled: bool,
272    pub log_filter: String,
273}
274
275impl Preferences {
276    const fn const_default() -> Self {
277        Self {
278            css_animations_testing_enabled: false,
279            devtools_server_enabled: false,
280            devtools_server_port: 0,
281            dom_abort_controller_enabled: true,
282            dom_adoptedstylesheet_enabled: false,
283            dom_allow_scripts_to_close_windows: false,
284            dom_async_clipboard_enabled: false,
285            dom_bluetooth_enabled: false,
286            dom_bluetooth_testing_enabled: false,
287            dom_canvas_capture_enabled: false,
288            dom_canvas_text_enabled: true,
289            dom_canvas_backend: String::new(),
290            dom_clipboardevent_enabled: true,
291            dom_composition_event_enabled: false,
292            dom_cookiestore_enabled: false,
293            dom_credential_management_enabled: false,
294            dom_crypto_subtle_enabled: true,
295            dom_customelements_enabled: true,
296            dom_document_dblclick_dist: 1,
297            dom_document_dblclick_timeout: 300,
298            dom_fontface_enabled: false,
299            dom_fullscreen_test: false,
300            dom_gamepad_enabled: true,
301            dom_geolocation_enabled: false,
302            dom_indexeddb_enabled: false,
303            dom_intersection_observer_enabled: false,
304            dom_microdata_testing_enabled: false,
305            dom_uievent_which_enabled: true,
306            dom_mutation_observer_enabled: true,
307            dom_navigator_sendbeacon_enabled: false,
308            dom_notification_enabled: false,
309            dom_offscreen_canvas_enabled: false,
310            dom_permissions_enabled: false,
311            dom_permissions_testing_allowed_in_nonsecure_contexts: false,
312            dom_resize_observer_enabled: true,
313            dom_script_asynch: true,
314            dom_serviceworker_enabled: false,
315            dom_serviceworker_timeout_seconds: 60,
316            dom_servo_helpers_enabled: false,
317            dom_servoparser_async_html_tokenizer_enabled: false,
318            dom_testable_crash_enabled: false,
319            dom_testbinding_enabled: false,
320            dom_testbinding_prefcontrolled2_enabled: false,
321            dom_testbinding_prefcontrolled_enabled: false,
322            dom_testbinding_preference_value_falsy: false,
323            dom_testbinding_preference_value_quote_string_test: String::new(),
324            dom_testbinding_preference_value_space_string_test: String::new(),
325            dom_testbinding_preference_value_string_empty: String::new(),
326            dom_testbinding_preference_value_string_test: String::new(),
327            dom_testbinding_preference_value_truthy: false,
328            dom_testing_element_activation_enabled: false,
329            dom_testing_html_input_element_select_files_enabled: false,
330            dom_testperf_enabled: false,
331            dom_testutils_enabled: false,
332            dom_webgl2_enabled: false,
333            dom_webgpu_enabled: false,
334            dom_webgpu_wgpu_backend: String::new(),
335            dom_webrtc_enabled: false,
336            dom_webrtc_transceiver_enabled: false,
337            dom_webvtt_enabled: false,
338            dom_webxr_enabled: true,
339            dom_webxr_first_person_observer_view: false,
340            dom_webxr_glwindow_cubemap: false,
341            dom_webxr_glwindow_enabled: true,
342            dom_webxr_glwindow_left_right: false,
343            dom_webxr_glwindow_red_cyan: false,
344            dom_webxr_glwindow_spherical: false,
345            dom_webxr_hands_enabled: true,
346            dom_webxr_layers_enabled: false,
347            dom_webxr_openxr_enabled: true,
348            dom_webxr_sessionavailable: false,
349            dom_webxr_test: false,
350            dom_webxr_unsafe_assume_user_intent: false,
351            dom_worklet_blockingsleep: false,
352            dom_worklet_enabled: false,
353            dom_worklet_testing_enabled: false,
354            dom_worklet_timeout_ms: 10,
355            fonts_default: String::new(),
356            fonts_default_monospace_size: 13,
357            fonts_default_size: 16,
358            fonts_monospace: String::new(),
359            fonts_sans_serif: String::new(),
360            fonts_serif: String::new(),
361            gfx_precache_shaders: false,
362            gfx_text_antialiasing_enabled: true,
363            gfx_subpixel_text_antialiasing_enabled: true,
364            gfx_texture_swizzling_enabled: true,
365            image_key_batch_size: 10,
366            inspector_show_servo_internal_shadow_roots: false,
367            js_asmjs_enabled: true,
368            js_asyncstack: false,
369            js_baseline_interpreter_enabled: true,
370            js_baseline_jit_enabled: true,
371            js_baseline_jit_unsafe_eager_compilation_enabled: false,
372            js_disable_jit: false,
373            js_discard_system_source: false,
374            js_dump_stack_on_debuggee_would_run: false,
375            js_ion_enabled: true,
376            js_ion_offthread_compilation_enabled: true,
377            js_ion_unsafe_eager_compilation_enabled: false,
378            js_mem_gc_allocation_threshold_avoid_interrupt_factor: 100,
379            js_mem_gc_allocation_threshold_factor: 100,
380            js_mem_gc_allocation_threshold_mb: 30,
381            js_mem_gc_compacting_enabled: true,
382            js_mem_gc_decommit_threshold_mb: 32,
383            js_mem_gc_dynamic_heap_growth_enabled: true,
384            js_mem_gc_dynamic_mark_slice_enabled: true,
385            js_mem_gc_empty_chunk_count_min: 1,
386            js_mem_gc_high_frequency_heap_growth_max: 300,
387            js_mem_gc_high_frequency_heap_growth_min: 150,
388            js_mem_gc_high_frequency_high_limit_mb: 500,
389            js_mem_gc_high_frequency_low_limit_mb: 100,
390            js_mem_gc_high_frequency_time_limit_ms: 1000,
391            js_mem_gc_incremental_enabled: true,
392            js_mem_gc_incremental_slice_ms: 10,
393            js_mem_gc_low_frequency_heap_growth: 150,
394            js_mem_gc_per_zone_enabled: false,
395            js_mem_gc_zeal_frequency: 100,
396            js_mem_gc_zeal_level: 0,
397            js_mem_max: -1,
398            js_native_regex_enabled: true,
399            js_offthread_compilation_enabled: true,
400            js_shared_memory: true,
401            js_throw_on_asmjs_validation_failure: false,
402            js_throw_on_debuggee_would_run: false,
403            js_timers_minimum_duration: 1000,
404            js_wasm_baseline_enabled: true,
405            js_wasm_enabled: true,
406            js_wasm_ion_enabled: true,
407            js_werror_enabled: false,
408            largest_contentful_paint_enabled: false,
409            layout_animations_test_enabled: false,
410            layout_columns_enabled: false,
411            layout_container_queries_enabled: false,
412            layout_css_transition_behavior_enabled: true,
413            layout_flexbox_enabled: true,
414            layout_grid_enabled: false,
415            // TODO(mrobinson): This should likely be based on the number of processors.
416            layout_threads: 3,
417            layout_unimplemented: false,
418            layout_variable_fonts_enabled: false,
419            layout_writing_mode_enabled: false,
420            media_glvideo_enabled: false,
421            media_testing_enabled: false,
422            network_enforce_tls_enabled: false,
423            network_enforce_tls_localhost: false,
424            network_enforce_tls_onion: false,
425            network_http_cache_disabled: false,
426            network_local_directory_listing_enabled: true,
427            network_mime_sniff: false,
428            session_history_max_length: 20,
429            shell_background_color_rgba: [1.0, 1.0, 1.0, 1.0],
430            threadpools_async_runtime_workers_max: 6,
431            threadpools_fallback_worker_num: 3,
432            threadpools_image_cache_workers_max: 4,
433            threadpools_indexeddb_workers_max: 4,
434            threadpools_webstorage_workers_max: 4,
435            threadpools_resource_workers_max: 4,
436            threadpools_webrender_workers_max: 4,
437            webgl_testing_context_creation_error: false,
438            user_agent: String::new(),
439            viewport_meta_enabled: false,
440            log_filter: String::new(),
441        }
442    }
443}
444
445impl Default for Preferences {
446    fn default() -> Self {
447        let mut preferences = Self::const_default();
448        preferences.user_agent = UserAgentPlatform::default().to_user_agent_string();
449        preferences
450    }
451}
452
453pub enum UserAgentPlatform {
454    Desktop,
455    Android,
456    OpenHarmony,
457    Ios,
458}
459
460impl UserAgentPlatform {
461    /// Return the default `UserAgentPlatform` for this platform. This is
462    /// not an implementation of `Default` so that it can be `const`.
463    pub const fn default() -> Self {
464        if cfg!(target_os = "android") {
465            Self::Android
466        } else if cfg!(target_env = "ohos") {
467            Self::OpenHarmony
468        } else if cfg!(target_os = "ios") {
469            Self::Ios
470        } else {
471            Self::Desktop
472        }
473    }
474}
475
476impl UserAgentPlatform {
477    /// Convert this [`UserAgentPlatform`] into its corresponding `String` value, ie the
478    /// default user-agent to use for this platform.
479    pub fn to_user_agent_string(&self) -> String {
480        const SERVO_VERSION: &str = env!("CARGO_PKG_VERSION");
481        match self {
482            UserAgentPlatform::Desktop
483                if cfg!(all(target_os = "windows", target_arch = "x86_64")) =>
484            {
485                format!(
486                    "Mozilla/5.0 (Windows NT 10.0; Win64; {ARCH}rv:140.0) Servo/{SERVO_VERSION} Firefox/140.0"
487                )
488            },
489            UserAgentPlatform::Desktop if cfg!(target_os = "macos") => {
490                format!(
491                    "Mozilla/5.0 (Macintosh; Intel Mac OS X 10.15; rv:140.0) Servo/{SERVO_VERSION} Firefox/140.0"
492                )
493            },
494            UserAgentPlatform::Desktop => {
495                format!(
496                    "Mozilla/5.0 (X11; Linux {ARCH}; rv:140.0) Servo/{SERVO_VERSION} Firefox/140.0"
497                )
498            },
499            UserAgentPlatform::Android => {
500                format!(
501                    "Mozilla/5.0 (Android 10; Mobile; rv:140.0) Servo/{SERVO_VERSION} Firefox/140.0"
502                )
503            },
504            UserAgentPlatform::OpenHarmony => format!(
505                "Mozilla/5.0 (OpenHarmony; Mobile; rv:140.0) Servo/{SERVO_VERSION} Firefox/140.0"
506            ),
507            UserAgentPlatform::Ios => format!(
508                "Mozilla/5.0 (iPhone; CPU iPhone OS 18_6 like Mac OS X; rv:140.0) Servo/{SERVO_VERSION} Firefox/140.0"
509            ),
510        }
511    }
512}
servo_config/prefs.rs

servo_config/
prefs.rs
