From f804796eecce86953c9f47ed07e9a6a34655ff32 Mon Sep 17 00:00:00 2001 From: Dave Love Date: Mon, 3 Feb 2003 15:00:57 +0000 Subject: *** empty log message *** --- etc/NEWS | 3 ++ lisp/ChangeLog | 4 ++ lisp/emacs-lisp/benchmark.el | 117 +++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 124 insertions(+) create mode 100644 lisp/emacs-lisp/benchmark.el diff --git a/etc/NEWS b/etc/NEWS index dbf6cf99abe..c8bdfdefb3b 100644 --- a/etc/NEWS +++ b/etc/NEWS @@ -1144,6 +1144,9 @@ mode-lines in inverse-video. ** The obsolete C mode (c-mode.el) has been removed to avoid problems with Custom. +** New package benchmark.el contains simple support for convenient +timing measurements of code (including the garbage collection component). + * Lisp Changes in Emacs 21.4 diff --git a/lisp/ChangeLog b/lisp/ChangeLog index fb3304e0f1c..9c7938cb2b7 100644 --- a/lisp/ChangeLog +++ b/lisp/ChangeLog @@ -1,3 +1,7 @@ +2003-02-03 Dave Love + + * emacs-lisp/benchmark.el: New. + 2003-02-02 Andreas Schwab * progmodes/asm-mode.el (asm-font-lock-keywords): Allow arbitrary diff --git a/lisp/emacs-lisp/benchmark.el b/lisp/emacs-lisp/benchmark.el new file mode 100644 index 00000000000..cc8a7bf96f6 --- /dev/null +++ b/lisp/emacs-lisp/benchmark.el @@ -0,0 +1,117 @@ +;;; benchmark.el --- support for benchmarking code + +;; Copyright (C) 2003 Free Software Foundation, Inc. + +;; Author: Dave Love +;; Keywords: lisp, extensions + +;; This file is free software; you can redistribute it and/or modify +;; it under the terms of the GNU General Public License as published by +;; the Free Software Foundation; either version 2, or (at your option) +;; any later version. + +;; This file is distributed in the hope that it will be useful, +;; but WITHOUT ANY WARRANTY; without even the implied warranty of +;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +;; GNU General Public License for more details. + +;; You should have received a copy of the GNU General Public License +;; along with GNU Emacs; see the file COPYING. If not, write to +;; the Free Software Foundation, Inc., 59 Temple Place - Suite 330, +;; Boston, MA 02111-1307, USA. + +;;; Commentary: + +;; Utilities for timing the execution of forms, including the time +;; taken for GC. Note that prior to timing code you may want to +;; ensure things like: there has just been a GC, the relevant code is +;; already loaded (so that there's no overhead from autoloading etc.), +;; and the code is compiled if appropriate (but see +;; `benchmark-run-compiled'). + +;;; Code: + +(defmacro benchmark-elapse (&rest forms) + "Return the time in seconds elapsed for execution of FORMS." + (let ((t1 (make-symbol "t1")) + (t2 (make-symbol "t2"))) + `(let (,t1 ,t2) + (setq ,t1 (current-time)) + ,@forms + (setq ,t2 (current-time)) + (+ (* (- (car ,t2) (car ,t1)) 65536.0) + (- (nth 1 ,t2) (nth 1 ,t1)) + (* (- (nth 2 ,t2) (nth 2 ,t1)) 1.0e-6))))) +(put 'benchmark-elapse 'edebug-form-spec t) +(put 'benchmark-elapse 'lisp-indent-function 0) + +;;;###autoload +(defmacro benchmark-run (&optional repetitions &rest forms) + "Time execution of FORMS. +If REPETITIONS is supplied as a number, run forms that many times, +accounting for the overhead of the resulting loop. Otherwise run +FORMS once. +Return a list of the total elapsed time for execution, the number of +garbage collections that ran, and the time taken by garbage collection. +See also `benchmark-run-compiled'." + (unless (natnump repetitions) + (setq forms (cons repetitions forms) + repetitions 1)) + (let ((i (make-symbol "i")) + (gcs (make-symbol "gcs")) + (gc (make-symbol "gc"))) + `(let ((,gc gc-elapsed) + (,gcs gcs-done)) + (list ,(if (> repetitions 1) + ;; Take account of the loop overhead. + `(- (benchmark-elapse (dotimes (,i ,repetitions) + ,@forms)) + (benchmark-elapse (dotimes (,i ,repetitions)))) + `(benchmark-elapse ,@forms)) + (- gcs-done ,gcs) + (- gc-elapsed ,gc))))) +(put 'benchmark-run 'edebug-form-spec t) +(put 'benchmark-run 'lisp-indent-function 2) + +;;;###autoload +(defmacro benchmark-run-compiled (&optional repetitions &rest forms) + "Time execution of compiled version of FORMS. +This is like `benchmark-run', but what is timed is a funcall of the +byte code obtained by wrapping FORMS in a `lambda' and compiling the +result. The overhead of the `lambda's is accounted for." + (unless (natnump repetitions) + (setq forms (cons repetitions forms) + repetitions 1)) + (let ((i (make-symbol "i")) + (gcs (make-symbol "gcs")) + (gc (make-symbol "gc")) + (code (byte-compile `(lambda () ,@forms))) + (lambda-code (byte-compile `(lambda ())))) + `(let ((,gc gc-elapsed) + (,gcs gcs-done)) + (list ,(if (> repetitions 1) + ;; Take account of the loop overhead. + `(- (benchmark-elapse (dotimes (,i ,repetitions) + (funcall ,code))) + (benchmark-elapse (dotimes (,i ,repetitions) + (funcall ,lambda-code)))) + `(benchmark-elapse (funcall ,code))) + (- gcs-done ,gcs) (- gc-elapsed ,gc))))) +(put 'benchmark-run-compiled 'edebug-form-spec t) +(put 'benchmark-run-compiled 'lisp-indent-function 2) + +;;;###autoload +(defun benchmark (repetitions form) + "Print the time taken for REPETITIONS executions of FORM. +Interactively, REPETITIONS is taken from the prefix arg. For +non-interactive use see also `benchmark-run' and +`benchmark-run-compiled'." + (interactive "p\nxForm: ") + (let ((result (eval `(benchmark-run ,repetitions ,form)))) + (if (zerop (nth 1 result)) + (message "Elapsed time: %fs" (car result)) + (message "Elapsed time: %fs (%fs in %d GCs)" (car result) + (nth 2 result) (nth 1 result))))) + +(provide 'benchmark) +;;; benchmark.el ends here -- cgit v1.2.1