FD.io VPP  v18.01.2-1-g9b554f3
Vector Packet Processing
dpo.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  * @brief
17  * A Data-Path Object is an object that represents actions that are
18  * applied to packets are they are switched through VPP's data-path.
19  *
20  * The DPO can be considered to be like is a base class that is specialised
21  * by other objects to provide concreate actions
22  *
23  * The VLIB graph nodes are graph of DPO types, the DPO graph is a graph of
24  * instances.
25  */
26 
27 #ifndef __DPO_H__
28 #define __DPO_H__
29 
30 #include <vnet/vnet.h>
31 
32 /**
33  * @brief An index for adjacencies.
34  * Alas 'C' is not typesafe enough to b0rk when a u32 is used instead of
35  * an index_t. However, for us humans, we can glean much more intent
36  * from the declaration
37  * foo barindex_t t);
38  * than we can from
39  * foo bar(u32 t);
40  */
41 typedef u32 index_t;
42 
43 /**
44  * @brief Invalid index - used when no index is known
45  * blazoned capitals INVALID speak volumes where ~0 does not.
46  */
47 #define INDEX_INVALID ((index_t)(~0))
48 
49 /**
50  * @brief Data path protocol.
51  * Actions performed on packets in the data-plane can be described and represented
52  * by protocol independent objects, i.e. ADJACENCY, but the spceifics actions
53  * required during ADJACENCY processing can be protocol dependent. For example,
54  * the adjacency rewrite node performs a ip4 checksum calculation, ip6 and MPLS
55  * do not, all 3 perform a TTL decrement. The VLIB graph nodes are thus protocol
56  * dependent, and thus each graph edge/arc is too.
57  * When programming a DPO's next node arc from child to parent it is thus required
58  * to know the parent's data-path protocol so the correct arc index can be used.
59  */
60 typedef enum dpo_proto_t_
61 {
68 } __attribute__((packed)) dpo_proto_t;
69 
70 #define DPO_PROTO_NUM ((dpo_proto_t)(DPO_PROTO_NSH+1))
71 #define DPO_PROTO_NONE ((dpo_proto_t)(DPO_PROTO_NUM+1))
72 
73 #define DPO_PROTOS { \
74  [DPO_PROTO_IP4] = "ip4", \
75  [DPO_PROTO_IP6] = "ip6", \
76  [DPO_PROTO_ETHERNET] = "ethernet", \
77  [DPO_PROTO_MPLS] = "mpls", \
78  [DPO_PROTO_NSH] = "nsh", \
79  [DPO_PROTO_BIER] = "bier", \
80 }
81 
82 #define FOR_EACH_DPO_PROTO(_proto) \
83  for (_proto = DPO_PROTO_IP4; \
84  _proto <= DPO_PROTO_NSH; \
85  _proto++)
86 
87 /**
88  * @brief Common types of data-path objects
89  * New types can be dynamically added using dpo_register_new_type()
90  */
91 typedef enum dpo_type_t_ {
92  /**
93  * A non-zero value first so we can spot unitialisation errors
94  */
99  /**
100  * @brief load-balancing over a choice of [un]equal cost paths
101  */
127 } __attribute__((packed)) dpo_type_t;
128 
129 #define DPO_TYPE_NUM DPO_LAST
130 
131 #define DPO_TYPES { \
132  [DPO_FIRST] = "dpo-invalid", \
133  [DPO_DROP] = "dpo-drop", \
134  [DPO_IP_NULL] = "dpo-ip-null", \
135  [DPO_PUNT] = "dpo-punt", \
136  [DPO_ADJACENCY] = "dpo-adjacency", \
137  [DPO_ADJACENCY_INCOMPLETE] = "dpo-adjacency-incomplete", \
138  [DPO_ADJACENCY_MIDCHAIN] = "dpo-adjacency-midcahin", \
139  [DPO_ADJACENCY_GLEAN] = "dpo-glean", \
140  [DPO_ADJACENCY_MCAST] = "dpo-adj-mcast", \
141  [DPO_ADJACENCY_MCAST_MIDCHAIN] = "dpo-adj-mcast-midchain", \
142  [DPO_RECEIVE] = "dpo-receive", \
143  [DPO_LOOKUP] = "dpo-lookup", \
144  [DPO_LOAD_BALANCE] = "dpo-load-balance", \
145  [DPO_REPLICATE] = "dpo-replicate", \
146  [DPO_LISP_CP] = "dpo-lisp-cp", \
147  [DPO_CLASSIFY] = "dpo-classify", \
148  [DPO_MPLS_LABEL] = "dpo-mpls-label", \
149  [DPO_MPLS_DISPOSITION] = "dpo-mpls-diposition", \
150  [DPO_MFIB_ENTRY] = "dpo-mfib_entry", \
151  [DPO_INTERFACE_RX] = "dpo-interface-rx", \
152  [DPO_INTERFACE_TX] = "dpo-interface-tx", \
153  [DPO_L2_BRIDGE] = "dpo-l2-bridge", \
154  [DPO_L3_PROXY] = "dpo-l3-proxy", \
155  [DPO_BIER_TABLE] = "bier-table", \
156  [DPO_BIER_FMASK] = "bier-fmask", \
157  [DPO_BIER_IMP] = "bier-imposition", \
158  [DPO_BIER_DISP_ENTRY] = "bier-disp-entry", \
159  [DPO_BIER_DISP_TABLE] = "bier-disp-table", \
160 }
161 
162 /**
163  * @brief The identity of a DPO is a combination of its type and its
164  * instance number/index of objects of that type
165  */
166 typedef struct dpo_id_t_ {
167  /**
168  * the type
169  */
170  dpo_type_t dpoi_type;
171  /**
172  * the data-path protocol of the type.
173  */
174  dpo_proto_t dpoi_proto;
175  /**
176  * The next VLIB node to follow.
177  */
179  /**
180  * the index of objects of that type
181  */
182  index_t dpoi_index;
183 } __attribute__ ((aligned(sizeof(u64)))) dpo_id_t;
184 
185 STATIC_ASSERT(sizeof(dpo_id_t) <= sizeof(u64),
186  "DPO ID is greater than sizeof u64 "
187  "atomic updates need to be revisited");
188 
189 /**
190  * @brief An initialiser for DPOs declared on the stack.
191  * Thenext node is set to 0 since VLIB graph nodes should set 0 index to drop.
192  */
193 #define DPO_INVALID \
194 { \
195  .dpoi_type = DPO_FIRST, \
196  .dpoi_proto = DPO_PROTO_NONE, \
197  .dpoi_index = INDEX_INVALID, \
198  .dpoi_next_node = 0, \
199 }
200 
201 /**
202  * @brief Return true if the DPO object is valid, i.e. has been initialised.
203  */
204 static inline int
205 dpo_id_is_valid (const dpo_id_t *dpoi)
206 {
207  return (dpoi->dpoi_type != DPO_FIRST &&
208  dpoi->dpoi_index != INDEX_INVALID);
209 }
210 
211 extern dpo_proto_t vnet_link_to_dpo_proto(vnet_link_t linkt);
212 
213 /**
214  * @brief
215  * Take a reference counting lock on the DPO
216  */
217 extern void dpo_lock(dpo_id_t *dpo);
218 
219 /**
220  * @brief
221  * Release a reference counting lock on the DPO
222  */
223 extern void dpo_unlock(dpo_id_t *dpo);
224 
225 /**
226  * @brief Set/create a DPO ID
227  * The DPO will be locked.
228  *
229  * @param dpo
230  * The DPO object to configure
231  *
232  * @param type
233  * The dpo_type_t of the DPO
234  *
235  * @param proto
236  * The dpo_proto_t of the DPO
237  *
238  * @param index
239  * The type specific index of the DPO
240  */
241 extern void dpo_set(dpo_id_t *dpo,
242  dpo_type_t type,
243  dpo_proto_t proto,
244  index_t index);
245 
246 /**
247  * @brief reset a DPO ID
248  * The DPO will be unlocked.
249  *
250  * @param dpo
251  * The DPO object to reset
252  */
253 extern void dpo_reset(dpo_id_t *dpo);
254 
255 /**
256  * @brief compare two DPOs for equality
257  */
258 extern int dpo_cmp(const dpo_id_t *dpo1,
259  const dpo_id_t *dpo2);
260 
261 /**
262  * @brief
263  * atomic copy a data-plane object.
264  * This is safe to use when the dst DPO is currently switching packets
265  */
266 extern void dpo_copy(dpo_id_t *dst,
267  const dpo_id_t *src);
268 
269 /**
270  * @brief Return TRUE is the DPO is any type of adjacency
271  */
272 extern int dpo_is_adj(const dpo_id_t *dpo);
273 
274 /**
275  * @biref Format a DPO_id_t oject
276  */
277 extern u8 *format_dpo_id(u8 * s, va_list * args);
278 
279 /**
280  * @biref format a DPO type
281  */
282 extern u8 *format_dpo_type(u8 * s, va_list * args);
283 
284 /**
285  * @brief format a DPO protocol
286  */
287 extern u8 *format_dpo_proto(u8 * s, va_list * args);
288 
289 /**
290  * @brief format a DPO protocol
291  */
292 extern vnet_link_t dpo_proto_to_link(dpo_proto_t dp);
293 
294 /**
295  * @brief
296  * Set and stack a DPO.
297  * The DPO passed is set to the parent DPO and the necessary
298  * VLIB graph arcs are created. The child_type and child_proto
299  * are used to get the VLID nodes from which the arcs are added.
300  *
301  * @param child_type
302  * Child DPO type.
303  *
304  * @param child_proto
305  * Child DPO proto
306  *
307  * @parem dpo
308  * This is the DPO to stack and set.
309  *
310  * @paren parent_dpo
311  * The parent DPO to stack onto.
312  */
313 extern void dpo_stack(dpo_type_t child_type,
314  dpo_proto_t child_proto,
315  dpo_id_t *dpo,
316  const dpo_id_t *parent_dpo);
317 
318 /**
319  * @brief
320  * Set and stack a DPO.
321  * The DPO passed is set to the parent DPO and the necessary
322  * VLIB graph arcs are created, from the child_node passed.
323  *
324  * @param child_node
325  * The VLIB grpah node index to create an arc from to the parent
326  *
327  * @param dpo
328  * This is the DPO to stack and set.
329  *
330  * @param parent_dpo
331  * The parent DPO to stack onto.
332  */
333 extern void dpo_stack_from_node(u32 child_node,
334  dpo_id_t *dpo,
335  const dpo_id_t *parent);
336 
337 /**
338  * Get a uRPF interface for the DPO
339  *
340  * @param dpo
341  * The DPO from which to get the uRPF interface
342  *
343  * @return valid SW interface index or ~0
344  */
345 extern u32 dpo_get_urpf(const dpo_id_t *dpo);
346 
347 /**
348  * @brief A lock function registered for a DPO type
349  */
350 typedef void (*dpo_lock_fn_t)(dpo_id_t *dpo);
351 
352 /**
353  * @brief An unlock function registered for a DPO type
354  */
355 typedef void (*dpo_unlock_fn_t)(dpo_id_t *dpo);
356 
357 /**
358  * @brief An memory usage show command
359  */
360 typedef void (*dpo_mem_show_t)(void);
361 
362 /**
363  * @brief Given a DPO instance return a vector of node indices that
364  * the type/instance will use.
365  */
366 typedef u32* (*dpo_get_next_node_t)(const dpo_id_t *dpo);
367 
368 /**
369  * @brief Given a DPO instance return an interface that can
370  * be used in an uRPF check
371  */
372 typedef u32 (*dpo_get_urpf_t)(const dpo_id_t *dpo);
373 
374 /**
375  * @brief A virtual function table regisitered for a DPO type
376  */
377 typedef struct dpo_vft_t_
378 {
379  /**
380  * A reference counting lock function
381  */
383  /**
384  * A reference counting unlock function
385  */
387  /**
388  * A format function
389  */
391  /**
392  * A show memory usage function
393  */
395  /**
396  * A function to get the next VLIB node given an instance
397  * of the DPO. If this is null, then the node's name MUST be
398  * retreiveable from the nodes names array passed in the register
399  * function
400  */
402  /**
403  * Get uRPF interface
404  */
406 } dpo_vft_t;
407 
408 
409 /**
410  * @brief For a given DPO type Register:
411  * - a virtual function table
412  * - a NULL terminated array of graph nodes from which that object type
413  * will originate packets, i.e. the nodes in which the object type will be
414  * the parent DPO in the DP graph. The ndoes are per-data-path protocol
415  * (see above).
416  *
417  * @param type
418  * The type being registered.
419  *
420  * @param vft
421  * The virtual function table to register for the type.
422  *
423  * @param nodes
424  * The string description of the per-protocol VLIB graph nodes.
425  */
426 extern void dpo_register(dpo_type_t type,
427  const dpo_vft_t *vft,
428  const char * const * const * nodes);
429 
430 /**
431  * @brief Create and register a new DPO type.
432  *
433  * This can be used by plugins to create new DPO types that are not listed
434  * in dpo_type_t enum
435  *
436  * @param vft
437  * The virtual function table to register for the type.
438  *
439  * @param nodes
440  * The string description of the per-protocol VLIB graph nodes.
441  *
442  * @return The new dpo_type_t
443  */
444 extern dpo_type_t dpo_register_new_type(const dpo_vft_t *vft,
445  const char * const * const * nodes);
446 
447 #endif
dpo_lock_fn_t dv_lock
A reference counting lock function.
Definition: dpo.h:382
Definition: dpo.h:98
void(* dpo_lock_fn_t)(dpo_id_t *dpo)
A lock function registered for a DPO type.
Definition: dpo.h:350
A virtual function table regisitered for a DPO type.
Definition: dpo.h:377
dpo_proto_t_
Data path protocol.
Definition: dpo.h:60
static int dpo_id_is_valid(const dpo_id_t *dpoi)
Return true if the DPO object is valid, i.e.
Definition: dpo.h:205
dpo_get_urpf_t dv_get_urpf
Get uRPF interface.
Definition: dpo.h:405
dpo_proto_t dpoi_proto
the data-path protocol of the type.
Definition: dpo.h:174
u32 *(* dpo_get_next_node_t)(const dpo_id_t *dpo)
Given a DPO instance return a vector of node indices that the type/instance will use.
Definition: dpo.h:366
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
dpo_type_t_
Common types of data-path objects New types can be dynamically added using dpo_register_new_type() ...
Definition: dpo.h:91
u8 *( format_function_t)(u8 *s, va_list *args)
Definition: format.h:48
u32(* dpo_get_urpf_t)(const dpo_id_t *dpo)
Given a DPO instance return an interface that can be used in an uRPF check.
Definition: dpo.h:372
void dpo_unlock(dpo_id_t *dpo)
Release a reference counting lock on the DPO.
Definition: dpo.c:342
STATIC_ASSERT(sizeof(dpo_id_t)<=sizeof(u64),"DPO ID is greater than sizeof u64 ""atomic updates need to be revisited")
u8 * format_dpo_proto(u8 *s, va_list *args)
format a DPO protocol
Definition: dpo.c:174
u8 * format_dpo_id(u8 *s, va_list *args)
Format a DPO_id_t oject
Definition: dpo.c:146
dpo_get_next_node_t dv_get_next_node
A function to get the next VLIB node given an instance of the DPO.
Definition: dpo.h:401
u32 dpo_get_urpf(const dpo_id_t *dpo)
Get a uRPF interface for the DPO.
Definition: dpo.c:351
void dpo_set(dpo_id_t *dpo, dpo_type_t type, dpo_proto_t proto, index_t index)
Set/create a DPO ID The DPO will be locked.
Definition: dpo.c:182
The identity of a DPO is a combination of its type and its instance number/index of objects of that t...
Definition: dpo.h:166
void dpo_stack(dpo_type_t child_type, dpo_proto_t child_proto, dpo_id_t *dpo, const dpo_id_t *parent_dpo)
Set and stack a DPO.
Definition: dpo.c:470
void(* dpo_mem_show_t)(void)
An memory usage show command.
Definition: dpo.h:360
Definition: dpo.h:126
dpo_type_t dpoi_type
the type
Definition: dpo.h:170
vnet_link_t dpo_proto_to_link(dpo_proto_t dp)
format a DPO protocol
Definition: dpo.c:116
load-balancing over a choice of [un]equal cost paths
Definition: dpo.h:102
void dpo_reset(dpo_id_t *dpo)
reset a DPO ID The DPO will be unlocked.
Definition: dpo.c:228
int dpo_cmp(const dpo_id_t *dpo1, const dpo_id_t *dpo2)
compare two DPOs for equality
Definition: dpo.c:245
void dpo_register(dpo_type_t type, const dpo_vft_t *vft, const char *const *const *nodes)
For a given DPO type Register:
Definition: dpo.c:306
void dpo_copy(dpo_id_t *dst, const dpo_id_t *src)
atomic copy a data-plane object.
Definition: dpo.c:258
u8 * format_dpo_type(u8 *s, va_list *args)
format a DPO type
Definition: dpo.c:136
int dpo_is_adj(const dpo_id_t *dpo)
Return TRUE is the DPO is any type of adjacency.
Definition: dpo.c:274
unsigned int u32
Definition: types.h:88
enum vnet_link_t_ vnet_link_t
Link Type: A description of the protocol of packets on the link.
A non-zero value first so we can spot unitialisation errors.
Definition: dpo.h:95
void dpo_lock(dpo_id_t *dpo)
Take a reference counting lock on the DPO.
Definition: dpo.c:333
void(* dpo_unlock_fn_t)(dpo_id_t *dpo)
An unlock function registered for a DPO type.
Definition: dpo.h:355
dpo_mem_show_t dv_mem_show
A show memory usage function.
Definition: dpo.h:394
unsigned short u16
Definition: types.h:57
dpo_type_t dpo_register_new_type(const dpo_vft_t *vft, const char *const *const *nodes)
Create and register a new DPO type.
Definition: dpo.c:322
index_t dpoi_index
the index of objects of that type
Definition: dpo.h:182
format_function_t * dv_format
A format function.
Definition: dpo.h:390
unsigned char u8
Definition: types.h:56
#define INDEX_INVALID
Invalid index - used when no index is known blazoned capitals INVALID speak volumes where ~0 does not...
Definition: dpo.h:47
dpo_lock_fn_t dv_unlock
A reference counting unlock function.
Definition: dpo.h:386
void dpo_stack_from_node(u32 child_node, dpo_id_t *dpo, const dpo_id_t *parent)
Set and stack a DPO.
Definition: dpo.c:485
dpo_proto_t vnet_link_to_dpo_proto(vnet_link_t linkt)
Definition: dpo.c:94
u16 dpoi_next_node
The next VLIB node to follow.
Definition: dpo.h:178
Definition: dpo.h:96
struct dpo_vft_t_ dpo_vft_t
A virtual function table regisitered for a DPO type.