// This file contains instruction definitions.

// It is read by generators stored in Tools/cases_generator/

// to generate Python/generated_cases.c.h and others.

// Note that there is some dummy C code at the top and bottom of the file

// to fool text editors like VS Code into believing this is valid C code.

// The actual instruction definitions start at // BEGIN BYTECODES //.

// See Tools/cases_generator/README.md for more information.

#include "Python.h"

#include "pycore_abstract.h" // _PyIndex_Check()

#include "pycore_backoff.h"

#include "pycore_cell.h" // PyCell_GetRef()

#include "pycore_code.h"

#include "pycore_emscripten_signal.h" // _Py_CHECK_EMSCRIPTEN_SIGNALS

#include "pycore_function.h"

#include "pycore_instruments.h"

#include "pycore_intrinsics.h"

#include "pycore_long.h" // _PyLong_GetZero()

#include "pycore_moduleobject.h" // PyModuleObject

#include "pycore_object.h" // _PyObject_GC_TRACK()

#include "pycore_opcode_metadata.h" // uop names

#include "pycore_opcode_utils.h" // MAKE_FUNCTION_*

#include "pycore_pyatomic_ft_wrappers.h" // FT_ATOMIC_*

#include "pycore_pyerrors.h" // _PyErr_GetRaisedException()

#include "pycore_pystate.h" // _PyInterpreterState_GET()

#include "pycore_range.h" // _PyRangeIterObject

#include "pycore_setobject.h" // _PySet_NextEntry()

#include "pycore_sliceobject.h" // _PyBuildSlice_ConsumeRefs

#include "pycore_sysmodule.h" // _PySys_Audit()

#include "pycore_tuple.h" // _PyTuple_ITEMS()

#include "pycore_typeobject.h" // _PySuper_Lookup()

#include "pycore_dict.h"

#include "dictobject.h"

#include "pycore_frame.h"

#include "opcode.h"

#include "optimizer.h"

#include "pydtrace.h"

#include "setobject.h"

#define USE_COMPUTED_GOTOS 0

#include "ceval_macros.h"

/* Flow control macros */

#define GO_TO_INSTRUCTION(instname) ((void)0)

#define inst(name, ...) case name:

#define op(name, ...) /* NAME is ignored */

#define macro(name) static int MACRO_##name

#define super(name) static int SUPER_##name

#define family(name, ...) static int family_##name

#define pseudo(name) static int pseudo_##name

/* Annotations */

#define guard

#define override

#define specializing

#define split

#define replicate(TIMES)

// Dummy variables for stack effects.

static PyObject *value, *value1, *value2, *left, *right, *res, *sum, *prod, *sub;

static PyObject *container, *start, *stop, *v, *lhs, *rhs, *res2;

static PyObject *list, *tuple, *dict, *owner, *set, *str, *tup, *map, *keys;

static PyObject *exit_func, *lasti, *val, *retval, *obj, *iter, *exhausted;

static PyObject *aiter, *awaitable, *iterable, *w, *exc_value, *bc, *locals;

static PyObject *orig, *excs, *update, *b, *fromlist, *level, *from;

static PyObject **pieces, **values;

static size_t jump;

// Dummy variables for cache effects

static uint16_t invert, counter, index, hint;

#define unused 0 // Used in a macro def, can't be static

static uint32_t type_version;

static _PyExecutorObject *current_executor;

static PyObject *

dummy_func(

PyThreadState *tstate,

_PyInterpreterFrame *frame,

unsigned char opcode,

unsigned int oparg,

_Py_CODEUNIT *next_instr,

PyObject **stack_pointer,

int throwflag,

PyObject *args[]

)

