bytecode.c 37.8 KB
Newer Older
Jim Blandy's avatar
Jim Blandy committed
1
/* Execution of byte code produced by bytecomp.el.
Paul Eggert's avatar
Paul Eggert committed
2
   Copyright (C) 1985-1988, 1993, 2000-2016 Free Software Foundation,
3
   Inc.
Jim Blandy's avatar
Jim Blandy committed
4 5 6

This file is part of GNU Emacs.

7
GNU Emacs is free software: you can redistribute it and/or modify
Jim Blandy's avatar
Jim Blandy committed
8
it under the terms of the GNU General Public License as published by
9 10
the Free Software Foundation, either version 3 of the License, or (at
your option) any later version.
Jim Blandy's avatar
Jim Blandy committed
11 12 13 14 15 16 17

GNU Emacs is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

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/>.  */
Jim Blandy's avatar
Jim Blandy committed
19

20
#include <config.h>
21

Jim Blandy's avatar
Jim Blandy committed
22
#include "lisp.h"
Paul Eggert's avatar
Paul Eggert committed
23
#include "blockinput.h"
24
#include "character.h"
25
#include "buffer.h"
Paul Eggert's avatar
Paul Eggert committed
26
#include "keyboard.h"
Jim Blandy's avatar
Jim Blandy committed
27
#include "syntax.h"
Stefan Monnier's avatar
Stefan Monnier committed
28
#include "window.h"
Jim Blandy's avatar
Jim Blandy committed
29

30 31 32 33 34
#ifdef CHECK_FRAME_FONT
#include "frame.h"
#include "xterm.h"
#endif

35
/*
36
 * define BYTE_CODE_SAFE to enable some minor sanity checking (useful for
37 38
 * debugging the byte compiler...)
 *
39
 * define BYTE_CODE_METER to enable generation of a byte-op usage histogram.
Jim Blandy's avatar
Jim Blandy committed
40
 */
41 42
/* #define BYTE_CODE_SAFE */
/* #define BYTE_CODE_METER */
Jim Blandy's avatar
Jim Blandy committed
43

Tom Tromey's avatar
Tom Tromey committed
44 45 46 47
/* If BYTE_CODE_THREADED is defined, then the interpreter will be
   indirect threaded, using GCC's computed goto extension.  This code,
   as currently implemented, is incompatible with BYTE_CODE_SAFE and
   BYTE_CODE_METER.  */
Paul Eggert's avatar
Paul Eggert committed
48 49
#if (defined __GNUC__ && !defined __STRICT_ANSI__ \
     && !defined BYTE_CODE_SAFE && !defined BYTE_CODE_METER)
Tom Tromey's avatar
Tom Tromey committed
50 51 52
#define BYTE_CODE_THREADED
#endif

Jim Blandy's avatar
Jim Blandy committed
53 54 55

#ifdef BYTE_CODE_METER

56 57
#define METER_2(code1, code2) AREF (AREF (Vbyte_code_meter, code1), code2)
#define METER_1(code) METER_2 (0, code)
58

59 60 61 62
#define METER_CODE(last_code, this_code)				\
{									\
  if (byte_metering_on)							\
    {									\
63 64 65
      if (XFASTINT (METER_1 (this_code)) < MOST_POSITIVE_FIXNUM)	\
        XSETFASTINT (METER_1 (this_code),				\
		     XFASTINT (METER_1 (this_code)) + 1);		\
66
      if (last_code							\
67 68 69 70
	  && (XFASTINT (METER_2 (last_code, this_code))			\
	      < MOST_POSITIVE_FIXNUM))					\
        XSETFASTINT (METER_2 (last_code, this_code),			\
		     XFASTINT (METER_2 (last_code, this_code)) + 1);	\
71
    }									\
72
}
Jim Blandy's avatar
Jim Blandy committed
73

74
#endif /* BYTE_CODE_METER */
Jim Blandy's avatar
Jim Blandy committed
75 76 77 78


/*  Byte codes: */

Tom Tromey's avatar
Tom Tromey committed
79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128
#define BYTE_CODES							\
DEFINE (Bstack_ref, 0) /* Actually, Bstack_ref+0 is not implemented: use dup.  */ \
DEFINE (Bstack_ref1, 1)							\
DEFINE (Bstack_ref2, 2)							\
DEFINE (Bstack_ref3, 3)							\
DEFINE (Bstack_ref4, 4)							\
DEFINE (Bstack_ref5, 5)							\
DEFINE (Bstack_ref6, 6)							\
DEFINE (Bstack_ref7, 7)							\
DEFINE (Bvarref, 010)							\
DEFINE (Bvarref1, 011)							\
DEFINE (Bvarref2, 012)							\
DEFINE (Bvarref3, 013)							\
DEFINE (Bvarref4, 014)							\
DEFINE (Bvarref5, 015)							\
DEFINE (Bvarref6, 016)							\
DEFINE (Bvarref7, 017)							\
DEFINE (Bvarset, 020)							\
DEFINE (Bvarset1, 021)							\
DEFINE (Bvarset2, 022)							\
DEFINE (Bvarset3, 023)							\
DEFINE (Bvarset4, 024)							\
DEFINE (Bvarset5, 025)							\
DEFINE (Bvarset6, 026)							\
DEFINE (Bvarset7, 027)							\
DEFINE (Bvarbind, 030)							\
DEFINE (Bvarbind1, 031)							\
DEFINE (Bvarbind2, 032)							\
DEFINE (Bvarbind3, 033)							\
DEFINE (Bvarbind4, 034)							\
DEFINE (Bvarbind5, 035)							\
DEFINE (Bvarbind6, 036)							\
DEFINE (Bvarbind7, 037)							\
DEFINE (Bcall, 040)							\
DEFINE (Bcall1, 041)							\
DEFINE (Bcall2, 042)							\
DEFINE (Bcall3, 043)							\
DEFINE (Bcall4, 044)							\
DEFINE (Bcall5, 045)							\
DEFINE (Bcall6, 046)							\
DEFINE (Bcall7, 047)							\
DEFINE (Bunbind, 050)							\
DEFINE (Bunbind1, 051)							\
DEFINE (Bunbind2, 052)							\
DEFINE (Bunbind3, 053)							\
DEFINE (Bunbind4, 054)							\
DEFINE (Bunbind5, 055)							\
DEFINE (Bunbind6, 056)							\
DEFINE (Bunbind7, 057)							\
									\
