Skip to contentSkip to conversation

Introduce eBPF flow dissector

PATCH Superseded Petar Penkov 3 participants 10 messages Sep 13, 2018 – Sep 14, 2018

Subsystems (9)

v3 of 4 Superseded Latest is v4 →

lore
Share & tools
lore
#0 lore raw

v3 cover Introduce eBPF flow dissector

From: Petar Penkov <[email protected]>

This patch series hardens the RX stack by allowing flow dissection in BPF, as previously discussed [1]. Because of the rigorous checks of the BPF verifier, this provides significant security guarantees. In particular, the BPF flow dissector cannot get inside of an infinite loop, as with CVE-2013-4348, because BPF programs are guaranteed to terminate. It cannot read outside of packet bounds, because all memory accesses are checked. Also, with BPF the administrator can decide which protocols to support, reducing potential attack surface. Rarely encountered protocols can be excluded from dissection and the program can be updated without kernel recompile or reboot if a bug is discovered.

Patch 1 adds infrastructure to execute a BPF program in __skb_flow_dissect. This includes a new BPF program and attach type.

Patch 2 adds the new BPF flow dissector definitions to tools/uapi.

Patch 3 adds support for the new BPF program type to libbpf and bpftool.

Patch 4 adds a flow dissector program in BPF. This parses most protocols in __skb_flow_dissect in BPF for a subset of flow keys (basic, control, ports, and address types).

Patch 5 adds a selftest that attaches the BPF program to the flow dissector and sends traffic with different levels of encapsulation.

Performance Evaluation:
The in-kernel implementation was compared against the demo program from patch 4 using the test in patch 5 with IPv4/UDP traffic over 10 seconds.

	$perf record -a -C 4 taskset -c 4 ./test_flow_dissector -i 4 -f 8 \
		-t 10

In-kernel Dissector:

	__skb_flow_dissect overhead: 2.12%
	Total Packets: 3,272,597 (from output of ./test_flow_dissector)

BPF Dissector:

	__skb_flow_dissect overhead: 1.63% 
	Total Packets: 3,232,356 (from output of ./test_flow_dissector)

No-op BPF Dissector:

	__skb_flow_dissect overhead: 1.52% 
	Total Packets: 3,330,635 (from output of ./test_flow_dissector)

Changes since v2:
1/ Changes to tools/include/uapi pulled into a separate patch 2 2/ Changes to tools/lib and tools/bpftool pulled into a separate patch 3 3/ Changed flow_keys in __sk_buff from __u32 to struct bpf_flow_keys * 4/ Added nhoff field in struct bpf_flow_keys to pass initial offset 5/ Saving all of the modified control block, rather than just the qdisc 6/ Sample BPF program in patch 4 modified to use the changes above

Changes since v1:
1/ LD_ABS instructions now disallowed for the new BPF prog type 2/ now checks if skb is NULL in __skb_flow_dissect()
3/ fixed incorrect accesses in flow_dissector_is_valid_access()
- writes to the flow_keys field now disallowed
- reads/writes to tc_classid and data_meta now disallowed
4/ headers pulled with bpf_skb_load_data if direct access fails

Changes since RFC:
1/ Flow dissector hook changed from global to per-netns
2/ Defined struct bpf_flow_keys to be used in BPF flow dissector programs instead of exposing the internal flow keys layout. Added a function to translate from bpf_flow_keys to the internal layout after BPF dissection is complete. The pointer to this struct is stored in qdisc_skb_cb rather than inside of the 20 byte control block which simplifies verification and allows access to all 20 bytes of the cb. 3/ Removed GUE parsing as it relied on a hardcoded port
4/ MPLS parsing now stops at the first label which is consistent with the in-kernel flow dissector
5/ Refactored to use direct packet access and to write out to struct bpf_flow_keys

[1] http://vger.kernel.org/netconf2017_files/rx_hardening_and_udp_gso.pdf

Petar Penkov (5):
flow_dissector: implements flow dissector BPF hook
bpf: sync bpf.h uapi with tools/
bpf: support flow dissector in libbpf and bpftool
flow_dissector: implements eBPF parser selftests/bpf: test bpf flow dissection

 include/linux/bpf.h                           |   1 +
 include/linux/bpf_types.h                     |   1 +
 include/linux/skbuff.h                        |   7 +
 include/net/net_namespace.h                   |   3 +
 include/net/sch_generic.h                     |  12 +-
 include/uapi/linux/bpf.h                      |  26 +
 kernel/bpf/syscall.c                          |   8 +
 kernel/bpf/verifier.c                         |  32 +
 net/core/filter.c                             |  70 ++
 net/core/flow_dissector.c                     | 134 +++
 tools/bpf/bpftool/prog.c                      |   1 +
 tools/include/uapi/linux/bpf.h                |  26 +
 tools/lib/bpf/libbpf.c                        |   2 +
 tools/testing/selftests/bpf/.gitignore        |   2 +
 tools/testing/selftests/bpf/Makefile          |   8 +-
 tools/testing/selftests/bpf/bpf_flow.c        | 373 +++++++++
 tools/testing/selftests/bpf/config            |   1 +
 .../selftests/bpf/flow_dissector_load.c       | 140 ++++
 .../selftests/bpf/test_flow_dissector.c       | 782 ++++++++++++++++++
 .../selftests/bpf/test_flow_dissector.sh      | 115 +++
 tools/testing/selftests/bpf/with_addr.sh      |  54 ++
 tools/testing/selftests/bpf/with_tunnels.sh   |  36 +
 22 files changed, 1828 insertions(+), 6 deletions(-)
 create mode 100644 tools/testing/selftests/bpf/bpf_flow.c
 create mode 100644 tools/testing/selftests/bpf/flow_dissector_load.c
 create mode 100644 tools/testing/selftests/bpf/test_flow_dissector.c
 create mode 100755 tools/testing/selftests/bpf/test_flow_dissector.sh
 create mode 100755 tools/testing/selftests/bpf/with_addr.sh
 create mode 100755 tools/testing/selftests/bpf/with_tunnels.sh
