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