Product Documentation
Cadence SKILL Development Reference
Product Version IC23.1, June 2023

profileSummary

profileSummary( 
[ ?file t_filename ] 
[ ?sort s_sortKey ] 
[ ?filters g_filterSpec ] 
[ ?maxFns x_maxDisplayed ]
[ ?minSecs f_minSecs ] 
[ ?minBytes x_minBytes ]
[ ?children g_showChildren ] 
) 
=> t

Description

Prints a summary of profiling results, showing either the execution time or memory allocated to SKILL functions that were executed.

You select whether to profile time or memory by the argument you pass to the profile function. After executing the functions you are interested in, call profileSummary to generate a report of the CPU time spent in the functions or the amount of SKILL memory allocated in those functions. Using profileSummary options, you can sort and filter data to see only the functions in which you are interested. All functions are measured so you can create multiple profile summaries at the end of each session.

SKILL Profiler is not yet supported on the Windows/Wintel platform.

Arguments

?file t_filename

Specifies the report file name. Defaults to ilProf_<login>.out in the /tmp directory.

?sort s_sortKey

Changes the fields the profile summary is sorted by.

'total Seconds or bytes allocated in functions and
children. This is the default.

'inside Seconds or bytes allocated in function only.

?filters g_filterSpec

Valid values: a regular expression, a symbol, t, binary.

A regular expression displays function names indicated by the expression. For example ^hi displays all functions beginning with hi.

A symbol containing a context displays all functions in that context.

t displays user functions (functions which have been loaded by the user and are not read protected).

'binary displays only SKILL functions implemented in C.

?maxFns x_maxDisplayed

Integer indicating the maximum number of functions to be displayed in the profile summary.

Default value: 1000

?minSecs f_minSecs

Floating-point number indicating in seconds the minimum time that a function must have spent executing before it should be displayed. This time cannot be smaller than 1/60 of a second.

Default value: 0.0

?minBytes x_minBytes

Integer that indicates the minimum number of bytes that need to be allocated to the function before it should be displayed.

Default value: 0

If both ?minSecs and ?minBytes are specified then any function which meets the minimum requirement of either one is displayed.

?children g_showChildren

If t, then the amount of time spent in each child function and the memory allocated is printed at the bottom of the profile summary report.

Value Returned

t

Always returns t.

Examples

profileSummary(?file "/tmp/summary.out" 
?sort 'inside ?children t ?maxFns 100)

Related Topics

Profiler Functions

profile

unprofile

profileReset


Return to top
 ⠀
X