summaryrefslogtreecommitdiffstats
path: root/src
diff options
context:
space:
mode:
authorNeale Ranns <nranns@cisco.com>2018-08-06 09:09:24 -0400
committerNeale Ranns <nranns@cisco.com>2018-08-06 15:16:08 +0000
commit6763a1d1346aabd6ed2d8d0737e336c40c914028 (patch)
treec8b91a5f69fd17e0b4ba2adfb03a32885bec3498 /src
parent4d2eb4ca81596af26b197feb85cf48a3c23e129c (diff)
re-indent UDP encap documentation
Change-Id: Ieb53860769f511205bcd3f1605e76a80e65d4939 Signed-off-by: Neale Ranns <nranns@cisco.com>
Diffstat (limited to 'src')
-rw-r--r--src/vnet/udp/udp_encap.h65
1 files changed, 34 insertions, 31 deletions
diff --git a/src/vnet/udp/udp_encap.h b/src/vnet/udp/udp_encap.h
index e20edec7be5..e2d652775bc 100644
--- a/src/vnet/udp/udp_encap.h
+++ b/src/vnet/udp/udp_encap.h
@@ -34,9 +34,9 @@
typedef enum udp_encap_fixup_flags_t_
{
UDP_ENCAP_FIXUP_NONE = 0,
- /**
- * UDP source port contains an entropy/hash value for load-balancing by downstream peers.
- */
+ /**
+ * UDP source port contains an entropy/hash value for load-balancing by downstream peers.
+ */
UDP_ENCAP_FIXUP_UDP_SRC_PORT_ENTROPY = (1 << 0),
} udp_encap_fixup_flags_t;
@@ -45,14 +45,14 @@ typedef enum udp_encap_fixup_flags_t_
*/
typedef struct udp_encap_t_
{
- /**
- * The first cacheline contains the data used in the data-plane
- */
+ /**
+ * The first cacheline contains the data used in the data-plane
+ */
CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
- /**
- * The headers to paint, in packet painting order
- */
+ /**
+ * The headers to paint, in packet painting order
+ */
union
{
struct
@@ -67,43 +67,46 @@ typedef struct udp_encap_t_
} __attribute__ ((packed)) ip6;
} __attribute__ ((packed)) ue_hdrs;
- /**
- * Flags controlling fixup behaviour
- */
+ /**
+ * Flags controlling fixup behaviour
+ */
udp_encap_fixup_flags_t ue_flags;
- /**
- * The DPO used to forward to the next node in the VLIB graph
- */
+ /**
+ * The DPO used to forward to the next node in the VLIB graph
+ */
dpo_id_t ue_dpo;
- /**
- * the protocol of the IP header imposed
- */
+ /**
+ * the protocol of the IP header imposed
+ */
fib_protocol_t ue_ip_proto;
+ /**
+ * The seond cacheline contains control-plane data
+ */
CLIB_CACHE_LINE_ALIGN_MARK (cacheline1);
- /**
- * linkage into the FIB graph
- */
+ /**
+ * linkage into the FIB graph
+ */
fib_node_t ue_fib_node;
- /**
- * The ID given by the user/client.
- * This ID is used by the client for modifications.
- */
+ /**
+ * The ID given by the user/client.
+ * This ID is used by the client for modifications.
+ */
u32 ue_id;
- /**
- * Tracking information for the IP destination
- */
+ /**
+ * Tracking information for the IP destination
+ */
fib_node_index_t ue_fib_entry_index;
u32 ue_fib_sibling;
- /**
- * The FIB index in which the encap destination resides
- */
+ /**
+ * The FIB index in which the encap destination resides
+ */
index_t ue_fib_index;
} udp_encap_t;