Re: [PATCH 3/4 v2] firmware: stratix10-svc: Fix some error handling paths in stratix10_svc_drv_probe()

Re: [PATCH 3/4 v2] firmware: stratix10-svc: Fix some error handling paths in stratix10_svc_drv_probe()

[Markus Elfring]

> While at it, also move a 'platform_device_put()' call to the error handling path.

How do you think about to use the message “Complete exception handling
in stratix10_svc_drv_probe()” in the final commit subject?


…
> +++ b/drivers/firmware/stratix10-svc.c
…
> @@ -1043,24 +1043,34 @@  static int stratix10_svc_drv_probe(struct platform_device *pdev)
…
> +	return 0;
> +
> +put_platform:
> +	platform_device_put(svc->stratix10_svc_rsu);
> +err_free_kfifo:
…
>  	return ret;
>  }


Can the label “err_put_device” be more appropriate for the improved
function implementation?
(Or: Would you like to omit the prefix “err_” for these jump targets?)

Regards,
Markus

[PATCH 0/4 v2] firmware: stratix10-svc: Fix some error handling code

[Christophe JAILLET]

This serie was previously sent as a single patch.
After a comment from Dan Carpenter about an error handling path that could be
improved, I've looked deeper at the code and found other issues.

The previous patch corresponds to patch 3/4 in this serie.
This v2 takes Dan's comment into account and fix another resource leak.

Patch 1/4: svc_create_memory_pool returns an error code on error, not NULL 
Patch 2/4: undo a memremap on error path and remove funtion
Patch 3/4: improve error handling in the probe function
Patch 4/4: unrelated clean-up

Christophe JAILLET (4):
  firmware: stratix10-svc: Fix genpool creation error handling
  firmware: stratix10-svc: Unmap some previously memremap'ed memory
  firmware: stratix10-svc: Fix some error handling paths in
    'stratix10_svc_drv_probe()'
  firmware: stratix10-svc: Slighly simplify call

 drivers/firmware/stratix10-svc.c | 42 +++++++++++++++++++-------------
 1 file changed, 25 insertions(+), 17 deletions(-)

-- 
2.25.1

[PATCH 3/4 v2] firmware: stratix10-svc: Fix some error handling paths in 'stratix10_svc_drv_probe()'

[Christophe JAILLET]

If an error occurs after calling 'svc_create_memory_pool()', the allocated
genpool should be destroyed with 'gen_pool_destroy()', as already done in
the remove function.

If an error occurs after calling 'kfifo_alloc()', the allocated memory
should be freed with 'kfifo_free()', as already done in the remove
function.

While at it, also move a 'platform_device_put()' call to the error handling
path.

Fixes: b5dc75c915cd ("firmware: stratix10-svc: extend svc to support new RSU features")
Fixes: 7ca5ce896524 ("firmware: add Intel Stratix10 service layer driver")
Signed-off-by: Christophe JAILLET <christophe.jaillet@wanadoo.fr>
---
 drivers/firmware/stratix10-svc.c | 26 ++++++++++++++++++--------
 1 file changed, 18 insertions(+), 8 deletions(-)

diff --git a/drivers/firmware/stratix10-svc.c b/drivers/firmware/stratix10-svc.c
index de5870f76c5e..739004398877 100644
--- a/drivers/firmware/stratix10-svc.c
+++ b/drivers/firmware/stratix10-svc.c
@@ -1024,7 +1024,7 @@ static int stratix10_svc_drv_probe(struct platform_device *pdev)
 	ret = kfifo_alloc(&controller->svc_fifo, fifo_size, GFP_KERNEL);
 	if (ret) {
 		dev_err(dev, "failed to allocate FIFO\n");
-		return ret;
+		goto err_destroy_pool;
 	}
 	spin_lock_init(&controller->svc_fifo_lock);
 
@@ -1043,24 +1043,34 @@ static int stratix10_svc_drv_probe(struct platform_device *pdev)
 
 	/* add svc client device(s) */
 	svc = devm_kzalloc(dev, sizeof(*svc), GFP_KERNEL);
-	if (!svc)
-		return -ENOMEM;
+	if (!svc) {
+		ret = -ENOMEM;
+		goto err_free_kfifo;
+	}
 
 	svc->stratix10_svc_rsu = platform_device_alloc(STRATIX10_RSU, 0);
 	if (!svc->stratix10_svc_rsu) {
 		dev_err(dev, "failed to allocate %s device\n", STRATIX10_RSU);
-		return -ENOMEM;
+		ret = -ENOMEM;
+		goto err_free_kfifo;
 	}
 
 	ret = platform_device_add(svc->stratix10_svc_rsu);
-	if (ret) {
-		platform_device_put(svc->stratix10_svc_rsu);
-		return ret;
-	}
+	if (ret)
+		goto put_platform;
+
 	dev_set_drvdata(dev, svc);
 
 	pr_info("Intel Service Layer Driver Initialized\n");
 
