Skip to contentSkip to conversation

bindgen-cli: set CLANG_PATH in native wrapper to native clang

PATCH Superseded [email protected] 3 participants 5 messages Jun 30 – Jul 12

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 bindgen-cli: set CLANG_PATH in native wrapper to native clang

From: Yogesh Tyagi <[email protected]>

bindgen uses the clang-sys crate to locate a 'clang' executable for querying default include paths. clang-sys's search order is CLANG_PATH, then libclang's directory, then 'llvm-config --bindir', then PATH.

When clang is used as the toolchain, the crossscripts llvm-config wrapper honours YOCTO_ALTERNATE_EXE_PATH and reports the target sysroot bindir. clang-sys's 'llvm-config --bindir' step then resolves to a target clang that cannot execute on the build host, so native bindgen fails with:

could not run executable .../recipe-sysroot/usr/bin/clang-NN:
No such file or directory (os error 2)

This is hit, for example, when building mesa with the rusticl/opencl PACKAGECONFIG, whose do_compile runs the native bindgen against rusticl_mesa_bindings.h.

Set CLANG_PATH to the native clang in the bindgen wrapper so clang-sys uses the runnable host binary first, short-circuiting the llvm-config lookup. The native wrapper already exports LIBCLANG_PATH the same way.

---
 .../bindgen-cli/bindgen-cli_0.72.1.bb               | 13 ++++++++++++-
 1 file changed, 12 insertions(+), 1 deletion(-)
meta/recipes-devtools/bindgen-cli/bindgen-cli_0.72.1.bb +12 -1
index 72dadfe52f..1e2b901aab 100644
@@ -11,8 +11,19 @@ SRCREV = "d874de8d646d9b8a3e7ba2db2bcd52f2fba8f1f5"
 
 require ${BPN}-crates.inc
 
+# bindgen uses the clang-sys crate to locate a 'clang' executable for querying
+# default include paths. clang-sys's search order is: CLANG_PATH, libclang's dir,
+# 'llvm-config --bindir', then PATH. When clang is the toolchain, the crossscripts
+# llvm-config wrapper honours YOCTO_ALTERNATE_EXE_PATH and reports the target
+# sysroot bindir, so clang-sys's 'llvm-config --bindir' step resolves to a target
+# clang that cannot run on the build host (native bindgen then fails with
+# "could not run executable .../clang-NN: No such file or directory", e.g. when
+# building mesa with the rusticl/opencl PACKAGECONFIG). Set CLANG_PATH to the
+# native clang so the runnable host binary is used first.
 do_install:append:class-native() {
-	create_wrapper ${D}/${bindir}/bindgen LIBCLANG_PATH="${STAGING_LIBDIR_NATIVE}"
+	create_wrapper ${D}/${bindir}/bindgen \
+		LIBCLANG_PATH="${STAGING_LIBDIR_NATIVE}" \
+		CLANG_PATH="${STAGING_BINDIR_NATIVE}/clang"
 }
 
 BBCLASSEXTEND = "native nativesdk"
Signature · 1 line
2.43.0
Reviewed-by on v1 1/1
#1 lore raw
Quoted 3 lines · Yogesh Tyagi

Set CLANG_PATH to the native clang in the bindgen wrapper so clang-sys uses the runnable host binary first, short-circuiting the llvm-config lookup. The native wrapper already exports LIBCLANG_PATH the same way.

The reasoning is sound, and beyond the mesa rusticl case this also helps the rust-in-kernel build: kernel-yocto-rust.bbclass pulls in both clang-native and bindgen-cli-native, so native bindgen can hit the same target-clang-via-llvm-config lookup. Pinning CLANG_PATH to the native clang that matches the native libclang is the consistent thing to do there too, so:

One thing while you're here: the recipe is BBCLASSEXTEND = "native nativesdk", but the wrapper fix is do_install:append:class-native() only. Unless I'm misreading it, that leaves the nativesdk bindgen wrapper with just LIBCLANG_PATH and no CLANG_PATH, so an SDK that runs bindgen (e.g. rust kernel-module development in the SDK, which is being wired up separately) would still hit the identical "could not run executable .../clang-NN" failure. If that's right, could you extend the CLANG_PATH export to the nativesdk wrapper as well? A shared helper (or a class-native/class-nativesdk pair pointing at the respective STAGING_BINDIR) would cover both. If nativesdk is already handled some other way, ignore me.

Bruce

#2 lore raw

2026. 07. 08. 14:41 keltezéssel, Bruce Ashfield via lists.openembedded.org írta:

