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