Get a list of dataflow paths
Syntax
get_dataflow_paths [‑filter <arg>] [‑max_paths <arg>] [‑max_depth <arg>]
[‑min_depth <arg>] [‑min_width <arg>] [‑from <args>] [‑to <args>]
[‑through <args>] [‑quiet] [‑verbose]Returns
List of dataflow paths.
Usage
| Name | Description |
|---|---|
[-filter]
|
Filter list with given expression. |
[-max_paths]
|
Maximum number of paths. Default: 100 |
[-max_depth]
|
Maximum number of instances that can be skipped to find the next required end point. Default: 10 |
[-min_depth]
|
Minimum number of instances that can be skipped to find the next required end point. Default: 1 |
[-min_width]
|
Minimum number of bus depth to consider for paths to be shown. Default: 1 |
[-from]
|
From leaf cells. |
[-to]
|
To leaf cells. |
[-through]
|
Through leaf cells. |
[-quiet]
|
Ignore command errors |
[-verbose]
|
Suspend message limits during command execution |
Description
This returns a list of dataflow path objects which is useful to generate a group of paths to analyze within the Dataflow Design view. A dataflow design is an optimized netlist that has low level objects trimmed out and focuses on sparse netlist objects and wide buses. A dataflow path object is a path extracted from a dataflow design.
This command works when a dataflow design is open and the Dataflow view is selected in the Vivado Design Suite. The command iterates through dataflow primitives until max_depth is reached and returns all paths that meet the criteria. The following are the typical dataflow primitives available in the dataflow netlist.
- Memories
- DSP
- Other IP blocks such as Transceivers, PCIe, and DCMAC
Arguments
-filter <args> - (Optional) Filter the results list with the specified expression.
-max_paths <arg> - (Optional) Specifies the maximum number of paths to return. Default value is 100.
-max_depth <arg> - (Optional) Specifies the maximum number of netlist objects to trace through before reaching the endpoint. Default value is 10.
-min_depth <arg> - (Optional) Specifies the minimum number of netlistobjects to trace through before reaching the endpoint. Default value is 1.
-min_width <arg> - (Optional) Specifies the minimum width of any bus net returned by get_dataflow_paths. Default value is 1.
-from <arg> - (Optional) Specify a startpoint cell or list of cells. The returned path starts from one of the cells provided. The argument only accepts cell objects.
-to <arg> - (Optional) Specify a endpoint cell or list of cells. The returned path ends at one of the cells provided. The argument only accepts cell objects.
-through <arg> - (Optional) Specify a midpoint cell or list of cells to trace paths through. The argument only accepts cell objects.
-quiet - (Optional) Execute the command quietly, returning no messages from the command. The command also returns TCL_OK regardless of any errors encountered during execution.
-verbose - (Optional) Temporarily override any message limits and return all messages from this command.
set_msg_config command.Examples
show_objects -name dfv_1 [get_dataflow_paths]start_cell with a max_depth of 20 cells:show_objects -name dfv_2 [get_dataflow_paths -from [get_cells start_cell] \ -max_depth 20 -max_paths 50]