/* Execute compiled code */

/* XXX TO DO:

XXX speed up searching for keywords by using a dictionary

XXX document it!

*/

/* enable more aggressive intra-module optimizations, where available */

#define PY_LOCAL_AGGRESSIVE

#include "Python.h"

#include "code.h"

#include "dictobject.h"

#include "frameobject.h"

#include "opcode.h"

#include "pydtrace.h"

#include "setobject.h"

#include "structmember.h"

#include <ctype.h>

/* Turn this on if your compiler chokes on the big switch: */

/* #define CASE_TOO_BIG 1 */

#ifdef Py_DEBUG

/* For debugging the interpreter: */

#define LLTRACE 1 /* Low-level trace feature */

#define CHECKEXC 1 /* Double-check exception checking */

#endif

/* Private API for the LOAD_METHOD opcode. */

extern int _PyObject_GetMethod(PyObject *, PyObject *, PyObject **);

typedef PyObject *(*callproc)(PyObject *, PyObject *, PyObject *);

/* Forward declarations */

Py_LOCAL_INLINE(PyObject *) call_function(PyObject ***, Py_ssize_t, PyObject *);

static PyObject * do_call_core(PyObject *, PyObject *, PyObject *);

#ifdef LLTRACE

static int lltrace;

static int prtrace(PyObject *, const char *);

#endif

static int call_trace(Py_tracefunc, PyObject *,

PyThreadState *, PyFrameObject *,

int, PyObject *);

static int call_trace_protected(Py_tracefunc, PyObject *,

PyThreadState *, PyFrameObject *,

int, PyObject *);

static void call_exc_trace(Py_tracefunc, PyObject *,

PyThreadState *, PyFrameObject *);

static int maybe_call_line_trace(Py_tracefunc, PyObject *,

PyThreadState *, PyFrameObject *, int *, int *, int *);

static void maybe_dtrace_line(PyFrameObject *, int *, int *, int *);

static void dtrace_function_entry(PyFrameObject *);

static void dtrace_function_return(PyFrameObject *);

static PyObject * cmp_outcome(int, PyObject *, PyObject *);

static PyObject * import_name(PyFrameObject *, PyObject *, PyObject *, PyObject *);

static PyObject * import_from(PyObject *, PyObject *);

static int import_all_from(PyObject *, PyObject *);

static void format_exc_check_arg(PyObject *, const char *, PyObject *);

static void format_exc_unbound(PyCodeObject *co, int oparg);

static PyObject * unicode_concatenate(PyObject *, PyObject *,

PyFrameObject *, const _Py_CODEUNIT *);

static PyObject * special_lookup(PyObject *, _Py_Identifier *);

#define NAME_ERROR_MSG \

"name '%.200s' is not defined"

#define UNBOUNDLOCAL_ERROR_MSG \

"local variable '%.200s' referenced before assignment"

#define UNBOUNDFREE_ERROR_MSG \

"free variable '%.200s' referenced before assignment" \

" in enclosing scope"

/* Dynamic execution profile */

#ifdef DYNAMIC_EXECUTION_PROFILE

#ifdef DXPAIRS

static long dxpairs[257][256];

#define dxp dxpairs[256]

#else

static long dxp[256];

#endif

#endif

#ifdef WITH_THREAD

#define GIL_REQUEST _Py_atomic_load_relaxed(&gil_drop_request)

#else

#define GIL_REQUEST 0

#endif

/* This can set eval_breaker to 0 even though gil_drop_request became

1. We believe this is all right because the eval loop will release

the GIL eventually anyway. */

#define COMPUTE_EVAL_BREAKER() \

_Py_atomic_store_relaxed( \

&eval_breaker, \

GIL_REQUEST | \

_Py_atomic_load_relaxed(&pendingcalls_to_do) | \

pending_async_exc)

#ifdef WITH_THREAD

#define SET_GIL_DROP_REQUEST() \

do { \

_Py_atomic_store_relaxed(&gil_drop_request, 1); \

_Py_atomic_store_relaxed(&eval_breaker, 1); \

} while (0)

