//! The main loop of `rust-analyzer` responsible for dispatching LSP //! requests/replies and notifications back to the client. mod handlers; mod subscriptions; pub(crate) mod pending_requests; use std::{ env, error::Error, fmt, panic, path::PathBuf, sync::Arc, time::{Duration, Instant}, }; use crossbeam_channel::{select, unbounded, RecvError, Sender}; use lsp_server::{Connection, ErrorCode, Message, Notification, Request, RequestId, Response}; use lsp_types::{ClientCapabilities, NumberOrString}; use ra_cargo_watch::{url_from_path_with_drive_lowercasing, CheckOptions, CheckTask}; use ra_ide::{Canceled, FileId, LibraryData, SourceRootId}; use ra_prof::profile; use ra_vfs::{VfsFile, VfsTask, Watch}; use relative_path::RelativePathBuf; use rustc_hash::FxHashSet; use serde::{de::DeserializeOwned, Serialize}; use threadpool::ThreadPool; use crate::{ diagnostics::DiagnosticTask, feature_flags::FeatureFlags, main_loop::{ pending_requests::{PendingRequest, PendingRequests}, subscriptions::Subscriptions, }, req, world::{Options, WorldSnapshot, WorldState}, Result, ServerConfig, }; #[derive(Debug)] pub struct LspError { pub code: i32, pub message: String, } impl LspError { pub const UNKNOWN_FILE: i32 = -32900; pub fn new(code: i32, message: String) -> LspError { LspError { code, message } } } impl fmt::Display for LspError { fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { write!(f, "Language Server request failed with {}. ({})", self.code, self.message) } } impl Error for LspError {} pub fn main_loop( ws_roots: Vec, client_caps: ClientCapabilities, config: ServerConfig, connection: Connection, ) -> Result<()> { log::info!("server_config: {:#?}", config); // Windows scheduler implements priority boosts: if thread waits for an // event (like a condvar), and event fires, priority of the thread is // temporary bumped. This optimization backfires in our case: each time the // `main_loop` schedules a task to run on a threadpool, the worker threads // gets a higher priority, and (on a machine with fewer cores) displaces the // main loop! We work-around this by marking the main loop as a // higher-priority thread. // // https://docs.microsoft.com/en-us/windows/win32/procthread/scheduling-priorities // https://docs.microsoft.com/en-us/windows/win32/procthread/priority-boosts // https://github.com/rust-analyzer/rust-analyzer/issues/2835 #[cfg(windows)] unsafe { use winapi::um::processthreadsapi::*; let thread = GetCurrentThread(); let thread_priority_above_normal = 1; SetThreadPriority(thread, thread_priority_above_normal); } let mut loop_state = LoopState::default(); let mut world_state = { let feature_flags = { let mut ff = FeatureFlags::default(); for (flag, value) in config.feature_flags { if ff.set(flag.as_str(), value).is_err() { log::error!("unknown feature flag: {:?}", flag); show_message( req::MessageType::Error, format!("unknown feature flag: {:?}", flag), &connection.sender, ); } } ff }; log::info!("feature_flags: {:#?}", feature_flags); // FIXME: support dynamic workspace loading. let workspaces = { let mut loaded_workspaces = Vec::new(); for ws_root in &ws_roots { let workspace = ra_project_model::ProjectWorkspace::discover_with_sysroot( ws_root.as_path(), config.with_sysroot, &config.cargo_features, ); match workspace { Ok(workspace) => loaded_workspaces.push(workspace), Err(e) => { log::error!("loading workspace failed: {:?}", e); if let Some(ra_project_model::CargoTomlNotFoundError { .. }) = e.downcast_ref() { if !feature_flags.get("notifications.cargo-toml-not-found") { continue; } } show_message( req::MessageType::Error, format!("rust-analyzer failed to load workspace: {:?}", e), &connection.sender, ); } } } loaded_workspaces }; let globs = config .exclude_globs .iter() .map(|glob| crate::vfs_glob::Glob::new(glob)) .collect::, _>>()?; if config.use_client_watching { let registration_options = req::DidChangeWatchedFilesRegistrationOptions { watchers: workspaces .iter() .flat_map(|ws| ws.to_roots()) .filter(|root| root.is_member()) .map(|root| format!("{}/**/*.rs", root.path().display())) .map(|glob_pattern| req::FileSystemWatcher { glob_pattern, kind: None }) .collect(), }; let registration = req::Registration { id: "file-watcher".to_string(), method: "workspace/didChangeWatchedFiles".to_string(), register_options: Some(serde_json::to_value(registration_options).unwrap()), }; let params = req::RegistrationParams { registrations: vec![registration] }; let request = request_new::(loop_state.next_request_id(), params); connection.sender.send(request.into()).unwrap(); } let options = { let text_document_caps = client_caps.text_document.as_ref(); Options { publish_decorations: config.publish_decorations, supports_location_link: text_document_caps .and_then(|it| it.definition) .and_then(|it| it.link_support) .unwrap_or(false), line_folding_only: text_document_caps .and_then(|it| it.folding_range.as_ref()) .and_then(|it| it.line_folding_only) .unwrap_or(false), max_inlay_hint_length: config.max_inlay_hint_length, cargo_watch: CheckOptions { enable: config.cargo_watch_enable, args: config.cargo_watch_args, command: config.cargo_watch_command, all_targets: config.cargo_watch_all_targets, }, rustfmt_args: config.rustfmt_args, } }; WorldState::new( ws_roots, workspaces, config.lru_capacity, &globs, Watch(!config.use_client_watching), options, feature_flags, ) }; let pool = ThreadPool::default(); let (task_sender, task_receiver) = unbounded::(); let (libdata_sender, libdata_receiver) = unbounded::(); log::info!("server initialized, serving requests"); { let task_sender = task_sender; let libdata_sender = libdata_sender; loop { log::trace!("selecting"); let event = select! { recv(&connection.receiver) -> msg => match msg { Ok(msg) => Event::Msg(msg), Err(RecvError) => return Err("client exited without shutdown".into()), }, recv(task_receiver) -> task => Event::Task(task.unwrap()), recv(world_state.task_receiver) -> task => match task { Ok(task) => Event::Vfs(task), Err(RecvError) => return Err("vfs died".into()), }, recv(libdata_receiver) -> data => Event::Lib(data.unwrap()), recv(world_state.check_watcher.task_recv) -> task => match task { Ok(task) => Event::CheckWatcher(task), Err(RecvError) => return Err("check watcher died".into()), } }; if let Event::Msg(Message::Request(req)) = &event { if connection.handle_shutdown(&req)? { break; }; } loop_turn( &pool, &task_sender, &libdata_sender, &connection, &mut world_state, &mut loop_state, event, )?; } } world_state.analysis_host.request_cancellation(); log::info!("waiting for tasks to finish..."); task_receiver.into_iter().for_each(|task| { on_task(task, &connection.sender, &mut loop_state.pending_requests, &mut world_state) }); libdata_receiver.into_iter().for_each(drop); log::info!("...tasks have finished"); log::info!("joining threadpool..."); drop(pool); log::info!("...threadpool has finished"); let vfs = Arc::try_unwrap(world_state.vfs).expect("all snapshots should be dead"); drop(vfs); Ok(()) } #[derive(Debug)] enum Task { Respond(Response), Notify(Notification), Diagnostic(DiagnosticTask), } enum Event { Msg(Message), Task(Task), Vfs(VfsTask), Lib(LibraryData), CheckWatcher(CheckTask), } impl fmt::Debug for Event { fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { let debug_verbose_not = |not: &Notification, f: &mut fmt::Formatter| { f.debug_struct("Notification").field("method", ¬.method).finish() }; match self { Event::Msg(Message::Notification(not)) => { if notification_is::(not) || notification_is::(not) { return debug_verbose_not(not, f); } } Event::Task(Task::Notify(not)) => { if notification_is::(not) || notification_is::(not) { return debug_verbose_not(not, f); } } Event::Task(Task::Respond(resp)) => { return f .debug_struct("Response") .field("id", &resp.id) .field("error", &resp.error) .finish(); } _ => (), } match self { Event::Msg(it) => fmt::Debug::fmt(it, f), Event::Task(it) => fmt::Debug::fmt(it, f), Event::Vfs(it) => fmt::Debug::fmt(it, f), Event::Lib(it) => fmt::Debug::fmt(it, f), Event::CheckWatcher(it) => fmt::Debug::fmt(it, f), } } } #[derive(Debug, Default)] struct LoopState { next_request_id: u64, pending_responses: FxHashSet, pending_requests: PendingRequests, subscriptions: Subscriptions, // We try not to index more than MAX_IN_FLIGHT_LIBS libraries at the same // time to always have a thread ready to react to input. in_flight_libraries: usize, pending_libraries: Vec<(SourceRootId, Vec<(FileId, RelativePathBuf, Arc)>)>, workspace_loaded: bool, } impl LoopState { fn next_request_id(&mut self) -> RequestId { self.next_request_id += 1; let res: RequestId = self.next_request_id.into(); let inserted = self.pending_responses.insert(res.clone()); assert!(inserted); res } } fn loop_turn( pool: &ThreadPool, task_sender: &Sender, libdata_sender: &Sender, connection: &Connection, world_state: &mut WorldState, loop_state: &mut LoopState, event: Event, ) -> Result<()> { let loop_start = Instant::now(); // NOTE: don't count blocking select! call as a loop-turn time let _p = profile("main_loop_inner/loop-turn"); log::info!("loop turn = {:?}", event); let queue_count = pool.queued_count(); if queue_count > 0 { log::info!("queued count = {}", queue_count); } match event { Event::Task(task) => { on_task(task, &connection.sender, &mut loop_state.pending_requests, world_state); world_state.maybe_collect_garbage(); } Event::Vfs(task) => { world_state.vfs.write().handle_task(task); } Event::Lib(lib) => { world_state.add_lib(lib); world_state.maybe_collect_garbage(); loop_state.in_flight_libraries -= 1; } Event::CheckWatcher(task) => on_check_task(task, world_state, task_sender)?, Event::Msg(msg) => match msg { Message::Request(req) => on_request( world_state, &mut loop_state.pending_requests, pool, task_sender, &connection.sender, loop_start, req, )?, Message::Notification(not) => { on_notification( &connection.sender, world_state, &mut loop_state.pending_requests, &mut loop_state.subscriptions, not, )?; } Message::Response(resp) => { let removed = loop_state.pending_responses.remove(&resp.id); if !removed { log::error!("unexpected response: {:?}", resp) } } }, }; let mut state_changed = false; if let Some(changes) = world_state.process_changes() { state_changed = true; loop_state.pending_libraries.extend(changes); } let max_in_flight_libs = pool.max_count().saturating_sub(2).max(1); while loop_state.in_flight_libraries < max_in_flight_libs && !loop_state.pending_libraries.is_empty() { let (root, files) = loop_state.pending_libraries.pop().unwrap(); loop_state.in_flight_libraries += 1; let sender = libdata_sender.clone(); pool.execute(move || { log::info!("indexing {:?} ... ", root); let data = LibraryData::prepare(root, files); sender.send(data).unwrap(); }); } if !loop_state.workspace_loaded && world_state.roots_to_scan == 0 && loop_state.pending_libraries.is_empty() && loop_state.in_flight_libraries == 0 { loop_state.workspace_loaded = true; let n_packages: usize = world_state.workspaces.iter().map(|it| it.n_packages()).sum(); if world_state.feature_flags.get("notifications.workspace-loaded") { let msg = format!("workspace loaded, {} rust packages", n_packages); show_message(req::MessageType::Info, msg, &connection.sender); } world_state.check_watcher.update(); pool.execute({ let subs = loop_state.subscriptions.subscriptions(); let snap = world_state.snapshot(); move || snap.analysis().prime_caches(subs).unwrap_or_else(|_: Canceled| ()) }); } if state_changed { update_file_notifications_on_threadpool( pool, world_state.snapshot(), world_state.options.publish_decorations, task_sender.clone(), loop_state.subscriptions.subscriptions(), ) } let loop_duration = loop_start.elapsed(); if loop_duration > Duration::from_millis(100) { log::error!("overly long loop turn: {:?}", loop_duration); if env::var("RA_PROFILE").is_ok() { show_message( req::MessageType::Error, format!("overly long loop turn: {:?}", loop_duration), &connection.sender, ); } } Ok(()) } fn on_task( task: Task, msg_sender: &Sender, pending_requests: &mut PendingRequests, state: &mut WorldState, ) { match task { Task::Respond(response) => { if let Some(completed) = pending_requests.finish(&response.id) { log::info!("handled req#{} in {:?}", completed.id, completed.duration); state.complete_request(completed); msg_sender.send(response.into()).unwrap(); } } Task::Notify(n) => { msg_sender.send(n.into()).unwrap(); } Task::Diagnostic(task) => on_diagnostic_task(task, msg_sender, state), } } fn on_request( world: &mut WorldState, pending_requests: &mut PendingRequests, pool: &ThreadPool, task_sender: &Sender, msg_sender: &Sender, request_received: Instant, req: Request, ) -> Result<()> { let mut pool_dispatcher = PoolDispatcher { req: Some(req), pool, world, task_sender, msg_sender, pending_requests, request_received, }; pool_dispatcher .on_sync::(|s, ()| Ok(s.collect_garbage()))? .on_sync::(|s, p| handlers::handle_join_lines(s.snapshot(), p))? .on_sync::(|s, p| handlers::handle_on_enter(s.snapshot(), p))? .on_sync::(|s, p| { handlers::handle_selection_range(s.snapshot(), p) })? .on_sync::(|s, p| { handlers::handle_find_matching_brace(s.snapshot(), p) })? .on::(handlers::handle_analyzer_status)? .on::(handlers::handle_syntax_tree)? .on::(handlers::handle_expand_macro)? .on::(handlers::handle_on_type_formatting)? .on::(handlers::handle_document_symbol)? .on::(handlers::handle_workspace_symbol)? .on::(handlers::handle_goto_definition)? .on::(handlers::handle_goto_implementation)? .on::(handlers::handle_goto_type_definition)? .on::(handlers::handle_parent_module)? .on::(handlers::handle_runnables)? .on::(handlers::handle_decorations)? .on::(handlers::handle_completion)? .on::(handlers::handle_code_action)? .on::(handlers::handle_code_lens)? .on::(handlers::handle_code_lens_resolve)? .on::(handlers::handle_folding_range)? .on::(handlers::handle_signature_help)? .on::(handlers::handle_hover)? .on::(handlers::handle_prepare_rename)? .on::(handlers::handle_rename)? .on::(handlers::handle_references)? .on::(handlers::handle_formatting)? .on::(handlers::handle_document_highlight)? .on::(handlers::handle_inlay_hints)? .on::(handlers::handle_call_hierarchy_prepare)? .on::(handlers::handle_call_hierarchy_incoming)? .on::(handlers::handle_call_hierarchy_outgoing)? .on::(handlers::handle_semantic_tokens)? .on::(handlers::handle_semantic_tokens_range)? .on::(handlers::handle_ssr)? .finish(); Ok(()) } fn on_notification( msg_sender: &Sender, state: &mut WorldState, pending_requests: &mut PendingRequests, subs: &mut Subscriptions, not: Notification, ) -> Result<()> { let not = match notification_cast::(not) { Ok(params) => { let id: RequestId = match params.id { NumberOrString::Number(id) => id.into(), NumberOrString::String(id) => id.into(), }; if pending_requests.cancel(&id) { let response = Response::new_err( id, ErrorCode::RequestCanceled as i32, "canceled by client".to_string(), ); msg_sender.send(response.into()).unwrap() } return Ok(()); } Err(not) => not, }; let not = match notification_cast::(not) { Ok(params) => { let uri = params.text_document.uri; let path = uri.to_file_path().map_err(|()| format!("invalid uri: {}", uri))?; if let Some(file_id) = state.vfs.write().add_file_overlay(&path, params.text_document.text) { subs.add_sub(FileId(file_id.0)); } return Ok(()); } Err(not) => not, }; let not = match notification_cast::(not) { Ok(mut params) => { let uri = params.text_document.uri; let path = uri.to_file_path().map_err(|()| format!("invalid uri: {}", uri))?; let text = params.content_changes.pop().ok_or_else(|| "empty changes".to_string())?.text; state.vfs.write().change_file_overlay(path.as_path(), text); return Ok(()); } Err(not) => not, }; let not = match notification_cast::(not) { Ok(_params) => { state.check_watcher.update(); return Ok(()); } Err(not) => not, }; let not = match notification_cast::(not) { Ok(params) => { let uri = params.text_document.uri; let path = uri.to_file_path().map_err(|()| format!("invalid uri: {}", uri))?; if let Some(file_id) = state.vfs.write().remove_file_overlay(path.as_path()) { subs.remove_sub(FileId(file_id.0)); } let params = req::PublishDiagnosticsParams { uri, diagnostics: Vec::new(), version: None }; let not = notification_new::(params); msg_sender.send(not.into()).unwrap(); return Ok(()); } Err(not) => not, }; let not = match notification_cast::(not) { Ok(_params) => { return Ok(()); } Err(not) => not, }; let not = match notification_cast::(not) { Ok(params) => { let mut vfs = state.vfs.write(); for change in params.changes { let uri = change.uri; let path = uri.to_file_path().map_err(|()| format!("invalid uri: {}", uri))?; vfs.notify_changed(path) } return Ok(()); } Err(not) => not, }; if not.method.starts_with("$/") { return Ok(()); } log::error!("unhandled notification: {:?}", not); Ok(()) } fn on_check_task( task: CheckTask, world_state: &mut WorldState, task_sender: &Sender, ) -> Result<()> { match task { CheckTask::ClearDiagnostics => { task_sender.send(Task::Diagnostic(DiagnosticTask::ClearCheck))?; } CheckTask::AddDiagnostic { url, diagnostic, fixes } => { let path = url.to_file_path().map_err(|()| format!("invalid uri: {}", url))?; let file_id = match world_state.vfs.read().path2file(&path) { Some(file) => FileId(file.0), None => { log::error!("File with cargo diagnostic not found in VFS: {}", path.display()); return Ok(()); } }; task_sender .send(Task::Diagnostic(DiagnosticTask::AddCheck(file_id, diagnostic, fixes)))?; } CheckTask::Status(progress) => { let params = req::ProgressParams { token: req::ProgressToken::String("rustAnalyzer/cargoWatcher".to_string()), value: req::ProgressParamsValue::WorkDone(progress), }; let not = notification_new::(params); task_sender.send(Task::Notify(not)).unwrap(); } }; Ok(()) } fn on_diagnostic_task(task: DiagnosticTask, msg_sender: &Sender, state: &mut WorldState) { let subscriptions = state.diagnostics.handle_task(task); for file_id in subscriptions { let path = state.vfs.read().file2path(VfsFile(file_id.0)); let uri = match url_from_path_with_drive_lowercasing(&path) { Ok(uri) => uri, Err(err) => { log::error!("Couldn't convert path to url ({}): {:?}", err, path.to_string_lossy()); continue; } }; let diagnostics = state.diagnostics.diagnostics_for(file_id).cloned().collect(); let params = req::PublishDiagnosticsParams { uri, diagnostics, version: None }; let not = notification_new::(params); msg_sender.send(not.into()).unwrap(); } } struct PoolDispatcher<'a> { req: Option, pool: &'a ThreadPool, world: &'a mut WorldState, pending_requests: &'a mut PendingRequests, msg_sender: &'a Sender, task_sender: &'a Sender, request_received: Instant, } impl<'a> PoolDispatcher<'a> { /// Dispatches the request onto the current thread fn on_sync( &mut self, f: fn(&mut WorldState, R::Params) -> Result, ) -> Result<&mut Self> where R: req::Request + 'static, R::Params: DeserializeOwned + panic::UnwindSafe + 'static, R::Result: Serialize + 'static, { let (id, params) = match self.parse::() { Some(it) => it, None => { return Ok(self); } }; let world = panic::AssertUnwindSafe(&mut *self.world); let task = panic::catch_unwind(move || { let result = f(world.0, params); result_to_task::(id, result) }) .map_err(|_| format!("sync task {:?} panicked", R::METHOD))?; on_task(task, self.msg_sender, self.pending_requests, self.world); Ok(self) } /// Dispatches the request onto thread pool fn on(&mut self, f: fn(WorldSnapshot, R::Params) -> Result) -> Result<&mut Self> where R: req::Request + 'static, R::Params: DeserializeOwned + Send + 'static, R::Result: Serialize + 'static, { let (id, params) = match self.parse::() { Some(it) => it, None => { return Ok(self); } }; self.pool.execute({ let world = self.world.snapshot(); let sender = self.task_sender.clone(); move || { let result = f(world, params); let task = result_to_task::(id, result); sender.send(task).unwrap(); } }); Ok(self) } fn parse(&mut self) -> Option<(RequestId, R::Params)> where R: req::Request + 'static, R::Params: DeserializeOwned + 'static, { let req = self.req.take()?; let (id, params) = match req.extract::(R::METHOD) { Ok(it) => it, Err(req) => { self.req = Some(req); return None; } }; self.pending_requests.start(PendingRequest { id: id.clone(), method: R::METHOD.to_string(), received: self.request_received, }); Some((id, params)) } fn finish(&mut self) { match self.req.take() { None => (), Some(req) => { log::error!("unknown request: {:?}", req); let resp = Response::new_err( req.id, ErrorCode::MethodNotFound as i32, "unknown request".to_string(), ); self.msg_sender.send(resp.into()).unwrap(); } } } } fn result_to_task(id: RequestId, result: Result) -> Task where R: req::Request + 'static, R::Params: DeserializeOwned + 'static, R::Result: Serialize + 'static, { let response = match result { Ok(resp) => Response::new_ok(id, &resp), Err(e) => match e.downcast::() { Ok(lsp_error) => { if lsp_error.code == LspError::UNKNOWN_FILE { // Work-around for https://github.com/rust-analyzer/rust-analyzer/issues/1521 Response::new_ok(id, ()) } else { Response::new_err(id, lsp_error.code, lsp_error.message) } } Err(e) => { if is_canceled(&e) { Response::new_err( id, ErrorCode::ContentModified as i32, "content modified".to_string(), ) } else { Response::new_err(id, ErrorCode::InternalError as i32, e.to_string()) } } }, }; Task::Respond(response) } fn update_file_notifications_on_threadpool( pool: &ThreadPool, world: WorldSnapshot, publish_decorations: bool, task_sender: Sender, subscriptions: Vec, ) { log::trace!("updating notifications for {:?}", subscriptions); let publish_diagnostics = world.feature_flags.get("lsp.diagnostics"); pool.execute(move || { for file_id in subscriptions { if publish_diagnostics { match handlers::publish_diagnostics(&world, file_id) { Err(e) => { if !is_canceled(&e) { log::error!("failed to compute diagnostics: {:?}", e); } } Ok(task) => { task_sender.send(Task::Diagnostic(task)).unwrap(); } } } if publish_decorations { match handlers::publish_decorations(&world, file_id) { Err(e) => { if !is_canceled(&e) { log::error!("failed to compute decorations: {:?}", e); } } Ok(params) => { let not = notification_new::(params); task_sender.send(Task::Notify(not)).unwrap(); } } } } }); } pub fn show_message(typ: req::MessageType, message: impl Into, sender: &Sender) { let message = message.into(); let params = req::ShowMessageParams { typ, message }; let not = notification_new::(params); sender.send(not.into()).unwrap(); } fn is_canceled(e: &Box) -> bool { e.downcast_ref::().is_some() } fn notification_is(notification: &Notification) -> bool { notification.method == N::METHOD } fn notification_cast(notification: Notification) -> std::result::Result where N: lsp_types::notification::Notification, N::Params: DeserializeOwned, { notification.extract(N::METHOD) } fn notification_new(params: N::Params) -> Notification where N: lsp_types::notification::Notification, N::Params: Serialize, { Notification::new(N::METHOD.to_string(), params) } fn request_new(id: RequestId, params: R::Params) -> Request where R: lsp_types::request::Request, R::Params: Serialize, { Request::new(id, R::METHOD.to_string(), params) }