rust-lang / rust-lang/rust-bindgen

`repr(packed(n))` missing on virtual classes

Open
#3,166 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Rust
Stars
5.3k
Forks
829
Avg merge
1d 1h
Merged PRs (30d)
15

Description

(Apologies if this already reported in some form: GitHub search shows a lot of semi-related open issues but none seem to define exactly this scenario - even if they may share the same problem in the end)

Consider the following bindings.hpp sample:

#pragma pack(4)

class Data {
	void *test;
};

class Foo {
	virtual void foo();
};

Running bindgen bindings.hpp (with a 64-bit target) prints:

/* automatically generated by rust-bindgen 0.71.1 */

#[repr(C, packed(4))]
#[derive(Debug, Copy, Clone)]
pub struct Data {
    pub test: *mut ::std::os::raw::c_void,
}
#[allow(clippy::unnecessary_operation, clippy::identity_op)]
const _: () = {
    ["Size of Data"][::std::mem::size_of::<Data>() - 8usize];
    ["Alignment of Data"][::std::mem::align_of::<Data>() - 4usize];
    ["Offset of field: Data::test"][::std::mem::offset_of!(Data, test) - 0usize];
};
#[repr(C)]
pub struct Foo__bindgen_vtable(::std::os::raw::c_void);
#[repr(C)]
#[derive(Debug, Copy, Clone)]
pub struct Foo {
    pub vtable_: *const Foo__bindgen_vtable,
}
#[allow(clippy::unnecessary_operation, clippy::identity_op)]
const _: () = {
    ["Size of Foo"][::std::mem::size_of::<Foo>() - 8usize];
    ["Alignment of Foo"][::std::mem::align_of::<Foo>() - 4usize];
};

It seems that the layout tests picked up the #pragma pack(4) and expect an alignment of 4 for both Data and Foo (both contain pointer fields that are otherwise aligned to 8 bytes). However, packed(4) is only emitted for the "POD" Data structure but not for the Foo virtual class, meaning that these layout tests will now fail:

❯ rustc bindings.rs
...

error[E0080]: evaluation of constant value failed
  --> bindings.rs:24:5
   |
24 |     ["Alignment of Foo"][::std::mem::align_of::<Foo>() - 4usize];
   |     ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ index out of bounds: the length is 1 but the index is 4

error: aborting due to 2 previous errors

Some errors have detailed explanations: E0080, E0601.
For more information about an error, try `rustc --explain E0080`.

The repr(C, packed(4)) should be emitted on struct Foo, and the alignment test is correct. After all, printing alignof(Foo) for the above code is 4 in cpp too.

#include <iostream>
#pragma pack(4)
class Foo {
  virtual void foo();
};
int main() {
  std::cout << alignof(Foo) << std::endl;
}
$ clang -lstdc++ bindings.cpp && ./a.out
4

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the bindings.hpp repro and run bindgen to compare the generated bindings.rs for Data and Foo. Trace how the virtual Foo class is represented, then ensure its generated layout includes packed(4) so the emitted rustc alignment checks pass.

Written by the indexing model from the issue text.

Assessment

Tech stack
cpp, rust
Domain
tooling
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.