Re: [RFC PATCH] gpiolib: Refactor gpio_export

Ryan Mallon
2012-10-19T22:14:21Z

On 19/10/12 21:07, Linus Walleij wrote:

> On Wed, Oct 17, 2012 at 1:41 AM, Ryan Mallon <rmallon@gmail.com> wrote:
>
>> The gpio_export function uses nested if statements and the status
>> variable to handle the failure cases. This makes the function logic
>> difficult to follow. Refactor the code to abort immediately on failure
>> using goto. This makes the code slightly longer, but significantly
>> reduces the nesting and number of split lines and makes the code easier
>> to read.
>>
>> Signed-off-by: Ryan Mallon
>
> Very good initiative!
>
>> +++ b/drivers/gpio/gpiolib.c
>> @@ -702,68 +702,74 @@ int gpio_export(unsigned gpio, bool direction_may_change)
>> {
>> unsigned long flags;
>> struct gpio_desc *desc;
>> - int status = -EINVAL;
>> + int status;
>> const char *ioname = NULL;
>> + struct device *dev;
>>
>> /* can't export until sysfs is available ... */
>> if (!gpio_class.p) {
>> pr_debug("%s: called too early!\n", __func__);
>> - return -ENOENT;
>> + status = -ENOENT;
>> + goto fail;
>
> Why bother with all the goto:s here since there are no resources
> to clean up? Just pr_debug() and return -ENOENT; is good enough.
>
> I don't quite see the point.

I did it this way just so that there would be a single exit point.
I don't mind either way, so I'll update the ones without any
clean up to simply return.

> Arguably this should be pr_err() or something BTW, just debug()
> may hide serious bugs.

Not sure about that. User-space can check the return code if it
wants to find out why the call failed. We shouldn't
unconditionally spam the log with error messages on sysfs
access since it makes an easy DoS vector on the syslog. The
pr_debug messages I think are really for people who are
developing on gpiolib.

~Ryan