Function

Summary

Declares the parameter values of the profiling function.

Package

hcl

Signature

set-up-profiler &key symbols packages kind interval

Note: the argument kind is available only on UNIX/Linux/Mac OS.

Arguments

symbols

A symbol or a list of symbols. Each symbol is checked to see if it is suitable for profiling and if so it is added to the list *profile-symbol-list*.

packages

A valid package name or list of package names, or :all , meaning all packages. All the symbols in the packages are checked as above. If a :symbols keyword is present then this argument is ignored.

kind

There are three possible values corresponding to the kinds of profiling that are available:

:profile -- process time only

:virtual -- process time and system time

:real -- real time

The default value is :profile .

interval

A positive integer representing time in microseconds. The default value is 10000.

Values

The time interval is returned.

Description

set-up-profiler is used to declare the values of the parameters of the profiling function. Three values are required:

• The symbols or packages to be monitored by the profiler.
• The kind of profiling to be done. This refers to how the time between samples is measured. There are three possibilities for what time is measured:

Process time and system time for the process.

Process time only.

Real time.

• The time interval between profiling samples. This time interval is in microseconds, and the minimum value is 10000, i.e. 10 ms.

Example

(set-up-profiler :symbols '(car cdr)

                 :interval 50000)

On Unix/Linux/Mac OS:

(set-up-profiler :symbols '(car cdr)

                 :kind :profile :interval 50000)

See also

add-symbol-profiler
profile
*profile-symbol-list*
remove-symbol-profiler