|
| 1 | +// Copyright (c) 2024 The Pybind Development Team. |
| 2 | +// All rights reserved. Use of this source code is governed by a |
| 3 | +// BSD-style license that can be found in the LICENSE file. |
| 4 | + |
| 5 | +// For background see the description of PR google/pywrapcc#30099. |
| 6 | + |
| 7 | +#pragma once |
| 8 | + |
| 9 | +#include "../attr.h" |
| 10 | +#include "../pytypes.h" |
| 11 | +#include "common.h" |
| 12 | + |
| 13 | +#include <cstring> |
| 14 | + |
| 15 | +PYBIND11_NAMESPACE_BEGIN(PYBIND11_NAMESPACE) |
| 16 | +PYBIND11_NAMESPACE_BEGIN(detail) |
| 17 | + |
| 18 | +struct function_record_PyObject { |
| 19 | + PyObject_HEAD |
| 20 | + function_record *cpp_func_rec; |
| 21 | +}; |
| 22 | + |
| 23 | +PYBIND11_NAMESPACE_BEGIN(function_record_PyTypeObject_methods) |
| 24 | + |
| 25 | +PyObject *tp_new_impl(PyTypeObject *type, PyObject *args, PyObject *kwds); |
| 26 | +PyObject *tp_alloc_impl(PyTypeObject *type, Py_ssize_t nitems); |
| 27 | +int tp_init_impl(PyObject *self, PyObject *args, PyObject *kwds); |
| 28 | +void tp_dealloc_impl(PyObject *self); |
| 29 | +void tp_free_impl(void *self); |
| 30 | + |
| 31 | +static PyObject *reduce_ex_impl(PyObject *self, PyObject *, PyObject *); |
| 32 | + |
| 33 | +PYBIND11_WARNING_PUSH |
| 34 | +#if defined(__GNUC__) && __GNUC__ >= 8 |
| 35 | +PYBIND11_WARNING_DISABLE_GCC("-Wcast-function-type") |
| 36 | +#endif |
| 37 | +static PyMethodDef tp_methods_impl[] |
| 38 | + = {{"__reduce_ex__", (PyCFunction) reduce_ex_impl, METH_VARARGS | METH_KEYWORDS, nullptr}, |
| 39 | + {nullptr, nullptr, 0, nullptr}}; |
| 40 | +PYBIND11_WARNING_POP |
| 41 | + |
| 42 | +// Note that this name is versioned. |
| 43 | +constexpr char tp_name_impl[] |
| 44 | + = "pybind11_detail_function_record_" PYBIND11_DETAIL_FUNCTION_RECORD_ABI_ID |
| 45 | + "_" PYBIND11_PLATFORM_ABI_ID_V4; |
| 46 | + |
| 47 | +PYBIND11_NAMESPACE_END(function_record_PyTypeObject_methods) |
| 48 | + |
| 49 | +// Designated initializers are a C++20 feature: |
| 50 | +// https://en.cppreference.com/w/cpp/language/aggregate_initialization#Designated_initializers |
| 51 | +// MSVC rejects them unless /std:c++20 is used (error code C7555). |
| 52 | +PYBIND11_WARNING_PUSH |
| 53 | +PYBIND11_WARNING_DISABLE_CLANG("-Wmissing-field-initializers") |
| 54 | +#if defined(__GNUC__) && __GNUC__ >= 8 |
| 55 | +PYBIND11_WARNING_DISABLE_GCC("-Wmissing-field-initializers") |
| 56 | +#endif |
| 57 | +static PyTypeObject function_record_PyTypeObject = { |
| 58 | + PyVarObject_HEAD_INIT(nullptr, 0) |
| 59 | + /* const char *tp_name */ function_record_PyTypeObject_methods::tp_name_impl, |
| 60 | + /* Py_ssize_t tp_basicsize */ sizeof(function_record_PyObject), |
| 61 | + /* Py_ssize_t tp_itemsize */ 0, |
| 62 | + /* destructor tp_dealloc */ function_record_PyTypeObject_methods::tp_dealloc_impl, |
| 63 | + /* Py_ssize_t tp_vectorcall_offset */ 0, |
| 64 | + /* getattrfunc tp_getattr */ nullptr, |
| 65 | + /* setattrfunc tp_setattr */ nullptr, |
| 66 | + /* PyAsyncMethods *tp_as_async */ nullptr, |
| 67 | + /* reprfunc tp_repr */ nullptr, |
| 68 | + /* PyNumberMethods *tp_as_number */ nullptr, |
| 69 | + /* PySequenceMethods *tp_as_sequence */ nullptr, |
| 70 | + /* PyMappingMethods *tp_as_mapping */ nullptr, |
| 71 | + /* hashfunc tp_hash */ nullptr, |
| 72 | + /* ternaryfunc tp_call */ nullptr, |
| 73 | + /* reprfunc tp_str */ nullptr, |
| 74 | + /* getattrofunc tp_getattro */ nullptr, |
| 75 | + /* setattrofunc tp_setattro */ nullptr, |
| 76 | + /* PyBufferProcs *tp_as_buffer */ nullptr, |
| 77 | + /* unsigned long tp_flags */ Py_TPFLAGS_DEFAULT, |
| 78 | + /* const char *tp_doc */ nullptr, |
| 79 | + /* traverseproc tp_traverse */ nullptr, |
| 80 | + /* inquiry tp_clear */ nullptr, |
| 81 | + /* richcmpfunc tp_richcompare */ nullptr, |
| 82 | + /* Py_ssize_t tp_weaklistoffset */ 0, |
| 83 | + /* getiterfunc tp_iter */ nullptr, |
| 84 | + /* iternextfunc tp_iternext */ nullptr, |
| 85 | + /* struct PyMethodDef *tp_methods */ function_record_PyTypeObject_methods::tp_methods_impl, |
| 86 | + /* struct PyMemberDef *tp_members */ nullptr, |
| 87 | + /* struct PyGetSetDef *tp_getset */ nullptr, |
| 88 | + /* struct _typeobject *tp_base */ nullptr, |
| 89 | + /* PyObject *tp_dict */ nullptr, |
| 90 | + /* descrgetfunc tp_descr_get */ nullptr, |
| 91 | + /* descrsetfunc tp_descr_set */ nullptr, |
| 92 | + /* Py_ssize_t tp_dictoffset */ 0, |
| 93 | + /* initproc tp_init */ function_record_PyTypeObject_methods::tp_init_impl, |
| 94 | + /* allocfunc tp_alloc */ function_record_PyTypeObject_methods::tp_alloc_impl, |
| 95 | + /* newfunc tp_new */ function_record_PyTypeObject_methods::tp_new_impl, |
| 96 | + /* freefunc tp_free */ function_record_PyTypeObject_methods::tp_free_impl, |
| 97 | + /* inquiry tp_is_gc */ nullptr, |
| 98 | + /* PyObject *tp_bases */ nullptr, |
| 99 | + /* PyObject *tp_mro */ nullptr, |
| 100 | + /* PyObject *tp_cache */ nullptr, |
| 101 | + /* PyObject *tp_subclasses */ nullptr, |
| 102 | + /* PyObject *tp_weaklist */ nullptr, |
| 103 | + /* destructor tp_del */ nullptr, |
| 104 | + /* unsigned int tp_version_tag */ 0, |
| 105 | + /* destructor tp_finalize */ nullptr, |
| 106 | +#if PY_VERSION_HEX >= 0x03080000 |
| 107 | + /* vectorcallfunc tp_vectorcall */ nullptr, |
| 108 | +#endif |
| 109 | +}; |
| 110 | +PYBIND11_WARNING_POP |
| 111 | + |
| 112 | +static bool function_record_PyTypeObject_PyType_Ready_first_call = true; |
| 113 | + |
| 114 | +inline void function_record_PyTypeObject_PyType_Ready() { |
| 115 | + if (function_record_PyTypeObject_PyType_Ready_first_call) { |
| 116 | + if (PyType_Ready(&function_record_PyTypeObject) < 0) { |
| 117 | + throw error_already_set(); |
| 118 | + } |
| 119 | + function_record_PyTypeObject_PyType_Ready_first_call = false; |
| 120 | + } |
| 121 | +} |
| 122 | + |
| 123 | +inline bool is_function_record_PyObject(PyObject *obj) { |
| 124 | + if (PyType_Check(obj) != 0) { |
| 125 | + return false; |
| 126 | + } |
| 127 | + PyTypeObject *obj_type = Py_TYPE(obj); |
| 128 | + // Fast path (pointer comparison). |
| 129 | + if (obj_type == &function_record_PyTypeObject) { |
| 130 | + return true; |
| 131 | + } |
| 132 | + // This works across extension modules. Note that tp_name is versioned. |
| 133 | + if (strcmp(obj_type->tp_name, function_record_PyTypeObject.tp_name) == 0) { |
| 134 | + return true; |
| 135 | + } |
| 136 | + return false; |
| 137 | +} |
| 138 | + |
| 139 | +inline function_record *function_record_ptr_from_PyObject(PyObject *obj) { |
| 140 | + if (is_function_record_PyObject(obj)) { |
| 141 | + return ((detail::function_record_PyObject *) obj)->cpp_func_rec; |
| 142 | + } |
| 143 | + return nullptr; |
| 144 | +} |
| 145 | + |
| 146 | +inline object function_record_PyObject_New() { |
| 147 | + auto *py_func_rec = PyObject_New(function_record_PyObject, &function_record_PyTypeObject); |
| 148 | + if (py_func_rec == nullptr) { |
| 149 | + throw error_already_set(); |
| 150 | + } |
| 151 | + py_func_rec->cpp_func_rec = nullptr; // For clarity/purity. Redundant in practice. |
| 152 | + return reinterpret_steal<object>((PyObject *) py_func_rec); |
| 153 | +} |
| 154 | + |
| 155 | +PYBIND11_NAMESPACE_BEGIN(function_record_PyTypeObject_methods) |
| 156 | + |
| 157 | +// Guard against accidents & oversights, in particular when porting to future Python versions. |
| 158 | +inline PyObject *tp_new_impl(PyTypeObject *, PyObject *, PyObject *) { |
| 159 | + pybind11_fail("UNEXPECTED CALL OF function_record_PyTypeObject_methods::tp_new_impl"); |
| 160 | + // return nullptr; // Unreachable. |
| 161 | +} |
| 162 | + |
| 163 | +inline PyObject *tp_alloc_impl(PyTypeObject *, Py_ssize_t) { |
| 164 | + pybind11_fail("UNEXPECTED CALL OF function_record_PyTypeObject_methods::tp_alloc_impl"); |
| 165 | + // return nullptr; // Unreachable. |
| 166 | +} |
| 167 | + |
| 168 | +inline int tp_init_impl(PyObject *, PyObject *, PyObject *) { |
| 169 | + pybind11_fail("UNEXPECTED CALL OF function_record_PyTypeObject_methods::tp_init_impl"); |
| 170 | + // return -1; // Unreachable. |
| 171 | +} |
| 172 | + |
| 173 | +// The implementation needs the definition of `class cpp_function`. |
| 174 | +void tp_dealloc_impl(PyObject *self); |
| 175 | + |
| 176 | +inline void tp_free_impl(void *) { |
| 177 | + pybind11_fail("UNEXPECTED CALL OF function_record_PyTypeObject_methods::tp_free_impl"); |
| 178 | +} |
| 179 | + |
| 180 | +inline PyObject *reduce_ex_impl(PyObject *self, PyObject *, PyObject *) { |
| 181 | + // Deliberately ignoring the arguments for simplicity (expected is `protocol: int`). |
| 182 | + const function_record *rec = function_record_ptr_from_PyObject(self); |
| 183 | + if (rec == nullptr) { |
| 184 | + pybind11_fail( |
| 185 | + "FATAL: function_record_PyTypeObject reduce_ex_impl(): cannot obtain cpp_func_rec."); |
| 186 | + } |
| 187 | + if (rec->name != nullptr && rec->name[0] != '\0' && rec->scope |
| 188 | + && PyModule_Check(rec->scope.ptr()) != 0) { |
| 189 | + object scope_module = get_scope_module(rec->scope); |
| 190 | + if (scope_module) { |
| 191 | + return make_tuple(reinterpret_borrow<object>(PyEval_GetBuiltins())["eval"], |
| 192 | + make_tuple(str("__import__('importlib').import_module('") |
| 193 | + + scope_module + str("')"))) |
| 194 | + .release() |
| 195 | + .ptr(); |
| 196 | + } |
| 197 | + } |
| 198 | + set_error(PyExc_RuntimeError, repr(self) + str(" is not pickleable.")); |
| 199 | + return nullptr; |
| 200 | +} |
| 201 | + |
| 202 | +PYBIND11_NAMESPACE_END(function_record_PyTypeObject_methods) |
| 203 | + |
| 204 | +PYBIND11_NAMESPACE_END(detail) |
| 205 | +PYBIND11_NAMESPACE_END(PYBIND11_NAMESPACE) |
0 commit comments