Issue #26200: Added Py_SETREF and replaced Py_XSETREF with Py_SETREF

serhiy-storchaka · serhiy-storchaka · commit f01e408c1688 · 2016-04-10T18:12:01.000+03:00
in places where Py_DECREF was used.
diff --git a/Include/object.h b/Include/object.h
@@ -851,18 +851,28 @@ PyAPI_FUNC(void) _Py_Dealloc(PyObject *);
  *
  * As in case of Py_CLEAR "the obvious" code can be deadly:
  *
- *     Py_XDECREF(op);
+ *     Py_DECREF(op);
  *     op = op2;
  *
  * The safe way is:
  *
- *      Py_XSETREF(op, op2);
+ *      Py_SETREF(op, op2);
  *
  * That arranges to set `op` to `op2` _before_ decref'ing, so that any code
  * triggered as a side-effect of `op` getting torn down no longer believes
  * `op` points to a valid object.
+ *
+ * Py_XSETREF is a variant of Py_SETREF that uses Py_XDECREF instead of
+ * Py_DECREF.
  */
 
+#define Py_SETREF(op, op2)                      \
+    do {                                        \
+        PyObject *_py_tmp = (PyObject *)(op);   \
+        (op) = (op2);                           \
+        Py_DECREF(_py_tmp);                     \
+    } while (0)
+
 #define Py_XSETREF(op, op2)                     \
     do {                                        \
         PyObject *_py_tmp = (PyObject *)(op);   \
diff --git a/Modules/_ctypes/_ctypes.c b/Modules/_ctypes/_ctypes.c
@@ -391,7 +391,7 @@ StructUnionType_new(PyTypeObject *type, PyObject *args, PyObject *kwds, int isSt
         Py_DECREF((PyObject *)dict);
         return NULL;
     }
-    Py_XSETREF(result->tp_dict, (PyObject *)dict);
+    Py_SETREF(result->tp_dict, (PyObject *)dict);
     dict->format = _ctypes_alloc_format_string(NULL, "B");
     if (dict->format == NULL) {
         Py_DECREF(result);
@@ -960,7 +960,7 @@ PyCPointerType_new(PyTypeObject *type, PyObject *args, PyObject *kwds)
         Py_DECREF((PyObject *)stgdict);
         return NULL;
     }
-    Py_XSETREF(result->tp_dict, (PyObject *)stgdict);
+    Py_SETREF(result->tp_dict, (PyObject *)stgdict);
 
     return (PyObject *)result;
 }
@@ -1403,7 +1403,7 @@ PyCArrayType_new(PyTypeObject *type, PyObject *args, PyObject *kwds)
     /* replace the class dict by our updated spam dict */
     if (-1 == PyDict_Update((PyObject *)stgdict, result->tp_dict))
         goto error;