{

// Dummy labels.

pop_1_error:

// Dummy locals.

PyObject *dummy;

_Py_CODEUNIT *this_instr;

PyObject *attr;

PyObject *attrs;

PyObject *bottom;

PyObject *callable;

PyObject *callargs;

PyObject *codeobj;

PyObject *cond;

PyObject *descr;

_PyInterpreterFrame entry_frame;

PyObject *exc;

PyObject *exit;

PyObject *fget;

PyObject *fmt_spec;

PyObject *func;

uint32_t func_version;

PyObject *getattribute;

PyObject *kwargs;

PyObject *kwdefaults;

PyObject *len_o;

PyObject *match;

PyObject *match_type;

PyObject *method;

PyObject *mgr;

Py_ssize_t min_args;

PyObject *names;

PyObject *new_exc;

PyObject *next;

PyObject *none;

PyObject *null;

PyObject *prev_exc;

PyObject *receiver;

PyObject *rest;

int result;

PyObject *self;

PyObject *seq;

PyObject *slice;

PyObject *step;

PyObject *subject;

PyObject *top;

PyObject *type;

PyObject *typevars;

PyObject *val0;

PyObject *val1;

int values_or_none;

switch (opcode) {

// BEGIN BYTECODES //

pure inst(NOP, (--)) {

}

family(RESUME, 0) = {

RESUME_CHECK,

};

tier1 inst(RESUME, (--)) {

assert(frame == tstate->current_frame);

if (tstate->tracing == 0) {

uintptr_t global_version =

_Py_atomic_load_uintptr_relaxed(&tstate->eval_breaker) &

~_PY_EVAL_EVENTS_MASK;

PyCodeObject* code = _PyFrame_GetCode(frame);

uintptr_t code_version = FT_ATOMIC_LOAD_UINTPTR_ACQUIRE(code->_co_instrumentation_version);

assert((code_version & 255) == 0);

if (code_version != global_version) {

int err = _Py_Instrument(_PyFrame_GetCode(frame), tstate->interp);

ERROR_IF(err, error);

next_instr = this_instr;

DISPATCH();

}

assert(this_instr->op.code == RESUME ||

this_instr->op.code == RESUME_CHECK ||

this_instr->op.code == INSTRUMENTED_RESUME ||

this_instr->op.code == ENTER_EXECUTOR);

if (this_instr->op.code == RESUME) {

#if ENABLE_SPECIALIZATION

FT_ATOMIC_STORE_UINT8_RELAXED(this_instr->op.code, RESUME_CHECK);

#endif /* ENABLE_SPECIALIZATION */

}

}

if ((oparg & RESUME_OPARG_LOCATION_MASK) < RESUME_AFTER_YIELD_FROM) {

CHECK_EVAL_BREAKER();

}

}

inst(RESUME_CHECK, (--)) {

#if defined(__EMSCRIPTEN__)

DEOPT_IF(_Py_emscripten_signal_clock == 0);

_Py_emscripten_signal_clock -= Py_EMSCRIPTEN_SIGNAL_HANDLING;

#endif

uintptr_t eval_breaker = _Py_atomic_load_uintptr_relaxed(&tstate->eval_breaker);

uintptr_t version = FT_ATOMIC_LOAD_UINTPTR_ACQUIRE(_PyFrame_GetCode(frame)->_co_instrumentation_version);

assert((version & _PY_EVAL_EVENTS_MASK) == 0);

DEOPT_IF(eval_breaker != version);

}

inst(INSTRUMENTED_RESUME, (--)) {

uintptr_t global_version = _Py_atomic_load_uintptr_relaxed(&tstate->eval_breaker) & ~_PY_EVAL_EVENTS_MASK;

uintptr_t code_version = FT_ATOMIC_LOAD_UINTPTR_ACQUIRE(_PyFrame_GetCode(frame)->_co_instrumentation_version);

if (code_version != global_version && tstate->tracing == 0) {

int err = _Py_Instrument(_PyFrame_GetCode(frame), tstate->interp);

if (err) {

ERROR_NO_POP();

}

next_instr = this_instr;

}

else {

if ((oparg & RESUME_OPARG_LOCATION_MASK) < RESUME_AFTER_YIELD_FROM) {

CHECK_EVAL_BREAKER();

}

_PyFrame_SetStackPointer(frame, stack_pointer);

int err = _Py_call_instrumentation(

tstate, oparg > 0, frame, this_instr);

stack_pointer = _PyFrame_GetStackPointer(frame);

ERROR_IF(err, error);

if (frame->instr_ptr != this_instr) {

/* Instrumentation has jumped */

next_instr = frame->instr_ptr;

DISPATCH();

}

}

}

pseudo(LOAD_CLOSURE, (-- unused)) = {

LOAD_FAST,

};

inst(LOAD_FAST_CHECK, (-- value)) {

_PyStackRef value_s = GETLOCAL(oparg);

if (PyStackRef_IsNull(value_s)) {

_PyEval_FormatExcCheckArg(tstate, PyExc_UnboundLocalError,

UNBOUNDLOCAL_ERROR_MSG,

PyTuple_GetItem(_PyFrame_GetCode(frame)->co_localsplusnames, oparg)

);

ERROR_IF(1, error);

}

value = PyStackRef_DUP(value_s);

}

replicate(8) pure inst(LOAD_FAST, (-- value)) {

assert(!PyStackRef_IsNull(GETLOCAL(oparg)));

value = PyStackRef_DUP(GETLOCAL(oparg));

}

inst(LOAD_FAST_AND_CLEAR, (-- value)) {

value = GETLOCAL(oparg);

// do not use SETLOCAL here, it decrefs the old value

GETLOCAL(oparg) = PyStackRef_NULL;

}

inst(LOAD_FAST_LOAD_FAST, ( -- value1, value2)) {

uint32_t oparg1 = oparg >> 4;

uint32_t oparg2 = oparg & 15;

value1 = PyStackRef_DUP(GETLOCAL(oparg1));

value2 = PyStackRef_DUP(GETLOCAL(oparg2));

}

pure inst(LOAD_CONST, (-- value)) {

value = PyStackRef_FromPyObjectNew(GETITEM(FRAME_CO_CONSTS, oparg));

}

replicate(8) inst(STORE_FAST, (value --)) {

SETLOCAL(oparg, value);

}

pseudo(STORE_FAST_MAYBE_NULL, (unused --)) = {

STORE_FAST,

};

inst(STORE_FAST_LOAD_FAST, (value1 -- value2)) {

uint32_t oparg1 = oparg >> 4;

uint32_t oparg2 = oparg & 15;

SETLOCAL(oparg1, value1);

value2 = PyStackRef_DUP(GETLOCAL(oparg2));

}

inst(STORE_FAST_STORE_FAST, (value2, value1 --)) {

uint32_t oparg1 = oparg >> 4;

uint32_t oparg2 = oparg & 15;

SETLOCAL(oparg1, value1);

SETLOCAL(oparg2, value2);

}

pure inst(POP_TOP, (value --)) {

DECREF_INPUTS();

}

pure inst(PUSH_NULL, (-- res)) {

res = PyStackRef_NULL;

}

macro(END_FOR) = POP_TOP;

tier1 inst(INSTRUMENTED_END_FOR, (receiver, value -- receiver)) {

/* Need to create a fake StopIteration error here,

* to conform to PEP 380 */

if (PyStackRef_GenCheck(receiver)) {

int err = monitor_stop_iteration(tstate, frame, this_instr, PyStackRef_AsPyObjectBorrow(value));

if (err) {

ERROR_NO_POP();

}

}

DECREF_INPUTS();

}

pure inst(END_SEND, (receiver, value -- value)) {

(void)receiver;

PyStackRef_CLOSE(receiver);

}

tier1 inst(INSTRUMENTED_END_SEND, (receiver, value -- value)) {

PyObject *receiver_o = PyStackRef_AsPyObjectBorrow(receiver);

if (PyGen_Check(receiver_o) || PyCoro_CheckExact(receiver_o)) {

int err = monitor_stop_iteration(tstate, frame, this_instr, PyStackRef_AsPyObjectBorrow(value));

if (err) {

ERROR_NO_POP();

}

}

PyStackRef_CLOSE(receiver);

}

inst(UNARY_NEGATIVE, (value -- res)) {

PyObject *res_o = PyNumber_Negative(PyStackRef_AsPyObjectBorrow(value));

DECREF_INPUTS();

ERROR_IF(res_o == NULL, error);

res = PyStackRef_FromPyObjectSteal(res_o);

}

pure inst(UNARY_NOT, (value -- res)) {

assert(PyStackRef_BoolCheck(value));

res = PyStackRef_Is(value, PyStackRef_False)

? PyStackRef_True : PyStackRef_False;

}

family(TO_BOOL, INLINE_CACHE_ENTRIES_TO_BOOL) = {

TO_BOOL_ALWAYS_TRUE,

TO_BOOL_BOOL,

TO_BOOL_INT,

TO_BOOL_LIST,

TO_BOOL_NONE,

TO_BOOL_STR,

};

specializing op(_SPECIALIZE_TO_BOOL, (counter/1, value -- value)) {

#if ENABLE_SPECIALIZATION

if (ADAPTIVE_COUNTER_TRIGGERS(counter)) {

next_instr = this_instr;

_Py_Specialize_ToBool(value, next_instr);

DISPATCH_SAME_OPARG();

}

STAT_INC(TO_BOOL, deferred);

ADVANCE_ADAPTIVE_COUNTER(this_instr[1].counter);

#endif /* ENABLE_SPECIALIZATION */

}

op(_TO_BOOL, (value -- res)) {

int err = PyObject_IsTrue(PyStackRef_AsPyObjectBorrow(value));

DECREF_INPUTS();

ERROR_IF(err < 0, error);

res = err ? PyStackRef_True : PyStackRef_False;

}

macro(TO_BOOL) = _SPECIALIZE_TO_BOOL + unused/2 + _TO_BOOL;

inst(TO_BOOL_BOOL, (unused/1, unused/2, value -- value)) {

EXIT_IF(!PyStackRef_BoolCheck(value));

STAT_INC(TO_BOOL, hit);

}

inst(TO_BOOL_INT, (unused/1, unused/2, value -- res)) {

PyObject *value_o = PyStackRef_AsPyObjectBorrow(value);

EXIT_IF(!PyLong_CheckExact(value_o));

STAT_INC(TO_BOOL, hit);

if (_PyLong_IsZero((PyLongObject *)value_o)) {

assert(_Py_IsImmortal(value_o));

res = PyStackRef_False;

}

else {

DECREF_INPUTS();

res = PyStackRef_True;

}

}

inst(TO_BOOL_LIST, (unused/1, unused/2, value -- res)) {

PyObject *value_o = PyStackRef_AsPyObjectBorrow(value);

EXIT_IF(!PyList_CheckExact(value_o));

STAT_INC(TO_BOOL, hit);

res = Py_SIZE(value_o) ? PyStackRef_True : PyStackRef_False;

DECREF_INPUTS();

}

inst(TO_BOOL_NONE, (unused/1, unused/2, value -- res)) {

// This one is a bit weird, because we expect *some* failures:

EXIT_IF(!PyStackRef_Is(value, PyStackRef_None));

STAT_INC(TO_BOOL, hit);

res = PyStackRef_False;

}

inst(TO_BOOL_STR, (unused/1, unused/2, value -- res)) {

PyObject *value_o = PyStackRef_AsPyObjectBorrow(value);

EXIT_IF(!PyUnicode_CheckExact(value_o));

STAT_INC(TO_BOOL, hit);

if (value_o == &_Py_STR(empty)) {

assert(_Py_IsImmortal(value_o));

res = PyStackRef_False;

}

else {

assert(Py_SIZE(value_o));

DECREF_INPUTS();

res = PyStackRef_True;

}

}

op(_REPLACE_WITH_TRUE, (value -- res)) {

DECREF_INPUTS();

res = PyStackRef_True;

}

macro(TO_BOOL_ALWAYS_TRUE) =

unused/1 +

_GUARD_TYPE_VERSION +

_REPLACE_WITH_TRUE;

inst(UNARY_INVERT, (value -- res)) {

PyObject *res_o = PyNumber_Invert(PyStackRef_AsPyObjectBorrow(value));

DECREF_INPUTS();

ERROR_IF(res_o == NULL, error);

res = PyStackRef_FromPyObjectSteal(res_o);

}

family(BINARY_OP, INLINE_CACHE_ENTRIES_BINARY_OP) = {

BINARY_OP_MULTIPLY_INT,

BINARY_OP_ADD_INT,

BINARY_OP_SUBTRACT_INT,

BINARY_OP_MULTIPLY_FLOAT,

BINARY_OP_ADD_FLOAT,

BINARY_OP_SUBTRACT_FLOAT,

BINARY_OP_ADD_UNICODE,

// BINARY_OP_INPLACE_ADD_UNICODE, // See comments at that opcode.

};

op(_GUARD_BOTH_INT, (left, right -- left, right)) {

PyObject *left_o = PyStackRef_AsPyObjectBorrow(left);

PyObject *right_o = PyStackRef_AsPyObjectBorrow(right);

EXIT_IF(!PyLong_CheckExact(left_o));

EXIT_IF(!PyLong_CheckExact(right_o));

}

op(_GUARD_NOS_INT, (left, unused -- left, unused)) {

PyObject *left_o = PyStackRef_AsPyObjectBorrow(left);

EXIT_IF(!PyLong_CheckExact(left_o));

}

op(_GUARD_TOS_INT, (value -- value)) {

PyObject *value_o = PyStackRef_AsPyObjectBorrow(value);

EXIT_IF(!PyLong_CheckExact(value_o));

}

pure op(_BINARY_OP_MULTIPLY_INT, (left, right -- res)) {

PyObject *left_o = PyStackRef_AsPyObjectBorrow(left);

PyObject *right_o = PyStackRef_AsPyObjectBorrow(right);

STAT_INC(BINARY_OP, hit);

PyObject *res_o = _PyLong_Multiply((PyLongObject *)left_o, (PyLongObject *)right_o);

_Py_DECREF_SPECIALIZED(right_o, (destructor)PyObject_Free);

_Py_DECREF_SPECIALIZED(left_o, (destructor)PyObject_Free);

ERROR_IF(res_o == NULL, error);

res = PyStackRef_FromPyObjectSteal(res_o);

}

pure op(_BINARY_OP_ADD_INT, (left, right -- res)) {

PyObject *left_o = PyStackRef_AsPyObjectBorrow(left);

PyObject *right_o = PyStackRef_AsPyObjectBorrow(right);

STAT_INC(BINARY_OP, hit);

PyObject *res_o = _PyLong_Add((PyLongObject *)left_o, (PyLongObject *)right_o);

_Py_DECREF_SPECIALIZED(right_o, (destructor)PyObject_Free);

_Py_DECREF_SPECIALIZED(left_o, (destructor)PyObject_Free);

ERROR_IF(res_o == NULL, error);

res = PyStackRef_FromPyObjectSteal(res_o);

}

pure op(_BINARY_OP_SUBTRACT_INT, (left, right -- res)) {

PyObject *left_o = PyStackRef_AsPyObjectBorrow(left);

PyObject *right_o = PyStackRef_AsPyObjectBorrow(right);

STAT_INC(BINARY_OP, hit);

PyObject *res_o = _PyLong_Subtract((PyLongObject *)left_o, (PyLongObject *)right_o);

_Py_DECREF_SPECIALIZED(right_o, (destructor)PyObject_Free);

_Py_DECREF_SPECIALIZED(left_o, (destructor)PyObject_Free);;

ERROR_IF(res_o == NULL, error);

res = PyStackRef_FromPyObjectSteal(res_o);

}

macro(BINARY_OP_MULTIPLY_INT) =

_GUARD_BOTH_INT + unused/1 + _BINARY_OP_MULTIPLY_INT;

macro(BINARY_OP_ADD_INT) =

_GUARD_BOTH_INT + unused/1 + _BINARY_OP_ADD_INT;

macro(BINARY_OP_SUBTRACT_INT) =

_GUARD_BOTH_INT + unused/1 + _BINARY_OP_SUBTRACT_INT;

op(_GUARD_BOTH_FLOAT, (left, right -- left, right)) {

PyObject *left_o = PyStackRef_AsPyObjectBorrow(left);

PyObject *right_o = PyStackRef_AsPyObjectBorrow(right);

EXIT_IF(!PyFloat_CheckExact(left_o));

EXIT_IF(!PyFloat_CheckExact(right_o));

}

op(_GUARD_NOS_FLOAT, (left, unused -- left, unused)) {

PyObject *left_o = PyStackRef_AsPyObjectBorrow(left);

EXIT_IF(!PyFloat_CheckExact(left_o));

}

op(_GUARD_TOS_FLOAT, (value -- value)) {

PyObject *value_o = PyStackRef_AsPyObjectBorrow(value);

EXIT_IF(!PyFloat_CheckExact(value_o));

}

pure op(_BINARY_OP_MULTIPLY_FLOAT, (left, right -- res)) {

PyObject *left_o = PyStackRef_AsPyObjectBorrow(left);

PyObject *right_o = PyStackRef_AsPyObjectBorrow(right);

STAT_INC(BINARY_OP, hit);

double dres =

((PyFloatObject *)left_o)->ob_fval *

((PyFloatObject *)right_o)->ob_fval;

PyObject *res_o;

DECREF_INPUTS_AND_REUSE_FLOAT(left_o, right_o, dres, res_o);

res = PyStackRef_FromPyObjectSteal(res_o);

}

pure op(_BINARY_OP_ADD_FLOAT, (left, right -- res)) {

PyObject *left_o = PyStackRef_AsPyObjectBorrow(left);

PyObject *right_o = PyStackRef_AsPyObjectBorrow(right);

STAT_INC(BINARY_OP, hit);

double dres =

((PyFloatObject *)left_o)->ob_fval +

((PyFloatObject *)right_o)->ob_fval;

PyObject *res_o;

DECREF_INPUTS_AND_REUSE_FLOAT(left_o, right_o, dres, res_o);

res = PyStackRef_FromPyObjectSteal(res_o);

}

pure op(_BINARY_OP_SUBTRACT_FLOAT, (left, right -- res)) {

PyObject *left_o = PyStackRef_AsPyObjectBorrow(left);

PyObject *right_o = PyStackRef_AsPyObjectBorrow(right);

STAT_INC(BINARY_OP, hit);

double dres =

((PyFloatObject *)left_o)->ob_fval -

((PyFloatObject *)right_o)->ob_fval;

PyObject *res_o;

DECREF_INPUTS_AND_REUSE_FLOAT(left_o, right_o, dres, res_o);

res = PyStackRef_FromPyObjectSteal(res_o);

}

macro(BINARY_OP_MULTIPLY_FLOAT) =

_GUARD_BOTH_FLOAT + unused/1 + _BINARY_OP_MULTIPLY_FLOAT;

macro(BINARY_OP_ADD_FLOAT) =

_GUARD_BOTH_FLOAT + unused/1 + _BINARY_OP_ADD_FLOAT;

macro(BINARY_OP_SUBTRACT_FLOAT) =

_GUARD_BOTH_FLOAT + unused/1 + _BINARY_OP_SUBTRACT_FLOAT;

op(_GUARD_BOTH_UNICODE, (left, right -- left, right)) {

PyObject *left_o = PyStackRef_AsPyObjectBorrow(left);

PyObject *right_o = PyStackRef_AsPyObjectBorrow(right);

EXIT_IF(!PyUnicode_CheckExact(left_o));

EXIT_IF(!PyUnicode_CheckExact(right_o));

}

pure op(_BINARY_OP_ADD_UNICODE, (left, right -- res)) {

PyObject *left_o = PyStackRef_AsPyObjectBorrow(left);

PyObject *right_o = PyStackRef_AsPyObjectBorrow(right);

STAT_INC(BINARY_OP, hit);

PyObject *res_o = PyUnicode_Concat(left_o, right_o);

_Py_DECREF_SPECIALIZED(left_o, _PyUnicode_ExactDealloc);

_Py_DECREF_SPECIALIZED(right_o, _PyUnicode_ExactDealloc);

ERROR_IF(res_o == NULL, error);

res = PyStackRef_FromPyObjectSteal(res_o);

}

macro(BINARY_OP_ADD_UNICODE) =

_GUARD_BOTH_UNICODE + unused/1 + _BINARY_OP_ADD_UNICODE;

// This is a subtle one. It's a super-instruction for

// BINARY_OP_ADD_UNICODE followed by STORE_FAST

// where the store goes into the left argument.

// So the inputs are the same as for all BINARY_OP

// specializations, but there is no output.

// At the end we just skip over the STORE_FAST.

op(_BINARY_OP_INPLACE_ADD_UNICODE, (left, right --)) {

PyObject *left_o = PyStackRef_AsPyObjectBorrow(left);

PyObject *right_o = PyStackRef_AsPyObjectBorrow(right);

int next_oparg;

#if TIER_ONE

assert(next_instr->op.code == STORE_FAST);

next_oparg = next_instr->op.arg;

#else

next_oparg = CURRENT_OPERAND();

#endif

_PyStackRef *target_local = &GETLOCAL(next_oparg);

DEOPT_IF(!PyStackRef_Is(*target_local, left));

STAT_INC(BINARY_OP, hit);

/* Handle `left = left + right` or `left += right` for str.

*

* When possible, extend `left` in place rather than

* allocating a new PyUnicodeObject. This attempts to avoid

* quadratic behavior when one neglects to use str.join().

*

* If `left` has only two references remaining (one from

* the stack, one in the locals), DECREFing `left` leaves

* only the locals reference, so PyUnicode_Append knows

* that the string is safe to mutate.

*/

assert(Py_REFCNT(left_o) >= 2);

_Py_DECREF_NO_DEALLOC(left_o);

PyObject *temp = PyStackRef_AsPyObjectBorrow(*target_local);

PyUnicode_Append(&temp, right_o);

*target_local = PyStackRef_FromPyObjectSteal(temp);

_Py_DECREF_SPECIALIZED(right_o, _PyUnicode_ExactDealloc);

ERROR_IF(PyStackRef_IsNull(*target_local), error);

#if TIER_ONE

// The STORE_FAST is already done. This is done here in tier one,

// and during trace projection in tier two:

assert(next_instr->op.code == STORE_FAST);

SKIP_OVER(1);

#endif

}

macro(BINARY_OP_INPLACE_ADD_UNICODE) =

_GUARD_BOTH_UNICODE + unused/1 + _BINARY_OP_INPLACE_ADD_UNICODE;

family(BINARY_SUBSCR, INLINE_CACHE_ENTRIES_BINARY_SUBSCR) = {

BINARY_SUBSCR_DICT,

BINARY_SUBSCR_GETITEM,

BINARY_SUBSCR_LIST_INT,

BINARY_SUBSCR_STR_INT,

BINARY_SUBSCR_TUPLE_INT,

};

specializing op(_SPECIALIZE_BINARY_SUBSCR, (counter/1, container, sub -- container, sub)) {

#if ENABLE_SPECIALIZATION

if (ADAPTIVE_COUNTER_TRIGGERS(counter)) {

next_instr = this_instr;

_Py_Specialize_BinarySubscr(container, sub, next_instr);

DISPATCH_SAME_OPARG();

}

STAT_INC(BINARY_SUBSCR, deferred);

ADVANCE_ADAPTIVE_COUNTER(this_instr[1].counter);

#endif /* ENABLE_SPECIALIZATION */

}

op(_BINARY_SUBSCR, (container, sub -- res)) {

PyObject *container_o = PyStackRef_AsPyObjectBorrow(container);

PyObject *sub_o = PyStackRef_AsPyObjectBorrow(sub);

PyObject *res_o = PyObject_GetItem(container_o, sub_o);

DECREF_INPUTS();

ERROR_IF(res_o == NULL, error);

res = PyStackRef_FromPyObjectSteal(res_o);

}

macro(BINARY_SUBSCR) = _SPECIALIZE_BINARY_SUBSCR + _BINARY_SUBSCR;

inst(BINARY_SLICE, (container, start, stop -- res)) {

PyObject *slice = _PyBuildSlice_ConsumeRefs(PyStackRef_AsPyObjectSteal(start),

PyStackRef_AsPyObjectSteal(stop));

PyObject *res_o;

// Can't use ERROR_IF() here, because we haven't

// DECREF'ed container yet, and we still own slice.

if (slice == NULL) {

res_o = NULL;

}

else {

res_o = PyObject_GetItem(PyStackRef_AsPyObjectBorrow(container), slice);

Py_DECREF(slice);

}

PyStackRef_CLOSE(container);

ERROR_IF(res_o == NULL, error);

res = PyStackRef_FromPyObjectSteal(res_o);

}

inst(STORE_SLICE, (v, container, start, stop -- )) {

PyObject *slice = _PyBuildSlice_ConsumeRefs(PyStackRef_AsPyObjectSteal(start),

PyStackRef_AsPyObjectSteal(stop));

int err;

if (slice == NULL) {

err = 1;

}

else {

err = PyObject_SetItem(PyStackRef_AsPyObjectBorrow(container), slice, PyStackRef_AsPyObjectBorrow(v));

Py_DECREF(slice);

}

PyStackRef_CLOSE(v);

PyStackRef_CLOSE(container);

ERROR_IF(err, error);

}

inst(BINARY_SUBSCR_LIST_INT, (unused/1, list_st, sub_st -- res)) {

PyObject *sub = PyStackRef_AsPyObjectBorrow(sub_st);

PyObject *list = PyStackRef_AsPyObjectBorrow(list_st);

DEOPT_IF(!PyLong_CheckExact(sub));

DEOPT_IF(!PyList_CheckExact(list));

// Deopt unless 0 <= sub < PyList_Size(list)

DEOPT_IF(!_PyLong_IsNonNegativeCompact((PyLongObject *)sub));

Py_ssize_t index = ((PyLongObject*)sub)->long_value.ob_digit[0];

DEOPT_IF(index >= PyList_GET_SIZE(list));

STAT_INC(BINARY_SUBSCR, hit);

PyObject *res_o = PyList_GET_ITEM(list, index);

assert(res_o != NULL);

Py_INCREF(res_o);

_Py_DECREF_SPECIALIZED(sub, (destructor)PyObject_Free);

PyStackRef_CLOSE(list_st);

res = PyStackRef_FromPyObjectSteal(res_o);

}

inst(BINARY_SUBSCR_STR_INT, (unused/1, str_st, sub_st -- res)) {

PyObject *sub = PyStackRef_AsPyObjectBorrow(sub_st);

PyObject *str = PyStackRef_AsPyObjectBorrow(str_st);

DEOPT_IF(!PyLong_CheckExact(sub));

DEOPT_IF(!PyUnicode_CheckExact(str));

DEOPT_IF(!_PyLong_IsNonNegativeCompact((PyLongObject *)sub));

Py_ssize_t index = ((PyLongObject*)sub)->long_value.ob_digit[0];

DEOPT_IF(PyUnicode_GET_LENGTH(str) <= index);

// Specialize for reading an ASCII character from any string:

Py_UCS4 c = PyUnicode_READ_CHAR(str, index);

DEOPT_IF(Py_ARRAY_LENGTH(_Py_SINGLETON(strings).ascii) <= c);

STAT_INC(BINARY_SUBSCR, hit);

PyObject *res_o = (PyObject*)&_Py_SINGLETON(strings).ascii[c];

_Py_DECREF_SPECIALIZED(sub, (destructor)PyObject_Free);

PyStackRef_CLOSE(str_st);

res = PyStackRef_FromPyObjectSteal(res_o);

}

inst(BINARY_SUBSCR_TUPLE_INT, (unused/1, tuple_st, sub_st -- res)) {

PyObject *sub = PyStackRef_AsPyObjectBorrow(sub_st);

PyObject *tuple = PyStackRef_AsPyObjectBorrow(tuple_st);

DEOPT_IF(!PyLong_CheckExact(sub));

DEOPT_IF(!PyTuple_CheckExact(tuple));

// Deopt unless 0 <= sub < PyTuple_Size(list)

DEOPT_IF(!_PyLong_IsNonNegativeCompact((PyLongObject *)sub));

Py_ssize_t index = ((PyLongObject*)sub)->long_value.ob_digit[0];

DEOPT_IF(index >= PyTuple_GET_SIZE(tuple));

STAT_INC(BINARY_SUBSCR, hit);

PyObject *res_o = PyTuple_GET_ITEM(tuple, index);

assert(res_o != NULL);

Py_INCREF(res_o);

_Py_DECREF_SPECIALIZED(sub, (destructor)PyObject_Free);

PyStackRef_CLOSE(tuple_st);

res = PyStackRef_FromPyObjectSteal(res_o);

}

inst(BINARY_SUBSCR_DICT, (unused/1, dict_st, sub_st -- res)) {

PyObject *sub = PyStackRef_AsPyObjectBorrow(sub_st);

PyObject *dict = PyStackRef_AsPyObjectBorrow(dict_st);

DEOPT_IF(!PyDict_CheckExact(dict));

STAT_INC(BINARY_SUBSCR, hit);

PyObject *res_o;

int rc = PyDict_GetItemRef(dict, sub, &res_o);

if (rc == 0) {

_PyErr_SetKeyError(sub);

}

DECREF_INPUTS();

ERROR_IF(rc <= 0, error); // not found or error

res = PyStackRef_FromPyObjectSteal(res_o);

}

op(_BINARY_SUBSCR_CHECK_FUNC, (container, unused -- container, unused)) {

PyTypeObject *tp = Py_TYPE(PyStackRef_AsPyObjectBorrow(container));

DEOPT_IF(!PyType_HasFeature(tp, Py_TPFLAGS_HEAPTYPE));

PyHeapTypeObject *ht = (PyHeapTypeObject *)tp;

PyObject *getitem = ht->_spec_cache.getitem;

DEOPT_IF(getitem == NULL);

assert(PyFunction_Check(getitem));

uint32_t cached_version = ht->_spec_cache.getitem_version;

DEOPT_IF(((PyFunctionObject *)getitem)->func_version != cached_version);

PyCodeObject *code = (PyCodeObject *)PyFunction_GET_CODE(getitem);

assert(code->co_argcount == 2);

DEOPT_IF(!_PyThreadState_HasStackSpace(tstate, code->co_framesize));

STAT_INC(BINARY_SUBSCR, hit);

Py_INCREF(getitem);

}

op(_BINARY_SUBSCR_INIT_CALL, (container, sub -- new_frame: _PyInterpreterFrame* )) {

PyTypeObject *tp = Py_TYPE(PyStackRef_AsPyObjectBorrow(container));

PyHeapTypeObject *ht = (PyHeapTypeObject *)tp;

PyObject *getitem = ht->_spec_cache.getitem;

new_frame = _PyFrame_PushUnchecked(tstate, (PyFunctionObject *)getitem, 2);

SYNC_SP();

new_frame->localsplus[0] = container;

new_frame->localsplus[1] = sub;

frame->return_offset = (uint16_t)(1 + INLINE_CACHE_ENTRIES_BINARY_SUBSCR);

}

macro(BINARY_SUBSCR_GETITEM) =

unused/1 + // Skip over the counter

_CHECK_PEP_523 +

_BINARY_SUBSCR_CHECK_FUNC +

_BINARY_SUBSCR_INIT_CALL +

_PUSH_FRAME;

inst(LIST_APPEND, (list, unused[oparg-1], v -- list, unused[oparg-1])) {

ERROR_IF(_PyList_AppendTakeRef((PyListObject *)PyStackRef_AsPyObjectBorrow(list),

PyStackRef_AsPyObjectSteal(v)) < 0, error);

}

inst(SET_ADD, (set, unused[oparg-1], v -- set, unused[oparg-1])) {

int err = PySet_Add(PyStackRef_AsPyObjectBorrow(set),

PyStackRef_AsPyObjectBorrow(v));

DECREF_INPUTS();

ERROR_IF(err, error);

}

family(STORE_SUBSCR, INLINE_CACHE_ENTRIES_STORE_SUBSCR) = {

STORE_SUBSCR_DICT,

STORE_SUBSCR_LIST_INT,

};

specializing op(_SPECIALIZE_STORE_SUBSCR, (counter/1, container, sub -- container, sub)) {

#if ENABLE_SPECIALIZATION

if (ADAPTIVE_COUNTER_TRIGGERS(counter)) {

next_instr = this_instr;

_Py_Specialize_StoreSubscr(container, sub, next_instr);

DISPATCH_SAME_OPARG();

}

STAT_INC(STORE_SUBSCR, deferred);

ADVANCE_ADAPTIVE_COUNTER(this_instr[1].counter);

#endif /* ENABLE_SPECIALIZATION */

}

op(_STORE_SUBSCR, (v, container, sub -- )) {

/* container[sub] = v */

int err = PyObject_SetItem(PyStackRef_AsPyObjectBorrow(container), PyStackRef_AsPyObjectBorrow(sub), PyStackRef_AsPyObjectBorrow(v));

DECREF_INPUTS();

ERROR_IF(err, error);

}

macro(STORE_SUBSCR) = _SPECIALIZE_STORE_SUBSCR + _STORE_SUBSCR;

inst(STORE_SUBSCR_LIST_INT, (unused/1, value, list_st, sub_st -- )) {

PyObject *sub = PyStackRef_AsPyObjectBorrow(sub_st);

PyObject *list = PyStackRef_AsPyObjectBorrow(list_st);

DEOPT_IF(!PyLong_CheckExact(sub));

DEOPT_IF(!PyList_CheckExact(list));

// Ensure nonnegative, zero-or-one-digit ints.

DEOPT_IF(!_PyLong_IsNonNegativeCompact((PyLongObject *)sub));

Py_ssize_t index = ((PyLongObject*)sub)->long_value.ob_digit[0];

// Ensure index < len(list)

DEOPT_IF(index >= PyList_GET_SIZE(list));

STAT_INC(STORE_SUBSCR, hit);

PyObject *old_value = PyList_GET_ITEM(list, index);

PyList_SET_ITEM(list, index, PyStackRef_AsPyObjectSteal(value));

assert(old_value != NULL);

Py_DECREF(old_value);

_Py_DECREF_SPECIALIZED(sub, (destructor)PyObject_Free);

PyStackRef_CLOSE(list_st);

}

inst(STORE_SUBSCR_DICT, (unused/1, value, dict_st, sub -- )) {

PyObject *dict = PyStackRef_AsPyObjectBorrow(dict_st);

DEOPT_IF(!PyDict_CheckExact(dict));

STAT_INC(STORE_SUBSCR, hit);

int err = _PyDict_SetItem_Take2((PyDictObject *)dict,

PyStackRef_AsPyObjectSteal(sub),

PyStackRef_AsPyObjectSteal(value));

PyStackRef_CLOSE(dict_st);

ERROR_IF(err, error);

}

inst(DELETE_SUBSCR, (container, sub --)) {

/* del container[sub] */

int err = PyObject_DelItem(PyStackRef_AsPyObjectBorrow(container),

PyStackRef_AsPyObjectBorrow(sub));

DECREF_INPUTS();

ERROR_IF(err, error);

}

inst(CALL_INTRINSIC_1, (value -- res)) {

assert(oparg <= MAX_INTRINSIC_1);

PyObject *res_o = _PyIntrinsics_UnaryFunctions[oparg].func(tstate, PyStackRef_AsPyObjectBorrow(value));

DECREF_INPUTS();

ERROR_IF(res_o == NULL, error);

res = PyStackRef_FromPyObjectSteal(res_o);

}

inst(CALL_INTRINSIC_2, (value2_st, value1_st -- res)) {

assert(oparg <= MAX_INTRINSIC_2);

PyObject *value1 = PyStackRef_AsPyObjectBorrow(value1_st);

PyObject *value2 = PyStackRef_AsPyObjectBorrow(value2_st);

PyObject *res_o = _PyIntrinsics_BinaryFunctions[oparg].func(tstate, value2, value1);

DECREF_INPUTS();

ERROR_IF(res_o == NULL, error);

res = PyStackRef_FromPyObjectSteal(res_o);

}

tier1 inst(RAISE_VARARGS, (args[oparg] -- )) {

PyObject *cause = NULL, *exc = NULL;

switch (oparg) {

case 2:

cause = PyStackRef_AsPyObjectSteal(args[1]);

_Py_FALLTHROUGH;

case 1:

exc = PyStackRef_AsPyObjectSteal(args[0]);

_Py_FALLTHROUGH;

case 0:

if (do_raise(tstate, exc, cause)) {

assert(oparg == 0);

monitor_reraise(tstate, frame, this_instr);

goto exception_unwind;

}

break;

default:

_PyErr_SetString(tstate, PyExc_SystemError,

"bad RAISE_VARARGS oparg");

break;

}

ERROR_IF(true, error);

}

tier1 inst(INTERPRETER_EXIT, (retval --)) {

assert(frame == &entry_frame);

assert(_PyFrame_IsIncomplete(frame));

/* Restore previous frame and return. */

tstate->current_frame = frame->previous;

assert(!_PyErr_Occurred(tstate));

tstate->c_recursion_remaining += PY_EVAL_C_STACK_UNITS;

return PyStackRef_AsPyObjectSteal(retval);

}

// The stack effect here is ambiguous.

// We definitely pop the return value off the stack on entry.

// We also push it onto the stack on exit, but that's a

// different frame, and it's accounted for by _PUSH_FRAME.

inst(RETURN_VALUE, (retval -- res)) {

#if TIER_ONE

assert(frame != &entry_frame);

#endif

SYNC_SP();

_PyFrame_SetStackPointer(frame, stack_pointer);

assert(EMPTY());

_Py_LeaveRecursiveCallPy(tstate);

// GH-99729: We need to unlink the frame *before* clearing it:

_PyInterpreterFrame *dying = frame;

frame = tstate->current_frame = dying->previous;

_PyEval_FrameClearAndPop(tstate, dying);

LOAD_SP();

LOAD_IP(frame->return_offset);

res = retval;

LLTRACE_RESUME_FRAME();

}

tier1 op(_RETURN_VALUE_EVENT, (val -- val)) {

int err = _Py_call_instrumentation_arg(

tstate, PY_MONITORING_EVENT_PY_RETURN,

frame, this_instr, PyStackRef_AsPyObjectBorrow(val));

if (err) ERROR_NO_POP();

}

macro(INSTRUMENTED_RETURN_VALUE) =

_RETURN_VALUE_EVENT +

RETURN_VALUE;

macro(RETURN_CONST) =

LOAD_CONST +

RETURN_VALUE;

macro(INSTRUMENTED_RETURN_CONST) =

LOAD_CONST +

_RETURN_VALUE_EVENT +

RETURN_VALUE;

inst(GET_AITER, (obj -- iter)) {

unaryfunc getter = NULL;

PyObject *obj_o = PyStackRef_AsPyObjectBorrow(obj);

PyObject *iter_o;

PyTypeObject *type = Py_TYPE(obj_o);

if (type->tp_as_async != NULL) {

getter = type->tp_as_async->am_aiter;

}

if (getter == NULL) {

_PyErr_Format(tstate, PyExc_TypeError,

"'async for' requires an object with "

"__aiter__ method, got %.100s",

type->tp_name);

DECREF_INPUTS();

ERROR_IF(true, error);

}

iter_o = (*getter)(obj_o);

DECREF_INPUTS();