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:
7 * http://www.apache.org/licenses/LICENSE-2.0
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.
16 * ip/ip.h: ip generic (4 or 6) main
18 * Copyright (c) 2008 Eliot Dresselhaus
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:
28 * The above copyright notice and this permission notice shall be
29 * included in all copies or substantial portions of the Software.
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.
40 #ifndef included_ip_main_h
41 #define included_ip_main_h
43 #include <vppinfra/hash.h>
44 #include <vppinfra/heap.h> /* adjacency heap */
45 #include <vppinfra/ptclosure.h>
47 #include <vnet/vnet.h>
49 #include <vnet/ip/format.h>
50 #include <vnet/ip/ip_packet.h>
51 #include <vnet/ip/lookup.h>
53 #include <vnet/tcp/tcp_packet.h>
54 #include <vnet/udp/udp_packet.h>
55 #include <vnet/ip/icmp46_packet.h>
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>
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>
68 #define u8_ptr_add(ptr, index) (((u8 *)ptr) + index)
69 #define u16_net_add(u, val) clib_host_to_net_u16(clib_net_to_host_u16(u) + (val))
71 /* Per protocol info. */
74 /* Protocol name (also used as hash key). */
77 /* Protocol number. */
78 ip_protocol_t protocol;
80 /* Format function for this IP protocol. */
81 format_function_t *format_header;
83 /* Parser for header. */
84 unformat_function_t *unformat_header;
86 /* Parser for per-protocol matches. */
87 unformat_function_t *unformat_match;
89 /* Parser for packet generator edits for this protocol. */
90 unformat_function_t *unformat_pg_edit;
93 /* Per TCP/UDP port info. */
96 /* Port name (used as hash key). */
99 /* UDP/TCP port number in network byte order. */
102 /* Port specific format function. */
103 format_function_t *format_header;
105 /* Parser for packet generator edits for this protocol. */
106 unformat_function_t *unformat_pg_edit;
107 } tcp_udp_port_info_t;
111 /* Per IP protocol info. */
112 ip_protocol_info_t *protocol_infos;
114 /* Protocol info index hashed by 8 bit IP protocol. */
115 uword *protocol_info_by_protocol;
117 /* Hash table mapping IP protocol name (see protocols.def)
118 to protocol number. */
119 uword *protocol_info_by_name;
121 /* Per TCP/UDP port info. */
122 tcp_udp_port_info_t *port_infos;
124 /* Hash table from network-byte-order port to port info index. */
125 uword *port_info_by_port;
127 /* Hash table mapping TCP/UDP name to port info index. */
128 uword *port_info_by_name;
131 extern ip_main_t ip_main;
133 clib_error_t *ip_main_init (vlib_main_t * vm);
135 static inline ip_protocol_info_t *
136 ip_get_protocol_info (ip_main_t * im, u32 protocol)
140 p = hash_get (im->protocol_info_by_protocol, protocol);
141 return p ? vec_elt_at_index (im->protocol_infos, p[0]) : 0;
144 static inline tcp_udp_port_info_t *
145 ip_get_tcp_udp_port_info (ip_main_t * im, u32 port)
149 p = hash_get (im->port_info_by_port, port);
150 return p ? vec_elt_at_index (im->port_infos, p[0]) : 0;
153 always_inline ip_csum_t
154 ip_incremental_checksum_buffer (vlib_main_t * vm,
155 vlib_buffer_t * first_buffer,
156 u32 first_buffer_offset,
157 u32 n_bytes_to_checksum, ip_csum_t sum)
159 vlib_buffer_t *b = first_buffer;
160 u32 n_bytes_left = n_bytes_to_checksum;
161 ASSERT (b->current_length >= first_buffer_offset);
165 n = clib_min (n_bytes_left, b->current_length - first_buffer_offset);
166 h = vlib_buffer_get_current (b) + first_buffer_offset;
167 sum = ip_incremental_checksum (sum, h, n);
168 if (PREDICT_FALSE (b->flags & VLIB_BUFFER_NEXT_PRESENT))
173 if (n_bytes_left == 0)
175 b = vlib_get_buffer (vm, b->next_buffer);
176 n = clib_min (n_bytes_left, b->current_length);
177 h = vlib_buffer_get_current (b);
178 sum = ip_incremental_checksum (sum, h, n);
185 void ip_del_all_interface_addresses (vlib_main_t * vm, u32 sw_if_index);
187 extern vlib_node_registration_t ip4_inacl_node;
188 extern vlib_node_registration_t ip6_inacl_node;
190 void ip_table_create (fib_protocol_t fproto, u32 table_id, u8 is_api,
193 void ip_table_delete (fib_protocol_t fproto, u32 table_id, u8 is_api);
195 int ip_table_bind (fib_protocol_t fproto, u32 sw_if_index,
196 u32 table_id, u8 is_api);
198 u8 ip_is_zero (ip46_address_t * ip46_address, u8 is_ip4);
199 u8 ip_is_local_host (ip46_address_t * ip46_address, u8 is_ip4);
200 u8 ip4_is_local_host (ip4_address_t * ip4_address);
201 u8 ip6_is_local_host (ip6_address_t * ip6_address);
202 u8 ip_is_local (u32 fib_index, ip46_address_t * ip46_address, u8 is_ip4);
203 u8 ip_interface_has_address (u32 sw_if_index, ip46_address_t * ip, u8 is_ip4);
204 void ip_copy (ip46_address_t * dst, ip46_address_t * src, u8 is_ip4);
205 void ip_set (ip46_address_t * dst, void *src, u8 is_ip4);
206 void *ip_interface_get_first_ip (u32 sw_if_index, u8 is_ip4);
207 void ip4_address_normalize (ip4_address_t * ip4, u8 preflen);
208 void ip6_address_normalize (ip6_address_t * ip6, u8 preflen);
209 void ip4_preflen_to_mask (u8 pref_len, ip4_address_t * ip);
210 u32 ip4_mask_to_preflen (ip4_address_t * mask);
211 void ip4_prefix_max_address_host_order (ip4_address_t * ip, u8 plen,
212 ip4_address_t * res);
213 void ip6_prefix_max_address_host_order (ip6_address_t * ip, u8 plen,
214 ip6_address_t * res);
215 void ip6_preflen_to_mask (u8 pref_len, ip6_address_t * mask);
216 u32 ip6_mask_to_preflen (ip6_address_t * mask);
218 #endif /* included_ip_main_h */
221 * fd.io coding-style-patch-verification: ON
224 * eval: (c-set-style "gnu")