xref: /linux/Documentation/translations/zh_CN/kbuild/reproducible-builds.rst (revision fcc79e1714e8c2b8e216dc3149812edd37884eef)
1.. SPDX-License-Identifier: GPL-2.0
2
3.. include:: ../disclaimer-zh_CN.rst
4
5:Original: Documentation/kbuild/reproducible-builds.rst
6
7:Translator: 慕冬亮 Dongliang Mu <dzm91@hust.edu.cn>
8
9============
10可重现的构建
11============
12
13通常希望使用相同工具集构建相同源代码是可重现的,即,输出始终完全相同。这使得能够验证
14二进制分发或嵌入式系统的构建基础设施未被篡改。这样也更容易验证源代码或工具的更改不会
15影响最终生成的二进制文件。
16
17`可重现构建项目`_ 提供了有关该主题的更多信息。本文档涵盖了构建内核可能不可重现的
18各种原因,以及如何避免这些问题。
19
20时间戳
21------
22
23内核在三个地方嵌入时间戳:
24
25* 通过 ``uname()`` 显示与包含在 ``/proc/version`` 中的版本字符串
26
27* initramfs 中的文件时间戳
28
29* 如果启动 ``CONFIG_IKHEADERS``,内核或相应模块中嵌入的内核头文件的时间戳,
30  通过 ``/sys/kernel/kheaders.tar.xz`` 显示
31
32默认情况下,时间戳为当前时间或内核头文件的修改时间。这个内容必须使用
33`KBUILD_BUILD_TIMESTAMP`_ 变量进行覆盖。如果你从某个 git 提交进行构建,
34可以使用其提交日期。
35
36内核 *不* 使用 ``__DATE__`` 和 ``__TIME__`` 宏,并在使用这些宏时启用警告。
37如果你合并的外部代码使用这些宏,则必须通过设置 `SOURCE_DATE_EPOCH`_ 环境
38变量来覆盖它们对应的时间戳。
39
40用户,主机
41----------
42
43内核在 ``/proc/version`` 中嵌入构建用户和主机名。必须使用
44`KBUILD_BUILD_USER 和 KBUILD_BUILD_HOST`_ 变量来覆盖这些设置。如果
45您从某个 git 提交进行构建,可以使用其提交者地址。
46
47绝对文件名
48----------
49
50当内核在树外构建时,调试信息可能包括源文件的绝对文件名。这些信息必须通过在
51`KCFLAGS`_ 变量中包含 ``-fdebug-prefix-map`` 选项来覆盖。
52
53根据使用的编译器,``__FILE__`` 宏在树外构建中也可能扩展为绝对文件名。Kbuild
54自动使用 ``-fmacro-prefix-map`` 选项来防止这种情况,前提是它被支持。
55
56可重现构建网站提供了有关这些 `prefix-map 选项`_ 的更多信息。
57
58在源包中的生成文件
59------------------
60
61在 ``tools/`` 子目录下,一些程序的构建过程并不完全支持树外构建。这可能导致后续
62使用如 ``make rpm-pkg`` 构建的源码包包含生成的文件。在构建源码包之前,您应该通过
63运行 ``make mrproper`` 或 ``git clean -d -f -x`` 来确保源码树是干净的。
64
65模块签名
66--------
67
68如果你启用 ``CONFIG_MODULE_SIG_ALL``,默认行为是为每次构建生成不同的临时密钥,
69从而导致模块不可重现。然而,将签名密钥包含在源代码中显然会违背签名模块的目的。
70
71一种方法是将构建过程分为几个部分,以便不可重现的部分可以作为源处理:
72
731. 生成一个持久的签名密钥。将该密钥的证书添加到内核源代码中。
74
752. 将 ``CONFIG_SYSTEM_TRUSTED_KEYS`` 符号设置为包括签名密钥的证书,将
76``CONFIG_MODULE_SIG_KEY`` 设置为空字符串,并禁用 ``CONFIG_MODULE_SIG_ALL``。
77最后,构建内核和模块。
78
793. 为模块创建分离的签名,并将它们作为源发布。
80
814. 附加模块签名并进行第二次构建。这可以重建模块,或使用步骤 2 的输出。
82
83结构随机化
84----------
85
86如果你启用 ``CONFIG_RANDSTRUCT``,则需要在 ``scripts/basic/randstruct.seed``
87中预生成随机种子,以便每次构建都使用相同的值。有关详细信息,请参见
88``scripts/gen-randstruct-seed.sh``。
89
90调试信息冲突
91------------
92
93这并非是个不可重现性的问题,而是生成的文件 *过于* 可重现的问题。
94
95一旦你设置了所有必要的变量来开展可重现构建,vDSO 的调试信息可能即使对于不同的内核版
96本也是相同的。这会导致不同内核版本的调试信息软件包之间发生文件冲突。
97
98为了避免这种情况,你可以通过在 vDSO 中包含一个任意的 salt 字符串,使其对于不同的
99内核版本是不同的。这种机制由 Kconfig 符号 ``CONFIG_BUILD_SALT`` 指定。
100
101Git
102---
103
104未提交的更改或 Git 中的不同提交 ID 也可能导致不同的编译结果。例如,在执行
105``git reset HEAD^`` 后,即使代码相同,编译期间生成的
106``include/config/kernel.release`` 也会不同,导致最终生成的二进制文件也不尽相同。
107有关详细信息,请参见 ``scripts/setlocalversion``。
108
109.. _KBUILD_BUILD_TIMESTAMP: kbuild.html#kbuild-build-timestamp
110.. _KBUILD_BUILD_USER 和 KBUILD_BUILD_HOST: kbuild.html#kbuild-build-user-kbuild-build-host
111.. _KCFLAGS: kbuild.html#kcflags
112.. _prefix-map 选项: https://reproducible-builds.org/docs/build-path/
113.. _可重现构建项目: https://reproducible-builds.org/
114.. _SOURCE_DATE_EPOCH: https://reproducible-builds.org/docs/source-date-epoch/
115