129 130 131 132
DEFINE (Bpophandler, 060)						\
DEFINE (Bpushconditioncase, 061)					\
DEFINE (Bpushcatch, 062)						\
									\
Tom Tromey's avatar
Tom Tromey committed
133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275
DEFINE (Bnth, 070)							\
DEFINE (Bsymbolp, 071)							\
DEFINE (Bconsp, 072)							\
DEFINE (Bstringp, 073)							\
DEFINE (Blistp, 074)							\
DEFINE (Beq, 075)							\
DEFINE (Bmemq, 076)							\
DEFINE (Bnot, 077)							\
DEFINE (Bcar, 0100)							\
DEFINE (Bcdr, 0101)							\
DEFINE (Bcons, 0102)							\
DEFINE (Blist1, 0103)							\
DEFINE (Blist2, 0104)							\
DEFINE (Blist3, 0105)							\
DEFINE (Blist4, 0106)							\
DEFINE (Blength, 0107)							\
DEFINE (Baref, 0110)							\
DEFINE (Baset, 0111)							\
DEFINE (Bsymbol_value, 0112)						\
DEFINE (Bsymbol_function, 0113)						\
DEFINE (Bset, 0114)							\
DEFINE (Bfset, 0115)							\
DEFINE (Bget, 0116)							\
DEFINE (Bsubstring, 0117)						\
DEFINE (Bconcat2, 0120)							\
DEFINE (Bconcat3, 0121)							\
DEFINE (Bconcat4, 0122)							\
DEFINE (Bsub1, 0123)							\
DEFINE (Badd1, 0124)							\
DEFINE (Beqlsign, 0125)							\
DEFINE (Bgtr, 0126)							\
DEFINE (Blss, 0127)							\
DEFINE (Bleq, 0130)							\
DEFINE (Bgeq, 0131)							\
DEFINE (Bdiff, 0132)							\
DEFINE (Bnegate, 0133)							\
DEFINE (Bplus, 0134)							\
DEFINE (Bmax, 0135)							\
DEFINE (Bmin, 0136)							\
DEFINE (Bmult, 0137)							\
									\
DEFINE (Bpoint, 0140)							\
/* Was Bmark in v17.  */						\
DEFINE (Bsave_current_buffer, 0141) /* Obsolete.  */			\
DEFINE (Bgoto_char, 0142)						\
DEFINE (Binsert, 0143)							\
DEFINE (Bpoint_max, 0144)						\
DEFINE (Bpoint_min, 0145)						\
DEFINE (Bchar_after, 0146)						\
DEFINE (Bfollowing_char, 0147)						\
DEFINE (Bpreceding_char, 0150)						\
DEFINE (Bcurrent_column, 0151)						\
DEFINE (Bindent_to, 0152)						\
DEFINE (Beolp, 0154)							\
DEFINE (Beobp, 0155)							\
DEFINE (Bbolp, 0156)							\
DEFINE (Bbobp, 0157)							\
DEFINE (Bcurrent_buffer, 0160)						\
DEFINE (Bset_buffer, 0161)						\
DEFINE (Bsave_current_buffer_1, 0162) /* Replacing Bsave_current_buffer.  */ \
DEFINE (Binteractive_p, 0164) /* Obsolete since Emacs-24.1.  */		\
									\
DEFINE (Bforward_char, 0165)						\
DEFINE (Bforward_word, 0166)						\
DEFINE (Bskip_chars_forward, 0167)					\
DEFINE (Bskip_chars_backward, 0170)					\
DEFINE (Bforward_line, 0171)						\
DEFINE (Bchar_syntax, 0172)						\
DEFINE (Bbuffer_substring, 0173)					\
DEFINE (Bdelete_region, 0174)						\
DEFINE (Bnarrow_to_region, 0175)					\
DEFINE (Bwiden, 0176)							\
DEFINE (Bend_of_line, 0177)						\
									\
DEFINE (Bconstant2, 0201)						\
DEFINE (Bgoto, 0202)							\
DEFINE (Bgotoifnil, 0203)						\
DEFINE (Bgotoifnonnil, 0204)						\
DEFINE (Bgotoifnilelsepop, 0205)					\
DEFINE (Bgotoifnonnilelsepop, 0206)					\
DEFINE (Breturn, 0207)							\
DEFINE (Bdiscard, 0210)							\
DEFINE (Bdup, 0211)							\
									\
DEFINE (Bsave_excursion, 0212)						\
DEFINE (Bsave_window_excursion, 0213) /* Obsolete since Emacs-24.1.  */	\
DEFINE (Bsave_restriction, 0214)					\
DEFINE (Bcatch, 0215)							\
									\
DEFINE (Bunwind_protect, 0216)						\
DEFINE (Bcondition_case, 0217)						\
DEFINE (Btemp_output_buffer_setup, 0220) /* Obsolete since Emacs-24.1.  */ \
DEFINE (Btemp_output_buffer_show, 0221)  /* Obsolete since Emacs-24.1.  */ \
									\
DEFINE (Bunbind_all, 0222)	/* Obsolete.  Never used.  */		\
									\
DEFINE (Bset_marker, 0223)						\
DEFINE (Bmatch_beginning, 0224)						\
DEFINE (Bmatch_end, 0225)						\
DEFINE (Bupcase, 0226)							\
DEFINE (Bdowncase, 0227)						\
									\
DEFINE (Bstringeqlsign, 0230)						\
DEFINE (Bstringlss, 0231)						\
DEFINE (Bequal, 0232)							\
DEFINE (Bnthcdr, 0233)							\
DEFINE (Belt, 0234)							\
DEFINE (Bmember, 0235)							\
DEFINE (Bassq, 0236)							\
DEFINE (Bnreverse, 0237)						\
DEFINE (Bsetcar, 0240)							\
DEFINE (Bsetcdr, 0241)							\
DEFINE (Bcar_safe, 0242)						\
DEFINE (Bcdr_safe, 0243)						\
DEFINE (Bnconc, 0244)							\
DEFINE (Bquo, 0245)							\
DEFINE (Brem, 0246)							\
DEFINE (Bnumberp, 0247)							\
DEFINE (Bintegerp, 0250)						\
									\
