Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

doc: gcc-plugins: update gcc-plugins.rst

This document was written a long time ago. Update it.

[1] Drop the version information

The range of the supported GCC versions are always changing. The
current minimal GCC version is 4.9, and commit 1e860048c53e
("gcc-plugins: simplify GCC plugin-dev capability test") removed the
old code accordingly.

We do not need to mention specific version ranges like "all gcc versions
from 4.5 to 6.0" since we forget to update the documentation when we
raise the minimal compiler version.

[2] Drop the C compiler statements

Since commit 77342a02ff6e ("gcc-plugins: drop support for GCC <= 4.7")
the GCC plugin infrastructure only supports g++.

[3] Drop supported architectures

As of v5.11-rc4, the infrastructure supports more architectures;
arm, arm64, mips, powerpc, riscv, s390, um, and x86. (just grep
"select HAVE_GCC_PLUGINS") Again, we miss to update this document when a
new architecture is supported. Let's just say "only some architectures".

[4] Update the apt-get example

We are now discussing to bump the minimal version to GCC 5. The GCC 4.9
support will be removed sooner or later. Change the package example to
gcc-10-plugin-dev while we are here.

[5] Update the build target

Since commit ce2fd53a10c7 ("kbuild: descend into scripts/gcc-plugins/
via scripts/Makefile"), "make gcc-plugins" is not supported.
"make scripts" builds all the enabled plugins, including some other
tools.

[6] Update the steps for adding a new plugin

At first, all CONFIG options for GCC plugins were located in arch/Kconfig.
After commit 45332b1bdfdc ("gcc-plugins: split out Kconfig entries to
scripts/gcc-plugins/Kconfig"), scripts/gcc-plugins/Kconfig became the
central place to collect plugin CONFIG options. In my understanding,
this requirement no longer exists because commit 9f671e58159a ("security:
Create "kernel hardening" config area") moved some of plugin CONFIG
options to another file. Find an appropriate place to add the new CONFIG.

The sub-directory support was never used by anyone, and removed by
commit c17d6179ad5a ("gcc-plugins: remove unused GCC_PLUGIN_SUBDIR").

Remove the useless $(src)/ prefix.

Signed-off-by: Masahiro Yamada <masahiroy@kernel.org>

+21 -20
+21 -20
Documentation/kbuild/gcc-plugins.rst
··· 11 11 We can analyse, change and add further code during compilation via 12 12 callbacks [2]_, GIMPLE [3]_, IPA [4]_ and RTL passes [5]_. 13 13 14 - The GCC plugin infrastructure of the kernel supports all gcc versions from 15 - 4.5 to 6.0, building out-of-tree modules, cross-compilation and building in a 16 - separate directory. 17 - Plugin source files have to be compilable by both a C and a C++ compiler as well 18 - because gcc versions 4.5 and 4.6 are compiled by a C compiler, 19 - gcc-4.7 can be compiled by a C or a C++ compiler, 20 - and versions 4.8+ can only be compiled by a C++ compiler. 14 + The GCC plugin infrastructure of the kernel supports building out-of-tree 15 + modules, cross-compilation and building in a separate directory. 16 + Plugin source files have to be compilable by a C++ compiler. 21 17 22 - Currently the GCC plugin infrastructure supports only the x86, arm, arm64 and 23 - powerpc architectures. 18 + Currently the GCC plugin infrastructure supports only some architectures. 19 + Grep "select HAVE_GCC_PLUGINS" to find out which architectures support 20 + GCC plugins. 24 21 25 22 This infrastructure was ported from grsecurity [6]_ and PaX [7]_. 26 23 ··· 50 53 $(src)/scripts/gcc-plugins/gcc-generate-rtl-pass.h** 51 54 52 55 These headers automatically generate the registration structures for 53 - GIMPLE, SIMPLE_IPA, IPA and RTL passes. They support all gcc versions 54 - from 4.5 to 6.0. 56 + GIMPLE, SIMPLE_IPA, IPA and RTL passes. 55 57 They should be preferred to creating the structures by hand. 56 58 57 59 ··· 58 62 ===== 59 63 60 64 You must install the gcc plugin headers for your gcc version, 61 - e.g., on Ubuntu for gcc-4.9:: 65 + e.g., on Ubuntu for gcc-10:: 62 66 63 - apt-get install gcc-4.9-plugin-dev 67 + apt-get install gcc-10-plugin-dev 64 68 65 69 Or on Fedora:: 66 70 67 71 dnf install gcc-plugin-devel 68 72 69 - Enable a GCC plugin based feature in the kernel config:: 73 + Enable the GCC plugin infrastructure and some plugin(s) you want to use 74 + in the kernel config:: 70 75 71 - CONFIG_GCC_PLUGIN_CYC_COMPLEXITY = y 76 + CONFIG_GCC_PLUGINS=y 77 + CONFIG_GCC_PLUGIN_CYC_COMPLEXITY=y 78 + CONFIG_GCC_PLUGIN_LATENT_ENTROPY=y 79 + ... 72 80 73 - To compile only the plugin(s):: 81 + To compile the minimum tool set including the plugin(s):: 74 82 75 - make gcc-plugins 83 + make scripts 76 84 77 85 or just run the kernel make and compile the whole kernel with 78 86 the cyclomatic complexity GCC plugin. ··· 85 85 4. How to add a new GCC plugin 86 86 ============================== 87 87 88 - The GCC plugins are in $(src)/scripts/gcc-plugins/. You can use a file or a directory 89 - here. It must be added to $(src)/scripts/gcc-plugins/Makefile, 90 - $(src)/scripts/Makefile.gcc-plugins and $(src)/arch/Kconfig. 88 + The GCC plugins are in scripts/gcc-plugins/. You need to put plugin source files 89 + right under scripts/gcc-plugins/. Creating subdirectories is not supported. 90 + It must be added to scripts/gcc-plugins/Makefile, scripts/Makefile.gcc-plugins 91 + and a relevant Kconfig file. 91 92 See the cyc_complexity_plugin.c (CONFIG_GCC_PLUGIN_CYC_COMPLEXITY) GCC plugin.