1 /* Execution of byte code produced by bytecomp.el.
2 Copyright (C) 1985-1988, 1993, 2000-2014 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 __STRICT_ANSI__ \
63 && !defined BYTE_CODE_SAFE && !defined BYTE_CODE_METER)
64 #define BYTE_CODE_THREADED
68 #ifdef BYTE_CODE_METER
70 Lisp_Object Qbyte_code_meter
;
71 #define METER_2(code1, code2) AREF (AREF (Vbyte_code_meter, code1), code2)
72 #define METER_1(code) METER_2 (0, code)
74 #define METER_CODE(last_code, this_code) \
76 if (byte_metering_on) \
78 if (XFASTINT (METER_1 (this_code)) < MOST_POSITIVE_FIXNUM) \
79 XSETFASTINT (METER_1 (this_code), \
80 XFASTINT (METER_1 (this_code)) + 1); \
82 && (XFASTINT (METER_2 (last_code, this_code)) \
83 < MOST_POSITIVE_FIXNUM)) \
84 XSETFASTINT (METER_2 (last_code, this_code), \
85 XFASTINT (METER_2 (last_code, this_code)) + 1); \
89 #endif /* BYTE_CODE_METER */
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) \
144 DEFINE (Bpophandler, 060) \
145 DEFINE (Bpushconditioncase, 061) \
146 DEFINE (Bpushcatch, 062) \
149 DEFINE (Bsymbolp, 071) \
150 DEFINE (Bconsp, 072) \
151 DEFINE (Bstringp, 073) \
152 DEFINE (Blistp, 074) \
154 DEFINE (Bmemq, 076) \
156 DEFINE (Bcar, 0100) \
157 DEFINE (Bcdr, 0101) \
158 DEFINE (Bcons, 0102) \
159 DEFINE (Blist1, 0103) \
160 DEFINE (Blist2, 0104) \
161 DEFINE (Blist3, 0105) \
162 DEFINE (Blist4, 0106) \
163 DEFINE (Blength, 0107) \
164 DEFINE (Baref, 0110) \
165 DEFINE (Baset, 0111) \
166 DEFINE (Bsymbol_value, 0112) \
167 DEFINE (Bsymbol_function, 0113) \
168 DEFINE (Bset, 0114) \
169 DEFINE (Bfset, 0115) \
170 DEFINE (Bget, 0116) \
171 DEFINE (Bsubstring, 0117) \
172 DEFINE (Bconcat2, 0120) \
173 DEFINE (Bconcat3, 0121) \
174 DEFINE (Bconcat4, 0122) \
175 DEFINE (Bsub1, 0123) \
176 DEFINE (Badd1, 0124) \
177 DEFINE (Beqlsign, 0125) \
178 DEFINE (Bgtr, 0126) \
179 DEFINE (Blss, 0127) \
180 DEFINE (Bleq, 0130) \
181 DEFINE (Bgeq, 0131) \
182 DEFINE (Bdiff, 0132) \
183 DEFINE (Bnegate, 0133) \
184 DEFINE (Bplus, 0134) \
185 DEFINE (Bmax, 0135) \
186 DEFINE (Bmin, 0136) \
187 DEFINE (Bmult, 0137) \
189 DEFINE (Bpoint, 0140) \
190 /* Was Bmark in v17. */ \
191 DEFINE (Bsave_current_buffer, 0141) /* Obsolete. */ \
192 DEFINE (Bgoto_char, 0142) \
193 DEFINE (Binsert, 0143) \
194 DEFINE (Bpoint_max, 0144) \
195 DEFINE (Bpoint_min, 0145) \
196 DEFINE (Bchar_after, 0146) \
197 DEFINE (Bfollowing_char, 0147) \
198 DEFINE (Bpreceding_char, 0150) \
199 DEFINE (Bcurrent_column, 0151) \
200 DEFINE (Bindent_to, 0152) \
201 DEFINE (Beolp, 0154) \
202 DEFINE (Beobp, 0155) \
203 DEFINE (Bbolp, 0156) \
204 DEFINE (Bbobp, 0157) \
205 DEFINE (Bcurrent_buffer, 0160) \
206 DEFINE (Bset_buffer, 0161) \
207 DEFINE (Bsave_current_buffer_1, 0162) /* Replacing Bsave_current_buffer. */ \
208 DEFINE (Binteractive_p, 0164) /* Obsolete since Emacs-24.1. */ \
210 DEFINE (Bforward_char, 0165) \
211 DEFINE (Bforward_word, 0166) \
212 DEFINE (Bskip_chars_forward, 0167) \
213 DEFINE (Bskip_chars_backward, 0170) \
214 DEFINE (Bforward_line, 0171) \
215 DEFINE (Bchar_syntax, 0172) \
216 DEFINE (Bbuffer_substring, 0173) \
217 DEFINE (Bdelete_region, 0174) \
218 DEFINE (Bnarrow_to_region, 0175) \
219 DEFINE (Bwiden, 0176) \
220 DEFINE (Bend_of_line, 0177) \
222 DEFINE (Bconstant2, 0201) \
223 DEFINE (Bgoto, 0202) \
224 DEFINE (Bgotoifnil, 0203) \
225 DEFINE (Bgotoifnonnil, 0204) \
226 DEFINE (Bgotoifnilelsepop, 0205) \
227 DEFINE (Bgotoifnonnilelsepop, 0206) \
228 DEFINE (Breturn, 0207) \
229 DEFINE (Bdiscard, 0210) \
230 DEFINE (Bdup, 0211) \
232 DEFINE (Bsave_excursion, 0212) \
233 DEFINE (Bsave_window_excursion, 0213) /* Obsolete since Emacs-24.1. */ \
234 DEFINE (Bsave_restriction, 0214) \
235 DEFINE (Bcatch, 0215) \
237 DEFINE (Bunwind_protect, 0216) \
238 DEFINE (Bcondition_case, 0217) \
239 DEFINE (Btemp_output_buffer_setup, 0220) /* Obsolete since Emacs-24.1. */ \
240 DEFINE (Btemp_output_buffer_show, 0221) /* Obsolete since Emacs-24.1. */ \
242 DEFINE (Bunbind_all, 0222) /* Obsolete. Never used. */ \
244 DEFINE (Bset_marker, 0223) \
245 DEFINE (Bmatch_beginning, 0224) \
246 DEFINE (Bmatch_end, 0225) \
247 DEFINE (Bupcase, 0226) \
248 DEFINE (Bdowncase, 0227) \
250 DEFINE (Bstringeqlsign, 0230) \
251 DEFINE (Bstringlss, 0231) \
252 DEFINE (Bequal, 0232) \
253 DEFINE (Bnthcdr, 0233) \
254 DEFINE (Belt, 0234) \
255 DEFINE (Bmember, 0235) \
256 DEFINE (Bassq, 0236) \
257 DEFINE (Bnreverse, 0237) \
258 DEFINE (Bsetcar, 0240) \
259 DEFINE (Bsetcdr, 0241) \
260 DEFINE (Bcar_safe, 0242) \
261 DEFINE (Bcdr_safe, 0243) \
262 DEFINE (Bnconc, 0244) \
263 DEFINE (Bquo, 0245) \
264 DEFINE (Brem, 0246) \
265 DEFINE (Bnumberp, 0247) \
266 DEFINE (Bintegerp, 0250) \
268 DEFINE (BRgoto, 0252) \
269 DEFINE (BRgotoifnil, 0253) \
270 DEFINE (BRgotoifnonnil, 0254) \
271 DEFINE (BRgotoifnilelsepop, 0255) \
272 DEFINE (BRgotoifnonnilelsepop, 0256) \
274 DEFINE (BlistN, 0257) \
275 DEFINE (BconcatN, 0260) \
276 DEFINE (BinsertN, 0261) \
278 /* Bstack_ref is code 0. */ \
279 DEFINE (Bstack_set, 0262) \
280 DEFINE (Bstack_set2, 0263) \
281 DEFINE (BdiscardN, 0266) \
283 DEFINE (Bconstant, 0300)
287 #define DEFINE(name, value) name = value,
291 #ifdef BYTE_CODE_SAFE
292 Bscan_buffer
= 0153, /* No longer generated as of v18. */
293 Bset_mark
= 0163, /* this loser is no longer generated as of v18 */
297 /* Whether to maintain a `top' and `bottom' field in the stack frame. */
298 #define BYTE_MAINTAIN_TOP (BYTE_CODE_SAFE || BYTE_MARK_STACK)
300 /* Structure describing a value stack used during byte-code execution
305 /* Program counter. This points into the byte_string below
306 and is relocated when that string is relocated. */
307 const unsigned char *pc
;
309 /* Top and bottom of stack. The bottom points to an area of memory
310 allocated with alloca in Fbyte_code. */
311 #if BYTE_MAINTAIN_TOP
312 Lisp_Object
*top
, *bottom
;
315 /* The string containing the byte-code, and its current address.
316 Storing this here protects it from GC because mark_byte_stack
318 Lisp_Object byte_string
;
319 const unsigned char *byte_string_start
;
322 /* The vector of constants used during byte-code execution. Storing
323 this here protects it from GC because mark_byte_stack marks it. */
324 Lisp_Object constants
;
327 /* Next entry in byte_stack_list. */
328 struct byte_stack
*next
;
331 /* A list of currently active byte-code execution value stacks.
332 Fbyte_code adds an entry to the head of this list before it starts
333 processing byte-code, and it removes the entry again when it is
334 done. Signaling an error truncates the list analogous to
337 struct byte_stack
*byte_stack_list
;
340 /* Mark objects on byte_stack_list. Called during GC. */
344 mark_byte_stack (void)
346 struct byte_stack
*stack
;
349 for (stack
= byte_stack_list
; stack
; stack
= stack
->next
)
351 /* If STACK->top is null here, this means there's an opcode in
352 Fbyte_code that wasn't expected to GC, but did. To find out
353 which opcode this is, record the value of `stack', and walk
354 up the stack in a debugger, stopping in frames of Fbyte_code.
355 The culprit is found in the frame of Fbyte_code where the
356 address of its local variable `stack' is equal to the
357 recorded value of `stack' here. */
358 eassert (stack
->top
);
360 for (obj
= stack
->bottom
; obj
<= stack
->top
; ++obj
)
363 mark_object (stack
->byte_string
);
364 mark_object (stack
->constants
);
369 /* Unmark objects in the stacks on byte_stack_list. Relocate program
370 counters. Called when GC has completed. */
373 unmark_byte_stack (void)
375 struct byte_stack
*stack
;
377 for (stack
= byte_stack_list
; stack
; stack
= stack
->next
)
379 if (stack
->byte_string_start
!= SDATA (stack
->byte_string
))
381 ptrdiff_t offset
= stack
->pc
- stack
->byte_string_start
;
382 stack
->byte_string_start
= SDATA (stack
->byte_string
);
383 stack
->pc
= stack
->byte_string_start
+ offset
;
389 /* Fetch the next byte from the bytecode stream. */
391 #ifdef BYTE_CODE_SAFE
392 #define FETCH (eassert (stack.byte_string_start == SDATA (stack.byte_string)), *stack.pc++)
394 #define FETCH *stack.pc++
397 /* Fetch two bytes from the bytecode stream and make a 16-bit number
400 #define FETCH2 (op = FETCH, op + (FETCH << 8))
402 /* Push x onto the execution stack. This used to be #define PUSH(x)
403 (*++stackp = (x)) This oddity is necessary because Alliant can't be
404 bothered to compile the preincrement operator properly, as of 4/91.
407 #define PUSH(x) (top++, *top = (x))
409 /* Pop a value off the execution stack. */
413 /* Discard n values from the execution stack. */
415 #define DISCARD(n) (top -= (n))
417 /* Get the value which is at the top of the execution stack, but don't
422 /* Actions that must be performed before and after calling a function
425 #if !BYTE_MAINTAIN_TOP
426 #define BEFORE_POTENTIAL_GC() ((void)0)
427 #define AFTER_POTENTIAL_GC() ((void)0)
429 #define BEFORE_POTENTIAL_GC() stack.top = top
430 #define AFTER_POTENTIAL_GC() stack.top = NULL
433 /* Garbage collect if we have consed enough since the last time.
434 We do this at every branch, to avoid loops that never GC. */
438 BEFORE_POTENTIAL_GC (); \
440 AFTER_POTENTIAL_GC (); \
443 /* Check for jumping out of range. */
445 #ifdef BYTE_CODE_SAFE
447 #define CHECK_RANGE(ARG) \
448 if (ARG >= bytestr_length) emacs_abort ()
450 #else /* not BYTE_CODE_SAFE */
452 #define CHECK_RANGE(ARG)
454 #endif /* not BYTE_CODE_SAFE */
456 /* A version of the QUIT macro which makes sure that the stack top is
457 set before signaling `quit'. */
459 #define BYTE_CODE_QUIT \
461 if (!NILP (Vquit_flag) && NILP (Vinhibit_quit)) \
463 Lisp_Object flag = Vquit_flag; \
465 BEFORE_POTENTIAL_GC (); \
466 if (EQ (Vthrow_on_input, flag)) \
467 Fthrow (Vthrow_on_input, Qt); \
468 Fsignal (Qquit, Qnil); \
469 AFTER_POTENTIAL_GC (); \
471 else if (pending_signals) \
472 process_pending_signals (); \
476 DEFUN ("byte-code", Fbyte_code
, Sbyte_code
, 3, 3, 0,
477 doc
: /* Function used internally in byte-compiled code.
478 The first argument, BYTESTR, is a string of byte code;
479 the second, VECTOR, a vector of constants;
480 the third, MAXDEPTH, the maximum stack depth used in this function.
481 If the third argument is incorrect, Emacs may crash. */)
482 (Lisp_Object bytestr
, Lisp_Object vector
, Lisp_Object maxdepth
)
484 return exec_byte_code (bytestr
, vector
, maxdepth
, Qnil
, 0, NULL
);
488 bcall0 (Lisp_Object f
)
493 /* Execute the byte-code in BYTESTR. VECTOR is the constant vector, and
494 MAXDEPTH is the maximum stack depth used (if MAXDEPTH is incorrect,
495 emacs may crash!). If ARGS_TEMPLATE is non-nil, it should be a lisp
496 argument list (including &rest, &optional, etc.), and ARGS, of size
497 NARGS, should be a vector of the actual arguments. The arguments in
498 ARGS are pushed on the stack according to ARGS_TEMPLATE before
499 executing BYTESTR. */
502 exec_byte_code (Lisp_Object bytestr
, Lisp_Object vector
, Lisp_Object maxdepth
,
503 Lisp_Object args_template
, ptrdiff_t nargs
, Lisp_Object
*args
)
505 ptrdiff_t count
= SPECPDL_INDEX ();
506 #ifdef BYTE_CODE_METER
507 int volatile this_op
= 0;
511 /* Lisp_Object v1, v2; */
512 Lisp_Object
*vectorp
;
513 #ifdef BYTE_CODE_SAFE
514 ptrdiff_t const_length
;
516 ptrdiff_t bytestr_length
;
518 struct byte_stack stack
;
521 enum handlertype type
;
523 #if 0 /* CHECK_FRAME_FONT */
525 struct frame
*f
= SELECTED_FRAME ();
527 && FRAME_FONT (f
)->direction
!= 0
528 && FRAME_FONT (f
)->direction
!= 1)
533 CHECK_STRING (bytestr
);
534 CHECK_VECTOR (vector
);
535 CHECK_NATNUM (maxdepth
);
537 #ifdef BYTE_CODE_SAFE
538 const_length
= ASIZE (vector
);
541 if (STRING_MULTIBYTE (bytestr
))
542 /* BYTESTR must have been produced by Emacs 20.2 or the earlier
543 because they produced a raw 8-bit string for byte-code and now
544 such a byte-code string is loaded as multibyte while raw 8-bit
545 characters converted to multibyte form. Thus, now we must
546 convert them back to the originally intended unibyte form. */
547 bytestr
= Fstring_as_unibyte (bytestr
);
549 #ifdef BYTE_CODE_SAFE
550 bytestr_length
= SBYTES (bytestr
);
552 vectorp
= XVECTOR (vector
)->contents
;
554 stack
.byte_string
= bytestr
;
555 stack
.pc
= stack
.byte_string_start
= SDATA (bytestr
);
557 stack
.constants
= vector
;
559 if (MAX_ALLOCA
/ word_size
<= XFASTINT (maxdepth
))
560 memory_full (SIZE_MAX
);
561 top
= alloca ((XFASTINT (maxdepth
) + 1) * sizeof *top
);
562 #if BYTE_MAINTAIN_TOP
563 stack
.bottom
= top
+ 1;
566 stack
.next
= byte_stack_list
;
567 byte_stack_list
= &stack
;
569 #ifdef BYTE_CODE_SAFE
570 stacke
= stack
.bottom
- 1 + XFASTINT (maxdepth
);
573 if (INTEGERP (args_template
))
575 ptrdiff_t at
= XINT (args_template
);
576 bool rest
= (at
& 128) != 0;
577 int mandatory
= at
& 127;
578 ptrdiff_t nonrest
= at
>> 8;
579 eassert (mandatory
<= nonrest
);
580 if (nargs
<= nonrest
)
583 for (i
= 0 ; i
< nargs
; i
++, args
++)
585 if (nargs
< mandatory
)
586 /* Too few arguments. */
587 Fsignal (Qwrong_number_of_arguments
,
588 list2 (Fcons (make_number (mandatory
),
589 rest
? Qand_rest
: make_number (nonrest
)),
590 make_number (nargs
)));
593 for (; i
< nonrest
; i
++)
602 for (i
= 0 ; i
< nonrest
; i
++, args
++)
604 PUSH (Flist (nargs
- nonrest
, args
));
607 /* Too many arguments. */
608 Fsignal (Qwrong_number_of_arguments
,
609 list2 (Fcons (make_number (mandatory
), make_number (nonrest
)),
610 make_number (nargs
)));
612 else if (! NILP (args_template
))
613 /* We should push some arguments on the stack. */
615 error ("Unknown args template!");
620 #ifdef BYTE_CODE_SAFE
623 else if (top
< stack
.bottom
- 1)
627 #ifdef BYTE_CODE_METER
629 this_op
= op
= FETCH
;
630 METER_CODE (prev_op
, op
);
632 #ifndef BYTE_CODE_THREADED
637 /* The interpreter can be compiled one of two ways: as an
638 ordinary switch-based interpreter, or as a threaded
639 interpreter. The threaded interpreter relies on GCC's
640 computed goto extension, so it is not available everywhere.
641 Threading provides a performance boost. These macros are how
642 we allow the code to be compiled both ways. */
643 #ifdef BYTE_CODE_THREADED
644 /* The CASE macro introduces an instruction's body. It is
645 either a label or a case label. */
646 #define CASE(OP) insn_ ## OP
647 /* NEXT is invoked at the end of an instruction to go to the
648 next instruction. It is either a computed goto, or a
650 #define NEXT goto *(targets[op = FETCH])
651 /* FIRST is like NEXT, but is only used at the start of the
652 interpreter body. In the switch-based interpreter it is the
653 switch, so the threaded definition must include a semicolon. */
655 /* Most cases are labeled with the CASE macro, above.
656 CASE_DEFAULT is one exception; it is used if the interpreter
657 being built requires a default case. The threaded
658 interpreter does not, because the dispatch table is
659 completely filled. */
661 /* This introduces an instruction that is known to call abort. */
662 #define CASE_ABORT CASE (Bstack_ref): CASE (default)
664 /* See above for the meaning of the various defines. */
665 #define CASE(OP) case OP
667 #define FIRST switch (op)
668 #define CASE_DEFAULT case 255: default:
669 #define CASE_ABORT case 0
672 #ifdef BYTE_CODE_THREADED
674 /* A convenience define that saves us a lot of typing and makes
675 the table clearer. */
676 #define LABEL(OP) [OP] = &&insn_ ## OP
678 #if 4 < __GNUC__ + (6 <= __GNUC_MINOR__)
679 # pragma GCC diagnostic push
680 # pragma GCC diagnostic ignored "-Woverride-init"
681 #elif defined __clang__
682 # pragma GCC diagnostic push
683 # pragma GCC diagnostic ignored "-Winitializer-overrides"
686 /* This is the dispatch table for the threaded interpreter. */
687 static const void *const targets
[256] =
689 [0 ... (Bconstant
- 1)] = &&insn_default
,
690 [Bconstant
... 255] = &&insn_Bconstant
,
692 #define DEFINE(name, value) LABEL (name) ,
697 #if 4 < __GNUC__ + (6 <= __GNUC_MINOR__) || defined __clang__
698 # pragma GCC diagnostic pop
719 /* This seems to be the most frequently executed byte-code
720 among the Bvarref's, so avoid a goto here. */
730 if (XSYMBOL (v1
)->redirect
!= SYMBOL_PLAINVAL
731 || (v2
= SYMBOL_VAL (XSYMBOL (v1
)),
734 BEFORE_POTENTIAL_GC ();
735 v2
= Fsymbol_value (v1
);
736 AFTER_POTENTIAL_GC ();
741 BEFORE_POTENTIAL_GC ();
742 v2
= Fsymbol_value (v1
);
743 AFTER_POTENTIAL_GC ();
759 stack
.pc
= stack
.byte_string_start
+ op
;
774 BEFORE_POTENTIAL_GC ();
775 wrong_type_argument (Qlistp
, v1
);
784 TOP
= EQ (v1
, TOP
) ? Qt
: Qnil
;
791 BEFORE_POTENTIAL_GC ();
793 TOP
= Fmemq (TOP
, v1
);
794 AFTER_POTENTIAL_GC ();
808 BEFORE_POTENTIAL_GC ();
809 wrong_type_argument (Qlistp
, v1
);
831 Lisp_Object sym
, val
;
836 /* Inline the most common case. */
838 && !EQ (val
, Qunbound
)
839 && !XSYMBOL (sym
)->redirect
840 && !SYMBOL_CONSTANT_P (sym
))
841 SET_SYMBOL_VAL (XSYMBOL (sym
), val
);
844 BEFORE_POTENTIAL_GC ();
845 set_internal (sym
, val
, Qnil
, 0);
846 AFTER_POTENTIAL_GC ();
860 /* ------------------ */
878 /* Specbind can signal and thus GC. */
879 BEFORE_POTENTIAL_GC ();
880 specbind (vectorp
[op
], POP
);
881 AFTER_POTENTIAL_GC ();
901 BEFORE_POTENTIAL_GC ();
903 #ifdef BYTE_CODE_METER
904 if (byte_metering_on
&& SYMBOLP (TOP
))
909 v2
= Fget (v1
, Qbyte_code_meter
);
911 && XINT (v2
) < MOST_POSITIVE_FIXNUM
)
913 XSETINT (v2
, XINT (v2
) + 1);
914 Fput (v1
, Qbyte_code_meter
, v2
);
918 TOP
= Ffuncall (op
+ 1, &TOP
);
919 AFTER_POTENTIAL_GC ();
939 BEFORE_POTENTIAL_GC ();
940 unbind_to (SPECPDL_INDEX () - op
, Qnil
);
941 AFTER_POTENTIAL_GC ();
944 CASE (Bunbind_all
): /* Obsolete. Never used. */
945 /* To unbind back to the beginning of this frame. Not used yet,
946 but will be needed for tail-recursion elimination. */
947 BEFORE_POTENTIAL_GC ();
948 unbind_to (count
, Qnil
);
949 AFTER_POTENTIAL_GC ();
955 op
= FETCH2
; /* pc = FETCH2 loses since FETCH2 contains pc++ */
957 stack
.pc
= stack
.byte_string_start
+ op
;
960 CASE (Bgotoifnonnil
):
970 stack
.pc
= stack
.byte_string_start
+ op
;
975 CASE (Bgotoifnilelsepop
):
982 stack
.pc
= stack
.byte_string_start
+ op
;
987 CASE (Bgotoifnonnilelsepop
):
994 stack
.pc
= stack
.byte_string_start
+ op
;
1002 stack
.pc
+= (int) *stack
.pc
- 127;
1013 stack
.pc
+= (int) *stack
.pc
- 128;
1019 CASE (BRgotoifnonnil
):
1027 stack
.pc
+= (int) *stack
.pc
- 128;
1033 CASE (BRgotoifnilelsepop
):
1039 stack
.pc
+= op
- 128;
1044 CASE (BRgotoifnonnilelsepop
):
1050 stack
.pc
+= op
- 128;
1064 PUSH (vectorp
[FETCH2
]);
1067 CASE (Bsave_excursion
):
1068 record_unwind_protect (save_excursion_restore
,
1069 save_excursion_save ());
1072 CASE (Bsave_current_buffer
): /* Obsolete since ??. */
1073 CASE (Bsave_current_buffer_1
):
1074 record_unwind_current_buffer ();
1077 CASE (Bsave_window_excursion
): /* Obsolete since 24.1. */
1079 ptrdiff_t count1
= SPECPDL_INDEX ();
1080 record_unwind_protect (restore_window_configuration
,
1081 Fcurrent_window_configuration (Qnil
));
1082 BEFORE_POTENTIAL_GC ();
1084 unbind_to (count1
, TOP
);
1085 AFTER_POTENTIAL_GC ();
1089 CASE (Bsave_restriction
):
1090 record_unwind_protect (save_restriction_restore
,
1091 save_restriction_save ());
1094 CASE (Bcatch
): /* Obsolete since 24.4. */
1097 BEFORE_POTENTIAL_GC ();
1099 TOP
= internal_catch (TOP
, eval_sub
, v1
);
1100 AFTER_POTENTIAL_GC ();
1104 CASE (Bpushcatch
): /* New in 24.4. */
1107 CASE (Bpushconditioncase
): /* New in 24.4. */
1109 extern EMACS_INT lisp_eval_depth
;
1110 extern int poll_suppress_count
;
1111 extern int interrupt_input_blocked
;
1116 type
= CONDITION_CASE
;
1121 PUSH_HANDLER (c
, tag
, type
);
1122 c
->bytecode_dest
= dest
;
1123 c
->bytecode_top
= top
;
1125 if (sys_setjmp (c
->jmp
))
1127 struct handler
*c
= handlerlist
;
1129 top
= c
->bytecode_top
;
1130 dest
= c
->bytecode_dest
;
1131 handlerlist
= c
->next
;
1134 /* Might have been re-set by longjmp! */
1135 stack
.byte_string_start
= SDATA (stack
.byte_string
);
1136 stack
.pc
= stack
.byte_string_start
+ dest
;
1142 CASE (Bpophandler
): /* New in 24.4. */
1144 handlerlist
= handlerlist
->next
;
1148 CASE (Bunwind_protect
): /* FIXME: avoid closure for lexbind. */
1150 Lisp_Object handler
= POP
;
1151 /* Support for a function here is new in 24.4. */
1152 record_unwind_protect (NILP (Ffunctionp (handler
))
1153 ? unwind_body
: bcall0
,
1158 CASE (Bcondition_case
): /* Obsolete since 24.4. */
1160 Lisp_Object handlers
, body
;
1163 BEFORE_POTENTIAL_GC ();
1164 TOP
= internal_lisp_condition_case (TOP
, body
, handlers
);
1165 AFTER_POTENTIAL_GC ();
1169 CASE (Btemp_output_buffer_setup
): /* Obsolete since 24.1. */
1170 BEFORE_POTENTIAL_GC ();
1172 temp_output_buffer_setup (SSDATA (TOP
));
1173 AFTER_POTENTIAL_GC ();
1174 TOP
= Vstandard_output
;
1177 CASE (Btemp_output_buffer_show
): /* Obsolete since 24.1. */
1180 BEFORE_POTENTIAL_GC ();
1182 temp_output_buffer_show (TOP
);
1184 /* pop binding of standard-output */
1185 unbind_to (SPECPDL_INDEX () - 1, Qnil
);
1186 AFTER_POTENTIAL_GC ();
1194 BEFORE_POTENTIAL_GC ();
1200 while (--n
>= 0 && CONSP (v1
))
1204 AFTER_POTENTIAL_GC ();
1209 TOP
= SYMBOLP (TOP
) ? Qt
: Qnil
;
1213 TOP
= CONSP (TOP
) ? Qt
: Qnil
;
1217 TOP
= STRINGP (TOP
) ? Qt
: Qnil
;
1221 TOP
= CONSP (TOP
) || NILP (TOP
) ? Qt
: Qnil
;
1225 TOP
= NILP (TOP
) ? Qt
: Qnil
;
1232 TOP
= Fcons (TOP
, v1
);
1244 TOP
= list2 (TOP
, v1
);
1250 TOP
= Flist (3, &TOP
);
1255 TOP
= Flist (4, &TOP
);
1261 TOP
= Flist (op
, &TOP
);
1265 BEFORE_POTENTIAL_GC ();
1266 TOP
= Flength (TOP
);
1267 AFTER_POTENTIAL_GC ();
1273 BEFORE_POTENTIAL_GC ();
1275 TOP
= Faref (TOP
, v1
);
1276 AFTER_POTENTIAL_GC ();
1283 BEFORE_POTENTIAL_GC ();
1285 TOP
= Faset (TOP
, v1
, v2
);
1286 AFTER_POTENTIAL_GC ();
1290 CASE (Bsymbol_value
):
1291 BEFORE_POTENTIAL_GC ();
1292 TOP
= Fsymbol_value (TOP
);
1293 AFTER_POTENTIAL_GC ();
1296 CASE (Bsymbol_function
):
1297 BEFORE_POTENTIAL_GC ();
1298 TOP
= Fsymbol_function (TOP
);
1299 AFTER_POTENTIAL_GC ();
1305 BEFORE_POTENTIAL_GC ();
1307 TOP
= Fset (TOP
, v1
);
1308 AFTER_POTENTIAL_GC ();
1315 BEFORE_POTENTIAL_GC ();
1317 TOP
= Ffset (TOP
, v1
);
1318 AFTER_POTENTIAL_GC ();
1325 BEFORE_POTENTIAL_GC ();
1327 TOP
= Fget (TOP
, v1
);
1328 AFTER_POTENTIAL_GC ();
1335 BEFORE_POTENTIAL_GC ();
1337 TOP
= Fsubstring (TOP
, v1
, v2
);
1338 AFTER_POTENTIAL_GC ();
1343 BEFORE_POTENTIAL_GC ();
1345 TOP
= Fconcat (2, &TOP
);
1346 AFTER_POTENTIAL_GC ();
1350 BEFORE_POTENTIAL_GC ();
1352 TOP
= Fconcat (3, &TOP
);
1353 AFTER_POTENTIAL_GC ();
1357 BEFORE_POTENTIAL_GC ();
1359 TOP
= Fconcat (4, &TOP
);
1360 AFTER_POTENTIAL_GC ();
1365 BEFORE_POTENTIAL_GC ();
1367 TOP
= Fconcat (op
, &TOP
);
1368 AFTER_POTENTIAL_GC ();
1377 XSETINT (v1
, XINT (v1
) - 1);
1382 BEFORE_POTENTIAL_GC ();
1384 AFTER_POTENTIAL_GC ();
1395 XSETINT (v1
, XINT (v1
) + 1);
1400 BEFORE_POTENTIAL_GC ();
1402 AFTER_POTENTIAL_GC ();
1410 BEFORE_POTENTIAL_GC ();
1412 CHECK_NUMBER_OR_FLOAT_COERCE_MARKER (v1
);
1413 CHECK_NUMBER_OR_FLOAT_COERCE_MARKER (v2
);
1414 AFTER_POTENTIAL_GC ();
1415 if (FLOATP (v1
) || FLOATP (v2
))
1419 f1
= (FLOATP (v1
) ? XFLOAT_DATA (v1
) : XINT (v1
));
1420 f2
= (FLOATP (v2
) ? XFLOAT_DATA (v2
) : XINT (v2
));
1421 TOP
= (f1
== f2
? Qt
: Qnil
);
1424 TOP
= (XINT (v1
) == XINT (v2
) ? Qt
: Qnil
);
1431 BEFORE_POTENTIAL_GC ();
1433 TOP
= arithcompare (TOP
, v1
, ARITH_GRTR
);
1434 AFTER_POTENTIAL_GC ();
1441 BEFORE_POTENTIAL_GC ();
1443 TOP
= arithcompare (TOP
, v1
, ARITH_LESS
);
1444 AFTER_POTENTIAL_GC ();
1451 BEFORE_POTENTIAL_GC ();
1453 TOP
= arithcompare (TOP
, v1
, ARITH_LESS_OR_EQUAL
);
1454 AFTER_POTENTIAL_GC ();
1461 BEFORE_POTENTIAL_GC ();
1463 TOP
= arithcompare (TOP
, v1
, ARITH_GRTR_OR_EQUAL
);
1464 AFTER_POTENTIAL_GC ();
1469 BEFORE_POTENTIAL_GC ();
1471 TOP
= Fminus (2, &TOP
);
1472 AFTER_POTENTIAL_GC ();
1481 XSETINT (v1
, - XINT (v1
));
1486 BEFORE_POTENTIAL_GC ();
1487 TOP
= Fminus (1, &TOP
);
1488 AFTER_POTENTIAL_GC ();
1494 BEFORE_POTENTIAL_GC ();
1496 TOP
= Fplus (2, &TOP
);
1497 AFTER_POTENTIAL_GC ();
1501 BEFORE_POTENTIAL_GC ();
1503 TOP
= Fmax (2, &TOP
);
1504 AFTER_POTENTIAL_GC ();
1508 BEFORE_POTENTIAL_GC ();
1510 TOP
= Fmin (2, &TOP
);
1511 AFTER_POTENTIAL_GC ();
1515 BEFORE_POTENTIAL_GC ();
1517 TOP
= Ftimes (2, &TOP
);
1518 AFTER_POTENTIAL_GC ();
1522 BEFORE_POTENTIAL_GC ();
1524 TOP
= Fquo (2, &TOP
);
1525 AFTER_POTENTIAL_GC ();
1531 BEFORE_POTENTIAL_GC ();
1533 TOP
= Frem (TOP
, v1
);
1534 AFTER_POTENTIAL_GC ();
1541 XSETFASTINT (v1
, PT
);
1547 BEFORE_POTENTIAL_GC ();
1548 TOP
= Fgoto_char (TOP
);
1549 AFTER_POTENTIAL_GC ();
1553 BEFORE_POTENTIAL_GC ();
1554 TOP
= Finsert (1, &TOP
);
1555 AFTER_POTENTIAL_GC ();
1560 BEFORE_POTENTIAL_GC ();
1562 TOP
= Finsert (op
, &TOP
);
1563 AFTER_POTENTIAL_GC ();
1569 XSETFASTINT (v1
, ZV
);
1577 XSETFASTINT (v1
, BEGV
);
1583 BEFORE_POTENTIAL_GC ();
1584 TOP
= Fchar_after (TOP
);
1585 AFTER_POTENTIAL_GC ();
1588 CASE (Bfollowing_char
):
1591 BEFORE_POTENTIAL_GC ();
1592 v1
= Ffollowing_char ();
1593 AFTER_POTENTIAL_GC ();
1598 CASE (Bpreceding_char
):
1601 BEFORE_POTENTIAL_GC ();
1602 v1
= Fprevious_char ();
1603 AFTER_POTENTIAL_GC ();
1608 CASE (Bcurrent_column
):
1611 BEFORE_POTENTIAL_GC ();
1612 XSETFASTINT (v1
, current_column ());
1613 AFTER_POTENTIAL_GC ();
1619 BEFORE_POTENTIAL_GC ();
1620 TOP
= Findent_to (TOP
, Qnil
);
1621 AFTER_POTENTIAL_GC ();
1640 CASE (Bcurrent_buffer
):
1641 PUSH (Fcurrent_buffer ());
1645 BEFORE_POTENTIAL_GC ();
1646 TOP
= Fset_buffer (TOP
);
1647 AFTER_POTENTIAL_GC ();
1650 CASE (Binteractive_p
): /* Obsolete since 24.1. */
1651 BEFORE_POTENTIAL_GC ();
1652 PUSH (call0 (intern ("interactive-p")));
1653 AFTER_POTENTIAL_GC ();
1656 CASE (Bforward_char
):
1657 BEFORE_POTENTIAL_GC ();
1658 TOP
= Fforward_char (TOP
);
1659 AFTER_POTENTIAL_GC ();
1662 CASE (Bforward_word
):
1663 BEFORE_POTENTIAL_GC ();
1664 TOP
= Fforward_word (TOP
);
1665 AFTER_POTENTIAL_GC ();
1668 CASE (Bskip_chars_forward
):
1671 BEFORE_POTENTIAL_GC ();
1673 TOP
= Fskip_chars_forward (TOP
, v1
);
1674 AFTER_POTENTIAL_GC ();
1678 CASE (Bskip_chars_backward
):
1681 BEFORE_POTENTIAL_GC ();
1683 TOP
= Fskip_chars_backward (TOP
, v1
);
1684 AFTER_POTENTIAL_GC ();
1688 CASE (Bforward_line
):
1689 BEFORE_POTENTIAL_GC ();
1690 TOP
= Fforward_line (TOP
);
1691 AFTER_POTENTIAL_GC ();
1694 CASE (Bchar_syntax
):
1698 BEFORE_POTENTIAL_GC ();
1699 CHECK_CHARACTER (TOP
);
1700 AFTER_POTENTIAL_GC ();
1702 if (NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
1703 MAKE_CHAR_MULTIBYTE (c
);
1704 XSETFASTINT (TOP
, syntax_code_spec
[SYNTAX (c
)]);
1708 CASE (Bbuffer_substring
):
1711 BEFORE_POTENTIAL_GC ();
1713 TOP
= Fbuffer_substring (TOP
, v1
);
1714 AFTER_POTENTIAL_GC ();
1718 CASE (Bdelete_region
):
1721 BEFORE_POTENTIAL_GC ();
1723 TOP
= Fdelete_region (TOP
, v1
);
1724 AFTER_POTENTIAL_GC ();
1728 CASE (Bnarrow_to_region
):
1731 BEFORE_POTENTIAL_GC ();
1733 TOP
= Fnarrow_to_region (TOP
, v1
);
1734 AFTER_POTENTIAL_GC ();
1739 BEFORE_POTENTIAL_GC ();
1741 AFTER_POTENTIAL_GC ();
1744 CASE (Bend_of_line
):
1745 BEFORE_POTENTIAL_GC ();
1746 TOP
= Fend_of_line (TOP
);
1747 AFTER_POTENTIAL_GC ();
1753 BEFORE_POTENTIAL_GC ();
1756 TOP
= Fset_marker (TOP
, v2
, v1
);
1757 AFTER_POTENTIAL_GC ();
1761 CASE (Bmatch_beginning
):
1762 BEFORE_POTENTIAL_GC ();
1763 TOP
= Fmatch_beginning (TOP
);
1764 AFTER_POTENTIAL_GC ();
1768 BEFORE_POTENTIAL_GC ();
1769 TOP
= Fmatch_end (TOP
);
1770 AFTER_POTENTIAL_GC ();
1774 BEFORE_POTENTIAL_GC ();
1775 TOP
= Fupcase (TOP
);
1776 AFTER_POTENTIAL_GC ();
1780 BEFORE_POTENTIAL_GC ();
1781 TOP
= Fdowncase (TOP
);
1782 AFTER_POTENTIAL_GC ();
1785 CASE (Bstringeqlsign
):
1788 BEFORE_POTENTIAL_GC ();
1790 TOP
= Fstring_equal (TOP
, v1
);
1791 AFTER_POTENTIAL_GC ();
1798 BEFORE_POTENTIAL_GC ();
1800 TOP
= Fstring_lessp (TOP
, v1
);
1801 AFTER_POTENTIAL_GC ();
1809 TOP
= Fequal (TOP
, v1
);
1816 BEFORE_POTENTIAL_GC ();
1818 TOP
= Fnthcdr (TOP
, v1
);
1819 AFTER_POTENTIAL_GC ();
1828 /* Exchange args and then do nth. */
1830 BEFORE_POTENTIAL_GC ();
1834 AFTER_POTENTIAL_GC ();
1837 while (--n
>= 0 && CONSP (v1
))
1844 BEFORE_POTENTIAL_GC ();
1846 TOP
= Felt (TOP
, v1
);
1847 AFTER_POTENTIAL_GC ();
1855 BEFORE_POTENTIAL_GC ();
1857 TOP
= Fmember (TOP
, v1
);
1858 AFTER_POTENTIAL_GC ();
1865 BEFORE_POTENTIAL_GC ();
1867 TOP
= Fassq (TOP
, v1
);
1868 AFTER_POTENTIAL_GC ();
1873 BEFORE_POTENTIAL_GC ();
1874 TOP
= Fnreverse (TOP
);
1875 AFTER_POTENTIAL_GC ();
1881 BEFORE_POTENTIAL_GC ();
1883 TOP
= Fsetcar (TOP
, v1
);
1884 AFTER_POTENTIAL_GC ();
1891 BEFORE_POTENTIAL_GC ();
1893 TOP
= Fsetcdr (TOP
, v1
);
1894 AFTER_POTENTIAL_GC ();
1902 TOP
= CAR_SAFE (v1
);
1910 TOP
= CDR_SAFE (v1
);
1915 BEFORE_POTENTIAL_GC ();
1917 TOP
= Fnconc (2, &TOP
);
1918 AFTER_POTENTIAL_GC ();
1922 TOP
= (NUMBERP (TOP
) ? Qt
: Qnil
);
1926 TOP
= INTEGERP (TOP
) ? Qt
: Qnil
;
1929 #ifdef BYTE_CODE_SAFE
1930 /* These are intentionally written using 'case' syntax,
1931 because they are incompatible with the threaded
1935 BEFORE_POTENTIAL_GC ();
1936 error ("set-mark is an obsolete bytecode");
1937 AFTER_POTENTIAL_GC ();
1940 BEFORE_POTENTIAL_GC ();
1941 error ("scan-buffer is an obsolete bytecode");
1942 AFTER_POTENTIAL_GC ();
1947 /* Actually this is Bstack_ref with offset 0, but we use Bdup
1948 for that instead. */
1949 /* CASE (Bstack_ref): */
1950 call3 (intern ("error"),
1951 build_string ("Invalid byte opcode: op=%s, ptr=%d"),
1953 make_number ((stack
.pc
- 1) - stack
.byte_string_start
));
1955 /* Handy byte-codes for lexical binding. */
1962 Lisp_Object
*ptr
= top
- (op
- Bstack_ref
);
1968 Lisp_Object
*ptr
= top
- (FETCH
);
1974 Lisp_Object
*ptr
= top
- (FETCH2
);
1979 /* stack-set-0 = discard; stack-set-1 = discard-1-preserve-tos. */
1981 Lisp_Object
*ptr
= top
- (FETCH
);
1987 Lisp_Object
*ptr
= top
- (FETCH2
);
2003 #ifdef BYTE_CODE_SAFE
2008 if ((op
-= Bconstant
) >= const_length
)
2014 PUSH (vectorp
[op
- Bconstant
]);
2022 byte_stack_list
= byte_stack_list
->next
;
2024 /* Binds and unbinds are supposed to be compiled balanced. */
2025 if (SPECPDL_INDEX () != count
)
2027 if (SPECPDL_INDEX () > count
)
2028 unbind_to (count
, Qnil
);
2029 error ("binding stack not balanced (serious byte compiler bug)");
2036 syms_of_bytecode (void)
2038 defsubr (&Sbyte_code
);
2040 #ifdef BYTE_CODE_METER
2042 DEFVAR_LISP ("byte-code-meter", Vbyte_code_meter
,
2043 doc
: /* A vector of vectors which holds a histogram of byte-code usage.
2044 \(aref (aref byte-code-meter 0) CODE) indicates how many times the byte
2045 opcode CODE has been executed.
2046 \(aref (aref byte-code-meter CODE1) CODE2), where CODE1 is not 0,
2047 indicates how many times the byte opcodes CODE1 and CODE2 have been
2048 executed in succession. */);
2050 DEFVAR_BOOL ("byte-metering-on", byte_metering_on
,
2051 doc
: /* If non-nil, keep profiling information on byte code usage.
2052 The variable byte-code-meter indicates how often each byte opcode is used.
2053 If a symbol has a property named `byte-code-meter' whose value is an
2054 integer, it is incremented each time that symbol's function is called. */);
2056 byte_metering_on
= 0;
2057 Vbyte_code_meter
= Fmake_vector (make_number (256), make_number (0));
2058 DEFSYM (Qbyte_code_meter
, "byte-code-meter");
2062 ASET (Vbyte_code_meter
, i
,
2063 Fmake_vector (make_number (256), make_number (0)));