[PATCH v3 1/2] RDMA/hfi1: Fix error return code in parse_platform_config()

[PATCH v3 1/2] RDMA/hfi1: Fix error return code in parse_platform_config()

[Wang Yufen]

In the previous while loop, "ret" may be assigned zero, so the error
return code may be incorrectly set to 0 instead of -EINVAL.
Add bail_with_einval goto label and covert all "goto bail;" to "goto
bail_with_einval:" where it's appropriate. Add dropping some duplicative
"ret = -EINVAL;" lines, as Andy suggessted.

Fixes: 97167e813415 ("staging/rdma/hfi1: Tune for unknown channel if configuration file is absent")
Signed-off-by: Wang Yufen <wangyufen@huawei.com>
Reviewed-by: Andy Shevchenko <andriy.shevchenko@linux.intel.com>
---
 drivers/infiniband/hw/hfi1/firmware.c | 20 +++++++++++---------
 1 file changed, 11 insertions(+), 9 deletions(-)

diff --git a/drivers/infiniband/hw/hfi1/firmware.c b/drivers/infiniband/hw/hfi1/firmware.c
index 1d77514..44d8628 100644
--- a/drivers/infiniband/hw/hfi1/firmware.c
+++ b/drivers/infiniband/hw/hfi1/firmware.c
@@ -1730,7 +1730,7 @@ int parse_platform_config(struct hfi1_devdata *dd)
 	u32 *ptr = NULL;
 	u32 header1 = 0, header2 = 0, magic_num = 0, crc = 0, file_length = 0;
 	u32 record_idx = 0, table_type = 0, table_length_dwords = 0;
-	int ret = -EINVAL; /* assume failure */
+	int ret;
 
 	/*
 	 * For integrated devices that did not fall back to the default file,
@@ -1743,7 +1743,7 @@ int parse_platform_config(struct hfi1_devdata *dd)
 
 	if (!dd->platform_config.data) {
 		dd_dev_err(dd, "%s: Missing config file\n", __func__);
-		goto bail;
+		goto bail_with_einval;
 	}
 	ptr = (u32 *)dd->platform_config.data;
 
@@ -1751,7 +1751,7 @@ int parse_platform_config(struct hfi1_devdata *dd)
 	ptr++;
 	if (magic_num != PLATFORM_CONFIG_MAGIC_NUM) {
 		dd_dev_err(dd, "%s: Bad config file\n", __func__);
-		goto bail;
+		goto bail_with_einval;
 	}
 
 	/* Field is file size in DWORDs */
@@ -1774,7 +1774,7 @@ int parse_platform_config(struct hfi1_devdata *dd)
 	if (file_length > dd->platform_config.size) {
 		dd_dev_info(dd, "%s:File claims to be larger than read size\n",
 			    __func__);
-		goto bail;
+		goto bail_with_einval;
 	} else if (file_length < dd->platform_config.size) {
 		dd_dev_info(dd,
 			    "%s:File claims to be smaller than read size, continuing\n",
@@ -1794,7 +1794,7 @@ int parse_platform_config(struct hfi1_devdata *dd)
 			dd_dev_err(dd, "%s: Failed validation at offset %ld\n",
 				   __func__, (ptr - (u32 *)
 					      dd->platform_config.data));
-			goto bail;
+			goto bail_with_einval;
 		}
 
 		record_idx = *ptr &
@@ -1837,7 +1837,7 @@ int parse_platform_config(struct hfi1_devdata *dd)
 					   __func__, table_type,
 					   (ptr - (u32 *)
 					    dd->platform_config.data));
-				goto bail; /* We don't trust this file now */
+				goto bail_with_einval; /* We don't trust this file now */
 			}
 			pcfgcache->config_tables[table_type].table = ptr;
 		} else {
@@ -1856,7 +1856,7 @@ int parse_platform_config(struct hfi1_devdata *dd)
 					   __func__, table_type,
 					   (ptr -
 					    (u32 *)dd->platform_config.data));
-				goto bail; /* We don't trust this file now */
+				goto bail_with_einval; /* We don't trust this file now */
 			}
 			pcfgcache->config_tables[table_type].table_metadata =
 									ptr;
@@ -1873,8 +1873,7 @@ int parse_platform_config(struct hfi1_devdata *dd)
 			dd_dev_err(dd, "%s: Failed CRC check at offset %ld\n",
 				   __func__, (ptr -
 				   (u32 *)dd->platform_config.data));
