1 /* Execution of byte code produced by bytecomp.el.
2 Copyright (C) 1985-1988, 1993, 2000-2013 Free Software Foundation,
5 This file is part of GNU Emacs.
7 GNU Emacs is free software: you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation, either version 3 of the License, or
10 (at your option) any later version.
12 GNU Emacs is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
21 hacked on by jwz@lucid.com 17-jun-91
22 o added a compile-time switch to turn on simple sanity checking;
23 o put back the obsolete byte-codes for error-detection;
24 o added a new instruction, unbind_all, which I will use for
25 tail-recursion elimination;
26 o made temp_output_buffer_show be called with the right number
28 o made the new bytecodes be called with args in the right order;
29 o added metering support.
32 o added relative jump instructions;
33 o all conditionals now only do QUIT if they jump.
39 #include "character.h"
44 #ifdef CHECK_FRAME_FONT
50 * define BYTE_CODE_SAFE to enable some minor sanity checking (useful for
51 * debugging the byte compiler...)
53 * define BYTE_CODE_METER to enable generation of a byte-op usage histogram.
55 /* #define BYTE_CODE_SAFE */
56 /* #define BYTE_CODE_METER */
58 /* If BYTE_CODE_THREADED is defined, then the interpreter will be
59 indirect threaded, using GCC's computed goto extension. This code,
60 as currently implemented, is incompatible with BYTE_CODE_SAFE and
62 #if defined (__GNUC__) && !defined (BYTE_CODE_SAFE) && !defined (BYTE_CODE_METER)
63 #define BYTE_CODE_THREADED
67 #ifdef BYTE_CODE_METER
69 Lisp_Object Qbyte_code_meter
;
70 #define METER_2(code1, code2) AREF (AREF (Vbyte_code_meter, code1), code2)
71 #define METER_1(code) METER_2 (0, code)
73 #define METER_CODE(last_code, this_code) \
75 if (byte_metering_on) \
77 if (XFASTINT (METER_1 (this_code)) < MOST_POSITIVE_FIXNUM) \
78 XSETFASTINT (METER_1 (this_code), \
79 XFASTINT (METER_1 (this_code)) + 1); \
81 && (XFASTINT (METER_2 (last_code, this_code)) \
82 < MOST_POSITIVE_FIXNUM)) \
83 XSETFASTINT (METER_2 (last_code, this_code), \
84 XFASTINT (METER_2 (last_code, this_code)) + 1); \
88 #endif /* BYTE_CODE_METER */
94 DEFINE (Bstack_ref, 0) /* Actually, Bstack_ref+0 is not implemented: use dup. */ \
95 DEFINE (Bstack_ref1, 1) \
96 DEFINE (Bstack_ref2, 2) \
97 DEFINE (Bstack_ref3, 3) \
98 DEFINE (Bstack_ref4, 4) \
99 DEFINE (Bstack_ref5, 5) \
100 DEFINE (Bstack_ref6, 6) \
101 DEFINE (Bstack_ref7, 7) \
102 DEFINE (Bvarref, 010) \
103 DEFINE (Bvarref1, 011) \
104 DEFINE (Bvarref2, 012) \
105 DEFINE (Bvarref3, 013) \
106 DEFINE (Bvarref4, 014) \
107 DEFINE (Bvarref5, 015) \
108 DEFINE (Bvarref6, 016) \
109 DEFINE (Bvarref7, 017) \
110 DEFINE (Bvarset, 020) \
111 DEFINE (Bvarset1, 021) \
112 DEFINE (Bvarset2, 022) \
113 DEFINE (Bvarset3, 023) \
114 DEFINE (Bvarset4, 024) \
115 DEFINE (Bvarset5, 025) \
116 DEFINE (Bvarset6, 026) \
117 DEFINE (Bvarset7, 027) \
118 DEFINE (Bvarbind, 030) \
119 DEFINE (Bvarbind1, 031) \
120 DEFINE (Bvarbind2, 032) \
121 DEFINE (Bvarbind3, 033) \
122 DEFINE (Bvarbind4, 034) \
123 DEFINE (Bvarbind5, 035) \
124 DEFINE (Bvarbind6, 036) \
125 DEFINE (Bvarbind7, 037) \
126 DEFINE (Bcall, 040) \
127 DEFINE (Bcall1, 041) \
128 DEFINE (Bcall2, 042) \
129 DEFINE (Bcall3, 043) \
130 DEFINE (Bcall4, 044) \
131 DEFINE (Bcall5, 045) \
132 DEFINE (Bcall6, 046) \
133 DEFINE (Bcall7, 047) \
134 DEFINE (Bunbind, 050) \
135 DEFINE (Bunbind1, 051) \
136 DEFINE (Bunbind2, 052) \
137 DEFINE (Bunbind3, 053) \
138 DEFINE (Bunbind4, 054) \
139 DEFINE (Bunbind5, 055) \
140 DEFINE (Bunbind6, 056) \
141 DEFINE (Bunbind7, 057) \
144 DEFINE (Bsymbolp, 071) \
145 DEFINE (Bconsp, 072) \
146 DEFINE (Bstringp, 073) \
147 DEFINE (Blistp, 074) \
149 DEFINE (Bmemq, 076) \
151 DEFINE (Bcar, 0100) \
152 DEFINE (Bcdr, 0101) \
153 DEFINE (Bcons, 0102) \
154 DEFINE (Blist1, 0103) \
155 DEFINE (Blist2, 0104) \
156 DEFINE (Blist3, 0105) \
157 DEFINE (Blist4, 0106) \
158 DEFINE (Blength, 0107) \
159 DEFINE (Baref, 0110) \
160 DEFINE (Baset, 0111) \
161 DEFINE (Bsymbol_value, 0112) \
162 DEFINE (Bsymbol_function, 0113) \
163 DEFINE (Bset, 0114) \
164 DEFINE (Bfset, 0115) \
165 DEFINE (Bget, 0116) \
166 DEFINE (Bsubstring, 0117) \
167 DEFINE (Bconcat2, 0120) \
168 DEFINE (Bconcat3, 0121) \
169 DEFINE (Bconcat4, 0122) \
170 DEFINE (Bsub1, 0123) \
171 DEFINE (Badd1, 0124) \
172 DEFINE (Beqlsign, 0125) \
173 DEFINE (Bgtr, 0126) \
174 DEFINE (Blss, 0127) \
175 DEFINE (Bleq, 0130) \
176 DEFINE (Bgeq, 0131) \
177 DEFINE (Bdiff, 0132) \
178 DEFINE (Bnegate, 0133) \
179 DEFINE (Bplus, 0134) \
180 DEFINE (Bmax, 0135) \
181 DEFINE (Bmin, 0136) \
182 DEFINE (Bmult, 0137) \
184 DEFINE (Bpoint, 0140) \
185 /* Was Bmark in v17. */ \
186 DEFINE (Bsave_current_buffer, 0141) /* Obsolete. */ \
187 DEFINE (Bgoto_char, 0142) \
188 DEFINE (Binsert, 0143) \
189 DEFINE (Bpoint_max, 0144) \
190 DEFINE (Bpoint_min, 0145) \
191 DEFINE (Bchar_after, 0146) \
192 DEFINE (Bfollowing_char, 0147) \
193 DEFINE (Bpreceding_char, 0150) \
194 DEFINE (Bcurrent_column, 0151) \
195 DEFINE (Bindent_to, 0152) \
196 DEFINE (Beolp, 0154) \
197 DEFINE (Beobp, 0155) \
198 DEFINE (Bbolp, 0156) \
199 DEFINE (Bbobp, 0157) \
200 DEFINE (Bcurrent_buffer, 0160) \
201 DEFINE (Bset_buffer, 0161) \
202 DEFINE (Bsave_current_buffer_1, 0162) /* Replacing Bsave_current_buffer. */ \
203 DEFINE (Binteractive_p, 0164) /* Obsolete since Emacs-24.1. */ \
205 DEFINE (Bforward_char, 0165) \
206 DEFINE (Bforward_word, 0166) \
207 DEFINE (Bskip_chars_forward, 0167) \
208 DEFINE (Bskip_chars_backward, 0170) \
209 DEFINE (Bforward_line, 0171) \
210 DEFINE (Bchar_syntax, 0172) \
211 DEFINE (Bbuffer_substring, 0173) \
212 DEFINE (Bdelete_region, 0174) \
213 DEFINE (Bnarrow_to_region, 0175) \
214 DEFINE (Bwiden, 0176) \
215 DEFINE (Bend_of_line, 0177) \
217 DEFINE (Bconstant2, 0201) \
218 DEFINE (Bgoto, 0202) \
219 DEFINE (Bgotoifnil, 0203) \
220 DEFINE (Bgotoifnonnil, 0204) \
221 DEFINE (Bgotoifnilelsepop, 0205) \
222 DEFINE (Bgotoifnonnilelsepop, 0206) \
223 DEFINE (Breturn, 0207) \
224 DEFINE (Bdiscard, 0210) \
225 DEFINE (Bdup, 0211) \
227 DEFINE (Bsave_excursion, 0212) \
228 DEFINE (Bsave_window_excursion, 0213) /* Obsolete since Emacs-24.1. */ \
229 DEFINE (Bsave_restriction, 0214) \
230 DEFINE (Bcatch, 0215) \
232 DEFINE (Bunwind_protect, 0216) \
233 DEFINE (Bcondition_case, 0217) \
234 DEFINE (Btemp_output_buffer_setup, 0220) /* Obsolete since Emacs-24.1. */ \
235 DEFINE (Btemp_output_buffer_show, 0221) /* Obsolete since Emacs-24.1. */ \
237 DEFINE (Bunbind_all, 0222) /* Obsolete. Never used. */ \
239 DEFINE (Bset_marker, 0223) \
240 DEFINE (Bmatch_beginning, 0224) \
241 DEFINE (Bmatch_end, 0225) \
242 DEFINE (Bupcase, 0226) \
243 DEFINE (Bdowncase, 0227) \
245 DEFINE (Bstringeqlsign, 0230) \
246 DEFINE (Bstringlss, 0231) \
247 DEFINE (Bequal, 0232) \
248 DEFINE (Bnthcdr, 0233) \
249 DEFINE (Belt, 0234) \
250 DEFINE (Bmember, 0235) \
251 DEFINE (Bassq, 0236) \
252 DEFINE (Bnreverse, 0237) \
253 DEFINE (Bsetcar, 0240) \
254 DEFINE (Bsetcdr, 0241) \
255 DEFINE (Bcar_safe, 0242) \
256 DEFINE (Bcdr_safe, 0243) \
257 DEFINE (Bnconc, 0244) \
258 DEFINE (Bquo, 0245) \
259 DEFINE (Brem, 0246) \
260 DEFINE (Bnumberp, 0247) \
261 DEFINE (Bintegerp, 0250) \
263 DEFINE (BRgoto, 0252) \
264 DEFINE (BRgotoifnil, 0253) \
265 DEFINE (BRgotoifnonnil, 0254) \
266 DEFINE (BRgotoifnilelsepop, 0255) \
267 DEFINE (BRgotoifnonnilelsepop, 0256) \
269 DEFINE (BlistN, 0257) \
270 DEFINE (BconcatN, 0260) \
271 DEFINE (BinsertN, 0261) \
273 /* Bstack_ref is code 0. */ \
274 DEFINE (Bstack_set, 0262) \
275 DEFINE (Bstack_set2, 0263) \
276 DEFINE (BdiscardN, 0266) \
278 DEFINE (Bconstant, 0300)
282 #define DEFINE(name, value) name = value,
286 #ifdef BYTE_CODE_SAFE
287 Bscan_buffer
= 0153, /* No longer generated as of v18. */
288 Bset_mark
= 0163 /* this loser is no longer generated as of v18 */
292 /* Whether to maintain a `top' and `bottom' field in the stack frame. */
293 #define BYTE_MAINTAIN_TOP (BYTE_CODE_SAFE || BYTE_MARK_STACK)
295 /* Structure describing a value stack used during byte-code execution
300 /* Program counter. This points into the byte_string below
301 and is relocated when that string is relocated. */
302 const unsigned char *pc
;
304 /* Top and bottom of stack. The bottom points to an area of memory
305 allocated with alloca in Fbyte_code. */
306 #if BYTE_MAINTAIN_TOP
307 Lisp_Object
*top
, *bottom
;
310 /* The string containing the byte-code, and its current address.
311 Storing this here protects it from GC because mark_byte_stack
313 Lisp_Object byte_string
;
314 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
;
322 /* Next entry in byte_stack_list. */
323 struct byte_stack
*next
;
326 /* A list of currently active byte-code execution value stacks.
327 Fbyte_code adds an entry to the head of this list before it starts
328 processing byte-code, and it removed the entry again when it is
329 done. Signaling an error truncates the list analogous to
332 struct byte_stack
*byte_stack_list
;
335 /* Mark objects on byte_stack_list. Called during GC. */
339 mark_byte_stack (void)
341 struct byte_stack
*stack
;
344 for (stack
= byte_stack_list
; stack
; stack
= stack
->next
)
346 /* If STACK->top is null here, this means there's an opcode in
347 Fbyte_code that wasn't expected to GC, but did. To find out
348 which opcode this is, record the value of `stack', and walk
349 up the stack in a debugger, stopping in frames of Fbyte_code.
350 The culprit is found in the frame of Fbyte_code where the
351 address of its local variable `stack' is equal to the
352 recorded value of `stack' here. */
353 eassert (stack
->top
);
355 for (obj
= stack
->bottom
; obj
<= stack
->top
; ++obj
)
358 mark_object (stack
->byte_string
);
359 mark_object (stack
->constants
);
364 /* Unmark objects in the stacks on byte_stack_list. Relocate program
365 counters. Called when GC has completed. */
368 unmark_byte_stack (void)
370 struct byte_stack
*stack
;
372 for (stack
= byte_stack_list
; stack
; stack
= stack
->next
)
374 if (stack
->byte_string_start
!= SDATA (stack
->byte_string
))
376 ptrdiff_t offset
= stack
->pc
- stack
->byte_string_start
;
377 stack
->byte_string_start
= SDATA (stack
->byte_string
);
378 stack
->pc
= stack
->byte_string_start
+ offset
;
384 /* Fetch the next byte from the bytecode stream. */
386 #define FETCH *stack.pc++
388 /* Fetch two bytes from the bytecode stream and make a 16-bit number
391 #define FETCH2 (op = FETCH, op + (FETCH << 8))
393 /* Push x onto the execution stack. This used to be #define PUSH(x)
394 (*++stackp = (x)) This oddity is necessary because Alliant can't be
395 bothered to compile the preincrement operator properly, as of 4/91.
398 #define PUSH(x) (top++, *top = (x))
400 /* Pop a value off the execution stack. */
404 /* Discard n values from the execution stack. */
406 #define DISCARD(n) (top -= (n))
408 /* Get the value which is at the top of the execution stack, but don't
413 /* Actions that must be performed before and after calling a function
416 #if !BYTE_MAINTAIN_TOP
417 #define BEFORE_POTENTIAL_GC() ((void)0)
418 #define AFTER_POTENTIAL_GC() ((void)0)
420 #define BEFORE_POTENTIAL_GC() stack.top = top
421 #define AFTER_POTENTIAL_GC() stack.top = NULL
424 /* Garbage collect if we have consed enough since the last time.
425 We do this at every branch, to avoid loops that never GC. */
429 BEFORE_POTENTIAL_GC (); \
431 AFTER_POTENTIAL_GC (); \
434 /* Check for jumping out of range. */
436 #ifdef BYTE_CODE_SAFE
438 #define CHECK_RANGE(ARG) \
439 if (ARG >= bytestr_length) emacs_abort ()
441 #else /* not BYTE_CODE_SAFE */
443 #define CHECK_RANGE(ARG)
445 #endif /* not BYTE_CODE_SAFE */
447 /* A version of the QUIT macro which makes sure that the stack top is
448 set before signaling `quit'. */
450 #define BYTE_CODE_QUIT \
452 if (!NILP (Vquit_flag) && NILP (Vinhibit_quit)) \
454 Lisp_Object flag = Vquit_flag; \
456 BEFORE_POTENTIAL_GC (); \
457 if (EQ (Vthrow_on_input, flag)) \
458 Fthrow (Vthrow_on_input, Qt); \
459 Fsignal (Qquit, Qnil); \
460 AFTER_POTENTIAL_GC (); \
462 else if (pending_signals) \
463 process_pending_signals (); \
467 DEFUN ("byte-code", Fbyte_code
, Sbyte_code
, 3, 3, 0,
468 doc
: /* Function used internally in byte-compiled code.
469 The first argument, BYTESTR, is a string of byte code;
470 the second, VECTOR, a vector of constants;
471 the third, MAXDEPTH, the maximum stack depth used in this function.
472 If the third argument is incorrect, Emacs may crash. */)
473 (Lisp_Object bytestr
, Lisp_Object vector
, Lisp_Object maxdepth
)
475 return exec_byte_code (bytestr
, vector
, maxdepth
, Qnil
, 0, NULL
);
478 /* Execute the byte-code in BYTESTR. VECTOR is the constant vector, and
479 MAXDEPTH is the maximum stack depth used (if MAXDEPTH is incorrect,
480 emacs may crash!). If ARGS_TEMPLATE is non-nil, it should be a lisp
481 argument list (including &rest, &optional, etc.), and ARGS, of size
482 NARGS, should be a vector of the actual arguments. The arguments in
483 ARGS are pushed on the stack according to ARGS_TEMPLATE before
484 executing BYTESTR. */
487 exec_byte_code (Lisp_Object bytestr
, Lisp_Object vector
, Lisp_Object maxdepth
,
488 Lisp_Object args_template
, ptrdiff_t nargs
, Lisp_Object
*args
)
490 ptrdiff_t count
= SPECPDL_INDEX ();
491 #ifdef BYTE_CODE_METER
496 /* Lisp_Object v1, v2; */
497 Lisp_Object
*vectorp
;
498 #ifdef BYTE_CODE_SAFE
499 ptrdiff_t const_length
;
501 ptrdiff_t bytestr_length
;
503 struct byte_stack stack
;
507 #if 0 /* CHECK_FRAME_FONT */
509 struct frame
*f
= SELECTED_FRAME ();
511 && FRAME_FONT (f
)->direction
!= 0
512 && FRAME_FONT (f
)->direction
!= 1)
517 CHECK_STRING (bytestr
);
518 CHECK_VECTOR (vector
);
519 CHECK_NATNUM (maxdepth
);
521 #ifdef BYTE_CODE_SAFE
522 const_length
= ASIZE (vector
);
525 if (STRING_MULTIBYTE (bytestr
))
526 /* BYTESTR must have been produced by Emacs 20.2 or the earlier
527 because they produced a raw 8-bit string for byte-code and now
528 such a byte-code string is loaded as multibyte while raw 8-bit
529 characters converted to multibyte form. Thus, now we must
530 convert them back to the originally intended unibyte form. */
531 bytestr
= Fstring_as_unibyte (bytestr
);
533 #ifdef BYTE_CODE_SAFE
534 bytestr_length
= SBYTES (bytestr
);
536 vectorp
= XVECTOR (vector
)->contents
;
538 stack
.byte_string
= bytestr
;
539 stack
.pc
= stack
.byte_string_start
= SDATA (bytestr
);
541 stack
.constants
= vector
;
543 if (MAX_ALLOCA
/ word_size
<= XFASTINT (maxdepth
))
544 memory_full (SIZE_MAX
);
545 top
= alloca ((XFASTINT (maxdepth
) + 1) * sizeof *top
);
546 #if BYTE_MAINTAIN_TOP
547 stack
.bottom
= top
+ 1;
550 stack
.next
= byte_stack_list
;
551 byte_stack_list
= &stack
;
553 #ifdef BYTE_CODE_SAFE
554 stacke
= stack
.bottom
- 1 + XFASTINT (maxdepth
);
557 if (INTEGERP (args_template
))
559 ptrdiff_t at
= XINT (args_template
);
560 bool rest
= (at
& 128) != 0;
561 int mandatory
= at
& 127;
562 ptrdiff_t nonrest
= at
>> 8;
563 eassert (mandatory
<= nonrest
);
564 if (nargs
<= nonrest
)
567 for (i
= 0 ; i
< nargs
; i
++, args
++)
569 if (nargs
< mandatory
)
570 /* Too few arguments. */
571 Fsignal (Qwrong_number_of_arguments
,
572 Fcons (Fcons (make_number (mandatory
),
573 rest
? Qand_rest
: make_number (nonrest
)),
574 Fcons (make_number (nargs
), Qnil
)));
577 for (; i
< nonrest
; i
++)
586 for (i
= 0 ; i
< nonrest
; i
++, args
++)
588 PUSH (Flist (nargs
- nonrest
, args
));
591 /* Too many arguments. */
592 Fsignal (Qwrong_number_of_arguments
,
593 Fcons (Fcons (make_number (mandatory
),
594 make_number (nonrest
)),
595 Fcons (make_number (nargs
), Qnil
)));
597 else if (! NILP (args_template
))
598 /* We should push some arguments on the stack. */
600 error ("Unknown args template!");
605 #ifdef BYTE_CODE_SAFE
608 else if (top
< stack
.bottom
- 1)
612 #ifdef BYTE_CODE_METER
614 this_op
= op
= FETCH
;
615 METER_CODE (prev_op
, op
);
617 #ifndef BYTE_CODE_THREADED
622 /* The interpreter can be compiled one of two ways: as an
623 ordinary switch-based interpreter, or as a threaded
624 interpreter. The threaded interpreter relies on GCC's
625 computed goto extension, so it is not available everywhere.
626 Threading provides a performance boost. These macros are how
627 we allow the code to be compiled both ways. */
628 #ifdef BYTE_CODE_THREADED
629 /* The CASE macro introduces an instruction's body. It is
630 either a label or a case label. */
631 #define CASE(OP) insn_ ## OP
632 /* NEXT is invoked at the end of an instruction to go to the
633 next instruction. It is either a computed goto, or a
635 #define NEXT goto *(targets[op = FETCH])
636 /* FIRST is like NEXT, but is only used at the start of the
637 interpreter body. In the switch-based interpreter it is the
638 switch, so the threaded definition must include a semicolon. */
640 /* Most cases are labeled with the CASE macro, above.
641 CASE_DEFAULT is one exception; it is used if the interpreter
642 being built requires a default case. The threaded
643 interpreter does not, because the dispatch table is
644 completely filled. */
646 /* This introduces an instruction that is known to call abort. */
647 #define CASE_ABORT CASE (Bstack_ref): CASE (default)
649 /* See above for the meaning of the various defines. */
650 #define CASE(OP) case OP
652 #define FIRST switch (op)
653 #define CASE_DEFAULT case 255: default:
654 #define CASE_ABORT case 0
657 #ifdef BYTE_CODE_THREADED
659 /* A convenience define that saves us a lot of typing and makes
660 the table clearer. */
661 #define LABEL(OP) [OP] = &&insn_ ## OP
663 #if __GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 6)
664 # pragma GCC diagnostic push
665 # pragma GCC diagnostic ignored "-Woverride-init"
668 /* This is the dispatch table for the threaded interpreter. */
669 static const void *const targets
[256] =
671 [0 ... (Bconstant
- 1)] = &&insn_default
,
672 [Bconstant
... 255] = &&insn_Bconstant
,
674 #define DEFINE(name, value) LABEL (name) ,
679 #if __GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 6)
680 # pragma GCC diagnostic pop
701 /* This seems to be the most frequently executed byte-code
702 among the Bvarref's, so avoid a goto here. */
712 if (XSYMBOL (v1
)->redirect
!= SYMBOL_PLAINVAL
713 || (v2
= SYMBOL_VAL (XSYMBOL (v1
)),
716 BEFORE_POTENTIAL_GC ();
717 v2
= Fsymbol_value (v1
);
718 AFTER_POTENTIAL_GC ();
723 BEFORE_POTENTIAL_GC ();
724 v2
= Fsymbol_value (v1
);
725 AFTER_POTENTIAL_GC ();
741 stack
.pc
= stack
.byte_string_start
+ op
;
756 BEFORE_POTENTIAL_GC ();
757 wrong_type_argument (Qlistp
, v1
);
766 TOP
= EQ (v1
, TOP
) ? Qt
: Qnil
;
773 BEFORE_POTENTIAL_GC ();
775 TOP
= Fmemq (TOP
, v1
);
776 AFTER_POTENTIAL_GC ();
790 BEFORE_POTENTIAL_GC ();
791 wrong_type_argument (Qlistp
, v1
);
813 Lisp_Object sym
, val
;
818 /* Inline the most common case. */
820 && !EQ (val
, Qunbound
)
821 && !XSYMBOL (sym
)->redirect
822 && !SYMBOL_CONSTANT_P (sym
))
823 SET_SYMBOL_VAL (XSYMBOL (sym
), val
);
826 BEFORE_POTENTIAL_GC ();
827 set_internal (sym
, val
, Qnil
, 0);
828 AFTER_POTENTIAL_GC ();
842 /* ------------------ */
860 /* Specbind can signal and thus GC. */
861 BEFORE_POTENTIAL_GC ();
862 specbind (vectorp
[op
], POP
);
863 AFTER_POTENTIAL_GC ();
883 BEFORE_POTENTIAL_GC ();
885 #ifdef BYTE_CODE_METER
886 if (byte_metering_on
&& SYMBOLP (TOP
))
891 v2
= Fget (v1
, Qbyte_code_meter
);
893 && XINT (v2
) < MOST_POSITIVE_FIXNUM
)
895 XSETINT (v2
, XINT (v2
) + 1);
896 Fput (v1
, Qbyte_code_meter
, v2
);
900 TOP
= Ffuncall (op
+ 1, &TOP
);
901 AFTER_POTENTIAL_GC ();
921 BEFORE_POTENTIAL_GC ();
922 unbind_to (SPECPDL_INDEX () - op
, Qnil
);
923 AFTER_POTENTIAL_GC ();
926 CASE (Bunbind_all
): /* Obsolete. Never used. */
927 /* To unbind back to the beginning of this frame. Not used yet,
928 but will be needed for tail-recursion elimination. */
929 BEFORE_POTENTIAL_GC ();
930 unbind_to (count
, Qnil
);
931 AFTER_POTENTIAL_GC ();
937 op
= FETCH2
; /* pc = FETCH2 loses since FETCH2 contains pc++ */
939 stack
.pc
= stack
.byte_string_start
+ op
;
942 CASE (Bgotoifnonnil
):
952 stack
.pc
= stack
.byte_string_start
+ op
;
957 CASE (Bgotoifnilelsepop
):
964 stack
.pc
= stack
.byte_string_start
+ op
;
969 CASE (Bgotoifnonnilelsepop
):
976 stack
.pc
= stack
.byte_string_start
+ op
;
984 stack
.pc
+= (int) *stack
.pc
- 127;
995 stack
.pc
+= (int) *stack
.pc
- 128;
1001 CASE (BRgotoifnonnil
):
1009 stack
.pc
+= (int) *stack
.pc
- 128;
1015 CASE (BRgotoifnilelsepop
):
1021 stack
.pc
+= op
- 128;
1026 CASE (BRgotoifnonnilelsepop
):
1032 stack
.pc
+= op
- 128;
1046 PUSH (vectorp
[FETCH2
]);
1049 CASE (Bsave_excursion
):
1050 record_unwind_protect (save_excursion_restore
,
1051 save_excursion_save ());
1054 CASE (Bsave_current_buffer
): /* Obsolete since ??. */
1055 CASE (Bsave_current_buffer_1
):
1056 record_unwind_current_buffer ();
1059 CASE (Bsave_window_excursion
): /* Obsolete since 24.1. */
1061 register ptrdiff_t count1
= SPECPDL_INDEX ();
1062 record_unwind_protect (Fset_window_configuration
,
1063 Fcurrent_window_configuration (Qnil
));
1064 BEFORE_POTENTIAL_GC ();
1066 unbind_to (count1
, TOP
);
1067 AFTER_POTENTIAL_GC ();
1071 CASE (Bsave_restriction
):
1072 record_unwind_protect (save_restriction_restore
,
1073 save_restriction_save ());
1076 CASE (Bcatch
): /* FIXME: ill-suited for lexbind. */
1079 BEFORE_POTENTIAL_GC ();
1081 TOP
= internal_catch (TOP
, eval_sub
, v1
);
1082 AFTER_POTENTIAL_GC ();
1086 CASE (Bunwind_protect
): /* FIXME: avoid closure for lexbind. */
1087 record_unwind_protect (Fprogn
, POP
);
1090 CASE (Bcondition_case
): /* FIXME: ill-suited for lexbind. */
1092 Lisp_Object handlers
, body
;
1095 BEFORE_POTENTIAL_GC ();
1096 TOP
= internal_lisp_condition_case (TOP
, body
, handlers
);
1097 AFTER_POTENTIAL_GC ();
1101 CASE (Btemp_output_buffer_setup
): /* Obsolete since 24.1. */
1102 BEFORE_POTENTIAL_GC ();
1104 temp_output_buffer_setup (SSDATA (TOP
));
1105 AFTER_POTENTIAL_GC ();
1106 TOP
= Vstandard_output
;
1109 CASE (Btemp_output_buffer_show
): /* Obsolete since 24.1. */
1112 BEFORE_POTENTIAL_GC ();
1114 temp_output_buffer_show (TOP
);
1116 /* pop binding of standard-output */
1117 unbind_to (SPECPDL_INDEX () - 1, Qnil
);
1118 AFTER_POTENTIAL_GC ();
1126 BEFORE_POTENTIAL_GC ();
1132 while (--n
>= 0 && CONSP (v1
))
1136 AFTER_POTENTIAL_GC ();
1141 TOP
= SYMBOLP (TOP
) ? Qt
: Qnil
;
1145 TOP
= CONSP (TOP
) ? Qt
: Qnil
;
1149 TOP
= STRINGP (TOP
) ? Qt
: Qnil
;
1153 TOP
= CONSP (TOP
) || NILP (TOP
) ? Qt
: Qnil
;
1157 TOP
= NILP (TOP
) ? Qt
: Qnil
;
1164 TOP
= Fcons (TOP
, v1
);
1169 TOP
= Fcons (TOP
, Qnil
);
1176 TOP
= Fcons (TOP
, Fcons (v1
, Qnil
));
1182 TOP
= Flist (3, &TOP
);
1187 TOP
= Flist (4, &TOP
);
1193 TOP
= Flist (op
, &TOP
);
1197 BEFORE_POTENTIAL_GC ();
1198 TOP
= Flength (TOP
);
1199 AFTER_POTENTIAL_GC ();
1205 BEFORE_POTENTIAL_GC ();
1207 TOP
= Faref (TOP
, v1
);
1208 AFTER_POTENTIAL_GC ();
1215 BEFORE_POTENTIAL_GC ();
1217 TOP
= Faset (TOP
, v1
, v2
);
1218 AFTER_POTENTIAL_GC ();
1222 CASE (Bsymbol_value
):
1223 BEFORE_POTENTIAL_GC ();
1224 TOP
= Fsymbol_value (TOP
);
1225 AFTER_POTENTIAL_GC ();
1228 CASE (Bsymbol_function
):
1229 BEFORE_POTENTIAL_GC ();
1230 TOP
= Fsymbol_function (TOP
);
1231 AFTER_POTENTIAL_GC ();
1237 BEFORE_POTENTIAL_GC ();
1239 TOP
= Fset (TOP
, v1
);
1240 AFTER_POTENTIAL_GC ();
1247 BEFORE_POTENTIAL_GC ();
1249 TOP
= Ffset (TOP
, v1
);
1250 AFTER_POTENTIAL_GC ();
1257 BEFORE_POTENTIAL_GC ();
1259 TOP
= Fget (TOP
, v1
);
1260 AFTER_POTENTIAL_GC ();
1267 BEFORE_POTENTIAL_GC ();
1269 TOP
= Fsubstring (TOP
, v1
, v2
);
1270 AFTER_POTENTIAL_GC ();
1275 BEFORE_POTENTIAL_GC ();
1277 TOP
= Fconcat (2, &TOP
);
1278 AFTER_POTENTIAL_GC ();
1282 BEFORE_POTENTIAL_GC ();
1284 TOP
= Fconcat (3, &TOP
);
1285 AFTER_POTENTIAL_GC ();
1289 BEFORE_POTENTIAL_GC ();
1291 TOP
= Fconcat (4, &TOP
);
1292 AFTER_POTENTIAL_GC ();
1297 BEFORE_POTENTIAL_GC ();
1299 TOP
= Fconcat (op
, &TOP
);
1300 AFTER_POTENTIAL_GC ();
1309 XSETINT (v1
, XINT (v1
) - 1);
1314 BEFORE_POTENTIAL_GC ();
1316 AFTER_POTENTIAL_GC ();
1327 XSETINT (v1
, XINT (v1
) + 1);
1332 BEFORE_POTENTIAL_GC ();
1334 AFTER_POTENTIAL_GC ();
1342 BEFORE_POTENTIAL_GC ();
1344 CHECK_NUMBER_OR_FLOAT_COERCE_MARKER (v1
);
1345 CHECK_NUMBER_OR_FLOAT_COERCE_MARKER (v2
);
1346 AFTER_POTENTIAL_GC ();
1347 if (FLOATP (v1
) || FLOATP (v2
))
1351 f1
= (FLOATP (v1
) ? XFLOAT_DATA (v1
) : XINT (v1
));
1352 f2
= (FLOATP (v2
) ? XFLOAT_DATA (v2
) : XINT (v2
));
1353 TOP
= (f1
== f2
? Qt
: Qnil
);
1356 TOP
= (XINT (v1
) == XINT (v2
) ? Qt
: Qnil
);
1363 BEFORE_POTENTIAL_GC ();
1365 TOP
= Fgtr (TOP
, v1
);
1366 AFTER_POTENTIAL_GC ();
1373 BEFORE_POTENTIAL_GC ();
1375 TOP
= Flss (TOP
, v1
);
1376 AFTER_POTENTIAL_GC ();
1383 BEFORE_POTENTIAL_GC ();
1385 TOP
= Fleq (TOP
, v1
);
1386 AFTER_POTENTIAL_GC ();
1393 BEFORE_POTENTIAL_GC ();
1395 TOP
= Fgeq (TOP
, v1
);
1396 AFTER_POTENTIAL_GC ();
1401 BEFORE_POTENTIAL_GC ();
1403 TOP
= Fminus (2, &TOP
);
1404 AFTER_POTENTIAL_GC ();
1413 XSETINT (v1
, - XINT (v1
));
1418 BEFORE_POTENTIAL_GC ();
1419 TOP
= Fminus (1, &TOP
);
1420 AFTER_POTENTIAL_GC ();
1426 BEFORE_POTENTIAL_GC ();
1428 TOP
= Fplus (2, &TOP
);
1429 AFTER_POTENTIAL_GC ();
1433 BEFORE_POTENTIAL_GC ();
1435 TOP
= Fmax (2, &TOP
);
1436 AFTER_POTENTIAL_GC ();
1440 BEFORE_POTENTIAL_GC ();
1442 TOP
= Fmin (2, &TOP
);
1443 AFTER_POTENTIAL_GC ();
1447 BEFORE_POTENTIAL_GC ();
1449 TOP
= Ftimes (2, &TOP
);
1450 AFTER_POTENTIAL_GC ();
1454 BEFORE_POTENTIAL_GC ();
1456 TOP
= Fquo (2, &TOP
);
1457 AFTER_POTENTIAL_GC ();
1463 BEFORE_POTENTIAL_GC ();
1465 TOP
= Frem (TOP
, v1
);
1466 AFTER_POTENTIAL_GC ();
1473 XSETFASTINT (v1
, PT
);
1479 BEFORE_POTENTIAL_GC ();
1480 TOP
= Fgoto_char (TOP
);
1481 AFTER_POTENTIAL_GC ();
1485 BEFORE_POTENTIAL_GC ();
1486 TOP
= Finsert (1, &TOP
);
1487 AFTER_POTENTIAL_GC ();
1492 BEFORE_POTENTIAL_GC ();
1494 TOP
= Finsert (op
, &TOP
);
1495 AFTER_POTENTIAL_GC ();
1501 XSETFASTINT (v1
, ZV
);
1509 XSETFASTINT (v1
, BEGV
);
1515 BEFORE_POTENTIAL_GC ();
1516 TOP
= Fchar_after (TOP
);
1517 AFTER_POTENTIAL_GC ();
1520 CASE (Bfollowing_char
):
1523 BEFORE_POTENTIAL_GC ();
1524 v1
= Ffollowing_char ();
1525 AFTER_POTENTIAL_GC ();
1530 CASE (Bpreceding_char
):
1533 BEFORE_POTENTIAL_GC ();
1534 v1
= Fprevious_char ();
1535 AFTER_POTENTIAL_GC ();
1540 CASE (Bcurrent_column
):
1543 BEFORE_POTENTIAL_GC ();
1544 XSETFASTINT (v1
, current_column ());
1545 AFTER_POTENTIAL_GC ();
1551 BEFORE_POTENTIAL_GC ();
1552 TOP
= Findent_to (TOP
, Qnil
);
1553 AFTER_POTENTIAL_GC ();
1572 CASE (Bcurrent_buffer
):
1573 PUSH (Fcurrent_buffer ());
1577 BEFORE_POTENTIAL_GC ();
1578 TOP
= Fset_buffer (TOP
);
1579 AFTER_POTENTIAL_GC ();
1582 CASE (Binteractive_p
): /* Obsolete since 24.1. */
1583 BEFORE_POTENTIAL_GC ();
1584 PUSH (call0 (intern ("interactive-p")));
1585 AFTER_POTENTIAL_GC ();
1588 CASE (Bforward_char
):
1589 BEFORE_POTENTIAL_GC ();
1590 TOP
= Fforward_char (TOP
);
1591 AFTER_POTENTIAL_GC ();
1594 CASE (Bforward_word
):
1595 BEFORE_POTENTIAL_GC ();
1596 TOP
= Fforward_word (TOP
);
1597 AFTER_POTENTIAL_GC ();
1600 CASE (Bskip_chars_forward
):
1603 BEFORE_POTENTIAL_GC ();
1605 TOP
= Fskip_chars_forward (TOP
, v1
);
1606 AFTER_POTENTIAL_GC ();
1610 CASE (Bskip_chars_backward
):
1613 BEFORE_POTENTIAL_GC ();
1615 TOP
= Fskip_chars_backward (TOP
, v1
);
1616 AFTER_POTENTIAL_GC ();
1620 CASE (Bforward_line
):
1621 BEFORE_POTENTIAL_GC ();
1622 TOP
= Fforward_line (TOP
);
1623 AFTER_POTENTIAL_GC ();
1626 CASE (Bchar_syntax
):
1630 BEFORE_POTENTIAL_GC ();
1631 CHECK_CHARACTER (TOP
);
1632 AFTER_POTENTIAL_GC ();
1634 if (NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
1635 MAKE_CHAR_MULTIBYTE (c
);
1636 XSETFASTINT (TOP
, syntax_code_spec
[(int) SYNTAX (c
)]);
1640 CASE (Bbuffer_substring
):
1643 BEFORE_POTENTIAL_GC ();
1645 TOP
= Fbuffer_substring (TOP
, v1
);
1646 AFTER_POTENTIAL_GC ();
1650 CASE (Bdelete_region
):
1653 BEFORE_POTENTIAL_GC ();
1655 TOP
= Fdelete_region (TOP
, v1
);
1656 AFTER_POTENTIAL_GC ();
1660 CASE (Bnarrow_to_region
):
1663 BEFORE_POTENTIAL_GC ();
1665 TOP
= Fnarrow_to_region (TOP
, v1
);
1666 AFTER_POTENTIAL_GC ();
1671 BEFORE_POTENTIAL_GC ();
1673 AFTER_POTENTIAL_GC ();
1676 CASE (Bend_of_line
):
1677 BEFORE_POTENTIAL_GC ();
1678 TOP
= Fend_of_line (TOP
);
1679 AFTER_POTENTIAL_GC ();
1685 BEFORE_POTENTIAL_GC ();
1688 TOP
= Fset_marker (TOP
, v2
, v1
);
1689 AFTER_POTENTIAL_GC ();
1693 CASE (Bmatch_beginning
):
1694 BEFORE_POTENTIAL_GC ();
1695 TOP
= Fmatch_beginning (TOP
);
1696 AFTER_POTENTIAL_GC ();
1700 BEFORE_POTENTIAL_GC ();
1701 TOP
= Fmatch_end (TOP
);
1702 AFTER_POTENTIAL_GC ();
1706 BEFORE_POTENTIAL_GC ();
1707 TOP
= Fupcase (TOP
);
1708 AFTER_POTENTIAL_GC ();
1712 BEFORE_POTENTIAL_GC ();
1713 TOP
= Fdowncase (TOP
);
1714 AFTER_POTENTIAL_GC ();
1717 CASE (Bstringeqlsign
):
1720 BEFORE_POTENTIAL_GC ();
1722 TOP
= Fstring_equal (TOP
, v1
);
1723 AFTER_POTENTIAL_GC ();
1730 BEFORE_POTENTIAL_GC ();
1732 TOP
= Fstring_lessp (TOP
, v1
);
1733 AFTER_POTENTIAL_GC ();
1741 TOP
= Fequal (TOP
, v1
);
1748 BEFORE_POTENTIAL_GC ();
1750 TOP
= Fnthcdr (TOP
, v1
);
1751 AFTER_POTENTIAL_GC ();
1760 /* Exchange args and then do nth. */
1762 BEFORE_POTENTIAL_GC ();
1766 AFTER_POTENTIAL_GC ();
1769 while (--n
>= 0 && CONSP (v1
))
1776 BEFORE_POTENTIAL_GC ();
1778 TOP
= Felt (TOP
, v1
);
1779 AFTER_POTENTIAL_GC ();
1787 BEFORE_POTENTIAL_GC ();
1789 TOP
= Fmember (TOP
, v1
);
1790 AFTER_POTENTIAL_GC ();
1797 BEFORE_POTENTIAL_GC ();
1799 TOP
= Fassq (TOP
, v1
);
1800 AFTER_POTENTIAL_GC ();
1805 BEFORE_POTENTIAL_GC ();
1806 TOP
= Fnreverse (TOP
);
1807 AFTER_POTENTIAL_GC ();
1813 BEFORE_POTENTIAL_GC ();
1815 TOP
= Fsetcar (TOP
, v1
);
1816 AFTER_POTENTIAL_GC ();
1823 BEFORE_POTENTIAL_GC ();
1825 TOP
= Fsetcdr (TOP
, v1
);
1826 AFTER_POTENTIAL_GC ();
1834 TOP
= CAR_SAFE (v1
);
1842 TOP
= CDR_SAFE (v1
);
1847 BEFORE_POTENTIAL_GC ();
1849 TOP
= Fnconc (2, &TOP
);
1850 AFTER_POTENTIAL_GC ();
1854 TOP
= (NUMBERP (TOP
) ? Qt
: Qnil
);
1858 TOP
= INTEGERP (TOP
) ? Qt
: Qnil
;
1861 #ifdef BYTE_CODE_SAFE
1862 /* These are intentionally written using 'case' syntax,
1863 because they are incompatible with the threaded
1867 BEFORE_POTENTIAL_GC ();
1868 error ("set-mark is an obsolete bytecode");
1869 AFTER_POTENTIAL_GC ();
1872 BEFORE_POTENTIAL_GC ();
1873 error ("scan-buffer is an obsolete bytecode");
1874 AFTER_POTENTIAL_GC ();
1879 /* Actually this is Bstack_ref with offset 0, but we use Bdup
1880 for that instead. */
1881 /* CASE (Bstack_ref): */
1882 error ("Invalid byte opcode");
1884 /* Handy byte-codes for lexical binding. */
1891 Lisp_Object
*ptr
= top
- (op
- Bstack_ref
);
1897 Lisp_Object
*ptr
= top
- (FETCH
);
1903 Lisp_Object
*ptr
= top
- (FETCH2
);
1908 /* stack-set-0 = discard; stack-set-1 = discard-1-preserve-tos. */
1910 Lisp_Object
*ptr
= top
- (FETCH
);
1916 Lisp_Object
*ptr
= top
- (FETCH2
);
1932 #ifdef BYTE_CODE_SAFE
1937 if ((op
-= Bconstant
) >= const_length
)
1943 PUSH (vectorp
[op
- Bconstant
]);
1951 byte_stack_list
= byte_stack_list
->next
;
1953 /* Binds and unbinds are supposed to be compiled balanced. */
1954 if (SPECPDL_INDEX () != count
)
1955 #ifdef BYTE_CODE_SAFE
1956 error ("binding stack not balanced (serious byte compiler bug)");
1965 syms_of_bytecode (void)
1967 defsubr (&Sbyte_code
);
1969 #ifdef BYTE_CODE_METER
1971 DEFVAR_LISP ("byte-code-meter", Vbyte_code_meter
,
1972 doc
: /* A vector of vectors which holds a histogram of byte-code usage.
1973 \(aref (aref byte-code-meter 0) CODE) indicates how many times the byte
1974 opcode CODE has been executed.
1975 \(aref (aref byte-code-meter CODE1) CODE2), where CODE1 is not 0,
1976 indicates how many times the byte opcodes CODE1 and CODE2 have been
1977 executed in succession. */);
1979 DEFVAR_BOOL ("byte-metering-on", byte_metering_on
,
1980 doc
: /* If non-nil, keep profiling information on byte code usage.
1981 The variable byte-code-meter indicates how often each byte opcode is used.
1982 If a symbol has a property named `byte-code-meter' whose value is an
1983 integer, it is incremented each time that symbol's function is called. */);
1985 byte_metering_on
= 0;
1986 Vbyte_code_meter
= Fmake_vector (make_number (256), make_number (0));
1987 DEFSYM (Qbyte_code_meter
, "byte-code-meter");
1991 ASET (Vbyte_code_meter
, i
,
1992 Fmake_vector (make_number (256), make_number (0)));