src/vnet/ip/ip4_inlines.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  * ip/ip4.h: ip4 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_ip4_inlines_h
  41 #define included_ip_ip4_inlines_h
  42
  43 #include <vnet/ip/ip_flow_hash.h>
  44 #include <vnet/ip/ip4_packet.h>
  45
  46 #define IP_DF 0x4000            /* don't fragment */
  47
  48 /* Compute flow hash.  We'll use it to select which adjacency to use for this
  49    flow.  And other things. */
  50 always_inline u32
  51 ip4_compute_flow_hash (const ip4_header_t * ip,
  52                        flow_hash_config_t flow_hash_config)
  53 {
  54   tcp_header_t *tcp = (void *) (ip + 1);
  55   u32 a, b, c, t1, t2;
  56   uword is_tcp_udp = (ip->protocol == IP_PROTOCOL_TCP
  57                       || ip->protocol == IP_PROTOCOL_UDP);
  58
  59   t1 = (flow_hash_config & IP_FLOW_HASH_SRC_ADDR)
  60     ? ip->src_address.data_u32 : 0;
  61   t2 = (flow_hash_config & IP_FLOW_HASH_DST_ADDR)
  62     ? ip->dst_address.data_u32 : 0;
  63
  64   a = (flow_hash_config & IP_FLOW_HASH_REVERSE_SRC_DST) ? t2 : t1;
  65   b = (flow_hash_config & IP_FLOW_HASH_REVERSE_SRC_DST) ? t1 : t2;
  66
  67   t1 = is_tcp_udp ? tcp->src : 0;
  68   t2 = is_tcp_udp ? tcp->dst : 0;
  69
  70   t1 = (flow_hash_config & IP_FLOW_HASH_SRC_PORT) ? t1 : 0;
  71   t2 = (flow_hash_config & IP_FLOW_HASH_DST_PORT) ? t2 : 0;
  72
  73   if (flow_hash_config & IP_FLOW_HASH_SYMMETRIC)
  74     {
  75       if (b < a)
  76         {
  77           c = a;
  78           a = b;
  79           b = c;
  80         }
  81       if (t2 < t1)
  82         {
  83           t2 += t1;
  84           t1 = t2 - t1;
  85           t2 = t2 - t1;
  86         }
  87     }
  88
  89   b ^= (flow_hash_config & IP_FLOW_HASH_PROTO) ? ip->protocol : 0;
  90   c = (flow_hash_config & IP_FLOW_HASH_REVERSE_SRC_DST) ?
  91     (t1 << 16) | t2 : (t2 << 16) | t1;
  92   a ^= ip_flow_hash_router_id;
  93
  94   hash_v3_mix32 (a, b, c);
  95   hash_v3_finalize32 (a, b, c);
  96
  97   return c;
  98 }
  99
 100 always_inline void *
 101 vlib_buffer_push_ip4_custom (vlib_main_t * vm, vlib_buffer_t * b,
 102                              ip4_address_t * src, ip4_address_t * dst,
 103                              int proto, u8 csum_offload, u8 is_df)
 104 {
 105   ip4_header_t *ih;
 106
 107   /* make some room */
 108   ih = vlib_buffer_push_uninit (b, sizeof (ip4_header_t));
 109
 110   ih->ip_version_and_header_length = 0x45;
 111   ih->tos = 0;
 112   ih->length = clib_host_to_net_u16 (vlib_buffer_length_in_chain (vm, b));
 113
 114   /* No fragments */
 115   ih->flags_and_fragment_offset = is_df ? clib_host_to_net_u16 (IP_DF) : 0;
 116   ih->ttl = 255;
 117   ih->protocol = proto;
 118   ih->src_address.as_u32 = src->as_u32;
 119   ih->dst_address.as_u32 = dst->as_u32;
 120
 121   vnet_buffer (b)->l3_hdr_offset = (u8 *) ih - b->data;
 122   b->flags |= VNET_BUFFER_F_IS_IP4 | VNET_BUFFER_F_L3_HDR_OFFSET_VALID;
 123
 124   /* Offload ip4 header checksum generation */
 125   if (csum_offload)
 126     {
 127       ih->checksum = 0;
 128       b->flags |= VNET_BUFFER_F_OFFLOAD_IP_CKSUM;
 129     }
 130   else
 131     ih->checksum = ip4_header_checksum (ih);
 132
 133   return ih;
 134 }
 135
 136 /**
 137  * Push IPv4 header to buffer
 138  *
 139  * This does not support fragmentation.
 140  *
 141  * @param vm - vlib_main
 142  * @param b - buffer to write the header to
 143  * @param src - source IP
 144  * @param dst - destination IP
 145  * @param prot - payload proto
 146  *
 147  * @return - pointer to start of IP header
 148  */
 149 always_inline void *
 150 vlib_buffer_push_ip4 (vlib_main_t * vm, vlib_buffer_t * b,
 151                       ip4_address_t * src, ip4_address_t * dst, int proto,
 152                       u8 csum_offload)
 153 {
 154   return vlib_buffer_push_ip4_custom (vm, b, src, dst, proto, csum_offload,
 155                                       1 /* is_df */ );
 156 }
 157
 158 #endif /* included_ip_ip4_inlines_h */
 159
 160 /*
 161  * fd.io coding-style-patch-verification: ON
 162  *
 163  * Local Variables:
 164  * eval: (c-set-style "gnu")
 165  * End:
 166  */