CPython Internals 笔记 ── 编译 Python

[qiwihui]

现在你已经下载了 CPython 开发环境并对其进行了配置，你可以将 CPython 源代码编译成一个可执行的解释器。

与 Python 文件不同，C 源代码每次更改时都必须重新编译。

在前一章中，我们已经设置开发环境，并设置了运行“Build”阶段的选项，该选项将重新编译 CPython。
在构建步骤工作之前，你需要一个 C 编译器和一些构建工具。
使用的工具取决于你使用的操作系统。

如果你担心这些步骤中的任何一个会干扰您现有的 CPython 安装，请不要担心。CPython 源目录的行为就像一个虚拟环境。

对于编译 CPython、修改源代码和标准库，这些都保留在源目录的沙箱中。

如果要安装自定义版本，本章也将介绍此步骤。

在 macOS 系统上编译 CPython

在 macOS 上编译 CPython 需要一些额外的应用程序和库。你首先需要基本的 C 编译器工具包。
“Command Line Development Tools” 是一个可以在 macOS 中通过 App Store 更新的应用程序。
你需要在终端上执行初始安装。

在终端中，通过运行以下命令安装 C 编译器和工具包：

$ xcode-select --install

该命令会弹出一个提示，提示下载并安装一组工具，包括 Git、Make 和 GNU C 编译器。

你还需要一份 OpenSSL 的工作副本，用于从 PyPi.org 网站获取包。
如果你以后计划使用此构建版本来安装其他软件包，则需要进行 SSL 验证。

在 macOS 上安装 OpenSSL 的最简单方法是使用 Homebrew。

可以使用一下命令安装 Homebrew：

$ /usr/bin/ruby -e "$(curl -fsSL \
 https://raw.githubusercontent.com/Homebrew/install/master/install)"

一旦安装完成，你就可以使用 brew install 命令来安装所需的工具。

$ brew install openssl xz zlib gdbm sqlite

现在你已经安装了依赖项，你可以运行 configure 脚本。
Homebrew 有一个命令 brew --prefix [package] ，它将给出安装包的目录。
你将通过编译 Homebrew 使用的位置来启用对 SSL 的支持。

标志 --with-pydebug 启用调试挂钩。如果你打算出于开发或测试目的进行调试，请添加此项。

配置阶段只需要运行一次，同时指定 zlib 包的位置：

$ CPPFLAGS="-I$(brew --prefix zlib)/include" \
 LDFLAGS="-L$(brew --prefix zlib)/lib -L$(brew --prefix bzip2)/lib" \
 ./configure --with-openssl=$(brew --prefix openssl) --with-pydebug

运行 configure 将在存储库的根目录中生成一个 Makefile，你可以使用它来自动化构建过程。

你现在可以通过运行一下命令来构建 CPython 二进制文件：

$ make -j2 -s

在构建过程中，你可能会收到一些错误。在构建摘要中，make 会通知你并非所有包都已构建。
例如，ossaudiodev、spwd 和 _tkinter 将无法使用这组指令进行构建。
如果你不打算针对这些软件包进行开发，那也没关系。
如果是，请查看官方开发指南网站以获取更多信息。

构建将需要几分钟并生成一个名为 python.exe 的二进制文件。每次对源代码进行更改时，
你都会需要使用相同的标志重新运行 make。
python.exe 二进制文件是 CPython 的调试二进制文件。
执行 python.exe 以查看有效的 REPL：

$ ./python.exe
Python 3.9.0b1 (tags/v3.9.0b1:97fe9cf, May 19 2020, 10:00:00)
[Clang 10.0.1 (clang-1001.0.46.4)] on darwin
Type "help", "copyright", "credits" or "license" for more information.
>>>

是的，没错，macOS 版本的文件扩展名为 .exe。 这个扩展不是因为它是 Windows 二进制文件！
因为 macOS 有一个不区分大小写的文件系统，并且在使用二进制文件时，
开发人员不希望人们不小心引用 Python/ 目录，因此附加了 .exe 以避免歧义。
如果你稍后运行 make install 或 make altinstall，
它将在将文件安装到你的系统之前将文件重命名回 python。

配置文件引导优化

macOS、Linux 和 Windows 构建过程具有“PGO”或“Profile Guided Optimization”标志。
PGO 不是 Python 团队创建的东西，而是许多编译器的特性，包括 CPython 使用的编译器。

PGO 的工作方式是进行初始编译，然后通过运行一系列测试来分析应用程序。
然后分析创建的配置文件，编译器将对二进制文件进行更改以提高性能。

对于 CPython，分析阶段运行 python -m test --pgo，
它执行在 Lib/test/libregrtest/pgo.py 中指定的回归测试。
这些测试是专门选择的，因为它们使用常用的 C 扩展模块或类型。

PGO 过程非常耗时，因此在整本书中，我将其排除在推荐步骤列表之外，以缩短编译时间。
如果要将自定义编译版本的 CPython 分发到生产环境中，
则应在 Linux 和 macOS 中使用 --with-pgo 标志运行 ./configure，
并在 Windows 上使用 --pgo 标志运行 build.bat。

由于优化特定于执行配置文件的平台和架构，因此无法在操作系统或 CPU 架构之间共享 PGO 配置文件。
python.org 上的 CPython 发行版已经通过 PGO，所以如果你在编译的二进制文件上运行基准测试，
它会比从 python.org 下载的要慢。

Windows、macOS 和 Linux 配置文件引导的优化包括以下检查和改进：

• 函数内联 ── 如果函数被另一个函数定期调用，那么它将被“内联”以减少堆栈大小。
• 虚拟调用推测和内联 ── 如果一个虚拟函数调用频繁地针对某个函数，
  PGO 可以插入一个有条件执行的对该函数的直接调用。然后可以内联直接调用。
• 寄存器分配优化 ── 基于配置文件数据结果，PGO 将优化寄存器分配。
• 基本块优化 ── 基本块优化允许在给定帧内临时执行的共同执行的基本块放置在同一组页面（局部性）中。
  它最大限度地减少了使用的页面数量，从而最大限度地减少了内存开销。
• 热点优化 ── 程序花费最多执行时间的函数可以优化速度。
• 函数布局优化 ── 在分析调用图之后，倾向于沿着相同执行路径的函数被移动到编译应用程序的同一部分。
• 条件分支优化 - PGO 可以查看决策分支，如 if..else if 或 switch 语句，并找出最常用的路径。
  例如，如果 switch 语句中有 10 个 case，其中一个使用了 95% 的时间，那么它会被移到顶部，以便在代码路径中立即执行。
• 死点分离 ── 在 PGO 期间未调用的代码被移动到应用程序的单独部分。

结论

在本章中，你已经了解了如何将 CPython 源代码编译成可工作的解释器。
在探索和改编源代码时，你可以在整本书中使用这些知识。

在使用 CPython 时，你可能需要重复编译步骤数十次甚至数百次。
如果你可以调整你的开发环境来创建重新编译的快捷方式，最好现在就这样做，这样可以节省大量时间。

GitHub repo: qiwihui/blog

Follow me: @qiwihui

Site: QIWIHUI