-    Py_XSETREF(result->tp_dict, (PyObject *)stgdict);  /* steal the reference */
+    Py_SETREF(result->tp_dict, (PyObject *)stgdict);  /* steal the reference */
     stgdict = NULL;
 
     /* Special case for character arrays.
@@ -1816,7 +1816,7 @@ static PyObject *CreateSwappedType(PyTypeObject *type, PyObject *args, PyObject
         Py_DECREF((PyObject *)stgdict);
         return NULL;
     }
-    Py_XSETREF(result->tp_dict, (PyObject *)stgdict);
+    Py_SETREF(result->tp_dict, (PyObject *)stgdict);
 
     return (PyObject *)result;
 }
@@ -1944,7 +1944,7 @@ PyCSimpleType_new(PyTypeObject *type, PyObject *args, PyObject *kwds)
         Py_DECREF((PyObject *)stgdict);
         return NULL;
     }
-    Py_XSETREF(result->tp_dict, (PyObject *)stgdict);
+    Py_SETREF(result->tp_dict, (PyObject *)stgdict);
 
     /* Install from_param class methods in ctypes base classes.
        Overrides the PyCSimpleType_from_param generic method.
@@ -2307,7 +2307,7 @@ PyCFuncPtrType_new(PyTypeObject *type, PyObject *args, PyObject *kwds)
         Py_DECREF((PyObject *)stgdict);
         return NULL;
     }
-    Py_XSETREF(result->tp_dict, (PyObject *)stgdict);
+    Py_SETREF(result->tp_dict, (PyObject *)stgdict);
 
     if (-1 == make_funcptrtype_dict(stgdict)) {
         Py_DECREF(result);
@@ -5150,7 +5150,7 @@ comerror_init(PyObject *self, PyObject *args, PyObject *kwds)
         return -1;
 
     Py_INCREF(args);
-    Py_XSETREF(((PyBaseExceptionObject *)self)->args, args);
+    Py_SETREF(((PyBaseExceptionObject *)self)->args, args);
 
     return 0;
 }
diff --git a/Modules/_curses_panel.c b/Modules/_curses_panel.c
@@ -313,7 +313,7 @@ PyCursesPanel_replace_panel(PyCursesPanelObject *self, PyObject *args)
         return NULL;
     }
     Py_INCREF(temp);
-    Py_XSETREF(po->wo, temp);
+    Py_SETREF(po->wo, temp);
     Py_INCREF(Py_None);
     return Py_None;
 }
diff --git a/Modules/_datetimemodule.c b/Modules/_datetimemodule.c
@@ -1058,7 +1058,7 @@ format_utcoffset(char *buf, size_t buflen, const char *sep,
     /* Offset is normalized, so it is negative if days < 0 */
     if (GET_TD_DAYS(offset) < 0) {
         sign = '-';
-        Py_XSETREF(offset, delta_negative((PyDateTime_Delta *)offset));
+        Py_SETREF(offset, delta_negative((PyDateTime_Delta *)offset));
         if (offset == NULL)
             return -1;
     }
@@ -3045,7 +3045,7 @@ tzinfo_fromutc(PyDateTime_TZInfo *self, PyObject *dt)
     if (dst == Py_None)
         goto Inconsistent;
     if (delta_bool((PyDateTime_Delta *)dst) != 0) {
-        Py_XSETREF(result, add_datetime_timedelta((PyDateTime_DateTime *)result,
+        Py_SETREF(result, add_datetime_timedelta((PyDateTime_DateTime *)result,
                                                  (PyDateTime_Delta *)dst, 1));
         if (result == NULL)
             goto Fail;
@@ -4445,7 +4445,7 @@ datetime_subtract(PyObject *left, PyObject *right)
                 return NULL;
 
             if (offdiff != NULL) {
-                Py_XSETREF(result, delta_subtract(result, offdiff));
+                Py_SETREF(result, delta_subtract(result, offdiff));
                 Py_DECREF(offdiff);
             }
         }
diff --git a/Modules/_elementtree.c b/Modules/_elementtree.c
@@ -1957,7 +1957,7 @@ element_tag_setter(ElementObject *self, PyObject *value, void *closure)
 {
     _VALIDATE_ATTR_VALUE(value);
     Py_INCREF(value);
-    Py_XSETREF(self->tag, value);
+    Py_SETREF(self->tag, value);
     return 0;
 }
 
@@ -1990,7 +1990,7 @@ element_attrib_setter(ElementObject *self, PyObject *value, void *closure)
             return -1;
     }
     Py_INCREF(value);
-    Py_XSETREF(self->extra->attrib, value);
+    Py_SETREF(self->extra->attrib, value);
     return 0;
 }
 
@@ -2524,9 +2524,9 @@ treebuilder_handle_start(TreeBuilderObject* self, PyObject* tag,
     self->index++;
 
     Py_INCREF(node);
-    Py_XSETREF(self->this, node);
+    Py_SETREF(self->this, node);
     Py_INCREF(node);
-    Py_XSETREF(self->last, node);
+    Py_SETREF(self->last, node);
 
     if (treebuilder_append_event(self, self->start_event_obj, node) < 0)
         goto error;
diff --git a/Modules/_io/bytesio.c b/Modules/_io/bytesio.c
@@ -96,7 +96,7 @@ unshare_buffer(bytesio *self, size_t size)
         return -1;
     memcpy(PyBytes_AS_STRING(new_buf), PyBytes_AS_STRING(self->buf),
            self->string_size);
-    Py_XSETREF(self->buf, new_buf);
+    Py_SETREF(self->buf, new_buf);
     return 0;
 }
 