#define RESET_GIL_DROP_REQUEST() \

do { \

_Py_atomic_store_relaxed(&gil_drop_request, 0); \

COMPUTE_EVAL_BREAKER(); \

} while (0)

#endif

/* Pending calls are only modified under pending_lock */

#define SIGNAL_PENDING_CALLS() \

do { \

_Py_atomic_store_relaxed(&pendingcalls_to_do, 1); \

_Py_atomic_store_relaxed(&eval_breaker, 1); \

} while (0)

#define UNSIGNAL_PENDING_CALLS() \

do { \

_Py_atomic_store_relaxed(&pendingcalls_to_do, 0); \

COMPUTE_EVAL_BREAKER(); \

} while (0)

#define SIGNAL_ASYNC_EXC() \

do { \

pending_async_exc = 1; \

_Py_atomic_store_relaxed(&eval_breaker, 1); \

} while (0)

#define UNSIGNAL_ASYNC_EXC() \

do { pending_async_exc = 0; COMPUTE_EVAL_BREAKER(); } while (0)

/* This single variable consolidates all requests to break out of the fast path

in the eval loop. */

static _Py_atomic_int eval_breaker = {0};

/* Request for running pending calls. */

static _Py_atomic_int pendingcalls_to_do = {0};

/* Request for looking at the `async_exc` field of the current thread state.

Guarded by the GIL. */

static int pending_async_exc = 0;

#ifdef WITH_THREAD

#ifdef HAVE_ERRNO_H

#include <errno.h>

#endif

#include "pythread.h"

static PyThread_type_lock pending_lock = 0; /* for pending calls */

static unsigned long main_thread = 0;

/* Request for dropping the GIL */

static _Py_atomic_int gil_drop_request = {0};

#include "ceval_gil.h"

int

PyEval_ThreadsInitialized(void)

{

return gil_created();

}

void

PyEval_InitThreads(void)

{

if (gil_created())

return;

create_gil();

take_gil(PyThreadState_GET());

main_thread = PyThread_get_thread_ident();

if (!pending_lock)

pending_lock = PyThread_allocate_lock();

}

void

_PyEval_FiniThreads(void)

{

if (!gil_created())

return;

destroy_gil();

assert(!gil_created());

}

void

PyEval_AcquireLock(void)

{

PyThreadState *tstate = PyThreadState_GET();

if (tstate == NULL)

Py_FatalError("PyEval_AcquireLock: current thread state is NULL");

take_gil(tstate);

}

void

PyEval_ReleaseLock(void)

{

/* This function must succeed when the current thread state is NULL.

We therefore avoid PyThreadState_GET() which dumps a fatal error

in debug mode.

*/

drop_gil((PyThreadState*)_Py_atomic_load_relaxed(

&_PyThreadState_Current));

}

void

PyEval_AcquireThread(PyThreadState *tstate)

{

if (tstate == NULL)

Py_FatalError("PyEval_AcquireThread: NULL new thread state");

/* Check someone has called PyEval_InitThreads() to create the lock */

assert(gil_created());

take_gil(tstate);

if (PyThreadState_Swap(tstate) != NULL)

Py_FatalError(

"PyEval_AcquireThread: non-NULL old thread state");

}

void

PyEval_ReleaseThread(PyThreadState *tstate)

{

if (tstate == NULL)

Py_FatalError("PyEval_ReleaseThread: NULL thread state");

if (PyThreadState_Swap(NULL) != tstate)

Py_FatalError("PyEval_ReleaseThread: wrong thread state");

drop_gil(tstate);

}

/* This function is called from PyOS_AfterFork_Child to destroy all threads

* which are not running in the child process, and clear internal locks

* which might be held by those threads.

*/

void

PyEval_ReInitThreads(void)

{

PyThreadState *current_tstate = PyThreadState_GET();

if (!gil_created())

return;

recreate_gil();

pending_lock = PyThread_allocate_lock();

take_gil(current_tstate);

main_thread = PyThread_get_thread_ident();

/* Destroy all threads except the current one */

_PyThreadState_DeleteExcept(current_tstate);

}

