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;
60 unformat_opaque_ioam (unformat_input_t * input, va_list * args)
62 u64 *opaquep = va_arg (*args, u64 *);
66 if (unformat (input, "ioam-encap %s", &flow_name))
68 *opaquep = ioam_flow_add (1, flow_name);
71 else if (unformat (input, "ioam-decap %s", &flow_name))
73 *opaquep = ioam_flow_add (0, flow_name);
82 get_flow_name_from_flow_ctx (u32 flow_ctx)
84 flow_data_t *flow = NULL;
85 ip6_hop_by_hop_ioam_main_t *hm = &ip6_hop_by_hop_ioam_main;
88 index = IOAM_MASK_DECAP_BIT (flow_ctx);
90 if (pool_is_free_index (hm->flows, index))
93 flow = pool_elt_at_index (hm->flows, index);
94 return (flow->flow_name);
97 /* The main h-b-h tracer will be invoked, no need to do much here */
99 ip6_hbh_add_register_option (u8 option,
101 int rewrite_options (u8 * rewrite_string,
104 ip6_hop_by_hop_ioam_main_t *hm = &ip6_hop_by_hop_ioam_main;
106 ASSERT (option < ARRAY_LEN (hm->add_options));
108 /* Already registered */
109 if (hm->add_options[option])
112 hm->add_options[option] = rewrite_options;
113 hm->options_size[option] = size;
119 ip6_hbh_add_unregister_option (u8 option)
121 ip6_hop_by_hop_ioam_main_t *hm = &ip6_hop_by_hop_ioam_main;
123 ASSERT (option < ARRAY_LEN (hm->add_options));
126 if (!hm->add_options[option])
129 hm->add_options[option] = NULL;
130 hm->options_size[option] = 0;
134 /* Config handler registration */
136 ip6_hbh_config_handler_register (u8 option,
137 int config_handler (void *data, u8 disable))
139 ip6_hop_by_hop_ioam_main_t *hm = &ip6_hop_by_hop_ioam_main;
141 ASSERT (option < ARRAY_LEN (hm->config_handler));
143 /* Already registered */
144 if (hm->config_handler[option])
145 return (VNET_API_ERROR_INVALID_REGISTRATION);
147 hm->config_handler[option] = config_handler;
153 ip6_hbh_config_handler_unregister (u8 option)
155 ip6_hop_by_hop_ioam_main_t *hm = &ip6_hop_by_hop_ioam_main;
157 ASSERT (option < ARRAY_LEN (hm->config_handler));
160 if (!hm->config_handler[option])
161 return (VNET_API_ERROR_INVALID_REGISTRATION);
163 hm->config_handler[option] = NULL;
167 /* Flow handler registration */
169 ip6_hbh_flow_handler_register (u8 option,
170 u32 ioam_flow_handler (u32 flow_ctx, u8 add))
172 ip6_hop_by_hop_ioam_main_t *hm = &ip6_hop_by_hop_ioam_main;
174 ASSERT (option < ARRAY_LEN (hm->flow_handler));
176 /* Already registered */
177 if (hm->flow_handler[option])
178 return (VNET_API_ERROR_INVALID_REGISTRATION);
180 hm->flow_handler[option] = ioam_flow_handler;
186 ip6_hbh_flow_handler_unregister (u8 option)
188 ip6_hop_by_hop_ioam_main_t *hm = &ip6_hop_by_hop_ioam_main;
190 ASSERT (option < ARRAY_LEN (hm->flow_handler));
193 if (!hm->flow_handler[option])
194 return (VNET_API_ERROR_INVALID_REGISTRATION);
196 hm->flow_handler[option] = NULL;
203 } ip6_add_hop_by_hop_trace_t;
205 /* packet trace format function */
207 format_ip6_add_hop_by_hop_trace (u8 * s, va_list * args)
209 CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
210 CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
211 ip6_add_hop_by_hop_trace_t *t = va_arg (*args,
212 ip6_add_hop_by_hop_trace_t *);
214 s = format (s, "IP6_ADD_HOP_BY_HOP: next index %d", t->next_index);
218 vlib_node_registration_t ip6_add_hop_by_hop_node;
220 #define foreach_ip6_add_hop_by_hop_error \
221 _(PROCESSED, "Pkts w/ added ip6 hop-by-hop options")
225 #define _(sym,str) IP6_ADD_HOP_BY_HOP_ERROR_##sym,
226 foreach_ip6_add_hop_by_hop_error
228 IP6_ADD_HOP_BY_HOP_N_ERROR,
229 } ip6_add_hop_by_hop_error_t;
231 static char *ip6_add_hop_by_hop_error_strings[] = {
232 #define _(sym,string) string,
233 foreach_ip6_add_hop_by_hop_error
238 ip6_add_hop_by_hop_node_fn (vlib_main_t * vm,
239 vlib_node_runtime_t * node, vlib_frame_t * frame)
241 ip6_hop_by_hop_ioam_main_t *hm = &ip6_hop_by_hop_ioam_main;
242 u32 n_left_from, *from, *to_next;
243 ip_lookup_next_t next_index;
245 u8 *rewrite = hm->rewrite;
246 u32 rewrite_length = vec_len (rewrite);
248 from = vlib_frame_vector_args (frame);
249 n_left_from = frame->n_vectors;
250 next_index = node->cached_next_index;
252 while (n_left_from > 0)
256 vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
257 while (n_left_from >= 4 && n_left_to_next >= 2)
260 vlib_buffer_t *b0, *b1;
262 ip6_header_t *ip0, *ip1;
263 ip6_hop_by_hop_header_t *hbh0, *hbh1;
264 u64 *copy_src0, *copy_dst0, *copy_src1, *copy_dst1;
267 /* Prefetch next iteration. */
269 vlib_buffer_t *p2, *p3;
271 p2 = vlib_get_buffer (vm, from[2]);
272 p3 = vlib_get_buffer (vm, from[3]);
274 vlib_prefetch_buffer_header (p2, LOAD);
275 vlib_prefetch_buffer_header (p3, LOAD);
277 CLIB_PREFETCH (p2->data - rewrite_length,
278 2 * CLIB_CACHE_LINE_BYTES, STORE);
279 CLIB_PREFETCH (p3->data - rewrite_length,
280 2 * CLIB_CACHE_LINE_BYTES, STORE);
283 /* speculatively enqueue b0 and b1 to the current next frame */
284 to_next[0] = bi0 = from[0];
285 to_next[1] = bi1 = from[1];
291 b0 = vlib_get_buffer (vm, bi0);
292 b1 = vlib_get_buffer (vm, bi1);
294 /* $$$$$ Dual loop: process 2 x packets here $$$$$ */
295 ip0 = vlib_buffer_get_current (b0);
296 ip1 = vlib_buffer_get_current (b1);
298 /* Copy the ip header left by the required amount */
299 copy_dst0 = (u64 *) (((u8 *) ip0) - rewrite_length);
300 copy_dst1 = (u64 *) (((u8 *) ip1) - rewrite_length);
301 copy_src0 = (u64 *) ip0;
302 copy_src1 = (u64 *) ip1;
304 copy_dst0[0] = copy_src0[0];
305 copy_dst0[1] = copy_src0[1];
306 copy_dst0[2] = copy_src0[2];
307 copy_dst0[3] = copy_src0[3];
308 copy_dst0[4] = copy_src0[4];
310 copy_dst1[0] = copy_src1[0];
311 copy_dst1[1] = copy_src1[1];
312 copy_dst1[2] = copy_src1[2];
313 copy_dst1[3] = copy_src1[3];
314 copy_dst1[4] = copy_src1[4];
316 vlib_buffer_advance (b0, -(word) rewrite_length);
317 vlib_buffer_advance (b1, -(word) rewrite_length);
318 ip0 = vlib_buffer_get_current (b0);
319 ip1 = vlib_buffer_get_current (b1);
321 hbh0 = (ip6_hop_by_hop_header_t *) (ip0 + 1);
322 hbh1 = (ip6_hop_by_hop_header_t *) (ip1 + 1);
323 /* $$$ tune, rewrite_length is a multiple of 8 */
324 clib_memcpy (hbh0, rewrite, rewrite_length);
325 clib_memcpy (hbh1, rewrite, rewrite_length);
326 /* Patch the protocol chain, insert the h-b-h (type 0) header */
327 hbh0->protocol = ip0->protocol;
328 hbh1->protocol = ip1->protocol;
332 clib_net_to_host_u16 (ip0->payload_length) + rewrite_length;
334 clib_net_to_host_u16 (ip1->payload_length) + rewrite_length;
335 ip0->payload_length = clib_host_to_net_u16 (new_l0);
336 ip1->payload_length = clib_host_to_net_u16 (new_l1);
338 /* Populate the (first) h-b-h list elt */
339 next0 = IP6_HBYH_IOAM_INPUT_NEXT_IP6_LOOKUP;
340 next1 = IP6_HBYH_IOAM_INPUT_NEXT_IP6_LOOKUP;
343 /* $$$$$ End of processing 2 x packets $$$$$ */
345 if (PREDICT_FALSE ((node->flags & VLIB_NODE_FLAG_TRACE)))
347 if (b0->flags & VLIB_BUFFER_IS_TRACED)
349 ip6_add_hop_by_hop_trace_t *t =
350 vlib_add_trace (vm, node, b0, sizeof (*t));
351 t->next_index = next0;
353 if (b1->flags & VLIB_BUFFER_IS_TRACED)
355 ip6_add_hop_by_hop_trace_t *t =
356 vlib_add_trace (vm, node, b1, sizeof (*t));
357 t->next_index = next1;
361 /* verify speculative enqueues, maybe switch current next frame */
362 vlib_validate_buffer_enqueue_x2 (vm, node, next_index,
363 to_next, n_left_to_next,
364 bi0, bi1, next0, next1);
366 while (n_left_from > 0 && n_left_to_next > 0)
372 ip6_hop_by_hop_header_t *hbh0;
373 u64 *copy_src0, *copy_dst0;
376 /* speculatively enqueue b0 to the current next frame */
384 b0 = vlib_get_buffer (vm, bi0);
386 ip0 = vlib_buffer_get_current (b0);
388 /* Copy the ip header left by the required amount */
389 copy_dst0 = (u64 *) (((u8 *) ip0) - rewrite_length);
390 copy_src0 = (u64 *) ip0;
392 copy_dst0[0] = copy_src0[0];
393 copy_dst0[1] = copy_src0[1];
394 copy_dst0[2] = copy_src0[2];
395 copy_dst0[3] = copy_src0[3];
396 copy_dst0[4] = copy_src0[4];
397 vlib_buffer_advance (b0, -(word) rewrite_length);
398 ip0 = vlib_buffer_get_current (b0);
400 hbh0 = (ip6_hop_by_hop_header_t *) (ip0 + 1);
401 /* $$$ tune, rewrite_length is a multiple of 8 */
402 clib_memcpy (hbh0, rewrite, rewrite_length);
403 /* Patch the protocol chain, insert the h-b-h (type 0) header */
404 hbh0->protocol = ip0->protocol;
407 clib_net_to_host_u16 (ip0->payload_length) + rewrite_length;
408 ip0->payload_length = clib_host_to_net_u16 (new_l0);
410 /* Populate the (first) h-b-h list elt */
411 next0 = IP6_HBYH_IOAM_INPUT_NEXT_IP6_LOOKUP;
413 if (PREDICT_FALSE ((node->flags & VLIB_NODE_FLAG_TRACE)
414 && (b0->flags & VLIB_BUFFER_IS_TRACED)))
416 ip6_add_hop_by_hop_trace_t *t =
417 vlib_add_trace (vm, node, b0, sizeof (*t));
418 t->next_index = next0;
423 /* verify speculative enqueue, maybe switch current next frame */
424 vlib_validate_buffer_enqueue_x1 (vm, node, next_index,
425 to_next, n_left_to_next,
429 vlib_put_next_frame (vm, node, next_index, n_left_to_next);
432 vlib_node_increment_counter (vm, ip6_add_hop_by_hop_node.index,
433 IP6_ADD_HOP_BY_HOP_ERROR_PROCESSED, processed);
434 return frame->n_vectors;
438 VLIB_REGISTER_NODE (ip6_add_hop_by_hop_node) = /* *INDENT-OFF* */
440 .function = ip6_add_hop_by_hop_node_fn,.name =
441 "ip6-add-hop-by-hop",.vector_size = sizeof (u32),.format_trace =
442 format_ip6_add_hop_by_hop_trace,.type =
443 VLIB_NODE_TYPE_INTERNAL,.n_errors =
444 ARRAY_LEN (ip6_add_hop_by_hop_error_strings),.error_strings =
445 ip6_add_hop_by_hop_error_strings,
446 /* See ip/lookup.h */
447 .n_next_nodes = IP6_HBYH_IOAM_INPUT_N_NEXT,.next_nodes =
449 #define _(s,n) [IP6_HBYH_IOAM_INPUT_NEXT_##s] = n,
450 foreach_ip6_hbyh_ioam_input_next
458 VLIB_NODE_FUNCTION_MULTIARCH (ip6_add_hop_by_hop_node,
459 ip6_add_hop_by_hop_node_fn);
460 /* The main h-b-h tracer was already invoked, no need to do much here */
464 } ip6_pop_hop_by_hop_trace_t;
466 /* packet trace format function */
468 format_ip6_pop_hop_by_hop_trace (u8 * s, va_list * args)
470 CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
471 CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
472 ip6_pop_hop_by_hop_trace_t *t =
473 va_arg (*args, ip6_pop_hop_by_hop_trace_t *);
475 s = format (s, "IP6_POP_HOP_BY_HOP: next index %d", t->next_index);
480 ip6_hbh_pop_register_option (u8 option,
481 int options (vlib_buffer_t * b,
483 ip6_hop_by_hop_option_t * opt))
485 ip6_hop_by_hop_ioam_main_t *hm = &ip6_hop_by_hop_ioam_main;
487 ASSERT (option < ARRAY_LEN (hm->pop_options));
489 /* Already registered */
490 if (hm->pop_options[option])
493 hm->pop_options[option] = options;
499 ip6_hbh_pop_unregister_option (u8 option)
501 ip6_hop_by_hop_ioam_main_t *hm = &ip6_hop_by_hop_ioam_main;
503 ASSERT (option < ARRAY_LEN (hm->pop_options));
506 if (!hm->pop_options[option])
509 hm->pop_options[option] = NULL;
513 vlib_node_registration_t ip6_pop_hop_by_hop_node;
515 #define foreach_ip6_pop_hop_by_hop_error \
516 _(PROCESSED, "Pkts w/ removed ip6 hop-by-hop options") \
517 _(NO_HOHO, "Pkts w/ no ip6 hop-by-hop options") \
518 _(OPTION_FAILED, "ip6 pop hop-by-hop failed to process")
522 #define _(sym,str) IP6_POP_HOP_BY_HOP_ERROR_##sym,
523 foreach_ip6_pop_hop_by_hop_error
525 IP6_POP_HOP_BY_HOP_N_ERROR,
526 } ip6_pop_hop_by_hop_error_t;
528 static char *ip6_pop_hop_by_hop_error_strings[] = {
529 #define _(sym,string) string,
530 foreach_ip6_pop_hop_by_hop_error
535 ioam_pop_hop_by_hop_processing (vlib_main_t * vm,
537 ip6_hop_by_hop_header_t * hbh0,
540 ip6_hop_by_hop_ioam_main_t *hm = &ip6_hop_by_hop_ioam_main;
541 ip6_hop_by_hop_option_t *opt0, *limit0;
547 opt0 = (ip6_hop_by_hop_option_t *) (hbh0 + 1);
548 limit0 = (ip6_hop_by_hop_option_t *)
549 ((u8 *) hbh0 + ((hbh0->length + 1) << 3));
551 /* Scan the set of h-b-h options, process ones that we understand */
552 while (opt0 < limit0)
558 opt0 = (ip6_hop_by_hop_option_t *) ((u8 *) opt0) + 1;
563 if (hm->pop_options[type0])
565 if ((*hm->pop_options[type0]) (b, ip0, opt0) < 0)
567 vlib_node_increment_counter (vm,
568 ip6_pop_hop_by_hop_node.index,
569 IP6_POP_HOP_BY_HOP_ERROR_OPTION_FAILED,
575 (ip6_hop_by_hop_option_t *) (((u8 *) opt0) + opt0->length +
576 sizeof (ip6_hop_by_hop_option_t));
581 ip6_pop_hop_by_hop_node_fn (vlib_main_t * vm,
582 vlib_node_runtime_t * node, vlib_frame_t * frame)
584 ip6_main_t *im = &ip6_main;
585 ip_lookup_main_t *lm = &im->lookup_main;
586 u32 n_left_from, *from, *to_next;
587 ip_lookup_next_t next_index;
591 from = vlib_frame_vector_args (frame);
592 n_left_from = frame->n_vectors;
593 next_index = node->cached_next_index;
595 while (n_left_from > 0)
599 vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
601 while (n_left_from >= 4 && n_left_to_next >= 2)
604 vlib_buffer_t *b0, *b1;
606 u32 adj_index0, adj_index1;
607 ip6_header_t *ip0, *ip1;
608 ip_adjacency_t *adj0, *adj1;
609 ip6_hop_by_hop_header_t *hbh0, *hbh1;
610 u64 *copy_dst0, *copy_src0, *copy_dst1, *copy_src1;
613 /* Prefetch next iteration. */
615 vlib_buffer_t *p2, *p3;
617 p2 = vlib_get_buffer (vm, from[2]);
618 p3 = vlib_get_buffer (vm, from[3]);
620 vlib_prefetch_buffer_header (p2, LOAD);
621 vlib_prefetch_buffer_header (p3, LOAD);
623 CLIB_PREFETCH (p2->data, CLIB_CACHE_LINE_BYTES, STORE);
624 CLIB_PREFETCH (p3->data, CLIB_CACHE_LINE_BYTES, STORE);
627 /* speculatively enqueue b0 and b1 to the current next frame */
628 to_next[0] = bi0 = from[0];
629 to_next[1] = bi1 = from[1];
635 b0 = vlib_get_buffer (vm, bi0);
636 b1 = vlib_get_buffer (vm, bi1);
638 /* $$$$$ Dual loop: process 2 x packets here $$$$$ */
639 ip0 = vlib_buffer_get_current (b0);
640 ip1 = vlib_buffer_get_current (b1);
641 adj_index0 = vnet_buffer (b0)->ip.adj_index[VLIB_TX];
642 adj_index1 = vnet_buffer (b1)->ip.adj_index[VLIB_TX];
643 adj0 = ip_get_adjacency (lm, adj_index0);
644 adj1 = ip_get_adjacency (lm, adj_index1);
646 next0 = adj0->lookup_next_index;
647 next1 = adj1->lookup_next_index;
649 hbh0 = (ip6_hop_by_hop_header_t *) (ip0 + 1);
650 hbh1 = (ip6_hop_by_hop_header_t *) (ip1 + 1);
652 ioam_pop_hop_by_hop_processing (vm, ip0, hbh0, b0);
653 ioam_pop_hop_by_hop_processing (vm, ip1, hbh1, b1);
655 vlib_buffer_advance (b0, (hbh0->length + 1) << 3);
656 vlib_buffer_advance (b1, (hbh1->length + 1) << 3);
658 new_l0 = clib_net_to_host_u16 (ip0->payload_length) -
659 ((hbh0->length + 1) << 3);
660 new_l1 = clib_net_to_host_u16 (ip1->payload_length) -
661 ((hbh1->length + 1) << 3);
663 ip0->payload_length = clib_host_to_net_u16 (new_l0);
664 ip1->payload_length = clib_host_to_net_u16 (new_l1);
666 ip0->protocol = hbh0->protocol;
667 ip1->protocol = hbh1->protocol;
669 copy_src0 = (u64 *) ip0;
670 copy_src1 = (u64 *) ip1;
671 copy_dst0 = copy_src0 + (hbh0->length + 1);
672 copy_dst0[4] = copy_src0[4];
673 copy_dst0[3] = copy_src0[3];
674 copy_dst0[2] = copy_src0[2];
675 copy_dst0[1] = copy_src0[1];
676 copy_dst0[0] = copy_src0[0];
677 copy_dst1 = copy_src1 + (hbh1->length + 1);
678 copy_dst1[4] = copy_src1[4];
679 copy_dst1[3] = copy_src1[3];
680 copy_dst1[2] = copy_src1[2];
681 copy_dst1[1] = copy_src1[1];
682 copy_dst1[0] = copy_src1[0];
684 /* $$$$$ End of processing 2 x packets $$$$$ */
686 if (PREDICT_FALSE ((node->flags & VLIB_NODE_FLAG_TRACE)))
688 if (b0->flags & VLIB_BUFFER_IS_TRACED)
690 ip6_pop_hop_by_hop_trace_t *t =
691 vlib_add_trace (vm, node, b0, sizeof (*t));
692 t->next_index = next0;
694 if (b1->flags & VLIB_BUFFER_IS_TRACED)
696 ip6_pop_hop_by_hop_trace_t *t =
697 vlib_add_trace (vm, node, b1, sizeof (*t));
698 t->next_index = next1;
702 /* verify speculative enqueues, maybe switch current next frame */
703 vlib_validate_buffer_enqueue_x2 (vm, node, next_index,
704 to_next, n_left_to_next,
705 bi0, bi1, next0, next1);
708 while (n_left_from > 0 && n_left_to_next > 0)
715 ip_adjacency_t *adj0;
716 ip6_hop_by_hop_header_t *hbh0;
717 u64 *copy_dst0, *copy_src0;
720 /* speculatively enqueue b0 to the current next frame */
728 b0 = vlib_get_buffer (vm, bi0);
730 ip0 = vlib_buffer_get_current (b0);
731 adj_index0 = vnet_buffer (b0)->ip.adj_index[VLIB_TX];
732 adj0 = ip_get_adjacency (lm, adj_index0);
734 /* Default use the next_index from the adjacency. */
735 next0 = adj0->lookup_next_index;
737 /* Perfectly normal to end up here w/ out h-b-h header */
738 hbh0 = (ip6_hop_by_hop_header_t *) (ip0 + 1);
740 /* TODO:Temporarily doing it here.. do this validation in end_of_path_cb */
741 ioam_pop_hop_by_hop_processing (vm, ip0, hbh0, b0);
742 /* Pop the trace data */
743 vlib_buffer_advance (b0, (hbh0->length + 1) << 3);
744 new_l0 = clib_net_to_host_u16 (ip0->payload_length) -
745 ((hbh0->length + 1) << 3);
746 ip0->payload_length = clib_host_to_net_u16 (new_l0);
747 ip0->protocol = hbh0->protocol;
748 copy_src0 = (u64 *) ip0;
749 copy_dst0 = copy_src0 + (hbh0->length + 1);
750 copy_dst0[4] = copy_src0[4];
751 copy_dst0[3] = copy_src0[3];
752 copy_dst0[2] = copy_src0[2];
753 copy_dst0[1] = copy_src0[1];
754 copy_dst0[0] = copy_src0[0];
757 if (PREDICT_FALSE ((node->flags & VLIB_NODE_FLAG_TRACE)
758 && (b0->flags & VLIB_BUFFER_IS_TRACED)))
760 ip6_pop_hop_by_hop_trace_t *t =
761 vlib_add_trace (vm, node, b0, sizeof (*t));
762 t->next_index = next0;
765 /* verify speculative enqueue, maybe switch current next frame */
766 vlib_validate_buffer_enqueue_x1 (vm, node, next_index,
767 to_next, n_left_to_next,
771 vlib_put_next_frame (vm, node, next_index, n_left_to_next);
774 vlib_node_increment_counter (vm, ip6_pop_hop_by_hop_node.index,
775 IP6_POP_HOP_BY_HOP_ERROR_PROCESSED, processed);
776 vlib_node_increment_counter (vm, ip6_pop_hop_by_hop_node.index,
777 IP6_POP_HOP_BY_HOP_ERROR_NO_HOHO, no_header);
778 return frame->n_vectors;
782 VLIB_REGISTER_NODE (ip6_pop_hop_by_hop_node) =
784 .function = ip6_pop_hop_by_hop_node_fn,.name =
785 "ip6-pop-hop-by-hop",.vector_size = sizeof (u32),.format_trace =
786 format_ip6_pop_hop_by_hop_trace,.type =
787 VLIB_NODE_TYPE_INTERNAL,.sibling_of = "ip6-lookup",.n_errors =
788 ARRAY_LEN (ip6_pop_hop_by_hop_error_strings),.error_strings =
789 ip6_pop_hop_by_hop_error_strings,
790 /* See ip/lookup.h */
795 VLIB_NODE_FUNCTION_MULTIARCH (ip6_pop_hop_by_hop_node,
796 ip6_pop_hop_by_hop_node_fn);
797 static clib_error_t *
798 ip6_hop_by_hop_ioam_init (vlib_main_t * vm)
801 ip6_hop_by_hop_ioam_main_t *hm = &ip6_hop_by_hop_ioam_main;
803 if ((error = vlib_call_init_function (vm, ip_main_init)))
806 if ((error = vlib_call_init_function (vm, ip6_lookup_init)))
810 hm->vnet_main = vnet_get_main ();
811 hm->unix_time_0 = (u32) time (0); /* Store starting time */
812 hm->vlib_time_0 = vlib_time_now (vm);
813 hm->ioam_flag = IOAM_HBYH_MOD;
814 memset (hm->add_options, 0, sizeof (hm->add_options));
815 memset (hm->pop_options, 0, sizeof (hm->pop_options));
816 memset (hm->options_size, 0, sizeof (hm->options_size));
818 vnet_classify_register_unformat_opaque_index_fn (unformat_opaque_ioam);
823 VLIB_INIT_FUNCTION (ip6_hop_by_hop_ioam_init);
826 ip6_ioam_set_rewrite (u8 ** rwp, int has_trace_option,
827 int has_pot_option, int has_seqno_option)
829 ip6_hop_by_hop_ioam_main_t *hm = &ip6_hop_by_hop_ioam_main;
832 ip6_hop_by_hop_header_t *hbh;
834 u8 *trace_data_size = NULL;
835 u8 *pot_data_size = NULL;
839 if (has_trace_option == 0 && has_pot_option == 0)
842 /* Work out how much space we need */
843 size = sizeof (ip6_hop_by_hop_header_t);
845 //if (has_trace_option && hm->get_sizeof_options[HBH_OPTION_TYPE_IOAM_TRACE_DATA_LIST] != 0)
847 && hm->options_size[HBH_OPTION_TYPE_IOAM_TRACE_DATA_LIST] != 0)
849 size += hm->options_size[HBH_OPTION_TYPE_IOAM_TRACE_DATA_LIST];
852 && hm->add_options[HBH_OPTION_TYPE_IOAM_PROOF_OF_TRANSIT] != 0)
854 size += hm->options_size[HBH_OPTION_TYPE_IOAM_PROOF_OF_TRANSIT];
857 if (has_seqno_option)
859 size += hm->options_size[HBH_OPTION_TYPE_IOAM_EDGE_TO_EDGE];
862 /* Round to a multiple of 8 octets */
863 rnd_size = (size + 7) & ~7;
865 /* allocate it, zero-fill / pad by construction */
866 vec_validate (rewrite, rnd_size - 1);
868 hbh = (ip6_hop_by_hop_header_t *) rewrite;
869 /* Length of header in 8 octet units, not incl first 8 octets */
870 hbh->length = (rnd_size >> 3) - 1;
871 current = (u8 *) (hbh + 1);
874 && hm->add_options[HBH_OPTION_TYPE_IOAM_TRACE_DATA_LIST] != 0)
876 if (0 != (hm->options_size[HBH_OPTION_TYPE_IOAM_TRACE_DATA_LIST]))
879 &hm->options_size[HBH_OPTION_TYPE_IOAM_TRACE_DATA_LIST];
881 hm->add_options[HBH_OPTION_TYPE_IOAM_TRACE_DATA_LIST] (current,
883 current += *trace_data_size;
887 && hm->add_options[HBH_OPTION_TYPE_IOAM_PROOF_OF_TRANSIT] != 0)
890 &hm->options_size[HBH_OPTION_TYPE_IOAM_PROOF_OF_TRANSIT];
892 hm->add_options[HBH_OPTION_TYPE_IOAM_PROOF_OF_TRANSIT] (current,
894 current += *pot_data_size;
897 if (has_seqno_option &&
898 (hm->add_options[HBH_OPTION_TYPE_IOAM_EDGE_TO_EDGE] != 0))
900 if (0 == hm->add_options[HBH_OPTION_TYPE_IOAM_EDGE_TO_EDGE] (current,
903 [HBH_OPTION_TYPE_IOAM_EDGE_TO_EDGE])))
904 current += hm->options_size[HBH_OPTION_TYPE_IOAM_EDGE_TO_EDGE];
912 clear_ioam_rewrite_fn (void)
914 ip6_hop_by_hop_ioam_main_t *hm = &ip6_hop_by_hop_ioam_main;
916 vec_free (hm->rewrite);
918 hm->has_trace_option = 0;
919 hm->has_pot_option = 0;
920 hm->has_seqno_option = 0;
921 hm->has_analyse_option = 0;
922 if (hm->config_handler[HBH_OPTION_TYPE_IOAM_TRACE_DATA_LIST])
923 hm->config_handler[HBH_OPTION_TYPE_IOAM_TRACE_DATA_LIST] (NULL, 1);
925 if (hm->config_handler[HBH_OPTION_TYPE_IOAM_PROOF_OF_TRANSIT])
926 hm->config_handler[HBH_OPTION_TYPE_IOAM_PROOF_OF_TRANSIT] (NULL, 1);
928 if (hm->config_handler[HBH_OPTION_TYPE_IOAM_EDGE_TO_EDGE])
930 hm->config_handler[HBH_OPTION_TYPE_IOAM_EDGE_TO_EDGE] ((void *)
931 &hm->has_analyse_option,
939 clear_ioam_rewrite_command_fn (vlib_main_t * vm,
940 unformat_input_t * input,
941 vlib_cli_command_t * cmd)
943 return (clear_ioam_rewrite_fn ());
947 * This command clears all the In-band OAM (iOAM) features enabled by
948 * the '<em>set ioam rewrite</em>' command. Use '<em>show ioam summary</em>' to
949 * verify the configured settings cleared.
952 * Example of how to clear iOAM features:
953 * @cliexcmd{clear ioam rewrite}
956 VLIB_CLI_COMMAND (ip6_clear_ioam_rewrite_cmd, static) = {
957 .path = "clear ioam rewrite",
958 .short_help = "clear ioam rewrite",
959 .function = clear_ioam_rewrite_command_fn,
964 ip6_ioam_enable (int has_trace_option, int has_pot_option,
965 int has_seqno_option, int has_analyse_option)
968 ip6_hop_by_hop_ioam_main_t *hm = &ip6_hop_by_hop_ioam_main;
969 rv = ip6_ioam_set_rewrite (&hm->rewrite, has_trace_option,
970 has_pot_option, has_seqno_option);
975 if (has_trace_option)
977 hm->has_trace_option = has_trace_option;
978 if (hm->config_handler[HBH_OPTION_TYPE_IOAM_TRACE_DATA_LIST])
979 hm->config_handler[HBH_OPTION_TYPE_IOAM_TRACE_DATA_LIST] (NULL,
985 hm->has_pot_option = has_pot_option;
986 if (hm->config_handler[HBH_OPTION_TYPE_IOAM_PROOF_OF_TRANSIT])
987 hm->config_handler[HBH_OPTION_TYPE_IOAM_PROOF_OF_TRANSIT] (NULL,
990 hm->has_analyse_option = has_analyse_option;
991 if (has_seqno_option)
993 hm->has_seqno_option = has_seqno_option;
994 if (hm->config_handler[HBH_OPTION_TYPE_IOAM_EDGE_TO_EDGE])
996 hm->config_handler[HBH_OPTION_TYPE_IOAM_EDGE_TO_EDGE] ((void *)
1004 return clib_error_return_code (0, rv, 0,
1005 "ip6_ioam_set_rewrite returned %d", rv);
1012 static clib_error_t *
1013 ip6_set_ioam_rewrite_command_fn (vlib_main_t * vm,
1014 unformat_input_t * input,
1015 vlib_cli_command_t * cmd)
1017 int has_trace_option = 0;
1018 int has_pot_option = 0;
1019 int has_seqno_option = 0;
1020 int has_analyse_option = 0;
1021 clib_error_t *rv = 0;
1023 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1025 if (unformat (input, "trace"))
1026 has_trace_option = 1;
1027 else if (unformat (input, "pot"))
1029 else if (unformat (input, "seqno"))
1030 has_seqno_option = 1;
1031 else if (unformat (input, "analyse"))
1032 has_analyse_option = 1;
1038 rv = ip6_ioam_enable (has_trace_option, has_pot_option,
1039 has_seqno_option, has_analyse_option);
1045 * This command is used to enable In-band OAM (iOAM) features on IPv6.
1046 * '<em>trace</em>' is used to enable iOAM trace feature. '<em>pot</em>' is used to
1047 * enable the Proof Of Transit feature. '<em>ppc</em>' is used to indicate the
1048 * Per Packet Counter feature for Edge to Edge processing. '<em>ppc</em>' is
1049 * used to indicate if this node is an '<em>encap</em>' node (iOAM edge node
1050 * where packet enters iOAM domain), a '<em>decap</em>' node (iOAM edge node
1051 * where packet leaves iOAM domain) or '<em>none</em>' (iOAM node where packet
1052 * is in-transit through the iOAM domain). '<em>ppc</em>' can only be set if
1053 * '<em>trace</em>' or '<em>pot</em>' is enabled.
1055 * Use '<em>clear ioam rewrite</em>' to disable all features enabled by this
1056 * command. Use '<em>show ioam summary</em>' to verify the configured settings.
1059 * Example of how to enable trace and pot with ppc set to encap:
1060 * @cliexcmd{set ioam rewrite trace pot ppc encap}
1063 VLIB_CLI_COMMAND (ip6_set_ioam_rewrite_cmd, static) = {
1064 .path = "set ioam rewrite",
1065 .short_help = "set ioam [trace] [pot] [seqno] [analyse]",
1066 .function = ip6_set_ioam_rewrite_command_fn,
1070 static clib_error_t *
1071 ip6_show_ioam_summary_cmd_fn (vlib_main_t * vm,
1072 unformat_input_t * input,
1073 vlib_cli_command_t * cmd)
1075 ip6_hop_by_hop_ioam_main_t *hm = &ip6_hop_by_hop_ioam_main;
1079 if (!is_zero_ip6_address (&hm->adj))
1081 s = format (s, " REWRITE FLOW CONFIGS - \n");
1082 s = format (s, " Destination Address : %U\n",
1083 format_ip6_address, &hm->adj, sizeof (ip6_address_t));
1085 format (s, " Flow operation : %d (%s)\n",
1088 IOAM_HBYH_ADD) ? "Add" : ((hm->ioam_flag ==
1089 IOAM_HBYH_MOD) ? "Mod" : "Pop"));
1093 s = format (s, " REWRITE FLOW CONFIGS - Not configured\n");
1097 s = format (s, " TRACE OPTION - %d (%s)\n",
1098 hm->has_trace_option,
1099 (hm->has_trace_option ? "Enabled" : "Disabled"));
1100 if (hm->has_trace_option)
1103 "Try 'show ioam trace and show ioam-trace profile' for more information\n");
1106 s = format (s, " POT OPTION - %d (%s)\n",
1108 (hm->has_pot_option ? "Enabled" : "Disabled"));
1109 if (hm->has_pot_option)
1112 "Try 'show ioam pot and show pot profile' for more information\n");
1114 s = format (s, " EDGE TO EDGE - SeqNo OPTION - %d (%s)\n",
1115 hm->has_seqno_option,
1116 hm->has_seqno_option ? "Enabled" : "Disabled");
1117 if (hm->has_seqno_option)
1118 s = format (s, "Try 'show ioam e2e' for more information\n");
1120 s = format (s, " iOAM Analyse OPTION - %d (%s)\n",
1121 hm->has_analyse_option,
1122 hm->has_analyse_option ? "Enabled" : "Disabled");
1124 vlib_cli_output (vm, "%v", s);
1130 * This command displays the current configuration data for In-band
1134 * Example to show the iOAM configuration:
1135 * @cliexstart{show ioam summary}
1136 * REWRITE FLOW CONFIGS -
1137 * Destination Address : ff02::1
1138 * Flow operation : 2 (Pop)
1139 * TRACE OPTION - 1 (Enabled)
1140 * Try 'show ioam trace and show ioam-trace profile' for more information
1141 * POT OPTION - 1 (Enabled)
1142 * Try 'show ioam pot and show pot profile' for more information
1143 * EDGE TO EDGE - PPC OPTION - 1 (Encap)
1147 VLIB_CLI_COMMAND (ip6_show_ioam_run_cmd, static) = {
1148 .path = "show ioam summary",
1149 .short_help = "show ioam summary",
1150 .function = ip6_show_ioam_summary_cmd_fn,
1155 vnet_register_ioam_end_of_path_callback (void *cb)
1157 ip6_hop_by_hop_ioam_main_t *hm = &ip6_hop_by_hop_ioam_main;
1159 hm->ioam_end_of_path_cb = cb;
1163 * fd.io coding-style-patch-verification: ON
1166 * eval: (c-set-style "gnu")