diff --git a/Modules/_sqlite/connection.c b/Modules/_sqlite/connection.c
@@ -204,7 +204,7 @@ void pysqlite_flush_statement_cache(pysqlite_Connection* self)
         node = node->next;
     }
 
-    Py_XSETREF(self->statement_cache,
+    Py_SETREF(self->statement_cache,
               (pysqlite_Cache *)PyObject_CallFunction((PyObject *)&pysqlite_CacheType, "O", self));
     Py_DECREF(self);
     self->statement_cache->decref_factory = 0;
@@ -793,7 +793,7 @@ static void _pysqlite_drop_unused_statement_references(pysqlite_Connection* self
         }
     }
 
-    Py_XSETREF(self->statements, new_list);
+    Py_SETREF(self->statements, new_list);
 }
 
 static void _pysqlite_drop_unused_cursor_references(pysqlite_Connection* self)
@@ -824,7 +824,7 @@ static void _pysqlite_drop_unused_cursor_references(pysqlite_Connection* self)
         }
     }
 
-    Py_XSETREF(self->cursors, new_list);
+    Py_SETREF(self->cursors, new_list);
 }
 
 PyObject* pysqlite_connection_create_function(pysqlite_Connection* self, PyObject* args, PyObject* kwargs)
diff --git a/Modules/_sqlite/cursor.c b/Modules/_sqlite/cursor.c
@@ -509,7 +509,7 @@ PyObject* _pysqlite_query_execute(pysqlite_Cursor* self, int multiple, PyObject*
 
     /* reset description and rowcount */
     Py_INCREF(Py_None);
-    Py_XSETREF(self->description, Py_None);
+    Py_SETREF(self->description, Py_None);
     self->rowcount = -1L;
 
     func_args = PyTuple_New(1);
@@ -534,7 +534,7 @@ PyObject* _pysqlite_query_execute(pysqlite_Cursor* self, int multiple, PyObject*
     }
 
     if (self->statement->in_use) {
-        Py_XSETREF(self->statement,
+        Py_SETREF(self->statement,
                   PyObject_New(pysqlite_Statement, &pysqlite_StatementType));
         if (!self->statement) {
             goto error;
@@ -651,7 +651,7 @@ PyObject* _pysqlite_query_execute(pysqlite_Cursor* self, int multiple, PyObject*
                 numcols = sqlite3_column_count(self->statement->st);
                 Py_END_ALLOW_THREADS
 
-                Py_XSETREF(self->description, PyTuple_New(numcols));
+                Py_SETREF(self->description, PyTuple_New(numcols));
                 if (!self->description) {
                     goto error;
                 }
diff --git a/Modules/_sre.c b/Modules/_sre.c
@@ -753,7 +753,7 @@ deepcopy(PyObject** object, PyObject* memo)
     if (!copy)
         return 0;
 
-    Py_XSETREF(*object, copy);
+    Py_SETREF(*object, copy);
 
     return 1; /* success */
 }
diff --git a/Modules/_ssl.c b/Modules/_ssl.c
@@ -1589,7 +1589,7 @@ static int PySSL_set_context(PySSLSocket *self, PyObject *value,
         return -1;
 #else
         Py_INCREF(value);
-        Py_XSETREF(self->ctx, (PySSLContext *)value);
+        Py_SETREF(self->ctx, (PySSLContext *)value);
         SSL_set_SSL_CTX(self->ssl, self->ctx->ctx);
 #endif
     } else {
diff --git a/Modules/itertoolsmodule.c b/Modules/itertoolsmodule.c
@@ -622,7 +622,7 @@ tee_next(teeobject *to)
         link = teedataobject_jumplink(to->dataobj);
         if (link == NULL)
             return NULL;
-        Py_XSETREF(to->dataobj, (teedataobject *)link);
+        Py_SETREF(to->dataobj, (teedataobject *)link);
         to->index = 0;
     }
     value = teedataobject_getitem(to->dataobj, to->index);
@@ -3457,7 +3457,7 @@ accumulate_next(accumulateobject *lz)
         return NULL;
 
     Py_INCREF(newtotal);
-    Py_XSETREF(lz->total, newtotal);
+    Py_SETREF(lz->total, newtotal);
     return newtotal;
 }
 
diff --git a/Modules/signalmodule.c b/Modules/signalmodule.c
@@ -1266,7 +1266,7 @@ PyInit__signal(void)
     if (Handlers[SIGINT].func == DefaultHandler) {
         /* Install default int handler */
         Py_INCREF(IntHandler);
-        Py_XSETREF(Handlers[SIGINT].func, IntHandler);
+        Py_SETREF(Handlers[SIGINT].func, IntHandler);
         old_siginthandler = PyOS_setsig(SIGINT, signal_handler);
     }
 
diff --git a/Modules/zipimport.c b/Modules/zipimport.c
@@ -155,7 +155,7 @@ zipimporter_init(ZipImporter *self, PyObject *args, PyObject *kwds)
             tmp = PyUnicode_FromFormat("%U%c", self->prefix, SEP);
             if (tmp == NULL)
                 goto error;
-            Py_XSETREF(self->prefix, tmp);
+            Py_SETREF(self->prefix, tmp);
         }
     }
     else
diff --git a/Modules/zlibmodule.c b/Modules/zlibmodule.c
@@ -667,7 +667,7 @@ save_unconsumed_input(compobject *self, int err)
                       PyBytes_AS_STRING(self->unused_data), old_size);
             Py_MEMCPY(PyBytes_AS_STRING(new_data) + old_size,
                       self->zst.next_in, self->zst.avail_in);
