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/ip4_input.h>
41 #include <vnet/ethernet/ethernet.h>
42 #include <vnet/ppp/ppp.h>
43 #include <vnet/hdlc/hdlc.h>
51 format_ip4_input_trace (u8 * s, va_list * va)
53 CLIB_UNUSED (vlib_main_t * vm) = va_arg (*va, vlib_main_t *);
54 CLIB_UNUSED (vlib_node_t * node) = va_arg (*va, vlib_node_t *);
55 ip4_input_trace_t *t = va_arg (*va, ip4_input_trace_t *);
58 format_ip4_header, t->packet_data, sizeof (t->packet_data));
63 /* Validate IP v4 packets and pass them either to forwarding code
64 or drop/punt exception packets. */
66 ip4_input_inline (vlib_main_t * vm,
67 vlib_node_runtime_t * node,
68 vlib_frame_t * frame, int verify_checksum)
70 ip4_main_t *im = &ip4_main;
71 vnet_main_t *vnm = vnet_get_main ();
72 ip_lookup_main_t *lm = &im->lookup_main;
73 u32 n_left_from, *from, *to_next;
74 ip4_input_next_t next_index;
75 vlib_node_runtime_t *error_node =
76 vlib_node_get_runtime (vm, ip4_input_node.index);
77 vlib_simple_counter_main_t *cm;
78 u32 thread_index = vlib_get_thread_index ();
80 from = vlib_frame_vector_args (frame);
81 n_left_from = frame->n_vectors;
82 next_index = node->cached_next_index;
84 if (node->flags & VLIB_NODE_FLAG_TRACE)
85 vlib_trace_frame_buffers_only (vm, node, from, frame->n_vectors,
87 sizeof (ip4_input_trace_t));
89 cm = vec_elt_at_index (vnm->interface_main.sw_if_counters,
90 VNET_INTERFACE_COUNTER_IP4);
92 while (n_left_from > 0)
96 vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
98 while (n_left_from >= 4 && n_left_to_next >= 2)
100 vlib_buffer_t *p0, *p1;
101 ip4_header_t *ip0, *ip1;
102 u32 sw_if_index0, pi0, next0;
103 u32 sw_if_index1, pi1, next1;
106 /* Prefetch next iteration. */
108 vlib_buffer_t *p2, *p3;
110 p2 = vlib_get_buffer (vm, from[2]);
111 p3 = vlib_get_buffer (vm, from[3]);
113 vlib_prefetch_buffer_header (p2, LOAD);
114 vlib_prefetch_buffer_header (p3, LOAD);
116 CLIB_PREFETCH (p2->data, sizeof (ip0[0]), LOAD);
117 CLIB_PREFETCH (p3->data, sizeof (ip1[0]), LOAD);
120 to_next[0] = pi0 = from[0];
121 to_next[1] = pi1 = from[1];
127 p0 = vlib_get_buffer (vm, pi0);
128 p1 = vlib_get_buffer (vm, pi1);
130 ip0 = vlib_buffer_get_current (p0);
131 ip1 = vlib_buffer_get_current (p1);
133 sw_if_index0 = vnet_buffer (p0)->sw_if_index[VLIB_RX];
134 sw_if_index1 = vnet_buffer (p1)->sw_if_index[VLIB_RX];
136 if (PREDICT_FALSE (ip4_address_is_multicast (&ip0->dst_address)))
138 arc0 = lm->mcast_feature_arc_index;
139 next0 = IP4_INPUT_NEXT_LOOKUP_MULTICAST;
143 arc0 = lm->ucast_feature_arc_index;
144 next0 = IP4_INPUT_NEXT_LOOKUP;
147 if (PREDICT_FALSE (ip4_address_is_multicast (&ip1->dst_address)))
149 arc1 = lm->mcast_feature_arc_index;
150 next1 = IP4_INPUT_NEXT_LOOKUP_MULTICAST;
154 arc1 = lm->ucast_feature_arc_index;
155 next1 = IP4_INPUT_NEXT_LOOKUP;
158 vnet_buffer (p0)->ip.adj_index[VLIB_RX] = ~0;
159 vnet_buffer (p1)->ip.adj_index[VLIB_RX] = ~0;
161 vnet_feature_arc_start (arc0, sw_if_index0, &next0, p0);
162 vnet_feature_arc_start (arc1, sw_if_index1, &next1, p1);
164 vlib_increment_simple_counter (cm, thread_index, sw_if_index0, 1);
165 vlib_increment_simple_counter (cm, thread_index, sw_if_index1, 1);
166 ip4_input_check_x2 (vm, error_node,
168 &next0, &next1, verify_checksum);
170 vlib_validate_buffer_enqueue_x2 (vm, node, next_index,
171 to_next, n_left_to_next,
172 pi0, pi1, next0, next1);
174 while (n_left_from > 0 && n_left_to_next > 0)
178 u32 sw_if_index0, pi0, next0;
188 p0 = vlib_get_buffer (vm, pi0);
189 ip0 = vlib_buffer_get_current (p0);
191 sw_if_index0 = vnet_buffer (p0)->sw_if_index[VLIB_RX];
193 if (PREDICT_FALSE (ip4_address_is_multicast (&ip0->dst_address)))
195 arc0 = lm->mcast_feature_arc_index;
196 next0 = IP4_INPUT_NEXT_LOOKUP_MULTICAST;
200 arc0 = lm->ucast_feature_arc_index;
201 next0 = IP4_INPUT_NEXT_LOOKUP;
204 vnet_buffer (p0)->ip.adj_index[VLIB_RX] = ~0;
205 vnet_feature_arc_start (arc0, sw_if_index0, &next0, p0);
207 vlib_increment_simple_counter (cm, thread_index, sw_if_index0, 1);
208 ip4_input_check_x1 (vm, error_node, p0, ip0, &next0,
211 vlib_validate_buffer_enqueue_x1 (vm, node, next_index,
212 to_next, n_left_to_next,
216 vlib_put_next_frame (vm, node, next_index, n_left_to_next);
219 return frame->n_vectors;
222 /** \brief IPv4 input node.
225 This is the IPv4 input node: validates ip4 header checksums,
226 verifies ip header lengths, discards pkts with expired TTLs,
227 and sends pkts to the set of ip feature nodes configured on
230 @param vm vlib_main_t corresponding to the current thread
231 @param node vlib_node_runtime_t
232 @param frame vlib_frame_t whose contents should be dispatched
234 @par Graph mechanics: buffer metadata, next index usage
237 - vnet_feature_config_main_t cm corresponding to each pkt's dst address unicast /
239 - <code>b->current_config_index</code> corresponding to each pkt's
241 - This sets the per-packet graph trajectory, ensuring that
242 each packet visits the per-interface features in order.
244 - <code>vnet_buffer(b)->sw_if_index[VLIB_RX]</code>
245 - Indicates the @c sw_if_index value of the interface that the
246 packet was received on.
249 - <code>vnet_buffer(b)->ip.adj_index[VLIB_TX]</code>
250 - The lookup result adjacency index.
252 <em>Next Indices:</em>
253 - Dispatches pkts to the (first) feature node:
254 <code> vnet_get_config_data (... &next0 ...); </code>
258 ip4_input (vlib_main_t * vm, vlib_node_runtime_t * node, vlib_frame_t * frame)
260 return ip4_input_inline (vm, node, frame, /* verify_checksum */ 1);
264 ip4_input_no_checksum (vlib_main_t * vm,
265 vlib_node_runtime_t * node, vlib_frame_t * frame)
267 return ip4_input_inline (vm, node, frame, /* verify_checksum */ 0);
270 char *ip4_error_strings[] = {
271 #define _(sym,string) string,
277 VLIB_REGISTER_NODE (ip4_input_node) = {
278 .function = ip4_input,
280 .vector_size = sizeof (u32),
282 .n_errors = IP4_N_ERROR,
283 .error_strings = ip4_error_strings,
285 .n_next_nodes = IP4_INPUT_N_NEXT,
287 [IP4_INPUT_NEXT_DROP] = "error-drop",
288 [IP4_INPUT_NEXT_PUNT] = "error-punt",
289 [IP4_INPUT_NEXT_LOOKUP] = "ip4-lookup",
290 [IP4_INPUT_NEXT_LOOKUP_MULTICAST] = "ip4-mfib-forward-lookup",
291 [IP4_INPUT_NEXT_ICMP_ERROR] = "ip4-icmp-error",
292 [IP4_INPUT_NEXT_REASSEMBLY] = "ip4-reassembly",
295 .format_buffer = format_ip4_header,
296 .format_trace = format_ip4_input_trace,
300 VLIB_NODE_FUNCTION_MULTIARCH (ip4_input_node, ip4_input);
303 VLIB_REGISTER_NODE (ip4_input_no_checksum_node,static) = {
304 .function = ip4_input_no_checksum,
305 .name = "ip4-input-no-checksum",
306 .vector_size = sizeof (u32),
308 .n_next_nodes = IP4_INPUT_N_NEXT,
310 [IP4_INPUT_NEXT_DROP] = "error-drop",
311 [IP4_INPUT_NEXT_PUNT] = "error-punt",
312 [IP4_INPUT_NEXT_LOOKUP] = "ip4-lookup",
313 [IP4_INPUT_NEXT_LOOKUP_MULTICAST] = "ip4-mfib-forward-lookup",
314 [IP4_INPUT_NEXT_ICMP_ERROR] = "ip4-icmp-error",
315 [IP4_INPUT_NEXT_REASSEMBLY] = "ip4-reassembly",
318 .format_buffer = format_ip4_header,
319 .format_trace = format_ip4_input_trace,
323 VLIB_NODE_FUNCTION_MULTIARCH (ip4_input_no_checksum_node,
324 ip4_input_no_checksum);
326 static clib_error_t *
327 ip4_init (vlib_main_t * vm)
331 ethernet_register_input_type (vm, ETHERNET_TYPE_IP4, ip4_input_node.index);
332 ppp_register_input_protocol (vm, PPP_PROTOCOL_ip4, ip4_input_node.index);
333 hdlc_register_input_protocol (vm, HDLC_PROTOCOL_ip4, ip4_input_node.index);
337 pn = pg_get_node (ip4_input_node.index);
338 pn->unformat_edit = unformat_pg_ip4_header;
339 pn = pg_get_node (ip4_input_no_checksum_node.index);
340 pn->unformat_edit = unformat_pg_ip4_header;
343 if ((error = vlib_call_init_function (vm, ip4_cli_init)))
346 if ((error = vlib_call_init_function (vm, ip4_source_check_init)))
349 if ((error = vlib_call_init_function
350 (vm, ip4_source_and_port_range_check_init)))
353 /* Set flow hash to something non-zero. */
354 ip4_main.flow_hash_seed = 0xdeadbeef;
356 /* Default TTL for packets we generate. */
357 ip4_main.host_config.ttl = 64;
362 VLIB_INIT_FUNCTION (ip4_init);
365 * fd.io coding-style-patch-verification: ON
368 * eval: (c-set-style "gnu")