blob: a8ae41a7842aef4b49d7f3e960013f6a0212cea6 [file] [log] [blame]
Victor Stinnerc22bfaa2017-02-12 19:27:05 +01001#include "Python.h"
Victor Stinnerbcda8f12018-11-21 22:27:47 +01002#include "pycore_object.h"
Victor Stinnerbe434dc2019-11-05 00:51:22 +01003#include "pycore_pyerrors.h"
Victor Stinner621cebe2018-11-12 16:53:38 +01004#include "pycore_pystate.h"
Victor Stinnerec13b932018-11-25 23:56:17 +01005#include "pycore_tupleobject.h"
Victor Stinnerc22bfaa2017-02-12 19:27:05 +01006#include "frameobject.h"
7
8
Jeroen Demeyerd4efd912019-07-02 11:49:40 +02009static PyObject *const *
Victor Stinner17269092019-11-05 01:22:12 +010010_PyStack_UnpackDict(PyThreadState *tstate,
11 PyObject *const *args, Py_ssize_t nargs,
12 PyObject *kwargs, PyObject **p_kwnames);
Jeroen Demeyerd4efd912019-07-02 11:49:40 +020013
14static void
15_PyStack_UnpackDict_Free(PyObject *const *stack, Py_ssize_t nargs,
16 PyObject *kwnames);
17
Jeroen Demeyeraacc77f2019-05-29 20:31:52 +020018
Victor Stinnerc22bfaa2017-02-12 19:27:05 +010019static PyObject *
20null_error(void)
21{
22 if (!PyErr_Occurred())
23 PyErr_SetString(PyExc_SystemError,
24 "null argument to internal routine");
25 return NULL;
26}
27
28
29PyObject*
Victor Stinner17269092019-11-05 01:22:12 +010030_Py_CheckFunctionResult(PyThreadState *tstate, PyObject *callable,
31 PyObject *result, const char *where)
Victor Stinnerc22bfaa2017-02-12 19:27:05 +010032{
Victor Stinnerc22bfaa2017-02-12 19:27:05 +010033 assert((callable != NULL) ^ (where != NULL));
34
35 if (result == NULL) {
Victor Stinnerd12d0e72019-11-07 12:42:07 +010036 if (!_PyErr_Occurred(tstate)) {
Victor Stinnerc22bfaa2017-02-12 19:27:05 +010037 if (callable)
Victor Stinner17269092019-11-05 01:22:12 +010038 _PyErr_Format(tstate, PyExc_SystemError,
39 "%R returned NULL without setting an error",
40 callable);
Victor Stinnerc22bfaa2017-02-12 19:27:05 +010041 else
Victor Stinner17269092019-11-05 01:22:12 +010042 _PyErr_Format(tstate, PyExc_SystemError,
43 "%s returned NULL without setting an error",
44 where);
Victor Stinnerc22bfaa2017-02-12 19:27:05 +010045#ifdef Py_DEBUG
46 /* Ensure that the bug is caught in debug mode */
47 Py_FatalError("a function returned NULL without setting an error");
48#endif
49 return NULL;
50 }
51 }
52 else {
Victor Stinnerd12d0e72019-11-07 12:42:07 +010053 if (_PyErr_Occurred(tstate)) {
Victor Stinnerc22bfaa2017-02-12 19:27:05 +010054 Py_DECREF(result);
55
56 if (callable) {
Victor Stinner17269092019-11-05 01:22:12 +010057 _PyErr_FormatFromCauseTstate(
58 tstate, PyExc_SystemError,
59 "%R returned a result with an error set", callable);
Victor Stinnerc22bfaa2017-02-12 19:27:05 +010060 }
61 else {
Victor Stinner17269092019-11-05 01:22:12 +010062 _PyErr_FormatFromCauseTstate(
63 tstate, PyExc_SystemError,
64 "%s returned a result with an error set", where);
Victor Stinnerc22bfaa2017-02-12 19:27:05 +010065 }
66#ifdef Py_DEBUG
67 /* Ensure that the bug is caught in debug mode */
68 Py_FatalError("a function returned a result with an error set");
69#endif
70 return NULL;
71 }
72 }
73 return result;
74}
75
76
77/* --- Core PyObject call functions ------------------------------- */
78
Victor Stinner2ff58a22019-06-17 14:27:23 +020079/* Call a callable Python object without any arguments */
80PyObject *
81PyObject_CallNoArgs(PyObject *func)
82{
83 return _PyObject_CallNoArg(func);
84}
85
86
Victor Stinnerc22bfaa2017-02-12 19:27:05 +010087PyObject *
Jeroen Demeyeraacc77f2019-05-29 20:31:52 +020088_PyObject_FastCallDict(PyObject *callable, PyObject *const *args,
89 size_t nargsf, PyObject *kwargs)
Victor Stinnerc22bfaa2017-02-12 19:27:05 +010090{
Victor Stinner17269092019-11-05 01:22:12 +010091 assert(callable != NULL);
92
93 PyThreadState *tstate = _PyThreadState_GET();
Victor Stinnerc22bfaa2017-02-12 19:27:05 +010094 /* _PyObject_FastCallDict() must not be called with an exception set,
95 because it can clear it (directly or indirectly) and so the
96 caller loses its exception */
Victor Stinner17269092019-11-05 01:22:12 +010097 assert(!_PyErr_Occurred(tstate));
Jeroen Demeyeraacc77f2019-05-29 20:31:52 +020098
99 Py_ssize_t nargs = PyVectorcall_NARGS(nargsf);
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100100 assert(nargs >= 0);
101 assert(nargs == 0 || args != NULL);
102 assert(kwargs == NULL || PyDict_Check(kwargs));
103
Jeroen Demeyeraacc77f2019-05-29 20:31:52 +0200104 vectorcallfunc func = _PyVectorcall_Function(callable);
105 if (func == NULL) {
106 /* Use tp_call instead */
Victor Stinner7e433732019-11-08 10:05:17 +0100107 return _PyObject_MakeTpCall(tstate, callable, args, nargs, kwargs);
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100108 }
Jeroen Demeyeraacc77f2019-05-29 20:31:52 +0200109
110 PyObject *res;
Jeroen Demeyerd4efd912019-07-02 11:49:40 +0200111 if (kwargs == NULL || PyDict_GET_SIZE(kwargs) == 0) {
Jeroen Demeyeraacc77f2019-05-29 20:31:52 +0200112 res = func(callable, args, nargsf, NULL);
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100113 }
114 else {
Jeroen Demeyeraacc77f2019-05-29 20:31:52 +0200115 PyObject *kwnames;
116 PyObject *const *newargs;
Victor Stinner17269092019-11-05 01:22:12 +0100117 newargs = _PyStack_UnpackDict(tstate,
118 args, nargs,
119 kwargs, &kwnames);
Jeroen Demeyerd4efd912019-07-02 11:49:40 +0200120 if (newargs == NULL) {
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100121 return NULL;
122 }
Jeroen Demeyerd4efd912019-07-02 11:49:40 +0200123 res = func(callable, newargs,
124 nargs | PY_VECTORCALL_ARGUMENTS_OFFSET, kwnames);
125 _PyStack_UnpackDict_Free(newargs, nargs, kwnames);
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100126 }
Victor Stinner17269092019-11-05 01:22:12 +0100127 return _Py_CheckFunctionResult(tstate, callable, res, NULL);
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100128}
129
130
131PyObject *
Victor Stinner7e433732019-11-08 10:05:17 +0100132_PyObject_MakeTpCall(PyThreadState *tstate, PyObject *callable,
133 PyObject *const *args, Py_ssize_t nargs,
134 PyObject *keywords)
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100135{
Jeroen Demeyeraacc77f2019-05-29 20:31:52 +0200136 /* Slow path: build a temporary tuple for positional arguments and a
137 * temporary dictionary for keyword arguments (if any) */
138 ternaryfunc call = Py_TYPE(callable)->tp_call;
139 if (call == NULL) {
Victor Stinnerbe434dc2019-11-05 00:51:22 +0100140 _PyErr_Format(tstate, PyExc_TypeError,
141 "'%.200s' object is not callable",
142 Py_TYPE(callable)->tp_name);
Jeroen Demeyeraacc77f2019-05-29 20:31:52 +0200143 return NULL;
144 }
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100145
146 assert(nargs >= 0);
Jeroen Demeyeraacc77f2019-05-29 20:31:52 +0200147 assert(nargs == 0 || args != NULL);
148 assert(keywords == NULL || PyTuple_Check(keywords) || PyDict_Check(keywords));
149 PyObject *argstuple = _PyTuple_FromArray(args, nargs);
150 if (argstuple == NULL) {
151 return NULL;
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100152 }
Jeroen Demeyeraacc77f2019-05-29 20:31:52 +0200153
154 PyObject *kwdict;
155 if (keywords == NULL || PyDict_Check(keywords)) {
156 kwdict = keywords;
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100157 }
158 else {
Jeroen Demeyeraacc77f2019-05-29 20:31:52 +0200159 if (PyTuple_GET_SIZE(keywords)) {
160 assert(args != NULL);
161 kwdict = _PyStack_AsDict(args + nargs, keywords);
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100162 if (kwdict == NULL) {
163 Py_DECREF(argstuple);
164 return NULL;
165 }
166 }
167 else {
Jeroen Demeyeraacc77f2019-05-29 20:31:52 +0200168 keywords = kwdict = NULL;
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100169 }
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100170 }
Jeroen Demeyeraacc77f2019-05-29 20:31:52 +0200171
172 PyObject *result = NULL;
Victor Stinnerbe434dc2019-11-05 00:51:22 +0100173 if (_Py_EnterRecursiveCall(tstate, " while calling a Python object") == 0)
Jeroen Demeyeraacc77f2019-05-29 20:31:52 +0200174 {
175 result = call(callable, argstuple, kwdict);
Victor Stinnerbe434dc2019-11-05 00:51:22 +0100176 _Py_LeaveRecursiveCall(tstate);
Jeroen Demeyeraacc77f2019-05-29 20:31:52 +0200177 }
178
179 Py_DECREF(argstuple);
180 if (kwdict != keywords) {
181 Py_DECREF(kwdict);
182 }
183
Victor Stinner17269092019-11-05 01:22:12 +0100184 result = _Py_CheckFunctionResult(tstate, callable, result, NULL);
Jeroen Demeyeraacc77f2019-05-29 20:31:52 +0200185 return result;
186}
187
188
189PyObject *
190PyVectorcall_Call(PyObject *callable, PyObject *tuple, PyObject *kwargs)
191{
Victor Stinner17269092019-11-05 01:22:12 +0100192 PyThreadState *tstate = _PyThreadState_GET();
193
Petr Viktorinfb9423f2019-06-02 23:52:20 +0200194 /* get vectorcallfunc as in _PyVectorcall_Function, but without
195 * the _Py_TPFLAGS_HAVE_VECTORCALL check */
196 Py_ssize_t offset = Py_TYPE(callable)->tp_vectorcall_offset;
Jeroen Demeyera8b27e62019-06-24 12:41:05 +0200197 if (offset <= 0) {
Victor Stinner17269092019-11-05 01:22:12 +0100198 _PyErr_Format(tstate, PyExc_TypeError,
199 "'%.200s' object does not support vectorcall",
200 Py_TYPE(callable)->tp_name);
Petr Viktorinfb9423f2019-06-02 23:52:20 +0200201 return NULL;
202 }
203 vectorcallfunc func = *(vectorcallfunc *)(((char *)callable) + offset);
Jeroen Demeyeraacc77f2019-05-29 20:31:52 +0200204 if (func == NULL) {
Victor Stinner17269092019-11-05 01:22:12 +0100205 _PyErr_Format(tstate, PyExc_TypeError,
206 "'%.200s' object does not support vectorcall",
207 Py_TYPE(callable)->tp_name);
Jeroen Demeyeraacc77f2019-05-29 20:31:52 +0200208 return NULL;
209 }
Petr Viktorinfb9423f2019-06-02 23:52:20 +0200210
Jeroen Demeyeraacc77f2019-05-29 20:31:52 +0200211 Py_ssize_t nargs = PyTuple_GET_SIZE(tuple);
Jeroen Demeyerd4efd912019-07-02 11:49:40 +0200212
213 /* Fast path for no keywords */
214 if (kwargs == NULL || PyDict_GET_SIZE(kwargs) == 0) {
215 return func(callable, _PyTuple_ITEMS(tuple), nargs, NULL);
Jeroen Demeyeraacc77f2019-05-29 20:31:52 +0200216 }
217
Jeroen Demeyerd4efd912019-07-02 11:49:40 +0200218 /* Convert arguments & call */
219 PyObject *const *args;
220 PyObject *kwnames;
Victor Stinner17269092019-11-05 01:22:12 +0100221 args = _PyStack_UnpackDict(tstate,
222 _PyTuple_ITEMS(tuple), nargs,
223 kwargs, &kwnames);
Jeroen Demeyerd4efd912019-07-02 11:49:40 +0200224 if (args == NULL) {
225 return NULL;
226 }
227 PyObject *result = func(callable, args,
228 nargs | PY_VECTORCALL_ARGUMENTS_OFFSET, kwnames);
229 _PyStack_UnpackDict_Free(args, nargs, kwnames);
Victor Stinner17269092019-11-05 01:22:12 +0100230 return _Py_CheckFunctionResult(tstate, callable, result, NULL);
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100231}
232
233
234PyObject *
235PyObject_Call(PyObject *callable, PyObject *args, PyObject *kwargs)
236{
Victor Stinnerbe434dc2019-11-05 00:51:22 +0100237 PyThreadState *tstate = _PyThreadState_GET();
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100238 ternaryfunc call;
239 PyObject *result;
240
241 /* PyObject_Call() must not be called with an exception set,
242 because it can clear it (directly or indirectly) and so the
243 caller loses its exception */
Victor Stinnerbe434dc2019-11-05 00:51:22 +0100244 assert(!_PyErr_Occurred(tstate));
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100245 assert(PyTuple_Check(args));
246 assert(kwargs == NULL || PyDict_Check(kwargs));
247
Jeroen Demeyeraacc77f2019-05-29 20:31:52 +0200248 if (_PyVectorcall_Function(callable) != NULL) {
249 return PyVectorcall_Call(callable, args, kwargs);
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100250 }
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100251 else {
252 call = callable->ob_type->tp_call;
253 if (call == NULL) {
Victor Stinnerbe434dc2019-11-05 00:51:22 +0100254 _PyErr_Format(tstate, PyExc_TypeError,
255 "'%.200s' object is not callable",
256 callable->ob_type->tp_name);
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100257 return NULL;
258 }
259
Victor Stinnerbe434dc2019-11-05 00:51:22 +0100260 if (_Py_EnterRecursiveCall(tstate, " while calling a Python object")) {
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100261 return NULL;
Victor Stinnerbe434dc2019-11-05 00:51:22 +0100262 }
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100263
264 result = (*call)(callable, args, kwargs);
265
Victor Stinnerbe434dc2019-11-05 00:51:22 +0100266 _Py_LeaveRecursiveCall(tstate);
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100267
Victor Stinner17269092019-11-05 01:22:12 +0100268 return _Py_CheckFunctionResult(tstate, callable, result, NULL);
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100269 }
270}
271
272
Jeroen Demeyer7a6873c2019-09-11 13:01:01 +0200273PyObject *
274PyCFunction_Call(PyObject *callable, PyObject *args, PyObject *kwargs)
275{
276 return PyObject_Call(callable, args, kwargs);
277}
278
279
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100280/* --- PyFunction call functions ---------------------------------- */
281
282static PyObject* _Py_HOT_FUNCTION
Serhiy Storchakaa5552f02017-12-15 13:11:11 +0200283function_code_fastcall(PyCodeObject *co, PyObject *const *args, Py_ssize_t nargs,
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100284 PyObject *globals)
285{
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100286 assert(globals != NULL);
Victor Stinnerbe434dc2019-11-05 00:51:22 +0100287
288 PyThreadState *tstate = _PyThreadState_GET();
289 assert(tstate != NULL);
290
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100291 /* XXX Perhaps we should create a specialized
292 _PyFrame_New_NoTrack() that doesn't take locals, but does
293 take builtins without sanity checking them.
294 */
Victor Stinnerbe434dc2019-11-05 00:51:22 +0100295 PyFrameObject *f = _PyFrame_New_NoTrack(tstate, co, globals, NULL);
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100296 if (f == NULL) {
297 return NULL;
298 }
299
Victor Stinnerbe434dc2019-11-05 00:51:22 +0100300 PyObject **fastlocals = f->f_localsplus;
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100301
Victor Stinnerbe434dc2019-11-05 00:51:22 +0100302 for (Py_ssize_t i = 0; i < nargs; i++) {
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100303 Py_INCREF(*args);
304 fastlocals[i] = *args++;
305 }
Victor Stinnerbe434dc2019-11-05 00:51:22 +0100306 PyObject *result = PyEval_EvalFrameEx(f, 0);
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100307
308 if (Py_REFCNT(f) > 1) {
309 Py_DECREF(f);
310 _PyObject_GC_TRACK(f);
311 }
312 else {
313 ++tstate->recursion_depth;
314 Py_DECREF(f);
315 --tstate->recursion_depth;
316 }
317 return result;
318}
319
320
321PyObject *
Jeroen Demeyer37788bc2019-05-30 15:11:22 +0200322_PyFunction_Vectorcall(PyObject *func, PyObject* const* stack,
323 size_t nargsf, PyObject *kwnames)
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100324{
325 PyCodeObject *co = (PyCodeObject *)PyFunction_GET_CODE(func);
326 PyObject *globals = PyFunction_GET_GLOBALS(func);
327 PyObject *argdefs = PyFunction_GET_DEFAULTS(func);
328 PyObject *kwdefs, *closure, *name, *qualname;
329 PyObject **d;
330 Py_ssize_t nkwargs = (kwnames == NULL) ? 0 : PyTuple_GET_SIZE(kwnames);
331 Py_ssize_t nd;
332
333 assert(PyFunction_Check(func));
Jeroen Demeyeraacc77f2019-05-29 20:31:52 +0200334 Py_ssize_t nargs = PyVectorcall_NARGS(nargsf);
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100335 assert(nargs >= 0);
336 assert(kwnames == NULL || PyTuple_CheckExact(kwnames));
337 assert((nargs == 0 && nkwargs == 0) || stack != NULL);
Jeroen Demeyer05677862019-08-16 12:41:27 +0200338 /* kwnames must only contain strings and all keys must be unique */
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100339
340 if (co->co_kwonlyargcount == 0 && nkwargs == 0 &&
Victor Stinner086c3ae2017-10-25 05:26:17 -0700341 (co->co_flags & ~PyCF_MASK) == (CO_OPTIMIZED | CO_NEWLOCALS | CO_NOFREE))
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100342 {
Pablo Galindocd74e662019-06-01 18:08:04 +0100343 if (argdefs == NULL && co->co_argcount == nargs) {
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100344 return function_code_fastcall(co, stack, nargs, globals);
345 }
346 else if (nargs == 0 && argdefs != NULL
Pablo Galindocd74e662019-06-01 18:08:04 +0100347 && co->co_argcount == PyTuple_GET_SIZE(argdefs)) {
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100348 /* function called with no arguments, but all parameters have
349 a default value: use default values as arguments .*/
Victor Stinnerd17a6932018-11-09 16:56:48 +0100350 stack = _PyTuple_ITEMS(argdefs);
Serhiy Storchakafff9a312017-03-21 08:53:25 +0200351 return function_code_fastcall(co, stack, PyTuple_GET_SIZE(argdefs),
352 globals);
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100353 }
354 }
355
356 kwdefs = PyFunction_GET_KW_DEFAULTS(func);
357 closure = PyFunction_GET_CLOSURE(func);
358 name = ((PyFunctionObject *)func) -> func_name;
359 qualname = ((PyFunctionObject *)func) -> func_qualname;
360
361 if (argdefs != NULL) {
Victor Stinnerd17a6932018-11-09 16:56:48 +0100362 d = _PyTuple_ITEMS(argdefs);
Serhiy Storchakafff9a312017-03-21 08:53:25 +0200363 nd = PyTuple_GET_SIZE(argdefs);
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100364 }
365 else {
366 d = NULL;
367 nd = 0;
368 }
369 return _PyEval_EvalCodeWithName((PyObject*)co, globals, (PyObject *)NULL,
370 stack, nargs,
Victor Stinnerd17a6932018-11-09 16:56:48 +0100371 nkwargs ? _PyTuple_ITEMS(kwnames) : NULL,
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100372 stack + nargs,
373 nkwargs, 1,
374 d, (int)nd, kwdefs,
375 closure, name, qualname);
376}
377
378
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100379/* --- More complex call functions -------------------------------- */
380
381/* External interface to call any callable object.
382 The args must be a tuple or NULL. The kwargs must be a dict or NULL. */
383PyObject *
384PyEval_CallObjectWithKeywords(PyObject *callable,
385 PyObject *args, PyObject *kwargs)
386{
387#ifdef Py_DEBUG
388 /* PyEval_CallObjectWithKeywords() must not be called with an exception
389 set. It raises a new exception if parameters are invalid or if
390 PyTuple_New() fails, and so the original exception is lost. */
391 assert(!PyErr_Occurred());
392#endif
393
INADA Naoki3824cd82017-03-01 20:41:03 +0900394 if (args != NULL && !PyTuple_Check(args)) {
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100395 PyErr_SetString(PyExc_TypeError,
396 "argument list must be a tuple");
397 return NULL;
398 }
399
400 if (kwargs != NULL && !PyDict_Check(kwargs)) {
401 PyErr_SetString(PyExc_TypeError,
402 "keyword list must be a dictionary");
403 return NULL;
404 }
405
INADA Naoki3824cd82017-03-01 20:41:03 +0900406 if (args == NULL) {
407 return _PyObject_FastCallDict(callable, NULL, 0, kwargs);
408 }
409 else {
410 return PyObject_Call(callable, args, kwargs);
411 }
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100412}
413
414
415PyObject *
416PyObject_CallObject(PyObject *callable, PyObject *args)
417{
Jeroen Demeyer1dbd0842019-07-11 17:57:32 +0200418 assert(!PyErr_Occurred());
419 if (args == NULL) {
420 return _PyObject_CallNoArg(callable);
421 }
422 if (!PyTuple_Check(args)) {
423 PyErr_SetString(PyExc_TypeError,
424 "argument list must be a tuple");
425 return NULL;
426 }
427 return PyObject_Call(callable, args, NULL);
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100428}
429
430
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100431/* Call callable(obj, *args, **kwargs). */
432PyObject *
433_PyObject_Call_Prepend(PyObject *callable,
434 PyObject *obj, PyObject *args, PyObject *kwargs)
435{
436 PyObject *small_stack[_PY_FASTCALL_SMALL_STACK];
437 PyObject **stack;
438 Py_ssize_t argcount;
439 PyObject *result;
440
441 assert(PyTuple_Check(args));
442
443 argcount = PyTuple_GET_SIZE(args);
444 if (argcount + 1 <= (Py_ssize_t)Py_ARRAY_LENGTH(small_stack)) {
445 stack = small_stack;
446 }
447 else {
448 stack = PyMem_Malloc((argcount + 1) * sizeof(PyObject *));
449 if (stack == NULL) {
450 PyErr_NoMemory();
451 return NULL;
452 }
453 }
454
455 /* use borrowed references */
456 stack[0] = obj;
457 memcpy(&stack[1],
Victor Stinnerd17a6932018-11-09 16:56:48 +0100458 _PyTuple_ITEMS(args),
459 argcount * sizeof(PyObject *));
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100460
461 result = _PyObject_FastCallDict(callable,
462 stack, argcount + 1,
463 kwargs);
464 if (stack != small_stack) {
465 PyMem_Free(stack);
466 }
467 return result;
468}
469
470
471/* --- Call with a format string ---------------------------------- */
472
473static PyObject *
474_PyObject_CallFunctionVa(PyObject *callable, const char *format,
475 va_list va, int is_size_t)
476{
477 PyObject* small_stack[_PY_FASTCALL_SMALL_STACK];
478 const Py_ssize_t small_stack_len = Py_ARRAY_LENGTH(small_stack);
479 PyObject **stack;
480 Py_ssize_t nargs, i;
481 PyObject *result;
482
483 if (callable == NULL) {
484 return null_error();
485 }
486
487 if (!format || !*format) {
488 return _PyObject_CallNoArg(callable);
489 }
490
491 if (is_size_t) {
492 stack = _Py_VaBuildStack_SizeT(small_stack, small_stack_len,
493 format, va, &nargs);
494 }
495 else {
496 stack = _Py_VaBuildStack(small_stack, small_stack_len,
497 format, va, &nargs);
498 }
499 if (stack == NULL) {
500 return NULL;
501 }
502
503 if (nargs == 1 && PyTuple_Check(stack[0])) {
504 /* Special cases for backward compatibility:
505 - PyObject_CallFunction(func, "O", tuple) calls func(*tuple)
506 - PyObject_CallFunction(func, "(OOO)", arg1, arg2, arg3) calls
507 func(*(arg1, arg2, arg3)): func(arg1, arg2, arg3) */
508 PyObject *args = stack[0];
509 result = _PyObject_FastCall(callable,
Victor Stinnerd17a6932018-11-09 16:56:48 +0100510 _PyTuple_ITEMS(args),
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100511 PyTuple_GET_SIZE(args));
512 }
513 else {
514 result = _PyObject_FastCall(callable, stack, nargs);
515 }
516
517 for (i = 0; i < nargs; ++i) {
518 Py_DECREF(stack[i]);
519 }
520 if (stack != small_stack) {
521 PyMem_Free(stack);
522 }
523 return result;
524}
525
526
527PyObject *
528PyObject_CallFunction(PyObject *callable, const char *format, ...)
529{
530 va_list va;
531 PyObject *result;
532
533 va_start(va, format);
534 result = _PyObject_CallFunctionVa(callable, format, va, 0);
535 va_end(va);
536
537 return result;
538}
539
540
INADA Naokiaa289a52017-03-14 18:00:59 +0900541/* PyEval_CallFunction is exact copy of PyObject_CallFunction.
542 * This function is kept for backward compatibility.
543 */
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100544PyObject *
545PyEval_CallFunction(PyObject *callable, const char *format, ...)
546{
INADA Naokiaa289a52017-03-14 18:00:59 +0900547 va_list va;
548 PyObject *result;
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100549
INADA Naokiaa289a52017-03-14 18:00:59 +0900550 va_start(va, format);
551 result = _PyObject_CallFunctionVa(callable, format, va, 0);
552 va_end(va);
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100553
INADA Naokiaa289a52017-03-14 18:00:59 +0900554 return result;
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100555}
556
557
558PyObject *
559_PyObject_CallFunction_SizeT(PyObject *callable, const char *format, ...)
560{
561 va_list va;
562 PyObject *result;
563
564 va_start(va, format);
565 result = _PyObject_CallFunctionVa(callable, format, va, 1);
566 va_end(va);
567
568 return result;
569}
570
571
572static PyObject*
573callmethod(PyObject* callable, const char *format, va_list va, int is_size_t)
574{
575 assert(callable != NULL);
576
577 if (!PyCallable_Check(callable)) {
578 PyErr_Format(PyExc_TypeError,
579 "attribute of type '%.200s' is not callable",
580 Py_TYPE(callable)->tp_name);
581 return NULL;
582 }
583
584 return _PyObject_CallFunctionVa(callable, format, va, is_size_t);
585}
586
587
588PyObject *
589PyObject_CallMethod(PyObject *obj, const char *name, const char *format, ...)
590{
591 va_list va;
592 PyObject *callable, *retval;
593
594 if (obj == NULL || name == NULL) {
595 return null_error();
596 }
597
598 callable = PyObject_GetAttrString(obj, name);
599 if (callable == NULL)
600 return NULL;
601
602 va_start(va, format);
603 retval = callmethod(callable, format, va, 0);
604 va_end(va);
605
606 Py_DECREF(callable);
607 return retval;
608}
609
610
INADA Naokiaa289a52017-03-14 18:00:59 +0900611/* PyEval_CallMethod is exact copy of PyObject_CallMethod.
612 * This function is kept for backward compatibility.
613 */
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100614PyObject *
615PyEval_CallMethod(PyObject *obj, const char *name, const char *format, ...)
616{
INADA Naokiaa289a52017-03-14 18:00:59 +0900617 va_list va;
618 PyObject *callable, *retval;
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100619
INADA Naokiaa289a52017-03-14 18:00:59 +0900620 if (obj == NULL || name == NULL) {
621 return null_error();
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100622 }
623
INADA Naokiaa289a52017-03-14 18:00:59 +0900624 callable = PyObject_GetAttrString(obj, name);
625 if (callable == NULL)
626 return NULL;
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100627
INADA Naokiaa289a52017-03-14 18:00:59 +0900628 va_start(va, format);
629 retval = callmethod(callable, format, va, 0);
630 va_end(va);
631
632 Py_DECREF(callable);
633 return retval;
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100634}
635
636
637PyObject *
638_PyObject_CallMethodId(PyObject *obj, _Py_Identifier *name,
639 const char *format, ...)
640{
641 va_list va;
642 PyObject *callable, *retval;
643
644 if (obj == NULL || name == NULL) {
645 return null_error();
646 }
647
648 callable = _PyObject_GetAttrId(obj, name);
649 if (callable == NULL)
650 return NULL;
651
652 va_start(va, format);
653 retval = callmethod(callable, format, va, 0);
654 va_end(va);
655
656 Py_DECREF(callable);
657 return retval;
658}
659
660
661PyObject *
662_PyObject_CallMethod_SizeT(PyObject *obj, const char *name,
663 const char *format, ...)
664{
665 va_list va;
666 PyObject *callable, *retval;
667
668 if (obj == NULL || name == NULL) {
669 return null_error();
670 }
671
672 callable = PyObject_GetAttrString(obj, name);
673 if (callable == NULL)
674 return NULL;
675
676 va_start(va, format);
677 retval = callmethod(callable, format, va, 1);
678 va_end(va);
679
680 Py_DECREF(callable);
681 return retval;
682}
683
684
685PyObject *
686_PyObject_CallMethodId_SizeT(PyObject *obj, _Py_Identifier *name,
687 const char *format, ...)
688{
689 va_list va;
690 PyObject *callable, *retval;
691
692 if (obj == NULL || name == NULL) {
693 return null_error();
694 }
695
696 callable = _PyObject_GetAttrId(obj, name);
697 if (callable == NULL) {
698 return NULL;
699 }
700
701 va_start(va, format);
702 retval = callmethod(callable, format, va, 1);
703 va_end(va);
704
705 Py_DECREF(callable);
706 return retval;
707}
708
709
710/* --- Call with "..." arguments ---------------------------------- */
711
712static PyObject *
Michael J. Sullivan47dd2f92019-05-26 00:23:34 -0700713object_vacall(PyObject *base, PyObject *callable, va_list vargs)
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100714{
715 PyObject *small_stack[_PY_FASTCALL_SMALL_STACK];
716 PyObject **stack;
717 Py_ssize_t nargs;
718 PyObject *result;
719 Py_ssize_t i;
720 va_list countva;
721
722 if (callable == NULL) {
723 return null_error();
724 }
725
726 /* Count the number of arguments */
727 va_copy(countva, vargs);
Michael J. Sullivan47dd2f92019-05-26 00:23:34 -0700728 nargs = base ? 1 : 0;
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100729 while (1) {
730 PyObject *arg = va_arg(countva, PyObject *);
731 if (arg == NULL) {
732 break;
733 }
734 nargs++;
735 }
736 va_end(countva);
737
738 /* Copy arguments */
739 if (nargs <= (Py_ssize_t)Py_ARRAY_LENGTH(small_stack)) {
740 stack = small_stack;
741 }
742 else {
743 stack = PyMem_Malloc(nargs * sizeof(stack[0]));
744 if (stack == NULL) {
745 PyErr_NoMemory();
746 return NULL;
747 }
748 }
749
Michael J. Sullivan47dd2f92019-05-26 00:23:34 -0700750 i = 0;
751 if (base) {
752 stack[i++] = base;
753 }
754
755 for (; i < nargs; ++i) {
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100756 stack[i] = va_arg(vargs, PyObject *);
757 }
758
759 /* Call the function */
760 result = _PyObject_FastCall(callable, stack, nargs);
761
762 if (stack != small_stack) {
763 PyMem_Free(stack);
764 }
765 return result;
766}
767
768
Michael J. Sullivan47dd2f92019-05-26 00:23:34 -0700769PyObject *
Jeroen Demeyerb1263d52019-06-28 11:49:00 +0200770_PyObject_VectorcallMethod(PyObject *name, PyObject *const *args,
771 size_t nargsf, PyObject *kwnames)
772{
773 assert(name != NULL);
774 assert(args != NULL);
775 assert(PyVectorcall_NARGS(nargsf) >= 1);
776
Victor Stinner7e433732019-11-08 10:05:17 +0100777 PyThreadState *tstate = _PyThreadState_GET();
Jeroen Demeyerb1263d52019-06-28 11:49:00 +0200778 PyObject *callable = NULL;
779 /* Use args[0] as "self" argument */
780 int unbound = _PyObject_GetMethod(args[0], name, &callable);
781 if (callable == NULL) {
782 return NULL;
783 }
784
785 if (unbound) {
786 /* We must remove PY_VECTORCALL_ARGUMENTS_OFFSET since
787 * that would be interpreted as allowing to change args[-1] */
788 nargsf &= ~PY_VECTORCALL_ARGUMENTS_OFFSET;
789 }
790 else {
791 /* Skip "self". We can keep PY_VECTORCALL_ARGUMENTS_OFFSET since
792 * args[-1] in the onward call is args[0] here. */
793 args++;
794 nargsf--;
795 }
Victor Stinner7e433732019-11-08 10:05:17 +0100796 PyObject *result = _PyObject_VectorcallTstate(tstate, callable,
797 args, nargsf, kwnames);
Jeroen Demeyerb1263d52019-06-28 11:49:00 +0200798 Py_DECREF(callable);
799 return result;
800}
801
802
803PyObject *
Michael J. Sullivan47dd2f92019-05-26 00:23:34 -0700804PyObject_CallMethodObjArgs(PyObject *obj, PyObject *name, ...)
805{
806 if (obj == NULL || name == NULL) {
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100807 return null_error();
808 }
809
Michael J. Sullivan47dd2f92019-05-26 00:23:34 -0700810 PyObject *callable = NULL;
811 int is_method = _PyObject_GetMethod(obj, name, &callable);
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100812 if (callable == NULL) {
813 return NULL;
814 }
Michael J. Sullivan47dd2f92019-05-26 00:23:34 -0700815 obj = is_method ? obj : NULL;
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100816
Michael J. Sullivan47dd2f92019-05-26 00:23:34 -0700817 va_list vargs;
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100818 va_start(vargs, name);
Michael J. Sullivan47dd2f92019-05-26 00:23:34 -0700819 PyObject *result = object_vacall(obj, callable, vargs);
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100820 va_end(vargs);
821
822 Py_DECREF(callable);
823 return result;
824}
825
826
827PyObject *
828_PyObject_CallMethodIdObjArgs(PyObject *obj,
829 struct _Py_Identifier *name, ...)
830{
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100831 if (obj == NULL || name == NULL) {
832 return null_error();
833 }
834
Michael J. Sullivan47dd2f92019-05-26 00:23:34 -0700835 PyObject *oname = _PyUnicode_FromId(name); /* borrowed */
836 if (!oname) {
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100837 return NULL;
838 }
839
Michael J. Sullivan47dd2f92019-05-26 00:23:34 -0700840 PyObject *callable = NULL;
841 int is_method = _PyObject_GetMethod(obj, oname, &callable);
842 if (callable == NULL) {
843 return NULL;
844 }
845 obj = is_method ? obj : NULL;
846
847 va_list vargs;
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100848 va_start(vargs, name);
Michael J. Sullivan47dd2f92019-05-26 00:23:34 -0700849 PyObject *result = object_vacall(obj, callable, vargs);
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100850 va_end(vargs);
851
852 Py_DECREF(callable);
853 return result;
854}
855
856
857PyObject *
858PyObject_CallFunctionObjArgs(PyObject *callable, ...)
859{
860 va_list vargs;
861 PyObject *result;
862
863 va_start(vargs, callable);
Michael J. Sullivan47dd2f92019-05-26 00:23:34 -0700864 result = object_vacall(NULL, callable, vargs);
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100865 va_end(vargs);
866
867 return result;
868}
869
870
871/* --- PyStack functions ------------------------------------------ */
872
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100873PyObject *
Serhiy Storchakaa5552f02017-12-15 13:11:11 +0200874_PyStack_AsDict(PyObject *const *values, PyObject *kwnames)
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100875{
876 Py_ssize_t nkwargs;
877 PyObject *kwdict;
878 Py_ssize_t i;
879
880 assert(kwnames != NULL);
881 nkwargs = PyTuple_GET_SIZE(kwnames);
882 kwdict = _PyDict_NewPresized(nkwargs);
883 if (kwdict == NULL) {
884 return NULL;
885 }
886
887 for (i = 0; i < nkwargs; i++) {
888 PyObject *key = PyTuple_GET_ITEM(kwnames, i);
889 PyObject *value = *values++;
890 /* If key already exists, replace it with the new value */
891 if (PyDict_SetItem(kwdict, key, value)) {
892 Py_DECREF(kwdict);
893 return NULL;
894 }
895 }
896 return kwdict;
897}
898
899
Jeroen Demeyerd4efd912019-07-02 11:49:40 +0200900/* Convert (args, nargs, kwargs: dict) into a (stack, nargs, kwnames: tuple).
901
902 Allocate a new argument vector and keyword names tuple. Return the argument
903 vector; return NULL with exception set on error. Return the keyword names
904 tuple in *p_kwnames.
905
Jeroen Demeyer05677862019-08-16 12:41:27 +0200906 This also checks that all keyword names are strings. If not, a TypeError is
907 raised.
908
Jeroen Demeyerd4efd912019-07-02 11:49:40 +0200909 The newly allocated argument vector supports PY_VECTORCALL_ARGUMENTS_OFFSET.
910
Jeroen Demeyer05677862019-08-16 12:41:27 +0200911 When done, you must call _PyStack_UnpackDict_Free(stack, nargs, kwnames) */
Jeroen Demeyerd4efd912019-07-02 11:49:40 +0200912static PyObject *const *
Victor Stinner17269092019-11-05 01:22:12 +0100913_PyStack_UnpackDict(PyThreadState *tstate,
914 PyObject *const *args, Py_ssize_t nargs,
915 PyObject *kwargs, PyObject **p_kwnames)
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100916{
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100917 assert(nargs >= 0);
Jeroen Demeyerd4efd912019-07-02 11:49:40 +0200918 assert(kwargs != NULL);
919 assert(PyDict_Check(kwargs));
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100920
Jeroen Demeyerd4efd912019-07-02 11:49:40 +0200921 Py_ssize_t nkwargs = PyDict_GET_SIZE(kwargs);
922 /* Check for overflow in the PyMem_Malloc() call below. The subtraction
923 * in this check cannot overflow: both maxnargs and nkwargs are
924 * non-negative signed integers, so their difference fits in the type. */
925 Py_ssize_t maxnargs = PY_SSIZE_T_MAX / sizeof(args[0]) - 1;
926 if (nargs > maxnargs - nkwargs) {
Victor Stinner17269092019-11-05 01:22:12 +0100927 _PyErr_NoMemory(tstate);
Jeroen Demeyerd4efd912019-07-02 11:49:40 +0200928 return NULL;
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100929 }
930
Jeroen Demeyerd4efd912019-07-02 11:49:40 +0200931 /* Add 1 to support PY_VECTORCALL_ARGUMENTS_OFFSET */
932 PyObject **stack = PyMem_Malloc((1 + nargs + nkwargs) * sizeof(args[0]));
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100933 if (stack == NULL) {
Victor Stinner17269092019-11-05 01:22:12 +0100934 _PyErr_NoMemory(tstate);
Jeroen Demeyerd4efd912019-07-02 11:49:40 +0200935 return NULL;
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100936 }
937
Jeroen Demeyerd4efd912019-07-02 11:49:40 +0200938 PyObject *kwnames = PyTuple_New(nkwargs);
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100939 if (kwnames == NULL) {
940 PyMem_Free(stack);
Jeroen Demeyerd4efd912019-07-02 11:49:40 +0200941 return NULL;
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100942 }
943
Jeroen Demeyerd4efd912019-07-02 11:49:40 +0200944 stack++; /* For PY_VECTORCALL_ARGUMENTS_OFFSET */
945
Jeroen Demeyer77aa3962019-05-22 13:09:35 +0200946 /* Copy positional arguments */
Jeroen Demeyerd4efd912019-07-02 11:49:40 +0200947 for (Py_ssize_t i = 0; i < nargs; i++) {
Jeroen Demeyer77aa3962019-05-22 13:09:35 +0200948 Py_INCREF(args[i]);
949 stack[i] = args[i];
950 }
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100951
Jeroen Demeyerd4efd912019-07-02 11:49:40 +0200952 PyObject **kwstack = stack + nargs;
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100953 /* This loop doesn't support lookup function mutating the dictionary
954 to change its size. It's a deliberate choice for speed, this function is
955 called in the performance critical hot code. */
Jeroen Demeyerd4efd912019-07-02 11:49:40 +0200956 Py_ssize_t pos = 0, i = 0;
957 PyObject *key, *value;
Jeroen Demeyer05677862019-08-16 12:41:27 +0200958 unsigned long keys_are_strings = Py_TPFLAGS_UNICODE_SUBCLASS;
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100959 while (PyDict_Next(kwargs, &pos, &key, &value)) {
Jeroen Demeyer05677862019-08-16 12:41:27 +0200960 keys_are_strings &= Py_TYPE(key)->tp_flags;
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100961 Py_INCREF(key);
Jeroen Demeyer77aa3962019-05-22 13:09:35 +0200962 Py_INCREF(value);
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100963 PyTuple_SET_ITEM(kwnames, i, key);
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100964 kwstack[i] = value;
965 i++;
966 }
967
Jeroen Demeyer05677862019-08-16 12:41:27 +0200968 /* keys_are_strings has the value Py_TPFLAGS_UNICODE_SUBCLASS if that
969 * flag is set for all keys. Otherwise, keys_are_strings equals 0.
970 * We do this check once at the end instead of inside the loop above
971 * because it simplifies the deallocation in the failing case.
972 * It happens to also make the loop above slightly more efficient. */
973 if (!keys_are_strings) {
Victor Stinner17269092019-11-05 01:22:12 +0100974 _PyErr_SetString(tstate, PyExc_TypeError,
975 "keywords must be strings");
Jeroen Demeyer05677862019-08-16 12:41:27 +0200976 _PyStack_UnpackDict_Free(stack, nargs, kwnames);
977 return NULL;
978 }
979
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100980 *p_kwnames = kwnames;
Jeroen Demeyerd4efd912019-07-02 11:49:40 +0200981 return stack;
982}
983
984static void
985_PyStack_UnpackDict_Free(PyObject *const *stack, Py_ssize_t nargs,
986 PyObject *kwnames)
987{
988 Py_ssize_t n = PyTuple_GET_SIZE(kwnames) + nargs;
989 for (Py_ssize_t i = 0; i < n; i++) {
990 Py_DECREF(stack[i]);
991 }
992 PyMem_Free((PyObject **)stack - 1);
993 Py_DECREF(kwnames);
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100994}