Coverage Report

Created: 2026-06-21 06:15

next uncovered line (L), next uncovered region (R), next uncovered branch (B)
/src/cpython/Python/ceval_macros.h
Line
Count
Source
1
// Macros and other things needed by ceval.c, and bytecodes.c
2
3
/* Computed GOTOs, or
4
       the-optimization-commonly-but-improperly-known-as-"threaded code"
5
   using gcc's labels-as-values extension
6
   (http://gcc.gnu.org/onlinedocs/gcc/Labels-as-Values.html).
7
8
   The traditional bytecode evaluation loop uses a "switch" statement, which
9
   decent compilers will optimize as a single indirect branch instruction
10
   combined with a lookup table of jump addresses. However, since the
11
   indirect jump instruction is shared by all opcodes, the CPU will have a
12
   hard time making the right prediction for where to jump next (actually,
13
   it will be always wrong except in the uncommon case of a sequence of
14
   several identical opcodes).
15
16
   "Threaded code" in contrast, uses an explicit jump table and an explicit
17
   indirect jump instruction at the end of each opcode. Since the jump
18
   instruction is at a different address for each opcode, the CPU will make a
19
   separate prediction for each of these instructions, which is equivalent to
20
   predicting the second opcode of each opcode pair. These predictions have
21
   a much better chance to turn out valid, especially in small bytecode loops.
22
23
   A mispredicted branch on a modern CPU flushes the whole pipeline and
24
   can cost several CPU cycles (depending on the pipeline depth),
25
   and potentially many more instructions (depending on the pipeline width).
26
   A correctly predicted branch, however, is nearly free.
27
28
   At the time of this writing, the "threaded code" version is up to 15-20%
29
   faster than the normal "switch" version, depending on the compiler and the
30
   CPU architecture.
31
32
   NOTE: care must be taken that the compiler doesn't try to "optimize" the
33
   indirect jumps by sharing them between all opcodes. Such optimizations
34
   can be disabled on gcc by using the -fno-gcse flag (or possibly
35
   -fno-crossjumping).
36
*/
37
38
/* Use macros rather than inline functions, to make it as clear as possible
39
 * to the C compiler that the tracing check is a simple test then branch.
40
 * We want to be sure that the compiler knows this before it generates
41
 * the CFG.
42
 */
43
44
#ifdef WITH_DTRACE
45
#define OR_DTRACE_LINE | (PyDTrace_LINE_ENABLED() ? 255 : 0)
46
#else
47
#define OR_DTRACE_LINE
48
#endif
49
50
#ifdef HAVE_COMPUTED_GOTOS
51
    #ifndef USE_COMPUTED_GOTOS
52
    #define USE_COMPUTED_GOTOS 1
53
    #endif
54
#else
55
    #if defined(USE_COMPUTED_GOTOS) && USE_COMPUTED_GOTOS
56
    #error "Computed gotos are not supported on this compiler."
57
    #endif
58
    #undef USE_COMPUTED_GOTOS
59
    #define USE_COMPUTED_GOTOS 0
60
#endif
61
62
#ifdef Py_STATS
63
#define INSTRUCTION_STATS(op) \
64
    do { \
65
        PyStats *s = _PyStats_GET(); \
66
        OPCODE_EXE_INC(op); \
67
        if (s) s->opcode_stats[lastopcode].pair_count[op]++; \
68
        lastopcode = op; \
69
    } while (0)
