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:
7 * http://www.apache.org/licenses/LICENSE-2.0
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.
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.
20 * The DPO can be considered to be like is a base class that is specialised
21 * by other objects to provide concreate actions
23 * The VLIB graph nodes are graph of DPO types, the DPO graph is a graph of
30 #include <vnet/vnet.h>
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
44 * @brief Invalid index - used when no index is known
45 * blazoned capitals INVALID speak volumes where ~0 does not.
47 #define INDEX_INVALID ((index_t)(~0))
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.
60 typedef enum dpo_proto_t_
68 } __attribute__((packed)) dpo_proto_t;
70 #define DPO_PROTO_NUM ((dpo_proto_t)(DPO_PROTO_NSH+1))
71 #define DPO_PROTO_NONE ((dpo_proto_t)(DPO_PROTO_NUM+1))
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", \
82 #define FOR_EACH_DPO_PROTO(_proto) \
83 for (_proto = DPO_PROTO_IP4; \
84 _proto <= DPO_PROTO_NSH; \
88 * @brief Common types of data-path objects
89 * New types can be dynamically added using dpo_register_new_type()
91 typedef enum dpo_type_t_ {
93 * A non-zero value first so we can spot unitialisation errors
100 * @brief load-balancing over a choice of [un]equal cost paths
105 DPO_ADJACENCY_INCOMPLETE,
106 DPO_ADJACENCY_MIDCHAIN,
109 DPO_ADJACENCY_MCAST_MIDCHAIN,
114 DPO_MPLS_DISPOSITION_PIPE,
115 DPO_MPLS_DISPOSITION_UNIFORM,
128 } __attribute__((packed)) dpo_type_t;
130 #define DPO_TYPE_NUM DPO_LAST
132 #define DPO_TYPES { \
133 [DPO_FIRST] = "dpo-invalid", \
134 [DPO_DROP] = "dpo-drop", \
135 [DPO_IP_NULL] = "dpo-ip-null", \
136 [DPO_PUNT] = "dpo-punt", \
137 [DPO_ADJACENCY] = "dpo-adjacency", \
138 [DPO_ADJACENCY_INCOMPLETE] = "dpo-adjacency-incomplete", \
139 [DPO_ADJACENCY_MIDCHAIN] = "dpo-adjacency-midcahin", \
140 [DPO_ADJACENCY_GLEAN] = "dpo-glean", \
141 [DPO_ADJACENCY_MCAST] = "dpo-adj-mcast", \
142 [DPO_ADJACENCY_MCAST_MIDCHAIN] = "dpo-adj-mcast-midchain", \
143 [DPO_RECEIVE] = "dpo-receive", \
144 [DPO_LOOKUP] = "dpo-lookup", \
145 [DPO_LOAD_BALANCE] = "dpo-load-balance", \
146 [DPO_REPLICATE] = "dpo-replicate", \
147 [DPO_LISP_CP] = "dpo-lisp-cp", \
148 [DPO_CLASSIFY] = "dpo-classify", \
149 [DPO_MPLS_DISPOSITION_PIPE] = "dpo-mpls-diposition-pipe", \
150 [DPO_MPLS_DISPOSITION_UNIFORM] = "dpo-mpls-diposition-uniform", \
151 [DPO_MFIB_ENTRY] = "dpo-mfib-entry", \
152 [DPO_INTERFACE_RX] = "dpo-interface-rx", \
153 [DPO_INTERFACE_TX] = "dpo-interface-tx", \
154 [DPO_DVR] = "dpo-dvr", \
155 [DPO_L3_PROXY] = "dpo-l3-proxy", \
156 [DPO_BIER_TABLE] = "bier-table", \
157 [DPO_BIER_FMASK] = "bier-fmask", \
158 [DPO_BIER_IMP] = "bier-imposition", \
159 [DPO_BIER_DISP_ENTRY] = "bier-disp-entry", \
160 [DPO_BIER_DISP_TABLE] = "bier-disp-table", \
161 [DPO_IP6_LL] = "ip6-link-local", \
165 * @brief The identity of a DPO is a combination of its type and its
166 * instance number/index of objects of that type
168 typedef struct dpo_id_t_ {
172 dpo_type_t dpoi_type;
174 * the data-path protocol of the type.
176 dpo_proto_t dpoi_proto;
178 * The next VLIB node to follow.
182 * the index of objects of that type
185 } __attribute__ ((aligned(sizeof(u64)))) dpo_id_t;
187 STATIC_ASSERT(sizeof(dpo_id_t) <= sizeof(u64),
188 "DPO ID is greater than sizeof u64 "
189 "atomic updates need to be revisited");
192 * @brief An initialiser for DPOs declared on the stack.
193 * Thenext node is set to 0 since VLIB graph nodes should set 0 index to drop.
195 #define DPO_INVALID \
197 .dpoi_type = DPO_FIRST, \
198 .dpoi_proto = DPO_PROTO_NONE, \
199 .dpoi_index = INDEX_INVALID, \
200 .dpoi_next_node = 0, \
204 * @brief Return true if the DPO object is valid, i.e. has been initialised.
207 dpo_id_is_valid (const dpo_id_t *dpoi)
209 return (dpoi->dpoi_type != DPO_FIRST &&
210 dpoi->dpoi_index != INDEX_INVALID);
213 extern dpo_proto_t vnet_link_to_dpo_proto(vnet_link_t linkt);
217 * Take a reference counting lock on the DPO
219 extern void dpo_lock(dpo_id_t *dpo);
223 * Release a reference counting lock on the DPO
225 extern void dpo_unlock(dpo_id_t *dpo);
229 * Make an interpose DPO from an original
231 extern void dpo_mk_interpose(const dpo_id_t *original,
232 const dpo_id_t *parent,
236 * @brief Set/create a DPO ID
237 * The DPO will be locked.
240 * The DPO object to configure
243 * The dpo_type_t of the DPO
246 * The dpo_proto_t of the DPO
249 * The type specific index of the DPO
251 extern void dpo_set(dpo_id_t *dpo,
257 * @brief reset a DPO ID
258 * The DPO will be unlocked.
261 * The DPO object to reset
263 extern void dpo_reset(dpo_id_t *dpo);
266 * @brief compare two DPOs for equality
268 extern int dpo_cmp(const dpo_id_t *dpo1,
269 const dpo_id_t *dpo2);
273 * atomic copy a data-plane object.
274 * This is safe to use when the dst DPO is currently switching packets
276 extern void dpo_copy(dpo_id_t *dst,
277 const dpo_id_t *src);
280 * @brief Return TRUE is the DPO is any type of adjacency
282 extern int dpo_is_adj(const dpo_id_t *dpo);
285 * @biref Format a DPO_id_t oject
287 extern u8 *format_dpo_id(u8 * s, va_list * args);
290 * @biref format a DPO type
292 extern u8 *format_dpo_type(u8 * s, va_list * args);
295 * @brief format a DPO protocol
297 extern u8 *format_dpo_proto(u8 * s, va_list * args);
300 * @brief format a DPO protocol
302 extern vnet_link_t dpo_proto_to_link(dpo_proto_t dp);
306 * Set and stack a DPO.
307 * The DPO passed is set to the parent DPO and the necessary
308 * VLIB graph arcs are created. The child_type and child_proto
309 * are used to get the VLID nodes from which the arcs are added.
318 * This is the DPO to stack and set.
321 * The parent DPO to stack onto.
323 extern void dpo_stack(dpo_type_t child_type,
324 dpo_proto_t child_proto,
326 const dpo_id_t *parent_dpo);
330 * Set and stack a DPO.
331 * The DPO passed is set to the parent DPO and the necessary
332 * VLIB graph arcs are created, from the child_node passed.
335 * The VLIB grpah node index to create an arc from to the parent
338 * This is the DPO to stack and set.
341 * The parent DPO to stack onto.
343 extern void dpo_stack_from_node(u32 child_node,
345 const dpo_id_t *parent);
348 * Get a uRPF interface for the DPO
351 * The DPO from which to get the uRPF interface
353 * @return valid SW interface index or ~0
355 extern u32 dpo_get_urpf(const dpo_id_t *dpo);
358 * @brief A lock function registered for a DPO type
360 typedef void (*dpo_lock_fn_t)(dpo_id_t *dpo);
363 * @brief An unlock function registered for a DPO type
365 typedef void (*dpo_unlock_fn_t)(dpo_id_t *dpo);
368 * @brief An memory usage show command
370 typedef void (*dpo_mem_show_t)(void);
373 * @brief Given a DPO instance return a vector of node indices that
374 * the type/instance will use.
376 typedef u32* (*dpo_get_next_node_t)(const dpo_id_t *dpo);
379 * @brief Given a DPO instance return an interface that can
380 * be used in an uRPF check
382 typedef u32 (*dpo_get_urpf_t)(const dpo_id_t *dpo);
385 * @brief Called during FIB interposition when the originally
386 * registered DPO is used to 'clone' an instance for interposition
387 * at a particular location in the FIB graph.
388 * The parent is the next DPO in the chain that the clone will
389 * be used instead of. The clone may then choose to stack itself
392 typedef void (*dpo_mk_interpose_t)(const dpo_id_t *original,
393 const dpo_id_t *parent,
397 * @brief A virtual function table regisitered for a DPO type
399 typedef struct dpo_vft_t_
402 * A reference counting lock function
404 dpo_lock_fn_t dv_lock;
406 * A reference counting unlock function
408 dpo_lock_fn_t dv_unlock;
412 format_function_t *dv_format;
414 * A show memory usage function
416 dpo_mem_show_t dv_mem_show;
418 * A function to get the next VLIB node given an instance
419 * of the DPO. If this is null, then the node's name MUST be
420 * retreiveable from the nodes names array passed in the register
423 dpo_get_next_node_t dv_get_next_node;
427 dpo_get_urpf_t dv_get_urpf;
429 * Signal on an interposed child that the parent has changed
431 dpo_mk_interpose_t dv_mk_interpose;
436 * @brief For a given DPO type Register:
437 * - a virtual function table
438 * - a NULL terminated array of graph nodes from which that object type
439 * will originate packets, i.e. the nodes in which the object type will be
440 * the parent DPO in the DP graph. The ndoes are per-data-path protocol
444 * The type being registered.
447 * The virtual function table to register for the type.
450 * The string description of the per-protocol VLIB graph nodes.
452 extern void dpo_register(dpo_type_t type,
453 const dpo_vft_t *vft,
454 const char * const * const * nodes);
457 * @brief Create and register a new DPO type.
459 * This can be used by plugins to create new DPO types that are not listed
463 * The virtual function table to register for the type.
466 * The string description of the per-protocol VLIB graph nodes.
468 * @return The new dpo_type_t
470 extern dpo_type_t dpo_register_new_type(const dpo_vft_t *vft,
471 const char * const * const * nodes);
474 * @brief Return already stacked up next node index for a given
475 * child_type/child_proto and parent_type/patent_proto.
476 * The VLIB graph arc used is taken from the parent and child types
488 * @param parent_proto
491 * @return The VLIB Graph node index
494 dpo_get_next_node_by_type_and_proto (dpo_type_t child_type,
495 dpo_proto_t child_proto,
496 dpo_type_t parent_type,
497 dpo_proto_t parent_proto);