Stowage/cpython
2
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-11-04 07:31:38 +00:00
Code Issues Projects Releases Packages Wiki Activity
cpython/Python/frozen.c

135 lines
6.1 KiB
C
Raw Normal View History

grand renaming; added copyright to some files
1996-05-28 22:30:17 +00:00
bpo-45019: Add a tool to generate list of modules to include for frozen modules (gh-27980) Frozen modules must be added to several files in order to work properly. Before this change this had to be done manually. Here we add a tool to generate the relevant lines in those files instead. This helps us avoid mistakes and omissions. https://bugs.python.org/issue45019
2021-08-30 17:25:11 -06:00
/* Frozen modules initializer
*
* Frozen modules are written to header files by Programs/_freeze_module.
* These files are typically put in Python/frozen_modules/. Each holds
* an array of bytes named "_Py_M__<module>", which is used below.
*
* These files must be regenerated any time the corresponding .pyc
* file would change (including with changes to the compiler, bytecode
* format, marshal format). This can be done with "make regen-frozen".
gh-97669: Create Tools/build/ directory (#97963) Create Tools/build/ directory. Move the following scripts from Tools/scripts/ to Tools/build/: * check_extension_modules.py * deepfreeze.py * freeze_modules.py * generate_global_objects.py * generate_levenshtein_examples.py * generate_opcode_h.py * generate_re_casefix.py * generate_sre_constants.py * generate_stdlib_module_names.py * generate_token.py * parse_html5_entities.py * smelly.py * stable_abi.py * umarshal.py * update_file.py * verify_ensurepip_wheels.py Update references to these scripts.
2022-10-17 12:01:00 +02:00
* That make target just runs Tools/build/freeze_modules.py.
bpo-45019: Add a tool to generate list of modules to include for frozen modules (gh-27980) Frozen modules must be added to several files in order to work properly. Before this change this had to be done manually. Here we add a tool to generate the relevant lines in those files instead. This helps us avoid mistakes and omissions. https://bugs.python.org/issue45019
2021-08-30 17:25:11 -06:00
*
* The freeze_modules.py script also determines which modules get
* frozen. Update the list at the top of the script to add, remove,
* or modify the target modules. Then run the script
* (or run "make regen-frozen").
*
* The script does the following:
*
* 1. run Programs/_freeze_module on the target modules
* 2. update the includes and _PyImport_FrozenModules[] in this file
* 3. update the FROZEN_FILES variable in Makefile.pre.in
* 4. update the per-module targets in Makefile.pre.in
* 5. update the lists of modules in PCbuild/_freeze_module.vcxproj and
* PCbuild/_freeze_module.vcxproj.filters
*
* (Note that most of the data in this file is auto-generated by the script.)
*
* Those steps can also be done manually, though this is not recommended.
* Expect such manual changes to be removed the next time
* freeze_modules.py runs.
* */
grand renaming; added copyright to some files
1996-05-28 22:30:17 +00:00
Initial revision
1995-08-04 04:20:48 +00:00
/* In order to test the support for frozen modules, by default we
bpo-45019: Add a tool to generate list of modules to include for frozen modules (gh-27980) Frozen modules must be added to several files in order to work properly. Before this change this had to be done manually. Here we add a tool to generate the relevant lines in those files instead. This helps us avoid mistakes and omissions. https://bugs.python.org/issue45019
2021-08-30 17:25:11 -06:00
define some simple frozen modules: __hello__, __phello__ (a package),
and __phello__.spam. Loading any will print some famous words... */
Initial revision
1995-08-04 04:20:48 +00:00
bpo-45019: Add a tool to generate list of modules to include for frozen modules (gh-27980) Frozen modules must be added to several files in order to work properly. Before this change this had to be done manually. Here we add a tool to generate the relevant lines in those files instead. This helps us avoid mistakes and omissions. https://bugs.python.org/issue45019
2021-08-30 17:25:11 -06:00
#include "Python.h"
bpo-45020: Identify which frozen modules are actually aliases. (gh-28655) In the list of generated frozen modules at the top of Tools/scripts/freeze_modules.py, you will find that some of the modules have a different name than the module (or .py file) that is actually frozen. Let's call each case an "alias". Aliases do not come into play until we get to the (generated) list of modules in Python/frozen.c. (The tool for freezing modules, Programs/_freeze_module, is only concerned with the source file, not the module it will be used for.) Knowledge of which frozen modules are aliases (and the identity of the original module) normally isn't important. However, this information is valuable when we go to set __file__ on frozen stdlib modules. This change updates Tools/scripts/freeze_modules.py to map aliases to the original module name (or None if not a stdlib module) in Python/frozen.c. We also add a helper function in Python/import.c to look up a frozen module's alias and add the result of that function to the frozen info returned from find_frozen(). https://bugs.python.org/issue45020
2021-10-05 11:26:37 -06:00
#include "pycore_import.h"
Initial revision
1995-08-04 04:20:48 +00:00
bpo-46748: Don't import <stdbool.h> in public headers (GH-31553) <stdbool.h> is the standard/modern way to define embedd/extends Python free to define bool, true and false, but there are existing applications that use slightly different redefinitions, which fail if the header is included. It's OK to use stdbool outside the public headers, though. https://bugs.python.org/issue46748
2022-02-25 09:25:54 +01:00
#include <stdbool.h>
bpo-45019: Add a tool to generate list of modules to include for frozen modules (gh-27980) Frozen modules must be added to several files in order to work properly. Before this change this had to be done manually. Here we add a tool to generate the relevant lines in those files instead. This helps us avoid mistakes and omissions. https://bugs.python.org/issue45019
2021-08-30 17:25:11 -06:00
/* Includes for frozen modules: */
gh-100227: Only Use deepfreeze for the Main Interpreter (gh-103794) Deep-frozen code objects are cannot be shared (currently) by interpreters, due to how adaptive specialization can modify the bytecodes. We work around this by only using the deep-frozen objects in the main interpreter. This does incur a performance penalty for subinterpreters, which we may be able to resolve later.
2023-04-24 15:48:05 -06:00
#include "frozen_modules/importlib._bootstrap.h"
#include "frozen_modules/importlib._bootstrap_external.h"
#include "frozen_modules/zipimport.h"
#include "frozen_modules/abc.h"
#include "frozen_modules/codecs.h"
#include "frozen_modules/io.h"
#include "frozen_modules/_collections_abc.h"
#include "frozen_modules/_sitebuiltins.h"
#include "frozen_modules/genericpath.h"
#include "frozen_modules/ntpath.h"
#include "frozen_modules/posixpath.h"
#include "frozen_modules/os.h"
#include "frozen_modules/site.h"
#include "frozen_modules/stat.h"
#include "frozen_modules/importlib.util.h"
#include "frozen_modules/importlib.machinery.h"
#include "frozen_modules/runpy.h"
#include "frozen_modules/__hello__.h"
#include "frozen_modules/__phello__.h"
#include "frozen_modules/__phello__.ham.h"
#include "frozen_modules/__phello__.ham.eggs.h"
#include "frozen_modules/__phello__.spam.h"
#include "frozen_modules/frozen_only.h"
bpo-45019: Add a tool to generate list of modules to include for frozen modules (gh-27980) Frozen modules must be added to several files in order to work properly. Before this change this had to be done manually. Here we add a tool to generate the relevant lines in those files instead. This helps us avoid mistakes and omissions. https://bugs.python.org/issue45019
2021-08-30 17:25:11 -06:00
/* End includes */
bpo-45395: Make custom frozen modules additions instead of replacements. (gh-28778) Currently custom modules (the array set on PyImport_FrozenModules) replace all the frozen stdlib modules. That can be problematic and is unlikely to be what the user wants. This change treats the custom frozen modules as additions instead. They take precedence over all other frozen modules except for those needed to bootstrap the import system. If the "code" field of an entry in the custom array is NULL then that frozen module is treated as disabled, which allows a custom entry to disable a frozen stdlib module. This change allows us to get rid of is_essential_frozen_module() and simplifies the logic for which frozen modules should be ignored. https://bugs.python.org/issue45395
2021-10-28 15:04:33 -06:00
static const struct _frozen bootstrap_modules[] = {
GH-108716: Turn off deep-freezing of code objects. (GH-108722)
2023-09-08 10:34:40 +01:00
{"_frozen_importlib", _Py_M__importlib__bootstrap, (int)sizeof(_Py_M__importlib__bootstrap), false},
{"_frozen_importlib_external", _Py_M__importlib__bootstrap_external, (int)sizeof(_Py_M__importlib__bootstrap_external), false},
{"zipimport", _Py_M__zipimport, (int)sizeof(_Py_M__zipimport), false},
bpo-45395: Make custom frozen modules additions instead of replacements. (gh-28778) Currently custom modules (the array set on PyImport_FrozenModules) replace all the frozen stdlib modules. That can be problematic and is unlikely to be what the user wants. This change treats the custom frozen modules as additions instead. They take precedence over all other frozen modules except for those needed to bootstrap the import system. If the "code" field of an entry in the custom array is NULL then that frozen module is treated as disabled, which allows a custom entry to disable a frozen stdlib module. This change allows us to get rid of is_essential_frozen_module() and simplifies the logic for which frozen modules should be ignored. https://bugs.python.org/issue45395
2021-10-28 15:04:33 -06:00
{0, 0, 0} /* bootstrap sentinel */
};
static const struct _frozen stdlib_modules[] = {
bpo-45020: Freeze os, site, and codecs. (gh-28398) https://bugs.python.org/issue45020
2021-09-17 16:31:31 -06:00
/* stdlib - startup, without site (python -S) */
GH-108716: Turn off deep-freezing of code objects. (GH-108722)
2023-09-08 10:34:40 +01:00
{"abc", _Py_M__abc, (int)sizeof(_Py_M__abc), false},
{"codecs", _Py_M__codecs, (int)sizeof(_Py_M__codecs), false},
{"io", _Py_M__io, (int)sizeof(_Py_M__io), false},
bpo-45020: Freeze os, site, and codecs. (gh-28398) https://bugs.python.org/issue45020
2021-09-17 16:31:31 -06:00
/* stdlib - startup, with site */
GH-108716: Turn off deep-freezing of code objects. (GH-108722)
2023-09-08 10:34:40 +01:00
{"_collections_abc", _Py_M___collections_abc, (int)sizeof(_Py_M___collections_abc), false},
{"_sitebuiltins", _Py_M___sitebuiltins, (int)sizeof(_Py_M___sitebuiltins), false},
{"genericpath", _Py_M__genericpath, (int)sizeof(_Py_M__genericpath), false},
{"ntpath", _Py_M__ntpath, (int)sizeof(_Py_M__ntpath), false},
{"posixpath", _Py_M__posixpath, (int)sizeof(_Py_M__posixpath), false},
{"os.path", _Py_M__posixpath, (int)sizeof(_Py_M__posixpath), false},
{"os", _Py_M__os, (int)sizeof(_Py_M__os), false},
{"site", _Py_M__site, (int)sizeof(_Py_M__site), false},
{"stat", _Py_M__stat, (int)sizeof(_Py_M__stat), false},
bpo-45654: Freeze the runpy module and stuff it imports (GH-29903)
2021-12-09 22:21:09 +05:30
/* runpy - run module with -m */
GH-108716: Turn off deep-freezing of code objects. (GH-108722)
2023-09-08 10:34:40 +01:00
{"importlib.util", _Py_M__importlib_util, (int)sizeof(_Py_M__importlib_util), false},
{"importlib.machinery", _Py_M__importlib_machinery, (int)sizeof(_Py_M__importlib_machinery), false},
{"runpy", _Py_M__runpy, (int)sizeof(_Py_M__runpy), false},
bpo-45395: Make custom frozen modules additions instead of replacements. (gh-28778) Currently custom modules (the array set on PyImport_FrozenModules) replace all the frozen stdlib modules. That can be problematic and is unlikely to be what the user wants. This change treats the custom frozen modules as additions instead. They take precedence over all other frozen modules except for those needed to bootstrap the import system. If the "code" field of an entry in the custom array is NULL then that frozen module is treated as disabled, which allows a custom entry to disable a frozen stdlib module. This change allows us to get rid of is_essential_frozen_module() and simplifies the logic for which frozen modules should be ignored. https://bugs.python.org/issue45395
2021-10-28 15:04:33 -06:00
{0, 0, 0} /* stdlib sentinel */
};
static const struct _frozen test_modules[] = {
GH-108716: Turn off deep-freezing of code objects. (GH-108722)
2023-09-08 10:34:40 +01:00
{"__hello__", _Py_M____hello__, (int)sizeof(_Py_M____hello__), false},
{"__hello_alias__", _Py_M____hello__, (int)sizeof(_Py_M____hello__), false},
{"__phello_alias__", _Py_M____hello__, (int)sizeof(_Py_M____hello__), true},
{"__phello_alias__.spam", _Py_M____hello__, (int)sizeof(_Py_M____hello__), false},
{"__phello__", _Py_M____phello__, (int)sizeof(_Py_M____phello__), true},
{"__phello__.__init__", _Py_M____phello__, (int)sizeof(_Py_M____phello__), false},
{"__phello__.ham", _Py_M____phello___ham, (int)sizeof(_Py_M____phello___ham), true},
{"__phello__.ham.__init__", _Py_M____phello___ham, (int)sizeof(_Py_M____phello___ham), false},
{"__phello__.ham.eggs", _Py_M____phello___ham_eggs, (int)sizeof(_Py_M____phello___ham_eggs), false},
{"__phello__.spam", _Py_M____phello___spam, (int)sizeof(_Py_M____phello___spam), false},
{"__hello_only__", _Py_M__frozen_only, (int)sizeof(_Py_M__frozen_only), false},
bpo-45395: Make custom frozen modules additions instead of replacements. (gh-28778) Currently custom modules (the array set on PyImport_FrozenModules) replace all the frozen stdlib modules. That can be problematic and is unlikely to be what the user wants. This change treats the custom frozen modules as additions instead. They take precedence over all other frozen modules except for those needed to bootstrap the import system. If the "code" field of an entry in the custom array is NULL then that frozen module is treated as disabled, which allows a custom entry to disable a frozen stdlib module. This change allows us to get rid of is_essential_frozen_module() and simplifies the logic for which frozen modules should be ignored. https://bugs.python.org/issue45395
2021-10-28 15:04:33 -06:00
{0, 0, 0} /* test sentinel */
Initial revision
1995-08-04 04:20:48 +00:00
};
bpo-45395: Make custom frozen modules additions instead of replacements. (gh-28778) Currently custom modules (the array set on PyImport_FrozenModules) replace all the frozen stdlib modules. That can be problematic and is unlikely to be what the user wants. This change treats the custom frozen modules as additions instead. They take precedence over all other frozen modules except for those needed to bootstrap the import system. If the "code" field of an entry in the custom array is NULL then that frozen module is treated as disabled, which allows a custom entry to disable a frozen stdlib module. This change allows us to get rid of is_essential_frozen_module() and simplifies the logic for which frozen modules should be ignored. https://bugs.python.org/issue45395
2021-10-28 15:04:33 -06:00
const struct _frozen *_PyImport_FrozenBootstrap = bootstrap_modules;
const struct _frozen *_PyImport_FrozenStdlib = stdlib_modules;
const struct _frozen *_PyImport_FrozenTest = test_modules;
New style interface via pointer variable.
1996-06-17 17:07:23 +00:00
bpo-45020: Identify which frozen modules are actually aliases. (gh-28655) In the list of generated frozen modules at the top of Tools/scripts/freeze_modules.py, you will find that some of the modules have a different name than the module (or .py file) that is actually frozen. Let's call each case an "alias". Aliases do not come into play until we get to the (generated) list of modules in Python/frozen.c. (The tool for freezing modules, Programs/_freeze_module, is only concerned with the source file, not the module it will be used for.) Knowledge of which frozen modules are aliases (and the identity of the original module) normally isn't important. However, this information is valuable when we go to set __file__ on frozen stdlib modules. This change updates Tools/scripts/freeze_modules.py to map aliases to the original module name (or None if not a stdlib module) in Python/frozen.c. We also add a helper function in Python/import.c to look up a frozen module's alias and add the result of that function to the frozen info returned from find_frozen(). https://bugs.python.org/issue45020
2021-10-05 11:26:37 -06:00
static const struct _module_alias aliases[] = {
{"_frozen_importlib", "importlib._bootstrap"},
{"_frozen_importlib_external", "importlib._bootstrap_external"},
{"os.path", "posixpath"},
{"__hello_alias__", "__hello__"},
{"__phello_alias__", "__hello__"},
{"__phello_alias__.spam", "__hello__"},
{"__phello__.__init__", "<__phello__"},
{"__phello__.ham.__init__", "<__phello__.ham"},
{"__hello_only__", NULL},
{0, 0} /* aliases sentinel */
};
const struct _module_alias *_PyImport_FrozenAliases = aliases;
New style interface via pointer variable.
1996-06-17 17:07:23 +00:00
/* Embedding apps may change this pointer to point to their favorite
collection of frozen modules: */
bpo-45395: Make custom frozen modules additions instead of replacements. (gh-28778) Currently custom modules (the array set on PyImport_FrozenModules) replace all the frozen stdlib modules. That can be problematic and is unlikely to be what the user wants. This change treats the custom frozen modules as additions instead. They take precedence over all other frozen modules except for those needed to bootstrap the import system. If the "code" field of an entry in the custom array is NULL then that frozen module is treated as disabled, which allows a custom entry to disable a frozen stdlib module. This change allows us to get rid of is_essential_frozen_module() and simplifies the logic for which frozen modules should be ignored. https://bugs.python.org/issue45395
2021-10-28 15:04:33 -06:00
const struct _frozen *PyImport_FrozenModules = NULL;
Reference in a new issue Copy permalink