bytecode.c 37.6 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


Lisp_Object Qbytecode;
83
extern Lisp_Object Qand_optional, Qand_rest;
Jim Blandy's avatar
Jim Blandy committed
84 85 86

/*  Byte codes: */

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

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

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

#define Bunwind_protect 0216
#define Bcondition_case 0217
194 195
#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
196

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

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

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

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

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

Jim Blandy's avatar
Jim Blandy committed
238
#define Bconstant 0300
Gerd Moellmann's avatar
Gerd Moellmann committed
239

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

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

  /* 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;
262
  const unsigned char *byte_string_start;
Gerd Moellmann's avatar
Gerd Moellmann committed
263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279

  /* 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;

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

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

  for (stack = byte_stack_list; stack; stack = stack->next)
    {
292 293 294 295 296 297 298
      /* 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
299
      eassert (stack->top);
300

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

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

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

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

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

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

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

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

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

339 340 341 342
/* 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
343 344

#define PUSH(x) (top++, *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 355 356 357
#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
358

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

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

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

373
#define MAYBE_GC()					\
374
 do {							\
375 376 377 378 379 380 381
  if (consing_since_gc > gc_cons_threshold		\
      && consing_since_gc > gc_relative_threshold)	\
    {							\
      BEFORE_POTENTIAL_GC ();				\
      Fgarbage_collect ();				\
      AFTER_POTENTIAL_GC ();				\
    }							\
382
 } while (0)
383

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

#ifdef BYTE_CODE_SAFE

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

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

#define CHECK_RANGE(ARG)

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

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

Gerd Moellmann's avatar
Gerd Moellmann committed
415

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

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

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

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

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

478
#ifdef BYTE_CODE_SAFE
479
  bytestr_length = SBYTES (bytestr);
480
#endif
481 482
  vectorp = XVECTOR (vector)->contents;

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

Gerd Moellmann's avatar
Gerd Moellmann committed
496 497 498
#ifdef BYTE_CODE_SAFE
  stacke = stack.bottom - 1 + XFASTINT (maxdepth);
#endif
499

500
  if (INTEGERP (args_template))
501
    {
502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534
      int at = XINT (args_template);
      int rest = at & 128;
      int mandatory = at & 127;
      int nonrest = at >> 8;
      eassert (mandatory <= nonrest);
      if (nargs <= nonrest)
	{
	  int i;
	  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)
	{
	  int i;
	  for (i = 0 ; i < nonrest; i++, args++)
	    PUSH (*args);
	  PUSH (Flist (nargs - nonrest, args));
	}
      else
	/* Too many arguments.  */
535
	Fsignal (Qwrong_number_of_arguments,
536 537 538 539 540 541 542 543
		 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!");
544 545
    }

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

#ifdef BYTE_CODE_METER
      prev_op = this_op;
      this_op = op = FETCH;
      METER_CODE (prev_op, op);
#else
560
      op = FETCH;
Jim Blandy's avatar
Jim Blandy committed
561 562
#endif

