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 __IP6_MFIB_H__
26 #define __IP6_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 ip6_mfib_table_lookup(const ip6_mfib_t *fib,
34 const ip6_address_t *src,
35 const ip6_address_t *grp,
37 extern fib_node_index_t ip6_mfib_table_fwd_lookup(const ip6_mfib_t *fib,
38 const ip6_address_t *src,
39 const ip6_address_t *grp);
40 extern fib_node_index_t ip6_mfib_table_lookup_exact_match(const ip6_mfib_t *fib,
41 const ip6_address_t *grp,
42 const ip6_address_t *src,
44 extern fib_node_index_t ip6_mfib_table_get_less_specific (const ip6_mfib_t *mfib,
45 const ip6_address_t *src,
46 const ip6_address_t *grp,
49 extern void ip6_mfib_table_entry_remove(ip6_mfib_t *fib,
50 const ip6_address_t *grp,
51 const ip6_address_t *src,
54 extern void ip6_mfib_table_entry_insert(ip6_mfib_t *fib,
55 const ip6_address_t *grp,
56 const ip6_address_t *src,
58 fib_node_index_t fib_entry_index);
59 extern void ip6_mfib_table_destroy(ip6_mfib_t *fib);
63 * Add/remove the interface from the accepting list of the special MFIB entries
65 extern void ip6_mfib_interface_enable_disable(u32 sw_if_index,
69 * @brief Get the FIB at the given index
71 static inline ip6_mfib_t *
72 ip6_mfib_get (u32 index)
74 return (&(pool_elt_at_index(ip6_main.mfibs, index)->v6));
78 * @brief Get or create an IPv4 fib.
80 * Get or create an IPv4 fib with the provided table ID.
83 * When set to \c ~0, an arbitrary and unused fib ID is picked
84 * and can be retrieved with \c ret->table_id.
85 * Otherwise, the fib ID to be used to retrieve or create the desired fib.
86 * @returns A pointer to the retrieved or created fib.
89 extern u32 ip6_mfib_table_find_or_create_and_lock(u32 table_id,
91 extern u32 ip6_mfib_table_create_and_lock(mfib_source_t src);
95 u32 ip6_mfib_index_from_table_id (u32 table_id)
97 ip6_main_t * im = &ip6_main;
100 p = hash_get (im->mfib_index_by_table_id, table_id);
107 extern u32 ip6_mfib_table_get_index_for_sw_if_index(u32 sw_if_index);
110 * @brief Data-plane lookup function
112 extern fib_node_index_t ip6_mfib_table_lookup2(const ip6_mfib_t *mfib,
113 const ip6_address_t *src,
114 const ip6_address_t *grp);
117 * @brief Walk the IP6 mfib table.
119 * @param mfib the table to walk
120 * @param fn The function to invoke on each entry visited
121 * @param ctx A context passed in the visit function
123 extern void ip6_mfib_table_walk (ip6_mfib_t *mfib,
124 mfib_table_walk_fn_t fn,
128 * @brief format (display) ipv6 MFIB mempry usage
130 extern u8 *format_ip6_mfib_table_memory(u8 * s, va_list * args);