Add Compile command. #248

calavera · 2019-03-07T18:21:41Z

This command allows people to compile a wasm module to machine code ahead
of time. It dumps the data in the cache, so future runs can use it.

It also changes the Cache trait to use Strings as keys, so it's more flexible than using the WasmHash object directly.

I've added a --from-cache flag to the Run command to allow loading modules directly from the cache without having access to the wasm or wat files. I'm not super sold on this flag.

I'm super open to suggestions and other options.

Enjoy this doggo taking a bath:

Hywan · 2019-03-08T08:44:01Z

Thanks for the great PR!

I think the ideal workflows should be the following:

wasmer run <file.wasm> to run a Wasm binary file. A cache of the compiled version is created on-the-fly, and re-used for the next runs,
wasmer compile <file.wasm> to compile a Wasm file in the cache ahead of time, then simply run wasm run <file.wasm> would fetch it from the cache, as if it was a “next run” for the previous item.

Based on these assumptions, the --from-cache option is not necessary.

Thoughts?

calavera · 2019-03-08T15:57:50Z

@Hywan that means that you need the wasm file where you compile and where you execute the module, that's not always the same servers.

xmclark

@calavera this seems like your use case:

Compile wasm to cache file with Wasmer, cache is ouput somewhere accessible
persist cache for later...do something else...kill some time...send it over the network etc.
Load the cache back into Wasmer (maybe on a different machine) and run it

This seems like a valid use case. This is an ahead-of-time compilation workflow for hot runs. I think the addition of the Compile subcommand and the --from-cache option is fine. The confusing part about --from-cache is that we require a wasm file for the Run command. Ignoring the required option seems confusing. Maybe a dedicated subcommand for running from a cache?

calavera · 2019-03-08T17:07:13Z

Ignoring the required option seems confusing. Maybe a dedicated subcommand for running from a cache?

I thought about that too, and it would make sense because this feature is dependent on the cache. Do you have any suggestions for the subcomand name @xmclark ?

What about this?

wasmer cache exec WASM_HASH

lachlansneff · 2019-03-08T18:49:30Z

My opinion is that we provide two cache subcommands:

wasmer cache generate <wasm file> -o/--output this/is/a/dir

takes an optional output directory argument

and

wasmer cache run foo/bar/hash

Takes a path to the cache as the argument.

calavera · 2019-03-08T18:52:18Z

I'm also realizing that this might need the wasm path, or at least a name for the module to be executed. I'm thinking about what's the best way to solve that.

calavera · 2019-03-08T18:53:01Z

My opinion is that we provide two cache subcommands

I like this suggestion

calavera · 2019-03-08T22:49:55Z

@lachlansneff, @xmclark I've implemented those two subcommands, tell me if this makes sense:

- `wasmer cache generate` to generate a machine object.
- `wasmer cache run` to run a cached object.

The run command requires two arguments. The first one is the name of the
program to run, to pass it as args[0] to the module, and the key for the
object in the cache. It also allows to send extra arguments to pass them
to the module. Example:

$ wasmer cache run nginx VERY_LONG_HASH -- -c /opt/nginx/config

I can write documentation for those subcommands if this is a good way to implement this.

xmclark

Looks great!

xmclark · 2019-03-08T23:05:23Z

src/bin/wasmer.rs

+        .map_err(|e| format!("Can't execute module from cache: {:?}", e))?;
+
+    let name = String::from(options.module_name.to_str().unwrap());
+    run_wasm_module(&module, name, &options.args)


A small nitpick: the module_name is unecessary on the CLI. Can you pass the hash as a string to run_wasm_module in place of the name? This will allow us to remove the module_name field from CacheRun too.

This way all we have to type is:
$ wasmer cache run VERY_LONG_HASH -- -c /opt/nginx/config

I can do that, I was not sure if it'd be ok 👍

lachlansneff · 2019-03-08T23:37:07Z

bors try

bors · 2019-03-08T23:44:05Z

try

Build succeeded

calavera · 2019-03-10T01:11:21Z

