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