Quoted 12 lines · Yogesh Tyagi
Quoted 3 lines

Set CLANG_PATH to the native clang in the bindgen wrapper so clang-sys uses the runnable host binary first, short-circuiting the llvm-config lookup. The native wrapper already exports LIBCLANG_PATH the same way.

The reasoning is sound, and beyond the mesa rusticl case this also helps the rust-in-kernel build: kernel-yocto-rust.bbclass pulls in both clang-native and bindgen-cli-native, so native bindgen can hit the same target-clang-via-llvm-config lookup. Pinning CLANG_PATH to the native clang that matches the native libclang is the consistent thing to do there too, so:

Quoted 22 lines

One thing while you're here: the recipe is BBCLASSEXTEND = "native nativesdk", but the wrapper fix is do_install:append:class-native() only. Unless I'm misreading it, that leaves the nativesdk bindgen wrapper with just LIBCLANG_PATH and no CLANG_PATH, so an SDK that runs bindgen (e.g. rust kernel-module development in the SDK, which is being wired up separately) would still hit the identical "could not run executable .../clang-NN" failure. If that's right, could you extend the CLANG_PATH export to the nativesdk wrapper as well? A shared helper (or a class-native/class-nativesdk pair pointing at the respective STAGING_BINDIR) would cover both. If nativesdk is already handled some other way, ignore me.

Bruce

