napi/bindgen_runtime/
mod.rs

1use std::ffi::c_void;
2use std::rc::Rc;
3
4pub use callback_info::*;
5pub use ctor::ctor;
6pub use env::*;
7pub use iterator::Generator;
8pub use js_values::*;
9pub use module_register::*;
10
11use super::sys;
12use crate::{JsError, Result, Status};
13
14#[cfg(feature = "tokio_rt")]
15pub mod async_iterator;
16mod callback_info;
17mod env;
18mod error;
19pub mod iterator;
20mod js_values;
21mod module_register;
22
23pub trait ObjectFinalize: Sized {
24  #[allow(unused)]
25  fn finalize(self, env: Env) -> Result<()> {
26    Ok(())
27  }
28}
29
30/// # Safety
31///
32/// called when node wrapper objects destroyed
33#[doc(hidden)]
34pub(crate) unsafe extern "C" fn raw_finalize_unchecked<T: ObjectFinalize>(
35  env: sys::napi_env,
36  finalize_data: *mut c_void,
37  _finalize_hint: *mut c_void,
38) {
39  let data: Box<T> = unsafe { Box::from_raw(finalize_data.cast()) };
40  if let Err(err) = data.finalize(Env::from_raw(env)) {
41    let e: JsError = err.into();
42    unsafe { e.throw_into(env) };
43    return;
44  }
45  if let Some((_, ref_val, finalize_callbacks_ptr)) =
46    REFERENCE_MAP.borrow_mut(|reference_map| reference_map.remove(&finalize_data))
47  {
48    let finalize_callbacks_rc = unsafe { Rc::from_raw(finalize_callbacks_ptr) };
49
50    #[cfg(all(debug_assertions, not(target_family = "wasm")))]
51    {
52      let rc_strong_count = Rc::strong_count(&finalize_callbacks_rc);
53      // If `Rc` strong count is 2, it means the finalize of referenced `Object` is called before the `fn drop` of the `Reference`
54      // It always happened on exiting process
55      // In general, the `fn drop` would happen first
56      assert!(
57        rc_strong_count == 1 || rc_strong_count == 2,
58        "Rc strong count is: {}, it should be 1 or 2",
59        rc_strong_count
60      );
61    }
62    let finalize = unsafe { Box::from_raw(finalize_callbacks_rc.get()) };
63    finalize();
64    let delete_reference_status = unsafe { sys::napi_delete_reference(env, ref_val) };
65    debug_assert!(
66      delete_reference_status == sys::Status::napi_ok,
67      "Delete reference in finalize callback failed {}",
68      Status::from(delete_reference_status)
69    );
70  }
71}
72
73/// # Safety
74///
75/// called when node buffer is ready for gc
76#[doc(hidden)]
77pub unsafe extern "C" fn drop_buffer(
78  _env: sys::napi_env,
79  #[allow(unused)] finalize_data: *mut c_void,
80  finalize_hint: *mut c_void,
81) {
82  #[cfg(all(debug_assertions, not(windows)))]
83  {
84    js_values::BUFFER_DATA.with(|buffer_data| {
85      let mut buffer = buffer_data.lock().expect("Unlock Buffer data failed");
86      buffer.remove(&(finalize_data as *mut u8));
87    });
88  }
89  unsafe {
90    drop(Box::from_raw(finalize_hint as *mut Buffer));
91  }
92}
93
94/// # Safety
95///
96/// called when node buffer slice is ready for gc
97#[doc(hidden)]
98pub unsafe extern "C" fn drop_buffer_slice(
99  _env: sys::napi_env,
100  finalize_data: *mut c_void,
101  finalize_hint: *mut c_void,
102) {
103  let len = *unsafe { Box::from_raw(finalize_hint.cast()) };
104  #[cfg(all(debug_assertions, not(windows)))]
105  {
106    js_values::BUFFER_DATA.with(|buffer_data| {
107      let mut buffer = buffer_data.lock().expect("Unlock Buffer data failed");
108      buffer.remove(&(finalize_data as *mut u8));
109    });
110  }
111  unsafe {
112    drop(Vec::from_raw_parts(finalize_data, len, len));
113  }
114}
napi/bindgen_runtime/mod.rs

napi/bindgen_runtime/
mod.rs
