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 #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   /* Protocol name (also used as hash key). */
  71   u8 * name;
  72
  73   /* Protocol number. */
  74   ip_protocol_t protocol;
  75
  76   /* Format function for this IP protocol. */
  77   format_function_t * format_header;
  78
  79   /* Parser for header. */
  80   unformat_function_t * unformat_header;
  81
  82   /* Parser for per-protocol matches. */
  83   unformat_function_t * unformat_match;
  84
  85   /* Parser for packet generator edits for this protocol. */
  86   unformat_function_t * unformat_pg_edit;
  87 } ip_protocol_info_t;
  88
  89 /* Per TCP/UDP port info. */
  90 typedef struct {
  91   /* Port name (used as hash key). */
  92   u8 * name;
  93
  94   /* UDP/TCP port number in network byte order. */
  95   u16 port;
  96
  97   /* Port specific format function. */
  98   format_function_t * format_header;
  99
 100   /* Parser for packet generator edits for this protocol. */
 101   unformat_function_t * unformat_pg_edit;
 102 } tcp_udp_port_info_t;
 103
 104 typedef struct {
 105   /* Per IP protocol info. */
 106   ip_protocol_info_t * protocol_infos;
 107
 108   /* Protocol info index hashed by 8 bit IP protocol. */
 109   uword * protocol_info_by_protocol;
 110
 111   /* Hash table mapping IP protocol name (see protocols.def)
 112      to protocol number. */
 113   uword * protocol_info_by_name;
 114
 115   /* Per TCP/UDP port info. */
 116   tcp_udp_port_info_t * port_infos;
 117
 118   /* Hash table from network-byte-order port to port info index. */
 119   uword * port_info_by_port;
 120
 121   /* Hash table mapping TCP/UDP name to port info index. */
 122   uword * port_info_by_name;
 123 } ip_main_t;
 124
 125 extern ip_main_t ip_main;
 126
 127 clib_error_t *
 128 ip_main_init (vlib_main_t * vm);
 129
 130 static inline ip_protocol_info_t *
 131 ip_get_protocol_info (ip_main_t * im, u32 protocol)
 132 {
 133   uword * p;
 134
 135   p = hash_get (im->protocol_info_by_protocol, protocol);
 136   return p ? vec_elt_at_index (im->protocol_infos, p[0]) : 0;
 137 }
 138
 139 static inline tcp_udp_port_info_t *
 140 ip_get_tcp_udp_port_info (ip_main_t * im, u32 port)
 141 {
 142   uword * p;
 143
 144   p = hash_get (im->port_info_by_port, port);
 145   return p ? vec_elt_at_index (im->port_infos, p[0]) : 0;
 146 }
 147
 148 always_inline ip_csum_t
 149 ip_incremental_checksum_buffer (vlib_main_t * vm, vlib_buffer_t * first_buffer,
 150                                 u32 first_buffer_offset,
 151                                 u32 n_bytes_to_checksum,
 152                                 ip_csum_t sum)
 153 {
 154   vlib_buffer_t * b = first_buffer;
 155   u32 n_bytes_left = n_bytes_to_checksum;
 156   ASSERT (b->current_length >= first_buffer_offset);
 157   void * h;
 158   u32 n;
 159
 160   n = clib_min (n_bytes_left, b->current_length);
 161   h = vlib_buffer_get_current (b) + first_buffer_offset;
 162   sum = ip_incremental_checksum (sum, h, n);
 163   if (PREDICT_FALSE (b->flags & VLIB_BUFFER_NEXT_PRESENT))
 164     {
 165       while (1)
 166         {
 167           n_bytes_left -= n;
 168           if (n_bytes_left == 0)
 169             break;
 170           b = vlib_get_buffer (vm, b->next_buffer);
 171           n = clib_min (n_bytes_left, b->current_length);
 172           h = vlib_buffer_get_current (b);
 173           sum = ip_incremental_checksum (sum, h, n);
 174         }
 175     }
 176
 177   return sum;
 178 }
 179
 180 void ip_del_all_interface_addresses (vlib_main_t *vm, u32 sw_if_index);
 181
 182 extern vlib_node_registration_t ip4_inacl_node;
 183 extern vlib_node_registration_t ip6_inacl_node;
 184
 185 #endif /* included_ip_main_h */