#endif /* WITH_THREAD */

/* This function is used to signal that async exceptions are waiting to be

raised, therefore it is also useful in non-threaded builds. */

void

_PyEval_SignalAsyncExc(void)

{

SIGNAL_ASYNC_EXC();

}

/* Functions save_thread and restore_thread are always defined so

dynamically loaded modules needn't be compiled separately for use

with and without threads: */

PyThreadState *

PyEval_SaveThread(void)

{

PyThreadState *tstate = PyThreadState_Swap(NULL);

if (tstate == NULL)

Py_FatalError("PyEval_SaveThread: NULL tstate");

#ifdef WITH_THREAD

if (gil_created())

drop_gil(tstate);

#endif

return tstate;

}

void

PyEval_RestoreThread(PyThreadState *tstate)

{

if (tstate == NULL)

Py_FatalError("PyEval_RestoreThread: NULL tstate");

#ifdef WITH_THREAD

if (gil_created()) {

int err = errno;

take_gil(tstate);

/* _Py_Finalizing is protected by the GIL */

if (_Py_Finalizing && tstate != _Py_Finalizing) {

drop_gil(tstate);

PyThread_exit_thread();

assert(0); /* unreachable */

}

errno = err;

}

#endif

PyThreadState_Swap(tstate);

}

/* Mechanism whereby asynchronously executing callbacks (e.g. UNIX

signal handlers or Mac I/O completion routines) can schedule calls

to a function to be called synchronously.

The synchronous function is called with one void* argument.

It should return 0 for success or -1 for failure -- failure should

be accompanied by an exception.

If registry succeeds, the registry function returns 0; if it fails

(e.g. due to too many pending calls) it returns -1 (without setting

an exception condition).

Note that because registry may occur from within signal handlers,

or other asynchronous events, calling malloc() is unsafe!

#ifdef WITH_THREAD

Any thread can schedule pending calls, but only the main thread

will execute them.

There is no facility to schedule calls to a particular thread, but

that should be easy to change, should that ever be required. In

that case, the static variables here should go into the python

threadstate.

#endif

*/

void

_PyEval_SignalReceived(void)

{

/* bpo-30703: Function called when the C signal handler of Python gets a

signal. We cannot queue a callback using Py_AddPendingCall() since

that function is not async-signal-safe. */

SIGNAL_PENDING_CALLS();

}

#ifdef WITH_THREAD

/* The WITH_THREAD implementation is thread-safe. It allows

scheduling to be made from any thread, and even from an executing

callback.

*/

#define NPENDINGCALLS 32

static struct {

int (*func)(void *);

void *arg;

} pendingcalls[NPENDINGCALLS];

static int pendingfirst = 0;

static int pendinglast = 0;

int

Py_AddPendingCall(int (*func)(void *), void *arg)

{

int i, j, result=0;

PyThread_type_lock lock = pending_lock;

/* try a few times for the lock. Since this mechanism is used

* for signal handling (on the main thread), there is a (slim)

* chance that a signal is delivered on the same thread while we

* hold the lock during the Py_MakePendingCalls() function.

* This avoids a deadlock in that case.

* Note that signals can be delivered on any thread. In particular,

* on Windows, a SIGINT is delivered on a system-created worker

* thread.

* We also check for lock being NULL, in the unlikely case that

* this function is called before any bytecode evaluation takes place.

*/

if (lock != NULL) {

for (i = 0; i<100; i++) {

if (PyThread_acquire_lock(lock, NOWAIT_LOCK))

break;

}

if (i == 100)

return -1;

}

i = pendinglast;

j = (i + 1) % NPENDINGCALLS;

if (j == pendingfirst) {

result = -1; /* Queue full */

} else {

pendingcalls[i].func = func;

pendingcalls[i].arg = arg;

pendinglast = j;

}

/* signal main loop */

SIGNAL_PENDING_CALLS();

if (lock != NULL)

PyThread_release_lock(lock);

return result;

}

