2 * Copyright (c) 2017 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/ip4_input.c: IP v4 input node
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_input_h
41 #define included_ip_input_h
43 #include <vnet/ip/ip.h>
44 #include <vnet/ethernet/ethernet.h>
45 #include <vppinfra/vector/ip_csum.h>
51 IP4_INPUT_NEXT_OPTIONS,
52 IP4_INPUT_NEXT_LOOKUP,
53 IP4_INPUT_NEXT_LOOKUP_MULTICAST,
54 IP4_INPUT_NEXT_ICMP_ERROR,
58 static_always_inline void
59 check_ver_opt_csum (ip4_header_t * ip, u8 * error, int verify_checksum)
61 if (PREDICT_FALSE (ip->ip_version_and_header_length != 0x45))
63 if ((ip->ip_version_and_header_length & 0xf0) != 0x40)
64 *error = IP4_ERROR_VERSION;
65 else if ((ip->ip_version_and_header_length & 0x0f) < 5)
66 *error = IP4_ERROR_HDR_TOO_SHORT;
69 *error = IP4_ERROR_OPTIONS;
70 if (verify_checksum &&
71 clib_ip_csum ((u8 *) ip, ip4_header_bytes (ip)) != 0)
72 *error = IP4_ERROR_BAD_CHECKSUM;
75 else if (PREDICT_FALSE (verify_checksum &&
76 clib_ip_csum ((u8 *) ip, sizeof (ip4_header_t)) !=
78 *error = IP4_ERROR_BAD_CHECKSUM;
82 ip4_input_check_x4 (vlib_main_t * vm,
83 vlib_node_runtime_t * error_node,
84 vlib_buffer_t ** p, ip4_header_t ** ip,
85 u16 * next, int verify_checksum)
87 u8 error0, error1, error2, error3;
88 u32 ip_len0, cur_len0;
89 u32 ip_len1, cur_len1;
90 u32 ip_len2, cur_len2;
91 u32 ip_len3, cur_len3;
92 i32 len_diff0, len_diff1, len_diff2, len_diff3;
94 error0 = error1 = error2 = error3 = IP4_ERROR_NONE;
96 check_ver_opt_csum (ip[0], &error0, verify_checksum);
97 check_ver_opt_csum (ip[1], &error1, verify_checksum);
98 check_ver_opt_csum (ip[2], &error2, verify_checksum);
99 check_ver_opt_csum (ip[3], &error3, verify_checksum);
101 if (PREDICT_FALSE (ip[0]->ttl < 1))
102 error0 = IP4_ERROR_TIME_EXPIRED;
103 if (PREDICT_FALSE (ip[1]->ttl < 1))
104 error1 = IP4_ERROR_TIME_EXPIRED;
105 if (PREDICT_FALSE (ip[2]->ttl < 1))
106 error2 = IP4_ERROR_TIME_EXPIRED;
107 if (PREDICT_FALSE (ip[3]->ttl < 1))
108 error3 = IP4_ERROR_TIME_EXPIRED;
110 /* Drop fragmentation offset 1 packets. */
111 error0 = ip4_get_fragment_offset (ip[0]) == 1 ?
112 IP4_ERROR_FRAGMENT_OFFSET_ONE : error0;
113 error1 = ip4_get_fragment_offset (ip[1]) == 1 ?
114 IP4_ERROR_FRAGMENT_OFFSET_ONE : error1;
115 error2 = ip4_get_fragment_offset (ip[2]) == 1 ?
116 IP4_ERROR_FRAGMENT_OFFSET_ONE : error2;
117 error3 = ip4_get_fragment_offset (ip[3]) == 1 ?
118 IP4_ERROR_FRAGMENT_OFFSET_ONE : error3;
120 /* Verify lengths. */
121 ip_len0 = clib_net_to_host_u16 (ip[0]->length);
122 ip_len1 = clib_net_to_host_u16 (ip[1]->length);
123 ip_len2 = clib_net_to_host_u16 (ip[2]->length);
124 ip_len3 = clib_net_to_host_u16 (ip[3]->length);
126 /* IP length must be at least minimal IP header. */
127 error0 = ip_len0 < sizeof (ip[0][0]) ? IP4_ERROR_TOO_SHORT : error0;
128 error1 = ip_len1 < sizeof (ip[1][0]) ? IP4_ERROR_TOO_SHORT : error1;
129 error2 = ip_len2 < sizeof (ip[2][0]) ? IP4_ERROR_TOO_SHORT : error2;
130 error3 = ip_len3 < sizeof (ip[3][0]) ? IP4_ERROR_TOO_SHORT : error3;
132 cur_len0 = vlib_buffer_length_in_chain (vm, p[0]);
133 cur_len1 = vlib_buffer_length_in_chain (vm, p[1]);
134 cur_len2 = vlib_buffer_length_in_chain (vm, p[2]);
135 cur_len3 = vlib_buffer_length_in_chain (vm, p[3]);
137 len_diff0 = cur_len0 - ip_len0;
138 len_diff1 = cur_len1 - ip_len1;
139 len_diff2 = cur_len2 - ip_len2;
140 len_diff3 = cur_len3 - ip_len3;
142 error0 = len_diff0 < 0 ? IP4_ERROR_BAD_LENGTH : error0;
143 error1 = len_diff1 < 0 ? IP4_ERROR_BAD_LENGTH : error1;
144 error2 = len_diff2 < 0 ? IP4_ERROR_BAD_LENGTH : error2;
145 error3 = len_diff3 < 0 ? IP4_ERROR_BAD_LENGTH : error3;
147 if (PREDICT_FALSE (error0 != IP4_ERROR_NONE))
149 if (error0 == IP4_ERROR_TIME_EXPIRED)
151 icmp4_error_set_vnet_buffer (p[0], ICMP4_time_exceeded,
152 ICMP4_time_exceeded_ttl_exceeded_in_transit,
154 next[0] = IP4_INPUT_NEXT_ICMP_ERROR;
157 next[0] = error0 != IP4_ERROR_OPTIONS ?
158 IP4_INPUT_NEXT_DROP : IP4_INPUT_NEXT_OPTIONS;
159 p[0]->error = error_node->errors[error0];
161 if (PREDICT_FALSE (error1 != IP4_ERROR_NONE))
163 if (error1 == IP4_ERROR_TIME_EXPIRED)
165 icmp4_error_set_vnet_buffer (p[1], ICMP4_time_exceeded,
166 ICMP4_time_exceeded_ttl_exceeded_in_transit,
168 next[1] = IP4_INPUT_NEXT_ICMP_ERROR;
171 next[1] = error1 != IP4_ERROR_OPTIONS ?
172 IP4_INPUT_NEXT_DROP : IP4_INPUT_NEXT_OPTIONS;
173 p[1]->error = error_node->errors[error1];
175 if (PREDICT_FALSE (error2 != IP4_ERROR_NONE))
177 if (error2 == IP4_ERROR_TIME_EXPIRED)
179 icmp4_error_set_vnet_buffer (p[2], ICMP4_time_exceeded,
180 ICMP4_time_exceeded_ttl_exceeded_in_transit,
182 next[2] = IP4_INPUT_NEXT_ICMP_ERROR;
185 next[2] = error2 != IP4_ERROR_OPTIONS ?
186 IP4_INPUT_NEXT_DROP : IP4_INPUT_NEXT_OPTIONS;
187 p[2]->error = error_node->errors[error2];
189 if (PREDICT_FALSE (error3 != IP4_ERROR_NONE))
191 if (error3 == IP4_ERROR_TIME_EXPIRED)
193 icmp4_error_set_vnet_buffer (p[3], ICMP4_time_exceeded,
194 ICMP4_time_exceeded_ttl_exceeded_in_transit,
196 next[3] = IP4_INPUT_NEXT_ICMP_ERROR;
199 next[3] = error3 != IP4_ERROR_OPTIONS ?
200 IP4_INPUT_NEXT_DROP : IP4_INPUT_NEXT_OPTIONS;
201 p[3]->error = error_node->errors[error3];
206 ip4_input_check_x2 (vlib_main_t * vm,
207 vlib_node_runtime_t * error_node,
208 vlib_buffer_t * p0, vlib_buffer_t * p1,
209 ip4_header_t * ip0, ip4_header_t * ip1,
210 u32 * next0, u32 * next1, int verify_checksum)
213 u32 ip_len0, cur_len0;
214 u32 ip_len1, cur_len1;
215 i32 len_diff0, len_diff1;
217 error0 = error1 = IP4_ERROR_NONE;
219 check_ver_opt_csum (ip0, &error0, verify_checksum);
220 check_ver_opt_csum (ip1, &error1, verify_checksum);
222 if (PREDICT_FALSE (ip0->ttl < 1))
223 error0 = IP4_ERROR_TIME_EXPIRED;
224 if (PREDICT_FALSE (ip1->ttl < 1))
225 error1 = IP4_ERROR_TIME_EXPIRED;
227 /* Drop fragmentation offset 1 packets. */
228 error0 = ip4_get_fragment_offset (ip0) == 1 ?
229 IP4_ERROR_FRAGMENT_OFFSET_ONE : error0;
230 error1 = ip4_get_fragment_offset (ip1) == 1 ?
231 IP4_ERROR_FRAGMENT_OFFSET_ONE : error1;
233 /* Verify lengths. */
234 ip_len0 = clib_net_to_host_u16 (ip0->length);
235 ip_len1 = clib_net_to_host_u16 (ip1->length);
237 /* IP length must be at least minimal IP header. */
238 error0 = ip_len0 < sizeof (ip0[0]) ? IP4_ERROR_TOO_SHORT : error0;
239 error1 = ip_len1 < sizeof (ip1[0]) ? IP4_ERROR_TOO_SHORT : error1;
241 cur_len0 = vlib_buffer_length_in_chain (vm, p0);
242 cur_len1 = vlib_buffer_length_in_chain (vm, p1);
244 len_diff0 = cur_len0 - ip_len0;
245 len_diff1 = cur_len1 - ip_len1;
247 error0 = len_diff0 < 0 ? IP4_ERROR_BAD_LENGTH : error0;
248 error1 = len_diff1 < 0 ? IP4_ERROR_BAD_LENGTH : error1;
250 if (PREDICT_FALSE (error0 != IP4_ERROR_NONE))
252 if (error0 == IP4_ERROR_TIME_EXPIRED)
254 icmp4_error_set_vnet_buffer (p0, ICMP4_time_exceeded,
255 ICMP4_time_exceeded_ttl_exceeded_in_transit,
257 *next0 = IP4_INPUT_NEXT_ICMP_ERROR;
260 *next0 = error0 != IP4_ERROR_OPTIONS ?
261 IP4_INPUT_NEXT_DROP : IP4_INPUT_NEXT_OPTIONS;
262 p0->error = error_node->errors[error0];
264 if (PREDICT_FALSE (error1 != IP4_ERROR_NONE))
266 if (error1 == IP4_ERROR_TIME_EXPIRED)
268 icmp4_error_set_vnet_buffer (p1, ICMP4_time_exceeded,
269 ICMP4_time_exceeded_ttl_exceeded_in_transit,
271 *next1 = IP4_INPUT_NEXT_ICMP_ERROR;
274 *next1 = error1 != IP4_ERROR_OPTIONS ?
275 IP4_INPUT_NEXT_DROP : IP4_INPUT_NEXT_OPTIONS;
276 p1->error = error_node->errors[error1];
281 ip4_input_check_x1 (vlib_main_t * vm,
282 vlib_node_runtime_t * error_node,
284 ip4_header_t * ip0, u32 * next0, int verify_checksum)
286 u32 ip_len0, cur_len0;
290 error0 = IP4_ERROR_NONE;
292 check_ver_opt_csum (ip0, &error0, verify_checksum);
294 if (PREDICT_FALSE (ip0->ttl < 1))
295 error0 = IP4_ERROR_TIME_EXPIRED;
297 /* Drop fragmentation offset 1 packets. */
298 error0 = ip4_get_fragment_offset (ip0) == 1 ?
299 IP4_ERROR_FRAGMENT_OFFSET_ONE : error0;
301 /* Verify lengths. */
302 ip_len0 = clib_net_to_host_u16 (ip0->length);
304 /* IP length must be at least minimal IP header. */
305 error0 = ip_len0 < sizeof (ip0[0]) ? IP4_ERROR_TOO_SHORT : error0;
307 cur_len0 = vlib_buffer_length_in_chain (vm, p0);
309 len_diff0 = cur_len0 - ip_len0;
311 error0 = len_diff0 < 0 ? IP4_ERROR_BAD_LENGTH : error0;
313 if (PREDICT_FALSE (error0 != IP4_ERROR_NONE))
315 if (error0 == IP4_ERROR_TIME_EXPIRED)
317 icmp4_error_set_vnet_buffer (p0, ICMP4_time_exceeded,
318 ICMP4_time_exceeded_ttl_exceeded_in_transit,
320 *next0 = IP4_INPUT_NEXT_ICMP_ERROR;
323 *next0 = error0 != IP4_ERROR_OPTIONS ?
324 IP4_INPUT_NEXT_DROP : IP4_INPUT_NEXT_OPTIONS;
325 p0->error = error_node->errors[error0];
330 * fd.io coding-style-patch-verification: ON
333 * eval: (c-set-style "gnu")