File size: 8,587 Bytes
db4a26f |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 |
#ifndef PY_MODULE_CPP
#define PY_MODULE_CPP
#include "greenlet_internal.hpp"
#include "TGreenletGlobals.cpp"
#include "TMainGreenlet.cpp"
#include "TThreadStateDestroy.cpp"
using greenlet::LockGuard;
using greenlet::ThreadState;
#ifdef __clang__
# pragma clang diagnostic push
# pragma clang diagnostic ignored "-Wunused-function"
# pragma clang diagnostic ignored "-Wunused-variable"
#endif
PyDoc_STRVAR(mod_getcurrent_doc,
"getcurrent() -> greenlet\n"
"\n"
"Returns the current greenlet (i.e. the one which called this "
"function).\n");
static PyObject*
mod_getcurrent(PyObject* UNUSED(module))
{
return GET_THREAD_STATE().state().get_current().relinquish_ownership_o();
}
PyDoc_STRVAR(mod_settrace_doc,
"settrace(callback) -> object\n"
"\n"
"Sets a new tracing function and returns the previous one.\n");
static PyObject*
mod_settrace(PyObject* UNUSED(module), PyObject* args)
{
PyArgParseParam tracefunc;
if (!PyArg_ParseTuple(args, "O", &tracefunc)) {
return NULL;
}
ThreadState& state = GET_THREAD_STATE();
OwnedObject previous = state.get_tracefunc();
if (!previous) {
previous = Py_None;
}
state.set_tracefunc(tracefunc);
return previous.relinquish_ownership();
}
PyDoc_STRVAR(mod_gettrace_doc,
"gettrace() -> object\n"
"\n"
"Returns the currently set tracing function, or None.\n");
static PyObject*
mod_gettrace(PyObject* UNUSED(module))
{
OwnedObject tracefunc = GET_THREAD_STATE().state().get_tracefunc();
if (!tracefunc) {
tracefunc = Py_None;
}
return tracefunc.relinquish_ownership();
}
PyDoc_STRVAR(mod_set_thread_local_doc,
"set_thread_local(key, value) -> None\n"
"\n"
"Set a value in the current thread-local dictionary. Debugging only.\n");
static PyObject*
mod_set_thread_local(PyObject* UNUSED(module), PyObject* args)
{
PyArgParseParam key;
PyArgParseParam value;
PyObject* result = NULL;
if (PyArg_UnpackTuple(args, "set_thread_local", 2, 2, &key, &value)) {
if(PyDict_SetItem(
PyThreadState_GetDict(), // borrow
key,
value) == 0 ) {
// success
Py_INCREF(Py_None);
result = Py_None;
}
}
return result;
}
PyDoc_STRVAR(mod_get_pending_cleanup_count_doc,
"get_pending_cleanup_count() -> Integer\n"
"\n"
"Get the number of greenlet cleanup operations pending. Testing only.\n");
static PyObject*
mod_get_pending_cleanup_count(PyObject* UNUSED(module))
{
LockGuard cleanup_lock(*mod_globs->thread_states_to_destroy_lock);
return PyLong_FromSize_t(mod_globs->thread_states_to_destroy.size());
}
PyDoc_STRVAR(mod_get_total_main_greenlets_doc,
"get_total_main_greenlets() -> Integer\n"
"\n"
"Quickly return the number of main greenlets that exist. Testing only.\n");
static PyObject*
mod_get_total_main_greenlets(PyObject* UNUSED(module))
{
return PyLong_FromSize_t(G_TOTAL_MAIN_GREENLETS);
}
PyDoc_STRVAR(mod_get_clocks_used_doing_optional_cleanup_doc,
"get_clocks_used_doing_optional_cleanup() -> Integer\n"
"\n"
"Get the number of clock ticks the program has used doing optional "
"greenlet cleanup.\n"
"Beginning in greenlet 2.0, greenlet tries to find and dispose of greenlets\n"
"that leaked after a thread exited. This requires invoking Python's garbage collector,\n"
"which may have a performance cost proportional to the number of live objects.\n"
"This function returns the amount of processor time\n"
"greenlet has used to do this. In programs that run with very large amounts of live\n"
"objects, this metric can be used to decide whether the cost of doing this cleanup\n"
"is worth the memory leak being corrected. If not, you can disable the cleanup\n"
"using ``enable_optional_cleanup(False)``.\n"
"The units are arbitrary and can only be compared to themselves (similarly to ``time.clock()``);\n"
"for example, to see how it scales with your heap. You can attempt to convert them into seconds\n"
"by dividing by the value of CLOCKS_PER_SEC."
"If cleanup has been disabled, returns None."
"\n"
"This is an implementation specific, provisional API. It may be changed or removed\n"
"in the future.\n"
".. versionadded:: 2.0"
);
static PyObject*
mod_get_clocks_used_doing_optional_cleanup(PyObject* UNUSED(module))
{
std::clock_t& clocks = ThreadState::clocks_used_doing_gc();
if (clocks == std::clock_t(-1)) {
Py_RETURN_NONE;
}
// This might not actually work on some implementations; clock_t
// is an opaque type.
return PyLong_FromSsize_t(clocks);
}
PyDoc_STRVAR(mod_enable_optional_cleanup_doc,
"mod_enable_optional_cleanup(bool) -> None\n"
"\n"
"Enable or disable optional cleanup operations.\n"
"See ``get_clocks_used_doing_optional_cleanup()`` for details.\n"
);
static PyObject*
mod_enable_optional_cleanup(PyObject* UNUSED(module), PyObject* flag)
{
int is_true = PyObject_IsTrue(flag);
if (is_true == -1) {
return nullptr;
}
std::clock_t& clocks = ThreadState::clocks_used_doing_gc();
if (is_true) {
// If we already have a value, we don't want to lose it.
if (clocks == std::clock_t(-1)) {
clocks = 0;
}
}
else {
clocks = std::clock_t(-1);
}
Py_RETURN_NONE;
}
#if !GREENLET_PY313
PyDoc_STRVAR(mod_get_tstate_trash_delete_nesting_doc,
"get_tstate_trash_delete_nesting() -> Integer\n"
"\n"
"Return the 'trash can' nesting level. Testing only.\n");
static PyObject*
mod_get_tstate_trash_delete_nesting(PyObject* UNUSED(module))
{
PyThreadState* tstate = PyThreadState_GET();
#if GREENLET_PY312
return PyLong_FromLong(tstate->trash.delete_nesting);
#else
return PyLong_FromLong(tstate->trash_delete_nesting);
#endif
}
#endif
static PyMethodDef GreenMethods[] = {
{
.ml_name="getcurrent",
.ml_meth=(PyCFunction)mod_getcurrent,
.ml_flags=METH_NOARGS,
.ml_doc=mod_getcurrent_doc
},
{
.ml_name="settrace",
.ml_meth=(PyCFunction)mod_settrace,
.ml_flags=METH_VARARGS,
.ml_doc=mod_settrace_doc
},
{
.ml_name="gettrace",
.ml_meth=(PyCFunction)mod_gettrace,
.ml_flags=METH_NOARGS,
.ml_doc=mod_gettrace_doc
},
{
.ml_name="set_thread_local",
.ml_meth=(PyCFunction)mod_set_thread_local,
.ml_flags=METH_VARARGS,
.ml_doc=mod_set_thread_local_doc
},
{
.ml_name="get_pending_cleanup_count",
.ml_meth=(PyCFunction)mod_get_pending_cleanup_count,
.ml_flags=METH_NOARGS,
.ml_doc=mod_get_pending_cleanup_count_doc
},
{
.ml_name="get_total_main_greenlets",
.ml_meth=(PyCFunction)mod_get_total_main_greenlets,
.ml_flags=METH_NOARGS,
.ml_doc=mod_get_total_main_greenlets_doc
},
{
.ml_name="get_clocks_used_doing_optional_cleanup",
.ml_meth=(PyCFunction)mod_get_clocks_used_doing_optional_cleanup,
.ml_flags=METH_NOARGS,
.ml_doc=mod_get_clocks_used_doing_optional_cleanup_doc
},
{
.ml_name="enable_optional_cleanup",
.ml_meth=(PyCFunction)mod_enable_optional_cleanup,
.ml_flags=METH_O,
.ml_doc=mod_enable_optional_cleanup_doc
},
#if !GREENLET_PY313
{
.ml_name="get_tstate_trash_delete_nesting",
.ml_meth=(PyCFunction)mod_get_tstate_trash_delete_nesting,
.ml_flags=METH_NOARGS,
.ml_doc=mod_get_tstate_trash_delete_nesting_doc
},
#endif
{.ml_name=NULL, .ml_meth=NULL} /* Sentinel */
};
static const char* const copy_on_greentype[] = {
"getcurrent",
"error",
"GreenletExit",
"settrace",
"gettrace",
NULL
};
static struct PyModuleDef greenlet_module_def = {
.m_base=PyModuleDef_HEAD_INIT,
.m_name="greenlet._greenlet",
.m_doc=NULL,
.m_size=-1,
.m_methods=GreenMethods,
};
#endif
#ifdef __clang__
# pragma clang diagnostic pop
#elif defined(__GNUC__)
# pragma GCC diagnostic pop
#endif
|