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 #ifndef __MFIB_TABLE_H__
17 #define __MFIB_TABLE_H__
19 #include <vnet/ip/ip.h>
20 #include <vnet/adj/adj.h>
21 #include <vnet/dpo/replicate_dpo.h>
23 #include <vnet/mfib/mfib_types.h>
27 * A protocol Independent IP multicast FIB table
29 typedef struct mfib_table_t_
32 * A union of the protocol specific FIBs that provide the
33 * underlying LPM mechanism.
34 * This element is first in the struct so that it is in the
43 * Which protocol this table serves. Used to switch on the union above.
45 fib_protocol_t mft_proto;
48 * number of locks on the table
53 * Table ID (hash key) for this FIB.
58 * Index into FIB vector.
60 fib_node_index_t mft_index;
63 * Total route counters
65 u32 mft_total_route_counts;
75 * Format the description/name of the table
77 extern u8* format_mfib_table_name(u8* s, va_list ap);
81 * Perfom a longest prefix match in the non-forwarding table
84 * The index of the FIB
87 * The prefix to lookup
90 * The index of the fib_entry_t for the best match, which may be the default route
92 extern fib_node_index_t mfib_table_lookup(u32 fib_index,
93 const mfib_prefix_t *prefix);
97 * Perfom an exact match in the non-forwarding table
100 * The index of the FIB
103 * The prefix to lookup
106 * The index of the fib_entry_t for the exact match, or INVALID
107 * is there is no match.
109 extern fib_node_index_t mfib_table_lookup_exact_match(u32 fib_index,
110 const mfib_prefix_t *prefix);
114 * Add a new (with no replication) or lock an existing entry
117 * The prefix for the entry to add
120 * the index of the fib_entry_t that is created (or existed already).
122 extern fib_node_index_t mfib_table_entry_update(u32 fib_index,
123 const mfib_prefix_t *prefix,
124 mfib_source_t source,
125 mfib_entry_flags_t flags);
129 * Add n paths to an entry (aka route) in the FIB. If the entry does not
130 * exist, it will be created.
131 * See the documentation for fib_route_path_t for more descirptions of
132 * the path parameters.
135 * The index of the FIB
138 * The prefix for the entry to add
141 * The ID of the client/source adding the entry.
144 * Flags for the entry.
150 * the index of the fib_entry_t that is created (or existed already).
152 extern fib_node_index_t mfib_table_entry_path_update(u32 fib_index,
153 const mfib_prefix_t *prefix,
154 mfib_source_t source,
155 const fib_route_path_t *rpath,
156 mfib_itf_flags_t flags);
160 * Remove n paths to an entry (aka route) in the FIB. If this is the entry's
161 * last path, then the entry will be removed, unless it has other sources.
162 * See the documentation for fib_route_path_t for more descirptions of
163 * the path parameters.
166 * The index of the FIB
169 * The prefix for the entry to add
172 * The ID of the client/source adding the entry.
177 extern void mfib_table_entry_path_remove(u32 fib_index,
178 const mfib_prefix_t *prefix,
179 mfib_source_t source,
180 const fib_route_path_t *paths);
186 * Delete a FIB entry. If the entry has no more sources, then it is
187 * removed from the table.
190 * The index of the FIB
193 * The prefix for the entry to remove
196 * The ID of the client/source adding the entry.
198 extern void mfib_table_entry_delete(u32 fib_index,
199 const mfib_prefix_t *prefix,
200 mfib_source_t source);
204 * Delete a FIB entry. If the entry has no more sources, then it is
205 * removed from the table.
208 * The index of the FIB entry
211 * The ID of the client/source adding the entry.
213 extern void mfib_table_entry_delete_index(fib_node_index_t entry_index,
214 mfib_source_t source);
218 * Add a 'special' entry to the mFIB that links to the DPO passed
219 * A special entry is an entry that the FIB is not expect to resolve
220 * via the usual mechanisms (i.e. recurisve or neighbour adj DB lookup).
221 * Instead the client/source provides the index of a replicate DPO to link to.
224 * The index of the FIB
230 * The ID of the client/source adding the entry.
233 * Flags for the entry.
236 * The replicate DPO index to link to.
239 * the index of the fib_entry_t that is created (or existed already).
241 extern fib_node_index_t mfib_table_entry_special_add(u32 fib_index,
242 const mfib_prefix_t *prefix,
243 mfib_source_t source,
244 mfib_entry_flags_t flags,
249 * Flush all entries from a table for the source
252 * The index of the FIB
255 * The protocol of the entries in the table
258 * the source to flush
260 extern void mfib_table_flush(u32 fib_index,
261 fib_protocol_t proto);
265 * Get the index of the FIB bound to the interface
268 * The protocol of the FIB (and thus the entries therein)
271 * The interface index
274 * The index of the FIB
276 extern u32 mfib_table_get_index_for_sw_if_index(fib_protocol_t proto,
281 * Get the index of the FIB for a Table-ID. This DOES NOT create the
282 * FIB if it does not exist.
285 * The protocol of the FIB (and thus the entries therein)
291 * The index of the FIB, which may be INVALID.
293 extern u32 mfib_table_find(fib_protocol_t proto, u32 table_id);
298 * Get the index of the FIB for a Table-ID. This DOES create the
299 * FIB if it does not exist.
302 * The protocol of the FIB (and thus the entries therein)
308 * The index of the FIB
310 extern u32 mfib_table_find_or_create_and_lock(fib_protocol_t proto,
316 * Take a reference counting lock on the table
319 * The index of the FIB
322 * The protocol of the FIB (and thus the entries therein)
324 extern void mfib_table_unlock(u32 fib_index,
325 fib_protocol_t proto);
329 * Release a reference counting lock on the table. When the last lock
330 * has gone. the FIB is deleted.
333 * The index of the FIB
336 * The protocol of the FIB (and thus the entries therein)
338 extern void mfib_table_lock(u32 fib_index,
339 fib_protocol_t proto);
343 * Return the number of entries in the FIB added by a given source.
346 * The index of the FIB
349 * The protocol of the FIB (and thus the entries therein)
351 * @return number of sourced entries.
353 extern u32 mfib_table_get_num_entries(u32 fib_index,
354 fib_protocol_t proto);
358 * Get a pointer to a FIB table
360 extern mfib_table_t *mfib_table_get(fib_node_index_t index,
361 fib_protocol_t proto);
364 * @brief Call back function when walking entries in a FIB table
366 typedef int (*mfib_table_walk_fn_t)(fib_node_index_t fei,
370 * @brief Walk all entries in a FIB table
371 * N.B: This is NOT safe to deletes. If you need to delete, walk the whole
372 * table and store elements in a vector, then delete the elements
374 extern void mfib_table_walk(u32 fib_index,
375 fib_protocol_t proto,
376 mfib_table_walk_fn_t fn,