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)
143 pool_foreach_index (ai, adj_pool)
145 if (sw_if_index == adj_get_sw_if_index(ai))
156 * CLI command for NSH map
158 static clib_error_t *
159 nsh_add_del_map_command_fn (vlib_main_t * vm,
160 unformat_input_t * input,
161 vlib_cli_command_t * cmd)
163 unformat_input_t _line_input, *line_input = &_line_input;
165 u32 nsp, nsi, mapped_nsp, mapped_nsi, nsh_action;
166 int nsp_set = 0, nsi_set = 0, mapped_nsp_set = 0, mapped_nsi_set = 0;
167 int nsh_action_set = 0;
170 u32 sw_if_index = ~0; // temporary requirement to get this moved over to NSHSFC
171 u32 rx_sw_if_index = ~0; // temporary requirement to get this moved over to NSHSFC
172 nsh_add_del_map_args_t _a, *a = &_a;
176 /* Get a line of input. */
177 if (!unformat_user (input, unformat_line_input, line_input))
180 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
182 if (unformat (line_input, "del"))
184 else if (unformat (line_input, "nsp %d", &nsp))
186 else if (unformat (line_input, "nsi %d", &nsi))
188 else if (unformat (line_input, "mapped-nsp %d", &mapped_nsp))
190 else if (unformat (line_input, "mapped-nsi %d", &mapped_nsi))
192 else if (unformat (line_input, "nsh_action %U", unformat_nsh_action,
195 else if (unformat (line_input, "encap-gre4-intf %d", &sw_if_index))
196 next_node = NSH_NODE_NEXT_ENCAP_GRE4;
197 else if (unformat (line_input, "encap-gre6-intf %d", &sw_if_index))
198 next_node = NSH_NODE_NEXT_ENCAP_GRE6;
199 else if (unformat (line_input, "encap-vxlan-gpe-intf %d", &sw_if_index))
200 next_node = NSH_NODE_NEXT_ENCAP_VXLANGPE;
201 else if (unformat (line_input, "encap-lisp-gpe-intf %d", &sw_if_index))
202 next_node = NSH_NODE_NEXT_ENCAP_LISP_GPE;
203 else if (unformat (line_input, "encap-vxlan4-intf %d", &sw_if_index))
204 next_node = NSH_NODE_NEXT_ENCAP_VXLAN4;
205 else if (unformat (line_input, "encap-vxlan6-intf %d", &sw_if_index))
206 next_node = NSH_NODE_NEXT_ENCAP_VXLAN6;
207 else if (unformat (line_input, "encap-eth-intf %d", &sw_if_index))
209 next_node = NSH_NODE_NEXT_ENCAP_ETHERNET;
210 adj_index = nsh_get_adj_by_sw_if_index (sw_if_index);
214 (line_input, "encap-none %d %d", &sw_if_index, &rx_sw_if_index))
215 next_node = NSH_NODE_NEXT_DECAP_ETH_INPUT;
217 return clib_error_return (0, "parse error: '%U'",
218 format_unformat_error, line_input);
221 unformat_free (line_input);
223 if (nsp_set == 0 || nsi_set == 0)
224 return clib_error_return (0, "nsp nsi pair required. Key: for NSH entry");
226 if (mapped_nsp_set == 0 || mapped_nsi_set == 0)
227 return clib_error_return (0,
228 "mapped-nsp mapped-nsi pair required. Key: for NSH entry");
230 if (nsh_action_set == 0)
231 return clib_error_return (0, "nsh_action required: swap|push|pop.");
234 return clib_error_return (0,
235 "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>]");
237 clib_memset (a, 0, sizeof (*a));
239 /* set args structure */
241 a->map.nsp_nsi = (nsp << NSH_NSP_SHIFT) | nsi;
242 a->map.mapped_nsp_nsi = (mapped_nsp << NSH_NSP_SHIFT) | mapped_nsi;
243 a->map.nsh_action = nsh_action;
244 a->map.sw_if_index = sw_if_index;
245 a->map.rx_sw_if_index = rx_sw_if_index;
246 a->map.next_node = next_node;
247 a->map.adj_index = adj_index;
249 rv = nsh_add_del_map (a, &map_index);
255 case -1: //TODO API_ERROR_INVALID_VALUE:
256 return clib_error_return (0,
257 "mapping already exists. Remove it first.");
259 case -2: // TODO API_ERROR_NO_SUCH_ENTRY:
260 return clib_error_return (0, "mapping does not exist.");
263 return clib_error_return (0, "nsh_add_del_map returned %d", rv);
266 if ((a->map.next_node == NSH_NODE_NEXT_ENCAP_VXLAN4)
267 | (a->map.next_node == NSH_NODE_NEXT_ENCAP_VXLAN6))
269 rv = nsh_add_del_proxy_session (a);
275 case -1: //TODO API_ERROR_INVALID_VALUE:
276 return clib_error_return (0,
277 "nsh-proxy-session already exists. Remove it first.");
279 case -2: // TODO API_ERROR_NO_SUCH_ENTRY:
280 return clib_error_return (0, "nsh-proxy-session does not exist.");
283 return clib_error_return
284 (0, "nsh_add_del_proxy_session() returned %d", rv);
291 VLIB_CLI_COMMAND (create_nsh_map_command, static) = {
292 .path = "create nsh map",
294 "create nsh map nsp <nn> nsi <nn> [del] mapped-nsp <nn> mapped-nsi <nn> nsh_action [swap|push|pop] "
295 "[encap-gre4-intf <nn> | encap-gre4-intf <nn> | encap-vxlan-gpe-intf <nn> | encap-lisp-gpe-intf <nn> "
296 " encap-vxlan4-intf <nn> | encap-vxlan6-intf <nn>| encap-eth-intf <nn> | encap-none]\n",
297 .function = nsh_add_del_map_command_fn,
301 * CLI command for showing the mapping between NSH entries
303 static clib_error_t *
304 show_nsh_map_command_fn (vlib_main_t * vm,
305 unformat_input_t * input, vlib_cli_command_t * cmd)
307 nsh_main_t *nm = &nsh_main;
310 if (pool_elts (nm->nsh_mappings) == 0)
311 vlib_cli_output (vm, "No nsh maps configured.");
313 pool_foreach (map, nm->nsh_mappings)
315 vlib_cli_output (vm, "%U", format_nsh_map, map);
321 VLIB_CLI_COMMAND (show_nsh_map_command, static) = {
322 .path = "show nsh map",
323 .function = show_nsh_map_command_fn,
327 * CLI command for adding NSH entry
329 static clib_error_t *
330 nsh_add_del_entry_command_fn (vlib_main_t * vm,
331 unformat_input_t * input,
332 vlib_cli_command_t * cmd)
334 unformat_input_t _line_input, *line_input = &_line_input;
340 u8 next_protocol = 1; /* default: ip4 */
351 nsh_tlv_header_t tlv_header;
352 u8 cur_len = 0, tlvs_len = 0;
354 nsh_main_t *nm = &nsh_main;
355 nsh_option_map_t _nsh_option, *nsh_option = &_nsh_option;
360 nsh_add_del_entry_args_t _a, *a = &_a;
361 u8 has_ioam_trace_option = 0;
363 /* Get a line of input. */
364 if (!unformat_user (input, unformat_line_input, line_input))
367 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
369 if (unformat (line_input, "del"))
371 else if (unformat (line_input, "version %d", &tmp))
372 ver_o_c |= (tmp & 3) << 6;
373 else if (unformat (line_input, "o-bit %d", &tmp))
374 ver_o_c |= (tmp & 1) << 5;
375 else if (unformat (line_input, "c-bit %d", &tmp))
376 ver_o_c |= (tmp & 1) << 4;
377 else if (unformat (line_input, "ttl %d", &ttl))
378 ver_o_c |= (ttl & NSH_LEN_MASK) >> 2;
379 else if (unformat (line_input, "md-type %d", &tmp))
381 else if (unformat (line_input, "next-ip4"))
383 else if (unformat (line_input, "next-ip6"))
385 else if (unformat (line_input, "next-ethernet"))
387 else if (unformat (line_input, "c1 %d", &c1))
389 else if (unformat (line_input, "c2 %d", &c2))
391 else if (unformat (line_input, "c3 %d", &c3))
393 else if (unformat (line_input, "c4 %d", &c4))
395 else if (unformat (line_input, "nsp %d", &nsp))
397 else if (unformat (line_input, "nsi %d", &nsi))
399 else if (unformat (line_input, "tlv-ioam-trace"))
400 has_ioam_trace_option = 1;
402 return clib_error_return (0, "parse error: '%U'",
403 format_unformat_error, line_input);
406 unformat_free (line_input);
409 return clib_error_return (0, "nsp not specified");
412 return clib_error_return (0, "nsi not specified");
414 if (md_type == 1 && has_ioam_trace_option == 1)
415 return clib_error_return (0, "Invalid MD Type");
417 nsp_nsi = (nsp << 8) | nsi;
419 clib_memset (a, 0, sizeof (*a));
424 a->nsh_entry.md.md1_data.c1 = c1;
425 a->nsh_entry.md.md1_data.c2 = c2;
426 a->nsh_entry.md.md1_data.c3 = c3;
427 a->nsh_entry.md.md1_data.c4 = c4;
428 length = (sizeof (nsh_base_header_t) + sizeof (nsh_md1_data_t)) >> 2;
430 else if (md_type == 2)
432 length = sizeof (nsh_base_header_t) >> 2;
434 vec_free (a->nsh_entry.tlvs_data);
435 tlvs_len = (MAX_METADATA_LEN << 2);
436 vec_validate_aligned (data, tlvs_len - 1, CLIB_CACHE_LINE_BYTES);
437 a->nsh_entry.tlvs_data = data;
440 if (has_ioam_trace_option)
442 tlv_header.class = clib_host_to_net_u16 (NSH_MD2_IOAM_CLASS);
443 tlv_header.type = NSH_MD2_IOAM_OPTION_TYPE_TRACE;
444 /* Uses network order's class and type to lookup */
446 nsh_md2_lookup_option (tlv_header.class, tlv_header.type);
447 if (nsh_option == NULL)
448 return clib_error_return (0, "iOAM Trace not registered");
450 if (nm->add_options[nsh_option->option_id] != NULL)
452 if (0 != nm->add_options[nsh_option->option_id] ((u8 *) current,
455 return clib_error_return (0, "Invalid MD Type");
459 nm->options_size[nsh_option->option_id] = option_size;
460 /* round to 4-byte */
461 option_size = (((option_size + 3) >> 2) << 2);
463 cur_len += option_size;
464 current = data + option_size;
467 /* Add more options' parsing */
469 a->nsh_entry.tlvs_len = cur_len;
470 length += (cur_len >> 2);
472 length = (length & NSH_LEN_MASK) | ((ttl & 0x3) << 6);
474 #define _(x) a->nsh_entry.nsh_base.x = x;
475 foreach_copy_nsh_base_hdr_field;
478 rv = nsh_add_del_entry (a, &entry_index);
485 return clib_error_return (0, "nsh_add_del_entry returned %d", rv);
491 VLIB_CLI_COMMAND (create_nsh_entry_command, static) = {
492 .path = "create nsh entry",
494 "create nsh entry {nsp <nn> nsi <nn>} [ttl <nn>] [md-type <nn>]"
495 " [c1 <nn> c2 <nn> c3 <nn> c4 <nn>] [tlv-ioam-trace] [del]\n",
496 .function = nsh_add_del_entry_command_fn,
499 /* format from network order */
501 format_nsh_header (u8 * s, va_list * args)
503 nsh_main_t *nm = &nsh_main;
504 nsh_md2_data_t *opt0;
505 nsh_md2_data_t *limit0;
506 nsh_option_map_t *nsh_option;
509 u8 *header = va_arg (*args, u8 *);
510 nsh_base_header_t *nsh_base = (nsh_base_header_t *) header;
511 nsh_md1_data_t *nsh_md1 = (nsh_md1_data_t *) (nsh_base + 1);
512 nsh_md2_data_t *nsh_md2 = (nsh_md2_data_t *) (nsh_base + 1);
513 opt0 = (nsh_md2_data_t *) nsh_md2;
514 limit0 = (nsh_md2_data_t *) ((u8 *) nsh_md2 +
515 ((nsh_base->length & NSH_LEN_MASK) * 4
516 - sizeof (nsh_base_header_t)));
518 s = format (s, "nsh ver %d ", (nsh_base->ver_o_c >> 6));
519 if (nsh_base->ver_o_c & NSH_O_BIT)
520 s = format (s, "O-set ");
522 if (nsh_base->ver_o_c & NSH_C_BIT)
523 s = format (s, "C-set ");
525 s = format (s, "ttl %d ", (nsh_base->ver_o_c & NSH_TTL_H4_MASK) << 2 |
526 (nsh_base->length & NSH_TTL_L2_MASK) >> 6);
528 s = format (s, "len %d (%d bytes) md_type %d next_protocol %d\n",
529 (nsh_base->length & NSH_LEN_MASK),
530 (nsh_base->length & NSH_LEN_MASK) * 4,
531 nsh_base->md_type, nsh_base->next_protocol);
533 s = format (s, " service path %d service index %d\n",
534 (clib_net_to_host_u32 (nsh_base->nsp_nsi) >> NSH_NSP_SHIFT) &
536 clib_net_to_host_u32 (nsh_base->nsp_nsi) & NSH_NSI_MASK);
538 if (nsh_base->md_type == 1)
540 s = format (s, " c1 %d c2 %d c3 %d c4 %d\n",
541 clib_net_to_host_u32 (nsh_md1->c1),
542 clib_net_to_host_u32 (nsh_md1->c2),
543 clib_net_to_host_u32 (nsh_md1->c3),
544 clib_net_to_host_u32 (nsh_md1->c4));
546 else if (nsh_base->md_type == 2)
548 s = format (s, " Supported TLVs: \n");
550 /* Scan the set of variable metadata, network order */
551 while (opt0 < limit0)
553 nsh_option = nsh_md2_lookup_option (opt0->class, opt0->type);
554 if (nsh_option != NULL)
556 if (nm->trace[nsh_option->option_id] != NULL)
558 s = (*nm->trace[nsh_option->option_id]) (s, opt0);
563 format (s, "\n untraced option %d length %d",
564 opt0->type, opt0->length);
570 format (s, "\n unrecognized option %d length %d",
571 opt0->type, opt0->length);
574 /* round to 4-byte */
575 option_len = ((opt0->length + 3) >> 2) << 2;
577 (nsh_md2_data_t *) (((u8 *) opt0) + sizeof (nsh_md2_data_t) +
586 format_nsh_node_map_trace (u8 * s, va_list * args)
588 CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
589 CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
590 nsh_input_trace_t *t = va_arg (*args, nsh_input_trace_t *);
592 s = format (s, "\n %U", format_nsh_header, &(t->trace_data));
597 static clib_error_t *
598 show_nsh_entry_command_fn (vlib_main_t * vm,
599 unformat_input_t * input, vlib_cli_command_t * cmd)
601 nsh_main_t *nm = &nsh_main;
602 nsh_entry_t *nsh_entry;
604 if (pool_elts (nm->nsh_entries) == 0)
605 vlib_cli_output (vm, "No nsh entries configured.");
607 pool_foreach (nsh_entry, nm->nsh_entries)
609 vlib_cli_output (vm, "%U", format_nsh_header, nsh_entry->rewrite);
610 vlib_cli_output (vm, " rewrite_size: %d bytes", nsh_entry->rewrite_size);
616 VLIB_CLI_COMMAND (show_nsh_entry_command, static) = {
617 .path = "show nsh entry",
618 .function = show_nsh_entry_command_fn,
622 * fd.io coding-style-patch-verification: ON
625 * eval: (c-set-style "gnu")