int

Py_MakePendingCalls(void)

{

static int busy = 0;

int i;

int r = 0;

assert(PyGILState_Check());

if (!pending_lock) {

/* initial allocation of the lock */

pending_lock = PyThread_allocate_lock();

if (pending_lock == NULL)

return -1;

}

/* only service pending calls on main thread */

if (main_thread && PyThread_get_thread_ident() != main_thread)

return 0;

/* don't perform recursive pending calls */

if (busy)

return 0;

busy = 1;

/* unsignal before starting to call callbacks, so that any callback

added in-between re-signals */

UNSIGNAL_PENDING_CALLS();

/* Python signal handler doesn't really queue a callback: it only signals

that a signal was received, see _PyEval_SignalReceived(). */

if (PyErr_CheckSignals() < 0) {

goto error;

}

/* perform a bounded number of calls, in case of recursion */

for (i=0; i<NPENDINGCALLS; i++) {

int j;

int (*func)(void *);

void *arg = NULL;

/* pop one item off the queue while holding the lock */

PyThread_acquire_lock(pending_lock, WAIT_LOCK);

j = pendingfirst;

if (j == pendinglast) {

func = NULL; /* Queue empty */

} else {

func = pendingcalls[j].func;

arg = pendingcalls[j].arg;

pendingfirst = (j + 1) % NPENDINGCALLS;

}

PyThread_release_lock(pending_lock);

/* having released the lock, perform the callback */

if (func == NULL)

break;

r = func(arg);

if (r) {

goto error;

}

}

busy = 0;

return r;

error:

busy = 0;

SIGNAL_PENDING_CALLS(); /* We're not done yet */

return -1;

}

#else /* if ! defined WITH_THREAD */

/*

WARNING! ASYNCHRONOUSLY EXECUTING CODE!

This code is used for signal handling in python that isn't built

with WITH_THREAD.

Don't use this implementation when Py_AddPendingCalls() can happen

on a different thread!

There are two possible race conditions:

(1) nested asynchronous calls to Py_AddPendingCall()

(2) AddPendingCall() calls made while pending calls are being processed.

(1) is very unlikely because typically signal delivery

is blocked during signal handling. So it should be impossible.

(2) is a real possibility.

The current code is safe against (2), but not against (1).

The safety against (2) is derived from the fact that only one

thread is present, interrupted by signals, and that the critical

section is protected with the "busy" variable. On Windows, which

delivers SIGINT on a system thread, this does not hold and therefore

Windows really shouldn't use this version.

The two threads could theoretically wiggle around the "busy" variable.

*/

#define NPENDINGCALLS 32

static struct {

int (*func)(void *);

void *arg;

} pendingcalls[NPENDINGCALLS];

static volatile int pendingfirst = 0;

static volatile int pendinglast = 0;

int

Py_AddPendingCall(int (*func)(void *), void *arg)

{

static volatile int busy = 0;

int i, j;

/* XXX Begin critical section */

if (busy)

return -1;

busy = 1;

i = pendinglast;

j = (i + 1) % NPENDINGCALLS;

if (j == pendingfirst) {

busy = 0;

return -1; /* Queue full */

}

pendingcalls[i].func = func;

pendingcalls[i].arg = arg;

pendinglast = j;

SIGNAL_PENDING_CALLS();

busy = 0;

/* XXX End critical section */

return 0;

}

int

Py_MakePendingCalls(void)

{

static int busy = 0;

if (busy)

return 0;

busy = 1;

/* unsignal before starting to call callbacks, so that any callback

added in-between re-signals */

UNSIGNAL_PENDING_CALLS();

/* Python signal handler doesn't really queue a callback: it only signals

that a signal was received, see _PyEval_SignalReceived(). */

if (PyErr_CheckSignals() < 0) {

goto error;

}

for (;;) {

int i;

int (*func)(void *);

void *arg;

i = pendingfirst;

if (i == pendinglast)

break; /* Queue empty */

func = pendingcalls[i].func;

arg = pendingcalls[i].arg;

pendingfirst = (i + 1) % NPENDINGCALLS;

if (func(arg) < 0) {

goto error:

}

}

busy = 0;

return 0;

error:

busy = 0;

SIGNAL_PENDING_CALLS(); /* We're not done yet */

return -1;

}

