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/bier/bier_entry.h>
17 #include <vnet/bier/bier_update.h>
19 #include <vnet/fib/fib_path_list.h>
21 #include <vnet/bier/bier_fmask_db.h>
22 #include <vnet/bier/bier_fmask.h>
23 #include <vnet/bier/bier_table.h>
25 bier_entry_t *bier_entry_pool;
28 bier_entry_get_index (const bier_entry_t *be)
30 return (be - bier_entry_pool);
33 static fib_path_list_walk_rc_t
34 bier_entry_link_walk (fib_node_index_t pl_index,
35 fib_node_index_t path_index,
38 bier_entry_t *be = arg;
41 bfmi = fib_path_get_resolving_index(path_index);
42 bier_fmask_link(bfmi, be->be_bp);
44 return (FIB_PATH_LIST_WALK_CONTINUE);
47 static fib_path_list_walk_rc_t
48 bier_entry_unlink_walk (fib_node_index_t pl_index,
49 fib_node_index_t path_index,
52 bier_entry_t *be = arg;
55 bfmi = fib_path_get_resolving_index(path_index);
56 bier_fmask_unlink(bfmi, be->be_bp);
58 return (FIB_PATH_LIST_WALK_CONTINUE);
62 bier_entry_create (index_t bti,
67 pool_get(bier_entry_pool, be);
71 be->be_path_list = FIB_NODE_INDEX_INVALID;
73 return (bier_entry_get_index(be));
77 bier_entry_delete (index_t bei)
81 be = bier_entry_get(bei);
84 * if we still ahve a path-list, unlink from it
86 if (FIB_NODE_INDEX_INVALID != be->be_path_list)
88 fib_path_list_walk(be->be_path_list,
89 bier_entry_unlink_walk,
91 fib_path_list_child_remove(be->be_path_list,
92 be->be_sibling_index);
95 pool_put(bier_entry_pool, be);
99 bier_entry_table_ecmp_walk_add_fmask (index_t btei,
102 bier_entry_t *be = arg;;
105 * choose a fmask from the entry's resolved set to add
106 * to ECMP table's lookup table
108 if (FIB_NODE_INDEX_INVALID != be->be_path_list)
110 const bier_table_id_t *btid;
111 dpo_id_t dpo = DPO_INVALID;
112 const dpo_id_t *choice;
115 btid = bier_table_get_id(btei);
117 fib_path_list_contribute_forwarding(be->be_path_list,
118 FIB_FORW_CHAIN_TYPE_BIER,
119 FIB_PATH_LIST_FWD_FLAG_COLLAPSE,
123 * select the appropriate bucket from the LB
125 if (dpo.dpoi_type == DPO_LOAD_BALANCE)
127 lb = load_balance_get(dpo.dpoi_index);
128 choice = load_balance_get_bucket_i(lb,
130 (lb->lb_n_buckets_minus_1));
137 if (choice->dpoi_type == DPO_BIER_FMASK)
139 bier_table_ecmp_set_fmask(btei, be->be_bp,
145 * any other type results in a drop, which we represent
146 * with an empty bucket
148 bier_table_ecmp_set_fmask(btei, be->be_bp,
157 * no fmasks left. insert a drop
159 bier_table_ecmp_set_fmask(btei, be->be_bp, INDEX_INVALID);
164 bier_entry_path_add (index_t bei,
165 const fib_route_path_t *rpaths)
167 fib_node_index_t old_pl_index;
170 be = bier_entry_get(bei);
171 old_pl_index = be->be_path_list;
174 * lock the path-list so it does not go away before we unlink
175 * from its resolved fmasks
177 fib_path_list_lock(old_pl_index);
179 if (FIB_NODE_INDEX_INVALID == be->be_path_list)
181 old_pl_index = FIB_NODE_INDEX_INVALID;
182 be->be_path_list = fib_path_list_create((FIB_PATH_LIST_FLAG_SHARED |
183 FIB_PATH_LIST_FLAG_NO_URPF),
185 be->be_sibling_index = fib_path_list_child_add(be->be_path_list,
186 FIB_NODE_TYPE_BIER_ENTRY,
187 bier_entry_get_index(be));
192 old_pl_index = be->be_path_list;
195 fib_path_list_copy_and_path_add(old_pl_index,
196 (FIB_PATH_LIST_FLAG_SHARED |
197 FIB_PATH_LIST_FLAG_NO_URPF),
200 fib_path_list_child_remove(old_pl_index,
201 be->be_sibling_index);
202 be->be_sibling_index = fib_path_list_child_add(be->be_path_list,
203 FIB_NODE_TYPE_BIER_ENTRY,
204 bier_entry_get_index(be));
207 * link the entry's bit-position to each fmask in the new path-list
208 * then unlink from the old.
210 fib_path_list_walk(be->be_path_list,
211 bier_entry_link_walk,
213 if (FIB_NODE_INDEX_INVALID != old_pl_index)
215 fib_path_list_walk(old_pl_index,
216 bier_entry_unlink_walk,
221 * update the ECNP tables with the new choice
223 bier_table_ecmp_walk(be->be_bti,
224 bier_entry_table_ecmp_walk_add_fmask,
228 * symmetric unlock. The old path-list may not exist hereinafter
230 fib_path_list_unlock(old_pl_index);
234 bier_entry_path_remove (index_t bei,
235 const fib_route_path_t *rpaths)
237 fib_node_index_t old_pl_index;
240 be = bier_entry_get(bei);
241 old_pl_index = be->be_path_list;
243 fib_path_list_lock(old_pl_index);
245 ASSERT (FIB_NODE_INDEX_INVALID != be->be_path_list);
248 fib_path_list_copy_and_path_remove(old_pl_index,
249 (FIB_PATH_LIST_FLAG_SHARED |
250 FIB_PATH_LIST_FLAG_NO_URPF),
253 if (be->be_path_list != old_pl_index)
258 fib_path_list_child_remove(old_pl_index,
259 be->be_sibling_index);
261 if (FIB_NODE_INDEX_INVALID != be->be_path_list)
264 * link the entry's bit-position to each fmask in the new path-list
265 * then unlink from the old.
267 fib_path_list_walk(be->be_path_list,
268 bier_entry_link_walk,
270 be->be_sibling_index =
271 fib_path_list_child_add(be->be_path_list,
272 FIB_NODE_TYPE_BIER_ENTRY,
273 bier_entry_get_index(be));
276 fib_path_list_walk(old_pl_index,
277 bier_entry_unlink_walk,
280 fib_path_list_unlock(old_pl_index);
284 * update the ECNP tables with the new choice
286 bier_table_ecmp_walk(be->be_bti,
287 bier_entry_table_ecmp_walk_add_fmask,
290 return (fib_path_list_get_n_paths(be->be_path_list));
294 bier_entry_contribute_forwarding(index_t bei,
297 bier_entry_t *be = bier_entry_get(bei);
299 fib_path_list_contribute_forwarding(be->be_path_list,
300 FIB_FORW_CHAIN_TYPE_BIER,
301 FIB_PATH_LIST_FWD_FLAG_COLLAPSE,
306 format_bier_entry (u8* s, va_list *ap)
308 index_t bei = va_arg(*ap, index_t);
309 bier_show_flags_t flags = va_arg(*ap, bier_show_flags_t);
311 bier_entry_t *be = bier_entry_get(bei);
313 s = format(s, " bp:%d\n", be->be_bp);
314 s = fib_path_list_format(be->be_path_list, s);
316 if (flags & BIER_SHOW_DETAIL)
318 dpo_id_t dpo = DPO_INVALID;
320 bier_entry_contribute_forwarding(bei, &dpo);
322 s = format(s, " forwarding:\n");
324 format_dpo_id, &dpo, 2);
332 bier_entry_get_node (fib_node_index_t index)
334 bier_entry_t *be = bier_entry_get(index);
335 return (&(be->be_node));
339 bier_entry_get_from_node (fib_node_t *node)
341 return ((bier_entry_t*)(((char*)node) -
342 STRUCT_OFFSET_OF(bier_entry_t,
347 bier_entry_last_lock_gone (fib_node_t *node)
350 * the lifetime of the entry is managed by the table.
356 * A back walk has reached this BIER entry
358 static fib_node_back_walk_rc_t
359 bier_entry_back_walk_notify (fib_node_t *node,
360 fib_node_back_walk_ctx_t *ctx)
363 * re-populate the ECMP tables with new choices
365 bier_entry_t *be = bier_entry_get_from_node(node);
367 bier_table_ecmp_walk(be->be_bti,
368 bier_entry_table_ecmp_walk_add_fmask,
372 * no need to propagate further up the graph.
374 return (FIB_NODE_BACK_WALK_CONTINUE);
378 * The BIER fmask's graph node virtual function table
380 static const fib_node_vft_t bier_entry_vft = {
381 .fnv_get = bier_entry_get_node,
382 .fnv_last_lock = bier_entry_last_lock_gone,
383 .fnv_back_walk = bier_entry_back_walk_notify,
387 bier_entry_module_init (vlib_main_t * vm)
389 fib_node_register_type (FIB_NODE_TYPE_BIER_ENTRY, &bier_entry_vft);
394 VLIB_INIT_FUNCTION (bier_entry_module_init);