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/ |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 12 | http://www.python.org/pipermail/python-dev/2000-March/003869.html |
| 13 | http://www.python.org/pipermail/python-dev/2000-March/004010.html |
| 14 | http://www.python.org/pipermail/python-dev/2000-March/004022.html |
| 15 | |
| 16 | For a highlevel view of the collection process, read the collect |
| 17 | function. |
| 18 | |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 19 | */ |
| 20 | |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 21 | #include "Python.h" |
| 22 | |
Neil Schemenauer | 43411b5 | 2001-08-30 00:05:51 +0000 | [diff] [blame] | 23 | /* Get an object's GC head */ |
| 24 | #define AS_GC(o) ((PyGC_Head *)(o)-1) |
| 25 | |
| 26 | /* Get the object given the GC head */ |
| 27 | #define FROM_GC(g) ((PyObject *)(((PyGC_Head *)g)+1)) |
| 28 | |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 29 | /*** Global GC state ***/ |
| 30 | |
Neil Schemenauer | 2880ae5 | 2002-05-04 05:35:20 +0000 | [diff] [blame] | 31 | struct gc_generation { |
| 32 | PyGC_Head head; |
| 33 | int threshold; /* collection threshold */ |
| 34 | int count; /* count of allocations or collections of younger |
| 35 | generations */ |
| 36 | }; |
| 37 | |
| 38 | #define NUM_GENERATIONS 3 |
| 39 | #define GEN_HEAD(n) (&generations[n].head) |
| 40 | |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 41 | /* linked lists of container objects */ |
Neil Schemenauer | 2880ae5 | 2002-05-04 05:35:20 +0000 | [diff] [blame] | 42 | static struct gc_generation generations[NUM_GENERATIONS] = { |
| 43 | /* PyGC_Head, threshold, count */ |
| 44 | {{{GEN_HEAD(0), GEN_HEAD(0), 0}}, 700, 0}, |
| 45 | {{{GEN_HEAD(1), GEN_HEAD(1), 0}}, 10, 0}, |
| 46 | {{{GEN_HEAD(2), GEN_HEAD(2), 0}}, 10, 0}, |
| 47 | }; |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 48 | |
Neil Schemenauer | 2880ae5 | 2002-05-04 05:35:20 +0000 | [diff] [blame] | 49 | PyGC_Head *_PyGC_generation0 = GEN_HEAD(0); |
| 50 | |
Vladimir Marangozov | f9d20c3 | 2000-08-06 22:45:31 +0000 | [diff] [blame] | 51 | static int enabled = 1; /* automatic collection enabled? */ |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 52 | |
Neil Schemenauer | 43411b5 | 2001-08-30 00:05:51 +0000 | [diff] [blame] | 53 | /* true if we are currently running the collector */ |
Tim Peters | bf384c2 | 2003-04-06 00:11:39 +0000 | [diff] [blame] | 54 | static int collecting = 0; |
Neil Schemenauer | 43411b5 | 2001-08-30 00:05:51 +0000 | [diff] [blame] | 55 | |
Tim Peters | 6fc13d9 | 2002-07-02 18:12:35 +0000 | [diff] [blame] | 56 | /* list of uncollectable objects */ |
Tim Peters | bf384c2 | 2003-04-06 00:11:39 +0000 | [diff] [blame] | 57 | static PyObject *garbage = NULL; |
Tim Peters | 6fc13d9 | 2002-07-02 18:12:35 +0000 | [diff] [blame] | 58 | |
| 59 | /* Python string to use if unhandled exception occurs */ |
Tim Peters | bf384c2 | 2003-04-06 00:11:39 +0000 | [diff] [blame] | 60 | static PyObject *gc_str = NULL; |
Tim Peters | 6fc13d9 | 2002-07-02 18:12:35 +0000 | [diff] [blame] | 61 | |
Tim Peters | 93ad66d | 2003-04-05 17:15:44 +0000 | [diff] [blame] | 62 | /* Python string used to look for __del__ attribute. */ |
| 63 | static PyObject *delstr = NULL; |
Jeremy Hylton | ce136e9 | 2003-04-04 19:59:06 +0000 | [diff] [blame] | 64 | |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 65 | /* set for debugging information */ |
| 66 | #define DEBUG_STATS (1<<0) /* print collection statistics */ |
| 67 | #define DEBUG_COLLECTABLE (1<<1) /* print collectable objects */ |
| 68 | #define DEBUG_UNCOLLECTABLE (1<<2) /* print uncollectable objects */ |
| 69 | #define DEBUG_INSTANCES (1<<3) /* print instances */ |
| 70 | #define DEBUG_OBJECTS (1<<4) /* print other objects */ |
Neil Schemenauer | 544de1e | 2000-09-22 15:22:38 +0000 | [diff] [blame] | 71 | #define DEBUG_SAVEALL (1<<5) /* save all garbage in gc.garbage */ |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 72 | #define DEBUG_LEAK DEBUG_COLLECTABLE | \ |
| 73 | DEBUG_UNCOLLECTABLE | \ |
| 74 | DEBUG_INSTANCES | \ |
Neil Schemenauer | 544de1e | 2000-09-22 15:22:38 +0000 | [diff] [blame] | 75 | DEBUG_OBJECTS | \ |
| 76 | DEBUG_SAVEALL |
Jeremy Hylton | b709df3 | 2000-09-01 02:47:25 +0000 | [diff] [blame] | 77 | static int debug; |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 78 | |
Tim Peters | 6fc13d9 | 2002-07-02 18:12:35 +0000 | [diff] [blame] | 79 | /*-------------------------------------------------------------------------- |
| 80 | gc_refs values. |
Neil Schemenauer | 43411b5 | 2001-08-30 00:05:51 +0000 | [diff] [blame] | 81 | |
Tim Peters | 6fc13d9 | 2002-07-02 18:12:35 +0000 | [diff] [blame] | 82 | Between collections, every gc'ed object has one of two gc_refs values: |
| 83 | |
| 84 | GC_UNTRACKED |
| 85 | The initial state; objects returned by PyObject_GC_Malloc are in this |
| 86 | state. The object doesn't live in any generation list, and its |
| 87 | tp_traverse slot must not be called. |
| 88 | |
| 89 | GC_REACHABLE |
| 90 | The object lives in some generation list, and its tp_traverse is safe to |
| 91 | call. An object transitions to GC_REACHABLE when PyObject_GC_Track |
| 92 | is called. |
| 93 | |
| 94 | During a collection, gc_refs can temporarily take on other states: |
| 95 | |
| 96 | >= 0 |
| 97 | At the start of a collection, update_refs() copies the true refcount |
| 98 | to gc_refs, for each object in the generation being collected. |
| 99 | subtract_refs() then adjusts gc_refs so that it equals the number of |
| 100 | times an object is referenced directly from outside the generation |
| 101 | being collected. |
Martin v. Löwis | 774348c | 2002-11-09 19:54:06 +0000 | [diff] [blame] | 102 | gc_refs remains >= 0 throughout these steps. |
Tim Peters | 6fc13d9 | 2002-07-02 18:12:35 +0000 | [diff] [blame] | 103 | |
| 104 | GC_TENTATIVELY_UNREACHABLE |
| 105 | move_unreachable() then moves objects not reachable (whether directly or |
| 106 | indirectly) from outside the generation into an "unreachable" set. |
| 107 | Objects that are found to be reachable have gc_refs set to GC_REACHABLE |
| 108 | again. Objects that are found to be unreachable have gc_refs set to |
| 109 | GC_TENTATIVELY_UNREACHABLE. It's "tentatively" because the pass doing |
| 110 | this can't be sure until it ends, and GC_TENTATIVELY_UNREACHABLE may |
| 111 | transition back to GC_REACHABLE. |
| 112 | |
| 113 | Only objects with GC_TENTATIVELY_UNREACHABLE still set are candidates |
| 114 | for collection. If it's decided not to collect such an object (e.g., |
| 115 | it has a __del__ method), its gc_refs is restored to GC_REACHABLE again. |
| 116 | ---------------------------------------------------------------------------- |
| 117 | */ |
Tim Peters | ea40563 | 2002-07-02 00:52:30 +0000 | [diff] [blame] | 118 | #define GC_UNTRACKED _PyGC_REFS_UNTRACKED |
| 119 | #define GC_REACHABLE _PyGC_REFS_REACHABLE |
| 120 | #define GC_TENTATIVELY_UNREACHABLE _PyGC_REFS_TENTATIVELY_UNREACHABLE |
Tim Peters | 19b74c7 | 2002-07-01 03:52:19 +0000 | [diff] [blame] | 121 | |
Tim Peters | 6fc13d9 | 2002-07-02 18:12:35 +0000 | [diff] [blame] | 122 | #define IS_TRACKED(o) ((AS_GC(o))->gc.gc_refs != GC_UNTRACKED) |
Tim Peters | 19b74c7 | 2002-07-01 03:52:19 +0000 | [diff] [blame] | 123 | #define IS_REACHABLE(o) ((AS_GC(o))->gc.gc_refs == GC_REACHABLE) |
| 124 | #define IS_TENTATIVELY_UNREACHABLE(o) ( \ |
| 125 | (AS_GC(o))->gc.gc_refs == GC_TENTATIVELY_UNREACHABLE) |
Neil Schemenauer | a2b11ec | 2002-05-21 15:53:24 +0000 | [diff] [blame] | 126 | |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 127 | /*** list functions ***/ |
| 128 | |
| 129 | static void |
| 130 | gc_list_init(PyGC_Head *list) |
| 131 | { |
Tim Peters | 9e4ca10 | 2001-10-11 18:31:31 +0000 | [diff] [blame] | 132 | list->gc.gc_prev = list; |
| 133 | list->gc.gc_next = list; |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 134 | } |
| 135 | |
Neil Schemenauer | 2880ae5 | 2002-05-04 05:35:20 +0000 | [diff] [blame] | 136 | static int |
| 137 | gc_list_is_empty(PyGC_Head *list) |
| 138 | { |
| 139 | return (list->gc.gc_next == list); |
| 140 | } |
| 141 | |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 142 | static void |
| 143 | gc_list_append(PyGC_Head *node, PyGC_Head *list) |
| 144 | { |
Tim Peters | 9e4ca10 | 2001-10-11 18:31:31 +0000 | [diff] [blame] | 145 | node->gc.gc_next = list; |
| 146 | node->gc.gc_prev = list->gc.gc_prev; |
| 147 | node->gc.gc_prev->gc.gc_next = node; |
| 148 | list->gc.gc_prev = node; |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 149 | } |
| 150 | |
| 151 | static void |
| 152 | gc_list_remove(PyGC_Head *node) |
| 153 | { |
Tim Peters | 9e4ca10 | 2001-10-11 18:31:31 +0000 | [diff] [blame] | 154 | node->gc.gc_prev->gc.gc_next = node->gc.gc_next; |
| 155 | node->gc.gc_next->gc.gc_prev = node->gc.gc_prev; |
| 156 | node->gc.gc_next = NULL; /* object is not currently tracked */ |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 157 | } |
| 158 | |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 159 | /* append a list onto another list, from becomes an empty list */ |
| 160 | static void |
| 161 | gc_list_merge(PyGC_Head *from, PyGC_Head *to) |
| 162 | { |
| 163 | PyGC_Head *tail; |
Neil Schemenauer | 2880ae5 | 2002-05-04 05:35:20 +0000 | [diff] [blame] | 164 | if (!gc_list_is_empty(from)) { |
Tim Peters | 9e4ca10 | 2001-10-11 18:31:31 +0000 | [diff] [blame] | 165 | tail = to->gc.gc_prev; |
| 166 | tail->gc.gc_next = from->gc.gc_next; |
| 167 | tail->gc.gc_next->gc.gc_prev = tail; |
| 168 | to->gc.gc_prev = from->gc.gc_prev; |
| 169 | to->gc.gc_prev->gc.gc_next = to; |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 170 | } |
| 171 | gc_list_init(from); |
| 172 | } |
| 173 | |
| 174 | static long |
| 175 | gc_list_size(PyGC_Head *list) |
| 176 | { |
| 177 | PyGC_Head *gc; |
| 178 | long n = 0; |
Tim Peters | 9e4ca10 | 2001-10-11 18:31:31 +0000 | [diff] [blame] | 179 | for (gc = list->gc.gc_next; gc != list; gc = gc->gc.gc_next) { |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 180 | n++; |
| 181 | } |
| 182 | return n; |
| 183 | } |
| 184 | |
Tim Peters | 259272b | 2003-04-06 19:41:39 +0000 | [diff] [blame] | 185 | /* Append objects in a GC list to a Python list. |
| 186 | * Return 0 if all OK, < 0 if error (out of memory for list). |
| 187 | */ |
| 188 | static int |
| 189 | append_objects(PyObject *py_list, PyGC_Head *gc_list) |
| 190 | { |
| 191 | PyGC_Head *gc; |
| 192 | for (gc = gc_list->gc.gc_next; gc != gc_list; gc = gc->gc.gc_next) { |
| 193 | PyObject *op = FROM_GC(gc); |
| 194 | if (op != py_list) { |
| 195 | if (PyList_Append(py_list, op)) { |
| 196 | return -1; /* exception */ |
| 197 | } |
| 198 | } |
| 199 | } |
| 200 | return 0; |
| 201 | } |
| 202 | |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 203 | /*** end of list stuff ***/ |
| 204 | |
| 205 | |
Tim Peters | 19b74c7 | 2002-07-01 03:52:19 +0000 | [diff] [blame] | 206 | /* Set all gc_refs = ob_refcnt. After this, gc_refs is > 0 for all objects |
| 207 | * in containers, and is GC_REACHABLE for all tracked gc objects not in |
| 208 | * containers. |
Tim Peters | 8839617 | 2002-06-30 17:56:40 +0000 | [diff] [blame] | 209 | */ |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 210 | static void |
| 211 | update_refs(PyGC_Head *containers) |
| 212 | { |
Tim Peters | 9e4ca10 | 2001-10-11 18:31:31 +0000 | [diff] [blame] | 213 | PyGC_Head *gc = containers->gc.gc_next; |
Tim Peters | ea40563 | 2002-07-02 00:52:30 +0000 | [diff] [blame] | 214 | for (; gc != containers; gc = gc->gc.gc_next) { |
| 215 | assert(gc->gc.gc_refs == GC_REACHABLE); |
Tim Peters | 9e4ca10 | 2001-10-11 18:31:31 +0000 | [diff] [blame] | 216 | gc->gc.gc_refs = FROM_GC(gc)->ob_refcnt; |
Tim Peters | 780c497 | 2003-11-14 00:01:17 +0000 | [diff] [blame] | 217 | /* Python's cyclic gc should never see an incoming refcount |
| 218 | * of 0: if something decref'ed to 0, it should have been |
| 219 | * deallocated immediately at that time. |
| 220 | * Possible cause (if the assert triggers): a tp_dealloc |
| 221 | * routine left a gc-aware object tracked during its teardown |
| 222 | * phase, and did something-- or allowed something to happen -- |
| 223 | * that called back into Python. gc can trigger then, and may |
| 224 | * see the still-tracked dying object. Before this assert |
| 225 | * was added, such mistakes went on to allow gc to try to |
| 226 | * delete the object again. In a debug build, that caused |
| 227 | * a mysterious segfault, when _Py_ForgetReference tried |
| 228 | * to remove the object from the doubly-linked list of all |
| 229 | * objects a second time. In a release build, an actual |
| 230 | * double deallocation occurred, which leads to corruption |
| 231 | * of the allocator's internal bookkeeping pointers. That's |
| 232 | * so serious that maybe this should be a release-build |
| 233 | * check instead of an assert? |
| 234 | */ |
| 235 | assert(gc->gc.gc_refs != 0); |
Tim Peters | ea40563 | 2002-07-02 00:52:30 +0000 | [diff] [blame] | 236 | } |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 237 | } |
| 238 | |
Tim Peters | 19b74c7 | 2002-07-01 03:52:19 +0000 | [diff] [blame] | 239 | /* A traversal callback for subtract_refs. */ |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 240 | static int |
| 241 | visit_decref(PyObject *op, void *data) |
| 242 | { |
Tim Peters | 93cd83e | 2002-06-30 21:31:03 +0000 | [diff] [blame] | 243 | assert(op != NULL); |
Tim Peters | 19b74c7 | 2002-07-01 03:52:19 +0000 | [diff] [blame] | 244 | if (PyObject_IS_GC(op)) { |
| 245 | PyGC_Head *gc = AS_GC(op); |
| 246 | /* We're only interested in gc_refs for objects in the |
| 247 | * generation being collected, which can be recognized |
| 248 | * because only they have positive gc_refs. |
| 249 | */ |
Tim Peters | aab713b | 2002-07-02 22:15:28 +0000 | [diff] [blame] | 250 | assert(gc->gc.gc_refs != 0); /* else refcount was too small */ |
Tim Peters | 19b74c7 | 2002-07-01 03:52:19 +0000 | [diff] [blame] | 251 | if (gc->gc.gc_refs > 0) |
| 252 | gc->gc.gc_refs--; |
| 253 | } |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 254 | return 0; |
| 255 | } |
| 256 | |
Tim Peters | 19b74c7 | 2002-07-01 03:52:19 +0000 | [diff] [blame] | 257 | /* Subtract internal references from gc_refs. After this, gc_refs is >= 0 |
| 258 | * for all objects in containers, and is GC_REACHABLE for all tracked gc |
| 259 | * objects not in containers. The ones with gc_refs > 0 are directly |
| 260 | * reachable from outside containers, and so can't be collected. |
| 261 | */ |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 262 | static void |
| 263 | subtract_refs(PyGC_Head *containers) |
| 264 | { |
| 265 | traverseproc traverse; |
Tim Peters | 9e4ca10 | 2001-10-11 18:31:31 +0000 | [diff] [blame] | 266 | PyGC_Head *gc = containers->gc.gc_next; |
| 267 | for (; gc != containers; gc=gc->gc.gc_next) { |
Neil Schemenauer | 43411b5 | 2001-08-30 00:05:51 +0000 | [diff] [blame] | 268 | traverse = FROM_GC(gc)->ob_type->tp_traverse; |
| 269 | (void) traverse(FROM_GC(gc), |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 270 | (visitproc)visit_decref, |
| 271 | NULL); |
| 272 | } |
| 273 | } |
| 274 | |
Tim Peters | 19b74c7 | 2002-07-01 03:52:19 +0000 | [diff] [blame] | 275 | /* A traversal callback for move_unreachable. */ |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 276 | static int |
Tim Peters | 19b74c7 | 2002-07-01 03:52:19 +0000 | [diff] [blame] | 277 | visit_reachable(PyObject *op, PyGC_Head *reachable) |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 278 | { |
Tim Peters | ea40563 | 2002-07-02 00:52:30 +0000 | [diff] [blame] | 279 | if (PyObject_IS_GC(op)) { |
Tim Peters | 19b74c7 | 2002-07-01 03:52:19 +0000 | [diff] [blame] | 280 | PyGC_Head *gc = AS_GC(op); |
| 281 | const int gc_refs = gc->gc.gc_refs; |
| 282 | |
| 283 | if (gc_refs == 0) { |
| 284 | /* This is in move_unreachable's 'young' list, but |
| 285 | * the traversal hasn't yet gotten to it. All |
| 286 | * we need to do is tell move_unreachable that it's |
| 287 | * reachable. |
| 288 | */ |
| 289 | gc->gc.gc_refs = 1; |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 290 | } |
Tim Peters | 19b74c7 | 2002-07-01 03:52:19 +0000 | [diff] [blame] | 291 | else if (gc_refs == GC_TENTATIVELY_UNREACHABLE) { |
| 292 | /* This had gc_refs = 0 when move_unreachable got |
| 293 | * to it, but turns out it's reachable after all. |
| 294 | * Move it back to move_unreachable's 'young' list, |
| 295 | * and move_unreachable will eventually get to it |
| 296 | * again. |
| 297 | */ |
| 298 | gc_list_remove(gc); |
| 299 | gc_list_append(gc, reachable); |
| 300 | gc->gc.gc_refs = 1; |
| 301 | } |
| 302 | /* Else there's nothing to do. |
| 303 | * If gc_refs > 0, it must be in move_unreachable's 'young' |
| 304 | * list, and move_unreachable will eventually get to it. |
| 305 | * If gc_refs == GC_REACHABLE, it's either in some other |
| 306 | * generation so we don't care about it, or move_unreachable |
Tim Peters | 6fc13d9 | 2002-07-02 18:12:35 +0000 | [diff] [blame] | 307 | * already dealt with it. |
Tim Peters | ea40563 | 2002-07-02 00:52:30 +0000 | [diff] [blame] | 308 | * If gc_refs == GC_UNTRACKED, it must be ignored. |
Tim Peters | 19b74c7 | 2002-07-01 03:52:19 +0000 | [diff] [blame] | 309 | */ |
Tim Peters | ea40563 | 2002-07-02 00:52:30 +0000 | [diff] [blame] | 310 | else { |
| 311 | assert(gc_refs > 0 |
| 312 | || gc_refs == GC_REACHABLE |
| 313 | || gc_refs == GC_UNTRACKED); |
| 314 | } |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 315 | } |
| 316 | return 0; |
| 317 | } |
| 318 | |
Tim Peters | 19b74c7 | 2002-07-01 03:52:19 +0000 | [diff] [blame] | 319 | /* Move the unreachable objects from young to unreachable. After this, |
| 320 | * all objects in young have gc_refs = GC_REACHABLE, and all objects in |
| 321 | * unreachable have gc_refs = GC_TENTATIVELY_UNREACHABLE. All tracked |
| 322 | * gc objects not in young or unreachable still have gc_refs = GC_REACHABLE. |
| 323 | * All objects in young after this are directly or indirectly reachable |
| 324 | * from outside the original young; and all objects in unreachable are |
| 325 | * not. |
Tim Peters | 8839617 | 2002-06-30 17:56:40 +0000 | [diff] [blame] | 326 | */ |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 327 | static void |
Tim Peters | 19b74c7 | 2002-07-01 03:52:19 +0000 | [diff] [blame] | 328 | move_unreachable(PyGC_Head *young, PyGC_Head *unreachable) |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 329 | { |
Tim Peters | 19b74c7 | 2002-07-01 03:52:19 +0000 | [diff] [blame] | 330 | PyGC_Head *gc = young->gc.gc_next; |
| 331 | |
| 332 | /* Invariants: all objects "to the left" of us in young have gc_refs |
| 333 | * = GC_REACHABLE, and are indeed reachable (directly or indirectly) |
| 334 | * from outside the young list as it was at entry. All other objects |
| 335 | * from the original young "to the left" of us are in unreachable now, |
| 336 | * and have gc_refs = GC_TENTATIVELY_UNREACHABLE. All objects to the |
| 337 | * left of us in 'young' now have been scanned, and no objects here |
| 338 | * or to the right have been scanned yet. |
| 339 | */ |
| 340 | |
| 341 | while (gc != young) { |
| 342 | PyGC_Head *next; |
| 343 | |
Tim Peters | 6fc13d9 | 2002-07-02 18:12:35 +0000 | [diff] [blame] | 344 | if (gc->gc.gc_refs) { |
| 345 | /* gc is definitely reachable from outside the |
| 346 | * original 'young'. Mark it as such, and traverse |
| 347 | * its pointers to find any other objects that may |
| 348 | * be directly reachable from it. Note that the |
| 349 | * call to tp_traverse may append objects to young, |
| 350 | * so we have to wait until it returns to determine |
| 351 | * the next object to visit. |
| 352 | */ |
| 353 | PyObject *op = FROM_GC(gc); |
| 354 | traverseproc traverse = op->ob_type->tp_traverse; |
| 355 | assert(gc->gc.gc_refs > 0); |
| 356 | gc->gc.gc_refs = GC_REACHABLE; |
| 357 | (void) traverse(op, |
| 358 | (visitproc)visit_reachable, |
| 359 | (void *)young); |
| 360 | next = gc->gc.gc_next; |
| 361 | } |
| 362 | else { |
Tim Peters | 19b74c7 | 2002-07-01 03:52:19 +0000 | [diff] [blame] | 363 | /* This *may* be unreachable. To make progress, |
| 364 | * assume it is. gc isn't directly reachable from |
| 365 | * any object we've already traversed, but may be |
| 366 | * reachable from an object we haven't gotten to yet. |
| 367 | * visit_reachable will eventually move gc back into |
| 368 | * young if that's so, and we'll see it again. |
| 369 | */ |
| 370 | next = gc->gc.gc_next; |
| 371 | gc_list_remove(gc); |
| 372 | gc_list_append(gc, unreachable); |
| 373 | gc->gc.gc_refs = GC_TENTATIVELY_UNREACHABLE; |
| 374 | } |
Tim Peters | 19b74c7 | 2002-07-01 03:52:19 +0000 | [diff] [blame] | 375 | gc = next; |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 376 | } |
| 377 | } |
| 378 | |
Tim Peters | 86b993b | 2003-04-05 17:35:54 +0000 | [diff] [blame] | 379 | /* Return true if object has a finalization method. |
| 380 | * CAUTION: An instance of an old-style class has to be checked for a |
Tim Peters | f6b8045 | 2003-04-07 19:21:15 +0000 | [diff] [blame] | 381 | *__del__ method, and earlier versions of this used to call PyObject_HasAttr, |
| 382 | * which in turn could call the class's __getattr__ hook (if any). That |
| 383 | * could invoke arbitrary Python code, mutating the object graph in arbitrary |
| 384 | * ways, and that was the source of some excruciatingly subtle bugs. |
Tim Peters | 86b993b | 2003-04-05 17:35:54 +0000 | [diff] [blame] | 385 | */ |
Neil Schemenauer | a765c12 | 2001-11-01 17:35:23 +0000 | [diff] [blame] | 386 | static int |
| 387 | has_finalizer(PyObject *op) |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 388 | { |
Tim Peters | 86b993b | 2003-04-05 17:35:54 +0000 | [diff] [blame] | 389 | if (PyInstance_Check(op)) { |
Tim Peters | 86b993b | 2003-04-05 17:35:54 +0000 | [diff] [blame] | 390 | assert(delstr != NULL); |
Tim Peters | f6b8045 | 2003-04-07 19:21:15 +0000 | [diff] [blame] | 391 | return _PyInstance_Lookup(op, delstr) != NULL; |
Tim Peters | 86b993b | 2003-04-05 17:35:54 +0000 | [diff] [blame] | 392 | } |
| 393 | else if (PyType_HasFeature(op->ob_type, Py_TPFLAGS_HEAPTYPE)) |
| 394 | return op->ob_type->tp_del != NULL; |
| 395 | else |
| 396 | return 0; |
Neil Schemenauer | a765c12 | 2001-11-01 17:35:23 +0000 | [diff] [blame] | 397 | } |
| 398 | |
Tim Peters | ead8b7a | 2004-10-30 23:09:22 +0000 | [diff] [blame^] | 399 | /* Move the objects in unreachable with __del__ methods into `finalizers`. |
| 400 | * Objects moved into `finalizers` have gc_refs set to GC_REACHABLE; the |
| 401 | * objects remaining in unreachable are left at GC_TENTATIVELY_UNREACHABLE. |
Jeremy Hylton | ce136e9 | 2003-04-04 19:59:06 +0000 | [diff] [blame] | 402 | */ |
Neil Schemenauer | a765c12 | 2001-11-01 17:35:23 +0000 | [diff] [blame] | 403 | static void |
Tim Peters | ead8b7a | 2004-10-30 23:09:22 +0000 | [diff] [blame^] | 404 | move_finalizers(PyGC_Head *unreachable, PyGC_Head *finalizers) |
Neil Schemenauer | a765c12 | 2001-11-01 17:35:23 +0000 | [diff] [blame] | 405 | { |
Tim Peters | ead8b7a | 2004-10-30 23:09:22 +0000 | [diff] [blame^] | 406 | PyGC_Head *gc; |
| 407 | PyGC_Head *next; |
Tim Peters | f6b8045 | 2003-04-07 19:21:15 +0000 | [diff] [blame] | 408 | |
Tim Peters | ead8b7a | 2004-10-30 23:09:22 +0000 | [diff] [blame^] | 409 | /* March over unreachable. Move objects with finalizers into |
| 410 | * `finalizers`. |
| 411 | */ |
| 412 | for (gc = unreachable->gc.gc_next; gc != unreachable; gc = next) { |
Neil Schemenauer | 43411b5 | 2001-08-30 00:05:51 +0000 | [diff] [blame] | 413 | PyObject *op = FROM_GC(gc); |
Jeremy Hylton | ce136e9 | 2003-04-04 19:59:06 +0000 | [diff] [blame] | 414 | |
Tim Peters | f6ae7a4 | 2003-04-05 18:40:50 +0000 | [diff] [blame] | 415 | assert(IS_TENTATIVELY_UNREACHABLE(op)); |
Tim Peters | ead8b7a | 2004-10-30 23:09:22 +0000 | [diff] [blame^] | 416 | next = gc->gc.gc_next; |
Tim Peters | f6ae7a4 | 2003-04-05 18:40:50 +0000 | [diff] [blame] | 417 | |
Tim Peters | f6b8045 | 2003-04-07 19:21:15 +0000 | [diff] [blame] | 418 | if (has_finalizer(op)) { |
Tim Peters | f6ae7a4 | 2003-04-05 18:40:50 +0000 | [diff] [blame] | 419 | gc_list_remove(gc); |
Tim Peters | f6b8045 | 2003-04-07 19:21:15 +0000 | [diff] [blame] | 420 | gc_list_append(gc, finalizers); |
| 421 | gc->gc.gc_refs = GC_REACHABLE; |
Jeremy Hylton | ce136e9 | 2003-04-04 19:59:06 +0000 | [diff] [blame] | 422 | } |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 423 | } |
| 424 | } |
| 425 | |
Tim Peters | 19b74c7 | 2002-07-01 03:52:19 +0000 | [diff] [blame] | 426 | /* A traversal callback for move_finalizer_reachable. */ |
| 427 | static int |
| 428 | visit_move(PyObject *op, PyGC_Head *tolist) |
| 429 | { |
| 430 | if (PyObject_IS_GC(op)) { |
Tim Peters | ea40563 | 2002-07-02 00:52:30 +0000 | [diff] [blame] | 431 | if (IS_TENTATIVELY_UNREACHABLE(op)) { |
Tim Peters | 19b74c7 | 2002-07-01 03:52:19 +0000 | [diff] [blame] | 432 | PyGC_Head *gc = AS_GC(op); |
| 433 | gc_list_remove(gc); |
| 434 | gc_list_append(gc, tolist); |
| 435 | gc->gc.gc_refs = GC_REACHABLE; |
| 436 | } |
| 437 | } |
| 438 | return 0; |
| 439 | } |
| 440 | |
| 441 | /* Move objects that are reachable from finalizers, from the unreachable set |
Tim Peters | f6b8045 | 2003-04-07 19:21:15 +0000 | [diff] [blame] | 442 | * into finalizers set. |
Tim Peters | 19b74c7 | 2002-07-01 03:52:19 +0000 | [diff] [blame] | 443 | */ |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 444 | static void |
Tim Peters | f6b8045 | 2003-04-07 19:21:15 +0000 | [diff] [blame] | 445 | move_finalizer_reachable(PyGC_Head *finalizers) |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 446 | { |
| 447 | traverseproc traverse; |
Tim Peters | 9e4ca10 | 2001-10-11 18:31:31 +0000 | [diff] [blame] | 448 | PyGC_Head *gc = finalizers->gc.gc_next; |
Tim Peters | bf384c2 | 2003-04-06 00:11:39 +0000 | [diff] [blame] | 449 | for (; gc != finalizers; gc = gc->gc.gc_next) { |
| 450 | /* Note that the finalizers list may grow during this. */ |
Neil Schemenauer | 43411b5 | 2001-08-30 00:05:51 +0000 | [diff] [blame] | 451 | traverse = FROM_GC(gc)->ob_type->tp_traverse; |
Tim Peters | 8839617 | 2002-06-30 17:56:40 +0000 | [diff] [blame] | 452 | (void) traverse(FROM_GC(gc), |
Tim Peters | bf384c2 | 2003-04-06 00:11:39 +0000 | [diff] [blame] | 453 | (visitproc)visit_move, |
Tim Peters | f6b8045 | 2003-04-07 19:21:15 +0000 | [diff] [blame] | 454 | (void *)finalizers); |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 455 | } |
| 456 | } |
| 457 | |
Tim Peters | ead8b7a | 2004-10-30 23:09:22 +0000 | [diff] [blame^] | 458 | /* Clear all weakrefs to unreachable objects, and if such a weakref has a |
| 459 | * callback, invoke it if necessary. Note that it's possible for such |
| 460 | * weakrefs to be outside the unreachable set -- indeed, those are precisely |
| 461 | * the weakrefs whose callbacks must be invoked. See gc_weakref.txt for |
| 462 | * overview & some details. Some weakrefs with callbacks may be reclaimed |
| 463 | * directly by this routine; the number reclaimed is the return value. Other |
| 464 | * weakrefs with callbacks may be moved into the `old` generation. Objects |
| 465 | * moved into `old` have gc_refs set to GC_REACHABLE; the objects remaining in |
| 466 | * unreachable are left at GC_TENTATIVELY_UNREACHABLE. When this returns, |
| 467 | * no object in `unreachable` is weakly referenced anymore. |
Tim Peters | 403a203 | 2003-11-20 21:21:46 +0000 | [diff] [blame] | 468 | */ |
| 469 | static int |
Tim Peters | ead8b7a | 2004-10-30 23:09:22 +0000 | [diff] [blame^] | 470 | handle_weakrefs(PyGC_Head *unreachable, PyGC_Head *old) |
Tim Peters | 403a203 | 2003-11-20 21:21:46 +0000 | [diff] [blame] | 471 | { |
Tim Peters | ead8b7a | 2004-10-30 23:09:22 +0000 | [diff] [blame^] | 472 | PyGC_Head *gc; |
| 473 | PyObject *op; /* generally FROM_GC(gc) */ |
| 474 | PyWeakReference *wr; /* generally a cast of op */ |
| 475 | |
| 476 | PyGC_Head wrcb_to_call; /* weakrefs with callbacks to call */ |
| 477 | PyGC_Head wrcb_to_kill; /* weakrefs with callbacks to ignore */ |
| 478 | |
| 479 | PyGC_Head *next; |
Tim Peters | 403a203 | 2003-11-20 21:21:46 +0000 | [diff] [blame] | 480 | int num_freed = 0; |
| 481 | |
Tim Peters | ead8b7a | 2004-10-30 23:09:22 +0000 | [diff] [blame^] | 482 | gc_list_init(&wrcb_to_call); |
| 483 | gc_list_init(&wrcb_to_kill); |
Tim Peters | 403a203 | 2003-11-20 21:21:46 +0000 | [diff] [blame] | 484 | |
Tim Peters | ead8b7a | 2004-10-30 23:09:22 +0000 | [diff] [blame^] | 485 | /* Clear all weakrefs to the objects in unreachable. If such a weakref |
| 486 | * also has a callback, move it into `wrcb_to_call` if the callback |
| 487 | * needs to be invoked, or into `wrcb_to_kill` if the callback should |
| 488 | * be ignored. Note that we cannot invoke any callbacks until all |
| 489 | * weakrefs to unreachable objects are cleared, lest the callback |
| 490 | * resurrect an unreachable object via a still-active weakref. That's |
| 491 | * why the weakrefs with callbacks are moved into different lists -- we |
| 492 | * make another pass over those lists after this pass completes. |
| 493 | */ |
| 494 | for (gc = unreachable->gc.gc_next; gc != unreachable; gc = next) { |
| 495 | PyWeakReference **wrlist; |
| 496 | |
| 497 | op = FROM_GC(gc); |
| 498 | assert(IS_TENTATIVELY_UNREACHABLE(op)); |
| 499 | next = gc->gc.gc_next; |
| 500 | |
| 501 | if (! PyType_SUPPORTS_WEAKREFS(op->ob_type)) |
| 502 | continue; |
| 503 | |
| 504 | /* It supports weakrefs. Does it have any? */ |
| 505 | wrlist = (PyWeakReference **) |
| 506 | PyObject_GET_WEAKREFS_LISTPTR(op); |
| 507 | |
| 508 | /* `op` may have some weakrefs. March over the list, clear |
| 509 | * all the weakrefs, and move the weakrefs with callbacks |
| 510 | * into one of the wrcb_to_{call,kill} lists. |
| 511 | */ |
| 512 | for (wr = *wrlist; wr != NULL; wr = *wrlist) { |
| 513 | PyGC_Head *wrasgc; /* AS_GC(wr) */ |
| 514 | |
| 515 | /* _PyWeakref_ClearRef clears the weakref but leaves |
| 516 | * the callback pointer intact. Obscure: it also |
| 517 | * changes *wrlist. |
| 518 | */ |
| 519 | assert(wr->wr_object == op); |
| 520 | _PyWeakref_ClearRef(wr); |
| 521 | assert(wr->wr_object == Py_None); |
| 522 | if (wr->wr_callback == NULL) |
| 523 | continue; /* no callback */ |
| 524 | |
| 525 | /* Headache time. `op` is going away, and is weakly referenced by |
| 526 | * `wr`, which has a callback. Should the callback be invoked? If wr |
| 527 | * is also trash, no: |
| 528 | * |
| 529 | * 1. There's no need to call it. The object and the weakref are |
| 530 | * both going away, so it's legitimate to pretend the weakref is |
| 531 | * going away first. The user has to ensure a weakref outlives its |
| 532 | * referent if they want a guarantee that the wr callback will get |
| 533 | * invoked. |
| 534 | * |
| 535 | * 2. It may be catastrophic to call it. If the callback is also in |
| 536 | * cyclic trash (CT), then although the CT is unreachable from |
| 537 | * outside the current generation, CT may be reachable from the |
| 538 | * callback. Then the callback could resurrect insane objects. |
| 539 | * |
| 540 | * Since the callback is never needed and may be unsafe in this case, |
| 541 | * wr is moved to wrcb_to_kill. |
| 542 | * |
| 543 | * OTOH, if wr isn't part of CT, we should invoke the callback: the |
| 544 | * weakref outlived the trash. Note that since wr isn't CT in this |
| 545 | * case, its callback can't be CT either -- wr acted as an external |
| 546 | * root to this generation, and therefore its callback did too. So |
| 547 | * nothing in CT is reachable from the callback either, so it's hard |
| 548 | * to imagine how calling it later could create a problem for us. wr |
| 549 | * is moved to wrcb_to_call in this case. |
| 550 | * |
| 551 | * Obscure: why do we move weakrefs with ignored callbacks to a list |
| 552 | * we crawl over later, instead of getting rid of the callback right |
| 553 | * now? It's because the obvious way doesn't work: setting |
| 554 | * wr->wr_callback to NULL requires that we decref the current |
| 555 | * wr->wr_callback. But callbacks are also weakly referenceable, so |
| 556 | * wr->wr_callback may *itself* be referenced by another weakref with |
| 557 | * another callback. The latter callback could get triggered now if |
| 558 | * we decref'ed now, but as explained before it's potentially unsafe to |
| 559 | * invoke any callback before all weakrefs to CT are cleared. |
| 560 | */ |
| 561 | /* Create a new reference so that wr can't go away |
| 562 | * before we can process it again. |
| 563 | */ |
| 564 | Py_INCREF(wr); |
| 565 | |
| 566 | /* Move wr to the appropriate list. */ |
| 567 | wrasgc = AS_GC(wr); |
| 568 | if (wrasgc == next) |
| 569 | next = wrasgc->gc.gc_next; |
| 570 | gc_list_remove(wrasgc); |
| 571 | gc_list_append(wrasgc, |
| 572 | IS_TENTATIVELY_UNREACHABLE(wr) ? |
| 573 | &wrcb_to_kill : &wrcb_to_call); |
| 574 | wrasgc->gc.gc_refs = GC_REACHABLE; |
| 575 | } |
| 576 | } |
| 577 | |
| 578 | /* Now that all weakrefs to trash have been cleared, it's safe to |
| 579 | * decref the callbacks we decided to ignore. We cannot invoke |
| 580 | * them because they may be able to resurrect unreachable (from |
| 581 | * outside) objects. |
| 582 | */ |
| 583 | while (! gc_list_is_empty(&wrcb_to_kill)) { |
| 584 | gc = wrcb_to_kill.gc.gc_next; |
| 585 | op = FROM_GC(gc); |
Tim Peters | 403a203 | 2003-11-20 21:21:46 +0000 | [diff] [blame] | 586 | assert(IS_REACHABLE(op)); |
| 587 | assert(PyWeakref_Check(op)); |
Guido van Rossum | 0bba722 | 2003-11-24 04:02:13 +0000 | [diff] [blame] | 588 | assert(((PyWeakReference *)op)->wr_callback != NULL); |
Tim Peters | ead8b7a | 2004-10-30 23:09:22 +0000 | [diff] [blame^] | 589 | |
| 590 | /* Give up the reference we created in the first pass. When |
| 591 | * op's refcount hits 0 (which it may or may not do right now), |
| 592 | * op's tp_dealloc will decref op->wr_callback too. |
| 593 | */ |
Tim Peters | 403a203 | 2003-11-20 21:21:46 +0000 | [diff] [blame] | 594 | Py_DECREF(op); |
Tim Peters | ead8b7a | 2004-10-30 23:09:22 +0000 | [diff] [blame^] | 595 | if (wrcb_to_kill.gc.gc_next == gc) { |
Tim Peters | 403a203 | 2003-11-20 21:21:46 +0000 | [diff] [blame] | 596 | /* object is still alive -- move it */ |
| 597 | gc_list_remove(gc); |
| 598 | gc_list_append(gc, old); |
| 599 | } |
| 600 | else |
| 601 | ++num_freed; |
| 602 | } |
Tim Peters | ead8b7a | 2004-10-30 23:09:22 +0000 | [diff] [blame^] | 603 | |
| 604 | /* Finally, invoke the callbacks we decided to honor. It's safe to |
| 605 | * invoke them because they cannot reference objects in `unreachable`. |
| 606 | */ |
| 607 | while (! gc_list_is_empty(&wrcb_to_call)) { |
| 608 | PyObject *temp; |
| 609 | PyObject *callback; |
| 610 | |
| 611 | gc = wrcb_to_call.gc.gc_next; |
| 612 | op = FROM_GC(gc); |
| 613 | assert(IS_REACHABLE(op)); |
| 614 | assert(PyWeakref_Check(op)); |
| 615 | wr = (PyWeakReference *)op; |
| 616 | callback = wr->wr_callback; |
| 617 | assert(callback != NULL); |
| 618 | |
| 619 | /* copy-paste of weakrefobject.c's handle_callback() */ |
| 620 | temp = PyObject_CallFunction(callback, "O", wr); |
| 621 | if (temp == NULL) |
| 622 | PyErr_WriteUnraisable(callback); |
| 623 | else |
| 624 | Py_DECREF(temp); |
| 625 | |
| 626 | /* Give up the reference we created in the first pass. When |
| 627 | * op's refcount hits 0 (which it may or may not do right now), |
| 628 | * op's tp_dealloc will decref op->wr_callback too. |
| 629 | */ |
| 630 | Py_DECREF(op); |
| 631 | if (wrcb_to_call.gc.gc_next == gc) { |
| 632 | /* object is still alive -- move it */ |
| 633 | gc_list_remove(gc); |
| 634 | gc_list_append(gc, old); |
| 635 | } |
| 636 | else |
| 637 | ++num_freed; |
| 638 | } |
| 639 | |
Tim Peters | 403a203 | 2003-11-20 21:21:46 +0000 | [diff] [blame] | 640 | return num_freed; |
| 641 | } |
| 642 | |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 643 | static void |
Jeremy Hylton | 0625777 | 2000-08-31 15:10:24 +0000 | [diff] [blame] | 644 | debug_instance(char *msg, PyInstanceObject *inst) |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 645 | { |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 646 | char *cname; |
Neil Schemenauer | a765c12 | 2001-11-01 17:35:23 +0000 | [diff] [blame] | 647 | /* simple version of instance_repr */ |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 648 | PyObject *classname = inst->in_class->cl_name; |
| 649 | if (classname != NULL && PyString_Check(classname)) |
| 650 | cname = PyString_AsString(classname); |
| 651 | else |
| 652 | cname = "?"; |
Jeremy Hylton | 0625777 | 2000-08-31 15:10:24 +0000 | [diff] [blame] | 653 | PySys_WriteStderr("gc: %.100s <%.100s instance at %p>\n", |
| 654 | msg, cname, inst); |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 655 | } |
| 656 | |
| 657 | static void |
Jeremy Hylton | 0625777 | 2000-08-31 15:10:24 +0000 | [diff] [blame] | 658 | debug_cycle(char *msg, PyObject *op) |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 659 | { |
| 660 | if ((debug & DEBUG_INSTANCES) && PyInstance_Check(op)) { |
Jeremy Hylton | 0625777 | 2000-08-31 15:10:24 +0000 | [diff] [blame] | 661 | debug_instance(msg, (PyInstanceObject *)op); |
Neil Schemenauer | 544de1e | 2000-09-22 15:22:38 +0000 | [diff] [blame] | 662 | } |
| 663 | else if (debug & DEBUG_OBJECTS) { |
Jeremy Hylton | 0625777 | 2000-08-31 15:10:24 +0000 | [diff] [blame] | 664 | PySys_WriteStderr("gc: %.100s <%.100s %p>\n", |
| 665 | msg, op->ob_type->tp_name, op); |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 666 | } |
| 667 | } |
| 668 | |
Tim Peters | bf384c2 | 2003-04-06 00:11:39 +0000 | [diff] [blame] | 669 | /* Handle uncollectable garbage (cycles with finalizers, and stuff reachable |
| 670 | * only from such cycles). |
Tim Peters | f6b8045 | 2003-04-07 19:21:15 +0000 | [diff] [blame] | 671 | * If DEBUG_SAVEALL, all objects in finalizers are appended to the module |
| 672 | * garbage list (a Python list), else only the objects in finalizers with |
| 673 | * __del__ methods are appended to garbage. All objects in finalizers are |
| 674 | * merged into the old list regardless. |
Tim Peters | 259272b | 2003-04-06 19:41:39 +0000 | [diff] [blame] | 675 | * Returns 0 if all OK, <0 on error (out of memory to grow the garbage list). |
| 676 | * The finalizers list is made empty on a successful return. |
Tim Peters | bf384c2 | 2003-04-06 00:11:39 +0000 | [diff] [blame] | 677 | */ |
Tim Peters | 259272b | 2003-04-06 19:41:39 +0000 | [diff] [blame] | 678 | static int |
Tim Peters | f6b8045 | 2003-04-07 19:21:15 +0000 | [diff] [blame] | 679 | handle_finalizers(PyGC_Head *finalizers, PyGC_Head *old) |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 680 | { |
Tim Peters | f6b8045 | 2003-04-07 19:21:15 +0000 | [diff] [blame] | 681 | PyGC_Head *gc = finalizers->gc.gc_next; |
| 682 | |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 683 | if (garbage == NULL) { |
| 684 | garbage = PyList_New(0); |
Tim Peters | bf384c2 | 2003-04-06 00:11:39 +0000 | [diff] [blame] | 685 | if (garbage == NULL) |
| 686 | Py_FatalError("gc couldn't create gc.garbage list"); |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 687 | } |
Tim Peters | f6b8045 | 2003-04-07 19:21:15 +0000 | [diff] [blame] | 688 | for (; gc != finalizers; gc = gc->gc.gc_next) { |
| 689 | PyObject *op = FROM_GC(gc); |
| 690 | |
| 691 | if ((debug & DEBUG_SAVEALL) || has_finalizer(op)) { |
| 692 | if (PyList_Append(garbage, op) < 0) |
| 693 | return -1; |
| 694 | } |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 695 | } |
Tim Peters | f6b8045 | 2003-04-07 19:21:15 +0000 | [diff] [blame] | 696 | |
Tim Peters | 259272b | 2003-04-06 19:41:39 +0000 | [diff] [blame] | 697 | gc_list_merge(finalizers, old); |
| 698 | return 0; |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 699 | } |
| 700 | |
Neil Schemenauer | 544de1e | 2000-09-22 15:22:38 +0000 | [diff] [blame] | 701 | /* Break reference cycles by clearing the containers involved. This is |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 702 | * 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] | 703 | * objects may be freed. It is possible I screwed something up here. |
| 704 | */ |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 705 | static void |
Jeremy Hylton | ce136e9 | 2003-04-04 19:59:06 +0000 | [diff] [blame] | 706 | delete_garbage(PyGC_Head *collectable, PyGC_Head *old) |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 707 | { |
| 708 | inquiry clear; |
| 709 | |
Jeremy Hylton | ce136e9 | 2003-04-04 19:59:06 +0000 | [diff] [blame] | 710 | while (!gc_list_is_empty(collectable)) { |
| 711 | PyGC_Head *gc = collectable->gc.gc_next; |
Neil Schemenauer | 43411b5 | 2001-08-30 00:05:51 +0000 | [diff] [blame] | 712 | PyObject *op = FROM_GC(gc); |
Tim Peters | 8839617 | 2002-06-30 17:56:40 +0000 | [diff] [blame] | 713 | |
Tim Peters | 19b74c7 | 2002-07-01 03:52:19 +0000 | [diff] [blame] | 714 | assert(IS_TENTATIVELY_UNREACHABLE(op)); |
Neil Schemenauer | 544de1e | 2000-09-22 15:22:38 +0000 | [diff] [blame] | 715 | if (debug & DEBUG_SAVEALL) { |
| 716 | PyList_Append(garbage, op); |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 717 | } |
Neil Schemenauer | 544de1e | 2000-09-22 15:22:38 +0000 | [diff] [blame] | 718 | else { |
| 719 | if ((clear = op->ob_type->tp_clear) != NULL) { |
| 720 | Py_INCREF(op); |
Jeremy Hylton | 8a13518 | 2002-06-06 23:23:55 +0000 | [diff] [blame] | 721 | clear(op); |
Neil Schemenauer | 544de1e | 2000-09-22 15:22:38 +0000 | [diff] [blame] | 722 | Py_DECREF(op); |
| 723 | } |
| 724 | } |
Jeremy Hylton | ce136e9 | 2003-04-04 19:59:06 +0000 | [diff] [blame] | 725 | if (collectable->gc.gc_next == gc) { |
Neil Schemenauer | 544de1e | 2000-09-22 15:22:38 +0000 | [diff] [blame] | 726 | /* object is still alive, move it, it may die later */ |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 727 | gc_list_remove(gc); |
| 728 | gc_list_append(gc, old); |
Tim Peters | 19b74c7 | 2002-07-01 03:52:19 +0000 | [diff] [blame] | 729 | gc->gc.gc_refs = GC_REACHABLE; |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 730 | } |
| 731 | } |
| 732 | } |
| 733 | |
| 734 | /* This is the main function. Read this to understand how the |
| 735 | * collection process works. */ |
| 736 | static long |
Neil Schemenauer | 2880ae5 | 2002-05-04 05:35:20 +0000 | [diff] [blame] | 737 | collect(int generation) |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 738 | { |
Neil Schemenauer | 2880ae5 | 2002-05-04 05:35:20 +0000 | [diff] [blame] | 739 | int i; |
Tim Peters | 19b74c7 | 2002-07-01 03:52:19 +0000 | [diff] [blame] | 740 | long m = 0; /* # objects collected */ |
| 741 | long n = 0; /* # unreachable objects that couldn't be collected */ |
Neil Schemenauer | 2880ae5 | 2002-05-04 05:35:20 +0000 | [diff] [blame] | 742 | PyGC_Head *young; /* the generation we are examining */ |
| 743 | PyGC_Head *old; /* next older generation */ |
Tim Peters | 403a203 | 2003-11-20 21:21:46 +0000 | [diff] [blame] | 744 | PyGC_Head unreachable; /* non-problematic unreachable trash */ |
| 745 | PyGC_Head finalizers; /* objects with, & reachable from, __del__ */ |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 746 | PyGC_Head *gc; |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 747 | |
Tim Peters | 93ad66d | 2003-04-05 17:15:44 +0000 | [diff] [blame] | 748 | if (delstr == NULL) { |
| 749 | delstr = PyString_InternFromString("__del__"); |
| 750 | if (delstr == NULL) |
| 751 | Py_FatalError("gc couldn't allocate \"__del__\""); |
| 752 | } |
| 753 | |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 754 | if (debug & DEBUG_STATS) { |
Neil Schemenauer | 2880ae5 | 2002-05-04 05:35:20 +0000 | [diff] [blame] | 755 | PySys_WriteStderr("gc: collecting generation %d...\n", |
| 756 | generation); |
| 757 | PySys_WriteStderr("gc: objects in each generation:"); |
| 758 | for (i = 0; i < NUM_GENERATIONS; i++) { |
| 759 | PySys_WriteStderr(" %ld", gc_list_size(GEN_HEAD(i))); |
| 760 | } |
| 761 | PySys_WriteStderr("\n"); |
| 762 | } |
| 763 | |
| 764 | /* update collection and allocation counters */ |
| 765 | if (generation+1 < NUM_GENERATIONS) |
| 766 | generations[generation+1].count += 1; |
| 767 | for (i = 0; i <= generation; i++) |
Neil Schemenauer | c905164 | 2002-06-28 19:16:04 +0000 | [diff] [blame] | 768 | generations[i].count = 0; |
Neil Schemenauer | 2880ae5 | 2002-05-04 05:35:20 +0000 | [diff] [blame] | 769 | |
| 770 | /* merge younger generations with one we are currently collecting */ |
| 771 | for (i = 0; i < generation; i++) { |
| 772 | gc_list_merge(GEN_HEAD(i), GEN_HEAD(generation)); |
| 773 | } |
| 774 | |
| 775 | /* handy references */ |
| 776 | young = GEN_HEAD(generation); |
Tim Peters | 19b74c7 | 2002-07-01 03:52:19 +0000 | [diff] [blame] | 777 | if (generation < NUM_GENERATIONS-1) |
Neil Schemenauer | 2880ae5 | 2002-05-04 05:35:20 +0000 | [diff] [blame] | 778 | old = GEN_HEAD(generation+1); |
Tim Peters | 19b74c7 | 2002-07-01 03:52:19 +0000 | [diff] [blame] | 779 | else |
| 780 | old = young; |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 781 | |
| 782 | /* Using ob_refcnt and gc_refs, calculate which objects in the |
Tim Peters | ead8b7a | 2004-10-30 23:09:22 +0000 | [diff] [blame^] | 783 | * container set are reachable from outside the set (i.e., have a |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 784 | * refcount greater than 0 when all the references within the |
Tim Peters | ead8b7a | 2004-10-30 23:09:22 +0000 | [diff] [blame^] | 785 | * set are taken into account). |
Tim Peters | 19b74c7 | 2002-07-01 03:52:19 +0000 | [diff] [blame] | 786 | */ |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 787 | update_refs(young); |
| 788 | subtract_refs(young); |
| 789 | |
Tim Peters | 19b74c7 | 2002-07-01 03:52:19 +0000 | [diff] [blame] | 790 | /* Leave everything reachable from outside young in young, and move |
| 791 | * everything else (in young) to unreachable. |
| 792 | * NOTE: This used to move the reachable objects into a reachable |
| 793 | * set instead. But most things usually turn out to be reachable, |
| 794 | * so it's more efficient to move the unreachable things. |
| 795 | */ |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 796 | gc_list_init(&unreachable); |
Tim Peters | 19b74c7 | 2002-07-01 03:52:19 +0000 | [diff] [blame] | 797 | move_unreachable(young, &unreachable); |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 798 | |
Tim Peters | 19b74c7 | 2002-07-01 03:52:19 +0000 | [diff] [blame] | 799 | /* Move reachable objects to next generation. */ |
| 800 | if (young != old) |
| 801 | gc_list_merge(young, old); |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 802 | |
Tim Peters | 19b74c7 | 2002-07-01 03:52:19 +0000 | [diff] [blame] | 803 | /* All objects in unreachable are trash, but objects reachable from |
| 804 | * finalizers can't safely be deleted. Python programmers should take |
| 805 | * care not to create such things. For Python, finalizers means |
Tim Peters | 403a203 | 2003-11-20 21:21:46 +0000 | [diff] [blame] | 806 | * instance objects with __del__ methods. Weakrefs with callbacks |
Tim Peters | ead8b7a | 2004-10-30 23:09:22 +0000 | [diff] [blame^] | 807 | * can also call arbitrary Python code but they will be dealt with by |
| 808 | * handle_weakrefs(). |
Tim Peters | f6b8045 | 2003-04-07 19:21:15 +0000 | [diff] [blame] | 809 | */ |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 810 | gc_list_init(&finalizers); |
Tim Peters | ead8b7a | 2004-10-30 23:09:22 +0000 | [diff] [blame^] | 811 | move_finalizers(&unreachable, &finalizers); |
Tim Peters | bf384c2 | 2003-04-06 00:11:39 +0000 | [diff] [blame] | 812 | /* finalizers contains the unreachable objects with a finalizer; |
Tim Peters | 403a203 | 2003-11-20 21:21:46 +0000 | [diff] [blame] | 813 | * unreachable objects reachable *from* those are also uncollectable, |
| 814 | * and we move those into the finalizers list too. |
Tim Peters | bf384c2 | 2003-04-06 00:11:39 +0000 | [diff] [blame] | 815 | */ |
Tim Peters | f6b8045 | 2003-04-07 19:21:15 +0000 | [diff] [blame] | 816 | move_finalizer_reachable(&finalizers); |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 817 | |
| 818 | /* Collect statistics on collectable objects found and print |
Tim Peters | 403a203 | 2003-11-20 21:21:46 +0000 | [diff] [blame] | 819 | * debugging information. |
| 820 | */ |
Tim Peters | f6b8045 | 2003-04-07 19:21:15 +0000 | [diff] [blame] | 821 | for (gc = unreachable.gc.gc_next; gc != &unreachable; |
Tim Peters | 9e4ca10 | 2001-10-11 18:31:31 +0000 | [diff] [blame] | 822 | gc = gc->gc.gc_next) { |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 823 | m++; |
Jeremy Hylton | 0625777 | 2000-08-31 15:10:24 +0000 | [diff] [blame] | 824 | if (debug & DEBUG_COLLECTABLE) { |
Neil Schemenauer | 43411b5 | 2001-08-30 00:05:51 +0000 | [diff] [blame] | 825 | debug_cycle("collectable", FROM_GC(gc)); |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 826 | } |
| 827 | } |
Tim Peters | ead8b7a | 2004-10-30 23:09:22 +0000 | [diff] [blame^] | 828 | |
| 829 | /* Clear weakrefs and invoke callbacks as necessary. */ |
| 830 | m += handle_weakrefs(&unreachable, old); |
| 831 | |
Tim Peters | fb2ab4d | 2003-04-07 22:41:24 +0000 | [diff] [blame] | 832 | /* Call tp_clear on objects in the unreachable set. This will cause |
| 833 | * the reference cycles to be broken. It may also cause some objects |
| 834 | * in finalizers to be freed. |
| 835 | */ |
Tim Peters | f6b8045 | 2003-04-07 19:21:15 +0000 | [diff] [blame] | 836 | delete_garbage(&unreachable, old); |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 837 | |
| 838 | /* Collect statistics on uncollectable objects found and print |
| 839 | * debugging information. */ |
Tim Peters | 50c61d5 | 2003-04-06 01:50:50 +0000 | [diff] [blame] | 840 | for (gc = finalizers.gc.gc_next; |
Tim Peters | bf384c2 | 2003-04-06 00:11:39 +0000 | [diff] [blame] | 841 | gc != &finalizers; |
| 842 | gc = gc->gc.gc_next) { |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 843 | n++; |
Tim Peters | bf384c2 | 2003-04-06 00:11:39 +0000 | [diff] [blame] | 844 | if (debug & DEBUG_UNCOLLECTABLE) |
Neil Schemenauer | 43411b5 | 2001-08-30 00:05:51 +0000 | [diff] [blame] | 845 | debug_cycle("uncollectable", FROM_GC(gc)); |
Tim Peters | bf384c2 | 2003-04-06 00:11:39 +0000 | [diff] [blame] | 846 | } |
Jeremy Hylton | 0625777 | 2000-08-31 15:10:24 +0000 | [diff] [blame] | 847 | if (debug & DEBUG_STATS) { |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 848 | if (m == 0 && n == 0) { |
Jeremy Hylton | 0625777 | 2000-08-31 15:10:24 +0000 | [diff] [blame] | 849 | PySys_WriteStderr("gc: done.\n"); |
Neil Schemenauer | 544de1e | 2000-09-22 15:22:38 +0000 | [diff] [blame] | 850 | } |
| 851 | else { |
Jeremy Hylton | 0625777 | 2000-08-31 15:10:24 +0000 | [diff] [blame] | 852 | PySys_WriteStderr( |
| 853 | "gc: done, %ld unreachable, %ld uncollectable.\n", |
| 854 | n+m, n); |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 855 | } |
| 856 | } |
| 857 | |
| 858 | /* Append instances in the uncollectable set to a Python |
| 859 | * reachable list of garbage. The programmer has to deal with |
Tim Peters | bf384c2 | 2003-04-06 00:11:39 +0000 | [diff] [blame] | 860 | * this if they insist on creating this type of structure. |
| 861 | */ |
Tim Peters | f6b8045 | 2003-04-07 19:21:15 +0000 | [diff] [blame] | 862 | (void)handle_finalizers(&finalizers, old); |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 863 | |
Jeremy Hylton | b709df3 | 2000-09-01 02:47:25 +0000 | [diff] [blame] | 864 | if (PyErr_Occurred()) { |
Tim Peters | f6b8045 | 2003-04-07 19:21:15 +0000 | [diff] [blame] | 865 | if (gc_str == NULL) |
Tim Peters | fb2ab4d | 2003-04-07 22:41:24 +0000 | [diff] [blame] | 866 | gc_str = PyString_FromString("garbage collection"); |
Jeremy Hylton | b709df3 | 2000-09-01 02:47:25 +0000 | [diff] [blame] | 867 | PyErr_WriteUnraisable(gc_str); |
| 868 | Py_FatalError("unexpected exception during garbage collection"); |
| 869 | } |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 870 | return n+m; |
| 871 | } |
| 872 | |
| 873 | static long |
| 874 | collect_generations(void) |
| 875 | { |
Neil Schemenauer | 2880ae5 | 2002-05-04 05:35:20 +0000 | [diff] [blame] | 876 | int i; |
Vladimir Marangozov | b16714b | 2000-07-10 05:37:39 +0000 | [diff] [blame] | 877 | long n = 0; |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 878 | |
Neil Schemenauer | 2880ae5 | 2002-05-04 05:35:20 +0000 | [diff] [blame] | 879 | /* Find the oldest generation (higest numbered) where the count |
| 880 | * exceeds the threshold. Objects in the that generation and |
| 881 | * generations younger than it will be collected. */ |
| 882 | for (i = NUM_GENERATIONS-1; i >= 0; i--) { |
| 883 | if (generations[i].count > generations[i].threshold) { |
| 884 | n = collect(i); |
| 885 | break; |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 886 | } |
| 887 | } |
| 888 | return n; |
| 889 | } |
| 890 | |
Martin v. Löwis | 14f8b4c | 2002-06-13 20:33:02 +0000 | [diff] [blame] | 891 | PyDoc_STRVAR(gc_enable__doc__, |
Vladimir Marangozov | f9d20c3 | 2000-08-06 22:45:31 +0000 | [diff] [blame] | 892 | "enable() -> None\n" |
| 893 | "\n" |
Martin v. Löwis | 14f8b4c | 2002-06-13 20:33:02 +0000 | [diff] [blame] | 894 | "Enable automatic garbage collection.\n"); |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 895 | |
Vladimir Marangozov | f9d20c3 | 2000-08-06 22:45:31 +0000 | [diff] [blame] | 896 | static PyObject * |
Tim Peters | 50c61d5 | 2003-04-06 01:50:50 +0000 | [diff] [blame] | 897 | gc_enable(PyObject *self, PyObject *noargs) |
Vladimir Marangozov | f9d20c3 | 2000-08-06 22:45:31 +0000 | [diff] [blame] | 898 | { |
Vladimir Marangozov | f9d20c3 | 2000-08-06 22:45:31 +0000 | [diff] [blame] | 899 | enabled = 1; |
Vladimir Marangozov | f9d20c3 | 2000-08-06 22:45:31 +0000 | [diff] [blame] | 900 | Py_INCREF(Py_None); |
| 901 | return Py_None; |
| 902 | } |
| 903 | |
Martin v. Löwis | 14f8b4c | 2002-06-13 20:33:02 +0000 | [diff] [blame] | 904 | PyDoc_STRVAR(gc_disable__doc__, |
Vladimir Marangozov | f9d20c3 | 2000-08-06 22:45:31 +0000 | [diff] [blame] | 905 | "disable() -> None\n" |
| 906 | "\n" |
Martin v. Löwis | 14f8b4c | 2002-06-13 20:33:02 +0000 | [diff] [blame] | 907 | "Disable automatic garbage collection.\n"); |
Vladimir Marangozov | f9d20c3 | 2000-08-06 22:45:31 +0000 | [diff] [blame] | 908 | |
| 909 | static PyObject * |
Tim Peters | 50c61d5 | 2003-04-06 01:50:50 +0000 | [diff] [blame] | 910 | gc_disable(PyObject *self, PyObject *noargs) |
Vladimir Marangozov | f9d20c3 | 2000-08-06 22:45:31 +0000 | [diff] [blame] | 911 | { |
Vladimir Marangozov | f9d20c3 | 2000-08-06 22:45:31 +0000 | [diff] [blame] | 912 | enabled = 0; |
Vladimir Marangozov | f9d20c3 | 2000-08-06 22:45:31 +0000 | [diff] [blame] | 913 | Py_INCREF(Py_None); |
| 914 | return Py_None; |
| 915 | } |
| 916 | |
Martin v. Löwis | 14f8b4c | 2002-06-13 20:33:02 +0000 | [diff] [blame] | 917 | PyDoc_STRVAR(gc_isenabled__doc__, |
Vladimir Marangozov | f9d20c3 | 2000-08-06 22:45:31 +0000 | [diff] [blame] | 918 | "isenabled() -> status\n" |
| 919 | "\n" |
Martin v. Löwis | 14f8b4c | 2002-06-13 20:33:02 +0000 | [diff] [blame] | 920 | "Returns true if automatic garbage collection is enabled.\n"); |
Vladimir Marangozov | f9d20c3 | 2000-08-06 22:45:31 +0000 | [diff] [blame] | 921 | |
| 922 | static PyObject * |
Tim Peters | 50c61d5 | 2003-04-06 01:50:50 +0000 | [diff] [blame] | 923 | gc_isenabled(PyObject *self, PyObject *noargs) |
Vladimir Marangozov | f9d20c3 | 2000-08-06 22:45:31 +0000 | [diff] [blame] | 924 | { |
Raymond Hettinger | 674d56b | 2004-01-04 04:00:13 +0000 | [diff] [blame] | 925 | return PyBool_FromLong((long)enabled); |
Vladimir Marangozov | f9d20c3 | 2000-08-06 22:45:31 +0000 | [diff] [blame] | 926 | } |
| 927 | |
Martin v. Löwis | 14f8b4c | 2002-06-13 20:33:02 +0000 | [diff] [blame] | 928 | PyDoc_STRVAR(gc_collect__doc__, |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 929 | "collect() -> n\n" |
| 930 | "\n" |
Martin v. Löwis | 14f8b4c | 2002-06-13 20:33:02 +0000 | [diff] [blame] | 931 | "Run a full collection. The number of unreachable objects is returned.\n"); |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 932 | |
| 933 | static PyObject * |
Tim Peters | 50c61d5 | 2003-04-06 01:50:50 +0000 | [diff] [blame] | 934 | gc_collect(PyObject *self, PyObject *noargs) |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 935 | { |
| 936 | long n; |
| 937 | |
Tim Peters | 50c61d5 | 2003-04-06 01:50:50 +0000 | [diff] [blame] | 938 | if (collecting) |
Neil Schemenauer | e8c40cb | 2001-10-31 23:09:35 +0000 | [diff] [blame] | 939 | n = 0; /* already collecting, don't do anything */ |
Neil Schemenauer | e8c40cb | 2001-10-31 23:09:35 +0000 | [diff] [blame] | 940 | else { |
| 941 | collecting = 1; |
Neil Schemenauer | 2880ae5 | 2002-05-04 05:35:20 +0000 | [diff] [blame] | 942 | n = collect(NUM_GENERATIONS - 1); |
Neil Schemenauer | e8c40cb | 2001-10-31 23:09:35 +0000 | [diff] [blame] | 943 | collecting = 0; |
| 944 | } |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 945 | |
Neil Schemenauer | 7760cff | 2000-09-22 22:35:36 +0000 | [diff] [blame] | 946 | return Py_BuildValue("l", n); |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 947 | } |
| 948 | |
Martin v. Löwis | 14f8b4c | 2002-06-13 20:33:02 +0000 | [diff] [blame] | 949 | PyDoc_STRVAR(gc_set_debug__doc__, |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 950 | "set_debug(flags) -> None\n" |
| 951 | "\n" |
| 952 | "Set the garbage collection debugging flags. Debugging information is\n" |
| 953 | "written to sys.stderr.\n" |
| 954 | "\n" |
| 955 | "flags is an integer and can have the following bits turned on:\n" |
| 956 | "\n" |
| 957 | " DEBUG_STATS - Print statistics during collection.\n" |
| 958 | " DEBUG_COLLECTABLE - Print collectable objects found.\n" |
| 959 | " DEBUG_UNCOLLECTABLE - Print unreachable but uncollectable objects found.\n" |
| 960 | " DEBUG_INSTANCES - Print instance objects.\n" |
| 961 | " DEBUG_OBJECTS - Print objects other than instances.\n" |
Neil Schemenauer | 544de1e | 2000-09-22 15:22:38 +0000 | [diff] [blame] | 962 | " DEBUG_SAVEALL - Save objects to gc.garbage rather than freeing them.\n" |
Martin v. Löwis | 14f8b4c | 2002-06-13 20:33:02 +0000 | [diff] [blame] | 963 | " DEBUG_LEAK - Debug leaking programs (everything but STATS).\n"); |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 964 | |
| 965 | static PyObject * |
Vladimir Marangozov | f9d20c3 | 2000-08-06 22:45:31 +0000 | [diff] [blame] | 966 | gc_set_debug(PyObject *self, PyObject *args) |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 967 | { |
Neil Schemenauer | 7760cff | 2000-09-22 22:35:36 +0000 | [diff] [blame] | 968 | if (!PyArg_ParseTuple(args, "i:set_debug", &debug)) |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 969 | return NULL; |
| 970 | |
| 971 | Py_INCREF(Py_None); |
| 972 | return Py_None; |
| 973 | } |
| 974 | |
Martin v. Löwis | 14f8b4c | 2002-06-13 20:33:02 +0000 | [diff] [blame] | 975 | PyDoc_STRVAR(gc_get_debug__doc__, |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 976 | "get_debug() -> flags\n" |
| 977 | "\n" |
Martin v. Löwis | 14f8b4c | 2002-06-13 20:33:02 +0000 | [diff] [blame] | 978 | "Get the garbage collection debugging flags.\n"); |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 979 | |
| 980 | static PyObject * |
Tim Peters | 50c61d5 | 2003-04-06 01:50:50 +0000 | [diff] [blame] | 981 | gc_get_debug(PyObject *self, PyObject *noargs) |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 982 | { |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 983 | return Py_BuildValue("i", debug); |
| 984 | } |
| 985 | |
Martin v. Löwis | 14f8b4c | 2002-06-13 20:33:02 +0000 | [diff] [blame] | 986 | PyDoc_STRVAR(gc_set_thresh__doc__, |
Neal Norwitz | 2a47c0f | 2002-01-29 00:53:41 +0000 | [diff] [blame] | 987 | "set_threshold(threshold0, [threshold1, threshold2]) -> None\n" |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 988 | "\n" |
| 989 | "Sets the collection thresholds. Setting threshold0 to zero disables\n" |
Martin v. Löwis | 14f8b4c | 2002-06-13 20:33:02 +0000 | [diff] [blame] | 990 | "collection.\n"); |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 991 | |
| 992 | static PyObject * |
Vladimir Marangozov | f9d20c3 | 2000-08-06 22:45:31 +0000 | [diff] [blame] | 993 | gc_set_thresh(PyObject *self, PyObject *args) |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 994 | { |
Neil Schemenauer | 2880ae5 | 2002-05-04 05:35:20 +0000 | [diff] [blame] | 995 | int i; |
| 996 | if (!PyArg_ParseTuple(args, "i|ii:set_threshold", |
| 997 | &generations[0].threshold, |
| 998 | &generations[1].threshold, |
| 999 | &generations[2].threshold)) |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 1000 | return NULL; |
Neil Schemenauer | 2880ae5 | 2002-05-04 05:35:20 +0000 | [diff] [blame] | 1001 | for (i = 2; i < NUM_GENERATIONS; i++) { |
| 1002 | /* generations higher than 2 get the same threshold */ |
| 1003 | generations[i].threshold = generations[2].threshold; |
| 1004 | } |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 1005 | |
| 1006 | Py_INCREF(Py_None); |
| 1007 | return Py_None; |
| 1008 | } |
| 1009 | |
Martin v. Löwis | 14f8b4c | 2002-06-13 20:33:02 +0000 | [diff] [blame] | 1010 | PyDoc_STRVAR(gc_get_thresh__doc__, |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 1011 | "get_threshold() -> (threshold0, threshold1, threshold2)\n" |
| 1012 | "\n" |
Martin v. Löwis | 14f8b4c | 2002-06-13 20:33:02 +0000 | [diff] [blame] | 1013 | "Return the current collection thresholds\n"); |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 1014 | |
| 1015 | static PyObject * |
Tim Peters | 50c61d5 | 2003-04-06 01:50:50 +0000 | [diff] [blame] | 1016 | gc_get_thresh(PyObject *self, PyObject *noargs) |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 1017 | { |
Neil Schemenauer | 2880ae5 | 2002-05-04 05:35:20 +0000 | [diff] [blame] | 1018 | return Py_BuildValue("(iii)", |
| 1019 | generations[0].threshold, |
| 1020 | generations[1].threshold, |
| 1021 | generations[2].threshold); |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 1022 | } |
| 1023 | |
Neil Schemenauer | 48c7034 | 2001-08-09 15:38:31 +0000 | [diff] [blame] | 1024 | static int |
Martin v. Löwis | 560da62 | 2001-11-24 09:24:51 +0000 | [diff] [blame] | 1025 | referrersvisit(PyObject* obj, PyObject *objs) |
Neil Schemenauer | 48c7034 | 2001-08-09 15:38:31 +0000 | [diff] [blame] | 1026 | { |
Martin v. Löwis | c8fe77b | 2001-11-29 18:08:31 +0000 | [diff] [blame] | 1027 | int i; |
| 1028 | for (i = 0; i < PyTuple_GET_SIZE(objs); i++) |
| 1029 | if (PyTuple_GET_ITEM(objs, i) == obj) |
| 1030 | return 1; |
Neil Schemenauer | 48c7034 | 2001-08-09 15:38:31 +0000 | [diff] [blame] | 1031 | return 0; |
| 1032 | } |
| 1033 | |
Neil Schemenauer | 17e7be6 | 2001-08-10 14:46:47 +0000 | [diff] [blame] | 1034 | static int |
Martin v. Löwis | 560da62 | 2001-11-24 09:24:51 +0000 | [diff] [blame] | 1035 | gc_referrers_for(PyObject *objs, PyGC_Head *list, PyObject *resultlist) |
Neil Schemenauer | 48c7034 | 2001-08-09 15:38:31 +0000 | [diff] [blame] | 1036 | { |
| 1037 | PyGC_Head *gc; |
| 1038 | PyObject *obj; |
| 1039 | traverseproc traverse; |
Tim Peters | 9e4ca10 | 2001-10-11 18:31:31 +0000 | [diff] [blame] | 1040 | for (gc = list->gc.gc_next; gc != list; gc = gc->gc.gc_next) { |
Neil Schemenauer | 43411b5 | 2001-08-30 00:05:51 +0000 | [diff] [blame] | 1041 | obj = FROM_GC(gc); |
Neil Schemenauer | 48c7034 | 2001-08-09 15:38:31 +0000 | [diff] [blame] | 1042 | traverse = obj->ob_type->tp_traverse; |
| 1043 | if (obj == objs || obj == resultlist) |
| 1044 | continue; |
Martin v. Löwis | 560da62 | 2001-11-24 09:24:51 +0000 | [diff] [blame] | 1045 | if (traverse(obj, (visitproc)referrersvisit, objs)) { |
Neil Schemenauer | 17e7be6 | 2001-08-10 14:46:47 +0000 | [diff] [blame] | 1046 | if (PyList_Append(resultlist, obj) < 0) |
| 1047 | return 0; /* error */ |
Neil Schemenauer | 48c7034 | 2001-08-09 15:38:31 +0000 | [diff] [blame] | 1048 | } |
| 1049 | } |
Neil Schemenauer | 17e7be6 | 2001-08-10 14:46:47 +0000 | [diff] [blame] | 1050 | return 1; /* no error */ |
Neil Schemenauer | 48c7034 | 2001-08-09 15:38:31 +0000 | [diff] [blame] | 1051 | } |
| 1052 | |
Martin v. Löwis | 14f8b4c | 2002-06-13 20:33:02 +0000 | [diff] [blame] | 1053 | PyDoc_STRVAR(gc_get_referrers__doc__, |
Martin v. Löwis | 560da62 | 2001-11-24 09:24:51 +0000 | [diff] [blame] | 1054 | "get_referrers(*objs) -> list\n\ |
Martin v. Löwis | 14f8b4c | 2002-06-13 20:33:02 +0000 | [diff] [blame] | 1055 | Return the list of objects that directly refer to any of objs."); |
Neil Schemenauer | 48c7034 | 2001-08-09 15:38:31 +0000 | [diff] [blame] | 1056 | |
Neil Schemenauer | 17e7be6 | 2001-08-10 14:46:47 +0000 | [diff] [blame] | 1057 | static PyObject * |
Martin v. Löwis | 560da62 | 2001-11-24 09:24:51 +0000 | [diff] [blame] | 1058 | gc_get_referrers(PyObject *self, PyObject *args) |
Neil Schemenauer | 48c7034 | 2001-08-09 15:38:31 +0000 | [diff] [blame] | 1059 | { |
Neil Schemenauer | 2880ae5 | 2002-05-04 05:35:20 +0000 | [diff] [blame] | 1060 | int i; |
Neil Schemenauer | 48c7034 | 2001-08-09 15:38:31 +0000 | [diff] [blame] | 1061 | PyObject *result = PyList_New(0); |
Neil Schemenauer | 2880ae5 | 2002-05-04 05:35:20 +0000 | [diff] [blame] | 1062 | for (i = 0; i < NUM_GENERATIONS; i++) { |
| 1063 | if (!(gc_referrers_for(args, GEN_HEAD(i), result))) { |
| 1064 | Py_DECREF(result); |
| 1065 | return NULL; |
| 1066 | } |
Neil Schemenauer | 17e7be6 | 2001-08-10 14:46:47 +0000 | [diff] [blame] | 1067 | } |
Neil Schemenauer | 48c7034 | 2001-08-09 15:38:31 +0000 | [diff] [blame] | 1068 | return result; |
| 1069 | } |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 1070 | |
Tim Peters | 0f81ab6 | 2003-04-08 16:39:48 +0000 | [diff] [blame] | 1071 | /* 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] | 1072 | static int |
Tim Peters | 730f553 | 2003-04-08 17:17:17 +0000 | [diff] [blame] | 1073 | referentsvisit(PyObject *obj, PyObject *list) |
Jeremy Hylton | 5bd378b | 2003-04-03 16:28:38 +0000 | [diff] [blame] | 1074 | { |
Tim Peters | 0f81ab6 | 2003-04-08 16:39:48 +0000 | [diff] [blame] | 1075 | return PyList_Append(list, obj) < 0; |
Jeremy Hylton | 5bd378b | 2003-04-03 16:28:38 +0000 | [diff] [blame] | 1076 | } |
| 1077 | |
Tim Peters | 730f553 | 2003-04-08 17:17:17 +0000 | [diff] [blame] | 1078 | PyDoc_STRVAR(gc_get_referents__doc__, |
| 1079 | "get_referents(*objs) -> list\n\ |
Jeremy Hylton | 059b094 | 2003-04-03 16:29:13 +0000 | [diff] [blame] | 1080 | Return the list of objects that are directly referred to by objs."); |
Jeremy Hylton | 5bd378b | 2003-04-03 16:28:38 +0000 | [diff] [blame] | 1081 | |
| 1082 | static PyObject * |
Tim Peters | 730f553 | 2003-04-08 17:17:17 +0000 | [diff] [blame] | 1083 | gc_get_referents(PyObject *self, PyObject *args) |
Jeremy Hylton | 5bd378b | 2003-04-03 16:28:38 +0000 | [diff] [blame] | 1084 | { |
| 1085 | int i; |
| 1086 | PyObject *result = PyList_New(0); |
Tim Peters | 0f81ab6 | 2003-04-08 16:39:48 +0000 | [diff] [blame] | 1087 | |
| 1088 | if (result == NULL) |
| 1089 | return NULL; |
| 1090 | |
Jeremy Hylton | 5bd378b | 2003-04-03 16:28:38 +0000 | [diff] [blame] | 1091 | for (i = 0; i < PyTuple_GET_SIZE(args); i++) { |
Tim Peters | 0f81ab6 | 2003-04-08 16:39:48 +0000 | [diff] [blame] | 1092 | traverseproc traverse; |
Tim Peters | 93ad66d | 2003-04-05 17:15:44 +0000 | [diff] [blame] | 1093 | PyObject *obj = PyTuple_GET_ITEM(args, i); |
Tim Peters | 0f81ab6 | 2003-04-08 16:39:48 +0000 | [diff] [blame] | 1094 | |
| 1095 | if (! PyObject_IS_GC(obj)) |
Jeremy Hylton | 5bd378b | 2003-04-03 16:28:38 +0000 | [diff] [blame] | 1096 | continue; |
Tim Peters | 0f81ab6 | 2003-04-08 16:39:48 +0000 | [diff] [blame] | 1097 | traverse = obj->ob_type->tp_traverse; |
| 1098 | if (! traverse) |
| 1099 | continue; |
Tim Peters | 730f553 | 2003-04-08 17:17:17 +0000 | [diff] [blame] | 1100 | if (traverse(obj, (visitproc)referentsvisit, result)) { |
Tim Peters | 0f81ab6 | 2003-04-08 16:39:48 +0000 | [diff] [blame] | 1101 | Py_DECREF(result); |
Jeremy Hylton | 5bd378b | 2003-04-03 16:28:38 +0000 | [diff] [blame] | 1102 | return NULL; |
Tim Peters | 0f81ab6 | 2003-04-08 16:39:48 +0000 | [diff] [blame] | 1103 | } |
Jeremy Hylton | 5bd378b | 2003-04-03 16:28:38 +0000 | [diff] [blame] | 1104 | } |
| 1105 | return result; |
| 1106 | } |
| 1107 | |
Martin v. Löwis | 14f8b4c | 2002-06-13 20:33:02 +0000 | [diff] [blame] | 1108 | PyDoc_STRVAR(gc_get_objects__doc__, |
Neil Schemenauer | c7c8d8e | 2001-08-09 15:58:59 +0000 | [diff] [blame] | 1109 | "get_objects() -> [...]\n" |
| 1110 | "\n" |
| 1111 | "Return a list of objects tracked by the collector (excluding the list\n" |
Martin v. Löwis | 14f8b4c | 2002-06-13 20:33:02 +0000 | [diff] [blame] | 1112 | "returned).\n"); |
Neil Schemenauer | c7c8d8e | 2001-08-09 15:58:59 +0000 | [diff] [blame] | 1113 | |
Neil Schemenauer | c7c8d8e | 2001-08-09 15:58:59 +0000 | [diff] [blame] | 1114 | static PyObject * |
Tim Peters | 50c61d5 | 2003-04-06 01:50:50 +0000 | [diff] [blame] | 1115 | gc_get_objects(PyObject *self, PyObject *noargs) |
Neil Schemenauer | c7c8d8e | 2001-08-09 15:58:59 +0000 | [diff] [blame] | 1116 | { |
Neil Schemenauer | 2880ae5 | 2002-05-04 05:35:20 +0000 | [diff] [blame] | 1117 | int i; |
Neil Schemenauer | c7c8d8e | 2001-08-09 15:58:59 +0000 | [diff] [blame] | 1118 | PyObject* result; |
| 1119 | |
Neil Schemenauer | c7c8d8e | 2001-08-09 15:58:59 +0000 | [diff] [blame] | 1120 | result = PyList_New(0); |
Tim Peters | 50c61d5 | 2003-04-06 01:50:50 +0000 | [diff] [blame] | 1121 | if (result == NULL) |
Martin v. Löwis | f8a6f24 | 2001-12-02 18:31:02 +0000 | [diff] [blame] | 1122 | return NULL; |
Neil Schemenauer | 2880ae5 | 2002-05-04 05:35:20 +0000 | [diff] [blame] | 1123 | for (i = 0; i < NUM_GENERATIONS; i++) { |
| 1124 | if (append_objects(result, GEN_HEAD(i))) { |
| 1125 | Py_DECREF(result); |
| 1126 | return NULL; |
| 1127 | } |
Martin v. Löwis | 155aad1 | 2001-12-02 12:21:34 +0000 | [diff] [blame] | 1128 | } |
Neil Schemenauer | c7c8d8e | 2001-08-09 15:58:59 +0000 | [diff] [blame] | 1129 | return result; |
| 1130 | } |
| 1131 | |
| 1132 | |
Martin v. Löwis | 14f8b4c | 2002-06-13 20:33:02 +0000 | [diff] [blame] | 1133 | PyDoc_STRVAR(gc__doc__, |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 1134 | "This module provides access to the garbage collector for reference cycles.\n" |
| 1135 | "\n" |
Vladimir Marangozov | f9d20c3 | 2000-08-06 22:45:31 +0000 | [diff] [blame] | 1136 | "enable() -- Enable automatic garbage collection.\n" |
| 1137 | "disable() -- Disable automatic garbage collection.\n" |
| 1138 | "isenabled() -- Returns true if automatic collection is enabled.\n" |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 1139 | "collect() -- Do a full collection right now.\n" |
| 1140 | "set_debug() -- Set debugging flags.\n" |
| 1141 | "get_debug() -- Get debugging flags.\n" |
| 1142 | "set_threshold() -- Set the collection thresholds.\n" |
| 1143 | "get_threshold() -- Return the current the collection thresholds.\n" |
Neil Schemenauer | c7c8d8e | 2001-08-09 15:58:59 +0000 | [diff] [blame] | 1144 | "get_objects() -- Return a list of all objects tracked by the collector.\n" |
Jeremy Hylton | 5bd378b | 2003-04-03 16:28:38 +0000 | [diff] [blame] | 1145 | "get_referrers() -- Return the list of objects that refer to an object.\n" |
Tim Peters | 730f553 | 2003-04-08 17:17:17 +0000 | [diff] [blame] | 1146 | "get_referents() -- Return the list of objects that an object refers to.\n"); |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 1147 | |
| 1148 | static PyMethodDef GcMethods[] = { |
Tim Peters | 50c61d5 | 2003-04-06 01:50:50 +0000 | [diff] [blame] | 1149 | {"enable", gc_enable, METH_NOARGS, gc_enable__doc__}, |
| 1150 | {"disable", gc_disable, METH_NOARGS, gc_disable__doc__}, |
| 1151 | {"isenabled", gc_isenabled, METH_NOARGS, gc_isenabled__doc__}, |
Vladimir Marangozov | f9d20c3 | 2000-08-06 22:45:31 +0000 | [diff] [blame] | 1152 | {"set_debug", gc_set_debug, METH_VARARGS, gc_set_debug__doc__}, |
Tim Peters | 50c61d5 | 2003-04-06 01:50:50 +0000 | [diff] [blame] | 1153 | {"get_debug", gc_get_debug, METH_NOARGS, gc_get_debug__doc__}, |
Vladimir Marangozov | f9d20c3 | 2000-08-06 22:45:31 +0000 | [diff] [blame] | 1154 | {"set_threshold", gc_set_thresh, METH_VARARGS, gc_set_thresh__doc__}, |
Tim Peters | 50c61d5 | 2003-04-06 01:50:50 +0000 | [diff] [blame] | 1155 | {"get_threshold", gc_get_thresh, METH_NOARGS, gc_get_thresh__doc__}, |
| 1156 | {"collect", gc_collect, METH_NOARGS, gc_collect__doc__}, |
| 1157 | {"get_objects", gc_get_objects,METH_NOARGS, gc_get_objects__doc__}, |
Martin v. Löwis | 560da62 | 2001-11-24 09:24:51 +0000 | [diff] [blame] | 1158 | {"get_referrers", gc_get_referrers, METH_VARARGS, |
| 1159 | gc_get_referrers__doc__}, |
Tim Peters | 730f553 | 2003-04-08 17:17:17 +0000 | [diff] [blame] | 1160 | {"get_referents", gc_get_referents, METH_VARARGS, |
| 1161 | gc_get_referents__doc__}, |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 1162 | {NULL, NULL} /* Sentinel */ |
| 1163 | }; |
| 1164 | |
Jason Tishler | 6bc06ec | 2003-09-04 11:59:50 +0000 | [diff] [blame] | 1165 | PyMODINIT_FUNC |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 1166 | initgc(void) |
| 1167 | { |
| 1168 | PyObject *m; |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 1169 | |
| 1170 | m = Py_InitModule4("gc", |
| 1171 | GcMethods, |
| 1172 | gc__doc__, |
| 1173 | NULL, |
| 1174 | PYTHON_API_VERSION); |
Tim Peters | 1155887 | 2003-04-06 23:30:52 +0000 | [diff] [blame] | 1175 | |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 1176 | if (garbage == NULL) { |
| 1177 | garbage = PyList_New(0); |
Tim Peters | 1155887 | 2003-04-06 23:30:52 +0000 | [diff] [blame] | 1178 | if (garbage == NULL) |
| 1179 | return; |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 1180 | } |
Tim Peters | 1155887 | 2003-04-06 23:30:52 +0000 | [diff] [blame] | 1181 | if (PyModule_AddObject(m, "garbage", garbage) < 0) |
| 1182 | return; |
| 1183 | #define ADD_INT(NAME) if (PyModule_AddIntConstant(m, #NAME, NAME) < 0) return |
| 1184 | ADD_INT(DEBUG_STATS); |
| 1185 | ADD_INT(DEBUG_COLLECTABLE); |
| 1186 | ADD_INT(DEBUG_UNCOLLECTABLE); |
| 1187 | ADD_INT(DEBUG_INSTANCES); |
| 1188 | ADD_INT(DEBUG_OBJECTS); |
| 1189 | ADD_INT(DEBUG_SAVEALL); |
| 1190 | ADD_INT(DEBUG_LEAK); |
| 1191 | #undef ADD_INT |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 1192 | } |
| 1193 | |
Guido van Rossum | e13ddc9 | 2003-04-17 17:29:22 +0000 | [diff] [blame] | 1194 | /* API to invoke gc.collect() from C */ |
| 1195 | long |
| 1196 | PyGC_Collect(void) |
| 1197 | { |
| 1198 | long n; |
| 1199 | |
| 1200 | if (collecting) |
| 1201 | n = 0; /* already collecting, don't do anything */ |
| 1202 | else { |
| 1203 | collecting = 1; |
| 1204 | n = collect(NUM_GENERATIONS - 1); |
| 1205 | collecting = 0; |
| 1206 | } |
| 1207 | |
| 1208 | return n; |
| 1209 | } |
| 1210 | |
Neil Schemenauer | 43411b5 | 2001-08-30 00:05:51 +0000 | [diff] [blame] | 1211 | /* for debugging */ |
Guido van Rossum | e13ddc9 | 2003-04-17 17:29:22 +0000 | [diff] [blame] | 1212 | void |
| 1213 | _PyGC_Dump(PyGC_Head *g) |
Neil Schemenauer | 43411b5 | 2001-08-30 00:05:51 +0000 | [diff] [blame] | 1214 | { |
| 1215 | _PyObject_Dump(FROM_GC(g)); |
| 1216 | } |
| 1217 | |
Neil Schemenauer | 43411b5 | 2001-08-30 00:05:51 +0000 | [diff] [blame] | 1218 | /* extension modules might be compiled with GC support so these |
| 1219 | functions must always be available */ |
| 1220 | |
Neil Schemenauer | fec4eb1 | 2002-04-12 02:41:03 +0000 | [diff] [blame] | 1221 | #undef PyObject_GC_Track |
| 1222 | #undef PyObject_GC_UnTrack |
| 1223 | #undef PyObject_GC_Del |
| 1224 | #undef _PyObject_GC_Malloc |
| 1225 | |
Neil Schemenauer | 43411b5 | 2001-08-30 00:05:51 +0000 | [diff] [blame] | 1226 | void |
Neil Schemenauer | fec4eb1 | 2002-04-12 02:41:03 +0000 | [diff] [blame] | 1227 | PyObject_GC_Track(void *op) |
Neil Schemenauer | 43411b5 | 2001-08-30 00:05:51 +0000 | [diff] [blame] | 1228 | { |
| 1229 | _PyObject_GC_TRACK(op); |
| 1230 | } |
| 1231 | |
Neil Schemenauer | fec4eb1 | 2002-04-12 02:41:03 +0000 | [diff] [blame] | 1232 | /* for binary compatibility with 2.2 */ |
Neil Schemenauer | 43411b5 | 2001-08-30 00:05:51 +0000 | [diff] [blame] | 1233 | void |
Neil Schemenauer | fec4eb1 | 2002-04-12 02:41:03 +0000 | [diff] [blame] | 1234 | _PyObject_GC_Track(PyObject *op) |
| 1235 | { |
| 1236 | PyObject_GC_Track(op); |
| 1237 | } |
| 1238 | |
| 1239 | void |
| 1240 | PyObject_GC_UnTrack(void *op) |
Neil Schemenauer | 43411b5 | 2001-08-30 00:05:51 +0000 | [diff] [blame] | 1241 | { |
Tim Peters | 803526b | 2002-07-07 05:13:56 +0000 | [diff] [blame] | 1242 | /* Obscure: the Py_TRASHCAN mechanism requires that we be able to |
| 1243 | * call PyObject_GC_UnTrack twice on an object. |
| 1244 | */ |
Neil Schemenauer | a2b11ec | 2002-05-21 15:53:24 +0000 | [diff] [blame] | 1245 | if (IS_TRACKED(op)) |
Guido van Rossum | ff413af | 2002-03-28 20:34:59 +0000 | [diff] [blame] | 1246 | _PyObject_GC_UNTRACK(op); |
Neil Schemenauer | 43411b5 | 2001-08-30 00:05:51 +0000 | [diff] [blame] | 1247 | } |
| 1248 | |
Neil Schemenauer | fec4eb1 | 2002-04-12 02:41:03 +0000 | [diff] [blame] | 1249 | /* for binary compatibility with 2.2 */ |
| 1250 | void |
| 1251 | _PyObject_GC_UnTrack(PyObject *op) |
| 1252 | { |
| 1253 | PyObject_GC_UnTrack(op); |
| 1254 | } |
| 1255 | |
Neil Schemenauer | 43411b5 | 2001-08-30 00:05:51 +0000 | [diff] [blame] | 1256 | PyObject * |
Neil Schemenauer | fec4eb1 | 2002-04-12 02:41:03 +0000 | [diff] [blame] | 1257 | _PyObject_GC_Malloc(size_t basicsize) |
Neil Schemenauer | 43411b5 | 2001-08-30 00:05:51 +0000 | [diff] [blame] | 1258 | { |
| 1259 | PyObject *op; |
Neil Schemenauer | fec4eb1 | 2002-04-12 02:41:03 +0000 | [diff] [blame] | 1260 | PyGC_Head *g = PyObject_MALLOC(sizeof(PyGC_Head) + basicsize); |
Neil Schemenauer | 43411b5 | 2001-08-30 00:05:51 +0000 | [diff] [blame] | 1261 | if (g == NULL) |
Jeremy Hylton | 8a13518 | 2002-06-06 23:23:55 +0000 | [diff] [blame] | 1262 | return PyErr_NoMemory(); |
Tim Peters | ea40563 | 2002-07-02 00:52:30 +0000 | [diff] [blame] | 1263 | g->gc.gc_refs = GC_UNTRACKED; |
Neil Schemenauer | 2880ae5 | 2002-05-04 05:35:20 +0000 | [diff] [blame] | 1264 | generations[0].count++; /* number of allocated GC objects */ |
| 1265 | if (generations[0].count > generations[0].threshold && |
Neil Schemenauer | 43411b5 | 2001-08-30 00:05:51 +0000 | [diff] [blame] | 1266 | enabled && |
Neil Schemenauer | 2880ae5 | 2002-05-04 05:35:20 +0000 | [diff] [blame] | 1267 | generations[0].threshold && |
Neil Schemenauer | 43411b5 | 2001-08-30 00:05:51 +0000 | [diff] [blame] | 1268 | !collecting && |
| 1269 | !PyErr_Occurred()) { |
| 1270 | collecting = 1; |
Neil Schemenauer | 2880ae5 | 2002-05-04 05:35:20 +0000 | [diff] [blame] | 1271 | collect_generations(); |
Neil Schemenauer | 43411b5 | 2001-08-30 00:05:51 +0000 | [diff] [blame] | 1272 | collecting = 0; |
| 1273 | } |
| 1274 | op = FROM_GC(g); |
Neil Schemenauer | 43411b5 | 2001-08-30 00:05:51 +0000 | [diff] [blame] | 1275 | return op; |
| 1276 | } |
| 1277 | |
| 1278 | PyObject * |
| 1279 | _PyObject_GC_New(PyTypeObject *tp) |
| 1280 | { |
Neil Schemenauer | fec4eb1 | 2002-04-12 02:41:03 +0000 | [diff] [blame] | 1281 | PyObject *op = _PyObject_GC_Malloc(_PyObject_SIZE(tp)); |
Tim Peters | fa8efab | 2002-04-28 01:57:25 +0000 | [diff] [blame] | 1282 | if (op != NULL) |
| 1283 | op = PyObject_INIT(op, tp); |
| 1284 | return op; |
Neil Schemenauer | 43411b5 | 2001-08-30 00:05:51 +0000 | [diff] [blame] | 1285 | } |
| 1286 | |
| 1287 | PyVarObject * |
Tim Peters | 6d483d3 | 2001-10-06 21:27:34 +0000 | [diff] [blame] | 1288 | _PyObject_GC_NewVar(PyTypeObject *tp, int nitems) |
Neil Schemenauer | 43411b5 | 2001-08-30 00:05:51 +0000 | [diff] [blame] | 1289 | { |
Neil Schemenauer | fec4eb1 | 2002-04-12 02:41:03 +0000 | [diff] [blame] | 1290 | const size_t size = _PyObject_VAR_SIZE(tp, nitems); |
| 1291 | PyVarObject *op = (PyVarObject *) _PyObject_GC_Malloc(size); |
Tim Peters | fa8efab | 2002-04-28 01:57:25 +0000 | [diff] [blame] | 1292 | if (op != NULL) |
| 1293 | op = PyObject_INIT_VAR(op, tp, nitems); |
| 1294 | return op; |
Neil Schemenauer | 43411b5 | 2001-08-30 00:05:51 +0000 | [diff] [blame] | 1295 | } |
| 1296 | |
| 1297 | PyVarObject * |
Tim Peters | 6d483d3 | 2001-10-06 21:27:34 +0000 | [diff] [blame] | 1298 | _PyObject_GC_Resize(PyVarObject *op, int nitems) |
Neil Schemenauer | 43411b5 | 2001-08-30 00:05:51 +0000 | [diff] [blame] | 1299 | { |
Tim Peters | f2a67da | 2001-10-07 03:54:51 +0000 | [diff] [blame] | 1300 | const size_t basicsize = _PyObject_VAR_SIZE(op->ob_type, nitems); |
Neil Schemenauer | 43411b5 | 2001-08-30 00:05:51 +0000 | [diff] [blame] | 1301 | PyGC_Head *g = AS_GC(op); |
Neil Schemenauer | fec4eb1 | 2002-04-12 02:41:03 +0000 | [diff] [blame] | 1302 | g = PyObject_REALLOC(g, sizeof(PyGC_Head) + basicsize); |
Neil Schemenauer | 43411b5 | 2001-08-30 00:05:51 +0000 | [diff] [blame] | 1303 | if (g == NULL) |
| 1304 | return (PyVarObject *)PyErr_NoMemory(); |
| 1305 | op = (PyVarObject *) FROM_GC(g); |
Tim Peters | 6d483d3 | 2001-10-06 21:27:34 +0000 | [diff] [blame] | 1306 | op->ob_size = nitems; |
Neil Schemenauer | 43411b5 | 2001-08-30 00:05:51 +0000 | [diff] [blame] | 1307 | return op; |
| 1308 | } |
| 1309 | |
| 1310 | void |
Neil Schemenauer | fec4eb1 | 2002-04-12 02:41:03 +0000 | [diff] [blame] | 1311 | PyObject_GC_Del(void *op) |
Neil Schemenauer | 43411b5 | 2001-08-30 00:05:51 +0000 | [diff] [blame] | 1312 | { |
Neil Schemenauer | 43411b5 | 2001-08-30 00:05:51 +0000 | [diff] [blame] | 1313 | PyGC_Head *g = AS_GC(op); |
Neil Schemenauer | a2b11ec | 2002-05-21 15:53:24 +0000 | [diff] [blame] | 1314 | if (IS_TRACKED(op)) |
Neil Schemenauer | 43411b5 | 2001-08-30 00:05:51 +0000 | [diff] [blame] | 1315 | gc_list_remove(g); |
Neil Schemenauer | 2880ae5 | 2002-05-04 05:35:20 +0000 | [diff] [blame] | 1316 | if (generations[0].count > 0) { |
| 1317 | generations[0].count--; |
Neil Schemenauer | 43411b5 | 2001-08-30 00:05:51 +0000 | [diff] [blame] | 1318 | } |
Neil Schemenauer | fec4eb1 | 2002-04-12 02:41:03 +0000 | [diff] [blame] | 1319 | PyObject_FREE(g); |
Neil Schemenauer | 43411b5 | 2001-08-30 00:05:51 +0000 | [diff] [blame] | 1320 | } |
| 1321 | |
Neil Schemenauer | fec4eb1 | 2002-04-12 02:41:03 +0000 | [diff] [blame] | 1322 | /* for binary compatibility with 2.2 */ |
| 1323 | #undef _PyObject_GC_Del |
| 1324 | void |
| 1325 | _PyObject_GC_Del(PyObject *op) |
| 1326 | { |
| 1327 | PyObject_GC_Del(op); |
| 1328 | } |