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 & 0xf) != 5)
65 *error = IP4_ERROR_OPTIONS;
66 if (verify_checksum &&
67 clib_ip_csum ((u8 *) ip, ip4_header_bytes (ip)) != 0)
68 *error = IP4_ERROR_BAD_CHECKSUM;
71 *error = IP4_ERROR_VERSION;
73 else if (PREDICT_FALSE (verify_checksum &&
74 clib_ip_csum ((u8 *) ip, sizeof (ip4_header_t)) !=
76 *error = IP4_ERROR_BAD_CHECKSUM;
80 ip4_input_check_x4 (vlib_main_t * vm,
81 vlib_node_runtime_t * error_node,
82 vlib_buffer_t ** p, ip4_header_t ** ip,
83 u16 * next, int verify_checksum)
85 u8 error0, error1, error2, error3;
86 u32 ip_len0, cur_len0;
87 u32 ip_len1, cur_len1;
88 u32 ip_len2, cur_len2;
89 u32 ip_len3, cur_len3;
90 i32 len_diff0, len_diff1, len_diff2, len_diff3;
92 error0 = error1 = error2 = error3 = IP4_ERROR_NONE;
94 check_ver_opt_csum (ip[0], &error0, verify_checksum);
95 check_ver_opt_csum (ip[1], &error1, verify_checksum);
96 check_ver_opt_csum (ip[2], &error2, verify_checksum);
97 check_ver_opt_csum (ip[3], &error3, verify_checksum);
99 if (PREDICT_FALSE (ip[0]->ttl < 1))
100 error0 = IP4_ERROR_TIME_EXPIRED;
101 if (PREDICT_FALSE (ip[1]->ttl < 1))
102 error1 = IP4_ERROR_TIME_EXPIRED;
103 if (PREDICT_FALSE (ip[2]->ttl < 1))
104 error2 = IP4_ERROR_TIME_EXPIRED;
105 if (PREDICT_FALSE (ip[3]->ttl < 1))
106 error3 = IP4_ERROR_TIME_EXPIRED;
108 /* Drop fragmentation offset 1 packets. */
109 error0 = ip4_get_fragment_offset (ip[0]) == 1 ?
110 IP4_ERROR_FRAGMENT_OFFSET_ONE : error0;
111 error1 = ip4_get_fragment_offset (ip[1]) == 1 ?
112 IP4_ERROR_FRAGMENT_OFFSET_ONE : error1;
113 error2 = ip4_get_fragment_offset (ip[2]) == 1 ?
114 IP4_ERROR_FRAGMENT_OFFSET_ONE : error2;
115 error3 = ip4_get_fragment_offset (ip[3]) == 1 ?
116 IP4_ERROR_FRAGMENT_OFFSET_ONE : error3;
118 /* Verify lengths. */
119 ip_len0 = clib_net_to_host_u16 (ip[0]->length);
120 ip_len1 = clib_net_to_host_u16 (ip[1]->length);
121 ip_len2 = clib_net_to_host_u16 (ip[2]->length);
122 ip_len3 = clib_net_to_host_u16 (ip[3]->length);
124 /* IP length must be at least minimal IP header. */
125 error0 = ip_len0 < sizeof (ip[0][0]) ? IP4_ERROR_TOO_SHORT : error0;
126 error1 = ip_len1 < sizeof (ip[1][0]) ? IP4_ERROR_TOO_SHORT : error1;
127 error2 = ip_len2 < sizeof (ip[2][0]) ? IP4_ERROR_TOO_SHORT : error2;
128 error3 = ip_len3 < sizeof (ip[3][0]) ? IP4_ERROR_TOO_SHORT : error3;
130 cur_len0 = vlib_buffer_length_in_chain (vm, p[0]);
131 cur_len1 = vlib_buffer_length_in_chain (vm, p[1]);
132 cur_len2 = vlib_buffer_length_in_chain (vm, p[2]);
133 cur_len3 = vlib_buffer_length_in_chain (vm, p[3]);
135 len_diff0 = cur_len0 - ip_len0;
136 len_diff1 = cur_len1 - ip_len1;
137 len_diff2 = cur_len2 - ip_len2;
138 len_diff3 = cur_len3 - ip_len3;
140 error0 = len_diff0 < 0 ? IP4_ERROR_BAD_LENGTH : error0;
141 error1 = len_diff1 < 0 ? IP4_ERROR_BAD_LENGTH : error1;
142 error2 = len_diff2 < 0 ? IP4_ERROR_BAD_LENGTH : error2;
143 error3 = len_diff3 < 0 ? IP4_ERROR_BAD_LENGTH : error3;
145 if (PREDICT_FALSE (error0 != IP4_ERROR_NONE))
147 if (error0 == IP4_ERROR_TIME_EXPIRED)
149 icmp4_error_set_vnet_buffer (p[0], ICMP4_time_exceeded,
150 ICMP4_time_exceeded_ttl_exceeded_in_transit,
152 next[0] = IP4_INPUT_NEXT_ICMP_ERROR;
155 next[0] = error0 != IP4_ERROR_OPTIONS ?
156 IP4_INPUT_NEXT_DROP : IP4_INPUT_NEXT_OPTIONS;
157 p[0]->error = error_node->errors[error0];
159 if (PREDICT_FALSE (error1 != IP4_ERROR_NONE))
161 if (error1 == IP4_ERROR_TIME_EXPIRED)
163 icmp4_error_set_vnet_buffer (p[1], ICMP4_time_exceeded,
164 ICMP4_time_exceeded_ttl_exceeded_in_transit,
166 next[1] = IP4_INPUT_NEXT_ICMP_ERROR;
169 next[1] = error1 != IP4_ERROR_OPTIONS ?
170 IP4_INPUT_NEXT_DROP : IP4_INPUT_NEXT_OPTIONS;
171 p[1]->error = error_node->errors[error1];
173 if (PREDICT_FALSE (error2 != IP4_ERROR_NONE))
175 if (error2 == IP4_ERROR_TIME_EXPIRED)
177 icmp4_error_set_vnet_buffer (p[2], ICMP4_time_exceeded,
178 ICMP4_time_exceeded_ttl_exceeded_in_transit,
180 next[2] = IP4_INPUT_NEXT_ICMP_ERROR;
183 next[2] = error2 != IP4_ERROR_OPTIONS ?
184 IP4_INPUT_NEXT_DROP : IP4_INPUT_NEXT_OPTIONS;
185 p[2]->error = error_node->errors[error2];
187 if (PREDICT_FALSE (error3 != IP4_ERROR_NONE))
189 if (error3 == IP4_ERROR_TIME_EXPIRED)
191 icmp4_error_set_vnet_buffer (p[3], ICMP4_time_exceeded,
192 ICMP4_time_exceeded_ttl_exceeded_in_transit,
194 next[3] = IP4_INPUT_NEXT_ICMP_ERROR;
197 next[3] = error3 != IP4_ERROR_OPTIONS ?
198 IP4_INPUT_NEXT_DROP : IP4_INPUT_NEXT_OPTIONS;
199 p[3]->error = error_node->errors[error3];
204 ip4_input_check_x2 (vlib_main_t * vm,
205 vlib_node_runtime_t * error_node,
206 vlib_buffer_t * p0, vlib_buffer_t * p1,
207 ip4_header_t * ip0, ip4_header_t * ip1,
208 u32 * next0, u32 * next1, int verify_checksum)
211 u32 ip_len0, cur_len0;
212 u32 ip_len1, cur_len1;
213 i32 len_diff0, len_diff1;
215 error0 = error1 = IP4_ERROR_NONE;
217 check_ver_opt_csum (ip0, &error0, verify_checksum);
218 check_ver_opt_csum (ip1, &error1, verify_checksum);
220 if (PREDICT_FALSE (ip0->ttl < 1))
221 error0 = IP4_ERROR_TIME_EXPIRED;
222 if (PREDICT_FALSE (ip1->ttl < 1))
223 error1 = IP4_ERROR_TIME_EXPIRED;
225 /* Drop fragmentation offset 1 packets. */
226 error0 = ip4_get_fragment_offset (ip0) == 1 ?
227 IP4_ERROR_FRAGMENT_OFFSET_ONE : error0;
228 error1 = ip4_get_fragment_offset (ip1) == 1 ?
229 IP4_ERROR_FRAGMENT_OFFSET_ONE : error1;
231 /* Verify lengths. */
232 ip_len0 = clib_net_to_host_u16 (ip0->length);
233 ip_len1 = clib_net_to_host_u16 (ip1->length);
235 /* IP length must be at least minimal IP header. */
236 error0 = ip_len0 < sizeof (ip0[0]) ? IP4_ERROR_TOO_SHORT : error0;
237 error1 = ip_len1 < sizeof (ip1[0]) ? IP4_ERROR_TOO_SHORT : error1;
239 cur_len0 = vlib_buffer_length_in_chain (vm, p0);
240 cur_len1 = vlib_buffer_length_in_chain (vm, p1);
242 len_diff0 = cur_len0 - ip_len0;
243 len_diff1 = cur_len1 - ip_len1;
245 error0 = len_diff0 < 0 ? IP4_ERROR_BAD_LENGTH : error0;
246 error1 = len_diff1 < 0 ? IP4_ERROR_BAD_LENGTH : error1;
248 if (PREDICT_FALSE (error0 != IP4_ERROR_NONE))
250 if (error0 == IP4_ERROR_TIME_EXPIRED)
252 icmp4_error_set_vnet_buffer (p0, ICMP4_time_exceeded,
253 ICMP4_time_exceeded_ttl_exceeded_in_transit,
255 *next0 = IP4_INPUT_NEXT_ICMP_ERROR;
258 *next0 = error0 != IP4_ERROR_OPTIONS ?
259 IP4_INPUT_NEXT_DROP : IP4_INPUT_NEXT_OPTIONS;
260 p0->error = error_node->errors[error0];
262 if (PREDICT_FALSE (error1 != IP4_ERROR_NONE))
264 if (error1 == IP4_ERROR_TIME_EXPIRED)
266 icmp4_error_set_vnet_buffer (p1, ICMP4_time_exceeded,
267 ICMP4_time_exceeded_ttl_exceeded_in_transit,
269 *next1 = IP4_INPUT_NEXT_ICMP_ERROR;
272 *next1 = error1 != IP4_ERROR_OPTIONS ?
273 IP4_INPUT_NEXT_DROP : IP4_INPUT_NEXT_OPTIONS;
274 p1->error = error_node->errors[error1];
279 ip4_input_check_x1 (vlib_main_t * vm,
280 vlib_node_runtime_t * error_node,
282 ip4_header_t * ip0, u32 * next0, int verify_checksum)
284 u32 ip_len0, cur_len0;
288 error0 = IP4_ERROR_NONE;
290 check_ver_opt_csum (ip0, &error0, verify_checksum);
292 if (PREDICT_FALSE (ip0->ttl < 1))
293 error0 = IP4_ERROR_TIME_EXPIRED;
295 /* Drop fragmentation offset 1 packets. */
296 error0 = ip4_get_fragment_offset (ip0) == 1 ?
297 IP4_ERROR_FRAGMENT_OFFSET_ONE : error0;
299 /* Verify lengths. */
300 ip_len0 = clib_net_to_host_u16 (ip0->length);
302 /* IP length must be at least minimal IP header. */
303 error0 = ip_len0 < sizeof (ip0[0]) ? IP4_ERROR_TOO_SHORT : error0;
305 cur_len0 = vlib_buffer_length_in_chain (vm, p0);
307 len_diff0 = cur_len0 - ip_len0;
309 error0 = len_diff0 < 0 ? IP4_ERROR_BAD_LENGTH : error0;
311 if (PREDICT_FALSE (error0 != IP4_ERROR_NONE))
313 if (error0 == IP4_ERROR_TIME_EXPIRED)
315 icmp4_error_set_vnet_buffer (p0, ICMP4_time_exceeded,
316 ICMP4_time_exceeded_ttl_exceeded_in_transit,
318 *next0 = IP4_INPUT_NEXT_ICMP_ERROR;
321 *next0 = error0 != IP4_ERROR_OPTIONS ?
322 IP4_INPUT_NEXT_DROP : IP4_INPUT_NEXT_OPTIONS;
323 p0->error = error_node->errors[error0];
328 * fd.io coding-style-patch-verification: ON
331 * eval: (c-set-style "gnu")