vnet/vnet/ip/ip.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/ip.h: ip generic (4 or 6) main
  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_main_h
  41 #define included_ip_main_h
  42
  43 #include <vppinfra/hash.h>
  44 #include <vppinfra/heap.h>              /* adjacency heap */
  45
  46 #include <vnet/vnet.h>
  47
  48 #include <vnet/ip/format.h>
  49 #include <vnet/ip/ip_packet.h>
  50 #include <vnet/ip/lookup.h>
  51
  52 #include <vnet/ip/tcp_packet.h>
  53 #include <vnet/ip/udp_packet.h>
  54 #include <vnet/ip/icmp46_packet.h>
  55
  56 #include <vnet/ip/ip4.h>
  57 #include <vnet/ip/ip4_error.h>
  58 #include <vnet/ip/ip4_packet.h>
  59
  60 #include <vnet/ip/ip6.h>
  61 #include <vnet/ip/ip6_packet.h>
  62 #include <vnet/ip/ip6_error.h>
  63 #include <vnet/ip/icmp6.h>
  64
  65 #include <vnet/ip/tcp.h>
  66
  67 #if DPDK > 0
  68 #include <vnet/devices/dpdk/dpdk.h>
  69 #endif
  70
  71 #include <vnet/classify/vnet_classify.h>
  72
  73 typedef union {
  74   ip4_address_t ip4;
  75   ip6_address_t ip6;
  76 } ip46_address_t;
  77
  78 /* Per protocol info. */
  79 typedef struct {
  80   /* Protocol name (also used as hash key). */
  81   u8 * name;
  82
  83   /* Protocol number. */
  84   ip_protocol_t protocol;
  85
  86   /* Format function for this IP protocol. */
  87   format_function_t * format_header;
  88
  89   /* Parser for header. */
  90   unformat_function_t * unformat_header;
  91
  92   /* Parser for per-protocol matches. */
  93   unformat_function_t * unformat_match;
  94
  95   /* Parser for packet generator edits for this protocol. */
  96   unformat_function_t * unformat_pg_edit;
  97 } ip_protocol_info_t;
  98
  99 /* Per TCP/UDP port info. */
 100 typedef struct {
 101   /* Port name (used as hash key). */
 102   u8 * name;
 103
 104   /* UDP/TCP port number in network byte order. */
 105   u16 port;
 106
 107   /* Port specific format function. */
 108   format_function_t * format_header;
 109
 110   /* Parser for packet generator edits for this protocol. */
 111   unformat_function_t * unformat_pg_edit;
 112 } tcp_udp_port_info_t;
 113
 114 typedef struct {
 115   /* Per IP protocol info. */
 116   ip_protocol_info_t * protocol_infos;
 117
 118   /* Protocol info index hashed by 8 bit IP protocol. */
 119   uword * protocol_info_by_protocol;
 120
 121   /* Hash table mapping IP protocol name (see protocols.def)
 122      to protocol number. */
 123   uword * protocol_info_by_name;
 124
 125   /* Per TCP/UDP port info. */
 126   tcp_udp_port_info_t * port_infos;
 127
 128   /* Hash table from network-byte-order port to port info index. */
 129   uword * port_info_by_port;
 130
 131   /* Hash table mapping TCP/UDP name to port info index. */
 132   uword * port_info_by_name;
 133 } ip_main_t;
 134
 135 extern ip_main_t ip_main;
 136
 137 clib_error_t *
 138 ip_main_init (vlib_main_t * vm);
 139
 140 static inline ip_protocol_info_t *
 141 ip_get_protocol_info (ip_main_t * im, u32 protocol)
 142 {
 143   uword * p;
 144
 145   p = hash_get (im->protocol_info_by_protocol, protocol);
 146   return p ? vec_elt_at_index (im->protocol_infos, p[0]) : 0;
 147 }
 148
 149 static inline tcp_udp_port_info_t *
 150 ip_get_tcp_udp_port_info (ip_main_t * im, u32 port)
 151 {
 152   uword * p;
 153
 154   p = hash_get (im->port_info_by_port, port);
 155   return p ? vec_elt_at_index (im->port_infos, p[0]) : 0;
 156 }
 157
 158 always_inline ip_csum_t
 159 ip_incremental_checksum_buffer (vlib_main_t * vm, vlib_buffer_t * first_buffer,
 160                                 u32 first_buffer_offset,
 161                                 u32 n_bytes_to_checksum,
 162                                 ip_csum_t sum)
 163 #if DPDK > 0
 164 {
 165   u32 n_bytes_left = n_bytes_to_checksum;
 166   struct rte_mbuf * mb = ((struct rte_mbuf *)first_buffer)-1;
 167   u8 nb_segs = mb->nb_segs;
 168   ASSERT(mb->data_len >= first_buffer_offset);
 169   void * h;
 170   u32 n;
 171
 172   n = clib_min (n_bytes_left, mb->data_len);
 173   h = vlib_buffer_get_current (first_buffer) + first_buffer_offset;
 174   while (n_bytes_left)
 175     {
 176       sum = ip_incremental_checksum (sum, h, n);
 177       n_bytes_left -= n;
 178       nb_segs--;
 179       mb = mb->next;
 180       if ((nb_segs == 0) || (mb == 0))
 181         break;
 182
 183       n = clib_min (n_bytes_left, mb->data_len);
 184       h = rte_ctrlmbuf_data(mb);
 185     }
 186
 187   ASSERT(n_bytes_left == 0);
 188   ASSERT(nb_segs == 0);
 189   return sum;
 190 }
 191 #else
 192 {
 193   vlib_buffer_t * b = first_buffer;
 194   u32 n_bytes_left = n_bytes_to_checksum;
 195   ASSERT (b->current_length >= first_buffer_offset);
 196   void * h;
 197   u32 n;
 198
 199   n = clib_min (n_bytes_left, b->current_length);
 200   h = vlib_buffer_get_current (b) + first_buffer_offset;
 201   sum = ip_incremental_checksum (sum, h, n);
 202   if (PREDICT_FALSE (b->flags & VLIB_BUFFER_NEXT_PRESENT))
 203     {
 204       while (1)
 205         {
 206           n_bytes_left -= n;
 207           if (n_bytes_left == 0)
 208             break;
 209           b = vlib_get_buffer (vm, b->next_buffer);
 210           n = clib_min (n_bytes_left, b->current_length);
 211           h = vlib_buffer_get_current (b);
 212           sum = ip_incremental_checksum (sum, h, n);
 213         }
 214     }
 215
 216   return sum;
 217 }
 218 #endif /* DPDK */
 219
 220 void ip_del_all_interface_addresses (vlib_main_t *vm, u32 sw_if_index);
 221
 222 #endif /* included_ip_main_h */