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

This file is part of GNU Emacs.

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

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
17
along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.  */
Jim Blandy's avatar
Jim Blandy committed
18

19
/*
20
hacked on by jwz@lucid.com 17-jun-91
Jim Blandy's avatar
Jim Blandy committed
21 22
  o  added a compile-time switch to turn on simple sanity checking;
  o  put back the obsolete byte-codes for error-detection;
23
  o  added a new instruction, unbind_all, which I will use for
Jim Blandy's avatar
Jim Blandy committed
24
     tail-recursion elimination;
25
  o  made temp_output_buffer_show be called with the right number
Jim Blandy's avatar
Jim Blandy committed
26 27 28 29 30
     of args;
  o  made the new bytecodes be called with args in the right order;
  o  added metering support.

by Hallvard:
31
  o  added relative jump instructions;
Jim Blandy's avatar
Jim Blandy committed
32 33 34
  o  all conditionals now only do QUIT if they jump.
 */

35
#include <config.h>
36
#include <setjmp.h>
Jim Blandy's avatar
Jim Blandy committed
37 38
#include "lisp.h"
#include "buffer.h"
39
#include "character.h"
Jim Blandy's avatar
Jim Blandy committed
40
#include "syntax.h"
Stefan Monnier's avatar
Stefan Monnier committed
41
#include "window.h"
Jim Blandy's avatar
Jim Blandy committed
42

43 44 45 46 47
#ifdef CHECK_FRAME_FONT
#include "frame.h"
#include "xterm.h"
#endif

48
/*
49
 * define BYTE_CODE_SAFE to enable some minor sanity checking (useful for
50 51
 * debugging the byte compiler...)
 *
52
 * define BYTE_CODE_METER to enable generation of a byte-op usage histogram.
Jim Blandy's avatar
Jim Blandy committed
53
 */
54
#define BYTE_CODE_SAFE 1
55
/* #define BYTE_CODE_METER */
Jim Blandy's avatar
Jim Blandy committed
56 57 58 59


#ifdef BYTE_CODE_METER

60
Lisp_Object Qbyte_code_meter;
61
#define METER_2(code1, code2) \
Jim Blandy's avatar
Jim Blandy committed
62 63 64
  XFASTINT (XVECTOR (XVECTOR (Vbyte_code_meter)->contents[(code1)]) \
	    ->contents[(code2)])

65 66
#define METER_1(code) METER_2 (0, (code))

67 68 69 70 71 72 73 74 75 76
#define METER_CODE(last_code, this_code)				\
{									\
  if (byte_metering_on)							\
    {									\
      if (METER_1 (this_code) < MOST_POSITIVE_FIXNUM)			\
        METER_1 (this_code)++;						\
      if (last_code							\
	  && METER_2 (last_code, this_code) < MOST_POSITIVE_FIXNUM)	\
        METER_2 (last_code, this_code)++;				\
    }									\
77
}
Jim Blandy's avatar
Jim Blandy committed
78

79
#else /* no BYTE_CODE_METER */
Jim Blandy's avatar
Jim Blandy committed
80

81
#define METER_CODE(last_code, this_code)
Richard M. Stallman's avatar
Richard M. Stallman committed
82

83
#endif /* no BYTE_CODE_METER */
Jim Blandy's avatar
Jim Blandy committed
84 85 86


Lisp_Object Qbytecode;
87
extern Lisp_Object Qand_optional, Qand_rest;
Jim Blandy's avatar
Jim Blandy committed
88 89 90

/*  Byte codes: */

91
#define Bstack_ref 0 /* Actually, Bstack_ref+0 is not implemented: use dup.  */
Jim Blandy's avatar
Jim Blandy committed
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
#define Bvarref 010
#define Bvarset 020
#define Bvarbind 030
#define Bcall 040
#define Bunbind 050

#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
117
#define Bsymbol_function 0113
Jim Blandy's avatar
Jim Blandy committed
118
#define Bset 0114
119
#define Bfset 0115
Jim Blandy's avatar
Jim Blandy committed
120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139
#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
140
/* Was Bmark in v17.  */
141
#define Bsave_current_buffer 0141 /* Obsolete.  */
Jim Blandy's avatar
Jim Blandy committed
142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157
#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 Bscan_buffer 0153 /* No longer generated as of v18 */
#define Beolp 0154
#define Beobp 0155
#define Bbolp 0156
#define Bbobp 0157
#define Bcurrent_buffer 0160
#define Bset_buffer 0161
Richard M. Stallman's avatar
Richard M. Stallman committed
158
#define Bsave_current_buffer_1 0162 /* Replacing Bsave_current_buffer.  */
159
#define Bread_char 0162 /* No longer generated as of v19 */
Jim Blandy's avatar
Jim Blandy committed
160
#define Bset_mark 0163 /* this loser is no longer generated as of v18 */
161
#define Binteractive_p 0164 /* Obsolete.  */
Jim Blandy's avatar
Jim Blandy committed
162 163 164 165 166 167 168 169 170 171 172

#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
173
#define Bend_of_line 0177
Jim Blandy's avatar
Jim Blandy committed
174 175 176 177 178 179 180 181 182 183 184 185

