blob: 15637c6a1f31d14952d3deb6804f143ef9d8170a [file] [log] [blame]
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001/* Module definition and import implementation */
2
Guido van Rossum79f25d91997-04-29 20:08:16 +00003#include "Python.h"
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00004
Jeremy Hylton3e0055f2005-10-20 19:59:25 +00005#include "Python-ast.h"
Victor Stinner3bb183d2018-11-22 18:38:38 +01006#undef Yield /* undefine macro conflicting with <winbase.h> */
Victor Stinner621cebe2018-11-12 16:53:38 +01007#include "pycore_pyhash.h"
8#include "pycore_pylifecycle.h"
9#include "pycore_pymem.h"
10#include "pycore_pystate.h"
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000011#include "errcode.h"
Guido van Rossumc405b7b1991-06-04 19:39:42 +000012#include "marshal.h"
Jeremy Hylton3e0055f2005-10-20 19:59:25 +000013#include "code.h"
Antoine Pitroubc07a5c2012-07-08 12:01:27 +020014#include "frameobject.h"
Guido van Rossumd8bac6d1992-02-26 15:19:13 +000015#include "osdefs.h"
Guido van Rossum1ae940a1995-01-02 19:04:15 +000016#include "importdl.h"
Christian Heimes3d2b4072017-09-30 00:53:19 +020017#include "pydtrace.h"
Guido van Rossumc405b7b1991-06-04 19:39:42 +000018
Guido van Rossum55a83382000-09-20 20:31:38 +000019#ifdef HAVE_FCNTL_H
20#include <fcntl.h>
21#endif
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000022#ifdef __cplusplus
Brett Cannon9a5b25a2010-03-01 02:09:17 +000023extern "C" {
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000024#endif
Guido van Rossum55a83382000-09-20 20:31:38 +000025
Barry Warsaw28a691b2010-04-17 00:19:56 +000026#define CACHEDIR "__pycache__"
Guido van Rossum96774c12000-05-01 20:19:08 +000027
Victor Stinner95872862011-03-07 18:20:56 +010028/* See _PyImport_FixupExtensionObject() below */
Guido van Rossum25ce5661997-08-02 03:10:38 +000029static PyObject *extensions = NULL;
Guido van Rossum3f5da241990-12-20 15:06:42 +000030
Guido van Rossum771c6c81997-10-31 18:37:24 +000031/* This table is defined in config.c: */
32extern struct _inittab _PyImport_Inittab[];
33
34struct _inittab *PyImport_Inittab = _PyImport_Inittab;
Victor Stinner92a3c6f2017-12-06 18:12:59 +010035static struct _inittab *inittab_copy = NULL;
Guido van Rossum66f1fa81991-04-03 19:03:52 +000036
Brett Cannon4caa61d2014-01-09 19:03:32 -050037/*[clinic input]
38module _imp
39[clinic start generated code]*/
Serhiy Storchaka1009bf12015-04-03 23:53:51 +030040/*[clinic end generated code: output=da39a3ee5e6b4b0d input=9c332475d8686284]*/
Brett Cannonfd4d0502014-05-30 11:21:14 -040041
42#include "clinic/import.c.h"
Brett Cannon4caa61d2014-01-09 19:03:32 -050043
Guido van Rossum1ae940a1995-01-02 19:04:15 +000044/* Initialize things */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000045
Victor Stinnerf7e5b562017-11-15 15:48:08 -080046_PyInitError
Victor Stinner672b6ba2017-12-06 17:25:50 +010047_PyImport_Init(PyInterpreterState *interp)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000048{
Serhiy Storchaka013bb912014-02-10 18:21:34 +020049 interp->builtins_copy = PyDict_Copy(interp->builtins);
Victor Stinnerf7e5b562017-11-15 15:48:08 -080050 if (interp->builtins_copy == NULL) {
51 return _Py_INIT_ERR("Can't backup builtins dict");
52 }
53 return _Py_INIT_OK();
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000054}
55
Victor Stinnerf7e5b562017-11-15 15:48:08 -080056_PyInitError
Just van Rossum52e14d62002-12-30 22:08:05 +000057_PyImportHooks_Init(void)
58{
Brett Cannonfd074152012-04-14 14:10:13 -040059 PyObject *v, *path_hooks = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000060 int err = 0;
Just van Rossum52e14d62002-12-30 22:08:05 +000061
Brett Cannonfd074152012-04-14 14:10:13 -040062 /* adding sys.path_hooks and sys.path_importer_cache */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000063 v = PyList_New(0);
64 if (v == NULL)
65 goto error;
66 err = PySys_SetObject("meta_path", v);
67 Py_DECREF(v);
68 if (err)
69 goto error;
70 v = PyDict_New();
71 if (v == NULL)
72 goto error;
73 err = PySys_SetObject("path_importer_cache", v);
74 Py_DECREF(v);
75 if (err)
76 goto error;
77 path_hooks = PyList_New(0);
78 if (path_hooks == NULL)
79 goto error;
80 err = PySys_SetObject("path_hooks", path_hooks);
81 if (err) {
Victor Stinnerf7e5b562017-11-15 15:48:08 -080082 goto error;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000083 }
Brett Cannonfd074152012-04-14 14:10:13 -040084 Py_DECREF(path_hooks);
Victor Stinnerf7e5b562017-11-15 15:48:08 -080085 return _Py_INIT_OK();
86
87 error:
88 PyErr_Print();
89 return _Py_INIT_ERR("initializing sys.meta_path, sys.path_hooks, "
90 "or path_importer_cache failed");
Brett Cannonfd074152012-04-14 14:10:13 -040091}
92
Victor Stinnerf7e5b562017-11-15 15:48:08 -080093_PyInitError
Brett Cannonfd074152012-04-14 14:10:13 -040094_PyImportZip_Init(void)
95{
ukwksk5e6312c2018-05-15 04:10:52 +090096 PyObject *path_hooks, *zipimport;
Brett Cannonfd074152012-04-14 14:10:13 -040097 int err = 0;
98
99 path_hooks = PySys_GetObject("path_hooks");
Victor Stinner1e53bba2013-07-16 22:26:05 +0200100 if (path_hooks == NULL) {
101 PyErr_SetString(PyExc_RuntimeError, "unable to get sys.path_hooks");
Brett Cannonfd074152012-04-14 14:10:13 -0400102 goto error;
Victor Stinner1e53bba2013-07-16 22:26:05 +0200103 }
Brett Cannonfd074152012-04-14 14:10:13 -0400104
105 if (Py_VerboseFlag)
106 PySys_WriteStderr("# installing zipimport hook\n");
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000107
ukwksk5e6312c2018-05-15 04:10:52 +0900108 zipimport = PyImport_ImportModule("zipimport");
109 if (zipimport == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000110 PyErr_Clear(); /* No zip import module -- okay */
111 if (Py_VerboseFlag)
112 PySys_WriteStderr("# can't import zipimport\n");
113 }
114 else {
Martin v. Löwisbd928fe2011-10-14 10:20:37 +0200115 _Py_IDENTIFIER(zipimporter);
ukwksk5e6312c2018-05-15 04:10:52 +0900116 PyObject *zipimporter = _PyObject_GetAttrId(zipimport,
Martin v. Löwis1ee1b6f2011-10-10 18:11:30 +0200117 &PyId_zipimporter);
ukwksk5e6312c2018-05-15 04:10:52 +0900118 Py_DECREF(zipimport);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000119 if (zipimporter == NULL) {
120 PyErr_Clear(); /* No zipimporter object -- okay */
121 if (Py_VerboseFlag)
122 PySys_WriteStderr(
123 "# can't import zipimport.zipimporter\n");
124 }
125 else {
Brett Cannon8923a4d2012-04-24 22:03:46 -0400126 /* sys.path_hooks.insert(0, zipimporter) */
127 err = PyList_Insert(path_hooks, 0, zipimporter);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000128 Py_DECREF(zipimporter);
Brett Cannonfd074152012-04-14 14:10:13 -0400129 if (err < 0) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000130 goto error;
Brett Cannonfd074152012-04-14 14:10:13 -0400131 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000132 if (Py_VerboseFlag)
133 PySys_WriteStderr(
134 "# installed zipimport hook\n");
135 }
136 }
Brett Cannonfd074152012-04-14 14:10:13 -0400137
Victor Stinnerf7e5b562017-11-15 15:48:08 -0800138 return _Py_INIT_OK();
Brett Cannonfd074152012-04-14 14:10:13 -0400139
140 error:
141 PyErr_Print();
Victor Stinnerf7e5b562017-11-15 15:48:08 -0800142 return _Py_INIT_ERR("initializing zipimport failed");
Just van Rossum52e14d62002-12-30 22:08:05 +0000143}
144
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000145/* Locking primitives to prevent parallel imports of the same module
146 in different threads to return with a partially loaded module.
147 These calls are serialized by the global interpreter lock. */
148
Guido van Rossum49b56061998-10-01 20:42:43 +0000149#include "pythread.h"
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000150
Guido van Rossum65d5b571998-12-21 19:32:43 +0000151static PyThread_type_lock import_lock = 0;
Serhiy Storchakaaefa7eb2017-03-23 15:48:39 +0200152static unsigned long import_lock_thread = PYTHREAD_INVALID_THREAD_ID;
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000153static int import_lock_level = 0;
154
Benjamin Peterson0df35a92009-10-04 20:32:25 +0000155void
156_PyImport_AcquireLock(void)
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000157{
Serhiy Storchakaaefa7eb2017-03-23 15:48:39 +0200158 unsigned long me = PyThread_get_thread_ident();
159 if (me == PYTHREAD_INVALID_THREAD_ID)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000160 return; /* Too bad */
161 if (import_lock == NULL) {
162 import_lock = PyThread_allocate_lock();
163 if (import_lock == NULL)
164 return; /* Nothing much we can do. */
165 }
166 if (import_lock_thread == me) {
167 import_lock_level++;
168 return;
169 }
Serhiy Storchakaaefa7eb2017-03-23 15:48:39 +0200170 if (import_lock_thread != PYTHREAD_INVALID_THREAD_ID ||
171 !PyThread_acquire_lock(import_lock, 0))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000172 {
173 PyThreadState *tstate = PyEval_SaveThread();
174 PyThread_acquire_lock(import_lock, 1);
175 PyEval_RestoreThread(tstate);
176 }
Antoine Pitrou202b6062012-12-18 22:18:17 +0100177 assert(import_lock_level == 0);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000178 import_lock_thread = me;
179 import_lock_level = 1;
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000180}
181
Benjamin Peterson0df35a92009-10-04 20:32:25 +0000182int
183_PyImport_ReleaseLock(void)
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000184{
Serhiy Storchakaaefa7eb2017-03-23 15:48:39 +0200185 unsigned long me = PyThread_get_thread_ident();
186 if (me == PYTHREAD_INVALID_THREAD_ID || import_lock == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000187 return 0; /* Too bad */
188 if (import_lock_thread != me)
189 return -1;
190 import_lock_level--;
Antoine Pitrou202b6062012-12-18 22:18:17 +0100191 assert(import_lock_level >= 0);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000192 if (import_lock_level == 0) {
Serhiy Storchakaaefa7eb2017-03-23 15:48:39 +0200193 import_lock_thread = PYTHREAD_INVALID_THREAD_ID;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000194 PyThread_release_lock(import_lock);
195 }
196 return 1;
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000197}
198
Antoine Pitrouf7ecfac2017-05-28 11:35:14 +0200199/* This function is called from PyOS_AfterFork_Child to ensure that newly
Gregory P. Smith24cec9f2010-03-01 06:18:41 +0000200 created child processes do not share locks with the parent.
201 We now acquire the import lock around fork() calls but on some platforms
202 (Solaris 9 and earlier? see isue7242) that still left us with problems. */
Guido van Rossum8ee3e5a2005-09-14 18:09:42 +0000203
204void
205_PyImport_ReInitLock(void)
206{
Christian Heimes418fd742015-04-19 21:08:42 +0200207 if (import_lock != NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000208 import_lock = PyThread_allocate_lock();
Christian Heimes418fd742015-04-19 21:08:42 +0200209 if (import_lock == NULL) {
210 Py_FatalError("PyImport_ReInitLock failed to create a new lock");
211 }
212 }
Nick Coghlanb2ddf792010-12-02 04:11:46 +0000213 if (import_lock_level > 1) {
214 /* Forked as a side effect of import */
Serhiy Storchakaaefa7eb2017-03-23 15:48:39 +0200215 unsigned long me = PyThread_get_thread_ident();
Brett Cannone4710cf2012-11-15 21:39:36 -0500216 /* The following could fail if the lock is already held, but forking as
217 a side-effect of an import is a) rare, b) nuts, and c) difficult to
218 do thanks to the lock only being held when doing individual module
219 locks per import. */
220 PyThread_acquire_lock(import_lock, NOWAIT_LOCK);
Nick Coghlanb2ddf792010-12-02 04:11:46 +0000221 import_lock_thread = me;
222 import_lock_level--;
223 } else {
Serhiy Storchakaaefa7eb2017-03-23 15:48:39 +0200224 import_lock_thread = PYTHREAD_INVALID_THREAD_ID;
Nick Coghlanb2ddf792010-12-02 04:11:46 +0000225 import_lock_level = 0;
226 }
Guido van Rossum8ee3e5a2005-09-14 18:09:42 +0000227}
228
Brett Cannon4caa61d2014-01-09 19:03:32 -0500229/*[clinic input]
230_imp.lock_held
231
232Return True if the import lock is currently held, else False.
233
234On platforms without threads, return False.
235[clinic start generated code]*/
236
Brett Cannon4caa61d2014-01-09 19:03:32 -0500237static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +0300238_imp_lock_held_impl(PyObject *module)
239/*[clinic end generated code: output=8b89384b5e1963fc input=9b088f9b217d9bdf]*/
Tim Peters69232342001-08-30 05:16:13 +0000240{
Serhiy Storchakaaefa7eb2017-03-23 15:48:39 +0200241 return PyBool_FromLong(import_lock_thread != PYTHREAD_INVALID_THREAD_ID);
Tim Peters69232342001-08-30 05:16:13 +0000242}
243
Brett Cannon4caa61d2014-01-09 19:03:32 -0500244/*[clinic input]
245_imp.acquire_lock
246
247Acquires the interpreter's import lock for the current thread.
248
249This lock should be used by import hooks to ensure thread-safety when importing
250modules. On platforms without threads, this function does nothing.
251[clinic start generated code]*/
252
Brett Cannon4caa61d2014-01-09 19:03:32 -0500253static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +0300254_imp_acquire_lock_impl(PyObject *module)
255/*[clinic end generated code: output=1aff58cb0ee1b026 input=4a2d4381866d5fdc]*/
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000256{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000257 _PyImport_AcquireLock();
Serhiy Storchaka228b12e2017-01-23 09:47:21 +0200258 Py_RETURN_NONE;
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000259}
260
Brett Cannon4caa61d2014-01-09 19:03:32 -0500261/*[clinic input]
262_imp.release_lock
263
264Release the interpreter's import lock.
265
266On platforms without threads, this function does nothing.
267[clinic start generated code]*/
268
Brett Cannon4caa61d2014-01-09 19:03:32 -0500269static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +0300270_imp_release_lock_impl(PyObject *module)
271/*[clinic end generated code: output=7faab6d0be178b0a input=934fb11516dd778b]*/
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000272{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000273 if (_PyImport_ReleaseLock() < 0) {
274 PyErr_SetString(PyExc_RuntimeError,
275 "not holding the import lock");
276 return NULL;
277 }
Serhiy Storchaka228b12e2017-01-23 09:47:21 +0200278 Py_RETURN_NONE;
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000279}
280
Antoine Pitrou8db076c2011-10-30 19:13:55 +0100281void
282_PyImport_Fini(void)
283{
Serhiy Storchaka505ff752014-02-09 13:33:53 +0200284 Py_CLEAR(extensions);
Antoine Pitrou8db076c2011-10-30 19:13:55 +0100285 if (import_lock != NULL) {
286 PyThread_free_lock(import_lock);
287 import_lock = NULL;
288 }
Antoine Pitrou8db076c2011-10-30 19:13:55 +0100289}
290
Victor Stinner92a3c6f2017-12-06 18:12:59 +0100291void
292_PyImport_Fini2(void)
293{
294 /* Use the same memory allocator than PyImport_ExtendInittab(). */
295 PyMemAllocatorEx old_alloc;
296 _PyMem_SetDefaultAllocator(PYMEM_DOMAIN_RAW, &old_alloc);
297
298 /* Free memory allocated by PyImport_ExtendInittab() */
299 PyMem_RawFree(inittab_copy);
300
301 PyMem_SetAllocator(PYMEM_DOMAIN_RAW, &old_alloc);
302}
303
Guido van Rossum25ce5661997-08-02 03:10:38 +0000304/* Helper for sys */
305
306PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000307PyImport_GetModuleDict(void)
Guido van Rossum25ce5661997-08-02 03:10:38 +0000308{
Victor Stinnercaba55b2018-08-03 15:33:52 +0200309 PyInterpreterState *interp = _PyInterpreterState_GET_UNSAFE();
Eric Snow3f9eee62017-09-15 16:35:20 -0600310 if (interp->modules == NULL) {
Eric Snow93c92f72017-09-13 23:46:04 -0700311 Py_FatalError("PyImport_GetModuleDict: no module dictionary!");
Eric Snow3f9eee62017-09-15 16:35:20 -0600312 }
Eric Snow93c92f72017-09-13 23:46:04 -0700313 return interp->modules;
Guido van Rossum25ce5661997-08-02 03:10:38 +0000314}
315
Eric Snowd393c1b2017-09-14 12:18:12 -0600316/* In some corner cases it is important to be sure that the import
317 machinery has been initialized (or not cleaned up yet). For
318 example, see issue #4236 and PyModule_Create2(). */
319
320int
321_PyImport_IsInitialized(PyInterpreterState *interp)
322{
323 if (interp->modules == NULL)
324 return 0;
325 return 1;
326}
Guido van Rossum3f5da241990-12-20 15:06:42 +0000327
Eric Snow3f9eee62017-09-15 16:35:20 -0600328PyObject *
329_PyImport_GetModuleId(struct _Py_Identifier *nameid)
330{
331 PyObject *name = _PyUnicode_FromId(nameid); /* borrowed */
332 if (name == NULL) {
333 return NULL;
334 }
335 return PyImport_GetModule(name);
336}
337
338int
339_PyImport_SetModule(PyObject *name, PyObject *m)
340{
341 PyObject *modules = PyImport_GetModuleDict();
342 return PyObject_SetItem(modules, name, m);
343}
344
345int
346_PyImport_SetModuleString(const char *name, PyObject *m)
347{
348 PyObject *modules = PyImport_GetModuleDict();
349 return PyMapping_SetItemString(modules, name, m);
350}
351
352PyObject *
353PyImport_GetModule(PyObject *name)
354{
355 PyObject *m;
356 PyObject *modules = PyImport_GetModuleDict();
357 if (modules == NULL) {
358 PyErr_SetString(PyExc_RuntimeError, "unable to get sys.modules");
359 return NULL;
360 }
361 Py_INCREF(modules);
362 if (PyDict_CheckExact(modules)) {
363 m = PyDict_GetItemWithError(modules, name); /* borrowed */
364 Py_XINCREF(m);
365 }
366 else {
367 m = PyObject_GetItem(modules, name);
Serhiy Storchakae9d94942018-04-25 20:58:40 +0300368 if (m == NULL && PyErr_ExceptionMatches(PyExc_KeyError)) {
Eric Snow3f9eee62017-09-15 16:35:20 -0600369 PyErr_Clear();
370 }
371 }
372 Py_DECREF(modules);
373 return m;
374}
375
376
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000377/* List of names to clear in sys */
Serhiy Storchaka2d06e842015-12-25 19:53:18 +0200378static const char * const sys_deletes[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000379 "path", "argv", "ps1", "ps2",
380 "last_type", "last_value", "last_traceback",
381 "path_hooks", "path_importer_cache", "meta_path",
Antoine Pitroudcedaf62013-07-31 23:14:08 +0200382 "__interactivehook__",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000383 /* misc stuff */
384 "flags", "float_info",
385 NULL
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000386};
387
Serhiy Storchaka2d06e842015-12-25 19:53:18 +0200388static const char * const sys_files[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000389 "stdin", "__stdin__",
390 "stdout", "__stdout__",
391 "stderr", "__stderr__",
392 NULL
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000393};
394
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000395/* Un-initialize things, as good as we can */
Guido van Rossum3f5da241990-12-20 15:06:42 +0000396
Guido van Rossum3f5da241990-12-20 15:06:42 +0000397void
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000398PyImport_Cleanup(void)
Guido van Rossum3f5da241990-12-20 15:06:42 +0000399{
Antoine Pitroudcedaf62013-07-31 23:14:08 +0200400 Py_ssize_t pos;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000401 PyObject *key, *value, *dict;
Victor Stinnercaba55b2018-08-03 15:33:52 +0200402 PyInterpreterState *interp = _PyInterpreterState_Get();
Eric Snowd393c1b2017-09-14 12:18:12 -0600403 PyObject *modules = PyImport_GetModuleDict();
Antoine Pitroudcedaf62013-07-31 23:14:08 +0200404 PyObject *weaklist = NULL;
Serhiy Storchaka2d06e842015-12-25 19:53:18 +0200405 const char * const *p;
Guido van Rossum758eec01998-01-19 21:58:26 +0000406
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000407 if (modules == NULL)
408 return; /* Already done */
Guido van Rossum758eec01998-01-19 21:58:26 +0000409
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000410 /* Delete some special variables first. These are common
411 places where user values hide and people complain when their
412 destructors fail. Since the modules containing them are
413 deleted *last* of all, they would come too late in the normal
414 destruction order. Sigh. */
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000415
Antoine Pitroudcedaf62013-07-31 23:14:08 +0200416 /* XXX Perhaps these precautions are obsolete. Who knows? */
417
Serhiy Storchaka013bb912014-02-10 18:21:34 +0200418 if (Py_VerboseFlag)
419 PySys_WriteStderr("# clear builtins._\n");
Serhiy Storchakae9d94942018-04-25 20:58:40 +0300420 if (PyDict_SetItemString(interp->builtins, "_", Py_None) < 0) {
Serhiy Storchakac1a68322018-04-29 22:16:30 +0300421 PyErr_WriteUnraisable(NULL);
Serhiy Storchakae9d94942018-04-25 20:58:40 +0300422 }
Serhiy Storchaka013bb912014-02-10 18:21:34 +0200423
424 for (p = sys_deletes; *p != NULL; p++) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000425 if (Py_VerboseFlag)
Serhiy Storchaka013bb912014-02-10 18:21:34 +0200426 PySys_WriteStderr("# clear sys.%s\n", *p);
Serhiy Storchakae9d94942018-04-25 20:58:40 +0300427 if (PyDict_SetItemString(interp->sysdict, *p, Py_None) < 0) {
Serhiy Storchakac1a68322018-04-29 22:16:30 +0300428 PyErr_WriteUnraisable(NULL);
Serhiy Storchakae9d94942018-04-25 20:58:40 +0300429 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000430 }
Serhiy Storchaka013bb912014-02-10 18:21:34 +0200431 for (p = sys_files; *p != NULL; p+=2) {
432 if (Py_VerboseFlag)
433 PySys_WriteStderr("# restore sys.%s\n", *p);
434 value = PyDict_GetItemString(interp->sysdict, *(p+1));
435 if (value == NULL)
436 value = Py_None;
Serhiy Storchakae9d94942018-04-25 20:58:40 +0300437 if (PyDict_SetItemString(interp->sysdict, *p, value) < 0) {
Serhiy Storchakac1a68322018-04-29 22:16:30 +0300438 PyErr_WriteUnraisable(NULL);
Serhiy Storchakae9d94942018-04-25 20:58:40 +0300439 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000440 }
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000441
Antoine Pitroudcedaf62013-07-31 23:14:08 +0200442 /* We prepare a list which will receive (name, weakref) tuples of
443 modules when they are removed from sys.modules. The name is used
444 for diagnosis messages (in verbose mode), while the weakref helps
445 detect those modules which have been held alive. */
446 weaklist = PyList_New(0);
Serhiy Storchakac1a68322018-04-29 22:16:30 +0300447 if (weaklist == NULL) {
448 PyErr_WriteUnraisable(NULL);
449 }
Antoine Pitroudcedaf62013-07-31 23:14:08 +0200450
Antoine Pitrou79ba3882013-08-06 22:50:15 +0200451#define STORE_MODULE_WEAKREF(name, mod) \
Antoine Pitroudcedaf62013-07-31 23:14:08 +0200452 if (weaklist != NULL) { \
Antoine Pitroudcedaf62013-07-31 23:14:08 +0200453 PyObject *wr = PyWeakref_NewRef(mod, NULL); \
Serhiy Storchakae9d94942018-04-25 20:58:40 +0300454 if (wr) { \
Antoine Pitroudcedaf62013-07-31 23:14:08 +0200455 PyObject *tup = PyTuple_Pack(2, name, wr); \
Serhiy Storchakae9d94942018-04-25 20:58:40 +0300456 if (!tup || PyList_Append(weaklist, tup) < 0) { \
Serhiy Storchakac1a68322018-04-29 22:16:30 +0300457 PyErr_WriteUnraisable(NULL); \
Serhiy Storchakae9d94942018-04-25 20:58:40 +0300458 } \
Antoine Pitroudcedaf62013-07-31 23:14:08 +0200459 Py_XDECREF(tup); \
Serhiy Storchakae9d94942018-04-25 20:58:40 +0300460 Py_DECREF(wr); \
Antoine Pitroudcedaf62013-07-31 23:14:08 +0200461 } \
Serhiy Storchakae9d94942018-04-25 20:58:40 +0300462 else { \
Serhiy Storchakac1a68322018-04-29 22:16:30 +0300463 PyErr_WriteUnraisable(NULL); \
Serhiy Storchakae9d94942018-04-25 20:58:40 +0300464 } \
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000465 }
Eric Snow3f9eee62017-09-15 16:35:20 -0600466#define CLEAR_MODULE(name, mod) \
467 if (PyModule_Check(mod)) { \
468 if (Py_VerboseFlag && PyUnicode_Check(name)) \
469 PySys_FormatStderr("# cleanup[2] removing %U\n", name); \
470 STORE_MODULE_WEAKREF(name, mod); \
Serhiy Storchakae9d94942018-04-25 20:58:40 +0300471 if (PyObject_SetItem(modules, name, Py_None) < 0) { \
Serhiy Storchakac1a68322018-04-29 22:16:30 +0300472 PyErr_WriteUnraisable(NULL); \
Serhiy Storchakae9d94942018-04-25 20:58:40 +0300473 } \
Eric Snow3f9eee62017-09-15 16:35:20 -0600474 }
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000475
Antoine Pitroudcedaf62013-07-31 23:14:08 +0200476 /* Remove all modules from sys.modules, hoping that garbage collection
477 can reclaim most of them. */
Eric Snow3f9eee62017-09-15 16:35:20 -0600478 if (PyDict_CheckExact(modules)) {
479 pos = 0;
480 while (PyDict_Next(modules, &pos, &key, &value)) {
481 CLEAR_MODULE(key, value);
482 }
483 }
484 else {
485 PyObject *iterator = PyObject_GetIter(modules);
486 if (iterator == NULL) {
Serhiy Storchakac1a68322018-04-29 22:16:30 +0300487 PyErr_WriteUnraisable(NULL);
Eric Snow3f9eee62017-09-15 16:35:20 -0600488 }
489 else {
490 while ((key = PyIter_Next(iterator))) {
491 value = PyObject_GetItem(modules, key);
492 if (value == NULL) {
Serhiy Storchakac1a68322018-04-29 22:16:30 +0300493 PyErr_WriteUnraisable(NULL);
Eric Snow3f9eee62017-09-15 16:35:20 -0600494 continue;
495 }
496 CLEAR_MODULE(key, value);
497 Py_DECREF(value);
498 Py_DECREF(key);
499 }
Serhiy Storchakae9d94942018-04-25 20:58:40 +0300500 if (PyErr_Occurred()) {
Serhiy Storchakac1a68322018-04-29 22:16:30 +0300501 PyErr_WriteUnraisable(NULL);
Serhiy Storchakae9d94942018-04-25 20:58:40 +0300502 }
Eric Snow3f9eee62017-09-15 16:35:20 -0600503 Py_DECREF(iterator);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000504 }
505 }
Guido van Rossum758eec01998-01-19 21:58:26 +0000506
Antoine Pitroudcedaf62013-07-31 23:14:08 +0200507 /* Clear the modules dict. */
Eric Snow3f9eee62017-09-15 16:35:20 -0600508 if (PyDict_CheckExact(modules)) {
509 PyDict_Clear(modules);
510 }
511 else {
512 _Py_IDENTIFIER(clear);
Serhiy Storchakac1a68322018-04-29 22:16:30 +0300513 if (_PyObject_CallMethodId(modules, &PyId_clear, "") == NULL) {
514 PyErr_WriteUnraisable(NULL);
515 }
Eric Snow3f9eee62017-09-15 16:35:20 -0600516 }
Serhiy Storchaka013bb912014-02-10 18:21:34 +0200517 /* Restore the original builtins dict, to ensure that any
518 user data gets cleared. */
519 dict = PyDict_Copy(interp->builtins);
Serhiy Storchakac1a68322018-04-29 22:16:30 +0300520 if (dict == NULL) {
521 PyErr_WriteUnraisable(NULL);
522 }
Serhiy Storchaka013bb912014-02-10 18:21:34 +0200523 PyDict_Clear(interp->builtins);
Serhiy Storchakac1a68322018-04-29 22:16:30 +0300524 if (PyDict_Update(interp->builtins, interp->builtins_copy)) {
Serhiy Storchaka013bb912014-02-10 18:21:34 +0200525 PyErr_Clear();
Serhiy Storchakac1a68322018-04-29 22:16:30 +0300526 }
Serhiy Storchaka013bb912014-02-10 18:21:34 +0200527 Py_XDECREF(dict);
Antoine Pitrou40322e62013-08-11 00:30:09 +0200528 /* Clear module dict copies stored in the interpreter state */
529 _PyState_ClearModules();
Antoine Pitroudcedaf62013-07-31 23:14:08 +0200530 /* Collect references */
531 _PyGC_CollectNoFail();
Antoine Pitrou5f454a02013-05-06 21:15:57 +0200532 /* Dump GC stats before it's too late, since it uses the warnings
533 machinery. */
534 _PyGC_DumpShutdownStats();
535
Antoine Pitroudcedaf62013-07-31 23:14:08 +0200536 /* Now, if there are any modules left alive, clear their globals to
537 minimize potential leaks. All C extension modules actually end
Serhiy Storchaka013bb912014-02-10 18:21:34 +0200538 up here, since they are kept alive in the interpreter state.
539
540 The special treatment of "builtins" here is because even
541 when it's not referenced as a module, its dictionary is
542 referenced by almost every module's __builtins__. Since
543 deleting a module clears its dictionary (even if there are
544 references left to it), we need to delete the "builtins"
545 module last. Likewise, we don't delete sys until the very
546 end because it is implicitly referenced (e.g. by print). */
Antoine Pitroudcedaf62013-07-31 23:14:08 +0200547 if (weaklist != NULL) {
Serhiy Storchakac93c58b2018-10-29 19:30:16 +0200548 Py_ssize_t i;
549 /* Since dict is ordered in CPython 3.6+, modules are saved in
550 importing order. First clear modules imported later. */
551 for (i = PyList_GET_SIZE(weaklist) - 1; i >= 0; i--) {
Antoine Pitroudcedaf62013-07-31 23:14:08 +0200552 PyObject *tup = PyList_GET_ITEM(weaklist, i);
Antoine Pitrou79ba3882013-08-06 22:50:15 +0200553 PyObject *name = PyTuple_GET_ITEM(tup, 0);
Antoine Pitroudcedaf62013-07-31 23:14:08 +0200554 PyObject *mod = PyWeakref_GET_OBJECT(PyTuple_GET_ITEM(tup, 1));
555 if (mod == Py_None)
556 continue;
Antoine Pitroudcedaf62013-07-31 23:14:08 +0200557 assert(PyModule_Check(mod));
Serhiy Storchaka013bb912014-02-10 18:21:34 +0200558 dict = PyModule_GetDict(mod);
559 if (dict == interp->builtins || dict == interp->sysdict)
560 continue;
561 Py_INCREF(mod);
Antoine Pitrou79ba3882013-08-06 22:50:15 +0200562 if (Py_VerboseFlag && PyUnicode_Check(name))
Serhiy Storchaka013bb912014-02-10 18:21:34 +0200563 PySys_FormatStderr("# cleanup[3] wiping %U\n", name);
Antoine Pitroudcedaf62013-07-31 23:14:08 +0200564 _PyModule_Clear(mod);
565 Py_DECREF(mod);
Antoine Pitrou070cb3c2013-05-08 13:23:25 +0200566 }
Antoine Pitroudcedaf62013-07-31 23:14:08 +0200567 Py_DECREF(weaklist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000568 }
Guido van Rossum758eec01998-01-19 21:58:26 +0000569
Serhiy Storchaka013bb912014-02-10 18:21:34 +0200570 /* Next, delete sys and builtins (in that order) */
571 if (Py_VerboseFlag)
572 PySys_FormatStderr("# cleanup[3] wiping sys\n");
573 _PyModule_ClearDict(interp->sysdict);
574 if (Py_VerboseFlag)
575 PySys_FormatStderr("# cleanup[3] wiping builtins\n");
576 _PyModule_ClearDict(interp->builtins);
577
Antoine Pitroudcedaf62013-07-31 23:14:08 +0200578 /* Clear and delete the modules directory. Actual modules will
579 still be there only if imported during the execution of some
580 destructor. */
Eric Snow93c92f72017-09-13 23:46:04 -0700581 interp->modules = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000582 Py_DECREF(modules);
Antoine Pitroudcedaf62013-07-31 23:14:08 +0200583
584 /* Once more */
585 _PyGC_CollectNoFail();
586
Serhiy Storchakae9d94942018-04-25 20:58:40 +0300587#undef CLEAR_MODULE
Antoine Pitroudcedaf62013-07-31 23:14:08 +0200588#undef STORE_MODULE_WEAKREF
Guido van Rossum8d15b5d1990-10-26 14:58:58 +0000589}
Guido van Rossum7f133ed1991-02-19 12:23:57 +0000590
591
Barry Warsaw28a691b2010-04-17 00:19:56 +0000592/* Helper for pythonrun.c -- return magic number and tag. */
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000593
594long
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000595PyImport_GetMagicNumber(void)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000596{
Antoine Pitrou44b4b6a2012-07-10 18:27:54 +0200597 long res;
Victor Stinnercaba55b2018-08-03 15:33:52 +0200598 PyInterpreterState *interp = _PyInterpreterState_Get();
Eric Snow32439d62015-05-02 19:15:18 -0600599 PyObject *external, *pyc_magic;
600
601 external = PyObject_GetAttrString(interp->importlib, "_bootstrap_external");
602 if (external == NULL)
603 return -1;
604 pyc_magic = PyObject_GetAttrString(external, "_RAW_MAGIC_NUMBER");
605 Py_DECREF(external);
Brett Cannon77b2abd2012-07-09 16:09:00 -0400606 if (pyc_magic == NULL)
607 return -1;
Antoine Pitrou44b4b6a2012-07-10 18:27:54 +0200608 res = PyLong_AsLong(pyc_magic);
Benjamin Peterson66f36592012-07-09 22:21:55 -0700609 Py_DECREF(pyc_magic);
610 return res;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000611}
612
613
Brett Cannon3adc7b72012-07-09 14:22:12 -0400614extern const char * _PySys_ImplCacheTag;
615
Barry Warsaw28a691b2010-04-17 00:19:56 +0000616const char *
617PyImport_GetMagicTag(void)
618{
Brett Cannon3adc7b72012-07-09 14:22:12 -0400619 return _PySys_ImplCacheTag;
Barry Warsaw28a691b2010-04-17 00:19:56 +0000620}
621
Brett Cannon98979b82012-07-02 15:13:11 -0400622
Guido van Rossum25ce5661997-08-02 03:10:38 +0000623/* Magic for extension modules (built-in as well as dynamically
624 loaded). To prevent initializing an extension module more than
Andrew Svetlov6b2cbeb2012-12-14 17:04:59 +0200625 once, we keep a static dictionary 'extensions' keyed by the tuple
626 (module name, module name) (for built-in modules) or by
627 (filename, module name) (for dynamically loaded modules), containing these
628 modules. A copy of the module's dictionary is stored by calling
629 _PyImport_FixupExtensionObject() immediately after the module initialization
630 function succeeds. A copy can be retrieved from there by calling
Victor Stinner95872862011-03-07 18:20:56 +0100631 _PyImport_FindExtensionObject().
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000632
Barry Warsaw7c9627b2010-06-17 18:38:20 +0000633 Modules which do support multiple initialization set their m_size
634 field to a non-negative number (indicating the size of the
635 module-specific state). They are still recorded in the extensions
636 dictionary, to avoid loading shared libraries twice.
Martin v. Löwis1a214512008-06-11 05:26:20 +0000637*/
638
639int
Victor Stinner95872862011-03-07 18:20:56 +0100640_PyImport_FixupExtensionObject(PyObject *mod, PyObject *name,
Eric Snowd393c1b2017-09-14 12:18:12 -0600641 PyObject *filename, PyObject *modules)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000642{
Eric Snowd393c1b2017-09-14 12:18:12 -0600643 PyObject *dict, *key;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000644 struct PyModuleDef *def;
Benjamin Peterson5cb8a312012-12-15 00:05:16 -0500645 int res;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000646 if (extensions == NULL) {
647 extensions = PyDict_New();
648 if (extensions == NULL)
649 return -1;
650 }
651 if (mod == NULL || !PyModule_Check(mod)) {
652 PyErr_BadInternalCall();
653 return -1;
654 }
655 def = PyModule_GetDef(mod);
656 if (!def) {
657 PyErr_BadInternalCall();
658 return -1;
659 }
Eric Snow3f9eee62017-09-15 16:35:20 -0600660 if (PyObject_SetItem(modules, name, mod) < 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000661 return -1;
662 if (_PyState_AddModule(mod, def) < 0) {
Eric Snow3f9eee62017-09-15 16:35:20 -0600663 PyMapping_DelItem(modules, name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000664 return -1;
665 }
666 if (def->m_size == -1) {
667 if (def->m_base.m_copy) {
668 /* Somebody already imported the module,
669 likely under a different name.
670 XXX this should really not happen. */
Serhiy Storchaka505ff752014-02-09 13:33:53 +0200671 Py_CLEAR(def->m_base.m_copy);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000672 }
673 dict = PyModule_GetDict(mod);
674 if (dict == NULL)
675 return -1;
676 def->m_base.m_copy = PyDict_Copy(dict);
677 if (def->m_base.m_copy == NULL)
678 return -1;
679 }
Benjamin Peterson5cb8a312012-12-15 00:05:16 -0500680 key = PyTuple_Pack(2, filename, name);
681 if (key == NULL)
Andrew Svetlov6b2cbeb2012-12-14 17:04:59 +0200682 return -1;
Benjamin Peterson5cb8a312012-12-15 00:05:16 -0500683 res = PyDict_SetItem(extensions, key, (PyObject *)def);
684 Py_DECREF(key);
685 if (res < 0)
Andrew Svetlov6b2cbeb2012-12-14 17:04:59 +0200686 return -1;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000687 return 0;
Guido van Rossum25ce5661997-08-02 03:10:38 +0000688}
689
Victor Stinner49d3f252010-10-17 01:24:53 +0000690int
Eric Snowd393c1b2017-09-14 12:18:12 -0600691_PyImport_FixupBuiltin(PyObject *mod, const char *name, PyObject *modules)
Victor Stinner49d3f252010-10-17 01:24:53 +0000692{
693 int res;
Victor Stinner95872862011-03-07 18:20:56 +0100694 PyObject *nameobj;
Victor Stinner21fcd0c2011-03-07 18:28:15 +0100695 nameobj = PyUnicode_InternFromString(name);
Victor Stinner95872862011-03-07 18:20:56 +0100696 if (nameobj == NULL)
Victor Stinner49d3f252010-10-17 01:24:53 +0000697 return -1;
Eric Snowd393c1b2017-09-14 12:18:12 -0600698 res = _PyImport_FixupExtensionObject(mod, nameobj, nameobj, modules);
Victor Stinner95872862011-03-07 18:20:56 +0100699 Py_DECREF(nameobj);
Victor Stinner49d3f252010-10-17 01:24:53 +0000700 return res;
701}
702
Guido van Rossum25ce5661997-08-02 03:10:38 +0000703PyObject *
Victor Stinner95872862011-03-07 18:20:56 +0100704_PyImport_FindExtensionObject(PyObject *name, PyObject *filename)
Guido van Rossum25ce5661997-08-02 03:10:38 +0000705{
Eric Snowd393c1b2017-09-14 12:18:12 -0600706 PyObject *modules = PyImport_GetModuleDict();
707 return _PyImport_FindExtensionObjectEx(name, filename, modules);
708}
709
710PyObject *
711_PyImport_FindExtensionObjectEx(PyObject *name, PyObject *filename,
712 PyObject *modules)
713{
Benjamin Peterson5cb8a312012-12-15 00:05:16 -0500714 PyObject *mod, *mdict, *key;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000715 PyModuleDef* def;
716 if (extensions == NULL)
717 return NULL;
Benjamin Peterson5cb8a312012-12-15 00:05:16 -0500718 key = PyTuple_Pack(2, filename, name);
719 if (key == NULL)
Andrew Svetlov6b2cbeb2012-12-14 17:04:59 +0200720 return NULL;
Benjamin Peterson5cb8a312012-12-15 00:05:16 -0500721 def = (PyModuleDef *)PyDict_GetItem(extensions, key);
722 Py_DECREF(key);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000723 if (def == NULL)
724 return NULL;
725 if (def->m_size == -1) {
726 /* Module does not support repeated initialization */
727 if (def->m_base.m_copy == NULL)
728 return NULL;
Eric Snowd393c1b2017-09-14 12:18:12 -0600729 mod = _PyImport_AddModuleObject(name, modules);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000730 if (mod == NULL)
731 return NULL;
732 mdict = PyModule_GetDict(mod);
733 if (mdict == NULL)
734 return NULL;
735 if (PyDict_Update(mdict, def->m_base.m_copy))
736 return NULL;
737 }
738 else {
739 if (def->m_base.m_init == NULL)
740 return NULL;
741 mod = def->m_base.m_init();
742 if (mod == NULL)
743 return NULL;
Eric Snow3f9eee62017-09-15 16:35:20 -0600744 if (PyObject_SetItem(modules, name, mod) == -1) {
Christian Heimes09ca7942013-07-20 14:51:53 +0200745 Py_DECREF(mod);
746 return NULL;
747 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000748 Py_DECREF(mod);
749 }
750 if (_PyState_AddModule(mod, def) < 0) {
Eric Snow3f9eee62017-09-15 16:35:20 -0600751 PyMapping_DelItem(modules, name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000752 Py_DECREF(mod);
753 return NULL;
754 }
755 if (Py_VerboseFlag)
Victor Stinner95872862011-03-07 18:20:56 +0100756 PySys_FormatStderr("import %U # previously loaded (%R)\n",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000757 name, filename);
758 return mod;
Brett Cannon9a5b25a2010-03-01 02:09:17 +0000759
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000760}
761
Victor Stinner49d3f252010-10-17 01:24:53 +0000762PyObject *
Eric Snowd393c1b2017-09-14 12:18:12 -0600763_PyImport_FindBuiltin(const char *name, PyObject *modules)
Victor Stinner49d3f252010-10-17 01:24:53 +0000764{
Victor Stinner95872862011-03-07 18:20:56 +0100765 PyObject *res, *nameobj;
Victor Stinner21fcd0c2011-03-07 18:28:15 +0100766 nameobj = PyUnicode_InternFromString(name);
Victor Stinner95872862011-03-07 18:20:56 +0100767 if (nameobj == NULL)
Victor Stinner49d3f252010-10-17 01:24:53 +0000768 return NULL;
Eric Snowd393c1b2017-09-14 12:18:12 -0600769 res = _PyImport_FindExtensionObjectEx(nameobj, nameobj, modules);
Victor Stinner95872862011-03-07 18:20:56 +0100770 Py_DECREF(nameobj);
Victor Stinner49d3f252010-10-17 01:24:53 +0000771 return res;
772}
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000773
774/* Get the module object corresponding to a module name.
775 First check the modules dictionary if there's one there,
Walter Dörwaldf0dfc7a2003-10-20 14:01:56 +0000776 if not, create a new one and insert it in the modules dictionary.
Guido van Rossum7f9fa971995-01-20 16:53:12 +0000777 Because the former action is most common, THIS DOES NOT RETURN A
778 'NEW' REFERENCE! */
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000779
Guido van Rossum79f25d91997-04-29 20:08:16 +0000780PyObject *
Victor Stinner27ee0892011-03-04 12:57:09 +0000781PyImport_AddModuleObject(PyObject *name)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000782{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000783 PyObject *modules = PyImport_GetModuleDict();
Eric Snowd393c1b2017-09-14 12:18:12 -0600784 return _PyImport_AddModuleObject(name, modules);
785}
786
787PyObject *
788_PyImport_AddModuleObject(PyObject *name, PyObject *modules)
789{
Eric Snow86b7afd2017-09-04 17:54:09 -0600790 PyObject *m;
Eric Snow3f9eee62017-09-15 16:35:20 -0600791 if (PyDict_CheckExact(modules)) {
792 m = PyDict_GetItemWithError(modules, name);
793 }
794 else {
795 m = PyObject_GetItem(modules, name);
796 // For backward-comaptibility we copy the behavior
797 // of PyDict_GetItemWithError().
798 if (PyErr_ExceptionMatches(PyExc_KeyError)) {
799 PyErr_Clear();
800 }
Serhiy Storchaka48a583b2016-02-10 10:31:20 +0200801 }
802 if (PyErr_Occurred()) {
803 return NULL;
804 }
Eric Snow3f9eee62017-09-15 16:35:20 -0600805 if (m != NULL && PyModule_Check(m)) {
806 return m;
807 }
Victor Stinner27ee0892011-03-04 12:57:09 +0000808 m = PyModule_NewObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000809 if (m == NULL)
810 return NULL;
Eric Snow3f9eee62017-09-15 16:35:20 -0600811 if (PyObject_SetItem(modules, name, m) != 0) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000812 Py_DECREF(m);
813 return NULL;
814 }
815 Py_DECREF(m); /* Yes, it still exists, in modules! */
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000816
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000817 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000818}
819
Victor Stinner27ee0892011-03-04 12:57:09 +0000820PyObject *
821PyImport_AddModule(const char *name)
822{
823 PyObject *nameobj, *module;
824 nameobj = PyUnicode_FromString(name);
825 if (nameobj == NULL)
826 return NULL;
827 module = PyImport_AddModuleObject(nameobj);
828 Py_DECREF(nameobj);
829 return module;
830}
831
832
Tim Peters1cd70172004-08-02 03:52:12 +0000833/* Remove name from sys.modules, if it's there. */
834static void
Victor Stinner27ee0892011-03-04 12:57:09 +0000835remove_module(PyObject *name)
Tim Peters1cd70172004-08-02 03:52:12 +0000836{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000837 PyObject *modules = PyImport_GetModuleDict();
Eric Snow3f9eee62017-09-15 16:35:20 -0600838 if (PyMapping_DelItem(modules, name) < 0) {
839 if (!PyMapping_HasKey(modules, name)) {
840 return;
841 }
Serhiy Storchaka34fd4c22018-11-05 16:20:25 +0200842 Py_FatalError("import: deleting existing key in "
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000843 "sys.modules failed");
Eric Snow3f9eee62017-09-15 16:35:20 -0600844 }
Tim Peters1cd70172004-08-02 03:52:12 +0000845}
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000846
Christian Heimes3b06e532008-01-07 20:12:44 +0000847
Guido van Rossum7f9fa971995-01-20 16:53:12 +0000848/* Execute a code object in a module and return the module object
Tim Peters1cd70172004-08-02 03:52:12 +0000849 * WITH INCREMENTED REFERENCE COUNT. If an error occurs, name is
850 * removed from sys.modules, to avoid leaving damaged module objects
851 * in sys.modules. The caller may wish to restore the original
852 * module object (if any) in this case; PyImport_ReloadModule is an
853 * example.
Barry Warsaw28a691b2010-04-17 00:19:56 +0000854 *
855 * Note that PyImport_ExecCodeModuleWithPathnames() is the preferred, richer
856 * interface. The other two exist primarily for backward compatibility.
Tim Peters1cd70172004-08-02 03:52:12 +0000857 */
Guido van Rossum79f25d91997-04-29 20:08:16 +0000858PyObject *
Serhiy Storchakac6792272013-10-19 21:03:34 +0300859PyImport_ExecCodeModule(const char *name, PyObject *co)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000860{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000861 return PyImport_ExecCodeModuleWithPathnames(
862 name, co, (char *)NULL, (char *)NULL);
Guido van Rossume32bf6e1998-02-11 05:53:02 +0000863}
864
865PyObject *
Serhiy Storchakac6792272013-10-19 21:03:34 +0300866PyImport_ExecCodeModuleEx(const char *name, PyObject *co, const char *pathname)
Guido van Rossume32bf6e1998-02-11 05:53:02 +0000867{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000868 return PyImport_ExecCodeModuleWithPathnames(
869 name, co, pathname, (char *)NULL);
Barry Warsaw28a691b2010-04-17 00:19:56 +0000870}
871
872PyObject *
Serhiy Storchakac6792272013-10-19 21:03:34 +0300873PyImport_ExecCodeModuleWithPathnames(const char *name, PyObject *co,
874 const char *pathname,
875 const char *cpathname)
Barry Warsaw28a691b2010-04-17 00:19:56 +0000876{
Victor Stinner27ee0892011-03-04 12:57:09 +0000877 PyObject *m = NULL;
Eric Snow32439d62015-05-02 19:15:18 -0600878 PyObject *nameobj, *pathobj = NULL, *cpathobj = NULL, *external= NULL;
Victor Stinner27ee0892011-03-04 12:57:09 +0000879
880 nameobj = PyUnicode_FromString(name);
881 if (nameobj == NULL)
882 return NULL;
883
Victor Stinner27ee0892011-03-04 12:57:09 +0000884 if (cpathname != NULL) {
885 cpathobj = PyUnicode_DecodeFSDefault(cpathname);
886 if (cpathobj == NULL)
887 goto error;
Brett Cannona6473f92012-07-13 13:57:03 -0400888 }
889 else
Victor Stinner27ee0892011-03-04 12:57:09 +0000890 cpathobj = NULL;
Brett Cannona6473f92012-07-13 13:57:03 -0400891
892 if (pathname != NULL) {
893 pathobj = PyUnicode_DecodeFSDefault(pathname);
894 if (pathobj == NULL)
895 goto error;
896 }
897 else if (cpathobj != NULL) {
Victor Stinnercaba55b2018-08-03 15:33:52 +0200898 PyInterpreterState *interp = _PyInterpreterState_GET_UNSAFE();
Brett Cannona6473f92012-07-13 13:57:03 -0400899 _Py_IDENTIFIER(_get_sourcefile);
900
901 if (interp == NULL) {
902 Py_FatalError("PyImport_ExecCodeModuleWithPathnames: "
903 "no interpreter!");
904 }
905
Eric Snow32439d62015-05-02 19:15:18 -0600906 external= PyObject_GetAttrString(interp->importlib,
907 "_bootstrap_external");
908 if (external != NULL) {
909 pathobj = _PyObject_CallMethodIdObjArgs(external,
910 &PyId__get_sourcefile, cpathobj,
911 NULL);
912 Py_DECREF(external);
913 }
Brett Cannona6473f92012-07-13 13:57:03 -0400914 if (pathobj == NULL)
915 PyErr_Clear();
916 }
917 else
918 pathobj = NULL;
919
Victor Stinner27ee0892011-03-04 12:57:09 +0000920 m = PyImport_ExecCodeModuleObject(nameobj, co, pathobj, cpathobj);
921error:
922 Py_DECREF(nameobj);
923 Py_XDECREF(pathobj);
924 Py_XDECREF(cpathobj);
925 return m;
926}
927
Brett Cannon18fc4e72014-04-04 10:01:46 -0400928static PyObject *
929module_dict_for_exec(PyObject *name)
Victor Stinner27ee0892011-03-04 12:57:09 +0000930{
Brett Cannon18fc4e72014-04-04 10:01:46 -0400931 PyObject *m, *d = NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000932
Victor Stinner27ee0892011-03-04 12:57:09 +0000933 m = PyImport_AddModuleObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000934 if (m == NULL)
935 return NULL;
936 /* If the module is being reloaded, we get the old module back
937 and re-use its dict to exec the new code. */
938 d = PyModule_GetDict(m);
939 if (PyDict_GetItemString(d, "__builtins__") == NULL) {
940 if (PyDict_SetItemString(d, "__builtins__",
Brett Cannon18fc4e72014-04-04 10:01:46 -0400941 PyEval_GetBuiltins()) != 0) {
942 remove_module(name);
943 return NULL;
944 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000945 }
Brett Cannon18fc4e72014-04-04 10:01:46 -0400946
Eric Snow08197a42014-05-12 17:54:55 -0600947 return d; /* Return a borrowed reference. */
Brett Cannon18fc4e72014-04-04 10:01:46 -0400948}
949
950static PyObject *
951exec_code_in_module(PyObject *name, PyObject *module_dict, PyObject *code_object)
952{
Brett Cannon18fc4e72014-04-04 10:01:46 -0400953 PyObject *v, *m;
954
955 v = PyEval_EvalCode(code_object, module_dict, module_dict);
956 if (v == NULL) {
957 remove_module(name);
958 return NULL;
959 }
960 Py_DECREF(v);
961
Eric Snow3f9eee62017-09-15 16:35:20 -0600962 m = PyImport_GetModule(name);
963 if (m == NULL) {
Brett Cannon18fc4e72014-04-04 10:01:46 -0400964 PyErr_Format(PyExc_ImportError,
965 "Loaded module %R not found in sys.modules",
966 name);
967 return NULL;
968 }
969
Brett Cannon18fc4e72014-04-04 10:01:46 -0400970 return m;
971}
972
973PyObject*
974PyImport_ExecCodeModuleObject(PyObject *name, PyObject *co, PyObject *pathname,
975 PyObject *cpathname)
976{
Eric Snow32439d62015-05-02 19:15:18 -0600977 PyObject *d, *external, *res;
Victor Stinnercaba55b2018-08-03 15:33:52 +0200978 PyInterpreterState *interp = _PyInterpreterState_GET_UNSAFE();
Eric Snow08197a42014-05-12 17:54:55 -0600979 _Py_IDENTIFIER(_fix_up_module);
Brett Cannon18fc4e72014-04-04 10:01:46 -0400980
981 d = module_dict_for_exec(name);
982 if (d == NULL) {
983 return NULL;
984 }
985
Eric Snow08197a42014-05-12 17:54:55 -0600986 if (pathname == NULL) {
987 pathname = ((PyCodeObject *)co)->co_filename;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000988 }
Eric Snow32439d62015-05-02 19:15:18 -0600989 external = PyObject_GetAttrString(interp->importlib, "_bootstrap_external");
990 if (external == NULL)
991 return NULL;
992 res = _PyObject_CallMethodIdObjArgs(external,
Eric Snow08197a42014-05-12 17:54:55 -0600993 &PyId__fix_up_module,
994 d, name, pathname, cpathname, NULL);
Eric Snow32439d62015-05-02 19:15:18 -0600995 Py_DECREF(external);
Eric Snow08197a42014-05-12 17:54:55 -0600996 if (res != NULL) {
Eric Snow58cfdd82014-05-29 12:31:39 -0600997 Py_DECREF(res);
Eric Snow08197a42014-05-12 17:54:55 -0600998 res = exec_code_in_module(name, d, co);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000999 }
Eric Snow08197a42014-05-12 17:54:55 -06001000 return res;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001001}
1002
1003
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001004static void
1005update_code_filenames(PyCodeObject *co, PyObject *oldname, PyObject *newname)
1006{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001007 PyObject *constants, *tmp;
1008 Py_ssize_t i, n;
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001009
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001010 if (PyUnicode_Compare(co->co_filename, oldname))
1011 return;
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001012
Serhiy Storchaka576f1322016-01-05 21:27:54 +02001013 Py_INCREF(newname);
Serhiy Storchakaec397562016-04-06 09:50:03 +03001014 Py_XSETREF(co->co_filename, newname);
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001015
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001016 constants = co->co_consts;
1017 n = PyTuple_GET_SIZE(constants);
1018 for (i = 0; i < n; i++) {
1019 tmp = PyTuple_GET_ITEM(constants, i);
1020 if (PyCode_Check(tmp))
1021 update_code_filenames((PyCodeObject *)tmp,
1022 oldname, newname);
1023 }
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001024}
1025
Victor Stinner2f42ae52011-03-20 00:41:24 +01001026static void
1027update_compiled_module(PyCodeObject *co, PyObject *newname)
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001028{
Victor Stinner2f42ae52011-03-20 00:41:24 +01001029 PyObject *oldname;
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001030
Victor Stinner2f42ae52011-03-20 00:41:24 +01001031 if (PyUnicode_Compare(co->co_filename, newname) == 0)
1032 return;
Hirokazu Yamamoto4f447fb2009-03-04 01:52:10 +00001033
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001034 oldname = co->co_filename;
1035 Py_INCREF(oldname);
1036 update_code_filenames(co, oldname, newname);
1037 Py_DECREF(oldname);
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001038}
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001039
Brett Cannon4caa61d2014-01-09 19:03:32 -05001040/*[clinic input]
1041_imp._fix_co_filename
1042
1043 code: object(type="PyCodeObject *", subclass_of="&PyCode_Type")
1044 Code object to change.
1045
1046 path: unicode
1047 File path to use.
1048 /
1049
1050Changes code.co_filename to specify the passed-in file path.
1051[clinic start generated code]*/
1052
Brett Cannon4caa61d2014-01-09 19:03:32 -05001053static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03001054_imp__fix_co_filename_impl(PyObject *module, PyCodeObject *code,
Larry Hastings89964c42015-04-14 18:07:59 -04001055 PyObject *path)
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03001056/*[clinic end generated code: output=1d002f100235587d input=895ba50e78b82f05]*/
Brett Cannon442c9b92011-03-23 16:14:42 -07001057
Brett Cannon4caa61d2014-01-09 19:03:32 -05001058{
Brett Cannona6dec2e2014-01-10 07:43:55 -05001059 update_compiled_module(code, path);
Brett Cannon442c9b92011-03-23 16:14:42 -07001060
1061 Py_RETURN_NONE;
1062}
1063
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001064
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001065/* Forward */
Benjamin Peterson6fba3db2013-03-18 23:13:31 -07001066static const struct _frozen * find_frozen(PyObject *);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001067
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001068
1069/* Helper to test for built-in module */
1070
1071static int
Victor Stinner95872862011-03-07 18:20:56 +01001072is_builtin(PyObject *name)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001073{
Serhiy Storchakaf4934ea2016-11-16 10:17:58 +02001074 int i;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001075 for (i = 0; PyImport_Inittab[i].name != NULL; i++) {
Serhiy Storchakaf4934ea2016-11-16 10:17:58 +02001076 if (_PyUnicode_EqualToASCIIString(name, PyImport_Inittab[i].name)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001077 if (PyImport_Inittab[i].initfunc == NULL)
1078 return -1;
1079 else
1080 return 1;
1081 }
1082 }
1083 return 0;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001084}
1085
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001086
Brett Cannonfdcdd9e2016-07-08 11:00:00 -07001087/* Return a finder object for a sys.path/pkg.__path__ item 'p',
Just van Rossum52e14d62002-12-30 22:08:05 +00001088 possibly by fetching it from the path_importer_cache dict. If it
Thomas Wouters89f507f2006-12-13 04:49:30 +00001089 wasn't yet cached, traverse path_hooks until a hook is found
Just van Rossum52e14d62002-12-30 22:08:05 +00001090 that can handle the path item. Return None if no hook could;
Brett Cannonfdcdd9e2016-07-08 11:00:00 -07001091 this tells our caller that the path based finder could not find
1092 a finder for this path item. Cache the result in
1093 path_importer_cache.
Just van Rossum52e14d62002-12-30 22:08:05 +00001094 Returns a borrowed reference. */
1095
1096static PyObject *
1097get_path_importer(PyObject *path_importer_cache, PyObject *path_hooks,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001098 PyObject *p)
Just van Rossum52e14d62002-12-30 22:08:05 +00001099{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001100 PyObject *importer;
1101 Py_ssize_t j, nhooks;
Just van Rossum52e14d62002-12-30 22:08:05 +00001102
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001103 /* These conditions are the caller's responsibility: */
1104 assert(PyList_Check(path_hooks));
1105 assert(PyDict_Check(path_importer_cache));
Just van Rossum52e14d62002-12-30 22:08:05 +00001106
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001107 nhooks = PyList_Size(path_hooks);
1108 if (nhooks < 0)
1109 return NULL; /* Shouldn't happen */
Just van Rossum52e14d62002-12-30 22:08:05 +00001110
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001111 importer = PyDict_GetItem(path_importer_cache, p);
1112 if (importer != NULL)
1113 return importer;
Just van Rossum52e14d62002-12-30 22:08:05 +00001114
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001115 /* set path_importer_cache[p] to None to avoid recursion */
1116 if (PyDict_SetItem(path_importer_cache, p, Py_None) != 0)
1117 return NULL;
Just van Rossum52e14d62002-12-30 22:08:05 +00001118
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001119 for (j = 0; j < nhooks; j++) {
1120 PyObject *hook = PyList_GetItem(path_hooks, j);
1121 if (hook == NULL)
1122 return NULL;
Victor Stinnerde4ae3d2016-12-04 22:59:09 +01001123 importer = PyObject_CallFunctionObjArgs(hook, p, NULL);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001124 if (importer != NULL)
1125 break;
Just van Rossum52e14d62002-12-30 22:08:05 +00001126
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001127 if (!PyErr_ExceptionMatches(PyExc_ImportError)) {
1128 return NULL;
1129 }
1130 PyErr_Clear();
1131 }
1132 if (importer == NULL) {
Brett Cannonaa936422012-04-27 15:30:58 -04001133 return Py_None;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001134 }
1135 if (importer != NULL) {
1136 int err = PyDict_SetItem(path_importer_cache, p, importer);
1137 Py_DECREF(importer);
1138 if (err != 0)
1139 return NULL;
1140 }
1141 return importer;
Just van Rossum52e14d62002-12-30 22:08:05 +00001142}
1143
Benjamin Petersone5024512018-09-12 12:06:42 -07001144PyObject *
Christian Heimes9cd17752007-11-18 19:35:23 +00001145PyImport_GetImporter(PyObject *path) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001146 PyObject *importer=NULL, *path_importer_cache=NULL, *path_hooks=NULL;
Christian Heimes9cd17752007-11-18 19:35:23 +00001147
Victor Stinner1e53bba2013-07-16 22:26:05 +02001148 path_importer_cache = PySys_GetObject("path_importer_cache");
1149 path_hooks = PySys_GetObject("path_hooks");
1150 if (path_importer_cache != NULL && path_hooks != NULL) {
1151 importer = get_path_importer(path_importer_cache,
1152 path_hooks, path);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001153 }
1154 Py_XINCREF(importer); /* get_path_importer returns a borrowed reference */
1155 return importer;
Christian Heimes9cd17752007-11-18 19:35:23 +00001156}
1157
Nick Coghland5cacbb2015-05-23 22:24:10 +10001158/*[clinic input]
1159_imp.create_builtin
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001160
Nick Coghland5cacbb2015-05-23 22:24:10 +10001161 spec: object
1162 /
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001163
Nick Coghland5cacbb2015-05-23 22:24:10 +10001164Create an extension module.
1165[clinic start generated code]*/
Guido van Rossum7f133ed1991-02-19 12:23:57 +00001166
Nick Coghland5cacbb2015-05-23 22:24:10 +10001167static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03001168_imp_create_builtin(PyObject *module, PyObject *spec)
1169/*[clinic end generated code: output=ace7ff22271e6f39 input=37f966f890384e47]*/
Guido van Rossum7f133ed1991-02-19 12:23:57 +00001170{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001171 struct _inittab *p;
Nick Coghland5cacbb2015-05-23 22:24:10 +10001172 PyObject *name;
Serhiy Storchaka85b0f5b2016-11-20 10:16:47 +02001173 const char *namestr;
Victor Stinner5eb4f592013-11-14 22:38:52 +01001174 PyObject *mod;
Guido van Rossum25ce5661997-08-02 03:10:38 +00001175
Nick Coghland5cacbb2015-05-23 22:24:10 +10001176 name = PyObject_GetAttrString(spec, "name");
1177 if (name == NULL) {
1178 return NULL;
1179 }
1180
Victor Stinner5eb4f592013-11-14 22:38:52 +01001181 mod = _PyImport_FindExtensionObject(name, name);
Nick Coghland5cacbb2015-05-23 22:24:10 +10001182 if (mod || PyErr_Occurred()) {
1183 Py_DECREF(name);
Raymond Hettingerf0afe772016-08-31 08:44:11 -07001184 Py_XINCREF(mod);
Nick Coghland5cacbb2015-05-23 22:24:10 +10001185 return mod;
1186 }
1187
1188 namestr = PyUnicode_AsUTF8(name);
1189 if (namestr == NULL) {
1190 Py_DECREF(name);
1191 return NULL;
1192 }
Guido van Rossum25ce5661997-08-02 03:10:38 +00001193
Eric Snowd393c1b2017-09-14 12:18:12 -06001194 PyObject *modules = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001195 for (p = PyImport_Inittab; p->name != NULL; p++) {
Antoine Pitrou6c40eb72012-01-18 20:16:09 +01001196 PyModuleDef *def;
Serhiy Storchakaf4934ea2016-11-16 10:17:58 +02001197 if (_PyUnicode_EqualToASCIIString(name, p->name)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001198 if (p->initfunc == NULL) {
Nick Coghland5cacbb2015-05-23 22:24:10 +10001199 /* Cannot re-init internal module ("sys" or "builtins") */
1200 mod = PyImport_AddModule(namestr);
1201 Py_DECREF(name);
1202 return mod;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001203 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001204 mod = (*p->initfunc)();
Nick Coghland5cacbb2015-05-23 22:24:10 +10001205 if (mod == NULL) {
1206 Py_DECREF(name);
1207 return NULL;
1208 }
1209 if (PyObject_TypeCheck(mod, &PyModuleDef_Type)) {
1210 Py_DECREF(name);
1211 return PyModule_FromDefAndSpec((PyModuleDef*)mod, spec);
1212 } else {
1213 /* Remember pointer to module init function. */
1214 def = PyModule_GetDef(mod);
Christian Heimesa78b6272016-09-09 00:25:03 +02001215 if (def == NULL) {
1216 Py_DECREF(name);
1217 return NULL;
1218 }
Nick Coghland5cacbb2015-05-23 22:24:10 +10001219 def->m_base.m_init = p->initfunc;
Eric Snowd393c1b2017-09-14 12:18:12 -06001220 if (modules == NULL) {
1221 modules = PyImport_GetModuleDict();
1222 }
1223 if (_PyImport_FixupExtensionObject(mod, name, name,
1224 modules) < 0) {
Nick Coghland5cacbb2015-05-23 22:24:10 +10001225 Py_DECREF(name);
1226 return NULL;
1227 }
1228 Py_DECREF(name);
1229 return mod;
1230 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001231 }
1232 }
Nick Coghland5cacbb2015-05-23 22:24:10 +10001233 Py_DECREF(name);
1234 Py_RETURN_NONE;
Guido van Rossum7f133ed1991-02-19 12:23:57 +00001235}
Guido van Rossumf56e3db1993-04-01 20:59:32 +00001236
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001237
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001238/* Frozen modules */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001239
Benjamin Peterson6fba3db2013-03-18 23:13:31 -07001240static const struct _frozen *
Victor Stinner53dc7352011-03-20 01:50:21 +01001241find_frozen(PyObject *name)
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001242{
Benjamin Peterson6fba3db2013-03-18 23:13:31 -07001243 const struct _frozen *p;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001244
Victor Stinner53dc7352011-03-20 01:50:21 +01001245 if (name == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001246 return NULL;
Benjamin Petersond968e272008-11-05 22:48:33 +00001247
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001248 for (p = PyImport_FrozenModules; ; p++) {
1249 if (p->name == NULL)
1250 return NULL;
Serhiy Storchakaf4934ea2016-11-16 10:17:58 +02001251 if (_PyUnicode_EqualToASCIIString(name, p->name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001252 break;
1253 }
1254 return p;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001255}
1256
Guido van Rossum79f25d91997-04-29 20:08:16 +00001257static PyObject *
Victor Stinner53dc7352011-03-20 01:50:21 +01001258get_frozen_object(PyObject *name)
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001259{
Benjamin Peterson6fba3db2013-03-18 23:13:31 -07001260 const struct _frozen *p = find_frozen(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001261 int size;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001262
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001263 if (p == NULL) {
1264 PyErr_Format(PyExc_ImportError,
Victor Stinner53dc7352011-03-20 01:50:21 +01001265 "No such frozen object named %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001266 name);
1267 return NULL;
1268 }
1269 if (p->code == NULL) {
1270 PyErr_Format(PyExc_ImportError,
Victor Stinner53dc7352011-03-20 01:50:21 +01001271 "Excluded frozen object named %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001272 name);
1273 return NULL;
1274 }
1275 size = p->size;
1276 if (size < 0)
1277 size = -size;
Serhiy Storchakac6792272013-10-19 21:03:34 +03001278 return PyMarshal_ReadObjectFromString((const char *)p->code, size);
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001279}
1280
Brett Cannon8d110132009-03-15 02:20:16 +00001281static PyObject *
Victor Stinner53dc7352011-03-20 01:50:21 +01001282is_frozen_package(PyObject *name)
Brett Cannon8d110132009-03-15 02:20:16 +00001283{
Benjamin Peterson6fba3db2013-03-18 23:13:31 -07001284 const struct _frozen *p = find_frozen(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001285 int size;
Brett Cannon8d110132009-03-15 02:20:16 +00001286
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001287 if (p == NULL) {
1288 PyErr_Format(PyExc_ImportError,
Victor Stinner53dc7352011-03-20 01:50:21 +01001289 "No such frozen object named %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001290 name);
1291 return NULL;
1292 }
Brett Cannon8d110132009-03-15 02:20:16 +00001293
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001294 size = p->size;
Brett Cannon8d110132009-03-15 02:20:16 +00001295
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001296 if (size < 0)
1297 Py_RETURN_TRUE;
1298 else
1299 Py_RETURN_FALSE;
Brett Cannon8d110132009-03-15 02:20:16 +00001300}
1301
1302
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001303/* Initialize a frozen module.
Brett Cannon3c2ac442009-03-08 20:49:47 +00001304 Return 1 for success, 0 if the module is not found, and -1 with
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001305 an exception set if the initialization failed.
1306 This function is also used from frozenmain.c */
Guido van Rossum0b344901995-02-07 15:35:27 +00001307
1308int
Victor Stinner53dc7352011-03-20 01:50:21 +01001309PyImport_ImportFrozenModuleObject(PyObject *name)
Guido van Rossumf56e3db1993-04-01 20:59:32 +00001310{
Benjamin Peterson6fba3db2013-03-18 23:13:31 -07001311 const struct _frozen *p;
Brett Cannon18fc4e72014-04-04 10:01:46 -04001312 PyObject *co, *m, *d;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001313 int ispackage;
1314 int size;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001315
Victor Stinner53dc7352011-03-20 01:50:21 +01001316 p = find_frozen(name);
1317
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001318 if (p == NULL)
1319 return 0;
1320 if (p->code == NULL) {
1321 PyErr_Format(PyExc_ImportError,
Victor Stinner53dc7352011-03-20 01:50:21 +01001322 "Excluded frozen object named %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001323 name);
1324 return -1;
1325 }
1326 size = p->size;
1327 ispackage = (size < 0);
1328 if (ispackage)
1329 size = -size;
Serhiy Storchakac6792272013-10-19 21:03:34 +03001330 co = PyMarshal_ReadObjectFromString((const char *)p->code, size);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001331 if (co == NULL)
1332 return -1;
1333 if (!PyCode_Check(co)) {
1334 PyErr_Format(PyExc_TypeError,
Victor Stinner53dc7352011-03-20 01:50:21 +01001335 "frozen object %R is not a code object",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001336 name);
1337 goto err_return;
1338 }
1339 if (ispackage) {
Brett Cannon3e0651b2013-05-31 23:18:39 -04001340 /* Set __path__ to the empty list */
Brett Cannon18fc4e72014-04-04 10:01:46 -04001341 PyObject *l;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001342 int err;
Victor Stinner53dc7352011-03-20 01:50:21 +01001343 m = PyImport_AddModuleObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001344 if (m == NULL)
1345 goto err_return;
1346 d = PyModule_GetDict(m);
Brett Cannon3e0651b2013-05-31 23:18:39 -04001347 l = PyList_New(0);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001348 if (l == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001349 goto err_return;
1350 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001351 err = PyDict_SetItemString(d, "__path__", l);
1352 Py_DECREF(l);
1353 if (err != 0)
1354 goto err_return;
1355 }
Brett Cannon18fc4e72014-04-04 10:01:46 -04001356 d = module_dict_for_exec(name);
1357 if (d == NULL) {
Victor Stinner53dc7352011-03-20 01:50:21 +01001358 goto err_return;
Brett Cannon18fc4e72014-04-04 10:01:46 -04001359 }
1360 m = exec_code_in_module(name, d, co);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001361 if (m == NULL)
1362 goto err_return;
1363 Py_DECREF(co);
1364 Py_DECREF(m);
1365 return 1;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001366err_return:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001367 Py_DECREF(co);
1368 return -1;
Guido van Rossumf56e3db1993-04-01 20:59:32 +00001369}
Guido van Rossum74e6a111994-08-29 12:54:38 +00001370
Victor Stinner53dc7352011-03-20 01:50:21 +01001371int
Serhiy Storchakac6792272013-10-19 21:03:34 +03001372PyImport_ImportFrozenModule(const char *name)
Victor Stinner53dc7352011-03-20 01:50:21 +01001373{
1374 PyObject *nameobj;
1375 int ret;
1376 nameobj = PyUnicode_InternFromString(name);
1377 if (nameobj == NULL)
1378 return -1;
1379 ret = PyImport_ImportFrozenModuleObject(nameobj);
1380 Py_DECREF(nameobj);
1381 return ret;
1382}
1383
Guido van Rossum74e6a111994-08-29 12:54:38 +00001384
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001385/* Import a module, either built-in, frozen, or external, and return
Guido van Rossum7f9fa971995-01-20 16:53:12 +00001386 its module object WITH INCREMENTED REFERENCE COUNT */
Guido van Rossum74e6a111994-08-29 12:54:38 +00001387
Guido van Rossum79f25d91997-04-29 20:08:16 +00001388PyObject *
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00001389PyImport_ImportModule(const char *name)
Guido van Rossum74e6a111994-08-29 12:54:38 +00001390{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001391 PyObject *pname;
1392 PyObject *result;
Marc-André Lemburg3c61c352001-02-09 19:40:15 +00001393
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001394 pname = PyUnicode_FromString(name);
1395 if (pname == NULL)
1396 return NULL;
1397 result = PyImport_Import(pname);
1398 Py_DECREF(pname);
1399 return result;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001400}
1401
Christian Heimes072c0f12008-01-03 23:01:04 +00001402/* Import a module without blocking
1403 *
1404 * At first it tries to fetch the module from sys.modules. If the module was
1405 * never loaded before it loads it with PyImport_ImportModule() unless another
1406 * thread holds the import lock. In the latter case the function raises an
1407 * ImportError instead of blocking.
1408 *
1409 * Returns the module object with incremented ref count.
1410 */
1411PyObject *
1412PyImport_ImportModuleNoBlock(const char *name)
1413{
Antoine Pitrouea3eb882012-05-17 18:55:59 +02001414 return PyImport_ImportModule(name);
Christian Heimes072c0f12008-01-03 23:01:04 +00001415}
1416
Guido van Rossum17fc85f1997-09-06 18:52:03 +00001417
Antoine Pitroubc07a5c2012-07-08 12:01:27 +02001418/* Remove importlib frames from the traceback,
1419 * except in Verbose mode. */
1420static void
1421remove_importlib_frames(void)
1422{
1423 const char *importlib_filename = "<frozen importlib._bootstrap>";
Eric Snow32439d62015-05-02 19:15:18 -06001424 const char *external_filename = "<frozen importlib._bootstrap_external>";
Nick Coghlan42c07662012-07-31 21:14:18 +10001425 const char *remove_frames = "_call_with_frames_removed";
Antoine Pitroubc07a5c2012-07-08 12:01:27 +02001426 int always_trim = 0;
Benjamin Petersonfa873702012-07-09 13:43:53 -07001427 int in_importlib = 0;
Antoine Pitroubc07a5c2012-07-08 12:01:27 +02001428 PyObject *exception, *value, *base_tb, *tb;
Benjamin Petersonfa873702012-07-09 13:43:53 -07001429 PyObject **prev_link, **outer_link = NULL;
Antoine Pitroubc07a5c2012-07-08 12:01:27 +02001430
1431 /* Synopsis: if it's an ImportError, we trim all importlib chunks
Nick Coghlan42c07662012-07-31 21:14:18 +10001432 from the traceback. We always trim chunks
1433 which end with a call to "_call_with_frames_removed". */
Antoine Pitroubc07a5c2012-07-08 12:01:27 +02001434
1435 PyErr_Fetch(&exception, &value, &base_tb);
1436 if (!exception || Py_VerboseFlag)
1437 goto done;
1438 if (PyType_IsSubtype((PyTypeObject *) exception,
1439 (PyTypeObject *) PyExc_ImportError))
1440 always_trim = 1;
1441
1442 prev_link = &base_tb;
1443 tb = base_tb;
Antoine Pitroubc07a5c2012-07-08 12:01:27 +02001444 while (tb != NULL) {
1445 PyTracebackObject *traceback = (PyTracebackObject *)tb;
1446 PyObject *next = (PyObject *) traceback->tb_next;
1447 PyFrameObject *frame = traceback->tb_frame;
1448 PyCodeObject *code = frame->f_code;
1449 int now_in_importlib;
1450
1451 assert(PyTraceBack_Check(tb));
Serhiy Storchakaf4934ea2016-11-16 10:17:58 +02001452 now_in_importlib = _PyUnicode_EqualToASCIIString(code->co_filename, importlib_filename) ||
1453 _PyUnicode_EqualToASCIIString(code->co_filename, external_filename);
Antoine Pitroubc07a5c2012-07-08 12:01:27 +02001454 if (now_in_importlib && !in_importlib) {
1455 /* This is the link to this chunk of importlib tracebacks */
1456 outer_link = prev_link;
1457 }
1458 in_importlib = now_in_importlib;
1459
1460 if (in_importlib &&
1461 (always_trim ||
Serhiy Storchakaf4934ea2016-11-16 10:17:58 +02001462 _PyUnicode_EqualToASCIIString(code->co_name, remove_frames))) {
Antoine Pitroubc07a5c2012-07-08 12:01:27 +02001463 Py_XINCREF(next);
Serhiy Storchakaec397562016-04-06 09:50:03 +03001464 Py_XSETREF(*outer_link, next);
Antoine Pitroubc07a5c2012-07-08 12:01:27 +02001465 prev_link = outer_link;
1466 }
1467 else {
1468 prev_link = (PyObject **) &traceback->tb_next;
1469 }
1470 tb = next;
1471 }
1472done:
1473 PyErr_Restore(exception, value, base_tb);
1474}
1475
1476
Serhiy Storchaka133138a2016-08-02 22:51:21 +03001477static PyObject *
1478resolve_name(PyObject *name, PyObject *globals, int level)
Thomas Woutersf7f438b2006-02-28 16:09:29 +00001479{
Eric Snowb523f842013-11-22 09:05:39 -07001480 _Py_IDENTIFIER(__spec__);
Brett Cannonfd074152012-04-14 14:10:13 -04001481 _Py_IDENTIFIER(__package__);
1482 _Py_IDENTIFIER(__path__);
1483 _Py_IDENTIFIER(__name__);
Serhiy Storchaka133138a2016-08-02 22:51:21 +03001484 _Py_IDENTIFIER(parent);
1485 PyObject *abs_name;
1486 PyObject *package = NULL;
1487 PyObject *spec;
Serhiy Storchaka133138a2016-08-02 22:51:21 +03001488 Py_ssize_t last_dot;
1489 PyObject *base;
1490 int level_up;
1491
1492 if (globals == NULL) {
1493 PyErr_SetString(PyExc_KeyError, "'__name__' not in globals");
1494 goto error;
1495 }
1496 if (!PyDict_Check(globals)) {
1497 PyErr_SetString(PyExc_TypeError, "globals must be a dict");
1498 goto error;
1499 }
1500 package = _PyDict_GetItemId(globals, &PyId___package__);
1501 if (package == Py_None) {
1502 package = NULL;
1503 }
1504 spec = _PyDict_GetItemId(globals, &PyId___spec__);
1505
1506 if (package != NULL) {
1507 Py_INCREF(package);
1508 if (!PyUnicode_Check(package)) {
1509 PyErr_SetString(PyExc_TypeError, "package must be a string");
1510 goto error;
1511 }
1512 else if (spec != NULL && spec != Py_None) {
1513 int equal;
1514 PyObject *parent = _PyObject_GetAttrId(spec, &PyId_parent);
1515 if (parent == NULL) {
1516 goto error;
1517 }
1518
1519 equal = PyObject_RichCompareBool(package, parent, Py_EQ);
1520 Py_DECREF(parent);
1521 if (equal < 0) {
1522 goto error;
1523 }
1524 else if (equal == 0) {
1525 if (PyErr_WarnEx(PyExc_ImportWarning,
1526 "__package__ != __spec__.parent", 1) < 0) {
1527 goto error;
1528 }
1529 }
1530 }
1531 }
1532 else if (spec != NULL && spec != Py_None) {
1533 package = _PyObject_GetAttrId(spec, &PyId_parent);
1534 if (package == NULL) {
1535 goto error;
1536 }
1537 else if (!PyUnicode_Check(package)) {
1538 PyErr_SetString(PyExc_TypeError,
1539 "__spec__.parent must be a string");
1540 goto error;
1541 }
1542 }
1543 else {
1544 if (PyErr_WarnEx(PyExc_ImportWarning,
1545 "can't resolve package from __spec__ or __package__, "
1546 "falling back on __name__ and __path__", 1) < 0) {
1547 goto error;
1548 }
1549
1550 package = _PyDict_GetItemId(globals, &PyId___name__);
1551 if (package == NULL) {
1552 PyErr_SetString(PyExc_KeyError, "'__name__' not in globals");
1553 goto error;
1554 }
1555
1556 Py_INCREF(package);
1557 if (!PyUnicode_Check(package)) {
1558 PyErr_SetString(PyExc_TypeError, "__name__ must be a string");
1559 goto error;
1560 }
1561
1562 if (_PyDict_GetItemId(globals, &PyId___path__) == NULL) {
1563 Py_ssize_t dot;
1564
1565 if (PyUnicode_READY(package) < 0) {
1566 goto error;
1567 }
1568
1569 dot = PyUnicode_FindChar(package, '.',
1570 0, PyUnicode_GET_LENGTH(package), -1);
1571 if (dot == -2) {
1572 goto error;
1573 }
1574
1575 if (dot >= 0) {
1576 PyObject *substr = PyUnicode_Substring(package, 0, dot);
1577 if (substr == NULL) {
1578 goto error;
1579 }
1580 Py_SETREF(package, substr);
1581 }
1582 }
1583 }
1584
1585 last_dot = PyUnicode_GET_LENGTH(package);
1586 if (last_dot == 0) {
1587 PyErr_SetString(PyExc_ImportError,
1588 "attempted relative import with no known parent package");
1589 goto error;
1590 }
Serhiy Storchaka133138a2016-08-02 22:51:21 +03001591
1592 for (level_up = 1; level_up < level; level_up += 1) {
1593 last_dot = PyUnicode_FindChar(package, '.', 0, last_dot, -1);
1594 if (last_dot == -2) {
1595 goto error;
1596 }
1597 else if (last_dot == -1) {
1598 PyErr_SetString(PyExc_ValueError,
1599 "attempted relative import beyond top-level "
1600 "package");
1601 goto error;
1602 }
1603 }
1604
1605 base = PyUnicode_Substring(package, 0, last_dot);
1606 Py_DECREF(package);
1607 if (base == NULL || PyUnicode_GET_LENGTH(name) == 0) {
1608 return base;
1609 }
1610
1611 abs_name = PyUnicode_FromFormat("%U.%U", base, name);
1612 Py_DECREF(base);
1613 return abs_name;
1614
1615 error:
1616 Py_XDECREF(package);
1617 return NULL;
1618}
1619
Neil Schemenauereea3cc12017-12-03 09:26:03 -08001620static PyObject *
1621import_find_and_load(PyObject *abs_name)
1622{
1623 _Py_IDENTIFIER(_find_and_load);
1624 PyObject *mod = NULL;
Victor Stinnercaba55b2018-08-03 15:33:52 +02001625 PyInterpreterState *interp = _PyInterpreterState_GET_UNSAFE();
Neil Schemenauereea3cc12017-12-03 09:26:03 -08001626 int import_time = interp->core_config.import_time;
1627 static int import_level;
1628 static _PyTime_t accumulated;
1629
1630 _PyTime_t t1 = 0, accumulated_copy = accumulated;
1631
1632 /* XOptions is initialized after first some imports.
1633 * So we can't have negative cache before completed initialization.
1634 * Anyway, importlib._find_and_load is much slower than
1635 * _PyDict_GetItemIdWithError().
1636 */
1637 if (import_time) {
1638 static int header = 1;
1639 if (header) {
1640 fputs("import time: self [us] | cumulative | imported package\n",
1641 stderr);
1642 header = 0;
1643 }
1644
1645 import_level++;
1646 t1 = _PyTime_GetPerfCounter();
1647 accumulated = 0;
1648 }
1649
1650 if (PyDTrace_IMPORT_FIND_LOAD_START_ENABLED())
1651 PyDTrace_IMPORT_FIND_LOAD_START(PyUnicode_AsUTF8(abs_name));
1652
1653 mod = _PyObject_CallMethodIdObjArgs(interp->importlib,
1654 &PyId__find_and_load, abs_name,
1655 interp->import_func, NULL);
1656
1657 if (PyDTrace_IMPORT_FIND_LOAD_DONE_ENABLED())
1658 PyDTrace_IMPORT_FIND_LOAD_DONE(PyUnicode_AsUTF8(abs_name),
1659 mod != NULL);
1660
1661 if (import_time) {
1662 _PyTime_t cum = _PyTime_GetPerfCounter() - t1;
1663
1664 import_level--;
1665 fprintf(stderr, "import time: %9ld | %10ld | %*s%s\n",
1666 (long)_PyTime_AsMicroseconds(cum - accumulated, _PyTime_ROUND_CEILING),
1667 (long)_PyTime_AsMicroseconds(cum, _PyTime_ROUND_CEILING),
1668 import_level*2, "", PyUnicode_AsUTF8(abs_name));
1669
1670 accumulated = accumulated_copy + cum;
1671 }
1672
1673 return mod;
1674}
1675
Serhiy Storchaka133138a2016-08-02 22:51:21 +03001676PyObject *
1677PyImport_ImportModuleLevelObject(PyObject *name, PyObject *globals,
1678 PyObject *locals, PyObject *fromlist,
1679 int level)
1680{
Brett Cannonfd074152012-04-14 14:10:13 -04001681 _Py_IDENTIFIER(_handle_fromlist);
Brett Cannonfd074152012-04-14 14:10:13 -04001682 PyObject *abs_name = NULL;
Brett Cannonfd074152012-04-14 14:10:13 -04001683 PyObject *final_mod = NULL;
1684 PyObject *mod = NULL;
1685 PyObject *package = NULL;
Victor Stinnercaba55b2018-08-03 15:33:52 +02001686 PyInterpreterState *interp = _PyInterpreterState_GET_UNSAFE();
Serhiy Storchakafa494fd2015-05-30 17:45:22 +03001687 int has_from;
Brett Cannonfd074152012-04-14 14:10:13 -04001688
Brett Cannonfd074152012-04-14 14:10:13 -04001689 if (name == NULL) {
1690 PyErr_SetString(PyExc_ValueError, "Empty module name");
1691 goto error;
1692 }
1693
1694 /* The below code is importlib.__import__() & _gcd_import(), ported to C
1695 for added performance. */
1696
1697 if (!PyUnicode_Check(name)) {
1698 PyErr_SetString(PyExc_TypeError, "module name must be a string");
1699 goto error;
1700 }
Serhiy Storchaka133138a2016-08-02 22:51:21 +03001701 if (PyUnicode_READY(name) < 0) {
Brett Cannonfd074152012-04-14 14:10:13 -04001702 goto error;
1703 }
1704 if (level < 0) {
1705 PyErr_SetString(PyExc_ValueError, "level must be >= 0");
1706 goto error;
1707 }
Brett Cannon849113a2016-01-22 15:25:50 -08001708
Serhiy Storchaka133138a2016-08-02 22:51:21 +03001709 if (level > 0) {
1710 abs_name = resolve_name(name, globals, level);
1711 if (abs_name == NULL)
Brett Cannon9fa81262016-01-22 16:39:02 -08001712 goto error;
Brett Cannonfd074152012-04-14 14:10:13 -04001713 }
1714 else { /* level == 0 */
1715 if (PyUnicode_GET_LENGTH(name) == 0) {
1716 PyErr_SetString(PyExc_ValueError, "Empty module name");
1717 goto error;
1718 }
Brett Cannonfd074152012-04-14 14:10:13 -04001719 abs_name = name;
1720 Py_INCREF(abs_name);
1721 }
1722
Eric Snow3f9eee62017-09-15 16:35:20 -06001723 mod = PyImport_GetModule(abs_name);
Serhiy Storchakab4baace2017-07-06 08:09:03 +03001724 if (mod != NULL && mod != Py_None) {
Serhiy Storchaka133138a2016-08-02 22:51:21 +03001725 _Py_IDENTIFIER(__spec__);
Serhiy Storchaka133138a2016-08-02 22:51:21 +03001726 _Py_IDENTIFIER(_lock_unlock_module);
Eric Snowb523f842013-11-22 09:05:39 -07001727 PyObject *spec;
Antoine Pitrouea3eb882012-05-17 18:55:59 +02001728
Antoine Pitrou03989852012-08-28 00:24:52 +02001729 /* Optimization: only call _bootstrap._lock_unlock_module() if
Eric Snowb523f842013-11-22 09:05:39 -07001730 __spec__._initializing is true.
1731 NOTE: because of this, initializing must be set *before*
Antoine Pitrou03989852012-08-28 00:24:52 +02001732 stuffing the new module in sys.modules.
1733 */
Eric Snowb523f842013-11-22 09:05:39 -07001734 spec = _PyObject_GetAttrId(mod, &PyId___spec__);
Serhiy Storchaka3e429dc2018-10-30 13:19:51 +02001735 if (_PyModuleSpec_IsInitializing(spec)) {
1736 PyObject *value = _PyObject_CallMethodIdObjArgs(interp->importlib,
1737 &PyId__lock_unlock_module, abs_name,
1738 NULL);
1739 if (value == NULL) {
1740 Py_DECREF(spec);
1741 goto error;
Serhiy Storchaka133138a2016-08-02 22:51:21 +03001742 }
Serhiy Storchaka3e429dc2018-10-30 13:19:51 +02001743 Py_DECREF(value);
Antoine Pitrouea3eb882012-05-17 18:55:59 +02001744 }
Serhiy Storchaka3e429dc2018-10-30 13:19:51 +02001745 Py_XDECREF(spec);
Brett Cannonfd074152012-04-14 14:10:13 -04001746 }
1747 else {
Neil Schemenauer11cc2892017-12-07 16:24:59 -08001748 Py_XDECREF(mod);
Neil Schemenauereea3cc12017-12-03 09:26:03 -08001749 mod = import_find_and_load(abs_name);
Brett Cannonfd074152012-04-14 14:10:13 -04001750 if (mod == NULL) {
Antoine Pitrouea3eb882012-05-17 18:55:59 +02001751 goto error;
Brett Cannonfd074152012-04-14 14:10:13 -04001752 }
1753 }
1754
Serhiy Storchaka133138a2016-08-02 22:51:21 +03001755 has_from = 0;
1756 if (fromlist != NULL && fromlist != Py_None) {
1757 has_from = PyObject_IsTrue(fromlist);
1758 if (has_from < 0)
1759 goto error;
1760 }
Serhiy Storchakafa494fd2015-05-30 17:45:22 +03001761 if (!has_from) {
Victor Stinner744c34e2016-05-20 11:36:13 +02001762 Py_ssize_t len = PyUnicode_GET_LENGTH(name);
1763 if (level == 0 || len > 0) {
1764 Py_ssize_t dot;
Brett Cannonfd074152012-04-14 14:10:13 -04001765
Victor Stinner744c34e2016-05-20 11:36:13 +02001766 dot = PyUnicode_FindChar(name, '.', 0, len, 1);
1767 if (dot == -2) {
Antoine Pitrouea3eb882012-05-17 18:55:59 +02001768 goto error;
Brett Cannonfd074152012-04-14 14:10:13 -04001769 }
1770
Victor Stinner744c34e2016-05-20 11:36:13 +02001771 if (dot == -1) {
Antoine Pitrou6efa50a2012-05-07 21:41:59 +02001772 /* No dot in module name, simple exit */
Antoine Pitrou6efa50a2012-05-07 21:41:59 +02001773 final_mod = mod;
1774 Py_INCREF(mod);
Antoine Pitrouea3eb882012-05-17 18:55:59 +02001775 goto error;
Antoine Pitrou6efa50a2012-05-07 21:41:59 +02001776 }
1777
Brett Cannonfd074152012-04-14 14:10:13 -04001778 if (level == 0) {
Victor Stinner744c34e2016-05-20 11:36:13 +02001779 PyObject *front = PyUnicode_Substring(name, 0, dot);
1780 if (front == NULL) {
1781 goto error;
1782 }
1783
Serhiy Storchaka133138a2016-08-02 22:51:21 +03001784 final_mod = PyImport_ImportModuleLevelObject(front, NULL, NULL, NULL, 0);
Antoine Pitroub78174c2012-05-06 17:15:23 +02001785 Py_DECREF(front);
Brett Cannonfd074152012-04-14 14:10:13 -04001786 }
1787 else {
Victor Stinner744c34e2016-05-20 11:36:13 +02001788 Py_ssize_t cut_off = len - dot;
Antoine Pitrou22a1d172012-04-16 22:06:21 +02001789 Py_ssize_t abs_name_len = PyUnicode_GET_LENGTH(abs_name);
Brett Cannon49f8d8b2012-04-14 21:50:00 -04001790 PyObject *to_return = PyUnicode_Substring(abs_name, 0,
Brett Cannonfd074152012-04-14 14:10:13 -04001791 abs_name_len - cut_off);
Antoine Pitrou22a1d172012-04-16 22:06:21 +02001792 if (to_return == NULL) {
Antoine Pitrouea3eb882012-05-17 18:55:59 +02001793 goto error;
Antoine Pitrou22a1d172012-04-16 22:06:21 +02001794 }
Brett Cannonfd074152012-04-14 14:10:13 -04001795
Eric Snow3f9eee62017-09-15 16:35:20 -06001796 final_mod = PyImport_GetModule(to_return);
Serhiy Storchaka133138a2016-08-02 22:51:21 +03001797 Py_DECREF(to_return);
Brett Cannon49f8d8b2012-04-14 21:50:00 -04001798 if (final_mod == NULL) {
1799 PyErr_Format(PyExc_KeyError,
1800 "%R not in sys.modules as expected",
1801 to_return);
Serhiy Storchaka133138a2016-08-02 22:51:21 +03001802 goto error;
Brett Cannon49f8d8b2012-04-14 21:50:00 -04001803 }
Brett Cannonfd074152012-04-14 14:10:13 -04001804 }
1805 }
1806 else {
1807 final_mod = mod;
1808 Py_INCREF(mod);
1809 }
1810 }
1811 else {
Serhiy Storchaka4e244252018-03-11 10:52:37 +02001812 _Py_IDENTIFIER(__path__);
1813 PyObject *path;
1814 if (_PyObject_LookupAttrId(mod, &PyId___path__, &path) < 0) {
1815 goto error;
1816 }
1817 if (path) {
1818 Py_DECREF(path);
1819 final_mod = _PyObject_CallMethodIdObjArgs(
1820 interp->importlib, &PyId__handle_fromlist,
1821 mod, fromlist, interp->import_func, NULL);
1822 }
1823 else {
1824 final_mod = mod;
1825 Py_INCREF(mod);
1826 }
Brett Cannonfd074152012-04-14 14:10:13 -04001827 }
Antoine Pitrou6efa50a2012-05-07 21:41:59 +02001828
Brett Cannonfd074152012-04-14 14:10:13 -04001829 error:
1830 Py_XDECREF(abs_name);
Brett Cannonfd074152012-04-14 14:10:13 -04001831 Py_XDECREF(mod);
1832 Py_XDECREF(package);
Antoine Pitroubc07a5c2012-07-08 12:01:27 +02001833 if (final_mod == NULL)
1834 remove_importlib_frames();
Brett Cannonfd074152012-04-14 14:10:13 -04001835 return final_mod;
Guido van Rossum75acc9c1998-03-03 22:26:50 +00001836}
1837
Victor Stinnerfe93faf2011-03-14 15:54:52 -04001838PyObject *
Benjamin Peterson04778a82011-05-25 09:29:00 -05001839PyImport_ImportModuleLevel(const char *name, PyObject *globals, PyObject *locals,
Victor Stinnerfe93faf2011-03-14 15:54:52 -04001840 PyObject *fromlist, int level)
1841{
1842 PyObject *nameobj, *mod;
1843 nameobj = PyUnicode_FromString(name);
1844 if (nameobj == NULL)
1845 return NULL;
1846 mod = PyImport_ImportModuleLevelObject(nameobj, globals, locals,
1847 fromlist, level);
1848 Py_DECREF(nameobj);
1849 return mod;
1850}
1851
1852
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001853/* Re-import a module of any kind and return its module object, WITH
1854 INCREMENTED REFERENCE COUNT */
1855
Guido van Rossum79f25d91997-04-29 20:08:16 +00001856PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001857PyImport_ReloadModule(PyObject *m)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001858{
Eric Snow3f9eee62017-09-15 16:35:20 -06001859 _Py_IDENTIFIER(imp);
Brett Cannon62228db2012-04-29 14:38:11 -04001860 _Py_IDENTIFIER(reload);
1861 PyObject *reloaded_module = NULL;
Eric Snow3f9eee62017-09-15 16:35:20 -06001862 PyObject *imp = _PyImport_GetModuleId(&PyId_imp);
Brett Cannon62228db2012-04-29 14:38:11 -04001863 if (imp == NULL) {
1864 imp = PyImport_ImportModule("imp");
1865 if (imp == NULL) {
1866 return NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001867 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001868 }
Victor Stinnerad3c03b2011-03-14 09:21:33 -04001869
Victor Stinner55ba38a2016-12-09 16:09:30 +01001870 reloaded_module = _PyObject_CallMethodIdObjArgs(imp, &PyId_reload, m, NULL);
Brett Cannon62228db2012-04-29 14:38:11 -04001871 Py_DECREF(imp);
1872 return reloaded_module;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001873}
1874
1875
Guido van Rossumd47a0a81997-08-14 20:11:26 +00001876/* Higher-level import emulator which emulates the "import" statement
1877 more accurately -- it invokes the __import__() function from the
1878 builtins of the current globals. This means that the import is
1879 done using whatever import hooks are installed in the current
Brett Cannonbc2eff32010-09-19 21:39:02 +00001880 environment.
Guido van Rossum6058eb41998-12-21 19:51:00 +00001881 A dummy list ["__doc__"] is passed as the 4th argument so that
Neal Norwitz80e7f272007-08-26 06:45:23 +00001882 e.g. PyImport_Import(PyUnicode_FromString("win32com.client.gencache"))
Guido van Rossum6058eb41998-12-21 19:51:00 +00001883 will return <module "gencache"> instead of <module "win32com">. */
Guido van Rossumd47a0a81997-08-14 20:11:26 +00001884
1885PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001886PyImport_Import(PyObject *module_name)
Guido van Rossumd47a0a81997-08-14 20:11:26 +00001887{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001888 static PyObject *silly_list = NULL;
1889 static PyObject *builtins_str = NULL;
1890 static PyObject *import_str = NULL;
1891 PyObject *globals = NULL;
1892 PyObject *import = NULL;
1893 PyObject *builtins = NULL;
1894 PyObject *r = NULL;
Guido van Rossumd47a0a81997-08-14 20:11:26 +00001895
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001896 /* Initialize constant string objects */
1897 if (silly_list == NULL) {
1898 import_str = PyUnicode_InternFromString("__import__");
1899 if (import_str == NULL)
1900 return NULL;
1901 builtins_str = PyUnicode_InternFromString("__builtins__");
1902 if (builtins_str == NULL)
1903 return NULL;
Brett Cannonbc2eff32010-09-19 21:39:02 +00001904 silly_list = PyList_New(0);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001905 if (silly_list == NULL)
1906 return NULL;
1907 }
Guido van Rossumd47a0a81997-08-14 20:11:26 +00001908
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001909 /* Get the builtins from current globals */
1910 globals = PyEval_GetGlobals();
1911 if (globals != NULL) {
1912 Py_INCREF(globals);
1913 builtins = PyObject_GetItem(globals, builtins_str);
1914 if (builtins == NULL)
1915 goto err;
1916 }
1917 else {
1918 /* No globals -- use standard builtins, and fake globals */
1919 builtins = PyImport_ImportModuleLevel("builtins",
1920 NULL, NULL, NULL, 0);
1921 if (builtins == NULL)
1922 return NULL;
1923 globals = Py_BuildValue("{OO}", builtins_str, builtins);
1924 if (globals == NULL)
1925 goto err;
1926 }
Guido van Rossumd47a0a81997-08-14 20:11:26 +00001927
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001928 /* Get the __import__ function from the builtins */
1929 if (PyDict_Check(builtins)) {
1930 import = PyObject_GetItem(builtins, import_str);
1931 if (import == NULL)
1932 PyErr_SetObject(PyExc_KeyError, import_str);
1933 }
1934 else
1935 import = PyObject_GetAttr(builtins, import_str);
1936 if (import == NULL)
1937 goto err;
Guido van Rossumd47a0a81997-08-14 20:11:26 +00001938
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001939 /* Call the __import__ function with the proper argument list
Brett Cannonbc2eff32010-09-19 21:39:02 +00001940 Always use absolute import here.
1941 Calling for side-effect of import. */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001942 r = PyObject_CallFunction(import, "OOOOi", module_name, globals,
1943 globals, silly_list, 0, NULL);
Brett Cannonbc2eff32010-09-19 21:39:02 +00001944 if (r == NULL)
1945 goto err;
1946 Py_DECREF(r);
1947
Eric Snow3f9eee62017-09-15 16:35:20 -06001948 r = PyImport_GetModule(module_name);
1949 if (r == NULL && !PyErr_Occurred()) {
Serhiy Storchaka145541c2017-06-15 20:54:38 +03001950 PyErr_SetObject(PyExc_KeyError, module_name);
1951 }
Guido van Rossumd47a0a81997-08-14 20:11:26 +00001952
1953 err:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001954 Py_XDECREF(globals);
1955 Py_XDECREF(builtins);
1956 Py_XDECREF(import);
Tim Peters50d8d372001-02-28 05:34:27 +00001957
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001958 return r;
Guido van Rossumd47a0a81997-08-14 20:11:26 +00001959}
1960
Brett Cannon4caa61d2014-01-09 19:03:32 -05001961/*[clinic input]
1962_imp.extension_suffixes
1963
1964Returns the list of file suffixes used to identify extension modules.
1965[clinic start generated code]*/
1966
Brett Cannon4caa61d2014-01-09 19:03:32 -05001967static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03001968_imp_extension_suffixes_impl(PyObject *module)
1969/*[clinic end generated code: output=0bf346e25a8f0cd3 input=ecdeeecfcb6f839e]*/
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001970{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001971 PyObject *list;
Brett Cannon2657df42012-05-04 15:20:40 -04001972 const char *suffix;
1973 unsigned int index = 0;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001974
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001975 list = PyList_New(0);
1976 if (list == NULL)
1977 return NULL;
Brett Cannon2657df42012-05-04 15:20:40 -04001978#ifdef HAVE_DYNAMIC_LOADING
1979 while ((suffix = _PyImport_DynLoadFiletab[index])) {
1980 PyObject *item = PyUnicode_FromString(suffix);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001981 if (item == NULL) {
1982 Py_DECREF(list);
1983 return NULL;
1984 }
1985 if (PyList_Append(list, item) < 0) {
1986 Py_DECREF(list);
1987 Py_DECREF(item);
1988 return NULL;
1989 }
1990 Py_DECREF(item);
Brett Cannon2657df42012-05-04 15:20:40 -04001991 index += 1;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001992 }
Brett Cannon2657df42012-05-04 15:20:40 -04001993#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001994 return list;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001995}
1996
Brett Cannon4caa61d2014-01-09 19:03:32 -05001997/*[clinic input]
Brett Cannon4caa61d2014-01-09 19:03:32 -05001998_imp.init_frozen
1999
2000 name: unicode
2001 /
2002
2003Initializes a frozen module.
2004[clinic start generated code]*/
2005
Brett Cannon4caa61d2014-01-09 19:03:32 -05002006static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03002007_imp_init_frozen_impl(PyObject *module, PyObject *name)
2008/*[clinic end generated code: output=fc0511ed869fd69c input=13019adfc04f3fb3]*/
Brett Cannon4caa61d2014-01-09 19:03:32 -05002009{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002010 int ret;
2011 PyObject *m;
Brett Cannon4caa61d2014-01-09 19:03:32 -05002012
Victor Stinner53dc7352011-03-20 01:50:21 +01002013 ret = PyImport_ImportFrozenModuleObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002014 if (ret < 0)
2015 return NULL;
2016 if (ret == 0) {
Serhiy Storchaka228b12e2017-01-23 09:47:21 +02002017 Py_RETURN_NONE;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002018 }
Victor Stinner53dc7352011-03-20 01:50:21 +01002019 m = PyImport_AddModuleObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002020 Py_XINCREF(m);
2021 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002022}
2023
Brett Cannon4caa61d2014-01-09 19:03:32 -05002024/*[clinic input]
2025_imp.get_frozen_object
2026
2027 name: unicode
2028 /
2029
2030Create a code object for a frozen module.
2031[clinic start generated code]*/
2032
Brett Cannon4caa61d2014-01-09 19:03:32 -05002033static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03002034_imp_get_frozen_object_impl(PyObject *module, PyObject *name)
2035/*[clinic end generated code: output=2568cc5b7aa0da63 input=ed689bc05358fdbd]*/
Brett Cannon4caa61d2014-01-09 19:03:32 -05002036{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002037 return get_frozen_object(name);
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002038}
2039
Brett Cannon4caa61d2014-01-09 19:03:32 -05002040/*[clinic input]
2041_imp.is_frozen_package
2042
2043 name: unicode
2044 /
2045
2046Returns True if the module name is of a frozen package.
2047[clinic start generated code]*/
2048
Brett Cannon4caa61d2014-01-09 19:03:32 -05002049static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03002050_imp_is_frozen_package_impl(PyObject *module, PyObject *name)
2051/*[clinic end generated code: output=e70cbdb45784a1c9 input=81b6cdecd080fbb8]*/
Brett Cannon4caa61d2014-01-09 19:03:32 -05002052{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002053 return is_frozen_package(name);
Brett Cannon8d110132009-03-15 02:20:16 +00002054}
2055
Brett Cannon4caa61d2014-01-09 19:03:32 -05002056/*[clinic input]
2057_imp.is_builtin
2058
2059 name: unicode
2060 /
2061
2062Returns True if the module name corresponds to a built-in module.
2063[clinic start generated code]*/
2064
Guido van Rossum79f25d91997-04-29 20:08:16 +00002065static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03002066_imp_is_builtin_impl(PyObject *module, PyObject *name)
2067/*[clinic end generated code: output=3bfd1162e2d3be82 input=86befdac021dd1c7]*/
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002068{
Brett Cannon4caa61d2014-01-09 19:03:32 -05002069 return PyLong_FromLong(is_builtin(name));
2070}
2071
2072/*[clinic input]
2073_imp.is_frozen
2074
2075 name: unicode
2076 /
2077
2078Returns True if the module name corresponds to a frozen module.
2079[clinic start generated code]*/
2080
Brett Cannon4caa61d2014-01-09 19:03:32 -05002081static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03002082_imp_is_frozen_impl(PyObject *module, PyObject *name)
2083/*[clinic end generated code: output=01f408f5ec0f2577 input=7301dbca1897d66b]*/
Brett Cannon4caa61d2014-01-09 19:03:32 -05002084{
Benjamin Peterson6fba3db2013-03-18 23:13:31 -07002085 const struct _frozen *p;
Brett Cannon4caa61d2014-01-09 19:03:32 -05002086
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002087 p = find_frozen(name);
2088 return PyBool_FromLong((long) (p == NULL ? 0 : p->size));
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002089}
2090
Larry Hastings1df0b352015-08-24 19:53:56 -07002091/* Common implementation for _imp.exec_dynamic and _imp.exec_builtin */
2092static int
2093exec_builtin_or_dynamic(PyObject *mod) {
2094 PyModuleDef *def;
2095 void *state;
2096
2097 if (!PyModule_Check(mod)) {
2098 return 0;
2099 }
2100
2101 def = PyModule_GetDef(mod);
2102 if (def == NULL) {
Larry Hastings1df0b352015-08-24 19:53:56 -07002103 return 0;
2104 }
Brett Cannon52794db2016-09-07 17:00:43 -07002105
Larry Hastings1df0b352015-08-24 19:53:56 -07002106 state = PyModule_GetState(mod);
Larry Hastings1df0b352015-08-24 19:53:56 -07002107 if (state) {
2108 /* Already initialized; skip reload */
2109 return 0;
2110 }
Brett Cannon52794db2016-09-07 17:00:43 -07002111
Larry Hastings1df0b352015-08-24 19:53:56 -07002112 return PyModule_ExecDef(mod, def);
2113}
2114
Guido van Rossum96a8fb71999-12-22 14:09:35 +00002115#ifdef HAVE_DYNAMIC_LOADING
2116
Brett Cannon4caa61d2014-01-09 19:03:32 -05002117/*[clinic input]
Nick Coghland5cacbb2015-05-23 22:24:10 +10002118_imp.create_dynamic
Brett Cannon4caa61d2014-01-09 19:03:32 -05002119
Nick Coghland5cacbb2015-05-23 22:24:10 +10002120 spec: object
Brett Cannon4caa61d2014-01-09 19:03:32 -05002121 file: object = NULL
2122 /
2123
Nick Coghland5cacbb2015-05-23 22:24:10 +10002124Create an extension module.
Brett Cannon4caa61d2014-01-09 19:03:32 -05002125[clinic start generated code]*/
2126
Brett Cannon4caa61d2014-01-09 19:03:32 -05002127static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03002128_imp_create_dynamic_impl(PyObject *module, PyObject *spec, PyObject *file)
2129/*[clinic end generated code: output=83249b827a4fde77 input=c31b954f4cf4e09d]*/
Brett Cannon4caa61d2014-01-09 19:03:32 -05002130{
Nick Coghland5cacbb2015-05-23 22:24:10 +10002131 PyObject *mod, *name, *path;
Victor Stinnerfefd70c2011-03-14 15:54:07 -04002132 FILE *fp;
2133
Nick Coghland5cacbb2015-05-23 22:24:10 +10002134 name = PyObject_GetAttrString(spec, "name");
2135 if (name == NULL) {
2136 return NULL;
2137 }
2138
2139 path = PyObject_GetAttrString(spec, "origin");
2140 if (path == NULL) {
2141 Py_DECREF(name);
2142 return NULL;
2143 }
2144
2145 mod = _PyImport_FindExtensionObject(name, path);
2146 if (mod != NULL) {
2147 Py_DECREF(name);
2148 Py_DECREF(path);
2149 Py_INCREF(mod);
2150 return mod;
2151 }
2152
Brett Cannon4caa61d2014-01-09 19:03:32 -05002153 if (file != NULL) {
2154 fp = _Py_fopen_obj(path, "r");
Victor Stinnere9ddbf62011-03-22 10:46:35 +01002155 if (fp == NULL) {
Nick Coghland5cacbb2015-05-23 22:24:10 +10002156 Py_DECREF(name);
Brett Cannon4caa61d2014-01-09 19:03:32 -05002157 Py_DECREF(path);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002158 return NULL;
Victor Stinnere9ddbf62011-03-22 10:46:35 +01002159 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002160 }
Victor Stinnerfefd70c2011-03-14 15:54:07 -04002161 else
2162 fp = NULL;
Nick Coghland5cacbb2015-05-23 22:24:10 +10002163
2164 mod = _PyImport_LoadDynamicModuleWithSpec(spec, fp);
2165
2166 Py_DECREF(name);
Brett Cannon4caa61d2014-01-09 19:03:32 -05002167 Py_DECREF(path);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002168 if (fp)
2169 fclose(fp);
Victor Stinnerfefd70c2011-03-14 15:54:07 -04002170 return mod;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002171}
2172
Nick Coghland5cacbb2015-05-23 22:24:10 +10002173/*[clinic input]
2174_imp.exec_dynamic -> int
2175
2176 mod: object
2177 /
2178
2179Initialize an extension module.
2180[clinic start generated code]*/
2181
2182static int
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03002183_imp_exec_dynamic_impl(PyObject *module, PyObject *mod)
2184/*[clinic end generated code: output=f5720ac7b465877d input=9fdbfcb250280d3a]*/
Nick Coghland5cacbb2015-05-23 22:24:10 +10002185{
Larry Hastings1df0b352015-08-24 19:53:56 -07002186 return exec_builtin_or_dynamic(mod);
Nick Coghland5cacbb2015-05-23 22:24:10 +10002187}
2188
2189
Guido van Rossum96a8fb71999-12-22 14:09:35 +00002190#endif /* HAVE_DYNAMIC_LOADING */
2191
Larry Hastings7726ac92014-01-31 22:03:12 -08002192/*[clinic input]
Larry Hastings1df0b352015-08-24 19:53:56 -07002193_imp.exec_builtin -> int
2194
2195 mod: object
2196 /
2197
2198Initialize a built-in module.
2199[clinic start generated code]*/
2200
2201static int
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03002202_imp_exec_builtin_impl(PyObject *module, PyObject *mod)
2203/*[clinic end generated code: output=0262447b240c038e input=7beed5a2f12a60ca]*/
Larry Hastings1df0b352015-08-24 19:53:56 -07002204{
2205 return exec_builtin_or_dynamic(mod);
2206}
2207
Benjamin Peterson42aa93b2017-12-09 10:26:52 -08002208/*[clinic input]
2209_imp.source_hash
2210
2211 key: long
2212 source: Py_buffer
2213[clinic start generated code]*/
2214
2215static PyObject *
2216_imp_source_hash_impl(PyObject *module, long key, Py_buffer *source)
2217/*[clinic end generated code: output=edb292448cf399ea input=9aaad1e590089789]*/
2218{
Benjamin Peterson83620772017-12-09 12:18:56 -08002219 union {
2220 uint64_t x;
2221 char data[sizeof(uint64_t)];
2222 } hash;
2223 hash.x = _Py_KeyedHash((uint64_t)key, source->buf, source->len);
Benjamin Peterson42aa93b2017-12-09 10:26:52 -08002224#if !PY_LITTLE_ENDIAN
2225 // Force to little-endian. There really ought to be a succinct standard way
2226 // to do this.
Benjamin Peterson83620772017-12-09 12:18:56 -08002227 for (size_t i = 0; i < sizeof(hash.data)/2; i++) {
2228 char tmp = hash.data[i];
2229 hash.data[i] = hash.data[sizeof(hash.data) - i - 1];
2230 hash.data[sizeof(hash.data) - i - 1] = tmp;
Benjamin Peterson42aa93b2017-12-09 10:26:52 -08002231 }
Benjamin Peterson42aa93b2017-12-09 10:26:52 -08002232#endif
Benjamin Peterson83620772017-12-09 12:18:56 -08002233 return PyBytes_FromStringAndSize(hash.data, sizeof(hash.data));
Benjamin Peterson42aa93b2017-12-09 10:26:52 -08002234}
2235
Barry Warsaw28a691b2010-04-17 00:19:56 +00002236
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002237PyDoc_STRVAR(doc_imp,
Brett Cannon6f44d662012-04-15 16:08:47 -04002238"(Extremely) low-level import machinery bits as used by importlib and imp.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00002239
Guido van Rossum79f25d91997-04-29 20:08:16 +00002240static PyMethodDef imp_methods[] = {
Brett Cannon4caa61d2014-01-09 19:03:32 -05002241 _IMP_EXTENSION_SUFFIXES_METHODDEF
2242 _IMP_LOCK_HELD_METHODDEF
2243 _IMP_ACQUIRE_LOCK_METHODDEF
2244 _IMP_RELEASE_LOCK_METHODDEF
2245 _IMP_GET_FROZEN_OBJECT_METHODDEF
2246 _IMP_IS_FROZEN_PACKAGE_METHODDEF
Nick Coghland5cacbb2015-05-23 22:24:10 +10002247 _IMP_CREATE_BUILTIN_METHODDEF
Brett Cannon4caa61d2014-01-09 19:03:32 -05002248 _IMP_INIT_FROZEN_METHODDEF
2249 _IMP_IS_BUILTIN_METHODDEF
2250 _IMP_IS_FROZEN_METHODDEF
Nick Coghland5cacbb2015-05-23 22:24:10 +10002251 _IMP_CREATE_DYNAMIC_METHODDEF
2252 _IMP_EXEC_DYNAMIC_METHODDEF
Larry Hastings1df0b352015-08-24 19:53:56 -07002253 _IMP_EXEC_BUILTIN_METHODDEF
Brett Cannon4caa61d2014-01-09 19:03:32 -05002254 _IMP__FIX_CO_FILENAME_METHODDEF
Benjamin Peterson42aa93b2017-12-09 10:26:52 -08002255 _IMP_SOURCE_HASH_METHODDEF
Brett Cannon4caa61d2014-01-09 19:03:32 -05002256 {NULL, NULL} /* sentinel */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002257};
2258
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002259
Martin v. Löwis1a214512008-06-11 05:26:20 +00002260static struct PyModuleDef impmodule = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002261 PyModuleDef_HEAD_INIT,
Brett Cannon6f44d662012-04-15 16:08:47 -04002262 "_imp",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002263 doc_imp,
2264 0,
2265 imp_methods,
2266 NULL,
2267 NULL,
2268 NULL,
2269 NULL
Martin v. Löwis1a214512008-06-11 05:26:20 +00002270};
Thomas Wouters0e3f5912006-08-11 14:57:12 +00002271
Jason Tishler6bc06ec2003-09-04 11:59:50 +00002272PyMODINIT_FUNC
Benjamin Petersonc65ef772018-01-29 11:33:57 -08002273PyInit__imp(void)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002274{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002275 PyObject *m, *d;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002276
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002277 m = PyModule_Create(&impmodule);
2278 if (m == NULL)
2279 goto failure;
2280 d = PyModule_GetDict(m);
2281 if (d == NULL)
2282 goto failure;
Victor Stinnercaba55b2018-08-03 15:33:52 +02002283 _PyCoreConfig *config = &_PyInterpreterState_Get()->core_config;
Victor Stinner80b762f2018-08-01 18:18:07 +02002284 PyObject *pyc_mode = PyUnicode_FromString(config->_check_hash_pycs_mode);
Benjamin Peterson42aa93b2017-12-09 10:26:52 -08002285 if (pyc_mode == NULL) {
2286 goto failure;
2287 }
2288 if (PyDict_SetItemString(d, "check_hash_based_pycs", pyc_mode) < 0) {
2289 Py_DECREF(pyc_mode);
2290 goto failure;
2291 }
2292 Py_DECREF(pyc_mode);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002293
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002294 return m;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002295 failure:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002296 Py_XDECREF(m);
2297 return NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002298}
Guido van Rossum09cae1f1998-05-14 02:32:54 +00002299
2300
Guido van Rossumb18618d2000-05-03 23:44:39 +00002301/* API for embedding applications that want to add their own entries
2302 to the table of built-in modules. This should normally be called
2303 *before* Py_Initialize(). When the table resize fails, -1 is
2304 returned and the existing table is unchanged.
Guido van Rossum09cae1f1998-05-14 02:32:54 +00002305
2306 After a similar function by Just van Rossum. */
2307
2308int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002309PyImport_ExtendInittab(struct _inittab *newtab)
Guido van Rossum09cae1f1998-05-14 02:32:54 +00002310{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002311 struct _inittab *p;
Benjamin Peterson0c644fc2017-12-15 23:42:33 -08002312 size_t i, n;
Victor Stinner92a3c6f2017-12-06 18:12:59 +01002313 int res = 0;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00002314
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002315 /* Count the number of entries in both tables */
2316 for (n = 0; newtab[n].name != NULL; n++)
2317 ;
2318 if (n == 0)
2319 return 0; /* Nothing to do */
2320 for (i = 0; PyImport_Inittab[i].name != NULL; i++)
2321 ;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00002322
Victor Stinner92a3c6f2017-12-06 18:12:59 +01002323 /* Force default raw memory allocator to get a known allocator to be able
2324 to release the memory in _PyImport_Fini2() */
2325 PyMemAllocatorEx old_alloc;
2326 _PyMem_SetDefaultAllocator(PYMEM_DOMAIN_RAW, &old_alloc);
2327
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002328 /* Allocate new memory for the combined table */
Benjamin Peterson0c644fc2017-12-15 23:42:33 -08002329 p = NULL;
2330 if (i + n <= SIZE_MAX / sizeof(struct _inittab) - 1) {
Victor Stinner92a3c6f2017-12-06 18:12:59 +01002331 size_t size = sizeof(struct _inittab) * (i + n + 1);
2332 p = PyMem_RawRealloc(inittab_copy, size);
2333 }
Victor Stinner92a3c6f2017-12-06 18:12:59 +01002334 if (p == NULL) {
2335 res = -1;
2336 goto done;
2337 }
Guido van Rossum09cae1f1998-05-14 02:32:54 +00002338
Victor Stinner92a3c6f2017-12-06 18:12:59 +01002339 /* Copy the tables into the new memory at the first call
2340 to PyImport_ExtendInittab(). */
2341 if (inittab_copy != PyImport_Inittab) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002342 memcpy(p, PyImport_Inittab, (i+1) * sizeof(struct _inittab));
Victor Stinner92a3c6f2017-12-06 18:12:59 +01002343 }
2344 memcpy(p + i, newtab, (n + 1) * sizeof(struct _inittab));
2345 PyImport_Inittab = inittab_copy = p;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00002346
Victor Stinner92a3c6f2017-12-06 18:12:59 +01002347done:
2348 PyMem_SetAllocator(PYMEM_DOMAIN_RAW, &old_alloc);
2349 return res;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00002350}
2351
2352/* Shorthand to add a single entry given a name and a function */
2353
2354int
Brett Cannona826f322009-04-02 03:41:46 +00002355PyImport_AppendInittab(const char *name, PyObject* (*initfunc)(void))
Guido van Rossum09cae1f1998-05-14 02:32:54 +00002356{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002357 struct _inittab newtab[2];
Guido van Rossum09cae1f1998-05-14 02:32:54 +00002358
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002359 memset(newtab, '\0', sizeof newtab);
Guido van Rossum09cae1f1998-05-14 02:32:54 +00002360
Serhiy Storchaka20b39b22014-09-28 11:27:24 +03002361 newtab[0].name = name;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002362 newtab[0].initfunc = initfunc;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00002363
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002364 return PyImport_ExtendInittab(newtab);
Guido van Rossum09cae1f1998-05-14 02:32:54 +00002365}
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002366
2367#ifdef __cplusplus
2368}
2369#endif