Re: [ndctl PATCH v2 2/2] namespace: Close fd before return in do_xaction_namespace()

From: Zhiqiang Liu <liuzhiqiang26@huawei.com>
To: <vishal.l.verma@intel.com>
Cc: <nvdimm@lists.linux.dev>, linfeilong <linfeilong@huawei.com>,
	<lixiaokeng@huawei.com>,
	Alison Schofield <alison.schofield@intel.com>,
	<liuzhiqiang26@huawei.com>
Subject: Re: [ndctl PATCH v2 2/2] namespace: Close fd before return in do_xaction_namespace()
Date: Sat, 31 Jul 2021 16:31:44 +0800	[thread overview]
Message-ID: <529413c2-6f7f-ddcc-b82f-bf69166f65d0@huawei.com> (raw)
In-Reply-To: <a10193c0-e56b-8bf1-7ce4-d0c0f7bdc35b@huawei.com>

friendly ping...

On 2021/7/6 12:33, Zhiqiang Liu wrote:
> Recently, we use Coverity to analysis the ndctl package,
> one issue in do_xaction_namespace() is reported as follows,
> 	CID 11690564: (RESOURCE_LEAK)
> 	2058. leaked_storage: Variable "ri_ctx" going out of scope
> 	      leaks the storage "ri_ctx.f_out" points to.
>
> In do_xaction_namespace(), ri_ctx.f_out should be closed after
> being opened. This prevents a potential file descriptor leak
> in do_xaction_namespace().
>
> Signed-off-by: Zhiqiang Liu <liuzhiqiang26@huawei.com>
> ---
> v1->v2: add coverity report info as suggested by Alison
>
>  ndctl/namespace.c | 17 +++++++++--------
>  1 file changed, 9 insertions(+), 8 deletions(-)
>
> diff --git a/ndctl/namespace.c b/ndctl/namespace.c
> index 21089d7..55364ac 100644
> --- a/ndctl/namespace.c
> +++ b/ndctl/namespace.c
> @@ -2141,7 +2141,7 @@ static int do_xaction_namespace(const char *namespace,
>  				util_display_json_array(ri_ctx.f_out, ri_ctx.jblocks, 0);
>  			if (rc >= 0)
>  				(*processed)++;
> -			return rc;
> +			goto out;
>  		}
>  	}
>
> @@ -2152,11 +2152,11 @@ static int do_xaction_namespace(const char *namespace,
>  		rc = file_write_infoblock(param.outfile);
>  		if (rc >= 0)
>  			(*processed)++;
> -		return rc;
> +		goto out;
>  	}
>
>  	if (!namespace && action != ACTION_CREATE)
> -		return rc;
> +		goto out;
>
>  	if (verbose)
>  		ndctl_set_log_priority(ctx, LOG_DEBUG);
> @@ -2212,7 +2212,7 @@ static int do_xaction_namespace(const char *namespace,
>  						saved_rc = rc;
>  						continue;
>  				}
> -				return rc;
> +				goto out;
>  			}
>  			ndctl_namespace_foreach_safe(region, ndns, _n) {
>  				ndns_name = ndctl_namespace_get_devname(ndns);
> @@ -2259,7 +2259,7 @@ static int do_xaction_namespace(const char *namespace,
>  					rc = namespace_reconfig(region, ndns);
>  					if (rc == 0)
>  						*processed = 1;
> -					return rc;
> +					goto out;
>  				case ACTION_READ_INFOBLOCK:
>  					rc = namespace_rw_infoblock(ndns, &ri_ctx, READ);
>  					if (rc == 0)
> @@ -2281,9 +2281,6 @@ static int do_xaction_namespace(const char *namespace,
>  	if (ri_ctx.jblocks)
>  		util_display_json_array(ri_ctx.f_out, ri_ctx.jblocks, 0);
>
> -	if (ri_ctx.f_out && ri_ctx.f_out != stdout)
> -		fclose(ri_ctx.f_out);
> -
>  	if (action == ACTION_CREATE && rc == -EAGAIN) {
>  		/*
>  		 * Namespace creation searched through all candidate
> @@ -2301,6 +2298,10 @@ static int do_xaction_namespace(const char *namespace,
>  	if (saved_rc)
>  		rc = saved_rc;
>
> +out:
> +	if (ri_ctx.f_out && ri_ctx.f_out != stdout)
> +		fclose(ri_ctx.f_out);
> +
>  	return rc;
>  }
>