Fix incorrect NDEBUG handling in LLVM bindings #127654

nikic · 2024-07-12T12:59:08Z

We currently compile our LLVM bindings using -DNDEBUG if debuginfo for LLVM is disabled. However, NDEBUG doesn't have any relation to debuginfo, it controls whether assertions are enabled.

Split the LLVM_NDEBUG environment variable into two, so that assertions and debuginfo are controlled independently.

After this change, LLVMRustDIBuilderInsertDeclareAtEnd triggers an assertion failure on LLVM 19 due to an incorrect cast. Fix it by removing the unused return value entirely.

r? @cuviper

cuviper · 2024-07-12T20:05:47Z

compiler/rustc_llvm/build.rs

        cfg.define("NDEBUG", None);
+    }
+
+    if tracked_env_var_os("LLVM_NO_DEBUGINFO").is_some() {


Maybe we should use DEBUG here, as set by Cargo, so it's based on the crate debug level rather than the LLVM build. That will make a difference in distro builds that aren't even building LLVM at all.

Actually, cc::Build should do that automatically, so I think we don't need any manual setting.

Per https://docs.rs/cc/1.1.1/cc/struct.Build.html#method.debug this actually already happens automatically, so I think this code should just be removed.

Oops, race condition :)

We currently compile our LLVM bindings using `-DNDEBUG` if debuginfo for LLVM is disabled. However, `NDEBUG` doesn't have any relation to debuginfo, it controls whether assertions are enabled. Rename the environment variable to `LLVM_ASSERTIONS` and drive it using the `llvm_assertions` option. Also drop the explicit `debug(false)` call, as cc already sets this up using the cargo `DEBUG` environment variable.

The return value changed from an Instruction to a DbgRecord in LLVM 19. As we don't actually use the result, drop the return value entirely to support both.

cuviper · 2024-07-12T20:57:51Z

@bors r+ rollup

bors · 2024-07-12T20:57:53Z

📌 Commit 8dfd3a4 has been approved by cuviper

It is now in the queue for this repository.

Rollup of 3 pull requests Successful merges: - rust-lang#127654 (Fix incorrect NDEBUG handling in LLVM bindings) - rust-lang#127661 (Stabilize io_slice_advance) - rust-lang#127668 (Improved slice documentation) r? `@ghost` `@rustbot` modify labels: rollup

Rollup merge of rust-lang#127654 - nikic:llvm-ndebug-fix, r=cuviper Fix incorrect NDEBUG handling in LLVM bindings We currently compile our LLVM bindings using `-DNDEBUG` if debuginfo for LLVM is disabled. However, `NDEBUG` doesn't have any relation to debuginfo, it controls whether assertions are enabled. Split the LLVM_NDEBUG environment variable into two, so that assertions and debuginfo are controlled independently. After this change, `LLVMRustDIBuilderInsertDeclareAtEnd` triggers an assertion failure on LLVM 19 due to an incorrect cast. Fix it by removing the unused return value entirely. r? `@cuviper`

Update to LLVM 19 Related changes: * rust-lang#127605 * rust-lang#127613 * rust-lang#127654 * rust-lang#128141 * llvm/llvm-project#98933 try-job: dist-x86_64-apple try-job: dist-apple-various try-job: x86_64-apple-1 try-job: x86_64-apple-2 try-job: dist-aarch64-apple try-job: aarch64-apple

Update to LLVM 19 Related changes: * rust-lang#127605 * rust-lang#127613 * rust-lang#127654 * rust-lang#128141 * llvm/llvm-project#98933 try-job: x86_64-msvc try-job: i686-msvc try-job: x86_64-msvc-ext try-job: dist-x86_64-msvc try-job: dist-i686-msvc try-job: dist-aarch64-msvc try-job: dist-x86_64-msvc-alt

Update to LLVM 19 Related changes: * rust-lang#127605 * rust-lang#127613 * rust-lang#127654 * rust-lang#128141 * llvm/llvm-project#98933 try-job: i686-mingw try-job: x86_64-mingw try-job: dist-i686-mingw try-job: dist-x86_64-mingw

