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

Bump module serialization format to v2 #1223

Merged
merged 2 commits into from Feb 8, 2022

Conversation

webmaster128
Copy link
Member

No description provided.

@webmaster128 webmaster128 merged commit ae07df7 into main Feb 8, 2022
@webmaster128 webmaster128 deleted the MODULE_SERIALIZATION_VERSION-v2 branch February 8, 2022 06:43
/// Version for cosmwasm_vm 1.0.0-beta5 / wasmvm 1.0.0-beta6 that ships with Wasmer 2.1.1.
/// - **v3**:<br>
/// Version for Wasmer 2.2.0 which contains a [module breaking change to 2.1.x](https://github.com/wasmerio/wasmer/pull/2747).
const MODULE_SERIALIZATION_VERSION: &str = "v2";
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can't this be derived or imported from wasmer somehow? That will make this code support all versions transparently (new test below would have to me modified).

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No, the version is not exposed yet. This might change in the future. They added a versioning schema in wasmerio/wasmer#2747. However, it is not exported. So currently they just say it can change at any time.

If we get the version, we can check much better that we don't miss an update. However, we might want to keep control over the version number since it can include our own format changes as well. E.g. we could rename the file names from <checksum> to <checksum>.module or compress the modules before writing them to disk.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If we get the version, we can check much better that we don't miss an update. However, we might want to keep control over the version number since it can include our own format changes as well. E.g. we could rename the file names from <checksum> to <checksum>.module or compress the modules before writing them to disk.

When wasmer module format version is published, we can consider that plus our own version number, either in a subdir or with a minor / patch format, i.e. {}/{} or {}.{} / {}-{}.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In 9f5716c you see an approach that hacks into the private header information. This way we ensure a module version change is noticed.

We could hash the full Wasmer module header into the file path, like format!("v3-wasmer{}", &header_hash[0..8]). Then the bumping happens automatically.

The only issue I see with this approach is that it is not obvious for admins which cache directory is used and which one is obsolete.

Copy link
Contributor

@maurolacy maurolacy Feb 8, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We could hash the full Wasmer module header into the file path, like format!("v3-wasmer{}", &header_hash[0..8]). Then the bumping happens automatically.

I like it. At least, until there's a public wasmer module format version number.

The only issue I see with this approach is that it is not obvious for admins which cache directory is used and which one is obsolete.

Not a big issue. The one being used will always contain more recent files, and those can be easily detected

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good stuff. Let's continue the conversation in #1224 as Wasmer 2.2.0 will be the first version in which the relevant information is stored in the module headers.

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