support.lisp 5.97 KB
Newer Older
Eric Marsden's avatar
Eric Marsden committed
1
2
3
;;; support.lisp --- performance benchmarks for Common Lisp implementations
;;
;; Author: Eric Marsden  <emarsden@laas.fr>
4
5
;; Maintainer: Daniel Kochmański <daniel@turtleware.eu>
;;
6
;; Time-stamp: <2016-05-16 15:39:14 jack>
Eric Marsden's avatar
Eric Marsden committed
7
8
9
10
11
12
13
14
15
16
17
18
19
20
;;
;;
;; The benchmarks consist of
;;
;;   - the Gabriel benchmarks
;;   - some mathematical operations (factorial, fibonnaci, CRC)
;;   - some bignum-intensive operations
;;   - hashtable and READ-LINE tests
;;   - CLOS tests
;;   - array, string and bitvector exercises
;;

(in-package :cl-bench)

21
(defvar *version* "20160513")
Eric Marsden's avatar
Eric Marsden committed
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39

(defvar *benchmarks* '())
(defvar *benchmark-results* '())

(defvar +implementation+
  (concatenate 'string
               (lisp-implementation-type) " "
               (lisp-implementation-version)))


(defclass benchmark ()
    ((name   :accessor benchmark-name
             :initarg :name)
     (short  :accessor benchmark-short
             :initarg :short
             :type string)
     (long   :accessor benchmark-long
             :initarg :long
40
             :initform ""
Eric Marsden's avatar
Eric Marsden committed
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
             :type string)
     (group  :accessor benchmark-group
             :initarg :group)
     (runs   :accessor benchmark-runs
             :initarg :runs
             :initform 1
             :type integer)
     (disabled-for :accessor benchmark-disabled-for
                   :initarg :disabled-for
                   :initform nil)
     (setup    :initarg :setup
               :initform nil)
     (function :initarg :function
               :accessor benchmark-function)))

(defmethod print-object ((self benchmark) stream)
  (print-unreadable-object (self stream :type nil)
     (format stream "benchmark ~a for ~d runs"
             (benchmark-short self)
             (benchmark-runs self))))

(defmethod initialize-instance :after ((self benchmark)
                                       &rest initargs
                                       &key &allow-other-keys)
   (declare (ignore initargs))
   (unless (slot-boundp self 'short)
     (setf (benchmark-short self) (string (benchmark-name self))))
   self)

;;    (setf (benchmark-function self)
;;          (compile nil `(lambda ()
;;                         (dotimes (i ,(benchmark-runs self))
;;                           `(funcall ',(benchmark-function ,self))))))


(defmacro defbench (fun &rest args)
  `(push (make-instance 'benchmark :name ',fun ,@args)
         *benchmarks*))



(defvar *benchmark-output*)
(defvar *current-test*)


(defmacro with-bench-output (&body body)
  `(with-open-file (f (benchmark-report-file)
                    :direction :output
                    :if-exists :supersede)
    (let ((*benchmark-output* f)
          (*load-verbose* nil)
          (*print-length* nil)
          (*compile-verbose* nil)
          (*compile-print* nil))
      (bench-report-header)
      (progn ,@body)
      (bench-report-footer))))

99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
(defun bench-run-1 (benchmark &key force)
  (multiple-value-bind (real user sys consed)
      (if (and (not force)
               (some #'(lambda (bench)
                         (member bench *features*))
                     (benchmark-disabled-for benchmark)))
          (progn
            (format t "~&=== skipping disabled ~a~%" benchmark))
          (progn
            (bench-gc)
            (with-slots (setup function runs) benchmark
              (when setup (funcall setup))
              (format t "~&=== running ~a~%" benchmark)
              (bench-time function runs))))
    (push (list (slot-value benchmark 'short) real user sys consed)
          *benchmark-results*)))

Eric Marsden's avatar
Eric Marsden committed
116
117
118
119
120
121
122
123
124
125
126
(defun bench-run ()
  (with-open-file (f (benchmark-report-file)
                     :direction :output
                     :if-exists :supersede)
     (let ((*benchmark-output* f)
           (*print-length*)
           (*load-verbose* nil)
           (*compile-verbose* nil)
           (*compile-print* nil))
       (bench-report-header)
       (dolist (b (reverse *benchmarks*))
127
128
         (bench-run-1 b)
         (bench-report (car *benchmark-results*)))
Eric Marsden's avatar
Eric Marsden committed
129
130
131
132
133
134
135
       (bench-report-footer))))

(defun benchmark-report-file ()
  (multiple-value-bind (second minute hour date month year)
      (get-decoded-time)
    (declare (ignore second))
    (format nil "~aCL-benchmark-~d~2,'0d~2,'0dT~2,'0d~2,'0d"
136
            (namestring *output-dir*)
Eric Marsden's avatar
Eric Marsden committed
137
138
139
140
            year month date hour minute)))

(defun bench-report-header ()
  (format *benchmark-output*
141
          ";; -*- lisp -*-  ~a~%;;~%#| Implementation *features*: ~s |#~%;;~%"
Eric Marsden's avatar
Eric Marsden committed
142
143
144
145
146
147
148
149
150
151
          +implementation+ *features*)
  (format *benchmark-output*
          ";; Function                      real     user     sys       consed~%")
  (format *benchmark-output*
          ";; ----------------------------------------------------------------~%"))

(defun bench-report-footer ()
  (format *benchmark-output* "~%~s~%"
          (cons +implementation+ *benchmark-results*)))

152
153
154
;; generate a report to *benchmark-output* on the benchmark result
(defun bench-report (bench-result)
  (destructuring-bind (name real user sys consed) bench-result
Eric Marsden's avatar
Eric Marsden committed
155
    (format *benchmark-output*
156
            ";; ~25a ~8,2f ~8,2f ~8,2f ~12d"
Eric Marsden's avatar
Eric Marsden committed
157
158
            name real user sys consed)
    (terpri *benchmark-output*)
159
    (force-output *benchmark-output*)))
Eric Marsden's avatar
Eric Marsden committed
160
161
162
163

;; a generic timing function, that depends on GET-INTERNAL-RUN-TIME
;; and GET-INTERNAL-REAL-TIME returning sensible results. If a version
;; was defined in sysdep/setup-<impl>, we use that instead
164
(defun generic-bench-time (fun times)
Eric Marsden's avatar
Eric Marsden committed
165
166
167
168
169
170
171
172
  (let (before-real after-real before-user after-user)
    (setq before-user (get-internal-run-time))
    (setq before-real (get-internal-real-time))
    (dotimes (i times)
      (funcall fun))
    (setq after-user (get-internal-run-time))
    (setq after-real (get-internal-real-time))
    ;; return real user sys consed
173
174
    (values (coerce (/ (- after-real before-real) internal-time-units-per-second) 'float)
            (coerce (/ (- after-user before-user) internal-time-units-per-second) 'float)
175
            nil nil)))
Eric Marsden's avatar
Eric Marsden committed
176
177
178

(eval-when (:load-toplevel :execute)
  (unless (fboundp 'bench-time)
Daniel Kochmański's avatar
Daniel Kochmański committed
179
    (setf (fdefinition 'bench-time) #'generic-bench-time)))
Eric Marsden's avatar
Eric Marsden committed
180
181

;; EOF