1780819 - Allow non-nullable references in locals

Status: RESOLVED FIXED

(Core :: JavaScript: WebAssembly, task, P3)

Description

[Ryan Hunt [:rhunt] (on leave until early May)]

Function-references adds non-nullable references. By default they cannot be used in locals because locals default to null until they are stored into. The let instruction was added to resolve this, but was removed due to complexity for engines and producers.

Discussion is being had in [1] for an alternative.

[1] https://github.com/WebAssembly/function-references/issues/44

Comment 1

[Ryan Hunt [:rhunt] (on leave until early May)]

It looks like consensus was reached around option '1a' [1].

This option is roughly: Track initialisation status of locals during validation and only allow local.get after a local.set/tee in the same or a surrounding block. with the initialisation status of a local being reset at the end of the block they are initialised in.

[1] https://github.com/WebAssembly/function-references/pull/63

Comment 2

[Ryan Hunt [:rhunt] (on leave until early May)]

Roughly this will allow:

(module
  (type $t (func))
  (func
    (local (ref $t))
    block
      (local.set 0 ref.func 0)
      block
        (drop local.get 0)
      end
    end
  )
)

Where the local is initialized in the same block or ancestor of the block it is used from.

Comment 3

[Ryan Hunt [:rhunt] (on leave until early May)]

Attachment: nnl-test.js

I tried something new and wrote a test case generator here which should enumerate all the interesting possibilities here. Hopefully it should be easy to read, tried to add comments about what test cases should be passing/failing and why.

Comment 4

[Ryan Hunt [:rhunt] (on leave until early May)]

Here is my understanding of how we'll likely implement this.

1. Move the ValTypeVector that stores locals to be inside OpIter

• This is current stored in each compiler and passed to readLocalGet/etc as a parameter

2. Store the number of params of the func in OpIter

• the local index space starts with the first N params, params can be non-nullable locals and don't need to initialized before being set because they are initialized on enrry

3. Create a bit vector with length equal to the number of non-param locals in OpIter

• everything defaults to 0, not initialized

4. Create a stack of 'InitializedLocal' in OpIter

• struct InitializedLocal { index: u32 }

5. Every local.set/tee $index performs:

• If the bit for the local is unset, mark it as set and push an InitializedLocal for the index

6. Every local.get $index performs:

• Fail if the bit is unset

7. Every 'begin' of a block records the height of the initialized local stack on the ControlItemStack, similar to how we do the value stack
8. Every 'end' of a block pops each item from the initialized local stack to the height on entry

• Every popped initialized local resets the bit to 0

This creates an 'undo trail' for whether a local is initialized in a block or ancestor blocks. This was not my idea, but proposed as an efficient implementation of validation on the F-R github. It adds some time overhead for managing the initialized local stack, but avoids having to copy the bitset of initialized locals each time you enter a new block.

Comment 5

[Yury Delendik (:yury)]

Attachment: Bug 1780819 - Allow non-nullable references in locals. r?rhunt

• Allows non-defaultable locals to be present
• Adds UnsetLocalsState to track state (as defined by spec)
• Add testing of generated sequences of blocks and locals operations

Comment 6

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/9caa242322e5
Allow non-nullable references in locals. r=rhunt

Comment 7

[Atila Butkovits]

https://hg.mozilla.org/mozilla-central/rev/9caa242322e5