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/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 #include <vnet/ip/ip.h>
41 #include <vnet/ethernet/ethernet.h>
42 #include <vnet/ppp/ppp.h>
43 #include <vnet/hdlc/hdlc.h>
49 static u8 * format_ip4_input_trace (u8 * s, va_list * va)
51 CLIB_UNUSED (vlib_main_t * vm) = va_arg (*va, vlib_main_t *);
52 CLIB_UNUSED (vlib_node_t * node) = va_arg (*va, vlib_node_t *);
53 ip4_input_trace_t * t = va_arg (*va, ip4_input_trace_t *);
57 t->packet_data, sizeof (t->packet_data));
65 IP4_INPUT_NEXT_LOOKUP,
66 IP4_INPUT_NEXT_LOOKUP_MULTICAST,
67 IP4_INPUT_NEXT_ICMP_ERROR,
71 /* Validate IP v4 packets and pass them either to forwarding code
72 or drop/punt exception packets. */
74 ip4_input_inline (vlib_main_t * vm,
75 vlib_node_runtime_t * node,
79 ip4_main_t * im = &ip4_main;
80 vnet_main_t * vnm = vnet_get_main();
81 ip_lookup_main_t * lm = &im->lookup_main;
82 u32 n_left_from, * from, * to_next;
83 ip4_input_next_t next_index;
84 vlib_node_runtime_t * error_node = vlib_node_get_runtime (vm, ip4_input_node.index);
85 vlib_simple_counter_main_t * cm;
86 u32 cpu_index = os_get_cpu_number();
88 from = vlib_frame_vector_args (frame);
89 n_left_from = frame->n_vectors;
90 next_index = node->cached_next_index;
92 if (node->flags & VLIB_NODE_FLAG_TRACE)
93 vlib_trace_frame_buffers_only (vm, node, from, frame->n_vectors,
95 sizeof (ip4_input_trace_t));
97 cm = vec_elt_at_index (vnm->interface_main.sw_if_counters,
98 VNET_INTERFACE_COUNTER_IP4);
100 while (n_left_from > 0)
104 vlib_get_next_frame (vm, node, next_index,
105 to_next, n_left_to_next);
107 while (n_left_from >= 4 && n_left_to_next >= 2)
109 vlib_buffer_t * p0, * p1;
110 ip4_header_t * ip0, * ip1;
111 ip_config_main_t * cm0, * cm1;
112 u32 sw_if_index0, pi0, ip_len0, cur_len0, next0;
113 u32 sw_if_index1, pi1, ip_len1, cur_len1, next1;
114 i32 len_diff0, len_diff1;
115 u8 error0, error1, cast0, cast1;
117 /* Prefetch next iteration. */
119 vlib_buffer_t * p2, * p3;
121 p2 = vlib_get_buffer (vm, from[2]);
122 p3 = vlib_get_buffer (vm, from[3]);
124 vlib_prefetch_buffer_header (p2, LOAD);
125 vlib_prefetch_buffer_header (p3, LOAD);
127 CLIB_PREFETCH (p2->data, sizeof (ip0[0]), LOAD);
128 CLIB_PREFETCH (p3->data, sizeof (ip1[0]), LOAD);
131 to_next[0] = pi0 = from[0];
132 to_next[1] = pi1 = from[1];
138 p0 = vlib_get_buffer (vm, pi0);
139 p1 = vlib_get_buffer (vm, pi1);
141 ip0 = vlib_buffer_get_current (p0);
142 ip1 = vlib_buffer_get_current (p1);
144 sw_if_index0 = vnet_buffer (p0)->sw_if_index[VLIB_RX];
145 sw_if_index1 = vnet_buffer (p1)->sw_if_index[VLIB_RX];
147 cast0 = ip4_address_is_multicast (&ip0->dst_address) ? VNET_MULTICAST : VNET_UNICAST;
148 cast1 = ip4_address_is_multicast (&ip1->dst_address) ? VNET_MULTICAST : VNET_UNICAST;
150 cm0 = lm->rx_config_mains + cast0;
151 cm1 = lm->rx_config_mains + cast1;
153 vnet_buffer (p0)->ip.current_config_index = vec_elt (cm0->config_index_by_sw_if_index, sw_if_index0);
154 vnet_buffer (p1)->ip.current_config_index = vec_elt (cm1->config_index_by_sw_if_index, sw_if_index1);
156 vnet_buffer (p0)->ip.adj_index[VLIB_RX] = ~0;
157 vnet_buffer (p1)->ip.adj_index[VLIB_RX] = ~0;
159 vnet_get_config_data (&cm0->config_main,
160 &vnet_buffer (p0)->ip.current_config_index,
162 /* # bytes of config data */ 0);
163 vnet_get_config_data (&cm1->config_main,
164 &vnet_buffer (p1)->ip.current_config_index,
166 /* # bytes of config data */ 0);
168 vlib_increment_simple_counter (cm, cpu_index, sw_if_index0, 1);
169 vlib_increment_simple_counter (cm, cpu_index, sw_if_index1, 1);
171 error0 = error1 = IP4_ERROR_NONE;
173 /* Punt packets with options. */
174 error0 = (ip0->ip_version_and_header_length & 0xf) != 5 ? IP4_ERROR_OPTIONS : error0;
175 error1 = (ip1->ip_version_and_header_length & 0xf) != 5 ? IP4_ERROR_OPTIONS : error1;
177 /* Version != 4? Drop it. */
178 error0 = (ip0->ip_version_and_header_length >> 4) != 4 ? IP4_ERROR_VERSION : error0;
179 error1 = (ip1->ip_version_and_header_length >> 4) != 4 ? IP4_ERROR_VERSION : error1;
181 /* Verify header checksum. */
184 ip_csum_t sum0, sum1;
186 ip4_partial_header_checksum_x1 (ip0, sum0);
187 ip4_partial_header_checksum_x1 (ip1, sum1);
189 error0 = 0xffff != ip_csum_fold (sum0) ? IP4_ERROR_BAD_CHECKSUM : error0;
190 error1 = 0xffff != ip_csum_fold (sum1) ? IP4_ERROR_BAD_CHECKSUM : error1;
193 /* Drop fragmentation offset 1 packets. */
194 error0 = ip4_get_fragment_offset (ip0) == 1 ? IP4_ERROR_FRAGMENT_OFFSET_ONE : error0;
195 error1 = ip4_get_fragment_offset (ip1) == 1 ? IP4_ERROR_FRAGMENT_OFFSET_ONE : error1;
197 /* TTL <= 1? Drop it. */
198 error0 = (ip0->ttl <= 1 && cast0 == VNET_UNICAST) ? IP4_ERROR_TIME_EXPIRED : error0;
199 error1 = (ip1->ttl <= 1 && cast1 == VNET_UNICAST) ? IP4_ERROR_TIME_EXPIRED : error1;
201 /* Verify lengths. */
202 ip_len0 = clib_net_to_host_u16 (ip0->length);
203 ip_len1 = clib_net_to_host_u16 (ip1->length);
205 /* IP length must be at least minimal IP header. */
206 error0 = ip_len0 < sizeof (ip0[0]) ? IP4_ERROR_TOO_SHORT : error0;
207 error1 = ip_len1 < sizeof (ip1[0]) ? IP4_ERROR_TOO_SHORT : error1;
209 cur_len0 = vlib_buffer_length_in_chain (vm, p0);
210 cur_len1 = vlib_buffer_length_in_chain (vm, p1);
212 len_diff0 = cur_len0 - ip_len0;
213 len_diff1 = cur_len1 - ip_len1;
215 error0 = len_diff0 < 0 ? IP4_ERROR_BAD_LENGTH : error0;
216 error1 = len_diff1 < 0 ? IP4_ERROR_BAD_LENGTH : error1;
218 p0->error = error_node->errors[error0];
219 p1->error = error_node->errors[error1];
221 if (PREDICT_FALSE(error0 != IP4_ERROR_NONE))
223 if (error0 == IP4_ERROR_TIME_EXPIRED) {
224 icmp4_error_set_vnet_buffer(p0, ICMP4_time_exceeded,
225 ICMP4_time_exceeded_ttl_exceeded_in_transit, 0);
226 next0 = IP4_INPUT_NEXT_ICMP_ERROR;
228 next0 = error0 != IP4_ERROR_OPTIONS ? IP4_INPUT_NEXT_DROP : IP4_INPUT_NEXT_PUNT;
230 if (PREDICT_FALSE(error1 != IP4_ERROR_NONE))
232 if (error1 == IP4_ERROR_TIME_EXPIRED) {
233 icmp4_error_set_vnet_buffer(p1, ICMP4_time_exceeded,
234 ICMP4_time_exceeded_ttl_exceeded_in_transit, 0);
235 next1 = IP4_INPUT_NEXT_ICMP_ERROR;
237 next1 = error1 != IP4_ERROR_OPTIONS ? IP4_INPUT_NEXT_DROP : IP4_INPUT_NEXT_PUNT;
240 vlib_validate_buffer_enqueue_x2 (vm, node, next_index,
241 to_next, n_left_to_next,
242 pi0, pi1, next0, next1);
244 while (n_left_from > 0 && n_left_to_next > 0)
248 ip_config_main_t * cm0;
249 u32 sw_if_index0, pi0, ip_len0, cur_len0, next0;
260 p0 = vlib_get_buffer (vm, pi0);
261 ip0 = vlib_buffer_get_current (p0);
263 sw_if_index0 = vnet_buffer (p0)->sw_if_index[VLIB_RX];
265 cast0 = ip4_address_is_multicast (&ip0->dst_address) ? VNET_MULTICAST : VNET_UNICAST;
266 cm0 = lm->rx_config_mains + cast0;
267 vnet_buffer (p0)->ip.current_config_index = vec_elt (cm0->config_index_by_sw_if_index, sw_if_index0);
268 vnet_buffer (p0)->ip.adj_index[VLIB_RX] = ~0;
269 vnet_get_config_data (&cm0->config_main,
270 &vnet_buffer (p0)->ip.current_config_index,
272 /* # bytes of config data */ 0);
274 vlib_increment_simple_counter (cm, cpu_index, sw_if_index0, 1);
276 error0 = IP4_ERROR_NONE;
278 /* Punt packets with options. */
279 error0 = (ip0->ip_version_and_header_length & 0xf) != 5 ? IP4_ERROR_OPTIONS : error0;
281 /* Version != 4? Drop it. */
282 error0 = (ip0->ip_version_and_header_length >> 4) != 4 ? IP4_ERROR_VERSION : error0;
284 /* Verify header checksum. */
289 ip4_partial_header_checksum_x1 (ip0, sum0);
290 error0 = 0xffff != ip_csum_fold (sum0) ? IP4_ERROR_BAD_CHECKSUM : error0;
293 /* Drop fragmentation offset 1 packets. */
294 error0 = ip4_get_fragment_offset (ip0) == 1 ? IP4_ERROR_FRAGMENT_OFFSET_ONE : error0;
296 /* TTL <= 1? Drop it. */
297 error0 = (ip0->ttl <= 1 && cast0 == VNET_UNICAST) ? IP4_ERROR_TIME_EXPIRED : 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);
306 len_diff0 = cur_len0 - ip_len0;
307 error0 = len_diff0 < 0 ? IP4_ERROR_BAD_LENGTH : error0;
309 p0->error = error_node->errors[error0];
310 if (PREDICT_FALSE(error0 != IP4_ERROR_NONE))
312 if (error0 == IP4_ERROR_TIME_EXPIRED) {
313 icmp4_error_set_vnet_buffer(p0, ICMP4_time_exceeded,
314 ICMP4_time_exceeded_ttl_exceeded_in_transit, 0);
315 next0 = IP4_INPUT_NEXT_ICMP_ERROR;
317 next0 = error0 != IP4_ERROR_OPTIONS ? IP4_INPUT_NEXT_DROP : IP4_INPUT_NEXT_PUNT;
320 vlib_validate_buffer_enqueue_x1 (vm, node, next_index,
321 to_next, n_left_to_next,
325 vlib_put_next_frame (vm, node, next_index, n_left_to_next);
328 return frame->n_vectors;
332 ip4_input (vlib_main_t * vm,
333 vlib_node_runtime_t * node,
334 vlib_frame_t * frame)
336 return ip4_input_inline (vm, node, frame, /* verify_checksum */ 1);
340 ip4_input_no_checksum (vlib_main_t * vm,
341 vlib_node_runtime_t * node,
342 vlib_frame_t * frame)
344 return ip4_input_inline (vm, node, frame, /* verify_checksum */ 0);
347 static char * ip4_error_strings[] = {
348 #define _(sym,string) string,
353 VLIB_REGISTER_NODE (ip4_input_node) = {
354 .function = ip4_input,
356 .vector_size = sizeof (u32),
358 .n_errors = IP4_N_ERROR,
359 .error_strings = ip4_error_strings,
361 .n_next_nodes = IP4_INPUT_N_NEXT,
363 [IP4_INPUT_NEXT_DROP] = "error-drop",
364 [IP4_INPUT_NEXT_PUNT] = "error-punt",
365 [IP4_INPUT_NEXT_LOOKUP] = "ip4-lookup",
366 [IP4_INPUT_NEXT_LOOKUP_MULTICAST] = "ip4-lookup-multicast",
367 [IP4_INPUT_NEXT_ICMP_ERROR] = "ip4-icmp-error",
370 .format_buffer = format_ip4_header,
371 .format_trace = format_ip4_input_trace,
374 VLIB_REGISTER_NODE (ip4_input_no_checksum_node,static) = {
375 .function = ip4_input_no_checksum,
376 .name = "ip4-input-no-checksum",
377 .vector_size = sizeof (u32),
379 .n_next_nodes = IP4_INPUT_N_NEXT,
381 [IP4_INPUT_NEXT_DROP] = "error-drop",
382 [IP4_INPUT_NEXT_PUNT] = "error-punt",
383 [IP4_INPUT_NEXT_LOOKUP] = "ip4-lookup",
384 [IP4_INPUT_NEXT_LOOKUP_MULTICAST] = "ip4-lookup-multicast",
385 [IP4_INPUT_NEXT_ICMP_ERROR] = "ip4-icmp-error",
388 .format_buffer = format_ip4_header,
389 .format_trace = format_ip4_input_trace,
392 static clib_error_t * ip4_init (vlib_main_t * vm)
394 clib_error_t * error;
396 ethernet_register_input_type (vm, ETHERNET_TYPE_IP4,
397 ip4_input_node.index);
398 ppp_register_input_protocol (vm, PPP_PROTOCOL_ip4,
399 ip4_input_node.index);
400 hdlc_register_input_protocol (vm, HDLC_PROTOCOL_ip4,
401 ip4_input_node.index);
405 pn = pg_get_node (ip4_input_node.index);
406 pn->unformat_edit = unformat_pg_ip4_header;
407 pn = pg_get_node (ip4_input_no_checksum_node.index);
408 pn->unformat_edit = unformat_pg_ip4_header;
411 if ((error = vlib_call_init_function (vm, ip4_cli_init)))
414 if ((error = vlib_call_init_function (vm, ip4_source_check_init)))
417 /* Set flow hash to something non-zero. */
418 ip4_main.flow_hash_seed = 0xdeadbeef;
420 /* Default TTL for packets we generate. */
421 ip4_main.host_config.ttl = 64;
426 VLIB_INIT_FUNCTION (ip4_init);