diff mbox series

[net,v2,1/2] af_unix: Fix garbage collection of embryos carrying OOB with SCM_RIGHTS

Message ID 20240516145457.1206847-2-mhal@rbox.co (mailing list archive)
State Superseded
Delegated to: Netdev Maintainers
Headers show
Series af_unix: Fix GC and improve selftest | expand

Checks

Context Check Description
netdev/series_format success Posting correctly formatted
netdev/tree_selection success Clearly marked for net
netdev/ynl success Generated files up to date; no warnings/errors; no diff in generated;
netdev/fixes_present success Fixes tag present in non-next series
netdev/header_inline success No static functions without inline keyword in header files
netdev/build_32bit success Errors and warnings before: 922 this patch: 922
netdev/build_tools success No tools touched, skip
netdev/cc_maintainers success CCed 5 of 5 maintainers
netdev/build_clang success Errors and warnings before: 925 this patch: 925
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: 927 this patch: 927
netdev/checkpatch warning WARNING: line length of 81 exceeds 80 columns
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

Commit Message

Michal Luczaj May 16, 2024, 2:50 p.m. UTC
GC attempts to explicitly drop oob_skb before purging the hit list.

The problem is with embryos: kfree_skb(u->oob_skb) is never called on an
embryo socket, as those sockets are not directly stacked by the SCC walk.

The python script below [0] sends a listener's fd to its embryo as OOB
data.  While GC does collect the embryo's queue, it fails to drop the OOB
skb's refcount.  The skb which was in embryo's receive queue stays as
unix_sk(sk)->oob_skb and keeps the listener's refcount [1].

Tell GC to dispose embryo's oob_skb.

[0]:
from array import array
from socket import *

addr = '\x00unix-oob'
lis = socket(AF_UNIX, SOCK_STREAM)
lis.bind(addr)
lis.listen(1)

s = socket(AF_UNIX, SOCK_STREAM)
s.connect(addr)
scm = (SOL_SOCKET, SCM_RIGHTS, array('i', [lis.fileno()]))
s.sendmsg([b'x'], [scm], MSG_OOB)
lis.close()

[1]
$ grep unix-oob /proc/net/unix
$ ./unix-oob.py
$ grep unix-oob /proc/net/unix
0000000000000000: 00000002 00000000 00000000 0001 02     0 @unix-oob
0000000000000000: 00000002 00000000 00010000 0001 01  6072 @unix-oob

Fixes: 4090fa373f0e ("af_unix: Replace garbage collection algorithm.")
Signed-off-by: Michal Luczaj <mhal@rbox.co>
---
 net/unix/garbage.c | 23 ++++++++++++++---------
 1 file changed, 14 insertions(+), 9 deletions(-)

Comments

Kuniyuki Iwashima May 17, 2024, 1:45 a.m. UTC | #1
From: Michal Luczaj <mhal@rbox.co>
Date: Thu, 16 May 2024 16:50:09 +0200
> GC attempts to explicitly drop oob_skb before purging the hit list.

Sorry for not catching these in v1,

nit: s/oob_skb/oob_skb's reference/

> 
> The problem is with embryos: kfree_skb(u->oob_skb) is never called on an
> embryo socket, as those sockets are not directly stacked by the SCC walk.

", as ..." is not correct and can be just removed.  Here we walk
through embryos as written in the next paragraph but we forget
dropping oob_skb's refcnt.

> 
> The python script below [0] sends a listener's fd to its embryo as OOB
> data.  While GC does collect the embryo's queue, it fails to drop the OOB
> skb's refcount.  The skb which was in embryo's receive queue stays as
> unix_sk(sk)->oob_skb and keeps the listener's refcount [1].
> 
> Tell GC to dispose embryo's oob_skb.
> 
> [0]:
> from array import array
> from socket import *
> 
> addr = '\x00unix-oob'
> lis = socket(AF_UNIX, SOCK_STREAM)
> lis.bind(addr)
> lis.listen(1)
> 
> s = socket(AF_UNIX, SOCK_STREAM)
> s.connect(addr)
> scm = (SOL_SOCKET, SCM_RIGHTS, array('i', [lis.fileno()]))
> s.sendmsg([b'x'], [scm], MSG_OOB)
> lis.close()
> 
> [1]
> $ grep unix-oob /proc/net/unix
> $ ./unix-oob.py
> $ grep unix-oob /proc/net/unix
> 0000000000000000: 00000002 00000000 00000000 0001 02     0 @unix-oob
> 0000000000000000: 00000002 00000000 00010000 0001 01  6072 @unix-oob
> 
> Fixes: 4090fa373f0e ("af_unix: Replace garbage collection algorithm.")
> Signed-off-by: Michal Luczaj <mhal@rbox.co>

