1 /* Execution of byte code produced by bytecomp.el.
2 Copyright (C) 1985-1988, 1993, 2000-2012 Free Software Foundation, Inc.
4 This file is part of GNU Emacs.
6 GNU Emacs is free software: you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation, either version 3 of the License, or
9 (at your option) any later version.
11 GNU Emacs is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
20 hacked on by jwz@lucid.com 17-jun-91
21 o added a compile-time switch to turn on simple sanity checking;
22 o put back the obsolete byte-codes for error-detection;
23 o added a new instruction, unbind_all, which I will use for
24 tail-recursion elimination;
25 o made temp_output_buffer_show be called with the right number
27 o made the new bytecodes be called with args in the right order;
28 o added metering support.
31 o added relative jump instructions;
32 o all conditionals now only do QUIT if they jump.
38 #include "character.h"
43 #ifdef CHECK_FRAME_FONT
49 * define BYTE_CODE_SAFE to enable some minor sanity checking (useful for
50 * debugging the byte compiler...)
52 * define BYTE_CODE_METER to enable generation of a byte-op usage histogram.
54 /* #define BYTE_CODE_SAFE */
55 /* #define BYTE_CODE_METER */
57 /* If BYTE_CODE_THREADED is defined, then the interpreter will be
58 indirect threaded, using GCC's computed goto extension. This code,
59 as currently implemented, is incompatible with BYTE_CODE_SAFE and
61 #if defined (__GNUC__) && !defined (BYTE_CODE_SAFE) && !defined (BYTE_CODE_METER)
62 #define BYTE_CODE_THREADED
66 #ifdef BYTE_CODE_METER
68 Lisp_Object Qbyte_code_meter
;
69 #define METER_2(code1, code2) AREF (AREF (Vbyte_code_meter, code1), code2)
70 #define METER_1(code) METER_2 (0, code)
72 #define METER_CODE(last_code, this_code) \
74 if (byte_metering_on) \
76 if (XFASTINT (METER_1 (this_code)) < MOST_POSITIVE_FIXNUM) \
77 XSETFASTINT (METER_1 (this_code), \
78 XFASTINT (METER_1 (this_code)) + 1); \
80 && (XFASTINT (METER_2 (last_code, this_code)) \
81 < MOST_POSITIVE_FIXNUM)) \
82 XSETFASTINT (METER_2 (last_code, this_code), \
83 XFASTINT (METER_2 (last_code, this_code)) + 1); \
87 #endif /* BYTE_CODE_METER */
90 Lisp_Object Qbytecode
;
95 DEFINE (Bstack_ref, 0) /* Actually, Bstack_ref+0 is not implemented: use dup. */ \
96 DEFINE (Bstack_ref1, 1) \
97 DEFINE (Bstack_ref2, 2) \
98 DEFINE (Bstack_ref3, 3) \
99 DEFINE (Bstack_ref4, 4) \
100 DEFINE (Bstack_ref5, 5) \
101 DEFINE (Bstack_ref6, 6) \
102 DEFINE (Bstack_ref7, 7) \
103 DEFINE (Bvarref, 010) \
104 DEFINE (Bvarref1, 011) \
105 DEFINE (Bvarref2, 012) \
106 DEFINE (Bvarref3, 013) \
107 DEFINE (Bvarref4, 014) \
108 DEFINE (Bvarref5, 015) \
109 DEFINE (Bvarref6, 016) \
110 DEFINE (Bvarref7, 017) \
111 DEFINE (Bvarset, 020) \
112 DEFINE (Bvarset1, 021) \
113 DEFINE (Bvarset2, 022) \
114 DEFINE (Bvarset3, 023) \
115 DEFINE (Bvarset4, 024) \
116 DEFINE (Bvarset5, 025) \
117 DEFINE (Bvarset6, 026) \
118 DEFINE (Bvarset7, 027) \
119 DEFINE (Bvarbind, 030) \
120 DEFINE (Bvarbind1, 031) \
121 DEFINE (Bvarbind2, 032) \
122 DEFINE (Bvarbind3, 033) \
123 DEFINE (Bvarbind4, 034) \
124 DEFINE (Bvarbind5, 035) \
125 DEFINE (Bvarbind6, 036) \
126 DEFINE (Bvarbind7, 037) \
127 DEFINE (Bcall, 040) \
128 DEFINE (Bcall1, 041) \
129 DEFINE (Bcall2, 042) \
130 DEFINE (Bcall3, 043) \
131 DEFINE (Bcall4, 044) \
132 DEFINE (Bcall5, 045) \
133 DEFINE (Bcall6, 046) \
134 DEFINE (Bcall7, 047) \
135 DEFINE (Bunbind, 050) \
136 DEFINE (Bunbind1, 051) \
137 DEFINE (Bunbind2, 052) \
138 DEFINE (Bunbind3, 053) \
139 DEFINE (Bunbind4, 054) \
140 DEFINE (Bunbind5, 055) \
141 DEFINE (Bunbind6, 056) \
142 DEFINE (Bunbind7, 057) \
145 DEFINE (Bsymbolp, 071) \
146 DEFINE (Bconsp, 072) \
147 DEFINE (Bstringp, 073) \
148 DEFINE (Blistp, 074) \
150 DEFINE (Bmemq, 076) \
152 DEFINE (Bcar, 0100) \
153 DEFINE (Bcdr, 0101) \
154 DEFINE (Bcons, 0102) \
155 DEFINE (Blist1, 0103) \
156 DEFINE (Blist2, 0104) \
157 DEFINE (Blist3, 0105) \
158 DEFINE (Blist4, 0106) \
159 DEFINE (Blength, 0107) \
160 DEFINE (Baref, 0110) \
161 DEFINE (Baset, 0111) \
162 DEFINE (Bsymbol_value, 0112) \
163 DEFINE (Bsymbol_function, 0113) \
164 DEFINE (Bset, 0114) \
165 DEFINE (Bfset, 0115) \
166 DEFINE (Bget, 0116) \
167 DEFINE (Bsubstring, 0117) \
168 DEFINE (Bconcat2, 0120) \
169 DEFINE (Bconcat3, 0121) \
170 DEFINE (Bconcat4, 0122) \
171 DEFINE (Bsub1, 0123) \
172 DEFINE (Badd1, 0124) \
173 DEFINE (Beqlsign, 0125) \
174 DEFINE (Bgtr, 0126) \
175 DEFINE (Blss, 0127) \
176 DEFINE (Bleq, 0130) \
177 DEFINE (Bgeq, 0131) \
178 DEFINE (Bdiff, 0132) \
179 DEFINE (Bnegate, 0133) \
180 DEFINE (Bplus, 0134) \
181 DEFINE (Bmax, 0135) \
182 DEFINE (Bmin, 0136) \
183 DEFINE (Bmult, 0137) \
185 DEFINE (Bpoint, 0140) \
186 /* Was Bmark in v17. */ \
187 DEFINE (Bsave_current_buffer, 0141) /* Obsolete. */ \
188 DEFINE (Bgoto_char, 0142) \
189 DEFINE (Binsert, 0143) \
190 DEFINE (Bpoint_max, 0144) \
191 DEFINE (Bpoint_min, 0145) \
192 DEFINE (Bchar_after, 0146) \
193 DEFINE (Bfollowing_char, 0147) \
194 DEFINE (Bpreceding_char, 0150) \
195 DEFINE (Bcurrent_column, 0151) \
196 DEFINE (Bindent_to, 0152) \
197 DEFINE (Beolp, 0154) \
198 DEFINE (Beobp, 0155) \
199 DEFINE (Bbolp, 0156) \
200 DEFINE (Bbobp, 0157) \
201 DEFINE (Bcurrent_buffer, 0160) \
202 DEFINE (Bset_buffer, 0161) \
203 DEFINE (Bsave_current_buffer_1, 0162) /* Replacing Bsave_current_buffer. */ \
204 DEFINE (Binteractive_p, 0164) /* Obsolete since Emacs-24.1. */ \
206 DEFINE (Bforward_char, 0165) \
207 DEFINE (Bforward_word, 0166) \
208 DEFINE (Bskip_chars_forward, 0167) \
209 DEFINE (Bskip_chars_backward, 0170) \
210 DEFINE (Bforward_line, 0171) \
211 DEFINE (Bchar_syntax, 0172) \
212 DEFINE (Bbuffer_substring, 0173) \
213 DEFINE (Bdelete_region, 0174) \
214 DEFINE (Bnarrow_to_region, 0175) \
215 DEFINE (Bwiden, 0176) \
216 DEFINE (Bend_of_line, 0177) \
218 DEFINE (Bconstant2, 0201) \
219 DEFINE (Bgoto, 0202) \
220 DEFINE (Bgotoifnil, 0203) \
221 DEFINE (Bgotoifnonnil, 0204) \
222 DEFINE (Bgotoifnilelsepop, 0205) \
223 DEFINE (Bgotoifnonnilelsepop, 0206) \
224 DEFINE (Breturn, 0207) \
225 DEFINE (Bdiscard, 0210) \
226 DEFINE (Bdup, 0211) \
228 DEFINE (Bsave_excursion, 0212) \
229 DEFINE (Bsave_window_excursion, 0213) /* Obsolete since Emacs-24.1. */ \
230 DEFINE (Bsave_restriction, 0214) \
231 DEFINE (Bcatch, 0215) \
233 DEFINE (Bunwind_protect, 0216) \
234 DEFINE (Bcondition_case, 0217) \
235 DEFINE (Btemp_output_buffer_setup, 0220) /* Obsolete since Emacs-24.1. */ \
236 DEFINE (Btemp_output_buffer_show, 0221) /* Obsolete since Emacs-24.1. */ \
238 DEFINE (Bunbind_all, 0222) /* Obsolete. Never used. */ \
240 DEFINE (Bset_marker, 0223) \
241 DEFINE (Bmatch_beginning, 0224) \
242 DEFINE (Bmatch_end, 0225) \
243 DEFINE (Bupcase, 0226) \
244 DEFINE (Bdowncase, 0227) \
246 DEFINE (Bstringeqlsign, 0230) \
247 DEFINE (Bstringlss, 0231) \
248 DEFINE (Bequal, 0232) \
249 DEFINE (Bnthcdr, 0233) \
250 DEFINE (Belt, 0234) \
251 DEFINE (Bmember, 0235) \
252 DEFINE (Bassq, 0236) \
253 DEFINE (Bnreverse, 0237) \
254 DEFINE (Bsetcar, 0240) \
255 DEFINE (Bsetcdr, 0241) \
256 DEFINE (Bcar_safe, 0242) \
257 DEFINE (Bcdr_safe, 0243) \
258 DEFINE (Bnconc, 0244) \
259 DEFINE (Bquo, 0245) \
260 DEFINE (Brem, 0246) \
261 DEFINE (Bnumberp, 0247) \
262 DEFINE (Bintegerp, 0250) \
264 DEFINE (BRgoto, 0252) \
265 DEFINE (BRgotoifnil, 0253) \
266 DEFINE (BRgotoifnonnil, 0254) \
267 DEFINE (BRgotoifnilelsepop, 0255) \
268 DEFINE (BRgotoifnonnilelsepop, 0256) \
270 DEFINE (BlistN, 0257) \
271 DEFINE (BconcatN, 0260) \
272 DEFINE (BinsertN, 0261) \
274 /* Bstack_ref is code 0. */ \
275 DEFINE (Bstack_set, 0262) \
276 DEFINE (Bstack_set2, 0263) \
277 DEFINE (BdiscardN, 0266) \
279 DEFINE (Bconstant, 0300)
283 #define DEFINE(name, value) name = value,
287 #ifdef BYTE_CODE_SAFE
288 Bscan_buffer
= 0153, /* No longer generated as of v18. */
289 Bset_mark
= 0163 /* this loser is no longer generated as of v18 */
293 /* Whether to maintain a `top' and `bottom' field in the stack frame. */
294 #define BYTE_MAINTAIN_TOP (BYTE_CODE_SAFE || BYTE_MARK_STACK)
296 /* Structure describing a value stack used during byte-code execution
301 /* Program counter. This points into the byte_string below
302 and is relocated when that string is relocated. */
303 const unsigned char *pc
;
305 /* Top and bottom of stack. The bottom points to an area of memory
306 allocated with alloca in Fbyte_code. */
307 #if BYTE_MAINTAIN_TOP
308 Lisp_Object
*top
, *bottom
;
311 /* The string containing the byte-code, and its current address.
312 Storing this here protects it from GC because mark_byte_stack
314 Lisp_Object byte_string
;
315 const unsigned char *byte_string_start
;
317 /* The vector of constants used during byte-code execution. Storing
318 this here protects it from GC because mark_byte_stack marks it. */
319 Lisp_Object constants
;
321 /* Next entry in byte_stack_list. */
322 struct byte_stack
*next
;
325 /* A list of currently active byte-code execution value stacks.
326 Fbyte_code adds an entry to the head of this list before it starts
327 processing byte-code, and it removed the entry again when it is
328 done. Signaling an error truncates the list analogous to
331 struct byte_stack
*byte_stack_list
;
334 /* Mark objects on byte_stack_list. Called during GC. */
338 mark_byte_stack (void)
340 struct byte_stack
*stack
;
343 for (stack
= byte_stack_list
; stack
; stack
= stack
->next
)
345 /* If STACK->top is null here, this means there's an opcode in
346 Fbyte_code that wasn't expected to GC, but did. To find out
347 which opcode this is, record the value of `stack', and walk
348 up the stack in a debugger, stopping in frames of Fbyte_code.
349 The culprit is found in the frame of Fbyte_code where the
350 address of its local variable `stack' is equal to the
351 recorded value of `stack' here. */
352 eassert (stack
->top
);
354 for (obj
= stack
->bottom
; obj
<= stack
->top
; ++obj
)
357 mark_object (stack
->byte_string
);
358 mark_object (stack
->constants
);
363 /* Unmark objects in the stacks on byte_stack_list. Relocate program
364 counters. Called when GC has completed. */
367 unmark_byte_stack (void)
369 struct byte_stack
*stack
;
371 for (stack
= byte_stack_list
; stack
; stack
= stack
->next
)
373 if (stack
->byte_string_start
!= SDATA (stack
->byte_string
))
375 ptrdiff_t offset
= stack
->pc
- stack
->byte_string_start
;
376 stack
->byte_string_start
= SDATA (stack
->byte_string
);
377 stack
->pc
= stack
->byte_string_start
+ offset
;
383 /* Fetch the next byte from the bytecode stream */
385 #define FETCH *stack.pc++
387 /* Fetch two bytes from the bytecode stream and make a 16-bit number
390 #define FETCH2 (op = FETCH, op + (FETCH << 8))
392 /* Push x onto the execution stack. This used to be #define PUSH(x)
393 (*++stackp = (x)) This oddity is necessary because Alliant can't be
394 bothered to compile the preincrement operator properly, as of 4/91.
397 #define PUSH(x) (top++, *top = (x))
399 /* Pop a value off the execution stack. */
403 /* Discard n values from the execution stack. */
405 #define DISCARD(n) (top -= (n))
407 /* Get the value which is at the top of the execution stack, but don't
412 /* Actions that must be performed before and after calling a function
415 #if !BYTE_MAINTAIN_TOP
416 #define BEFORE_POTENTIAL_GC() ((void)0)
417 #define AFTER_POTENTIAL_GC() ((void)0)
419 #define BEFORE_POTENTIAL_GC() stack.top = top
420 #define AFTER_POTENTIAL_GC() stack.top = NULL
423 /* Garbage collect if we have consed enough since the last time.
424 We do this at every branch, to avoid loops that never GC. */
428 BEFORE_POTENTIAL_GC (); \
430 AFTER_POTENTIAL_GC (); \
433 /* Check for jumping out of range. */
435 #ifdef BYTE_CODE_SAFE
437 #define CHECK_RANGE(ARG) \
438 if (ARG >= bytestr_length) abort ()
440 #else /* not BYTE_CODE_SAFE */
442 #define CHECK_RANGE(ARG)
444 #endif /* not BYTE_CODE_SAFE */
446 /* A version of the QUIT macro which makes sure that the stack top is
447 set before signaling `quit'. */
449 #define BYTE_CODE_QUIT \
451 if (!NILP (Vquit_flag) && NILP (Vinhibit_quit)) \
453 Lisp_Object flag = Vquit_flag; \
455 BEFORE_POTENTIAL_GC (); \
456 if (EQ (Vthrow_on_input, flag)) \
457 Fthrow (Vthrow_on_input, Qt); \
458 Fsignal (Qquit, Qnil); \
459 AFTER_POTENTIAL_GC (); \
461 ELSE_PENDING_SIGNALS \
465 DEFUN ("byte-code", Fbyte_code
, Sbyte_code
, 3, 3, 0,
466 doc
: /* Function used internally in byte-compiled code.
467 The first argument, BYTESTR, is a string of byte code;
468 the second, VECTOR, a vector of constants;
469 the third, MAXDEPTH, the maximum stack depth used in this function.
470 If the third argument is incorrect, Emacs may crash. */)
471 (Lisp_Object bytestr
, Lisp_Object vector
, Lisp_Object maxdepth
)
473 return exec_byte_code (bytestr
, vector
, maxdepth
, Qnil
, 0, NULL
);
476 /* Execute the byte-code in BYTESTR. VECTOR is the constant vector, and
477 MAXDEPTH is the maximum stack depth used (if MAXDEPTH is incorrect,
478 emacs may crash!). If ARGS_TEMPLATE is non-nil, it should be a lisp
479 argument list (including &rest, &optional, etc.), and ARGS, of size
480 NARGS, should be a vector of the actual arguments. The arguments in
481 ARGS are pushed on the stack according to ARGS_TEMPLATE before
482 executing BYTESTR. */
485 exec_byte_code (Lisp_Object bytestr
, Lisp_Object vector
, Lisp_Object maxdepth
,
486 Lisp_Object args_template
, ptrdiff_t nargs
, Lisp_Object
*args
)
488 ptrdiff_t count
= SPECPDL_INDEX ();
489 #ifdef BYTE_CODE_METER
494 /* Lisp_Object v1, v2; */
495 Lisp_Object
*vectorp
;
496 #ifdef BYTE_CODE_SAFE
497 ptrdiff_t const_length
;
499 ptrdiff_t bytestr_length
;
501 struct byte_stack stack
;
505 #if 0 /* CHECK_FRAME_FONT */
507 struct frame
*f
= SELECTED_FRAME ();
509 && FRAME_FONT (f
)->direction
!= 0
510 && FRAME_FONT (f
)->direction
!= 1)
515 CHECK_STRING (bytestr
);
516 CHECK_VECTOR (vector
);
517 CHECK_NATNUM (maxdepth
);
519 #ifdef BYTE_CODE_SAFE
520 const_length
= ASIZE (vector
);
523 if (STRING_MULTIBYTE (bytestr
))
524 /* BYTESTR must have been produced by Emacs 20.2 or the earlier
525 because they produced a raw 8-bit string for byte-code and now
526 such a byte-code string is loaded as multibyte while raw 8-bit
527 characters converted to multibyte form. Thus, now we must
528 convert them back to the originally intended unibyte form. */
529 bytestr
= Fstring_as_unibyte (bytestr
);
531 #ifdef BYTE_CODE_SAFE
532 bytestr_length
= SBYTES (bytestr
);
534 vectorp
= XVECTOR (vector
)->contents
;
536 stack
.byte_string
= bytestr
;
537 stack
.pc
= stack
.byte_string_start
= SDATA (bytestr
);
538 stack
.constants
= vector
;
539 if (MAX_ALLOCA
/ word_size
<= XFASTINT (maxdepth
))
540 memory_full (SIZE_MAX
);
541 top
= alloca ((XFASTINT (maxdepth
) + 1) * sizeof *top
);
542 #if BYTE_MAINTAIN_TOP
543 stack
.bottom
= top
+ 1;
546 stack
.next
= byte_stack_list
;
547 byte_stack_list
= &stack
;
549 #ifdef BYTE_CODE_SAFE
550 stacke
= stack
.bottom
- 1 + XFASTINT (maxdepth
);
553 if (INTEGERP (args_template
))
555 ptrdiff_t at
= XINT (args_template
);
557 int mandatory
= at
& 127;
558 ptrdiff_t nonrest
= at
>> 8;
559 eassert (mandatory
<= nonrest
);
560 if (nargs
<= nonrest
)
563 for (i
= 0 ; i
< nargs
; i
++, args
++)
565 if (nargs
< mandatory
)
566 /* Too few arguments. */
567 Fsignal (Qwrong_number_of_arguments
,
568 Fcons (Fcons (make_number (mandatory
),
569 rest
? Qand_rest
: make_number (nonrest
)),
570 Fcons (make_number (nargs
), Qnil
)));
573 for (; i
< nonrest
; i
++)
582 for (i
= 0 ; i
< nonrest
; i
++, args
++)
584 PUSH (Flist (nargs
- nonrest
, args
));
587 /* Too many arguments. */
588 Fsignal (Qwrong_number_of_arguments
,
589 Fcons (Fcons (make_number (mandatory
),
590 make_number (nonrest
)),
591 Fcons (make_number (nargs
), Qnil
)));
593 else if (! NILP (args_template
))
594 /* We should push some arguments on the stack. */
596 error ("Unknown args template!");
601 #ifdef BYTE_CODE_SAFE
604 else if (top
< stack
.bottom
- 1)
608 #ifdef BYTE_CODE_METER
610 this_op
= op
= FETCH
;
611 METER_CODE (prev_op
, op
);
613 #ifndef BYTE_CODE_THREADED
618 /* The interpreter can be compiled one of two ways: as an
619 ordinary switch-based interpreter, or as a threaded
620 interpreter. The threaded interpreter relies on GCC's
621 computed goto extension, so it is not available everywhere.
622 Threading provides a performance boost. These macros are how
623 we allow the code to be compiled both ways. */
624 #ifdef BYTE_CODE_THREADED
625 /* The CASE macro introduces an instruction's body. It is
626 either a label or a case label. */
627 #define CASE(OP) insn_ ## OP
628 /* NEXT is invoked at the end of an instruction to go to the
629 next instruction. It is either a computed goto, or a
631 #define NEXT goto *(targets[op = FETCH])
632 /* FIRST is like NEXT, but is only used at the start of the
633 interpreter body. In the switch-based interpreter it is the
634 switch, so the threaded definition must include a semicolon. */
636 /* Most cases are labeled with the CASE macro, above.
637 CASE_DEFAULT is one exception; it is used if the interpreter
638 being built requires a default case. The threaded
639 interpreter does not, because the dispatch table is
640 completely filled. */
642 /* This introduces an instruction that is known to call abort. */
643 #define CASE_ABORT CASE (Bstack_ref): CASE (default)
645 /* See above for the meaning of the various defines. */
646 #define CASE(OP) case OP
648 #define FIRST switch (op)
649 #define CASE_DEFAULT case 255: default:
650 #define CASE_ABORT case 0
653 #ifdef BYTE_CODE_THREADED
655 /* A convenience define that saves us a lot of typing and makes
656 the table clearer. */
657 #define LABEL(OP) [OP] = &&insn_ ## OP
659 #if (__GNUC__ == 4 && 6 <= __GNUC_MINOR__) || 4 < __GNUC__
660 # pragma GCC diagnostic push
661 # pragma GCC diagnostic ignored "-Woverride-init"
664 /* This is the dispatch table for the threaded interpreter. */
665 static const void *const targets
[256] =
667 [0 ... (Bconstant
- 1)] = &&insn_default
,
668 [Bconstant
... 255] = &&insn_Bconstant
,
670 #define DEFINE(name, value) LABEL (name) ,
675 #if (__GNUC__ == 4 && 6 <= __GNUC_MINOR__) || 4 < __GNUC__
676 # pragma GCC diagnostic pop
697 /* This seems to be the most frequently executed byte-code
698 among the Bvarref's, so avoid a goto here. */
708 if (XSYMBOL (v1
)->redirect
!= SYMBOL_PLAINVAL
709 || (v2
= SYMBOL_VAL (XSYMBOL (v1
)),
712 BEFORE_POTENTIAL_GC ();
713 v2
= Fsymbol_value (v1
);
714 AFTER_POTENTIAL_GC ();
719 BEFORE_POTENTIAL_GC ();
720 v2
= Fsymbol_value (v1
);
721 AFTER_POTENTIAL_GC ();
737 stack
.pc
= stack
.byte_string_start
+ op
;
752 BEFORE_POTENTIAL_GC ();
753 wrong_type_argument (Qlistp
, v1
);
754 AFTER_POTENTIAL_GC ();
763 TOP
= EQ (v1
, TOP
) ? Qt
: Qnil
;
770 BEFORE_POTENTIAL_GC ();
772 TOP
= Fmemq (TOP
, v1
);
773 AFTER_POTENTIAL_GC ();
787 BEFORE_POTENTIAL_GC ();
788 wrong_type_argument (Qlistp
, v1
);
789 AFTER_POTENTIAL_GC ();
811 Lisp_Object sym
, val
;
816 /* Inline the most common case. */
818 && !EQ (val
, Qunbound
)
819 && !XSYMBOL (sym
)->redirect
820 && !SYMBOL_CONSTANT_P (sym
))
821 SET_SYMBOL_VAL (XSYMBOL (sym
), val
);
824 BEFORE_POTENTIAL_GC ();
825 set_internal (sym
, val
, Qnil
, 0);
826 AFTER_POTENTIAL_GC ();
840 /* ------------------ */
858 /* Specbind can signal and thus GC. */
859 BEFORE_POTENTIAL_GC ();
860 specbind (vectorp
[op
], POP
);
861 AFTER_POTENTIAL_GC ();
881 BEFORE_POTENTIAL_GC ();
883 #ifdef BYTE_CODE_METER
884 if (byte_metering_on
&& SYMBOLP (TOP
))
889 v2
= Fget (v1
, Qbyte_code_meter
);
891 && XINT (v2
) < MOST_POSITIVE_FIXNUM
)
893 XSETINT (v2
, XINT (v2
) + 1);
894 Fput (v1
, Qbyte_code_meter
, v2
);
898 TOP
= Ffuncall (op
+ 1, &TOP
);
899 AFTER_POTENTIAL_GC ();
919 BEFORE_POTENTIAL_GC ();
920 unbind_to (SPECPDL_INDEX () - op
, Qnil
);
921 AFTER_POTENTIAL_GC ();
924 CASE (Bunbind_all
): /* Obsolete. Never used. */
925 /* To unbind back to the beginning of this frame. Not used yet,
926 but will be needed for tail-recursion elimination. */
927 BEFORE_POTENTIAL_GC ();
928 unbind_to (count
, Qnil
);
929 AFTER_POTENTIAL_GC ();
935 op
= FETCH2
; /* pc = FETCH2 loses since FETCH2 contains pc++ */
937 stack
.pc
= stack
.byte_string_start
+ op
;
940 CASE (Bgotoifnonnil
):
950 stack
.pc
= stack
.byte_string_start
+ op
;
955 CASE (Bgotoifnilelsepop
):
962 stack
.pc
= stack
.byte_string_start
+ op
;
967 CASE (Bgotoifnonnilelsepop
):
974 stack
.pc
= stack
.byte_string_start
+ op
;
982 stack
.pc
+= (int) *stack
.pc
- 127;
993 stack
.pc
+= (int) *stack
.pc
- 128;
999 CASE (BRgotoifnonnil
):
1007 stack
.pc
+= (int) *stack
.pc
- 128;
1013 CASE (BRgotoifnilelsepop
):
1019 stack
.pc
+= op
- 128;
1024 CASE (BRgotoifnonnilelsepop
):
1030 stack
.pc
+= op
- 128;
1044 PUSH (vectorp
[FETCH2
]);
1047 CASE (Bsave_excursion
):
1048 record_unwind_protect (save_excursion_restore
,
1049 save_excursion_save ());
1052 CASE (Bsave_current_buffer
): /* Obsolete since ??. */
1053 CASE (Bsave_current_buffer_1
):
1054 record_unwind_protect (set_buffer_if_live
, Fcurrent_buffer ());
1057 CASE (Bsave_window_excursion
): /* Obsolete since 24.1. */
1059 register ptrdiff_t count1
= SPECPDL_INDEX ();
1060 record_unwind_protect (Fset_window_configuration
,
1061 Fcurrent_window_configuration (Qnil
));
1062 BEFORE_POTENTIAL_GC ();
1064 unbind_to (count1
, TOP
);
1065 AFTER_POTENTIAL_GC ();
1069 CASE (Bsave_restriction
):
1070 record_unwind_protect (save_restriction_restore
,
1071 save_restriction_save ());
1074 CASE (Bcatch
): /* FIXME: ill-suited for lexbind. */
1077 BEFORE_POTENTIAL_GC ();
1079 TOP
= internal_catch (TOP
, eval_sub
, v1
);
1080 AFTER_POTENTIAL_GC ();
1084 CASE (Bunwind_protect
): /* FIXME: avoid closure for lexbind. */
1085 record_unwind_protect (Fprogn
, POP
);
1088 CASE (Bcondition_case
): /* FIXME: ill-suited for lexbind. */
1090 Lisp_Object handlers
, body
;
1093 BEFORE_POTENTIAL_GC ();
1094 TOP
= internal_lisp_condition_case (TOP
, body
, handlers
);
1095 AFTER_POTENTIAL_GC ();
1099 CASE (Btemp_output_buffer_setup
): /* Obsolete since 24.1. */
1100 BEFORE_POTENTIAL_GC ();
1102 temp_output_buffer_setup (SSDATA (TOP
));
1103 AFTER_POTENTIAL_GC ();
1104 TOP
= Vstandard_output
;
1107 CASE (Btemp_output_buffer_show
): /* Obsolete since 24.1. */
1110 BEFORE_POTENTIAL_GC ();
1112 temp_output_buffer_show (TOP
);
1114 /* pop binding of standard-output */
1115 unbind_to (SPECPDL_INDEX () - 1, Qnil
);
1116 AFTER_POTENTIAL_GC ();
1124 BEFORE_POTENTIAL_GC ();
1130 while (--n
>= 0 && CONSP (v1
))
1134 AFTER_POTENTIAL_GC ();
1139 TOP
= SYMBOLP (TOP
) ? Qt
: Qnil
;
1143 TOP
= CONSP (TOP
) ? Qt
: Qnil
;
1147 TOP
= STRINGP (TOP
) ? Qt
: Qnil
;
1151 TOP
= CONSP (TOP
) || NILP (TOP
) ? Qt
: Qnil
;
1155 TOP
= NILP (TOP
) ? Qt
: Qnil
;
1162 TOP
= Fcons (TOP
, v1
);
1167 TOP
= Fcons (TOP
, Qnil
);
1174 TOP
= Fcons (TOP
, Fcons (v1
, Qnil
));
1180 TOP
= Flist (3, &TOP
);
1185 TOP
= Flist (4, &TOP
);
1191 TOP
= Flist (op
, &TOP
);
1195 BEFORE_POTENTIAL_GC ();
1196 TOP
= Flength (TOP
);
1197 AFTER_POTENTIAL_GC ();
1203 BEFORE_POTENTIAL_GC ();
1205 TOP
= Faref (TOP
, v1
);
1206 AFTER_POTENTIAL_GC ();
1213 BEFORE_POTENTIAL_GC ();
1215 TOP
= Faset (TOP
, v1
, v2
);
1216 AFTER_POTENTIAL_GC ();
1220 CASE (Bsymbol_value
):
1221 BEFORE_POTENTIAL_GC ();
1222 TOP
= Fsymbol_value (TOP
);
1223 AFTER_POTENTIAL_GC ();
1226 CASE (Bsymbol_function
):
1227 BEFORE_POTENTIAL_GC ();
1228 TOP
= Fsymbol_function (TOP
);
1229 AFTER_POTENTIAL_GC ();
1235 BEFORE_POTENTIAL_GC ();
1237 TOP
= Fset (TOP
, v1
);
1238 AFTER_POTENTIAL_GC ();
1245 BEFORE_POTENTIAL_GC ();
1247 TOP
= Ffset (TOP
, v1
);
1248 AFTER_POTENTIAL_GC ();
1255 BEFORE_POTENTIAL_GC ();
1257 TOP
= Fget (TOP
, v1
);
1258 AFTER_POTENTIAL_GC ();
1265 BEFORE_POTENTIAL_GC ();
1267 TOP
= Fsubstring (TOP
, v1
, v2
);
1268 AFTER_POTENTIAL_GC ();
1273 BEFORE_POTENTIAL_GC ();
1275 TOP
= Fconcat (2, &TOP
);
1276 AFTER_POTENTIAL_GC ();
1280 BEFORE_POTENTIAL_GC ();
1282 TOP
= Fconcat (3, &TOP
);
1283 AFTER_POTENTIAL_GC ();
1287 BEFORE_POTENTIAL_GC ();
1289 TOP
= Fconcat (4, &TOP
);
1290 AFTER_POTENTIAL_GC ();
1295 BEFORE_POTENTIAL_GC ();
1297 TOP
= Fconcat (op
, &TOP
);
1298 AFTER_POTENTIAL_GC ();
1307 XSETINT (v1
, XINT (v1
) - 1);
1312 BEFORE_POTENTIAL_GC ();
1314 AFTER_POTENTIAL_GC ();
1325 XSETINT (v1
, XINT (v1
) + 1);
1330 BEFORE_POTENTIAL_GC ();
1332 AFTER_POTENTIAL_GC ();
1340 BEFORE_POTENTIAL_GC ();
1342 CHECK_NUMBER_OR_FLOAT_COERCE_MARKER (v1
);
1343 CHECK_NUMBER_OR_FLOAT_COERCE_MARKER (v2
);
1344 AFTER_POTENTIAL_GC ();
1345 if (FLOATP (v1
) || FLOATP (v2
))
1349 f1
= (FLOATP (v1
) ? XFLOAT_DATA (v1
) : XINT (v1
));
1350 f2
= (FLOATP (v2
) ? XFLOAT_DATA (v2
) : XINT (v2
));
1351 TOP
= (f1
== f2
? Qt
: Qnil
);
1354 TOP
= (XINT (v1
) == XINT (v2
) ? Qt
: Qnil
);
1361 BEFORE_POTENTIAL_GC ();
1363 TOP
= Fgtr (TOP
, v1
);
1364 AFTER_POTENTIAL_GC ();
1371 BEFORE_POTENTIAL_GC ();
1373 TOP
= Flss (TOP
, v1
);
1374 AFTER_POTENTIAL_GC ();
1381 BEFORE_POTENTIAL_GC ();
1383 TOP
= Fleq (TOP
, v1
);
1384 AFTER_POTENTIAL_GC ();
1391 BEFORE_POTENTIAL_GC ();
1393 TOP
= Fgeq (TOP
, v1
);
1394 AFTER_POTENTIAL_GC ();
1399 BEFORE_POTENTIAL_GC ();
1401 TOP
= Fminus (2, &TOP
);
1402 AFTER_POTENTIAL_GC ();
1411 XSETINT (v1
, - XINT (v1
));
1416 BEFORE_POTENTIAL_GC ();
1417 TOP
= Fminus (1, &TOP
);
1418 AFTER_POTENTIAL_GC ();
1424 BEFORE_POTENTIAL_GC ();
1426 TOP
= Fplus (2, &TOP
);
1427 AFTER_POTENTIAL_GC ();
1431 BEFORE_POTENTIAL_GC ();
1433 TOP
= Fmax (2, &TOP
);
1434 AFTER_POTENTIAL_GC ();
1438 BEFORE_POTENTIAL_GC ();
1440 TOP
= Fmin (2, &TOP
);
1441 AFTER_POTENTIAL_GC ();
1445 BEFORE_POTENTIAL_GC ();
1447 TOP
= Ftimes (2, &TOP
);
1448 AFTER_POTENTIAL_GC ();
1452 BEFORE_POTENTIAL_GC ();
1454 TOP
= Fquo (2, &TOP
);
1455 AFTER_POTENTIAL_GC ();
1461 BEFORE_POTENTIAL_GC ();
1463 TOP
= Frem (TOP
, v1
);
1464 AFTER_POTENTIAL_GC ();
1471 XSETFASTINT (v1
, PT
);
1477 BEFORE_POTENTIAL_GC ();
1478 TOP
= Fgoto_char (TOP
);
1479 AFTER_POTENTIAL_GC ();
1483 BEFORE_POTENTIAL_GC ();
1484 TOP
= Finsert (1, &TOP
);
1485 AFTER_POTENTIAL_GC ();
1490 BEFORE_POTENTIAL_GC ();
1492 TOP
= Finsert (op
, &TOP
);
1493 AFTER_POTENTIAL_GC ();
1499 XSETFASTINT (v1
, ZV
);
1507 XSETFASTINT (v1
, BEGV
);
1513 BEFORE_POTENTIAL_GC ();
1514 TOP
= Fchar_after (TOP
);
1515 AFTER_POTENTIAL_GC ();
1518 CASE (Bfollowing_char
):
1521 BEFORE_POTENTIAL_GC ();
1522 v1
= Ffollowing_char ();
1523 AFTER_POTENTIAL_GC ();
1528 CASE (Bpreceding_char
):
1531 BEFORE_POTENTIAL_GC ();
1532 v1
= Fprevious_char ();
1533 AFTER_POTENTIAL_GC ();
1538 CASE (Bcurrent_column
):
1541 BEFORE_POTENTIAL_GC ();
1542 XSETFASTINT (v1
, current_column ());
1543 AFTER_POTENTIAL_GC ();
1549 BEFORE_POTENTIAL_GC ();
1550 TOP
= Findent_to (TOP
, Qnil
);
1551 AFTER_POTENTIAL_GC ();
1570 CASE (Bcurrent_buffer
):
1571 PUSH (Fcurrent_buffer ());
1575 BEFORE_POTENTIAL_GC ();
1576 TOP
= Fset_buffer (TOP
);
1577 AFTER_POTENTIAL_GC ();
1580 CASE (Binteractive_p
): /* Obsolete since 24.1. */
1581 PUSH (Finteractive_p ());
1584 CASE (Bforward_char
):
1585 BEFORE_POTENTIAL_GC ();
1586 TOP
= Fforward_char (TOP
);
1587 AFTER_POTENTIAL_GC ();
1590 CASE (Bforward_word
):
1591 BEFORE_POTENTIAL_GC ();
1592 TOP
= Fforward_word (TOP
);
1593 AFTER_POTENTIAL_GC ();
1596 CASE (Bskip_chars_forward
):
1599 BEFORE_POTENTIAL_GC ();
1601 TOP
= Fskip_chars_forward (TOP
, v1
);
1602 AFTER_POTENTIAL_GC ();
1606 CASE (Bskip_chars_backward
):
1609 BEFORE_POTENTIAL_GC ();
1611 TOP
= Fskip_chars_backward (TOP
, v1
);
1612 AFTER_POTENTIAL_GC ();
1616 CASE (Bforward_line
):
1617 BEFORE_POTENTIAL_GC ();
1618 TOP
= Fforward_line (TOP
);
1619 AFTER_POTENTIAL_GC ();
1622 CASE (Bchar_syntax
):
1626 BEFORE_POTENTIAL_GC ();
1627 CHECK_CHARACTER (TOP
);
1628 AFTER_POTENTIAL_GC ();
1630 if (NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
1631 MAKE_CHAR_MULTIBYTE (c
);
1632 XSETFASTINT (TOP
, syntax_code_spec
[(int) SYNTAX (c
)]);
1636 CASE (Bbuffer_substring
):
1639 BEFORE_POTENTIAL_GC ();
1641 TOP
= Fbuffer_substring (TOP
, v1
);
1642 AFTER_POTENTIAL_GC ();
1646 CASE (Bdelete_region
):
1649 BEFORE_POTENTIAL_GC ();
1651 TOP
= Fdelete_region (TOP
, v1
);
1652 AFTER_POTENTIAL_GC ();
1656 CASE (Bnarrow_to_region
):
1659 BEFORE_POTENTIAL_GC ();
1661 TOP
= Fnarrow_to_region (TOP
, v1
);
1662 AFTER_POTENTIAL_GC ();
1667 BEFORE_POTENTIAL_GC ();
1669 AFTER_POTENTIAL_GC ();
1672 CASE (Bend_of_line
):
1673 BEFORE_POTENTIAL_GC ();
1674 TOP
= Fend_of_line (TOP
);
1675 AFTER_POTENTIAL_GC ();
1681 BEFORE_POTENTIAL_GC ();
1684 TOP
= Fset_marker (TOP
, v2
, v1
);
1685 AFTER_POTENTIAL_GC ();
1689 CASE (Bmatch_beginning
):
1690 BEFORE_POTENTIAL_GC ();
1691 TOP
= Fmatch_beginning (TOP
);
1692 AFTER_POTENTIAL_GC ();
1696 BEFORE_POTENTIAL_GC ();
1697 TOP
= Fmatch_end (TOP
);
1698 AFTER_POTENTIAL_GC ();
1702 BEFORE_POTENTIAL_GC ();
1703 TOP
= Fupcase (TOP
);
1704 AFTER_POTENTIAL_GC ();
1708 BEFORE_POTENTIAL_GC ();
1709 TOP
= Fdowncase (TOP
);
1710 AFTER_POTENTIAL_GC ();
1713 CASE (Bstringeqlsign
):
1716 BEFORE_POTENTIAL_GC ();
1718 TOP
= Fstring_equal (TOP
, v1
);
1719 AFTER_POTENTIAL_GC ();
1726 BEFORE_POTENTIAL_GC ();
1728 TOP
= Fstring_lessp (TOP
, v1
);
1729 AFTER_POTENTIAL_GC ();
1737 TOP
= Fequal (TOP
, v1
);
1744 BEFORE_POTENTIAL_GC ();
1746 TOP
= Fnthcdr (TOP
, v1
);
1747 AFTER_POTENTIAL_GC ();
1756 /* Exchange args and then do nth. */
1758 BEFORE_POTENTIAL_GC ();
1762 AFTER_POTENTIAL_GC ();
1765 while (--n
>= 0 && CONSP (v1
))
1772 BEFORE_POTENTIAL_GC ();
1774 TOP
= Felt (TOP
, v1
);
1775 AFTER_POTENTIAL_GC ();
1783 BEFORE_POTENTIAL_GC ();
1785 TOP
= Fmember (TOP
, v1
);
1786 AFTER_POTENTIAL_GC ();
1793 BEFORE_POTENTIAL_GC ();
1795 TOP
= Fassq (TOP
, v1
);
1796 AFTER_POTENTIAL_GC ();
1801 BEFORE_POTENTIAL_GC ();
1802 TOP
= Fnreverse (TOP
);
1803 AFTER_POTENTIAL_GC ();
1809 BEFORE_POTENTIAL_GC ();
1811 TOP
= Fsetcar (TOP
, v1
);
1812 AFTER_POTENTIAL_GC ();
1819 BEFORE_POTENTIAL_GC ();
1821 TOP
= Fsetcdr (TOP
, v1
);
1822 AFTER_POTENTIAL_GC ();
1830 TOP
= CAR_SAFE (v1
);
1838 TOP
= CDR_SAFE (v1
);
1843 BEFORE_POTENTIAL_GC ();
1845 TOP
= Fnconc (2, &TOP
);
1846 AFTER_POTENTIAL_GC ();
1850 TOP
= (NUMBERP (TOP
) ? Qt
: Qnil
);
1854 TOP
= INTEGERP (TOP
) ? Qt
: Qnil
;
1857 #ifdef BYTE_CODE_SAFE
1858 /* These are intentionally written using 'case' syntax,
1859 because they are incompatible with the threaded
1863 BEFORE_POTENTIAL_GC ();
1864 error ("set-mark is an obsolete bytecode");
1865 AFTER_POTENTIAL_GC ();
1868 BEFORE_POTENTIAL_GC ();
1869 error ("scan-buffer is an obsolete bytecode");
1870 AFTER_POTENTIAL_GC ();
1875 /* Actually this is Bstack_ref with offset 0, but we use Bdup
1876 for that instead. */
1877 /* CASE (Bstack_ref): */
1880 /* Handy byte-codes for lexical binding. */
1887 Lisp_Object
*ptr
= top
- (op
- Bstack_ref
);
1893 Lisp_Object
*ptr
= top
- (FETCH
);
1899 Lisp_Object
*ptr
= top
- (FETCH2
);
1904 /* stack-set-0 = discard; stack-set-1 = discard-1-preserve-tos. */
1906 Lisp_Object
*ptr
= top
- (FETCH
);
1912 Lisp_Object
*ptr
= top
- (FETCH2
);
1928 #ifdef BYTE_CODE_SAFE
1933 if ((op
-= Bconstant
) >= const_length
)
1939 PUSH (vectorp
[op
- Bconstant
]);
1947 byte_stack_list
= byte_stack_list
->next
;
1949 /* Binds and unbinds are supposed to be compiled balanced. */
1950 if (SPECPDL_INDEX () != count
)
1951 #ifdef BYTE_CODE_SAFE
1952 error ("binding stack not balanced (serious byte compiler bug)");
1961 syms_of_bytecode (void)
1963 DEFSYM (Qbytecode
, "byte-code");
1965 defsubr (&Sbyte_code
);
1967 #ifdef BYTE_CODE_METER
1969 DEFVAR_LISP ("byte-code-meter", Vbyte_code_meter
,
1970 doc
: /* A vector of vectors which holds a histogram of byte-code usage.
1971 \(aref (aref byte-code-meter 0) CODE) indicates how many times the byte
1972 opcode CODE has been executed.
1973 \(aref (aref byte-code-meter CODE1) CODE2), where CODE1 is not 0,
1974 indicates how many times the byte opcodes CODE1 and CODE2 have been
1975 executed in succession. */);
1977 DEFVAR_BOOL ("byte-metering-on", byte_metering_on
,
1978 doc
: /* If non-nil, keep profiling information on byte code usage.
1979 The variable byte-code-meter indicates how often each byte opcode is used.
1980 If a symbol has a property named `byte-code-meter' whose value is an
1981 integer, it is incremented each time that symbol's function is called. */);
1983 byte_metering_on
= 0;
1984 Vbyte_code_meter
= Fmake_vector (make_number (256), make_number (0));
1985 DEFSYM (Qbyte_code_meter
, "byte-code-meter");
1989 ASET (Vbyte_code_meter
, i
,
1990 Fmake_vector (make_number (256), make_number (0)));