-            Py_XSETREF(self->unused_data, new_data);
+            Py_SETREF(self->unused_data, new_data);
             self->zst.avail_in = 0;
         }
     }
@@ -679,7 +679,7 @@ save_unconsumed_input(compobject *self, int err)
                 (char *)self->zst.next_in, self->zst.avail_in);
         if (new_data == NULL)
             return -1;
-        Py_XSETREF(self->unconsumed_tail, new_data);
+        Py_SETREF(self->unconsumed_tail, new_data);
     }
     return 0;
 }
diff --git a/Objects/bytesobject.c b/Objects/bytesobject.c
@@ -3697,7 +3697,7 @@ PyBytes_Concat(PyObject **pv, PyObject *w)
         /* Multiple references, need to create new object */
         PyObject *v;
         v = bytes_concat(*pv, w);
-        Py_XSETREF(*pv, v);
+        Py_SETREF(*pv, v);
     }
 }
 
diff --git a/Objects/funcobject.c b/Objects/funcobject.c
@@ -504,7 +504,7 @@ func_new(PyTypeObject* type, PyObject* args, PyObject* kw)
 
     if (name != Py_None) {
         Py_INCREF(name);
-        Py_XSETREF(newfunc->func_name, name);
+        Py_SETREF(newfunc->func_name, name);
     }
     if (defaults != Py_None) {
         Py_INCREF(defaults);
diff --git a/Objects/listobject.c b/Objects/listobject.c
@@ -735,7 +735,7 @@ list_ass_item(PyListObject *a, Py_ssize_t i, PyObject *v)
     if (v == NULL)
         return list_ass_slice(a, i, i+1, v);
     Py_INCREF(v);
-    Py_XSETREF(a->ob_item[i], v);
+    Py_SETREF(a->ob_item[i], v);
     return 0;
 }
 
