Zero-length stream copies within one component instance trap for non-numeric payloads

Open
#753 1 comment 1 reaction 0 assignees View on GitHub

Maintainers usually reply within 4 days

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
45/100
Issue type
Bug
Clarity
Mostly clear
Activity status
Active
Domain
compilers

Research direction

Start with the linked canonical ABI definition and compare its non-numeric payload trap condition with the zero-length stream read in the WAST example. Reproduce the case with Wasmtime and determine whether the implementation or the specification needs an update; done means the behavior and expected test result are resolved.

Written by the indexing model from the issue text.

Description

This test:

;; With a write pending on a `stream<string>`, a zero-length read from the
;; same component instance copies nothing and returns COMPLETED(0).
(component
  (core module $libc
    (memory (export "memory") 1)
    (func (export "realloc") (param i32 i32 i32 i32) (result i32) unreachable))
  (core instance $libc (instantiate $libc))
  (type $stream (stream string))
  (core func $stream.new (canon stream.new $stream))
  (core func $stream.read (canon stream.read $stream async
    (memory (core memory $libc "memory")) (realloc (core func $libc "realloc"))))
  (core func $stream.write (canon stream.write $stream async
    (memory (core memory $libc "memory"))))
  (core module $m
    (import "" "stream.new" (func $stream.new (result i64)))
    (import "" "stream.read" (func $stream.read (param i32 i32 i32) (result i32)))
    (import "" "stream.write" (func $stream.write (param i32 i32 i32) (result i32)))
    (func (export "run") (result i32)
      (local $pair i64)
      (local.set $pair (call $stream.new))
      (if (i32.ne (i32.const -1) ;; BLOCKED
            (call $stream.write
              (i32.wrap_i64 (i64.shr_u (local.get $pair) (i64.const 32)))
              (i32.const 0) (i32.const 1)))
        (then unreachable))
      (call $stream.read (i32.wrap_i64 (local.get $pair)) (i32.const 0) (i32.const 0)))
  )
  (core instance $i (instantiate $m (with "" (instance
    (export "stream.new" (func $stream.new))
    (export "stream.read" (func $stream.read))
    (export "stream.write" (func $stream.write))))))
  (func (export "run") async (result u32) (canon lift (core func $i "run")))
)


(assert_return (invoke "run") (u32.const 0)) ;; COMPLETED(0)

fails in Wasmtime with:

$ wasmtime wast foo.wast
Error: failed to run script file 'foo.wast'

Caused by:
    0: failed directive on foo.wast:39
    1: error while executing at wasm backtrace:
    0:    0x282 - wasm-function[3]
                    at foo.wast:29:8
    2: cannot read from and write to intra-component future/stream with non-numeric payload

but the spec indicates that this test should pass right now as the trap is gated on non-zero-length buffers.

I wanted to flag this as a possible update to the specification (similar to https://github.com/WebAssembly/component-model/issues/750 perhaps) where subjectively I'd expect this to unconditionally fail regardless of the lengths in play, but I may also be showing my biases from #750 too.

Dominant language
WebAssembly
Stars
1.4k
Forks
134
Avg merge
3d 19h
Merged PRs (30d)
8

Getting set up

This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from WebAssembly/component-model

All issues in WebAssembly/component-model

Similar issues

More Compilers issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.