vnet/vnet/ip/ip6_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  * ip6/packet.h: ip6 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_ip6_packet_h
  41 #define included_ip6_packet_h
  42
  43 #include <vnet/ip/tcp_packet.h>
  44 #include <vnet/ip/ip4_packet.h>
  45
  46 typedef union {
  47   u8 as_u8[16];
  48   u16 as_u16[8];
  49   u32 as_u32[4];
  50   u64 as_u64[2];
  51   uword as_uword[16 / sizeof (uword)];
  52 } ip6_address_t;
  53
  54 /* Packed so that the mhash key doesn't include uninitialized pad bytes */
  55 typedef CLIB_PACKED (struct {
  56   /* IP address must be first for ip_interface_address_get_address() to work */
  57   ip6_address_t ip6_addr;
  58   u32 fib_index;
  59 }) ip6_address_fib_t;
  60
  61 typedef CLIB_PACKED (union {
  62   struct {
  63     u32 pad[3];
  64     ip4_address_t ip4;
  65   };
  66   ip6_address_t ip6;
  67   u64 as_u64[2];
  68 }) ip46_address_t;
  69 #define ip46_address_is_ip4(ip46)       (((ip46)->pad[0] | (ip46)->pad[1] | (ip46)->pad[2]) == 0)
  70 #define ip46_address_mask_ip4(ip46)     ((ip46)->pad[0] = (ip46)->pad[1] = (ip46)->pad[2] = 0)
  71 #define ip46_address_set_ip4(ip46, ip)  (ip46_address_mask_ip4(ip46), (ip46)->ip4 = (ip)[0])
  72 #define ip46_address_reset(ip46)        ((ip46)->as_u64[0] = (ip46)->as_u64[1] = 0)
  73
  74 always_inline void
  75 ip6_addr_fib_init (ip6_address_fib_t * addr_fib, ip6_address_t * address,
  76                    u32 fib_index)
  77 {
  78   addr_fib->ip6_addr.as_u64[0] = address->as_u64[0];
  79   addr_fib->ip6_addr.as_u64[1] = address->as_u64[1];
  80   addr_fib->fib_index = fib_index;
  81 }
  82
  83 /* Special addresses:
  84    unspecified          ::/128
  85    loopback             ::1/128
  86    global unicast       2000::/3
  87    unique local unicast fc00::/7
  88    link local unicast   fe80::/10
  89    multicast            ff00::/8
  90    ietf reserved        everything else. */
  91
  92 #define foreach_ip6_multicast_address_scope     \
  93   _ (loopback, 0x1)                             \
  94   _ (link_local, 0x2)                           \
  95   _ (admin_local, 0x4)                          \
  96   _ (site_local, 0x5)                           \
  97   _ (organization_local, 0x8)                   \
  98   _ (global, 0xe)
  99
 100 #define foreach_ip6_multicast_link_local_group_id       \
 101   _ (all_hosts, 0x1)                                    \
 102   _ (all_routers, 0x2)                                  \
 103   _ (rip_routers, 0x9)                                  \
 104   _ (eigrp_routers, 0xa)                                \
 105   _ (pim_routers, 0xd)                            \
 106  _ (mldv2_routers, 0x16)
 107
 108 typedef enum {
 109 #define _(f,n) IP6_MULTICAST_SCOPE_##f = n,
 110   foreach_ip6_multicast_address_scope
 111 #undef _
 112 } ip6_multicast_address_scope_t;
 113
 114 typedef enum {
 115 #define _(f,n) IP6_MULTICAST_GROUP_ID_##f = n,
 116   foreach_ip6_multicast_link_local_group_id
 117 #undef _
 118 } ip6_multicast_link_local_group_id_t;
 119
 120 always_inline uword
 121 ip6_address_is_multicast (ip6_address_t * a)
 122 { return a->as_u8[0] == 0xff; }
 123
 124 always_inline void
 125 ip6_set_reserved_multicast_address (ip6_address_t * a,
 126                                     ip6_multicast_address_scope_t scope,
 127                                     u16 id)
 128 {
 129   a->as_u64[0] = a->as_u64[1] = 0;
 130   a->as_u16[0] = clib_host_to_net_u16 (0xff00 | scope);
 131   a->as_u16[7] = clib_host_to_net_u16 (id);
 132 }
 133
 134 always_inline void
 135 ip6_set_solicited_node_multicast_address (ip6_address_t * a, u32 id)
 136 {
 137   /* 0xff02::1:ffXX:XXXX. */
 138   a->as_u64[0] = a->as_u64[1] = 0;
 139   a->as_u16[0] = clib_host_to_net_u16 (0xff02);
 140   a->as_u8[11] = 1;
 141   ASSERT ((id >> 24) == 0);
 142   id |= 0xff << 24;
 143   a->as_u32[3] = clib_host_to_net_u32 (id);
 144 }
 145
 146 always_inline void
 147 ip6_link_local_address_from_ethernet_address (ip6_address_t * a, u8 * ethernet_address)
 148 {
 149   a->as_u64[0] = a->as_u64[1] = 0;
 150   a->as_u16[0] = clib_host_to_net_u16 (0xfe80);
 151   /* Always set locally administered bit (6). */
 152   a->as_u8[0x8] = ethernet_address[0] | (1 << 6);
 153   a->as_u8[0x9] = ethernet_address[1];
 154   a->as_u8[0xa] = ethernet_address[2];
 155   a->as_u8[0xb] = 0xff;
 156   a->as_u8[0xc] = 0xfe;
 157   a->as_u8[0xd] = ethernet_address[3];
 158   a->as_u8[0xe] = ethernet_address[4];
 159   a->as_u8[0xf] = ethernet_address[5];
 160 }
 161
 162 always_inline void
 163 ip6_multicast_ethernet_address (u8 * ethernet_address, u32 group_id)
 164 {
 165   ethernet_address[0] = 0x33;
 166   ethernet_address[1] = 0x33;
 167   ethernet_address[2] = ((group_id >> 24) & 0xff);
 168   ethernet_address[3] = ((group_id >> 16) & 0xff);
 169   ethernet_address[4] = ((group_id >>  8) & 0xff);
 170   ethernet_address[5] = ((group_id >>  0) & 0xff);
 171 }
 172
 173 always_inline uword
 174 ip6_address_is_equal (ip6_address_t * a, ip6_address_t * b)
 175 {
 176   int i;
 177   for (i = 0; i < ARRAY_LEN (a->as_uword); i++)
 178     if (a->as_uword[i] != b->as_uword[i])
 179       return 0;
 180   return 1;
 181 }
 182
 183 always_inline uword
 184 ip6_address_is_equal_masked (ip6_address_t * a, ip6_address_t * b,
 185                              ip6_address_t * mask)
 186 {
 187   int i;
 188   for (i = 0; i < ARRAY_LEN (a->as_uword); i++)
 189     {
 190       uword a_masked, b_masked;
 191       a_masked = a->as_uword[i] & mask->as_uword[i];
 192       b_masked = b->as_uword[i] & mask->as_uword[i];
 193
 194       if (a_masked != b_masked)
 195         return 0;
 196     }
 197   return 1;
 198 }
 199
 200 always_inline void
 201 ip6_address_mask (ip6_address_t * a, ip6_address_t * mask)
 202 {
 203   int i;
 204   for (i = 0; i < ARRAY_LEN (a->as_uword); i++)
 205     a->as_uword[i] &= mask->as_uword[i];
 206 }
 207
 208 always_inline void
 209 ip6_address_set_zero (ip6_address_t * a)
 210 {
 211   int i;
 212   for (i = 0; i < ARRAY_LEN (a->as_uword); i++)
 213     a->as_uword[i] = 0;
 214 }
 215
 216 always_inline void
 217 ip6_address_mask_from_width (ip6_address_t * a, u32 width)
 218 {
 219   int i, byte, bit, bitnum;
 220   ASSERT (width <= 128);
 221   memset (a, 0, sizeof (a[0]));
 222   for (i = 0; i < width; i++)
 223     {
 224       bitnum = (7 - (i & 7));
 225       byte = i / 8;
 226       bit = 1<<bitnum;
 227       a->as_u8[byte] |= bit;
 228     }
 229 }
 230
 231 always_inline uword
 232 ip6_address_is_zero (ip6_address_t * a)
 233 {
 234   int i;
 235   for (i = 0; i < ARRAY_LEN (a->as_uword); i++)
 236     if (a->as_uword[i] != 0)
 237       return 0;
 238   return 1;
 239 }
 240
 241 /* Check for unspecified address ::0 */
 242 always_inline uword
 243 ip6_address_is_unspecified (ip6_address_t * a)
 244 { return ip6_address_is_zero (a); }
 245
 246 /* Check for loopback address ::1 */
 247 always_inline uword
 248 ip6_address_is_loopback (ip6_address_t * a)
 249 {
 250   uword is_loopback;
 251   u8 save = a->as_u8[15];
 252   a->as_u8[15] = save ^ 1;
 253   is_loopback = ip6_address_is_zero (a);
 254   a->as_u8[15] = save;
 255   return is_loopback;
 256 }
 257
 258 /* Check for link local unicast fe80::/10. */
 259 always_inline uword
 260 ip6_address_is_link_local_unicast (ip6_address_t * a)
 261 { return a->as_u8[0] == 0xfe && (a->as_u8[1] & 0xc0) == 0x80; }
 262
 263 /* Check for unique local unicast fc00::/7. */
 264 always_inline uword
 265 ip6_address_is_local_unicast (ip6_address_t * a)
 266 { return (a->as_u8[0] & 0xfe) == 0xfc; }
 267
 268 /* Check for unique global unicast 2000::/3. */
 269 always_inline uword
 270 ip6_address_is_global_unicast (ip6_address_t * a)
 271 { return (a->as_u8[0] & 0xe0) == 0x20; }
 272
 273 /* Check for solicited node multicast 0xff02::1:ff00:0/104 */
 274 always_inline uword
 275 ip6_is_solicited_node_multicast_address (ip6_address_t * a)
 276 {
 277   return (a->as_u32[0] == clib_host_to_net_u32 (0xff020000)
 278           && a->as_u32[1] == 0
 279           && a->as_u32[2] == clib_host_to_net_u32 (1)
 280           && a->as_u8[12] == 0xff);
 281 }
 282
 283 typedef struct {
 284   /* 4 bit version, 8 bit traffic class and 20 bit flow label. */
 285   u32 ip_version_traffic_class_and_flow_label;
 286
 287   /* Total packet length not including this header (but including
 288      any extension headers if present). */
 289   u16 payload_length;
 290
 291   /* Protocol for next header. */
 292   u8 protocol;
 293
 294   /* Hop limit decremented by router at each hop. */
 295   u8 hop_limit;
 296
 297   /* Source and destination address. */
 298   ip6_address_t src_address, dst_address;
 299 } ip6_header_t;
 300
 301 always_inline void *
 302 ip6_next_header (ip6_header_t * i)
 303 { return (void *) (i + 1); }
 304
 305 always_inline void
 306 ip6_tcp_reply_x1 (ip6_header_t * ip0, tcp_header_t * tcp0)
 307 {
 308   {
 309     ip6_address_t src0, dst0;
 310
 311     src0 = ip0->src_address;
 312     dst0 = ip0->dst_address;
 313     ip0->src_address = dst0;
 314     ip0->dst_address = src0;
 315   }
 316
 317   {
 318     u16 src0, dst0;
 319
 320     src0 = tcp0->ports.src;
 321     dst0 = tcp0->ports.dst;
 322     tcp0->ports.src = dst0;
 323     tcp0->ports.dst = src0;
 324   }
 325 }
 326
 327 always_inline void
 328 ip6_tcp_reply_x2 (ip6_header_t * ip0, ip6_header_t * ip1,
 329                   tcp_header_t * tcp0, tcp_header_t * tcp1)
 330 {
 331   {
 332     ip6_address_t src0, dst0, src1, dst1;
 333
 334     src0 = ip0->src_address;
 335     src1 = ip1->src_address;
 336     dst0 = ip0->dst_address;
 337     dst1 = ip1->dst_address;
 338     ip0->src_address = dst0;
 339     ip1->src_address = dst1;
 340     ip0->dst_address = src0;
 341     ip1->dst_address = src1;
 342   }
 343
 344   {
 345     u16 src0, dst0, src1, dst1;
 346
 347     src0 = tcp0->ports.src;
 348     src1 = tcp1->ports.src;
 349     dst0 = tcp0->ports.dst;
 350     dst1 = tcp1->ports.dst;
 351     tcp0->ports.src = dst0;
 352     tcp1->ports.src = dst1;
 353     tcp0->ports.dst = src0;
 354     tcp1->ports.dst = src1;
 355   }
 356 }
 357
 358
 359 typedef CLIB_PACKED (struct {
 360   u8 data;
 361 }) ip6_pad1_option_t;
 362
 363 typedef CLIB_PACKED (struct {
 364   u8 type;
 365   u8 len;
 366   u8 data[0];
 367 }) ip6_padN_option_t;
 368
 369 typedef CLIB_PACKED (struct {
 370 #define IP6_MLDP_ALERT_TYPE  0x5
 371   u8 type;
 372   u8 len;
 373   u16 value;
 374 }) ip6_router_alert_option_t;
 375
 376 typedef CLIB_PACKED (struct {
 377   u8 next_hdr;
 378   /* Length of this header plus option data in 8 byte units. */
 379   u8 n_data_u64s;
 380   u8 data[0];
 381 }) ip6_hop_by_hop_ext_t;
 382
 383 typedef CLIB_PACKED (struct {
 384   u8 next_hdr;
 385   u8 rsv;
 386   u16 fragment_offset_and_more;
 387   u32 identification;
 388 }) ip6_frag_hdr_t;
 389
 390 #define ip6_frag_hdr_offset(hdr) \
 391   (clib_net_to_host_u16((hdr)->fragment_offset_and_more) >> 3)
 392
 393 #define ip6_frag_hdr_more(hdr) \
 394   (clib_net_to_host_u16((hdr)->fragment_offset_and_more) & 0x1)
 395
 396 #define ip6_frag_hdr_offset_and_more(offset, more) \
 397   clib_host_to_net_u16(((offset) << 3) + !!(more))
 398
 399 #endif /* included_ip6_packet_h */