(statprof)

Overview

(statprof) is intended to be a fairly simple statistical profiler for guile. It is in the early stages yet, so consider its output still suspect, and please report any bugs to guile-devel at gnu.org, or to me directly at rlb at defaultvalue.org.

This would reset statprof, clearing all accumulated statistics, then start profiling, run some code, stop profiling, and finally display a gprof flat-style table of statistics which will look something like this:

All of the numerical data with the exception of the calls column is statistically approximate. In the following column descriptions, and in all of statprof, "time" refers to execution time (both user and system), not wall clock time.

% time

The percent of the time spent inside the procedure itself (not counting children).

cumulative seconds

The total number of seconds spent in the procedure, including children.

self seconds

The total number of seconds spent in the procedure itself (not counting children).

calls

The total number of times the procedure was called.

self ms/call

The average time taken by the procedure itself on each call, in ms.

total ms/call

The average time taken by each call to the procedure, including time spent in child functions.

name

The name of the procedure.

The profiler uses eq? and the procedure object itself to identify the procedures, so it won't confuse different procedures with the same name. They will show up as two different rows in the output.

Right now the profiler is quite simplistic. I cannot provide call-graphs or other higher level information. What you see in the table is pretty much all there is. Patches are welcome :-)

Implementation notes

The profiler works by setting the unix profiling signal ITIMER_PROF to go off after the interval you define in the call to statprof-reset. When the signal fires, a sampling routine is run which looks at the current procedure that's executing, and then crawls up the stack, and for each procedure encountered, increments that procedure's sample count. Note that if a procedure is encountered multiple times on a given stack, it is only counted once. After the sampling is complete, the profiler resets profiling timer to fire again after the appropriate interval.

Meanwhile, the profiler keeps track, via get-internal-run-time, how much CPU time (system and user -- which is also what ITIMER_PROF tracks), has elapsed while code has been executing within a statprof-start/stop block.

The profiler also tries to avoid counting or timing its own code as much as possible.

Usage

statprof-active?

[Function]

Returns #t if statprof-start has been called more times than statprof-stop, #f otherwise.

statprof-start

[Function]

Start the profiler.

statprof-stop

[Function]

Stop the profiler.

statprof-reset

[Function]

Reset the statprof sampler interval to sample-seconds and sample-microseconds. If count-calls? is true, arrange to instrument procedure calls as well as collecting statistical profiling data. If full-stacks? is true, collect all sampled stacks into a list for later analysis.

Enables traps and debugging as necessary.

statprof-accumulated-time

[Function]

Returns the time accumulated during the last statprof run.

statprof-sample-count

[Function]

Returns the number of samples taken during the last statprof run.

statprof-fold-call-data

[Function]

Fold proc over the call-data accumulated by statprof. Cannot be called while statprof is active. proc should take two arguments, (call-dataprior-result).

Note that a given proc-name may appear multiple times, but if it does, it represents different functions with the same name.

statprof-proc-call-data

[Function]

Returns the call-data associated with proc, or #f if none is available.

statprof-call-data-name

[Function]

statprof-call-data-calls

[Function]

statprof-call-data-cum-samples

[Function]

statprof-call-data-self-samples

[Function]

statprof-call-data->stats

[Function]

Returns an object of type statprof-stats.

statprof-stats-proc-name

[Function]

statprof-stats-%-time-in-proc

[Function]

statprof-stats-cum-secs-in-proc

[Function]

statprof-stats-self-secs-in-proc

[Function]

statprof-stats-calls

[Function]

statprof-stats-self-secs-per-call

[Function]

statprof-stats-cum-secs-per-call

[Function]

statprof-display

[Function]

Displays a gprof-like summary of the statistics collected. Unless an optional port argument is passed, uses the current output port.

statprof-display-anomolies

[Function]

A sanity check that attempts to detect anomolies in statprof's statistics.

statprof-fetch-stacks

[Function]

Returns a list of stacks, as they were captured since the last call to statprof-reset.

Note that stacks are only collected if the full-stacks? argument to statprof-reset is true.

statprof-fetch-call-tree

[Function]

Return a call tree for the previous statprof run.
The return value is a list of nodes, each of which is of the type:
@code
node ::= (@var{proc} @var{count} . @var{nodes})
@end code