1 ;;; byte-optimize.el --- the optimization passes of the emacs-lisp byte compiler.
3 ;;; Copyright (c) 1991, 1994 Free Software Foundation, Inc.
5 ;; Author: Jamie Zawinski <jwz@jwz.org>
6 ;; Hallvard Furuseth <hbf@ulrik.uio.no>
9 ;; This file is part of XEmacs.
11 ;; XEmacs is free software; you can redistribute it and/or modify it
12 ;; under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation; either version 2, or (at your option)
16 ;; XEmacs is distributed in the hope that it will be useful, but
17 ;; WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
19 ;; General Public License for more details.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with XEmacs; 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.
26 ;;; Synched up with: FSF 20.7.
30 ;; ========================================================================
31 ;; "No matter how hard you try, you can't make a racehorse out of a pig.
32 ;; You can, however, make a faster pig."
34 ;; Or, to put it another way, the emacs byte compiler is a VW Bug. This code
35 ;; makes it be a VW Bug with fuel injection and a turbocharger... You're
36 ;; still not going to make it go faster than 70 mph, but it might be easier
42 ;; (apply #'(lambda (x &rest y) ...) 1 (foo))
44 ;; maintain a list of functions known not to access any global variables
45 ;; (actually, give them a 'dynamically-safe property) and then
46 ;; (let ( v1 v2 ... vM vN ) <...dynamically-safe...> ) ==>
47 ;; (let ( v1 v2 ... vM ) vN <...dynamically-safe...> )
48 ;; by recursing on this, we might be able to eliminate the entire let.
49 ;; However certain variables should never have their bindings optimized
50 ;; away, because they affect everything.
51 ;; (put 'debug-on-error 'binding-is-magic t)
52 ;; (put 'debug-on-abort 'binding-is-magic t)
53 ;; (put 'debug-on-next-call 'binding-is-magic t)
54 ;; (put 'mocklisp-arguments 'binding-is-magic t)
55 ;; (put 'inhibit-quit 'binding-is-magic t)
56 ;; (put 'quit-flag 'binding-is-magic t)
57 ;; (put 't 'binding-is-magic t)
58 ;; (put 'nil 'binding-is-magic t)
60 ;; (put 'gc-cons-threshold 'binding-is-magic t)
61 ;; (put 'track-mouse 'binding-is-magic t)
64 ;; Simple defsubsts often produce forms like
65 ;; (let ((v1 (f1)) (v2 (f2)) ...)
67 ;; It would be nice if we could optimize this to
69 ;; but we can't unless FN is dynamically-safe (it might be dynamically
70 ;; referring to the bindings that the lambda arglist established.)
71 ;; One of the uncountable lossages introduced by dynamic scope...
73 ;; Maybe there should be a control-structure that says "turn on
74 ;; fast-and-loose type-assumptive optimizations here." Then when
75 ;; we see a form like (car foo) we can from then on assume that
76 ;; the variable foo is of type cons, and optimize based on that.
77 ;; But, this won't win much because of (you guessed it) dynamic
78 ;; scope. Anything down the stack could change the value.
79 ;; (Another reason it doesn't work is that it is perfectly valid
80 ;; to call car with a null argument.) A better approach might
81 ;; be to allow type-specification of the form
82 ;; (put 'foo 'arg-types '(float (list integer) dynamic))
83 ;; (put 'foo 'result-type 'bool)
84 ;; It should be possible to have these types checked to a certain
87 ;; collapse common subexpressions
89 ;; It would be nice if redundant sequences could be factored out as well,
90 ;; when they are known to have no side-effects:
91 ;; (list (+ a b c) (+ a b c)) --> a b add c add dup list-2
92 ;; but beware of traps like
93 ;; (cons (list x y) (list x y))
95 ;; Tail-recursion elimination is not really possible in Emacs Lisp.
96 ;; Tail-recursion elimination is almost always impossible when all variables
97 ;; have dynamic scope, but given that the "return" byteop requires the
98 ;; binding stack to be empty (rather than emptying it itself), there can be
99 ;; no truly tail-recursive Emacs Lisp functions that take any arguments or
100 ;; make any bindings.
102 ;; Here is an example of an Emacs Lisp function which could safely be
103 ;; byte-compiled tail-recursively:
105 ;; (defun tail-map (fn list)
107 ;; (funcall fn (car list))
108 ;; (tail-map fn (cdr list)))))
110 ;; However, if there was even a single let-binding around the COND,
111 ;; it could not be byte-compiled, because there would be an "unbind"
112 ;; byte-op between the final "call" and "return." Adding a
113 ;; Bunbind_all byteop would fix this.
115 ;; (defun foo (x y z) ... (foo a b c))
116 ;; ... (const foo) (varref a) (varref b) (varref c) (call 3) END: (return)
117 ;; ... (varref a) (varbind x) (varref b) (varbind y) (varref c) (varbind z) (goto 0) END: (unbind-all) (return)
118 ;; ... (varref a) (varset x) (varref b) (varset y) (varref c) (varset z) (goto 0) END: (return)
120 ;; this also can be considered tail recursion:
122 ;; ... (const foo) (varref a) (call 1) (goto X) ... X: (return)
123 ;; could generalize this by doing the optimization
124 ;; (goto X) ... X: (return) --> (return)
126 ;; But this doesn't solve all of the problems: although by doing tail-
127 ;; recursion elimination in this way, the call-stack does not grow, the
128 ;; binding-stack would grow with each recursive step, and would eventually
129 ;; overflow. I don't believe there is any way around this without lexical
132 ;; Wouldn't it be nice if Emacs Lisp had lexical scope.
134 ;; Idea: the form (lexical-scope) in a file means that the file may be
135 ;; compiled lexically. This proclamation is file-local. Then, within
136 ;; that file, "let" would establish lexical bindings, and "let-dynamic"
137 ;; would do things the old way. (Or we could use CL "declare" forms.)
138 ;; We'd have to notice defvars and defconsts, since those variables should
139 ;; always be dynamic, and attempting to do a lexical binding of them
140 ;; should simply do a dynamic binding instead.
141 ;; But! We need to know about variables that were not necessarily defvarred
142 ;; in the file being compiled (doing a boundp check isn't good enough.)
143 ;; Fdefvar() would have to be modified to add something to the plist.
145 ;; A major disadvantage of this scheme is that the interpreter and compiler
146 ;; would have different semantics for files compiled with (dynamic-scope).
147 ;; Since this would be a file-local optimization, there would be no way to
148 ;; modify the interpreter to obey this (unless the loader was hacked
149 ;; in some grody way, but that's a really bad idea.)
151 ;; HA! RMS removed the following paragraph from his version of
154 ;; Really the Right Thing is to make lexical scope the default across
155 ;; the board, in the interpreter and compiler, and just FIX all of
156 ;; the code that relies on dynamic scope of non-defvarred variables.
158 ;; Other things to consider:
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)
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.
168 ;;(disassemble #'(lambda (x) (and (point) (foo))))
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:
177 ;;(disassemble #'(lambda (x) (eq (if (point) 'a 'b) 'c)))
178 ;;(disassemble #'(lambda (x) (if (point) (eq 'a 'c) (eq 'b 'c))))
180 ;; (car (cons A B)) -> (prog1 A B)
181 ;;(disassemble #'(lambda (x) (car (cons (foo) 42))))
183 ;; (cdr (cons A B)) -> (progn A B)
184 ;;(disassemble #'(lambda (x) (cdr (cons 42 (foo)))))
186 ;; (car (list A B ...)) -> (prog1 A ... B)
187 ;;(disassemble #'(lambda (x) (car (list (foo) 42 (bar)))))
189 ;; (cdr (list A B ...)) -> (progn A (list B ...))
190 ;;(disassemble #'(lambda (x) (cdr (list 42 (foo) (bar)))))
195 (require 'byte-compile "bytecomp")
197 (defun byte-compile-log-lap-1 (format &rest args)
198 (if (aref byte-code-vector 0)
199 (error "The old version of the disassembler is loaded. Reload new-bytecomp as well."))
201 (apply 'format format
205 (if (not (consp arg))
206 (if (and (symbolp arg)
207 (string-match "^byte-" (symbol-name arg)))
208 (intern (substring (symbol-name arg) 5))
210 (if (integerp (setq c (car arg)))
211 (error "non-symbolic byte-op %s" c))
214 (setq a (cond ((memq c byte-goto-ops)
215 (car (cdr (cdr arg))))
216 ((memq c byte-constref-ops)
219 (setq c (symbol-name c))
220 (if (string-match "^byte-." c)
221 (setq c (intern (substring c 5)))))
222 (if (eq c 'constant) (setq c 'const))
223 (if (and (eq (cdr arg) 0)
224 (not (memq c '(unbind call const))))
226 (format "(%s %s)" c a))))
229 (defmacro byte-compile-log-lap (format-string &rest args)
231 '(memq byte-optimize-log '(t byte))
232 (cons 'byte-compile-log-lap-1
233 (cons format-string args))))
236 ;;; byte-compile optimizers to support inlining
238 (put 'inline 'byte-optimizer 'byte-optimize-inline-handler)
240 (defun byte-optimize-inline-handler (form)
241 "byte-optimize-handler for the `inline' special-form."
246 (let ((fn (car-safe sexp)))
247 (if (and (symbolp fn)
248 (or (cdr (assq fn byte-compile-function-environment))
250 (not (or (cdr (assq fn byte-compile-macro-environment))
251 (and (consp (setq fn (symbol-function fn)))
252 (eq (car fn) 'macro))
254 (byte-compile-inline-expand sexp)
259 ;; Splice the given lap code into the current instruction stream.
260 ;; If it has any labels in it, you're responsible for making sure there
261 ;; are no collisions, and that byte-compile-tag-number is reasonable
262 ;; after this is spliced in. The provided list is destroyed.
263 (defun byte-inline-lapcode (lap)
264 (setq byte-compile-output (nconc (nreverse lap) byte-compile-output)))
267 (defun byte-compile-inline-expand (form)
268 (let* ((name (car form))
269 (fn (or (cdr (assq name byte-compile-function-environment))
270 (and (fboundp name) (symbol-function name)))))
273 (byte-compile-warn "attempt to inline %s before it was defined" name)
276 (if (and (consp fn) (eq (car fn) 'autoload))
279 (setq fn (or (cdr (assq name byte-compile-function-environment))
280 (and (fboundp name) (symbol-function name))))))
281 (if (and (consp fn) (eq (car fn) 'autoload))
282 (error "file \"%s\" didn't define \"%s\"" (nth 1 fn) name))
284 (byte-compile-inline-expand (cons fn (cdr form)))
285 (if (compiled-function-p fn)
288 (cons (list 'lambda (compiled-function-arglist fn)
290 (compiled-function-instructions fn)
291 (compiled-function-constants fn)
292 (compiled-function-stack-depth fn)))
294 (if (not (eq (car fn) 'lambda)) (error "%s is not a lambda" name))
295 (cons fn (cdr form)))))))
297 ;;; ((lambda ...) ...)
299 (defun byte-compile-unfold-lambda (form &optional name)
300 (or name (setq name "anonymous lambda"))
301 (let ((lambda (car form))
303 (if (compiled-function-p lambda)
304 (setq lambda (list 'lambda (compiled-function-arglist lambda)
306 (compiled-function-instructions lambda)
307 (compiled-function-constants lambda)
308 (compiled-function-stack-depth lambda)))))
309 (let ((arglist (nth 1 lambda))
310 (body (cdr (cdr lambda)))
313 (if (and (stringp (car body)) (cdr body))
314 (setq body (cdr body)))
315 (if (and (consp (car body)) (eq 'interactive (car (car body))))
316 (setq body (cdr body)))
318 (cond ((eq (car arglist) '&optional)
319 ;; ok, I'll let this slide because funcall_lambda() does...
320 ;; (if optionalp (error "multiple &optional keywords in %s" name))
321 (if restp (error "&optional found after &rest in %s" name))
322 (if (null (cdr arglist))
323 (error "nothing after &optional in %s" name))
325 ((eq (car arglist) '&rest)
326 ;; ...but it is by no stretch of the imagination a reasonable
327 ;; thing that funcall_lambda() allows (&rest x y) and
328 ;; (&rest x &optional y) in arglists.
329 (if (null (cdr arglist))
330 (error "nothing after &rest in %s" name))
331 (if (cdr (cdr arglist))
332 (error "multiple vars after &rest in %s" name))
335 (setq bindings (cons (list (car arglist)
336 (and values (cons 'list values)))
339 ((and (not optionalp) (null values))
340 (byte-compile-warn "attempt to open-code %s with too few arguments" name)
341 (setq arglist nil values 'too-few))
343 (setq bindings (cons (list (car arglist) (car values))
345 values (cdr values))))
346 (setq arglist (cdr arglist)))
349 (or (eq values 'too-few)
351 "attempt to open-code %s with too many arguments" name))
355 (cons 'let (cons (nreverse bindings) body))
356 (cons 'progn body))))
357 (byte-compile-log " %s\t==>\t%s" form newform)
361 ;;; implementing source-level optimizers
363 (defun byte-optimize-form-code-walker (form for-effect)
365 ;; For normal function calls, We can just mapcar the optimizer the cdr. But
366 ;; we need to have special knowledge of the syntax of the special forms
367 ;; like let and defun (that's why they're special forms :-). (Actually,
368 ;; the important aspect is that they are subrs that don't evaluate all of
371 (let ((fn (car-safe form))
373 (cond ((not (consp form))
374 (if (not (and for-effect
375 (or byte-compile-delete-errors
381 (byte-compile-warn "malformed quote form: %s"
382 (prin1-to-string form)))
383 ;; map (quote nil) to nil to simplify optimizer logic.
384 ;; map quoted constants to nil if for-effect (just because).
388 ((or (compiled-function-p fn)
389 (eq 'lambda (car-safe fn)))
390 (byte-compile-unfold-lambda form))
391 ((memq fn '(let let*))
392 ;; recursively enter the optimizer for the bindings and body
393 ;; of a let or let*. This for depth-firstness: forms that
394 ;; are more deeply nested are optimized first.
399 (if (symbolp binding)
401 (if (cdr (cdr binding))
402 (byte-compile-warn "malformed let binding: %s"
403 (prin1-to-string binding)))
405 (byte-optimize-form (nth 1 binding) nil))))
407 (byte-optimize-body (cdr (cdr form)) for-effect))))
414 (byte-optimize-form (car clause) nil)
415 (byte-optimize-body (cdr clause) for-effect))
416 (byte-compile-warn "malformed cond form: %s"
417 (prin1-to-string clause))
421 ;; as an extra added bonus, this simplifies (progn <x>) --> <x>
424 (setq tmp (byte-optimize-body (cdr form) for-effect))
425 (if (cdr tmp) (cons 'progn tmp) (car tmp)))
426 (byte-optimize-form (nth 1 form) for-effect)))
430 (cons (byte-optimize-form (nth 1 form) for-effect)
431 (byte-optimize-body (cdr (cdr form)) t)))
432 (byte-optimize-form (nth 1 form) for-effect)))
435 (cons (byte-optimize-form (nth 1 form) t)
436 (cons (byte-optimize-form (nth 2 form) for-effect)
437 (byte-optimize-body (cdr (cdr (cdr form))) t)))))
439 ((memq fn '(save-excursion save-restriction save-current-buffer))
440 ;; those subrs which have an implicit progn; it's not quite good
441 ;; enough to treat these like normal function calls.
442 ;; This can turn (save-excursion ...) into (save-excursion) which
443 ;; will be optimized away in the lap-optimize pass.
444 (cons fn (byte-optimize-body (cdr form) for-effect)))
446 ((eq fn 'with-output-to-temp-buffer)
447 ;; this is just like the above, except for the first argument.
450 (byte-optimize-form (nth 1 form) nil)
451 (byte-optimize-body (cdr (cdr form)) for-effect))))
455 (cons (byte-optimize-form (nth 1 form) nil)
457 (byte-optimize-form (nth 2 form) for-effect)
458 (byte-optimize-body (nthcdr 3 form) for-effect)))))
460 ((memq fn '(and or)) ; remember, and/or are control structures.
461 ;; take forms off the back until we can't any more.
462 ;; In the future it could conceivably be a problem that the
463 ;; subexpressions of these forms are optimized in the reverse
464 ;; order, but it's ok for now.
466 (let ((backwards (reverse (cdr form))))
467 (while (and backwards
468 (null (setcar backwards
469 (byte-optimize-form (car backwards)
471 (setq backwards (cdr backwards)))
472 (if (and (cdr form) (null backwards))
474 " all subforms of %s called for effect; deleted" form))
476 ;; Now optimize the rest of the forms. We need the return
477 ;; values. We already did the car.
479 (mapcar 'byte-optimize-form (cdr backwards)))
480 (cons fn (nreverse backwards))))
481 (cons fn (mapcar 'byte-optimize-form (cdr form)))))
483 ((eq fn 'interactive)
484 (byte-compile-warn "misplaced interactive spec: %s"
485 (prin1-to-string form))
488 ((memq fn '(defun defmacro function
489 condition-case save-window-excursion))
490 ;; These forms are compiled as constants or by breaking out
491 ;; all the subexpressions and compiling them separately.
494 ((eq fn 'unwind-protect)
495 ;; the "protected" part of an unwind-protect is compiled (and thus
496 ;; optimized) as a top-level form, so don't do it here. But the
497 ;; non-protected part has the same for-effect status as the
498 ;; unwind-protect itself. (The protected part is always for effect,
499 ;; but that isn't handled properly yet.)
501 (cons (byte-optimize-form (nth 1 form) for-effect)
505 ;; the body of a catch is compiled (and thus optimized) as a
506 ;; top-level form, so don't do it here. The tag is never
507 ;; for-effect. The body should have the same for-effect status
508 ;; as the catch form itself, but that isn't handled properly yet.
510 (cons (byte-optimize-form (nth 1 form) nil)
513 ;; If optimization is on, this is the only place that macros are
514 ;; expanded. If optimization is off, then macroexpansion happens
515 ;; in byte-compile-form. Otherwise, the macros are already expanded
516 ;; by the time that is reached.
518 (setq form (macroexpand form
519 byte-compile-macro-environment))))
520 (byte-optimize-form form for-effect))
523 (or (eq 'mocklisp (car-safe fn)) ; ha!
524 (byte-compile-warn "%s is a malformed function"
525 (prin1-to-string fn)))
528 ((and for-effect (setq tmp (get fn 'side-effect-free))
529 (or byte-compile-delete-errors
532 (byte-compile-warn "%s called for effect"
533 (prin1-to-string form))
535 (byte-compile-log " %s called for effect; deleted" fn)
536 ;; appending a nil here might not be necessary, but it can't hurt.
538 (cons 'progn (append (cdr form) '(nil))) t))
541 ;; Otherwise, no args can be considered to be for-effect,
542 ;; even if the called function is for-effect, because we
543 ;; don't know anything about that function.
544 (cons fn (mapcar 'byte-optimize-form (cdr form)))))))
547 (defun byte-optimize-form (form &optional for-effect)
548 "The source-level pass of the optimizer."
550 ;; First, optimize all sub-forms of this one.
551 (setq form (byte-optimize-form-code-walker form for-effect))
553 ;; After optimizing all subforms, optimize this form until it doesn't
554 ;; optimize any further. This means that some forms will be passed through
555 ;; the optimizer many times, but that's necessary to make the for-effect
556 ;; processing do as much as possible.
559 (if (and (consp form)
562 ;; we don't have any of these yet, but we might.
563 (setq opt (get (car form) 'byte-for-effect-optimizer)))
564 (setq opt (get (car form) 'byte-optimizer)))
565 (not (eq form (setq new (funcall opt form)))))
567 ;; (if (equal form new) (error "bogus optimizer -- %s" opt))
568 (byte-compile-log " %s\t==>\t%s" form new)
569 (setq new (byte-optimize-form new for-effect))
574 (defun byte-optimize-body (forms all-for-effect)
575 ;; Optimize the cdr of a progn or implicit progn; `forms' is a list of
576 ;; forms, all but the last of which are optimized with the assumption that
577 ;; they are being called for effect. The last is for-effect as well if
578 ;; all-for-effect is true. Returns a new list of forms.
583 (setq fe (or all-for-effect (cdr rest)))
584 (setq new (and (car rest) (byte-optimize-form (car rest) fe)))
585 (if (or new (not fe))
586 (setq result (cons new result)))
587 (setq rest (cdr rest)))
591 ;;; some source-level optimizers
593 ;;; when writing optimizers, be VERY careful that the optimizer returns
594 ;;; something not EQ to its argument if and ONLY if it has made a change.
595 ;;; This implies that you cannot simply destructively modify the list;
596 ;;; you must return something not EQ to it if you make an optimization.
598 ;;; It is now safe to optimize code such that it introduces new bindings.
600 ;; I'd like this to be a defsubst, but let's not be self-referential...
601 (defmacro byte-compile-trueconstp (form)
602 ;; Returns non-nil if FORM is a non-nil constant.
603 `(cond ((consp ,form) (eq (car ,form) 'quote))
604 ((not (symbolp ,form)))
608 ;; If the function is being called with constant numeric args,
609 ;; evaluate as much as possible at compile-time. This optimizer
610 ;; assumes that the function is associative, like + or *.
611 (defun byte-optimize-associative-math (form)
616 (if (numberp (car rest))
617 (setq constants (cons (car rest) constants))
618 (setq args (cons (car rest) args)))
619 (setq rest (cdr rest)))
623 (apply (car form) constants)
625 (cons (car form) (nreverse args))
627 (apply (car form) constants))
630 ;; If the function is being called with constant numeric args,
631 ;; evaluate as much as possible at compile-time. This optimizer
632 ;; assumes that the function satisfies
633 ;; (op x1 x2 ... xn) == (op ...(op (op x1 x2) x3) ...xn)
635 (defun byte-optimize-nonassociative-math (form)
636 (if (or (not (numberp (car (cdr form))))
637 (not (numberp (car (cdr (cdr form))))))
639 (let ((constant (car (cdr form)))
640 (rest (cdr (cdr form))))
641 (while (numberp (car rest))
642 (setq constant (funcall (car form) constant (car rest))
645 (cons (car form) (cons constant rest))
648 ;;(defun byte-optimize-associative-two-args-math (form)
649 ;; (setq form (byte-optimize-associative-math form))
651 ;; (byte-optimize-two-args-left form)
654 ;;(defun byte-optimize-nonassociative-two-args-math (form)
655 ;; (setq form (byte-optimize-nonassociative-math form))
657 ;; (byte-optimize-two-args-right form)
660 ;; jwz: (byte-optimize-approx-equal 0.0 0.0) was returning nil
661 ;; in xemacs 19.15 because it used < instead of <=.
662 (defun byte-optimize-approx-equal (x y)
663 (<= (* (abs (- x y)) 100) (abs (+ x y))))
665 ;; Collect all the constants from FORM, after the STARTth arg,
666 ;; and apply FUN to them to make one argument at the end.
667 ;; For functions that can handle floats, that optimization
668 ;; can be incorrect because reordering can cause an overflow
669 ;; that would otherwise be avoided by encountering an arg that is a float.
670 ;; We avoid this problem by (1) not moving float constants and
671 ;; (2) not moving anything if it would cause an overflow.
672 (defun byte-optimize-delay-constants-math (form start fun)
673 ;; Merge all FORM's constants from number START, call FUN on them
674 ;; and put the result at the end.
675 (let ((rest (nthcdr (1- start) form))
677 ;; t means we must check for overflow.
678 (overflow (memq fun '(+ *))))
679 (while (cdr (setq rest (cdr rest)))
680 (if (integerp (car rest))
682 (setq form (copy-sequence form)
683 rest (nthcdr (1- start) form))
684 (while (setq rest (cdr rest))
685 (cond ((integerp (car rest))
686 (setq constants (cons (car rest) constants))
688 ;; If necessary, check now for overflow
689 ;; that might be caused by reordering.
691 ;; We have overflow if the result of doing the arithmetic
692 ;; on floats is not even close to the result
693 ;; of doing it on integers.
694 (not (byte-optimize-approx-equal
695 (apply fun (mapcar 'float constants))
696 (float (apply fun constants)))))
698 (setq form (nconc (delq nil form)
699 (list (apply fun (nreverse constants)))))))))
702 (defun byte-optimize-plus (form)
703 (setq form (byte-optimize-delay-constants-math form 1 '+))
704 (if (memq 0 form) (setq form (delq 0 (copy-sequence form))))
705 ;;(setq form (byte-optimize-associative-two-args-math form))
707 (case (length (cdr form))
713 ;; It is not safe to delete the function entirely
714 ;; (actually, it would be safe if we knew the sole arg
720 (byte-optimize-predicate
722 ;; `add1' and `sub1' are a marginally fewer instructions
723 ;; than `plus' and `minus', so use them when possible.
724 ((eq (nth 1 form) 1) `(1+ ,(nth 2 form))) ; (+ 1 x) --> (1+ x)
725 ((eq (nth 2 form) 1) `(1+ ,(nth 1 form))) ; (+ x 1) --> (1+ x)
726 ((eq (nth 1 form) -1) `(1- ,(nth 2 form))) ; (+ -1 x) --> (1- x)
727 ((eq (nth 2 form) -1) `(1- ,(nth 1 form))) ; (+ x -1) --> (1- x)
730 (t (byte-optimize-predicate form))))
732 (defun byte-optimize-minus (form)
733 ;; Put constants at the end, except the last constant.
734 (setq form (byte-optimize-delay-constants-math form 2 '+))
735 ;; Now only first and last element can be an integer.
736 (let ((last (last (nthcdr 3 form))))
738 ;; (- x y ... 0) --> (- x y ...)
739 (setq form (copy-sequence form))
740 (setcdr (cdr (cdr form)) (delq 0 (nthcdr 3 form))))
741 ;; If form is (- CONST foo... CONST), merge first and last.
742 ((and (numberp (nth 1 form))
744 (setq form (nconc (list '- (- (nth 1 form) last) (nth 2 form))
745 (delq last (copy-sequence (nthcdr 3 form))))))))
747 (case (length (cdr form))
753 ;; It is not safe to delete the function entirely
754 ;; (actually, it would be safe if we knew the sole arg
760 (byte-optimize-predicate
762 ;; `add1' and `sub1' are a marginally fewer instructions than `plus'
763 ;; and `minus', so use them when possible.
764 ((eq (nth 2 form) 1) `(1- ,(nth 1 form))) ; (- x 1) --> (1- x)
765 ((eq (nth 2 form) -1) `(1+ ,(nth 1 form))) ; (- x -1) --> (1+ x)
766 ((eq (nth 1 form) 0) `(- ,(nth 2 form))) ; (- 0 x) --> (- x)
769 (t (byte-optimize-predicate form))))
771 (defun byte-optimize-multiply (form)
772 (setq form (byte-optimize-delay-constants-math form 1 '*))
773 ;; If there is a constant integer in FORM, it is now the last element.
774 (cond ((null (cdr form)) 1)
775 ;;; It is not safe to delete the function entirely
776 ;;; (actually, it would be safe if we know the sole arg
777 ;;; is not a marker or if it appears in other arithmetic).
778 ;;; ((null (cdr (cdr form))) (nth 1 form))
779 ((let ((last (last form)))
780 (byte-optimize-predicate
781 (cond ((eq 0 last) (cons 'progn (cdr form)))
782 ((eq 1 last) (delq 1 (copy-sequence form)))
783 ((eq -1 last) (list '- (delq -1 (copy-sequence form))))
785 (memq t (mapcar 'symbolp (cdr form))))
786 (prog1 (setq form (delq 2 (copy-sequence form)))
787 (while (not (symbolp (car (setq form (cdr form))))))
788 (setcar form (list '+ (car form) (car form)))))
791 (defun byte-optimize-divide (form)
792 (setq form (byte-optimize-delay-constants-math form 2 '*))
793 ;; If there is a constant integer in FORM, it is now the last element.
794 (let ((last (last (cdr (cdr form)))))
796 (cond ((= (length form) 3)
797 (if (and (numberp (nth 1 form))
800 (/ (nth 1 form) last)
802 (setq form (list 'progn (/ (nth 1 form) last)))))
804 (setq form (butlast form)))
805 ((numberp (nth 1 form))
806 (setq form (cons (car form)
807 (cons (/ (nth 1 form) last)
808 (butlast (cdr (cdr form)))))
811 ;;; ((null (cdr (cdr form)))
814 (append '(progn) (cdr (cdr form)) '(0)))
816 (list '- (if (nthcdr 3 form)
821 (defun byte-optimize-logmumble (form)
822 (setq form (byte-optimize-delay-constants-math form 1 (car form)))
823 (byte-optimize-predicate
825 (setq form (if (eq (car form) 'logand)
826 (cons 'progn (cdr form))
827 (delq 0 (copy-sequence form)))))
828 ((and (eq (car-safe form) 'logior)
830 (cons 'progn (cdr form)))
834 (defun byte-optimize-binary-predicate (form)
835 (if (byte-compile-constp (nth 1 form))
836 (if (byte-compile-constp (nth 2 form))
838 (list 'quote (eval form))
840 ;; This can enable some lapcode optimizations.
841 (list (car form) (nth 2 form) (nth 1 form)))
844 (defun byte-optimize-predicate (form)
848 (setq ok (byte-compile-constp (car rest))
852 (list 'quote (eval form))
856 (defun byte-optimize-identity (form)
857 (if (and (cdr form) (null (cdr (cdr form))))
859 (byte-compile-warn "identity called with %d arg%s, but requires 1"
861 (if (= 1 (length (cdr form))) "" "s"))
864 (defun byte-optimize-car (form)
865 (let ((arg (cadr form)))
867 ((and (byte-compile-trueconstp arg)
868 (not (and (consp arg)
869 (eq (car arg) 'quote)
870 (listp (cadr arg)))))
872 "taking car of a constant: %s" arg)
874 ((and (eq (car-safe arg) 'cons)
876 `(prog1 ,(nth 1 arg) ,(nth 2 arg)))
877 ((eq (car-safe arg) 'list)
878 `(prog1 ,@(cdr arg)))
880 (byte-optimize-predicate form)))))
882 (defun byte-optimize-cdr (form)
883 (let ((arg (cadr form)))
885 ((and (byte-compile-trueconstp arg)
886 (not (and (consp arg)
887 (eq (car arg) 'quote)
888 (listp (cadr arg)))))
890 "taking cdr of a constant: %s" arg)
892 ((and (eq (car-safe arg) 'cons)
894 `(progn ,(nth 1 arg) ,(nth 2 arg)))
895 ((eq (car-safe arg) 'list)
896 (if (> (length arg) 2)
897 `(progn ,(cadr arg) (list ,@(cddr arg)))
900 (byte-optimize-predicate form)))))
902 (put 'identity 'byte-optimizer 'byte-optimize-identity)
904 (put '+ 'byte-optimizer 'byte-optimize-plus)
905 (put '* 'byte-optimizer 'byte-optimize-multiply)
906 (put '- 'byte-optimizer 'byte-optimize-minus)
907 (put '/ 'byte-optimizer 'byte-optimize-divide)
908 (put 'max 'byte-optimizer 'byte-optimize-associative-math)
909 (put 'min 'byte-optimizer 'byte-optimize-associative-math)
911 (put '= 'byte-optimizer 'byte-optimize-binary-predicate)
912 (put 'eq 'byte-optimizer 'byte-optimize-binary-predicate)
913 (put 'eql 'byte-optimizer 'byte-optimize-binary-predicate)
914 (put 'equal 'byte-optimizer 'byte-optimize-binary-predicate)
915 (put 'string= 'byte-optimizer 'byte-optimize-binary-predicate)
916 (put 'string-equal 'byte-optimizer 'byte-optimize-binary-predicate)
918 (put '< 'byte-optimizer 'byte-optimize-predicate)
919 (put '> 'byte-optimizer 'byte-optimize-predicate)
920 (put '<= 'byte-optimizer 'byte-optimize-predicate)
921 (put '>= 'byte-optimizer 'byte-optimize-predicate)
922 (put '1+ 'byte-optimizer 'byte-optimize-predicate)
923 (put '1- 'byte-optimizer 'byte-optimize-predicate)
924 (put 'not 'byte-optimizer 'byte-optimize-predicate)
925 (put 'null 'byte-optimizer 'byte-optimize-predicate)
926 (put 'memq 'byte-optimizer 'byte-optimize-predicate)
927 (put 'consp 'byte-optimizer 'byte-optimize-predicate)
928 (put 'listp 'byte-optimizer 'byte-optimize-predicate)
929 (put 'symbolp 'byte-optimizer 'byte-optimize-predicate)
930 (put 'stringp 'byte-optimizer 'byte-optimize-predicate)
931 (put 'string< 'byte-optimizer 'byte-optimize-predicate)
932 (put 'string-lessp 'byte-optimizer 'byte-optimize-predicate)
933 (put 'length 'byte-optimizer 'byte-optimize-predicate)
935 (put 'logand 'byte-optimizer 'byte-optimize-logmumble)
936 (put 'logior 'byte-optimizer 'byte-optimize-logmumble)
937 (put 'logxor 'byte-optimizer 'byte-optimize-logmumble)
938 (put 'lognot 'byte-optimizer 'byte-optimize-predicate)
940 (put 'car 'byte-optimizer 'byte-optimize-car)
941 (put 'cdr 'byte-optimizer 'byte-optimize-cdr)
942 (put 'car-safe 'byte-optimizer 'byte-optimize-predicate)
943 (put 'cdr-safe 'byte-optimizer 'byte-optimize-predicate)
946 ;; I'm not convinced that this is necessary. Doesn't the optimizer loop
947 ;; take care of this? - Jamie
948 ;; I think this may some times be necessary to reduce eg. (quote 5) to 5,
949 ;; so arithmetic optimizers recognize the numeric constant. - Hallvard
950 (put 'quote 'byte-optimizer 'byte-optimize-quote)
951 (defun byte-optimize-quote (form)
952 (if (or (consp (nth 1 form))
953 (and (symbolp (nth 1 form))
955 (not (keywordp (nth 1 form)))
956 (not (memq (nth 1 form) '(nil t)))))
960 (defun byte-optimize-zerop (form)
961 (cond ((numberp (nth 1 form))
963 (byte-compile-delete-errors
964 (list '= (nth 1 form) 0))
967 (put 'zerop 'byte-optimizer 'byte-optimize-zerop)
969 (defun byte-optimize-and (form)
970 ;; Simplify if less than 2 args.
971 ;; if there is a literal nil in the args to `and', throw it and following
972 ;; forms away, and surround the `and' with (progn ... nil).
973 (cond ((null (cdr form)))
977 (prog1 (setq form (copy-sequence form))
979 (setq form (cdr form)))
982 ((null (cdr (cdr form)))
984 ((byte-optimize-predicate form))))
986 (defun byte-optimize-or (form)
987 ;; Throw away nil's, and simplify if less than 2 args.
988 ;; If there is a literal non-nil constant in the args to `or', throw away all
991 (setq form (delq nil (copy-sequence form))))
993 (while (cdr (setq rest (cdr rest)))
994 (if (byte-compile-trueconstp (car rest))
995 (setq form (copy-sequence form)
996 rest (setcdr (memq (car rest) form) nil))))
998 (byte-optimize-predicate form)
1001 (defun byte-optimize-cond (form)
1002 ;; if any clauses have a literal nil as their test, throw them away.
1003 ;; if any clause has a literal non-nil constant as its test, throw
1004 ;; away all following clauses.
1006 ;; This must be first, to reduce (cond (t ...) (nil)) to (progn t ...)
1007 (while (setq rest (assq nil (cdr form)))
1008 (setq form (delq rest (copy-sequence form))))
1009 (if (memq nil (cdr form))
1010 (setq form (delq nil (copy-sequence form))))
1012 (while (setq rest (cdr rest))
1013 (cond ((byte-compile-trueconstp (car-safe (car rest)))
1014 (cond ((eq rest (cdr form))
1016 (if (cdr (car rest))
1017 (if (cdr (cdr (car rest)))
1018 (cons 'progn (cdr (car rest)))
1022 (setq form (copy-sequence form))
1023 (setcdr (memq (car rest) form) nil)))
1026 ;; Turn (cond (( <x> )) ... ) into (or <x> (cond ... ))
1027 (if (eq 'cond (car-safe form))
1028 (let ((clauses (cdr form)))
1029 (if (and (consp (car clauses))
1030 (null (cdr (car clauses))))
1031 (list 'or (car (car clauses))
1033 (cons (car form) (cdr (cdr form)))))
1037 (defun byte-optimize-if (form)
1038 ;; (if <true-constant> <then> <else...>) ==> <then>
1039 ;; (if <false-constant> <then> <else...>) ==> (progn <else...>)
1040 ;; (if <test> nil <else...>) ==> (if (not <test>) (progn <else...>))
1041 ;; (if <test> <then> nil) ==> (if <test> <then>)
1042 (let ((clause (nth 1 form)))
1043 (cond ((byte-compile-trueconstp clause)
1047 (cons 'progn (nthcdr 3 form))
1050 (if (equal '(nil) (nthcdr 3 form))
1051 (list 'if clause (nth 2 form))
1053 ((or (nth 3 form) (nthcdr 4 form))
1055 ;; Don't make a double negative;
1056 ;; instead, take away the one that is there.
1057 (if (and (consp clause) (memq (car clause) '(not null))
1058 (= (length clause) 2)) ; (not xxxx) or (not (xxxx))
1062 (cons 'progn (nthcdr 3 form))
1065 (list 'progn clause nil)))))
1067 (defun byte-optimize-while (form)
1071 (put 'and 'byte-optimizer 'byte-optimize-and)
1072 (put 'or 'byte-optimizer 'byte-optimize-or)
1073 (put 'cond 'byte-optimizer 'byte-optimize-cond)
1074 (put 'if 'byte-optimizer 'byte-optimize-if)
1075 (put 'while 'byte-optimizer 'byte-optimize-while)
1077 ;; Remove any reason for avoiding `char-before'.
1078 (defun byte-optimize-char-before (form)
1079 `(char-after (1- ,(or (nth 1 form) '(point))) ,@(cdr (cdr form))))
1081 (put 'char-before 'byte-optimizer 'byte-optimize-char-before)
1083 ;; byte-compile-negation-optimizer lives in bytecomp.el
1084 ;(put '/= 'byte-optimizer 'byte-compile-negation-optimizer)
1085 (put 'atom 'byte-optimizer 'byte-compile-negation-optimizer)
1086 (put 'nlistp 'byte-optimizer 'byte-compile-negation-optimizer)
1089 (defun byte-optimize-funcall (form)
1090 ;; (funcall '(lambda ...) ...) ==> ((lambda ...) ...)
1091 ;; (funcall 'foo ...) ==> (foo ...)
1092 (let ((fn (nth 1 form)))
1093 (if (memq (car-safe fn) '(quote function))
1094 (cons (nth 1 fn) (cdr (cdr form)))
1097 (defun byte-optimize-apply (form)
1098 ;; If the last arg is a literal constant, turn this into a funcall.
1099 ;; The funcall optimizer can then transform (funcall 'foo ...) -> (foo ...).
1100 (let ((fn (nth 1 form))
1101 (last (nth (1- (length form)) form))) ; I think this really is fastest
1102 (or (if (or (null last)
1103 (eq (car-safe last) 'quote))
1104 (if (listp (nth 1 last))
1105 (let ((butlast (nreverse (cdr (reverse (cdr (cdr form)))))))
1106 (nconc (list 'funcall fn) butlast
1107 (mapcar #'(lambda (x) (list 'quote x)) (nth 1 last))))
1109 "last arg to apply can't be a literal atom: %s"
1110 (prin1-to-string last))
1114 (put 'funcall 'byte-optimizer 'byte-optimize-funcall)
1115 (put 'apply 'byte-optimizer 'byte-optimize-apply)
1118 (put 'let 'byte-optimizer 'byte-optimize-letX)
1119 (put 'let* 'byte-optimizer 'byte-optimize-letX)
1120 (defun byte-optimize-letX (form)
1121 (cond ((null (nth 1 form))
1123 (cons 'progn (cdr (cdr form))))
1124 ((or (nth 2 form) (nthcdr 3 form))
1127 ((eq (car form) 'let)
1128 (append '(progn) (mapcar 'car-safe (mapcar 'cdr-safe (nth 1 form)))
1131 (let ((binds (reverse (nth 1 form))))
1132 (list 'let* (reverse (cdr binds)) (nth 1 (car binds)) nil)))))
1135 (put 'nth 'byte-optimizer 'byte-optimize-nth)
1136 (defun byte-optimize-nth (form)
1137 (if (and (= (safe-length form) 3) (memq (nth 1 form) '(0 1)))
1138 (list 'car (if (zerop (nth 1 form))
1140 (list 'cdr (nth 2 form))))
1141 (byte-optimize-predicate form)))
1143 (put 'nthcdr 'byte-optimizer 'byte-optimize-nthcdr)
1144 (defun byte-optimize-nthcdr (form)
1145 (if (and (= (safe-length form) 3) (not (memq (nth 1 form) '(0 1 2))))
1146 (byte-optimize-predicate form)
1147 (let ((count (nth 1 form)))
1148 (setq form (nth 2 form))
1149 (while (>= (setq count (1- count)) 0)
1150 (setq form (list 'cdr form)))
1153 (put 'concat 'byte-optimizer 'byte-optimize-concat)
1154 (defun byte-optimize-concat (form)
1155 (let ((args (cdr form))
1157 (while (and args constant)
1158 (or (byte-compile-constp (car args))
1159 (setq constant nil))
1160 (setq args (cdr args)))
1165 ;;; enumerating those functions which need not be called if the returned
1166 ;;; value is not used. That is, something like
1167 ;;; (progn (list (something-with-side-effects) (yow))
1169 ;;; may safely be turned into
1170 ;;; (progn (progn (something-with-side-effects) (yow))
1172 ;;; Further optimizations will turn (progn (list 1 2 3) 'foo) into 'foo.
1174 ;;; I wonder if I missed any :-\)
1175 (let ((side-effect-free-fns
1176 '(% * + - / /= 1+ 1- < <= = > >= abs acos append aref ash asin atan
1178 boundp buffer-file-name buffer-local-variables buffer-modified-p
1180 capitalize car-less-than-car car cdr ceiling concat
1181 ;; coordinates-in-window-p not in XEmacs
1182 copy-marker cos count-lines
1183 default-boundp default-value documentation downcase
1184 elt exp expt fboundp featurep
1185 file-directory-p file-exists-p file-locked-p file-name-absolute-p
1186 file-newer-than-file-p file-readable-p file-symlink-p file-writable-p
1188 get get-buffer get-buffer-window getenv get-file-buffer
1189 ;; hash-table functions
1190 make-hash-table copy-hash-table
1193 hash-table-rehash-size
1194 hash-table-rehash-threshold
1200 length log log10 logand logb logior lognot logxor lsh
1201 marker-buffer max member memq min mod
1202 next-window nth nthcdr number-to-string
1203 parse-colon-path plist-get previous-window
1204 radians-to-degrees rassq regexp-quote reverse round
1205 sin sqrt string< string= string-equal string-lessp string-to-char
1206 string-to-int string-to-number substring symbol-plist
1207 tan upcase user-variable-p vconcat
1208 ;; XEmacs change: window-edges -> window-pixel-edges
1209 window-buffer window-dedicated-p window-pixel-edges window-height
1210 window-hscroll window-minibuffer-p window-width
1212 ;; functions defined by cl
1213 oddp evenp plusp minusp
1214 abs expt signum last butlast ldiff
1216 isqrt floor* ceiling* truncate* round* mod* rem* subseq
1219 (side-effect-and-error-free-fns
1221 bobp bolp buffer-end buffer-list buffer-size buffer-string bufferp
1222 car-safe case-table-p cdr-safe char-or-string-p char-table-p
1223 characterp commandp cons
1224 consolep console-live-p consp
1226 ;; XEmacs: extent functions, frame-live-p, various other stuff
1227 devicep device-live-p
1228 dot dot-marker eobp eolp eq eql equal eventp extentp
1229 extent-live-p floatp framep frame-live-p
1230 get-largest-window get-lru-window
1232 identity ignore integerp integer-or-marker-p interactive-p
1233 invocation-directory invocation-name
1235 make-marker mark mark-marker markerp memory-limit minibuffer-window
1236 ;; mouse-movement-p not in XEmacs
1237 natnump nlistp not null number-or-marker-p numberp
1238 one-window-p ;; overlayp not in XEmacs
1239 point point-marker point-min point-max processp
1241 selected-window sequencep stringp subrp symbolp syntax-table-p
1242 user-full-name user-login-name user-original-login-name
1243 user-real-login-name user-real-uid user-uid
1245 window-configuration-p window-live-p windowp
1246 ;; Functions defined by cl
1247 eql floatp-safe list* subst acons equalp random-state-p
1250 (dolist (fn side-effect-free-fns)
1251 (put fn 'side-effect-free t))
1252 (dolist (fn side-effect-and-error-free-fns)
1253 (put fn 'side-effect-free 'error-free)))
1256 (defun byte-compile-splice-in-already-compiled-code (form)
1257 ;; form is (byte-code "..." [...] n)
1258 (if (not (memq byte-optimize '(t lap)))
1259 (byte-compile-normal-call form)
1260 (byte-inline-lapcode
1261 (byte-decompile-bytecode-1 (nth 1 form) (nth 2 form) t))
1262 (setq byte-compile-maxdepth (max (+ byte-compile-depth (nth 3 form))
1263 byte-compile-maxdepth))
1264 (setq byte-compile-depth (1+ byte-compile-depth))))
1266 (put 'byte-code 'byte-compile 'byte-compile-splice-in-already-compiled-code)
1269 (defconst byte-constref-ops
1270 '(byte-constant byte-constant2 byte-varref byte-varset byte-varbind))
1272 ;;; This function extracts the bitfields from variable-length opcodes.
1273 ;;; Originally defined in disass.el (which no longer uses it.)
1275 (defun disassemble-offset ()
1277 ;; fetch and return the offset for the current opcode.
1278 ;; return NIL if this opcode has no offset
1279 ;; OP, PTR and BYTES are used and set dynamically
1280 (declare (special op ptr bytes))
1281 (cond ((< op byte-nth)
1282 (let ((tem (logand op 7)))
1283 (setq op (logand op 248))
1285 (setq ptr (1+ ptr)) ;offset in next byte
1286 ;; char-to-int to avoid downstream problems
1287 ;; caused by chars appearing where ints are
1288 ;; expected. In bytecode the bytes in the
1289 ;; opcode string are always interpreted as ints.
1290 (char-to-int (aref bytes ptr)))
1292 (setq ptr (1+ ptr)) ;offset in next 2 bytes
1294 (progn (setq ptr (1+ ptr))
1295 (lsh (aref bytes ptr) 8))))
1296 (t tem)))) ;offset was in opcode
1297 ((>= op byte-constant)
1298 (prog1 (- op byte-constant) ;offset in opcode
1299 (setq op byte-constant)))
1300 ((and (>= op byte-constant2)
1301 (<= op byte-goto-if-not-nil-else-pop))
1302 (setq ptr (1+ ptr)) ;offset in next 2 bytes
1304 (progn (setq ptr (1+ ptr))
1305 (lsh (aref bytes ptr) 8))))
1306 ;; XEmacs: this code was here before. FSF's first comparison
1307 ;; is (>= op byte-listN). It appears that the rel-goto stuff
1308 ;; does not exist in FSF 19.30. It doesn't exist in 19.28
1309 ;; either, so I'm going to assume that this is an improvement
1310 ;; on our part and leave it in. --ben
1311 ((and (>= op byte-rel-goto)
1312 (<= op byte-insertN))
1313 (setq ptr (1+ ptr)) ;offset in next byte
1314 ;; Use char-to-int to avoid downstream problems caused by
1315 ;; chars appearing where ints are expected. In bytecode
1316 ;; the bytes in the opcode string are always interpreted as
1318 (char-to-int (aref bytes ptr)))))
1321 ;;; This de-compiler is used for inline expansion of compiled functions,
1322 ;;; and by the disassembler.
1324 ;;; This list contains numbers, which are pc values,
1325 ;;; before each instruction.
1326 (defun byte-decompile-bytecode (bytes constvec)
1327 "Turns BYTECODE into lapcode, referring to CONSTVEC."
1328 (let ((byte-compile-constants nil)
1329 (byte-compile-variables nil)
1330 (byte-compile-tag-number 0))
1331 (byte-decompile-bytecode-1 bytes constvec)))
1333 ;; As byte-decompile-bytecode, but updates
1334 ;; byte-compile-{constants, variables, tag-number}.
1335 ;; If MAKE-SPLICEABLE is true, then `return' opcodes are replaced
1336 ;; with `goto's destined for the end of the code.
1337 ;; That is for use by the compiler.
1338 ;; If MAKE-SPLICEABLE is nil, we are being called for the disassembler.
1339 ;; In that case, we put a pc value into the list
1340 ;; before each insn (or its label).
1341 (defun byte-decompile-bytecode-1 (bytes constvec &optional make-spliceable)
1342 (let ((length (length bytes))
1343 (ptr 0) optr tags op offset
1347 ;; (retcount 0) unused
1349 (while (not (= ptr length))
1351 (setq lap (cons ptr lap)))
1352 (setq op (aref bytes ptr)
1354 offset (disassemble-offset)) ; this does dynamic-scope magic
1355 (setq op (aref byte-code-vector op))
1356 ;; XEmacs: the next line in FSF 19.30 reads
1357 ;; (cond ((memq op byte-goto-ops)
1358 ;; see the comment above about byte-rel-goto in XEmacs.
1359 (cond ((or (memq op byte-goto-ops)
1360 (cond ((memq op byte-rel-goto-ops)
1361 (setq op (aref byte-code-vector
1362 (- (symbol-value op)
1363 (- byte-rel-goto byte-goto))))
1364 (setq offset (+ ptr (- offset 127)))
1368 (cdr (or (assq offset tags)
1371 (byte-compile-make-tag))
1373 ((cond ((eq op 'byte-constant2) (setq op 'byte-constant) t)
1374 ((memq op byte-constref-ops)))
1375 (setq tmp (aref constvec offset)
1376 offset (if (eq op 'byte-constant)
1377 (byte-compile-get-constant tmp)
1378 (or (assq tmp byte-compile-variables)
1379 (car (setq byte-compile-variables
1381 byte-compile-variables)))))))
1382 ((and make-spliceable
1383 (eq op 'byte-return))
1384 (if (= ptr (1- length))
1386 (setq offset (or endtag (setq endtag (byte-compile-make-tag)))
1388 ;; lap = ( [ (pc . (op . arg)) ]* )
1389 (setq lap (cons (cons optr (cons op (or offset 0)))
1391 (setq ptr (1+ ptr)))
1392 ;; take off the dummy nil op that we replaced a trailing "return" with.
1395 (cond ((numberp (car rest)))
1396 ((setq tmp (assq (car (car rest)) tags))
1397 ;; this addr is jumped to
1398 (setcdr rest (cons (cons nil (cdr tmp))
1400 (setq tags (delq tmp tags))
1401 (setq rest (cdr rest))))
1402 (setq rest (cdr rest))))
1403 (if tags (error "optimizer error: missed tags %s" tags))
1404 (if (null (car (cdr (car lap))))
1405 (setq lap (cdr lap)))
1407 (setq lap (cons (cons nil endtag) lap)))
1408 ;; remove addrs, lap = ( [ (op . arg) | (TAG tagno) ]* )
1409 (mapcar #'(lambda (elt) (if (numberp elt) elt (cdr elt)))
1413 ;;; peephole optimizer
1415 (defconst byte-tagref-ops (cons 'TAG byte-goto-ops))
1417 (defconst byte-conditional-ops
1418 '(byte-goto-if-nil byte-goto-if-not-nil byte-goto-if-nil-else-pop
1419 byte-goto-if-not-nil-else-pop))
1421 (defconst byte-after-unbind-ops
1422 '(byte-constant byte-dup
1423 byte-symbolp byte-consp byte-stringp byte-listp byte-numberp byte-integerp
1425 byte-cons byte-list1 byte-list2 ; byte-list3 byte-list4
1427 ;; How about other side-effect-free-ops? Is it safe to move an
1428 ;; error invocation (such as from nth) out of an unwind-protect?
1429 ;; No, it is not, because the unwind-protect forms can alter
1430 ;; the inside of the object to which nth would apply.
1431 ;; For the same reason, byte-equal was deleted from this list.
1432 "Byte-codes that can be moved past an unbind.")
1434 (defconst byte-compile-side-effect-and-error-free-ops
1435 '(byte-constant byte-dup byte-symbolp byte-consp byte-stringp byte-listp
1436 byte-integerp byte-numberp byte-eq byte-equal byte-not byte-car-safe
1437 byte-cdr-safe byte-cons byte-list1 byte-list2 byte-point byte-point-max
1438 byte-point-min byte-following-char byte-preceding-char
1439 byte-current-column byte-eolp byte-eobp byte-bolp byte-bobp
1440 byte-current-buffer byte-interactive-p))
1442 (defconst byte-compile-side-effect-free-ops
1444 '(byte-varref byte-nth byte-memq byte-car byte-cdr byte-length byte-aref
1445 byte-symbol-value byte-get byte-concat2 byte-concat3 byte-sub1 byte-add1
1446 byte-eqlsign byte-gtr byte-lss byte-leq byte-geq byte-diff byte-negate
1447 byte-plus byte-max byte-min byte-mult byte-char-after byte-char-syntax
1448 byte-buffer-substring byte-string= byte-string< byte-nthcdr byte-elt
1449 byte-member byte-assq byte-quo byte-rem)
1450 byte-compile-side-effect-and-error-free-ops))
1452 ;;; This piece of shit is because of the way DEFVAR_BOOL() variables work.
1453 ;;; Consider the code
1455 ;;; (defun foo (flag)
1456 ;;; (let ((old-pop-ups pop-up-windows)
1457 ;;; (pop-up-windows flag))
1458 ;;; (cond ((not (eq pop-up-windows old-pop-ups))
1459 ;;; (setq old-pop-ups pop-up-windows)
1462 ;;; Uncompiled, old-pop-ups will always be set to nil or t, even if FLAG is
1463 ;;; something else. But if we optimize
1466 ;;; varbind pop-up-windows
1467 ;;; varref pop-up-windows
1472 ;;; varbind pop-up-windows
1475 ;;; we break the program, because it will appear that pop-up-windows and
1476 ;;; old-pop-ups are not EQ when really they are. So we have to know what
1477 ;;; the BOOL variables are, and not perform this optimization on them.
1480 ;;; This used to hold a large list of boolean variables, which had to
1481 ;;; be updated every time a new DEFVAR_BOOL is added, making it very
1482 ;;; hard to maintain. Such a list is not necessary under XEmacs,
1483 ;;; where we can use `built-in-variable-type' to query for boolean
1486 ;(defconst byte-boolean-vars
1487 ; '(abbrev-all-caps purify-flag find-file-compare-truenames
1488 ; find-file-use-truenames delete-auto-save-files byte-metering-on
1489 ; x-seppuku-on-epipe zmacs-regions zmacs-region-active-p
1490 ; zmacs-region-stays atomic-extent-goto-char-p
1491 ; suppress-early-error-handler-backtrace noninteractive
1492 ; inhibit-early-packages inhibit-autoloads debug-paths
1493 ; inhibit-site-lisp debug-on-quit debug-on-next-call
1494 ; modifier-keys-are-sticky x-allow-sendevents
1495 ; mswindows-dynamic-frame-resize focus-follows-mouse
1496 ; inhibit-input-event-recording enable-multibyte-characters
1497 ; disable-auto-save-when-buffer-shrinks
1498 ; allow-deletion-of-last-visible-frame indent-tabs-mode
1499 ; load-in-progress load-warn-when-source-newer
1500 ; load-warn-when-source-only load-ignore-elc-files
1501 ; load-force-doc-strings fail-on-bucky-bit-character-escapes
1502 ; popup-menu-titles menubar-show-keybindings completion-ignore-case
1503 ; canna-empty-info canna-through-info canna-underline
1504 ; canna-inhibit-hankakukana enable-multibyte-characters
1505 ; re-short-flag x-handle-non-fully-specified-fonts
1506 ; print-escape-newlines print-readably delete-exited-processes
1507 ; windowed-process-io visible-bell no-redraw-on-reenter
1508 ; cursor-in-echo-area inhibit-warning-display
1509 ; column-number-start-at-one parse-sexp-ignore-comments
1510 ; words-include-escapes scroll-on-clipped-lines)
1511 ; "DEFVAR_BOOL variables. Giving these any non-nil value sets them to t.
1512 ;If this does not enumerate all DEFVAR_BOOL variables, the byte-optimizer
1513 ;may generate incorrect code.")
1515 (defun byte-optimize-lapcode (lap &optional for-effect)
1516 "Simple peephole optimizer. LAP is both modified and returned."
1521 (keep-going 'first-time)
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)))
1528 (or (eq keep-going 'first-time)
1529 (byte-compile-log-lap " ---- next pass"))
1533 (setq lap0 (car rest)
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.
1541 ;; <side-effect-free> pop --> <deleted>
1543 ;; const-X pop --> <deleted>
1544 ;; varref-X pop --> <deleted>
1545 ;; dup pop --> <deleted>
1547 ((and (eq 'byte-discard (car lap1))
1548 (memq (car lap0) side-effect-free))
1550 (setq tmp (aref byte-stack+-info (symbol-value (car lap0))))
1551 (setq rest (cdr rest))
1553 (byte-compile-log-lap
1554 " %s discard\t-->\t<deleted>" lap0)
1555 (setq lap (delq lap0 (delq lap1 lap))))
1557 (byte-compile-log-lap
1558 " %s discard\t-->\t<deleted> discard" lap0)
1559 (setq lap (delq lap0 lap)))
1561 (byte-compile-log-lap
1562 " %s discard\t-->\tdiscard discard" lap0)
1563 (setcar lap0 'byte-discard)
1565 ((error "Optimizer error: too much on the stack"))))
1567 ;; goto*-X X: --> X:
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))
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)
1582 (setq keep-going t))
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.
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 (eq (built-in-variable-type (car (cdr lap2)))
1595 (not (eq (car lap0) 'byte-constant)))
1598 (if (memq (car lap0) '(byte-constant byte-dup))
1600 (setq tmp (if (or (not tmp)
1601 (memq (car (cdr lap0)) '(nil t)))
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))
1609 (byte-compile-log-lap " %s %s\t-->\tdup %s" lap1 lap2 lap1)
1610 (setcar lap2 (car lap1))
1611 (setcar lap1 'byte-dup)
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))))
1619 ;; dup varset-X discard --> varset-X
1620 ;; dup varbind-X discard --> varbind-X
1621 ;; (the varbind variant can emerge from other optimizations)
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)
1629 (setq lap (delq lap0 (delq lap2 lap))))
1631 ;; not goto-X-if-nil --> goto-X-if-non-nil
1632 ;; not goto-X-if-non-nil --> goto-X-if-nil
1634 ;; it is wrong to do the same thing for the -else-pop variants.
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"
1642 (if (eq (car lap1) 'byte-goto-if-nil)
1643 'byte-goto-if-not-nil
1646 (setcar lap1 (if (eq (car lap1) 'byte-goto-if-nil)
1647 'byte-goto-if-not-nil
1649 (setq lap (delq lap0 lap))
1650 (setq keep-going t))
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:
1655 ;; it is wrong to do the same thing for the -else-pop variants.
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:"
1665 (cons inverse (cdr lap1)) lap2)
1666 (setq lap (delq lap0 lap))
1667 (setcar lap1 inverse)
1668 (setq keep-going t)))
1670 ;; const goto-if-* --> whatever
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))
1677 (not (car (cdr lap0))))
1678 (byte-compile-log-lap " %s %s\t-->\t<deleted>"
1680 (setq rest (cdr rest)
1681 lap (delq lap0 (delq lap1 lap))))
1683 (if (memq (car lap1) byte-goto-always-pop-ops)
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))
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.
1699 ((and (eq 'byte-varref (car lap0))
1701 (setq tmp (cdr rest))
1702 (while (eq (car (car tmp)) 'byte-dup)
1703 (setq tmp (cdr tmp)))
1705 (eq (cdr lap0) (cdr (car tmp)))
1706 (eq 'byte-varref (car (car tmp))))
1707 (if (memq byte-optimize-log '(t byte))
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)))
1716 (setcar (car tmp) 'byte-dup)
1717 (setcdr (car tmp) 0)
1720 ;; TAG1: TAG2: --> TAG1: <deleted>
1721 ;; (and other references to TAG2 are replaced with TAG1)
1723 ((and (eq (car lap0) 'TAG)
1724 (eq (car lap1) 'TAG))
1725 (and (memq byte-optimize-log '(t byte))
1726 (byte-compile-log " adjacent tags %d and %d merged"
1727 (nth 1 lap1) (nth 1 lap0)))
1729 (while (setq tmp2 (rassq lap0 tmp3))
1731 (setq tmp3 (cdr (memq tmp2 tmp3))))
1732 (setq lap (delq lap0 lap)
1735 ;; unused-TAG: --> <deleted>
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)
1744 ;; goto ... --> goto <delete until TAG or end>
1745 ;; return ... --> return <delete until TAG or end>
1747 ((and (memq (car lap0) '(byte-goto byte-return))
1748 (not (memq (car lap1) '(TAG nil))))
1751 (opt-p (memq byte-optimize-log '(t lap)))
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")
1760 (if (eq 'TAG (car (car tmp)))
1761 (format "%d:" (car (cdr (car tmp))))
1762 (or (car tmp) ""))))
1764 (apply 'byte-compile-log-lap-1
1766 " %s\t-->\t%s <deleted> %s")
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))))
1775 (setq keep-going t))
1777 ;; <safe-op> unbind --> unbind <safe-op>
1778 ;; (this may enable other optimizations.)
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)
1784 (setcar (cdr rest) lap0)
1785 (setq keep-going t))
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)
1791 ((and (eq 'byte-unbind (car lap1))
1792 (memq (car lap0) '(byte-varbind byte-save-excursion
1793 byte-save-restriction))
1795 (if (zerop (setcdr lap1 (1- (cdr lap1))))
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)
1805 (if (and (/= 0 (cdr lap1))
1806 (eq (car lap0) 'byte-varbind))
1809 (setq keep-going t))
1811 ;; goto*-X ... X: goto-Y --> goto*-Y
1812 ;; goto-X ... X: return --> return
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"
1822 (if (eq (car tmp) 'byte-return)
1823 (setcar lap0 'byte-return))
1824 (setcdr lap0 (cdr tmp))
1825 (setq keep-going t))))
1827 ;; goto-*-else-pop X ... X: goto-if-* --> whatever
1828 ;; goto-*-else-pop X ... X: discard --> whatever
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)))))
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
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)
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))
1856 ;; const goto-X ... X: goto-if-* --> whatever
1857 ;; const goto-X ... X: discard --> whatever
1859 ((and (eq (car lap0) 'byte-constant)
1860 (eq (car lap1) 'byte-goto)
1861 (memq (car (car (setq tmp (cdr (memq (cdr lap1) lap)))))
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)))
1878 ;; Jump one step further
1879 (byte-compile-log-lap
1880 " %s goto [%s]\t-->\t<deleted> goto <skip>"
1882 (or (eq 'TAG (car (nth 1 tmp)))
1883 (setcdr tmp (cons (byte-compile-make-tag)
1885 (setcdr lap1 (car (cdr tmp)))
1886 (setq lap (delq lap0 lap))))
1887 (setq keep-going t))
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).
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)))))
1899 (eq (cdr (car tmp)) (cdr lap1))
1900 (not (eq (built-in-variable-type (car (cdr lap1)))
1902 ;;(byte-compile-log-lap " Pulled %s to end of loop" (car tmp))
1903 (let ((newtag (byte-compile-make-tag)))
1904 (byte-compile-log-lap
1905 " %s: %s ... %s %s\t-->\t%s: %s %s: ... %s %s %s"
1906 (nth 1 (cdr lap2)) (car tmp)
1908 (nth 1 (cdr lap2)) (car tmp)
1909 (nth 1 newtag) 'byte-dup lap1
1910 (cons 'byte-goto newtag)
1912 (setcdr rest (cons (cons 'byte-dup 0) (cdr rest)))
1913 (setcdr tmp (cons (setcdr lap2 newtag) (cdr tmp))))
1915 (setq keep-going t))
1917 ;; goto-X Y: ... X: goto-if*-Y --> goto-if-not-*-X+1 Y:
1918 ;; (This can pull the loop test to the end of the loop)
1920 ((and (eq (car lap0) 'byte-goto)
1921 (eq (car lap1) 'TAG)
1923 (cdr (car (setq tmp (cdr (memq (cdr lap0) lap))))))
1924 (memq (car (car tmp))
1925 '(byte-goto byte-goto-if-nil byte-goto-if-not-nil
1926 byte-goto-if-nil-else-pop)))
1927 ;; (byte-compile-log-lap " %s %s, %s %s --> moved conditional"
1928 ;; lap0 lap1 (cdr lap0) (car tmp))
1929 (let ((newtag (byte-compile-make-tag)))
1930 (byte-compile-log-lap
1931 "%s %s: ... %s: %s\t-->\t%s ... %s:"
1932 lap0 (nth 1 lap1) (nth 1 (cdr lap0)) (car tmp)
1933 (cons (cdr (assq (car (car tmp))
1934 '((byte-goto-if-nil . byte-goto-if-not-nil)
1935 (byte-goto-if-not-nil . byte-goto-if-nil)
1936 (byte-goto-if-nil-else-pop .
1937 byte-goto-if-not-nil-else-pop)
1938 (byte-goto-if-not-nil-else-pop .
1939 byte-goto-if-nil-else-pop))))
1944 (setcdr tmp (cons (setcdr lap0 newtag) (cdr tmp)))
1945 (if (eq (car (car tmp)) 'byte-goto-if-nil-else-pop)
1946 ;; We can handle this case but not the -if-not-nil case,
1947 ;; because we won't know which non-nil constant to push.
1948 (setcdr rest (cons (cons 'byte-constant
1949 (byte-compile-get-constant nil))
1951 (setcar lap0 (nth 1 (memq (car (car tmp))
1952 '(byte-goto-if-nil-else-pop
1953 byte-goto-if-not-nil
1955 byte-goto-if-not-nil
1956 byte-goto byte-goto))))
1958 (setq keep-going t))
1960 (setq rest (cdr rest)))
1963 ;; Rebuild byte-compile-constants / byte-compile-variables.
1964 ;; Simple optimizations that would inhibit other optimizations if they
1965 ;; were done in the optimizing loop, and optimizations which there is no
1966 ;; need to do more than once.
1967 (setq byte-compile-constants nil
1968 byte-compile-variables nil
1969 variable-frequency (make-hash-table :test 'eq))
1972 (setq lap0 (car rest)
1975 ((byte-varref byte-varset byte-varbind)
1976 (incf (gethash (cdr lap0) variable-frequency 0))
1977 (unless (memq (cdr lap0) byte-compile-variables)
1978 (push (cdr lap0) byte-compile-variables)))
1980 (unless (memq (cdr lap0) byte-compile-constants)
1981 (push (cdr lap0) byte-compile-constants))))
1983 ;; const-C varset-X const-C --> const-C dup varset-X
1984 ;; const-C varbind-X const-C --> const-C dup varbind-X
1986 (and (eq (car lap0) 'byte-constant)
1987 (eq (car (nth 2 rest)) 'byte-constant)
1988 (eq (cdr lap0) (cdr (nth 2 rest)))
1989 (memq (car lap1) '(byte-varbind byte-varset)))
1990 (byte-compile-log-lap " %s %s %s\t-->\t%s dup %s"
1991 lap0 lap1 lap0 lap0 lap1)
1992 (setcar (cdr (cdr rest)) (cons (car lap1) (cdr lap1)))
1993 (setcar (cdr rest) (cons 'byte-dup 0))
1996 ;; const-X [dup/const-X ...] --> const-X [dup ...] dup
1997 ;; varref-X [dup/varref-X ...] --> varref-X [dup ...] dup
1999 ((memq (car lap0) '(byte-constant byte-varref))
2003 (while (eq 'byte-dup (car (car (setq tmp (cdr tmp))))))
2004 (and (eq (cdr lap0) (cdr (car tmp)))
2005 (eq (car lap0) (car (car tmp)))))
2006 (setcar tmp (cons 'byte-dup 0))
2009 (byte-compile-log-lap
2010 " %s [dup/%s]...\t-->\t%s dup..." lap0 lap0 lap0)))
2012 ;; unbind-N unbind-M --> unbind-(N+M)
2014 ((and (eq 'byte-unbind (car lap0))
2015 (eq 'byte-unbind (car lap1)))
2016 (byte-compile-log-lap " %s %s\t-->\t%s" lap0 lap1
2018 (+ (cdr lap0) (cdr lap1))))
2020 (setq lap (delq lap0 lap))
2021 (setcdr lap1 (+ (cdr lap1) (cdr lap0))))
2023 (setq rest (cdr rest)))
2024 ;; Since the first 6 entries of the compiled-function constants
2025 ;; vector are most efficient for varref/set/bind ops, we sort by
2026 ;; reference count. This generates maximally space efficient and
2027 ;; pretty time-efficient byte-code. See `byte-compile-constants-vector'.
2028 (setq byte-compile-variables
2029 (sort byte-compile-variables
2031 (< (gethash v1 variable-frequency)
2032 (gethash v2 variable-frequency)))))
2033 ;; Another hack - put the most used variable in position 6, for
2034 ;; better locality of reference with adjoining constants.
2035 (let ((tail (last byte-compile-variables 6)))
2036 (setq byte-compile-variables
2037 (append (nbutlast byte-compile-variables 6)
2039 (setq byte-compile-maxdepth (+ byte-compile-maxdepth add-depth)))
2042 (provide 'byte-optimize)
2045 ;; To avoid "lisp nesting exceeds max-lisp-eval-depth" when this file compiles
2046 ;; itself, compile some of its most used recursive functions (at load time).
2049 (or (compiled-function-p (symbol-function 'byte-optimize-form))
2050 (assq 'byte-code (symbol-function 'byte-optimize-form))
2051 (let ((byte-optimize nil)
2052 (byte-compile-warnings nil))
2055 (or noninteractive (message "compiling %s..." x))
2057 (or noninteractive (message "compiling %s...done" x)))
2058 '(byte-optimize-form
2060 byte-optimize-predicate
2061 byte-optimize-binary-predicate
2062 ;; Inserted some more than necessary, to speed it up.
2063 byte-optimize-form-code-walker
2064 byte-optimize-lapcode))))
2067 ;;; byte-optimize.el ends here