1 //! The context or environment in which the language server functions. In our
2 //! server implementation this is know as the `WorldState`.
4 //! Each tick provides an immutable snapshot of the state as `WorldSnapshot`.
6 use std::{sync::Arc, time::Instant};
8 use crossbeam_channel::{unbounded, Receiver, Sender};
9 use flycheck::FlycheckHandle;
10 use ide::{Analysis, AnalysisHost, Cancelable, Change, FileId};
11 use ide_db::base_db::{CrateId, VfsPath};
12 use lsp_types::{SemanticTokens, Url};
13 use parking_lot::{Mutex, RwLock};
15 BuildDataCollector, BuildDataResult, CargoWorkspace, ProcMacroClient, ProjectWorkspace, Target,
17 use rustc_hash::FxHashMap;
18 use vfs::AnchoredPathBuf;
22 diagnostics::{CheckFixes, DiagnosticCollection},
23 document::DocumentData,
25 line_index::{LineEndings, LineIndex},
29 reload::SourceRootConfig,
30 request_metrics::{LatestRequests, RequestMetrics},
31 thread_pool::TaskPool,
32 to_proto::url_from_abs_path,
36 // Enforces drop order
37 pub(crate) struct Handle<H, C> {
39 pub(crate) receiver: C,
42 pub(crate) type ReqHandler = fn(&mut GlobalState, lsp_server::Response);
43 pub(crate) type ReqQueue = lsp_server::ReqQueue<(String, Instant), ReqHandler>;
45 /// `GlobalState` is the primary mutable state of the language server
47 /// The most interesting components are `vfs`, which stores a consistent
48 /// snapshot of the file systems, and `analysis_host`, which stores our
49 /// incremental salsa database.
51 /// Note that this struct has more than on impl in various modules!
52 pub(crate) struct GlobalState {
53 sender: Sender<lsp_server::Message>,
55 pub(crate) task_pool: Handle<TaskPool<Task>, Receiver<Task>>,
56 pub(crate) loader: Handle<Box<dyn vfs::loader::Handle>, Receiver<vfs::loader::Message>>,
57 pub(crate) config: Arc<Config>,
58 pub(crate) analysis_host: AnalysisHost,
59 pub(crate) diagnostics: DiagnosticCollection,
60 pub(crate) mem_docs: FxHashMap<VfsPath, DocumentData>,
61 pub(crate) semantic_tokens_cache: Arc<Mutex<FxHashMap<Url, SemanticTokens>>>,
62 pub(crate) shutdown_requested: bool,
63 pub(crate) last_reported_status: Option<lsp_ext::ServerStatusParams>,
64 pub(crate) source_root_config: SourceRootConfig,
65 pub(crate) proc_macro_client: Option<ProcMacroClient>,
67 pub(crate) flycheck: Vec<FlycheckHandle>,
68 pub(crate) flycheck_sender: Sender<flycheck::Message>,
69 pub(crate) flycheck_receiver: Receiver<flycheck::Message>,
71 pub(crate) vfs: Arc<RwLock<(vfs::Vfs, FxHashMap<FileId, LineEndings>)>>,
72 pub(crate) vfs_config_version: u32,
73 pub(crate) vfs_progress_config_version: u32,
74 pub(crate) vfs_progress_n_total: usize,
75 pub(crate) vfs_progress_n_done: usize,
77 /// For both `workspaces` and `workspace_build_data`, the field stores the
78 /// data we actually use, while the `OpQueue` stores the result of the last
81 /// If the fetch (partially) fails, we do not update the values.
82 pub(crate) workspaces: Arc<Vec<ProjectWorkspace>>,
83 pub(crate) fetch_workspaces_queue: OpQueue<(), Vec<anyhow::Result<ProjectWorkspace>>>,
84 pub(crate) workspace_build_data: Option<BuildDataResult>,
85 pub(crate) fetch_build_data_queue:
86 OpQueue<BuildDataCollector, Option<anyhow::Result<BuildDataResult>>>,
87 pub(crate) prime_caches_queue: OpQueue<(), ()>,
89 latest_requests: Arc<RwLock<LatestRequests>>,
92 /// An immutable snapshot of the world's state at a point in time.
93 pub(crate) struct GlobalStateSnapshot {
94 pub(crate) config: Arc<Config>,
95 pub(crate) analysis: Analysis,
96 pub(crate) check_fixes: CheckFixes,
97 pub(crate) latest_requests: Arc<RwLock<LatestRequests>>,
98 mem_docs: FxHashMap<VfsPath, DocumentData>,
99 pub(crate) semantic_tokens_cache: Arc<Mutex<FxHashMap<Url, SemanticTokens>>>,
100 vfs: Arc<RwLock<(vfs::Vfs, FxHashMap<FileId, LineEndings>)>>,
101 pub(crate) workspaces: Arc<Vec<ProjectWorkspace>>,
105 pub(crate) fn new(sender: Sender<lsp_server::Message>, config: Config) -> GlobalState {
107 let (sender, receiver) = unbounded::<vfs::loader::Message>();
108 let handle: vfs_notify::NotifyHandle =
109 vfs::loader::Handle::spawn(Box::new(move |msg| sender.send(msg).unwrap()));
110 let handle = Box::new(handle) as Box<dyn vfs::loader::Handle>;
111 Handle { handle, receiver }
115 let (sender, receiver) = unbounded();
116 let handle = TaskPool::new(sender);
117 Handle { handle, receiver }
120 let analysis_host = AnalysisHost::new(config.lru_capacity());
121 let (flycheck_sender, flycheck_receiver) = unbounded();
124 req_queue: ReqQueue::default(),
127 config: Arc::new(config),
129 diagnostics: Default::default(),
130 mem_docs: FxHashMap::default(),
131 semantic_tokens_cache: Arc::new(Default::default()),
132 shutdown_requested: false,
133 last_reported_status: None,
134 source_root_config: SourceRootConfig::default(),
135 proc_macro_client: None,
137 flycheck: Vec::new(),
141 vfs: Arc::new(RwLock::new((vfs::Vfs::default(), FxHashMap::default()))),
142 vfs_config_version: 0,
143 vfs_progress_config_version: 0,
144 vfs_progress_n_total: 0,
145 vfs_progress_n_done: 0,
147 workspaces: Arc::new(Vec::new()),
148 fetch_workspaces_queue: OpQueue::default(),
149 workspace_build_data: None,
150 prime_caches_queue: OpQueue::default(),
152 fetch_build_data_queue: OpQueue::default(),
153 latest_requests: Default::default(),
157 pub(crate) fn process_changes(&mut self) -> bool {
158 let _p = profile::span("GlobalState::process_changes");
159 let mut fs_changes = Vec::new();
160 let mut has_fs_changes = false;
163 let mut change = Change::new();
164 let (vfs, line_endings_map) = &mut *self.vfs.write();
165 let changed_files = vfs.take_changes();
166 if changed_files.is_empty() {
170 for file in changed_files {
171 if file.is_created_or_deleted() {
172 if let Some(path) = vfs.file_path(file.file_id).as_path() {
173 fs_changes.push((path.to_path_buf(), file.change_kind));
174 has_fs_changes = true;
178 let text = if file.exists() {
179 let bytes = vfs.file_contents(file.file_id).to_vec();
180 match String::from_utf8(bytes).ok() {
182 let (text, line_endings) = LineEndings::normalize(text);
183 line_endings_map.insert(file.file_id, line_endings);
191 change.change_file(file.file_id, text);
194 let roots = self.source_root_config.partition(&vfs);
195 change.set_roots(roots);
200 self.analysis_host.apply_change(change);
201 self.maybe_refresh(&fs_changes);
205 pub(crate) fn snapshot(&self) -> GlobalStateSnapshot {
206 GlobalStateSnapshot {
207 config: Arc::clone(&self.config),
208 workspaces: Arc::clone(&self.workspaces),
209 analysis: self.analysis_host.analysis(),
210 vfs: Arc::clone(&self.vfs),
211 latest_requests: Arc::clone(&self.latest_requests),
212 check_fixes: Arc::clone(&self.diagnostics.check_fixes),
213 mem_docs: self.mem_docs.clone(),
214 semantic_tokens_cache: Arc::clone(&self.semantic_tokens_cache),
218 pub(crate) fn send_request<R: lsp_types::request::Request>(
223 let request = self.req_queue.outgoing.register(R::METHOD.to_string(), params, handler);
224 self.send(request.into());
226 pub(crate) fn complete_request(&mut self, response: lsp_server::Response) {
227 let handler = self.req_queue.outgoing.complete(response.id.clone());
228 handler(self, response)
231 pub(crate) fn send_notification<N: lsp_types::notification::Notification>(
235 let not = lsp_server::Notification::new(N::METHOD.to_string(), params);
236 self.send(not.into());
239 pub(crate) fn register_request(
241 request: &lsp_server::Request,
242 request_received: Instant,
246 .register(request.id.clone(), (request.method.clone(), request_received));
248 pub(crate) fn respond(&mut self, response: lsp_server::Response) {
249 if let Some((method, start)) = self.req_queue.incoming.complete(response.id.clone()) {
250 let duration = start.elapsed();
251 log::info!("handled req#{} in {:?}", response.id, duration);
252 let metrics = RequestMetrics { id: response.id.clone(), method, duration };
253 self.latest_requests.write().record(metrics);
254 self.send(response.into());
257 pub(crate) fn cancel(&mut self, request_id: lsp_server::RequestId) {
258 if let Some(response) = self.req_queue.incoming.cancel(request_id) {
259 self.send(response.into());
263 fn send(&mut self, message: lsp_server::Message) {
264 self.sender.send(message).unwrap()
268 impl Drop for GlobalState {
270 self.analysis_host.request_cancellation()
274 impl GlobalStateSnapshot {
275 pub(crate) fn url_to_file_id(&self, url: &Url) -> Result<FileId> {
276 url_to_file_id(&self.vfs.read().0, url)
279 pub(crate) fn file_id_to_url(&self, id: FileId) -> Url {
280 file_id_to_url(&self.vfs.read().0, id)
283 pub(crate) fn file_line_index(&self, file_id: FileId) -> Cancelable<LineIndex> {
284 let endings = self.vfs.read().1[&file_id];
285 let index = self.analysis.file_line_index(file_id)?;
286 let res = LineIndex { index, endings, encoding: self.config.offset_encoding() };
290 pub(crate) fn url_file_version(&self, url: &Url) -> Option<i32> {
291 let path = from_proto::vfs_path(&url).ok()?;
292 Some(self.mem_docs.get(&path)?.version)
295 pub(crate) fn anchored_path(&self, path: &AnchoredPathBuf) -> Url {
296 let mut base = self.vfs.read().0.file_path(path.anchor);
298 let path = base.join(&path.path).unwrap();
299 let path = path.as_path().unwrap();
300 url_from_abs_path(&path)
303 pub(crate) fn cargo_target_for_crate_root(
306 ) -> Option<(&CargoWorkspace, Target)> {
307 let file_id = self.analysis.crate_root(crate_id).ok()?;
308 let path = self.vfs.read().0.file_path(file_id);
309 let path = path.as_path()?;
310 self.workspaces.iter().find_map(|ws| match ws {
311 ProjectWorkspace::Cargo { cargo, .. } => {
312 cargo.target_by_root(&path).map(|it| (cargo, it))
314 ProjectWorkspace::Json { .. } => None,
319 pub(crate) fn file_id_to_url(vfs: &vfs::Vfs, id: FileId) -> Url {
320 let path = vfs.file_path(id);
321 let path = path.as_path().unwrap();
322 url_from_abs_path(&path)
325 pub(crate) fn url_to_file_id(vfs: &vfs::Vfs, url: &Url) -> Result<FileId> {
326 let path = from_proto::vfs_path(url)?;
327 let res = vfs.file_id(&path).ok_or_else(|| format!("file not found: {}", path))?;