<div dir="ltr">Hi William,<div><br></div><div>This is an idea Ilya did some thinking about before. The motivation was slightly different (editor on laptop, clangd on remote workstation) but I believe equivalent. </div><div>We're not going to get around needing to have all sources on both machines (or mounted from one to the other). Clangd and the editor both need to see them. So I think the path translation is indeed the bit to attack. The scary thing about adding file mapping is doing it consistently everywhere without making mistakes or adding lots of noise to the code.</div><div><br></div><div>An idea I want to throw out there: clangd performs reads via a VFS. This is an existing abstraction where path translation could be added without any additional complexity to clangd proper. </div><div>The way this would work: we give clangd a different view of the world and connect it directly to the editor (on the host). This means clangd needs to speak the host's language, so the VFS needs to simulate the FS layout of the host.</div><div>This leads to the main limitation: we need a compilation database that's consistent with the *host's* file layout. I suspect mechanically transforming compilation databases is hard (relative paths etc), so this may mean running the build system on the host (at least sufficiently to generate the CDB).</div><div>Not sure if there's a way to modify this idea to avoid the limitation.</div><div><br></div><div>I'm interested in how else we can get clangd to expose a different view of the world than its VFS sees in a consistent way, too!</div></div><br><div class="gmail_quote"><div dir="ltr">On Thu, Jan 10, 2019 at 9:12 AM William Wagner via clangd-dev <<a href="mailto:clangd-dev@lists.llvm.org">clangd-dev@lists.llvm.org</a>> wrote:<br></div><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left:1px solid rgb(204,204,204);padding-left:1ex"><div style="color:rgb(49,49,49);font-family:Arial,"BB.Proportional";white-space:pre-wrap;word-spacing:1px;font-size:0.8125rem" dir="auto"><span style="font-size:0.8125rem">Hello,</span><br></div><br style="color:rgb(49,49,49);font-family:Arial,"BB.Proportional";white-space:pre-wrap;word-spacing:1px"><div style="color:rgb(49,49,49);font-family:Arial,"BB.Proportional";white-space:pre-wrap;word-spacing:1px;font-size:0.8125rem" dir="auto">I’ve been using clangd for developing a C++ project at work. Our development setup requires that we build and run our code inside a docker container. From a language server perspective this presents a few challenges:</div><br style="color:rgb(49,49,49);font-family:Arial,"BB.Proportional";white-space:pre-wrap;word-spacing:1px"><ol style="color:rgb(49,49,49);font-family:Arial,"BB.Proportional";white-space:pre-wrap;word-spacing:1px"><li style="list-style-type:decimal"><div style="font-size:0.8125rem">Communicating with the language server running in the container</div></li><li style="list-style-type:decimal"><div style="font-size:0.8125rem">Synchronizing the files between the host and the container</div></li><li style="list-style-type:decimal"><div style="font-size:0.8125rem">Translating file paths between the host lsp client  and docker lsp server</div></li><li style="list-style-type:decimal"><div style="font-size:0.8125rem">Having dependency files that are only in the container available to view on the host (for textDocument/definition on dependencies installed only in the container)</div></li></ol><br style="color:rgb(49,49,49);font-family:Arial,"BB.Proportional";white-space:pre-wrap;word-spacing:1px"><div style="color:rgb(49,49,49);font-family:Arial,"BB.Proportional";white-space:pre-wrap;word-spacing:1px;font-size:0.8125rem" dir="auto">Fortunately, docker’s facilities make 1) and 2) pretty easy to deal with. </div><br style="color:rgb(49,49,49);font-family:Arial,"BB.Proportional";white-space:pre-wrap;word-spacing:1px"><div style="color:rgb(49,49,49);font-family:Arial,"BB.Proportional";white-space:pre-wrap;word-spacing:1px;font-size:0.8125rem" dir="auto">1) can be solved by creating a bash script that contains something similar to:</div><div style="color:rgb(49,49,49);font-family:Arial,"BB.Proportional";white-space:pre-wrap;word-spacing:1px;font-size:0.8125rem" dir="auto"> `docker exec -i <build_container> /path/to/clangd ${@:1}`</div><div style="color:rgb(49,49,49);font-family:Arial,"BB.Proportional";white-space:pre-wrap;word-spacing:1px;font-size:0.8125rem" dir="auto">and pointing clangd.path to this script</div><br style="color:rgb(49,49,49);font-family:Arial,"BB.Proportional";white-space:pre-wrap;word-spacing:1px"><div style="color:rgb(49,49,49);font-family:Arial,"BB.Proportional";white-space:pre-wrap;word-spacing:1px;font-size:0.8125rem" dir="auto">2) can be solved by using a docker bind mount, which maps the directory of the project you’re working on into the container</div><br style="color:rgb(49,49,49);font-family:Arial,"BB.Proportional";white-space:pre-wrap;word-spacing:1px"><div style="color:rgb(49,49,49);font-family:Arial,"BB.Proportional";white-space:pre-wrap;word-spacing:1px;font-size:0.8125rem" dir="auto">3) can be solved by mounting the host:/path/to/project to an identical path in the container. Then there doesn't have to be any translation between the requests/responses between the file uris that the client and server send back and forth. However, this may not always be possible and still leaves the problem of external dependency paths.</div><br style="color:rgb(49,49,49);font-family:Arial,"BB.Proportional";white-space:pre-wrap;word-spacing:1px"><div style="color:rgb(49,49,49);font-family:Arial,"BB.Proportional";white-space:pre-wrap;word-spacing:1px;font-size:0.8125rem" dir="auto">4) has no easy solution yet afaik. A potentially simple one would be to copy just the dependency headers from the container over to some directory on the host, and be able to translate clangd response file uris to the appropriate path on the host. The way I envision that is an extra arg to the clangd server that supports path substitution, such as:</div><br style="color:rgb(49,49,49);font-family:Arial,"BB.Proportional";white-space:pre-wrap;word-spacing:1px"><div style="color:rgb(49,49,49);font-family:Arial,"BB.Proportional";white-space:pre-wrap;word-spacing:1px;font-size:0.8125rem" dir="auto">`clangd -path-mappings=’/host/home/project/deps:/container/deps;/host/home/project/:container/project`</div><br style="color:rgb(49,49,49);font-family:Arial,"BB.Proportional";white-space:pre-wrap;word-spacing:1px"><div style="color:rgb(49,49,49);font-family:Arial,"BB.Proportional";white-space:pre-wrap;word-spacing:1px;font-size:0.8125rem" dir="auto">So if I “Go To Definition” on an external symbol e.g. Foo, which is defined in /container/deps/foo.hh”, and I have the foo.hh header in /host/home/project/.deps/foo.hh, then the response from the servers textDocument/definition would substitute the /container/deps/foo.hh → /host/home/project/.deps/foo.hh and all would be well. </div><br style="color:rgb(49,49,49);font-family:Arial,"BB.Proportional";white-space:pre-wrap;word-spacing:1px"><div style="color:rgb(49,49,49);font-family:Arial,"BB.Proportional";white-space:pre-wrap;word-spacing:1px;font-size:0.8125rem" dir="auto">I believe sourcegraph has implemented an extension to the LSP to handle missing files on the client/server, but I cannot find the proposed spec. Also these are some github discussions that touch on the topics above:</div><ul style="color:rgb(49,49,49);font-family:Arial,"BB.Proportional";white-space:pre-wrap;word-spacing:1px"><li style="list-style-type:disc"><div style="font-size:0.8125rem">Ccls supports a path Mappings config option that allows substitution, see <a href="https://github.com/MaskRay/ccls/issues/75" target="_blank"><span style="font-size:0.8125rem">https://github.com/MaskRay/ccls/issues/75</span></a></div></li><li style="list-style-type:disc"><div style="font-size:0.8125rem">Discussion on remote langauge server proposal <span style="font-size:0.8125rem"><a href="https://github.com/Microsoft/language-server-protocol/issues/528" target="_blank">https://github.com/Microsoft/language-server-protocol/issues/528</a></span></div></li></ul><br style="color:rgb(49,49,49);font-family:Arial,"BB.Proportional";white-space:pre-wrap;word-spacing:1px"><div style="color:rgb(49,49,49);font-family:Arial,"BB.Proportional";white-space:pre-wrap;word-spacing:1px;font-size:0.8125rem" dir="auto">I’d be happy to implement this path mapping functionality, but thought it’d be prudent to see what everyone else thinks before doing so.</div><br style="color:rgb(49,49,49);font-family:Arial,"BB.Proportional";white-space:pre-wrap;word-spacing:1px"><div style="color:rgb(49,49,49);font-family:Arial,"BB.Proportional";white-space:pre-wrap;word-spacing:1px;font-size:0.8125rem" dir="auto">Thanks!</div><br style="color:rgb(49,49,49);font-family:Arial,"BB.Proportional";white-space:pre-wrap;word-spacing:1px"><br style="color:rgb(49,49,49);font-family:Arial,"BB.Proportional";white-space:pre-wrap;word-spacing:1px">
_______________________________________________<br>
clangd-dev mailing list<br>
<a href="mailto:clangd-dev@lists.llvm.org" target="_blank">clangd-dev@lists.llvm.org</a><br>
<a href="http://lists.llvm.org/cgi-bin/mailman/listinfo/clangd-dev" rel="noreferrer" target="_blank">http://lists.llvm.org/cgi-bin/mailman/listinfo/clangd-dev</a><br>
</blockquote></div>