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 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765
#![allow(clippy::too_many_arguments)]
use std::ops::DerefMut;
use std::time::Instant;
use crate::database_logger::{BacktraceFrame, BacktraceProvider, ModuleBacktrace, Record};
use crate::execution_context::ExecutionContext;
use crate::host::scheduler::{ScheduleError, ScheduledReducerId};
use crate::host::timestamp::Timestamp;
use crate::host::wasm_common::instrumentation;
use crate::host::wasm_common::module_host_actor::ExecutionTimings;
use crate::host::wasm_common::{
err_to_errno, instrumentation::CallTimes, AbiRuntimeError, BufferIdx, BufferIterIdx, BufferIters, Buffers,
TimingSpan, TimingSpanIdx, TimingSpanSet,
};
use crate::host::AbiCall;
use anyhow::{anyhow, Context};
use wasmtime::{AsContext, Caller, StoreContextMut};
use crate::host::instance_env::InstanceEnv;
use super::{Mem, MemView, NullableMemOp, WasmError, WasmPointee, WasmPtr};
#[cfg(not(feature = "spacetimedb-wasm-instance-env-times"))]
use instrumentation::noop as span;
#[cfg(feature = "spacetimedb-wasm-instance-env-times")]
use instrumentation::op as span;
/// A `WasmInstanceEnv` provides the connection between a module
/// and the database.
///
/// A `WasmInstanceEnv` associates an `InstanceEnv` (responsible for
/// the database instance and its associated state) with a wasm
/// `Mem`. It also contains the resources (`Buffers` and
/// `BufferIters`) needed to manage the ABI contract between modules
/// and the host.
///
/// Once created, a `WasmInstanceEnv` must be instantiated with a `Mem`
/// exactly once.
///
/// Some of the state associated to a `WasmInstanceEnv` is per reducer invocation.
/// For instance, module-defined timing spans are per reducer.
pub(super) struct WasmInstanceEnv {
/// The database `InstanceEnv` associated to this instance.
instance_env: InstanceEnv,
/// The `Mem` associated to this instance. At construction time,
/// this is always `None`. The `Mem` instance is extracted from the
/// instance exports, and after instantiation is complete, this will
/// always be `Some`.
mem: Option<Mem>,
/// The slab of `Buffers` created for this instance.
buffers: Buffers,
/// The slab of `BufferIters` created for this instance.
iters: BufferIters,
/// Track time spent in module-defined spans.
timing_spans: TimingSpanSet,
/// The point in time the last reducer call started at.
reducer_start: Instant,
/// Track time spent in all wasm instance env calls (aka syscall time).
///
/// Each function, like `insert`, will add the `Duration` spent in it
/// to this tracker.
call_times: CallTimes,
/// The last, including current, reducer to be executed by this environment.
reducer_name: String,
}
type WasmResult<T> = Result<T, WasmError>;
type RtResult<T> = anyhow::Result<T>;
/// Wraps an `InstanceEnv` with the magic necessary to push
/// and pull bytes from webassembly memory.
impl WasmInstanceEnv {
/// Create a new `WasmEnstanceEnv` from the given `InstanceEnv`.
pub fn new(instance_env: InstanceEnv) -> Self {
let reducer_start = Instant::now();
Self {
instance_env,
mem: None,
buffers: Default::default(),
iters: Default::default(),
timing_spans: Default::default(),
reducer_start,
call_times: CallTimes::new(),
reducer_name: String::from(""),
}
}
/// Finish the instantiation of this instance with the provided `Mem`.
pub fn instantiate(&mut self, mem: Mem) {
assert!(self.mem.is_none());
self.mem = Some(mem);
}
/// Returns a reference to the memory, assumed to be initialized.
pub fn get_mem(&self) -> Mem {
self.mem.expect("Initialized memory")
}
fn mem_env<'a>(ctx: impl Into<StoreContextMut<'a, Self>>) -> (&'a mut MemView, &'a mut Self) {
let ctx = ctx.into();
let mem = ctx.data().get_mem();
mem.view_and_store_mut(ctx)
}
/// Return a reference to the `InstanceEnv`,
/// which is responsible for DB instance and associated state.
pub fn instance_env(&self) -> &InstanceEnv {
&self.instance_env
}
/// Take ownership of a particular `Buffer` from this instance.
pub fn take_buffer(&mut self, idx: BufferIdx) -> Option<bytes::Bytes> {
self.buffers.take(idx)
}
/// Take ownership of the given `data` and give back a `BufferIdx`
/// as a handle to that data.
pub fn insert_buffer(&mut self, data: bytes::Bytes) -> BufferIdx {
self.buffers.insert(data)
}
/// Signal to this `WasmInstanceEnv` that a reducer call is beginning.
pub fn start_reducer(&mut self, name: &str) {
self.reducer_start = Instant::now();
self.reducer_name = name.to_owned();
}
/// Signal to this `WasmInstanceEnv` that a reducer call is over.
/// This resets all of the state associated to a single reducer call,
/// and returns instrumentation records.
pub fn finish_reducer(&mut self) -> ExecutionTimings {
// For the moment, we only explicitly clear the set of buffers and the
// "syscall" times.
// TODO: should we be clearing `iters` and/or `timing_spans`?
self.buffers.clear();
let total_duration = self.reducer_start.elapsed();
// Taking the call times record also resets timings to 0s for the next call.
let wasm_instance_env_call_times = self.call_times.take();
ExecutionTimings {
total_duration,
wasm_instance_env_call_times,
}
}
/// Returns an execution context for a reducer call.
fn reducer_context(&self) -> Result<impl DerefMut<Target = ExecutionContext> + '_, WasmError> {
self.instance_env().get_ctx().map_err(|err| WasmError::Db(err.into()))
}
/// Call the function `f` with the name `func`.
/// The function `f` is provided with the callers environment and the host's memory.
///
/// One of `cvt`, `cvt_ret`, or `cvt_noret` should be used in the implementation of any
/// host call, to provide consistent error handling and instrumentation.
///
/// Some database errors are logged but are otherwise regarded as `Ok(_)`.
/// See `err_to_errno` for a list.
fn cvt(
mut caller: Caller<'_, Self>,
func: AbiCall,
f: impl FnOnce(&mut Caller<'_, Self>) -> WasmResult<()>,
) -> RtResult<u32> {
let span_start = span::CallSpanStart::new(func);
// Call `f` with the caller and a handle to the memory.
let result = f(&mut caller);
// Track the span of this call.
let span = span_start.end();
span::record_span(&mut caller.data_mut().call_times, span);
// Bail if there were no errors.
let Err(err) = result else {
return Ok(0);
};
// Handle any errors.
Err(match err {
WasmError::Db(err) => match err_to_errno(&err) {
Some(errno) => {
log::debug!("abi call to {func} returned a normal error: {err:#}");
return Ok(errno.into());
}
None => anyhow::Error::from(AbiRuntimeError { func, err }),
},
WasmError::Wasm(err) => err,
})
}
/// Call the function `f` with any return value being written to the pointer `out`.
///
/// Otherwise, `cvt_ret` (this function) behaves as `cvt`.
///
/// One of `cvt`, `cvt_ret`, or `cvt_noret` should be used in the implementation of any
/// host call, to provide consistent error handling and instrumentation.
///
/// This method should be used as opposed to a manual implementation,
/// as it helps with upholding the safety invariants of [`bindings_sys::call`].
///
/// Returns an error if writing `T` to `out` errors.
fn cvt_ret<T: WasmPointee>(
caller: Caller<'_, Self>,
call: AbiCall,
out: WasmPtr<T>,
f: impl FnOnce(&mut Caller<'_, Self>) -> WasmResult<T>,
) -> RtResult<u32> {
Self::cvt(caller, call, |caller| {
f(caller).and_then(|ret| {
let (mem, _) = Self::mem_env(caller);
ret.write_to(mem, out)
})
})
}
/// Call the function `f`.
///
/// This is the version of `cvt` or `cvt_ret` for functions with no return value.
/// One of `cvt`, `cvt_ret`, or `cvt_noret` should be used in the implementation of any
/// host call, to provide consistent error handling and instrumentation.
fn cvt_noret(mut caller: Caller<'_, Self>, call: AbiCall, f: impl FnOnce(&mut Caller<'_, Self>)) {
let span_start = span::CallSpanStart::new(call);
// Call `f` with the caller and a handle to the memory.
f(&mut caller);
let span = span_start.end();
span::record_span(&mut caller.data_mut().call_times, span);
}
/// Schedules a reducer to be called asynchronously at `time`.
///
/// The reducer is named as the valid UTF-8 slice `(name, name_len)`,
/// and is passed the slice `(args, args_len)` as its argument.
///
/// A generated schedule id is assigned to the reducer.
/// This id is written to the pointer `out`.
///
/// Returns an error if
/// - the `time` delay exceeds `64^6 - 1` milliseconds from now
/// - `name` does not point to valid UTF-8
/// - `name + name_len` or `args + args_len` overflow a 64-bit integer
/// - writing to `out` overflows a 64-bit integer
#[tracing::instrument(skip_all)]
pub fn schedule_reducer(
caller: Caller<'_, Self>,
name: WasmPtr<u8>,
name_len: u32,
args: WasmPtr<u8>,
args_len: u32,
time: u64,
out: WasmPtr<u64>,
) -> RtResult<()> {
Self::cvt_ret(caller, AbiCall::ScheduleReducer, out, |caller| {
let (mem, env) = Self::mem_env(caller);
// Read the index name as a string from `(name, name_len)`.
let name = mem.deref_str(name, name_len)?.to_owned();
// Read the reducer's arguments as a byte slice.
let args = mem.deref_slice(args, args_len)?.to_vec();
// Schedule it!
let ScheduledReducerId(id) =
env.instance_env
.schedule(name, args, Timestamp(time))
.map_err(|e| match e {
ScheduleError::DelayTooLong(_) => anyhow!("requested delay is too long"),
ScheduleError::IdTransactionError(_) => {
anyhow!("transaction to acquire ScheduleReducerId failed")
}
})?;
Ok(id)
})
.map(|_| ())
}
/// Unschedule a reducer using the same `id` generated as when it was scheduled.
///
/// This assumes that the reducer hasn't already been executed.
#[tracing::instrument(skip_all)]
pub fn cancel_reducer(caller: Caller<'_, Self>, id: u64) {
Self::cvt_noret(caller, AbiCall::CancelReducer, |caller| {
caller.data().instance_env.cancel_reducer(ScheduledReducerId(id))
})
}
/// Log at `level` a `message` message occuring in `filename:line_number`
/// with [`target`] being the module path at the `log!` invocation site.
///
/// These various pointers are interpreted lossily as UTF-8 strings with a corresponding `_len`.
///
/// The `target` and `filename` pointers are ignored by passing `NULL`.
/// The line number is ignored if `line_number == u32::MAX`.
///
/// No message is logged if
/// - `target != NULL && target + target_len > u64::MAX`
/// - `filename != NULL && filename + filename_len > u64::MAX`
/// - `message + message_len > u64::MAX`
///
/// [`target`]: https://docs.rs/log/latest/log/struct.Record.html#method.target
#[tracing::instrument(skip_all)]
pub fn console_log(
caller: Caller<'_, Self>,
level: u32,
target: WasmPtr<u8>,
target_len: u32,
filename: WasmPtr<u8>,
filename_len: u32,
line_number: u32,
message: WasmPtr<u8>,
message_len: u32,
) {
let do_console_log = |caller: &mut Caller<'_, Self>| -> WasmResult<()> {
let env = caller.data();
let mem = env.get_mem().view(&caller);
// Read the `target`, `filename`, and `message` strings from WASM memory.
let target = mem.deref_str_lossy(target, target_len).check_nullptr()?;
let filename = mem.deref_str_lossy(filename, filename_len).check_nullptr()?;
let message = mem.deref_str_lossy(message, message_len)?;
// The line number cannot be `u32::MAX` as this represents `Option::None`.
let line_number = (line_number != u32::MAX).then_some(line_number);
let record = Record {
// TODO: figure out whether to use walltime now or logical reducer now (env.reducer_start)
ts: chrono::Utc::now(),
target: target.as_deref(),
filename: filename.as_deref(),
line_number,
message: &message,
};
// Write the log record to the `DatabaseLogger` in the database instance context (dbic).
env.instance_env
.console_log((level as u8).into(), &record, &caller.as_context());
Ok(())
};
Self::cvt_noret(caller, AbiCall::ConsoleLog, |caller| {
let _ = do_console_log(caller);
})
}
/// Inserts a row into the table identified by `table_id`,
/// where the row is read from the byte slice `row` in WASM memory,
/// lasting `row_len` bytes.
///
/// The `(row, row_len)` slice must be a BSATN-encoded `ProductValue`
/// matching the table's `ProductType` row-schema.
/// The `row` pointer is written to with the inserted row re-encoded.
/// This is due to auto-incrementing columns.
///
/// Returns an error if
/// - a table with the provided `table_id` doesn't exist
/// - there were unique constraint violations
/// - `row + row_len` overflows a 64-bit integer
/// - `(row, row_len)` doesn't decode from BSATN to a `ProductValue`
/// according to the `ProductType` that the table's schema specifies.
#[tracing::instrument(skip_all)]
pub fn insert(caller: Caller<'_, Self>, table_id: u32, row: WasmPtr<u8>, row_len: u32) -> RtResult<u32> {
Self::cvt(caller, AbiCall::Insert, |caller| {
let (mem, env) = Self::mem_env(caller);
// Read the row from WASM memory into a buffer.
let row_buffer = mem.deref_slice_mut(row, row_len)?;
// Insert the row into the DB. We get back the decoded version.
// Then re-encode and write that back into WASM memory at `row`.
// We're doing this because of autoinc.
let ctx = env.reducer_context()?;
let new_row = env.instance_env.insert(&ctx, table_id.into(), row_buffer)?;
new_row.encode(&mut { row_buffer });
Ok(())
})
}
/// Deletes all rows in the table identified by `table_id`
/// where the column identified by `cols` matches the byte string,
/// in WASM memory, pointed to at by `value`.
///
/// Matching is defined by BSATN-decoding `value` to an `AlgebraicValue`
/// according to the column's schema and then `Ord for AlgebraicValue`.
///
/// The number of rows deleted is written to the WASM pointer `out`.
///
/// Returns an error if
/// - a table with the provided `table_id` doesn't exist
/// - no columns were deleted
/// - `col_id` does not identify a column of the table,
/// - `(value, value_len)` doesn't decode from BSATN to an `AlgebraicValue`
/// according to the `AlgebraicType` that the table's schema specifies for `col_id`.
/// - `value + value_len` overflows a 64-bit integer
/// - writing to `out` would overflow a 32-bit integer
pub fn delete_by_col_eq(
caller: Caller<'_, Self>,
table_id: u32,
col_id: u32,
value: WasmPtr<u8>,
value_len: u32,
out: WasmPtr<u32>,
) -> RtResult<u32> {
Self::cvt_ret(caller, AbiCall::DeleteByColEq, out, |caller| {
let (mem, env) = Self::mem_env(caller);
let ctx = env.reducer_context()?;
let value = mem.deref_slice(value, value_len)?;
let count = env
.instance_env
.delete_by_col_eq(&ctx, table_id.into(), col_id.into(), value)?;
Ok(count)
})
}
/// Deletes those rows, in the table identified by `table_id`,
/// that match any row in `relation`.
///
/// Matching is defined by first BSATN-decoding
/// the byte string pointed to at by `relation` to a `Vec<ProductValue>`
/// according to the row schema of the table
/// and then using `Ord for AlgebraicValue`.
///
/// The number of rows deleted is written to the WASM pointer `out`.
///
/// Returns an error if
/// - a table with the provided `table_id` doesn't exist
/// - `(relation, relation_len)` doesn't decode from BSATN to a `Vec<ProductValue>`
/// according to the `ProductValue` that the table's schema specifies for rows.
/// - `relation + relation_len` overflows a 64-bit integer
/// - writing to `out` would overflow a 32-bit integer
#[tracing::instrument(skip_all)]
pub fn delete_by_rel(
caller: Caller<'_, Self>,
table_id: u32,
relation: WasmPtr<u8>,
relation_len: u32,
out: WasmPtr<u32>,
) -> RtResult<u32> {
Self::cvt_ret(caller, AbiCall::DeleteByRel, out, |caller| {
let (mem, env) = Self::mem_env(caller);
let relation = mem.deref_slice(relation, relation_len)?;
Ok(env.instance_env.delete_by_rel(table_id.into(), relation)?)
})
}
/// Queries the `table_id` associated with the given (table) `name`
/// where `name` points to a UTF-8 slice in WASM memory of `name_len` bytes.
///
/// The table id is written into the `out` pointer.
///
/// Returns an error if
/// - a table with the provided `table_id` doesn't exist
/// - the slice `(name, name_len)` is not valid UTF-8
/// - `name + name_len` overflows a 64-bit address.
/// - writing to `out` overflows a 32-bit integer
#[tracing::instrument(skip_all)]
pub fn get_table_id(
caller: Caller<'_, Self>,
name: WasmPtr<u8>,
name_len: u32,
out: WasmPtr<u32>,
) -> RtResult<u32> {
Self::cvt_ret::<u32>(caller, AbiCall::GetTableId, out, |caller| {
let (mem, env) = Self::mem_env(caller);
// Read the table name from WASM memory.
let name = mem.deref_str(name, name_len)?;
// Query the table id.
Ok(env.instance_env.get_table_id(name)?.into())
})
}
/// Creates an index with the name `index_name` and type `index_type`,
/// on a product of the given columns in `col_ids`
/// in the table identified by `table_id`.
///
/// Here `index_name` points to a UTF-8 slice in WASM memory
/// and `col_ids` points to a byte slice in WASM memory with each element being a column.
///
/// Currently only single-column-indices are supported
/// and they may only be of the btree index type.
///
/// Returns an error if
/// - a table with the provided `table_id` doesn't exist
/// - the slice `(index_name, index_name_len)` is not valid UTF-8
/// - `index_name + index_name_len` or `col_ids + col_len` overflow a 64-bit integer
/// - `index_type > 1`
///
/// Panics if `index_type == 1` or `col_ids.len() != 1`.
#[tracing::instrument(skip_all)]
pub fn create_index(
caller: Caller<'_, Self>,
index_name: WasmPtr<u8>,
index_name_len: u32,
table_id: u32,
index_type: u32,
col_ids: WasmPtr<u8>,
col_len: u32,
) -> RtResult<u32> {
Self::cvt(caller, AbiCall::CreateIndex, |caller| {
let (mem, env) = Self::mem_env(caller);
// Read the index name from WASM memory.
let index_name = mem.deref_str(index_name, index_name_len)?.into();
// Read the column ids on which to create an index from WASM memory.
// This may be one column or an index on several columns.
let cols = mem.deref_slice(col_ids, col_len)?.to_vec();
env.instance_env
.create_index(index_name, table_id.into(), index_type as u8, cols)?;
Ok(())
})
}
/// Finds all rows in the table identified by `table_id`,
/// where the row has a column, identified by `cols`,
/// with data matching the byte string, in WASM memory, pointed to at by `val`.
///
/// Matching is defined BSATN-decoding `val` to an `AlgebraicValue`
/// according to the column's schema and then `Ord for AlgebraicValue`.
///
/// The rows found are BSATN-encoded and then concatenated.
/// The resulting byte string from the concatenation is written
/// to a fresh buffer with the buffer's identifier written to the WASM pointer `out`.
///
/// Returns an error if
/// - a table with the provided `table_id` doesn't exist
/// - `col_id` does not identify a column of the table,
/// - `(val, val_len)` cannot be decoded to an `AlgebraicValue`
/// typed at the `AlgebraicType` of the column,
/// - `val + val_len` overflows a 64-bit integer
pub fn iter_by_col_eq(
caller: Caller<'_, Self>,
table_id: u32,
col_id: u32,
val: WasmPtr<u8>,
val_len: u32,
out: WasmPtr<BufferIdx>,
) -> RtResult<u32> {
Self::cvt_ret(caller, AbiCall::IterByColEq, out, |caller| {
let (mem, env) = Self::mem_env(caller);
// Read the test value from WASM memory.
let value = mem.deref_slice(val, val_len)?;
// Retrieve the execution context for the current reducer.
let ctx = env.reducer_context()?;
// Find the relevant rows.
let data = env
.instance_env
.iter_by_col_eq(&ctx, table_id.into(), col_id.into(), value)?;
// Release the immutable borrow of `env.buffers` by dropping `ctx`.
drop(ctx);
// Insert the encoded + concatenated rows into a new buffer and return its id.
Ok(env.buffers.insert(data.into()))
})
}
/// Start iteration on each row, as bytes, of a table identified by `table_id`.
///
/// The iterator is registered in the host environment
/// under an assigned index which is written to the `out` pointer provided.
///
/// Returns an error if
/// - a table with the provided `table_id` doesn't exist
// #[tracing::instrument(skip_all)]
pub fn iter_start(caller: Caller<'_, Self>, table_id: u32, out: WasmPtr<BufferIterIdx>) -> RtResult<u32> {
Self::cvt_ret(caller, AbiCall::IterStart, out, |caller| {
let env = caller.data_mut();
// Retrieve the execution context for the current reducer.
let ctx = env.reducer_context()?;
// Collect the iterator chunks.
let chunks = env.instance_env.iter_chunks(&ctx, table_id.into())?;
drop(ctx);
// Register the iterator and get back the index to write to `out`.
// Calls to the iterator are done through dynamic dispatch.
Ok(env.iters.insert(chunks.into_iter()))
})
}
/// Like [`WasmInstanceEnv::iter_start`], start iteration on each row,
/// as bytes, of a table identified by `table_id`.
///
/// The rows are filtered through `filter`, which is read from WASM memory
/// and is encoded in the embedded language defined by `spacetimedb_lib::filter::Expr`.
///
/// The iterator is registered in the host environment
/// under an assigned index which is written to the `out` pointer provided.
///
/// Returns an error if
/// - a table with the provided `table_id` doesn't exist
/// - `(filter, filter_len)` doesn't decode to a filter expression
/// - `filter + filter_len` overflows a 64-bit integer
pub fn iter_start_filtered(
caller: Caller<'_, Self>,
table_id: u32,
filter: WasmPtr<u8>,
filter_len: u32,
out: WasmPtr<BufferIterIdx>,
) -> RtResult<u32> {
Self::cvt_ret(caller, AbiCall::IterStartFiltered, out, |caller| {
let (mem, env) = Self::mem_env(caller);
// Retrieve the execution context for the current reducer.
let ctx = env.reducer_context()?;
// Read the slice `(filter, filter_len)`.
let filter = mem.deref_slice(filter, filter_len)?;
// Construct the iterator.
let chunks = env.instance_env.iter_filtered_chunks(&ctx, table_id.into(), filter)?;
drop(ctx);
// Register the iterator and get back the index to write to `out`.
// Calls to the iterator are done through dynamic dispatch.
Ok(env.iters.insert(chunks.into_iter()))
})
}
/// Advances the registered iterator with the index given by `iter_key`.
///
/// On success, the next element (the row as bytes) is written to a buffer.
/// The buffer's index is returned and written to the `out` pointer.
/// If there are no elements left, an invalid buffer index is written to `out`.
/// On failure however, the error is returned.
///
/// Returns an error if
/// - `iter` does not identify a registered `BufferIter`
/// - writing to `out` would overflow a 32-bit integer
/// - advancing the iterator resulted in an error
// #[tracing::instrument(skip_all)]
pub fn iter_next(caller: Caller<'_, Self>, iter_key: u32, out: WasmPtr<BufferIdx>) -> RtResult<u32> {
Self::cvt_ret(caller, AbiCall::IterNext, out, |caller| {
let env = caller.data_mut();
// Retrieve the iterator by `iter_key`.
let iter = env.iters.get_mut(BufferIterIdx(iter_key)).context("no such iterator")?;
// Advance the iterator.
Ok(iter
.next()
.map_or(BufferIdx::INVALID, |buf| env.insert_buffer(buf.into())))
})
}
/// Drops the entire registered iterator with the index given by `iter_key`.
/// The iterator is effectively de-registered.
///
/// Returns an error if the iterator does not exist.
// #[tracing::instrument(skip_all)]
pub fn iter_drop(caller: Caller<'_, Self>, iter_key: u32) -> RtResult<u32> {
Self::cvt(caller, AbiCall::IterDrop, |caller| {
caller
.data_mut()
.iters
.take(BufferIterIdx(iter_key))
.context("no such iterator")?;
Ok(())
})
}
/// Returns the length (number of bytes) of buffer `bufh` without
/// transferring ownership of the data into the function.
///
/// The `bufh` must have previously been allocating using `_buffer_alloc`.
///
/// Returns an error if the buffer does not exist.
// #[tracing::instrument(skip_all)]
pub fn buffer_len(caller: Caller<'_, Self>, buffer: u32) -> RtResult<u32> {
caller
.data()
.buffers
.get(BufferIdx(buffer))
.map(|b| b.len() as u32)
.context("no such buffer")
}
/// Consumes the `buffer`,
/// moving its contents to the slice `(dst, dst_len)`.
///
/// Returns an error if
/// - the buffer does not exist
/// - `dst + dst_len` overflows a 64-bit integer
// #[tracing::instrument(skip_all)]
pub fn buffer_consume(mut caller: Caller<'_, Self>, buffer: u32, dst: WasmPtr<u8>, dst_len: u32) -> RtResult<()> {
let (mem, env) = Self::mem_env(&mut caller);
let buf = env.take_buffer(BufferIdx(buffer)).context("no such buffer")?;
anyhow::ensure!(dst_len as usize == buf.len(), "bad length passed to buffer_consume");
mem.deref_slice_mut(dst, dst_len)?.copy_from_slice(&buf);
Ok(())
}
/// Creates a buffer of size `data_len` in the host environment.
///
/// The contents of the byte slice pointed to by `data`
/// and lasting `data_len` bytes
/// is written into the newly initialized buffer.
///
/// The buffer is registered in the host environment and is indexed by the returned `u32`.
///
/// Returns an error if `data + data_len` overflows a 64-bit integer.
// #[tracing::instrument(skip_all)]
pub fn buffer_alloc(mut caller: Caller<'_, Self>, data: WasmPtr<u8>, data_len: u32) -> RtResult<u32> {
let (mem, env) = Self::mem_env(&mut caller);
let buf = mem.deref_slice(data, data_len)?;
Ok(env.buffers.insert(buf.to_vec().into()).0)
}
pub fn span_start(mut caller: Caller<'_, Self>, name: WasmPtr<u8>, name_len: u32) -> RtResult<u32> {
let (mem, env) = Self::mem_env(&mut caller);
let name = mem.deref_slice(name, name_len)?.to_vec();
Ok(env.timing_spans.insert(TimingSpan::new(name)).0)
}
pub fn span_end(mut caller: Caller<'_, Self>, span_id: u32) -> RtResult<()> {
let span = caller
.data_mut()
.timing_spans
.take(TimingSpanIdx(span_id))
.context("no such timing span")?;
let elapsed = span.start.elapsed();
let name = String::from_utf8_lossy(&span.name);
let message = format!("Timing span {:?}: {:?}", name, elapsed);
let record = Record {
ts: chrono::Utc::now(),
target: None,
filename: None,
line_number: None,
message: &message,
};
caller
.data()
.instance_env
.console_log(crate::database_logger::LogLevel::Info, &record, &caller.as_context());
Ok(())
}
}
impl<T> BacktraceProvider for wasmtime::StoreContext<'_, T> {
fn capture(&self) -> Box<dyn ModuleBacktrace> {
Box::new(wasmtime::WasmBacktrace::capture(self))
}
}
impl ModuleBacktrace for wasmtime::WasmBacktrace {
fn frames(&self) -> Vec<BacktraceFrame<'_>> {
self.frames()
.iter()
.map(|f| BacktraceFrame {
module_name: None,
func_name: f.func_name(),
})
.collect()
}
}