blob: 8a60b3e58e30356deea50b3f737f70f63abe7dfb [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 Stinner621cebe2018-11-12 16:53:38 +01003#include "pycore_pystate.h"
Victor Stinnerec13b932018-11-25 23:56:17 +01004#include "pycore_tupleobject.h"
Victor Stinnerc22bfaa2017-02-12 19:27:05 +01005#include "frameobject.h"
6
7
Jeroen Demeyeraacc77f2019-05-29 20:31:52 +02008static PyObject *
9cfunction_call_varargs(PyObject *func, PyObject *args, PyObject *kwargs);
10
Jeroen Demeyerd4efd912019-07-02 11:49:40 +020011static PyObject *const *
12_PyStack_UnpackDict(PyObject *const *args, Py_ssize_t nargs, PyObject *kwargs,
13 PyObject **p_kwnames);
14
15static void
16_PyStack_UnpackDict_Free(PyObject *const *stack, Py_ssize_t nargs,
17 PyObject *kwnames);
18
Jeroen Demeyeraacc77f2019-05-29 20:31:52 +020019
Victor Stinnerc22bfaa2017-02-12 19:27:05 +010020static PyObject *
21null_error(void)
22{
23 if (!PyErr_Occurred())
24 PyErr_SetString(PyExc_SystemError,
25 "null argument to internal routine");
26 return NULL;
27}
28
29
30PyObject*
31_Py_CheckFunctionResult(PyObject *callable, PyObject *result, const char *where)
32{
33 int err_occurred = (PyErr_Occurred() != NULL);
34
35 assert((callable != NULL) ^ (where != NULL));
36
37 if (result == NULL) {
38 if (!err_occurred) {
39 if (callable)
40 PyErr_Format(PyExc_SystemError,
41 "%R returned NULL without setting an error",
42 callable);
43 else
44 PyErr_Format(PyExc_SystemError,
45 "%s returned NULL without setting an error",
46 where);
47#ifdef Py_DEBUG
48 /* Ensure that the bug is caught in debug mode */
49 Py_FatalError("a function returned NULL without setting an error");
50#endif
51 return NULL;
52 }
53 }
54 else {
55 if (err_occurred) {
56 Py_DECREF(result);
57
58 if (callable) {
59 _PyErr_FormatFromCause(PyExc_SystemError,
60 "%R returned a result with an error set",
61 callable);
62 }
63 else {
64 _PyErr_FormatFromCause(PyExc_SystemError,
65 "%s returned a result with an error set",
66 where);
67 }
68#ifdef Py_DEBUG
69 /* Ensure that the bug is caught in debug mode */
70 Py_FatalError("a function returned a result with an error set");
71#endif
72 return NULL;
73 }
74 }
75 return result;
76}
77
78
79/* --- Core PyObject call functions ------------------------------- */
80
Victor Stinner2ff58a22019-06-17 14:27:23 +020081/* Call a callable Python object without any arguments */
82PyObject *
83PyObject_CallNoArgs(PyObject *func)
84{
85 return _PyObject_CallNoArg(func);
86}
87
88
Victor Stinnerc22bfaa2017-02-12 19:27:05 +010089PyObject *
Jeroen Demeyeraacc77f2019-05-29 20:31:52 +020090_PyObject_FastCallDict(PyObject *callable, PyObject *const *args,
91 size_t nargsf, PyObject *kwargs)
Victor Stinnerc22bfaa2017-02-12 19:27:05 +010092{
93 /* _PyObject_FastCallDict() must not be called with an exception set,
94 because it can clear it (directly or indirectly) and so the
95 caller loses its exception */
96 assert(!PyErr_Occurred());
Victor Stinnerc22bfaa2017-02-12 19:27:05 +010097 assert(callable != NULL);
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 */
107 return _PyObject_MakeTpCall(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;
Jeroen Demeyerd4efd912019-07-02 11:49:40 +0200117 newargs = _PyStack_UnpackDict(args, nargs, kwargs, &kwnames);
118 if (newargs == NULL) {
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100119 return NULL;
120 }
Jeroen Demeyerd4efd912019-07-02 11:49:40 +0200121 res = func(callable, newargs,
122 nargs | PY_VECTORCALL_ARGUMENTS_OFFSET, kwnames);
123 _PyStack_UnpackDict_Free(newargs, nargs, kwnames);
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100124 }
Jeroen Demeyeraacc77f2019-05-29 20:31:52 +0200125 return _Py_CheckFunctionResult(callable, res, NULL);
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100126}
127
128
129PyObject *
Jeroen Demeyeraacc77f2019-05-29 20:31:52 +0200130_PyObject_MakeTpCall(PyObject *callable, PyObject *const *args, Py_ssize_t nargs, PyObject *keywords)
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100131{
Jeroen Demeyeraacc77f2019-05-29 20:31:52 +0200132 /* Slow path: build a temporary tuple for positional arguments and a
133 * temporary dictionary for keyword arguments (if any) */
134 ternaryfunc call = Py_TYPE(callable)->tp_call;
135 if (call == NULL) {
136 PyErr_Format(PyExc_TypeError, "'%.200s' object is not callable",
137 Py_TYPE(callable)->tp_name);
138 return NULL;
139 }
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100140
141 assert(nargs >= 0);
Jeroen Demeyeraacc77f2019-05-29 20:31:52 +0200142 assert(nargs == 0 || args != NULL);
143 assert(keywords == NULL || PyTuple_Check(keywords) || PyDict_Check(keywords));
144 PyObject *argstuple = _PyTuple_FromArray(args, nargs);
145 if (argstuple == NULL) {
146 return NULL;
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100147 }
Jeroen Demeyeraacc77f2019-05-29 20:31:52 +0200148
149 PyObject *kwdict;
150 if (keywords == NULL || PyDict_Check(keywords)) {
151 kwdict = keywords;
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100152 }
153 else {
Jeroen Demeyeraacc77f2019-05-29 20:31:52 +0200154 if (PyTuple_GET_SIZE(keywords)) {
155 assert(args != NULL);
156 kwdict = _PyStack_AsDict(args + nargs, keywords);
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100157 if (kwdict == NULL) {
158 Py_DECREF(argstuple);
159 return NULL;
160 }
161 }
162 else {
Jeroen Demeyeraacc77f2019-05-29 20:31:52 +0200163 keywords = kwdict = NULL;
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100164 }
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100165 }
Jeroen Demeyeraacc77f2019-05-29 20:31:52 +0200166
167 PyObject *result = NULL;
168 if (Py_EnterRecursiveCall(" while calling a Python object") == 0)
169 {
170 result = call(callable, argstuple, kwdict);
171 Py_LeaveRecursiveCall();
172 }
173
174 Py_DECREF(argstuple);
175 if (kwdict != keywords) {
176 Py_DECREF(kwdict);
177 }
178
179 result = _Py_CheckFunctionResult(callable, result, NULL);
180 return result;
181}
182
183
184PyObject *
185PyVectorcall_Call(PyObject *callable, PyObject *tuple, PyObject *kwargs)
186{
Petr Viktorinfb9423f2019-06-02 23:52:20 +0200187 /* get vectorcallfunc as in _PyVectorcall_Function, but without
188 * the _Py_TPFLAGS_HAVE_VECTORCALL check */
189 Py_ssize_t offset = Py_TYPE(callable)->tp_vectorcall_offset;
Jeroen Demeyera8b27e62019-06-24 12:41:05 +0200190 if (offset <= 0) {
Petr Viktorinfb9423f2019-06-02 23:52:20 +0200191 PyErr_Format(PyExc_TypeError, "'%.200s' object does not support vectorcall",
192 Py_TYPE(callable)->tp_name);
193 return NULL;
194 }
195 vectorcallfunc func = *(vectorcallfunc *)(((char *)callable) + offset);
Jeroen Demeyeraacc77f2019-05-29 20:31:52 +0200196 if (func == NULL) {
197 PyErr_Format(PyExc_TypeError, "'%.200s' object does not support vectorcall",
198 Py_TYPE(callable)->tp_name);
199 return NULL;
200 }
Petr Viktorinfb9423f2019-06-02 23:52:20 +0200201
Jeroen Demeyeraacc77f2019-05-29 20:31:52 +0200202 Py_ssize_t nargs = PyTuple_GET_SIZE(tuple);
Jeroen Demeyerd4efd912019-07-02 11:49:40 +0200203
204 /* Fast path for no keywords */
205 if (kwargs == NULL || PyDict_GET_SIZE(kwargs) == 0) {
206 return func(callable, _PyTuple_ITEMS(tuple), nargs, NULL);
Jeroen Demeyeraacc77f2019-05-29 20:31:52 +0200207 }
208
Jeroen Demeyerd4efd912019-07-02 11:49:40 +0200209 /* Convert arguments & call */
210 PyObject *const *args;
211 PyObject *kwnames;
212 args = _PyStack_UnpackDict(_PyTuple_ITEMS(tuple), nargs, kwargs, &kwnames);
213 if (args == NULL) {
214 return NULL;
215 }
216 PyObject *result = func(callable, args,
217 nargs | PY_VECTORCALL_ARGUMENTS_OFFSET, kwnames);
218 _PyStack_UnpackDict_Free(args, nargs, kwnames);
Jeroen Demeyer0d722f32019-07-05 14:48:24 +0200219 return _Py_CheckFunctionResult(callable, result, NULL);
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100220}
221
222
223PyObject *
224PyObject_Call(PyObject *callable, PyObject *args, PyObject *kwargs)
225{
226 ternaryfunc call;
227 PyObject *result;
228
229 /* PyObject_Call() must not be called with an exception set,
230 because it can clear it (directly or indirectly) and so the
231 caller loses its exception */
232 assert(!PyErr_Occurred());
233 assert(PyTuple_Check(args));
234 assert(kwargs == NULL || PyDict_Check(kwargs));
235
Jeroen Demeyeraacc77f2019-05-29 20:31:52 +0200236 if (_PyVectorcall_Function(callable) != NULL) {
237 return PyVectorcall_Call(callable, args, kwargs);
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100238 }
239 else if (PyCFunction_Check(callable)) {
Jeroen Demeyeraacc77f2019-05-29 20:31:52 +0200240 /* This must be a METH_VARARGS function, otherwise we would be
241 * in the previous case */
242 return cfunction_call_varargs(callable, args, kwargs);
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100243 }
244 else {
245 call = callable->ob_type->tp_call;
246 if (call == NULL) {
247 PyErr_Format(PyExc_TypeError, "'%.200s' object is not callable",
248 callable->ob_type->tp_name);
249 return NULL;
250 }
251
252 if (Py_EnterRecursiveCall(" while calling a Python object"))
253 return NULL;
254
255 result = (*call)(callable, args, kwargs);
256
257 Py_LeaveRecursiveCall();
258
259 return _Py_CheckFunctionResult(callable, result, NULL);
260 }
261}
262
263
264/* --- PyFunction call functions ---------------------------------- */
265
266static PyObject* _Py_HOT_FUNCTION
Serhiy Storchakaa5552f02017-12-15 13:11:11 +0200267function_code_fastcall(PyCodeObject *co, PyObject *const *args, Py_ssize_t nargs,
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100268 PyObject *globals)
269{
270 PyFrameObject *f;
Victor Stinner50b48572018-11-01 01:51:40 +0100271 PyThreadState *tstate = _PyThreadState_GET();
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100272 PyObject **fastlocals;
273 Py_ssize_t i;
274 PyObject *result;
275
276 assert(globals != NULL);
277 /* XXX Perhaps we should create a specialized
278 _PyFrame_New_NoTrack() that doesn't take locals, but does
279 take builtins without sanity checking them.
280 */
281 assert(tstate != NULL);
282 f = _PyFrame_New_NoTrack(tstate, co, globals, NULL);
283 if (f == NULL) {
284 return NULL;
285 }
286
287 fastlocals = f->f_localsplus;
288
289 for (i = 0; i < nargs; i++) {
290 Py_INCREF(*args);
291 fastlocals[i] = *args++;
292 }
293 result = PyEval_EvalFrameEx(f,0);
294
295 if (Py_REFCNT(f) > 1) {
296 Py_DECREF(f);
297 _PyObject_GC_TRACK(f);
298 }
299 else {
300 ++tstate->recursion_depth;
301 Py_DECREF(f);
302 --tstate->recursion_depth;
303 }
304 return result;
305}
306
307
308PyObject *
Jeroen Demeyer37788bc2019-05-30 15:11:22 +0200309_PyFunction_Vectorcall(PyObject *func, PyObject* const* stack,
310 size_t nargsf, PyObject *kwnames)
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100311{
312 PyCodeObject *co = (PyCodeObject *)PyFunction_GET_CODE(func);
313 PyObject *globals = PyFunction_GET_GLOBALS(func);
314 PyObject *argdefs = PyFunction_GET_DEFAULTS(func);
315 PyObject *kwdefs, *closure, *name, *qualname;
316 PyObject **d;
317 Py_ssize_t nkwargs = (kwnames == NULL) ? 0 : PyTuple_GET_SIZE(kwnames);
318 Py_ssize_t nd;
319
320 assert(PyFunction_Check(func));
Jeroen Demeyeraacc77f2019-05-29 20:31:52 +0200321 Py_ssize_t nargs = PyVectorcall_NARGS(nargsf);
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100322 assert(nargs >= 0);
323 assert(kwnames == NULL || PyTuple_CheckExact(kwnames));
324 assert((nargs == 0 && nkwargs == 0) || stack != NULL);
Jeroen Demeyer05677862019-08-16 12:41:27 +0200325 /* kwnames must only contain strings and all keys must be unique */
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100326
327 if (co->co_kwonlyargcount == 0 && nkwargs == 0 &&
Victor Stinner086c3ae2017-10-25 05:26:17 -0700328 (co->co_flags & ~PyCF_MASK) == (CO_OPTIMIZED | CO_NEWLOCALS | CO_NOFREE))
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100329 {
Pablo Galindocd74e662019-06-01 18:08:04 +0100330 if (argdefs == NULL && co->co_argcount == nargs) {
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100331 return function_code_fastcall(co, stack, nargs, globals);
332 }
333 else if (nargs == 0 && argdefs != NULL
Pablo Galindocd74e662019-06-01 18:08:04 +0100334 && co->co_argcount == PyTuple_GET_SIZE(argdefs)) {
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100335 /* function called with no arguments, but all parameters have
336 a default value: use default values as arguments .*/
Victor Stinnerd17a6932018-11-09 16:56:48 +0100337 stack = _PyTuple_ITEMS(argdefs);
Serhiy Storchakafff9a312017-03-21 08:53:25 +0200338 return function_code_fastcall(co, stack, PyTuple_GET_SIZE(argdefs),
339 globals);
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100340 }
341 }
342
343 kwdefs = PyFunction_GET_KW_DEFAULTS(func);
344 closure = PyFunction_GET_CLOSURE(func);
345 name = ((PyFunctionObject *)func) -> func_name;
346 qualname = ((PyFunctionObject *)func) -> func_qualname;
347
348 if (argdefs != NULL) {
Victor Stinnerd17a6932018-11-09 16:56:48 +0100349 d = _PyTuple_ITEMS(argdefs);
Serhiy Storchakafff9a312017-03-21 08:53:25 +0200350 nd = PyTuple_GET_SIZE(argdefs);
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100351 }
352 else {
353 d = NULL;
354 nd = 0;
355 }
356 return _PyEval_EvalCodeWithName((PyObject*)co, globals, (PyObject *)NULL,
357 stack, nargs,
Victor Stinnerd17a6932018-11-09 16:56:48 +0100358 nkwargs ? _PyTuple_ITEMS(kwnames) : NULL,
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100359 stack + nargs,
360 nkwargs, 1,
361 d, (int)nd, kwdefs,
362 closure, name, qualname);
363}
364
365
366/* --- PyCFunction call functions --------------------------------- */
367
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100368static PyObject *
369cfunction_call_varargs(PyObject *func, PyObject *args, PyObject *kwargs)
370{
371 assert(!PyErr_Occurred());
Serhiy Storchaka5eb788b2017-06-06 18:45:22 +0300372 assert(kwargs == NULL || PyDict_Check(kwargs));
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100373
374 PyCFunction meth = PyCFunction_GET_FUNCTION(func);
375 PyObject *self = PyCFunction_GET_SELF(func);
376 PyObject *result;
377
Jeroen Demeyeraacc77f2019-05-29 20:31:52 +0200378 assert(PyCFunction_GET_FLAGS(func) & METH_VARARGS);
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100379 if (PyCFunction_GET_FLAGS(func) & METH_KEYWORDS) {
380 if (Py_EnterRecursiveCall(" while calling a Python object")) {
381 return NULL;
382 }
383
Serhiy Storchaka62be7422018-11-27 13:27:31 +0200384 result = (*(PyCFunctionWithKeywords)(void(*)(void))meth)(self, args, kwargs);
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100385
386 Py_LeaveRecursiveCall();
387 }
388 else {
Serhiy Storchaka5eb788b2017-06-06 18:45:22 +0300389 if (kwargs != NULL && PyDict_GET_SIZE(kwargs) != 0) {
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100390 PyErr_Format(PyExc_TypeError, "%.200s() takes no keyword arguments",
391 ((PyCFunctionObject*)func)->m_ml->ml_name);
392 return NULL;
393 }
394
395 if (Py_EnterRecursiveCall(" while calling a Python object")) {
396 return NULL;
397 }
398
399 result = (*meth)(self, args);
400
401 Py_LeaveRecursiveCall();
402 }
403
404 return _Py_CheckFunctionResult(func, result, NULL);
405}
406
407
408PyObject *
409PyCFunction_Call(PyObject *func, PyObject *args, PyObject *kwargs)
410{
Jeroen Demeyeraacc77f2019-05-29 20:31:52 +0200411 /* For METH_VARARGS, we cannot use vectorcall as the vectorcall pointer
412 * is NULL. This is intentional, since vectorcall would be slower. */
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100413 if (PyCFunction_GET_FLAGS(func) & METH_VARARGS) {
414 return cfunction_call_varargs(func, args, kwargs);
415 }
Jeroen Demeyeraacc77f2019-05-29 20:31:52 +0200416 return PyVectorcall_Call(func, args, kwargs);
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100417}
418
419
420/* --- More complex call functions -------------------------------- */
421
422/* External interface to call any callable object.
423 The args must be a tuple or NULL. The kwargs must be a dict or NULL. */
424PyObject *
425PyEval_CallObjectWithKeywords(PyObject *callable,
426 PyObject *args, PyObject *kwargs)
427{
428#ifdef Py_DEBUG
429 /* PyEval_CallObjectWithKeywords() must not be called with an exception
430 set. It raises a new exception if parameters are invalid or if
431 PyTuple_New() fails, and so the original exception is lost. */
432 assert(!PyErr_Occurred());
433#endif
434
INADA Naoki3824cd82017-03-01 20:41:03 +0900435 if (args != NULL && !PyTuple_Check(args)) {
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100436 PyErr_SetString(PyExc_TypeError,
437 "argument list must be a tuple");
438 return NULL;
439 }
440
441 if (kwargs != NULL && !PyDict_Check(kwargs)) {
442 PyErr_SetString(PyExc_TypeError,
443 "keyword list must be a dictionary");
444 return NULL;
445 }
446
INADA Naoki3824cd82017-03-01 20:41:03 +0900447 if (args == NULL) {
448 return _PyObject_FastCallDict(callable, NULL, 0, kwargs);
449 }
450 else {
451 return PyObject_Call(callable, args, kwargs);
452 }
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100453}
454
455
456PyObject *
457PyObject_CallObject(PyObject *callable, PyObject *args)
458{
Jeroen Demeyer1dbd0842019-07-11 17:57:32 +0200459 assert(!PyErr_Occurred());
460 if (args == NULL) {
461 return _PyObject_CallNoArg(callable);
462 }
463 if (!PyTuple_Check(args)) {
464 PyErr_SetString(PyExc_TypeError,
465 "argument list must be a tuple");
466 return NULL;
467 }
468 return PyObject_Call(callable, args, NULL);
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100469}
470
471
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100472/* Call callable(obj, *args, **kwargs). */
473PyObject *
474_PyObject_Call_Prepend(PyObject *callable,
475 PyObject *obj, PyObject *args, PyObject *kwargs)
476{
477 PyObject *small_stack[_PY_FASTCALL_SMALL_STACK];
478 PyObject **stack;
479 Py_ssize_t argcount;
480 PyObject *result;
481
482 assert(PyTuple_Check(args));
483
484 argcount = PyTuple_GET_SIZE(args);
485 if (argcount + 1 <= (Py_ssize_t)Py_ARRAY_LENGTH(small_stack)) {
486 stack = small_stack;
487 }
488 else {
489 stack = PyMem_Malloc((argcount + 1) * sizeof(PyObject *));
490 if (stack == NULL) {
491 PyErr_NoMemory();
492 return NULL;
493 }
494 }
495
496 /* use borrowed references */
497 stack[0] = obj;
498 memcpy(&stack[1],
Victor Stinnerd17a6932018-11-09 16:56:48 +0100499 _PyTuple_ITEMS(args),
500 argcount * sizeof(PyObject *));
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100501
502 result = _PyObject_FastCallDict(callable,
503 stack, argcount + 1,
504 kwargs);
505 if (stack != small_stack) {
506 PyMem_Free(stack);
507 }
508 return result;
509}
510
511
512/* --- Call with a format string ---------------------------------- */
513
514static PyObject *
515_PyObject_CallFunctionVa(PyObject *callable, const char *format,
516 va_list va, int is_size_t)
517{
518 PyObject* small_stack[_PY_FASTCALL_SMALL_STACK];
519 const Py_ssize_t small_stack_len = Py_ARRAY_LENGTH(small_stack);
520 PyObject **stack;
521 Py_ssize_t nargs, i;
522 PyObject *result;
523
524 if (callable == NULL) {
525 return null_error();
526 }
527
528 if (!format || !*format) {
529 return _PyObject_CallNoArg(callable);
530 }
531
532 if (is_size_t) {
533 stack = _Py_VaBuildStack_SizeT(small_stack, small_stack_len,
534 format, va, &nargs);
535 }
536 else {
537 stack = _Py_VaBuildStack(small_stack, small_stack_len,
538 format, va, &nargs);
539 }
540 if (stack == NULL) {
541 return NULL;
542 }
543
544 if (nargs == 1 && PyTuple_Check(stack[0])) {
545 /* Special cases for backward compatibility:
546 - PyObject_CallFunction(func, "O", tuple) calls func(*tuple)
547 - PyObject_CallFunction(func, "(OOO)", arg1, arg2, arg3) calls
548 func(*(arg1, arg2, arg3)): func(arg1, arg2, arg3) */
549 PyObject *args = stack[0];
550 result = _PyObject_FastCall(callable,
Victor Stinnerd17a6932018-11-09 16:56:48 +0100551 _PyTuple_ITEMS(args),
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100552 PyTuple_GET_SIZE(args));
553 }
554 else {
555 result = _PyObject_FastCall(callable, stack, nargs);
556 }
557
558 for (i = 0; i < nargs; ++i) {
559 Py_DECREF(stack[i]);
560 }
561 if (stack != small_stack) {
562 PyMem_Free(stack);
563 }
564 return result;
565}
566
567
568PyObject *
569PyObject_CallFunction(PyObject *callable, const char *format, ...)
570{
571 va_list va;
572 PyObject *result;
573
574 va_start(va, format);
575 result = _PyObject_CallFunctionVa(callable, format, va, 0);
576 va_end(va);
577
578 return result;
579}
580
581
INADA Naokiaa289a52017-03-14 18:00:59 +0900582/* PyEval_CallFunction is exact copy of PyObject_CallFunction.
583 * This function is kept for backward compatibility.
584 */
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100585PyObject *
586PyEval_CallFunction(PyObject *callable, const char *format, ...)
587{
INADA Naokiaa289a52017-03-14 18:00:59 +0900588 va_list va;
589 PyObject *result;
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100590
INADA Naokiaa289a52017-03-14 18:00:59 +0900591 va_start(va, format);
592 result = _PyObject_CallFunctionVa(callable, format, va, 0);
593 va_end(va);
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100594
INADA Naokiaa289a52017-03-14 18:00:59 +0900595 return result;
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100596}
597
598
599PyObject *
600_PyObject_CallFunction_SizeT(PyObject *callable, const char *format, ...)
601{
602 va_list va;
603 PyObject *result;
604
605 va_start(va, format);
606 result = _PyObject_CallFunctionVa(callable, format, va, 1);
607 va_end(va);
608
609 return result;
610}
611
612
613static PyObject*
614callmethod(PyObject* callable, const char *format, va_list va, int is_size_t)
615{
616 assert(callable != NULL);
617
618 if (!PyCallable_Check(callable)) {
619 PyErr_Format(PyExc_TypeError,
620 "attribute of type '%.200s' is not callable",
621 Py_TYPE(callable)->tp_name);
622 return NULL;
623 }
624
625 return _PyObject_CallFunctionVa(callable, format, va, is_size_t);
626}
627
628
629PyObject *
630PyObject_CallMethod(PyObject *obj, const char *name, const char *format, ...)
631{
632 va_list va;
633 PyObject *callable, *retval;
634
635 if (obj == NULL || name == NULL) {
636 return null_error();
637 }
638
639 callable = PyObject_GetAttrString(obj, name);
640 if (callable == NULL)
641 return NULL;
642
643 va_start(va, format);
644 retval = callmethod(callable, format, va, 0);
645 va_end(va);
646
647 Py_DECREF(callable);
648 return retval;
649}
650
651
INADA Naokiaa289a52017-03-14 18:00:59 +0900652/* PyEval_CallMethod is exact copy of PyObject_CallMethod.
653 * This function is kept for backward compatibility.
654 */
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100655PyObject *
656PyEval_CallMethod(PyObject *obj, const char *name, const char *format, ...)
657{
INADA Naokiaa289a52017-03-14 18:00:59 +0900658 va_list va;
659 PyObject *callable, *retval;
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100660
INADA Naokiaa289a52017-03-14 18:00:59 +0900661 if (obj == NULL || name == NULL) {
662 return null_error();
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100663 }
664
INADA Naokiaa289a52017-03-14 18:00:59 +0900665 callable = PyObject_GetAttrString(obj, name);
666 if (callable == NULL)
667 return NULL;
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100668
INADA Naokiaa289a52017-03-14 18:00:59 +0900669 va_start(va, format);
670 retval = callmethod(callable, format, va, 0);
671 va_end(va);
672
673 Py_DECREF(callable);
674 return retval;
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100675}
676
677
678PyObject *
679_PyObject_CallMethodId(PyObject *obj, _Py_Identifier *name,
680 const char *format, ...)
681{
682 va_list va;
683 PyObject *callable, *retval;
684
685 if (obj == NULL || name == NULL) {
686 return null_error();
687 }
688
689 callable = _PyObject_GetAttrId(obj, name);
690 if (callable == NULL)
691 return NULL;
692
693 va_start(va, format);
694 retval = callmethod(callable, format, va, 0);
695 va_end(va);
696
697 Py_DECREF(callable);
698 return retval;
699}
700
701
702PyObject *
703_PyObject_CallMethod_SizeT(PyObject *obj, const char *name,
704 const char *format, ...)
705{
706 va_list va;
707 PyObject *callable, *retval;
708
709 if (obj == NULL || name == NULL) {
710 return null_error();
711 }
712
713 callable = PyObject_GetAttrString(obj, name);
714 if (callable == NULL)
715 return NULL;
716
717 va_start(va, format);
718 retval = callmethod(callable, format, va, 1);
719 va_end(va);
720
721 Py_DECREF(callable);
722 return retval;
723}
724
725
726PyObject *
727_PyObject_CallMethodId_SizeT(PyObject *obj, _Py_Identifier *name,
728 const char *format, ...)
729{
730 va_list va;
731 PyObject *callable, *retval;
732
733 if (obj == NULL || name == NULL) {
734 return null_error();
735 }
736
737 callable = _PyObject_GetAttrId(obj, name);
738 if (callable == NULL) {
739 return NULL;
740 }
741
742 va_start(va, format);
743 retval = callmethod(callable, format, va, 1);
744 va_end(va);
745
746 Py_DECREF(callable);
747 return retval;
748}
749
750
751/* --- Call with "..." arguments ---------------------------------- */
752
753static PyObject *
Michael J. Sullivan47dd2f92019-05-26 00:23:34 -0700754object_vacall(PyObject *base, PyObject *callable, va_list vargs)
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100755{
756 PyObject *small_stack[_PY_FASTCALL_SMALL_STACK];
757 PyObject **stack;
758 Py_ssize_t nargs;
759 PyObject *result;
760 Py_ssize_t i;
761 va_list countva;
762
763 if (callable == NULL) {
764 return null_error();
765 }
766
767 /* Count the number of arguments */
768 va_copy(countva, vargs);
Michael J. Sullivan47dd2f92019-05-26 00:23:34 -0700769 nargs = base ? 1 : 0;
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100770 while (1) {
771 PyObject *arg = va_arg(countva, PyObject *);
772 if (arg == NULL) {
773 break;
774 }
775 nargs++;
776 }
777 va_end(countva);
778
779 /* Copy arguments */
780 if (nargs <= (Py_ssize_t)Py_ARRAY_LENGTH(small_stack)) {
781 stack = small_stack;
782 }
783 else {
784 stack = PyMem_Malloc(nargs * sizeof(stack[0]));
785 if (stack == NULL) {
786 PyErr_NoMemory();
787 return NULL;
788 }
789 }
790
Michael J. Sullivan47dd2f92019-05-26 00:23:34 -0700791 i = 0;
792 if (base) {
793 stack[i++] = base;
794 }
795
796 for (; i < nargs; ++i) {
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100797 stack[i] = va_arg(vargs, PyObject *);
798 }
799
800 /* Call the function */
801 result = _PyObject_FastCall(callable, stack, nargs);
802
803 if (stack != small_stack) {
804 PyMem_Free(stack);
805 }
806 return result;
807}
808
809
Michael J. Sullivan47dd2f92019-05-26 00:23:34 -0700810PyObject *
Jeroen Demeyerb1263d52019-06-28 11:49:00 +0200811_PyObject_VectorcallMethod(PyObject *name, PyObject *const *args,
812 size_t nargsf, PyObject *kwnames)
813{
814 assert(name != NULL);
815 assert(args != NULL);
816 assert(PyVectorcall_NARGS(nargsf) >= 1);
817
818 PyObject *callable = NULL;
819 /* Use args[0] as "self" argument */
820 int unbound = _PyObject_GetMethod(args[0], name, &callable);
821 if (callable == NULL) {
822 return NULL;
823 }
824
825 if (unbound) {
826 /* We must remove PY_VECTORCALL_ARGUMENTS_OFFSET since
827 * that would be interpreted as allowing to change args[-1] */
828 nargsf &= ~PY_VECTORCALL_ARGUMENTS_OFFSET;
829 }
830 else {
831 /* Skip "self". We can keep PY_VECTORCALL_ARGUMENTS_OFFSET since
832 * args[-1] in the onward call is args[0] here. */
833 args++;
834 nargsf--;
835 }
836 PyObject *result = _PyObject_Vectorcall(callable, args, nargsf, kwnames);
837 Py_DECREF(callable);
838 return result;
839}
840
841
842PyObject *
Michael J. Sullivan47dd2f92019-05-26 00:23:34 -0700843PyObject_CallMethodObjArgs(PyObject *obj, PyObject *name, ...)
844{
845 if (obj == NULL || name == NULL) {
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100846 return null_error();
847 }
848
Michael J. Sullivan47dd2f92019-05-26 00:23:34 -0700849 PyObject *callable = NULL;
850 int is_method = _PyObject_GetMethod(obj, name, &callable);
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100851 if (callable == NULL) {
852 return NULL;
853 }
Michael J. Sullivan47dd2f92019-05-26 00:23:34 -0700854 obj = is_method ? obj : NULL;
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100855
Michael J. Sullivan47dd2f92019-05-26 00:23:34 -0700856 va_list vargs;
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100857 va_start(vargs, name);
Michael J. Sullivan47dd2f92019-05-26 00:23:34 -0700858 PyObject *result = object_vacall(obj, callable, vargs);
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100859 va_end(vargs);
860
861 Py_DECREF(callable);
862 return result;
863}
864
865
866PyObject *
867_PyObject_CallMethodIdObjArgs(PyObject *obj,
868 struct _Py_Identifier *name, ...)
869{
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100870 if (obj == NULL || name == NULL) {
871 return null_error();
872 }
873
Michael J. Sullivan47dd2f92019-05-26 00:23:34 -0700874 PyObject *oname = _PyUnicode_FromId(name); /* borrowed */
875 if (!oname) {
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100876 return NULL;
877 }
878
Michael J. Sullivan47dd2f92019-05-26 00:23:34 -0700879 PyObject *callable = NULL;
880 int is_method = _PyObject_GetMethod(obj, oname, &callable);
881 if (callable == NULL) {
882 return NULL;
883 }
884 obj = is_method ? obj : NULL;
885
886 va_list vargs;
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100887 va_start(vargs, name);
Michael J. Sullivan47dd2f92019-05-26 00:23:34 -0700888 PyObject *result = object_vacall(obj, callable, vargs);
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100889 va_end(vargs);
890
891 Py_DECREF(callable);
892 return result;
893}
894
895
896PyObject *
897PyObject_CallFunctionObjArgs(PyObject *callable, ...)
898{
899 va_list vargs;
900 PyObject *result;
901
902 va_start(vargs, callable);
Michael J. Sullivan47dd2f92019-05-26 00:23:34 -0700903 result = object_vacall(NULL, callable, vargs);
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100904 va_end(vargs);
905
906 return result;
907}
908
909
910/* --- PyStack functions ------------------------------------------ */
911
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100912PyObject *
Serhiy Storchakaa5552f02017-12-15 13:11:11 +0200913_PyStack_AsDict(PyObject *const *values, PyObject *kwnames)
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100914{
915 Py_ssize_t nkwargs;
916 PyObject *kwdict;
917 Py_ssize_t i;
918
919 assert(kwnames != NULL);
920 nkwargs = PyTuple_GET_SIZE(kwnames);
921 kwdict = _PyDict_NewPresized(nkwargs);
922 if (kwdict == NULL) {
923 return NULL;
924 }
925
926 for (i = 0; i < nkwargs; i++) {
927 PyObject *key = PyTuple_GET_ITEM(kwnames, i);
928 PyObject *value = *values++;
929 /* If key already exists, replace it with the new value */
930 if (PyDict_SetItem(kwdict, key, value)) {
931 Py_DECREF(kwdict);
932 return NULL;
933 }
934 }
935 return kwdict;
936}
937
938
Jeroen Demeyerd4efd912019-07-02 11:49:40 +0200939/* Convert (args, nargs, kwargs: dict) into a (stack, nargs, kwnames: tuple).
940
941 Allocate a new argument vector and keyword names tuple. Return the argument
942 vector; return NULL with exception set on error. Return the keyword names
943 tuple in *p_kwnames.
944
Jeroen Demeyer05677862019-08-16 12:41:27 +0200945 This also checks that all keyword names are strings. If not, a TypeError is
946 raised.
947
Jeroen Demeyerd4efd912019-07-02 11:49:40 +0200948 The newly allocated argument vector supports PY_VECTORCALL_ARGUMENTS_OFFSET.
949
Jeroen Demeyer05677862019-08-16 12:41:27 +0200950 When done, you must call _PyStack_UnpackDict_Free(stack, nargs, kwnames) */
Jeroen Demeyerd4efd912019-07-02 11:49:40 +0200951static PyObject *const *
Serhiy Storchakaa5552f02017-12-15 13:11:11 +0200952_PyStack_UnpackDict(PyObject *const *args, Py_ssize_t nargs, PyObject *kwargs,
Jeroen Demeyerd4efd912019-07-02 11:49:40 +0200953 PyObject **p_kwnames)
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100954{
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100955 assert(nargs >= 0);
Jeroen Demeyerd4efd912019-07-02 11:49:40 +0200956 assert(kwargs != NULL);
957 assert(PyDict_Check(kwargs));
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100958
Jeroen Demeyerd4efd912019-07-02 11:49:40 +0200959 Py_ssize_t nkwargs = PyDict_GET_SIZE(kwargs);
960 /* Check for overflow in the PyMem_Malloc() call below. The subtraction
961 * in this check cannot overflow: both maxnargs and nkwargs are
962 * non-negative signed integers, so their difference fits in the type. */
963 Py_ssize_t maxnargs = PY_SSIZE_T_MAX / sizeof(args[0]) - 1;
964 if (nargs > maxnargs - nkwargs) {
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100965 PyErr_NoMemory();
Jeroen Demeyerd4efd912019-07-02 11:49:40 +0200966 return NULL;
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100967 }
968
Jeroen Demeyerd4efd912019-07-02 11:49:40 +0200969 /* Add 1 to support PY_VECTORCALL_ARGUMENTS_OFFSET */
970 PyObject **stack = PyMem_Malloc((1 + nargs + nkwargs) * sizeof(args[0]));
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100971 if (stack == NULL) {
972 PyErr_NoMemory();
Jeroen Demeyerd4efd912019-07-02 11:49:40 +0200973 return NULL;
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100974 }
975
Jeroen Demeyerd4efd912019-07-02 11:49:40 +0200976 PyObject *kwnames = PyTuple_New(nkwargs);
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100977 if (kwnames == NULL) {
978 PyMem_Free(stack);
Jeroen Demeyerd4efd912019-07-02 11:49:40 +0200979 return NULL;
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100980 }
981
Jeroen Demeyerd4efd912019-07-02 11:49:40 +0200982 stack++; /* For PY_VECTORCALL_ARGUMENTS_OFFSET */
983
Jeroen Demeyer77aa3962019-05-22 13:09:35 +0200984 /* Copy positional arguments */
Jeroen Demeyerd4efd912019-07-02 11:49:40 +0200985 for (Py_ssize_t i = 0; i < nargs; i++) {
Jeroen Demeyer77aa3962019-05-22 13:09:35 +0200986 Py_INCREF(args[i]);
987 stack[i] = args[i];
988 }
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100989
Jeroen Demeyerd4efd912019-07-02 11:49:40 +0200990 PyObject **kwstack = stack + nargs;
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100991 /* This loop doesn't support lookup function mutating the dictionary
992 to change its size. It's a deliberate choice for speed, this function is
993 called in the performance critical hot code. */
Jeroen Demeyerd4efd912019-07-02 11:49:40 +0200994 Py_ssize_t pos = 0, i = 0;
995 PyObject *key, *value;
Jeroen Demeyer05677862019-08-16 12:41:27 +0200996 unsigned long keys_are_strings = Py_TPFLAGS_UNICODE_SUBCLASS;
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100997 while (PyDict_Next(kwargs, &pos, &key, &value)) {
Jeroen Demeyer05677862019-08-16 12:41:27 +0200998 keys_are_strings &= Py_TYPE(key)->tp_flags;
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100999 Py_INCREF(key);
Jeroen Demeyer77aa3962019-05-22 13:09:35 +02001000 Py_INCREF(value);
Victor Stinnerc22bfaa2017-02-12 19:27:05 +01001001 PyTuple_SET_ITEM(kwnames, i, key);
Victor Stinnerc22bfaa2017-02-12 19:27:05 +01001002 kwstack[i] = value;
1003 i++;
1004 }
1005
Jeroen Demeyer05677862019-08-16 12:41:27 +02001006 /* keys_are_strings has the value Py_TPFLAGS_UNICODE_SUBCLASS if that
1007 * flag is set for all keys. Otherwise, keys_are_strings equals 0.
1008 * We do this check once at the end instead of inside the loop above
1009 * because it simplifies the deallocation in the failing case.
1010 * It happens to also make the loop above slightly more efficient. */
1011 if (!keys_are_strings) {
1012 PyErr_SetString(PyExc_TypeError,
1013 "keywords must be strings");
1014 _PyStack_UnpackDict_Free(stack, nargs, kwnames);
1015 return NULL;
1016 }
1017
Victor Stinnerc22bfaa2017-02-12 19:27:05 +01001018 *p_kwnames = kwnames;
Jeroen Demeyerd4efd912019-07-02 11:49:40 +02001019 return stack;
1020}
1021
1022static void
1023_PyStack_UnpackDict_Free(PyObject *const *stack, Py_ssize_t nargs,
1024 PyObject *kwnames)
1025{
1026 Py_ssize_t n = PyTuple_GET_SIZE(kwnames) + nargs;
1027 for (Py_ssize_t i = 0; i < n; i++) {
1028 Py_DECREF(stack[i]);
1029 }
1030 PyMem_Free((PyObject **)stack - 1);
1031 Py_DECREF(kwnames);
Victor Stinnerc22bfaa2017-02-12 19:27:05 +01001032}