Commit | Line | Data |
---|---|---|
55535639 | 1 | ;;; byte-opt.el --- the optimization passes of the emacs-lisp byte compiler |
3eac9910 | 2 | |
3731a850 | 3 | ;; Copyright (C) 1991, 1994, 2000, 2001, 2002, 2003, 2004, |
8b72699e | 4 | ;; 2005, 2006, 2007, 2008 Free Software Foundation, Inc. |
3eac9910 JB |
5 | |
6 | ;; Author: Jamie Zawinski <jwz@lucid.com> | |
7 | ;; Hallvard Furuseth <hbf@ulrik.uio.no> | |
e1f0df62 | 8 | ;; Maintainer: FSF |
3eac9910 | 9 | ;; Keywords: internal |
1c393159 JB |
10 | |
11 | ;; This file is part of GNU Emacs. | |
12 | ||
d6cba7ae | 13 | ;; GNU Emacs is free software: you can redistribute it and/or modify |
1c393159 | 14 | ;; it under the terms of the GNU General Public License as published by |
d6cba7ae GM |
15 | ;; the Free Software Foundation, either version 3 of the License, or |
16 | ;; (at your option) any later version. | |
1c393159 JB |
17 | |
18 | ;; GNU Emacs is distributed in the hope that it will be useful, | |
19 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of | |
20 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
21 | ;; GNU General Public License for more details. | |
22 | ||
23 | ;; You should have received a copy of the GNU General Public License | |
d6cba7ae | 24 | ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. |
1c393159 | 25 | |
3eac9910 JB |
26 | ;;; Commentary: |
27 | ||
b578f267 EN |
28 | ;; ======================================================================== |
29 | ;; "No matter how hard you try, you can't make a racehorse out of a pig. | |
30 | ;; You can, however, make a faster pig." | |
31 | ;; | |
40fafc21 | 32 | ;; Or, to put it another way, the Emacs byte compiler is a VW Bug. This code |
a1506d29 | 33 | ;; makes it be a VW Bug with fuel injection and a turbocharger... You're |
b578f267 EN |
34 | ;; still not going to make it go faster than 70 mph, but it might be easier |
35 | ;; to get it there. | |
36 | ;; | |
1c393159 | 37 | |
b578f267 EN |
38 | ;; TO DO: |
39 | ;; | |
72d8b544 | 40 | ;; (apply (lambda (x &rest y) ...) 1 (foo)) |
b578f267 EN |
41 | ;; |
42 | ;; maintain a list of functions known not to access any global variables | |
43 | ;; (actually, give them a 'dynamically-safe property) and then | |
44 | ;; (let ( v1 v2 ... vM vN ) <...dynamically-safe...> ) ==> | |
45 | ;; (let ( v1 v2 ... vM ) vN <...dynamically-safe...> ) | |
46 | ;; by recursing on this, we might be able to eliminate the entire let. | |
47 | ;; However certain variables should never have their bindings optimized | |
48 | ;; away, because they affect everything. | |
49 | ;; (put 'debug-on-error 'binding-is-magic t) | |
50 | ;; (put 'debug-on-abort 'binding-is-magic t) | |
51 | ;; (put 'debug-on-next-call 'binding-is-magic t) | |
b578f267 EN |
52 | ;; (put 'inhibit-quit 'binding-is-magic t) |
53 | ;; (put 'quit-flag 'binding-is-magic t) | |
54 | ;; (put 't 'binding-is-magic t) | |
55 | ;; (put 'nil 'binding-is-magic t) | |
56 | ;; possibly also | |
57 | ;; (put 'gc-cons-threshold 'binding-is-magic t) | |
58 | ;; (put 'track-mouse 'binding-is-magic t) | |
59 | ;; others? | |
60 | ;; | |
61 | ;; Simple defsubsts often produce forms like | |
62 | ;; (let ((v1 (f1)) (v2 (f2)) ...) | |
63 | ;; (FN v1 v2 ...)) | |
a1506d29 | 64 | ;; It would be nice if we could optimize this to |
b578f267 EN |
65 | ;; (FN (f1) (f2) ...) |
66 | ;; but we can't unless FN is dynamically-safe (it might be dynamically | |
67 | ;; referring to the bindings that the lambda arglist established.) | |
68 | ;; One of the uncountable lossages introduced by dynamic scope... | |
69 | ;; | |
a1506d29 | 70 | ;; Maybe there should be a control-structure that says "turn on |
b578f267 EN |
71 | ;; fast-and-loose type-assumptive optimizations here." Then when |
72 | ;; we see a form like (car foo) we can from then on assume that | |
73 | ;; the variable foo is of type cons, and optimize based on that. | |
a1506d29 | 74 | ;; But, this won't win much because of (you guessed it) dynamic |
b578f267 EN |
75 | ;; scope. Anything down the stack could change the value. |
76 | ;; (Another reason it doesn't work is that it is perfectly valid | |
77 | ;; to call car with a null argument.) A better approach might | |
78 | ;; be to allow type-specification of the form | |
79 | ;; (put 'foo 'arg-types '(float (list integer) dynamic)) | |
80 | ;; (put 'foo 'result-type 'bool) | |
81 | ;; It should be possible to have these types checked to a certain | |
82 | ;; degree. | |
83 | ;; | |
84 | ;; collapse common subexpressions | |
85 | ;; | |
86 | ;; It would be nice if redundant sequences could be factored out as well, | |
87 | ;; when they are known to have no side-effects: | |
88 | ;; (list (+ a b c) (+ a b c)) --> a b add c add dup list-2 | |
89 | ;; but beware of traps like | |
90 | ;; (cons (list x y) (list x y)) | |
91 | ;; | |
92 | ;; Tail-recursion elimination is not really possible in Emacs Lisp. | |
93 | ;; Tail-recursion elimination is almost always impossible when all variables | |
94 | ;; have dynamic scope, but given that the "return" byteop requires the | |
95 | ;; binding stack to be empty (rather than emptying it itself), there can be | |
96 | ;; no truly tail-recursive Emacs Lisp functions that take any arguments or | |
97 | ;; make any bindings. | |
98 | ;; | |
99 | ;; Here is an example of an Emacs Lisp function which could safely be | |
100 | ;; byte-compiled tail-recursively: | |
101 | ;; | |
102 | ;; (defun tail-map (fn list) | |
103 | ;; (cond (list | |
104 | ;; (funcall fn (car list)) | |
105 | ;; (tail-map fn (cdr list))))) | |
106 | ;; | |
107 | ;; However, if there was even a single let-binding around the COND, | |
108 | ;; it could not be byte-compiled, because there would be an "unbind" | |
a1506d29 | 109 | ;; byte-op between the final "call" and "return." Adding a |
b578f267 EN |
110 | ;; Bunbind_all byteop would fix this. |
111 | ;; | |
112 | ;; (defun foo (x y z) ... (foo a b c)) | |
113 | ;; ... (const foo) (varref a) (varref b) (varref c) (call 3) END: (return) | |
114 | ;; ... (varref a) (varbind x) (varref b) (varbind y) (varref c) (varbind z) (goto 0) END: (unbind-all) (return) | |
115 | ;; ... (varref a) (varset x) (varref b) (varset y) (varref c) (varset z) (goto 0) END: (return) | |
116 | ;; | |
117 | ;; this also can be considered tail recursion: | |
118 | ;; | |
119 | ;; ... (const foo) (varref a) (call 1) (goto X) ... X: (return) | |
120 | ;; could generalize this by doing the optimization | |
121 | ;; (goto X) ... X: (return) --> (return) | |
122 | ;; | |
123 | ;; But this doesn't solve all of the problems: although by doing tail- | |
124 | ;; recursion elimination in this way, the call-stack does not grow, the | |
125 | ;; binding-stack would grow with each recursive step, and would eventually | |
126 | ;; overflow. I don't believe there is any way around this without lexical | |
127 | ;; scope. | |
128 | ;; | |
129 | ;; Wouldn't it be nice if Emacs Lisp had lexical scope. | |
130 | ;; | |
a1506d29 JB |
131 | ;; Idea: the form (lexical-scope) in a file means that the file may be |
132 | ;; compiled lexically. This proclamation is file-local. Then, within | |
b578f267 EN |
133 | ;; that file, "let" would establish lexical bindings, and "let-dynamic" |
134 | ;; would do things the old way. (Or we could use CL "declare" forms.) | |
135 | ;; We'd have to notice defvars and defconsts, since those variables should | |
136 | ;; always be dynamic, and attempting to do a lexical binding of them | |
137 | ;; should simply do a dynamic binding instead. | |
138 | ;; But! We need to know about variables that were not necessarily defvarred | |
139 | ;; in the file being compiled (doing a boundp check isn't good enough.) | |
140 | ;; Fdefvar() would have to be modified to add something to the plist. | |
141 | ;; | |
a1506d29 JB |
142 | ;; A major disadvantage of this scheme is that the interpreter and compiler |
143 | ;; would have different semantics for files compiled with (dynamic-scope). | |
b578f267 | 144 | ;; Since this would be a file-local optimization, there would be no way to |
a1506d29 | 145 | ;; modify the interpreter to obey this (unless the loader was hacked |
b578f267 | 146 | ;; in some grody way, but that's a really bad idea.) |
97e6527f KH |
147 | |
148 | ;; Other things to consider: | |
149 | ||
6b61353c KH |
150 | ;; ;; Associative math should recognize subcalls to identical function: |
151 | ;; (disassemble (lambda (x) (+ (+ (foo) 1) (+ (bar) 2)))) | |
152 | ;; ;; This should generate the same as (1+ x) and (1- x) | |
c1fe6512 | 153 | |
6b61353c KH |
154 | ;; (disassemble (lambda (x) (cons (+ x 1) (- x 1)))) |
155 | ;; ;; An awful lot of functions always return a non-nil value. If they're | |
156 | ;; ;; error free also they may act as true-constants. | |
c1fe6512 | 157 | |
6b61353c KH |
158 | ;; (disassemble (lambda (x) (and (point) (foo)))) |
159 | ;; ;; When | |
160 | ;; ;; - all but one arguments to a function are constant | |
161 | ;; ;; - the non-constant argument is an if-expression (cond-expression?) | |
162 | ;; ;; then the outer function can be distributed. If the guarding | |
163 | ;; ;; condition is side-effect-free [assignment-free] then the other | |
164 | ;; ;; arguments may be any expressions. Since, however, the code size | |
165 | ;; ;; can increase this way they should be "simple". Compare: | |
c1fe6512 | 166 | |
6b61353c KH |
167 | ;; (disassemble (lambda (x) (eq (if (point) 'a 'b) 'c))) |
168 | ;; (disassemble (lambda (x) (if (point) (eq 'a 'c) (eq 'b 'c)))) | |
c1fe6512 | 169 | |
6b61353c KH |
170 | ;; ;; (car (cons A B)) -> (prog1 A B) |
171 | ;; (disassemble (lambda (x) (car (cons (foo) 42)))) | |
c1fe6512 | 172 | |
6b61353c KH |
173 | ;; ;; (cdr (cons A B)) -> (progn A B) |
174 | ;; (disassemble (lambda (x) (cdr (cons 42 (foo))))) | |
c1fe6512 | 175 | |
6b61353c KH |
176 | ;; ;; (car (list A B ...)) -> (prog1 A B ...) |
177 | ;; (disassemble (lambda (x) (car (list (foo) 42 (bar))))) | |
c1fe6512 | 178 | |
6b61353c KH |
179 | ;; ;; (cdr (list A B ...)) -> (progn A (list B ...)) |
180 | ;; (disassemble (lambda (x) (cdr (list 42 (foo) (bar))))) | |
97e6527f | 181 | |
1c393159 | 182 | |
3eac9910 | 183 | ;;; Code: |
1c393159 | 184 | |
c144230d | 185 | (require 'bytecomp) |
d8947b79 | 186 | (eval-when-compile (require 'cl)) |
c144230d | 187 | |
1c393159 JB |
188 | (defun byte-compile-log-lap-1 (format &rest args) |
189 | (if (aref byte-code-vector 0) | |
55535639 | 190 | (error "The old version of the disassembler is loaded. Reload new-bytecomp as well")) |
1c393159 JB |
191 | (byte-compile-log-1 |
192 | (apply 'format format | |
193 | (let (c a) | |
72d8b544 | 194 | (mapcar (lambda (arg) |
1c393159 JB |
195 | (if (not (consp arg)) |
196 | (if (and (symbolp arg) | |
197 | (string-match "^byte-" (symbol-name arg))) | |
198 | (intern (substring (symbol-name arg) 5)) | |
199 | arg) | |
200 | (if (integerp (setq c (car arg))) | |
201 | (error "non-symbolic byte-op %s" c)) | |
202 | (if (eq c 'TAG) | |
203 | (setq c arg) | |
204 | (setq a (cond ((memq c byte-goto-ops) | |
205 | (car (cdr (cdr arg)))) | |
206 | ((memq c byte-constref-ops) | |
207 | (car (cdr arg))) | |
208 | (t (cdr arg)))) | |
209 | (setq c (symbol-name c)) | |
210 | (if (string-match "^byte-." c) | |
211 | (setq c (intern (substring c 5))))) | |
212 | (if (eq c 'constant) (setq c 'const)) | |
213 | (if (and (eq (cdr arg) 0) | |
214 | (not (memq c '(unbind call const)))) | |
215 | c | |
216 | (format "(%s %s)" c a)))) | |
217 | args))))) | |
218 | ||
219 | (defmacro byte-compile-log-lap (format-string &rest args) | |
6b61353c KH |
220 | `(and (memq byte-optimize-log '(t byte)) |
221 | (byte-compile-log-lap-1 ,format-string ,@args))) | |
1c393159 JB |
222 | |
223 | \f | |
224 | ;;; byte-compile optimizers to support inlining | |
225 | ||
226 | (put 'inline 'byte-optimizer 'byte-optimize-inline-handler) | |
227 | ||
228 | (defun byte-optimize-inline-handler (form) | |
229 | "byte-optimize-handler for the `inline' special-form." | |
230 | (cons 'progn | |
231 | (mapcar | |
72d8b544 | 232 | (lambda (sexp) |
08d72d13 SM |
233 | (let ((f (car-safe sexp))) |
234 | (if (and (symbolp f) | |
235 | (or (cdr (assq f byte-compile-function-environment)) | |
236 | (not (or (not (fboundp f)) | |
237 | (cdr (assq f byte-compile-macro-environment)) | |
238 | (and (consp (setq f (symbol-function f))) | |
239 | (eq (car f) 'macro)) | |
240 | (subrp f))))) | |
241 | (byte-compile-inline-expand sexp) | |
242 | sexp))) | |
1c393159 JB |
243 | (cdr form)))) |
244 | ||
245 | ||
70e1dad8 RS |
246 | ;; Splice the given lap code into the current instruction stream. |
247 | ;; If it has any labels in it, you're responsible for making sure there | |
248 | ;; are no collisions, and that byte-compile-tag-number is reasonable | |
249 | ;; after this is spliced in. The provided list is destroyed. | |
1c393159 | 250 | (defun byte-inline-lapcode (lap) |
1c393159 JB |
251 | (setq byte-compile-output (nconc (nreverse lap) byte-compile-output))) |
252 | ||
1c393159 JB |
253 | (defun byte-compile-inline-expand (form) |
254 | (let* ((name (car form)) | |
255 | (fn (or (cdr (assq name byte-compile-function-environment)) | |
256 | (and (fboundp name) (symbol-function name))))) | |
257 | (if (null fn) | |
258 | (progn | |
244bbdc5 | 259 | (byte-compile-warn "attempt to inline `%s' before it was defined" |
c59a4192 | 260 | name) |
1c393159 JB |
261 | form) |
262 | ;; else | |
78ecf55a | 263 | (when (and (consp fn) (eq (car fn) 'autoload)) |
28881a56 | 264 | (load (nth 1 fn)) |
78ecf55a GM |
265 | (setq fn (or (and (fboundp name) (symbol-function name)) |
266 | (cdr (assq name byte-compile-function-environment))))) | |
1c393159 | 267 | (if (and (consp fn) (eq (car fn) 'autoload)) |
0abfa90d | 268 | (error "File `%s' didn't define `%s'" (nth 1 fn) name)) |
f61b7b7f | 269 | (if (and (symbolp fn) (not (eq fn t))) |
1c393159 | 270 | (byte-compile-inline-expand (cons fn (cdr form))) |
96d699f3 | 271 | (if (byte-code-function-p fn) |
70b40ea1 | 272 | (let (string) |
2b29a376 | 273 | (fetch-bytecode fn) |
70b40ea1 | 274 | (setq string (aref fn 1)) |
6b61353c | 275 | ;; Isn't it an error for `string' not to be unibyte?? --stef |
70b40ea1 RS |
276 | (if (fboundp 'string-as-unibyte) |
277 | (setq string (string-as-unibyte string))) | |
b1dfec55 RS |
278 | ;; `byte-compile-splice-in-already-compiled-code' |
279 | ;; takes care of inlining the body. | |
6b61353c KH |
280 | (cons `(lambda ,(aref fn 0) |
281 | (byte-code ,string ,(aref fn 2) ,(aref fn 3))) | |
2b29a376 | 282 | (cdr form))) |
223a2a62 KH |
283 | (if (eq (car-safe fn) 'lambda) |
284 | (cons fn (cdr form)) | |
285 | ;; Give up on inlining. | |
286 | form)))))) | |
1c393159 | 287 | |
6b61353c | 288 | ;; ((lambda ...) ...) |
1c393159 JB |
289 | (defun byte-compile-unfold-lambda (form &optional name) |
290 | (or name (setq name "anonymous lambda")) | |
291 | (let ((lambda (car form)) | |
292 | (values (cdr form))) | |
96d699f3 | 293 | (if (byte-code-function-p lambda) |
7e1dae73 JB |
294 | (setq lambda (list 'lambda (aref lambda 0) |
295 | (list 'byte-code (aref lambda 1) | |
296 | (aref lambda 2) (aref lambda 3))))) | |
1c393159 JB |
297 | (let ((arglist (nth 1 lambda)) |
298 | (body (cdr (cdr lambda))) | |
299 | optionalp restp | |
300 | bindings) | |
301 | (if (and (stringp (car body)) (cdr body)) | |
302 | (setq body (cdr body))) | |
303 | (if (and (consp (car body)) (eq 'interactive (car (car body)))) | |
304 | (setq body (cdr body))) | |
305 | (while arglist | |
306 | (cond ((eq (car arglist) '&optional) | |
307 | ;; ok, I'll let this slide because funcall_lambda() does... | |
308 | ;; (if optionalp (error "multiple &optional keywords in %s" name)) | |
309 | (if restp (error "&optional found after &rest in %s" name)) | |
310 | (if (null (cdr arglist)) | |
311 | (error "nothing after &optional in %s" name)) | |
312 | (setq optionalp t)) | |
313 | ((eq (car arglist) '&rest) | |
314 | ;; ...but it is by no stretch of the imagination a reasonable | |
315 | ;; thing that funcall_lambda() allows (&rest x y) and | |
316 | ;; (&rest x &optional y) in arglists. | |
317 | (if (null (cdr arglist)) | |
318 | (error "nothing after &rest in %s" name)) | |
319 | (if (cdr (cdr arglist)) | |
320 | (error "multiple vars after &rest in %s" name)) | |
321 | (setq restp t)) | |
322 | (restp | |
323 | (setq bindings (cons (list (car arglist) | |
324 | (and values (cons 'list values))) | |
325 | bindings) | |
326 | values nil)) | |
327 | ((and (not optionalp) (null values)) | |
244bbdc5 | 328 | (byte-compile-warn "attempt to open-code `%s' with too few arguments" name) |
1c393159 JB |
329 | (setq arglist nil values 'too-few)) |
330 | (t | |
331 | (setq bindings (cons (list (car arglist) (car values)) | |
332 | bindings) | |
333 | values (cdr values)))) | |
334 | (setq arglist (cdr arglist))) | |
335 | (if values | |
336 | (progn | |
337 | (or (eq values 'too-few) | |
338 | (byte-compile-warn | |
244bbdc5 | 339 | "attempt to open-code `%s' with too many arguments" name)) |
1c393159 | 340 | form) |
a1506d29 | 341 | |
936ae731 GM |
342 | ;; The following leads to infinite recursion when loading a |
343 | ;; file containing `(defsubst f () (f))', and then trying to | |
344 | ;; byte-compile that file. | |
345 | ;(setq body (mapcar 'byte-optimize-form body))) | |
a1506d29 JB |
346 | |
347 | (let ((newform | |
1c393159 JB |
348 | (if bindings |
349 | (cons 'let (cons (nreverse bindings) body)) | |
350 | (cons 'progn body)))) | |
351 | (byte-compile-log " %s\t==>\t%s" form newform) | |
352 | newform))))) | |
353 | ||
354 | \f | |
355 | ;;; implementing source-level optimizers | |
356 | ||
357 | (defun byte-optimize-form-code-walker (form for-effect) | |
358 | ;; | |
359 | ;; For normal function calls, We can just mapcar the optimizer the cdr. But | |
360 | ;; we need to have special knowledge of the syntax of the special forms | |
361 | ;; like let and defun (that's why they're special forms :-). (Actually, | |
362 | ;; the important aspect is that they are subrs that don't evaluate all of | |
363 | ;; their args.) | |
364 | ;; | |
365 | (let ((fn (car-safe form)) | |
366 | tmp) | |
367 | (cond ((not (consp form)) | |
368 | (if (not (and for-effect | |
369 | (or byte-compile-delete-errors | |
370 | (not (symbolp form)) | |
371 | (eq form t)))) | |
372 | form)) | |
373 | ((eq fn 'quote) | |
374 | (if (cdr (cdr form)) | |
244bbdc5 | 375 | (byte-compile-warn "malformed quote form: `%s'" |
1c393159 JB |
376 | (prin1-to-string form))) |
377 | ;; map (quote nil) to nil to simplify optimizer logic. | |
378 | ;; map quoted constants to nil if for-effect (just because). | |
379 | (and (nth 1 form) | |
380 | (not for-effect) | |
381 | form)) | |
96d699f3 | 382 | ((or (byte-code-function-p fn) |
1c393159 | 383 | (eq 'lambda (car-safe fn))) |
42521cd4 SM |
384 | (byte-optimize-form-code-walker |
385 | (byte-compile-unfold-lambda form) | |
386 | for-effect)) | |
1c393159 JB |
387 | ((memq fn '(let let*)) |
388 | ;; recursively enter the optimizer for the bindings and body | |
389 | ;; of a let or let*. This for depth-firstness: forms that | |
390 | ;; are more deeply nested are optimized first. | |
391 | (cons fn | |
392 | (cons | |
72d8b544 | 393 | (mapcar (lambda (binding) |
1c393159 JB |
394 | (if (symbolp binding) |
395 | binding | |
396 | (if (cdr (cdr binding)) | |
244bbdc5 | 397 | (byte-compile-warn "malformed let binding: `%s'" |
1c393159 JB |
398 | (prin1-to-string binding))) |
399 | (list (car binding) | |
400 | (byte-optimize-form (nth 1 binding) nil)))) | |
401 | (nth 1 form)) | |
402 | (byte-optimize-body (cdr (cdr form)) for-effect)))) | |
403 | ((eq fn 'cond) | |
404 | (cons fn | |
72d8b544 | 405 | (mapcar (lambda (clause) |
1c393159 JB |
406 | (if (consp clause) |
407 | (cons | |
408 | (byte-optimize-form (car clause) nil) | |
409 | (byte-optimize-body (cdr clause) for-effect)) | |
244bbdc5 | 410 | (byte-compile-warn "malformed cond form: `%s'" |
1c393159 JB |
411 | (prin1-to-string clause)) |
412 | clause)) | |
413 | (cdr form)))) | |
414 | ((eq fn 'progn) | |
415 | ;; as an extra added bonus, this simplifies (progn <x>) --> <x> | |
416 | (if (cdr (cdr form)) | |
417 | (progn | |
418 | (setq tmp (byte-optimize-body (cdr form) for-effect)) | |
419 | (if (cdr tmp) (cons 'progn tmp) (car tmp))) | |
420 | (byte-optimize-form (nth 1 form) for-effect))) | |
421 | ((eq fn 'prog1) | |
422 | (if (cdr (cdr form)) | |
423 | (cons 'prog1 | |
424 | (cons (byte-optimize-form (nth 1 form) for-effect) | |
425 | (byte-optimize-body (cdr (cdr form)) t))) | |
426 | (byte-optimize-form (nth 1 form) for-effect))) | |
427 | ((eq fn 'prog2) | |
428 | (cons 'prog2 | |
429 | (cons (byte-optimize-form (nth 1 form) t) | |
430 | (cons (byte-optimize-form (nth 2 form) for-effect) | |
431 | (byte-optimize-body (cdr (cdr (cdr form))) t))))) | |
a1506d29 | 432 | |
2754fefa | 433 | ((memq fn '(save-excursion save-restriction save-current-buffer)) |
1c393159 JB |
434 | ;; those subrs which have an implicit progn; it's not quite good |
435 | ;; enough to treat these like normal function calls. | |
436 | ;; This can turn (save-excursion ...) into (save-excursion) which | |
437 | ;; will be optimized away in the lap-optimize pass. | |
438 | (cons fn (byte-optimize-body (cdr form) for-effect))) | |
a1506d29 | 439 | |
1c393159 JB |
440 | ((eq fn 'with-output-to-temp-buffer) |
441 | ;; this is just like the above, except for the first argument. | |
442 | (cons fn | |
443 | (cons | |
444 | (byte-optimize-form (nth 1 form) nil) | |
445 | (byte-optimize-body (cdr (cdr form)) for-effect)))) | |
a1506d29 | 446 | |
1c393159 | 447 | ((eq fn 'if) |
aefd695a | 448 | (when (< (length form) 3) |
244bbdc5 | 449 | (byte-compile-warn "too few arguments for `if'")) |
1c393159 JB |
450 | (cons fn |
451 | (cons (byte-optimize-form (nth 1 form) nil) | |
452 | (cons | |
453 | (byte-optimize-form (nth 2 form) for-effect) | |
454 | (byte-optimize-body (nthcdr 3 form) for-effect))))) | |
a1506d29 | 455 | |
1c393159 JB |
456 | ((memq fn '(and or)) ; remember, and/or are control structures. |
457 | ;; take forms off the back until we can't any more. | |
eb8c3be9 | 458 | ;; In the future it could conceivably be a problem that the |
1c393159 JB |
459 | ;; subexpressions of these forms are optimized in the reverse |
460 | ;; order, but it's ok for now. | |
461 | (if for-effect | |
462 | (let ((backwards (reverse (cdr form)))) | |
463 | (while (and backwards | |
464 | (null (setcar backwards | |
465 | (byte-optimize-form (car backwards) | |
466 | for-effect)))) | |
467 | (setq backwards (cdr backwards))) | |
468 | (if (and (cdr form) (null backwards)) | |
469 | (byte-compile-log | |
470 | " all subforms of %s called for effect; deleted" form)) | |
471 | (and backwards | |
e8f3c355 | 472 | (cons fn (nreverse (mapcar 'byte-optimize-form backwards))))) |
1c393159 JB |
473 | (cons fn (mapcar 'byte-optimize-form (cdr form))))) |
474 | ||
475 | ((eq fn 'interactive) | |
244bbdc5 | 476 | (byte-compile-warn "misplaced interactive spec: `%s'" |
1c393159 JB |
477 | (prin1-to-string form)) |
478 | nil) | |
a1506d29 | 479 | |
1c393159 JB |
480 | ((memq fn '(defun defmacro function |
481 | condition-case save-window-excursion)) | |
482 | ;; These forms are compiled as constants or by breaking out | |
483 | ;; all the subexpressions and compiling them separately. | |
484 | form) | |
485 | ||
486 | ((eq fn 'unwind-protect) | |
487 | ;; the "protected" part of an unwind-protect is compiled (and thus | |
488 | ;; optimized) as a top-level form, so don't do it here. But the | |
489 | ;; non-protected part has the same for-effect status as the | |
490 | ;; unwind-protect itself. (The protected part is always for effect, | |
491 | ;; but that isn't handled properly yet.) | |
492 | (cons fn | |
493 | (cons (byte-optimize-form (nth 1 form) for-effect) | |
494 | (cdr (cdr form))))) | |
a1506d29 | 495 | |
1c393159 JB |
496 | ((eq fn 'catch) |
497 | ;; the body of a catch is compiled (and thus optimized) as a | |
498 | ;; top-level form, so don't do it here. The tag is never | |
499 | ;; for-effect. The body should have the same for-effect status | |
500 | ;; as the catch form itself, but that isn't handled properly yet. | |
501 | (cons fn | |
502 | (cons (byte-optimize-form (nth 1 form) nil) | |
503 | (cdr (cdr form))))) | |
504 | ||
8c26d7b3 RS |
505 | ((eq fn 'ignore) |
506 | ;; Don't treat the args to `ignore' as being | |
507 | ;; computed for effect. We want to avoid the warnings | |
508 | ;; that might occur if they were treated that way. | |
509 | ;; However, don't actually bother calling `ignore'. | |
510 | `(prog1 nil . ,(mapcar 'byte-optimize-form (cdr form)))) | |
511 | ||
1c393159 JB |
512 | ;; If optimization is on, this is the only place that macros are |
513 | ;; expanded. If optimization is off, then macroexpansion happens | |
514 | ;; in byte-compile-form. Otherwise, the macros are already expanded | |
515 | ;; by the time that is reached. | |
516 | ((not (eq form | |
517 | (setq form (macroexpand form | |
518 | byte-compile-macro-environment)))) | |
519 | (byte-optimize-form form for-effect)) | |
5428ee02 RS |
520 | |
521 | ;; Support compiler macros as in cl.el. | |
522 | ((and (fboundp 'compiler-macroexpand) | |
4f493b7c RS |
523 | (symbolp (car-safe form)) |
524 | (get (car-safe form) 'cl-compiler-macro) | |
5428ee02 | 525 | (not (eq form |
4cead7a2 RS |
526 | (with-no-warnings |
527 | (setq form (compiler-macroexpand form)))))) | |
5428ee02 | 528 | (byte-optimize-form form for-effect)) |
a1506d29 | 529 | |
1c393159 | 530 | ((not (symbolp fn)) |
5f11d42c PJ |
531 | (byte-compile-warn "`%s' is a malformed function" |
532 | (prin1-to-string fn)) | |
1c393159 JB |
533 | form) |
534 | ||
535 | ((and for-effect (setq tmp (get fn 'side-effect-free)) | |
536 | (or byte-compile-delete-errors | |
537 | (eq tmp 'error-free) | |
8c26d7b3 RS |
538 | ;; Detect the expansion of (pop foo). |
539 | ;; There is no need to compile the call to `car' there. | |
540 | (and (eq fn 'car) | |
541 | (eq (car-safe (cadr form)) 'prog1) | |
542 | (let ((var (cadr (cadr form))) | |
543 | (last (nth 2 (cadr form)))) | |
544 | (and (symbolp var) | |
545 | (null (nthcdr 3 (cadr form))) | |
546 | (eq (car-safe last) 'setq) | |
547 | (eq (cadr last) var) | |
548 | (eq (car-safe (nth 2 last)) 'cdr) | |
549 | (eq (cadr (nth 2 last)) var)))) | |
1c393159 | 550 | (progn |
1fbb84da CY |
551 | (byte-compile-warn "value returned from %s is unused" |
552 | (prin1-to-string form)) | |
1c393159 JB |
553 | nil))) |
554 | (byte-compile-log " %s called for effect; deleted" fn) | |
555 | ;; appending a nil here might not be necessary, but it can't hurt. | |
556 | (byte-optimize-form | |
557 | (cons 'progn (append (cdr form) '(nil))) t)) | |
a1506d29 | 558 | |
1c393159 JB |
559 | (t |
560 | ;; Otherwise, no args can be considered to be for-effect, | |
561 | ;; even if the called function is for-effect, because we | |
562 | ;; don't know anything about that function. | |
fb67ebdf CY |
563 | (let ((args (mapcar #'byte-optimize-form (cdr form)))) |
564 | (if (and (get fn 'pure) | |
565 | (byte-optimize-all-constp args)) | |
566 | (list 'quote (apply fn (mapcar #'eval args))) | |
567 | (cons fn args))))))) | |
568 | ||
569 | (defun byte-optimize-all-constp (list) | |
ab2d877d | 570 | "Non-nil if all elements of LIST satisfy `byte-compile-constp'." |
fb67ebdf CY |
571 | (let ((constant t)) |
572 | (while (and list constant) | |
573 | (unless (byte-compile-constp (car list)) | |
574 | (setq constant nil)) | |
575 | (setq list (cdr list))) | |
576 | constant)) | |
1c393159 JB |
577 | |
578 | (defun byte-optimize-form (form &optional for-effect) | |
579 | "The source-level pass of the optimizer." | |
580 | ;; | |
581 | ;; First, optimize all sub-forms of this one. | |
582 | (setq form (byte-optimize-form-code-walker form for-effect)) | |
583 | ;; | |
584 | ;; after optimizing all subforms, optimize this form until it doesn't | |
585 | ;; optimize any further. This means that some forms will be passed through | |
586 | ;; the optimizer many times, but that's necessary to make the for-effect | |
587 | ;; processing do as much as possible. | |
588 | ;; | |
589 | (let (opt new) | |
590 | (if (and (consp form) | |
591 | (symbolp (car form)) | |
592 | (or (and for-effect | |
593 | ;; we don't have any of these yet, but we might. | |
594 | (setq opt (get (car form) 'byte-for-effect-optimizer))) | |
595 | (setq opt (get (car form) 'byte-optimizer))) | |
596 | (not (eq form (setq new (funcall opt form))))) | |
597 | (progn | |
598 | ;; (if (equal form new) (error "bogus optimizer -- %s" opt)) | |
599 | (byte-compile-log " %s\t==>\t%s" form new) | |
600 | (setq new (byte-optimize-form new for-effect)) | |
601 | new) | |
602 | form))) | |
603 | ||
604 | ||
605 | (defun byte-optimize-body (forms all-for-effect) | |
606 | ;; optimize the cdr of a progn or implicit progn; all forms is a list of | |
607 | ;; forms, all but the last of which are optimized with the assumption that | |
608 | ;; they are being called for effect. the last is for-effect as well if | |
609 | ;; all-for-effect is true. returns a new list of forms. | |
610 | (let ((rest forms) | |
611 | (result nil) | |
612 | fe new) | |
613 | (while rest | |
614 | (setq fe (or all-for-effect (cdr rest))) | |
615 | (setq new (and (car rest) (byte-optimize-form (car rest) fe))) | |
616 | (if (or new (not fe)) | |
617 | (setq result (cons new result))) | |
618 | (setq rest (cdr rest))) | |
619 | (nreverse result))) | |
620 | ||
621 | \f | |
6b61353c KH |
622 | ;; some source-level optimizers |
623 | ;; | |
624 | ;; when writing optimizers, be VERY careful that the optimizer returns | |
625 | ;; something not EQ to its argument if and ONLY if it has made a change. | |
626 | ;; This implies that you cannot simply destructively modify the list; | |
627 | ;; you must return something not EQ to it if you make an optimization. | |
628 | ;; | |
629 | ;; It is now safe to optimize code such that it introduces new bindings. | |
1c393159 | 630 | |
d8947b79 DN |
631 | (defsubst byte-compile-trueconstp (form) |
632 | "Return non-nil if FORM always evaluates to a non-nil value." | |
20ce031c SM |
633 | (while (eq (car-safe form) 'progn) |
634 | (setq form (car (last (cdr form))))) | |
d8947b79 DN |
635 | (cond ((consp form) |
636 | (case (car form) | |
637 | (quote (cadr form)) | |
20ce031c SM |
638 | ;; Can't use recursion in a defsubst. |
639 | ;; (progn (byte-compile-trueconstp (car (last (cdr form))))) | |
640 | )) | |
d8947b79 DN |
641 | ((not (symbolp form))) |
642 | ((eq form t)) | |
643 | ((keywordp form)))) | |
644 | ||
645 | (defsubst byte-compile-nilconstp (form) | |
646 | "Return non-nil if FORM always evaluates to a nil value." | |
20ce031c SM |
647 | (while (eq (car-safe form) 'progn) |
648 | (setq form (car (last (cdr form))))) | |
d8947b79 DN |
649 | (cond ((consp form) |
650 | (case (car form) | |
651 | (quote (null (cadr form))) | |
20ce031c SM |
652 | ;; Can't use recursion in a defsubst. |
653 | ;; (progn (byte-compile-nilconstp (car (last (cdr form))))) | |
654 | )) | |
d8947b79 DN |
655 | ((not (symbolp form)) nil) |
656 | ((null form)))) | |
1c393159 | 657 | |
70e1dad8 | 658 | ;; If the function is being called with constant numeric args, |
a1506d29 | 659 | ;; evaluate as much as possible at compile-time. This optimizer |
70e1dad8 | 660 | ;; assumes that the function is associative, like + or *. |
1c393159 | 661 | (defun byte-optimize-associative-math (form) |
1c393159 JB |
662 | (let ((args nil) |
663 | (constants nil) | |
664 | (rest (cdr form))) | |
665 | (while rest | |
666 | (if (numberp (car rest)) | |
667 | (setq constants (cons (car rest) constants)) | |
668 | (setq args (cons (car rest) args))) | |
669 | (setq rest (cdr rest))) | |
670 | (if (cdr constants) | |
671 | (if args | |
672 | (list (car form) | |
673 | (apply (car form) constants) | |
674 | (if (cdr args) | |
675 | (cons (car form) (nreverse args)) | |
676 | (car args))) | |
677 | (apply (car form) constants)) | |
678 | form))) | |
679 | ||
70e1dad8 | 680 | ;; If the function is being called with constant numeric args, |
97e6527f KH |
681 | ;; evaluate as much as possible at compile-time. This optimizer |
682 | ;; assumes that the function satisfies | |
683 | ;; (op x1 x2 ... xn) == (op ...(op (op x1 x2) x3) ...xn) | |
684 | ;; like - and /. | |
1c393159 | 685 | (defun byte-optimize-nonassociative-math (form) |
1c393159 JB |
686 | (if (or (not (numberp (car (cdr form)))) |
687 | (not (numberp (car (cdr (cdr form)))))) | |
688 | form | |
689 | (let ((constant (car (cdr form))) | |
690 | (rest (cdr (cdr form)))) | |
691 | (while (numberp (car rest)) | |
692 | (setq constant (funcall (car form) constant (car rest)) | |
693 | rest (cdr rest))) | |
694 | (if rest | |
695 | (cons (car form) (cons constant rest)) | |
696 | constant)))) | |
697 | ||
698 | ;;(defun byte-optimize-associative-two-args-math (form) | |
699 | ;; (setq form (byte-optimize-associative-math form)) | |
700 | ;; (if (consp form) | |
701 | ;; (byte-optimize-two-args-left form) | |
702 | ;; form)) | |
703 | ||
704 | ;;(defun byte-optimize-nonassociative-two-args-math (form) | |
705 | ;; (setq form (byte-optimize-nonassociative-math form)) | |
706 | ;; (if (consp form) | |
707 | ;; (byte-optimize-two-args-right form) | |
708 | ;; form)) | |
709 | ||
97e6527f | 710 | (defun byte-optimize-approx-equal (x y) |
1fa68f21 | 711 | (<= (* (abs (- x y)) 100) (abs (+ x y)))) |
97e6527f KH |
712 | |
713 | ;; Collect all the constants from FORM, after the STARTth arg, | |
714 | ;; and apply FUN to them to make one argument at the end. | |
715 | ;; For functions that can handle floats, that optimization | |
716 | ;; can be incorrect because reordering can cause an overflow | |
717 | ;; that would otherwise be avoided by encountering an arg that is a float. | |
718 | ;; We avoid this problem by (1) not moving float constants and | |
719 | ;; (2) not moving anything if it would cause an overflow. | |
1c393159 JB |
720 | (defun byte-optimize-delay-constants-math (form start fun) |
721 | ;; Merge all FORM's constants from number START, call FUN on them | |
722 | ;; and put the result at the end. | |
97e6527f KH |
723 | (let ((rest (nthcdr (1- start) form)) |
724 | (orig form) | |
725 | ;; t means we must check for overflow. | |
726 | (overflow (memq fun '(+ *)))) | |
1c393159 | 727 | (while (cdr (setq rest (cdr rest))) |
97e6527f | 728 | (if (integerp (car rest)) |
1c393159 JB |
729 | (let (constants) |
730 | (setq form (copy-sequence form) | |
731 | rest (nthcdr (1- start) form)) | |
732 | (while (setq rest (cdr rest)) | |
97e6527f | 733 | (cond ((integerp (car rest)) |
1c393159 JB |
734 | (setq constants (cons (car rest) constants)) |
735 | (setcar rest nil)))) | |
97e6527f KH |
736 | ;; If necessary, check now for overflow |
737 | ;; that might be caused by reordering. | |
738 | (if (and overflow | |
739 | ;; We have overflow if the result of doing the arithmetic | |
740 | ;; on floats is not even close to the result | |
741 | ;; of doing it on integers. | |
742 | (not (byte-optimize-approx-equal | |
743 | (apply fun (mapcar 'float constants)) | |
744 | (float (apply fun constants))))) | |
745 | (setq form orig) | |
746 | (setq form (nconc (delq nil form) | |
747 | (list (apply fun (nreverse constants))))))))) | |
1c393159 JB |
748 | form)) |
749 | ||
750 | (defun byte-optimize-plus (form) | |
751 | (setq form (byte-optimize-delay-constants-math form 1 '+)) | |
752 | (if (memq 0 form) (setq form (delq 0 (copy-sequence form)))) | |
753 | ;;(setq form (byte-optimize-associative-two-args-math form)) | |
754 | (cond ((null (cdr form)) | |
755 | (condition-case () | |
756 | (eval form) | |
757 | (error form))) | |
6b61353c KH |
758 | ;;; It is not safe to delete the function entirely |
759 | ;;; (actually, it would be safe if we know the sole arg | |
760 | ;;; is not a marker). | |
761 | ;;; ((null (cdr (cdr form))) (nth 1 form)) | |
ea9d6371 RS |
762 | ((null (cddr form)) |
763 | (if (numberp (nth 1 form)) | |
764 | (nth 1 form) | |
765 | form)) | |
1fa68f21 RS |
766 | ((and (null (nthcdr 3 form)) |
767 | (or (memq (nth 1 form) '(1 -1)) | |
768 | (memq (nth 2 form) '(1 -1)))) | |
79d137ff | 769 | ;; Optimize (+ x 1) into (1+ x) and (+ x -1) into (1- x). |
1fa68f21 RS |
770 | (let ((integer |
771 | (if (memq (nth 1 form) '(1 -1)) | |
772 | (nth 1 form) | |
773 | (nth 2 form))) | |
774 | (other | |
775 | (if (memq (nth 1 form) '(1 -1)) | |
776 | (nth 2 form) | |
777 | (nth 1 form)))) | |
778 | (list (if (eq integer 1) '1+ '1-) | |
779 | other))) | |
1c393159 JB |
780 | (t form))) |
781 | ||
782 | (defun byte-optimize-minus (form) | |
783 | ;; Put constants at the end, except the last constant. | |
784 | (setq form (byte-optimize-delay-constants-math form 2 '+)) | |
785 | ;; Now only first and last element can be a number. | |
786 | (let ((last (car (reverse (nthcdr 3 form))))) | |
787 | (cond ((eq 0 last) | |
788 | ;; (- x y ... 0) --> (- x y ...) | |
789 | (setq form (copy-sequence form)) | |
790 | (setcdr (cdr (cdr form)) (delq 0 (nthcdr 3 form)))) | |
1fa68f21 RS |
791 | ((equal (nthcdr 2 form) '(1)) |
792 | (setq form (list '1- (nth 1 form)))) | |
793 | ((equal (nthcdr 2 form) '(-1)) | |
794 | (setq form (list '1+ (nth 1 form)))) | |
1c393159 JB |
795 | ;; If form is (- CONST foo... CONST), merge first and last. |
796 | ((and (numberp (nth 1 form)) | |
797 | (numberp last)) | |
798 | (setq form (nconc (list '- (- (nth 1 form) last) (nth 2 form)) | |
799 | (delq last (copy-sequence (nthcdr 3 form)))))))) | |
6b61353c KH |
800 | ;;; It is not safe to delete the function entirely |
801 | ;;; (actually, it would be safe if we know the sole arg | |
802 | ;;; is not a marker). | |
3315a6a3 RS |
803 | ;;; (if (eq (nth 2 form) 0) |
804 | ;;; (nth 1 form) ; (- x 0) --> x | |
1c393159 JB |
805 | (byte-optimize-predicate |
806 | (if (and (null (cdr (cdr (cdr form)))) | |
807 | (eq (nth 1 form) 0)) ; (- 0 x) --> (- x) | |
808 | (cons (car form) (cdr (cdr form))) | |
3315a6a3 RS |
809 | form)) |
810 | ;;; ) | |
811 | ) | |
1c393159 JB |
812 | |
813 | (defun byte-optimize-multiply (form) | |
814 | (setq form (byte-optimize-delay-constants-math form 1 '*)) | |
815 | ;; If there is a constant in FORM, it is now the last element. | |
816 | (cond ((null (cdr form)) 1) | |
6b61353c KH |
817 | ;;; It is not safe to delete the function entirely |
818 | ;;; (actually, it would be safe if we know the sole arg | |
819 | ;;; is not a marker or if it appears in other arithmetic). | |
3315a6a3 | 820 | ;;; ((null (cdr (cdr form))) (nth 1 form)) |
1c393159 | 821 | ((let ((last (car (reverse form)))) |
97e6527f | 822 | (cond ((eq 0 last) (cons 'progn (cdr form))) |
1c393159 JB |
823 | ((eq 1 last) (delq 1 (copy-sequence form))) |
824 | ((eq -1 last) (list '- (delq -1 (copy-sequence form)))) | |
825 | ((and (eq 2 last) | |
826 | (memq t (mapcar 'symbolp (cdr form)))) | |
827 | (prog1 (setq form (delq 2 (copy-sequence form))) | |
828 | (while (not (symbolp (car (setq form (cdr form)))))) | |
829 | (setcar form (list '+ (car form) (car form))))) | |
830 | (form)))))) | |
831 | ||
832 | (defsubst byte-compile-butlast (form) | |
833 | (nreverse (cdr (reverse form)))) | |
834 | ||
835 | (defun byte-optimize-divide (form) | |
836 | (setq form (byte-optimize-delay-constants-math form 2 '*)) | |
837 | (let ((last (car (reverse (cdr (cdr form)))))) | |
838 | (if (numberp last) | |
199dd758 | 839 | (cond ((= (length form) 3) |
97e6527f KH |
840 | (if (and (numberp (nth 1 form)) |
841 | (not (zerop last)) | |
842 | (condition-case nil | |
843 | (/ (nth 1 form) last) | |
844 | (error nil))) | |
845 | (setq form (list 'progn (/ (nth 1 form) last))))) | |
199dd758 | 846 | ((= last 1) |
1c393159 JB |
847 | (setq form (byte-compile-butlast form))) |
848 | ((numberp (nth 1 form)) | |
849 | (setq form (cons (car form) | |
850 | (cons (/ (nth 1 form) last) | |
851 | (byte-compile-butlast (cdr (cdr form))))) | |
852 | last nil)))) | |
a1506d29 | 853 | (cond |
3315a6a3 RS |
854 | ;;; ((null (cdr (cdr form))) |
855 | ;;; (nth 1 form)) | |
1c393159 JB |
856 | ((eq (nth 1 form) 0) |
857 | (append '(progn) (cdr (cdr form)) '(0))) | |
858 | ((eq last -1) | |
859 | (list '- (if (nthcdr 3 form) | |
860 | (byte-compile-butlast form) | |
861 | (nth 1 form)))) | |
862 | (form)))) | |
863 | ||
864 | (defun byte-optimize-logmumble (form) | |
865 | (setq form (byte-optimize-delay-constants-math form 1 (car form))) | |
866 | (byte-optimize-predicate | |
867 | (cond ((memq 0 form) | |
868 | (setq form (if (eq (car form) 'logand) | |
869 | (cons 'progn (cdr form)) | |
870 | (delq 0 (copy-sequence form))))) | |
871 | ((and (eq (car-safe form) 'logior) | |
872 | (memq -1 form)) | |
97e6527f | 873 | (cons 'progn (cdr form))) |
1c393159 JB |
874 | (form)))) |
875 | ||
876 | ||
877 | (defun byte-optimize-binary-predicate (form) | |
878 | (if (byte-compile-constp (nth 1 form)) | |
879 | (if (byte-compile-constp (nth 2 form)) | |
880 | (condition-case () | |
881 | (list 'quote (eval form)) | |
882 | (error form)) | |
883 | ;; This can enable some lapcode optimizations. | |
884 | (list (car form) (nth 2 form) (nth 1 form))) | |
885 | form)) | |
886 | ||
887 | (defun byte-optimize-predicate (form) | |
888 | (let ((ok t) | |
889 | (rest (cdr form))) | |
890 | (while (and rest ok) | |
891 | (setq ok (byte-compile-constp (car rest)) | |
892 | rest (cdr rest))) | |
893 | (if ok | |
894 | (condition-case () | |
895 | (list 'quote (eval form)) | |
896 | (error form)) | |
897 | form))) | |
898 | ||
899 | (defun byte-optimize-identity (form) | |
900 | (if (and (cdr form) (null (cdr (cdr form)))) | |
901 | (nth 1 form) | |
244bbdc5 | 902 | (byte-compile-warn "identity called with %d arg%s, but requires 1" |
1c393159 JB |
903 | (length (cdr form)) |
904 | (if (= 1 (length (cdr form))) "" "s")) | |
905 | form)) | |
906 | ||
907 | (put 'identity 'byte-optimizer 'byte-optimize-identity) | |
908 | ||
909 | (put '+ 'byte-optimizer 'byte-optimize-plus) | |
910 | (put '* 'byte-optimizer 'byte-optimize-multiply) | |
911 | (put '- 'byte-optimizer 'byte-optimize-minus) | |
912 | (put '/ 'byte-optimizer 'byte-optimize-divide) | |
913 | (put 'max 'byte-optimizer 'byte-optimize-associative-math) | |
914 | (put 'min 'byte-optimizer 'byte-optimize-associative-math) | |
915 | ||
916 | (put '= 'byte-optimizer 'byte-optimize-binary-predicate) | |
917 | (put 'eq 'byte-optimizer 'byte-optimize-binary-predicate) | |
1c393159 JB |
918 | (put 'equal 'byte-optimizer 'byte-optimize-binary-predicate) |
919 | (put 'string= 'byte-optimizer 'byte-optimize-binary-predicate) | |
920 | (put 'string-equal 'byte-optimizer 'byte-optimize-binary-predicate) | |
921 | ||
922 | (put '< 'byte-optimizer 'byte-optimize-predicate) | |
923 | (put '> 'byte-optimizer 'byte-optimize-predicate) | |
924 | (put '<= 'byte-optimizer 'byte-optimize-predicate) | |
925 | (put '>= 'byte-optimizer 'byte-optimize-predicate) | |
926 | (put '1+ 'byte-optimizer 'byte-optimize-predicate) | |
927 | (put '1- 'byte-optimizer 'byte-optimize-predicate) | |
928 | (put 'not 'byte-optimizer 'byte-optimize-predicate) | |
929 | (put 'null 'byte-optimizer 'byte-optimize-predicate) | |
930 | (put 'memq 'byte-optimizer 'byte-optimize-predicate) | |
931 | (put 'consp 'byte-optimizer 'byte-optimize-predicate) | |
932 | (put 'listp 'byte-optimizer 'byte-optimize-predicate) | |
933 | (put 'symbolp 'byte-optimizer 'byte-optimize-predicate) | |
934 | (put 'stringp 'byte-optimizer 'byte-optimize-predicate) | |
935 | (put 'string< 'byte-optimizer 'byte-optimize-predicate) | |
936 | (put 'string-lessp 'byte-optimizer 'byte-optimize-predicate) | |
937 | ||
938 | (put 'logand 'byte-optimizer 'byte-optimize-logmumble) | |
939 | (put 'logior 'byte-optimizer 'byte-optimize-logmumble) | |
940 | (put 'logxor 'byte-optimizer 'byte-optimize-logmumble) | |
941 | (put 'lognot 'byte-optimizer 'byte-optimize-predicate) | |
942 | ||
943 | (put 'car 'byte-optimizer 'byte-optimize-predicate) | |
944 | (put 'cdr 'byte-optimizer 'byte-optimize-predicate) | |
945 | (put 'car-safe 'byte-optimizer 'byte-optimize-predicate) | |
946 | (put 'cdr-safe 'byte-optimizer 'byte-optimize-predicate) | |
947 | ||
948 | ||
a1506d29 | 949 | ;; I'm not convinced that this is necessary. Doesn't the optimizer loop |
1c393159 JB |
950 | ;; take care of this? - Jamie |
951 | ;; I think this may some times be necessary to reduce ie (quote 5) to 5, | |
eb8c3be9 | 952 | ;; so arithmetic optimizers recognize the numeric constant. - Hallvard |
1c393159 JB |
953 | (put 'quote 'byte-optimizer 'byte-optimize-quote) |
954 | (defun byte-optimize-quote (form) | |
955 | (if (or (consp (nth 1 form)) | |
956 | (and (symbolp (nth 1 form)) | |
e1f0df62 | 957 | (not (byte-compile-const-symbol-p form)))) |
1c393159 JB |
958 | form |
959 | (nth 1 form))) | |
960 | ||
961 | (defun byte-optimize-zerop (form) | |
962 | (cond ((numberp (nth 1 form)) | |
963 | (eval form)) | |
964 | (byte-compile-delete-errors | |
965 | (list '= (nth 1 form) 0)) | |
966 | (form))) | |
967 | ||
968 | (put 'zerop 'byte-optimizer 'byte-optimize-zerop) | |
969 | ||
970 | (defun byte-optimize-and (form) | |
971 | ;; Simplify if less than 2 args. | |
972 | ;; if there is a literal nil in the args to `and', throw it and following | |
973 | ;; forms away, and surround the `and' with (progn ... nil). | |
974 | (cond ((null (cdr form))) | |
975 | ((memq nil form) | |
976 | (list 'progn | |
977 | (byte-optimize-and | |
978 | (prog1 (setq form (copy-sequence form)) | |
979 | (while (nth 1 form) | |
980 | (setq form (cdr form))) | |
981 | (setcdr form nil))) | |
982 | nil)) | |
983 | ((null (cdr (cdr form))) | |
984 | (nth 1 form)) | |
985 | ((byte-optimize-predicate form)))) | |
986 | ||
987 | (defun byte-optimize-or (form) | |
988 | ;; Throw away nil's, and simplify if less than 2 args. | |
989 | ;; If there is a literal non-nil constant in the args to `or', throw away all | |
990 | ;; following forms. | |
991 | (if (memq nil form) | |
992 | (setq form (delq nil (copy-sequence form)))) | |
993 | (let ((rest form)) | |
994 | (while (cdr (setq rest (cdr rest))) | |
995 | (if (byte-compile-trueconstp (car rest)) | |
996 | (setq form (copy-sequence form) | |
997 | rest (setcdr (memq (car rest) form) nil)))) | |
998 | (if (cdr (cdr form)) | |
999 | (byte-optimize-predicate form) | |
1000 | (nth 1 form)))) | |
1001 | ||
1002 | (defun byte-optimize-cond (form) | |
1003 | ;; if any clauses have a literal nil as their test, throw them away. | |
1004 | ;; if any clause has a literal non-nil constant as its test, throw | |
1005 | ;; away all following clauses. | |
1006 | (let (rest) | |
1007 | ;; This must be first, to reduce (cond (t ...) (nil)) to (progn t ...) | |
1008 | (while (setq rest (assq nil (cdr form))) | |
1009 | (setq form (delq rest (copy-sequence form)))) | |
1010 | (if (memq nil (cdr form)) | |
1011 | (setq form (delq nil (copy-sequence form)))) | |
1012 | (setq rest form) | |
1013 | (while (setq rest (cdr rest)) | |
1014 | (cond ((byte-compile-trueconstp (car-safe (car rest))) | |
d8947b79 DN |
1015 | ;; This branch will always be taken: kill the subsequent ones. |
1016 | (cond ((eq rest (cdr form)) ;First branch of `cond'. | |
1017 | (setq form `(progn ,@(car rest)))) | |
1c393159 JB |
1018 | ((cdr rest) |
1019 | (setq form (copy-sequence form)) | |
1020 | (setcdr (memq (car rest) form) nil))) | |
d8947b79 DN |
1021 | (setq rest nil)) |
1022 | ((and (consp (car rest)) | |
1023 | (byte-compile-nilconstp (caar rest))) | |
1024 | ;; This branch will never be taken: kill its body. | |
1025 | (setcdr (car rest) nil))))) | |
1c393159 JB |
1026 | ;; |
1027 | ;; Turn (cond (( <x> )) ... ) into (or <x> (cond ... )) | |
1028 | (if (eq 'cond (car-safe form)) | |
1029 | (let ((clauses (cdr form))) | |
1030 | (if (and (consp (car clauses)) | |
1031 | (null (cdr (car clauses)))) | |
1032 | (list 'or (car (car clauses)) | |
1033 | (byte-optimize-cond | |
1034 | (cons (car form) (cdr (cdr form))))) | |
1035 | form)) | |
1036 | form)) | |
1037 | ||
1038 | (defun byte-optimize-if (form) | |
40fafc21 | 1039 | ;; (if (progn <insts> <test>) <rest>) ==> (progn <insts> (if <test> <rest>)) |
1c393159 JB |
1040 | ;; (if <true-constant> <then> <else...>) ==> <then> |
1041 | ;; (if <false-constant> <then> <else...>) ==> (progn <else...>) | |
1042 | ;; (if <test> nil <else...>) ==> (if (not <test>) (progn <else...>)) | |
1043 | ;; (if <test> <then> nil) ==> (if <test> <then>) | |
1044 | (let ((clause (nth 1 form))) | |
9d693d80 SM |
1045 | (cond ((and (eq (car-safe clause) 'progn) |
1046 | ;; `clause' is a proper list. | |
1047 | (null (cdr (last clause)))) | |
40fafc21 SM |
1048 | (if (null (cddr clause)) |
1049 | ;; A trivial `progn'. | |
1050 | (byte-optimize-if `(if ,(cadr clause) ,@(nthcdr 2 form))) | |
1051 | (nconc (butlast clause) | |
1052 | (list | |
1053 | (byte-optimize-if | |
1054 | `(if ,(car (last clause)) ,@(nthcdr 2 form))))))) | |
1055 | ((byte-compile-trueconstp clause) | |
d8947b79 DN |
1056 | `(progn ,clause ,(nth 2 form))) |
1057 | ((byte-compile-nilconstp clause) | |
1058 | `(progn ,clause ,@(nthcdr 3 form))) | |
1c393159 JB |
1059 | ((nth 2 form) |
1060 | (if (equal '(nil) (nthcdr 3 form)) | |
1061 | (list 'if clause (nth 2 form)) | |
1062 | form)) | |
1063 | ((or (nth 3 form) (nthcdr 4 form)) | |
97e6527f KH |
1064 | (list 'if |
1065 | ;; Don't make a double negative; | |
1066 | ;; instead, take away the one that is there. | |
1067 | (if (and (consp clause) (memq (car clause) '(not null)) | |
1068 | (= (length clause) 2)) ; (not xxxx) or (not (xxxx)) | |
1069 | (nth 1 clause) | |
1070 | (list 'not clause)) | |
1c393159 JB |
1071 | (if (nthcdr 4 form) |
1072 | (cons 'progn (nthcdr 3 form)) | |
1073 | (nth 3 form)))) | |
1074 | (t | |
1075 | (list 'progn clause nil))))) | |
1076 | ||
1077 | (defun byte-optimize-while (form) | |
aefd695a | 1078 | (when (< (length form) 2) |
244bbdc5 | 1079 | (byte-compile-warn "too few arguments for `while'")) |
1c393159 JB |
1080 | (if (nth 1 form) |
1081 | form)) | |
1082 | ||
1083 | (put 'and 'byte-optimizer 'byte-optimize-and) | |
1084 | (put 'or 'byte-optimizer 'byte-optimize-or) | |
1085 | (put 'cond 'byte-optimizer 'byte-optimize-cond) | |
1086 | (put 'if 'byte-optimizer 'byte-optimize-if) | |
1087 | (put 'while 'byte-optimizer 'byte-optimize-while) | |
1088 | ||
1089 | ;; byte-compile-negation-optimizer lives in bytecomp.el | |
1090 | (put '/= 'byte-optimizer 'byte-compile-negation-optimizer) | |
1091 | (put 'atom 'byte-optimizer 'byte-compile-negation-optimizer) | |
1092 | (put 'nlistp 'byte-optimizer 'byte-compile-negation-optimizer) | |
1093 | ||
1094 | ||
1095 | (defun byte-optimize-funcall (form) | |
72d8b544 SM |
1096 | ;; (funcall (lambda ...) ...) ==> ((lambda ...) ...) |
1097 | ;; (funcall foo ...) ==> (foo ...) | |
1c393159 JB |
1098 | (let ((fn (nth 1 form))) |
1099 | (if (memq (car-safe fn) '(quote function)) | |
1100 | (cons (nth 1 fn) (cdr (cdr form))) | |
1101 | form))) | |
1102 | ||
1103 | (defun byte-optimize-apply (form) | |
1104 | ;; If the last arg is a literal constant, turn this into a funcall. | |
1105 | ;; The funcall optimizer can then transform (funcall 'foo ...) -> (foo ...). | |
1106 | (let ((fn (nth 1 form)) | |
1107 | (last (nth (1- (length form)) form))) ; I think this really is fastest | |
1108 | (or (if (or (null last) | |
1109 | (eq (car-safe last) 'quote)) | |
1110 | (if (listp (nth 1 last)) | |
1111 | (let ((butlast (nreverse (cdr (reverse (cdr (cdr form))))))) | |
7e1dae73 | 1112 | (nconc (list 'funcall fn) butlast |
72d8b544 | 1113 | (mapcar (lambda (x) (list 'quote x)) (nth 1 last)))) |
1c393159 | 1114 | (byte-compile-warn |
244bbdc5 | 1115 | "last arg to apply can't be a literal atom: `%s'" |
1c393159 JB |
1116 | (prin1-to-string last)) |
1117 | nil)) | |
1118 | form))) | |
1119 | ||
1120 | (put 'funcall 'byte-optimizer 'byte-optimize-funcall) | |
1121 | (put 'apply 'byte-optimizer 'byte-optimize-apply) | |
1122 | ||
1123 | ||
1124 | (put 'let 'byte-optimizer 'byte-optimize-letX) | |
1125 | (put 'let* 'byte-optimizer 'byte-optimize-letX) | |
1126 | (defun byte-optimize-letX (form) | |
1127 | (cond ((null (nth 1 form)) | |
1128 | ;; No bindings | |
1129 | (cons 'progn (cdr (cdr form)))) | |
1130 | ((or (nth 2 form) (nthcdr 3 form)) | |
1131 | form) | |
1132 | ;; The body is nil | |
1133 | ((eq (car form) 'let) | |
5d265171 RS |
1134 | (append '(progn) (mapcar 'car-safe (mapcar 'cdr-safe (nth 1 form))) |
1135 | '(nil))) | |
1c393159 JB |
1136 | (t |
1137 | (let ((binds (reverse (nth 1 form)))) | |
1138 | (list 'let* (reverse (cdr binds)) (nth 1 (car binds)) nil))))) | |
1139 | ||
1140 | ||
1141 | (put 'nth 'byte-optimizer 'byte-optimize-nth) | |
1142 | (defun byte-optimize-nth (form) | |
56cfa244 DL |
1143 | (if (= (safe-length form) 3) |
1144 | (if (memq (nth 1 form) '(0 1)) | |
1145 | (list 'car (if (zerop (nth 1 form)) | |
1146 | (nth 2 form) | |
1147 | (list 'cdr (nth 2 form)))) | |
1148 | (byte-optimize-predicate form)) | |
1149 | form)) | |
1c393159 JB |
1150 | |
1151 | (put 'nthcdr 'byte-optimizer 'byte-optimize-nthcdr) | |
1152 | (defun byte-optimize-nthcdr (form) | |
56cfa244 DL |
1153 | (if (= (safe-length form) 3) |
1154 | (if (memq (nth 1 form) '(0 1 2)) | |
1155 | (let ((count (nth 1 form))) | |
1156 | (setq form (nth 2 form)) | |
1157 | (while (>= (setq count (1- count)) 0) | |
1158 | (setq form (list 'cdr form))) | |
1159 | form) | |
1160 | (byte-optimize-predicate form)) | |
1161 | form)) | |
79d137ff | 1162 | |
e5c230f4 DL |
1163 | ;; Fixme: delete-char -> delete-region (byte-coded) |
1164 | ;; optimize string-as-unibyte, string-as-multibyte, string-make-unibyte, | |
1165 | ;; string-make-multibyte for constant args. | |
1166 | ||
1167 | (put 'featurep 'byte-optimizer 'byte-optimize-featurep) | |
1168 | (defun byte-optimize-featurep (form) | |
5ebfbcdc SM |
1169 | ;; Emacs-21's byte-code doesn't run under XEmacs or SXEmacs anyway, so we |
1170 | ;; can safely optimize away this test. | |
538a93d8 | 1171 | (if (member (cdr-safe form) '(((quote xemacs)) ((quote sxemacs)))) |
e5c230f4 | 1172 | nil |
70f41945 DN |
1173 | (if (member (cdr-safe form) '(((quote emacs)))) |
1174 | t | |
1175 | form))) | |
66ff2893 SM |
1176 | |
1177 | (put 'set 'byte-optimizer 'byte-optimize-set) | |
1178 | (defun byte-optimize-set (form) | |
1179 | (let ((var (car-safe (cdr-safe form)))) | |
1180 | (cond | |
1181 | ((and (eq (car-safe var) 'quote) (consp (cdr var))) | |
e64e9e6a | 1182 | `(setq ,(cadr var) ,@(cddr form))) |
66ff2893 SM |
1183 | ((and (eq (car-safe var) 'make-local-variable) |
1184 | (eq (car-safe (setq var (car-safe (cdr var)))) 'quote) | |
1185 | (consp (cdr var))) | |
1186 | `(progn ,(cadr form) (setq ,(cadr var) ,@(cddr form)))) | |
1187 | (t form)))) | |
1c393159 | 1188 | \f |
6b61353c KH |
1189 | ;; enumerating those functions which need not be called if the returned |
1190 | ;; value is not used. That is, something like | |
1191 | ;; (progn (list (something-with-side-effects) (yow)) | |
1192 | ;; (foo)) | |
1193 | ;; may safely be turned into | |
1194 | ;; (progn (progn (something-with-side-effects) (yow)) | |
1195 | ;; (foo)) | |
1196 | ;; Further optimizations will turn (progn (list 1 2 3) 'foo) into 'foo. | |
1197 | ||
1198 | ;; Some of these functions have the side effect of allocating memory | |
1199 | ;; and it would be incorrect to replace two calls with one. | |
1200 | ;; But we don't try to do those kinds of optimizations, | |
1201 | ;; so it is safe to list such functions here. | |
1202 | ;; Some of these functions return values that depend on environment | |
1203 | ;; state, so that constant folding them would be wrong, | |
1204 | ;; but we don't do constant folding based on this list. | |
1205 | ||
1206 | ;; However, at present the only optimization we normally do | |
1207 | ;; is delete calls that need not occur, and we only do that | |
1208 | ;; with the error-free functions. | |
1209 | ||
1210 | ;; I wonder if I missed any :-\) | |
1c393159 | 1211 | (let ((side-effect-free-fns |
c20a77cc RS |
1212 | '(% * + - / /= 1+ 1- < <= = > >= abs acos append aref ash asin atan |
1213 | assoc assq | |
1214 | boundp buffer-file-name buffer-local-variables buffer-modified-p | |
1fc9ee97 | 1215 | buffer-substring byte-code-function-p |
049a65a3 | 1216 | capitalize car-less-than-car car cdr ceiling char-after char-before |
1fc9ee97 RS |
1217 | char-equal char-to-string char-width |
1218 | compare-strings concat coordinates-in-window-p | |
1219 | copy-alist copy-sequence copy-marker cos count-lines | |
9e60aa0b | 1220 | decode-char |
1fc9ee97 | 1221 | decode-time default-boundp default-value documentation downcase |
8f924df7 | 1222 | elt encode-char exp expt encode-time error-message-string |
1fc9ee97 | 1223 | fboundp fceiling featurep ffloor |
1c393159 JB |
1224 | file-directory-p file-exists-p file-locked-p file-name-absolute-p |
1225 | file-newer-than-file-p file-readable-p file-symlink-p file-writable-p | |
1fc9ee97 RS |
1226 | float float-time floor format format-time-string frame-visible-p |
1227 | fround ftruncate | |
2412aadb DL |
1228 | get gethash get-buffer get-buffer-window getenv get-file-buffer |
1229 | hash-table-count | |
1fc9ee97 | 1230 | int-to-string intern-soft |
f34bba69 | 1231 | keymap-parent |
e1f0df62 | 1232 | length local-variable-if-set-p local-variable-p log log10 logand |
f9cbd456 | 1233 | logb logior lognot logxor lsh langinfo |
1fc9ee97 | 1234 | make-list make-string make-symbol |
d9881cf1 | 1235 | marker-buffer max member memq min mod multibyte-char-to-unibyte |
c20a77cc | 1236 | next-window nth nthcdr number-to-string |
1fc9ee97 RS |
1237 | parse-colon-path plist-get plist-member |
1238 | prefix-numeric-value previous-window prin1-to-string propertize | |
1239 | radians-to-degrees rassq rassoc read-from-string regexp-quote | |
1240 | region-beginning region-end reverse round | |
049a65a3 | 1241 | sin sqrt string string< string= string-equal string-lessp string-to-char |
1fc9ee97 | 1242 | string-to-int string-to-number substring sxhash symbol-function |
d9881cf1 DL |
1243 | symbol-name symbol-plist symbol-value string-make-unibyte |
1244 | string-make-multibyte string-as-multibyte string-as-unibyte | |
8f924df7 | 1245 | string-to-multibyte |
1fc9ee97 RS |
1246 | tan truncate |
1247 | unibyte-char-to-multibyte upcase user-full-name | |
1248 | user-login-name user-original-login-name user-variable-p | |
1249 | vconcat | |
c20a77cc RS |
1250 | window-buffer window-dedicated-p window-edges window-height |
1251 | window-hscroll window-minibuffer-p window-width | |
1c393159 | 1252 | zerop)) |
1c393159 | 1253 | (side-effect-and-error-free-fns |
c20a77cc | 1254 | '(arrayp atom |
a1506d29 | 1255 | bobp bolp bool-vector-p |
1fc9ee97 | 1256 | buffer-end buffer-list buffer-size buffer-string bufferp |
354a6a95 | 1257 | car-safe case-table-p cdr-safe char-or-string-p characterp |
85eb6576 | 1258 | charsetp commandp cons consp |
f34bba69 | 1259 | current-buffer current-global-map current-indentation |
1fc9ee97 RS |
1260 | current-local-map current-minor-mode-maps current-time |
1261 | current-time-string current-time-zone | |
1262 | eobp eolp eq equal eventp | |
049a65a3 | 1263 | floatp following-char framep |
c20a77cc | 1264 | get-largest-window get-lru-window |
2412aadb | 1265 | hash-table-p |
c20a77cc RS |
1266 | identity ignore integerp integer-or-marker-p interactive-p |
1267 | invocation-directory invocation-name | |
f34bba69 DL |
1268 | keymapp |
1269 | line-beginning-position line-end-position list listp | |
8f924df7 KH |
1270 | make-marker mark mark-marker markerp max-char |
1271 | memory-limit minibuffer-window | |
c20a77cc RS |
1272 | mouse-movement-p |
1273 | natnump nlistp not null number-or-marker-p numberp | |
1274 | one-window-p overlayp | |
85eb6576 DL |
1275 | point point-marker point-min point-max preceding-char primary-charset |
1276 | processp | |
f34bba69 | 1277 | recent-keys recursion-depth |
1fc9ee97 RS |
1278 | safe-length selected-frame selected-window sequencep |
1279 | standard-case-table standard-syntax-table stringp subrp symbolp | |
1280 | syntax-table syntax-table-p | |
f34bba69 DL |
1281 | this-command-keys this-command-keys-vector this-single-command-keys |
1282 | this-single-command-raw-keys | |
c20a77cc | 1283 | user-real-login-name user-real-uid user-uid |
f34bba69 | 1284 | vector vectorp visible-frame-list |
1fc9ee97 | 1285 | wholenump window-configuration-p window-live-p windowp))) |
1c393159 JB |
1286 | (while side-effect-free-fns |
1287 | (put (car side-effect-free-fns) 'side-effect-free t) | |
1288 | (setq side-effect-free-fns (cdr side-effect-free-fns))) | |
1289 | (while side-effect-and-error-free-fns | |
1290 | (put (car side-effect-and-error-free-fns) 'side-effect-free 'error-free) | |
1291 | (setq side-effect-and-error-free-fns (cdr side-effect-and-error-free-fns))) | |
1292 | nil) | |
1293 | ||
fb67ebdf CY |
1294 | \f |
1295 | ;; pure functions are side-effect free functions whose values depend | |
1296 | ;; only on their arguments. For these functions, calls with constant | |
1297 | ;; arguments can be evaluated at compile time. This may shift run time | |
1298 | ;; errors to compile time. | |
1299 | ||
1300 | (let ((pure-fns | |
1301 | '(concat symbol-name regexp-opt regexp-quote string-to-syntax))) | |
1302 | (while pure-fns | |
1303 | (put (car pure-fns) 'pure t) | |
1304 | (setq pure-fns (cdr pure-fns))) | |
1305 | nil) | |
1c393159 JB |
1306 | |
1307 | (defun byte-compile-splice-in-already-compiled-code (form) | |
1308 | ;; form is (byte-code "..." [...] n) | |
1309 | (if (not (memq byte-optimize '(t lap))) | |
1310 | (byte-compile-normal-call form) | |
1311 | (byte-inline-lapcode | |
1312 | (byte-decompile-bytecode-1 (nth 1 form) (nth 2 form) t)) | |
1313 | (setq byte-compile-maxdepth (max (+ byte-compile-depth (nth 3 form)) | |
1314 | byte-compile-maxdepth)) | |
1315 | (setq byte-compile-depth (1+ byte-compile-depth)))) | |
1316 | ||
1317 | (put 'byte-code 'byte-compile 'byte-compile-splice-in-already-compiled-code) | |
1318 | ||
1319 | \f | |
1320 | (defconst byte-constref-ops | |
1321 | '(byte-constant byte-constant2 byte-varref byte-varset byte-varbind)) | |
1322 | ||
6b61353c KH |
1323 | ;; This function extracts the bitfields from variable-length opcodes. |
1324 | ;; Originally defined in disass.el (which no longer uses it.) | |
1c393159 JB |
1325 | |
1326 | (defun disassemble-offset () | |
1327 | "Don't call this!" | |
1328 | ;; fetch and return the offset for the current opcode. | |
f0529b5b | 1329 | ;; return nil if this opcode has no offset |
1c393159 JB |
1330 | ;; OP, PTR and BYTES are used and set dynamically |
1331 | (defvar op) | |
1332 | (defvar ptr) | |
1333 | (defvar bytes) | |
1334 | (cond ((< op byte-nth) | |
1335 | (let ((tem (logand op 7))) | |
1336 | (setq op (logand op 248)) | |
1337 | (cond ((eq tem 6) | |
1338 | (setq ptr (1+ ptr)) ;offset in next byte | |
1339 | (aref bytes ptr)) | |
1340 | ((eq tem 7) | |
1341 | (setq ptr (1+ ptr)) ;offset in next 2 bytes | |
1342 | (+ (aref bytes ptr) | |
1343 | (progn (setq ptr (1+ ptr)) | |
1344 | (lsh (aref bytes ptr) 8)))) | |
1345 | (t tem)))) ;offset was in opcode | |
1346 | ((>= op byte-constant) | |
1347 | (prog1 (- op byte-constant) ;offset in opcode | |
1348 | (setq op byte-constant))) | |
1349 | ((and (>= op byte-constant2) | |
1350 | (<= op byte-goto-if-not-nil-else-pop)) | |
1351 | (setq ptr (1+ ptr)) ;offset in next 2 bytes | |
1352 | (+ (aref bytes ptr) | |
1353 | (progn (setq ptr (1+ ptr)) | |
1354 | (lsh (aref bytes ptr) 8)))) | |
3eac9910 | 1355 | ((and (>= op byte-listN) |
1c393159 JB |
1356 | (<= op byte-insertN)) |
1357 | (setq ptr (1+ ptr)) ;offset in next byte | |
1358 | (aref bytes ptr)))) | |
1359 | ||
1360 | ||
6b61353c KH |
1361 | ;; This de-compiler is used for inline expansion of compiled functions, |
1362 | ;; and by the disassembler. | |
1363 | ;; | |
1364 | ;; This list contains numbers, which are pc values, | |
1365 | ;; before each instruction. | |
1c393159 | 1366 | (defun byte-decompile-bytecode (bytes constvec) |
40fafc21 | 1367 | "Turn BYTECODE into lapcode, referring to CONSTVEC." |
1c393159 JB |
1368 | (let ((byte-compile-constants nil) |
1369 | (byte-compile-variables nil) | |
1370 | (byte-compile-tag-number 0)) | |
1371 | (byte-decompile-bytecode-1 bytes constvec))) | |
1372 | ||
70e1dad8 RS |
1373 | ;; As byte-decompile-bytecode, but updates |
1374 | ;; byte-compile-{constants, variables, tag-number}. | |
cffcfe66 | 1375 | ;; If MAKE-SPLICEABLE is true, then `return' opcodes are replaced |
70e1dad8 | 1376 | ;; with `goto's destined for the end of the code. |
cffcfe66 RS |
1377 | ;; That is for use by the compiler. |
1378 | ;; If MAKE-SPLICEABLE is nil, we are being called for the disassembler. | |
1379 | ;; In that case, we put a pc value into the list | |
1380 | ;; before each insn (or its label). | |
1381 | (defun byte-decompile-bytecode-1 (bytes constvec &optional make-spliceable) | |
1c393159 | 1382 | (let ((length (length bytes)) |
08d72d13 | 1383 | (ptr 0) optr tags op offset |
1c393159 | 1384 | lap tmp |
08d72d13 | 1385 | endtag) |
1c393159 | 1386 | (while (not (= ptr length)) |
cffcfe66 RS |
1387 | (or make-spliceable |
1388 | (setq lap (cons ptr lap))) | |
1c393159 JB |
1389 | (setq op (aref bytes ptr) |
1390 | optr ptr | |
1391 | offset (disassemble-offset)) ; this does dynamic-scope magic | |
1392 | (setq op (aref byte-code-vector op)) | |
3eac9910 | 1393 | (cond ((memq op byte-goto-ops) |
1c393159 JB |
1394 | ;; it's a pc |
1395 | (setq offset | |
1396 | (cdr (or (assq offset tags) | |
1397 | (car (setq tags | |
1398 | (cons (cons offset | |
1399 | (byte-compile-make-tag)) | |
1400 | tags))))))) | |
1401 | ((cond ((eq op 'byte-constant2) (setq op 'byte-constant) t) | |
1402 | ((memq op byte-constref-ops))) | |
6ebe9f82 RS |
1403 | (setq tmp (if (>= offset (length constvec)) |
1404 | (list 'out-of-range offset) | |
1405 | (aref constvec offset)) | |
1c393159 JB |
1406 | offset (if (eq op 'byte-constant) |
1407 | (byte-compile-get-constant tmp) | |
1408 | (or (assq tmp byte-compile-variables) | |
1409 | (car (setq byte-compile-variables | |
1410 | (cons (list tmp) | |
1411 | byte-compile-variables))))))) | |
cffcfe66 | 1412 | ((and make-spliceable |
1c393159 JB |
1413 | (eq op 'byte-return)) |
1414 | (if (= ptr (1- length)) | |
1415 | (setq op nil) | |
1416 | (setq offset (or endtag (setq endtag (byte-compile-make-tag))) | |
1417 | op 'byte-goto)))) | |
1418 | ;; lap = ( [ (pc . (op . arg)) ]* ) | |
1419 | (setq lap (cons (cons optr (cons op (or offset 0))) | |
1420 | lap)) | |
1421 | (setq ptr (1+ ptr))) | |
1422 | ;; take off the dummy nil op that we replaced a trailing "return" with. | |
1423 | (let ((rest lap)) | |
1424 | (while rest | |
41cf13b9 RS |
1425 | (cond ((numberp (car rest))) |
1426 | ((setq tmp (assq (car (car rest)) tags)) | |
1c393159 JB |
1427 | ;; this addr is jumped to |
1428 | (setcdr rest (cons (cons nil (cdr tmp)) | |
1429 | (cdr rest))) | |
1430 | (setq tags (delq tmp tags)) | |
1431 | (setq rest (cdr rest)))) | |
1432 | (setq rest (cdr rest)))) | |
1433 | (if tags (error "optimizer error: missed tags %s" tags)) | |
1434 | (if (null (car (cdr (car lap)))) | |
1435 | (setq lap (cdr lap))) | |
1436 | (if endtag | |
1437 | (setq lap (cons (cons nil endtag) lap))) | |
1438 | ;; remove addrs, lap = ( [ (op . arg) | (TAG tagno) ]* ) | |
41cf13b9 RS |
1439 | (mapcar (function (lambda (elt) |
1440 | (if (numberp elt) | |
1441 | elt | |
1442 | (cdr elt)))) | |
1443 | (nreverse lap)))) | |
1c393159 JB |
1444 | |
1445 | \f | |
1446 | ;;; peephole optimizer | |
1447 | ||
1448 | (defconst byte-tagref-ops (cons 'TAG byte-goto-ops)) | |
1449 | ||
1450 | (defconst byte-conditional-ops | |
1451 | '(byte-goto-if-nil byte-goto-if-not-nil byte-goto-if-nil-else-pop | |
1452 | byte-goto-if-not-nil-else-pop)) | |
1453 | ||
1454 | (defconst byte-after-unbind-ops | |
1455 | '(byte-constant byte-dup | |
1456 | byte-symbolp byte-consp byte-stringp byte-listp byte-numberp byte-integerp | |
43fd1680 | 1457 | byte-eq byte-not |
1c393159 | 1458 | byte-cons byte-list1 byte-list2 ; byte-list3 byte-list4 |
cb88b56e RS |
1459 | byte-interactive-p) |
1460 | ;; How about other side-effect-free-ops? Is it safe to move an | |
1461 | ;; error invocation (such as from nth) out of an unwind-protect? | |
43fd1680 RS |
1462 | ;; No, it is not, because the unwind-protect forms can alter |
1463 | ;; the inside of the object to which nth would apply. | |
1464 | ;; For the same reason, byte-equal was deleted from this list. | |
cb88b56e | 1465 | "Byte-codes that can be moved past an unbind.") |
1c393159 JB |
1466 | |
1467 | (defconst byte-compile-side-effect-and-error-free-ops | |
1468 | '(byte-constant byte-dup byte-symbolp byte-consp byte-stringp byte-listp | |
1469 | byte-integerp byte-numberp byte-eq byte-equal byte-not byte-car-safe | |
1470 | byte-cdr-safe byte-cons byte-list1 byte-list2 byte-point byte-point-max | |
1471 | byte-point-min byte-following-char byte-preceding-char | |
1472 | byte-current-column byte-eolp byte-eobp byte-bolp byte-bobp | |
1473 | byte-current-buffer byte-interactive-p)) | |
1474 | ||
1475 | (defconst byte-compile-side-effect-free-ops | |
a1506d29 | 1476 | (nconc |
1c393159 JB |
1477 | '(byte-varref byte-nth byte-memq byte-car byte-cdr byte-length byte-aref |
1478 | byte-symbol-value byte-get byte-concat2 byte-concat3 byte-sub1 byte-add1 | |
1479 | byte-eqlsign byte-gtr byte-lss byte-leq byte-geq byte-diff byte-negate | |
1480 | byte-plus byte-max byte-min byte-mult byte-char-after byte-char-syntax | |
1481 | byte-buffer-substring byte-string= byte-string< byte-nthcdr byte-elt | |
1482 | byte-member byte-assq byte-quo byte-rem) | |
1483 | byte-compile-side-effect-and-error-free-ops)) | |
1484 | ||
6b61353c KH |
1485 | ;; This crock is because of the way DEFVAR_BOOL variables work. |
1486 | ;; Consider the code | |
1487 | ;; | |
1488 | ;; (defun foo (flag) | |
1489 | ;; (let ((old-pop-ups pop-up-windows) | |
1490 | ;; (pop-up-windows flag)) | |
1491 | ;; (cond ((not (eq pop-up-windows old-pop-ups)) | |
1492 | ;; (setq old-pop-ups pop-up-windows) | |
1493 | ;; ...)))) | |
1494 | ;; | |
1495 | ;; Uncompiled, old-pop-ups will always be set to nil or t, even if FLAG is | |
1496 | ;; something else. But if we optimize | |
1497 | ;; | |
1498 | ;; varref flag | |
1499 | ;; varbind pop-up-windows | |
1500 | ;; varref pop-up-windows | |
1501 | ;; not | |
1502 | ;; to | |
1503 | ;; varref flag | |
1504 | ;; dup | |
1505 | ;; varbind pop-up-windows | |
1506 | ;; not | |
1507 | ;; | |
1508 | ;; we break the program, because it will appear that pop-up-windows and | |
1509 | ;; old-pop-ups are not EQ when really they are. So we have to know what | |
1510 | ;; the BOOL variables are, and not perform this optimization on them. | |
1511 | ||
1512 | ;; The variable `byte-boolean-vars' is now primitive and updated | |
1513 | ;; automatically by DEFVAR_BOOL. | |
1c393159 JB |
1514 | |
1515 | (defun byte-optimize-lapcode (lap &optional for-effect) | |
6b61353c KH |
1516 | "Simple peephole optimizer. LAP is both modified and returned. |
1517 | If FOR-EFFECT is non-nil, the return value is assumed to be of no importance." | |
944425c0 DL |
1518 | (let (lap0 |
1519 | lap1 | |
1520 | lap2 | |
1c393159 JB |
1521 | (keep-going 'first-time) |
1522 | (add-depth 0) | |
1523 | rest tmp tmp2 tmp3 | |
1524 | (side-effect-free (if byte-compile-delete-errors | |
1525 | byte-compile-side-effect-free-ops | |
1526 | byte-compile-side-effect-and-error-free-ops))) | |
1527 | (while keep-going | |
1528 | (or (eq keep-going 'first-time) | |
1529 | (byte-compile-log-lap " ---- next pass")) | |
1530 | (setq rest lap | |
1531 | keep-going nil) | |
1532 | (while rest | |
1533 | (setq lap0 (car rest) | |
1534 | lap1 (nth 1 rest) | |
1535 | lap2 (nth 2 rest)) | |
1536 | ||
1537 | ;; You may notice that sequences like "dup varset discard" are | |
1538 | ;; optimized but sequences like "dup varset TAG1: discard" are not. | |
1539 | ;; You may be tempted to change this; resist that temptation. | |
1540 | (cond ;; | |
1541 | ;; <side-effect-free> pop --> <deleted> | |
1542 | ;; ...including: | |
1543 | ;; const-X pop --> <deleted> | |
1544 | ;; varref-X pop --> <deleted> | |
1545 | ;; dup pop --> <deleted> | |
1546 | ;; | |
1547 | ((and (eq 'byte-discard (car lap1)) | |
1548 | (memq (car lap0) side-effect-free)) | |
1549 | (setq keep-going t) | |
1550 | (setq tmp (aref byte-stack+-info (symbol-value (car lap0)))) | |
1551 | (setq rest (cdr rest)) | |
1552 | (cond ((= tmp 1) | |
1553 | (byte-compile-log-lap | |
1554 | " %s discard\t-->\t<deleted>" lap0) | |
1555 | (setq lap (delq lap0 (delq lap1 lap)))) | |
1556 | ((= tmp 0) | |
1557 | (byte-compile-log-lap | |
1558 | " %s discard\t-->\t<deleted> discard" lap0) | |
1559 | (setq lap (delq lap0 lap))) | |
1560 | ((= tmp -1) | |
1561 | (byte-compile-log-lap | |
1562 | " %s discard\t-->\tdiscard discard" lap0) | |
1563 | (setcar lap0 'byte-discard) | |
1564 | (setcdr lap0 0)) | |
1565 | ((error "Optimizer error: too much on the stack")))) | |
1566 | ;; | |
1567 | ;; goto*-X X: --> X: | |
1568 | ;; | |
1569 | ((and (memq (car lap0) byte-goto-ops) | |
1570 | (eq (cdr lap0) lap1)) | |
1571 | (cond ((eq (car lap0) 'byte-goto) | |
1572 | (setq lap (delq lap0 lap)) | |
1573 | (setq tmp "<deleted>")) | |
1574 | ((memq (car lap0) byte-goto-always-pop-ops) | |
1575 | (setcar lap0 (setq tmp 'byte-discard)) | |
1576 | (setcdr lap0 0)) | |
1577 | ((error "Depth conflict at tag %d" (nth 2 lap0)))) | |
1578 | (and (memq byte-optimize-log '(t byte)) | |
1579 | (byte-compile-log " (goto %s) %s:\t-->\t%s %s:" | |
1580 | (nth 1 lap1) (nth 1 lap1) | |
1581 | tmp (nth 1 lap1))) | |
1582 | (setq keep-going t)) | |
1583 | ;; | |
1584 | ;; varset-X varref-X --> dup varset-X | |
1585 | ;; varbind-X varref-X --> dup varbind-X | |
1586 | ;; const/dup varset-X varref-X --> const/dup varset-X const/dup | |
1587 | ;; const/dup varbind-X varref-X --> const/dup varbind-X const/dup | |
1588 | ;; The latter two can enable other optimizations. | |
1589 | ;; | |
1590 | ((and (eq 'byte-varref (car lap2)) | |
1591 | (eq (cdr lap1) (cdr lap2)) | |
1592 | (memq (car lap1) '(byte-varset byte-varbind))) | |
1593 | (if (and (setq tmp (memq (car (cdr lap2)) byte-boolean-vars)) | |
1594 | (not (eq (car lap0) 'byte-constant))) | |
1595 | nil | |
1596 | (setq keep-going t) | |
1597 | (if (memq (car lap0) '(byte-constant byte-dup)) | |
1598 | (progn | |
1599 | (setq tmp (if (or (not tmp) | |
e1f0df62 DL |
1600 | (byte-compile-const-symbol-p |
1601 | (car (cdr lap0)))) | |
1c393159 JB |
1602 | (cdr lap0) |
1603 | (byte-compile-get-constant t))) | |
1604 | (byte-compile-log-lap " %s %s %s\t-->\t%s %s %s" | |
1605 | lap0 lap1 lap2 lap0 lap1 | |
1606 | (cons (car lap0) tmp)) | |
1607 | (setcar lap2 (car lap0)) | |
1608 | (setcdr lap2 tmp)) | |
1609 | (byte-compile-log-lap " %s %s\t-->\tdup %s" lap1 lap2 lap1) | |
1610 | (setcar lap2 (car lap1)) | |
1611 | (setcar lap1 'byte-dup) | |
1612 | (setcdr lap1 0) | |
1613 | ;; The stack depth gets locally increased, so we will | |
1614 | ;; increase maxdepth in case depth = maxdepth here. | |
1615 | ;; This can cause the third argument to byte-code to | |
1616 | ;; be larger than necessary. | |
1617 | (setq add-depth 1)))) | |
1618 | ;; | |
1619 | ;; dup varset-X discard --> varset-X | |
1620 | ;; dup varbind-X discard --> varbind-X | |
1621 | ;; (the varbind variant can emerge from other optimizations) | |
1622 | ;; | |
1623 | ((and (eq 'byte-dup (car lap0)) | |
1624 | (eq 'byte-discard (car lap2)) | |
1625 | (memq (car lap1) '(byte-varset byte-varbind))) | |
1626 | (byte-compile-log-lap " dup %s discard\t-->\t%s" lap1 lap1) | |
1627 | (setq keep-going t | |
1628 | rest (cdr rest)) | |
1629 | (setq lap (delq lap0 (delq lap2 lap)))) | |
1630 | ;; | |
1631 | ;; not goto-X-if-nil --> goto-X-if-non-nil | |
1632 | ;; not goto-X-if-non-nil --> goto-X-if-nil | |
1633 | ;; | |
1634 | ;; it is wrong to do the same thing for the -else-pop variants. | |
1635 | ;; | |
1636 | ((and (eq 'byte-not (car lap0)) | |
1637 | (or (eq 'byte-goto-if-nil (car lap1)) | |
1638 | (eq 'byte-goto-if-not-nil (car lap1)))) | |
1639 | (byte-compile-log-lap " not %s\t-->\t%s" | |
1640 | lap1 | |
1641 | (cons | |
1642 | (if (eq (car lap1) 'byte-goto-if-nil) | |
1643 | 'byte-goto-if-not-nil | |
1644 | 'byte-goto-if-nil) | |
1645 | (cdr lap1))) | |
1646 | (setcar lap1 (if (eq (car lap1) 'byte-goto-if-nil) | |
1647 | 'byte-goto-if-not-nil | |
1648 | 'byte-goto-if-nil)) | |
1649 | (setq lap (delq lap0 lap)) | |
1650 | (setq keep-going t)) | |
1651 | ;; | |
1652 | ;; goto-X-if-nil goto-Y X: --> goto-Y-if-non-nil X: | |
1653 | ;; goto-X-if-non-nil goto-Y X: --> goto-Y-if-nil X: | |
1654 | ;; | |
1655 | ;; it is wrong to do the same thing for the -else-pop variants. | |
a1506d29 | 1656 | ;; |
1c393159 JB |
1657 | ((and (or (eq 'byte-goto-if-nil (car lap0)) |
1658 | (eq 'byte-goto-if-not-nil (car lap0))) ; gotoX | |
1659 | (eq 'byte-goto (car lap1)) ; gotoY | |
1660 | (eq (cdr lap0) lap2)) ; TAG X | |
1661 | (let ((inverse (if (eq 'byte-goto-if-nil (car lap0)) | |
1662 | 'byte-goto-if-not-nil 'byte-goto-if-nil))) | |
1663 | (byte-compile-log-lap " %s %s %s:\t-->\t%s %s:" | |
1664 | lap0 lap1 lap2 | |
1665 | (cons inverse (cdr lap1)) lap2) | |
1666 | (setq lap (delq lap0 lap)) | |
1667 | (setcar lap1 inverse) | |
1668 | (setq keep-going t))) | |
1669 | ;; | |
1670 | ;; const goto-if-* --> whatever | |
1671 | ;; | |
1672 | ((and (eq 'byte-constant (car lap0)) | |
1673 | (memq (car lap1) byte-conditional-ops)) | |
1674 | (cond ((if (or (eq (car lap1) 'byte-goto-if-nil) | |
1675 | (eq (car lap1) 'byte-goto-if-nil-else-pop)) | |
1676 | (car (cdr lap0)) | |
1677 | (not (car (cdr lap0)))) | |
1678 | (byte-compile-log-lap " %s %s\t-->\t<deleted>" | |
1679 | lap0 lap1) | |
1680 | (setq rest (cdr rest) | |
1681 | lap (delq lap0 (delq lap1 lap)))) | |
1682 | (t | |
1683 | (if (memq (car lap1) byte-goto-always-pop-ops) | |
1684 | (progn | |
1685 | (byte-compile-log-lap " %s %s\t-->\t%s" | |
1686 | lap0 lap1 (cons 'byte-goto (cdr lap1))) | |
1687 | (setq lap (delq lap0 lap))) | |
1688 | (byte-compile-log-lap " %s %s\t-->\t%s" lap0 lap1 | |
1689 | (cons 'byte-goto (cdr lap1)))) | |
1690 | (setcar lap1 'byte-goto))) | |
1691 | (setq keep-going t)) | |
1692 | ;; | |
1693 | ;; varref-X varref-X --> varref-X dup | |
1694 | ;; varref-X [dup ...] varref-X --> varref-X [dup ...] dup | |
1695 | ;; We don't optimize the const-X variations on this here, | |
1696 | ;; because that would inhibit some goto optimizations; we | |
1697 | ;; optimize the const-X case after all other optimizations. | |
1698 | ;; | |
1699 | ((and (eq 'byte-varref (car lap0)) | |
1700 | (progn | |
1701 | (setq tmp (cdr rest)) | |
1702 | (while (eq (car (car tmp)) 'byte-dup) | |
1703 | (setq tmp (cdr tmp))) | |
1704 | t) | |
1705 | (eq (cdr lap0) (cdr (car tmp))) | |
1706 | (eq 'byte-varref (car (car tmp)))) | |
1707 | (if (memq byte-optimize-log '(t byte)) | |
1708 | (let ((str "")) | |
1709 | (setq tmp2 (cdr rest)) | |
1710 | (while (not (eq tmp tmp2)) | |
1711 | (setq tmp2 (cdr tmp2) | |
1712 | str (concat str " dup"))) | |
1713 | (byte-compile-log-lap " %s%s %s\t-->\t%s%s dup" | |
1714 | lap0 str lap0 lap0 str))) | |
1715 | (setq keep-going t) | |
1716 | (setcar (car tmp) 'byte-dup) | |
1717 | (setcdr (car tmp) 0) | |
1718 | (setq rest tmp)) | |
1719 | ;; | |
1720 | ;; TAG1: TAG2: --> TAG1: <deleted> | |
1721 | ;; (and other references to TAG2 are replaced with TAG1) | |
1722 | ;; | |
1723 | ((and (eq (car lap0) 'TAG) | |
1724 | (eq (car lap1) 'TAG)) | |
1725 | (and (memq byte-optimize-log '(t byte)) | |
eb8c3be9 | 1726 | (byte-compile-log " adjacent tags %d and %d merged" |
1c393159 JB |
1727 | (nth 1 lap1) (nth 1 lap0))) |
1728 | (setq tmp3 lap) | |
1729 | (while (setq tmp2 (rassq lap0 tmp3)) | |
1730 | (setcdr tmp2 lap1) | |
1731 | (setq tmp3 (cdr (memq tmp2 tmp3)))) | |
1732 | (setq lap (delq lap0 lap) | |
1733 | keep-going t)) | |
1734 | ;; | |
1735 | ;; unused-TAG: --> <deleted> | |
1736 | ;; | |
1737 | ((and (eq 'TAG (car lap0)) | |
1738 | (not (rassq lap0 lap))) | |
1739 | (and (memq byte-optimize-log '(t byte)) | |
1740 | (byte-compile-log " unused tag %d removed" (nth 1 lap0))) | |
1741 | (setq lap (delq lap0 lap) | |
1742 | keep-going t)) | |
1743 | ;; | |
1744 | ;; goto ... --> goto <delete until TAG or end> | |
1745 | ;; return ... --> return <delete until TAG or end> | |
1746 | ;; | |
1747 | ((and (memq (car lap0) '(byte-goto byte-return)) | |
1748 | (not (memq (car lap1) '(TAG nil)))) | |
1749 | (setq tmp rest) | |
1750 | (let ((i 0) | |
1751 | (opt-p (memq byte-optimize-log '(t lap))) | |
1752 | str deleted) | |
1753 | (while (and (setq tmp (cdr tmp)) | |
1754 | (not (eq 'TAG (car (car tmp))))) | |
1755 | (if opt-p (setq deleted (cons (car tmp) deleted) | |
1756 | str (concat str " %s") | |
1757 | i (1+ i)))) | |
1758 | (if opt-p | |
a1506d29 | 1759 | (let ((tagstr |
1c393159 | 1760 | (if (eq 'TAG (car (car tmp))) |
dec4e22e | 1761 | (format "%d:" (car (cdr (car tmp)))) |
1c393159 JB |
1762 | (or (car tmp) "")))) |
1763 | (if (< i 6) | |
1764 | (apply 'byte-compile-log-lap-1 | |
1765 | (concat " %s" str | |
1766 | " %s\t-->\t%s <deleted> %s") | |
1767 | lap0 | |
1768 | (nconc (nreverse deleted) | |
1769 | (list tagstr lap0 tagstr))) | |
1770 | (byte-compile-log-lap | |
1771 | " %s <%d unreachable op%s> %s\t-->\t%s <deleted> %s" | |
1772 | lap0 i (if (= i 1) "" "s") | |
1773 | tagstr lap0 tagstr)))) | |
1774 | (rplacd rest tmp)) | |
1775 | (setq keep-going t)) | |
1776 | ;; | |
1777 | ;; <safe-op> unbind --> unbind <safe-op> | |
1778 | ;; (this may enable other optimizations.) | |
1779 | ;; | |
1780 | ((and (eq 'byte-unbind (car lap1)) | |
1781 | (memq (car lap0) byte-after-unbind-ops)) | |
1782 | (byte-compile-log-lap " %s %s\t-->\t%s %s" lap0 lap1 lap1 lap0) | |
1783 | (setcar rest lap1) | |
1784 | (setcar (cdr rest) lap0) | |
1785 | (setq keep-going t)) | |
1786 | ;; | |
1787 | ;; varbind-X unbind-N --> discard unbind-(N-1) | |
1788 | ;; save-excursion unbind-N --> unbind-(N-1) | |
1789 | ;; save-restriction unbind-N --> unbind-(N-1) | |
1790 | ;; | |
1791 | ((and (eq 'byte-unbind (car lap1)) | |
1792 | (memq (car lap0) '(byte-varbind byte-save-excursion | |
1793 | byte-save-restriction)) | |
1794 | (< 0 (cdr lap1))) | |
1795 | (if (zerop (setcdr lap1 (1- (cdr lap1)))) | |
1796 | (delq lap1 rest)) | |
1797 | (if (eq (car lap0) 'byte-varbind) | |
1798 | (setcar rest (cons 'byte-discard 0)) | |
1799 | (setq lap (delq lap0 lap))) | |
1800 | (byte-compile-log-lap " %s %s\t-->\t%s %s" | |
1801 | lap0 (cons (car lap1) (1+ (cdr lap1))) | |
1802 | (if (eq (car lap0) 'byte-varbind) | |
1803 | (car rest) | |
1804 | (car (cdr rest))) | |
1805 | (if (and (/= 0 (cdr lap1)) | |
1806 | (eq (car lap0) 'byte-varbind)) | |
1807 | (car (cdr rest)) | |
1808 | "")) | |
1809 | (setq keep-going t)) | |
1810 | ;; | |
1811 | ;; goto*-X ... X: goto-Y --> goto*-Y | |
1812 | ;; goto-X ... X: return --> return | |
1813 | ;; | |
1814 | ((and (memq (car lap0) byte-goto-ops) | |
1815 | (memq (car (setq tmp (nth 1 (memq (cdr lap0) lap)))) | |
1816 | '(byte-goto byte-return))) | |
1817 | (cond ((and (not (eq tmp lap0)) | |
1818 | (or (eq (car lap0) 'byte-goto) | |
1819 | (eq (car tmp) 'byte-goto))) | |
1820 | (byte-compile-log-lap " %s [%s]\t-->\t%s" | |
1821 | (car lap0) tmp tmp) | |
1822 | (if (eq (car tmp) 'byte-return) | |
1823 | (setcar lap0 'byte-return)) | |
1824 | (setcdr lap0 (cdr tmp)) | |
1825 | (setq keep-going t)))) | |
1826 | ;; | |
1827 | ;; goto-*-else-pop X ... X: goto-if-* --> whatever | |
1828 | ;; goto-*-else-pop X ... X: discard --> whatever | |
1829 | ;; | |
1830 | ((and (memq (car lap0) '(byte-goto-if-nil-else-pop | |
1831 | byte-goto-if-not-nil-else-pop)) | |
1832 | (memq (car (car (setq tmp (cdr (memq (cdr lap0) lap))))) | |
1833 | (eval-when-compile | |
1834 | (cons 'byte-discard byte-conditional-ops))) | |
1835 | (not (eq lap0 (car tmp)))) | |
1836 | (setq tmp2 (car tmp)) | |
1837 | (setq tmp3 (assq (car lap0) '((byte-goto-if-nil-else-pop | |
1838 | byte-goto-if-nil) | |
1839 | (byte-goto-if-not-nil-else-pop | |
1840 | byte-goto-if-not-nil)))) | |
1841 | (if (memq (car tmp2) tmp3) | |
1842 | (progn (setcar lap0 (car tmp2)) | |
1843 | (setcdr lap0 (cdr tmp2)) | |
1844 | (byte-compile-log-lap " %s-else-pop [%s]\t-->\t%s" | |
1845 | (car lap0) tmp2 lap0)) | |
1846 | ;; Get rid of the -else-pop's and jump one step further. | |
1847 | (or (eq 'TAG (car (nth 1 tmp))) | |
1848 | (setcdr tmp (cons (byte-compile-make-tag) | |
1849 | (cdr tmp)))) | |
1850 | (byte-compile-log-lap " %s [%s]\t-->\t%s <skip>" | |
1851 | (car lap0) tmp2 (nth 1 tmp3)) | |
1852 | (setcar lap0 (nth 1 tmp3)) | |
1853 | (setcdr lap0 (nth 1 tmp))) | |
1854 | (setq keep-going t)) | |
1855 | ;; | |
1856 | ;; const goto-X ... X: goto-if-* --> whatever | |
1857 | ;; const goto-X ... X: discard --> whatever | |
1858 | ;; | |
1859 | ((and (eq (car lap0) 'byte-constant) | |
1860 | (eq (car lap1) 'byte-goto) | |
1861 | (memq (car (car (setq tmp (cdr (memq (cdr lap1) lap))))) | |
1862 | (eval-when-compile | |
1863 | (cons 'byte-discard byte-conditional-ops))) | |
1864 | (not (eq lap1 (car tmp)))) | |
1865 | (setq tmp2 (car tmp)) | |
1866 | (cond ((memq (car tmp2) | |
1867 | (if (null (car (cdr lap0))) | |
1868 | '(byte-goto-if-nil byte-goto-if-nil-else-pop) | |
1869 | '(byte-goto-if-not-nil | |
1870 | byte-goto-if-not-nil-else-pop))) | |
1871 | (byte-compile-log-lap " %s goto [%s]\t-->\t%s %s" | |
1872 | lap0 tmp2 lap0 tmp2) | |
1873 | (setcar lap1 (car tmp2)) | |
1874 | (setcdr lap1 (cdr tmp2)) | |
1875 | ;; Let next step fix the (const,goto-if*) sequence. | |
1876 | (setq rest (cons nil rest))) | |
1877 | (t | |
1878 | ;; Jump one step further | |
1879 | (byte-compile-log-lap | |
1880 | " %s goto [%s]\t-->\t<deleted> goto <skip>" | |
1881 | lap0 tmp2) | |
1882 | (or (eq 'TAG (car (nth 1 tmp))) | |
1883 | (setcdr tmp (cons (byte-compile-make-tag) | |
1884 | (cdr tmp)))) | |
1885 | (setcdr lap1 (car (cdr tmp))) | |
1886 | (setq lap (delq lap0 lap)))) | |
1887 | (setq keep-going t)) | |
1888 | ;; | |
1889 | ;; X: varref-Y ... varset-Y goto-X --> | |
1890 | ;; X: varref-Y Z: ... dup varset-Y goto-Z | |
1891 | ;; (varset-X goto-BACK, BACK: varref-X --> copy the varref down.) | |
1892 | ;; (This is so usual for while loops that it is worth handling). | |
1893 | ;; | |
1894 | ((and (eq (car lap1) 'byte-varset) | |
1895 | (eq (car lap2) 'byte-goto) | |
1896 | (not (memq (cdr lap2) rest)) ;Backwards jump | |
1897 | (eq (car (car (setq tmp (cdr (memq (cdr lap2) lap))))) | |
1898 | 'byte-varref) | |
1899 | (eq (cdr (car tmp)) (cdr lap1)) | |
1900 | (not (memq (car (cdr lap1)) byte-boolean-vars))) | |
1901 | ;;(byte-compile-log-lap " Pulled %s to end of loop" (car tmp)) | |
1902 | (let ((newtag (byte-compile-make-tag))) | |
1903 | (byte-compile-log-lap | |
1904 | " %s: %s ... %s %s\t-->\t%s: %s %s: ... %s %s %s" | |
1905 | (nth 1 (cdr lap2)) (car tmp) | |
1906 | lap1 lap2 | |
1907 | (nth 1 (cdr lap2)) (car tmp) | |
1908 | (nth 1 newtag) 'byte-dup lap1 | |
1909 | (cons 'byte-goto newtag) | |
1910 | ) | |
1911 | (setcdr rest (cons (cons 'byte-dup 0) (cdr rest))) | |
1912 | (setcdr tmp (cons (setcdr lap2 newtag) (cdr tmp)))) | |
1913 | (setq add-depth 1) | |
1914 | (setq keep-going t)) | |
1915 | ;; | |
1916 | ;; goto-X Y: ... X: goto-if*-Y --> goto-if-not-*-X+1 Y: | |
1917 | ;; (This can pull the loop test to the end of the loop) | |
1918 | ;; | |
1919 | ((and (eq (car lap0) 'byte-goto) | |
1920 | (eq (car lap1) 'TAG) | |
1921 | (eq lap1 | |
1922 | (cdr (car (setq tmp (cdr (memq (cdr lap0) lap)))))) | |
1923 | (memq (car (car tmp)) | |
1924 | '(byte-goto byte-goto-if-nil byte-goto-if-not-nil | |
1925 | byte-goto-if-nil-else-pop))) | |
1926 | ;; (byte-compile-log-lap " %s %s, %s %s --> moved conditional" | |
1927 | ;; lap0 lap1 (cdr lap0) (car tmp)) | |
1928 | (let ((newtag (byte-compile-make-tag))) | |
1929 | (byte-compile-log-lap | |
1930 | "%s %s: ... %s: %s\t-->\t%s ... %s:" | |
1931 | lap0 (nth 1 lap1) (nth 1 (cdr lap0)) (car tmp) | |
1932 | (cons (cdr (assq (car (car tmp)) | |
1933 | '((byte-goto-if-nil . byte-goto-if-not-nil) | |
1934 | (byte-goto-if-not-nil . byte-goto-if-nil) | |
1935 | (byte-goto-if-nil-else-pop . | |
1936 | byte-goto-if-not-nil-else-pop) | |
1937 | (byte-goto-if-not-nil-else-pop . | |
1938 | byte-goto-if-nil-else-pop)))) | |
1939 | newtag) | |
a1506d29 | 1940 | |
1c393159 JB |
1941 | (nth 1 newtag) |
1942 | ) | |
1943 | (setcdr tmp (cons (setcdr lap0 newtag) (cdr tmp))) | |
1944 | (if (eq (car (car tmp)) 'byte-goto-if-nil-else-pop) | |
1945 | ;; We can handle this case but not the -if-not-nil case, | |
1946 | ;; because we won't know which non-nil constant to push. | |
1947 | (setcdr rest (cons (cons 'byte-constant | |
1948 | (byte-compile-get-constant nil)) | |
1949 | (cdr rest)))) | |
1950 | (setcar lap0 (nth 1 (memq (car (car tmp)) | |
1951 | '(byte-goto-if-nil-else-pop | |
1952 | byte-goto-if-not-nil | |
1953 | byte-goto-if-nil | |
1954 | byte-goto-if-not-nil | |
1955 | byte-goto byte-goto)))) | |
1956 | ) | |
1957 | (setq keep-going t)) | |
1958 | ) | |
1959 | (setq rest (cdr rest))) | |
1960 | ) | |
1961 | ;; Cleanup stage: | |
1962 | ;; Rebuild byte-compile-constants / byte-compile-variables. | |
1963 | ;; Simple optimizations that would inhibit other optimizations if they | |
1964 | ;; were done in the optimizing loop, and optimizations which there is no | |
1965 | ;; need to do more than once. | |
1966 | (setq byte-compile-constants nil | |
1967 | byte-compile-variables nil) | |
1968 | (setq rest lap) | |
1969 | (while rest | |
1970 | (setq lap0 (car rest) | |
1971 | lap1 (nth 1 rest)) | |
1972 | (if (memq (car lap0) byte-constref-ops) | |
3ecf67a1 GM |
1973 | (if (or (eq (car lap0) 'byte-constant) |
1974 | (eq (car lap0) 'byte-constant2)) | |
1975 | (unless (memq (cdr lap0) byte-compile-constants) | |
1c393159 | 1976 | (setq byte-compile-constants (cons (cdr lap0) |
3ecf67a1 GM |
1977 | byte-compile-constants))) |
1978 | (unless (memq (cdr lap0) byte-compile-variables) | |
1979 | (setq byte-compile-variables (cons (cdr lap0) | |
1980 | byte-compile-variables))))) | |
1c393159 JB |
1981 | (cond (;; |
1982 | ;; const-C varset-X const-C --> const-C dup varset-X | |
1983 | ;; const-C varbind-X const-C --> const-C dup varbind-X | |
1984 | ;; | |
1985 | (and (eq (car lap0) 'byte-constant) | |
1986 | (eq (car (nth 2 rest)) 'byte-constant) | |
3ecf67a1 | 1987 | (eq (cdr lap0) (cdr (nth 2 rest))) |
1c393159 JB |
1988 | (memq (car lap1) '(byte-varbind byte-varset))) |
1989 | (byte-compile-log-lap " %s %s %s\t-->\t%s dup %s" | |
1990 | lap0 lap1 lap0 lap0 lap1) | |
1991 | (setcar (cdr (cdr rest)) (cons (car lap1) (cdr lap1))) | |
1992 | (setcar (cdr rest) (cons 'byte-dup 0)) | |
1993 | (setq add-depth 1)) | |
1994 | ;; | |
1995 | ;; const-X [dup/const-X ...] --> const-X [dup ...] dup | |
1996 | ;; varref-X [dup/varref-X ...] --> varref-X [dup ...] dup | |
1997 | ;; | |
1998 | ((memq (car lap0) '(byte-constant byte-varref)) | |
1999 | (setq tmp rest | |
2000 | tmp2 nil) | |
2001 | (while (progn | |
2002 | (while (eq 'byte-dup (car (car (setq tmp (cdr tmp)))))) | |
2003 | (and (eq (cdr lap0) (cdr (car tmp))) | |
2004 | (eq (car lap0) (car (car tmp))))) | |
2005 | (setcar tmp (cons 'byte-dup 0)) | |
2006 | (setq tmp2 t)) | |
2007 | (if tmp2 | |
2008 | (byte-compile-log-lap | |
dec4e22e | 2009 | " %s [dup/%s]...\t-->\t%s dup..." lap0 lap0 lap0))) |
1c393159 JB |
2010 | ;; |
2011 | ;; unbind-N unbind-M --> unbind-(N+M) | |
2012 | ;; | |
2013 | ((and (eq 'byte-unbind (car lap0)) | |
2014 | (eq 'byte-unbind (car lap1))) | |
2015 | (byte-compile-log-lap " %s %s\t-->\t%s" lap0 lap1 | |
2016 | (cons 'byte-unbind | |
2017 | (+ (cdr lap0) (cdr lap1)))) | |
2018 | (setq keep-going t) | |
2019 | (setq lap (delq lap0 lap)) | |
2020 | (setcdr lap1 (+ (cdr lap1) (cdr lap0)))) | |
2021 | ) | |
2022 | (setq rest (cdr rest))) | |
2023 | (setq byte-compile-maxdepth (+ byte-compile-maxdepth add-depth))) | |
2024 | lap) | |
2025 | ||
1ffa4286 | 2026 | (provide 'byte-opt) |
1c393159 JB |
2027 | |
2028 | \f | |
2029 | ;; To avoid "lisp nesting exceeds max-lisp-eval-depth" when this file compiles | |
2030 | ;; itself, compile some of its most used recursive functions (at load time). | |
2031 | ;; | |
2032 | (eval-when-compile | |
96d699f3 | 2033 | (or (byte-code-function-p (symbol-function 'byte-optimize-form)) |
1c393159 JB |
2034 | (assq 'byte-code (symbol-function 'byte-optimize-form)) |
2035 | (let ((byte-optimize nil) | |
2036 | (byte-compile-warnings nil)) | |
988e2906 GM |
2037 | (mapc (lambda (x) |
2038 | (or noninteractive (message "compiling %s..." x)) | |
2039 | (byte-compile x) | |
2040 | (or noninteractive (message "compiling %s...done" x))) | |
2041 | '(byte-optimize-form | |
2042 | byte-optimize-body | |
2043 | byte-optimize-predicate | |
2044 | byte-optimize-binary-predicate | |
2045 | ;; Inserted some more than necessary, to speed it up. | |
2046 | byte-optimize-form-code-walker | |
2047 | byte-optimize-lapcode)))) | |
1c393159 | 2048 | nil) |
3eac9910 | 2049 | |
f61b7b7f | 2050 | ;; arch-tag: 0f14076b-737e-4bef-aae6-908826ec1ff1 |
3eac9910 | 2051 | ;;; byte-opt.el ends here |