FD.io VPP  v18.01.2-1-g9b554f3
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/format.h>
50 #include <vnet/ip/ip_packet.h>
51 #include <vnet/ip/lookup.h>
52 
53 #include <vnet/tcp/tcp_packet.h>
54 #include <vnet/udp/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>
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);
163  h = vlib_buffer_get_current (b) + first_buffer_offset;
164  sum = ip_incremental_checksum (sum, h, n);
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 
186 
187 void ip_table_create (fib_protocol_t fproto, u32 table_id, u8 is_api,
188  const u8 * name);
189 
190 void ip_table_delete (fib_protocol_t fproto, u32 table_id, u8 is_api);
191 
192 int ip_table_bind (fib_protocol_t fproto, u32 sw_if_index,
193  u32 table_id, u8 is_api);
194 
195 u8 ip_is_zero (ip46_address_t * ip46_address, u8 is_ip4);
196 u8 ip_is_local_host (ip46_address_t * ip46_address, u8 is_ip4);
197 u8 ip_is_local (u32 fib_index, ip46_address_t * ip46_address, u8 is_ip4);
198 u8 ip_interface_has_address (u32 sw_if_index, ip46_address_t * ip, u8 is_ip4);
199 void ip_copy (ip46_address_t * dst, ip46_address_t * src, u8 is_ip4);
200 void ip_set (ip46_address_t * dst, void *src, u8 is_ip4);
201 void *ip_interface_get_first_ip (u32 sw_if_index, u8 is_ip4);
202 void ip4_address_normalize (ip4_address_t * ip4, u8 preflen);
203 void ip6_address_normalize (ip6_address_t * ip6, u8 preflen);
204 void ip4_preflen_to_mask (u8 pref_len, ip4_address_t * ip);
207  ip4_address_t * res);
209  ip6_address_t * res);
210 void ip6_preflen_to_mask (u8 pref_len, ip6_address_t * mask);
212 
213 #endif /* included_ip_main_h */
214 
215 /*
216  * fd.io coding-style-patch-verification: ON
217  *
218  * Local Variables:
219  * eval: (c-set-style "gnu")
220  * End:
221  */
uword * protocol_info_by_name
Definition: ip.h:116
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
uword( unformat_function_t)(unformat_input_t *input, va_list *args)
Definition: format.h:231
u32 ip4_mask_to_preflen(ip4_address_t *mask)
Definition: ip.c:191
void ip_table_create(fib_protocol_t fproto, u32 table_id, u8 is_api, const u8 *name)
Definition: ip_api.c:1242
#define clib_min(x, y)
Definition: clib.h:340
void ip6_address_normalize(ip6_address_t *ip6, u8 preflen)
Definition: ip.c:162
void * ip_interface_get_first_ip(u32 sw_if_index, u8 is_ip4)
Definition: ip.c:119
void ip_set(ip46_address_t *dst, void *src, u8 is_ip4)
Definition: ip.c:76
void ip6_preflen_to_mask(u8 pref_len, ip6_address_t *mask)
Definition: ip.c:208
Definitions for all things IP (v4|v6) unicast and multicast lookup related.
uword * port_info_by_name
Definition: ip.h:125
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:41
struct _vlib_node_registration vlib_node_registration_t
u8 ip_interface_has_address(u32 sw_if_index, ip46_address_t *ip, u8 is_ip4)
Definition: ip.c:85
uword ip_csum_t
Definition: ip_packet.h:90
Definition: ip.h:106
u8 *( format_function_t)(u8 *s, va_list *args)
Definition: format.h:48
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:229
void ip4_address_normalize(ip4_address_t *ip4, u8 preflen)
Definition: ip.c:152
#define VLIB_BUFFER_NEXT_PRESENT
Definition: buffer.h:95
unformat_function_t * unformat_pg_edit
Definition: ip.h:87
ip_csum_t ip_incremental_checksum(ip_csum_t sum, void *_data, uword n_bytes)
Definition: ip_checksum.c:43
#define always_inline
Definition: clib.h:92
#define vec_elt_at_index(v, i)
Get vector value at index i checking that i is in bounds.
uword * port_info_by_port
Definition: ip.h:122
#define hash_get(h, key)
Definition: hash.h:248
static ip_protocol_info_t * ip_get_protocol_info(ip_main_t *im, u32 protocol)
Definition: ip.h:133
u16 current_length
Nbytes between current data and the end of this buffer.
Definition: buffer.h:72
format_function_t * format_header
Definition: ip.h:78
static void * vlib_buffer_get_current(vlib_buffer_t *b)
Get pointer to current data to process.
Definition: buffer.h:195
void ip_copy(ip46_address_t *dst, ip46_address_t *src, u8 is_ip4)
Definition: ip.c:67
u32 ip6_mask_to_preflen(ip6_address_t *mask)
Definition: ip.c:252
#define PREDICT_FALSE(x)
Definition: clib.h:105
enum ip_protocol ip_protocol_t
void ip_del_all_interface_addresses(vlib_main_t *vm, u32 sw_if_index)
Definition: ip46_cli.c:80
int ip_table_bind(fib_protocol_t fproto, u32 sw_if_index, u32 table_id, u8 is_api)
vlib_node_registration_t ip4_inacl_node
(constructor) VLIB_REGISTER_NODE (ip4_inacl_node)
Definition: ip_input_acl.c:395
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)
Definition: ip_input_acl.c:420
vec_header_t h
Definition: buffer.c:282
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:786
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)
unsigned int u32
Definition: types.h:88
unformat_function_t * unformat_pg_edit
Definition: ip.h:103
u32 next_buffer
Next buffer for this linked-list of buffers.
Definition: buffer.h:109
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
u64 uword
Definition: types.h:112
void ip4_prefix_max_address_host_order(ip4_address_t *ip, u8 plen, ip4_address_t *res)
Definition: ip.c:199
unsigned short u16
Definition: types.h:57
unsigned char u8
Definition: types.h:56
void ip4_preflen_to_mask(u8 pref_len, ip4_address_t *ip)
Definition: ip.c:182
u8 ip_is_zero(ip46_address_t *ip46_address, u8 is_ip4)
Definition: ip.c:20
u8 * name
Definition: ip.h: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 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:75
static vlib_buffer_t * vlib_get_buffer(vlib_main_t *vm, u32 buffer_index)
Translate buffer index into buffer pointer.
Definition: buffer_funcs.h:57