1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
|
/*
* Copyright (c) 2016 Cisco and/or its affiliates.
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at:
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
#ifndef __UDP_ENCAP_H__
#define __UDP_ENCAP_H__
#include <vnet/ip/ip.h>
#include <vnet/udp/udp.h>
#include <vnet/fib/fib_node.h>
/**
* UDP encapsualtion.
* A representation of the encapsulation of packets in UDP-over-IP.
* This is encapsulation only, there is no tunnel interface, hence
* it is uni-directional. For decap register a handler with the UDP port
* dispatcher.
*/
/**
* Fixup behaviour. Actions performed on the encap in the data-plance
*/
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_ENCAP_FIXUP_UDP_SRC_PORT_ENTROPY = (1 << 0),
} udp_encap_fixup_flags_t;
/**
* The UDP encap represenation
*/
typedef struct udp_encap_t_
{
/**
* 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
*/
union
{
struct
{
ip4_header_t ue_ip4;
udp_header_t ue_udp;
} __attribute__ ((packed)) ip4;
struct
{
ip6_header_t ue_ip6;
udp_header_t ue_udp;
} __attribute__ ((packed)) ip6;
} __attribute__ ((packed)) ue_hdrs;
/**
* Flags controlling fixup behaviour
*/
udp_encap_fixup_flags_t ue_flags;
/**
* 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
*/
fib_protocol_t ue_ip_proto;
/**
* The seond cacheline contains control-plane data
*/
CLIB_CACHE_LINE_ALIGN_MARK (cacheline1);
/**
* 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.
*/
u32 ue_id;
/**
* 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
*/
index_t ue_fib_index;
} udp_encap_t;
extern index_t udp_encap_add_and_lock (u32 id,
fib_protocol_t proto,
index_t fib_index,
const ip46_address_t * src_ip,
const ip46_address_t * dst_ip,
u16 src_port,
u16 dst_port,
udp_encap_fixup_flags_t flags);
extern index_t udp_encap_find (u32 id);
extern void udp_encap_lock (u32 id);
extern void udp_encap_unlock (u32 id);
extern u8 *format_udp_encap (u8 * s, va_list * args);
extern void udp_encap_unlock_w_index (index_t uei);
extern void udp_encap_contribute_forwarding (u32 id,
dpo_proto_t proto,
dpo_id_t * dpo);
extern void udp_encap_get_stats (index_t uei, u64 * packets, u64 * bytes);
/**
* Callback function invoked when walking all encap objects.
* Return non-zero to continue the walk.
*/
typedef walk_rc_t (*udp_encap_walk_cb_t) (index_t uei, void *ctx);
/**
* Walk each of the encap objects
*/
extern void udp_encap_walk (udp_encap_walk_cb_t cb, void *ctx);
/**
* Pool of encaps
*/
extern udp_encap_t *udp_encap_pool;
static inline udp_encap_t *
udp_encap_get (index_t uei)
{
return (pool_elt_at_index (udp_encap_pool, uei));
}
/*
* fd.io coding-style-patch-verification: ON
*
* Local Variables:
* eval: (c-set-style "gnu")
* End:
*/
#endif
|