diff --git a/Objects/rangeobject.c b/Objects/rangeobject.c
@@ -1064,7 +1064,7 @@ longrangeiter_next(longrangeiterobject *r)
     result = PyNumber_Add(r->start, product);
     Py_DECREF(product);
     if (result) {
-        Py_XSETREF(r->index, new_index);
+        Py_SETREF(r->index, new_index);
     }
     else {
         Py_DECREF(new_index);
diff --git a/Objects/typeobject.c b/Objects/typeobject.c
@@ -424,7 +424,7 @@ type_set_name(PyTypeObject *type, PyObject *value, void *context)
 
     type->tp_name = tp_name;
     Py_INCREF(value);
-    Py_XSETREF(((PyHeapTypeObject*)type)->ht_name, value);
+    Py_SETREF(((PyHeapTypeObject*)type)->ht_name, value);
 
     return 0;
 }
@@ -445,7 +445,7 @@ type_set_qualname(PyTypeObject *type, PyObject *value, void *context)
 
     et = (PyHeapTypeObject*)type;
     Py_INCREF(value);
-    Py_XSETREF(et->ht_qualname, value);
+    Py_SETREF(et->ht_qualname, value);
     return 0;
 }
 
@@ -2903,7 +2903,7 @@ _PyType_Lookup(PyTypeObject *type, PyObject *name)
         else
             method_cache_misses++;
 #endif
-        Py_XSETREF(method_cache[h].name, name);
+        Py_SETREF(method_cache[h].name, name);
     }
     return res;
 }
diff --git a/Objects/unicodeobject.c b/Objects/unicodeobject.c
@@ -1830,15 +1830,15 @@ unicode_resize(PyObject **p_unicode, Py_ssize_t length)
         _Py_INCREF_UNICODE_EMPTY();
         if (!unicode_empty)
             return -1;
-        Py_XSETREF(*p_unicode, unicode_empty);
+        Py_SETREF(*p_unicode, unicode_empty);
         return 0;
     }
 
     if (!unicode_modifiable(unicode)) {
         PyObject *copy = resize_copy(unicode, length);
         if (copy == NULL)
             return -1;
-        Py_XSETREF(*p_unicode, copy);
+        Py_SETREF(*p_unicode, copy);
         return 0;
     }
 
@@ -13547,7 +13547,7 @@ _PyUnicodeWriter_PrepareInternal(_PyUnicodeWriter *writer,
             return -1;
         _PyUnicode_FastCopyCharacters(newbuffer, 0,
                                       writer->buffer, 0, writer->pos);
-        Py_XSETREF(writer->buffer, newbuffer);
+        Py_SETREF(writer->buffer, newbuffer);
     }
     _PyUnicodeWriter_Update(writer);
     return 0;
@@ -15264,7 +15264,7 @@ PyUnicode_InternInPlace(PyObject **p)
 
     if (t) {
         Py_INCREF(t);
-        Py_XSETREF(*p, t);
+        Py_SETREF(*p, t);
         return;
     }
 
diff --git a/Python/_warnings.c b/Python/_warnings.c
diff --git a/Python/ceval.c b/Python/ceval.c
diff --git a/Python/errors.c b/Python/errors.c

Original file line number	Diff line number	Diff line change
`@@ -313,7 +313,7 @@ PyCursesPanel_replace_panel(PyCursesPanelObject self, PyObject args)`
`313`	`313`	`return NULL;`
`314`	`314`	`}`
`315`	`315`	`Py_INCREF(temp);`
`316`		`- Py_XSETREF(po->wo, temp);`
	`316`	`+ Py_SETREF(po->wo, temp);`
