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 bier_fmask_get_index (const bier_fmask_t *bfm)
43 return (bfm - bier_fmask_pool);
47 bier_fmask_bits_init (bier_fmask_bits_t *bits,
48 bier_hdr_len_id_t hlid)
50 bits->bfmb_refs = clib_mem_alloc(sizeof(bits->bfmb_refs[0]) *
51 bier_hdr_len_id_to_num_bits(hlid));
52 memset(bits->bfmb_refs,
54 (sizeof(bits->bfmb_refs[0]) *
55 bier_hdr_len_id_to_num_bits(hlid)));
57 bits->bfmb_input_reset_string.bbs_len =
58 bier_hdr_len_id_to_num_buckets(hlid);
61 * The buckets are accessed in the switch path
63 bits->bfmb_input_reset_string.bbs_buckets =
64 clib_mem_alloc_aligned(
65 sizeof(bits->bfmb_input_reset_string.bbs_buckets[0]) *
66 bier_hdr_len_id_to_num_buckets(hlid),
67 CLIB_CACHE_LINE_BYTES);
68 memset(bits->bfmb_input_reset_string.bbs_buckets,
70 sizeof(bits->bfmb_input_reset_string.bbs_buckets[0]) *
71 bier_hdr_len_id_to_num_buckets(hlid));
75 bier_fmask_stack (bier_fmask_t *bfm)
77 dpo_id_t via_dpo = DPO_INVALID;
78 fib_forward_chain_type_t fct;
80 if (bfm->bfm_flags & BIER_FMASK_FLAG_MPLS)
82 fct = FIB_FORW_CHAIN_TYPE_MPLS_NON_EOS;
86 fct = FIB_FORW_CHAIN_TYPE_BIER;
89 fib_path_list_contribute_forwarding(bfm->bfm_pl, fct,
90 FIB_PATH_LIST_FWD_FLAG_COLLAPSE,
94 * If the via PL entry provides no forwarding (i.e. a drop)
95 * then neither does this fmask. That way children consider this fmask
96 * unresolved and other ECMP options are used instead.
98 if (dpo_is_drop(&via_dpo))
100 bfm->bfm_flags &= ~BIER_FMASK_FLAG_FORWARDING;
104 bfm->bfm_flags |= BIER_FMASK_FLAG_FORWARDING;
107 dpo_stack(DPO_BIER_FMASK,
115 bier_fmask_contribute_forwarding (index_t bfmi,
120 bfm = bier_fmask_get(bfmi);
122 if (bfm->bfm_flags & BIER_FMASK_FLAG_FORWARDING)
131 dpo_copy(dpo, drop_dpo_get(DPO_PROTO_BIER));
136 bier_fmask_child_add (fib_node_index_t bfmi,
137 fib_node_type_t child_type,
138 fib_node_index_t child_index)
140 return (fib_node_child_add(FIB_NODE_TYPE_BIER_FMASK,
147 bier_fmask_child_remove (fib_node_index_t bfmi,
150 if (INDEX_INVALID == bfmi)
155 fib_node_child_remove(FIB_NODE_TYPE_BIER_FMASK,
161 bier_fmask_init (bier_fmask_t *bfm,
162 const bier_fmask_id_t *fmid,
163 const fib_route_path_t *rpaths)
165 const bier_table_id_t *btid;
168 *bfm->bfm_id = *fmid;
169 dpo_reset(&bfm->bfm_dpo);
170 btid = bier_table_get_id(bfm->bfm_id->bfmi_bti);
171 bier_fmask_bits_init(&bfm->bfm_bits, btid->bti_hdr_len);
173 if (ip46_address_is_zero(&(bfm->bfm_id->bfmi_nh)))
175 bfm->bfm_flags |= BIER_FMASK_FLAG_DISP;
178 if (!(bfm->bfm_flags & BIER_FMASK_FLAG_DISP))
180 if (NULL != rpaths->frp_label_stack)
182 olabel = rpaths->frp_label_stack[0].fml_value;
183 vnet_mpls_uc_set_label(&bfm->bfm_label, olabel);
184 vnet_mpls_uc_set_exp(&bfm->bfm_label, 0);
185 vnet_mpls_uc_set_s(&bfm->bfm_label, 1);
186 vnet_mpls_uc_set_ttl(&bfm->bfm_label, 64);
187 bfm->bfm_flags |= BIER_FMASK_FLAG_MPLS;
196 bfm->bfm_flags &= ~BIER_FMASK_FLAG_MPLS;
199 * use a label as encoded for BIFT value
201 id = bier_bift_id_encode(btid->bti_set,
202 btid->bti_sub_domain,
204 vnet_mpls_uc_set_label(&bfm->bfm_label, id);
205 vnet_mpls_uc_set_s(&bfm->bfm_label, 1);
206 vnet_mpls_uc_set_exp(&bfm->bfm_label, 0);
207 vnet_mpls_uc_set_ttl(&bfm->bfm_label, 64);
209 bfm->bfm_label = clib_host_to_net_u32(bfm->bfm_label);
212 bfm->bfm_pl = fib_path_list_create((FIB_PATH_LIST_FLAG_SHARED |
213 FIB_PATH_LIST_FLAG_NO_URPF),
215 bfm->bfm_sibling = fib_path_list_child_add(bfm->bfm_pl,
216 FIB_NODE_TYPE_BIER_FMASK,
217 bier_fmask_get_index(bfm));
219 bier_fmask_stack(bfm);
223 bier_fmask_destroy (bier_fmask_t *bfm)
225 clib_mem_free(bfm->bfm_bits.bfmb_refs);
226 clib_mem_free(bfm->bfm_bits.bfmb_input_reset_string.bbs_buckets);
228 bier_fmask_db_remove(bfm->bfm_id);
229 fib_path_list_child_remove(bfm->bfm_pl,
231 dpo_reset(&bfm->bfm_dpo);
232 clib_mem_free(bfm->bfm_id);
233 pool_put(bier_fmask_pool, bfm);
237 bier_fmask_unlock (index_t bfmi)
241 if (INDEX_INVALID == bfmi)
246 bfm = bier_fmask_get(bfmi);
248 fib_node_unlock(&bfm->bfm_node);
252 bier_fmask_lock (index_t bfmi)
256 if (INDEX_INVALID == bfmi)
261 bfm = bier_fmask_get(bfmi);
263 fib_node_lock(&bfm->bfm_node);
267 bier_fmask_create_and_lock (const bier_fmask_id_t *fmid,
268 const fib_route_path_t *rpaths)
272 pool_get_aligned(bier_fmask_pool, bfm, CLIB_CACHE_LINE_BYTES);
274 memset(bfm, 0, sizeof(*bfm));
276 bfm->bfm_id = clib_mem_alloc(sizeof(*bfm->bfm_id));
278 ASSERT(1 == vec_len(rpaths));
279 fib_node_init(&bfm->bfm_node, FIB_NODE_TYPE_BIER_FMASK);
280 bier_fmask_init(bfm, fmid, rpaths);
282 bier_fmask_lock(bier_fmask_get_index(bfm));
284 return (bier_fmask_get_index(bfm));
288 bier_fmask_link (index_t bfmi,
293 bfm = bier_fmask_get(bfmi);
295 if (0 == bfm->bfm_bits.bfmb_refs[BIER_BP_TO_INDEX(bp)])
298 * 0 -> 1 transistion - set the bit in the string
300 bier_bit_string_set_bit(&bfm->bfm_bits.bfmb_input_reset_string, bp);
303 ++bfm->bfm_bits.bfmb_refs[BIER_BP_TO_INDEX(bp)];
304 ++bfm->bfm_bits.bfmb_count;
308 bier_fmask_unlink (index_t bfmi,
313 bfm = bier_fmask_get(bfmi);
315 --bfm->bfm_bits.bfmb_refs[BIER_BP_TO_INDEX(bp)];
316 --bfm->bfm_bits.bfmb_count;
318 if (0 == bfm->bfm_bits.bfmb_refs[BIER_BP_TO_INDEX(bp)])
321 * 1 -> 0 transistion - clear the bit in the string
323 bier_bit_string_clear_bit(&bfm->bfm_bits.bfmb_input_reset_string, bp);
328 format_bier_fmask (u8 *s, va_list *ap)
330 index_t bfmi = va_arg(*ap, index_t);
331 u32 indent = va_arg(*ap, u32);
332 bier_fmask_attributes_t attr;
335 if (pool_is_free_index(bier_fmask_pool, bfmi))
337 return (format(s, "No BIER f-mask %d", bfmi));
340 bfm = bier_fmask_get(bfmi);
342 s = format(s, "fmask: nh:%U bs:%U locks:%d ",
343 format_ip46_address, &bfm->bfm_id->bfmi_nh, IP46_TYPE_ANY,
344 format_bier_bit_string, &bfm->bfm_bits.bfmb_input_reset_string,
345 bfm->bfm_node.fn_locks);
346 s = format(s, "flags:");
347 FOR_EACH_BIER_FMASK_ATTR(attr) {
348 if ((1<<attr) & bfm->bfm_flags) {
349 s = format (s, "%s,", bier_fmask_attr_names[attr]);
353 s = fib_path_list_format(bfm->bfm_pl, s);
355 if (bfm->bfm_flags & BIER_FMASK_FLAG_MPLS)
357 s = format(s, " output-label:%U",
358 format_mpls_unicast_label,
359 vnet_mpls_uc_get_label(clib_net_to_host_u32(bfm->bfm_label)));
363 s = format(s, " output-bfit:[%U]",
365 vnet_mpls_uc_get_label(clib_net_to_host_u32(bfm->bfm_label)));
367 s = format(s, "\n %U%U",
368 format_white_space, indent,
369 format_dpo_id, &bfm->bfm_dpo, indent+2);
376 bier_fmask_get_node (fib_node_index_t index)
378 bier_fmask_t *bfm = bier_fmask_get(index);
379 return (&(bfm->bfm_node));
383 bier_fmask_get_from_node (fib_node_t *node)
385 return ((bier_fmask_t*)(((char*)node) -
386 STRUCT_OFFSET_OF(bier_fmask_t,
391 * bier_fmask_last_lock_gone
394 bier_fmask_last_lock_gone (fib_node_t *node)
396 bier_fmask_destroy(bier_fmask_get_from_node(node));
400 * bier_fmask_back_walk_notify
402 * A back walk has reached this BIER fmask
404 static fib_node_back_walk_rc_t
405 bier_fmask_back_walk_notify (fib_node_t *node,
406 fib_node_back_walk_ctx_t *ctx)
409 * re-stack the fmask on the n-eos of the via
411 bier_fmask_t *bfm = bier_fmask_get_from_node(node);
413 bier_fmask_stack(bfm);
416 * propagate further up the graph.
417 * we can do this synchronously since the fan out is small.
419 fib_walk_sync(FIB_NODE_TYPE_BIER_FMASK, bier_fmask_get_index(bfm), ctx);
421 return (FIB_NODE_BACK_WALK_CONTINUE);
425 * The BIER fmask's graph node virtual function table
427 static const fib_node_vft_t bier_fmask_vft = {
428 .fnv_get = bier_fmask_get_node,
429 .fnv_last_lock = bier_fmask_last_lock_gone,
430 .fnv_back_walk = bier_fmask_back_walk_notify,
434 bier_fmask_dpo_lock (dpo_id_t *dpo)
439 bier_fmask_dpo_unlock (dpo_id_t *dpo)
444 bier_fmask_dpo_mem_show (void)
446 fib_show_memory_usage("BIER-fmask",
447 pool_elts(bier_fmask_pool),
448 pool_len(bier_fmask_pool),
449 sizeof(bier_fmask_t));
452 const static dpo_vft_t bier_fmask_dpo_vft = {
453 .dv_lock = bier_fmask_dpo_lock,
454 .dv_unlock = bier_fmask_dpo_unlock,
455 .dv_mem_show = bier_fmask_dpo_mem_show,
456 .dv_format = format_bier_fmask,
459 const static char *const bier_fmask_mpls_nodes[] =
464 const static char * const * const bier_fmask_nodes[DPO_PROTO_NUM] =
466 [DPO_PROTO_BIER] = bier_fmask_mpls_nodes,
467 [DPO_PROTO_MPLS] = bier_fmask_mpls_nodes,
471 bier_fmask_module_init (vlib_main_t * vm)
473 fib_node_register_type (FIB_NODE_TYPE_BIER_FMASK, &bier_fmask_vft);
474 dpo_register(DPO_BIER_FMASK, &bier_fmask_dpo_vft, bier_fmask_nodes);
479 VLIB_INIT_FUNCTION (bier_fmask_module_init);
481 static clib_error_t *
482 bier_fmask_show (vlib_main_t * vm,
483 unformat_input_t * input,
484 vlib_cli_command_t * cmd)
489 bfmi = INDEX_INVALID;
491 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT) {
492 if (unformat (input, "%d", &bfmi))
501 if (INDEX_INVALID == bfmi)
503 pool_foreach(bfm, bier_fmask_pool,
505 vlib_cli_output (vm, "[@%d] %U",
506 bier_fmask_get_index(bfm),
507 format_bier_fmask, bier_fmask_get_index(bfm), 0);
512 vlib_cli_output (vm, "%U", format_bier_fmask, bfmi, 0);
518 VLIB_CLI_COMMAND (show_bier_fmask, static) = {
519 .path = "show bier fmask",
520 .short_help = "show bier fmask",
521 .function = bier_fmask_show,