2 * nsh_cli.c - nsh cli functions
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.
18 #include <vnet/vnet.h>
19 #include <vnet/plugin/plugin.h>
21 #include <vnet/adj/adj.h>
23 /* format from network order */
25 format_nsh_pop_header (u8 * s, va_list * args)
27 return format_nsh_header (s, args);
31 format_nsh_pop_node_map_trace (u8 * s, va_list * args)
33 return format_nsh_node_map_trace (s, args);
37 unformat_nsh_action (unformat_input_t * input, va_list * args)
39 u32 *result = va_arg (*args, u32 *);
42 if (unformat (input, "swap"))
43 *result = NSH_ACTION_SWAP;
44 else if (unformat (input, "push"))
45 *result = NSH_ACTION_PUSH;
46 else if (unformat (input, "pop"))
47 *result = NSH_ACTION_POP;
48 else if (unformat (input, "%d", &tmp))
57 format_nsh_action (u8 * s, va_list * args)
59 u32 nsh_action = va_arg (*args, u32);
64 return format (s, "swap");
66 return format (s, "push");
68 return format (s, "pop");
70 return format (s, "unknown %d", nsh_action);
76 format_nsh_map (u8 * s, va_list * args)
78 nsh_map_t *map = va_arg (*args, nsh_map_t *);
80 s = format (s, "nsh entry nsp: %d nsi: %d ",
81 (map->nsp_nsi >> NSH_NSP_SHIFT) & NSH_NSP_MASK,
82 map->nsp_nsi & NSH_NSI_MASK);
83 s = format (s, "maps to nsp: %d nsi: %d ",
84 (map->mapped_nsp_nsi >> NSH_NSP_SHIFT) & NSH_NSP_MASK,
85 map->mapped_nsp_nsi & NSH_NSI_MASK);
87 s = format (s, " nsh_action %U\n", format_nsh_action, map->nsh_action);
89 switch (map->next_node)
91 case NSH_NODE_NEXT_ENCAP_GRE4:
93 s = format (s, "encapped by GRE4 intf: %d", map->sw_if_index);
96 case NSH_NODE_NEXT_ENCAP_GRE6:
98 s = format (s, "encapped by GRE6 intf: %d", map->sw_if_index);
101 case NSH_NODE_NEXT_ENCAP_VXLANGPE:
103 s = format (s, "encapped by VXLAN GPE intf: %d", map->sw_if_index);
106 case NSH_NODE_NEXT_ENCAP_VXLAN4:
108 s = format (s, "encapped by VXLAN4 intf: %d", map->sw_if_index);
111 case NSH_NODE_NEXT_ENCAP_VXLAN6:
113 s = format (s, "encapped by VXLAN6 intf: %d", map->sw_if_index);
116 case NSH_NODE_NEXT_DECAP_ETH_INPUT:
118 s = format (s, "encap-none");
121 case NSH_NODE_NEXT_ENCAP_LISP_GPE:
123 s = format (s, "encapped by LISP GPE intf: %d", map->sw_if_index);
126 case NSH_NODE_NEXT_ENCAP_ETHERNET:
128 s = format (s, "encapped by Ethernet intf: %d", map->sw_if_index);
132 s = format (s, "only GRE and VXLANGPE support in this rev");
139 nsh_get_adj_by_sw_if_index (u32 sw_if_index)
144 pool_foreach_index(ai, adj_pool,
146 if (sw_if_index == adj_get_sw_if_index(ai))
158 * CLI command for NSH map
160 static clib_error_t *
161 nsh_add_del_map_command_fn (vlib_main_t * vm,
162 unformat_input_t * input,
163 vlib_cli_command_t * cmd)
165 unformat_input_t _line_input, *line_input = &_line_input;
167 u32 nsp, nsi, mapped_nsp, mapped_nsi, nsh_action;
168 int nsp_set = 0, nsi_set = 0, mapped_nsp_set = 0, mapped_nsi_set = 0;
169 int nsh_action_set = 0;
172 u32 sw_if_index = ~0; // temporary requirement to get this moved over to NSHSFC
173 u32 rx_sw_if_index = ~0; // temporary requirement to get this moved over to NSHSFC
174 nsh_add_del_map_args_t _a, *a = &_a;
178 /* Get a line of input. */
179 if (!unformat_user (input, unformat_line_input, line_input))
182 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
184 if (unformat (line_input, "del"))
186 else if (unformat (line_input, "nsp %d", &nsp))
188 else if (unformat (line_input, "nsi %d", &nsi))
190 else if (unformat (line_input, "mapped-nsp %d", &mapped_nsp))
192 else if (unformat (line_input, "mapped-nsi %d", &mapped_nsi))
194 else if (unformat (line_input, "nsh_action %U", unformat_nsh_action,
197 else if (unformat (line_input, "encap-gre4-intf %d", &sw_if_index))
198 next_node = NSH_NODE_NEXT_ENCAP_GRE4;
199 else if (unformat (line_input, "encap-gre6-intf %d", &sw_if_index))
200 next_node = NSH_NODE_NEXT_ENCAP_GRE6;
201 else if (unformat (line_input, "encap-vxlan-gpe-intf %d", &sw_if_index))
202 next_node = NSH_NODE_NEXT_ENCAP_VXLANGPE;
203 else if (unformat (line_input, "encap-lisp-gpe-intf %d", &sw_if_index))
204 next_node = NSH_NODE_NEXT_ENCAP_LISP_GPE;
205 else if (unformat (line_input, "encap-vxlan4-intf %d", &sw_if_index))
206 next_node = NSH_NODE_NEXT_ENCAP_VXLAN4;
207 else if (unformat (line_input, "encap-vxlan6-intf %d", &sw_if_index))
208 next_node = NSH_NODE_NEXT_ENCAP_VXLAN6;
209 else if (unformat (line_input, "encap-eth-intf %d", &sw_if_index))
211 next_node = NSH_NODE_NEXT_ENCAP_ETHERNET;
212 adj_index = nsh_get_adj_by_sw_if_index (sw_if_index);
216 (line_input, "encap-none %d %d", &sw_if_index, &rx_sw_if_index))
217 next_node = NSH_NODE_NEXT_DECAP_ETH_INPUT;
219 return clib_error_return (0, "parse error: '%U'",
220 format_unformat_error, line_input);
223 unformat_free (line_input);
225 if (nsp_set == 0 || nsi_set == 0)
226 return clib_error_return (0, "nsp nsi pair required. Key: for NSH entry");
228 if (mapped_nsp_set == 0 || mapped_nsi_set == 0)
229 return clib_error_return (0,
230 "mapped-nsp mapped-nsi pair required. Key: for NSH entry");
232 if (nsh_action_set == 0)
233 return clib_error_return (0, "nsh_action required: swap|push|pop.");
236 return clib_error_return (0,
237 "must specific action: [encap-gre-intf <nn> | encap-vxlan-gpe-intf <nn> | encap-lisp-gpe-intf <nn> | encap-none <tx_sw_if_index> <rx_sw_if_index>]");
239 clib_memset (a, 0, sizeof (*a));
241 /* set args structure */
243 a->map.nsp_nsi = (nsp << NSH_NSP_SHIFT) | nsi;
244 a->map.mapped_nsp_nsi = (mapped_nsp << NSH_NSP_SHIFT) | mapped_nsi;
245 a->map.nsh_action = nsh_action;
246 a->map.sw_if_index = sw_if_index;
247 a->map.rx_sw_if_index = rx_sw_if_index;
248 a->map.next_node = next_node;
249 a->map.adj_index = adj_index;
251 rv = nsh_add_del_map (a, &map_index);
257 case -1: //TODO API_ERROR_INVALID_VALUE:
258 return clib_error_return (0,
259 "mapping already exists. Remove it first.");
261 case -2: // TODO API_ERROR_NO_SUCH_ENTRY:
262 return clib_error_return (0, "mapping does not exist.");
265 return clib_error_return (0, "nsh_add_del_map returned %d", rv);
268 if ((a->map.next_node == NSH_NODE_NEXT_ENCAP_VXLAN4)
269 | (a->map.next_node == NSH_NODE_NEXT_ENCAP_VXLAN6))
271 rv = nsh_add_del_proxy_session (a);
277 case -1: //TODO API_ERROR_INVALID_VALUE:
278 return clib_error_return (0,
279 "nsh-proxy-session already exists. Remove it first.");
281 case -2: // TODO API_ERROR_NO_SUCH_ENTRY:
282 return clib_error_return (0, "nsh-proxy-session does not exist.");
285 return clib_error_return
286 (0, "nsh_add_del_proxy_session() returned %d", rv);
294 VLIB_CLI_COMMAND (create_nsh_map_command, static) = {
295 .path = "create nsh map",
297 "create nsh map nsp <nn> nsi <nn> [del] mapped-nsp <nn> mapped-nsi <nn> nsh_action [swap|push|pop] "
298 "[encap-gre4-intf <nn> | encap-gre4-intf <nn> | encap-vxlan-gpe-intf <nn> | encap-lisp-gpe-intf <nn> "
299 " encap-vxlan4-intf <nn> | encap-vxlan6-intf <nn>| encap-eth-intf <nn> | encap-none]\n",
300 .function = nsh_add_del_map_command_fn,
305 * CLI command for showing the mapping between NSH entries
307 static clib_error_t *
308 show_nsh_map_command_fn (vlib_main_t * vm,
309 unformat_input_t * input, vlib_cli_command_t * cmd)
311 nsh_main_t *nm = &nsh_main;
314 if (pool_elts (nm->nsh_mappings) == 0)
315 vlib_cli_output (vm, "No nsh maps configured.");
317 pool_foreach (map, nm->nsh_mappings, (
319 vlib_cli_output (vm, "%U",
329 VLIB_CLI_COMMAND (show_nsh_map_command, static) = {
330 .path = "show nsh map",
331 .function = show_nsh_map_command_fn,
336 * CLI command for adding NSH entry
338 static clib_error_t *
339 nsh_add_del_entry_command_fn (vlib_main_t * vm,
340 unformat_input_t * input,
341 vlib_cli_command_t * cmd)
343 unformat_input_t _line_input, *line_input = &_line_input;
349 u8 next_protocol = 1; /* default: ip4 */
360 nsh_tlv_header_t tlv_header;
361 u8 cur_len = 0, tlvs_len = 0;
363 nsh_main_t *nm = &nsh_main;
364 nsh_option_map_t _nsh_option, *nsh_option = &_nsh_option;
369 nsh_add_del_entry_args_t _a, *a = &_a;
370 u8 has_ioam_trace_option = 0;
372 /* Get a line of input. */
373 if (!unformat_user (input, unformat_line_input, line_input))
376 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
378 if (unformat (line_input, "del"))
380 else if (unformat (line_input, "version %d", &tmp))
381 ver_o_c |= (tmp & 3) << 6;
382 else if (unformat (line_input, "o-bit %d", &tmp))
383 ver_o_c |= (tmp & 1) << 5;
384 else if (unformat (line_input, "c-bit %d", &tmp))
385 ver_o_c |= (tmp & 1) << 4;
386 else if (unformat (line_input, "ttl %d", &ttl))
387 ver_o_c |= (ttl & NSH_LEN_MASK) >> 2;
388 else if (unformat (line_input, "md-type %d", &tmp))
390 else if (unformat (line_input, "next-ip4"))
392 else if (unformat (line_input, "next-ip6"))
394 else if (unformat (line_input, "next-ethernet"))
396 else if (unformat (line_input, "c1 %d", &c1))
398 else if (unformat (line_input, "c2 %d", &c2))
400 else if (unformat (line_input, "c3 %d", &c3))
402 else if (unformat (line_input, "c4 %d", &c4))
404 else if (unformat (line_input, "nsp %d", &nsp))
406 else if (unformat (line_input, "nsi %d", &nsi))
408 else if (unformat (line_input, "tlv-ioam-trace"))
409 has_ioam_trace_option = 1;
411 return clib_error_return (0, "parse error: '%U'",
412 format_unformat_error, line_input);
415 unformat_free (line_input);
418 return clib_error_return (0, "nsp not specified");
421 return clib_error_return (0, "nsi not specified");
423 if (md_type == 1 && has_ioam_trace_option == 1)
424 return clib_error_return (0, "Invalid MD Type");
426 nsp_nsi = (nsp << 8) | nsi;
428 clib_memset (a, 0, sizeof (*a));
433 a->nsh_entry.md.md1_data.c1 = c1;
434 a->nsh_entry.md.md1_data.c2 = c2;
435 a->nsh_entry.md.md1_data.c3 = c3;
436 a->nsh_entry.md.md1_data.c4 = c4;
437 length = (sizeof (nsh_base_header_t) + sizeof (nsh_md1_data_t)) >> 2;
439 else if (md_type == 2)
441 length = sizeof (nsh_base_header_t) >> 2;
443 vec_free (a->nsh_entry.tlvs_data);
444 tlvs_len = (MAX_METADATA_LEN << 2);
445 vec_validate_aligned (data, tlvs_len - 1, CLIB_CACHE_LINE_BYTES);
446 a->nsh_entry.tlvs_data = data;
449 if (has_ioam_trace_option)
451 tlv_header.class = clib_host_to_net_u16 (NSH_MD2_IOAM_CLASS);
452 tlv_header.type = NSH_MD2_IOAM_OPTION_TYPE_TRACE;
453 /* Uses network order's class and type to lookup */
455 nsh_md2_lookup_option (tlv_header.class, tlv_header.type);
456 if (nsh_option == NULL)
457 return clib_error_return (0, "iOAM Trace not registered");
459 if (nm->add_options[nsh_option->option_id] != NULL)
461 if (0 != nm->add_options[nsh_option->option_id] ((u8 *) current,
464 return clib_error_return (0, "Invalid MD Type");
468 nm->options_size[nsh_option->option_id] = option_size;
469 /* round to 4-byte */
470 option_size = (((option_size + 3) >> 2) << 2);
472 cur_len += option_size;
473 current = data + option_size;
476 /* Add more options' parsing */
478 a->nsh_entry.tlvs_len = cur_len;
479 length += (cur_len >> 2);
481 length = (length & NSH_LEN_MASK) | ((ttl & 0x3) << 6);
483 #define _(x) a->nsh_entry.nsh_base.x = x;
484 foreach_copy_nsh_base_hdr_field;
487 rv = nsh_add_del_entry (a, &entry_index);
494 return clib_error_return (0, "nsh_add_del_entry returned %d", rv);
501 VLIB_CLI_COMMAND (create_nsh_entry_command, static) = {
502 .path = "create nsh entry",
504 "create nsh entry {nsp <nn> nsi <nn>} [ttl <nn>] [md-type <nn>]"
505 " [c1 <nn> c2 <nn> c3 <nn> c4 <nn>] [tlv-ioam-trace] [del]\n",
506 .function = nsh_add_del_entry_command_fn,
510 /* format from network order */
512 format_nsh_header (u8 * s, va_list * args)
514 nsh_main_t *nm = &nsh_main;
515 nsh_md2_data_t *opt0;
516 nsh_md2_data_t *limit0;
517 nsh_option_map_t *nsh_option;
520 u8 *header = va_arg (*args, u8 *);
521 nsh_base_header_t *nsh_base = (nsh_base_header_t *) header;
522 nsh_md1_data_t *nsh_md1 = (nsh_md1_data_t *) (nsh_base + 1);
523 nsh_md2_data_t *nsh_md2 = (nsh_md2_data_t *) (nsh_base + 1);
524 opt0 = (nsh_md2_data_t *) nsh_md2;
525 limit0 = (nsh_md2_data_t *) ((u8 *) nsh_md2 +
526 ((nsh_base->length & NSH_LEN_MASK) * 4
527 - sizeof (nsh_base_header_t)));
529 s = format (s, "nsh ver %d ", (nsh_base->ver_o_c >> 6));
530 if (nsh_base->ver_o_c & NSH_O_BIT)
531 s = format (s, "O-set ");
533 if (nsh_base->ver_o_c & NSH_C_BIT)
534 s = format (s, "C-set ");
536 s = format (s, "ttl %d ", (nsh_base->ver_o_c & NSH_TTL_H4_MASK) << 2 |
537 (nsh_base->length & NSH_TTL_L2_MASK) >> 6);
539 s = format (s, "len %d (%d bytes) md_type %d next_protocol %d\n",
540 (nsh_base->length & NSH_LEN_MASK),
541 (nsh_base->length & NSH_LEN_MASK) * 4,
542 nsh_base->md_type, nsh_base->next_protocol);
544 s = format (s, " service path %d service index %d\n",
545 (clib_net_to_host_u32 (nsh_base->nsp_nsi) >> NSH_NSP_SHIFT) &
547 clib_net_to_host_u32 (nsh_base->nsp_nsi) & NSH_NSI_MASK);
549 if (nsh_base->md_type == 1)
551 s = format (s, " c1 %d c2 %d c3 %d c4 %d\n",
552 clib_net_to_host_u32 (nsh_md1->c1),
553 clib_net_to_host_u32 (nsh_md1->c2),
554 clib_net_to_host_u32 (nsh_md1->c3),
555 clib_net_to_host_u32 (nsh_md1->c4));
557 else if (nsh_base->md_type == 2)
559 s = format (s, " Supported TLVs: \n");
561 /* Scan the set of variable metadata, network order */
562 while (opt0 < limit0)
564 nsh_option = nsh_md2_lookup_option (opt0->class, opt0->type);
565 if (nsh_option != NULL)
567 if (nm->trace[nsh_option->option_id] != NULL)
569 s = (*nm->trace[nsh_option->option_id]) (s, opt0);
574 format (s, "\n untraced option %d length %d",
575 opt0->type, opt0->length);
581 format (s, "\n unrecognized option %d length %d",
582 opt0->type, opt0->length);
585 /* round to 4-byte */
586 option_len = ((opt0->length + 3) >> 2) << 2;
588 (nsh_md2_data_t *) (((u8 *) opt0) + sizeof (nsh_md2_data_t) +
597 format_nsh_node_map_trace (u8 * s, va_list * args)
599 CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
600 CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
601 nsh_input_trace_t *t = va_arg (*args, nsh_input_trace_t *);
603 s = format (s, "\n %U", format_nsh_header, &(t->trace_data));
608 static clib_error_t *
609 show_nsh_entry_command_fn (vlib_main_t * vm,
610 unformat_input_t * input, vlib_cli_command_t * cmd)
612 nsh_main_t *nm = &nsh_main;
613 nsh_entry_t *nsh_entry;
615 if (pool_elts (nm->nsh_entries) == 0)
616 vlib_cli_output (vm, "No nsh entries configured.");
618 pool_foreach (nsh_entry, nm->nsh_entries, (
620 vlib_cli_output (vm, "%U",
624 " rewrite_size: %d bytes",
625 nsh_entry->rewrite_size);
633 VLIB_CLI_COMMAND (show_nsh_entry_command, static) = {
634 .path = "show nsh entry",
635 .function = show_nsh_entry_command_fn,
640 * fd.io coding-style-patch-verification: ON
643 * eval: (c-set-style "gnu")