FD.io VPP  v21.01.1
Vector Packet Processing
vxlan_api.c
Go to the documentation of this file.
1 /*
2  *------------------------------------------------------------------
3  * vxlan_api.c - vxlan api
4  *
5  * Copyright (c) 2016 Cisco and/or its affiliates.
6  * Licensed under the Apache License, Version 2.0 (the "License");
7  * you may not use this file except in compliance with the License.
8  * You may obtain a copy of the License at:
9  *
10  * http://www.apache.org/licenses/LICENSE-2.0
11  *
12  * Unless required by applicable law or agreed to in writing, software
13  * distributed under the License is distributed on an "AS IS" BASIS,
14  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15  * See the License for the specific language governing permissions and
16  * limitations under the License.
17  *------------------------------------------------------------------
18  */
19 
20 #include <vnet/vnet.h>
21 #include <vlibmemory/api.h>
22 
23 #include <vnet/interface.h>
24 #include <vnet/api_errno.h>
25 #include <vnet/feature/feature.h>
26 #include <vnet/vxlan/vxlan.h>
27 #include <vnet/fib/fib_table.h>
28 
29 #include <vnet/ip/ip_types_api.h>
30 
31 #include <vnet/vnet_msg_enum.h>
32 
33 #define vl_typedefs /* define message structures */
34 #include <vnet/vnet_all_api_h.h>
35 #undef vl_typedefs
36 
37 #define vl_endianfun /* define message structures */
38 #include <vnet/vnet_all_api_h.h>
39 #undef vl_endianfun
40 
41 /* instantiate all the print functions we know about */
42 #define vl_print(handle, ...) vlib_cli_output (handle, __VA_ARGS__)
43 #define vl_printfun
44 #include <vnet/vnet_all_api_h.h>
45 #undef vl_printfun
46 
48 
49 #define foreach_vpe_api_msg \
50 _(SW_INTERFACE_SET_VXLAN_BYPASS, sw_interface_set_vxlan_bypass) \
51 _(VXLAN_ADD_DEL_TUNNEL, vxlan_add_del_tunnel) \
52 _(VXLAN_TUNNEL_DUMP, vxlan_tunnel_dump) \
53 _(VXLAN_OFFLOAD_RX, vxlan_offload_rx)
54 
55 static void
57 {
58  vl_api_vxlan_offload_rx_reply_t *rmp;
59  int rv = 0;
60  u32 hw_if_index = ntohl (mp->hw_if_index);
61  u32 sw_if_index = ntohl (mp->sw_if_index);
62 
63  if (!vnet_hw_interface_is_valid (vnet_get_main (), hw_if_index))
64  {
65  rv = VNET_API_ERROR_NO_SUCH_ENTRY;
66  goto err;
67  }
69 
70  u32 t_index = vnet_vxlan_get_tunnel_index (sw_if_index);
71  if (t_index == ~0)
72  {
73  rv = VNET_API_ERROR_INVALID_SW_IF_INDEX_2;
74  goto err;
75  }
76 
77  vxlan_main_t *vxm = &vxlan_main;
78  vxlan_tunnel_t *t = pool_elt_at_index (vxm->tunnels, t_index);
79  if (!ip46_address_is_ip4 (&t->dst))
80  {
81  rv = VNET_API_ERROR_INVALID_ADDRESS_FAMILY;
82  goto err;
83  }
84 
85  vnet_main_t *vnm = vnet_get_main ();
86  vnet_hw_interface_t *hw_if = vnet_get_hw_interface (vnm, hw_if_index);
87  ip4_main_t *im = &ip4_main;
88  u32 rx_fib_index =
90 
91  if (t->encap_fib_index != rx_fib_index)
92  {
93  rv = VNET_API_ERROR_NO_SUCH_FIB;
94  goto err;
95  }
96 
97  if (vnet_vxlan_add_del_rx_flow (hw_if_index, t_index, mp->enable))
98  {
99  rv = VNET_API_ERROR_UNSPECIFIED;
100  goto err;
101  }
103 err:
104 
105  REPLY_MACRO (VL_API_VXLAN_OFFLOAD_RX_REPLY);
106 }
107 
108 static void
111 {
112  vl_api_sw_interface_set_vxlan_bypass_reply_t *rmp;
113  int rv = 0;
114  u32 sw_if_index = ntohl (mp->sw_if_index);
115 
117 
118  vnet_int_vxlan_bypass_mode (sw_if_index, mp->is_ipv6, mp->enable);
120 
121  REPLY_MACRO (VL_API_SW_INTERFACE_SET_VXLAN_BYPASS_REPLY);
122 }
123 
126 {
128  int rv = 0;
129  bool is_ipv6;
130  u32 fib_index;
131  ip46_address_t src, dst;
132 
133  ip_address_decode (&mp->src_address, &src);
134  ip_address_decode (&mp->dst_address, &dst);
135 
136  if (ip46_address_is_ip4 (&src) != ip46_address_is_ip4 (&dst))
137  {
138  rv = VNET_API_ERROR_INVALID_VALUE;
139  goto out;
140  }
141 
142  is_ipv6 = !ip46_address_is_ip4 (&src);
143 
144  fib_index = fib_table_find (fib_ip_proto (is_ipv6),
145  ntohl (mp->encap_vrf_id));
146  if (fib_index == ~0)
147  {
148  rv = VNET_API_ERROR_NO_SUCH_FIB;
149  goto out;
150  }
151 
153  .is_add = mp->is_add,
154  .is_ip6 = is_ipv6,
155  .instance = ntohl (mp->instance),
156  .mcast_sw_if_index = ntohl (mp->mcast_sw_if_index),
157  .encap_fib_index = fib_index,
158  .decap_next_index = ntohl (mp->decap_next_index),
159  .vni = ntohl (mp->vni),
160  .dst = dst,
161  .src = src,
162  };
163 
164  /* Check src & dst are different */
165  if (ip46_address_cmp (&a.dst, &a.src) == 0)
166  {
167  rv = VNET_API_ERROR_SAME_SRC_DST;
168  goto out;
169  }
170  if (ip46_address_is_multicast (&a.dst) &&
172  {
173  rv = VNET_API_ERROR_INVALID_SW_IF_INDEX;
174  goto out;
175  }
176 
177  u32 sw_if_index = ~0;
178  rv = vnet_vxlan_add_del_tunnel (&a, &sw_if_index);
179 
180 out:
181  /* *INDENT-OFF* */
182  REPLY_MACRO2(VL_API_VXLAN_ADD_DEL_TUNNEL_REPLY,
183  ({
184  rmp->sw_if_index = ntohl (sw_if_index);
185  }));
186  /* *INDENT-ON* */
187 }
188 
189 static void send_vxlan_tunnel_details
191 {
193  ip4_main_t *im4 = &ip4_main;
194  ip6_main_t *im6 = &ip6_main;
195 
196  rmp = vl_msg_api_alloc (sizeof (*rmp));
197  clib_memset (rmp, 0, sizeof (*rmp));
198  rmp->_vl_msg_id = ntohs (VL_API_VXLAN_TUNNEL_DETAILS);
199 
202 
203  if (ip46_address_is_ip4 (&t->dst))
204  rmp->encap_vrf_id = htonl (im4->fibs[t->encap_fib_index].ft_table_id);
205  else
206  rmp->encap_vrf_id = htonl (im6->fibs[t->encap_fib_index].ft_table_id);
207 
208  rmp->instance = htonl (t->user_instance);
209  rmp->mcast_sw_if_index = htonl (t->mcast_sw_if_index);
210  rmp->vni = htonl (t->vni);
211  rmp->decap_next_index = htonl (t->decap_next_index);
212  rmp->sw_if_index = htonl (t->sw_if_index);
213  rmp->context = context;
214 
215  vl_api_send_msg (reg, (u8 *) rmp);
216 }
217 
220 {
222  vxlan_main_t *vxm = &vxlan_main;
223  vxlan_tunnel_t *t;
225 
227  if (!reg)
228  return;
229 
230  sw_if_index = ntohl (mp->sw_if_index);
231 
232  if (~0 == sw_if_index)
233  {
234  /* *INDENT-OFF* */
235  pool_foreach (t, vxm->tunnels)
236  {
237  send_vxlan_tunnel_details(t, reg, mp->context);
238  }
239  /* *INDENT-ON* */
240  }
241  else
242  {
243  if ((sw_if_index >= vec_len (vxm->tunnel_index_by_sw_if_index)) ||
244  (~0 == vxm->tunnel_index_by_sw_if_index[sw_if_index]))
245  {
246  return;
247  }
249  send_vxlan_tunnel_details (t, reg, mp->context);
250  }
251 }
252 
253 /*
254  * vpe_api_hookup
255  * Add vpe's API message handlers to the table.
256  * vlib has already mapped shared memory and
257  * added the client registration handlers.
258  * See .../vlib-api/vlibmemory/memclnt_vlib.c:memclnt_process()
259  */
260 #define vl_msg_name_crc_list
261 #include <vnet/vnet_all_api_h.h>
262 #undef vl_msg_name_crc_list
263 
264 static void
266 {
267 #define _(id,n,crc) vl_msg_api_add_msg_name_crc (am, #n "_" #crc, id);
268  foreach_vl_msg_name_crc_vxlan;
269 #undef _
270 }
271 
272 static clib_error_t *
274 {
275  api_main_t *am = vlibapi_get_main ();
276 
277 #define _(N,n) \
278  vl_msg_api_set_handlers(VL_API_##N, #n, \
279  vl_api_##n##_t_handler, \
280  vl_noop_handler, \
281  vl_api_##n##_t_endian, \
282  vl_api_##n##_t_print, \
283  sizeof(vl_api_##n##_t), 1);
285 #undef _
286 
287  am->api_trace_cfg[VL_API_VXLAN_ADD_DEL_TUNNEL].size += 16 * sizeof (u32);
288 
289  /*
290  * Set up the (msg_name, crc, message-id) table
291  */
293 
294  return 0;
295 }
296 
298 
299 /*
300  * fd.io coding-style-patch-verification: ON
301  *
302  * Local Variables:
303  * eval: (c-set-style "gnu")
304  * End:
305  */
vl_api_interface_index_t sw_if_index
Definition: vxlan.api:58
u32 user_instance
Definition: vxlan.h:131
static void vl_api_sw_interface_set_vxlan_bypass_t_handler(vl_api_sw_interface_set_vxlan_bypass_t *mp)
Definition: vxlan_api.c:110
static uword ip46_address_is_multicast(const ip46_address_t *a)
Definition: ip46_address.h:154
a
Definition: bitmap.h:544
#define ntohs(x)
Definition: af_xdp.bpf.c:29
vnet_main_t * vnet_get_main(void)
Definition: misc.c:46
#define pool_foreach(VAR, POOL)
Iterate through pool.
Definition: pool.h:527
int size
for sanity checking
Definition: api_common.h:83
#define REPLY_MACRO2(t, body)
clib_memset(h->entries, 0, sizeof(h->entries[0]) *entries)
Interface set vxlan-bypass request.
Definition: vxlan.api:81
bool is_add[default=true]
Definition: vxlan.api:37
static void vl_api_send_msg(vl_api_registration_t *rp, u8 *elem)
Definition: api.h:35
ip46_address_t dst
Definition: vxlan.h:94
static vnet_hw_interface_t * vnet_get_hw_interface(vnet_main_t *vnm, u32 hw_if_index)
#define foreach_vpe_api_msg
Definition: vxlan_api.c:49
vl_api_address_t src
Definition: gre.api:54
static void setup_message_id_table(api_main_t *am)
Definition: vxlan_api.c:265
vlib_main_t * vm
Definition: in2out_ed.c:1580
u32 * fib_index_by_sw_if_index
Table index indexed by software interface.
Definition: ip4.h:123
static u8 ip46_address_is_ip4(const ip46_address_t *ip46)
Definition: ip46_address.h:55
void * vl_msg_api_alloc(int nbytes)
vl_api_address_t src_address
Definition: vxlan.api:39
unsigned char u8
Definition: types.h:56
trace_cfg_t * api_trace_cfg
Current trace configuration.
Definition: api_common.h:277
static int ip46_address_cmp(const ip46_address_t *ip46_1, const ip46_address_t *ip46_2)
Definition: ip46_address.h:80
VLIB_API_INIT_FUNCTION(vxlan_api_hookup)
static void vl_api_vxlan_add_del_tunnel_t_handler(vl_api_vxlan_add_del_tunnel_t *mp)
Definition: vxlan_api.c:125
unsigned int u32
Definition: types.h:88
u32 fib_table_find(fib_protocol_t proto, u32 table_id)
Get the index of the FIB for a Table-ID.
Definition: fib_table.c:1106
ip46_type_t ip_address_decode(const vl_api_address_t *in, ip46_address_t *out)
Decode/Encode for struct/union types.
Definition: ip_types_api.c:186
vl_api_interface_index_t mcast_sw_if_index
Definition: vxlan.api:68
static clib_error_t * vxlan_api_hookup(vlib_main_t *vm)
Definition: vxlan_api.c:273
vl_api_address_t src_address
Definition: vxlan.api:66
#define pool_elt_at_index(p, i)
Returns pointer to element at given index.
Definition: pool.h:546
vxlan_main_t vxlan_main
Definition: vxlan.c:45
#define REPLY_MACRO(t)
ip6_main_t ip6_main
Definition: ip6_forward.c:2785
vl_api_address_t dst
Definition: gre.api:55
vl_api_interface_index_t sw_if_index
Definition: vxlan.api:51
vl_api_interface_index_t sw_if_index
Definition: vxlan.api:102
API main structure, used by both vpp and binary API clients.
Definition: api_common.h:227
int vnet_vxlan_add_del_rx_flow(u32 hw_if_index, u32 t_index, int is_add)
Definition: vxlan.c:1099
An API client registration, only in vpp/vlib.
Definition: api_common.h:47
#define BAD_SW_IF_INDEX_LABEL
int vnet_vxlan_add_del_tunnel(vnet_vxlan_add_del_tunnel_args_t *a, u32 *sw_if_indexp)
Definition: vxlan.c:340
Offload vxlan rx request.
Definition: vxlan.api:97
static uword vnet_sw_if_index_is_api_valid(u32 sw_if_index)
vl_api_interface_index_t sw_if_index
Definition: vxlan.api:85
u32 ft_table_id
Table ID (hash key) for this FIB.
Definition: fib_table.h:92
u32 mcast_sw_if_index
Definition: vxlan.h:97
Create or delete a VXLAN tunnel.
Definition: vxlan.api:33
static vl_api_registration_t * vl_api_client_index_to_registration(u32 index)
Definition: api.h:79
static uword vnet_hw_interface_is_valid(vnet_main_t *vnm, u32 hw_if_index)
vl_api_address_t dst_address
Definition: vxlan.api:67
bool enable[default=true]
Definition: vxlan.api:103
IPv4 main type.
Definition: ip4.h:107
vl_api_interface_index_t hw_if_index
Definition: vxlan.api:101
u32 sw_if_index
Definition: vxlan.h:106
u32 vnet_vxlan_get_tunnel_index(u32 sw_if_index)
Definition: vxlan.c:1138
#define vec_elt(v, i)
Get vector value at index i.
void vnet_int_vxlan_bypass_mode(u32 sw_if_index, u8 is_ip6, u8 is_enable)
Definition: vxlan.c:903
#define vec_len(v)
Number of elements in vector (rvalue-only, NULL tolerant)
static fib_protocol_t fib_ip_proto(bool is_ip6)
Convert from boolean is_ip6 to FIB protocol.
Definition: fib_types.h:79
u32 encap_fib_index
Definition: vxlan.h:103
u16 decap_next_index
Definition: vxlan.h:100
u32 * tunnel_index_by_sw_if_index
Definition: vxlan.h:173
void ip_address_encode(const ip46_address_t *in, ip46_type_t type, vl_api_address_t *out)
Definition: ip_types_api.c:220
static void vl_api_vxlan_tunnel_dump_t_handler(vl_api_vxlan_tunnel_dump_t *mp)
Definition: vxlan_api.c:219
static api_main_t * vlibapi_get_main(void)
Definition: api_common.h:389
vl_api_interface_index_t sw_if_index
Definition: vxlan.api:64
ip4_main_t ip4_main
Global ip4 main structure.
Definition: ip4_forward.c:1105
struct fib_table_t_ * fibs
Vector of FIBs.
Definition: ip4.h:112
static void send_vxlan_tunnel_details(vxlan_tunnel_t *t, vl_api_registration_t *reg, u32 context)
Definition: vxlan_api.c:190
bool is_ipv6
Definition: dhcp.api:202
struct fib_table_t_ * fibs
Definition: ip6.h:115
vxlan_tunnel_t * tunnels
Definition: vxlan.h:159
vl_api_interface_index_t mcast_sw_if_index
Definition: vxlan.api:41
vl_api_interface_index_t sw_if_index
Definition: wireguard.api:34
ip46_address_t src
Definition: vxlan.h:93
#define VALIDATE_SW_IF_INDEX(mp)
static void vl_api_vxlan_offload_rx_t_handler(vl_api_vxlan_offload_rx_t *mp)
Definition: vxlan_api.c:56
vl_api_address_t dst_address
Definition: vxlan.api:40