pythongh-131525: Cache the result of tuple_hash

Author: mdboom

Include/cpython/tupleobject.h

@@ -4,6 +4,8 @@
 
 typedef struct {
     PyObject_VAR_HEAD
+    /* Cached hash.  Initially set to -1. */
+    Py_uhash_t ob_hash;
     /* ob_item contains space for 'ob_size' elements.
        Items must normally not be NULL, except during construction when
        the tuple is not yet visible outside the function that builds it. */

Include/internal/pycore_tuple.h

@@ -8,6 +8,7 @@ extern "C" {
 #  error "this header requires Py_BUILD_CORE define"
 #endif
 
+#include "pycore_gc.h"            // _PyObject_GC_IS_TRACKED
 #include "pycore_structs.h"       // _PyStackRef
 
 extern void _PyTuple_MaybeUntrack(PyObject *);
@@ -32,6 +33,20 @@ typedef struct {
     PyTupleObject *it_seq; /* Set to NULL when iterator is exhausted */
 } _PyTupleIterObject;
 
+#define _PyTuple_RESET_HASH_CACHE(op) (_PyTuple_CAST(op)->ob_hash = -1)
+
+/*
+   bpo-42536: If reusing a tuple object, this should be called to re-track it
+   with the garbage collector and reset its hash cache. */
+static inline void
+_PyTuple_Recycle(PyObject *op)
+{
+    _PyTuple_RESET_HASH_CACHE(op);
+    if (!_PyObject_GC_IS_TRACKED(op)) {
+        _PyObject_GC_TRACK(op);
+    }
+}
+
 #ifdef __cplusplus
 }
 #endif