#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
186
#define Bsave_window_excursion 0213 /* Obsolete.  */
Jim Blandy's avatar
Jim Blandy committed
187 188 189 190 191
#define Bsave_restriction 0214
#define Bcatch 0215

#define Bunwind_protect 0216
#define Bcondition_case 0217
192 193
#define Btemp_output_buffer_setup 0220 /* Obsolete.  */
#define Btemp_output_buffer_show 0221  /* Obsolete.  */
Jim Blandy's avatar
Jim Blandy committed
194

195
#define Bunbind_all 0222	/* Obsolete.  */
Jim Blandy's avatar
Jim Blandy committed
196

197 198 199 200 201 202
#define Bset_marker 0223
#define Bmatch_beginning 0224
#define Bmatch_end 0225
#define Bupcase 0226
#define Bdowncase 0227

Jim Blandy's avatar
Jim Blandy committed
203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220
#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

221 222 223 224 225 226 227 228 229 230
#define BRgoto 0252
#define BRgotoifnil 0253
#define BRgotoifnonnil 0254
#define BRgotoifnilelsepop 0255
#define BRgotoifnonnilelsepop 0256

#define BlistN 0257
#define BconcatN 0260
#define BinsertN 0261

231 232 233 234 235
/* Bstack_ref is code 0.  */
#define Bstack_set  0262
#define Bstack_set2 0263
#define BdiscardN   0266

Jim Blandy's avatar
Jim Blandy committed
236 237
#define Bconstant 0300
#define CONSTANTLIM 0100
Gerd Moellmann's avatar
Gerd Moellmann committed
238

239 240
/* Whether to maintain a `top' and `bottom' field in the stack frame.  */
#define BYTE_MAINTAIN_TOP (BYTE_CODE_SAFE || BYTE_MARK_STACK)
241

Gerd Moellmann's avatar
Gerd Moellmann committed
242 243 244 245 246 247 248
/* 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.  */
249
  const unsigned char *pc;
Gerd Moellmann's avatar
Gerd Moellmann committed
250 251 252

  /* Top and bottom of stack.  The bottom points to an area of memory
     allocated with alloca in Fbyte_code.  */
253
#if BYTE_MAINTAIN_TOP
Gerd Moellmann's avatar
Gerd Moellmann committed
254
  Lisp_Object *top, *bottom;
255
#endif
Gerd Moellmann's avatar
Gerd Moellmann committed
256 257 258 259 260

  /* The string containing the byte-code, and its current address.
     Storing this here protects it from GC because mark_byte_stack
     marks it.  */
  Lisp_Object byte_string;
261
  const unsigned char *byte_string_start;
Gerd Moellmann's avatar
Gerd Moellmann committed
262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278

  /* The vector of constants used during byte-code execution.  Storing
     this here protects it from GC because mark_byte_stack marks it.  */
  Lisp_Object constants;

  /* 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
   processing byte-code, and it removed the entry again when it is
   done.  Signalling an error truncates the list analoguous to
   gcprolist.  */

struct byte_stack *byte_stack_list;

279

Gerd Moellmann's avatar
Gerd Moellmann committed
280 281
/* Mark objects on byte_stack_list.  Called during GC.  */

282
#if BYTE_MARK_STACK
Gerd Moellmann's avatar
Gerd Moellmann committed
283
void
284
mark_byte_stack (void)
Gerd Moellmann's avatar
Gerd Moellmann committed
285 286 287 288 289 290
{
  struct byte_stack *stack;
  Lisp_Object *obj;

  for (stack = byte_stack_list; stack; stack = stack->next)
    {
291 292 293 294 295 296 297
      /* If STACK->top is null here, this means there's an opcode in
	 Fbyte_code that wasn't expected to GC, but did.  To find out
	 which opcode this is, record the value of `stack', and walk
	 up the stack in a debugger, stopping in frames of Fbyte_code.
	 The culprit is found in the frame of Fbyte_code where the
	 address of its local variable `stack' is equal to the
	 recorded value of `stack' here.  */
Kenichi Handa's avatar
Kenichi Handa committed
298
      eassert (stack->top);
299

Gerd Moellmann's avatar
Gerd Moellmann committed
300
      for (obj = stack->bottom; obj <= stack->top; ++obj)
Kenichi Handa's avatar
Kenichi Handa committed
301
	mark_object (*obj);
302

Kenichi Handa's avatar
Kenichi Handa committed
303 304
      mark_object (stack->byte_string);
      mark_object (stack->constants);
Gerd Moellmann's avatar
Gerd Moellmann committed
305 306
    }
}
307
#endif
Gerd Moellmann's avatar
Gerd Moellmann committed
308

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

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

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

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

Gerd Moellmann's avatar
Gerd Moellmann committed
331
#define FETCH *stack.pc++
Jim Blandy's avatar
Jim Blandy committed
332

333 334
/* Fetch two bytes from the bytecode stream and make a 16-bit number
   out of them */
Jim Blandy's avatar
Jim Blandy committed
335 336 337

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

