wasm_encoder/component/canonicals.rs
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
use crate::{encode_section, ComponentSection, ComponentSectionId, Encode};
use alloc::vec::Vec;
/// Represents options for canonical function definitions.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum CanonicalOption {
/// The string types in the function signature are UTF-8 encoded.
UTF8,
/// The string types in the function signature are UTF-16 encoded.
UTF16,
/// The string types in the function signature are compact UTF-16 encoded.
CompactUTF16,
/// The memory to use if the lifting or lowering of a function requires memory access.
///
/// The value is an index to a core memory.
Memory(u32),
/// The realloc function to use if the lifting or lowering of a function requires memory
/// allocation.
///
/// The value is an index to a core function of type `(func (param i32 i32 i32 i32) (result i32))`.
Realloc(u32),
/// The post-return function to use if the lifting of a function requires
/// cleanup after the function returns.
PostReturn(u32),
/// Indicates that specified function should be lifted or lowered using the `async` ABI.
Async,
/// The function to use if the async lifting of a function should receive task/stream/future progress events
/// using a callback.
Callback(u32),
}
impl Encode for CanonicalOption {
fn encode(&self, sink: &mut Vec<u8>) {
match self {
Self::UTF8 => sink.push(0x00),
Self::UTF16 => sink.push(0x01),
Self::CompactUTF16 => sink.push(0x02),
Self::Memory(idx) => {
sink.push(0x03);
idx.encode(sink);
}
Self::Realloc(idx) => {
sink.push(0x04);
idx.encode(sink);
}
Self::PostReturn(idx) => {
sink.push(0x05);
idx.encode(sink);
}
Self::Async => {
sink.push(0x06);
}
Self::Callback(idx) => {
sink.push(0x07);
idx.encode(sink);
}
}
}
}
/// An encoder for the canonical function section of WebAssembly components.
///
/// # Example
///
/// ```
/// use wasm_encoder::{Component, CanonicalFunctionSection, CanonicalOption};
///
/// let mut functions = CanonicalFunctionSection::new();
/// functions.lift(0, 0, [CanonicalOption::UTF8]);
///
/// let mut component = Component::new();
/// component.section(&functions);
///
/// let bytes = component.finish();
/// ```
#[derive(Clone, Debug, Default)]
pub struct CanonicalFunctionSection {
bytes: Vec<u8>,
num_added: u32,
}
impl CanonicalFunctionSection {
/// Construct a new component function section encoder.
pub fn new() -> Self {
Self::default()
}
/// The number of functions in the section.
pub fn len(&self) -> u32 {
self.num_added
}
/// Determines if the section is empty.
pub fn is_empty(&self) -> bool {
self.num_added == 0
}
/// Define a function that will lift a core WebAssembly function to the canonical ABI.
pub fn lift<O>(&mut self, core_func_index: u32, type_index: u32, options: O) -> &mut Self
where
O: IntoIterator<Item = CanonicalOption>,
O::IntoIter: ExactSizeIterator,
{
let options = options.into_iter();
self.bytes.push(0x00);
self.bytes.push(0x00);
core_func_index.encode(&mut self.bytes);
options.len().encode(&mut self.bytes);
for option in options {
option.encode(&mut self.bytes);
}
type_index.encode(&mut self.bytes);
self.num_added += 1;
self
}
/// Define a function that will lower a canonical ABI function to a core WebAssembly function.
pub fn lower<O>(&mut self, func_index: u32, options: O) -> &mut Self
where
O: IntoIterator<Item = CanonicalOption>,
O::IntoIter: ExactSizeIterator,
{
let options = options.into_iter();
self.bytes.push(0x01);
self.bytes.push(0x00);
func_index.encode(&mut self.bytes);
options.len().encode(&mut self.bytes);
for option in options {
option.encode(&mut self.bytes);
}
self.num_added += 1;
self
}
/// Defines a function which will create an owned handle to the resource
/// specified by `ty_index`.
pub fn resource_new(&mut self, ty_index: u32) -> &mut Self {
self.bytes.push(0x02);
ty_index.encode(&mut self.bytes);
self.num_added += 1;
self
}
/// Defines a function which will drop the specified type of handle.
pub fn resource_drop(&mut self, ty_index: u32) -> &mut Self {
self.bytes.push(0x03);
ty_index.encode(&mut self.bytes);
self.num_added += 1;
self
}
/// Defines a function which will return the representation of the specified
/// resource type.
pub fn resource_rep(&mut self, ty_index: u32) -> &mut Self {
self.bytes.push(0x04);
ty_index.encode(&mut self.bytes);
self.num_added += 1;
self
}
/// Defines a function which will spawns a new thread by invoking a shared
/// function of type `ty_index`.
pub fn thread_spawn(&mut self, ty_index: u32) -> &mut Self {
self.bytes.push(0x05);
ty_index.encode(&mut self.bytes);
self.num_added += 1;
self
}
/// Defines a function which will return the number of threads that can be
/// expected to execute concurrently.
pub fn thread_hw_concurrency(&mut self) -> &mut Self {
self.bytes.push(0x06);
self.num_added += 1;
self
}
/// Defines a function which tells the host to enable or disable
/// backpressure for the caller's instance. When backpressure is enabled,
/// the host must not start any new calls to that instance until
/// backpressure is disabled.
pub fn task_backpressure(&mut self) -> &mut Self {
self.bytes.push(0x08);
self.num_added += 1;
self
}
/// Defines a function which returns a result to the caller of a lifted
/// export function. This allows the callee to continue executing after
/// returning a result.
pub fn task_return(&mut self, ty: u32) -> &mut Self {
self.bytes.push(0x09);
ty.encode(&mut self.bytes);
self.num_added += 1;
self
}
/// Defines a function which waits for at least one outstanding async
/// task/stream/future to make progress, returning the first such event.
///
/// If `async_` is true, the caller instance may be reentered.
pub fn task_wait(&mut self, async_: bool, memory: u32) -> &mut Self {
self.bytes.push(0x0a);
self.bytes.push(if async_ { 1 } else { 0 });
memory.encode(&mut self.bytes);
self.num_added += 1;
self
}
/// Defines a function which checks whether any outstanding async
/// task/stream/future has made progress. Unlike `task.wait`, this does not
/// block and may return nothing if no such event has occurred.
///
/// If `async_` is true, the caller instance may be reentered.
pub fn task_poll(&mut self, async_: bool, memory: u32) -> &mut Self {
self.bytes.push(0x0b);
self.bytes.push(if async_ { 1 } else { 0 });
memory.encode(&mut self.bytes);
self.num_added += 1;
self
}
/// Defines a function which yields control to the host so that other tasks
/// are able to make progress, if any.
///
/// If `async_` is true, the caller instance may be reentered.
pub fn task_yield(&mut self, async_: bool) -> &mut Self {
self.bytes.push(0x0c);
self.bytes.push(if async_ { 1 } else { 0 });
self.num_added += 1;
self
}
/// Defines a function to drop a specified task which has completed.
pub fn subtask_drop(&mut self) -> &mut Self {
self.bytes.push(0x0d);
self.num_added += 1;
self
}
/// Defines a function to create a new `stream` handle of the specified
/// type.
pub fn stream_new(&mut self, ty: u32) -> &mut Self {
self.bytes.push(0x0e);
ty.encode(&mut self.bytes);
self.num_added += 1;
self
}
/// Defines a function to read from a `stream` of the specified type.
pub fn stream_read<O>(&mut self, ty: u32, options: O) -> &mut Self
where
O: IntoIterator<Item = CanonicalOption>,
O::IntoIter: ExactSizeIterator,
{
self.bytes.push(0x0f);
ty.encode(&mut self.bytes);
let options = options.into_iter();
options.len().encode(&mut self.bytes);
for option in options {
option.encode(&mut self.bytes);
}
self.num_added += 1;
self
}
/// Defines a function to write to a `stream` of the specified type.
pub fn stream_write<O>(&mut self, ty: u32, options: O) -> &mut Self
where
O: IntoIterator<Item = CanonicalOption>,
O::IntoIter: ExactSizeIterator,
{
self.bytes.push(0x10);
ty.encode(&mut self.bytes);
let options = options.into_iter();
options.len().encode(&mut self.bytes);
for option in options {
option.encode(&mut self.bytes);
}
self.num_added += 1;
self
}
/// Defines a function to cancel an in-progress read from a `stream` of the
/// specified type.
pub fn stream_cancel_read(&mut self, ty: u32, async_: bool) -> &mut Self {
self.bytes.push(0x11);
ty.encode(&mut self.bytes);
self.bytes.push(if async_ { 1 } else { 0 });
self.num_added += 1;
self
}
/// Defines a function to cancel an in-progress write to a `stream` of the
/// specified type.
pub fn stream_cancel_write(&mut self, ty: u32, async_: bool) -> &mut Self {
self.bytes.push(0x12);
ty.encode(&mut self.bytes);
self.bytes.push(if async_ { 1 } else { 0 });
self.num_added += 1;
self
}
/// Defines a function to close the readable end of a `stream` of the
/// specified type.
pub fn stream_close_readable(&mut self, ty: u32) -> &mut Self {
self.bytes.push(0x13);
ty.encode(&mut self.bytes);
self.num_added += 1;
self
}
/// Defines a function to close the writable end of a `stream` of the
/// specified type.
pub fn stream_close_writable(&mut self, ty: u32) -> &mut Self {
self.bytes.push(0x14);
ty.encode(&mut self.bytes);
self.num_added += 1;
self
}
/// Defines a function to create a new `future` handle of the specified
/// type.
pub fn future_new(&mut self, ty: u32) -> &mut Self {
self.bytes.push(0x15);
ty.encode(&mut self.bytes);
self.num_added += 1;
self
}
/// Defines a function to read from a `future` of the specified type.
pub fn future_read<O>(&mut self, ty: u32, options: O) -> &mut Self
where
O: IntoIterator<Item = CanonicalOption>,
O::IntoIter: ExactSizeIterator,
{
self.bytes.push(0x16);
ty.encode(&mut self.bytes);
let options = options.into_iter();
options.len().encode(&mut self.bytes);
for option in options {
option.encode(&mut self.bytes);
}
self.num_added += 1;
self
}
/// Defines a function to write to a `future` of the specified type.
pub fn future_write<O>(&mut self, ty: u32, options: O) -> &mut Self
where
O: IntoIterator<Item = CanonicalOption>,
O::IntoIter: ExactSizeIterator,
{
self.bytes.push(0x17);
ty.encode(&mut self.bytes);
let options = options.into_iter();
options.len().encode(&mut self.bytes);
for option in options {
option.encode(&mut self.bytes);
}
self.num_added += 1;
self
}
/// Defines a function to cancel an in-progress read from a `future` of the
/// specified type.
pub fn future_cancel_read(&mut self, ty: u32, async_: bool) -> &mut Self {
self.bytes.push(0x18);
ty.encode(&mut self.bytes);
self.bytes.push(if async_ { 1 } else { 0 });
self.num_added += 1;
self
}
/// Defines a function to cancel an in-progress write to a `future` of the
/// specified type.
pub fn future_cancel_write(&mut self, ty: u32, async_: bool) -> &mut Self {
self.bytes.push(0x19);
ty.encode(&mut self.bytes);
self.bytes.push(if async_ { 1 } else { 0 });
self.num_added += 1;
self
}
/// Defines a function to close the readable end of a `future` of the
/// specified type.
pub fn future_close_readable(&mut self, ty: u32) -> &mut Self {
self.bytes.push(0x1a);
ty.encode(&mut self.bytes);
self.num_added += 1;
self
}
/// Defines a function to close the writable end of a `future` of the
/// specified type.
pub fn future_close_writable(&mut self, ty: u32) -> &mut Self {
self.bytes.push(0x1b);
ty.encode(&mut self.bytes);
self.num_added += 1;
self
}
/// Defines a function to create a new `error-context` with a specified
/// debug message.
pub fn error_context_new<O>(&mut self, options: O) -> &mut Self
where
O: IntoIterator<Item = CanonicalOption>,
O::IntoIter: ExactSizeIterator,
{
self.bytes.push(0x1c);
let options = options.into_iter();
options.len().encode(&mut self.bytes);
for option in options {
option.encode(&mut self.bytes);
}
self.num_added += 1;
self
}
/// Defines a function to get the debug message for a specified
/// `error-context`.
///
/// Note that the debug message might not necessarily match what was passed
/// to `error-context.new`.
pub fn error_context_debug_message<O>(&mut self, options: O) -> &mut Self
where
O: IntoIterator<Item = CanonicalOption>,
O::IntoIter: ExactSizeIterator,
{
self.bytes.push(0x1d);
let options = options.into_iter();
options.len().encode(&mut self.bytes);
for option in options {
option.encode(&mut self.bytes);
}
self.num_added += 1;
self
}
/// Defines a function to drop a specified `error-context`.
pub fn error_context_drop(&mut self) -> &mut Self {
self.bytes.push(0x1e);
self.num_added += 1;
self
}
}
impl Encode for CanonicalFunctionSection {
fn encode(&self, sink: &mut Vec<u8>) {
encode_section(sink, self.num_added, &self.bytes);
}
}
impl ComponentSection for CanonicalFunctionSection {
fn id(&self) -> u8 {
ComponentSectionId::CanonicalFunction.into()
}
}