| 1 | //===- LSPServer.cpp - MLIR Language Server -------------------------------===// |
| 2 | // |
| 3 | // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions. |
| 4 | // See https://llvm.org/LICENSE.txt for license information. |
| 5 | // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception |
| 6 | // |
| 7 | //===----------------------------------------------------------------------===// |
| 8 | |
| 9 | #include "LSPServer.h" |
| 10 | #include "MLIRServer.h" |
| 11 | #include "Protocol.h" |
| 12 | #include "llvm/Support/LSP/Logging.h" |
| 13 | #include "llvm/Support/LSP/Transport.h" |
| 14 | #include <optional> |
| 15 | |
| 16 | #define DEBUG_TYPE "mlir-lsp-server" |
| 17 | |
| 18 | using namespace mlir; |
| 19 | using namespace mlir::lsp; |
| 20 | |
| 21 | using llvm::lsp::Callback; |
| 22 | using llvm::lsp::CodeAction; |
| 23 | using llvm::lsp::CodeActionParams; |
| 24 | using llvm::lsp::CompletionList; |
| 25 | using llvm::lsp::CompletionParams; |
| 26 | using llvm::lsp::DidChangeTextDocumentParams; |
| 27 | using llvm::lsp::DidCloseTextDocumentParams; |
| 28 | using llvm::lsp::DidOpenTextDocumentParams; |
| 29 | using llvm::lsp::DocumentSymbol; |
| 30 | using llvm::lsp::DocumentSymbolParams; |
| 31 | using llvm::lsp::Hover; |
| 32 | using llvm::lsp::InitializedParams; |
| 33 | using llvm::lsp::InitializeParams; |
| 34 | using llvm::lsp::JSONTransport; |
| 35 | using llvm::lsp::Logger; |
| 36 | using llvm::lsp::MessageHandler; |
| 37 | using llvm::lsp::MLIRConvertBytecodeParams; |
| 38 | using llvm::lsp::MLIRConvertBytecodeResult; |
| 39 | using llvm::lsp::NoParams; |
| 40 | using llvm::lsp::OutgoingNotification; |
| 41 | using llvm::lsp::PublishDiagnosticsParams; |
| 42 | using llvm::lsp::ReferenceParams; |
| 43 | using llvm::lsp::TextDocumentPositionParams; |
| 44 | using llvm::lsp::TextDocumentSyncKind; |
| 45 | using llvm::lsp::URIForFile; |
| 46 | |
| 47 | //===----------------------------------------------------------------------===// |
| 48 | // LSPServer |
| 49 | //===----------------------------------------------------------------------===// |
| 50 | |
| 51 | namespace { |
| 52 | struct LSPServer { |
| 53 | LSPServer(MLIRServer &server) : server(server) {} |
| 54 | |
| 55 | //===--------------------------------------------------------------------===// |
| 56 | // Initialization |
| 57 | |
| 58 | void onInitialize(const InitializeParams ¶ms, |
| 59 | Callback<llvm::json::Value> reply); |
| 60 | void onInitialized(const InitializedParams ¶ms); |
| 61 | void onShutdown(const NoParams ¶ms, Callback<std::nullptr_t> reply); |
| 62 | |
| 63 | //===--------------------------------------------------------------------===// |
| 64 | // Document Change |
| 65 | |
| 66 | void onDocumentDidOpen(const DidOpenTextDocumentParams ¶ms); |
| 67 | void onDocumentDidClose(const DidCloseTextDocumentParams ¶ms); |
| 68 | void onDocumentDidChange(const DidChangeTextDocumentParams ¶ms); |
| 69 | |
| 70 | //===--------------------------------------------------------------------===// |
| 71 | // Definitions and References |
| 72 | |
| 73 | void onGoToDefinition(const TextDocumentPositionParams ¶ms, |
| 74 | Callback<std::vector<llvm::lsp::Location>> reply); |
| 75 | void onReference(const ReferenceParams ¶ms, |
| 76 | Callback<std::vector<llvm::lsp::Location>> reply); |
| 77 | |
| 78 | //===--------------------------------------------------------------------===// |
| 79 | // Hover |
| 80 | |
| 81 | void onHover(const TextDocumentPositionParams ¶ms, |
| 82 | Callback<std::optional<Hover>> reply); |
| 83 | |
| 84 | //===--------------------------------------------------------------------===// |
| 85 | // Document Symbols |
| 86 | |
| 87 | void onDocumentSymbol(const DocumentSymbolParams ¶ms, |
| 88 | Callback<std::vector<DocumentSymbol>> reply); |
| 89 | |
| 90 | //===--------------------------------------------------------------------===// |
| 91 | // Code Completion |
| 92 | |
| 93 | void onCompletion(const CompletionParams ¶ms, |
| 94 | Callback<CompletionList> reply); |
| 95 | |
| 96 | //===--------------------------------------------------------------------===// |
| 97 | // Code Action |
| 98 | |
| 99 | void onCodeAction(const CodeActionParams ¶ms, |
| 100 | Callback<llvm::json::Value> reply); |
| 101 | |
| 102 | //===--------------------------------------------------------------------===// |
| 103 | // Bytecode |
| 104 | |
| 105 | void onConvertFromBytecode(const MLIRConvertBytecodeParams ¶ms, |
| 106 | Callback<MLIRConvertBytecodeResult> reply); |
| 107 | void onConvertToBytecode(const MLIRConvertBytecodeParams ¶ms, |
| 108 | Callback<MLIRConvertBytecodeResult> reply); |
| 109 | |
| 110 | //===--------------------------------------------------------------------===// |
| 111 | // Fields |
| 112 | //===--------------------------------------------------------------------===// |
| 113 | |
| 114 | MLIRServer &server; |
| 115 | |
| 116 | /// An outgoing notification used to send diagnostics to the client when they |
| 117 | /// are ready to be processed. |
| 118 | OutgoingNotification<PublishDiagnosticsParams> publishDiagnostics; |
| 119 | |
| 120 | /// Used to indicate that the 'shutdown' request was received from the |
| 121 | /// Language Server client. |
| 122 | bool shutdownRequestReceived = false; |
| 123 | }; |
| 124 | } // namespace |
| 125 | |
| 126 | //===----------------------------------------------------------------------===// |
| 127 | // Initialization |
| 128 | //===----------------------------------------------------------------------===// |
| 129 | |
| 130 | void LSPServer::onInitialize(const InitializeParams ¶ms, |
| 131 | Callback<llvm::json::Value> reply) { |
| 132 | // Configure the workspace root if it was provided. |
| 133 | if (params.rootUri) { |
| 134 | llvm::Expected<URIForFile> rootURI = URIForFile::fromURI(uri: *params.rootUri); |
| 135 | if (rootURI) |
| 136 | server.setWorkspaceRoot(rootURI->file()); |
| 137 | else |
| 138 | consumeError(Err: rootURI.takeError()); |
| 139 | } else if (params.rootPath) { |
| 140 | server.setWorkspaceRoot(*params.rootPath); |
| 141 | } |
| 142 | |
| 143 | // Send a response with the capabilities of this server. |
| 144 | llvm::json::Object serverCaps{ |
| 145 | {.K: "textDocumentSync" , |
| 146 | .V: llvm::json::Object{ |
| 147 | {.K: "openClose" , .V: true}, |
| 148 | {.K: "change" , .V: (int)TextDocumentSyncKind::Full}, |
| 149 | {.K: "save" , .V: true}, |
| 150 | }}, |
| 151 | {.K: "completionProvider" , |
| 152 | .V: llvm::json::Object{ |
| 153 | {.K: "allCommitCharacters" , |
| 154 | .V: { |
| 155 | "\t" , |
| 156 | ";" , |
| 157 | "," , |
| 158 | "." , |
| 159 | "=" , |
| 160 | }}, |
| 161 | {.K: "resolveProvider" , .V: false}, |
| 162 | {.K: "triggerCharacters" , |
| 163 | .V: {"." , "%" , "^" , "!" , "#" , "(" , "," , "<" , ":" , "[" , " " , "\"" , "/" }}, |
| 164 | }}, |
| 165 | {.K: "definitionProvider" , .V: true}, |
| 166 | {.K: "referencesProvider" , .V: true}, |
| 167 | {.K: "hoverProvider" , .V: true}, |
| 168 | |
| 169 | // For now we only support documenting symbols when the client supports |
| 170 | // hierarchical symbols. |
| 171 | {.K: "documentSymbolProvider" , |
| 172 | .V: params.capabilities.hierarchicalDocumentSymbol}, |
| 173 | }; |
| 174 | |
| 175 | // Per LSP, codeActionProvider can be either boolean or CodeActionOptions. |
| 176 | // CodeActionOptions is only valid if the client supports action literal |
| 177 | // via textDocument.codeAction.codeActionLiteralSupport. |
| 178 | serverCaps["codeActionProvider" ] = |
| 179 | params.capabilities.codeActionStructure |
| 180 | ? llvm::json::Object{{.K: "codeActionKinds" , |
| 181 | .V: {CodeAction::kQuickFix, CodeAction::kRefactor, |
| 182 | CodeAction::kInfo}}} |
| 183 | : llvm::json::Value(true); |
| 184 | |
| 185 | llvm::json::Object result{ |
| 186 | {{.K: "serverInfo" , |
| 187 | .V: llvm::json::Object{{.K: "name" , .V: "mlir-lsp-server" }, {.K: "version" , .V: "0.0.0" }}}, |
| 188 | {.K: "capabilities" , .V: std::move(serverCaps)}}}; |
| 189 | reply(std::move(result)); |
| 190 | } |
| 191 | void LSPServer::onInitialized(const InitializedParams &) {} |
| 192 | void LSPServer::onShutdown(const NoParams &, Callback<std::nullptr_t> reply) { |
| 193 | shutdownRequestReceived = true; |
| 194 | reply(nullptr); |
| 195 | } |
| 196 | |
| 197 | //===----------------------------------------------------------------------===// |
| 198 | // Document Change |
| 199 | //===----------------------------------------------------------------------===// |
| 200 | |
| 201 | void LSPServer::onDocumentDidOpen(const DidOpenTextDocumentParams ¶ms) { |
| 202 | PublishDiagnosticsParams diagParams(params.textDocument.uri, |
| 203 | params.textDocument.version); |
| 204 | server.addOrUpdateDocument(uri: params.textDocument.uri, contents: params.textDocument.text, |
| 205 | version: params.textDocument.version, |
| 206 | diagnostics&: diagParams.diagnostics); |
| 207 | |
| 208 | // Publish any recorded diagnostics. |
| 209 | publishDiagnostics(diagParams); |
| 210 | } |
| 211 | void LSPServer::onDocumentDidClose(const DidCloseTextDocumentParams ¶ms) { |
| 212 | std::optional<int64_t> version = |
| 213 | server.removeDocument(uri: params.textDocument.uri); |
| 214 | if (!version) |
| 215 | return; |
| 216 | |
| 217 | // Empty out the diagnostics shown for this document. This will clear out |
| 218 | // anything currently displayed by the client for this document (e.g. in the |
| 219 | // "Problems" pane of VSCode). |
| 220 | publishDiagnostics( |
| 221 | PublishDiagnosticsParams(params.textDocument.uri, *version)); |
| 222 | } |
| 223 | void LSPServer::onDocumentDidChange(const DidChangeTextDocumentParams ¶ms) { |
| 224 | // TODO: We currently only support full document updates, we should refactor |
| 225 | // to avoid this. |
| 226 | if (params.contentChanges.size() != 1) |
| 227 | return; |
| 228 | PublishDiagnosticsParams diagParams(params.textDocument.uri, |
| 229 | params.textDocument.version); |
| 230 | server.addOrUpdateDocument( |
| 231 | uri: params.textDocument.uri, contents: params.contentChanges.front().text, |
| 232 | version: params.textDocument.version, diagnostics&: diagParams.diagnostics); |
| 233 | |
| 234 | // Publish any recorded diagnostics. |
| 235 | publishDiagnostics(diagParams); |
| 236 | } |
| 237 | |
| 238 | //===----------------------------------------------------------------------===// |
| 239 | // Definitions and References |
| 240 | //===----------------------------------------------------------------------===// |
| 241 | |
| 242 | void LSPServer::onGoToDefinition( |
| 243 | const TextDocumentPositionParams ¶ms, |
| 244 | Callback<std::vector<llvm::lsp::Location>> reply) { |
| 245 | std::vector<llvm::lsp::Location> locations; |
| 246 | server.getLocationsOf(uri: params.textDocument.uri, defPos: params.position, locations); |
| 247 | reply(std::move(locations)); |
| 248 | } |
| 249 | |
| 250 | void LSPServer::onReference(const ReferenceParams ¶ms, |
| 251 | Callback<std::vector<llvm::lsp::Location>> reply) { |
| 252 | std::vector<llvm::lsp::Location> locations; |
| 253 | server.findReferencesOf(uri: params.textDocument.uri, pos: params.position, references&: locations); |
| 254 | reply(std::move(locations)); |
| 255 | } |
| 256 | |
| 257 | //===----------------------------------------------------------------------===// |
| 258 | // Hover |
| 259 | //===----------------------------------------------------------------------===// |
| 260 | |
| 261 | void LSPServer::onHover(const TextDocumentPositionParams ¶ms, |
| 262 | Callback<std::optional<Hover>> reply) { |
| 263 | reply(server.findHover(uri: params.textDocument.uri, hoverPos: params.position)); |
| 264 | } |
| 265 | |
| 266 | //===----------------------------------------------------------------------===// |
| 267 | // Document Symbols |
| 268 | //===----------------------------------------------------------------------===// |
| 269 | |
| 270 | void LSPServer::onDocumentSymbol(const DocumentSymbolParams ¶ms, |
| 271 | Callback<std::vector<DocumentSymbol>> reply) { |
| 272 | std::vector<DocumentSymbol> symbols; |
| 273 | server.findDocumentSymbols(uri: params.textDocument.uri, symbols); |
| 274 | reply(std::move(symbols)); |
| 275 | } |
| 276 | |
| 277 | //===----------------------------------------------------------------------===// |
| 278 | // Code Completion |
| 279 | //===----------------------------------------------------------------------===// |
| 280 | |
| 281 | void LSPServer::onCompletion(const CompletionParams ¶ms, |
| 282 | Callback<CompletionList> reply) { |
| 283 | reply(server.getCodeCompletion(uri: params.textDocument.uri, completePos: params.position)); |
| 284 | } |
| 285 | |
| 286 | //===----------------------------------------------------------------------===// |
| 287 | // Code Action |
| 288 | //===----------------------------------------------------------------------===// |
| 289 | |
| 290 | void LSPServer::onCodeAction(const CodeActionParams ¶ms, |
| 291 | Callback<llvm::json::Value> reply) { |
| 292 | URIForFile uri = params.textDocument.uri; |
| 293 | |
| 294 | // Check whether a particular CodeActionKind is included in the response. |
| 295 | auto isKindAllowed = [only(params.context.only)](StringRef kind) { |
| 296 | if (only.empty()) |
| 297 | return true; |
| 298 | return llvm::any_of(Range: only, P: [&](StringRef base) { |
| 299 | return kind.consume_front(Prefix: base) && |
| 300 | (kind.empty() || kind.starts_with(Prefix: "." )); |
| 301 | }); |
| 302 | }; |
| 303 | |
| 304 | // We provide a code action for fixes on the specified diagnostics. |
| 305 | std::vector<CodeAction> actions; |
| 306 | if (isKindAllowed(CodeAction::kQuickFix)) |
| 307 | server.getCodeActions(uri, pos: params.range.start, context: params.context, actions); |
| 308 | reply(std::move(actions)); |
| 309 | } |
| 310 | |
| 311 | //===----------------------------------------------------------------------===// |
| 312 | // Bytecode |
| 313 | //===----------------------------------------------------------------------===// |
| 314 | |
| 315 | void LSPServer::onConvertFromBytecode( |
| 316 | const MLIRConvertBytecodeParams ¶ms, |
| 317 | Callback<MLIRConvertBytecodeResult> reply) { |
| 318 | reply(server.convertFromBytecode(uri: params.uri)); |
| 319 | } |
| 320 | |
| 321 | void LSPServer::onConvertToBytecode(const MLIRConvertBytecodeParams ¶ms, |
| 322 | Callback<MLIRConvertBytecodeResult> reply) { |
| 323 | reply(server.convertToBytecode(uri: params.uri)); |
| 324 | } |
| 325 | |
| 326 | //===----------------------------------------------------------------------===// |
| 327 | // Entry point |
| 328 | //===----------------------------------------------------------------------===// |
| 329 | |
| 330 | LogicalResult lsp::runMlirLSPServer(MLIRServer &server, |
| 331 | JSONTransport &transport) { |
| 332 | LSPServer lspServer(server); |
| 333 | MessageHandler messageHandler(transport); |
| 334 | |
| 335 | // Initialization |
| 336 | messageHandler.method(Method: "initialize" , ThisPtr: &lspServer, Handler: &LSPServer::onInitialize); |
| 337 | messageHandler.notification(Method: "initialized" , ThisPtr: &lspServer, |
| 338 | Handler: &LSPServer::onInitialized); |
| 339 | messageHandler.method(Method: "shutdown" , ThisPtr: &lspServer, Handler: &LSPServer::onShutdown); |
| 340 | |
| 341 | // Document Changes |
| 342 | messageHandler.notification(Method: "textDocument/didOpen" , ThisPtr: &lspServer, |
| 343 | Handler: &LSPServer::onDocumentDidOpen); |
| 344 | messageHandler.notification(Method: "textDocument/didClose" , ThisPtr: &lspServer, |
| 345 | Handler: &LSPServer::onDocumentDidClose); |
| 346 | messageHandler.notification(Method: "textDocument/didChange" , ThisPtr: &lspServer, |
| 347 | Handler: &LSPServer::onDocumentDidChange); |
| 348 | |
| 349 | // Definitions and References |
| 350 | messageHandler.method(Method: "textDocument/definition" , ThisPtr: &lspServer, |
| 351 | Handler: &LSPServer::onGoToDefinition); |
| 352 | messageHandler.method(Method: "textDocument/references" , ThisPtr: &lspServer, |
| 353 | Handler: &LSPServer::onReference); |
| 354 | |
| 355 | // Hover |
| 356 | messageHandler.method(Method: "textDocument/hover" , ThisPtr: &lspServer, Handler: &LSPServer::onHover); |
| 357 | |
| 358 | // Document Symbols |
| 359 | messageHandler.method(Method: "textDocument/documentSymbol" , ThisPtr: &lspServer, |
| 360 | Handler: &LSPServer::onDocumentSymbol); |
| 361 | |
| 362 | // Code Completion |
| 363 | messageHandler.method(Method: "textDocument/completion" , ThisPtr: &lspServer, |
| 364 | Handler: &LSPServer::onCompletion); |
| 365 | |
| 366 | // Code Action |
| 367 | messageHandler.method(Method: "textDocument/codeAction" , ThisPtr: &lspServer, |
| 368 | Handler: &LSPServer::onCodeAction); |
| 369 | |
| 370 | // Bytecode |
| 371 | messageHandler.method(Method: "mlir/convertFromBytecode" , ThisPtr: &lspServer, |
| 372 | Handler: &LSPServer::onConvertFromBytecode); |
| 373 | messageHandler.method(Method: "mlir/convertToBytecode" , ThisPtr: &lspServer, |
| 374 | Handler: &LSPServer::onConvertToBytecode); |
| 375 | |
| 376 | // Diagnostics |
| 377 | lspServer.publishDiagnostics = |
| 378 | messageHandler.outgoingNotification<PublishDiagnosticsParams>( |
| 379 | Method: "textDocument/publishDiagnostics" ); |
| 380 | |
| 381 | // Run the main loop of the transport. |
| 382 | LogicalResult result = success(); |
| 383 | if (llvm::Error error = transport.run(Handler&: messageHandler)) { |
| 384 | Logger::error(Fmt: "Transport error: {0}" , Vals&: error); |
| 385 | llvm::consumeError(Err: std::move(error)); |
| 386 | result = failure(); |
| 387 | } else { |
| 388 | result = success(IsSuccess: lspServer.shutdownRequestReceived); |
| 389 | } |
| 390 | return result; |
| 391 | } |
| 392 | |