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 <vlib/vlib.h>
17 #include <vnet/dpo/drop_dpo.h>
19 #include <vnet/mfib/mfib_table.h>
20 #include <vnet/mfib/ip4_mfib.h>
21 #include <vnet/mfib/ip6_mfib.h>
22 #include <vnet/mfib/mfib_entry.h>
23 #include <vnet/mfib/mfib_signal.h>
26 mfib_table_get (fib_node_index_t index,
31 case FIB_PROTOCOL_IP4:
32 return (pool_elt_at_index(ip4_main.mfibs, index));
33 case FIB_PROTOCOL_IP6:
34 return (pool_elt_at_index(ip6_main.mfibs, index));
35 case FIB_PROTOCOL_MPLS:
42 static inline fib_node_index_t
43 mfib_table_lookup_i (const mfib_table_t *mfib_table,
44 const mfib_prefix_t *prefix)
46 switch (prefix->fp_proto)
48 case FIB_PROTOCOL_IP4:
49 return (ip4_mfib_table_lookup(&mfib_table->v4,
50 &prefix->fp_src_addr.ip4,
51 &prefix->fp_grp_addr.ip4,
53 case FIB_PROTOCOL_IP6:
54 return (ip6_mfib_table_lookup(&mfib_table->v6,
55 &prefix->fp_src_addr.ip6,
56 &prefix->fp_grp_addr.ip6,
58 case FIB_PROTOCOL_MPLS:
61 return (FIB_NODE_INDEX_INVALID);
65 mfib_table_lookup (u32 fib_index,
66 const mfib_prefix_t *prefix)
68 return (mfib_table_lookup_i(mfib_table_get(fib_index, prefix->fp_proto), prefix));
71 static inline fib_node_index_t
72 mfib_table_lookup_exact_match_i (const mfib_table_t *mfib_table,
73 const mfib_prefix_t *prefix)
75 switch (prefix->fp_proto)
77 case FIB_PROTOCOL_IP4:
78 return (ip4_mfib_table_lookup_exact_match(&mfib_table->v4,
79 &prefix->fp_grp_addr.ip4,
80 &prefix->fp_src_addr.ip4,
82 case FIB_PROTOCOL_IP6:
83 return (ip6_mfib_table_lookup_exact_match(&mfib_table->v6,
84 &prefix->fp_grp_addr.ip6,
85 &prefix->fp_src_addr.ip6,
87 case FIB_PROTOCOL_MPLS:
90 return (FIB_NODE_INDEX_INVALID);
94 mfib_table_lookup_exact_match (u32 fib_index,
95 const mfib_prefix_t *prefix)
97 return (mfib_table_lookup_exact_match_i(mfib_table_get(fib_index,
103 mfib_table_entry_remove (mfib_table_t *mfib_table,
104 const mfib_prefix_t *prefix,
105 fib_node_index_t fib_entry_index)
107 vlib_smp_unsafe_warning();
109 mfib_table->mft_total_route_counts--;
111 switch (prefix->fp_proto)
113 case FIB_PROTOCOL_IP4:
114 ip4_mfib_table_entry_remove(&mfib_table->v4,
115 &prefix->fp_grp_addr.ip4,
116 &prefix->fp_src_addr.ip4,
119 case FIB_PROTOCOL_IP6:
120 ip6_mfib_table_entry_remove(&mfib_table->v6,
121 &prefix->fp_grp_addr.ip6,
122 &prefix->fp_src_addr.ip6,
125 case FIB_PROTOCOL_MPLS:
130 mfib_entry_unlock(fib_entry_index);
134 mfib_table_entry_insert (mfib_table_t *mfib_table,
135 const mfib_prefix_t *prefix,
136 fib_node_index_t mfib_entry_index)
138 vlib_smp_unsafe_warning();
140 mfib_entry_lock(mfib_entry_index);
141 mfib_table->mft_total_route_counts++;
143 switch (prefix->fp_proto)
145 case FIB_PROTOCOL_IP4:
146 ip4_mfib_table_entry_insert(&mfib_table->v4,
147 &prefix->fp_grp_addr.ip4,
148 &prefix->fp_src_addr.ip4,
152 case FIB_PROTOCOL_IP6:
153 ip6_mfib_table_entry_insert(&mfib_table->v6,
154 &prefix->fp_grp_addr.ip6,
155 &prefix->fp_src_addr.ip6,
159 case FIB_PROTOCOL_MPLS:
165 mfib_table_entry_update (u32 fib_index,
166 const mfib_prefix_t *prefix,
167 mfib_source_t source,
169 mfib_entry_flags_t entry_flags)
171 fib_node_index_t mfib_entry_index;
172 mfib_table_t *mfib_table;
174 mfib_table = mfib_table_get(fib_index, prefix->fp_proto);
175 mfib_entry_index = mfib_table_lookup_exact_match_i(mfib_table, prefix);
177 if (FIB_NODE_INDEX_INVALID == mfib_entry_index)
179 if (MFIB_ENTRY_FLAG_NONE != entry_flags)
182 * update to a non-existing entry with non-zero flags
184 mfib_entry_index = mfib_entry_create(fib_index, source,
188 mfib_table_entry_insert(mfib_table, prefix, mfib_entry_index);
192 * the entry doesn't exist and the request is to set no flags
193 * the result would be an entry that doesn't exist - so do nothing
198 mfib_entry_lock(mfib_entry_index);
200 if (mfib_entry_update(mfib_entry_index,
207 * this update means we can now remove the entry.
209 mfib_table_entry_remove(mfib_table, prefix, mfib_entry_index);
212 mfib_entry_unlock(mfib_entry_index);
215 return (mfib_entry_index);
219 mfib_table_entry_path_update (u32 fib_index,
220 const mfib_prefix_t *prefix,
221 mfib_source_t source,
222 const fib_route_path_t *rpath,
223 mfib_itf_flags_t itf_flags)
225 fib_node_index_t mfib_entry_index;
226 mfib_table_t *mfib_table;
228 mfib_table = mfib_table_get(fib_index, prefix->fp_proto);
229 mfib_entry_index = mfib_table_lookup_exact_match_i(mfib_table, prefix);
231 if (FIB_NODE_INDEX_INVALID == mfib_entry_index)
233 mfib_entry_index = mfib_entry_create(fib_index,
237 MFIB_ENTRY_FLAG_NONE);
239 mfib_table_entry_insert(mfib_table, prefix, mfib_entry_index);
242 mfib_entry_path_update(mfib_entry_index,
247 return (mfib_entry_index);
251 mfib_table_entry_path_remove (u32 fib_index,
252 const mfib_prefix_t *prefix,
253 mfib_source_t source,
254 const fib_route_path_t *rpath)
256 fib_node_index_t mfib_entry_index;
257 mfib_table_t *mfib_table;
259 mfib_table = mfib_table_get(fib_index, prefix->fp_proto);
260 mfib_entry_index = mfib_table_lookup_exact_match_i(mfib_table, prefix);
262 if (FIB_NODE_INDEX_INVALID == mfib_entry_index)
265 * removing an etry that does not exist. i'll allow it.
273 * don't nobody go nowhere
275 mfib_entry_lock(mfib_entry_index);
277 no_more_sources = mfib_entry_path_remove(mfib_entry_index,
284 * last source gone. remove from the table
286 mfib_table_entry_remove(mfib_table, prefix, mfib_entry_index);
289 mfib_entry_unlock(mfib_entry_index);
294 mfib_table_entry_special_add (u32 fib_index,
295 const mfib_prefix_t *prefix,
296 mfib_source_t source,
297 mfib_entry_flags_t entry_flags,
300 fib_node_index_t mfib_entry_index;
301 mfib_table_t *mfib_table;
303 mfib_table = mfib_table_get(fib_index, prefix->fp_proto);
304 mfib_entry_index = mfib_table_lookup_exact_match_i(mfib_table, prefix);
306 if (FIB_NODE_INDEX_INVALID == mfib_entry_index)
308 mfib_entry_index = mfib_entry_create(fib_index,
312 MFIB_ENTRY_FLAG_NONE);
314 mfib_table_entry_insert(mfib_table, prefix, mfib_entry_index);
317 mfib_entry_update(mfib_entry_index, source,
318 (MFIB_ENTRY_FLAG_EXCLUSIVE | entry_flags),
322 return (mfib_entry_index);
326 mfib_table_entry_delete_i (u32 fib_index,
327 fib_node_index_t mfib_entry_index,
328 const mfib_prefix_t *prefix,
329 mfib_source_t source)
331 mfib_table_t *mfib_table;
333 mfib_table = mfib_table_get(fib_index, prefix->fp_proto);
336 * don't nobody go nowhere
338 mfib_entry_lock(mfib_entry_index);
340 if (mfib_entry_delete(mfib_entry_index, source))
343 * last source gone. remove from the table
345 mfib_table_entry_remove(mfib_table, prefix, mfib_entry_index);
349 * still has sources, leave it be.
352 mfib_entry_unlock(mfib_entry_index);
356 mfib_table_entry_delete (u32 fib_index,
357 const mfib_prefix_t *prefix,
358 mfib_source_t source)
360 fib_node_index_t mfib_entry_index;
362 mfib_entry_index = mfib_table_lookup_exact_match(fib_index, prefix);
364 if (FIB_NODE_INDEX_INVALID == mfib_entry_index)
367 * removing an etry that does not exist.
368 * i'll allow it, but i won't like it.
370 clib_warning("%U not in FIB", format_mfib_prefix, prefix);
374 mfib_table_entry_delete_i(fib_index, mfib_entry_index,
380 mfib_table_entry_delete_index (fib_node_index_t mfib_entry_index,
381 mfib_source_t source)
383 mfib_prefix_t prefix;
385 mfib_entry_get_prefix(mfib_entry_index, &prefix);
387 mfib_table_entry_delete_i(mfib_entry_get_fib_index(mfib_entry_index),
388 mfib_entry_index, &prefix, source);
392 mfib_table_get_index_for_sw_if_index (fib_protocol_t proto,
397 case FIB_PROTOCOL_IP4:
398 return (ip4_mfib_table_get_index_for_sw_if_index(sw_if_index));
399 case FIB_PROTOCOL_IP6:
400 return (ip6_mfib_table_get_index_for_sw_if_index(sw_if_index));
401 case FIB_PROTOCOL_MPLS:
409 mfib_table_find (fib_protocol_t proto,
414 case FIB_PROTOCOL_IP4:
415 return (ip4_mfib_index_from_table_id(table_id));
416 case FIB_PROTOCOL_IP6:
417 return (ip6_mfib_index_from_table_id(table_id));
418 case FIB_PROTOCOL_MPLS:
426 mfib_table_find_or_create_and_lock_i (fib_protocol_t proto,
431 mfib_table_t *mfib_table;
436 case FIB_PROTOCOL_IP4:
437 fi = ip4_mfib_table_find_or_create_and_lock(table_id, src);
439 case FIB_PROTOCOL_IP6:
440 fi = ip6_mfib_table_find_or_create_and_lock(table_id, src);
442 case FIB_PROTOCOL_MPLS:
447 mfib_table = mfib_table_get(fi, proto);
449 if (NULL == mfib_table->mft_desc)
453 mfib_table->mft_desc = format(NULL, "%s", name);
457 mfib_table->mft_desc = format(NULL, "%U-VRF:%d",
458 format_fib_protocol, proto,
467 mfib_table_find_or_create_and_lock (fib_protocol_t proto,
471 return (mfib_table_find_or_create_and_lock_i(proto, table_id,
476 mfib_table_find_or_create_and_lock_w_name (fib_protocol_t proto,
481 return (mfib_table_find_or_create_and_lock_i(proto, table_id,
486 * @brief Table flush context. Store the indicies of matching FIB entries
487 * that need to be removed.
489 typedef struct mfib_table_flush_ctx_t_
492 * The list of entries to flush
494 fib_node_index_t *mftf_entries;
497 * The source we are flushing
499 mfib_source_t mftf_source;
500 } mfib_table_flush_ctx_t;
503 mfib_table_flush_cb (fib_node_index_t mfib_entry_index,
506 mfib_table_flush_ctx_t *ctx = arg;
508 if (mfib_entry_is_sourced(mfib_entry_index, ctx->mftf_source))
510 vec_add1(ctx->mftf_entries, mfib_entry_index);
516 mfib_table_flush (u32 mfib_index,
517 fib_protocol_t proto,
518 mfib_source_t source)
520 fib_node_index_t *mfib_entry_index;
521 mfib_table_flush_ctx_t ctx = {
522 .mftf_entries = NULL,
523 .mftf_source = source,
526 mfib_table_walk(mfib_index, proto,
530 vec_foreach(mfib_entry_index, ctx.mftf_entries)
532 mfib_table_entry_delete_index(*mfib_entry_index, source);
535 vec_free(ctx.mftf_entries);
539 mfib_table_destroy (mfib_table_t *mfib_table)
541 vec_free(mfib_table->mft_desc);
543 switch (mfib_table->mft_proto)
545 case FIB_PROTOCOL_IP4:
546 ip4_mfib_table_destroy(&mfib_table->v4);
548 case FIB_PROTOCOL_IP6:
549 ip6_mfib_table_destroy(&mfib_table->v6);
551 case FIB_PROTOCOL_MPLS:
558 mfib_table_unlock (u32 fib_index,
559 fib_protocol_t proto,
560 mfib_source_t source)
562 mfib_table_t *mfib_table;
564 mfib_table = mfib_table_get(fib_index, proto);
565 mfib_table->mft_locks[source]--;
566 mfib_table->mft_locks[MFIB_TABLE_TOTAL_LOCKS]--;
568 if (0 == mfib_table->mft_locks[source])
571 * The source no longer needs the table. flush any routes
572 * from it just in case
574 mfib_table_flush(fib_index, proto, source);
577 if (0 == mfib_table->mft_locks[MFIB_TABLE_TOTAL_LOCKS])
580 * no more locak from any source - kill it
582 mfib_table_destroy(mfib_table);
587 mfib_table_lock (u32 fib_index,
588 fib_protocol_t proto,
589 mfib_source_t source)
591 mfib_table_t *mfib_table;
593 mfib_table = mfib_table_get(fib_index, proto);
594 mfib_table->mft_locks[source]++;
595 mfib_table->mft_locks[MFIB_TABLE_TOTAL_LOCKS]++;
599 mfib_table_walk (u32 fib_index,
600 fib_protocol_t proto,
601 mfib_table_walk_fn_t fn,
606 case FIB_PROTOCOL_IP4:
607 ip4_mfib_table_walk(ip4_mfib_get(fib_index), fn, ctx);
609 case FIB_PROTOCOL_IP6:
610 ip6_mfib_table_walk(ip6_mfib_get(fib_index), fn, ctx);
612 case FIB_PROTOCOL_MPLS:
618 format_mfib_table_name (u8* s, va_list *ap)
620 fib_node_index_t fib_index = va_arg(*ap, fib_node_index_t);
621 fib_protocol_t proto = va_arg(*ap, int); // int promotion
622 mfib_table_t *mfib_table;
624 mfib_table = mfib_table_get(fib_index, proto);
626 s = format(s, "%v", mfib_table->mft_desc);
631 static clib_error_t *
632 mfib_module_init (vlib_main_t * vm)
634 clib_error_t * error;
636 if ((error = vlib_call_init_function (vm, fib_module_init)))
638 if ((error = vlib_call_init_function (vm, rn_module_init)))
641 mfib_entry_module_init();
642 mfib_signal_module_init();
647 VLIB_INIT_FUNCTION(mfib_module_init);