Description
Removes a function as a separate entity in the RTL hierarchy. After inlining, the function is dissolved into the calling function, and no longer appears as a separate level of hierarchy.
In some cases, inlining a function allows operations within the function to be shared and optimized more effectively with the calling function. However, an inlined function cannot be shared or reused, so if the parent function calls the inlined function multiple times, this can increase the area and resource utilization.
By default, inlining is only performed on the next level of function hierarchy.
Syntax
set_directive_inline [OPTIONS] <location>
-
<location>
is the location (in the formatfunction[/label]
) where inlining is to be performed.
Options
-
-off
- By default, Vitis HLS performs inlining
of smaller functions in the code. Using the
-off
option disables inlining for the specified function. -
-recursive
- By default, only one level of function inlining is
performed. The functions within the specified function are not inlined. The
-recursive
option inlines all functions recursively within the specified function hierarchy.
Examples
The following example inlines function foo_sub1
, but no sub-functions called by foo_sub1
.
set_directive_inline foo_sub1
foo_sub1
, recursively down the hierarchy, except function foo_sub2
:set_directive_inline -recursive foo_sub1
set_directive_inline -off foo_sub2