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 * @brief The IPv4 Multicast-FIB
20 * This IPv4 FIB is used by the protocol independent FIB. So directly using
21 * this APIs in client code is not encouraged. However, this IPv4 FIB can be
22 * used if all the client wants is an IPv4 prefix data-base
25 #ifndef __IP4_MFIB_H__
26 #define __IP4_MFIB_H__
28 #include <vlib/vlib.h>
29 #include <vnet/ip/ip.h>
31 #include <vnet/mfib/mfib_table.h>
33 extern fib_node_index_t ip4_mfib_table_lookup(const ip4_mfib_t *fib,
34 const ip4_address_t *src,
35 const ip4_address_t *grp,
37 extern fib_node_index_t ip4_mfib_table_lookup_exact_match(const ip4_mfib_t *fib,
38 const ip4_address_t *grp,
39 const ip4_address_t *src,
41 extern fib_node_index_t ip4_mfib_table_get_less_specific (const ip4_mfib_t *mfib,
42 const ip4_address_t *src,
43 const ip4_address_t *grp,
46 extern void ip4_mfib_table_entry_remove(ip4_mfib_t *fib,
47 const ip4_address_t *grp,
48 const ip4_address_t *src,
51 extern void ip4_mfib_table_entry_insert(ip4_mfib_t *fib,
52 const ip4_address_t *grp,
53 const ip4_address_t *src,
55 fib_node_index_t fib_entry_index);
56 extern void ip4_mfib_table_destroy(ip4_mfib_t *fib);
59 * @brief Get the FIB at the given index
61 static inline ip4_mfib_t *
62 ip4_mfib_get (u32 index)
64 return (&(pool_elt_at_index(ip4_main.mfibs, index)->v4));
68 * @brief Get or create an IPv4 fib.
70 * Get or create an IPv4 fib with the provided table ID.
73 * When set to \c ~0, an arbitrary and unused fib ID is picked
74 * and can be retrieved with \c ret->table_id.
75 * Otherwise, the fib ID to be used to retrieve or create the desired fib.
76 * @returns A pointer to the retrieved or created fib.
79 extern u32 ip4_mfib_table_find_or_create_and_lock(u32 table_id,
81 extern u32 ip4_mfib_table_create_and_lock(mfib_source_t src);
84 u32 ip4_mfib_index_from_table_id (u32 table_id)
86 ip4_main_t * im = &ip4_main;
89 p = hash_get (im->mfib_index_by_table_id, table_id);
96 extern u32 ip4_mfib_table_get_index_for_sw_if_index(u32 sw_if_index);
99 * @brief Walk the IP4 mfib table.
101 * @param mfib the table to walk
102 * @param fn The function to invoke on each entry visited
103 * @param ctx A context passed in the visit function
105 extern void ip4_mfib_table_walk(ip4_mfib_t *mfib,
106 mfib_table_walk_fn_t fn,
110 * @brief format (display) the memory usage for IP4 mfibs
112 extern u8 * format_ip4_mfib_table_memory(u8 * s, va_list * args);