From patchwork Thu Feb 11 22:41:35 2016 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Emese Revfy X-Patchwork-Id: 8285421 Return-Path: X-Original-To: patchwork-linux-kbuild@patchwork.kernel.org Delivered-To: patchwork-parsemail@patchwork2.web.kernel.org Received: from mail.kernel.org (mail.kernel.org [198.145.29.136]) by patchwork2.web.kernel.org (Postfix) with ESMTP id 0F992BEEE5 for ; Thu, 11 Feb 2016 22:43:24 +0000 (UTC) Received: from mail.kernel.org (localhost [127.0.0.1]) by mail.kernel.org (Postfix) with ESMTP id EE15220398 for ; Thu, 11 Feb 2016 22:43:22 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by mail.kernel.org (Postfix) with ESMTP id DC21A20364 for ; Thu, 11 Feb 2016 22:43:21 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1750817AbcBKWnV (ORCPT ); Thu, 11 Feb 2016 17:43:21 -0500 Received: from mail-wm0-f66.google.com ([74.125.82.66]:34706 "EHLO mail-wm0-f66.google.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1750800AbcBKWnU (ORCPT ); Thu, 11 Feb 2016 17:43:20 -0500 Received: by mail-wm0-f66.google.com with SMTP id p63so13151190wmp.1 for ; Thu, 11 Feb 2016 14:43:20 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20120113; h=date:from:to:cc:subject:message-id:in-reply-to:references :mime-version:content-type:content-transfer-encoding; bh=T544+2KWXSf12Wq7xtRNp7VslGLS3DIuTWoo+ZAKkek=; b=NldxvZVepfUa2TTep8winBdCdKwTGmJMjLSxAae8h4fMta7IvehXxAVHd0Jh1HXXNd ONS+dFx4if9xAJA57Wq2FVVa7rssaJHyrn9ekrGPFE9JuD7hsWfTk+VJ3rQd1TCEImOW EDl11t1F2o6xWErUQHKLufdC+MISScc1ubYDdiGkQ7Ch9TW9jL6F73KrimqpWMa5UDrD l6ElbSmJJgF6ipcdRRzMTkHRU72X7dEzh6mxYmgwTkVROaMJi5YjaPwH8wi4EXlEXWwx KSjaP+l2xw5C1A49RK/KMBHtRpohJqmleAlPOaGhLO980XvYrSU2YbqSGrKsNbzp5HuY e2cA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20130820; h=x-gm-message-state:date:from:to:cc:subject:message-id:in-reply-to :references:mime-version:content-type:content-transfer-encoding; bh=T544+2KWXSf12Wq7xtRNp7VslGLS3DIuTWoo+ZAKkek=; b=Lw9nX1JDbMMJh++xN5xyziOduFoGoIrsWSD+G2uZfE9xvlh4QjeOWZGtfiAUl6+pT5 lE+CUPEkK0W6IMenzfbAGjcFdYu2VCbHLGR8PtAtzMiU11L9J++fOxoGxqx6XDXa2g2E hfhdSzmB2hZzALP/095LGSme3pCOXdtrtYZ4yo72pKcVZtqpcx/7TMWXEQBpYZnomgJR fAVfC/VNpmKHjAzdOd1lz3AJNYPaTne4138FZY3OZXV6RuDO/s/OEUhYKfroRxfZmiN9 wufB2Z+bxCG9Gdz3T4L7pfnXWI7SzlzcpUWNCIWdCcFUhHByz/XVxGeVHPXh+sBEN1sU cL8A== X-Gm-Message-State: AG10YOQCiNjCHxVLmn3UqhGE9etWU6nT1kp96EvxA+6yHxZljqyw5t5laoPxfUR9Xg5uFA== X-Received: by 10.28.9.71 with SMTP id 68mr902884wmj.33.1455230599641; Thu, 11 Feb 2016 14:43:19 -0800 (PST) Received: from localhost (beleg.madhouse-project.org. [128.199.36.147]) by smtp.gmail.com with ESMTPSA id u4sm9486404wjz.4.2016.02.11.14.43.18 (version=TLSv1/SSLv3 cipher=OTHER); Thu, 11 Feb 2016 14:43:18 -0800 (PST) Date: Thu, 11 Feb 2016 23:41:35 +0100 From: Emese Revfy To: linux-kbuild@vger.kernel.org Cc: pageexec@freemail.hu, spender@grsecurity.net, kernel-hardening@lists.openwall.com, mmarek@suse.com, keescook@chromium.org, linux@rasmusvillemoes.dk Subject: [PATCH v2 2/3] Add Cyclomatic complexity GCC plugin Message-Id: <20160211234135.4478fabfc780825379936963@gmail.com> In-Reply-To: <20160211233646.97c2af3675dc5b0f525f0489@gmail.com> References: <20160211233646.97c2af3675dc5b0f525f0489@gmail.com> X-Mailer: Sylpheed 3.4.3 (GTK+ 2.24.29; x86_64-pc-linux-gnu) Mime-Version: 1.0 Sender: linux-kbuild-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-kbuild@vger.kernel.org X-Spam-Status: No, score=-7.0 required=5.0 tests=BAYES_00, DKIM_ADSP_CUSTOM_MED, DKIM_SIGNED, FREEMAIL_FROM, RCVD_IN_DNSWL_HI, RP_MATCHES_RCVD, T_DKIM_INVALID, UNPARSEABLE_RELAY autolearn=ham version=3.3.1 X-Spam-Checker-Version: SpamAssassin 3.3.1 (2010-03-16) on mail.kernel.org X-Virus-Scanned: ClamAV using ClamSMTP Add a very simple plugin to demonstrate the GCC plugin infrastructure. This GCC plugin computes the cyclomatic complexity of each function. The complexity M of a function's control flow graph is defined as: M = E - N + 2P where E = the number of edges N = the number of nodes P = the number of connected components (exit nodes). --- arch/Kconfig | 12 ++++ scripts/Makefile.gcc-plugins | 6 +- tools/gcc/Makefile | 4 ++ tools/gcc/cyc_complexity_plugin.c | 120 ++++++++++++++++++++++++++++++++++++++ 4 files changed, 141 insertions(+), 1 deletion(-) create mode 100644 tools/gcc/cyc_complexity_plugin.c diff --git a/arch/Kconfig b/arch/Kconfig index a95e5b1..a558ecb 100644 --- a/arch/Kconfig +++ b/arch/Kconfig @@ -365,6 +365,18 @@ config HAVE_GCC_PLUGINS An arch should select this symbol if it supports building with gcc plugins. +config GCC_PLUGIN_CYC_COMPLEXITY + bool "Compute the cyclomatic complexity of a function" + depends on HAVE_GCC_PLUGINS + help + The complexity M of a function's control flow graph is defined as: + M = E - N + 2P + where + + E = the number of edges + N = the number of nodes + P = the number of connected components (exit nodes). + endmenu # "GCC plugins" config HAVE_CC_STACKPROTECTOR diff --git a/scripts/Makefile.gcc-plugins b/scripts/Makefile.gcc-plugins index a60a88e..c49abcd 100644 --- a/scripts/Makefile.gcc-plugins +++ b/scripts/Makefile.gcc-plugins @@ -4,7 +4,11 @@ else PLUGINCC := $(shell $(CONFIG_SHELL) $(srctree)/scripts/gcc-plugin.sh "$(HOSTCC)" "$(HOSTCXX)" "$(CC)") endif ifneq ($(PLUGINCC),) -export PLUGINCC GCC_PLUGINS_CFLAGS GCC_PLUGINS_AFLAGS +ifdef CONFIG_GCC_PLUGIN_CYC_COMPLEXITY +GCC_PLUGIN_CYC_COMPLEXITY_CFLAGS := -fplugin=$(objtree)/tools/gcc/cyc_complexity_plugin.so +endif +GCC_PLUGINS_CFLAGS := $(GCC_PLUGIN_CYC_COMPLEXITY_CFLAGS) +export PLUGINCC GCC_PLUGINS_CFLAGS GCC_PLUGINS_AFLAGS GCC_PLUGIN_CYC_COMPLEXITY ifeq ($(KBUILD_EXTMOD),) gcc-plugins: $(Q)$(MAKE) $(build)=tools/gcc diff --git a/tools/gcc/Makefile b/tools/gcc/Makefile index b2d64af..31c72bf 100644 --- a/tools/gcc/Makefile +++ b/tools/gcc/Makefile @@ -12,4 +12,8 @@ endif export GCCPLUGINS_DIR HOSTLIBS +$(HOSTLIBS)-$(CONFIG_GCC_PLUGIN_CYC_COMPLEXITY) := cyc_complexity_plugin.so + always := $($(HOSTLIBS)-y) + +cyc_complexity_plugin-objs := cyc_complexity_plugin.o diff --git a/tools/gcc/cyc_complexity_plugin.c b/tools/gcc/cyc_complexity_plugin.c new file mode 100644 index 0000000..c6f0d58 --- /dev/null +++ b/tools/gcc/cyc_complexity_plugin.c @@ -0,0 +1,120 @@ +/* + * Copyright 2011-2016 by Emese Revfy + * Licensed under the GPL v2, or (at your option) v3 + * + * Homepage: + * https://github.com/ephox-gcc-plugins/cyclomatic_complexity + * + * http://en.wikipedia.org/wiki/Cyclomatic_complexity + * The complexity M is then defined as: + * M = E - N + 2P + * where + * + * E = the number of edges of the graph + * N = the number of nodes of the graph + * P = the number of connected components (exit nodes). + * + * Usage (4.5 - 5): + * $ make clean; make run + */ + +#include "gcc-common.h" + +int plugin_is_GPL_compatible; + +static struct plugin_info cyc_complexity_plugin_info = { + .version = "20150523", + .help = "Cyclomatic Complexity\n", +}; + +static unsigned int handle_function(void) +{ + int complexity; + expanded_location xloc; + + // M = E - N + 2P + complexity = n_edges_for_fn(cfun) - n_basic_blocks_for_fn(cfun) + 2; + + xloc = expand_location(DECL_SOURCE_LOCATION(current_function_decl)); + fprintf(stderr, "Cyclomatic Complexity %d %s:%s\n", complexity, xloc.file, DECL_NAME_POINTER(current_function_decl)); + + return 0; +} + +#if BUILDING_GCC_VERSION >= 4009 +namespace { +static const struct pass_data cyc_complexity_pass_data = { +#else +static struct gimple_opt_pass cyc_complexity_pass = { + .pass = { +#endif + .type = GIMPLE_PASS, + .name = "cyc_complexity", +#if BUILDING_GCC_VERSION >= 4008 + .optinfo_flags = OPTGROUP_NONE, +#endif +#if BUILDING_GCC_VERSION >= 5000 +#elif BUILDING_GCC_VERSION >= 4009 + .has_gate = false, + .has_execute = true, +#else + .gate = NULL, + .execute = handle_function, + .sub = NULL, + .next = NULL, + .static_pass_number = 0, +#endif + .tv_id = TV_NONE, + .properties_required = 0, + .properties_provided = 0, + .properties_destroyed = 0, + .todo_flags_start = 0, + .todo_flags_finish = TODO_dump_func +#if BUILDING_GCC_VERSION < 4009 + } +#endif +}; + +#if BUILDING_GCC_VERSION >= 4009 +class cyc_complexity_pass : public gimple_opt_pass { +public: + cyc_complexity_pass() : gimple_opt_pass(cyc_complexity_pass_data, g) {} +#if BUILDING_GCC_VERSION >= 5000 + virtual unsigned int execute(function *) { return handle_function(); } +#else + unsigned int execute() { return handle_function(); } +#endif +}; +} + +static struct opt_pass *make_cyc_complexity_pass(void) +{ + return new cyc_complexity_pass(); +} +#else +static struct opt_pass *make_cyc_complexity_pass(void) +{ + return &cyc_complexity_pass.pass; +} +#endif + +int plugin_init(struct plugin_name_args *plugin_info, struct plugin_gcc_version *version) +{ + const char * const plugin_name = plugin_info->base_name; + struct register_pass_info cyc_complexity_pass_info; + + cyc_complexity_pass_info.pass = make_cyc_complexity_pass(); + cyc_complexity_pass_info.reference_pass_name = "ssa"; + cyc_complexity_pass_info.ref_pass_instance_number = 1; + cyc_complexity_pass_info.pos_op = PASS_POS_INSERT_AFTER; + + if (!plugin_default_version_check(version, &gcc_version)) { + error(G_("incompatible gcc/plugin versions")); + return 1; + } + + register_callback(plugin_name, PLUGIN_INFO, NULL, &cyc_complexity_plugin_info); + register_callback(plugin_name, PLUGIN_PASS_MANAGER_SETUP, NULL, &cyc_complexity_pass_info); + + return 0; +}