Mirrors/servo
1
0
Fork 0
mirror of https://github.com/servo/servo.git synced 2025-08-12 08:55:32 +01:00
Code Issues Projects Releases Packages Wiki Activity

script_bindings Start wrapping unsafe code in unsafe {} (#38545)

Browse source 
This is useful to better isolate `unsafe` code. Once all unsafe calls
are wrapped we can enable the Rust warning.  This also explicitly
disables the warning for generated code, which is a much more difficult
task. After this change there are 211 warnings left in
`script_bindings`.

Testing: This should not change behavior and is thus covered by existing
tests.

Signed-off-by: Martin Robinson <mrobinson@igalia.com>
This commit is contained in:
Martin Robinson 2025-08-08 14:21:31 +02:00 • committed by GitHub
parent c9541f2906
commit 5c307a38df
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
8 changed files with 91 additions and 70 deletions
Download patch file Download diff file Expand all files Collapse all files

16
components/script_bindings/callback.rs
View file

@ -96,11 +96,13 @@ impl<D: DomTypes> CallbackObject<D> {
unsafe fn init(&mut self, cx: JSContext, callback: *mut JSObject) { unsafe fn init(&mut self, cx: JSContext, callback: *mut JSObject) {
self.callback.set(callback); self.callback.set(callback);
self.permanent_js_root.set(ObjectValue(callback)); self.permanent_js_root.set(ObjectValue(callback));
assert!(AddRawValueRoot( unsafe {
*cx, assert!(AddRawValueRoot(
self.permanent_js_root.get_unsafe(), *cx,
b"CallbackObject::root\n".as_c_char_ptr() self.permanent_js_root.get_unsafe(),
)); b"CallbackObject::root\n".as_c_char_ptr()
));
}
} }
} }
@ -173,7 +175,7 @@ impl<D: DomTypes> CallbackFunction<D> {
/// # Safety /// # Safety
/// `callback` must point to a valid, non-null JSObject. /// `callback` must point to a valid, non-null JSObject.
pub unsafe fn init(&mut self, cx: JSContext, callback: *mut JSObject) { pub unsafe fn init(&mut self, cx: JSContext, callback: *mut JSObject) {
self.object.init(cx, callback); unsafe { self.object.init(cx, callback) };
} }
} }
@ -205,7 +207,7 @@ impl<D: DomTypes> CallbackInterface<D> {
/// # Safety /// # Safety
/// `callback` must point to a valid, non-null JSObject. /// `callback` must point to a valid, non-null JSObject.
pub unsafe fn init(&mut self, cx: JSContext, callback: *mut JSObject) { pub unsafe fn init(&mut self, cx: JSContext, callback: *mut JSObject) {
self.object.init(cx, callback); unsafe { self.object.init(cx, callback) };
} }
/// Returns the property with the given `name`, if it is a callable object, /// Returns the property with the given `name`, if it is a callable object,

21
components/script_bindings/codegen/codegen.py
View file

@ -53,11 +53,22 @@ from configuration import (
) )
AUTOGENERATED_WARNING_COMMENT = "/* THIS FILE IS AUTOGENERATED - DO NOT EDIT */\n\n" AUTOGENERATED_WARNING_COMMENT = "/* THIS FILE IS AUTOGENERATED - DO NOT EDIT */\n\n"
ALLOWED_WARNING_LIST = ['non_camel_case_types', 'non_upper_case_globals', 'unused_imports', ALLOWED_WARNING_LIST = [
'unused_variables', 'unused_assignments', 'unused_mut', 'non_camel_case_types',
'clippy::approx_constant', 'clippy::enum_variant_names', 'clippy::let_unit_value', 'non_upper_case_globals',
'clippy::needless_return', 'clippy::too_many_arguments', 'clippy::unnecessary_cast', 'unsafe_op_in_unsafe_fn',
'clippy::upper_case_acronyms'] 'unused_imports',
'unused_variables',
'unused_assignments',
'unused_mut',
'clippy::approx_constant',
'clippy::enum_variant_names',
'clippy::let_unit_value',
'clippy::needless_return',
'clippy::too_many_arguments',
'clippy::unnecessary_cast',
'clippy::upper_case_acronyms'
]
ALLOWED_WARNINGS = f"#![allow({','.join(ALLOWED_WARNING_LIST)})]\n\n" ALLOWED_WARNINGS = f"#![allow({','.join(ALLOWED_WARNING_LIST)})]\n\n"
FINALIZE_HOOK_NAME = '_finalize' FINALIZE_HOOK_NAME = '_finalize'

