From patchwork Sun Mar 6 23:05:31 2016 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Emese Revfy X-Patchwork-Id: 8514211 Return-Path: X-Original-To: patchwork-linux-kbuild@patchwork.kernel.org Delivered-To: patchwork-parsemail@patchwork1.web.kernel.org Received: from mail.kernel.org (mail.kernel.org [198.145.29.136]) by patchwork1.web.kernel.org (Postfix) with ESMTP id 2F5799F7CA for ; Sun, 6 Mar 2016 23:07:34 +0000 (UTC) Received: from mail.kernel.org (localhost [127.0.0.1]) by mail.kernel.org (Postfix) with ESMTP id 13D42201C0 for ; Sun, 6 Mar 2016 23:07:33 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by mail.kernel.org (Postfix) with ESMTP id BA775200DC for ; Sun, 6 Mar 2016 23:07:31 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1751634AbcCFXHb (ORCPT ); Sun, 6 Mar 2016 18:07:31 -0500 Received: from mail-wm0-f68.google.com ([74.125.82.68]:35927 "EHLO mail-wm0-f68.google.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1751510AbcCFXHa (ORCPT ); Sun, 6 Mar 2016 18:07:30 -0500 Received: by mail-wm0-f68.google.com with SMTP id l68so7925624wml.3; Sun, 06 Mar 2016 15:07:29 -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-transfer-encoding; bh=JZwP+52vtxJVRz0pvQR0p5h0CknFYFipnQH7TomyNF8=; b=LxqoxKcouGI7p33tu8Rjn7jpvLLniJIcc6kj7gMtQ+YNIKiD36V63sUFyAvocGsA8e 1NO7Gy2oBF+SYz0CXf6Y67+pKTycK1CFcxSUjiQeZUm8yivVZKd5cFC+An7BjPNlniAZ Wn3b6An8XxcpN4HDgm0CFLDE/PvQdMoklNx/RD6uDK8K9TpSL2jUA/ACYZvuRvOkzoRM eYqD1VPbnvREzMYUlFBwIT9UyS5a+Px3OqZ5xgpp5E3L6PiYU6tqW8aT2x2o/33d0h8x +aSZ4QszTMpMarkrrmHnhh3n1CL919bXVAVvhnn9/J4idY+Dw5RCkcL1FRJMPFvDInGL Fozw== 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=JZwP+52vtxJVRz0pvQR0p5h0CknFYFipnQH7TomyNF8=; b=HOiSX2eQvgSGWLeNAOmsr3xdExPUJojbXa9s/cQyMIr4lfVO3c3KeVKvFDNwQPjgVQ H44sEfb9jsT9ENwIfTIbnllhevN9ufL3PPGcFC4UuoTbznP7pxHRF+Kq//DpLEZF32Dt 4gUKv+H9fkXx7xBFW30MWdwI0qoeeyK3gSk18+3A9bcV5JRHEAUpTDQY3XDHfPAxbJCA xHCiG6E1wojLD+i8loOdp4WxBXcaLfsV7n4qa+zH2C2Ngf4XL4V7QBUnywp0olFNoNiH n3E9V4ps1dy7gg8VVH4pjaUS/dImsLUBXTA7OW0zPm6HpnMejouZbpqSxkvss0Ob+uoD w9fw== X-Gm-Message-State: AD7BkJJkjRgXA9TEzJ4DNvRBZGgCwVtlR7t//iJlAVBi4VoY654RVDsj/98yvfXcSeAxfg== X-Received: by 10.28.132.212 with SMTP id g203mr9779384wmd.30.1457305648630; Sun, 06 Mar 2016 15:07:28 -0800 (PST) Received: from localhost (beleg.madhouse-project.org. [128.199.36.147]) by smtp.gmail.com with ESMTPSA id e25sm2745408wmi.21.2016.03.06.15.07.26 (version=TLSv1/SSLv3 cipher=OTHER); Sun, 06 Mar 2016 15:07:27 -0800 (PST) Date: Mon, 7 Mar 2016 00:05:31 +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, fengguang.wu@intel.com, dvyukov@google.com, linux-kernel@vger.kernel.org Subject: [PATCH v5 3/5] Add Cyclomatic complexity GCC plugin Message-Id: <20160307000531.d43ae7df74bfa5e9e9e29087@gmail.com> In-Reply-To: <20160307000208.1bec3e7dc874489d1b4fcbb4@gmail.com> References: <20160307000208.1bec3e7dc874489d1b4fcbb4@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=-6.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 | 6 +++- tools/gcc/Makefile | 4 +++ tools/gcc/cyc_complexity_plugin.c | 73 +++++++++++++++++++++++++++++++++++++++ 4 files changed, 94 insertions(+), 1 deletion(-) create mode 100644 tools/gcc/cyc_complexity_plugin.c diff --git a/arch/Kconfig b/arch/Kconfig index e090642..59bde9b 100644 --- a/arch/Kconfig +++ b/arch/Kconfig @@ -370,6 +370,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 7c85bf2..dd7b56d 100644 --- a/scripts/Makefile.gcc-plugins +++ b/scripts/Makefile.gcc-plugins @@ -5,7 +5,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..34df974 --- /dev/null +++ b/tools/gcc/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; +}