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

This file is part of GNU Emacs.

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

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

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

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

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

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

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

48
/*
49
 * define BYTE_CODE_SAFE to enable some minor sanity checking (useful for
50 51
 * debugging the byte compiler...)
 *
52
 * define BYTE_CODE_METER to enable generation of a byte-op usage histogram.
Jim Blandy's avatar
Jim Blandy committed
53
 */
54 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
#else /* no BYTE_CODE_METER */
Jim Blandy's avatar
Jim Blandy committed
80

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

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

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

/*  Byte codes: */

91
#define Bstack_ref 0
Jim Blandy's avatar
Jim Blandy committed
92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116
#define Bvarref 010
#define Bvarset 020
#define Bvarbind 030
#define Bcall 040
#define Bunbind 050

#define Bnth 070
#define Bsymbolp 071
#define Bconsp 072
#define Bstringp 073
#define Blistp 074
#define Beq 075
#define Bmemq 076
#define Bnot 077
#define Bcar 0100
#define Bcdr 0101
#define Bcons 0102
#define Blist1 0103
#define Blist2 0104
#define Blist3 0105
#define Blist4 0106
#define Blength 0107
#define Baref 0110
#define Baset 0111
#define Bsymbol_value 0112
117
#define Bsymbol_function 0113
Jim Blandy's avatar
Jim Blandy committed
118
#define Bset 0114
119
#define Bfset 0115
Jim Blandy's avatar
Jim Blandy committed
120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139
#define Bget 0116
#define Bsubstring 0117
#define Bconcat2 0120
#define Bconcat3 0121
#define Bconcat4 0122
#define Bsub1 0123
#define Badd1 0124
#define Beqlsign 0125
#define Bgtr 0126
#define Blss 0127
#define Bleq 0130
#define Bgeq 0131
#define Bdiff 0132
#define Bnegate 0133
#define Bplus 0134
#define Bmax 0135
#define Bmin 0136
#define Bmult 0137

#define Bpoint 0140
140 141
/* Was Bmark in v17.  */
#define Bsave_current_buffer 0141
Jim Blandy's avatar
Jim Blandy committed
142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157
#define Bgoto_char 0142
#define Binsert 0143
#define Bpoint_max 0144
#define Bpoint_min 0145
#define Bchar_after 0146
#define Bfollowing_char 0147
#define Bpreceding_char 0150
#define Bcurrent_column 0151
#define Bindent_to 0152
#define Bscan_buffer 0153 /* No longer generated as of v18 */
#define Beolp 0154
#define Beobp 0155
#define Bbolp 0156
#define Bbobp 0157
#define Bcurrent_buffer 0160
#define Bset_buffer 0161
Richard M. Stallman's avatar
Richard M. Stallman committed
158
#define Bsave_current_buffer_1 0162 /* Replacing Bsave_current_buffer.  */
159
#define Bread_char 0162 /* No longer generated as of v19 */
Jim Blandy's avatar
Jim Blandy committed
160 161 162 163 164 165 166 167 168 169 170 171 172
#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
173
#define Bend_of_line 0177
Jim Blandy's avatar
Jim Blandy committed
174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196

#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

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

Jim Blandy's avatar
Jim Blandy committed
203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220
#define Bstringeqlsign 0230
#define Bstringlss 0231
#define Bequal 0232
#define Bnthcdr 0233
#define Belt 0234
#define Bmember 0235
#define Bassq 0236
#define Bnreverse 0237
#define Bsetcar 0240
#define Bsetcdr 0241
#define Bcar_safe 0242
#define Bcdr_safe 0243
#define Bnconc 0244
#define Bquo 0245
#define Brem 0246
#define Bnumberp 0247
#define Bintegerp 0250

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

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

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

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

239

Gerd Moellmann's avatar
Gerd Moellmann committed
240 241 242 243 244 245 246
/* 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.  */
247
  const unsigned char *pc;
Gerd Moellmann's avatar
Gerd Moellmann committed
248 249 250 251 252 253 254 255 256

  /* 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;
257
  const unsigned char *byte_string_start;
Gerd Moellmann's avatar
Gerd Moellmann committed
258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274

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

275

Gerd Moellmann's avatar
Gerd Moellmann committed
276 277 278
/* Mark objects on byte_stack_list.  Called during GC.  */

