minor statprof tweaks
[bpt/guile.git] / module / statprof.scm
CommitLineData
47f3ce52
AW
1;;;; (statprof) -- a statistical profiler for Guile
2;;;; -*-scheme-*-
3;;;;
e1138ba1 4;;;; Copyright (C) 2009, 2010 Free Software Foundation, Inc.
47f3ce52
AW
5;;;; Copyright (C) 2004, 2009 Andy Wingo <wingo at pobox dot com>
6;;;; Copyright (C) 2001 Rob Browning <rlb at defaultvalue dot org>
7;;;;
8;;;; This library is free software; you can redistribute it and/or
9;;;; modify it under the terms of the GNU Lesser General Public
10;;;; License as published by the Free Software Foundation; either
11;;;; version 3 of the License, or (at your option) any later version.
12;;;;
13;;;; This library is distributed in the hope that it will be useful,
14;;;; but WITHOUT ANY WARRANTY; without even the implied warranty of
15;;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16;;;; Lesser General Public License for more details.
17;;;;
18;;;; You should have received a copy of the GNU Lesser General Public
19;;;; License along with this library; if not, write to the Free Software
20;;;; Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
21;;;;
22\f
23
24;;; Commentary:
25;;
26;;@code{(statprof)} is intended to be a fairly simple
27;;statistical profiler for guile. It is in the early stages yet, so
28;;consider its output still suspect, and please report any bugs to
29;;@email{guile-devel at gnu.org}, or to me directly at @email{rlb at
30;;defaultvalue.org}.
31;;
32;;A simple use of statprof would look like this:
33;;
34;;@example
35;; (statprof-reset 0 50000 #t)
36;; (statprof-start)
37;; (do-something)
38;; (statprof-stop)
39;; (statprof-display)
40;;@end example
41;;
42;;This would reset statprof, clearing all accumulated statistics, then
43;;start profiling, run some code, stop profiling, and finally display a
44;;gprof flat-style table of statistics which will look something like
45;;this:
46;;
47;;@example
48;; % cumulative self self total
49;; time seconds seconds calls ms/call ms/call name
50;; 35.29 0.23 0.23 2002 0.11 0.11 -
51;; 23.53 0.15 0.15 2001 0.08 0.08 positive?
52;; 23.53 0.15 0.15 2000 0.08 0.08 +
53;; 11.76 0.23 0.08 2000 0.04 0.11 do-nothing
54;; 5.88 0.64 0.04 2001 0.02 0.32 loop
55;; 0.00 0.15 0.00 1 0.00 150.59 do-something
56;; ...
57;;@end example
58;;
59;;All of the numerical data with the exception of the calls column is
60;;statistically approximate. In the following column descriptions, and
61;;in all of statprof, "time" refers to execution time (both user and
62;;system), not wall clock time.
63;;
64;;@table @asis
65;;@item % time
66;;The percent of the time spent inside the procedure itself
67;;(not counting children).
68;;@item cumulative seconds
69;;The total number of seconds spent in the procedure, including
70;;children.
71;;@item self seconds
72;;The total number of seconds spent in the procedure itself (not counting
73;;children).
74;;@item calls
75;;The total number of times the procedure was called.
76;;@item self ms/call
77;;The average time taken by the procedure itself on each call, in ms.
78;;@item total ms/call
79;;The average time taken by each call to the procedure, including time
80;;spent in child functions.
81;;@item name
82;;The name of the procedure.
83;;@end table
84;;
85;;The profiler uses @code{eq?} and the procedure object itself to
86;;identify the procedures, so it won't confuse different procedures with
87;;the same name. They will show up as two different rows in the output.
88;;
89;;Right now the profiler is quite simplistic. I cannot provide
90;;call-graphs or other higher level information. What you see in the
91;;table is pretty much all there is. Patches are welcome :-)
92;;
93;;@section Implementation notes
94;;
95;;The profiler works by setting the unix profiling signal
96;;@code{ITIMER_PROF} to go off after the interval you define in the call
97;;to @code{statprof-reset}. When the signal fires, a sampling routine is
98;;run which looks at the current procedure that's executing, and then
99;;crawls up the stack, and for each procedure encountered, increments
100;;that procedure's sample count. Note that if a procedure is encountered
101;;multiple times on a given stack, it is only counted once. After the
102;;sampling is complete, the profiler resets profiling timer to fire
103;;again after the appropriate interval.
104;;
105;;Meanwhile, the profiler keeps track, via @code{get-internal-run-time},
106;;how much CPU time (system and user -- which is also what
107;;@code{ITIMER_PROF} tracks), has elapsed while code has been executing
108;;within a statprof-start/stop block.
109;;
110;;The profiler also tries to avoid counting or timing its own code as
111;;much as possible.
112;;
113;;; Code:
114
115;; When you add new features, please also add tests to ./tests/ if you
116;; have time, and then add the new files to ./run-tests. Also, if
117;; anyone's bored, there are a lot of existing API bits that don't
118;; have tests yet.
119
120;; TODO
121;;
122;; Check about profiling C functions -- does profiling primitives work?
123;; Also look into stealing code from qprof so we can sample the C stack
124;; Call graphs?
125
126(define-module (statprof)
127 #:use-module (srfi srfi-1)
128 #:autoload (ice-9 format) (format)
e1138ba1
AW
129 #:use-module (system vm vm)
130 #:use-module (system vm frame)
131 #:use-module (system vm program)
47f3ce52
AW
132 #:export (statprof-active?
133 statprof-start
134 statprof-stop
135 statprof-reset
136
137 statprof-accumulated-time
138 statprof-sample-count
139 statprof-fold-call-data
140 statprof-proc-call-data
141 statprof-call-data-name
142 statprof-call-data-calls
143 statprof-call-data-cum-samples
144 statprof-call-data-self-samples
145 statprof-call-data->stats
146
147 statprof-stats-proc-name
148 statprof-stats-%-time-in-proc
149 statprof-stats-cum-secs-in-proc
150 statprof-stats-self-secs-in-proc
151 statprof-stats-calls
152 statprof-stats-self-secs-per-call
153 statprof-stats-cum-secs-per-call
154
155 statprof-display
156 statprof-display-anomolies
157
158 statprof-fetch-stacks
159 statprof-fetch-call-tree
160
e1138ba1 161 statprof
47f3ce52
AW
162 with-statprof))
163
164
165;; This profiler tracks two numbers for every function called while
166;; it's active. It tracks the total number of calls, and the number
167;; of times the function was active when the sampler fired.
168;;
169;; Globally the profiler tracks the total time elapsed and the number
170;; of times the sampler was fired.
171;;
172;; Right now, this profiler is not per-thread and is not thread safe.
173
174(define accumulated-time #f) ; total so far.
175(define last-start-time #f) ; start-time when timer is active.
176(define sample-count #f) ; total count of sampler calls.
177(define sampling-frequency #f) ; in (seconds . microseconds)
178(define remaining-prof-time #f) ; time remaining when prof suspended.
179(define profile-level 0) ; for user start/stop nesting.
180(define %count-calls? #t) ; whether to catch apply-frame.
181(define gc-time-taken 0) ; gc time between statprof-start and
182 ; statprof-stop.
183(define record-full-stacks? #f) ; if #t, stash away the stacks
184 ; for later analysis.
185(define stacks '())
186
187;; procedure-data will be a hash where the key is the function object
188;; itself and the value is the data. The data will be a vector like
189;; this: #(name call-count cum-sample-count self-sample-count)
190(define procedure-data #f)
191
192;; If you change the call-data data structure, you need to also change
193;; sample-uncount-frame.
c165c50d
AW
194(define (make-call-data proc call-count cum-sample-count self-sample-count)
195 (vector proc call-count cum-sample-count self-sample-count))
196(define (call-data-proc cd) (vector-ref cd 0))
197(define (call-data-name cd) (procedure-name (call-data-proc cd)))
198(define (call-data-printable cd)
199 (or (call-data-name cd)
200 (with-output-to-string (lambda () (write (call-data-proc cd))))))
47f3ce52
AW
201(define (call-data-call-count cd) (vector-ref cd 1))
202(define (call-data-cum-sample-count cd) (vector-ref cd 2))
203(define (call-data-self-sample-count cd) (vector-ref cd 3))
204
47f3ce52
AW
205(define (inc-call-data-call-count! cd)
206 (vector-set! cd 1 (1+ (vector-ref cd 1))))
207(define (inc-call-data-cum-sample-count! cd)
208 (vector-set! cd 2 (1+ (vector-ref cd 2))))
209(define (inc-call-data-self-sample-count! cd)
210 (vector-set! cd 3 (1+ (vector-ref cd 3))))
211
212(define-macro (accumulate-time stop-time)
213 `(set! accumulated-time
214 (+ accumulated-time 0.0 (- ,stop-time last-start-time))))
215
216(define (get-call-data proc)
663212bb
AW
217 (let ((k (if (or (not (program? proc))
218 (zero? (program-num-free-variables proc)))
219 proc
220 (program-objcode proc))))
221 (or (hashq-ref procedure-data k)
222 (let ((call-data (make-call-data proc 0 0 0)))
223 (hashq-set! procedure-data k call-data)
224 call-data))))
47f3ce52
AW
225
226;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
227;; SIGPROF handler
228
229(define (sample-stack-procs stack)
230 (let ((stacklen (stack-length stack))
231 (hit-count-call? #f))
232
233 (if record-full-stacks?
234 (set! stacks (cons stack stacks)))
235
236 (set! sample-count (+ sample-count 1))
237 ;; Now accumulate stats for the whole stack.
238 (let loop ((frame (stack-ref stack 0))
239 (procs-seen (make-hash-table 13))
240 (self #f))
241 (cond
242 ((not frame)
243 (hash-fold
244 (lambda (proc val accum)
245 (inc-call-data-cum-sample-count!
246 (get-call-data proc)))
247 #f
248 procs-seen)
249 (and=> (and=> self get-call-data)
250 inc-call-data-self-sample-count!))
251 ((frame-procedure frame)
252 => (lambda (proc)
253 (cond
254 ((eq? proc count-call)
255 ;; We're not supposed to be sampling count-call and
256 ;; its sub-functions, so loop again with a clean
257 ;; slate.
258 (set! hit-count-call? #t)
259 (loop (frame-previous frame) (make-hash-table 13) #f))
c165c50d 260 (else
47f3ce52
AW
261 (hashq-set! procs-seen proc #t)
262 (loop (frame-previous frame)
263 procs-seen
c165c50d 264 (or self proc))))))
47f3ce52
AW
265 (else
266 (loop (frame-previous frame) procs-seen self))))
267 hit-count-call?))
268
269(define inside-profiler? #f)
270
271(define (profile-signal-handler sig)
272 (set! inside-profiler? #t)
273
274 ;; FIXME: with-statprof should be able to set an outer frame for the
275 ;; stack cut
276 (if (positive? profile-level)
277 (let* ((stop-time (get-internal-run-time))
c165c50d
AW
278 ;; cut down to the signal handler. note that this will only
279 ;; work if statprof.scm is compiled; otherwise we get
280 ;; `eval' on the stack instead, because if it's not
281 ;; compiled, profile-signal-handler is a thunk that
282 ;; tail-calls eval. perhaps we should always compile the
283 ;; signal handler instead...
284 (stack (or (make-stack #t profile-signal-handler)
285 (pk 'what! (make-stack #t))))
47f3ce52
AW
286 (inside-apply-trap? (sample-stack-procs stack)))
287
288 (if (not inside-apply-trap?)
289 (begin
290 ;; disabling here is just a little more efficient, but
291 ;; not necessary given inside-profiler?. We can't just
292 ;; disable unconditionally at the top of this function
293 ;; and eliminate inside-profiler? because it seems to
294 ;; confuse guile wrt re-enabling the trap when
295 ;; count-call finishes.
e1138ba1
AW
296 (if %count-calls?
297 (set-vm-trace-level! (the-vm)
298 (1- (vm-trace-level (the-vm)))))
47f3ce52
AW
299 (accumulate-time stop-time)))
300
301 (setitimer ITIMER_PROF
302 0 0
303 (car sampling-frequency)
304 (cdr sampling-frequency))
305
306 (if (not inside-apply-trap?)
307 (begin
308 (set! last-start-time (get-internal-run-time))
e1138ba1
AW
309 (if %count-calls?
310 (set-vm-trace-level! (the-vm)
311 (1+ (vm-trace-level (the-vm)))))))))
312
47f3ce52
AW
313 (set! inside-profiler? #f))
314
315;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
316;; Count total calls.
317
e1138ba1 318(define (count-call frame)
47f3ce52
AW
319 (if (not inside-profiler?)
320 (begin
321 (accumulate-time (get-internal-run-time))
322
e1138ba1 323 (and=> (frame-procedure frame)
47f3ce52 324 (lambda (proc)
c165c50d
AW
325 (inc-call-data-call-count!
326 (get-call-data proc))))
47f3ce52
AW
327
328 (set! last-start-time (get-internal-run-time)))))
329
330;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
331
332(define (statprof-active?)
333 "Returns @code{#t} if @code{statprof-start} has been called more times
334than @code{statprof-stop}, @code{#f} otherwise."
335 (positive? profile-level))
336
337;; Do not call this from statprof internal functions -- user only.
338(define (statprof-start)
339 "Start the profiler.@code{}"
340 ;; After some head-scratching, I don't *think* I need to mask/unmask
341 ;; signals here, but if I'm wrong, please let me know.
342 (set! profile-level (+ profile-level 1))
343 (if (= profile-level 1)
344 (let* ((rpt remaining-prof-time)
345 (use-rpt? (and rpt
346 (or (positive? (car rpt))
347 (positive? (cdr rpt))))))
348 (set! remaining-prof-time #f)
349 (set! last-start-time (get-internal-run-time))
350 (set! gc-time-taken
351 (cdr (assq 'gc-time-taken (gc-stats))))
352 (if use-rpt?
353 (setitimer ITIMER_PROF 0 0 (car rpt) (cdr rpt))
354 (setitimer ITIMER_PROF
355 0 0
356 (car sampling-frequency)
357 (cdr sampling-frequency)))
663212bb
AW
358 (if %count-calls?
359 (add-hook! (vm-apply-hook (the-vm)) count-call))
e1138ba1 360 (set-vm-trace-level! (the-vm) (1+ (vm-trace-level (the-vm))))
47f3ce52
AW
361 #t)))
362
363;; Do not call this from statprof internal functions -- user only.
364(define (statprof-stop)
365 "Stop the profiler.@code{}"
366 ;; After some head-scratching, I don't *think* I need to mask/unmask
367 ;; signals here, but if I'm wrong, please let me know.
368 (set! profile-level (- profile-level 1))
369 (if (zero? profile-level)
370 (begin
371 (set! gc-time-taken
372 (- (cdr (assq 'gc-time-taken (gc-stats))) gc-time-taken))
e1138ba1 373 (set-vm-trace-level! (the-vm) (1- (vm-trace-level (the-vm))))
663212bb
AW
374 (if %count-calls?
375 (remove-hook! (vm-apply-hook (the-vm)) count-call))
47f3ce52
AW
376 ;; I believe that we need to do this before getting the time
377 ;; (unless we want to make things even more complicated).
378 (set! remaining-prof-time (setitimer ITIMER_PROF 0 0 0 0))
379 (accumulate-time (get-internal-run-time))
380 (set! last-start-time #f))))
381
e640b440
AW
382(define* (statprof-reset sample-seconds sample-microseconds count-calls?
383 #:optional full-stacks?)
47f3ce52
AW
384 "Reset the statprof sampler interval to @var{sample-seconds} and
385@var{sample-microseconds}. If @var{count-calls?} is true, arrange to
386instrument procedure calls as well as collecting statistical profiling
387data. If @var{full-stacks?} is true, collect all sampled stacks into a
388list for later analysis.
389
390Enables traps and debugging as necessary."
391 (if (positive? profile-level)
392 (error "Can't reset profiler while profiler is running."))
393 (set! %count-calls? count-calls?)
394 (set! accumulated-time 0)
395 (set! last-start-time #f)
396 (set! sample-count 0)
397 (set! sampling-frequency (cons sample-seconds sample-microseconds))
398 (set! remaining-prof-time #f)
399 (set! procedure-data (make-hash-table 131))
e640b440 400 (set! record-full-stacks? full-stacks?)
47f3ce52 401 (set! stacks '())
47f3ce52
AW
402 (sigaction SIGPROF profile-signal-handler)
403 #t)
404
405(define (statprof-fold-call-data proc init)
406 "Fold @var{proc} over the call-data accumulated by statprof. Cannot be
407called while statprof is active. @var{proc} should take two arguments,
408@code{(@var{call-data} @var{prior-result})}.
409
410Note that a given proc-name may appear multiple times, but if it does,
411it represents different functions with the same name."
412 (if (positive? profile-level)
413 (error "Can't call statprof-fold-called while profiler is running."))
414
415 (hash-fold
416 (lambda (key value prior-result)
417 (proc value prior-result))
418 init
419 procedure-data))
420
421(define (statprof-proc-call-data proc)
422 "Returns the call-data associated with @var{proc}, or @code{#f} if
423none is available."
424 (if (positive? profile-level)
425 (error "Can't call statprof-fold-called while profiler is running."))
426
427 (hashq-ref procedure-data proc))
428
429;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
430;; Stats
431
432(define (statprof-call-data->stats call-data)
433 "Returns an object of type @code{statprof-stats}."
434 ;; returns (vector proc-name
435 ;; %-time-in-proc
436 ;; cum-seconds-in-proc
437 ;; self-seconds-in-proc
438 ;; num-calls
439 ;; self-secs-per-call
440 ;; total-secs-per-call)
441
c165c50d 442 (let* ((proc-name (call-data-printable call-data))
47f3ce52
AW
443 (self-samples (call-data-self-sample-count call-data))
444 (cum-samples (call-data-cum-sample-count call-data))
445 (all-samples (statprof-sample-count))
446 (secs-per-sample (/ (statprof-accumulated-time)
447 (statprof-sample-count)))
448 (num-calls (and %count-calls? (statprof-call-data-calls call-data))))
449
450 (vector proc-name
451 (* (/ self-samples all-samples) 100.0)
452 (* cum-samples secs-per-sample 1.0)
453 (* self-samples secs-per-sample 1.0)
454 num-calls
455 (and num-calls ;; maybe we only sampled in children
456 (if (zero? self-samples) 0.0
457 (/ (* self-samples secs-per-sample) 1.0 num-calls)))
458 (and num-calls ;; cum-samples must be positive
e1138ba1
AW
459 (/ (* cum-samples secs-per-sample)
460 1.0
461 ;; num-calls might be 0 if we entered statprof during the
462 ;; dynamic extent of the call
463 (max num-calls 1))))))
47f3ce52
AW
464
465(define (statprof-stats-proc-name stats) (vector-ref stats 0))
466(define (statprof-stats-%-time-in-proc stats) (vector-ref stats 1))
467(define (statprof-stats-cum-secs-in-proc stats) (vector-ref stats 2))
468(define (statprof-stats-self-secs-in-proc stats) (vector-ref stats 3))
469(define (statprof-stats-calls stats) (vector-ref stats 4))
470(define (statprof-stats-self-secs-per-call stats) (vector-ref stats 5))
471(define (statprof-stats-cum-secs-per-call stats) (vector-ref stats 6))
472
473;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
474
475(define (stats-sorter x y)
476 (let ((diff (- (statprof-stats-self-secs-in-proc x)
477 (statprof-stats-self-secs-in-proc y))))
478 (positive?
479 (if (= diff 0)
480 (- (statprof-stats-cum-secs-in-proc x)
481 (statprof-stats-cum-secs-in-proc y))
482 diff))))
483
484(define (statprof-display . port)
485 "Displays a gprof-like summary of the statistics collected. Unless an
486optional @var{port} argument is passed, uses the current output port."
487 (if (null? port) (set! port (current-output-port)))
488
489 (cond
490 ((zero? (statprof-sample-count))
491 (format port "No samples recorded.\n"))
492 (else
493 (let* ((stats-list (statprof-fold-call-data
494 (lambda (data prior-value)
495 (cons (statprof-call-data->stats data)
496 prior-value))
497 '()))
498 (sorted-stats (sort stats-list stats-sorter)))
499
500 (define (display-stats-line stats)
501 (if %count-calls?
e1138ba1 502 (format port "~6,2f ~9,2f ~9,2f ~7d ~8,2f ~8,2f "
47f3ce52
AW
503 (statprof-stats-%-time-in-proc stats)
504 (statprof-stats-cum-secs-in-proc stats)
505 (statprof-stats-self-secs-in-proc stats)
506 (statprof-stats-calls stats)
507 (* 1000 (statprof-stats-self-secs-per-call stats))
508 (* 1000 (statprof-stats-cum-secs-per-call stats)))
509 (format port "~6,2f ~9,2f ~9,2f "
510 (statprof-stats-%-time-in-proc stats)
511 (statprof-stats-cum-secs-in-proc stats)
512 (statprof-stats-self-secs-in-proc stats)))
513 (display (statprof-stats-proc-name stats) port)
514 (newline port))
515
516 (if %count-calls?
517 (begin
518 (format port "~5a ~10a ~7a ~8a ~8a ~8a ~8@a\n"
519 "% " "cumulative" "self" "" "self" "total" "")
520 (format port "~5a ~9a ~8a ~8a ~8a ~8a ~8@a\n"
521 "time" "seconds" "seconds" "calls" "ms/call" "ms/call" "name"))
522 (begin
523 (format port "~5a ~10a ~7a ~8@a\n"
524 "%" "cumulative" "self" "")
525 (format port "~5a ~10a ~7a ~8@a\n"
526 "time" "seconds" "seconds" "name")))
527
528 (for-each display-stats-line sorted-stats)
529
530 (display "---\n" port)
531 (simple-format #t "Sample count: ~A\n" (statprof-sample-count))
532 (simple-format #t "Total time: ~A seconds (~A seconds in GC)\n"
533 (statprof-accumulated-time)
e640b440 534 (/ gc-time-taken 1.0 internal-time-units-per-second))))))
47f3ce52
AW
535
536(define (statprof-display-anomolies)
537 "A sanity check that attempts to detect anomolies in statprof's
538statistics.@code{}"
539 (statprof-fold-call-data
540 (lambda (data prior-value)
541 (if (and %count-calls?
542 (zero? (call-data-call-count data))
c165c50d 543 (positive? (call-data-cum-sample-count data)))
47f3ce52
AW
544 (simple-format #t
545 "==[~A ~A ~A]\n"
546 (call-data-name data)
547 (call-data-call-count data)
c165c50d 548 (call-data-cum-sample-count data))))
47f3ce52
AW
549 #f)
550 (simple-format #t "Total time: ~A\n" (statprof-accumulated-time))
551 (simple-format #t "Sample count: ~A\n" (statprof-sample-count)))
552
553(define (statprof-accumulated-time)
554 "Returns the time accumulated during the last statprof run.@code{}"
555 (if (positive? profile-level)
556 (error "Can't get accumulated time while profiler is running."))
557 (/ accumulated-time internal-time-units-per-second))
558
559(define (statprof-sample-count)
560 "Returns the number of samples taken during the last statprof run.@code{}"
561 (if (positive? profile-level)
562 (error "Can't get accumulated time while profiler is running."))
563 sample-count)
564
565(define statprof-call-data-name call-data-name)
566(define statprof-call-data-calls call-data-call-count)
567(define statprof-call-data-cum-samples call-data-cum-sample-count)
568(define statprof-call-data-self-samples call-data-self-sample-count)
569
570(define (statprof-fetch-stacks)
571 "Returns a list of stacks, as they were captured since the last call
572to @code{statprof-reset}.
573
574Note that stacks are only collected if the @var{full-stacks?} argument
575to @code{statprof-reset} is true."
576 stacks)
577
578(define procedure=?
663212bb
AW
579 (lambda (a b)
580 (cond
581 ((eq? a b))
582 ((and (program? a) (program? b))
583 (eq? (program-objcode a) (program-objcode b)))
584 (else
585 #f))))
47f3ce52
AW
586
587;; tree ::= (car n . tree*)
588
589(define (lists->trees lists equal?)
590 (let lp ((in lists) (n-terminal 0) (tails '()))
591 (cond
592 ((null? in)
593 (let ((trees (map (lambda (tail)
594 (cons (car tail)
595 (lists->trees (cdr tail) equal?)))
596 tails)))
597 (cons (apply + n-terminal (map cadr trees))
598 (sort trees
599 (lambda (a b) (> (cadr a) (cadr b)))))))
600 ((null? (car in))
601 (lp (cdr in) (1+ n-terminal) tails))
602 ((find (lambda (x) (equal? (car x) (caar in)))
603 tails)
604 => (lambda (tail)
605 (lp (cdr in)
606 n-terminal
607 (assq-set! tails
608 (car tail)
609 (cons (cdar in) (cdr tail))))))
610 (else
611 (lp (cdr in)
612 n-terminal
613 (acons (caar in) (list (cdar in)) tails))))))
614
615(define (stack->procedures stack)
616 (filter identity
617 (unfold-right (lambda (x) (not x))
618 frame-procedure
619 frame-previous
620 (stack-ref stack 0))))
621
622(define (statprof-fetch-call-tree)
623 "Return a call tree for the previous statprof run.
624
625The return value is a list of nodes, each of which is of the type:
626@code
627 node ::= (@var{proc} @var{count} . @var{nodes})
628@end code"
629 (cons #t (lists->trees (map stack->procedures stacks) procedure=?)))
630
e1138ba1
AW
631(define* (statprof thunk #:key (loop 1) (hz 100) (count-calls? #f)
632 (full-stacks? #f))
633 "Profiles the execution of @var{thunk}.
634
635The stack will be sampled @var{hz} times per second, and the thunk itself will
636be called @var{loop} times.
637
638If @var{count-calls?} is true, all procedure calls will be recorded. This
639operation is somewhat expensive.
640
641If @var{full-stacks?} is true, at each sample, statprof will store away the
642whole call tree, for later analysis. Use @code{statprof-fetch-stacks} or
643@code{statprof-fetch-call-tree} to retrieve the last-stored stacks."
644
645 (dynamic-wind
646 (lambda ()
647 (statprof-reset (inexact->exact (floor (/ 1 hz)))
648 (inexact->exact (* 1e6 (- (/ 1 hz)
649 (floor (/ 1 hz)))))
650 count-calls?
651 full-stacks?)
652 (statprof-start))
653 (lambda ()
654 (let lp ((i loop))
655 (if (not (zero? i))
656 (begin
657 (thunk)
658 (lp (1- i))))))
659 (lambda ()
660 (statprof-stop)
661 (statprof-display)
662 (set! procedure-data #f))))
663
47f3ce52
AW
664(define-macro (with-statprof . args)
665 "Profiles the expressions in its body.
666
667Keyword arguments:
668
669@table @code
670@item #:loop
671Execute the body @var{loop} number of times, or @code{#f} for no looping
672
673default: @code{#f}
674@item #:hz
675Sampling rate
676
677default: @code{20}
678@item #:count-calls?
679Whether to instrument each function call (expensive)
680
681default: @code{#f}
682@item #:full-stacks?
683Whether to collect away all sampled stacks into a list
684
685default: @code{#f}
686@end table"
687 (define (kw-arg-ref kw args def)
688 (cond
689 ((null? args) (error "Invalid macro body"))
690 ((keyword? (car args))
691 (if (eq? (car args) kw)
692 (cadr args)
693 (kw-arg-ref kw (cddr args) def)))
694 ((eq? kw #f def) ;; asking for the body
695 args)
696 (else def))) ;; kw not found
e1138ba1
AW
697 `((@ (statprof) statprof)
698 (lambda () ,@(kw-arg-ref #f args #f))
699 #:loop ,(kw-arg-ref #:loop args 1)
700 #:hz ,(kw-arg-ref #:hz args 100)
701 #:count-calls? ,(kw-arg-ref #:count-calls? args #f)
702 #:full-stacks? ,(kw-arg-ref #:full-stacks? args #f)))
703