338 339 340 341
/* Push x onto the execution stack.  This used to be #define PUSH(x)
   (*++stackp = (x)) This oddity is necessary because Alliant can't be
   bothered to compile the preincrement operator properly, as of 4/91.
   -JimB */
Gerd Moellmann's avatar
Gerd Moellmann committed
342 343

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

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

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

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

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

/* Get the value which is at the top of the execution stack, but don't
   pop it. */

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

358
/* Actions that must be performed before and after calling a function
Gerd Moellmann's avatar
Gerd Moellmann committed
359
   that might GC.  */
Jim Blandy's avatar
Jim Blandy committed
360

361 362 363 364
#if !BYTE_MAINTAIN_TOP
#define BEFORE_POTENTIAL_GC()	((void)0)
#define AFTER_POTENTIAL_GC()	((void)0)
#else
Gerd Moellmann's avatar
Gerd Moellmann committed
365 366
#define BEFORE_POTENTIAL_GC()	stack.top = top
#define AFTER_POTENTIAL_GC()	stack.top = NULL
367
#endif
Jim Blandy's avatar
Jim Blandy committed
368

Richard M. Stallman's avatar
Richard M. Stallman committed
369 370 371
/* Garbage collect if we have consed enough since the last time.
   We do this at every branch, to avoid loops that never GC.  */

372 373 374 375 376 377 378 379
#define MAYBE_GC()					\
  if (consing_since_gc > gc_cons_threshold		\
      && consing_since_gc > gc_relative_threshold)	\
    {							\
      BEFORE_POTENTIAL_GC ();				\
      Fgarbage_collect ();				\
      AFTER_POTENTIAL_GC ();				\
    }							\
380 381
  else

382
/* Check for jumping out of range.  */
Gerd Moellmann's avatar
Gerd Moellmann committed
383 384 385

#ifdef BYTE_CODE_SAFE

386
#define CHECK_RANGE(ARG) \
387 388
  if (ARG >= bytestr_length) abort ()

389
#else /* not BYTE_CODE_SAFE */
Gerd Moellmann's avatar
Gerd Moellmann committed
390 391 392

#define CHECK_RANGE(ARG)

393
#endif /* not BYTE_CODE_SAFE */
Gerd Moellmann's avatar
Gerd Moellmann committed
394

Gerd Moellmann's avatar
Gerd Moellmann committed
395 396 397 398 399 400 401
/* 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))	\
      {							\
402
        Lisp_Object flag = Vquit_flag;			\
Gerd Moellmann's avatar
Gerd Moellmann committed
403 404
	Vquit_flag = Qnil;				\
        BEFORE_POTENTIAL_GC ();				\
405
	if (EQ (Vthrow_on_input, flag))			\
406
	  Fthrow (Vthrow_on_input, Qt);			\
Gerd Moellmann's avatar
Gerd Moellmann committed
407
	Fsignal (Qquit, Qnil);				\
408
	AFTER_POTENTIAL_GC ();				\
Gerd Moellmann's avatar
Gerd Moellmann committed
409
      }							\
410
    ELSE_PENDING_SIGNALS				\
Gerd Moellmann's avatar
Gerd Moellmann committed
411 412
  } while (0)

Gerd Moellmann's avatar
Gerd Moellmann committed
413

414
DEFUN ("byte-code", Fbyte_code, Sbyte_code, 3, MANY, 0,
415 416 417 418
       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.
419 420 421 422 423 424 425
If the third argument is incorrect, Emacs may crash.

If ARGS-TEMPLATE is specified, it is an argument list specification,
according to which any remaining arguments are pushed on the stack
before executing BYTESTR.

usage: (byte-code BYTESTR VECTOR MAXDEP &optional ARGS-TEMPLATE &rest ARGS) */)
Stefan Monnier's avatar
Stefan Monnier committed
426
     (int nargs, Lisp_Object *args)
427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442
{
  Lisp_Object args_tmpl = nargs >= 4 ? args[3] : Qnil;
  int pnargs = nargs >= 4 ? nargs - 4 : 0;
  Lisp_Object *pargs = nargs >= 4 ? args + 4 : 0;
  return exec_byte_code (args[0], args[1], args[2], args_tmpl, pnargs, pargs);
}

/* 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
443 444
exec_byte_code (Lisp_Object bytestr, Lisp_Object vector, Lisp_Object maxdepth,
		Lisp_Object args_template, int nargs, Lisp_Object *args)
Jim Blandy's avatar
Jim Blandy committed
445
{
Juanma Barranquero's avatar
Juanma Barranquero committed
446
  int count = SPECPDL_INDEX ();
Jim Blandy's avatar
Jim Blandy committed
447 448 449 450
#ifdef BYTE_CODE_METER
  int this_op = 0;
  int prev_op;
#endif
Gerd Moellmann's avatar
Gerd Moellmann committed
451
  int op;
452
  /* Lisp_Object v1, v2; */
453
  Lisp_Object *vectorp;
Jim Blandy's avatar
Jim Blandy committed
454
#ifdef BYTE_CODE_SAFE
Gerd Moellmann's avatar
Gerd Moellmann committed
455 456
  int const_length = XVECTOR (vector)->size;
  Lisp_Object *stacke;
