xclbinutil Utility

This utility operates on a xclbin produced by Xilinx® OpenCL™ Compiler. See the SDAccel Environment User Guide (UG1023) for more information.

For example:

  • Reporting xclbin information: xclbinutil --info --input binary_container_1.xclbin
  • Extracting the bitstream image: xclbinutil --dump-section BITSTREAM:RAW:bitstream.bit --input binary_container_1.xclbin
  • Extracting the build metadata: xclbinutil --dump-section BUILD_METADATA:HTML:buildMetadata.json --input binary_container_1.xclbin
  • Removing a section: xclbinutil --remove-section BITSTREAM --input binary_container_1.xclbin --output binary_container_modified.xclbin
  • xclbinutil --input verify.xclbin --dump-section IP_LAYOUT:JSON:ip_layout_orig.json
  • xclbinutil --input verify.xclbin --output verifyout.xclbin --append-section IP_LAYOUT:JSON:ip_layout_append.json
  • xclbinutil --input verifyout.xclbin --dump-section IP_LAYOUT:JSON:ip_layout_modified.json
  • xclbinutil --input verify.xclbin --info --verbose

Command Options

  • -h [ --help ]: Print help messages
  • i [ --input ] <arg>: Input file name. Reads xclbin into memory.
  • -o [ --output ] <arg>: Output file name. Writes in memory xclbin image to a file.
  • -v [ --verbose ]: Display verbose/debug information.
  • -q [ --quiet ]: Minimize reporting information.
  • --migrate-forward: Migrate the xclbin archive forward to the new binary format.
  • --remove-section: <arg> Section name to remove.
  • --add-section <arg>: Section name to add. Format: <section>:<format>:<file>
  • --dump-section <arg> Section to dump. Format: <section>:<format>:<file>
  • --replace-section <arg> Section to replace.
  • --key-value <arg> Key value pairs. Format: [USER|SYS]:<key>:<value>
  • --remove-key <arg> Removes the given user key from the xclbin archive.
  • --add-signature <arg> Adds a user defined signature to the given xclbin image.
  • --remove-signature Removes the signature from the xclbin image.
  • --get-signature Returns the user defined signature (if set) of the xclbin image.
  • --info Report accelerator binary content. Including: generation and packaging data, kernel signatures, connectivity, clocks, sections, etc.
  • --list-names List all possible section names (Stand Alone Option)
  • --version Version of this executable.
  • --force Forces a file overwrite.

<section>:<format>:<file> Syntax Information

<section>
The section to add or dump (e.g., BUILD_METDATA, BITSTREAM, etc.)
Note: If a JSON format is being used, this value can be empty. If so, then the JSON metadata will determine the section it is associated with. In addition, only sections that are found in the JSON file will be reported.
<format>
The format to be used. Currently, there are three formats available:
RAW
Binary Image
JSON
JSON file format
HTML
Browser visible
<file>
The name of the input/output file to use.

For example, --add-section BITSTREAM:RAW:mybitstream.bit.