bytecode.c 36.7 KB
Newer Older
Jim Blandy's avatar
Jim Blandy committed
1
/* Execution of byte code produced by bytecomp.el.
2
   Copyright (C) 1985, 1986, 1987, 1988, 1993, 2000, 2001, 2002, 2003, 2004,
Glenn Morris's avatar
Glenn Morris committed
3
                 2005, 2006, 2007, 2008, 2009, 2010 Free Software Foundation, Inc.
Jim Blandy's avatar
Jim Blandy committed
4 5 6

This file is part of GNU Emacs.

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

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

You should have received a copy of the GNU General Public License
18
along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.  */
Jim Blandy's avatar
Jim Blandy committed
19

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

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

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

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

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


#ifdef BYTE_CODE_METER

61
Lisp_Object Vbyte_code_meter, Qbyte_code_meter;
Jim Blandy's avatar
Jim Blandy committed
62 63
int byte_metering_on;

64
#define METER_2(code1, code2) \
Jim Blandy's avatar
Jim Blandy committed
65 66 67
  XFASTINT (XVECTOR (XVECTOR (Vbyte_code_meter)->contents[(code1)]) \
	    ->contents[(code2)])

68 69
#define METER_1(code) METER_2 (0, (code))

70 71 72 73 74 75 76 77 78 79
#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)++;				\
    }									\
80
}
Jim Blandy's avatar
Jim Blandy committed
81

82
#else /* no BYTE_CODE_METER */
Jim Blandy's avatar
Jim Blandy committed
83

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

86
#endif /* no BYTE_CODE_METER */
Jim Blandy's avatar
Jim Blandy committed
87 88 89


Lisp_Object Qbytecode;
90
extern Lisp_Object Qand_optional, Qand_rest;
Jim Blandy's avatar
Jim Blandy committed
91 92 93

/*  Byte codes: */

94
#define Bstack_ref 0
Jim Blandy's avatar
Jim Blandy committed
95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119
#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
120
#define Bsymbol_function 0113
Jim Blandy's avatar
Jim Blandy committed
121
#define Bset 0114
122
#define Bfset 0115
Jim Blandy's avatar
Jim Blandy committed
123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142
#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
143 144
/* Was Bmark in v17.  */
#define Bsave_current_buffer 0141
Jim Blandy's avatar
Jim Blandy committed
145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160
#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
161
#define Bsave_current_buffer_1 0162 /* Replacing Bsave_current_buffer.  */
162
#define Bread_char 0162 /* No longer generated as of v19 */
Jim Blandy's avatar
Jim Blandy committed
163 164 165 166 167 168 169 170 171 172 173 174 175
#define Bset_mark 0163 /* this loser is no longer generated as of v18 */
#define Binteractive_p 0164 /* Needed since interactive-p takes unevalled args */

#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
176
#define Bend_of_line 0177
Jim Blandy's avatar
Jim Blandy committed
177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199

#define Bconstant2 0201
#define Bgoto 0202
#define Bgotoifnil 0203
#define Bgotoifnonnil 0204
#define Bgotoifnilelsepop 0205
#define Bgotoifnonnilelsepop 0206
#define Breturn 0207
#define Bdiscard 0210
#define Bdup 0211

#define Bsave_excursion 0212
#define Bsave_window_excursion 0213
#define Bsave_restriction 0214
#define Bcatch 0215

#define Bunwind_protect 0216
#define Bcondition_case 0217
#define Btemp_output_buffer_setup 0220
#define Btemp_output_buffer_show 0221

#define Bunbind_all 0222

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

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

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

234 235 236 237 238 239 240
/* Bstack_ref is code 0.  */
#define Bstack_set  0262
#define Bstack_set2 0263
#define Bvec_ref    0264
#define Bvec_set    0265
#define BdiscardN   0266

Jim Blandy's avatar
Jim Blandy committed
241 242
#define Bconstant 0300
#define CONSTANTLIM 0100
Gerd Moellmann's avatar
Gerd Moellmann committed
243

244

Gerd Moellmann's avatar
Gerd Moellmann committed
245 246 247 248 249 250 251
/* 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.  */
252
  const unsigned char *pc;
Gerd Moellmann's avatar
Gerd Moellmann committed
253 254 255 256 257 258 259 260 261

  /* Top and bottom of stack.  The bottom points to an area of memory
     allocated with alloca in Fbyte_code.  */
  Lisp_Object *top, *bottom;

  /* 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 283 284 285 286 287 288 289 290
/* Mark objects on byte_stack_list.  Called during GC.  */

