Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Change data representation of resource methods #1070

Merged
merged 2 commits into from
Jun 16, 2023

Conversation

alexcrichton
Copy link
Member

Note: this builds on #1068

This commit changes the representation of resources and their methods in
the wit-parser crate as implemented originally in #1053. Previously
methods related to a resource were strung as a separate list of methods
from each Resource type which provided a nested view of functions for
bindings generators to interpret. This representation, however, does not
allow for methods or constructors to actually refer to the resource type
itself because the resource type can't be created until the method list
is created, a cyclic dependency.

To handle this problem this commit removes the nested list of functions
and instead places all resource methods and functions and such within
the normal single list of functions within an interface. This represents
a "flattened" version of all functions available within an interface or
world and aligns with the WebAssembly representation of how these will
work. The names of these functions are not valid identifiers and have
the component-model mangling along the lines of [method]foo.bar for
example.

My hope is that in the future as bindings generators are worked on
various helper methods can be added to automatically group functions
based on their kind to avoid any issues. Otherwise though this will
likely "break" all existing code generators when resources are
introduced because the names aren't valid identifiers in any language.
I think this is a good thing, however, as that way it can't be forgotten
to handle the resources case and failures will be "loud" in theory.

This commit changes a number of other miscellaneous details such as:

  • Type resolution no longer needs to consider types referenced by
    methods of resources as dependencies which reflects how this will all
    look in a wasm binary format where resources are declared before their
    member functions are declared.

  • Parsing has been updated to address some minor issues here and there
    and additionally has some new names to remove the old "value" concept
    which is no longer a thing.

This commit changes the representation of resources and their methods in
the `wit-parser` crate as implemented originally in bytecodealliance#1053. Previously
methods related to a resource were strung as a separate list of methods
from each `Resource` type which provided a nested view of functions for
bindings generators to interpret. This representation, however, does not
allow for methods or constructors to actually refer to the resource type
itself because the resource type can't be created until the method list
is created, a cyclic dependency.

To handle this problem this commit removes the nested list of functions
and instead places all resource methods and functions and such within
the normal single list of functions within an interface. This represents
a "flattened" version of all functions available within an interface or
world and aligns with the WebAssembly representation of how these will
work. The names of these functions are not valid identifiers and have
the component-model mangling along the lines of `[method]foo.bar` for
example.

My hope is that in the future as bindings generators are worked on
various helper methods can be added to automatically group functions
based on their kind to avoid any issues. Otherwise though this will
likely "break" all existing code generators when resources are
introduced because the names aren't valid identifiers in any language.
I think this is a good thing, however, as that way it can't be forgotten
to handle the resources case and failures will be "loud" in theory.

This commit changes a number of other miscellaneous details such as:

* Type resolution no longer needs to consider types referenced by
  methods of resources as dependencies which reflects how this will all
  look in a wasm binary format where resources are declared before their
  member functions are declared.

* Parsing has been updated to address some minor issues here and there
  and additionally has some new names to remove the old "value" concept
  which is no longer a thing.
Additionally be sure to update ids listed in `FunctionKind` during
merging.
@alexcrichton alexcrichton merged commit 4b69456 into bytecodealliance:main Jun 16, 2023
14 checks passed
@alexcrichton alexcrichton deleted the wit-resources branch June 16, 2023 22:37
alexcrichton added a commit to alexcrichton/wasm-tools that referenced this pull request Jul 11, 2023
Releases recent changes such as:

* More support for the gc proposal. bytecodealliance#1045 bytecodealliance#1059
* Support for resources throughout most tooling. bytecodealliance#1053 bytecodealliance#1068 bytecodealliance#1070 bytecodealliance#1082
  bytecodealliance#1079 bytecodealliance#1083 bytecodealliance#1084 bytecodealliance#1105 bytecodealliance#1113 bytecodealliance#1116
* Support for `include` in WIT files. bytecodealliance#1054 bytecodealliance#1085 bytecodealliance#1088
* WIT worlds may now be rejected if the same interface can be "reached"
  as both an import and an export simultaneously. bytecodealliance#1081 bytecodealliance#1107
* Support for registry metadata in `wasm-tools metadata`. bytecodealliance#1060
* A new subcommand `wasm-tools component targets`. bytecodealliance#1089
* An `--out-dir` argument is supported on `wasm-tools component wit` to
  print the entire `Resolve` instead of just one package. bytecodealliance#1108
