LinuxLists.cc - [PATCH 0/5] iio: use permission specific variants of DEVICE

2018-01-04 14:36:26

Subject: [PATCH 0/5] iio: use permission specific variants of DEVICE_ATTR

Series of clean-up patches which replace all DEVICE_ATTR macros with the
permission specific variants DEVICE_ATTR_{RO/WO/RW}.

Patches were created using coccinelle. The following script is for conversion to
the DEVICE_ATTR_RO macro and the other conversions are similar. The script may
require some manual intervention when multiple attributes share the show or
store function.

@r@
identifier attr, show_fn;
declarer name DEVICE_ATTR;
@@

DEVICE_ATTR(attr, \(S_IRUGO\|0444\), show_fn, NULL);

@script: python p@
attr_show;
attr << r.attr;
@@

// standardise the show fn name to {attr}_show
coccinelle.attr_show = attr + "_show"

@@
identifier r.attr, r.show_fn;
declarer name DEVICE_ATTR_RO;
@@

// change the attr declaration
- DEVICE_ATTR(attr, \(S_IRUGO\|0444\), show_fn, NULL);
+ DEVICE_ATTR_RO(attr);

@rr@
identifier r.show_fn, p.attr_show;
@@

// rename the show function
- show_fn
+ attr_show
(...) {
...
}

@depends on rr@
identifier r.show_fn, p.attr_show;
@@

// rename fn usages
- show_fun
+ attr_show

Aishwarya Pant (5):
iio: buffer: use permission specific variants of DEVICE_ATTR
iio: core: use permission specific variants of DEVICE_ATTR
iio: trigger: use permission specific variants of DEVICE_ATTR
iio: hrtimer: use permission specific variants of DEVICE_ATTR
iio: trigger: sysfs: use permisssion specific variants of DEVICE_ATTR

drivers/iio/industrialio-buffer.c | 25 +++++++++++--------------
drivers/iio/industrialio-core.c | 11 +++++------
drivers/iio/industrialio-trigger.c | 18 ++++++++----------
drivers/iio/trigger/iio-trig-hrtimer.c | 8 +++-----
drivers/iio/trigger/iio-trig-sysfs.c | 4 ++--
5 files changed, 29 insertions(+), 37 deletions(-)

--
2.15.1

2018-01-04 14:37:23

by Aishwarya Pant

[permalink] [raw]

Subject: [PATCH 1/5] iio: buffer: use permission specific variants of DEVICE_ATTR

This is a clean-up patch which replaces DEVICE_ATTR macro with the file
permission specific DEVICE_ATTR_{RO/WO/RW} macros for compaction and
readability. Done using coccinelle.

Signed-off-by: Aishwarya Pant <[email protected]>
---
drivers/iio/industrialio-buffer.c | 25 +++++++++++--------------
1 file changed, 11 insertions(+), 14 deletions(-)

diff --git a/drivers/iio/industrialio-buffer.c b/drivers/iio/industrialio-buffer.c
index d2b465140a6b..ca565fbcff90 100644
--- a/drivers/iio/industrialio-buffer.c
+++ b/drivers/iio/industrialio-buffer.c
@@ -497,7 +497,7 @@ static int iio_buffer_add_channel_sysfs(struct iio_dev *indio_dev,
return ret;
}

