1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286
// Copyright 2018-2023 the Deno authors. All rights reserved. MIT license.
// Think of Resources as File Descriptors. They are integers that are allocated
// by the privileged side of Deno which refer to various rust objects that need
// to be persisted between various ops. For example, network sockets are
// resources. Resources may or may not correspond to a real operating system
// file descriptor (hence the different name).
use crate::error::not_supported;
use crate::io::AsyncResult;
use crate::io::BufMutView;
use crate::io::BufView;
use crate::io::WriteOutcome;
use crate::ResourceHandle;
use crate::ResourceHandleFd;
use anyhow::Error;
use std::any::type_name;
use std::any::Any;
use std::any::TypeId;
use std::borrow::Cow;
use std::rc::Rc;
/// Resources are Rust objects that are attached to a [deno_core::JsRuntime].
/// They are identified in JS by a numeric ID (the resource ID, or rid).
/// Resources can be created in ops. Resources can also be retrieved in ops by
/// their rid. Resources are not thread-safe - they can only be accessed from
/// the thread that the JsRuntime lives on.
///
/// Resources are reference counted in Rust. This means that they can be
/// cloned and passed around. When the last reference is dropped, the resource
/// is automatically closed. As long as the resource exists in the resource
/// table, the reference count is at least 1.
///
/// ### Readable
///
/// Readable resources are resources that can have data read from. Examples of
/// this are files, sockets, or HTTP streams.
///
/// Readables can be read from from either JS or Rust. In JS one can use
/// `Deno.core.read()` to read from a single chunk of data from a readable. In
/// Rust one can directly call `read()` or `read_byob()`. The Rust side code is
/// used to implement ops like `op_slice`.
///
/// A distinction can be made between readables that produce chunks of data
/// themselves (they allocate the chunks), and readables that fill up
/// bring-your-own-buffers (BYOBs). The former is often the case for framed
/// protocols like HTTP, while the latter is often the case for kernel backed
/// resources like files and sockets.
///
/// All readables must implement `read()`. If resources can support an optimized
/// path for BYOBs, they should also implement `read_byob()`. For kernel backed
/// resources it often makes sense to implement `read_byob()` first, and then
/// implement `read()` as an operation that allocates a new chunk with
/// `len == limit`, then calls `read_byob()`, and then returns a chunk sliced to
/// the number of bytes read. Kernel backed resources can use the
/// [deno_core::impl_readable_byob] macro to implement optimized `read_byob()`
/// and `read()` implementations from a single `Self::read()` method.
///
/// ### Writable
///
/// Writable resources are resources that can have data written to. Examples of
/// this are files, sockets, or HTTP streams.
///
/// Writables can be written to from either JS or Rust. In JS one can use
/// `Deno.core.write()` to write to a single chunk of data to a writable. In
/// Rust one can directly call `write()`. The latter is used to implement ops
/// like `op_slice`.
pub trait Resource: Any + 'static {
/// Returns a string representation of the resource which is made available
/// to JavaScript code through `op_resources`. The default implementation
/// returns the Rust type name, but specific resource types may override this
/// trait method.
fn name(&self) -> Cow<str> {
type_name::<Self>().into()
}
/// Read a single chunk of data from the resource. This operation returns a
/// `BufView` that represents the data that was read. If a zero length buffer
/// is returned, it indicates that the resource has reached EOF.
///
/// If this method is not implemented, the default implementation will error
/// with a "not supported" error.
///
/// If a readable can provide an optimized path for BYOBs, it should also
/// implement `read_byob()`.
fn read(self: Rc<Self>, limit: usize) -> AsyncResult<BufView> {
_ = limit;
Box::pin(futures::future::err(not_supported()))
}
/// Read a single chunk of data from the resource into the provided `BufMutView`.
///
/// This operation returns the number of bytes read. If zero bytes are read,
/// it indicates that the resource has reached EOF.
///
/// If this method is not implemented explicitly, the default implementation
/// will call `read()` and then copy the data into the provided buffer. For
/// readable resources that can provide an optimized path for BYOBs, it is
/// strongly recommended to override this method.
fn read_byob(
self: Rc<Self>,
mut buf: BufMutView,
) -> AsyncResult<(usize, BufMutView)> {
Box::pin(async move {
let read = self.read(buf.len()).await?;
let nread = read.len();
buf[..nread].copy_from_slice(&read);
Ok((nread, buf))
})
}
/// Write an error state to this resource, if the resource supports it.
fn write_error(self: Rc<Self>, _error: Error) -> AsyncResult<()> {
Box::pin(futures::future::err(not_supported()))
}
/// Write a single chunk of data to the resource. The operation may not be
/// able to write the entire chunk, in which case it should return the number
/// of bytes written. Additionally it should return the `BufView` that was
/// passed in.
///
/// If this method is not implemented, the default implementation will error
/// with a "not supported" error.
fn write(self: Rc<Self>, buf: BufView) -> AsyncResult<WriteOutcome> {
_ = buf;
Box::pin(futures::future::err(not_supported()))
}
/// Write an entire chunk of data to the resource. Unlike `write()`, this will
/// ensure the entire chunk is written. If the operation is not able to write
/// the entire chunk, an error is to be returned.
///
/// By default this method will call `write()` repeatedly until the entire
/// chunk is written. Resources that can write the entire chunk in a single
/// operation using an optimized path should override this method.
fn write_all(self: Rc<Self>, view: BufView) -> AsyncResult<()> {
Box::pin(async move {
let mut view = view;
let this = self;
while !view.is_empty() {
let resp = this.clone().write(view).await?;
match resp {
WriteOutcome::Partial {
nwritten,
view: new_view,
} => {
view = new_view;
view.advance_cursor(nwritten);
}
WriteOutcome::Full { .. } => break,
}
}
Ok(())
})
}
/// The same as [`read_byob()`][Resource::read_byob], but synchronous.
fn read_byob_sync(self: Rc<Self>, data: &mut [u8]) -> Result<usize, Error> {
_ = data;
Err(not_supported())
}
/// The same as [`write()`][Resource::write], but synchronous.
fn write_sync(self: Rc<Self>, data: &[u8]) -> Result<usize, Error> {
_ = data;
Err(not_supported())
}
/// The shutdown method can be used to asynchronously close the resource. It
/// is not automatically called when the resource is dropped or closed.
///
/// If this method is not implemented, the default implementation will error
/// with a "not supported" error.
fn shutdown(self: Rc<Self>) -> AsyncResult<()> {
Box::pin(futures::future::err(not_supported()))
}
/// Resources may implement the `close()` trait method if they need to do
/// resource specific clean-ups, such as cancelling pending futures, after a
/// resource has been removed from the resource table.
fn close(self: Rc<Self>) {}
/// Resources backed by a file descriptor or socket handle can let ops know
/// to allow for low-level optimizations.
fn backing_handle(self: Rc<Self>) -> Option<ResourceHandle> {
#[allow(deprecated)]
self.backing_fd().map(ResourceHandle::Fd)
}
/// Resources backed by a file descriptor can let ops know to allow for
/// low-level optimizations.
#[deprecated = "Use backing_handle"]
fn backing_fd(self: Rc<Self>) -> Option<ResourceHandleFd> {
None
}
fn size_hint(&self) -> (u64, Option<u64>) {
(0, None)
}
}
impl dyn Resource {
#[inline(always)]
fn is<T: Resource>(&self) -> bool {
self.type_id() == TypeId::of::<T>()
}
#[inline(always)]
#[allow(clippy::needless_lifetimes)]
pub fn downcast_rc<'a, T: Resource>(self: &'a Rc<Self>) -> Option<&'a Rc<T>> {
if self.is::<T>() {
let ptr = self as *const Rc<_> as *const Rc<T>;
// TODO(piscisaureus): safety comment
#[allow(clippy::undocumented_unsafe_blocks)]
Some(unsafe { &*ptr })
} else {
None
}
}
}
#[macro_export]
macro_rules! impl_readable_byob {
() => {
fn read(
self: ::std::rc::Rc<Self>,
limit: ::core::primitive::usize,
) -> AsyncResult<$crate::BufView> {
::std::boxed::Box::pin(async move {
let mut vec = ::std::vec![0; limit];
let nread = self.read(&mut vec).await?;
if nread != vec.len() {
vec.truncate(nread);
}
let view = $crate::BufView::from(vec);
::std::result::Result::Ok(view)
})
}
fn read_byob(
self: ::std::rc::Rc<Self>,
mut buf: $crate::BufMutView,
) -> AsyncResult<(::core::primitive::usize, $crate::BufMutView)> {
::std::boxed::Box::pin(async move {
let nread = self.read(buf.as_mut()).await?;
::std::result::Result::Ok((nread, buf))
})
}
};
}
#[macro_export]
macro_rules! impl_writable {
(__write) => {
fn write(
self: ::std::rc::Rc<Self>,
view: $crate::BufView,
) -> $crate::AsyncResult<$crate::WriteOutcome> {
::std::boxed::Box::pin(async move {
let nwritten = self.write(&view).await?;
::std::result::Result::Ok($crate::WriteOutcome::Partial {
nwritten,
view,
})
})
}
};
(__write_all) => {
fn write_all(
self: ::std::rc::Rc<Self>,
view: $crate::BufView,
) -> $crate::AsyncResult<()> {
::std::boxed::Box::pin(async move {
self.write_all(&view).await?;
::std::result::Result::Ok(())
})
}
};
() => {
$crate::impl_writable!(__write);
};
(with_all) => {
$crate::impl_writable!(__write);
$crate::impl_writable!(__write_all);
};
}