profiler-status

$Revision: 5.0.2.2 $

Function

Package: PROFILER

Arguments: (&key verbose current-profile)

This function will print to *standard-output* the status of the current profile. If the profile was invoked with the with-profiling macro, the form profiled is also printed.

This function returns one of the following possible values:

:inactive -- the profile has not yet started collecting samples

:suspended -- the profile has started sampling, but sampling is currently not being done

:sampling -- the profile has been started and sampling is occurring

:saved -- the profile has been stopped, but as yet no analysis of saved profile data has occurred

:analyzed -- all data of a finished profile has been analyzed

The :current-profile keyword argument, if supplied, causes the function to return the status of the given profile. The value of this argument defaults to the current profile. If specified, its value must be a profile saved with save-current-profile.

The :verbose keyword argument, if non-nil (default is t), causes additional information about the profile to be printed. If you specify it as nil, only the appropriate keyword (from the list above) is returned and nothing additional is printed.

A finalized profile (profiler-status returns :analyzed) can be saved using the macro save-current-profile.

See profiling.htm for general information on profiling. Note that the profiler is not available with some Allegro CL products.

The general documentation description is in introduction.htm. The index is in index.htm.