2 * Copyright (c) 2016 Cisco and/or its affiliates.
3 * Licensed under the Apache License, Version 2.0 (the "License");
4 * you may not use this file except in compliance with the License.
5 * You may obtain a copy of the License at:
7 * http://www.apache.org/licenses/LICENSE-2.0
9 * Unless required by applicable law or agreed to in writing, software
10 * distributed under the License is distributed on an "AS IS" BASIS,
11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 * See the License for the specific language governing permissions and
13 * limitations under the License.
15 #include <vlib/vlib.h>
16 #include <vnet/vnet.h>
17 #include <vnet/pg/pg.h>
18 #include <vppinfra/error.h>
20 #include <vnet/ip/ip.h>
22 #include <vppinfra/hash.h>
23 #include <vppinfra/error.h>
24 #include <vppinfra/elog.h>
26 #include <vnet/ip/ip6_hop_by_hop.h>
27 #include <vnet/fib/ip6_fib.h>
28 #include <vnet/classify/vnet_classify.h>
32 * @brief In-band OAM (iOAM).
34 * In-band OAM (iOAM) is an implementation study to record operational
35 * information in the packet while the packet traverses a path between
36 * two points in the network.
38 * VPP can function as in-band OAM encapsulating, transit and
39 * decapsulating node. In this version of VPP in-band OAM data is
40 * transported as options in an IPv6 hop-by-hop extension header. Hence
41 * in-band OAM can be enabled for IPv6 traffic.
44 ip6_hop_by_hop_ioam_main_t ip6_hop_by_hop_ioam_main;
46 #define foreach_ip6_hbyh_ioam_input_next \
47 _(IP6_REWRITE, "ip6-rewrite") \
48 _(IP6_LOOKUP, "ip6-lookup") \
53 #define _(s,n) IP6_HBYH_IOAM_INPUT_NEXT_##s,
54 foreach_ip6_hbyh_ioam_input_next
56 IP6_HBYH_IOAM_INPUT_N_NEXT,
57 } ip6_hbyh_ioam_input_next_t;
61 ioam_flow_add (u8 encap, u8 * flow_name)
63 ip6_hop_by_hop_ioam_main_t *hm = &ip6_hop_by_hop_ioam_main;
64 flow_data_t *flow = 0;
68 pool_get (hm->flows, flow);
69 memset (flow, 0, sizeof (flow_data_t));
71 index = flow - hm->flows;
72 strncpy ((char *) flow->flow_name, (char *) flow_name, 31);
75 IOAM_SET_DECAP (index);
77 for (i = 0; i < 255; i++)
79 if (hm->flow_handler[i])
80 flow->ctx[i] = hm->flow_handler[i] (index, 1);
86 unformat_opaque_ioam (unformat_input_t * input, va_list * args)
88 u64 *opaquep = va_arg (*args, u64 *);
92 if (unformat (input, "ioam-encap %s", &flow_name))
94 *opaquep = ioam_flow_add (1, flow_name);
97 else if (unformat (input, "ioam-decap %s", &flow_name))
99 *opaquep = ioam_flow_add (0, flow_name);
103 vec_free (flow_name);
108 get_flow_name_from_flow_ctx (u32 flow_ctx)
110 flow_data_t *flow = NULL;
111 ip6_hop_by_hop_ioam_main_t *hm = &ip6_hop_by_hop_ioam_main;
114 index = IOAM_MASK_DECAP_BIT (flow_ctx);
116 if (pool_is_free_index (hm->flows, index))
119 flow = pool_elt_at_index (hm->flows, index);
120 return (flow->flow_name);
123 /* The main h-b-h tracer will be invoked, no need to do much here */
125 ip6_hbh_add_register_option (u8 option,
127 int rewrite_options (u8 * rewrite_string,
130 ip6_hop_by_hop_ioam_main_t *hm = &ip6_hop_by_hop_ioam_main;
132 ASSERT (option < ARRAY_LEN (hm->add_options));
134 /* Already registered */
135 if (hm->add_options[option])
138 hm->add_options[option] = rewrite_options;
139 hm->options_size[option] = size;
145 ip6_hbh_add_unregister_option (u8 option)
147 ip6_hop_by_hop_ioam_main_t *hm = &ip6_hop_by_hop_ioam_main;
149 ASSERT (option < ARRAY_LEN (hm->add_options));
152 if (!hm->add_options[option])
155 hm->add_options[option] = NULL;
156 hm->options_size[option] = 0;
160 /* Config handler registration */
162 ip6_hbh_config_handler_register (u8 option,
163 int config_handler (void *data, u8 disable))
165 ip6_hop_by_hop_ioam_main_t *hm = &ip6_hop_by_hop_ioam_main;
167 ASSERT (option < ARRAY_LEN (hm->config_handler));
169 /* Already registered */
170 if (hm->config_handler[option])
171 return (VNET_API_ERROR_INVALID_REGISTRATION);
173 hm->config_handler[option] = config_handler;
179 ip6_hbh_config_handler_unregister (u8 option)
181 ip6_hop_by_hop_ioam_main_t *hm = &ip6_hop_by_hop_ioam_main;
183 ASSERT (option < ARRAY_LEN (hm->config_handler));
186 if (!hm->config_handler[option])
187 return (VNET_API_ERROR_INVALID_REGISTRATION);
189 hm->config_handler[option] = NULL;
193 /* Flow handler registration */
195 ip6_hbh_flow_handler_register (u8 option,
196 u32 ioam_flow_handler (u32 flow_ctx, u8 add))
198 ip6_hop_by_hop_ioam_main_t *hm = &ip6_hop_by_hop_ioam_main;
200 ASSERT (option < ARRAY_LEN (hm->flow_handler));
202 /* Already registered */
203 if (hm->flow_handler[option])
204 return (VNET_API_ERROR_INVALID_REGISTRATION);
206 hm->flow_handler[option] = ioam_flow_handler;
212 ip6_hbh_flow_handler_unregister (u8 option)
214 ip6_hop_by_hop_ioam_main_t *hm = &ip6_hop_by_hop_ioam_main;
216 ASSERT (option < ARRAY_LEN (hm->flow_handler));
219 if (!hm->flow_handler[option])
220 return (VNET_API_ERROR_INVALID_REGISTRATION);
222 hm->flow_handler[option] = NULL;
229 } ip6_add_hop_by_hop_trace_t;
231 /* packet trace format function */
233 format_ip6_add_hop_by_hop_trace (u8 * s, va_list * args)
235 CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
236 CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
237 ip6_add_hop_by_hop_trace_t *t = va_arg (*args,
238 ip6_add_hop_by_hop_trace_t *);
240 s = format (s, "IP6_ADD_HOP_BY_HOP: next index %d", t->next_index);
244 vlib_node_registration_t ip6_add_hop_by_hop_node;
246 #define foreach_ip6_add_hop_by_hop_error \
247 _(PROCESSED, "Pkts w/ added ip6 hop-by-hop options")
251 #define _(sym,str) IP6_ADD_HOP_BY_HOP_ERROR_##sym,
252 foreach_ip6_add_hop_by_hop_error
254 IP6_ADD_HOP_BY_HOP_N_ERROR,
255 } ip6_add_hop_by_hop_error_t;
257 static char *ip6_add_hop_by_hop_error_strings[] = {
258 #define _(sym,string) string,
259 foreach_ip6_add_hop_by_hop_error
264 ip6_add_hop_by_hop_node_fn (vlib_main_t * vm,
265 vlib_node_runtime_t * node, vlib_frame_t * frame)
267 ip6_hop_by_hop_ioam_main_t *hm = &ip6_hop_by_hop_ioam_main;
268 u32 n_left_from, *from, *to_next;
269 ip_lookup_next_t next_index;
271 u8 *rewrite = hm->rewrite;
272 u32 rewrite_length = vec_len (rewrite);
274 from = vlib_frame_vector_args (frame);
275 n_left_from = frame->n_vectors;
276 next_index = node->cached_next_index;
278 while (n_left_from > 0)
282 vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
283 while (n_left_from >= 4 && n_left_to_next >= 2)
286 vlib_buffer_t *b0, *b1;
288 ip6_header_t *ip0, *ip1;
289 ip6_hop_by_hop_header_t *hbh0, *hbh1;
290 u64 *copy_src0, *copy_dst0, *copy_src1, *copy_dst1;
293 /* Prefetch next iteration. */
295 vlib_buffer_t *p2, *p3;
297 p2 = vlib_get_buffer (vm, from[2]);
298 p3 = vlib_get_buffer (vm, from[3]);
300 vlib_prefetch_buffer_header (p2, LOAD);
301 vlib_prefetch_buffer_header (p3, LOAD);
303 CLIB_PREFETCH (p2->data - rewrite_length,
304 2 * CLIB_CACHE_LINE_BYTES, STORE);
305 CLIB_PREFETCH (p3->data - rewrite_length,
306 2 * CLIB_CACHE_LINE_BYTES, STORE);
309 /* speculatively enqueue b0 and b1 to the current next frame */
310 to_next[0] = bi0 = from[0];
311 to_next[1] = bi1 = from[1];
317 b0 = vlib_get_buffer (vm, bi0);
318 b1 = vlib_get_buffer (vm, bi1);
320 /* $$$$$ Dual loop: process 2 x packets here $$$$$ */
321 ip0 = vlib_buffer_get_current (b0);
322 ip1 = vlib_buffer_get_current (b1);
324 /* Copy the ip header left by the required amount */
325 copy_dst0 = (u64 *) (((u8 *) ip0) - rewrite_length);
326 copy_dst1 = (u64 *) (((u8 *) ip1) - rewrite_length);
327 copy_src0 = (u64 *) ip0;
328 copy_src1 = (u64 *) ip1;
330 copy_dst0[0] = copy_src0[0];
331 copy_dst0[1] = copy_src0[1];
332 copy_dst0[2] = copy_src0[2];
333 copy_dst0[3] = copy_src0[3];
334 copy_dst0[4] = copy_src0[4];
336 copy_dst1[0] = copy_src1[0];
337 copy_dst1[1] = copy_src1[1];
338 copy_dst1[2] = copy_src1[2];
339 copy_dst1[3] = copy_src1[3];
340 copy_dst1[4] = copy_src1[4];
342 vlib_buffer_advance (b0, -(word) rewrite_length);
343 vlib_buffer_advance (b1, -(word) rewrite_length);
344 ip0 = vlib_buffer_get_current (b0);
345 ip1 = vlib_buffer_get_current (b1);
347 hbh0 = (ip6_hop_by_hop_header_t *) (ip0 + 1);
348 hbh1 = (ip6_hop_by_hop_header_t *) (ip1 + 1);
349 /* $$$ tune, rewrite_length is a multiple of 8 */
350 clib_memcpy (hbh0, rewrite, rewrite_length);
351 clib_memcpy (hbh1, rewrite, rewrite_length);
352 /* Patch the protocol chain, insert the h-b-h (type 0) header */
353 hbh0->protocol = ip0->protocol;
354 hbh1->protocol = ip1->protocol;
358 clib_net_to_host_u16 (ip0->payload_length) + rewrite_length;
360 clib_net_to_host_u16 (ip1->payload_length) + rewrite_length;
361 ip0->payload_length = clib_host_to_net_u16 (new_l0);
362 ip1->payload_length = clib_host_to_net_u16 (new_l1);
364 /* Populate the (first) h-b-h list elt */
365 next0 = IP6_HBYH_IOAM_INPUT_NEXT_IP6_LOOKUP;
366 next1 = IP6_HBYH_IOAM_INPUT_NEXT_IP6_LOOKUP;
369 /* $$$$$ End of processing 2 x packets $$$$$ */
371 if (PREDICT_FALSE ((node->flags & VLIB_NODE_FLAG_TRACE)))
373 if (b0->flags & VLIB_BUFFER_IS_TRACED)
375 ip6_add_hop_by_hop_trace_t *t =
376 vlib_add_trace (vm, node, b0, sizeof (*t));
377 t->next_index = next0;
379 if (b1->flags & VLIB_BUFFER_IS_TRACED)
381 ip6_add_hop_by_hop_trace_t *t =
382 vlib_add_trace (vm, node, b1, sizeof (*t));
383 t->next_index = next1;
387 /* verify speculative enqueues, maybe switch current next frame */
388 vlib_validate_buffer_enqueue_x2 (vm, node, next_index,
389 to_next, n_left_to_next,
390 bi0, bi1, next0, next1);
392 while (n_left_from > 0 && n_left_to_next > 0)
398 ip6_hop_by_hop_header_t *hbh0;
399 u64 *copy_src0, *copy_dst0;
402 /* speculatively enqueue b0 to the current next frame */
410 b0 = vlib_get_buffer (vm, bi0);
412 ip0 = vlib_buffer_get_current (b0);
414 /* Copy the ip header left by the required amount */
415 copy_dst0 = (u64 *) (((u8 *) ip0) - rewrite_length);
416 copy_src0 = (u64 *) ip0;
418 copy_dst0[0] = copy_src0[0];
419 copy_dst0[1] = copy_src0[1];
420 copy_dst0[2] = copy_src0[2];
421 copy_dst0[3] = copy_src0[3];
422 copy_dst0[4] = copy_src0[4];
423 vlib_buffer_advance (b0, -(word) rewrite_length);
424 ip0 = vlib_buffer_get_current (b0);
426 hbh0 = (ip6_hop_by_hop_header_t *) (ip0 + 1);
427 /* $$$ tune, rewrite_length is a multiple of 8 */
428 clib_memcpy (hbh0, rewrite, rewrite_length);
429 /* Patch the protocol chain, insert the h-b-h (type 0) header */
430 hbh0->protocol = ip0->protocol;
433 clib_net_to_host_u16 (ip0->payload_length) + rewrite_length;
434 ip0->payload_length = clib_host_to_net_u16 (new_l0);
436 /* Populate the (first) h-b-h list elt */
437 next0 = IP6_HBYH_IOAM_INPUT_NEXT_IP6_LOOKUP;
439 if (PREDICT_FALSE ((node->flags & VLIB_NODE_FLAG_TRACE)
440 && (b0->flags & VLIB_BUFFER_IS_TRACED)))
442 ip6_add_hop_by_hop_trace_t *t =
443 vlib_add_trace (vm, node, b0, sizeof (*t));
444 t->next_index = next0;
449 /* verify speculative enqueue, maybe switch current next frame */
450 vlib_validate_buffer_enqueue_x1 (vm, node, next_index,
451 to_next, n_left_to_next,
455 vlib_put_next_frame (vm, node, next_index, n_left_to_next);
458 vlib_node_increment_counter (vm, ip6_add_hop_by_hop_node.index,
459 IP6_ADD_HOP_BY_HOP_ERROR_PROCESSED, processed);
460 return frame->n_vectors;
464 VLIB_REGISTER_NODE (ip6_add_hop_by_hop_node) = /* *INDENT-OFF* */
466 .function = ip6_add_hop_by_hop_node_fn,.name =
467 "ip6-add-hop-by-hop",.vector_size = sizeof (u32),.format_trace =
468 format_ip6_add_hop_by_hop_trace,.type =
469 VLIB_NODE_TYPE_INTERNAL,.n_errors =
470 ARRAY_LEN (ip6_add_hop_by_hop_error_strings),.error_strings =
471 ip6_add_hop_by_hop_error_strings,
472 /* See ip/lookup.h */
473 .n_next_nodes = IP6_HBYH_IOAM_INPUT_N_NEXT,.next_nodes =
475 #define _(s,n) [IP6_HBYH_IOAM_INPUT_NEXT_##s] = n,
476 foreach_ip6_hbyh_ioam_input_next
484 VLIB_NODE_FUNCTION_MULTIARCH (ip6_add_hop_by_hop_node,
485 ip6_add_hop_by_hop_node_fn);
486 /* The main h-b-h tracer was already invoked, no need to do much here */
490 } ip6_pop_hop_by_hop_trace_t;
492 /* packet trace format function */
494 format_ip6_pop_hop_by_hop_trace (u8 * s, va_list * args)
496 CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
497 CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
498 ip6_pop_hop_by_hop_trace_t *t =
499 va_arg (*args, ip6_pop_hop_by_hop_trace_t *);
501 s = format (s, "IP6_POP_HOP_BY_HOP: next index %d", t->next_index);
506 ip6_hbh_pop_register_option (u8 option,
507 int options (vlib_buffer_t * b,
509 ip6_hop_by_hop_option_t * opt))
511 ip6_hop_by_hop_ioam_main_t *hm = &ip6_hop_by_hop_ioam_main;
513 ASSERT (option < ARRAY_LEN (hm->pop_options));
515 /* Already registered */
516 if (hm->pop_options[option])
519 hm->pop_options[option] = options;
525 ip6_hbh_pop_unregister_option (u8 option)
527 ip6_hop_by_hop_ioam_main_t *hm = &ip6_hop_by_hop_ioam_main;
529 ASSERT (option < ARRAY_LEN (hm->pop_options));
532 if (!hm->pop_options[option])
535 hm->pop_options[option] = NULL;
539 vlib_node_registration_t ip6_pop_hop_by_hop_node;
541 #define foreach_ip6_pop_hop_by_hop_error \
542 _(PROCESSED, "Pkts w/ removed ip6 hop-by-hop options") \
543 _(NO_HOHO, "Pkts w/ no ip6 hop-by-hop options") \
544 _(OPTION_FAILED, "ip6 pop hop-by-hop failed to process")
548 #define _(sym,str) IP6_POP_HOP_BY_HOP_ERROR_##sym,
549 foreach_ip6_pop_hop_by_hop_error
551 IP6_POP_HOP_BY_HOP_N_ERROR,
552 } ip6_pop_hop_by_hop_error_t;
554 static char *ip6_pop_hop_by_hop_error_strings[] = {
555 #define _(sym,string) string,
556 foreach_ip6_pop_hop_by_hop_error
561 ioam_pop_hop_by_hop_processing (vlib_main_t * vm,
563 ip6_hop_by_hop_header_t * hbh0,
566 ip6_hop_by_hop_ioam_main_t *hm = &ip6_hop_by_hop_ioam_main;
567 ip6_hop_by_hop_option_t *opt0, *limit0;
573 opt0 = (ip6_hop_by_hop_option_t *) (hbh0 + 1);
574 limit0 = (ip6_hop_by_hop_option_t *)
575 ((u8 *) hbh0 + ((hbh0->length + 1) << 3));
577 /* Scan the set of h-b-h options, process ones that we understand */
578 while (opt0 < limit0)
584 opt0 = (ip6_hop_by_hop_option_t *) ((u8 *) opt0) + 1;
589 if (hm->pop_options[type0])
591 if ((*hm->pop_options[type0]) (b, ip0, opt0) < 0)
593 vlib_node_increment_counter (vm,
594 ip6_pop_hop_by_hop_node.index,
595 IP6_POP_HOP_BY_HOP_ERROR_OPTION_FAILED,
601 (ip6_hop_by_hop_option_t *) (((u8 *) opt0) + opt0->length +
602 sizeof (ip6_hop_by_hop_option_t));
607 ip6_pop_hop_by_hop_node_fn (vlib_main_t * vm,
608 vlib_node_runtime_t * node, vlib_frame_t * frame)
610 ip6_main_t *im = &ip6_main;
611 ip_lookup_main_t *lm = &im->lookup_main;
612 u32 n_left_from, *from, *to_next;
613 ip_lookup_next_t next_index;
617 from = vlib_frame_vector_args (frame);
618 n_left_from = frame->n_vectors;
619 next_index = node->cached_next_index;
621 while (n_left_from > 0)
625 vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
627 while (n_left_from >= 4 && n_left_to_next >= 2)
630 vlib_buffer_t *b0, *b1;
632 u32 adj_index0, adj_index1;
633 ip6_header_t *ip0, *ip1;
634 ip_adjacency_t *adj0, *adj1;
635 ip6_hop_by_hop_header_t *hbh0, *hbh1;
636 u64 *copy_dst0, *copy_src0, *copy_dst1, *copy_src1;
639 /* Prefetch next iteration. */
641 vlib_buffer_t *p2, *p3;
643 p2 = vlib_get_buffer (vm, from[2]);
644 p3 = vlib_get_buffer (vm, from[3]);
646 vlib_prefetch_buffer_header (p2, LOAD);
647 vlib_prefetch_buffer_header (p3, LOAD);
649 CLIB_PREFETCH (p2->data, CLIB_CACHE_LINE_BYTES, STORE);
650 CLIB_PREFETCH (p3->data, CLIB_CACHE_LINE_BYTES, STORE);
653 /* speculatively enqueue b0 and b1 to the current next frame */
654 to_next[0] = bi0 = from[0];
655 to_next[1] = bi1 = from[1];
661 b0 = vlib_get_buffer (vm, bi0);
662 b1 = vlib_get_buffer (vm, bi1);
664 /* $$$$$ Dual loop: process 2 x packets here $$$$$ */
665 ip0 = vlib_buffer_get_current (b0);
666 ip1 = vlib_buffer_get_current (b1);
667 adj_index0 = vnet_buffer (b0)->ip.adj_index[VLIB_TX];
668 adj_index1 = vnet_buffer (b1)->ip.adj_index[VLIB_TX];
669 adj0 = ip_get_adjacency (lm, adj_index0);
670 adj1 = ip_get_adjacency (lm, adj_index1);
672 next0 = adj0->lookup_next_index;
673 next1 = adj1->lookup_next_index;
675 hbh0 = (ip6_hop_by_hop_header_t *) (ip0 + 1);
676 hbh1 = (ip6_hop_by_hop_header_t *) (ip1 + 1);
678 ioam_pop_hop_by_hop_processing (vm, ip0, hbh0, b0);
679 ioam_pop_hop_by_hop_processing (vm, ip1, hbh1, b1);
681 vlib_buffer_advance (b0, (hbh0->length + 1) << 3);
682 vlib_buffer_advance (b1, (hbh1->length + 1) << 3);
684 new_l0 = clib_net_to_host_u16 (ip0->payload_length) -
685 ((hbh0->length + 1) << 3);
686 new_l1 = clib_net_to_host_u16 (ip1->payload_length) -
687 ((hbh1->length + 1) << 3);
689 ip0->payload_length = clib_host_to_net_u16 (new_l0);
690 ip1->payload_length = clib_host_to_net_u16 (new_l1);
692 ip0->protocol = hbh0->protocol;
693 ip1->protocol = hbh1->protocol;
695 copy_src0 = (u64 *) ip0;
696 copy_src1 = (u64 *) ip1;
697 copy_dst0 = copy_src0 + (hbh0->length + 1);
698 copy_dst0[4] = copy_src0[4];
699 copy_dst0[3] = copy_src0[3];
700 copy_dst0[2] = copy_src0[2];
701 copy_dst0[1] = copy_src0[1];
702 copy_dst0[0] = copy_src0[0];
703 copy_dst1 = copy_src1 + (hbh1->length + 1);
704 copy_dst1[4] = copy_src1[4];
705 copy_dst1[3] = copy_src1[3];
706 copy_dst1[2] = copy_src1[2];
707 copy_dst1[1] = copy_src1[1];
708 copy_dst1[0] = copy_src1[0];
710 /* $$$$$ End of processing 2 x packets $$$$$ */
712 if (PREDICT_FALSE ((node->flags & VLIB_NODE_FLAG_TRACE)))
714 if (b0->flags & VLIB_BUFFER_IS_TRACED)
716 ip6_pop_hop_by_hop_trace_t *t =
717 vlib_add_trace (vm, node, b0, sizeof (*t));
718 t->next_index = next0;
720 if (b1->flags & VLIB_BUFFER_IS_TRACED)
722 ip6_pop_hop_by_hop_trace_t *t =
723 vlib_add_trace (vm, node, b1, sizeof (*t));
724 t->next_index = next1;
728 /* verify speculative enqueues, maybe switch current next frame */
729 vlib_validate_buffer_enqueue_x2 (vm, node, next_index,
730 to_next, n_left_to_next,
731 bi0, bi1, next0, next1);
734 while (n_left_from > 0 && n_left_to_next > 0)
741 ip_adjacency_t *adj0;
742 ip6_hop_by_hop_header_t *hbh0;
743 u64 *copy_dst0, *copy_src0;
746 /* speculatively enqueue b0 to the current next frame */
754 b0 = vlib_get_buffer (vm, bi0);
756 ip0 = vlib_buffer_get_current (b0);
757 adj_index0 = vnet_buffer (b0)->ip.adj_index[VLIB_TX];
758 adj0 = ip_get_adjacency (lm, adj_index0);
760 /* Default use the next_index from the adjacency. */
761 next0 = adj0->lookup_next_index;
763 /* Perfectly normal to end up here w/ out h-b-h header */
764 hbh0 = (ip6_hop_by_hop_header_t *) (ip0 + 1);
766 /* TODO:Temporarily doing it here.. do this validation in end_of_path_cb */
767 ioam_pop_hop_by_hop_processing (vm, ip0, hbh0, b0);
768 /* Pop the trace data */
769 vlib_buffer_advance (b0, (hbh0->length + 1) << 3);
770 new_l0 = clib_net_to_host_u16 (ip0->payload_length) -
771 ((hbh0->length + 1) << 3);
772 ip0->payload_length = clib_host_to_net_u16 (new_l0);
773 ip0->protocol = hbh0->protocol;
774 copy_src0 = (u64 *) ip0;
775 copy_dst0 = copy_src0 + (hbh0->length + 1);
776 copy_dst0[4] = copy_src0[4];
777 copy_dst0[3] = copy_src0[3];
778 copy_dst0[2] = copy_src0[2];
779 copy_dst0[1] = copy_src0[1];
780 copy_dst0[0] = copy_src0[0];
783 if (PREDICT_FALSE ((node->flags & VLIB_NODE_FLAG_TRACE)
784 && (b0->flags & VLIB_BUFFER_IS_TRACED)))
786 ip6_pop_hop_by_hop_trace_t *t =
787 vlib_add_trace (vm, node, b0, sizeof (*t));
788 t->next_index = next0;
791 /* verify speculative enqueue, maybe switch current next frame */
792 vlib_validate_buffer_enqueue_x1 (vm, node, next_index,
793 to_next, n_left_to_next,
797 vlib_put_next_frame (vm, node, next_index, n_left_to_next);
800 vlib_node_increment_counter (vm, ip6_pop_hop_by_hop_node.index,
801 IP6_POP_HOP_BY_HOP_ERROR_PROCESSED, processed);
802 vlib_node_increment_counter (vm, ip6_pop_hop_by_hop_node.index,
803 IP6_POP_HOP_BY_HOP_ERROR_NO_HOHO, no_header);
804 return frame->n_vectors;
808 VLIB_REGISTER_NODE (ip6_pop_hop_by_hop_node) =
810 .function = ip6_pop_hop_by_hop_node_fn,.name =
811 "ip6-pop-hop-by-hop",.vector_size = sizeof (u32),.format_trace =
812 format_ip6_pop_hop_by_hop_trace,.type =
813 VLIB_NODE_TYPE_INTERNAL,.sibling_of = "ip6-lookup",.n_errors =
814 ARRAY_LEN (ip6_pop_hop_by_hop_error_strings),.error_strings =
815 ip6_pop_hop_by_hop_error_strings,
816 /* See ip/lookup.h */
821 VLIB_NODE_FUNCTION_MULTIARCH (ip6_pop_hop_by_hop_node,
822 ip6_pop_hop_by_hop_node_fn);
823 static clib_error_t *
824 ip6_hop_by_hop_ioam_init (vlib_main_t * vm)
827 ip6_hop_by_hop_ioam_main_t *hm = &ip6_hop_by_hop_ioam_main;
829 if ((error = vlib_call_init_function (vm, ip_main_init)))
832 if ((error = vlib_call_init_function (vm, ip6_lookup_init)))
836 hm->vnet_main = vnet_get_main ();
837 hm->unix_time_0 = (u32) time (0); /* Store starting time */
838 hm->vlib_time_0 = vlib_time_now (vm);
839 hm->ioam_flag = IOAM_HBYH_MOD;
840 memset (hm->add_options, 0, sizeof (hm->add_options));
841 memset (hm->pop_options, 0, sizeof (hm->pop_options));
842 memset (hm->options_size, 0, sizeof (hm->options_size));
844 vnet_classify_register_unformat_opaque_index_fn (unformat_opaque_ioam);
849 VLIB_INIT_FUNCTION (ip6_hop_by_hop_ioam_init);
852 ip6_ioam_set_rewrite (u8 ** rwp, int has_trace_option,
853 int has_pot_option, int has_seqno_option)
855 ip6_hop_by_hop_ioam_main_t *hm = &ip6_hop_by_hop_ioam_main;
858 ip6_hop_by_hop_header_t *hbh;
860 u8 *trace_data_size = NULL;
861 u8 *pot_data_size = NULL;
865 if (has_trace_option == 0 && has_pot_option == 0)
868 /* Work out how much space we need */
869 size = sizeof (ip6_hop_by_hop_header_t);
871 //if (has_trace_option && hm->get_sizeof_options[HBH_OPTION_TYPE_IOAM_TRACE_DATA_LIST] != 0)
873 && hm->options_size[HBH_OPTION_TYPE_IOAM_TRACE_DATA_LIST] != 0)
875 size += hm->options_size[HBH_OPTION_TYPE_IOAM_TRACE_DATA_LIST];
878 && hm->add_options[HBH_OPTION_TYPE_IOAM_PROOF_OF_TRANSIT] != 0)
880 size += hm->options_size[HBH_OPTION_TYPE_IOAM_PROOF_OF_TRANSIT];
883 if (has_seqno_option)
885 size += hm->options_size[HBH_OPTION_TYPE_IOAM_EDGE_TO_EDGE];
888 /* Round to a multiple of 8 octets */
889 rnd_size = (size + 7) & ~7;
891 /* allocate it, zero-fill / pad by construction */
892 vec_validate (rewrite, rnd_size - 1);
894 hbh = (ip6_hop_by_hop_header_t *) rewrite;
895 /* Length of header in 8 octet units, not incl first 8 octets */
896 hbh->length = (rnd_size >> 3) - 1;
897 current = (u8 *) (hbh + 1);
900 && hm->add_options[HBH_OPTION_TYPE_IOAM_TRACE_DATA_LIST] != 0)
902 if (0 != (hm->options_size[HBH_OPTION_TYPE_IOAM_TRACE_DATA_LIST]))
905 &hm->options_size[HBH_OPTION_TYPE_IOAM_TRACE_DATA_LIST];
907 hm->add_options[HBH_OPTION_TYPE_IOAM_TRACE_DATA_LIST] (current,
909 current += *trace_data_size;
913 && hm->add_options[HBH_OPTION_TYPE_IOAM_PROOF_OF_TRANSIT] != 0)
916 &hm->options_size[HBH_OPTION_TYPE_IOAM_PROOF_OF_TRANSIT];
918 hm->add_options[HBH_OPTION_TYPE_IOAM_PROOF_OF_TRANSIT] (current,
920 current += *pot_data_size;
923 if (has_seqno_option &&
924 (hm->add_options[HBH_OPTION_TYPE_IOAM_EDGE_TO_EDGE] != 0))
926 if (0 == hm->add_options[HBH_OPTION_TYPE_IOAM_EDGE_TO_EDGE] (current,
929 [HBH_OPTION_TYPE_IOAM_EDGE_TO_EDGE])))
930 current += hm->options_size[HBH_OPTION_TYPE_IOAM_EDGE_TO_EDGE];
938 clear_ioam_rewrite_fn (void)
940 ip6_hop_by_hop_ioam_main_t *hm = &ip6_hop_by_hop_ioam_main;
942 vec_free (hm->rewrite);
944 hm->has_trace_option = 0;
945 hm->has_pot_option = 0;
946 hm->has_seqno_option = 0;
947 hm->has_analyse_option = 0;
948 if (hm->config_handler[HBH_OPTION_TYPE_IOAM_TRACE_DATA_LIST])
949 hm->config_handler[HBH_OPTION_TYPE_IOAM_TRACE_DATA_LIST] (NULL, 1);
951 if (hm->config_handler[HBH_OPTION_TYPE_IOAM_PROOF_OF_TRANSIT])
952 hm->config_handler[HBH_OPTION_TYPE_IOAM_PROOF_OF_TRANSIT] (NULL, 1);
954 if (hm->config_handler[HBH_OPTION_TYPE_IOAM_EDGE_TO_EDGE])
956 hm->config_handler[HBH_OPTION_TYPE_IOAM_EDGE_TO_EDGE] ((void *)
957 &hm->has_analyse_option,
965 clear_ioam_rewrite_command_fn (vlib_main_t * vm,
966 unformat_input_t * input,
967 vlib_cli_command_t * cmd)
969 return (clear_ioam_rewrite_fn ());
973 * This command clears all the In-band OAM (iOAM) features enabled by
974 * the '<em>set ioam rewrite</em>' command. Use '<em>show ioam summary</em>' to
975 * verify the configured settings cleared.
978 * Example of how to clear iOAM features:
979 * @cliexcmd{clear ioam rewrite}
982 VLIB_CLI_COMMAND (ip6_clear_ioam_rewrite_cmd, static) = {
983 .path = "clear ioam rewrite",
984 .short_help = "clear ioam rewrite",
985 .function = clear_ioam_rewrite_command_fn,
990 ip6_ioam_enable (int has_trace_option, int has_pot_option,
991 int has_seqno_option, int has_analyse_option)
994 ip6_hop_by_hop_ioam_main_t *hm = &ip6_hop_by_hop_ioam_main;
995 rv = ip6_ioam_set_rewrite (&hm->rewrite, has_trace_option,
996 has_pot_option, has_seqno_option);
1001 if (has_trace_option)
1003 hm->has_trace_option = has_trace_option;
1004 if (hm->config_handler[HBH_OPTION_TYPE_IOAM_TRACE_DATA_LIST])
1005 hm->config_handler[HBH_OPTION_TYPE_IOAM_TRACE_DATA_LIST] (NULL,
1011 hm->has_pot_option = has_pot_option;
1012 if (hm->config_handler[HBH_OPTION_TYPE_IOAM_PROOF_OF_TRANSIT])
1013 hm->config_handler[HBH_OPTION_TYPE_IOAM_PROOF_OF_TRANSIT] (NULL,
1016 hm->has_analyse_option = has_analyse_option;
1017 if (has_seqno_option)
1019 hm->has_seqno_option = has_seqno_option;
1020 if (hm->config_handler[HBH_OPTION_TYPE_IOAM_EDGE_TO_EDGE])
1022 hm->config_handler[HBH_OPTION_TYPE_IOAM_EDGE_TO_EDGE] ((void *)
1023 &has_analyse_option,
1030 return clib_error_return_code (0, rv, 0,
1031 "ip6_ioam_set_rewrite returned %d", rv);
1038 static clib_error_t *
1039 ip6_set_ioam_rewrite_command_fn (vlib_main_t * vm,
1040 unformat_input_t * input,
1041 vlib_cli_command_t * cmd)
1043 int has_trace_option = 0;
1044 int has_pot_option = 0;
1045 int has_seqno_option = 0;
1046 int has_analyse_option = 0;
1047 clib_error_t *rv = 0;
1049 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1051 if (unformat (input, "trace"))
1052 has_trace_option = 1;
1053 else if (unformat (input, "pot"))
1055 else if (unformat (input, "seqno"))
1056 has_seqno_option = 1;
1057 else if (unformat (input, "analyse"))
1058 has_analyse_option = 1;
1064 rv = ip6_ioam_enable (has_trace_option, has_pot_option,
1065 has_seqno_option, has_analyse_option);
1071 * This command is used to enable In-band OAM (iOAM) features on IPv6.
1072 * '<em>trace</em>' is used to enable iOAM trace feature. '<em>pot</em>' is used to
1073 * enable the Proof Of Transit feature. '<em>ppc</em>' is used to indicate the
1074 * Per Packet Counter feature for Edge to Edge processing. '<em>ppc</em>' is
1075 * used to indicate if this node is an '<em>encap</em>' node (iOAM edge node
1076 * where packet enters iOAM domain), a '<em>decap</em>' node (iOAM edge node
1077 * where packet leaves iOAM domain) or '<em>none</em>' (iOAM node where packet
1078 * is in-transit through the iOAM domain). '<em>ppc</em>' can only be set if
1079 * '<em>trace</em>' or '<em>pot</em>' is enabled.
1081 * Use '<em>clear ioam rewrite</em>' to disable all features enabled by this
1082 * command. Use '<em>show ioam summary</em>' to verify the configured settings.
1085 * Example of how to enable trace and pot with ppc set to encap:
1086 * @cliexcmd{set ioam rewrite trace pot ppc encap}
1089 VLIB_CLI_COMMAND (ip6_set_ioam_rewrite_cmd, static) = {
1090 .path = "set ioam rewrite",
1091 .short_help = "set ioam [trace] [pot] [seqno] [analyse]",
1092 .function = ip6_set_ioam_rewrite_command_fn,
1096 static clib_error_t *
1097 ip6_show_ioam_summary_cmd_fn (vlib_main_t * vm,
1098 unformat_input_t * input,
1099 vlib_cli_command_t * cmd)
1101 ip6_hop_by_hop_ioam_main_t *hm = &ip6_hop_by_hop_ioam_main;
1105 if (!is_zero_ip6_address (&hm->adj))
1107 s = format (s, " REWRITE FLOW CONFIGS - \n");
1108 s = format (s, " Destination Address : %U\n",
1109 format_ip6_address, &hm->adj, sizeof (ip6_address_t));
1111 format (s, " Flow operation : %d (%s)\n",
1114 IOAM_HBYH_ADD) ? "Add" : ((hm->ioam_flag ==
1115 IOAM_HBYH_MOD) ? "Mod" : "Pop"));
1119 s = format (s, " REWRITE FLOW CONFIGS - Not configured\n");
1123 s = format (s, " TRACE OPTION - %d (%s)\n",
1124 hm->has_trace_option,
1125 (hm->has_trace_option ? "Enabled" : "Disabled"));
1126 if (hm->has_trace_option)
1129 "Try 'show ioam trace and show ioam-trace profile' for more information\n");
1132 s = format (s, " POT OPTION - %d (%s)\n",
1134 (hm->has_pot_option ? "Enabled" : "Disabled"));
1135 if (hm->has_pot_option)
1138 "Try 'show ioam pot and show pot profile' for more information\n");
1140 s = format (s, " EDGE TO EDGE - SeqNo OPTION - %d (%s)\n",
1141 hm->has_seqno_option,
1142 hm->has_seqno_option ? "Enabled" : "Disabled");
1143 if (hm->has_seqno_option)
1144 s = format (s, "Try 'show ioam e2e' for more information\n");
1146 s = format (s, " iOAM Analyse OPTION - %d (%s)\n",
1147 hm->has_analyse_option,
1148 hm->has_analyse_option ? "Enabled" : "Disabled");
1150 vlib_cli_output (vm, "%v", s);
1156 * This command displays the current configuration data for In-band
1160 * Example to show the iOAM configuration:
1161 * @cliexstart{show ioam summary}
1162 * REWRITE FLOW CONFIGS -
1163 * Destination Address : ff02::1
1164 * Flow operation : 2 (Pop)
1165 * TRACE OPTION - 1 (Enabled)
1166 * Try 'show ioam trace and show ioam-trace profile' for more information
1167 * POT OPTION - 1 (Enabled)
1168 * Try 'show ioam pot and show pot profile' for more information
1169 * EDGE TO EDGE - PPC OPTION - 1 (Encap)
1173 VLIB_CLI_COMMAND (ip6_show_ioam_run_cmd, static) = {
1174 .path = "show ioam summary",
1175 .short_help = "show ioam summary",
1176 .function = ip6_show_ioam_summary_cmd_fn,
1181 vnet_register_ioam_end_of_path_callback (void *cb)
1183 ip6_hop_by_hop_ioam_main_t *hm = &ip6_hop_by_hop_ioam_main;
1185 hm->ioam_end_of_path_cb = cb;
1189 * fd.io coding-style-patch-verification: ON
1192 * eval: (c-set-style "gnu")