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