Doc/c-api/gcsupport.rst

   1 .. highlightlang:: c
   2
   3 .. _supporting-cycle-detection:
   4
   5 Supporting Cyclic Garbage Collection
   6 ====================================
   7
   8 Python's support for detecting and collecting garbage which involves circular
   9 references requires support from object types which are "containers" for other
  10 objects which may also be containers.  Types which do not store references to
  11 other objects, or which only store references to atomic types (such as numbers
  12 or strings), do not need to provide any explicit support for garbage
  13 collection.
  14
  15 To create a container type, the :attr:`tp_flags` field of the type object must
  16 include the :const:`Py_TPFLAGS_HAVE_GC` and provide an implementation of the
  17 :attr:`tp_traverse` handler.  If instances of the type are mutable, a
  18 :attr:`tp_clear` implementation must also be provided.
  19
  20
  21 .. data:: Py_TPFLAGS_HAVE_GC
  22    :noindex:
  23
  24    Objects with a type with this flag set must conform with the rules
  25    documented here.  For convenience these objects will be referred to as
  26    container objects.
  27
  28 Constructors for container types must conform to two rules:
  29
  30 #. The memory for the object must be allocated using :cfunc:`PyObject_GC_New`
  31    or :cfunc:`PyObject_GC_VarNew`.
  32
  33 #. Once all the fields which may contain references to other containers are
  34    initialized, it must call :cfunc:`PyObject_GC_Track`.
  35
  36
  37 .. cfunction:: TYPE* PyObject_GC_New(TYPE, PyTypeObject *type)
  38
  39    Analogous to :cfunc:`PyObject_New` but for container objects with the
  40    :const:`Py_TPFLAGS_HAVE_GC` flag set.
  41
  42
  43 .. cfunction:: TYPE* PyObject_GC_NewVar(TYPE, PyTypeObject *type, Py_ssize_t size)
  44
  45    Analogous to :cfunc:`PyObject_NewVar` but for container objects with the
  46    :const:`Py_TPFLAGS_HAVE_GC` flag set.
  47
  48
  49 .. cfunction:: TYPE* PyObject_GC_Resize(TYPE, PyVarObject *op, Py_ssize_t newsize)
  50
  51    Resize an object allocated by :cfunc:`PyObject_NewVar`.  Returns the
  52    resized object or *NULL* on failure.
  53
  54
  55 .. cfunction:: void PyObject_GC_Track(PyObject *op)
  56
  57    Adds the object *op* to the set of container objects tracked by the
  58    collector.  The collector can run at unexpected times so objects must be
  59    valid while being tracked.  This should be called once all the fields
  60    followed by the :attr:`tp_traverse` handler become valid, usually near the
  61    end of the constructor.
  62
  63
  64 .. cfunction:: void _PyObject_GC_TRACK(PyObject *op)
  65
  66    A macro version of :cfunc:`PyObject_GC_Track`.  It should not be used for
  67    extension modules.
  68
  69 Similarly, the deallocator for the object must conform to a similar pair of
  70 rules:
  71
  72 #. Before fields which refer to other containers are invalidated,
  73    :cfunc:`PyObject_GC_UnTrack` must be called.
  74
  75 #. The object's memory must be deallocated using :cfunc:`PyObject_GC_Del`.
  76
  77
  78 .. cfunction:: void PyObject_GC_Del(void *op)
  79
  80    Releases memory allocated to an object using :cfunc:`PyObject_GC_New` or
  81    :cfunc:`PyObject_GC_NewVar`.
  82
  83
  84 .. cfunction:: void PyObject_GC_UnTrack(void *op)
  85
  86    Remove the object *op* from the set of container objects tracked by the
  87    collector.  Note that :cfunc:`PyObject_GC_Track` can be called again on
  88    this object to add it back to the set of tracked objects.  The deallocator
  89    (:attr:`tp_dealloc` handler) should call this for the object before any of
  90    the fields used by the :attr:`tp_traverse` handler become invalid.
  91
  92
  93 .. cfunction:: void _PyObject_GC_UNTRACK(PyObject *op)
  94
  95    A macro version of :cfunc:`PyObject_GC_UnTrack`.  It should not be used for
  96    extension modules.
  97
  98 The :attr:`tp_traverse` handler accepts a function parameter of this type:
  99
 100
 101 .. ctype:: int (*visitproc)(PyObject *object, void *arg)
 102
 103    Type of the visitor function passed to the :attr:`tp_traverse` handler.
 104    The function should be called with an object to traverse as *object* and
 105    the third parameter to the :attr:`tp_traverse` handler as *arg*.  The
 106    Python core uses several visitor functions to implement cyclic garbage
 107    detection; it's not expected that users will need to write their own
 108    visitor functions.
 109
 110 The :attr:`tp_traverse` handler must have the following type:
 111
 112
 113 .. ctype:: int (*traverseproc)(PyObject *self, visitproc visit, void *arg)
 114
 115    Traversal function for a container object.  Implementations must call the
 116    *visit* function for each object directly contained by *self*, with the
 117    parameters to *visit* being the contained object and the *arg* value passed
 118    to the handler.  The *visit* function must not be called with a *NULL*
 119    object argument.  If *visit* returns a non-zero value that value should be
 120    returned immediately.
 121
 122 To simplify writing :attr:`tp_traverse` handlers, a :cfunc:`Py_VISIT` macro is
 123 provided.  In order to use this macro, the :attr:`tp_traverse` implementation
 124 must name its arguments exactly *visit* and *arg*:
 125
 126
 127 .. cfunction:: void Py_VISIT(PyObject *o)
 128
 129    Call the *visit* callback, with arguments *o* and *arg*. If *visit* returns
 130    a non-zero value, then return it.  Using this macro, :attr:`tp_traverse`
 131    handlers look like::
 132
 133       static int
 134       my_traverse(Noddy *self, visitproc visit, void *arg)
 135       {
 136           Py_VISIT(self->foo);
 137           Py_VISIT(self->bar);
 138           return 0;
 139       }
 140
 141 The :attr:`tp_clear` handler must be of the :ctype:`inquiry` type, or *NULL*
 142 if the object is immutable.
 143
 144
 145 .. ctype:: int (*inquiry)(PyObject *self)
 146
 147    Drop references that may have created reference cycles.  Immutable objects
 148    do not have to define this method since they can never directly create
 149    reference cycles.  Note that the object must still be valid after calling
 150    this method (don't just call :cfunc:`Py_DECREF` on a reference).  The
 151    collector will call this method if it detects that this object is involved
 152    in a reference cycle.