summarize-backtrace-logging

5.3 Documentation addenda

summarize-backtrace-logging

Function

: Syntax: summarize-backtrace-logging filename

The filename argument specifies a file that contains the backtrace logging summary.

The function summarize-backtrace-logging accepts the following keyword arguments:

:stream

: This keyword argument specifies a stream to which the summary is sent. The default value is t, which signifies the stream that is the value of the Common Lisp variable *standard-output*.

:cutoff

: This keyword argument specifies the minimum percentage of total execution time that a function must consume to be represented in the summary. The default value is 2.

:max-backtrace-depth

: This keyword argument specifies the depth of the summary tree. The depth is the maximum level that the tree can attain, where the function specified by the :root keyword argument is at the first level. The default value is 10.

:root

: This keyword argument specifies the function from which the trace begins; that is, this function serves as the root node of the call tree. The default value is nil, which means that a complete summary of the backtrace logging information in the filename argument is made.

:collapse-tree

: If this keyword argument has a non-nil value, transitive call chains are collapsed into a node pair containing only the initiator of the chain and the final function in the chain. Thus, if this argument is set and you have a function temp1 that only calls temp2, and temp2 only calls temp3, the function temp2 would not appear in the call tree. The default value of this argument is nil. This option is especially valuable when the trace involves interpreted code.

:print-tree

: If the value of this keyword argument is nil, the call tree is not printed with the summary. The default value is t.

:print-exclusive-time

: If this keyword argument has a non-nil value, the summary shows the percentage of time spent in those functions that were at the top of the stack when the samples were taken. The default value is t.

If the value you specify for the :max-backtrace-depth argument is greater than 50, you should not use the default value for the :root keyword argument, since the resulting tree would be very large. Instead, trace once using the default root and then trace again with a root function taken from an interior level of the first call tree. Repeat this process if necessary.

Liquid Common Lisp 5.0 Release and Installation Notes - 9 JUN 1997

Generated with Harlequin WebMaker