Компоновка Rust FFI: repr(C) у внешней структуры не исправляет вложенные поля

Что это такое

Согласно справочнику Rust, представление влияет на выравнивающие промежутки между полями типа, но не на представление самих этих полей. Поэтому внешняя структура #[repr(C)], содержащая внутреннюю структуру с компоновкой Rust, не делает внутреннюю компоновку совместимой с C. Объявление, которое выглядит похоже в двух языках, само по себе не является проверенным контрактом ABI. Rust Reference: type layout

Почему это важно

Агенты часто исправляют несоответствие FFI, добавляя один атрибут или приводя указатель к другому типу. Полезнее спросить, согласованы ли у обеих сторон все вложенные типы, размеры, выравнивание и соглашение о вызовах. Рассматривайте вопросы компоновки отдельно от владения выделенной памятью и времени жизни указателей: каждый из этих аспектов может независимо оказаться неверным.

Как применять

• Начните с авторитетного заголовочного файла внешней библиотеки и перечислите точные типы на границе. Включите вложенные структуры, перечисления, обратные вызовы и поля с указателями, а не только сигнатуру верхнего уровня.
• Сопоставьте каждый тип на границе с документированным представлением и типом C для конкретной целевой платформы. Не предоставляйте обычную коллекцию Rust через внешний интерфейс только потому, что её текущий вид в отладчике похож на внешнюю структуру.
• Предложите небольшие тестовые примеры на C и Rust, которые сравнивают размеры, выравнивание и значимые смещения для поддерживаемой целевой платформы. Используйте легко различимые значения полей, чтобы выявить переставленные или усечённые поля при передаче туда и обратно.
• Проверьте оба направления границы, если оба доступны публично: внешний код, использующий значение Rust, и Rust, использующий внешнее значение.
• Документируйте вместе с привязкой все предположения об архитектуре и пересматривайте их при смене компилятора, целевой платформы или версии внешней библиотеки.

Подводные камни

Успешные проверки компоновки не подтверждают, остаётся ли указатель действительным, может ли он быть null и можно ли по нему записывать. repr(C) также не определяет переносимое сетевое кодирование: контракт привязан к ABI платформы. Не используйте упакованную компоновку как универсальное исправление, поскольку требования к выравниванию остаются. Это предложенная процедура проверки, а не утверждение, что какая-либо конкретная сгенерированная привязка прошла тесты совместимости.