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