From 530bd8e1e68973c0b0f67e60c5520d32bb2628ad Mon Sep 17 00:00:00 2001 From: Pierre Pfister Date: Tue, 10 May 2016 17:11:22 +0100 Subject: VPP-69: Create fib or bridge domain with arbitrary ID It appeared to me that it might be usefull to allow users to create fibs or bridge domains without a complete knowledge of the current used IDs. These changes define fib and bridge domain constructors when the provided ID is ~0. In such a case, an unused ID is used to create a new fib or bridge domain. Change-Id: Iaba69a023296e6d17bdde45980f9db84832a3995 Signed-off-by: Pierre Pfister --- vnet/vnet/ip/ip4.h | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) (limited to 'vnet/vnet/ip/ip4.h') diff --git a/vnet/vnet/ip/ip4.h b/vnet/vnet/ip/ip4.h index 5c530b74952..b14541eb2ef 100644 --- a/vnet/vnet/ip/ip4.h +++ b/vnet/vnet/ip/ip4.h @@ -293,6 +293,28 @@ typedef struct { u32 n_add_adj; } ip4_add_del_route_args_t; +/** + * \brief Get or create an IPv4 fib. + * + * Get or create an IPv4 fib with the provided fib ID or index. + * The fib ID is a possibly-sparse user-defined value while + * the fib index defines the position of the fib in the fib vector. + * + * \param im + * ip4_main pointer. + * \param table_index_or_id + * The table index if \c IP4_ROUTE_FLAG_FIB_INDEX bit is set in \p flags. + * Otherwise, when set to \c ~0, an arbitrary and unused fib ID is picked + * and can be retrieved with \c ret->table_id. + * Otherwise, the fib ID to be used to retrieve or create the desired fib. + * \param flags + * Indicates whether \p table_index_or_id is the fib index or ID. + * When the bit \c IP4_ROUTE_FLAG_FIB_INDEX is set, \p table_index_or_id + * is considered as the fib index, and the fib ID otherwise. + * \returns A pointer to the retrieved or created fib. + * + * \remark When getting a fib with the fib index, the fib MUST already exist. + */ ip4_fib_t * find_ip4_fib_by_table_index_or_id (ip4_main_t * im, u32 table_index_or_id, u32 flags); -- cgit 1.2.3-korg