src/vnet/ip/ip6_inlines.h

   1 /*
   2  * Copyright (c) 2016 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/ip6.h: ip6 main include file
  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_ip_ip6_inlines_h
  41 #define included_ip_ip6_inlines_h
  42
  43 #include <vnet/ip/ip6_packet.h>
  44 #include <vnet/ip/ip6_hop_by_hop_packet.h>
  45
  46 /* Compute flow hash.  We'll use it to select which Sponge to use for this
  47    flow.  And other things. */
  48 always_inline u32
  49 ip6_compute_flow_hash (const ip6_header_t * ip,
  50                        flow_hash_config_t flow_hash_config)
  51 {
  52   tcp_header_t *tcp;
  53   udp_header_t *udp = (void *) (ip + 1);
  54   gtpv1u_header_t *gtpu = (void *) (udp + 1);
  55   u64 a, b, c;
  56   u64 t1, t2;
  57   u32 t3;
  58   uword is_tcp_udp = 0;
  59   uword is_udp = ip->protocol == IP_PROTOCOL_UDP;
  60   u8 protocol = ip->protocol;
  61
  62   if (PREDICT_TRUE ((ip->protocol == IP_PROTOCOL_TCP) || is_udp))
  63     {
  64       is_tcp_udp = 1;
  65       tcp = (void *) (ip + 1);
  66     }
  67   else if (ip->protocol == IP_PROTOCOL_IP6_HOP_BY_HOP_OPTIONS)
  68     {
  69       ip6_hop_by_hop_header_t *hbh = (ip6_hop_by_hop_header_t *) (ip + 1);
  70       if ((hbh->protocol == IP_PROTOCOL_TCP) ||
  71           (hbh->protocol == IP_PROTOCOL_UDP))
  72         {
  73           is_tcp_udp = 1;
  74           tcp = (tcp_header_t *) ((u8 *) hbh + ((hbh->length + 1) << 3));
  75         }
  76       protocol = hbh->protocol;
  77     }
  78
  79   t1 = (ip->src_address.as_u64[0] ^ ip->src_address.as_u64[1]);
  80   t1 = (flow_hash_config & IP_FLOW_HASH_SRC_ADDR) ? t1 : 0;
  81
  82   t2 = (ip->dst_address.as_u64[0] ^ ip->dst_address.as_u64[1]);
  83   t2 = (flow_hash_config & IP_FLOW_HASH_DST_ADDR) ? t2 : 0;
  84
  85   a = (flow_hash_config & IP_FLOW_HASH_REVERSE_SRC_DST) ? t2 : t1;
  86   b = (flow_hash_config & IP_FLOW_HASH_REVERSE_SRC_DST) ? t1 : t2;
  87
  88   t1 = is_tcp_udp ? tcp->src : 0;
  89   t2 = is_tcp_udp ? tcp->dst : 0;
  90
  91   t1 = (flow_hash_config & IP_FLOW_HASH_SRC_PORT) ? t1 : 0;
  92   t2 = (flow_hash_config & IP_FLOW_HASH_DST_PORT) ? t2 : 0;
  93
  94   if (flow_hash_config & IP_FLOW_HASH_SYMMETRIC)
  95     {
  96       if (b < a)
  97         {
  98           c = a;
  99           a = b;
 100           b = c;
 101         }
 102       if (t2 < t1)
 103         {
 104           t2 += t1;
 105           t1 = t2 - t1;
 106           t2 = t2 - t1;
 107         }
 108     }
 109
 110   b ^= (flow_hash_config & IP_FLOW_HASH_PROTO) ? protocol : 0;
 111   c = ((flow_hash_config & IP_FLOW_HASH_REVERSE_SRC_DST) ? ((t1 << 16) | t2) :
 112                                                            ((t2 << 16) | t1));
 113   t1 = ((u64) ip_flow_hash_router_id << 32);
 114   t1 |=
 115     ((flow_hash_config & IP_FLOW_HASH_FL) ? ip6_flow_label_network_order (ip) :
 116                                             0);
 117   c ^= t1;
 118   if (PREDICT_TRUE (is_udp) &&
 119       PREDICT_FALSE ((flow_hash_config & IP_FLOW_HASH_GTPV1_TEID) &&
 120                      udp->dst_port == GTPV1_PORT_BE))
 121     {
 122       t3 = gtpu->teid;
 123       a ^= t3;
 124     }
 125   hash_mix64 (a, b, c);
 126   return (u32) c;
 127 }
 128
 129 /* ip6_locate_header
 130  *
 131  * This function is to search for the header specified by the protocol number
 132  * in find_hdr_type.
 133  * This is used to locate a specific IPv6 extension header
 134  * or to find transport layer header.
 135  *   1. If the find_hdr_type < 0 then it finds and returns the protocol number and
 136  *   offset stored in *offset of the transport or ESP header in the chain if
 137  *   found.
 138  *   2. If a header with find_hdr_type > 0 protocol number is found then the
 139  *      offset is stored in *offset and protocol number of the header is
 140  *      returned.
 141  *   3. If find_hdr_type is not found or packet is malformed or
 142  *      it is a non-first fragment -1 is returned.
 143  */
 144 always_inline int
 145 ip6_locate_header (vlib_buffer_t *b, ip6_header_t *ip, int find_hdr_type,
 146                    u32 *offset)
 147 {
 148   ip6_ext_hdr_chain_t hdr_chain;
 149   int res = ip6_ext_header_walk (b, ip, find_hdr_type, &hdr_chain);
 150   if (res >= 0)
 151     {
 152       *offset = hdr_chain.eh[res].offset;
 153       return hdr_chain.eh[res].protocol;
 154     }
 155   return -1;
 156 }
 157
 158
 159 /**
 160  * Push IPv6 header to buffer
 161  *
 162  * @param vm - vlib_main
 163  * @param b - buffer to write the header to
 164  * @param src - source IP
 165  * @param dst - destination IP
 166  * @param prot - payload proto
 167  * @param flow_label - flow label
 168  *
 169  * @return - pointer to start of IP header
 170  */
 171 always_inline void *
 172 vlib_buffer_push_ip6_custom (vlib_main_t * vm, vlib_buffer_t * b,
 173                              ip6_address_t * src, ip6_address_t * dst,
 174                              int proto, u32 flow_label)
 175 {
 176   ip6_header_t *ip6h;
 177   u16 payload_length;
 178
 179   /* make some room */
 180   ip6h = vlib_buffer_push_uninit (b, sizeof (ip6_header_t));
 181   ASSERT (flow_label < 1 << 20);
 182   ip6h->ip_version_traffic_class_and_flow_label =
 183     clib_host_to_net_u32 ((0x6 << 28) | flow_label);
 184
 185   /* calculate ip6 payload length */
 186   payload_length = vlib_buffer_length_in_chain (vm, b);
 187   payload_length -= sizeof (*ip6h);
 188
 189   ip6h->payload_length = clib_host_to_net_u16 (payload_length);
 190
 191   ip6h->hop_limit = 0xff;
 192   ip6h->protocol = proto;
 193   clib_memcpy_fast (ip6h->src_address.as_u8, src->as_u8,
 194                     sizeof (ip6h->src_address));
 195   clib_memcpy_fast (ip6h->dst_address.as_u8, dst->as_u8,
 196                     sizeof (ip6h->src_address));
 197   vnet_buffer (b)->l3_hdr_offset = (u8 *) ip6h - b->data;
 198   b->flags |= VNET_BUFFER_F_IS_IP6 | VNET_BUFFER_F_L3_HDR_OFFSET_VALID;
 199
 200   return ip6h;
 201 }
 202
 203 /**
 204  * Push IPv6 header to buffer
 205  *
 206  * @param vm - vlib_main
 207  * @param b - buffer to write the header to
 208  * @param src - source IP
 209  * @param dst - destination IP
 210  * @param prot - payload proto
 211  *
 212  * @return - pointer to start of IP header
 213  */
 214 always_inline void *
 215 vlib_buffer_push_ip6 (vlib_main_t * vm, vlib_buffer_t * b,
 216                       ip6_address_t * src, ip6_address_t * dst, int proto)
 217 {
 218   return vlib_buffer_push_ip6_custom (vm, b, src, dst, proto,
 219                                       0 /* flow label */ );
 220
 221 }
 222
 223 #endif /* included_ip_ip6_h */
 224
 225 /*
 226  * fd.io coding-style-patch-verification: ON
 227  *
 228  * Local Variables:
 229  * eval: (c-set-style "gnu")
 230  * End:
 231  */