FD.io VPP  v20.01-48-g3e0dafb74
Vector Packet Processing
ip.h
Go to the documentation of this file.
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/ip_types.h>
50 #include <vnet/ip/format.h>
51 #include <vnet/ip/ip_packet.h>
52 #include <vnet/ip/lookup.h>
53 
54 #include <vnet/tcp/tcp_packet.h>
55 #include <vnet/udp/udp_packet.h>
56 #include <vnet/ip/icmp46_packet.h>
57 
58 #include <vnet/ip/ip4.h>
59 #include <vnet/ip/ip4_error.h>
60 #include <vnet/ip/ip4_packet.h>
61 #include <vnet/ip/icmp4.h>
62 
63 #include <vnet/ip/ip6.h>
64 #include <vnet/ip/ip6_packet.h>
65 #include <vnet/ip/ip6_error.h>
66 #include <vnet/ip/icmp6.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. */
76 
77  /* Format function for this IP protocol. */
79 
80  /* Parser for header. */
82 
83  /* Parser for per-protocol matches. */
85 
86  /* Parser for packet generator edits for this protocol. */
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. */
98 
99  /* Port specific format function. */
101 
102  /* Parser for packet generator edits for this protocol. */
105 
106 typedef struct
107 {
108  /* Per IP protocol info. */
110 
111  /* Protocol info index hashed by 8 bit IP protocol. */
113 
114  /* Hash table mapping IP protocol name (see protocols.def)
115  to protocol number. */
117 
118  /* Per TCP/UDP port info. */
120 
121  /* Hash table from network-byte-order port to port info index. */
123 
124  /* Hash table mapping TCP/UDP name to port info index. */
126 } ip_main_t;
127 
128 extern ip_main_t ip_main;
129 
131 
132 static inline ip_protocol_info_t *
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 *
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 
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 - first_buffer_offset);
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 
184  ip_csum_t sum0, u32 payload_length,
185  u8 * iph, u32 ip_header_size, u8 * l4h)
186 {
187  u16 sum16;
188  u8 *data_this_buffer, length_odd;
189  u32 n_bytes_left, n_this_buffer, n_ip_bytes_this_buffer;
190 
191  n_bytes_left = payload_length;
192 
193  if (l4h) /* packet l4 header and no buffer chain involved */
194  {
195  ASSERT (p0 == NULL);
196  n_this_buffer = payload_length;
197  data_this_buffer = l4h;
198  }
199  else
200  {
201  ASSERT (p0);
202  if (iph) /* ip header pointer set to packet in buffer */
203  {
204  ASSERT (ip_header_size);
205  n_this_buffer = payload_length;
206  data_this_buffer = iph + ip_header_size; /* at l4 header */
207  n_ip_bytes_this_buffer =
208  p0->current_length - (((u8 *) iph - p0->data) - p0->current_data);
209  if (PREDICT_FALSE (payload_length + ip_header_size >
210  n_ip_bytes_this_buffer))
211  {
212  n_this_buffer = n_ip_bytes_this_buffer - ip_header_size;
213  if (PREDICT_FALSE (n_this_buffer >> 31))
214  { /* error - ip header don't fit this buffer */
215  return 0xfefe;
216  }
217  }
218  }
219  else /* packet in buffer with no ip header */
220  { /* buffer current pointer at l4 header */
221  n_this_buffer = p0->current_length;
222  data_this_buffer = vlib_buffer_get_current (p0);
223  }
224  n_this_buffer = clib_min (n_this_buffer, n_bytes_left);
225  }
226 
227  while (1)
228  {
229  sum0 = ip_incremental_checksum (sum0, data_this_buffer, n_this_buffer);
230  n_bytes_left -= n_this_buffer;
231  if (n_bytes_left == 0)
232  break;
233 
234  if (!(p0->flags & VLIB_BUFFER_NEXT_PRESENT))
235  {
236  return 0xfefe;
237  }
238 
239  length_odd = (n_this_buffer & 1);
240 
241  p0 = vlib_get_buffer (vm, p0->next_buffer);
242  data_this_buffer = vlib_buffer_get_current (p0);
243  n_this_buffer = clib_min (p0->current_length, n_bytes_left);
244 
245  if (PREDICT_FALSE (length_odd))
246  {
247  /* Prepend a 0 byte to maintain 2-byte checksum alignment */
248  data_this_buffer--;
249  n_this_buffer++;
250  n_bytes_left++;
251  data_this_buffer[0] = 0;
252  }
253  }
254 
255  sum16 = ~ip_csum_fold (sum0);
256  return sum16;
257 }
258 
260 
263 
264 void ip_table_create (fib_protocol_t fproto, u32 table_id, u8 is_api,
265  const u8 * name);
266 
267 void ip_table_delete (fib_protocol_t fproto, u32 table_id, u8 is_api);
268 
270  u32 table_id, u8 is_api);
271 
272 u8 ip_is_zero (ip46_address_t * ip46_address, u8 is_ip4);
273 u8 ip_is_local_host (ip46_address_t * ip46_address, u8 is_ip4);
274 u8 ip4_is_local_host (ip4_address_t * ip4_address);
275 u8 ip6_is_local_host (ip6_address_t * ip6_address);
276 u8 ip_is_local (u32 fib_index, ip46_address_t * ip46_address, u8 is_ip4);
277 u8 ip_interface_has_address (u32 sw_if_index, ip46_address_t * ip, u8 is_ip4);
278 void ip_copy (ip46_address_t * dst, ip46_address_t * src, u8 is_ip4);
279 void ip_set (ip46_address_t * dst, void *src, u8 is_ip4);
281 void ip4_address_normalize (ip4_address_t * ip4, u8 preflen);
282 void ip6_address_normalize (ip6_address_t * ip6, u8 preflen);
283 void ip4_preflen_to_mask (u8 pref_len, ip4_address_t * ip);
286  ip4_address_t * res);
288  ip6_address_t * res);
289 void ip6_preflen_to_mask (u8 pref_len, ip6_address_t * mask);
291 
292 #endif /* included_ip_main_h */
293 
294 /*
295  * fd.io coding-style-patch-verification: ON
296  *
297  * Local Variables:
298  * eval: (c-set-style "gnu")
299  * End:
300  */
uword * protocol_info_by_name
Definition: ip.h:116
u32 flags
buffer flags: VLIB_BUFFER_FREE_LIST_INDEX_MASK: bits used to store free list index, VLIB_BUFFER_IS_TRACED: trace this buffer.
Definition: buffer.h:124
uword * protocol_info_by_protocol
Definition: ip.h:112
static ip_csum_t ip_incremental_checksum_buffer(vlib_main_t *vm, vlib_buffer_t *first_buffer, u32 first_buffer_offset, u32 n_bytes_to_checksum, ip_csum_t sum)
Definition: ip.h:151
u32 ip4_mask_to_preflen(ip4_address_t *mask)
Definition: ip.c:206
u8 ip6_is_local_host(ip6_address_t *ip6_address)
Definition: ip.c:45
void ip_table_create(fib_protocol_t fproto, u32 table_id, u8 is_api, const u8 *name)
Definition: ip_api.c:579
#define clib_min(x, y)
Definition: clib.h:295
void ip6_address_normalize(ip6_address_t *ip6, u8 preflen)
Definition: ip.c:177
void * ip_interface_get_first_ip(u32 sw_if_index, u8 is_ip4)
Definition: ip.c:134
void ip_set(ip46_address_t *dst, void *src, u8 is_ip4)
Definition: ip.c:90
void ip6_preflen_to_mask(u8 pref_len, ip6_address_t *mask)
Definition: ip.c:223
i16 current_data
signed offset in data[], pre_data[] that we are currently processing.
Definition: buffer.h:110
Definitions for all things IP (v4|v6) unicast and multicast lookup related.
uword * port_info_by_name
Definition: ip.h:125
#define NULL
Definition: clib.h:58
u16 current_length
Nbytes between current data and the end of this buffer.
Definition: buffer.h:113
u8 ip_is_local(u32 fib_index, ip46_address_t *ip46_address, u8 is_ip4)
Checks that an ip is local to the requested fib.
Definition: ip.c:55
u8 data[0]
Packet data.
Definition: buffer.h:181
vl_api_address_t src
Definition: gre.api:60
u8 ip_interface_has_address(u32 sw_if_index, ip46_address_t *ip, u8 is_ip4)
Definition: ip.c:100
uword ip_csum_t
Definition: ip_packet.h:244
Definition: ip.h:106
unsigned char u8
Definition: types.h:56
enum fib_protocol_t_ fib_protocol_t
Protocol Type.
ip_protocol_t protocol
Definition: ip.h:75
void ip6_prefix_max_address_host_order(ip6_address_t *ip, u8 plen, ip6_address_t *res)
Definition: ip.c:245
void ip4_address_normalize(ip4_address_t *ip4, u8 preflen)
Definition: ip.c:167
u8 *() format_function_t(u8 *s, va_list *args)
Definition: format.h:48
static u16 ip_calculate_l4_checksum(vlib_main_t *vm, vlib_buffer_t *p0, ip_csum_t sum0, u32 payload_length, u8 *iph, u32 ip_header_size, u8 *l4h)
Definition: ip.h:183
vl_api_ip_proto_t protocol
Definition: lb_types.api:71
unformat_function_t * unformat_pg_edit
Definition: ip.h:87
vl_api_interface_index_t sw_if_index
Definition: gre.api:59
#define vec_elt_at_index(v, i)
Get vector value at index i checking that i is in bounds.
unsigned int u32
Definition: types.h:88
uword * port_info_by_port
Definition: ip.h:122
#define hash_get(h, key)
Definition: hash.h:249
static ip_protocol_info_t * ip_get_protocol_info(ip_main_t *im, u32 protocol)
Definition: ip.h:133
format_function_t * format_header
Definition: ip.h:78
unsigned short u16
Definition: types.h:57
static void * vlib_buffer_get_current(vlib_buffer_t *b)
Get pointer to current data to process.
Definition: buffer.h:229
void ip_copy(ip46_address_t *dst, ip46_address_t *src, u8 is_ip4)
Definition: ip.c:81
u8 ip4_is_local_host(ip4_address_t *ip4_address)
Definition: ip.c:39
u32 ip6_mask_to_preflen(ip6_address_t *mask)
Definition: ip.c:268
#define PREDICT_FALSE(x)
Definition: clib.h:111
enum ip_protocol ip_protocol_t
#define always_inline
Definition: ipsec.h:28
void ip_del_all_interface_addresses(vlib_main_t *vm, u32 sw_if_index)
Definition: ip46_cli.c:82
int ip_table_bind(fib_protocol_t fproto, u32 sw_if_index, u32 table_id, u8 is_api)
uword() unformat_function_t(unformat_input_t *input, va_list *args)
Definition: format.h:233
vl_api_address_t dst
Definition: gre.api:61
vlib_node_registration_t ip4_inacl_node
(constructor) VLIB_REGISTER_NODE (ip4_inacl_node)
u8 is_ip4
Definition: lisp_gpe.api:232
ip_protocol_info_t * protocol_infos
Definition: ip.h:109
clib_error_t * ip_main_init(vlib_main_t *vm)
Definition: ip_init.c:45
vlib_node_registration_t ip6_inacl_node
(constructor) VLIB_REGISTER_NODE (ip6_inacl_node)
ip_main_t ip_main
Definition: ip_init.c:42
void ip_table_delete(fib_protocol_t fproto, u32 table_id, u8 is_api)
Definition: ip_api.c:457
string name[64]
Definition: ip.api:44
static tcp_udp_port_info_t * ip_get_tcp_udp_port_info(ip_main_t *im, u32 port)
Definition: ip.h:142
#define ASSERT(truth)
unformat_function_t * unformat_pg_edit
Definition: ip.h:103
unformat_function_t * unformat_header
Definition: ip.h:81
format_function_t * format_header
Definition: ip.h:100
unformat_function_t * unformat_match
Definition: ip.h:84
struct _vlib_node_registration vlib_node_registration_t
void ip4_prefix_max_address_host_order(ip4_address_t *ip, u8 plen, ip4_address_t *res)
Definition: ip.c:214
u32 next_buffer
Next buffer for this linked-list of buffers.
Definition: buffer.h:140
void ip4_preflen_to_mask(u8 pref_len, ip4_address_t *ip)
Definition: ip.c:197
u8 ip_is_zero(ip46_address_t *ip46_address, u8 is_ip4)
Definition: ip.c:20
VLIB buffer representation.
Definition: buffer.h:102
u64 uword
Definition: types.h:112
u8 * name
Definition: ip.h:72
u16 port
Definition: lb_types.api:72
tcp_udp_port_info_t * port_infos
Definition: ip.h:119
u8 ip_is_local_host(ip46_address_t *ip46_address, u8 is_ip4)
Definition: ip.c:29
u32 table_id
Definition: fib_types.api:118
static ip_csum_t ip_incremental_checksum(ip_csum_t sum, void *_data, uword n_bytes)
Definition: ip_packet.h:318
static vlib_buffer_t * vlib_get_buffer(vlib_main_t *vm, u32 buffer_index)
Translate buffer index into buffer pointer.
Definition: buffer_funcs.h:85
static u16 ip_csum_fold(ip_csum_t c)
Definition: ip_packet.h:300