Jim Blandy's avatar
Jim Blandy committed
457
#endif
458
  int bytestr_length;
Gerd Moellmann's avatar
Gerd Moellmann committed
459 460
  struct byte_stack stack;
  Lisp_Object *top;
461
  Lisp_Object result;
Jim Blandy's avatar
Jim Blandy committed
462

463
#if 0 /* CHECK_FRAME_FONT */
464 465 466 467 468 469 470 471 472
 {
   struct frame *f = SELECTED_FRAME ();
   if (FRAME_X_P (f)
       && FRAME_FONT (f)->direction != 0
       && FRAME_FONT (f)->direction != 1)
     abort ();
 }
#endif

473
  CHECK_STRING (bytestr);
Kim F. Storm's avatar
Kim F. Storm committed
474
  CHECK_VECTOR (vector);
475
  CHECK_NUMBER (maxdepth);
Jim Blandy's avatar
Jim Blandy committed
476

477 478 479 480 481
  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
482
       convert them back to the originally intended unibyte form.  */
483
    bytestr = Fstring_as_unibyte (bytestr);
484

485
  bytestr_length = SBYTES (bytestr);
486 487
  vectorp = XVECTOR (vector)->contents;

Gerd Moellmann's avatar
Gerd Moellmann committed
488
  stack.byte_string = bytestr;
489
  stack.pc = stack.byte_string_start = SDATA (bytestr);
Gerd Moellmann's avatar
Gerd Moellmann committed
490
  stack.constants = vector;
491
  top = (Lisp_Object *) alloca (XFASTINT (maxdepth)
Gerd Moellmann's avatar
Gerd Moellmann committed
492
                                         * sizeof (Lisp_Object));
493 494
#if BYTE_MAINTAIN_TOP
  stack.bottom = top;
Gerd Moellmann's avatar
Gerd Moellmann committed
495
  stack.top = NULL;
496 497
#endif
  top -= 1;
Gerd Moellmann's avatar
Gerd Moellmann committed
498 499
  stack.next = byte_stack_list;
  byte_stack_list = &stack;
Jim Blandy's avatar
Jim Blandy committed
500

Gerd Moellmann's avatar
Gerd Moellmann committed
501 502 503
#ifdef BYTE_CODE_SAFE
  stacke = stack.bottom - 1 + XFASTINT (maxdepth);
#endif
504

505 506 507 508 509 510 511 512 513 514 515
  if (! NILP (args_template))
    /* We should push some arguments on the stack.  */
    {
      Lisp_Object at;
      int pushed = 0, optional = 0;

      for (at = args_template; CONSP (at); at = XCDR (at))
	if (EQ (XCAR (at), Qand_optional))
	  optional = 1;
	else if (EQ (XCAR (at), Qand_rest))
	  {
516 517 518
	    PUSH (pushed < nargs
		  ? Flist (nargs - pushed, args)
		  : Qnil);
519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537
	    pushed = nargs;
	    at = Qnil;
	    break;
	  }
	else if (pushed < nargs)
	  {
	    PUSH (*args++);
	    pushed++;
	  }
	else if (optional)
	  PUSH (Qnil);
	else
	  break;

      if (pushed != nargs || !NILP (at))
	Fsignal (Qwrong_number_of_arguments,
		 Fcons (args_template, Fcons (make_number (nargs), Qnil)));
    }

