cpython/Include/internal/pycore_regions.h at fb85684e11b83953df488d8189b5a9a1d48d7474 · fxpl/cpython · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
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
117
118
119
120
121
122
123
124
125
126
127
#ifndef Py_INTERNAL_REGIONS_H
#define Py_INTERNAL_REGIONS_H

#ifdef __cplusplus
extern "C" {
#endif

#ifndef Py_BUILD_CORE
#  error "this header requires Py_BUILD_CORE define"
#endif

#include "object.h"
#include "regions.h"

#define Py_CHECKWRITE(op) ((op) && !Py_IsImmutable(op))
#define Py_REQUIREWRITE(op, msg) {if (Py_CHECKWRITE(op)) { _PyObject_ASSERT_FAILED_MSG(op, msg); }}

Py_region_ptr_t _Py_REGION(PyObject *ob);
#if !defined(Py_LIMITED_API) || Py_LIMITED_API+0 < 0x030b0000
#  define Py_REGION(ob) _Py_REGION(_PyObject_CAST(ob))
#endif

void _Py_SET_TAGGED_REGION(PyObject *ob, Py_region_ptr_with_tags_t region);
#if !defined(Py_LIMITED_API) || Py_LIMITED_API+0 < 0x030b0000
#  define Py_SET_TAGGED_REGION(ob, region) _Py_SET_TAGGED_REGION(_PyObject_CAST(ob), (region))
#endif

static inline void _Py_SET_REGION(PyObject *ob, Py_region_ptr_t region) {
    _Py_SET_TAGGED_REGION(ob, Py_region_ptr_with_tags(region & Py_REGION_MASK));
}
#if !defined(Py_LIMITED_API) || Py_LIMITED_API+0 < 0x030b0000
#  define Py_SET_REGION(ob, region) (_Py_SET_REGION(_PyObject_CAST(ob), _Py_CAST(Py_region_ptr_t, (region))))
#endif

/* This makes the given objects and all object reachable from the given
 * object immutable. This will also move the objects into the immutable
 * region.
 *
 * The argument is borrowed, meaning that it expects the calling context
 * to handle the reference count.
 *
 * The function will return `Py_None` by default.
 */
PyObject* _Py_MakeImmutable(PyObject* obj);
#define Py_MakeImmutable(op) _Py_MakeImmutable(_PyObject_CAST(op))

PyObject* _Py_Mermaid(PyObject *args, PyObject *kwargs);

PyObject* _Py_InvariantSrcFailure(void);
#define Py_InvariantSrcFailure() _Py_InvariantSrcFailure()

PyObject* _Py_InvariantTgtFailure(void);
#define Py_InvariantTgtFailure() _Py_InvariantTgtFailure()

PyObject* _Py_EnableInvariant(void);
#define Py_EnableInvariant() _Py_EnableInvariant()

PyObject* _Py_ResetInvariant(void);
#define Py_ResetInvariant() _Py_ResetInvariant()

// Invariant placeholder
bool _Py_RegionAddReference(PyObject* src, PyObject* new_tgt);
#define Py_REGIONADDREFERENCE(a, b) _Py_RegionAddReference(_PyObject_CAST(a), b)

void _Py_RegionAddLocalReference(PyObject* new_tgt);
#define Py_REGIONADDLOCALREFERENCE(b) _Py_RegionAddLocalReference(b)

// Helper macros to count the number of arguments
#define _COUNT_ARGS(_1, _2, _3, _4, _5, _6, _7, _8, _9, _10, _11, _12, _13, _14, _15, _16, N, ...) N
#define COUNT_ARGS(...) _COUNT_ARGS(__VA_ARGS__, 16, 15, 14, 13, 12, 11, 10, 9, 8, 7, 6, 5, 4, 3, 2, 1)

bool _Py_RegionAddReferences(PyObject* src, int new_tgtc, ...);
#define Py_REGIONADDREFERENCES(a, ...) _Py_RegionAddReferences(_PyObject_CAST(a), COUNT_ARGS(__VA_ARGS__), __VA_ARGS__)

void _Py_RegionRemoveReference(PyObject* src, PyObject* old_tgt);
#define Py_REGIONREMOVEREFERENCE(a, b) _Py_RegionRemoveReference(_PyObject_CAST(a), b)

#ifdef NDEBUG
#define _Py_VPYDBG(fmt, ...)
#define _Py_VPYDBGPRINT(fmt, ...)
#else
#define _Py_VPYDBG(fmt, ...) printf(fmt, ##__VA_ARGS__)
#define _Py_VPYDBGPRINT(op) PyObject_Print(_PyObject_CAST(op), stdout, 0)
#endif

int _Py_CheckRegionInvariant(PyThreadState *tstate);
// Set a cown as parent of a region
void _PyRegion_set_cown_parent(PyObject* region, PyObject* cown);
// Check whether a region is closed
int _PyCown_release(PyObject *self);
int _PyCown_is_released(PyObject *self);
int _PyCown_is_pending_release(PyObject *self);
PyObject *_PyCown_close_region(PyObject* ob);
#define PyCown_close_region(op) _PyCown_close_region(_PyObject_CAST(op))
int _PyRegion_is_closed(PyObject* op);
#define PyRegion_is_closed(op) _PyRegion_is_closed(_PyObject_CAST(op))


#ifdef _Py_TYPEOF
#define Py_CLEAR_OBJECT_FIELD(op, field) \
    do { \
        _Py_TYPEOF(op)* _tmp_field_ptr = &(field); \
        _Py_TYPEOF(op) _tmp_old_field = (*_tmp_field_ptr); \
        if (_tmp_old_field != NULL) { \
            *_tmp_field_ptr = _Py_NULL; \
            Py_REGIONREMOVEREFERENCE(op, _tmp_old_field); \
            Py_DECREF(_tmp_old_field); \
        } \
    } while (0)
#else
#define Py_CLEAR_OBJECT_FIELD(op, field) \
    do { \
        PyObject **_tmp_field_ptr = _Py_CAST(PyObject**, &(op)); \
        PyObject *_tmp_old_field = (*_tmp_field_ptr); \
        if (_tmp_old_field != NULL) { \
            PyObject *_null_ptr = _Py_NULL; \
            memcpy(_tmp_field_ptr, &_null_ptr, sizeof(PyObject*)); \
            Py_REGIONREMOVEREFERENCE(op, _tmp_old_field); \
            Py_DECREF(_tmp_old_field); \
        } \
    } while (0)
#endif

#ifdef __cplusplus
}
#endif
#endif /* !Py_INTERNAL_VERONAPY_H */