src/vnet/ip/icmp4.c

   1 /*
   2  * Copyright (c) 2015 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  * ip/icmp4.c: ipv4 icmp
  17  *
  18  * Copyright (c) 2008 Eliot Dresselhaus
  19  *
  20  * Permission is hereby granted, free of charge, to any person obtaining
  21  * a copy of this software and associated documentation files (the
  22  * "Software"), to deal in the Software without restriction, including
  23  * without limitation the rights to use, copy, modify, merge, publish,
  24  * distribute, sublicense, and/or sell copies of the Software, and to
  25  * permit persons to whom the Software is furnished to do so, subject to
  26  * the following conditions:
  27  *
  28  * The above copyright notice and this permission notice shall be
  29  * included in all copies or substantial portions of the Software.
  30  *
  31  *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  32  *  EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  33  *  MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  34  *  NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
  35  *  LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
  36  *  OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
  37  *  WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  38  */
  39
  40 #include <vlib/vlib.h>
  41 #include <vnet/ip/ip.h>
  42 #include <vnet/pg/pg.h>
  43 #include <vnet/ip/ip_sas.h>
  44 #include <vnet/util/throttle.h>
  45
  46 /** ICMP throttling */
  47 static throttle_t icmp_throttle;
  48
  49 static u8 *
  50 format_ip4_icmp_type_and_code (u8 * s, va_list * args)
  51 {
  52   icmp4_type_t type = va_arg (*args, int);
  53   u8 code = va_arg (*args, int);
  54   char *t = 0;
  55
  56 #define _(n,f) case n: t = #f; break;
  57
  58   switch (type)
  59     {
  60       foreach_icmp4_type;
  61
  62     default:
  63       break;
  64     }
  65
  66 #undef _
  67
  68   if (!t)
  69     return format (s, "unknown 0x%x", type);
  70
  71   s = format (s, "%s", t);
  72
  73   t = 0;
  74   switch ((type << 8) | code)
  75     {
  76 #define _(a,n,f) case (ICMP4_##a << 8) | (n): t = #f; break;
  77
  78       foreach_icmp4_code;
  79
  80 #undef _
  81     }
  82
  83   if (t)
  84     s = format (s, " %s", t);
  85
  86   return s;
  87 }
  88
  89 static u8 *
  90 format_ip4_icmp_header (u8 * s, va_list * args)
  91 {
  92   icmp46_header_t *icmp = va_arg (*args, icmp46_header_t *);
  93   u32 max_header_bytes = va_arg (*args, u32);
  94
  95   /* Nothing to do. */
  96   if (max_header_bytes < sizeof (icmp[0]))
  97     return format (s, "ICMP header truncated");
  98
  99   s = format (s, "ICMP %U checksum 0x%x",
 100               format_ip4_icmp_type_and_code, icmp->type, icmp->code,
 101               clib_net_to_host_u16 (icmp->checksum));
 102
 103   if ((ICMP4_echo_request == icmp->type || ICMP4_echo_reply == icmp->type)
 104       && sizeof (icmp[0]) + sizeof (u16) < max_header_bytes)
 105     {
 106       s = format (s, " id %u", clib_net_to_host_u16 (*(u16 *) (icmp + 1)));
 107     }
 108
 109   return s;
 110 }
 111
 112 static u8 *
 113 format_icmp_input_trace (u8 * s, va_list * va)
 114 {
 115   CLIB_UNUSED (vlib_main_t * vm) = va_arg (*va, vlib_main_t *);
 116   CLIB_UNUSED (vlib_node_t * node) = va_arg (*va, vlib_node_t *);
 117   icmp_input_trace_t *t = va_arg (*va, icmp_input_trace_t *);
 118
 119   s = format (s, "%U",
 120               format_ip4_header, t->packet_data, sizeof (t->packet_data));
 121
 122   return s;
 123 }
 124
 125 typedef enum
 126 {
 127   ICMP_INPUT_NEXT_ERROR,
 128   ICMP_INPUT_N_NEXT,
 129 } icmp_input_next_t;
 130
 131 typedef struct
 132 {
 133   uword *type_and_code_by_name;
 134
 135   uword *type_by_name;
 136
 137   /* Vector dispatch table indexed by [icmp type]. */
 138   u8 ip4_input_next_index_by_type[256];
 139 } icmp4_main_t;
 140
 141 icmp4_main_t icmp4_main;
 142
 143 static uword
 144 ip4_icmp_input (vlib_main_t * vm,
 145                 vlib_node_runtime_t * node, vlib_frame_t * frame)
 146 {
 147   icmp4_main_t *im = &icmp4_main;
 148   uword n_packets = frame->n_vectors;
 149   u32 *from, *to_next;
 150   u32 n_left_from, n_left_to_next, next;
 151
 152   from = vlib_frame_vector_args (frame);
 153   n_left_from = n_packets;
 154   next = node->cached_next_index;
 155
 156   if (node->flags & VLIB_NODE_FLAG_TRACE)
 157     vlib_trace_frame_buffers_only (vm, node, from, frame->n_vectors,
 158                                    /* stride */ 1,
 159                                    sizeof (icmp_input_trace_t));
 160
 161   while (n_left_from > 0)
 162     {
 163       vlib_get_next_frame (vm, node, next, to_next, n_left_to_next);
 164
 165       while (n_left_from > 0 && n_left_to_next > 0)
 166         {
 167           vlib_buffer_t *p0;
 168           ip4_header_t *ip0;
 169           icmp46_header_t *icmp0;
 170           icmp4_type_t type0;
 171           u32 bi0, next0;
 172
 173           if (PREDICT_TRUE (n_left_from > 2))
 174             {
 175               vlib_prefetch_buffer_with_index (vm, from[2], LOAD);
 176               p0 = vlib_get_buffer (vm, from[1]);
 177               ip0 = vlib_buffer_get_current (p0);
 178               clib_prefetch_load (ip0);
 179             }
 180
 181           bi0 = to_next[0] = from[0];
 182
 183           from += 1;
 184           n_left_from -= 1;
 185           to_next += 1;
 186           n_left_to_next -= 1;
 187
 188           p0 = vlib_get_buffer (vm, bi0);
 189           ip0 = vlib_buffer_get_current (p0);
 190           icmp0 = ip4_next_header (ip0);
 191           type0 = icmp0->type;
 192           next0 = im->ip4_input_next_index_by_type[type0];
 193
 194           p0->error = node->errors[ICMP4_ERROR_UNKNOWN_TYPE];
 195
 196           /* Verify speculative enqueue, maybe switch current next frame */
 197           vlib_validate_buffer_enqueue_x1 (vm, node, next, to_next,
 198                                            n_left_to_next, bi0, next0);
 199         }
 200
 201       vlib_put_next_frame (vm, node, next, n_left_to_next);
 202     }
 203
 204   return frame->n_vectors;
 205 }
 206
 207 /* *INDENT-OFF* */
 208 VLIB_REGISTER_NODE (ip4_icmp_input_node) = {
 209   .function = ip4_icmp_input,
 210   .name = "ip4-icmp-input",
 211
 212   .vector_size = sizeof (u32),
 213
 214   .format_trace = format_icmp_input_trace,
 215
 216   .n_errors = ICMP4_N_ERROR,
 217   .error_counters = icmp4_error_counters,
 218
 219   .n_next_nodes = 1,
 220   .next_nodes = {
 221     [ICMP_INPUT_NEXT_ERROR] = "ip4-punt",
 222   },
 223 };
 224 /* *INDENT-ON* */
 225
 226 typedef enum
 227 {
 228   IP4_ICMP_ERROR_NEXT_DROP,
 229   IP4_ICMP_ERROR_NEXT_LOOKUP,
 230   IP4_ICMP_ERROR_N_NEXT,
 231 } ip4_icmp_error_next_t;
 232
 233 static u8
 234 icmp4_icmp_type_to_error (u8 type)
 235 {
 236   switch (type)
 237     {
 238     case ICMP4_destination_unreachable:
 239       return ICMP4_ERROR_DEST_UNREACH_SENT;
 240     case ICMP4_time_exceeded:
 241       return ICMP4_ERROR_TTL_EXPIRE_SENT;
 242     case ICMP4_parameter_problem:
 243       return ICMP4_ERROR_PARAM_PROBLEM_SENT;
 244     default:
 245       return ICMP4_ERROR_DROP;
 246     }
 247 }
 248
 249 static uword
 250 ip4_icmp_error (vlib_main_t * vm,
 251                 vlib_node_runtime_t * node, vlib_frame_t * frame)
 252 {
 253   u32 *from, *to_next;
 254   uword n_left_from, n_left_to_next;
 255   ip4_icmp_error_next_t next_index;
 256   u32 thread_index = vm->thread_index;
 257
 258   from = vlib_frame_vector_args (frame);
 259   n_left_from = frame->n_vectors;
 260   next_index = node->cached_next_index;
 261
 262   u64 seed = throttle_seed (&icmp_throttle, thread_index, vlib_time_now (vm));
 263
 264   if (node->flags & VLIB_NODE_FLAG_TRACE)
 265     vlib_trace_frame_buffers_only (vm, node, from, frame->n_vectors,
 266                                    /* stride */ 1,
 267                                    sizeof (icmp_input_trace_t));
 268
 269   while (n_left_from > 0)
 270     {
 271       vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
 272
 273       while (n_left_from > 0 && n_left_to_next > 0)
 274         {
 275           /*
 276            * Duplicate first buffer and free the original chain.  Keep
 277            * as much of the original packet as possible, within the
 278            * minimum MTU. We chat "a little" here by keeping whatever
 279            * is available in the first buffer.
 280            */
 281
 282           u32 pi0 = ~0;
 283           u32 org_pi0 = from[0];
 284           u32 next0 = IP4_ICMP_ERROR_NEXT_LOOKUP;
 285           u8 error0 = ICMP4_ERROR_NONE;
 286           vlib_buffer_t *p0, *org_p0;
 287           ip4_header_t *ip0, *out_ip0;
 288           icmp46_header_t *icmp0;
 289           u32 sw_if_index0;
 290           ip_csum_t sum;
 291
 292           org_p0 = vlib_get_buffer (vm, org_pi0);
 293           ip0 = vlib_buffer_get_current (org_p0);
 294
 295           /* Rate limit based on the src,dst addresses in the original packet
 296            */
 297           u64 r0 =
 298             (u64) ip0->dst_address.as_u32 << 32 | ip0->src_address.as_u32;
 299
 300           if (throttle_check (&icmp_throttle, thread_index, r0, seed))
 301             {
 302               vlib_error_count (vm, node->node_index, ICMP4_ERROR_DROP, 1);
 303               from += 1;
 304               n_left_from -= 1;
 305               continue;
 306             }
 307
 308           p0 = vlib_buffer_copy_no_chain (vm, org_p0, &pi0);
 309           if (!p0 || pi0 == ~0) /* Out of buffers */
 310             continue;
 311
 312           /* Speculatively enqueue p0 to the current next frame */
 313           to_next[0] = pi0;
 314           from += 1;
 315           to_next += 1;
 316           n_left_from -= 1;
 317           n_left_to_next -= 1;
 318
 319           sw_if_index0 = vnet_buffer (p0)->sw_if_index[VLIB_RX];
 320
 321           vlib_buffer_copy_trace_flag (vm, org_p0, pi0);
 322
 323           /* Add IP header and ICMPv4 header including a 4 byte data field */
 324           vlib_buffer_advance (p0,
 325                                -sizeof (ip4_header_t) -
 326                                sizeof (icmp46_header_t) - 4);
 327
 328           p0->flags |= VNET_BUFFER_F_LOCALLY_ORIGINATED;
 329           p0->current_length =
 330             p0->current_length > 576 ? 576 : p0->current_length;
 331           out_ip0 = vlib_buffer_get_current (p0);
 332           icmp0 = (icmp46_header_t *) & out_ip0[1];
 333
 334           /* Fill ip header fields */
 335           out_ip0->ip_version_and_header_length = 0x45;
 336           out_ip0->tos = 0;
 337           out_ip0->length = clib_host_to_net_u16 (p0->current_length);
 338           out_ip0->fragment_id = 0;
 339           out_ip0->flags_and_fragment_offset = 0;
 340           out_ip0->ttl = 0xff;
 341           out_ip0->protocol = IP_PROTOCOL_ICMP;
 342           out_ip0->dst_address = ip0->src_address;
 343           /* Prefer a source address from "offending interface" */
 344           if (!ip4_sas_by_sw_if_index (sw_if_index0, &out_ip0->dst_address,
 345                                        &out_ip0->src_address))
 346             { /* interface has no IP6 address - should not happen */
 347               next0 = IP4_ICMP_ERROR_NEXT_DROP;
 348               error0 = ICMP4_ERROR_DROP;
 349             }
 350
 351           out_ip0->checksum = ip4_header_checksum (out_ip0);
 352
 353           /* Fill icmp header fields */
 354           icmp0->type = vnet_buffer (p0)->ip.icmp.type;
 355           icmp0->code = vnet_buffer (p0)->ip.icmp.code;
 356           *((u32 *) (icmp0 + 1)) =
 357             clib_host_to_net_u32 (vnet_buffer (p0)->ip.icmp.data);
 358           icmp0->checksum = 0;
 359           sum =
 360             ip_incremental_checksum (0, icmp0,
 361                                      p0->current_length -
 362                                      sizeof (ip4_header_t));
 363           icmp0->checksum = ~ip_csum_fold (sum);
 364
 365           /* Update error status */
 366           if (error0 == ICMP4_ERROR_NONE)
 367             error0 = icmp4_icmp_type_to_error (icmp0->type);
 368
 369           vlib_error_count (vm, node->node_index, error0, 1);
 370
 371           /* Verify speculative enqueue, maybe switch current next frame */
 372           vlib_validate_buffer_enqueue_x1 (vm, node, next_index,
 373                                            to_next, n_left_to_next,
 374                                            pi0, next0);
 375         }
 376       vlib_put_next_frame (vm, node, next_index, n_left_to_next);
 377     }
 378
 379   /*
 380    * push the original buffers to error-drop, so that
 381    * they can get the error counters handled, then freed
 382    */
 383   vlib_buffer_enqueue_to_single_next (vm, node,
 384                                       vlib_frame_vector_args (frame),
 385                                       IP4_ICMP_ERROR_NEXT_DROP,
 386                                       frame->n_vectors);
 387
 388   return frame->n_vectors;
 389 }
 390
 391 /* *INDENT-OFF* */
 392 VLIB_REGISTER_NODE (ip4_icmp_error_node) = {
 393   .function = ip4_icmp_error,
 394   .name = "ip4-icmp-error",
 395   .vector_size = sizeof (u32),
 396
 397   .n_errors = ICMP4_N_ERROR,
 398   .error_counters = icmp4_error_counters,
 399
 400   .n_next_nodes = IP4_ICMP_ERROR_N_NEXT,
 401   .next_nodes = {
 402     [IP4_ICMP_ERROR_NEXT_DROP] = "ip4-drop",
 403     [IP4_ICMP_ERROR_NEXT_LOOKUP] = "ip4-lookup",
 404   },
 405
 406   .format_trace = format_icmp_input_trace,
 407 };
 408 /* *INDENT-ON* */
 409
 410
 411 static uword
 412 unformat_icmp_type_and_code (unformat_input_t * input, va_list * args)
 413 {
 414   icmp46_header_t *h = va_arg (*args, icmp46_header_t *);
 415   icmp4_main_t *cm = &icmp4_main;
 416   u32 i;
 417
 418   if (unformat_user (input, unformat_vlib_number_by_name,
 419                      cm->type_and_code_by_name, &i))
 420     {
 421       h->type = (i >> 8) & 0xff;
 422       h->code = (i >> 0) & 0xff;
 423     }
 424   else if (unformat_user (input, unformat_vlib_number_by_name,
 425                           cm->type_by_name, &i))
 426     {
 427       h->type = i;
 428       h->code = 0;
 429     }
 430   else
 431     return 0;
 432
 433   return 1;
 434 }
 435
 436 static void
 437 icmp4_pg_edit_function (pg_main_t * pg,
 438                         pg_stream_t * s,
 439                         pg_edit_group_t * g, u32 * packets, u32 n_packets)
 440 {
 441   vlib_main_t *vm = vlib_get_main ();
 442   u32 ip_offset, icmp_offset;
 443
 444   icmp_offset = g->start_byte_offset;
 445   ip_offset = (g - 1)->start_byte_offset;
 446
 447   while (n_packets >= 1)
 448     {
 449       vlib_buffer_t *p0;
 450       ip4_header_t *ip0;
 451       icmp46_header_t *icmp0;
 452       u32 len0;
 453
 454       p0 = vlib_get_buffer (vm, packets[0]);
 455       n_packets -= 1;
 456       packets += 1;
 457
 458       ASSERT (p0->current_data == 0);
 459       ip0 = (void *) (p0->data + ip_offset);
 460       icmp0 = (void *) (p0->data + icmp_offset);
 461
 462       /* if IP length has been specified, then calculate the length based on buffer */
 463       if (ip0->length == 0)
 464         len0 = vlib_buffer_length_in_chain (vm, p0) - icmp_offset;
 465       else
 466         len0 = clib_net_to_host_u16 (ip0->length) - icmp_offset;
 467
 468       icmp0->checksum =
 469         ~ip_csum_fold (ip_incremental_checksum (0, icmp0, len0));
 470     }
 471 }
 472
 473 typedef struct
 474 {
 475   pg_edit_t type, code;
 476   pg_edit_t checksum;
 477 } pg_icmp46_header_t;
 478
 479 always_inline void
 480 pg_icmp_header_init (pg_icmp46_header_t * p)
 481 {
 482   /* Initialize fields that are not bit fields in the IP header. */
 483 #define _(f) pg_edit_init (&p->f, icmp46_header_t, f);
 484   _(type);
 485   _(code);
 486   _(checksum);
 487 #undef _
 488 }
 489
 490 static uword
 491 unformat_pg_icmp_header (unformat_input_t * input, va_list * args)
 492 {
 493   pg_stream_t *s = va_arg (*args, pg_stream_t *);
 494   pg_icmp46_header_t *p;
 495   u32 group_index;
 496
 497   p = pg_create_edit_group (s, sizeof (p[0]), sizeof (icmp46_header_t),
 498                             &group_index);
 499   pg_icmp_header_init (p);
 500
 501   p->checksum.type = PG_EDIT_UNSPECIFIED;
 502
 503   {
 504     icmp46_header_t tmp;
 505
 506     if (!unformat (input, "ICMP %U", unformat_icmp_type_and_code, &tmp))
 507       goto error;
 508
 509     pg_edit_set_fixed (&p->type, tmp.type);
 510     pg_edit_set_fixed (&p->code, tmp.code);
 511   }
 512
 513   /* Parse options. */
 514   while (1)
 515     {
 516       if (unformat (input, "checksum %U",
 517                     unformat_pg_edit, unformat_pg_number, &p->checksum))
 518         ;
 519
 520       /* Can't parse input: try next protocol level. */
 521       else
 522         break;
 523     }
 524
 525   if (!unformat_user (input, unformat_pg_payload, s))
 526     goto error;
 527
 528   if (p->checksum.type == PG_EDIT_UNSPECIFIED)
 529     {
 530       pg_edit_group_t *g = pg_stream_get_group (s, group_index);
 531       g->edit_function = icmp4_pg_edit_function;
 532       g->edit_function_opaque = 0;
 533     }
 534
 535   return 1;
 536
 537 error:
 538   /* Free up any edits we may have added. */
 539   pg_free_edit_group (s);
 540   return 0;
 541 }
 542
 543 void
 544 ip4_icmp_register_type (vlib_main_t * vm, icmp4_type_t type, u32 node_index)
 545 {
 546   icmp4_main_t *im = &icmp4_main;
 547   u32 old_next_index;
 548
 549   ASSERT ((int) type < ARRAY_LEN (im->ip4_input_next_index_by_type));
 550   old_next_index = im->ip4_input_next_index_by_type[type];
 551
 552   im->ip4_input_next_index_by_type[type]
 553     = vlib_node_add_next (vm, ip4_icmp_input_node.index, node_index);
 554
 555   if (old_next_index &&
 556       (old_next_index != im->ip4_input_next_index_by_type[type]))
 557     clib_warning ("WARNING: changed next_by_type[%d]", (int) type);
 558 }
 559
 560 static clib_error_t *
 561 icmp4_init (vlib_main_t * vm)
 562 {
 563   ip_main_t *im = &ip_main;
 564   ip_protocol_info_t *pi;
 565   icmp4_main_t *cm = &icmp4_main;
 566   clib_error_t *error;
 567
 568   error = vlib_call_init_function (vm, ip_main_init);
 569
 570   if (error)
 571     return error;
 572
 573   pi = ip_get_protocol_info (im, IP_PROTOCOL_ICMP);
 574   pi->format_header = format_ip4_icmp_header;
 575   pi->unformat_pg_edit = unformat_pg_icmp_header;
 576
 577   cm->type_by_name = hash_create_string (0, sizeof (uword));
 578 #define _(n,t) hash_set_mem (cm->type_by_name, #t, (n));
 579   foreach_icmp4_type;
 580 #undef _
 581
 582   cm->type_and_code_by_name = hash_create_string (0, sizeof (uword));
 583 #define _(a,n,t) hash_set_mem (cm->type_by_name, #t, (n) | (ICMP4_##a << 8));
 584   foreach_icmp4_code;
 585 #undef _
 586
 587   clib_memset (cm->ip4_input_next_index_by_type,
 588                ICMP_INPUT_NEXT_ERROR,
 589                sizeof (cm->ip4_input_next_index_by_type));
 590
 591   vlib_thread_main_t *tm = &vlib_thread_main;
 592   u32 n_vlib_mains = tm->n_vlib_mains;
 593
 594   throttle_init (&icmp_throttle, n_vlib_mains, THROTTLE_BITS, 1e-5);
 595
 596   return 0;
 597 }
 598
 599 VLIB_INIT_FUNCTION (icmp4_init);
 600
 601 /*
 602  * fd.io coding-style-patch-verification: ON
 603  *
 604  * Local Variables:
 605  * eval: (c-set-style "gnu")
 606  * End:
 607  */