blob: 319b661f1f9b195777f2fb07738f8abed8c5ac45 [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"
Guido van Rossumd8faa362007-04-27 19:54:29 +00006#undef Yield /* undefine macro conflicting with winbase.h */
Benjamin Peterson42aa93b2017-12-09 10:26:52 -08007#include "internal/hash.h"
Eric Snow2ebc5ce2017-09-07 23:51:28 -06008#include "internal/pystate.h"
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00009#include "errcode.h"
Guido van Rossumc405b7b1991-06-04 19:39:42 +000010#include "marshal.h"
Jeremy Hylton3e0055f2005-10-20 19:59:25 +000011#include "code.h"
Antoine Pitroubc07a5c2012-07-08 12:01:27 +020012#include "frameobject.h"
Guido van Rossumd8bac6d1992-02-26 15:19:13 +000013#include "osdefs.h"
Guido van Rossum1ae940a1995-01-02 19:04:15 +000014#include "importdl.h"
Christian Heimes3d2b4072017-09-30 00:53:19 +020015#include "pydtrace.h"
Guido van Rossumc405b7b1991-06-04 19:39:42 +000016
Guido van Rossum55a83382000-09-20 20:31:38 +000017#ifdef HAVE_FCNTL_H
18#include <fcntl.h>
19#endif
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000020#ifdef __cplusplus
Brett Cannon9a5b25a2010-03-01 02:09:17 +000021extern "C" {
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000022#endif
Guido van Rossum55a83382000-09-20 20:31:38 +000023
Barry Warsaw28a691b2010-04-17 00:19:56 +000024#define CACHEDIR "__pycache__"
Guido van Rossum96774c12000-05-01 20:19:08 +000025
Victor Stinner95872862011-03-07 18:20:56 +010026/* See _PyImport_FixupExtensionObject() below */
Guido van Rossum25ce5661997-08-02 03:10:38 +000027static PyObject *extensions = NULL;
Guido van Rossum3f5da241990-12-20 15:06:42 +000028
Guido van Rossum771c6c81997-10-31 18:37:24 +000029/* This table is defined in config.c: */
30extern struct _inittab _PyImport_Inittab[];
31
32struct _inittab *PyImport_Inittab = _PyImport_Inittab;
Victor Stinner92a3c6f2017-12-06 18:12:59 +010033static struct _inittab *inittab_copy = NULL;
Guido van Rossum66f1fa81991-04-03 19:03:52 +000034
Brett Cannon4caa61d2014-01-09 19:03:32 -050035/*[clinic input]
36module _imp
37[clinic start generated code]*/
Serhiy Storchaka1009bf12015-04-03 23:53:51 +030038/*[clinic end generated code: output=da39a3ee5e6b4b0d input=9c332475d8686284]*/
Brett Cannonfd4d0502014-05-30 11:21:14 -040039
40#include "clinic/import.c.h"
Brett Cannon4caa61d2014-01-09 19:03:32 -050041
Guido van Rossum1ae940a1995-01-02 19:04:15 +000042/* Initialize things */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000043
Victor Stinnerf7e5b562017-11-15 15:48:08 -080044_PyInitError
Victor Stinner672b6ba2017-12-06 17:25:50 +010045_PyImport_Init(PyInterpreterState *interp)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000046{
Serhiy Storchaka013bb912014-02-10 18:21:34 +020047 interp->builtins_copy = PyDict_Copy(interp->builtins);
Victor Stinnerf7e5b562017-11-15 15:48:08 -080048 if (interp->builtins_copy == NULL) {
49 return _Py_INIT_ERR("Can't backup builtins dict");
50 }
51 return _Py_INIT_OK();
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000052}
53
Victor Stinnerf7e5b562017-11-15 15:48:08 -080054_PyInitError
Just van Rossum52e14d62002-12-30 22:08:05 +000055_PyImportHooks_Init(void)
56{
Brett Cannonfd074152012-04-14 14:10:13 -040057 PyObject *v, *path_hooks = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000058 int err = 0;
Just van Rossum52e14d62002-12-30 22:08:05 +000059
Brett Cannonfd074152012-04-14 14:10:13 -040060 /* adding sys.path_hooks and sys.path_importer_cache */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000061 v = PyList_New(0);
62 if (v == NULL)
63 goto error;
64 err = PySys_SetObject("meta_path", v);
65 Py_DECREF(v);
66 if (err)
67 goto error;
68 v = PyDict_New();
69 if (v == NULL)
70 goto error;
71 err = PySys_SetObject("path_importer_cache", v);
72 Py_DECREF(v);
73 if (err)
74 goto error;
75 path_hooks = PyList_New(0);
76 if (path_hooks == NULL)
77 goto error;
78 err = PySys_SetObject("path_hooks", path_hooks);
79 if (err) {
Victor Stinnerf7e5b562017-11-15 15:48:08 -080080 goto error;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000081 }
Brett Cannonfd074152012-04-14 14:10:13 -040082 Py_DECREF(path_hooks);
Victor Stinnerf7e5b562017-11-15 15:48:08 -080083 return _Py_INIT_OK();
84
85 error:
86 PyErr_Print();
87 return _Py_INIT_ERR("initializing sys.meta_path, sys.path_hooks, "
88 "or path_importer_cache failed");
Brett Cannonfd074152012-04-14 14:10:13 -040089}
90
Victor Stinnerf7e5b562017-11-15 15:48:08 -080091_PyInitError
Brett Cannonfd074152012-04-14 14:10:13 -040092_PyImportZip_Init(void)
93{
ukwksk5e6312c2018-05-15 04:10:52 +090094 PyObject *path_hooks, *zipimport;
Brett Cannonfd074152012-04-14 14:10:13 -040095 int err = 0;
96
97 path_hooks = PySys_GetObject("path_hooks");
Victor Stinner1e53bba2013-07-16 22:26:05 +020098 if (path_hooks == NULL) {
99 PyErr_SetString(PyExc_RuntimeError, "unable to get sys.path_hooks");
Brett Cannonfd074152012-04-14 14:10:13 -0400100 goto error;
Victor Stinner1e53bba2013-07-16 22:26:05 +0200101 }
Brett Cannonfd074152012-04-14 14:10:13 -0400102
103 if (Py_VerboseFlag)
104 PySys_WriteStderr("# installing zipimport hook\n");
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000105
ukwksk5e6312c2018-05-15 04:10:52 +0900106 zipimport = PyImport_ImportModule("zipimport");
107 if (zipimport == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000108 PyErr_Clear(); /* No zip import module -- okay */
109 if (Py_VerboseFlag)
110 PySys_WriteStderr("# can't import zipimport\n");
111 }
112 else {
Martin v. Löwisbd928fe2011-10-14 10:20:37 +0200113 _Py_IDENTIFIER(zipimporter);
ukwksk5e6312c2018-05-15 04:10:52 +0900114 PyObject *zipimporter = _PyObject_GetAttrId(zipimport,
Martin v. Löwis1ee1b6f2011-10-10 18:11:30 +0200115 &PyId_zipimporter);
ukwksk5e6312c2018-05-15 04:10:52 +0900116 Py_DECREF(zipimport);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000117 if (zipimporter == NULL) {
118 PyErr_Clear(); /* No zipimporter object -- okay */
119 if (Py_VerboseFlag)
120 PySys_WriteStderr(
121 "# can't import zipimport.zipimporter\n");
122 }
123 else {
Brett Cannon8923a4d2012-04-24 22:03:46 -0400124 /* sys.path_hooks.insert(0, zipimporter) */
125 err = PyList_Insert(path_hooks, 0, zipimporter);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000126 Py_DECREF(zipimporter);
Brett Cannonfd074152012-04-14 14:10:13 -0400127 if (err < 0) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000128 goto error;
Brett Cannonfd074152012-04-14 14:10:13 -0400129 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000130 if (Py_VerboseFlag)
131 PySys_WriteStderr(
132 "# installed zipimport hook\n");
133 }
134 }
Brett Cannonfd074152012-04-14 14:10:13 -0400135
Victor Stinnerf7e5b562017-11-15 15:48:08 -0800136 return _Py_INIT_OK();
Brett Cannonfd074152012-04-14 14:10:13 -0400137
138 error:
139 PyErr_Print();
Victor Stinnerf7e5b562017-11-15 15:48:08 -0800140 return _Py_INIT_ERR("initializing zipimport failed");
Just van Rossum52e14d62002-12-30 22:08:05 +0000141}
142
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000143/* Locking primitives to prevent parallel imports of the same module
144 in different threads to return with a partially loaded module.
145 These calls are serialized by the global interpreter lock. */
146
Guido van Rossum49b56061998-10-01 20:42:43 +0000147#include "pythread.h"
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000148
Guido van Rossum65d5b571998-12-21 19:32:43 +0000149static PyThread_type_lock import_lock = 0;
Serhiy Storchakaaefa7eb2017-03-23 15:48:39 +0200150static unsigned long import_lock_thread = PYTHREAD_INVALID_THREAD_ID;
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000151static int import_lock_level = 0;
152
Benjamin Peterson0df35a92009-10-04 20:32:25 +0000153void
154_PyImport_AcquireLock(void)
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000155{
Serhiy Storchakaaefa7eb2017-03-23 15:48:39 +0200156 unsigned long me = PyThread_get_thread_ident();
157 if (me == PYTHREAD_INVALID_THREAD_ID)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000158 return; /* Too bad */
159 if (import_lock == NULL) {
160 import_lock = PyThread_allocate_lock();
161 if (import_lock == NULL)
162 return; /* Nothing much we can do. */
163 }
164 if (import_lock_thread == me) {
165 import_lock_level++;
166 return;
167 }
Serhiy Storchakaaefa7eb2017-03-23 15:48:39 +0200168 if (import_lock_thread != PYTHREAD_INVALID_THREAD_ID ||
169 !PyThread_acquire_lock(import_lock, 0))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000170 {
171 PyThreadState *tstate = PyEval_SaveThread();
172 PyThread_acquire_lock(import_lock, 1);
173 PyEval_RestoreThread(tstate);
174 }
Antoine Pitrou202b6062012-12-18 22:18:17 +0100175 assert(import_lock_level == 0);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000176 import_lock_thread = me;
177 import_lock_level = 1;
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000178}
179
Benjamin Peterson0df35a92009-10-04 20:32:25 +0000180int
181_PyImport_ReleaseLock(void)
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000182{
Serhiy Storchakaaefa7eb2017-03-23 15:48:39 +0200183 unsigned long me = PyThread_get_thread_ident();
184 if (me == PYTHREAD_INVALID_THREAD_ID || import_lock == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000185 return 0; /* Too bad */
186 if (import_lock_thread != me)
187 return -1;
188 import_lock_level--;
Antoine Pitrou202b6062012-12-18 22:18:17 +0100189 assert(import_lock_level >= 0);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000190 if (import_lock_level == 0) {
Serhiy Storchakaaefa7eb2017-03-23 15:48:39 +0200191 import_lock_thread = PYTHREAD_INVALID_THREAD_ID;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000192 PyThread_release_lock(import_lock);
193 }
194 return 1;
Guido van Rossum75acc9c1998-03-03 22:26:50 +0000195}
196
Antoine Pitrouf7ecfac2017-05-28 11:35:14 +0200197/* This function is called from PyOS_AfterFork_Child to ensure that newly
Gregory P. Smith24cec9f2010-03-01 06:18:41 +0000198 created child processes do not share locks with the parent.
199 We now acquire the import lock around fork() calls but on some platforms
200 (Solaris 9 and earlier? see isue7242) that still left us with problems. */
Guido van Rossum8ee3e5a2005-09-14 18:09:42 +0000201
202void
203_PyImport_ReInitLock(void)
204{
Christian Heimes418fd742015-04-19 21:08:42 +0200205 if (import_lock != NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000206 import_lock = PyThread_allocate_lock();
Christian Heimes418fd742015-04-19 21:08:42 +0200207 if (import_lock == NULL) {
208 Py_FatalError("PyImport_ReInitLock failed to create a new lock");
209 }
210 }
Nick Coghlanb2ddf792010-12-02 04:11:46 +0000211 if (import_lock_level > 1) {
212 /* Forked as a side effect of import */
Serhiy Storchakaaefa7eb2017-03-23 15:48:39 +0200213 unsigned long me = PyThread_get_thread_ident();
Brett Cannone4710cf2012-11-15 21:39:36 -0500214 /* The following could fail if the lock is already held, but forking as
215 a side-effect of an import is a) rare, b) nuts, and c) difficult to
216 do thanks to the lock only being held when doing individual module
217 locks per import. */
218 PyThread_acquire_lock(import_lock, NOWAIT_LOCK);
Nick Coghlanb2ddf792010-12-02 04:11:46 +0000219 import_lock_thread = me;
220 import_lock_level--;
221 } else {
Serhiy Storchakaaefa7eb2017-03-23 15:48:39 +0200222 import_lock_thread = PYTHREAD_INVALID_THREAD_ID;
Nick Coghlanb2ddf792010-12-02 04:11:46 +0000223 import_lock_level = 0;
224 }
Guido van Rossum8ee3e5a2005-09-14 18:09:42 +0000225}
226
Brett Cannon4caa61d2014-01-09 19:03:32 -0500227/*[clinic input]
228_imp.lock_held
229
230Return True if the import lock is currently held, else False.
231
232On platforms without threads, return False.
233[clinic start generated code]*/
234
Brett Cannon4caa61d2014-01-09 19:03:32 -0500235static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +0300236_imp_lock_held_impl(PyObject *module)
237/*[clinic end generated code: output=8b89384b5e1963fc input=9b088f9b217d9bdf]*/
Tim Peters69232342001-08-30 05:16:13 +0000238{
Serhiy Storchakaaefa7eb2017-03-23 15:48:39 +0200239 return PyBool_FromLong(import_lock_thread != PYTHREAD_INVALID_THREAD_ID);
Tim Peters69232342001-08-30 05:16:13 +0000240}
241
Brett Cannon4caa61d2014-01-09 19:03:32 -0500242/*[clinic input]
243_imp.acquire_lock
244
245Acquires the interpreter's import lock for the current thread.
246
247This lock should be used by import hooks to ensure thread-safety when importing
248modules. On platforms without threads, this function does nothing.
249[clinic start generated code]*/
250
Brett Cannon4caa61d2014-01-09 19:03:32 -0500251static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +0300252_imp_acquire_lock_impl(PyObject *module)
253/*[clinic end generated code: output=1aff58cb0ee1b026 input=4a2d4381866d5fdc]*/
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000254{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000255 _PyImport_AcquireLock();
Serhiy Storchaka228b12e2017-01-23 09:47:21 +0200256 Py_RETURN_NONE;
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000257}
258
Brett Cannon4caa61d2014-01-09 19:03:32 -0500259/*[clinic input]
260_imp.release_lock
261
262Release the interpreter's import lock.
263
264On platforms without threads, this function does nothing.
265[clinic start generated code]*/
266
Brett Cannon4caa61d2014-01-09 19:03:32 -0500267static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +0300268_imp_release_lock_impl(PyObject *module)
269/*[clinic end generated code: output=7faab6d0be178b0a input=934fb11516dd778b]*/
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000270{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000271 if (_PyImport_ReleaseLock() < 0) {
272 PyErr_SetString(PyExc_RuntimeError,
273 "not holding the import lock");
274 return NULL;
275 }
Serhiy Storchaka228b12e2017-01-23 09:47:21 +0200276 Py_RETURN_NONE;
Guido van Rossumc4f4ca92003-02-12 21:46:11 +0000277}
278
Antoine Pitrou8db076c2011-10-30 19:13:55 +0100279void
280_PyImport_Fini(void)
281{
Serhiy Storchaka505ff752014-02-09 13:33:53 +0200282 Py_CLEAR(extensions);
Antoine Pitrou8db076c2011-10-30 19:13:55 +0100283 if (import_lock != NULL) {
284 PyThread_free_lock(import_lock);
285 import_lock = NULL;
286 }
Antoine Pitrou8db076c2011-10-30 19:13:55 +0100287}
288
Victor Stinner92a3c6f2017-12-06 18:12:59 +0100289void
290_PyImport_Fini2(void)
291{
292 /* Use the same memory allocator than PyImport_ExtendInittab(). */
293 PyMemAllocatorEx old_alloc;
294 _PyMem_SetDefaultAllocator(PYMEM_DOMAIN_RAW, &old_alloc);
295
296 /* Free memory allocated by PyImport_ExtendInittab() */
297 PyMem_RawFree(inittab_copy);
298
299 PyMem_SetAllocator(PYMEM_DOMAIN_RAW, &old_alloc);
300}
301
Guido van Rossum25ce5661997-08-02 03:10:38 +0000302/* Helper for sys */
303
304PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000305PyImport_GetModuleDict(void)
Guido van Rossum25ce5661997-08-02 03:10:38 +0000306{
Victor Stinnercaba55b2018-08-03 15:33:52 +0200307 PyInterpreterState *interp = _PyInterpreterState_GET_UNSAFE();
Eric Snow3f9eee62017-09-15 16:35:20 -0600308 if (interp->modules == NULL) {
Eric Snow93c92f72017-09-13 23:46:04 -0700309 Py_FatalError("PyImport_GetModuleDict: no module dictionary!");
Eric Snow3f9eee62017-09-15 16:35:20 -0600310 }
Eric Snow93c92f72017-09-13 23:46:04 -0700311 return interp->modules;
Guido van Rossum25ce5661997-08-02 03:10:38 +0000312}
313
Eric Snowd393c1b2017-09-14 12:18:12 -0600314/* In some corner cases it is important to be sure that the import
315 machinery has been initialized (or not cleaned up yet). For
316 example, see issue #4236 and PyModule_Create2(). */
317
318int
319_PyImport_IsInitialized(PyInterpreterState *interp)
320{
321 if (interp->modules == NULL)
322 return 0;
323 return 1;
324}
Guido van Rossum3f5da241990-12-20 15:06:42 +0000325
Eric Snow3f9eee62017-09-15 16:35:20 -0600326PyObject *
327_PyImport_GetModuleId(struct _Py_Identifier *nameid)
328{
329 PyObject *name = _PyUnicode_FromId(nameid); /* borrowed */
330 if (name == NULL) {
331 return NULL;
332 }
333 return PyImport_GetModule(name);
334}
335
336int
337_PyImport_SetModule(PyObject *name, PyObject *m)
338{
339 PyObject *modules = PyImport_GetModuleDict();
340 return PyObject_SetItem(modules, name, m);
341}
342
343int
344_PyImport_SetModuleString(const char *name, PyObject *m)
345{
346 PyObject *modules = PyImport_GetModuleDict();
347 return PyMapping_SetItemString(modules, name, m);
348}
349
350PyObject *
351PyImport_GetModule(PyObject *name)
352{
353 PyObject *m;
354 PyObject *modules = PyImport_GetModuleDict();
355 if (modules == NULL) {
356 PyErr_SetString(PyExc_RuntimeError, "unable to get sys.modules");
357 return NULL;
358 }
359 Py_INCREF(modules);
360 if (PyDict_CheckExact(modules)) {
361 m = PyDict_GetItemWithError(modules, name); /* borrowed */
362 Py_XINCREF(m);
363 }
364 else {
365 m = PyObject_GetItem(modules, name);
Serhiy Storchakae9d94942018-04-25 20:58:40 +0300366 if (m == NULL && PyErr_ExceptionMatches(PyExc_KeyError)) {
Eric Snow3f9eee62017-09-15 16:35:20 -0600367 PyErr_Clear();
368 }
369 }
370 Py_DECREF(modules);
371 return m;
372}
373
374
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000375/* List of names to clear in sys */
Serhiy Storchaka2d06e842015-12-25 19:53:18 +0200376static const char * const sys_deletes[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000377 "path", "argv", "ps1", "ps2",
378 "last_type", "last_value", "last_traceback",
379 "path_hooks", "path_importer_cache", "meta_path",
Antoine Pitroudcedaf62013-07-31 23:14:08 +0200380 "__interactivehook__",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000381 /* misc stuff */
382 "flags", "float_info",
383 NULL
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000384};
385
Serhiy Storchaka2d06e842015-12-25 19:53:18 +0200386static const char * const sys_files[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000387 "stdin", "__stdin__",
388 "stdout", "__stdout__",
389 "stderr", "__stderr__",
390 NULL
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000391};
392
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000393/* Un-initialize things, as good as we can */
Guido van Rossum3f5da241990-12-20 15:06:42 +0000394
Guido van Rossum3f5da241990-12-20 15:06:42 +0000395void
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000396PyImport_Cleanup(void)
Guido van Rossum3f5da241990-12-20 15:06:42 +0000397{
Antoine Pitroudcedaf62013-07-31 23:14:08 +0200398 Py_ssize_t pos;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000399 PyObject *key, *value, *dict;
Victor Stinnercaba55b2018-08-03 15:33:52 +0200400 PyInterpreterState *interp = _PyInterpreterState_Get();
Eric Snowd393c1b2017-09-14 12:18:12 -0600401 PyObject *modules = PyImport_GetModuleDict();
Antoine Pitroudcedaf62013-07-31 23:14:08 +0200402 PyObject *weaklist = NULL;
Serhiy Storchaka2d06e842015-12-25 19:53:18 +0200403 const char * const *p;
Guido van Rossum758eec01998-01-19 21:58:26 +0000404
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000405 if (modules == NULL)
406 return; /* Already done */
Guido van Rossum758eec01998-01-19 21:58:26 +0000407
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000408 /* Delete some special variables first. These are common
409 places where user values hide and people complain when their
410 destructors fail. Since the modules containing them are
411 deleted *last* of all, they would come too late in the normal
412 destruction order. Sigh. */
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000413
Antoine Pitroudcedaf62013-07-31 23:14:08 +0200414 /* XXX Perhaps these precautions are obsolete. Who knows? */
415
Serhiy Storchaka013bb912014-02-10 18:21:34 +0200416 if (Py_VerboseFlag)
417 PySys_WriteStderr("# clear builtins._\n");
Serhiy Storchakae9d94942018-04-25 20:58:40 +0300418 if (PyDict_SetItemString(interp->builtins, "_", Py_None) < 0) {
Serhiy Storchakac1a68322018-04-29 22:16:30 +0300419 PyErr_WriteUnraisable(NULL);
Serhiy Storchakae9d94942018-04-25 20:58:40 +0300420 }
Serhiy Storchaka013bb912014-02-10 18:21:34 +0200421
422 for (p = sys_deletes; *p != NULL; p++) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000423 if (Py_VerboseFlag)
Serhiy Storchaka013bb912014-02-10 18:21:34 +0200424 PySys_WriteStderr("# clear sys.%s\n", *p);
Serhiy Storchakae9d94942018-04-25 20:58:40 +0300425 if (PyDict_SetItemString(interp->sysdict, *p, Py_None) < 0) {
Serhiy Storchakac1a68322018-04-29 22:16:30 +0300426 PyErr_WriteUnraisable(NULL);
Serhiy Storchakae9d94942018-04-25 20:58:40 +0300427 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000428 }
Serhiy Storchaka013bb912014-02-10 18:21:34 +0200429 for (p = sys_files; *p != NULL; p+=2) {
430 if (Py_VerboseFlag)
431 PySys_WriteStderr("# restore sys.%s\n", *p);
432 value = PyDict_GetItemString(interp->sysdict, *(p+1));
433 if (value == NULL)
434 value = Py_None;
Serhiy Storchakae9d94942018-04-25 20:58:40 +0300435 if (PyDict_SetItemString(interp->sysdict, *p, value) < 0) {
Serhiy Storchakac1a68322018-04-29 22:16:30 +0300436 PyErr_WriteUnraisable(NULL);
Serhiy Storchakae9d94942018-04-25 20:58:40 +0300437 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000438 }
Guido van Rossum05f9dce1998-02-19 20:58:44 +0000439
Antoine Pitroudcedaf62013-07-31 23:14:08 +0200440 /* We prepare a list which will receive (name, weakref) tuples of
441 modules when they are removed from sys.modules. The name is used
442 for diagnosis messages (in verbose mode), while the weakref helps
443 detect those modules which have been held alive. */
444 weaklist = PyList_New(0);
Serhiy Storchakac1a68322018-04-29 22:16:30 +0300445 if (weaklist == NULL) {
446 PyErr_WriteUnraisable(NULL);
447 }
Antoine Pitroudcedaf62013-07-31 23:14:08 +0200448
Antoine Pitrou79ba3882013-08-06 22:50:15 +0200449#define STORE_MODULE_WEAKREF(name, mod) \
Antoine Pitroudcedaf62013-07-31 23:14:08 +0200450 if (weaklist != NULL) { \
Antoine Pitroudcedaf62013-07-31 23:14:08 +0200451 PyObject *wr = PyWeakref_NewRef(mod, NULL); \
Serhiy Storchakae9d94942018-04-25 20:58:40 +0300452 if (wr) { \
Antoine Pitroudcedaf62013-07-31 23:14:08 +0200453 PyObject *tup = PyTuple_Pack(2, name, wr); \
Serhiy Storchakae9d94942018-04-25 20:58:40 +0300454 if (!tup || PyList_Append(weaklist, tup) < 0) { \
Serhiy Storchakac1a68322018-04-29 22:16:30 +0300455 PyErr_WriteUnraisable(NULL); \
Serhiy Storchakae9d94942018-04-25 20:58:40 +0300456 } \
Antoine Pitroudcedaf62013-07-31 23:14:08 +0200457 Py_XDECREF(tup); \
Serhiy Storchakae9d94942018-04-25 20:58:40 +0300458 Py_DECREF(wr); \
Antoine Pitroudcedaf62013-07-31 23:14:08 +0200459 } \
Serhiy Storchakae9d94942018-04-25 20:58:40 +0300460 else { \
Serhiy Storchakac1a68322018-04-29 22:16:30 +0300461 PyErr_WriteUnraisable(NULL); \
Serhiy Storchakae9d94942018-04-25 20:58:40 +0300462 } \
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000463 }
Eric Snow3f9eee62017-09-15 16:35:20 -0600464#define CLEAR_MODULE(name, mod) \
465 if (PyModule_Check(mod)) { \
466 if (Py_VerboseFlag && PyUnicode_Check(name)) \
467 PySys_FormatStderr("# cleanup[2] removing %U\n", name); \
468 STORE_MODULE_WEAKREF(name, mod); \
Serhiy Storchakae9d94942018-04-25 20:58:40 +0300469 if (PyObject_SetItem(modules, name, Py_None) < 0) { \
Serhiy Storchakac1a68322018-04-29 22:16:30 +0300470 PyErr_WriteUnraisable(NULL); \
Serhiy Storchakae9d94942018-04-25 20:58:40 +0300471 } \
Eric Snow3f9eee62017-09-15 16:35:20 -0600472 }
Guido van Rossuma0fec2b1998-02-06 17:16:02 +0000473
Antoine Pitroudcedaf62013-07-31 23:14:08 +0200474 /* Remove all modules from sys.modules, hoping that garbage collection
475 can reclaim most of them. */
Eric Snow3f9eee62017-09-15 16:35:20 -0600476 if (PyDict_CheckExact(modules)) {
477 pos = 0;
478 while (PyDict_Next(modules, &pos, &key, &value)) {
479 CLEAR_MODULE(key, value);
480 }
481 }
482 else {
483 PyObject *iterator = PyObject_GetIter(modules);
484 if (iterator == NULL) {
Serhiy Storchakac1a68322018-04-29 22:16:30 +0300485 PyErr_WriteUnraisable(NULL);
Eric Snow3f9eee62017-09-15 16:35:20 -0600486 }
487 else {
488 while ((key = PyIter_Next(iterator))) {
489 value = PyObject_GetItem(modules, key);
490 if (value == NULL) {
Serhiy Storchakac1a68322018-04-29 22:16:30 +0300491 PyErr_WriteUnraisable(NULL);
Eric Snow3f9eee62017-09-15 16:35:20 -0600492 continue;
493 }
494 CLEAR_MODULE(key, value);
495 Py_DECREF(value);
496 Py_DECREF(key);
497 }
Serhiy Storchakae9d94942018-04-25 20:58:40 +0300498 if (PyErr_Occurred()) {
Serhiy Storchakac1a68322018-04-29 22:16:30 +0300499 PyErr_WriteUnraisable(NULL);
Serhiy Storchakae9d94942018-04-25 20:58:40 +0300500 }
Eric Snow3f9eee62017-09-15 16:35:20 -0600501 Py_DECREF(iterator);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000502 }
503 }
Guido van Rossum758eec01998-01-19 21:58:26 +0000504
Antoine Pitroudcedaf62013-07-31 23:14:08 +0200505 /* Clear the modules dict. */
Eric Snow3f9eee62017-09-15 16:35:20 -0600506 if (PyDict_CheckExact(modules)) {
507 PyDict_Clear(modules);
508 }
509 else {
510 _Py_IDENTIFIER(clear);
Serhiy Storchakac1a68322018-04-29 22:16:30 +0300511 if (_PyObject_CallMethodId(modules, &PyId_clear, "") == NULL) {
512 PyErr_WriteUnraisable(NULL);
513 }
Eric Snow3f9eee62017-09-15 16:35:20 -0600514 }
Serhiy Storchaka013bb912014-02-10 18:21:34 +0200515 /* Restore the original builtins dict, to ensure that any
516 user data gets cleared. */
517 dict = PyDict_Copy(interp->builtins);
Serhiy Storchakac1a68322018-04-29 22:16:30 +0300518 if (dict == NULL) {
519 PyErr_WriteUnraisable(NULL);
520 }
Serhiy Storchaka013bb912014-02-10 18:21:34 +0200521 PyDict_Clear(interp->builtins);
Serhiy Storchakac1a68322018-04-29 22:16:30 +0300522 if (PyDict_Update(interp->builtins, interp->builtins_copy)) {
Serhiy Storchaka013bb912014-02-10 18:21:34 +0200523 PyErr_Clear();
Serhiy Storchakac1a68322018-04-29 22:16:30 +0300524 }
Serhiy Storchaka013bb912014-02-10 18:21:34 +0200525 Py_XDECREF(dict);
Antoine Pitrou40322e62013-08-11 00:30:09 +0200526 /* Clear module dict copies stored in the interpreter state */
527 _PyState_ClearModules();
Antoine Pitroudcedaf62013-07-31 23:14:08 +0200528 /* Collect references */
529 _PyGC_CollectNoFail();
Antoine Pitrou5f454a02013-05-06 21:15:57 +0200530 /* Dump GC stats before it's too late, since it uses the warnings
531 machinery. */
532 _PyGC_DumpShutdownStats();
533
Antoine Pitroudcedaf62013-07-31 23:14:08 +0200534 /* Now, if there are any modules left alive, clear their globals to
535 minimize potential leaks. All C extension modules actually end
Serhiy Storchaka013bb912014-02-10 18:21:34 +0200536 up here, since they are kept alive in the interpreter state.
537
538 The special treatment of "builtins" here is because even
539 when it's not referenced as a module, its dictionary is
540 referenced by almost every module's __builtins__. Since
541 deleting a module clears its dictionary (even if there are
542 references left to it), we need to delete the "builtins"
543 module last. Likewise, we don't delete sys until the very
544 end because it is implicitly referenced (e.g. by print). */
Antoine Pitroudcedaf62013-07-31 23:14:08 +0200545 if (weaklist != NULL) {
546 Py_ssize_t i, n;
547 n = PyList_GET_SIZE(weaklist);
548 for (i = 0; i < n; i++) {
549 PyObject *tup = PyList_GET_ITEM(weaklist, i);
Antoine Pitrou79ba3882013-08-06 22:50:15 +0200550 PyObject *name = PyTuple_GET_ITEM(tup, 0);
Antoine Pitroudcedaf62013-07-31 23:14:08 +0200551 PyObject *mod = PyWeakref_GET_OBJECT(PyTuple_GET_ITEM(tup, 1));
552 if (mod == Py_None)
553 continue;
Antoine Pitroudcedaf62013-07-31 23:14:08 +0200554 assert(PyModule_Check(mod));
Serhiy Storchaka013bb912014-02-10 18:21:34 +0200555 dict = PyModule_GetDict(mod);
556 if (dict == interp->builtins || dict == interp->sysdict)
557 continue;
558 Py_INCREF(mod);
Antoine Pitrou79ba3882013-08-06 22:50:15 +0200559 if (Py_VerboseFlag && PyUnicode_Check(name))
Serhiy Storchaka013bb912014-02-10 18:21:34 +0200560 PySys_FormatStderr("# cleanup[3] wiping %U\n", name);
Antoine Pitroudcedaf62013-07-31 23:14:08 +0200561 _PyModule_Clear(mod);
562 Py_DECREF(mod);
Antoine Pitrou070cb3c2013-05-08 13:23:25 +0200563 }
Antoine Pitroudcedaf62013-07-31 23:14:08 +0200564 Py_DECREF(weaklist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000565 }
Guido van Rossum758eec01998-01-19 21:58:26 +0000566
Serhiy Storchaka013bb912014-02-10 18:21:34 +0200567 /* Next, delete sys and builtins (in that order) */
568 if (Py_VerboseFlag)
569 PySys_FormatStderr("# cleanup[3] wiping sys\n");
570 _PyModule_ClearDict(interp->sysdict);
571 if (Py_VerboseFlag)
572 PySys_FormatStderr("# cleanup[3] wiping builtins\n");
573 _PyModule_ClearDict(interp->builtins);
574
Antoine Pitroudcedaf62013-07-31 23:14:08 +0200575 /* Clear and delete the modules directory. Actual modules will
576 still be there only if imported during the execution of some
577 destructor. */
Eric Snow93c92f72017-09-13 23:46:04 -0700578 interp->modules = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000579 Py_DECREF(modules);
Antoine Pitroudcedaf62013-07-31 23:14:08 +0200580
581 /* Once more */
582 _PyGC_CollectNoFail();
583
Serhiy Storchakae9d94942018-04-25 20:58:40 +0300584#undef CLEAR_MODULE
Antoine Pitroudcedaf62013-07-31 23:14:08 +0200585#undef STORE_MODULE_WEAKREF
Guido van Rossum8d15b5d1990-10-26 14:58:58 +0000586}
Guido van Rossum7f133ed1991-02-19 12:23:57 +0000587
588
Barry Warsaw28a691b2010-04-17 00:19:56 +0000589/* Helper for pythonrun.c -- return magic number and tag. */
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000590
591long
Thomas Woutersf70ef4f2000-07-22 18:47:25 +0000592PyImport_GetMagicNumber(void)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000593{
Antoine Pitrou44b4b6a2012-07-10 18:27:54 +0200594 long res;
Victor Stinnercaba55b2018-08-03 15:33:52 +0200595 PyInterpreterState *interp = _PyInterpreterState_Get();
Eric Snow32439d62015-05-02 19:15:18 -0600596 PyObject *external, *pyc_magic;
597
598 external = PyObject_GetAttrString(interp->importlib, "_bootstrap_external");
599 if (external == NULL)
600 return -1;
601 pyc_magic = PyObject_GetAttrString(external, "_RAW_MAGIC_NUMBER");
602 Py_DECREF(external);
Brett Cannon77b2abd2012-07-09 16:09:00 -0400603 if (pyc_magic == NULL)
604 return -1;
Antoine Pitrou44b4b6a2012-07-10 18:27:54 +0200605 res = PyLong_AsLong(pyc_magic);
Benjamin Peterson66f36592012-07-09 22:21:55 -0700606 Py_DECREF(pyc_magic);
607 return res;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000608}
609
610
Brett Cannon3adc7b72012-07-09 14:22:12 -0400611extern const char * _PySys_ImplCacheTag;
612
Barry Warsaw28a691b2010-04-17 00:19:56 +0000613const char *
614PyImport_GetMagicTag(void)
615{
Brett Cannon3adc7b72012-07-09 14:22:12 -0400616 return _PySys_ImplCacheTag;
Barry Warsaw28a691b2010-04-17 00:19:56 +0000617}
618
Brett Cannon98979b82012-07-02 15:13:11 -0400619
Guido van Rossum25ce5661997-08-02 03:10:38 +0000620/* Magic for extension modules (built-in as well as dynamically
621 loaded). To prevent initializing an extension module more than
Andrew Svetlov6b2cbeb2012-12-14 17:04:59 +0200622 once, we keep a static dictionary 'extensions' keyed by the tuple
623 (module name, module name) (for built-in modules) or by
624 (filename, module name) (for dynamically loaded modules), containing these
625 modules. A copy of the module's dictionary is stored by calling
626 _PyImport_FixupExtensionObject() immediately after the module initialization
627 function succeeds. A copy can be retrieved from there by calling
Victor Stinner95872862011-03-07 18:20:56 +0100628 _PyImport_FindExtensionObject().
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000629
Barry Warsaw7c9627b2010-06-17 18:38:20 +0000630 Modules which do support multiple initialization set their m_size
631 field to a non-negative number (indicating the size of the
632 module-specific state). They are still recorded in the extensions
633 dictionary, to avoid loading shared libraries twice.
Martin v. Löwis1a214512008-06-11 05:26:20 +0000634*/
635
636int
Victor Stinner95872862011-03-07 18:20:56 +0100637_PyImport_FixupExtensionObject(PyObject *mod, PyObject *name,
Eric Snowd393c1b2017-09-14 12:18:12 -0600638 PyObject *filename, PyObject *modules)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000639{
Eric Snowd393c1b2017-09-14 12:18:12 -0600640 PyObject *dict, *key;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000641 struct PyModuleDef *def;
Benjamin Peterson5cb8a312012-12-15 00:05:16 -0500642 int res;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000643 if (extensions == NULL) {
644 extensions = PyDict_New();
645 if (extensions == NULL)
646 return -1;
647 }
648 if (mod == NULL || !PyModule_Check(mod)) {
649 PyErr_BadInternalCall();
650 return -1;
651 }
652 def = PyModule_GetDef(mod);
653 if (!def) {
654 PyErr_BadInternalCall();
655 return -1;
656 }
Eric Snow3f9eee62017-09-15 16:35:20 -0600657 if (PyObject_SetItem(modules, name, mod) < 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000658 return -1;
659 if (_PyState_AddModule(mod, def) < 0) {
Eric Snow3f9eee62017-09-15 16:35:20 -0600660 PyMapping_DelItem(modules, name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000661 return -1;
662 }
663 if (def->m_size == -1) {
664 if (def->m_base.m_copy) {
665 /* Somebody already imported the module,
666 likely under a different name.
667 XXX this should really not happen. */
Serhiy Storchaka505ff752014-02-09 13:33:53 +0200668 Py_CLEAR(def->m_base.m_copy);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000669 }
670 dict = PyModule_GetDict(mod);
671 if (dict == NULL)
672 return -1;
673 def->m_base.m_copy = PyDict_Copy(dict);
674 if (def->m_base.m_copy == NULL)
675 return -1;
676 }
Benjamin Peterson5cb8a312012-12-15 00:05:16 -0500677 key = PyTuple_Pack(2, filename, name);
678 if (key == NULL)
Andrew Svetlov6b2cbeb2012-12-14 17:04:59 +0200679 return -1;
Benjamin Peterson5cb8a312012-12-15 00:05:16 -0500680 res = PyDict_SetItem(extensions, key, (PyObject *)def);
681 Py_DECREF(key);
682 if (res < 0)
Andrew Svetlov6b2cbeb2012-12-14 17:04:59 +0200683 return -1;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000684 return 0;
Guido van Rossum25ce5661997-08-02 03:10:38 +0000685}
686
Victor Stinner49d3f252010-10-17 01:24:53 +0000687int
Eric Snowd393c1b2017-09-14 12:18:12 -0600688_PyImport_FixupBuiltin(PyObject *mod, const char *name, PyObject *modules)
Victor Stinner49d3f252010-10-17 01:24:53 +0000689{
690 int res;
Victor Stinner95872862011-03-07 18:20:56 +0100691 PyObject *nameobj;
Victor Stinner21fcd0c2011-03-07 18:28:15 +0100692 nameobj = PyUnicode_InternFromString(name);
Victor Stinner95872862011-03-07 18:20:56 +0100693 if (nameobj == NULL)
Victor Stinner49d3f252010-10-17 01:24:53 +0000694 return -1;
Eric Snowd393c1b2017-09-14 12:18:12 -0600695 res = _PyImport_FixupExtensionObject(mod, nameobj, nameobj, modules);
Victor Stinner95872862011-03-07 18:20:56 +0100696 Py_DECREF(nameobj);
Victor Stinner49d3f252010-10-17 01:24:53 +0000697 return res;
698}
699
Guido van Rossum25ce5661997-08-02 03:10:38 +0000700PyObject *
Victor Stinner95872862011-03-07 18:20:56 +0100701_PyImport_FindExtensionObject(PyObject *name, PyObject *filename)
Guido van Rossum25ce5661997-08-02 03:10:38 +0000702{
Eric Snowd393c1b2017-09-14 12:18:12 -0600703 PyObject *modules = PyImport_GetModuleDict();
704 return _PyImport_FindExtensionObjectEx(name, filename, modules);
705}
706
707PyObject *
708_PyImport_FindExtensionObjectEx(PyObject *name, PyObject *filename,
709 PyObject *modules)
710{
Benjamin Peterson5cb8a312012-12-15 00:05:16 -0500711 PyObject *mod, *mdict, *key;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000712 PyModuleDef* def;
713 if (extensions == NULL)
714 return NULL;
Benjamin Peterson5cb8a312012-12-15 00:05:16 -0500715 key = PyTuple_Pack(2, filename, name);
716 if (key == NULL)
Andrew Svetlov6b2cbeb2012-12-14 17:04:59 +0200717 return NULL;
Benjamin Peterson5cb8a312012-12-15 00:05:16 -0500718 def = (PyModuleDef *)PyDict_GetItem(extensions, key);
719 Py_DECREF(key);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000720 if (def == NULL)
721 return NULL;
722 if (def->m_size == -1) {
723 /* Module does not support repeated initialization */
724 if (def->m_base.m_copy == NULL)
725 return NULL;
Eric Snowd393c1b2017-09-14 12:18:12 -0600726 mod = _PyImport_AddModuleObject(name, modules);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000727 if (mod == NULL)
728 return NULL;
729 mdict = PyModule_GetDict(mod);
730 if (mdict == NULL)
731 return NULL;
732 if (PyDict_Update(mdict, def->m_base.m_copy))
733 return NULL;
734 }
735 else {
736 if (def->m_base.m_init == NULL)
737 return NULL;
738 mod = def->m_base.m_init();
739 if (mod == NULL)
740 return NULL;
Eric Snow3f9eee62017-09-15 16:35:20 -0600741 if (PyObject_SetItem(modules, name, mod) == -1) {
Christian Heimes09ca7942013-07-20 14:51:53 +0200742 Py_DECREF(mod);
743 return NULL;
744 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000745 Py_DECREF(mod);
746 }
747 if (_PyState_AddModule(mod, def) < 0) {
Eric Snow3f9eee62017-09-15 16:35:20 -0600748 PyMapping_DelItem(modules, name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000749 Py_DECREF(mod);
750 return NULL;
751 }
752 if (Py_VerboseFlag)
Victor Stinner95872862011-03-07 18:20:56 +0100753 PySys_FormatStderr("import %U # previously loaded (%R)\n",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000754 name, filename);
755 return mod;
Brett Cannon9a5b25a2010-03-01 02:09:17 +0000756
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000757}
758
Victor Stinner49d3f252010-10-17 01:24:53 +0000759PyObject *
Eric Snowd393c1b2017-09-14 12:18:12 -0600760_PyImport_FindBuiltin(const char *name, PyObject *modules)
Victor Stinner49d3f252010-10-17 01:24:53 +0000761{
Victor Stinner95872862011-03-07 18:20:56 +0100762 PyObject *res, *nameobj;
Victor Stinner21fcd0c2011-03-07 18:28:15 +0100763 nameobj = PyUnicode_InternFromString(name);
Victor Stinner95872862011-03-07 18:20:56 +0100764 if (nameobj == NULL)
Victor Stinner49d3f252010-10-17 01:24:53 +0000765 return NULL;
Eric Snowd393c1b2017-09-14 12:18:12 -0600766 res = _PyImport_FindExtensionObjectEx(nameobj, nameobj, modules);
Victor Stinner95872862011-03-07 18:20:56 +0100767 Py_DECREF(nameobj);
Victor Stinner49d3f252010-10-17 01:24:53 +0000768 return res;
769}
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000770
771/* Get the module object corresponding to a module name.
772 First check the modules dictionary if there's one there,
Walter Dörwaldf0dfc7a2003-10-20 14:01:56 +0000773 if not, create a new one and insert it in the modules dictionary.
Guido van Rossum7f9fa971995-01-20 16:53:12 +0000774 Because the former action is most common, THIS DOES NOT RETURN A
775 'NEW' REFERENCE! */
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000776
Guido van Rossum79f25d91997-04-29 20:08:16 +0000777PyObject *
Victor Stinner27ee0892011-03-04 12:57:09 +0000778PyImport_AddModuleObject(PyObject *name)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000779{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000780 PyObject *modules = PyImport_GetModuleDict();
Eric Snowd393c1b2017-09-14 12:18:12 -0600781 return _PyImport_AddModuleObject(name, modules);
782}
783
784PyObject *
785_PyImport_AddModuleObject(PyObject *name, PyObject *modules)
786{
Eric Snow86b7afd2017-09-04 17:54:09 -0600787 PyObject *m;
Eric Snow3f9eee62017-09-15 16:35:20 -0600788 if (PyDict_CheckExact(modules)) {
789 m = PyDict_GetItemWithError(modules, name);
790 }
791 else {
792 m = PyObject_GetItem(modules, name);
793 // For backward-comaptibility we copy the behavior
794 // of PyDict_GetItemWithError().
795 if (PyErr_ExceptionMatches(PyExc_KeyError)) {
796 PyErr_Clear();
797 }
Serhiy Storchaka48a583b2016-02-10 10:31:20 +0200798 }
799 if (PyErr_Occurred()) {
800 return NULL;
801 }
Eric Snow3f9eee62017-09-15 16:35:20 -0600802 if (m != NULL && PyModule_Check(m)) {
803 return m;
804 }
Victor Stinner27ee0892011-03-04 12:57:09 +0000805 m = PyModule_NewObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000806 if (m == NULL)
807 return NULL;
Eric Snow3f9eee62017-09-15 16:35:20 -0600808 if (PyObject_SetItem(modules, name, m) != 0) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000809 Py_DECREF(m);
810 return NULL;
811 }
812 Py_DECREF(m); /* Yes, it still exists, in modules! */
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000813
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000814 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000815}
816
Victor Stinner27ee0892011-03-04 12:57:09 +0000817PyObject *
818PyImport_AddModule(const char *name)
819{
820 PyObject *nameobj, *module;
821 nameobj = PyUnicode_FromString(name);
822 if (nameobj == NULL)
823 return NULL;
824 module = PyImport_AddModuleObject(nameobj);
825 Py_DECREF(nameobj);
826 return module;
827}
828
829
Tim Peters1cd70172004-08-02 03:52:12 +0000830/* Remove name from sys.modules, if it's there. */
831static void
Victor Stinner27ee0892011-03-04 12:57:09 +0000832remove_module(PyObject *name)
Tim Peters1cd70172004-08-02 03:52:12 +0000833{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000834 PyObject *modules = PyImport_GetModuleDict();
Eric Snow3f9eee62017-09-15 16:35:20 -0600835 if (PyMapping_DelItem(modules, name) < 0) {
836 if (!PyMapping_HasKey(modules, name)) {
837 return;
838 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000839 Py_FatalError("import: deleting existing key in"
840 "sys.modules failed");
Eric Snow3f9eee62017-09-15 16:35:20 -0600841 }
Tim Peters1cd70172004-08-02 03:52:12 +0000842}
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000843
Christian Heimes3b06e532008-01-07 20:12:44 +0000844
Guido van Rossum7f9fa971995-01-20 16:53:12 +0000845/* Execute a code object in a module and return the module object
Tim Peters1cd70172004-08-02 03:52:12 +0000846 * WITH INCREMENTED REFERENCE COUNT. If an error occurs, name is
847 * removed from sys.modules, to avoid leaving damaged module objects
848 * in sys.modules. The caller may wish to restore the original
849 * module object (if any) in this case; PyImport_ReloadModule is an
850 * example.
Barry Warsaw28a691b2010-04-17 00:19:56 +0000851 *
852 * Note that PyImport_ExecCodeModuleWithPathnames() is the preferred, richer
853 * interface. The other two exist primarily for backward compatibility.
Tim Peters1cd70172004-08-02 03:52:12 +0000854 */
Guido van Rossum79f25d91997-04-29 20:08:16 +0000855PyObject *
Serhiy Storchakac6792272013-10-19 21:03:34 +0300856PyImport_ExecCodeModule(const char *name, PyObject *co)
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000857{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000858 return PyImport_ExecCodeModuleWithPathnames(
859 name, co, (char *)NULL, (char *)NULL);
Guido van Rossume32bf6e1998-02-11 05:53:02 +0000860}
861
862PyObject *
Serhiy Storchakac6792272013-10-19 21:03:34 +0300863PyImport_ExecCodeModuleEx(const char *name, PyObject *co, const char *pathname)
Guido van Rossume32bf6e1998-02-11 05:53:02 +0000864{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000865 return PyImport_ExecCodeModuleWithPathnames(
866 name, co, pathname, (char *)NULL);
Barry Warsaw28a691b2010-04-17 00:19:56 +0000867}
868
869PyObject *
Serhiy Storchakac6792272013-10-19 21:03:34 +0300870PyImport_ExecCodeModuleWithPathnames(const char *name, PyObject *co,
871 const char *pathname,
872 const char *cpathname)
Barry Warsaw28a691b2010-04-17 00:19:56 +0000873{
Victor Stinner27ee0892011-03-04 12:57:09 +0000874 PyObject *m = NULL;
Eric Snow32439d62015-05-02 19:15:18 -0600875 PyObject *nameobj, *pathobj = NULL, *cpathobj = NULL, *external= NULL;
Victor Stinner27ee0892011-03-04 12:57:09 +0000876
877 nameobj = PyUnicode_FromString(name);
878 if (nameobj == NULL)
879 return NULL;
880
Victor Stinner27ee0892011-03-04 12:57:09 +0000881 if (cpathname != NULL) {
882 cpathobj = PyUnicode_DecodeFSDefault(cpathname);
883 if (cpathobj == NULL)
884 goto error;
Brett Cannona6473f92012-07-13 13:57:03 -0400885 }
886 else
Victor Stinner27ee0892011-03-04 12:57:09 +0000887 cpathobj = NULL;
Brett Cannona6473f92012-07-13 13:57:03 -0400888
889 if (pathname != NULL) {
890 pathobj = PyUnicode_DecodeFSDefault(pathname);
891 if (pathobj == NULL)
892 goto error;
893 }
894 else if (cpathobj != NULL) {
Victor Stinnercaba55b2018-08-03 15:33:52 +0200895 PyInterpreterState *interp = _PyInterpreterState_GET_UNSAFE();
Brett Cannona6473f92012-07-13 13:57:03 -0400896 _Py_IDENTIFIER(_get_sourcefile);
897
898 if (interp == NULL) {
899 Py_FatalError("PyImport_ExecCodeModuleWithPathnames: "
900 "no interpreter!");
901 }
902
Eric Snow32439d62015-05-02 19:15:18 -0600903 external= PyObject_GetAttrString(interp->importlib,
904 "_bootstrap_external");
905 if (external != NULL) {
906 pathobj = _PyObject_CallMethodIdObjArgs(external,
907 &PyId__get_sourcefile, cpathobj,
908 NULL);
909 Py_DECREF(external);
910 }
Brett Cannona6473f92012-07-13 13:57:03 -0400911 if (pathobj == NULL)
912 PyErr_Clear();
913 }
914 else
915 pathobj = NULL;
916
Victor Stinner27ee0892011-03-04 12:57:09 +0000917 m = PyImport_ExecCodeModuleObject(nameobj, co, pathobj, cpathobj);
918error:
919 Py_DECREF(nameobj);
920 Py_XDECREF(pathobj);
921 Py_XDECREF(cpathobj);
922 return m;
923}
924
Brett Cannon18fc4e72014-04-04 10:01:46 -0400925static PyObject *
926module_dict_for_exec(PyObject *name)
Victor Stinner27ee0892011-03-04 12:57:09 +0000927{
Brett Cannon18fc4e72014-04-04 10:01:46 -0400928 PyObject *m, *d = NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000929
Victor Stinner27ee0892011-03-04 12:57:09 +0000930 m = PyImport_AddModuleObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000931 if (m == NULL)
932 return NULL;
933 /* If the module is being reloaded, we get the old module back
934 and re-use its dict to exec the new code. */
935 d = PyModule_GetDict(m);
936 if (PyDict_GetItemString(d, "__builtins__") == NULL) {
937 if (PyDict_SetItemString(d, "__builtins__",
Brett Cannon18fc4e72014-04-04 10:01:46 -0400938 PyEval_GetBuiltins()) != 0) {
939 remove_module(name);
940 return NULL;
941 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000942 }
Brett Cannon18fc4e72014-04-04 10:01:46 -0400943
Eric Snow08197a42014-05-12 17:54:55 -0600944 return d; /* Return a borrowed reference. */
Brett Cannon18fc4e72014-04-04 10:01:46 -0400945}
946
947static PyObject *
948exec_code_in_module(PyObject *name, PyObject *module_dict, PyObject *code_object)
949{
Brett Cannon18fc4e72014-04-04 10:01:46 -0400950 PyObject *v, *m;
951
952 v = PyEval_EvalCode(code_object, module_dict, module_dict);
953 if (v == NULL) {
954 remove_module(name);
955 return NULL;
956 }
957 Py_DECREF(v);
958
Eric Snow3f9eee62017-09-15 16:35:20 -0600959 m = PyImport_GetModule(name);
960 if (m == NULL) {
Brett Cannon18fc4e72014-04-04 10:01:46 -0400961 PyErr_Format(PyExc_ImportError,
962 "Loaded module %R not found in sys.modules",
963 name);
964 return NULL;
965 }
966
Brett Cannon18fc4e72014-04-04 10:01:46 -0400967 return m;
968}
969
970PyObject*
971PyImport_ExecCodeModuleObject(PyObject *name, PyObject *co, PyObject *pathname,
972 PyObject *cpathname)
973{
Eric Snow32439d62015-05-02 19:15:18 -0600974 PyObject *d, *external, *res;
Victor Stinnercaba55b2018-08-03 15:33:52 +0200975 PyInterpreterState *interp = _PyInterpreterState_GET_UNSAFE();
Eric Snow08197a42014-05-12 17:54:55 -0600976 _Py_IDENTIFIER(_fix_up_module);
Brett Cannon18fc4e72014-04-04 10:01:46 -0400977
978 d = module_dict_for_exec(name);
979 if (d == NULL) {
980 return NULL;
981 }
982
Eric Snow08197a42014-05-12 17:54:55 -0600983 if (pathname == NULL) {
984 pathname = ((PyCodeObject *)co)->co_filename;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000985 }
Eric Snow32439d62015-05-02 19:15:18 -0600986 external = PyObject_GetAttrString(interp->importlib, "_bootstrap_external");
987 if (external == NULL)
988 return NULL;
989 res = _PyObject_CallMethodIdObjArgs(external,
Eric Snow08197a42014-05-12 17:54:55 -0600990 &PyId__fix_up_module,
991 d, name, pathname, cpathname, NULL);
Eric Snow32439d62015-05-02 19:15:18 -0600992 Py_DECREF(external);
Eric Snow08197a42014-05-12 17:54:55 -0600993 if (res != NULL) {
Eric Snow58cfdd82014-05-29 12:31:39 -0600994 Py_DECREF(res);
Eric Snow08197a42014-05-12 17:54:55 -0600995 res = exec_code_in_module(name, d, co);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000996 }
Eric Snow08197a42014-05-12 17:54:55 -0600997 return res;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000998}
999
1000
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001001static void
1002update_code_filenames(PyCodeObject *co, PyObject *oldname, PyObject *newname)
1003{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001004 PyObject *constants, *tmp;
1005 Py_ssize_t i, n;
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001006
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001007 if (PyUnicode_Compare(co->co_filename, oldname))
1008 return;
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001009
Serhiy Storchaka576f1322016-01-05 21:27:54 +02001010 Py_INCREF(newname);
Serhiy Storchakaec397562016-04-06 09:50:03 +03001011 Py_XSETREF(co->co_filename, newname);
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001012
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001013 constants = co->co_consts;
1014 n = PyTuple_GET_SIZE(constants);
1015 for (i = 0; i < n; i++) {
1016 tmp = PyTuple_GET_ITEM(constants, i);
1017 if (PyCode_Check(tmp))
1018 update_code_filenames((PyCodeObject *)tmp,
1019 oldname, newname);
1020 }
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001021}
1022
Victor Stinner2f42ae52011-03-20 00:41:24 +01001023static void
1024update_compiled_module(PyCodeObject *co, PyObject *newname)
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001025{
Victor Stinner2f42ae52011-03-20 00:41:24 +01001026 PyObject *oldname;
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001027
Victor Stinner2f42ae52011-03-20 00:41:24 +01001028 if (PyUnicode_Compare(co->co_filename, newname) == 0)
1029 return;
Hirokazu Yamamoto4f447fb2009-03-04 01:52:10 +00001030
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001031 oldname = co->co_filename;
1032 Py_INCREF(oldname);
1033 update_code_filenames(co, oldname, newname);
1034 Py_DECREF(oldname);
Antoine Pitroud35cbf62009-01-06 19:02:24 +00001035}
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001036
Brett Cannon4caa61d2014-01-09 19:03:32 -05001037/*[clinic input]
1038_imp._fix_co_filename
1039
1040 code: object(type="PyCodeObject *", subclass_of="&PyCode_Type")
1041 Code object to change.
1042
1043 path: unicode
1044 File path to use.
1045 /
1046
1047Changes code.co_filename to specify the passed-in file path.
1048[clinic start generated code]*/
1049
Brett Cannon4caa61d2014-01-09 19:03:32 -05001050static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03001051_imp__fix_co_filename_impl(PyObject *module, PyCodeObject *code,
Larry Hastings89964c42015-04-14 18:07:59 -04001052 PyObject *path)
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03001053/*[clinic end generated code: output=1d002f100235587d input=895ba50e78b82f05]*/
Brett Cannon442c9b92011-03-23 16:14:42 -07001054
Brett Cannon4caa61d2014-01-09 19:03:32 -05001055{
Brett Cannona6dec2e2014-01-10 07:43:55 -05001056 update_compiled_module(code, path);
Brett Cannon442c9b92011-03-23 16:14:42 -07001057
1058 Py_RETURN_NONE;
1059}
1060
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001061
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001062/* Forward */
Benjamin Peterson6fba3db2013-03-18 23:13:31 -07001063static const struct _frozen * find_frozen(PyObject *);
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001064
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001065
1066/* Helper to test for built-in module */
1067
1068static int
Victor Stinner95872862011-03-07 18:20:56 +01001069is_builtin(PyObject *name)
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001070{
Serhiy Storchakaf4934ea2016-11-16 10:17:58 +02001071 int i;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001072 for (i = 0; PyImport_Inittab[i].name != NULL; i++) {
Serhiy Storchakaf4934ea2016-11-16 10:17:58 +02001073 if (_PyUnicode_EqualToASCIIString(name, PyImport_Inittab[i].name)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001074 if (PyImport_Inittab[i].initfunc == NULL)
1075 return -1;
1076 else
1077 return 1;
1078 }
1079 }
1080 return 0;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001081}
1082
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001083
Brett Cannonfdcdd9e2016-07-08 11:00:00 -07001084/* Return a finder object for a sys.path/pkg.__path__ item 'p',
Just van Rossum52e14d62002-12-30 22:08:05 +00001085 possibly by fetching it from the path_importer_cache dict. If it
Thomas Wouters89f507f2006-12-13 04:49:30 +00001086 wasn't yet cached, traverse path_hooks until a hook is found
Just van Rossum52e14d62002-12-30 22:08:05 +00001087 that can handle the path item. Return None if no hook could;
Brett Cannonfdcdd9e2016-07-08 11:00:00 -07001088 this tells our caller that the path based finder could not find
1089 a finder for this path item. Cache the result in
1090 path_importer_cache.
Just van Rossum52e14d62002-12-30 22:08:05 +00001091 Returns a borrowed reference. */
1092
1093static PyObject *
1094get_path_importer(PyObject *path_importer_cache, PyObject *path_hooks,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001095 PyObject *p)
Just van Rossum52e14d62002-12-30 22:08:05 +00001096{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001097 PyObject *importer;
1098 Py_ssize_t j, nhooks;
Just van Rossum52e14d62002-12-30 22:08:05 +00001099
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001100 /* These conditions are the caller's responsibility: */
1101 assert(PyList_Check(path_hooks));
1102 assert(PyDict_Check(path_importer_cache));
Just van Rossum52e14d62002-12-30 22:08:05 +00001103
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001104 nhooks = PyList_Size(path_hooks);
1105 if (nhooks < 0)
1106 return NULL; /* Shouldn't happen */
Just van Rossum52e14d62002-12-30 22:08:05 +00001107
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001108 importer = PyDict_GetItem(path_importer_cache, p);
1109 if (importer != NULL)
1110 return importer;
Just van Rossum52e14d62002-12-30 22:08:05 +00001111
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001112 /* set path_importer_cache[p] to None to avoid recursion */
1113 if (PyDict_SetItem(path_importer_cache, p, Py_None) != 0)
1114 return NULL;
Just van Rossum52e14d62002-12-30 22:08:05 +00001115
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001116 for (j = 0; j < nhooks; j++) {
1117 PyObject *hook = PyList_GetItem(path_hooks, j);
1118 if (hook == NULL)
1119 return NULL;
Victor Stinnerde4ae3d2016-12-04 22:59:09 +01001120 importer = PyObject_CallFunctionObjArgs(hook, p, NULL);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001121 if (importer != NULL)
1122 break;
Just van Rossum52e14d62002-12-30 22:08:05 +00001123
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001124 if (!PyErr_ExceptionMatches(PyExc_ImportError)) {
1125 return NULL;
1126 }
1127 PyErr_Clear();
1128 }
1129 if (importer == NULL) {
Brett Cannonaa936422012-04-27 15:30:58 -04001130 return Py_None;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001131 }
1132 if (importer != NULL) {
1133 int err = PyDict_SetItem(path_importer_cache, p, importer);
1134 Py_DECREF(importer);
1135 if (err != 0)
1136 return NULL;
1137 }
1138 return importer;
Just van Rossum52e14d62002-12-30 22:08:05 +00001139}
1140
Christian Heimes9cd17752007-11-18 19:35:23 +00001141PyAPI_FUNC(PyObject *)
1142PyImport_GetImporter(PyObject *path) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001143 PyObject *importer=NULL, *path_importer_cache=NULL, *path_hooks=NULL;
Christian Heimes9cd17752007-11-18 19:35:23 +00001144
Victor Stinner1e53bba2013-07-16 22:26:05 +02001145 path_importer_cache = PySys_GetObject("path_importer_cache");
1146 path_hooks = PySys_GetObject("path_hooks");
1147 if (path_importer_cache != NULL && path_hooks != NULL) {
1148 importer = get_path_importer(path_importer_cache,
1149 path_hooks, path);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001150 }
1151 Py_XINCREF(importer); /* get_path_importer returns a borrowed reference */
1152 return importer;
Christian Heimes9cd17752007-11-18 19:35:23 +00001153}
1154
Nick Coghland5cacbb2015-05-23 22:24:10 +10001155/*[clinic input]
1156_imp.create_builtin
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001157
Nick Coghland5cacbb2015-05-23 22:24:10 +10001158 spec: object
1159 /
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001160
Nick Coghland5cacbb2015-05-23 22:24:10 +10001161Create an extension module.
1162[clinic start generated code]*/
Guido van Rossum7f133ed1991-02-19 12:23:57 +00001163
Nick Coghland5cacbb2015-05-23 22:24:10 +10001164static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03001165_imp_create_builtin(PyObject *module, PyObject *spec)
1166/*[clinic end generated code: output=ace7ff22271e6f39 input=37f966f890384e47]*/
Guido van Rossum7f133ed1991-02-19 12:23:57 +00001167{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001168 struct _inittab *p;
Nick Coghland5cacbb2015-05-23 22:24:10 +10001169 PyObject *name;
Serhiy Storchaka85b0f5b2016-11-20 10:16:47 +02001170 const char *namestr;
Victor Stinner5eb4f592013-11-14 22:38:52 +01001171 PyObject *mod;
Guido van Rossum25ce5661997-08-02 03:10:38 +00001172
Nick Coghland5cacbb2015-05-23 22:24:10 +10001173 name = PyObject_GetAttrString(spec, "name");
1174 if (name == NULL) {
1175 return NULL;
1176 }
1177
Victor Stinner5eb4f592013-11-14 22:38:52 +01001178 mod = _PyImport_FindExtensionObject(name, name);
Nick Coghland5cacbb2015-05-23 22:24:10 +10001179 if (mod || PyErr_Occurred()) {
1180 Py_DECREF(name);
Raymond Hettingerf0afe772016-08-31 08:44:11 -07001181 Py_XINCREF(mod);
Nick Coghland5cacbb2015-05-23 22:24:10 +10001182 return mod;
1183 }
1184
1185 namestr = PyUnicode_AsUTF8(name);
1186 if (namestr == NULL) {
1187 Py_DECREF(name);
1188 return NULL;
1189 }
Guido van Rossum25ce5661997-08-02 03:10:38 +00001190
Eric Snowd393c1b2017-09-14 12:18:12 -06001191 PyObject *modules = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001192 for (p = PyImport_Inittab; p->name != NULL; p++) {
Antoine Pitrou6c40eb72012-01-18 20:16:09 +01001193 PyModuleDef *def;
Serhiy Storchakaf4934ea2016-11-16 10:17:58 +02001194 if (_PyUnicode_EqualToASCIIString(name, p->name)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001195 if (p->initfunc == NULL) {
Nick Coghland5cacbb2015-05-23 22:24:10 +10001196 /* Cannot re-init internal module ("sys" or "builtins") */
1197 mod = PyImport_AddModule(namestr);
1198 Py_DECREF(name);
1199 return mod;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001200 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001201 mod = (*p->initfunc)();
Nick Coghland5cacbb2015-05-23 22:24:10 +10001202 if (mod == NULL) {
1203 Py_DECREF(name);
1204 return NULL;
1205 }
1206 if (PyObject_TypeCheck(mod, &PyModuleDef_Type)) {
1207 Py_DECREF(name);
1208 return PyModule_FromDefAndSpec((PyModuleDef*)mod, spec);
1209 } else {
1210 /* Remember pointer to module init function. */
1211 def = PyModule_GetDef(mod);
Christian Heimesa78b6272016-09-09 00:25:03 +02001212 if (def == NULL) {
1213 Py_DECREF(name);
1214 return NULL;
1215 }
Nick Coghland5cacbb2015-05-23 22:24:10 +10001216 def->m_base.m_init = p->initfunc;
Eric Snowd393c1b2017-09-14 12:18:12 -06001217 if (modules == NULL) {
1218 modules = PyImport_GetModuleDict();
1219 }
1220 if (_PyImport_FixupExtensionObject(mod, name, name,
1221 modules) < 0) {
Nick Coghland5cacbb2015-05-23 22:24:10 +10001222 Py_DECREF(name);
1223 return NULL;
1224 }
1225 Py_DECREF(name);
1226 return mod;
1227 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001228 }
1229 }
Nick Coghland5cacbb2015-05-23 22:24:10 +10001230 Py_DECREF(name);
1231 Py_RETURN_NONE;
Guido van Rossum7f133ed1991-02-19 12:23:57 +00001232}
Guido van Rossumf56e3db1993-04-01 20:59:32 +00001233
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001234
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001235/* Frozen modules */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001236
Benjamin Peterson6fba3db2013-03-18 23:13:31 -07001237static const struct _frozen *
Victor Stinner53dc7352011-03-20 01:50:21 +01001238find_frozen(PyObject *name)
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001239{
Benjamin Peterson6fba3db2013-03-18 23:13:31 -07001240 const struct _frozen *p;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001241
Victor Stinner53dc7352011-03-20 01:50:21 +01001242 if (name == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001243 return NULL;
Benjamin Petersond968e272008-11-05 22:48:33 +00001244
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001245 for (p = PyImport_FrozenModules; ; p++) {
1246 if (p->name == NULL)
1247 return NULL;
Serhiy Storchakaf4934ea2016-11-16 10:17:58 +02001248 if (_PyUnicode_EqualToASCIIString(name, p->name))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001249 break;
1250 }
1251 return p;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001252}
1253
Guido van Rossum79f25d91997-04-29 20:08:16 +00001254static PyObject *
Victor Stinner53dc7352011-03-20 01:50:21 +01001255get_frozen_object(PyObject *name)
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001256{
Benjamin Peterson6fba3db2013-03-18 23:13:31 -07001257 const struct _frozen *p = find_frozen(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001258 int size;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001259
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001260 if (p == NULL) {
1261 PyErr_Format(PyExc_ImportError,
Victor Stinner53dc7352011-03-20 01:50:21 +01001262 "No such frozen object named %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001263 name);
1264 return NULL;
1265 }
1266 if (p->code == NULL) {
1267 PyErr_Format(PyExc_ImportError,
Victor Stinner53dc7352011-03-20 01:50:21 +01001268 "Excluded frozen object named %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001269 name);
1270 return NULL;
1271 }
1272 size = p->size;
1273 if (size < 0)
1274 size = -size;
Serhiy Storchakac6792272013-10-19 21:03:34 +03001275 return PyMarshal_ReadObjectFromString((const char *)p->code, size);
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001276}
1277
Brett Cannon8d110132009-03-15 02:20:16 +00001278static PyObject *
Victor Stinner53dc7352011-03-20 01:50:21 +01001279is_frozen_package(PyObject *name)
Brett Cannon8d110132009-03-15 02:20:16 +00001280{
Benjamin Peterson6fba3db2013-03-18 23:13:31 -07001281 const struct _frozen *p = find_frozen(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001282 int size;
Brett Cannon8d110132009-03-15 02:20:16 +00001283
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001284 if (p == NULL) {
1285 PyErr_Format(PyExc_ImportError,
Victor Stinner53dc7352011-03-20 01:50:21 +01001286 "No such frozen object named %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001287 name);
1288 return NULL;
1289 }
Brett Cannon8d110132009-03-15 02:20:16 +00001290
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001291 size = p->size;
Brett Cannon8d110132009-03-15 02:20:16 +00001292
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001293 if (size < 0)
1294 Py_RETURN_TRUE;
1295 else
1296 Py_RETURN_FALSE;
Brett Cannon8d110132009-03-15 02:20:16 +00001297}
1298
1299
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001300/* Initialize a frozen module.
Brett Cannon3c2ac442009-03-08 20:49:47 +00001301 Return 1 for success, 0 if the module is not found, and -1 with
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001302 an exception set if the initialization failed.
1303 This function is also used from frozenmain.c */
Guido van Rossum0b344901995-02-07 15:35:27 +00001304
1305int
Victor Stinner53dc7352011-03-20 01:50:21 +01001306PyImport_ImportFrozenModuleObject(PyObject *name)
Guido van Rossumf56e3db1993-04-01 20:59:32 +00001307{
Benjamin Peterson6fba3db2013-03-18 23:13:31 -07001308 const struct _frozen *p;
Brett Cannon18fc4e72014-04-04 10:01:46 -04001309 PyObject *co, *m, *d;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001310 int ispackage;
1311 int size;
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00001312
Victor Stinner53dc7352011-03-20 01:50:21 +01001313 p = find_frozen(name);
1314
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001315 if (p == NULL)
1316 return 0;
1317 if (p->code == NULL) {
1318 PyErr_Format(PyExc_ImportError,
Victor Stinner53dc7352011-03-20 01:50:21 +01001319 "Excluded frozen object named %R",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001320 name);
1321 return -1;
1322 }
1323 size = p->size;
1324 ispackage = (size < 0);
1325 if (ispackage)
1326 size = -size;
Serhiy Storchakac6792272013-10-19 21:03:34 +03001327 co = PyMarshal_ReadObjectFromString((const char *)p->code, size);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001328 if (co == NULL)
1329 return -1;
1330 if (!PyCode_Check(co)) {
1331 PyErr_Format(PyExc_TypeError,
Victor Stinner53dc7352011-03-20 01:50:21 +01001332 "frozen object %R is not a code object",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001333 name);
1334 goto err_return;
1335 }
1336 if (ispackage) {
Brett Cannon3e0651b2013-05-31 23:18:39 -04001337 /* Set __path__ to the empty list */
Brett Cannon18fc4e72014-04-04 10:01:46 -04001338 PyObject *l;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001339 int err;
Victor Stinner53dc7352011-03-20 01:50:21 +01001340 m = PyImport_AddModuleObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001341 if (m == NULL)
1342 goto err_return;
1343 d = PyModule_GetDict(m);
Brett Cannon3e0651b2013-05-31 23:18:39 -04001344 l = PyList_New(0);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001345 if (l == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001346 goto err_return;
1347 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001348 err = PyDict_SetItemString(d, "__path__", l);
1349 Py_DECREF(l);
1350 if (err != 0)
1351 goto err_return;
1352 }
Brett Cannon18fc4e72014-04-04 10:01:46 -04001353 d = module_dict_for_exec(name);
1354 if (d == NULL) {
Victor Stinner53dc7352011-03-20 01:50:21 +01001355 goto err_return;
Brett Cannon18fc4e72014-04-04 10:01:46 -04001356 }
1357 m = exec_code_in_module(name, d, co);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001358 if (m == NULL)
1359 goto err_return;
1360 Py_DECREF(co);
1361 Py_DECREF(m);
1362 return 1;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001363err_return:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001364 Py_DECREF(co);
1365 return -1;
Guido van Rossumf56e3db1993-04-01 20:59:32 +00001366}
Guido van Rossum74e6a111994-08-29 12:54:38 +00001367
Victor Stinner53dc7352011-03-20 01:50:21 +01001368int
Serhiy Storchakac6792272013-10-19 21:03:34 +03001369PyImport_ImportFrozenModule(const char *name)
Victor Stinner53dc7352011-03-20 01:50:21 +01001370{
1371 PyObject *nameobj;
1372 int ret;
1373 nameobj = PyUnicode_InternFromString(name);
1374 if (nameobj == NULL)
1375 return -1;
1376 ret = PyImport_ImportFrozenModuleObject(nameobj);
1377 Py_DECREF(nameobj);
1378 return ret;
1379}
1380
Guido van Rossum74e6a111994-08-29 12:54:38 +00001381
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001382/* Import a module, either built-in, frozen, or external, and return
Guido van Rossum7f9fa971995-01-20 16:53:12 +00001383 its module object WITH INCREMENTED REFERENCE COUNT */
Guido van Rossum74e6a111994-08-29 12:54:38 +00001384
Guido van Rossum79f25d91997-04-29 20:08:16 +00001385PyObject *
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00001386PyImport_ImportModule(const char *name)
Guido van Rossum74e6a111994-08-29 12:54:38 +00001387{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001388 PyObject *pname;
1389 PyObject *result;
Marc-André Lemburg3c61c352001-02-09 19:40:15 +00001390
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001391 pname = PyUnicode_FromString(name);
1392 if (pname == NULL)
1393 return NULL;
1394 result = PyImport_Import(pname);
1395 Py_DECREF(pname);
1396 return result;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00001397}
1398
Christian Heimes072c0f12008-01-03 23:01:04 +00001399/* Import a module without blocking
1400 *
1401 * At first it tries to fetch the module from sys.modules. If the module was
1402 * never loaded before it loads it with PyImport_ImportModule() unless another
1403 * thread holds the import lock. In the latter case the function raises an
1404 * ImportError instead of blocking.
1405 *
1406 * Returns the module object with incremented ref count.
1407 */
1408PyObject *
1409PyImport_ImportModuleNoBlock(const char *name)
1410{
Antoine Pitrouea3eb882012-05-17 18:55:59 +02001411 return PyImport_ImportModule(name);
Christian Heimes072c0f12008-01-03 23:01:04 +00001412}
1413
Guido van Rossum17fc85f1997-09-06 18:52:03 +00001414
Antoine Pitroubc07a5c2012-07-08 12:01:27 +02001415/* Remove importlib frames from the traceback,
1416 * except in Verbose mode. */
1417static void
1418remove_importlib_frames(void)
1419{
1420 const char *importlib_filename = "<frozen importlib._bootstrap>";
Eric Snow32439d62015-05-02 19:15:18 -06001421 const char *external_filename = "<frozen importlib._bootstrap_external>";
Nick Coghlan42c07662012-07-31 21:14:18 +10001422 const char *remove_frames = "_call_with_frames_removed";
Antoine Pitroubc07a5c2012-07-08 12:01:27 +02001423 int always_trim = 0;
Benjamin Petersonfa873702012-07-09 13:43:53 -07001424 int in_importlib = 0;
Antoine Pitroubc07a5c2012-07-08 12:01:27 +02001425 PyObject *exception, *value, *base_tb, *tb;
Benjamin Petersonfa873702012-07-09 13:43:53 -07001426 PyObject **prev_link, **outer_link = NULL;
Antoine Pitroubc07a5c2012-07-08 12:01:27 +02001427
1428 /* Synopsis: if it's an ImportError, we trim all importlib chunks
Nick Coghlan42c07662012-07-31 21:14:18 +10001429 from the traceback. We always trim chunks
1430 which end with a call to "_call_with_frames_removed". */
Antoine Pitroubc07a5c2012-07-08 12:01:27 +02001431
1432 PyErr_Fetch(&exception, &value, &base_tb);
1433 if (!exception || Py_VerboseFlag)
1434 goto done;
1435 if (PyType_IsSubtype((PyTypeObject *) exception,
1436 (PyTypeObject *) PyExc_ImportError))
1437 always_trim = 1;
1438
1439 prev_link = &base_tb;
1440 tb = base_tb;
Antoine Pitroubc07a5c2012-07-08 12:01:27 +02001441 while (tb != NULL) {
1442 PyTracebackObject *traceback = (PyTracebackObject *)tb;
1443 PyObject *next = (PyObject *) traceback->tb_next;
1444 PyFrameObject *frame = traceback->tb_frame;
1445 PyCodeObject *code = frame->f_code;
1446 int now_in_importlib;
1447
1448 assert(PyTraceBack_Check(tb));
Serhiy Storchakaf4934ea2016-11-16 10:17:58 +02001449 now_in_importlib = _PyUnicode_EqualToASCIIString(code->co_filename, importlib_filename) ||
1450 _PyUnicode_EqualToASCIIString(code->co_filename, external_filename);
Antoine Pitroubc07a5c2012-07-08 12:01:27 +02001451 if (now_in_importlib && !in_importlib) {
1452 /* This is the link to this chunk of importlib tracebacks */
1453 outer_link = prev_link;
1454 }
1455 in_importlib = now_in_importlib;
1456
1457 if (in_importlib &&
1458 (always_trim ||
Serhiy Storchakaf4934ea2016-11-16 10:17:58 +02001459 _PyUnicode_EqualToASCIIString(code->co_name, remove_frames))) {
Antoine Pitroubc07a5c2012-07-08 12:01:27 +02001460 Py_XINCREF(next);
Serhiy Storchakaec397562016-04-06 09:50:03 +03001461 Py_XSETREF(*outer_link, next);
Antoine Pitroubc07a5c2012-07-08 12:01:27 +02001462 prev_link = outer_link;
1463 }
1464 else {
1465 prev_link = (PyObject **) &traceback->tb_next;
1466 }
1467 tb = next;
1468 }
1469done:
1470 PyErr_Restore(exception, value, base_tb);
1471}
1472
1473
Serhiy Storchaka133138a2016-08-02 22:51:21 +03001474static PyObject *
1475resolve_name(PyObject *name, PyObject *globals, int level)
Thomas Woutersf7f438b2006-02-28 16:09:29 +00001476{
Eric Snowb523f842013-11-22 09:05:39 -07001477 _Py_IDENTIFIER(__spec__);
Brett Cannonfd074152012-04-14 14:10:13 -04001478 _Py_IDENTIFIER(__package__);
1479 _Py_IDENTIFIER(__path__);
1480 _Py_IDENTIFIER(__name__);
Serhiy Storchaka133138a2016-08-02 22:51:21 +03001481 _Py_IDENTIFIER(parent);
1482 PyObject *abs_name;
1483 PyObject *package = NULL;
1484 PyObject *spec;
Serhiy Storchaka133138a2016-08-02 22:51:21 +03001485 Py_ssize_t last_dot;
1486 PyObject *base;
1487 int level_up;
1488
1489 if (globals == NULL) {
1490 PyErr_SetString(PyExc_KeyError, "'__name__' not in globals");
1491 goto error;
1492 }
1493 if (!PyDict_Check(globals)) {
1494 PyErr_SetString(PyExc_TypeError, "globals must be a dict");
1495 goto error;
1496 }
1497 package = _PyDict_GetItemId(globals, &PyId___package__);
1498 if (package == Py_None) {
1499 package = NULL;
1500 }
1501 spec = _PyDict_GetItemId(globals, &PyId___spec__);
1502
1503 if (package != NULL) {
1504 Py_INCREF(package);
1505 if (!PyUnicode_Check(package)) {
1506 PyErr_SetString(PyExc_TypeError, "package must be a string");
1507 goto error;
1508 }
1509 else if (spec != NULL && spec != Py_None) {
1510 int equal;
1511 PyObject *parent = _PyObject_GetAttrId(spec, &PyId_parent);
1512 if (parent == NULL) {
1513 goto error;
1514 }
1515
1516 equal = PyObject_RichCompareBool(package, parent, Py_EQ);
1517 Py_DECREF(parent);
1518 if (equal < 0) {
1519 goto error;
1520 }
1521 else if (equal == 0) {
1522 if (PyErr_WarnEx(PyExc_ImportWarning,
1523 "__package__ != __spec__.parent", 1) < 0) {
1524 goto error;
1525 }
1526 }
1527 }
1528 }
1529 else if (spec != NULL && spec != Py_None) {
1530 package = _PyObject_GetAttrId(spec, &PyId_parent);
1531 if (package == NULL) {
1532 goto error;
1533 }
1534 else if (!PyUnicode_Check(package)) {
1535 PyErr_SetString(PyExc_TypeError,
1536 "__spec__.parent must be a string");
1537 goto error;
1538 }
1539 }
1540 else {
1541 if (PyErr_WarnEx(PyExc_ImportWarning,
1542 "can't resolve package from __spec__ or __package__, "
1543 "falling back on __name__ and __path__", 1) < 0) {
1544 goto error;
1545 }
1546
1547 package = _PyDict_GetItemId(globals, &PyId___name__);
1548 if (package == NULL) {
1549 PyErr_SetString(PyExc_KeyError, "'__name__' not in globals");
1550 goto error;
1551 }
1552
1553 Py_INCREF(package);
1554 if (!PyUnicode_Check(package)) {
1555 PyErr_SetString(PyExc_TypeError, "__name__ must be a string");
1556 goto error;
1557 }
1558
1559 if (_PyDict_GetItemId(globals, &PyId___path__) == NULL) {
1560 Py_ssize_t dot;
1561
1562 if (PyUnicode_READY(package) < 0) {
1563 goto error;
1564 }
1565
1566 dot = PyUnicode_FindChar(package, '.',
1567 0, PyUnicode_GET_LENGTH(package), -1);
1568 if (dot == -2) {
1569 goto error;
1570 }
1571
1572 if (dot >= 0) {
1573 PyObject *substr = PyUnicode_Substring(package, 0, dot);
1574 if (substr == NULL) {
1575 goto error;
1576 }
1577 Py_SETREF(package, substr);
1578 }
1579 }
1580 }
1581
1582 last_dot = PyUnicode_GET_LENGTH(package);
1583 if (last_dot == 0) {
1584 PyErr_SetString(PyExc_ImportError,
1585 "attempted relative import with no known parent package");
1586 goto error;
1587 }
Serhiy Storchaka133138a2016-08-02 22:51:21 +03001588
1589 for (level_up = 1; level_up < level; level_up += 1) {
1590 last_dot = PyUnicode_FindChar(package, '.', 0, last_dot, -1);
1591 if (last_dot == -2) {
1592 goto error;
1593 }
1594 else if (last_dot == -1) {
1595 PyErr_SetString(PyExc_ValueError,
1596 "attempted relative import beyond top-level "
1597 "package");
1598 goto error;
1599 }
1600 }
1601
1602 base = PyUnicode_Substring(package, 0, last_dot);
1603 Py_DECREF(package);
1604 if (base == NULL || PyUnicode_GET_LENGTH(name) == 0) {
1605 return base;
1606 }
1607
1608 abs_name = PyUnicode_FromFormat("%U.%U", base, name);
1609 Py_DECREF(base);
1610 return abs_name;
1611
1612 error:
1613 Py_XDECREF(package);
1614 return NULL;
1615}
1616
Neil Schemenauereea3cc12017-12-03 09:26:03 -08001617static PyObject *
1618import_find_and_load(PyObject *abs_name)
1619{
1620 _Py_IDENTIFIER(_find_and_load);
1621 PyObject *mod = NULL;
Victor Stinnercaba55b2018-08-03 15:33:52 +02001622 PyInterpreterState *interp = _PyInterpreterState_GET_UNSAFE();
Neil Schemenauereea3cc12017-12-03 09:26:03 -08001623 int import_time = interp->core_config.import_time;
1624 static int import_level;
1625 static _PyTime_t accumulated;
1626
1627 _PyTime_t t1 = 0, accumulated_copy = accumulated;
1628
1629 /* XOptions is initialized after first some imports.
1630 * So we can't have negative cache before completed initialization.
1631 * Anyway, importlib._find_and_load is much slower than
1632 * _PyDict_GetItemIdWithError().
1633 */
1634 if (import_time) {
1635 static int header = 1;
1636 if (header) {
1637 fputs("import time: self [us] | cumulative | imported package\n",
1638 stderr);
1639 header = 0;
1640 }
1641
1642 import_level++;
1643 t1 = _PyTime_GetPerfCounter();
1644 accumulated = 0;
1645 }
1646
1647 if (PyDTrace_IMPORT_FIND_LOAD_START_ENABLED())
1648 PyDTrace_IMPORT_FIND_LOAD_START(PyUnicode_AsUTF8(abs_name));
1649
1650 mod = _PyObject_CallMethodIdObjArgs(interp->importlib,
1651 &PyId__find_and_load, abs_name,
1652 interp->import_func, NULL);
1653
1654 if (PyDTrace_IMPORT_FIND_LOAD_DONE_ENABLED())
1655 PyDTrace_IMPORT_FIND_LOAD_DONE(PyUnicode_AsUTF8(abs_name),
1656 mod != NULL);
1657
1658 if (import_time) {
1659 _PyTime_t cum = _PyTime_GetPerfCounter() - t1;
1660
1661 import_level--;
1662 fprintf(stderr, "import time: %9ld | %10ld | %*s%s\n",
1663 (long)_PyTime_AsMicroseconds(cum - accumulated, _PyTime_ROUND_CEILING),
1664 (long)_PyTime_AsMicroseconds(cum, _PyTime_ROUND_CEILING),
1665 import_level*2, "", PyUnicode_AsUTF8(abs_name));
1666
1667 accumulated = accumulated_copy + cum;
1668 }
1669
1670 return mod;
1671}
1672
Serhiy Storchaka133138a2016-08-02 22:51:21 +03001673PyObject *
1674PyImport_ImportModuleLevelObject(PyObject *name, PyObject *globals,
1675 PyObject *locals, PyObject *fromlist,
1676 int level)
1677{
Brett Cannonfd074152012-04-14 14:10:13 -04001678 _Py_IDENTIFIER(_handle_fromlist);
Brett Cannonfd074152012-04-14 14:10:13 -04001679 PyObject *abs_name = NULL;
Brett Cannonfd074152012-04-14 14:10:13 -04001680 PyObject *final_mod = NULL;
1681 PyObject *mod = NULL;
1682 PyObject *package = NULL;
Victor Stinnercaba55b2018-08-03 15:33:52 +02001683 PyInterpreterState *interp = _PyInterpreterState_GET_UNSAFE();
Serhiy Storchakafa494fd2015-05-30 17:45:22 +03001684 int has_from;
Brett Cannonfd074152012-04-14 14:10:13 -04001685
Brett Cannonfd074152012-04-14 14:10:13 -04001686 if (name == NULL) {
1687 PyErr_SetString(PyExc_ValueError, "Empty module name");
1688 goto error;
1689 }
1690
1691 /* The below code is importlib.__import__() & _gcd_import(), ported to C
1692 for added performance. */
1693
1694 if (!PyUnicode_Check(name)) {
1695 PyErr_SetString(PyExc_TypeError, "module name must be a string");
1696 goto error;
1697 }
Serhiy Storchaka133138a2016-08-02 22:51:21 +03001698 if (PyUnicode_READY(name) < 0) {
Brett Cannonfd074152012-04-14 14:10:13 -04001699 goto error;
1700 }
1701 if (level < 0) {
1702 PyErr_SetString(PyExc_ValueError, "level must be >= 0");
1703 goto error;
1704 }
Brett Cannon849113a2016-01-22 15:25:50 -08001705
Serhiy Storchaka133138a2016-08-02 22:51:21 +03001706 if (level > 0) {
1707 abs_name = resolve_name(name, globals, level);
1708 if (abs_name == NULL)
Brett Cannon9fa81262016-01-22 16:39:02 -08001709 goto error;
Brett Cannonfd074152012-04-14 14:10:13 -04001710 }
1711 else { /* level == 0 */
1712 if (PyUnicode_GET_LENGTH(name) == 0) {
1713 PyErr_SetString(PyExc_ValueError, "Empty module name");
1714 goto error;
1715 }
Brett Cannonfd074152012-04-14 14:10:13 -04001716 abs_name = name;
1717 Py_INCREF(abs_name);
1718 }
1719
Eric Snow3f9eee62017-09-15 16:35:20 -06001720 mod = PyImport_GetModule(abs_name);
Serhiy Storchakab4baace2017-07-06 08:09:03 +03001721 if (mod != NULL && mod != Py_None) {
Serhiy Storchaka133138a2016-08-02 22:51:21 +03001722 _Py_IDENTIFIER(__spec__);
1723 _Py_IDENTIFIER(_initializing);
1724 _Py_IDENTIFIER(_lock_unlock_module);
Eric Snowb523f842013-11-22 09:05:39 -07001725 PyObject *value = NULL;
1726 PyObject *spec;
Antoine Pitrouea3eb882012-05-17 18:55:59 +02001727 int initializing = 0;
1728
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__);
1735 if (spec != NULL) {
1736 value = _PyObject_GetAttrId(spec, &PyId__initializing);
1737 Py_DECREF(spec);
1738 }
Antoine Pitrouea3eb882012-05-17 18:55:59 +02001739 if (value == NULL)
1740 PyErr_Clear();
1741 else {
1742 initializing = PyObject_IsTrue(value);
1743 Py_DECREF(value);
1744 if (initializing == -1)
1745 PyErr_Clear();
Serhiy Storchaka133138a2016-08-02 22:51:21 +03001746 if (initializing > 0) {
Serhiy Storchaka133138a2016-08-02 22:51:21 +03001747 value = _PyObject_CallMethodIdObjArgs(interp->importlib,
1748 &PyId__lock_unlock_module, abs_name,
1749 NULL);
1750 if (value == NULL)
1751 goto error;
1752 Py_DECREF(value);
1753 }
Antoine Pitrouea3eb882012-05-17 18:55:59 +02001754 }
Brett Cannonfd074152012-04-14 14:10:13 -04001755 }
1756 else {
Neil Schemenauer11cc2892017-12-07 16:24:59 -08001757 Py_XDECREF(mod);
Neil Schemenauereea3cc12017-12-03 09:26:03 -08001758 mod = import_find_and_load(abs_name);
Brett Cannonfd074152012-04-14 14:10:13 -04001759 if (mod == NULL) {
Antoine Pitrouea3eb882012-05-17 18:55:59 +02001760 goto error;
Brett Cannonfd074152012-04-14 14:10:13 -04001761 }
1762 }
1763
Serhiy Storchaka133138a2016-08-02 22:51:21 +03001764 has_from = 0;
1765 if (fromlist != NULL && fromlist != Py_None) {
1766 has_from = PyObject_IsTrue(fromlist);
1767 if (has_from < 0)
1768 goto error;
1769 }
Serhiy Storchakafa494fd2015-05-30 17:45:22 +03001770 if (!has_from) {
Victor Stinner744c34e2016-05-20 11:36:13 +02001771 Py_ssize_t len = PyUnicode_GET_LENGTH(name);
1772 if (level == 0 || len > 0) {
1773 Py_ssize_t dot;
Brett Cannonfd074152012-04-14 14:10:13 -04001774
Victor Stinner744c34e2016-05-20 11:36:13 +02001775 dot = PyUnicode_FindChar(name, '.', 0, len, 1);
1776 if (dot == -2) {
Antoine Pitrouea3eb882012-05-17 18:55:59 +02001777 goto error;
Brett Cannonfd074152012-04-14 14:10:13 -04001778 }
1779
Victor Stinner744c34e2016-05-20 11:36:13 +02001780 if (dot == -1) {
Antoine Pitrou6efa50a2012-05-07 21:41:59 +02001781 /* No dot in module name, simple exit */
Antoine Pitrou6efa50a2012-05-07 21:41:59 +02001782 final_mod = mod;
1783 Py_INCREF(mod);
Antoine Pitrouea3eb882012-05-17 18:55:59 +02001784 goto error;
Antoine Pitrou6efa50a2012-05-07 21:41:59 +02001785 }
1786
Brett Cannonfd074152012-04-14 14:10:13 -04001787 if (level == 0) {
Victor Stinner744c34e2016-05-20 11:36:13 +02001788 PyObject *front = PyUnicode_Substring(name, 0, dot);
1789 if (front == NULL) {
1790 goto error;
1791 }
1792
Serhiy Storchaka133138a2016-08-02 22:51:21 +03001793 final_mod = PyImport_ImportModuleLevelObject(front, NULL, NULL, NULL, 0);
Antoine Pitroub78174c2012-05-06 17:15:23 +02001794 Py_DECREF(front);
Brett Cannonfd074152012-04-14 14:10:13 -04001795 }
1796 else {
Victor Stinner744c34e2016-05-20 11:36:13 +02001797 Py_ssize_t cut_off = len - dot;
Antoine Pitrou22a1d172012-04-16 22:06:21 +02001798 Py_ssize_t abs_name_len = PyUnicode_GET_LENGTH(abs_name);
Brett Cannon49f8d8b2012-04-14 21:50:00 -04001799 PyObject *to_return = PyUnicode_Substring(abs_name, 0,
Brett Cannonfd074152012-04-14 14:10:13 -04001800 abs_name_len - cut_off);
Antoine Pitrou22a1d172012-04-16 22:06:21 +02001801 if (to_return == NULL) {
Antoine Pitrouea3eb882012-05-17 18:55:59 +02001802 goto error;
Antoine Pitrou22a1d172012-04-16 22:06:21 +02001803 }
Brett Cannonfd074152012-04-14 14:10:13 -04001804
Eric Snow3f9eee62017-09-15 16:35:20 -06001805 final_mod = PyImport_GetModule(to_return);
Serhiy Storchaka133138a2016-08-02 22:51:21 +03001806 Py_DECREF(to_return);
Brett Cannon49f8d8b2012-04-14 21:50:00 -04001807 if (final_mod == NULL) {
1808 PyErr_Format(PyExc_KeyError,
1809 "%R not in sys.modules as expected",
1810 to_return);
Serhiy Storchaka133138a2016-08-02 22:51:21 +03001811 goto error;
Brett Cannon49f8d8b2012-04-14 21:50:00 -04001812 }
Brett Cannonfd074152012-04-14 14:10:13 -04001813 }
1814 }
1815 else {
1816 final_mod = mod;
1817 Py_INCREF(mod);
1818 }
1819 }
1820 else {
Serhiy Storchaka4e244252018-03-11 10:52:37 +02001821 _Py_IDENTIFIER(__path__);
1822 PyObject *path;
1823 if (_PyObject_LookupAttrId(mod, &PyId___path__, &path) < 0) {
1824 goto error;
1825 }
1826 if (path) {
1827 Py_DECREF(path);
1828 final_mod = _PyObject_CallMethodIdObjArgs(
1829 interp->importlib, &PyId__handle_fromlist,
1830 mod, fromlist, interp->import_func, NULL);
1831 }
1832 else {
1833 final_mod = mod;
1834 Py_INCREF(mod);
1835 }
Brett Cannonfd074152012-04-14 14:10:13 -04001836 }
Antoine Pitrou6efa50a2012-05-07 21:41:59 +02001837
Brett Cannonfd074152012-04-14 14:10:13 -04001838 error:
1839 Py_XDECREF(abs_name);
Brett Cannonfd074152012-04-14 14:10:13 -04001840 Py_XDECREF(mod);
1841 Py_XDECREF(package);
Antoine Pitroubc07a5c2012-07-08 12:01:27 +02001842 if (final_mod == NULL)
1843 remove_importlib_frames();
Brett Cannonfd074152012-04-14 14:10:13 -04001844 return final_mod;
Guido van Rossum75acc9c1998-03-03 22:26:50 +00001845}
1846
Victor Stinnerfe93faf2011-03-14 15:54:52 -04001847PyObject *
Benjamin Peterson04778a82011-05-25 09:29:00 -05001848PyImport_ImportModuleLevel(const char *name, PyObject *globals, PyObject *locals,
Victor Stinnerfe93faf2011-03-14 15:54:52 -04001849 PyObject *fromlist, int level)
1850{
1851 PyObject *nameobj, *mod;
1852 nameobj = PyUnicode_FromString(name);
1853 if (nameobj == NULL)
1854 return NULL;
1855 mod = PyImport_ImportModuleLevelObject(nameobj, globals, locals,
1856 fromlist, level);
1857 Py_DECREF(nameobj);
1858 return mod;
1859}
1860
1861
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001862/* Re-import a module of any kind and return its module object, WITH
1863 INCREMENTED REFERENCE COUNT */
1864
Guido van Rossum79f25d91997-04-29 20:08:16 +00001865PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001866PyImport_ReloadModule(PyObject *m)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001867{
Eric Snow3f9eee62017-09-15 16:35:20 -06001868 _Py_IDENTIFIER(imp);
Brett Cannon62228db2012-04-29 14:38:11 -04001869 _Py_IDENTIFIER(reload);
1870 PyObject *reloaded_module = NULL;
Eric Snow3f9eee62017-09-15 16:35:20 -06001871 PyObject *imp = _PyImport_GetModuleId(&PyId_imp);
Brett Cannon62228db2012-04-29 14:38:11 -04001872 if (imp == NULL) {
1873 imp = PyImport_ImportModule("imp");
1874 if (imp == NULL) {
1875 return NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001876 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001877 }
Victor Stinnerad3c03b2011-03-14 09:21:33 -04001878
Victor Stinner55ba38a2016-12-09 16:09:30 +01001879 reloaded_module = _PyObject_CallMethodIdObjArgs(imp, &PyId_reload, m, NULL);
Brett Cannon62228db2012-04-29 14:38:11 -04001880 Py_DECREF(imp);
1881 return reloaded_module;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001882}
1883
1884
Guido van Rossumd47a0a81997-08-14 20:11:26 +00001885/* Higher-level import emulator which emulates the "import" statement
1886 more accurately -- it invokes the __import__() function from the
1887 builtins of the current globals. This means that the import is
1888 done using whatever import hooks are installed in the current
Brett Cannonbc2eff32010-09-19 21:39:02 +00001889 environment.
Guido van Rossum6058eb41998-12-21 19:51:00 +00001890 A dummy list ["__doc__"] is passed as the 4th argument so that
Neal Norwitz80e7f272007-08-26 06:45:23 +00001891 e.g. PyImport_Import(PyUnicode_FromString("win32com.client.gencache"))
Guido van Rossum6058eb41998-12-21 19:51:00 +00001892 will return <module "gencache"> instead of <module "win32com">. */
Guido van Rossumd47a0a81997-08-14 20:11:26 +00001893
1894PyObject *
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00001895PyImport_Import(PyObject *module_name)
Guido van Rossumd47a0a81997-08-14 20:11:26 +00001896{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001897 static PyObject *silly_list = NULL;
1898 static PyObject *builtins_str = NULL;
1899 static PyObject *import_str = NULL;
1900 PyObject *globals = NULL;
1901 PyObject *import = NULL;
1902 PyObject *builtins = NULL;
1903 PyObject *r = NULL;
Guido van Rossumd47a0a81997-08-14 20:11:26 +00001904
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001905 /* Initialize constant string objects */
1906 if (silly_list == NULL) {
1907 import_str = PyUnicode_InternFromString("__import__");
1908 if (import_str == NULL)
1909 return NULL;
1910 builtins_str = PyUnicode_InternFromString("__builtins__");
1911 if (builtins_str == NULL)
1912 return NULL;
Brett Cannonbc2eff32010-09-19 21:39:02 +00001913 silly_list = PyList_New(0);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001914 if (silly_list == NULL)
1915 return NULL;
1916 }
Guido van Rossumd47a0a81997-08-14 20:11:26 +00001917
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001918 /* Get the builtins from current globals */
1919 globals = PyEval_GetGlobals();
1920 if (globals != NULL) {
1921 Py_INCREF(globals);
1922 builtins = PyObject_GetItem(globals, builtins_str);
1923 if (builtins == NULL)
1924 goto err;
1925 }
1926 else {
1927 /* No globals -- use standard builtins, and fake globals */
1928 builtins = PyImport_ImportModuleLevel("builtins",
1929 NULL, NULL, NULL, 0);
1930 if (builtins == NULL)
1931 return NULL;
1932 globals = Py_BuildValue("{OO}", builtins_str, builtins);
1933 if (globals == NULL)
1934 goto err;
1935 }
Guido van Rossumd47a0a81997-08-14 20:11:26 +00001936
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001937 /* Get the __import__ function from the builtins */
1938 if (PyDict_Check(builtins)) {
1939 import = PyObject_GetItem(builtins, import_str);
1940 if (import == NULL)
1941 PyErr_SetObject(PyExc_KeyError, import_str);
1942 }
1943 else
1944 import = PyObject_GetAttr(builtins, import_str);
1945 if (import == NULL)
1946 goto err;
Guido van Rossumd47a0a81997-08-14 20:11:26 +00001947
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001948 /* Call the __import__ function with the proper argument list
Brett Cannonbc2eff32010-09-19 21:39:02 +00001949 Always use absolute import here.
1950 Calling for side-effect of import. */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001951 r = PyObject_CallFunction(import, "OOOOi", module_name, globals,
1952 globals, silly_list, 0, NULL);
Brett Cannonbc2eff32010-09-19 21:39:02 +00001953 if (r == NULL)
1954 goto err;
1955 Py_DECREF(r);
1956
Eric Snow3f9eee62017-09-15 16:35:20 -06001957 r = PyImport_GetModule(module_name);
1958 if (r == NULL && !PyErr_Occurred()) {
Serhiy Storchaka145541c2017-06-15 20:54:38 +03001959 PyErr_SetObject(PyExc_KeyError, module_name);
1960 }
Guido van Rossumd47a0a81997-08-14 20:11:26 +00001961
1962 err:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001963 Py_XDECREF(globals);
1964 Py_XDECREF(builtins);
1965 Py_XDECREF(import);
Tim Peters50d8d372001-02-28 05:34:27 +00001966
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001967 return r;
Guido van Rossumd47a0a81997-08-14 20:11:26 +00001968}
1969
Brett Cannon4caa61d2014-01-09 19:03:32 -05001970/*[clinic input]
1971_imp.extension_suffixes
1972
1973Returns the list of file suffixes used to identify extension modules.
1974[clinic start generated code]*/
1975
Brett Cannon4caa61d2014-01-09 19:03:32 -05001976static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03001977_imp_extension_suffixes_impl(PyObject *module)
1978/*[clinic end generated code: output=0bf346e25a8f0cd3 input=ecdeeecfcb6f839e]*/
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001979{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001980 PyObject *list;
Brett Cannon2657df42012-05-04 15:20:40 -04001981 const char *suffix;
1982 unsigned int index = 0;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00001983
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001984 list = PyList_New(0);
1985 if (list == NULL)
1986 return NULL;
Brett Cannon2657df42012-05-04 15:20:40 -04001987#ifdef HAVE_DYNAMIC_LOADING
1988 while ((suffix = _PyImport_DynLoadFiletab[index])) {
1989 PyObject *item = PyUnicode_FromString(suffix);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001990 if (item == NULL) {
1991 Py_DECREF(list);
1992 return NULL;
1993 }
1994 if (PyList_Append(list, item) < 0) {
1995 Py_DECREF(list);
1996 Py_DECREF(item);
1997 return NULL;
1998 }
1999 Py_DECREF(item);
Brett Cannon2657df42012-05-04 15:20:40 -04002000 index += 1;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002001 }
Brett Cannon2657df42012-05-04 15:20:40 -04002002#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002003 return list;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002004}
2005
Brett Cannon4caa61d2014-01-09 19:03:32 -05002006/*[clinic input]
Brett Cannon4caa61d2014-01-09 19:03:32 -05002007_imp.init_frozen
2008
2009 name: unicode
2010 /
2011
2012Initializes a frozen module.
2013[clinic start generated code]*/
2014
Brett Cannon4caa61d2014-01-09 19:03:32 -05002015static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03002016_imp_init_frozen_impl(PyObject *module, PyObject *name)
2017/*[clinic end generated code: output=fc0511ed869fd69c input=13019adfc04f3fb3]*/
Brett Cannon4caa61d2014-01-09 19:03:32 -05002018{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002019 int ret;
2020 PyObject *m;
Brett Cannon4caa61d2014-01-09 19:03:32 -05002021
Victor Stinner53dc7352011-03-20 01:50:21 +01002022 ret = PyImport_ImportFrozenModuleObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002023 if (ret < 0)
2024 return NULL;
2025 if (ret == 0) {
Serhiy Storchaka228b12e2017-01-23 09:47:21 +02002026 Py_RETURN_NONE;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002027 }
Victor Stinner53dc7352011-03-20 01:50:21 +01002028 m = PyImport_AddModuleObject(name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002029 Py_XINCREF(m);
2030 return m;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002031}
2032
Brett Cannon4caa61d2014-01-09 19:03:32 -05002033/*[clinic input]
2034_imp.get_frozen_object
2035
2036 name: unicode
2037 /
2038
2039Create a code object for a frozen module.
2040[clinic start generated code]*/
2041
Brett Cannon4caa61d2014-01-09 19:03:32 -05002042static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03002043_imp_get_frozen_object_impl(PyObject *module, PyObject *name)
2044/*[clinic end generated code: output=2568cc5b7aa0da63 input=ed689bc05358fdbd]*/
Brett Cannon4caa61d2014-01-09 19:03:32 -05002045{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002046 return get_frozen_object(name);
Guido van Rossum6ec1efb1995-08-04 04:08:57 +00002047}
2048
Brett Cannon4caa61d2014-01-09 19:03:32 -05002049/*[clinic input]
2050_imp.is_frozen_package
2051
2052 name: unicode
2053 /
2054
2055Returns True if the module name is of a frozen package.
2056[clinic start generated code]*/
2057
Brett Cannon4caa61d2014-01-09 19:03:32 -05002058static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03002059_imp_is_frozen_package_impl(PyObject *module, PyObject *name)
2060/*[clinic end generated code: output=e70cbdb45784a1c9 input=81b6cdecd080fbb8]*/
Brett Cannon4caa61d2014-01-09 19:03:32 -05002061{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002062 return is_frozen_package(name);
Brett Cannon8d110132009-03-15 02:20:16 +00002063}
2064
Brett Cannon4caa61d2014-01-09 19:03:32 -05002065/*[clinic input]
2066_imp.is_builtin
2067
2068 name: unicode
2069 /
2070
2071Returns True if the module name corresponds to a built-in module.
2072[clinic start generated code]*/
2073
Guido van Rossum79f25d91997-04-29 20:08:16 +00002074static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03002075_imp_is_builtin_impl(PyObject *module, PyObject *name)
2076/*[clinic end generated code: output=3bfd1162e2d3be82 input=86befdac021dd1c7]*/
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002077{
Brett Cannon4caa61d2014-01-09 19:03:32 -05002078 return PyLong_FromLong(is_builtin(name));
2079}
2080
2081/*[clinic input]
2082_imp.is_frozen
2083
2084 name: unicode
2085 /
2086
2087Returns True if the module name corresponds to a frozen module.
2088[clinic start generated code]*/
2089
Brett Cannon4caa61d2014-01-09 19:03:32 -05002090static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03002091_imp_is_frozen_impl(PyObject *module, PyObject *name)
2092/*[clinic end generated code: output=01f408f5ec0f2577 input=7301dbca1897d66b]*/
Brett Cannon4caa61d2014-01-09 19:03:32 -05002093{
Benjamin Peterson6fba3db2013-03-18 23:13:31 -07002094 const struct _frozen *p;
Brett Cannon4caa61d2014-01-09 19:03:32 -05002095
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002096 p = find_frozen(name);
2097 return PyBool_FromLong((long) (p == NULL ? 0 : p->size));
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002098}
2099
Larry Hastings1df0b352015-08-24 19:53:56 -07002100/* Common implementation for _imp.exec_dynamic and _imp.exec_builtin */
2101static int
2102exec_builtin_or_dynamic(PyObject *mod) {
2103 PyModuleDef *def;
2104 void *state;
2105
2106 if (!PyModule_Check(mod)) {
2107 return 0;
2108 }
2109
2110 def = PyModule_GetDef(mod);
2111 if (def == NULL) {
Larry Hastings1df0b352015-08-24 19:53:56 -07002112 return 0;
2113 }
Brett Cannon52794db2016-09-07 17:00:43 -07002114
Larry Hastings1df0b352015-08-24 19:53:56 -07002115 state = PyModule_GetState(mod);
Larry Hastings1df0b352015-08-24 19:53:56 -07002116 if (state) {
2117 /* Already initialized; skip reload */
2118 return 0;
2119 }
Brett Cannon52794db2016-09-07 17:00:43 -07002120
Larry Hastings1df0b352015-08-24 19:53:56 -07002121 return PyModule_ExecDef(mod, def);
2122}
2123
Guido van Rossum96a8fb71999-12-22 14:09:35 +00002124#ifdef HAVE_DYNAMIC_LOADING
2125
Brett Cannon4caa61d2014-01-09 19:03:32 -05002126/*[clinic input]
Nick Coghland5cacbb2015-05-23 22:24:10 +10002127_imp.create_dynamic
Brett Cannon4caa61d2014-01-09 19:03:32 -05002128
Nick Coghland5cacbb2015-05-23 22:24:10 +10002129 spec: object
Brett Cannon4caa61d2014-01-09 19:03:32 -05002130 file: object = NULL
2131 /
2132
Nick Coghland5cacbb2015-05-23 22:24:10 +10002133Create an extension module.
Brett Cannon4caa61d2014-01-09 19:03:32 -05002134[clinic start generated code]*/
2135
Brett Cannon4caa61d2014-01-09 19:03:32 -05002136static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03002137_imp_create_dynamic_impl(PyObject *module, PyObject *spec, PyObject *file)
2138/*[clinic end generated code: output=83249b827a4fde77 input=c31b954f4cf4e09d]*/
Brett Cannon4caa61d2014-01-09 19:03:32 -05002139{
Nick Coghland5cacbb2015-05-23 22:24:10 +10002140 PyObject *mod, *name, *path;
Victor Stinnerfefd70c2011-03-14 15:54:07 -04002141 FILE *fp;
2142
Nick Coghland5cacbb2015-05-23 22:24:10 +10002143 name = PyObject_GetAttrString(spec, "name");
2144 if (name == NULL) {
2145 return NULL;
2146 }
2147
2148 path = PyObject_GetAttrString(spec, "origin");
2149 if (path == NULL) {
2150 Py_DECREF(name);
2151 return NULL;
2152 }
2153
2154 mod = _PyImport_FindExtensionObject(name, path);
2155 if (mod != NULL) {
2156 Py_DECREF(name);
2157 Py_DECREF(path);
2158 Py_INCREF(mod);
2159 return mod;
2160 }
2161
Brett Cannon4caa61d2014-01-09 19:03:32 -05002162 if (file != NULL) {
2163 fp = _Py_fopen_obj(path, "r");
Victor Stinnere9ddbf62011-03-22 10:46:35 +01002164 if (fp == NULL) {
Nick Coghland5cacbb2015-05-23 22:24:10 +10002165 Py_DECREF(name);
Brett Cannon4caa61d2014-01-09 19:03:32 -05002166 Py_DECREF(path);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002167 return NULL;
Victor Stinnere9ddbf62011-03-22 10:46:35 +01002168 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002169 }
Victor Stinnerfefd70c2011-03-14 15:54:07 -04002170 else
2171 fp = NULL;
Nick Coghland5cacbb2015-05-23 22:24:10 +10002172
2173 mod = _PyImport_LoadDynamicModuleWithSpec(spec, fp);
2174
2175 Py_DECREF(name);
Brett Cannon4caa61d2014-01-09 19:03:32 -05002176 Py_DECREF(path);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002177 if (fp)
2178 fclose(fp);
Victor Stinnerfefd70c2011-03-14 15:54:07 -04002179 return mod;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002180}
2181
Nick Coghland5cacbb2015-05-23 22:24:10 +10002182/*[clinic input]
2183_imp.exec_dynamic -> int
2184
2185 mod: object
2186 /
2187
2188Initialize an extension module.
2189[clinic start generated code]*/
2190
2191static int
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03002192_imp_exec_dynamic_impl(PyObject *module, PyObject *mod)
2193/*[clinic end generated code: output=f5720ac7b465877d input=9fdbfcb250280d3a]*/
Nick Coghland5cacbb2015-05-23 22:24:10 +10002194{
Larry Hastings1df0b352015-08-24 19:53:56 -07002195 return exec_builtin_or_dynamic(mod);
Nick Coghland5cacbb2015-05-23 22:24:10 +10002196}
2197
2198
Guido van Rossum96a8fb71999-12-22 14:09:35 +00002199#endif /* HAVE_DYNAMIC_LOADING */
2200
Larry Hastings7726ac92014-01-31 22:03:12 -08002201/*[clinic input]
Larry Hastings1df0b352015-08-24 19:53:56 -07002202_imp.exec_builtin -> int
2203
2204 mod: object
2205 /
2206
2207Initialize a built-in module.
2208[clinic start generated code]*/
2209
2210static int
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03002211_imp_exec_builtin_impl(PyObject *module, PyObject *mod)
2212/*[clinic end generated code: output=0262447b240c038e input=7beed5a2f12a60ca]*/
Larry Hastings1df0b352015-08-24 19:53:56 -07002213{
2214 return exec_builtin_or_dynamic(mod);
2215}
2216
Benjamin Peterson42aa93b2017-12-09 10:26:52 -08002217/*[clinic input]
2218_imp.source_hash
2219
2220 key: long
2221 source: Py_buffer
2222[clinic start generated code]*/
2223
2224static PyObject *
2225_imp_source_hash_impl(PyObject *module, long key, Py_buffer *source)
2226/*[clinic end generated code: output=edb292448cf399ea input=9aaad1e590089789]*/
2227{
Benjamin Peterson83620772017-12-09 12:18:56 -08002228 union {
2229 uint64_t x;
2230 char data[sizeof(uint64_t)];
2231 } hash;
2232 hash.x = _Py_KeyedHash((uint64_t)key, source->buf, source->len);
Benjamin Peterson42aa93b2017-12-09 10:26:52 -08002233#if !PY_LITTLE_ENDIAN
2234 // Force to little-endian. There really ought to be a succinct standard way
2235 // to do this.
Benjamin Peterson83620772017-12-09 12:18:56 -08002236 for (size_t i = 0; i < sizeof(hash.data)/2; i++) {
2237 char tmp = hash.data[i];
2238 hash.data[i] = hash.data[sizeof(hash.data) - i - 1];
2239 hash.data[sizeof(hash.data) - i - 1] = tmp;
Benjamin Peterson42aa93b2017-12-09 10:26:52 -08002240 }
Benjamin Peterson42aa93b2017-12-09 10:26:52 -08002241#endif
Benjamin Peterson83620772017-12-09 12:18:56 -08002242 return PyBytes_FromStringAndSize(hash.data, sizeof(hash.data));
Benjamin Peterson42aa93b2017-12-09 10:26:52 -08002243}
2244
Barry Warsaw28a691b2010-04-17 00:19:56 +00002245
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002246PyDoc_STRVAR(doc_imp,
Brett Cannon6f44d662012-04-15 16:08:47 -04002247"(Extremely) low-level import machinery bits as used by importlib and imp.");
Guido van Rossum0207e6d1997-09-09 22:04:42 +00002248
Guido van Rossum79f25d91997-04-29 20:08:16 +00002249static PyMethodDef imp_methods[] = {
Brett Cannon4caa61d2014-01-09 19:03:32 -05002250 _IMP_EXTENSION_SUFFIXES_METHODDEF
2251 _IMP_LOCK_HELD_METHODDEF
2252 _IMP_ACQUIRE_LOCK_METHODDEF
2253 _IMP_RELEASE_LOCK_METHODDEF
2254 _IMP_GET_FROZEN_OBJECT_METHODDEF
2255 _IMP_IS_FROZEN_PACKAGE_METHODDEF
Nick Coghland5cacbb2015-05-23 22:24:10 +10002256 _IMP_CREATE_BUILTIN_METHODDEF
Brett Cannon4caa61d2014-01-09 19:03:32 -05002257 _IMP_INIT_FROZEN_METHODDEF
2258 _IMP_IS_BUILTIN_METHODDEF
2259 _IMP_IS_FROZEN_METHODDEF
Nick Coghland5cacbb2015-05-23 22:24:10 +10002260 _IMP_CREATE_DYNAMIC_METHODDEF
2261 _IMP_EXEC_DYNAMIC_METHODDEF
Larry Hastings1df0b352015-08-24 19:53:56 -07002262 _IMP_EXEC_BUILTIN_METHODDEF
Brett Cannon4caa61d2014-01-09 19:03:32 -05002263 _IMP__FIX_CO_FILENAME_METHODDEF
Benjamin Peterson42aa93b2017-12-09 10:26:52 -08002264 _IMP_SOURCE_HASH_METHODDEF
Brett Cannon4caa61d2014-01-09 19:03:32 -05002265 {NULL, NULL} /* sentinel */
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002266};
2267
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002268
Martin v. Löwis1a214512008-06-11 05:26:20 +00002269static struct PyModuleDef impmodule = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002270 PyModuleDef_HEAD_INIT,
Brett Cannon6f44d662012-04-15 16:08:47 -04002271 "_imp",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002272 doc_imp,
2273 0,
2274 imp_methods,
2275 NULL,
2276 NULL,
2277 NULL,
2278 NULL
Martin v. Löwis1a214512008-06-11 05:26:20 +00002279};
Thomas Wouters0e3f5912006-08-11 14:57:12 +00002280
Jason Tishler6bc06ec2003-09-04 11:59:50 +00002281PyMODINIT_FUNC
Benjamin Petersonc65ef772018-01-29 11:33:57 -08002282PyInit__imp(void)
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002283{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002284 PyObject *m, *d;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002285
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002286 m = PyModule_Create(&impmodule);
2287 if (m == NULL)
2288 goto failure;
2289 d = PyModule_GetDict(m);
2290 if (d == NULL)
2291 goto failure;
Victor Stinnercaba55b2018-08-03 15:33:52 +02002292 _PyCoreConfig *config = &_PyInterpreterState_Get()->core_config;
Victor Stinner80b762f2018-08-01 18:18:07 +02002293 PyObject *pyc_mode = PyUnicode_FromString(config->_check_hash_pycs_mode);
Benjamin Peterson42aa93b2017-12-09 10:26:52 -08002294 if (pyc_mode == NULL) {
2295 goto failure;
2296 }
2297 if (PyDict_SetItemString(d, "check_hash_based_pycs", pyc_mode) < 0) {
2298 Py_DECREF(pyc_mode);
2299 goto failure;
2300 }
2301 Py_DECREF(pyc_mode);
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002302
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002303 return m;
Guido van Rossumaee0bad1997-09-05 07:33:22 +00002304 failure:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002305 Py_XDECREF(m);
2306 return NULL;
Guido van Rossum1ae940a1995-01-02 19:04:15 +00002307}
Guido van Rossum09cae1f1998-05-14 02:32:54 +00002308
2309
Guido van Rossumb18618d2000-05-03 23:44:39 +00002310/* API for embedding applications that want to add their own entries
2311 to the table of built-in modules. This should normally be called
2312 *before* Py_Initialize(). When the table resize fails, -1 is
2313 returned and the existing table is unchanged.
Guido van Rossum09cae1f1998-05-14 02:32:54 +00002314
2315 After a similar function by Just van Rossum. */
2316
2317int
Thomas Woutersf70ef4f2000-07-22 18:47:25 +00002318PyImport_ExtendInittab(struct _inittab *newtab)
Guido van Rossum09cae1f1998-05-14 02:32:54 +00002319{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002320 struct _inittab *p;
Benjamin Peterson0c644fc2017-12-15 23:42:33 -08002321 size_t i, n;
Victor Stinner92a3c6f2017-12-06 18:12:59 +01002322 int res = 0;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00002323
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002324 /* Count the number of entries in both tables */
2325 for (n = 0; newtab[n].name != NULL; n++)
2326 ;
2327 if (n == 0)
2328 return 0; /* Nothing to do */
2329 for (i = 0; PyImport_Inittab[i].name != NULL; i++)
2330 ;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00002331
Victor Stinner92a3c6f2017-12-06 18:12:59 +01002332 /* Force default raw memory allocator to get a known allocator to be able
2333 to release the memory in _PyImport_Fini2() */
2334 PyMemAllocatorEx old_alloc;
2335 _PyMem_SetDefaultAllocator(PYMEM_DOMAIN_RAW, &old_alloc);
2336
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002337 /* Allocate new memory for the combined table */
Benjamin Peterson0c644fc2017-12-15 23:42:33 -08002338 p = NULL;
2339 if (i + n <= SIZE_MAX / sizeof(struct _inittab) - 1) {
Victor Stinner92a3c6f2017-12-06 18:12:59 +01002340 size_t size = sizeof(struct _inittab) * (i + n + 1);
2341 p = PyMem_RawRealloc(inittab_copy, size);
2342 }
Victor Stinner92a3c6f2017-12-06 18:12:59 +01002343 if (p == NULL) {
2344 res = -1;
2345 goto done;
2346 }
Guido van Rossum09cae1f1998-05-14 02:32:54 +00002347
Victor Stinner92a3c6f2017-12-06 18:12:59 +01002348 /* Copy the tables into the new memory at the first call
2349 to PyImport_ExtendInittab(). */
2350 if (inittab_copy != PyImport_Inittab) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002351 memcpy(p, PyImport_Inittab, (i+1) * sizeof(struct _inittab));
Victor Stinner92a3c6f2017-12-06 18:12:59 +01002352 }
2353 memcpy(p + i, newtab, (n + 1) * sizeof(struct _inittab));
2354 PyImport_Inittab = inittab_copy = p;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00002355
Victor Stinner92a3c6f2017-12-06 18:12:59 +01002356done:
2357 PyMem_SetAllocator(PYMEM_DOMAIN_RAW, &old_alloc);
2358 return res;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00002359}
2360
2361/* Shorthand to add a single entry given a name and a function */
2362
2363int
Brett Cannona826f322009-04-02 03:41:46 +00002364PyImport_AppendInittab(const char *name, PyObject* (*initfunc)(void))
Guido van Rossum09cae1f1998-05-14 02:32:54 +00002365{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002366 struct _inittab newtab[2];
Guido van Rossum09cae1f1998-05-14 02:32:54 +00002367
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002368 memset(newtab, '\0', sizeof newtab);
Guido van Rossum09cae1f1998-05-14 02:32:54 +00002369
Serhiy Storchaka20b39b22014-09-28 11:27:24 +03002370 newtab[0].name = name;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002371 newtab[0].initfunc = initfunc;
Guido van Rossum09cae1f1998-05-14 02:32:54 +00002372
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002373 return PyImport_ExtendInittab(newtab);
Guido van Rossum09cae1f1998-05-14 02:32:54 +00002374}
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002375
2376#ifdef __cplusplus
2377}
2378#endif