Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.18 as permitted sender) client-ip=23.128.96.18;
Message-ID: <09bacd3b3da948df632a0ffb4d7ca90603a45d06.camel@perches.com>
Subject: Re: [PATCH V2] sysfs: Add sysfs_emit and sysfs_emit_at to format
 sysfs output
From:   Joe Perches <joe@perches.com>
To:     Denis Efremov <efremov@linux.com>,
        Greg Kroah-Hartman <gregkh@linuxfoundation.org>,
        "Rafael J. Wysocki" <rafael@kernel.org>
Cc:     Kees Cook <keescook@chromium.org>,
        "Gustavo A . R . Silva" <gustavoars@kernel.org>,
        Julia Lawall <julia.lawall@inria.fr>,
        Alex Dewar <alex.dewar90@gmail.com>,
        Jonathan Corbet <corbet@lwn.net>, linux-doc@vger.kernel.org,
        linux-kernel@vger.kernel.org
Date:   Sun, 30 Aug 2020 09:05:13 -0700
In-Reply-To: <8b01dc3a-3642-bc12-ae4d-42b90ec208f1@linux.com>
References: <a9054fb521e65f2809671fa9c18e2453061e9d91.1598744610.git.joe@perches.com>
         <c22b7006813b1776467a72e716a5970e9277b4b7.camel@perches.com>
         <8b01dc3a-3642-bc12-ae4d-42b90ec208f1@linux.com>
Content-Type: text/plain; charset="ISO-8859-1"
User-Agent: Evolution 3.36.4-0ubuntu1 
MIME-Version: 1.0
Content-Transfer-Encoding: 7bit
Sender: linux-kernel-owner@vger.kernel.org
Precedence: bulk

On Sun, 2020-08-30 at 18:25 +0300, Denis Efremov wrote:
> 
> On 8/30/20 3:43 AM, Joe Perches wrote:
> > $ cat sysfs_emit.cocci
> > @@
> > identifier d_show =~ "^.*show.*$";
> 
> I think this additional pattern will allow to take more functions into the scope. 
> 
> @da@
> identifier show, store;
> expression name, mode;
> @@
> 
> (
>   DEVICE_ATTR(name, mode, show, store)
>   DEVICE_ATTR_PREALLOC(name, mode, show, store)
>   DEVICE_ATTR_IGNORE_LOCKDEP(name, mode, show, store)
> )

Thanks Denis.

I'll try that out too.

A trivial grep shows there are at least 130+
DEVICE_ATTR functions that have a show function
that doesn't include "show" in the function name.

$ grep-2.5.4 -rP --include=*.[ch] '\bDEVICE_ATTR\s*\(\s*\w+\s*,\s*[^,]+,\s*[^,]*,[^;]+;' * | \
  perl -p -e 's/[[:space:]]*//g; s/;/;\n/g' | \
  cut -f3 -d, | \
  grep -v show | \
  sort | uniq | wc -l
139

> @@
> // I think device_show_ulong, device_show_int, device_show_bool
> // functions deserve explicit handling because they are somewhat
> // reference implementations.

Those reference implementations could be send as
a separate patch but this preliminary script does
already handle them.

I do like the idea below of renaming the show
functions without _show in the name adding _show.

> identifier d_show = { da.show, device_show_ulong, device_show_int, device_show_bool };
> identifier dev, attr, buf;
> @@
> 
> * ssize_t d_show(struct device *dev, struct device_attribute *attr, char *buf)
>   {
>      ...
>   }
> 
> 
> I tried also to handle DEVICE_ATTR_RW, but I failed to use fresh identifier.
> This doesn't work:
> 
> @darw@
> identifier name;
> @@
> 
> (
>   DEVICE_ATTR_RW(name)
>   DEVICE_ATTR_RO(name)
>   DEVICE_ATTR_WO(name)
> )
> 
> @@
> identifier darw.name;
> fresh identifier d_show = name ## "_show"; // <== parse error
> identifier dev, attr, buf;
> @@
> 
> * ssize_t d_show(struct device *dev, struct device_attribute *attr, char *buf)
>   {
>      ...
>   }
> 
> 
> Regards,
> Denis