Merge branch 'seq-let'
[emacs.git] / lisp / emacs-lisp / benchmark.el
Commit [+]AuthorDateLineData
500ae430
DL
Dave Love2003-02-03 15:00:57 +00001;;; benchmark.el --- support for benchmarking code
2
7e09ef09 Paul Eggert2015-01-01 14:26:41 -08003;; Copyright (C) 2003-2015 Free Software Foundation, Inc.
500ae430
DL
Dave Love2003-02-03 15:00:57 +00004
5;; Author: Dave Love <fx@gnu.org>
6;; Keywords: lisp, extensions
7
d6cba7ae
GM
Glenn Morris2008-05-06 03:21:21 +00008;; This file is part of GNU Emacs.
9
10;; GNU Emacs is free software: you can redistribute it and/or modify
500ae430 Dave Love2003-02-03 15:00:57 +000011;; it under the terms of the GNU General Public License as published by
d6cba7ae
GM
Glenn Morris2008-05-06 03:21:21 +000012;; the Free Software Foundation, either version 3 of the License, or
13;; (at your option) any later version.
500ae430 Dave Love2003-02-03 15:00:57 +000014
d6cba7ae Glenn Morris2008-05-06 03:21:21 +000015;; GNU Emacs is distributed in the hope that it will be useful,
500ae430
DL
Dave Love2003-02-03 15:00:57 +000016;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18;; GNU General Public License for more details.
19
20;; You should have received a copy of the GNU General Public License
d6cba7ae Glenn Morris2008-05-06 03:21:21 +000021;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
500ae430
DL
Dave Love2003-02-03 15:00:57 +000022
23;;; Commentary:
24
25;; Utilities for timing the execution of forms, including the time
26;; taken for GC. Note that prior to timing code you may want to
27;; ensure things like: there has just been a GC, the relevant code is
28;; already loaded (so that there's no overhead from autoloading etc.),
29;; and the code is compiled if appropriate (but see
30;; `benchmark-run-compiled').
31
32;;; Code:
33
34(defmacro benchmark-elapse (&rest forms)
35 "Return the time in seconds elapsed for execution of FORMS."
36 (let ((t1 (make-symbol "t1"))
37 (t2 (make-symbol "t2")))
38 `(let (,t1 ,t2)
39 (setq ,t1 (current-time))
40 ,@forms
41 (setq ,t2 (current-time))
e2bac5f6
PE
Paul Eggert2011-06-30 17:27:45 -070042 (float-time (time-subtract ,t2 ,t1)))))
43
500ae430
DL
Dave Love2003-02-03 15:00:57 +000044(put 'benchmark-elapse 'edebug-form-spec t)
45(put 'benchmark-elapse 'lisp-indent-function 0)
46
47;;;###autoload
48(defmacro benchmark-run (&optional repetitions &rest forms)
49 "Time execution of FORMS.
50If REPETITIONS is supplied as a number, run forms that many times,
51accounting for the overhead of the resulting loop. Otherwise run
52FORMS once.
53Return a list of the total elapsed time for execution, the number of
54garbage collections that ran, and the time taken by garbage collection.
55See also `benchmark-run-compiled'."
9b851e25 Stefan Monnier2012-09-09 21:16:13 -040056 (declare (indent 1) (debug t))
500ae430
DL
Dave Love2003-02-03 15:00:57 +000057 (unless (natnump repetitions)
58 (setq forms (cons repetitions forms)
59 repetitions 1))
60 (let ((i (make-symbol "i"))
61 (gcs (make-symbol "gcs"))
62 (gc (make-symbol "gc")))
63 `(let ((,gc gc-elapsed)
64 (,gcs gcs-done))
65 (list ,(if (> repetitions 1)
66 ;; Take account of the loop overhead.
67 `(- (benchmark-elapse (dotimes (,i ,repetitions)
68 ,@forms))
69 (benchmark-elapse (dotimes (,i ,repetitions))))
70 `(benchmark-elapse ,@forms))
71 (- gcs-done ,gcs)
72 (- gc-elapsed ,gc)))))
500ae430
DL
Dave Love2003-02-03 15:00:57 +000073
74;;;###autoload
75(defmacro benchmark-run-compiled (&optional repetitions &rest forms)
76 "Time execution of compiled version of FORMS.
77This is like `benchmark-run', but what is timed is a funcall of the
78byte code obtained by wrapping FORMS in a `lambda' and compiling the
79result. The overhead of the `lambda's is accounted for."
9b851e25 Stefan Monnier2012-09-09 21:16:13 -040080 (declare (indent 1) (debug t))
500ae430
DL
Dave Love2003-02-03 15:00:57 +000081 (unless (natnump repetitions)
82 (setq forms (cons repetitions forms)
83 repetitions 1))
84 (let ((i (make-symbol "i"))
85 (gcs (make-symbol "gcs"))
86 (gc (make-symbol "gc"))
87 (code (byte-compile `(lambda () ,@forms)))
88 (lambda-code (byte-compile `(lambda ()))))
89 `(let ((,gc gc-elapsed)
90 (,gcs gcs-done))
91 (list ,(if (> repetitions 1)
92 ;; Take account of the loop overhead.
93 `(- (benchmark-elapse (dotimes (,i ,repetitions)
94 (funcall ,code)))
95 (benchmark-elapse (dotimes (,i ,repetitions)
96 (funcall ,lambda-code))))
97 `(benchmark-elapse (funcall ,code)))
98 (- gcs-done ,gcs) (- gc-elapsed ,gc)))))
500ae430
DL
Dave Love2003-02-03 15:00:57 +000099
100;;;###autoload
101(defun benchmark (repetitions form)
102 "Print the time taken for REPETITIONS executions of FORM.
e597afcb
JB
Juanma Barranquero2009-03-17 10:32:20 +0000103Interactively, REPETITIONS is taken from the prefix arg.
104For non-interactive use see also `benchmark-run' and
500ae430
DL
Dave Love2003-02-03 15:00:57 +0000105`benchmark-run-compiled'."
106 (interactive "p\nxForm: ")
107 (let ((result (eval `(benchmark-run ,repetitions ,form))))
108 (if (zerop (nth 1 result))
109 (message "Elapsed time: %fs" (car result))
110 (message "Elapsed time: %fs (%fs in %d GCs)" (car result)
111 (nth 2 result) (nth 1 result)))))
112
113(provide 'benchmark)
ab5796a9 Miles Bader2003-09-01 15:45:59 +0000114
500ae430 Dave Love2003-02-03 15:00:57 +0000115;;; benchmark.el ends here