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>
50 #ifndef CLIB_MARCH_VARIANT
52 format_ip4_input_trace (u8 * s, va_list * va)
54 CLIB_UNUSED (vlib_main_t * vm) = va_arg (*va, vlib_main_t *);
55 CLIB_UNUSED (vlib_node_t * node) = va_arg (*va, vlib_node_t *);
56 ip4_input_trace_t *t = va_arg (*va, ip4_input_trace_t *);
59 format_ip4_header, t->packet_data, sizeof (t->packet_data));
65 static_always_inline u32
66 ip4_input_set_next (u32 sw_if_index, vlib_buffer_t * b, int arc_enabled)
68 ip4_main_t *im = &ip4_main;
69 ip_lookup_main_t *lm = &im->lookup_main;
73 ip4_header_t *ip = vlib_buffer_get_current (b);
75 if (PREDICT_FALSE (ip4_address_is_multicast (&ip->dst_address)))
77 next = IP4_INPUT_NEXT_LOOKUP_MULTICAST;
78 arc = lm->mcast_feature_arc_index;
82 next = IP4_INPUT_NEXT_LOOKUP;
83 arc = lm->ucast_feature_arc_index;
87 vnet_feature_arc_start (arc, sw_if_index, &next, b);
92 static_always_inline void
93 ip4_input_check_sw_if_index (vlib_main_t * vm,
94 vlib_simple_counter_main_t * cm, u32 sw_if_index,
95 u32 * last_sw_if_index, u32 * cnt,
98 ip4_main_t *im = &ip4_main;
99 ip_lookup_main_t *lm = &im->lookup_main;
101 if (*last_sw_if_index == sw_if_index)
107 thread_index = vm->thread_index;
109 vlib_increment_simple_counter (cm, thread_index, *last_sw_if_index, *cnt);
111 *last_sw_if_index = sw_if_index;
113 if (vnet_have_features (lm->ucast_feature_arc_index, sw_if_index) ||
114 vnet_have_features (lm->mcast_feature_arc_index, sw_if_index))
120 /* Validate IP v4 packets and pass them either to forwarding code
121 or drop/punt exception packets. */
123 ip4_input_inline (vlib_main_t * vm,
124 vlib_node_runtime_t * node,
125 vlib_frame_t * frame, int verify_checksum)
127 vnet_main_t *vnm = vnet_get_main ();
128 u32 n_left_from, *from;
129 u32 thread_index = vm->thread_index;
130 vlib_node_runtime_t *error_node =
131 vlib_node_get_runtime (vm, ip4_input_node.index);
132 vlib_simple_counter_main_t *cm;
133 vlib_buffer_t *bufs[VLIB_FRAME_SIZE], **b;
135 u16 nexts[VLIB_FRAME_SIZE], *next;
137 u32 last_sw_if_index = ~0;
141 from = vlib_frame_vector_args (frame);
142 n_left_from = frame->n_vectors;
144 if (node->flags & VLIB_NODE_FLAG_TRACE)
145 vlib_trace_frame_buffers_only (vm, node, from, frame->n_vectors,
147 sizeof (ip4_input_trace_t));
149 cm = vec_elt_at_index (vnm->interface_main.sw_if_counters,
150 VNET_INTERFACE_COUNTER_IP4);
152 vlib_get_buffers (vm, from, bufs, n_left_from);
155 while (n_left_from >= 4)
159 /* Prefetch next iteration. */
160 if (n_left_from >= 12)
162 vlib_prefetch_buffer_header (b[8], LOAD);
163 vlib_prefetch_buffer_header (b[9], LOAD);
164 vlib_prefetch_buffer_header (b[10], LOAD);
165 vlib_prefetch_buffer_header (b[11], LOAD);
167 CLIB_PREFETCH (b[4]->data, sizeof (ip4_header_t), LOAD);
168 CLIB_PREFETCH (b[5]->data, sizeof (ip4_header_t), LOAD);
169 CLIB_PREFETCH (b[6]->data, sizeof (ip4_header_t), LOAD);
170 CLIB_PREFETCH (b[7]->data, sizeof (ip4_header_t), LOAD);
173 vnet_buffer (b[0])->ip.adj_index[VLIB_RX] = ~0;
174 vnet_buffer (b[1])->ip.adj_index[VLIB_RX] = ~0;
175 vnet_buffer (b[2])->ip.adj_index[VLIB_RX] = ~0;
176 vnet_buffer (b[3])->ip.adj_index[VLIB_RX] = ~0;
178 sw_if_index[0] = vnet_buffer (b[0])->sw_if_index[VLIB_RX];
179 sw_if_index[1] = vnet_buffer (b[1])->sw_if_index[VLIB_RX];
180 sw_if_index[2] = vnet_buffer (b[2])->sw_if_index[VLIB_RX];
181 sw_if_index[3] = vnet_buffer (b[3])->sw_if_index[VLIB_RX];
183 x |= sw_if_index[0] ^ last_sw_if_index;
184 x |= sw_if_index[1] ^ last_sw_if_index;
185 x |= sw_if_index[2] ^ last_sw_if_index;
186 x |= sw_if_index[3] ^ last_sw_if_index;
188 if (PREDICT_TRUE (x == 0))
190 /* we deal with 4 more packets sharing the same sw_if_index
191 with the previous one, so we can optimize */
195 next[0] = ip4_input_set_next (sw_if_index[0], b[0], 1);
196 next[1] = ip4_input_set_next (sw_if_index[1], b[1], 1);
197 next[2] = ip4_input_set_next (sw_if_index[2], b[2], 1);
198 next[3] = ip4_input_set_next (sw_if_index[3], b[3], 1);
202 next[0] = ip4_input_set_next (sw_if_index[0], b[0], 0);
203 next[1] = ip4_input_set_next (sw_if_index[1], b[1], 0);
204 next[2] = ip4_input_set_next (sw_if_index[2], b[2], 0);
205 next[3] = ip4_input_set_next (sw_if_index[3], b[3], 0);
210 ip4_input_check_sw_if_index (vm, cm, sw_if_index[0],
211 &last_sw_if_index, &cnt, &arc_enabled);
212 ip4_input_check_sw_if_index (vm, cm, sw_if_index[1],
213 &last_sw_if_index, &cnt, &arc_enabled);
214 ip4_input_check_sw_if_index (vm, cm, sw_if_index[2],
215 &last_sw_if_index, &cnt, &arc_enabled);
216 ip4_input_check_sw_if_index (vm, cm, sw_if_index[3],
217 &last_sw_if_index, &cnt, &arc_enabled);
219 next[0] = ip4_input_set_next (sw_if_index[0], b[0], 1);
220 next[1] = ip4_input_set_next (sw_if_index[1], b[1], 1);
221 next[2] = ip4_input_set_next (sw_if_index[2], b[2], 1);
222 next[3] = ip4_input_set_next (sw_if_index[3], b[3], 1);
225 ip[0] = vlib_buffer_get_current (b[0]);
226 ip[1] = vlib_buffer_get_current (b[1]);
227 ip[2] = vlib_buffer_get_current (b[2]);
228 ip[3] = vlib_buffer_get_current (b[3]);
230 ip4_input_check_x4 (vm, error_node, b, ip, next, verify_checksum);
240 vnet_buffer (b[0])->ip.adj_index[VLIB_RX] = ~0;
241 sw_if_index[0] = vnet_buffer (b[0])->sw_if_index[VLIB_RX];
242 ip4_input_check_sw_if_index (vm, cm, sw_if_index[0], &last_sw_if_index,
244 next0 = ip4_input_set_next (sw_if_index[0], b[0], arc_enabled);
245 ip[0] = vlib_buffer_get_current (b[0]);
246 ip4_input_check_x1 (vm, error_node, b[0], ip[0], &next0,
256 vlib_increment_simple_counter (cm, thread_index, last_sw_if_index, cnt);
257 vlib_buffer_enqueue_to_next (vm, node, from, nexts, frame->n_vectors);
258 return frame->n_vectors;
261 /** \brief IPv4 input node.
264 This is the IPv4 input node: validates ip4 header checksums,
265 verifies ip header lengths, discards pkts with expired TTLs,
266 and sends pkts to the set of ip feature nodes configured on
269 @param vm vlib_main_t corresponding to the current thread
270 @param node vlib_node_runtime_t
271 @param frame vlib_frame_t whose contents should be dispatched
273 @par Graph mechanics: buffer metadata, next index usage
276 - vnet_feature_config_main_t cm corresponding to each pkt's dst address unicast /
278 - <code>b->current_config_index</code> corresponding to each pkt's
280 - This sets the per-packet graph trajectory, ensuring that
281 each packet visits the per-interface features in order.
283 - <code>vnet_buffer(b)->sw_if_index[VLIB_RX]</code>
284 - Indicates the @c sw_if_index value of the interface that the
285 packet was received on.
288 - <code>vnet_buffer(b)->ip.adj_index[VLIB_TX]</code>
289 - The lookup result adjacency index.
291 <em>Next Indices:</em>
292 - Dispatches pkts to the (first) feature node:
293 <code> vnet_get_config_data (... &next0 ...); </code>
296 VLIB_NODE_FN (ip4_input_node) (vlib_main_t * vm, vlib_node_runtime_t * node,
297 vlib_frame_t * frame)
299 return ip4_input_inline (vm, node, frame, /* verify_checksum */ 1);
302 VLIB_NODE_FN (ip4_input_no_checksum_node) (vlib_main_t * vm,
303 vlib_node_runtime_t * node,
304 vlib_frame_t * frame)
306 return ip4_input_inline (vm, node, frame, /* verify_checksum */ 0);
309 #ifndef CLIB_MARCH_VARIANT
310 char *ip4_error_strings[] = {
311 #define _(sym,string) string,
317 VLIB_REGISTER_NODE (ip4_input_node) = {
319 .vector_size = sizeof (u32),
321 .n_errors = IP4_N_ERROR,
322 .error_strings = ip4_error_strings,
324 .n_next_nodes = IP4_INPUT_N_NEXT,
326 [IP4_INPUT_NEXT_DROP] = "error-drop",
327 [IP4_INPUT_NEXT_PUNT] = "error-punt",
328 [IP4_INPUT_NEXT_OPTIONS] = "ip4-options",
329 [IP4_INPUT_NEXT_LOOKUP] = "ip4-lookup",
330 [IP4_INPUT_NEXT_LOOKUP_MULTICAST] = "ip4-mfib-forward-lookup",
331 [IP4_INPUT_NEXT_ICMP_ERROR] = "ip4-icmp-error",
332 [IP4_INPUT_NEXT_REASSEMBLY] = "ip4-reassembly",
335 .format_buffer = format_ip4_header,
336 .format_trace = format_ip4_input_trace,
339 VLIB_REGISTER_NODE (ip4_input_no_checksum_node) = {
340 .name = "ip4-input-no-checksum",
341 .vector_size = sizeof (u32),
343 .sibling_of = "ip4-input",
344 .format_buffer = format_ip4_header,
345 .format_trace = format_ip4_input_trace,
349 static clib_error_t *
350 ip4_init (vlib_main_t * vm)
354 ethernet_register_input_type (vm, ETHERNET_TYPE_IP4, ip4_input_node.index);
355 ppp_register_input_protocol (vm, PPP_PROTOCOL_ip4, ip4_input_node.index);
356 hdlc_register_input_protocol (vm, HDLC_PROTOCOL_ip4, ip4_input_node.index);
360 pn = pg_get_node (ip4_input_node.index);
361 pn->unformat_edit = unformat_pg_ip4_header;
362 pn = pg_get_node (ip4_input_no_checksum_node.index);
363 pn->unformat_edit = unformat_pg_ip4_header;
366 if ((error = vlib_call_init_function (vm, ip4_cli_init)))
369 if ((error = vlib_call_init_function (vm, ip4_source_check_init)))
372 if ((error = vlib_call_init_function
373 (vm, ip4_source_and_port_range_check_init)))
376 /* Set flow hash to something non-zero. */
377 ip4_main.flow_hash_seed = 0xdeadbeef;
379 /* Default TTL for packets we generate. */
380 ip4_main.host_config.ttl = 64;
385 VLIB_INIT_FUNCTION (ip4_init);
387 static clib_error_t *
388 ip4_main_loop_enter (vlib_main_t * vm)
390 ip4_main_t *im = &ip4_main;
391 vlib_thread_main_t *tm = &vlib_thread_main;
392 u32 n_vlib_mains = tm->n_vlib_mains;
396 vec_validate (im->arp_throttle_bitmaps, n_vlib_mains);
397 vec_validate (im->arp_throttle_seeds, n_vlib_mains);
398 vec_validate (im->arp_throttle_last_seed_change_time, n_vlib_mains);
400 for (i = 0; i < n_vlib_mains; i++)
401 vec_validate (im->arp_throttle_bitmaps[i],
402 (ARP_THROTTLE_BITS / BITS (uword)) - 1);
406 VLIB_MAIN_LOOP_ENTER_FUNCTION (ip4_main_loop_enter);
411 * fd.io coding-style-patch-verification: ON
414 * eval: (c-set-style "gnu")