#endif /* WITH_THREAD */

/* The interpreter's recursion limit */

#ifndef Py_DEFAULT_RECURSION_LIMIT

#define Py_DEFAULT_RECURSION_LIMIT 1000

#endif

static int recursion_limit = Py_DEFAULT_RECURSION_LIMIT;

int _Py_CheckRecursionLimit = Py_DEFAULT_RECURSION_LIMIT;

int

Py_GetRecursionLimit(void)

{

return recursion_limit;

}

void

Py_SetRecursionLimit(int new_limit)

{

recursion_limit = new_limit;

_Py_CheckRecursionLimit = recursion_limit;

}

/* the macro Py_EnterRecursiveCall() only calls _Py_CheckRecursiveCall()

if the recursion_depth reaches _Py_CheckRecursionLimit.

If USE_STACKCHECK, the macro decrements _Py_CheckRecursionLimit

to guarantee that _Py_CheckRecursiveCall() is regularly called.

Without USE_STACKCHECK, there is no need for this. */

int

_Py_CheckRecursiveCall(const char *where)

{

PyThreadState *tstate = PyThreadState_GET();

#ifdef USE_STACKCHECK

if (PyOS_CheckStack()) {

--tstate->recursion_depth;

PyErr_SetString(PyExc_MemoryError, "Stack overflow");

return -1;

}

#endif

_Py_CheckRecursionLimit = recursion_limit;

if (tstate->recursion_critical)

/* Somebody asked that we don't check for recursion. */

return 0;

if (tstate->overflowed) {

if (tstate->recursion_depth > recursion_limit + 50) {

/* Overflowing while handling an overflow. Give up. */

Py_FatalError("Cannot recover from stack overflow.");

}

return 0;

}

if (tstate->recursion_depth > recursion_limit) {

--tstate->recursion_depth;

tstate->overflowed = 1;

PyErr_Format(PyExc_RecursionError,

"maximum recursion depth exceeded%s",

where);

return -1;

}

return 0;

}

/* Status code for main loop (reason for stack unwind) */

enum why_code {

WHY_NOT = 0x0001, /* No error */

WHY_EXCEPTION = 0x0002, /* Exception occurred */

WHY_RETURN = 0x0008, /* 'return' statement */

WHY_BREAK = 0x0010, /* 'break' statement */

WHY_CONTINUE = 0x0020, /* 'continue' statement */

WHY_YIELD = 0x0040, /* 'yield' operator */

WHY_SILENCED = 0x0080 /* Exception silenced by 'with' */

};

static void save_exc_state(PyThreadState *, PyFrameObject *);

static void swap_exc_state(PyThreadState *, PyFrameObject *);

static void restore_and_clear_exc_state(PyThreadState *, PyFrameObject *);

static int do_raise(PyObject *, PyObject *);

static int unpack_iterable(PyObject *, int, int, PyObject **);

/* Records whether tracing is on for any thread. Counts the number of

threads for which tstate->c_tracefunc is non-NULL, so if the value

is 0, we know we don't have to check this thread's c_tracefunc.

This speeds up the if statement in PyEval_EvalFrameEx() after

fast_next_opcode*/

static int _Py_TracingPossible = 0;

PyObject *

PyEval_EvalCode(PyObject *co, PyObject *globals, PyObject *locals)

{

return PyEval_EvalCodeEx(co,

globals, locals,

(PyObject **)NULL, 0,

(PyObject **)NULL, 0,

(PyObject **)NULL, 0,

NULL, NULL);

}

/* Interpreter main loop */

PyObject *