void
mark_byte_stack ()
{
  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 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 ()
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

Gerd Moellmann's avatar
Gerd Moellmann committed
361 362
#define BEFORE_POTENTIAL_GC()	stack.top = top
#define AFTER_POTENTIAL_GC()	stack.top = NULL
Jim Blandy's avatar
Jim Blandy committed
363

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

367 368 369 370 371 372 373 374
#define MAYBE_GC()					\
  if (consing_since_gc > gc_cons_threshold		\
      && consing_since_gc > gc_relative_threshold)	\
    {							\
      BEFORE_POTENTIAL_GC ();				\
      Fgarbage_collect ();				\
      AFTER_POTENTIAL_GC ();				\
    }							\
375 376
  else

377
/* Check for jumping out of range.  */
Gerd Moellmann's avatar
Gerd Moellmann committed
378 379 380

#ifdef BYTE_CODE_SAFE

381
#define CHECK_RANGE(ARG) \
382 383
  if (ARG >= bytestr_length) abort ()

384
#else /* not BYTE_CODE_SAFE */
Gerd Moellmann's avatar
Gerd Moellmann committed
385 386 387

#define CHECK_RANGE(ARG)

388
#endif /* not BYTE_CODE_SAFE */
Gerd Moellmann's avatar
Gerd Moellmann committed
389

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

Gerd Moellmann's avatar
Gerd Moellmann committed
408

409
DEFUN ("byte-code", Fbyte_code, Sbyte_code, 3, MANY, 0,
410 411 412 413
       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.
414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443
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) */)
     (nargs, args)
     int nargs;
     Lisp_Object *args;
{
  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
exec_byte_code (bytestr, vector, maxdepth, args_template, nargs, args)
     Lisp_Object bytestr, vector, maxdepth, args_template;
     int nargs;
     Lisp_Object *args;
Jim Blandy's avatar
Jim Blandy committed
444
{
Juanma Barranquero's avatar
Juanma Barranquero committed
445
  int count = SPECPDL_INDEX ();
Jim Blandy's avatar
Jim Blandy committed
446 447 448 449
#ifdef BYTE_CODE_METER
  int this_op = 0;
  int prev_op;
#endif
Gerd Moellmann's avatar
Gerd Moellmann committed
450
  int op;
451
  /* Lisp_Object v1, v2; */
452
  Lisp_Object *vectorp;
Jim Blandy's avatar
Jim Blandy committed
453
#ifdef BYTE_CODE_SAFE
Gerd Moellmann's avatar
Gerd Moellmann committed
454 455
  int const_length = XVECTOR (vector)->size;
  Lisp_Object *stacke;
Jim Blandy's avatar
Jim Blandy committed
456
#endif
457
  int bytestr_length;
Gerd Moellmann's avatar
Gerd Moellmann committed
458 459
  struct byte_stack stack;
  Lisp_Object *top;
460
  Lisp_Object result;
Jim Blandy's avatar
Jim Blandy committed
461

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

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

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

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

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

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

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
  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))
	  {
	    PUSH (Flist (nargs, args));
	    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
532 533 534
  while (1)
    {
#ifdef BYTE_CODE_SAFE
535
      if (top > stacke)
536
	abort ();
Gerd Moellmann's avatar
Gerd Moellmann committed
537
      else if (top < stack.bottom - 1)
538
	abort ();
Jim Blandy's avatar
Jim Blandy committed
539 540 541 542 543 544 545
#endif

#ifdef BYTE_CODE_METER
      prev_op = this_op;
      this_op = op = FETCH;
      METER_CODE (prev_op, op);
#else
546
      op = FETCH;
Jim Blandy's avatar
Jim Blandy committed
547 548
#endif

549 550 551
      switch (op)
	{
	case Bvarref + 7:
Jim Blandy's avatar
Jim Blandy committed
552 553 554
	  op = FETCH2;
	  goto varref;

555 556 557
	case Bvarref:
	case Bvarref + 1:
	case Bvarref + 2:
558
	case Bvarref + 3:
559
	case Bvarref + 4:
560
	case Bvarref + 5:
Jim Blandy's avatar
Jim Blandy committed
561
	  op = op - Bvarref;
562 563 564 565 566 567
	  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
568
	varref:
569 570 571 572 573 574
	  {
	    Lisp_Object v1, v2;

	    v1 = vectorp[op];
	    if (SYMBOLP (v1))
	      {
575 576 577
		if (XSYMBOL (v1)->redirect != SYMBOL_PLAINVAL
		    || (v2 = SYMBOL_VAL (XSYMBOL (v1)),
			EQ (v2, Qunbound)))
578 579 580 581 582
		  {
		    BEFORE_POTENTIAL_GC ();
		    v2 = Fsymbol_value (v1);
		    AFTER_POTENTIAL_GC ();
		  }
583 584
	      }
	    else
585 586 587 588 589
	      {
		BEFORE_POTENTIAL_GC ();
		v2 = Fsymbol_value (v1);
		AFTER_POTENTIAL_GC ();
	      }
590 591 592 593 594
	    PUSH (v2);
	    break;
	  }

	case Bgotoifnil:
595 596 597 598 599 600 601 602 603 604 605 606 607
	  {
	    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
608

609 610 611 612
	case Bcar:
	  {
	    Lisp_Object v1;
	    v1 = TOP;
613
	    TOP = CAR (v1);
614 615 616 617 618 619 620 621 622 623 624 625 626 627
	    break;
	  }

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

	case Bmemq:
	  {
	    Lisp_Object v1;
628
	    BEFORE_POTENTIAL_GC ();
629 630
	    v1 = POP;
	    TOP = Fmemq (TOP, v1);
631
	    AFTER_POTENTIAL_GC ();
632 633 634 635 636 637 638
	    break;
	  }

	case Bcdr:
	  {
	    Lisp_Object v1;
	    v1 = TOP;
639
	    TOP = CDR (v1);
640 641
	    break;
	  }
Jim Blandy's avatar
Jim Blandy committed
642

643 644 645 646 647 648 649
	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
650 651
	  goto varset;

652 653
	case Bvarset+7:
	  op = FETCH2;
654 655 656 657
	  goto varset;

	case Bvarset+6:
	  op = FETCH;
Jim Blandy's avatar
Jim Blandy committed
658
	varset:
659 660
	  {
	    Lisp_Object sym, val;
661

662
	    sym = vectorp[op];
663
	    val = TOP;
664 665 666 667

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

681 682 683 684 685 686 687 688 689 690
	case Bdup:
	  {
	    Lisp_Object v1;
	    v1 = TOP;
	    PUSH (v1);
	    break;
	  }

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

Jim Blandy's avatar
Jim Blandy committed
691 692 693 694 695 696 697 698
	case Bvarbind+6:
	  op = FETCH;
	  goto varbind;

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

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

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

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

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

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

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

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

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

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

	case Bgoto:
Richard M. Stallman's avatar
Richard M. Stallman committed
782
	  MAYBE_GC ();
Gerd Moellmann's avatar
Gerd Moellmann committed
783
	  BYTE_CODE_QUIT;
Jim Blandy's avatar
Jim Blandy committed
784
	  op = FETCH2;    /* pc = FETCH2 loses since FETCH2 contains pc++ */
785
	  CHECK_RANGE (op);
Gerd Moellmann's avatar
Gerd Moellmann committed
786
	  stack.pc = stack.byte_string_start + op;
Jim Blandy's avatar
Jim Blandy committed
787 788 789
	  break;

	case Bgotoifnonnil:
790 791 792 793 794 795 796 797 798 799 800 801 802
	  {
	    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
803 804

	case Bgotoifnilelsepop:
Richard M. Stallman's avatar
Richard M. Stallman committed
805
	  MAYBE_GC ();
Jim Blandy's avatar
Jim Blandy committed
806
	  op = FETCH2;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
807
	  if (NILP (TOP))
Jim Blandy's avatar
Jim Blandy committed
808
	    {
Gerd Moellmann's avatar
Gerd Moellmann committed
809
	      BYTE_CODE_QUIT;
810
	      CHECK_RANGE (op);
Gerd Moellmann's avatar
Gerd Moellmann committed
811
	      stack.pc = stack.byte_string_start + op;
Jim Blandy's avatar
Jim Blandy committed
812
	    }
813
	  else DISCARD (1);
Jim Blandy's avatar
Jim Blandy committed
814 815 816
	  break;

	case Bgotoifnonnilelsepop:
Richard M. Stallman's avatar
Richard M. Stallman committed
817
	  MAYBE_GC ();
Jim Blandy's avatar
Jim Blandy committed
818
	  op = FETCH2;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
819
	  if (!NILP (TOP))
Jim Blandy's avatar
Jim Blandy committed
820
	    {
Gerd Moellmann's avatar
Gerd Moellmann committed
821
	      BYTE_CODE_QUIT;
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 827 828
	  else DISCARD (1);
	  break;

	case BRgoto:
Richard M. Stallman's avatar
Richard M. Stallman committed
829
	  MAYBE_GC ();
Gerd Moellmann's avatar
Gerd Moellmann committed
830
	  BYTE_CODE_QUIT;
Gerd Moellmann's avatar
Gerd Moellmann committed
831
	  stack.pc += (int) *stack.pc - 127;
832 833 834
	  break;

	case BRgotoifnil:
835 836 837 838 839 840 841 842 843 844 845 846
	  {
	    Lisp_Object v1;
	    MAYBE_GC ();
	    v1 = POP;
	    if (NILP (v1))
	      {
		BYTE_CODE_QUIT;
		stack.pc += (int) *stack.pc - 128;
	      }
	    stack.pc++;
	    break;
	  }
847 848

	case BRgotoifnonnil:
849 850 851 852 853 854 855 856 857 858 859 860
	  {
	    Lisp_Object v1;
	    MAYBE_GC ();
	    v1 = POP;
	    if (!NILP (v1))
	      {
		BYTE_CODE_QUIT;
		stack.pc += (int) *stack.pc - 128;
	      }
	    stack.pc++;
	    break;
	  }
861 862

	case BRgotoifnilelsepop:
Richard M. Stallman's avatar
Richard M. Stallman committed
863
	  MAYBE_GC ();
Gerd Moellmann's avatar
Gerd Moellmann committed
864
	  op = *stack.pc++;
865 866
	  if (NILP (TOP))
	    {
Gerd Moellmann's avatar
Gerd Moellmann committed
867
	      BYTE_CODE_QUIT;
Gerd Moellmann's avatar
Gerd Moellmann committed
868
	      stack.pc += op - 128;
869 870 871 872 873
	    }
	  else DISCARD (1);
	  break;

	case BRgotoifnonnilelsepop:
Richard M. Stallman's avatar
Richard M. Stallman committed
874
	  MAYBE_GC ();
Gerd Moellmann's avatar
Gerd Moellmann committed
875
	  op = *stack.pc++;
876 877
	  if (!NILP (TOP))
	    {
Gerd Moellmann's avatar
Gerd Moellmann committed
878
	      BYTE_CODE_QUIT;
Gerd Moellmann's avatar
Gerd Moellmann committed
879
	      stack.pc += op - 128;
880 881
	    }
	  else DISCARD (1);
Jim Blandy's avatar
Jim Blandy committed
882 883
	  break;

Jim Blandy's avatar
Jim Blandy committed
884
	case Breturn:
885
	  result = POP;
Jim Blandy's avatar
Jim Blandy committed
886 887 888
	  goto exit;

	case Bdiscard:
889
	  DISCARD (1);
Jim Blandy's avatar
Jim Blandy committed
890 891 892 893 894 895 896
	  break;

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

	case Bsave_excursion:
897 898
	  record_unwind_protect (save_excursion_restore,
				 save_excursion_save ());
Jim Blandy's avatar
Jim Blandy committed
899 900
	  break;

901
	case Bsave_current_buffer:
Richard M. Stallman's avatar
Richard M. Stallman committed
902
	case Bsave_current_buffer_1:
903
	  record_unwind_protect (set_buffer_if_live, Fcurrent_buffer ());
904 905
	  break;

Jim Blandy's avatar
Jim Blandy committed
906
	case Bsave_window_excursion:
907
	  BEFORE_POTENTIAL_GC ();
Jim Blandy's avatar
Jim Blandy committed
908
	  TOP = Fsave_window_excursion (TOP);
909
	  AFTER_POTENTIAL_GC ();
Jim Blandy's avatar
Jim Blandy committed
910 911 912
	  break;

	case Bsave_restriction:
913 914
	  record_unwind_protect (save_restriction_restore,
				 save_restriction_save ());
Jim Blandy's avatar
Jim Blandy committed
915 916 917
	  break;

	case Bcatch:
918 919 920
	  {
	    Lisp_Object v1;
	    BEFORE_POTENTIAL_GC ();
921
	    v1 = POP;
922 923 924 925
	    TOP = internal_catch (TOP, Feval, v1);
	    AFTER_POTENTIAL_GC ();
	    break;
	  }
Jim Blandy's avatar
Jim Blandy committed
926 927

	case Bunwind_protect:
928
	  record_unwind_protect (Fprogn, POP);
Jim Blandy's avatar
Jim Blandy committed
929 930 931
	  break;

	case Bcondition_case:
932
	  {
933 934 935
	    Lisp_Object handlers, body;
	    handlers = POP;
	    body = POP;
936
	    BEFORE_POTENTIAL_GC ();
937
	    TOP = internal_lisp_condition_case (TOP, body, handlers);
938 939 940
	    AFTER_POTENTIAL_GC ();
	    break;
	  }
Jim Blandy's avatar
Jim Blandy committed
941 942

	case Btemp_output_buffer_setup:
943
	  BEFORE_POTENTIAL_GC ();
944
	  CHECK_STRING (TOP);
945
	  temp_output_buffer_setup (SDATA (TOP));
946
	  AFTER_POTENTIAL_GC ();
Jim Blandy's avatar
Jim Blandy committed
947 948 949 950
	  TOP = Vstandard_output;
	  break;

	case Btemp_output_buffer_show:
951 952 953
	  {
	    Lisp_Object v1;
	    BEFORE_POTENTIAL_GC ();
954
	    v1 = POP;
955 956 957
	    temp_output_buffer_show (TOP);
	    TOP = v1;
	    /* pop binding of standard-output */
Juanma Barranquero's avatar
Juanma Barranquero committed
958
	    unbind_to (SPECPDL_INDEX () - 1, Qnil);
959 960 961
	    AFTER_POTENTIAL_GC ();
	    break;
	  }
Jim Blandy's avatar
Jim Blandy committed
962 963

	case Bnth:
964 965
	  {
	    Lisp_Object v1, v2;
966
	    BEFORE_POTENTIAL_GC ();
967 968
	    v1 = POP;
	    v2 = TOP;
969
	    CHECK_NUMBER (v2);
970
	    AFTER_POTENTIAL_GC ();
971 972
	    op = XINT (v2);
	    immediate_quit = 1;
973 974
	    while (--op >= 0 && CONSP (v1))
	      v1 = XCDR (v1);
975
	    immediate_quit = 0;
976
	    TOP = CAR (v1);
977 978
	    break;
	  }
Jim Blandy's avatar
Jim Blandy committed
979 980

	case Bsymbolp:
981
	  TOP = SYMBOLP (TOP) ? Qt : Qnil;
Jim Blandy's avatar
Jim Blandy committed
982 983 984 985 986 987 988
	  break;

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

	case Bstringp:
989
	  TOP = STRINGP (TOP) ? Qt : Qnil;
Jim Blandy's avatar
Jim Blandy committed
990 991 992
	  break;

	case Blistp:
Joseph Arceneaux's avatar
Joseph Arceneaux committed
993
	  TOP = CONSP (TOP) || NILP (TOP) ? Qt : Qnil;
Jim Blandy's avatar
Jim Blandy committed
994 995 996
	  break;

	case Bnot:
Joseph Arceneaux's avatar
Joseph Arceneaux committed
997
	  TOP = NILP (TOP) ? Qt : Qnil;
Jim Blandy's avatar
Jim Blandy committed
998 999 1000
	  break;

	case Bcons:
1001 1002 1003 1004 1005 1006
	  {
	    Lisp_Object v1;
	    v1 = POP;
	    TOP = Fcons (TOP, v1);
	    break;
	  }
Jim Blandy's avatar
Jim Blandy committed
1007 1008 1009 1010 1011 1012

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

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

	case Blist3:
1021
	  DISCARD (2);
Jim Blandy's avatar
Jim Blandy committed
1022 1023 1024 1025
	  TOP = Flist (3, &TOP);
	  break;

	case Blist4:
1026
	  DISCARD (3);
Jim Blandy's avatar
Jim Blandy committed
1027 1028 1029
	  TOP = Flist (4, &TOP);
	  break;

1030 1031 1032 1033 1034 1035
	case BlistN:
	  op = FETCH;
	  DISCARD (op - 1);
	  TOP = Flist (op, &TOP);
	  break;

Jim Blandy's avatar
Jim Blandy committed
1036
	case Blength:
1037
	  BEFORE_POTENTIAL_GC ();
Jim Blandy's avatar
Jim Blandy committed
1038
	  TOP = Flength (TOP);
1039
	  AFTER_POTENTIAL_GC ();
Jim Blandy's avatar
Jim Blandy committed
1040 1041 1042
	  break;

	case Baref:
1043 1044
	  {
	    Lisp_Object v1;
1045
	    BEFORE_POTENTIAL_GC ();<