]> git.lizzy.rs Git - rust.git/commit - src/tools/rust-analyzer
Rollup merge of #81542 - RReverser:wasi-symlink, r=alexcrichton
authorMara Bos <m-ou.se@m-ou.se>
Fri, 5 Feb 2021 11:26:00 +0000 (12:26 +0100)
committerGitHub <noreply@github.com>
Fri, 5 Feb 2021 11:26:00 +0000 (12:26 +0100)
commitce1020fc55d901838477ed5626c332c48ca16fd4
treed773fed5e2e5b15d6f4567ca1a7e338aa6adb6a2
parente98e42b881227113979092fb48a3096a115d2217
parentf4b1bef542b209ba92187b06d19f84374e51a746
Rollup merge of #81542 - RReverser:wasi-symlink, r=alexcrichton

Expose correct symlink API on WASI

As described in https://github.com/rust-lang/rust/issues/68574, the currently exposed API for symlinks is, in fact, a thin wrapper around the corresponding syscall, and not suitable for public usage.

The reason is that the 2nd param in the call is expected to be a handle of a "preopened directory" (a WASI concept for exposing dirs), and the only way to retrieve such handle right now is by tinkering with a private `__wasilibc_find_relpath` API, which is an implementation detail and definitely not something we want users to call directly.

Making matters worse, the semantics of this param aren't obvious from its name (`fd`), and easy to misinterpret, resulting in people trying to pass a handle of the target file itself (as in https://github.com/vitiral/path_abs/pull/50), which doesn't work as expected.

I did a [codesearch among open-source repos](https://sourcegraph.com/search?q=std%3A%3Aos%3A%3Awasi%3A%3Afs%3A%3Asymlink&patternType=literal), and the usage above is so far the only usage of this API at all, but we should fix it before more people start using it incorrectly.

While this is technically a breaking API change, I believe it's a justified one, as 1) it's OS-specific and 2) there was strictly no way to correctly use the previous form of the API, and if someone does use it, they're likely doing it wrong like in the example above.

The new API does not lead to the same confusion, as it mirrors `std::os::unix::fs::symlink` and `std::os::windows::fs::symlink_{file,dir}` variants by accepting source/target paths.

Fixes #68574.

r? ``@alexcrichton``