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