FD.io VPP  v19.04.4-rc0-5-ge88582fac
Vector Packet Processing
fib_entry_delegate.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 __FIB_ENTRY_DELEGATE_T__
17 #define __FIB_ENTRY_DELEGATE_T__
18 
19 #include <vnet/fib/fib_node.h>
20 
21 /**
22  * Delegate types
23  */
25  /**
26  * Forwarding chain types:
27  * for the vast majority of FIB entries only one chain is required - the
28  * one that forwards traffic matching the fib_entry_t's fib_prefix_t. For those
29  * fib_entry_t that are a resolution target for other fib_entry_t's they will also
30  * need the chain to provide forwarding for those children. We store these additional
31  * chains in delegates to save memory in the common case.
32  */
39  /**
40  * Dependency list of covered entries.
41  * these are more specific entries that are interested in changes
42  * to their respective cover
43  */
45  /**
46  * BFD session state
47  */
49  /**
50  * Attached import/export functionality
51  */
55 
56 #define FOR_EACH_DELEGATE_CHAIN(_entry, _fdt, _fed, _body) \
57 { \
58  for (_fdt = FIB_ENTRY_DELEGATE_CHAIN_UNICAST_IP4; \
59  _fdt <= FIB_ENTRY_DELEGATE_CHAIN_NSH; \
60  _fdt++) \
61  { \
62  _fed = fib_entry_delegate_get(_entry, _fdt); \
63  if (NULL != _fed) { \
64  _body; \
65  } \
66  } \
67 }
68 #define FOR_EACH_DELEGATE(_entry, _fdt, _fed, _body) \
69 { \
70  for (_fdt = FIB_ENTRY_DELEGATE_CHAIN_UNICAST_IP4; \
71  _fdt <= FIB_ENTRY_DELEGATE_ATTACHED_EXPORT; \
72  _fdt++) \
73  { \
74  _fed = fib_entry_delegate_get(_entry, _fdt); \
75  if (NULL != _fed) { \
76  _body; \
77  } \
78  } \
79 }
80 
81 /**
82  * Distillation of the BFD session states into a go/no-go for using
83  * the associated tracked FIB entry
84  */
85 typedef enum fib_bfd_state_t_
86 {
90 
91 /**
92  * A Delagate is a means to implmenet the Delagation design pattern; the extension of an
93  * objects functionality through the composition of, and delgation to, other objects.
94  * These 'other' objects are delegates. Delagates are thus attached to other FIB objects
95  * to extend their functionality.
96  */
97 typedef struct fib_entry_delegate_t_
98 {
99  /**
100  * The FIB entry object to which the delagate is attached
101  */
103 
104  /**
105  * The delagate type
106  */
108 
109  /**
110  * A union of data for the different delegate types
111  * These delegates are stored in a sparse vector on the entry, so they
112  * must all be of the same size. We could use indirection here for all types,
113  * i.e. store an index, that's ok for large delegates, like the attached export
114  * but for the chain delegates it's excessive
115  */
116  union
117  {
118  /**
119  * Valid for the forwarding chain delegates. The LB that is built.
120  */
122 
123  /**
124  * Valid for the attached import cases. An index of the importer/exporter
125  */
127 
128  /**
129  * For the cover tracking. The node list;
130  */
132 
133  /**
134  * BFD state
135  */
137  };
139 
140 struct fib_entry_t_;
141 
142 extern void fib_entry_delegate_remove(struct fib_entry_t_ *fib_entry,
144 
147 extern fib_entry_delegate_t *fib_entry_delegate_get(const struct fib_entry_t_ *fib_entry,
149 
152 
155 
156 extern u8 *format_fib_entry_deletegate(u8 * s, va_list * args);
157 
158 #endif
Contribute an object that is to be used to forward IP6 packets.
Definition: fib_types.h:113
An entry in a FIB table.
Definition: fib_entry.h:462
void fib_entry_delegate_remove(struct fib_entry_t_ *fib_entry, fib_entry_delegate_type_t type)
BFD session state.
fib_forward_chain_type_t fib_entry_delegate_type_to_chain_type(fib_entry_delegate_type_t type)
fib_node_index_t fd_index
Valid for the attached import cases.
enum fib_entry_delegate_type_t_ fib_entry_delegate_type_t
Delegate types.
fib_bfd_state_t fd_bfd_state
BFD state.
Contribute an object that is to be used to forward IP4 packets.
Definition: fib_types.h:109
fib_entry_delegate_type_t_
Delegate types.
dpo_id_t fd_dpo
Valid for the forwarding chain delegates.
unsigned char u8
Definition: types.h:56
fib_node_index_t fd_entry_index
The FIB entry object to which the delagate is attached.
fib_bfd_state_t_
Distillation of the BFD session states into a go/no-go for using the associated tracked FIB entry...
Contribute an object that is to be used to forward Ethernet packets.
Definition: fib_types.h:141
fib_node_list_t fd_list
For the cover tracking.
fib_entry_delegate_type_t fd_type
The delagate type.
Attached import/export functionality.
The identity of a DPO is a combination of its type and its instance number/index of objects of that t...
Definition: dpo.h:168
Contribute an object that is to be used to forward end-of-stack MPLS packets.
Definition: fib_types.h:129
struct fib_entry_delegate_t_ fib_entry_delegate_t
A Delagate is a means to implmenet the Delagation design pattern; the extension of an objects functio...
fib_entry_delegate_t * fib_entry_delegate_find_or_add(struct fib_entry_t_ *fib_entry, fib_entry_delegate_type_t fdt)
fib_entry_delegate_t * fib_entry_delegate_get(const struct fib_entry_t_ *fib_entry, fib_entry_delegate_type_t type)
Contribute an object that is to be used to forward NSH packets.
Definition: fib_types.h:147
u32 fib_node_index_t
A typedef of a node index.
Definition: fib_types.h:30
u8 * format_fib_entry_deletegate(u8 *s, va_list *args)
Forwarding chain types: for the vast majority of FIB entries only one chain is required - the one tha...
enum fib_forward_chain_type_t_ fib_forward_chain_type_t
FIB output chain type.
fib_entry_delegate_type_t fib_entry_chain_type_to_delegate_type(fib_forward_chain_type_t type)
enum fib_bfd_state_t_ fib_bfd_state_t
Distillation of the BFD session states into a go/no-go for using the associated tracked FIB entry...
u32 fib_node_list_t
A list of FIB nodes.
Definition: fib_node.h:199
Contribute an object that is to be used to forward non-end-of-stack MPLS packets. ...
Definition: fib_types.h:118
Dependency list of covered entries.
A Delagate is a means to implmenet the Delagation design pattern; the extension of an objects functio...