-			ret = -EINVAL;
-			goto bail;
+			goto bail_with_einval;
 		}
 		/* Jump the CRC DWORD */
 		ptr++;
@@ -1882,6 +1881,9 @@ int parse_platform_config(struct hfi1_devdata *dd)
 
 	pcfgcache->cache_valid = 1;
 	return 0;
+
+bail_with_einval:
+	ret = -EINVAL;
 bail:
 	memset(pcfgcache, 0, sizeof(struct platform_config_cache));
 	return ret;
-- 
1.8.3.1

[PATCH v3 2/2] RDMA/srp: Fix error return code in srp_parse_options()

[Wang Yufen]

In the previous while loop, "ret" may be assigned zero, , so the error
return code may be incorrectly set to 0 instead of -EINVAL.
Add out_with_einval goto label and covert all "goto out;" to "goto
out_with_einval:" where it's appropriate, alse investigate each case
separately as Andy suggessted.

Fixes: e711f968c49c ("IB/srp: replace custom implementation of hex2bin()")
Fixes: 2a174df0c602 ("IB/srp: Use kstrtoull() instead of simple_strtoull()")
Fixes: 19f313438c77 ("IB/srp: Add RDMA/CM support")
Signed-off-by: Wang Yufen <wangyufen@huawei.com>
---
 drivers/infiniband/ulp/srp/ib_srp.c | 86 ++++++++++++++++++++++++++-----------
 1 file changed, 60 insertions(+), 26 deletions(-)

