report_utilization - 2025.2 English - UG835

report_utilization [‑file <arg>] [‑append] [‑pblocks <args>]
    [‑evaluate_pblock] [‑exclude_child_pblocks] [‑exclude_non_assigned]
    [‑cells <args>] [‑return_string] [‑slr] [‑packthru] [‑name <arg>]
    [‑no_primitives] [‑omit_locs] [‑hierarchical] [‑spreadsheet_file <arg>]
    [‑spreadsheet_table <arg>] [‑spreadsheet_depth <arg>]
    [‑hierarchical_depth <arg>] [‑hierarchical_percentages]
    [‑hierarchical_min_primitive_count <arg>] [‑quiet] [‑verbose]

Description

Report resource usage on the target part by the current synthesized or implemented design. If you do not specify the -file, -return_string, or -name arguments, the report generates in the standard output.

This command returns the requested information, or returns an error if it fails. When this command runs in hierarchical mode, either with -hierarchical or -name, it reports resource utilization for each hierarchy in the design that meets the -hierarchical_min_primitive_count threshold.

Arguments

-cells <arg> - (Optional) Report the resources utilized by one or more hierarchical cells in the current design.

-evaluate_pblock <arg> - (Optional) Performs a what-if analysis on the specified -pblocks and the specified -cells. This option reports the utilization of the Pblocks populated by the specified cells. Percentages of utilization represent the ratio of the assigned cells to the available resources. This option requires both -pblocks and -cells.

-exclude_child_pblocks - (Optional) Report utilization of the specified -pblocks excluding any nested Pblocks. This reduces the utilization of the region as it does not account for assigned cells to a Pblock through a nested Pblock.

-exclude_non_assigned - (Optional) Exclude non-assigned cells from the Utilization report when the -pblocks option is specified. This decreases the utilization of the Pblock region as it does not account for utilized cells and not assigned to the specified Pblocks.

-hierarchical - (Optional) Reports the utilization of the device categorized as per the design hierarchy. This impacts report generated to a file. The report is hierarchical regardless when run inside the Vivado IDE.

-hierarchical_depth <arg> - (Optional) Specifies the depth of the hierarchy to report when reporting utilization according to the hierarchy. If the default depth is 0, it means that -hierarchical option reports full design hierarchy.

-hierarchical_min_primitive_count <arg> - (Optional) Specifies the minimum number of cells required in each hierarchy required to report utilization. It counts cells regardless of upper levels. Specifying -name and -hierarchical option impacts IDE report and text report respectively. Using value zero reports full hierarchy. Default value is 50.

Specifies the minimum number of cells required in order to report a hierarchy when the report is generated in hierarchical mode. Specifying -name or -hierarchical options triggers hierarchical mode. Using value zero reports all hierarchies. A higher level cell count is sum total of the lower level leaf cell counts and the number of leaf cells in the current hierarchy. Default value is 50.

-hierarchical_percentages - (Optional) Specifies that utilization data in the hierarchical report is reported as percentages.

-slr - (Optional) Reports the utilization for each separate SLR in devices having SLRs.

-name <arg> - (Optional) Specifies the name of the results to output to the GUI.

-no_primitives - (Optional) Remove the Primitives section from the report. The Primitives section reports the number and type of logic primitives used on the device.

-omit_locs - (Optional) Omit the Fixed column from the report. The Fixed column reports the quantity of fixed logic elements, or manually places onto the device.

-packthru - (Optional) Reports LUTs used for route through purposes. This appears in the utilization report as "LUTs used exclusively as route-thrus".

-return_string - (Optional) Directs the output to a Tcl string rather than to the standard output. A variable definition captures the Tcl string, parses, or processes as required.

-spreadsheet_file <arg> - (Optional) Export utilization tables to the specified XLSX format spreadsheet. The ability to export a spreadsheet file is only available when the -name option is also specified and the report is generated in the GUI.

-spreadsheet_table <arg> - (Optional) Specify a utilization table to export to the spreadsheet file. The default is to export the Hierarchy table for the whole design. This option requires the use of -spreadsheet_file.

It also exports other tables and specific resources. This process requires you to build the argument -spreadsheet_file switch by specifying the table name and then a hyphen followed the resource.

• Table Name - Resource Name: Adds multiple resources
• Table Name - Resource Name - Resource Name: Identify the names of the tables and the resources in the report.
  Warning: Ensure that the text matches precisely and is case sensitive.
  Note: The existing command works differently for different stages in the design flow or when porting projects to new families. Verify the command when targeting a new family or design stage.

Some example table names are:

• Hierarchy
• Slice Logic Distribution
• Slice Logic Distribution - LUT as Memory
• Netlist Logic
• Netlist Logic - Registers

-spreadsheet_depth <arg> - (Optional) Specifies the hierarchical depth, starting from the top-level of the design, to export to the spreadsheet file. The default value is 8. This options requires the use of -spreadsheet_file.

Examples

The following example reports a hierarchical report and writes it to util_hier.rpt file:

report_utilization -hierarchical -file util_hier.rpt

The following example generates a hierarchical report showing all hierarchies regardless of whether they meet the minimum primitive count threshold and writes it to util_hier2.rpt file:

report_utilization -hierarchical -hierarchical_min_primitive_count 0 -file \
util_hier2.rpt

The following example reports the resources used by a Pblock and write the results to the specified file:

report_utilization -pblocks [get_pblocks <pblockName>] -file \
./pblocks_util.txt 

This example reports the whole design utilization for named report in the GUI, but exports the "Clocking - BUFGCTRL" table to the specified spreadsheet file:

report_utilization -name utilization_1 -spreadsheet_file util_table.xlsx \
-spreadsheet_table "Clocking - BUFGCTRL"

The following example reports the resources utilized by each Pblock in the design, appending the report for each Pblock to a single specified file:

foreach x [get_pblocks] {
  puts "Reporting Pblock: $x ----------------------------------"
  report_utilization -append -file C:/Data/pblocks_util.txt -pblocks $x
}

See Also

• delete_utilization_results