2 *------------------------------------------------------------------
3 * vxlan_api.c - vxlan api
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:
10 * http://www.apache.org/licenses/LICENSE-2.0
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 *------------------------------------------------------------------
20 #include <vnet/vnet.h>
21 #include <vlibmemory/api.h>
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>
29 #include <vnet/ip/ip_types_api.h>
30 #include <vnet/udp/udp_local.h>
32 #include <vnet/vnet_msg_enum.h>
34 #define vl_typedefs /* define message structures */
35 #include <vnet/vnet_all_api_h.h>
38 #define vl_endianfun /* define message structures */
39 #include <vnet/vnet_all_api_h.h>
42 /* instantiate all the print functions we know about */
43 #define vl_print(handle, ...) vlib_cli_output (handle, __VA_ARGS__)
45 #include <vnet/vnet_all_api_h.h>
48 #include <vlibapi/api_helper_macros.h>
50 #define foreach_vpe_api_msg \
51 _ (SW_INTERFACE_SET_VXLAN_BYPASS, sw_interface_set_vxlan_bypass) \
52 _ (VXLAN_ADD_DEL_TUNNEL, vxlan_add_del_tunnel) \
53 _ (VXLAN_TUNNEL_DUMP, vxlan_tunnel_dump) \
54 _ (VXLAN_ADD_DEL_TUNNEL_V2, vxlan_add_del_tunnel_v2) \
55 _ (VXLAN_ADD_DEL_TUNNEL_V3, vxlan_add_del_tunnel_v3) \
56 _ (VXLAN_TUNNEL_V2_DUMP, vxlan_tunnel_v2_dump) \
57 _ (VXLAN_OFFLOAD_RX, vxlan_offload_rx)
60 vl_api_vxlan_offload_rx_t_handler (vl_api_vxlan_offload_rx_t * mp)
62 vl_api_vxlan_offload_rx_reply_t *rmp;
64 u32 hw_if_index = ntohl (mp->hw_if_index);
65 u32 sw_if_index = ntohl (mp->sw_if_index);
67 if (!vnet_hw_interface_is_valid (vnet_get_main (), hw_if_index))
69 rv = VNET_API_ERROR_NO_SUCH_ENTRY;
72 VALIDATE_SW_IF_INDEX (mp);
74 u32 t_index = vnet_vxlan_get_tunnel_index (sw_if_index);
77 rv = VNET_API_ERROR_INVALID_SW_IF_INDEX_2;
81 vxlan_main_t *vxm = &vxlan_main;
82 vxlan_tunnel_t *t = pool_elt_at_index (vxm->tunnels, t_index);
83 if (!ip46_address_is_ip4 (&t->dst))
85 rv = VNET_API_ERROR_INVALID_ADDRESS_FAMILY;
89 vnet_main_t *vnm = vnet_get_main ();
90 vnet_hw_interface_t *hw_if = vnet_get_hw_interface (vnm, hw_if_index);
91 ip4_main_t *im = &ip4_main;
93 vec_elt (im->fib_index_by_sw_if_index, hw_if->sw_if_index);
95 if (t->encap_fib_index != rx_fib_index)
97 rv = VNET_API_ERROR_NO_SUCH_FIB;
101 if (vnet_vxlan_add_del_rx_flow (hw_if_index, t_index, mp->enable))
103 rv = VNET_API_ERROR_UNSPECIFIED;
106 BAD_SW_IF_INDEX_LABEL;
109 REPLY_MACRO (VL_API_VXLAN_OFFLOAD_RX_REPLY);
113 vl_api_sw_interface_set_vxlan_bypass_t_handler
114 (vl_api_sw_interface_set_vxlan_bypass_t * mp)
116 vl_api_sw_interface_set_vxlan_bypass_reply_t *rmp;
118 u32 sw_if_index = ntohl (mp->sw_if_index);
120 VALIDATE_SW_IF_INDEX (mp);
122 vnet_int_vxlan_bypass_mode (sw_if_index, mp->is_ipv6, mp->enable);
123 BAD_SW_IF_INDEX_LABEL;
125 REPLY_MACRO (VL_API_SW_INTERFACE_SET_VXLAN_BYPASS_REPLY);
129 vxlan_add_del_tunnel_clean_input (vnet_vxlan_add_del_tunnel_args_t *a,
132 a->is_ip6 = !ip46_address_is_ip4 (&a->src);
134 a->encap_fib_index = fib_table_find (fib_ip_proto (a->is_ip6), encap_vrf_id);
135 if (a->encap_fib_index == ~0)
137 return VNET_API_ERROR_NO_SUCH_FIB;
140 if (ip46_address_is_ip4 (&a->src) != ip46_address_is_ip4 (&a->dst))
142 return VNET_API_ERROR_INVALID_VALUE;
145 /* Check src & dst are different */
146 if (ip46_address_cmp (&a->dst, &a->src) == 0)
148 return VNET_API_ERROR_SAME_SRC_DST;
150 if (ip46_address_is_multicast (&a->dst) &&
151 !vnet_sw_if_index_is_api_valid (a->mcast_sw_if_index))
153 return VNET_API_ERROR_INVALID_SW_IF_INDEX;
159 vl_api_vxlan_add_del_tunnel_t_handler (vl_api_vxlan_add_del_tunnel_t *mp)
161 vl_api_vxlan_add_del_tunnel_reply_t *rmp;
162 u32 sw_if_index = ~0;
165 vnet_vxlan_add_del_tunnel_args_t a = {
166 .is_add = mp->is_add,
167 .instance = ntohl (mp->instance),
168 .mcast_sw_if_index = ntohl (mp->mcast_sw_if_index),
169 .decap_next_index = ntohl (mp->decap_next_index),
170 .vni = ntohl (mp->vni),
172 ip_address_decode (&mp->src_address, &a.src);
173 ip_address_decode (&mp->dst_address, &a.dst);
175 rv = vxlan_add_del_tunnel_clean_input (&a, ntohl (mp->encap_vrf_id));
178 a.dst_port = a.is_ip6 ? UDP_DST_PORT_vxlan6 : UDP_DST_PORT_vxlan,
179 a.src_port = a.is_ip6 ? UDP_DST_PORT_vxlan6 : UDP_DST_PORT_vxlan,
180 rv = vnet_vxlan_add_del_tunnel (&a, &sw_if_index);
183 REPLY_MACRO2(VL_API_VXLAN_ADD_DEL_TUNNEL_REPLY,
185 rmp->sw_if_index = ntohl (sw_if_index);
190 vl_api_vxlan_add_del_tunnel_v2_t_handler (vl_api_vxlan_add_del_tunnel_v2_t *mp)
192 vl_api_vxlan_add_del_tunnel_v2_reply_t *rmp;
193 u32 sw_if_index = ~0;
196 vnet_vxlan_add_del_tunnel_args_t a = {
197 .is_add = mp->is_add,
198 .instance = ntohl (mp->instance),
199 .mcast_sw_if_index = ntohl (mp->mcast_sw_if_index),
200 .decap_next_index = ntohl (mp->decap_next_index),
201 .vni = ntohl (mp->vni),
202 .dst_port = ntohs (mp->dst_port),
203 .src_port = ntohs (mp->src_port),
206 ip_address_decode (&mp->src_address, &a.src);
207 ip_address_decode (&mp->dst_address, &a.dst);
209 rv = vxlan_add_del_tunnel_clean_input (&a, ntohl (mp->encap_vrf_id));
212 rv = vnet_vxlan_add_del_tunnel (&a, &sw_if_index);
214 REPLY_MACRO2 (VL_API_VXLAN_ADD_DEL_TUNNEL_V2_REPLY,
215 ({ rmp->sw_if_index = ntohl (sw_if_index); }));
219 vl_api_vxlan_add_del_tunnel_v3_t_handler (vl_api_vxlan_add_del_tunnel_v3_t *mp)
221 vl_api_vxlan_add_del_tunnel_v3_reply_t *rmp;
222 u32 sw_if_index = ~0;
225 vnet_vxlan_add_del_tunnel_args_t a = {
226 .is_add = mp->is_add,
227 .instance = ntohl (mp->instance),
228 .mcast_sw_if_index = ntohl (mp->mcast_sw_if_index),
229 .decap_next_index = ntohl (mp->decap_next_index),
230 .vni = ntohl (mp->vni),
231 .dst_port = ntohs (mp->dst_port),
232 .src_port = ntohs (mp->src_port),
236 ip_address_decode (&mp->src_address, &a.src);
237 ip_address_decode (&mp->dst_address, &a.dst);
239 rv = vxlan_add_del_tunnel_clean_input (&a, ntohl (mp->encap_vrf_id));
242 rv = vnet_vxlan_add_del_tunnel (&a, &sw_if_index);
244 REPLY_MACRO2 (VL_API_VXLAN_ADD_DEL_TUNNEL_V3_REPLY,
245 ({ rmp->sw_if_index = ntohl (sw_if_index); }));
248 static void send_vxlan_tunnel_details
249 (vxlan_tunnel_t * t, vl_api_registration_t * reg, u32 context)
251 vl_api_vxlan_tunnel_details_t *rmp;
252 ip4_main_t *im4 = &ip4_main;
253 ip6_main_t *im6 = &ip6_main;
255 rmp = vl_msg_api_alloc (sizeof (*rmp));
256 clib_memset (rmp, 0, sizeof (*rmp));
257 rmp->_vl_msg_id = ntohs (VL_API_VXLAN_TUNNEL_DETAILS);
259 ip_address_encode (&t->src, IP46_TYPE_ANY, &rmp->src_address);
260 ip_address_encode (&t->dst, IP46_TYPE_ANY, &rmp->dst_address);
262 if (ip46_address_is_ip4 (&t->dst))
263 rmp->encap_vrf_id = htonl (im4->fibs[t->encap_fib_index].ft_table_id);
265 rmp->encap_vrf_id = htonl (im6->fibs[t->encap_fib_index].ft_table_id);
267 rmp->instance = htonl (t->user_instance);
268 rmp->mcast_sw_if_index = htonl (t->mcast_sw_if_index);
269 rmp->vni = htonl (t->vni);
270 rmp->decap_next_index = htonl (t->decap_next_index);
271 rmp->sw_if_index = htonl (t->sw_if_index);
272 rmp->context = context;
274 vl_api_send_msg (reg, (u8 *) rmp);
277 static void vl_api_vxlan_tunnel_dump_t_handler
278 (vl_api_vxlan_tunnel_dump_t * mp)
280 vl_api_registration_t *reg;
281 vxlan_main_t *vxm = &vxlan_main;
285 reg = vl_api_client_index_to_registration (mp->client_index);
289 sw_if_index = ntohl (mp->sw_if_index);
291 if (~0 == sw_if_index)
293 pool_foreach (t, vxm->tunnels)
294 send_vxlan_tunnel_details(t, reg, mp->context);
298 if ((sw_if_index >= vec_len (vxm->tunnel_index_by_sw_if_index)) ||
299 (~0 == vxm->tunnel_index_by_sw_if_index[sw_if_index]))
303 t = &vxm->tunnels[vxm->tunnel_index_by_sw_if_index[sw_if_index]];
304 send_vxlan_tunnel_details (t, reg, mp->context);
309 send_vxlan_tunnel_v2_details (vxlan_tunnel_t *t, vl_api_registration_t *reg,
312 vl_api_vxlan_tunnel_v2_details_t *rmp;
313 ip4_main_t *im4 = &ip4_main;
314 ip6_main_t *im6 = &ip6_main;
316 rmp = vl_msg_api_alloc (sizeof (*rmp));
317 clib_memset (rmp, 0, sizeof (*rmp));
318 rmp->_vl_msg_id = ntohs (VL_API_VXLAN_TUNNEL_V2_DETAILS);
320 ip_address_encode (&t->src, IP46_TYPE_ANY, &rmp->src_address);
321 ip_address_encode (&t->dst, IP46_TYPE_ANY, &rmp->dst_address);
322 rmp->src_port = htons (t->src_port);
323 rmp->dst_port = htons (t->dst_port);
325 if (ip46_address_is_ip4 (&t->dst))
326 rmp->encap_vrf_id = htonl (im4->fibs[t->encap_fib_index].ft_table_id);
328 rmp->encap_vrf_id = htonl (im6->fibs[t->encap_fib_index].ft_table_id);
330 rmp->instance = htonl (t->user_instance);
331 rmp->mcast_sw_if_index = htonl (t->mcast_sw_if_index);
332 rmp->vni = htonl (t->vni);
333 rmp->decap_next_index = htonl (t->decap_next_index);
334 rmp->sw_if_index = htonl (t->sw_if_index);
335 rmp->context = context;
337 vl_api_send_msg (reg, (u8 *) rmp);
341 vl_api_vxlan_tunnel_v2_dump_t_handler (vl_api_vxlan_tunnel_v2_dump_t *mp)
343 vl_api_registration_t *reg;
344 vxlan_main_t *vxm = &vxlan_main;
348 reg = vl_api_client_index_to_registration (mp->client_index);
352 sw_if_index = ntohl (mp->sw_if_index);
354 if (~0 == sw_if_index)
356 pool_foreach (t, vxm->tunnels)
357 send_vxlan_tunnel_v2_details (t, reg, mp->context);
361 if ((sw_if_index >= vec_len (vxm->tunnel_index_by_sw_if_index)) ||
362 (~0 == vxm->tunnel_index_by_sw_if_index[sw_if_index]))
366 t = &vxm->tunnels[vxm->tunnel_index_by_sw_if_index[sw_if_index]];
367 send_vxlan_tunnel_v2_details (t, reg, mp->context);
373 * Add vpe's API message handlers to the table.
374 * vlib has already mapped shared memory and
375 * added the client registration handlers.
376 * See .../vlib-api/vlibmemory/memclnt_vlib.c:memclnt_process()
378 #define vl_msg_name_crc_list
379 #include <vnet/vnet_all_api_h.h>
380 #undef vl_msg_name_crc_list
383 setup_message_id_table (api_main_t * am)
385 #define _(id,n,crc) vl_msg_api_add_msg_name_crc (am, #n "_" #crc, id);
386 foreach_vl_msg_name_crc_vxlan;
390 static clib_error_t *
391 vxlan_api_hookup (vlib_main_t * vm)
393 api_main_t *am = vlibapi_get_main ();
396 vl_msg_api_set_handlers(VL_API_##N, #n, \
397 vl_api_##n##_t_handler, \
399 vl_api_##n##_t_endian, \
400 vl_api_##n##_t_print, \
401 sizeof(vl_api_##n##_t), 1);
405 am->api_trace_cfg[VL_API_VXLAN_ADD_DEL_TUNNEL].size += 16 * sizeof (u32);
408 * Set up the (msg_name, crc, message-id) table
410 setup_message_id_table (am);
415 VLIB_API_INIT_FUNCTION (vxlan_api_hookup);
418 * fd.io coding-style-patch-verification: ON
421 * eval: (c-set-style "gnu")