32
components/script_bindings/finalize.rs
View file

@ -18,14 +18,16 @@ use crate::weakref::{DOM_WEAK_SLOT, WeakBox, WeakReferenceable};
/// Drop the resources held by reserved slots of a global object /// Drop the resources held by reserved slots of a global object
unsafe fn do_finalize_global(obj: *mut JSObject) { unsafe fn do_finalize_global(obj: *mut JSObject) {
let protolist = get_proto_or_iface_array(obj); unsafe {
let list = (*protolist).as_mut_ptr(); let protolist = get_proto_or_iface_array(obj);
for idx in 0..PROTO_OR_IFACE_LENGTH as isize { let list = (*protolist).as_mut_ptr();
let entry = list.offset(idx); for idx in 0..PROTO_OR_IFACE_LENGTH as isize {
let value = *entry; let entry = list.offset(idx);
<*mut JSObject>::post_barrier(entry, value, ptr::null_mut()); let value = *entry;
<*mut JSObject>::post_barrier(entry, value, ptr::null_mut());
}
let _: Box<ProtoOrIfaceArray> = Box::from_raw(protolist);
} }
let _: Box<ProtoOrIfaceArray> = Box::from_raw(protolist);
} }
/// # Safety /// # Safety
@ -33,7 +35,7 @@ unsafe fn do_finalize_global(obj: *mut JSObject) {
pub(crate) unsafe fn finalize_common<T>(this: *const T) { pub(crate) unsafe fn finalize_common<T>(this: *const T) {
if !this.is_null() { if !this.is_null() {
// The pointer can be null if the object is the unforgeable holder of that interface. // The pointer can be null if the object is the unforgeable holder of that interface.
let _ = Box::from_raw(this as *mut T); let _ = unsafe { Box::from_raw(this as *mut T) };
} }
debug!("{} finalize: {:p}", type_name::<T>(), this); debug!("{} finalize: {:p}", type_name::<T>(), this);
} }
@ -42,8 +44,10 @@ pub(crate) unsafe fn finalize_common<T>(this: *const T) {
/// `obj` must point to a valid, non-null JS object. /// `obj` must point to a valid, non-null JS object.
/// `this` must point to a valid, non-null instance of T. /// `this` must point to a valid, non-null instance of T.
pub(crate) unsafe fn finalize_global<T>(obj: *mut JSObject, this: *const T) { pub(crate) unsafe fn finalize_global<T>(obj: *mut JSObject, this: *const T) {
do_finalize_global(obj); unsafe {
finalize_common::<T>(this); do_finalize_global(obj);
finalize_common::<T>(this);
}
} }
/// # Safety /// # Safety
@ -54,11 +58,11 @@ pub(crate) unsafe fn finalize_weak_referenceable<T: WeakReferenceable>(
this: *const T, this: *const T,
) { ) {
let mut slot = UndefinedValue(); let mut slot = UndefinedValue();
JS_GetReservedSlot(obj, DOM_WEAK_SLOT, &mut slot); unsafe { JS_GetReservedSlot(obj, DOM_WEAK_SLOT, &mut slot) };
let weak_box_ptr = slot.to_private() as *mut WeakBox<T>; let weak_box_ptr = slot.to_private() as *mut WeakBox<T>;
if !weak_box_ptr.is_null() { if !weak_box_ptr.is_null() {
let count = { let count = {
let weak_box = &*weak_box_ptr; let weak_box = unsafe { &*weak_box_ptr };
assert!(weak_box.value.get().is_some()); assert!(weak_box.value.get().is_some());
assert!(weak_box.count.get() > 0); assert!(weak_box.count.get() > 0);
weak_box.value.set(None); weak_box.value.set(None);
@ -67,8 +71,8 @@ pub(crate) unsafe fn finalize_weak_referenceable<T: WeakReferenceable>(
count count
}; };
if count == 0 { if count == 0 {
mem::drop(Box::from_raw(weak_box_ptr)); mem::drop(unsafe { Box::from_raw(weak_box_ptr) });
} }
} }
finalize_common::<T>(this); unsafe { finalize_common::<T>(this) };
} }

2
components/script_bindings/lib.rs
View file

@ -45,7 +45,7 @@ pub mod trace;
pub mod utils; pub mod utils;
pub mod weakref; pub mod weakref;
#[allow(non_snake_case)] #[allow(non_snake_case, unsafe_op_in_unsafe_fn)]
pub mod codegen { pub mod codegen {
pub mod Globals { pub mod Globals {
include!(concat!(env!("OUT_DIR"), "/Globals.rs")); include!(concat!(env!("OUT_DIR"), "/Globals.rs"));

2
components/script_bindings/mem.rs
View file

@ -16,5 +16,5 @@ pub(crate) unsafe fn malloc_size_of_including_raw_self<T: MallocSizeOf>(
ops: &mut MallocSizeOfOps, ops: &mut MallocSizeOfOps,
obj: *const c_void, obj: *const c_void,
) -> usize { ) -> usize {
ops.malloc_size_of(obj) + (*(obj as *const T)).size_of(ops) unsafe { ops.malloc_size_of(obj) + (*(obj as *const T)).size_of(ops) }
} }

20
components/script_bindings/root.rs
View file

@ -40,13 +40,13 @@ where
unsafe fn add_to_root_list(object: *const dyn JSTraceable) -> *const RootCollection { unsafe fn add_to_root_list(object: *const dyn JSTraceable) -> *const RootCollection {
assert_in_script(); assert_in_script();
STACK_ROOTS.with(|root_list| { STACK_ROOTS.with(|root_list| {
let root_list = &*root_list.get().unwrap(); let root_list = unsafe { &*root_list.get().unwrap() };
root_list.root(object); unsafe { root_list.root(object) };
root_list root_list
}) })
} }
let root_list = add_to_root_list(value.stable_trace_object()); let root_list = unsafe { add_to_root_list(value.stable_trace_object()) };
Root { value, root_list } Root { value, root_list }
} }
} }
@ -79,7 +79,7 @@ where
struct ReflectorStackRoot(Reflector); struct ReflectorStackRoot(Reflector);
unsafe impl JSTraceable for ReflectorStackRoot { unsafe impl JSTraceable for ReflectorStackRoot {
unsafe fn trace(&self, tracer: *mut JSTracer) { unsafe fn trace(&self, tracer: *mut JSTracer) {
trace_reflector(tracer, "on stack", &self.0); unsafe { trace_reflector(tracer, "on stack", &self.0) };
} }
} }
unsafe { &*(self.reflector() as *const Reflector as *const ReflectorStackRoot) } unsafe { &*(self.reflector() as *const Reflector as *const ReflectorStackRoot) }
@ -102,9 +102,9 @@ where
{ {
unsafe fn trace(&self, tracer: *mut JSTracer) { unsafe fn trace(&self, tracer: *mut JSTracer) {
if self.0.reflector().get_jsobject().is_null() { if self.0.reflector().get_jsobject().is_null() {
self.0.trace(tracer); unsafe { self.0.trace(tracer) };
} else { } else {
trace_reflector(tracer, "on stack", self.0.reflector()); unsafe { trace_reflector(tracer, "on stack", self.0.reflector()) };
} }
} }
} }
@ -283,8 +283,8 @@ where
pub unsafe fn reflect_with(self, obj: *mut JSObject) -> DomRoot<T> { pub unsafe fn reflect_with(self, obj: *mut JSObject) -> DomRoot<T> {
let ptr = self.as_ptr(); let ptr = self.as_ptr();
drop(self); drop(self);
let root = DomRoot::from_ref(&*ptr); let root = DomRoot::from_ref(unsafe { &*ptr });
root.init_reflector(obj); unsafe { root.init_reflector(obj) };
root root
} }
} }
@ -400,13 +400,13 @@ impl RootCollection {
/// Starts tracking a trace object. /// Starts tracking a trace object.
unsafe fn root(&self, object: *const dyn JSTraceable) { unsafe fn root(&self, object: *const dyn JSTraceable) {
assert_in_script(); assert_in_script();
(*self.roots.get()).push(object); unsafe { (*self.roots.get()).push(object) };
} }
/// Stops tracking a trace object, asserting if it isn't found. /// Stops tracking a trace object, asserting if it isn't found.
unsafe fn unroot(&self, object: *const dyn JSTraceable) { unsafe fn unroot(&self, object: *const dyn JSTraceable) {
assert_in_script(); assert_in_script();
let roots = &mut *self.roots.get(); let roots = unsafe { &mut *self.roots.get() };
match roots match roots
.iter() .iter()
.rposition(|r| std::ptr::addr_eq(*r as *const (), object as *const ())) .rposition(|r| std::ptr::addr_eq(*r as *const (), object as *const ()))

4
components/script_bindings/str.rs
View file

@ -321,8 +321,8 @@ pub fn serialize_jsval_to_json_utf8(
data: *mut std::ffi::c_void, data: *mut std::ffi::c_void,
) -> bool { ) -> bool {
let data = data as *mut ToJSONCallbackData; let data = data as *mut ToJSONCallbackData;
let string_chars = slice::from_raw_parts(string, len as usize); let string_chars = unsafe { slice::from_raw_parts(string, len as usize) };
(*data) unsafe { &mut *data }
.string .string
.get_or_insert_with(Default::default) .get_or_insert_with(Default::default)
.push_str(&String::from_utf16_lossy(string_chars)); .push_str(&String::from_utf16_lossy(string_chars));

64
components/script_bindings/trace.rs
View file

@ -106,14 +106,14 @@ pub unsafe trait CustomTraceable {
unsafe impl<T: CustomTraceable> CustomTraceable for Box<T> { unsafe impl<T: CustomTraceable> CustomTraceable for Box<T> {
#[inline] #[inline]
unsafe fn trace(&self, trc: *mut JSTracer) { unsafe fn trace(&self, trc: *mut JSTracer) {
(**self).trace(trc); unsafe { (**self).trace(trc) };
} }
} }
unsafe impl<T: JSTraceable> CustomTraceable for OnceCell<T> { unsafe impl<T: JSTraceable> CustomTraceable for OnceCell<T> {
unsafe fn trace(&self, tracer: *mut JSTracer) { unsafe fn trace(&self, tracer: *mut JSTracer) {
if let Some(value) = self.get() { if let Some(value) = self.get() {
value.trace(tracer) unsafe { value.trace(tracer) }
} }
} }
} }
@ -124,13 +124,13 @@ unsafe impl<T> CustomTraceable for Sender<T> {
unsafe impl<T: JSTraceable> CustomTraceable for ServoArc<T> { unsafe impl<T: JSTraceable> CustomTraceable for ServoArc<T> {
unsafe fn trace(&self, trc: *mut JSTracer) { unsafe fn trace(&self, trc: *mut JSTracer) {
(**self).trace(trc) unsafe { (**self).trace(trc) }
} }
} }
unsafe impl<T: JSTraceable> CustomTraceable for RwLock<T> { unsafe impl<T: JSTraceable> CustomTraceable for RwLock<T> {
unsafe fn trace(&self, trc: *mut JSTracer) { unsafe fn trace(&self, trc: *mut JSTracer) {
self.read().trace(trc) unsafe { self.read().trace(trc) }
} }
} }
@ -138,7 +138,7 @@ unsafe impl<T: JSTraceable + Eq + Hash> CustomTraceable for indexmap::IndexSet<T
#[inline] #[inline]
unsafe fn trace(&self, trc: *mut JSTracer) { unsafe fn trace(&self, trc: *mut JSTracer) {
for e in self.iter() { for e in self.iter() {
e.trace(trc); unsafe { e.trace(trc) };
} }
} }
} }
@ -149,7 +149,7 @@ unsafe impl<T: JSTraceable + 'static> CustomTraceable for SmallVec<[T; 1]> {
#[inline] #[inline]
unsafe fn trace(&self, trc: *mut JSTracer) { unsafe fn trace(&self, trc: *mut JSTracer) {
for e in self.iter() { for e in self.iter() {
e.trace(trc); unsafe { e.trace(trc) };
} }
} }
} }
@ -163,8 +163,8 @@ where
#[inline] #[inline]
unsafe fn trace(&self, trc: *mut JSTracer) { unsafe fn trace(&self, trc: *mut JSTracer) {
for (k, v) in self { for (k, v) in self {
k.trace(trc); unsafe { k.trace(trc) };
v.trace(trc); unsafe { v.trace(trc) };
} }
} }
} }
@ -175,7 +175,7 @@ where
{ {
unsafe fn trace(&self, tracer: *mut JSTracer) { unsafe fn trace(&self, tracer: *mut JSTracer) {
for (s, _origin) in self.iter() { for (s, _origin) in self.iter() {
s.trace(tracer) unsafe { s.trace(tracer) };
} }
} }
} }
@ -186,7 +186,7 @@ where
{ {
unsafe fn trace(&self, tracer: *mut JSTracer) { unsafe fn trace(&self, tracer: *mut JSTracer) {
for s in self.iter() { for s in self.iter() {
s.trace(tracer) unsafe { s.trace(tracer) };
} }
} }
} }
@ -196,7 +196,7 @@ where
S: JSTraceable + ::style::stylesheets::StylesheetInDocument + PartialEq + 'static, S: JSTraceable + ::style::stylesheets::StylesheetInDocument + PartialEq + 'static,
{ {
unsafe fn trace(&self, tracer: *mut JSTracer) { unsafe fn trace(&self, tracer: *mut JSTracer) {
self.stylesheets.trace(tracer) unsafe { self.stylesheets.trace(tracer) };
} }
} }
@ -205,7 +205,7 @@ where
Sink: JSTraceable + TendrilSink<UTF8>, Sink: JSTraceable + TendrilSink<UTF8>,
{ {
unsafe fn trace(&self, tracer: *mut JSTracer) { unsafe fn trace(&self, tracer: *mut JSTracer) {
self.inner_sink().trace(tracer); unsafe { self.inner_sink().trace(tracer) };
} }
} }
@ -228,15 +228,17 @@ where
ref ring, ref ring,
ref little, ref little,
} = *self; } = *self;
wrist.trace(trc); unsafe {
thumb_metacarpal.trace(trc); wrist.trace(trc);
thumb_phalanx_proximal.trace(trc); thumb_metacarpal.trace(trc);
thumb_phalanx_distal.trace(trc); thumb_phalanx_proximal.trace(trc);
thumb_phalanx_tip.trace(trc); thumb_phalanx_distal.trace(trc);
index.trace(trc); thumb_phalanx_tip.trace(trc);
middle.trace(trc); index.trace(trc);
ring.trace(trc); middle.trace(trc);
little.trace(trc); ring.trace(trc);
little.trace(trc);
}
} }
} }
@ -255,11 +257,13 @@ where
ref phalanx_distal, ref phalanx_distal,
ref phalanx_tip, ref phalanx_tip,
} = *self; } = *self;
metacarpal.trace(trc); unsafe {
phalanx_proximal.trace(trc); metacarpal.trace(trc);
phalanx_intermediate.trace(trc); phalanx_proximal.trace(trc);
phalanx_distal.trace(trc); phalanx_intermediate.trace(trc);
phalanx_tip.trace(trc); phalanx_distal.trace(trc);
phalanx_tip.trace(trc);
}
} }
} }
@ -281,7 +285,7 @@ unsafe impl<Handle: JSTraceable + Clone, Sink: TreeSink<Handle = Handle> + JSTra
} }
self.trace_handles(&tracer); self.trace_handles(&tracer);
self.sink.trace(trc); unsafe { self.sink.trace(trc) };
} }
} }
@ -290,7 +294,7 @@ unsafe impl<Handle: JSTraceable + Clone, Sink: TokenSink<Handle = Handle> + Cust
CustomTraceable for Tokenizer<Sink> CustomTraceable for Tokenizer<Sink>
{ {
unsafe fn trace(&self, trc: *mut JSTracer) { unsafe fn trace(&self, trc: *mut JSTracer) {
self.sink.trace(trc); unsafe { self.sink.trace(trc) };
} }
} }
@ -314,7 +318,7 @@ unsafe impl<Handle: JSTraceable + Clone, Sink: JSTraceable + XmlTreeSink<Handle
let tree_builder = &self.sink; let tree_builder = &self.sink;
tree_builder.trace_handles(&tracer); tree_builder.trace_handles(&tracer);
tree_builder.sink.trace(trc); unsafe { tree_builder.sink.trace(trc) };
} }
} }
@ -329,7 +333,7 @@ pub struct RootedTraceableBox<T: JSTraceable + 'static>(js::gc::RootedTraceableB
unsafe impl<T: JSTraceable + 'static> JSTraceable for RootedTraceableBox<T> { unsafe impl<T: JSTraceable + 'static> JSTraceable for RootedTraceableBox<T> {
unsafe fn trace(&self, tracer: *mut JSTracer) { unsafe fn trace(&self, tracer: *mut JSTracer) {
self.0.trace(tracer); unsafe { self.0.trace(tracer) };
} }
} }