PyEval_EvalFrame(PyFrameObject *f) {

/* This is for backward compatibility with extension modules that

used this API; core interpreter code should call

PyEval_EvalFrameEx() */

return PyEval_EvalFrameEx(f, 0);

}

PyObject *

PyEval_EvalFrameEx(PyFrameObject *f, int throwflag)

{

PyThreadState *tstate = PyThreadState_GET();

return tstate->interp->eval_frame(f, throwflag);

}

PyObject* _Py_HOT_FUNCTION

_PyEval_EvalFrameDefault(PyFrameObject *f, int throwflag)

{

#ifdef DXPAIRS

int lastopcode = 0;

#endif

PyObject **stack_pointer; /* Next free slot in value stack */

const _Py_CODEUNIT *next_instr;

int opcode; /* Current opcode */

int oparg; /* Current opcode argument, if any */

enum why_code why; /* Reason for block stack unwind */

PyObject **fastlocals, **freevars;

PyObject *retval = NULL; /* Return value */

PyThreadState *tstate = PyThreadState_GET();

PyCodeObject *co;

/* when tracing we set things up so that

not (instr_lb <= current_bytecode_offset < instr_ub)

is true when the line being executed has changed. The

initial values are such as to make this false the first

time it is tested. */

int instr_ub = -1, instr_lb = 0, instr_prev = -1;

const _Py_CODEUNIT *first_instr;

PyObject *names;

PyObject *consts;

#ifdef LLTRACE

_Py_IDENTIFIER(__ltrace__);

#endif

/* Computed GOTOs, or

the-optimization-commonly-but-improperly-known-as-"threaded code"

using gcc's labels-as-values extension

(http://gcc.gnu.org/onlinedocs/gcc/Labels-as-Values.html).

The traditional bytecode evaluation loop uses a "switch" statement, which

decent compilers will optimize as a single indirect branch instruction

combined with a lookup table of jump addresses. However, since the

indirect jump instruction is shared by all opcodes, the CPU will have a

hard time making the right prediction for where to jump next (actually,

it will be always wrong except in the uncommon case of a sequence of

several identical opcodes).

"Threaded code" in contrast, uses an explicit jump table and an explicit

indirect jump instruction at the end of each opcode. Since the jump

instruction is at a different address for each opcode, the CPU will make a

separate prediction for each of these instructions, which is equivalent to

predicting the second opcode of each opcode pair. These predictions have

a much better chance to turn out valid, especially in small bytecode loops.

A mispredicted branch on a modern CPU flushes the whole pipeline and

can cost several CPU cycles (depending on the pipeline depth),

and potentially many more instructions (depending on the pipeline width).

A correctly predicted branch, however, is nearly free.

At the time of this writing, the "threaded code" version is up to 15-20%

faster than the normal "switch" version, depending on the compiler and the

CPU architecture.

We disable the optimization if DYNAMIC_EXECUTION_PROFILE is defined,

because it would render the measurements invalid.

NOTE: care must be taken that the compiler doesn't try to "optimize" the

indirect jumps by sharing them between all opcodes. Such optimizations

can be disabled on gcc by using the -fno-gcse flag (or possibly

-fno-crossjumping).

*/

#ifdef DYNAMIC_EXECUTION_PROFILE

#undef USE_COMPUTED_GOTOS

#define USE_COMPUTED_GOTOS 0

#endif

#ifdef HAVE_COMPUTED_GOTOS

#ifndef USE_COMPUTED_GOTOS

#define USE_COMPUTED_GOTOS 1

#endif

#else

#if defined(USE_COMPUTED_GOTOS) && USE_COMPUTED_GOTOS

#error "Computed gotos are not supported on this compiler."

#endif

#undef USE_COMPUTED_GOTOS

#define USE_COMPUTED_GOTOS 0

#endif

#if USE_COMPUTED_GOTOS

/* Import the static jump table */

#include "opcode_targets.h"

#define TARGET(op) \

TARGET_##op: \

case op:

#define DISPATCH() \

{ \

if (!_Py_atomic_load_relaxed(&eval_breaker)) { \

FAST_DISPATCH(); \

} \

continue; \

}

#ifdef LLTRACE

#define FAST_DISPATCH() \

{ \

if (!lltrace && !_Py_TracingPossible && !PyDTrace_LINE_ENABLED()) { \

f->f_lasti = INSTR_OFFSET(); \

NEXTOPARG(); \

goto *opcode_targets[opcode]; \

} \

goto fast_next_opcode; \

}

#else

#define FAST_DISPATCH() \

{ \

if (!_Py_TracingPossible && !PyDTrace_LINE_ENABLED()) { \

f->f_lasti = INSTR_OFFSET(); \

NEXTOPARG(); \

goto *opcode_targets[opcode]; \

} \

goto fast_next_opcode; \

}

#endif

#else

#define TARGET(op) \

case op:

#define DISPATCH() continue

#define FAST_DISPATCH() goto fast_next_opcode

#endif

/* Tuple access macros */

#ifndef Py_DEBUG

#define GETITEM(v, i) PyTuple_GET_ITEM((PyTupleObject *)(v), (i))

#else

#define GETITEM(v, i) PyTuple_GetItem((v), (i))

#endif

/* Code access macros */

/* The integer overflow is checked by an assertion below. */

#define INSTR_OFFSET() (sizeof(_Py_CODEUNIT) * (int)(next_instr - first_instr))

#define NEXTOPARG() do { \

_Py_CODEUNIT word = *next_instr; \

opcode = _Py_OPCODE(word); \

oparg = _Py_OPARG(word); \

next_instr++; \

} while (0)