+	return 0;
+
+put_platform:
+	platform_device_put(svc->stratix10_svc_rsu);
+err_free_kfifo:
+	kfifo_free(&controller->svc_fifo);
+err_destroy_pool:
+	gen_pool_destroy(genpool);
 	return ret;
 }
 
-- 
2.25.1

Re: [PATCH 3/4 v2] firmware: stratix10-svc: Fix some error handling paths in 'stratix10_svc_drv_probe()'

[Richard Gong]

Hi,

Similarly we need add error handling for controller and chans, something 
like below:

@@ -997,13 +997,17 @@ static int stratix10_svc_drv_probe(struct 
platform_device *pdev)

         /* allocate service controller and supporting channel */
         controller = devm_kzalloc(dev, sizeof(*controller), GFP_KERNEL);
-       if (!controller)
-               return -ENOMEM;
+       if (!controller) {
+               ret = -ENOMEM;
+               goto err_destroy_pool;
+       }

         chans = devm_kmalloc_array(dev, SVC_NUM_CHANNEL,
                                    sizeof(*chans), GFP_KERNEL | 
__GFP_ZERO);
-       if (!chans)
-               return -ENOMEM;
+       if (!chans) {
+               ret = -ENOMEM;
+               goto err_destroy_pool;
+       }

         controller->dev = dev;
         controller->num_chans = SVC_NUM_CHANNEL;

On 4/29/20 1:52 AM, Christophe JAILLET wrote:
> If an error occurs after calling 'svc_create_memory_pool()', the allocated
> genpool should be destroyed with 'gen_pool_destroy()', as already done in
> the remove function.
> 
> If an error occurs after calling 'kfifo_alloc()', the allocated memory
> should be freed with 'kfifo_free()', as already done in the remove
> function.
> 
> While at it, also move a 'platform_device_put()' call to the error handling
> path.
> 
> Fixes: b5dc75c915cd ("firmware: stratix10-svc: extend svc to support new RSU features")
> Fixes: 7ca5ce896524 ("firmware: add Intel Stratix10 service layer driver")
> Signed-off-by: Christophe JAILLET <christophe.jaillet@wanadoo.fr>
> ---
>   drivers/firmware/stratix10-svc.c | 26 ++++++++++++++++++--------
>   1 file changed, 18 insertions(+), 8 deletions(-)
> 
I am fine with below changes.

> diff --git a/drivers/firmware/stratix10-svc.c b/drivers/firmware/stratix10-svc.c
> index de5870f76c5e..739004398877 100644
> --- a/drivers/firmware/stratix10-svc.c
> +++ b/drivers/firmware/stratix10-svc.c
> @@ -1024,7 +1024,7 @@ static int stratix10_svc_drv_probe(struct platform_device *pdev)
>   	ret = kfifo_alloc(&controller->svc_fifo, fifo_size, GFP_KERNEL);
>   	if (ret) {
>   		dev_err(dev, "failed to allocate FIFO\n");
> -		return ret;
> +		goto err_destroy_pool;
>   	}
>   	spin_lock_init(&controller->svc_fifo_lock);
>   
> @@ -1043,24 +1043,34 @@ static int stratix10_svc_drv_probe(struct platform_device *pdev)
>   
>   	/* add svc client device(s) */
>   	svc = devm_kzalloc(dev, sizeof(*svc), GFP_KERNEL);
> -	if (!svc)
> -		return -ENOMEM;
> +	if (!svc) {
> +		ret = -ENOMEM;
> +		goto err_free_kfifo;
> +	}
>   
>   	svc->stratix10_svc_rsu = platform_device_alloc(STRATIX10_RSU, 0);
>   	if (!svc->stratix10_svc_rsu) {
>   		dev_err(dev, "failed to allocate %s device\n", STRATIX10_RSU);
> -		return -ENOMEM;
> +		ret = -ENOMEM;
> +		goto err_free_kfifo;
>   	}
>   
>   	ret = platform_device_add(svc->stratix10_svc_rsu);
> -	if (ret) {
> -		platform_device_put(svc->stratix10_svc_rsu);
> -		return ret;
> -	}
> +	if (ret)
> +		goto put_platform;
> +
>   	dev_set_drvdata(dev, svc);
>   
>   	pr_info("Intel Service Layer Driver Initialized\n");
>   
> +	return 0;
> +
> +put_platform:
> +	platform_device_put(svc->stratix10_svc_rsu);
> +err_free_kfifo:
> +	kfifo_free(&controller->svc_fifo);
> +err_destroy_pool:
> +	gen_pool_destroy(genpool);
>   	return ret;
>   }
>   
> 
Regards,
Richard

Re: [PATCH 3/4 v2] firmware: stratix10-svc: Fix some error handling paths in 'stratix10_svc_drv_probe()'

