deno/cli/napi/async.rs

// Copyright 2018-2024 the Deno authors. All rights reserved. MIT license.

use deno_runtime::deno_napi::*;

use crate::check_env;
use crate::napi::threadsafe_functions::SendPtr;

#[repr(C)]
pub struct AsyncWork {
  pub data: *mut c_void,
  pub execute: napi_async_execute_callback,
  pub complete: napi_async_complete_callback,
}

unsafe impl Send for AsyncWork {}
unsafe impl Sync for AsyncWork {}

#[napi_sym::napi_sym]
fn napi_create_async_work(
  _env: *mut Env,
  _async_resource: napi_value,
  _async_resource_name: napi_value,
  execute: napi_async_execute_callback,
  complete: napi_async_complete_callback,
  data: *mut c_void,
  result: *mut napi_async_work,
) -> napi_status {
  let mut work = AsyncWork {
    data,
    execute,
    complete,
  };
  let work_box = Box::new(work);
  *result = transmute::<*mut AsyncWork, _>(Box::into_raw(work_box));
  napi_ok
}

#[napi_sym::napi_sym]
fn napi_cancel_async_work(
  _env: &mut Env,
  _async_work: napi_async_work,
) -> napi_status {
  napi_ok
}

/// Frees a previously allocated work object.
#[napi_sym::napi_sym]
fn napi_delete_async_work(
  _env: &mut Env,
  work: napi_async_work,
) -> napi_status {
  let work = Box::from_raw(work as *mut AsyncWork);
  drop(work);

  napi_ok
}

#[napi_sym::napi_sym]
fn napi_queue_async_work(
  env_ptr: *mut Env,
  work: napi_async_work,
) -> napi_status {
  let work: &AsyncWork = &*(work as *const AsyncWork);
  let Some(env) = env_ptr.as_mut() else {
    return napi_invalid_arg;
  };

  let send_env = SendPtr(env_ptr);

  #[inline(always)]
  fn do_work(ptr: SendPtr<Env>, work: &AsyncWork) {
    // SAFETY: This is a valid async work queue call and it runs on the event loop thread
    unsafe {
      (work.execute)(ptr.0 as napi_env, work.data);
      (work.complete)(ptr.0 as napi_env, napi_ok, work.data);
    }
  }

  env.add_async_work(move || do_work(send_env, work));

  napi_ok
}

// NOTE: we don't support "async_hooks::AsyncContext" so these APIs are noops.
#[napi_sym::napi_sym]
fn napi_async_init(
  env: *mut Env,
  _async_resource: napi_value,
  _async_resource_name: napi_value,
  result: *mut *mut (),
) -> napi_status {
  check_env!(env);
  *result = ptr::null_mut();
  napi_ok
}

#[napi_sym::napi_sym]
fn napi_async_destroy(env: *mut Env, async_context: *mut ()) -> napi_status {
  check_env!(env);
  assert!(async_context.is_null());
  napi_ok
}