Jim Blandy's avatar
Jim Blandy committed
538 539 540
  while (1)
    {
#ifdef BYTE_CODE_SAFE
541
      if (top > stacke)
542
	abort ();
Gerd Moellmann's avatar
Gerd Moellmann committed
543
      else if (top < stack.bottom - 1)
544
	abort ();
Jim Blandy's avatar
Jim Blandy committed
545 546 547 548 549 550 551
#endif

#ifdef BYTE_CODE_METER
      prev_op = this_op;
      this_op = op = FETCH;
      METER_CODE (prev_op, op);
#else
552
      op = FETCH;
Jim Blandy's avatar
Jim Blandy committed
553 554
#endif

555 556 557
      switch (op)
	{
	case Bvarref + 7:
Jim Blandy's avatar
Jim Blandy committed
558 559 560
	  op = FETCH2;
	  goto varref;

561 562 563
	case Bvarref:
	case Bvarref + 1:
	case Bvarref + 2:
564
	case Bvarref + 3:
565
	case Bvarref + 4:
566
	case Bvarref + 5:
Jim Blandy's avatar
Jim Blandy committed
567
	  op = op - Bvarref;
568 569 570 571 572 573
	  goto varref;

	/* This seems to be the most frequently executed byte-code
	   among the Bvarref's, so avoid a goto here.  */
	case Bvarref+6:
	  op = FETCH;
Jim Blandy's avatar
Jim Blandy committed
574
	varref:
575 576 577 578 579 580
	  {
	    Lisp_Object v1, v2;

	    v1 = vectorp[op];
	    if (SYMBOLP (v1))
	      {
581 582 583
		if (XSYMBOL (v1)->redirect != SYMBOL_PLAINVAL
		    || (v2 = SYMBOL_VAL (XSYMBOL (v1)),
			EQ (v2, Qunbound)))
584 585 586 587 588
		  {
		    BEFORE_POTENTIAL_GC ();
		    v2 = Fsymbol_value (v1);
		    AFTER_POTENTIAL_GC ();
		  }
589 590
	      }
	    else
591 592 593 594 595
	      {
		BEFORE_POTENTIAL_GC ();
		v2 = Fsymbol_value (v1);
		AFTER_POTENTIAL_GC ();
	      }
596 597 598 599 600
	    PUSH (v2);
	    break;
	  }

	case Bgotoifnil:
601 602 603 604 605 606 607 608 609 610 611 612 613
	  {
	    Lisp_Object v1;
	    MAYBE_GC ();
	    op = FETCH2;
	    v1 = POP;
	    if (NILP (v1))
	      {
		BYTE_CODE_QUIT;
		CHECK_RANGE (op);
		stack.pc = stack.byte_string_start + op;
	      }
	    break;
	  }
Jim Blandy's avatar
Jim Blandy committed
614

615 616 617 618
	case Bcar:
	  {
	    Lisp_Object v1;
	    v1 = TOP;
619
	    TOP = CAR (v1);
620 621 622 623 624 625 626 627 628 629 630 631 632 633
	    break;
	  }

	case Beq:
	  {
	    Lisp_Object v1;
	    v1 = POP;
	    TOP = EQ (v1, TOP) ? Qt : Qnil;
	    break;
	  }

	case Bmemq:
	  {
	    Lisp_Object v1;
634
	    BEFORE_POTENTIAL_GC ();
635 636
	    v1 = POP;
	    TOP = Fmemq (TOP, v1);
637
	    AFTER_POTENTIAL_GC ();
638 639 640 641 642 643 644
	    break;
	  }

	case Bcdr:
	  {
	    Lisp_Object v1;
	    v1 = TOP;
645
	    TOP = CDR (v1);
646 647
	    break;
	  }
Jim Blandy's avatar
Jim Blandy committed
648

649 650 651 652 653 654 655
	case Bvarset:
	case Bvarset+1:
	case Bvarset+2:
	case Bvarset+3:
	case Bvarset+4:
	case Bvarset+5:
	  op -= Bvarset;
Jim Blandy's avatar
Jim Blandy committed
656 657
	  goto varset;

658 659
	case Bvarset+7:
	  op = FETCH2;
660 661 662 663
	  goto varset;

	case Bvarset+6:
	  op = FETCH;
Jim Blandy's avatar
Jim Blandy committed
664
	varset:
665 666
	  {
	    Lisp_Object sym, val;
667

668
	    sym = vectorp[op];
669
	    val = TOP;
670 671 672 673

	    /* Inline the most common case.  */
	    if (SYMBOLP (sym)
		&& !EQ (val, Qunbound)
674 675 676
		&& !XSYMBOL (sym)->redirect
		&& !SYMBOL_CONSTANT_P (sym))
	      XSYMBOL (sym)->val.value = val;
677
	    else
678 679
	      {
		BEFORE_POTENTIAL_GC ();
680
		set_internal (sym, val, Qnil, 0);
681 682
		AFTER_POTENTIAL_GC ();
	      }
683
	  }
684
	  (void) POP;
Jim Blandy's avatar
Jim Blandy committed
685 686
	  break;

687 688 689 690 691 692 693 694 695 696
	case Bdup:
	  {
	    Lisp_Object v1;
	    v1 = TOP;
	    PUSH (v1);
	    break;
	  }

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

Jim Blandy's avatar
Jim Blandy committed
697 698 699 700 701 702 703 704
	case Bvarbind+6:
	  op = FETCH;
	  goto varbind;

	case Bvarbind+7:
	  op = FETCH2;
	  goto varbind;

705 706 707 708 709 710
	case Bvarbind:
	case Bvarbind+1:
	case Bvarbind+2:
	case Bvarbind+3:
	case Bvarbind+4:
	case Bvarbind+5:
Jim Blandy's avatar
Jim Blandy committed
711 712
	  op -= Bvarbind;
	varbind:
713 714
	  /* Specbind can signal and thus GC.  */
	  BEFORE_POTENTIAL_GC ();
Jim Blandy's avatar
Jim Blandy committed
715
	  specbind (vectorp[op], POP);
716
	  AFTER_POTENTIAL_GC ();
Jim Blandy's avatar
Jim Blandy committed
717 718 719 720 721 722 723 724 725 726
	  break;

	case Bcall+6:
	  op = FETCH;
	  goto docall;

	case Bcall+7:
	  op = FETCH2;
	  goto docall;

727 728 729 730 731 732
	case Bcall:
	case Bcall+1:
	case Bcall+2:
	case Bcall+3:
	case Bcall+4:
	case Bcall+5:
Jim Blandy's avatar
Jim Blandy committed
733 734
	  op -= Bcall;
	docall:
735
	  {
736
	    BEFORE_POTENTIAL_GC ();
737
	    DISCARD (op);
738
#ifdef BYTE_CODE_METER
739 740 741 742 743 744 745
	    if (byte_metering_on && SYMBOLP (TOP))
	      {
		Lisp_Object v1, v2;

		v1 = TOP;
		v2 = Fget (v1, Qbyte_code_meter);
		if (INTEGERP (v2)
746
		    && XINT (v2) < MOST_POSITIVE_FIXNUM)
747 748 749 750 751
		  {
		    XSETINT (v2, XINT (v2) + 1);
		    Fput (v1, Qbyte_code_meter, v2);
		  }
	      }
752
#endif
753 754 755 756
	    TOP = Ffuncall (op + 1, &TOP);
	    AFTER_POTENTIAL_GC ();
	    break;
	  }
Jim Blandy's avatar
Jim Blandy committed
757 758 759 760 761 762 763 764 765

	case Bunbind+6:
	  op = FETCH;
	  goto dounbind;

	case Bunbind+7:
	  op = FETCH2;
	  goto dounbind;

766 767 768 769 770 771
	case Bunbind:
	case Bunbind+1:
	case Bunbind+2:
	case Bunbind+3:
	case Bunbind+4:
	case Bunbind+5:
Jim Blandy's avatar
Jim Blandy committed
772 773
	  op -= Bunbind;
	dounbind:
Gerd Moellmann's avatar
Gerd Moellmann committed
774
	  BEFORE_POTENTIAL_GC ();
Juanma Barranquero's avatar
Juanma Barranquero committed
775
	  unbind_to (SPECPDL_INDEX () - op, Qnil);
Gerd Moellmann's avatar
Gerd Moellmann committed
776
	  AFTER_POTENTIAL_GC ();
Jim Blandy's avatar
Jim Blandy committed
777 778
	  break;

779
	case Bunbind_all:	/* Obsolete.  */
Jim Blandy's avatar
Jim Blandy committed
780
	  /* To unbind back to the beginning of this frame.  Not used yet,
781
	     but will be needed for tail-recursion elimination.  */
Gerd Moellmann's avatar
Gerd Moellmann committed
782
	  BEFORE_POTENTIAL_GC ();
Jim Blandy's avatar
Jim Blandy committed
783
	  unbind_to (count, Qnil);
Gerd Moellmann's avatar
Gerd Moellmann committed
784
	  AFTER_POTENTIAL_GC ();
Jim Blandy's avatar
Jim Blandy committed
785 786 787
	  break;

	case Bgoto:
Richard M. Stallman's avatar
Richard M. Stallman committed
788
	  MAYBE_GC ();
Gerd Moellmann's avatar
Gerd Moellmann committed
789
	  BYTE_CODE_QUIT;
Jim Blandy's avatar
Jim Blandy committed
790
	  op = FETCH2;    /* pc = FETCH2 loses since FETCH2 contains pc++ */
791
	  CHECK_RANGE (op);
Gerd Moellmann's avatar
Gerd Moellmann committed
792
	  stack.pc = stack.byte_string_start + op;
Jim Blandy's avatar
Jim Blandy committed
793 794 795
	  break;

	case Bgotoifnonnil:
796 797 798 799 800 801 802 803 804 805 806 807 808
	  {
	    Lisp_Object v1;
	    MAYBE_GC ();
	    op = FETCH2;
	    v1 = POP;
	    if (!NILP (v1))
	      {
		BYTE_CODE_QUIT;
		CHECK_RANGE (op);
		stack.pc = stack.byte_string_start + op;
	      }
	    break;
	  }
Jim Blandy's avatar
Jim Blandy committed
809 810

	case Bgotoifnilelsepop:
Richard M. Stallman's avatar
Richard M. Stallman committed
811
	  MAYBE_GC ();
Jim Blandy's avatar
Jim Blandy committed
812
	  op = FETCH2;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
813
	  if (NILP (TOP))
Jim Blandy's avatar
Jim Blandy committed
814
	    {
Gerd Moellmann's avatar
Gerd Moellmann committed
815
	      BYTE_CODE_QUIT;
816
	      CHECK_RANGE (op);
Gerd Moellmann's avatar
Gerd Moellmann committed
817
	      stack.pc = stack.byte_string_start + op;
Jim Blandy's avatar
Jim Blandy committed
818
	    }
819
	  else DISCARD (1);
Jim Blandy's avatar
Jim Blandy committed
820 821 822
	  break;

	case Bgotoifnonnilelsepop:
Richard M. Stallman's avatar
Richard M. Stallman committed
823
	  MAYBE_GC ();
Jim Blandy's avatar
Jim Blandy committed
824
	  op = FETCH2;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
825
	  if (!NILP (TOP))
Jim Blandy's avatar
Jim Blandy committed
826
	    {
Gerd Moellmann's avatar
Gerd Moellmann committed
827
	      BYTE_CODE_QUIT;
828
	      CHECK_RANGE (op);
Gerd Moellmann's avatar
Gerd Moellmann committed
829
	      stack.pc = stack.byte_string_start + op;
Jim Blandy's avatar
Jim Blandy committed
830
	    }
831 832 833 834
	  else DISCARD (1);
	  break;

	case BRgoto:
Richard M. Stallman's avatar
Richard M. Stallman committed
835
	  MAYBE_GC ();
Gerd Moellmann's avatar
Gerd Moellmann committed
836
	  BYTE_CODE_QUIT;
Gerd Moellmann's avatar
Gerd Moellmann committed
837
	  stack.pc += (int) *stack.pc - 127;
838 839 840
	  break;

	case BRgotoifnil:
841 842 843 844 845 846 847 848 849 850 851 852
	  {
	    Lisp_Object v1;
	    MAYBE_GC ();
	    v1 = POP;
	    if (NILP (v1))
	      {
		BYTE_CODE_QUIT;
		stack.pc += (int) *stack.pc - 128;
	      }
	    stack.pc++;
	    break;
	  }
853 854

	case BRgotoifnonnil:
855 856 857 858 859 860 861 862 863 864 865 866
	  {
	    Lisp_Object v1;
	    MAYBE_GC ();
	    v1 = POP;
	    if (!NILP (v1))
	      {
		BYTE_CODE_QUIT;
		stack.pc += (int) *stack.pc - 128;
	      }
	    stack.pc++;
	    break;
	  }
867 868

	case BRgotoifnilelsepop:
Richard M. Stallman's avatar
Richard M. Stallman committed
869
	  MAYBE_GC ();
Gerd Moellmann's avatar
Gerd Moellmann committed
870
	  op = *stack.pc++;
871 872
	  if (NILP (TOP))
	    {
Gerd Moellmann's avatar
Gerd Moellmann committed
873
	      BYTE_CODE_QUIT;
Gerd Moellmann's avatar
Gerd Moellmann committed
874
	      stack.pc += op - 128;
875 876 877 878 879
	    }
	  else DISCARD (1);
	  break;

	case BRgotoifnonnilelsepop:
Richard M. Stallman's avatar
Richard M. Stallman committed
880
	  MAYBE_GC ();
Gerd Moellmann's avatar
Gerd Moellmann committed
881
	  op = *stack.pc++;
882 883
	  if (!NILP (TOP))
	    {
Gerd Moellmann's avatar
Gerd Moellmann committed
884
	      BYTE_CODE_QUIT;
Gerd Moellmann's avatar
Gerd Moellmann committed
885
	      stack.pc += op - 128;
886 887
	    }
	  else DISCARD (1);
Jim Blandy's avatar
Jim Blandy committed
888 889
	  break;

Jim Blandy's avatar
Jim Blandy committed
890
	case Breturn:
891
	  result = POP;
Jim Blandy's avatar
Jim Blandy committed
892 893 894
	  goto exit;

	case Bdiscard:
895
	  DISCARD (1);
Jim Blandy's avatar
Jim Blandy committed
896 897 898 899 900 901 902
	  break;

	case Bconstant2:
	  PUSH (vectorp[FETCH2]);
	  break;

	case Bsave_excursion:
903 904
	  record_unwind_protect (save_excursion_restore,
				 save_excursion_save ());
Jim Blandy's avatar
Jim Blandy committed
905 906
	  break;

907
	case Bsave_current_buffer: /* Obsolete.  */
Richard M. Stallman's avatar
Richard M. Stallman committed
908
	case Bsave_current_buffer_1:
909
	  record_unwind_protect (set_buffer_if_live, Fcurrent_buffer ());
910 911
	  break;

912 913 914 915 916 917 918 919 920 921 922
	case Bsave_window_excursion: /* Obsolete.  */
	  {
	    register int count = SPECPDL_INDEX ();
	    record_unwind_protect (Fset_window_configuration,
				   Fcurrent_window_configuration (Qnil));
	    BEFORE_POTENTIAL_GC ();
	    TOP = Fprogn (TOP);
	    unbind_to (count, TOP);
	    AFTER_POTENTIAL_GC ();
	    break;
	  }
Jim Blandy's avatar
Jim Blandy committed
923 924

	case Bsave_restriction:
925 926
	  record_unwind_protect (save_restriction_restore,
				 save_restriction_save ());
Jim Blandy's avatar
Jim Blandy committed
927 928 929
	  break;

	case Bcatch:
930 931 932
	  {
	    Lisp_Object v1;
	    BEFORE_POTENTIAL_GC ();
933
	    v1 = POP;
934
	    TOP = internal_catch (TOP, eval_sub, v1); /* FIXME: lexbind */
935 936 937
	    AFTER_POTENTIAL_GC ();
	    break;
	  }
Jim Blandy's avatar
Jim Blandy committed
938 939

	case Bunwind_protect:
940
	  record_unwind_protect (Fprogn, POP); /* FIXME: lexbind */
Jim Blandy's avatar
Jim Blandy committed
941 942 943
	  break;

	case Bcondition_case:
944
	  {
945 946 947
	    Lisp_Object handlers, body;
	    handlers = POP;
	    body = POP;
948
	    BEFORE_POTENTIAL_GC ();
949
	    TOP = internal_lisp_condition_case (TOP, body, handlers); /* FIXME: lexbind */
950 951 952
	    AFTER_POTENTIAL_GC ();
	    break;
	  }
Jim Blandy's avatar
Jim Blandy committed
953

954
	case Btemp_output_buffer_setup: /* Obsolete.  */
955
	  BEFORE_POTENTIAL_GC ();
956
	  CHECK_STRING (TOP);
957
	  temp_output_buffer_setup (SSDATA (TOP));
958
	  AFTER_POTENTIAL_GC ();
Jim Blandy's avatar
Jim Blandy committed
959 960 961
	  TOP = Vstandard_output;
	  break;

962
	case Btemp_output_buffer_show: /* Obsolete.  */
963 964 965
	  {
	    Lisp_Object v1;
	    BEFORE_POTENTIAL_GC ();
966
	    v1 = POP;
967 968 969
	    temp_output_buffer_show (TOP);
	    TOP = v1;
	    /* pop binding of standard-output */
Juanma Barranquero's avatar
Juanma Barranquero committed
970
	    unbind_to (SPECPDL_INDEX () - 1, Qnil);
971 972 973
	    AFTER_POTENTIAL_GC ();
	    break;
	  }
Jim Blandy's avatar
Jim Blandy committed
974 975

	case Bnth:
976 977
	  {
	    Lisp_Object v1, v2;
978
	    BEFORE_POTENTIAL_GC ();
979 980
	    v1 = POP;
	    v2 = TOP;
981
	    CHECK_NUMBER (v2);
982
	    AFTER_POTENTIAL_GC ();
983 984
	    op = XINT (v2);
	    immediate_quit = 1;
985 986
	    while (--op >= 0 && CONSP (v1))
	      v1 = XCDR (v1);
987
	    immediate_quit = 0;
988
	    TOP = CAR (v1);
989 990
	    break;
	  }
Jim Blandy's avatar
Jim Blandy committed
991 992

	case Bsymbolp:
993
	  TOP = SYMBOLP (TOP) ? Qt : Qnil;
Jim Blandy's avatar
Jim Blandy committed
994 995 996 997 998 999 1000
	  break;

	case Bconsp:
	  TOP = CONSP (TOP) ? Qt : Qnil;
	  break;

	case Bstringp:
1001
	  TOP = STRINGP (TOP) ? Qt : Qnil;
Jim Blandy's avatar
Jim Blandy committed
1002 1003 1004
	  break;

	case Blistp:
Joseph Arceneaux's avatar
Joseph Arceneaux committed
1005
	  TOP = CONSP (TOP) || NILP (TOP) ? Qt : Qnil;
Jim Blandy's avatar
Jim Blandy committed
1006 1007 1008
	  break;

	case Bnot:
Joseph Arceneaux's avatar
Joseph Arceneaux committed
1009
	  TOP = NILP (TOP) ? Qt : Qnil;
Jim Blandy's avatar
Jim Blandy committed
1010 1011 1012
	  break;

	case Bcons:
1013 1014 1015 1016 1017 1018
	  {
	    Lisp_Object v1;
	    v1 = POP;
	    TOP = Fcons (TOP, v1);
	    break;
	  }
Jim Blandy's avatar
Jim Blandy committed
1019 1020 1021 1022 1023 1024

	case Blist1:
	  TOP = Fcons (TOP, Qnil);
	  break;

	case Blist2:
1025 1026 1027 1028 1029 1030
	  {
	    Lisp_Object v1;
	    v1 = POP;
	    TOP = Fcons (TOP, Fcons (v1, Qnil));
	    break;
	  }
Jim Blandy's avatar
Jim Blandy committed
1031 1032

	case Blist3:
1033
	  DISCARD (2);
Jim Blandy's avatar
Jim Blandy committed
1034 1035 1036 1037
	  TOP = Flist (3, &TOP);
	  break;

	case Blist4:
1038
	  DISCARD (3);
Jim Blandy's avatar
Jim Blandy committed
1039 1040 1041
	  TOP = Flist (4, &TOP);
	  break;

1042 1043 1044 1045 1046 1047
	case BlistN:
	  op = FETCH;
	  DISCARD (op - 1);
	  TOP = Flist (op, &TOP);
	  break;

Jim Blandy's avatar
Jim Blandy committed
1048
	case Blength:
1049
	  BEFORE_POTENTIAL_GC ();
Jim Blandy's avatar
Jim Blandy committed
1050
	  TOP = Flength (TOP);
1051
	  AFTER_POTENTIAL_GC ();
Jim Blandy's avatar
Jim Blandy committed
1052 1053 1054
	  break;

	case Baref:
1055 1056
	  {
	    Lisp_Object v1;
1057
	    BEFORE_POTENTIAL_GC ();
1058 1059
	    v1 = POP;
	    TOP = Faref (TOP, v1);
1060
	    AFTER_POTENTIAL_GC ();
1061 1062
	    break;
	  }
Jim Blandy's avatar
Jim Blandy committed
1063 1064

	case Baset:
1065 1066
	  {
	    Lisp_Object v1, v2;
1067
	    BEFORE_POTENTIAL_GC ();
1068 1069
	    v2 = POP; v1 = POP;
	    TOP = Faset (TOP, v1, v2);
1070
	    AFTER_POTENTIAL_GC ();
1071 1072
	    break;
	  }
Jim Blandy's avatar
Jim Blandy committed
1073 1074

	case Bsymbol_value:
1075
	  BEFORE_POTENTIAL_GC ();