From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1751994AbdFKOhD (ORCPT ); Sun, 11 Jun 2017 10:37:03 -0400 Received: from mail2-relais-roc.national.inria.fr ([192.134.164.83]:57087 "EHLO mail2-relais-roc.national.inria.fr" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1751651AbdFKOhC (ORCPT ); Sun, 11 Jun 2017 10:37:02 -0400 X-IronPort-AV: E=Sophos;i="5.39,329,1493676000"; d="scan'208";a="278239477" Date: Sun, 11 Jun 2017 16:36:55 +0200 (CEST) From: Julia Lawall X-X-Sender: jll@hadrien To: Andy Shevchenko cc: kernel-janitors@vger.kernel.org, Gilles Muller , Nicolas Palix , Michal Marek , cocci@systeme.lip6.fr, linux-kernel@vger.kernel.org, Jonathan Cameron , linux-iio@vger.kernel.org, Hartmut Knaack , Lars-Peter Clausen , Peter Meerwald-Stadler Subject: Re: [PATCH] scripts/coccinelle/api/gpiod_get_index.cocci: use gpiod_get variant when possible In-Reply-To: <1497191312.22624.110.camel@linux.intel.com> Message-ID: References: <1497189236-4666-1-git-send-email-Julia.Lawall@lip6.fr> <1497191312.22624.110.camel@linux.intel.com> User-Agent: Alpine 2.20 (DEB 67 2015-01-07) MIME-Version: 1.0 Content-Type: multipart/mixed; BOUNDARY="8323329-541630860-1497191815=:3008" Sender: linux-kernel-owner@vger.kernel.org List-ID: X-Mailing-List: linux-kernel@vger.kernel.org --8323329-541630860-1497191815=:3008 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8BIT On Sun, 11 Jun 2017, Andy Shevchenko wrote: > On Sun, 2017-06-11 at 15:53 +0200, Julia Lawall wrote: > > Coccinelle script to use the shorter gpiod_get function when the third > > argument to a gpiod_get_index function is 0. > > > > This rule avoids modifying wrapper functions and cases where there is > > a > > series of gpiod_get_index calls. > > Thanks for the script. > > One caution nevertheless (I'm not an expert in coccinelle below, so, > can't tell if it's already there): > > If there are two calls to gpio_get_index() with different indices, we > are not going to replace the one which uses 0. It's halfway there. I assume that the second call would come afterwards, ie one would naturally put 0 first. Checking before too could make the script a bit expensive. A warning message is emitted about the issue. julia > > > > > Signed-off-by: Julia Lawall > > > > --- > >  scripts/coccinelle/api/gpiod_get_index.cocci |   92 > > +++++++++++++++++++++++++++ > >  1 file changed, 92 insertions(+) > > > > diff --git a/scripts/coccinelle/api/gpiod_get_index.cocci > > b/scripts/coccinelle/api/gpiod_get_index.cocci > > new file mode 100644 > > index 0000000..a670a29 > > --- /dev/null > > +++ b/scripts/coccinelle/api/gpiod_get_index.cocci > > @@ -0,0 +1,92 @@ > > +/// Use the shorter gpiod_get function when the third argument to a > > +/// gpiod_get_index function is 0. > > +//# The change might not be desired when there is a series of calls, > > for 0, 1, > > +//# 2, etc.  This rule checks for another such call subsequently > > only. > > +/// > > +// Confidence: Moderate > > +// Copyright: (C) 2017 Julia Lawall, Inria. GPLv2. > > +// URL: http://coccinelle.lip6.fr/ > > +// Options: --no-includes --include-headers > > +// Keywords: gpiod_get_index > > + > > +virtual patch > > +virtual context > > +virtual org > > +virtual report > > + > > +@initialize:python@ > > +@@ > > + > > +def not_wrapper(p): > > +  return (p[0].current_element != "devm_gpiod_get_optional" and > > +          p[0].current_element != "devm_gpiod_get" and > > +          p[0].current_element != "gpiod_get_optional" and > > +          p[0].current_element != "gpiod_get"); > > + > > +@r depends on patch && !context && !org && !report@ > > +expression e1,e2,e3,e4,e5,e6,n != 0; > > +position p : script:python() { not_wrapper(p) }; > > +@@ > > + > > +( > > +- devm_gpiod_get_index_optional@p > > ++ devm_gpiod_get_optional > > +| > > +- devm_gpiod_get_index@p > > ++ devm_gpiod_get > > +| > > +- gpiod_get_index_optional@p > > ++ gpiod_get_optional > > +| > > +- gpiod_get_index@p > > ++ gpiod_get > > +) > > +   (e1,e2, > > +-   0, > > +    e3) > > + ... when != devm_gpiod_get_index_optional(e4,e5,n,e6) > > +     when != devm_gpiod_get_index(e4,e5,n,e6) > > +     when != gpiod_get_index_optional(e4,e5,n,e6) > > +     when != gpiod_get_index(e4,e5,n,e6) > > + > > +// ------------------------------------------------------------------ > > ---------- > > + > > +@r_context depends on !patch && (context || org || report) forall@ > > +expression e1, e2, e3, e4, e5, e6, n != 0; > > +position p: script:python () { not_wrapper(p) }; > > +@@ > > + > > +( > > +*  devm_gpiod_get_index_optional@p > > +| > > +*  devm_gpiod_get_index@p > > +| > > +*  gpiod_get_index_optional@p > > +| > > +*  gpiod_get_index@p > > +) > > +   (e1,e2, > > +*    0, > > +    e3) > > + ... when != devm_gpiod_get_index_optional(e4,e5,n,e6) > > +     when != devm_gpiod_get_index(e4,e5,n,e6) > > +     when != gpiod_get_index_optional(e4,e5,n,e6) > > +     when != gpiod_get_index(e4,e5,n,e6) > > + > > +// ------------------------------------------------------------------ > > ---------- > > + > > +@script:python r_org depends on org@ > > +p << r_context.p; > > +@@ > > + > > +msg = "Use non _index variant in 0 case." > > +coccilib.org.print_todo(p[0], msg) > > + > > +// ------------------------------------------------------------------ > > ---------- > > + > > +@script:python r_report depends on report@ > > +p << r_context.p; > > +@@ > > + > > +msg = "Use non _index variant in 0 case around line %s." % > > (p[0].line) > > +coccilib.report.print_report(p[0], msg) > > > > -- > Andy Shevchenko > Intel Finland Oy > -- > To unsubscribe from this list: send the line "unsubscribe kernel-janitors" in > the body of a message to majordomo@vger.kernel.org > More majordomo info at http://vger.kernel.org/majordomo-info.html > --8323329-541630860-1497191815=:3008--