llvm-offload-binary - Man Page

llvm-offload-binary [options] [input files...]

llvm-offload-binary is a utility for bundling multiple device object files into a single binary container. The resulting binary can then be embedded into the host section table to form a fat binary containing offloading code for different targets. Conversely, it can also extract previously bundled device images.

The binary format begins with the magic bytes 0x10FF10AD, followed by a version and size. Each binary contains its own header, allowing tools to locate offloading sections even when merged by a linker. Each offload entry includes metadata such as the device image kind, producer kind, and key-value string metadata. Multiple offloading images are concatenated to form a fat binary.

# Package multiple device images into a fat binary:
$ llvm-offload-binary -o out.bin \
      --image=file=input.o,triple=nvptx64,arch=sm_70

# Extract a matching image from a fat binary:
$ llvm-offload-binary in.bin \
      --image=file=output.o,triple=nvptx64,arch=sm_70

# Extract and archive images into a static library:
$ llvm-offload-binary in.bin --archive -o libdevice.a

--archive

When extracting from an input binary, write all extracted images into a static archive instead of separate files.

--image=<<key>=<value>,...>

Specify a set of arbitrary key-value arguments describing an image. Commonly used optional keys include arch (e.g. sm_70 for CUDA) and triple (e.g. nvptx64-nvidia-cuda).

-o <file>

Write output to <file>. When bundling, this specifies the fat binary filename. When extracting, this specifies the archive or output file destination.

--help, -h

Display available options. Use --help-hidden to show hidden options.

--help-list

Display a list of all options. Use --help-list-hidden to show hidden ones.

--version

Display the version of the llvm-offload-binary executable.

@<FILE>

Read command-line options from response file <FILE>.

The binary format is marked by the magic bytes 0x10FF10AD, followed by a version number. Each created binary contains its own header. This allows tools to locate offloading sections even after linker operations such as relocatable linking. Conceptually, this binary format is a serialization of a string map and an image buffer.

Each offload entry describes a bundled image along with its associated metadata.

The entry table refers to both a string table and the raw device image itself. The string table provides arbitrary key-value metadata.

The string table is a collection of null-terminated strings stored in the image. Offsets allow string entries to be interpreted as key-value pairs, enabling flexible metadata such as architecture or target triple.

The enumerated values for image kind and offload kind are:

clang(1) <clang.html>, llvm-objdump(1) <llvm-objdump.html>

Maintained by the LLVM Team (https://llvm.org/).

2003-2026, LLVM Project

The man page llvm-offload-binary-22(1) is an alias of llvm-offload-binary(1).