70
#else
71
40.5G
#define INSTRUCTION_STATS(op) ((void)0)
72
#endif
73
74
#ifdef Py_STATS
75
#   define TAIL_CALL_PARAMS _PyInterpreterFrame *frame, _PyStackRef *stack_pointer, PyThreadState *tstate, _Py_CODEUNIT *next_instr, const void *instruction_funcptr_table, int oparg, int lastopcode
76
#   define TAIL_CALL_ARGS frame, stack_pointer, tstate, next_instr, instruction_funcptr_table, oparg, lastopcode
77
#else
78
#   define TAIL_CALL_PARAMS _PyInterpreterFrame *frame, _PyStackRef *stack_pointer, PyThreadState *tstate, _Py_CODEUNIT *next_instr, const void *instruction_funcptr_table, int oparg
79
#   define TAIL_CALL_ARGS frame, stack_pointer, tstate, next_instr, instruction_funcptr_table, oparg
80
#endif
81
82
#if _Py_TAIL_CALL_INTERP
83
#   if defined(__clang__) || defined(__GNUC__)
84
#       if !_Py__has_attribute(preserve_none) || !_Py__has_attribute(musttail)
85
#           error "This compiler does not have support for efficient tail calling."
86
#       endif
87
#   elif defined(_MSC_VER) && (_MSC_VER < 1950)
88
#       error "You need at least VS 2026 / PlatformToolset v145 for tail calling."
89
#   endif
90
#   if defined(_MSC_VER) && !defined(__clang__)
91
#      define Py_MUSTTAIL [[msvc::musttail]]
92
#      define Py_PRESERVE_NONE_CC __preserve_none
93
#   else
94
#       define Py_MUSTTAIL __attribute__((musttail))
95
#       define Py_PRESERVE_NONE_CC __attribute__((preserve_none))
96
#   endif
97
    typedef PyObject *(Py_PRESERVE_NONE_CC *py_tail_call_funcptr)(TAIL_CALL_PARAMS);
98
99
#   define DISPATCH_TABLE_VAR instruction_funcptr_table
100
#   define DISPATCH_TABLE instruction_funcptr_handler_table
101
#   define TRACING_DISPATCH_TABLE instruction_funcptr_tracing_table
102
#   define TARGET(op) Py_NO_INLINE PyObject *Py_PRESERVE_NONE_CC _TAIL_CALL_##op(TAIL_CALL_PARAMS)
103
104
#   define DISPATCH_GOTO() \
105
        do { \
106
            Py_MUSTTAIL return (((py_tail_call_funcptr *)instruction_funcptr_table)[opcode])(TAIL_CALL_ARGS); \
107
        } while (0)
108
#   define DISPATCH_GOTO_NON_TRACING() \
109
        do { \
110
            Py_MUSTTAIL return (((py_tail_call_funcptr *)DISPATCH_TABLE)[opcode])(TAIL_CALL_ARGS); \
111
        } while (0)
