92310e418c25611418feda3c798c688747059ed0
[vpp.git] / src / vnet / ip / lookup.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/ip_lookup.c: ip4/6 adjacency and lookup table management
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/adj/adj.h>
42 #include <vnet/fib/fib_table.h>
43 #include <vnet/fib/ip4_fib.h>
44 #include <vnet/fib/ip6_fib.h>
45 #include <vnet/mpls/mpls.h>
46 #include <vnet/mfib/mfib_table.h>
47 #include <vnet/dpo/drop_dpo.h>
48 #include <vnet/dpo/classify_dpo.h>
49 #include <vnet/dpo/punt_dpo.h>
50 #include <vnet/dpo/receive_dpo.h>
51 #include <vnet/dpo/ip_null_dpo.h>
52
53 /**
54  * @file
55  * @brief IPv4 and IPv6 adjacency and lookup table management.
56  *
57  */
58
59 static clib_error_t *
60 ip_sw_interface_add_del (vnet_main_t * vnm, u32 sw_if_index, u32 is_add)
61 {
62   vec_validate_init_empty (ip4_main.
63                            lookup_main.if_address_pool_index_by_sw_if_index,
64                            sw_if_index, ~0);
65   vec_validate_init_empty (ip6_main.
66                            lookup_main.if_address_pool_index_by_sw_if_index,
67                            sw_if_index, ~0);
68
69   return (NULL);
70 }
71
72 VNET_SW_INTERFACE_ADD_DEL_FUNCTION (ip_sw_interface_add_del);
73
74 void
75 ip_lookup_init (ip_lookup_main_t * lm, u32 is_ip6)
76 {
77   if (!lm->fib_result_n_bytes)
78     lm->fib_result_n_bytes = sizeof (uword);
79
80   lm->is_ip6 = is_ip6;
81   mhash_init (&lm->prefix_to_if_prefix_index, sizeof (uword),
82               sizeof (ip_interface_prefix_key_t));
83   if (is_ip6)
84     {
85       lm->format_address_and_length = format_ip6_address_and_length;
86       mhash_init (&lm->address_to_if_address_index, sizeof (uword),
87                   sizeof (ip6_address_fib_t));
88     }
89   else
90     {
91       lm->format_address_and_length = format_ip4_address_and_length;
92       mhash_init (&lm->address_to_if_address_index, sizeof (uword),
93                   sizeof (ip4_address_fib_t));
94     }
95
96   {
97     int i;
98
99     /* Setup all IP protocols to be punted and builtin-unknown. */
100     for (i = 0; i < 256; i++)
101       {
102         lm->local_next_by_ip_protocol[i] = IP_LOCAL_NEXT_PUNT;
103         lm->builtin_protocol_by_ip_protocol[i] = IP_BUILTIN_PROTOCOL_UNKNOWN;
104       }
105
106     lm->local_next_by_ip_protocol[IP_PROTOCOL_UDP] = IP_LOCAL_NEXT_UDP_LOOKUP;
107     lm->local_next_by_ip_protocol[is_ip6 ? IP_PROTOCOL_ICMP6 :
108                                   IP_PROTOCOL_ICMP] = IP_LOCAL_NEXT_ICMP;
109     lm->builtin_protocol_by_ip_protocol[IP_PROTOCOL_UDP] =
110       IP_BUILTIN_PROTOCOL_UDP;
111     lm->builtin_protocol_by_ip_protocol[is_ip6 ? IP_PROTOCOL_ICMP6 :
112                                         IP_PROTOCOL_ICMP] =
113       IP_BUILTIN_PROTOCOL_ICMP;
114   }
115 }
116
117 u8 *
118 format_ip_flow_hash_config (u8 * s, va_list * args)
119 {
120   flow_hash_config_t flow_hash_config = va_arg (*args, u32);
121
122 #define _(n, b, v)                                                            \
123   if (flow_hash_config & v)                                                   \
124     s = format (s, "%s ", #n);
125   foreach_flow_hash_bit;
126 #undef _
127
128   return s;
129 }
130
131 uword
132 unformat_ip_flow_hash_config (unformat_input_t *input, va_list *args)
133 {
134   flow_hash_config_t *flow_hash_config = va_arg (*args, flow_hash_config_t *);
135   uword start_index = unformat_check_input (input);
136   int matched_once = 0;
137
138   if (unformat (input, "default"))
139     {
140       *flow_hash_config = IP_FLOW_HASH_DEFAULT;
141       return 1;
142     }
143   while (!unformat_is_eof (input) &&
144          !is_white_space (unformat_peek_input (input)))
145     {
146       if (unformat (input, "%_,"))
147         ;
148 #define _(a, b)                                                               \
149   else if (unformat (input, "%_" #a))                                         \
150   {                                                                           \
151     *flow_hash_config |= b;                                                   \
152     matched_once = 1;                                                         \
153   }
154       foreach_flow_hash_bit_v1
155 #undef _
156         else
157       {
158         /* Roll back to our start */
159         input->index = start_index;
160         return 0;
161       }
162     }
163
164   return matched_once;
165 }
166
167 u8 *
168 format_ip_adjacency_packet_data (u8 * s, va_list * args)
169 {
170   u8 *packet_data = va_arg (*args, u8 *);
171   u32 n_packet_data_bytes = va_arg (*args, u32);
172
173   s = format (s, "%U", format_hex_bytes, packet_data, n_packet_data_bytes);
174
175   return s;
176 }
177
178 static uword
179 unformat_dpo (unformat_input_t * input, va_list * args)
180 {
181   dpo_id_t *dpo = va_arg (*args, dpo_id_t *);
182   fib_protocol_t fp = va_arg (*args, int);
183   dpo_proto_t proto;
184
185   proto = fib_proto_to_dpo (fp);
186
187   if (unformat (input, "drop"))
188     dpo_copy (dpo, drop_dpo_get (proto));
189   else if (unformat (input, "punt"))
190     dpo_copy (dpo, punt_dpo_get (proto));
191   else if (unformat (input, "local"))
192     receive_dpo_add_or_lock (proto, ~0, NULL, dpo);
193   else if (unformat (input, "null-send-unreach"))
194     ip_null_dpo_add_and_lock (proto, IP_NULL_ACTION_SEND_ICMP_UNREACH, dpo);
195   else if (unformat (input, "null-send-prohibit"))
196     ip_null_dpo_add_and_lock (proto, IP_NULL_ACTION_SEND_ICMP_PROHIBIT, dpo);
197   else if (unformat (input, "null"))
198     ip_null_dpo_add_and_lock (proto, IP_NULL_ACTION_NONE, dpo);
199   else if (unformat (input, "classify"))
200     {
201       u32 classify_table_index;
202
203       if (!unformat (input, "%d", &classify_table_index))
204         {
205           clib_warning ("classify adj must specify table index");
206           return 0;
207         }
208
209       dpo_set (dpo, DPO_CLASSIFY, proto,
210                classify_dpo_create (proto, classify_table_index));
211     }
212   else
213     return 0;
214
215   return 1;
216 }
217
218 const ip46_address_t zero_addr = {
219   .as_u64 = {
220              0, 0},
221 };
222
223 static clib_error_t *
224 vnet_ip_route_cmd (vlib_main_t * vm,
225                    unformat_input_t * main_input, vlib_cli_command_t * cmd)
226 {
227   unformat_input_t _line_input, *line_input = &_line_input;
228   u32 table_id, is_del, fib_index, payload_proto;
229   dpo_id_t dpo = DPO_INVALID, *dpos = NULL;
230   fib_route_path_t *rpaths = NULL, rpath;
231   fib_prefix_t *prefixs = NULL, pfx;
232   clib_error_t *error = NULL;
233   f64 count;
234   int i;
235
236   is_del = 0;
237   table_id = 0;
238   count = 1;
239   clib_memset (&pfx, 0, sizeof (pfx));
240
241   /* Get a line of input. */
242   if (!unformat_user (main_input, unformat_line_input, line_input))
243     return 0;
244
245   while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
246     {
247       clib_memset (&rpath, 0, sizeof (rpath));
248
249       if (unformat (line_input, "table %d", &table_id))
250         ;
251       else if (unformat (line_input, "count %f", &count))
252         ;
253
254       else if (unformat (line_input, "%U/%d",
255                          unformat_ip4_address, &pfx.fp_addr.ip4, &pfx.fp_len))
256         {
257           payload_proto = pfx.fp_proto = FIB_PROTOCOL_IP4;
258           vec_add1 (prefixs, pfx);
259         }
260       else if (unformat (line_input, "%U/%d",
261                          unformat_ip6_address, &pfx.fp_addr.ip6, &pfx.fp_len))
262         {
263           payload_proto = pfx.fp_proto = FIB_PROTOCOL_IP6;
264           vec_add1 (prefixs, pfx);
265         }
266       else if (unformat (line_input, "via %U",
267                          unformat_fib_route_path, &rpath, &payload_proto))
268         {
269           vec_add1 (rpaths, rpath);
270         }
271       else if (vec_len (prefixs) > 0 &&
272                unformat (line_input, "via %U",
273                          unformat_dpo, &dpo, prefixs[0].fp_proto))
274         {
275           vec_add1 (dpos, dpo);
276         }
277       else if (unformat (line_input, "del"))
278         is_del = 1;
279       else if (unformat (line_input, "add"))
280         is_del = 0;
281       else
282         {
283           error = unformat_parse_error (line_input);
284           goto done;
285         }
286     }
287
288   if (vec_len (prefixs) == 0)
289     {
290       error =
291         clib_error_return (0, "expected ip4/ip6 destination address/length.");
292       goto done;
293     }
294
295   if (!is_del && vec_len (rpaths) + vec_len (dpos) == 0)
296     {
297       error = clib_error_return (0, "expected paths.");
298       goto done;
299     }
300
301   if (~0 == table_id)
302     {
303       /*
304        * if no table_id is passed we will manipulate the default
305        */
306       fib_index = 0;
307     }
308   else
309     {
310       fib_index = fib_table_find (prefixs[0].fp_proto, table_id);
311
312       if (~0 == fib_index)
313         {
314           error = clib_error_return (0, "Nonexistent table id %d", table_id);
315           goto done;
316         }
317     }
318
319   for (i = 0; i < vec_len (prefixs); i++)
320     {
321       if (is_del && 0 == vec_len (rpaths))
322         {
323           fib_table_entry_delete (fib_index, &prefixs[i], FIB_SOURCE_CLI);
324         }
325       else if (!is_del && 1 == vec_len (dpos))
326         {
327           fib_table_entry_special_dpo_add (fib_index,
328                                            &prefixs[i],
329                                            FIB_SOURCE_CLI,
330                                            FIB_ENTRY_FLAG_EXCLUSIVE,
331                                            &dpos[0]);
332           dpo_reset (&dpos[0]);
333         }
334       else if (vec_len (dpos) > 0)
335         {
336           error =
337             clib_error_return (0,
338                                "Load-balancing over multiple special adjacencies is unsupported");
339           goto done;
340         }
341       else if (0 < vec_len (rpaths))
342         {
343           u32 k, n;
344           f64 t[2];
345           n = count;
346           t[0] = vlib_time_now (vm);
347
348           for (k = 0; k < n; k++)
349             {
350               fib_prefix_t rpfx = {
351                 .fp_len = prefixs[i].fp_len,
352                 .fp_proto = prefixs[i].fp_proto,
353                 .fp_addr = prefixs[i].fp_addr,
354               };
355
356               if (is_del)
357                 fib_table_entry_path_remove2 (fib_index,
358                                               &rpfx, FIB_SOURCE_CLI, rpaths);
359               else
360                 fib_table_entry_path_add2 (fib_index,
361                                            &rpfx,
362                                            FIB_SOURCE_CLI,
363                                            FIB_ENTRY_FLAG_NONE, rpaths);
364
365               fib_prefix_increment (&prefixs[i]);
366             }
367
368           t[1] = vlib_time_now (vm);
369           if (count > 1)
370             vlib_cli_output (vm, "%.6e routes/sec", count / (t[1] - t[0]));
371         }
372       else
373         {
374           error = clib_error_return (0, "Don't understand what you want...");
375           goto done;
376         }
377     }
378
379 done:
380   vec_free (dpos);
381   vec_free (prefixs);
382   vec_free (rpaths);
383   unformat_free (line_input);
384   return error;
385 }
386
387 clib_error_t *
388 vnet_ip_table_cmd (vlib_main_t * vm,
389                    unformat_input_t * main_input,
390                    vlib_cli_command_t * cmd, fib_protocol_t fproto)
391 {
392   unformat_input_t _line_input, *line_input = &_line_input;
393   clib_error_t *error = NULL;
394   u32 table_id, is_add;
395   u8 *name = NULL;
396
397   is_add = 1;
398   table_id = ~0;
399
400   /* Get a line of input. */
401   if (!unformat_user (main_input, unformat_line_input, line_input))
402     return 0;
403
404   while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
405     {
406       if (unformat (line_input, "%d", &table_id))
407         ;
408       else if (unformat (line_input, "del"))
409         is_add = 0;
410       else if (unformat (line_input, "add"))
411         is_add = 1;
412       else if (unformat (line_input, "name %s", &name))
413         ;
414       else
415         {
416           error = unformat_parse_error (line_input);
417           goto done;
418         }
419     }
420
421   if (0 == table_id)
422     {
423       error = clib_error_return (0, "Can't change the default table");
424       goto done;
425     }
426   else
427         {
428           if (is_add)
429             {
430               if (~0 == table_id)
431                 {
432                   table_id = ip_table_get_unused_id (fproto);
433                   vlib_cli_output (vm, "%u\n", table_id);
434                 }
435               ip_table_create (fproto, table_id, 0, name);
436             }
437           else
438             {
439               if (~0 == table_id)
440                 {
441                   error = clib_error_return (0, "No table id");
442                   goto done;
443                 }
444               ip_table_delete (fproto, table_id, 0);
445             }
446         }
447
448 done:
449   vec_free (name);
450   unformat_free (line_input);
451   return error;
452 }
453
454 clib_error_t *
455 vnet_ip4_table_cmd (vlib_main_t * vm,
456                     unformat_input_t * main_input, vlib_cli_command_t * cmd)
457 {
458   return (vnet_ip_table_cmd (vm, main_input, cmd, FIB_PROTOCOL_IP4));
459 }
460
461 clib_error_t *
462 vnet_ip6_table_cmd (vlib_main_t * vm,
463                     unformat_input_t * main_input, vlib_cli_command_t * cmd)
464 {
465   return (vnet_ip_table_cmd (vm, main_input, cmd, FIB_PROTOCOL_IP6));
466 }
467
468 clib_error_t *
469 vnet_show_ip_table_cmd (vlib_main_t *vm, unformat_input_t *main_input,
470                         vlib_cli_command_t *cmd, fib_protocol_t fproto)
471 {
472   unformat_input_t _line_input, *line_input = &_line_input;
473   fib_table_t *fib, *fibs;
474   clib_error_t *error = NULL;
475   u32 table_id = ~0, fib_index;
476   /* Get a line of input. */
477   if (unformat_user (main_input, unformat_line_input, line_input))
478     {
479       while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
480         {
481           if (unformat (line_input, "%d", &table_id))
482             ;
483           else
484             {
485               error = unformat_parse_error (line_input);
486               goto done;
487             }
488         }
489       unformat_free (line_input);
490     }
491
492   fibs = (fproto == FIB_PROTOCOL_IP4) ? ip4_main.fibs : ip6_main.fibs;
493
494   if (table_id != (u32) ~0)
495     {
496       fib_index = fib_table_find (fproto, table_id);
497       if (fib_index == (u32) ~0)
498         {
499           error = clib_error_return (0, "Couldn't find table with table_id %u",
500                                      table_id);
501           goto done;
502         }
503
504       fib = fib_table_get (fib_index, fproto);
505       vlib_cli_output (vm, "[%3u] table_id:%3u %v", fib->ft_index,
506                        fib->ft_table_id, fib->ft_desc);
507     }
508   else
509     {
510       pool_foreach (fib, fibs)
511         vlib_cli_output (vm, "[%3u] table_id:%3u %v", fib->ft_index,
512                          fib->ft_table_id, fib->ft_desc);
513     }
514
515 done:
516   return error;
517 }
518
519 clib_error_t *
520 vnet_show_ip4_table_cmd (vlib_main_t *vm, unformat_input_t *main_input,
521                          vlib_cli_command_t *cmd)
522 {
523   return (vnet_show_ip_table_cmd (vm, main_input, cmd, FIB_PROTOCOL_IP4));
524 }
525
526 clib_error_t *
527 vnet_show_ip6_table_cmd (vlib_main_t *vm, unformat_input_t *main_input,
528                          vlib_cli_command_t *cmd)
529 {
530   return (vnet_show_ip_table_cmd (vm, main_input, cmd, FIB_PROTOCOL_IP6));
531 }
532
533 /* *INDENT-OFF* */
534 VLIB_CLI_COMMAND (vlib_cli_ip_command, static) = {
535   .path = "ip",
536   .short_help = "Internet protocol (IP) commands",
537 };
538 /* *INDENT-ON* */
539
540 /* *INDENT-OFF* */
541 VLIB_CLI_COMMAND (vlib_cli_ip6_command, static) = {
542   .path = "ip6",
543   .short_help = "Internet protocol version 6 (IPv6) commands",
544 };
545 /* *INDENT-ON* */
546
547 /* *INDENT-OFF* */
548 VLIB_CLI_COMMAND (vlib_cli_show_ip_command, static) = {
549   .path = "show ip",
550   .short_help = "Internet protocol (IP) show commands",
551 };
552 /* *INDENT-ON* */
553
554 /* *INDENT-OFF* */
555 VLIB_CLI_COMMAND (vlib_cli_show_ip6_command, static) = {
556   .path = "show ip6",
557   .short_help = "Internet protocol version 6 (IPv6) show commands",
558 };
559 /* *INDENT-ON* */
560
561 /*?
562  * This command is used to add or delete IPv4 or IPv6 routes. All
563  * IP Addresses ('<em><dst-ip-addr>/<width></em>',
564  * '<em><next-hop-ip-addr></em>' and '<em><adj-hop-ip-addr></em>')
565  * can be IPv4 or IPv6, but all must be of the same form in a single
566  * command. To display the current set of routes, use the commands
567  * '<em>show ip fib</em>' and '<em>show ip6 fib</em>'.
568  *
569  * @cliexpar
570  * Example of how to add a straight forward static route:
571  * @cliexcmd{ip route add 6.0.1.2/32 via 6.0.0.1 GigabitEthernet2/0/0}
572  * Example of how to delete a straight forward static route:
573  * @cliexcmd{ip route del 6.0.1.2/32 via 6.0.0.1 GigabitEthernet2/0/0}
574  * Mainly for route add/del performance testing, one can add or delete
575  * multiple routes by adding 'count N' to the previous item:
576  * @cliexcmd{ip route add count 10 7.0.0.0/24 via 6.0.0.1 GigabitEthernet2/0/0}
577  * Add multiple routes for the same destination to create equal-cost multipath:
578  * @cliexcmd{ip route add 7.0.0.1/32 via 6.0.0.1 GigabitEthernet2/0/0}
579  * @cliexcmd{ip route add 7.0.0.1/32 via 6.0.0.2 GigabitEthernet2/0/0}
580  * For unequal-cost multipath, specify the desired weights. This
581  * combination of weights results in 3/4 of the traffic following the
582  * second path, 1/4 following the first path:
583  * @cliexcmd{ip route add 7.0.0.1/32 via 6.0.0.1 GigabitEthernet2/0/0 weight 1}
584  * @cliexcmd{ip route add 7.0.0.1/32 via 6.0.0.2 GigabitEthernet2/0/0 weight 3}
585  * To add a route to a particular FIB table (VRF), use:
586  * @cliexcmd{ip route add 172.16.24.0/24 table 7 via GigabitEthernet2/0/0}
587  ?*/
588 /* *INDENT-OFF* */
589 VLIB_CLI_COMMAND (ip_route_command, static) = {
590   .path = "ip route",
591   .short_help = "ip route [add|del] [count <n>] <dst-ip-addr>/<width> [table <table-id>] via [next-hop-address] [next-hop-interface] [next-hop-table <value>] [weight <value>] [preference <value>] [udp-encap-id <value>] [ip4-lookup-in-table <value>] [ip6-lookup-in-table <value>] [mpls-lookup-in-table <value>] [resolve-via-host] [resolve-via-connected] [rx-ip4 <interface>] [out-labels <value value value>]",
592   .function = vnet_ip_route_cmd,
593   .is_mp_safe = 1,
594 };
595
596 /* *INDENT-ON* */
597 /*?
598  * This command is used to add or delete IPv4  Tables. All
599  * Tables must be explicitly added before that can be used. Creating a
600  * table will add both unicast and multicast FIBs
601  *
602  ?*/
603 /* *INDENT-OFF* */
604 VLIB_CLI_COMMAND (ip4_table_command, static) = {
605   .path = "ip table",
606   .short_help = "ip table [add|del] <table-id>",
607   .function = vnet_ip4_table_cmd,
608 };
609 /* *INDENT-ON* */
610
611 /* *INDENT-ON* */
612 /*?
613  * This command is used to add or delete IPv4  Tables. All
614  * Tables must be explicitly added before that can be used. Creating a
615  * table will add both unicast and multicast FIBs
616  *
617  ?*/
618 /* *INDENT-OFF* */
619 VLIB_CLI_COMMAND (ip6_table_command, static) = {
620   .path = "ip6 table",
621   .short_help = "ip6 table [add|del] <table-id>",
622   .function = vnet_ip6_table_cmd,
623 };
624
625 VLIB_CLI_COMMAND (show_ip4_table_command, static) = {
626   .path = "show ip table",
627   .short_help = "show ip table <table-id>",
628   .function = vnet_show_ip4_table_cmd,
629 };
630
631 VLIB_CLI_COMMAND (show_ip6_table_command, static) = {
632   .path = "show ip6 table",
633   .short_help = "show ip6 table <table-id>",
634   .function = vnet_show_ip6_table_cmd,
635 };
636
637 static clib_error_t *
638 ip_table_bind_cmd (vlib_main_t * vm,
639                    unformat_input_t * input,
640                    vlib_cli_command_t * cmd,
641                    fib_protocol_t fproto)
642 {
643   vnet_main_t *vnm = vnet_get_main ();
644   clib_error_t *error = 0;
645   u32 sw_if_index, table_id;
646   int rv;
647
648   sw_if_index = ~0;
649
650   if (!unformat_user (input, unformat_vnet_sw_interface, vnm, &sw_if_index))
651     {
652       error = clib_error_return (0, "unknown interface `%U'",
653                                  format_unformat_error, input);
654       goto done;
655     }
656
657   if (unformat (input, "%d", &table_id))
658     ;
659   else
660     {
661       error = clib_error_return (0, "expected table id `%U'",
662                                  format_unformat_error, input);
663       goto done;
664     }
665
666   rv = ip_table_bind (fproto, sw_if_index, table_id);
667
668   if (VNET_API_ERROR_ADDRESS_FOUND_FOR_INTERFACE == rv)
669     {
670       error = clib_error_return (0, "IP addresses are still present on %U",
671                                  format_vnet_sw_if_index_name,
672                                  vnet_get_main(),
673                                  sw_if_index);
674     }
675   else if (VNET_API_ERROR_NO_SUCH_FIB == rv)
676     {
677       error = clib_error_return (0, "no such table %d", table_id);
678     }
679   else if (0 != rv)
680     {
681       error = clib_error_return (0, "unknown error");
682     }
683
684  done:
685   return error;
686 }
687
688 static clib_error_t *
689 ip4_table_bind_cmd (vlib_main_t * vm,
690                     unformat_input_t * input,
691                     vlib_cli_command_t * cmd)
692 {
693   return (ip_table_bind_cmd (vm , input, cmd, FIB_PROTOCOL_IP4));
694 }
695
696 static clib_error_t *
697 ip6_table_bind_cmd (vlib_main_t * vm,
698                     unformat_input_t * input,
699                     vlib_cli_command_t * cmd)
700 {
701   return (ip_table_bind_cmd (vm , input, cmd, FIB_PROTOCOL_IP6));
702 }
703
704 /*?
705  * Place the indicated interface into the supplied IPv4 FIB table (also known
706  * as a VRF). The FIB table must be created using "ip table add" already. To
707  * display the current IPv4 FIB table, use the command '<em>show ip fib</em>'.
708  * FIB table will only be displayed if a route has been added to the table, or
709  * an IP Address is assigned to an interface in the table (which adds a route
710  * automatically).
711  *
712  * @note IP addresses added after setting the interface IP table are added to
713  * the indicated FIB table. If an IP address is added prior to changing the
714  * table then this is an error. The control plane must remove these addresses
715  * first and then change the table. VPP will not automatically move the
716  * addresses from the old to the new table as it does not know the validity
717  * of such a change.
718  *
719  * @cliexpar
720  * Example of how to add an interface to an IPv4 FIB table (where 2 is the table-id):
721  * @cliexcmd{set interface ip table GigabitEthernet2/0/0 2}
722  ?*/
723 /* *INDENT-OFF* */
724 VLIB_CLI_COMMAND (set_interface_ip_table_command, static) =
725 {
726   .path = "set interface ip table",
727   .function = ip4_table_bind_cmd,
728   .short_help = "set interface ip table <interface> <table-id>",
729 };
730 /* *INDENT-ON* */
731
732 /*?
733  * Place the indicated interface into the supplied IPv6 FIB table (also known
734  * as a VRF). The FIB table must be created using "ip6 table add" already. To
735  * display the current IPv6 FIB table, use the command '<em>show ip6 fib</em>'.
736  * FIB table will only be displayed if a route has been added to the table, or
737  * an IP Address is assigned to an interface in the table (which adds a route
738  * automatically).
739  *
740  * @note IP addresses added after setting the interface IP table are added to
741  * the indicated FIB table. If an IP address is added prior to changing the
742  * table then this is an error. The control plane must remove these addresses
743  * first and then change the table. VPP will not automatically move the
744  * addresses from the old to the new table as it does not know the validity
745  * of such a change.
746  *
747  * @cliexpar
748  * Example of how to add an interface to an IPv6 FIB table (where 2 is the table-id):
749  * @cliexcmd{set interface ip6 table GigabitEthernet2/0/0 2}
750  ?*/
751 /* *INDENT-OFF* */
752 VLIB_CLI_COMMAND (set_interface_ip6_table_command, static) =
753 {
754   .path = "set interface ip6 table",
755   .function = ip6_table_bind_cmd,
756   .short_help = "set interface ip6 table <interface> <table-id>"
757 };
758 /* *INDENT-ON* */
759
760 clib_error_t *
761 vnet_ip_mroute_cmd (vlib_main_t * vm,
762                     unformat_input_t * main_input, vlib_cli_command_t * cmd)
763 {
764   unformat_input_t _line_input, *line_input = &_line_input;
765   fib_route_path_t rpath, *rpaths = NULL;
766   clib_error_t *error = NULL;
767   u32 table_id, is_del, payload_proto;
768   mfib_prefix_t pfx;
769   u32 fib_index;
770   mfib_entry_flags_t eflags = 0;
771   u32 gcount, scount, ss, gg, incr;
772   f64 timet[2];
773   u32 rpf_id = MFIB_RPF_ID_NONE;
774
775   gcount = scount = 1;
776   is_del = 0;
777   table_id = 0;
778   clib_memset (&pfx, 0, sizeof (pfx));
779   clib_memset (&rpath, 0, sizeof (rpath));
780   rpath.frp_sw_if_index = ~0;
781
782   /* Get a line of input. */
783   if (!unformat_user (main_input, unformat_line_input, line_input))
784     return 0;
785
786   while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
787     {
788       if (unformat (line_input, "table %d", &table_id))
789         ;
790       else if (unformat (line_input, "del"))
791         is_del = 1;
792       else if (unformat (line_input, "add"))
793         is_del = 0;
794       else if (unformat (line_input, "rpf-id %d", &rpf_id))
795         ;
796       else if (unformat (line_input, "scount %d", &scount))
797         ;
798       else if (unformat (line_input, "gcount %d", &gcount))
799         ;
800       else if (unformat (line_input, "%U %U",
801                          unformat_ip4_address,
802                          &pfx.fp_src_addr.ip4,
803                          unformat_ip4_address, &pfx.fp_grp_addr.ip4))
804         {
805           payload_proto = pfx.fp_proto = FIB_PROTOCOL_IP4;
806           pfx.fp_len = 64;
807         }
808       else if (unformat (line_input, "%U %U",
809                          unformat_ip6_address,
810                          &pfx.fp_src_addr.ip6,
811                          unformat_ip6_address, &pfx.fp_grp_addr.ip6))
812         {
813           payload_proto = pfx.fp_proto = FIB_PROTOCOL_IP6;
814           pfx.fp_len = 256;
815         }
816       else if (unformat (line_input, "%U/%d",
817                          unformat_ip4_address,
818                          &pfx.fp_grp_addr.ip4, &pfx.fp_len))
819         {
820           clib_memset (&pfx.fp_src_addr.ip4, 0, sizeof (pfx.fp_src_addr.ip4));
821           payload_proto = pfx.fp_proto = FIB_PROTOCOL_IP4;
822         }
823       else if (unformat (line_input, "%U/%d",
824                          unformat_ip6_address,
825                          &pfx.fp_grp_addr.ip6, &pfx.fp_len))
826         {
827           clib_memset (&pfx.fp_src_addr.ip6, 0, sizeof (pfx.fp_src_addr.ip6));
828           payload_proto = pfx.fp_proto = FIB_PROTOCOL_IP6;
829         }
830       else if (unformat (line_input, "%U",
831                          unformat_ip4_address, &pfx.fp_grp_addr.ip4))
832         {
833           clib_memset (&pfx.fp_src_addr.ip4, 0, sizeof (pfx.fp_src_addr.ip4));
834           payload_proto = pfx.fp_proto = FIB_PROTOCOL_IP4;
835           pfx.fp_len = 32;
836         }
837       else if (unformat (line_input, "%U",
838                          unformat_ip6_address, &pfx.fp_grp_addr.ip6))
839         {
840           clib_memset (&pfx.fp_src_addr.ip6, 0, sizeof (pfx.fp_src_addr.ip6));
841           payload_proto = pfx.fp_proto = FIB_PROTOCOL_IP6;
842           pfx.fp_len = 128;
843         }
844       else if (unformat (line_input, "via local Forward"))
845         {
846           clib_memset (&rpath.frp_addr, 0, sizeof (rpath.frp_addr));
847           rpath.frp_sw_if_index = ~0;
848           rpath.frp_weight = 1;
849           rpath.frp_flags |= FIB_ROUTE_PATH_LOCAL;
850           /*
851            * set the path proto appropriately for the prefix
852            */
853           rpath.frp_proto = fib_proto_to_dpo (pfx.fp_proto);
854           rpath.frp_mitf_flags = MFIB_ITF_FLAG_FORWARD;
855
856           vec_add1 (rpaths, rpath);
857         }
858       else if (unformat (line_input, "via %U",
859                          unformat_fib_route_path, &rpath, &payload_proto))
860         {
861           vec_add1 (rpaths, rpath);
862         }
863       else if (unformat (line_input, "%U",
864                          unformat_mfib_entry_flags, &eflags))
865         ;
866       else
867         {
868           error = unformat_parse_error (line_input);
869           goto done;
870         }
871     }
872
873   if (~0 == table_id)
874     {
875       /*
876        * if no table_id is passed we will manipulate the default
877        */
878       fib_index = 0;
879     }
880   else
881     {
882       fib_index = mfib_table_find (pfx.fp_proto, table_id);
883
884       if (~0 == fib_index)
885         {
886           error = clib_error_return (0, "Nonexistent table id %d", table_id);
887           goto done;
888         }
889     }
890
891   timet[0] = vlib_time_now (vm);
892
893   if (FIB_PROTOCOL_IP4 == pfx.fp_proto)
894     {
895       incr = 1 << (32 - (pfx.fp_len % 32));
896     }
897   else
898     {
899       incr = 1 << (128 - (pfx.fp_len % 128));
900     }
901
902   for (ss = 0; ss < scount; ss++)
903     {
904       for (gg = 0; gg < gcount; gg++)
905         {
906           if (is_del && 0 == vec_len (rpaths))
907             {
908               /* no path provided => route delete */
909               mfib_table_entry_delete (fib_index, &pfx, MFIB_SOURCE_CLI);
910             }
911           else if (eflags || (MFIB_RPF_ID_NONE != rpf_id))
912             {
913               mfib_table_entry_update (fib_index, &pfx, MFIB_SOURCE_CLI,
914                                        rpf_id, eflags);
915             }
916           else
917             {
918               if (is_del)
919                 mfib_table_entry_path_remove (fib_index,
920                                               &pfx, MFIB_SOURCE_CLI, rpaths);
921               else
922                 mfib_table_entry_path_update (fib_index, &pfx, MFIB_SOURCE_CLI,
923                                               MFIB_ENTRY_FLAG_NONE, rpaths);
924             }
925
926           if (FIB_PROTOCOL_IP4 == pfx.fp_proto)
927             {
928               pfx.fp_grp_addr.ip4.as_u32 =
929                 clib_host_to_net_u32 (incr +
930                                       clib_net_to_host_u32 (pfx.
931                                                             fp_grp_addr.ip4.
932                                                             as_u32));
933             }
934           else
935             {
936               int bucket = (incr < 64 ? 0 : 1);
937               pfx.fp_grp_addr.ip6.as_u64[bucket] =
938                 clib_host_to_net_u64 (incr +
939                                       clib_net_to_host_u64 (pfx.
940                                                             fp_grp_addr.ip6.as_u64
941                                                             [bucket]));
942
943             }
944         }
945       if (FIB_PROTOCOL_IP4 == pfx.fp_proto)
946         {
947           pfx.fp_src_addr.ip4.as_u32 =
948             clib_host_to_net_u32 (1 +
949                                   clib_net_to_host_u32 (pfx.fp_src_addr.
950                                                         ip4.as_u32));
951         }
952       else
953         {
954           pfx.fp_src_addr.ip6.as_u64[1] =
955             clib_host_to_net_u64 (1 +
956                                   clib_net_to_host_u64 (pfx.fp_src_addr.
957                                                         ip6.as_u64[1]));
958         }
959     }
960
961   timet[1] = vlib_time_now (vm);
962
963   if (scount > 1 || gcount > 1)
964     vlib_cli_output (vm, "%.6e routes/sec",
965                      (scount * gcount) / (timet[1] - timet[0]));
966
967 done:
968   vec_free (rpaths);
969   unformat_free (line_input);
970
971   return error;
972 }
973
974 /*?
975  * This command is used to add or delete IPv4 or IPv6  multicast routes. All
976  * IP Addresses ('<em><dst-ip-addr>/<width></em>',
977  * '<em><next-hop-ip-addr></em>' and '<em><adj-hop-ip-addr></em>')
978  * can be IPv4 or IPv6, but all must be of the same form in a single
979  * command. To display the current set of routes, use the commands
980  * '<em>show ip mfib</em>' and '<em>show ip6 mfib</em>'.
981  * The full set of support flags for interfaces and route is shown via;
982  * '<em>show mfib route flags</em>' and '<em>show mfib itf flags</em>'
983  * respectively.
984  * @cliexpar
985  * Example of how to add a forwarding interface to a route (and create the
986  * route if it does not exist)
987  * @cliexcmd{ip mroute add 232.1.1.1 via GigabitEthernet2/0/0 Forward}
988  * Example of how to add an accepting interface to a route (and create the
989  * route if it does not exist)
990  * @cliexcmd{ip mroute add 232.1.1.1 via GigabitEthernet2/0/1 Accept}
991  * Example of changing the route's flags to send signals via the API
992  * @cliexcmd{ip mroute add 232.1.1.1 Signal}
993
994  ?*/
995 /* *INDENT-OFF* */
996 VLIB_CLI_COMMAND (ip_mroute_command, static) =
997 {
998   .path = "ip mroute",
999   .short_help = "ip mroute [add|del] <dst-ip-addr>/<width> [table <table-id>] [rpf-id <ID>] [via <next-hop-ip-addr> [<interface>],",
1000   .function = vnet_ip_mroute_cmd,
1001   .is_mp_safe = 1,
1002 };
1003 /* *INDENT-ON* */
1004
1005 /*
1006  * fd.io coding-style-patch-verification: ON
1007  *
1008  * Local Variables:
1009  * eval: (c-set-style "gnu")
1010  * End:
1011  */