blob: 0d5c41295c29c82b2dc2ec2268a7b6c7762915be [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 Stinner17269092019-11-05 01:22:12 +010033 int err_occurred = (_PyErr_Occurred(tstate) != NULL);
Victor Stinnerc22bfaa2017-02-12 19:27:05 +010034
35 assert((callable != NULL) ^ (where != NULL));
36
37 if (result == NULL) {
38 if (!err_occurred) {
39 if (callable)
Victor Stinner17269092019-11-05 01:22:12 +010040 _PyErr_Format(tstate, PyExc_SystemError,
41 "%R returned NULL without setting an error",
42 callable);
Victor Stinnerc22bfaa2017-02-12 19:27:05 +010043 else
Victor Stinner17269092019-11-05 01:22:12 +010044 _PyErr_Format(tstate, PyExc_SystemError,
45 "%s returned NULL without setting an error",
46 where);
Victor Stinnerc22bfaa2017-02-12 19:27:05 +010047#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) {
Victor Stinner17269092019-11-05 01:22:12 +010059 _PyErr_FormatFromCauseTstate(
60 tstate, PyExc_SystemError,
61 "%R returned a result with an error set", callable);
Victor Stinnerc22bfaa2017-02-12 19:27:05 +010062 }
63 else {
Victor Stinner17269092019-11-05 01:22:12 +010064 _PyErr_FormatFromCauseTstate(
65 tstate, PyExc_SystemError,
66 "%s returned a result with an error set", where);
Victor Stinnerc22bfaa2017-02-12 19:27:05 +010067 }
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{
Victor Stinner17269092019-11-05 01:22:12 +010093 assert(callable != NULL);
94
95 PyThreadState *tstate = _PyThreadState_GET();
Victor Stinnerc22bfaa2017-02-12 19:27:05 +010096 /* _PyObject_FastCallDict() must not be called with an exception set,
97 because it can clear it (directly or indirectly) and so the
98 caller loses its exception */
Victor Stinner17269092019-11-05 01:22:12 +010099 assert(!_PyErr_Occurred(tstate));
Jeroen Demeyeraacc77f2019-05-29 20:31:52 +0200100
101 Py_ssize_t nargs = PyVectorcall_NARGS(nargsf);
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100102 assert(nargs >= 0);
103 assert(nargs == 0 || args != NULL);
104 assert(kwargs == NULL || PyDict_Check(kwargs));
105
Jeroen Demeyeraacc77f2019-05-29 20:31:52 +0200106 vectorcallfunc func = _PyVectorcall_Function(callable);
107 if (func == NULL) {
108 /* Use tp_call instead */
109 return _PyObject_MakeTpCall(callable, args, nargs, kwargs);
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100110 }
Jeroen Demeyeraacc77f2019-05-29 20:31:52 +0200111
112 PyObject *res;
Jeroen Demeyerd4efd912019-07-02 11:49:40 +0200113 if (kwargs == NULL || PyDict_GET_SIZE(kwargs) == 0) {
Jeroen Demeyeraacc77f2019-05-29 20:31:52 +0200114 res = func(callable, args, nargsf, NULL);
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100115 }
116 else {
Jeroen Demeyeraacc77f2019-05-29 20:31:52 +0200117 PyObject *kwnames;
118 PyObject *const *newargs;
Victor Stinner17269092019-11-05 01:22:12 +0100119 newargs = _PyStack_UnpackDict(tstate,
120 args, nargs,
121 kwargs, &kwnames);
Jeroen Demeyerd4efd912019-07-02 11:49:40 +0200122 if (newargs == NULL) {
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100123 return NULL;
124 }
Jeroen Demeyerd4efd912019-07-02 11:49:40 +0200125 res = func(callable, newargs,
126 nargs | PY_VECTORCALL_ARGUMENTS_OFFSET, kwnames);
127 _PyStack_UnpackDict_Free(newargs, nargs, kwnames);
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100128 }
Victor Stinner17269092019-11-05 01:22:12 +0100129 return _Py_CheckFunctionResult(tstate, callable, res, NULL);
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100130}
131
132
133PyObject *
Jeroen Demeyeraacc77f2019-05-29 20:31:52 +0200134_PyObject_MakeTpCall(PyObject *callable, PyObject *const *args, Py_ssize_t nargs, PyObject *keywords)
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100135{
Victor Stinnerbe434dc2019-11-05 00:51:22 +0100136 PyThreadState *tstate = _PyThreadState_GET();
137
Jeroen Demeyeraacc77f2019-05-29 20:31:52 +0200138 /* Slow path: build a temporary tuple for positional arguments and a
139 * temporary dictionary for keyword arguments (if any) */
140 ternaryfunc call = Py_TYPE(callable)->tp_call;
141 if (call == NULL) {
Victor Stinnerbe434dc2019-11-05 00:51:22 +0100142 _PyErr_Format(tstate, PyExc_TypeError,
143 "'%.200s' object is not callable",
144 Py_TYPE(callable)->tp_name);
Jeroen Demeyeraacc77f2019-05-29 20:31:52 +0200145 return NULL;
146 }
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100147
148 assert(nargs >= 0);
Jeroen Demeyeraacc77f2019-05-29 20:31:52 +0200149 assert(nargs == 0 || args != NULL);
150 assert(keywords == NULL || PyTuple_Check(keywords) || PyDict_Check(keywords));
151 PyObject *argstuple = _PyTuple_FromArray(args, nargs);
152 if (argstuple == NULL) {
153 return NULL;
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100154 }
Jeroen Demeyeraacc77f2019-05-29 20:31:52 +0200155
156 PyObject *kwdict;
157 if (keywords == NULL || PyDict_Check(keywords)) {
158 kwdict = keywords;
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100159 }
160 else {
Jeroen Demeyeraacc77f2019-05-29 20:31:52 +0200161 if (PyTuple_GET_SIZE(keywords)) {
162 assert(args != NULL);
163 kwdict = _PyStack_AsDict(args + nargs, keywords);
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100164 if (kwdict == NULL) {
165 Py_DECREF(argstuple);
166 return NULL;
167 }
168 }
169 else {
Jeroen Demeyeraacc77f2019-05-29 20:31:52 +0200170 keywords = kwdict = NULL;
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100171 }
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100172 }
Jeroen Demeyeraacc77f2019-05-29 20:31:52 +0200173
174 PyObject *result = NULL;
Victor Stinnerbe434dc2019-11-05 00:51:22 +0100175 if (_Py_EnterRecursiveCall(tstate, " while calling a Python object") == 0)
Jeroen Demeyeraacc77f2019-05-29 20:31:52 +0200176 {
177 result = call(callable, argstuple, kwdict);
Victor Stinnerbe434dc2019-11-05 00:51:22 +0100178 _Py_LeaveRecursiveCall(tstate);
Jeroen Demeyeraacc77f2019-05-29 20:31:52 +0200179 }
180
181 Py_DECREF(argstuple);
182 if (kwdict != keywords) {
183 Py_DECREF(kwdict);
184 }
185
Victor Stinner17269092019-11-05 01:22:12 +0100186 result = _Py_CheckFunctionResult(tstate, callable, result, NULL);
Jeroen Demeyeraacc77f2019-05-29 20:31:52 +0200187 return result;
188}
189
190
191PyObject *
192PyVectorcall_Call(PyObject *callable, PyObject *tuple, PyObject *kwargs)
193{
Victor Stinner17269092019-11-05 01:22:12 +0100194 PyThreadState *tstate = _PyThreadState_GET();
195
Petr Viktorinfb9423f2019-06-02 23:52:20 +0200196 /* get vectorcallfunc as in _PyVectorcall_Function, but without
197 * the _Py_TPFLAGS_HAVE_VECTORCALL check */
198 Py_ssize_t offset = Py_TYPE(callable)->tp_vectorcall_offset;
Jeroen Demeyera8b27e62019-06-24 12:41:05 +0200199 if (offset <= 0) {
Victor Stinner17269092019-11-05 01:22:12 +0100200 _PyErr_Format(tstate, PyExc_TypeError,
201 "'%.200s' object does not support vectorcall",
202 Py_TYPE(callable)->tp_name);
Petr Viktorinfb9423f2019-06-02 23:52:20 +0200203 return NULL;
204 }
205 vectorcallfunc func = *(vectorcallfunc *)(((char *)callable) + offset);
Jeroen Demeyeraacc77f2019-05-29 20:31:52 +0200206 if (func == NULL) {
Victor Stinner17269092019-11-05 01:22:12 +0100207 _PyErr_Format(tstate, PyExc_TypeError,
208 "'%.200s' object does not support vectorcall",
209 Py_TYPE(callable)->tp_name);
Jeroen Demeyeraacc77f2019-05-29 20:31:52 +0200210 return NULL;
211 }
Petr Viktorinfb9423f2019-06-02 23:52:20 +0200212
Jeroen Demeyeraacc77f2019-05-29 20:31:52 +0200213 Py_ssize_t nargs = PyTuple_GET_SIZE(tuple);
Jeroen Demeyerd4efd912019-07-02 11:49:40 +0200214
215 /* Fast path for no keywords */
216 if (kwargs == NULL || PyDict_GET_SIZE(kwargs) == 0) {
217 return func(callable, _PyTuple_ITEMS(tuple), nargs, NULL);
Jeroen Demeyeraacc77f2019-05-29 20:31:52 +0200218 }
219
Jeroen Demeyerd4efd912019-07-02 11:49:40 +0200220 /* Convert arguments & call */
221 PyObject *const *args;
222 PyObject *kwnames;
Victor Stinner17269092019-11-05 01:22:12 +0100223 args = _PyStack_UnpackDict(tstate,
224 _PyTuple_ITEMS(tuple), nargs,
225 kwargs, &kwnames);
Jeroen Demeyerd4efd912019-07-02 11:49:40 +0200226 if (args == NULL) {
227 return NULL;
228 }
229 PyObject *result = func(callable, args,
230 nargs | PY_VECTORCALL_ARGUMENTS_OFFSET, kwnames);
231 _PyStack_UnpackDict_Free(args, nargs, kwnames);
Victor Stinner17269092019-11-05 01:22:12 +0100232 return _Py_CheckFunctionResult(tstate, callable, result, NULL);
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100233}
234
235
236PyObject *
237PyObject_Call(PyObject *callable, PyObject *args, PyObject *kwargs)
238{
Victor Stinnerbe434dc2019-11-05 00:51:22 +0100239 PyThreadState *tstate = _PyThreadState_GET();
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100240 ternaryfunc call;
241 PyObject *result;
242
243 /* PyObject_Call() must not be called with an exception set,
244 because it can clear it (directly or indirectly) and so the
245 caller loses its exception */
Victor Stinnerbe434dc2019-11-05 00:51:22 +0100246 assert(!_PyErr_Occurred(tstate));
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100247 assert(PyTuple_Check(args));
248 assert(kwargs == NULL || PyDict_Check(kwargs));
249
Jeroen Demeyeraacc77f2019-05-29 20:31:52 +0200250 if (_PyVectorcall_Function(callable) != NULL) {
251 return PyVectorcall_Call(callable, args, kwargs);
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100252 }
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100253 else {
254 call = callable->ob_type->tp_call;
255 if (call == NULL) {
Victor Stinnerbe434dc2019-11-05 00:51:22 +0100256 _PyErr_Format(tstate, PyExc_TypeError,
257 "'%.200s' object is not callable",
258 callable->ob_type->tp_name);
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100259 return NULL;
260 }
261
Victor Stinnerbe434dc2019-11-05 00:51:22 +0100262 if (_Py_EnterRecursiveCall(tstate, " while calling a Python object")) {
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100263 return NULL;
Victor Stinnerbe434dc2019-11-05 00:51:22 +0100264 }
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100265
266 result = (*call)(callable, args, kwargs);
267
Victor Stinnerbe434dc2019-11-05 00:51:22 +0100268 _Py_LeaveRecursiveCall(tstate);
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100269
Victor Stinner17269092019-11-05 01:22:12 +0100270 return _Py_CheckFunctionResult(tstate, callable, result, NULL);
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100271 }
272}
273
274
Jeroen Demeyer7a6873c2019-09-11 13:01:01 +0200275PyObject *
276PyCFunction_Call(PyObject *callable, PyObject *args, PyObject *kwargs)
277{
278 return PyObject_Call(callable, args, kwargs);
279}
280
281
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100282/* --- PyFunction call functions ---------------------------------- */
283
284static PyObject* _Py_HOT_FUNCTION
Serhiy Storchakaa5552f02017-12-15 13:11:11 +0200285function_code_fastcall(PyCodeObject *co, PyObject *const *args, Py_ssize_t nargs,
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100286 PyObject *globals)
287{
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100288 assert(globals != NULL);
Victor Stinnerbe434dc2019-11-05 00:51:22 +0100289
290 PyThreadState *tstate = _PyThreadState_GET();
291 assert(tstate != NULL);
292
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100293 /* XXX Perhaps we should create a specialized
294 _PyFrame_New_NoTrack() that doesn't take locals, but does
295 take builtins without sanity checking them.
296 */
Victor Stinnerbe434dc2019-11-05 00:51:22 +0100297 PyFrameObject *f = _PyFrame_New_NoTrack(tstate, co, globals, NULL);
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100298 if (f == NULL) {
299 return NULL;
300 }
301
Victor Stinnerbe434dc2019-11-05 00:51:22 +0100302 PyObject **fastlocals = f->f_localsplus;
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100303
Victor Stinnerbe434dc2019-11-05 00:51:22 +0100304 for (Py_ssize_t i = 0; i < nargs; i++) {
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100305 Py_INCREF(*args);
306 fastlocals[i] = *args++;
307 }
Victor Stinnerbe434dc2019-11-05 00:51:22 +0100308 PyObject *result = PyEval_EvalFrameEx(f, 0);
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100309
310 if (Py_REFCNT(f) > 1) {
311 Py_DECREF(f);
312 _PyObject_GC_TRACK(f);
313 }
314 else {
315 ++tstate->recursion_depth;
316 Py_DECREF(f);
317 --tstate->recursion_depth;
318 }
319 return result;
320}
321
322
323PyObject *
Jeroen Demeyer37788bc2019-05-30 15:11:22 +0200324_PyFunction_Vectorcall(PyObject *func, PyObject* const* stack,
325 size_t nargsf, PyObject *kwnames)
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100326{
327 PyCodeObject *co = (PyCodeObject *)PyFunction_GET_CODE(func);
328 PyObject *globals = PyFunction_GET_GLOBALS(func);
329 PyObject *argdefs = PyFunction_GET_DEFAULTS(func);
330 PyObject *kwdefs, *closure, *name, *qualname;
331 PyObject **d;
332 Py_ssize_t nkwargs = (kwnames == NULL) ? 0 : PyTuple_GET_SIZE(kwnames);
333 Py_ssize_t nd;
334
335 assert(PyFunction_Check(func));
Jeroen Demeyeraacc77f2019-05-29 20:31:52 +0200336 Py_ssize_t nargs = PyVectorcall_NARGS(nargsf);
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100337 assert(nargs >= 0);
338 assert(kwnames == NULL || PyTuple_CheckExact(kwnames));
339 assert((nargs == 0 && nkwargs == 0) || stack != NULL);
Jeroen Demeyer05677862019-08-16 12:41:27 +0200340 /* kwnames must only contain strings and all keys must be unique */
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100341
342 if (co->co_kwonlyargcount == 0 && nkwargs == 0 &&
Victor Stinner086c3ae2017-10-25 05:26:17 -0700343 (co->co_flags & ~PyCF_MASK) == (CO_OPTIMIZED | CO_NEWLOCALS | CO_NOFREE))
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100344 {
Pablo Galindocd74e662019-06-01 18:08:04 +0100345 if (argdefs == NULL && co->co_argcount == nargs) {
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100346 return function_code_fastcall(co, stack, nargs, globals);
347 }
348 else if (nargs == 0 && argdefs != NULL
Pablo Galindocd74e662019-06-01 18:08:04 +0100349 && co->co_argcount == PyTuple_GET_SIZE(argdefs)) {
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100350 /* function called with no arguments, but all parameters have
351 a default value: use default values as arguments .*/
Victor Stinnerd17a6932018-11-09 16:56:48 +0100352 stack = _PyTuple_ITEMS(argdefs);
Serhiy Storchakafff9a312017-03-21 08:53:25 +0200353 return function_code_fastcall(co, stack, PyTuple_GET_SIZE(argdefs),
354 globals);
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100355 }
356 }
357
358 kwdefs = PyFunction_GET_KW_DEFAULTS(func);
359 closure = PyFunction_GET_CLOSURE(func);
360 name = ((PyFunctionObject *)func) -> func_name;
361 qualname = ((PyFunctionObject *)func) -> func_qualname;
362
363 if (argdefs != NULL) {
Victor Stinnerd17a6932018-11-09 16:56:48 +0100364 d = _PyTuple_ITEMS(argdefs);
Serhiy Storchakafff9a312017-03-21 08:53:25 +0200365 nd = PyTuple_GET_SIZE(argdefs);
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100366 }
367 else {
368 d = NULL;
369 nd = 0;
370 }
371 return _PyEval_EvalCodeWithName((PyObject*)co, globals, (PyObject *)NULL,
372 stack, nargs,
Victor Stinnerd17a6932018-11-09 16:56:48 +0100373 nkwargs ? _PyTuple_ITEMS(kwnames) : NULL,
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100374 stack + nargs,
375 nkwargs, 1,
376 d, (int)nd, kwdefs,
377 closure, name, qualname);
378}
379
380
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100381/* --- More complex call functions -------------------------------- */
382
383/* External interface to call any callable object.
384 The args must be a tuple or NULL. The kwargs must be a dict or NULL. */
385PyObject *
386PyEval_CallObjectWithKeywords(PyObject *callable,
387 PyObject *args, PyObject *kwargs)
388{
389#ifdef Py_DEBUG
390 /* PyEval_CallObjectWithKeywords() must not be called with an exception
391 set. It raises a new exception if parameters are invalid or if
392 PyTuple_New() fails, and so the original exception is lost. */
393 assert(!PyErr_Occurred());
394#endif
395
INADA Naoki3824cd82017-03-01 20:41:03 +0900396 if (args != NULL && !PyTuple_Check(args)) {
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100397 PyErr_SetString(PyExc_TypeError,
398 "argument list must be a tuple");
399 return NULL;
400 }
401
402 if (kwargs != NULL && !PyDict_Check(kwargs)) {
403 PyErr_SetString(PyExc_TypeError,
404 "keyword list must be a dictionary");
405 return NULL;
406 }
407
INADA Naoki3824cd82017-03-01 20:41:03 +0900408 if (args == NULL) {
409 return _PyObject_FastCallDict(callable, NULL, 0, kwargs);
410 }
411 else {
412 return PyObject_Call(callable, args, kwargs);
413 }
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100414}
415
416
417PyObject *
418PyObject_CallObject(PyObject *callable, PyObject *args)
419{
Jeroen Demeyer1dbd0842019-07-11 17:57:32 +0200420 assert(!PyErr_Occurred());
421 if (args == NULL) {
422 return _PyObject_CallNoArg(callable);
423 }
424 if (!PyTuple_Check(args)) {
425 PyErr_SetString(PyExc_TypeError,
426 "argument list must be a tuple");
427 return NULL;
428 }
429 return PyObject_Call(callable, args, NULL);
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100430}
431
432
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100433/* Call callable(obj, *args, **kwargs). */
434PyObject *
435_PyObject_Call_Prepend(PyObject *callable,
436 PyObject *obj, PyObject *args, PyObject *kwargs)
437{
438 PyObject *small_stack[_PY_FASTCALL_SMALL_STACK];
439 PyObject **stack;
440 Py_ssize_t argcount;
441 PyObject *result;
442
443 assert(PyTuple_Check(args));
444
445 argcount = PyTuple_GET_SIZE(args);
446 if (argcount + 1 <= (Py_ssize_t)Py_ARRAY_LENGTH(small_stack)) {
447 stack = small_stack;
448 }
449 else {
450 stack = PyMem_Malloc((argcount + 1) * sizeof(PyObject *));
451 if (stack == NULL) {
452 PyErr_NoMemory();
453 return NULL;
454 }
455 }
456
457 /* use borrowed references */
458 stack[0] = obj;
459 memcpy(&stack[1],
Victor Stinnerd17a6932018-11-09 16:56:48 +0100460 _PyTuple_ITEMS(args),
461 argcount * sizeof(PyObject *));
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100462
463 result = _PyObject_FastCallDict(callable,
464 stack, argcount + 1,
465 kwargs);
466 if (stack != small_stack) {
467 PyMem_Free(stack);
468 }
469 return result;
470}
471
472
473/* --- Call with a format string ---------------------------------- */
474
475static PyObject *
476_PyObject_CallFunctionVa(PyObject *callable, const char *format,
477 va_list va, int is_size_t)
478{
479 PyObject* small_stack[_PY_FASTCALL_SMALL_STACK];
480 const Py_ssize_t small_stack_len = Py_ARRAY_LENGTH(small_stack);
481 PyObject **stack;
482 Py_ssize_t nargs, i;
483 PyObject *result;
484
485 if (callable == NULL) {
486 return null_error();
487 }
488
489 if (!format || !*format) {
490 return _PyObject_CallNoArg(callable);
491 }
492
493 if (is_size_t) {
494 stack = _Py_VaBuildStack_SizeT(small_stack, small_stack_len,
495 format, va, &nargs);
496 }
497 else {
498 stack = _Py_VaBuildStack(small_stack, small_stack_len,
499 format, va, &nargs);
500 }
501 if (stack == NULL) {
502 return NULL;
503 }
504
505 if (nargs == 1 && PyTuple_Check(stack[0])) {
506 /* Special cases for backward compatibility:
507 - PyObject_CallFunction(func, "O", tuple) calls func(*tuple)
508 - PyObject_CallFunction(func, "(OOO)", arg1, arg2, arg3) calls
509 func(*(arg1, arg2, arg3)): func(arg1, arg2, arg3) */
510 PyObject *args = stack[0];
511 result = _PyObject_FastCall(callable,
Victor Stinnerd17a6932018-11-09 16:56:48 +0100512 _PyTuple_ITEMS(args),
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100513 PyTuple_GET_SIZE(args));
514 }
515 else {
516 result = _PyObject_FastCall(callable, stack, nargs);
517 }
518
519 for (i = 0; i < nargs; ++i) {
520 Py_DECREF(stack[i]);
521 }
522 if (stack != small_stack) {
523 PyMem_Free(stack);
524 }
525 return result;
526}
527
528
529PyObject *
530PyObject_CallFunction(PyObject *callable, const char *format, ...)
531{
532 va_list va;
533 PyObject *result;
534
535 va_start(va, format);
536 result = _PyObject_CallFunctionVa(callable, format, va, 0);
537 va_end(va);
538
539 return result;
540}
541
542
INADA Naokiaa289a52017-03-14 18:00:59 +0900543/* PyEval_CallFunction is exact copy of PyObject_CallFunction.
544 * This function is kept for backward compatibility.
545 */
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100546PyObject *
547PyEval_CallFunction(PyObject *callable, const char *format, ...)
548{
INADA Naokiaa289a52017-03-14 18:00:59 +0900549 va_list va;
550 PyObject *result;
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100551
INADA Naokiaa289a52017-03-14 18:00:59 +0900552 va_start(va, format);
553 result = _PyObject_CallFunctionVa(callable, format, va, 0);
554 va_end(va);
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100555
INADA Naokiaa289a52017-03-14 18:00:59 +0900556 return result;
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100557}
558
559
560PyObject *
561_PyObject_CallFunction_SizeT(PyObject *callable, const char *format, ...)
562{
563 va_list va;
564 PyObject *result;
565
566 va_start(va, format);
567 result = _PyObject_CallFunctionVa(callable, format, va, 1);
568 va_end(va);
569
570 return result;
571}
572
573
574static PyObject*
575callmethod(PyObject* callable, const char *format, va_list va, int is_size_t)
576{
577 assert(callable != NULL);
578
579 if (!PyCallable_Check(callable)) {
580 PyErr_Format(PyExc_TypeError,
581 "attribute of type '%.200s' is not callable",
582 Py_TYPE(callable)->tp_name);
583 return NULL;
584 }
585
586 return _PyObject_CallFunctionVa(callable, format, va, is_size_t);
587}
588
589
590PyObject *
591PyObject_CallMethod(PyObject *obj, const char *name, const char *format, ...)
592{
593 va_list va;
594 PyObject *callable, *retval;
595
596 if (obj == NULL || name == NULL) {
597 return null_error();
598 }
599
600 callable = PyObject_GetAttrString(obj, name);
601 if (callable == NULL)
602 return NULL;
603
604 va_start(va, format);
605 retval = callmethod(callable, format, va, 0);
606 va_end(va);
607
608 Py_DECREF(callable);
609 return retval;
610}
611
612
INADA Naokiaa289a52017-03-14 18:00:59 +0900613/* PyEval_CallMethod is exact copy of PyObject_CallMethod.
614 * This function is kept for backward compatibility.
615 */
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100616PyObject *
617PyEval_CallMethod(PyObject *obj, const char *name, const char *format, ...)
618{
INADA Naokiaa289a52017-03-14 18:00:59 +0900619 va_list va;
620 PyObject *callable, *retval;
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100621
INADA Naokiaa289a52017-03-14 18:00:59 +0900622 if (obj == NULL || name == NULL) {
623 return null_error();
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100624 }
625
INADA Naokiaa289a52017-03-14 18:00:59 +0900626 callable = PyObject_GetAttrString(obj, name);
627 if (callable == NULL)
628 return NULL;
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100629
INADA Naokiaa289a52017-03-14 18:00:59 +0900630 va_start(va, format);
631 retval = callmethod(callable, format, va, 0);
632 va_end(va);
633
634 Py_DECREF(callable);
635 return retval;
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100636}
637
638
639PyObject *
640_PyObject_CallMethodId(PyObject *obj, _Py_Identifier *name,
641 const char *format, ...)
642{
643 va_list va;
644 PyObject *callable, *retval;
645
646 if (obj == NULL || name == NULL) {
647 return null_error();
648 }
649
650 callable = _PyObject_GetAttrId(obj, name);
651 if (callable == NULL)
652 return NULL;
653
654 va_start(va, format);
655 retval = callmethod(callable, format, va, 0);
656 va_end(va);
657
658 Py_DECREF(callable);
659 return retval;
660}
661
662
663PyObject *
664_PyObject_CallMethod_SizeT(PyObject *obj, const char *name,
665 const char *format, ...)
666{
667 va_list va;
668 PyObject *callable, *retval;
669
670 if (obj == NULL || name == NULL) {
671 return null_error();
672 }
673
674 callable = PyObject_GetAttrString(obj, name);
675 if (callable == NULL)
676 return NULL;
677
678 va_start(va, format);
679 retval = callmethod(callable, format, va, 1);
680 va_end(va);
681
682 Py_DECREF(callable);
683 return retval;
684}
685
686
687PyObject *
688_PyObject_CallMethodId_SizeT(PyObject *obj, _Py_Identifier *name,
689 const char *format, ...)
690{
691 va_list va;
692 PyObject *callable, *retval;
693
694 if (obj == NULL || name == NULL) {
695 return null_error();
696 }
697
698 callable = _PyObject_GetAttrId(obj, name);
699 if (callable == NULL) {
700 return NULL;
701 }
702
703 va_start(va, format);
704 retval = callmethod(callable, format, va, 1);
705 va_end(va);
706
707 Py_DECREF(callable);
708 return retval;
709}
710
711
712/* --- Call with "..." arguments ---------------------------------- */
713
714static PyObject *
Michael J. Sullivan47dd2f92019-05-26 00:23:34 -0700715object_vacall(PyObject *base, PyObject *callable, va_list vargs)
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100716{
717 PyObject *small_stack[_PY_FASTCALL_SMALL_STACK];
718 PyObject **stack;
719 Py_ssize_t nargs;
720 PyObject *result;
721 Py_ssize_t i;
722 va_list countva;
723
724 if (callable == NULL) {
725 return null_error();
726 }
727
728 /* Count the number of arguments */
729 va_copy(countva, vargs);
Michael J. Sullivan47dd2f92019-05-26 00:23:34 -0700730 nargs = base ? 1 : 0;
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100731 while (1) {
732 PyObject *arg = va_arg(countva, PyObject *);
733 if (arg == NULL) {
734 break;
735 }
736 nargs++;
737 }
738 va_end(countva);
739
740 /* Copy arguments */
741 if (nargs <= (Py_ssize_t)Py_ARRAY_LENGTH(small_stack)) {
742 stack = small_stack;
743 }
744 else {
745 stack = PyMem_Malloc(nargs * sizeof(stack[0]));
746 if (stack == NULL) {
747 PyErr_NoMemory();
748 return NULL;
749 }
750 }
751
Michael J. Sullivan47dd2f92019-05-26 00:23:34 -0700752 i = 0;
753 if (base) {
754 stack[i++] = base;
755 }
756
757 for (; i < nargs; ++i) {
Victor Stinnerc22bfaa2017-02-12 19:27:05 +0100758 stack[i] = va_arg(vargs, PyObject *);
759 }
760
761 /* Call the function */
762 result = _PyObject_FastCall(callable, stack, nargs);
763
764 if (stack != small_stack) {
765 PyMem_Free(stack);
766 }
767 return result;
768}
769
770
Michael J. Sullivan47dd2f92019-05-26 00:23:34 -0700771PyObject *
Jeroen Demeyerb1263d52019-06-28 11:49:00 +0200772_PyObject_VectorcallMethod(PyObject *name, PyObject *const *args,
773 size_t nargsf, PyObject *kwnames)
774{
775 assert(name != NULL);
776 assert(args != NULL);
777 assert(PyVectorcall_NARGS(nargsf) >= 1);
778
779 PyObject *callable = NULL;
780 /* Use args[0] as "self" argument */
781 int unbound = _PyObject_GetMethod(args[0], name, &callable);
782 if (callable == NULL) {
783 return NULL;
784 }
785
786 if (unbound) {
787 /* We must remove PY_VECTORCALL_ARGUMENTS_OFFSET since
788 * that would be interpreted as allowing to change args[-1] */
789 nargsf &= ~PY_VECTORCALL_ARGUMENTS_OFFSET;
790 }
791 else {
792 /* Skip "self". We can keep PY_VECTORCALL_ARGUMENTS_OFFSET since
793 * args[-1] in the onward call is args[0] here. */
794 args++;
795 nargsf--;
796 }
797 PyObject *result = _PyObject_Vectorcall(callable, args, nargsf, kwnames);
798 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}