ping.c revision cbe25aab
1/*
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:
6 *
7 *     http://www.apache.org/licenses/LICENSE-2.0
8 *
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.
14 */
15
16#include <stddef.h>
17
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>
25
26#include <vnet/ip/icmp4.h>
27#include <ping/ping.h>
28
29ping_main_t ping_main;
30
31/**
32 * @file
33 * @brief IPv4 and IPv6 ICMP Ping.
34 *
35 * This file contains code to support IPv4 or IPv6 ICMP ECHO_REQUEST to
36 * network hosts.
37 *
38 */
39
40typedef struct
41{
42  u16 id;
43  u16 seq;
44  u32 cli_process_node;
45  u8 is_ip6;
46} icmp_echo_trace_t;
47
48
49u8 *
50format_icmp_echo_trace (u8 * s, va_list * va)
51{
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 *);
55
56  s =
57    format (s, "ICMP%s echo id %d seq %d", t->is_ip6 ? "6" : "4", t->id,
58	    t->seq);
59  if (t->cli_process_node == PING_CLI_UNKNOWN_NODE)
60    {
61      s = format (s, " (unknown)");
62    }
63  else
64    {
65      s = format (s, " send to cli node %d", t->cli_process_node);
66    }
67
68  return s;
69}
70
71
72static u8 *
73format_ip46_ping_result (u8 * s, va_list * args)
74{
75  send_ip46_ping_result_t res = va_arg (*args, send_ip46_ping_result_t);
76
77  switch (res)
78    {
79#define _(v, n) case SEND_PING_##v: s = format(s, "%s", n);break;
80      foreach_ip46_ping_result
81#undef _
82    }
83
84  return (s);
85}
86
87
88/*
89 * Poor man's get-set-clear functions
90 * for manipulation of icmp_id -> cli_process_id
91 * mappings.
92 *
93 * There should normally be very few (0..1..2) of these
94 * mappings, so the linear search is a good strategy.
95 *
96 * Make them thread-safe via a simple spinlock.
97 *
98 */
99
100
101static_always_inline uword
102get_cli_process_id_by_icmp_id_mt (vlib_main_t * vm, u16 icmp_id)
103{
104  ping_main_t *pm = &ping_main;
105  uword cli_process_id = PING_CLI_UNKNOWN_NODE;
106  ping_run_t *pr;
107
108  clib_spinlock_lock_if_init (&pm->ping_run_check_lock);
109  vec_foreach (pr, pm->active_ping_runs)
110  {
111    if (pr->icmp_id == icmp_id)
112      {
113	cli_process_id = pr->cli_process_id;
114	break;
115      }
116  }
117  clib_spinlock_unlock_if_init (&pm->ping_run_check_lock);
118  return cli_process_id;
119}
120
121
122static_always_inline void
123set_cli_process_id_by_icmp_id_mt (vlib_main_t * vm, u16 icmp_id,
124				  uword cli_process_id)
125{
126  ping_main_t *pm = &ping_main;
127  ping_run_t *pr;
128
129  clib_spinlock_lock_if_init (&pm->ping_run_check_lock);
130  vec_foreach (pr, pm->active_ping_runs)
131  {
132    if (pr->icmp_id == icmp_id)
133      {
134	pr->cli_process_id = cli_process_id;
135	goto have_found_and_set;
136      }
137  }
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);
141have_found_and_set:
142  clib_spinlock_unlock_if_init (&pm->ping_run_check_lock);
143}
144
145
146static_always_inline void
147clear_cli_process_id_by_icmp_id_mt (vlib_main_t * vm, u16 icmp_id)
148{
149  ping_main_t *pm = &ping_main;
150  ping_run_t *pr;
151
152  clib_spinlock_lock_if_init (&pm->ping_run_check_lock);
153  vec_foreach (pr, pm->active_ping_runs)
154  {
155    if (pr->icmp_id == icmp_id)
156      {
157	vec_del1 (pm->active_ping_runs, pm->active_ping_runs - pr);
158	break;
159      }
160  }
161  clib_spinlock_unlock_if_init (&pm->ping_run_check_lock);
162}
163
164static_always_inline int
165ip46_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)
167{
168  int l4_offset;
169  if (is_ip6)
170    {
171      ip6_header_t *ip6 = vlib_buffer_get_current (b0);
172      if (ip6->protocol != IP_PROTOCOL_ICMP6)
173	{
174	  return 0;
175	}
176      l4_offset = sizeof (*ip6);	// IPv6 EH
177    }
178  else
179    {
180      ip4_header_t *ip4 = vlib_buffer_get_current (b0);
181      l4_offset = ip4_header_bytes (ip4);
182
183    }
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);
186
187  *out_icmp_id = clib_net_to_host_u16 (icmp46_echo->id);
188  *out_icmp_seq = clib_net_to_host_u16 (icmp46_echo->seq);
189  return 1;
190}
191
192/*
193 * post the buffer to a given cli process node - the caller should forget bi0 after return.
194 */
195
196static_always_inline void
197ip46_post_icmp_reply_event (vlib_main_t * vm, uword cli_process_id, u32 bi0,
198			    int is_ip6)
199{
200  vlib_buffer_t *b0 = vlib_get_buffer (vm, bi0);
201  u64 nowts = clib_cpu_time_now ();
202
203  /* Pass the timestamp to the cli_process thanks to the vnet_buffer unused metadata field */
204
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];
210  *pnowts = nowts;
211
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);
214}
215
216
217static_always_inline void
218ip46_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)
222{
223  if (PREDICT_FALSE (b0->flags & VLIB_BUFFER_IS_TRACED))
224    {
225      icmp_echo_trace_t *tr = vlib_add_trace (vm, node, b0, sizeof (*tr));
226      tr->id = id;
227      tr->seq = seq;
228      tr->cli_process_node = cli_process_id;
229      tr->is_ip6 = is_ip6;
230    }
231}
232
233
234static_always_inline uword
235ip46_icmp_echo_reply_inner_node_fn (vlib_main_t * vm,
236				    vlib_node_runtime_t * node,
237				    vlib_frame_t * frame, int do_trace,
238				    int is_ip6)
239{
240  u32 n_left_from, *from, *to_next;
241  icmp46_echo_reply_next_t next_index;
242
243  from = vlib_frame_vector_args (frame);
244  n_left_from = frame->n_vectors;
245
246  next_index = node->cached_next_index;
247
248  while (n_left_from > 0)
249    {
250      u32 n_left_to_next;
251      vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
252
253      while (n_left_from > 0 && n_left_to_next > 0)
254	{
255	  u32 bi0;
256	  vlib_buffer_t *b0;
257	  /*
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.
261	   *
262	   * So the only "next" node is a punt, normally.
263	   */
264	  u32 next0 = ICMP46_ECHO_REPLY_NEXT_PUNT;
265
266	  bi0 = from[0];
267	  b0 = vlib_get_buffer (vm, bi0);
268	  from += 1;
269	  n_left_from -= 1;
270
271	  u16 icmp_id = ~0;
272	  u16 icmp_seq = ~0;
273	  uword cli_process_id = PING_CLI_UNKNOWN_NODE;
274
275	  if (ip46_get_icmp_id_and_seq (vm, b0, &icmp_id, &icmp_seq, is_ip6))
276	    {
277	      cli_process_id = get_cli_process_id_by_icmp_id_mt (vm, icmp_id);
278	    }
279
280	  if (do_trace)
281	    ip46_echo_reply_maybe_trace_buffer (vm, node, cli_process_id,
282						icmp_id, icmp_seq, b0,
283						is_ip6);
284
285	  if (~0 == cli_process_id)
286	    {
287	      /* no outstanding requests for this reply, punt */
288	      /* speculatively enqueue b0 to the current next frame */
289	      to_next[0] = bi0;
290	      to_next += 1;
291	      n_left_to_next -= 1;
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,
295					       bi0, next0);
296	    }
297	  else
298	    {
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);
301	    }
302	}
303      vlib_put_next_frame (vm, node, next_index, n_left_to_next);
304    }
305  return frame->n_vectors;
306}
307
308/*
309 * select "with-trace" or "without-trace" codepaths upfront.
310 */
311static_always_inline uword
312ip46_icmp_echo_reply_outer_node_fn (vlib_main_t * vm,
313				    vlib_node_runtime_t * node,
314				    vlib_frame_t * frame, int is_ip6)
315{
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);
319  else
320    return ip46_icmp_echo_reply_inner_node_fn (vm, node, frame,
321					       0 /* do_trace */ , is_ip6);
322}
323
324static uword
325ip4_icmp_echo_reply_node_fn (vlib_main_t * vm,
326			     vlib_node_runtime_t * node, vlib_frame_t * frame)
327{
328  return ip46_icmp_echo_reply_outer_node_fn (vm, node, frame,
329					     0 /* is_ip6 */ );
330}
331
332static uword
333ip6_icmp_echo_reply_node_fn (vlib_main_t * vm,
334			     vlib_node_runtime_t * node, vlib_frame_t * frame)
335{
336  return ip46_icmp_echo_reply_outer_node_fn (vm, node, frame,
337					     1 /* is_ip6 */ );
338}
339
340/* *INDENT-OFF* */
341VLIB_REGISTER_NODE (ip6_icmp_echo_reply_node, static) =
342{
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,
348  .next_nodes = {
349    [ICMP46_ECHO_REPLY_NEXT_DROP] = "ip6-drop",
350    [ICMP46_ECHO_REPLY_NEXT_PUNT] = "ip6-punt",
351  },
352};
353
354VLIB_REGISTER_NODE (ip4_icmp_echo_reply_node, static) =
355{
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,
361  .next_nodes = {
362    [ICMP46_ECHO_REPLY_NEXT_DROP] = "ip4-drop",
363    [ICMP46_ECHO_REPLY_NEXT_PUNT] = "ip4-punt",
364  },
365};
366/* *INDENT-ON* */
367
368static uword
369ip4_icmp_echo_request (vlib_main_t * vm,
370		       vlib_node_runtime_t * node, vlib_frame_t * frame)
371{
372  uword n_packets = frame->n_vectors;
373  u32 *from, *to_next;
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;
378
379  from = vlib_frame_vector_args (frame);
380  n_left_from = n_packets;
381  next = node->cached_next_index;
382
383  if (node->flags & VLIB_NODE_FLAG_TRACE)
384    vlib_trace_frame_buffers_only (vm, node, from, frame->n_vectors,
385				   /* stride */ 1,
386				   sizeof (icmp_input_trace_t));
387
388  /* Get random fragment IDs for replies. */
389  fid = fragment_ids = clib_random_buffer_get_data (&vm->random_buffer,
390						    n_packets *
391						    sizeof (fragment_ids[0]));
392
393  while (n_left_from > 0)
394    {
395      vlib_get_next_frame (vm, node, next, to_next, n_left_to_next);
396
397      while (n_left_from > 2 && n_left_to_next > 2)
398	{
399	  vlib_buffer_t *p0, *p1;
400	  ip4_header_t *ip0, *ip1;
401	  icmp46_header_t *icmp0, *icmp1;
402	  u32 bi0, src0, dst0;
403	  u32 bi1, src1, dst1;
404	  ip_csum_t sum0, sum1;
405
406	  bi0 = to_next[0] = from[0];
407	  bi1 = to_next[1] = from[1];
408
409	  from += 2;
410	  n_left_from -= 2;
411	  to_next += 2;
412	  n_left_to_next -= 2;
413
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);
420
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;
425
426	  /* Update ICMP checksum. */
427	  sum0 = icmp0->checksum;
428	  sum1 = icmp1->checksum;
429
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;
438
439	  icmp0->checksum = ip_csum_fold (sum0);
440	  icmp1->checksum = ip_csum_fold (sum1);
441
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;
446
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;
453
454	  /* Update IP checksum. */
455	  sum0 = ip0->checksum;
456	  sum1 = ip1->checksum;
457
458	  sum0 = ip_csum_update (sum0, ip0->ttl, host_config_ttl,
459				 ip4_header_t, ttl);
460	  sum1 = ip_csum_update (sum1, ip1->ttl, host_config_ttl,
461				 ip4_header_t, ttl);
462	  ip0->ttl = host_config_ttl;
463	  ip1->ttl = host_config_ttl;
464
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];
472	  fid += 2;
473
474	  ip0->checksum = ip_csum_fold (sum0);
475	  ip1->checksum = ip_csum_fold (sum1);
476
477	  ASSERT (ip0->checksum == ip4_header_checksum (ip0));
478	  ASSERT (ip1->checksum == ip4_header_checksum (ip1));
479
480	  p0->flags |= VNET_BUFFER_F_LOCALLY_ORIGINATED;
481	  p1->flags |= VNET_BUFFER_F_LOCALLY_ORIGINATED;
482	}
483
484      while (n_left_from > 0 && n_left_to_next > 0)
485	{
486	  vlib_buffer_t *p0;
487	  ip4_header_t *ip0;
488	  icmp46_header_t *icmp0;
489	  u32 bi0, src0, dst0;
490	  ip_csum_t sum0;
491
492	  bi0 = to_next[0] = from[0];
493
494	  from += 1;
495	  n_left_from -= 1;
496	  to_next += 1;
497	  n_left_to_next -= 1;
498
499	  p0 = vlib_get_buffer (vm, bi0);
500	  ip0 = vlib_buffer_get_current (p0);
501	  icmp0 = ip4_next_header (ip0);
502
503	  vnet_buffer (p0)->sw_if_index[VLIB_RX] =
504	    vnet_main.local_interface_sw_if_index;
505
506	  /* Update ICMP checksum. */
507	  sum0 = icmp0->checksum;
508
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);
514
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;
519
520	  /* Update IP checksum. */
521	  sum0 = ip0->checksum;
522
523	  sum0 = ip_csum_update (sum0, ip0->ttl, host_config_ttl,
524				 ip4_header_t, ttl);
525	  ip0->ttl = host_config_ttl;
526
527	  sum0 = ip_csum_update (sum0, ip0->fragment_id, fid[0],
528				 ip4_header_t, fragment_id);
529	  ip0->fragment_id = fid[0];
530	  fid += 1;
531
532	  ip0->checksum = ip_csum_fold (sum0);
533
534	  ASSERT (ip0->checksum == ip4_header_checksum (ip0));
535
536	  p0->flags |= VNET_BUFFER_F_LOCALLY_ORIGINATED;
537	}
538
539      vlib_put_next_frame (vm, node, next, n_left_to_next);
540    }
541
542  vlib_error_count (vm, ip4_icmp_input_node.index,
543		    ICMP4_ERROR_ECHO_REPLIES_SENT, frame->n_vectors);
544
545  return frame->n_vectors;
546}
547
548static u8 *
549format_icmp_input_trace (u8 * s, va_list * va)
550{
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 *);
554
555  s = format (s, "%U",
556	      format_ip4_header, t->packet_data, sizeof (t->packet_data));
557
558  return s;
559}
560
561/* *INDENT-OFF* */
562VLIB_REGISTER_NODE (ip4_icmp_echo_request_node,static) = {
563  .function = ip4_icmp_echo_request,
564  .name = "ip4-icmp-echo-request",
565
566  .vector_size = sizeof (u32),
567
568  .format_trace = format_icmp_input_trace,
569
570  .n_next_nodes = 1,
571  .next_nodes = {
572    [0] = "ip4-load-balance",
573  },
574};
575/* *INDENT-ON* */
576
577/*
578 * A swarm of address-family agnostic helper functions
579 * for building and sending the ICMP echo request.
580 *
581 * Deliberately mostly "static" rather than "static inline"
582 * so one can trace them sanely if needed in debugger, if needed.
583 *
584 */
585
586static_always_inline u8
587get_icmp_echo_payload_byte (int offset)
588{
589  return (offset % 256);
590}
591
592/* Fill in the ICMP ECHO structure, return the safety-checked and possibly shrunk data_len */
593static u16
594init_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)
598{
599  int i;
600
601
602  int l34_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;
606
607  int first_buf_data_len = data_len < max_data_len ? data_len : max_data_len;
608
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++);
612
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)
617    {
618      int this_buf_data_len =
619	remaining_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);
623      if (n_alloc < 1)
624	{
625	  /* That is how much we have so far - return it... */
626	  return (data_len - remaining_data_len);
627	}
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++)
633	{
634	  b0->data[i] = get_icmp_echo_payload_byte (payload_offset++);
635	}
636      b0->current_length = this_buf_data_len;
637      b0->current_data = 0;
638      remaining_data_len -= this_buf_data_len;
639    }
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;
643
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);
647  return data_len;
648}
649
650
651static u32
652ip46_fib_index_from_table_id (u32 table_id, int is_ip6)
653{
654  u32 fib_index = is_ip6 ?
655    ip6_fib_index_from_table_id (table_id) :
656    ip4_fib_index_from_table_id (table_id);
657  return fib_index;
658}
659
660static fib_node_index_t
661ip46_fib_table_lookup_host (u32 fib_index, ip46_address_t * pa46, int is_ip6)
662{
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;
667}
668
669static u32
670ip46_get_resolving_interface (u32 fib_index, ip46_address_t * pa46,
671			      int is_ip6)
672{
673  u32 sw_if_index = ~0;
674  if (~0 != fib_index)
675    {
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);
679    }
680  return sw_if_index;
681}
682
683static u32
684ip46_fib_table_get_index_for_sw_if_index (u32 sw_if_index, int is_ip6)
685{
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;
690
691}
692
693
694static int
695ip46_fill_l3_header (ip46_address_t * pa46, vlib_buffer_t * b0, int is_ip6)
696{
697  if (is_ip6)
698    {
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));
709    }
710  else
711    {
712      ip4_header_t *ip4 = vlib_buffer_get_current (b0);
713      /* Fill in ip4 header fields */
714      ip4->checksum = 0;
715      ip4->ip_version_and_header_length = 0x45;
716      ip4->tos = 0;
717      ip4->length = 0;		/* will be set later */
718      ip4->fragment_id = 0;
719      ip4->flags_and_fragment_offset = 0;
720      ip4->ttl = 0xff;
721      ip4->protocol = IP_PROTOCOL_ICMP;
722      ip4->src_address = pa46->ip4;
723      ip4->dst_address = pa46->ip4;
724      return (sizeof (ip4_header_t));
725    }
726}
727
728static int
729ip46_set_src_address (u32 sw_if_index, vlib_buffer_t * b0, int is_ip6)
730{
731  int res;
732  if (is_ip6)
733    {
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);
737    }
738  else
739    {
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. */
745      res = !res;
746    }
747  return res;
748}
749
750static void
751ip46_print_buffer_src_address (vlib_main_t * vm, vlib_buffer_t * b0,
752			       int is_ip6)
753{
754  void *format_addr_func;
755  void *paddr;
756  if (is_ip6)
757    {
758      ip6_header_t *ip6 = vlib_buffer_get_current (b0);
759      format_addr_func = format_ip6_address;
760      paddr = &ip6->src_address;
761    }
762  else
763    {
764      ip4_header_t *ip4 = vlib_buffer_get_current (b0);
765      format_addr_func = format_ip4_address;
766      paddr = &ip4->src_address;
767    }
768  vlib_cli_output (vm, "Source address: %U ", format_addr_func, paddr);
769}
770
771static u16
772ip46_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,
774			   int is_ip6)
775{
776  icmp46_header_t *icmp46 = vlib_buffer_get_current (b0) + l4_offset;
777
778  icmp46->type = is_ip6 ? ICMP6_echo_request : ICMP4_echo_request;
779  icmp46->code = 0;
780  icmp46->checksum = 0;
781
782  icmp46_echo_request_t *icmp46_echo = (icmp46_echo_request_t *) (icmp46 + 1);
783
784  data_len =
785    init_icmp46_echo_request (vm, b0, l4_offset, icmp46_echo, seq_host,
786			      id_host, clib_cpu_time_now (), data_len);
787  return data_len;
788}
789
790
791/* Compute ICMP4 checksum with multibuffer support. */
792u16
793ip4_icmp_compute_checksum (vlib_main_t * vm, vlib_buffer_t * p0,
794			   ip4_header_t * ip0)
795{
796  ip_csum_t sum0;
797  u32 ip_header_length, payload_length_host_byte_order;
798  u32 n_this_buffer, n_bytes_left, n_ip_bytes_this_buffer;
799  u16 sum16;
800  void *data_this_buffer;
801
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;
805
806  /* ICMP4 checksum does not include the IP header */
807  sum0 = 0;
808
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)
814    {
815      n_this_buffer = n_ip_bytes_this_buffer > ip_header_length ?
816	n_ip_bytes_this_buffer - ip_header_length : 0;
817    }
818  while (1)
819    {
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)
823	break;
824
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;
829    }
830
831  sum16 = ~ip_csum_fold (sum0);
832
833  return sum16;
834}
835
836
837static void
838ip46_fix_len_and_csum (vlib_main_t * vm, int l4_offset, u16 data_len,
839		       vlib_buffer_t * b0, int is_ip6)
840{
841  u16 payload_length =
842    data_len + sizeof (icmp46_header_t) + offsetof (icmp46_echo_request_t,
843						    data);
844  u16 total_length = payload_length + l4_offset;
845  icmp46_header_t *icmp46 = vlib_buffer_get_current (b0) + l4_offset;
846  icmp46->checksum = 0;
847
848  if (is_ip6)
849    {
850      ip6_header_t *ip6 = vlib_buffer_get_current (b0);
851      ip6->payload_length = clib_host_to_net_u16 (payload_length);
852
853      int bogus_length = 0;
854      icmp46->checksum =
855	ip6_tcp_udp_icmp_compute_checksum (vm, b0, ip6, &bogus_length);
856    }
857  else
858    {
859      ip4_header_t *ip4 = vlib_buffer_get_current (b0);
860      ip4->length = clib_host_to_net_u16 (total_length);
861
862      ip4->checksum = ip4_header_checksum (ip4);
863      icmp46->checksum = ip4_icmp_compute_checksum (vm, b0, ip4);
864    }
865}
866
867static u16
868at_most_a_frame (u32 count)
869{
870  return count > VLIB_FRAME_SIZE ? VLIB_FRAME_SIZE : count;
871}
872
873static int
874ip46_enqueue_packet (vlib_main_t * vm, vlib_buffer_t * b0, u32 burst,
875		     int is_ip6)
876{
877  vlib_frame_t *f = 0;
878  u32 lookup_node_index =
879    is_ip6 ? ip6_lookup_node.index : ip4_lookup_node.index;
880  int n_sent = 0;
881
882  u16 n_to_send;
883
884  /*
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.
889   */
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)
892    {
893      f = vlib_get_frame_to_node (vm, lookup_node_index);
894      /* f can not be NULL here - frame allocation failure causes panic */
895
896      u32 *to_next = vlib_frame_vector_args (f);
897      f->n_vectors = n_to_send;
898
899      while (n_to_send > 1)
900	{
901	  vlib_buffer_t *b0copy = vlib_buffer_copy (vm, b0);
902	  if (PREDICT_FALSE (b0copy == NULL))
903	    goto ship_and_ret;
904	  *to_next++ = vlib_get_buffer_index (vm, b0copy);
905	  n_to_send--;
906	  n_sent++;
907	}
908
909      /* n_to_send is guaranteed to equal 1 here */
910      if (burst > 0)
911	{
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))
915	    goto ship_and_ret;
916	  n_to_send--;
917	  *to_next++ = vlib_get_buffer_index (vm, b0copy);
918	}
919      else
920	{
921	  /* put the original buffer as the last one of an error-free run */
922	  *to_next++ = vlib_get_buffer_index (vm, b0);
923	}
924      vlib_put_frame_to_node (vm, lookup_node_index, f);
925      n_sent += f->n_vectors;
926    }
927  return n_sent;
928  /*
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.
934   */
935ship_and_ret:
936  n_sent += f->n_vectors;
937  vlib_put_frame_to_node (vm, lookup_node_index, f);
938  return n_sent;
939}
940
941
942/*
943 * An address-family agnostic ping send function.
944 */
945
946#define ERROR_OUT(e) do { err = e; goto done; } while (0)
947
948static send_ip46_ping_result_t
949send_ip46_ping (vlib_main_t * vm,
950		u32 table_id,
951		ip46_address_t * pa46,
952		u32 sw_if_index,
953		u16 seq_host, u16 id_host, u16 data_len, u32 burst,
954		u8 verbose, int is_ip6)
955{
956  int err = SEND_PING_OK;
957  u32 bi0 = 0;
958  int n_buf0 = 0;
959  vlib_buffer_t *b0;
960
961  n_buf0 = vlib_buffer_alloc (vm, &bi0, 1);
962  if (n_buf0 < 1)
963    ERROR_OUT (SEND_PING_ALLOC_FAIL);
964
965  b0 = vlib_get_buffer (vm, bi0);
966  VLIB_BUFFER_TRACE_TRAJECTORY_INIT (b0);
967
968  /*
969   * if the user did not provide a source interface,
970   * perform a resolution and use an interface
971   * via which it succeeds.
972   */
973  u32 fib_index;
974  if (~0 == sw_if_index)
975    {
976      fib_index = ip46_fib_index_from_table_id (table_id, is_ip6);
977      sw_if_index = ip46_get_resolving_interface (fib_index, pa46, is_ip6);
978    }
979  else
980    fib_index =
981      ip46_fib_table_get_index_for_sw_if_index (sw_if_index, is_ip6);
982
983  if (~0 == fib_index)
984    ERROR_OUT (SEND_PING_NO_TABLE);
985  if (~0 == sw_if_index)
986    ERROR_OUT (SEND_PING_NO_INTERFACE);
987
988  vnet_buffer (b0)->sw_if_index[VLIB_RX] = sw_if_index;
989  vnet_buffer (b0)->sw_if_index[VLIB_TX] = fib_index;
990
991  int l4_header_offset = ip46_fill_l3_header (pa46, b0, is_ip6);
992
993  /* set the src address in the buffer */
994  if (!ip46_set_src_address (sw_if_index, b0, is_ip6))
995    ERROR_OUT (SEND_PING_NO_SRC_ADDRESS);
996  if (verbose)
997    ip46_print_buffer_src_address (vm, b0, is_ip6);
998
999  data_len =
1000    ip46_fill_icmp_request_at (vm, l4_header_offset, seq_host, id_host,
1001			       data_len, b0, is_ip6);
1002
1003  ip46_fix_len_and_csum (vm, l4_header_offset, data_len, b0, is_ip6);
1004
1005  int n_sent = ip46_enqueue_packet (vm, b0, burst, is_ip6);
1006  if (n_sent < burst)
1007    err = SEND_PING_NO_BUFFERS;
1008
1009done:
1010  if (err != SEND_PING_OK)
1011    {
1012      if (n_buf0 > 0)
1013	vlib_buffer_free (vm, &bi0, 1);
1014    }
1015  return err;
1016}
1017
1018static send_ip46_ping_result_t
1019send_ip6_ping (vlib_main_t * vm,
1020	       u32 table_id, ip6_address_t * pa6,
1021	       u32 sw_if_index, u16 seq_host, u16 id_host, u16 data_len,
1022	       u32 burst, u8 verbose)
1023{
1024  ip46_address_t target;
1025  target.ip6 = *pa6;
1026  return send_ip46_ping (vm, table_id, &target, sw_if_index, seq_host,
1027			 id_host, data_len, burst, verbose, 1 /* is_ip6 */ );
1028}
1029
1030static send_ip46_ping_result_t
1031send_ip4_ping (vlib_main_t * vm,
1032	       u32 table_id, ip4_address_t * pa4,
1033	       u32 sw_if_index, u16 seq_host, u16 id_host, u16 data_len,
1034	       u32 burst, u8 verbose)
1035{
1036  ip46_address_t target;
1037  ip46_address_set_ip4 (&target, pa4);
1038  return send_ip46_ping (vm, table_id, &target, sw_if_index, seq_host,
1039			 id_host, data_len, burst, verbose, 0 /* is_ip6 */ );
1040}
1041
1042static void
1043print_ip46_icmp_reply (vlib_main_t * vm, u32 bi0, int is_ip6)
1044{
1045  vlib_buffer_t *b0 = vlib_get_buffer (vm, bi0);
1046  int l4_offset;
1047  void *paddr;
1048  void *format_addr_func;
1049  u16 payload_length;
1050  u8 ttl;
1051  if (is_ip6)
1052    {
1053      ip6_header_t *ip6 = vlib_buffer_get_current (b0);
1054      paddr = (void *) &ip6->src_address;
1055      format_addr_func = (void *) format_ip6_address;
1056      ttl = ip6->hop_limit;
1057      l4_offset = sizeof (ip6_header_t);	// FIXME - EH processing ?
1058      payload_length = clib_net_to_host_u16 (ip6->payload_length);
1059    }
1060  else
1061    {
1062      ip4_header_t *ip4 = vlib_buffer_get_current (b0);
1063      paddr = (void *) &ip4->src_address;
1064      format_addr_func = (void *) format_ip4_address;
1065      ttl = ip4->ttl;
1066      l4_offset = ip4_header_bytes (ip4);
1067      payload_length =
1068	clib_net_to_host_u16 (ip4->length) + ip4_header_bytes (ip4);
1069    }
1070  icmp46_header_t *icmp = vlib_buffer_get_current (b0) + l4_offset;
1071  icmp46_echo_request_t *icmp_echo = (icmp46_echo_request_t *) (icmp + 1);
1072  u64 *dataplane_ts = (u64 *) & vnet_buffer (b0)->unused[0];
1073
1074  f64 clocks_per_second = ((f64) vm->clib_time.clocks_per_second);
1075  f64 rtt =
1076    ((f64) (*dataplane_ts - icmp_echo->time_sent)) / clocks_per_second;
1077
1078  vlib_cli_output (vm,
1079		   "%d bytes from %U: icmp_seq=%d ttl=%d time=%.4f ms",
1080		   payload_length,
1081		   format_addr_func,
1082		   paddr,
1083		   clib_host_to_net_u16 (icmp_echo->seq), ttl, rtt * 1000.0);
1084}
1085
1086/*
1087 * Perform the ping run with the given parameters in the current CLI process.
1088 * Depending on whether pa4 or pa6 is set, runs IPv4 or IPv6 ping.
1089 * The amusing side effect is of course if both are set, then both pings are sent.
1090 * This behavior can be used to ping a dualstack host over IPv4 and IPv6 at once.
1091 */
1092
1093static void
1094run_ping_ip46_address (vlib_main_t * vm, u32 table_id, ip4_address_t * pa4,
1095		       ip6_address_t * pa6, u32 sw_if_index,
1096		       f64 ping_interval, u32 ping_repeat, u32 data_len,
1097		       u32 ping_burst, u32 verbose)
1098{
1099  int i;
1100  uword curr_proc = vlib_current_process (vm);
1101  u32 n_replies = 0;
1102  u32 n_requests = 0;
1103  u16 icmp_id;
1104
1105  static u32 rand_seed = 0;
1106
1107  if (PREDICT_FALSE (!rand_seed))
1108    rand_seed = random_default_seed ();
1109
1110  icmp_id = random_u32 (&rand_seed) & 0xffff;
1111
1112  while (~0 != get_cli_process_id_by_icmp_id_mt (vm, icmp_id))
1113    {
1114      vlib_cli_output (vm, "ICMP ID collision at %d, incrementing", icmp_id);
1115      icmp_id++;
1116    }
1117
1118  set_cli_process_id_by_icmp_id_mt (vm, icmp_id, curr_proc);
1119
1120  for (i = 1; i <= ping_repeat; i++)
1121    {
1122      send_ip46_ping_result_t res = SEND_PING_OK;
1123      f64 sleep_interval;
1124      f64 time_ping_sent = vlib_time_now (vm);
1125      if (pa6)
1126	{
1127	  res = send_ip6_ping (vm, table_id,
1128			       pa6, sw_if_index, i, icmp_id,
1129			       data_len, ping_burst, verbose);
1130	  if (SEND_PING_OK == res)
1131	    n_requests += ping_burst;
1132	  else
1133	    vlib_cli_output (vm, "Failed: %U", format_ip46_ping_result, res);
1134	}
1135      if (pa4)
1136	{
1137	  res = send_ip4_ping (vm, table_id, pa4,
1138			       sw_if_index, i, icmp_id, data_len,
1139			       ping_burst, verbose);
1140	  if (SEND_PING_OK == res)
1141	    n_requests += ping_burst;
1142	  else
1143	    vlib_cli_output (vm, "Failed: %U", format_ip46_ping_result, res);
1144	}
1145
1146      /* Collect and print the responses until it is time to send a next ping */
1147
1148      while ((i <= ping_repeat)
1149	     &&
1150	     ((sleep_interval =
1151	       time_ping_sent + ping_interval - vlib_time_now (vm)) > 0.0))
1152	{
1153	  uword event_type, *event_data = 0;
1154	  vlib_process_wait_for_event_or_clock (vm, sleep_interval);
1155	  event_type = vlib_process_get_events (vm, &event_data);
1156	  switch (event_type)
1157	    {
1158	    case ~0:		/* no events => timeout */
1159	      break;
1160	    case PING_RESPONSE_IP6:
1161	      /* fall-through */
1162	    case PING_RESPONSE_IP4:
1163	      {
1164		int ii;
1165		int is_ip6 = (event_type == PING_RESPONSE_IP6);
1166		for (ii = 0; ii < vec_len (event_data); ii++)
1167		  {
1168		    u32 bi0 = event_data[ii];
1169		    print_ip46_icmp_reply (vm, bi0, is_ip6);
1170		    n_replies++;
1171		    if (0 != bi0)
1172		      vlib_buffer_free (vm, &bi0, 1);
1173		  }
1174	      }
1175	      break;
1176	    default:
1177	      /* someone pressed a key, abort */
1178	      vlib_cli_output (vm, "Aborted due to a keypress.");
1179	      goto double_break;
1180	      break;
1181	    }
1182	  vec_free (event_data);
1183	}
1184    }
1185double_break:
1186  vlib_cli_output (vm, "\n");
1187  {
1188    float loss =
1189      (0 ==
1190       n_requests) ? 0 : 100.0 * ((float) n_requests -
1191				  (float) n_replies) / (float) n_requests;
1192    vlib_cli_output (vm,
1193		     "Statistics: %u sent, %u received, %f%% packet loss\n",
1194		     n_requests, n_replies, loss);
1195    clear_cli_process_id_by_icmp_id_mt (vm, icmp_id);
1196  }
1197}
1198
1199
1200
1201static clib_error_t *
1202ping_ip_address (vlib_main_t * vm,
1203		 unformat_input_t * input, vlib_cli_command_t * cmd)
1204{
1205  ip4_address_t a4;
1206  ip6_address_t a6;
1207  clib_error_t *error = 0;
1208  u32 ping_repeat = 5;
1209  u32 ping_burst = 1;
1210  u8 ping_ip4, ping_ip6;
1211  vnet_main_t *vnm = vnet_get_main ();
1212  u32 data_len = PING_DEFAULT_DATA_LEN;
1213  u32 verbose = 0;
1214  f64 ping_interval = PING_DEFAULT_INTERVAL;
1215  u32 sw_if_index, table_id;
1216
1217  table_id = 0;
1218  ping_ip4 = ping_ip6 = 0;
1219  sw_if_index = ~0;
1220
1221  if (unformat (input, "%U", unformat_ip4_address, &a4))
1222    {
1223      ping_ip4 = 1;
1224    }
1225  else if (unformat (input, "%U", unformat_ip6_address, &a6))
1226    {
1227      ping_ip6 = 1;
1228    }
1229  else if (unformat (input, "ipv4"))
1230    {
1231      if (unformat (input, "%U", unformat_ip4_address, &a4))
1232	{
1233	  ping_ip4 = 1;
1234	}
1235      else
1236	{
1237	  error =
1238	    clib_error_return (0,
1239			       "expecting IPv4 address but got `%U'",
1240			       format_unformat_error, input);
1241	}
1242    }
1243  else if (unformat (input, "ipv6"))
1244    {
1245      if (unformat (input, "%U", unformat_ip6_address, &a6))
1246	{
1247	  ping_ip6 = 1;
1248	}
1249      else
1250	{
1251	  error =
1252	    clib_error_return (0,
1253			       "expecting IPv6 address but got `%U'",
1254			       format_unformat_error, input);
1255	}
1256    }
1257  else
1258    {
1259      error =
1260	clib_error_return (0,
1261			   "expecting IP4/IP6 address `%U'. Usage: ping <addr> [source <intf>] [size <datasz>] [repeat <count>] [verbose]",
1262			   format_unformat_error, input);
1263      goto done;
1264    }
1265
1266  /* allow for the second AF in the same ping */
1267  if (!ping_ip4 && (unformat (input, "ipv4")))
1268    {
1269      if (unformat (input, "%U", unformat_ip4_address, &a4))
1270	{
1271	  ping_ip4 = 1;
1272	}
1273    }
1274  else if (!ping_ip6 && (unformat (input, "ipv6")))
1275    {
1276      if (unformat (input, "%U", unformat_ip6_address, &a6))
1277	{
1278	  ping_ip6 = 1;
1279	}
1280    }
1281
1282  /* parse the rest of the parameters  in a cycle */
1283  while (!unformat_eof (input, NULL))
1284    {
1285      if (unformat (input, "source"))
1286	{
1287	  if (!unformat_user
1288	      (input, unformat_vnet_sw_interface, vnm, &sw_if_index))
1289	    {
1290	      error =
1291		clib_error_return (0,
1292				   "unknown interface `%U'",
1293				   format_unformat_error, input);
1294	      goto done;
1295	    }
1296	}
1297      else if (unformat (input, "size"))
1298	{
1299	  if (!unformat (input, "%u", &data_len))
1300	    {
1301	      error =
1302		clib_error_return (0,
1303				   "expecting size but got `%U'",
1304				   format_unformat_error, input);
1305	      goto done;
1306	    }
1307	  if (data_len > PING_MAXIMUM_DATA_SIZE)
1308	    {
1309	      error =
1310		clib_error_return (0,
1311				   "%d is bigger than maximum allowed payload size %d",
1312				   data_len, PING_MAXIMUM_DATA_SIZE);
1313	      goto done;
1314	    }
1315	}
1316      else if (unformat (input, "table-id"))
1317	{
1318	  if (!unformat (input, "%u", &table_id))
1319	    {
1320	      error =
1321		clib_error_return (0,
1322				   "expecting table-id but got `%U'",
1323				   format_unformat_error, input);
1324	      goto done;
1325	    }
1326	}
1327      else if (unformat (input, "interval"))
1328	{
1329	  if (!unformat (input, "%f", &ping_interval))
1330	    {
1331	      error =
1332		clib_error_return (0,
1333				   "expecting interval (floating point number) got `%U'",
1334				   format_unformat_error, input);
1335	      goto done;
1336	    }
1337	}
1338      else if (unformat (input, "repeat"))
1339	{
1340	  if (!unformat (input, "%u", &ping_repeat))
1341	    {
1342	      error =
1343		clib_error_return (0,
1344				   "expecting repeat count but got `%U'",
1345				   format_unformat_error, input);
1346	      goto done;
1347	    }
1348	}
1349      else if (unformat (input, "burst"))
1350	{
1351	  if (!unformat (input, "%u", &ping_burst))
1352	    {
1353	      error =
1354		clib_error_return (0,
1355				   "expecting burst count but got `%U'",
1356				   format_unformat_error, input);
1357	      goto done;
1358	    }
1359	}
1360      else if (unformat (input, "verbose"))
1361	{
1362	  verbose = 1;
1363	}
1364      else
1365	{
1366	  error = clib_error_return (0, "unknown input `%U'",
1367				     format_unformat_error, input);
1368	  goto done;
1369	}
1370    }
1371
1372/*
1373 * Operationally, one won't (and shouldn't) need to send more than a frame worth of pings.
1374 * But it may be handy during the debugging.
1375 */
1376
1377#ifdef CLIB_DEBUG
1378#define MAX_PING_BURST (10*VLIB_FRAME_SIZE)
1379#else
1380#define MAX_PING_BURST (VLIB_FRAME_SIZE)
1381#endif
1382
1383  if (ping_burst < 1 || ping_burst > MAX_PING_BURST)
1384    return clib_error_return (0, "burst size must be between 1 and %u",
1385			      MAX_PING_BURST);
1386
1387  run_ping_ip46_address (vm, table_id, ping_ip4 ? &a4 : NULL,
1388			 ping_ip6 ? &a6 : NULL, sw_if_index, ping_interval,
1389			 ping_repeat, data_len, ping_burst, verbose);
1390done:
1391  return error;
1392}
1393
1394/*?
1395 * This command sends an ICMP ECHO_REQUEST to network hosts. The address
1396 * can be an IPv4 or IPv6 address (or both at the same time).
1397 *
1398 * @cliexpar
1399 * @parblock
1400 * Example of how ping an IPv4 address:
1401 * @cliexstart{ping 172.16.1.2 source GigabitEthernet2/0/0 repeat 2}
1402 * 64 bytes from 172.16.1.2: icmp_seq=1 ttl=64 time=.1090 ms
1403 * 64 bytes from 172.16.1.2: icmp_seq=2 ttl=64 time=.0914 ms
1404 *
1405 * Statistics: 2 sent, 2 received, 0% packet loss
1406 * @cliexend
1407 *
1408 * Example of how ping both an IPv4 address and IPv6 address at the same time:
1409 * @cliexstart{ping 172.16.1.2 ipv6 fe80::24a5:f6ff:fe9c:3a36 source GigabitEthernet2/0/0 repeat 2 verbose}
1410 * Adjacency index: 10, sw_if_index: 1
1411 * Adj: ip6-discover-neighbor
1412 * Adj Interface: 0
1413 * Forced set interface: 1
1414 * Adjacency index: 0, sw_if_index: 4294967295
1415 * Adj: ip4-miss
1416 * Adj Interface: 0
1417 * Forced set interface: 1
1418 * Source address: 172.16.1.1
1419 * 64 bytes from 172.16.1.2: icmp_seq=1 ttl=64 time=.1899 ms
1420 * Adjacency index: 10, sw_if_index: 1
1421 * Adj: ip6-discover-neighbor
1422 * Adj Interface: 0
1423 * Forced set interface: 1
1424 * Adjacency index: 0, sw_if_index: 4294967295
1425 * Adj: ip4-miss
1426 * Adj Interface: 0
1427 * Forced set interface: 1
1428 * Source address: 172.16.1.1
1429 * 64 bytes from 172.16.1.2: icmp_seq=2 ttl=64 time=.0910 ms
1430 *
1431 * Statistics: 4 sent, 2 received, 50% packet loss
1432 * @cliexend
1433 * @endparblock
1434?*/
1435/* *INDENT-OFF* */
1436VLIB_CLI_COMMAND (ping_command, static) =
1437{
1438  .path = "ping",
1439  .function = ping_ip_address,
1440  .short_help = "ping {<ip-addr> | ipv4 <ip4-addr> | ipv6 <ip6-addr>}"
1441  " [ipv4 <ip4-addr> | ipv6 <ip6-addr>] [source <interface>]"
1442  " [size <pktsize:60>] [interval <sec:1>] [repeat <cnt:5>] [table-id <id:0>]"
1443  " [burst <count:1>] [verbose]",
1444  .is_mp_safe = 1,
1445};
1446/* *INDENT-ON* */
1447
1448static clib_error_t *
1449ping_cli_init (vlib_main_t * vm)
1450{
1451  vlib_thread_main_t *tm = vlib_get_thread_main ();
1452  ping_main_t *pm = &ping_main;
1453
1454  pm->ip6_main = &ip6_main;
1455  pm->ip4_main = &ip4_main;
1456  icmp6_register_type (vm, ICMP6_echo_reply, ip6_icmp_echo_reply_node.index);
1457  ip4_icmp_register_type (vm, ICMP4_echo_reply,
1458			  ip4_icmp_echo_reply_node.index);
1459  if (tm->n_vlib_mains > 1)
1460    clib_spinlock_init (&pm->ping_run_check_lock);
1461
1462  ip4_icmp_register_type (vm, ICMP4_echo_request,
1463			  ip4_icmp_echo_request_node.index);
1464
1465  return 0;
1466}
1467
1468VLIB_INIT_FUNCTION (ping_cli_init);
1469
1470/* *INDENT-OFF* */
1471VLIB_PLUGIN_REGISTER () = {
1472    .version = VPP_BUILD_VER,
1473    .description = "Ping (ping)",
1474};
1475/* *INDENT-ON* */
1476
1477/*
1478 * fd.io coding-style-patch-verification: ON
1479 *
1480 * Local Variables:
1481 * eval: (c-set-style "gnu")
1482 * End:
1483 */
1484