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 X.

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

One of the keywords :profile , :virtual and :real .

interval

A positive integer.

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, as follows.

symbols (or packages ) specifies which symbols are to be monitored by the profiler.

kind specifies the way that the time between samples is measured:

:profile

Process time only.

:virtual

Process time and system time for the process.

:real

Real time.

The default value of kind is :profile .

interval specifies the time interval in milliseconds between profiling samples. The minimum value of interval is 10000, that is 10 ms.

Example

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

                 :interval 50000)

On Unix/Linux/Mac OS X:

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

                 :kind :profile :interval 50000)

See also

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