bytecode.c 37.7 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 55
/* #define BYTE_CODE_SAFE */
/* #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
#endif /* BYTE_CODE_METER */
Jim Blandy's avatar
Jim Blandy committed
80 81 82 83 84 85


Lisp_Object Qbytecode;

/*  Byte codes: */

86
#define Bstack_ref 0 /* Actually, Bstack_ref+0 is not implemented: use dup.  */
Jim Blandy's avatar
Jim Blandy committed
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
#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
112
#define Bsymbol_function 0113
Jim Blandy's avatar
Jim Blandy committed
113
#define Bset 0114
114
#define Bfset 0115
Jim Blandy's avatar
Jim Blandy committed
115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134
#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
135
/* Was Bmark in v17.  */
136
#define Bsave_current_buffer 0141 /* Obsolete.  */
Jim Blandy's avatar
Jim Blandy committed
137 138 139 140 141 142 143 144 145
#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
146
#ifdef BYTE_CODE_SAFE
Stefan Monnier's avatar
Stefan Monnier committed
147
#define Bscan_buffer 0153 /* No longer generated as of v18.  */
148
#endif
Jim Blandy's avatar
Jim Blandy committed
149 150 151 152 153 154
#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
155
#define Bsave_current_buffer_1 0162 /* Replacing Bsave_current_buffer.  */
156
#if 0
157
#define Bread_char 0162 /* No longer generated as of v19 */
158 159
#endif
#ifdef BYTE_CODE_SAFE
Jim Blandy's avatar
Jim Blandy committed
160
#define Bset_mark 0163 /* this loser is no longer generated as of v18 */
161
#endif
162
#define Binteractive_p 0164 /* Obsolete since Emacs-24.1.  */
Jim Blandy's avatar
Jim Blandy committed
163 164 165 166 167 168 169 170 171 172 173

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

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

#define Bunwind_protect 0216
#define Bcondition_case 0217
193 194
#define Btemp_output_buffer_setup 0220 /* Obsolete since Emacs-24.1.  */
#define Btemp_output_buffer_show 0221  /* Obsolete since Emacs-24.1.  */
Jim Blandy's avatar
Jim Blandy committed
195

196
#define Bunbind_all 0222	/* Obsolete.  Never used.  */
Jim Blandy's avatar
Jim Blandy committed
197

198 199 200 201 202 203
#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
204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221
#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

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

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

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

Jim Blandy's avatar
Jim Blandy committed
237
#define Bconstant 0300
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
	  ptrdiff_t 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
#define MAYBE_GC()					\
373
 do {							\
374 375 376 377 378 379 380
  if (consing_since_gc > gc_cons_threshold		\
      && consing_since_gc > gc_relative_threshold)	\
    {							\
      BEFORE_POTENTIAL_GC ();				\
      Fgarbage_collect ();				\
      AFTER_POTENTIAL_GC ();				\
    }							\
381
 } while (0)
382

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

#ifdef BYTE_CODE_SAFE

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

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

#define CHECK_RANGE(ARG)

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

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

Gerd Moellmann's avatar
Gerd Moellmann committed
414

