MTRIE Optimisations 2
[vpp.git] / src / vnet / ip / ip4_source_check.c
1 /*
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:
6  *
7  *     http://www.apache.org/licenses/LICENSE-2.0
8  *
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.
14  */
15 /*
16  * ip/ip4_source_check.c: IP v4 check source address (unicast RPF check)
17  *
18  * Copyright (c) 2008 Eliot Dresselhaus
19  *
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:
27  *
28  * The above copyright notice and this permission notice shall be
29  * included in all copies or substantial portions of the Software.
30  *
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.
38  */
39
40 #include <vnet/ip/ip.h>
41 #include <vnet/fib/ip4_fib.h>
42 #include <vnet/fib/fib_urpf_list.h>
43 #include <vnet/dpo/load_balance.h>
44
45 /**
46  * @file
47  * @brief IPv4 Unicast Source Check.
48  *
49  * This file contains the IPv4 interface unicast source check.
50  */
51
52
53 typedef struct
54 {
55   u8 packet_data[64];
56   index_t urpf;
57 } ip4_source_check_trace_t;
58
59 static u8 *
60 format_ip4_source_check_trace (u8 * s, va_list * va)
61 {
62   CLIB_UNUSED (vlib_main_t * vm) = va_arg (*va, vlib_main_t *);
63   CLIB_UNUSED (vlib_node_t * node) = va_arg (*va, vlib_node_t *);
64   ip4_source_check_trace_t *t = va_arg (*va, ip4_source_check_trace_t *);
65
66   s = format (s, "%U",
67               format_ip4_header, t->packet_data, sizeof (t->packet_data));
68
69   return s;
70 }
71
72 typedef enum
73 {
74   IP4_SOURCE_CHECK_NEXT_DROP,
75   IP4_SOURCE_CHECK_N_NEXT,
76 } ip4_source_check_next_t;
77
78 typedef enum
79 {
80   IP4_SOURCE_CHECK_REACHABLE_VIA_RX,
81   IP4_SOURCE_CHECK_REACHABLE_VIA_ANY,
82 } ip4_source_check_type_t;
83
84 typedef union
85 {
86   u32 fib_index;
87 } ip4_source_check_config_t;
88
89 always_inline uword
90 ip4_source_check_inline (vlib_main_t * vm,
91                          vlib_node_runtime_t * node,
92                          vlib_frame_t * frame,
93                          ip4_source_check_type_t source_check_type)
94 {
95   u32 n_left_from, *from, *to_next;
96   u32 next_index;
97   vlib_node_runtime_t *error_node =
98     vlib_node_get_runtime (vm, ip4_input_node.index);
99
100   from = vlib_frame_vector_args (frame);
101   n_left_from = frame->n_vectors;
102   next_index = node->cached_next_index;
103
104   if (node->flags & VLIB_NODE_FLAG_TRACE)
105     vlib_trace_frame_buffers_only (vm, node, from, frame->n_vectors,
106                                    /* stride */ 1,
107                                    sizeof (ip4_source_check_trace_t));
108
109   while (n_left_from > 0)
110     {
111       u32 n_left_to_next;
112
113       vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
114
115       while (n_left_from >= 4 && n_left_to_next >= 2)
116         {
117           vlib_buffer_t *p0, *p1;
118           ip4_header_t *ip0, *ip1;
119           ip4_fib_mtrie_t *mtrie0, *mtrie1;
120           ip4_fib_mtrie_leaf_t leaf0, leaf1;
121           ip4_source_check_config_t *c0, *c1;
122           const load_balance_t *lb0, *lb1;
123           u32 pi0, next0, pass0, lb_index0;
124           u32 pi1, next1, pass1, lb_index1;
125
126           /* Prefetch next iteration. */
127           {
128             vlib_buffer_t *p2, *p3;
129
130             p2 = vlib_get_buffer (vm, from[2]);
131             p3 = vlib_get_buffer (vm, from[3]);
132
133             vlib_prefetch_buffer_header (p2, LOAD);
134             vlib_prefetch_buffer_header (p3, LOAD);
135
136             CLIB_PREFETCH (p2->data, sizeof (ip0[0]), LOAD);
137             CLIB_PREFETCH (p3->data, sizeof (ip1[0]), LOAD);
138           }
139
140           pi0 = to_next[0] = from[0];
141           pi1 = to_next[1] = from[1];
142           from += 2;
143           to_next += 2;
144           n_left_from -= 2;
145           n_left_to_next -= 2;
146
147           p0 = vlib_get_buffer (vm, pi0);
148           p1 = vlib_get_buffer (vm, pi1);
149
150           ip0 = vlib_buffer_get_current (p0);
151           ip1 = vlib_buffer_get_current (p1);
152
153           c0 =
154             vnet_feature_next_with_data (vnet_buffer (p0)->sw_if_index
155                                          [VLIB_RX], &next0, p0,
156                                          sizeof (c0[0]));
157           c1 =
158             vnet_feature_next_with_data (vnet_buffer (p1)->sw_if_index
159                                          [VLIB_RX], &next1, p1,
160                                          sizeof (c1[0]));
161
162           mtrie0 = &ip4_fib_get (c0->fib_index)->mtrie;
163           mtrie1 = &ip4_fib_get (c1->fib_index)->mtrie;
164
165           leaf0 = ip4_fib_mtrie_lookup_step_one (mtrie0, &ip0->src_address);
166           leaf1 = ip4_fib_mtrie_lookup_step_one (mtrie1, &ip1->src_address);
167
168           leaf0 =
169             ip4_fib_mtrie_lookup_step (mtrie0, leaf0, &ip0->src_address, 2);
170           leaf1 =
171             ip4_fib_mtrie_lookup_step (mtrie1, leaf1, &ip1->src_address, 2);
172
173           leaf0 =
174             ip4_fib_mtrie_lookup_step (mtrie0, leaf0, &ip0->src_address, 3);
175           leaf1 =
176             ip4_fib_mtrie_lookup_step (mtrie1, leaf1, &ip1->src_address, 3);
177
178           lb_index0 = ip4_fib_mtrie_leaf_get_adj_index (leaf0);
179           lb_index1 = ip4_fib_mtrie_leaf_get_adj_index (leaf1);
180
181           lb0 = load_balance_get (lb_index0);
182           lb1 = load_balance_get (lb_index1);
183
184           /* Pass multicast. */
185           pass0 = ip4_address_is_multicast (&ip0->src_address)
186             || ip0->src_address.as_u32 == clib_host_to_net_u32 (0xFFFFFFFF);
187           pass1 = ip4_address_is_multicast (&ip1->src_address)
188             || ip1->src_address.as_u32 == clib_host_to_net_u32 (0xFFFFFFFF);
189
190           if (IP4_SOURCE_CHECK_REACHABLE_VIA_RX == source_check_type)
191             {
192               pass0 |= fib_urpf_check (lb0->lb_urpf,
193                                        vnet_buffer (p0)->sw_if_index
194                                        [VLIB_RX]);
195               pass1 |=
196                 fib_urpf_check (lb1->lb_urpf,
197                                 vnet_buffer (p1)->sw_if_index[VLIB_RX]);
198             }
199           else
200             {
201               pass0 |= fib_urpf_check_size (lb0->lb_urpf);
202               pass1 |= fib_urpf_check_size (lb1->lb_urpf);
203             }
204           next0 = (pass0 ? next0 : IP4_SOURCE_CHECK_NEXT_DROP);
205           next1 = (pass1 ? next1 : IP4_SOURCE_CHECK_NEXT_DROP);
206
207           p0->error =
208             error_node->errors[IP4_ERROR_UNICAST_SOURCE_CHECK_FAILS];
209           p1->error =
210             error_node->errors[IP4_ERROR_UNICAST_SOURCE_CHECK_FAILS];
211
212           vlib_validate_buffer_enqueue_x2 (vm, node, next_index,
213                                            to_next, n_left_to_next,
214                                            pi0, pi1, next0, next1);
215         }
216
217       while (n_left_from > 0 && n_left_to_next > 0)
218         {
219           vlib_buffer_t *p0;
220           ip4_header_t *ip0;
221           ip4_fib_mtrie_t *mtrie0;
222           ip4_fib_mtrie_leaf_t leaf0;
223           ip4_source_check_config_t *c0;
224           u32 pi0, next0, pass0, lb_index0;
225           const load_balance_t *lb0;
226
227           pi0 = from[0];
228           to_next[0] = pi0;
229           from += 1;
230           to_next += 1;
231           n_left_from -= 1;
232           n_left_to_next -= 1;
233
234           p0 = vlib_get_buffer (vm, pi0);
235           ip0 = vlib_buffer_get_current (p0);
236
237           c0 =
238             vnet_feature_next_with_data (vnet_buffer (p0)->sw_if_index
239                                          [VLIB_RX], &next0, p0,
240                                          sizeof (c0[0]));
241
242           mtrie0 = &ip4_fib_get (c0->fib_index)->mtrie;
243
244           leaf0 = ip4_fib_mtrie_lookup_step_one (mtrie0, &ip0->src_address);
245
246           leaf0 =
247             ip4_fib_mtrie_lookup_step (mtrie0, leaf0, &ip0->src_address, 2);
248
249           leaf0 =
250             ip4_fib_mtrie_lookup_step (mtrie0, leaf0, &ip0->src_address, 3);
251
252           lb_index0 = ip4_fib_mtrie_leaf_get_adj_index (leaf0);
253
254           lb0 = load_balance_get (lb_index0);
255
256           /* Pass multicast. */
257           pass0 = ip4_address_is_multicast (&ip0->src_address)
258             || ip0->src_address.as_u32 == clib_host_to_net_u32 (0xFFFFFFFF);
259
260           if (IP4_SOURCE_CHECK_REACHABLE_VIA_RX == source_check_type)
261             {
262               pass0 |= fib_urpf_check (lb0->lb_urpf,
263                                        vnet_buffer (p0)->sw_if_index
264                                        [VLIB_RX]);
265             }
266           else
267             {
268               pass0 |= fib_urpf_check_size (lb0->lb_urpf);
269             }
270
271           next0 = (pass0 ? next0 : IP4_SOURCE_CHECK_NEXT_DROP);
272           p0->error =
273             error_node->errors[IP4_ERROR_UNICAST_SOURCE_CHECK_FAILS];
274
275           vlib_validate_buffer_enqueue_x1 (vm, node, next_index,
276                                            to_next, n_left_to_next,
277                                            pi0, next0);
278         }
279
280       vlib_put_next_frame (vm, node, next_index, n_left_to_next);
281     }
282
283   return frame->n_vectors;
284 }
285
286 static uword
287 ip4_source_check_reachable_via_any (vlib_main_t * vm,
288                                     vlib_node_runtime_t * node,
289                                     vlib_frame_t * frame)
290 {
291   return ip4_source_check_inline (vm, node, frame,
292                                   IP4_SOURCE_CHECK_REACHABLE_VIA_ANY);
293 }
294
295 static uword
296 ip4_source_check_reachable_via_rx (vlib_main_t * vm,
297                                    vlib_node_runtime_t * node,
298                                    vlib_frame_t * frame)
299 {
300   return ip4_source_check_inline (vm, node, frame,
301                                   IP4_SOURCE_CHECK_REACHABLE_VIA_RX);
302 }
303
304 /* *INDENT-OFF* */
305 VLIB_REGISTER_NODE (ip4_check_source_reachable_via_any) = {
306   .function = ip4_source_check_reachable_via_any,
307   .name = "ip4-source-check-via-any",
308   .vector_size = sizeof (u32),
309
310   .n_next_nodes = IP4_SOURCE_CHECK_N_NEXT,
311   .next_nodes = {
312     [IP4_SOURCE_CHECK_NEXT_DROP] = "error-drop",
313   },
314
315   .format_buffer = format_ip4_header,
316   .format_trace = format_ip4_source_check_trace,
317 };
318 /* *INDENT-ON* */
319
320 VLIB_NODE_FUNCTION_MULTIARCH (ip4_check_source_reachable_via_any,
321                               ip4_source_check_reachable_via_any);
322
323 /* *INDENT-OFF* */
324 VLIB_REGISTER_NODE (ip4_check_source_reachable_via_rx) = {
325   .function = ip4_source_check_reachable_via_rx,
326   .name = "ip4-source-check-via-rx",
327   .vector_size = sizeof (u32),
328
329   .n_next_nodes = IP4_SOURCE_CHECK_N_NEXT,
330   .next_nodes = {
331     [IP4_SOURCE_CHECK_NEXT_DROP] = "error-drop",
332   },
333
334   .format_buffer = format_ip4_header,
335   .format_trace = format_ip4_source_check_trace,
336 };
337 /* *INDENT-ON* */
338
339 VLIB_NODE_FUNCTION_MULTIARCH (ip4_check_source_reachable_via_rx,
340                               ip4_source_check_reachable_via_rx);
341
342 static clib_error_t *
343 set_ip_source_check (vlib_main_t * vm,
344                      unformat_input_t * input, vlib_cli_command_t * cmd)
345 {
346   unformat_input_t _line_input, *line_input = &_line_input;
347   vnet_main_t *vnm = vnet_get_main ();
348   ip4_main_t *im = &ip4_main;
349   clib_error_t *error = 0;
350   u32 sw_if_index, is_del;
351   ip4_source_check_config_t config;
352   char *feature_name = "ip4-source-check-via-rx";
353
354   sw_if_index = ~0;
355   is_del = 0;
356
357   if (!unformat_user (input, unformat_line_input, line_input))
358     return 0;
359
360   while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
361     {
362       if (unformat_user
363           (line_input, unformat_vnet_sw_interface, vnm, &sw_if_index))
364         ;
365       else if (unformat (line_input, "del"))
366         is_del = 1;
367       else if (unformat (line_input, "loose"))
368         feature_name = "ip4-source-check-via-any";
369       else
370         {
371           error = unformat_parse_error (line_input);
372           goto done;
373         }
374     }
375
376   if (~0 == sw_if_index)
377     {
378       error = clib_error_return (0, "unknown interface `%U'",
379                                  format_unformat_error, line_input);
380       goto done;
381     }
382
383   config.fib_index = im->fib_index_by_sw_if_index[sw_if_index];
384   vnet_feature_enable_disable ("ip4-unicast", feature_name, sw_if_index,
385                                is_del == 0, &config, sizeof (config));
386 done:
387   unformat_free (line_input);
388
389   return error;
390 }
391
392 /*?
393  * This command adds the 'ip4-source-check-via-rx' graph node for
394  * a given interface. By adding the IPv4 source check graph node to
395  * an interface, the code verifies that the source address of incoming
396  * unicast packets are reachable over the incoming interface. Two flavours
397  * are supported (the default is strict):
398  * - loose: accept ingress packet if there is a route to reach the source
399  * - strict: accept ingress packet if it arrived on an interface which
400  *          the route to the source uses. i.e. an interface that the source
401  *          is reachable via.
402  *
403  * @cliexpar
404  * @parblock
405  * Example of graph node before range checking is enabled:
406  * @cliexstart{show vlib graph ip4-source-check-via-rx}
407  *            Name                      Next                    Previous
408  * ip4-source-check-via-rx         error-drop [0]
409  * @cliexend
410  *
411  * Example of how to enable unicast source checking on an interface:
412  * @cliexcmd{set interface ip source-check GigabitEthernet2/0/0 loose}
413  *
414  * Example of graph node after range checking is enabled:
415  * @cliexstart{show vlib graph ip4-source-check-via-rx}
416  *            Name                      Next                    Previous
417  * ip4-source-check-via-rx         error-drop [0]         ip4-input-no-checksum
418  *                           ip4-source-and-port-range-         ip4-input
419  * @cliexend
420  *
421  * Example of how to display the feature enabed on an interface:
422  * @cliexstart{show ip interface features GigabitEthernet2/0/0}
423  * IP feature paths configured on GigabitEthernet2/0/0...
424  *
425  * ipv4 unicast:
426  *   ip4-source-check-via-rx
427  *   ip4-lookup
428  *
429  * ipv4 multicast:
430  *   ip4-lookup-multicast
431  *
432  * ipv4 multicast:
433  *   interface-output
434  *
435  * ipv6 unicast:
436  *   ip6-lookup
437  *
438  * ipv6 multicast:
439  *   ip6-lookup
440  *
441  * ipv6 multicast:
442  *   interface-output
443  * @cliexend
444  *
445  * Example of how to disable unicast source checking on an interface:
446  * @cliexcmd{set interface ip source-check GigabitEthernet2/0/0 del}
447  * @endparblock
448 ?*/
449 /* *INDENT-OFF* */
450 VLIB_CLI_COMMAND (set_interface_ip_source_check_command, static) = {
451   .path = "set interface ip source-check",
452   .function = set_ip_source_check,
453   .short_help = "set interface ip source-check <interface> [strict|loose] [del]",
454 };
455 /* *INDENT-ON* */
456
457 static clib_error_t *
458 ip_source_check_accept (vlib_main_t * vm,
459                         unformat_input_t * input, vlib_cli_command_t * cmd)
460 {
461   unformat_input_t _line_input, *line_input = &_line_input;
462   fib_prefix_t pfx = {
463     .fp_proto = FIB_PROTOCOL_IP4,
464   };
465   clib_error_t *error = NULL;
466   u32 table_id, is_add, fib_index;
467
468   is_add = 1;
469   table_id = ~0;
470
471   /* Get a line of input. */
472   if (!unformat_user (input, unformat_line_input, line_input))
473     return 0;
474
475   while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
476     {
477       if (unformat (line_input, "table %d", &table_id))
478         ;
479       else if (unformat (line_input, "del"))
480         is_add = 0;
481       else if (unformat (line_input, "add"))
482         is_add = 1;
483       else if (unformat (line_input, "%U/%d",
484                          unformat_ip4_address, &pfx.fp_addr.ip4, &pfx.fp_len))
485         pfx.fp_proto = FIB_PROTOCOL_IP4;
486       else
487         {
488           error = unformat_parse_error (line_input);
489           goto done;
490         }
491     }
492
493   if (~0 != table_id)
494     {
495       fib_index = fib_table_id_find_fib_index (pfx.fp_proto, table_id);
496       if (~0 == fib_index)
497         {
498           error = clib_error_return (0, "Nonexistent table id %d", table_id);
499           goto done;
500         }
501     }
502   else
503     {
504       fib_index = 0;
505     }
506
507   if (is_add)
508     {
509       fib_table_entry_special_add (fib_index,
510                                    &pfx,
511                                    FIB_SOURCE_URPF_EXEMPT,
512                                    FIB_ENTRY_FLAG_DROP, ADJ_INDEX_INVALID);
513     }
514   else
515     {
516       fib_table_entry_special_remove (fib_index,
517                                       &pfx, FIB_SOURCE_URPF_EXEMPT);
518     }
519
520 done:
521   unformat_free (line_input);
522
523   return error;
524 }
525
526 /*?
527  * Add an exemption for a prefix to pass the Unicast Reverse Path
528  * Forwarding (uRPF) loose check. This is for testing purposes only.
529  * If the '<em>table</em>' is not enter it is defaulted to 0. Default
530  * is to '<em>add</em>'. VPP always performs a loose uRPF check for
531  * for-us traffic.
532  *
533  * @cliexpar
534  * Example of how to add a uRPF exception to a FIB table to pass the
535  * loose RPF tests:
536  * @cliexcmd{ip urpf-accept table 7 add}
537 ?*/
538 /* *INDENT-OFF* */
539 VLIB_CLI_COMMAND (ip_source_check_accept_command, static) = {
540   .path = "ip urpf-accept",
541   .function = ip_source_check_accept,
542   .short_help = "ip urpf-accept [table <table-id>] [add|del]",
543 };
544 /* *INDENT-ON* */
545
546
547 /* Dummy init function to get us linked in. */
548 clib_error_t *
549 ip4_source_check_init (vlib_main_t * vm)
550 {
551   return 0;
552 }
553
554 VLIB_INIT_FUNCTION (ip4_source_check_init);
555
556 /*
557  * fd.io coding-style-patch-verification: ON
558  *
559  * Local Variables:
560  * eval: (c-set-style "gnu")
561  * End:
562  */