Added flow pattern items and header formats of L2TPv2 and PPP.
Signed-off-by: Wenjun Wu <wenjun1...@intel.com>
Signed-off-by: Jie Wang <jie1x.w...@intel.com>
---
doc/guides/prog_guide/rte_flow.rst | 25 +++
doc/guides/rel_notes/release_21_11.rst | 5 +
lib/ethdev/rte_flow.c | 2 +
lib/ethdev/rte_flow.h | 66 ++++++++
lib/net/rte_l2tpv2.h | 214 +++++++++++++++++++++++++
lib/net/rte_ppp.h | 35 ++++
6 files changed, 347 insertions(+)
create mode 100644 lib/net/rte_l2tpv2.h
create mode 100644 lib/net/rte_ppp.h
diff --git a/doc/guides/prog_guide/rte_flow.rst
b/doc/guides/prog_guide/rte_flow.rst
index fa05fe0845..6277c641ef 100644
--- a/doc/guides/prog_guide/rte_flow.rst
+++ b/doc/guides/prog_guide/rte_flow.rst
@@ -1548,6 +1548,31 @@ This item is meant to use the same structure as `Item:
PORT_REPRESENTOR`_.
See also `Action: REPRESENTED_PORT`_.
+Item: ``L2TPV2``
+^^^^^^^^^^^^^^^^^^^
+
+Matches a L2TPv2 header.
+
+- ``flags_version``: flags(12b), version(4b).
+- ``length``: total length of the message.
+- ``tunnel_id``: identifier for the control connection.
+- ``session_id``: identifier for a session within a tunnel.
+- ``ns``: sequence number for this date or control message.
+- ``nr``: sequence number expected in the next control message to be received.
+- ``offset_size``: offset of payload data.
+- ``offset_padding``: offset padding, variable length.
+- Default ``mask`` matches flags_version only.
+
+Item: ``PPP``
+^^^^^^^^^^^^^^^^^^^
+
+Matches a PPP header.
+
+- ``addr``: ppp address.
+- ``ctrl``: ppp control.
+- ``proto_id``: ppp protocol identifier.
+- Default ``mask`` matches addr, ctrl, proto_id.
+
Actions
~~~~~~~
diff --git a/doc/guides/rel_notes/release_21_11.rst
b/doc/guides/rel_notes/release_21_11.rst
index ec2a788789..e1b23ce0e9 100644
--- a/doc/guides/rel_notes/release_21_11.rst
+++ b/doc/guides/rel_notes/release_21_11.rst
@@ -98,6 +98,11 @@ New Features
Added an ethdev API which can help users get device configuration.
+* **Added L2TPV2 and PPP protocol support in rte_flow.**
+
+ Added flow pattern items and header formats of L2TPv2 and PPP to support
+ PPP over L2TPv2 over UDP protocol RSS Hash.
+
* **Updated AF_XDP PMD.**
* Disabled secondary process support.
diff --git a/lib/ethdev/rte_flow.c b/lib/ethdev/rte_flow.c
index 29f2b0e954..0bfbeb73e8 100644
--- a/lib/ethdev/rte_flow.c
+++ b/lib/ethdev/rte_flow.c
@@ -102,6 +102,8 @@ static const struct rte_flow_desc_data rte_flow_desc_item[]
= {
MK_FLOW_ITEM(CONNTRACK, sizeof(uint32_t)),
MK_FLOW_ITEM(PORT_REPRESENTOR, sizeof(struct rte_flow_item_ethdev)),
MK_FLOW_ITEM(REPRESENTED_PORT, sizeof(struct rte_flow_item_ethdev)),
+ MK_FLOW_ITEM(L2TPV2, sizeof(struct rte_flow_item_l2tpv2)),
+ MK_FLOW_ITEM(PPP, sizeof(struct rte_flow_item_ppp)),
};
/** Generate flow_action[] entry. */
diff --git a/lib/ethdev/rte_flow.h b/lib/ethdev/rte_flow.h
index d5bfdaaaf2..2bc825b567 100644
--- a/lib/ethdev/rte_flow.h
+++ b/lib/ethdev/rte_flow.h
@@ -35,6 +35,8 @@
#include <rte_mbuf_dyn.h>
#include <rte_meter.h>
#include <rte_gtp.h>
+#include <rte_l2tpv2.h>
+#include <rte_ppp.h>
#ifdef __cplusplus
extern "C" {
@@ -635,6 +637,21 @@ enum rte_flow_item_type {
* @see struct rte_flow_item_ethdev
*/
RTE_FLOW_ITEM_TYPE_REPRESENTED_PORT,
+
+ /**
+ * Matches L2TPV2 Header.
+ *
+ * See struct rte_flow_item_l2tpv2.
+ */
+ RTE_FLOW_ITEM_TYPE_L2TPV2,
+
+ /**
+ * Matches PPP Header.
+ *
+ * See struct rte_flow_item_ppp.
+ */
+ RTE_FLOW_ITEM_TYPE_PPP,
+
};
/**
@@ -1891,6 +1908,55 @@ static const struct rte_flow_item_ethdev
rte_flow_item_ethdev_mask = {
};
#endif
+/**
+ * @warning
+ * @b EXPERIMENTAL: this structure may change without prior notice
+ * RTE_FLOW_ITEM_TYPE_L2TPV2
+ *
+ * Matches L2TPv2 Header
+ */
+struct rte_flow_item_l2tpv2 {
+ struct rte_l2tpv2_combined_msg_hdr hdr;
+};
+
+/** Default mask for RTE_FLOW_ITEM_TYPE_L2TPV2. */
+#ifndef __cplusplus
+static const struct rte_flow_item_l2tpv2 rte_flow_item_l2tpv2_mask = {
+ /*
+ * flags and version bit mask
+ * 7 6 5 4 3 2 1 0 7 6 5 4 3 2 1 0
+ * T L x x S x O P x x x x V V V V
+ */
+ .hdr = {
+ .common = {
+ .flags_version = 0xcb0f,
+ },
+ },
+};
+#endif
+
+/**
+ * @warning
+ * @b EXPERIMENTAL: this structure may change without prior notice
+ * RTE_FLOW_ITEM_TYPE_PPP
+ *
+ * Matches PPP Header
+ */
+struct rte_flow_item_ppp {
+ struct rte_ppp_hdr hdr;
+};
+
+/** Default mask for RTE_FLOW_ITEM_TYPE_PPP. */
+#ifndef __cplusplus
+static const struct rte_flow_item_ppp rte_flow_item_ppp_mask = {
+ .hdr = {
+ .addr = 0xff,
+ .ctrl = 0xff,
+ .proto_id = 0xffff,
+ }
+};
+#endif
+
/**
* Matching pattern item definition.
*
diff --git a/lib/net/rte_l2tpv2.h b/lib/net/rte_l2tpv2.h
new file mode 100644
index 0000000000..aea3c689be
--- /dev/null
+++ b/lib/net/rte_l2tpv2.h
@@ -0,0 +1,214 @@
+/* SPDX-License-Identifier: BSD-3-Clause
+ * Copyright 2021 Mellanox Technologies, Ltd
+ */
+
+#ifndef _RTE_L2TPV2_H_
+#define _RTE_L2TPV2_H_
+
+/**
+ * @file
+ *
+ * L2TP header:
+ * 0 1 2 3
+ * 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
+ * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+ * |T|L|x|x|S|x|O|P|x|x|x|x| Ver | Length (opt) |
+ * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+ * | Tunnel ID | Session ID |
+ * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+ * | Ns (opt) | Nr (opt) |
+ * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+ * | Offset Size (opt) | Offset pad... (opt)
+ * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+ *
+ * The Type (T) bit indicates the type of message. It is set to 0 for a data
+ * message and 1 for a control message.
+ *
+ * If the Length (L) bit is 1, the Length field is present. This bit MUST be
+ * set to 1 for control messages.
+ *
+ * The x bits are reserved for future extensions. All reserved bits MUST
+ * be set to 0 on outgoing messages and ignored on incoming messages.
+ *
+ * If the Sequence (S) bit is set to 1 the Ns and Nr fields are present.
+ * The S bit MUST be set to 1 for control messages.
+ *
+ * If the Offset (O) bit is 1, the Offset Size field is present. The O
+ * bit MUST be set to 0 for control messages.
+ *
+ * If the Priority (P) bit is 1, this data message should receive
+ * preferential treatment in its local queuing and transmission.
+ * The P bit MUST be set to 0 for control messages.
+ *
+ * Ver MUST be 2, indicating the version of the L2TP data message header.
+ *
+ * The Length field indicates the total length of the message in octets.
+ *
+ * Tunnel ID indicates the identifier for the control connection.
+ *
+ * Session ID indicates the identifier for a session within a tunnel.
+ *
+ * Ns indicates the sequence number for this data or control message.
+ *
+ * Nr indicates the sequence number expected in the next control message
+ * to be received.
+ *
+ * The Offset Size field, if present, specifies the number of octets
+ * past the L2TP header at which the payload data is expected to start.
+ * Actual data within the offset padding is undefined. If the offset
+ * field is present, the L2TP header ends after the last octet of the
+ * offset padding.
+ */
+
+#include <stdint.h>
+#include <rte_byteorder.h>
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+/**
+ * L2TPv2 Common Header
+ */
+RTE_STD_C11
+struct rte_l2tpv2_common_hdr {
+ union {
+ rte_be16_t flags_version;
+ struct {
+#if RTE_BYTE_ORDER == RTE_LITTLE_ENDIAN
+ rte_be16_t t:1; /**< message Type */
+ rte_be16_t l:1; /**< length option bit*/
+ rte_be16_t res1:2; /**< reserved */
+ rte_be16_t s:1; /**< ns/nr option bit*/
+ rte_be16_t res2:1; /**< reserved */
+ rte_be16_t o:1; /**< offset option bit*/
+ rte_be16_t p:1; /**< priority option bit*/
+ rte_be16_t res3:4; /**< reserved */
+ rte_be16_t ver:4; /**< protocol version */
+#elif RTE_BYTE_ORDER == RTE_BIG_ENDIAN
+ rte_be16_t ver:4; /**< protocol version */
+ rte_be16_t res3:4; /**< reserved */
+ rte_be16_t p:1; /**< priority option bit*/
+ rte_be16_t o:1; /**< offset option bit*/
+ rte_be16_t res2:1; /**< reserved */
+ rte_be16_t s:1; /**< ns/nr option bit*/
+ rte_be16_t res1:2; /**< reserved */
+ rte_be16_t l:1; /**< length option bit*/
+ rte_be16_t t:1; /**< message Type */
+#endif
+ };
+ };
+};
+
+/*
+ * L2TPv2 message Header contains all options(length, ns, nr,
+ * offset size, offset padding).
+ */
+struct rte_l2tpv2_msg_with_all_options {
+ rte_be16_t length; /**< length(16) */
+ rte_be16_t tunnel_id; /**< tunnel id(16) */
+ rte_be16_t session_id; /**< session id(16) */
+ rte_be16_t ns; /**< Ns(16) */
+ rte_be16_t nr; /**< Nr(16) */
+ rte_be16_t offset_size; /**< offset size(16) */
+ uint8_t *offset_padding; /**< offset padding(variable length) */
+};
+
+/*
+ * L2TPv2 message Header contains all options except length(ns, nr,
+ * offset size, offset padding).
+ */
+struct rte_l2tpv2_msg_without_length {
+ rte_be16_t tunnel_id; /**< tunnel id(16) */
+ rte_be16_t session_id; /**< session id(16) */
+ rte_be16_t ns; /**< Ns(16) */
+ rte_be16_t nr; /**< Nr(16) */
+ rte_be16_t offset_size; /**< offset size(16) */
+ uint8_t *offset_padding; /**< offset padding(variable length) */
+};
+
+/*
+ * L2TPv2 message Header contains all options except ns_nr(length,
+ * offset size, offset padding).
+ * Ns and Nr MUST be toghter.
+ */
+struct rte_l2tpv2_msg_without_ns_nr {
+ rte_be16_t length; /**< length(16) */
+ rte_be16_t tunnel_id; /**< tunnel id(16) */
+ rte_be16_t session_id; /**< session id(16) */
+ rte_be16_t offset_size; /**< offset size(16) */
+ uint8_t *offset_padding; /**< offset padding(variable length) */
+};
+
+/*
+ * L2TPv2 message Header contains all options except ns_nr(length, ns, nr).
+ * offset size and offset padding MUST be toghter.
+ */
+struct rte_l2tpv2_msg_without_offset {
+ rte_be16_t length; /**< length(16) */
+ rte_be16_t tunnel_id; /**< tunnel id(16) */
+ rte_be16_t session_id; /**< session id(16) */
+ rte_be16_t ns; /**< Ns(16) */
+ rte_be16_t nr; /**< Nr(16) */
+};
+
+/*
+ * L2TPv2 message Header contains options offset size and offset padding.
+ */
+struct rte_l2tpv2_msg_with_offset {
+ rte_be16_t tunnel_id; /**< tunnel id(16) */
+ rte_be16_t session_id; /**< session id(16) */
+ rte_be16_t offset_size; /**< offset size(16) */
+ uint8_t *offset_padding; /**< offset padding(variable length) */
+};
+
+/*
+ * L2TPv2 message Header contains options ns and nr.
+ */
+struct rte_l2tpv2_msg_with_ns_nr {
+ rte_be16_t tunnel_id; /**< tunnel id(16) */
+ rte_be16_t session_id; /**< session id(16) */
+ rte_be16_t ns; /**< Ns(16) */
+ rte_be16_t nr; /**< Nr(16) */
+};
+
+/*
+ * L2TPv2 message Header contains option length.
+ */
+struct rte_l2tpv2_msg_with_length {
+ rte_be16_t length; /**< length(16) */
+ rte_be16_t tunnel_id; /**< tunnel id(16) */
+ rte_be16_t session_id; /**< session id(16) */
+};
+
+/*
+ * L2TPv2 message Header without all options.
+ */
+struct rte_l2tpv2_msg_without_all_options {
+ rte_be16_t tunnel_id; /**< tunnel id(16) */
+ rte_be16_t session_id; /**< session id(16) */
+};
+
+/**
+ * L2TPv2 Combined Message Header Format: Common Header + Options
+ */
+RTE_STD_C11
+struct rte_l2tpv2_combined_msg_hdr {
+ struct rte_l2tpv2_common_hdr common;
+ union {
+ struct rte_l2tpv2_msg_with_all_options type0;
+ struct rte_l2tpv2_msg_without_length type1;
+ struct rte_l2tpv2_msg_without_ns_nr type2;
+ struct rte_l2tpv2_msg_without_offset type3;
+ struct rte_l2tpv2_msg_with_offset type4;
+ struct rte_l2tpv2_msg_with_ns_nr type5;
+ struct rte_l2tpv2_msg_with_length type6;
+ struct rte_l2tpv2_msg_without_all_options type7;
+ };
+};
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif /* _RTE_L2TPV2_H_ */
diff --git a/lib/net/rte_ppp.h b/lib/net/rte_ppp.h
new file mode 100644
index 0000000000..9ea633baa7
--- /dev/null
+++ b/lib/net/rte_ppp.h
@@ -0,0 +1,35 @@
+/* SPDX-License-Identifier: BSD-3-Clause
+ * Copyright 2021 Mellanox Technologies, Ltd
+ */
+
+#ifndef _RTE_PPP_H_
+#define _RTE_PPP_H_
+
+/**
+ * @file
+ *
+ * PPP headers definition.
+ *
+ */
+
+#include <stdint.h>
+#include <rte_byteorder.h>
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+/**
+ * PPP Header
+ */
+struct rte_ppp_hdr {
+ uint8_t addr; /**< ppp address(8) */
+ uint8_t ctrl; /**< ppp control(8) */
+ rte_be16_t proto_id; /**< ppp protocol id(16) */
+} __rte_packed;
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif /* _RTE_PPP_H_ */
--
2.25.1
