crates/plugin_runtime/Cargo.toml 🔗
@@ -15,4 +15,4 @@ pollster = "0.2.5"
smol = "1.2.5"
[build-dependencies]
-wasmtime = "0.38"
+wasmtime = { version = "0.38", features = ["all-arch"] }
Merge pull request #1358 from zed-industries/plugin-cross-pre
Isaac Clayton created
Remove requirement for target triple in precompiled binary extensionChange summary
crates/plugin_runtime/Cargo.toml | 2
crates/plugin_runtime/README.md | 11 ++---
crates/plugin_runtime/build.rs | 13 +++++-
crates/zed/src/languages.rs | 6 +++
crates/zed/src/languages/language_plugin.rs | 42 +++++++++++-----------
styles/package-lock.json | 1
6 files changed, 44 insertions(+), 31 deletions(-)
Detailed changes
crates/plugin_runtime/README.md 🔗
@@ -152,7 +152,7 @@ Plugins in the `plugins` directory are automatically recompiled and serialized t
- `plugin.wasm` is the plugin compiled to Wasm. As a baseline, this should be about 4MB for debug builds and 2MB for release builds, but it depends on the specific plugin being built.
-- `plugin.wasm.pre` is the plugin compiled to Wasm *and additionally* precompiled to host-platform-agnostic cranelift-specific IR. This should be about 700KB for debug builds and 500KB in release builds. Each plugin takes about 1 or 2 seconds to compile to native code using cranelift, so precompiling plugins drastically reduces the startup time required to begin to run a plugin.
+- `plugin.wasm.pre` is the plugin compiled to Wasm *and additionally* precompiled to host-platform-specific native code, determined by the `TARGET` cargo exposes at compile-time. This should be about 700KB for debug builds and 500KB in release builds. Each plugin takes about 1 or 2 seconds to compile to native code using cranelift, so precompiling plugins drastically reduces the startup time required to begin to run a plugin.
For all intents and purposes, it is *highly recommended* that you use precompiled plugins where possible, as they are much more lightweight and take much less time to instantiate.
@@ -246,18 +246,17 @@ Once all imports are marked, we can instantiate the plugin. To instantiate the p
```rust
let plugin = builder
.init(
- true,
- include_bytes!("../../../plugins/bin/cool_plugin.wasm.pre"),
+ PluginBinary::Precompiled(bytes),
)
.await
.unwrap();
```
-The `.init` method currently takes two arguments:
+The `.init` method takes a single argument containing the plugin binary.
-1. First, the 'precompiled' flag, indicating whether the plugin is *normal* (`.wasm`) or precompiled (`.wasm.pre`). When using a precompiled plugin, set this flag to `true`.
+1. If not precompiled, use `PluginBinary::Wasm(bytes)`. This supports both the WebAssembly Textual format (`.wat`) and the WebAssembly Binary format (`.wasm`).
-2. Second, the raw plugin Wasm itself, as an array of bytes. When not precompiled, this can be either the Wasm binary format (`.wasm`) or the Wasm textual format (`.wat`). When precompiled, this must be the precompiled plugin (`.wasm.pre`).
+2. If precompiled, use `PluginBinary::Precompiled(bytes)`. This supports precompiled plugins ending in `.wasm.pre`. You need to be extra-careful when using precompiled plugins to ensure that the plugin target matches the target of the binary you are compiling.
The `.init` method is asynchronous, and must be `.await`ed upon. If the plugin is malformed or doesn't import the right functions, an error will be raised.
crates/plugin_runtime/build.rs 🔗
@@ -26,7 +26,6 @@ fn main() {
"release" => (&["--release"][..], "release"),
unknown => panic!("unknown profile `{}`", unknown),
};
-
// Invoke cargo to build the plugins
let build_successful = std::process::Command::new("cargo")
.args([
@@ -42,8 +41,13 @@ fn main() {
.success();
assert!(build_successful);
+ // Get the target architecture for pre-cross-compilation of plugins
+ // and create and engine with the appropriate config
+ let target_triple = std::env::var("TARGET").unwrap().to_string();
+ println!("cargo:rerun-if-env-changed=TARGET");
+ let engine = create_default_engine(&target_triple);
+
// Find all compiled binaries
- let engine = create_default_engine();
let binaries = std::fs::read_dir(base.join("target/wasm32-wasi").join(profile_target))
.expect("Could not find compiled plugins in target");
@@ -69,8 +73,11 @@ fn main() {
/// Creates an engine with the default configuration.
/// N.B. This must create an engine with the same config as the one
/// in `plugin_runtime/src/plugin.rs`.
-fn create_default_engine() -> Engine {
+fn create_default_engine(target_triple: &str) -> Engine {
let mut config = Config::default();
+ config
+ .target(target_triple)
+ .expect(&format!("Could not set target to `{}`", target_triple));
config.async_support(true);
config.consume_fuel(true);
Engine::new(&config).expect("Could not create precompilation engine")
crates/zed/src/languages.rs 🔗
@@ -3,6 +3,7 @@ pub use language::*;
use lazy_static::lazy_static;
use rust_embed::RustEmbed;
use std::{borrow::Cow, str, sync::Arc};
+// use util::ResultExt;
mod c;
mod go;
@@ -54,6 +55,11 @@ pub async fn init(languages: Arc<LanguageRegistry>, _executor: Arc<Background>)
"json",
tree_sitter_json::language(),
Some(CachedLspAdapter::new(json::JsonLspAdapter).await),
+ // TODO: switch back to plugin
+ // match language_plugin::new_json(executor).await.log_err() {
+ // Some(lang) => Some(CachedLspAdapter::new(lang).await),
+ // None => None,
+ // },
),
(
"markdown",
crates/zed/src/languages/language_plugin.rs 🔗
@@ -5,30 +5,30 @@ use collections::HashMap;
use futures::lock::Mutex;
use gpui::executor::Background;
use language::{LanguageServerName, LspAdapter};
-// use plugin_runtime::{Plugin, PluginBinary, PluginBuilder, WasiFn};
-use plugin_runtime::{Plugin, WasiFn};
+use plugin_runtime::{Plugin, PluginBinary, PluginBuilder, WasiFn};
use std::{any::Any, path::PathBuf, sync::Arc};
use util::ResultExt;
-// pub async fn new_json(executor: Arc<Background>) -> Result<PluginLspAdapter> {
-// let plugin = PluginBuilder::new_default()?
-// .host_function_async("command", |command: String| async move {
-// let mut args = command.split(' ');
-// let command = args.next().unwrap();
-// smol::process::Command::new(command)
-// .args(args)
-// .output()
-// .await
-// .log_err()
-// .map(|output| output.stdout)
-// })?
-// .init(PluginBinary::Precompiled(include_bytes!(
-// "../../../../plugins/bin/json_language.wasm.pre"
-// )))
-// .await?;
-//
-// PluginLspAdapter::new(plugin, executor).await
-// }
+#[allow(dead_code)]
+pub async fn new_json(executor: Arc<Background>) -> Result<PluginLspAdapter> {
+ let plugin = PluginBuilder::new_default()?
+ .host_function_async("command", |command: String| async move {
+ let mut args = command.split(' ');
+ let command = args.next().unwrap();
+ smol::process::Command::new(command)
+ .args(args)
+ .output()
+ .await
+ .log_err()
+ .map(|output| output.stdout)
+ })?
+ .init(PluginBinary::Precompiled(include_bytes!(
+ "../../../../plugins/bin/json_language.wasm.pre",
+ )))
+ .await?;
+
+ PluginLspAdapter::new(plugin, executor).await
+}
pub struct PluginLspAdapter {
name: WasiFn<(), String>,
styles/package-lock.json 🔗
@@ -5,6 +5,7 @@
"requires": true,
"packages": {
"": {
+ "name": "styles",
"version": "1.0.0",
"license": "ISC",
"dependencies": {