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:
7 * http://www.apache.org/licenses/LICENSE-2.0
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.
16 #include <vnet/fib/fib_entry.h>
17 #include <vnet/fib/fib_table.h>
18 #include <vnet/fib/fib_walk.h>
19 #include <vnet/fib/fib_path_list.h>
21 #include <vnet/bier/bier_table.h>
22 #include <vnet/bier/bier_fmask.h>
23 #include <vnet/bier/bier_bit_string.h>
24 #include <vnet/bier/bier_disp_table.h>
26 #include <vnet/mpls/mpls.h>
27 #include <vnet/dpo/drop_dpo.h>
28 #include <vnet/dpo/load_balance.h>
31 * attributes names for formatting
33 static const char *const bier_fmask_attr_names[] = BIER_FMASK_ATTR_NAMES;
36 * pool of BIER fmask objects
38 bier_fmask_t *bier_fmask_pool;
41 * Stats for each BIER fmask object
43 vlib_combined_counter_main_t bier_fmask_counters;
46 bier_fmask_get_index (const bier_fmask_t *bfm)
48 return (bfm - bier_fmask_pool);
52 bier_fmask_bits_init (bier_fmask_bits_t *bits,
53 bier_hdr_len_id_t hlid)
55 bits->bfmb_refs = clib_mem_alloc(sizeof(bits->bfmb_refs[0]) *
56 bier_hdr_len_id_to_num_bits(hlid));
57 memset(bits->bfmb_refs,
59 (sizeof(bits->bfmb_refs[0]) *
60 bier_hdr_len_id_to_num_bits(hlid)));
62 bits->bfmb_input_reset_string.bbs_len =
63 bier_hdr_len_id_to_num_buckets(hlid);
66 * The buckets are accessed in the switch path
68 bits->bfmb_input_reset_string.bbs_buckets =
69 clib_mem_alloc_aligned(
70 sizeof(bits->bfmb_input_reset_string.bbs_buckets[0]) *
71 bier_hdr_len_id_to_num_buckets(hlid),
72 CLIB_CACHE_LINE_BYTES);
73 memset(bits->bfmb_input_reset_string.bbs_buckets,
75 sizeof(bits->bfmb_input_reset_string.bbs_buckets[0]) *
76 bier_hdr_len_id_to_num_buckets(hlid));
80 bier_fmask_stack (bier_fmask_t *bfm)
82 dpo_id_t via_dpo = DPO_INVALID;
83 fib_forward_chain_type_t fct;
85 if (bfm->bfm_flags & BIER_FMASK_FLAG_MPLS)
87 fct = FIB_FORW_CHAIN_TYPE_MPLS_NON_EOS;
91 fct = FIB_FORW_CHAIN_TYPE_BIER;
94 fib_path_list_contribute_forwarding(bfm->bfm_pl, fct,
95 FIB_PATH_LIST_FWD_FLAG_COLLAPSE,
99 * If the via PL entry provides no forwarding (i.e. a drop)
100 * then neither does this fmask. That way children consider this fmask
101 * unresolved and other ECMP options are used instead.
103 if (dpo_is_drop(&via_dpo))
105 bfm->bfm_flags &= ~BIER_FMASK_FLAG_FORWARDING;
109 bfm->bfm_flags |= BIER_FMASK_FLAG_FORWARDING;
112 dpo_stack(DPO_BIER_FMASK,
120 bier_fmask_contribute_forwarding (index_t bfmi,
125 bfm = bier_fmask_get(bfmi);
127 if (bfm->bfm_flags & BIER_FMASK_FLAG_FORWARDING)
136 dpo_copy(dpo, drop_dpo_get(DPO_PROTO_BIER));
141 bier_fmask_child_add (fib_node_index_t bfmi,
142 fib_node_type_t child_type,
143 fib_node_index_t child_index)
145 return (fib_node_child_add(FIB_NODE_TYPE_BIER_FMASK,
152 bier_fmask_child_remove (fib_node_index_t bfmi,
155 if (INDEX_INVALID == bfmi)
160 fib_node_child_remove(FIB_NODE_TYPE_BIER_FMASK,
166 bier_fmask_init (bier_fmask_t *bfm,
167 const bier_fmask_id_t *fmid,
168 const fib_route_path_t *rpaths)
170 const bier_table_id_t *btid;
173 ASSERT(1 == vec_len(rpaths));
174 memset(bfm, 0, sizeof(*bfm));
176 bfm->bfm_id = clib_mem_alloc(sizeof(*bfm->bfm_id));
178 fib_node_init(&bfm->bfm_node, FIB_NODE_TYPE_BIER_FMASK);
179 *bfm->bfm_id = *fmid;
180 dpo_reset(&bfm->bfm_dpo);
181 btid = bier_table_get_id(bfm->bfm_id->bfmi_bti);
182 bier_fmask_bits_init(&bfm->bfm_bits, btid->bti_hdr_len);
184 if (ip46_address_is_zero(&(bfm->bfm_id->bfmi_nh)))
186 bfm->bfm_flags |= BIER_FMASK_FLAG_DISP;
189 if (!(bfm->bfm_flags & BIER_FMASK_FLAG_DISP))
191 if (NULL != rpaths->frp_label_stack)
193 olabel = rpaths->frp_label_stack[0].fml_value;
194 vnet_mpls_uc_set_label(&bfm->bfm_label, olabel);
195 vnet_mpls_uc_set_exp(&bfm->bfm_label, 0);
196 vnet_mpls_uc_set_s(&bfm->bfm_label, 1);
197 vnet_mpls_uc_set_ttl(&bfm->bfm_label, 64);
198 bfm->bfm_flags |= BIER_FMASK_FLAG_MPLS;
207 bfm->bfm_flags &= ~BIER_FMASK_FLAG_MPLS;
210 * use a label as encoded for BIFT value
212 id = bier_bift_id_encode(btid->bti_set,
213 btid->bti_sub_domain,
215 vnet_mpls_uc_set_label(&bfm->bfm_label, id);
216 vnet_mpls_uc_set_s(&bfm->bfm_label, 1);
217 vnet_mpls_uc_set_exp(&bfm->bfm_label, 0);
218 vnet_mpls_uc_set_ttl(&bfm->bfm_label, 64);
220 bfm->bfm_label = clib_host_to_net_u32(bfm->bfm_label);
223 bfm->bfm_pl = fib_path_list_create((FIB_PATH_LIST_FLAG_SHARED |
224 FIB_PATH_LIST_FLAG_NO_URPF),
226 bfm->bfm_sibling = fib_path_list_child_add(bfm->bfm_pl,
227 FIB_NODE_TYPE_BIER_FMASK,
228 bier_fmask_get_index(bfm));
230 bier_fmask_stack(bfm);
234 bier_fmask_destroy (bier_fmask_t *bfm)
236 clib_mem_free(bfm->bfm_bits.bfmb_refs);
237 clib_mem_free(bfm->bfm_bits.bfmb_input_reset_string.bbs_buckets);
239 bier_fmask_db_remove(bfm->bfm_id);
240 fib_path_list_child_remove(bfm->bfm_pl,
242 dpo_reset(&bfm->bfm_dpo);
243 clib_mem_free(bfm->bfm_id);
244 pool_put(bier_fmask_pool, bfm);
248 bier_fmask_unlock (index_t bfmi)
252 if (INDEX_INVALID == bfmi)
257 bfm = bier_fmask_get(bfmi);
259 fib_node_unlock(&bfm->bfm_node);
263 bier_fmask_lock (index_t bfmi)
267 if (INDEX_INVALID == bfmi)
272 bfm = bier_fmask_get(bfmi);
274 fib_node_lock(&bfm->bfm_node);
278 bier_fmask_create_and_lock (const bier_fmask_id_t *fmid,
279 const fib_route_path_t *rpaths)
284 pool_get_aligned(bier_fmask_pool, bfm, CLIB_CACHE_LINE_BYTES);
285 bfmi = bier_fmask_get_index(bfm);
287 vlib_validate_combined_counter (&(bier_fmask_counters), bfmi);
288 vlib_zero_combined_counter (&(bier_fmask_counters), bfmi);
290 bier_fmask_init(bfm, fmid, rpaths);
292 bier_fmask_lock(bfmi);
298 bier_fmask_link (index_t bfmi,
303 bfm = bier_fmask_get(bfmi);
305 if (0 == bfm->bfm_bits.bfmb_refs[BIER_BP_TO_INDEX(bp)])
308 * 0 -> 1 transistion - set the bit in the string
310 bier_bit_string_set_bit(&bfm->bfm_bits.bfmb_input_reset_string, bp);
313 ++bfm->bfm_bits.bfmb_refs[BIER_BP_TO_INDEX(bp)];
314 ++bfm->bfm_bits.bfmb_count;
318 bier_fmask_unlink (index_t bfmi,
323 bfm = bier_fmask_get(bfmi);
325 --bfm->bfm_bits.bfmb_refs[BIER_BP_TO_INDEX(bp)];
326 --bfm->bfm_bits.bfmb_count;
328 if (0 == bfm->bfm_bits.bfmb_refs[BIER_BP_TO_INDEX(bp)])
331 * 1 -> 0 transistion - clear the bit in the string
333 bier_bit_string_clear_bit(&bfm->bfm_bits.bfmb_input_reset_string, bp);
338 format_bier_fmask (u8 *s, va_list *ap)
340 index_t bfmi = va_arg(*ap, index_t);
341 u32 indent = va_arg(*ap, u32);
342 bier_fmask_attributes_t attr;
346 if (pool_is_free_index(bier_fmask_pool, bfmi))
348 return (format(s, "No BIER f-mask %d", bfmi));
351 bfm = bier_fmask_get(bfmi);
353 s = format(s, "fmask: nh:%U bs:%U locks:%d ",
354 format_ip46_address, &bfm->bfm_id->bfmi_nh, IP46_TYPE_ANY,
355 format_bier_bit_string, &bfm->bfm_bits.bfmb_input_reset_string,
356 bfm->bfm_node.fn_locks);
357 s = format(s, "flags:");
358 FOR_EACH_BIER_FMASK_ATTR(attr) {
359 if ((1<<attr) & bfm->bfm_flags) {
360 s = format (s, "%s,", bier_fmask_attr_names[attr]);
363 vlib_get_combined_counter (&(bier_fmask_counters), bfmi, &to);
364 s = format (s, " to:[%Ld:%Ld]]", to.packets, to.bytes);
366 s = fib_path_list_format(bfm->bfm_pl, s);
368 if (bfm->bfm_flags & BIER_FMASK_FLAG_MPLS)
370 s = format(s, " output-label:%U",
371 format_mpls_unicast_label,
372 vnet_mpls_uc_get_label(clib_net_to_host_u32(bfm->bfm_label)));
376 s = format(s, " output-bfit:[%U]",
378 vnet_mpls_uc_get_label(clib_net_to_host_u32(bfm->bfm_label)));
380 s = format(s, "\n %U%U",
381 format_white_space, indent,
382 format_dpo_id, &bfm->bfm_dpo, indent+2);
388 bier_fmask_get_stats (index_t bfmi, u64 * packets, u64 * bytes)
392 vlib_get_combined_counter (&(bier_fmask_counters), bfmi, &to);
394 *packets = to.packets;
399 bier_fmask_encode (index_t bfmi,
400 bier_table_id_t *btid,
401 fib_route_path_encode_t *rpath)
405 bfm = bier_fmask_get(bfmi);
406 *btid = *bier_table_get_id(bfm->bfm_id->bfmi_bti);
408 memset(rpath, 0, sizeof(*rpath));
410 rpath->rpath.frp_sw_if_index = ~0;
412 switch (bfm->bfm_id->bfmi_nh_type)
415 rpath->rpath.frp_flags = FIB_ROUTE_PATH_UDP_ENCAP;
416 rpath->rpath.frp_udp_encap_id = bfm->bfm_id->bfmi_id;
419 memcpy(&rpath->rpath.frp_addr, &bfm->bfm_id->bfmi_nh,
420 sizeof(rpath->rpath.frp_addr));
426 bier_fmask_get_node (fib_node_index_t index)
428 bier_fmask_t *bfm = bier_fmask_get(index);
429 return (&(bfm->bfm_node));
433 bier_fmask_get_from_node (fib_node_t *node)
435 return ((bier_fmask_t*)(((char*)node) -
436 STRUCT_OFFSET_OF(bier_fmask_t,
441 * bier_fmask_last_lock_gone
444 bier_fmask_last_lock_gone (fib_node_t *node)
446 bier_fmask_destroy(bier_fmask_get_from_node(node));
450 * bier_fmask_back_walk_notify
452 * A back walk has reached this BIER fmask
454 static fib_node_back_walk_rc_t
455 bier_fmask_back_walk_notify (fib_node_t *node,
456 fib_node_back_walk_ctx_t *ctx)
459 * re-stack the fmask on the n-eos of the via
461 bier_fmask_t *bfm = bier_fmask_get_from_node(node);
463 bier_fmask_stack(bfm);
466 * propagate further up the graph.
467 * we can do this synchronously since the fan out is small.
469 fib_walk_sync(FIB_NODE_TYPE_BIER_FMASK, bier_fmask_get_index(bfm), ctx);
471 return (FIB_NODE_BACK_WALK_CONTINUE);
475 * The BIER fmask's graph node virtual function table
477 static const fib_node_vft_t bier_fmask_vft = {
478 .fnv_get = bier_fmask_get_node,
479 .fnv_last_lock = bier_fmask_last_lock_gone,
480 .fnv_back_walk = bier_fmask_back_walk_notify,
484 bier_fmask_dpo_lock (dpo_id_t *dpo)
489 bier_fmask_dpo_unlock (dpo_id_t *dpo)
494 bier_fmask_dpo_mem_show (void)
496 fib_show_memory_usage("BIER-fmask",
497 pool_elts(bier_fmask_pool),
498 pool_len(bier_fmask_pool),
499 sizeof(bier_fmask_t));
502 const static dpo_vft_t bier_fmask_dpo_vft = {
503 .dv_lock = bier_fmask_dpo_lock,
504 .dv_unlock = bier_fmask_dpo_unlock,
505 .dv_mem_show = bier_fmask_dpo_mem_show,
506 .dv_format = format_bier_fmask,
509 const static char *const bier_fmask_mpls_nodes[] =
514 const static char * const * const bier_fmask_nodes[DPO_PROTO_NUM] =
516 [DPO_PROTO_BIER] = bier_fmask_mpls_nodes,
517 [DPO_PROTO_MPLS] = bier_fmask_mpls_nodes,
521 bier_fmask_module_init (vlib_main_t * vm)
523 fib_node_register_type (FIB_NODE_TYPE_BIER_FMASK, &bier_fmask_vft);
524 dpo_register(DPO_BIER_FMASK, &bier_fmask_dpo_vft, bier_fmask_nodes);
529 VLIB_INIT_FUNCTION (bier_fmask_module_init);
531 static clib_error_t *
532 bier_fmask_show (vlib_main_t * vm,
533 unformat_input_t * input,
534 vlib_cli_command_t * cmd)
539 bfmi = INDEX_INVALID;
541 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT) {
542 if (unformat (input, "%d", &bfmi))
551 if (INDEX_INVALID == bfmi)
553 pool_foreach(bfm, bier_fmask_pool,
555 vlib_cli_output (vm, "[@%d] %U",
556 bier_fmask_get_index(bfm),
557 format_bier_fmask, bier_fmask_get_index(bfm), 0);
562 vlib_cli_output (vm, "%U", format_bier_fmask, bfmi, 0);
568 VLIB_CLI_COMMAND (show_bier_fmask, static) = {
569 .path = "show bier fmask",
570 .short_help = "show bier fmask",
571 .function = bier_fmask_show,