563 564 565
      switch (op)
	{
	case Bvarref + 7:
Jim Blandy's avatar
Jim Blandy committed
566 567 568
	  op = FETCH2;
	  goto varref;

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

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

	case Bgotoifnil:
609 610 611 612 613 614 615 616 617 618 619 620 621
	  {
	    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
622

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

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

	case Bmemq:
	  {
	    Lisp_Object v1;
651
	    BEFORE_POTENTIAL_GC ();
652 653
	    v1 = POP;
	    TOP = Fmemq (TOP, v1);
654
	    AFTER_POTENTIAL_GC ();
655 656 657 658 659 660 661
	    break;
	  }

	case Bcdr:
	  {
	    Lisp_Object v1;
	    v1 = TOP;
662 663 664 665 666 667 668 669 670 671 672
	    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;
673 674
	    break;
	  }
Jim Blandy's avatar
Jim Blandy committed
675

676 677 678 679 680 681 682
	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
683 684
	  goto varset;

685 686
	case Bvarset+7:
	  op = FETCH2;
687 688 689 690
	  goto varset;

	case Bvarset+6:
	  op = FETCH;
Jim Blandy's avatar
Jim Blandy committed
691
	varset:
692 693
	  {
	    Lisp_Object sym, val;
694

695
	    sym = vectorp[op];
696
	    val = TOP;
697 698 699 700

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

714 715 716 717 718 719 720 721 722 723
	case Bdup:
	  {
	    Lisp_Object v1;
	    v1 = TOP;
	    PUSH (v1);
	    break;
	  }

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

Jim Blandy's avatar
Jim Blandy committed
724 725 726 727 728 729 730 731
	case Bvarbind+6:
	  op = FETCH;
	  goto varbind;

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

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

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

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

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

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

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

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

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

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

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

	case Bgotoifnonnil:
823 824 825 826 827 828 829 830 831 832 833 834 835
	  {
	    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
836 837

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

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

	case BRgoto:
Richard M. Stallman's avatar
Richard M. Stallman committed
862
	  MAYBE_GC ();
Gerd Moellmann's avatar
Gerd Moellmann committed
863
	  BYTE_CODE_QUIT;
Gerd Moellmann's avatar
Gerd Moellmann committed
864
	  stack.pc += (int) *stack.pc - 127;
865 866 867
	  break;

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

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

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

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

Jim Blandy's avatar
Jim Blandy committed
917
	case Breturn:
918
	  result = POP;
Jim Blandy's avatar
Jim Blandy committed
919 920 921
	  goto exit;

	case Bdiscard:
922
	  DISCARD (1);
Jim Blandy's avatar
Jim Blandy committed
923 924 925 926 927 928 929
	  break;

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

	case Bsave_excursion:
930 931
	  record_unwind_protect (save_excursion_restore,
				 save_excursion_save ());
Jim Blandy's avatar
Jim Blandy committed
932 933
	  break;

934
	case Bsave_current_buffer: /* Obsolete since ??.  */
Richard M. Stallman's avatar
Richard M. Stallman committed
935
	case Bsave_current_buffer_1:
936
	  record_unwind_protect (set_buffer_if_live, Fcurrent_buffer ());
937 938
	  break;

939
	case Bsave_window_excursion: /* Obsolete since 24.1.  */
940 941 942 943 944 945 946 947 948 949
	  {
	    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
950 951

	case Bsave_restriction:
952 953
	  record_unwind_protect (save_restriction_restore,
				 save_restriction_save ());
Jim Blandy's avatar
Jim Blandy committed
954 955
	  break;

956
	case Bcatch:		/* FIXME: ill-suited for lexbind */
957 958 959
	  {
	    Lisp_Object v1;
	    BEFORE_POTENTIAL_GC ();
960
	    v1 = POP;
961
	    TOP = internal_catch (TOP, eval_sub, v1);
962 963 964
	    AFTER_POTENTIAL_GC ();
	    break;
	  }
Jim Blandy's avatar
Jim Blandy committed
965

966
	case Bunwind_protect:	/* FIXME: avoid closure for lexbind */
967
	  record_unwind_protect (Fprogn, POP);
Jim Blandy's avatar
Jim Blandy committed
968 969
	  break;

970
	case Bcondition_case:	/* FIXME: ill-suited for lexbind */
971
	  {
972 973 974
	    Lisp_Object handlers, body;
	    handlers = POP;
	    body = POP;
975
	    BEFORE_POTENTIAL_GC ();
976
	    TOP = internal_lisp_condition_case (TOP, body, handlers);
977 978 979
	    AFTER_POTENTIAL_GC ();
	    break;
	  }
Jim Blandy's avatar
Jim Blandy committed
980

981
	case Btemp_output_buffer_setup: /* Obsolete since 24.1.  */
982
	  BEFORE_POTENTIAL_GC ();
983
	  CHECK_STRING (TOP);
984
	  temp_output_buffer_setup (SSDATA (TOP));
985
	  AFTER_POTENTIAL_GC ();
Jim Blandy's avatar
Jim Blandy committed
986 987 988
	  TOP = Vstandard_output;
	  break;

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