FD.io VPP  v18.01.2-1-g9b554f3
Vector Packet Processing
mfib_table.h
Go to the documentation of this file.
1 /*
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:
6  *
7  * http://www.apache.org/licenses/LICENSE-2.0
8  *
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.
14  */
15 
16 #ifndef __MFIB_TABLE_H__
17 #define __MFIB_TABLE_H__
18 
19 #include <vnet/ip/ip.h>
20 #include <vnet/adj/adj.h>
21 #include <vnet/dpo/replicate_dpo.h>
22 
23 #include <vnet/mfib/mfib_types.h>
24 
25 /**
26  * Keep a lock per-source and a total
27  */
28 #define MFIB_TABLE_N_LOCKS (MFIB_N_SOURCES+1)
29 #define MFIB_TABLE_TOTAL_LOCKS MFIB_N_SOURCES
30 
31 /**
32  * @brief
33  * A protocol Independent IP multicast FIB table
34  */
35 typedef struct mfib_table_t_
36 {
37  /**
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
41  * first cache line.
42  */
43  union {
46  };
47 
48  /**
49  * Which protocol this table serves. Used to switch on the union above.
50  */
52 
53  /**
54  * number of locks on the table
55  */
57 
58  /**
59  * Table ID (hash key) for this FIB.
60  */
62 
63  /**
64  * Index into FIB vector.
65  */
67 
68  /**
69  * Total route counters
70  */
72 
73  /**
74  * Table description
75  */
77 } mfib_table_t;
78 
79 /**
80  * @brief
81  * Format the description/name of the table
82  */
83 extern u8* format_mfib_table_name(u8* s, va_list *ap);
84 
85 /**
86  * @brief
87  * Perfom a longest prefix match in the non-forwarding table
88  *
89  * @param fib_index
90  * The index of the FIB
91  *
92  * @param prefix
93  * The prefix to lookup
94  *
95  * @return
96  * The index of the fib_entry_t for the best match, which may be the default route
97  */
98 extern fib_node_index_t mfib_table_lookup(u32 fib_index,
99  const mfib_prefix_t *prefix);
100 
101 /**
102  * @brief
103  * Perfom an exact match in the non-forwarding table
104  *
105  * @param fib_index
106  * The index of the FIB
107  *
108  * @param prefix
109  * The prefix to lookup
110  *
111  * @return
112  * The index of the fib_entry_t for the exact match, or INVALID
113  * is there is no match.
114  */
116  const mfib_prefix_t *prefix);
117 
118 /**
119  * @brief
120  * Add a new (with no replication) or lock an existing entry
121  *
122  * @param prefix
123  * The prefix for the entry to add
124  *
125  * @return
126  * the index of the fib_entry_t that is created (or existed already).
127  */
129  const mfib_prefix_t *prefix,
130  mfib_source_t source,
131  fib_rpf_id_t rpf_id,
133 
134 /**
135  * @brief
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.
140  *
141  * @param fib_index
142  * The index of the FIB
143  *
144  * @param prefix
145  * The prefix for the entry to add
146  *
147  * @param source
148  * The ID of the client/source adding the entry.
149  *
150  * @param flags
151  * Flags for the entry.
152  *
153  * @param rpaths
154  * A vector of paths.
155  *
156  * @return
157  * the index of the fib_entry_t that is created (or existed already).
158  */
160  const mfib_prefix_t *prefix,
161  mfib_source_t source,
162  const fib_route_path_t *rpath,
164 
165 /**
166  * @brief
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.
171  *
172  * @param fib_index
173  * The index of the FIB
174  *
175  * @param prefix
176  * The prefix for the entry to add
177  *
178  * @param source
179  * The ID of the client/source adding the entry.
180  *
181  * @param rpaths
182  * A vector of paths.
183  */
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);
188 
189 
190 
191 /**
192  * @brief
193  * Delete a FIB entry. If the entry has no more sources, then it is
194  * removed from the table.
195  *
196  * @param fib_index
197  * The index of the FIB
198  *
199  * @param prefix
200  * The prefix for the entry to remove
201  *
202  * @param source
203  * The ID of the client/source adding the entry.
204  */
205 extern void mfib_table_entry_delete(u32 fib_index,
206  const mfib_prefix_t *prefix,
207  mfib_source_t source);
208 
209 /**
210  * @brief
211  * Delete a FIB entry. If the entry has no more sources, then it is
212  * removed from the table.
213  *
214  * @param entry_index
215  * The index of the FIB entry
216  *
217  * @param source
218  * The ID of the client/source adding the entry.
219  */
220 extern void mfib_table_entry_delete_index(fib_node_index_t entry_index,
221  mfib_source_t source);
222 
223 /**
224  * @brief
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.
229  *
230  * @param fib_index
231  * The index of the FIB
232  *
233  * @param prefix
234  * The prefix to add
235  *
236  * @param source
237  * The ID of the client/source adding the entry.
238  *
239  * @param flags
240  * Flags for the entry.
241  *
242  * @param rep_dpo
243  * The replicate DPO index to link to.
244  *
245  * @return
246  * the index of the fib_entry_t that is created (or existed already).
247  */
249  const mfib_prefix_t *prefix,
250  mfib_source_t source,
252  index_t rep_dpo);
253 
254 /**
255  * @brief
256  * Flush all entries from a table for the source
257  *
258  * @param fib_index
259  * The index of the FIB
260  *
261  * @paran proto
262  * The protocol of the entries in the table
263  *
264  * @param source
265  * the source to flush
266  */
267 extern void mfib_table_flush(u32 fib_index,
268  fib_protocol_t proto,
269  mfib_source_t source);
270 
271 /**
272  * @brief
273  * Get the index of the FIB bound to the interface
274  *
275  * @paran proto
276  * The protocol of the FIB (and thus the entries therein)
277  *
278  * @param sw_if_index
279  * The interface index
280  *
281  * @return fib_index
282  * The index of the FIB
283  */
285  u32 sw_if_index);
286 
287 /**
288  * @brief
289  * Get the index of the FIB for a Table-ID. This DOES NOT create the
290  * FIB if it does not exist.
291  *
292  * @paran proto
293  * The protocol of the FIB (and thus the entries therein)
294  *
295  * @param table-id
296  * The Table-ID
297  *
298  * @return fib_index
299  * The index of the FIB, which may be INVALID.
300  */
301 extern u32 mfib_table_find(fib_protocol_t proto, u32 table_id);
302 
303 
304 /**
305  * @brief
306  * Get the index of the FIB for a Table-ID. This DOES create the
307  * FIB if it does not exist.
308  *
309  * @paran proto
310  * The protocol of the FIB (and thus the entries therein)
311  *
312  * @param table-id
313  * The Table-ID
314  *
315  * @return fib_index
316  * The index of the FIB
317  *
318  * @param source
319  * The ID of the client/source.
320  */
322  u32 table_id,
323  mfib_source_t source);
324 
325 /**
326  * @brief
327  * Get the index of the FIB for a Table-ID. This DOES create the
328  * FIB if it does not exist.
329  *
330  * @paran proto
331  * The protocol of the FIB (and thus the entries therein)
332  *
333  * @param table-id
334  * The Table-ID
335  *
336  * @return fib_index
337  * The index of the FIB
338  *
339  * @param source
340  * The ID of the client/source.
341  *
342  * @param name
343  * The client is choosing the name they want the table to have
344  */
346  u32 table_id,
347  mfib_source_t source,
348  const u8 *name);
349 
350 
351 /**
352  * @brief
353  * Take a reference counting lock on the table
354  *
355  * @param fib_index
356  * The index of the FIB
357  *
358  * @paran proto
359  * The protocol of the FIB (and thus the entries therein)
360  *
361  * @param source
362  * The ID of the client/source.
363  */
364 extern void mfib_table_unlock(u32 fib_index,
365  fib_protocol_t proto,
366  mfib_source_t source);
367 
368 /**
369  * @brief
370  * Release a reference counting lock on the table. When the last lock
371  * has gone. the FIB is deleted.
372  *
373  * @param fib_index
374  * The index of the FIB
375  *
376  * @paran proto
377  * The protocol of the FIB (and thus the entries therein)
378  *
379  * @param source
380  * The ID of the client/source.
381  */
382 extern void mfib_table_lock(u32 fib_index,
383  fib_protocol_t proto,
384  mfib_source_t source);
385 
386 /**
387  * @brief
388  * Return the number of entries in the FIB added by a given source.
389  *
390  * @param fib_index
391  * The index of the FIB
392  *
393  * @paran proto
394  * The protocol of the FIB (and thus the entries therein)
395  *
396  * @return number of sourced entries.
397  */
398 extern u32 mfib_table_get_num_entries(u32 fib_index,
399  fib_protocol_t proto);
400 
401 /**
402  * @brief
403  * Get a pointer to a FIB table
404  */
406  fib_protocol_t proto);
407 
408 /**
409  * @brief Call back function when walking entries in a FIB table
410  */
412  void *ctx);
413 
414 /**
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
418  */
419 extern void mfib_table_walk(u32 fib_index,
420  fib_protocol_t proto,
422  void *ctx);
423 /**
424  * @brief format (display) the memory usage for mfibs
425  */
426 extern u8 * format_mfib_table_memory(u8 * s, va_list * args);
427 
428 #endif
void mfib_table_unlock(u32 fib_index, fib_protocol_t proto, mfib_source_t source)
Take a reference counting lock on the table.
Definition: mfib_table.c:558
u32 mfib_table_find(fib_protocol_t proto, u32 table_id)
Get the index of the FIB for a Table-ID.
Definition: mfib_table.c:409
u32 mfib_table_get_num_entries(u32 fib_index, fib_protocol_t proto)
Return the number of entries in the FIB added by a given source.
enum mfib_entry_flags_t_ mfib_entry_flags_t
A representation of a path as described by a route producer.
Definition: fib_types.h:377
ip6_mfib_t v6
Definition: mfib_table.h:45
void mfib_table_entry_path_remove(u32 fib_index, const mfib_prefix_t *prefix, mfib_source_t source, const fib_route_path_t *paths)
Remove n paths to an entry (aka route) in the FIB.
Definition: mfib_table.c:251
void mfib_table_flush(u32 fib_index, fib_protocol_t proto, mfib_source_t source)
Flush all entries from a table for the source.
Definition: mfib_table.c:516
u32 index_t
A Data-Path Object is an object that represents actions that are applied to packets are they are swit...
Definition: dpo.h:41
u16 mft_locks[MFIB_TABLE_N_LOCKS]
number of locks on the table
Definition: mfib_table.h:56
u32 mft_total_route_counts
Total route counters.
Definition: mfib_table.h:71
u32 mfib_table_find_or_create_and_lock(fib_protocol_t proto, u32 table_id, mfib_source_t source)
Get the index of the FIB for a Table-ID.
Definition: mfib_table.c:467
mfib_table_t * mfib_table_get(fib_node_index_t index, fib_protocol_t proto)
Get a pointer to a FIB table.
Definition: mfib_table.c:26
struct mfib_table_t_ mfib_table_t
A protocol Independent IP multicast FIB table.
fib_node_index_t mfib_table_lookup_exact_match(u32 fib_index, const mfib_prefix_t *prefix)
Perfom an exact match in the non-forwarding table.
Definition: mfib_table.c:94
enum fib_protocol_t_ fib_protocol_t
Protocol Type.
fib_node_index_t mfib_table_entry_path_update(u32 fib_index, const mfib_prefix_t *prefix, mfib_source_t source, const fib_route_path_t *rpath, mfib_itf_flags_t flags)
Add n paths to an entry (aka route) in the FIB.
Definition: mfib_table.c:219
fib_node_index_t mfib_table_lookup(u32 fib_index, const mfib_prefix_t *prefix)
Perfom a longest prefix match in the non-forwarding table.
Definition: mfib_table.c:65
void mfib_table_lock(u32 fib_index, fib_protocol_t proto, mfib_source_t source)
Release a reference counting lock on the table.
Definition: mfib_table.c:587
enum mfib_source_t_ mfib_source_t
Possible [control plane] sources of MFIB entries.
fib_node_index_t mft_index
Index into FIB vector.
Definition: mfib_table.h:66
void mfib_table_entry_delete(u32 fib_index, const mfib_prefix_t *prefix, mfib_source_t source)
Delete a FIB entry.
Definition: mfib_table.c:356
Definition: ip4.h:49
u8 * mft_desc
Table description.
Definition: mfib_table.h:76
fib_node_index_t mfib_table_entry_update(u32 fib_index, const mfib_prefix_t *prefix, mfib_source_t source, fib_rpf_id_t rpf_id, mfib_entry_flags_t flags)
Add a new (with no replication) or lock an existing entry.
Definition: mfib_table.c:165
Definition: ip6.h:76
#define MFIB_TABLE_N_LOCKS
Keep a lock per-source and a total.
Definition: mfib_table.h:28
u8 * format_mfib_table_name(u8 *s, va_list *ap)
Format the description/name of the table.
Definition: mfib_table.c:618
u32 fib_node_index_t
A typedef of a node index.
Definition: fib_types.h:29
Aggregrate type for a prefix.
Definition: mfib_types.h:24
u32 fib_rpf_id_t
An RPF-ID is numerical value that is used RPF validate.
Definition: fib_types.h:356
unsigned int u32
Definition: types.h:88
long ctx[MAX_CONNS]
Definition: main.c:122
u32 mfib_table_get_index_for_sw_if_index(fib_protocol_t proto, u32 sw_if_index)
Get the index of the FIB bound to the interface.
Definition: mfib_table.c:392
fib_protocol_t mft_proto
Which protocol this table serves.
Definition: mfib_table.h:51
u32 mft_table_id
Table ID (hash key) for this FIB.
Definition: mfib_table.h:61
void mfib_table_walk(u32 fib_index, fib_protocol_t proto, mfib_table_walk_fn_t fn, void *ctx)
Walk all entries in a FIB table N.B: This is NOT safe to deletes.
Definition: mfib_table.c:599
unsigned short u16
Definition: types.h:57
u8 * format_mfib_table_memory(u8 *s, va_list *args)
format (display) the memory usage for mfibs
Definition: mfib_table.c:632
unsigned char u8
Definition: types.h:56
enum mfib_itf_flags_t_ mfib_itf_flags_t
fib_node_index_t mfib_table_entry_special_add(u32 fib_index, const mfib_prefix_t *prefix, mfib_source_t source, mfib_entry_flags_t flags, index_t rep_dpo)
Add a &#39;special&#39; entry to the mFIB that links to the DPO passed A special entry is an entry that the F...
Definition: mfib_table.c:294
int(* mfib_table_walk_fn_t)(fib_node_index_t fei, void *ctx)
Call back function when walking entries in a FIB table.
Definition: mfib_table.h:411
ip4_mfib_t v4
Definition: mfib_table.h:44
A protocol Independent IP multicast FIB table.
Definition: mfib_table.h:35
u32 flags
Definition: vhost-user.h:77
void mfib_table_entry_delete_index(fib_node_index_t entry_index, mfib_source_t source)
Delete a FIB entry.
Definition: mfib_table.c:380
u32 mfib_table_find_or_create_and_lock_w_name(fib_protocol_t proto, u32 table_id, mfib_source_t source, const u8 *name)
Get the index of the FIB for a Table-ID.
Definition: mfib_table.c:476