License cleanup: add SPDX GPL-2.0 license identifier to files with no license
Many source files in the tree are missing licensing information, which
makes it harder for compliance tools to determine the correct license.
By default all files without license information are under the default
license of the kernel, which is GPL version 2.
Update the files which contain no license information with the 'GPL-2.0'
SPDX license identifier. The SPDX identifier is a legally binding
shorthand, which can be used instead of the full boiler plate text.
This patch is based on work done by Thomas Gleixner and Kate Stewart and
Philippe Ombredanne.
How this work was done:
Patches were generated and checked against linux-4.14-rc6 for a subset of
the use cases:
- file had no licensing information it it.
- file was a */uapi/* one with no licensing information in it,
- file was a */uapi/* one with existing licensing information,
Further patches will be generated in subsequent months to fix up cases
where non-standard license headers were used, and references to license
had to be inferred by heuristics based on keywords.
The analysis to determine which SPDX License Identifier to be applied to
a file was done in a spreadsheet of side by side results from of the
output of two independent scanners (ScanCode & Windriver) producing SPDX
tag:value files created by Philippe Ombredanne. Philippe prepared the
base worksheet, and did an initial spot review of a few 1000 files.
The 4.13 kernel was the starting point of the analysis with 60,537 files
assessed. Kate Stewart did a file by file comparison of the scanner
results in the spreadsheet to determine which SPDX license identifier(s)
to be applied to the file. She confirmed any determination that was not
immediately clear with lawyers working with the Linux Foundation.
Criteria used to select files for SPDX license identifier tagging was:
- Files considered eligible had to be source code files.
- Make and config files were included as candidates if they contained >5
lines of source
- File already had some variant of a license header in it (even if <5
lines).
All documentation files were explicitly excluded.
The following heuristics were used to determine which SPDX license
identifiers to apply.
- when both scanners couldn't find any license traces, file was
considered to have no license information in it, and the top level
COPYING file license applied.
For non */uapi/* files that summary was:
SPDX license identifier # files
---------------------------------------------------|-------
GPL-2.0 11139
and resulted in the first patch in this series.
If that file was a */uapi/* path one, it was "GPL-2.0 WITH
Linux-syscall-note" otherwise it was "GPL-2.0". Results of that was:
SPDX license identifier # files
---------------------------------------------------|-------
GPL-2.0 WITH Linux-syscall-note 930
and resulted in the second patch in this series.
- if a file had some form of licensing information in it, and was one
of the */uapi/* ones, it was denoted with the Linux-syscall-note if
any GPL family license was found in the file or had no licensing in
it (per prior point). Results summary:
SPDX license identifier # files
---------------------------------------------------|------
GPL-2.0 WITH Linux-syscall-note 270
GPL-2.0+ WITH Linux-syscall-note 169
((GPL-2.0 WITH Linux-syscall-note) OR BSD-2-Clause) 21
((GPL-2.0 WITH Linux-syscall-note) OR BSD-3-Clause) 17
LGPL-2.1+ WITH Linux-syscall-note 15
GPL-1.0+ WITH Linux-syscall-note 14
((GPL-2.0+ WITH Linux-syscall-note) OR BSD-3-Clause) 5
LGPL-2.0+ WITH Linux-syscall-note 4
LGPL-2.1 WITH Linux-syscall-note 3
((GPL-2.0 WITH Linux-syscall-note) OR MIT) 3
((GPL-2.0 WITH Linux-syscall-note) AND MIT) 1
and that resulted in the third patch in this series.
- when the two scanners agreed on the detected license(s), that became
the concluded license(s).
- when there was disagreement between the two scanners (one detected a
license but the other didn't, or they both detected different
licenses) a manual inspection of the file occurred.
- In most cases a manual inspection of the information in the file
resulted in a clear resolution of the license that should apply (and
which scanner probably needed to revisit its heuristics).
- When it was not immediately clear, the license identifier was
confirmed with lawyers working with the Linux Foundation.
- If there was any question as to the appropriate license identifier,
the file was flagged for further research and to be revisited later
in time.
In total, over 70 hours of logged manual review was done on the
spreadsheet to determine the SPDX license identifiers to apply to the
source files by Kate, Philippe, Thomas and, in some cases, confirmation
by lawyers working with the Linux Foundation.
Kate also obtained a third independent scan of the 4.13 code base from
FOSSology, and compared selected files where the other two scanners
disagreed against that SPDX file, to see if there was new insights. The
Windriver scanner is based on an older version of FOSSology in part, so
they are related.
Thomas did random spot checks in about 500 files from the spreadsheets
for the uapi headers and agreed with SPDX license identifier in the
files he inspected. For the non-uapi files Thomas did random spot checks
in about 15000 files.
In initial set of patches against 4.14-rc6, 3 files were found to have
copy/paste license identifier errors, and have been fixed to reflect the
correct identifier.
Additionally Philippe spent 10 hours this week doing a detailed manual
inspection and review of the 12,461 patched files from the initial patch
version early this week with:
- a full scancode scan run, collecting the matched texts, detected
license ids and scores
- reviewing anything where there was a license detected (about 500+
files) to ensure that the applied SPDX license was correct
- reviewing anything where there was no detection but the patch license
was not GPL-2.0 WITH Linux-syscall-note to ensure that the applied
SPDX license was correct
This produced a worksheet with 20 files needing minor correction. This
worksheet was then exported into 3 different .csv files for the
different types of files to be modified.
These .csv files were then reviewed by Greg. Thomas wrote a script to
parse the csv files and add the proper SPDX tag to the file, in the
format that the file expected. This script was further refined by Greg
based on the output to detect more types of files automatically and to
distinguish between header and source .c files (which need different
comment types.) Finally Greg ran the script using the .csv files to
generate the patches.
Reviewed-by: Kate Stewart <kstewart@linuxfoundation.org>
Reviewed-by: Philippe Ombredanne <pombredanne@nexb.com>
Reviewed-by: Thomas Gleixner <tglx@linutronix.de>
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
2017-11-01 22:07:57 +08:00
|
|
|
// SPDX-License-Identifier: GPL-2.0
|
2016-01-05 06:41:45 +08:00
|
|
|
/*
|
|
|
|
|
* To speed up listener socket lookup, create an array to store all sockets
|
|
|
|
|
* listening on the same port. This allows a decision to be made after finding
|
2016-01-05 06:41:47 +08:00
|
|
|
* the first socket. An optional BPF program can also be configured for
|
|
|
|
|
* selecting the socket index from the array of available sockets.
|
2016-01-05 06:41:45 +08:00
|
|
|
*/
|
|
|
|
|
|
|
|
|
|
#include <net/sock_reuseport.h>
|
2016-01-05 06:41:47 +08:00
|
|
|
#include <linux/bpf.h>
|
2018-08-08 16:01:22 +08:00
|
|
|
#include <linux/idr.h>
|
2018-08-08 16:01:26 +08:00
|
|
|
#include <linux/filter.h>
|
2016-01-05 06:41:45 +08:00
|
|
|
#include <linux/rcupdate.h>
|
|
|
|
|
|
|
|
|
|
#define INIT_SOCKS 128
|
|
|
|
|
|
2018-08-08 16:01:22 +08:00
|
|
|
DEFINE_SPINLOCK(reuseport_lock);
|
|
|
|
|
|
|
|
|
|
#define REUSEPORT_MIN_ID 1
|
|
|
|
|
static DEFINE_IDA(reuseport_ida);
|
|
|
|
|
|
|
|
|
|
int reuseport_get_id(struct sock_reuseport *reuse)
|
|
|
|
|
{
|
|
|
|
|
int id;
|
|
|
|
|
|
|
|
|
|
if (reuse->reuseport_id)
|
|
|
|
|
return reuse->reuseport_id;
|
|
|
|
|
|
|
|
|
|
id = ida_simple_get(&reuseport_ida, REUSEPORT_MIN_ID, 0,
|
|
|
|
|
/* Called under reuseport_lock */
|
|
|
|
|
GFP_ATOMIC);
|
|
|
|
|
if (id < 0)
|
|
|
|
|
return id;
|
|
|
|
|
|
|
|
|
|
reuse->reuseport_id = id;
|
|
|
|
|
|
|
|
|
|
return reuse->reuseport_id;
|
|
|
|
|
}
|
2016-01-05 06:41:45 +08:00
|
|
|
|
2017-04-03 06:18:23 +08:00
|
|
|
static struct sock_reuseport *__reuseport_alloc(unsigned int max_socks)
|
2016-01-05 06:41:45 +08:00
|
|
|
{
|
2017-04-03 06:18:23 +08:00
|
|
|
unsigned int size = sizeof(struct sock_reuseport) +
|
2016-01-05 06:41:45 +08:00
|
|
|
sizeof(struct sock *) * max_socks;
|
|
|
|
|
struct sock_reuseport *reuse = kzalloc(size, GFP_ATOMIC);
|
|
|
|
|
|
|
|
|
|
if (!reuse)
|
|
|
|
|
return NULL;
|
|
|
|
|
|
|
|
|
|
reuse->max_socks = max_socks;
|
|
|
|
|
|
2016-01-05 06:41:47 +08:00
|
|
|
RCU_INIT_POINTER(reuse->prog, NULL);
|
2016-01-05 06:41:45 +08:00
|
|
|
return reuse;
|
|
|
|
|
}
|
|
|
|
|
|
bpf: Introduce BPF_PROG_TYPE_SK_REUSEPORT
This patch adds a BPF_PROG_TYPE_SK_REUSEPORT which can select
a SO_REUSEPORT sk from a BPF_MAP_TYPE_REUSEPORT_ARRAY. Like other
non SK_FILTER/CGROUP_SKB program, it requires CAP_SYS_ADMIN.
BPF_PROG_TYPE_SK_REUSEPORT introduces "struct sk_reuseport_kern"
to store the bpf context instead of using the skb->cb[48].
At the SO_REUSEPORT sk lookup time, it is in the middle of transiting
from a lower layer (ipv4/ipv6) to a upper layer (udp/tcp). At this
point, it is not always clear where the bpf context can be appended
in the skb->cb[48] to avoid saving-and-restoring cb[]. Even putting
aside the difference between ipv4-vs-ipv6 and udp-vs-tcp. It is not
clear if the lower layer is only ipv4 and ipv6 in the future and
will it not touch the cb[] again before transiting to the upper
layer.
For example, in udp_gro_receive(), it uses the 48 byte NAPI_GRO_CB
instead of IP[6]CB and it may still modify the cb[] after calling
the udp[46]_lib_lookup_skb(). Because of the above reason, if
sk->cb is used for the bpf ctx, saving-and-restoring is needed
and likely the whole 48 bytes cb[] has to be saved and restored.
Instead of saving, setting and restoring the cb[], this patch opts
to create a new "struct sk_reuseport_kern" and setting the needed
values in there.
The new BPF_PROG_TYPE_SK_REUSEPORT and "struct sk_reuseport_(kern|md)"
will serve all ipv4/ipv6 + udp/tcp combinations. There is no protocol
specific usage at this point and it is also inline with the current
sock_reuseport.c implementation (i.e. no protocol specific requirement).
In "struct sk_reuseport_md", this patch exposes data/data_end/len
with semantic similar to other existing usages. Together
with "bpf_skb_load_bytes()" and "bpf_skb_load_bytes_relative()",
the bpf prog can peek anywhere in the skb. The "bind_inany" tells
the bpf prog that the reuseport group is bind-ed to a local
INANY address which cannot be learned from skb.
The new "bind_inany" is added to "struct sock_reuseport" which will be
used when running the new "BPF_PROG_TYPE_SK_REUSEPORT" bpf prog in order
to avoid repeating the "bind INANY" test on
"sk_v6_rcv_saddr/sk->sk_rcv_saddr" every time a bpf prog is run. It can
only be properly initialized when a "sk->sk_reuseport" enabled sk is
adding to a hashtable (i.e. during "reuseport_alloc()" and
"reuseport_add_sock()").
The new "sk_select_reuseport()" is the main helper that the
bpf prog will use to select a SO_REUSEPORT sk. It is the only function
that can use the new BPF_MAP_TYPE_REUSEPORT_ARRAY. As mentioned in
the earlier patch, the validity of a selected sk is checked in
run time in "sk_select_reuseport()". Doing the check in
verification time is difficult and inflexible (consider the map-in-map
use case). The runtime check is to compare the selected sk's reuseport_id
with the reuseport_id that we want. This helper will return -EXXX if the
selected sk cannot serve the incoming request (e.g. reuseport_id
not match). The bpf prog can decide if it wants to do SK_DROP as its
discretion.
When the bpf prog returns SK_PASS, the kernel will check if a
valid sk has been selected (i.e. "reuse_kern->selected_sk != NULL").
If it does , it will use the selected sk. If not, the kernel
will select one from "reuse->socks[]" (as before this patch).
The SK_DROP and SK_PASS handling logic will be in the next patch.
Signed-off-by: Martin KaFai Lau <kafai@fb.com>
Acked-by: Alexei Starovoitov <ast@kernel.org>
Signed-off-by: Daniel Borkmann <daniel@iogearbox.net>
2018-08-08 16:01:25 +08:00
|
|
|
int reuseport_alloc(struct sock *sk, bool bind_inany)
|
2016-01-05 06:41:45 +08:00
|
|
|
{
|
|
|
|
|
struct sock_reuseport *reuse;
|
|
|
|
|
|
|
|
|
|
/* bh lock used since this function call may precede hlist lock in
|
|
|
|
|
* soft irq of receive path or setsockopt from process context
|
|
|
|
|
*/
|
|
|
|
|
spin_lock_bh(&reuseport_lock);
|
2017-10-20 03:00:29 +08:00
|
|
|
|
|
|
|
|
/* Allocation attempts can occur concurrently via the setsockopt path
|
|
|
|
|
* and the bind/hash path. Nothing to do when we lose the race.
|
|
|
|
|
*/
|
bpf: Introduce BPF_PROG_TYPE_SK_REUSEPORT
This patch adds a BPF_PROG_TYPE_SK_REUSEPORT which can select
a SO_REUSEPORT sk from a BPF_MAP_TYPE_REUSEPORT_ARRAY. Like other
non SK_FILTER/CGROUP_SKB program, it requires CAP_SYS_ADMIN.
BPF_PROG_TYPE_SK_REUSEPORT introduces "struct sk_reuseport_kern"
to store the bpf context instead of using the skb->cb[48].
At the SO_REUSEPORT sk lookup time, it is in the middle of transiting
from a lower layer (ipv4/ipv6) to a upper layer (udp/tcp). At this
point, it is not always clear where the bpf context can be appended
in the skb->cb[48] to avoid saving-and-restoring cb[]. Even putting
aside the difference between ipv4-vs-ipv6 and udp-vs-tcp. It is not
clear if the lower layer is only ipv4 and ipv6 in the future and
will it not touch the cb[] again before transiting to the upper
layer.
For example, in udp_gro_receive(), it uses the 48 byte NAPI_GRO_CB
instead of IP[6]CB and it may still modify the cb[] after calling
the udp[46]_lib_lookup_skb(). Because of the above reason, if
sk->cb is used for the bpf ctx, saving-and-restoring is needed
and likely the whole 48 bytes cb[] has to be saved and restored.
Instead of saving, setting and restoring the cb[], this patch opts
to create a new "struct sk_reuseport_kern" and setting the needed
values in there.
The new BPF_PROG_TYPE_SK_REUSEPORT and "struct sk_reuseport_(kern|md)"
will serve all ipv4/ipv6 + udp/tcp combinations. There is no protocol
specific usage at this point and it is also inline with the current
sock_reuseport.c implementation (i.e. no protocol specific requirement).
In "struct sk_reuseport_md", this patch exposes data/data_end/len
with semantic similar to other existing usages. Together
with "bpf_skb_load_bytes()" and "bpf_skb_load_bytes_relative()",
the bpf prog can peek anywhere in the skb. The "bind_inany" tells
the bpf prog that the reuseport group is bind-ed to a local
INANY address which cannot be learned from skb.
The new "bind_inany" is added to "struct sock_reuseport" which will be
used when running the new "BPF_PROG_TYPE_SK_REUSEPORT" bpf prog in order
to avoid repeating the "bind INANY" test on
"sk_v6_rcv_saddr/sk->sk_rcv_saddr" every time a bpf prog is run. It can
only be properly initialized when a "sk->sk_reuseport" enabled sk is
adding to a hashtable (i.e. during "reuseport_alloc()" and
"reuseport_add_sock()").
The new "sk_select_reuseport()" is the main helper that the
bpf prog will use to select a SO_REUSEPORT sk. It is the only function
that can use the new BPF_MAP_TYPE_REUSEPORT_ARRAY. As mentioned in
the earlier patch, the validity of a selected sk is checked in
run time in "sk_select_reuseport()". Doing the check in
verification time is difficult and inflexible (consider the map-in-map
use case). The runtime check is to compare the selected sk's reuseport_id
with the reuseport_id that we want. This helper will return -EXXX if the
selected sk cannot serve the incoming request (e.g. reuseport_id
not match). The bpf prog can decide if it wants to do SK_DROP as its
discretion.
When the bpf prog returns SK_PASS, the kernel will check if a
valid sk has been selected (i.e. "reuse_kern->selected_sk != NULL").
If it does , it will use the selected sk. If not, the kernel
will select one from "reuse->socks[]" (as before this patch).
The SK_DROP and SK_PASS handling logic will be in the next patch.
Signed-off-by: Martin KaFai Lau <kafai@fb.com>
Acked-by: Alexei Starovoitov <ast@kernel.org>
Signed-off-by: Daniel Borkmann <daniel@iogearbox.net>
2018-08-08 16:01:25 +08:00
|
|
|
reuse = rcu_dereference_protected(sk->sk_reuseport_cb,
|
|
|
|
|
lockdep_is_held(&reuseport_lock));
|
|
|
|
|
if (reuse) {
|
|
|
|
|
/* Only set reuse->bind_inany if the bind_inany is true.
|
|
|
|
|
* Otherwise, it will overwrite the reuse->bind_inany
|
|
|
|
|
* which was set by the bind/hash path.
|
|
|
|
|
*/
|
|
|
|
|
if (bind_inany)
|
|
|
|
|
reuse->bind_inany = bind_inany;
|
2017-10-20 03:00:29 +08:00
|
|
|
goto out;
|
bpf: Introduce BPF_PROG_TYPE_SK_REUSEPORT
This patch adds a BPF_PROG_TYPE_SK_REUSEPORT which can select
a SO_REUSEPORT sk from a BPF_MAP_TYPE_REUSEPORT_ARRAY. Like other
non SK_FILTER/CGROUP_SKB program, it requires CAP_SYS_ADMIN.
BPF_PROG_TYPE_SK_REUSEPORT introduces "struct sk_reuseport_kern"
to store the bpf context instead of using the skb->cb[48].
At the SO_REUSEPORT sk lookup time, it is in the middle of transiting
from a lower layer (ipv4/ipv6) to a upper layer (udp/tcp). At this
point, it is not always clear where the bpf context can be appended
in the skb->cb[48] to avoid saving-and-restoring cb[]. Even putting
aside the difference between ipv4-vs-ipv6 and udp-vs-tcp. It is not
clear if the lower layer is only ipv4 and ipv6 in the future and
will it not touch the cb[] again before transiting to the upper
layer.
For example, in udp_gro_receive(), it uses the 48 byte NAPI_GRO_CB
instead of IP[6]CB and it may still modify the cb[] after calling
the udp[46]_lib_lookup_skb(). Because of the above reason, if
sk->cb is used for the bpf ctx, saving-and-restoring is needed
and likely the whole 48 bytes cb[] has to be saved and restored.
Instead of saving, setting and restoring the cb[], this patch opts
to create a new "struct sk_reuseport_kern" and setting the needed
values in there.
The new BPF_PROG_TYPE_SK_REUSEPORT and "struct sk_reuseport_(kern|md)"
will serve all ipv4/ipv6 + udp/tcp combinations. There is no protocol
specific usage at this point and it is also inline with the current
sock_reuseport.c implementation (i.e. no protocol specific requirement).
In "struct sk_reuseport_md", this patch exposes data/data_end/len
with semantic similar to other existing usages. Together
with "bpf_skb_load_bytes()" and "bpf_skb_load_bytes_relative()",
the bpf prog can peek anywhere in the skb. The "bind_inany" tells
the bpf prog that the reuseport group is bind-ed to a local
INANY address which cannot be learned from skb.
The new "bind_inany" is added to "struct sock_reuseport" which will be
used when running the new "BPF_PROG_TYPE_SK_REUSEPORT" bpf prog in order
to avoid repeating the "bind INANY" test on
"sk_v6_rcv_saddr/sk->sk_rcv_saddr" every time a bpf prog is run. It can
only be properly initialized when a "sk->sk_reuseport" enabled sk is
adding to a hashtable (i.e. during "reuseport_alloc()" and
"reuseport_add_sock()").
The new "sk_select_reuseport()" is the main helper that the
bpf prog will use to select a SO_REUSEPORT sk. It is the only function
that can use the new BPF_MAP_TYPE_REUSEPORT_ARRAY. As mentioned in
the earlier patch, the validity of a selected sk is checked in
run time in "sk_select_reuseport()". Doing the check in
verification time is difficult and inflexible (consider the map-in-map
use case). The runtime check is to compare the selected sk's reuseport_id
with the reuseport_id that we want. This helper will return -EXXX if the
selected sk cannot serve the incoming request (e.g. reuseport_id
not match). The bpf prog can decide if it wants to do SK_DROP as its
discretion.
When the bpf prog returns SK_PASS, the kernel will check if a
valid sk has been selected (i.e. "reuse_kern->selected_sk != NULL").
If it does , it will use the selected sk. If not, the kernel
will select one from "reuse->socks[]" (as before this patch).
The SK_DROP and SK_PASS handling logic will be in the next patch.
Signed-off-by: Martin KaFai Lau <kafai@fb.com>
Acked-by: Alexei Starovoitov <ast@kernel.org>
Signed-off-by: Daniel Borkmann <daniel@iogearbox.net>
2018-08-08 16:01:25 +08:00
|
|
|
}
|
2017-10-20 03:00:29 +08:00
|
|
|
|
2016-01-05 06:41:45 +08:00
|
|
|
reuse = __reuseport_alloc(INIT_SOCKS);
|
|
|
|
|
if (!reuse) {
|
|
|
|
|
spin_unlock_bh(&reuseport_lock);
|
|
|
|
|
return -ENOMEM;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
reuse->socks[0] = sk;
|
|
|
|
|
reuse->num_socks = 1;
|
bpf: Introduce BPF_PROG_TYPE_SK_REUSEPORT
This patch adds a BPF_PROG_TYPE_SK_REUSEPORT which can select
a SO_REUSEPORT sk from a BPF_MAP_TYPE_REUSEPORT_ARRAY. Like other
non SK_FILTER/CGROUP_SKB program, it requires CAP_SYS_ADMIN.
BPF_PROG_TYPE_SK_REUSEPORT introduces "struct sk_reuseport_kern"
to store the bpf context instead of using the skb->cb[48].
At the SO_REUSEPORT sk lookup time, it is in the middle of transiting
from a lower layer (ipv4/ipv6) to a upper layer (udp/tcp). At this
point, it is not always clear where the bpf context can be appended
in the skb->cb[48] to avoid saving-and-restoring cb[]. Even putting
aside the difference between ipv4-vs-ipv6 and udp-vs-tcp. It is not
clear if the lower layer is only ipv4 and ipv6 in the future and
will it not touch the cb[] again before transiting to the upper
layer.
For example, in udp_gro_receive(), it uses the 48 byte NAPI_GRO_CB
instead of IP[6]CB and it may still modify the cb[] after calling
the udp[46]_lib_lookup_skb(). Because of the above reason, if
sk->cb is used for the bpf ctx, saving-and-restoring is needed
and likely the whole 48 bytes cb[] has to be saved and restored.
Instead of saving, setting and restoring the cb[], this patch opts
to create a new "struct sk_reuseport_kern" and setting the needed
values in there.
The new BPF_PROG_TYPE_SK_REUSEPORT and "struct sk_reuseport_(kern|md)"
will serve all ipv4/ipv6 + udp/tcp combinations. There is no protocol
specific usage at this point and it is also inline with the current
sock_reuseport.c implementation (i.e. no protocol specific requirement).
In "struct sk_reuseport_md", this patch exposes data/data_end/len
with semantic similar to other existing usages. Together
with "bpf_skb_load_bytes()" and "bpf_skb_load_bytes_relative()",
the bpf prog can peek anywhere in the skb. The "bind_inany" tells
the bpf prog that the reuseport group is bind-ed to a local
INANY address which cannot be learned from skb.
The new "bind_inany" is added to "struct sock_reuseport" which will be
used when running the new "BPF_PROG_TYPE_SK_REUSEPORT" bpf prog in order
to avoid repeating the "bind INANY" test on
"sk_v6_rcv_saddr/sk->sk_rcv_saddr" every time a bpf prog is run. It can
only be properly initialized when a "sk->sk_reuseport" enabled sk is
adding to a hashtable (i.e. during "reuseport_alloc()" and
"reuseport_add_sock()").
The new "sk_select_reuseport()" is the main helper that the
bpf prog will use to select a SO_REUSEPORT sk. It is the only function
that can use the new BPF_MAP_TYPE_REUSEPORT_ARRAY. As mentioned in
the earlier patch, the validity of a selected sk is checked in
run time in "sk_select_reuseport()". Doing the check in
verification time is difficult and inflexible (consider the map-in-map
use case). The runtime check is to compare the selected sk's reuseport_id
with the reuseport_id that we want. This helper will return -EXXX if the
selected sk cannot serve the incoming request (e.g. reuseport_id
not match). The bpf prog can decide if it wants to do SK_DROP as its
discretion.
When the bpf prog returns SK_PASS, the kernel will check if a
valid sk has been selected (i.e. "reuse_kern->selected_sk != NULL").
If it does , it will use the selected sk. If not, the kernel
will select one from "reuse->socks[]" (as before this patch).
The SK_DROP and SK_PASS handling logic will be in the next patch.
Signed-off-by: Martin KaFai Lau <kafai@fb.com>
Acked-by: Alexei Starovoitov <ast@kernel.org>
Signed-off-by: Daniel Borkmann <daniel@iogearbox.net>
2018-08-08 16:01:25 +08:00
|
|
|
reuse->bind_inany = bind_inany;
|
2016-01-05 06:41:45 +08:00
|
|
|
rcu_assign_pointer(sk->sk_reuseport_cb, reuse);
|
|
|
|
|
|
2017-10-20 03:00:29 +08:00
|
|
|
out:
|
2016-01-05 06:41:45 +08:00
|
|
|
spin_unlock_bh(&reuseport_lock);
|
|
|
|
|
|
|
|
|
|
return 0;
|
|
|
|
|
}
|
|
|
|
|
EXPORT_SYMBOL(reuseport_alloc);
|
|
|
|
|
|
|
|
|
|
static struct sock_reuseport *reuseport_grow(struct sock_reuseport *reuse)
|
|
|
|
|
{
|
|
|
|
|
struct sock_reuseport *more_reuse;
|
|
|
|
|
u32 more_socks_size, i;
|
|
|
|
|
|
|
|
|
|
more_socks_size = reuse->max_socks * 2U;
|
|
|
|
|
if (more_socks_size > U16_MAX)
|
|
|
|
|
return NULL;
|
|
|
|
|
|
|
|
|
|
more_reuse = __reuseport_alloc(more_socks_size);
|
|
|
|
|
if (!more_reuse)
|
|
|
|
|
return NULL;
|
|
|
|
|
|
|
|
|
|
more_reuse->max_socks = more_socks_size;
|
|
|
|
|
more_reuse->num_socks = reuse->num_socks;
|
2016-01-05 06:41:47 +08:00
|
|
|
more_reuse->prog = reuse->prog;
|
2018-08-08 16:01:22 +08:00
|
|
|
more_reuse->reuseport_id = reuse->reuseport_id;
|
bpf: Introduce BPF_PROG_TYPE_SK_REUSEPORT
This patch adds a BPF_PROG_TYPE_SK_REUSEPORT which can select
a SO_REUSEPORT sk from a BPF_MAP_TYPE_REUSEPORT_ARRAY. Like other
non SK_FILTER/CGROUP_SKB program, it requires CAP_SYS_ADMIN.
BPF_PROG_TYPE_SK_REUSEPORT introduces "struct sk_reuseport_kern"
to store the bpf context instead of using the skb->cb[48].
At the SO_REUSEPORT sk lookup time, it is in the middle of transiting
from a lower layer (ipv4/ipv6) to a upper layer (udp/tcp). At this
point, it is not always clear where the bpf context can be appended
in the skb->cb[48] to avoid saving-and-restoring cb[]. Even putting
aside the difference between ipv4-vs-ipv6 and udp-vs-tcp. It is not
clear if the lower layer is only ipv4 and ipv6 in the future and
will it not touch the cb[] again before transiting to the upper
layer.
For example, in udp_gro_receive(), it uses the 48 byte NAPI_GRO_CB
instead of IP[6]CB and it may still modify the cb[] after calling
the udp[46]_lib_lookup_skb(). Because of the above reason, if
sk->cb is used for the bpf ctx, saving-and-restoring is needed
and likely the whole 48 bytes cb[] has to be saved and restored.
Instead of saving, setting and restoring the cb[], this patch opts
to create a new "struct sk_reuseport_kern" and setting the needed
values in there.
The new BPF_PROG_TYPE_SK_REUSEPORT and "struct sk_reuseport_(kern|md)"
will serve all ipv4/ipv6 + udp/tcp combinations. There is no protocol
specific usage at this point and it is also inline with the current
sock_reuseport.c implementation (i.e. no protocol specific requirement).
In "struct sk_reuseport_md", this patch exposes data/data_end/len
with semantic similar to other existing usages. Together
with "bpf_skb_load_bytes()" and "bpf_skb_load_bytes_relative()",
the bpf prog can peek anywhere in the skb. The "bind_inany" tells
the bpf prog that the reuseport group is bind-ed to a local
INANY address which cannot be learned from skb.
The new "bind_inany" is added to "struct sock_reuseport" which will be
used when running the new "BPF_PROG_TYPE_SK_REUSEPORT" bpf prog in order
to avoid repeating the "bind INANY" test on
"sk_v6_rcv_saddr/sk->sk_rcv_saddr" every time a bpf prog is run. It can
only be properly initialized when a "sk->sk_reuseport" enabled sk is
adding to a hashtable (i.e. during "reuseport_alloc()" and
"reuseport_add_sock()").
The new "sk_select_reuseport()" is the main helper that the
bpf prog will use to select a SO_REUSEPORT sk. It is the only function
that can use the new BPF_MAP_TYPE_REUSEPORT_ARRAY. As mentioned in
the earlier patch, the validity of a selected sk is checked in
run time in "sk_select_reuseport()". Doing the check in
verification time is difficult and inflexible (consider the map-in-map
use case). The runtime check is to compare the selected sk's reuseport_id
with the reuseport_id that we want. This helper will return -EXXX if the
selected sk cannot serve the incoming request (e.g. reuseport_id
not match). The bpf prog can decide if it wants to do SK_DROP as its
discretion.
When the bpf prog returns SK_PASS, the kernel will check if a
valid sk has been selected (i.e. "reuse_kern->selected_sk != NULL").
If it does , it will use the selected sk. If not, the kernel
will select one from "reuse->socks[]" (as before this patch).
The SK_DROP and SK_PASS handling logic will be in the next patch.
Signed-off-by: Martin KaFai Lau <kafai@fb.com>
Acked-by: Alexei Starovoitov <ast@kernel.org>
Signed-off-by: Daniel Borkmann <daniel@iogearbox.net>
2018-08-08 16:01:25 +08:00
|
|
|
more_reuse->bind_inany = reuse->bind_inany;
|
2016-01-05 06:41:45 +08:00
|
|
|
|
|
|
|
|
memcpy(more_reuse->socks, reuse->socks,
|
|
|
|
|
reuse->num_socks * sizeof(struct sock *));
|
tcp: Avoid TCP syncookie rejected by SO_REUSEPORT socket
Although the actual cookie check "__cookie_v[46]_check()" does
not involve sk specific info, it checks whether the sk has recent
synq overflow event in "tcp_synq_no_recent_overflow()". The
tcp_sk(sk)->rx_opt.ts_recent_stamp is updated every second
when it has sent out a syncookie (through "tcp_synq_overflow()").
The above per sk "recent synq overflow event timestamp" works well
for non SO_REUSEPORT use case. However, it may cause random
connection request reject/discard when SO_REUSEPORT is used with
syncookie because it fails the "tcp_synq_no_recent_overflow()"
test.
When SO_REUSEPORT is used, it usually has multiple listening
socks serving TCP connection requests destinated to the same local IP:PORT.
There are cases that the TCP-ACK-COOKIE may not be received
by the same sk that sent out the syncookie. For example,
if reuse->socks[] began with {sk0, sk1},
1) sk1 sent out syncookies and tcp_sk(sk1)->rx_opt.ts_recent_stamp
was updated.
2) the reuse->socks[] became {sk1, sk2} later. e.g. sk0 was first closed
and then sk2 was added. Here, sk2 does not have ts_recent_stamp set.
There are other ordering that will trigger the similar situation
below but the idea is the same.
3) When the TCP-ACK-COOKIE comes back, sk2 was selected.
"tcp_synq_no_recent_overflow(sk2)" returns true. In this case,
all syncookies sent by sk1 will be handled (and rejected)
by sk2 while sk1 is still alive.
The userspace may create and remove listening SO_REUSEPORT sockets
as it sees fit. E.g. Adding new thread (and SO_REUSEPORT sock) to handle
incoming requests, old process stopping and new process starting...etc.
With or without SO_ATTACH_REUSEPORT_[CB]BPF,
the sockets leaving and joining a reuseport group makes picking
the same sk to check the syncookie very difficult (if not impossible).
The later patches will allow bpf prog more flexibility in deciding
where a sk should be located in a bpf map and selecting a particular
SO_REUSEPORT sock as it sees fit. e.g. Without closing any sock,
replace the whole bpf reuseport_array in one map_update() by using
map-in-map. Getting the syncookie check working smoothly across
socks in the same "reuse->socks[]" is important.
A partial solution is to set the newly added sk's ts_recent_stamp
to the max ts_recent_stamp of a reuseport group but that will require
to iterate through reuse->socks[] OR
pessimistically set it to "now - TCP_SYNCOOKIE_VALID" when a sk is
joining a reuseport group. However, neither of them will solve the
existing sk getting moved around the reuse->socks[] and that
sk may not have ts_recent_stamp updated, unlikely under continuous
synflood but not impossible.
This patch opts to treat the reuseport group as a whole when
considering the last synq overflow timestamp since
they are serving the same IP:PORT from the userspace
(and BPF program) perspective.
"synq_overflow_ts" is added to "struct sock_reuseport".
The tcp_synq_overflow() and tcp_synq_no_recent_overflow()
will update/check reuse->synq_overflow_ts if the sk is
in a reuseport group. Similar to the reuseport decision in
__inet_lookup_listener(), both sk->sk_reuseport and
sk->sk_reuseport_cb are tested for SO_REUSEPORT usage.
Update on "synq_overflow_ts" happens at roughly once
every second.
A synflood test was done with a 16 rx-queues and 16 reuseport sockets.
No meaningful performance change is observed. Before and
after the change is ~9Mpps in IPv4.
Cc: Eric Dumazet <edumazet@google.com>
Signed-off-by: Martin KaFai Lau <kafai@fb.com>
Acked-by: Alexei Starovoitov <ast@kernel.org>
Signed-off-by: Daniel Borkmann <daniel@iogearbox.net>
2018-08-08 16:01:21 +08:00
|
|
|
more_reuse->synq_overflow_ts = READ_ONCE(reuse->synq_overflow_ts);
|
2016-01-05 06:41:45 +08:00
|
|
|
|
|
|
|
|
for (i = 0; i < reuse->num_socks; ++i)
|
|
|
|
|
rcu_assign_pointer(reuse->socks[i]->sk_reuseport_cb,
|
|
|
|
|
more_reuse);
|
|
|
|
|
|
2016-01-05 06:41:47 +08:00
|
|
|
/* Note: we use kfree_rcu here instead of reuseport_free_rcu so
|
|
|
|
|
* that reuse and more_reuse can temporarily share a reference
|
|
|
|
|
* to prog.
|
|
|
|
|
*/
|
2016-01-05 06:41:45 +08:00
|
|
|
kfree_rcu(reuse, rcu);
|
|
|
|
|
return more_reuse;
|
|
|
|
|
}
|
|
|
|
|
|
2018-02-03 02:27:27 +08:00
|
|
|
static void reuseport_free_rcu(struct rcu_head *head)
|
|
|
|
|
{
|
|
|
|
|
struct sock_reuseport *reuse;
|
|
|
|
|
|
|
|
|
|
reuse = container_of(head, struct sock_reuseport, rcu);
|
2018-08-08 16:01:26 +08:00
|
|
|
sk_reuseport_prog_free(rcu_dereference_protected(reuse->prog, 1));
|
2018-08-08 16:01:22 +08:00
|
|
|
if (reuse->reuseport_id)
|
|
|
|
|
ida_simple_remove(&reuseport_ida, reuse->reuseport_id);
|
2018-02-03 02:27:27 +08:00
|
|
|
kfree(reuse);
|
|
|
|
|
}
|
|
|
|
|
|
2016-01-05 06:41:45 +08:00
|
|
|
/**
|
|
|
|
|
* reuseport_add_sock - Add a socket to the reuseport group of another.
|
|
|
|
|
* @sk: New socket to add to the group.
|
|
|
|
|
* @sk2: Socket belonging to the existing reuseport group.
|
|
|
|
|
* May return ENOMEM and not add socket to group under memory pressure.
|
|
|
|
|
*/
|
bpf: Introduce BPF_PROG_TYPE_SK_REUSEPORT
This patch adds a BPF_PROG_TYPE_SK_REUSEPORT which can select
a SO_REUSEPORT sk from a BPF_MAP_TYPE_REUSEPORT_ARRAY. Like other
non SK_FILTER/CGROUP_SKB program, it requires CAP_SYS_ADMIN.
BPF_PROG_TYPE_SK_REUSEPORT introduces "struct sk_reuseport_kern"
to store the bpf context instead of using the skb->cb[48].
At the SO_REUSEPORT sk lookup time, it is in the middle of transiting
from a lower layer (ipv4/ipv6) to a upper layer (udp/tcp). At this
point, it is not always clear where the bpf context can be appended
in the skb->cb[48] to avoid saving-and-restoring cb[]. Even putting
aside the difference between ipv4-vs-ipv6 and udp-vs-tcp. It is not
clear if the lower layer is only ipv4 and ipv6 in the future and
will it not touch the cb[] again before transiting to the upper
layer.
For example, in udp_gro_receive(), it uses the 48 byte NAPI_GRO_CB
instead of IP[6]CB and it may still modify the cb[] after calling
the udp[46]_lib_lookup_skb(). Because of the above reason, if
sk->cb is used for the bpf ctx, saving-and-restoring is needed
and likely the whole 48 bytes cb[] has to be saved and restored.
Instead of saving, setting and restoring the cb[], this patch opts
to create a new "struct sk_reuseport_kern" and setting the needed
values in there.
The new BPF_PROG_TYPE_SK_REUSEPORT and "struct sk_reuseport_(kern|md)"
will serve all ipv4/ipv6 + udp/tcp combinations. There is no protocol
specific usage at this point and it is also inline with the current
sock_reuseport.c implementation (i.e. no protocol specific requirement).
In "struct sk_reuseport_md", this patch exposes data/data_end/len
with semantic similar to other existing usages. Together
with "bpf_skb_load_bytes()" and "bpf_skb_load_bytes_relative()",
the bpf prog can peek anywhere in the skb. The "bind_inany" tells
the bpf prog that the reuseport group is bind-ed to a local
INANY address which cannot be learned from skb.
The new "bind_inany" is added to "struct sock_reuseport" which will be
used when running the new "BPF_PROG_TYPE_SK_REUSEPORT" bpf prog in order
to avoid repeating the "bind INANY" test on
"sk_v6_rcv_saddr/sk->sk_rcv_saddr" every time a bpf prog is run. It can
only be properly initialized when a "sk->sk_reuseport" enabled sk is
adding to a hashtable (i.e. during "reuseport_alloc()" and
"reuseport_add_sock()").
The new "sk_select_reuseport()" is the main helper that the
bpf prog will use to select a SO_REUSEPORT sk. It is the only function
that can use the new BPF_MAP_TYPE_REUSEPORT_ARRAY. As mentioned in
the earlier patch, the validity of a selected sk is checked in
run time in "sk_select_reuseport()". Doing the check in
verification time is difficult and inflexible (consider the map-in-map
use case). The runtime check is to compare the selected sk's reuseport_id
with the reuseport_id that we want. This helper will return -EXXX if the
selected sk cannot serve the incoming request (e.g. reuseport_id
not match). The bpf prog can decide if it wants to do SK_DROP as its
discretion.
When the bpf prog returns SK_PASS, the kernel will check if a
valid sk has been selected (i.e. "reuse_kern->selected_sk != NULL").
If it does , it will use the selected sk. If not, the kernel
will select one from "reuse->socks[]" (as before this patch).
The SK_DROP and SK_PASS handling logic will be in the next patch.
Signed-off-by: Martin KaFai Lau <kafai@fb.com>
Acked-by: Alexei Starovoitov <ast@kernel.org>
Signed-off-by: Daniel Borkmann <daniel@iogearbox.net>
2018-08-08 16:01:25 +08:00
|
|
|
int reuseport_add_sock(struct sock *sk, struct sock *sk2, bool bind_inany)
|
2016-01-05 06:41:45 +08:00
|
|
|
{
|
2018-02-03 02:27:27 +08:00
|
|
|
struct sock_reuseport *old_reuse, *reuse;
|
2016-01-05 06:41:45 +08:00
|
|
|
|
2016-01-20 03:27:08 +08:00
|
|
|
if (!rcu_access_pointer(sk2->sk_reuseport_cb)) {
|
bpf: Introduce BPF_PROG_TYPE_SK_REUSEPORT
This patch adds a BPF_PROG_TYPE_SK_REUSEPORT which can select
a SO_REUSEPORT sk from a BPF_MAP_TYPE_REUSEPORT_ARRAY. Like other
non SK_FILTER/CGROUP_SKB program, it requires CAP_SYS_ADMIN.
BPF_PROG_TYPE_SK_REUSEPORT introduces "struct sk_reuseport_kern"
to store the bpf context instead of using the skb->cb[48].
At the SO_REUSEPORT sk lookup time, it is in the middle of transiting
from a lower layer (ipv4/ipv6) to a upper layer (udp/tcp). At this
point, it is not always clear where the bpf context can be appended
in the skb->cb[48] to avoid saving-and-restoring cb[]. Even putting
aside the difference between ipv4-vs-ipv6 and udp-vs-tcp. It is not
clear if the lower layer is only ipv4 and ipv6 in the future and
will it not touch the cb[] again before transiting to the upper
layer.
For example, in udp_gro_receive(), it uses the 48 byte NAPI_GRO_CB
instead of IP[6]CB and it may still modify the cb[] after calling
the udp[46]_lib_lookup_skb(). Because of the above reason, if
sk->cb is used for the bpf ctx, saving-and-restoring is needed
and likely the whole 48 bytes cb[] has to be saved and restored.
Instead of saving, setting and restoring the cb[], this patch opts
to create a new "struct sk_reuseport_kern" and setting the needed
values in there.
The new BPF_PROG_TYPE_SK_REUSEPORT and "struct sk_reuseport_(kern|md)"
will serve all ipv4/ipv6 + udp/tcp combinations. There is no protocol
specific usage at this point and it is also inline with the current
sock_reuseport.c implementation (i.e. no protocol specific requirement).
In "struct sk_reuseport_md", this patch exposes data/data_end/len
with semantic similar to other existing usages. Together
with "bpf_skb_load_bytes()" and "bpf_skb_load_bytes_relative()",
the bpf prog can peek anywhere in the skb. The "bind_inany" tells
the bpf prog that the reuseport group is bind-ed to a local
INANY address which cannot be learned from skb.
The new "bind_inany" is added to "struct sock_reuseport" which will be
used when running the new "BPF_PROG_TYPE_SK_REUSEPORT" bpf prog in order
to avoid repeating the "bind INANY" test on
"sk_v6_rcv_saddr/sk->sk_rcv_saddr" every time a bpf prog is run. It can
only be properly initialized when a "sk->sk_reuseport" enabled sk is
adding to a hashtable (i.e. during "reuseport_alloc()" and
"reuseport_add_sock()").
The new "sk_select_reuseport()" is the main helper that the
bpf prog will use to select a SO_REUSEPORT sk. It is the only function
that can use the new BPF_MAP_TYPE_REUSEPORT_ARRAY. As mentioned in
the earlier patch, the validity of a selected sk is checked in
run time in "sk_select_reuseport()". Doing the check in
verification time is difficult and inflexible (consider the map-in-map
use case). The runtime check is to compare the selected sk's reuseport_id
with the reuseport_id that we want. This helper will return -EXXX if the
selected sk cannot serve the incoming request (e.g. reuseport_id
not match). The bpf prog can decide if it wants to do SK_DROP as its
discretion.
When the bpf prog returns SK_PASS, the kernel will check if a
valid sk has been selected (i.e. "reuse_kern->selected_sk != NULL").
If it does , it will use the selected sk. If not, the kernel
will select one from "reuse->socks[]" (as before this patch).
The SK_DROP and SK_PASS handling logic will be in the next patch.
Signed-off-by: Martin KaFai Lau <kafai@fb.com>
Acked-by: Alexei Starovoitov <ast@kernel.org>
Signed-off-by: Daniel Borkmann <daniel@iogearbox.net>
2018-08-08 16:01:25 +08:00
|
|
|
int err = reuseport_alloc(sk2, bind_inany);
|
2016-01-20 03:27:08 +08:00
|
|
|
|
|
|
|
|
if (err)
|
|
|
|
|
return err;
|
|
|
|
|
}
|
|
|
|
|
|
2016-01-05 06:41:45 +08:00
|
|
|
spin_lock_bh(&reuseport_lock);
|
|
|
|
|
reuse = rcu_dereference_protected(sk2->sk_reuseport_cb,
|
2018-02-03 02:27:27 +08:00
|
|
|
lockdep_is_held(&reuseport_lock));
|
|
|
|
|
old_reuse = rcu_dereference_protected(sk->sk_reuseport_cb,
|
|
|
|
|
lockdep_is_held(&reuseport_lock));
|
|
|
|
|
if (old_reuse && old_reuse->num_socks != 1) {
|
|
|
|
|
spin_unlock_bh(&reuseport_lock);
|
|
|
|
|
return -EBUSY;
|
|
|
|
|
}
|
2016-01-05 06:41:45 +08:00
|
|
|
|
|
|
|
|
if (reuse->num_socks == reuse->max_socks) {
|
|
|
|
|
reuse = reuseport_grow(reuse);
|
|
|
|
|
if (!reuse) {
|
|
|
|
|
spin_unlock_bh(&reuseport_lock);
|
|
|
|
|
return -ENOMEM;
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
reuse->socks[reuse->num_socks] = sk;
|
|
|
|
|
/* paired with smp_rmb() in reuseport_select_sock() */
|
|
|
|
|
smp_wmb();
|
|
|
|
|
reuse->num_socks++;
|
|
|
|
|
rcu_assign_pointer(sk->sk_reuseport_cb, reuse);
|
|
|
|
|
|
|
|
|
|
spin_unlock_bh(&reuseport_lock);
|
|
|
|
|
|
2018-02-03 02:27:27 +08:00
|
|
|
if (old_reuse)
|
|
|
|
|
call_rcu(&old_reuse->rcu, reuseport_free_rcu);
|
2016-01-05 06:41:45 +08:00
|
|
|
return 0;
|
|
|
|
|
}
|
2018-11-12 18:27:16 +08:00
|
|
|
EXPORT_SYMBOL(reuseport_add_sock);
|
2016-01-05 06:41:45 +08:00
|
|
|
|
|
|
|
|
void reuseport_detach_sock(struct sock *sk)
|
|
|
|
|
{
|
|
|
|
|
struct sock_reuseport *reuse;
|
|
|
|
|
int i;
|
|
|
|
|
|
|
|
|
|
spin_lock_bh(&reuseport_lock);
|
|
|
|
|
reuse = rcu_dereference_protected(sk->sk_reuseport_cb,
|
|
|
|
|
lockdep_is_held(&reuseport_lock));
|
bpf: Introduce BPF_MAP_TYPE_REUSEPORT_SOCKARRAY
This patch introduces a new map type BPF_MAP_TYPE_REUSEPORT_SOCKARRAY.
To unleash the full potential of a bpf prog, it is essential for the
userspace to be capable of directly setting up a bpf map which can then
be consumed by the bpf prog to make decision. In this case, decide which
SO_REUSEPORT sk to serve the incoming request.
By adding BPF_MAP_TYPE_REUSEPORT_SOCKARRAY, the userspace has total control
and visibility on where a SO_REUSEPORT sk should be located in a bpf map.
The later patch will introduce BPF_PROG_TYPE_SK_REUSEPORT such that
the bpf prog can directly select a sk from the bpf map. That will
raise the programmability of the bpf prog attached to a reuseport
group (a group of sk serving the same IP:PORT).
For example, in UDP, the bpf prog can peek into the payload (e.g.
through the "data" pointer introduced in the later patch) to learn
the application level's connection information and then decide which sk
to pick from a bpf map. The userspace can tightly couple the sk's location
in a bpf map with the application logic in generating the UDP payload's
connection information. This connection info contact/API stays within the
userspace.
Also, when used with map-in-map, the userspace can switch the
old-server-process's inner map to a new-server-process's inner map
in one call "bpf_map_update_elem(outer_map, &index, &new_reuseport_array)".
The bpf prog will then direct incoming requests to the new process instead
of the old process. The old process can finish draining the pending
requests (e.g. by "accept()") before closing the old-fds. [Note that
deleting a fd from a bpf map does not necessary mean the fd is closed]
During map_update_elem(),
Only SO_REUSEPORT sk (i.e. which has already been added
to a reuse->socks[]) can be used. That means a SO_REUSEPORT sk that is
"bind()" for UDP or "bind()+listen()" for TCP. These conditions are
ensured in "reuseport_array_update_check()".
A SO_REUSEPORT sk can only be added once to a map (i.e. the
same sk cannot be added twice even to the same map). SO_REUSEPORT
already allows another sk to be created for the same IP:PORT.
There is no need to re-create a similar usage in the BPF side.
When a SO_REUSEPORT is deleted from the "reuse->socks[]" (e.g. "close()"),
it will notify the bpf map to remove it from the map also. It is
done through "bpf_sk_reuseport_detach()" and it will only be called
if >=1 of the "reuse->sock[]" has ever been added to a bpf map.
The map_update()/map_delete() has to be in-sync with the
"reuse->socks[]". Hence, the same "reuseport_lock" used
by "reuse->socks[]" has to be used here also. Care has
been taken to ensure the lock is only acquired when the
adding sk passes some strict tests. and
freeing the map does not require the reuseport_lock.
The reuseport_array will also support lookup from the syscall
side. It will return a sock_gen_cookie(). The sock_gen_cookie()
is on-demand (i.e. a sk's cookie is not generated until the very
first map_lookup_elem()).
The lookup cookie is 64bits but it goes against the logical userspace
expectation on 32bits sizeof(fd) (and as other fd based bpf maps do also).
It may catch user in surprise if we enforce value_size=8 while
userspace still pass a 32bits fd during update. Supporting different
value_size between lookup and update seems unintuitive also.
We also need to consider what if other existing fd based maps want
to return 64bits value from syscall's lookup in the future.
Hence, reuseport_array supports both value_size 4 and 8, and
assuming user will usually use value_size=4. The syscall's lookup
will return ENOSPC on value_size=4. It will will only
return 64bits value from sock_gen_cookie() when user consciously
choose value_size=8 (as a signal that lookup is desired) which then
requires a 64bits value in both lookup and update.
Signed-off-by: Martin KaFai Lau <kafai@fb.com>
Acked-by: Alexei Starovoitov <ast@kernel.org>
Signed-off-by: Daniel Borkmann <daniel@iogearbox.net>
2018-08-08 16:01:24 +08:00
|
|
|
|
|
|
|
|
/* At least one of the sk in this reuseport group is added to
|
|
|
|
|
* a bpf map. Notify the bpf side. The bpf map logic will
|
|
|
|
|
* remove the sk if it is indeed added to a bpf map.
|
|
|
|
|
*/
|
|
|
|
|
if (reuse->reuseport_id)
|
|
|
|
|
bpf_sk_reuseport_detach(sk);
|
|
|
|
|
|
2016-01-05 06:41:45 +08:00
|
|
|
rcu_assign_pointer(sk->sk_reuseport_cb, NULL);
|
|
|
|
|
|
|
|
|
|
for (i = 0; i < reuse->num_socks; i++) {
|
|
|
|
|
if (reuse->socks[i] == sk) {
|
|
|
|
|
reuse->socks[i] = reuse->socks[reuse->num_socks - 1];
|
|
|
|
|
reuse->num_socks--;
|
|
|
|
|
if (reuse->num_socks == 0)
|
2016-01-05 06:41:47 +08:00
|
|
|
call_rcu(&reuse->rcu, reuseport_free_rcu);
|
2016-01-05 06:41:45 +08:00
|
|
|
break;
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
spin_unlock_bh(&reuseport_lock);
|
|
|
|
|
}
|
|
|
|
|
EXPORT_SYMBOL(reuseport_detach_sock);
|
|
|
|
|
|
2018-08-08 16:01:26 +08:00
|
|
|
static struct sock *run_bpf_filter(struct sock_reuseport *reuse, u16 socks,
|
|
|
|
|
struct bpf_prog *prog, struct sk_buff *skb,
|
|
|
|
|
int hdr_len)
|
2016-01-05 06:41:47 +08:00
|
|
|
{
|
|
|
|
|
struct sk_buff *nskb = NULL;
|
|
|
|
|
u32 index;
|
|
|
|
|
|
|
|
|
|
if (skb_shared(skb)) {
|
|
|
|
|
nskb = skb_clone(skb, GFP_ATOMIC);
|
|
|
|
|
if (!nskb)
|
|
|
|
|
return NULL;
|
|
|
|
|
skb = nskb;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/* temporarily advance data past protocol header */
|
|
|
|
|
if (!pskb_pull(skb, hdr_len)) {
|
2016-01-05 23:57:13 +08:00
|
|
|
kfree_skb(nskb);
|
2016-01-05 06:41:47 +08:00
|
|
|
return NULL;
|
|
|
|
|
}
|
|
|
|
|
index = bpf_prog_run_save_cb(prog, skb);
|
|
|
|
|
__skb_push(skb, hdr_len);
|
|
|
|
|
|
|
|
|
|
consume_skb(nskb);
|
|
|
|
|
|
|
|
|
|
if (index >= socks)
|
|
|
|
|
return NULL;
|
|
|
|
|
|
|
|
|
|
return reuse->socks[index];
|
|
|
|
|
}
|
|
|
|
|
|
2016-01-05 06:41:45 +08:00
|
|
|
/**
|
|
|
|
|
* reuseport_select_sock - Select a socket from an SO_REUSEPORT group.
|
|
|
|
|
* @sk: First socket in the group.
|
2016-01-05 06:41:47 +08:00
|
|
|
* @hash: When no BPF filter is available, use this hash to select.
|
|
|
|
|
* @skb: skb to run through BPF filter.
|
|
|
|
|
* @hdr_len: BPF filter expects skb data pointer at payload data. If
|
|
|
|
|
* the skb does not yet point at the payload, this parameter represents
|
|
|
|
|
* how far the pointer needs to advance to reach the payload.
|
2016-01-05 06:41:45 +08:00
|
|
|
* Returns a socket that should receive the packet (or NULL on error).
|
|
|
|
|
*/
|
2016-01-05 06:41:47 +08:00
|
|
|
struct sock *reuseport_select_sock(struct sock *sk,
|
|
|
|
|
u32 hash,
|
|
|
|
|
struct sk_buff *skb,
|
|
|
|
|
int hdr_len)
|
2016-01-05 06:41:45 +08:00
|
|
|
{
|
|
|
|
|
struct sock_reuseport *reuse;
|
2016-01-05 06:41:47 +08:00
|
|
|
struct bpf_prog *prog;
|
2016-01-05 06:41:45 +08:00
|
|
|
struct sock *sk2 = NULL;
|
|
|
|
|
u16 socks;
|
|
|
|
|
|
|
|
|
|
rcu_read_lock();
|
|
|
|
|
reuse = rcu_dereference(sk->sk_reuseport_cb);
|
|
|
|
|
|
|
|
|
|
/* if memory allocation failed or add call is not yet complete */
|
|
|
|
|
if (!reuse)
|
|
|
|
|
goto out;
|
|
|
|
|
|
2016-01-05 06:41:47 +08:00
|
|
|
prog = rcu_dereference(reuse->prog);
|
2016-01-05 06:41:45 +08:00
|
|
|
socks = READ_ONCE(reuse->num_socks);
|
|
|
|
|
if (likely(socks)) {
|
|
|
|
|
/* paired with smp_wmb() in reuseport_add_sock() */
|
|
|
|
|
smp_rmb();
|
|
|
|
|
|
2018-08-08 16:01:26 +08:00
|
|
|
if (!prog || !skb)
|
|
|
|
|
goto select_by_hash;
|
|
|
|
|
|
|
|
|
|
if (prog->type == BPF_PROG_TYPE_SK_REUSEPORT)
|
|
|
|
|
sk2 = bpf_run_sk_reuseport(reuse, sk, prog, skb, hash);
|
|
|
|
|
else
|
|
|
|
|
sk2 = run_bpf_filter(reuse, socks, prog, skb, hdr_len);
|
2017-11-30 22:39:34 +08:00
|
|
|
|
2018-08-08 16:01:26 +08:00
|
|
|
select_by_hash:
|
2017-11-30 22:39:34 +08:00
|
|
|
/* no bpf or invalid bpf result: fall back to hash usage */
|
|
|
|
|
if (!sk2)
|
2016-01-05 06:41:47 +08:00
|
|
|
sk2 = reuse->socks[reciprocal_scale(hash, socks)];
|
2016-01-05 06:41:45 +08:00
|
|
|
}
|
|
|
|
|
|
|
|
|
|
out:
|
|
|
|
|
rcu_read_unlock();
|
|
|
|
|
return sk2;
|
|
|
|
|
}
|
|
|
|
|
EXPORT_SYMBOL(reuseport_select_sock);
|
2016-01-05 06:41:47 +08:00
|
|
|
|
2018-08-08 16:01:26 +08:00
|
|
|
int reuseport_attach_prog(struct sock *sk, struct bpf_prog *prog)
|
2016-01-05 06:41:47 +08:00
|
|
|
{
|
|
|
|
|
struct sock_reuseport *reuse;
|
|
|
|
|
struct bpf_prog *old_prog;
|
|
|
|
|
|
2018-08-08 16:01:26 +08:00
|
|
|
if (sk_unhashed(sk) && sk->sk_reuseport) {
|
|
|
|
|
int err = reuseport_alloc(sk, false);
|
|
|
|
|
|
|
|
|
|
if (err)
|
|
|
|
|
return err;
|
|
|
|
|
} else if (!rcu_access_pointer(sk->sk_reuseport_cb)) {
|
|
|
|
|
/* The socket wasn't bound with SO_REUSEPORT */
|
|
|
|
|
return -EINVAL;
|
|
|
|
|
}
|
|
|
|
|
|
2016-01-05 06:41:47 +08:00
|
|
|
spin_lock_bh(&reuseport_lock);
|
|
|
|
|
reuse = rcu_dereference_protected(sk->sk_reuseport_cb,
|
|
|
|
|
lockdep_is_held(&reuseport_lock));
|
|
|
|
|
old_prog = rcu_dereference_protected(reuse->prog,
|
|
|
|
|
lockdep_is_held(&reuseport_lock));
|
|
|
|
|
rcu_assign_pointer(reuse->prog, prog);
|
|
|
|
|
spin_unlock_bh(&reuseport_lock);
|
|
|
|
|
|
2018-08-08 16:01:26 +08:00
|
|
|
sk_reuseport_prog_free(old_prog);
|
|
|
|
|
return 0;
|
2016-01-05 06:41:47 +08:00
|
|
|
}
|
|
|
|
|
EXPORT_SYMBOL(reuseport_attach_prog);
|