Windows-rs: build.rs panics with debug assertions in the standard library enabled

[jyn514]

thread '<unnamed>' panicked at 'attempt to create unaligned or null slice', /home/joshua/rustc/library/core/src/slice/raw.rs:90:5
  17:     0x7f1ba4aab4bd - core::panicking::panic::h8cbc293f6a10d9b7
                               at /home/joshua/rustc/library/core/src/panicking.rs:50:5
  18:     0x7f1ba49b435a - core::slice::raw::from_raw_parts::h53f99ecbe714ca76
                               at /home/joshua/rustc/library/core/src/slice/raw.rs:90:5
  19:     0x7f1ba49b69ce - windows_winmd::parsed::blob::Blob::read_utf16::hab64d71897c4ec66
                               at /home/joshua/.local/lib/cargo/git/checkouts/windows-rs-4d19330348d493fa/256538e/crates/winmd/src/parsed/blob.rs:83:32
  20:     0x7f1ba45ef2a8 - windows_gen::constant::Constant::gen::h92df2277ccc1ec96
                               at /home/joshua/.local/lib/cargo/git/checkouts/windows-rs-4d19330348d493fa/256538e/crates/gen/src/constant.rs:49:65
  21:     0x7f1ba45c6658 - windows_gen::type_definition::TypeDefinition::gen::hf233f3f33c3c1c9a
                               at /home/joshua/.local/lib/cargo/git/checkouts/windows-rs-4d19330348d493fa/256538e/crates/gen/src/type_definition.rs:85:34
  22:     0x7f1ba451ccfe - windows_gen::type_tree::TypeTree::gen::{{closure}}::h20e29892e9070001
                               at /home/joshua/.local/lib/cargo/git/checkouts/windows-rs-4d19330348d493fa/256538e/crates/gen/src/type_tree.rs:119:22

This is with an incremental build with a newly built compiler, so there's a small possibility it could be https://github.com/rust-lang/rust/issues/76720. But I'm reporting it just in case it's a bug in the build script itself.

The command I ran was

cargo +stage1 rustc --profile=check -- -Z time-passes

where +stage1 is https://github.com/rust-lang/rust/commit/5f74ab49694a8622afd44c24021b44239573402d.

[jyn514]

rm -r target did fix the issue (and now I get linker errors about the windows runtime instead).

[kennykerr]

The panic is interesting, but not very actionable unless there's a consistent repro. It doesn't look familiar.

You'll have a hard time linking on Linux due to the lack of libs, until we have support for DLL imports in Rust. We have someone looking into that.

[jyn514]

This is probably not worth looking into then. The bit about DLL imports looks very cool, I didn't realize that was possible :)

[jyn514]

I found why this only panicked locally, that's a debug_assert! and the standard library is distributed in release mode: https://github.com/rust-lang/rust/blob/84864bfea9c00fb90a1fa6e3af1d8ad52ce8f9ec/library/core/src/slice/raw.rs#L90

[bjorn3]

Blob::read_utf16 can create an unaligned &[u16]: https://github.com/microsoft/windows-rs/blob/4a2915140799f250c96f85bd9aa91e41482a3fe4/crates/winmd/src/parsed/blob.rs#L80-L89

This is UB.

[jyn514]

The issue is that self.offset may not be a multiple of 16, right?

[rylev]

Yes, and it can also be null.

[bjorn3]

If either files[...].bytes is not aligned to 2 bytes or self.offset is not a multiple of 2, the resulting &[u16] will be unaligned.

[kennykerr]

I'd have to check the ECMA spec, but if it is null then it probably just means it should be an empty string. I'm not sure whether it is guaranteed to be aligned, but we can always harden it to deal with that case.

Is there a reliable repro for this?

[jyn514]

@kennykerr you'd have to compile a custom rustc, by default these assertions are disabled. There are instructions at https://rustc-dev-guide.rust-lang.org/building/how-to-build-and-run.html, or @rylev already has a local compiler built.

[jyn514]

Alternatively you can copy the assertion into your code: https://github.com/rust-lang/rust/blob/84864bfea9c00fb90a1fa6e3af1d8ad52ce8f9ec/library/core/src/intrinsics.rs#L1742

[kennykerr]

There is a bug in the source metadata where many constants are missing values. https://github.com/microsoft/win32metadata/issues/88 This may be what is causing the null case.

I'm not sure what would be causing the unaligned case. The ECMA spec says that all data must be stored with proper alignment. It's possible this is not being preserved when the PE file (winmd) is copied into a Vec.

[kennykerr]

Field constants are the only place where UTF16 values are stored within the winmd file. For the most part, strings are always UTF8.

[kennykerr]

And thanks @jyn514 - Ryan said he'll take a look at fixing this.