DEFINE (BRgoto, 0252)							\
DEFINE (BRgotoifnil, 0253)						\
DEFINE (BRgotoifnonnil, 0254)						\
DEFINE (BRgotoifnilelsepop, 0255)					\
DEFINE (BRgotoifnonnilelsepop, 0256)					\
									\
DEFINE (BlistN, 0257)							\
DEFINE (BconcatN, 0260)							\
DEFINE (BinsertN, 0261)							\
									\
/* Bstack_ref is code 0.  */						\
DEFINE (Bstack_set,  0262)						\
DEFINE (Bstack_set2, 0263)						\
DEFINE (BdiscardN,   0266)						\
									\
DEFINE (Bconstant, 0300)

enum byte_code_op
{
#define DEFINE(name, value) name = value,
    BYTE_CODES
#undef DEFINE

276
#ifdef BYTE_CODE_SAFE
Tom Tromey's avatar
Tom Tromey committed
277
    Bscan_buffer = 0153, /* No longer generated as of v18.  */
Paul Eggert's avatar
Paul Eggert committed
278
    Bset_mark = 0163, /* this loser is no longer generated as of v18 */
279
#endif
Tom Tromey's avatar
Tom Tromey committed
280
};
281

Gerd Moellmann's avatar
Gerd Moellmann committed
282 283 284 285 286 287 288
/* Structure describing a value stack used during byte-code execution
   in Fbyte_code.  */

struct byte_stack
{
  /* Program counter.  This points into the byte_string below
     and is relocated when that string is relocated.  */
289
  const unsigned char *pc;
Gerd Moellmann's avatar
Gerd Moellmann committed
290 291

  /* The string containing the byte-code, and its current address.
292
     Storing this here protects it from GC.  */
Gerd Moellmann's avatar
Gerd Moellmann committed
293
  Lisp_Object byte_string;
294
  const unsigned char *byte_string_start;
Gerd Moellmann's avatar
Gerd Moellmann committed
295 296 297 298 299 300 301

  /* Next entry in byte_stack_list.  */
  struct byte_stack *next;
};

/* A list of currently active byte-code execution value stacks.
   Fbyte_code adds an entry to the head of this list before it starts
302
   processing byte-code, and it removes the entry again when it is
303
   done.  Signaling an error truncates the list.  */
Gerd Moellmann's avatar
Gerd Moellmann committed
304 305 306

struct byte_stack *byte_stack_list;

307

308 309
/* Relocate program counters in the stacks on byte_stack_list.  Called
   when GC has completed.  */
Gerd Moellmann's avatar
Gerd Moellmann committed
310

311
void
312
relocate_byte_stack (void)
Gerd Moellmann's avatar
Gerd Moellmann committed
313 314 315 316
{
  struct byte_stack *stack;

  for (stack = byte_stack_list; stack; stack = stack->next)
317
    {
318
      if (stack->byte_string_start != SDATA (stack->byte_string))
319
	{
320
	  ptrdiff_t offset = stack->pc - stack->byte_string_start;
321
	  stack->byte_string_start = SDATA (stack->byte_string);
322 323 324
	  stack->pc = stack->byte_string_start + offset;
	}
    }
Gerd Moellmann's avatar
Gerd Moellmann committed
325 326
}

Jim Blandy's avatar
Jim Blandy committed
327

328
/* Fetch the next byte from the bytecode stream.  */
Jim Blandy's avatar
Jim Blandy committed
329

330 331 332
#ifdef BYTE_CODE_SAFE
#define FETCH (eassert (stack.byte_string_start == SDATA (stack.byte_string)), *stack.pc++)
#else
Gerd Moellmann's avatar
Gerd Moellmann committed
333
#define FETCH *stack.pc++
334
#endif
Jim Blandy's avatar
Jim Blandy committed
335

336
/* Fetch two bytes from the bytecode stream and make a 16-bit number
337
   out of them.  */
Jim Blandy's avatar
Jim Blandy committed
338 339 340

#define FETCH2 (op = FETCH, op + (FETCH << 8))

341 342
/* Push X onto the execution stack.  The expression X should not
   contain TOP, to avoid competing side effects.  */
Gerd Moellmann's avatar
Gerd Moellmann committed
343

344
#define PUSH(x) (*++top = (x))
Jim Blandy's avatar
Jim Blandy committed
345 346 347

/* Pop a value off the execution stack.  */

Gerd Moellmann's avatar
Gerd Moellmann committed
348
#define POP (*top--)
Jim Blandy's avatar
Jim Blandy committed
349 350 351

/* Discard n values from the execution stack.  */

Gerd Moellmann's avatar
Gerd Moellmann committed
352 353 354
#define DISCARD(n) (top -= (n))

/* Get the value which is at the top of the execution stack, but don't
355
   pop it.  */
Gerd Moellmann's avatar
Gerd Moellmann committed
356 357

#define TOP (*top)
Jim Blandy's avatar
Jim Blandy committed
358

359
/* Check for jumping out of range.  */
Gerd Moellmann's avatar
Gerd Moellmann committed
360 361 362

#ifdef BYTE_CODE_SAFE

363
#define CHECK_RANGE(ARG) \
364
  if (ARG >= bytestr_length) emacs_abort ()
365

366
#else /* not BYTE_CODE_SAFE */
Gerd Moellmann's avatar
Gerd Moellmann committed
367 368 369

#define CHECK_RANGE(ARG)

370
#endif /* not BYTE_CODE_SAFE */
Gerd Moellmann's avatar
Gerd Moellmann committed
371

Gerd Moellmann's avatar
Gerd Moellmann committed
372 373 374 375 376 377 378
/* A version of the QUIT macro which makes sure that the stack top is
   set before signaling `quit'.  */

