diff mbox series

[v1] net/handshake: Fix handshake_req_destroy_test1

Message ID 170724699027.91401.7839730697326806733.stgit@oracle-102.nfsv4bat.org (mailing list archive)
State Accepted
Commit 4e1d71cabb19ec2586827adfc60d68689c68c194
Delegated to: Netdev Maintainers
Headers show
Series [v1] net/handshake: Fix handshake_req_destroy_test1 | expand

Checks

Context Check Description
netdev/series_format warning Single patches do not need cover letters; Target tree name not specified in the subject
netdev/tree_selection success Guessed tree name to be net-next
netdev/ynl success Generated files up to date; no warnings/errors; no diff in generated;
netdev/fixes_present success Fixes tag not required for -next series
netdev/header_inline success No static functions without inline keyword in header files
netdev/build_32bit success Errors and warnings before: 1048 this patch: 1048
netdev/build_tools success No tools touched, skip
netdev/cc_maintainers fail 1 blamed authors not CCed: ruanjinjie@huawei.com; 4 maintainers not CCed: pabeni@redhat.com kuba@kernel.org ruanjinjie@huawei.com edumazet@google.com
netdev/build_clang success Errors and warnings before: 1065 this patch: 1065
netdev/verify_signedoff success Signed-off-by tag matches author and committer
netdev/deprecated_api success None detected
netdev/check_selftest success No net selftest shell script
netdev/verify_fixes success Fixes tag looks correct
netdev/build_allmodconfig_warn success Errors and warnings before: 1065 this patch: 1065
netdev/checkpatch success total: 0 errors, 0 warnings, 0 checks, 11 lines checked
netdev/build_clang_rust success No Rust files in patch. Skipping build
netdev/kdoc success Errors and warnings before: 0 this patch: 0
netdev/source_inline success Was 0 now: 0
netdev/contest success net-next-2024-02-09--00-00 (tests: 687)

Commit Message

Chuck Lever Feb. 6, 2024, 7:16 p.m. UTC
From: Chuck Lever <chuck.lever@oracle.com>

Recently, handshake_req_destroy_test1 started failing:

Expected handshake_req_destroy_test == req, but
    handshake_req_destroy_test == 0000000000000000
    req == 0000000060f99b40
not ok 11 req_destroy works

This is because "sock_release(sock)" was replaced with "fput(filp)"
to address a memory leak. Note that sock_release() is synchronous
but fput() usually delays the final close and clean-up.

The delay is not consequential in the other cases that were changed
but handshake_req_destroy_test1 is testing that handshake_req_cancel()
followed by closing the file actually does call the ->hp_destroy
method. Thus the PTR_EQ test at the end has to be sure that the
final close is complete before it checks the pointer.

We cannot use a completion here because if ->hp_destroy is never
called (ie, there is an API bug) then the test will hang.

Reported by: Guenter Roeck <linux@roeck-us.net>
Closes: https://lore.kernel.org/netdev/ZcKDd1to4MPANCrn@tissot.1015granger.net/T/#mac5c6299f86799f1c71776f3a07f9c566c7c3c40
Fixes: 4a0f07d71b04 ("net/handshake: Fix memory leak in __sock_create() and sock_alloc_file()")
Signed-off-by: Chuck Lever <chuck.lever@oracle.com>
---
 net/handshake/handshake-test.c |    5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)

Comments

Hannes Reinecke Feb. 7, 2024, 1:21 a.m. UTC | #1
On 2/7/24 03:16, Chuck Lever wrote:
> From: Chuck Lever <chuck.lever@oracle.com>
> 
> Recently, handshake_req_destroy_test1 started failing:
> 
> Expected handshake_req_destroy_test == req, but
>      handshake_req_destroy_test == 0000000000000000
>      req == 0000000060f99b40
> not ok 11 req_destroy works
> 
> This is because "sock_release(sock)" was replaced with "fput(filp)"
> to address a memory leak. Note that sock_release() is synchronous
> but fput() usually delays the final close and clean-up.
> 
> The delay is not consequential in the other cases that were changed
> but handshake_req_destroy_test1 is testing that handshake_req_cancel()
> followed by closing the file actually does call the ->hp_destroy
> method. Thus the PTR_EQ test at the end has to be sure that the
> final close is complete before it checks the pointer.
> 
> We cannot use a completion here because if ->hp_destroy is never
> called (ie, there is an API bug) then the test will hang.
> 
> Reported by: Guenter Roeck <linux@roeck-us.net>
> Closes: https://lore.kernel.org/netdev/ZcKDd1to4MPANCrn@tissot.1015granger.net/T/#mac5c6299f86799f1c71776f3a07f9c566c7c3c40
> Fixes: 4a0f07d71b04 ("net/handshake: Fix memory leak in __sock_create() and sock_alloc_file()")
> Signed-off-by: Chuck Lever <chuck.lever@oracle.com>
> ---
>   net/handshake/handshake-test.c |    5 ++++-
>   1 file changed, 4 insertions(+), 1 deletion(-)
> 
> diff --git a/net/handshake/handshake-test.c b/net/handshake/handshake-test.c
> index 16ed7bfd29e4..34fd1d9b2db8 100644
> --- a/net/handshake/handshake-test.c
> +++ b/net/handshake/handshake-test.c
> @@ -471,7 +471,10 @@ static void handshake_req_destroy_test1(struct kunit *test)
>   	handshake_req_cancel(sock->sk);
>   
>   	/* Act */
> -	fput(filp);
> +	/* Ensure the close/release/put process has run to
> +	 * completion before checking the result.
> +	 */
> +	__fput_sync(filp);
>   
>   	/* Assert */
>   	KUNIT_EXPECT_PTR_EQ(test, handshake_req_destroy_test, req);
> 
> 
> 
Reviewed-by: Hannes Reinecke <hare@suse.de>

Cheers,

Hannes
patchwork-bot+netdevbpf@kernel.org Feb. 9, 2024, 2:50 a.m. UTC | #2
Hello:

This patch was applied to netdev/net.git (main)
by Jakub Kicinski <kuba@kernel.org>:

On Tue, 06 Feb 2024 14:16:31 -0500 you wrote:
> From: Chuck Lever <chuck.lever@oracle.com>
> 
> Recently, handshake_req_destroy_test1 started failing:
> 
> Expected handshake_req_destroy_test == req, but
>     handshake_req_destroy_test == 0000000000000000
>     req == 0000000060f99b40
> not ok 11 req_destroy works
> 
> [...]

Here is the summary with links:
  - [v1] net/handshake: Fix handshake_req_destroy_test1
    https://git.kernel.org/netdev/net/c/4e1d71cabb19

You are awesome, thank you!
diff mbox series

Patch

diff --git a/net/handshake/handshake-test.c b/net/handshake/handshake-test.c
index 16ed7bfd29e4..34fd1d9b2db8 100644
--- a/net/handshake/handshake-test.c
+++ b/net/handshake/handshake-test.c
@@ -471,7 +471,10 @@  static void handshake_req_destroy_test1(struct kunit *test)
 	handshake_req_cancel(sock->sk);
 
 	/* Act */
-	fput(filp);
+	/* Ensure the close/release/put process has run to
+	 * completion before checking the result.
+	 */
+	__fput_sync(filp);
 
 	/* Assert */
 	KUNIT_EXPECT_PTR_EQ(test, handshake_req_destroy_test, req);