Jim Blandy's avatar
Jim Blandy committed
415
DEFUN ("byte-code", Fbyte_code, Sbyte_code, 3, 3, 0,
416 417 418 419 420
       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
421
  (Lisp_Object bytestr, Lisp_Object vector, Lisp_Object maxdepth)
422
{
423
  return exec_byte_code (bytestr, vector, maxdepth, Qnil, 0, NULL);
424 425 426 427 428 429 430 431 432 433 434
}

/* 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
435
exec_byte_code (Lisp_Object bytestr, Lisp_Object vector, Lisp_Object maxdepth,
436
		Lisp_Object args_template, ptrdiff_t nargs, Lisp_Object *args)
Jim Blandy's avatar
Jim Blandy committed
437
{
438
  ptrdiff_t count = SPECPDL_INDEX ();
Jim Blandy's avatar
Jim Blandy committed
439 440 441 442
#ifdef BYTE_CODE_METER
  int this_op = 0;
  int prev_op;
#endif
Gerd Moellmann's avatar
Gerd Moellmann committed
443
  int op;
444
  /* Lisp_Object v1, v2; */
445
  Lisp_Object *vectorp;
Jim Blandy's avatar
Jim Blandy committed
446
#ifdef BYTE_CODE_SAFE
447
  ptrdiff_t const_length;
Gerd Moellmann's avatar
Gerd Moellmann committed
448
  Lisp_Object *stacke;
449
  ptrdiff_t bytestr_length;
450
#endif
Gerd Moellmann's avatar
Gerd Moellmann committed
451 452
  struct byte_stack stack;
  Lisp_Object *top;
453
  Lisp_Object result;
Jim Blandy's avatar
Jim Blandy committed
454

455
#if 0 /* CHECK_FRAME_FONT */
456 457 458 459 460 461 462 463 464
 {
   struct frame *f = SELECTED_FRAME ();
   if (FRAME_X_P (f)
       && FRAME_FONT (f)->direction != 0
       && FRAME_FONT (f)->direction != 1)
     abort ();
 }
#endif

465
  CHECK_STRING (bytestr);
Kim F. Storm's avatar
Kim F. Storm committed
466
  CHECK_VECTOR (vector);
467
  CHECK_NATNUM (maxdepth);
Jim Blandy's avatar
Jim Blandy committed
468

469
#ifdef BYTE_CODE_SAFE
470
  const_length = ASIZE (vector);
471 472
#endif

473 474 475 476 477
  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
478
       convert them back to the originally intended unibyte form.  */
479
    bytestr = Fstring_as_unibyte (bytestr);
480

481
#ifdef BYTE_CODE_SAFE
482
  bytestr_length = SBYTES (bytestr);
483
#endif
484 485
  vectorp = XVECTOR (vector)->contents;

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

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

504
  if (INTEGERP (args_template))
505
    {
506
      EMACS_INT at = XINT (args_template);
507 508
      int rest = at & 128;
      int mandatory = at & 127;
509
      EMACS_INT nonrest = at >> 8;
510 511 512
      eassert (mandatory <= nonrest);
      if (nargs <= nonrest)
	{
513
	  EMACS_INT i;
514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531
	  for (i = 0 ; i < nargs; i++, args++)
	    PUSH (*args);
	  if (nargs < mandatory)
	    /* Too few arguments.  */
	    Fsignal (Qwrong_number_of_arguments,
		     Fcons (Fcons (make_number (mandatory),
				   rest ? Qand_rest : make_number (nonrest)),
			    Fcons (make_number (nargs), Qnil)));
	  else
	    {
	      for (; i < nonrest; i++)
		PUSH (Qnil);
	      if (rest)
		PUSH (Qnil);
	    }
	}
      else if (rest)
	{
532
	  ptrdiff_t i;
533 534 535 536 537 538
	  for (i = 0 ; i < nonrest; i++, args++)
	    PUSH (*args);
	  PUSH (Flist (nargs - nonrest, args));
	}
      else
	/* Too many arguments.  */
539
	Fsignal (Qwrong_number_of_arguments,
540 541 542 543 544 545 546 547
		 Fcons (Fcons (make_number (mandatory),
			       make_number (nonrest)),
			Fcons (make_number (nargs), Qnil)));
    }
  else if (! NILP (args_template))
    /* We should push some arguments on the stack.  */
    {
      error ("Unknown args template!");
548 549
    }

Jim Blandy's avatar
Jim Blandy committed
550 551 552
  while (1)
    {
#ifdef BYTE_CODE_SAFE
553
      if (top > stacke)
554
	abort ();
Gerd Moellmann's avatar
Gerd Moellmann committed
555
      else if (top < stack.bottom - 1)
556
	abort ();
Jim Blandy's avatar
Jim Blandy committed
557 558 559 560 561 562 563
#endif

#ifdef BYTE_CODE_METER
      prev_op = this_op;
      this_op = op = FETCH;
      METER_CODE (prev_op, op);
#else
564
      op = FETCH;
Jim Blandy's avatar
Jim Blandy committed
565 566
#endif

567 568 569
      switch (op)
	{
	case Bvarref + 7:
Jim Blandy's avatar
Jim Blandy committed
570 571 572
	  op = FETCH2;
	  goto varref;

573 574 575
	case Bvarref:
	case Bvarref + 1:
	case Bvarref + 2:
576
	case Bvarref + 3:
577
	case Bvarref + 4:
578
	case Bvarref + 5:
Jim Blandy's avatar
Jim Blandy committed
579
	  op = op - Bvarref;
580 581 582 583 584 585
	  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
586
	varref:
587 588 589 590 591 592
	  {
	    Lisp_Object v1, v2;

	    v1 = vectorp[op];
	    if (SYMBOLP (v1))
	      {
593 594 595
		if (XSYMBOL (v1)->redirect != SYMBOL_PLAINVAL
		    || (v2 = SYMBOL_VAL (XSYMBOL (v1)),
			EQ (v2, Qunbound)))
596 597 598 599 600
		  {
		    BEFORE_POTENTIAL_GC ();
		    v2 = Fsymbol_value (v1);
		    AFTER_POTENTIAL_GC ();
		  }
601 602
	      }
	    else
603 604 605 606 607
	      {
		BEFORE_POTENTIAL_GC ();
		v2 = Fsymbol_value (v1);
		AFTER_POTENTIAL_GC ();
	      }
608 609 610 611 612
	    PUSH (v2);
	    break;
	  }

	case Bgotoifnil:
613 614 615 616 617 618 619 620 621 622 623 624 625
	  {
	    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
626

627 628 629 630
	case Bcar:
	  {
	    Lisp_Object v1;
	    v1 = TOP;
631 632 633 634 635 636 637 638 639 640
	    if (CONSP (v1))
	      TOP = XCAR (v1);
	    else if (NILP (v1))
	      TOP = Qnil;
	    else
	      {
		BEFORE_POTENTIAL_GC ();
		wrong_type_argument (Qlistp, v1);
		AFTER_POTENTIAL_GC ();
	      }
641 642 643 644 645 646 647 648 649 650 651 652 653 654
	    break;
	  }

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

	case Bmemq:
	  {
	    Lisp_Object v1;
655
	    BEFORE_POTENTIAL_GC ();
656 657
	    v1 = POP;
	    TOP = Fmemq (TOP, v1);
658
	    AFTER_POTENTIAL_GC ();
659 660 661 662 663 664 665
	    break;
	  }

	case Bcdr:
	  {
	    Lisp_Object v1;
	    v1 = TOP;
666 667 668 669 670 671 672 673 674 675 676
	    if (CONSP (v1))
	      TOP = XCDR (v1);
	    else if (NILP (v1))
	      TOP = Qnil;
	    else
	      {
		BEFORE_POTENTIAL_GC ();
		wrong_type_argument (Qlistp, v1);
		AFTER_POTENTIAL_GC ();
	      }
	    break;
677 678
	    break;
	  }
Jim Blandy's avatar
Jim Blandy committed
679

680 681 682 683 684 685 686
	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
687 688
	  goto varset;

689 690
	case Bvarset+7:
	  op = FETCH2;
691 692 693 694
	  goto varset;

	case Bvarset+6:
	  op = FETCH;
Jim Blandy's avatar
Jim Blandy committed
695
	varset:
696 697
	  {
	    Lisp_Object sym, val;
698

699
	    sym = vectorp[op];
700
	    val = TOP;
701 702 703 704

	    /* Inline the most common case.  */
	    if (SYMBOLP (sym)
		&& !EQ (val, Qunbound)
705 706 707
		&& !XSYMBOL (sym)->redirect
		&& !SYMBOL_CONSTANT_P (sym))
	      XSYMBOL (sym)->val.value = val;
708
	    else
709 710
	      {
		BEFORE_POTENTIAL_GC ();
711
		set_internal (sym, val, Qnil, 0);
712 713
		AFTER_POTENTIAL_GC ();
	      }
714
	  }
715
	  (void) POP;
Jim Blandy's avatar
Jim Blandy committed
716 717
	  break;

718 719 720 721 722 723 724 725 726 727
	case Bdup:
	  {
	    Lisp_Object v1;
	    v1 = TOP;
	    PUSH (v1);
	    break;
	  }

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

Jim Blandy's avatar
Jim Blandy committed
728 729 730 731 732 733 734 735
	case Bvarbind+6:
	  op = FETCH;
	  goto varbind;

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

736 737 738 739 740 741
	case Bvarbind:
	case Bvarbind+1:
	case Bvarbind+2:
	case Bvarbind+3:
	case Bvarbind+4:
	case Bvarbind+5:
Jim Blandy's avatar
Jim Blandy committed
742 743
	  op -= Bvarbind;
	varbind:
744 745
	  /* Specbind can signal and thus GC.  */
	  BEFORE_POTENTIAL_GC ();
Jim Blandy's avatar
Jim Blandy committed
746
	  specbind (vectorp[op], POP);
747
	  AFTER_POTENTIAL_GC ();
Jim Blandy's avatar
Jim Blandy committed
748 749 750 751 752 753 754 755 756 757
	  break;

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

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

758 759 760 761 762 763
	case Bcall:
	case Bcall+1:
	case Bcall+2:
	case Bcall+3:
	case Bcall+4:
	case Bcall+5:
Jim Blandy's avatar
Jim Blandy committed
764 765
	  op -= Bcall;
	docall:
766
	  {
767
	    BEFORE_POTENTIAL_GC ();
768
	    DISCARD (op);
769
#ifdef BYTE_CODE_METER
770 771 772 773 774 775 776
	    if (byte_metering_on && SYMBOLP (TOP))
	      {
		Lisp_Object v1, v2;

		v1 = TOP;
		v2 = Fget (v1, Qbyte_code_meter);
		if (INTEGERP (v2)
777
		    && XINT (v2) < MOST_POSITIVE_FIXNUM)
778 779 780 781 782
		  {
		    XSETINT (v2, XINT (v2) + 1);
		    Fput (v1, Qbyte_code_meter, v2);
		  }
	      }
783
#endif
784 785 786 787
	    TOP = Ffuncall (op + 1, &TOP);
	    AFTER_POTENTIAL_GC ();
	    break;
	  }
Jim Blandy's avatar
Jim Blandy committed
788 789 790 791 792 793 794 795 796

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

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

797 798 799 800 801 802
	case Bunbind:
	case Bunbind+1:
	case Bunbind+2:
	case Bunbind+3:
	case Bunbind+4:
	case Bunbind+5:
Jim Blandy's avatar
Jim Blandy committed
803 804
	  op -= Bunbind;
	dounbind:
Gerd Moellmann's avatar
Gerd Moellmann committed
805
	  BEFORE_POTENTIAL_GC ();
Juanma Barranquero's avatar
Juanma Barranquero committed
806
	  unbind_to (SPECPDL_INDEX () - op, Qnil);
Gerd Moellmann's avatar
Gerd Moellmann committed
807
	  AFTER_POTENTIAL_GC ();
Jim Blandy's avatar
Jim Blandy committed
808 809
	  break;

810
	case Bunbind_all:	/* Obsolete.  Never used.  */
Jim Blandy's avatar
Jim Blandy committed
811
	  /* To unbind back to the beginning of this frame.  Not used yet,
812
	     but will be needed for tail-recursion elimination.  */
Gerd Moellmann's avatar
Gerd Moellmann committed
813
	  BEFORE_POTENTIAL_GC ();
Jim Blandy's avatar
Jim Blandy committed
814
	  unbind_to (count, Qnil);
Gerd Moellmann's avatar
Gerd Moellmann committed
815
	  AFTER_POTENTIAL_GC ();
Jim Blandy's avatar
Jim Blandy committed
816 817 818
	  break;

	case Bgoto:
Richard M. Stallman's avatar
Richard M. Stallman committed
819
	  MAYBE_GC ();
Gerd Moellmann's avatar
Gerd Moellmann committed
820
	  BYTE_CODE_QUIT;
Jim Blandy's avatar
Jim Blandy committed
821
	  op = FETCH2;    /* pc = FETCH2 loses since FETCH2 contains pc++ */
822
	  CHECK_RANGE (op);
Gerd Moellmann's avatar
Gerd Moellmann committed
823
	  stack.pc = stack.byte_string_start + op;
Jim Blandy's avatar
Jim Blandy committed
824 825 826
	  break;

	case Bgotoifnonnil:
827 828 829 830 831 832 833 834 835 836 837 838 839
	  {
	    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
840 841

	case Bgotoifnilelsepop:
Richard M. Stallman's avatar
Richard M. Stallman committed
842
	  MAYBE_GC ();
Jim Blandy's avatar
Jim Blandy committed
843
	  op = FETCH2;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
844
	  if (NILP (TOP))
Jim Blandy's avatar
Jim Blandy committed
845
	    {
Gerd Moellmann's avatar
Gerd Moellmann committed
846
	      BYTE_CODE_QUIT;
847
	      CHECK_RANGE (op);
Gerd Moellmann's avatar
Gerd Moellmann committed
848
	      stack.pc = stack.byte_string_start + op;
Jim Blandy's avatar
Jim Blandy committed
849
	    }
850
	  else DISCARD (1);
Jim Blandy's avatar
Jim Blandy committed
851 852 853
	  break;

	case Bgotoifnonnilelsepop:
Richard M. Stallman's avatar
Richard M. Stallman committed
854
	  MAYBE_GC ();
Jim Blandy's avatar
Jim Blandy committed
855
	  op = FETCH2;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
856
	  if (!NILP (TOP))
Jim Blandy's avatar
Jim Blandy committed
857
	    {
Gerd Moellmann's avatar
Gerd Moellmann committed
858
	      BYTE_CODE_QUIT;
859
	      CHECK_RANGE (op);
Gerd Moellmann's avatar
Gerd Moellmann committed
860
	      stack.pc = stack.byte_string_start + op;
Jim Blandy's avatar
Jim Blandy committed
861
	    }
862 863 864 865
	  else DISCARD (1);
	  break;

	case BRgoto:
Richard M. Stallman's avatar
Richard M. Stallman committed
866
	  MAYBE_GC ();
Gerd Moellmann's avatar
Gerd Moellmann committed
867
	  BYTE_CODE_QUIT;
Gerd Moellmann's avatar
Gerd Moellmann committed
868
	  stack.pc += (int) *stack.pc - 127;
869 870 871
	  break;

	case BRgotoifnil:
872 873 874 875 876 877 878 879 880 881 882 883
	  {
	    Lisp_Object v1;
	    MAYBE_GC ();
	    v1 = POP;
	    if (NILP (v1))
	      {
		BYTE_CODE_QUIT;
		stack.pc += (int) *stack.pc - 128;
	      }
	    stack.pc++;
	    break;
	  }
884 885

	case BRgotoifnonnil:
886 887 888 889 890 891 892 893 894 895 896 897
	  {
	    Lisp_Object v1;
	    MAYBE_GC ();
	    v1 = POP;
	    if (!NILP (v1))
	      {
		BYTE_CODE_QUIT;
		stack.pc += (int) *stack.pc - 128;
	      }
	    stack.pc++;
	    break;
	  }
898 899

	case BRgotoifnilelsepop:
Richard M. Stallman's avatar
Richard M. Stallman committed
900
	  MAYBE_GC ();
Gerd Moellmann's avatar
Gerd Moellmann committed
901
	  op = *stack.pc++;
902 903
	  if (NILP (TOP))
	    {
Gerd Moellmann's avatar
Gerd Moellmann committed
904
	      BYTE_CODE_QUIT;
Gerd Moellmann's avatar
Gerd Moellmann committed
905
	      stack.pc += op - 128;
906 907 908 909 910
	    }
	  else DISCARD (1);
	  break;

	case BRgotoifnonnilelsepop:
Richard M. Stallman's avatar
Richard M. Stallman committed
911
	  MAYBE_GC ();
Gerd Moellmann's avatar
Gerd Moellmann committed
912
	  op = *stack.pc++;
913 914
	  if (!NILP (TOP))
	    {
Gerd Moellmann's avatar
Gerd Moellmann committed
915
	      BYTE_CODE_QUIT;
Gerd Moellmann's avatar
Gerd Moellmann committed
916
	      stack.pc += op - 128;
917 918
	    }
	  else DISCARD (1);
Jim Blandy's avatar
Jim Blandy committed
919 920
	  break;

Jim Blandy's avatar
Jim Blandy committed
921
	case Breturn:
922
	  result = POP;
Jim Blandy's avatar
Jim Blandy committed
923 924 925
	  goto exit;

	case Bdiscard:
926
	  DISCARD (1);
Jim Blandy's avatar
Jim Blandy committed
927 928 929 930 931 932 933
	  break;

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

	case Bsave_excursion:
934 935
	  record_unwind_protect (save_excursion_restore,
				 save_excursion_save ());
Jim Blandy's avatar
Jim Blandy committed
936 937
	  break;

938
	case Bsave_current_buffer: /* Obsolete since ??.  */
Richard M. Stallman's avatar
Richard M. Stallman committed
939
	case Bsave_current_buffer_1:
940
	  record_unwind_protect (set_buffer_if_live, Fcurrent_buffer ());
941 942
	  break;

943
	case Bsave_window_excursion: /* Obsolete since 24.1.  */
944
	  {
945
	    register ptrdiff_t count1 = SPECPDL_INDEX ();
946 947 948 949
	    record_unwind_protect (Fset_window_configuration,
				   Fcurrent_window_configuration (Qnil));
	    BEFORE_POTENTIAL_GC ();
	    TOP = Fprogn (TOP);
950
	    unbind_to (count1, TOP);
951 952 953
	    AFTER_POTENTIAL_GC ();
	    break;
	  }
Jim Blandy's avatar
Jim Blandy committed
954 955

	case Bsave_restriction:
956 957
	  record_unwind_protect (save_restriction_restore,
				 save_restriction_save ());
Jim Blandy's avatar
Jim Blandy committed
958 959
	  break;

Stefan Monnier's avatar
Stefan Monnier committed
960
	case Bcatch:		/* FIXME: ill-suited for lexbind.  */
961 962 963
	  {
	    Lisp_Object v1;
	    BEFORE_POTENTIAL_GC ();
964
	    v1 = POP;
965
	    TOP = internal_catch (TOP, eval_sub, v1);
966 967 968
	    AFTER_POTENTIAL_GC ();
	    break;
	  }
Jim Blandy's avatar
Jim Blandy committed
969

Stefan Monnier's avatar
Stefan Monnier committed
970
	case Bunwind_protect:	/* FIXME: avoid closure for lexbind.  */
971
	  record_unwind_protect (Fprogn, POP);
Jim Blandy's avatar
Jim Blandy committed
972 973
	  break;

Stefan Monnier's avatar
Stefan Monnier committed
974
	case Bcondition_case:	/* FIXME: ill-suited for lexbind.  */
975
	  {
976 977 978
	    Lisp_Object handlers, body;
	    handlers = POP;
	    body = POP;
979
	    BEFORE_POTENTIAL_GC ();
980
	    TOP = internal_lisp_condition_case (TOP, body, handlers);
981 982 983
	    AFTER_POTENTIAL_GC ();
	    break;
	  }
Jim Blandy's avatar
Jim Blandy committed
984

985
	case Btemp_output_buffer_setup: /* Obsolete since 24.1.  */
986
	  BEFORE_POTENTIAL_GC ();
987
	  CHECK_STRING (TOP);
988
	  temp_output_buffer_setup (SSDATA (TOP));
989
	  AFTER_POTENTIAL_GC ();
Jim Blandy's avatar
Jim Blandy committed
990 991 992
	  TOP = Vstandard_output;
	  break;

993
	case Btemp_output_buffer_show: /* Obsolete since 24.1.  */
994 995 996
	  {
	    Lisp_Object v1;
	    BEFORE_POTENTIAL_GC ();
997
	    v1 = POP;
998 999 1000
	    temp_output_buffer_show (TOP);
	    TOP = v1;
	    /* pop binding of standard-output */
Juanma Barranquero's avatar
Juanma Barranquero committed
1001
	    unbind_to (SPECPDL_INDEX () - 1, Qnil);
1002 1003 1004
	    AFTER_POTENTIAL_GC ();
	    break;
	  }
Jim Blandy's avatar
Jim Blandy committed
1005 1006

	case Bnth:
1007 1008
	  {
	    Lisp_Object v1, v2;
1009
	    EMACS_INT n;
1010
	    BEFORE_POTENTIAL_GC ();
1011 1012
	    v1 = POP;
	    v2 = TOP;
1013
	    CHECK_NUMBER (v2);
1014
	    n = XINT (v2);
1015
	    immediate_quit = 1;
1016
	    while (--n >= 0 && CONSP (v1))
1017
	      v1 = XCDR (v1);
1018
	    immediate_quit = 0;
1019
	    TOP = CAR (v1);
1020
	    AFTER_POTENTIAL_GC ();
1021 1022
	    break;
	  }
Jim Blandy's avatar
Jim Blandy committed
1023 1024

	case Bsymbolp:
1025
	  TOP = SYMBOLP (TOP) ? Qt : Qnil;
Jim Blandy's avatar
Jim Blandy committed
1026 1027 1028 1029 1030 1031 1032
	  break;

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

	case Bstringp:
1033
	  TOP = STRINGP (TOP) ? Qt : Qnil;
Jim Blandy's avatar
Jim Blandy committed
1034 1035 1036
	  break;

	case Blistp:
Joseph Arceneaux's avatar
Joseph Arceneaux committed
1037
	  TOP = CONSP (TOP) || NILP (TOP) ? Qt : Qnil;
Jim Blandy's avatar
Jim Blandy committed
1038 1039 1040
	  break;

	case Bnot:
Joseph Arceneaux's avatar
Joseph Arceneaux committed
1041
	  TOP = NILP (TOP) ? Qt : Qnil;
Jim Blandy's avatar
Jim Blandy committed
1042 1043 1044
	  break;

	case Bcons: