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

gcc-plugins: Remove cyc_complexity

This plugin has no impact on the resulting binary, is disabled
under COMPILE_TEST, and is not enabled on any builds I'm aware of.
Additionally, given the clarified purpose of GCC plugins in the kernel,
remove cyc_complexity.

Cc: Masahiro Yamada <masahiroy@kernel.org>
Cc: Michal Marek <michal.lkml@markovi.net>
Cc: Nick Desaulniers <ndesaulniers@google.com>
Cc: Jonathan Corbet <corbet@lwn.net>
Cc: linux-hardening@vger.kernel.org
Cc: linux-kbuild@vger.kernel.org
Cc: linux-doc@vger.kernel.org
Signed-off-by: Kees Cook <keescook@chromium.org>
Reviewed-by: Miguel Ojeda <ojeda@kernel.org>
Reviewed-by: Nathan Chancellor <nathan@kernel.org>
Acked-by: Nick Desaulniers <ndesaulniers@google.com>
Acked-by: Ard Biesheuvel <ardb@kernel.org>
Link: https://lore.kernel.org/r/20211020173554.38122-3-keescook@chromium.org

-89
-2
Documentation/kbuild/gcc-plugins.rst
··· 96 96 in the kernel config:: 97 97 98 98 CONFIG_GCC_PLUGINS=y 99 - CONFIG_GCC_PLUGIN_CYC_COMPLEXITY=y 100 99 CONFIG_GCC_PLUGIN_LATENT_ENTROPY=y 101 100 ... 102 101 ··· 114 115 right under scripts/gcc-plugins/. Creating subdirectories is not supported. 115 116 It must be added to scripts/gcc-plugins/Makefile, scripts/Makefile.gcc-plugins 116 117 and a relevant Kconfig file. 117 - See the cyc_complexity_plugin.c (CONFIG_GCC_PLUGIN_CYC_COMPLEXITY) GCC plugin.
-2
scripts/Makefile.gcc-plugins
··· 1 1 # SPDX-License-Identifier: GPL-2.0 2 2 3 - gcc-plugin-$(CONFIG_GCC_PLUGIN_CYC_COMPLEXITY) += cyc_complexity_plugin.so 4 - 5 3 gcc-plugin-$(CONFIG_GCC_PLUGIN_LATENT_ENTROPY) += latent_entropy_plugin.so 6 4 gcc-plugin-cflags-$(CONFIG_GCC_PLUGIN_LATENT_ENTROPY) \ 7 5 += -DLATENT_ENTROPY_PLUGIN
-16
scripts/gcc-plugins/Kconfig
··· 19 19 20 20 if GCC_PLUGINS 21 21 22 - config GCC_PLUGIN_CYC_COMPLEXITY 23 - bool "Compute the cyclomatic complexity of a function" if EXPERT 24 - depends on !COMPILE_TEST # too noisy 25 - help 26 - The complexity M of a function's control flow graph is defined as: 27 - M = E - N + 2P 28 - where 29 - 30 - E = the number of edges 31 - N = the number of nodes 32 - P = the number of connected components (exit nodes). 33 - 34 - Enabling this plugin reports the complexity to stderr during the 35 - build. It mainly serves as a simple example of how to create a 36 - gcc plugin for the kernel. 37 - 38 22 config GCC_PLUGIN_SANCOV 39 23 bool 40 24 # Plugin can be removed once the kernel only supports GCC 6+
-69
scripts/gcc-plugins/cyc_complexity_plugin.c
··· 1 - /* 2 - * Copyright 2011-2016 by Emese Revfy <re.emese@gmail.com> 3 - * Licensed under the GPL v2, or (at your option) v3 4 - * 5 - * Homepage: 6 - * https://github.com/ephox-gcc-plugins/cyclomatic_complexity 7 - * 8 - * https://en.wikipedia.org/wiki/Cyclomatic_complexity 9 - * The complexity M is then defined as: 10 - * M = E - N + 2P 11 - * where 12 - * 13 - * E = the number of edges of the graph 14 - * N = the number of nodes of the graph 15 - * P = the number of connected components (exit nodes). 16 - * 17 - * Usage (4.5 - 5): 18 - * $ make clean; make run 19 - */ 20 - 21 - #include "gcc-common.h" 22 - 23 - __visible int plugin_is_GPL_compatible; 24 - 25 - static struct plugin_info cyc_complexity_plugin_info = { 26 - .version = "20160225", 27 - .help = "Cyclomatic Complexity\n", 28 - }; 29 - 30 - static unsigned int cyc_complexity_execute(void) 31 - { 32 - int complexity; 33 - expanded_location xloc; 34 - 35 - /* M = E - N + 2P */ 36 - complexity = n_edges_for_fn(cfun) - n_basic_blocks_for_fn(cfun) + 2; 37 - 38 - xloc = expand_location(DECL_SOURCE_LOCATION(current_function_decl)); 39 - fprintf(stderr, "Cyclomatic Complexity %d %s:%s\n", complexity, 40 - xloc.file, DECL_NAME_POINTER(current_function_decl)); 41 - 42 - return 0; 43 - } 44 - 45 - #define PASS_NAME cyc_complexity 46 - 47 - #define NO_GATE 48 - #define TODO_FLAGS_FINISH TODO_dump_func 49 - 50 - #include "gcc-generate-gimple-pass.h" 51 - 52 - __visible int plugin_init(struct plugin_name_args *plugin_info, struct plugin_gcc_version *version) 53 - { 54 - const char * const plugin_name = plugin_info->base_name; 55 - 56 - PASS_INFO(cyc_complexity, "ssa", 1, PASS_POS_INSERT_AFTER); 57 - 58 - if (!plugin_default_version_check(version, &gcc_version)) { 59 - error(G_("incompatible gcc/plugin versions")); 60 - return 1; 61 - } 62 - 63 - register_callback(plugin_name, PLUGIN_INFO, NULL, 64 - &cyc_complexity_plugin_info); 65 - register_callback(plugin_name, PLUGIN_PASS_MANAGER_SETUP, NULL, 66 - &cyc_complexity_pass_info); 67 - 68 - return 0; 69 - }