Documentation/kbuild/gcc-plugins.rst

2 GCC plugin infrastructure
9 GCC plugins are loadable modules that provide extra features to the
14 The GCC plugin infrastructure of the kernel supports all gcc versions from
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,
22 Currently the GCC plugin infrastructure supports only the x86, arm, arm64 and
29 .. [1] https://gcc.gnu.org/onlinedocs/gccint/Plugins.html
30 .. [2] https://gcc.gnu.org/onlinedocs/gccint/Plugin-API.html#Plugin-API
31 .. [3] https://gcc.gnu.org/onlinedocs/gccint/GIMPLE.html
32 .. [4] https://gcc.gnu.org/onlinedocs/gccint/IPA.html
33 .. [5] https://gcc.gnu.org/onlinedocs/gccint/RTL.html
41 **$(src)/scripts/gcc-plugins**
43 	This is the directory of the GCC plugins.
45 **$(src)/scripts/gcc-plugins/gcc-common.h**
47 	This is a compatibility header for GCC plugins.
48 	It should be always included instead of individual gcc headers.
50 **$(src)/scripts/gcc-plugin.sh**
53 	gcc-common.h and chooses the proper host compiler to build the plugins
54 	(gcc-4.7 can be built by either gcc or g++).
56 **$(src)/scripts/gcc-plugins/gcc-generate-gimple-pass.h,
57 $(src)/scripts/gcc-plugins/gcc-generate-ipa-pass.h,
58 $(src)/scripts/gcc-plugins/gcc-generate-simple_ipa-pass.h,
59 $(src)/scripts/gcc-plugins/gcc-generate-rtl-pass.h**
62 	GIMPLE, SIMPLE_IPA, IPA and RTL passes. They support all gcc versions
70 You must install the gcc plugin headers for your gcc version,
71 e.g., on Ubuntu for gcc-4.9::
73 	apt-get install gcc-4.9-plugin-dev
77 	dnf install gcc-plugin-devel
79 Enable a GCC plugin based feature in the kernel config::
85 	make gcc-plugins
88 the cyclomatic complexity GCC plugin.
91 4. How to add a new GCC plugin
94 The GCC plugins are in $(src)/scripts/gcc-plugins/. You can use a file or a directory
95 here. It must be added to $(src)/scripts/gcc-plugins/Makefile,
96 $(src)/scripts/Makefile.gcc-plugins and $(src)/arch/Kconfig.
97 See the cyc_complexity_plugin.c (CONFIG_GCC_PLUGIN_CYC_COMPLEXITY) GCC plugin.