with the above corrected, you can add

Reviewed-by: Kuniyuki Iwashima <kuniyu@amazon.com>

Thanks!


> ---
>  net/unix/garbage.c | 23 ++++++++++++++---------
>  1 file changed, 14 insertions(+), 9 deletions(-)
> 
> diff --git a/net/unix/garbage.c b/net/unix/garbage.c
> index 1f8b8cdfcdc8..dfe94a90ece4 100644
> --- a/net/unix/garbage.c
> +++ b/net/unix/garbage.c
> @@ -342,6 +342,18 @@ enum unix_recv_queue_lock_class {
>  	U_RECVQ_LOCK_EMBRYO,
>  };
>  
> +static void unix_collect_queue(struct unix_sock *u, struct sk_buff_head *hitlist)
> +{
> +	skb_queue_splice_init(&u->sk.sk_receive_queue, hitlist);
> +
> +#if IS_ENABLED(CONFIG_AF_UNIX_OOB)
> +	if (u->oob_skb) {
> +		WARN_ON_ONCE(skb_unref(u->oob_skb));
> +		u->oob_skb = NULL;
> +	}
> +#endif
> +}
> +
>  static void unix_collect_skb(struct list_head *scc, struct sk_buff_head *hitlist)
>  {
>  	struct unix_vertex *vertex;
> @@ -365,18 +377,11 @@ static void unix_collect_skb(struct list_head *scc, struct sk_buff_head *hitlist
>  
>  				/* listener -> embryo order, the inversion never happens. */
>  				spin_lock_nested(&embryo_queue->lock, U_RECVQ_LOCK_EMBRYO);
> -				skb_queue_splice_init(embryo_queue, hitlist);
> +				unix_collect_queue(unix_sk(skb->sk), hitlist);
>  				spin_unlock(&embryo_queue->lock);
>  			}
>  		} else {
> -			skb_queue_splice_init(queue, hitlist);
> -
> -#if IS_ENABLED(CONFIG_AF_UNIX_OOB)
> -			if (u->oob_skb) {
> -				kfree_skb(u->oob_skb);
> -				u->oob_skb = NULL;
> -			}
> -#endif
> +			unix_collect_queue(u, hitlist);
>  		}
>  
>  		spin_unlock(&queue->lock);
> -- 
> 2.45.0
>
Michal Luczaj May 17, 2024, 5:59 a.m. UTC | #2
On 5/17/24 03:45, Kuniyuki Iwashima wrote:
> From: Michal Luczaj <mhal@rbox.co>
> Date: Thu, 16 May 2024 16:50:09 +0200
>> GC attempts to explicitly drop oob_skb before purging the hit list.
> 
> Sorry for not catching these in v1,
> 
> nit: s/oob_skb/oob_skb's reference/

Argh, sorry, I've copy-pasted my own misformulation.

>> The problem is with embryos: kfree_skb(u->oob_skb) is never called on an
>> embryo socket, as those sockets are not directly stacked by the SCC walk.
> 
> ", as ..." is not correct and can be just removed.  Here we walk
> through embryos as written in the next paragraph but we forget
> dropping oob_skb's refcnt.

Oh, I agree we walk through embryos. I wrote that embryos are not _stacked_
by the SCC walk, i.e. embryos don't appear on the `vertex_stack`. But I
think you're right, such comment of mine would be incorrect anyway. So,
removing and resending.

>> The python script below [0] sends a listener's fd to its embryo as OOB
>> data.  While GC does collect the embryo's queue, it fails to drop the OOB
>> skb's refcount.  The skb which was in embryo's receive queue stays as
>> unix_sk(sk)->oob_skb and keeps the listener's refcount [1].
>>
>> Tell GC to dispose embryo's oob_skb.
>>
>> [0]:
>> from array import array
>> from socket import *
>>
>> addr = '\x00unix-oob'
>> lis = socket(AF_UNIX, SOCK_STREAM)
>> lis.bind(addr)
>> lis.listen(1)
>>
>> s = socket(AF_UNIX, SOCK_STREAM)
>> s.connect(addr)
>> scm = (SOL_SOCKET, SCM_RIGHTS, array('i', [lis.fileno()]))
>> s.sendmsg([b'x'], [scm], MSG_OOB)
>> lis.close()
>>
>> [1]
>> $ grep unix-oob /proc/net/unix
>> $ ./unix-oob.py
>> $ grep unix-oob /proc/net/unix
>> 0000000000000000: 00000002 00000000 00000000 0001 02     0 @unix-oob
>> 0000000000000000: 00000002 00000000 00010000 0001 01  6072 @unix-oob
>>
>> Fixes: 4090fa373f0e ("af_unix: Replace garbage collection algorithm.")
>> Signed-off-by: Michal Luczaj <mhal@rbox.co>
> 
> with the above corrected, you can add
> 
> Reviewed-by: Kuniyuki Iwashima <kuniyu@amazon.com>
> 
> Thanks!