`317`	`317`	`Py_INCREF(Py_None);`
`318`	`318`	`return Py_None;`
`319`	`319`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1957,7 +1957,7 @@ element_tag_setter(ElementObject self, PyObject value, void *closure)`
`1957`	`1957`	`{`
`1958`	`1958`	`_VALIDATE_ATTR_VALUE(value);`
`1959`	`1959`	`Py_INCREF(value);`
`1960`		`- Py_XSETREF(self->tag, value);`
	`1960`	`+ Py_SETREF(self->tag, value);`
`1961`	`1961`	`return 0;`
`1962`	`1962`	`}`
`1963`	`1963`
`@@ -1990,7 +1990,7 @@ element_attrib_setter(ElementObject self, PyObject value, void *closure)`
`1990`	`1990`	`return -1;`
`1991`	`1991`	`}`
`1992`	`1992`	`Py_INCREF(value);`
`1993`		`- Py_XSETREF(self->extra->attrib, value);`
	`1993`	`+ Py_SETREF(self->extra->attrib, value);`
`1994`	`1994`	`return 0;`
`1995`	`1995`	`}`
`1996`	`1996`
`@@ -2524,9 +2524,9 @@ treebuilder_handle_start(TreeBuilderObject* self, PyObject* tag,`
`2524`	`2524`	`self->index++;`
`2525`	`2525`
`2526`	`2526`	`Py_INCREF(node);`
`2527`		`- Py_XSETREF(self->this, node);`
	`2527`	`+ Py_SETREF(self->this, node);`
`2528`	`2528`	`Py_INCREF(node);`
`2529`		`- Py_XSETREF(self->last, node);`
	`2529`	`+ Py_SETREF(self->last, node);`
`2530`	`2530`
`2531`	`2531`	`if (treebuilder_append_event(self, self->start_event_obj, node) < 0)`
`2532`	`2532`	`goto error;`
Original file line number	Diff line number	Diff line change
`@@ -96,7 +96,7 @@ unshare_buffer(bytesio *self, size_t size)`
`96`	`96`	`return -1;`
`97`	`97`	`memcpy(PyBytes_AS_STRING(new_buf), PyBytes_AS_STRING(self->buf),`
`98`	`98`	`self->string_size);`
`99`		`- Py_XSETREF(self->buf, new_buf);`
	`99`	`+ Py_SETREF(self->buf, new_buf);`
`100`	`100`	`return 0;`
`101`	`101`	`}`
`102`	`102`
Original file line number	Diff line number	Diff line change
`@@ -204,7 +204,7 @@ void pysqlite_flush_statement_cache(pysqlite_Connection* self)`
`204`	`204`	`node = node->next;`
`205`	`205`	`}`
`206`	`206`
`207`		`- Py_XSETREF(self->statement_cache,`
	`207`	`+ Py_SETREF(self->statement_cache,`
`208`	`208`	`(pysqlite_Cache )PyObject_CallFunction((PyObject )&pysqlite_CacheType, "O", self));`
`209`	`209`	`Py_DECREF(self);`
`210`	`210`	`self->statement_cache->decref_factory = 0;`
`@@ -793,7 +793,7 @@ static void _pysqlite_drop_unused_statement_references(pysqlite_Connection* self`
`793`	`793`	`}`
`794`	`794`	`}`
`795`	`795`
`796`		`- Py_XSETREF(self->statements, new_list);`
	`796`	`+ Py_SETREF(self->statements, new_list);`
`797`	`797`	`}`
`798`	`798`
`799`	`799`	`static void _pysqlite_drop_unused_cursor_references(pysqlite_Connection* self)`
`@@ -824,7 +824,7 @@ static void _pysqlite_drop_unused_cursor_references(pysqlite_Connection* self)`
`824`	`824`	`}`
`825`	`825`	`}`
`826`	`826`
`827`		`- Py_XSETREF(self->cursors, new_list);`
	`827`	`+ Py_SETREF(self->cursors, new_list);`
`828`	`828`	`}`
`829`	`829`
`830`	`830`	`PyObject* pysqlite_connection_create_function(pysqlite_Connection* self, PyObject* args, PyObject* kwargs)`
Original file line number	Diff line number	Diff line change
`@@ -753,7 +753,7 @@ deepcopy(PyObject** object, PyObject* memo)`
`753`	`753`	`if (!copy)`
`754`	`754`	`return 0;`
`755`	`755`
`756`		`- Py_XSETREF(*object, copy);`
	`756`	`+ Py_SETREF(*object, copy);`
`757`	`757`
`758`	`758`	`return 1; /* success */`
`759`	`759`	`}`