112
#   define JUMP_TO_LABEL(name) \
113
        do { \
114
            Py_MUSTTAIL return (_TAIL_CALL_##name)(TAIL_CALL_ARGS); \
115
        } while (0)
116
#   ifdef Py_STATS
117
#       define JUMP_TO_PREDICTED(name) \
118
            do { \
119
                Py_MUSTTAIL return (_TAIL_CALL_##name)(frame, stack_pointer, tstate, this_instr, instruction_funcptr_table, oparg, lastopcode); \
120
            } while (0)
121
#   else
122
#       define JUMP_TO_PREDICTED(name) \
123
            do { \
124
                Py_MUSTTAIL return (_TAIL_CALL_##name)(frame, stack_pointer, tstate, this_instr, instruction_funcptr_table, oparg); \
125
            } while (0)
126
#   endif
127
#    define LABEL(name) TARGET(name)
128
#elif USE_COMPUTED_GOTOS
129
#  define DISPATCH_TABLE_VAR opcode_targets
130
5.45M
#  define DISPATCH_TABLE opcode_targets_table
131
#  define TRACING_DISPATCH_TABLE opcode_tracing_targets_table
132
40.5G
#  define TARGET(op) TARGET_##op:
133
40.7G
#  define DISPATCH_GOTO() goto *opcode_targets[opcode]
134
5.45M
#  define DISPATCH_GOTO_NON_TRACING() goto *DISPATCH_TABLE[opcode];
135
176M
#  define JUMP_TO_LABEL(name) goto name;
136
203M
#  define JUMP_TO_PREDICTED(name) goto PREDICTED_##name;
137
485M
#  define LABEL(name) name:
138
#else
139
#  define TARGET(op) case op: TARGET_##op:
140
#  define DISPATCH_GOTO() dispatch_code = opcode | tracing_mode ; goto dispatch_opcode
141
#  define DISPATCH_GOTO_NON_TRACING() dispatch_code = opcode; goto dispatch_opcode
142
#  define JUMP_TO_LABEL(name) goto name;
143
#  define JUMP_TO_PREDICTED(name) goto PREDICTED_##name;
144
#  define LABEL(name) name:
145
#endif
146
147
#if (_Py_TAIL_CALL_INTERP || USE_COMPUTED_GOTOS) && _Py_TIER2
148
#  define IS_JIT_TRACING() (DISPATCH_TABLE_VAR == TRACING_DISPATCH_TABLE)
149
#  define ENTER_TRACING() \
150
    DISPATCH_TABLE_VAR = TRACING_DISPATCH_TABLE;
151
#  define LEAVE_TRACING() \
152
    DISPATCH_TABLE_VAR = DISPATCH_TABLE;
153
#else
154
#  define IS_JIT_TRACING() (tracing_mode != 0)
155
#  define ENTER_TRACING() tracing_mode = 255
156
#  define LEAVE_TRACING() tracing_mode = 0
157
#endif
158
159
#if _Py_TIER2
160
#define STOP_TRACING() \
161
    do { \
162
        if (IS_JIT_TRACING()) { \
163
            LEAVE_TRACING(); \
164
            _PyJit_FinalizeTracing(tstate, 0); \
165
        } \
166
    } while (0);
167
#else
168
153M
#define STOP_TRACING() ((void)(0));
169
#endif
170
171
/* PRE_DISPATCH_GOTO() does lltrace if enabled. Normally a no-op */
172
#ifdef Py_DEBUG
173
#define PRE_DISPATCH_GOTO() if (frame->lltrace >= 5) { \
174
    lltrace_instruction(frame, stack_pointer, next_instr, opcode, oparg); }
175
#else
176
40.7G
#define PRE_DISPATCH_GOTO() ((void)0)
177
#endif
178
179
#ifdef Py_DEBUG
180
#define LLTRACE_RESUME_FRAME() \
181
do { \
182
    _PyFrame_SetStackPointer(frame, stack_pointer); \
183
    int lltrace = maybe_lltrace_resume_frame(frame, GLOBALS()); \
184
    stack_pointer = _PyFrame_GetStackPointer(frame); \
185
    frame->lltrace = lltrace; \
186
} while (0)
187
#else
188
2.42G
#define LLTRACE_RESUME_FRAME() ((void)0)
189
#endif
190
191
#ifdef Py_GIL_DISABLED
192
#define QSBR_QUIESCENT_STATE(tstate) _Py_qsbr_quiescent_state(((_PyThreadStateImpl *)tstate)->qsbr)
193
#else
194
#define QSBR_QUIESCENT_STATE(tstate)
195
#endif
196
197
198
/* Do interpreter dispatch accounting for tracing and instrumentation */
199
#define DISPATCH() \
200
40.4G
    { \
201
40.4G
        _PyFrame_StackAssertInvalid(frame); \
202
40.4G
        NEXTOPARG(); \
203
40.4G
        PRE_DISPATCH_GOTO(); \
204
40.4G
        DISPATCH_GOTO(); \
205
40.4G
    }
206
207
#define DISPATCH_NON_TRACING() \
208
    { \
209
        _PyFrame_StackAssertInvalid(frame); \
210
        NEXTOPARG(); \
211
        PRE_DISPATCH_GOTO(); \
212
        DISPATCH_GOTO_NON_TRACING(); \
213
    }
214
215
#define DISPATCH_SAME_OPARG() \
216
5.45M
    { \
217
5.45M
        opcode = next_instr->op.code; \
218
5.45M
        PRE_DISPATCH_GOTO(); \
219
5.45M
        DISPATCH_GOTO_NON_TRACING(); \
220
5.45M
    }
221
222
#define DISPATCH_INLINED(NEW_FRAME)                              \
223
2.45M
    do {                                                         \
224
2.45M
        assert(!IS_PEP523_HOOKED(tstate));                       \
225
2.45M
        _PyFrame_SetStackPointer(frame, stack_pointer);          \
226
2.45M
        _PyFrame_StackPointerValidate(frame);                    \
227
2.45M
        assert((NEW_FRAME)->previous == frame);                  \
228
2.45M
        frame = tstate->current_frame = (NEW_FRAME);             \
229
2.45M
        CALL_STAT_INC(inlined_py_calls);                         \
230
2.45M
        JUMP_TO_LABEL(start_frame);                              \
231
0
    } while (0)
232
233
/* Tuple access macros */
234
235
#ifndef Py_DEBUG
236
1.65G
#define GETITEM(v, i) PyTuple_GET_ITEM((v), (i))
237
#else
238
static inline PyObject *
239
GETITEM(PyObject *v, Py_ssize_t i) {
240
    assert(PyTuple_Check(v));
241
    assert(i >= 0);
242
    assert(i < PyTuple_GET_SIZE(v));
243
    return PyTuple_GET_ITEM(v, i);
244
}
245
#endif
246
247
/* Code access macros */
248
249
/* The integer overflow is checked by an assertion below. */
250
79.6M
#define INSTR_OFFSET() ((int)(next_instr - _PyFrame_GetBytecode(frame)))
251
40.4G
#define NEXTOPARG()  do { \
252
40.4G
        _Py_CODEUNIT word  = {.cache = FT_ATOMIC_LOAD_UINT16_RELAXED(*(uint16_t*)next_instr)}; \
253
40.4G
        opcode = word.op.code; \
254
40.4G
        oparg = word.op.arg; \
255
40.4G
    } while (0)
256
257
/* JUMPBY makes the generator identify the instruction as a jump. SKIP_OVER is
258
 * for advancing to the next instruction, taking into account cache entries
259
 * and skipped instructions.
260
 */
261
6.32G
#define JUMPBY(x)       (next_instr += (x))
262
#define SKIP_OVER(x)    (next_instr += (x))
263
264
#define STACK_LEVEL()     ((int)(stack_pointer - _PyFrame_Stackbase(frame)))
265
#define STACK_SIZE()      (_PyFrame_GetCode(frame)->co_stacksize)
266
267
#define WITHIN_STACK_BOUNDS() \
268
   (frame->owner == FRAME_OWNED_BY_INTERPRETER || (STACK_LEVEL() >= 0 && STACK_LEVEL() <= STACK_SIZE()))
269
270
#if defined(Py_DEBUG) && !defined(_Py_JIT)
271
// This allows temporary stack "overflows", provided it's all in the cache at any point of time.
272
#define ASSERT_WITHIN_STACK_BOUNDS_IGNORING_CACHE(F, L) \
273
   assert(frame->owner == FRAME_OWNED_BY_INTERPRETER || (STACK_LEVEL() >= 0 && (STACK_LEVEL()) <= STACK_SIZE()))
274
#else
275
#define ASSERT_WITHIN_STACK_BOUNDS_IGNORING_CACHE ASSERT_WITHIN_STACK_BOUNDS
276
#endif
277
278
/* Data access macros */
279
#define FRAME_CO_CONSTS (_PyFrame_GetCode(frame)->co_consts)
280
#define FRAME_CO_NAMES  (_PyFrame_GetCode(frame)->co_names)
281
282
/* Local variable macros */
283
284
1.30M
#define LOCALS_ARRAY    (frame->localsplus)
285
16.9G
#define GETLOCAL(i)     (frame->localsplus[i])
286
287
288
#ifdef Py_STATS
289
#define UPDATE_MISS_STATS(INSTNAME)                              \
290
    do {                                                         \
291
        STAT_INC(opcode, miss);                                  \
292
        STAT_INC((INSTNAME), miss);                              \
293
        /* The counter is always the first cache entry: */       \
294
        if (ADAPTIVE_COUNTER_TRIGGERS(next_instr->cache)) {      \
295
            STAT_INC((INSTNAME), deopt);                         \
296
        }                                                        \
297
    } while (0)
298
#else
299
203M
#define UPDATE_MISS_STATS(INSTNAME) ((void)0)
300
#endif
301
302
303
// Try to lock an object in the free threading build, if it's not already
304
// locked. Use with a DEOPT_IF() to deopt if the object is already locked.
305
// These are no-ops in the default GIL build. The general pattern is:
306
//
307
// DEOPT_IF(!LOCK_OBJECT(op));
308
// if (/* condition fails */) {
309
//     UNLOCK_OBJECT(op);
310
//     DEOPT_IF(true);
311
//  }
312
//  ...
313
//  UNLOCK_OBJECT(op);
314
//
315
// NOTE: The object must be unlocked on every exit code path and you should
316
// avoid any potentially escaping calls (like PyStackRef_CLOSE) while the
317
// object is locked.
318
#ifdef Py_GIL_DISABLED
319
#  define LOCK_OBJECT(op) PyMutex_LockFast(&(_PyObject_CAST(op))->ob_mutex)
320
#  define UNLOCK_OBJECT(op) PyMutex_Unlock(&(_PyObject_CAST(op))->ob_mutex)
321
#else
322
692M
#  define LOCK_OBJECT(op) (1)
323
692M
#  define UNLOCK_OBJECT(op) ((void)0)
324
#endif
325
326
1.81G
#define GLOBALS() frame->f_globals
327
694M
#define BUILTINS() frame->f_builtins
328
4.03M
#define LOCALS() frame->f_locals
329
#define CONSTS() _PyFrame_GetCode(frame)->co_consts
330
#define NAMES() _PyFrame_GetCode(frame)->co_names
331
332
#if defined(WITH_DTRACE) && !defined(Py_BUILD_CORE_MODULE)
333
static void dtrace_function_entry(_PyInterpreterFrame *);
334
static void dtrace_function_return(_PyInterpreterFrame *);
335
336
#define DTRACE_FUNCTION_ENTRY()  \
337
    if (PyDTrace_FUNCTION_ENTRY_ENABLED()) { \
338
        dtrace_function_entry(frame); \
339
    }
340
341
#define DTRACE_FUNCTION_RETURN() \
342
    if (PyDTrace_FUNCTION_RETURN_ENABLED()) { \
343
        dtrace_function_return(frame); \
344
    }
345
#else
346
1.24G
#define DTRACE_FUNCTION_ENTRY() ((void)0)
347
1.22G
#define DTRACE_FUNCTION_RETURN() ((void)0)
348
#endif
349
350
/* This takes a uint16_t instead of a _Py_BackoffCounter,
351
 * because it is used directly on the cache entry in generated code,
352
 * which is always an integral type. */
353
// Force re-specialization when tracing a side exit to get good side exits.
354
#define ADAPTIVE_COUNTER_TRIGGERS(COUNTER) \
355
1.54G
    backoff_counter_triggers(forge_backoff_counter((COUNTER)))
356
357
#define ADVANCE_ADAPTIVE_COUNTER(COUNTER) \
358
1.54G
    do { \
359
1.54G
        (COUNTER) = advance_backoff_counter((COUNTER)); \
360
1.54G
    } while (0);
361
362
#define PAUSE_ADAPTIVE_COUNTER(COUNTER) \
363
0
    do { \
364
0
        (COUNTER) = pause_backoff_counter((COUNTER)); \
365
0
    } while (0);
366
367
#ifdef ENABLE_SPECIALIZATION
368
/* Multiple threads may execute these concurrently if thread-local bytecode is
369
 * disabled and they all execute the main copy of the bytecode. Specialization
370
 * is disabled in that case so the value is unused, but the RMW cycle should be
371
 * free of data races.
372
 */
373
#define RECORD_BRANCH_TAKEN(bitset, flag) \
374
3.16G
    FT_ATOMIC_STORE_UINT16_RELAXED(       \
375
3.16G
        bitset, (FT_ATOMIC_LOAD_UINT16_RELAXED(bitset) << 1) | (flag))
376
#else
377
#define RECORD_BRANCH_TAKEN(bitset, flag)
378
#endif
379
380
#define UNBOUNDLOCAL_ERROR_MSG \
381
0
    "cannot access local variable '%s' where it is not associated with a value"
382
#define UNBOUNDFREE_ERROR_MSG \
383
0
    "cannot access free variable '%s' where it is not associated with a value" \
384
0
    " in enclosing scope"
385
6
#define NAME_ERROR_MSG "name '%.200s' is not defined"
386
387
// If a trace function sets a new f_lineno and
388
// *then* raises, we use the destination when searching
389
// for an exception handler, displaying the traceback, and so on
390
0
#define INSTRUMENTED_JUMP(src, dest, event) \
391
0
do { \
392
0
    if (tstate->tracing) {\
393
0
        next_instr = dest; \
394
0
    } else { \
395
0
        _PyFrame_SetStackPointer(frame, stack_pointer); \
396
0
        next_instr = _Py_call_instrumentation_jump(this_instr, tstate, event, frame, src, dest); \
397
0
        stack_pointer = _PyFrame_GetStackPointer(frame); \
398
0
        if (next_instr == NULL) { \
399
0
            next_instr = (dest)+1; \
400
0
            JUMP_TO_LABEL(error); \
401
0
        } \
402
0
    } \
403
0
} while (0);
404
405
406
239M
static inline int _Py_EnterRecursivePy(PyThreadState *tstate) {
407
239M
    return (tstate->py_recursion_remaining-- <= 0) &&
408
296
        _Py_CheckRecursiveCallPy(tstate);
409
239M
}
410
411
1.24G
static inline void _Py_LeaveRecursiveCallPy(PyThreadState *tstate)  {
412
1.24G
    tstate->py_recursion_remaining++;
413
1.24G
}
414
415
/* Implementation of "macros" that modify the instruction pointer,
416
 * stack pointer, or frame pointer.
417
 * These need to treated differently by tier 1 and 2.
418
 * The Tier 1 version is here; Tier 2 is inlined in ceval.c. */
419
420
2.20G
#define LOAD_IP(OFFSET) do { \
421
2.20G
        next_instr = frame->instr_ptr + (OFFSET); \
422
2.20G
    } while (0)
