blob: 103a11152412117802b245dbe38c02b2b07cb44c [file] [log] [blame]
Guido van Rossumf70e43a1991-02-19 12:39:46 +00001
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00002/* System module */
3
4/*
5Various bits of information used by the interpreter are collected in
6module 'sys'.
Guido van Rossum3f5da241990-12-20 15:06:42 +00007Function member:
Guido van Rossumcc8914f1995-03-20 15:09:40 +00008- exit(sts): raise SystemExit
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00009Data members:
10- stdin, stdout, stderr: standard file objects
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000011- modules: the table of modules (dictionary)
Guido van Rossum3f5da241990-12-20 15:06:42 +000012- path: module search path (list of strings)
13- argv: script arguments (list of strings)
14- ps1, ps2: optional primary and secondary prompts (strings)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000015*/
16
Guido van Rossum65bf9f21997-04-29 18:33:38 +000017#include "Python.h"
Jeremy Hylton3e0055f2005-10-20 19:59:25 +000018#include "code.h"
Barry Warsawb6a54d22000-12-06 21:47:46 +000019#include "frameobject.h"
Victor Stinner838f2642019-06-13 22:41:23 +020020#include "pycore_ceval.h"
Victor Stinner331a6a52019-05-27 16:39:22 +020021#include "pycore_initconfig.h"
Victor Stinner838f2642019-06-13 22:41:23 +020022#include "pycore_pathconfig.h"
23#include "pycore_pyerrors.h"
Victor Stinner621cebe2018-11-12 16:53:38 +010024#include "pycore_pylifecycle.h"
25#include "pycore_pymem.h"
Victor Stinner621cebe2018-11-12 16:53:38 +010026#include "pycore_pystate.h"
Steve Dowerb82e17e2019-05-23 08:45:22 -070027#include "pycore_tupleobject.h"
Victor Stinnerd5c355c2011-04-30 14:53:09 +020028#include "pythread.h"
Steve Dowerb82e17e2019-05-23 08:45:22 -070029#include "pydtrace.h"
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000030
Guido van Rossume2437a11992-03-23 18:20:18 +000031#include "osdefs.h"
Stefan Krah1845d142016-04-25 21:38:53 +020032#include <locale.h>
Guido van Rossum3f5da241990-12-20 15:06:42 +000033
Mark Hammond8696ebc2002-10-08 02:44:31 +000034#ifdef MS_WINDOWS
35#define WIN32_LEAN_AND_MEAN
Amaury Forgeot d'Arc06cfe952007-11-10 13:55:44 +000036#include <windows.h>
Mark Hammond8696ebc2002-10-08 02:44:31 +000037#endif /* MS_WINDOWS */
38
Guido van Rossum9b38a141996-09-11 23:12:24 +000039#ifdef MS_COREDLL
Guido van Rossumc606fe11996-04-09 02:37:57 +000040extern void *PyWin_DLLhModule;
Guido van Rossum6c1e5f21997-09-29 23:34:23 +000041/* A string loaded from the DLL at startup: */
42extern const char *PyWin_DLLVersionString;
Guido van Rossumc606fe11996-04-09 02:37:57 +000043#endif
44
Nathaniel J. Smithfc2f4072018-01-21 06:44:07 -080045/*[clinic input]
46module sys
47[clinic start generated code]*/
48/*[clinic end generated code: output=da39a3ee5e6b4b0d input=3726b388feee8cea]*/
49
50#include "clinic/sysmodule.c.h"
51
Victor Stinnerbd303c12013-11-07 23:07:29 +010052_Py_IDENTIFIER(_);
53_Py_IDENTIFIER(__sizeof__);
Eric Snowdae02762017-09-14 00:35:58 -070054_Py_IDENTIFIER(_xoptions);
Victor Stinnerbd303c12013-11-07 23:07:29 +010055_Py_IDENTIFIER(buffer);
56_Py_IDENTIFIER(builtins);
57_Py_IDENTIFIER(encoding);
58_Py_IDENTIFIER(path);
59_Py_IDENTIFIER(stdout);
60_Py_IDENTIFIER(stderr);
Eric Snowdae02762017-09-14 00:35:58 -070061_Py_IDENTIFIER(warnoptions);
Victor Stinnerbd303c12013-11-07 23:07:29 +010062_Py_IDENTIFIER(write);
63
Victor Stinner838f2642019-06-13 22:41:23 +020064static PyObject *
65sys_get_object_id(PyThreadState *tstate, _Py_Identifier *key)
Victor Stinnerd67bd452013-11-06 22:36:40 +010066{
Victor Stinner838f2642019-06-13 22:41:23 +020067 PyObject *sd = tstate->interp->sysdict;
Victor Stinnercaba55b2018-08-03 15:33:52 +020068 if (sd == NULL) {
Victor Stinnerd67bd452013-11-06 22:36:40 +010069 return NULL;
Victor Stinnercaba55b2018-08-03 15:33:52 +020070 }
Victor Stinnerd67bd452013-11-06 22:36:40 +010071 return _PyDict_GetItemId(sd, key);
72}
73
74PyObject *
Victor Stinner838f2642019-06-13 22:41:23 +020075_PySys_GetObjectId(_Py_Identifier *key)
76{
77 PyThreadState *tstate = _PyThreadState_GET();
78 return sys_get_object_id(tstate, key);
79}
80
81PyObject *
Neal Norwitzf3081322007-08-25 00:32:45 +000082PySys_GetObject(const char *name)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000083{
Victor Stinner838f2642019-06-13 22:41:23 +020084 PyThreadState *tstate = _PyThreadState_GET();
85 PyObject *sd = tstate->interp->sysdict;
Victor Stinnercaba55b2018-08-03 15:33:52 +020086 if (sd == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000087 return NULL;
Victor Stinnercaba55b2018-08-03 15:33:52 +020088 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000089 return PyDict_GetItemString(sd, name);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000090}
91
Victor Stinner838f2642019-06-13 22:41:23 +020092static int
93sys_set_object_id(PyThreadState *tstate, _Py_Identifier *key, PyObject *v)
Victor Stinnerd67bd452013-11-06 22:36:40 +010094{
Victor Stinner838f2642019-06-13 22:41:23 +020095 PyObject *sd = tstate->interp->sysdict;
Victor Stinnerd67bd452013-11-06 22:36:40 +010096 if (v == NULL) {
Victor Stinnercaba55b2018-08-03 15:33:52 +020097 if (_PyDict_GetItemId(sd, key) == NULL) {
Victor Stinnerd67bd452013-11-06 22:36:40 +010098 return 0;
Victor Stinnercaba55b2018-08-03 15:33:52 +020099 }
100 else {
Victor Stinnerd67bd452013-11-06 22:36:40 +0100101 return _PyDict_DelItemId(sd, key);
Victor Stinnercaba55b2018-08-03 15:33:52 +0200102 }
Victor Stinnerd67bd452013-11-06 22:36:40 +0100103 }
Victor Stinnercaba55b2018-08-03 15:33:52 +0200104 else {
Victor Stinnerd67bd452013-11-06 22:36:40 +0100105 return _PyDict_SetItemId(sd, key, v);
Victor Stinnercaba55b2018-08-03 15:33:52 +0200106 }
Victor Stinnerd67bd452013-11-06 22:36:40 +0100107}
108
109int
Victor Stinner838f2642019-06-13 22:41:23 +0200110_PySys_SetObjectId(_Py_Identifier *key, PyObject *v)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000111{
Victor Stinner838f2642019-06-13 22:41:23 +0200112 PyThreadState *tstate = _PyThreadState_GET();
113 return sys_set_object_id(tstate, key, v);
114}
115
116static int
117sys_set_object(PyThreadState *tstate, const char *name, PyObject *v)
118{
119 PyObject *sd = tstate->interp->sysdict;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000120 if (v == NULL) {
Victor Stinnercaba55b2018-08-03 15:33:52 +0200121 if (PyDict_GetItemString(sd, name) == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000122 return 0;
Victor Stinnercaba55b2018-08-03 15:33:52 +0200123 }
124 else {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000125 return PyDict_DelItemString(sd, name);
Victor Stinnercaba55b2018-08-03 15:33:52 +0200126 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000127 }
Victor Stinnercaba55b2018-08-03 15:33:52 +0200128 else {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000129 return PyDict_SetItemString(sd, name, v);
Victor Stinnercaba55b2018-08-03 15:33:52 +0200130 }
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000131}
132
Victor Stinner838f2642019-06-13 22:41:23 +0200133int
134PySys_SetObject(const char *name, PyObject *v)
Steve Dowerb82e17e2019-05-23 08:45:22 -0700135{
Victor Stinner838f2642019-06-13 22:41:23 +0200136 PyThreadState *tstate = _PyThreadState_GET();
137 return sys_set_object(tstate, name, v);
138}
139
140static int
141should_audit(PyThreadState *ts)
142{
Steve Dowerb82e17e2019-05-23 08:45:22 -0700143 if (!ts) {
144 return 0;
145 }
Victor Stinner0fd2c302019-06-04 03:15:09 +0200146 PyInterpreterState *is = ts ? ts->interp : NULL;
147 return _PyRuntime.audit_hook_head
Steve Dowerb82e17e2019-05-23 08:45:22 -0700148 || (is && is->audit_hooks)
149 || PyDTrace_AUDIT_ENABLED();
150}
151
152int
153PySys_Audit(const char *event, const char *argFormat, ...)
154{
155 PyObject *eventName = NULL;
156 PyObject *eventArgs = NULL;
157 PyObject *hooks = NULL;
158 PyObject *hook = NULL;
159 int res = -1;
Victor Stinner838f2642019-06-13 22:41:23 +0200160 PyThreadState *ts = _PyThreadState_GET();
Steve Dowerb82e17e2019-05-23 08:45:22 -0700161
162 /* N format is inappropriate, because you do not know
163 whether the reference is consumed by the call.
164 Assert rather than exception for perf reasons */
165 assert(!argFormat || !strchr(argFormat, 'N'));
166
167 /* Early exit when no hooks are registered */
Victor Stinner838f2642019-06-13 22:41:23 +0200168 if (!should_audit(ts)) {
Steve Dowerb82e17e2019-05-23 08:45:22 -0700169 return 0;
170 }
171
172 _Py_AuditHookEntry *e = _PyRuntime.audit_hook_head;
Steve Dowerb82e17e2019-05-23 08:45:22 -0700173 int dtrace = PyDTrace_AUDIT_ENABLED();
174
175 PyObject *exc_type, *exc_value, *exc_tb;
176 if (ts) {
Victor Stinner838f2642019-06-13 22:41:23 +0200177 _PyErr_Fetch(ts, &exc_type, &exc_value, &exc_tb);
Steve Dowerb82e17e2019-05-23 08:45:22 -0700178 }
179
180 /* Initialize event args now */
181 if (argFormat && argFormat[0]) {
182 va_list args;
183 va_start(args, argFormat);
184 eventArgs = Py_VaBuildValue(argFormat, args);
Zackery Spytz08286d52019-06-21 09:31:59 -0600185 va_end(args);
Steve Dowerb82e17e2019-05-23 08:45:22 -0700186 if (eventArgs && !PyTuple_Check(eventArgs)) {
187 PyObject *argTuple = PyTuple_Pack(1, eventArgs);
188 Py_DECREF(eventArgs);
189 eventArgs = argTuple;
190 }
191 } else {
192 eventArgs = PyTuple_New(0);
193 }
194 if (!eventArgs) {
195 goto exit;
196 }
197
198 /* Call global hooks */
199 for (; e; e = e->next) {
200 if (e->hookCFunction(event, eventArgs, e->userData) < 0) {
201 goto exit;
202 }
203 }
204
205 /* Dtrace USDT point */
206 if (dtrace) {
207 PyDTrace_AUDIT(event, (void *)eventArgs);
208 }
209
210 /* Call interpreter hooks */
Victor Stinner838f2642019-06-13 22:41:23 +0200211 PyInterpreterState *is = ts ? ts->interp : NULL;
Steve Dowerb82e17e2019-05-23 08:45:22 -0700212 if (is && is->audit_hooks) {
213 eventName = PyUnicode_FromString(event);
214 if (!eventName) {
215 goto exit;
216 }
217
218 hooks = PyObject_GetIter(is->audit_hooks);
219 if (!hooks) {
220 goto exit;
221 }
222
223 /* Disallow tracing in hooks unless explicitly enabled */
224 ts->tracing++;
225 ts->use_tracing = 0;
226 while ((hook = PyIter_Next(hooks)) != NULL) {
227 PyObject *o;
228 int canTrace = -1;
229 o = PyObject_GetAttrString(hook, "__cantrace__");
230 if (o) {
231 canTrace = PyObject_IsTrue(o);
232 Py_DECREF(o);
Victor Stinner838f2642019-06-13 22:41:23 +0200233 } else if (_PyErr_Occurred(ts) &&
234 _PyErr_ExceptionMatches(ts, PyExc_AttributeError)) {
235 _PyErr_Clear(ts);
Steve Dowerb82e17e2019-05-23 08:45:22 -0700236 canTrace = 0;
237 }
238 if (canTrace < 0) {
239 break;
240 }
241 if (canTrace) {
242 ts->use_tracing = (ts->c_tracefunc || ts->c_profilefunc);
243 ts->tracing--;
244 }
245 o = PyObject_CallFunctionObjArgs(hook, eventName,
246 eventArgs, NULL);
247 if (canTrace) {
248 ts->tracing++;
249 ts->use_tracing = 0;
250 }
251 if (!o) {
252 break;
253 }
254 Py_DECREF(o);
255 Py_CLEAR(hook);
256 }
257 ts->use_tracing = (ts->c_tracefunc || ts->c_profilefunc);
258 ts->tracing--;
Victor Stinner838f2642019-06-13 22:41:23 +0200259 if (_PyErr_Occurred(ts)) {
Steve Dowerb82e17e2019-05-23 08:45:22 -0700260 goto exit;
261 }
262 }
263
264 res = 0;
265
266exit:
267 Py_XDECREF(hook);
268 Py_XDECREF(hooks);
269 Py_XDECREF(eventName);
270 Py_XDECREF(eventArgs);
271
272 if (ts) {
273 if (!res) {
Victor Stinner838f2642019-06-13 22:41:23 +0200274 _PyErr_Restore(ts, exc_type, exc_value, exc_tb);
Steve Dowerb82e17e2019-05-23 08:45:22 -0700275 } else {
Victor Stinner838f2642019-06-13 22:41:23 +0200276 assert(_PyErr_Occurred(ts));
Steve Dowerb82e17e2019-05-23 08:45:22 -0700277 Py_XDECREF(exc_type);
278 Py_XDECREF(exc_value);
279 Py_XDECREF(exc_tb);
280 }
281 }
282
283 return res;
284}
285
286/* We expose this function primarily for our own cleanup during
287 * finalization. In general, it should not need to be called,
288 * and as such it is not defined in any header files.
289 */
Victor Stinner838f2642019-06-13 22:41:23 +0200290void
291_PySys_ClearAuditHooks(void)
292{
Steve Dowerb82e17e2019-05-23 08:45:22 -0700293 /* Must be finalizing to clear hooks */
294 _PyRuntimeState *runtime = &_PyRuntime;
295 PyThreadState *ts = _PyRuntimeState_GetThreadState(runtime);
296 assert(!ts || _Py_CURRENTLY_FINALIZING(runtime, ts));
Victor Stinner838f2642019-06-13 22:41:23 +0200297 if (!ts || !_Py_CURRENTLY_FINALIZING(runtime, ts)) {
Steve Dowerb82e17e2019-05-23 08:45:22 -0700298 return;
Victor Stinner838f2642019-06-13 22:41:23 +0200299 }
Steve Dowerb82e17e2019-05-23 08:45:22 -0700300
Victor Stinner838f2642019-06-13 22:41:23 +0200301 const PyConfig *config = &ts->interp->config;
302 if (config->verbose) {
Steve Dowerb82e17e2019-05-23 08:45:22 -0700303 PySys_WriteStderr("# clear sys.audit hooks\n");
304 }
305
306 /* Hooks can abort later hooks for this event, but cannot
307 abort the clear operation itself. */
308 PySys_Audit("cpython._PySys_ClearAuditHooks", NULL);
Victor Stinner838f2642019-06-13 22:41:23 +0200309 _PyErr_Clear(ts);
Steve Dowerb82e17e2019-05-23 08:45:22 -0700310
Victor Stinner0fd2c302019-06-04 03:15:09 +0200311 _Py_AuditHookEntry *e = _PyRuntime.audit_hook_head, *n;
312 _PyRuntime.audit_hook_head = NULL;
Steve Dowerb82e17e2019-05-23 08:45:22 -0700313 while (e) {
314 n = e->next;
315 PyMem_RawFree(e);
316 e = n;
317 }
318}
319
320int
321PySys_AddAuditHook(Py_AuditHookFunction hook, void *userData)
322{
Victor Stinner838f2642019-06-13 22:41:23 +0200323 _PyRuntimeState *runtime = &_PyRuntime;
324 PyThreadState *tstate = _PyRuntimeState_GetThreadState(runtime);
325
Steve Dowerb82e17e2019-05-23 08:45:22 -0700326 /* Invoke existing audit hooks to allow them an opportunity to abort. */
327 /* Cannot invoke hooks until we are initialized */
Victor Stinner838f2642019-06-13 22:41:23 +0200328 if (runtime->initialized) {
Steve Dowerb82e17e2019-05-23 08:45:22 -0700329 if (PySys_Audit("sys.addaudithook", NULL) < 0) {
Victor Stinner838f2642019-06-13 22:41:23 +0200330 if (_PyErr_ExceptionMatches(tstate, PyExc_Exception)) {
Steve Dowerb82e17e2019-05-23 08:45:22 -0700331 /* We do not report errors derived from Exception */
Victor Stinner838f2642019-06-13 22:41:23 +0200332 _PyErr_Clear(tstate);
Steve Dowerb82e17e2019-05-23 08:45:22 -0700333 return 0;
334 }
335 return -1;
336 }
337 }
338
Victor Stinner0fd2c302019-06-04 03:15:09 +0200339 _Py_AuditHookEntry *e = _PyRuntime.audit_hook_head;
Steve Dowerb82e17e2019-05-23 08:45:22 -0700340 if (!e) {
341 e = (_Py_AuditHookEntry*)PyMem_RawMalloc(sizeof(_Py_AuditHookEntry));
Victor Stinner0fd2c302019-06-04 03:15:09 +0200342 _PyRuntime.audit_hook_head = e;
Steve Dowerb82e17e2019-05-23 08:45:22 -0700343 } else {
Victor Stinner838f2642019-06-13 22:41:23 +0200344 while (e->next) {
Steve Dowerb82e17e2019-05-23 08:45:22 -0700345 e = e->next;
Victor Stinner838f2642019-06-13 22:41:23 +0200346 }
Steve Dowerb82e17e2019-05-23 08:45:22 -0700347 e = e->next = (_Py_AuditHookEntry*)PyMem_RawMalloc(
348 sizeof(_Py_AuditHookEntry));
349 }
350
351 if (!e) {
Victor Stinner838f2642019-06-13 22:41:23 +0200352 if (runtime->initialized) {
353 _PyErr_NoMemory(tstate);
354 }
Steve Dowerb82e17e2019-05-23 08:45:22 -0700355 return -1;
356 }
357
358 e->next = NULL;
359 e->hookCFunction = (Py_AuditHookFunction)hook;
360 e->userData = userData;
361
362 return 0;
363}
364
365/*[clinic input]
366sys.addaudithook
367
368 hook: object
369
370Adds a new audit hook callback.
371[clinic start generated code]*/
372
373static PyObject *
374sys_addaudithook_impl(PyObject *module, PyObject *hook)
375/*[clinic end generated code: output=4f9c17aaeb02f44e input=0f3e191217a45e34]*/
376{
Victor Stinner838f2642019-06-13 22:41:23 +0200377 PyThreadState *tstate = _PyThreadState_GET();
378
Steve Dowerb82e17e2019-05-23 08:45:22 -0700379 /* Invoke existing audit hooks to allow them an opportunity to abort. */
380 if (PySys_Audit("sys.addaudithook", NULL) < 0) {
Victor Stinner838f2642019-06-13 22:41:23 +0200381 if (_PyErr_ExceptionMatches(tstate, PyExc_Exception)) {
Steve Dowerb82e17e2019-05-23 08:45:22 -0700382 /* We do not report errors derived from Exception */
Victor Stinner838f2642019-06-13 22:41:23 +0200383 _PyErr_Clear(tstate);
Steve Dowerb82e17e2019-05-23 08:45:22 -0700384 Py_RETURN_NONE;
385 }
386 return NULL;
387 }
388
Victor Stinner838f2642019-06-13 22:41:23 +0200389 PyInterpreterState *is = tstate->interp;
Steve Dowerb82e17e2019-05-23 08:45:22 -0700390
391 if (is->audit_hooks == NULL) {
392 is->audit_hooks = PyList_New(0);
393 if (is->audit_hooks == NULL) {
394 return NULL;
395 }
396 }
397
398 if (PyList_Append(is->audit_hooks, hook) < 0) {
399 return NULL;
400 }
401
402 Py_RETURN_NONE;
403}
404
405PyDoc_STRVAR(audit_doc,
406"audit(event, *args)\n\
407\n\
408Passes the event to any audit hooks that are attached.");
409
410static PyObject *
411sys_audit(PyObject *self, PyObject *const *args, Py_ssize_t argc)
412{
Victor Stinner838f2642019-06-13 22:41:23 +0200413 PyThreadState *tstate = _PyThreadState_GET();
414
Steve Dowerb82e17e2019-05-23 08:45:22 -0700415 if (argc == 0) {
Victor Stinner838f2642019-06-13 22:41:23 +0200416 _PyErr_SetString(tstate, PyExc_TypeError,
417 "audit() missing 1 required positional argument: "
418 "'event'");
Steve Dowerb82e17e2019-05-23 08:45:22 -0700419 return NULL;
420 }
421
Victor Stinner838f2642019-06-13 22:41:23 +0200422 if (!should_audit(tstate)) {
Steve Dowerb82e17e2019-05-23 08:45:22 -0700423 Py_RETURN_NONE;
424 }
425
426 PyObject *auditEvent = args[0];
427 if (!auditEvent) {
Victor Stinner838f2642019-06-13 22:41:23 +0200428 _PyErr_SetString(tstate, PyExc_TypeError,
429 "expected str for argument 'event'");
Steve Dowerb82e17e2019-05-23 08:45:22 -0700430 return NULL;
431 }
432 if (!PyUnicode_Check(auditEvent)) {
Victor Stinner838f2642019-06-13 22:41:23 +0200433 _PyErr_Format(tstate, PyExc_TypeError,
434 "expected str for argument 'event', not %.200s",
435 Py_TYPE(auditEvent)->tp_name);
Steve Dowerb82e17e2019-05-23 08:45:22 -0700436 return NULL;
437 }
438 const char *event = PyUnicode_AsUTF8(auditEvent);
439 if (!event) {
440 return NULL;
441 }
442
443 PyObject *auditArgs = _PyTuple_FromArray(args + 1, argc - 1);
444 if (!auditArgs) {
445 return NULL;
446 }
447
448 int res = PySys_Audit(event, "O", auditArgs);
449 Py_DECREF(auditArgs);
450
451 if (res < 0) {
452 return NULL;
453 }
454
455 Py_RETURN_NONE;
456}
457
458
Barry Warsaw36c1d1f2017-10-05 12:11:18 -0400459static PyObject *
Serhiy Storchakaa5552f02017-12-15 13:11:11 +0200460sys_breakpointhook(PyObject *self, PyObject *const *args, Py_ssize_t nargs, PyObject *keywords)
Barry Warsaw36c1d1f2017-10-05 12:11:18 -0400461{
Victor Stinner838f2642019-06-13 22:41:23 +0200462 PyThreadState *tstate = _PyThreadState_GET();
463 assert(!_PyErr_Occurred(tstate));
Serhiy Storchakaf60bf0e2018-07-09 21:46:51 +0300464 char *envar = Py_GETENV("PYTHONBREAKPOINT");
Barry Warsaw36c1d1f2017-10-05 12:11:18 -0400465
466 if (envar == NULL || strlen(envar) == 0) {
467 envar = "pdb.set_trace";
468 }
469 else if (!strcmp(envar, "0")) {
470 /* The breakpoint is explicitly no-op'd. */
471 Py_RETURN_NONE;
472 }
Serhiy Storchakaf60bf0e2018-07-09 21:46:51 +0300473 /* According to POSIX the string returned by getenv() might be invalidated
474 * or the string content might be overwritten by a subsequent call to
475 * getenv(). Since importing a module can performs the getenv() calls,
476 * we need to save a copy of envar. */
477 envar = _PyMem_RawStrdup(envar);
478 if (envar == NULL) {
Victor Stinner838f2642019-06-13 22:41:23 +0200479 _PyErr_NoMemory(tstate);
Serhiy Storchakaf60bf0e2018-07-09 21:46:51 +0300480 return NULL;
481 }
Serhiy Storchaka4ae06c52017-12-12 13:55:04 +0200482 const char *last_dot = strrchr(envar, '.');
483 const char *attrname = NULL;
Barry Warsaw36c1d1f2017-10-05 12:11:18 -0400484 PyObject *modulepath = NULL;
485
486 if (last_dot == NULL) {
487 /* The breakpoint is a built-in, e.g. PYTHONBREAKPOINT=int */
488 modulepath = PyUnicode_FromString("builtins");
489 attrname = envar;
490 }
Serhiy Storchaka3607ef42019-01-15 13:26:38 +0200491 else if (last_dot != envar) {
Barry Warsaw36c1d1f2017-10-05 12:11:18 -0400492 /* Split on the last dot; */
493 modulepath = PyUnicode_FromStringAndSize(envar, last_dot - envar);
494 attrname = last_dot + 1;
495 }
Serhiy Storchaka3607ef42019-01-15 13:26:38 +0200496 else {
497 goto warn;
498 }
Barry Warsaw36c1d1f2017-10-05 12:11:18 -0400499 if (modulepath == NULL) {
Serhiy Storchakaf60bf0e2018-07-09 21:46:51 +0300500 PyMem_RawFree(envar);
Barry Warsaw36c1d1f2017-10-05 12:11:18 -0400501 return NULL;
502 }
503
Anthony Sottiledce345c2018-11-01 10:25:05 -0700504 PyObject *module = PyImport_Import(modulepath);
Barry Warsaw36c1d1f2017-10-05 12:11:18 -0400505 Py_DECREF(modulepath);
Barry Warsaw36c1d1f2017-10-05 12:11:18 -0400506
507 if (module == NULL) {
Victor Stinner838f2642019-06-13 22:41:23 +0200508 if (_PyErr_ExceptionMatches(tstate, PyExc_ImportError)) {
Serhiy Storchaka3607ef42019-01-15 13:26:38 +0200509 goto warn;
510 }
511 PyMem_RawFree(envar);
512 return NULL;
Barry Warsaw36c1d1f2017-10-05 12:11:18 -0400513 }
514
515 PyObject *hook = PyObject_GetAttrString(module, attrname);
516 Py_DECREF(module);
517
518 if (hook == NULL) {
Victor Stinner838f2642019-06-13 22:41:23 +0200519 if (_PyErr_ExceptionMatches(tstate, PyExc_AttributeError)) {
Serhiy Storchaka3607ef42019-01-15 13:26:38 +0200520 goto warn;
521 }
522 PyMem_RawFree(envar);
523 return NULL;
Barry Warsaw36c1d1f2017-10-05 12:11:18 -0400524 }
Serhiy Storchakaf60bf0e2018-07-09 21:46:51 +0300525 PyMem_RawFree(envar);
Jeroen Demeyeraacc77f2019-05-29 20:31:52 +0200526 PyObject *retval = _PyObject_Vectorcall(hook, args, nargs, keywords);
Barry Warsaw36c1d1f2017-10-05 12:11:18 -0400527 Py_DECREF(hook);
528 return retval;
529
Serhiy Storchaka3607ef42019-01-15 13:26:38 +0200530 warn:
Barry Warsaw36c1d1f2017-10-05 12:11:18 -0400531 /* If any of the imports went wrong, then warn and ignore. */
Victor Stinner838f2642019-06-13 22:41:23 +0200532 _PyErr_Clear(tstate);
Barry Warsaw36c1d1f2017-10-05 12:11:18 -0400533 int status = PyErr_WarnFormat(
534 PyExc_RuntimeWarning, 0,
535 "Ignoring unimportable $PYTHONBREAKPOINT: \"%s\"", envar);
Serhiy Storchakaf60bf0e2018-07-09 21:46:51 +0300536 PyMem_RawFree(envar);
Barry Warsaw36c1d1f2017-10-05 12:11:18 -0400537 if (status < 0) {
538 /* Printing the warning raised an exception. */
539 return NULL;
540 }
541 /* The warning was (probably) issued. */
542 Py_RETURN_NONE;
543}
544
545PyDoc_STRVAR(breakpointhook_doc,
546"breakpointhook(*args, **kws)\n"
547"\n"
548"This hook function is called by built-in breakpoint().\n"
549);
550
Victor Stinner13d49ee2010-12-04 17:24:33 +0000551/* Write repr(o) to sys.stdout using sys.stdout.encoding and 'backslashreplace'
552 error handler. If sys.stdout has a buffer attribute, use
553 sys.stdout.buffer.write(encoded), otherwise redecode the string and use
554 sys.stdout.write(redecoded).
555
556 Helper function for sys_displayhook(). */
557static int
Victor Stinner838f2642019-06-13 22:41:23 +0200558sys_displayhook_unencodable(PyThreadState *tstate, PyObject *outf, PyObject *o)
Victor Stinner13d49ee2010-12-04 17:24:33 +0000559{
560 PyObject *stdout_encoding = NULL;
561 PyObject *encoded, *escaped_str, *repr_str, *buffer, *result;
Serhiy Storchaka85b0f5b2016-11-20 10:16:47 +0200562 const char *stdout_encoding_str;
Victor Stinner13d49ee2010-12-04 17:24:33 +0000563 int ret;
564
Martin v. Löwis1ee1b6f2011-10-10 18:11:30 +0200565 stdout_encoding = _PyObject_GetAttrId(outf, &PyId_encoding);
Victor Stinner13d49ee2010-12-04 17:24:33 +0000566 if (stdout_encoding == NULL)
567 goto error;
Serhiy Storchaka06515832016-11-20 09:13:07 +0200568 stdout_encoding_str = PyUnicode_AsUTF8(stdout_encoding);
Victor Stinner13d49ee2010-12-04 17:24:33 +0000569 if (stdout_encoding_str == NULL)
570 goto error;
571
572 repr_str = PyObject_Repr(o);
573 if (repr_str == NULL)
574 goto error;
575 encoded = PyUnicode_AsEncodedString(repr_str,
576 stdout_encoding_str,
577 "backslashreplace");
578 Py_DECREF(repr_str);
579 if (encoded == NULL)
580 goto error;
581
Martin v. Löwis1ee1b6f2011-10-10 18:11:30 +0200582 buffer = _PyObject_GetAttrId(outf, &PyId_buffer);
Victor Stinner13d49ee2010-12-04 17:24:33 +0000583 if (buffer) {
Jeroen Demeyer59ad1102019-07-11 10:59:05 +0200584 result = _PyObject_CallMethodIdOneArg(buffer, &PyId_write, encoded);
Victor Stinner13d49ee2010-12-04 17:24:33 +0000585 Py_DECREF(buffer);
586 Py_DECREF(encoded);
587 if (result == NULL)
588 goto error;
589 Py_DECREF(result);
590 }
591 else {
Victor Stinner838f2642019-06-13 22:41:23 +0200592 _PyErr_Clear(tstate);
Victor Stinner13d49ee2010-12-04 17:24:33 +0000593 escaped_str = PyUnicode_FromEncodedObject(encoded,
594 stdout_encoding_str,
595 "strict");
596 Py_DECREF(encoded);
597 if (PyFile_WriteObject(escaped_str, outf, Py_PRINT_RAW) != 0) {
598 Py_DECREF(escaped_str);
599 goto error;
600 }
601 Py_DECREF(escaped_str);
602 }
603 ret = 0;
604 goto finally;
605
606error:
607 ret = -1;
608finally:
609 Py_XDECREF(stdout_encoding);
610 return ret;
611}
612
Tal Einatede0b6f2018-12-31 17:12:08 +0200613/*[clinic input]
614sys.displayhook
615
616 object as o: object
617 /
618
619Print an object to sys.stdout and also save it in builtins._
620[clinic start generated code]*/
621
Guido van Rossum65bf9f21997-04-29 18:33:38 +0000622static PyObject *
Tal Einatede0b6f2018-12-31 17:12:08 +0200623sys_displayhook(PyObject *module, PyObject *o)
624/*[clinic end generated code: output=347477d006df92ed input=08ba730166d7ef72]*/
Moshe Zadkaf68f2fe2001-01-11 05:41:27 +0000625{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000626 PyObject *outf;
Victor Stinnerd02fbb82013-11-06 18:27:13 +0100627 PyObject *builtins;
628 static PyObject *newline = NULL;
Victor Stinner13d49ee2010-12-04 17:24:33 +0000629 int err;
Victor Stinner838f2642019-06-13 22:41:23 +0200630 PyThreadState *tstate = _PyThreadState_GET();
Moshe Zadkaf68f2fe2001-01-11 05:41:27 +0000631
Eric Snow3f9eee62017-09-15 16:35:20 -0600632 builtins = _PyImport_GetModuleId(&PyId_builtins);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000633 if (builtins == NULL) {
Victor Stinner838f2642019-06-13 22:41:23 +0200634 if (!_PyErr_Occurred(tstate)) {
635 _PyErr_SetString(tstate, PyExc_RuntimeError,
636 "lost builtins module");
Stefan Krah027b09c2019-03-25 21:50:58 +0100637 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000638 return NULL;
639 }
Eric Snow3f9eee62017-09-15 16:35:20 -0600640 Py_DECREF(builtins);
Moshe Zadka03897ea2001-07-23 13:32:43 +0000641
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000642 /* Print value except if None */
643 /* After printing, also assign to '_' */
644 /* Before, set '_' to None to avoid recursion */
645 if (o == Py_None) {
Serhiy Storchaka228b12e2017-01-23 09:47:21 +0200646 Py_RETURN_NONE;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000647 }
Martin v. Löwis1c67dd92011-10-14 15:16:45 +0200648 if (_PyObject_SetAttrId(builtins, &PyId__, Py_None) != 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000649 return NULL;
Victor Stinner838f2642019-06-13 22:41:23 +0200650 outf = sys_get_object_id(tstate, &PyId_stdout);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000651 if (outf == NULL || outf == Py_None) {
Victor Stinner838f2642019-06-13 22:41:23 +0200652 _PyErr_SetString(tstate, PyExc_RuntimeError, "lost sys.stdout");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000653 return NULL;
654 }
Victor Stinner13d49ee2010-12-04 17:24:33 +0000655 if (PyFile_WriteObject(o, outf, 0) != 0) {
Victor Stinner838f2642019-06-13 22:41:23 +0200656 if (_PyErr_ExceptionMatches(tstate, PyExc_UnicodeEncodeError)) {
Victor Stinner13d49ee2010-12-04 17:24:33 +0000657 /* repr(o) is not encodable to sys.stdout.encoding with
658 * sys.stdout.errors error handler (which is probably 'strict') */
Victor Stinner838f2642019-06-13 22:41:23 +0200659 _PyErr_Clear(tstate);
660 err = sys_displayhook_unencodable(tstate, outf, o);
661 if (err) {
Victor Stinner13d49ee2010-12-04 17:24:33 +0000662 return NULL;
Victor Stinner838f2642019-06-13 22:41:23 +0200663 }
Victor Stinner13d49ee2010-12-04 17:24:33 +0000664 }
665 else {
666 return NULL;
667 }
668 }
Victor Stinnerd02fbb82013-11-06 18:27:13 +0100669 if (newline == NULL) {
670 newline = PyUnicode_FromString("\n");
671 if (newline == NULL)
672 return NULL;
673 }
674 if (PyFile_WriteObject(newline, outf, Py_PRINT_RAW) != 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000675 return NULL;
Martin v. Löwis1c67dd92011-10-14 15:16:45 +0200676 if (_PyObject_SetAttrId(builtins, &PyId__, o) != 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000677 return NULL;
Serhiy Storchaka228b12e2017-01-23 09:47:21 +0200678 Py_RETURN_NONE;
Moshe Zadkaf68f2fe2001-01-11 05:41:27 +0000679}
680
Tal Einatede0b6f2018-12-31 17:12:08 +0200681
682/*[clinic input]
683sys.excepthook
684
685 exctype: object
686 value: object
687 traceback: object
688 /
689
690Handle an exception by displaying it with a traceback on sys.stderr.
691[clinic start generated code]*/
Ka-Ping Yeeb5c51322001-03-23 02:46:52 +0000692
693static PyObject *
Tal Einatede0b6f2018-12-31 17:12:08 +0200694sys_excepthook_impl(PyObject *module, PyObject *exctype, PyObject *value,
695 PyObject *traceback)
696/*[clinic end generated code: output=18d99fdda21b6b5e input=ecf606fa826f19d9]*/
Ka-Ping Yeeb5c51322001-03-23 02:46:52 +0000697{
Tal Einatede0b6f2018-12-31 17:12:08 +0200698 PyErr_Display(exctype, value, traceback);
Serhiy Storchaka228b12e2017-01-23 09:47:21 +0200699 Py_RETURN_NONE;
Ka-Ping Yeeb5c51322001-03-23 02:46:52 +0000700}
701
Tal Einatede0b6f2018-12-31 17:12:08 +0200702
703/*[clinic input]
704sys.exc_info
705
706Return current exception information: (type, value, traceback).
707
708Return information about the most recent exception caught by an except
709clause in the current stack frame or in an older stack frame.
710[clinic start generated code]*/
Moshe Zadkaf68f2fe2001-01-11 05:41:27 +0000711
712static PyObject *
Tal Einatede0b6f2018-12-31 17:12:08 +0200713sys_exc_info_impl(PyObject *module)
714/*[clinic end generated code: output=3afd0940cf3a4d30 input=b5c5bf077788a3e5]*/
Guido van Rossuma027efa1997-05-05 20:56:21 +0000715{
Victor Stinner50b48572018-11-01 01:51:40 +0100716 _PyErr_StackItem *err_info = _PyErr_GetTopmostException(_PyThreadState_GET());
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000717 return Py_BuildValue(
718 "(OOO)",
Mark Shannonae3087c2017-10-22 22:41:51 +0100719 err_info->exc_type != NULL ? err_info->exc_type : Py_None,
720 err_info->exc_value != NULL ? err_info->exc_value : Py_None,
721 err_info->exc_traceback != NULL ?
722 err_info->exc_traceback : Py_None);
Guido van Rossuma027efa1997-05-05 20:56:21 +0000723}
724
Tal Einatede0b6f2018-12-31 17:12:08 +0200725
726/*[clinic input]
Victor Stinneref9d9b62019-05-22 11:28:22 +0200727sys.unraisablehook
728
729 unraisable: object
730 /
731
732Handle an unraisable exception.
733
734The unraisable argument has the following attributes:
735
736* exc_type: Exception type.
Victor Stinner71c52e32019-05-27 08:57:14 +0200737* exc_value: Exception value, can be None.
738* exc_traceback: Exception traceback, can be None.
739* err_msg: Error message, can be None.
740* object: Object causing the exception, can be None.
Victor Stinneref9d9b62019-05-22 11:28:22 +0200741[clinic start generated code]*/
742
743static PyObject *
744sys_unraisablehook(PyObject *module, PyObject *unraisable)
Victor Stinner71c52e32019-05-27 08:57:14 +0200745/*[clinic end generated code: output=bb92838b32abaa14 input=ec3af148294af8d3]*/
Victor Stinneref9d9b62019-05-22 11:28:22 +0200746{
747 return _PyErr_WriteUnraisableDefaultHook(unraisable);
748}
749
750
751/*[clinic input]
Tal Einatede0b6f2018-12-31 17:12:08 +0200752sys.exit
753
754 status: object = NULL
755 /
756
757Exit the interpreter by raising SystemExit(status).
758
759If the status is omitted or None, it defaults to zero (i.e., success).
760If the status is an integer, it will be used as the system exit status.
761If it is another kind of object, it will be printed and the system
762exit status will be one (i.e., failure).
763[clinic start generated code]*/
Guido van Rossum46d3dc32003-03-01 03:20:41 +0000764
765static PyObject *
Tal Einatede0b6f2018-12-31 17:12:08 +0200766sys_exit_impl(PyObject *module, PyObject *status)
767/*[clinic end generated code: output=13870986c1ab2ec0 input=a737351f86685e9c]*/
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000768{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000769 /* Raise SystemExit so callers may catch it or clean up. */
Victor Stinner838f2642019-06-13 22:41:23 +0200770 PyThreadState *tstate = _PyThreadState_GET();
771 _PyErr_SetObject(tstate, PyExc_SystemExit, status);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000772 return NULL;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000773}
774
Guido van Rossumc3bc31e1998-06-27 19:43:25 +0000775
Martin v. Löwis107b7da2001-11-09 20:59:39 +0000776
Tal Einatede0b6f2018-12-31 17:12:08 +0200777/*[clinic input]
778sys.getdefaultencoding
779
780Return the current default encoding used by the Unicode implementation.
781[clinic start generated code]*/
782
Guido van Rossum65bf9f21997-04-29 18:33:38 +0000783static PyObject *
Tal Einatede0b6f2018-12-31 17:12:08 +0200784sys_getdefaultencoding_impl(PyObject *module)
785/*[clinic end generated code: output=256d19dfcc0711e6 input=d416856ddbef6909]*/
Fred Drake8b4d01d2000-05-09 19:57:01 +0000786{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000787 return PyUnicode_FromString(PyUnicode_GetDefaultEncoding());
Fred Drake8b4d01d2000-05-09 19:57:01 +0000788}
789
Tal Einatede0b6f2018-12-31 17:12:08 +0200790/*[clinic input]
791sys.getfilesystemencoding
792
793Return the encoding used to convert Unicode filenames to OS filenames.
794[clinic start generated code]*/
Fred Drake8b4d01d2000-05-09 19:57:01 +0000795
796static PyObject *
Tal Einatede0b6f2018-12-31 17:12:08 +0200797sys_getfilesystemencoding_impl(PyObject *module)
798/*[clinic end generated code: output=1dc4bdbe9be44aa7 input=8475f8649b8c7d8c]*/
Martin v. Löwis73d538b2003-03-05 15:13:47 +0000799{
Victor Stinner838f2642019-06-13 22:41:23 +0200800 PyThreadState *tstate = _PyThreadState_GET();
801 const PyConfig *config = &tstate->interp->config;
Victor Stinner709d23d2019-05-02 14:56:30 -0400802 return PyUnicode_FromWideChar(config->filesystem_encoding, -1);
Martin v. Löwis73d538b2003-03-05 15:13:47 +0000803}
804
Tal Einatede0b6f2018-12-31 17:12:08 +0200805/*[clinic input]
806sys.getfilesystemencodeerrors
807
808Return the error mode used Unicode to OS filename conversion.
809[clinic start generated code]*/
Martin v. Löwis73d538b2003-03-05 15:13:47 +0000810
Martin v. Löwis04dc25c2008-10-03 16:09:28 +0000811static PyObject *
Tal Einatede0b6f2018-12-31 17:12:08 +0200812sys_getfilesystemencodeerrors_impl(PyObject *module)
813/*[clinic end generated code: output=ba77b36bbf7c96f5 input=22a1e8365566f1e5]*/
Steve Dowercc16be82016-09-08 10:35:16 -0700814{
Victor Stinner838f2642019-06-13 22:41:23 +0200815 PyThreadState *tstate = _PyThreadState_GET();
816 const PyConfig *config = &tstate->interp->config;
Victor Stinner709d23d2019-05-02 14:56:30 -0400817 return PyUnicode_FromWideChar(config->filesystem_errors, -1);
Steve Dowercc16be82016-09-08 10:35:16 -0700818}
819
Tal Einatede0b6f2018-12-31 17:12:08 +0200820/*[clinic input]
821sys.intern
822
823 string as s: unicode
824 /
825
826``Intern'' the given string.
827
828This enters the string in the (global) table of interned strings whose
829purpose is to speed up dictionary lookups. Return the string itself or
830the previously interned string object with the same value.
831[clinic start generated code]*/
Steve Dowercc16be82016-09-08 10:35:16 -0700832
833static PyObject *
Tal Einatede0b6f2018-12-31 17:12:08 +0200834sys_intern_impl(PyObject *module, PyObject *s)
835/*[clinic end generated code: output=be680c24f5c9e5d6 input=849483c006924e2f]*/
Georg Brandl66a796e2006-12-19 20:50:34 +0000836{
Victor Stinner838f2642019-06-13 22:41:23 +0200837 PyThreadState *tstate = _PyThreadState_GET();
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000838 if (PyUnicode_CheckExact(s)) {
839 Py_INCREF(s);
840 PyUnicode_InternInPlace(&s);
841 return s;
842 }
843 else {
Victor Stinner838f2642019-06-13 22:41:23 +0200844 _PyErr_Format(tstate, PyExc_TypeError,
845 "can't intern %.400s", s->ob_type->tp_name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000846 return NULL;
847 }
Georg Brandl66a796e2006-12-19 20:50:34 +0000848}
849
Georg Brandl66a796e2006-12-19 20:50:34 +0000850
Fred Drake5755ce62001-06-27 19:19:46 +0000851/*
852 * Cached interned string objects used for calling the profile and
853 * trace functions. Initialized by trace_init().
854 */
Nick Coghlan5a851672017-09-08 10:14:16 +1000855static PyObject *whatstrings[8] = {NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL};
Fred Drake5755ce62001-06-27 19:19:46 +0000856
857static int
858trace_init(void)
859{
Nick Coghlan5a851672017-09-08 10:14:16 +1000860 static const char * const whatnames[8] = {
Serhiy Storchaka2d06e842015-12-25 19:53:18 +0200861 "call", "exception", "line", "return",
Nick Coghlan5a851672017-09-08 10:14:16 +1000862 "c_call", "c_exception", "c_return",
863 "opcode"
Serhiy Storchaka2d06e842015-12-25 19:53:18 +0200864 };
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000865 PyObject *name;
866 int i;
Nick Coghlan5a851672017-09-08 10:14:16 +1000867 for (i = 0; i < 8; ++i) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000868 if (whatstrings[i] == NULL) {
869 name = PyUnicode_InternFromString(whatnames[i]);
870 if (name == NULL)
871 return -1;
872 whatstrings[i] = name;
873 }
874 }
875 return 0;
Fred Drake5755ce62001-06-27 19:19:46 +0000876}
877
878
879static PyObject *
Victor Stinnerfdeb6ec2013-12-13 02:01:38 +0100880call_trampoline(PyObject* callback,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000881 PyFrameObject *frame, int what, PyObject *arg)
Fred Drake5755ce62001-06-27 19:19:46 +0000882{
Victor Stinner78da82b2016-08-20 01:22:57 +0200883 if (PyFrame_FastToLocalsWithError(frame) < 0) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000884 return NULL;
Victor Stinner78da82b2016-08-20 01:22:57 +0200885 }
Victor Stinner41bb43a2013-10-29 01:19:37 +0100886
Victor Stinner838f2642019-06-13 22:41:23 +0200887 PyObject *stack[3];
Victor Stinner78da82b2016-08-20 01:22:57 +0200888 stack[0] = (PyObject *)frame;
889 stack[1] = whatstrings[what];
890 stack[2] = (arg != NULL) ? arg : Py_None;
Fred Drake5755ce62001-06-27 19:19:46 +0000891
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000892 /* call the Python-level function */
Victor Stinner838f2642019-06-13 22:41:23 +0200893 PyObject *result = _PyObject_FastCall(callback, stack, 3);
Fred Drake5755ce62001-06-27 19:19:46 +0000894
Victor Stinner78da82b2016-08-20 01:22:57 +0200895 PyFrame_LocalsToFast(frame, 1);
896 if (result == NULL) {
897 PyTraceBack_Here(frame);
898 }
899
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000900 return result;
Fred Drake5755ce62001-06-27 19:19:46 +0000901}
902
903static int
904profile_trampoline(PyObject *self, PyFrameObject *frame,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000905 int what, PyObject *arg)
Fred Drake5755ce62001-06-27 19:19:46 +0000906{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000907 PyObject *result;
Fred Drake5755ce62001-06-27 19:19:46 +0000908
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000909 if (arg == NULL)
910 arg = Py_None;
Victor Stinnerfdeb6ec2013-12-13 02:01:38 +0100911 result = call_trampoline(self, frame, what, arg);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000912 if (result == NULL) {
913 PyEval_SetProfile(NULL, NULL);
914 return -1;
915 }
916 Py_DECREF(result);
917 return 0;
Fred Drake5755ce62001-06-27 19:19:46 +0000918}
919
920static int
921trace_trampoline(PyObject *self, PyFrameObject *frame,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000922 int what, PyObject *arg)
Fred Drake5755ce62001-06-27 19:19:46 +0000923{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000924 PyObject *callback;
925 PyObject *result;
Fred Drake5755ce62001-06-27 19:19:46 +0000926
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000927 if (what == PyTrace_CALL)
928 callback = self;
929 else
930 callback = frame->f_trace;
931 if (callback == NULL)
932 return 0;
Victor Stinnerfdeb6ec2013-12-13 02:01:38 +0100933 result = call_trampoline(callback, frame, what, arg);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000934 if (result == NULL) {
935 PyEval_SetTrace(NULL, NULL);
Serhiy Storchaka505ff752014-02-09 13:33:53 +0200936 Py_CLEAR(frame->f_trace);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000937 return -1;
938 }
939 if (result != Py_None) {
Serhiy Storchakaec397562016-04-06 09:50:03 +0300940 Py_XSETREF(frame->f_trace, result);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000941 }
942 else {
943 Py_DECREF(result);
944 }
945 return 0;
Fred Drake5755ce62001-06-27 19:19:46 +0000946}
Fred Draked0838392001-06-16 21:02:31 +0000947
Fred Drake8b4d01d2000-05-09 19:57:01 +0000948static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000949sys_settrace(PyObject *self, PyObject *args)
Guido van Rossume2437a11992-03-23 18:20:18 +0000950{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000951 if (trace_init() == -1)
952 return NULL;
953 if (args == Py_None)
954 PyEval_SetTrace(NULL, NULL);
955 else
956 PyEval_SetTrace(trace_trampoline, args);
Serhiy Storchaka228b12e2017-01-23 09:47:21 +0200957 Py_RETURN_NONE;
Guido van Rossume2437a11992-03-23 18:20:18 +0000958}
959
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +0000960PyDoc_STRVAR(settrace_doc,
Guido van Rossumc3bc31e1998-06-27 19:43:25 +0000961"settrace(function)\n\
962\n\
963Set the global debug tracing function. It will be called on each\n\
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +0000964function call. See the debugger chapter in the library manual."
965);
Guido van Rossumc3bc31e1998-06-27 19:43:25 +0000966
Tal Einatede0b6f2018-12-31 17:12:08 +0200967/*[clinic input]
968sys.gettrace
969
970Return the global debug tracing function set with sys.settrace.
971
972See the debugger chapter in the library manual.
973[clinic start generated code]*/
974
Guido van Rossum65bf9f21997-04-29 18:33:38 +0000975static PyObject *
Tal Einatede0b6f2018-12-31 17:12:08 +0200976sys_gettrace_impl(PyObject *module)
977/*[clinic end generated code: output=e97e3a4d8c971b6e input=373b51bb2147f4d8]*/
Christian Heimes9bd667a2008-01-20 15:14:11 +0000978{
Victor Stinner50b48572018-11-01 01:51:40 +0100979 PyThreadState *tstate = _PyThreadState_GET();
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000980 PyObject *temp = tstate->c_traceobj;
Christian Heimes9bd667a2008-01-20 15:14:11 +0000981
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000982 if (temp == NULL)
983 temp = Py_None;
984 Py_INCREF(temp);
985 return temp;
Christian Heimes9bd667a2008-01-20 15:14:11 +0000986}
987
Christian Heimes9bd667a2008-01-20 15:14:11 +0000988static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000989sys_setprofile(PyObject *self, PyObject *args)
Guido van Rossume2437a11992-03-23 18:20:18 +0000990{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000991 if (trace_init() == -1)
992 return NULL;
993 if (args == Py_None)
994 PyEval_SetProfile(NULL, NULL);
995 else
996 PyEval_SetProfile(profile_trampoline, args);
Serhiy Storchaka228b12e2017-01-23 09:47:21 +0200997 Py_RETURN_NONE;
Guido van Rossume2437a11992-03-23 18:20:18 +0000998}
999
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +00001000PyDoc_STRVAR(setprofile_doc,
Guido van Rossumc3bc31e1998-06-27 19:43:25 +00001001"setprofile(function)\n\
1002\n\
1003Set the profiling function. It will be called on each function call\n\
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +00001004and return. See the profiler chapter in the library manual."
1005);
Guido van Rossumc3bc31e1998-06-27 19:43:25 +00001006
Tal Einatede0b6f2018-12-31 17:12:08 +02001007/*[clinic input]
1008sys.getprofile
1009
1010Return the profiling function set with sys.setprofile.
1011
1012See the profiler chapter in the library manual.
1013[clinic start generated code]*/
1014
Guido van Rossum65bf9f21997-04-29 18:33:38 +00001015static PyObject *
Tal Einatede0b6f2018-12-31 17:12:08 +02001016sys_getprofile_impl(PyObject *module)
1017/*[clinic end generated code: output=579b96b373448188 input=1b3209d89a32965d]*/
Christian Heimes9bd667a2008-01-20 15:14:11 +00001018{
Victor Stinner50b48572018-11-01 01:51:40 +01001019 PyThreadState *tstate = _PyThreadState_GET();
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001020 PyObject *temp = tstate->c_profileobj;
Christian Heimes9bd667a2008-01-20 15:14:11 +00001021
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001022 if (temp == NULL)
1023 temp = Py_None;
1024 Py_INCREF(temp);
1025 return temp;
Christian Heimes9bd667a2008-01-20 15:14:11 +00001026}
1027
Tim Peterse5e065b2003-07-06 18:36:54 +00001028
Tal Einatede0b6f2018-12-31 17:12:08 +02001029/*[clinic input]
1030sys.setswitchinterval
1031
1032 interval: double
1033 /
1034
1035Set the ideal thread switching delay inside the Python interpreter.
1036
1037The actual frequency of switching threads can be lower if the
1038interpreter executes long sequences of uninterruptible code
1039(this is implementation-specific and workload-dependent).
1040
1041The parameter must represent the desired switching delay in seconds
1042A typical value is 0.005 (5 milliseconds).
1043[clinic start generated code]*/
Tim Peterse5e065b2003-07-06 18:36:54 +00001044
Antoine Pitrou074e5ed2009-11-10 19:50:40 +00001045static PyObject *
Tal Einatede0b6f2018-12-31 17:12:08 +02001046sys_setswitchinterval_impl(PyObject *module, double interval)
1047/*[clinic end generated code: output=65a19629e5153983 input=561b477134df91d9]*/
Antoine Pitrou074e5ed2009-11-10 19:50:40 +00001048{
Victor Stinner838f2642019-06-13 22:41:23 +02001049 PyThreadState *tstate = _PyThreadState_GET();
Tal Einatede0b6f2018-12-31 17:12:08 +02001050 if (interval <= 0.0) {
Victor Stinner838f2642019-06-13 22:41:23 +02001051 _PyErr_SetString(tstate, PyExc_ValueError,
1052 "switch interval must be strictly positive");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001053 return NULL;
1054 }
Tal Einatede0b6f2018-12-31 17:12:08 +02001055 _PyEval_SetSwitchInterval((unsigned long) (1e6 * interval));
Serhiy Storchaka228b12e2017-01-23 09:47:21 +02001056 Py_RETURN_NONE;
Antoine Pitrou074e5ed2009-11-10 19:50:40 +00001057}
1058
Antoine Pitrou074e5ed2009-11-10 19:50:40 +00001059
Tal Einatede0b6f2018-12-31 17:12:08 +02001060/*[clinic input]
1061sys.getswitchinterval -> double
1062
1063Return the current thread switch interval; see sys.setswitchinterval().
1064[clinic start generated code]*/
1065
1066static double
1067sys_getswitchinterval_impl(PyObject *module)
1068/*[clinic end generated code: output=a38c277c85b5096d input=bdf9d39c0ebbbb6f]*/
Antoine Pitrou074e5ed2009-11-10 19:50:40 +00001069{
Tal Einatede0b6f2018-12-31 17:12:08 +02001070 return 1e-6 * _PyEval_GetSwitchInterval();
Antoine Pitrou074e5ed2009-11-10 19:50:40 +00001071}
1072
Tal Einatede0b6f2018-12-31 17:12:08 +02001073/*[clinic input]
1074sys.setrecursionlimit
1075
1076 limit as new_limit: int
1077 /
1078
1079Set the maximum depth of the Python interpreter stack to n.
1080
1081This limit prevents infinite recursion from causing an overflow of the C
1082stack and crashing Python. The highest possible limit is platform-
1083dependent.
1084[clinic start generated code]*/
Antoine Pitrou074e5ed2009-11-10 19:50:40 +00001085
Tim Peterse5e065b2003-07-06 18:36:54 +00001086static PyObject *
Tal Einatede0b6f2018-12-31 17:12:08 +02001087sys_setrecursionlimit_impl(PyObject *module, int new_limit)
1088/*[clinic end generated code: output=35e1c64754800ace input=b0f7a23393924af3]*/
Jeremy Hyltonee5adfb2000-08-31 19:23:01 +00001089{
Tal Einatede0b6f2018-12-31 17:12:08 +02001090 int mark;
Victor Stinner838f2642019-06-13 22:41:23 +02001091 PyThreadState *tstate = _PyThreadState_GET();
Victor Stinner50856d52015-10-13 00:11:21 +02001092
Victor Stinner50856d52015-10-13 00:11:21 +02001093 if (new_limit < 1) {
Victor Stinner838f2642019-06-13 22:41:23 +02001094 _PyErr_SetString(tstate, PyExc_ValueError,
1095 "recursion limit must be greater or equal than 1");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001096 return NULL;
1097 }
Victor Stinner50856d52015-10-13 00:11:21 +02001098
1099 /* Issue #25274: When the recursion depth hits the recursion limit in
1100 _Py_CheckRecursiveCall(), the overflowed flag of the thread state is
1101 set to 1 and a RecursionError is raised. The overflowed flag is reset
1102 to 0 when the recursion depth goes below the low-water mark: see
1103 Py_LeaveRecursiveCall().
1104
1105 Reject too low new limit if the current recursion depth is higher than
1106 the new low-water mark. Otherwise it may not be possible anymore to
1107 reset the overflowed flag to 0. */
1108 mark = _Py_RecursionLimitLowerWaterMark(new_limit);
Victor Stinner50856d52015-10-13 00:11:21 +02001109 if (tstate->recursion_depth >= mark) {
Victor Stinner838f2642019-06-13 22:41:23 +02001110 _PyErr_Format(tstate, PyExc_RecursionError,
1111 "cannot set the recursion limit to %i at "
1112 "the recursion depth %i: the limit is too low",
1113 new_limit, tstate->recursion_depth);
Victor Stinner50856d52015-10-13 00:11:21 +02001114 return NULL;
1115 }
1116
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001117 Py_SetRecursionLimit(new_limit);
Serhiy Storchaka228b12e2017-01-23 09:47:21 +02001118 Py_RETURN_NONE;
Jeremy Hyltonee5adfb2000-08-31 19:23:01 +00001119}
1120
Nathaniel J. Smithfc2f4072018-01-21 06:44:07 -08001121/*[clinic input]
1122sys.set_coroutine_origin_tracking_depth
1123
1124 depth: int
1125
1126Enable or disable origin tracking for coroutine objects in this thread.
1127
Tal Einatede0b6f2018-12-31 17:12:08 +02001128Coroutine objects will track 'depth' frames of traceback information
1129about where they came from, available in their cr_origin attribute.
1130
1131Set a depth of 0 to disable.
Nathaniel J. Smithfc2f4072018-01-21 06:44:07 -08001132[clinic start generated code]*/
1133
1134static PyObject *
1135sys_set_coroutine_origin_tracking_depth_impl(PyObject *module, int depth)
Tal Einatede0b6f2018-12-31 17:12:08 +02001136/*[clinic end generated code: output=0a2123c1cc6759c5 input=a1d0a05f89d2c426]*/
Nathaniel J. Smithfc2f4072018-01-21 06:44:07 -08001137{
Victor Stinner838f2642019-06-13 22:41:23 +02001138 PyThreadState *tstate = _PyThreadState_GET();
Nathaniel J. Smithfc2f4072018-01-21 06:44:07 -08001139 if (depth < 0) {
Victor Stinner838f2642019-06-13 22:41:23 +02001140 _PyErr_SetString(tstate, PyExc_ValueError, "depth must be >= 0");
Nathaniel J. Smithfc2f4072018-01-21 06:44:07 -08001141 return NULL;
1142 }
Victor Stinner838f2642019-06-13 22:41:23 +02001143 _PyEval_SetCoroutineOriginTrackingDepth(tstate, depth);
Nathaniel J. Smithfc2f4072018-01-21 06:44:07 -08001144 Py_RETURN_NONE;
1145}
1146
1147/*[clinic input]
1148sys.get_coroutine_origin_tracking_depth -> int
1149
1150Check status of origin tracking for coroutine objects in this thread.
1151[clinic start generated code]*/
1152
1153static int
1154sys_get_coroutine_origin_tracking_depth_impl(PyObject *module)
1155/*[clinic end generated code: output=3699f7be95a3afb8 input=335266a71205b61a]*/
1156{
1157 return _PyEval_GetCoroutineOriginTrackingDepth();
1158}
1159
Yury Selivanoveb636452016-09-08 22:01:51 -07001160static PyTypeObject AsyncGenHooksType;
1161
1162PyDoc_STRVAR(asyncgen_hooks_doc,
1163"asyncgen_hooks\n\
1164\n\
1165A struct sequence providing information about asynhronous\n\
1166generators hooks. The attributes are read only.");
1167
1168static PyStructSequence_Field asyncgen_hooks_fields[] = {
1169 {"firstiter", "Hook to intercept first iteration"},
1170 {"finalizer", "Hook to intercept finalization"},
1171 {0}
1172};
1173
1174static PyStructSequence_Desc asyncgen_hooks_desc = {
1175 "asyncgen_hooks", /* name */
1176 asyncgen_hooks_doc, /* doc */
1177 asyncgen_hooks_fields , /* fields */
1178 2
1179};
1180
Yury Selivanoveb636452016-09-08 22:01:51 -07001181static PyObject *
1182sys_set_asyncgen_hooks(PyObject *self, PyObject *args, PyObject *kw)
1183{
1184 static char *keywords[] = {"firstiter", "finalizer", NULL};
1185 PyObject *firstiter = NULL;
1186 PyObject *finalizer = NULL;
Victor Stinner838f2642019-06-13 22:41:23 +02001187 PyThreadState *tstate = _PyThreadState_GET();
Yury Selivanoveb636452016-09-08 22:01:51 -07001188
1189 if (!PyArg_ParseTupleAndKeywords(
1190 args, kw, "|OO", keywords,
1191 &firstiter, &finalizer)) {
1192 return NULL;
1193 }
1194
1195 if (finalizer && finalizer != Py_None) {
1196 if (!PyCallable_Check(finalizer)) {
Victor Stinner838f2642019-06-13 22:41:23 +02001197 _PyErr_Format(tstate, PyExc_TypeError,
1198 "callable finalizer expected, got %.50s",
1199 Py_TYPE(finalizer)->tp_name);
Yury Selivanoveb636452016-09-08 22:01:51 -07001200 return NULL;
1201 }
1202 _PyEval_SetAsyncGenFinalizer(finalizer);
1203 }
1204 else if (finalizer == Py_None) {
1205 _PyEval_SetAsyncGenFinalizer(NULL);
1206 }
1207
1208 if (firstiter && firstiter != Py_None) {
1209 if (!PyCallable_Check(firstiter)) {
Victor Stinner838f2642019-06-13 22:41:23 +02001210 _PyErr_Format(tstate, PyExc_TypeError,
1211 "callable firstiter expected, got %.50s",
1212 Py_TYPE(firstiter)->tp_name);
Yury Selivanoveb636452016-09-08 22:01:51 -07001213 return NULL;
1214 }
1215 _PyEval_SetAsyncGenFirstiter(firstiter);
1216 }
1217 else if (firstiter == Py_None) {
1218 _PyEval_SetAsyncGenFirstiter(NULL);
1219 }
1220
1221 Py_RETURN_NONE;
1222}
1223
1224PyDoc_STRVAR(set_asyncgen_hooks_doc,
Tal Einatede0b6f2018-12-31 17:12:08 +02001225"set_asyncgen_hooks(* [, firstiter] [, finalizer])\n\
Yury Selivanoveb636452016-09-08 22:01:51 -07001226\n\
1227Set a finalizer for async generators objects."
1228);
1229
Tal Einatede0b6f2018-12-31 17:12:08 +02001230/*[clinic input]
1231sys.get_asyncgen_hooks
1232
1233Return the installed asynchronous generators hooks.
1234
1235This returns a namedtuple of the form (firstiter, finalizer).
1236[clinic start generated code]*/
1237
Yury Selivanoveb636452016-09-08 22:01:51 -07001238static PyObject *
Tal Einatede0b6f2018-12-31 17:12:08 +02001239sys_get_asyncgen_hooks_impl(PyObject *module)
1240/*[clinic end generated code: output=53a253707146f6cf input=3676b9ea62b14625]*/
Yury Selivanoveb636452016-09-08 22:01:51 -07001241{
1242 PyObject *res;
1243 PyObject *firstiter = _PyEval_GetAsyncGenFirstiter();
1244 PyObject *finalizer = _PyEval_GetAsyncGenFinalizer();
1245
1246 res = PyStructSequence_New(&AsyncGenHooksType);
1247 if (res == NULL) {
1248 return NULL;
1249 }
1250
1251 if (firstiter == NULL) {
1252 firstiter = Py_None;
1253 }
1254
1255 if (finalizer == NULL) {
1256 finalizer = Py_None;
1257 }
1258
1259 Py_INCREF(firstiter);
1260 PyStructSequence_SET_ITEM(res, 0, firstiter);
1261
1262 Py_INCREF(finalizer);
1263 PyStructSequence_SET_ITEM(res, 1, finalizer);
1264
1265 return res;
1266}
1267
Yury Selivanoveb636452016-09-08 22:01:51 -07001268
Mark Dickinsondc787d22010-05-23 13:33:13 +00001269static PyTypeObject Hash_InfoType;
1270
1271PyDoc_STRVAR(hash_info_doc,
1272"hash_info\n\
1273\n\
1274A struct sequence providing parameters used for computing\n\
Christian Heimes985ecdc2013-11-20 11:46:18 +01001275hashes. The attributes are read only.");
Mark Dickinsondc787d22010-05-23 13:33:13 +00001276
1277static PyStructSequence_Field hash_info_fields[] = {
1278 {"width", "width of the type used for hashing, in bits"},
1279 {"modulus", "prime number giving the modulus on which the hash "
1280 "function is based"},
1281 {"inf", "value to be used for hash of a positive infinity"},
1282 {"nan", "value to be used for hash of a nan"},
1283 {"imag", "multiplier used for the imaginary part of a complex number"},
Christian Heimes985ecdc2013-11-20 11:46:18 +01001284 {"algorithm", "name of the algorithm for hashing of str, bytes and "
1285 "memoryviews"},
1286 {"hash_bits", "internal output size of hash algorithm"},
1287 {"seed_bits", "seed size of hash algorithm"},
1288 {"cutoff", "small string optimization cutoff"},
Mark Dickinsondc787d22010-05-23 13:33:13 +00001289 {NULL, NULL}
1290};
1291
1292static PyStructSequence_Desc hash_info_desc = {
1293 "sys.hash_info",
1294 hash_info_doc,
1295 hash_info_fields,
Christian Heimes985ecdc2013-11-20 11:46:18 +01001296 9,
Mark Dickinsondc787d22010-05-23 13:33:13 +00001297};
1298
Matthias Klosed885e952010-07-06 10:53:30 +00001299static PyObject *
Victor Stinner838f2642019-06-13 22:41:23 +02001300get_hash_info(PyThreadState *tstate)
Mark Dickinsondc787d22010-05-23 13:33:13 +00001301{
1302 PyObject *hash_info;
1303 int field = 0;
Christian Heimes985ecdc2013-11-20 11:46:18 +01001304 PyHash_FuncDef *hashfunc;
Mark Dickinsondc787d22010-05-23 13:33:13 +00001305 hash_info = PyStructSequence_New(&Hash_InfoType);
1306 if (hash_info == NULL)
1307 return NULL;
Christian Heimes985ecdc2013-11-20 11:46:18 +01001308 hashfunc = PyHash_GetFuncDef();
Mark Dickinsondc787d22010-05-23 13:33:13 +00001309 PyStructSequence_SET_ITEM(hash_info, field++,
Benjamin Peterson8f67d082010-10-17 20:54:53 +00001310 PyLong_FromLong(8*sizeof(Py_hash_t)));
Mark Dickinsondc787d22010-05-23 13:33:13 +00001311 PyStructSequence_SET_ITEM(hash_info, field++,
Benjamin Peterson8035bc52010-10-23 16:20:50 +00001312 PyLong_FromSsize_t(_PyHASH_MODULUS));
Mark Dickinsondc787d22010-05-23 13:33:13 +00001313 PyStructSequence_SET_ITEM(hash_info, field++,
1314 PyLong_FromLong(_PyHASH_INF));
1315 PyStructSequence_SET_ITEM(hash_info, field++,
1316 PyLong_FromLong(_PyHASH_NAN));
1317 PyStructSequence_SET_ITEM(hash_info, field++,
1318 PyLong_FromLong(_PyHASH_IMAG));
Christian Heimes985ecdc2013-11-20 11:46:18 +01001319 PyStructSequence_SET_ITEM(hash_info, field++,
1320 PyUnicode_FromString(hashfunc->name));
1321 PyStructSequence_SET_ITEM(hash_info, field++,
1322 PyLong_FromLong(hashfunc->hash_bits));
1323 PyStructSequence_SET_ITEM(hash_info, field++,
1324 PyLong_FromLong(hashfunc->seed_bits));
1325 PyStructSequence_SET_ITEM(hash_info, field++,
1326 PyLong_FromLong(Py_HASH_CUTOFF));
Victor Stinner838f2642019-06-13 22:41:23 +02001327 if (_PyErr_Occurred(tstate)) {
Mark Dickinsondc787d22010-05-23 13:33:13 +00001328 Py_CLEAR(hash_info);
1329 return NULL;
1330 }
1331 return hash_info;
1332}
Tal Einatede0b6f2018-12-31 17:12:08 +02001333/*[clinic input]
1334sys.getrecursionlimit
Mark Dickinsondc787d22010-05-23 13:33:13 +00001335
Tal Einatede0b6f2018-12-31 17:12:08 +02001336Return the current value of the recursion limit.
Mark Dickinsondc787d22010-05-23 13:33:13 +00001337
Tal Einatede0b6f2018-12-31 17:12:08 +02001338The recursion limit is the maximum depth of the Python interpreter
1339stack. This limit prevents infinite recursion from causing an overflow
1340of the C stack and crashing Python.
1341[clinic start generated code]*/
Jeremy Hyltonee5adfb2000-08-31 19:23:01 +00001342
1343static PyObject *
Tal Einatede0b6f2018-12-31 17:12:08 +02001344sys_getrecursionlimit_impl(PyObject *module)
1345/*[clinic end generated code: output=d571fb6b4549ef2e input=1c6129fd2efaeea8]*/
Jeremy Hyltonee5adfb2000-08-31 19:23:01 +00001346{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001347 return PyLong_FromLong(Py_GetRecursionLimit());
Jeremy Hyltonee5adfb2000-08-31 19:23:01 +00001348}
1349
Mark Hammond8696ebc2002-10-08 02:44:31 +00001350#ifdef MS_WINDOWS
Mark Hammond8696ebc2002-10-08 02:44:31 +00001351
Eric Smithf7bb5782010-01-27 00:44:57 +00001352static PyTypeObject WindowsVersionType = {0, 0, 0, 0, 0, 0};
1353
1354static PyStructSequence_Field windows_version_fields[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001355 {"major", "Major version number"},
1356 {"minor", "Minor version number"},
1357 {"build", "Build number"},
1358 {"platform", "Operating system platform"},
1359 {"service_pack", "Latest Service Pack installed on the system"},
1360 {"service_pack_major", "Service Pack major version number"},
1361 {"service_pack_minor", "Service Pack minor version number"},
1362 {"suite_mask", "Bit mask identifying available product suites"},
1363 {"product_type", "System product type"},
Steve Dower74f4af72016-09-17 17:27:48 -07001364 {"platform_version", "Diagnostic version number"},
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001365 {0}
Eric Smithf7bb5782010-01-27 00:44:57 +00001366};
1367
1368static PyStructSequence_Desc windows_version_desc = {
Tal Einatede0b6f2018-12-31 17:12:08 +02001369 "sys.getwindowsversion", /* name */
1370 sys_getwindowsversion__doc__, /* doc */
1371 windows_version_fields, /* fields */
1372 5 /* For backward compatibility,
1373 only the first 5 items are accessible
1374 via indexing, the rest are name only */
Eric Smithf7bb5782010-01-27 00:44:57 +00001375};
1376
Steve Dower3e96f322015-03-02 08:01:10 -08001377/* Disable deprecation warnings about GetVersionEx as the result is
1378 being passed straight through to the caller, who is responsible for
1379 using it correctly. */
1380#pragma warning(push)
1381#pragma warning(disable:4996)
1382
Tal Einatede0b6f2018-12-31 17:12:08 +02001383/*[clinic input]
1384sys.getwindowsversion
1385
1386Return info about the running version of Windows as a named tuple.
1387
1388The members are named: major, minor, build, platform, service_pack,
1389service_pack_major, service_pack_minor, suite_mask, product_type and
1390platform_version. For backward compatibility, only the first 5 items
1391are available by indexing. All elements are numbers, except
1392service_pack and platform_type which are strings, and platform_version
1393which is a 3-tuple. Platform is always 2. Product_type may be 1 for a
1394workstation, 2 for a domain controller, 3 for a server.
1395Platform_version is a 3-tuple containing a version number that is
1396intended for identifying the OS rather than feature detection.
1397[clinic start generated code]*/
1398
Mark Hammond8696ebc2002-10-08 02:44:31 +00001399static PyObject *
Tal Einatede0b6f2018-12-31 17:12:08 +02001400sys_getwindowsversion_impl(PyObject *module)
1401/*[clinic end generated code: output=1ec063280b932857 input=73a228a328fee63a]*/
Mark Hammond8696ebc2002-10-08 02:44:31 +00001402{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001403 PyObject *version;
1404 int pos = 0;
Minmin Gong8ebc6452019-02-02 20:26:55 -08001405 OSVERSIONINFOEXW ver;
Steve Dower74f4af72016-09-17 17:27:48 -07001406 DWORD realMajor, realMinor, realBuild;
1407 HANDLE hKernel32;
1408 wchar_t kernel32_path[MAX_PATH];
1409 LPVOID verblock;
1410 DWORD verblock_size;
Victor Stinner838f2642019-06-13 22:41:23 +02001411 PyThreadState *tstate = _PyThreadState_GET();
Steve Dower74f4af72016-09-17 17:27:48 -07001412
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001413 ver.dwOSVersionInfoSize = sizeof(ver);
Minmin Gong8ebc6452019-02-02 20:26:55 -08001414 if (!GetVersionExW((OSVERSIONINFOW*) &ver))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001415 return PyErr_SetFromWindowsErr(0);
Eric Smithf7bb5782010-01-27 00:44:57 +00001416
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001417 version = PyStructSequence_New(&WindowsVersionType);
1418 if (version == NULL)
1419 return NULL;
Eric Smithf7bb5782010-01-27 00:44:57 +00001420
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001421 PyStructSequence_SET_ITEM(version, pos++, PyLong_FromLong(ver.dwMajorVersion));
1422 PyStructSequence_SET_ITEM(version, pos++, PyLong_FromLong(ver.dwMinorVersion));
1423 PyStructSequence_SET_ITEM(version, pos++, PyLong_FromLong(ver.dwBuildNumber));
1424 PyStructSequence_SET_ITEM(version, pos++, PyLong_FromLong(ver.dwPlatformId));
Minmin Gong8ebc6452019-02-02 20:26:55 -08001425 PyStructSequence_SET_ITEM(version, pos++, PyUnicode_FromWideChar(ver.szCSDVersion, -1));
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001426 PyStructSequence_SET_ITEM(version, pos++, PyLong_FromLong(ver.wServicePackMajor));
1427 PyStructSequence_SET_ITEM(version, pos++, PyLong_FromLong(ver.wServicePackMinor));
1428 PyStructSequence_SET_ITEM(version, pos++, PyLong_FromLong(ver.wSuiteMask));
1429 PyStructSequence_SET_ITEM(version, pos++, PyLong_FromLong(ver.wProductType));
Eric Smithf7bb5782010-01-27 00:44:57 +00001430
Steve Dower74f4af72016-09-17 17:27:48 -07001431 realMajor = ver.dwMajorVersion;
1432 realMinor = ver.dwMinorVersion;
1433 realBuild = ver.dwBuildNumber;
1434
1435 // GetVersion will lie if we are running in a compatibility mode.
1436 // We need to read the version info from a system file resource
1437 // to accurately identify the OS version. If we fail for any reason,
1438 // just return whatever GetVersion said.
Tony Roberts4860f012019-02-02 18:16:42 +01001439 Py_BEGIN_ALLOW_THREADS
Steve Dower74f4af72016-09-17 17:27:48 -07001440 hKernel32 = GetModuleHandleW(L"kernel32.dll");
Tony Roberts4860f012019-02-02 18:16:42 +01001441 Py_END_ALLOW_THREADS
Steve Dower74f4af72016-09-17 17:27:48 -07001442 if (hKernel32 && GetModuleFileNameW(hKernel32, kernel32_path, MAX_PATH) &&
1443 (verblock_size = GetFileVersionInfoSizeW(kernel32_path, NULL)) &&
1444 (verblock = PyMem_RawMalloc(verblock_size))) {
1445 VS_FIXEDFILEINFO *ffi;
1446 UINT ffi_len;
1447
1448 if (GetFileVersionInfoW(kernel32_path, 0, verblock_size, verblock) &&
1449 VerQueryValueW(verblock, L"", (LPVOID)&ffi, &ffi_len)) {
1450 realMajor = HIWORD(ffi->dwProductVersionMS);
1451 realMinor = LOWORD(ffi->dwProductVersionMS);
1452 realBuild = HIWORD(ffi->dwProductVersionLS);
1453 }
1454 PyMem_RawFree(verblock);
1455 }
Segev Finer48fb7662017-06-04 20:52:27 +03001456 PyStructSequence_SET_ITEM(version, pos++, Py_BuildValue("(kkk)",
1457 realMajor,
1458 realMinor,
1459 realBuild
Steve Dower74f4af72016-09-17 17:27:48 -07001460 ));
1461
Victor Stinner838f2642019-06-13 22:41:23 +02001462 if (_PyErr_Occurred(tstate)) {
Serhiy Storchaka48d761e2013-12-17 15:11:24 +02001463 Py_DECREF(version);
1464 return NULL;
1465 }
Steve Dower74f4af72016-09-17 17:27:48 -07001466
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001467 return version;
Mark Hammond8696ebc2002-10-08 02:44:31 +00001468}
1469
Steve Dower3e96f322015-03-02 08:01:10 -08001470#pragma warning(pop)
1471
Tal Einatede0b6f2018-12-31 17:12:08 +02001472/*[clinic input]
1473sys._enablelegacywindowsfsencoding
1474
1475Changes the default filesystem encoding to mbcs:replace.
1476
1477This is done for consistency with earlier versions of Python. See PEP
1478529 for more information.
1479
1480This is equivalent to defining the PYTHONLEGACYWINDOWSFSENCODING
1481environment variable before launching Python.
1482[clinic start generated code]*/
Steve Dowercc16be82016-09-08 10:35:16 -07001483
1484static PyObject *
Tal Einatede0b6f2018-12-31 17:12:08 +02001485sys__enablelegacywindowsfsencoding_impl(PyObject *module)
1486/*[clinic end generated code: output=f5c3855b45e24fe9 input=2bfa931a20704492]*/
Steve Dowercc16be82016-09-08 10:35:16 -07001487{
Victor Stinner709d23d2019-05-02 14:56:30 -04001488 if (_PyUnicode_EnableLegacyWindowsFSEncoding() < 0) {
Victor Stinnerb2457ef2018-08-29 13:25:36 +02001489 return NULL;
1490 }
Steve Dowercc16be82016-09-08 10:35:16 -07001491 Py_RETURN_NONE;
1492}
1493
Mark Hammond8696ebc2002-10-08 02:44:31 +00001494#endif /* MS_WINDOWS */
1495
Martin v. Löwisf0473d52001-07-18 16:17:16 +00001496#ifdef HAVE_DLOPEN
Tal Einatede0b6f2018-12-31 17:12:08 +02001497
1498/*[clinic input]
1499sys.setdlopenflags
1500
1501 flags as new_val: int
1502 /
1503
1504Set the flags used by the interpreter for dlopen calls.
1505
1506This is used, for example, when the interpreter loads extension
1507modules. Among other things, this will enable a lazy resolving of
1508symbols when importing a module, if called as sys.setdlopenflags(0).
1509To share symbols across extension modules, call as
1510sys.setdlopenflags(os.RTLD_GLOBAL). Symbolic names for the flag
1511modules can be found in the os module (RTLD_xxx constants, e.g.
1512os.RTLD_LAZY).
1513[clinic start generated code]*/
1514
Martin v. Löwisf0473d52001-07-18 16:17:16 +00001515static PyObject *
Tal Einatede0b6f2018-12-31 17:12:08 +02001516sys_setdlopenflags_impl(PyObject *module, int new_val)
1517/*[clinic end generated code: output=ec918b7fe0a37281 input=4c838211e857a77f]*/
Martin v. Löwisf0473d52001-07-18 16:17:16 +00001518{
Victor Stinner838f2642019-06-13 22:41:23 +02001519 PyThreadState *tstate = _PyThreadState_GET();
1520 tstate->interp->dlopenflags = new_val;
Serhiy Storchaka228b12e2017-01-23 09:47:21 +02001521 Py_RETURN_NONE;
Martin v. Löwisf0473d52001-07-18 16:17:16 +00001522}
1523
Tal Einatede0b6f2018-12-31 17:12:08 +02001524
1525/*[clinic input]
1526sys.getdlopenflags
1527
1528Return the current value of the flags that are used for dlopen calls.
1529
1530The flag constants are defined in the os module.
1531[clinic start generated code]*/
Martin v. Löwisf0473d52001-07-18 16:17:16 +00001532
1533static PyObject *
Tal Einatede0b6f2018-12-31 17:12:08 +02001534sys_getdlopenflags_impl(PyObject *module)
1535/*[clinic end generated code: output=e92cd1bc5005da6e input=dc4ea0899c53b4b6]*/
Martin v. Löwisf0473d52001-07-18 16:17:16 +00001536{
Victor Stinner838f2642019-06-13 22:41:23 +02001537 PyThreadState *tstate = _PyThreadState_GET();
1538 return PyLong_FromLong(tstate->interp->dlopenflags);
Martin v. Löwisf0473d52001-07-18 16:17:16 +00001539}
1540
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001541#endif /* HAVE_DLOPEN */
Martin v. Löwisf0473d52001-07-18 16:17:16 +00001542
Guido van Rossum14b4adb1992-09-03 20:25:30 +00001543#ifdef USE_MALLOPT
1544/* Link with -lmalloc (or -lmpc) on an SGI */
1545#include <malloc.h>
1546
Tal Einatede0b6f2018-12-31 17:12:08 +02001547/*[clinic input]
1548sys.mdebug
1549
1550 flag: int
1551 /
1552[clinic start generated code]*/
1553
Guido van Rossum65bf9f21997-04-29 18:33:38 +00001554static PyObject *
Tal Einatede0b6f2018-12-31 17:12:08 +02001555sys_mdebug_impl(PyObject *module, int flag)
1556/*[clinic end generated code: output=5431d545847c3637 input=151d150ae1636f8a]*/
Guido van Rossum14b4adb1992-09-03 20:25:30 +00001557{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001558 int flag;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001559 mallopt(M_DEBUG, flag);
Serhiy Storchaka228b12e2017-01-23 09:47:21 +02001560 Py_RETURN_NONE;
Guido van Rossum14b4adb1992-09-03 20:25:30 +00001561}
1562#endif /* USE_MALLOPT */
1563
Serhiy Storchaka547d3bc2014-08-14 22:21:18 +03001564size_t
1565_PySys_GetSizeOf(PyObject *o)
Martin v. Löwis00709aa2008-06-04 14:18:43 +00001566{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001567 PyObject *res = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001568 PyObject *method;
Serhiy Storchaka030e92d2014-11-15 13:21:37 +02001569 Py_ssize_t size;
Victor Stinner838f2642019-06-13 22:41:23 +02001570 PyThreadState *tstate = _PyThreadState_GET();
Benjamin Petersona5758c02009-05-09 18:15:04 +00001571
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001572 /* Make sure the type is initialized. float gets initialized late */
Victor Stinner838f2642019-06-13 22:41:23 +02001573 if (PyType_Ready(Py_TYPE(o)) < 0) {
Serhiy Storchaka547d3bc2014-08-14 22:21:18 +03001574 return (size_t)-1;
Victor Stinner838f2642019-06-13 22:41:23 +02001575 }
Robert Schuppeniesfbe94c52008-07-14 10:13:31 +00001576
Benjamin Petersonce798522012-01-22 11:24:29 -05001577 method = _PyObject_LookupSpecial(o, &PyId___sizeof__);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001578 if (method == NULL) {
Victor Stinner838f2642019-06-13 22:41:23 +02001579 if (!_PyErr_Occurred(tstate)) {
1580 _PyErr_Format(tstate, PyExc_TypeError,
1581 "Type %.100s doesn't define __sizeof__",
1582 Py_TYPE(o)->tp_name);
1583 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001584 }
1585 else {
Victor Stinnerf17c3de2016-12-06 18:46:19 +01001586 res = _PyObject_CallNoArg(method);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001587 Py_DECREF(method);
1588 }
1589
Serhiy Storchaka547d3bc2014-08-14 22:21:18 +03001590 if (res == NULL)
1591 return (size_t)-1;
1592
Serhiy Storchaka030e92d2014-11-15 13:21:37 +02001593 size = PyLong_AsSsize_t(res);
Serhiy Storchaka547d3bc2014-08-14 22:21:18 +03001594 Py_DECREF(res);
Victor Stinner838f2642019-06-13 22:41:23 +02001595 if (size == -1 && _PyErr_Occurred(tstate))
Serhiy Storchaka547d3bc2014-08-14 22:21:18 +03001596 return (size_t)-1;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001597
Serhiy Storchaka030e92d2014-11-15 13:21:37 +02001598 if (size < 0) {
Victor Stinner838f2642019-06-13 22:41:23 +02001599 _PyErr_SetString(tstate, PyExc_ValueError,
1600 "__sizeof__() should return >= 0");
Serhiy Storchaka030e92d2014-11-15 13:21:37 +02001601 return (size_t)-1;
1602 }
1603
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001604 /* add gc_head size */
Serhiy Storchaka547d3bc2014-08-14 22:21:18 +03001605 if (PyObject_IS_GC(o))
Serhiy Storchaka030e92d2014-11-15 13:21:37 +02001606 return ((size_t)size) + sizeof(PyGC_Head);
1607 return (size_t)size;
Serhiy Storchaka547d3bc2014-08-14 22:21:18 +03001608}
1609
1610static PyObject *
1611sys_getsizeof(PyObject *self, PyObject *args, PyObject *kwds)
1612{
1613 static char *kwlist[] = {"object", "default", 0};
1614 size_t size;
1615 PyObject *o, *dflt = NULL;
Victor Stinner838f2642019-06-13 22:41:23 +02001616 PyThreadState *tstate = _PyThreadState_GET();
Serhiy Storchaka547d3bc2014-08-14 22:21:18 +03001617
1618 if (!PyArg_ParseTupleAndKeywords(args, kwds, "O|O:getsizeof",
Victor Stinner838f2642019-06-13 22:41:23 +02001619 kwlist, &o, &dflt)) {
Serhiy Storchaka547d3bc2014-08-14 22:21:18 +03001620 return NULL;
Victor Stinner838f2642019-06-13 22:41:23 +02001621 }
Serhiy Storchaka547d3bc2014-08-14 22:21:18 +03001622
1623 size = _PySys_GetSizeOf(o);
1624
Victor Stinner838f2642019-06-13 22:41:23 +02001625 if (size == (size_t)-1 && _PyErr_Occurred(tstate)) {
Serhiy Storchaka547d3bc2014-08-14 22:21:18 +03001626 /* Has a default value been given */
Victor Stinner838f2642019-06-13 22:41:23 +02001627 if (dflt != NULL && _PyErr_ExceptionMatches(tstate, PyExc_TypeError)) {
1628 _PyErr_Clear(tstate);
Serhiy Storchaka547d3bc2014-08-14 22:21:18 +03001629 Py_INCREF(dflt);
1630 return dflt;
1631 }
1632 else
1633 return NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001634 }
Serhiy Storchaka547d3bc2014-08-14 22:21:18 +03001635
1636 return PyLong_FromSize_t(size);
Martin v. Löwis00709aa2008-06-04 14:18:43 +00001637}
1638
1639PyDoc_STRVAR(getsizeof_doc,
Tal Einatede0b6f2018-12-31 17:12:08 +02001640"getsizeof(object [, default]) -> int\n\
Martin v. Löwis00709aa2008-06-04 14:18:43 +00001641\n\
1642Return the size of object in bytes.");
1643
Tal Einatede0b6f2018-12-31 17:12:08 +02001644/*[clinic input]
1645sys.getrefcount -> Py_ssize_t
1646
1647 object: object
1648 /
1649
1650Return the reference count of object.
1651
1652The count returned is generally one higher than you might expect,
1653because it includes the (temporary) reference as an argument to
1654getrefcount().
1655[clinic start generated code]*/
1656
1657static Py_ssize_t
1658sys_getrefcount_impl(PyObject *module, PyObject *object)
1659/*[clinic end generated code: output=5fd477f2264b85b2 input=bf474efd50a21535]*/
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +00001660{
Tal Einatede0b6f2018-12-31 17:12:08 +02001661 return object->ob_refcnt;
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +00001662}
1663
Tim Peters4be93d02002-07-07 19:59:50 +00001664#ifdef Py_REF_DEBUG
Tal Einatede0b6f2018-12-31 17:12:08 +02001665/*[clinic input]
1666sys.gettotalrefcount -> Py_ssize_t
1667[clinic start generated code]*/
1668
1669static Py_ssize_t
1670sys_gettotalrefcount_impl(PyObject *module)
1671/*[clinic end generated code: output=4103886cf17c25bc input=53b744faa5d2e4f6]*/
Mark Hammond440d8982000-06-20 08:12:48 +00001672{
Tal Einatede0b6f2018-12-31 17:12:08 +02001673 return _Py_GetRefTotal();
Mark Hammond440d8982000-06-20 08:12:48 +00001674}
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001675#endif /* Py_REF_DEBUG */
Mark Hammond440d8982000-06-20 08:12:48 +00001676
Tal Einatede0b6f2018-12-31 17:12:08 +02001677/*[clinic input]
1678sys.getallocatedblocks -> Py_ssize_t
Guido van Rossumc3bc31e1998-06-27 19:43:25 +00001679
Tal Einatede0b6f2018-12-31 17:12:08 +02001680Return the number of memory blocks currently allocated.
1681[clinic start generated code]*/
1682
1683static Py_ssize_t
1684sys_getallocatedblocks_impl(PyObject *module)
1685/*[clinic end generated code: output=f0c4e873f0b6dcf7 input=dab13ee346a0673e]*/
Antoine Pitrouf9d0b122012-12-09 14:28:26 +01001686{
Tal Einatede0b6f2018-12-31 17:12:08 +02001687 return _Py_GetAllocatedBlocks();
Antoine Pitrouf9d0b122012-12-09 14:28:26 +01001688}
1689
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +00001690#ifdef COUNT_ALLOCS
Tal Einatede0b6f2018-12-31 17:12:08 +02001691/*[clinic input]
1692sys.getcounts
1693[clinic start generated code]*/
1694
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +00001695static PyObject *
Tal Einatede0b6f2018-12-31 17:12:08 +02001696sys_getcounts_impl(PyObject *module)
1697/*[clinic end generated code: output=20df00bc164f43cb input=ad2ec7bda5424953]*/
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +00001698{
Pablo Galindo49c75a82018-10-28 15:02:17 +00001699 extern PyObject *_Py_get_counts(void);
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +00001700
Pablo Galindo49c75a82018-10-28 15:02:17 +00001701 return _Py_get_counts();
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +00001702}
1703#endif
1704
Tal Einatede0b6f2018-12-31 17:12:08 +02001705/*[clinic input]
1706sys._getframe
1707
1708 depth: int = 0
1709 /
1710
1711Return a frame object from the call stack.
1712
1713If optional integer depth is given, return the frame object that many
1714calls below the top of the stack. If that is deeper than the call
1715stack, ValueError is raised. The default for depth is zero, returning
1716the frame at the top of the call stack.
1717
1718This function should be used for internal and specialized purposes
1719only.
1720[clinic start generated code]*/
Barry Warsawb6a54d22000-12-06 21:47:46 +00001721
1722static PyObject *
Tal Einatede0b6f2018-12-31 17:12:08 +02001723sys__getframe_impl(PyObject *module, int depth)
1724/*[clinic end generated code: output=d438776c04d59804 input=c1be8a6464b11ee5]*/
Barry Warsawb6a54d22000-12-06 21:47:46 +00001725{
Victor Stinner838f2642019-06-13 22:41:23 +02001726 PyThreadState *tstate = _PyThreadState_GET();
1727 PyFrameObject *f = tstate->frame;
Barry Warsawb6a54d22000-12-06 21:47:46 +00001728
Steve Dowerb82e17e2019-05-23 08:45:22 -07001729 if (PySys_Audit("sys._getframe", "O", f) < 0) {
1730 return NULL;
1731 }
1732
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001733 while (depth > 0 && f != NULL) {
1734 f = f->f_back;
1735 --depth;
1736 }
1737 if (f == NULL) {
Victor Stinner838f2642019-06-13 22:41:23 +02001738 _PyErr_SetString(tstate, PyExc_ValueError,
1739 "call stack is not deep enough");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001740 return NULL;
1741 }
1742 Py_INCREF(f);
1743 return (PyObject*)f;
Barry Warsawb6a54d22000-12-06 21:47:46 +00001744}
1745
Tal Einatede0b6f2018-12-31 17:12:08 +02001746/*[clinic input]
1747sys._current_frames
1748
1749Return a dict mapping each thread's thread id to its current stack frame.
1750
1751This function should be used for specialized purposes only.
1752[clinic start generated code]*/
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001753
1754static PyObject *
Tal Einatede0b6f2018-12-31 17:12:08 +02001755sys__current_frames_impl(PyObject *module)
1756/*[clinic end generated code: output=d2a41ac0a0a3809a input=2a9049c5f5033691]*/
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001757{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001758 return _PyThread_CurrentFrames();
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001759}
1760
Tal Einatede0b6f2018-12-31 17:12:08 +02001761/*[clinic input]
1762sys.call_tracing
1763
1764 func: object
1765 args as funcargs: object(subclass_of='&PyTuple_Type')
1766 /
1767
1768Call func(*args), while tracing is enabled.
1769
1770The tracing state is saved, and restored afterwards. This is intended
1771to be called from a debugger from a checkpoint, to recursively debug
1772some other code.
1773[clinic start generated code]*/
Guido van Rossuma12fe4e2003-04-09 19:06:21 +00001774
1775static PyObject *
Tal Einatede0b6f2018-12-31 17:12:08 +02001776sys_call_tracing_impl(PyObject *module, PyObject *func, PyObject *funcargs)
1777/*[clinic end generated code: output=7e4999853cd4e5a6 input=5102e8b11049f92f]*/
Guido van Rossuma12fe4e2003-04-09 19:06:21 +00001778{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001779 return _PyEval_CallTracing(func, funcargs);
Guido van Rossuma12fe4e2003-04-09 19:06:21 +00001780}
1781
Victor Stinner048afd92016-11-28 11:59:04 +01001782
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001783#ifdef __cplusplus
1784extern "C" {
1785#endif
1786
Tal Einatede0b6f2018-12-31 17:12:08 +02001787/*[clinic input]
1788sys._debugmallocstats
1789
1790Print summary info to stderr about the state of pymalloc's structures.
1791
1792In Py_DEBUG mode, also perform some expensive internal consistency
1793checks.
1794[clinic start generated code]*/
1795
David Malcolm49526f42012-06-22 14:55:41 -04001796static PyObject *
Tal Einatede0b6f2018-12-31 17:12:08 +02001797sys__debugmallocstats_impl(PyObject *module)
1798/*[clinic end generated code: output=ec3565f8c7cee46a input=33c0c9c416f98424]*/
David Malcolm49526f42012-06-22 14:55:41 -04001799{
1800#ifdef WITH_PYMALLOC
Victor Stinner6bf992a2017-12-06 17:26:10 +01001801 if (_PyObject_DebugMallocStats(stderr)) {
Victor Stinner34be8072016-03-14 12:04:26 +01001802 fputc('\n', stderr);
1803 }
David Malcolm49526f42012-06-22 14:55:41 -04001804#endif
1805 _PyObject_DebugTypeStats(stderr);
1806
1807 Py_RETURN_NONE;
1808}
David Malcolm49526f42012-06-22 14:55:41 -04001809
Guido van Rossum7f3f2c11996-05-23 22:45:41 +00001810#ifdef Py_TRACE_REFS
Guido van Rossumded690f1996-05-24 20:48:31 +00001811/* Defined in objects.c because it uses static globals if that file */
Tim Petersdbd9ba62000-07-09 03:09:57 +00001812extern PyObject *_Py_GetObjects(PyObject *, PyObject *);
Sjoerd Mullender6ec3c651995-08-29 09:18:14 +00001813#endif
Guido van Rossumded690f1996-05-24 20:48:31 +00001814
Guido van Rossum43f1b8d1997-01-24 04:07:45 +00001815#ifdef DYNAMIC_EXECUTION_PROFILE
1816/* Defined in ceval.c because it uses static globals if that file */
Tim Petersdbd9ba62000-07-09 03:09:57 +00001817extern PyObject *_Py_GetDXProfile(PyObject *, PyObject *);
Guido van Rossum43f1b8d1997-01-24 04:07:45 +00001818#endif
1819
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001820#ifdef __cplusplus
1821}
1822#endif
1823
Tal Einatede0b6f2018-12-31 17:12:08 +02001824
1825/*[clinic input]
1826sys._clear_type_cache
1827
1828Clear the internal type lookup cache.
1829[clinic start generated code]*/
1830
Christian Heimes15ebc882008-02-04 18:48:49 +00001831static PyObject *
Tal Einatede0b6f2018-12-31 17:12:08 +02001832sys__clear_type_cache_impl(PyObject *module)
1833/*[clinic end generated code: output=20e48ca54a6f6971 input=127f3e04a8d9b555]*/
Christian Heimes15ebc882008-02-04 18:48:49 +00001834{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001835 PyType_ClearCache();
1836 Py_RETURN_NONE;
Christian Heimes15ebc882008-02-04 18:48:49 +00001837}
1838
Tal Einatede0b6f2018-12-31 17:12:08 +02001839/*[clinic input]
1840sys.is_finalizing
1841
1842Return True if Python is exiting.
1843[clinic start generated code]*/
1844
Antoine Pitrou5db1bb82014-12-07 01:28:27 +01001845static PyObject *
Tal Einatede0b6f2018-12-31 17:12:08 +02001846sys_is_finalizing_impl(PyObject *module)
1847/*[clinic end generated code: output=735b5ff7962ab281 input=f0df747a039948a5]*/
Antoine Pitrou5db1bb82014-12-07 01:28:27 +01001848{
Eric Snow2ebc5ce2017-09-07 23:51:28 -06001849 return PyBool_FromLong(_Py_IsFinalizing());
Antoine Pitrou5db1bb82014-12-07 01:28:27 +01001850}
1851
Victor Stinnerd6958ac2016-12-02 01:13:46 +01001852#ifdef ANDROID_API_LEVEL
Tal Einatede0b6f2018-12-31 17:12:08 +02001853/*[clinic input]
1854sys.getandroidapilevel
1855
1856Return the build time API version of Android as an integer.
1857[clinic start generated code]*/
Victor Stinnerd6958ac2016-12-02 01:13:46 +01001858
1859static PyObject *
Tal Einatede0b6f2018-12-31 17:12:08 +02001860sys_getandroidapilevel_impl(PyObject *module)
1861/*[clinic end generated code: output=214abf183a1c70c1 input=3e6d6c9fcdd24ac6]*/
Victor Stinnerd6958ac2016-12-02 01:13:46 +01001862{
1863 return PyLong_FromLong(ANDROID_API_LEVEL);
1864}
1865#endif /* ANDROID_API_LEVEL */
1866
1867
Steve Dowerb82e17e2019-05-23 08:45:22 -07001868
Guido van Rossum65bf9f21997-04-29 18:33:38 +00001869static PyMethodDef sys_methods[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001870 /* Might as well keep this in alphabetic order */
Steve Dowerb82e17e2019-05-23 08:45:22 -07001871 SYS_ADDAUDITHOOK_METHODDEF
1872 {"audit", (PyCFunction)(void(*)(void))sys_audit, METH_FASTCALL, audit_doc },
Serhiy Storchaka62be7422018-11-27 13:27:31 +02001873 {"breakpointhook", (PyCFunction)(void(*)(void))sys_breakpointhook,
Barry Warsaw36c1d1f2017-10-05 12:11:18 -04001874 METH_FASTCALL | METH_KEYWORDS, breakpointhook_doc},
Tal Einatede0b6f2018-12-31 17:12:08 +02001875 SYS__CLEAR_TYPE_CACHE_METHODDEF
1876 SYS__CURRENT_FRAMES_METHODDEF
1877 SYS_DISPLAYHOOK_METHODDEF
1878 SYS_EXC_INFO_METHODDEF
1879 SYS_EXCEPTHOOK_METHODDEF
1880 SYS_EXIT_METHODDEF
1881 SYS_GETDEFAULTENCODING_METHODDEF
1882 SYS_GETDLOPENFLAGS_METHODDEF
1883 SYS_GETALLOCATEDBLOCKS_METHODDEF
1884 SYS_GETCOUNTS_METHODDEF
Guido van Rossum43f1b8d1997-01-24 04:07:45 +00001885#ifdef DYNAMIC_EXECUTION_PROFILE
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001886 {"getdxp", _Py_GetDXProfile, METH_VARARGS},
Guido van Rossum43f1b8d1997-01-24 04:07:45 +00001887#endif
Tal Einatede0b6f2018-12-31 17:12:08 +02001888 SYS_GETFILESYSTEMENCODING_METHODDEF
1889 SYS_GETFILESYSTEMENCODEERRORS_METHODDEF
Guido van Rossum7f3f2c11996-05-23 22:45:41 +00001890#ifdef Py_TRACE_REFS
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001891 {"getobjects", _Py_GetObjects, METH_VARARGS},
Tim Peters4be93d02002-07-07 19:59:50 +00001892#endif
Tal Einatede0b6f2018-12-31 17:12:08 +02001893 SYS_GETTOTALREFCOUNT_METHODDEF
1894 SYS_GETREFCOUNT_METHODDEF
1895 SYS_GETRECURSIONLIMIT_METHODDEF
Serhiy Storchaka62be7422018-11-27 13:27:31 +02001896 {"getsizeof", (PyCFunction)(void(*)(void))sys_getsizeof,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001897 METH_VARARGS | METH_KEYWORDS, getsizeof_doc},
Tal Einatede0b6f2018-12-31 17:12:08 +02001898 SYS__GETFRAME_METHODDEF
1899 SYS_GETWINDOWSVERSION_METHODDEF
1900 SYS__ENABLELEGACYWINDOWSFSENCODING_METHODDEF
1901 SYS_INTERN_METHODDEF
1902 SYS_IS_FINALIZING_METHODDEF
1903 SYS_MDEBUG_METHODDEF
Tal Einatede0b6f2018-12-31 17:12:08 +02001904 SYS_SETSWITCHINTERVAL_METHODDEF
1905 SYS_GETSWITCHINTERVAL_METHODDEF
1906 SYS_SETDLOPENFLAGS_METHODDEF
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001907 {"setprofile", sys_setprofile, METH_O, setprofile_doc},
Tal Einatede0b6f2018-12-31 17:12:08 +02001908 SYS_GETPROFILE_METHODDEF
1909 SYS_SETRECURSIONLIMIT_METHODDEF
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001910 {"settrace", sys_settrace, METH_O, settrace_doc},
Tal Einatede0b6f2018-12-31 17:12:08 +02001911 SYS_GETTRACE_METHODDEF
1912 SYS_CALL_TRACING_METHODDEF
1913 SYS__DEBUGMALLOCSTATS_METHODDEF
Nathaniel J. Smithfc2f4072018-01-21 06:44:07 -08001914 SYS_SET_COROUTINE_ORIGIN_TRACKING_DEPTH_METHODDEF
1915 SYS_GET_COROUTINE_ORIGIN_TRACKING_DEPTH_METHODDEF
Serhiy Storchaka62be7422018-11-27 13:27:31 +02001916 {"set_asyncgen_hooks", (PyCFunction)(void(*)(void))sys_set_asyncgen_hooks,
Yury Selivanoveb636452016-09-08 22:01:51 -07001917 METH_VARARGS | METH_KEYWORDS, set_asyncgen_hooks_doc},
Tal Einatede0b6f2018-12-31 17:12:08 +02001918 SYS_GET_ASYNCGEN_HOOKS_METHODDEF
1919 SYS_GETANDROIDAPILEVEL_METHODDEF
Victor Stinneref9d9b62019-05-22 11:28:22 +02001920 SYS_UNRAISABLEHOOK_METHODDEF
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001921 {NULL, NULL} /* sentinel */
Guido van Rossum3f5da241990-12-20 15:06:42 +00001922};
1923
Guido van Rossum65bf9f21997-04-29 18:33:38 +00001924static PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001925list_builtin_module_names(void)
Guido van Rossum34679b71993-01-26 13:33:44 +00001926{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001927 PyObject *list = PyList_New(0);
1928 int i;
1929 if (list == NULL)
1930 return NULL;
1931 for (i = 0; PyImport_Inittab[i].name != NULL; i++) {
1932 PyObject *name = PyUnicode_FromString(
1933 PyImport_Inittab[i].name);
1934 if (name == NULL)
1935 break;
1936 PyList_Append(list, name);
1937 Py_DECREF(name);
1938 }
1939 if (PyList_Sort(list) != 0) {
1940 Py_DECREF(list);
1941 list = NULL;
1942 }
1943 if (list) {
1944 PyObject *v = PyList_AsTuple(list);
1945 Py_DECREF(list);
1946 list = v;
1947 }
1948 return list;
Guido van Rossum34679b71993-01-26 13:33:44 +00001949}
1950
Nick Coghlanbc77eff2018-03-25 20:44:30 +10001951/* Pre-initialization support for sys.warnoptions and sys._xoptions
1952 *
1953 * Modern internal code paths:
1954 * These APIs get called after _Py_InitializeCore and get to use the
1955 * regular CPython list, dict, and unicode APIs.
1956 *
1957 * Legacy embedding code paths:
1958 * The multi-phase initialization API isn't public yet, so embedding
1959 * apps still need to be able configure sys.warnoptions and sys._xoptions
1960 * before they call Py_Initialize. To support this, we stash copies of
1961 * the supplied wchar * sequences in linked lists, and then migrate the
1962 * contents of those lists to the sys module in _PyInitializeCore.
1963 *
1964 */
1965
1966struct _preinit_entry {
1967 wchar_t *value;
1968 struct _preinit_entry *next;
1969};
1970
1971typedef struct _preinit_entry *_Py_PreInitEntry;
1972
1973static _Py_PreInitEntry _preinit_warnoptions = NULL;
1974static _Py_PreInitEntry _preinit_xoptions = NULL;
1975
1976static _Py_PreInitEntry
1977_alloc_preinit_entry(const wchar_t *value)
1978{
1979 /* To get this to work, we have to initialize the runtime implicitly */
1980 _PyRuntime_Initialize();
1981
1982 /* Force default allocator, so we can ensure that it also gets used to
1983 * destroy the linked list in _clear_preinit_entries.
1984 */
1985 PyMemAllocatorEx old_alloc;
1986 _PyMem_SetDefaultAllocator(PYMEM_DOMAIN_RAW, &old_alloc);
1987
1988 _Py_PreInitEntry node = PyMem_RawCalloc(1, sizeof(*node));
1989 if (node != NULL) {
1990 node->value = _PyMem_RawWcsdup(value);
1991 if (node->value == NULL) {
1992 PyMem_RawFree(node);
1993 node = NULL;
1994 };
1995 };
1996
1997 PyMem_SetAllocator(PYMEM_DOMAIN_RAW, &old_alloc);
1998 return node;
Zackery Spytz1a2252e2019-05-06 10:56:51 -06001999}
Nick Coghlanbc77eff2018-03-25 20:44:30 +10002000
2001static int
2002_append_preinit_entry(_Py_PreInitEntry *optionlist, const wchar_t *value)
2003{
2004 _Py_PreInitEntry new_entry = _alloc_preinit_entry(value);
2005 if (new_entry == NULL) {
2006 return -1;
2007 }
2008 /* We maintain the linked list in this order so it's easy to play back
2009 * the add commands in the same order later on in _Py_InitializeCore
2010 */
2011 _Py_PreInitEntry last_entry = *optionlist;
2012 if (last_entry == NULL) {
2013 *optionlist = new_entry;
2014 } else {
2015 while (last_entry->next != NULL) {
2016 last_entry = last_entry->next;
2017 }
2018 last_entry->next = new_entry;
2019 }
2020 return 0;
Zackery Spytz1a2252e2019-05-06 10:56:51 -06002021}
Nick Coghlanbc77eff2018-03-25 20:44:30 +10002022
2023static void
2024_clear_preinit_entries(_Py_PreInitEntry *optionlist)
2025{
2026 _Py_PreInitEntry current = *optionlist;
2027 *optionlist = NULL;
2028 /* Deallocate the nodes and their contents using the default allocator */
2029 PyMemAllocatorEx old_alloc;
2030 _PyMem_SetDefaultAllocator(PYMEM_DOMAIN_RAW, &old_alloc);
2031 while (current != NULL) {
2032 _Py_PreInitEntry next = current->next;
2033 PyMem_RawFree(current->value);
2034 PyMem_RawFree(current);
2035 current = next;
2036 }
2037 PyMem_SetAllocator(PYMEM_DOMAIN_RAW, &old_alloc);
Zackery Spytz1a2252e2019-05-06 10:56:51 -06002038}
Nick Coghlanbc77eff2018-03-25 20:44:30 +10002039
2040static void
2041_clear_all_preinit_options(void)
2042{
2043 _clear_preinit_entries(&_preinit_warnoptions);
2044 _clear_preinit_entries(&_preinit_xoptions);
2045}
2046
2047static int
Victor Stinner838f2642019-06-13 22:41:23 +02002048sys_read_preinit_options(PyThreadState *tstate)
Nick Coghlanbc77eff2018-03-25 20:44:30 +10002049{
2050 /* Rerun the add commands with the actual sys module available */
Nick Coghlanbc77eff2018-03-25 20:44:30 +10002051 if (tstate == NULL) {
2052 /* Still don't have a thread state, so something is wrong! */
2053 return -1;
2054 }
2055 _Py_PreInitEntry entry = _preinit_warnoptions;
2056 while (entry != NULL) {
2057 PySys_AddWarnOption(entry->value);
2058 entry = entry->next;
2059 }
2060 entry = _preinit_xoptions;
2061 while (entry != NULL) {
2062 PySys_AddXOption(entry->value);
2063 entry = entry->next;
2064 }
2065
2066 _clear_all_preinit_options();
2067 return 0;
Zackery Spytz1a2252e2019-05-06 10:56:51 -06002068}
Nick Coghlanbc77eff2018-03-25 20:44:30 +10002069
Eric Snow2ebc5ce2017-09-07 23:51:28 -06002070static PyObject *
Victor Stinner838f2642019-06-13 22:41:23 +02002071get_warnoptions(PyThreadState *tstate)
Eric Snow2ebc5ce2017-09-07 23:51:28 -06002072{
Victor Stinner838f2642019-06-13 22:41:23 +02002073 PyObject *warnoptions = sys_get_object_id(tstate, &PyId_warnoptions);
Eric Snow2ebc5ce2017-09-07 23:51:28 -06002074 if (warnoptions == NULL || !PyList_Check(warnoptions)) {
Nick Coghlanbc77eff2018-03-25 20:44:30 +10002075 /* PEP432 TODO: we can reach this if warnoptions is NULL in the main
2076 * interpreter config. When that happens, we need to properly set
2077 * the `warnoptions` reference in the main interpreter config as well.
2078 *
2079 * For Python 3.7, we shouldn't be able to get here due to the
2080 * combination of how _PyMainInterpreter_ReadConfig and _PySys_EndInit
2081 * work, but we expect 3.8+ to make the _PyMainInterpreter_ReadConfig
2082 * call optional for embedding applications, thus making this
2083 * reachable again.
2084 */
Eric Snow2ebc5ce2017-09-07 23:51:28 -06002085 warnoptions = PyList_New(0);
Victor Stinner838f2642019-06-13 22:41:23 +02002086 if (warnoptions == NULL) {
Eric Snow2ebc5ce2017-09-07 23:51:28 -06002087 return NULL;
Victor Stinner838f2642019-06-13 22:41:23 +02002088 }
2089 if (sys_set_object_id(tstate, &PyId_warnoptions, warnoptions)) {
Eric Snowdae02762017-09-14 00:35:58 -07002090 Py_DECREF(warnoptions);
2091 return NULL;
2092 }
2093 Py_DECREF(warnoptions);
Eric Snow2ebc5ce2017-09-07 23:51:28 -06002094 }
2095 return warnoptions;
2096}
Guido van Rossum23fff912000-12-15 22:02:05 +00002097
2098void
2099PySys_ResetWarnOptions(void)
2100{
Victor Stinner50b48572018-11-01 01:51:40 +01002101 PyThreadState *tstate = _PyThreadState_GET();
Nick Coghlanbc77eff2018-03-25 20:44:30 +10002102 if (tstate == NULL) {
2103 _clear_preinit_entries(&_preinit_warnoptions);
2104 return;
2105 }
2106
Victor Stinner838f2642019-06-13 22:41:23 +02002107 PyObject *warnoptions = sys_get_object_id(tstate, &PyId_warnoptions);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002108 if (warnoptions == NULL || !PyList_Check(warnoptions))
2109 return;
2110 PyList_SetSlice(warnoptions, 0, PyList_GET_SIZE(warnoptions), NULL);
Guido van Rossum23fff912000-12-15 22:02:05 +00002111}
2112
Victor Stinnere1b29952018-10-30 14:31:42 +01002113static int
Victor Stinner838f2642019-06-13 22:41:23 +02002114_PySys_AddWarnOptionWithError(PyThreadState *tstate, PyObject *option)
Guido van Rossum23fff912000-12-15 22:02:05 +00002115{
Victor Stinner838f2642019-06-13 22:41:23 +02002116 PyObject *warnoptions = get_warnoptions(tstate);
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002117 if (warnoptions == NULL) {
2118 return -1;
2119 }
2120 if (PyList_Append(warnoptions, option)) {
2121 return -1;
2122 }
2123 return 0;
2124}
2125
2126void
2127PySys_AddWarnOptionUnicode(PyObject *option)
2128{
Victor Stinner838f2642019-06-13 22:41:23 +02002129 PyThreadState *tstate = _PyThreadState_GET();
2130 if (_PySys_AddWarnOptionWithError(tstate, option) < 0) {
Victor Stinnere1b29952018-10-30 14:31:42 +01002131 /* No return value, therefore clear error state if possible */
Victor Stinner838f2642019-06-13 22:41:23 +02002132 if (tstate) {
2133 _PyErr_Clear(tstate);
Victor Stinnere1b29952018-10-30 14:31:42 +01002134 }
2135 }
Victor Stinner9ca9c252010-05-19 16:53:30 +00002136}
2137
2138void
2139PySys_AddWarnOption(const wchar_t *s)
2140{
Victor Stinner50b48572018-11-01 01:51:40 +01002141 PyThreadState *tstate = _PyThreadState_GET();
Nick Coghlanbc77eff2018-03-25 20:44:30 +10002142 if (tstate == NULL) {
2143 _append_preinit_entry(&_preinit_warnoptions, s);
2144 return;
2145 }
Victor Stinner9ca9c252010-05-19 16:53:30 +00002146 PyObject *unicode;
2147 unicode = PyUnicode_FromWideChar(s, -1);
2148 if (unicode == NULL)
2149 return;
2150 PySys_AddWarnOptionUnicode(unicode);
2151 Py_DECREF(unicode);
Guido van Rossum23fff912000-12-15 22:02:05 +00002152}
2153
Christian Heimes33fe8092008-04-13 13:53:33 +00002154int
2155PySys_HasWarnOptions(void)
2156{
Victor Stinner838f2642019-06-13 22:41:23 +02002157 PyThreadState *tstate = _PyThreadState_GET();
2158 PyObject *warnoptions = sys_get_object_id(tstate, &PyId_warnoptions);
Serhiy Storchakadffccc62018-12-10 13:50:22 +02002159 return (warnoptions != NULL && PyList_Check(warnoptions)
2160 && PyList_GET_SIZE(warnoptions) > 0);
Christian Heimes33fe8092008-04-13 13:53:33 +00002161}
2162
Antoine Pitrou9583cac2010-10-21 13:42:28 +00002163static PyObject *
Victor Stinner838f2642019-06-13 22:41:23 +02002164get_xoptions(PyThreadState *tstate)
Antoine Pitrou9583cac2010-10-21 13:42:28 +00002165{
Victor Stinner838f2642019-06-13 22:41:23 +02002166 PyObject *xoptions = sys_get_object_id(tstate, &PyId__xoptions);
Antoine Pitrou9583cac2010-10-21 13:42:28 +00002167 if (xoptions == NULL || !PyDict_Check(xoptions)) {
Nick Coghlanbc77eff2018-03-25 20:44:30 +10002168 /* PEP432 TODO: we can reach this if xoptions is NULL in the main
2169 * interpreter config. When that happens, we need to properly set
2170 * the `xoptions` reference in the main interpreter config as well.
2171 *
2172 * For Python 3.7, we shouldn't be able to get here due to the
2173 * combination of how _PyMainInterpreter_ReadConfig and _PySys_EndInit
2174 * work, but we expect 3.8+ to make the _PyMainInterpreter_ReadConfig
2175 * call optional for embedding applications, thus making this
2176 * reachable again.
2177 */
Antoine Pitrou9583cac2010-10-21 13:42:28 +00002178 xoptions = PyDict_New();
Victor Stinner838f2642019-06-13 22:41:23 +02002179 if (xoptions == NULL) {
Eric Snow2ebc5ce2017-09-07 23:51:28 -06002180 return NULL;
Victor Stinner838f2642019-06-13 22:41:23 +02002181 }
2182 if (sys_set_object_id(tstate, &PyId__xoptions, xoptions)) {
Eric Snowdae02762017-09-14 00:35:58 -07002183 Py_DECREF(xoptions);
2184 return NULL;
2185 }
2186 Py_DECREF(xoptions);
Antoine Pitrou9583cac2010-10-21 13:42:28 +00002187 }
2188 return xoptions;
2189}
2190
Victor Stinnere1b29952018-10-30 14:31:42 +01002191static int
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002192_PySys_AddXOptionWithError(const wchar_t *s)
Antoine Pitrou9583cac2010-10-21 13:42:28 +00002193{
Antoine Pitrou9583cac2010-10-21 13:42:28 +00002194 PyObject *name = NULL, *value = NULL;
Antoine Pitrou9583cac2010-10-21 13:42:28 +00002195
Victor Stinner838f2642019-06-13 22:41:23 +02002196 PyThreadState *tstate = _PyThreadState_GET();
2197 PyObject *opts = get_xoptions(tstate);
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002198 if (opts == NULL) {
Antoine Pitrou9583cac2010-10-21 13:42:28 +00002199 goto error;
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002200 }
Antoine Pitrou9583cac2010-10-21 13:42:28 +00002201
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002202 const wchar_t *name_end = wcschr(s, L'=');
Antoine Pitrou9583cac2010-10-21 13:42:28 +00002203 if (!name_end) {
2204 name = PyUnicode_FromWideChar(s, -1);
2205 value = Py_True;
2206 Py_INCREF(value);
2207 }
2208 else {
2209 name = PyUnicode_FromWideChar(s, name_end - s);
2210 value = PyUnicode_FromWideChar(name_end + 1, -1);
2211 }
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002212 if (name == NULL || value == NULL) {
Antoine Pitrou9583cac2010-10-21 13:42:28 +00002213 goto error;
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002214 }
2215 if (PyDict_SetItem(opts, name, value) < 0) {
2216 goto error;
2217 }
Antoine Pitrou9583cac2010-10-21 13:42:28 +00002218 Py_DECREF(name);
2219 Py_DECREF(value);
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002220 return 0;
Antoine Pitrou9583cac2010-10-21 13:42:28 +00002221
2222error:
2223 Py_XDECREF(name);
2224 Py_XDECREF(value);
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002225 return -1;
2226}
2227
2228void
2229PySys_AddXOption(const wchar_t *s)
2230{
Victor Stinner50b48572018-11-01 01:51:40 +01002231 PyThreadState *tstate = _PyThreadState_GET();
Nick Coghlanbc77eff2018-03-25 20:44:30 +10002232 if (tstate == NULL) {
2233 _append_preinit_entry(&_preinit_xoptions, s);
2234 return;
2235 }
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002236 if (_PySys_AddXOptionWithError(s) < 0) {
2237 /* No return value, therefore clear error state if possible */
Victor Stinner838f2642019-06-13 22:41:23 +02002238 if (tstate) {
2239 _PyErr_Clear(tstate);
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002240 }
Victor Stinner0cae6092016-11-11 01:43:56 +01002241 }
Antoine Pitrou9583cac2010-10-21 13:42:28 +00002242}
2243
2244PyObject *
2245PySys_GetXOptions(void)
2246{
Victor Stinner838f2642019-06-13 22:41:23 +02002247 PyThreadState *tstate = _PyThreadState_GET();
2248 return get_xoptions(tstate);
Antoine Pitrou9583cac2010-10-21 13:42:28 +00002249}
2250
Guido van Rossum40552d01998-08-06 03:34:39 +00002251/* XXX This doc string is too long to be a single string literal in VC++ 5.0.
2252 Two literals concatenated works just fine. If you have a K&R compiler
2253 or other abomination that however *does* understand longer strings,
2254 get rid of the !!! comment in the middle and the quotes that surround it. */
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +00002255PyDoc_VAR(sys_doc) =
2256PyDoc_STR(
Guido van Rossumc3bc31e1998-06-27 19:43:25 +00002257"This module provides access to some objects used or maintained by the\n\
2258interpreter and to functions that interact strongly with the interpreter.\n\
2259\n\
2260Dynamic objects:\n\
2261\n\
2262argv -- command line arguments; argv[0] is the script pathname if known\n\
2263path -- module search path; path[0] is the script directory, else ''\n\
2264modules -- dictionary of loaded modules\n\
Ka-Ping Yeeb5c51322001-03-23 02:46:52 +00002265\n\
2266displayhook -- called to show results in an interactive session\n\
2267excepthook -- called to handle any uncaught exception other than SystemExit\n\
2268 To customize printing in an interactive session or to install a custom\n\
2269 top-level exception handler, assign other functions to replace these.\n\
2270\n\
Benjamin Peterson06157a42008-07-15 00:28:36 +00002271stdin -- standard input file object; used by input()\n\
Georg Brandl88fc6642007-02-09 21:28:07 +00002272stdout -- standard output file object; used by print()\n\
Guido van Rossumc3bc31e1998-06-27 19:43:25 +00002273stderr -- standard error object; used for error messages\n\
Ka-Ping Yeeb5c51322001-03-23 02:46:52 +00002274 By assigning other file objects (or objects that behave like files)\n\
2275 to these, it is possible to redirect all of the interpreter's I/O.\n\
Guido van Rossumc3bc31e1998-06-27 19:43:25 +00002276\n\
2277last_type -- type of last uncaught exception\n\
2278last_value -- value of last uncaught exception\n\
2279last_traceback -- traceback of last uncaught exception\n\
2280 These three are only available in an interactive session after a\n\
2281 traceback has been printed.\n\
Guido van Rossuma71b5f41999-01-14 19:07:00 +00002282"
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +00002283)
Ka-Ping Yeeb5c51322001-03-23 02:46:52 +00002284/* concatenating string here */
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +00002285PyDoc_STR(
Guido van Rossuma71b5f41999-01-14 19:07:00 +00002286"\n\
Guido van Rossumc3bc31e1998-06-27 19:43:25 +00002287Static objects:\n\
2288\n\
Victor Stinnerd5c355c2011-04-30 14:53:09 +02002289builtin_module_names -- tuple of module names built into this interpreter\n\
2290copyright -- copyright notice pertaining to this interpreter\n\
2291exec_prefix -- prefix used to find the machine-specific Python library\n\
Petri Lehtinen4b0eab62012-02-02 21:23:15 +02002292executable -- absolute path of the executable binary of the Python interpreter\n\
Victor Stinnerd5c355c2011-04-30 14:53:09 +02002293float_info -- a struct sequence with information about the float implementation.\n\
2294float_repr_style -- string indicating the style of repr() output for floats\n\
Christian Heimes985ecdc2013-11-20 11:46:18 +01002295hash_info -- a struct sequence with information about the hash algorithm.\n\
Victor Stinnerd5c355c2011-04-30 14:53:09 +02002296hexversion -- version information encoded as a single integer\n\
Barry Warsaw409da152012-06-03 16:18:47 -04002297implementation -- Python implementation information.\n\
Mark Dickinsonbd792642009-03-18 20:06:12 +00002298int_info -- a struct sequence with information about the int implementation.\n\
Thomas Woutersd2cf20e2007-08-30 22:57:53 +00002299maxsize -- the largest supported length of containers.\n\
Serhiy Storchakad3faf432015-01-18 11:28:37 +02002300maxunicode -- the value of the largest Unicode code point\n\
Victor Stinnerd5c355c2011-04-30 14:53:09 +02002301platform -- platform identifier\n\
2302prefix -- prefix used to find the Python library\n\
2303thread_info -- a struct sequence with information about the thread implementation.\n\
Fred Drake801c08d2000-04-13 15:29:10 +00002304version -- the version of this interpreter as a string\n\
Eric Smith0e5b5622009-02-06 01:32:42 +00002305version_info -- version information as a named tuple\n\
Ka-Ping Yeeb5c51322001-03-23 02:46:52 +00002306"
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +00002307)
Steve Dowercc16be82016-09-08 10:35:16 -07002308#ifdef MS_COREDLL
Ka-Ping Yeeb5c51322001-03-23 02:46:52 +00002309/* concatenating string here */
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +00002310PyDoc_STR(
Ka-Ping Yeeb5c51322001-03-23 02:46:52 +00002311"dllhandle -- [Windows only] integer handle of the Python DLL\n\
Guido van Rossumc3bc31e1998-06-27 19:43:25 +00002312winver -- [Windows only] version number of the Python DLL\n\
Ka-Ping Yeeb5c51322001-03-23 02:46:52 +00002313"
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +00002314)
Steve Dowercc16be82016-09-08 10:35:16 -07002315#endif /* MS_COREDLL */
2316#ifdef MS_WINDOWS
2317/* concatenating string here */
2318PyDoc_STR(
oldkaa0735f2018-02-02 16:52:55 +08002319"_enablelegacywindowsfsencoding -- [Windows only]\n\
Steve Dowercc16be82016-09-08 10:35:16 -07002320"
2321)
2322#endif
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +00002323PyDoc_STR(
Ka-Ping Yeeb5c51322001-03-23 02:46:52 +00002324"__stdin__ -- the original stdin; don't touch!\n\
2325__stdout__ -- the original stdout; don't touch!\n\
2326__stderr__ -- the original stderr; don't touch!\n\
2327__displayhook__ -- the original displayhook; don't touch!\n\
2328__excepthook__ -- the original excepthook; don't touch!\n\
Guido van Rossumc3bc31e1998-06-27 19:43:25 +00002329\n\
2330Functions:\n\
2331\n\
Georg Brandl1a3284e2007-12-02 09:40:06 +00002332displayhook() -- print an object to the screen, and save it in builtins._\n\
Ka-Ping Yeeb5c51322001-03-23 02:46:52 +00002333excepthook() -- print an exception and its traceback to sys.stderr\n\
Guido van Rossumc3bc31e1998-06-27 19:43:25 +00002334exc_info() -- return thread-safe information about the current exception\n\
2335exit() -- exit the interpreter by raising SystemExit\n\
Martin v. Löwisf0473d52001-07-18 16:17:16 +00002336getdlopenflags() -- returns flags to be used for dlopen() calls\n\
Christian Heimes9bd667a2008-01-20 15:14:11 +00002337getprofile() -- get the global profiling function\n\
Guido van Rossumc3bc31e1998-06-27 19:43:25 +00002338getrefcount() -- return the reference count for an object (plus one :-)\n\
Jeremy Hyltonee5adfb2000-08-31 19:23:01 +00002339getrecursionlimit() -- return the max recursion depth for the interpreter\n\
Martin v. Löwis00709aa2008-06-04 14:18:43 +00002340getsizeof() -- return the size of an object in bytes\n\
Christian Heimes9bd667a2008-01-20 15:14:11 +00002341gettrace() -- get the global debug tracing function\n\
Martin v. Löwisf0473d52001-07-18 16:17:16 +00002342setdlopenflags() -- set the flags to be used for dlopen() calls\n\
Guido van Rossumc3bc31e1998-06-27 19:43:25 +00002343setprofile() -- set the global profiling function\n\
Jeremy Hyltonee5adfb2000-08-31 19:23:01 +00002344setrecursionlimit() -- set the max recursion depth for the interpreter\n\
Guido van Rossumc3bc31e1998-06-27 19:43:25 +00002345settrace() -- set the global debug tracing function\n\
Fred Drakeccede592000-08-14 20:59:57 +00002346"
Martin v. Löwisa3fb4f72002-06-09 13:33:54 +00002347)
Fred Drakeccede592000-08-14 20:59:57 +00002348/* end of sys_doc */ ;
Guido van Rossumc3bc31e1998-06-27 19:43:25 +00002349
Christian Heimesd32ed6f2008-01-14 18:49:24 +00002350
2351PyDoc_STRVAR(flags__doc__,
2352"sys.flags\n\
2353\n\
2354Flags provided through command line arguments or environment vars.");
2355
2356static PyTypeObject FlagsType;
2357
2358static PyStructSequence_Field flags_fields[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002359 {"debug", "-d"},
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002360 {"inspect", "-i"},
2361 {"interactive", "-i"},
2362 {"optimize", "-O or -OO"},
2363 {"dont_write_bytecode", "-B"},
2364 {"no_user_site", "-s"},
2365 {"no_site", "-S"},
2366 {"ignore_environment", "-E"},
2367 {"verbose", "-v"},
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002368 /* {"unbuffered", "-u"}, */
2369 /* {"skip_first", "-x"}, */
Georg Brandl8aa7e992010-12-28 18:30:18 +00002370 {"bytes_warning", "-b"},
2371 {"quiet", "-q"},
Georg Brandl09a7c722012-02-20 21:31:46 +01002372 {"hash_randomization", "-R"},
Christian Heimesad73a9c2013-08-10 16:36:18 +02002373 {"isolated", "-I"},
Victor Stinner5e3806f2017-11-30 11:40:24 +01002374 {"dev_mode", "-X dev"},
Victor Stinner91106cd2017-12-13 12:29:09 +01002375 {"utf8_mode", "-X utf8"},
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002376 {0}
Christian Heimesd32ed6f2008-01-14 18:49:24 +00002377};
2378
2379static PyStructSequence_Desc flags_desc = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002380 "sys.flags", /* name */
2381 flags__doc__, /* doc */
2382 flags_fields, /* fields */
Victor Stinner91106cd2017-12-13 12:29:09 +01002383 15
Christian Heimesd32ed6f2008-01-14 18:49:24 +00002384};
2385
2386static PyObject*
Victor Stinner838f2642019-06-13 22:41:23 +02002387make_flags(_PyRuntimeState *runtime, PyThreadState *tstate)
Christian Heimesd32ed6f2008-01-14 18:49:24 +00002388{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002389 int pos = 0;
2390 PyObject *seq;
Victor Stinner331a6a52019-05-27 16:39:22 +02002391 const PyPreConfig *preconfig = &runtime->preconfig;
Victor Stinner838f2642019-06-13 22:41:23 +02002392 const PyConfig *config = &tstate->interp->config;
Christian Heimesd32ed6f2008-01-14 18:49:24 +00002393
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002394 seq = PyStructSequence_New(&FlagsType);
2395 if (seq == NULL)
2396 return NULL;
Christian Heimesd32ed6f2008-01-14 18:49:24 +00002397
2398#define SetFlag(flag) \
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002399 PyStructSequence_SET_ITEM(seq, pos++, PyLong_FromLong(flag))
Christian Heimesd32ed6f2008-01-14 18:49:24 +00002400
Victor Stinnerfbca9082018-08-30 00:50:45 +02002401 SetFlag(config->parser_debug);
2402 SetFlag(config->inspect);
2403 SetFlag(config->interactive);
2404 SetFlag(config->optimization_level);
2405 SetFlag(!config->write_bytecode);
2406 SetFlag(!config->user_site_directory);
2407 SetFlag(!config->site_import);
Victor Stinner20004952019-03-26 02:31:11 +01002408 SetFlag(!config->use_environment);
Victor Stinnerfbca9082018-08-30 00:50:45 +02002409 SetFlag(config->verbose);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002410 /* SetFlag(saw_unbuffered_flag); */
2411 /* SetFlag(skipfirstline); */
Victor Stinnerfbca9082018-08-30 00:50:45 +02002412 SetFlag(config->bytes_warning);
2413 SetFlag(config->quiet);
2414 SetFlag(config->use_hash_seed == 0 || config->hash_seed != 0);
Victor Stinner20004952019-03-26 02:31:11 +01002415 SetFlag(config->isolated);
2416 PyStructSequence_SET_ITEM(seq, pos++, PyBool_FromLong(config->dev_mode));
2417 SetFlag(preconfig->utf8_mode);
Victor Stinner91106cd2017-12-13 12:29:09 +01002418#undef SetFlag
Christian Heimesd32ed6f2008-01-14 18:49:24 +00002419
Victor Stinner838f2642019-06-13 22:41:23 +02002420 if (_PyErr_Occurred(tstate)) {
Serhiy Storchaka87a854d2013-12-17 14:59:42 +02002421 Py_DECREF(seq);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002422 return NULL;
2423 }
2424 return seq;
Christian Heimesd32ed6f2008-01-14 18:49:24 +00002425}
2426
Eric Smith0e5b5622009-02-06 01:32:42 +00002427PyDoc_STRVAR(version_info__doc__,
2428"sys.version_info\n\
2429\n\
2430Version information as a named tuple.");
2431
2432static PyTypeObject VersionInfoType;
2433
2434static PyStructSequence_Field version_info_fields[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002435 {"major", "Major release number"},
2436 {"minor", "Minor release number"},
2437 {"micro", "Patch release number"},
Ned Deilyda4887a2016-11-04 17:03:34 -04002438 {"releaselevel", "'alpha', 'beta', 'candidate', or 'final'"},
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002439 {"serial", "Serial release number"},
2440 {0}
Eric Smith0e5b5622009-02-06 01:32:42 +00002441};
2442
2443static PyStructSequence_Desc version_info_desc = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002444 "sys.version_info", /* name */
2445 version_info__doc__, /* doc */
2446 version_info_fields, /* fields */
2447 5
Eric Smith0e5b5622009-02-06 01:32:42 +00002448};
2449
2450static PyObject *
Victor Stinner838f2642019-06-13 22:41:23 +02002451make_version_info(PyThreadState *tstate)
Eric Smith0e5b5622009-02-06 01:32:42 +00002452{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002453 PyObject *version_info;
2454 char *s;
2455 int pos = 0;
Eric Smith0e5b5622009-02-06 01:32:42 +00002456
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002457 version_info = PyStructSequence_New(&VersionInfoType);
2458 if (version_info == NULL) {
2459 return NULL;
2460 }
Eric Smith0e5b5622009-02-06 01:32:42 +00002461
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002462 /*
2463 * These release level checks are mutually exclusive and cover
2464 * the field, so don't get too fancy with the pre-processor!
2465 */
Eric Smith0e5b5622009-02-06 01:32:42 +00002466#if PY_RELEASE_LEVEL == PY_RELEASE_LEVEL_ALPHA
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002467 s = "alpha";
Eric Smith0e5b5622009-02-06 01:32:42 +00002468#elif PY_RELEASE_LEVEL == PY_RELEASE_LEVEL_BETA
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002469 s = "beta";
Eric Smith0e5b5622009-02-06 01:32:42 +00002470#elif PY_RELEASE_LEVEL == PY_RELEASE_LEVEL_GAMMA
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002471 s = "candidate";
Eric Smith0e5b5622009-02-06 01:32:42 +00002472#elif PY_RELEASE_LEVEL == PY_RELEASE_LEVEL_FINAL
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002473 s = "final";
Eric Smith0e5b5622009-02-06 01:32:42 +00002474#endif
2475
2476#define SetIntItem(flag) \
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002477 PyStructSequence_SET_ITEM(version_info, pos++, PyLong_FromLong(flag))
Eric Smith0e5b5622009-02-06 01:32:42 +00002478#define SetStrItem(flag) \
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002479 PyStructSequence_SET_ITEM(version_info, pos++, PyUnicode_FromString(flag))
Eric Smith0e5b5622009-02-06 01:32:42 +00002480
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002481 SetIntItem(PY_MAJOR_VERSION);
2482 SetIntItem(PY_MINOR_VERSION);
2483 SetIntItem(PY_MICRO_VERSION);
2484 SetStrItem(s);
2485 SetIntItem(PY_RELEASE_SERIAL);
Eric Smith0e5b5622009-02-06 01:32:42 +00002486#undef SetIntItem
2487#undef SetStrItem
2488
Victor Stinner838f2642019-06-13 22:41:23 +02002489 if (_PyErr_Occurred(tstate)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002490 Py_CLEAR(version_info);
2491 return NULL;
2492 }
2493 return version_info;
Eric Smith0e5b5622009-02-06 01:32:42 +00002494}
2495
Brett Cannon3adc7b72012-07-09 14:22:12 -04002496/* sys.implementation values */
2497#define NAME "cpython"
2498const char *_PySys_ImplName = NAME;
Victor Stinnercf01b682015-11-05 11:21:38 +01002499#define MAJOR Py_STRINGIFY(PY_MAJOR_VERSION)
2500#define MINOR Py_STRINGIFY(PY_MINOR_VERSION)
Ned Deily529ea5d2014-06-30 23:31:14 -07002501#define TAG NAME "-" MAJOR MINOR
Brett Cannon3adc7b72012-07-09 14:22:12 -04002502const char *_PySys_ImplCacheTag = TAG;
2503#undef NAME
Brett Cannon3adc7b72012-07-09 14:22:12 -04002504#undef MAJOR
2505#undef MINOR
2506#undef TAG
2507
Barry Warsaw409da152012-06-03 16:18:47 -04002508static PyObject *
2509make_impl_info(PyObject *version_info)
2510{
2511 int res;
2512 PyObject *impl_info, *value, *ns;
2513
2514 impl_info = PyDict_New();
2515 if (impl_info == NULL)
2516 return NULL;
2517
2518 /* populate the dict */
2519
Brett Cannon3adc7b72012-07-09 14:22:12 -04002520 value = PyUnicode_FromString(_PySys_ImplName);
Barry Warsaw409da152012-06-03 16:18:47 -04002521 if (value == NULL)
2522 goto error;
2523 res = PyDict_SetItemString(impl_info, "name", value);
2524 Py_DECREF(value);
2525 if (res < 0)
2526 goto error;
2527
Brett Cannon3adc7b72012-07-09 14:22:12 -04002528 value = PyUnicode_FromString(_PySys_ImplCacheTag);
Barry Warsaw409da152012-06-03 16:18:47 -04002529 if (value == NULL)
2530 goto error;
2531 res = PyDict_SetItemString(impl_info, "cache_tag", value);
2532 Py_DECREF(value);
2533 if (res < 0)
2534 goto error;
Barry Warsaw409da152012-06-03 16:18:47 -04002535
2536 res = PyDict_SetItemString(impl_info, "version", version_info);
2537 if (res < 0)
2538 goto error;
2539
2540 value = PyLong_FromLong(PY_VERSION_HEX);
2541 if (value == NULL)
2542 goto error;
2543 res = PyDict_SetItemString(impl_info, "hexversion", value);
2544 Py_DECREF(value);
2545 if (res < 0)
2546 goto error;
2547
doko@ubuntu.com55532312016-06-14 08:55:19 +02002548#ifdef MULTIARCH
2549 value = PyUnicode_FromString(MULTIARCH);
2550 if (value == NULL)
2551 goto error;
2552 res = PyDict_SetItemString(impl_info, "_multiarch", value);
2553 Py_DECREF(value);
2554 if (res < 0)
2555 goto error;
2556#endif
2557
Barry Warsaw409da152012-06-03 16:18:47 -04002558 /* dict ready */
2559
2560 ns = _PyNamespace_New(impl_info);
2561 Py_DECREF(impl_info);
2562 return ns;
2563
2564error:
2565 Py_CLEAR(impl_info);
2566 return NULL;
2567}
2568
Martin v. Löwis1a214512008-06-11 05:26:20 +00002569static struct PyModuleDef sysmodule = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002570 PyModuleDef_HEAD_INIT,
2571 "sys",
2572 sys_doc,
2573 -1, /* multiple "initialization" just copies the module dict. */
2574 sys_methods,
2575 NULL,
2576 NULL,
2577 NULL,
2578 NULL
Martin v. Löwis1a214512008-06-11 05:26:20 +00002579};
2580
Eric Snow6b4be192017-05-22 21:36:03 -07002581/* Updating the sys namespace, returning NULL pointer on error */
Victor Stinner8fea2522013-10-27 17:15:42 +01002582#define SET_SYS_FROM_STRING_BORROW(key, value) \
Victor Stinner58049602013-07-22 22:40:00 +02002583 do { \
Victor Stinner58049602013-07-22 22:40:00 +02002584 PyObject *v = (value); \
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002585 if (v == NULL) { \
2586 goto err_occurred; \
2587 } \
Victor Stinner58049602013-07-22 22:40:00 +02002588 res = PyDict_SetItemString(sysdict, key, v); \
2589 if (res < 0) { \
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002590 goto err_occurred; \
Victor Stinner8fea2522013-10-27 17:15:42 +01002591 } \
2592 } while (0)
2593#define SET_SYS_FROM_STRING(key, value) \
2594 do { \
Victor Stinner8fea2522013-10-27 17:15:42 +01002595 PyObject *v = (value); \
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002596 if (v == NULL) { \
2597 goto err_occurred; \
2598 } \
Victor Stinner8fea2522013-10-27 17:15:42 +01002599 res = PyDict_SetItemString(sysdict, key, v); \
2600 Py_DECREF(v); \
2601 if (res < 0) { \
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002602 goto err_occurred; \
Victor Stinner58049602013-07-22 22:40:00 +02002603 } \
2604 } while (0)
Guido van Rossum25ce5661997-08-02 03:10:38 +00002605
Victor Stinner331a6a52019-05-27 16:39:22 +02002606static PyStatus
Victor Stinner838f2642019-06-13 22:41:23 +02002607_PySys_InitCore(_PyRuntimeState *runtime, PyThreadState *tstate,
Victor Stinner0fd2c302019-06-04 03:15:09 +02002608 PyObject *sysdict)
Eric Snow6b4be192017-05-22 21:36:03 -07002609{
Victor Stinnerab672812019-01-23 15:04:40 +01002610 PyObject *version_info;
Eric Snow6b4be192017-05-22 21:36:03 -07002611 int res;
2612
Nick Coghland6009512014-11-20 21:39:37 +10002613 /* stdin/stdout/stderr are set in pylifecycle.c */
Martin v. Löwis5467d4c2003-05-10 07:10:12 +00002614
Victor Stinner8fea2522013-10-27 17:15:42 +01002615 SET_SYS_FROM_STRING_BORROW("__displayhook__",
2616 PyDict_GetItemString(sysdict, "displayhook"));
2617 SET_SYS_FROM_STRING_BORROW("__excepthook__",
2618 PyDict_GetItemString(sysdict, "excepthook"));
Barry Warsaw36c1d1f2017-10-05 12:11:18 -04002619 SET_SYS_FROM_STRING_BORROW(
2620 "__breakpointhook__",
2621 PyDict_GetItemString(sysdict, "breakpointhook"));
Victor Stinneref9d9b62019-05-22 11:28:22 +02002622 SET_SYS_FROM_STRING_BORROW("__unraisablehook__",
2623 PyDict_GetItemString(sysdict, "unraisablehook"));
2624
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002625 SET_SYS_FROM_STRING("version",
2626 PyUnicode_FromString(Py_GetVersion()));
2627 SET_SYS_FROM_STRING("hexversion",
2628 PyLong_FromLong(PY_VERSION_HEX));
Ned Deily5c4b0d02017-03-04 00:19:55 -05002629 SET_SYS_FROM_STRING("_git",
2630 Py_BuildValue("(szz)", "CPython", _Py_gitidentifier(),
2631 _Py_gitversion()));
INADA Naoki6b42eb12017-06-29 15:31:38 +09002632 SET_SYS_FROM_STRING("_framework", PyUnicode_FromString(_PYTHONFRAMEWORK));
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002633 SET_SYS_FROM_STRING("api_version",
2634 PyLong_FromLong(PYTHON_API_VERSION));
2635 SET_SYS_FROM_STRING("copyright",
2636 PyUnicode_FromString(Py_GetCopyright()));
2637 SET_SYS_FROM_STRING("platform",
2638 PyUnicode_FromString(Py_GetPlatform()));
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002639 SET_SYS_FROM_STRING("maxsize",
2640 PyLong_FromSsize_t(PY_SSIZE_T_MAX));
2641 SET_SYS_FROM_STRING("float_info",
2642 PyFloat_GetInfo());
2643 SET_SYS_FROM_STRING("int_info",
2644 PyLong_GetInfo());
Mark Dickinsondc787d22010-05-23 13:33:13 +00002645 /* initialize hash_info */
Victor Stinner1c8f0592013-07-22 22:24:54 +02002646 if (Hash_InfoType.tp_name == NULL) {
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002647 if (PyStructSequence_InitType2(&Hash_InfoType, &hash_info_desc) < 0) {
2648 goto type_init_failed;
2649 }
Victor Stinner1c8f0592013-07-22 22:24:54 +02002650 }
Mark Dickinsondc787d22010-05-23 13:33:13 +00002651 SET_SYS_FROM_STRING("hash_info",
Victor Stinner838f2642019-06-13 22:41:23 +02002652 get_hash_info(tstate));
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002653 SET_SYS_FROM_STRING("maxunicode",
Ezio Melotti48a2f8f2011-09-29 00:18:19 +03002654 PyLong_FromLong(0x10FFFF));
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002655 SET_SYS_FROM_STRING("builtin_module_names",
2656 list_builtin_module_names());
Christian Heimes743e0cd2012-10-17 23:52:17 +02002657#if PY_BIG_ENDIAN
2658 SET_SYS_FROM_STRING("byteorder",
2659 PyUnicode_FromString("big"));
2660#else
2661 SET_SYS_FROM_STRING("byteorder",
2662 PyUnicode_FromString("little"));
2663#endif
Fred Drake099325e2000-08-14 15:47:03 +00002664
Guido van Rossum8b9ea871996-08-23 18:14:47 +00002665#ifdef MS_COREDLL
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002666 SET_SYS_FROM_STRING("dllhandle",
2667 PyLong_FromVoidPtr(PyWin_DLLhModule));
2668 SET_SYS_FROM_STRING("winver",
2669 PyUnicode_FromString(PyWin_DLLVersionString));
Guido van Rossumc606fe11996-04-09 02:37:57 +00002670#endif
Barry Warsaw8cf4eae2010-10-16 01:04:07 +00002671#ifdef ABIFLAGS
2672 SET_SYS_FROM_STRING("abiflags",
2673 PyUnicode_FromString(ABIFLAGS));
2674#endif
Antoine Pitrou9583cac2010-10-21 13:42:28 +00002675
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002676 /* version_info */
Victor Stinner1c8f0592013-07-22 22:24:54 +02002677 if (VersionInfoType.tp_name == NULL) {
2678 if (PyStructSequence_InitType2(&VersionInfoType,
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002679 &version_info_desc) < 0) {
2680 goto type_init_failed;
2681 }
Victor Stinner1c8f0592013-07-22 22:24:54 +02002682 }
Victor Stinner838f2642019-06-13 22:41:23 +02002683 version_info = make_version_info(tstate);
Barry Warsaw409da152012-06-03 16:18:47 -04002684 SET_SYS_FROM_STRING("version_info", version_info);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002685 /* prevent user from creating new instances */
2686 VersionInfoType.tp_init = NULL;
2687 VersionInfoType.tp_new = NULL;
Antoine Pitrou871dfc42014-04-28 13:07:06 +02002688 res = PyDict_DelItemString(VersionInfoType.tp_dict, "__new__");
Victor Stinner838f2642019-06-13 22:41:23 +02002689 if (res < 0 && _PyErr_ExceptionMatches(tstate, PyExc_KeyError)) {
2690 _PyErr_Clear(tstate);
2691 }
Eric Smith0e5b5622009-02-06 01:32:42 +00002692
Barry Warsaw409da152012-06-03 16:18:47 -04002693 /* implementation */
2694 SET_SYS_FROM_STRING("implementation", make_impl_info(version_info));
2695
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002696 /* flags */
Victor Stinner1c8f0592013-07-22 22:24:54 +02002697 if (FlagsType.tp_name == 0) {
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002698 if (PyStructSequence_InitType2(&FlagsType, &flags_desc) < 0) {
2699 goto type_init_failed;
2700 }
Victor Stinner1c8f0592013-07-22 22:24:54 +02002701 }
Victor Stinner43125222019-04-24 18:23:53 +02002702 /* Set flags to their default values (updated by _PySys_InitMain()) */
Victor Stinner838f2642019-06-13 22:41:23 +02002703 SET_SYS_FROM_STRING("flags", make_flags(runtime, tstate));
Eric Smithf7bb5782010-01-27 00:44:57 +00002704
2705#if defined(MS_WINDOWS)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002706 /* getwindowsversion */
2707 if (WindowsVersionType.tp_name == 0)
Victor Stinner1c8f0592013-07-22 22:24:54 +02002708 if (PyStructSequence_InitType2(&WindowsVersionType,
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002709 &windows_version_desc) < 0) {
2710 goto type_init_failed;
2711 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002712 /* prevent user from creating new instances */
2713 WindowsVersionType.tp_init = NULL;
2714 WindowsVersionType.tp_new = NULL;
Victor Stinner838f2642019-06-13 22:41:23 +02002715 assert(!_PyErr_Occurred(tstate));
Antoine Pitrou871dfc42014-04-28 13:07:06 +02002716 res = PyDict_DelItemString(WindowsVersionType.tp_dict, "__new__");
Victor Stinner838f2642019-06-13 22:41:23 +02002717 if (res < 0 && _PyErr_ExceptionMatches(tstate, PyExc_KeyError)) {
2718 _PyErr_Clear(tstate);
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002719 }
Eric Smithf7bb5782010-01-27 00:44:57 +00002720#endif
2721
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002722 /* float repr style: 0.03 (short) vs 0.029999999999999999 (legacy) */
Mark Dickinsonb08a53a2009-04-16 19:52:09 +00002723#ifndef PY_NO_SHORT_FLOAT_REPR
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002724 SET_SYS_FROM_STRING("float_repr_style",
2725 PyUnicode_FromString("short"));
Mark Dickinsonb08a53a2009-04-16 19:52:09 +00002726#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002727 SET_SYS_FROM_STRING("float_repr_style",
2728 PyUnicode_FromString("legacy"));
Mark Dickinsonb08a53a2009-04-16 19:52:09 +00002729#endif
2730
Victor Stinnerd5c355c2011-04-30 14:53:09 +02002731 SET_SYS_FROM_STRING("thread_info", PyThread_GetInfo());
Victor Stinnerd5c355c2011-04-30 14:53:09 +02002732
Yury Selivanoveb636452016-09-08 22:01:51 -07002733 /* initialize asyncgen_hooks */
2734 if (AsyncGenHooksType.tp_name == NULL) {
2735 if (PyStructSequence_InitType2(
2736 &AsyncGenHooksType, &asyncgen_hooks_desc) < 0) {
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002737 goto type_init_failed;
Yury Selivanoveb636452016-09-08 22:01:51 -07002738 }
2739 }
2740
Victor Stinner838f2642019-06-13 22:41:23 +02002741 if (_PyErr_Occurred(tstate)) {
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002742 goto err_occurred;
2743 }
Victor Stinner331a6a52019-05-27 16:39:22 +02002744 return _PyStatus_OK();
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002745
2746type_init_failed:
Victor Stinner331a6a52019-05-27 16:39:22 +02002747 return _PyStatus_ERR("failed to initialize a type");
Victor Stinnerf7e5b562017-11-15 15:48:08 -08002748
2749err_occurred:
Victor Stinner331a6a52019-05-27 16:39:22 +02002750 return _PyStatus_ERR("can't initialize sys module");
Guido van Rossum5b3138b1990-11-18 17:41:40 +00002751}
2752
Eric Snow6b4be192017-05-22 21:36:03 -07002753#undef SET_SYS_FROM_STRING
Eric Snow6b4be192017-05-22 21:36:03 -07002754
2755/* Updating the sys namespace, returning integer error codes */
Eric Snow6b4be192017-05-22 21:36:03 -07002756#define SET_SYS_FROM_STRING_INT_RESULT(key, value) \
2757 do { \
2758 PyObject *v = (value); \
2759 if (v == NULL) \
2760 return -1; \
2761 res = PyDict_SetItemString(sysdict, key, v); \
2762 Py_DECREF(v); \
2763 if (res < 0) { \
2764 return res; \
2765 } \
2766 } while (0)
2767
Victor Stinner8b9dbc02019-03-27 01:36:16 +01002768
2769static int
2770sys_add_xoption(PyObject *opts, const wchar_t *s)
2771{
2772 PyObject *name, *value;
2773
2774 const wchar_t *name_end = wcschr(s, L'=');
2775 if (!name_end) {
2776 name = PyUnicode_FromWideChar(s, -1);
2777 value = Py_True;
2778 Py_INCREF(value);
2779 }
2780 else {
2781 name = PyUnicode_FromWideChar(s, name_end - s);
2782 value = PyUnicode_FromWideChar(name_end + 1, -1);
2783 }
2784 if (name == NULL || value == NULL) {
2785 goto error;
2786 }
2787 if (PyDict_SetItem(opts, name, value) < 0) {
2788 goto error;
2789 }
2790 Py_DECREF(name);
2791 Py_DECREF(value);
2792 return 0;
2793
2794error:
2795 Py_XDECREF(name);
2796 Py_XDECREF(value);
2797 return -1;
2798}
2799
2800
2801static PyObject*
Victor Stinner331a6a52019-05-27 16:39:22 +02002802sys_create_xoptions_dict(const PyConfig *config)
Victor Stinner8b9dbc02019-03-27 01:36:16 +01002803{
2804 Py_ssize_t nxoption = config->xoptions.length;
2805 wchar_t * const * xoptions = config->xoptions.items;
2806 PyObject *dict = PyDict_New();
2807 if (dict == NULL) {
2808 return NULL;
2809 }
2810
2811 for (Py_ssize_t i=0; i < nxoption; i++) {
2812 const wchar_t *option = xoptions[i];
2813 if (sys_add_xoption(dict, option) < 0) {
2814 Py_DECREF(dict);
2815 return NULL;
2816 }
2817 }
2818
2819 return dict;
2820}
2821
2822
Eric Snow6b4be192017-05-22 21:36:03 -07002823int
Victor Stinner838f2642019-06-13 22:41:23 +02002824_PySys_InitMain(_PyRuntimeState *runtime, PyThreadState *tstate)
Eric Snow6b4be192017-05-22 21:36:03 -07002825{
Victor Stinner838f2642019-06-13 22:41:23 +02002826 PyObject *sysdict = tstate->interp->sysdict;
2827 const PyConfig *config = &tstate->interp->config;
Eric Snow6b4be192017-05-22 21:36:03 -07002828 int res;
2829
Victor Stinner8b9dbc02019-03-27 01:36:16 +01002830#define COPY_LIST(KEY, VALUE) \
Victor Stinner37cd9822018-11-16 11:55:35 +01002831 do { \
Victor Stinner331a6a52019-05-27 16:39:22 +02002832 PyObject *list = _PyWideStringList_AsList(&(VALUE)); \
Victor Stinner37cd9822018-11-16 11:55:35 +01002833 if (list == NULL) { \
2834 return -1; \
2835 } \
2836 SET_SYS_FROM_STRING_BORROW(KEY, list); \
2837 Py_DECREF(list); \
2838 } while (0)
2839
Victor Stinner8b9dbc02019-03-27 01:36:16 +01002840#define SET_SYS_FROM_WSTR(KEY, VALUE) \
2841 do { \
2842 PyObject *str = PyUnicode_FromWideChar(VALUE, -1); \
2843 if (str == NULL) { \
2844 return -1; \
2845 } \
2846 SET_SYS_FROM_STRING_BORROW(KEY, str); \
2847 Py_DECREF(str); \
2848 } while (0)
Victor Stinner37cd9822018-11-16 11:55:35 +01002849
Victor Stinner8b9dbc02019-03-27 01:36:16 +01002850 COPY_LIST("path", config->module_search_paths);
2851
2852 SET_SYS_FROM_WSTR("executable", config->executable);
Steve Dower9048c492019-06-29 10:34:11 -07002853 SET_SYS_FROM_WSTR("_base_executable", config->base_executable);
Victor Stinner8b9dbc02019-03-27 01:36:16 +01002854 SET_SYS_FROM_WSTR("prefix", config->prefix);
2855 SET_SYS_FROM_WSTR("base_prefix", config->base_prefix);
2856 SET_SYS_FROM_WSTR("exec_prefix", config->exec_prefix);
2857 SET_SYS_FROM_WSTR("base_exec_prefix", config->base_exec_prefix);
Victor Stinner41264f12017-12-15 02:05:29 +01002858
Carl Meyerb193fa92018-06-15 22:40:56 -06002859 if (config->pycache_prefix != NULL) {
Victor Stinner8b9dbc02019-03-27 01:36:16 +01002860 SET_SYS_FROM_WSTR("pycache_prefix", config->pycache_prefix);
Carl Meyerb193fa92018-06-15 22:40:56 -06002861 } else {
2862 PyDict_SetItemString(sysdict, "pycache_prefix", Py_None);
2863 }
2864
Victor Stinner8b9dbc02019-03-27 01:36:16 +01002865 COPY_LIST("argv", config->argv);
2866 COPY_LIST("warnoptions", config->warnoptions);
2867
2868 PyObject *xoptions = sys_create_xoptions_dict(config);
2869 if (xoptions == NULL) {
2870 return -1;
Victor Stinner41264f12017-12-15 02:05:29 +01002871 }
Victor Stinner8b9dbc02019-03-27 01:36:16 +01002872 SET_SYS_FROM_STRING_BORROW("_xoptions", xoptions);
Pablo Galindo34ef64f2019-03-27 12:43:47 +00002873 Py_DECREF(xoptions);
Victor Stinner41264f12017-12-15 02:05:29 +01002874
Victor Stinner37cd9822018-11-16 11:55:35 +01002875#undef COPY_LIST
Victor Stinner8b9dbc02019-03-27 01:36:16 +01002876#undef SET_SYS_FROM_WSTR
Victor Stinner37cd9822018-11-16 11:55:35 +01002877
Eric Snow6b4be192017-05-22 21:36:03 -07002878 /* Set flags to their final values */
Victor Stinner838f2642019-06-13 22:41:23 +02002879 SET_SYS_FROM_STRING_INT_RESULT("flags", make_flags(runtime, tstate));
Eric Snow6b4be192017-05-22 21:36:03 -07002880 /* prevent user from creating new instances */
2881 FlagsType.tp_init = NULL;
2882 FlagsType.tp_new = NULL;
2883 res = PyDict_DelItemString(FlagsType.tp_dict, "__new__");
2884 if (res < 0) {
Victor Stinner838f2642019-06-13 22:41:23 +02002885 if (!_PyErr_ExceptionMatches(tstate, PyExc_KeyError)) {
Eric Snow6b4be192017-05-22 21:36:03 -07002886 return res;
2887 }
Victor Stinner838f2642019-06-13 22:41:23 +02002888 _PyErr_Clear(tstate);
Eric Snow6b4be192017-05-22 21:36:03 -07002889 }
2890
2891 SET_SYS_FROM_STRING_INT_RESULT("dont_write_bytecode",
Victor Stinner8b9dbc02019-03-27 01:36:16 +01002892 PyBool_FromLong(!config->write_bytecode));
Eric Snow6b4be192017-05-22 21:36:03 -07002893
Victor Stinner838f2642019-06-13 22:41:23 +02002894 if (get_warnoptions(tstate) == NULL) {
Eric Snow2ebc5ce2017-09-07 23:51:28 -06002895 return -1;
Victor Stinner838f2642019-06-13 22:41:23 +02002896 }
Victor Stinner865de272017-06-08 13:27:47 +02002897
Victor Stinner838f2642019-06-13 22:41:23 +02002898 if (get_xoptions(tstate) == NULL)
Eric Snow2ebc5ce2017-09-07 23:51:28 -06002899 return -1;
Eric Snow6b4be192017-05-22 21:36:03 -07002900
Nick Coghlanbc77eff2018-03-25 20:44:30 +10002901 /* Transfer any sys.warnoptions and sys._xoptions set directly
2902 * by an embedding application from the linked list to the module. */
Victor Stinner838f2642019-06-13 22:41:23 +02002903 if (sys_read_preinit_options(tstate) != 0)
Nick Coghlanbc77eff2018-03-25 20:44:30 +10002904 return -1;
2905
Victor Stinner838f2642019-06-13 22:41:23 +02002906 if (_PyErr_Occurred(tstate)) {
2907 goto err_occurred;
2908 }
2909
Eric Snow6b4be192017-05-22 21:36:03 -07002910 return 0;
Victor Stinner41264f12017-12-15 02:05:29 +01002911
2912err_occurred:
2913 return -1;
Eric Snow6b4be192017-05-22 21:36:03 -07002914}
2915
Victor Stinner41264f12017-12-15 02:05:29 +01002916#undef SET_SYS_FROM_STRING_BORROW
Eric Snow6b4be192017-05-22 21:36:03 -07002917#undef SET_SYS_FROM_STRING_INT_RESULT
Eric Snow6b4be192017-05-22 21:36:03 -07002918
Victor Stinnerab672812019-01-23 15:04:40 +01002919
2920/* Set up a preliminary stderr printer until we have enough
2921 infrastructure for the io module in place.
2922
2923 Use UTF-8/surrogateescape and ignore EAGAIN errors. */
Victor Stinner331a6a52019-05-27 16:39:22 +02002924PyStatus
Victor Stinnerab672812019-01-23 15:04:40 +01002925_PySys_SetPreliminaryStderr(PyObject *sysdict)
2926{
2927 PyObject *pstderr = PyFile_NewStdPrinter(fileno(stderr));
2928 if (pstderr == NULL) {
2929 goto error;
2930 }
2931 if (_PyDict_SetItemId(sysdict, &PyId_stderr, pstderr) < 0) {
2932 goto error;
2933 }
2934 if (PyDict_SetItemString(sysdict, "__stderr__", pstderr) < 0) {
2935 goto error;
2936 }
2937 Py_DECREF(pstderr);
Victor Stinner331a6a52019-05-27 16:39:22 +02002938 return _PyStatus_OK();
Victor Stinnerab672812019-01-23 15:04:40 +01002939
2940error:
2941 Py_XDECREF(pstderr);
Victor Stinner331a6a52019-05-27 16:39:22 +02002942 return _PyStatus_ERR("can't set preliminary stderr");
Victor Stinnerab672812019-01-23 15:04:40 +01002943}
2944
2945
2946/* Create sys module without all attributes: _PySys_InitMain() should be called
2947 later to add remaining attributes. */
Victor Stinner331a6a52019-05-27 16:39:22 +02002948PyStatus
Victor Stinnerb45d2592019-06-20 00:05:23 +02002949_PySys_Create(_PyRuntimeState *runtime, PyThreadState *tstate,
Victor Stinner0fd2c302019-06-04 03:15:09 +02002950 PyObject **sysmod_p)
Victor Stinnerab672812019-01-23 15:04:40 +01002951{
Victor Stinnerb45d2592019-06-20 00:05:23 +02002952 PyInterpreterState *interp = tstate->interp;
Victor Stinner838f2642019-06-13 22:41:23 +02002953
Victor Stinnerab672812019-01-23 15:04:40 +01002954 PyObject *modules = PyDict_New();
2955 if (modules == NULL) {
Victor Stinner331a6a52019-05-27 16:39:22 +02002956 return _PyStatus_ERR("can't make modules dictionary");
Victor Stinnerab672812019-01-23 15:04:40 +01002957 }
2958 interp->modules = modules;
2959
2960 PyObject *sysmod = _PyModule_CreateInitialized(&sysmodule, PYTHON_API_VERSION);
2961 if (sysmod == NULL) {
Victor Stinner331a6a52019-05-27 16:39:22 +02002962 return _PyStatus_ERR("failed to create a module object");
Victor Stinnerab672812019-01-23 15:04:40 +01002963 }
2964
2965 PyObject *sysdict = PyModule_GetDict(sysmod);
2966 if (sysdict == NULL) {
Victor Stinner331a6a52019-05-27 16:39:22 +02002967 return _PyStatus_ERR("can't initialize sys dict");
Victor Stinnerab672812019-01-23 15:04:40 +01002968 }
2969 Py_INCREF(sysdict);
2970 interp->sysdict = sysdict;
2971
2972 if (PyDict_SetItemString(sysdict, "modules", interp->modules) < 0) {
Victor Stinner331a6a52019-05-27 16:39:22 +02002973 return _PyStatus_ERR("can't initialize sys module");
Victor Stinnerab672812019-01-23 15:04:40 +01002974 }
2975
Victor Stinner331a6a52019-05-27 16:39:22 +02002976 PyStatus status = _PySys_SetPreliminaryStderr(sysdict);
2977 if (_PyStatus_EXCEPTION(status)) {
2978 return status;
Victor Stinnerab672812019-01-23 15:04:40 +01002979 }
2980
Victor Stinner838f2642019-06-13 22:41:23 +02002981 status = _PySys_InitCore(runtime, tstate, sysdict);
Victor Stinner331a6a52019-05-27 16:39:22 +02002982 if (_PyStatus_EXCEPTION(status)) {
2983 return status;
Victor Stinnerab672812019-01-23 15:04:40 +01002984 }
2985
2986 _PyImport_FixupBuiltin(sysmod, "sys", interp->modules);
2987
2988 *sysmod_p = sysmod;
Victor Stinner331a6a52019-05-27 16:39:22 +02002989 return _PyStatus_OK();
Victor Stinnerab672812019-01-23 15:04:40 +01002990}
2991
2992
Guido van Rossum65bf9f21997-04-29 18:33:38 +00002993static PyObject *
Martin v. Löwis790465f2008-04-05 20:41:37 +00002994makepathobject(const wchar_t *path, wchar_t delim)
Guido van Rossum5b3138b1990-11-18 17:41:40 +00002995{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002996 int i, n;
2997 const wchar_t *p;
2998 PyObject *v, *w;
Tim Peters216b78b2006-01-06 02:40:53 +00002999
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003000 n = 1;
3001 p = path;
3002 while ((p = wcschr(p, delim)) != NULL) {
3003 n++;
3004 p++;
3005 }
3006 v = PyList_New(n);
3007 if (v == NULL)
3008 return NULL;
3009 for (i = 0; ; i++) {
3010 p = wcschr(path, delim);
3011 if (p == NULL)
3012 p = path + wcslen(path); /* End of string */
3013 w = PyUnicode_FromWideChar(path, (Py_ssize_t)(p - path));
3014 if (w == NULL) {
3015 Py_DECREF(v);
3016 return NULL;
3017 }
Zackery Spytz99d56b52018-12-08 07:16:55 -07003018 PyList_SET_ITEM(v, i, w);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003019 if (*p == '\0')
3020 break;
3021 path = p+1;
3022 }
3023 return v;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00003024}
3025
3026void
Martin v. Löwis790465f2008-04-05 20:41:37 +00003027PySys_SetPath(const wchar_t *path)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00003028{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003029 PyObject *v;
3030 if ((v = makepathobject(path, DELIM)) == NULL)
3031 Py_FatalError("can't create sys.path");
Victor Stinner838f2642019-06-13 22:41:23 +02003032 PyThreadState *tstate = _PyThreadState_GET();
3033 if (sys_set_object_id(tstate, &PyId_path, v) != 0) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003034 Py_FatalError("can't assign sys.path");
Victor Stinner838f2642019-06-13 22:41:23 +02003035 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003036 Py_DECREF(v);
Guido van Rossum3f5da241990-12-20 15:06:42 +00003037}
3038
Guido van Rossum65bf9f21997-04-29 18:33:38 +00003039static PyObject *
Victor Stinner74f65682019-03-15 15:08:05 +01003040make_sys_argv(int argc, wchar_t * const * argv)
Guido van Rossum3f5da241990-12-20 15:06:42 +00003041{
Victor Stinner74f65682019-03-15 15:08:05 +01003042 PyObject *list = PyList_New(argc);
3043 if (list == NULL) {
3044 return NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003045 }
Victor Stinner74f65682019-03-15 15:08:05 +01003046
3047 for (Py_ssize_t i = 0; i < argc; i++) {
3048 PyObject *v = PyUnicode_FromWideChar(argv[i], -1);
3049 if (v == NULL) {
3050 Py_DECREF(list);
3051 return NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003052 }
Victor Stinner74f65682019-03-15 15:08:05 +01003053 PyList_SET_ITEM(list, i, v);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003054 }
Victor Stinner74f65682019-03-15 15:08:05 +01003055 return list;
Guido van Rossum3f5da241990-12-20 15:06:42 +00003056}
3057
Victor Stinner11a247d2017-12-13 21:05:57 +01003058void
3059PySys_SetArgvEx(int argc, wchar_t **argv, int updatepath)
Victor Stinnerd5dda982017-12-13 17:31:16 +01003060{
Victor Stinner838f2642019-06-13 22:41:23 +02003061 PyThreadState *tstate = _PyThreadState_GET();
3062
Victor Stinner74f65682019-03-15 15:08:05 +01003063 if (argc < 1 || argv == NULL) {
3064 /* Ensure at least one (empty) argument is seen */
3065 wchar_t* empty_argv[1] = {L""};
3066 argv = empty_argv;
3067 argc = 1;
3068 }
3069
3070 PyObject *av = make_sys_argv(argc, argv);
Victor Stinnerd5dda982017-12-13 17:31:16 +01003071 if (av == NULL) {
Victor Stinner11a247d2017-12-13 21:05:57 +01003072 Py_FatalError("no mem for sys.argv");
Victor Stinnerd5dda982017-12-13 17:31:16 +01003073 }
Victor Stinner838f2642019-06-13 22:41:23 +02003074 if (sys_set_object(tstate, "argv", av) != 0) {
Victor Stinnerd5dda982017-12-13 17:31:16 +01003075 Py_DECREF(av);
Victor Stinner11a247d2017-12-13 21:05:57 +01003076 Py_FatalError("can't assign sys.argv");
Victor Stinnerd5dda982017-12-13 17:31:16 +01003077 }
3078 Py_DECREF(av);
3079
3080 if (updatepath) {
3081 /* If argv[0] is not '-c' nor '-m', prepend argv[0] to sys.path.
3082 If argv[0] is a symlink, use the real path. */
Victor Stinner331a6a52019-05-27 16:39:22 +02003083 const PyWideStringList argv_list = {.length = argc, .items = argv};
Victor Stinnerdcf61712019-03-19 16:09:27 +01003084 PyObject *path0 = NULL;
3085 if (_PyPathConfig_ComputeSysPath0(&argv_list, &path0)) {
3086 if (path0 == NULL) {
3087 Py_FatalError("can't compute path0 from argv");
Victor Stinner11a247d2017-12-13 21:05:57 +01003088 }
Victor Stinnerdcf61712019-03-19 16:09:27 +01003089
Victor Stinner838f2642019-06-13 22:41:23 +02003090 PyObject *sys_path = sys_get_object_id(tstate, &PyId_path);
Victor Stinnerdcf61712019-03-19 16:09:27 +01003091 if (sys_path != NULL) {
3092 if (PyList_Insert(sys_path, 0, path0) < 0) {
3093 Py_DECREF(path0);
3094 Py_FatalError("can't prepend path0 to sys.path");
3095 }
3096 }
3097 Py_DECREF(path0);
Victor Stinner11a247d2017-12-13 21:05:57 +01003098 }
Victor Stinnerd5dda982017-12-13 17:31:16 +01003099 }
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00003100}
Guido van Rossuma890e681998-05-12 14:59:24 +00003101
Antoine Pitrouf978fac2010-05-21 17:25:34 +00003102void
3103PySys_SetArgv(int argc, wchar_t **argv)
3104{
Christian Heimesad73a9c2013-08-10 16:36:18 +02003105 PySys_SetArgvEx(argc, argv, Py_IsolatedFlag == 0);
Antoine Pitrouf978fac2010-05-21 17:25:34 +00003106}
3107
Victor Stinner14284c22010-04-23 12:02:30 +00003108/* Reimplementation of PyFile_WriteString() no calling indirectly
3109 PyErr_CheckSignals(): avoid the call to PyObject_Str(). */
3110
3111static int
Victor Stinner79766632010-08-16 17:36:42 +00003112sys_pyfile_write_unicode(PyObject *unicode, PyObject *file)
Victor Stinner14284c22010-04-23 12:02:30 +00003113{
Victor Stinnerecccc4f2010-06-08 20:46:00 +00003114 if (file == NULL)
3115 return -1;
Jeroen Demeyerb1263d52019-06-28 11:49:00 +02003116 assert(unicode != NULL);
Jeroen Demeyer59ad1102019-07-11 10:59:05 +02003117 PyObject *result = _PyObject_CallMethodIdOneArg(file, &PyId_write, unicode);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003118 if (result == NULL) {
Jeroen Demeyerb1263d52019-06-28 11:49:00 +02003119 return -1;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003120 }
Jeroen Demeyerb1263d52019-06-28 11:49:00 +02003121 Py_DECREF(result);
3122 return 0;
Victor Stinner14284c22010-04-23 12:02:30 +00003123}
3124
Victor Stinner79766632010-08-16 17:36:42 +00003125static int
3126sys_pyfile_write(const char *text, PyObject *file)
3127{
3128 PyObject *unicode = NULL;
3129 int err;
3130
3131 if (file == NULL)
3132 return -1;
3133
3134 unicode = PyUnicode_FromString(text);
3135 if (unicode == NULL)
3136 return -1;
3137
3138 err = sys_pyfile_write_unicode(unicode, file);
3139 Py_DECREF(unicode);
3140 return err;
3141}
Guido van Rossuma890e681998-05-12 14:59:24 +00003142
3143/* APIs to write to sys.stdout or sys.stderr using a printf-like interface.
3144 Adapted from code submitted by Just van Rossum.
3145
3146 PySys_WriteStdout(format, ...)
3147 PySys_WriteStderr(format, ...)
3148
3149 The first function writes to sys.stdout; the second to sys.stderr. When
3150 there is a problem, they write to the real (C level) stdout or stderr;
Guido van Rossum8442af31998-10-12 18:22:10 +00003151 no exceptions are raised.
Guido van Rossuma890e681998-05-12 14:59:24 +00003152
Victor Stinner14284c22010-04-23 12:02:30 +00003153 PyErr_CheckSignals() is not called to avoid the execution of the Python
Victor Stinner79766632010-08-16 17:36:42 +00003154 signal handlers: they may raise a new exception whereas sys_write()
3155 ignores all exceptions.
Victor Stinner14284c22010-04-23 12:02:30 +00003156
Guido van Rossuma890e681998-05-12 14:59:24 +00003157 Both take a printf-style format string as their first argument followed
3158 by a variable length argument list determined by the format string.
3159
3160 *** WARNING ***
3161
3162 The format should limit the total size of the formatted output string to
3163 1000 bytes. In particular, this means that no unrestricted "%s" formats
3164 should occur; these should be limited using "%.<N>s where <N> is a
3165 decimal number calculated so that <N> plus the maximum size of other
3166 formatted text does not exceed 1000 bytes. Also watch out for "%f",
3167 which can print hundreds of digits for very large numbers.
3168
3169 */
3170
3171static void
Victor Stinner09054372013-11-06 22:41:44 +01003172sys_write(_Py_Identifier *key, FILE *fp, const char *format, va_list va)
Guido van Rossuma890e681998-05-12 14:59:24 +00003173{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003174 PyObject *file;
3175 PyObject *error_type, *error_value, *error_traceback;
3176 char buffer[1001];
3177 int written;
Victor Stinner838f2642019-06-13 22:41:23 +02003178 PyThreadState *tstate = _PyThreadState_GET();
Guido van Rossuma890e681998-05-12 14:59:24 +00003179
Victor Stinner838f2642019-06-13 22:41:23 +02003180 _PyErr_Fetch(tstate, &error_type, &error_value, &error_traceback);
3181 file = sys_get_object_id(tstate, key);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003182 written = PyOS_vsnprintf(buffer, sizeof(buffer), format, va);
3183 if (sys_pyfile_write(buffer, file) != 0) {
Victor Stinner838f2642019-06-13 22:41:23 +02003184 _PyErr_Clear(tstate);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003185 fputs(buffer, fp);
3186 }
3187 if (written < 0 || (size_t)written >= sizeof(buffer)) {
3188 const char *truncated = "... truncated";
Victor Stinner79766632010-08-16 17:36:42 +00003189 if (sys_pyfile_write(truncated, file) != 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003190 fputs(truncated, fp);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003191 }
Victor Stinner838f2642019-06-13 22:41:23 +02003192 _PyErr_Restore(tstate, error_type, error_value, error_traceback);
Guido van Rossuma890e681998-05-12 14:59:24 +00003193}
3194
3195void
Guido van Rossuma890e681998-05-12 14:59:24 +00003196PySys_WriteStdout(const char *format, ...)
Guido van Rossuma890e681998-05-12 14:59:24 +00003197{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003198 va_list va;
Guido van Rossuma890e681998-05-12 14:59:24 +00003199
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003200 va_start(va, format);
Victor Stinnerbd303c12013-11-07 23:07:29 +01003201 sys_write(&PyId_stdout, stdout, format, va);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003202 va_end(va);
Guido van Rossuma890e681998-05-12 14:59:24 +00003203}
3204
3205void
Guido van Rossuma890e681998-05-12 14:59:24 +00003206PySys_WriteStderr(const char *format, ...)
Guido van Rossuma890e681998-05-12 14:59:24 +00003207{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003208 va_list va;
Guido van Rossuma890e681998-05-12 14:59:24 +00003209
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003210 va_start(va, format);
Victor Stinnerbd303c12013-11-07 23:07:29 +01003211 sys_write(&PyId_stderr, stderr, format, va);
Victor Stinner79766632010-08-16 17:36:42 +00003212 va_end(va);
3213}
3214
3215static void
Victor Stinner09054372013-11-06 22:41:44 +01003216sys_format(_Py_Identifier *key, FILE *fp, const char *format, va_list va)
Victor Stinner79766632010-08-16 17:36:42 +00003217{
3218 PyObject *file, *message;
3219 PyObject *error_type, *error_value, *error_traceback;
Serhiy Storchaka85b0f5b2016-11-20 10:16:47 +02003220 const char *utf8;
Victor Stinner838f2642019-06-13 22:41:23 +02003221 PyThreadState *tstate = _PyThreadState_GET();
Victor Stinner79766632010-08-16 17:36:42 +00003222
Victor Stinner838f2642019-06-13 22:41:23 +02003223 _PyErr_Fetch(tstate, &error_type, &error_value, &error_traceback);
3224 file = sys_get_object_id(tstate, key);
Victor Stinner79766632010-08-16 17:36:42 +00003225 message = PyUnicode_FromFormatV(format, va);
3226 if (message != NULL) {
3227 if (sys_pyfile_write_unicode(message, file) != 0) {
Victor Stinner838f2642019-06-13 22:41:23 +02003228 _PyErr_Clear(tstate);
Serhiy Storchaka06515832016-11-20 09:13:07 +02003229 utf8 = PyUnicode_AsUTF8(message);
Victor Stinner79766632010-08-16 17:36:42 +00003230 if (utf8 != NULL)
3231 fputs(utf8, fp);
3232 }
3233 Py_DECREF(message);
3234 }
Victor Stinner838f2642019-06-13 22:41:23 +02003235 _PyErr_Restore(tstate, error_type, error_value, error_traceback);
Victor Stinner79766632010-08-16 17:36:42 +00003236}
3237
3238void
3239PySys_FormatStdout(const char *format, ...)
3240{
3241 va_list va;
3242
3243 va_start(va, format);
Victor Stinnerbd303c12013-11-07 23:07:29 +01003244 sys_format(&PyId_stdout, stdout, format, va);
Victor Stinner79766632010-08-16 17:36:42 +00003245 va_end(va);
3246}
3247
3248void
3249PySys_FormatStderr(const char *format, ...)
3250{
3251 va_list va;
3252
3253 va_start(va, format);
Victor Stinnerbd303c12013-11-07 23:07:29 +01003254 sys_format(&PyId_stderr, stderr, format, va);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003255 va_end(va);
Guido van Rossuma890e681998-05-12 14:59:24 +00003256}