diff --git a/drivers/infiniband/ulp/srp/ib_srp.c b/drivers/infiniband/ulp/srp/ib_srp.c
index 1075c2a..23445b7 100644
--- a/drivers/infiniband/ulp/srp/ib_srp.c
+++ b/drivers/infiniband/ulp/srp/ib_srp.c
@@ -3343,7 +3343,7 @@ static int srp_parse_options(struct net *net, const char *buf,
 	bool has_port;
 	int opt_mask = 0;
 	int token;
-	int ret = -EINVAL;
+	int ret;
 	int i;
 
 	options = kstrdup(buf, GFP_KERNEL);
@@ -3410,7 +3410,8 @@ static int srp_parse_options(struct net *net, const char *buf,
 			break;
 
 		case SRP_OPT_PKEY:
-			if (match_hex(args, &token)) {
+			ret = match_hex(args, &token);
+			if (ret) {
 				pr_warn("bad P_Key parameter '%s'\n", p);
 				goto out;
 			}
@@ -3470,7 +3471,8 @@ static int srp_parse_options(struct net *net, const char *buf,
 			break;
 
 		case SRP_OPT_MAX_SECT:
-			if (match_int(args, &token)) {
+			ret = match_int(args, &token);
+			if (ret) {
 				pr_warn("bad max sect parameter '%s'\n", p);
 				goto out;
 			}
@@ -3478,9 +3480,12 @@ static int srp_parse_options(struct net *net, const char *buf,
 			break;
 
 		case SRP_OPT_QUEUE_SIZE:
-			if (match_int(args, &token) || token < 1) {
-				pr_warn("bad queue_size parameter '%s'\n", p);
+			ret = match_int(args, &token);
+			if (ret)
 				goto out;
+			if (token < 1) {
+				pr_warn("bad queue_size parameter '%s'\n", p);
+				goto out_with_einval;
 			}
 			target->scsi_host->can_queue = token;
 			target->queue_size = token + SRP_RSP_SQ_SIZE +
@@ -3490,25 +3495,32 @@ static int srp_parse_options(struct net *net, const char *buf,
 			break;
 
 		case SRP_OPT_MAX_CMD_PER_LUN:
-			if (match_int(args, &token) || token < 1) {
+			ret = match_int(args, &token);
+			if (ret)
+				goto out;
+			if (token < 1) {
 				pr_warn("bad max cmd_per_lun parameter '%s'\n",
 					p);
-				goto out;
+				goto out_with_einval;
 			}
 			target->scsi_host->cmd_per_lun = token;
 			break;
 
 		case SRP_OPT_TARGET_CAN_QUEUE:
-			if (match_int(args, &token) || token < 1) {
+			ret = match_int(args, &token);
+			if (ret)
+				goto out;
+			if (token < 1) {
 				pr_warn("bad max target_can_queue parameter '%s'\n",
 					p);
-				goto out;
+				goto out_with_einval;
 			}
 			target->target_can_queue = token;
 			break;
 
 		case SRP_OPT_IO_CLASS:
-			if (match_hex(args, &token)) {
+			ret = match_hex(args, &token);
+			if (ret) {
 				pr_warn("bad IO class parameter '%s'\n", p);
 				goto out;
 			}
@@ -3517,7 +3529,7 @@ static int srp_parse_options(struct net *net, const char *buf,
 				pr_warn("unknown IO class parameter value %x specified (use %x or %x).\n",
 					token, SRP_REV10_IB_IO_CLASS,
 					SRP_REV16A_IB_IO_CLASS);
-				goto out;
+				goto out_with_einval;
 			}
 			target->io_class = token;
 			break;
@@ -3539,16 +3551,20 @@ static int srp_parse_options(struct net *net, const char *buf,
 			break;
 
 		case SRP_OPT_CMD_SG_ENTRIES:
-			if (match_int(args, &token) || token < 1 || token > 255) {
+			ret = match_int(args, &token);
+			if (ret)
+				goto out;
+			if (token < 1 || token > 255) {
 				pr_warn("bad max cmd_sg_entries parameter '%s'\n",
 					p);
-				goto out;
+				goto out_with_einval;
 			}
 			target->cmd_sg_cnt = token;
 			break;
 
 		case SRP_OPT_ALLOW_EXT_SG:
-			if (match_int(args, &token)) {
+			ret = match_int(args, &token);
+			if (ret) {
 				pr_warn("bad allow_ext_sg parameter '%s'\n", p);
 				goto out;
 			}
@@ -3556,44 +3572,58 @@ static int srp_parse_options(struct net *net, const char *buf,
 			break;
 
 		case SRP_OPT_SG_TABLESIZE:
-			if (match_int(args, &token) || token < 1 ||
-					token > SG_MAX_SEGMENTS) {
+			ret = match_int(args, &token);
+			if (ret)
+				goto out;
+			if (token < 1 || token > SG_MAX_SEGMENTS) {
 				pr_warn("bad max sg_tablesize parameter '%s'\n",
 					p);
-				goto out;
+				goto out_with_einval;
 			}
 			target->sg_tablesize = token;
 			break;
 
 		case SRP_OPT_COMP_VECTOR:
-			if (match_int(args, &token) || token < 0) {
-				pr_warn("bad comp_vector parameter '%s'\n", p);
+			ret = match_int(args, &token);
+			if (ret)
 				goto out;
+			if (token < 0) {
+				pr_warn("bad comp_vector parameter '%s'\n", p);
+				goto out_with_einval;
 			}
 			target->comp_vector = token;
 			break;
 
 		case SRP_OPT_TL_RETRY_COUNT:
-			if (match_int(args, &token) || token < 2 || token > 7) {
+			ret = match_int(args, &token);
+			if (ret)
+				goto out;
+			if (token < 2 || token > 7) {
 				pr_warn("bad tl_retry_count parameter '%s' (must be a number between 2 and 7)\n",
 					p);
-				goto out;
+				goto out_with_einval;
 			}
 			target->tl_retry_count = token;
 			break;
 
 		case SRP_OPT_MAX_IT_IU_SIZE:
-			if (match_int(args, &token) || token < 0) {
-				pr_warn("bad maximum initiator to target IU size '%s'\n", p);
+			ret = match_int(args, &token);
+			if (ret)
 				goto out;
+			if (token < 0) {
+				pr_warn("bad maximum initiator to target IU size '%s'\n", p);
+				goto out_with_einval;
 			}
 			target->max_it_iu_size = token;
 			break;
 
 		case SRP_OPT_CH_COUNT:
-			if (match_int(args, &token) || token < 1) {
-				pr_warn("bad channel count %s\n", p);
+			ret = match_int(args, &token);
+			if (ret)
 				goto out;
+			if (token < 1) {
+				pr_warn("bad channel count %s\n", p);
+				goto out_with_einval;
 			}
 			target->ch_count = token;
 			break;
@@ -3601,7 +3631,7 @@ static int srp_parse_options(struct net *net, const char *buf,
 		default:
 			pr_warn("unknown parameter or missing value '%s' in target creation request\n",
 				p);
-			goto out;
+			goto out_with_einval;
 		}
 	}
 
@@ -3623,6 +3653,10 @@ static int srp_parse_options(struct net *net, const char *buf,
 out:
 	kfree(options);
 	return ret;
+
+out_with_einval:
+	ret = -EINVAL;
+	goto out;
 }
 
 static ssize_t add_target_store(struct device *dev,
-- 
1.8.3.1

Re: [PATCH v3 1/2] RDMA/hfi1: Fix error return code in parse_platform_config()

[Leon Romanovsky]

On Sat, Nov 26, 2022 at 09:50:53PM +0800, Wang Yufen wrote:
> In the previous while loop, "ret" may be assigned zero, so the error
> return code may be incorrectly set to 0 instead of -EINVAL.
> Add bail_with_einval goto label and covert all "goto bail;" to "goto
> bail_with_einval:" where it's appropriate. Add dropping some duplicative
> "ret = -EINVAL;" lines, as Andy suggessted.
> 
> Fixes: 97167e813415 ("staging/rdma/hfi1: Tune for unknown channel if configuration file is absent")
> Signed-off-by: Wang Yufen <wangyufen@huawei.com>
> Reviewed-by: Andy Shevchenko <andriy.shevchenko@linux.intel.com>
> ---
>  drivers/infiniband/hw/hfi1/firmware.c | 20 +++++++++++---------
>  1 file changed, 11 insertions(+), 9 deletions(-)

<...>


> +bail_with_einval:
> +	ret = -EINVAL;

Sorry for being late, but no. It can be seen as anti-pattern as it
causes to the situations where unrelated code changes can potentially
overwrite return value. Please set valid return code before calling to
goto.

Thanks

>  bail:
>  	memset(pcfgcache, 0, sizeof(struct platform_config_cache));
>  	return ret;
> -- 
> 1.8.3.1
> 

Re: [PATCH v3 2/2] RDMA/srp: Fix error return code in srp_parse_options()

[Leon Romanovsky]

On Sat, Nov 26, 2022 at 09:50:54PM +0800, Wang Yufen wrote:
> In the previous while loop, "ret" may be assigned zero, , so the error
> return code may be incorrectly set to 0 instead of -EINVAL.
> Add out_with_einval goto label and covert all "goto out;" to "goto
> out_with_einval:" where it's appropriate, alse investigate each case
> separately as Andy suggessted.
> 
> Fixes: e711f968c49c ("IB/srp: replace custom implementation of hex2bin()")
> Fixes: 2a174df0c602 ("IB/srp: Use kstrtoull() instead of simple_strtoull()")
> Fixes: 19f313438c77 ("IB/srp: Add RDMA/CM support")
> Signed-off-by: Wang Yufen <wangyufen@huawei.com>
> ---
>  drivers/infiniband/ulp/srp/ib_srp.c | 86 ++++++++++++++++++++++++++-----------
>  1 file changed, 60 insertions(+), 26 deletions(-)

<...>

> @@ -3623,6 +3653,10 @@ static int srp_parse_options(struct net *net, const char *buf,
>  out:
>  	kfree(options);
>  	return ret;
> +
> +out_with_einval:

It needs to be changed back.

Thanks

> +	ret = -EINVAL;
> +	goto out;
>  }
>  
>  static ssize_t add_target_store(struct device *dev,
> -- 
> 1.8.3.1
> 

Re: [PATCH v3 1/2] RDMA/hfi1: Fix error return code in parse_platform_config()

[wangyufen]

在 2022/11/28 19:57, Leon Romanovsky 写道:
> On Sat, Nov 26, 2022 at 09:50:53PM +0800, Wang Yufen wrote:
>> In the previous while loop, "ret" may be assigned zero, so the error
>> return code may be incorrectly set to 0 instead of -EINVAL.
>> Add bail_with_einval goto label and covert all "goto bail;" to "goto
>> bail_with_einval:" where it's appropriate. Add dropping some duplicative
>> "ret = -EINVAL;" lines, as Andy suggessted.
>>
>> Fixes: 97167e813415 ("staging/rdma/hfi1: Tune for unknown channel if configuration file is absent")
>> Signed-off-by: Wang Yufen <wangyufen@huawei.com>
>> Reviewed-by: Andy Shevchenko <andriy.shevchenko@linux.intel.com>
>> ---
>>   drivers/infiniband/hw/hfi1/firmware.c | 20 +++++++++++---------
>>   1 file changed, 11 insertions(+), 9 deletions(-)
> 
> <...>
> 
> 
>> +bail_with_einval:
>> +	ret = -EINVAL;
> 
> Sorry for being late, but no. It can be seen as anti-pattern as it
> causes to the situations where unrelated code changes can potentially
> overwrite return value. Please set valid return code before calling to
> goto.

OK, will change in v4.
Thanks
> 
> Thanks
> 
>>   bail:
>>   	memset(pcfgcache, 0, sizeof(struct platform_config_cache));
>>   	return ret;
>> -- 
>> 1.8.3.1
>>