423
424
/* There's no STORE_IP(), it's inlined by the code generator. */
425
426
#define LOAD_SP() \
427
stack_pointer = _PyFrame_GetStackPointer(frame)
428
429
#define SAVE_SP() \
430
_PyFrame_SetStackPointer(frame, stack_pointer)
431
432
/* Tier-switching macros. */
433
434
#define TIER1_TO_TIER2(EXECUTOR)                        \
435
do {                                                   \
436
    OPT_STAT_INC(traces_executed);                     \
437
    next_instr = _Py_jit_entry((EXECUTOR), frame, stack_pointer, tstate); \
438
    frame = tstate->current_frame;                     \
439
    stack_pointer = _PyFrame_GetStackPointer(frame);   \
440
    int keep_tracing_bit = (uintptr_t)next_instr & 1;   \
441
    next_instr = (_Py_CODEUNIT *)(((uintptr_t)next_instr) & (~1)); \
442
    if (next_instr == NULL) {                          \
443
        /* gh-140104: The exception handler expects frame->instr_ptr
444
            to after this_instr, not this_instr! */ \
445
        next_instr = frame->instr_ptr + 1;                 \
446
        JUMP_TO_LABEL(error);                          \
447
    }                                                  \
448
    if (keep_tracing_bit) { \
449
        assert(uop_buffer_length(&((_PyThreadStateImpl *)tstate)->jit_tracer_state->code_buffer)); \
450
        ENTER_TRACING(); \
451
        DISPATCH_NON_TRACING(); \
452
    } \
453
    DISPATCH();                                        \
454
} while (0)
455
456
#define TIER2_TO_TIER2(EXECUTOR) \
457
do {                                                   \
458
    OPT_STAT_INC(traces_executed);                     \
459
    current_executor = (EXECUTOR);                     \
460
    goto tier2_start;                                  \
461
} while (0)
462
463
#define GOTO_TIER_ONE_SETUP \
464
    tstate->current_executor = NULL;                              \