void
279
mark_byte_stack (void)
Gerd Moellmann's avatar
Gerd Moellmann committed
280 281 282 283 284 285
{
  struct byte_stack *stack;
  Lisp_Object *obj;

  for (stack = byte_stack_list; stack; stack = stack->next)
    {
286 287 288 289 290 291 292
      /* 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
293
      eassert (stack->top);
294

Gerd Moellmann's avatar
Gerd Moellmann committed
295
      for (obj = stack->bottom; obj <= stack->top; ++obj)
Kenichi Handa's avatar
Kenichi Handa committed
296
	mark_object (*obj);
297

Kenichi Handa's avatar
Kenichi Handa committed
298 299
      mark_object (stack->byte_string);
      mark_object (stack->constants);
Gerd Moellmann's avatar
Gerd Moellmann committed
300 301 302 303
    }
}


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

307
void
308
unmark_byte_stack (void)
Gerd Moellmann's avatar
Gerd Moellmann committed
309 310 311 312
{
  struct byte_stack *stack;

  for (stack = byte_stack_list; stack; stack = stack->next)
313
    {
314
      if (stack->byte_string_start != SDATA (stack->byte_string))
315 316
	{
	  int offset = stack->pc - stack->byte_string_start;
317
	  stack->byte_string_start = SDATA (stack->byte_string);
318 319 320
	  stack->pc = stack->byte_string_start + offset;
	}
    }
Gerd Moellmann's avatar
Gerd Moellmann committed
321 322
}

Jim Blandy's avatar
Jim Blandy committed
323 324 325

/* Fetch the next byte from the bytecode stream */

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

328 329
/* Fetch two bytes from the bytecode stream and make a 16-bit number
   out of them */
Jim Blandy's avatar
Jim Blandy committed
330 331 332

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

333 334 335 336
/* 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
337 338

#define PUSH(x) (top++, *top = (x))
Jim Blandy's avatar
Jim Blandy committed
339 340 341

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

Gerd Moellmann's avatar
Gerd Moellmann committed
342
#define POP (*top--)
Jim Blandy's avatar
Jim Blandy committed
343 344 345

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

Gerd Moellmann's avatar
Gerd Moellmann committed
346 347 348 349 350 351
#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
352

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

Gerd Moellmann's avatar
Gerd Moellmann committed
356 357
#define BEFORE_POTENTIAL_GC()	stack.top = top
#define AFTER_POTENTIAL_GC()	stack.top = NULL
Jim Blandy's avatar
Jim Blandy committed
358

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

362 363 364 365 366 367 368 369
#define MAYBE_GC()					\
  if (consing_since_gc > gc_cons_threshold		\
      && consing_since_gc > gc_relative_threshold)	\
    {							\
      BEFORE_POTENTIAL_GC ();				\
      Fgarbage_collect ();				\
      AFTER_POTENTIAL_GC ();				\
    }							\
370 371
  else

372
/* Check for jumping out of range.  */
Gerd Moellmann's avatar
Gerd Moellmann committed
373 374 375

#ifdef BYTE_CODE_SAFE

376
#define CHECK_RANGE(ARG) \
377 378
  if (ARG >= bytestr_length) abort ()

379
#else /* not BYTE_CODE_SAFE */
Gerd Moellmann's avatar
Gerd Moellmann committed
380 381 382

#define CHECK_RANGE(ARG)

383
#endif /* not BYTE_CODE_SAFE */
Gerd Moellmann's avatar
Gerd Moellmann committed
384

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

Gerd Moellmann's avatar
Gerd Moellmann committed
403

404
DEFUN ("byte-code", Fbyte_code, Sbyte_code, 3, MANY, 0,
405 406 407 408
       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.
409 410 411 412 413 414 415
If the third argument is incorrect, Emacs may crash.

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

usage: (byte-code BYTESTR VECTOR MAXDEP &optional ARGS-TEMPLATE &rest ARGS) */)
Stefan Monnier's avatar
Stefan Monnier committed
416
     (int nargs, Lisp_Object *args)
417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432
{
  Lisp_Object args_tmpl = nargs >= 4 ? args[3] : Qnil;
  int pnargs = nargs >= 4 ? nargs - 4 : 0;
  Lisp_Object *pargs = nargs >= 4 ? args + 4 : 0;
  return exec_byte_code (args[0], args[1], args[2], args_tmpl, pnargs, pargs);
}

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

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

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

463
  CHECK_STRING (bytestr);
Kim F. Storm's avatar
Kim F. Storm committed
464
  CHECK_VECTOR (vector);
465
  CHECK_NUMBER (maxdepth);
Jim Blandy's avatar
Jim Blandy committed
466

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

475
  bytestr_length = SBYTES (bytestr);
476 477
  vectorp = XVECTOR (vector)->contents;

Gerd Moellmann's avatar
Gerd Moellmann committed
478
  stack.byte_string = bytestr;
479
  stack.pc = stack.byte_string_start = SDATA (bytestr);
Gerd Moellmann's avatar
Gerd Moellmann committed
480
  stack.constants = vector;
481
  stack.bottom = (Lisp_Object *) alloca (XFASTINT (maxdepth)
Gerd Moellmann's avatar
Gerd Moellmann committed
482 483 484 485 486
                                         * 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
487

Gerd Moellmann's avatar
Gerd Moellmann committed
488 489 490
#ifdef BYTE_CODE_SAFE
  stacke = stack.bottom - 1 + XFASTINT (maxdepth);
#endif
491

492 493 494 495 496 497 498 499 500 501 502
  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))
	  {
503 504 505
	    PUSH (pushed < nargs
		  ? Flist (nargs - pushed, args)
		  : Qnil);
506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524
	    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
525 526 527
  while (1)
    {
#ifdef BYTE_CODE_SAFE
528
      if (top > stacke)
529
	abort ();
Gerd Moellmann's avatar
Gerd Moellmann committed
530
      else if (top < stack.bottom - 1)
531
	abort ();
Jim Blandy's avatar
Jim Blandy committed
532 533 534 535 536 537 538
#endif

#ifdef BYTE_CODE_METER
      prev_op = this_op;
      this_op = op = FETCH;
      METER_CODE (prev_op, op);
#else
539
      op = FETCH;
Jim Blandy's avatar
Jim Blandy committed
540 541
#endif

542 543 544
      switch (op)
	{
	case Bvarref + 7:
Jim Blandy's avatar
Jim Blandy committed
545 546 547
	  op = FETCH2;
	  goto varref;

548 549 550
	case Bvarref:
	case Bvarref + 1:
	case Bvarref + 2:
551
	case Bvarref + 3:
552
	case Bvarref + 4:
553
	case Bvarref + 5:
Jim Blandy's avatar
Jim Blandy committed
554
	  op = op - Bvarref;
555 556 557 558 559 560
	  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
561
	varref:
562 563 564 565 566 567
	  {
	    Lisp_Object v1, v2;

	    v1 = vectorp[op];
	    if (SYMBOLP (v1))
	      {
568 569 570
		if (XSYMBOL (v1)->redirect != SYMBOL_PLAINVAL
		    || (v2 = SYMBOL_VAL (XSYMBOL (v1)),
			EQ (v2, Qunbound)))
571 572 573 574 575
		  {
		    BEFORE_POTENTIAL_GC ();
		    v2 = Fsymbol_value (v1);
		    AFTER_POTENTIAL_GC ();
		  }
576 577
	      }
	    else
578 579 580 581 582
	      {
		BEFORE_POTENTIAL_GC ();
		v2 = Fsymbol_value (v1);
		AFTER_POTENTIAL_GC ();
	      }
583 584 585 586 587
	    PUSH (v2);
	    break;
	  }

	case Bgotoifnil:
588 589 590 591 592 593 594 595 596 597 598 599 600
	  {
	    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
601

602 603 604 605
	case Bcar:
	  {
	    Lisp_Object v1;
	    v1 = TOP;
606
	    TOP = CAR (v1);
607 608 609 610 611 612 613 614 615 616 617 618 619 620
	    break;
	  }

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

	case Bmemq:
	  {
	    Lisp_Object v1;
621
	    BEFORE_POTENTIAL_GC ();
622 623
	    v1 = POP;
	    TOP = Fmemq (TOP, v1);
624
	    AFTER_POTENTIAL_GC ();
625 626 627 628 629 630 631
	    break;
	  }

	case Bcdr:
	  {
	    Lisp_Object v1;
	    v1 = TOP;
632
	    TOP = CDR (v1);
633 634
	    break;
	  }
Jim Blandy's avatar
Jim Blandy committed
635

636 637 638 639 640 641 642
	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
643 644
	  goto varset;

645 646
	case Bvarset+7:
	  op = FETCH2;
647 648 649 650
	  goto varset;

	case Bvarset+6:
	  op = FETCH;
Jim Blandy's avatar
Jim Blandy committed
651
	varset:
652 653
	  {
	    Lisp_Object sym, val;
654

655
	    sym = vectorp[op];
656
	    val = TOP;
657 658 659 660

	    /* Inline the most common case.  */
	    if (SYMBOLP (sym)
		&& !EQ (val, Qunbound)
661 662 663
		&& !XSYMBOL (sym)->redirect
		&& !SYMBOL_CONSTANT_P (sym))
	      XSYMBOL (sym)->val.value = val;
664
	    else
665 666
	      {
		BEFORE_POTENTIAL_GC ();
667
		set_internal (sym, val, Qnil, 0);
668 669
		AFTER_POTENTIAL_GC ();
	      }
670
	  }
671
	  (void) POP;
Jim Blandy's avatar
Jim Blandy committed
672 673
	  break;

674 675 676 677 678 679 680 681 682 683
	case Bdup:
	  {
	    Lisp_Object v1;
	    v1 = TOP;
	    PUSH (v1);
	    break;
	  }

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

Jim Blandy's avatar
Jim Blandy committed
684 685 686 687 688 689 690 691
	case Bvarbind+6:
	  op = FETCH;
	  goto varbind;

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

692 693 694 695 696 697
	case Bvarbind:
	case Bvarbind+1:
	case Bvarbind+2:
	case Bvarbind+3:
	case Bvarbind+4:
	case Bvarbind+5:
Jim Blandy's avatar
Jim Blandy committed
698 699
	  op -= Bvarbind;
	varbind:
700 701
	  /* Specbind can signal and thus GC.  */
	  BEFORE_POTENTIAL_GC ();
Jim Blandy's avatar
Jim Blandy committed
702
	  specbind (vectorp[op], POP);
703
	  AFTER_POTENTIAL_GC ();
Jim Blandy's avatar
Jim Blandy committed
704 705 706 707 708 709 710 711 712 713
	  break;

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

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

714 715 716 717 718 719
	case Bcall:
	case Bcall+1:
	case Bcall+2:
	case Bcall+3:
	case Bcall+4:
	case Bcall+5:
Jim Blandy's avatar
Jim Blandy committed
720 721
	  op -= Bcall;
	docall:
722
	  {
723
	    BEFORE_POTENTIAL_GC ();
724
	    DISCARD (op);
725
#ifdef BYTE_CODE_METER
726 727 728 729 730 731 732
	    if (byte_metering_on && SYMBOLP (TOP))
	      {
		Lisp_Object v1, v2;

		v1 = TOP;
		v2 = Fget (v1, Qbyte_code_meter);
		if (INTEGERP (v2)
733
		    && XINT (v2) < MOST_POSITIVE_FIXNUM)
734 735 736 737 738
		  {
		    XSETINT (v2, XINT (v2) + 1);
		    Fput (v1, Qbyte_code_meter, v2);
		  }
	      }
739
#endif
740 741 742 743
	    TOP = Ffuncall (op + 1, &TOP);
	    AFTER_POTENTIAL_GC ();
	    break;
	  }
Jim Blandy's avatar
Jim Blandy committed
744 745 746 747 748 749 750 751 752

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

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

753 754 755 756 757 758
	case Bunbind:
	case Bunbind+1:
	case Bunbind+2:
	case Bunbind+3:
	case Bunbind+4:
	case Bunbind+5:
Jim Blandy's avatar
Jim Blandy committed
759 760
	  op -= Bunbind;
	dounbind:
Gerd Moellmann's avatar
Gerd Moellmann committed
761
	  BEFORE_POTENTIAL_GC ();
Juanma Barranquero's avatar
Juanma Barranquero committed
762
	  unbind_to (SPECPDL_INDEX () - op, Qnil);
Gerd Moellmann's avatar
Gerd Moellmann committed
763
	  AFTER_POTENTIAL_GC ();
Jim Blandy's avatar
Jim Blandy committed
764 765 766 767
	  break;

	case Bunbind_all:
	  /* To unbind back to the beginning of this frame.  Not used yet,
768
	     but will be needed for tail-recursion elimination.  */
Gerd Moellmann's avatar
Gerd Moellmann committed
769
	  BEFORE_POTENTIAL_GC ();
Jim Blandy's avatar
Jim Blandy committed
770
	  unbind_to (count, Qnil);
Gerd Moellmann's avatar
Gerd Moellmann committed
771
	  AFTER_POTENTIAL_GC ();
Jim Blandy's avatar
Jim Blandy committed
772 773 774
	  break;

	case Bgoto:
Richard M. Stallman's avatar
Richard M. Stallman committed
775
	  MAYBE_GC ();
Gerd Moellmann's avatar
Gerd Moellmann committed
776
	  BYTE_CODE_QUIT;
Jim Blandy's avatar
Jim Blandy committed
777
	  op = FETCH2;    /* pc = FETCH2 loses since FETCH2 contains pc++ */
778
	  CHECK_RANGE (op);
Gerd Moellmann's avatar
Gerd Moellmann committed
779
	  stack.pc = stack.byte_string_start + op;
Jim Blandy's avatar
Jim Blandy committed
780 781 782
	  break;

	case Bgotoifnonnil:
783 784 785 786 787 788 789 790 791 792 793 794 795
	  {
	    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
796 797

	case Bgotoifnilelsepop:
Richard M. Stallman's avatar
Richard M. Stallman committed
798
	  MAYBE_GC ();
Jim Blandy's avatar
Jim Blandy committed
799
	  op = FETCH2;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
800
	  if (NILP (TOP))
Jim Blandy's avatar
Jim Blandy committed
801
	    {
Gerd Moellmann's avatar
Gerd Moellmann committed
802
	      BYTE_CODE_QUIT;
803
	      CHECK_RANGE (op);
Gerd Moellmann's avatar
Gerd Moellmann committed
804
	      stack.pc = stack.byte_string_start + op;
Jim Blandy's avatar
Jim Blandy committed
805
	    }
806
	  else DISCARD (1);
Jim Blandy's avatar
Jim Blandy committed
807 808 809
	  break;

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

	case BRgoto:
Richard M. Stallman's avatar
Richard M. Stallman committed
822
	  MAYBE_GC ();
Gerd Moellmann's avatar
Gerd Moellmann committed
823
	  BYTE_CODE_QUIT;
Gerd Moellmann's avatar
Gerd Moellmann committed
824
	  stack.pc += (int) *stack.pc - 127;
825 826 827
	  break;

	case BRgotoifnil:
828 829 830 831 832 833 834 835 836 837 838 839
	  {
	    Lisp_Object v1;
	    MAYBE_GC ();
	    v1 = POP;
	    if (NILP (v1))
	      {
		BYTE_CODE_QUIT;
		stack.pc += (int) *stack.pc - 128;
	      }
	    stack.pc++;
	    break;
	  }
840 841

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

	case BRgotoifnilelsepop:
Richard M. Stallman's avatar
Richard M. Stallman committed
856
	  MAYBE_GC ();
Gerd Moellmann's avatar
Gerd Moellmann committed
857
	  op = *stack.pc++;
858 859
	  if (NILP (TOP))
	    {
Gerd Moellmann's avatar
Gerd Moellmann committed
860
	      BYTE_CODE_QUIT;
Gerd Moellmann's avatar
Gerd Moellmann committed
861
	      stack.pc += op - 128;
862 863 864 865 866
	    }
	  else DISCARD (1);
	  break;

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

Jim Blandy's avatar
Jim Blandy committed
877
	case Breturn:
878
	  result = POP;
Jim Blandy's avatar
Jim Blandy committed
879 880 881
	  goto exit;

	case Bdiscard:
882
	  DISCARD (1);
Jim Blandy's avatar
Jim Blandy committed
883 884 885 886 887 888 889
	  break;

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

	case Bsave_excursion:
890 891
	  record_unwind_protect (save_excursion_restore,
				 save_excursion_save ());
Jim Blandy's avatar
Jim Blandy committed
892 893
	  break;

894
	case Bsave_current_buffer:
Richard M. Stallman's avatar
Richard M. Stallman committed
895
	case Bsave_current_buffer_1:
896
	  record_unwind_protect (set_buffer_if_live, Fcurrent_buffer ());
897 898
	  break;

Jim Blandy's avatar
Jim Blandy committed
899
	case Bsave_window_excursion:
900
	  BEFORE_POTENTIAL_GC ();
901
	  TOP = Fsave_window_excursion (TOP); /* FIXME: lexbind */
902
	  AFTER_POTENTIAL_GC ();
Jim Blandy's avatar
Jim Blandy committed
903 904 905
	  break;

	case Bsave_restriction:
906 907
	  record_unwind_protect (save_restriction_restore,
				 save_restriction_save ());
Jim Blandy's avatar
Jim Blandy committed
908 909 910
	  break;

	case Bcatch:
911 912 913
	  {
	    Lisp_Object v1;
	    BEFORE_POTENTIAL_GC ();
914
	    v1 = POP;
915
	    TOP = internal_catch (TOP, eval_sub, v1); /* FIXME: lexbind */
916 917 918
	    AFTER_POTENTIAL_GC ();
	    break;
	  }
Jim Blandy's avatar
Jim Blandy committed
919 920

	case Bunwind_protect:
921
	  record_unwind_protect (Fprogn, POP); /* FIXME: lexbind */
Jim Blandy's avatar
Jim Blandy committed
922 923 924
	  break;

	case Bcondition_case:
925
	  {
926 927 928
	    Lisp_Object handlers, body;
	    handlers = POP;
	    body = POP;
929
	    BEFORE_POTENTIAL_GC ();
930
	    TOP = internal_lisp_condition_case (TOP, body, handlers); /* FIXME: lexbind */
931 932 933
	    AFTER_POTENTIAL_GC ();
	    break;
	  }
Jim Blandy's avatar
Jim Blandy committed
934 935

	case Btemp_output_buffer_setup:
936
	  BEFORE_POTENTIAL_GC ();
937
	  CHECK_STRING (TOP);
938
	  temp_output_buffer_setup (SSDATA (TOP));
939
	  AFTER_POTENTIAL_GC ();
Jim Blandy's avatar
Jim Blandy committed
940 941 942 943
	  TOP = Vstandard_output;
	  break;

	case Btemp_output_buffer_show:
944 945 946
	  {
	    Lisp_Object v1;
	    BEFORE_POTENTIAL_GC ();
947
	    v1 = POP;
948 949 950
	    temp_output_buffer_show (TOP);
	    TOP = v1;
	    /* pop binding of standard-output */
Juanma Barranquero's avatar
Juanma Barranquero committed
951
	    unbind_to (SPECPDL_INDEX () - 1, Qnil);
952 953 954
	    AFTER_POTENTIAL_GC ();
	    break;
	  }
Jim Blandy's avatar
Jim Blandy committed
955 956

	case Bnth:
957 958
	  {
	    Lisp_Object v1, v2;
959
	    BEFORE_POTENTIAL_GC ();
960 961
	    v1 = POP;
	    v2 = TOP;
962
	    CHECK_NUMBER (v2);
963
	    AFTER_POTENTIAL_GC ();
964 965
	    op = XINT (v2);
	    immediate_quit = 1;
966 967
	    while (--op >= 0 && CONSP (v1))
	      v1 = XCDR (v1);
968
	    immediate_quit = 0;
969
	    TOP = CAR (v1);
970 971
	    break;
	  }
Jim Blandy's avatar
Jim Blandy committed
972 973

	case Bsymbolp:
974
	  TOP = SYMBOLP (TOP) ? Qt : Qnil;
Jim Blandy's avatar
Jim Blandy committed
975 976 977 978 979 980 981
	  break;

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

	case Bstringp:
982
	  TOP = STRINGP (TOP) ? Qt : Qnil;
Jim Blandy's avatar
Jim Blandy committed
983 984 985
	  break;

	case Blistp:
Joseph Arceneaux's avatar
Joseph Arceneaux committed
986
	  TOP = CONSP (TOP) || NILP (TOP) ? Qt : Qnil;
Jim Blandy's avatar
Jim Blandy committed
987 988 989
	  break;

	case Bnot:
Joseph Arceneaux's avatar
Joseph Arceneaux committed
990
	  TOP = NILP (TOP) ? Qt : Qnil;
Jim Blandy's avatar
Jim Blandy committed
991 992 993
	  break;

	case Bcons:
994 995 996 997 998 999
	  {
	    Lisp_Object v1;
	    v1 = POP;
	    TOP = Fcons (TOP, v1);
	    break;
	  }
Jim Blandy's avatar
Jim Blandy committed
1000 1001 1002 1003 1004 1005

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

	case Blist2:
1006 1007 1008 1009 1010 1011
	  {
	    Lisp_Object v1;
	    v1 = POP;
	    TOP = Fcons (TOP, Fcons (v1, Qnil));
	    break;
	  }
Jim Blandy's avatar
Jim Blandy committed
1012 1013

	case Blist3:
1014
	  DISCARD (2);
Jim Blandy's avatar
Jim Blandy committed
1015 1016 1017 1018
	  TOP = Flist (3, &TOP);
	  break;

	case Blist4:
1019
	  DISCARD (3);
Jim Blandy's avatar
Jim Blandy committed
1020 1021 1022
	  TOP = Flist (4, &TOP);
	  break;

1023 1024 1025 1026 1027 1028
	case BlistN:
	  op = FETCH;
	  DISCARD (op - 1);
	  TOP = Flist (op, &TOP);
	  break;

Jim Blandy's avatar
Jim Blandy committed
1029
	case Blength:
1030
	  BEFORE_POTENTIAL_GC ();
Jim Blandy's avatar
Jim Blandy committed
1031
	  TOP = Flength (TOP);
1032
	  AFTER_POTENTIAL_GC ();
Jim Blandy's avatar
Jim Blandy committed
1033 1034 1035
	  break;

	case Baref:
1036 1037
	  {
	    Lisp_Object v1;
1038
	    BEFORE_POTENTIAL_GC ();
1039 1040
	    v1 = POP;
	    TOP = Faref (TOP, v1);
1041
	    AFTER_POTENTIAL_GC ();
1042 1043
	    break;
	  }
Jim Blandy's avatar
Jim Blandy committed
1044 1045

	case Baset:
1046 1047
	  {
	    Lisp_Object v1, v2;
1048
	    BEFORE_POTENTIAL_GC ();
1049 1050
	    v2 = POP; v1 = POP;
	    TOP = Faset (TOP, v1, v2);
1051
	    AFTER_POTENTIAL_GC ();
1052 1053
	    break;
	  }
Jim Blandy's avatar
Jim Blandy committed
1054 1055

	case Bsymbol_value:
1056
	  BEFORE_POTENTIAL_GC ();
Jim Blandy's avatar
Jim Blandy committed
1057
	  TOP = Fsymbol_value (TOP);
1058
	  AFTER_POTENTIAL_GC ();
Jim Blandy's avatar
Jim Blandy committed
1059 1060 1061
	  break;

	case Bsymbol_function:
1062
	  BEFORE_POTENTIAL_GC ();
Jim Blandy's avatar
Jim Blandy committed
1063
	  TOP = Fsymbol_function (TOP);
1064
	  AFTER_POTENTIAL_GC ();
Jim Blandy's avatar
Jim Blandy committed