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
  45 static char *icmp_error_strings[] = {
  46 #define _(f,s) s,
  47   foreach_icmp4_error
  48 #undef _
  49 };
  50
  51 static u8 *
  52 format_ip4_icmp_type_and_code (u8 * s, va_list * args)
  53 {
  54   icmp4_type_t type = va_arg (*args, int);
  55   u8 code = va_arg (*args, int);
  56   char *t = 0;
  57
  58 #define _(n,f) case n: t = #f; break;
  59
  60   switch (type)
  61     {
  62       foreach_icmp4_type;
  63
  64     default:
  65       break;
  66     }
  67
  68 #undef _
  69
  70   if (!t)
  71     return format (s, "unknown 0x%x", type);
  72
  73   s = format (s, "%s", t);
  74
  75   t = 0;
  76   switch ((type << 8) | code)
  77     {
  78 #define _(a,n,f) case (ICMP4_##a << 8) | (n): t = #f; break;
  79
  80       foreach_icmp4_code;
  81
  82 #undef _
  83     }
  84
  85   if (t)
  86     s = format (s, " %s", t);
  87
  88   return s;
  89 }
  90
  91 static u8 *
  92 format_ip4_icmp_header (u8 * s, va_list * args)
  93 {
  94   icmp46_header_t *icmp = va_arg (*args, icmp46_header_t *);
  95   u32 max_header_bytes = va_arg (*args, u32);
  96
  97   /* Nothing to do. */
  98   if (max_header_bytes < sizeof (icmp[0]))
  99     return format (s, "ICMP header truncated");
 100
 101   s = format (s, "ICMP %U checksum 0x%x",
 102               format_ip4_icmp_type_and_code, icmp->type, icmp->code,
 103               clib_net_to_host_u16 (icmp->checksum));
 104
 105   return s;
 106 }
 107
 108 static u8 *
 109 format_icmp_input_trace (u8 * s, va_list * va)
 110 {
 111   CLIB_UNUSED (vlib_main_t * vm) = va_arg (*va, vlib_main_t *);
 112   CLIB_UNUSED (vlib_node_t * node) = va_arg (*va, vlib_node_t *);
 113   icmp_input_trace_t *t = va_arg (*va, icmp_input_trace_t *);
 114
 115   s = format (s, "%U",
 116               format_ip4_header, t->packet_data, sizeof (t->packet_data));
 117
 118   return s;
 119 }
 120
 121 typedef enum
 122 {
 123   ICMP_INPUT_NEXT_ERROR,
 124   ICMP_INPUT_N_NEXT,
 125 } icmp_input_next_t;
 126
 127 typedef struct
 128 {
 129   uword *type_and_code_by_name;
 130
 131   uword *type_by_name;
 132
 133   /* Vector dispatch table indexed by [icmp type]. */
 134   u8 ip4_input_next_index_by_type[256];
 135 } icmp4_main_t;
 136
 137 icmp4_main_t icmp4_main;
 138
 139 static uword
 140 ip4_icmp_input (vlib_main_t * vm,
 141                 vlib_node_runtime_t * node, vlib_frame_t * frame)
 142 {
 143   icmp4_main_t *im = &icmp4_main;
 144   uword n_packets = frame->n_vectors;
 145   u32 *from, *to_next;
 146   u32 n_left_from, n_left_to_next, next;
 147
 148   from = vlib_frame_vector_args (frame);
 149   n_left_from = n_packets;
 150   next = node->cached_next_index;
 151
 152   if (node->flags & VLIB_NODE_FLAG_TRACE)
 153     vlib_trace_frame_buffers_only (vm, node, from, frame->n_vectors,
 154                                    /* stride */ 1,
 155                                    sizeof (icmp_input_trace_t));
 156
 157   while (n_left_from > 0)
 158     {
 159       vlib_get_next_frame (vm, node, next, to_next, n_left_to_next);
 160
 161       while (n_left_from > 0 && n_left_to_next > 0)
 162         {
 163           vlib_buffer_t *p0;
 164           ip4_header_t *ip0;
 165           icmp46_header_t *icmp0;
 166           icmp4_type_t type0;
 167           u32 bi0, next0;
 168
 169           if (PREDICT_TRUE (n_left_from > 2))
 170             {
 171               vlib_prefetch_buffer_with_index (vm, from[2], LOAD);
 172               p0 = vlib_get_buffer (vm, from[1]);
 173               ip0 = vlib_buffer_get_current (p0);
 174               CLIB_PREFETCH (ip0, CLIB_CACHE_LINE_BYTES, LOAD);
 175             }
 176
 177           bi0 = to_next[0] = from[0];
 178
 179           from += 1;
 180           n_left_from -= 1;
 181           to_next += 1;
 182           n_left_to_next -= 1;
 183
 184           p0 = vlib_get_buffer (vm, bi0);
 185           ip0 = vlib_buffer_get_current (p0);
 186           icmp0 = ip4_next_header (ip0);
 187           type0 = icmp0->type;
 188           next0 = im->ip4_input_next_index_by_type[type0];
 189
 190           p0->error = node->errors[ICMP4_ERROR_UNKNOWN_TYPE];
 191
 192           /* Verify speculative enqueue, maybe switch current next frame */
 193           vlib_validate_buffer_enqueue_x1 (vm, node, next, to_next,
 194                                            n_left_to_next, bi0, next0);
 195         }
 196
 197       vlib_put_next_frame (vm, node, next, n_left_to_next);
 198     }
 199
 200   return frame->n_vectors;
 201 }
 202
 203 /* *INDENT-OFF* */
 204 VLIB_REGISTER_NODE (ip4_icmp_input_node,static) = {
 205   .function = ip4_icmp_input,
 206   .name = "ip4-icmp-input",
 207
 208   .vector_size = sizeof (u32),
 209
 210   .format_trace = format_icmp_input_trace,
 211
 212   .n_errors = ARRAY_LEN (icmp_error_strings),
 213   .error_strings = icmp_error_strings,
 214
 215   .n_next_nodes = 1,
 216   .next_nodes = {
 217     [ICMP_INPUT_NEXT_ERROR] = "ip4-punt",
 218   },
 219 };
 220 /* *INDENT-ON* */
 221
 222 static uword
 223 ip4_icmp_echo_request (vlib_main_t * vm,
 224                        vlib_node_runtime_t * node, vlib_frame_t * frame)
 225 {
 226   uword n_packets = frame->n_vectors;
 227   u32 *from, *to_next;
 228   u32 n_left_from, n_left_to_next, next;
 229   ip4_main_t *i4m = &ip4_main;
 230   u16 *fragment_ids, *fid;
 231   u8 host_config_ttl = i4m->host_config.ttl;
 232
 233   from = vlib_frame_vector_args (frame);
 234   n_left_from = n_packets;
 235   next = node->cached_next_index;
 236
 237   if (node->flags & VLIB_NODE_FLAG_TRACE)
 238     vlib_trace_frame_buffers_only (vm, node, from, frame->n_vectors,
 239                                    /* stride */ 1,
 240                                    sizeof (icmp_input_trace_t));
 241
 242   /* Get random fragment IDs for replies. */
 243   fid = fragment_ids = clib_random_buffer_get_data (&vm->random_buffer,
 244                                                     n_packets *
 245                                                     sizeof (fragment_ids[0]));
 246
 247   while (n_left_from > 0)
 248     {
 249       vlib_get_next_frame (vm, node, next, to_next, n_left_to_next);
 250
 251       while (n_left_from > 2 && n_left_to_next > 2)
 252         {
 253           vlib_buffer_t *p0, *p1;
 254           ip4_header_t *ip0, *ip1;
 255           icmp46_header_t *icmp0, *icmp1;
 256           u32 bi0, src0, dst0;
 257           u32 bi1, src1, dst1;
 258           ip_csum_t sum0, sum1;
 259
 260           bi0 = to_next[0] = from[0];
 261           bi1 = to_next[1] = from[1];
 262
 263           from += 2;
 264           n_left_from -= 2;
 265           to_next += 2;
 266           n_left_to_next -= 2;
 267
 268           p0 = vlib_get_buffer (vm, bi0);
 269           p1 = vlib_get_buffer (vm, bi1);
 270           ip0 = vlib_buffer_get_current (p0);
 271           ip1 = vlib_buffer_get_current (p1);
 272           icmp0 = ip4_next_header (ip0);
 273           icmp1 = ip4_next_header (ip1);
 274
 275           vnet_buffer (p0)->sw_if_index[VLIB_RX] =
 276             vnet_main.local_interface_sw_if_index;
 277           vnet_buffer (p1)->sw_if_index[VLIB_RX] =
 278             vnet_main.local_interface_sw_if_index;
 279
 280           /* Update ICMP checksum. */
 281           sum0 = icmp0->checksum;
 282           sum1 = icmp1->checksum;
 283
 284           ASSERT (icmp0->type == ICMP4_echo_request);
 285           ASSERT (icmp1->type == ICMP4_echo_request);
 286           sum0 = ip_csum_update (sum0, ICMP4_echo_request, ICMP4_echo_reply,
 287                                  icmp46_header_t, type);
 288           sum1 = ip_csum_update (sum1, ICMP4_echo_request, ICMP4_echo_reply,
 289                                  icmp46_header_t, type);
 290           icmp0->type = ICMP4_echo_reply;
 291           icmp1->type = ICMP4_echo_reply;
 292
 293           icmp0->checksum = ip_csum_fold (sum0);
 294           icmp1->checksum = ip_csum_fold (sum1);
 295
 296           src0 = ip0->src_address.data_u32;
 297           src1 = ip1->src_address.data_u32;
 298           dst0 = ip0->dst_address.data_u32;
 299           dst1 = ip1->dst_address.data_u32;
 300
 301           /* Swap source and destination address.
 302              Does not change checksum. */
 303           ip0->src_address.data_u32 = dst0;
 304           ip1->src_address.data_u32 = dst1;
 305           ip0->dst_address.data_u32 = src0;
 306           ip1->dst_address.data_u32 = src1;
 307
 308           /* Update IP checksum. */
 309           sum0 = ip0->checksum;
 310           sum1 = ip1->checksum;
 311
 312           sum0 = ip_csum_update (sum0, ip0->ttl, host_config_ttl,
 313                                  ip4_header_t, ttl);
 314           sum1 = ip_csum_update (sum1, ip1->ttl, host_config_ttl,
 315                                  ip4_header_t, ttl);
 316           ip0->ttl = host_config_ttl;
 317           ip1->ttl = host_config_ttl;
 318
 319           /* New fragment id. */
 320           sum0 = ip_csum_update (sum0, ip0->fragment_id, fid[0],
 321                                  ip4_header_t, fragment_id);
 322           sum1 = ip_csum_update (sum1, ip1->fragment_id, fid[1],
 323                                  ip4_header_t, fragment_id);
 324           ip0->fragment_id = fid[0];
 325           ip1->fragment_id = fid[1];
 326           fid += 2;
 327
 328           ip0->checksum = ip_csum_fold (sum0);
 329           ip1->checksum = ip_csum_fold (sum1);
 330
 331           ASSERT (ip0->checksum == ip4_header_checksum (ip0));
 332           ASSERT (ip1->checksum == ip4_header_checksum (ip1));
 333
 334           p0->flags |= VNET_BUFFER_F_LOCALLY_ORIGINATED;
 335           p1->flags |= VNET_BUFFER_F_LOCALLY_ORIGINATED;
 336         }
 337
 338       while (n_left_from > 0 && n_left_to_next > 0)
 339         {
 340           vlib_buffer_t *p0;
 341           ip4_header_t *ip0;
 342           icmp46_header_t *icmp0;
 343           u32 bi0, src0, dst0;
 344           ip_csum_t sum0;
 345
 346           bi0 = to_next[0] = from[0];
 347
 348           from += 1;
 349           n_left_from -= 1;
 350           to_next += 1;
 351           n_left_to_next -= 1;
 352
 353           p0 = vlib_get_buffer (vm, bi0);
 354           ip0 = vlib_buffer_get_current (p0);
 355           icmp0 = ip4_next_header (ip0);
 356
 357           vnet_buffer (p0)->sw_if_index[VLIB_RX] =
 358             vnet_main.local_interface_sw_if_index;
 359
 360           /* Update ICMP checksum. */
 361           sum0 = icmp0->checksum;
 362
 363           ASSERT (icmp0->type == ICMP4_echo_request);
 364           sum0 = ip_csum_update (sum0, ICMP4_echo_request, ICMP4_echo_reply,
 365                                  icmp46_header_t, type);
 366           icmp0->type = ICMP4_echo_reply;
 367           icmp0->checksum = ip_csum_fold (sum0);
 368
 369           src0 = ip0->src_address.data_u32;
 370           dst0 = ip0->dst_address.data_u32;
 371           ip0->src_address.data_u32 = dst0;
 372           ip0->dst_address.data_u32 = src0;
 373
 374           /* Update IP checksum. */
 375           sum0 = ip0->checksum;
 376
 377           sum0 = ip_csum_update (sum0, ip0->ttl, host_config_ttl,
 378                                  ip4_header_t, ttl);
 379           ip0->ttl = host_config_ttl;
 380
 381           sum0 = ip_csum_update (sum0, ip0->fragment_id, fid[0],
 382                                  ip4_header_t, fragment_id);
 383           ip0->fragment_id = fid[0];
 384           fid += 1;
 385
 386           ip0->checksum = ip_csum_fold (sum0);
 387
 388           ASSERT (ip0->checksum == ip4_header_checksum (ip0));
 389
 390           p0->flags |= VNET_BUFFER_F_LOCALLY_ORIGINATED;
 391         }
 392
 393       vlib_put_next_frame (vm, node, next, n_left_to_next);
 394     }
 395
 396   vlib_error_count (vm, ip4_icmp_input_node.index,
 397                     ICMP4_ERROR_ECHO_REPLIES_SENT, frame->n_vectors);
 398
 399   return frame->n_vectors;
 400 }
 401
 402 /* *INDENT-OFF* */
 403 VLIB_REGISTER_NODE (ip4_icmp_echo_request_node,static) = {
 404   .function = ip4_icmp_echo_request,
 405   .name = "ip4-icmp-echo-request",
 406
 407   .vector_size = sizeof (u32),
 408
 409   .format_trace = format_icmp_input_trace,
 410
 411   .n_next_nodes = 1,
 412   .next_nodes = {
 413     [0] = "ip4-load-balance",
 414   },
 415 };
 416 /* *INDENT-ON* */
 417
 418 typedef enum
 419 {
 420   IP4_ICMP_ERROR_NEXT_DROP,
 421   IP4_ICMP_ERROR_NEXT_LOOKUP,
 422   IP4_ICMP_ERROR_N_NEXT,
 423 } ip4_icmp_error_next_t;
 424
 425 void
 426 icmp4_error_set_vnet_buffer (vlib_buffer_t * b, u8 type, u8 code, u32 data)
 427 {
 428   vnet_buffer (b)->ip.icmp.type = type;
 429   vnet_buffer (b)->ip.icmp.code = code;
 430   vnet_buffer (b)->ip.icmp.data = data;
 431 }
 432
 433 static u8
 434 icmp4_icmp_type_to_error (u8 type)
 435 {
 436   switch (type)
 437     {
 438     case ICMP4_destination_unreachable:
 439       return ICMP4_ERROR_DEST_UNREACH_SENT;
 440     case ICMP4_time_exceeded:
 441       return ICMP4_ERROR_TTL_EXPIRE_SENT;
 442     case ICMP4_parameter_problem:
 443       return ICMP4_ERROR_PARAM_PROBLEM_SENT;
 444     default:
 445       return ICMP4_ERROR_DROP;
 446     }
 447 }
 448
 449 static uword
 450 ip4_icmp_error (vlib_main_t * vm,
 451                 vlib_node_runtime_t * node, vlib_frame_t * frame)
 452 {
 453   u32 *from, *to_next;
 454   uword n_left_from, n_left_to_next;
 455   ip4_icmp_error_next_t next_index;
 456   ip4_main_t *im = &ip4_main;
 457   ip_lookup_main_t *lm = &im->lookup_main;
 458
 459   from = vlib_frame_vector_args (frame);
 460   n_left_from = frame->n_vectors;
 461   next_index = node->cached_next_index;
 462
 463   if (node->flags & VLIB_NODE_FLAG_TRACE)
 464     vlib_trace_frame_buffers_only (vm, node, from, frame->n_vectors,
 465                                    /* stride */ 1,
 466                                    sizeof (icmp_input_trace_t));
 467
 468   while (n_left_from > 0)
 469     {
 470       vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
 471
 472       while (n_left_from > 0 && n_left_to_next > 0)
 473         {
 474           /*
 475            * Duplicate first buffer and free the original chain.  Keep
 476            * as much of the original packet as possible, within the
 477            * minimum MTU. We chat "a little" here by keeping whatever
 478            * is available in the first buffer.
 479            */
 480
 481           u32 pi0 = ~0;
 482           u32 org_pi0 = from[0];
 483           u32 next0 = IP4_ICMP_ERROR_NEXT_LOOKUP;
 484           u8 error0 = ICMP4_ERROR_NONE;
 485           vlib_buffer_t *p0, *org_p0;
 486           ip4_header_t *ip0, *out_ip0;
 487           icmp46_header_t *icmp0;
 488           u32 sw_if_index0, if_add_index0;
 489           ip_csum_t sum;
 490
 491           org_p0 = vlib_get_buffer (vm, org_pi0);
 492           p0 = vlib_buffer_copy_no_chain (vm, org_p0, &pi0);
 493           if (!p0 || pi0 == ~0) /* Out of buffers */
 494             continue;
 495
 496           /* Speculatively enqueue p0 to the current next frame */
 497           to_next[0] = pi0;
 498           from += 1;
 499           to_next += 1;
 500           n_left_from -= 1;
 501           n_left_to_next -= 1;
 502
 503           ip0 = vlib_buffer_get_current (p0);
 504           sw_if_index0 = vnet_buffer (p0)->sw_if_index[VLIB_RX];
 505
 506           /* Add IP header and ICMPv4 header including a 4 byte data field */
 507           vlib_buffer_advance (p0,
 508                                -sizeof (ip4_header_t) -
 509                                sizeof (icmp46_header_t) - 4);
 510
 511           p0->current_length =
 512             p0->current_length > 576 ? 576 : p0->current_length;
 513           out_ip0 = vlib_buffer_get_current (p0);
 514           icmp0 = (icmp46_header_t *) & out_ip0[1];
 515
 516           /* Fill ip header fields */
 517           out_ip0->ip_version_and_header_length = 0x45;
 518           out_ip0->tos = 0;
 519           out_ip0->length = clib_host_to_net_u16 (p0->current_length);
 520           out_ip0->fragment_id = 0;
 521           out_ip0->flags_and_fragment_offset = 0;
 522           out_ip0->ttl = 0xff;
 523           out_ip0->protocol = IP_PROTOCOL_ICMP;
 524           out_ip0->dst_address = ip0->src_address;
 525           if_add_index0 = ~0;
 526           if (PREDICT_TRUE (vec_len (lm->if_address_pool_index_by_sw_if_index)
 527                             > sw_if_index0))
 528             if_add_index0 =
 529               lm->if_address_pool_index_by_sw_if_index[sw_if_index0];
 530           if (PREDICT_TRUE (if_add_index0 != ~0))
 531             {
 532               ip_interface_address_t *if_add =
 533                 pool_elt_at_index (lm->if_address_pool, if_add_index0);
 534               ip4_address_t *if_ip =
 535                 ip_interface_address_get_address (lm, if_add);
 536               out_ip0->src_address = *if_ip;
 537             }
 538           else
 539             {
 540               /* interface has no IP4 address - should not happen */
 541               next0 = IP4_ICMP_ERROR_NEXT_DROP;
 542               error0 = ICMP4_ERROR_DROP;
 543             }
 544           out_ip0->checksum = ip4_header_checksum (out_ip0);
 545
 546           /* Fill icmp header fields */
 547           icmp0->type = vnet_buffer (p0)->ip.icmp.type;
 548           icmp0->code = vnet_buffer (p0)->ip.icmp.code;
 549           *((u32 *) (icmp0 + 1)) =
 550             clib_host_to_net_u32 (vnet_buffer (p0)->ip.icmp.data);
 551           icmp0->checksum = 0;
 552           sum =
 553             ip_incremental_checksum (0, icmp0,
 554                                      p0->current_length -
 555                                      sizeof (ip4_header_t));
 556           icmp0->checksum = ~ip_csum_fold (sum);
 557
 558           /* Update error status */
 559           if (error0 == ICMP4_ERROR_NONE)
 560             error0 = icmp4_icmp_type_to_error (icmp0->type);
 561
 562           vlib_error_count (vm, node->node_index, error0, 1);
 563
 564           /* Verify speculative enqueue, maybe switch current next frame */
 565           vlib_validate_buffer_enqueue_x1 (vm, node, next_index,
 566                                            to_next, n_left_to_next,
 567                                            pi0, next0);
 568         }
 569       vlib_put_next_frame (vm, node, next_index, n_left_to_next);
 570     }
 571
 572   /*
 573    * push the original buffers to error-drop, so that
 574    * they can get the error counters handled, then freed
 575    */
 576   vlib_buffer_enqueue_to_single_next (vm, node,
 577                                       vlib_frame_vector_args (frame),
 578                                       IP4_ICMP_ERROR_NEXT_DROP,
 579                                       frame->n_vectors);
 580
 581   return frame->n_vectors;
 582 }
 583
 584 /* *INDENT-OFF* */
 585 VLIB_REGISTER_NODE (ip4_icmp_error_node) = {
 586   .function = ip4_icmp_error,
 587   .name = "ip4-icmp-error",
 588   .vector_size = sizeof (u32),
 589
 590   .n_errors = ARRAY_LEN (icmp_error_strings),
 591   .error_strings = icmp_error_strings,
 592
 593   .n_next_nodes = IP4_ICMP_ERROR_N_NEXT,
 594   .next_nodes = {
 595     [IP4_ICMP_ERROR_NEXT_DROP] = "ip4-drop",
 596     [IP4_ICMP_ERROR_NEXT_LOOKUP] = "ip4-lookup",
 597   },
 598
 599   .format_trace = format_icmp_input_trace,
 600 };
 601 /* *INDENT-ON* */
 602
 603
 604 static uword
 605 unformat_icmp_type_and_code (unformat_input_t * input, va_list * args)
 606 {
 607   icmp46_header_t *h = va_arg (*args, icmp46_header_t *);
 608   icmp4_main_t *cm = &icmp4_main;
 609   u32 i;
 610
 611   if (unformat_user (input, unformat_vlib_number_by_name,
 612                      cm->type_and_code_by_name, &i))
 613     {
 614       h->type = (i >> 8) & 0xff;
 615       h->code = (i >> 0) & 0xff;
 616     }
 617   else if (unformat_user (input, unformat_vlib_number_by_name,
 618                           cm->type_by_name, &i))
 619     {
 620       h->type = i;
 621       h->code = 0;
 622     }
 623   else
 624     return 0;
 625
 626   return 1;
 627 }
 628
 629 static void
 630 icmp4_pg_edit_function (pg_main_t * pg,
 631                         pg_stream_t * s,
 632                         pg_edit_group_t * g, u32 * packets, u32 n_packets)
 633 {
 634   vlib_main_t *vm = vlib_get_main ();
 635   u32 ip_offset, icmp_offset;
 636
 637   icmp_offset = g->start_byte_offset;
 638   ip_offset = (g - 1)->start_byte_offset;
 639
 640   while (n_packets >= 1)
 641     {
 642       vlib_buffer_t *p0;
 643       ip4_header_t *ip0;
 644       icmp46_header_t *icmp0;
 645       u32 len0;
 646
 647       p0 = vlib_get_buffer (vm, packets[0]);
 648       n_packets -= 1;
 649       packets += 1;
 650
 651       ASSERT (p0->current_data == 0);
 652       ip0 = (void *) (p0->data + ip_offset);
 653       icmp0 = (void *) (p0->data + icmp_offset);
 654
 655       /* if IP length has been specified, then calculate the length based on buffer */
 656       if (ip0->length == 0)
 657         len0 = vlib_buffer_length_in_chain (vm, p0) - icmp_offset;
 658       else
 659         len0 = clib_net_to_host_u16 (ip0->length) - icmp_offset;
 660
 661       icmp0->checksum =
 662         ~ip_csum_fold (ip_incremental_checksum (0, icmp0, len0));
 663     }
 664 }
 665
 666 typedef struct
 667 {
 668   pg_edit_t type, code;
 669   pg_edit_t checksum;
 670 } pg_icmp46_header_t;
 671
 672 always_inline void
 673 pg_icmp_header_init (pg_icmp46_header_t * p)
 674 {
 675   /* Initialize fields that are not bit fields in the IP header. */
 676 #define _(f) pg_edit_init (&p->f, icmp46_header_t, f);
 677   _(type);
 678   _(code);
 679   _(checksum);
 680 #undef _
 681 }
 682
 683 static uword
 684 unformat_pg_icmp_header (unformat_input_t * input, va_list * args)
 685 {
 686   pg_stream_t *s = va_arg (*args, pg_stream_t *);
 687   pg_icmp46_header_t *p;
 688   u32 group_index;
 689
 690   p = pg_create_edit_group (s, sizeof (p[0]), sizeof (icmp46_header_t),
 691                             &group_index);
 692   pg_icmp_header_init (p);
 693
 694   p->checksum.type = PG_EDIT_UNSPECIFIED;
 695
 696   {
 697     icmp46_header_t tmp;
 698
 699     if (!unformat (input, "ICMP %U", unformat_icmp_type_and_code, &tmp))
 700       goto error;
 701
 702     pg_edit_set_fixed (&p->type, tmp.type);
 703     pg_edit_set_fixed (&p->code, tmp.code);
 704   }
 705
 706   /* Parse options. */
 707   while (1)
 708     {
 709       if (unformat (input, "checksum %U",
 710                     unformat_pg_edit, unformat_pg_number, &p->checksum))
 711         ;
 712
 713       /* Can't parse input: try next protocol level. */
 714       else
 715         break;
 716     }
 717
 718   if (!unformat_user (input, unformat_pg_payload, s))
 719     goto error;
 720
 721   if (p->checksum.type == PG_EDIT_UNSPECIFIED)
 722     {
 723       pg_edit_group_t *g = pg_stream_get_group (s, group_index);
 724       g->edit_function = icmp4_pg_edit_function;
 725       g->edit_function_opaque = 0;
 726     }
 727
 728   return 1;
 729
 730 error:
 731   /* Free up any edits we may have added. */
 732   pg_free_edit_group (s);
 733   return 0;
 734 }
 735
 736 void
 737 ip4_icmp_register_type (vlib_main_t * vm, icmp4_type_t type, u32 node_index)
 738 {
 739   icmp4_main_t *im = &icmp4_main;
 740   u32 old_next_index;
 741
 742   ASSERT ((int) type < ARRAY_LEN (im->ip4_input_next_index_by_type));
 743   old_next_index = im->ip4_input_next_index_by_type[type];
 744
 745   im->ip4_input_next_index_by_type[type]
 746     = vlib_node_add_next (vm, ip4_icmp_input_node.index, node_index);
 747
 748   if (old_next_index &&
 749       (old_next_index != im->ip4_input_next_index_by_type[type]))
 750     clib_warning ("WARNING: changed next_by_type[%d]", (int) type);
 751 }
 752
 753 static clib_error_t *
 754 icmp4_init (vlib_main_t * vm)
 755 {
 756   ip_main_t *im = &ip_main;
 757   ip_protocol_info_t *pi;
 758   icmp4_main_t *cm = &icmp4_main;
 759   clib_error_t *error;
 760
 761   error = vlib_call_init_function (vm, ip_main_init);
 762
 763   if (error)
 764     return error;
 765
 766   pi = ip_get_protocol_info (im, IP_PROTOCOL_ICMP);
 767   pi->format_header = format_ip4_icmp_header;
 768   pi->unformat_pg_edit = unformat_pg_icmp_header;
 769
 770   cm->type_by_name = hash_create_string (0, sizeof (uword));
 771 #define _(n,t) hash_set_mem (cm->type_by_name, #t, (n));
 772   foreach_icmp4_type;
 773 #undef _
 774
 775   cm->type_and_code_by_name = hash_create_string (0, sizeof (uword));
 776 #define _(a,n,t) hash_set_mem (cm->type_by_name, #t, (n) | (ICMP4_##a << 8));
 777   foreach_icmp4_code;
 778 #undef _
 779
 780   clib_memset (cm->ip4_input_next_index_by_type,
 781                ICMP_INPUT_NEXT_ERROR,
 782                sizeof (cm->ip4_input_next_index_by_type));
 783
 784   ip4_icmp_register_type (vm, ICMP4_echo_request,
 785                           ip4_icmp_echo_request_node.index);
 786
 787   return 0;
 788 }
 789
 790 VLIB_INIT_FUNCTION (icmp4_init);
 791
 792 /*
 793  * fd.io coding-style-patch-verification: ON
 794  *
 795  * Local Variables:
 796  * eval: (c-set-style "gnu")
 797  * End:
 798  */