src/vnet/ip/ip4_packet.h

   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  * ip4/packet.h: ip4 packet format
  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 #ifndef included_ip4_packet_h
  41 #define included_ip4_packet_h
  42
  43 #include <vnet/ip/ip_packet.h>  /* for ip_csum_t */
  44 #include <vnet/tcp/tcp_packet.h>        /* for tcp_header_t */
  45 #include <vppinfra/byte_order.h>        /* for clib_net_to_host_u16 */
  46
  47 /* IP4 address which can be accessed either as 4 bytes
  48    or as a 32-bit number. */
  49 typedef union
  50 {
  51   u8 data[4];
  52   u32 data_u32;
  53   /* Aliases. */
  54   u8 as_u8[4];
  55   u16 as_u16[2];
  56   u32 as_u32;
  57 } ip4_address_t;
  58
  59 typedef struct
  60 {
  61   /* IP address must be first for ip_interface_address_get_address() to work */
  62   ip4_address_t ip4_addr;
  63   u32 fib_index;
  64 } ip4_address_fib_t;
  65
  66 always_inline void
  67 ip4_addr_fib_init (ip4_address_fib_t * addr_fib,
  68                    const ip4_address_t * address, u32 fib_index)
  69 {
  70   clib_memcpy_fast (&addr_fib->ip4_addr, address,
  71                     sizeof (addr_fib->ip4_addr));
  72   addr_fib->fib_index = fib_index;
  73 }
  74
  75 /* (src,dst) pair of addresses as found in packet header. */
  76 typedef struct
  77 {
  78   ip4_address_t src, dst;
  79 } ip4_address_pair_t;
  80
  81 typedef struct
  82 {
  83   ip4_address_t addr, mask;
  84 } ip4_address_and_mask_t;
  85
  86 typedef union
  87 {
  88   struct
  89   {
  90     /* 4 bit packet length (in 32bit units) and version VVVVLLLL.
  91        e.g. for packets w/ no options ip_version_and_header_length == 0x45. */
  92     u8 ip_version_and_header_length;
  93
  94     /* Type of service. */
  95     ip_dscp_t tos;
  96
  97     /* Total layer 3 packet length including this header. */
  98     u16 length;
  99
 100     /* Fragmentation ID. */
 101     u16 fragment_id;
 102
 103     /* 3 bits of flags and 13 bits of fragment offset (in units
 104        of 8 byte quantities). */
 105     u16 flags_and_fragment_offset;
 106 #define IP4_HEADER_FLAG_MORE_FRAGMENTS (1 << 13)
 107 #define IP4_HEADER_FLAG_DONT_FRAGMENT (1 << 14)
 108 #define IP4_HEADER_FLAG_CONGESTION (1 << 15)
 109
 110     /* Time to live decremented by router at each hop. */
 111     u8 ttl;
 112
 113     /* Next level protocol packet. */
 114     u8 protocol;
 115
 116     /* Checksum. */
 117     u16 checksum;
 118
 119     /* Source and destination address. */
 120     union
 121     {
 122       struct
 123       {
 124         ip4_address_t src_address, dst_address;
 125       };
 126       ip4_address_pair_t address_pair;
 127     };
 128   };
 129
 130   /* For checksumming we'll want to access IP header in word sized chunks. */
 131   /* For 64 bit machines. */
 132   /* *INDENT-OFF* */
 133   CLIB_PACKED (struct {
 134     u64 checksum_data_64[2];
 135     u32 checksum_data_64_32[1];
 136   });
 137   /* *INDENT-ON* */
 138
 139   /* For 32 bit machines. */
 140   /* *INDENT-OFF* */
 141   CLIB_PACKED (struct {
 142     u32 checksum_data_32[5];
 143   });
 144   /* *INDENT-ON* */
 145 } ip4_header_t;
 146
 147 /* Value of ip_version_and_header_length for packets w/o options. */
 148 #define IP4_VERSION_AND_HEADER_LENGTH_NO_OPTIONS \
 149   ((4 << 4) | (sizeof (ip4_header_t) / sizeof (u32)))
 150
 151 #define IP4_ROUTER_ALERT_OPTION 20
 152
 153 always_inline u16
 154 ip4_get_fragment_offset (const ip4_header_t * i)
 155 {
 156   return clib_net_to_host_u16 (i->flags_and_fragment_offset) & 0x1fff;
 157 }
 158
 159 always_inline u16
 160 ip4_get_fragment_more (const ip4_header_t * i)
 161 {
 162   return clib_net_to_host_u16 (i->flags_and_fragment_offset) &
 163     IP4_HEADER_FLAG_MORE_FRAGMENTS;
 164 }
 165
 166 always_inline int
 167 ip4_is_fragment (const ip4_header_t * i)
 168 {
 169   return (i->flags_and_fragment_offset &
 170           clib_net_to_host_u16 (0x1fff | IP4_HEADER_FLAG_MORE_FRAGMENTS));
 171 }
 172
 173 always_inline int
 174 ip4_is_first_fragment (const ip4_header_t * i)
 175 {
 176   return (i->flags_and_fragment_offset &
 177           clib_net_to_host_u16 (0x1fff | IP4_HEADER_FLAG_MORE_FRAGMENTS)) ==
 178     clib_net_to_host_u16 (IP4_HEADER_FLAG_MORE_FRAGMENTS);
 179 }
 180
 181 /* Fragment offset in bytes. */
 182 always_inline int
 183 ip4_get_fragment_offset_bytes (const ip4_header_t * i)
 184 {
 185   return 8 * ip4_get_fragment_offset (i);
 186 }
 187
 188 always_inline int
 189 ip4_header_bytes (const ip4_header_t * i)
 190 {
 191   return sizeof (u32) * (i->ip_version_and_header_length & 0xf);
 192 }
 193
 194 always_inline void *
 195 ip4_next_header (ip4_header_t * i)
 196 {
 197   return (void *) i + ip4_header_bytes (i);
 198 }
 199
 200 always_inline u16
 201 ip4_header_checksum (ip4_header_t * i)
 202 {
 203   int option_len = (i->ip_version_and_header_length & 0xf) - 5;
 204   uword sum = 0;
 205 #if uword_bits == 64
 206   u32 *iphdr = (u32 *) i;
 207
 208   sum += iphdr[0];
 209   sum += iphdr[1];
 210   sum += *(u16 *) (iphdr + 2);
 211   /* skip checksum */
 212   sum += iphdr[3];
 213   sum += iphdr[4];
 214
 215   if (PREDICT_FALSE (option_len > 0))
 216     switch (option_len)
 217       {
 218       case 10:
 219         sum += iphdr[14];
 220       case 9:
 221         sum += iphdr[13];
 222       case 8:
 223         sum += iphdr[12];
 224       case 7:
 225         sum += iphdr[11];
 226       case 6:
 227         sum += iphdr[10];
 228       case 5:
 229         sum += iphdr[9];
 230       case 4:
 231         sum += iphdr[8];
 232       case 3:
 233         sum += iphdr[7];
 234       case 2:
 235         sum += iphdr[6];
 236       case 1:
 237         sum += iphdr[5];
 238       default:
 239         break;
 240       }
 241
 242   sum = ((u32) sum) + (sum >> 32);
 243 #else
 244   u16 *iphdr = (u16 *) i;
 245
 246   sum += iphdr[0];
 247   sum += iphdr[1];
 248   sum += iphdr[2];
 249   sum += iphdr[3];
 250   sum += iphdr[4];
 251   /* skip checksum */
 252   sum += iphdr[6];
 253   sum += iphdr[7];
 254   sum += iphdr[8];
 255   sum += iphdr[9];
 256
 257   if (PREDICT_FALSE (option_len > 0))
 258     switch (option_len)
 259       {
 260       case 10:
 261         sum += iphdr[28];
 262         sum += iphdr[29];
 263       case 9:
 264         sum += iphdr[26];
 265         sum += iphdr[27];
 266       case 8:
 267         sum += iphdr[24];
 268         sum += iphdr[25];
 269       case 7:
 270         sum += iphdr[22];
 271         sum += iphdr[23];
 272       case 6:
 273         sum += iphdr[20];
 274         sum += iphdr[21];
 275       case 5:
 276         sum += iphdr[18];
 277         sum += iphdr[19];
 278       case 4:
 279         sum += iphdr[16];
 280         sum += iphdr[17];
 281       case 3:
 282         sum += iphdr[14];
 283         sum += iphdr[15];
 284       case 2:
 285         sum += iphdr[12];
 286         sum += iphdr[13];
 287       case 1:
 288         sum += iphdr[10];
 289         sum += iphdr[11];
 290       default:
 291         break;
 292       }
 293 #endif
 294
 295   sum = ((u16) sum) + (sum >> 16);
 296   sum = ((u16) sum) + (sum >> 16);
 297   return ~((u16) sum);
 298 }
 299
 300 always_inline void
 301 ip4_header_set_dscp (ip4_header_t * ip4, ip_dscp_t dscp)
 302 {
 303   ip4->tos &= ~0xfc;
 304   /* not masking the dscp value to save th instruction
 305    * it shouldn't b necessary since the argument is an enum
 306    * whose range is therefore constrained in the CP. in the
 307    * DP it will have been taken from another packet, so again
 308    * constrained in  value */
 309   ip4->tos |= dscp << IP_PACKET_TC_FIELD_DSCP_BIT_SHIFT;
 310 }
 311
 312 always_inline void
 313 ip4_header_set_ecn (ip4_header_t * ip4, ip_ecn_t ecn)
 314 {
 315   ip4->tos &= ~IP_PACKET_TC_FIELD_ECN_MASK;
 316   ip4->tos |= ecn;
 317 }
 318
 319 always_inline void
 320 ip4_header_set_ecn_w_chksum (ip4_header_t * ip4, ip_ecn_t ecn)
 321 {
 322   ip_csum_t sum = ip4->checksum;
 323   u8 old = ip4->tos;
 324   u8 new = (old & ~IP_PACKET_TC_FIELD_ECN_MASK) | ecn;
 325
 326   sum = ip_csum_update (sum, old, new, ip4_header_t, tos);
 327   ip4->checksum = ip_csum_fold (sum);
 328   ip4->tos = new;
 329 }
 330
 331 always_inline ip_dscp_t
 332 ip4_header_get_dscp (const ip4_header_t * ip4)
 333 {
 334   return (ip4->tos >> IP_PACKET_TC_FIELD_DSCP_BIT_SHIFT);
 335 }
 336
 337 always_inline ip_ecn_t
 338 ip4_header_get_ecn (const ip4_header_t * ip4)
 339 {
 340   return (ip4->tos & IP_PACKET_TC_FIELD_ECN_MASK);
 341 }
 342
 343 always_inline void
 344 ip4_header_set_df (ip4_header_t * ip4)
 345 {
 346   ip4->flags_and_fragment_offset |=
 347     clib_host_to_net_u16 (IP4_HEADER_FLAG_DONT_FRAGMENT);
 348 }
 349
 350 always_inline void
 351 ip4_header_clear_df (ip4_header_t * ip4)
 352 {
 353   ip4->flags_and_fragment_offset &=
 354     ~clib_host_to_net_u16 (IP4_HEADER_FLAG_DONT_FRAGMENT);
 355 }
 356
 357 always_inline u8
 358 ip4_header_get_df (const ip4_header_t * ip4)
 359 {
 360   return (! !(ip4->flags_and_fragment_offset &
 361               clib_host_to_net_u16 (IP4_HEADER_FLAG_DONT_FRAGMENT)));
 362 }
 363
 364 static inline uword
 365 ip4_header_checksum_is_valid (ip4_header_t * i)
 366 {
 367   return i->checksum == ip4_header_checksum (i);
 368 }
 369
 370 #define ip4_partial_header_checksum_x1(ip0,sum0)                        \
 371 do {                                                                    \
 372   if (BITS (ip_csum_t) > 32)                                            \
 373     {                                                                   \
 374       sum0 = ip0->checksum_data_64[0];                                  \
 375       sum0 = ip_csum_with_carry (sum0, ip0->checksum_data_64[1]);       \
 376       sum0 = ip_csum_with_carry (sum0, ip0->checksum_data_64_32[0]);    \
 377     }                                                                   \
 378   else                                                                  \
 379     {                                                                   \
 380       sum0 = ip0->checksum_data_32[0];                                  \
 381       sum0 = ip_csum_with_carry (sum0, ip0->checksum_data_32[1]);       \
 382       sum0 = ip_csum_with_carry (sum0, ip0->checksum_data_32[2]);       \
 383       sum0 = ip_csum_with_carry (sum0, ip0->checksum_data_32[3]);       \
 384       sum0 = ip_csum_with_carry (sum0, ip0->checksum_data_32[4]);       \
 385     }                                                                   \
 386 } while (0)
 387
 388 #define ip4_partial_header_checksum_x2(ip0,ip1,sum0,sum1)               \
 389 do {                                                                    \
 390   if (BITS (ip_csum_t) > 32)                                            \
 391     {                                                                   \
 392       sum0 = ip0->checksum_data_64[0];                                  \
 393       sum1 = ip1->checksum_data_64[0];                                  \
 394       sum0 = ip_csum_with_carry (sum0, ip0->checksum_data_64[1]);       \
 395       sum1 = ip_csum_with_carry (sum1, ip1->checksum_data_64[1]);       \
 396       sum0 = ip_csum_with_carry (sum0, ip0->checksum_data_64_32[0]);    \
 397       sum1 = ip_csum_with_carry (sum1, ip1->checksum_data_64_32[0]);    \
 398     }                                                                   \
 399   else                                                                  \
 400     {                                                                   \
 401       sum0 = ip0->checksum_data_32[0];                                  \
 402       sum1 = ip1->checksum_data_32[0];                                  \
 403       sum0 = ip_csum_with_carry (sum0, ip0->checksum_data_32[1]);       \
 404       sum1 = ip_csum_with_carry (sum1, ip1->checksum_data_32[1]);       \
 405       sum0 = ip_csum_with_carry (sum0, ip0->checksum_data_32[2]);       \
 406       sum1 = ip_csum_with_carry (sum1, ip1->checksum_data_32[2]);       \
 407       sum0 = ip_csum_with_carry (sum0, ip0->checksum_data_32[3]);       \
 408       sum1 = ip_csum_with_carry (sum1, ip1->checksum_data_32[3]);       \
 409       sum0 = ip_csum_with_carry (sum0, ip0->checksum_data_32[4]);       \
 410       sum1 = ip_csum_with_carry (sum1, ip1->checksum_data_32[4]);       \
 411     }                                                                   \
 412 } while (0)
 413
 414 always_inline uword
 415 ip4_address_is_multicast (const ip4_address_t * a)
 416 {
 417   return (a->data[0] & 0xf0) == 0xe0;
 418 }
 419
 420 always_inline uword
 421 ip4_address_is_global_broadcast (const ip4_address_t * a)
 422 {
 423   return (a->as_u32) == 0xffffffff;
 424 }
 425
 426 always_inline void
 427 ip4_multicast_address_set_for_group (ip4_address_t * a,
 428                                      ip_multicast_group_t g)
 429 {
 430   ASSERT ((u32) g < (1 << 28));
 431   a->as_u32 = clib_host_to_net_u32 ((0xe << 28) + g);
 432 }
 433
 434 always_inline void
 435 ip4_multicast_ethernet_address (u8 * ethernet_address,
 436                                 const ip4_address_t * a)
 437 {
 438   const u8 *d = a->as_u8;
 439
 440   ethernet_address[0] = 0x01;
 441   ethernet_address[1] = 0x00;
 442   ethernet_address[2] = 0x5e;
 443   ethernet_address[3] = d[1] & 0x7f;
 444   ethernet_address[4] = d[2];
 445   ethernet_address[5] = d[3];
 446 }
 447
 448 always_inline void
 449 ip4_tcp_reply_x1 (ip4_header_t * ip0, tcp_header_t * tcp0)
 450 {
 451   u32 src0, dst0;
 452
 453   src0 = ip0->src_address.data_u32;
 454   dst0 = ip0->dst_address.data_u32;
 455   ip0->src_address.data_u32 = dst0;
 456   ip0->dst_address.data_u32 = src0;
 457
 458   src0 = tcp0->src;
 459   dst0 = tcp0->dst;
 460   tcp0->src = dst0;
 461   tcp0->dst = src0;
 462 }
 463
 464 always_inline void
 465 ip4_tcp_reply_x2 (ip4_header_t * ip0, ip4_header_t * ip1,
 466                   tcp_header_t * tcp0, tcp_header_t * tcp1)
 467 {
 468   u32 src0, dst0, src1, dst1;
 469
 470   src0 = ip0->src_address.data_u32;
 471   src1 = ip1->src_address.data_u32;
 472   dst0 = ip0->dst_address.data_u32;
 473   dst1 = ip1->dst_address.data_u32;
 474   ip0->src_address.data_u32 = dst0;
 475   ip1->src_address.data_u32 = dst1;
 476   ip0->dst_address.data_u32 = src0;
 477   ip1->dst_address.data_u32 = src1;
 478
 479   src0 = tcp0->src;
 480   src1 = tcp1->src;
 481   dst0 = tcp0->dst;
 482   dst1 = tcp1->dst;
 483   tcp0->src = dst0;
 484   tcp1->src = dst1;
 485   tcp0->dst = src0;
 486   tcp1->dst = src1;
 487 }
 488
 489 #endif /* included_ip4_packet_h */
 490
 491 /*
 492  * fd.io coding-style-patch-verification: ON
 493  *
 494  * Local Variables:
 495  * eval: (c-set-style "gnu")
 496  * End:
 497  */