465
    OPT_HIST(trace_uop_execution_counter, trace_run_length_hist); \
466
    _PyFrame_SetStackPointer(frame, stack_pointer);
467
468
#define GOTO_TIER_ONE(TARGET) \
469
    do \
470
    { \
471
        GOTO_TIER_ONE_SETUP \
472
        return (_Py_CODEUNIT *)(TARGET); \
473
    } while (0)
474
475
#define GOTO_TIER_ONE_CONTINUE_TRACING(TARGET) \
476
    do \
477
    { \
478
        GOTO_TIER_ONE_SETUP \
479
        return (_Py_CODEUNIT *)(((uintptr_t)(TARGET))| 1); \
480
    } while (0)
481
482
#define CURRENT_OPARG()    (next_uop[-1].oparg)
483
#define CURRENT_OPERAND0_64() (next_uop[-1].operand0)
484
#define CURRENT_OPERAND1_64() (next_uop[-1].operand1)
485
#define CURRENT_OPERAND0_32() (next_uop[-1].operand0)
486
#define CURRENT_OPERAND1_32() (next_uop[-1].operand1)
487
#define CURRENT_OPERAND0_16() (next_uop[-1].operand0)
488
#define CURRENT_OPERAND1_16() (next_uop[-1].operand1)
489
#define CURRENT_TARGET()   (next_uop[-1].target)
490
491
#define JUMP_TO_JUMP_TARGET() goto jump_to_jump_target
492
#define JUMP_TO_ERROR() goto jump_to_error_target
493
494
/* Stackref macros */
495
496
/* How much scratch space to give stackref to PyObject* conversion. */
497
988M
#define MAX_STACKREF_SCRATCH 10
498
499
#define STACKREFS_TO_PYOBJECTS(ARGS, ARG_COUNT, NAME) \
500
    /* +1 because vectorcall might use -1 to write self */ \