I've removed that extra argument in the wasmer cache run command. Do you have any conventions to write documentation? I don't see any docs in this repo besides the readme.

calavera · 2019-03-11T15:40:10Z

@xmclark @lachlansneff it looks like Circle failed to download a dependency, and I cannot trigger a new job.

lachlansneff · 2019-03-11T16:26:02Z

@calavera Seems like a Cargo.lock issue? Try resetting it?

This command allows people to compile a wasm module to machine code ahead of time. It dumps the data in the cache, so future runs can use it. Signed-off-by: David Calavera <david.calavera@gmail.com>

This is more flexible than using the WasmHash as the key. Signed-off-by: David Calavera <david.calavera@gmail.com>

After a module is compiled, it can be loaded from the cache without providing a wasm object. Signed-off-by: David Calavera <david.calavera@gmail.com>

Signed-off-by: David Calavera <david.calavera@gmail.com>

- `wasmer cache generate` to generate a machine object. - `wasmer cache run` to run a cached object. The run command requires two arguments. The first one is the name of the program to run, to pass it as args[0] to the module, and the key for the object in the cache. It also allows to send extra arguments to pass them to the module. Example: ``` $ wasmer cache run nginx VERY_LONG_HASH -- -c /opt/nginx/config ``` Signed-off-by: David Calavera <david.calavera@gmail.com>

calavera · 2019-03-11T17:38:00Z

it looks like rebasing master did the trick @lachlansneff 🎊

xmclark · 2019-03-11T18:31:16Z

bors try

bors · 2019-03-11T18:31:44Z

try

Build failed

continuous-integration/appveyor/branch

Use the module key in the cache as the name. Signed-off-by: David Calavera <david.calavera@gmail.com>

calavera · 2019-03-12T17:21:28Z

bors try

bors · 2019-03-12T17:21:30Z

🔒 Permission denied

Existing reviewers: click here to make calavera a reviewer

bjfish · 2019-03-12T17:26:27Z

bors try

bors · 2019-03-12T17:34:13Z

try

Build succeeded

syrusakbary · 2019-03-15T16:55:58Z

A small update on this PR: we are gathering more feedback (and learnings) about the compilation/caching runtime needs, to make sure we expose the right API for it.

We will comment here as soon as we are 100% clear on it (hopefully soon!)

syrusakbary · 2020-07-08T06:23:37Z

We are on the final steps of rewriting Wasmer from scratch and this issue is now solved in the refactor (we have a compile subcommand).

syrusakbary · 2020-08-24T16:05:35Z

Hi @calavera!

We finally added support for precompiling wasm files to native object files (or JIT).
The usage is quite easy:

Compile:

wasmer compile python.wasm -o python.so --native

Run:

wasmer run python.so

Note: if you use the native engine, the startup time to load them is just in the order of nanoseconds even for big wasm files.

calavera force-pushed the compile_command branch from de0497d to eb73b2c Compare March 8, 2019 00:37

Hywan added 🎉 enhancement New feature! 📦 lib-deprecated About the deprecated crates 📦 lib-runtime labels Mar 8, 2019

xmclark self-requested a review March 8, 2019 16:52

xmclark reviewed Mar 8, 2019

View reviewed changes

calavera force-pushed the compile_command branch from 76c27d3 to 42e3a68 Compare March 8, 2019 22:48

calavera force-pushed the compile_command branch from 42e3a68 to 82b88bf Compare March 8, 2019 22:52

xmclark reviewed Mar 8, 2019

View reviewed changes

bors bot added a commit that referenced this pull request Mar 8, 2019

Try #248:

5ea44e0

xmclark approved these changes Mar 9, 2019

View reviewed changes

calavera force-pushed the compile_command branch from 8b69eb2 to b2c143a Compare March 11, 2019 01:54

calavera added 6 commits March 11, 2019 10:36

Add Compile command.

c070c02

This command allows people to compile a wasm module to machine code ahead of time. It dumps the data in the cache, so future runs can use it. Signed-off-by: David Calavera <david.calavera@gmail.com>

