BIER: fix support for longer bit-string lengths
[vpp.git] / src / vnet / bier / bier_test.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
17 #include <vnet/mpls/mpls.h>
18 #include <vnet/bier/bier_table.h>
19 #include <vnet/bier/bier_entry.h>
20 #include <vnet/bier/bier_fmask.h>
21 #include <vnet/bier/bier_bit_string.h>
22 #include <vnet/bier/bier_imp.h>
23 #include <vnet/bier/bier_disp_table.h>
24 #include <vnet/bier/bier_disp_entry.h>
25 #include <vnet/fib/fib_entry.h>
26 #include <vnet/fib/fib_table.h>
27 #include <vnet/fib/mpls_fib.h>
28 #include <vnet/dpo/load_balance.h>
29 #include <vnet/dpo/drop_dpo.h>
30 #include <vnet/dpo/lookup_dpo.h>
31 #include <vnet/mfib/mfib_table.h>
32
33 #include <vnet/fib/fib_test.h>
34
35 /*
36  * Add debugs for passing tests
37  */
38 static int bier_test_do_debug;
39
40 #define BIER_TEST_I(_cond, _comment, _args...)                  \
41 ({                                                              \
42     int _evald = (_cond);                                       \
43     if (!(_evald)) {                                            \
44         fformat(stderr, "FAIL:%d: " _comment "\n",              \
45                 __LINE__, ##_args);                             \
46     } else {                                                    \
47         if (bier_test_do_debug)                                 \
48             fformat(stderr, "PASS:%d: " _comment "\n",          \
49                     __LINE__, ##_args);                         \
50     }                                                           \
51     _evald;                                                     \
52 })
53 #define BIER_TEST(_cond, _comment, _args...)                    \
54 {                                                               \
55     if (!BIER_TEST_I(_cond, _comment, ##_args)) {               \
56         return 1;                                               \
57         ASSERT(!("FAIL: " _comment));                           \
58     }                                                           \
59 }
60
61 /**
62  * A 'i'm not fussed is this is not efficient' store of test data
63  */
64 typedef struct test_main_t_ {
65     /**
66      * HW if indicies
67      */
68     u32 hw_if_indicies[4];
69     /**
70      * HW interfaces
71      */
72     vnet_hw_interface_t * hw[4];
73
74 } test_main_t;
75 static test_main_t test_main;
76
77 /* fake ethernet device class, distinct from "fake-ethX" */
78 static u8 * format_test_interface_name (u8 * s, va_list * args)
79 {
80   u32 dev_instance = va_arg (*args, u32);
81   return format (s, "test-eth%d", dev_instance);
82 }
83
84 static uword dummy_interface_tx (vlib_main_t * vm,
85                                  vlib_node_runtime_t * node,
86                                  vlib_frame_t * frame)
87 {
88   clib_warning ("you shouldn't be here, leaking buffers...");
89   return frame->n_vectors;
90 }
91
92 VNET_DEVICE_CLASS (test_interface_device_class,static) = {
93   .name = "Test interface",
94   .format_device_name = format_test_interface_name,
95   .tx_function = dummy_interface_tx,
96 };
97
98 static u8 *hw_address;
99
100 static int
101 bier_test_mk_intf (u32 ninterfaces)
102 {
103     clib_error_t * error = NULL;
104     test_main_t *tm = &test_main;
105     u8 byte;
106     u32 i;
107
108     ASSERT(ninterfaces <= ARRAY_LEN(tm->hw_if_indicies));
109
110     for (i=0; i<6; i++)
111     {
112         byte = 0xd0+i;
113         vec_add1(hw_address, byte);
114     }
115
116     for (i = 0; i < ninterfaces; i++)
117     {
118         hw_address[5] = i;
119
120         error = ethernet_register_interface(vnet_get_main(),
121                                             test_interface_device_class.index,
122                                             i /* instance */,
123                                             hw_address,
124                                             &tm->hw_if_indicies[i],
125                                             /* flag change */ 0);
126
127         BIER_TEST((NULL == error), "ADD interface %d", i);
128
129         tm->hw[i] = vnet_get_hw_interface(vnet_get_main(),
130                                           tm->hw_if_indicies[i]);
131         vec_validate (ip4_main.fib_index_by_sw_if_index, tm->hw[i]->sw_if_index);
132         vec_validate (ip6_main.fib_index_by_sw_if_index, tm->hw[i]->sw_if_index);
133         ip4_main.fib_index_by_sw_if_index[tm->hw[i]->sw_if_index] = 0;
134         ip6_main.fib_index_by_sw_if_index[tm->hw[i]->sw_if_index] = 0;
135         error = vnet_sw_interface_set_flags(vnet_get_main(),
136                                             tm->hw[i]->sw_if_index,
137                                             VNET_SW_INTERFACE_FLAG_ADMIN_UP);
138         BIER_TEST((NULL == error), "UP interface %d", i);
139     }
140     /*
141      * re-eval after the inevitable realloc
142      */
143     for (i = 0; i < ninterfaces; i++)
144     {
145         tm->hw[i] = vnet_get_hw_interface(vnet_get_main(),
146                                           tm->hw_if_indicies[i]);
147     }
148
149     return (0);
150 }
151
152 #define BIER_TEST_LB(_cond, _comment, _args...)                 \
153 {                                                               \
154     if (!BIER_TEST_I(_cond, _comment, ##_args)) {               \
155         return (0);                                             \
156     }                                                           \
157 }
158
159 static int
160 bier_test_validate_entry (index_t bei,
161                           u16 n_buckets,
162                           ...)
163 {
164     dpo_id_t dpo = DPO_INVALID;
165     const load_balance_t *lb;
166     va_list ap;
167     int res;
168
169     va_start(ap, n_buckets);
170
171     bier_entry_contribute_forwarding(bei, &dpo);
172
173     res = BIER_TEST_I((DPO_LOAD_BALANCE == dpo.dpoi_type),
174                       "Entry links to %U",
175                       format_dpo_type, dpo.dpoi_type);
176
177     if (res)
178     {
179         lb = load_balance_get(dpo.dpoi_index);
180         res = fib_test_validate_lb_v(lb, n_buckets, &ap);
181     }
182
183     dpo_reset(&dpo);
184     va_end(ap);
185
186     return (res);
187 }
188
189 static int
190 bier_test_mpls_spf (void)
191 {
192     fib_node_index_t lfei, fei, bti;
193     u32 mpls_fib_index;
194     test_main_t *tm;
195     int lb_count;
196
197     lb_count = pool_elts(load_balance_pool);
198     tm = &test_main;
199 #define N_BIER_ECMP_TABLES 16
200     int ii;
201
202     /*
203      * Add the BIER Main table
204      */
205     const bier_table_id_t bt_0_0_0_256 = {
206         .bti_set = 0,
207         .bti_sub_domain = 0,
208         .bti_hdr_len = BIER_HDR_LEN_256,
209         .bti_type = BIER_TABLE_MPLS_SPF,
210         .bti_ecmp = BIER_ECMP_TABLE_ID_MAIN,
211     };
212
213     bti = bier_table_add_or_lock(&bt_0_0_0_256, 1600);
214
215     fib_test_lb_bucket_t l_o_bt[N_BIER_ECMP_TABLES];
216     bier_table_id_t bt_ecmp_0_0_0_256 = bt_0_0_0_256;
217
218     for (ii = 0; ii < N_BIER_ECMP_TABLES; ii++)
219     {
220         bt_ecmp_0_0_0_256.bti_ecmp = ii;
221
222         l_o_bt[ii].type = FT_LB_BIER_TABLE;
223         l_o_bt[ii].bier.table =
224             bier_table_ecmp_create_and_lock(&bt_ecmp_0_0_0_256);
225     };
226     const fib_prefix_t pfx_1600_neos = {
227         .fp_len = 21,
228         .fp_proto = FIB_PROTOCOL_MPLS,
229         .fp_label = 1600,
230         .fp_eos = MPLS_NON_EOS,
231         .fp_payload_proto = DPO_PROTO_BIER,
232     };
233     const fib_prefix_t pfx_1600_eos = {
234         .fp_len = 21,
235         .fp_proto = FIB_PROTOCOL_MPLS,
236         .fp_label = 1600,
237         .fp_eos = MPLS_EOS,
238         .fp_payload_proto = DPO_PROTO_BIER,
239     };
240
241     mpls_fib_index = fib_table_find(FIB_PROTOCOL_MPLS,
242                                     MPLS_FIB_DEFAULT_TABLE_ID);
243
244     lfei = fib_table_lookup(mpls_fib_index, &pfx_1600_neos);
245     BIER_TEST(FIB_NODE_INDEX_INVALID == lfei, "1600/0 is not present");
246
247     lfei = fib_table_lookup(mpls_fib_index, &pfx_1600_eos);
248     BIER_TEST(fib_test_validate_entry(lfei, FIB_FORW_CHAIN_TYPE_MPLS_EOS,
249                                       16,
250                                       &l_o_bt[0],
251                                       &l_o_bt[1],
252                                       &l_o_bt[2],
253                                       &l_o_bt[3],
254                                       &l_o_bt[4],
255                                       &l_o_bt[5],
256                                       &l_o_bt[6],
257                                       &l_o_bt[7],
258                                       &l_o_bt[8],
259                                       &l_o_bt[9],
260                                       &l_o_bt[10],
261                                       &l_o_bt[11],
262                                       &l_o_bt[12],
263                                       &l_o_bt[13],
264                                       &l_o_bt[14],
265                                       &l_o_bt[15]),
266               "1600/1 LB stacks on BIER table %d", bti);
267
268     /*
269      * modify the table's local label - keep the lock count accurate
270      */
271     const fib_prefix_t pfx_1601_eos = {
272         .fp_len = 21,
273         .fp_proto = FIB_PROTOCOL_MPLS,
274         .fp_label = 1601,
275         .fp_eos = MPLS_EOS,
276         .fp_payload_proto = DPO_PROTO_BIER,
277     };
278     bti = bier_table_add_or_lock(&bt_0_0_0_256, 1601);
279     bier_table_unlock(&bt_0_0_0_256);
280
281     lfei = fib_table_lookup(mpls_fib_index, &pfx_1600_eos);
282     BIER_TEST(FIB_NODE_INDEX_INVALID == lfei, "1600/1 is deleted");
283
284     lfei = fib_table_lookup(mpls_fib_index, &pfx_1601_eos);
285     BIER_TEST(fib_test_validate_entry(lfei, FIB_FORW_CHAIN_TYPE_MPLS_EOS,
286                                       16,
287                                       &l_o_bt[0],
288                                       &l_o_bt[1],
289                                       &l_o_bt[2],
290                                       &l_o_bt[3],
291                                       &l_o_bt[4],
292                                       &l_o_bt[5],
293                                       &l_o_bt[6],
294                                       &l_o_bt[7],
295                                       &l_o_bt[8],
296                                       &l_o_bt[9],
297                                       &l_o_bt[10],
298                                       &l_o_bt[11],
299                                       &l_o_bt[12],
300                                       &l_o_bt[13],
301                                       &l_o_bt[14],
302                                       &l_o_bt[15]),
303               "1601/1 LB stacks on BIER table %d", bti);
304
305     /*
306      * add a route to the table. the via IP route does not exist.
307      */
308     const ip46_address_t nh_1_1_1_1 = {
309         .ip4 = {
310             .as_u32 = clib_host_to_net_u32(0x01010101),
311         },
312     };
313     fib_route_path_t *paths_1_1_1_1 = NULL, *input_paths_1_1_1_1;
314     fib_route_path_t path_1_1_1_1 = {
315         .frp_addr = nh_1_1_1_1,
316         .frp_bier_fib_index = bti,
317         .frp_sw_if_index = ~0,
318     };
319     vec_add1(path_1_1_1_1.frp_label_stack, 500);
320     vec_add1(paths_1_1_1_1, path_1_1_1_1);
321     const fib_prefix_t pfx_1_1_1_1_s_32 = {
322         .fp_addr = nh_1_1_1_1,
323         .fp_len = 32,
324         .fp_proto = FIB_PROTOCOL_IP4,
325     };
326     index_t bei_1;
327
328     input_paths_1_1_1_1 = vec_dup(paths_1_1_1_1);
329     bier_table_route_add(&bt_0_0_0_256, 1, input_paths_1_1_1_1);
330     bei_1 = bier_table_lookup(bier_table_get(bti), 1);
331
332     BIER_TEST((INDEX_INVALID != bei_1), "BP:1 present");
333
334     /*
335      * the newly created fmask should stack on the non-eos chain
336      * of the via-fib-entry
337      */
338     dpo_id_t neos_dpo_1_1_1_1 = DPO_INVALID;
339     bier_fmask_t *bfm_1_1_1_1;
340     index_t bfmi_1_1_1_1;
341
342     fei = fib_table_lookup_exact_match(0, &pfx_1_1_1_1_s_32);
343     fib_entry_contribute_forwarding(fei,
344                                     FIB_FORW_CHAIN_TYPE_MPLS_NON_EOS,
345                                     &neos_dpo_1_1_1_1);
346
347     bfmi_1_1_1_1 = bier_fmask_db_find(bti, &path_1_1_1_1);
348     bfm_1_1_1_1 = bier_fmask_get(bfmi_1_1_1_1);
349
350     BIER_TEST(!dpo_cmp(drop_dpo_get(DPO_PROTO_MPLS),
351                        &bfm_1_1_1_1->bfm_dpo),
352               "Fmask via 1.1.1.1 stacks on MPLS drop");
353
354     /*
355      * The BIER entry should stack on the forwarding chain of the fmask
356      */
357     const fib_test_lb_bucket_t dpo_o_bfm_1_1_1_1 = {
358         .type = FT_LB_BIER_FMASK,
359         .bier = {
360             .fmask = bfmi_1_1_1_1,
361         },
362     };
363     dpo_id_t dpo_bei = DPO_INVALID;
364     bier_entry_contribute_forwarding(bei_1, &dpo_bei);
365
366     BIER_TEST(!dpo_cmp(&dpo_bei, drop_dpo_get(DPO_PROTO_BIER)),
367               "BP:1 stacks on bier drop");
368
369     /*
370      * give 1.1.1.1/32 a path and hence a interesting n-eos chain
371      */
372     ip46_address_t nh_10_10_10_1 = {
373         .ip4 = {
374             .as_u32 = clib_host_to_net_u32(0x0a0a0a01),
375         },
376     };
377     adj_index_t ai_mpls_10_10_10_1;
378     ai_mpls_10_10_10_1 = adj_nbr_add_or_lock(FIB_PROTOCOL_IP4,
379                                              VNET_LINK_MPLS,
380                                              &nh_10_10_10_1,
381                                              tm->hw[0]->sw_if_index);
382
383     fib_test_lb_bucket_t bucket_neos_99_via_10_10_10_1 = {
384         .type = FT_LB_LABEL_O_ADJ,
385         .label_o_adj = {
386             .label = 99,
387             .eos = MPLS_NON_EOS,
388             .adj = ai_mpls_10_10_10_1,
389             .ttl = 255,
390         },
391     };
392     mpls_label_t *out_lbl_99 = NULL;
393     vec_add1(out_lbl_99, 99);
394
395     fei = fib_table_entry_update_one_path(0,
396                                           &pfx_1_1_1_1_s_32,
397                                           FIB_SOURCE_API,
398                                           FIB_ENTRY_FLAG_NONE,
399                                           DPO_PROTO_IP4,
400                                           &nh_10_10_10_1,
401                                           tm->hw[0]->sw_if_index,
402                                           ~0, // invalid fib index
403                                           1,
404                                           out_lbl_99,
405                                           FIB_ROUTE_PATH_FLAG_NONE);
406     fib_entry_contribute_forwarding(fei,
407                                     FIB_FORW_CHAIN_TYPE_MPLS_NON_EOS,
408                                     &neos_dpo_1_1_1_1);
409     BIER_TEST(fib_test_validate_lb(&neos_dpo_1_1_1_1, 1,
410                                    &bucket_neos_99_via_10_10_10_1),
411               "1.1.1.1/32 n-eos LB 1 buckets via: 99 + 10.10.10.1");
412     BIER_TEST(!dpo_cmp(&neos_dpo_1_1_1_1,
413                        &bfm_1_1_1_1->bfm_dpo),
414               "Fmask via 1.1.1.1 stacks on updated non-eos of 1.1.1.1/32");
415     bier_entry_contribute_forwarding(bei_1, &dpo_bei);
416     BIER_TEST((dpo_bei.dpoi_index == bfmi_1_1_1_1),
417               "BP:1  stacks on fmask 1.1.1.1");
418
419     /*
420      * add another path to the via entry.
421      * this makes the via-entry instantiate a new load-balance with
422      * 2 buckets. and the back-walk to the BIER entry will need to
423      * re-stack on it.
424      */
425     ip46_address_t nh_10_10_10_2 = {
426         .ip4 = {
427             .as_u32 = clib_host_to_net_u32(0x0a0a0a02),
428         },
429     };
430     adj_index_t ai_mpls_10_10_10_2;
431
432     ai_mpls_10_10_10_2 = adj_nbr_add_or_lock(FIB_PROTOCOL_IP4,
433                                              VNET_LINK_MPLS,
434                                              &nh_10_10_10_2,
435                                              tm->hw[0]->sw_if_index);
436
437     fib_test_lb_bucket_t bucket_neos_100_via_10_10_10_2 = {
438         .type = FT_LB_LABEL_O_ADJ,
439         .label_o_adj = {
440             .label = 100,
441             .eos = MPLS_NON_EOS,
442             .adj = ai_mpls_10_10_10_2,
443             .ttl = 255,
444         },
445     };
446     mpls_label_t *out_lbl_100 = NULL;
447     vec_add1(out_lbl_100, 100);
448
449     fei = fib_table_entry_path_add(0,
450                                    &pfx_1_1_1_1_s_32,
451                                    FIB_SOURCE_API,
452                                    FIB_ENTRY_FLAG_NONE,
453                                    DPO_PROTO_IP4,
454                                    &nh_10_10_10_2,
455                                    tm->hw[0]->sw_if_index,
456                                    ~0, // invalid fib index
457                                    1,
458                                    out_lbl_100,
459                                    FIB_ROUTE_PATH_FLAG_NONE);
460
461     fib_entry_contribute_forwarding(fei,
462                                     FIB_FORW_CHAIN_TYPE_MPLS_NON_EOS,
463                                     &neos_dpo_1_1_1_1);
464     BIER_TEST(fib_test_validate_lb(&neos_dpo_1_1_1_1, 2,
465                                    &bucket_neos_99_via_10_10_10_1,
466                                    &bucket_neos_100_via_10_10_10_2),
467               "1.1.1.1/32 n-eos LB 2 buckets "
468               "via: 99 + 10.10.10.1, "
469               "via: 100 + 10.10.10.2");
470     BIER_TEST(!dpo_cmp(&neos_dpo_1_1_1_1,
471                        &bfm_1_1_1_1->bfm_dpo),
472               "Fmask via 1.1.1.1 stacks on updated non-eos of 1.1.1.1/32");
473
474     /*
475      * add another bier bit-position via the same next-hop
476      * since its the same next hop, the two bit-positions should link
477      * to the same fmask
478      */
479     index_t bei_2;
480
481     input_paths_1_1_1_1 = vec_dup(paths_1_1_1_1);
482     bier_table_route_add(&bt_0_0_0_256, 2, input_paths_1_1_1_1);
483     bei_2 = bier_table_lookup(bier_table_get(bti), 2);
484
485     bier_entry_contribute_forwarding(bei_2, &dpo_bei);
486     BIER_TEST((dpo_bei.dpoi_index == bfmi_1_1_1_1),
487               "BP:2  stacks on fmask 1.1.1.1");
488
489     /*
490      * now add a bit-position via a different next hop and expect to
491      * link via a different fmask
492      */
493     const ip46_address_t nh_1_1_1_2 = {
494         .ip4 = {
495             .as_u32 = clib_host_to_net_u32(0x01010102),
496         },
497     };
498     const fib_prefix_t pfx_1_1_1_2_s_32 = {
499         .fp_addr = nh_1_1_1_2,
500         .fp_len = 32,
501         .fp_proto = FIB_PROTOCOL_IP4,
502     };
503     fib_route_path_t *paths_1_1_1_2 = NULL, *input_paths_1_1_1_2, path_1_1_1_2 = {
504         .frp_addr = nh_1_1_1_2,
505         .frp_bier_fib_index = bti,
506         .frp_sw_if_index = ~0,
507     };
508     vec_add1(path_1_1_1_2.frp_label_stack, 501);
509     vec_add1(paths_1_1_1_2, path_1_1_1_2);
510     input_paths_1_1_1_2 = vec_dup(paths_1_1_1_2);
511     index_t bei_3;
512
513     mpls_label_t *out_lbl_101 = NULL;
514     vec_add1(out_lbl_101, 101);
515     fei = fib_table_entry_path_add(0,
516                                    &pfx_1_1_1_2_s_32,
517                                    FIB_SOURCE_API,
518                                    FIB_ENTRY_FLAG_NONE,
519                                    DPO_PROTO_IP4,
520                                    &nh_10_10_10_2,
521                                    tm->hw[0]->sw_if_index,
522                                    ~0, // invalid fib index
523                                    1,
524                                    out_lbl_101,
525                                    FIB_ROUTE_PATH_FLAG_NONE);
526     bier_table_route_add(&bt_0_0_0_256, 3, input_paths_1_1_1_2);
527     bei_3 = bier_table_lookup(bier_table_get(bti), 3);
528
529     BIER_TEST((INDEX_INVALID != bei_3), "BP:3 present");
530
531     /*
532      * the newly created fmask should stack on the non-eos chain
533      * of the via-fib-entry
534      */
535     dpo_id_t neos_dpo_1_1_1_2 = DPO_INVALID;
536     bier_fmask_t *bfm_1_1_1_2;
537     index_t bfmi_1_1_1_2;
538
539     fei = fib_table_lookup_exact_match(0, &pfx_1_1_1_2_s_32);
540     fib_entry_contribute_forwarding(fei,
541                                     FIB_FORW_CHAIN_TYPE_MPLS_NON_EOS,
542                                     &neos_dpo_1_1_1_2);
543
544     bfmi_1_1_1_2 = bier_fmask_db_find(bti, &path_1_1_1_2);
545     bfm_1_1_1_2 = bier_fmask_get(bfmi_1_1_1_2);
546
547     BIER_TEST(!dpo_cmp(&neos_dpo_1_1_1_2,
548                        &bfm_1_1_1_2->bfm_dpo),
549               "Fmask via 1.1.1.2 stacks on non-eos of 1.1.1.2/32");
550
551     /*
552      * The BIER entry should stack on the forwarding chain of the fmask
553      */
554     const fib_test_lb_bucket_t dpo_o_bfm_1_1_1_2 = {
555         .type = FT_LB_BIER_FMASK,
556         .bier = {
557             .fmask = bfmi_1_1_1_2,
558         },
559     };
560     bier_entry_contribute_forwarding(bei_3, &dpo_bei);
561     BIER_TEST((dpo_bei.dpoi_index == bfmi_1_1_1_2),
562               "BP:2 stacks on fmask 1.1.1.2");
563
564     /*
565      * Load-balance BP:3 over both next-hops
566      */
567     paths_1_1_1_1[0] = path_1_1_1_1;
568     input_paths_1_1_1_1 = vec_dup(paths_1_1_1_1);
569     bier_table_route_add(&bt_0_0_0_256, 3, input_paths_1_1_1_1);
570
571     BIER_TEST(bier_test_validate_entry(bei_3, 2,
572                                        &dpo_o_bfm_1_1_1_1,
573                                        &dpo_o_bfm_1_1_1_2),
574               "BP:3 stacks on fmask 1.1.1.2 & 1.1.1.1");
575
576     /*
577      * test that the ECMP choices for BP:3 have been spread over the
578      * ECMP tables
579      */
580     BIER_TEST((bier_table_fwd_lookup(bier_table_get(l_o_bt[0].bier.table), 3) ==
581                bfmi_1_1_1_1),
582               "fwd lookup for BP:3 ECMP:0 is 1.1.1.1");
583     BIER_TEST((bier_table_fwd_lookup(bier_table_get(l_o_bt[1].bier.table), 3) ==
584                bfmi_1_1_1_2),
585               "fwd lookup for BP:3 ECMP:1 is 1.1.1.2");
586
587     /*
588      * Withdraw one of the via FIB and thus bring down the fmask
589      * expect the bier-entry forwarding to remove this from the set
590      */
591     fib_table_entry_delete(0, &pfx_1_1_1_2_s_32, FIB_SOURCE_API);
592
593     bier_entry_contribute_forwarding(bei_3, &dpo_bei);
594     BIER_TEST((dpo_bei.dpoi_index == bfmi_1_1_1_1),
595               "BP:3 stacks on fmask 1.1.1.1");
596
597     BIER_TEST((bier_table_fwd_lookup(bier_table_get(l_o_bt[0].bier.table), 3) ==
598                bfmi_1_1_1_1),
599               "fwd lookup for BP:3 ECMP:0 is 1.1.1.1");
600     BIER_TEST((bier_table_fwd_lookup(bier_table_get(l_o_bt[1].bier.table), 3) ==
601                bfmi_1_1_1_1),
602               "fwd lookup for BP:3 ECMP:1 is 1.1.1.1");
603
604     /*
605      * add the via back
606      */
607     out_lbl_101 = NULL;
608     vec_add1(out_lbl_101, 101);
609     fei = fib_table_entry_path_add(0,
610                                    &pfx_1_1_1_2_s_32,
611                                    FIB_SOURCE_API,
612                                    FIB_ENTRY_FLAG_NONE,
613                                    DPO_PROTO_IP4,
614                                    &nh_10_10_10_2,
615                                    tm->hw[0]->sw_if_index,
616                                    ~0, // invalid fib index
617                                    1,
618                                    out_lbl_101,
619                                    FIB_ROUTE_PATH_FLAG_NONE);
620     /* suspend so the update walk kicks int */
621     vlib_process_suspend(vlib_get_main(), 1e-5);
622
623     BIER_TEST(bier_test_validate_entry(bei_3, 2,
624                                        &dpo_o_bfm_1_1_1_1,
625                                        &dpo_o_bfm_1_1_1_2),
626               "BP:3 stacks on fmask 1.1.1.2 & 1.1.1.1");
627     BIER_TEST((bier_table_fwd_lookup(bier_table_get(l_o_bt[0].bier.table), 3) ==
628                bfmi_1_1_1_1),
629               "fwd lookup for BP:3 ECMP:0 is 1.1.1.1");
630     BIER_TEST((bier_table_fwd_lookup(bier_table_get(l_o_bt[1].bier.table), 3) ==
631                bfmi_1_1_1_2),
632               "fwd lookup for BP:3 ECMP:1 is 1.1.1.2");
633
634     /*
635      * remove the original 1.1.1.2 fmask from BP:3
636      */
637     input_paths_1_1_1_2 = vec_dup(paths_1_1_1_2);
638     bier_table_route_remove(&bt_0_0_0_256, 3, input_paths_1_1_1_2);
639     bier_entry_contribute_forwarding(bei_3, &dpo_bei);
640     BIER_TEST((dpo_bei.dpoi_index == bfmi_1_1_1_1),
641               "BP:3 stacks on fmask 1.1.1.1");
642
643     /*
644      * test that the ECMP choices for BP:3 have been updated
645      */
646     BIER_TEST((bier_table_fwd_lookup(bier_table_get(l_o_bt[0].bier.table), 3) ==
647                bfmi_1_1_1_1),
648               "fwd lookup for BP:3 ECMP:0 is 1.1.1.1");
649     BIER_TEST((bier_table_fwd_lookup(bier_table_get(l_o_bt[1].bier.table), 3) ==
650                bfmi_1_1_1_1),
651               "fwd lookup for BP:3 ECMP:1 is 1.1.1.1");
652
653     /*
654      * remove the routes added
655      */
656     input_paths_1_1_1_1 = vec_dup(paths_1_1_1_1);
657     bier_table_route_remove(&bt_0_0_0_256, 2, input_paths_1_1_1_1);
658     input_paths_1_1_1_2 = vec_dup(paths_1_1_1_2);
659     bier_table_route_remove(&bt_0_0_0_256, 3, input_paths_1_1_1_2);
660     input_paths_1_1_1_1 = vec_dup(paths_1_1_1_1);
661     bier_table_route_remove(&bt_0_0_0_256, 3, input_paths_1_1_1_1);
662     input_paths_1_1_1_1 = vec_dup(paths_1_1_1_1);
663     bier_table_route_remove(&bt_0_0_0_256, 1, input_paths_1_1_1_1);
664
665     /*
666      * delete the table
667      */
668     bier_table_unlock(&bt_0_0_0_256);
669
670     /*
671      * test resources are freed
672      */
673     dpo_reset(&dpo_bei);
674     for (ii = 0; ii < N_BIER_ECMP_TABLES; ii++)
675     {
676         bier_table_ecmp_unlock(l_o_bt[ii].bier.table);
677     };
678     BIER_TEST(0 == pool_elts(bier_table_pool), "BIER table pool empty");
679     BIER_TEST(0 == pool_elts(bier_fmask_pool), "BIER fmask pool empty");
680     BIER_TEST(0 == pool_elts(bier_entry_pool), "BIER entry pool empty");
681
682     adj_unlock(ai_mpls_10_10_10_1);
683     adj_unlock(ai_mpls_10_10_10_2);
684     dpo_reset(&neos_dpo_1_1_1_1);
685     dpo_reset(&neos_dpo_1_1_1_2);
686     fib_table_entry_delete(0, &pfx_1_1_1_1_s_32, FIB_SOURCE_API);
687     fib_table_entry_delete(0, &pfx_1_1_1_2_s_32, FIB_SOURCE_API);
688
689     /* +1 to account for the one time alloc'd drop LB in the MPLS fibs */
690     BIER_TEST(lb_count+1 == pool_elts(load_balance_pool),
691               "Load-balance resources freed ");
692     BIER_TEST((0 == adj_nbr_db_size()), "ADJ DB size is %d",
693              adj_nbr_db_size());
694
695     vec_free(paths_1_1_1_1);
696     vec_free(paths_1_1_1_2);
697     vec_free(input_paths_1_1_1_1);
698     vec_free(input_paths_1_1_1_2);
699
700     return (0);
701 }
702
703 static int
704 bier_test_mpls_imp (void)
705 {
706     fib_node_index_t bii;
707     /* test_main_t *tm; */
708
709     /* tm = &test_main; */
710
711     /*
712      * Add the BIER Main table
713      */
714     const bier_table_id_t bt_0_0_0_256 = {
715         .bti_set = 0,
716         .bti_sub_domain = 0,
717         .bti_hdr_len = BIER_HDR_LEN_256,
718         .bti_type = BIER_TABLE_MPLS_SPF,
719         .bti_ecmp = BIER_ECMP_TABLE_ID_MAIN,
720     };
721
722     bier_table_add_or_lock(&bt_0_0_0_256, 1600);
723
724     /*
725      * A bit-string for imp 1.
726      */
727     bier_bit_string_t bbs_256;
728     u8 buckets[BIER_HDR_BUCKETS_256];
729     memset(buckets, 0x5, BIER_HDR_BUCKETS_256);
730
731     bier_bit_string_init(&bbs_256, BIER_HDR_LEN_256, buckets);
732
733     bii = bier_imp_add_or_lock(&bt_0_0_0_256, 1, &bbs_256);
734
735     /*
736      * An mfib entry that resolves via the BIER imposition
737      */
738     const mfib_prefix_t pfx_1_1_1_1_c_239_1_1_1 = {
739         .fp_len = 64,
740         .fp_proto = FIB_PROTOCOL_IP4,
741         .fp_grp_addr = {
742             .ip4.as_u32 = clib_host_to_net_u32(0xef010101),
743         },
744         .fp_src_addr = {
745             .ip4.as_u32 = clib_host_to_net_u32(0x01010101),
746         },
747     };
748     fib_route_path_t path_via_bier_imp_1 = {
749         .frp_proto = DPO_PROTO_BIER,
750         .frp_bier_imp = bii,
751         .frp_weight = 0,
752         .frp_flags = FIB_ROUTE_PATH_BIER_IMP,
753     };
754     mfib_table_entry_path_update(0, // default table
755                                  &pfx_1_1_1_1_c_239_1_1_1 ,
756                                  MFIB_SOURCE_API,
757                                  &path_via_bier_imp_1,
758                                  MFIB_ITF_FLAG_FORWARD);
759     mfib_table_entry_delete(0,
760                             &pfx_1_1_1_1_c_239_1_1_1 ,
761                             MFIB_SOURCE_API);
762
763     bier_imp_unlock(bii);
764     bier_table_unlock(&bt_0_0_0_256);
765
766     BIER_TEST(0 == pool_elts(bier_imp_pool),
767               "BIER imposition resources freed ");
768     BIER_TEST(0 == pool_elts(bier_table_pool),
769               "BIER table resources freed ");
770
771     return (0);
772 }
773
774 static int
775 bier_test_mpls_disp (void)
776 {
777     /*
778      * Add the BIER Main table
779      */
780     const bier_table_id_t bt_0_0_0_256 = {
781         .bti_set = 0,
782         .bti_sub_domain = 0,
783         .bti_hdr_len = BIER_HDR_LEN_256,
784         .bti_type = BIER_TABLE_MPLS_SPF,
785         .bti_ecmp = BIER_ECMP_TABLE_ID_MAIN,
786     };
787     index_t bti;
788
789     bti = bier_table_add_or_lock(&bt_0_0_0_256, 1600);
790
791     /*
792      * Add a BIER dispoition table
793      */
794     const u32 bier_disp_tbl_id = 1;
795     index_t bdti1;
796
797     bdti1 = bier_disp_table_add_or_lock(bier_disp_tbl_id);
798
799     /*
800      * add a bit-poistion in the table that resolves via
801      * DISP table, i.e. a for-us bit-position
802      */
803     fib_route_path_t *paths_via_disp = NULL, path_via_disp = {
804         // .frp_addr = all-zeros
805         .frp_proto = DPO_PROTO_BIER,
806         .frp_bier_fib_index = bdti1,
807         .frp_sw_if_index = ~0,
808     };
809     vec_add1(paths_via_disp, path_via_disp);
810
811     bier_table_route_add(&bt_0_0_0_256, 3, paths_via_disp);
812
813     /*
814      * the fmask should stack on the BIER disp table
815      */
816     bier_fmask_t *bfm_0_0_0_0;
817     index_t bfmi_0_0_0_0;
818     dpo_id_t dpo_disp_tbl_1 = DPO_INVALID;
819
820     bier_disp_table_contribute_forwarding(bdti1, &dpo_disp_tbl_1);
821
822     bfmi_0_0_0_0 = bier_fmask_db_find(bti, &path_via_disp);
823     bfm_0_0_0_0 = bier_fmask_get(bfmi_0_0_0_0);
824
825     BIER_TEST(!dpo_cmp(&dpo_disp_tbl_1, &bfm_0_0_0_0->bfm_dpo),
826               "Fmask via 0.0.0.0 stacks on BIER disp table 1");
827
828     /*
829      * and a deag entry into the disposition table
830      */
831     fib_route_path_t *rpaths = NULL, path_via_mfib = {
832         .frp_proto = DPO_PROTO_IP4,
833         .frp_addr = zero_addr,
834         .frp_fib_index = 0, // default MFIB table
835         .frp_rpf_id = 9, // some non-zero value
836         .frp_flags = FIB_ROUTE_PATH_RPF_ID,
837     };
838     bier_hdr_src_id_t src = 99;
839     vec_add1(rpaths, path_via_mfib);
840     bier_disp_table_entry_path_add(bier_disp_tbl_id, src,
841                                    BIER_HDR_PROTO_IPV4, rpaths);
842
843     /* which should stack on a lookup in the mfib table */
844     const dpo_id_t *dpo_disp_entry_v4;
845     bier_disp_entry_t *bde_99;
846     index_t bdei;
847
848     bdei = bier_disp_table_lookup(bdti1, clib_host_to_net_u16(src));
849     bde_99 = bier_disp_entry_get(bdei);
850     dpo_disp_entry_v4 = &bde_99->bde_fwd[BIER_HDR_PROTO_IPV4].bde_dpo;
851
852     lookup_dpo_t *lkd = lookup_dpo_get(dpo_disp_entry_v4->dpoi_index);
853
854     BIER_TEST((bdti1 == lkd->lkd_fib_index),
855               "disp is deag in %d %U",
856               lkd->lkd_fib_index,
857               format_dpo_id, dpo_disp_entry_v4, 0);
858     BIER_TEST((LOOKUP_INPUT_DST_ADDR == lkd->lkd_input),
859               "disp is destination deag in %d %U",
860               lkd->lkd_input,
861               format_dpo_id, dpo_disp_entry_v4, 0);
862     BIER_TEST((LOOKUP_MULTICAST == lkd->lkd_cast),
863               "disp is multicast deag in %d %U",
864               lkd->lkd_input,
865               format_dpo_id, dpo_disp_entry_v4, 0);
866
867     /*
868      * cleanup
869      */
870     dpo_reset(&dpo_disp_tbl_1);
871
872     bier_disp_table_entry_path_remove(bier_disp_tbl_id, src,
873                                       BIER_HDR_PROTO_IPV4, rpaths);
874     bier_table_route_remove(&bt_0_0_0_256, 3, paths_via_disp);
875
876     bier_disp_table_unlock_w_table_id(bier_disp_tbl_id);
877
878     bier_table_unlock(&bt_0_0_0_256);
879
880     BIER_TEST(0 == pool_elts(bier_fmask_pool),
881               "BIER fmask resources freed ");
882     BIER_TEST(0 == pool_elts(bier_table_pool),
883               "BIER table resources freed ");
884     BIER_TEST(0 == pool_elts(bier_disp_table_pool),
885               "BIER Disposition table resources freed ");
886     BIER_TEST(0 == pool_elts(bier_disp_entry_pool),
887               "BIER Disposition entry resources freed ");
888
889     vec_free(paths_via_disp);
890     return (0);
891 }
892
893 static clib_error_t *
894 bier_test (vlib_main_t * vm,
895            unformat_input_t * input,
896            vlib_cli_command_t * cmd_arg)
897 {
898     int res = 0;
899
900     res += bier_test_mk_intf(4);
901
902     if (unformat (input, "debug"))
903     {
904         bier_test_do_debug = 1;
905     }
906
907     if (unformat (input, "mid"))
908         res += bier_test_mpls_spf();
909     else if (unformat (input, "head"))
910         res += bier_test_mpls_imp();
911     else if (unformat (input, "tail"))
912         res += bier_test_mpls_disp();
913     else
914     {
915         res += bier_test_mpls_spf();
916         res += bier_test_mpls_imp();
917         res += bier_test_mpls_disp();
918     }
919
920     if (res)
921     {
922         return clib_error_return(0, "BIER Unit Test Failed");
923     }
924     else
925     {
926         return (NULL);
927     }
928 }
929
930 VLIB_CLI_COMMAND (test_route_command, static) = {
931     .path = "test bier",
932     .short_help = "bier unit tests",
933     .function = bier_test,
934 };
935
936 clib_error_t *
937 bier_test_init (vlib_main_t *vm)
938 {
939     return 0;
940 }
941
942 VLIB_INIT_FUNCTION (bier_test_init);