All right, thank you.

One question: git send-email automatically adds my Signed-off-by to your
patch (patch 2/2 in this series). Should I leave it that way?

>> ...
Kuniyuki Iwashima May 17, 2024, 7:47 a.m. UTC | #3
From: Michal Luczaj <mhal@rbox.co>
Date: Fri, 17 May 2024 07:59:16 +0200
> One question: git send-email automatically adds my Signed-off-by to your
> patch (patch 2/2 in this series). Should I leave it that way?

SOB is usually added by someone who changed the diff or merged it.

I think it would be better not to add it if not intended.  At least
on my laptop, it does not add SOB automatically.

FWIW, my command is like

  git send-email --annotate --cover-letter --thread --no-chain-reply-to \
  --subject-prefix "PATCH v1 net-next" \
  --to "" \
  --cc "" \
  --cc netdev@vger.kernel.org \
  --batch-size 1 --relogin-delay 15 --dry-run HEAD~10

Thanks!
Michal Luczaj May 17, 2024, 8:55 a.m. UTC | #4
On 5/17/24 09:47, Kuniyuki Iwashima wrote:
> From: Michal Luczaj <mhal@rbox.co>
> Date: Fri, 17 May 2024 07:59:16 +0200
>> One question: git send-email automatically adds my Signed-off-by to your
>> patch (patch 2/2 in this series). Should I leave it that way?
> 
> SOB is usually added by someone who changed the diff or merged it.
> 
> I think it would be better not to add it if not intended.  At least
> on my laptop, it does not add SOB automatically.

Sure, I understand. And the problem was that I had format.signOff = true in
.gitconfig. Fixed.

> FWIW, my command is like
> 
>   git send-email --annotate --cover-letter --thread --no-chain-reply-to \
>   --subject-prefix "PATCH v1 net-next" \

maintainer-netdev.rst shows an example with a slightly different order:
"[PATCH net-next v3]". But I guess it doesn't matter?

>   --to "" \
>   --cc "" \
>   --cc netdev@vger.kernel.org \
>   --batch-size 1 --relogin-delay 15 --dry-run HEAD~10
> 
> Thanks!
Kuniyuki Iwashima May 17, 2024, 9:22 a.m. UTC | #5
From: Michal Luczaj <mhal@rbox.co>
Date: Fri, 17 May 2024 10:55:53 +0200
> On 5/17/24 09:47, Kuniyuki Iwashima wrote:
> > From: Michal Luczaj <mhal@rbox.co>
> > Date: Fri, 17 May 2024 07:59:16 +0200
> >> One question: git send-email automatically adds my Signed-off-by to your
> >> patch (patch 2/2 in this series). Should I leave it that way?
> > 
> > SOB is usually added by someone who changed the diff or merged it.
> > 
> > I think it would be better not to add it if not intended.  At least
> > on my laptop, it does not add SOB automatically.
> 
> Sure, I understand. And the problem was that I had format.signOff = true in
> .gitconfig. Fixed.
> 
> > FWIW, my command is like
> > 
> >   git send-email --annotate --cover-letter --thread --no-chain-reply-to \
> >   --subject-prefix "PATCH v1 net-next" \
> 
> maintainer-netdev.rst shows an example with a slightly different order:
> "[PATCH net-next v3]". But I guess it doesn't matter?

It seems patchwork can parse either format. ("net,vX" and "vX,net")

https://patchwork.kernel.org/project/netdevbpf/list/
Michal Luczaj May 17, 2024, 9:58 a.m. UTC | #6
On 5/17/24 11:22, Kuniyuki Iwashima wrote:
> From: Michal Luczaj <mhal@rbox.co>
> Date: Fri, 17 May 2024 10:55:53 +0200
>> On 5/17/24 09:47, Kuniyuki Iwashima wrote:
>>> From: Michal Luczaj <mhal@rbox.co>
>>> Date: Fri, 17 May 2024 07:59:16 +0200
>>>> One question: git send-email automatically adds my Signed-off-by to your
>>>> patch (patch 2/2 in this series). Should I leave it that way?
>>>
>>> SOB is usually added by someone who changed the diff or merged it.
>>>
>>> I think it would be better not to add it if not intended.  At least
>>> on my laptop, it does not add SOB automatically.
>>
>> Sure, I understand. And the problem was that I had format.signOff = true in
>> .gitconfig. Fixed.
>>
>>> FWIW, my command is like
>>>
>>>   git send-email --annotate --cover-letter --thread --no-chain-reply-to \
>>>   --subject-prefix "PATCH v1 net-next" \
>>
>> maintainer-netdev.rst shows an example with a slightly different order:
>> "[PATCH net-next v3]". But I guess it doesn't matter?
> 
> It seems patchwork can parse either format. ("net,vX" and "vX,net")
> 
> https://patchwork.kernel.org/project/netdevbpf/list/