#define JUMPTO(x) (next_instr = first_instr + (x) / sizeof(_Py_CODEUNIT))

#define JUMPBY(x) (next_instr += (x) / sizeof(_Py_CODEUNIT))

/* OpCode prediction macros

Some opcodes tend to come in pairs thus making it possible to

predict the second code when the first is run. For example,

COMPARE_OP is often followed by POP_JUMP_IF_FALSE or POP_JUMP_IF_TRUE.

Verifying the prediction costs a single high-speed test of a register

variable against a constant. If the pairing was good, then the

processor's own internal branch predication has a high likelihood of

success, resulting in a nearly zero-overhead transition to the

next opcode. A successful prediction saves a trip through the eval-loop

including its unpredictable switch-case branch. Combined with the

processor's internal branch prediction, a successful PREDICT has the

effect of making the two opcodes run as if they were a single new opcode

with the bodies combined.

If collecting opcode statistics, your choices are to either keep the

predictions turned-on and interpret the results as if some opcodes

had been combined or turn-off predictions so that the opcode frequency

counter updates for both opcodes.

Opcode prediction is disabled with threaded code, since the latter allows

the CPU to record separate branch prediction information for each

opcode.

*/

#if defined(DYNAMIC_EXECUTION_PROFILE) || USE_COMPUTED_GOTOS

#define PREDICT(op) if (0) goto PRED_##op

#else

#define PREDICT(op) \

do{ \

_Py_CODEUNIT word = *next_instr; \

opcode = _Py_OPCODE(word); \

if (opcode == op){ \

oparg = _Py_OPARG(word); \

next_instr++; \

goto PRED_##op; \

} \

} while(0)

#endif

#define PREDICTED(op) PRED_##op:

/* Stack manipulation macros */

/* The stack can grow at most MAXINT deep, as co_nlocals and

co_stacksize are ints. */

#define STACK_LEVEL() ((int)(stack_pointer - f->f_valuestack))

#define EMPTY() (STACK_LEVEL() == 0)

#define TOP() (stack_pointer[-1])

#define SECOND() (stack_pointer[-2])

#define THIRD() (stack_pointer[-3])

#define FOURTH() (stack_pointer[-4])

#define PEEK(n) (stack_pointer[-(n)])

#define SET_TOP(v) (stack_pointer[-1] = (v))

#define SET_SECOND(v) (stack_pointer[-2] = (v))

