std.Build: add support for adding specific global search paths #22552
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
BratishkaErik
force-pushed
the
search-prefix-exact
branch
from
ffd95f4 to
47c69de
Compare
|
aarch64-linux-debug failure seems to be a regular |
BratishkaErik
force-pushed
the
search-prefix-exact
branch
from
47c69de to
d759b1e
Compare
alexrp
force-pushed
the
search-prefix-exact
branch
from
d759b1e to
836795d
Compare
alexrp
reviewed
Mar 26, 2025
alexrp
reviewed
Mar 26, 2025
alexrp
reviewed
Mar 26, 2025
|
I like where this is going overall; seems obviously useful to distro maintainers. @andrewrk should probably have a look too though. |
Signed-off-by: Eric Joldasov <[email protected]>
This allows more granularity when adding search paths, complementing
`--search-prefix` for more specific use-cases.
## Multi-arch library layout
On systems with multilib support (e.g. Gentoo with 32-bit and 64-bit
libraries in `/usr/lib` and `/usr/lib64` respectively), using
`--search-prefix` option can cause incorrect library selected.
For example, if I want to link system `libcurl` library when building
Zig program for non-native or explicit native-compatible target,
I can try using `--search-prefix /usr`, which will automatically add:
* `/usr/bin` as search path for binaries (fine),
* `/usr/lib` as search path for libraries (incorrect),
* `/usr/include` as search path for includes (fine),
In my case it will find 32-bit libraries for 64-bit target, causing
linker errors:
```console
$ zig build -Dtarget=x86_64-linux-gnu.2.35 --search-prefix /usr
error: ld.lld: /usr/lib/libcurl.so is incompatible with elf_x86_64
```
New `--search-paths` option allows to add search paths explicitly,
using passed ZON file as a specification. You can repeat multiple
times to add many different search paths if needed.
```zig
.{
.binaries = "/usr/bin"
.libraries = "/usr/lib64",
.includes = "/usr/include",
}
```
## Other layouts (GCC or Android NDK etc.)
Another use-case is when binaries, libraries and includes are
distributed across different hierarchies. Suppose I want to correctly
find `gcc` binary and link `gccjit` library for my project:
```zig
.{
.binaries = "/usr/x86_64-pc-linux-gnu/gcc-bin/14/",
.libraries = "/usr/lib/gcc/x86_64-pc-linux-gnu/14",
.includes = "/usr/lib/gcc/x86_64-pc-linux-gnu/14/include/",
}
```
Or use Android NDK:
```zig
.{
// you can omit fields or set `null` if you don't want to search them.
// .binaries = null,
.libraries = "/path_to_ndk/toolchains/llvm/prebuilt/linux-x86_64/sysroot/usr/lib/aarch64-linux-android/35",
.includes = "/path_to_ndk/toolchains/llvm/prebuilt/linux-x86_64/sysroot/usr/include",
}
```
```zig
.{
.libraries = "/path_to_ndk/toolchains/llvm/prebuilt/linux-x86_64/sysroot/usr/lib/aarch64-linux-android",
}
```
Signed-off-by: Eric Joldasov <[email protected]>
BratishkaErik
force-pushed
the
search-prefix-exact
branch
from
836795d to
ebd8dd0
Compare
BratishkaErik
changed the title
alexrp
approved these changes
Mar 26, 2025
BratishkaErik
commented
Mar 27, 2025
| includes: ?LazyPath = null, | ||
| }; | ||
|
|
||
| pub fn binaries(self: SearchMethod, b: *std.Build) ?LazyPath { |
There was a problem hiding this comment.
Maybe LazyPath is not the most suitable choice here? They are used by findProgram in configure phase, and so can't have generated LazyPath.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This allows more granularity when adding search paths, complementing
--search-prefixfor more specific use-cases.Multi-arch library layout
On systems with multilib support (e.g. Gentoo with 32-bit and 64-bit
libraries in
/usr/liband/usr/lib64respectively), using--search-prefixoption can cause incorrect library selected.For example, if I want to link system
libcurllibrary when buildingZig program for non-native or explicit native-compatible target,
I can try using
--search-prefix /usr, which will automatically add:/usr/binas search path for binaries (fine),/usr/libas search path for libraries (incorrect),/usr/includeas search path for includes (fine),In my case it will find 32-bit libraries for 64-bit target, causing
linker errors:
New
--search-pathsoption allows to add search paths explicitly,using passed ZON file as a specification. You can repeat multiple
times to add many different search paths if needed.
.{ .binaries = "/usr/bin" .libraries = "/usr/lib64", .includes = "/usr/include", }Other layouts (GCC or Android NDK etc.)
Another use-case is when binaries, libraries and includes are
distributed across different hierarchies. Suppose I want to correctly
find
gccbinary and linkgccjitlibrary for my project:.{ .binaries = "/usr/x86_64-pc-linux-gnu/gcc-bin/14/", .libraries = "/usr/lib/gcc/x86_64-pc-linux-gnu/14", .includes = "/usr/lib/gcc/x86_64-pc-linux-gnu/14/include/", }Or use Android NDK:
.{ // you can omit fields or set `null` if you don't want to search them. // .binaries = null, .libraries = "/path_to_ndk/toolchains/llvm/prebuilt/linux-x86_64/sysroot/usr/lib/aarch64-linux-android/35", .includes = "/path_to_ndk/toolchains/llvm/prebuilt/linux-x86_64/sysroot/usr/include", }.{ .libraries = "/path_to_ndk/toolchains/llvm/prebuilt/linux-x86_64/sysroot/usr/lib/aarch64-linux-android", }