FD.io VPP  v20.09-64-g4f7b92f0a
Vector Packet Processing
mfib_itf.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_ITF_H__
17 #define __MFIB_ITF_H__
18 
19 #include <vlib/vlib.h>
20 #include <vnet/mfib/mfib_types.h>
21 
22 /**
23  * @brief An interface associated with a particular MFIB entry
24  */
25 typedef struct mfib_itf_t_
26 {
27  /**
28  * Required for pool_get_aligned
29  */
30  CLIB_CACHE_LINE_ALIGN_MARK(cacheline0);
31 
32  /**
33  * @brief Forwarding Flags on the entry - checked in the data-path
34  */
36 
37  /**
38  * The SW IF index that this MFIB interface represents
39  */
41 
42  /**
43  * The index of the signal in the pending list
44  */
46 
47  /**
48  * A hash table of path-inidices that are contributing flags to this interface.
49  * Since paths with next-hops can be on the same interface and each of those
50  * paths can contribute different flags, we need to maintain the flag
51  * contribution from each path, and use a combination for forwarding.
52  */
54 } mfib_itf_t;
55 
56 /**
57  * update an interface from a path.
58  * returns 1 if the entry is removed, i.e. has no flags left, as a result
59  * of the update.
60  */
61 extern int mfib_itf_update(mfib_itf_t *itf,
62  fib_node_index_t path_index,
64 
65 extern index_t mfib_itf_create(fib_node_index_t path_index,
67 
68 extern void mfib_itf_delete(mfib_itf_t *itf);
69 
70 extern u8 *format_mfib_itf(u8 * s, va_list * args);
71 
73 
74 /**
75  * Get the MFIB interface representation
76  */
77 static inline mfib_itf_t *
79 {
80  return (pool_elt_at_index(mfib_itf_pool, mi));
81 }
82 
83 static inline index_t
85 {
86  return (mfi - mfib_itf_pool);
87 }
88 
89 #endif
index_t mfib_itf_create(fib_node_index_t path_index, mfib_itf_flags_t mfi_flags)
Definition: mfib_itf.c:25
u8 * format_mfib_itf(u8 *s, va_list *args)
Definition: mfib_itf.c:121
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
unsigned char u8
Definition: types.h:56
uword * mfi_hash
A hash table of path-inidices that are contributing flags to this interface.
Definition: mfib_itf.h:53
unsigned int u32
Definition: types.h:88
struct mfib_itf_t_ mfib_itf_t
An interface associated with a particular MFIB entry.
#define pool_elt_at_index(p, i)
Returns pointer to element at given index.
Definition: pool.h:534
static mfib_itf_t * mfib_itf_get(index_t mi)
Get the MFIB interface representation.
Definition: mfib_itf.h:78
u32 mfi_si
The index of the signal in the pending list.
Definition: mfib_itf.h:45
mfib_itf_flags_t mfi_flags
Forwarding Flags on the entry - checked in the data-path.
Definition: mfib_itf.h:35
void mfib_itf_delete(mfib_itf_t *itf)
Definition: mfib_itf.c:113
u32 fib_node_index_t
A typedef of a node index.
Definition: fib_types.h:30
CLIB_CACHE_LINE_ALIGN_MARK(cacheline0)
Required for pool_get_aligned.
An interface associated with a particular MFIB entry.
Definition: mfib_itf.h:25
u64 uword
Definition: types.h:112
enum mfib_itf_flags_t_ mfib_itf_flags_t
static index_t mfib_itf_get_index(const mfib_itf_t *mfi)
Definition: mfib_itf.h:84
u32 mfi_sw_if_index
The SW IF index that this MFIB interface represents.
Definition: mfib_itf.h:40
mfib_itf_t * mfib_itf_pool
Definition: mfib_itf.c:22
int mfib_itf_update(mfib_itf_t *itf, fib_node_index_t path_index, mfib_itf_flags_t mfi_flags)
update an interface from a path.
Definition: mfib_itf.c:66