* Miscellaneous bug fixes and improvements. bytecodealliance#1061 bytecodealliance#1065 bytecodealliance#1074 bytecodealliance#1073 bytecodealliance#1078 bytecodealliance#1077
  bytecodealliance#1072 bytecodealliance#1086 bytecodealliance#1091 bytecodealliance#1094 bytecodealliance#1114 bytecodealliance#1106
alexcrichton added a commit to alexcrichton/wasm-tools that referenced this pull request Jul 11, 2023
Releases recent changes such as:

* More support for the gc proposal.
  [bytecodealliance#1045](bytecodealliance#1045)
  [bytecodealliance#1059](bytecodealliance#1059)
* Support for resources throughout most tooling.
  [bytecodealliance#1053](bytecodealliance#1053)
  [bytecodealliance#1068](bytecodealliance#1068)
  [bytecodealliance#1070](bytecodealliance#1070)
  [bytecodealliance#1082](bytecodealliance#1082)
  [bytecodealliance#1079](bytecodealliance#1079)
  [bytecodealliance#1083](bytecodealliance#1083)
  [bytecodealliance#1084](bytecodealliance#1084)
  [bytecodealliance#1105](bytecodealliance#1105)
  [bytecodealliance#1113](bytecodealliance#1113)
  [bytecodealliance#1116](bytecodealliance#1116)
* Support for `include` in WIT files.
  [bytecodealliance#1054](bytecodealliance#1054)
  [bytecodealliance#1085](bytecodealliance#1085)
  [bytecodealliance#1088](bytecodealliance#1088)
* WIT worlds may now be rejected if the same interface can be "reached"
  as both an import and an export simultaneously.
  [bytecodealliance#1081](bytecodealliance#1081)
  [bytecodealliance#1107](bytecodealliance#1107)
* Support for registry metadata in `wasm-tools metadata`.
  [bytecodealliance#1060](bytecodealliance#1060)
* A new subcommand `wasm-tools component targets`.
  [bytecodealliance#1089](bytecodealliance#1089)
* An `--out-dir` argument is supported on `wasm-tools component wit` to
  print the entire `Resolve` instead of just one package.
  [bytecodealliance#1108](bytecodealliance#1108)
* Miscellaneous bug fixes and improvements.
  [bytecodealliance#1061](bytecodealliance#1061)
  [bytecodealliance#1065](bytecodealliance#1065)
  [bytecodealliance#1074](bytecodealliance#1074)
  [bytecodealliance#1073](bytecodealliance#1073)
  [bytecodealliance#1078](bytecodealliance#1078)
  [bytecodealliance#1077](bytecodealliance#1077)
  [bytecodealliance#1072](bytecodealliance#1072)
  [bytecodealliance#1086](bytecodealliance#1086)
  [bytecodealliance#1091](bytecodealliance#1091)
  [bytecodealliance#1094](bytecodealliance#1094)
  [bytecodealliance#1114](bytecodealliance#1114)
  [bytecodealliance#1106](bytecodealliance#1106)
alexcrichton added a commit that referenced this pull request Jul 11, 2023
Releases recent changes such as:

* More support for the gc proposal.
  [#1045](#1045)
  [#1059](#1059)
* Support for resources throughout most tooling.
  [#1053](#1053)
  [#1068](#1068)
  [#1070](#1070)
  [#1082](#1082)
  [#1079](#1079)
  [#1083](#1083)
  [#1084](#1084)
  [#1105](#1105)
  [#1113](#1113)
  [#1116](#1116)
* Support for `include` in WIT files.
  [#1054](#1054)
  [#1085](#1085)
  [#1088](#1088)
* WIT worlds may now be rejected if the same interface can be "reached"
  as both an import and an export simultaneously.
  [#1081](#1081)
  [#1107](#1107)
* Support for registry metadata in `wasm-tools metadata`.
  [#1060](#1060)
* A new subcommand `wasm-tools component targets`.
  [#1089](#1089)
* An `--out-dir` argument is supported on `wasm-tools component wit` to
  print the entire `Resolve` instead of just one package.
  [#1108](#1108)
* Miscellaneous bug fixes and improvements.
  [#1061](#1061)
  [#1065](#1065)
  [#1074](#1074)
  [#1073](#1073)
  [#1078](#1078)
  [#1077](#1077)
  [#1072](#1072)
  [#1086](#1086)
  [#1091](#1091)
  [#1094](#1094)
  [#1114](#1114)
  [#1106](#1106)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants