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>
26 * Keep a lock per-source and a total
28 #define MFIB_TABLE_N_LOCKS (MFIB_N_SOURCES+1)
29 #define MFIB_TABLE_TOTAL_LOCKS MFIB_N_SOURCES
33 * A protocol Independent IP multicast FIB table
35 typedef struct mfib_table_t_
38 * A union of the protocol specific FIBs that provide the
39 * underlying LPM mechanism.
40 * This element is first in the struct so that it is in the
49 * Which protocol this table serves. Used to switch on the union above.
51 fib_protocol_t mft_proto;
54 * number of locks on the table
56 u16 mft_locks[MFIB_TABLE_N_LOCKS];
59 * Table ID (hash key) for this FIB.
64 * Index into FIB vector.
66 fib_node_index_t mft_index;
69 * Total route counters
71 u32 mft_total_route_counts;
81 * Format the description/name of the table
83 extern u8* format_mfib_table_name(u8* s, va_list *ap);
87 * Perfom a longest prefix match in the non-forwarding table
90 * The index of the FIB
93 * The prefix to lookup
96 * The index of the fib_entry_t for the best match, which may be the default route
98 extern fib_node_index_t mfib_table_lookup(u32 fib_index,
99 const mfib_prefix_t *prefix);
103 * Perfom an exact match in the non-forwarding table
106 * The index of the FIB
109 * The prefix to lookup
112 * The index of the fib_entry_t for the exact match, or INVALID
113 * is there is no match.
115 extern fib_node_index_t mfib_table_lookup_exact_match(u32 fib_index,
116 const mfib_prefix_t *prefix);
120 * Add a new (with no replication) or lock an existing entry
123 * The prefix for the entry to add
126 * the index of the fib_entry_t that is created (or existed already).
128 extern fib_node_index_t mfib_table_entry_update(u32 fib_index,
129 const mfib_prefix_t *prefix,
130 mfib_source_t source,
132 mfib_entry_flags_t flags);
136 * Add n paths to an entry (aka route) in the FIB. If the entry does not
137 * exist, it will be created.
138 * See the documentation for fib_route_path_t for more descirptions of
139 * the path parameters.
142 * The index of the FIB
145 * The prefix for the entry to add
148 * The ID of the client/source adding the entry.
151 * Flags for the entry.
157 * the index of the fib_entry_t that is created (or existed already).
159 extern fib_node_index_t mfib_table_entry_path_update(u32 fib_index,
160 const mfib_prefix_t *prefix,
161 mfib_source_t source,
162 const fib_route_path_t *rpath,
163 mfib_itf_flags_t flags);
167 * Remove n paths to an entry (aka route) in the FIB. If this is the entry's
168 * last path, then the entry will be removed, unless it has other sources.
169 * See the documentation for fib_route_path_t for more descirptions of
170 * the path parameters.
173 * The index of the FIB
176 * The prefix for the entry to add
179 * The ID of the client/source adding the entry.
184 extern void mfib_table_entry_path_remove(u32 fib_index,
185 const mfib_prefix_t *prefix,
186 mfib_source_t source,
187 const fib_route_path_t *paths);
193 * Delete a FIB entry. If the entry has no more sources, then it is
194 * removed from the table.
197 * The index of the FIB
200 * The prefix for the entry to remove
203 * The ID of the client/source adding the entry.
205 extern void mfib_table_entry_delete(u32 fib_index,
206 const mfib_prefix_t *prefix,
207 mfib_source_t source);
211 * Delete a FIB entry. If the entry has no more sources, then it is
212 * removed from the table.
215 * The index of the FIB entry
218 * The ID of the client/source adding the entry.
220 extern void mfib_table_entry_delete_index(fib_node_index_t entry_index,
221 mfib_source_t source);
225 * Add a 'special' entry to the mFIB that links to the DPO passed
226 * A special entry is an entry that the FIB is not expect to resolve
227 * via the usual mechanisms (i.e. recurisve or neighbour adj DB lookup).
228 * Instead the client/source provides the index of a replicate DPO to link to.
231 * The index of the FIB
237 * The ID of the client/source adding the entry.
240 * Flags for the entry.
243 * The replicate DPO index to link to.
246 * the index of the fib_entry_t that is created (or existed already).
248 extern fib_node_index_t mfib_table_entry_special_add(u32 fib_index,
249 const mfib_prefix_t *prefix,
250 mfib_source_t source,
251 mfib_entry_flags_t flags,
256 * Flush all entries from a table for the source
259 * The index of the FIB
262 * The protocol of the entries in the table
265 * the source to flush
267 extern void mfib_table_flush(u32 fib_index,
268 fib_protocol_t proto,
269 mfib_source_t source);
273 * Get the index of the FIB bound to the interface
276 * The protocol of the FIB (and thus the entries therein)
279 * The interface index
282 * The index of the FIB
284 extern u32 mfib_table_get_index_for_sw_if_index(fib_protocol_t proto,
289 * Get the index of the FIB for a Table-ID. This DOES NOT create the
290 * FIB if it does not exist.
293 * The protocol of the FIB (and thus the entries therein)
299 * The index of the FIB, which may be INVALID.
301 extern u32 mfib_table_find(fib_protocol_t proto, u32 table_id);
306 * Get the index of the FIB for a Table-ID. This DOES create the
307 * FIB if it does not exist.
310 * The protocol of the FIB (and thus the entries therein)
316 * The index of the FIB
319 * The ID of the client/source.
321 extern u32 mfib_table_find_or_create_and_lock(fib_protocol_t proto,
323 mfib_source_t source);
327 * Get the index of the FIB for a Table-ID. This DOES create the
328 * FIB if it does not exist.
331 * The protocol of the FIB (and thus the entries therein)
337 * The index of the FIB
340 * The ID of the client/source.
343 * The client is choosing the name they want the table to have
345 extern u32 mfib_table_find_or_create_and_lock_w_name(fib_protocol_t proto,
347 mfib_source_t source,
353 * Take a reference counting lock on the table
356 * The index of the FIB
359 * The protocol of the FIB (and thus the entries therein)
362 * The ID of the client/source.
364 extern void mfib_table_unlock(u32 fib_index,
365 fib_protocol_t proto,
366 mfib_source_t source);
370 * Release a reference counting lock on the table. When the last lock
371 * has gone. the FIB is deleted.
374 * The index of the FIB
377 * The protocol of the FIB (and thus the entries therein)
380 * The ID of the client/source.
382 extern void mfib_table_lock(u32 fib_index,
383 fib_protocol_t proto,
384 mfib_source_t source);
388 * Return the number of entries in the FIB added by a given source.
391 * The index of the FIB
394 * The protocol of the FIB (and thus the entries therein)
396 * @return number of sourced entries.
398 extern u32 mfib_table_get_num_entries(u32 fib_index,
399 fib_protocol_t proto);
403 * Get a pointer to a FIB table
405 extern mfib_table_t *mfib_table_get(fib_node_index_t index,
406 fib_protocol_t proto);
409 * @brief Call back function when walking entries in a FIB table
411 typedef int (*mfib_table_walk_fn_t)(fib_node_index_t fei,
415 * @brief Walk all entries in a FIB table
416 * N.B: This is NOT safe to deletes. If you need to delete, walk the whole
417 * table and store elements in a vector, then delete the elements
419 extern void mfib_table_walk(u32 fib_index,
420 fib_protocol_t proto,
421 mfib_table_walk_fn_t fn,
424 * @brief format (display) the memory usage for mfibs
426 extern u8 * format_mfib_table_memory(u8 * s, va_list * args);