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 | |
| 23 | #ifdef WITH_CYCLE_GC |
| 24 | |
Neil Schemenauer | 43411b5 | 2001-08-30 00:05:51 +0000 | [diff] [blame] | 25 | /* Get an object's GC head */ |
| 26 | #define AS_GC(o) ((PyGC_Head *)(o)-1) |
| 27 | |
| 28 | /* Get the object given the GC head */ |
| 29 | #define FROM_GC(g) ((PyObject *)(((PyGC_Head *)g)+1)) |
| 30 | |
Neil Schemenauer | a2b11ec | 2002-05-21 15:53:24 +0000 | [diff] [blame] | 31 | /* True if an object is tracked by the GC */ |
| 32 | #define IS_TRACKED(o) ((AS_GC(o))->gc.gc_next != NULL) |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 33 | |
| 34 | /*** Global GC state ***/ |
| 35 | |
Neil Schemenauer | 2880ae5 | 2002-05-04 05:35:20 +0000 | [diff] [blame] | 36 | struct gc_generation { |
| 37 | PyGC_Head head; |
| 38 | int threshold; /* collection threshold */ |
| 39 | int count; /* count of allocations or collections of younger |
| 40 | generations */ |
| 41 | }; |
| 42 | |
| 43 | #define NUM_GENERATIONS 3 |
| 44 | #define GEN_HEAD(n) (&generations[n].head) |
| 45 | |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 46 | /* linked lists of container objects */ |
Neil Schemenauer | 2880ae5 | 2002-05-04 05:35:20 +0000 | [diff] [blame] | 47 | static struct gc_generation generations[NUM_GENERATIONS] = { |
| 48 | /* PyGC_Head, threshold, count */ |
| 49 | {{{GEN_HEAD(0), GEN_HEAD(0), 0}}, 700, 0}, |
| 50 | {{{GEN_HEAD(1), GEN_HEAD(1), 0}}, 10, 0}, |
| 51 | {{{GEN_HEAD(2), GEN_HEAD(2), 0}}, 10, 0}, |
| 52 | }; |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 53 | |
Neil Schemenauer | 2880ae5 | 2002-05-04 05:35:20 +0000 | [diff] [blame] | 54 | PyGC_Head *_PyGC_generation0 = GEN_HEAD(0); |
| 55 | |
Vladimir Marangozov | f9d20c3 | 2000-08-06 22:45:31 +0000 | [diff] [blame] | 56 | static int enabled = 1; /* automatic collection enabled? */ |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 57 | |
Neil Schemenauer | 43411b5 | 2001-08-30 00:05:51 +0000 | [diff] [blame] | 58 | /* true if we are currently running the collector */ |
| 59 | static int collecting; |
| 60 | |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 61 | /* set for debugging information */ |
| 62 | #define DEBUG_STATS (1<<0) /* print collection statistics */ |
| 63 | #define DEBUG_COLLECTABLE (1<<1) /* print collectable objects */ |
| 64 | #define DEBUG_UNCOLLECTABLE (1<<2) /* print uncollectable objects */ |
| 65 | #define DEBUG_INSTANCES (1<<3) /* print instances */ |
| 66 | #define DEBUG_OBJECTS (1<<4) /* print other objects */ |
Neil Schemenauer | 544de1e | 2000-09-22 15:22:38 +0000 | [diff] [blame] | 67 | #define DEBUG_SAVEALL (1<<5) /* save all garbage in gc.garbage */ |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 68 | #define DEBUG_LEAK DEBUG_COLLECTABLE | \ |
| 69 | DEBUG_UNCOLLECTABLE | \ |
| 70 | DEBUG_INSTANCES | \ |
Neil Schemenauer | 544de1e | 2000-09-22 15:22:38 +0000 | [diff] [blame] | 71 | DEBUG_OBJECTS | \ |
| 72 | DEBUG_SAVEALL |
Jeremy Hylton | b709df3 | 2000-09-01 02:47:25 +0000 | [diff] [blame] | 73 | static int debug; |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 74 | |
Tim Peters | 8839617 | 2002-06-30 17:56:40 +0000 | [diff] [blame^] | 75 | /* When a collection begins, gc_refs is set to ob_refcnt for, and only for, |
| 76 | * the objects in the generation being collected, called the "young" |
| 77 | * generation at that point. As collection proceeds, when it's determined |
| 78 | * that one of these can't be collected (e.g., because it's reachable from |
| 79 | * outside, or has a __del__ method), the object is moved out of young, and |
| 80 | * gc_refs is set to a negative value. The latter is so we can distinguish |
| 81 | * collection candidates from non-candidates just by looking at the object. |
| 82 | */ |
| 83 | /* Special gc_refs value, although any negative value means "moved". */ |
Neil Schemenauer | 43411b5 | 2001-08-30 00:05:51 +0000 | [diff] [blame] | 84 | #define GC_MOVED -123 |
| 85 | |
Tim Peters | 8839617 | 2002-06-30 17:56:40 +0000 | [diff] [blame^] | 86 | /* True iff an object is still a candidate for collection. */ |
| 87 | #define STILL_A_CANDIDATE(o) ((AS_GC(o))->gc.gc_refs >= 0) |
Neil Schemenauer | a2b11ec | 2002-05-21 15:53:24 +0000 | [diff] [blame] | 88 | |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 89 | /* list of uncollectable objects */ |
| 90 | static PyObject *garbage; |
| 91 | |
Jeremy Hylton | b709df3 | 2000-09-01 02:47:25 +0000 | [diff] [blame] | 92 | /* Python string to use if unhandled exception occurs */ |
| 93 | static PyObject *gc_str; |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 94 | |
| 95 | /*** list functions ***/ |
| 96 | |
| 97 | static void |
| 98 | gc_list_init(PyGC_Head *list) |
| 99 | { |
Tim Peters | 9e4ca10 | 2001-10-11 18:31:31 +0000 | [diff] [blame] | 100 | list->gc.gc_prev = list; |
| 101 | list->gc.gc_next = list; |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 102 | } |
| 103 | |
Neil Schemenauer | 2880ae5 | 2002-05-04 05:35:20 +0000 | [diff] [blame] | 104 | static int |
| 105 | gc_list_is_empty(PyGC_Head *list) |
| 106 | { |
| 107 | return (list->gc.gc_next == list); |
| 108 | } |
| 109 | |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 110 | static void |
| 111 | gc_list_append(PyGC_Head *node, PyGC_Head *list) |
| 112 | { |
Tim Peters | 9e4ca10 | 2001-10-11 18:31:31 +0000 | [diff] [blame] | 113 | node->gc.gc_next = list; |
| 114 | node->gc.gc_prev = list->gc.gc_prev; |
| 115 | node->gc.gc_prev->gc.gc_next = node; |
| 116 | list->gc.gc_prev = node; |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 117 | } |
| 118 | |
| 119 | static void |
| 120 | gc_list_remove(PyGC_Head *node) |
| 121 | { |
Tim Peters | 9e4ca10 | 2001-10-11 18:31:31 +0000 | [diff] [blame] | 122 | node->gc.gc_prev->gc.gc_next = node->gc.gc_next; |
| 123 | node->gc.gc_next->gc.gc_prev = node->gc.gc_prev; |
| 124 | node->gc.gc_next = NULL; /* object is not currently tracked */ |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 125 | } |
| 126 | |
Tim Peters | 8839617 | 2002-06-30 17:56:40 +0000 | [diff] [blame^] | 127 | static void |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 128 | gc_list_move(PyGC_Head *from, PyGC_Head *to) |
| 129 | { |
Neil Schemenauer | 2880ae5 | 2002-05-04 05:35:20 +0000 | [diff] [blame] | 130 | if (gc_list_is_empty(from)) { |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 131 | gc_list_init(to); |
Neil Schemenauer | 544de1e | 2000-09-22 15:22:38 +0000 | [diff] [blame] | 132 | } |
| 133 | else { |
Tim Peters | 9e4ca10 | 2001-10-11 18:31:31 +0000 | [diff] [blame] | 134 | to->gc.gc_next = from->gc.gc_next; |
| 135 | to->gc.gc_next->gc.gc_prev = to; |
| 136 | to->gc.gc_prev = from->gc.gc_prev; |
| 137 | to->gc.gc_prev->gc.gc_next = to; |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 138 | } |
| 139 | gc_list_init(from); |
| 140 | } |
| 141 | |
| 142 | /* append a list onto another list, from becomes an empty list */ |
| 143 | static void |
| 144 | gc_list_merge(PyGC_Head *from, PyGC_Head *to) |
| 145 | { |
| 146 | PyGC_Head *tail; |
Neil Schemenauer | 2880ae5 | 2002-05-04 05:35:20 +0000 | [diff] [blame] | 147 | if (!gc_list_is_empty(from)) { |
Tim Peters | 9e4ca10 | 2001-10-11 18:31:31 +0000 | [diff] [blame] | 148 | tail = to->gc.gc_prev; |
| 149 | tail->gc.gc_next = from->gc.gc_next; |
| 150 | tail->gc.gc_next->gc.gc_prev = tail; |
| 151 | to->gc.gc_prev = from->gc.gc_prev; |
| 152 | to->gc.gc_prev->gc.gc_next = to; |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 153 | } |
| 154 | gc_list_init(from); |
| 155 | } |
| 156 | |
| 157 | static long |
| 158 | gc_list_size(PyGC_Head *list) |
| 159 | { |
| 160 | PyGC_Head *gc; |
| 161 | long n = 0; |
Tim Peters | 9e4ca10 | 2001-10-11 18:31:31 +0000 | [diff] [blame] | 162 | 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] | 163 | n++; |
| 164 | } |
| 165 | return n; |
| 166 | } |
| 167 | |
| 168 | /*** end of list stuff ***/ |
| 169 | |
| 170 | |
Neil Schemenauer | 43411b5 | 2001-08-30 00:05:51 +0000 | [diff] [blame] | 171 | |
Tim Peters | 8839617 | 2002-06-30 17:56:40 +0000 | [diff] [blame^] | 172 | /* Set all gc_refs = ob_refcnt. After this, STILL_A_CANDIDATE(o) is true |
| 173 | * for all objects in containers, and false for all tracked gc objects not |
| 174 | * in containers (although see the comment in visit_decref). |
| 175 | */ |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 176 | static void |
| 177 | update_refs(PyGC_Head *containers) |
| 178 | { |
Tim Peters | 9e4ca10 | 2001-10-11 18:31:31 +0000 | [diff] [blame] | 179 | PyGC_Head *gc = containers->gc.gc_next; |
| 180 | for (; gc != containers; gc=gc->gc.gc_next) { |
| 181 | gc->gc.gc_refs = FROM_GC(gc)->ob_refcnt; |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 182 | } |
| 183 | } |
| 184 | |
| 185 | static int |
| 186 | visit_decref(PyObject *op, void *data) |
| 187 | { |
Tim Peters | 8839617 | 2002-06-30 17:56:40 +0000 | [diff] [blame^] | 188 | /* There's no point to decrementing gc_refs unless |
| 189 | * STILL_A_CANDIDATE(op) is true. It would take extra cycles to |
| 190 | * check that, though. If STILL_A_CANDIDATE(op) is false, |
| 191 | * decrementing gc_refs almost always makes it "even more negative", |
| 192 | * so doesn't change that STILL_A_CANDIDATE is false, and no harm is |
| 193 | * done. However, it's possible that, after many collections, this |
| 194 | * could underflow gc_refs in a long-lived old object. In that case, |
| 195 | * visit_move() may move the old object back to the generation |
| 196 | * getting collected. That would be a waste of time, but wouldn't |
| 197 | * cause an error. |
| 198 | */ |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 199 | if (op && PyObject_IS_GC(op)) { |
Tim Peters | 8839617 | 2002-06-30 17:56:40 +0000 | [diff] [blame^] | 200 | if (IS_TRACKED(op)) { |
Tim Peters | 9e4ca10 | 2001-10-11 18:31:31 +0000 | [diff] [blame] | 201 | AS_GC(op)->gc.gc_refs--; |
Tim Peters | 8839617 | 2002-06-30 17:56:40 +0000 | [diff] [blame^] | 202 | } |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 203 | } |
| 204 | return 0; |
| 205 | } |
| 206 | |
| 207 | /* Subtract internal references from gc_refs */ |
| 208 | static void |
| 209 | subtract_refs(PyGC_Head *containers) |
| 210 | { |
| 211 | traverseproc traverse; |
Tim Peters | 9e4ca10 | 2001-10-11 18:31:31 +0000 | [diff] [blame] | 212 | PyGC_Head *gc = containers->gc.gc_next; |
| 213 | for (; gc != containers; gc=gc->gc.gc_next) { |
Neil Schemenauer | 43411b5 | 2001-08-30 00:05:51 +0000 | [diff] [blame] | 214 | traverse = FROM_GC(gc)->ob_type->tp_traverse; |
| 215 | (void) traverse(FROM_GC(gc), |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 216 | (visitproc)visit_decref, |
| 217 | NULL); |
| 218 | } |
| 219 | } |
| 220 | |
Tim Peters | 8839617 | 2002-06-30 17:56:40 +0000 | [diff] [blame^] | 221 | /* Move objects with gc_refs > 0 to roots list. They can't be collected. */ |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 222 | static void |
| 223 | move_roots(PyGC_Head *containers, PyGC_Head *roots) |
| 224 | { |
| 225 | PyGC_Head *next; |
Tim Peters | 9e4ca10 | 2001-10-11 18:31:31 +0000 | [diff] [blame] | 226 | PyGC_Head *gc = containers->gc.gc_next; |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 227 | while (gc != containers) { |
Tim Peters | 9e4ca10 | 2001-10-11 18:31:31 +0000 | [diff] [blame] | 228 | next = gc->gc.gc_next; |
| 229 | if (gc->gc.gc_refs > 0) { |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 230 | gc_list_remove(gc); |
| 231 | gc_list_append(gc, roots); |
Tim Peters | 9e4ca10 | 2001-10-11 18:31:31 +0000 | [diff] [blame] | 232 | gc->gc.gc_refs = GC_MOVED; |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 233 | } |
| 234 | gc = next; |
| 235 | } |
| 236 | } |
| 237 | |
| 238 | static int |
Neil Schemenauer | 43411b5 | 2001-08-30 00:05:51 +0000 | [diff] [blame] | 239 | visit_move(PyObject *op, PyGC_Head *tolist) |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 240 | { |
| 241 | if (PyObject_IS_GC(op)) { |
Tim Peters | 8839617 | 2002-06-30 17:56:40 +0000 | [diff] [blame^] | 242 | if (IS_TRACKED(op) && STILL_A_CANDIDATE(op)) { |
Neil Schemenauer | a2b11ec | 2002-05-21 15:53:24 +0000 | [diff] [blame] | 243 | PyGC_Head *gc = AS_GC(op); |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 244 | gc_list_remove(gc); |
Neil Schemenauer | 43411b5 | 2001-08-30 00:05:51 +0000 | [diff] [blame] | 245 | gc_list_append(gc, tolist); |
Tim Peters | 9e4ca10 | 2001-10-11 18:31:31 +0000 | [diff] [blame] | 246 | gc->gc.gc_refs = GC_MOVED; |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 247 | } |
| 248 | } |
| 249 | return 0; |
| 250 | } |
| 251 | |
Tim Peters | 8839617 | 2002-06-30 17:56:40 +0000 | [diff] [blame^] | 252 | /* Move candidates referenced from reachable to reachable set (they're no |
| 253 | * longer candidates). |
| 254 | */ |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 255 | static void |
| 256 | move_root_reachable(PyGC_Head *reachable) |
| 257 | { |
| 258 | traverseproc traverse; |
Tim Peters | 9e4ca10 | 2001-10-11 18:31:31 +0000 | [diff] [blame] | 259 | PyGC_Head *gc = reachable->gc.gc_next; |
| 260 | for (; gc != reachable; gc=gc->gc.gc_next) { |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 261 | /* careful, reachable list is growing here */ |
Neil Schemenauer | 43411b5 | 2001-08-30 00:05:51 +0000 | [diff] [blame] | 262 | PyObject *op = FROM_GC(gc); |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 263 | traverse = op->ob_type->tp_traverse; |
| 264 | (void) traverse(op, |
Neil Schemenauer | 43411b5 | 2001-08-30 00:05:51 +0000 | [diff] [blame] | 265 | (visitproc)visit_move, |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 266 | (void *)reachable); |
| 267 | } |
| 268 | } |
| 269 | |
Tim Peters | 8839617 | 2002-06-30 17:56:40 +0000 | [diff] [blame^] | 270 | /* return true if object has a finalization method */ |
Neil Schemenauer | a765c12 | 2001-11-01 17:35:23 +0000 | [diff] [blame] | 271 | static int |
| 272 | has_finalizer(PyObject *op) |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 273 | { |
Jeremy Hylton | 0625777 | 2000-08-31 15:10:24 +0000 | [diff] [blame] | 274 | static PyObject *delstr = NULL; |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 275 | if (delstr == NULL) { |
| 276 | delstr = PyString_InternFromString("__del__"); |
Jeremy Hylton | 0625777 | 2000-08-31 15:10:24 +0000 | [diff] [blame] | 277 | if (delstr == NULL) |
| 278 | Py_FatalError("PyGC: can't initialize __del__ string"); |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 279 | } |
Tim Peters | db86561 | 2001-11-01 19:35:45 +0000 | [diff] [blame] | 280 | return (PyInstance_Check(op) || |
| 281 | PyType_HasFeature(op->ob_type, Py_TPFLAGS_HEAPTYPE)) |
| 282 | && PyObject_HasAttr(op, delstr); |
Neil Schemenauer | a765c12 | 2001-11-01 17:35:23 +0000 | [diff] [blame] | 283 | } |
| 284 | |
| 285 | /* Move all objects with finalizers (instances with __del__) */ |
| 286 | static void |
| 287 | move_finalizers(PyGC_Head *unreachable, PyGC_Head *finalizers) |
| 288 | { |
| 289 | PyGC_Head *next; |
| 290 | PyGC_Head *gc = unreachable->gc.gc_next; |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 291 | for (; gc != unreachable; gc=next) { |
Neil Schemenauer | 43411b5 | 2001-08-30 00:05:51 +0000 | [diff] [blame] | 292 | PyObject *op = FROM_GC(gc); |
Tim Peters | 9e4ca10 | 2001-10-11 18:31:31 +0000 | [diff] [blame] | 293 | next = gc->gc.gc_next; |
Neil Schemenauer | a765c12 | 2001-11-01 17:35:23 +0000 | [diff] [blame] | 294 | if (has_finalizer(op)) { |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 295 | gc_list_remove(gc); |
| 296 | gc_list_append(gc, finalizers); |
Tim Peters | 8839617 | 2002-06-30 17:56:40 +0000 | [diff] [blame^] | 297 | gc->gc.gc_refs = GC_MOVED; |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 298 | } |
| 299 | } |
| 300 | } |
| 301 | |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 302 | /* Move objects referenced from roots to roots */ |
| 303 | static void |
| 304 | move_finalizer_reachable(PyGC_Head *finalizers) |
| 305 | { |
| 306 | traverseproc traverse; |
Tim Peters | 9e4ca10 | 2001-10-11 18:31:31 +0000 | [diff] [blame] | 307 | PyGC_Head *gc = finalizers->gc.gc_next; |
| 308 | for (; gc != finalizers; gc=gc->gc.gc_next) { |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 309 | /* careful, finalizers list is growing here */ |
Neil Schemenauer | 43411b5 | 2001-08-30 00:05:51 +0000 | [diff] [blame] | 310 | traverse = FROM_GC(gc)->ob_type->tp_traverse; |
Tim Peters | 8839617 | 2002-06-30 17:56:40 +0000 | [diff] [blame^] | 311 | (void) traverse(FROM_GC(gc), |
Neil Schemenauer | 43411b5 | 2001-08-30 00:05:51 +0000 | [diff] [blame] | 312 | (visitproc)visit_move, |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 313 | (void *)finalizers); |
| 314 | } |
| 315 | } |
| 316 | |
| 317 | static void |
Jeremy Hylton | 0625777 | 2000-08-31 15:10:24 +0000 | [diff] [blame] | 318 | debug_instance(char *msg, PyInstanceObject *inst) |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 319 | { |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 320 | char *cname; |
Neil Schemenauer | a765c12 | 2001-11-01 17:35:23 +0000 | [diff] [blame] | 321 | /* simple version of instance_repr */ |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 322 | PyObject *classname = inst->in_class->cl_name; |
| 323 | if (classname != NULL && PyString_Check(classname)) |
| 324 | cname = PyString_AsString(classname); |
| 325 | else |
| 326 | cname = "?"; |
Jeremy Hylton | 0625777 | 2000-08-31 15:10:24 +0000 | [diff] [blame] | 327 | PySys_WriteStderr("gc: %.100s <%.100s instance at %p>\n", |
| 328 | msg, cname, inst); |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 329 | } |
| 330 | |
| 331 | static void |
Jeremy Hylton | 0625777 | 2000-08-31 15:10:24 +0000 | [diff] [blame] | 332 | debug_cycle(char *msg, PyObject *op) |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 333 | { |
| 334 | if ((debug & DEBUG_INSTANCES) && PyInstance_Check(op)) { |
Jeremy Hylton | 0625777 | 2000-08-31 15:10:24 +0000 | [diff] [blame] | 335 | debug_instance(msg, (PyInstanceObject *)op); |
Neil Schemenauer | 544de1e | 2000-09-22 15:22:38 +0000 | [diff] [blame] | 336 | } |
| 337 | else if (debug & DEBUG_OBJECTS) { |
Jeremy Hylton | 0625777 | 2000-08-31 15:10:24 +0000 | [diff] [blame] | 338 | PySys_WriteStderr("gc: %.100s <%.100s %p>\n", |
| 339 | msg, op->ob_type->tp_name, op); |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 340 | } |
| 341 | } |
| 342 | |
| 343 | /* Handle uncollectable garbage (cycles with finalizers). */ |
| 344 | static void |
| 345 | handle_finalizers(PyGC_Head *finalizers, PyGC_Head *old) |
| 346 | { |
| 347 | PyGC_Head *gc; |
| 348 | if (garbage == NULL) { |
| 349 | garbage = PyList_New(0); |
| 350 | } |
Tim Peters | 9e4ca10 | 2001-10-11 18:31:31 +0000 | [diff] [blame] | 351 | for (gc = finalizers->gc.gc_next; gc != finalizers; |
| 352 | gc = finalizers->gc.gc_next) { |
Neil Schemenauer | 43411b5 | 2001-08-30 00:05:51 +0000 | [diff] [blame] | 353 | PyObject *op = FROM_GC(gc); |
Neil Schemenauer | a765c12 | 2001-11-01 17:35:23 +0000 | [diff] [blame] | 354 | if ((debug & DEBUG_SAVEALL) || has_finalizer(op)) { |
| 355 | /* If SAVEALL is not set then just append objects with |
| 356 | * finalizers to the list of garbage. All objects in |
| 357 | * the finalizers list are reachable from those |
| 358 | * objects. */ |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 359 | PyList_Append(garbage, op); |
| 360 | } |
Tim Peters | 8839617 | 2002-06-30 17:56:40 +0000 | [diff] [blame^] | 361 | /* object is now reachable again */ |
| 362 | assert(!STILL_A_CANDIDATE(op)); |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 363 | gc_list_remove(gc); |
| 364 | gc_list_append(gc, old); |
| 365 | } |
| 366 | } |
| 367 | |
Neil Schemenauer | 544de1e | 2000-09-22 15:22:38 +0000 | [diff] [blame] | 368 | /* Break reference cycles by clearing the containers involved. This is |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 369 | * tricky business as the lists can be changing and we don't know which |
| 370 | * objects may be freed. It is possible I screwed something up here. */ |
| 371 | static void |
| 372 | delete_garbage(PyGC_Head *unreachable, PyGC_Head *old) |
| 373 | { |
| 374 | inquiry clear; |
| 375 | |
Neil Schemenauer | 2880ae5 | 2002-05-04 05:35:20 +0000 | [diff] [blame] | 376 | while (!gc_list_is_empty(unreachable)) { |
Tim Peters | 9e4ca10 | 2001-10-11 18:31:31 +0000 | [diff] [blame] | 377 | PyGC_Head *gc = unreachable->gc.gc_next; |
Neil Schemenauer | 43411b5 | 2001-08-30 00:05:51 +0000 | [diff] [blame] | 378 | PyObject *op = FROM_GC(gc); |
Tim Peters | 8839617 | 2002-06-30 17:56:40 +0000 | [diff] [blame^] | 379 | |
| 380 | assert(STILL_A_CANDIDATE(op)); |
Neil Schemenauer | 544de1e | 2000-09-22 15:22:38 +0000 | [diff] [blame] | 381 | if (debug & DEBUG_SAVEALL) { |
| 382 | PyList_Append(garbage, op); |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 383 | } |
Neil Schemenauer | 544de1e | 2000-09-22 15:22:38 +0000 | [diff] [blame] | 384 | else { |
| 385 | if ((clear = op->ob_type->tp_clear) != NULL) { |
| 386 | Py_INCREF(op); |
Jeremy Hylton | 8a13518 | 2002-06-06 23:23:55 +0000 | [diff] [blame] | 387 | clear(op); |
Neil Schemenauer | 544de1e | 2000-09-22 15:22:38 +0000 | [diff] [blame] | 388 | Py_DECREF(op); |
| 389 | } |
| 390 | } |
Tim Peters | 9e4ca10 | 2001-10-11 18:31:31 +0000 | [diff] [blame] | 391 | if (unreachable->gc.gc_next == gc) { |
Neil Schemenauer | 544de1e | 2000-09-22 15:22:38 +0000 | [diff] [blame] | 392 | /* object is still alive, move it, it may die later */ |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 393 | gc_list_remove(gc); |
| 394 | gc_list_append(gc, old); |
Tim Peters | 8839617 | 2002-06-30 17:56:40 +0000 | [diff] [blame^] | 395 | gc->gc.gc_refs = GC_MOVED; |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 396 | } |
| 397 | } |
| 398 | } |
| 399 | |
| 400 | /* This is the main function. Read this to understand how the |
| 401 | * collection process works. */ |
| 402 | static long |
Neil Schemenauer | 2880ae5 | 2002-05-04 05:35:20 +0000 | [diff] [blame] | 403 | collect(int generation) |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 404 | { |
Neil Schemenauer | 2880ae5 | 2002-05-04 05:35:20 +0000 | [diff] [blame] | 405 | int i; |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 406 | long n = 0; |
| 407 | long m = 0; |
Neil Schemenauer | 2880ae5 | 2002-05-04 05:35:20 +0000 | [diff] [blame] | 408 | PyGC_Head *young; /* the generation we are examining */ |
| 409 | PyGC_Head *old; /* next older generation */ |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 410 | PyGC_Head reachable; |
| 411 | PyGC_Head unreachable; |
| 412 | PyGC_Head finalizers; |
| 413 | PyGC_Head *gc; |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 414 | |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 415 | if (debug & DEBUG_STATS) { |
Neil Schemenauer | 2880ae5 | 2002-05-04 05:35:20 +0000 | [diff] [blame] | 416 | PySys_WriteStderr("gc: collecting generation %d...\n", |
| 417 | generation); |
| 418 | PySys_WriteStderr("gc: objects in each generation:"); |
| 419 | for (i = 0; i < NUM_GENERATIONS; i++) { |
| 420 | PySys_WriteStderr(" %ld", gc_list_size(GEN_HEAD(i))); |
| 421 | } |
| 422 | PySys_WriteStderr("\n"); |
| 423 | } |
| 424 | |
| 425 | /* update collection and allocation counters */ |
| 426 | if (generation+1 < NUM_GENERATIONS) |
| 427 | generations[generation+1].count += 1; |
| 428 | for (i = 0; i <= generation; i++) |
Neil Schemenauer | c905164 | 2002-06-28 19:16:04 +0000 | [diff] [blame] | 429 | generations[i].count = 0; |
Neil Schemenauer | 2880ae5 | 2002-05-04 05:35:20 +0000 | [diff] [blame] | 430 | |
| 431 | /* merge younger generations with one we are currently collecting */ |
| 432 | for (i = 0; i < generation; i++) { |
| 433 | gc_list_merge(GEN_HEAD(i), GEN_HEAD(generation)); |
| 434 | } |
| 435 | |
| 436 | /* handy references */ |
| 437 | young = GEN_HEAD(generation); |
| 438 | if (generation < NUM_GENERATIONS-1) { |
| 439 | old = GEN_HEAD(generation+1); |
| 440 | } else { |
| 441 | old = GEN_HEAD(NUM_GENERATIONS-1); |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 442 | } |
| 443 | |
| 444 | /* Using ob_refcnt and gc_refs, calculate which objects in the |
| 445 | * container set are reachable from outside the set (ie. have a |
| 446 | * refcount greater than 0 when all the references within the |
| 447 | * set are taken into account */ |
| 448 | update_refs(young); |
| 449 | subtract_refs(young); |
| 450 | |
| 451 | /* Move everything reachable from outside the set into the |
| 452 | * reachable set (ie. gc_refs > 0). Next, move everything |
| 453 | * reachable from objects in the reachable set. */ |
| 454 | gc_list_init(&reachable); |
| 455 | move_roots(young, &reachable); |
| 456 | move_root_reachable(&reachable); |
| 457 | |
| 458 | /* move unreachable objects to a temporary list, new objects can be |
| 459 | * allocated after this point */ |
| 460 | gc_list_init(&unreachable); |
| 461 | gc_list_move(young, &unreachable); |
| 462 | |
| 463 | /* move reachable objects to next generation */ |
| 464 | gc_list_merge(&reachable, old); |
| 465 | |
| 466 | /* Move objects reachable from finalizers, we can't safely delete |
| 467 | * them. Python programmers should take care not to create such |
| 468 | * things. For Python finalizers means instance objects with |
| 469 | * __del__ methods. */ |
| 470 | gc_list_init(&finalizers); |
| 471 | move_finalizers(&unreachable, &finalizers); |
| 472 | move_finalizer_reachable(&finalizers); |
| 473 | |
| 474 | /* Collect statistics on collectable objects found and print |
| 475 | * debugging information. */ |
Tim Peters | 9e4ca10 | 2001-10-11 18:31:31 +0000 | [diff] [blame] | 476 | for (gc = unreachable.gc.gc_next; gc != &unreachable; |
| 477 | gc = gc->gc.gc_next) { |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 478 | m++; |
Jeremy Hylton | 0625777 | 2000-08-31 15:10:24 +0000 | [diff] [blame] | 479 | if (debug & DEBUG_COLLECTABLE) { |
Neil Schemenauer | 43411b5 | 2001-08-30 00:05:51 +0000 | [diff] [blame] | 480 | debug_cycle("collectable", FROM_GC(gc)); |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 481 | } |
| 482 | } |
| 483 | /* call tp_clear on objects in the collectable set. This will cause |
| 484 | * the reference cycles to be broken. It may also cause some objects in |
| 485 | * finalizers to be freed */ |
| 486 | delete_garbage(&unreachable, old); |
| 487 | |
| 488 | /* Collect statistics on uncollectable objects found and print |
| 489 | * debugging information. */ |
Tim Peters | 9e4ca10 | 2001-10-11 18:31:31 +0000 | [diff] [blame] | 490 | for (gc = finalizers.gc.gc_next; gc != &finalizers; |
| 491 | gc = gc->gc.gc_next) { |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 492 | n++; |
Jeremy Hylton | 0625777 | 2000-08-31 15:10:24 +0000 | [diff] [blame] | 493 | if (debug & DEBUG_UNCOLLECTABLE) { |
Neil Schemenauer | 43411b5 | 2001-08-30 00:05:51 +0000 | [diff] [blame] | 494 | debug_cycle("uncollectable", FROM_GC(gc)); |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 495 | } |
| 496 | } |
Jeremy Hylton | 0625777 | 2000-08-31 15:10:24 +0000 | [diff] [blame] | 497 | if (debug & DEBUG_STATS) { |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 498 | if (m == 0 && n == 0) { |
Jeremy Hylton | 0625777 | 2000-08-31 15:10:24 +0000 | [diff] [blame] | 499 | PySys_WriteStderr("gc: done.\n"); |
Neil Schemenauer | 544de1e | 2000-09-22 15:22:38 +0000 | [diff] [blame] | 500 | } |
| 501 | else { |
Jeremy Hylton | 0625777 | 2000-08-31 15:10:24 +0000 | [diff] [blame] | 502 | PySys_WriteStderr( |
| 503 | "gc: done, %ld unreachable, %ld uncollectable.\n", |
| 504 | n+m, n); |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 505 | } |
| 506 | } |
| 507 | |
| 508 | /* Append instances in the uncollectable set to a Python |
| 509 | * reachable list of garbage. The programmer has to deal with |
| 510 | * this if they insist on creating this type of structure. */ |
| 511 | handle_finalizers(&finalizers, old); |
| 512 | |
Jeremy Hylton | b709df3 | 2000-09-01 02:47:25 +0000 | [diff] [blame] | 513 | if (PyErr_Occurred()) { |
Neil Schemenauer | 544de1e | 2000-09-22 15:22:38 +0000 | [diff] [blame] | 514 | if (gc_str == NULL) { |
| 515 | gc_str = PyString_FromString("garbage collection"); |
| 516 | } |
Jeremy Hylton | b709df3 | 2000-09-01 02:47:25 +0000 | [diff] [blame] | 517 | PyErr_WriteUnraisable(gc_str); |
| 518 | Py_FatalError("unexpected exception during garbage collection"); |
| 519 | } |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 520 | return n+m; |
| 521 | } |
| 522 | |
| 523 | static long |
| 524 | collect_generations(void) |
| 525 | { |
Neil Schemenauer | 2880ae5 | 2002-05-04 05:35:20 +0000 | [diff] [blame] | 526 | int i; |
Vladimir Marangozov | b16714b | 2000-07-10 05:37:39 +0000 | [diff] [blame] | 527 | long n = 0; |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 528 | |
Neil Schemenauer | 2880ae5 | 2002-05-04 05:35:20 +0000 | [diff] [blame] | 529 | /* Find the oldest generation (higest numbered) where the count |
| 530 | * exceeds the threshold. Objects in the that generation and |
| 531 | * generations younger than it will be collected. */ |
| 532 | for (i = NUM_GENERATIONS-1; i >= 0; i--) { |
| 533 | if (generations[i].count > generations[i].threshold) { |
| 534 | n = collect(i); |
| 535 | break; |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 536 | } |
| 537 | } |
| 538 | return n; |
| 539 | } |
| 540 | |
Martin v. Löwis | 14f8b4c | 2002-06-13 20:33:02 +0000 | [diff] [blame] | 541 | PyDoc_STRVAR(gc_enable__doc__, |
Vladimir Marangozov | f9d20c3 | 2000-08-06 22:45:31 +0000 | [diff] [blame] | 542 | "enable() -> None\n" |
| 543 | "\n" |
Martin v. Löwis | 14f8b4c | 2002-06-13 20:33:02 +0000 | [diff] [blame] | 544 | "Enable automatic garbage collection.\n"); |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 545 | |
Vladimir Marangozov | f9d20c3 | 2000-08-06 22:45:31 +0000 | [diff] [blame] | 546 | static PyObject * |
| 547 | gc_enable(PyObject *self, PyObject *args) |
| 548 | { |
| 549 | |
| 550 | if (!PyArg_ParseTuple(args, ":enable")) /* check no args */ |
| 551 | return NULL; |
| 552 | |
| 553 | enabled = 1; |
| 554 | |
| 555 | Py_INCREF(Py_None); |
| 556 | return Py_None; |
| 557 | } |
| 558 | |
Martin v. Löwis | 14f8b4c | 2002-06-13 20:33:02 +0000 | [diff] [blame] | 559 | PyDoc_STRVAR(gc_disable__doc__, |
Vladimir Marangozov | f9d20c3 | 2000-08-06 22:45:31 +0000 | [diff] [blame] | 560 | "disable() -> None\n" |
| 561 | "\n" |
Martin v. Löwis | 14f8b4c | 2002-06-13 20:33:02 +0000 | [diff] [blame] | 562 | "Disable automatic garbage collection.\n"); |
Vladimir Marangozov | f9d20c3 | 2000-08-06 22:45:31 +0000 | [diff] [blame] | 563 | |
| 564 | static PyObject * |
| 565 | gc_disable(PyObject *self, PyObject *args) |
| 566 | { |
| 567 | |
| 568 | if (!PyArg_ParseTuple(args, ":disable")) /* check no args */ |
| 569 | return NULL; |
| 570 | |
| 571 | enabled = 0; |
| 572 | |
| 573 | Py_INCREF(Py_None); |
| 574 | return Py_None; |
| 575 | } |
| 576 | |
Martin v. Löwis | 14f8b4c | 2002-06-13 20:33:02 +0000 | [diff] [blame] | 577 | PyDoc_STRVAR(gc_isenabled__doc__, |
Vladimir Marangozov | f9d20c3 | 2000-08-06 22:45:31 +0000 | [diff] [blame] | 578 | "isenabled() -> status\n" |
| 579 | "\n" |
Martin v. Löwis | 14f8b4c | 2002-06-13 20:33:02 +0000 | [diff] [blame] | 580 | "Returns true if automatic garbage collection is enabled.\n"); |
Vladimir Marangozov | f9d20c3 | 2000-08-06 22:45:31 +0000 | [diff] [blame] | 581 | |
| 582 | static PyObject * |
| 583 | gc_isenabled(PyObject *self, PyObject *args) |
| 584 | { |
| 585 | |
| 586 | if (!PyArg_ParseTuple(args, ":isenabled")) /* check no args */ |
| 587 | return NULL; |
| 588 | |
| 589 | return Py_BuildValue("i", enabled); |
| 590 | } |
| 591 | |
Martin v. Löwis | 14f8b4c | 2002-06-13 20:33:02 +0000 | [diff] [blame] | 592 | PyDoc_STRVAR(gc_collect__doc__, |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 593 | "collect() -> n\n" |
| 594 | "\n" |
Martin v. Löwis | 14f8b4c | 2002-06-13 20:33:02 +0000 | [diff] [blame] | 595 | "Run a full collection. The number of unreachable objects is returned.\n"); |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 596 | |
| 597 | static PyObject * |
Vladimir Marangozov | f9d20c3 | 2000-08-06 22:45:31 +0000 | [diff] [blame] | 598 | gc_collect(PyObject *self, PyObject *args) |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 599 | { |
| 600 | long n; |
| 601 | |
Fred Drake | cc1be24 | 2000-07-12 04:42:23 +0000 | [diff] [blame] | 602 | if (!PyArg_ParseTuple(args, ":collect")) /* check no args */ |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 603 | return NULL; |
| 604 | |
Neil Schemenauer | e8c40cb | 2001-10-31 23:09:35 +0000 | [diff] [blame] | 605 | if (collecting) { |
| 606 | n = 0; /* already collecting, don't do anything */ |
| 607 | } |
| 608 | else { |
| 609 | collecting = 1; |
Neil Schemenauer | 2880ae5 | 2002-05-04 05:35:20 +0000 | [diff] [blame] | 610 | n = collect(NUM_GENERATIONS - 1); |
Neil Schemenauer | e8c40cb | 2001-10-31 23:09:35 +0000 | [diff] [blame] | 611 | collecting = 0; |
| 612 | } |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 613 | |
Neil Schemenauer | 7760cff | 2000-09-22 22:35:36 +0000 | [diff] [blame] | 614 | return Py_BuildValue("l", n); |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 615 | } |
| 616 | |
Martin v. Löwis | 14f8b4c | 2002-06-13 20:33:02 +0000 | [diff] [blame] | 617 | PyDoc_STRVAR(gc_set_debug__doc__, |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 618 | "set_debug(flags) -> None\n" |
| 619 | "\n" |
| 620 | "Set the garbage collection debugging flags. Debugging information is\n" |
| 621 | "written to sys.stderr.\n" |
| 622 | "\n" |
| 623 | "flags is an integer and can have the following bits turned on:\n" |
| 624 | "\n" |
| 625 | " DEBUG_STATS - Print statistics during collection.\n" |
| 626 | " DEBUG_COLLECTABLE - Print collectable objects found.\n" |
| 627 | " DEBUG_UNCOLLECTABLE - Print unreachable but uncollectable objects found.\n" |
| 628 | " DEBUG_INSTANCES - Print instance objects.\n" |
| 629 | " DEBUG_OBJECTS - Print objects other than instances.\n" |
Neil Schemenauer | 544de1e | 2000-09-22 15:22:38 +0000 | [diff] [blame] | 630 | " 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] | 631 | " DEBUG_LEAK - Debug leaking programs (everything but STATS).\n"); |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 632 | |
| 633 | static PyObject * |
Vladimir Marangozov | f9d20c3 | 2000-08-06 22:45:31 +0000 | [diff] [blame] | 634 | gc_set_debug(PyObject *self, PyObject *args) |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 635 | { |
Neil Schemenauer | 7760cff | 2000-09-22 22:35:36 +0000 | [diff] [blame] | 636 | if (!PyArg_ParseTuple(args, "i:set_debug", &debug)) |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 637 | return NULL; |
| 638 | |
| 639 | Py_INCREF(Py_None); |
| 640 | return Py_None; |
| 641 | } |
| 642 | |
Martin v. Löwis | 14f8b4c | 2002-06-13 20:33:02 +0000 | [diff] [blame] | 643 | PyDoc_STRVAR(gc_get_debug__doc__, |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 644 | "get_debug() -> flags\n" |
| 645 | "\n" |
Martin v. Löwis | 14f8b4c | 2002-06-13 20:33:02 +0000 | [diff] [blame] | 646 | "Get the garbage collection debugging flags.\n"); |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 647 | |
| 648 | static PyObject * |
Vladimir Marangozov | f9d20c3 | 2000-08-06 22:45:31 +0000 | [diff] [blame] | 649 | gc_get_debug(PyObject *self, PyObject *args) |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 650 | { |
Fred Drake | cc1be24 | 2000-07-12 04:42:23 +0000 | [diff] [blame] | 651 | if (!PyArg_ParseTuple(args, ":get_debug")) /* no args */ |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 652 | return NULL; |
| 653 | |
| 654 | return Py_BuildValue("i", debug); |
| 655 | } |
| 656 | |
Martin v. Löwis | 14f8b4c | 2002-06-13 20:33:02 +0000 | [diff] [blame] | 657 | PyDoc_STRVAR(gc_set_thresh__doc__, |
Neal Norwitz | 2a47c0f | 2002-01-29 00:53:41 +0000 | [diff] [blame] | 658 | "set_threshold(threshold0, [threshold1, threshold2]) -> None\n" |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 659 | "\n" |
| 660 | "Sets the collection thresholds. Setting threshold0 to zero disables\n" |
Martin v. Löwis | 14f8b4c | 2002-06-13 20:33:02 +0000 | [diff] [blame] | 661 | "collection.\n"); |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 662 | |
| 663 | static PyObject * |
Vladimir Marangozov | f9d20c3 | 2000-08-06 22:45:31 +0000 | [diff] [blame] | 664 | gc_set_thresh(PyObject *self, PyObject *args) |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 665 | { |
Neil Schemenauer | 2880ae5 | 2002-05-04 05:35:20 +0000 | [diff] [blame] | 666 | int i; |
| 667 | if (!PyArg_ParseTuple(args, "i|ii:set_threshold", |
| 668 | &generations[0].threshold, |
| 669 | &generations[1].threshold, |
| 670 | &generations[2].threshold)) |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 671 | return NULL; |
Neil Schemenauer | 2880ae5 | 2002-05-04 05:35:20 +0000 | [diff] [blame] | 672 | for (i = 2; i < NUM_GENERATIONS; i++) { |
| 673 | /* generations higher than 2 get the same threshold */ |
| 674 | generations[i].threshold = generations[2].threshold; |
| 675 | } |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 676 | |
| 677 | Py_INCREF(Py_None); |
| 678 | return Py_None; |
| 679 | } |
| 680 | |
Martin v. Löwis | 14f8b4c | 2002-06-13 20:33:02 +0000 | [diff] [blame] | 681 | PyDoc_STRVAR(gc_get_thresh__doc__, |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 682 | "get_threshold() -> (threshold0, threshold1, threshold2)\n" |
| 683 | "\n" |
Martin v. Löwis | 14f8b4c | 2002-06-13 20:33:02 +0000 | [diff] [blame] | 684 | "Return the current collection thresholds\n"); |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 685 | |
| 686 | static PyObject * |
Vladimir Marangozov | f9d20c3 | 2000-08-06 22:45:31 +0000 | [diff] [blame] | 687 | gc_get_thresh(PyObject *self, PyObject *args) |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 688 | { |
Fred Drake | cc1be24 | 2000-07-12 04:42:23 +0000 | [diff] [blame] | 689 | if (!PyArg_ParseTuple(args, ":get_threshold")) /* no args */ |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 690 | return NULL; |
| 691 | |
Neil Schemenauer | 2880ae5 | 2002-05-04 05:35:20 +0000 | [diff] [blame] | 692 | return Py_BuildValue("(iii)", |
| 693 | generations[0].threshold, |
| 694 | generations[1].threshold, |
| 695 | generations[2].threshold); |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 696 | } |
| 697 | |
Neil Schemenauer | 48c7034 | 2001-08-09 15:38:31 +0000 | [diff] [blame] | 698 | static int |
Martin v. Löwis | 560da62 | 2001-11-24 09:24:51 +0000 | [diff] [blame] | 699 | referrersvisit(PyObject* obj, PyObject *objs) |
Neil Schemenauer | 48c7034 | 2001-08-09 15:38:31 +0000 | [diff] [blame] | 700 | { |
Martin v. Löwis | c8fe77b | 2001-11-29 18:08:31 +0000 | [diff] [blame] | 701 | int i; |
| 702 | for (i = 0; i < PyTuple_GET_SIZE(objs); i++) |
| 703 | if (PyTuple_GET_ITEM(objs, i) == obj) |
| 704 | return 1; |
Neil Schemenauer | 48c7034 | 2001-08-09 15:38:31 +0000 | [diff] [blame] | 705 | return 0; |
| 706 | } |
| 707 | |
Neil Schemenauer | 17e7be6 | 2001-08-10 14:46:47 +0000 | [diff] [blame] | 708 | static int |
Martin v. Löwis | 560da62 | 2001-11-24 09:24:51 +0000 | [diff] [blame] | 709 | gc_referrers_for(PyObject *objs, PyGC_Head *list, PyObject *resultlist) |
Neil Schemenauer | 48c7034 | 2001-08-09 15:38:31 +0000 | [diff] [blame] | 710 | { |
| 711 | PyGC_Head *gc; |
| 712 | PyObject *obj; |
| 713 | traverseproc traverse; |
Tim Peters | 9e4ca10 | 2001-10-11 18:31:31 +0000 | [diff] [blame] | 714 | 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] | 715 | obj = FROM_GC(gc); |
Neil Schemenauer | 48c7034 | 2001-08-09 15:38:31 +0000 | [diff] [blame] | 716 | traverse = obj->ob_type->tp_traverse; |
| 717 | if (obj == objs || obj == resultlist) |
| 718 | continue; |
Martin v. Löwis | 560da62 | 2001-11-24 09:24:51 +0000 | [diff] [blame] | 719 | if (traverse(obj, (visitproc)referrersvisit, objs)) { |
Neil Schemenauer | 17e7be6 | 2001-08-10 14:46:47 +0000 | [diff] [blame] | 720 | if (PyList_Append(resultlist, obj) < 0) |
| 721 | return 0; /* error */ |
Neil Schemenauer | 48c7034 | 2001-08-09 15:38:31 +0000 | [diff] [blame] | 722 | } |
| 723 | } |
Neil Schemenauer | 17e7be6 | 2001-08-10 14:46:47 +0000 | [diff] [blame] | 724 | return 1; /* no error */ |
Neil Schemenauer | 48c7034 | 2001-08-09 15:38:31 +0000 | [diff] [blame] | 725 | } |
| 726 | |
Martin v. Löwis | 14f8b4c | 2002-06-13 20:33:02 +0000 | [diff] [blame] | 727 | PyDoc_STRVAR(gc_get_referrers__doc__, |
Martin v. Löwis | 560da62 | 2001-11-24 09:24:51 +0000 | [diff] [blame] | 728 | "get_referrers(*objs) -> list\n\ |
Martin v. Löwis | 14f8b4c | 2002-06-13 20:33:02 +0000 | [diff] [blame] | 729 | Return the list of objects that directly refer to any of objs."); |
Neil Schemenauer | 48c7034 | 2001-08-09 15:38:31 +0000 | [diff] [blame] | 730 | |
Neil Schemenauer | 17e7be6 | 2001-08-10 14:46:47 +0000 | [diff] [blame] | 731 | static PyObject * |
Martin v. Löwis | 560da62 | 2001-11-24 09:24:51 +0000 | [diff] [blame] | 732 | gc_get_referrers(PyObject *self, PyObject *args) |
Neil Schemenauer | 48c7034 | 2001-08-09 15:38:31 +0000 | [diff] [blame] | 733 | { |
Neil Schemenauer | 2880ae5 | 2002-05-04 05:35:20 +0000 | [diff] [blame] | 734 | int i; |
Neil Schemenauer | 48c7034 | 2001-08-09 15:38:31 +0000 | [diff] [blame] | 735 | PyObject *result = PyList_New(0); |
Neil Schemenauer | 2880ae5 | 2002-05-04 05:35:20 +0000 | [diff] [blame] | 736 | for (i = 0; i < NUM_GENERATIONS; i++) { |
| 737 | if (!(gc_referrers_for(args, GEN_HEAD(i), result))) { |
| 738 | Py_DECREF(result); |
| 739 | return NULL; |
| 740 | } |
Neil Schemenauer | 17e7be6 | 2001-08-10 14:46:47 +0000 | [diff] [blame] | 741 | } |
Neil Schemenauer | 48c7034 | 2001-08-09 15:38:31 +0000 | [diff] [blame] | 742 | return result; |
| 743 | } |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 744 | |
Martin v. Löwis | 14f8b4c | 2002-06-13 20:33:02 +0000 | [diff] [blame] | 745 | PyDoc_STRVAR(gc_get_objects__doc__, |
Neil Schemenauer | c7c8d8e | 2001-08-09 15:58:59 +0000 | [diff] [blame] | 746 | "get_objects() -> [...]\n" |
| 747 | "\n" |
| 748 | "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] | 749 | "returned).\n"); |
Neil Schemenauer | c7c8d8e | 2001-08-09 15:58:59 +0000 | [diff] [blame] | 750 | |
| 751 | /* appending objects in a GC list to a Python list */ |
Martin v. Löwis | 155aad1 | 2001-12-02 12:21:34 +0000 | [diff] [blame] | 752 | static int |
Neil Schemenauer | c7c8d8e | 2001-08-09 15:58:59 +0000 | [diff] [blame] | 753 | append_objects(PyObject *py_list, PyGC_Head *gc_list) |
| 754 | { |
| 755 | PyGC_Head *gc; |
Tim Peters | 9e4ca10 | 2001-10-11 18:31:31 +0000 | [diff] [blame] | 756 | for (gc = gc_list->gc.gc_next; gc != gc_list; gc = gc->gc.gc_next) { |
Neil Schemenauer | 43411b5 | 2001-08-30 00:05:51 +0000 | [diff] [blame] | 757 | PyObject *op = FROM_GC(gc); |
Neil Schemenauer | c7c8d8e | 2001-08-09 15:58:59 +0000 | [diff] [blame] | 758 | if (op != py_list) { |
Martin v. Löwis | 155aad1 | 2001-12-02 12:21:34 +0000 | [diff] [blame] | 759 | if (PyList_Append(py_list, op)) { |
| 760 | return -1; /* exception */ |
| 761 | } |
Neil Schemenauer | c7c8d8e | 2001-08-09 15:58:59 +0000 | [diff] [blame] | 762 | } |
| 763 | } |
Martin v. Löwis | 155aad1 | 2001-12-02 12:21:34 +0000 | [diff] [blame] | 764 | return 0; |
Neil Schemenauer | c7c8d8e | 2001-08-09 15:58:59 +0000 | [diff] [blame] | 765 | } |
| 766 | |
| 767 | static PyObject * |
| 768 | gc_get_objects(PyObject *self, PyObject *args) |
| 769 | { |
Neil Schemenauer | 2880ae5 | 2002-05-04 05:35:20 +0000 | [diff] [blame] | 770 | int i; |
Neil Schemenauer | c7c8d8e | 2001-08-09 15:58:59 +0000 | [diff] [blame] | 771 | PyObject* result; |
| 772 | |
| 773 | if (!PyArg_ParseTuple(args, ":get_objects")) /* check no args */ |
| 774 | return NULL; |
| 775 | result = PyList_New(0); |
Martin v. Löwis | f8a6f24 | 2001-12-02 18:31:02 +0000 | [diff] [blame] | 776 | if (result == NULL) { |
| 777 | return NULL; |
| 778 | } |
Neil Schemenauer | 2880ae5 | 2002-05-04 05:35:20 +0000 | [diff] [blame] | 779 | for (i = 0; i < NUM_GENERATIONS; i++) { |
| 780 | if (append_objects(result, GEN_HEAD(i))) { |
| 781 | Py_DECREF(result); |
| 782 | return NULL; |
| 783 | } |
Martin v. Löwis | 155aad1 | 2001-12-02 12:21:34 +0000 | [diff] [blame] | 784 | } |
Neil Schemenauer | c7c8d8e | 2001-08-09 15:58:59 +0000 | [diff] [blame] | 785 | return result; |
| 786 | } |
| 787 | |
| 788 | |
Martin v. Löwis | 14f8b4c | 2002-06-13 20:33:02 +0000 | [diff] [blame] | 789 | PyDoc_STRVAR(gc__doc__, |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 790 | "This module provides access to the garbage collector for reference cycles.\n" |
| 791 | "\n" |
Vladimir Marangozov | f9d20c3 | 2000-08-06 22:45:31 +0000 | [diff] [blame] | 792 | "enable() -- Enable automatic garbage collection.\n" |
| 793 | "disable() -- Disable automatic garbage collection.\n" |
| 794 | "isenabled() -- Returns true if automatic collection is enabled.\n" |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 795 | "collect() -- Do a full collection right now.\n" |
| 796 | "set_debug() -- Set debugging flags.\n" |
| 797 | "get_debug() -- Get debugging flags.\n" |
| 798 | "set_threshold() -- Set the collection thresholds.\n" |
| 799 | "get_threshold() -- Return the current the collection thresholds.\n" |
Neil Schemenauer | c7c8d8e | 2001-08-09 15:58:59 +0000 | [diff] [blame] | 800 | "get_objects() -- Return a list of all objects tracked by the collector.\n" |
Martin v. Löwis | 14f8b4c | 2002-06-13 20:33:02 +0000 | [diff] [blame] | 801 | "get_referrers() -- Return the list of objects that refer to an object.\n"); |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 802 | |
| 803 | static PyMethodDef GcMethods[] = { |
Neil Schemenauer | 544de1e | 2000-09-22 15:22:38 +0000 | [diff] [blame] | 804 | {"enable", gc_enable, METH_VARARGS, gc_enable__doc__}, |
| 805 | {"disable", gc_disable, METH_VARARGS, gc_disable__doc__}, |
Vladimir Marangozov | f9d20c3 | 2000-08-06 22:45:31 +0000 | [diff] [blame] | 806 | {"isenabled", gc_isenabled, METH_VARARGS, gc_isenabled__doc__}, |
| 807 | {"set_debug", gc_set_debug, METH_VARARGS, gc_set_debug__doc__}, |
| 808 | {"get_debug", gc_get_debug, METH_VARARGS, gc_get_debug__doc__}, |
| 809 | {"set_threshold", gc_set_thresh, METH_VARARGS, gc_set_thresh__doc__}, |
| 810 | {"get_threshold", gc_get_thresh, METH_VARARGS, gc_get_thresh__doc__}, |
Neil Schemenauer | 544de1e | 2000-09-22 15:22:38 +0000 | [diff] [blame] | 811 | {"collect", gc_collect, METH_VARARGS, gc_collect__doc__}, |
Neil Schemenauer | c7c8d8e | 2001-08-09 15:58:59 +0000 | [diff] [blame] | 812 | {"get_objects", gc_get_objects,METH_VARARGS, gc_get_objects__doc__}, |
Martin v. Löwis | 560da62 | 2001-11-24 09:24:51 +0000 | [diff] [blame] | 813 | {"get_referrers", gc_get_referrers, METH_VARARGS, |
| 814 | gc_get_referrers__doc__}, |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 815 | {NULL, NULL} /* Sentinel */ |
| 816 | }; |
| 817 | |
| 818 | void |
| 819 | initgc(void) |
| 820 | { |
| 821 | PyObject *m; |
| 822 | PyObject *d; |
| 823 | |
| 824 | m = Py_InitModule4("gc", |
| 825 | GcMethods, |
| 826 | gc__doc__, |
| 827 | NULL, |
| 828 | PYTHON_API_VERSION); |
| 829 | d = PyModule_GetDict(m); |
| 830 | if (garbage == NULL) { |
| 831 | garbage = PyList_New(0); |
| 832 | } |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 833 | PyDict_SetItemString(d, "garbage", garbage); |
| 834 | PyDict_SetItemString(d, "DEBUG_STATS", |
| 835 | PyInt_FromLong(DEBUG_STATS)); |
| 836 | PyDict_SetItemString(d, "DEBUG_COLLECTABLE", |
| 837 | PyInt_FromLong(DEBUG_COLLECTABLE)); |
| 838 | PyDict_SetItemString(d, "DEBUG_UNCOLLECTABLE", |
| 839 | PyInt_FromLong(DEBUG_UNCOLLECTABLE)); |
| 840 | PyDict_SetItemString(d, "DEBUG_INSTANCES", |
| 841 | PyInt_FromLong(DEBUG_INSTANCES)); |
| 842 | PyDict_SetItemString(d, "DEBUG_OBJECTS", |
| 843 | PyInt_FromLong(DEBUG_OBJECTS)); |
Neil Schemenauer | 544de1e | 2000-09-22 15:22:38 +0000 | [diff] [blame] | 844 | PyDict_SetItemString(d, "DEBUG_SAVEALL", |
| 845 | PyInt_FromLong(DEBUG_SAVEALL)); |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 846 | PyDict_SetItemString(d, "DEBUG_LEAK", |
| 847 | PyInt_FromLong(DEBUG_LEAK)); |
| 848 | } |
| 849 | |
Neil Schemenauer | 43411b5 | 2001-08-30 00:05:51 +0000 | [diff] [blame] | 850 | /* for debugging */ |
| 851 | void _PyGC_Dump(PyGC_Head *g) |
| 852 | { |
| 853 | _PyObject_Dump(FROM_GC(g)); |
| 854 | } |
| 855 | |
Jeremy Hylton | c5007aa | 2000-06-30 05:02:53 +0000 | [diff] [blame] | 856 | #endif /* WITH_CYCLE_GC */ |
Neil Schemenauer | 43411b5 | 2001-08-30 00:05:51 +0000 | [diff] [blame] | 857 | |
| 858 | /* extension modules might be compiled with GC support so these |
| 859 | functions must always be available */ |
| 860 | |
Neil Schemenauer | fec4eb1 | 2002-04-12 02:41:03 +0000 | [diff] [blame] | 861 | #undef PyObject_GC_Track |
| 862 | #undef PyObject_GC_UnTrack |
| 863 | #undef PyObject_GC_Del |
| 864 | #undef _PyObject_GC_Malloc |
| 865 | |
Neil Schemenauer | 43411b5 | 2001-08-30 00:05:51 +0000 | [diff] [blame] | 866 | void |
Neil Schemenauer | fec4eb1 | 2002-04-12 02:41:03 +0000 | [diff] [blame] | 867 | PyObject_GC_Track(void *op) |
Neil Schemenauer | 43411b5 | 2001-08-30 00:05:51 +0000 | [diff] [blame] | 868 | { |
| 869 | _PyObject_GC_TRACK(op); |
| 870 | } |
| 871 | |
Neil Schemenauer | fec4eb1 | 2002-04-12 02:41:03 +0000 | [diff] [blame] | 872 | /* for binary compatibility with 2.2 */ |
Neil Schemenauer | 43411b5 | 2001-08-30 00:05:51 +0000 | [diff] [blame] | 873 | void |
Neil Schemenauer | fec4eb1 | 2002-04-12 02:41:03 +0000 | [diff] [blame] | 874 | _PyObject_GC_Track(PyObject *op) |
| 875 | { |
| 876 | PyObject_GC_Track(op); |
| 877 | } |
| 878 | |
| 879 | void |
| 880 | PyObject_GC_UnTrack(void *op) |
Neil Schemenauer | 43411b5 | 2001-08-30 00:05:51 +0000 | [diff] [blame] | 881 | { |
Neil Schemenauer | b883310 | 2002-03-29 03:04:25 +0000 | [diff] [blame] | 882 | #ifdef WITH_CYCLE_GC |
Neil Schemenauer | a2b11ec | 2002-05-21 15:53:24 +0000 | [diff] [blame] | 883 | if (IS_TRACKED(op)) |
Guido van Rossum | ff413af | 2002-03-28 20:34:59 +0000 | [diff] [blame] | 884 | _PyObject_GC_UNTRACK(op); |
Neil Schemenauer | b883310 | 2002-03-29 03:04:25 +0000 | [diff] [blame] | 885 | #endif |
Neil Schemenauer | 43411b5 | 2001-08-30 00:05:51 +0000 | [diff] [blame] | 886 | } |
| 887 | |
Neil Schemenauer | fec4eb1 | 2002-04-12 02:41:03 +0000 | [diff] [blame] | 888 | /* for binary compatibility with 2.2 */ |
| 889 | void |
| 890 | _PyObject_GC_UnTrack(PyObject *op) |
| 891 | { |
| 892 | PyObject_GC_UnTrack(op); |
| 893 | } |
| 894 | |
Neil Schemenauer | 43411b5 | 2001-08-30 00:05:51 +0000 | [diff] [blame] | 895 | PyObject * |
Neil Schemenauer | fec4eb1 | 2002-04-12 02:41:03 +0000 | [diff] [blame] | 896 | _PyObject_GC_Malloc(size_t basicsize) |
Neil Schemenauer | 43411b5 | 2001-08-30 00:05:51 +0000 | [diff] [blame] | 897 | { |
| 898 | PyObject *op; |
| 899 | #ifdef WITH_CYCLE_GC |
Neil Schemenauer | fec4eb1 | 2002-04-12 02:41:03 +0000 | [diff] [blame] | 900 | PyGC_Head *g = PyObject_MALLOC(sizeof(PyGC_Head) + basicsize); |
Neil Schemenauer | 43411b5 | 2001-08-30 00:05:51 +0000 | [diff] [blame] | 901 | if (g == NULL) |
Jeremy Hylton | 8a13518 | 2002-06-06 23:23:55 +0000 | [diff] [blame] | 902 | return PyErr_NoMemory(); |
Tim Peters | 9e4ca10 | 2001-10-11 18:31:31 +0000 | [diff] [blame] | 903 | g->gc.gc_next = NULL; |
Neil Schemenauer | 2880ae5 | 2002-05-04 05:35:20 +0000 | [diff] [blame] | 904 | generations[0].count++; /* number of allocated GC objects */ |
| 905 | if (generations[0].count > generations[0].threshold && |
Neil Schemenauer | 43411b5 | 2001-08-30 00:05:51 +0000 | [diff] [blame] | 906 | enabled && |
Neil Schemenauer | 2880ae5 | 2002-05-04 05:35:20 +0000 | [diff] [blame] | 907 | generations[0].threshold && |
Neil Schemenauer | 43411b5 | 2001-08-30 00:05:51 +0000 | [diff] [blame] | 908 | !collecting && |
| 909 | !PyErr_Occurred()) { |
| 910 | collecting = 1; |
Neil Schemenauer | 2880ae5 | 2002-05-04 05:35:20 +0000 | [diff] [blame] | 911 | collect_generations(); |
Neil Schemenauer | 43411b5 | 2001-08-30 00:05:51 +0000 | [diff] [blame] | 912 | collecting = 0; |
| 913 | } |
| 914 | op = FROM_GC(g); |
| 915 | #else |
Neil Schemenauer | fec4eb1 | 2002-04-12 02:41:03 +0000 | [diff] [blame] | 916 | op = PyObject_MALLOC(basicsize); |
Neil Schemenauer | 43411b5 | 2001-08-30 00:05:51 +0000 | [diff] [blame] | 917 | if (op == NULL) |
Jeremy Hylton | 8a13518 | 2002-06-06 23:23:55 +0000 | [diff] [blame] | 918 | return PyErr_NoMemory(); |
Neil Schemenauer | 43411b5 | 2001-08-30 00:05:51 +0000 | [diff] [blame] | 919 | |
| 920 | #endif |
| 921 | return op; |
| 922 | } |
| 923 | |
| 924 | PyObject * |
| 925 | _PyObject_GC_New(PyTypeObject *tp) |
| 926 | { |
Neil Schemenauer | fec4eb1 | 2002-04-12 02:41:03 +0000 | [diff] [blame] | 927 | PyObject *op = _PyObject_GC_Malloc(_PyObject_SIZE(tp)); |
Tim Peters | fa8efab | 2002-04-28 01:57:25 +0000 | [diff] [blame] | 928 | if (op != NULL) |
| 929 | op = PyObject_INIT(op, tp); |
| 930 | return op; |
Neil Schemenauer | 43411b5 | 2001-08-30 00:05:51 +0000 | [diff] [blame] | 931 | } |
| 932 | |
| 933 | PyVarObject * |
Tim Peters | 6d483d3 | 2001-10-06 21:27:34 +0000 | [diff] [blame] | 934 | _PyObject_GC_NewVar(PyTypeObject *tp, int nitems) |
Neil Schemenauer | 43411b5 | 2001-08-30 00:05:51 +0000 | [diff] [blame] | 935 | { |
Neil Schemenauer | fec4eb1 | 2002-04-12 02:41:03 +0000 | [diff] [blame] | 936 | const size_t size = _PyObject_VAR_SIZE(tp, nitems); |
| 937 | PyVarObject *op = (PyVarObject *) _PyObject_GC_Malloc(size); |
Tim Peters | fa8efab | 2002-04-28 01:57:25 +0000 | [diff] [blame] | 938 | if (op != NULL) |
| 939 | op = PyObject_INIT_VAR(op, tp, nitems); |
| 940 | return op; |
Neil Schemenauer | 43411b5 | 2001-08-30 00:05:51 +0000 | [diff] [blame] | 941 | } |
| 942 | |
| 943 | PyVarObject * |
Tim Peters | 6d483d3 | 2001-10-06 21:27:34 +0000 | [diff] [blame] | 944 | _PyObject_GC_Resize(PyVarObject *op, int nitems) |
Neil Schemenauer | 43411b5 | 2001-08-30 00:05:51 +0000 | [diff] [blame] | 945 | { |
Tim Peters | f2a67da | 2001-10-07 03:54:51 +0000 | [diff] [blame] | 946 | const size_t basicsize = _PyObject_VAR_SIZE(op->ob_type, nitems); |
Neil Schemenauer | 43411b5 | 2001-08-30 00:05:51 +0000 | [diff] [blame] | 947 | #ifdef WITH_CYCLE_GC |
| 948 | PyGC_Head *g = AS_GC(op); |
Neil Schemenauer | fec4eb1 | 2002-04-12 02:41:03 +0000 | [diff] [blame] | 949 | g = PyObject_REALLOC(g, sizeof(PyGC_Head) + basicsize); |
Neil Schemenauer | 43411b5 | 2001-08-30 00:05:51 +0000 | [diff] [blame] | 950 | if (g == NULL) |
| 951 | return (PyVarObject *)PyErr_NoMemory(); |
| 952 | op = (PyVarObject *) FROM_GC(g); |
| 953 | #else |
Neil Schemenauer | fec4eb1 | 2002-04-12 02:41:03 +0000 | [diff] [blame] | 954 | op = PyObject_REALLOC(op, basicsize); |
Neil Schemenauer | 43411b5 | 2001-08-30 00:05:51 +0000 | [diff] [blame] | 955 | if (op == NULL) |
| 956 | return (PyVarObject *)PyErr_NoMemory(); |
| 957 | #endif |
Tim Peters | 6d483d3 | 2001-10-06 21:27:34 +0000 | [diff] [blame] | 958 | op->ob_size = nitems; |
Neil Schemenauer | 43411b5 | 2001-08-30 00:05:51 +0000 | [diff] [blame] | 959 | return op; |
| 960 | } |
| 961 | |
| 962 | void |
Neil Schemenauer | fec4eb1 | 2002-04-12 02:41:03 +0000 | [diff] [blame] | 963 | PyObject_GC_Del(void *op) |
Neil Schemenauer | 43411b5 | 2001-08-30 00:05:51 +0000 | [diff] [blame] | 964 | { |
| 965 | #ifdef WITH_CYCLE_GC |
| 966 | PyGC_Head *g = AS_GC(op); |
Neil Schemenauer | a2b11ec | 2002-05-21 15:53:24 +0000 | [diff] [blame] | 967 | if (IS_TRACKED(op)) |
Neil Schemenauer | 43411b5 | 2001-08-30 00:05:51 +0000 | [diff] [blame] | 968 | gc_list_remove(g); |
Neil Schemenauer | 2880ae5 | 2002-05-04 05:35:20 +0000 | [diff] [blame] | 969 | if (generations[0].count > 0) { |
| 970 | generations[0].count--; |
Neil Schemenauer | 43411b5 | 2001-08-30 00:05:51 +0000 | [diff] [blame] | 971 | } |
Neil Schemenauer | fec4eb1 | 2002-04-12 02:41:03 +0000 | [diff] [blame] | 972 | PyObject_FREE(g); |
Neil Schemenauer | 43411b5 | 2001-08-30 00:05:51 +0000 | [diff] [blame] | 973 | #else |
Neil Schemenauer | fec4eb1 | 2002-04-12 02:41:03 +0000 | [diff] [blame] | 974 | PyObject_FREE(op); |
Neil Schemenauer | 43411b5 | 2001-08-30 00:05:51 +0000 | [diff] [blame] | 975 | #endif |
| 976 | } |
| 977 | |
Neil Schemenauer | fec4eb1 | 2002-04-12 02:41:03 +0000 | [diff] [blame] | 978 | /* for binary compatibility with 2.2 */ |
| 979 | #undef _PyObject_GC_Del |
| 980 | void |
| 981 | _PyObject_GC_Del(PyObject *op) |
| 982 | { |
| 983 | PyObject_GC_Del(op); |
| 984 | } |