2 * Copyright (c) 2015-2019 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_forward.h: IP v4 forwarding
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_ip4_forward_h__
41 #define __included_ip4_forward_h__
43 #include <vppinfra/cache.h>
44 #include <vnet/fib/ip4_fib.h>
45 #include <vnet/dpo/load_balance_map.h>
46 #include <vnet/ip/ip4_inlines.h>
50 * @brief IPv4 Forwarding.
52 * This file contains the source code for IPv4 forwarding.
56 ip4_lookup_inline (vlib_main_t * vm,
57 vlib_node_runtime_t * node, vlib_frame_t * frame)
59 ip4_main_t *im = &ip4_main;
60 vlib_combined_counter_main_t *cm = &load_balance_main.lbm_to_counters;
62 u32 thread_index = vm->thread_index;
63 vlib_buffer_t *bufs[VLIB_FRAME_SIZE];
64 vlib_buffer_t **b = bufs;
65 u16 nexts[VLIB_FRAME_SIZE], *next;
67 from = vlib_frame_vector_args (frame);
68 n_left = frame->n_vectors;
70 vlib_get_buffers (vm, from, bufs, n_left);
72 #if (CLIB_N_PREFETCHES >= 8)
75 ip4_header_t *ip0, *ip1, *ip2, *ip3;
76 const load_balance_t *lb0, *lb1, *lb2, *lb3;
77 ip4_fib_mtrie_t *mtrie0, *mtrie1, *mtrie2, *mtrie3;
78 ip4_fib_mtrie_leaf_t leaf0, leaf1, leaf2, leaf3;
79 ip4_address_t *dst_addr0, *dst_addr1, *dst_addr2, *dst_addr3;
80 u32 lb_index0, lb_index1, lb_index2, lb_index3;
81 flow_hash_config_t flow_hash_config0, flow_hash_config1;
82 flow_hash_config_t flow_hash_config2, flow_hash_config3;
83 u32 hash_c0, hash_c1, hash_c2, hash_c3;
84 const dpo_id_t *dpo0, *dpo1, *dpo2, *dpo3;
86 /* Prefetch next iteration. */
89 vlib_prefetch_buffer_header (b[4], LOAD);
90 vlib_prefetch_buffer_header (b[5], LOAD);
91 vlib_prefetch_buffer_header (b[6], LOAD);
92 vlib_prefetch_buffer_header (b[7], LOAD);
94 CLIB_PREFETCH (b[4]->data, sizeof (ip0[0]), LOAD);
95 CLIB_PREFETCH (b[5]->data, sizeof (ip0[0]), LOAD);
96 CLIB_PREFETCH (b[6]->data, sizeof (ip0[0]), LOAD);
97 CLIB_PREFETCH (b[7]->data, sizeof (ip0[0]), LOAD);
100 ip0 = vlib_buffer_get_current (b[0]);
101 ip1 = vlib_buffer_get_current (b[1]);
102 ip2 = vlib_buffer_get_current (b[2]);
103 ip3 = vlib_buffer_get_current (b[3]);
105 dst_addr0 = &ip0->dst_address;
106 dst_addr1 = &ip1->dst_address;
107 dst_addr2 = &ip2->dst_address;
108 dst_addr3 = &ip3->dst_address;
110 ip_lookup_set_buffer_fib_index (im->fib_index_by_sw_if_index, b[0]);
111 ip_lookup_set_buffer_fib_index (im->fib_index_by_sw_if_index, b[1]);
112 ip_lookup_set_buffer_fib_index (im->fib_index_by_sw_if_index, b[2]);
113 ip_lookup_set_buffer_fib_index (im->fib_index_by_sw_if_index, b[3]);
115 mtrie0 = &ip4_fib_get (vnet_buffer (b[0])->ip.fib_index)->mtrie;
116 mtrie1 = &ip4_fib_get (vnet_buffer (b[1])->ip.fib_index)->mtrie;
117 mtrie2 = &ip4_fib_get (vnet_buffer (b[2])->ip.fib_index)->mtrie;
118 mtrie3 = &ip4_fib_get (vnet_buffer (b[3])->ip.fib_index)->mtrie;
120 leaf0 = ip4_fib_mtrie_lookup_step_one (mtrie0, dst_addr0);
121 leaf1 = ip4_fib_mtrie_lookup_step_one (mtrie1, dst_addr1);
122 leaf2 = ip4_fib_mtrie_lookup_step_one (mtrie2, dst_addr2);
123 leaf3 = ip4_fib_mtrie_lookup_step_one (mtrie3, dst_addr3);
125 leaf0 = ip4_fib_mtrie_lookup_step (mtrie0, leaf0, dst_addr0, 2);
126 leaf1 = ip4_fib_mtrie_lookup_step (mtrie1, leaf1, dst_addr1, 2);
127 leaf2 = ip4_fib_mtrie_lookup_step (mtrie2, leaf2, dst_addr2, 2);
128 leaf3 = ip4_fib_mtrie_lookup_step (mtrie3, leaf3, dst_addr3, 2);
130 leaf0 = ip4_fib_mtrie_lookup_step (mtrie0, leaf0, dst_addr0, 3);
131 leaf1 = ip4_fib_mtrie_lookup_step (mtrie1, leaf1, dst_addr1, 3);
132 leaf2 = ip4_fib_mtrie_lookup_step (mtrie2, leaf2, dst_addr2, 3);
133 leaf3 = ip4_fib_mtrie_lookup_step (mtrie3, leaf3, dst_addr3, 3);
135 lb_index0 = ip4_fib_mtrie_leaf_get_adj_index (leaf0);
136 lb_index1 = ip4_fib_mtrie_leaf_get_adj_index (leaf1);
137 lb_index2 = ip4_fib_mtrie_leaf_get_adj_index (leaf2);
138 lb_index3 = ip4_fib_mtrie_leaf_get_adj_index (leaf3);
140 ASSERT (lb_index0 && lb_index1 && lb_index2 && lb_index3);
141 lb0 = load_balance_get (lb_index0);
142 lb1 = load_balance_get (lb_index1);
143 lb2 = load_balance_get (lb_index2);
144 lb3 = load_balance_get (lb_index3);
146 ASSERT (lb0->lb_n_buckets > 0);
147 ASSERT (is_pow2 (lb0->lb_n_buckets));
148 ASSERT (lb1->lb_n_buckets > 0);
149 ASSERT (is_pow2 (lb1->lb_n_buckets));
150 ASSERT (lb2->lb_n_buckets > 0);
151 ASSERT (is_pow2 (lb2->lb_n_buckets));
152 ASSERT (lb3->lb_n_buckets > 0);
153 ASSERT (is_pow2 (lb3->lb_n_buckets));
155 /* Use flow hash to compute multipath adjacency. */
156 hash_c0 = vnet_buffer (b[0])->ip.flow_hash = 0;
157 hash_c1 = vnet_buffer (b[1])->ip.flow_hash = 0;
158 hash_c2 = vnet_buffer (b[2])->ip.flow_hash = 0;
159 hash_c3 = vnet_buffer (b[3])->ip.flow_hash = 0;
160 if (PREDICT_FALSE (lb0->lb_n_buckets > 1))
162 flow_hash_config0 = lb0->lb_hash_config;
163 hash_c0 = vnet_buffer (b[0])->ip.flow_hash =
164 ip4_compute_flow_hash (ip0, flow_hash_config0);
166 load_balance_get_fwd_bucket (lb0,
168 (lb0->lb_n_buckets_minus_1)));
172 dpo0 = load_balance_get_bucket_i (lb0, 0);
174 if (PREDICT_FALSE (lb1->lb_n_buckets > 1))
176 flow_hash_config1 = lb1->lb_hash_config;
177 hash_c1 = vnet_buffer (b[1])->ip.flow_hash =
178 ip4_compute_flow_hash (ip1, flow_hash_config1);
180 load_balance_get_fwd_bucket (lb1,
182 (lb1->lb_n_buckets_minus_1)));
186 dpo1 = load_balance_get_bucket_i (lb1, 0);
188 if (PREDICT_FALSE (lb2->lb_n_buckets > 1))
190 flow_hash_config2 = lb2->lb_hash_config;
191 hash_c2 = vnet_buffer (b[2])->ip.flow_hash =
192 ip4_compute_flow_hash (ip2, flow_hash_config2);
194 load_balance_get_fwd_bucket (lb2,
196 (lb2->lb_n_buckets_minus_1)));
200 dpo2 = load_balance_get_bucket_i (lb2, 0);
202 if (PREDICT_FALSE (lb3->lb_n_buckets > 1))
204 flow_hash_config3 = lb3->lb_hash_config;
205 hash_c3 = vnet_buffer (b[3])->ip.flow_hash =
206 ip4_compute_flow_hash (ip3, flow_hash_config3);
208 load_balance_get_fwd_bucket (lb3,
210 (lb3->lb_n_buckets_minus_1)));
214 dpo3 = load_balance_get_bucket_i (lb3, 0);
217 next[0] = dpo0->dpoi_next_node;
218 vnet_buffer (b[0])->ip.adj_index[VLIB_TX] = dpo0->dpoi_index;
219 next[1] = dpo1->dpoi_next_node;
220 vnet_buffer (b[1])->ip.adj_index[VLIB_TX] = dpo1->dpoi_index;
221 next[2] = dpo2->dpoi_next_node;
222 vnet_buffer (b[2])->ip.adj_index[VLIB_TX] = dpo2->dpoi_index;
223 next[3] = dpo3->dpoi_next_node;
224 vnet_buffer (b[3])->ip.adj_index[VLIB_TX] = dpo3->dpoi_index;
226 vlib_increment_combined_counter
227 (cm, thread_index, lb_index0, 1,
228 vlib_buffer_length_in_chain (vm, b[0]));
229 vlib_increment_combined_counter
230 (cm, thread_index, lb_index1, 1,
231 vlib_buffer_length_in_chain (vm, b[1]));
232 vlib_increment_combined_counter
233 (cm, thread_index, lb_index2, 1,
234 vlib_buffer_length_in_chain (vm, b[2]));
235 vlib_increment_combined_counter
236 (cm, thread_index, lb_index3, 1,
237 vlib_buffer_length_in_chain (vm, b[3]));
243 #elif (CLIB_N_PREFETCHES >= 4)
246 ip4_header_t *ip0, *ip1;
247 const load_balance_t *lb0, *lb1;
248 ip4_fib_mtrie_t *mtrie0, *mtrie1;
249 ip4_fib_mtrie_leaf_t leaf0, leaf1;
250 ip4_address_t *dst_addr0, *dst_addr1;
251 u32 lb_index0, lb_index1;
252 flow_hash_config_t flow_hash_config0, flow_hash_config1;
253 u32 hash_c0, hash_c1;
254 const dpo_id_t *dpo0, *dpo1;
256 /* Prefetch next iteration. */
258 vlib_prefetch_buffer_header (b[2], LOAD);
259 vlib_prefetch_buffer_header (b[3], LOAD);
261 CLIB_PREFETCH (b[2]->data, sizeof (ip0[0]), LOAD);
262 CLIB_PREFETCH (b[3]->data, sizeof (ip0[0]), LOAD);
265 ip0 = vlib_buffer_get_current (b[0]);
266 ip1 = vlib_buffer_get_current (b[1]);
268 dst_addr0 = &ip0->dst_address;
269 dst_addr1 = &ip1->dst_address;
271 ip_lookup_set_buffer_fib_index (im->fib_index_by_sw_if_index, b[0]);
272 ip_lookup_set_buffer_fib_index (im->fib_index_by_sw_if_index, b[1]);
274 mtrie0 = &ip4_fib_get (vnet_buffer (b[0])->ip.fib_index)->mtrie;
275 mtrie1 = &ip4_fib_get (vnet_buffer (b[1])->ip.fib_index)->mtrie;
277 leaf0 = ip4_fib_mtrie_lookup_step_one (mtrie0, dst_addr0);
278 leaf1 = ip4_fib_mtrie_lookup_step_one (mtrie1, dst_addr1);
280 leaf0 = ip4_fib_mtrie_lookup_step (mtrie0, leaf0, dst_addr0, 2);
281 leaf1 = ip4_fib_mtrie_lookup_step (mtrie1, leaf1, dst_addr1, 2);
283 leaf0 = ip4_fib_mtrie_lookup_step (mtrie0, leaf0, dst_addr0, 3);
284 leaf1 = ip4_fib_mtrie_lookup_step (mtrie1, leaf1, dst_addr1, 3);
286 lb_index0 = ip4_fib_mtrie_leaf_get_adj_index (leaf0);
287 lb_index1 = ip4_fib_mtrie_leaf_get_adj_index (leaf1);
289 ASSERT (lb_index0 && lb_index1);
290 lb0 = load_balance_get (lb_index0);
291 lb1 = load_balance_get (lb_index1);
293 ASSERT (lb0->lb_n_buckets > 0);
294 ASSERT (is_pow2 (lb0->lb_n_buckets));
295 ASSERT (lb1->lb_n_buckets > 0);
296 ASSERT (is_pow2 (lb1->lb_n_buckets));
298 /* Use flow hash to compute multipath adjacency. */
299 hash_c0 = vnet_buffer (b[0])->ip.flow_hash = 0;
300 hash_c1 = vnet_buffer (b[1])->ip.flow_hash = 0;
301 if (PREDICT_FALSE (lb0->lb_n_buckets > 1))
303 flow_hash_config0 = lb0->lb_hash_config;
304 hash_c0 = vnet_buffer (b[0])->ip.flow_hash =
305 ip4_compute_flow_hash (ip0, flow_hash_config0);
307 load_balance_get_fwd_bucket (lb0,
309 (lb0->lb_n_buckets_minus_1)));
313 dpo0 = load_balance_get_bucket_i (lb0, 0);
315 if (PREDICT_FALSE (lb1->lb_n_buckets > 1))
317 flow_hash_config1 = lb1->lb_hash_config;
318 hash_c1 = vnet_buffer (b[1])->ip.flow_hash =
319 ip4_compute_flow_hash (ip1, flow_hash_config1);
321 load_balance_get_fwd_bucket (lb1,
323 (lb1->lb_n_buckets_minus_1)));
327 dpo1 = load_balance_get_bucket_i (lb1, 0);
330 next[0] = dpo0->dpoi_next_node;
331 vnet_buffer (b[0])->ip.adj_index[VLIB_TX] = dpo0->dpoi_index;
332 next[1] = dpo1->dpoi_next_node;
333 vnet_buffer (b[1])->ip.adj_index[VLIB_TX] = dpo1->dpoi_index;
335 vlib_increment_combined_counter
336 (cm, thread_index, lb_index0, 1,
337 vlib_buffer_length_in_chain (vm, b[0]));
338 vlib_increment_combined_counter
339 (cm, thread_index, lb_index1, 1,
340 vlib_buffer_length_in_chain (vm, b[1]));
350 const load_balance_t *lb0;
351 ip4_fib_mtrie_t *mtrie0;
352 ip4_fib_mtrie_leaf_t leaf0;
353 ip4_address_t *dst_addr0;
355 flow_hash_config_t flow_hash_config0;
356 const dpo_id_t *dpo0;
359 ip0 = vlib_buffer_get_current (b[0]);
360 dst_addr0 = &ip0->dst_address;
361 ip_lookup_set_buffer_fib_index (im->fib_index_by_sw_if_index, b[0]);
363 mtrie0 = &ip4_fib_get (vnet_buffer (b[0])->ip.fib_index)->mtrie;
364 leaf0 = ip4_fib_mtrie_lookup_step_one (mtrie0, dst_addr0);
365 leaf0 = ip4_fib_mtrie_lookup_step (mtrie0, leaf0, dst_addr0, 2);
366 leaf0 = ip4_fib_mtrie_lookup_step (mtrie0, leaf0, dst_addr0, 3);
367 lbi0 = ip4_fib_mtrie_leaf_get_adj_index (leaf0);
370 lb0 = load_balance_get (lbi0);
372 ASSERT (lb0->lb_n_buckets > 0);
373 ASSERT (is_pow2 (lb0->lb_n_buckets));
375 /* Use flow hash to compute multipath adjacency. */
376 hash_c0 = vnet_buffer (b[0])->ip.flow_hash = 0;
377 if (PREDICT_FALSE (lb0->lb_n_buckets > 1))
379 flow_hash_config0 = lb0->lb_hash_config;
381 hash_c0 = vnet_buffer (b[0])->ip.flow_hash =
382 ip4_compute_flow_hash (ip0, flow_hash_config0);
384 load_balance_get_fwd_bucket (lb0,
386 (lb0->lb_n_buckets_minus_1)));
390 dpo0 = load_balance_get_bucket_i (lb0, 0);
393 next[0] = dpo0->dpoi_next_node;
394 vnet_buffer (b[0])->ip.adj_index[VLIB_TX] = dpo0->dpoi_index;
396 vlib_increment_combined_counter (cm, thread_index, lbi0, 1,
397 vlib_buffer_length_in_chain (vm,
405 vlib_buffer_enqueue_to_next (vm, node, from, nexts, frame->n_vectors);
407 if (node->flags & VLIB_NODE_FLAG_TRACE)
408 ip4_forward_next_trace (vm, node, frame, VLIB_TX);
410 return frame->n_vectors;
413 #endif /* __included_ip4_forward_h__ */
416 * fd.io coding-style-patch-verification: ON
419 * eval: (c-set-style "gnu")