0c2e4c7b7965b11844e2be11a8846d78740a1e00
[vpp.git] / src / vnet / mfib / ip6_mfib.c
1 /*
2  * Copyright (c) 2016 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 #include <vnet/mfib/ip6_mfib.h>
17
18 #include <vnet/mfib/mfib_table.h>
19 #include <vnet/mfib/mfib_entry.h>
20 #include <vnet/fib/ip6_fib.h>
21
22 /**
23  * The number of bytes in an address/ask key in the radix tree
24  * First byte is the length in bytes.
25  */
26 #define IP6_MFIB_KEY_LEN 33
27
28 /**
29  * Key and mask for radix
30  */
31 typedef struct ip6_mfib_key_t_
32 {
33     u8 key[IP6_MFIB_KEY_LEN];
34     u8 mask[IP6_MFIB_KEY_LEN];
35 } ip6_mfib_key_t;
36
37 /**
38  * An object that is inserted into the radix tree.
39  * Since it's in the tree and has pointers, it cannot realloc and so cannot
40  * come from a vlib pool.
41  */
42 typedef struct ip6_mfib_node_t_
43 {
44     struct radix_node i6mn_nodes[2];
45     ip6_mfib_key_t i6mn_key;
46     index_t i6mn_entry;
47 } ip6_mfib_node_t;
48
49 static const mfib_prefix_t all_zeros = {
50     /* (*,*) */
51     .fp_src_addr = {
52         .ip6.as_u64 = {0, 0},
53     },
54     .fp_grp_addr = {
55         .ip6.as_u64 = {0, 0},
56     },
57     .fp_len  = 0,
58     .fp_proto = FIB_PROTOCOL_IP6,
59 };
60
61 typedef enum ip6_mfib_special_type_t_ {
62     IP6_MFIB_SPECIAL_TYPE_NONE,
63     IP6_MFIB_SPECIAL_TYPE_SOLICITED,
64 } ip6_mfib_special_type_t;
65
66 typedef struct ip6_mfib_special_t_ {
67     /**
68      * @brief solicited or not
69      */
70     ip6_mfib_special_type_t ims_type;
71
72     /**
73      * @brief the Prefix length
74      */
75     u8 ims_len;
76
77     /**
78      * @brief The last byte of the mcast address
79      */
80     u8 ims_byte;
81     /**
82      * @brief The scope of the address
83      */
84     u8 ims_scope;
85 } ip6_mfib_special_t;
86
87 static const ip6_mfib_special_t ip6_mfib_specials[] =
88 {
89     {
90         /*
91          * Add ff02::1:ff00:0/104 via local route for all tables.
92          *  This is required for neighbor discovery to work.
93          */
94         .ims_type = IP6_MFIB_SPECIAL_TYPE_SOLICITED,
95         .ims_len = 104,
96     },
97     {
98         /*
99          * all-routers multicast address
100          */
101         .ims_type = IP6_MFIB_SPECIAL_TYPE_NONE,
102         .ims_scope = IP6_MULTICAST_SCOPE_link_local,
103         .ims_byte = IP6_MULTICAST_GROUP_ID_all_routers,
104         .ims_len = 128,
105     },
106     {
107         /*
108          * all-nodes multicast address
109          */
110         .ims_type = IP6_MFIB_SPECIAL_TYPE_NONE,
111         .ims_scope = IP6_MULTICAST_SCOPE_link_local,
112         .ims_byte = IP6_MULTICAST_GROUP_ID_all_hosts,
113         .ims_len = 128,
114     },
115     {
116         /*
117          *  Add all-mldv2  multicast address via local route for all tables
118          */
119         .ims_type = IP6_MFIB_SPECIAL_TYPE_NONE,
120         .ims_len = 128,
121         .ims_scope = IP6_MULTICAST_SCOPE_link_local,
122         .ims_byte = IP6_MULTICAST_GROUP_ID_mldv2_routers,
123     }
124 };
125
126 #define FOR_EACH_IP6_SPECIAL(_pfx, _body)                               \
127 {                                                                       \
128     const ip6_mfib_special_t *_spec;                                    \
129     u8 _ii;                                                             \
130     for (_ii = 0;                                                       \
131          _ii < ARRAY_LEN(ip6_mfib_specials);                            \
132          _ii++)                                                         \
133     {                                                                   \
134         _spec = &ip6_mfib_specials[_ii];                                \
135         if (IP6_MFIB_SPECIAL_TYPE_SOLICITED == _spec->ims_type)         \
136         {                                                               \
137             ip6_set_solicited_node_multicast_address(                   \
138                 &(_pfx)->fp_grp_addr.ip6, 0);                           \
139         }                                                               \
140         else                                                            \
141         {                                                               \
142             ip6_set_reserved_multicast_address (                        \
143                 &(_pfx)->fp_grp_addr.ip6,                               \
144                 _spec->ims_scope,                                       \
145                 _spec->ims_byte);                                       \
146         }                                                               \
147         (_pfx)->fp_len = _spec->ims_len;                                \
148         do { _body; } while (0);                                        \
149     }                                                                   \
150 }
151
152
153 static u32
154 ip6_create_mfib_with_table_id (u32 table_id)
155 {
156     mfib_table_t *mfib_table;
157     mfib_prefix_t pfx = {
158         .fp_proto = FIB_PROTOCOL_IP6,
159     };
160     const fib_route_path_t path_for_us = {
161         .frp_proto = FIB_PROTOCOL_IP6,
162         .frp_addr = zero_addr,
163         .frp_sw_if_index = 0xffffffff,
164         .frp_fib_index = ~0,
165         .frp_weight = 0,
166         .frp_flags = FIB_ROUTE_PATH_LOCAL,
167     };
168
169     pool_get_aligned(ip6_main.mfibs, mfib_table, CLIB_CACHE_LINE_BYTES);
170     memset(mfib_table, 0, sizeof(*mfib_table));
171
172     mfib_table->mft_proto = FIB_PROTOCOL_IP6;
173     mfib_table->mft_index =
174         mfib_table->v6.index =
175             (mfib_table - ip6_main.mfibs);
176
177     hash_set (ip6_main.mfib_index_by_table_id,
178               table_id,
179               mfib_table->mft_index);
180
181     mfib_table->mft_table_id =
182         mfib_table->v6.table_id =
183             table_id;
184
185     mfib_table_lock(mfib_table->mft_index, FIB_PROTOCOL_IP6);
186
187     mfib_table->v6.rhead =
188         clib_mem_alloc_aligned (sizeof(*mfib_table->v6.rhead),
189                                 CLIB_CACHE_LINE_BYTES);
190     rn_inithead0(mfib_table->v6.rhead, 8);
191
192     /*
193      * add the special entries into the new FIB
194      */
195     mfib_table_entry_update(mfib_table->mft_index,
196                             &all_zeros,
197                             MFIB_SOURCE_DEFAULT_ROUTE,
198                             MFIB_ENTRY_FLAG_DROP);
199
200     /*
201      * Add each of the specials
202      */
203     FOR_EACH_IP6_SPECIAL(&pfx,
204     ({
205         mfib_table_entry_path_update(mfib_table->mft_index,
206                                      &pfx,
207                                      MFIB_SOURCE_SPECIAL,
208                                      &path_for_us,
209                                      MFIB_ITF_FLAG_FORWARD);
210     }));
211
212     return (mfib_table->mft_index);
213 }
214
215 void
216 ip6_mfib_table_destroy (ip6_mfib_t *mfib)
217 {
218     mfib_table_t *mfib_table = (mfib_table_t*)mfib;
219     fib_node_index_t mfei;
220     mfib_prefix_t pfx = {
221         .fp_proto = FIB_PROTOCOL_IP6,
222     };
223     const fib_route_path_t path_for_us = {
224         .frp_proto = FIB_PROTOCOL_IP6,
225         .frp_addr = zero_addr,
226         .frp_sw_if_index = 0xffffffff,
227         .frp_fib_index = ~0,
228         .frp_weight = 0,
229         .frp_flags = FIB_ROUTE_PATH_LOCAL,
230     };
231
232     /*
233      * remove all the specials we added when the table was created.
234      */
235     FOR_EACH_IP6_SPECIAL(&pfx,
236     {
237         mfib_table_entry_path_remove(mfib_table->mft_index,
238                                      &pfx,
239                                      MFIB_SOURCE_SPECIAL,
240                                      &path_for_us);
241     });
242
243     mfei = mfib_table_lookup_exact_match(mfib_table->mft_index, &all_zeros);
244     mfib_table_entry_delete_index(mfei, MFIB_SOURCE_DEFAULT_ROUTE);
245
246     /*
247      * validate no more routes.
248      */
249     ASSERT(0 == mfib_table->mft_total_route_counts);
250     ASSERT(~0 != mfib_table->mft_table_id);
251
252     hash_unset (ip6_main.mfib_index_by_table_id, mfib_table->mft_table_id);
253     clib_mem_free(mfib_table->v6.rhead);
254     pool_put(ip6_main.mfibs, mfib_table);
255 }
256
257 void
258 ip6_mfib_interface_enable_disable (u32 sw_if_index, int is_enable)
259 {
260     const fib_route_path_t path = {
261         .frp_proto = FIB_PROTOCOL_IP6,
262         .frp_addr = zero_addr,
263         .frp_sw_if_index = sw_if_index,
264         .frp_fib_index = ~0,
265         .frp_weight = 0,
266     };
267     mfib_prefix_t pfx = {
268         .fp_proto = FIB_PROTOCOL_IP6,
269     };
270     u32 mfib_index;
271
272     vec_validate (ip6_main.mfib_index_by_sw_if_index, sw_if_index);
273     mfib_index = ip6_mfib_table_get_index_for_sw_if_index(sw_if_index);
274
275     if (is_enable)
276     {
277         FOR_EACH_IP6_SPECIAL(&pfx,
278         {
279             mfib_table_entry_path_update(mfib_index,
280                                          &pfx,
281                                          MFIB_SOURCE_SPECIAL,
282                                          &path,
283                                          MFIB_ITF_FLAG_ACCEPT);
284         });
285     }
286     else
287     {
288         FOR_EACH_IP6_SPECIAL(&pfx,
289         {
290             mfib_table_entry_path_remove(mfib_index,
291                                          &pfx,
292                                          MFIB_SOURCE_SPECIAL,
293                                          &path);
294         });
295     }
296 }
297
298 u32
299 ip6_mfib_table_find_or_create_and_lock (u32 table_id)
300 {
301     u32 index;
302
303     index = ip6_mfib_index_from_table_id(table_id);
304     if (~0 == index)
305         return ip6_create_mfib_with_table_id(table_id);
306     mfib_table_lock(index, FIB_PROTOCOL_IP6);
307
308     return (index);
309 }
310
311 u32
312 ip6_mfib_table_get_index_for_sw_if_index (u32 sw_if_index)
313 {
314     if (sw_if_index >= vec_len(ip6_main.mfib_index_by_sw_if_index))
315     {
316         /*
317          * This is the case for interfaces that are not yet mapped to
318          * a IP table
319          */
320         return (~0);
321     }
322     return (ip6_main.mfib_index_by_sw_if_index[sw_if_index]);
323 }
324
325 #define IP6_MFIB_MK_KEY(_grp, _src, _key)                           \
326 {                                                                   \
327     (_key)->key[0] = 33;                                            \
328     memcpy((_key)->key+1, _grp, 16);                                \
329     memcpy((_key)->key+17, _src, 16);                               \
330 }
331
332 #define IP6_MFIB_MK_KEY_MASK(_grp, _src, _len, _key)                \
333 {                                                                   \
334     IP6_MFIB_MK_KEY(_grp, _src, _key);                              \
335                                                                     \
336     (_key)->mask[0] = 33;                                           \
337     if (_len <= 128)                                                \
338     {                                                               \
339         memcpy((_key)->mask+1, &ip6_main.fib_masks[_len], 16);      \
340         memset((_key)->mask+17, 0, 16);                             \
341     }                                                               \
342     else                                                            \
343     {                                                               \
344         ASSERT(_len == 256);                                        \
345         memcpy((_key)->mask+1, &ip6_main.fib_masks[128], 16);       \
346         memcpy((_key)->mask+17, &ip6_main.fib_masks[128], 16);      \
347     }                                                               \
348 }
349
350 /*
351  * ip6_fib_table_lookup_exact_match
352  *
353  * Exact match prefix lookup
354  */
355 fib_node_index_t
356 ip6_mfib_table_lookup_exact_match (const ip6_mfib_t *mfib,
357                                    const ip6_address_t *grp,
358                                    const ip6_address_t *src,
359                                    u32 len)
360 {
361     ip6_mfib_node_t *i6mn;
362     ip6_mfib_key_t key;
363
364     IP6_MFIB_MK_KEY_MASK(grp, src, len, &key);
365
366     i6mn = (ip6_mfib_node_t*) rn_lookup(key.key, key.mask,
367                                         (struct radix_node_head *)mfib->rhead);
368
369     if (NULL == i6mn)
370     {
371         return (INDEX_INVALID);
372     }
373
374     return (i6mn->i6mn_entry);
375 }
376
377 /*
378  * ip6_fib_table_lookup
379  *
380  * Longest prefix match
381  */
382 fib_node_index_t
383 ip6_mfib_table_lookup (const ip6_mfib_t *mfib,
384                        const ip6_address_t *src,
385                        const ip6_address_t *grp,
386                        u32 len)
387 {
388     ip6_mfib_node_t *i6mn;
389     ip6_mfib_key_t key;
390
391     IP6_MFIB_MK_KEY_MASK(grp, src, len, &key);
392
393     i6mn = (ip6_mfib_node_t*) rn_search_m(key.key,
394                                           mfib->rhead->rnh_treetop,
395                                           key.mask);
396
397     ASSERT(NULL != i6mn);
398
399     return (i6mn->i6mn_entry);
400 }
401
402 /*
403  * ip6_fib_table_lookup
404  *
405  * Longest prefix match no mask
406  */
407 fib_node_index_t
408 ip6_mfib_table_lookup2 (const ip6_mfib_t *mfib,
409                         const ip6_address_t *src,
410                         const ip6_address_t *grp)
411 {
412     ip6_mfib_node_t *i6mn;
413     ip6_mfib_key_t key;
414
415     IP6_MFIB_MK_KEY(grp, src, &key);
416
417     i6mn = (ip6_mfib_node_t*) rn_match(key.key,
418                                        (struct radix_node_head *)mfib->rhead); // const cast
419
420     ASSERT(NULL != i6mn);
421
422     return (i6mn->i6mn_entry);
423 }
424
425 void
426 ip6_mfib_table_entry_insert (ip6_mfib_t *mfib,
427                              const ip6_address_t *grp,
428                              const ip6_address_t *src,
429                              u32 len,
430                              fib_node_index_t mfib_entry_index)
431 {
432     ip6_mfib_node_t *i6mn = clib_mem_alloc(sizeof(*i6mn));
433
434     memset(i6mn, 0, sizeof(*i6mn));
435
436     IP6_MFIB_MK_KEY_MASK(grp, src, len, &i6mn->i6mn_key);
437     i6mn->i6mn_entry = mfib_entry_index;
438
439     if (NULL == rn_addroute(i6mn->i6mn_key.key,
440                             i6mn->i6mn_key.mask,
441                             mfib->rhead,
442                             i6mn->i6mn_nodes))
443     {
444         ASSERT(0);
445     }
446 }
447
448 void
449 ip6_mfib_table_entry_remove (ip6_mfib_t *mfib,
450                              const ip6_address_t *grp,
451                              const ip6_address_t *src,
452                              u32 len)
453 {
454     ip6_mfib_node_t *i6mn;
455     ip6_mfib_key_t key;
456
457     IP6_MFIB_MK_KEY_MASK(grp, src, len, &key);
458
459     i6mn = (ip6_mfib_node_t*) rn_delete(key.key, key.mask, mfib->rhead);
460
461     clib_mem_free(i6mn);
462 }
463
464 static clib_error_t *
465 ip6_mfib_module_init (vlib_main_t * vm)
466 {
467     return (NULL);
468 }
469
470 VLIB_INIT_FUNCTION(ip6_mfib_module_init);
471
472 static void
473 ip6_mfib_table_show_one (ip6_mfib_t *mfib,
474                          vlib_main_t * vm,
475                          ip6_address_t *src,
476                          ip6_address_t *grp,
477                          u32 mask_len)
478 {
479     vlib_cli_output(vm, "%U",
480                     format_mfib_entry,
481                     ip6_mfib_table_lookup(mfib, src, grp, mask_len),
482                     MFIB_ENTRY_FORMAT_DETAIL);
483 }
484
485 typedef struct ip6_mfib_show_ctx_t_ {
486     u32 fib_index;
487     fib_node_index_t *entries;
488 } ip6_mfib_show_ctx_t;
489
490
491 static int
492 ip6_mfib_table_collect_entries (struct radix_node *rn, void *arg)
493 {
494     ip6_mfib_show_ctx_t *ctx = arg;
495     ip6_mfib_node_t *i6mn;
496
497     i6mn = (ip6_mfib_node_t*) rn;
498
499     vec_add1(ctx->entries, i6mn->i6mn_entry);
500
501     return (0);
502 }
503
504 static void
505 ip6_mfib_table_show_all (ip6_mfib_t *mfib,
506                          vlib_main_t * vm)
507 {
508     fib_node_index_t *mfib_entry_index;
509     ip6_mfib_show_ctx_t ctx = {
510         .fib_index = mfib->index,
511         .entries = NULL,
512     };
513
514     rn_walktree(mfib->rhead,
515                 ip6_mfib_table_collect_entries,
516                 &ctx);
517
518     vec_sort_with_function(ctx.entries, mfib_entry_cmp_for_sort);
519
520     vec_foreach(mfib_entry_index, ctx.entries)
521     {
522         vlib_cli_output(vm, "%U",
523                         format_mfib_entry,
524                         *mfib_entry_index,
525                         MFIB_ENTRY_FORMAT_BRIEF);
526     }
527
528     vec_free(ctx.entries);
529 }
530
531 static clib_error_t *
532 ip6_show_mfib (vlib_main_t * vm,
533                unformat_input_t * input,
534                vlib_cli_command_t * cmd)
535 {
536     ip6_main_t * im4 = &ip6_main;
537     mfib_table_t *mfib_table;
538     int verbose, matching;
539     ip6_address_t grp, src = {{0}};
540     u32 mask = 32;
541     int table_id = -1, fib_index = ~0;
542
543     verbose = 1;
544     matching = 0;
545
546     while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
547     {
548         if (unformat (input, "brief") || unformat (input, "summary")
549             || unformat (input, "sum"))
550             verbose = 0;
551
552         else if (unformat (input, "%U %U",
553                            unformat_ip6_address, &src,
554                            unformat_ip6_address, &grp))
555         {
556             matching = 1;
557             mask = 64;
558         }
559         else if (unformat (input, "%U", unformat_ip6_address, &grp))
560         {
561             matching = 1;
562             mask = 32;
563         }
564         else if (unformat (input, "%U/%d",
565                            unformat_ip6_address, &grp, &mask))
566             matching = 1;
567         else if (unformat (input, "table %d", &table_id))
568             ;
569         else if (unformat (input, "index %d", &fib_index))
570             ;
571         else
572             break;
573     }
574
575     pool_foreach (mfib_table, im4->mfibs,
576     ({
577         ip6_mfib_t *mfib = &mfib_table->v6;
578
579         if (table_id >= 0 && table_id != (int)mfib->table_id)
580             continue;
581         if (fib_index != ~0 && fib_index != (int)mfib->index)
582             continue;
583
584         vlib_cli_output (vm, "%U, fib_index %d",
585                          format_mfib_table_name, mfib->index, FIB_PROTOCOL_IP6,
586                          mfib->index);
587
588         /* Show summary? */
589         if (! verbose)
590         {
591             /* vlib_cli_output (vm, "%=20s%=16s", "Prefix length", "Count"); */
592             /* for (i = 0; i < ARRAY_LEN (mfib->fib_entry_by_dst_address); i++) */
593             /* { */
594             /*     uword * hash = mfib->fib_entry_by_dst_address[i]; */
595             /*     uword n_elts = hash_elts (hash); */
596             /*     if (n_elts > 0) */
597             /*         vlib_cli_output (vm, "%20d%16d", i, n_elts); */
598             /* } */
599             continue;
600         }
601
602         if (!matching)
603         {
604             ip6_mfib_table_show_all(mfib, vm);
605         }
606         else
607         {
608             ip6_mfib_table_show_one(mfib, vm, &src, &grp, mask);
609         }
610     }));
611
612     return 0;
613 }
614
615 /*
616  * This command displays the IPv4 MulticasrFIB Tables (VRF Tables) and
617  * the route entries for each table.
618  *
619  * @note This command will run for a long time when the FIB tables are
620  * comprised of millions of entries. For those senarios, consider displaying
621  * a single table or summary mode.
622  *
623  * @cliexpar
624  * Example of how to display all the IPv4 Multicast FIB tables:
625  * @cliexstart{show ip fib}
626  * ipv4-VRF:0, fib_index 0
627  * (*, 0.0.0.0/0):  flags:D,
628  *  Interfaces:
629  *  multicast-ip6-chain
630  *   [@1]: dpo-drop ip6
631  * (*, 232.1.1.1/32):
632  * Interfaces:
633  *  test-eth1: Forward,
634  *  test-eth2: Forward,
635  *  test-eth0: Accept,
636  * multicast-ip6-chain
637  * [@2]: dpo-replicate: [index:1 buckets:2 to:[0:0]]
638  *   [0] [@1]: ipv4-mcast: test-eth1: IP6: d0:d1:d2:d3:d4:01 -> 01:00:05:00:00:00
639  *   [1] [@1]: ipv4-mcast: test-eth2: IP6: d0:d1:d2:d3:d4:02 -> 01:00:05:00:00:00
640  *
641  * @cliexend
642  * Example of how to display a summary of all IPv4 FIB tables:
643  * @cliexstart{show ip fib summary}
644  * ipv4-VRF:0, fib_index 0, flow hash: src dst sport dport proto
645  *     Prefix length         Count
646  *                    0               1
647  *                    8               2
648  *                   32               4
649  * ipv4-VRF:7, fib_index 1, flow hash: src dst sport dport proto
650  *     Prefix length         Count
651  *                    0               1
652  *                    8               2
653  *                   24               2
654  *                   32               4
655  * @cliexend
656  */
657 /* *INDENT-OFF* */
658 VLIB_CLI_COMMAND (ip6_show_fib_command, static) = {
659     .path = "show ip6 mfib",
660     .short_help = "show ip mfib [summary] [table <table-id>] [index <fib-id>] [<grp-addr>[/<mask>]] [<grp-addr>] [<src-addr> <grp-addr>]",
661     .function = ip6_show_mfib,
662 };
663 /* *INDENT-ON* */