Signature · 1 line
2.19.0.397.gdd90340f6a-goog
#1 lore raw

PATCH v3 1/5 flow_dissector: implements flow dissector BPF hook

From: Petar Penkov <[email protected]>

Adds a hook for programs of type BPF_PROG_TYPE_FLOW_DISSECTOR and attach type BPF_FLOW_DISSECTOR that is executed in the flow dissector path. The BPF program is per-network namespace.

---
 include/linux/bpf.h         |   1 +
 include/linux/bpf_types.h   |   1 +
 include/linux/skbuff.h      |   7 ++
 include/net/net_namespace.h |   3 +
 include/net/sch_generic.h   |  12 +++-
 include/uapi/linux/bpf.h    |  26 +++++++
 kernel/bpf/syscall.c        |   8 +++
 kernel/bpf/verifier.c       |  32 +++++++++
 net/core/filter.c           |  70 +++++++++++++++++++
 net/core/flow_dissector.c   | 134 ++++++++++++++++++++++++++++++++++++
 10 files changed, 291 insertions(+), 3 deletions(-)
include/linux/bpf.h +1 -0
index 523481a3471b..988a00797bcd 100644
@@ -212,6 +212,7 @@ enum bpf_reg_type {
 	PTR_TO_PACKET_META,	 /* skb->data - meta_len */
 	PTR_TO_PACKET,		 /* reg points to skb->data */
 	PTR_TO_PACKET_END,	 /* skb->data + headlen */
+	PTR_TO_FLOW_KEYS,	 /* reg points to bpf_flow_keys */
 };
 
 /* The information passed from prog-specific *_is_valid_access
include/linux/bpf_types.h +1 -0
index cd26c090e7c0..22083712dd18 100644
@@ -32,6 +32,7 @@ BPF_PROG_TYPE(BPF_PROG_TYPE_LIRC_MODE2, lirc_mode2)
 #ifdef CONFIG_INET
 BPF_PROG_TYPE(BPF_PROG_TYPE_SK_REUSEPORT, sk_reuseport)
 #endif
+BPF_PROG_TYPE(BPF_PROG_TYPE_FLOW_DISSECTOR, flow_dissector)
 
 BPF_MAP_TYPE(BPF_MAP_TYPE_ARRAY, array_map_ops)
 BPF_MAP_TYPE(BPF_MAP_TYPE_PERCPU_ARRAY, percpu_array_map_ops)
include/linux/skbuff.h +7 -0
index 17a13e4785fc..ce0e863f02a2 100644
@@ -243,6 +243,8 @@ struct scatterlist;
 struct pipe_inode_info;
 struct iov_iter;
 struct napi_struct;
+struct bpf_prog;
+union bpf_attr;
 
 #if defined(CONFIG_NF_CONNTRACK) || defined(CONFIG_NF_CONNTRACK_MODULE)
 struct nf_conntrack {
@@ -1192,6 +1194,11 @@ void skb_flow_dissector_init(struct flow_dissector *flow_dissector,
 			     const struct flow_dissector_key *key,
 			     unsigned int key_count);
 
+int skb_flow_dissector_bpf_prog_attach(const union bpf_attr *attr,
+				       struct bpf_prog *prog);
+
+int skb_flow_dissector_bpf_prog_detach(const union bpf_attr *attr);
+
 bool __skb_flow_dissect(const struct sk_buff *skb,
 			struct flow_dissector *flow_dissector,
 			void *target_container,
include/net/net_namespace.h +3 -0
index 9b5fdc50519a..99d4148e0f90 100644
@@ -43,6 +43,7 @@ struct ctl_table_header;
 struct net_generic;
 struct uevent_sock;
 struct netns_ipvs;
+struct bpf_prog;
 
 
 #define NETDEV_HASHBITS    8
@@ -145,6 +146,8 @@ struct net {
 #endif
 	struct net_generic __rcu	*gen;
 
+	struct bpf_prog __rcu	*flow_dissector_prog;
+
 	/* Note : following structs are cache line aligned */
 #ifdef CONFIG_XFRM
 	struct netns_xfrm	xfrm;
include/net/sch_generic.h +9 -3
index a6d00093f35e..1b81ba85fd2d 100644
@@ -19,6 +19,7 @@ struct Qdisc_ops;
 struct qdisc_walker;
 struct tcf_walker;
 struct module;
+struct bpf_flow_keys;
 
 typedef int tc_setup_cb_t(enum tc_setup_type type,
 			  void *type_data, void *cb_priv);
@@ -307,9 +308,14 @@ struct tcf_proto {
 };
 
 struct qdisc_skb_cb {
-	unsigned int		pkt_len;
-	u16			slave_dev_queue_mapping;
-	u16			tc_classid;
+	union {
+		struct {
+			unsigned int		pkt_len;
+			u16			slave_dev_queue_mapping;
+			u16			tc_classid;
+		};
+		struct bpf_flow_keys *flow_keys;
+	};
 #define QDISC_CB_PRIV_LEN 20
 	unsigned char		data[QDISC_CB_PRIV_LEN];
 };
