在 Ubuntu 22.04 中编译 tensorflow 2，并调试源代码

引言

本文描述如何在 Ubuntu 22.04 中编译 tensorflow 2 源码，以及如何生成 Python 代码包，并能够调试 tensorflow 源码，包括单步执行、观察变量和表达式等能力。

准备工作

请参照各自官方文档准备所需环境，在此不再赘述。

• Ubuntu 22.04, Windows 用户推荐使用 WSL 2。
• Python 3.10 ~ 3.12，安装在 Ubuntu 22.04 中。其中 Python 3.10 为 Ubuntu 22.04 默认分发版本。
• LLVM 16，安装在 Ubuntu 22.04 中。
• Bazel 最新版，安装在 Ubuntu 22.04 中。
• Visual Studio Code 最新版，用于调试 tensorflow。截至发稿时，使用的版本为 1.85.1。

准备 Ubuntu 22.04

1. 参考文章：https://aka.ms/wsl2 安装 Ubuntu 22.04。
2. 参考文章：https://www.tensorflow.org/install/source?hl=zh-cn 中的“Linux 和 macOS 设置”、“配置 build”和“构建 pip 软件包” 准备构建 tensorflow 的环境。

编译带调试符号的 tensorflow 安装包

按照 tensorflow 官方文档说明编译的代码包不包含调试符号。使用不带调试符号的 tensorflow 无法实现 tensorflow 源码级的调试。
因此，实际的编译命令为：

bazel build -c dbg --copt="-O0" --copt="-g"  --cxxopt="-O0" --cxxopt="-g" --strip=never --copt="-mavx" --cxxopt="-mavx" //tensorflow/tools/pip_package:build_pip_package

其中：
--copt 和 --cxxopt 为编译参数。-O0 为优化级别为0，即不优化。-g 为编译时带调试符号。-c dbg 为编译用于调试的代码包。--strip=never 表示编译后的二进制文件不适用条带化。-mavx 表示启用 avx 指令集。

注意：

1. 暂不启用 cuda。
2. 首次编译过程中需要在线更新第三方依赖代码包。中国大陆访问部分代码包可能受限。

建议：

1. 选定 Python 版本和 tensorflow 版本后再编译，如 Python 3.10 和 tensorflow 源代码的 v2.15.0 分支。使用 Python 的 virtualenv 代码包创建虚拟空间并启用，在虚拟空间下编译 tensorflow。
2. 带符号的代码包可能体积非常大，需要准备较高的磁盘空间和内存空间。如果需要较好的写入速度，推荐使用固态硬盘。

配置 Visual Studio Code

需要将 Visual Studio Code 安装到 WSL-Ubuntu-22.04 中，然后再准备下述条件：

需要的插件

1. C/C++
2. C/C++ Extension Pack
3. Chinese (Simplified) (简体中文) Language Pack for Visual Studio Code
4. clangd
5. Pylance
6. Pylint
7. Python
8. Python C++ Debuger
9. Python Extension Pack

运行和调试配置

{
    "version": "0.2.0",
    "configurations": [
        {
            "name": "Python C++ Debugger",
            "type": "pythoncpp",
            "request": "launch",
            "pythonConfig": "custom",
            "pythonLaunchName": "Python: Current File",
            "cppConfig": "custom",
            "cppAttachName": "(lldb) Attach"
        },
        {
            "name": "Python: Current File",
            "type": "python",
            "request": "launch",
            "program": "${file}",
            "console": "integratedTerminal",
            "justMyCode": false,
            "subProcess": true,
            "env": {
                "PYTHONPATH": "${workspaceFolder}"
            }
        },
        {
            "name": "(lldb) Attach",
            "type": "lldb",
            "request": "attach",
            "pid": "${command:pickMyProcess}",
            "sourceMap": {
                "/proc/self/cwd/external": "${workspaceFolder}/tensorflow/bazel-out/k8-dbg/bin/tensorflow/tools/pip_package/build_pip_package.runfiles/org_tensorflow/external",
                "/proc/self/cwd": "${workspaceFolder}/tensorflow",
            }
        }
    ]
}

注意：上述配置中的 sourceMap 请根据实际情况调整。如果在调试过程中看到了汇编，且汇编包含了文件和函数标记，则表明源代码映射没成功。