OK, v3 sent:
https://lore.kernel.org/netdev/20240517093138.1436323-1-mhal@rbox.co/

Thanks for help and review,
Michal
Jakub Kicinski May 17, 2024, 7:24 p.m. UTC | #7
On Fri, 17 May 2024 16:47:42 +0900 Kuniyuki Iwashima wrote:
> From: Michal Luczaj <mhal@rbox.co>
> Date: Fri, 17 May 2024 07:59:16 +0200
> > One question: git send-email automatically adds my Signed-off-by to your
> > patch (patch 2/2 in this series). Should I leave it that way?  
> 
> SOB is usually added by someone who changed the diff or merged it.
> 
> I think it would be better not to add it if not intended. 

My understanding is that Michal should indeed add his SOB, as he is 
the one submitting the patch now, and from the "certificate of origin"
we need his assurance that the code is indeed released under the
appropriate license.

If you could reply to your own posting with the SoB, Michal, that'd be
enough.
Michal Luczaj May 19, 2024, 8:47 a.m. UTC | #8
On 5/17/24 21:24, Jakub Kicinski wrote:
> On Fri, 17 May 2024 16:47:42 +0900 Kuniyuki Iwashima wrote:
>> From: Michal Luczaj <mhal@rbox.co>
>> Date: Fri, 17 May 2024 07:59:16 +0200
>>> One question: git send-email automatically adds my Signed-off-by to your
>>> patch (patch 2/2 in this series). Should I leave it that way?  
>>
>> SOB is usually added by someone who changed the diff or merged it.
>>
>> I think it would be better not to add it if not intended. 
> 
> My understanding is that Michal should indeed add his SOB, as he is 
> the one submitting the patch now, and from the "certificate of origin"
> we need his assurance that the code is indeed released under the
> appropriate license.
> 
> If you could reply to your own posting with the SoB, Michal, that'd be
> enough.

And there it is:
https://lore.kernel.org/netdev/71ceafc1-269c-44e0-80f0-6f16a1f35f0b@rbox.co/

Thanks,
Michal
diff mbox series

Patch

diff --git a/net/unix/garbage.c b/net/unix/garbage.c
index 1f8b8cdfcdc8..dfe94a90ece4 100644
--- a/net/unix/garbage.c
+++ b/net/unix/garbage.c
@@ -342,6 +342,18 @@  enum unix_recv_queue_lock_class {
 	U_RECVQ_LOCK_EMBRYO,
 };
 
+static void unix_collect_queue(struct unix_sock *u, struct sk_buff_head *hitlist)
+{
+	skb_queue_splice_init(&u->sk.sk_receive_queue, hitlist);
+
+#if IS_ENABLED(CONFIG_AF_UNIX_OOB)
+	if (u->oob_skb) {
+		WARN_ON_ONCE(skb_unref(u->oob_skb));
+		u->oob_skb = NULL;
+	}
+#endif
+}
+
 static void unix_collect_skb(struct list_head *scc, struct sk_buff_head *hitlist)
 {
 	struct unix_vertex *vertex;
@@ -365,18 +377,11 @@  static void unix_collect_skb(struct list_head *scc, struct sk_buff_head *hitlist
 
 				/* listener -> embryo order, the inversion never happens. */
 				spin_lock_nested(&embryo_queue->lock, U_RECVQ_LOCK_EMBRYO);
-				skb_queue_splice_init(embryo_queue, hitlist);
+				unix_collect_queue(unix_sk(skb->sk), hitlist);
 				spin_unlock(&embryo_queue->lock);
 			}
 		} else {
-			skb_queue_splice_init(queue, hitlist);
-
-#if IS_ENABLED(CONFIG_AF_UNIX_OOB)
-			if (u->oob_skb) {
-				kfree_skb(u->oob_skb);
-				u->oob_skb = NULL;
-			}
-#endif
+			unix_collect_queue(u, hitlist);
 		}
 
 		spin_unlock(&queue->lock);