include/uapi/linux/bpf.h +26 -0
index 66917a4eba27..d1baf20cd329 100644
@@ -152,6 +152,7 @@ enum bpf_prog_type {
 	BPF_PROG_TYPE_LWT_SEG6LOCAL,
 	BPF_PROG_TYPE_LIRC_MODE2,
 	BPF_PROG_TYPE_SK_REUSEPORT,
+	BPF_PROG_TYPE_FLOW_DISSECTOR,
 };
 
 enum bpf_attach_type {
@@ -172,6 +173,7 @@ enum bpf_attach_type {
 	BPF_CGROUP_UDP4_SENDMSG,
 	BPF_CGROUP_UDP6_SENDMSG,
 	BPF_LIRC_MODE2,
+	BPF_FLOW_DISSECTOR,
 	__MAX_BPF_ATTACH_TYPE
 };
 
@@ -2333,6 +2335,7 @@ struct __sk_buff {
 	/* ... here. */
 
 	__u32 data_meta;
+	struct bpf_flow_keys *flow_keys;
 };
 
 struct bpf_tunnel_key {
@@ -2778,4 +2781,27 @@ enum bpf_task_fd_type {
 	BPF_FD_TYPE_URETPROBE,		/* filename + offset */
 };
 
+struct bpf_flow_keys {
+	__u16	nhoff;
+	__u16	thoff;
+	__u16	addr_proto;			/* ETH_P_* of valid addrs */
+	__u8	is_frag;
+	__u8	is_first_frag;
+	__u8	is_encap;
+	__be16	n_proto;
+	__u8	ip_proto;
+	union {
+		struct {
+			__be32	ipv4_src;
+			__be32	ipv4_dst;
+		};
+		struct {
+			__u32	ipv6_src[4];	/* in6_addr; network order */
+			__u32	ipv6_dst[4];	/* in6_addr; network order */
+		};
+	};
+	__be16	sport;
+	__be16	dport;
+};
+
 #endif /* _UAPI__LINUX_BPF_H__ */
kernel/bpf/syscall.c +8 -0
index 3c9636f03bb2..b3c2d09bcf7a 100644
@@ -1615,6 +1615,9 @@ static int bpf_prog_attach(const union bpf_attr *attr)
 	case BPF_LIRC_MODE2:
 		ptype = BPF_PROG_TYPE_LIRC_MODE2;
 		break;
+	case BPF_FLOW_DISSECTOR:
+		ptype = BPF_PROG_TYPE_FLOW_DISSECTOR;
+		break;
 	default:
 		return -EINVAL;
 	}
@@ -1636,6 +1639,9 @@ static int bpf_prog_attach(const union bpf_attr *attr)
 	case BPF_PROG_TYPE_LIRC_MODE2:
 		ret = lirc_prog_attach(attr, prog);
 		break;
+	case BPF_PROG_TYPE_FLOW_DISSECTOR:
+		ret = skb_flow_dissector_bpf_prog_attach(attr, prog);
+		break;
 	default:
 		ret = cgroup_bpf_prog_attach(attr, ptype, prog);
 	}
@@ -1688,6 +1694,8 @@ static int bpf_prog_detach(const union bpf_attr *attr)
 		return sockmap_get_from_fd(attr, BPF_PROG_TYPE_SK_SKB, NULL);
 	case BPF_LIRC_MODE2:
 		return lirc_prog_detach(attr);
+	case BPF_FLOW_DISSECTOR:
+		return skb_flow_dissector_bpf_prog_detach(attr);
 	default:
 		return -EINVAL;
 	}