Update to LLVM 19 The LLVM 19.1.0 final release is planned for Sep 3rd. The rustc 1.82 stable release will be on Oct 17th. The unstable MC/DC coverage support is temporarily broken by this update. It will be restored by rust-lang#126733. The implementation changed substantially in LLVM 19, and there are no plans to support both the LLVM 18 and LLVM 19 implementation at the same time. Compatibility note for wasm: > WebAssembly target support for the `multivalue` target feature has changed when upgrading to LLVM 19. Support for generating functions with multiple returns no longer works and `-Ctarget-feature=+multivalue` has a different meaning than it did in LLVM 18 and prior. The WebAssembly target features `multivalue` and `reference-types` are now both enabled by default, but generated code is not affected by default. These features being enabled are encoded in the `target_features` custom section and may affect downstream tooling such as `wasm-opt` consuming the module, but the actual generated WebAssembly will continue to not use either `multivalue` or `reference-types` by default. There is no longer any supported means to generate a module that has a function with multiple returns. Related changes: * rust-lang#127605 * rust-lang#127613 * rust-lang#127654 * rust-lang#128141 * llvm/llvm-project#98933 Fixes rust-lang#121444. Fixes rust-lang#128212.

Update to LLVM 19 The LLVM 19.1.0 final release is planned for Sep 3rd. The rustc 1.82 stable release will be on Oct 17th. The unstable MC/DC coverage support is temporarily broken by this update. It will be restored by rust-lang/rust#126733. The implementation changed substantially in LLVM 19, and there are no plans to support both the LLVM 18 and LLVM 19 implementation at the same time. Compatibility note for wasm: > WebAssembly target support for the `multivalue` target feature has changed when upgrading to LLVM 19. Support for generating functions with multiple returns no longer works and `-Ctarget-feature=+multivalue` has a different meaning than it did in LLVM 18 and prior. The WebAssembly target features `multivalue` and `reference-types` are now both enabled by default, but generated code is not affected by default. These features being enabled are encoded in the `target_features` custom section and may affect downstream tooling such as `wasm-opt` consuming the module, but the actual generated WebAssembly will continue to not use either `multivalue` or `reference-types` by default. There is no longer any supported means to generate a module that has a function with multiple returns. Related changes: * rust-lang/rust#127605 * rust-lang/rust#127613 * rust-lang/rust#127654 * rust-lang/rust#128141 * llvm/llvm-project#98933 Fixes rust-lang/rust#121444. Fixes rust-lang/rust#128212.

rustbot assigned cuviper Jul 12, 2024

nikic mentioned this pull request Jul 12, 2024

Update to LLVM 19 #127513

Merged

cuviper reviewed Jul 12, 2024

View reviewed changes

nikic added 2 commits July 12, 2024 22:13

Remove LLVMRustDIBuilderInsertDeclareAtEnd return value

8dfd3a4

The return value changed from an Instruction to a DbgRecord in LLVM 19. As we don't actually use the result, drop the return value entirely to support both.

nikic force-pushed the llvm-ndebug-fix branch from 3bc92fc to 8dfd3a4 Compare July 12, 2024 20:23

bors added S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Jul 12, 2024

jhpratt mentioned this pull request Jul 13, 2024

Rollup of 3 pull requests #127674

Merged

bors merged commit cb1ccc1 into rust-lang:master Jul 13, 2024
6 checks passed

rustbot added this to the 1.81.0 milestone Jul 13, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix incorrect NDEBUG handling in LLVM bindings #127654

Fix incorrect NDEBUG handling in LLVM bindings #127654

nikic commented Jul 12, 2024

cuviper Jul 12, 2024

cuviper Jul 12, 2024

nikic Jul 12, 2024

nikic Jul 12, 2024 •

edited

Loading

cuviper commented Jul 12, 2024

bors commented Jul 12, 2024

Fix incorrect NDEBUG handling in LLVM bindings #127654

Fix incorrect NDEBUG handling in LLVM bindings #127654

Conversation

nikic commented Jul 12, 2024

cuviper Jul 12, 2024

Choose a reason for hiding this comment

cuviper Jul 12, 2024

Choose a reason for hiding this comment

nikic Jul 12, 2024

Choose a reason for hiding this comment

nikic Jul 12, 2024 • edited Loading

Choose a reason for hiding this comment

cuviper commented Jul 12, 2024

bors commented Jul 12, 2024

nikic Jul 12, 2024 •

edited

Loading