Change Cache trait to use strings as keys.

7ed4a3c

This is more flexible than using the WasmHash as the key. Signed-off-by: David Calavera <david.calavera@gmail.com>

Add flag to the run command to load modules from the cache.

d606ea2

After a module is compiled, it can be loaded from the cache without providing a wasm object. Signed-off-by: David Calavera <david.calavera@gmail.com>

Fix code formatting in wasmer.rs

bada13a

Signed-off-by: David Calavera <david.calavera@gmail.com>

Fix cache usage example.

a101377

Signed-off-by: David Calavera <david.calavera@gmail.com>

calavera force-pushed the compile_command branch from 10134a9 to 545421c Compare March 11, 2019 17:36

bors bot added a commit that referenced this pull request Mar 11, 2019

Try #248:

9369f83

Remove extra name required to run a cache module.

250fd92

Use the module key in the cache as the name. Signed-off-by: David Calavera <david.calavera@gmail.com>

calavera force-pushed the compile_command branch from 545421c to 250fd92 Compare March 12, 2019 16:54

bors bot added a commit that referenced this pull request Mar 12, 2019

Try #248:

b91150e

Merge branch 'master' into compile_command

1253a64

MarkMcCaskey added this to Needs review in Wasmer Reviews Nov 25, 2019

syrusakbary added the resolved in wasmer refactor label Jul 8, 2020

syrusakbary closed this Aug 24, 2020

Wasmer Reviews automation moved this from Needs review to Done Aug 24, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add Compile command. #248

Add Compile command. #248

calavera commented Mar 7, 2019

Hywan commented Mar 8, 2019

calavera commented Mar 8, 2019

xmclark left a comment

calavera commented Mar 8, 2019

lachlansneff commented Mar 8, 2019 •

edited

calavera commented Mar 8, 2019

calavera commented Mar 8, 2019

calavera commented Mar 8, 2019

xmclark left a comment

xmclark Mar 8, 2019

calavera Mar 8, 2019

lachlansneff commented Mar 8, 2019

bors bot commented Mar 8, 2019

calavera commented Mar 10, 2019

calavera commented Mar 11, 2019

lachlansneff commented Mar 11, 2019

calavera commented Mar 11, 2019

xmclark commented Mar 11, 2019

bors bot commented Mar 11, 2019

calavera commented Mar 12, 2019

bors bot commented Mar 12, 2019

bjfish commented Mar 12, 2019

bors bot commented Mar 12, 2019

syrusakbary commented Mar 15, 2019

syrusakbary commented Jul 8, 2020

syrusakbary commented Aug 24, 2020

Add Compile command. #248

Add Compile command. #248

Conversation

calavera commented Mar 7, 2019

Hywan commented Mar 8, 2019

calavera commented Mar 8, 2019

xmclark left a comment

Choose a reason for hiding this comment

calavera commented Mar 8, 2019

lachlansneff commented Mar 8, 2019 • edited

calavera commented Mar 8, 2019

calavera commented Mar 8, 2019

calavera commented Mar 8, 2019

xmclark left a comment

Choose a reason for hiding this comment

xmclark Mar 8, 2019

Choose a reason for hiding this comment

calavera Mar 8, 2019

Choose a reason for hiding this comment

lachlansneff commented Mar 8, 2019

bors bot commented Mar 8, 2019

try

Build succeeded

calavera commented Mar 10, 2019

calavera commented Mar 11, 2019

lachlansneff commented Mar 11, 2019

calavera commented Mar 11, 2019

xmclark commented Mar 11, 2019

bors bot commented Mar 11, 2019

try

Build failed

calavera commented Mar 12, 2019

bors bot commented Mar 12, 2019

bjfish commented Mar 12, 2019

bors bot commented Mar 12, 2019

try

Build succeeded

syrusakbary commented Mar 15, 2019

syrusakbary commented Jul 8, 2020

syrusakbary commented Aug 24, 2020

lachlansneff commented Mar 8, 2019 •

edited