2 * nsh_api.c - nsh mapping api
4 * Copyright (c) 2019 Cisco and/or its affiliates.
5 * Licensed under the Apache License, Version 2.0 (the "License");
6 * you may not use this file except in compliance with the License.
7 * You may obtain a copy of the License at:
9 * http://www.apache.org/licenses/LICENSE-2.0
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
17 #include <vnet/vnet.h>
18 #include <vnet/plugin/plugin.h>
21 #include <vlibapi/api.h>
22 #include <vlibmemory/api.h>
23 #include <vpp/app/version.h>
25 /* define message IDs */
26 #define vl_msg_id(n,h) n,
29 #include <nsh/nsh.api.h>
30 /* We'll want to know how many messages IDs we need... */
31 VL_MSG_FIRST_AVAILABLE,
35 /* define message structures */
37 #include <nsh/nsh.api.h>
40 /* define generated endian-swappers */
42 #include <nsh/nsh.api.h>
45 /* instantiate all the print functions we know about */
46 #define vl_print(handle, ...) vlib_cli_output (handle, __VA_ARGS__)
48 #include <nsh/nsh.api.h>
51 /* Get the API version number */
52 #define vl_api_version(n,v) static u32 api_version=(v);
53 #include <nsh/nsh.api.h>
56 #define vl_msg_name_crc_list
57 #include <nsh/nsh.api.h>
58 #undef vl_msg_name_crc_list
60 #define REPLY_MSG_ID_BASE nm->msg_id_base
61 #include <vlibapi/api_helper_macros.h>
63 /* List of message types that this plugin understands */
65 #define foreach_nsh_plugin_api_msg \
66 _(NSH_ADD_DEL_ENTRY, nsh_add_del_entry) \
67 _(NSH_ENTRY_DUMP, nsh_entry_dump) \
68 _(NSH_ADD_DEL_MAP, nsh_add_del_map) \
69 _(NSH_MAP_DUMP, nsh_map_dump)
72 * @brief CLI function for NSH admin up/down
82 nsh_interface_admin_up_down (vnet_main_t * vnm, u32 nsh_hw_if, u32 flags)
84 if (flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP)
85 vnet_hw_interface_set_flags (vnm, nsh_hw_if,
86 VNET_HW_INTERFACE_FLAG_LINK_UP);
88 vnet_hw_interface_set_flags (vnm, nsh_hw_if, 0);
94 * @brief Naming for NSH tunnel
96 * @param *s formatting string
99 * @return *s formatted string
103 format_nsh_name (u8 * s, va_list * args)
105 u32 dev_instance = va_arg (*args, u32);
106 return format (s, "nsh_tunnel%d", dev_instance);
110 VNET_DEVICE_CLASS (nsh_device_class, static) = {
112 .format_device_name = format_nsh_name,
113 .admin_up_down_function = nsh_interface_admin_up_down,
117 static void send_nsh_entry_details
118 (nsh_entry_t * t, vl_api_registration_t * rp, u32 context)
120 vl_api_nsh_entry_details_t *rmp;
121 nsh_main_t *nm = &nsh_main;
123 rmp = vl_msg_api_alloc (sizeof (*rmp));
124 clib_memset (rmp, 0, sizeof (*rmp));
126 rmp->_vl_msg_id = ntohs ((VL_API_NSH_ENTRY_DETAILS) + nm->msg_id_base);
127 rmp->ver_o_c = t->nsh_base.ver_o_c;
128 rmp->ttl = (t->nsh_base.ver_o_c & NSH_TTL_H4_MASK) << 2 |
129 (t->nsh_base.length & NSH_TTL_L2_MASK) >> 6;
130 rmp->length = t->nsh_base.length & NSH_LEN_MASK;
131 rmp->md_type = t->nsh_base.md_type;
132 rmp->next_protocol = t->nsh_base.next_protocol;
133 rmp->nsp_nsi = htonl (t->nsh_base.nsp_nsi);
135 if (t->nsh_base.md_type == 1)
138 rmp->c1 = htonl (t->md.md1_data.c1);
139 rmp->c2 = htonl (t->md.md1_data.c2);
140 rmp->c3 = htonl (t->md.md1_data.c3);
141 rmp->c4 = htonl (t->md.md1_data.c4);
143 else if (t->nsh_base.md_type == 2)
145 rmp->tlv_length = t->tlvs_len;
146 clib_memcpy (rmp->tlv, t->tlvs_data, t->tlvs_len);
149 rmp->context = context;
151 vl_api_send_msg (rp, (u8 *) rmp);
154 static void send_nsh_map_details
155 (nsh_map_t * t, vl_api_registration_t * rp, u32 context)
157 vl_api_nsh_map_details_t *rmp;
158 nsh_main_t *nm = &nsh_main;
160 rmp = vl_msg_api_alloc (sizeof (*rmp));
161 clib_memset (rmp, 0, sizeof (*rmp));
163 rmp->_vl_msg_id = ntohs ((VL_API_NSH_MAP_DETAILS) + nm->msg_id_base);
164 rmp->nsp_nsi = htonl (t->nsp_nsi);
165 rmp->mapped_nsp_nsi = htonl (t->mapped_nsp_nsi);
166 rmp->nsh_action = htonl (t->nsh_action);
167 rmp->sw_if_index = htonl (t->sw_if_index);
168 rmp->rx_sw_if_index = htonl (t->rx_sw_if_index);
169 rmp->next_node = htonl (t->next_node);
171 rmp->context = context;
173 vl_api_send_msg (rp, (u8 *) rmp);
177 vl_api_nsh_map_dump_t_handler (vl_api_nsh_map_dump_t * mp)
179 nsh_main_t *nm = &nsh_main;
182 vl_api_registration_t *rp;
184 rp = vl_api_client_index_to_registration (mp->client_index);
188 map_index = ntohl (mp->map_index);
192 pool_foreach (t, nm->nsh_mappings, (
194 send_nsh_map_details (t, rp,
201 if (map_index >= vec_len (nm->nsh_mappings))
205 t = &nm->nsh_mappings[map_index];
206 send_nsh_map_details (t, rp, mp->context);
210 /** API message handler */
212 vl_api_nsh_add_del_map_t_handler (vl_api_nsh_add_del_map_t * mp)
214 vl_api_nsh_add_del_map_reply_t *rmp;
215 nsh_main_t *nm = &nsh_main;
217 nsh_add_del_map_args_t _a, *a = &_a;
220 a->is_add = mp->is_add;
221 a->map.nsp_nsi = ntohl (mp->nsp_nsi);
222 a->map.mapped_nsp_nsi = ntohl (mp->mapped_nsp_nsi);
223 a->map.nsh_action = ntohl (mp->nsh_action);
224 a->map.sw_if_index = ntohl (mp->sw_if_index);
225 a->map.rx_sw_if_index = ntohl (mp->rx_sw_if_index);
226 a->map.next_node = ntohl (mp->next_node);
228 rv = nsh_add_del_map (a, &map_index);
230 if ((a->map.next_node == NSH_NODE_NEXT_ENCAP_VXLAN4)
231 | (a->map.next_node == NSH_NODE_NEXT_ENCAP_VXLAN6))
233 rv = nsh_add_del_proxy_session (a);
236 REPLY_MACRO2 (VL_API_NSH_ADD_DEL_MAP_REPLY, (
245 nsh_header_rewrite (nsh_entry_t * nsh_entry)
249 nsh_base_header_t *nsh_base;
250 nsh_md1_data_t *nsh_md1;
251 nsh_main_t *nm = &nsh_main;
252 nsh_md2_data_t *opt0;
253 nsh_md2_data_t *limit0;
254 nsh_md2_data_t *nsh_md2;
255 nsh_option_map_t _nsh_option, *nsh_option = &_nsh_option;
256 u8 old_option_size = 0;
257 u8 new_option_size = 0;
259 vec_free (nsh_entry->rewrite);
260 if (nsh_entry->nsh_base.md_type == 1)
262 len = sizeof (nsh_base_header_t) + sizeof (nsh_md1_data_t);
264 else if (nsh_entry->nsh_base.md_type == 2)
266 /* set to maxim, maybe dataplane will add more TLVs */
267 len = MAX_NSH_HEADER_LEN;
269 vec_validate_aligned (rw, len - 1, CLIB_CACHE_LINE_BYTES);
270 clib_memset (rw, 0, len);
272 nsh_base = (nsh_base_header_t *) rw;
273 nsh_base->ver_o_c = nsh_entry->nsh_base.ver_o_c;
274 nsh_base->length = nsh_entry->nsh_base.length;
275 nsh_base->md_type = nsh_entry->nsh_base.md_type;
276 nsh_base->next_protocol = nsh_entry->nsh_base.next_protocol;
277 nsh_base->nsp_nsi = clib_host_to_net_u32 (nsh_entry->nsh_base.nsp_nsi);
279 if (nsh_base->md_type == 1)
281 nsh_md1 = (nsh_md1_data_t *) (rw + sizeof (nsh_base_header_t));
282 nsh_md1->c1 = clib_host_to_net_u32 (nsh_entry->md.md1_data.c1);
283 nsh_md1->c2 = clib_host_to_net_u32 (nsh_entry->md.md1_data.c2);
284 nsh_md1->c3 = clib_host_to_net_u32 (nsh_entry->md.md1_data.c3);
285 nsh_md1->c4 = clib_host_to_net_u32 (nsh_entry->md.md1_data.c4);
286 nsh_entry->rewrite_size = 24;
288 else if (nsh_base->md_type == 2)
290 opt0 = (nsh_md2_data_t *) (nsh_entry->tlvs_data);
291 limit0 = (nsh_md2_data_t *) ((u8 *) opt0 + nsh_entry->tlvs_len);
293 nsh_md2 = (nsh_md2_data_t *) (rw + sizeof (nsh_base_header_t));
294 nsh_entry->rewrite_size = sizeof (nsh_base_header_t);
296 while (opt0 < limit0)
298 old_option_size = sizeof (nsh_md2_data_t) + opt0->length;
299 /* round to 4-byte */
300 old_option_size = ((old_option_size + 3) >> 2) << 2;
302 nsh_option = nsh_md2_lookup_option (opt0->class, opt0->type);
303 if (nsh_option == NULL)
308 if (nm->add_options[nsh_option->option_id] != NULL)
310 if (0 != nm->add_options[nsh_option->option_id] ((u8 *) nsh_md2,
316 /* round to 4-byte */
317 new_option_size = ((new_option_size + 3) >> 2) << 2;
319 nsh_entry->rewrite_size += new_option_size;
321 (nsh_md2_data_t *) (((u8 *) nsh_md2) + new_option_size);
322 opt0 = (nsh_md2_data_t *) (((u8 *) opt0) + old_option_size);
327 opt0 = (nsh_md2_data_t *) (((u8 *) opt0) + old_option_size);
333 nsh_entry->rewrite = rw;
334 nsh_base->length = (nsh_base->length & NSH_TTL_L2_MASK) |
335 ((nsh_entry->rewrite_size >> 2) & NSH_LEN_MASK);
340 extern vnet_hw_interface_class_t nsh_hw_class;
343 * Action function to add or del an nsh map.
344 * Shared by both CLI and binary API
347 nsh_add_del_map (nsh_add_del_map_args_t * a, u32 * map_indexp)
349 nsh_main_t *nm = &nsh_main;
350 vnet_main_t *vnm = nm->vnet_main;
356 vnet_hw_interface_t *hi;
360 /* net order, so data plane could use nsh header to lookup directly */
361 key = clib_host_to_net_u32 (a->map.nsp_nsi);
363 entry = hash_get_mem (nm->nsh_mapping_by_key, &key);
367 /* adding an entry, must not already exist */
369 return -1; //TODO API_ERROR_INVALID_VALUE;
371 pool_get_aligned (nm->nsh_mappings, map, CLIB_CACHE_LINE_BYTES);
372 clib_memset (map, 0, sizeof (*map));
374 /* copy from arg structure */
375 map->nsp_nsi = a->map.nsp_nsi;
376 map->mapped_nsp_nsi = a->map.mapped_nsp_nsi;
377 map->nsh_action = a->map.nsh_action;
378 map->sw_if_index = a->map.sw_if_index;
379 map->rx_sw_if_index = a->map.rx_sw_if_index;
380 map->next_node = a->map.next_node;
381 map->adj_index = a->map.adj_index;
384 key_copy = clib_mem_alloc (sizeof (*key_copy));
385 clib_memcpy (key_copy, &key, sizeof (*key_copy));
387 hash_set_mem (nm->nsh_mapping_by_key, key_copy, map - nm->nsh_mappings);
388 map_index = map - nm->nsh_mappings;
390 if (vec_len (nm->free_nsh_tunnel_hw_if_indices) > 0)
392 nsh_hw_if = nm->free_nsh_tunnel_hw_if_indices
393 [vec_len (nm->free_nsh_tunnel_hw_if_indices) - 1];
394 _vec_len (nm->free_nsh_tunnel_hw_if_indices) -= 1;
396 hi = vnet_get_hw_interface (vnm, nsh_hw_if);
397 hi->dev_instance = map_index;
398 hi->hw_instance = hi->dev_instance;
402 nsh_hw_if = vnet_register_interface
403 (vnm, nsh_device_class.index, map_index, nsh_hw_class.index,
405 hi = vnet_get_hw_interface (vnm, nsh_hw_if);
406 hi->output_node_index = nsh_aware_vnf_proxy_node.index;
409 map->nsh_hw_if = nsh_hw_if;
410 map->nsh_sw_if = nsh_sw_if = hi->sw_if_index;
411 vec_validate_init_empty (nm->tunnel_index_by_sw_if_index, nsh_sw_if,
413 nm->tunnel_index_by_sw_if_index[nsh_sw_if] = key;
415 vnet_sw_interface_set_flags (vnm, hi->sw_if_index,
416 VNET_SW_INTERFACE_FLAG_ADMIN_UP);
421 return -2; //TODO API_ERROR_NO_SUCH_ENTRY;
423 map = pool_elt_at_index (nm->nsh_mappings, entry[0]);
425 vnet_sw_interface_set_flags (vnm, map->nsh_sw_if,
426 VNET_SW_INTERFACE_FLAG_ADMIN_DOWN);
427 vec_add1 (nm->free_nsh_tunnel_hw_if_indices, map->nsh_sw_if);
428 nm->tunnel_index_by_sw_if_index[map->nsh_sw_if] = ~0;
430 hp = hash_get_pair (nm->nsh_mapping_by_key, &key);
431 key_copy = (void *) (hp->key);
432 hash_unset_mem (nm->nsh_mapping_by_key, &key);
433 clib_mem_free (key_copy);
435 pool_put (nm->nsh_mappings, map);
439 *map_indexp = map_index;
445 * Action function to add or del an nsh-proxy-session.
446 * Shared by both CLI and binary API
449 nsh_add_del_proxy_session (nsh_add_del_map_args_t * a)
451 nsh_main_t *nm = &nsh_main;
452 nsh_proxy_session_t *proxy = 0;
453 nsh_proxy_session_by_key_t key, *key_copy;
456 u32 nsp = 0, nsi = 0;
458 clib_memset (&key, 0, sizeof (key));
459 key.transport_type = a->map.next_node;
460 key.transport_index = a->map.sw_if_index;
462 entry = hash_get_mem (nm->nsh_proxy_session_by_key, &key);
466 /* adding an entry, must not already exist */
468 return -1; //TODO API_ERROR_INVALID_VALUE;
470 pool_get_aligned (nm->nsh_proxy_sessions, proxy, CLIB_CACHE_LINE_BYTES);
471 clib_memset (proxy, 0, sizeof (*proxy));
473 /* Nsi needs to minus 1 within NSH-Proxy */
474 nsp = (a->map.nsp_nsi >> NSH_NSP_SHIFT) & NSH_NSP_MASK;
475 nsi = a->map.nsp_nsi & NSH_NSI_MASK;
480 /* net order, so could use it to lookup nsh map table directly */
481 proxy->nsp_nsi = clib_host_to_net_u32 ((nsp << NSH_NSP_SHIFT) | nsi);
483 key_copy = clib_mem_alloc (sizeof (*key_copy));
484 clib_memcpy (key_copy, &key, sizeof (*key_copy));
486 hash_set_mem (nm->nsh_proxy_session_by_key, key_copy,
487 proxy - nm->nsh_proxy_sessions);
492 return -2; //TODO API_ERROR_NO_SUCH_ENTRY;
494 proxy = pool_elt_at_index (nm->nsh_proxy_sessions, entry[0]);
495 hp = hash_get_pair (nm->nsh_proxy_session_by_key, &key);
496 key_copy = (void *) (hp->key);
497 hash_unset_mem (nm->nsh_proxy_session_by_key, &key);
498 clib_mem_free (key_copy);
500 pool_put (nm->nsh_proxy_sessions, proxy);
507 * Action function for adding an NSH entry
508 * nsh_add_del_entry_args_t *a: host order
511 nsh_add_del_entry (nsh_add_del_entry_args_t * a, u32 * entry_indexp)
513 nsh_main_t *nm = &nsh_main;
514 nsh_entry_t *nsh_entry = 0;
518 u32 entry_index = ~0;
522 /* host order, because nsh map table stores nsp_nsi in host order */
523 key = a->nsh_entry.nsh_base.nsp_nsi;
525 entry_id = hash_get_mem (nm->nsh_entry_by_key, &key);
529 /* adding an entry, must not already exist */
531 return -1; // TODO VNET_API_ERROR_INVALID_VALUE;
533 pool_get_aligned (nm->nsh_entries, nsh_entry, CLIB_CACHE_LINE_BYTES);
534 clib_memset (nsh_entry, 0, sizeof (*nsh_entry));
536 /* copy from arg structure */
537 #define _(x) nsh_entry->nsh_base.x = a->nsh_entry.nsh_base.x;
538 foreach_copy_nsh_base_hdr_field;
541 if (a->nsh_entry.nsh_base.md_type == 1)
543 nsh_entry->md.md1_data.c1 = a->nsh_entry.md.md1_data.c1;
544 nsh_entry->md.md1_data.c2 = a->nsh_entry.md.md1_data.c2;
545 nsh_entry->md.md1_data.c3 = a->nsh_entry.md.md1_data.c3;
546 nsh_entry->md.md1_data.c4 = a->nsh_entry.md.md1_data.c4;
548 else if (a->nsh_entry.nsh_base.md_type == 2)
550 vec_free (nsh_entry->tlvs_data);
551 tlvs_len = a->nsh_entry.tlvs_len;
552 vec_validate_aligned (data, tlvs_len - 1, CLIB_CACHE_LINE_BYTES);
554 clib_memcpy (data, a->nsh_entry.tlvs_data, tlvs_len);
555 nsh_entry->tlvs_data = data;
556 nsh_entry->tlvs_len = tlvs_len;
557 vec_free (a->nsh_entry.tlvs_data);
560 nsh_header_rewrite (nsh_entry);
562 key_copy = clib_mem_alloc (sizeof (*key_copy));
563 clib_memcpy (key_copy, &key, sizeof (*key_copy));
565 hash_set_mem (nm->nsh_entry_by_key, key_copy,
566 nsh_entry - nm->nsh_entries);
567 entry_index = nsh_entry - nm->nsh_entries;
572 return -2; //TODO API_ERROR_NO_SUCH_ENTRY;
574 nsh_entry = pool_elt_at_index (nm->nsh_entries, entry_id[0]);
575 hp = hash_get_pair (nm->nsh_entry_by_key, &key);
576 key_copy = (void *) (hp->key);
577 hash_unset_mem (nm->nsh_entry_by_key, &key);
578 clib_mem_free (key_copy);
580 vec_free (nsh_entry->tlvs_data);
581 vec_free (nsh_entry->rewrite);
582 pool_put (nm->nsh_entries, nsh_entry);
586 *entry_indexp = entry_index;
592 /** API message handler */
593 static void vl_api_nsh_add_del_entry_t_handler
594 (vl_api_nsh_add_del_entry_t * mp)
596 vl_api_nsh_add_del_entry_reply_t *rmp;
597 nsh_main_t *nm = &nsh_main;
599 nsh_add_del_entry_args_t _a, *a = &_a;
600 u32 entry_index = ~0;
604 a->is_add = mp->is_add;
605 a->nsh_entry.nsh_base.ver_o_c =
606 (mp->ver_o_c & 0xF0) | ((mp->ttl & NSH_LEN_MASK) >> 2);
607 a->nsh_entry.nsh_base.length =
608 (mp->length & NSH_LEN_MASK) | ((mp->ttl & 0x3) << 6);
609 a->nsh_entry.nsh_base.md_type = mp->md_type;
610 a->nsh_entry.nsh_base.next_protocol = mp->next_protocol;
611 a->nsh_entry.nsh_base.nsp_nsi = ntohl (mp->nsp_nsi);
612 if (mp->md_type == 1)
614 a->nsh_entry.md.md1_data.c1 = ntohl (mp->c1);
615 a->nsh_entry.md.md1_data.c2 = ntohl (mp->c2);
616 a->nsh_entry.md.md1_data.c3 = ntohl (mp->c3);
617 a->nsh_entry.md.md1_data.c4 = ntohl (mp->c4);
619 else if (mp->md_type == 2)
621 tlvs_len = mp->tlv_length;
622 vec_validate_aligned (data, tlvs_len - 1, CLIB_CACHE_LINE_BYTES);
624 clib_memcpy (data, mp->tlv, tlvs_len);
625 a->nsh_entry.tlvs_data = data;
626 a->nsh_entry.tlvs_len = tlvs_len;
629 rv = nsh_add_del_entry (a, &entry_index);
631 REPLY_MACRO2 (VL_API_NSH_ADD_DEL_ENTRY_REPLY, (
640 vl_api_nsh_entry_dump_t_handler (vl_api_nsh_entry_dump_t * mp)
642 nsh_main_t *nm = &nsh_main;
645 vl_api_registration_t *rp;
647 rp = vl_api_client_index_to_registration (mp->client_index);
651 entry_index = ntohl (mp->entry_index);
653 if (~0 == entry_index)
655 pool_foreach (t, nm->nsh_entries, (
657 send_nsh_entry_details (t, rp,
664 if (entry_index >= vec_len (nm->nsh_entries))
668 t = &nm->nsh_entries[entry_index];
669 send_nsh_entry_details (t, rp, mp->context);
674 setup_message_id_table (nsh_main_t * nm, api_main_t * am)
676 #define _(id,n,crc) \
677 vl_msg_api_add_msg_name_crc (am, #n "_" #crc, id + nm->msg_id_base);
678 foreach_vl_msg_name_crc_nsh;
682 /* Set up the API message handling tables */
683 static clib_error_t *
684 nsh_plugin_api_hookup (vlib_main_t * vm)
686 nsh_main_t *nm __attribute__ ((unused)) = &nsh_main;
688 vl_msg_api_set_handlers((VL_API_##N + nm->msg_id_base), \
690 vl_api_##n##_t_handler, \
692 vl_api_##n##_t_endian, \
693 vl_api_##n##_t_print, \
694 sizeof(vl_api_##n##_t), 1);
695 foreach_nsh_plugin_api_msg;
702 nsh_api_init (vlib_main_t * vm, nsh_main_t * nm)
707 name = format (0, "nsh_%08x%c", api_version, 0);
710 nm->msg_id_base = vl_msg_api_get_msg_ids
711 ((char *) name, VL_MSG_FIRST_AVAILABLE);
713 error = nsh_plugin_api_hookup (vm);
715 /* Add our API messages to the global name_crc hash table */
716 setup_message_id_table (nm, vlibapi_get_main ());
724 * fd.io coding-style-patch-verification: ON
727 * eval: (c-set-style "gnu")