#define BYTE_CODE_QUIT					\
  do {							\
    if (!NILP (Vquit_flag) && NILP (Vinhibit_quit))	\
      {							\
379
        Lisp_Object flag = Vquit_flag;			\
Gerd Moellmann's avatar
Gerd Moellmann committed
380
	Vquit_flag = Qnil;				\
381
	if (EQ (Vthrow_on_input, flag))			\
382
	  Fthrow (Vthrow_on_input, Qt);			\
Gerd Moellmann's avatar
Gerd Moellmann committed
383 384
	Fsignal (Qquit, Qnil);				\
      }							\
385 386
    else if (pending_signals)				\
      process_pending_signals ();			\
Gerd Moellmann's avatar
Gerd Moellmann committed
387 388
  } while (0)

Gerd Moellmann's avatar
Gerd Moellmann committed
389

Jim Blandy's avatar
Jim Blandy committed
390
DEFUN ("byte-code", Fbyte_code, Sbyte_code, 3, 3, 0,
391 392 393 394 395
       doc: /* Function used internally in byte-compiled code.
The first argument, BYTESTR, is a string of byte code;
the second, VECTOR, a vector of constants;
the third, MAXDEPTH, the maximum stack depth used in this function.
If the third argument is incorrect, Emacs may crash.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
396
  (Lisp_Object bytestr, Lisp_Object vector, Lisp_Object maxdepth)
397
{
398
  return exec_byte_code (bytestr, vector, maxdepth, Qnil, 0, NULL);
399 400
}

401 402 403 404 405 406
static void
bcall0 (Lisp_Object f)
{
  Ffuncall (1, &f);
}

407 408 409 410 411 412 413 414 415
/* Execute the byte-code in BYTESTR.  VECTOR is the constant vector, and
   MAXDEPTH is the maximum stack depth used (if MAXDEPTH is incorrect,
   emacs may crash!).  If ARGS_TEMPLATE is non-nil, it should be a lisp
   argument list (including &rest, &optional, etc.), and ARGS, of size
   NARGS, should be a vector of the actual arguments.  The arguments in
   ARGS are pushed on the stack according to ARGS_TEMPLATE before
   executing BYTESTR.  */

Lisp_Object
Stefan Monnier's avatar
Stefan Monnier committed
416
exec_byte_code (Lisp_Object bytestr, Lisp_Object vector, Lisp_Object maxdepth,
417
		Lisp_Object args_template, ptrdiff_t nargs, Lisp_Object *args)
Jim Blandy's avatar
Jim Blandy committed
418
{
419
  ptrdiff_t count = SPECPDL_INDEX ();
Jim Blandy's avatar
Jim Blandy committed
420
#ifdef BYTE_CODE_METER
421
  int volatile this_op = 0;
Jim Blandy's avatar
Jim Blandy committed
422 423
  int prev_op;
#endif
Gerd Moellmann's avatar
Gerd Moellmann committed
424
  int op;
425
  /* Lisp_Object v1, v2; */
426
  Lisp_Object *vectorp;
Jim Blandy's avatar
Jim Blandy committed
427
#ifdef BYTE_CODE_SAFE
428 429 430
  ptrdiff_t const_length;
  Lisp_Object *stacke;
  ptrdiff_t bytestr_length;
431
#endif
Gerd Moellmann's avatar
Gerd Moellmann committed
432 433
  struct byte_stack stack;
  Lisp_Object *top;
434
  Lisp_Object result;
435
  enum handlertype type;
Jim Blandy's avatar
Jim Blandy committed
436

437
#if 0 /* CHECK_FRAME_FONT */
438 439 440 441 442
 {
   struct frame *f = SELECTED_FRAME ();
   if (FRAME_X_P (f)
       && FRAME_FONT (f)->direction != 0
       && FRAME_FONT (f)->direction != 1)
443
     emacs_abort ();
444 445 446
 }
#endif

447
  CHECK_STRING (bytestr);
Kim F. Storm's avatar
Kim F. Storm committed
448
  CHECK_VECTOR (vector);
449
  CHECK_NATNUM (maxdepth);
Jim Blandy's avatar
Jim Blandy committed
450

451
#ifdef BYTE_CODE_SAFE
452
  const_length = ASIZE (vector);
453 454
#endif

455 456 457 458 459
  if (STRING_MULTIBYTE (bytestr))
    /* BYTESTR must have been produced by Emacs 20.2 or the earlier
       because they produced a raw 8-bit string for byte-code and now
       such a byte-code string is loaded as multibyte while raw 8-bit
       characters converted to multibyte form.  Thus, now we must
460
       convert them back to the originally intended unibyte form.  */
461
    bytestr = Fstring_as_unibyte (bytestr);
462

463
#ifdef BYTE_CODE_SAFE
464
  bytestr_length = SBYTES (bytestr);
465
#endif
Paul Eggert's avatar
Paul Eggert committed
466
  vectorp = XVECTOR (vector)->contents;
467

Gerd Moellmann's avatar
Gerd Moellmann committed
468
  stack.byte_string = bytestr;
469
  stack.pc = stack.byte_string_start = SDATA (bytestr);
470
  if (MAX_ALLOCA / word_size <= XFASTINT (maxdepth))
471
    memory_full (SIZE_MAX);
472
  top = alloca ((XFASTINT (maxdepth) + 1) * sizeof *top);
Gerd Moellmann's avatar
Gerd Moellmann committed
473 474
  stack.next = byte_stack_list;
  byte_stack_list = &stack;
Jim Blandy's avatar
Jim Blandy committed
475

Gerd Moellmann's avatar
Gerd Moellmann committed
476 477 478
#ifdef BYTE_CODE_SAFE
  stacke = stack.bottom - 1 + XFASTINT (maxdepth);
#endif
479

480
  if (INTEGERP (args_template))
481
    {
482
      ptrdiff_t at = XINT (args_template);
483
      bool rest = (at & 128) != 0;
484
      int mandatory = at & 127;
485
      ptrdiff_t nonrest = at >> 8;
486 487 488
      eassert (mandatory <= nonrest);
      if (nargs <= nonrest)
	{
489
	  ptrdiff_t i;
490 491 492 493 494
	  for (i = 0 ; i < nargs; i++, args++)
	    PUSH (*args);
	  if (nargs < mandatory)
	    /* Too few arguments.  */
	    Fsignal (Qwrong_number_of_arguments,
495
		     list2 (Fcons (make_number (mandatory),
496
				   rest ? Qand_rest : make_number (nonrest)),
497
			    make_number (nargs)));
498 499 500 501 502 503 504 505 506 507
	  else
	    {
	      for (; i < nonrest; i++)
		PUSH (Qnil);
	      if (rest)
		PUSH (Qnil);
	    }
	}
      else if (rest)
	{
508
	  ptrdiff_t i;
509 510 511 512 513 514
	  for (i = 0 ; i < nonrest; i++, args++)
	    PUSH (*args);
	  PUSH (Flist (nargs - nonrest, args));
	}
      else
	/* Too many arguments.  */
515
	Fsignal (Qwrong_number_of_arguments,
516 517
		 list2 (Fcons (make_number (mandatory), make_number (nonrest)),
			make_number (nargs)));
518 519 520 521 522
    }
  else if (! NILP (args_template))
    /* We should push some arguments on the stack.  */
    {
      error ("Unknown args template!");
523 524
    }

Jim Blandy's avatar
Jim Blandy committed
525 526 527
  while (1)
    {
#ifdef BYTE_CODE_SAFE
528
      if (top > stacke)
529
	emacs_abort ();
Gerd Moellmann's avatar
Gerd Moellmann committed
530
      else if (top < stack.bottom - 1)
531
	emacs_abort ();
Jim Blandy's avatar
Jim Blandy committed
532 533 534 535 536 537 538
#endif

#ifdef BYTE_CODE_METER
      prev_op = this_op;
      this_op = op = FETCH;
      METER_CODE (prev_op, op);
#else
Tom Tromey's avatar
Tom Tromey committed
539
#ifndef BYTE_CODE_THREADED
540
      op = FETCH;
Jim Blandy's avatar
Jim Blandy committed
541
#endif
Tom Tromey's avatar
Tom Tromey committed
542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583
#endif

      /* The interpreter can be compiled one of two ways: as an
	 ordinary switch-based interpreter, or as a threaded
	 interpreter.  The threaded interpreter relies on GCC's
	 computed goto extension, so it is not available everywhere.
	 Threading provides a performance boost.  These macros are how
	 we allow the code to be compiled both ways.  */
#ifdef BYTE_CODE_THREADED
      /* The CASE macro introduces an instruction's body.  It is
	 either a label or a case label.  */
#define CASE(OP) insn_ ## OP
      /* NEXT is invoked at the end of an instruction to go to the
	 next instruction.  It is either a computed goto, or a
	 plain break.  */
#define NEXT goto *(targets[op = FETCH])
      /* FIRST is like NEXT, but is only used at the start of the
	 interpreter body.  In the switch-based interpreter it is the
	 switch, so the threaded definition must include a semicolon.  */
#define FIRST NEXT;
      /* Most cases are labeled with the CASE macro, above.
	 CASE_DEFAULT is one exception; it is used if the interpreter
	 being built requires a default case.  The threaded
	 interpreter does not, because the dispatch table is
	 completely filled.  */
#define CASE_DEFAULT
      /* This introduces an instruction that is known to call abort.  */
#define CASE_ABORT CASE (Bstack_ref): CASE (default)
#else
      /* See above for the meaning of the various defines.  */
#define CASE(OP) case OP
#define NEXT break
#define FIRST switch (op)
#define CASE_DEFAULT case 255: default:
#define CASE_ABORT case 0
#endif

#ifdef BYTE_CODE_THREADED

      /* A convenience define that saves us a lot of typing and makes
	 the table clearer.  */
#define LABEL(OP) [OP] = &&insn_ ## OP
Jim Blandy's avatar
Jim Blandy committed
584

585
#if GNUC_PREREQ (4, 6, 0)
586 587
# pragma GCC diagnostic push
# pragma GCC diagnostic ignored "-Woverride-init"
588 589 590
#elif defined __clang__
# pragma GCC diagnostic push
# pragma GCC diagnostic ignored "-Winitializer-overrides"
591 592
#endif

Tom Tromey's avatar
Tom Tromey committed
593 594
      /* This is the dispatch table for the threaded interpreter.  */
      static const void *const targets[256] =
595
	{
Tom Tromey's avatar
Tom Tromey committed
596 597 598 599 600 601 602
	  [0 ... (Bconstant - 1)] = &&insn_default,
	  [Bconstant ... 255] = &&insn_Bconstant,

#define DEFINE(name, value) LABEL (name) ,
	  BYTE_CODES
#undef DEFINE
	};
603

604
#if GNUC_PREREQ (4, 6, 0) || defined __clang__
605 606 607
# pragma GCC diagnostic pop
#endif

Tom Tromey's avatar
Tom Tromey committed
608 609 610 611 612 613
#endif


      FIRST
	{
	CASE (Bvarref7):
Jim Blandy's avatar
Jim Blandy committed
614 615 616
	  op = FETCH2;
	  goto varref;

Tom Tromey's avatar
Tom Tromey committed
617 618 619 620 621 622
	CASE (Bvarref):
	CASE (Bvarref1):
	CASE (Bvarref2):
	CASE (Bvarref3):
	CASE (Bvarref4):
	CASE (Bvarref5):
Jim Blandy's avatar
Jim Blandy committed
623
	  op = op - Bvarref;
624 625 626 627
	  goto varref;

	/* This seems to be the most frequently executed byte-code
	   among the Bvarref's, so avoid a goto here.  */
Tom Tromey's avatar
Tom Tromey committed
628
	CASE (Bvarref6):
629
	  op = FETCH;
Jim Blandy's avatar
Jim Blandy committed
630
	varref:
631 632 633 634 635 636
	  {
	    Lisp_Object v1, v2;

	    v1 = vectorp[op];
	    if (SYMBOLP (v1))
	      {
637 638 639
		if (XSYMBOL (v1)->redirect != SYMBOL_PLAINVAL
		    || (v2 = SYMBOL_VAL (XSYMBOL (v1)),
			EQ (v2, Qunbound)))
640 641 642
		  {
		    v2 = Fsymbol_value (v1);
		  }
643 644
	      }
	    else
645 646 647
	      {
		v2 = Fsymbol_value (v1);
	      }
648
	    PUSH (v2);
Tom Tromey's avatar
Tom Tromey committed
649
	    NEXT;
650 651
	  }

Tom Tromey's avatar
Tom Tromey committed
652
	CASE (Bgotoifnil):
653 654
	  {
	    Lisp_Object v1;
Paul Eggert's avatar
Paul Eggert committed
655
	    maybe_gc ();
656 657 658 659 660 661 662 663
	    op = FETCH2;
	    v1 = POP;
	    if (NILP (v1))
	      {
		BYTE_CODE_QUIT;
		CHECK_RANGE (op);
		stack.pc = stack.byte_string_start + op;
	      }
Tom Tromey's avatar
Tom Tromey committed
664
	    NEXT;
665
	  }
Jim Blandy's avatar
Jim Blandy committed
666

Tom Tromey's avatar
Tom Tromey committed
667
	CASE (Bcar):
668 669 670
	  {
	    Lisp_Object v1;
	    v1 = TOP;
671 672 673 674 675 676 677 678
	    if (CONSP (v1))
	      TOP = XCAR (v1);
	    else if (NILP (v1))
	      TOP = Qnil;
	    else
	      {
		wrong_type_argument (Qlistp, v1);
	      }
Tom Tromey's avatar
Tom Tromey committed
679
	    NEXT;
680 681
	  }

Tom Tromey's avatar
Tom Tromey committed
682
	CASE (Beq):
683 684 685 686
	  {
	    Lisp_Object v1;
	    v1 = POP;
	    TOP = EQ (v1, TOP) ? Qt : Qnil;
Tom Tromey's avatar
Tom Tromey committed
687
	    NEXT;
688 689
	  }

Tom Tromey's avatar
Tom Tromey committed
690
	CASE (Bmemq):
691 692 693 694
	  {
	    Lisp_Object v1;
	    v1 = POP;
	    TOP = Fmemq (TOP, v1);
Tom Tromey's avatar
Tom Tromey committed
695
	    NEXT;
696 697
	  }

Tom Tromey's avatar
Tom Tromey committed
698
	CASE (Bcdr):
699 700 701
	  {
	    Lisp_Object v1;
	    v1 = TOP;
702 703 704 705 706 707 708 709
	    if (CONSP (v1))
	      TOP = XCDR (v1);
	    else if (NILP (v1))
	      TOP = Qnil;
	    else
	      {
		wrong_type_argument (Qlistp, v1);
	      }
Tom Tromey's avatar
Tom Tromey committed
710
	    NEXT;
711
	  }
Jim Blandy's avatar
Jim Blandy committed
712

Tom Tromey's avatar
Tom Tromey committed
713 714 715 716 717 718
	CASE (Bvarset):
	CASE (Bvarset1):
	CASE (Bvarset2):
	CASE (Bvarset3):
	CASE (Bvarset4):
	CASE (Bvarset5):
719
	  op -= Bvarset;
Jim Blandy's avatar
Jim Blandy committed
720 721
	  goto varset;

Tom Tromey's avatar
Tom Tromey committed
722
	CASE (Bvarset7):
723
	  op = FETCH2;
724 725
	  goto varset;

Tom Tromey's avatar
Tom Tromey committed
726
	CASE (Bvarset6):
727
	  op = FETCH;
Jim Blandy's avatar
Jim Blandy committed
728
	varset:
729 730
	  {
	    Lisp_Object sym, val;
731

732
	    sym = vectorp[op];
733
	    val = TOP;
734 735 736 737

	    /* Inline the most common case.  */
	    if (SYMBOLP (sym)
		&& !EQ (val, Qunbound)
738 739
		&& !XSYMBOL (sym)->redirect
		&& !SYMBOL_CONSTANT_P (sym))
740
	      SET_SYMBOL_VAL (XSYMBOL (sym), val);
741
	    else
742
	      {
743
		set_internal (sym, val, Qnil, 0);
744
	      }
745
	  }
746
	  (void) POP;
Tom Tromey's avatar
Tom Tromey committed
747
	  NEXT;
Jim Blandy's avatar
Jim Blandy committed
748

Tom Tromey's avatar
Tom Tromey committed
749
	CASE (Bdup):
750 751 752 753
	  {
	    Lisp_Object v1;
	    v1 = TOP;
	    PUSH (v1);
Tom Tromey's avatar
Tom Tromey committed
754
	    NEXT;
755 756 757 758
	  }

	/* ------------------ */

Tom Tromey's avatar
Tom Tromey committed
759
	CASE (Bvarbind6):
Jim Blandy's avatar
Jim Blandy committed
760 761 762
	  op = FETCH;
	  goto varbind;

Tom Tromey's avatar
Tom Tromey committed
763
	CASE (Bvarbind7):
Jim Blandy's avatar
Jim Blandy committed
764 765 766
	  op = FETCH2;
	  goto varbind;

Tom Tromey's avatar
Tom Tromey committed
767 768 769 770 771 772
	CASE (Bvarbind):
	CASE (Bvarbind1):
	CASE (Bvarbind2):
	CASE (Bvarbind3):
	CASE (Bvarbind4):
	CASE (Bvarbind5):
Jim Blandy's avatar
Jim Blandy committed
773 774
	  op -= Bvarbind;
	varbind:
775
	  /* Specbind can signal and thus GC.  */
Jim Blandy's avatar
Jim Blandy committed
776
	  specbind (vectorp[op], POP);
Tom Tromey's avatar
Tom Tromey committed
777
	  NEXT;
Jim Blandy's avatar
Jim Blandy committed
778

Tom Tromey's avatar
Tom Tromey committed
779
	CASE (Bcall6):
Jim Blandy's avatar
Jim Blandy committed
780 781 782
	  op = FETCH;
	  goto docall;

Tom Tromey's avatar
Tom Tromey committed
783
	CASE (Bcall7):
Jim Blandy's avatar
Jim Blandy committed
784 785 786
	  op = FETCH2;
	  goto docall;

Tom Tromey's avatar
Tom Tromey committed
787 788 789 790 791 792
	CASE (Bcall):
	CASE (Bcall1):
	CASE (Bcall2):
	CASE (Bcall3):
	CASE (Bcall4):
	CASE (Bcall5):
Jim Blandy's avatar
Jim Blandy committed
793 794
	  op -= Bcall;
	docall:
795 796
	  {
	    DISCARD (op);
797
#ifdef BYTE_CODE_METER
798 799 800 801 802 803 804
	    if (byte_metering_on && SYMBOLP (TOP))
	      {
		Lisp_Object v1, v2;

		v1 = TOP;
		v2 = Fget (v1, Qbyte_code_meter);
		if (INTEGERP (v2)
805
		    && XINT (v2) < MOST_POSITIVE_FIXNUM)
806 807 808 809 810
		  {
		    XSETINT (v2, XINT (v2) + 1);
		    Fput (v1, Qbyte_code_meter, v2);
		  }
	      }
811
#endif
812
	    TOP = Ffuncall (op + 1, &TOP);
Tom Tromey's avatar
Tom Tromey committed
813
	    NEXT;
814
	  }
Jim Blandy's avatar
Jim Blandy committed
815

Tom Tromey's avatar
Tom Tromey committed
816
	CASE (Bunbind6):
Jim Blandy's avatar
Jim Blandy committed
817 818 819
	  op = FETCH;
	  goto dounbind;

Tom Tromey's avatar
Tom Tromey committed
820
	CASE (Bunbind7):
Jim Blandy's avatar
Jim Blandy committed
821 822 823
	  op = FETCH2;
	  goto dounbind;

Tom Tromey's avatar
Tom Tromey committed
824 825 826 827 828 829
	CASE (Bunbind):
	CASE (Bunbind1):
	CASE (Bunbind2):
	CASE (Bunbind3):
	CASE (Bunbind4):
	CASE (Bunbind5):
Jim Blandy's avatar
Jim Blandy committed
830 831
	  op -= Bunbind;
	dounbind:
Juanma Barranquero's avatar
Juanma Barranquero committed
832
	  unbind_to (SPECPDL_INDEX () - op, Qnil);
Tom Tromey's avatar
Tom Tromey committed
833
	  NEXT;
Jim Blandy's avatar
Jim Blandy committed
834

Tom Tromey's avatar
Tom Tromey committed
835
	CASE (Bunbind_all):	/* Obsolete.  Never used.  */
Jim Blandy's avatar
Jim Blandy committed
836
	  /* To unbind back to the beginning of this frame.  Not used yet,
837
	     but will be needed for tail-recursion elimination.  */
Jim Blandy's avatar
Jim Blandy committed
838
	  unbind_to (count, Qnil);
Tom Tromey's avatar
Tom Tromey committed
839
	  NEXT;
Jim Blandy's avatar
Jim Blandy committed
840

Tom Tromey's avatar
Tom Tromey committed
841
	CASE (Bgoto):
Paul Eggert's avatar
Paul Eggert committed
842
	  maybe_gc ();
Gerd Moellmann's avatar
Gerd Moellmann committed
843
	  BYTE_CODE_QUIT;
Jim Blandy's avatar
Jim Blandy committed
844
	  op = FETCH2;    /* pc = FETCH2 loses since FETCH2 contains pc++ */
845
	  CHECK_RANGE (op);
Gerd Moellmann's avatar
Gerd Moellmann committed
846
	  stack.pc = stack.byte_string_start + op;
Tom Tromey's avatar
Tom Tromey committed
847
	  NEXT;
Jim Blandy's avatar
Jim Blandy committed
848

Tom Tromey's avatar
Tom Tromey committed
849
	CASE (Bgotoifnonnil):
850 851
	  {
	    Lisp_Object v1;
Paul Eggert's avatar
Paul Eggert committed
852
	    maybe_gc ();
853 854 855 856 857 858 859 860
	    op = FETCH2;
	    v1 = POP;
	    if (!NILP (v1))
	      {
		BYTE_CODE_QUIT;
		CHECK_RANGE (op);
		stack.pc = stack.byte_string_start + op;
	      }
Tom Tromey's avatar
Tom Tromey committed
861
	    NEXT;
862
	  }
Jim Blandy's avatar
Jim Blandy committed
863

Tom Tromey's avatar
Tom Tromey committed
864
	CASE (Bgotoifnilelsepop):
Paul Eggert's avatar
Paul Eggert committed
865
	  maybe_gc ();
Jim Blandy's avatar
Jim Blandy committed
866
	  op = FETCH2;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
867
	  if (NILP (TOP))
Jim Blandy's avatar
Jim Blandy committed
868
	    {
Gerd Moellmann's avatar
Gerd Moellmann committed
869
	      BYTE_CODE_QUIT;
870
	      CHECK_RANGE (op);
Gerd Moellmann's avatar
Gerd Moellmann committed
871
	      stack.pc = stack.byte_string_start + op;
Jim Blandy's avatar
Jim Blandy committed
872
	    }
873
	  else DISCARD (1);
Tom Tromey's avatar
Tom Tromey committed
874
	  NEXT;
Jim Blandy's avatar
Jim Blandy committed
875

Tom Tromey's avatar
Tom Tromey committed
876
	CASE (Bgotoifnonnilelsepop):
Paul Eggert's avatar
Paul Eggert committed
877
	  maybe_gc ();
Jim Blandy's avatar
Jim Blandy committed
878
	  op = FETCH2;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
879
	  if (!NILP (TOP))
Jim Blandy's avatar
Jim Blandy committed
880
	    {
Gerd Moellmann's avatar
Gerd Moellmann committed
881
	      BYTE_CODE_QUIT;
882
	      CHECK_RANGE (op);
Gerd Moellmann's avatar
Gerd Moellmann committed
883
	      stack.pc = stack.byte_string_start + op;
Jim Blandy's avatar
Jim Blandy committed
884
	    }
885
	  else DISCARD (1);
Tom Tromey's avatar
Tom Tromey committed
886
	  NEXT;
887

Tom Tromey's avatar
Tom Tromey committed
888
	CASE (BRgoto):
Paul Eggert's avatar
Paul Eggert committed
889
	  maybe_gc ();
Gerd Moellmann's avatar
Gerd Moellmann committed
890
	  BYTE_CODE_QUIT;
Gerd Moellmann's avatar
Gerd Moellmann committed
891
	  stack.pc += (int) *stack.pc - 127;
Tom Tromey's avatar
Tom Tromey committed
892
	  NEXT;
893

Tom Tromey's avatar
Tom Tromey committed
894
	CASE (BRgotoifnil):
895 896
	  {
	    Lisp_Object v1;
Paul Eggert's avatar
Paul Eggert committed
897
	    maybe_gc ();
898 899 900 901 902 903 904
	    v1 = POP;
	    if (NILP (v1))
	      {
		BYTE_CODE_QUIT;
		stack.pc += (int) *stack.pc - 128;
	      }
	    stack.pc++;
Tom Tromey's avatar
Tom Tromey committed
905
	    NEXT;
906
	  }
907

Tom Tromey's avatar
Tom Tromey committed
908
	CASE (BRgotoifnonnil):
909 910
	  {
	    Lisp_Object v1;
Paul Eggert's avatar
Paul Eggert committed
911
	    maybe_gc ();
912 913 914 915 916 917 918
	    v1 = POP;
	    if (!NILP (v1))
	      {
		BYTE_CODE_QUIT;
		stack.pc += (int) *stack.pc - 128;
	      }
	    stack.pc++;
Tom Tromey's avatar
Tom Tromey committed
919
	    NEXT;
920
	  }
921

Tom Tromey's avatar
Tom Tromey committed
922
	CASE (BRgotoifnilelsepop):
Paul Eggert's avatar
Paul Eggert committed
923
	  maybe_gc ();
Gerd Moellmann's avatar
Gerd Moellmann committed
924
	  op = *stack.pc++;
925 926
	  if (NILP (TOP))
	    {
Gerd Moellmann's avatar
Gerd Moellmann committed
927
	      BYTE_CODE_QUIT;
Gerd Moellmann's avatar
Gerd Moellmann committed
928
	      stack.pc += op - 128;
929 930
	    }
	  else DISCARD (1);
Tom Tromey's avatar
Tom Tromey committed
931
	  NEXT;
932

Tom Tromey's avatar
Tom Tromey committed
933
	CASE (BRgotoifnonnilelsepop):
Paul Eggert's avatar
Paul Eggert committed
934
	  maybe_gc ();
Gerd Moellmann's avatar
Gerd Moellmann committed
935
	  op = *stack.pc++;
936 937
	  if (!NILP (TOP))
	    {
Gerd Moellmann's avatar
Gerd Moellmann committed
938
	      BYTE_CODE_QUIT;
Gerd Moellmann's avatar
Gerd Moellmann committed
939
	      stack.pc += op - 128;
940 941
	    }
	  else DISCARD (1);
Tom Tromey's avatar
Tom Tromey committed
942
	  NEXT;
Jim Blandy's avatar
Jim Blandy committed
943

Tom Tromey's avatar
Tom Tromey committed
944
	CASE (Breturn):
945
	  result = POP;
Jim Blandy's avatar
Jim Blandy committed
946 947
	  goto exit;

Tom Tromey's avatar
Tom Tromey committed
948
	CASE (Bdiscard):
949
	  DISCARD (1);
Tom Tromey's avatar
Tom Tromey committed
950
	  NEXT;
Jim Blandy's avatar
Jim Blandy committed
951

Tom Tromey's avatar
Tom Tromey committed
952
	CASE (Bconstant2):
Jim Blandy's avatar
Jim Blandy committed
953
	  PUSH (vectorp[FETCH2]);
Tom Tromey's avatar
Tom Tromey committed
954
	  NEXT;
Jim Blandy's avatar
Jim Blandy committed
955

Tom Tromey's avatar
Tom Tromey committed
956
	CASE (Bsave_excursion):
957 958
	  record_unwind_protect (save_excursion_restore,
				 save_excursion_save ());
Tom Tromey's avatar
Tom Tromey committed
959
	  NEXT;
Jim Blandy's avatar
Jim Blandy committed
960

Tom Tromey's avatar
Tom Tromey committed
961 962
	CASE (Bsave_current_buffer): /* Obsolete since ??.  */
	CASE (Bsave_current_buffer_1):
963
	  record_unwind_current_buffer ();
Tom Tromey's avatar
Tom Tromey committed
964
	  NEXT;
965

Tom Tromey's avatar
Tom Tromey committed
966
	CASE (Bsave_window_excursion): /* Obsolete since 24.1.  */
967
	  {
968 969
	    ptrdiff_t count1 = SPECPDL_INDEX ();
	    record_unwind_protect (restore_window_configuration,
970 971
				   Fcurrent_window_configuration (Qnil));
	    TOP = Fprogn (TOP);
972
	    unbind_to (count1, TOP);
Tom Tromey's avatar
Tom Tromey committed
973
	    NEXT;
974
	  }
Jim Blandy's avatar
Jim Blandy committed
975

Tom Tromey's avatar
Tom Tromey committed
976
	CASE (Bsave_restriction):
977 978
	  record_unwind_protect (save_restriction_restore,
				 save_restriction_save ());
Tom Tromey's avatar
Tom Tromey committed
979
	  NEXT;
Jim Blandy's avatar
Jim Blandy committed
980

981
	CASE (Bcatch):		/* Obsolete since 24.4.  */
982 983
	  {
	    Lisp_Object v1;
984
	    v1 = POP;
985
	    TOP = internal_catch (TOP, eval_sub, v1);
Tom Tromey's avatar
Tom Tromey committed
986
	    NEXT;
987
	  }
Jim Blandy's avatar
Jim Blandy committed
988

989 990 991 992
	CASE (Bpushcatch):	/* New in 24.4.  */
	  type = CATCHER;
	  goto pushhandler;
	CASE (Bpushconditioncase): /* New in 24.4.  */
993 994
	  type = CONDITION_CASE;
	pushhandler:
995
	  {
996 997
	    Lisp_Object tag = POP;
	    int dest = FETCH2;
998

999
	    struct handler *c = push_handler (tag, type);
1000 1001
	    c->bytecode_dest = dest;
	    c->bytecode_top = top;
1002