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