LLVM 20.0.0git
OffloadBinary.h
Go to the documentation of this file.
1//===--- Offloading.h - Utilities for handling offloading code -*- C++ -*-===//
2//
3// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4// See https://llvm.org/LICENSE.txt for license information.
5// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6//
7//===----------------------------------------------------------------------===//
8//
9// This file contains the binary format used for budingling device metadata with
10// an associated device image. The data can then be stored inside a host object
11// file to create a fat binary and read by the linker. This is intended to be a
12// thin wrapper around the image itself. If this format becomes sufficiently
13// complex it should be moved to a standard binary format like msgpack or ELF.
14//
15//===----------------------------------------------------------------------===//
16
17#ifndef LLVM_OBJECT_OFFLOADBINARY_H
18#define LLVM_OBJECT_OFFLOADBINARY_H
19
20#include "llvm/ADT/MapVector.h"
22#include "llvm/ADT/StringRef.h"
23#include "llvm/Object/Binary.h"
24#include "llvm/Support/Error.h"
26#include <memory>
27
28namespace llvm {
29
30namespace object {
31
32/// The producer of the associated offloading image.
39};
40
41/// The type of contents the offloading image contains.
50};
51
52/// A simple binary serialization of an offloading file. We use this format to
53/// embed the offloading image into the host executable so it can be extracted
54/// and used by the linker.
55///
56/// Many of these could be stored in the same section by the time the linker
57/// sees it so we mark this information with a header. The version is used to
58/// detect ABI stability and the size is used to find other offloading entries
59/// that may exist in the same section. All offsets are given as absolute byte
60/// offsets from the beginning of the file.
61class OffloadBinary : public Binary {
62public:
65
66 /// The current version of the binary used for backwards compatibility.
67 static const uint32_t Version = 1;
68
69 /// The offloading metadata that will be serialized to a memory buffer.
75 std::unique_ptr<MemoryBuffer> Image;
76 };
77
78 /// Attempt to parse the offloading binary stored in \p Data.
80
81 /// Serialize the contents of \p File to a binary buffer to be read later.
82 static SmallString<0> write(const OffloadingImage &);
83
84 static uint64_t getAlignment() { return 8; }
85
86 ImageKind getImageKind() const { return TheEntry->TheImageKind; }
87 OffloadKind getOffloadKind() const { return TheEntry->TheOffloadKind; }
88 uint32_t getVersion() const { return TheHeader->Version; }
89 uint32_t getFlags() const { return TheEntry->Flags; }
90 uint64_t getSize() const { return TheHeader->Size; }
91
92 StringRef getTriple() const { return getString("triple"); }
93 StringRef getArch() const { return getString("arch"); }
95 return StringRef(&Buffer[TheEntry->ImageOffset], TheEntry->ImageSize);
96 }
97
98 // Iterator over all the key and value pairs in the binary.
100 return string_iterator_range(StringData.begin(), StringData.end());
101 }
102
103 StringRef getString(StringRef Key) const { return StringData.lookup(Key); }
104
105 static bool classof(const Binary *V) { return V->isOffloadFile(); }
106
107 struct Header {
108 uint8_t Magic[4] = {0x10, 0xFF, 0x10, 0xAD}; // 0x10FF10AD magic bytes.
109 uint32_t Version = OffloadBinary::Version; // Version identifier.
110 uint64_t Size; // Size in bytes of this entire binary.
111 uint64_t EntryOffset; // Offset of the metadata entry in bytes.
112 uint64_t EntrySize; // Size of the metadata entry in bytes.
113 };
114
115 struct Entry {
116 ImageKind TheImageKind; // The kind of the image stored.
117 OffloadKind TheOffloadKind; // The producer of this image.
118 uint32_t Flags; // Additional flags associated with the image.
119 uint64_t StringOffset; // Offset in bytes to the string map.
120 uint64_t NumStrings; // Number of entries in the string map.
121 uint64_t ImageOffset; // Offset in bytes of the actual binary image.
122 uint64_t ImageSize; // Size in bytes of the binary image.
123 };
124
125 struct StringEntry {
128 };
129
130private:
131 OffloadBinary(MemoryBufferRef Source, const Header *TheHeader,
132 const Entry *TheEntry)
133 : Binary(Binary::ID_Offload, Source), Buffer(Source.getBufferStart()),
134 TheHeader(TheHeader), TheEntry(TheEntry) {
135 const StringEntry *StringMapBegin =
136 reinterpret_cast<const StringEntry *>(&Buffer[TheEntry->StringOffset]);
137 for (uint64_t I = 0, E = TheEntry->NumStrings; I != E; ++I) {
138 StringRef Key = &Buffer[StringMapBegin[I].KeyOffset];
139 StringData[Key] = &Buffer[StringMapBegin[I].ValueOffset];
140 }
141 }
142
143 OffloadBinary(const OffloadBinary &Other) = delete;
144
145 /// Map from keys to offsets in the binary.
147 /// Raw pointer to the MemoryBufferRef for convenience.
148 const char *Buffer;
149 /// Location of the header within the binary.
150 const Header *TheHeader;
151 /// Location of the metadata entries within the binary.
152 const Entry *TheEntry;
153};
154
155/// A class to contain the binary information for a single OffloadBinary that
156/// owns its memory.
157class OffloadFile : public OwningBinary<OffloadBinary> {
158public:
159 using TargetID = std::pair<StringRef, StringRef>;
160
161 OffloadFile(std::unique_ptr<OffloadBinary> Binary,
162 std::unique_ptr<MemoryBuffer> Buffer)
163 : OwningBinary<OffloadBinary>(std::move(Binary), std::move(Buffer)) {}
164
165 /// Make a deep copy of this offloading file.
167 std::unique_ptr<MemoryBuffer> Buffer = MemoryBuffer::getMemBufferCopy(
168 getBinary()->getMemoryBufferRef().getBuffer(),
169 getBinary()->getMemoryBufferRef().getBufferIdentifier());
170
171 // This parsing should never fail because it has already been parsed.
172 auto NewBinaryOrErr = OffloadBinary::create(*Buffer);
173 assert(NewBinaryOrErr && "Failed to parse a copy of the binary?");
174 if (!NewBinaryOrErr)
175 llvm::consumeError(NewBinaryOrErr.takeError());
176 return OffloadFile(std::move(*NewBinaryOrErr), std::move(Buffer));
177 }
178
179 /// We use the Triple and Architecture pair to group linker inputs together.
180 /// This conversion function lets us use these inputs in a hash-map.
181 operator TargetID() const {
182 return std::make_pair(getBinary()->getTriple(), getBinary()->getArch());
183 }
184};
185
186/// Extracts embedded device offloading code from a memory \p Buffer to a list
187/// of \p Binaries.
190
191/// Convert a string \p Name to an image kind.
193
194/// Convert an image kind to its string representation.
196
197/// Convert a string \p Name to an offload kind.
199
200/// Convert an offload kind to its string representation.
202
203/// If the target is AMD we check the target IDs for mutual compatibility. A
204/// target id is a string conforming to the folowing BNF syntax:
205///
206/// target-id ::= '<arch> ( : <feature> ( '+' | '-' ) )*'
207///
208/// The features 'xnack' and 'sramecc' are currently supported. These can be in
209/// the state of on, off, and any when unspecified. A target marked as any can
210/// bind with either on or off. This is used to link mutually compatible
211/// architectures together. Returns false in the case of an exact match.
214
215} // namespace object
216
217} // namespace llvm
218#endif
static GCRegistry::Add< CoreCLRGC > E("coreclr", "CoreCLR-compatible GC")
std::string Name
#define I(x, y, z)
Definition: MD5.cpp:58
This file implements a map that provides insertion order iteration.
assert(ImpDefSCC.getReg()==AMDGPU::SCC &&ImpDefSCC.isDef())
This file defines the SmallString class.
Value * RHS
Value * LHS
Lightweight error class with error context and mandatory checking.
Definition: Error.h:160
Tagged union holding either a T or a Error.
Definition: Error.h:481
This class implements a map that also provides access to all stored values in a deterministic order.
Definition: MapVector.h:36
typename VectorType::const_iterator const_iterator
Definition: MapVector.h:50
static std::unique_ptr< MemoryBuffer > getMemBufferCopy(StringRef InputData, const Twine &BufferName="")
Open the specified memory range as a MemoryBuffer, copying the contents and taking ownership of it.
SmallString - A SmallString is just a SmallVector with methods and accessors that make it work better...
Definition: SmallString.h:26
This class consists of common code factored out of the SmallVector class to reduce code duplication b...
Definition: SmallVector.h:573
StringRef - Represent a constant reference to a string, i.e.
Definition: StringRef.h:51
A range adaptor for a pair of iterators.
A simple binary serialization of an offloading file.
Definition: OffloadBinary.h:61
static uint64_t getAlignment()
Definition: OffloadBinary.h:84
OffloadKind getOffloadKind() const
Definition: OffloadBinary.h:87
iterator_range< string_iterator > string_iterator_range
Definition: OffloadBinary.h:64
StringRef getString(StringRef Key) const
uint32_t getVersion() const
Definition: OffloadBinary.h:88
StringRef getImage() const
Definition: OffloadBinary.h:94
static SmallString< 0 > write(const OffloadingImage &)
Serialize the contents of File to a binary buffer to be read later.
uint32_t getFlags() const
Definition: OffloadBinary.h:89
StringRef getTriple() const
Definition: OffloadBinary.h:92
ImageKind getImageKind() const
Definition: OffloadBinary.h:86
static Expected< std::unique_ptr< OffloadBinary > > create(MemoryBufferRef)
Attempt to parse the offloading binary stored in Data.
static bool classof(const Binary *V)
string_iterator_range strings() const
Definition: OffloadBinary.h:99
StringRef getArch() const
Definition: OffloadBinary.h:93
uint64_t getSize() const
Definition: OffloadBinary.h:90
static const uint32_t Version
The current version of the binary used for backwards compatibility.
Definition: OffloadBinary.h:67
MapVector< StringRef, StringRef >::const_iterator string_iterator
Definition: OffloadBinary.h:63
A class to contain the binary information for a single OffloadBinary that owns its memory.
std::pair< StringRef, StringRef > TargetID
OffloadFile copy() const
Make a deep copy of this offloading file.
OffloadFile(std::unique_ptr< OffloadBinary > Binary, std::unique_ptr< MemoryBuffer > Buffer)
Error extractOffloadBinaries(MemoryBufferRef Buffer, SmallVectorImpl< OffloadFile > &Binaries)
Extracts embedded device offloading code from a memory Buffer to a list of Binaries.
ImageKind getImageKind(StringRef Name)
Convert a string Name to an image kind.
bool areTargetsCompatible(const OffloadFile::TargetID &LHS, const OffloadFile::TargetID &RHS)
If the target is AMD we check the target IDs for mutual compatibility.
OffloadKind
The producer of the associated offloading image.
Definition: OffloadBinary.h:33
OffloadKind getOffloadKind(StringRef Name)
Convert a string Name to an offload kind.
StringRef getImageKindName(ImageKind Name)
Convert an image kind to its string representation.
ImageKind
The type of contents the offloading image contains.
Definition: OffloadBinary.h:42
StringRef getOffloadKindName(OffloadKind Name)
Convert an offload kind to its string representation.
This is an optimization pass for GlobalISel generic memory operations.
Definition: AddressRanges.h:18
@ Other
Any other memory.
OutputIt move(R &&Range, OutputIt Out)
Provide wrappers to std::move which take ranges instead of having to pass begin/end explicitly.
Definition: STLExtras.h:1873
void consumeError(Error Err)
Consume a Error without doing anything.
Definition: Error.h:1069
Implement std::hash so that hash_code can be used in STL containers.
Definition: BitVector.h:858
The offloading metadata that will be serialized to a memory buffer.
Definition: OffloadBinary.h:70
std::unique_ptr< MemoryBuffer > Image
Definition: OffloadBinary.h:75
MapVector< StringRef, StringRef > StringData
Definition: OffloadBinary.h:74