4d27530c69
This PR updates the OffloadBinary format from version 1 to version 2,
enabling support for multiple offloading entries in a single binary.
This allows combining multiple device images into a single binary with
common global metadata while maintaining backwards compatibility with
version 1 binaries.
# Key Changes
## Binary Format Enhancements
**Version 2 Format Changes:**
- Changed from single-entry to multi-entry design
- Updated `Header` structure:
- Renamed `EntryOffset` → `EntriesOffset` (offset to entries array)
- Renamed `EntrySize` → `EntriesCount` (number of entries)
- Added `StringEntry::ValueSize` field to support explicit string value
sizes (enables non-null-terminated strings)
- Introduced `OffloadEntryFlags` enum with `OIF_Metadata` flag for
metadata-only entries (entries without binary images)
**API Changes:**
- `OffloadBinary::create()` now returns
`Expected<SmallVector<std::unique_ptr<OffloadBinary>>>` instead of
single binary
- Added optional `Index` parameter to extract specific entry:
`create(Buffer, std::optional<uint64_t> Index)`
- `OffloadBinary::write()` now accepts `ArrayRef<OffloadingImage>`
instead of single image
- Added `OffloadBinary::extractHeader()` for header extraction
**Memory Management:**
- Implemented `SharedMemoryBuffer` class to enable memory sharing across
multiple `OffloadBinary` instances from the same file
- Multiple entries from a single serialized binary share the underlying
buffer
## Testing
**Unit Tests (`unittests/Object/OffloadingTest.cpp`):**
- `checkMultiEntryBinaryExtraction`: Tests extracting all entries from a
multi-entry binary
- `checkIndexBasedExtraction`: Tests extracting specific entries by
index, including out-of-bounds validation
- `checkEdgeCases`: Tests edge cases including:
- Empty string metadata
- Empty image data
- Large string values (4KB)
**Other Tests:**
- Updated `test/ObjectYAML/Offload/multiple_members.yaml` to include
metadata-only entry
---------
Co-authored-by: Joseph Huber <huberjn@outlook.com>
57 lines
1.8 KiB
YAML
57 lines
1.8 KiB
YAML
# RUN: yaml2obj %s | obj2yaml | FileCheck %s
|
|
!Offload
|
|
Members:
|
|
- ImageKind: IMG_Cubin
|
|
OffloadKind: OFK_OpenMP
|
|
Flags: 0
|
|
String:
|
|
- Key: "triple"
|
|
Value: "nvptx64-nvidia-cuda"
|
|
- Key: "arch"
|
|
Value: "sm_70"
|
|
Content: "deadbeef"
|
|
- ImageKind: IMG_Bitcode
|
|
OffloadKind: OFK_OpenMP
|
|
Flags: 0
|
|
String:
|
|
- Key: "triple"
|
|
Value: "amdgcn-amd-amdhsa"
|
|
- Key: "arch"
|
|
Value: "gfx908"
|
|
Content: "cafefeed"
|
|
- ImageKind: IMG_Object
|
|
OffloadKind: OFK_SYCL
|
|
# OIF_Metadata
|
|
Flags: 1
|
|
String:
|
|
- Key: "device"
|
|
Value: "gpu"
|
|
|
|
# CHECK: --- !Offload
|
|
# CHECK-NEXT: Members:
|
|
# CHECK-NEXT: - ImageKind: IMG_Cubin
|
|
# CHECK-NEXT: OffloadKind: OFK_OpenMP
|
|
# CHECK-NEXT: Flags: 0
|
|
# CHECK-NEXT: String:
|
|
# CHECK-NEXT: - Key: triple
|
|
# CHECK-NEXT: Value: nvptx64-nvidia-cuda
|
|
# CHECK-NEXT: - Key: arch
|
|
# CHECK-NEXT: Value: sm_70
|
|
# CHECK-NEXT: Content: DEADBEEF
|
|
# CHECK-NEXT: - ImageKind: IMG_Bitcode
|
|
# CHECK-NEXT: OffloadKind: OFK_OpenMP
|
|
# CHECK-NEXT: Flags: 0
|
|
# CHECK-NEXT: String:
|
|
# CHECK-NEXT: - Key: triple
|
|
# CHECK-NEXT: Value: amdgcn-amd-amdhsa
|
|
# CHECK-NEXT: - Key: arch
|
|
# CHECK-NEXT: Value: gfx908
|
|
# CHECK-NEXT: Content: CAFEFEED
|
|
# CHECK-NEXT: - ImageKind: IMG_Object
|
|
# CHECK-NEXT: OffloadKind: OFK_SYCL
|
|
# CHECK-NEXT: Flags: 1
|
|
# CHECK-NEXT: String:
|
|
# CHECK-NEXT: - Key: device
|
|
# CHECK-NEXT: Value: gpu
|
|
# CHECK-NEXT: ...
|