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))
181 * leave this label in host byte order so we can OR in the TTL
183 if (NULL != rpaths->frp_label_stack)
185 olabel = rpaths->frp_label_stack[0];
186 vnet_mpls_uc_set_label(&bfm->bfm_label, olabel);
187 vnet_mpls_uc_set_exp(&bfm->bfm_label, 0);
188 vnet_mpls_uc_set_s(&bfm->bfm_label, 1);
189 vnet_mpls_uc_set_ttl(&bfm->bfm_label, 0);
190 bfm->bfm_flags |= BIER_FMASK_FLAG_MPLS;
199 bfm->bfm_flags &= ~BIER_FMASK_FLAG_MPLS;
202 * use a label as encoded for BIFT value
204 id = bier_bift_id_encode(btid->bti_set,
205 btid->bti_sub_domain,
207 vnet_mpls_uc_set_label(&bfm->bfm_label, id);
208 vnet_mpls_uc_set_s(&bfm->bfm_label, 1);
209 vnet_mpls_uc_set_exp(&bfm->bfm_label, 0);
213 bfm->bfm_pl = fib_path_list_create((FIB_PATH_LIST_FLAG_SHARED |
214 FIB_PATH_LIST_FLAG_NO_URPF),
216 bfm->bfm_sibling = fib_path_list_child_add(bfm->bfm_pl,
217 FIB_NODE_TYPE_BIER_FMASK,
218 bier_fmask_get_index(bfm));
220 bier_fmask_stack(bfm);
224 bier_fmask_destroy (bier_fmask_t *bfm)
226 clib_mem_free(bfm->bfm_bits.bfmb_refs);
227 clib_mem_free(bfm->bfm_bits.bfmb_input_reset_string.bbs_buckets);
229 bier_fmask_db_remove(bfm->bfm_id);
230 fib_path_list_child_remove(bfm->bfm_pl,
232 dpo_reset(&bfm->bfm_dpo);
233 clib_mem_free(bfm->bfm_id);
234 pool_put(bier_fmask_pool, bfm);
238 bier_fmask_unlock (index_t bfmi)
242 if (INDEX_INVALID == bfmi)
247 bfm = bier_fmask_get(bfmi);
249 fib_node_unlock(&bfm->bfm_node);
253 bier_fmask_lock (index_t bfmi)
257 if (INDEX_INVALID == bfmi)
262 bfm = bier_fmask_get(bfmi);
264 fib_node_lock(&bfm->bfm_node);
268 bier_fmask_create_and_lock (const bier_fmask_id_t *fmid,
269 const fib_route_path_t *rpaths)
273 pool_get_aligned(bier_fmask_pool, bfm, CLIB_CACHE_LINE_BYTES);
275 memset(bfm, 0, sizeof(*bfm));
277 bfm->bfm_id = clib_mem_alloc(sizeof(*bfm->bfm_id));
279 ASSERT(1 == vec_len(rpaths));
280 fib_node_init(&bfm->bfm_node, FIB_NODE_TYPE_BIER_FMASK);
281 bier_fmask_init(bfm, fmid, rpaths);
283 bier_fmask_lock(bier_fmask_get_index(bfm));
285 return (bier_fmask_get_index(bfm));
289 bier_fmask_link (index_t bfmi,
294 bfm = bier_fmask_get(bfmi);
296 if (0 == bfm->bfm_bits.bfmb_refs[BIER_BP_TO_INDEX(bp)])
299 * 0 -> 1 transistion - set the bit in the string
301 bier_bit_string_set_bit(&bfm->bfm_bits.bfmb_input_reset_string, bp);
304 ++bfm->bfm_bits.bfmb_refs[BIER_BP_TO_INDEX(bp)];
305 ++bfm->bfm_bits.bfmb_count;
309 bier_fmask_unlink (index_t bfmi,
314 bfm = bier_fmask_get(bfmi);
316 --bfm->bfm_bits.bfmb_refs[BIER_BP_TO_INDEX(bp)];
317 --bfm->bfm_bits.bfmb_count;
319 if (0 == bfm->bfm_bits.bfmb_refs[BIER_BP_TO_INDEX(bp)])
322 * 1 -> 0 transistion - clear the bit in the string
324 bier_bit_string_clear_bit(&bfm->bfm_bits.bfmb_input_reset_string, bp);
329 format_bier_fmask (u8 *s, va_list *ap)
331 index_t bfmi = va_arg(*ap, index_t);
332 u32 indent = va_arg(*ap, u32);
333 bier_fmask_attributes_t attr;
336 if (pool_is_free_index(bier_fmask_pool, bfmi))
338 return (format(s, "No BIER f-mask %d", bfmi));
341 bfm = bier_fmask_get(bfmi);
343 s = format(s, "fmask: nh:%U bs:%U locks:%d ",
344 format_ip46_address, &bfm->bfm_id->bfmi_nh, IP46_TYPE_ANY,
345 format_bier_bit_string, &bfm->bfm_bits.bfmb_input_reset_string,
346 bfm->bfm_node.fn_locks);
347 s = format(s, "flags:");
348 FOR_EACH_BIER_FMASK_ATTR(attr) {
349 if ((1<<attr) & bfm->bfm_flags) {
350 s = format (s, "%s,", bier_fmask_attr_names[attr]);
354 s = fib_path_list_format(bfm->bfm_pl, s);
356 if (bfm->bfm_flags & BIER_FMASK_FLAG_MPLS)
358 s = format(s, " output-label:%U",
359 format_mpls_unicast_label,
360 vnet_mpls_uc_get_label(bfm->bfm_label));
364 s = format(s, " output-bfit:[%U]",
366 vnet_mpls_uc_get_label(bfm->bfm_label));
368 s = format(s, "\n %U%U",
369 format_white_space, indent,
370 format_dpo_id, &bfm->bfm_dpo, indent+2);
377 bier_fmask_get_node (fib_node_index_t index)
379 bier_fmask_t *bfm = bier_fmask_get(index);
380 return (&(bfm->bfm_node));
384 bier_fmask_get_from_node (fib_node_t *node)
386 return ((bier_fmask_t*)(((char*)node) -
387 STRUCT_OFFSET_OF(bier_fmask_t,
392 * bier_fmask_last_lock_gone
395 bier_fmask_last_lock_gone (fib_node_t *node)
397 bier_fmask_destroy(bier_fmask_get_from_node(node));
401 * bier_fmask_back_walk_notify
403 * A back walk has reached this BIER fmask
405 static fib_node_back_walk_rc_t
406 bier_fmask_back_walk_notify (fib_node_t *node,
407 fib_node_back_walk_ctx_t *ctx)
410 * re-stack the fmask on the n-eos of the via
412 bier_fmask_t *bfm = bier_fmask_get_from_node(node);
414 bier_fmask_stack(bfm);
417 * propagate further up the graph.
418 * we can do this synchronously since the fan out is small.
420 fib_walk_sync(FIB_NODE_TYPE_BIER_FMASK, bier_fmask_get_index(bfm), ctx);
422 return (FIB_NODE_BACK_WALK_CONTINUE);
426 * The BIER fmask's graph node virtual function table
428 static const fib_node_vft_t bier_fmask_vft = {
429 .fnv_get = bier_fmask_get_node,
430 .fnv_last_lock = bier_fmask_last_lock_gone,
431 .fnv_back_walk = bier_fmask_back_walk_notify,
435 bier_fmask_dpo_lock (dpo_id_t *dpo)
440 bier_fmask_dpo_unlock (dpo_id_t *dpo)
445 bier_fmask_dpo_mem_show (void)
447 fib_show_memory_usage("BIER-fmask",
448 pool_elts(bier_fmask_pool),
449 pool_len(bier_fmask_pool),
450 sizeof(bier_fmask_t));
453 const static dpo_vft_t bier_fmask_dpo_vft = {
454 .dv_lock = bier_fmask_dpo_lock,
455 .dv_unlock = bier_fmask_dpo_unlock,
456 .dv_mem_show = bier_fmask_dpo_mem_show,
457 .dv_format = format_bier_fmask,
460 const static char *const bier_fmask_mpls_nodes[] =
465 const static char * const * const bier_fmask_nodes[DPO_PROTO_NUM] =
467 [DPO_PROTO_BIER] = bier_fmask_mpls_nodes,
468 [DPO_PROTO_MPLS] = bier_fmask_mpls_nodes,
472 bier_fmask_module_init (vlib_main_t * vm)
474 fib_node_register_type (FIB_NODE_TYPE_BIER_FMASK, &bier_fmask_vft);
475 dpo_register(DPO_BIER_FMASK, &bier_fmask_dpo_vft, bier_fmask_nodes);
480 VLIB_INIT_FUNCTION (bier_fmask_module_init);
482 static clib_error_t *
483 bier_fmask_show (vlib_main_t * vm,
484 unformat_input_t * input,
485 vlib_cli_command_t * cmd)
490 bfmi = INDEX_INVALID;
492 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT) {
493 if (unformat (input, "%d", &bfmi))
502 if (INDEX_INVALID == bfmi)
504 pool_foreach(bfm, bier_fmask_pool,
506 vlib_cli_output (vm, "[@%d] %U",
507 bier_fmask_get_index(bfm),
508 format_bier_fmask, bier_fmask_get_index(bfm), 0);
513 vlib_cli_output (vm, "%U", format_bier_fmask, bfmi, 0);
519 VLIB_CLI_COMMAND (show_bier_fmask, static) = {
520 .path = "show bier fmask",
521 .short_help = "show bier fmask",
522 .function = bier_fmask_show,