kernel/bpf/verifier.c +32 -0
index 6ff1bac1795d..8ccbff4fff93 100644
@@ -261,6 +261,7 @@ static const char * const reg_type_str[] = {
 	[PTR_TO_PACKET]		= "pkt",
 	[PTR_TO_PACKET_META]	= "pkt_meta",
 	[PTR_TO_PACKET_END]	= "pkt_end",
+	[PTR_TO_FLOW_KEYS]	= "flow_keys",
 };
 
 static char slot_type_char[] = {
@@ -965,6 +966,7 @@ static bool is_spillable_regtype(enum bpf_reg_type type)
 	case PTR_TO_PACKET:
 	case PTR_TO_PACKET_META:
 	case PTR_TO_PACKET_END:
+	case PTR_TO_FLOW_KEYS:
 	case CONST_PTR_TO_MAP:
 		return true;
 	default:
@@ -1238,6 +1240,7 @@ static bool may_access_direct_pkt_data(struct bpf_verifier_env *env,
 	case BPF_PROG_TYPE_LWT_XMIT:
 	case BPF_PROG_TYPE_SK_SKB:
 	case BPF_PROG_TYPE_SK_MSG:
+	case BPF_PROG_TYPE_FLOW_DISSECTOR:
 		if (meta)
 			return meta->pkt_access;
 
@@ -1321,6 +1324,18 @@ static int check_ctx_access(struct bpf_verifier_env *env, int insn_idx, int off,
 	return -EACCES;
 }
 
+static int check_flow_keys_access(struct bpf_verifier_env *env, int off,
+				  int size)
+{
+	if (size < 0 || off < 0 ||
+	    (u64)off + size > sizeof(struct bpf_flow_keys)) {
+		verbose(env, "invalid access to flow keys off=%d size=%d\n",
+			off, size);
+		return -EACCES;
+	}
+	return 0;
+}
+
 static bool __is_pointer_value(bool allow_ptr_leaks,
 			       const struct bpf_reg_state *reg)
 {
@@ -1422,6 +1437,9 @@ static int check_ptr_alignment(struct bpf_verifier_env *env,
 		 * right in front, treat it the very same way.
 		 */
 		return check_pkt_ptr_alignment(env, reg, off, size, strict);
+	case PTR_TO_FLOW_KEYS:
+		pointer_desc = "flow keys ";
+		break;
 	case PTR_TO_MAP_VALUE:
 		pointer_desc = "value ";
 		break;
@@ -1692,6 +1710,17 @@ static int check_mem_access(struct bpf_verifier_env *env, int insn_idx, u32 regn
 		err = check_packet_access(env, regno, off, size, false);
 		if (!err && t == BPF_READ && value_regno >= 0)
 			mark_reg_unknown(env, regs, value_regno);
+	} else if (reg->type == PTR_TO_FLOW_KEYS) {
+		if (t == BPF_WRITE && value_regno >= 0 &&
+		    is_pointer_value(env, value_regno)) {
+			verbose(env, "R%d leaks addr into flow keys\n",
+				value_regno);
+			return -EACCES;
+		}
+
+		err = check_flow_keys_access(env, off, size);
+		if (!err && t == BPF_READ && value_regno >= 0)
+			mark_reg_unknown(env, regs, value_regno);
 	} else {
 		verbose(env, "R%d invalid mem access '%s'\n", regno,
 			reg_type_str[reg->type]);
@@ -1839,6 +1868,8 @@ static int check_helper_mem_access(struct bpf_verifier_env *env, int regno,
 	case PTR_TO_PACKET_META:
 		return check_packet_access(env, regno, reg->off, access_size,
 					   zero_size_allowed);
+	case PTR_TO_FLOW_KEYS:
+		return check_flow_keys_access(env, reg->off, access_size);
 	case PTR_TO_MAP_VALUE:
 		return check_map_access(env, regno, reg->off, access_size,
 					zero_size_allowed);
@@ -4366,6 +4397,7 @@ static bool regsafe(struct bpf_reg_state *rold, struct bpf_reg_state *rcur,
 	case PTR_TO_CTX:
 	case CONST_PTR_TO_MAP:
 	case PTR_TO_PACKET_END:
+	case PTR_TO_FLOW_KEYS:
 		/* Only valid matches are exact, which memcmp() above
 		 * would have accepted
 		 */
net/core/filter.c +70 -0

124 lines not on this page · raw message

net/core/flow_dissector.c +134 -0

164 lines not on this page · raw message

Signature · 1 line
2.19.0.397.gdd90340f6a-goog
#2 lore raw

Re: [bpf-next, v3 1/5] flow_dissector: implements flow dissector BPF hook

Quoted 8 lines · Petar Penkov

From: Petar Penkov <[email protected]>

Adds a hook for programs of type BPF_PROG_TYPE_FLOW_DISSECTOR and attach type BPF_FLOW_DISSECTOR that is executed in the flow dissector path. The BPF program is per-network namespace.

...

include/uapi/linux/bpf.h struct __sk_buff { · line 2338

Quoted 5 lines
include/uapi/linux/bpf.h +1 -0
@@ -2333,6 +2335,7 @@ struct __sk_buff {
 	/* ... here. */
 
 	__u32 data_meta;
+	struct bpf_flow_keys *flow_keys;

the bpf prog form patch 4 looks much better now. Thanks!

Quoted 19 lines
include/uapi/linux/bpf.h +12 -0
 };
 
 struct bpf_tunnel_key {
@@ -2778,4 +2781,27 @@ enum bpf_task_fd_type {
 	BPF_FD_TYPE_URETPROBE,		/* filename + offset */
 };
 
+struct bpf_flow_keys {
+	__u16	nhoff;
+	__u16	thoff;
+	__u16	addr_proto;			/* ETH_P_* of valid addrs */
+	__u8	is_frag;
+	__u8	is_first_frag;
+	__u8	is_encap;
+	__be16	n_proto;
+	__u8	ip_proto;
+	union {
+		struct {
+			__be32	ipv4_src;

include/uapi/linux/bpf.h enum bpf_task_fd_type { · line 2805

Quoted 10 lines
include/uapi/linux/bpf.h +10 -0
+			__be32	ipv4_dst;
+		};
+		struct {
+			__u32	ipv6_src[4];	/* in6_addr; network order */
+			__u32	ipv6_dst[4];	/* in6_addr; network order */
+		};
+	};
+	__be16	sport;
+	__be16	dport;
+};

can you please pack it?
struct bpf_flow_keys {

	__u16                      nhoff;                /*     0     2 */
	__u16                      thoff;                /*     2     2 */
	__u16                      addr_proto;           /*     4     2 */
	__u8                       is_frag;              /*     6     1 */
	__u8                       is_first_frag;        /*     7     1 */
	__u8                       is_encap;             /*     8     1 */
	/* XXX 1 byte hole, try to pack */

	__be16                     n_proto;              /*    10     2 */
	__u8                       ip_proto;             /*    12     1 */

	/* XXX 3 bytes hole, try to pack */

	union {

also is_frag and other fields are not used by the kernel and only used by the prog to pass data between tail_calls ? In such case reserve some space in bpf_flow_keys similar to skb->cb so it can contain any fields and accommodate for inevitable changes to bpf flow dissector prog in the future.

#3 lore raw

Re: [bpf-next, v3 1/5] flow_dissector: implements flow dissector BPF hook

Quoted 67 lines · Alexei Starovoitov
Quoted 8 lines · Petar Penkov

From: Petar Penkov <[email protected]>

Adds a hook for programs of type BPF_PROG_TYPE_FLOW_DISSECTOR and attach type BPF_FLOW_DISSECTOR that is executed in the flow dissector path. The BPF program is per-network namespace.

...

include/uapi/linux/bpf.h struct __sk_buff { · line 2338

Quoted 5 lines
include/uapi/linux/bpf.h +1 -0
@@ -2333,6 +2335,7 @@ struct __sk_buff {
      /* ... here. */
 
      __u32 data_meta;
+     struct bpf_flow_keys *flow_keys;

the bpf prog form patch 4 looks much better now. Thanks!

Quoted 19 lines
include/uapi/linux/bpf.h +12 -0
 };
 
 struct bpf_tunnel_key {
@@ -2778,4 +2781,27 @@ enum bpf_task_fd_type {
      BPF_FD_TYPE_URETPROBE,          /* filename + offset */
 };
 
+struct bpf_flow_keys {
+     __u16   nhoff;
+     __u16   thoff;
+     __u16   addr_proto;                     /* ETH_P_* of valid addrs */
+     __u8    is_frag;
+     __u8    is_first_frag;
+     __u8    is_encap;
+     __be16  n_proto;
+     __u8    ip_proto;
+     union {
+             struct {
+                     __be32  ipv4_src;

include/uapi/linux/bpf.h enum bpf_task_fd_type { · line 2805

Quoted 10 lines
include/uapi/linux/bpf.h +10 -0
+                     __be32  ipv4_dst;
+             };
+             struct {
+                     __u32   ipv6_src[4];    /* in6_addr; network order */
+                     __u32   ipv6_dst[4];    /* in6_addr; network order */
+             };
+     };
+     __be16  sport;
+     __be16  dport;
+};

can you please pack it?
struct bpf_flow_keys {

        __u16                      nhoff;                /*     0     2 */
        __u16                      thoff;                /*     2     2 */
        __u16                      addr_proto;           /*     4     2 */
        __u8                       is_frag;              /*     6     1 */
        __u8                       is_first_frag;        /*     7     1 */
        __u8                       is_encap;             /*     8     1 */
        /* XXX 1 byte hole, try to pack */

        __be16                     n_proto;              /*    10     2 */
        __u8                       ip_proto;             /*    12     1 */

        /* XXX 3 bytes hole, try to pack */

        union {
Quoted 2 lines

also is_frag and other fields are not used by the kernel and only used by the prog to pass data between tail_calls ?

No, these are mapped directly onto fields in struct flow_keys on return from the BPF program in __skb_flow_bpf_to_target. For is_frag, for instance:

       if (flow_keys->is_frag)
               key_control->flags |= FLOW_DIS_IS_FRAGMENT;

This is true for all fields in the struct except nhoff.

Quoted 3 lines

In such case reserve some space in bpf_flow_keys similar to skb->cb so it can contain any fields and accommodate for inevitable changes to bpf flow dissector prog in the future.

Do you mean a second scratch space akin to cb[], just a few reserved padding bytes?

We have given some thought to forward compatibility. The existing fields cannot be changed, but it should be fine if we need to expand the struct later.

#4 lore raw

Re: [bpf-next, v3 1/5] flow_dissector: implements flow dissector BPF hook

Quoted 72 lines · Willem de Bruijn
Quoted 67 lines · Alexei Starovoitov
Quoted 8 lines · Petar Penkov

From: Petar Penkov <[email protected]>

Adds a hook for programs of type BPF_PROG_TYPE_FLOW_DISSECTOR and attach type BPF_FLOW_DISSECTOR that is executed in the flow dissector path. The BPF program is per-network namespace.

...

include/uapi/linux/bpf.h struct __sk_buff { · line 2338

Quoted 5 lines
include/uapi/linux/bpf.h +1 -0
@@ -2333,6 +2335,7 @@ struct __sk_buff {
      /* ... here. */
 
      __u32 data_meta;
+     struct bpf_flow_keys *flow_keys;

the bpf prog form patch 4 looks much better now. Thanks!

Quoted 19 lines
include/uapi/linux/bpf.h +12 -0
 };
 
 struct bpf_tunnel_key {
@@ -2778,4 +2781,27 @@ enum bpf_task_fd_type {
      BPF_FD_TYPE_URETPROBE,          /* filename + offset */
 };
 
+struct bpf_flow_keys {
+     __u16   nhoff;
+     __u16   thoff;
+     __u16   addr_proto;                     /* ETH_P_* of valid addrs */
+     __u8    is_frag;
+     __u8    is_first_frag;
+     __u8    is_encap;
+     __be16  n_proto;
+     __u8    ip_proto;
+     union {
+             struct {
+                     __be32  ipv4_src;

include/uapi/linux/bpf.h enum bpf_task_fd_type { · line 2805

Quoted 10 lines
include/uapi/linux/bpf.h +10 -0
+                     __be32  ipv4_dst;
+             };
+             struct {
+                     __u32   ipv6_src[4];    /* in6_addr; network order */
+                     __u32   ipv6_dst[4];    /* in6_addr; network order */
+             };
+     };
+     __be16  sport;
+     __be16  dport;
+};

can you please pack it?
struct bpf_flow_keys {

        __u16                      nhoff;                /*     0     2 */
        __u16                      thoff;                /*     2     2 */
        __u16                      addr_proto;           /*     4     2 */
        __u8                       is_frag;              /*     6     1 */
        __u8                       is_first_frag;        /*     7     1 */
        __u8                       is_encap;             /*     8     1 */
        /* XXX 1 byte hole, try to pack */

        __be16                     n_proto;              /*    10     2 */
        __u8                       ip_proto;             /*    12     1 */

        /* XXX 3 bytes hole, try to pack */

        union {
Quoted 2 lines

also is_frag and other fields are not used by the kernel and only used by the prog to pass data between tail_calls ?

Quoted 6 lines

No, these are mapped directly onto fields in struct flow_keys on return from the BPF program in __skb_flow_bpf_to_target. For is_frag, for instance:

       if (flow_keys->is_frag)
               key_control->flags |= FLOW_DIS_IS_FRAGMENT;

right. my search-fu failed me. only packing is needed then.

Quoted 8 lines

This is true for all fields in the struct except nhoff.

Quoted 3 lines

In such case reserve some space in bpf_flow_keys similar to skb->cb so it can contain any fields and accommodate for inevitable changes to bpf flow dissector prog in the future.

Do you mean a second scratch space akin to cb[], just a few reserved padding bytes?

it looks to me it's possible to rearrange the fields to avoid all holes, so no extra padding bytes necessary.

Quoted 3 lines

We have given some thought to forward compatibility. The existing fields cannot be changed, but it should be fine if we need to expand the struct later.

let's keep cb-like idea for later. It seems to me we can add it to the end of bpf_flow_keys any time later.

#5 lore raw

Re: [bpf-next, v3 1/5] flow_dissector: implements flow dissector BPF hook

Quoted 89 lines · Alexei Starovoitov
Quoted 72 lines · Willem de Bruijn
Quoted 67 lines · Alexei Starovoitov
Quoted 8 lines · Petar Penkov

From: Petar Penkov <[email protected]>

Adds a hook for programs of type BPF_PROG_TYPE_FLOW_DISSECTOR and attach type BPF_FLOW_DISSECTOR that is executed in the flow dissector path. The BPF program is per-network namespace.

...

include/uapi/linux/bpf.h struct __sk_buff { · line 2338

Quoted 5 lines
include/uapi/linux/bpf.h +1 -0
@@ -2333,6 +2335,7 @@ struct __sk_buff {
      /* ... here. */
 
      __u32 data_meta;
+     struct bpf_flow_keys *flow_keys;

the bpf prog form patch 4 looks much better now. Thanks!

Quoted 19 lines
include/uapi/linux/bpf.h +12 -0
 };
 
 struct bpf_tunnel_key {
@@ -2778,4 +2781,27 @@ enum bpf_task_fd_type {
      BPF_FD_TYPE_URETPROBE,          /* filename + offset */
 };
 
+struct bpf_flow_keys {
+     __u16   nhoff;
+     __u16   thoff;
+     __u16   addr_proto;                     /* ETH_P_* of valid addrs */
+     __u8    is_frag;
+     __u8    is_first_frag;
+     __u8    is_encap;
+     __be16  n_proto;
+     __u8    ip_proto;
+     union {
+             struct {
+                     __be32  ipv4_src;

include/uapi/linux/bpf.h enum bpf_task_fd_type { · line 2805

Quoted 10 lines
include/uapi/linux/bpf.h +10 -0
+                     __be32  ipv4_dst;
+             };
+             struct {
+                     __u32   ipv6_src[4];    /* in6_addr; network order */
+                     __u32   ipv6_dst[4];    /* in6_addr; network order */
+             };
+     };
+     __be16  sport;
+     __be16  dport;
+};

can you please pack it?
struct bpf_flow_keys {

        __u16                      nhoff;                /*     0     2 */
        __u16                      thoff;                /*     2     2 */
        __u16                      addr_proto;           /*     4     2 */
        __u8                       is_frag;              /*     6     1 */
        __u8                       is_first_frag;        /*     7     1 */
        __u8                       is_encap;             /*     8     1 */
        /* XXX 1 byte hole, try to pack */

        __be16                     n_proto;              /*    10     2 */
        __u8                       ip_proto;             /*    12     1 */

        /* XXX 3 bytes hole, try to pack */

        union {
Quoted 2 lines

also is_frag and other fields are not used by the kernel and only used by the prog to pass data between tail_calls ?

Quoted 6 lines

No, these are mapped directly onto fields in struct flow_keys on return from the BPF program in __skb_flow_bpf_to_target. For is_frag, for instance:

       if (flow_keys->is_frag)
               key_control->flags |= FLOW_DIS_IS_FRAGMENT;

right. my search-fu failed me. only packing is needed then.

Quoted 6 lines

This is true for all fields in the struct except nhoff.

Quoted 3 lines

In such case reserve some space in bpf_flow_keys similar to skb->cb so it can contain any fields and accommodate for inevitable changes to bpf flow dissector prog in the future.

Quoted 5 lines
Quoted 2 lines

Do you mean a second scratch space akin to cb[], just a few reserved padding bytes?

it looks to me it's possible to rearrange the fields to avoid all holes, so no extra padding bytes necessary.

Absolutely. We forgot to run pahole earlier. Updating now.

Quoted 6 lines
Quoted 3 lines

We have given some thought to forward compatibility. The existing fields cannot be changed, but it should be fine if we need to expand the struct later.

let's keep cb-like idea for later. It seems to me we can add it to the end of bpf_flow_keys any time later.

#6 lore raw

PATCH v3 2/5 bpf: sync bpf.h uapi with tools/

In reply to Petar Penkov

From: Petar Penkov <[email protected]>

This patch syncs tools/include/uapi/linux/bpf.h with the flow dissector definitions from include/uapi/linux/bpf.h

---
 tools/include/uapi/linux/bpf.h | 26 ++++++++++++++++++++++++++
 1 file changed, 26 insertions(+)
tools/include/uapi/linux/bpf.h +26 -0
index 66917a4eba27..d1baf20cd329 100644
@@ -152,6 +152,7 @@ enum bpf_prog_type {
 	BPF_PROG_TYPE_LWT_SEG6LOCAL,
 	BPF_PROG_TYPE_LIRC_MODE2,
 	BPF_PROG_TYPE_SK_REUSEPORT,
+	BPF_PROG_TYPE_FLOW_DISSECTOR,
 };
 
 enum bpf_attach_type {
@@ -172,6 +173,7 @@ enum bpf_attach_type {
 	BPF_CGROUP_UDP4_SENDMSG,
 	BPF_CGROUP_UDP6_SENDMSG,
 	BPF_LIRC_MODE2,
+	BPF_FLOW_DISSECTOR,
 	__MAX_BPF_ATTACH_TYPE
 };
 
@@ -2333,6 +2335,7 @@ struct __sk_buff {
 	/* ... here. */
 
 	__u32 data_meta;
+	struct bpf_flow_keys *flow_keys;
 };
 
 struct bpf_tunnel_key {
@@ -2778,4 +2781,27 @@ enum bpf_task_fd_type {
 	BPF_FD_TYPE_URETPROBE,		/* filename + offset */
 };
 
+struct bpf_flow_keys {
+	__u16	nhoff;
+	__u16	thoff;
+	__u16	addr_proto;			/* ETH_P_* of valid addrs */
+	__u8	is_frag;
+	__u8	is_first_frag;
+	__u8	is_encap;
+	__be16	n_proto;
+	__u8	ip_proto;
+	union {
+		struct {
+			__be32	ipv4_src;
+			__be32	ipv4_dst;
+		};
+		struct {
+			__u32	ipv6_src[4];	/* in6_addr; network order */
+			__u32	ipv6_dst[4];	/* in6_addr; network order */
+		};
+	};
+	__be16	sport;
+	__be16	dport;
+};
+
 #endif /* _UAPI__LINUX_BPF_H__ */
Signature · 1 line
2.19.0.397.gdd90340f6a-goog
#7 lore raw

PATCH v3 3/5 bpf: support flow dissector in libbpf and bpftool

In reply to Petar Penkov

From: Petar Penkov <[email protected]>

This patch extends libbpf and bpftool to work with programs of type BPF_PROG_TYPE_FLOW_DISSECTOR.

---
 tools/bpf/bpftool/prog.c | 1 +
 tools/lib/bpf/libbpf.c   | 2 ++
 2 files changed, 3 insertions(+)
tools/bpf/bpftool/prog.c +1 -0
index dce960d22106..b1cd3bc8db70 100644
@@ -74,6 +74,7 @@ static const char * const prog_type_name[] = {
 	[BPF_PROG_TYPE_RAW_TRACEPOINT]	= "raw_tracepoint",
 	[BPF_PROG_TYPE_CGROUP_SOCK_ADDR] = "cgroup_sock_addr",
 	[BPF_PROG_TYPE_LIRC_MODE2]	= "lirc_mode2",
+	[BPF_PROG_TYPE_FLOW_DISSECTOR]	= "flow_dissector",
 };
 
 static void print_boot_time(__u64 nsecs, char *buf, unsigned int size)
tools/lib/bpf/libbpf.c +2 -0
index 8476da7f2720..9ca8e0e624d8 100644
@@ -1502,6 +1502,7 @@ static bool bpf_prog_type__needs_kver(enum bpf_prog_type type)
 	case BPF_PROG_TYPE_CGROUP_SOCK_ADDR:
 	case BPF_PROG_TYPE_LIRC_MODE2:
 	case BPF_PROG_TYPE_SK_REUSEPORT:
+	case BPF_PROG_TYPE_FLOW_DISSECTOR:
 		return false;
 	case BPF_PROG_TYPE_UNSPEC:
 	case BPF_PROG_TYPE_KPROBE:
@@ -2121,6 +2122,7 @@ static const struct {
 	BPF_PROG_SEC("sk_skb",		BPF_PROG_TYPE_SK_SKB),
 	BPF_PROG_SEC("sk_msg",		BPF_PROG_TYPE_SK_MSG),
 	BPF_PROG_SEC("lirc_mode2",	BPF_PROG_TYPE_LIRC_MODE2),
+	BPF_PROG_SEC("flow_dissector",	BPF_PROG_TYPE_FLOW_DISSECTOR),
 	BPF_SA_PROG_SEC("cgroup/bind4",	BPF_CGROUP_INET4_BIND),
 	BPF_SA_PROG_SEC("cgroup/bind6",	BPF_CGROUP_INET6_BIND),
 	BPF_SA_PROG_SEC("cgroup/connect4", BPF_CGROUP_INET4_CONNECT),
Signature · 1 line
2.19.0.397.gdd90340f6a-goog
#8 lore raw

PATCH v3 4/5 flow_dissector: implements eBPF parser

In reply to Petar Penkov

From: Petar Penkov <[email protected]>

This eBPF program extracts basic/control/ip address/ports keys from incoming packets. It supports recursive parsing for IP encapsulation, and VLAN, along with IPv4/IPv6 and extension headers. This program is meant to show how flow dissection and key extraction can be done in eBPF.

---
 tools/testing/selftests/bpf/Makefile   |   2 +-
 tools/testing/selftests/bpf/bpf_flow.c | 373 +++++++++++++++++++++++++
 2 files changed, 374 insertions(+), 1 deletion(-)
 create mode 100644 tools/testing/selftests/bpf/bpf_flow.c
tools/testing/selftests/bpf/Makefile +1 -1
index fff7fb1285fc..e65f50f9185e 100644
@@ -35,7 +35,7 @@ TEST_GEN_FILES = test_pkt_access.o test_xdp.o test_l4lb.o test_tcp_estats.o test
 	test_get_stack_rawtp.o test_sockmap_kern.o test_sockhash_kern.o \
 	test_lwt_seg6local.o sendmsg4_prog.o sendmsg6_prog.o test_lirc_mode2_kern.o \
 	get_cgroup_id_kern.o socket_cookie_prog.o test_select_reuseport_kern.o \
-	test_skb_cgroup_id_kern.o
+	test_skb_cgroup_id_kern.o bpf_flow.o
 
 # Order correspond to 'make run_tests' order
 TEST_PROGS := test_kmod.sh \
tools/testing/selftests/bpf/bpf_flow.c new file +373 -0

373 lines not on this page · raw message

Signature · 1 line
2.19.0.397.gdd90340f6a-goog
#9 lore raw

PATCH v3 5/5 selftests/bpf: test bpf flow dissection

In reply to Petar Penkov

From: Petar Penkov <[email protected]>

Adds a test that sends different types of packets over multiple tunnels and verifies that valid packets are dissected correctly. To do so, a tc-flower rule is added to drop packets on UDP src port 9, and packets are sent from ports 8, 9, and 10. Only the packets on port 9 should be dropped. Because tc-flower relies on the flow dissector to match flows, correct classification demonstrates correct dissection.

Also add support logic to load the BPF program and to inject the test packets.

---
 tools/testing/selftests/bpf/.gitignore        |   2 +
 tools/testing/selftests/bpf/Makefile          |   6 +-
 tools/testing/selftests/bpf/config            |   1 +
 .../selftests/bpf/flow_dissector_load.c       | 140 ++++
 .../selftests/bpf/test_flow_dissector.c       | 782 ++++++++++++++++++
 .../selftests/bpf/test_flow_dissector.sh      | 115 +++
 tools/testing/selftests/bpf/with_addr.sh      |  54 ++
 tools/testing/selftests/bpf/with_tunnels.sh   |  36 +
 8 files changed, 1134 insertions(+), 2 deletions(-)
 create mode 100644 tools/testing/selftests/bpf/flow_dissector_load.c
 create mode 100644 tools/testing/selftests/bpf/test_flow_dissector.c
 create mode 100755 tools/testing/selftests/bpf/test_flow_dissector.sh
 create mode 100755 tools/testing/selftests/bpf/with_addr.sh
 create mode 100755 tools/testing/selftests/bpf/with_tunnels.sh
tools/testing/selftests/bpf/.gitignore +2 -0
index 4d789c1e5167..8a60c9b9892d 100644
@@ -23,3 +23,5 @@ test_skb_cgroup_id_user
 test_socket_cookie
 test_cgroup_storage
 test_select_reuseport
+test_flow_dissector
+flow_dissector_load
tools/testing/selftests/bpf/Makefile +4 -2
index e65f50f9185e..fd3851d5c079 100644
@@ -47,10 +47,12 @@ TEST_PROGS := test_kmod.sh \
 	test_tunnel.sh \
 	test_lwt_seg6local.sh \
 	test_lirc_mode2.sh \
-	test_skb_cgroup_id.sh
+	test_skb_cgroup_id.sh \
+	test_flow_dissector.sh
 
 # Compile but not part of 'make run_tests'
-TEST_GEN_PROGS_EXTENDED = test_libbpf_open test_sock_addr test_skb_cgroup_id_user
+TEST_GEN_PROGS_EXTENDED = test_libbpf_open test_sock_addr test_skb_cgroup_id_user \
+	flow_dissector_load test_flow_dissector
 
 include ../lib.mk
 
tools/testing/selftests/bpf/config +1 -0
index b4994a94968b..3655508f95fd 100644
@@ -18,3 +18,4 @@ CONFIG_CRYPTO_HMAC=m
 CONFIG_CRYPTO_SHA256=m
 CONFIG_VXLAN=y
 CONFIG_GENEVE=y
+CONFIG_NET_CLS_FLOWER=m
tools/testing/selftests/bpf/flow_dissector_load.c new file +140 -0

140 lines not on this page · raw message

tools/testing/selftests/bpf/test_flow_dissector.c new file +782 -0

782 lines not on this page · raw message

tools/testing/selftests/bpf/test_flow_dissector.sh new file +115 -0

115 lines not on this page · raw message

tools/testing/selftests/bpf/with_addr.sh new file +54 -0

54 lines not on this page · raw message

tools/testing/selftests/bpf/with_tunnels.sh new file +36 -0
new file mode 100755
index 000000000000..e24949ed3a20
@@ -0,0 +1,36 @@
+#!/bin/bash
+# SPDX-License-Identifier: GPL-2.0
+#
+# setup tunnels for flow dissection test
+
+readonly SUFFIX="test_$(mktemp -u XXXX)"
+CONFIG="remote 127.0.0.2 local 127.0.0.1 dev lo"
+
+setup() {
+  ip link add "ipip_${SUFFIX}" type ipip ${CONFIG}
+  ip link add "gre_${SUFFIX}" type gre ${CONFIG}
+  ip link add "sit_${SUFFIX}" type sit ${CONFIG}
+
+  echo "tunnels before test:"
+  ip tunnel show
+
+  ip link set "ipip_${SUFFIX}" up
+  ip link set "gre_${SUFFIX}" up
+  ip link set "sit_${SUFFIX}" up
+}
+
+
+cleanup() {
+  ip tunnel del "ipip_${SUFFIX}"
+  ip tunnel del "gre_${SUFFIX}"
+  ip tunnel del "sit_${SUFFIX}"
+
+  echo "tunnels after test:"
+  ip tunnel show
+}
+
+trap cleanup EXIT
+
+setup
+"$@"
+exit "$?"
Signature · 1 line
2.19.0.397.gdd90340f6a-goog