1pub mod wit;
2
3use crate::ExtensionManifest;
4use anyhow::{Context as _, Result, anyhow, bail};
5use async_trait::async_trait;
6use extension::{
7 CodeLabel, Command, Completion, ContextServerConfiguration, DebugAdapterBinary,
8 DebugTaskDefinition, ExtensionHostProxy, KeyValueStoreDelegate, ProjectDelegate, SlashCommand,
9 SlashCommandArgumentCompletion, SlashCommandOutput, Symbol, WorktreeDelegate,
10};
11use fs::{Fs, normalize_path};
12use futures::future::LocalBoxFuture;
13use futures::{
14 Future, FutureExt, StreamExt as _,
15 channel::{
16 mpsc::{self, UnboundedSender},
17 oneshot,
18 },
19 future::BoxFuture,
20};
21use gpui::{App, AsyncApp, BackgroundExecutor, Task};
22use http_client::HttpClient;
23use language::LanguageName;
24use lsp::LanguageServerName;
25use moka::sync::Cache;
26use node_runtime::NodeRuntime;
27use release_channel::ReleaseChannel;
28use semantic_version::SemanticVersion;
29use std::borrow::Cow;
30use std::sync::LazyLock;
31use std::{
32 path::{Path, PathBuf},
33 sync::Arc,
34};
35use wasmtime::{
36 CacheStore, Engine, Store,
37 component::{Component, ResourceTable},
38};
39use wasmtime_wasi::{self as wasi, WasiView};
40use wit::Extension;
41
42pub struct WasmHost {
43 engine: Engine,
44 release_channel: ReleaseChannel,
45 http_client: Arc<dyn HttpClient>,
46 node_runtime: NodeRuntime,
47 pub(crate) proxy: Arc<ExtensionHostProxy>,
48 fs: Arc<dyn Fs>,
49 pub work_dir: PathBuf,
50 _main_thread_message_task: Task<()>,
51 main_thread_message_tx: mpsc::UnboundedSender<MainThreadCall>,
52}
53
54#[derive(Clone)]
55pub struct WasmExtension {
56 tx: UnboundedSender<ExtensionCall>,
57 pub manifest: Arc<ExtensionManifest>,
58 pub work_dir: Arc<Path>,
59 #[allow(unused)]
60 pub zed_api_version: SemanticVersion,
61}
62
63#[async_trait]
64impl extension::Extension for WasmExtension {
65 fn manifest(&self) -> Arc<ExtensionManifest> {
66 self.manifest.clone()
67 }
68
69 fn work_dir(&self) -> Arc<Path> {
70 self.work_dir.clone()
71 }
72
73 async fn language_server_command(
74 &self,
75 language_server_id: LanguageServerName,
76 language_name: LanguageName,
77 worktree: Arc<dyn WorktreeDelegate>,
78 ) -> Result<Command> {
79 self.call(|extension, store| {
80 async move {
81 let resource = store.data_mut().table().push(worktree)?;
82 let command = extension
83 .call_language_server_command(
84 store,
85 &language_server_id,
86 &language_name,
87 resource,
88 )
89 .await?
90 .map_err(|err| anyhow!("{err}"))?;
91
92 Ok(command.into())
93 }
94 .boxed()
95 })
96 .await
97 }
98
99 async fn language_server_initialization_options(
100 &self,
101 language_server_id: LanguageServerName,
102 language_name: LanguageName,
103 worktree: Arc<dyn WorktreeDelegate>,
104 ) -> Result<Option<String>> {
105 self.call(|extension, store| {
106 async move {
107 let resource = store.data_mut().table().push(worktree)?;
108 let options = extension
109 .call_language_server_initialization_options(
110 store,
111 &language_server_id,
112 &language_name,
113 resource,
114 )
115 .await?
116 .map_err(|err| anyhow!("{err}"))?;
117 anyhow::Ok(options)
118 }
119 .boxed()
120 })
121 .await
122 }
123
124 async fn language_server_workspace_configuration(
125 &self,
126 language_server_id: LanguageServerName,
127 worktree: Arc<dyn WorktreeDelegate>,
128 ) -> Result<Option<String>> {
129 self.call(|extension, store| {
130 async move {
131 let resource = store.data_mut().table().push(worktree)?;
132 let options = extension
133 .call_language_server_workspace_configuration(
134 store,
135 &language_server_id,
136 resource,
137 )
138 .await?
139 .map_err(|err| anyhow!("{err}"))?;
140 anyhow::Ok(options)
141 }
142 .boxed()
143 })
144 .await
145 }
146
147 async fn language_server_additional_initialization_options(
148 &self,
149 language_server_id: LanguageServerName,
150 target_language_server_id: LanguageServerName,
151 worktree: Arc<dyn WorktreeDelegate>,
152 ) -> Result<Option<String>> {
153 self.call(|extension, store| {
154 async move {
155 let resource = store.data_mut().table().push(worktree)?;
156 let options = extension
157 .call_language_server_additional_initialization_options(
158 store,
159 &language_server_id,
160 &target_language_server_id,
161 resource,
162 )
163 .await?
164 .map_err(|err| anyhow!("{err}"))?;
165 anyhow::Ok(options)
166 }
167 .boxed()
168 })
169 .await
170 }
171
172 async fn language_server_additional_workspace_configuration(
173 &self,
174 language_server_id: LanguageServerName,
175 target_language_server_id: LanguageServerName,
176 worktree: Arc<dyn WorktreeDelegate>,
177 ) -> Result<Option<String>> {
178 self.call(|extension, store| {
179 async move {
180 let resource = store.data_mut().table().push(worktree)?;
181 let options = extension
182 .call_language_server_additional_workspace_configuration(
183 store,
184 &language_server_id,
185 &target_language_server_id,
186 resource,
187 )
188 .await?
189 .map_err(|err| anyhow!("{err}"))?;
190 anyhow::Ok(options)
191 }
192 .boxed()
193 })
194 .await
195 }
196
197 async fn labels_for_completions(
198 &self,
199 language_server_id: LanguageServerName,
200 completions: Vec<Completion>,
201 ) -> Result<Vec<Option<CodeLabel>>> {
202 self.call(|extension, store| {
203 async move {
204 let labels = extension
205 .call_labels_for_completions(
206 store,
207 &language_server_id,
208 completions.into_iter().map(Into::into).collect(),
209 )
210 .await?
211 .map_err(|err| anyhow!("{err}"))?;
212
213 Ok(labels
214 .into_iter()
215 .map(|label| label.map(Into::into))
216 .collect())
217 }
218 .boxed()
219 })
220 .await
221 }
222
223 async fn labels_for_symbols(
224 &self,
225 language_server_id: LanguageServerName,
226 symbols: Vec<Symbol>,
227 ) -> Result<Vec<Option<CodeLabel>>> {
228 self.call(|extension, store| {
229 async move {
230 let labels = extension
231 .call_labels_for_symbols(
232 store,
233 &language_server_id,
234 symbols.into_iter().map(Into::into).collect(),
235 )
236 .await?
237 .map_err(|err| anyhow!("{err}"))?;
238
239 Ok(labels
240 .into_iter()
241 .map(|label| label.map(Into::into))
242 .collect())
243 }
244 .boxed()
245 })
246 .await
247 }
248
249 async fn complete_slash_command_argument(
250 &self,
251 command: SlashCommand,
252 arguments: Vec<String>,
253 ) -> Result<Vec<SlashCommandArgumentCompletion>> {
254 self.call(|extension, store| {
255 async move {
256 let completions = extension
257 .call_complete_slash_command_argument(store, &command.into(), &arguments)
258 .await?
259 .map_err(|err| anyhow!("{err}"))?;
260
261 Ok(completions.into_iter().map(Into::into).collect())
262 }
263 .boxed()
264 })
265 .await
266 }
267
268 async fn run_slash_command(
269 &self,
270 command: SlashCommand,
271 arguments: Vec<String>,
272 delegate: Option<Arc<dyn WorktreeDelegate>>,
273 ) -> Result<SlashCommandOutput> {
274 self.call(|extension, store| {
275 async move {
276 let resource = if let Some(delegate) = delegate {
277 Some(store.data_mut().table().push(delegate)?)
278 } else {
279 None
280 };
281
282 let output = extension
283 .call_run_slash_command(store, &command.into(), &arguments, resource)
284 .await?
285 .map_err(|err| anyhow!("{err}"))?;
286
287 Ok(output.into())
288 }
289 .boxed()
290 })
291 .await
292 }
293
294 async fn context_server_command(
295 &self,
296 context_server_id: Arc<str>,
297 project: Arc<dyn ProjectDelegate>,
298 ) -> Result<Command> {
299 self.call(|extension, store| {
300 async move {
301 let project_resource = store.data_mut().table().push(project)?;
302 let command = extension
303 .call_context_server_command(store, context_server_id.clone(), project_resource)
304 .await?
305 .map_err(|err| anyhow!("{err}"))?;
306 anyhow::Ok(command.into())
307 }
308 .boxed()
309 })
310 .await
311 }
312
313 async fn context_server_configuration(
314 &self,
315 context_server_id: Arc<str>,
316 project: Arc<dyn ProjectDelegate>,
317 ) -> Result<Option<ContextServerConfiguration>> {
318 self.call(|extension, store| {
319 async move {
320 let project_resource = store.data_mut().table().push(project)?;
321 let Some(configuration) = extension
322 .call_context_server_configuration(
323 store,
324 context_server_id.clone(),
325 project_resource,
326 )
327 .await?
328 .map_err(|err| anyhow!("{err}"))?
329 else {
330 return Ok(None);
331 };
332
333 Ok(Some(configuration.try_into()?))
334 }
335 .boxed()
336 })
337 .await
338 }
339
340 async fn suggest_docs_packages(&self, provider: Arc<str>) -> Result<Vec<String>> {
341 self.call(|extension, store| {
342 async move {
343 let packages = extension
344 .call_suggest_docs_packages(store, provider.as_ref())
345 .await?
346 .map_err(|err| anyhow!("{err:?}"))?;
347
348 Ok(packages)
349 }
350 .boxed()
351 })
352 .await
353 }
354
355 async fn index_docs(
356 &self,
357 provider: Arc<str>,
358 package_name: Arc<str>,
359 kv_store: Arc<dyn KeyValueStoreDelegate>,
360 ) -> Result<()> {
361 self.call(|extension, store| {
362 async move {
363 let kv_store_resource = store.data_mut().table().push(kv_store)?;
364 extension
365 .call_index_docs(
366 store,
367 provider.as_ref(),
368 package_name.as_ref(),
369 kv_store_resource,
370 )
371 .await?
372 .map_err(|err| anyhow!("{err:?}"))?;
373
374 anyhow::Ok(())
375 }
376 .boxed()
377 })
378 .await
379 }
380 async fn get_dap_binary(
381 &self,
382 dap_name: Arc<str>,
383 config: DebugTaskDefinition,
384 user_installed_path: Option<PathBuf>,
385 worktree: Arc<dyn WorktreeDelegate>,
386 ) -> Result<DebugAdapterBinary> {
387 self.call(|extension, store| {
388 async move {
389 let resource = store.data_mut().table().push(worktree)?;
390 let dap_binary = extension
391 .call_get_dap_binary(store, dap_name, config, user_installed_path, resource)
392 .await?
393 .map_err(|err| anyhow!("{err:?}"))?;
394 let dap_binary = dap_binary.try_into()?;
395 Ok(dap_binary)
396 }
397 .boxed()
398 })
399 .await
400 }
401
402 async fn get_dap_schema(&self) -> Result<serde_json::Value> {
403 self.call(|extension, store| {
404 async move {
405 extension
406 .call_dap_schema(store)
407 .await
408 .and_then(|schema| serde_json::to_value(schema).map_err(|err| err.to_string()))
409 .map_err(|err| anyhow!(err.to_string()))
410 }
411 .boxed()
412 })
413 .await
414 }
415}
416
417pub struct WasmState {
418 manifest: Arc<ExtensionManifest>,
419 pub table: ResourceTable,
420 ctx: wasi::WasiCtx,
421 pub host: Arc<WasmHost>,
422}
423
424type MainThreadCall = Box<dyn Send + for<'a> FnOnce(&'a mut AsyncApp) -> LocalBoxFuture<'a, ()>>;
425
426type ExtensionCall = Box<
427 dyn Send + for<'a> FnOnce(&'a mut Extension, &'a mut Store<WasmState>) -> BoxFuture<'a, ()>,
428>;
429
430fn wasm_engine() -> wasmtime::Engine {
431 static WASM_ENGINE: LazyLock<wasmtime::Engine> = LazyLock::new(|| {
432 let mut config = wasmtime::Config::new();
433 config.wasm_component_model(true);
434 config.async_support(true);
435 config
436 .enable_incremental_compilation(cache_store())
437 .unwrap();
438 wasmtime::Engine::new(&config).unwrap()
439 });
440
441 WASM_ENGINE.clone()
442}
443
444fn cache_store() -> Arc<IncrementalCompilationCache> {
445 static CACHE_STORE: LazyLock<Arc<IncrementalCompilationCache>> =
446 LazyLock::new(|| Arc::new(IncrementalCompilationCache::new()));
447 CACHE_STORE.clone()
448}
449
450impl WasmHost {
451 pub fn new(
452 fs: Arc<dyn Fs>,
453 http_client: Arc<dyn HttpClient>,
454 node_runtime: NodeRuntime,
455 proxy: Arc<ExtensionHostProxy>,
456 work_dir: PathBuf,
457 cx: &mut App,
458 ) -> Arc<Self> {
459 let (tx, mut rx) = mpsc::unbounded::<MainThreadCall>();
460 let task = cx.spawn(async move |cx| {
461 while let Some(message) = rx.next().await {
462 message(cx).await;
463 }
464 });
465 Arc::new(Self {
466 engine: wasm_engine(),
467 fs,
468 work_dir,
469 http_client,
470 node_runtime,
471 proxy,
472 release_channel: ReleaseChannel::global(cx),
473 _main_thread_message_task: task,
474 main_thread_message_tx: tx,
475 })
476 }
477
478 pub fn load_extension(
479 self: &Arc<Self>,
480 wasm_bytes: Vec<u8>,
481 manifest: &Arc<ExtensionManifest>,
482 executor: BackgroundExecutor,
483 ) -> Task<Result<WasmExtension>> {
484 let this = self.clone();
485 let manifest = manifest.clone();
486 executor.clone().spawn(async move {
487 let zed_api_version = parse_wasm_extension_version(&manifest.id, &wasm_bytes)?;
488
489 let component = Component::from_binary(&this.engine, &wasm_bytes)
490 .context("failed to compile wasm component")?;
491
492 let mut store = wasmtime::Store::new(
493 &this.engine,
494 WasmState {
495 ctx: this.build_wasi_ctx(&manifest).await?,
496 manifest: manifest.clone(),
497 table: ResourceTable::new(),
498 host: this.clone(),
499 },
500 );
501
502 let mut extension = Extension::instantiate_async(
503 &mut store,
504 this.release_channel,
505 zed_api_version,
506 &component,
507 )
508 .await?;
509
510 extension
511 .call_init_extension(&mut store)
512 .await
513 .context("failed to initialize wasm extension")?;
514
515 let (tx, mut rx) = mpsc::unbounded::<ExtensionCall>();
516 executor
517 .spawn(async move {
518 while let Some(call) = rx.next().await {
519 (call)(&mut extension, &mut store).await;
520 }
521 })
522 .detach();
523
524 Ok(WasmExtension {
525 manifest: manifest.clone(),
526 work_dir: this.work_dir.join(manifest.id.as_ref()).into(),
527 tx,
528 zed_api_version,
529 })
530 })
531 }
532
533 async fn build_wasi_ctx(&self, manifest: &Arc<ExtensionManifest>) -> Result<wasi::WasiCtx> {
534 let extension_work_dir = self.work_dir.join(manifest.id.as_ref());
535 self.fs
536 .create_dir(&extension_work_dir)
537 .await
538 .context("failed to create extension work dir")?;
539
540 let file_perms = wasi::FilePerms::all();
541 let dir_perms = wasi::DirPerms::all();
542
543 Ok(wasi::WasiCtxBuilder::new()
544 .inherit_stdio()
545 .preopened_dir(&extension_work_dir, ".", dir_perms, file_perms)?
546 .preopened_dir(
547 &extension_work_dir,
548 extension_work_dir.to_string_lossy(),
549 dir_perms,
550 file_perms,
551 )?
552 .env("PWD", extension_work_dir.to_string_lossy())
553 .env("RUST_BACKTRACE", "full")
554 .build())
555 }
556
557 pub fn writeable_path_from_extension(&self, id: &Arc<str>, path: &Path) -> Result<PathBuf> {
558 let extension_work_dir = self.work_dir.join(id.as_ref());
559 let path = normalize_path(&extension_work_dir.join(path));
560 anyhow::ensure!(
561 path.starts_with(&extension_work_dir),
562 "cannot write to path {path:?}",
563 );
564 Ok(path)
565 }
566}
567
568pub fn parse_wasm_extension_version(
569 extension_id: &str,
570 wasm_bytes: &[u8],
571) -> Result<SemanticVersion> {
572 let mut version = None;
573
574 for part in wasmparser::Parser::new(0).parse_all(wasm_bytes) {
575 if let wasmparser::Payload::CustomSection(s) =
576 part.context("error parsing wasm extension")?
577 {
578 if s.name() == "zed:api-version" {
579 version = parse_wasm_extension_version_custom_section(s.data());
580 if version.is_none() {
581 bail!(
582 "extension {} has invalid zed:api-version section: {:?}",
583 extension_id,
584 s.data()
585 );
586 }
587 }
588 }
589 }
590
591 // The reason we wait until we're done parsing all of the Wasm bytes to return the version
592 // is to work around a panic that can happen inside of Wasmtime when the bytes are invalid.
593 //
594 // By parsing the entirety of the Wasm bytes before we return, we're able to detect this problem
595 // earlier as an `Err` rather than as a panic.
596 version.with_context(|| format!("extension {extension_id} has no zed:api-version section"))
597}
598
599fn parse_wasm_extension_version_custom_section(data: &[u8]) -> Option<SemanticVersion> {
600 if data.len() == 6 {
601 Some(SemanticVersion::new(
602 u16::from_be_bytes([data[0], data[1]]) as _,
603 u16::from_be_bytes([data[2], data[3]]) as _,
604 u16::from_be_bytes([data[4], data[5]]) as _,
605 ))
606 } else {
607 None
608 }
609}
610
611impl WasmExtension {
612 pub async fn load(
613 extension_dir: PathBuf,
614 manifest: &Arc<ExtensionManifest>,
615 wasm_host: Arc<WasmHost>,
616 cx: &AsyncApp,
617 ) -> Result<Self> {
618 let path = extension_dir.join("extension.wasm");
619
620 let mut wasm_file = wasm_host
621 .fs
622 .open_sync(&path)
623 .await
624 .context("failed to open wasm file")?;
625
626 let mut wasm_bytes = Vec::new();
627 wasm_file
628 .read_to_end(&mut wasm_bytes)
629 .context("failed to read wasm")?;
630
631 wasm_host
632 .load_extension(wasm_bytes, manifest, cx.background_executor().clone())
633 .await
634 .with_context(|| format!("failed to load wasm extension {}", manifest.id))
635 }
636
637 pub async fn call<T, Fn>(&self, f: Fn) -> T
638 where
639 T: 'static + Send,
640 Fn: 'static
641 + Send
642 + for<'a> FnOnce(&'a mut Extension, &'a mut Store<WasmState>) -> BoxFuture<'a, T>,
643 {
644 let (return_tx, return_rx) = oneshot::channel();
645 self.tx
646 .clone()
647 .unbounded_send(Box::new(move |extension, store| {
648 async {
649 let result = f(extension, store).await;
650 return_tx.send(result).ok();
651 }
652 .boxed()
653 }))
654 .expect("wasm extension channel should not be closed yet");
655 return_rx.await.expect("wasm extension channel")
656 }
657}
658
659impl WasmState {
660 fn on_main_thread<T, Fn>(&self, f: Fn) -> impl 'static + Future<Output = T>
661 where
662 T: 'static + Send,
663 Fn: 'static + Send + for<'a> FnOnce(&'a mut AsyncApp) -> LocalBoxFuture<'a, T>,
664 {
665 let (return_tx, return_rx) = oneshot::channel();
666 self.host
667 .main_thread_message_tx
668 .clone()
669 .unbounded_send(Box::new(move |cx| {
670 async {
671 let result = f(cx).await;
672 return_tx.send(result).ok();
673 }
674 .boxed_local()
675 }))
676 .expect("main thread message channel should not be closed yet");
677 async move { return_rx.await.expect("main thread message channel") }
678 }
679
680 fn work_dir(&self) -> PathBuf {
681 self.host.work_dir.join(self.manifest.id.as_ref())
682 }
683}
684
685impl wasi::WasiView for WasmState {
686 fn table(&mut self) -> &mut ResourceTable {
687 &mut self.table
688 }
689
690 fn ctx(&mut self) -> &mut wasi::WasiCtx {
691 &mut self.ctx
692 }
693}
694
695/// Wrapper around a mini-moka bounded cache for storing incremental compilation artifacts.
696/// Since wasm modules have many similar elements, this can save us a lot of work at the
697/// cost of a small memory footprint. However, we don't want this to be unbounded, so we use
698/// a LFU/LRU cache to evict less used cache entries.
699#[derive(Debug)]
700struct IncrementalCompilationCache {
701 cache: Cache<Vec<u8>, Vec<u8>>,
702}
703
704impl IncrementalCompilationCache {
705 fn new() -> Self {
706 let cache = Cache::builder()
707 // Cap this at 32 MB for now. Our extensions turn into roughly 512kb in the cache,
708 // which means we could store 64 completely novel extensions in the cache, but in
709 // practice we will more than that, which is more than enough for our use case.
710 .max_capacity(32 * 1024 * 1024)
711 .weigher(|k: &Vec<u8>, v: &Vec<u8>| (k.len() + v.len()).try_into().unwrap_or(u32::MAX))
712 .build();
713 Self { cache }
714 }
715}
716
717impl CacheStore for IncrementalCompilationCache {
718 fn get(&self, key: &[u8]) -> Option<Cow<[u8]>> {
719 self.cache.get(key).map(|v| v.into())
720 }
721
722 fn insert(&self, key: &[u8], value: Vec<u8>) -> bool {
723 self.cache.insert(key.to_vec(), value);
724 true
725 }
726}