[Christophe JAILLET]

Le 05/05/2020 à 16:02, Richard Gong a écrit :
> Hi,
>
> Similarly we need add error handling for controller and chans, 
> something like below:
>
> @@ -997,13 +997,17 @@ static int stratix10_svc_drv_probe(struct 
> platform_device *pdev)
>
>         /* allocate service controller and supporting channel */
>         controller = devm_kzalloc(dev, sizeof(*controller), GFP_KERNEL);
> -       if (!controller)
> -               return -ENOMEM;
> +       if (!controller) {
> +               ret = -ENOMEM;
> +               goto err_destroy_pool;
> +       }
>
>         chans = devm_kmalloc_array(dev, SVC_NUM_CHANNEL,
>                                    sizeof(*chans), GFP_KERNEL | 
> __GFP_ZERO);
> -       if (!chans)
> -               return -ENOMEM;
> +       if (!chans) {
> +               ret = -ENOMEM;
> +               goto err_destroy_pool;
> +       }
>
>         controller->dev = dev;
>         controller->num_chans = SVC_NUM_CHANNEL;
>
Hi,

This is addressed in patch 1/4.
It moves 'svc_create_memory_pool' after these 2 allocations in order to 
avoid the goto.

I'll send a V3 in only 1 patch, as you proposed, it will ease review.

CJ


> On 4/29/20 1:52 AM, Christophe JAILLET wrote:
>> If an error occurs after calling 'svc_create_memory_pool()', the 
>> allocated
>> genpool should be destroyed with 'gen_pool_destroy()', as already 
>> done in
>> the remove function.
>>
>> If an error occurs after calling 'kfifo_alloc()', the allocated memory
>> should be freed with 'kfifo_free()', as already done in the remove
>> function.
>>
>> While at it, also move a 'platform_device_put()' call to the error 
>> handling
>> path.
>>
>> Fixes: b5dc75c915cd ("firmware: stratix10-svc: extend svc to support 
>> new RSU features")
>> Fixes: 7ca5ce896524 ("firmware: add Intel Stratix10 service layer 
>> driver")
>> Signed-off-by: Christophe JAILLET <christophe.jaillet@wanadoo.fr>
>> ---
>>   drivers/firmware/stratix10-svc.c | 26 ++++++++++++++++++--------
>>   1 file changed, 18 insertions(+), 8 deletions(-)
>>
> I am fine with below changes.
>
>> diff --git a/drivers/firmware/stratix10-svc.c 
>> b/drivers/firmware/stratix10-svc.c
>> index de5870f76c5e..739004398877 100644
>> --- a/drivers/firmware/stratix10-svc.c
>> +++ b/drivers/firmware/stratix10-svc.c
>> @@ -1024,7 +1024,7 @@ static int stratix10_svc_drv_probe(struct 
>> platform_device *pdev)
>>       ret = kfifo_alloc(&controller->svc_fifo, fifo_size, GFP_KERNEL);
>>       if (ret) {
>>           dev_err(dev, "failed to allocate FIFO\n");
>> -        return ret;
>> +        goto err_destroy_pool;
>>       }
>>       spin_lock_init(&controller->svc_fifo_lock);
>>   @@ -1043,24 +1043,34 @@ static int stratix10_svc_drv_probe(struct 
>> platform_device *pdev)
>>         /* add svc client device(s) */
>>       svc = devm_kzalloc(dev, sizeof(*svc), GFP_KERNEL);
>> -    if (!svc)
>> -        return -ENOMEM;
>> +    if (!svc) {
>> +        ret = -ENOMEM;
>> +        goto err_free_kfifo;
>> +    }
>>         svc->stratix10_svc_rsu = platform_device_alloc(STRATIX10_RSU, 
>> 0);
>>       if (!svc->stratix10_svc_rsu) {
>>           dev_err(dev, "failed to allocate %s device\n", STRATIX10_RSU);
>> -        return -ENOMEM;
>> +        ret = -ENOMEM;
>> +        goto err_free_kfifo;
>>       }
>>         ret = platform_device_add(svc->stratix10_svc_rsu);
>> -    if (ret) {
>> -        platform_device_put(svc->stratix10_svc_rsu);
>> -        return ret;
>> -    }
>> +    if (ret)
>> +        goto put_platform;
>> +
>>       dev_set_drvdata(dev, svc);
>>         pr_info("Intel Service Layer Driver Initialized\n");
>>   +    return 0;
>> +
>> +put_platform:
>> +    platform_device_put(svc->stratix10_svc_rsu);
>> +err_free_kfifo:
>> +    kfifo_free(&controller->svc_fifo);
>> +err_destroy_pool:
>> +    gen_pool_destroy(genpool);
>>       return ret;
>>   }
>>
> Regards,
> Richard
>