From patchwork Thu Apr 7 21:16:23 2016 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Emese Revfy X-Patchwork-Id: 8777431 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 DC2E3C0553 for ; Thu, 7 Apr 2016 21:18:59 +0000 (UTC) Received: from mail.kernel.org (localhost [127.0.0.1]) by mail.kernel.org (Postfix) with ESMTP id CAABD2014A for ; Thu, 7 Apr 2016 21:18:58 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by mail.kernel.org (Postfix) with ESMTP id AAE6920142 for ; Thu, 7 Apr 2016 21:18:57 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1757231AbcDGVS4 (ORCPT ); Thu, 7 Apr 2016 17:18:56 -0400 Received: from mail-wm0-f67.google.com ([74.125.82.67]:34774 "EHLO mail-wm0-f67.google.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1756660AbcDGVSz (ORCPT ); Thu, 7 Apr 2016 17:18:55 -0400 Received: by mail-wm0-f67.google.com with SMTP id n3so24519613wmn.1; Thu, 07 Apr 2016 14:18:55 -0700 (PDT) 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-transfer-encoding; bh=nEtVoPLmf6Ma9oyHb3gLzVHZgeOYsYPgmB8wrhMI/2E=; b=SwqAvVxgdtvUEnsrXrURozw9a+QRfFxyR4WrwjwQuHoj3hhlU1TraXL/BcaqfQxRum qhxIn9rCrsVVHKzJ4xrCWgVgXGsECVehzopyY2jQ2fFmTF4ClH90IlaebDNP6A9rMELg Qoc6e4hDPkgKGj0Wu0kCRB1/08ZpmkDDMo/d1idk08Mi9OUmzq/sS/EjdROE16lpmeiz 3qU1TrIgkDzC3Rk1i0BMkvekcDMjnRJkihlpvpTWMMzJdpgtavNjYXsn9VPOiA+/aIAh xnUz+bk9B+zb8laz7nFFqXD4mUlGNAveZaT5UAtHW98q2JqAigpfQJBp+ehV53H8CK41 pRSA== 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-transfer-encoding; bh=nEtVoPLmf6Ma9oyHb3gLzVHZgeOYsYPgmB8wrhMI/2E=; b=M6F/jlUxddpvjIH876RhJgCg8Ptmfz7WPMvU1FQRuJGp0fygw/1RwGyDPe5VJF4q1i 9iJ6oNnxgmbGegz8YkWVoedg6xGQAy85uA1bobOTA4hfVpYZuqr+hQbVnq8oGcjilu2S SOjPbn5RRXt9edatULv2+T6zNK3PExmYPgn8aleJhfbea5GHlqVmF29/fyS3oRZkrbsx sva1rRU/F9S3UFyL7A9ho+8Xw662pAQDwiE4aj4TYTy0a2LyNlBtIZU5eSgrWThYD4wE ROp5FM0IC7ONkL9DuwKvTjlG+VzF+QpfH107qtBBWe8zJuj3ciq5NLH5GUOS332djsvi AwjQ== X-Gm-Message-State: AD7BkJLLcFz+KWC/wbLpjnewtcJ9iLXRLErCesUyQCYZGA1H6MfTWT2dkesr30aVvkDlMw== X-Received: by 10.194.115.8 with SMTP id jk8mr5751856wjb.142.1460063934288; Thu, 07 Apr 2016 14:18:54 -0700 (PDT) Received: from localhost (beleg.madhouse-project.org. [128.199.36.147]) by smtp.gmail.com with ESMTPSA id k139sm3563864wmg.24.2016.04.07.14.18.52 (version=TLSv1/SSLv3 cipher=OTHER); Thu, 07 Apr 2016 14:18:53 -0700 (PDT) Date: Thu, 7 Apr 2016 23:16:23 +0200 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, fengguang.wu@intel.com, dvyukov@google.com, linux-kernel@vger.kernel.org, david.brown@linaro.org, yamada.masahiro@socionext.com Subject: [PATCH v6 4/6] Add Cyclomatic complexity GCC plugin Message-Id: <20160407231623.2158cac63a2ac2d7bbe8204f@gmail.com> In-Reply-To: <20160407231023.5f1307ffc79f0cdd880eedb7@gmail.com> References: <20160407231023.5f1307ffc79f0cdd880eedb7@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.8 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). Signed-off-by: Emese Revfy --- arch/Kconfig | 12 +++++ scripts/Makefile.gcc-plugins | 2 + scripts/gcc-plugins/Makefile | 4 ++ scripts/gcc-plugins/cyc_complexity_plugin.c | 73 +++++++++++++++++++++++++++++ 4 files changed, 91 insertions(+) create mode 100644 scripts/gcc-plugins/cyc_complexity_plugin.c diff --git a/arch/Kconfig b/arch/Kconfig index 7c12571..ddf29b4 100644 --- a/arch/Kconfig +++ b/arch/Kconfig @@ -366,6 +366,18 @@ menuconfig GCC_PLUGINS GCC plugins are loadable modules that provide extra features to the compiler. They are useful for runtime instrumentation and static analysis. +config GCC_PLUGIN_CYC_COMPLEXITY + bool "Compute the cyclomatic complexity of a function" + depends on 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). + config HAVE_CC_STACKPROTECTOR bool help diff --git a/scripts/Makefile.gcc-plugins b/scripts/Makefile.gcc-plugins index b981b65..34ad58b 100644 --- a/scripts/Makefile.gcc-plugins +++ b/scripts/Makefile.gcc-plugins @@ -2,6 +2,8 @@ ifdef CONFIG_GCC_PLUGINS __PLUGINCC := $(call cc-ifversion, -ge, 0408, $(HOSTCXX), $(HOSTCC)) PLUGINCC := $(shell $(CONFIG_SHELL) $(srctree)/scripts/gcc-plugin.sh "$(__PLUGINCC)" "$(HOSTCXX)" "$(CC)") + gcc-plugin-$(CONFIG_GCC_PLUGIN_CYC_COMPLEXITY) += cyc_complexity_plugin.so + GCC_PLUGINS_CFLAGS := $(addprefix -fplugin=$(objtree)/scripts/gcc-plugins/, $(gcc-plugin-y)) ifeq ($(PLUGINCC),) diff --git a/scripts/gcc-plugins/Makefile b/scripts/gcc-plugins/Makefile index b2d64af..31c72bf 100644 --- a/scripts/gcc-plugins/Makefile +++ b/scripts/gcc-plugins/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/scripts/gcc-plugins/cyc_complexity_plugin.c b/scripts/gcc-plugins/cyc_complexity_plugin.c new file mode 100644 index 0000000..34df974 --- /dev/null +++ b/scripts/gcc-plugins/cyc_complexity_plugin.c @@ -0,0 +1,73 @@ +/* + * 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 = "20160225", + .help = "Cyclomatic Complexity\n", +}; + +static unsigned int cyc_complexity_execute(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; +} + +#define PASS_NAME cyc_complexity + +#define NO_GATE +#define TODO_FLAGS_FINISH TODO_dump_func + +#include "gcc-generate-gimple-pass.h" + +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; +}