Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 1 | /* |
Tim Peters | 8839617 | 2002-06-30 17:56:40 +0000 | [diff] [blame] | 2 | |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 3 | Reference Cycle Garbage Collection |
| 4 | ================================== |
| 5 | |
Neil Schemenauer | b2c2c9e | 2000-10-04 16:34:09 +0000 | [diff] [blame] | 6 | Neil Schemenauer <nas@arctrix.com> |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 7 | |
| 8 | Based on a post on the python-dev list. Ideas from Guido van Rossum, |
| 9 | Eric Tiedemann, and various others. |
| 10 | |
Neil Schemenauer | 43411b5 | 2001-08-30 00:05:51 +0000 | [diff] [blame] | 11 | http://www.arctrix.com/nas/python/gc/ |
Neil Schemenauer | a7024e9 | 2008-07-15 19:24:01 +0000 | [diff] [blame] | 12 | |
| 13 | The following mailing list threads provide a historical perspective on |
| 14 | the design of this module. Note that a fair amount of refinement has |
| 15 | occurred since those discussions. |
| 16 | |
| 17 | http://mail.python.org/pipermail/python-dev/2000-March/002385.html |
| 18 | http://mail.python.org/pipermail/python-dev/2000-March/002434.html |
| 19 | http://mail.python.org/pipermail/python-dev/2000-March/002497.html |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 20 | |
| 21 | For a highlevel view of the collection process, read the collect |
| 22 | function. |
| 23 | |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 24 | */ |
| 25 | |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 26 | #include "Python.h" |
Victor Stinner | 27e2d1f | 2018-11-01 00:52:28 +0100 | [diff] [blame] | 27 | #include "pycore_context.h" |
Victor Stinner | 444b39b | 2019-11-20 01:18:11 +0100 | [diff] [blame] | 28 | #include "pycore_initconfig.h" |
Victor Stinner | e5014be | 2020-04-14 17:52:15 +0200 | [diff] [blame] | 29 | #include "pycore_interp.h" // PyInterpreterState.gc |
Victor Stinner | bcda8f1 | 2018-11-21 22:27:47 +0100 | [diff] [blame] | 30 | #include "pycore_object.h" |
Victor Stinner | 2e96906 | 2019-11-20 01:49:32 +0100 | [diff] [blame] | 31 | #include "pycore_pyerrors.h" |
Victor Stinner | e5014be | 2020-04-14 17:52:15 +0200 | [diff] [blame] | 32 | #include "pycore_pystate.h" // _PyThreadState_GET() |
Łukasz Langa | a785c87 | 2016-09-09 17:37:37 -0700 | [diff] [blame] | 33 | #include "pydtrace.h" |
Victor Stinner | e5014be | 2020-04-14 17:52:15 +0200 | [diff] [blame] | 34 | #include "pytime.h" // _PyTime_GetMonotonicClock() |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 35 | |
Victor Stinner | 67e0de6 | 2019-11-20 11:48:18 +0100 | [diff] [blame] | 36 | typedef struct _gc_runtime_state GCState; |
| 37 | |
Serhiy Storchaka | 9326028 | 2017-02-04 11:19:59 +0200 | [diff] [blame] | 38 | /*[clinic input] |
| 39 | module gc |
| 40 | [clinic start generated code]*/ |
| 41 | /*[clinic end generated code: output=da39a3ee5e6b4b0d input=b5c9690ecc842d79]*/ |
| 42 | |
Pablo Galindo | 320dd50 | 2019-10-10 22:45:17 +0100 | [diff] [blame] | 43 | |
| 44 | #ifdef Py_DEBUG |
| 45 | # define GC_DEBUG |
| 46 | #endif |
INADA Naoki | 5ac9e6e | 2018-07-10 17:19:53 +0900 | [diff] [blame] | 47 | |
| 48 | #define GC_NEXT _PyGCHead_NEXT |
| 49 | #define GC_PREV _PyGCHead_PREV |
| 50 | |
| 51 | // update_refs() set this bit for all objects in current generation. |
| 52 | // subtract_refs() and move_unreachable() uses this to distinguish |
| 53 | // visited object is in GCing or not. |
| 54 | // |
| 55 | // move_unreachable() removes this flag from reachable objects. |
| 56 | // Only unreachable objects have this flag. |
| 57 | // |
| 58 | // No objects in interpreter have this flag after GC ends. |
| 59 | #define PREV_MASK_COLLECTING _PyGC_PREV_MASK_COLLECTING |
| 60 | |
| 61 | // Lowest bit of _gc_next is used for UNREACHABLE flag. |
| 62 | // |
| 63 | // This flag represents the object is in unreachable list in move_unreachable() |
| 64 | // |
| 65 | // Although this flag is used only in move_unreachable(), move_unreachable() |
| 66 | // doesn't clear this flag to skip unnecessary iteration. |
| 67 | // move_legacy_finalizers() removes this flag instead. |
| 68 | // Between them, unreachable list is not normal list and we can not use |
| 69 | // most gc_list_* functions for it. |
| 70 | #define NEXT_MASK_UNREACHABLE (1) |
| 71 | |
Victor Stinner | 626bff8 | 2018-10-25 17:31:10 +0200 | [diff] [blame] | 72 | /* Get an object's GC head */ |
| 73 | #define AS_GC(o) ((PyGC_Head *)(o)-1) |
| 74 | |
| 75 | /* Get the object given the GC head */ |
| 76 | #define FROM_GC(g) ((PyObject *)(((PyGC_Head *)g)+1)) |
| 77 | |
INADA Naoki | 5ac9e6e | 2018-07-10 17:19:53 +0900 | [diff] [blame] | 78 | static inline int |
| 79 | gc_is_collecting(PyGC_Head *g) |
| 80 | { |
| 81 | return (g->_gc_prev & PREV_MASK_COLLECTING) != 0; |
| 82 | } |
| 83 | |
| 84 | static inline void |
| 85 | gc_clear_collecting(PyGC_Head *g) |
| 86 | { |
| 87 | g->_gc_prev &= ~PREV_MASK_COLLECTING; |
| 88 | } |
| 89 | |
| 90 | static inline Py_ssize_t |
| 91 | gc_get_refs(PyGC_Head *g) |
| 92 | { |
| 93 | return (Py_ssize_t)(g->_gc_prev >> _PyGC_PREV_SHIFT); |
| 94 | } |
| 95 | |
| 96 | static inline void |
| 97 | gc_set_refs(PyGC_Head *g, Py_ssize_t refs) |
| 98 | { |
| 99 | g->_gc_prev = (g->_gc_prev & ~_PyGC_PREV_MASK) |
| 100 | | ((uintptr_t)(refs) << _PyGC_PREV_SHIFT); |
| 101 | } |
| 102 | |
| 103 | static inline void |
| 104 | gc_reset_refs(PyGC_Head *g, Py_ssize_t refs) |
| 105 | { |
| 106 | g->_gc_prev = (g->_gc_prev & _PyGC_PREV_MASK_FINALIZED) |
| 107 | | PREV_MASK_COLLECTING |
| 108 | | ((uintptr_t)(refs) << _PyGC_PREV_SHIFT); |
| 109 | } |
| 110 | |
| 111 | static inline void |
| 112 | gc_decref(PyGC_Head *g) |
| 113 | { |
Victor Stinner | 626bff8 | 2018-10-25 17:31:10 +0200 | [diff] [blame] | 114 | _PyObject_ASSERT_WITH_MSG(FROM_GC(g), |
| 115 | gc_get_refs(g) > 0, |
| 116 | "refcount is too small"); |
INADA Naoki | 5ac9e6e | 2018-07-10 17:19:53 +0900 | [diff] [blame] | 117 | g->_gc_prev -= 1 << _PyGC_PREV_SHIFT; |
| 118 | } |
| 119 | |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 120 | /* set for debugging information */ |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 121 | #define DEBUG_STATS (1<<0) /* print collection statistics */ |
| 122 | #define DEBUG_COLLECTABLE (1<<1) /* print collectable objects */ |
| 123 | #define DEBUG_UNCOLLECTABLE (1<<2) /* print uncollectable objects */ |
| 124 | #define DEBUG_SAVEALL (1<<5) /* save all garbage in gc.garbage */ |
| 125 | #define DEBUG_LEAK DEBUG_COLLECTABLE | \ |
| 126 | DEBUG_UNCOLLECTABLE | \ |
| 127 | DEBUG_SAVEALL |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 128 | |
Victor Stinner | 67e0de6 | 2019-11-20 11:48:18 +0100 | [diff] [blame] | 129 | #define GEN_HEAD(gcstate, n) (&(gcstate)->generations[n].head) |
Antoine Pitrou | d4156c1 | 2012-10-30 22:43:19 +0100 | [diff] [blame] | 130 | |
Victor Stinner | 1bcc32f | 2020-06-10 20:08:26 +0200 | [diff] [blame] | 131 | |
| 132 | static GCState * |
| 133 | get_gc_state(void) |
| 134 | { |
| 135 | PyInterpreterState *interp = _PyInterpreterState_GET(); |
| 136 | return &interp->gc; |
| 137 | } |
| 138 | |
| 139 | |
Eric Snow | 2ebc5ce | 2017-09-07 23:51:28 -0600 | [diff] [blame] | 140 | void |
Victor Stinner | 7247407 | 2019-11-20 12:25:50 +0100 | [diff] [blame] | 141 | _PyGC_InitState(GCState *gcstate) |
Eric Snow | 2ebc5ce | 2017-09-07 23:51:28 -0600 | [diff] [blame] | 142 | { |
Victor Stinner | 67e0de6 | 2019-11-20 11:48:18 +0100 | [diff] [blame] | 143 | gcstate->enabled = 1; /* automatic collection enabled? */ |
Eric Snow | 2ebc5ce | 2017-09-07 23:51:28 -0600 | [diff] [blame] | 144 | |
Victor Stinner | 67e0de6 | 2019-11-20 11:48:18 +0100 | [diff] [blame] | 145 | #define _GEN_HEAD(n) GEN_HEAD(gcstate, n) |
Eric Snow | 2ebc5ce | 2017-09-07 23:51:28 -0600 | [diff] [blame] | 146 | struct gc_generation generations[NUM_GENERATIONS] = { |
INADA Naoki | 5ac9e6e | 2018-07-10 17:19:53 +0900 | [diff] [blame] | 147 | /* PyGC_Head, threshold, count */ |
| 148 | {{(uintptr_t)_GEN_HEAD(0), (uintptr_t)_GEN_HEAD(0)}, 700, 0}, |
| 149 | {{(uintptr_t)_GEN_HEAD(1), (uintptr_t)_GEN_HEAD(1)}, 10, 0}, |
| 150 | {{(uintptr_t)_GEN_HEAD(2), (uintptr_t)_GEN_HEAD(2)}, 10, 0}, |
Eric Snow | 2ebc5ce | 2017-09-07 23:51:28 -0600 | [diff] [blame] | 151 | }; |
| 152 | for (int i = 0; i < NUM_GENERATIONS; i++) { |
Victor Stinner | 67e0de6 | 2019-11-20 11:48:18 +0100 | [diff] [blame] | 153 | gcstate->generations[i] = generations[i]; |
Eric Snow | 2ebc5ce | 2017-09-07 23:51:28 -0600 | [diff] [blame] | 154 | }; |
Victor Stinner | 67e0de6 | 2019-11-20 11:48:18 +0100 | [diff] [blame] | 155 | gcstate->generation0 = GEN_HEAD(gcstate, 0); |
brainfvck | c75edab | 2017-10-16 12:49:41 -0700 | [diff] [blame] | 156 | struct gc_generation permanent_generation = { |
Victor Stinner | 67e0de6 | 2019-11-20 11:48:18 +0100 | [diff] [blame] | 157 | {(uintptr_t)&gcstate->permanent_generation.head, |
| 158 | (uintptr_t)&gcstate->permanent_generation.head}, 0, 0 |
brainfvck | c75edab | 2017-10-16 12:49:41 -0700 | [diff] [blame] | 159 | }; |
Victor Stinner | 67e0de6 | 2019-11-20 11:48:18 +0100 | [diff] [blame] | 160 | gcstate->permanent_generation = permanent_generation; |
Eric Snow | 2ebc5ce | 2017-09-07 23:51:28 -0600 | [diff] [blame] | 161 | } |
Antoine Pitrou | d4156c1 | 2012-10-30 22:43:19 +0100 | [diff] [blame] | 162 | |
Victor Stinner | 444b39b | 2019-11-20 01:18:11 +0100 | [diff] [blame] | 163 | |
| 164 | PyStatus |
Victor Stinner | 01b1cc1 | 2019-11-20 02:27:56 +0100 | [diff] [blame] | 165 | _PyGC_Init(PyThreadState *tstate) |
Victor Stinner | 444b39b | 2019-11-20 01:18:11 +0100 | [diff] [blame] | 166 | { |
Victor Stinner | 7247407 | 2019-11-20 12:25:50 +0100 | [diff] [blame] | 167 | GCState *gcstate = &tstate->interp->gc; |
Victor Stinner | 67e0de6 | 2019-11-20 11:48:18 +0100 | [diff] [blame] | 168 | if (gcstate->garbage == NULL) { |
| 169 | gcstate->garbage = PyList_New(0); |
| 170 | if (gcstate->garbage == NULL) { |
Victor Stinner | 444b39b | 2019-11-20 01:18:11 +0100 | [diff] [blame] | 171 | return _PyStatus_NO_MEMORY(); |
| 172 | } |
| 173 | } |
| 174 | return _PyStatus_OK(); |
| 175 | } |
| 176 | |
| 177 | |
INADA Naoki | 5ac9e6e | 2018-07-10 17:19:53 +0900 | [diff] [blame] | 178 | /* |
| 179 | _gc_prev values |
| 180 | --------------- |
Neil Schemenauer | 43411b5 | 2001-08-30 00:05:51 +0000 | [diff] [blame] | 181 | |
INADA Naoki | 5ac9e6e | 2018-07-10 17:19:53 +0900 | [diff] [blame] | 182 | Between collections, _gc_prev is used for doubly linked list. |
Tim Peters | 6fc13d9 | 2002-07-02 18:12:35 +0000 | [diff] [blame] | 183 | |
INADA Naoki | 5ac9e6e | 2018-07-10 17:19:53 +0900 | [diff] [blame] | 184 | Lowest two bits of _gc_prev are used for flags. |
| 185 | PREV_MASK_COLLECTING is used only while collecting and cleared before GC ends |
| 186 | or _PyObject_GC_UNTRACK() is called. |
Tim Peters | 6fc13d9 | 2002-07-02 18:12:35 +0000 | [diff] [blame] | 187 | |
INADA Naoki | 5ac9e6e | 2018-07-10 17:19:53 +0900 | [diff] [blame] | 188 | During a collection, _gc_prev is temporary used for gc_refs, and the gc list |
| 189 | is singly linked until _gc_prev is restored. |
Tim Peters | 6fc13d9 | 2002-07-02 18:12:35 +0000 | [diff] [blame] | 190 | |
INADA Naoki | 5ac9e6e | 2018-07-10 17:19:53 +0900 | [diff] [blame] | 191 | gc_refs |
Tim Peters | 6fc13d9 | 2002-07-02 18:12:35 +0000 | [diff] [blame] | 192 | At the start of a collection, update_refs() copies the true refcount |
| 193 | to gc_refs, for each object in the generation being collected. |
| 194 | subtract_refs() then adjusts gc_refs so that it equals the number of |
| 195 | times an object is referenced directly from outside the generation |
| 196 | being collected. |
Tim Peters | 6fc13d9 | 2002-07-02 18:12:35 +0000 | [diff] [blame] | 197 | |
INADA Naoki | 5ac9e6e | 2018-07-10 17:19:53 +0900 | [diff] [blame] | 198 | PREV_MASK_COLLECTING |
| 199 | Objects in generation being collected are marked PREV_MASK_COLLECTING in |
| 200 | update_refs(). |
| 201 | |
| 202 | |
| 203 | _gc_next values |
| 204 | --------------- |
| 205 | |
| 206 | _gc_next takes these values: |
| 207 | |
| 208 | 0 |
| 209 | The object is not tracked |
| 210 | |
| 211 | != 0 |
| 212 | Pointer to the next object in the GC list. |
| 213 | Additionally, lowest bit is used temporary for |
| 214 | NEXT_MASK_UNREACHABLE flag described below. |
| 215 | |
| 216 | NEXT_MASK_UNREACHABLE |
Tim Peters | 6fc13d9 | 2002-07-02 18:12:35 +0000 | [diff] [blame] | 217 | move_unreachable() then moves objects not reachable (whether directly or |
INADA Naoki | 5ac9e6e | 2018-07-10 17:19:53 +0900 | [diff] [blame] | 218 | indirectly) from outside the generation into an "unreachable" set and |
| 219 | set this flag. |
Tim Peters | 6fc13d9 | 2002-07-02 18:12:35 +0000 | [diff] [blame] | 220 | |
INADA Naoki | 5ac9e6e | 2018-07-10 17:19:53 +0900 | [diff] [blame] | 221 | Objects that are found to be reachable have gc_refs set to 1. |
| 222 | When this flag is set for the reachable object, the object must be in |
| 223 | "unreachable" set. |
| 224 | The flag is unset and the object is moved back to "reachable" set. |
| 225 | |
| 226 | move_legacy_finalizers() will remove this flag from "unreachable" set. |
Tim Peters | 6fc13d9 | 2002-07-02 18:12:35 +0000 | [diff] [blame] | 227 | */ |
Neil Schemenauer | a2b11ec | 2002-05-21 15:53:24 +0000 | [diff] [blame] | 228 | |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 229 | /*** list functions ***/ |
| 230 | |
INADA Naoki | 5ac9e6e | 2018-07-10 17:19:53 +0900 | [diff] [blame] | 231 | static inline void |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 232 | gc_list_init(PyGC_Head *list) |
| 233 | { |
INADA Naoki | 5ac9e6e | 2018-07-10 17:19:53 +0900 | [diff] [blame] | 234 | // List header must not have flags. |
| 235 | // We can assign pointer by simple cast. |
| 236 | list->_gc_prev = (uintptr_t)list; |
| 237 | list->_gc_next = (uintptr_t)list; |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 238 | } |
| 239 | |
INADA Naoki | 5ac9e6e | 2018-07-10 17:19:53 +0900 | [diff] [blame] | 240 | static inline int |
Neil Schemenauer | 2880ae5 | 2002-05-04 05:35:20 +0000 | [diff] [blame] | 241 | gc_list_is_empty(PyGC_Head *list) |
| 242 | { |
INADA Naoki | 5ac9e6e | 2018-07-10 17:19:53 +0900 | [diff] [blame] | 243 | return (list->_gc_next == (uintptr_t)list); |
Neil Schemenauer | 2880ae5 | 2002-05-04 05:35:20 +0000 | [diff] [blame] | 244 | } |
| 245 | |
Tim Peters | e2d5918 | 2004-11-01 01:39:08 +0000 | [diff] [blame] | 246 | /* Append `node` to `list`. */ |
INADA Naoki | 5ac9e6e | 2018-07-10 17:19:53 +0900 | [diff] [blame] | 247 | static inline void |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 248 | gc_list_append(PyGC_Head *node, PyGC_Head *list) |
| 249 | { |
INADA Naoki | 5ac9e6e | 2018-07-10 17:19:53 +0900 | [diff] [blame] | 250 | PyGC_Head *last = (PyGC_Head *)list->_gc_prev; |
| 251 | |
| 252 | // last <-> node |
| 253 | _PyGCHead_SET_PREV(node, last); |
| 254 | _PyGCHead_SET_NEXT(last, node); |
| 255 | |
| 256 | // node <-> list |
| 257 | _PyGCHead_SET_NEXT(node, list); |
| 258 | list->_gc_prev = (uintptr_t)node; |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 259 | } |
| 260 | |
Tim Peters | e2d5918 | 2004-11-01 01:39:08 +0000 | [diff] [blame] | 261 | /* Remove `node` from the gc list it's currently in. */ |
INADA Naoki | 5ac9e6e | 2018-07-10 17:19:53 +0900 | [diff] [blame] | 262 | static inline void |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 263 | gc_list_remove(PyGC_Head *node) |
| 264 | { |
INADA Naoki | 5ac9e6e | 2018-07-10 17:19:53 +0900 | [diff] [blame] | 265 | PyGC_Head *prev = GC_PREV(node); |
| 266 | PyGC_Head *next = GC_NEXT(node); |
| 267 | |
| 268 | _PyGCHead_SET_NEXT(prev, next); |
| 269 | _PyGCHead_SET_PREV(next, prev); |
| 270 | |
| 271 | node->_gc_next = 0; /* object is not currently tracked */ |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 272 | } |
| 273 | |
Tim Peters | e2d5918 | 2004-11-01 01:39:08 +0000 | [diff] [blame] | 274 | /* Move `node` from the gc list it's currently in (which is not explicitly |
| 275 | * named here) to the end of `list`. This is semantically the same as |
| 276 | * gc_list_remove(node) followed by gc_list_append(node, list). |
| 277 | */ |
| 278 | static void |
| 279 | gc_list_move(PyGC_Head *node, PyGC_Head *list) |
| 280 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 281 | /* Unlink from current list. */ |
INADA Naoki | 5ac9e6e | 2018-07-10 17:19:53 +0900 | [diff] [blame] | 282 | PyGC_Head *from_prev = GC_PREV(node); |
| 283 | PyGC_Head *from_next = GC_NEXT(node); |
| 284 | _PyGCHead_SET_NEXT(from_prev, from_next); |
| 285 | _PyGCHead_SET_PREV(from_next, from_prev); |
| 286 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 287 | /* Relink at end of new list. */ |
INADA Naoki | 5ac9e6e | 2018-07-10 17:19:53 +0900 | [diff] [blame] | 288 | // list must not have flags. So we can skip macros. |
| 289 | PyGC_Head *to_prev = (PyGC_Head*)list->_gc_prev; |
| 290 | _PyGCHead_SET_PREV(node, to_prev); |
| 291 | _PyGCHead_SET_NEXT(to_prev, node); |
| 292 | list->_gc_prev = (uintptr_t)node; |
| 293 | _PyGCHead_SET_NEXT(node, list); |
Tim Peters | e2d5918 | 2004-11-01 01:39:08 +0000 | [diff] [blame] | 294 | } |
| 295 | |
| 296 | /* append list `from` onto list `to`; `from` becomes an empty list */ |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 297 | static void |
| 298 | gc_list_merge(PyGC_Head *from, PyGC_Head *to) |
| 299 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 300 | assert(from != to); |
| 301 | if (!gc_list_is_empty(from)) { |
INADA Naoki | 5ac9e6e | 2018-07-10 17:19:53 +0900 | [diff] [blame] | 302 | PyGC_Head *to_tail = GC_PREV(to); |
| 303 | PyGC_Head *from_head = GC_NEXT(from); |
| 304 | PyGC_Head *from_tail = GC_PREV(from); |
| 305 | assert(from_head != from); |
| 306 | assert(from_tail != from); |
| 307 | |
| 308 | _PyGCHead_SET_NEXT(to_tail, from_head); |
| 309 | _PyGCHead_SET_PREV(from_head, to_tail); |
| 310 | |
| 311 | _PyGCHead_SET_NEXT(from_tail, to); |
| 312 | _PyGCHead_SET_PREV(to, from_tail); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 313 | } |
| 314 | gc_list_init(from); |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 315 | } |
| 316 | |
Neal Norwitz | 7b216c5 | 2006-03-04 20:01:53 +0000 | [diff] [blame] | 317 | static Py_ssize_t |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 318 | gc_list_size(PyGC_Head *list) |
| 319 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 320 | PyGC_Head *gc; |
| 321 | Py_ssize_t n = 0; |
INADA Naoki | 5ac9e6e | 2018-07-10 17:19:53 +0900 | [diff] [blame] | 322 | for (gc = GC_NEXT(list); gc != list; gc = GC_NEXT(gc)) { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 323 | n++; |
| 324 | } |
| 325 | return n; |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 326 | } |
| 327 | |
Pablo Galindo | 466326d | 2019-10-13 16:48:59 +0100 | [diff] [blame] | 328 | /* Walk the list and mark all objects as non-collecting */ |
| 329 | static inline void |
| 330 | gc_list_clear_collecting(PyGC_Head *collectable) |
| 331 | { |
| 332 | PyGC_Head *gc; |
| 333 | for (gc = GC_NEXT(collectable); gc != collectable; gc = GC_NEXT(gc)) { |
| 334 | gc_clear_collecting(gc); |
| 335 | } |
| 336 | } |
| 337 | |
Tim Peters | 259272b | 2003-04-06 19:41:39 +0000 | [diff] [blame] | 338 | /* Append objects in a GC list to a Python list. |
Pablo Galindo | 466326d | 2019-10-13 16:48:59 +0100 | [diff] [blame] | 339 | * Return 0 if all OK, < 0 if error (out of memory for list) |
Tim Peters | 259272b | 2003-04-06 19:41:39 +0000 | [diff] [blame] | 340 | */ |
| 341 | static int |
| 342 | append_objects(PyObject *py_list, PyGC_Head *gc_list) |
| 343 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 344 | PyGC_Head *gc; |
INADA Naoki | 5ac9e6e | 2018-07-10 17:19:53 +0900 | [diff] [blame] | 345 | for (gc = GC_NEXT(gc_list); gc != gc_list; gc = GC_NEXT(gc)) { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 346 | PyObject *op = FROM_GC(gc); |
| 347 | if (op != py_list) { |
| 348 | if (PyList_Append(py_list, op)) { |
| 349 | return -1; /* exception */ |
| 350 | } |
| 351 | } |
| 352 | } |
| 353 | return 0; |
Tim Peters | 259272b | 2003-04-06 19:41:39 +0000 | [diff] [blame] | 354 | } |
| 355 | |
Tim Peters | ea55c51 | 2019-10-18 20:59:14 -0500 | [diff] [blame] | 356 | // Constants for validate_list's flags argument. |
| 357 | enum flagstates {collecting_clear_unreachable_clear, |
| 358 | collecting_clear_unreachable_set, |
| 359 | collecting_set_unreachable_clear, |
| 360 | collecting_set_unreachable_set}; |
| 361 | |
Pablo Galindo | 320dd50 | 2019-10-10 22:45:17 +0100 | [diff] [blame] | 362 | #ifdef GC_DEBUG |
INADA Naoki | 5ac9e6e | 2018-07-10 17:19:53 +0900 | [diff] [blame] | 363 | // validate_list checks list consistency. And it works as document |
Tim Peters | 95bfc8a | 2019-10-13 16:47:04 -0500 | [diff] [blame] | 364 | // describing when flags are expected to be set / unset. |
| 365 | // `head` must be a doubly-linked gc list, although it's fine (expected!) if |
| 366 | // the prev and next pointers are "polluted" with flags. |
| 367 | // What's checked: |
| 368 | // - The `head` pointers are not polluted. |
Tim Peters | ea55c51 | 2019-10-18 20:59:14 -0500 | [diff] [blame] | 369 | // - The objects' PREV_MASK_COLLECTING and NEXT_MASK_UNREACHABLE flags are all |
| 370 | // `set or clear, as specified by the 'flags' argument. |
Tim Peters | 95bfc8a | 2019-10-13 16:47:04 -0500 | [diff] [blame] | 371 | // - The prev and next pointers are mutually consistent. |
INADA Naoki | 5ac9e6e | 2018-07-10 17:19:53 +0900 | [diff] [blame] | 372 | static void |
Tim Peters | ea55c51 | 2019-10-18 20:59:14 -0500 | [diff] [blame] | 373 | validate_list(PyGC_Head *head, enum flagstates flags) |
INADA Naoki | 5ac9e6e | 2018-07-10 17:19:53 +0900 | [diff] [blame] | 374 | { |
Tim Peters | 95bfc8a | 2019-10-13 16:47:04 -0500 | [diff] [blame] | 375 | assert((head->_gc_prev & PREV_MASK_COLLECTING) == 0); |
| 376 | assert((head->_gc_next & NEXT_MASK_UNREACHABLE) == 0); |
Tim Peters | ea55c51 | 2019-10-18 20:59:14 -0500 | [diff] [blame] | 377 | uintptr_t prev_value = 0, next_value = 0; |
| 378 | switch (flags) { |
| 379 | case collecting_clear_unreachable_clear: |
| 380 | break; |
| 381 | case collecting_set_unreachable_clear: |
| 382 | prev_value = PREV_MASK_COLLECTING; |
| 383 | break; |
| 384 | case collecting_clear_unreachable_set: |
| 385 | next_value = NEXT_MASK_UNREACHABLE; |
| 386 | break; |
| 387 | case collecting_set_unreachable_set: |
| 388 | prev_value = PREV_MASK_COLLECTING; |
| 389 | next_value = NEXT_MASK_UNREACHABLE; |
| 390 | break; |
| 391 | default: |
| 392 | assert(! "bad internal flags argument"); |
| 393 | } |
INADA Naoki | 5ac9e6e | 2018-07-10 17:19:53 +0900 | [diff] [blame] | 394 | PyGC_Head *prev = head; |
| 395 | PyGC_Head *gc = GC_NEXT(head); |
| 396 | while (gc != head) { |
Tim Peters | 95bfc8a | 2019-10-13 16:47:04 -0500 | [diff] [blame] | 397 | PyGC_Head *trueprev = GC_PREV(gc); |
| 398 | PyGC_Head *truenext = (PyGC_Head *)(gc->_gc_next & ~NEXT_MASK_UNREACHABLE); |
| 399 | assert(truenext != NULL); |
| 400 | assert(trueprev == prev); |
| 401 | assert((gc->_gc_prev & PREV_MASK_COLLECTING) == prev_value); |
| 402 | assert((gc->_gc_next & NEXT_MASK_UNREACHABLE) == next_value); |
INADA Naoki | 5ac9e6e | 2018-07-10 17:19:53 +0900 | [diff] [blame] | 403 | prev = gc; |
Tim Peters | 95bfc8a | 2019-10-13 16:47:04 -0500 | [diff] [blame] | 404 | gc = truenext; |
INADA Naoki | 5ac9e6e | 2018-07-10 17:19:53 +0900 | [diff] [blame] | 405 | } |
| 406 | assert(prev == GC_PREV(head)); |
| 407 | } |
| 408 | #else |
Tim Peters | ea55c51 | 2019-10-18 20:59:14 -0500 | [diff] [blame] | 409 | #define validate_list(x, y) do{}while(0) |
INADA Naoki | 5ac9e6e | 2018-07-10 17:19:53 +0900 | [diff] [blame] | 410 | #endif |
| 411 | |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 412 | /*** end of list stuff ***/ |
| 413 | |
| 414 | |
INADA Naoki | 5ac9e6e | 2018-07-10 17:19:53 +0900 | [diff] [blame] | 415 | /* Set all gc_refs = ob_refcnt. After this, gc_refs is > 0 and |
| 416 | * PREV_MASK_COLLECTING bit is set for all objects in containers. |
Tim Peters | 8839617 | 2002-06-30 17:56:40 +0000 | [diff] [blame] | 417 | */ |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 418 | static void |
| 419 | update_refs(PyGC_Head *containers) |
| 420 | { |
INADA Naoki | 5ac9e6e | 2018-07-10 17:19:53 +0900 | [diff] [blame] | 421 | PyGC_Head *gc = GC_NEXT(containers); |
| 422 | for (; gc != containers; gc = GC_NEXT(gc)) { |
| 423 | gc_reset_refs(gc, Py_REFCNT(FROM_GC(gc))); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 424 | /* Python's cyclic gc should never see an incoming refcount |
| 425 | * of 0: if something decref'ed to 0, it should have been |
| 426 | * deallocated immediately at that time. |
| 427 | * Possible cause (if the assert triggers): a tp_dealloc |
| 428 | * routine left a gc-aware object tracked during its teardown |
| 429 | * phase, and did something-- or allowed something to happen -- |
| 430 | * that called back into Python. gc can trigger then, and may |
| 431 | * see the still-tracked dying object. Before this assert |
| 432 | * was added, such mistakes went on to allow gc to try to |
| 433 | * delete the object again. In a debug build, that caused |
| 434 | * a mysterious segfault, when _Py_ForgetReference tried |
| 435 | * to remove the object from the doubly-linked list of all |
| 436 | * objects a second time. In a release build, an actual |
| 437 | * double deallocation occurred, which leads to corruption |
| 438 | * of the allocator's internal bookkeeping pointers. That's |
| 439 | * so serious that maybe this should be a release-build |
| 440 | * check instead of an assert? |
| 441 | */ |
Victor Stinner | a4b2bc7 | 2018-10-26 18:00:13 +0200 | [diff] [blame] | 442 | _PyObject_ASSERT(FROM_GC(gc), gc_get_refs(gc) != 0); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 443 | } |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 444 | } |
| 445 | |
Tim Peters | 19b74c7 | 2002-07-01 03:52:19 +0000 | [diff] [blame] | 446 | /* A traversal callback for subtract_refs. */ |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 447 | static int |
Victor Stinner | 4d5f94b | 2019-10-08 02:37:38 +0200 | [diff] [blame] | 448 | visit_decref(PyObject *op, void *parent) |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 449 | { |
Victor Stinner | 4d5f94b | 2019-10-08 02:37:38 +0200 | [diff] [blame] | 450 | _PyObject_ASSERT(_PyObject_CAST(parent), !_PyObject_IsFreed(op)); |
Victor Stinner | d91d4de | 2019-09-09 17:44:59 +0200 | [diff] [blame] | 451 | |
Hai Shi | 675d9a3 | 2020-04-15 02:11:20 +0800 | [diff] [blame] | 452 | if (_PyObject_IS_GC(op)) { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 453 | PyGC_Head *gc = AS_GC(op); |
| 454 | /* We're only interested in gc_refs for objects in the |
| 455 | * generation being collected, which can be recognized |
| 456 | * because only they have positive gc_refs. |
| 457 | */ |
INADA Naoki | 5ac9e6e | 2018-07-10 17:19:53 +0900 | [diff] [blame] | 458 | if (gc_is_collecting(gc)) { |
| 459 | gc_decref(gc); |
| 460 | } |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 461 | } |
| 462 | return 0; |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 463 | } |
| 464 | |
Tim Peters | 19b74c7 | 2002-07-01 03:52:19 +0000 | [diff] [blame] | 465 | /* Subtract internal references from gc_refs. After this, gc_refs is >= 0 |
| 466 | * for all objects in containers, and is GC_REACHABLE for all tracked gc |
| 467 | * objects not in containers. The ones with gc_refs > 0 are directly |
| 468 | * reachable from outside containers, and so can't be collected. |
| 469 | */ |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 470 | static void |
| 471 | subtract_refs(PyGC_Head *containers) |
| 472 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 473 | traverseproc traverse; |
INADA Naoki | 5ac9e6e | 2018-07-10 17:19:53 +0900 | [diff] [blame] | 474 | PyGC_Head *gc = GC_NEXT(containers); |
| 475 | for (; gc != containers; gc = GC_NEXT(gc)) { |
Victor Stinner | 4d5f94b | 2019-10-08 02:37:38 +0200 | [diff] [blame] | 476 | PyObject *op = FROM_GC(gc); |
| 477 | traverse = Py_TYPE(op)->tp_traverse; |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 478 | (void) traverse(FROM_GC(gc), |
| 479 | (visitproc)visit_decref, |
Victor Stinner | 4d5f94b | 2019-10-08 02:37:38 +0200 | [diff] [blame] | 480 | op); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 481 | } |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 482 | } |
| 483 | |
Tim Peters | 19b74c7 | 2002-07-01 03:52:19 +0000 | [diff] [blame] | 484 | /* A traversal callback for move_unreachable. */ |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 485 | static int |
Tim Peters | 19b74c7 | 2002-07-01 03:52:19 +0000 | [diff] [blame] | 486 | visit_reachable(PyObject *op, PyGC_Head *reachable) |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 487 | { |
Hai Shi | 675d9a3 | 2020-04-15 02:11:20 +0800 | [diff] [blame] | 488 | if (!_PyObject_IS_GC(op)) { |
INADA Naoki | 5ac9e6e | 2018-07-10 17:19:53 +0900 | [diff] [blame] | 489 | return 0; |
| 490 | } |
Tim Peters | 19b74c7 | 2002-07-01 03:52:19 +0000 | [diff] [blame] | 491 | |
INADA Naoki | 5ac9e6e | 2018-07-10 17:19:53 +0900 | [diff] [blame] | 492 | PyGC_Head *gc = AS_GC(op); |
| 493 | const Py_ssize_t gc_refs = gc_get_refs(gc); |
| 494 | |
Tim Peters | 1e73945 | 2019-10-21 11:21:35 -0500 | [diff] [blame] | 495 | // Ignore objects in other generation. |
Tim Peters | 95bfc8a | 2019-10-13 16:47:04 -0500 | [diff] [blame] | 496 | // This also skips objects "to the left" of the current position in |
| 497 | // move_unreachable's scan of the 'young' list - they've already been |
| 498 | // traversed, and no longer have the PREV_MASK_COLLECTING flag. |
Tim Peters | 1e73945 | 2019-10-21 11:21:35 -0500 | [diff] [blame] | 499 | if (! gc_is_collecting(gc)) { |
INADA Naoki | 5ac9e6e | 2018-07-10 17:19:53 +0900 | [diff] [blame] | 500 | return 0; |
| 501 | } |
Tim Peters | 1e73945 | 2019-10-21 11:21:35 -0500 | [diff] [blame] | 502 | // It would be a logic error elsewhere if the collecting flag were set on |
| 503 | // an untracked object. |
| 504 | assert(gc->_gc_next != 0); |
INADA Naoki | 5ac9e6e | 2018-07-10 17:19:53 +0900 | [diff] [blame] | 505 | |
| 506 | if (gc->_gc_next & NEXT_MASK_UNREACHABLE) { |
| 507 | /* This had gc_refs = 0 when move_unreachable got |
| 508 | * to it, but turns out it's reachable after all. |
| 509 | * Move it back to move_unreachable's 'young' list, |
| 510 | * and move_unreachable will eventually get to it |
| 511 | * again. |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 512 | */ |
Tim Peters | 95bfc8a | 2019-10-13 16:47:04 -0500 | [diff] [blame] | 513 | // Manually unlink gc from unreachable list because the list functions |
| 514 | // don't work right in the presence of NEXT_MASK_UNREACHABLE flags. |
INADA Naoki | 5ac9e6e | 2018-07-10 17:19:53 +0900 | [diff] [blame] | 515 | PyGC_Head *prev = GC_PREV(gc); |
| 516 | PyGC_Head *next = (PyGC_Head*)(gc->_gc_next & ~NEXT_MASK_UNREACHABLE); |
Victor Stinner | a4b2bc7 | 2018-10-26 18:00:13 +0200 | [diff] [blame] | 517 | _PyObject_ASSERT(FROM_GC(prev), |
| 518 | prev->_gc_next & NEXT_MASK_UNREACHABLE); |
| 519 | _PyObject_ASSERT(FROM_GC(next), |
| 520 | next->_gc_next & NEXT_MASK_UNREACHABLE); |
INADA Naoki | 5ac9e6e | 2018-07-10 17:19:53 +0900 | [diff] [blame] | 521 | prev->_gc_next = gc->_gc_next; // copy NEXT_MASK_UNREACHABLE |
| 522 | _PyGCHead_SET_PREV(next, prev); |
| 523 | |
| 524 | gc_list_append(gc, reachable); |
| 525 | gc_set_refs(gc, 1); |
| 526 | } |
| 527 | else if (gc_refs == 0) { |
| 528 | /* This is in move_unreachable's 'young' list, but |
| 529 | * the traversal hasn't yet gotten to it. All |
| 530 | * we need to do is tell move_unreachable that it's |
| 531 | * reachable. |
| 532 | */ |
| 533 | gc_set_refs(gc, 1); |
| 534 | } |
| 535 | /* Else there's nothing to do. |
| 536 | * If gc_refs > 0, it must be in move_unreachable's 'young' |
| 537 | * list, and move_unreachable will eventually get to it. |
| 538 | */ |
| 539 | else { |
Victor Stinner | a4b2bc7 | 2018-10-26 18:00:13 +0200 | [diff] [blame] | 540 | _PyObject_ASSERT_WITH_MSG(op, gc_refs > 0, "refcount is too small"); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 541 | } |
| 542 | return 0; |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 543 | } |
| 544 | |
Tim Peters | 19b74c7 | 2002-07-01 03:52:19 +0000 | [diff] [blame] | 545 | /* Move the unreachable objects from young to unreachable. After this, |
INADA Naoki | 5ac9e6e | 2018-07-10 17:19:53 +0900 | [diff] [blame] | 546 | * all objects in young don't have PREV_MASK_COLLECTING flag and |
| 547 | * unreachable have the flag. |
Tim Peters | 19b74c7 | 2002-07-01 03:52:19 +0000 | [diff] [blame] | 548 | * All objects in young after this are directly or indirectly reachable |
| 549 | * from outside the original young; and all objects in unreachable are |
| 550 | * not. |
INADA Naoki | 5ac9e6e | 2018-07-10 17:19:53 +0900 | [diff] [blame] | 551 | * |
| 552 | * This function restores _gc_prev pointer. young and unreachable are |
| 553 | * doubly linked list after this function. |
| 554 | * But _gc_next in unreachable list has NEXT_MASK_UNREACHABLE flag. |
| 555 | * So we can not gc_list_* functions for unreachable until we remove the flag. |
Tim Peters | 8839617 | 2002-06-30 17:56:40 +0000 | [diff] [blame] | 556 | */ |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 557 | static void |
Tim Peters | 19b74c7 | 2002-07-01 03:52:19 +0000 | [diff] [blame] | 558 | move_unreachable(PyGC_Head *young, PyGC_Head *unreachable) |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 559 | { |
INADA Naoki | 5ac9e6e | 2018-07-10 17:19:53 +0900 | [diff] [blame] | 560 | // previous elem in the young list, used for restore gc_prev. |
| 561 | PyGC_Head *prev = young; |
| 562 | PyGC_Head *gc = GC_NEXT(young); |
Tim Peters | 19b74c7 | 2002-07-01 03:52:19 +0000 | [diff] [blame] | 563 | |
INADA Naoki | 5ac9e6e | 2018-07-10 17:19:53 +0900 | [diff] [blame] | 564 | /* Invariants: all objects "to the left" of us in young are reachable |
| 565 | * (directly or indirectly) from outside the young list as it was at entry. |
| 566 | * |
| 567 | * All other objects from the original young "to the left" of us are in |
| 568 | * unreachable now, and have NEXT_MASK_UNREACHABLE. All objects to the |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 569 | * left of us in 'young' now have been scanned, and no objects here |
| 570 | * or to the right have been scanned yet. |
| 571 | */ |
Tim Peters | 19b74c7 | 2002-07-01 03:52:19 +0000 | [diff] [blame] | 572 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 573 | while (gc != young) { |
INADA Naoki | 5ac9e6e | 2018-07-10 17:19:53 +0900 | [diff] [blame] | 574 | if (gc_get_refs(gc)) { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 575 | /* gc is definitely reachable from outside the |
| 576 | * original 'young'. Mark it as such, and traverse |
| 577 | * its pointers to find any other objects that may |
| 578 | * be directly reachable from it. Note that the |
| 579 | * call to tp_traverse may append objects to young, |
| 580 | * so we have to wait until it returns to determine |
| 581 | * the next object to visit. |
| 582 | */ |
| 583 | PyObject *op = FROM_GC(gc); |
| 584 | traverseproc traverse = Py_TYPE(op)->tp_traverse; |
Victor Stinner | a4b2bc7 | 2018-10-26 18:00:13 +0200 | [diff] [blame] | 585 | _PyObject_ASSERT_WITH_MSG(op, gc_get_refs(gc) > 0, |
| 586 | "refcount is too small"); |
INADA Naoki | 5ac9e6e | 2018-07-10 17:19:53 +0900 | [diff] [blame] | 587 | // NOTE: visit_reachable may change gc->_gc_next when |
| 588 | // young->_gc_prev == gc. Don't do gc = GC_NEXT(gc) before! |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 589 | (void) traverse(op, |
INADA Naoki | 5ac9e6e | 2018-07-10 17:19:53 +0900 | [diff] [blame] | 590 | (visitproc)visit_reachable, |
| 591 | (void *)young); |
| 592 | // relink gc_prev to prev element. |
| 593 | _PyGCHead_SET_PREV(gc, prev); |
Quan Tian | 3bd0d62 | 2018-10-20 05:30:03 +0800 | [diff] [blame] | 594 | // gc is not COLLECTING state after here. |
INADA Naoki | 5ac9e6e | 2018-07-10 17:19:53 +0900 | [diff] [blame] | 595 | gc_clear_collecting(gc); |
| 596 | prev = gc; |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 597 | } |
| 598 | else { |
| 599 | /* This *may* be unreachable. To make progress, |
| 600 | * assume it is. gc isn't directly reachable from |
| 601 | * any object we've already traversed, but may be |
| 602 | * reachable from an object we haven't gotten to yet. |
| 603 | * visit_reachable will eventually move gc back into |
| 604 | * young if that's so, and we'll see it again. |
| 605 | */ |
INADA Naoki | 5ac9e6e | 2018-07-10 17:19:53 +0900 | [diff] [blame] | 606 | // Move gc to unreachable. |
| 607 | // No need to gc->next->prev = prev because it is single linked. |
| 608 | prev->_gc_next = gc->_gc_next; |
| 609 | |
| 610 | // We can't use gc_list_append() here because we use |
| 611 | // NEXT_MASK_UNREACHABLE here. |
| 612 | PyGC_Head *last = GC_PREV(unreachable); |
| 613 | // NOTE: Since all objects in unreachable set has |
| 614 | // NEXT_MASK_UNREACHABLE flag, we set it unconditionally. |
Tim Peters | 95bfc8a | 2019-10-13 16:47:04 -0500 | [diff] [blame] | 615 | // But this may pollute the unreachable list head's 'next' pointer |
| 616 | // too. That's semantically senseless but expedient here - the |
Pablo Galindo | 97f1267 | 2020-01-13 12:25:05 +0000 | [diff] [blame] | 617 | // damage is repaired when this function ends. |
INADA Naoki | 5ac9e6e | 2018-07-10 17:19:53 +0900 | [diff] [blame] | 618 | last->_gc_next = (NEXT_MASK_UNREACHABLE | (uintptr_t)gc); |
| 619 | _PyGCHead_SET_PREV(gc, last); |
| 620 | gc->_gc_next = (NEXT_MASK_UNREACHABLE | (uintptr_t)unreachable); |
| 621 | unreachable->_gc_prev = (uintptr_t)gc; |
| 622 | } |
| 623 | gc = (PyGC_Head*)prev->_gc_next; |
| 624 | } |
| 625 | // young->_gc_prev must be last element remained in the list. |
| 626 | young->_gc_prev = (uintptr_t)prev; |
Tim Peters | 95bfc8a | 2019-10-13 16:47:04 -0500 | [diff] [blame] | 627 | // don't let the pollution of the list head's next pointer leak |
| 628 | unreachable->_gc_next &= ~NEXT_MASK_UNREACHABLE; |
INADA Naoki | 5ac9e6e | 2018-07-10 17:19:53 +0900 | [diff] [blame] | 629 | } |
| 630 | |
| 631 | static void |
| 632 | untrack_tuples(PyGC_Head *head) |
| 633 | { |
| 634 | PyGC_Head *next, *gc = GC_NEXT(head); |
| 635 | while (gc != head) { |
| 636 | PyObject *op = FROM_GC(gc); |
| 637 | next = GC_NEXT(gc); |
| 638 | if (PyTuple_CheckExact(op)) { |
| 639 | _PyTuple_MaybeUntrack(op); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 640 | } |
| 641 | gc = next; |
| 642 | } |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 643 | } |
| 644 | |
Antoine Pitrou | e1ad3da | 2012-05-28 22:22:34 +0200 | [diff] [blame] | 645 | /* Try to untrack all currently tracked dictionaries */ |
| 646 | static void |
| 647 | untrack_dicts(PyGC_Head *head) |
| 648 | { |
INADA Naoki | 5ac9e6e | 2018-07-10 17:19:53 +0900 | [diff] [blame] | 649 | PyGC_Head *next, *gc = GC_NEXT(head); |
Antoine Pitrou | e1ad3da | 2012-05-28 22:22:34 +0200 | [diff] [blame] | 650 | while (gc != head) { |
| 651 | PyObject *op = FROM_GC(gc); |
INADA Naoki | 5ac9e6e | 2018-07-10 17:19:53 +0900 | [diff] [blame] | 652 | next = GC_NEXT(gc); |
| 653 | if (PyDict_CheckExact(op)) { |
Antoine Pitrou | e1ad3da | 2012-05-28 22:22:34 +0200 | [diff] [blame] | 654 | _PyDict_MaybeUntrack(op); |
INADA Naoki | 5ac9e6e | 2018-07-10 17:19:53 +0900 | [diff] [blame] | 655 | } |
Antoine Pitrou | e1ad3da | 2012-05-28 22:22:34 +0200 | [diff] [blame] | 656 | gc = next; |
| 657 | } |
| 658 | } |
| 659 | |
Antoine Pitrou | 796564c | 2013-07-30 19:59:21 +0200 | [diff] [blame] | 660 | /* Return true if object has a pre-PEP 442 finalization method. */ |
Neil Schemenauer | a765c12 | 2001-11-01 17:35:23 +0000 | [diff] [blame] | 661 | static int |
Antoine Pitrou | 796564c | 2013-07-30 19:59:21 +0200 | [diff] [blame] | 662 | has_legacy_finalizer(PyObject *op) |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 663 | { |
Victor Stinner | daa9756 | 2020-02-07 03:37:06 +0100 | [diff] [blame] | 664 | return Py_TYPE(op)->tp_del != NULL; |
Neil Schemenauer | a765c12 | 2001-11-01 17:35:23 +0000 | [diff] [blame] | 665 | } |
| 666 | |
Antoine Pitrou | 796564c | 2013-07-30 19:59:21 +0200 | [diff] [blame] | 667 | /* Move the objects in unreachable with tp_del slots into `finalizers`. |
INADA Naoki | 5ac9e6e | 2018-07-10 17:19:53 +0900 | [diff] [blame] | 668 | * |
| 669 | * This function also removes NEXT_MASK_UNREACHABLE flag |
| 670 | * from _gc_next in unreachable. |
Jeremy Hylton | ce136e9 | 2003-04-04 19:59:06 +0000 | [diff] [blame] | 671 | */ |
Neil Schemenauer | a765c12 | 2001-11-01 17:35:23 +0000 | [diff] [blame] | 672 | static void |
Antoine Pitrou | 796564c | 2013-07-30 19:59:21 +0200 | [diff] [blame] | 673 | move_legacy_finalizers(PyGC_Head *unreachable, PyGC_Head *finalizers) |
Neil Schemenauer | a765c12 | 2001-11-01 17:35:23 +0000 | [diff] [blame] | 674 | { |
INADA Naoki | 5ac9e6e | 2018-07-10 17:19:53 +0900 | [diff] [blame] | 675 | PyGC_Head *gc, *next; |
Tim Peters | 95bfc8a | 2019-10-13 16:47:04 -0500 | [diff] [blame] | 676 | assert((unreachable->_gc_next & NEXT_MASK_UNREACHABLE) == 0); |
Tim Peters | f6b8045 | 2003-04-07 19:21:15 +0000 | [diff] [blame] | 677 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 678 | /* March over unreachable. Move objects with finalizers into |
| 679 | * `finalizers`. |
| 680 | */ |
INADA Naoki | 5ac9e6e | 2018-07-10 17:19:53 +0900 | [diff] [blame] | 681 | for (gc = GC_NEXT(unreachable); gc != unreachable; gc = next) { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 682 | PyObject *op = FROM_GC(gc); |
Jeremy Hylton | ce136e9 | 2003-04-04 19:59:06 +0000 | [diff] [blame] | 683 | |
Victor Stinner | a4b2bc7 | 2018-10-26 18:00:13 +0200 | [diff] [blame] | 684 | _PyObject_ASSERT(op, gc->_gc_next & NEXT_MASK_UNREACHABLE); |
INADA Naoki | 5ac9e6e | 2018-07-10 17:19:53 +0900 | [diff] [blame] | 685 | gc->_gc_next &= ~NEXT_MASK_UNREACHABLE; |
| 686 | next = (PyGC_Head*)gc->_gc_next; |
Tim Peters | f6ae7a4 | 2003-04-05 18:40:50 +0000 | [diff] [blame] | 687 | |
Antoine Pitrou | 796564c | 2013-07-30 19:59:21 +0200 | [diff] [blame] | 688 | if (has_legacy_finalizer(op)) { |
INADA Naoki | 5ac9e6e | 2018-07-10 17:19:53 +0900 | [diff] [blame] | 689 | gc_clear_collecting(gc); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 690 | gc_list_move(gc, finalizers); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 691 | } |
| 692 | } |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 693 | } |
| 694 | |
Pablo Galindo | 466326d | 2019-10-13 16:48:59 +0100 | [diff] [blame] | 695 | static inline void |
| 696 | clear_unreachable_mask(PyGC_Head *unreachable) |
| 697 | { |
| 698 | /* Check that the list head does not have the unreachable bit set */ |
| 699 | assert(((uintptr_t)unreachable & NEXT_MASK_UNREACHABLE) == 0); |
| 700 | |
| 701 | PyGC_Head *gc, *next; |
Tim Peters | 95bfc8a | 2019-10-13 16:47:04 -0500 | [diff] [blame] | 702 | assert((unreachable->_gc_next & NEXT_MASK_UNREACHABLE) == 0); |
Pablo Galindo | 466326d | 2019-10-13 16:48:59 +0100 | [diff] [blame] | 703 | for (gc = GC_NEXT(unreachable); gc != unreachable; gc = next) { |
| 704 | _PyObject_ASSERT((PyObject*)FROM_GC(gc), gc->_gc_next & NEXT_MASK_UNREACHABLE); |
| 705 | gc->_gc_next &= ~NEXT_MASK_UNREACHABLE; |
| 706 | next = (PyGC_Head*)gc->_gc_next; |
| 707 | } |
Tim Peters | ea55c51 | 2019-10-18 20:59:14 -0500 | [diff] [blame] | 708 | validate_list(unreachable, collecting_set_unreachable_clear); |
Pablo Galindo | 466326d | 2019-10-13 16:48:59 +0100 | [diff] [blame] | 709 | } |
| 710 | |
Antoine Pitrou | 796564c | 2013-07-30 19:59:21 +0200 | [diff] [blame] | 711 | /* A traversal callback for move_legacy_finalizer_reachable. */ |
Tim Peters | 19b74c7 | 2002-07-01 03:52:19 +0000 | [diff] [blame] | 712 | static int |
| 713 | visit_move(PyObject *op, PyGC_Head *tolist) |
| 714 | { |
Hai Shi | 675d9a3 | 2020-04-15 02:11:20 +0800 | [diff] [blame] | 715 | if (_PyObject_IS_GC(op)) { |
INADA Naoki | 5ac9e6e | 2018-07-10 17:19:53 +0900 | [diff] [blame] | 716 | PyGC_Head *gc = AS_GC(op); |
| 717 | if (gc_is_collecting(gc)) { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 718 | gc_list_move(gc, tolist); |
INADA Naoki | 5ac9e6e | 2018-07-10 17:19:53 +0900 | [diff] [blame] | 719 | gc_clear_collecting(gc); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 720 | } |
| 721 | } |
| 722 | return 0; |
Tim Peters | 19b74c7 | 2002-07-01 03:52:19 +0000 | [diff] [blame] | 723 | } |
| 724 | |
| 725 | /* Move objects that are reachable from finalizers, from the unreachable set |
Tim Peters | f6b8045 | 2003-04-07 19:21:15 +0000 | [diff] [blame] | 726 | * into finalizers set. |
Tim Peters | 19b74c7 | 2002-07-01 03:52:19 +0000 | [diff] [blame] | 727 | */ |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 728 | static void |
Antoine Pitrou | 796564c | 2013-07-30 19:59:21 +0200 | [diff] [blame] | 729 | move_legacy_finalizer_reachable(PyGC_Head *finalizers) |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 730 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 731 | traverseproc traverse; |
INADA Naoki | 5ac9e6e | 2018-07-10 17:19:53 +0900 | [diff] [blame] | 732 | PyGC_Head *gc = GC_NEXT(finalizers); |
| 733 | for (; gc != finalizers; gc = GC_NEXT(gc)) { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 734 | /* Note that the finalizers list may grow during this. */ |
| 735 | traverse = Py_TYPE(FROM_GC(gc))->tp_traverse; |
| 736 | (void) traverse(FROM_GC(gc), |
| 737 | (visitproc)visit_move, |
| 738 | (void *)finalizers); |
| 739 | } |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 740 | } |
| 741 | |
Tim Peters | ead8b7a | 2004-10-30 23:09:22 +0000 | [diff] [blame] | 742 | /* Clear all weakrefs to unreachable objects, and if such a weakref has a |
| 743 | * callback, invoke it if necessary. Note that it's possible for such |
| 744 | * weakrefs to be outside the unreachable set -- indeed, those are precisely |
| 745 | * the weakrefs whose callbacks must be invoked. See gc_weakref.txt for |
| 746 | * overview & some details. Some weakrefs with callbacks may be reclaimed |
| 747 | * directly by this routine; the number reclaimed is the return value. Other |
| 748 | * weakrefs with callbacks may be moved into the `old` generation. Objects |
| 749 | * moved into `old` have gc_refs set to GC_REACHABLE; the objects remaining in |
| 750 | * unreachable are left at GC_TENTATIVELY_UNREACHABLE. When this returns, |
| 751 | * no object in `unreachable` is weakly referenced anymore. |
Tim Peters | 403a203 | 2003-11-20 21:21:46 +0000 | [diff] [blame] | 752 | */ |
| 753 | static int |
Tim Peters | ead8b7a | 2004-10-30 23:09:22 +0000 | [diff] [blame] | 754 | handle_weakrefs(PyGC_Head *unreachable, PyGC_Head *old) |
Tim Peters | 403a203 | 2003-11-20 21:21:46 +0000 | [diff] [blame] | 755 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 756 | PyGC_Head *gc; |
| 757 | PyObject *op; /* generally FROM_GC(gc) */ |
| 758 | PyWeakReference *wr; /* generally a cast of op */ |
| 759 | PyGC_Head wrcb_to_call; /* weakrefs with callbacks to call */ |
| 760 | PyGC_Head *next; |
| 761 | int num_freed = 0; |
Tim Peters | 403a203 | 2003-11-20 21:21:46 +0000 | [diff] [blame] | 762 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 763 | gc_list_init(&wrcb_to_call); |
Tim Peters | 403a203 | 2003-11-20 21:21:46 +0000 | [diff] [blame] | 764 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 765 | /* Clear all weakrefs to the objects in unreachable. If such a weakref |
| 766 | * also has a callback, move it into `wrcb_to_call` if the callback |
| 767 | * needs to be invoked. Note that we cannot invoke any callbacks until |
| 768 | * all weakrefs to unreachable objects are cleared, lest the callback |
| 769 | * resurrect an unreachable object via a still-active weakref. We |
| 770 | * make another pass over wrcb_to_call, invoking callbacks, after this |
| 771 | * pass completes. |
| 772 | */ |
INADA Naoki | 5ac9e6e | 2018-07-10 17:19:53 +0900 | [diff] [blame] | 773 | for (gc = GC_NEXT(unreachable); gc != unreachable; gc = next) { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 774 | PyWeakReference **wrlist; |
Tim Peters | ead8b7a | 2004-10-30 23:09:22 +0000 | [diff] [blame] | 775 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 776 | op = FROM_GC(gc); |
INADA Naoki | 5ac9e6e | 2018-07-10 17:19:53 +0900 | [diff] [blame] | 777 | next = GC_NEXT(gc); |
Tim Peters | ead8b7a | 2004-10-30 23:09:22 +0000 | [diff] [blame] | 778 | |
Neil Schemenauer | bcda460 | 2019-09-30 10:06:45 -0700 | [diff] [blame] | 779 | if (PyWeakref_Check(op)) { |
| 780 | /* A weakref inside the unreachable set must be cleared. If we |
| 781 | * allow its callback to execute inside delete_garbage(), it |
| 782 | * could expose objects that have tp_clear already called on |
| 783 | * them. Or, it could resurrect unreachable objects. One way |
| 784 | * this can happen is if some container objects do not implement |
| 785 | * tp_traverse. Then, wr_object can be outside the unreachable |
| 786 | * set but can be deallocated as a result of breaking the |
| 787 | * reference cycle. If we don't clear the weakref, the callback |
| 788 | * will run and potentially cause a crash. See bpo-38006 for |
| 789 | * one example. |
| 790 | */ |
| 791 | _PyWeakref_ClearRef((PyWeakReference *)op); |
| 792 | } |
| 793 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 794 | if (! PyType_SUPPORTS_WEAKREFS(Py_TYPE(op))) |
| 795 | continue; |
Tim Peters | ead8b7a | 2004-10-30 23:09:22 +0000 | [diff] [blame] | 796 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 797 | /* It supports weakrefs. Does it have any? */ |
| 798 | wrlist = (PyWeakReference **) |
Victor Stinner | 38aefc5 | 2020-04-06 14:07:02 +0200 | [diff] [blame] | 799 | _PyObject_GET_WEAKREFS_LISTPTR(op); |
Tim Peters | ead8b7a | 2004-10-30 23:09:22 +0000 | [diff] [blame] | 800 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 801 | /* `op` may have some weakrefs. March over the list, clear |
| 802 | * all the weakrefs, and move the weakrefs with callbacks |
| 803 | * that must be called into wrcb_to_call. |
| 804 | */ |
| 805 | for (wr = *wrlist; wr != NULL; wr = *wrlist) { |
| 806 | PyGC_Head *wrasgc; /* AS_GC(wr) */ |
Tim Peters | ead8b7a | 2004-10-30 23:09:22 +0000 | [diff] [blame] | 807 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 808 | /* _PyWeakref_ClearRef clears the weakref but leaves |
| 809 | * the callback pointer intact. Obscure: it also |
| 810 | * changes *wrlist. |
| 811 | */ |
Victor Stinner | a4b2bc7 | 2018-10-26 18:00:13 +0200 | [diff] [blame] | 812 | _PyObject_ASSERT((PyObject *)wr, wr->wr_object == op); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 813 | _PyWeakref_ClearRef(wr); |
Victor Stinner | a4b2bc7 | 2018-10-26 18:00:13 +0200 | [diff] [blame] | 814 | _PyObject_ASSERT((PyObject *)wr, wr->wr_object == Py_None); |
| 815 | if (wr->wr_callback == NULL) { |
| 816 | /* no callback */ |
| 817 | continue; |
| 818 | } |
Tim Peters | ead8b7a | 2004-10-30 23:09:22 +0000 | [diff] [blame] | 819 | |
Victor Stinner | a4b2bc7 | 2018-10-26 18:00:13 +0200 | [diff] [blame] | 820 | /* Headache time. `op` is going away, and is weakly referenced by |
| 821 | * `wr`, which has a callback. Should the callback be invoked? If wr |
| 822 | * is also trash, no: |
| 823 | * |
| 824 | * 1. There's no need to call it. The object and the weakref are |
| 825 | * both going away, so it's legitimate to pretend the weakref is |
| 826 | * going away first. The user has to ensure a weakref outlives its |
| 827 | * referent if they want a guarantee that the wr callback will get |
| 828 | * invoked. |
| 829 | * |
| 830 | * 2. It may be catastrophic to call it. If the callback is also in |
| 831 | * cyclic trash (CT), then although the CT is unreachable from |
| 832 | * outside the current generation, CT may be reachable from the |
| 833 | * callback. Then the callback could resurrect insane objects. |
| 834 | * |
| 835 | * Since the callback is never needed and may be unsafe in this case, |
| 836 | * wr is simply left in the unreachable set. Note that because we |
| 837 | * already called _PyWeakref_ClearRef(wr), its callback will never |
| 838 | * trigger. |
| 839 | * |
| 840 | * OTOH, if wr isn't part of CT, we should invoke the callback: the |
| 841 | * weakref outlived the trash. Note that since wr isn't CT in this |
| 842 | * case, its callback can't be CT either -- wr acted as an external |
| 843 | * root to this generation, and therefore its callback did too. So |
| 844 | * nothing in CT is reachable from the callback either, so it's hard |
| 845 | * to imagine how calling it later could create a problem for us. wr |
| 846 | * is moved to wrcb_to_call in this case. |
| 847 | */ |
INADA Naoki | 5ac9e6e | 2018-07-10 17:19:53 +0900 | [diff] [blame] | 848 | if (gc_is_collecting(AS_GC(wr))) { |
Neil Schemenauer | bcda460 | 2019-09-30 10:06:45 -0700 | [diff] [blame] | 849 | /* it should already have been cleared above */ |
| 850 | assert(wr->wr_object == Py_None); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 851 | continue; |
INADA Naoki | 5ac9e6e | 2018-07-10 17:19:53 +0900 | [diff] [blame] | 852 | } |
Tim Peters | cc2a866 | 2004-10-31 22:12:43 +0000 | [diff] [blame] | 853 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 854 | /* Create a new reference so that wr can't go away |
| 855 | * before we can process it again. |
| 856 | */ |
| 857 | Py_INCREF(wr); |
Tim Peters | ead8b7a | 2004-10-30 23:09:22 +0000 | [diff] [blame] | 858 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 859 | /* Move wr to wrcb_to_call, for the next pass. */ |
| 860 | wrasgc = AS_GC(wr); |
| 861 | assert(wrasgc != next); /* wrasgc is reachable, but |
| 862 | next isn't, so they can't |
| 863 | be the same */ |
| 864 | gc_list_move(wrasgc, &wrcb_to_call); |
| 865 | } |
| 866 | } |
Tim Peters | ead8b7a | 2004-10-30 23:09:22 +0000 | [diff] [blame] | 867 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 868 | /* Invoke the callbacks we decided to honor. It's safe to invoke them |
| 869 | * because they can't reference unreachable objects. |
| 870 | */ |
| 871 | while (! gc_list_is_empty(&wrcb_to_call)) { |
| 872 | PyObject *temp; |
| 873 | PyObject *callback; |
Tim Peters | ead8b7a | 2004-10-30 23:09:22 +0000 | [diff] [blame] | 874 | |
INADA Naoki | 5ac9e6e | 2018-07-10 17:19:53 +0900 | [diff] [blame] | 875 | gc = (PyGC_Head*)wrcb_to_call._gc_next; |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 876 | op = FROM_GC(gc); |
Victor Stinner | a4b2bc7 | 2018-10-26 18:00:13 +0200 | [diff] [blame] | 877 | _PyObject_ASSERT(op, PyWeakref_Check(op)); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 878 | wr = (PyWeakReference *)op; |
| 879 | callback = wr->wr_callback; |
Victor Stinner | a4b2bc7 | 2018-10-26 18:00:13 +0200 | [diff] [blame] | 880 | _PyObject_ASSERT(op, callback != NULL); |
Tim Peters | ead8b7a | 2004-10-30 23:09:22 +0000 | [diff] [blame] | 881 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 882 | /* copy-paste of weakrefobject.c's handle_callback() */ |
Petr Viktorin | ffd9753 | 2020-02-11 17:46:57 +0100 | [diff] [blame] | 883 | temp = PyObject_CallOneArg(callback, (PyObject *)wr); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 884 | if (temp == NULL) |
| 885 | PyErr_WriteUnraisable(callback); |
| 886 | else |
| 887 | Py_DECREF(temp); |
Tim Peters | ead8b7a | 2004-10-30 23:09:22 +0000 | [diff] [blame] | 888 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 889 | /* Give up the reference we created in the first pass. When |
| 890 | * op's refcount hits 0 (which it may or may not do right now), |
| 891 | * op's tp_dealloc will decref op->wr_callback too. Note |
| 892 | * that the refcount probably will hit 0 now, and because this |
| 893 | * weakref was reachable to begin with, gc didn't already |
| 894 | * add it to its count of freed objects. Example: a reachable |
| 895 | * weak value dict maps some key to this reachable weakref. |
| 896 | * The callback removes this key->weakref mapping from the |
| 897 | * dict, leaving no other references to the weakref (excepting |
| 898 | * ours). |
| 899 | */ |
| 900 | Py_DECREF(op); |
INADA Naoki | 5ac9e6e | 2018-07-10 17:19:53 +0900 | [diff] [blame] | 901 | if (wrcb_to_call._gc_next == (uintptr_t)gc) { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 902 | /* object is still alive -- move it */ |
| 903 | gc_list_move(gc, old); |
| 904 | } |
INADA Naoki | 5ac9e6e | 2018-07-10 17:19:53 +0900 | [diff] [blame] | 905 | else { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 906 | ++num_freed; |
INADA Naoki | 5ac9e6e | 2018-07-10 17:19:53 +0900 | [diff] [blame] | 907 | } |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 908 | } |
Tim Peters | ead8b7a | 2004-10-30 23:09:22 +0000 | [diff] [blame] | 909 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 910 | return num_freed; |
Tim Peters | 403a203 | 2003-11-20 21:21:46 +0000 | [diff] [blame] | 911 | } |
| 912 | |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 913 | static void |
Serhiy Storchaka | ef1585e | 2015-12-25 20:01:53 +0200 | [diff] [blame] | 914 | debug_cycle(const char *msg, PyObject *op) |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 915 | { |
Victor Stinner | 499dfcf | 2011-03-21 13:26:24 +0100 | [diff] [blame] | 916 | PySys_FormatStderr("gc: %s <%s %p>\n", |
| 917 | msg, Py_TYPE(op)->tp_name, op); |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 918 | } |
| 919 | |
Antoine Pitrou | 796564c | 2013-07-30 19:59:21 +0200 | [diff] [blame] | 920 | /* Handle uncollectable garbage (cycles with tp_del slots, and stuff reachable |
Tim Peters | bf384c2 | 2003-04-06 00:11:39 +0000 | [diff] [blame] | 921 | * only from such cycles). |
Tim Peters | f6b8045 | 2003-04-07 19:21:15 +0000 | [diff] [blame] | 922 | * If DEBUG_SAVEALL, all objects in finalizers are appended to the module |
| 923 | * garbage list (a Python list), else only the objects in finalizers with |
| 924 | * __del__ methods are appended to garbage. All objects in finalizers are |
| 925 | * merged into the old list regardless. |
Tim Peters | bf384c2 | 2003-04-06 00:11:39 +0000 | [diff] [blame] | 926 | */ |
Serhiy Storchaka | 301e3cc | 2018-05-24 15:19:29 +0300 | [diff] [blame] | 927 | static void |
Victor Stinner | 2e96906 | 2019-11-20 01:49:32 +0100 | [diff] [blame] | 928 | handle_legacy_finalizers(PyThreadState *tstate, |
Victor Stinner | 67e0de6 | 2019-11-20 11:48:18 +0100 | [diff] [blame] | 929 | GCState *gcstate, |
Victor Stinner | 9db0324 | 2019-04-26 02:32:01 +0200 | [diff] [blame] | 930 | PyGC_Head *finalizers, PyGC_Head *old) |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 931 | { |
Victor Stinner | 2e96906 | 2019-11-20 01:49:32 +0100 | [diff] [blame] | 932 | assert(!_PyErr_Occurred(tstate)); |
Victor Stinner | 67e0de6 | 2019-11-20 11:48:18 +0100 | [diff] [blame] | 933 | assert(gcstate->garbage != NULL); |
Victor Stinner | 9db0324 | 2019-04-26 02:32:01 +0200 | [diff] [blame] | 934 | |
| 935 | PyGC_Head *gc = GC_NEXT(finalizers); |
INADA Naoki | 5ac9e6e | 2018-07-10 17:19:53 +0900 | [diff] [blame] | 936 | for (; gc != finalizers; gc = GC_NEXT(gc)) { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 937 | PyObject *op = FROM_GC(gc); |
Tim Peters | f6b8045 | 2003-04-07 19:21:15 +0000 | [diff] [blame] | 938 | |
Victor Stinner | 67e0de6 | 2019-11-20 11:48:18 +0100 | [diff] [blame] | 939 | if ((gcstate->debug & DEBUG_SAVEALL) || has_legacy_finalizer(op)) { |
| 940 | if (PyList_Append(gcstate->garbage, op) < 0) { |
Victor Stinner | 2e96906 | 2019-11-20 01:49:32 +0100 | [diff] [blame] | 941 | _PyErr_Clear(tstate); |
Serhiy Storchaka | 301e3cc | 2018-05-24 15:19:29 +0300 | [diff] [blame] | 942 | break; |
Serhiy Storchaka | c4653c9 | 2018-05-29 18:50:10 +0300 | [diff] [blame] | 943 | } |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 944 | } |
| 945 | } |
Tim Peters | f6b8045 | 2003-04-07 19:21:15 +0000 | [diff] [blame] | 946 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 947 | gc_list_merge(finalizers, old); |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 948 | } |
| 949 | |
Tim Peters | 5fbc7b1 | 2014-05-08 17:42:19 -0500 | [diff] [blame] | 950 | /* Run first-time finalizers (if any) on all the objects in collectable. |
| 951 | * Note that this may remove some (or even all) of the objects from the |
| 952 | * list, due to refcounts falling to 0. |
| 953 | */ |
Antoine Pitrou | 796564c | 2013-07-30 19:59:21 +0200 | [diff] [blame] | 954 | static void |
Victor Stinner | 67e0de6 | 2019-11-20 11:48:18 +0100 | [diff] [blame] | 955 | finalize_garbage(PyThreadState *tstate, PyGC_Head *collectable) |
Antoine Pitrou | 796564c | 2013-07-30 19:59:21 +0200 | [diff] [blame] | 956 | { |
| 957 | destructor finalize; |
Tim Peters | 5fbc7b1 | 2014-05-08 17:42:19 -0500 | [diff] [blame] | 958 | PyGC_Head seen; |
Antoine Pitrou | 796564c | 2013-07-30 19:59:21 +0200 | [diff] [blame] | 959 | |
Tim Peters | 5fbc7b1 | 2014-05-08 17:42:19 -0500 | [diff] [blame] | 960 | /* While we're going through the loop, `finalize(op)` may cause op, or |
| 961 | * other objects, to be reclaimed via refcounts falling to zero. So |
| 962 | * there's little we can rely on about the structure of the input |
| 963 | * `collectable` list across iterations. For safety, we always take the |
| 964 | * first object in that list and move it to a temporary `seen` list. |
| 965 | * If objects vanish from the `collectable` and `seen` lists we don't |
| 966 | * care. |
| 967 | */ |
| 968 | gc_list_init(&seen); |
| 969 | |
| 970 | while (!gc_list_is_empty(collectable)) { |
INADA Naoki | 5ac9e6e | 2018-07-10 17:19:53 +0900 | [diff] [blame] | 971 | PyGC_Head *gc = GC_NEXT(collectable); |
Antoine Pitrou | 796564c | 2013-07-30 19:59:21 +0200 | [diff] [blame] | 972 | PyObject *op = FROM_GC(gc); |
Tim Peters | 5fbc7b1 | 2014-05-08 17:42:19 -0500 | [diff] [blame] | 973 | gc_list_move(gc, &seen); |
Antoine Pitrou | 796564c | 2013-07-30 19:59:21 +0200 | [diff] [blame] | 974 | if (!_PyGCHead_FINALIZED(gc) && |
Tim Peters | 5fbc7b1 | 2014-05-08 17:42:19 -0500 | [diff] [blame] | 975 | (finalize = Py_TYPE(op)->tp_finalize) != NULL) { |
INADA Naoki | 5ac9e6e | 2018-07-10 17:19:53 +0900 | [diff] [blame] | 976 | _PyGCHead_SET_FINALIZED(gc); |
Antoine Pitrou | 796564c | 2013-07-30 19:59:21 +0200 | [diff] [blame] | 977 | Py_INCREF(op); |
| 978 | finalize(op); |
Victor Stinner | 67e0de6 | 2019-11-20 11:48:18 +0100 | [diff] [blame] | 979 | assert(!_PyErr_Occurred(tstate)); |
Antoine Pitrou | 796564c | 2013-07-30 19:59:21 +0200 | [diff] [blame] | 980 | Py_DECREF(op); |
| 981 | } |
| 982 | } |
Tim Peters | 5fbc7b1 | 2014-05-08 17:42:19 -0500 | [diff] [blame] | 983 | gc_list_merge(&seen, collectable); |
Antoine Pitrou | 796564c | 2013-07-30 19:59:21 +0200 | [diff] [blame] | 984 | } |
| 985 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 986 | /* Break reference cycles by clearing the containers involved. This is |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 987 | * tricky business as the lists can be changing and we don't know which |
Tim Peters | 19b74c7 | 2002-07-01 03:52:19 +0000 | [diff] [blame] | 988 | * objects may be freed. It is possible I screwed something up here. |
| 989 | */ |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 990 | static void |
Victor Stinner | 67e0de6 | 2019-11-20 11:48:18 +0100 | [diff] [blame] | 991 | delete_garbage(PyThreadState *tstate, GCState *gcstate, |
Victor Stinner | 9db0324 | 2019-04-26 02:32:01 +0200 | [diff] [blame] | 992 | PyGC_Head *collectable, PyGC_Head *old) |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 993 | { |
Victor Stinner | 2e96906 | 2019-11-20 01:49:32 +0100 | [diff] [blame] | 994 | assert(!_PyErr_Occurred(tstate)); |
Victor Stinner | 9db0324 | 2019-04-26 02:32:01 +0200 | [diff] [blame] | 995 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 996 | while (!gc_list_is_empty(collectable)) { |
INADA Naoki | 5ac9e6e | 2018-07-10 17:19:53 +0900 | [diff] [blame] | 997 | PyGC_Head *gc = GC_NEXT(collectable); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 998 | PyObject *op = FROM_GC(gc); |
Tim Peters | 8839617 | 2002-06-30 17:56:40 +0000 | [diff] [blame] | 999 | |
Victor Stinner | a4b2bc7 | 2018-10-26 18:00:13 +0200 | [diff] [blame] | 1000 | _PyObject_ASSERT_WITH_MSG(op, Py_REFCNT(op) > 0, |
| 1001 | "refcount is too small"); |
INADA Naoki | 5ac9e6e | 2018-07-10 17:19:53 +0900 | [diff] [blame] | 1002 | |
Victor Stinner | 67e0de6 | 2019-11-20 11:48:18 +0100 | [diff] [blame] | 1003 | if (gcstate->debug & DEBUG_SAVEALL) { |
| 1004 | assert(gcstate->garbage != NULL); |
| 1005 | if (PyList_Append(gcstate->garbage, op) < 0) { |
Victor Stinner | 2e96906 | 2019-11-20 01:49:32 +0100 | [diff] [blame] | 1006 | _PyErr_Clear(tstate); |
Serhiy Storchaka | c4653c9 | 2018-05-29 18:50:10 +0300 | [diff] [blame] | 1007 | } |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1008 | } |
| 1009 | else { |
Victor Stinner | 9db0324 | 2019-04-26 02:32:01 +0200 | [diff] [blame] | 1010 | inquiry clear; |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1011 | if ((clear = Py_TYPE(op)->tp_clear) != NULL) { |
| 1012 | Py_INCREF(op); |
Serhiy Storchaka | c4653c9 | 2018-05-29 18:50:10 +0300 | [diff] [blame] | 1013 | (void) clear(op); |
Victor Stinner | 2e96906 | 2019-11-20 01:49:32 +0100 | [diff] [blame] | 1014 | if (_PyErr_Occurred(tstate)) { |
Victor Stinner | 71c52e3 | 2019-05-27 08:57:14 +0200 | [diff] [blame] | 1015 | _PyErr_WriteUnraisableMsg("in tp_clear of", |
| 1016 | (PyObject*)Py_TYPE(op)); |
Serhiy Storchaka | c4653c9 | 2018-05-29 18:50:10 +0300 | [diff] [blame] | 1017 | } |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1018 | Py_DECREF(op); |
| 1019 | } |
| 1020 | } |
INADA Naoki | 5ac9e6e | 2018-07-10 17:19:53 +0900 | [diff] [blame] | 1021 | if (GC_NEXT(collectable) == gc) { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1022 | /* object is still alive, move it, it may die later */ |
Pablo Galindo | 466326d | 2019-10-13 16:48:59 +0100 | [diff] [blame] | 1023 | gc_clear_collecting(gc); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1024 | gc_list_move(gc, old); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1025 | } |
| 1026 | } |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 1027 | } |
| 1028 | |
Christian Heimes | a156e09 | 2008-02-16 07:38:31 +0000 | [diff] [blame] | 1029 | /* Clear all free lists |
| 1030 | * All free lists are cleared during the collection of the highest generation. |
| 1031 | * Allocated items in the free list may keep a pymalloc arena occupied. |
| 1032 | * Clearing the free lists may give back memory to the OS earlier. |
| 1033 | */ |
| 1034 | static void |
Victor Stinner | e005ead | 2020-06-05 02:56:37 +0200 | [diff] [blame] | 1035 | clear_freelists(PyThreadState *tstate) |
Christian Heimes | a156e09 | 2008-02-16 07:38:31 +0000 | [diff] [blame] | 1036 | { |
Victor Stinner | 3744ed2 | 2020-06-05 01:39:24 +0200 | [diff] [blame] | 1037 | _PyFrame_ClearFreeList(tstate); |
Victor Stinner | 69ac6e5 | 2020-06-04 23:38:36 +0200 | [diff] [blame] | 1038 | _PyTuple_ClearFreeList(tstate); |
Victor Stinner | 2ba5937 | 2020-06-05 00:50:05 +0200 | [diff] [blame] | 1039 | _PyFloat_ClearFreeList(tstate); |
Victor Stinner | 88ec919 | 2020-06-05 02:05:41 +0200 | [diff] [blame] | 1040 | _PyList_ClearFreeList(tstate); |
Victor Stinner | ae00a5a | 2020-04-29 02:29:20 +0200 | [diff] [blame] | 1041 | _PyDict_ClearFreeList(); |
Victor Stinner | 78a02c2 | 2020-06-05 02:34:14 +0200 | [diff] [blame] | 1042 | _PyAsyncGen_ClearFreeLists(tstate); |
Victor Stinner | e005ead | 2020-06-05 02:56:37 +0200 | [diff] [blame] | 1043 | _PyContext_ClearFreeList(tstate); |
Christian Heimes | a156e09 | 2008-02-16 07:38:31 +0000 | [diff] [blame] | 1044 | } |
| 1045 | |
Pablo Galindo | 97f1267 | 2020-01-13 12:25:05 +0000 | [diff] [blame] | 1046 | // Show stats for objects in each generations |
Inada Naoki | bf8162c | 2019-08-02 16:25:29 +0900 | [diff] [blame] | 1047 | static void |
Victor Stinner | 67e0de6 | 2019-11-20 11:48:18 +0100 | [diff] [blame] | 1048 | show_stats_each_generations(GCState *gcstate) |
Inada Naoki | bf8162c | 2019-08-02 16:25:29 +0900 | [diff] [blame] | 1049 | { |
| 1050 | char buf[100]; |
| 1051 | size_t pos = 0; |
| 1052 | |
| 1053 | for (int i = 0; i < NUM_GENERATIONS && pos < sizeof(buf); i++) { |
| 1054 | pos += PyOS_snprintf(buf+pos, sizeof(buf)-pos, |
Victor Stinner | d36cf5f | 2020-06-10 18:38:05 +0200 | [diff] [blame] | 1055 | " %zd", |
Victor Stinner | 67e0de6 | 2019-11-20 11:48:18 +0100 | [diff] [blame] | 1056 | gc_list_size(GEN_HEAD(gcstate, i))); |
Inada Naoki | bf8162c | 2019-08-02 16:25:29 +0900 | [diff] [blame] | 1057 | } |
| 1058 | |
| 1059 | PySys_FormatStderr( |
| 1060 | "gc: objects in each generation:%s\n" |
| 1061 | "gc: objects in permanent generation: %zd\n", |
Victor Stinner | 67e0de6 | 2019-11-20 11:48:18 +0100 | [diff] [blame] | 1062 | buf, gc_list_size(&gcstate->permanent_generation.head)); |
Inada Naoki | bf8162c | 2019-08-02 16:25:29 +0900 | [diff] [blame] | 1063 | } |
| 1064 | |
Pablo Galindo | 97f1267 | 2020-01-13 12:25:05 +0000 | [diff] [blame] | 1065 | /* Deduce which objects among "base" are unreachable from outside the list |
Pablo Galindo | 466326d | 2019-10-13 16:48:59 +0100 | [diff] [blame] | 1066 | and move them to 'unreachable'. The process consist in the following steps: |
| 1067 | |
| 1068 | 1. Copy all reference counts to a different field (gc_prev is used to hold |
| 1069 | this copy to save memory). |
| 1070 | 2. Traverse all objects in "base" and visit all referred objects using |
Pablo Galindo | 97f1267 | 2020-01-13 12:25:05 +0000 | [diff] [blame] | 1071 | "tp_traverse" and for every visited object, subtract 1 to the reference |
Pablo Galindo | 466326d | 2019-10-13 16:48:59 +0100 | [diff] [blame] | 1072 | count (the one that we copied in the previous step). After this step, all |
| 1073 | objects that can be reached directly from outside must have strictly positive |
| 1074 | reference count, while all unreachable objects must have a count of exactly 0. |
Pablo Galindo | 97f1267 | 2020-01-13 12:25:05 +0000 | [diff] [blame] | 1075 | 3. Identify all unreachable objects (the ones with 0 reference count) and move |
Pablo Galindo | 466326d | 2019-10-13 16:48:59 +0100 | [diff] [blame] | 1076 | them to the "unreachable" list. This step also needs to move back to "base" all |
| 1077 | objects that were initially marked as unreachable but are referred transitively |
| 1078 | by the reachable objects (the ones with strictly positive reference count). |
| 1079 | |
| 1080 | Contracts: |
| 1081 | |
| 1082 | * The "base" has to be a valid list with no mask set. |
| 1083 | |
| 1084 | * The "unreachable" list must be uninitialized (this function calls |
| 1085 | gc_list_init over 'unreachable'). |
Tim Peters | 95bfc8a | 2019-10-13 16:47:04 -0500 | [diff] [blame] | 1086 | |
Pablo Galindo | 466326d | 2019-10-13 16:48:59 +0100 | [diff] [blame] | 1087 | IMPORTANT: This function leaves 'unreachable' with the NEXT_MASK_UNREACHABLE |
| 1088 | flag set but it does not clear it to skip unnecessary iteration. Before the |
| 1089 | flag is cleared (for example, by using 'clear_unreachable_mask' function or |
| 1090 | by a call to 'move_legacy_finalizers'), the 'unreachable' list is not a normal |
| 1091 | list and we can not use most gc_list_* functions for it. */ |
| 1092 | static inline void |
| 1093 | deduce_unreachable(PyGC_Head *base, PyGC_Head *unreachable) { |
Tim Peters | ea55c51 | 2019-10-18 20:59:14 -0500 | [diff] [blame] | 1094 | validate_list(base, collecting_clear_unreachable_clear); |
Pablo Galindo | 466326d | 2019-10-13 16:48:59 +0100 | [diff] [blame] | 1095 | /* Using ob_refcnt and gc_refs, calculate which objects in the |
| 1096 | * container set are reachable from outside the set (i.e., have a |
| 1097 | * refcount greater than 0 when all the references within the |
| 1098 | * set are taken into account). |
| 1099 | */ |
| 1100 | update_refs(base); // gc_prev is used for gc_refs |
| 1101 | subtract_refs(base); |
| 1102 | |
| 1103 | /* Leave everything reachable from outside base in base, and move |
| 1104 | * everything else (in base) to unreachable. |
Pablo Galindo | 97f1267 | 2020-01-13 12:25:05 +0000 | [diff] [blame] | 1105 | * |
Pablo Galindo | 466326d | 2019-10-13 16:48:59 +0100 | [diff] [blame] | 1106 | * NOTE: This used to move the reachable objects into a reachable |
| 1107 | * set instead. But most things usually turn out to be reachable, |
Pablo Galindo | 97f1267 | 2020-01-13 12:25:05 +0000 | [diff] [blame] | 1108 | * so it's more efficient to move the unreachable things. It "sounds slick" |
| 1109 | * to move the unreachable objects, until you think about it - the reason it |
| 1110 | * pays isn't actually obvious. |
| 1111 | * |
| 1112 | * Suppose we create objects A, B, C in that order. They appear in the young |
| 1113 | * generation in the same order. If B points to A, and C to B, and C is |
| 1114 | * reachable from outside, then the adjusted refcounts will be 0, 0, and 1 |
| 1115 | * respectively. |
| 1116 | * |
| 1117 | * When move_unreachable finds A, A is moved to the unreachable list. The |
| 1118 | * same for B when it's first encountered. Then C is traversed, B is moved |
| 1119 | * _back_ to the reachable list. B is eventually traversed, and then A is |
| 1120 | * moved back to the reachable list. |
| 1121 | * |
| 1122 | * So instead of not moving at all, the reachable objects B and A are moved |
| 1123 | * twice each. Why is this a win? A straightforward algorithm to move the |
| 1124 | * reachable objects instead would move A, B, and C once each. |
| 1125 | * |
| 1126 | * The key is that this dance leaves the objects in order C, B, A - it's |
| 1127 | * reversed from the original order. On all _subsequent_ scans, none of |
| 1128 | * them will move. Since most objects aren't in cycles, this can save an |
| 1129 | * unbounded number of moves across an unbounded number of later collections. |
| 1130 | * It can cost more only the first time the chain is scanned. |
| 1131 | * |
| 1132 | * Drawback: move_unreachable is also used to find out what's still trash |
| 1133 | * after finalizers may resurrect objects. In _that_ case most unreachable |
| 1134 | * objects will remain unreachable, so it would be more efficient to move |
| 1135 | * the reachable objects instead. But this is a one-time cost, probably not |
| 1136 | * worth complicating the code to speed just a little. |
Pablo Galindo | 466326d | 2019-10-13 16:48:59 +0100 | [diff] [blame] | 1137 | */ |
| 1138 | gc_list_init(unreachable); |
| 1139 | move_unreachable(base, unreachable); // gc_prev is pointer again |
Tim Peters | ea55c51 | 2019-10-18 20:59:14 -0500 | [diff] [blame] | 1140 | validate_list(base, collecting_clear_unreachable_clear); |
| 1141 | validate_list(unreachable, collecting_set_unreachable_set); |
Pablo Galindo | 466326d | 2019-10-13 16:48:59 +0100 | [diff] [blame] | 1142 | } |
| 1143 | |
| 1144 | /* Handle objects that may have resurrected after a call to 'finalize_garbage', moving |
| 1145 | them to 'old_generation' and placing the rest on 'still_unreachable'. |
| 1146 | |
| 1147 | Contracts: |
| 1148 | * After this function 'unreachable' must not be used anymore and 'still_unreachable' |
| 1149 | will contain the objects that did not resurrect. |
| 1150 | |
| 1151 | * The "still_unreachable" list must be uninitialized (this function calls |
| 1152 | gc_list_init over 'still_unreachable'). |
| 1153 | |
| 1154 | IMPORTANT: After a call to this function, the 'still_unreachable' set will have the |
| 1155 | PREV_MARK_COLLECTING set, but the objects in this set are going to be removed so |
| 1156 | we can skip the expense of clearing the flag to avoid extra iteration. */ |
| 1157 | static inline void |
| 1158 | handle_resurrected_objects(PyGC_Head *unreachable, PyGC_Head* still_unreachable, |
| 1159 | PyGC_Head *old_generation) |
| 1160 | { |
| 1161 | // Remove the PREV_MASK_COLLECTING from unreachable |
| 1162 | // to prepare it for a new call to 'deduce_unreachable' |
| 1163 | gc_list_clear_collecting(unreachable); |
| 1164 | |
| 1165 | // After the call to deduce_unreachable, the 'still_unreachable' set will |
| 1166 | // have the PREV_MARK_COLLECTING set, but the objects are going to be |
| 1167 | // removed so we can skip the expense of clearing the flag. |
| 1168 | PyGC_Head* resurrected = unreachable; |
| 1169 | deduce_unreachable(resurrected, still_unreachable); |
| 1170 | clear_unreachable_mask(still_unreachable); |
| 1171 | |
| 1172 | // Move the resurrected objects to the old generation for future collection. |
| 1173 | gc_list_merge(resurrected, old_generation); |
| 1174 | } |
| 1175 | |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 1176 | /* This is the main function. Read this to understand how the |
| 1177 | * collection process works. */ |
Neal Norwitz | 7b216c5 | 2006-03-04 20:01:53 +0000 | [diff] [blame] | 1178 | static Py_ssize_t |
Victor Stinner | 67e0de6 | 2019-11-20 11:48:18 +0100 | [diff] [blame] | 1179 | collect(PyThreadState *tstate, int generation, |
Victor Stinner | 9db0324 | 2019-04-26 02:32:01 +0200 | [diff] [blame] | 1180 | Py_ssize_t *n_collected, Py_ssize_t *n_uncollectable, int nofail) |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 1181 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1182 | int i; |
| 1183 | Py_ssize_t m = 0; /* # objects collected */ |
| 1184 | Py_ssize_t n = 0; /* # unreachable objects that couldn't be collected */ |
| 1185 | PyGC_Head *young; /* the generation we are examining */ |
| 1186 | PyGC_Head *old; /* next older generation */ |
| 1187 | PyGC_Head unreachable; /* non-problematic unreachable trash */ |
| 1188 | PyGC_Head finalizers; /* objects with, & reachable from, __del__ */ |
| 1189 | PyGC_Head *gc; |
Victor Stinner | 7181dec | 2015-03-27 17:47:53 +0100 | [diff] [blame] | 1190 | _PyTime_t t1 = 0; /* initialize to prevent a compiler warning */ |
Victor Stinner | 7247407 | 2019-11-20 12:25:50 +0100 | [diff] [blame] | 1191 | GCState *gcstate = &tstate->interp->gc; |
Antoine Pitrou | 40f6b12 | 2014-05-24 19:21:53 +0200 | [diff] [blame] | 1192 | |
Victor Stinner | d8135e9 | 2020-05-06 18:25:06 +0200 | [diff] [blame] | 1193 | #ifdef EXPERIMENTAL_ISOLATED_SUBINTERPRETERS |
| 1194 | if (tstate->interp->config._isolated_interpreter) { |
| 1195 | // bpo-40533: The garbage collector must not be run on parallel on |
| 1196 | // Python objects shared by multiple interpreters. |
| 1197 | return 0; |
| 1198 | } |
| 1199 | #endif |
| 1200 | |
Victor Stinner | 67e0de6 | 2019-11-20 11:48:18 +0100 | [diff] [blame] | 1201 | if (gcstate->debug & DEBUG_STATS) { |
Inada Naoki | bf8162c | 2019-08-02 16:25:29 +0900 | [diff] [blame] | 1202 | PySys_WriteStderr("gc: collecting generation %d...\n", generation); |
Victor Stinner | 67e0de6 | 2019-11-20 11:48:18 +0100 | [diff] [blame] | 1203 | show_stats_each_generations(gcstate); |
Victor Stinner | 7181dec | 2015-03-27 17:47:53 +0100 | [diff] [blame] | 1204 | t1 = _PyTime_GetMonotonicClock(); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1205 | } |
Neil Schemenauer | 2880ae5 | 2002-05-04 05:35:20 +0000 | [diff] [blame] | 1206 | |
Łukasz Langa | a785c87 | 2016-09-09 17:37:37 -0700 | [diff] [blame] | 1207 | if (PyDTrace_GC_START_ENABLED()) |
| 1208 | PyDTrace_GC_START(generation); |
| 1209 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1210 | /* update collection and allocation counters */ |
| 1211 | if (generation+1 < NUM_GENERATIONS) |
Victor Stinner | 67e0de6 | 2019-11-20 11:48:18 +0100 | [diff] [blame] | 1212 | gcstate->generations[generation+1].count += 1; |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1213 | for (i = 0; i <= generation; i++) |
Victor Stinner | 67e0de6 | 2019-11-20 11:48:18 +0100 | [diff] [blame] | 1214 | gcstate->generations[i].count = 0; |
Neil Schemenauer | 2880ae5 | 2002-05-04 05:35:20 +0000 | [diff] [blame] | 1215 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1216 | /* merge younger generations with one we are currently collecting */ |
| 1217 | for (i = 0; i < generation; i++) { |
Victor Stinner | 67e0de6 | 2019-11-20 11:48:18 +0100 | [diff] [blame] | 1218 | gc_list_merge(GEN_HEAD(gcstate, i), GEN_HEAD(gcstate, generation)); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1219 | } |
Neil Schemenauer | 2880ae5 | 2002-05-04 05:35:20 +0000 | [diff] [blame] | 1220 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1221 | /* handy references */ |
Victor Stinner | 67e0de6 | 2019-11-20 11:48:18 +0100 | [diff] [blame] | 1222 | young = GEN_HEAD(gcstate, generation); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1223 | if (generation < NUM_GENERATIONS-1) |
Victor Stinner | 67e0de6 | 2019-11-20 11:48:18 +0100 | [diff] [blame] | 1224 | old = GEN_HEAD(gcstate, generation+1); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1225 | else |
| 1226 | old = young; |
Tim Peters | ea55c51 | 2019-10-18 20:59:14 -0500 | [diff] [blame] | 1227 | validate_list(old, collecting_clear_unreachable_clear); |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 1228 | |
Pablo Galindo | 466326d | 2019-10-13 16:48:59 +0100 | [diff] [blame] | 1229 | deduce_unreachable(young, &unreachable); |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 1230 | |
INADA Naoki | 5ac9e6e | 2018-07-10 17:19:53 +0900 | [diff] [blame] | 1231 | untrack_tuples(young); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1232 | /* Move reachable objects to next generation. */ |
| 1233 | if (young != old) { |
| 1234 | if (generation == NUM_GENERATIONS - 2) { |
Victor Stinner | 67e0de6 | 2019-11-20 11:48:18 +0100 | [diff] [blame] | 1235 | gcstate->long_lived_pending += gc_list_size(young); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1236 | } |
| 1237 | gc_list_merge(young, old); |
| 1238 | } |
| 1239 | else { |
Pablo Galindo | 97f1267 | 2020-01-13 12:25:05 +0000 | [diff] [blame] | 1240 | /* We only un-track dicts in full collections, to avoid quadratic |
Antoine Pitrou | e1ad3da | 2012-05-28 22:22:34 +0200 | [diff] [blame] | 1241 | dict build-up. See issue #14775. */ |
| 1242 | untrack_dicts(young); |
Victor Stinner | 67e0de6 | 2019-11-20 11:48:18 +0100 | [diff] [blame] | 1243 | gcstate->long_lived_pending = 0; |
| 1244 | gcstate->long_lived_total = gc_list_size(young); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1245 | } |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 1246 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1247 | /* All objects in unreachable are trash, but objects reachable from |
Antoine Pitrou | 796564c | 2013-07-30 19:59:21 +0200 | [diff] [blame] | 1248 | * legacy finalizers (e.g. tp_del) can't safely be deleted. |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1249 | */ |
| 1250 | gc_list_init(&finalizers); |
INADA Naoki | 5ac9e6e | 2018-07-10 17:19:53 +0900 | [diff] [blame] | 1251 | // NEXT_MASK_UNREACHABLE is cleared here. |
| 1252 | // After move_legacy_finalizers(), unreachable is normal list. |
Antoine Pitrou | 796564c | 2013-07-30 19:59:21 +0200 | [diff] [blame] | 1253 | move_legacy_finalizers(&unreachable, &finalizers); |
| 1254 | /* finalizers contains the unreachable objects with a legacy finalizer; |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1255 | * unreachable objects reachable *from* those are also uncollectable, |
| 1256 | * and we move those into the finalizers list too. |
| 1257 | */ |
Antoine Pitrou | 796564c | 2013-07-30 19:59:21 +0200 | [diff] [blame] | 1258 | move_legacy_finalizer_reachable(&finalizers); |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 1259 | |
Tim Peters | ea55c51 | 2019-10-18 20:59:14 -0500 | [diff] [blame] | 1260 | validate_list(&finalizers, collecting_clear_unreachable_clear); |
| 1261 | validate_list(&unreachable, collecting_set_unreachable_clear); |
INADA Naoki | 5ac9e6e | 2018-07-10 17:19:53 +0900 | [diff] [blame] | 1262 | |
Tim Peters | ecbf35f | 2019-10-09 12:37:30 -0500 | [diff] [blame] | 1263 | /* Print debugging information. */ |
Victor Stinner | 67e0de6 | 2019-11-20 11:48:18 +0100 | [diff] [blame] | 1264 | if (gcstate->debug & DEBUG_COLLECTABLE) { |
Tim Peters | ecbf35f | 2019-10-09 12:37:30 -0500 | [diff] [blame] | 1265 | for (gc = GC_NEXT(&unreachable); gc != &unreachable; gc = GC_NEXT(gc)) { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1266 | debug_cycle("collectable", FROM_GC(gc)); |
| 1267 | } |
| 1268 | } |
Tim Peters | ead8b7a | 2004-10-30 23:09:22 +0000 | [diff] [blame] | 1269 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1270 | /* Clear weakrefs and invoke callbacks as necessary. */ |
| 1271 | m += handle_weakrefs(&unreachable, old); |
Tim Peters | ead8b7a | 2004-10-30 23:09:22 +0000 | [diff] [blame] | 1272 | |
Tim Peters | ea55c51 | 2019-10-18 20:59:14 -0500 | [diff] [blame] | 1273 | validate_list(old, collecting_clear_unreachable_clear); |
| 1274 | validate_list(&unreachable, collecting_set_unreachable_clear); |
INADA Naoki | 5ac9e6e | 2018-07-10 17:19:53 +0900 | [diff] [blame] | 1275 | |
Antoine Pitrou | 796564c | 2013-07-30 19:59:21 +0200 | [diff] [blame] | 1276 | /* Call tp_finalize on objects which have one. */ |
Victor Stinner | 67e0de6 | 2019-11-20 11:48:18 +0100 | [diff] [blame] | 1277 | finalize_garbage(tstate, &unreachable); |
Antoine Pitrou | 796564c | 2013-07-30 19:59:21 +0200 | [diff] [blame] | 1278 | |
Pablo Galindo | 466326d | 2019-10-13 16:48:59 +0100 | [diff] [blame] | 1279 | /* Handle any objects that may have resurrected after the call |
| 1280 | * to 'finalize_garbage' and continue the collection with the |
| 1281 | * objects that are still unreachable */ |
| 1282 | PyGC_Head final_unreachable; |
| 1283 | handle_resurrected_objects(&unreachable, &final_unreachable, old); |
| 1284 | |
| 1285 | /* Call tp_clear on objects in the final_unreachable set. This will cause |
| 1286 | * the reference cycles to be broken. It may also cause some objects |
| 1287 | * in finalizers to be freed. |
| 1288 | */ |
| 1289 | m += gc_list_size(&final_unreachable); |
Victor Stinner | 67e0de6 | 2019-11-20 11:48:18 +0100 | [diff] [blame] | 1290 | delete_garbage(tstate, gcstate, &final_unreachable, old); |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 1291 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1292 | /* Collect statistics on uncollectable objects found and print |
| 1293 | * debugging information. */ |
INADA Naoki | 5ac9e6e | 2018-07-10 17:19:53 +0900 | [diff] [blame] | 1294 | for (gc = GC_NEXT(&finalizers); gc != &finalizers; gc = GC_NEXT(gc)) { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1295 | n++; |
Victor Stinner | 67e0de6 | 2019-11-20 11:48:18 +0100 | [diff] [blame] | 1296 | if (gcstate->debug & DEBUG_UNCOLLECTABLE) |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1297 | debug_cycle("uncollectable", FROM_GC(gc)); |
| 1298 | } |
Victor Stinner | 67e0de6 | 2019-11-20 11:48:18 +0100 | [diff] [blame] | 1299 | if (gcstate->debug & DEBUG_STATS) { |
Inada Naoki | bf8162c | 2019-08-02 16:25:29 +0900 | [diff] [blame] | 1300 | double d = _PyTime_AsSecondsDouble(_PyTime_GetMonotonicClock() - t1); |
Inada Naoki | 013e52f | 2019-08-31 09:13:42 +0900 | [diff] [blame] | 1301 | PySys_WriteStderr( |
Victor Stinner | d36cf5f | 2020-06-10 18:38:05 +0200 | [diff] [blame] | 1302 | "gc: done, %zd unreachable, %zd uncollectable, %.4fs elapsed\n", |
Inada Naoki | bf8162c | 2019-08-02 16:25:29 +0900 | [diff] [blame] | 1303 | n+m, n, d); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1304 | } |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 1305 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1306 | /* Append instances in the uncollectable set to a Python |
| 1307 | * reachable list of garbage. The programmer has to deal with |
| 1308 | * this if they insist on creating this type of structure. |
| 1309 | */ |
Victor Stinner | 67e0de6 | 2019-11-20 11:48:18 +0100 | [diff] [blame] | 1310 | handle_legacy_finalizers(tstate, gcstate, &finalizers, old); |
Tim Peters | ea55c51 | 2019-10-18 20:59:14 -0500 | [diff] [blame] | 1311 | validate_list(old, collecting_clear_unreachable_clear); |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 1312 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1313 | /* Clear free list only during the collection of the highest |
| 1314 | * generation */ |
| 1315 | if (generation == NUM_GENERATIONS-1) { |
Victor Stinner | e005ead | 2020-06-05 02:56:37 +0200 | [diff] [blame] | 1316 | clear_freelists(tstate); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1317 | } |
Christian Heimes | a156e09 | 2008-02-16 07:38:31 +0000 | [diff] [blame] | 1318 | |
Victor Stinner | 2e96906 | 2019-11-20 01:49:32 +0100 | [diff] [blame] | 1319 | if (_PyErr_Occurred(tstate)) { |
Antoine Pitrou | fef34e3 | 2013-05-19 01:11:58 +0200 | [diff] [blame] | 1320 | if (nofail) { |
Victor Stinner | 2e96906 | 2019-11-20 01:49:32 +0100 | [diff] [blame] | 1321 | _PyErr_Clear(tstate); |
Antoine Pitrou | fef34e3 | 2013-05-19 01:11:58 +0200 | [diff] [blame] | 1322 | } |
| 1323 | else { |
Victor Stinner | 656c45e | 2020-01-24 18:05:24 +0100 | [diff] [blame] | 1324 | _PyErr_WriteUnraisableMsg("in garbage collection", NULL); |
Antoine Pitrou | fef34e3 | 2013-05-19 01:11:58 +0200 | [diff] [blame] | 1325 | } |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1326 | } |
Kristján Valur Jónsson | 69c6352 | 2012-04-15 11:41:32 +0000 | [diff] [blame] | 1327 | |
Antoine Pitrou | d4156c1 | 2012-10-30 22:43:19 +0100 | [diff] [blame] | 1328 | /* Update stats */ |
Victor Stinner | 9db0324 | 2019-04-26 02:32:01 +0200 | [diff] [blame] | 1329 | if (n_collected) { |
Kristján Valur Jónsson | 69c6352 | 2012-04-15 11:41:32 +0000 | [diff] [blame] | 1330 | *n_collected = m; |
Victor Stinner | 9db0324 | 2019-04-26 02:32:01 +0200 | [diff] [blame] | 1331 | } |
| 1332 | if (n_uncollectable) { |
Kristján Valur Jónsson | 69c6352 | 2012-04-15 11:41:32 +0000 | [diff] [blame] | 1333 | *n_uncollectable = n; |
Victor Stinner | 9db0324 | 2019-04-26 02:32:01 +0200 | [diff] [blame] | 1334 | } |
| 1335 | |
Victor Stinner | 67e0de6 | 2019-11-20 11:48:18 +0100 | [diff] [blame] | 1336 | struct gc_generation_stats *stats = &gcstate->generation_stats[generation]; |
Antoine Pitrou | d4156c1 | 2012-10-30 22:43:19 +0100 | [diff] [blame] | 1337 | stats->collections++; |
| 1338 | stats->collected += m; |
| 1339 | stats->uncollectable += n; |
Łukasz Langa | a785c87 | 2016-09-09 17:37:37 -0700 | [diff] [blame] | 1340 | |
Victor Stinner | 9db0324 | 2019-04-26 02:32:01 +0200 | [diff] [blame] | 1341 | if (PyDTrace_GC_DONE_ENABLED()) { |
Victor Stinner | 2e96906 | 2019-11-20 01:49:32 +0100 | [diff] [blame] | 1342 | PyDTrace_GC_DONE(n + m); |
Victor Stinner | 9db0324 | 2019-04-26 02:32:01 +0200 | [diff] [blame] | 1343 | } |
Łukasz Langa | a785c87 | 2016-09-09 17:37:37 -0700 | [diff] [blame] | 1344 | |
Victor Stinner | 2e96906 | 2019-11-20 01:49:32 +0100 | [diff] [blame] | 1345 | assert(!_PyErr_Occurred(tstate)); |
| 1346 | return n + m; |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 1347 | } |
| 1348 | |
Kristján Valur Jónsson | 69c6352 | 2012-04-15 11:41:32 +0000 | [diff] [blame] | 1349 | /* Invoke progress callbacks to notify clients that garbage collection |
| 1350 | * is starting or stopping |
| 1351 | */ |
| 1352 | static void |
Victor Stinner | 67e0de6 | 2019-11-20 11:48:18 +0100 | [diff] [blame] | 1353 | invoke_gc_callback(PyThreadState *tstate, const char *phase, |
Victor Stinner | 9db0324 | 2019-04-26 02:32:01 +0200 | [diff] [blame] | 1354 | int generation, Py_ssize_t collected, |
| 1355 | Py_ssize_t uncollectable) |
Kristján Valur Jónsson | 69c6352 | 2012-04-15 11:41:32 +0000 | [diff] [blame] | 1356 | { |
Victor Stinner | 67e0de6 | 2019-11-20 11:48:18 +0100 | [diff] [blame] | 1357 | assert(!_PyErr_Occurred(tstate)); |
Victor Stinner | 9db0324 | 2019-04-26 02:32:01 +0200 | [diff] [blame] | 1358 | |
Kristján Valur Jónsson | 69c6352 | 2012-04-15 11:41:32 +0000 | [diff] [blame] | 1359 | /* we may get called very early */ |
Victor Stinner | 7247407 | 2019-11-20 12:25:50 +0100 | [diff] [blame] | 1360 | GCState *gcstate = &tstate->interp->gc; |
Victor Stinner | 67e0de6 | 2019-11-20 11:48:18 +0100 | [diff] [blame] | 1361 | if (gcstate->callbacks == NULL) { |
Kristján Valur Jónsson | 69c6352 | 2012-04-15 11:41:32 +0000 | [diff] [blame] | 1362 | return; |
Victor Stinner | 9db0324 | 2019-04-26 02:32:01 +0200 | [diff] [blame] | 1363 | } |
| 1364 | |
Kristján Valur Jónsson | 69c6352 | 2012-04-15 11:41:32 +0000 | [diff] [blame] | 1365 | /* The local variable cannot be rebound, check it for sanity */ |
Victor Stinner | 67e0de6 | 2019-11-20 11:48:18 +0100 | [diff] [blame] | 1366 | assert(PyList_CheckExact(gcstate->callbacks)); |
Victor Stinner | 9db0324 | 2019-04-26 02:32:01 +0200 | [diff] [blame] | 1367 | PyObject *info = NULL; |
Victor Stinner | 67e0de6 | 2019-11-20 11:48:18 +0100 | [diff] [blame] | 1368 | if (PyList_GET_SIZE(gcstate->callbacks) != 0) { |
Kristján Valur Jónsson | 69c6352 | 2012-04-15 11:41:32 +0000 | [diff] [blame] | 1369 | info = Py_BuildValue("{sisnsn}", |
| 1370 | "generation", generation, |
| 1371 | "collected", collected, |
| 1372 | "uncollectable", uncollectable); |
| 1373 | if (info == NULL) { |
| 1374 | PyErr_WriteUnraisable(NULL); |
| 1375 | return; |
| 1376 | } |
| 1377 | } |
Victor Stinner | 67e0de6 | 2019-11-20 11:48:18 +0100 | [diff] [blame] | 1378 | for (Py_ssize_t i=0; i<PyList_GET_SIZE(gcstate->callbacks); i++) { |
| 1379 | PyObject *r, *cb = PyList_GET_ITEM(gcstate->callbacks, i); |
Kristján Valur Jónsson | 69c6352 | 2012-04-15 11:41:32 +0000 | [diff] [blame] | 1380 | Py_INCREF(cb); /* make sure cb doesn't go away */ |
| 1381 | r = PyObject_CallFunction(cb, "sO", phase, info); |
Serhiy Storchaka | 301e3cc | 2018-05-24 15:19:29 +0300 | [diff] [blame] | 1382 | if (r == NULL) { |
Kristján Valur Jónsson | 69c6352 | 2012-04-15 11:41:32 +0000 | [diff] [blame] | 1383 | PyErr_WriteUnraisable(cb); |
Serhiy Storchaka | 301e3cc | 2018-05-24 15:19:29 +0300 | [diff] [blame] | 1384 | } |
| 1385 | else { |
| 1386 | Py_DECREF(r); |
| 1387 | } |
Kristján Valur Jónsson | 69c6352 | 2012-04-15 11:41:32 +0000 | [diff] [blame] | 1388 | Py_DECREF(cb); |
| 1389 | } |
| 1390 | Py_XDECREF(info); |
Victor Stinner | 67e0de6 | 2019-11-20 11:48:18 +0100 | [diff] [blame] | 1391 | assert(!_PyErr_Occurred(tstate)); |
Kristján Valur Jónsson | 69c6352 | 2012-04-15 11:41:32 +0000 | [diff] [blame] | 1392 | } |
| 1393 | |
| 1394 | /* Perform garbage collection of a generation and invoke |
| 1395 | * progress callbacks. |
| 1396 | */ |
| 1397 | static Py_ssize_t |
Victor Stinner | 67e0de6 | 2019-11-20 11:48:18 +0100 | [diff] [blame] | 1398 | collect_with_callback(PyThreadState *tstate, int generation) |
Kristján Valur Jónsson | 69c6352 | 2012-04-15 11:41:32 +0000 | [diff] [blame] | 1399 | { |
Victor Stinner | 67e0de6 | 2019-11-20 11:48:18 +0100 | [diff] [blame] | 1400 | assert(!_PyErr_Occurred(tstate)); |
Victor Stinner | 9db0324 | 2019-04-26 02:32:01 +0200 | [diff] [blame] | 1401 | Py_ssize_t result, collected, uncollectable; |
Victor Stinner | 67e0de6 | 2019-11-20 11:48:18 +0100 | [diff] [blame] | 1402 | invoke_gc_callback(tstate, "start", generation, 0, 0); |
| 1403 | result = collect(tstate, generation, &collected, &uncollectable, 0); |
| 1404 | invoke_gc_callback(tstate, "stop", generation, collected, uncollectable); |
| 1405 | assert(!_PyErr_Occurred(tstate)); |
Kristján Valur Jónsson | 69c6352 | 2012-04-15 11:41:32 +0000 | [diff] [blame] | 1406 | return result; |
| 1407 | } |
| 1408 | |
Neal Norwitz | 7b216c5 | 2006-03-04 20:01:53 +0000 | [diff] [blame] | 1409 | static Py_ssize_t |
Victor Stinner | 67e0de6 | 2019-11-20 11:48:18 +0100 | [diff] [blame] | 1410 | collect_generations(PyThreadState *tstate) |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 1411 | { |
Victor Stinner | 7247407 | 2019-11-20 12:25:50 +0100 | [diff] [blame] | 1412 | GCState *gcstate = &tstate->interp->gc; |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1413 | /* Find the oldest generation (highest numbered) where the count |
| 1414 | * exceeds the threshold. Objects in the that generation and |
| 1415 | * generations younger than it will be collected. */ |
Victor Stinner | 9db0324 | 2019-04-26 02:32:01 +0200 | [diff] [blame] | 1416 | Py_ssize_t n = 0; |
| 1417 | for (int i = NUM_GENERATIONS-1; i >= 0; i--) { |
Victor Stinner | 67e0de6 | 2019-11-20 11:48:18 +0100 | [diff] [blame] | 1418 | if (gcstate->generations[i].count > gcstate->generations[i].threshold) { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1419 | /* Avoid quadratic performance degradation in number |
Pablo Galindo | 9091398 | 2019-12-27 21:55:56 +0000 | [diff] [blame] | 1420 | of tracked objects (see also issue #4074): |
| 1421 | |
| 1422 | To limit the cost of garbage collection, there are two strategies; |
| 1423 | - make each collection faster, e.g. by scanning fewer objects |
| 1424 | - do less collections |
| 1425 | This heuristic is about the latter strategy. |
| 1426 | |
| 1427 | In addition to the various configurable thresholds, we only trigger a |
| 1428 | full collection if the ratio |
| 1429 | |
| 1430 | long_lived_pending / long_lived_total |
| 1431 | |
| 1432 | is above a given value (hardwired to 25%). |
| 1433 | |
| 1434 | The reason is that, while "non-full" collections (i.e., collections of |
| 1435 | the young and middle generations) will always examine roughly the same |
| 1436 | number of objects -- determined by the aforementioned thresholds --, |
| 1437 | the cost of a full collection is proportional to the total number of |
| 1438 | long-lived objects, which is virtually unbounded. |
| 1439 | |
| 1440 | Indeed, it has been remarked that doing a full collection every |
| 1441 | <constant number> of object creations entails a dramatic performance |
| 1442 | degradation in workloads which consist in creating and storing lots of |
| 1443 | long-lived objects (e.g. building a large list of GC-tracked objects would |
| 1444 | show quadratic performance, instead of linear as expected: see issue #4074). |
| 1445 | |
| 1446 | Using the above ratio, instead, yields amortized linear performance in |
| 1447 | the total number of objects (the effect of which can be summarized |
| 1448 | thusly: "each full garbage collection is more and more costly as the |
| 1449 | number of objects grows, but we do fewer and fewer of them"). |
| 1450 | |
| 1451 | This heuristic was suggested by Martin von Löwis on python-dev in |
| 1452 | June 2008. His original analysis and proposal can be found at: |
| 1453 | http://mail.python.org/pipermail/python-dev/2008-June/080579.html |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1454 | */ |
| 1455 | if (i == NUM_GENERATIONS - 1 |
Victor Stinner | 67e0de6 | 2019-11-20 11:48:18 +0100 | [diff] [blame] | 1456 | && gcstate->long_lived_pending < gcstate->long_lived_total / 4) |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1457 | continue; |
Victor Stinner | 67e0de6 | 2019-11-20 11:48:18 +0100 | [diff] [blame] | 1458 | n = collect_with_callback(tstate, i); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1459 | break; |
| 1460 | } |
| 1461 | } |
| 1462 | return n; |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 1463 | } |
| 1464 | |
Serhiy Storchaka | 9326028 | 2017-02-04 11:19:59 +0200 | [diff] [blame] | 1465 | #include "clinic/gcmodule.c.h" |
| 1466 | |
| 1467 | /*[clinic input] |
| 1468 | gc.enable |
| 1469 | |
| 1470 | Enable automatic garbage collection. |
| 1471 | [clinic start generated code]*/ |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 1472 | |
Vladimir Marangozov | f9d20c3 | 2000-08-06 22:45:31 +0000 | [diff] [blame] | 1473 | static PyObject * |
Serhiy Storchaka | 9326028 | 2017-02-04 11:19:59 +0200 | [diff] [blame] | 1474 | gc_enable_impl(PyObject *module) |
| 1475 | /*[clinic end generated code: output=45a427e9dce9155c input=81ac4940ca579707]*/ |
Vladimir Marangozov | f9d20c3 | 2000-08-06 22:45:31 +0000 | [diff] [blame] | 1476 | { |
Victor Stinner | 1bcc32f | 2020-06-10 20:08:26 +0200 | [diff] [blame] | 1477 | GCState *gcstate = get_gc_state(); |
Victor Stinner | 67e0de6 | 2019-11-20 11:48:18 +0100 | [diff] [blame] | 1478 | gcstate->enabled = 1; |
Serhiy Storchaka | 228b12e | 2017-01-23 09:47:21 +0200 | [diff] [blame] | 1479 | Py_RETURN_NONE; |
Vladimir Marangozov | f9d20c3 | 2000-08-06 22:45:31 +0000 | [diff] [blame] | 1480 | } |
| 1481 | |
Serhiy Storchaka | 9326028 | 2017-02-04 11:19:59 +0200 | [diff] [blame] | 1482 | /*[clinic input] |
| 1483 | gc.disable |
| 1484 | |
| 1485 | Disable automatic garbage collection. |
| 1486 | [clinic start generated code]*/ |
Vladimir Marangozov | f9d20c3 | 2000-08-06 22:45:31 +0000 | [diff] [blame] | 1487 | |
| 1488 | static PyObject * |
Serhiy Storchaka | 9326028 | 2017-02-04 11:19:59 +0200 | [diff] [blame] | 1489 | gc_disable_impl(PyObject *module) |
| 1490 | /*[clinic end generated code: output=97d1030f7aa9d279 input=8c2e5a14e800d83b]*/ |
Vladimir Marangozov | f9d20c3 | 2000-08-06 22:45:31 +0000 | [diff] [blame] | 1491 | { |
Victor Stinner | 1bcc32f | 2020-06-10 20:08:26 +0200 | [diff] [blame] | 1492 | GCState *gcstate = get_gc_state(); |
Victor Stinner | 67e0de6 | 2019-11-20 11:48:18 +0100 | [diff] [blame] | 1493 | gcstate->enabled = 0; |
Serhiy Storchaka | 228b12e | 2017-01-23 09:47:21 +0200 | [diff] [blame] | 1494 | Py_RETURN_NONE; |
Vladimir Marangozov | f9d20c3 | 2000-08-06 22:45:31 +0000 | [diff] [blame] | 1495 | } |
| 1496 | |
Serhiy Storchaka | 9326028 | 2017-02-04 11:19:59 +0200 | [diff] [blame] | 1497 | /*[clinic input] |
| 1498 | gc.isenabled -> bool |
Vladimir Marangozov | f9d20c3 | 2000-08-06 22:45:31 +0000 | [diff] [blame] | 1499 | |
Serhiy Storchaka | 9326028 | 2017-02-04 11:19:59 +0200 | [diff] [blame] | 1500 | Returns true if automatic garbage collection is enabled. |
| 1501 | [clinic start generated code]*/ |
| 1502 | |
| 1503 | static int |
| 1504 | gc_isenabled_impl(PyObject *module) |
| 1505 | /*[clinic end generated code: output=1874298331c49130 input=30005e0422373b31]*/ |
Vladimir Marangozov | f9d20c3 | 2000-08-06 22:45:31 +0000 | [diff] [blame] | 1506 | { |
Victor Stinner | 1bcc32f | 2020-06-10 20:08:26 +0200 | [diff] [blame] | 1507 | GCState *gcstate = get_gc_state(); |
Victor Stinner | 67e0de6 | 2019-11-20 11:48:18 +0100 | [diff] [blame] | 1508 | return gcstate->enabled; |
Vladimir Marangozov | f9d20c3 | 2000-08-06 22:45:31 +0000 | [diff] [blame] | 1509 | } |
| 1510 | |
Serhiy Storchaka | 9326028 | 2017-02-04 11:19:59 +0200 | [diff] [blame] | 1511 | /*[clinic input] |
| 1512 | gc.collect -> Py_ssize_t |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 1513 | |
Serhiy Storchaka | 9326028 | 2017-02-04 11:19:59 +0200 | [diff] [blame] | 1514 | generation: int(c_default="NUM_GENERATIONS - 1") = 2 |
| 1515 | |
| 1516 | Run the garbage collector. |
| 1517 | |
| 1518 | With no arguments, run a full collection. The optional argument |
| 1519 | may be an integer specifying which generation to collect. A ValueError |
| 1520 | is raised if the generation number is invalid. |
| 1521 | |
| 1522 | The number of unreachable objects is returned. |
| 1523 | [clinic start generated code]*/ |
| 1524 | |
| 1525 | static Py_ssize_t |
| 1526 | gc_collect_impl(PyObject *module, int generation) |
| 1527 | /*[clinic end generated code: output=b697e633043233c7 input=40720128b682d879]*/ |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 1528 | { |
Victor Stinner | 2e96906 | 2019-11-20 01:49:32 +0100 | [diff] [blame] | 1529 | PyThreadState *tstate = _PyThreadState_GET(); |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 1530 | |
Serhiy Storchaka | 9326028 | 2017-02-04 11:19:59 +0200 | [diff] [blame] | 1531 | if (generation < 0 || generation >= NUM_GENERATIONS) { |
Victor Stinner | 2e96906 | 2019-11-20 01:49:32 +0100 | [diff] [blame] | 1532 | _PyErr_SetString(tstate, PyExc_ValueError, "invalid generation"); |
Serhiy Storchaka | 9326028 | 2017-02-04 11:19:59 +0200 | [diff] [blame] | 1533 | return -1; |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1534 | } |
Barry Warsaw | d3c38ff | 2006-03-07 09:46:03 +0000 | [diff] [blame] | 1535 | |
Victor Stinner | 7247407 | 2019-11-20 12:25:50 +0100 | [diff] [blame] | 1536 | GCState *gcstate = &tstate->interp->gc; |
Victor Stinner | 9db0324 | 2019-04-26 02:32:01 +0200 | [diff] [blame] | 1537 | Py_ssize_t n; |
Victor Stinner | 67e0de6 | 2019-11-20 11:48:18 +0100 | [diff] [blame] | 1538 | if (gcstate->collecting) { |
Victor Stinner | 9db0324 | 2019-04-26 02:32:01 +0200 | [diff] [blame] | 1539 | /* already collecting, don't do anything */ |
| 1540 | n = 0; |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1541 | } |
Victor Stinner | 9db0324 | 2019-04-26 02:32:01 +0200 | [diff] [blame] | 1542 | else { |
Victor Stinner | 67e0de6 | 2019-11-20 11:48:18 +0100 | [diff] [blame] | 1543 | gcstate->collecting = 1; |
| 1544 | n = collect_with_callback(tstate, generation); |
| 1545 | gcstate->collecting = 0; |
Victor Stinner | 9db0324 | 2019-04-26 02:32:01 +0200 | [diff] [blame] | 1546 | } |
Serhiy Storchaka | 9326028 | 2017-02-04 11:19:59 +0200 | [diff] [blame] | 1547 | return n; |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 1548 | } |
| 1549 | |
Serhiy Storchaka | 9326028 | 2017-02-04 11:19:59 +0200 | [diff] [blame] | 1550 | /*[clinic input] |
| 1551 | gc.set_debug |
| 1552 | |
| 1553 | flags: int |
| 1554 | An integer that can have the following bits turned on: |
| 1555 | DEBUG_STATS - Print statistics during collection. |
| 1556 | DEBUG_COLLECTABLE - Print collectable objects found. |
| 1557 | DEBUG_UNCOLLECTABLE - Print unreachable but uncollectable objects |
| 1558 | found. |
| 1559 | DEBUG_SAVEALL - Save objects to gc.garbage rather than freeing them. |
| 1560 | DEBUG_LEAK - Debug leaking programs (everything but STATS). |
| 1561 | / |
| 1562 | |
| 1563 | Set the garbage collection debugging flags. |
| 1564 | |
| 1565 | Debugging information is written to sys.stderr. |
| 1566 | [clinic start generated code]*/ |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 1567 | |
| 1568 | static PyObject * |
Serhiy Storchaka | 9326028 | 2017-02-04 11:19:59 +0200 | [diff] [blame] | 1569 | gc_set_debug_impl(PyObject *module, int flags) |
| 1570 | /*[clinic end generated code: output=7c8366575486b228 input=5e5ce15e84fbed15]*/ |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 1571 | { |
Victor Stinner | 1bcc32f | 2020-06-10 20:08:26 +0200 | [diff] [blame] | 1572 | GCState *gcstate = get_gc_state(); |
Victor Stinner | 67e0de6 | 2019-11-20 11:48:18 +0100 | [diff] [blame] | 1573 | gcstate->debug = flags; |
Serhiy Storchaka | 228b12e | 2017-01-23 09:47:21 +0200 | [diff] [blame] | 1574 | Py_RETURN_NONE; |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 1575 | } |
| 1576 | |
Serhiy Storchaka | 9326028 | 2017-02-04 11:19:59 +0200 | [diff] [blame] | 1577 | /*[clinic input] |
| 1578 | gc.get_debug -> int |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 1579 | |
Serhiy Storchaka | 9326028 | 2017-02-04 11:19:59 +0200 | [diff] [blame] | 1580 | Get the garbage collection debugging flags. |
| 1581 | [clinic start generated code]*/ |
| 1582 | |
| 1583 | static int |
| 1584 | gc_get_debug_impl(PyObject *module) |
| 1585 | /*[clinic end generated code: output=91242f3506cd1e50 input=91a101e1c3b98366]*/ |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 1586 | { |
Victor Stinner | 1bcc32f | 2020-06-10 20:08:26 +0200 | [diff] [blame] | 1587 | GCState *gcstate = get_gc_state(); |
Victor Stinner | 67e0de6 | 2019-11-20 11:48:18 +0100 | [diff] [blame] | 1588 | return gcstate->debug; |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 1589 | } |
| 1590 | |
Martin v. Löwis | 14f8b4c | 2002-06-13 20:33:02 +0000 | [diff] [blame] | 1591 | PyDoc_STRVAR(gc_set_thresh__doc__, |
Neal Norwitz | 2a47c0f | 2002-01-29 00:53:41 +0000 | [diff] [blame] | 1592 | "set_threshold(threshold0, [threshold1, threshold2]) -> None\n" |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 1593 | "\n" |
| 1594 | "Sets the collection thresholds. Setting threshold0 to zero disables\n" |
Martin v. Löwis | 14f8b4c | 2002-06-13 20:33:02 +0000 | [diff] [blame] | 1595 | "collection.\n"); |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 1596 | |
| 1597 | static PyObject * |
Victor Stinner | 9db0324 | 2019-04-26 02:32:01 +0200 | [diff] [blame] | 1598 | gc_set_threshold(PyObject *self, PyObject *args) |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 1599 | { |
Victor Stinner | 1bcc32f | 2020-06-10 20:08:26 +0200 | [diff] [blame] | 1600 | GCState *gcstate = get_gc_state(); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1601 | if (!PyArg_ParseTuple(args, "i|ii:set_threshold", |
Victor Stinner | 67e0de6 | 2019-11-20 11:48:18 +0100 | [diff] [blame] | 1602 | &gcstate->generations[0].threshold, |
| 1603 | &gcstate->generations[1].threshold, |
| 1604 | &gcstate->generations[2].threshold)) |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1605 | return NULL; |
Victor Stinner | 9db0324 | 2019-04-26 02:32:01 +0200 | [diff] [blame] | 1606 | for (int i = 3; i < NUM_GENERATIONS; i++) { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1607 | /* generations higher than 2 get the same threshold */ |
Victor Stinner | 67e0de6 | 2019-11-20 11:48:18 +0100 | [diff] [blame] | 1608 | gcstate->generations[i].threshold = gcstate->generations[2].threshold; |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1609 | } |
Serhiy Storchaka | 228b12e | 2017-01-23 09:47:21 +0200 | [diff] [blame] | 1610 | Py_RETURN_NONE; |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 1611 | } |
| 1612 | |
Serhiy Storchaka | 9326028 | 2017-02-04 11:19:59 +0200 | [diff] [blame] | 1613 | /*[clinic input] |
| 1614 | gc.get_threshold |
| 1615 | |
| 1616 | Return the current collection thresholds. |
| 1617 | [clinic start generated code]*/ |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 1618 | |
| 1619 | static PyObject * |
Serhiy Storchaka | 9326028 | 2017-02-04 11:19:59 +0200 | [diff] [blame] | 1620 | gc_get_threshold_impl(PyObject *module) |
| 1621 | /*[clinic end generated code: output=7902bc9f41ecbbd8 input=286d79918034d6e6]*/ |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 1622 | { |
Victor Stinner | 1bcc32f | 2020-06-10 20:08:26 +0200 | [diff] [blame] | 1623 | GCState *gcstate = get_gc_state(); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1624 | return Py_BuildValue("(iii)", |
Victor Stinner | 67e0de6 | 2019-11-20 11:48:18 +0100 | [diff] [blame] | 1625 | gcstate->generations[0].threshold, |
| 1626 | gcstate->generations[1].threshold, |
| 1627 | gcstate->generations[2].threshold); |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 1628 | } |
| 1629 | |
Serhiy Storchaka | 9326028 | 2017-02-04 11:19:59 +0200 | [diff] [blame] | 1630 | /*[clinic input] |
| 1631 | gc.get_count |
| 1632 | |
| 1633 | Return a three-tuple of the current collection counts. |
| 1634 | [clinic start generated code]*/ |
Barry Warsaw | d3c38ff | 2006-03-07 09:46:03 +0000 | [diff] [blame] | 1635 | |
| 1636 | static PyObject * |
Serhiy Storchaka | 9326028 | 2017-02-04 11:19:59 +0200 | [diff] [blame] | 1637 | gc_get_count_impl(PyObject *module) |
| 1638 | /*[clinic end generated code: output=354012e67b16398f input=a392794a08251751]*/ |
Barry Warsaw | d3c38ff | 2006-03-07 09:46:03 +0000 | [diff] [blame] | 1639 | { |
Victor Stinner | 1bcc32f | 2020-06-10 20:08:26 +0200 | [diff] [blame] | 1640 | GCState *gcstate = get_gc_state(); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1641 | return Py_BuildValue("(iii)", |
Victor Stinner | 67e0de6 | 2019-11-20 11:48:18 +0100 | [diff] [blame] | 1642 | gcstate->generations[0].count, |
| 1643 | gcstate->generations[1].count, |
| 1644 | gcstate->generations[2].count); |
Barry Warsaw | d3c38ff | 2006-03-07 09:46:03 +0000 | [diff] [blame] | 1645 | } |
| 1646 | |
Neil Schemenauer | 48c7034 | 2001-08-09 15:38:31 +0000 | [diff] [blame] | 1647 | static int |
Martin v. Löwis | 560da62 | 2001-11-24 09:24:51 +0000 | [diff] [blame] | 1648 | referrersvisit(PyObject* obj, PyObject *objs) |
Neil Schemenauer | 48c7034 | 2001-08-09 15:38:31 +0000 | [diff] [blame] | 1649 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1650 | Py_ssize_t i; |
| 1651 | for (i = 0; i < PyTuple_GET_SIZE(objs); i++) |
| 1652 | if (PyTuple_GET_ITEM(objs, i) == obj) |
| 1653 | return 1; |
| 1654 | return 0; |
Neil Schemenauer | 48c7034 | 2001-08-09 15:38:31 +0000 | [diff] [blame] | 1655 | } |
| 1656 | |
Neil Schemenauer | 17e7be6 | 2001-08-10 14:46:47 +0000 | [diff] [blame] | 1657 | static int |
Martin v. Löwis | 560da62 | 2001-11-24 09:24:51 +0000 | [diff] [blame] | 1658 | gc_referrers_for(PyObject *objs, PyGC_Head *list, PyObject *resultlist) |
Neil Schemenauer | 48c7034 | 2001-08-09 15:38:31 +0000 | [diff] [blame] | 1659 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1660 | PyGC_Head *gc; |
| 1661 | PyObject *obj; |
| 1662 | traverseproc traverse; |
INADA Naoki | 5ac9e6e | 2018-07-10 17:19:53 +0900 | [diff] [blame] | 1663 | for (gc = GC_NEXT(list); gc != list; gc = GC_NEXT(gc)) { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1664 | obj = FROM_GC(gc); |
| 1665 | traverse = Py_TYPE(obj)->tp_traverse; |
| 1666 | if (obj == objs || obj == resultlist) |
| 1667 | continue; |
| 1668 | if (traverse(obj, (visitproc)referrersvisit, objs)) { |
| 1669 | if (PyList_Append(resultlist, obj) < 0) |
| 1670 | return 0; /* error */ |
| 1671 | } |
| 1672 | } |
| 1673 | return 1; /* no error */ |
Neil Schemenauer | 48c7034 | 2001-08-09 15:38:31 +0000 | [diff] [blame] | 1674 | } |
| 1675 | |
Martin v. Löwis | 14f8b4c | 2002-06-13 20:33:02 +0000 | [diff] [blame] | 1676 | PyDoc_STRVAR(gc_get_referrers__doc__, |
Martin v. Löwis | 560da62 | 2001-11-24 09:24:51 +0000 | [diff] [blame] | 1677 | "get_referrers(*objs) -> list\n\ |
Martin v. Löwis | 14f8b4c | 2002-06-13 20:33:02 +0000 | [diff] [blame] | 1678 | Return the list of objects that directly refer to any of objs."); |
Neil Schemenauer | 48c7034 | 2001-08-09 15:38:31 +0000 | [diff] [blame] | 1679 | |
Neil Schemenauer | 17e7be6 | 2001-08-10 14:46:47 +0000 | [diff] [blame] | 1680 | static PyObject * |
Martin v. Löwis | 560da62 | 2001-11-24 09:24:51 +0000 | [diff] [blame] | 1681 | gc_get_referrers(PyObject *self, PyObject *args) |
Neil Schemenauer | 48c7034 | 2001-08-09 15:38:31 +0000 | [diff] [blame] | 1682 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1683 | PyObject *result = PyList_New(0); |
Victor Stinner | 67e0de6 | 2019-11-20 11:48:18 +0100 | [diff] [blame] | 1684 | if (!result) { |
| 1685 | return NULL; |
| 1686 | } |
Thomas Wouters | 49fd7fa | 2006-04-21 10:40:58 +0000 | [diff] [blame] | 1687 | |
Victor Stinner | 1bcc32f | 2020-06-10 20:08:26 +0200 | [diff] [blame] | 1688 | GCState *gcstate = get_gc_state(); |
| 1689 | for (int i = 0; i < NUM_GENERATIONS; i++) { |
Victor Stinner | 67e0de6 | 2019-11-20 11:48:18 +0100 | [diff] [blame] | 1690 | if (!(gc_referrers_for(args, GEN_HEAD(gcstate, i), result))) { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1691 | Py_DECREF(result); |
| 1692 | return NULL; |
| 1693 | } |
| 1694 | } |
| 1695 | return result; |
Neil Schemenauer | 48c7034 | 2001-08-09 15:38:31 +0000 | [diff] [blame] | 1696 | } |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 1697 | |
Tim Peters | 0f81ab6 | 2003-04-08 16:39:48 +0000 | [diff] [blame] | 1698 | /* Append obj to list; return true if error (out of memory), false if OK. */ |
Jeremy Hylton | 5bd378b | 2003-04-03 16:28:38 +0000 | [diff] [blame] | 1699 | static int |
Tim Peters | 730f553 | 2003-04-08 17:17:17 +0000 | [diff] [blame] | 1700 | referentsvisit(PyObject *obj, PyObject *list) |
Jeremy Hylton | 5bd378b | 2003-04-03 16:28:38 +0000 | [diff] [blame] | 1701 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1702 | return PyList_Append(list, obj) < 0; |
Jeremy Hylton | 5bd378b | 2003-04-03 16:28:38 +0000 | [diff] [blame] | 1703 | } |
| 1704 | |
Tim Peters | 730f553 | 2003-04-08 17:17:17 +0000 | [diff] [blame] | 1705 | PyDoc_STRVAR(gc_get_referents__doc__, |
| 1706 | "get_referents(*objs) -> list\n\ |
Jeremy Hylton | 059b094 | 2003-04-03 16:29:13 +0000 | [diff] [blame] | 1707 | Return the list of objects that are directly referred to by objs."); |
Jeremy Hylton | 5bd378b | 2003-04-03 16:28:38 +0000 | [diff] [blame] | 1708 | |
| 1709 | static PyObject * |
Tim Peters | 730f553 | 2003-04-08 17:17:17 +0000 | [diff] [blame] | 1710 | gc_get_referents(PyObject *self, PyObject *args) |
Jeremy Hylton | 5bd378b | 2003-04-03 16:28:38 +0000 | [diff] [blame] | 1711 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1712 | Py_ssize_t i; |
| 1713 | PyObject *result = PyList_New(0); |
Tim Peters | 0f81ab6 | 2003-04-08 16:39:48 +0000 | [diff] [blame] | 1714 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1715 | if (result == NULL) |
| 1716 | return NULL; |
Tim Peters | 0f81ab6 | 2003-04-08 16:39:48 +0000 | [diff] [blame] | 1717 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1718 | for (i = 0; i < PyTuple_GET_SIZE(args); i++) { |
| 1719 | traverseproc traverse; |
| 1720 | PyObject *obj = PyTuple_GET_ITEM(args, i); |
Tim Peters | 0f81ab6 | 2003-04-08 16:39:48 +0000 | [diff] [blame] | 1721 | |
Hai Shi | 675d9a3 | 2020-04-15 02:11:20 +0800 | [diff] [blame] | 1722 | if (!_PyObject_IS_GC(obj)) |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1723 | continue; |
| 1724 | traverse = Py_TYPE(obj)->tp_traverse; |
| 1725 | if (! traverse) |
| 1726 | continue; |
| 1727 | if (traverse(obj, (visitproc)referentsvisit, result)) { |
| 1728 | Py_DECREF(result); |
| 1729 | return NULL; |
| 1730 | } |
| 1731 | } |
| 1732 | return result; |
Jeremy Hylton | 5bd378b | 2003-04-03 16:28:38 +0000 | [diff] [blame] | 1733 | } |
| 1734 | |
Serhiy Storchaka | 9326028 | 2017-02-04 11:19:59 +0200 | [diff] [blame] | 1735 | /*[clinic input] |
| 1736 | gc.get_objects |
Pablo Galindo | 175421b | 2019-02-23 03:02:06 +0000 | [diff] [blame] | 1737 | generation: Py_ssize_t(accept={int, NoneType}, c_default="-1") = None |
| 1738 | Generation to extract the objects from. |
Serhiy Storchaka | 9326028 | 2017-02-04 11:19:59 +0200 | [diff] [blame] | 1739 | |
| 1740 | Return a list of objects tracked by the collector (excluding the list returned). |
Pablo Galindo | 175421b | 2019-02-23 03:02:06 +0000 | [diff] [blame] | 1741 | |
| 1742 | If generation is not None, return only the objects tracked by the collector |
| 1743 | that are in that generation. |
Serhiy Storchaka | 9326028 | 2017-02-04 11:19:59 +0200 | [diff] [blame] | 1744 | [clinic start generated code]*/ |
Neil Schemenauer | c7c8d8e | 2001-08-09 15:58:59 +0000 | [diff] [blame] | 1745 | |
Neil Schemenauer | c7c8d8e | 2001-08-09 15:58:59 +0000 | [diff] [blame] | 1746 | static PyObject * |
Pablo Galindo | 175421b | 2019-02-23 03:02:06 +0000 | [diff] [blame] | 1747 | gc_get_objects_impl(PyObject *module, Py_ssize_t generation) |
| 1748 | /*[clinic end generated code: output=48b35fea4ba6cb0e input=ef7da9df9806754c]*/ |
Neil Schemenauer | c7c8d8e | 2001-08-09 15:58:59 +0000 | [diff] [blame] | 1749 | { |
Victor Stinner | 67e0de6 | 2019-11-20 11:48:18 +0100 | [diff] [blame] | 1750 | PyThreadState *tstate = _PyThreadState_GET(); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1751 | int i; |
| 1752 | PyObject* result; |
Victor Stinner | 7247407 | 2019-11-20 12:25:50 +0100 | [diff] [blame] | 1753 | GCState *gcstate = &tstate->interp->gc; |
Neil Schemenauer | c7c8d8e | 2001-08-09 15:58:59 +0000 | [diff] [blame] | 1754 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1755 | result = PyList_New(0); |
Pablo Galindo | 175421b | 2019-02-23 03:02:06 +0000 | [diff] [blame] | 1756 | if (result == NULL) { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1757 | return NULL; |
Pablo Galindo | 175421b | 2019-02-23 03:02:06 +0000 | [diff] [blame] | 1758 | } |
| 1759 | |
| 1760 | /* If generation is passed, we extract only that generation */ |
Victor Stinner | 0810fa7 | 2019-04-15 17:54:09 +0200 | [diff] [blame] | 1761 | if (generation != -1) { |
Pablo Galindo | 175421b | 2019-02-23 03:02:06 +0000 | [diff] [blame] | 1762 | if (generation >= NUM_GENERATIONS) { |
Victor Stinner | 67e0de6 | 2019-11-20 11:48:18 +0100 | [diff] [blame] | 1763 | _PyErr_Format(tstate, PyExc_ValueError, |
| 1764 | "generation parameter must be less than the number of " |
| 1765 | "available generations (%i)", |
| 1766 | NUM_GENERATIONS); |
Pablo Galindo | 175421b | 2019-02-23 03:02:06 +0000 | [diff] [blame] | 1767 | goto error; |
| 1768 | } |
| 1769 | |
| 1770 | if (generation < 0) { |
Victor Stinner | 67e0de6 | 2019-11-20 11:48:18 +0100 | [diff] [blame] | 1771 | _PyErr_SetString(tstate, PyExc_ValueError, |
| 1772 | "generation parameter cannot be negative"); |
Pablo Galindo | 175421b | 2019-02-23 03:02:06 +0000 | [diff] [blame] | 1773 | goto error; |
| 1774 | } |
| 1775 | |
Victor Stinner | 67e0de6 | 2019-11-20 11:48:18 +0100 | [diff] [blame] | 1776 | if (append_objects(result, GEN_HEAD(gcstate, generation))) { |
Pablo Galindo | 175421b | 2019-02-23 03:02:06 +0000 | [diff] [blame] | 1777 | goto error; |
| 1778 | } |
| 1779 | |
| 1780 | return result; |
| 1781 | } |
| 1782 | |
| 1783 | /* If generation is not passed or None, get all objects from all generations */ |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1784 | for (i = 0; i < NUM_GENERATIONS; i++) { |
Victor Stinner | 67e0de6 | 2019-11-20 11:48:18 +0100 | [diff] [blame] | 1785 | if (append_objects(result, GEN_HEAD(gcstate, i))) { |
Pablo Galindo | 175421b | 2019-02-23 03:02:06 +0000 | [diff] [blame] | 1786 | goto error; |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1787 | } |
| 1788 | } |
| 1789 | return result; |
Pablo Galindo | 175421b | 2019-02-23 03:02:06 +0000 | [diff] [blame] | 1790 | |
| 1791 | error: |
| 1792 | Py_DECREF(result); |
| 1793 | return NULL; |
Neil Schemenauer | c7c8d8e | 2001-08-09 15:58:59 +0000 | [diff] [blame] | 1794 | } |
| 1795 | |
Serhiy Storchaka | 9326028 | 2017-02-04 11:19:59 +0200 | [diff] [blame] | 1796 | /*[clinic input] |
| 1797 | gc.get_stats |
| 1798 | |
| 1799 | Return a list of dictionaries containing per-generation statistics. |
| 1800 | [clinic start generated code]*/ |
Antoine Pitrou | d4156c1 | 2012-10-30 22:43:19 +0100 | [diff] [blame] | 1801 | |
| 1802 | static PyObject * |
Serhiy Storchaka | 9326028 | 2017-02-04 11:19:59 +0200 | [diff] [blame] | 1803 | gc_get_stats_impl(PyObject *module) |
| 1804 | /*[clinic end generated code: output=a8ab1d8a5d26f3ab input=1ef4ed9d17b1a470]*/ |
Antoine Pitrou | d4156c1 | 2012-10-30 22:43:19 +0100 | [diff] [blame] | 1805 | { |
| 1806 | int i; |
Antoine Pitrou | d4156c1 | 2012-10-30 22:43:19 +0100 | [diff] [blame] | 1807 | struct gc_generation_stats stats[NUM_GENERATIONS], *st; |
| 1808 | |
| 1809 | /* To get consistent values despite allocations while constructing |
| 1810 | the result list, we use a snapshot of the running stats. */ |
Victor Stinner | 1bcc32f | 2020-06-10 20:08:26 +0200 | [diff] [blame] | 1811 | GCState *gcstate = get_gc_state(); |
Antoine Pitrou | d4156c1 | 2012-10-30 22:43:19 +0100 | [diff] [blame] | 1812 | for (i = 0; i < NUM_GENERATIONS; i++) { |
Victor Stinner | 67e0de6 | 2019-11-20 11:48:18 +0100 | [diff] [blame] | 1813 | stats[i] = gcstate->generation_stats[i]; |
Antoine Pitrou | d4156c1 | 2012-10-30 22:43:19 +0100 | [diff] [blame] | 1814 | } |
| 1815 | |
Victor Stinner | 9db0324 | 2019-04-26 02:32:01 +0200 | [diff] [blame] | 1816 | PyObject *result = PyList_New(0); |
Antoine Pitrou | d4156c1 | 2012-10-30 22:43:19 +0100 | [diff] [blame] | 1817 | if (result == NULL) |
| 1818 | return NULL; |
| 1819 | |
| 1820 | for (i = 0; i < NUM_GENERATIONS; i++) { |
| 1821 | PyObject *dict; |
| 1822 | st = &stats[i]; |
| 1823 | dict = Py_BuildValue("{snsnsn}", |
| 1824 | "collections", st->collections, |
| 1825 | "collected", st->collected, |
| 1826 | "uncollectable", st->uncollectable |
| 1827 | ); |
| 1828 | if (dict == NULL) |
| 1829 | goto error; |
| 1830 | if (PyList_Append(result, dict)) { |
| 1831 | Py_DECREF(dict); |
| 1832 | goto error; |
| 1833 | } |
| 1834 | Py_DECREF(dict); |
| 1835 | } |
| 1836 | return result; |
| 1837 | |
| 1838 | error: |
| 1839 | Py_XDECREF(result); |
| 1840 | return NULL; |
| 1841 | } |
| 1842 | |
| 1843 | |
Serhiy Storchaka | 9326028 | 2017-02-04 11:19:59 +0200 | [diff] [blame] | 1844 | /*[clinic input] |
| 1845 | gc.is_tracked |
| 1846 | |
| 1847 | obj: object |
| 1848 | / |
| 1849 | |
| 1850 | Returns true if the object is tracked by the garbage collector. |
| 1851 | |
| 1852 | Simple atomic objects will return false. |
| 1853 | [clinic start generated code]*/ |
Antoine Pitrou | 3a652b1 | 2009-03-23 18:52:06 +0000 | [diff] [blame] | 1854 | |
| 1855 | static PyObject * |
Serhiy Storchaka | 9326028 | 2017-02-04 11:19:59 +0200 | [diff] [blame] | 1856 | gc_is_tracked(PyObject *module, PyObject *obj) |
| 1857 | /*[clinic end generated code: output=14f0103423b28e31 input=d83057f170ea2723]*/ |
Antoine Pitrou | 3a652b1 | 2009-03-23 18:52:06 +0000 | [diff] [blame] | 1858 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1859 | PyObject *result; |
| 1860 | |
Hai Shi | 675d9a3 | 2020-04-15 02:11:20 +0800 | [diff] [blame] | 1861 | if (_PyObject_IS_GC(obj) && _PyObject_GC_IS_TRACKED(obj)) |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1862 | result = Py_True; |
| 1863 | else |
| 1864 | result = Py_False; |
| 1865 | Py_INCREF(result); |
| 1866 | return result; |
Antoine Pitrou | 3a652b1 | 2009-03-23 18:52:06 +0000 | [diff] [blame] | 1867 | } |
| 1868 | |
brainfvck | c75edab | 2017-10-16 12:49:41 -0700 | [diff] [blame] | 1869 | /*[clinic input] |
Pablo Galindo | a2ec3f0 | 2020-01-14 12:06:45 +0000 | [diff] [blame] | 1870 | gc.is_finalized |
| 1871 | |
| 1872 | obj: object |
| 1873 | / |
| 1874 | |
| 1875 | Returns true if the object has been already finalized by the GC. |
| 1876 | [clinic start generated code]*/ |
| 1877 | |
| 1878 | static PyObject * |
| 1879 | gc_is_finalized(PyObject *module, PyObject *obj) |
| 1880 | /*[clinic end generated code: output=e1516ac119a918ed input=201d0c58f69ae390]*/ |
| 1881 | { |
Hai Shi | 675d9a3 | 2020-04-15 02:11:20 +0800 | [diff] [blame] | 1882 | if (_PyObject_IS_GC(obj) && _PyGCHead_FINALIZED(AS_GC(obj))) { |
Pablo Galindo | a2ec3f0 | 2020-01-14 12:06:45 +0000 | [diff] [blame] | 1883 | Py_RETURN_TRUE; |
| 1884 | } |
| 1885 | Py_RETURN_FALSE; |
| 1886 | } |
| 1887 | |
| 1888 | /*[clinic input] |
brainfvck | c75edab | 2017-10-16 12:49:41 -0700 | [diff] [blame] | 1889 | gc.freeze |
| 1890 | |
| 1891 | Freeze all current tracked objects and ignore them for future collections. |
| 1892 | |
| 1893 | This can be used before a POSIX fork() call to make the gc copy-on-write friendly. |
| 1894 | Note: collection before a POSIX fork() call may free pages for future allocation |
| 1895 | which can cause copy-on-write. |
| 1896 | [clinic start generated code]*/ |
| 1897 | |
| 1898 | static PyObject * |
| 1899 | gc_freeze_impl(PyObject *module) |
| 1900 | /*[clinic end generated code: output=502159d9cdc4c139 input=b602b16ac5febbe5]*/ |
| 1901 | { |
Victor Stinner | 1bcc32f | 2020-06-10 20:08:26 +0200 | [diff] [blame] | 1902 | GCState *gcstate = get_gc_state(); |
brainfvck | c75edab | 2017-10-16 12:49:41 -0700 | [diff] [blame] | 1903 | for (int i = 0; i < NUM_GENERATIONS; ++i) { |
Victor Stinner | 67e0de6 | 2019-11-20 11:48:18 +0100 | [diff] [blame] | 1904 | gc_list_merge(GEN_HEAD(gcstate, i), &gcstate->permanent_generation.head); |
| 1905 | gcstate->generations[i].count = 0; |
brainfvck | c75edab | 2017-10-16 12:49:41 -0700 | [diff] [blame] | 1906 | } |
| 1907 | Py_RETURN_NONE; |
| 1908 | } |
| 1909 | |
| 1910 | /*[clinic input] |
| 1911 | gc.unfreeze |
| 1912 | |
| 1913 | Unfreeze all objects in the permanent generation. |
| 1914 | |
| 1915 | Put all objects in the permanent generation back into oldest generation. |
| 1916 | [clinic start generated code]*/ |
| 1917 | |
| 1918 | static PyObject * |
| 1919 | gc_unfreeze_impl(PyObject *module) |
| 1920 | /*[clinic end generated code: output=1c15f2043b25e169 input=2dd52b170f4cef6c]*/ |
| 1921 | { |
Victor Stinner | 1bcc32f | 2020-06-10 20:08:26 +0200 | [diff] [blame] | 1922 | GCState *gcstate = get_gc_state(); |
Victor Stinner | 67e0de6 | 2019-11-20 11:48:18 +0100 | [diff] [blame] | 1923 | gc_list_merge(&gcstate->permanent_generation.head, |
| 1924 | GEN_HEAD(gcstate, NUM_GENERATIONS-1)); |
brainfvck | c75edab | 2017-10-16 12:49:41 -0700 | [diff] [blame] | 1925 | Py_RETURN_NONE; |
| 1926 | } |
| 1927 | |
| 1928 | /*[clinic input] |
Victor Stinner | 05d68a8 | 2018-01-18 11:15:25 +0100 | [diff] [blame] | 1929 | gc.get_freeze_count -> Py_ssize_t |
brainfvck | c75edab | 2017-10-16 12:49:41 -0700 | [diff] [blame] | 1930 | |
| 1931 | Return the number of objects in the permanent generation. |
| 1932 | [clinic start generated code]*/ |
| 1933 | |
Victor Stinner | 05d68a8 | 2018-01-18 11:15:25 +0100 | [diff] [blame] | 1934 | static Py_ssize_t |
brainfvck | c75edab | 2017-10-16 12:49:41 -0700 | [diff] [blame] | 1935 | gc_get_freeze_count_impl(PyObject *module) |
Victor Stinner | 05d68a8 | 2018-01-18 11:15:25 +0100 | [diff] [blame] | 1936 | /*[clinic end generated code: output=61cbd9f43aa032e1 input=45ffbc65cfe2a6ed]*/ |
brainfvck | c75edab | 2017-10-16 12:49:41 -0700 | [diff] [blame] | 1937 | { |
Victor Stinner | 1bcc32f | 2020-06-10 20:08:26 +0200 | [diff] [blame] | 1938 | GCState *gcstate = get_gc_state(); |
Victor Stinner | 67e0de6 | 2019-11-20 11:48:18 +0100 | [diff] [blame] | 1939 | return gc_list_size(&gcstate->permanent_generation.head); |
brainfvck | c75edab | 2017-10-16 12:49:41 -0700 | [diff] [blame] | 1940 | } |
| 1941 | |
Neil Schemenauer | c7c8d8e | 2001-08-09 15:58:59 +0000 | [diff] [blame] | 1942 | |
Martin v. Löwis | 14f8b4c | 2002-06-13 20:33:02 +0000 | [diff] [blame] | 1943 | PyDoc_STRVAR(gc__doc__, |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 1944 | "This module provides access to the garbage collector for reference cycles.\n" |
| 1945 | "\n" |
Vladimir Marangozov | f9d20c3 | 2000-08-06 22:45:31 +0000 | [diff] [blame] | 1946 | "enable() -- Enable automatic garbage collection.\n" |
| 1947 | "disable() -- Disable automatic garbage collection.\n" |
| 1948 | "isenabled() -- Returns true if automatic collection is enabled.\n" |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 1949 | "collect() -- Do a full collection right now.\n" |
Thomas Wouters | 89f507f | 2006-12-13 04:49:30 +0000 | [diff] [blame] | 1950 | "get_count() -- Return the current collection counts.\n" |
R David Murray | 0e81463 | 2013-12-26 15:11:28 -0500 | [diff] [blame] | 1951 | "get_stats() -- Return list of dictionaries containing per-generation stats.\n" |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 1952 | "set_debug() -- Set debugging flags.\n" |
| 1953 | "get_debug() -- Get debugging flags.\n" |
| 1954 | "set_threshold() -- Set the collection thresholds.\n" |
| 1955 | "get_threshold() -- Return the current the collection thresholds.\n" |
Neil Schemenauer | c7c8d8e | 2001-08-09 15:58:59 +0000 | [diff] [blame] | 1956 | "get_objects() -- Return a list of all objects tracked by the collector.\n" |
Antoine Pitrou | 3a652b1 | 2009-03-23 18:52:06 +0000 | [diff] [blame] | 1957 | "is_tracked() -- Returns true if a given object is tracked.\n" |
Pablo Galindo | b679137 | 2020-01-14 17:38:15 +0000 | [diff] [blame] | 1958 | "is_finalized() -- Returns true if a given object has been already finalized.\n" |
Jeremy Hylton | 5bd378b | 2003-04-03 16:28:38 +0000 | [diff] [blame] | 1959 | "get_referrers() -- Return the list of objects that refer to an object.\n" |
brainfvck | c75edab | 2017-10-16 12:49:41 -0700 | [diff] [blame] | 1960 | "get_referents() -- Return the list of objects that an object refers to.\n" |
| 1961 | "freeze() -- Freeze all tracked objects and ignore them for future collections.\n" |
| 1962 | "unfreeze() -- Unfreeze all objects in the permanent generation.\n" |
| 1963 | "get_freeze_count() -- Return the number of objects in the permanent generation.\n"); |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 1964 | |
| 1965 | static PyMethodDef GcMethods[] = { |
Serhiy Storchaka | 9326028 | 2017-02-04 11:19:59 +0200 | [diff] [blame] | 1966 | GC_ENABLE_METHODDEF |
| 1967 | GC_DISABLE_METHODDEF |
| 1968 | GC_ISENABLED_METHODDEF |
| 1969 | GC_SET_DEBUG_METHODDEF |
| 1970 | GC_GET_DEBUG_METHODDEF |
| 1971 | GC_GET_COUNT_METHODDEF |
Victor Stinner | 9db0324 | 2019-04-26 02:32:01 +0200 | [diff] [blame] | 1972 | {"set_threshold", gc_set_threshold, METH_VARARGS, gc_set_thresh__doc__}, |
Serhiy Storchaka | 9326028 | 2017-02-04 11:19:59 +0200 | [diff] [blame] | 1973 | GC_GET_THRESHOLD_METHODDEF |
| 1974 | GC_COLLECT_METHODDEF |
| 1975 | GC_GET_OBJECTS_METHODDEF |
| 1976 | GC_GET_STATS_METHODDEF |
| 1977 | GC_IS_TRACKED_METHODDEF |
Pablo Galindo | a2ec3f0 | 2020-01-14 12:06:45 +0000 | [diff] [blame] | 1978 | GC_IS_FINALIZED_METHODDEF |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1979 | {"get_referrers", gc_get_referrers, METH_VARARGS, |
| 1980 | gc_get_referrers__doc__}, |
| 1981 | {"get_referents", gc_get_referents, METH_VARARGS, |
| 1982 | gc_get_referents__doc__}, |
brainfvck | c75edab | 2017-10-16 12:49:41 -0700 | [diff] [blame] | 1983 | GC_FREEZE_METHODDEF |
| 1984 | GC_UNFREEZE_METHODDEF |
| 1985 | GC_GET_FREEZE_COUNT_METHODDEF |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1986 | {NULL, NULL} /* Sentinel */ |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 1987 | }; |
| 1988 | |
Martin v. Löwis | 1a21451 | 2008-06-11 05:26:20 +0000 | [diff] [blame] | 1989 | static struct PyModuleDef gcmodule = { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1990 | PyModuleDef_HEAD_INIT, |
Antoine Pitrou | 696e035 | 2010-08-08 22:18:46 +0000 | [diff] [blame] | 1991 | "gc", /* m_name */ |
| 1992 | gc__doc__, /* m_doc */ |
| 1993 | -1, /* m_size */ |
| 1994 | GcMethods, /* m_methods */ |
| 1995 | NULL, /* m_reload */ |
| 1996 | NULL, /* m_traverse */ |
| 1997 | NULL, /* m_clear */ |
| 1998 | NULL /* m_free */ |
Martin v. Löwis | 1a21451 | 2008-06-11 05:26:20 +0000 | [diff] [blame] | 1999 | }; |
| 2000 | |
Jason Tishler | 6bc06ec | 2003-09-04 11:59:50 +0000 | [diff] [blame] | 2001 | PyMODINIT_FUNC |
Martin v. Löwis | 1a21451 | 2008-06-11 05:26:20 +0000 | [diff] [blame] | 2002 | PyInit_gc(void) |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 2003 | { |
Victor Stinner | 1bcc32f | 2020-06-10 20:08:26 +0200 | [diff] [blame] | 2004 | GCState *gcstate = get_gc_state(); |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 2005 | |
Victor Stinner | 7247407 | 2019-11-20 12:25:50 +0100 | [diff] [blame] | 2006 | PyObject *m = PyModule_Create(&gcmodule); |
Martin v. Löwis | 1a21451 | 2008-06-11 05:26:20 +0000 | [diff] [blame] | 2007 | |
Victor Stinner | 9db0324 | 2019-04-26 02:32:01 +0200 | [diff] [blame] | 2008 | if (m == NULL) { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 2009 | return NULL; |
Victor Stinner | 9db0324 | 2019-04-26 02:32:01 +0200 | [diff] [blame] | 2010 | } |
Tim Peters | 1155887 | 2003-04-06 23:30:52 +0000 | [diff] [blame] | 2011 | |
Victor Stinner | 67e0de6 | 2019-11-20 11:48:18 +0100 | [diff] [blame] | 2012 | if (gcstate->garbage == NULL) { |
| 2013 | gcstate->garbage = PyList_New(0); |
Victor Stinner | 7247407 | 2019-11-20 12:25:50 +0100 | [diff] [blame] | 2014 | if (gcstate->garbage == NULL) { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 2015 | return NULL; |
Victor Stinner | 7247407 | 2019-11-20 12:25:50 +0100 | [diff] [blame] | 2016 | } |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 2017 | } |
Victor Stinner | 67e0de6 | 2019-11-20 11:48:18 +0100 | [diff] [blame] | 2018 | Py_INCREF(gcstate->garbage); |
Victor Stinner | 7247407 | 2019-11-20 12:25:50 +0100 | [diff] [blame] | 2019 | if (PyModule_AddObject(m, "garbage", gcstate->garbage) < 0) { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 2020 | return NULL; |
Victor Stinner | 7247407 | 2019-11-20 12:25:50 +0100 | [diff] [blame] | 2021 | } |
Thomas Wouters | 477c8d5 | 2006-05-27 19:21:47 +0000 | [diff] [blame] | 2022 | |
Victor Stinner | 67e0de6 | 2019-11-20 11:48:18 +0100 | [diff] [blame] | 2023 | if (gcstate->callbacks == NULL) { |
| 2024 | gcstate->callbacks = PyList_New(0); |
Victor Stinner | 7247407 | 2019-11-20 12:25:50 +0100 | [diff] [blame] | 2025 | if (gcstate->callbacks == NULL) { |
Kristján Valur Jónsson | 69c6352 | 2012-04-15 11:41:32 +0000 | [diff] [blame] | 2026 | return NULL; |
Victor Stinner | 7247407 | 2019-11-20 12:25:50 +0100 | [diff] [blame] | 2027 | } |
Kristján Valur Jónsson | 69c6352 | 2012-04-15 11:41:32 +0000 | [diff] [blame] | 2028 | } |
Victor Stinner | 67e0de6 | 2019-11-20 11:48:18 +0100 | [diff] [blame] | 2029 | Py_INCREF(gcstate->callbacks); |
Victor Stinner | 7247407 | 2019-11-20 12:25:50 +0100 | [diff] [blame] | 2030 | if (PyModule_AddObject(m, "callbacks", gcstate->callbacks) < 0) { |
Kristján Valur Jónsson | 69c6352 | 2012-04-15 11:41:32 +0000 | [diff] [blame] | 2031 | return NULL; |
Victor Stinner | 7247407 | 2019-11-20 12:25:50 +0100 | [diff] [blame] | 2032 | } |
Kristján Valur Jónsson | 69c6352 | 2012-04-15 11:41:32 +0000 | [diff] [blame] | 2033 | |
Victor Stinner | 7247407 | 2019-11-20 12:25:50 +0100 | [diff] [blame] | 2034 | #define ADD_INT(NAME) if (PyModule_AddIntConstant(m, #NAME, NAME) < 0) { return NULL; } |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 2035 | ADD_INT(DEBUG_STATS); |
| 2036 | ADD_INT(DEBUG_COLLECTABLE); |
| 2037 | ADD_INT(DEBUG_UNCOLLECTABLE); |
| 2038 | ADD_INT(DEBUG_SAVEALL); |
| 2039 | ADD_INT(DEBUG_LEAK); |
Tim Peters | 1155887 | 2003-04-06 23:30:52 +0000 | [diff] [blame] | 2040 | #undef ADD_INT |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 2041 | return m; |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 2042 | } |
| 2043 | |
Guido van Rossum | e13ddc9 | 2003-04-17 17:29:22 +0000 | [diff] [blame] | 2044 | /* API to invoke gc.collect() from C */ |
Neal Norwitz | 7b216c5 | 2006-03-04 20:01:53 +0000 | [diff] [blame] | 2045 | Py_ssize_t |
Guido van Rossum | e13ddc9 | 2003-04-17 17:29:22 +0000 | [diff] [blame] | 2046 | PyGC_Collect(void) |
| 2047 | { |
Victor Stinner | 2e96906 | 2019-11-20 01:49:32 +0100 | [diff] [blame] | 2048 | PyThreadState *tstate = _PyThreadState_GET(); |
Victor Stinner | 7247407 | 2019-11-20 12:25:50 +0100 | [diff] [blame] | 2049 | GCState *gcstate = &tstate->interp->gc; |
Victor Stinner | 2e96906 | 2019-11-20 01:49:32 +0100 | [diff] [blame] | 2050 | |
Victor Stinner | 67e0de6 | 2019-11-20 11:48:18 +0100 | [diff] [blame] | 2051 | if (!gcstate->enabled) { |
Victor Stinner | 9db0324 | 2019-04-26 02:32:01 +0200 | [diff] [blame] | 2052 | return 0; |
| 2053 | } |
Guido van Rossum | e13ddc9 | 2003-04-17 17:29:22 +0000 | [diff] [blame] | 2054 | |
Victor Stinner | 9db0324 | 2019-04-26 02:32:01 +0200 | [diff] [blame] | 2055 | Py_ssize_t n; |
Victor Stinner | 67e0de6 | 2019-11-20 11:48:18 +0100 | [diff] [blame] | 2056 | if (gcstate->collecting) { |
Victor Stinner | 9db0324 | 2019-04-26 02:32:01 +0200 | [diff] [blame] | 2057 | /* already collecting, don't do anything */ |
| 2058 | n = 0; |
| 2059 | } |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 2060 | else { |
Serhiy Storchaka | 301e3cc | 2018-05-24 15:19:29 +0300 | [diff] [blame] | 2061 | PyObject *exc, *value, *tb; |
Victor Stinner | 67e0de6 | 2019-11-20 11:48:18 +0100 | [diff] [blame] | 2062 | gcstate->collecting = 1; |
Victor Stinner | 2e96906 | 2019-11-20 01:49:32 +0100 | [diff] [blame] | 2063 | _PyErr_Fetch(tstate, &exc, &value, &tb); |
Victor Stinner | 67e0de6 | 2019-11-20 11:48:18 +0100 | [diff] [blame] | 2064 | n = collect_with_callback(tstate, NUM_GENERATIONS - 1); |
Victor Stinner | 2e96906 | 2019-11-20 01:49:32 +0100 | [diff] [blame] | 2065 | _PyErr_Restore(tstate, exc, value, tb); |
Victor Stinner | 67e0de6 | 2019-11-20 11:48:18 +0100 | [diff] [blame] | 2066 | gcstate->collecting = 0; |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 2067 | } |
Guido van Rossum | e13ddc9 | 2003-04-17 17:29:22 +0000 | [diff] [blame] | 2068 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 2069 | return n; |
Guido van Rossum | e13ddc9 | 2003-04-17 17:29:22 +0000 | [diff] [blame] | 2070 | } |
| 2071 | |
Antoine Pitrou | fef34e3 | 2013-05-19 01:11:58 +0200 | [diff] [blame] | 2072 | Py_ssize_t |
Łukasz Langa | fef7e94 | 2016-09-09 21:47:46 -0700 | [diff] [blame] | 2073 | _PyGC_CollectIfEnabled(void) |
| 2074 | { |
Łukasz Langa | fef7e94 | 2016-09-09 21:47:46 -0700 | [diff] [blame] | 2075 | return PyGC_Collect(); |
| 2076 | } |
| 2077 | |
| 2078 | Py_ssize_t |
Antoine Pitrou | fef34e3 | 2013-05-19 01:11:58 +0200 | [diff] [blame] | 2079 | _PyGC_CollectNoFail(void) |
| 2080 | { |
Victor Stinner | 2e96906 | 2019-11-20 01:49:32 +0100 | [diff] [blame] | 2081 | PyThreadState *tstate = _PyThreadState_GET(); |
| 2082 | assert(!_PyErr_Occurred(tstate)); |
Victor Stinner | 9db0324 | 2019-04-26 02:32:01 +0200 | [diff] [blame] | 2083 | |
Victor Stinner | 7247407 | 2019-11-20 12:25:50 +0100 | [diff] [blame] | 2084 | GCState *gcstate = &tstate->interp->gc; |
Antoine Pitrou | fef34e3 | 2013-05-19 01:11:58 +0200 | [diff] [blame] | 2085 | Py_ssize_t n; |
| 2086 | |
Antoine Pitrou | c69c9bc | 2013-08-15 20:15:15 +0200 | [diff] [blame] | 2087 | /* Ideally, this function is only called on interpreter shutdown, |
| 2088 | and therefore not recursively. Unfortunately, when there are daemon |
| 2089 | threads, a daemon thread can start a cyclic garbage collection |
| 2090 | during interpreter shutdown (and then never finish it). |
| 2091 | See http://bugs.python.org/issue8713#msg195178 for an example. |
| 2092 | */ |
Victor Stinner | 67e0de6 | 2019-11-20 11:48:18 +0100 | [diff] [blame] | 2093 | if (gcstate->collecting) { |
Antoine Pitrou | c69c9bc | 2013-08-15 20:15:15 +0200 | [diff] [blame] | 2094 | n = 0; |
Victor Stinner | 9db0324 | 2019-04-26 02:32:01 +0200 | [diff] [blame] | 2095 | } |
Antoine Pitrou | c69c9bc | 2013-08-15 20:15:15 +0200 | [diff] [blame] | 2096 | else { |
Victor Stinner | 67e0de6 | 2019-11-20 11:48:18 +0100 | [diff] [blame] | 2097 | gcstate->collecting = 1; |
| 2098 | n = collect(tstate, NUM_GENERATIONS - 1, NULL, NULL, 1); |
| 2099 | gcstate->collecting = 0; |
Antoine Pitrou | c69c9bc | 2013-08-15 20:15:15 +0200 | [diff] [blame] | 2100 | } |
Antoine Pitrou | fef34e3 | 2013-05-19 01:11:58 +0200 | [diff] [blame] | 2101 | return n; |
| 2102 | } |
Antoine Pitrou | 5f454a0 | 2013-05-06 21:15:57 +0200 | [diff] [blame] | 2103 | |
Antoine Pitrou | 696e035 | 2010-08-08 22:18:46 +0000 | [diff] [blame] | 2104 | void |
Victor Stinner | 67e0de6 | 2019-11-20 11:48:18 +0100 | [diff] [blame] | 2105 | _PyGC_DumpShutdownStats(PyThreadState *tstate) |
Antoine Pitrou | 696e035 | 2010-08-08 22:18:46 +0000 | [diff] [blame] | 2106 | { |
Victor Stinner | 7247407 | 2019-11-20 12:25:50 +0100 | [diff] [blame] | 2107 | GCState *gcstate = &tstate->interp->gc; |
Victor Stinner | 67e0de6 | 2019-11-20 11:48:18 +0100 | [diff] [blame] | 2108 | if (!(gcstate->debug & DEBUG_SAVEALL) |
| 2109 | && gcstate->garbage != NULL && PyList_GET_SIZE(gcstate->garbage) > 0) { |
Serhiy Storchaka | e2f92de | 2017-11-11 13:06:26 +0200 | [diff] [blame] | 2110 | const char *message; |
Victor Stinner | 67e0de6 | 2019-11-20 11:48:18 +0100 | [diff] [blame] | 2111 | if (gcstate->debug & DEBUG_UNCOLLECTABLE) |
Antoine Pitrou | b5d8204 | 2010-11-05 00:05:25 +0000 | [diff] [blame] | 2112 | message = "gc: %zd uncollectable objects at " \ |
Georg Brandl | 08be72d | 2010-10-24 15:11:22 +0000 | [diff] [blame] | 2113 | "shutdown"; |
| 2114 | else |
Antoine Pitrou | b5d8204 | 2010-11-05 00:05:25 +0000 | [diff] [blame] | 2115 | message = "gc: %zd uncollectable objects at " \ |
Georg Brandl | 08be72d | 2010-10-24 15:11:22 +0000 | [diff] [blame] | 2116 | "shutdown; use gc.set_debug(gc.DEBUG_UNCOLLECTABLE) to list them"; |
Antoine Pitrou | 070cb3c | 2013-05-08 13:23:25 +0200 | [diff] [blame] | 2117 | /* PyErr_WarnFormat does too many things and we are at shutdown, |
| 2118 | the warnings module's dependencies (e.g. linecache) may be gone |
| 2119 | already. */ |
| 2120 | if (PyErr_WarnExplicitFormat(PyExc_ResourceWarning, "gc", 0, |
| 2121 | "gc", NULL, message, |
Victor Stinner | 67e0de6 | 2019-11-20 11:48:18 +0100 | [diff] [blame] | 2122 | PyList_GET_SIZE(gcstate->garbage))) |
Georg Brandl | 08be72d | 2010-10-24 15:11:22 +0000 | [diff] [blame] | 2123 | PyErr_WriteUnraisable(NULL); |
Victor Stinner | 67e0de6 | 2019-11-20 11:48:18 +0100 | [diff] [blame] | 2124 | if (gcstate->debug & DEBUG_UNCOLLECTABLE) { |
Antoine Pitrou | 696e035 | 2010-08-08 22:18:46 +0000 | [diff] [blame] | 2125 | PyObject *repr = NULL, *bytes = NULL; |
Victor Stinner | 67e0de6 | 2019-11-20 11:48:18 +0100 | [diff] [blame] | 2126 | repr = PyObject_Repr(gcstate->garbage); |
Antoine Pitrou | 696e035 | 2010-08-08 22:18:46 +0000 | [diff] [blame] | 2127 | if (!repr || !(bytes = PyUnicode_EncodeFSDefault(repr))) |
Victor Stinner | 67e0de6 | 2019-11-20 11:48:18 +0100 | [diff] [blame] | 2128 | PyErr_WriteUnraisable(gcstate->garbage); |
Antoine Pitrou | 696e035 | 2010-08-08 22:18:46 +0000 | [diff] [blame] | 2129 | else { |
| 2130 | PySys_WriteStderr( |
Antoine Pitrou | 070cb3c | 2013-05-08 13:23:25 +0200 | [diff] [blame] | 2131 | " %s\n", |
Antoine Pitrou | 696e035 | 2010-08-08 22:18:46 +0000 | [diff] [blame] | 2132 | PyBytes_AS_STRING(bytes) |
| 2133 | ); |
| 2134 | } |
| 2135 | Py_XDECREF(repr); |
| 2136 | Py_XDECREF(bytes); |
| 2137 | } |
Antoine Pitrou | 696e035 | 2010-08-08 22:18:46 +0000 | [diff] [blame] | 2138 | } |
Antoine Pitrou | 5f454a0 | 2013-05-06 21:15:57 +0200 | [diff] [blame] | 2139 | } |
| 2140 | |
| 2141 | void |
Victor Stinner | 7eee5be | 2019-11-20 10:38:34 +0100 | [diff] [blame] | 2142 | _PyGC_Fini(PyThreadState *tstate) |
Antoine Pitrou | 5f454a0 | 2013-05-06 21:15:57 +0200 | [diff] [blame] | 2143 | { |
Victor Stinner | 7247407 | 2019-11-20 12:25:50 +0100 | [diff] [blame] | 2144 | GCState *gcstate = &tstate->interp->gc; |
Victor Stinner | 67e0de6 | 2019-11-20 11:48:18 +0100 | [diff] [blame] | 2145 | Py_CLEAR(gcstate->garbage); |
| 2146 | Py_CLEAR(gcstate->callbacks); |
Antoine Pitrou | 696e035 | 2010-08-08 22:18:46 +0000 | [diff] [blame] | 2147 | } |
| 2148 | |
Neil Schemenauer | 43411b5 | 2001-08-30 00:05:51 +0000 | [diff] [blame] | 2149 | /* for debugging */ |
Guido van Rossum | e13ddc9 | 2003-04-17 17:29:22 +0000 | [diff] [blame] | 2150 | void |
| 2151 | _PyGC_Dump(PyGC_Head *g) |
Neil Schemenauer | 43411b5 | 2001-08-30 00:05:51 +0000 | [diff] [blame] | 2152 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 2153 | _PyObject_Dump(FROM_GC(g)); |
Neil Schemenauer | 43411b5 | 2001-08-30 00:05:51 +0000 | [diff] [blame] | 2154 | } |
| 2155 | |
Victor Stinner | a544773 | 2019-10-10 09:32:13 +0200 | [diff] [blame] | 2156 | |
| 2157 | #ifdef Py_DEBUG |
Victor Stinner | 1b18455 | 2019-10-08 00:09:31 +0200 | [diff] [blame] | 2158 | static int |
| 2159 | visit_validate(PyObject *op, void *parent_raw) |
| 2160 | { |
| 2161 | PyObject *parent = _PyObject_CAST(parent_raw); |
| 2162 | if (_PyObject_IsFreed(op)) { |
| 2163 | _PyObject_ASSERT_FAILED_MSG(parent, |
| 2164 | "PyObject_GC_Track() object is not valid"); |
| 2165 | } |
| 2166 | return 0; |
| 2167 | } |
Victor Stinner | a544773 | 2019-10-10 09:32:13 +0200 | [diff] [blame] | 2168 | #endif |
Victor Stinner | 1b18455 | 2019-10-08 00:09:31 +0200 | [diff] [blame] | 2169 | |
| 2170 | |
Neil Schemenauer | 43411b5 | 2001-08-30 00:05:51 +0000 | [diff] [blame] | 2171 | /* extension modules might be compiled with GC support so these |
| 2172 | functions must always be available */ |
| 2173 | |
| 2174 | void |
Victor Stinner | a42de74 | 2018-11-22 10:25:22 +0100 | [diff] [blame] | 2175 | PyObject_GC_Track(void *op_raw) |
Neil Schemenauer | 43411b5 | 2001-08-30 00:05:51 +0000 | [diff] [blame] | 2176 | { |
Victor Stinner | a42de74 | 2018-11-22 10:25:22 +0100 | [diff] [blame] | 2177 | PyObject *op = _PyObject_CAST(op_raw); |
Victor Stinner | 271753a | 2018-11-22 01:02:54 +0100 | [diff] [blame] | 2178 | if (_PyObject_GC_IS_TRACKED(op)) { |
| 2179 | _PyObject_ASSERT_FAILED_MSG(op, |
| 2180 | "object already tracked " |
| 2181 | "by the garbage collector"); |
| 2182 | } |
Victor Stinner | a42de74 | 2018-11-22 10:25:22 +0100 | [diff] [blame] | 2183 | _PyObject_GC_TRACK(op); |
Victor Stinner | 1b18455 | 2019-10-08 00:09:31 +0200 | [diff] [blame] | 2184 | |
| 2185 | #ifdef Py_DEBUG |
| 2186 | /* Check that the object is valid: validate objects traversed |
| 2187 | by tp_traverse() */ |
| 2188 | traverseproc traverse = Py_TYPE(op)->tp_traverse; |
| 2189 | (void)traverse(op, visit_validate, op); |
| 2190 | #endif |
Neil Schemenauer | 43411b5 | 2001-08-30 00:05:51 +0000 | [diff] [blame] | 2191 | } |
| 2192 | |
Neil Schemenauer | fec4eb1 | 2002-04-12 02:41:03 +0000 | [diff] [blame] | 2193 | void |
Victor Stinner | a42de74 | 2018-11-22 10:25:22 +0100 | [diff] [blame] | 2194 | PyObject_GC_UnTrack(void *op_raw) |
Neil Schemenauer | 43411b5 | 2001-08-30 00:05:51 +0000 | [diff] [blame] | 2195 | { |
Victor Stinner | a42de74 | 2018-11-22 10:25:22 +0100 | [diff] [blame] | 2196 | PyObject *op = _PyObject_CAST(op_raw); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 2197 | /* Obscure: the Py_TRASHCAN mechanism requires that we be able to |
| 2198 | * call PyObject_GC_UnTrack twice on an object. |
| 2199 | */ |
INADA Naoki | 5ac9e6e | 2018-07-10 17:19:53 +0900 | [diff] [blame] | 2200 | if (_PyObject_GC_IS_TRACKED(op)) { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 2201 | _PyObject_GC_UNTRACK(op); |
INADA Naoki | 5ac9e6e | 2018-07-10 17:19:53 +0900 | [diff] [blame] | 2202 | } |
Neil Schemenauer | 43411b5 | 2001-08-30 00:05:51 +0000 | [diff] [blame] | 2203 | } |
| 2204 | |
Hai Shi | 675d9a3 | 2020-04-15 02:11:20 +0800 | [diff] [blame] | 2205 | int |
| 2206 | PyObject_IS_GC(PyObject *obj) |
| 2207 | { |
| 2208 | return _PyObject_IS_GC(obj); |
| 2209 | } |
| 2210 | |
Victor Stinner | db067af | 2014-05-02 22:31:14 +0200 | [diff] [blame] | 2211 | static PyObject * |
| 2212 | _PyObject_GC_Alloc(int use_calloc, size_t basicsize) |
Neil Schemenauer | 43411b5 | 2001-08-30 00:05:51 +0000 | [diff] [blame] | 2213 | { |
Victor Stinner | 67e0de6 | 2019-11-20 11:48:18 +0100 | [diff] [blame] | 2214 | PyThreadState *tstate = _PyThreadState_GET(); |
Victor Stinner | 7247407 | 2019-11-20 12:25:50 +0100 | [diff] [blame] | 2215 | GCState *gcstate = &tstate->interp->gc; |
Victor Stinner | 2e96906 | 2019-11-20 01:49:32 +0100 | [diff] [blame] | 2216 | if (basicsize > PY_SSIZE_T_MAX - sizeof(PyGC_Head)) { |
Victor Stinner | 67e0de6 | 2019-11-20 11:48:18 +0100 | [diff] [blame] | 2217 | return _PyErr_NoMemory(tstate); |
Victor Stinner | 2e96906 | 2019-11-20 01:49:32 +0100 | [diff] [blame] | 2218 | } |
| 2219 | size_t size = sizeof(PyGC_Head) + basicsize; |
| 2220 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 2221 | PyGC_Head *g; |
Victor Stinner | 2e96906 | 2019-11-20 01:49:32 +0100 | [diff] [blame] | 2222 | if (use_calloc) { |
Victor Stinner | db067af | 2014-05-02 22:31:14 +0200 | [diff] [blame] | 2223 | g = (PyGC_Head *)PyObject_Calloc(1, size); |
Victor Stinner | 2e96906 | 2019-11-20 01:49:32 +0100 | [diff] [blame] | 2224 | } |
| 2225 | else { |
Victor Stinner | db067af | 2014-05-02 22:31:14 +0200 | [diff] [blame] | 2226 | g = (PyGC_Head *)PyObject_Malloc(size); |
Victor Stinner | 2e96906 | 2019-11-20 01:49:32 +0100 | [diff] [blame] | 2227 | } |
| 2228 | if (g == NULL) { |
Victor Stinner | 67e0de6 | 2019-11-20 11:48:18 +0100 | [diff] [blame] | 2229 | return _PyErr_NoMemory(tstate); |
Victor Stinner | 2e96906 | 2019-11-20 01:49:32 +0100 | [diff] [blame] | 2230 | } |
INADA Naoki | 5ac9e6e | 2018-07-10 17:19:53 +0900 | [diff] [blame] | 2231 | assert(((uintptr_t)g & 3) == 0); // g must be aligned 4bytes boundary |
Victor Stinner | 2e96906 | 2019-11-20 01:49:32 +0100 | [diff] [blame] | 2232 | |
INADA Naoki | 5ac9e6e | 2018-07-10 17:19:53 +0900 | [diff] [blame] | 2233 | g->_gc_next = 0; |
| 2234 | g->_gc_prev = 0; |
Victor Stinner | 67e0de6 | 2019-11-20 11:48:18 +0100 | [diff] [blame] | 2235 | gcstate->generations[0].count++; /* number of allocated GC objects */ |
| 2236 | if (gcstate->generations[0].count > gcstate->generations[0].threshold && |
| 2237 | gcstate->enabled && |
| 2238 | gcstate->generations[0].threshold && |
| 2239 | !gcstate->collecting && |
| 2240 | !_PyErr_Occurred(tstate)) |
Victor Stinner | 2e96906 | 2019-11-20 01:49:32 +0100 | [diff] [blame] | 2241 | { |
Victor Stinner | 67e0de6 | 2019-11-20 11:48:18 +0100 | [diff] [blame] | 2242 | gcstate->collecting = 1; |
| 2243 | collect_generations(tstate); |
| 2244 | gcstate->collecting = 0; |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 2245 | } |
Victor Stinner | 2e96906 | 2019-11-20 01:49:32 +0100 | [diff] [blame] | 2246 | PyObject *op = FROM_GC(g); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 2247 | return op; |
Neil Schemenauer | 43411b5 | 2001-08-30 00:05:51 +0000 | [diff] [blame] | 2248 | } |
| 2249 | |
| 2250 | PyObject * |
Victor Stinner | db067af | 2014-05-02 22:31:14 +0200 | [diff] [blame] | 2251 | _PyObject_GC_Malloc(size_t basicsize) |
| 2252 | { |
| 2253 | return _PyObject_GC_Alloc(0, basicsize); |
| 2254 | } |
| 2255 | |
| 2256 | PyObject * |
| 2257 | _PyObject_GC_Calloc(size_t basicsize) |
| 2258 | { |
| 2259 | return _PyObject_GC_Alloc(1, basicsize); |
| 2260 | } |
| 2261 | |
| 2262 | PyObject * |
Neil Schemenauer | 43411b5 | 2001-08-30 00:05:51 +0000 | [diff] [blame] | 2263 | _PyObject_GC_New(PyTypeObject *tp) |
| 2264 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 2265 | PyObject *op = _PyObject_GC_Malloc(_PyObject_SIZE(tp)); |
Victor Stinner | 04fc4f2 | 2020-06-16 01:28:07 +0200 | [diff] [blame] | 2266 | if (op == NULL) { |
| 2267 | return NULL; |
| 2268 | } |
| 2269 | _PyObject_Init(op, tp); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 2270 | return op; |
Neil Schemenauer | 43411b5 | 2001-08-30 00:05:51 +0000 | [diff] [blame] | 2271 | } |
| 2272 | |
| 2273 | PyVarObject * |
Martin v. Löwis | 18e1655 | 2006-02-15 17:27:45 +0000 | [diff] [blame] | 2274 | _PyObject_GC_NewVar(PyTypeObject *tp, Py_ssize_t nitems) |
Neil Schemenauer | 43411b5 | 2001-08-30 00:05:51 +0000 | [diff] [blame] | 2275 | { |
Victor Stinner | 5d1866c | 2013-07-08 22:17:52 +0200 | [diff] [blame] | 2276 | size_t size; |
| 2277 | PyVarObject *op; |
| 2278 | |
| 2279 | if (nitems < 0) { |
| 2280 | PyErr_BadInternalCall(); |
| 2281 | return NULL; |
| 2282 | } |
| 2283 | size = _PyObject_VAR_SIZE(tp, nitems); |
| 2284 | op = (PyVarObject *) _PyObject_GC_Malloc(size); |
Victor Stinner | 04fc4f2 | 2020-06-16 01:28:07 +0200 | [diff] [blame] | 2285 | if (op == NULL) { |
| 2286 | return NULL; |
| 2287 | } |
| 2288 | _PyObject_InitVar(op, tp, nitems); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 2289 | return op; |
Neil Schemenauer | 43411b5 | 2001-08-30 00:05:51 +0000 | [diff] [blame] | 2290 | } |
| 2291 | |
| 2292 | PyVarObject * |
Martin v. Löwis | 4129068 | 2006-02-16 14:56:14 +0000 | [diff] [blame] | 2293 | _PyObject_GC_Resize(PyVarObject *op, Py_ssize_t nitems) |
Neil Schemenauer | 43411b5 | 2001-08-30 00:05:51 +0000 | [diff] [blame] | 2294 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 2295 | const size_t basicsize = _PyObject_VAR_SIZE(Py_TYPE(op), nitems); |
Victor Stinner | a4b2bc7 | 2018-10-26 18:00:13 +0200 | [diff] [blame] | 2296 | _PyObject_ASSERT((PyObject *)op, !_PyObject_GC_IS_TRACKED(op)); |
| 2297 | if (basicsize > PY_SSIZE_T_MAX - sizeof(PyGC_Head)) { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 2298 | return (PyVarObject *)PyErr_NoMemory(); |
Victor Stinner | a4b2bc7 | 2018-10-26 18:00:13 +0200 | [diff] [blame] | 2299 | } |
| 2300 | |
| 2301 | PyGC_Head *g = AS_GC(op); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 2302 | g = (PyGC_Head *)PyObject_REALLOC(g, sizeof(PyGC_Head) + basicsize); |
| 2303 | if (g == NULL) |
| 2304 | return (PyVarObject *)PyErr_NoMemory(); |
| 2305 | op = (PyVarObject *) FROM_GC(g); |
Victor Stinner | 60ac6ed | 2020-02-07 23:18:08 +0100 | [diff] [blame] | 2306 | Py_SET_SIZE(op, nitems); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 2307 | return op; |
Neil Schemenauer | 43411b5 | 2001-08-30 00:05:51 +0000 | [diff] [blame] | 2308 | } |
| 2309 | |
| 2310 | void |
Neil Schemenauer | fec4eb1 | 2002-04-12 02:41:03 +0000 | [diff] [blame] | 2311 | PyObject_GC_Del(void *op) |
Neil Schemenauer | 43411b5 | 2001-08-30 00:05:51 +0000 | [diff] [blame] | 2312 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 2313 | PyGC_Head *g = AS_GC(op); |
INADA Naoki | 5ac9e6e | 2018-07-10 17:19:53 +0900 | [diff] [blame] | 2314 | if (_PyObject_GC_IS_TRACKED(op)) { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 2315 | gc_list_remove(g); |
INADA Naoki | 5ac9e6e | 2018-07-10 17:19:53 +0900 | [diff] [blame] | 2316 | } |
Victor Stinner | 1bcc32f | 2020-06-10 20:08:26 +0200 | [diff] [blame] | 2317 | GCState *gcstate = get_gc_state(); |
Victor Stinner | 67e0de6 | 2019-11-20 11:48:18 +0100 | [diff] [blame] | 2318 | if (gcstate->generations[0].count > 0) { |
| 2319 | gcstate->generations[0].count--; |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 2320 | } |
| 2321 | PyObject_FREE(g); |
Neil Schemenauer | 43411b5 | 2001-08-30 00:05:51 +0000 | [diff] [blame] | 2322 | } |
Pablo Galindo | f13072b | 2020-04-11 01:21:54 +0100 | [diff] [blame] | 2323 | |
| 2324 | int |
| 2325 | PyObject_GC_IsTracked(PyObject* obj) |
| 2326 | { |
Hai Shi | 675d9a3 | 2020-04-15 02:11:20 +0800 | [diff] [blame] | 2327 | if (_PyObject_IS_GC(obj) && _PyObject_GC_IS_TRACKED(obj)) { |
Pablo Galindo | f13072b | 2020-04-11 01:21:54 +0100 | [diff] [blame] | 2328 | return 1; |
| 2329 | } |
| 2330 | return 0; |
| 2331 | } |
| 2332 | |
| 2333 | int |
| 2334 | PyObject_GC_IsFinalized(PyObject *obj) |
| 2335 | { |
Hai Shi | 675d9a3 | 2020-04-15 02:11:20 +0800 | [diff] [blame] | 2336 | if (_PyObject_IS_GC(obj) && _PyGCHead_FINALIZED(AS_GC(obj))) { |
Pablo Galindo | f13072b | 2020-04-11 01:21:54 +0100 | [diff] [blame] | 2337 | return 1; |
| 2338 | } |
| 2339 | return 0; |
| 2340 | } |