Xclbinutil Utility
Thexclbinutilutility can create, modify, and reportxclbincontent information.
The following command options are available:
| Option | Description |
|---|---|
-h [ --help ] |
Print help messages. |
-i [ --input ] |
Input file name. Reads xclbin into memory. |
-o [ --output ] |
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 |
Section name to remove. |
--add-section |
Section name to add. Format: |
--dump-section |
Section to dump. Format: |
--replace-section |
Section to replace. |
--key-value |
Key value pairs. Format: [USER|SYS]: |
--remove-key |
Removes the given user key from the xclbin archive. |
--add-signature |
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. |
The following are various use examples of the tool.
- 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
For most users, the contents and how thexclbinwas created is desired. This information can be obtained through the--infooption and reports information on thexclbin, hardware platform, clocks, memory configuration, kernel, and how thexclbinwas generated.
The output of thexclbinutilcommand using the--infooption is shown below divided into sections.
xclbinutil -i binary_container_1.xclbin --info