-static ssize_t iio_buffer_read_length(struct device *dev,
+static ssize_t length_show(struct device *dev,
struct device_attribute *attr,
char *buf)
{
@@ -507,7 +507,7 @@ static ssize_t iio_buffer_read_length(struct device *dev,
return sprintf(buf, "%d\n", buffer->length);
}

-static ssize_t iio_buffer_write_length(struct device *dev,
+static ssize_t length_store(struct device *dev,
struct device_attribute *attr,
const char *buf, size_t len)
{
@@ -540,7 +540,7 @@ static ssize_t iio_buffer_write_length(struct device *dev,
return ret ? ret : len;
}

-static ssize_t iio_buffer_show_enable(struct device *dev,
+static ssize_t enable_show(struct device *dev,
struct device_attribute *attr,
char *buf)
{
@@ -1117,7 +1117,7 @@ void iio_disable_all_buffers(struct iio_dev *indio_dev)
iio_buffer_deactivate_all(indio_dev);
}

-static ssize_t iio_buffer_store_enable(struct device *dev,
+static ssize_t enable_store(struct device *dev,
struct device_attribute *attr,
const char *buf,
size_t len)
@@ -1153,7 +1153,7 @@ static ssize_t iio_buffer_store_enable(struct device *dev,

static const char * const iio_scan_elements_group_name = "scan_elements";

-static ssize_t iio_buffer_show_watermark(struct device *dev,
+static ssize_t watermark_show(struct device *dev,
struct device_attribute *attr,
char *buf)
{
@@ -1163,7 +1163,7 @@ static ssize_t iio_buffer_show_watermark(struct device *dev,
return sprintf(buf, "%u\n", buffer->watermark);
}

-static ssize_t iio_buffer_store_watermark(struct device *dev,
+static ssize_t watermark_store(struct device *dev,
struct device_attribute *attr,
const char *buf,
size_t len)
@@ -1198,16 +1198,13 @@ static ssize_t iio_buffer_store_watermark(struct device *dev,
return ret ? ret : len;
}

-static DEVICE_ATTR(length, S_IRUGO | S_IWUSR, iio_buffer_read_length,
- iio_buffer_write_length);
+static DEVICE_ATTR_RW(length);
static struct device_attribute dev_attr_length_ro = __ATTR(length,
- S_IRUGO, iio_buffer_read_length, NULL);
-static DEVICE_ATTR(enable, S_IRUGO | S_IWUSR,
- iio_buffer_show_enable, iio_buffer_store_enable);
-static DEVICE_ATTR(watermark, S_IRUGO | S_IWUSR,
- iio_buffer_show_watermark, iio_buffer_store_watermark);
+ S_IRUGO, length_show, NULL);
+static DEVICE_ATTR_RW(enable);
+static DEVICE_ATTR_RW(watermark);
static struct device_attribute dev_attr_watermark_ro = __ATTR(watermark,
- S_IRUGO, iio_buffer_show_watermark, NULL);
+ S_IRUGO, watermark_show, NULL);

static struct attribute *iio_buffer_attrs[] = {
&dev_attr_length.attr,
--
2.15.1

2018-01-04 14:37:45

by Aishwarya Pant

[permalink] [raw]

Subject: [PATCH 2/5] iio: core: use permission specific variants of DEVICE_ATTR

2018-01-04 14:38:34

by Aishwarya Pant

[permalink] [raw]

Subject: [PATCH 4/5] iio: hrtimer: use permission specific variants of DEVICE_ATTR

2018-01-04 14:38:48

by Aishwarya Pant

[permalink] [raw]

Subject: [PATCH 5/5] iio: trigger: sysfs: use permisssion specific variants of DEVICE_ATTR

2018-01-04 14:40:52

by Aishwarya Pant

[permalink] [raw]

Subject: [PATCH 3/5] iio: trigger: use permission specific variants of DEVICE_ATTR

This is a clean-up patch which replaces DEVICE_ATTR macro with the file
permission specific DEVICE_ATTR_{RO/WO/RW} macros for compaction and
readability. Done using coccinelle.

Signed-off-by: Aishwarya Pant <[email protected]>
---
drivers/iio/industrialio-trigger.c | 18 ++++++++----------
1 file changed, 8 insertions(+), 10 deletions(-)

diff --git a/drivers/iio/industrialio-trigger.c b/drivers/iio/industrialio-trigger.c
index ce66699c7fcc..d24e49a4bdcc 100644
--- a/drivers/iio/industrialio-trigger.c
+++ b/drivers/iio/industrialio-trigger.c
@@ -39,7 +39,7 @@ static LIST_HEAD(iio_trigger_list);
static DEFINE_MUTEX(iio_trigger_list_lock);

/**
- * iio_trigger_read_name() - retrieve useful identifying name
+ * name_show() - retrieve useful identifying name
* @dev: device associated with the iio_trigger
* @attr: pointer to the device_attribute structure that is
* being processed
@@ -48,7 +48,7 @@ static DEFINE_MUTEX(iio_trigger_list_lock);
* Return: a negative number on failure or the number of written
* characters on success.
*/
-static ssize_t iio_trigger_read_name(struct device *dev,
+static ssize_t name_show(struct device *dev,
struct device_attribute *attr,
char *buf)
{
@@ -56,7 +56,7 @@ static ssize_t iio_trigger_read_name(struct device *dev,
return sprintf(buf, "%s\n", trig->name);
}

-static DEVICE_ATTR(name, S_IRUGO, iio_trigger_read_name, NULL);
+static DEVICE_ATTR_RO(name);

static struct attribute *iio_trig_dev_attrs[] = {
&dev_attr_name.attr,
@@ -358,7 +358,7 @@ void iio_dealloc_pollfunc(struct iio_poll_func *pf)
EXPORT_SYMBOL_GPL(iio_dealloc_pollfunc);

/**
- * iio_trigger_read_current() - trigger consumer sysfs query current trigger
+ * current_trigger_show() - trigger consumer sysfs query current trigger
* @dev: device associated with an industrial I/O device
* @attr: pointer to the device_attribute structure that
* is being processed
@@ -370,7 +370,7 @@ EXPORT_SYMBOL_GPL(iio_dealloc_pollfunc);
* Return: a negative number on failure, the number of characters written
* on success or 0 if no trigger is available
*/
-static ssize_t iio_trigger_read_current(struct device *dev,
+static ssize_t current_trigger_show(struct device *dev,
struct device_attribute *attr,
char *buf)
{
@@ -382,7 +382,7 @@ static ssize_t iio_trigger_read_current(struct device *dev,
}

/**
- * iio_trigger_write_current() - trigger consumer sysfs set current trigger
+ * current_trigger_store() - trigger consumer sysfs set current trigger
* @dev: device associated with an industrial I/O device
* @attr: device attribute that is being processed
* @buf: string buffer that holds the name of the trigger
@@ -395,7 +395,7 @@ static ssize_t iio_trigger_read_current(struct device *dev,
* Return: negative error code on failure or length of the buffer
* on success
*/
-static ssize_t iio_trigger_write_current(struct device *dev,
+static ssize_t current_trigger_store(struct device *dev,
struct device_attribute *attr,
const char *buf,
size_t len)
@@ -456,9 +456,7 @@ static ssize_t iio_trigger_write_current(struct device *dev,
return ret;
}

-static DEVICE_ATTR(current_trigger, S_IRUGO | S_IWUSR,
- iio_trigger_read_current,
- iio_trigger_write_current);
+static DEVICE_ATTR_RW(current_trigger);

static struct attribute *iio_trigger_consumer_attrs[] = {
&dev_attr_current_trigger.attr,
--
2.15.1

2018-01-04 15:16:23

by Joe Perches

[permalink] [raw]

Subject: Re: [PATCH 0/5] iio: use permission specific variants of DEVICE_ATTR

On Thu, 2018-01-04 at 20:06 +0530, Aishwarya Pant wrote:
> Series of clean-up patches which replace all DEVICE_ATTR macros with the
> permission specific variants DEVICE_ATTR_{RO/WO/RW}.
>
> Patches were created using coccinelle. The following script is for conversion to
> the DEVICE_ATTR_RO macro and the other conversions are similar. The script may
> require some manual intervention when multiple attributes share the show or
> store function.

I do think the perl scripts are a bit better here
as they can verify the show/store functions are
static, used once, the new functions names are
unused and so can be renamed without conflict.

Maybe the python bits can be extended to copy
these perl checks and avoid the possible manual
inspection and verification requirements.

https://lkml.org/lkml/2017/12/22/844

2018-01-06 12:35:28

by Jonathan Cameron

[permalink] [raw]

Subject: Re: [PATCH 1/5] iio: buffer: use permission specific variants of DEVICE_ATTR

On Thu, 4 Jan 2018 20:07:14 +0530
Aishwarya Pant <[email protected]> wrote:

> This is a clean-up patch which replaces DEVICE_ATTR macro with the file
> permission specific DEVICE_ATTR_{RO/WO/RW} macros for compaction and
> readability. Done using coccinelle.

Hmm. I'll be honest, I personally really dislike these macros.
They absolutely don't help with readability because they obscure
the connection between the attributes being created and their callbacks.
Short is not the same as more readable.

Dropping off the prefixes from function names suddenly makes them
appear a lot more generic than they are. The only advantage is is
standardizes their naming slightly - but that could be done whilst
maintaining the more readable version that makes everything obvious.

I'll think on whether the compactness gains are sufficient to justify their
use.

>
> Signed-off-by: Aishwarya Pant <[email protected]>
> ---
> drivers/iio/industrialio-buffer.c | 25 +++++++++++--------------
> 1 file changed, 11 insertions(+), 14 deletions(-)
>
> diff --git a/drivers/iio/industrialio-buffer.c b/drivers/iio/industrialio-buffer.c
> index d2b465140a6b..ca565fbcff90 100644
> --- a/drivers/iio/industrialio-buffer.c
> +++ b/drivers/iio/industrialio-buffer.c
> @@ -497,7 +497,7 @@ static int iio_buffer_add_channel_sysfs(struct iio_dev *indio_dev,
> return ret;
> }
>
> -static ssize_t iio_buffer_read_length(struct device *dev,
> +static ssize_t length_show(struct device *dev,
> struct device_attribute *attr,
> char *buf)
> {
> @@ -507,7 +507,7 @@ static ssize_t iio_buffer_read_length(struct device *dev,
> return sprintf(buf, "%d\n", buffer->length);
> }
>
> -static ssize_t iio_buffer_write_length(struct device *dev,
> +static ssize_t length_store(struct device *dev,
> struct device_attribute *attr,
> const char *buf, size_t len)
> {
> @@ -540,7 +540,7 @@ static ssize_t iio_buffer_write_length(struct device *dev,
> return ret ? ret : len;
> }
>
> -static ssize_t iio_buffer_show_enable(struct device *dev,
> +static ssize_t enable_show(struct device *dev,
> struct device_attribute *attr,
> char *buf)
> {
> @@ -1117,7 +1117,7 @@ void iio_disable_all_buffers(struct iio_dev *indio_dev)
> iio_buffer_deactivate_all(indio_dev);
> }
>
> -static ssize_t iio_buffer_store_enable(struct device *dev,
> +static ssize_t enable_store(struct device *dev,
> struct device_attribute *attr,
> const char *buf,
> size_t len)
> @@ -1153,7 +1153,7 @@ static ssize_t iio_buffer_store_enable(struct device *dev,
>
> static const char * const iio_scan_elements_group_name = "scan_elements";
>
> -static ssize_t iio_buffer_show_watermark(struct device *dev,
> +static ssize_t watermark_show(struct device *dev,
> struct device_attribute *attr,
> char *buf)
> {
> @@ -1163,7 +1163,7 @@ static ssize_t iio_buffer_show_watermark(struct device *dev,
> return sprintf(buf, "%u\n", buffer->watermark);
> }
>
> -static ssize_t iio_buffer_store_watermark(struct device *dev,
> +static ssize_t watermark_store(struct device *dev,
> struct device_attribute *attr,
> const char *buf,
> size_t len)
> @@ -1198,16 +1198,13 @@ static ssize_t iio_buffer_store_watermark(struct device *dev,
> return ret ? ret : len;
> }
>
> -static DEVICE_ATTR(length, S_IRUGO | S_IWUSR, iio_buffer_read_length,
> - iio_buffer_write_length);
> +static DEVICE_ATTR_RW(length);
> static struct device_attribute dev_attr_length_ro = __ATTR(length,
> - S_IRUGO, iio_buffer_read_length, NULL);
> -static DEVICE_ATTR(enable, S_IRUGO | S_IWUSR,
> - iio_buffer_show_enable, iio_buffer_store_enable);
> -static DEVICE_ATTR(watermark, S_IRUGO | S_IWUSR,
> - iio_buffer_show_watermark, iio_buffer_store_watermark);
> + S_IRUGO, length_show, NULL);
> +static DEVICE_ATTR_RW(enable);
> +static DEVICE_ATTR_RW(watermark);
> static struct device_attribute dev_attr_watermark_ro = __ATTR(watermark,
> - S_IRUGO, iio_buffer_show_watermark, NULL);
> + S_IRUGO, watermark_show, NULL);
>
> static struct attribute *iio_buffer_attrs[] = {
> &dev_attr_length.attr,

2018-01-06 12:50:40

by Lars-Peter Clausen

[permalink] [raw]

Subject: Re: [PATCH 1/5] iio: buffer: use permission specific variants of DEVICE_ATTR

On 01/06/2018 01:35 PM, Jonathan Cameron wrote:
> On Thu, 4 Jan 2018 20:07:14 +0530
> Aishwarya Pant <[email protected]> wrote:
>
>> This is a clean-up patch which replaces DEVICE_ATTR macro with the file
>> permission specific DEVICE_ATTR_{RO/WO/RW} macros for compaction and
>> readability. Done using coccinelle.
>
> Hmm. I'll be honest, I personally really dislike these macros.
> They absolutely don't help with readability because they obscure
> the connection between the attributes being created and their callbacks.
> Short is not the same as more readable.

FWIW fully agreed.

2018-01-06 13:19:02

by Julia Lawall

[permalink] [raw]

Subject: Re: [PATCH 1/5] iio: buffer: use permission specific variants of DEVICE_ATTR

On Sat, 6 Jan 2018, Lars-Peter Clausen wrote:

> On 01/06/2018 01:35 PM, Jonathan Cameron wrote:
> > On Thu, 4 Jan 2018 20:07:14 +0530
> > Aishwarya Pant <[email protected]> wrote:
> >
> >> This is a clean-up patch which replaces DEVICE_ATTR macro with the file
> >> permission specific DEVICE_ATTR_{RO/WO/RW} macros for compaction and
> >> readability. Done using coccinelle.
> >
> > Hmm. I'll be honest, I personally really dislike these macros.
> > They absolutely don't help with readability because they obscure
> > the connection between the attributes being created and their callbacks.
> > Short is not the same as more readable.
>
> FWIW fully agreed.

Could there be variants that keep the function names as arguments, but
keep the benefit of the simpler permission specification and ensuring that
the right functions are provided for the given permissions?

julia

2018-01-06 14:17:58

by Jonathan Cameron

[permalink] [raw]

Subject: Re: [PATCH 1/5] iio: buffer: use permission specific variants of DEVICE_ATTR

On Sat, 6 Jan 2018 14:18:58 +0100 (CET)
Julia Lawall <[email protected]> wrote:

> On Sat, 6 Jan 2018, Lars-Peter Clausen wrote:
>
> > On 01/06/2018 01:35 PM, Jonathan Cameron wrote:
> > > On Thu, 4 Jan 2018 20:07:14 +0530
> > > Aishwarya Pant <[email protected]> wrote:
> > >
> > >> This is a clean-up patch which replaces DEVICE_ATTR macro with the file
> > >> permission specific DEVICE_ATTR_{RO/WO/RW} macros for compaction and
> > >> readability. Done using coccinelle.
> > >
> > > Hmm. I'll be honest, I personally really dislike these macros.
> > > They absolutely don't help with readability because they obscure
> > > the connection between the attributes being created and their callbacks.
> > > Short is not the same as more readable.
> >
> > FWIW fully agreed.
>
> Could there be variants that keep the function names as arguments, but
> keep the benefit of the simpler permission specification and ensuring that
> the right functions are provided for the given permissions?

Yes, that would bring the benefits without the readability cost.
No one needs to know that RW means some octal number after all.

Jonathan
>
> julia
> --
> To unsubscribe from this list: send the line "unsubscribe linux-iio" in
> the body of a message to [email protected]
> More majordomo info at http://vger.kernel.org/majordomo-info.html

2018-01-06 15:28:36

by Joe Perches

[permalink] [raw]

Subject: Re: [PATCH 1/5] iio: buffer: use permission specific variants of DEVICE_ATTR

(Adding Greg KH who is I think the biggest proponent of these macros)

On Sat, 2018-01-06 at 12:35 +0000, Jonathan Cameron wrote:
> On Thu, 4 Jan 2018 20:07:14 +0530
> Aishwarya Pant <[email protected]> wrote
>
> > This is a clean-up patch which replaces DEVICE_ATTR macro with the file
> > permission specific DEVICE_ATTR_{RO/WO/RW} macros for compaction and
> > readability. Done using coccinelle.
>
> Hmm. I'll be honest, I personally really dislike these macros.
> They absolutely don't help with readability because they obscure
> the connection between the attributes being created and their callbacks.
> Short is not the same as more readable.
>
> Dropping off the prefixes from function names suddenly makes them
> appear a lot more generic than they are. The only advantage is is
> standardizes their naming slightly - but that could be done whilst
> maintaining the more readable version that makes everything obvious.
>
> I'll think on whether the compactness gains are sufficient to justify their
> use.
>
> >
> > Signed-off-by: Aishwarya Pant <[email protected]>
> > ---
> > drivers/iio/industrialio-buffer.c | 25 +++++++++++--------------
> > 1 file changed, 11 insertions(+), 14 deletions(-)
> >
> > diff --git a/drivers/iio/industrialio-buffer.c b/drivers/iio/industrialio-buffer.c
> > index d2b465140a6b..ca565fbcff90 100644
> > --- a/drivers/iio/industrialio-buffer.c
> > +++ b/drivers/iio/industrialio-buffer.c
> > @@ -497,7 +497,7 @@ static int iio_buffer_add_channel_sysfs(struct iio_dev *indio_dev,
> > return ret;
> > }
> >
> > -static ssize_t iio_buffer_read_length(struct device *dev,
> > +static ssize_t length_show(struct device *dev,
> > struct device_attribute *attr,
> > char *buf)
> > {
> > @@ -507,7 +507,7 @@ static ssize_t iio_buffer_read_length(struct device *dev,
> > return sprintf(buf, "%d\n", buffer->length);
> > }
> >
> > -static ssize_t iio_buffer_write_length(struct device *dev,
> > +static ssize_t length_store(struct device *dev,
> > struct device_attribute *attr,
> > const char *buf, size_t len)
> > {
> > @@ -540,7 +540,7 @@ static ssize_t iio_buffer_write_length(struct device *dev,
> > return ret ? ret : len;
> > }
> >
> > -static ssize_t iio_buffer_show_enable(struct device *dev,
> > +static ssize_t enable_show(struct device *dev,
> > struct device_attribute *attr,
> > char *buf)
> > {
> > @@ -1117,7 +1117,7 @@ void iio_disable_all_buffers(struct iio_dev *indio_dev)
> > iio_buffer_deactivate_all(indio_dev);
> > }
> >
> > -static ssize_t iio_buffer_store_enable(struct device *dev,
> > +static ssize_t enable_store(struct device *dev,
> > struct device_attribute *attr,
> > const char *buf,
> > size_t len)
> > @@ -1153,7 +1153,7 @@ static ssize_t iio_buffer_store_enable(struct device *dev,
> >
> > static const char * const iio_scan_elements_group_name = "scan_elements";
> >
> > -static ssize_t iio_buffer_show_watermark(struct device *dev,
> > +static ssize_t watermark_show(struct device *dev,
> > struct device_attribute *attr,
> > char *buf)
> > {
> > @@ -1163,7 +1163,7 @@ static ssize_t iio_buffer_show_watermark(struct device *dev,
> > return sprintf(buf, "%u\n", buffer->watermark);
> > }
> >
> > -static ssize_t iio_buffer_store_watermark(struct device *dev,
> > +static ssize_t watermark_store(struct device *dev,
> > struct device_attribute *attr,
> > const char *buf,
> > size_t len)
> > @@ -1198,16 +1198,13 @@ static ssize_t iio_buffer_store_watermark(struct device *dev,
> > return ret ? ret : len;
> > }
> >
> > -static DEVICE_ATTR(length, S_IRUGO | S_IWUSR, iio_buffer_read_length,
> > - iio_buffer_write_length);
> > +static DEVICE_ATTR_RW(length);
> > static struct device_attribute dev_attr_length_ro = __ATTR(length,
> > - S_IRUGO, iio_buffer_read_length, NULL);
> > -static DEVICE_ATTR(enable, S_IRUGO | S_IWUSR,
> > - iio_buffer_show_enable, iio_buffer_store_enable);
> > -static DEVICE_ATTR(watermark, S_IRUGO | S_IWUSR,
> > - iio_buffer_show_watermark, iio_buffer_store_watermark);
> > + S_IRUGO, length_show, NULL);
> > +static DEVICE_ATTR_RW(enable);
> > +static DEVICE_ATTR_RW(watermark);
> > static struct device_attribute dev_attr_watermark_ro = __ATTR(watermark,
> > - S_IRUGO, iio_buffer_show_watermark, NULL);
> > + S_IRUGO, watermark_show, NULL);
> >
> > static struct attribute *iio_buffer_attrs[] = {
> > &dev_attr_length.attr,
>
>