501
988M
    PyObject *NAME##_temp[MAX_STACKREF_SCRATCH+1]; \
502
988M
    PyObject **NAME = _PyObjectArray_FromStackRefArray(ARGS, ARG_COUNT, NAME##_temp);
503
504
#define STACKREFS_TO_PYOBJECTS_CLEANUP(NAME) \
505
    /* +1 because we +1 previously */ \
506
988M
    _PyObjectArray_Free(NAME - 1, NAME##_temp);
507
508
988M
#define CONVERSION_FAILED(NAME) ((NAME) == NULL)
509
510
#if defined(Py_DEBUG) && !defined(_Py_JIT)
511
#define SET_CURRENT_CACHED_VALUES(N) current_cached_values = (N)
512
#define CHECK_CURRENT_CACHED_VALUES(N) assert(current_cached_values == (N))
513
#else
514
#define SET_CURRENT_CACHED_VALUES(N) ((void)0)
515
#define CHECK_CURRENT_CACHED_VALUES(N) ((void)0)
516
#endif
517
518
1.05G
#define IS_PEP523_HOOKED(tstate) (tstate->interp->eval_frame != NULL)
519
520
static inline int
521
2.33G
check_periodics(PyThreadState *tstate) {
522
2.33G
    _Py_CHECK_EMSCRIPTEN_SIGNALS_PERIODICALLY();
523
2.33G
    QSBR_QUIESCENT_STATE(tstate);
524
2.33G
    if (_Py_atomic_load_uintptr_relaxed(&tstate->eval_breaker) & _PY_EVAL_EVENTS_MASK) {
525
101k
        return _Py_HandlePending(tstate);
526
101k
    }
527
2.33G
    return 0;
528
2.33G
}
529
530
// Mark the generator as executing. Returns true if the state was changed,
531
// false if it was already executing or finished.
532
static inline bool
533
gen_try_set_executing(PyGenObject *gen)
534
31.2M
{
535
#ifdef Py_GIL_DISABLED
536
    if (!_PyObject_IsUniquelyReferenced((PyObject *)gen)) {
537
        int8_t frame_state = _Py_atomic_load_int8_relaxed(&gen->gi_frame_state);
538
        while (frame_state < FRAME_SUSPENDED_YIELD_FROM_LOCKED) {
539
            if (_Py_atomic_compare_exchange_int8(&gen->gi_frame_state,
540
                                                 &frame_state,
541
                                                 FRAME_EXECUTING)) {
542
                return true;
543
            }
544
        }
545
        // NB: We return false for FRAME_SUSPENDED_YIELD_FROM_LOCKED as well.
546
        // That case is rare enough that we can just handle it in the deopt.
547
        return false;
548
    }
549
#endif
550
    // Use faster non-atomic modifications in the GIL-enabled build and when
551
    // the object is uniquely referenced in the free-threaded build.
552
31.2M
    if (gen->gi_frame_state < FRAME_EXECUTING) {
553
31.2M
        assert(gen->gi_frame_state != FRAME_SUSPENDED_YIELD_FROM_LOCKED);
554
31.2M
        gen->gi_frame_state = FRAME_EXECUTING;
555
31.2M
        return true;
556
31.2M
    }
557
0
    return false;
558
31.2M
}
559
560
// Macro for inplace float binary ops (tier 2 only).
561
// Mutates the uniquely-referenced TARGET operand in place.
562
// TARGET must be either left or right.
563
#define FLOAT_INPLACE_OP(left, right, TARGET, OP)                        \
564
    do {                                                                 \
565
        PyObject *left_o = PyStackRef_AsPyObjectBorrow(left);            \
566
        PyObject *right_o = PyStackRef_AsPyObjectBorrow(right);          \
567
        assert(PyFloat_CheckExact(left_o));                              \
568
        assert(PyFloat_CheckExact(right_o));                             \
569
        assert(_PyObject_IsUniquelyReferenced(                           \
570
            PyStackRef_AsPyObjectBorrow(TARGET)));                       \
571
        STAT_INC(BINARY_OP, hit);                                        \
572
        double _dres =                                                   \
573
            ((PyFloatObject *)left_o)->ob_fval                           \
574
            OP ((PyFloatObject *)right_o)->ob_fval;                      \
575
        ((PyFloatObject *)PyStackRef_AsPyObjectBorrow(TARGET))           \
576
            ->ob_fval = _dres;                                           \
577
    } while (0)
578
579
// Inplace float true division. Sets _divop_err to 1 on zero division.
580
// Caller must check _divop_err and call ERROR_NO_POP() if set.
581
#define FLOAT_INPLACE_DIVOP(left, right, TARGET)                         \
582
    int _divop_err = 0;                                                  \
583
    do {                                                                 \
584
        PyObject *left_o = PyStackRef_AsPyObjectBorrow(left);            \
585
        PyObject *right_o = PyStackRef_AsPyObjectBorrow(right);          \
586
        assert(PyFloat_CheckExact(left_o));                              \
587
        assert(PyFloat_CheckExact(right_o));                             \
588
        assert(_PyObject_IsUniquelyReferenced(                           \
589
            PyStackRef_AsPyObjectBorrow(TARGET)));                       \
590
        STAT_INC(BINARY_OP, hit);                                        \
591
        double _divisor = ((PyFloatObject *)right_o)->ob_fval;           \
592
        if (_divisor == 0.0) {                                           \
593
            PyErr_SetString(PyExc_ZeroDivisionError,                     \
594
                            "float division by zero");                   \
595
            _divop_err = 1;                                              \
596
            break;                                                       \
597
        }                                                                \
598
        double _dres = ((PyFloatObject *)left_o)->ob_fval / _divisor;    \
599
        ((PyFloatObject *)PyStackRef_AsPyObjectBorrow(TARGET))           \
600
            ->ob_fval = _dres;                                           \
601
    } while (0)
602
603
// Inplace compact int operation. TARGET is expected to be uniquely
604
// referenced at the optimizer level, but at runtime it may be a
605
// cached small int singleton. We check _Py_IsImmortal on TARGET
606
// to decide whether inplace mutation is safe.
607
//
608
// After the macro, _int_inplace_res holds the result (may be NULL
609
// on allocation failure). On success, TARGET was mutated in place
610
// and _int_inplace_res is a DUP'd reference to it. On fallback
611
// (small int target, small int result, or overflow), _int_inplace_res
612
// is from FUNC (_PyCompactLong_Add etc.).
613
// FUNC is the fallback function (_PyCompactLong_Add etc.)
614
#define INT_INPLACE_OP(left, right, TARGET, OP, FUNC)                    \
615
    _PyStackRef _int_inplace_res = PyStackRef_NULL;                      \
616
    do {                                                                 \
617
        PyObject *target_o = PyStackRef_AsPyObjectBorrow(TARGET);        \
618
        if (_Py_IsImmortal(target_o)) {                                  \
619
            break;                                                       \
620
        }                                                                \
621
        assert(_PyObject_IsUniquelyReferenced(target_o));                \
622
        Py_ssize_t left_val = _PyLong_CompactValue(                      \
623
            (PyLongObject *)PyStackRef_AsPyObjectBorrow(left));          \
624
        Py_ssize_t right_val = _PyLong_CompactValue(                     \
625
            (PyLongObject *)PyStackRef_AsPyObjectBorrow(right));         \
626
        Py_ssize_t result = left_val OP right_val;                       \
627
        if (!_PY_IS_SMALL_INT(result)                                    \
628
            && ((twodigits)((stwodigits)result) + PyLong_MASK            \
629
                < (twodigits)PyLong_MASK + PyLong_BASE))                 \
630
        {                                                                \
631
            _PyLong_SetSignAndDigitCount(                                \
632
                (PyLongObject *)target_o, result < 0 ? -1 : 1, 1);       \
633
            ((PyLongObject *)target_o)->long_value.ob_digit[0] =         \
634
                (digit)(result < 0 ? -result : result);                  \
635
            _int_inplace_res = PyStackRef_DUP(TARGET);                   \
636
            break;                                                       \
637
        }                                                                \
638
    } while (0);                                                         \
639
    if (PyStackRef_IsNull(_int_inplace_res)) {                           \
640
        _int_inplace_res = FUNC(                                         \
641
            (PyLongObject *)PyStackRef_AsPyObjectBorrow(left),           \
642
            (PyLongObject *)PyStackRef_AsPyObjectBorrow(right));         \
643
    }
644
645
#define CALL_TP_ITERITEM_NO_ESCAPE(ITER, INDEX) \
646
    Py_TYPE(ITER)->_tp_iteritem((ITER), (INDEX))