#define SET_THIRD(v) (stack_pointer[-3] = (v))

#define SET_FOURTH(v) (stack_pointer[-4] = (v))

#define SET_VALUE(n, v) (stack_pointer[-(n)] = (v))

#define BASIC_STACKADJ(n) (stack_pointer += n)

#define BASIC_PUSH(v) (*stack_pointer++ = (v))

#define BASIC_POP() (*--stack_pointer)

#ifdef LLTRACE

#define PUSH(v) { (void)(BASIC_PUSH(v), \

lltrace && prtrace(TOP(), "push")); \

assert(STACK_LEVEL() <= co->co_stacksize); }

#define POP() ((void)(lltrace && prtrace(TOP(), "pop")), \

BASIC_POP())

#define STACKADJ(n) { (void)(BASIC_STACKADJ(n), \

lltrace && prtrace(TOP(), "stackadj")); \

assert(STACK_LEVEL() <= co->co_stacksize); }

#define EXT_POP(STACK_POINTER) ((void)(lltrace && \

prtrace((STACK_POINTER)[-1], "ext_pop")), \

*--(STACK_POINTER))

#else

#define PUSH(v) BASIC_PUSH(v)

#define POP() BASIC_POP()

#define STACKADJ(n) BASIC_STACKADJ(n)

#define EXT_POP(STACK_POINTER) (*--(STACK_POINTER))

#endif

/* Local variable macros */

#define GETLOCAL(i) (fastlocals[i])

/* The SETLOCAL() macro must not DECREF the local variable in-place and

then store the new value; it must copy the old value to a temporary

value, then store the new value, and then DECREF the temporary value.

This is because it is possible that during the DECREF the frame is

accessed by other code (e.g. a __del__ method or gc.collect()) and the

variable would be pointing to already-freed memory. */

#define SETLOCAL(i, value) do { PyObject *tmp = GETLOCAL(i); \

GETLOCAL(i) = value; \

Py_XDECREF(tmp); } while (0)

#define UNWIND_BLOCK(b) \

while (STACK_LEVEL() > (b)->b_level) { \

PyObject *v = POP(); \

Py_XDECREF(v); \

}

#define UNWIND_EXCEPT_HANDLER(b) \

do { \

PyObject *type, *value, *traceback; \

assert(STACK_LEVEL() >= (b)->b_level + 3); \

while (STACK_LEVEL() > (b)->b_level + 3) { \

value = POP(); \

Py_XDECREF(value); \

} \

type = tstate->exc_type; \

value = tstate->exc_value; \

traceback = tstate->exc_traceback; \

tstate->exc_type = POP(); \

tstate->exc_value = POP(); \

tstate->exc_traceback = POP(); \

Py_XDECREF(type); \

Py_XDECREF(value); \

Py_XDECREF(traceback); \

} while(0)

/* Start of code */

/* push frame */

if (Py_EnterRecursiveCall(""))

return NULL;

tstate->frame = f;

if (tstate->use_tracing) {

if (tstate->c_tracefunc != NULL) {

/* tstate->c_tracefunc, if defined, is a

function that will be called on *every* entry

to a code block. Its return value, if not

None, is a function that will be called at

the start of each executed line of code.

(Actually, the function must return itself

in order to continue tracing.) The trace

functions are called with three arguments:

a pointer to the current frame, a string

indicating why the function is called, and

an argument which depends on the situation.

The global trace function is also called

whenever an exception is detected. */

if (call_trace_protected(tstate->c_tracefunc,

tstate->c_traceobj,

tstate, f, PyTrace_CALL, Py_None)) {

/* Trace function raised an error */

goto exit_eval_frame;

}

}

if (tstate->c_profilefunc != NULL) {

/* Similar for c_profilefunc, except it needn't

return itself and isn't called for "line" events */

if (call_trace_protected(tstate->c_profilefunc,

tstate->c_profileobj,

tstate, f, PyTrace_CALL, Py_None)) {

/* Profile function raised an error */

goto exit_eval_frame;

}

}

}