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.
18 #include <vlib/vlib.h>
19 #include <vnet/fib/ip6_fib.h>
20 #include <vnet/fib/ip4_fib.h>
21 #include <vnet/fib/fib_entry.h>
22 #include <vnet/ip/ip6_link.h>
23 #include <vnet/plugin/plugin.h>
24 #include <vpp/app/version.h>
26 #include <vnet/ip/icmp4.h>
27 #include <ping/ping.h>
29 ping_main_t ping_main;
33 * @brief IPv4 and IPv6 ICMP Ping.
35 * This file contains code to support IPv4 or IPv6 ICMP ECHO_REQUEST to
50 format_icmp_echo_trace (u8 * s, va_list * va)
52 CLIB_UNUSED (vlib_main_t * vm) = va_arg (*va, vlib_main_t *);
53 CLIB_UNUSED (vlib_node_t * node) = va_arg (*va, vlib_node_t *);
54 icmp_echo_trace_t *t = va_arg (*va, icmp_echo_trace_t *);
57 format (s, "ICMP%s echo id %d seq %d", t->is_ip6 ? "6" : "4", t->id,
59 if (t->cli_process_node == PING_CLI_UNKNOWN_NODE)
61 s = format (s, " (unknown)");
65 s = format (s, " send to cli node %d", t->cli_process_node);
73 format_ip46_ping_result (u8 * s, va_list * args)
75 send_ip46_ping_result_t res = va_arg (*args, send_ip46_ping_result_t);
79 #define _(v, n) case SEND_PING_##v: s = format(s, "%s", n);break;
80 foreach_ip46_ping_result
89 * Poor man's get-set-clear functions
90 * for manipulation of icmp_id -> cli_process_id
93 * There should normally be very few (0..1..2) of these
94 * mappings, so the linear search is a good strategy.
96 * Make them thread-safe via a simple spinlock.
101 static_always_inline uword
102 get_cli_process_id_by_icmp_id_mt (vlib_main_t * vm, u16 icmp_id)
104 ping_main_t *pm = &ping_main;
105 uword cli_process_id = PING_CLI_UNKNOWN_NODE;
108 clib_spinlock_lock_if_init (&pm->ping_run_check_lock);
109 vec_foreach (pr, pm->active_ping_runs)
111 if (pr->icmp_id == icmp_id)
113 cli_process_id = pr->cli_process_id;
117 clib_spinlock_unlock_if_init (&pm->ping_run_check_lock);
118 return cli_process_id;
122 static_always_inline void
123 set_cli_process_id_by_icmp_id_mt (vlib_main_t * vm, u16 icmp_id,
124 uword cli_process_id)
126 ping_main_t *pm = &ping_main;
129 clib_spinlock_lock_if_init (&pm->ping_run_check_lock);
130 vec_foreach (pr, pm->active_ping_runs)
132 if (pr->icmp_id == icmp_id)
134 pr->cli_process_id = cli_process_id;
135 goto have_found_and_set;
138 /* no such key yet - add a new one */
139 ping_run_t new_pr = {.icmp_id = icmp_id,.cli_process_id = cli_process_id };
140 vec_add1 (pm->active_ping_runs, new_pr);
142 clib_spinlock_unlock_if_init (&pm->ping_run_check_lock);
146 static_always_inline void
147 clear_cli_process_id_by_icmp_id_mt (vlib_main_t * vm, u16 icmp_id)
149 ping_main_t *pm = &ping_main;
152 clib_spinlock_lock_if_init (&pm->ping_run_check_lock);
153 vec_foreach (pr, pm->active_ping_runs)
155 if (pr->icmp_id == icmp_id)
157 vec_del1 (pm->active_ping_runs, pm->active_ping_runs - pr);
161 clib_spinlock_unlock_if_init (&pm->ping_run_check_lock);
164 static_always_inline int
165 ip46_get_icmp_id_and_seq (vlib_main_t * vm, vlib_buffer_t * b0,
166 u16 * out_icmp_id, u16 * out_icmp_seq, int is_ip6)
171 ip6_header_t *ip6 = vlib_buffer_get_current (b0);
172 if (ip6->protocol != IP_PROTOCOL_ICMP6)
176 l4_offset = sizeof (*ip6); // IPv6 EH
180 ip4_header_t *ip4 = vlib_buffer_get_current (b0);
181 l4_offset = ip4_header_bytes (ip4);
184 icmp46_header_t *icmp46 = vlib_buffer_get_current (b0) + l4_offset;
185 icmp46_echo_request_t *icmp46_echo = (icmp46_echo_request_t *) (icmp46 + 1);
187 *out_icmp_id = clib_net_to_host_u16 (icmp46_echo->id);
188 *out_icmp_seq = clib_net_to_host_u16 (icmp46_echo->seq);
193 * post the buffer to a given cli process node - the caller should forget bi0 after return.
196 static_always_inline void
197 ip46_post_icmp_reply_event (vlib_main_t * vm, uword cli_process_id, u32 bi0,
200 vlib_buffer_t *b0 = vlib_get_buffer (vm, bi0);
201 u64 nowts = clib_cpu_time_now ();
203 /* Pass the timestamp to the cli_process thanks to the vnet_buffer unused metadata field */
205 /* Camping on unused data... just ensure statically that there is enough space */
206 STATIC_ASSERT (ARRAY_LEN (vnet_buffer (b0)->unused) *
207 sizeof (vnet_buffer (b0)->unused[0]) > sizeof (nowts),
208 "ping reply timestamp fits within remaining space of vnet_buffer unused data");
209 u64 *pnowts = (void *) &vnet_buffer (b0)->unused[0];
212 u32 event_id = is_ip6 ? PING_RESPONSE_IP6 : PING_RESPONSE_IP4;
213 vlib_process_signal_event_mt (vm, cli_process_id, event_id, bi0);
217 static_always_inline void
218 ip46_echo_reply_maybe_trace_buffer (vlib_main_t * vm,
219 vlib_node_runtime_t * node,
220 uword cli_process_id, u16 id, u16 seq,
221 vlib_buffer_t * b0, int is_ip6)
223 if (PREDICT_FALSE (b0->flags & VLIB_BUFFER_IS_TRACED))
225 icmp_echo_trace_t *tr = vlib_add_trace (vm, node, b0, sizeof (*tr));
228 tr->cli_process_node = cli_process_id;
234 static_always_inline uword
235 ip46_icmp_echo_reply_inner_node_fn (vlib_main_t * vm,
236 vlib_node_runtime_t * node,
237 vlib_frame_t * frame, int do_trace,
240 u32 n_left_from, *from, *to_next;
241 icmp46_echo_reply_next_t next_index;
243 from = vlib_frame_vector_args (frame);
244 n_left_from = frame->n_vectors;
246 next_index = node->cached_next_index;
248 while (n_left_from > 0)
251 vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
253 while (n_left_from > 0 && n_left_to_next > 0)
258 * The buffers (replies) are either posted to the CLI thread
259 * awaiting for them for subsequent analysis and disposal,
260 * or are sent to the punt node.
262 * So the only "next" node is a punt, normally.
264 u32 next0 = ICMP46_ECHO_REPLY_NEXT_PUNT;
267 b0 = vlib_get_buffer (vm, bi0);
273 uword cli_process_id = PING_CLI_UNKNOWN_NODE;
275 if (ip46_get_icmp_id_and_seq (vm, b0, &icmp_id, &icmp_seq, is_ip6))
277 cli_process_id = get_cli_process_id_by_icmp_id_mt (vm, icmp_id);
281 ip46_echo_reply_maybe_trace_buffer (vm, node, cli_process_id,
282 icmp_id, icmp_seq, b0,
285 if (~0 == cli_process_id)
287 /* no outstanding requests for this reply, punt */
288 /* speculatively enqueue b0 to the current next frame */
292 /* verify speculative enqueue, maybe switch current next frame */
293 vlib_validate_buffer_enqueue_x1 (vm, node, next_index,
294 to_next, n_left_to_next,
299 /* Post the buffer to CLI thread. It will take care of freeing it. */
300 ip46_post_icmp_reply_event (vm, cli_process_id, bi0, is_ip6);
303 vlib_put_next_frame (vm, node, next_index, n_left_to_next);
305 return frame->n_vectors;
309 * select "with-trace" or "without-trace" codepaths upfront.
311 static_always_inline uword
312 ip46_icmp_echo_reply_outer_node_fn (vlib_main_t * vm,
313 vlib_node_runtime_t * node,
314 vlib_frame_t * frame, int is_ip6)
316 if (node->flags & VLIB_NODE_FLAG_TRACE)
317 return ip46_icmp_echo_reply_inner_node_fn (vm, node, frame,
318 1 /* do_trace */ , is_ip6);
320 return ip46_icmp_echo_reply_inner_node_fn (vm, node, frame,
321 0 /* do_trace */ , is_ip6);
325 ip4_icmp_echo_reply_node_fn (vlib_main_t * vm,
326 vlib_node_runtime_t * node, vlib_frame_t * frame)
328 return ip46_icmp_echo_reply_outer_node_fn (vm, node, frame,
333 ip6_icmp_echo_reply_node_fn (vlib_main_t * vm,
334 vlib_node_runtime_t * node, vlib_frame_t * frame)
336 return ip46_icmp_echo_reply_outer_node_fn (vm, node, frame,
341 VLIB_REGISTER_NODE (ip6_icmp_echo_reply_node, static) =
343 .function = ip6_icmp_echo_reply_node_fn,
344 .name = "ip6-icmp-echo-reply",
345 .vector_size = sizeof (u32),
346 .format_trace = format_icmp_echo_trace,
347 .n_next_nodes = ICMP46_ECHO_REPLY_N_NEXT,
349 [ICMP46_ECHO_REPLY_NEXT_DROP] = "ip6-drop",
350 [ICMP46_ECHO_REPLY_NEXT_PUNT] = "ip6-punt",
354 VLIB_REGISTER_NODE (ip4_icmp_echo_reply_node, static) =
356 .function = ip4_icmp_echo_reply_node_fn,
357 .name = "ip4-icmp-echo-reply",
358 .vector_size = sizeof (u32),
359 .format_trace = format_icmp_echo_trace,
360 .n_next_nodes = ICMP46_ECHO_REPLY_N_NEXT,
362 [ICMP46_ECHO_REPLY_NEXT_DROP] = "ip4-drop",
363 [ICMP46_ECHO_REPLY_NEXT_PUNT] = "ip4-punt",
369 ip4_icmp_echo_request (vlib_main_t * vm,
370 vlib_node_runtime_t * node, vlib_frame_t * frame)
372 uword n_packets = frame->n_vectors;
374 u32 n_left_from, n_left_to_next, next;
375 ip4_main_t *i4m = &ip4_main;
376 u16 *fragment_ids, *fid;
377 u8 host_config_ttl = i4m->host_config.ttl;
379 from = vlib_frame_vector_args (frame);
380 n_left_from = n_packets;
381 next = node->cached_next_index;
383 if (node->flags & VLIB_NODE_FLAG_TRACE)
384 vlib_trace_frame_buffers_only (vm, node, from, frame->n_vectors,
386 sizeof (icmp_input_trace_t));
388 /* Get random fragment IDs for replies. */
389 fid = fragment_ids = clib_random_buffer_get_data (&vm->random_buffer,
391 sizeof (fragment_ids[0]));
393 while (n_left_from > 0)
395 vlib_get_next_frame (vm, node, next, to_next, n_left_to_next);
397 while (n_left_from > 2 && n_left_to_next > 2)
399 vlib_buffer_t *p0, *p1;
400 ip4_header_t *ip0, *ip1;
401 icmp46_header_t *icmp0, *icmp1;
404 ip_csum_t sum0, sum1;
406 bi0 = to_next[0] = from[0];
407 bi1 = to_next[1] = from[1];
414 p0 = vlib_get_buffer (vm, bi0);
415 p1 = vlib_get_buffer (vm, bi1);
416 ip0 = vlib_buffer_get_current (p0);
417 ip1 = vlib_buffer_get_current (p1);
418 icmp0 = ip4_next_header (ip0);
419 icmp1 = ip4_next_header (ip1);
421 vnet_buffer (p0)->sw_if_index[VLIB_RX] =
422 vnet_main.local_interface_sw_if_index;
423 vnet_buffer (p1)->sw_if_index[VLIB_RX] =
424 vnet_main.local_interface_sw_if_index;
426 /* Update ICMP checksum. */
427 sum0 = icmp0->checksum;
428 sum1 = icmp1->checksum;
430 ASSERT (icmp0->type == ICMP4_echo_request);
431 ASSERT (icmp1->type == ICMP4_echo_request);
432 sum0 = ip_csum_update (sum0, ICMP4_echo_request, ICMP4_echo_reply,
433 icmp46_header_t, type);
434 sum1 = ip_csum_update (sum1, ICMP4_echo_request, ICMP4_echo_reply,
435 icmp46_header_t, type);
436 icmp0->type = ICMP4_echo_reply;
437 icmp1->type = ICMP4_echo_reply;
439 icmp0->checksum = ip_csum_fold (sum0);
440 icmp1->checksum = ip_csum_fold (sum1);
442 src0 = ip0->src_address.data_u32;
443 src1 = ip1->src_address.data_u32;
444 dst0 = ip0->dst_address.data_u32;
445 dst1 = ip1->dst_address.data_u32;
447 /* Swap source and destination address.
448 Does not change checksum. */
449 ip0->src_address.data_u32 = dst0;
450 ip1->src_address.data_u32 = dst1;
451 ip0->dst_address.data_u32 = src0;
452 ip1->dst_address.data_u32 = src1;
454 /* Update IP checksum. */
455 sum0 = ip0->checksum;
456 sum1 = ip1->checksum;
458 sum0 = ip_csum_update (sum0, ip0->ttl, host_config_ttl,
460 sum1 = ip_csum_update (sum1, ip1->ttl, host_config_ttl,
462 ip0->ttl = host_config_ttl;
463 ip1->ttl = host_config_ttl;
465 /* New fragment id. */
466 sum0 = ip_csum_update (sum0, ip0->fragment_id, fid[0],
467 ip4_header_t, fragment_id);
468 sum1 = ip_csum_update (sum1, ip1->fragment_id, fid[1],
469 ip4_header_t, fragment_id);
470 ip0->fragment_id = fid[0];
471 ip1->fragment_id = fid[1];
474 ip0->checksum = ip_csum_fold (sum0);
475 ip1->checksum = ip_csum_fold (sum1);
477 ASSERT (ip4_header_checksum_is_valid (ip0));
478 ASSERT (ip4_header_checksum_is_valid (ip1));
480 p0->flags |= VNET_BUFFER_F_LOCALLY_ORIGINATED;
481 p1->flags |= VNET_BUFFER_F_LOCALLY_ORIGINATED;
484 while (n_left_from > 0 && n_left_to_next > 0)
488 icmp46_header_t *icmp0;
492 bi0 = to_next[0] = from[0];
499 p0 = vlib_get_buffer (vm, bi0);
500 ip0 = vlib_buffer_get_current (p0);
501 icmp0 = ip4_next_header (ip0);
503 vnet_buffer (p0)->sw_if_index[VLIB_RX] =
504 vnet_main.local_interface_sw_if_index;
506 /* Update ICMP checksum. */
507 sum0 = icmp0->checksum;
509 ASSERT (icmp0->type == ICMP4_echo_request);
510 sum0 = ip_csum_update (sum0, ICMP4_echo_request, ICMP4_echo_reply,
511 icmp46_header_t, type);
512 icmp0->type = ICMP4_echo_reply;
513 icmp0->checksum = ip_csum_fold (sum0);
515 src0 = ip0->src_address.data_u32;
516 dst0 = ip0->dst_address.data_u32;
517 ip0->src_address.data_u32 = dst0;
518 ip0->dst_address.data_u32 = src0;
520 /* Update IP checksum. */
521 sum0 = ip0->checksum;
523 sum0 = ip_csum_update (sum0, ip0->ttl, host_config_ttl,
525 ip0->ttl = host_config_ttl;
527 sum0 = ip_csum_update (sum0, ip0->fragment_id, fid[0],
528 ip4_header_t, fragment_id);
529 ip0->fragment_id = fid[0];
532 ip0->checksum = ip_csum_fold (sum0);
534 ASSERT (ip4_header_checksum_is_valid (ip0));
536 p0->flags |= VNET_BUFFER_F_LOCALLY_ORIGINATED;
539 vlib_put_next_frame (vm, node, next, n_left_to_next);
542 vlib_error_count (vm, ip4_icmp_input_node.index,
543 ICMP4_ERROR_ECHO_REPLIES_SENT, frame->n_vectors);
545 return frame->n_vectors;
549 format_icmp_input_trace (u8 * s, va_list * va)
551 CLIB_UNUSED (vlib_main_t * vm) = va_arg (*va, vlib_main_t *);
552 CLIB_UNUSED (vlib_node_t * node) = va_arg (*va, vlib_node_t *);
553 icmp_input_trace_t *t = va_arg (*va, icmp_input_trace_t *);
556 format_ip4_header, t->packet_data, sizeof (t->packet_data));
562 VLIB_REGISTER_NODE (ip4_icmp_echo_request_node,static) = {
563 .function = ip4_icmp_echo_request,
564 .name = "ip4-icmp-echo-request",
566 .vector_size = sizeof (u32),
568 .format_trace = format_icmp_input_trace,
572 [0] = "ip4-load-balance",
578 * A swarm of address-family agnostic helper functions
579 * for building and sending the ICMP echo request.
581 * Deliberately mostly "static" rather than "static inline"
582 * so one can trace them sanely if needed in debugger, if needed.
586 static_always_inline u8
587 get_icmp_echo_payload_byte (int offset)
589 return (offset % 256);
592 /* Fill in the ICMP ECHO structure, return the safety-checked and possibly shrunk data_len */
594 init_icmp46_echo_request (vlib_main_t * vm, vlib_buffer_t * b0,
595 int l4_header_offset,
596 icmp46_echo_request_t * icmp46_echo, u16 seq_host,
597 u16 id_host, u64 now, u16 data_len)
603 l4_header_offset + sizeof (icmp46_header_t) +
604 offsetof (icmp46_echo_request_t, data);
605 int max_data_len = vlib_buffer_get_default_data_size (vm) - l34_len;
607 int first_buf_data_len = data_len < max_data_len ? data_len : max_data_len;
609 int payload_offset = 0;
610 for (i = 0; i < first_buf_data_len; i++)
611 icmp46_echo->data[i] = get_icmp_echo_payload_byte (payload_offset++);
613 /* inspired by vlib_buffer_add_data */
614 vlib_buffer_t *hb = b0;
615 int remaining_data_len = data_len - first_buf_data_len;
616 while (remaining_data_len)
618 int this_buf_data_len =
620 vlib_buffer_get_default_data_size (vm) ? remaining_data_len :
621 vlib_buffer_get_default_data_size (vm);
622 int n_alloc = vlib_buffer_alloc (vm, &b0->next_buffer, 1);
625 /* That is how much we have so far - return it... */
626 return (data_len - remaining_data_len);
628 b0->flags |= VLIB_BUFFER_NEXT_PRESENT;
629 /* move on to the newly acquired buffer */
630 b0 = vlib_get_buffer (vm, b0->next_buffer);
631 /* initialize the data */
632 for (i = 0; i < this_buf_data_len; i++)
634 b0->data[i] = get_icmp_echo_payload_byte (payload_offset++);
636 b0->current_length = this_buf_data_len;
637 b0->current_data = 0;
638 remaining_data_len -= this_buf_data_len;
640 hb->flags |= VLIB_BUFFER_TOTAL_LENGTH_VALID;
641 hb->current_length = l34_len + first_buf_data_len;
642 hb->total_length_not_including_first_buffer = data_len - first_buf_data_len;
644 icmp46_echo->time_sent = now;
645 icmp46_echo->seq = clib_host_to_net_u16 (seq_host);
646 icmp46_echo->id = clib_host_to_net_u16 (id_host);
652 ip46_fib_index_from_table_id (u32 table_id, int is_ip6)
654 u32 fib_index = is_ip6 ?
655 ip6_fib_index_from_table_id (table_id) :
656 ip4_fib_index_from_table_id (table_id);
660 static fib_node_index_t
661 ip46_fib_table_lookup_host (u32 fib_index, ip46_address_t * pa46, int is_ip6)
663 fib_node_index_t fib_entry_index = is_ip6 ?
664 ip6_fib_table_lookup (fib_index, &pa46->ip6, 128) :
665 ip4_fib_table_lookup (ip4_fib_get (fib_index), &pa46->ip4, 32);
666 return fib_entry_index;
670 ip46_get_resolving_interface (u32 fib_index, ip46_address_t * pa46,
673 u32 sw_if_index = ~0;
676 fib_node_index_t fib_entry_index;
677 fib_entry_index = ip46_fib_table_lookup_host (fib_index, pa46, is_ip6);
678 sw_if_index = fib_entry_get_resolving_interface (fib_entry_index);
684 ip46_fib_table_get_index_for_sw_if_index (u32 sw_if_index, int is_ip6)
686 u32 fib_table_index = is_ip6 ?
687 ip6_fib_table_get_index_for_sw_if_index (sw_if_index) :
688 ip4_fib_table_get_index_for_sw_if_index (sw_if_index);
689 return fib_table_index;
695 ip46_fill_l3_header (ip46_address_t * pa46, vlib_buffer_t * b0, int is_ip6)
699 ip6_header_t *ip6 = vlib_buffer_get_current (b0);
700 /* Fill in ip6 header fields */
701 ip6->ip_version_traffic_class_and_flow_label =
702 clib_host_to_net_u32 (0x6 << 28);
703 ip6->payload_length = 0; /* will be set later */
704 ip6->protocol = IP_PROTOCOL_ICMP6;
705 ip6->hop_limit = 255;
706 ip6->dst_address = pa46->ip6;
707 ip6->src_address = pa46->ip6;
708 return (sizeof (ip6_header_t));
712 ip4_header_t *ip4 = vlib_buffer_get_current (b0);
713 /* Fill in ip4 header fields */
715 ip4->ip_version_and_header_length = 0x45;
717 ip4->length = 0; /* will be set later */
718 ip4->fragment_id = 0;
719 ip4->flags_and_fragment_offset = 0;
721 ip4->protocol = IP_PROTOCOL_ICMP;
722 ip4->src_address = pa46->ip4;
723 ip4->dst_address = pa46->ip4;
724 return (sizeof (ip4_header_t));
729 ip46_set_src_address (u32 sw_if_index, vlib_buffer_t * b0, int is_ip6)
734 ip6_header_t *ip6 = vlib_buffer_get_current (b0);
735 res = ip6_src_address_for_packet (sw_if_index,
736 &ip6->dst_address, &ip6->src_address);
740 ip4_main_t *im = &ip4_main;
741 ip4_header_t *ip4 = vlib_buffer_get_current (b0);
742 res = ip4_src_address_for_packet (&im->lookup_main,
743 sw_if_index, &ip4->src_address);
744 /* IP4 and IP6 paths have the inverse logic. Harmonize. */
751 ip46_print_buffer_src_address (vlib_main_t * vm, vlib_buffer_t * b0,
754 void *format_addr_func;
758 ip6_header_t *ip6 = vlib_buffer_get_current (b0);
759 format_addr_func = format_ip6_address;
760 paddr = &ip6->src_address;
764 ip4_header_t *ip4 = vlib_buffer_get_current (b0);
765 format_addr_func = format_ip4_address;
766 paddr = &ip4->src_address;
768 vlib_cli_output (vm, "Source address: %U ", format_addr_func, paddr);
772 ip46_fill_icmp_request_at (vlib_main_t * vm, int l4_offset, u16 seq_host,
773 u16 id_host, u16 data_len, vlib_buffer_t * b0,
776 icmp46_header_t *icmp46 = vlib_buffer_get_current (b0) + l4_offset;
778 icmp46->type = is_ip6 ? ICMP6_echo_request : ICMP4_echo_request;
780 icmp46->checksum = 0;
782 icmp46_echo_request_t *icmp46_echo = (icmp46_echo_request_t *) (icmp46 + 1);
785 init_icmp46_echo_request (vm, b0, l4_offset, icmp46_echo, seq_host,
786 id_host, clib_cpu_time_now (), data_len);
791 /* Compute ICMP4 checksum with multibuffer support. */
793 ip4_icmp_compute_checksum (vlib_main_t * vm, vlib_buffer_t * p0,
797 u32 ip_header_length, payload_length_host_byte_order;
798 u32 n_this_buffer, n_bytes_left, n_ip_bytes_this_buffer;
800 void *data_this_buffer;
802 ip_header_length = ip4_header_bytes (ip0);
803 payload_length_host_byte_order =
804 clib_net_to_host_u16 (ip0->length) - ip_header_length;
806 /* ICMP4 checksum does not include the IP header */
809 n_bytes_left = n_this_buffer = payload_length_host_byte_order;
810 data_this_buffer = (void *) ip0 + ip_header_length;
811 n_ip_bytes_this_buffer =
812 p0->current_length - (((u8 *) ip0 - p0->data) - p0->current_data);
813 if (n_this_buffer + ip_header_length > n_ip_bytes_this_buffer)
815 n_this_buffer = n_ip_bytes_this_buffer > ip_header_length ?
816 n_ip_bytes_this_buffer - ip_header_length : 0;
820 sum0 = ip_incremental_checksum (sum0, data_this_buffer, n_this_buffer);
821 n_bytes_left -= n_this_buffer;
822 if (n_bytes_left == 0)
825 ASSERT (p0->flags & VLIB_BUFFER_NEXT_PRESENT);
826 p0 = vlib_get_buffer (vm, p0->next_buffer);
827 data_this_buffer = vlib_buffer_get_current (p0);
828 n_this_buffer = p0->current_length;
831 sum16 = ~ip_csum_fold (sum0);
838 ip46_fix_len_and_csum (vlib_main_t * vm, int l4_offset, u16 data_len,
839 vlib_buffer_t * b0, int is_ip6)
842 data_len + sizeof (icmp46_header_t) + offsetof (icmp46_echo_request_t,
844 u16 total_length = payload_length + l4_offset;
845 icmp46_header_t *icmp46 = vlib_buffer_get_current (b0) + l4_offset;
846 icmp46->checksum = 0;
850 ip6_header_t *ip6 = vlib_buffer_get_current (b0);
851 ip6->payload_length = clib_host_to_net_u16 (payload_length);
853 int bogus_length = 0;
855 ip6_tcp_udp_icmp_compute_checksum (vm, b0, ip6, &bogus_length);
859 ip4_header_t *ip4 = vlib_buffer_get_current (b0);
860 ip4->length = clib_host_to_net_u16 (total_length);
862 ip4->checksum = ip4_header_checksum (ip4);
863 icmp46->checksum = ip4_icmp_compute_checksum (vm, b0, ip4);
868 at_most_a_frame (u32 count)
870 return count > VLIB_FRAME_SIZE ? VLIB_FRAME_SIZE : count;
874 ip46_enqueue_packet (vlib_main_t * vm, vlib_buffer_t * b0, u32 burst,
878 u32 lookup_node_index =
879 is_ip6 ? ip6_lookup_node.index : ip4_lookup_node.index;
885 * Enqueue the packet, possibly as one or more frames of copies to make
886 * bursts. We enqueue b0 as the very last buffer, when there is no possibility
887 * for error in vlib_buffer_copy, so as to allow the caller to free it
888 * in case we encounter the error in the middle of the loop.
890 for (n_to_send = at_most_a_frame (burst), burst -= n_to_send; n_to_send > 0;
891 n_to_send = at_most_a_frame (burst), burst -= n_to_send)
893 f = vlib_get_frame_to_node (vm, lookup_node_index);
894 /* f can not be NULL here - frame allocation failure causes panic */
896 u32 *to_next = vlib_frame_vector_args (f);
897 f->n_vectors = n_to_send;
899 while (n_to_send > 1)
901 vlib_buffer_t *b0copy = vlib_buffer_copy (vm, b0);
902 if (PREDICT_FALSE (b0copy == NULL))
904 *to_next++ = vlib_get_buffer_index (vm, b0copy);
909 /* n_to_send is guaranteed to equal 1 here */
912 /* not the last burst, so still make a copy for the last buffer */
913 vlib_buffer_t *b0copy = vlib_buffer_copy (vm, b0);
914 if (PREDICT_FALSE (b0copy == NULL))
917 *to_next++ = vlib_get_buffer_index (vm, b0copy);
921 /* put the original buffer as the last one of an error-free run */
922 *to_next++ = vlib_get_buffer_index (vm, b0);
924 vlib_put_frame_to_node (vm, lookup_node_index, f);
925 n_sent += f->n_vectors;
929 * We reach here in case we already enqueued one or more buffers
930 * and maybe one or more frames but could not make more copies.
931 * There is an outstanding frame - so ship it and return.
932 * Caller will have to free the b0 in this case, since
933 * we did not enqueue it here yet.
936 ASSERT (n_to_send <= f->n_vectors);
937 f->n_vectors -= n_to_send;
938 n_sent += f->n_vectors;
939 vlib_put_frame_to_node (vm, lookup_node_index, f);
945 * An address-family agnostic ping send function.
948 #define ERROR_OUT(e) do { err = e; goto done; } while (0)
950 static send_ip46_ping_result_t
951 send_ip46_ping (vlib_main_t * vm,
953 ip46_address_t * pa46,
955 u16 seq_host, u16 id_host, u16 data_len, u32 burst,
956 u8 verbose, int is_ip6)
958 int err = SEND_PING_OK;
963 n_buf0 = vlib_buffer_alloc (vm, &bi0, 1);
965 ERROR_OUT (SEND_PING_ALLOC_FAIL);
967 b0 = vlib_get_buffer (vm, bi0);
968 VLIB_BUFFER_TRACE_TRAJECTORY_INIT (b0);
971 * if the user did not provide a source interface,
972 * perform a resolution and use an interface
973 * via which it succeeds.
976 if (~0 == sw_if_index)
978 fib_index = ip46_fib_index_from_table_id (table_id, is_ip6);
979 sw_if_index = ip46_get_resolving_interface (fib_index, pa46, is_ip6);
983 ip46_fib_table_get_index_for_sw_if_index (sw_if_index, is_ip6);
986 ERROR_OUT (SEND_PING_NO_TABLE);
987 if (~0 == sw_if_index)
988 ERROR_OUT (SEND_PING_NO_INTERFACE);
990 vnet_buffer (b0)->sw_if_index[VLIB_RX] = sw_if_index;
991 vnet_buffer (b0)->sw_if_index[VLIB_TX] = fib_index;
993 int l4_header_offset = ip46_fill_l3_header (pa46, b0, is_ip6);
995 /* set the src address in the buffer */
996 if (!ip46_set_src_address (sw_if_index, b0, is_ip6))
997 ERROR_OUT (SEND_PING_NO_SRC_ADDRESS);
999 ip46_print_buffer_src_address (vm, b0, is_ip6);
1002 ip46_fill_icmp_request_at (vm, l4_header_offset, seq_host, id_host,
1003 data_len, b0, is_ip6);
1005 ip46_fix_len_and_csum (vm, l4_header_offset, data_len, b0, is_ip6);
1007 int n_sent = ip46_enqueue_packet (vm, b0, burst, is_ip6);
1009 err = SEND_PING_NO_BUFFERS;
1012 if (err != SEND_PING_OK)
1015 vlib_buffer_free (vm, &bi0, 1);
1020 static send_ip46_ping_result_t
1021 send_ip6_ping (vlib_main_t * vm,
1022 u32 table_id, ip6_address_t * pa6,
1023 u32 sw_if_index, u16 seq_host, u16 id_host, u16 data_len,
1024 u32 burst, u8 verbose)
1026 ip46_address_t target;
1028 return send_ip46_ping (vm, table_id, &target, sw_if_index, seq_host,
1029 id_host, data_len, burst, verbose, 1 /* is_ip6 */ );
1032 static send_ip46_ping_result_t
1033 send_ip4_ping (vlib_main_t * vm,
1034 u32 table_id, ip4_address_t * pa4,
1035 u32 sw_if_index, u16 seq_host, u16 id_host, u16 data_len,
1036 u32 burst, u8 verbose)
1038 ip46_address_t target;
1039 ip46_address_set_ip4 (&target, pa4);
1040 return send_ip46_ping (vm, table_id, &target, sw_if_index, seq_host,
1041 id_host, data_len, burst, verbose, 0 /* is_ip6 */ );
1045 print_ip46_icmp_reply (vlib_main_t * vm, u32 bi0, int is_ip6)
1047 vlib_buffer_t *b0 = vlib_get_buffer (vm, bi0);
1050 void *format_addr_func;
1055 ip6_header_t *ip6 = vlib_buffer_get_current (b0);
1056 paddr = (void *) &ip6->src_address;
1057 format_addr_func = (void *) format_ip6_address;
1058 ttl = ip6->hop_limit;
1059 l4_offset = sizeof (ip6_header_t); // FIXME - EH processing ?
1060 payload_length = clib_net_to_host_u16 (ip6->payload_length);
1064 ip4_header_t *ip4 = vlib_buffer_get_current (b0);
1065 paddr = (void *) &ip4->src_address;
1066 format_addr_func = (void *) format_ip4_address;
1068 l4_offset = ip4_header_bytes (ip4);
1070 clib_net_to_host_u16 (ip4->length) + ip4_header_bytes (ip4);
1072 icmp46_header_t *icmp = vlib_buffer_get_current (b0) + l4_offset;
1073 icmp46_echo_request_t *icmp_echo = (icmp46_echo_request_t *) (icmp + 1);
1074 u64 *dataplane_ts = (u64 *) & vnet_buffer (b0)->unused[0];
1076 f64 clocks_per_second = ((f64) vm->clib_time.clocks_per_second);
1078 ((f64) (*dataplane_ts - icmp_echo->time_sent)) / clocks_per_second;
1080 vlib_cli_output (vm,
1081 "%d bytes from %U: icmp_seq=%d ttl=%d time=%.4f ms",
1085 clib_host_to_net_u16 (icmp_echo->seq), ttl, rtt * 1000.0);
1089 * Perform the ping run with the given parameters in the current CLI process.
1090 * Depending on whether pa4 or pa6 is set, runs IPv4 or IPv6 ping.
1091 * The amusing side effect is of course if both are set, then both pings are sent.
1092 * This behavior can be used to ping a dualstack host over IPv4 and IPv6 at once.
1096 run_ping_ip46_address (vlib_main_t * vm, u32 table_id, ip4_address_t * pa4,
1097 ip6_address_t * pa6, u32 sw_if_index,
1098 f64 ping_interval, u32 ping_repeat, u32 data_len,
1099 u32 ping_burst, u32 verbose)
1102 uword curr_proc = vlib_current_process (vm);
1107 static u32 rand_seed = 0;
1109 if (PREDICT_FALSE (!rand_seed))
1110 rand_seed = random_default_seed ();
1112 icmp_id = random_u32 (&rand_seed) & 0xffff;
1114 while (~0 != get_cli_process_id_by_icmp_id_mt (vm, icmp_id))
1116 vlib_cli_output (vm, "ICMP ID collision at %d, incrementing", icmp_id);
1120 set_cli_process_id_by_icmp_id_mt (vm, icmp_id, curr_proc);
1122 for (i = 1; i <= ping_repeat; i++)
1124 send_ip46_ping_result_t res = SEND_PING_OK;
1126 f64 time_ping_sent = vlib_time_now (vm);
1129 res = send_ip6_ping (vm, table_id,
1130 pa6, sw_if_index, i, icmp_id,
1131 data_len, ping_burst, verbose);
1132 if (SEND_PING_OK == res)
1133 n_requests += ping_burst;
1135 vlib_cli_output (vm, "Failed: %U", format_ip46_ping_result, res);
1139 res = send_ip4_ping (vm, table_id, pa4,
1140 sw_if_index, i, icmp_id, data_len,
1141 ping_burst, verbose);
1142 if (SEND_PING_OK == res)
1143 n_requests += ping_burst;
1145 vlib_cli_output (vm, "Failed: %U", format_ip46_ping_result, res);
1148 /* Collect and print the responses until it is time to send a next ping */
1150 while ((i <= ping_repeat)
1153 time_ping_sent + ping_interval - vlib_time_now (vm)) > 0.0))
1155 uword event_type, *event_data = 0;
1156 vlib_process_wait_for_event_or_clock (vm, sleep_interval);
1157 event_type = vlib_process_get_events (vm, &event_data);
1160 case ~0: /* no events => timeout */
1162 case PING_RESPONSE_IP6:
1164 case PING_RESPONSE_IP4:
1167 int is_ip6 = (event_type == PING_RESPONSE_IP6);
1168 for (ii = 0; ii < vec_len (event_data); ii++)
1170 u32 bi0 = event_data[ii];
1171 print_ip46_icmp_reply (vm, bi0, is_ip6);
1174 vlib_buffer_free (vm, &bi0, 1);
1179 /* someone pressed a key, abort */
1180 vlib_cli_output (vm, "Aborted due to a keypress.");
1184 vec_free (event_data);
1188 vlib_cli_output (vm, "\n");
1192 n_requests) ? 0 : 100.0 * ((float) n_requests -
1193 (float) n_replies) / (float) n_requests;
1194 vlib_cli_output (vm,
1195 "Statistics: %u sent, %u received, %f%% packet loss\n",
1196 n_requests, n_replies, loss);
1197 clear_cli_process_id_by_icmp_id_mt (vm, icmp_id);
1203 static clib_error_t *
1204 ping_ip_address (vlib_main_t * vm,
1205 unformat_input_t * input, vlib_cli_command_t * cmd)
1209 clib_error_t *error = 0;
1210 u32 ping_repeat = 5;
1212 u8 ping_ip4, ping_ip6;
1213 vnet_main_t *vnm = vnet_get_main ();
1214 u32 data_len = PING_DEFAULT_DATA_LEN;
1216 f64 ping_interval = PING_DEFAULT_INTERVAL;
1217 u32 sw_if_index, table_id;
1220 ping_ip4 = ping_ip6 = 0;
1223 if (unformat (input, "%U", unformat_ip4_address, &a4))
1227 else if (unformat (input, "%U", unformat_ip6_address, &a6))
1231 else if (unformat (input, "ipv4"))
1233 if (unformat (input, "%U", unformat_ip4_address, &a4))
1240 clib_error_return (0,
1241 "expecting IPv4 address but got `%U'",
1242 format_unformat_error, input);
1245 else if (unformat (input, "ipv6"))
1247 if (unformat (input, "%U", unformat_ip6_address, &a6))
1254 clib_error_return (0,
1255 "expecting IPv6 address but got `%U'",
1256 format_unformat_error, input);
1262 clib_error_return (0,
1263 "expecting IP4/IP6 address `%U'. Usage: ping <addr> [source <intf>] [size <datasz>] [repeat <count>] [verbose]",
1264 format_unformat_error, input);
1268 /* allow for the second AF in the same ping */
1269 if (!ping_ip4 && (unformat (input, "ipv4")))
1271 if (unformat (input, "%U", unformat_ip4_address, &a4))
1276 else if (!ping_ip6 && (unformat (input, "ipv6")))
1278 if (unformat (input, "%U", unformat_ip6_address, &a6))
1284 /* parse the rest of the parameters in a cycle */
1285 while (!unformat_eof (input, NULL))
1287 if (unformat (input, "source"))
1290 (input, unformat_vnet_sw_interface, vnm, &sw_if_index))
1293 clib_error_return (0,
1294 "unknown interface `%U'",
1295 format_unformat_error, input);
1299 else if (unformat (input, "size"))
1301 if (!unformat (input, "%u", &data_len))
1304 clib_error_return (0,
1305 "expecting size but got `%U'",
1306 format_unformat_error, input);
1309 if (data_len > PING_MAXIMUM_DATA_SIZE)
1312 clib_error_return (0,
1313 "%d is bigger than maximum allowed payload size %d",
1314 data_len, PING_MAXIMUM_DATA_SIZE);
1318 else if (unformat (input, "table-id"))
1320 if (!unformat (input, "%u", &table_id))
1323 clib_error_return (0,
1324 "expecting table-id but got `%U'",
1325 format_unformat_error, input);
1329 else if (unformat (input, "interval"))
1331 if (!unformat (input, "%f", &ping_interval))
1334 clib_error_return (0,
1335 "expecting interval (floating point number) got `%U'",
1336 format_unformat_error, input);
1340 else if (unformat (input, "repeat"))
1342 if (!unformat (input, "%u", &ping_repeat))
1345 clib_error_return (0,
1346 "expecting repeat count but got `%U'",
1347 format_unformat_error, input);
1351 else if (unformat (input, "burst"))
1353 if (!unformat (input, "%u", &ping_burst))
1356 clib_error_return (0,
1357 "expecting burst count but got `%U'",
1358 format_unformat_error, input);
1362 else if (unformat (input, "verbose"))
1368 error = clib_error_return (0, "unknown input `%U'",
1369 format_unformat_error, input);
1375 * Operationally, one won't (and shouldn't) need to send more than a frame worth of pings.
1376 * But it may be handy during the debugging.
1380 #define MAX_PING_BURST (10*VLIB_FRAME_SIZE)
1382 #define MAX_PING_BURST (VLIB_FRAME_SIZE)
1385 if (ping_burst < 1 || ping_burst > MAX_PING_BURST)
1386 return clib_error_return (0, "burst size must be between 1 and %u",
1389 run_ping_ip46_address (vm, table_id, ping_ip4 ? &a4 : NULL,
1390 ping_ip6 ? &a6 : NULL, sw_if_index, ping_interval,
1391 ping_repeat, data_len, ping_burst, verbose);
1397 * This command sends an ICMP ECHO_REQUEST to network hosts. The address
1398 * can be an IPv4 or IPv6 address (or both at the same time).
1402 * Example of how ping an IPv4 address:
1403 * @cliexstart{ping 172.16.1.2 source GigabitEthernet2/0/0 repeat 2}
1404 * 64 bytes from 172.16.1.2: icmp_seq=1 ttl=64 time=.1090 ms
1405 * 64 bytes from 172.16.1.2: icmp_seq=2 ttl=64 time=.0914 ms
1407 * Statistics: 2 sent, 2 received, 0% packet loss
1410 * Example of how ping both an IPv4 address and IPv6 address at the same time:
1411 * @cliexstart{ping 172.16.1.2 ipv6 fe80::24a5:f6ff:fe9c:3a36 source GigabitEthernet2/0/0 repeat 2 verbose}
1412 * Adjacency index: 10, sw_if_index: 1
1413 * Adj: ip6-discover-neighbor
1415 * Forced set interface: 1
1416 * Adjacency index: 0, sw_if_index: 4294967295
1419 * Forced set interface: 1
1420 * Source address: 172.16.1.1
1421 * 64 bytes from 172.16.1.2: icmp_seq=1 ttl=64 time=.1899 ms
1422 * Adjacency index: 10, sw_if_index: 1
1423 * Adj: ip6-discover-neighbor
1425 * Forced set interface: 1
1426 * Adjacency index: 0, sw_if_index: 4294967295
1429 * Forced set interface: 1
1430 * Source address: 172.16.1.1
1431 * 64 bytes from 172.16.1.2: icmp_seq=2 ttl=64 time=.0910 ms
1433 * Statistics: 4 sent, 2 received, 50% packet loss
1438 VLIB_CLI_COMMAND (ping_command, static) =
1441 .function = ping_ip_address,
1442 .short_help = "ping {<ip-addr> | ipv4 <ip4-addr> | ipv6 <ip6-addr>}"
1443 " [ipv4 <ip4-addr> | ipv6 <ip6-addr>] [source <interface>]"
1444 " [size <pktsize:60>] [interval <sec:1>] [repeat <cnt:5>] [table-id <id:0>]"
1445 " [burst <count:1>] [verbose]",
1450 static clib_error_t *
1451 ping_cli_init (vlib_main_t * vm)
1453 vlib_thread_main_t *tm = vlib_get_thread_main ();
1454 ping_main_t *pm = &ping_main;
1456 pm->ip6_main = &ip6_main;
1457 pm->ip4_main = &ip4_main;
1458 icmp6_register_type (vm, ICMP6_echo_reply, ip6_icmp_echo_reply_node.index);
1459 ip4_icmp_register_type (vm, ICMP4_echo_reply,
1460 ip4_icmp_echo_reply_node.index);
1461 if (tm->n_vlib_mains > 1)
1462 clib_spinlock_init (&pm->ping_run_check_lock);
1464 ip4_icmp_register_type (vm, ICMP4_echo_request,
1465 ip4_icmp_echo_request_node.index);
1470 VLIB_INIT_FUNCTION (ping_cli_init);
1473 VLIB_PLUGIN_REGISTER () = {
1474 .version = VPP_BUILD_VER,
1475 .description = "Ping (ping)",
1480 * fd.io coding-style-patch-verification: ON
1483 * eval: (c-set-style "gnu")