-=-=-=-=-=-=-=-=-=-=-=-
Links: You receive all messages sent to this group.
View/Reply Online (#240483): https://lists.openembedded.org/g/openembedded-core/message/240483
Mute This Topic: https://lists.openembedded.org/mt/120052346/3617728
Group Owner: [email protected]
Unsubscribe: https://lists.openembedded.org/g/openembedded-core/unsub [[email protected]]
-=-=-=-=-=-=-=-=-=-=-=-

#3 lore raw
In reply to Bruce Ashfield
Quoted 19 lines · Bruce Ashfield
Quoted 6 lines · Yogesh Tyagi

Set CLANG_PATH to the native clang in the bindgen wrapper so clang- sys
uses the runnable host binary first, short-circuiting the llvm- config
lookup. The native wrapper already exports LIBCLANG_PATH the same way.

The reasoning is sound, and beyond the mesa rusticl case this also helps
the rust-in-kernel build: kernel-yocto-rust.bbclass pulls in both clang-native and bindgen-cli-native, so native bindgen can hit the same
target-clang-via-llvm-config lookup. Pinning CLANG_PATH to the native clang that matches the native libclang is the consistent thing to do there too, so:

Quoted 16 lines

One thing while you're here: the recipe is BBCLASSEXTEND = "native nativesdk", but the wrapper fix is do_install:append:class-native() only.
Unless I'm misreading it, that leaves the nativesdk bindgen wrapper with
just LIBCLANG_PATH and no CLANG_PATH, so an SDK that runs bindgen (e.g.
rust kernel-module development in the SDK, which is being wired up separately) would still hit the identical "could not run executable .../clang-NN" failure. If that's right, could you extend the CLANG_PATH
export to the nativesdk wrapper as well? A shared helper (or a class-native/class-nativesdk pair pointing at the respective STAGING_BINDIR) would cover both. If nativesdk is already handled some
other way, ignore me.

Thanks Bruce, good catch — you're right that the SDK case was uncovered.

One clarification: in v1 the recipe only had do_install:append:class- native(), so the nativesdk bindgen had no wrapper at all — not even LIBCLANG_PATH. Same failure mode, just with nothing set rather than only CLANG_PATH missing.

v2 adds a class-nativesdk wrapper. I went with an explicit class- native/class-nativesdk pair rather than a shared helper, because the staging dirs aren't symmetric between the two classes and a shared "point at the respective STAGING_BINDIR" helper actually breaks:

native uses STAGING_*_NATIVE, which sits entirely under base_prefix, so create_wrapper's relocation rewrites it cleanly.
nativesdk's STAGING_LIBDIR/STAGING_BINDIR are STAGING_DIR_HOST (recipe- sysroot, i.e. TMPDIR) + the SDK path. create_wrapper only relocates the base_prefix substring, so the recipe-sysroot prefix stays baked into the shipped wrapper. I hit exactly that: do_package_qa failed with contains reference to TMPDIR [buildpaths].
So the nativesdk wrapper uses the plain on-target ${libdir}/${bindir} instead, which relocate fully. Verified by building both variants:
bindgen-cli-native and nativesdk-bindgen-cli both build and pass package QA, and both generated wrappers come out relocatable as CLANG_PATH=$realdir/../../usr/bin/clang.

Since the patch grew a new task, I dropped your Reviewed-by from v2 — happy to carry it if you're good with the nativesdk addition.

Quoted 2 lines

Bruce

#4 lore raw

PATCH v2 1/1 bindgen-cli: set CLANG_PATH in native and nativesdk wrappers to matching clang

In reply to [email protected]

From: Yogesh Tyagi <[email protected]>

bindgen uses the clang-sys crate to locate a 'clang' executable for querying default include paths. clang-sys's search order is CLANG_PATH, then libclang's directory, then 'llvm-config --bindir', then PATH.

When clang is used as the toolchain, the crossscripts llvm-config wrapper honours YOCTO_ALTERNATE_EXE_PATH and reports the target sysroot bindir. clang-sys's 'llvm-config --bindir' step then resolves to a target clang that cannot execute on the build host, so bindgen fails with:

could not run executable .../recipe-sysroot/usr/bin/clang-NN:
No such file or directory (os error 2)

This is hit, for example, when building mesa with the rusticl/opencl PACKAGECONFIG, whose do_compile runs the native bindgen against rusticl_mesa_bindings.h, and when building rust-in-kernel via kernel-yocto-rust.bbclass, which pulls in clang-native and bindgen-cli-native.

Set CLANG_PATH to the clang that matches the wrapped libclang so clang-sys uses the runnable binary first, short-circuiting the llvm-config lookup. The wrapper already exports LIBCLANG_PATH the same way.

The recipe is BBCLASSEXTEND = "native nativesdk", but only the native variant had a wrapper. Add the equivalent nativesdk wrapper so an SDK that runs bindgen (e.g. rust kernel-module development in the SDK) does not hit the identical target-clang failure. The native wrapper uses STAGING_*_NATIVE; the nativesdk wrapper uses the on-target ${libdir}/ ${bindir} so create_wrapper's relocation rewrites the full path and the shipped wrapper carries no build-time (TMPDIR) reference.

---
v2:
- Add the missing nativesdk bindgen wrapper (v1 only wrapped native), so an SDK that runs bindgen does not hit the same target-clang failure.
- The nativesdk wrapper uses the on-target ${libdir}/${bindir} rather than STAGING_LIBDIR/STAGING_BINDIR: the latter include the recipe sysroot (TMPDIR) prefix, which create_wrapper's relocation does not strip, so the shipped wrapper failed do_package_qa with a buildpaths (reference to TMPDIR) error.

 .../bindgen-cli/bindgen-cli_0.72.1.bb         | 19 ++++++++++++++++++-
 1 file changed, 18 insertions(+), 1 deletion(-)
meta/recipes-devtools/bindgen-cli/bindgen-cli_0.72.1.bb +18 -1
index 72dadfe52f..2ef797c156 100644
@@ -11,8 +11,25 @@ SRCREV = "d874de8d646d9b8a3e7ba2db2bcd52f2fba8f1f5"
 
 require ${BPN}-crates.inc
 
+# bindgen uses the clang-sys crate to locate a 'clang' executable for querying
+# default include paths. clang-sys's search order is: CLANG_PATH, libclang's dir,
+# 'llvm-config --bindir', then PATH. When clang is the toolchain, the crossscripts
+# llvm-config wrapper honours YOCTO_ALTERNATE_EXE_PATH and reports the target
+# sysroot bindir, so clang-sys's 'llvm-config --bindir' step resolves to a target
+# clang that cannot run on the build host (native bindgen then fails with
+# "could not run executable .../clang-NN: No such file or directory", e.g. when
+# building mesa with the rusticl/opencl PACKAGECONFIG). Set CLANG_PATH to the
+# native clang so the runnable host binary is used first.
 do_install:append:class-native() {
-	create_wrapper ${D}/${bindir}/bindgen LIBCLANG_PATH="${STAGING_LIBDIR_NATIVE}"
+	create_wrapper ${D}/${bindir}/bindgen \
+		LIBCLANG_PATH="${STAGING_LIBDIR_NATIVE}" \
+		CLANG_PATH="${STAGING_BINDIR_NATIVE}/clang"
+}
+
+do_install:append:class-nativesdk() {
+	create_wrapper ${D}/${bindir}/bindgen \
+		LIBCLANG_PATH="${libdir}" \
+		CLANG_PATH="${bindir}/clang"
 }
 
 BBCLASSEXTEND = "native nativesdk"
Signature · 1 line
2.43.0