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.
20 * The DPO is a base class that is specialised by other objects to provide
23 * The VLIB graph nodes are graph of types, the DPO graph is a graph of instances.
26 #include <vnet/dpo/dpo.h>
27 #include <vnet/ip/lookup.h>
28 #include <vnet/ip/format.h>
29 #include <vnet/adj/adj.h>
31 #include <vnet/dpo/load_balance.h>
32 #include <vnet/dpo/mpls_label_dpo.h>
33 #include <vnet/dpo/lookup_dpo.h>
34 #include <vnet/dpo/drop_dpo.h>
35 #include <vnet/dpo/receive_dpo.h>
36 #include <vnet/dpo/punt_dpo.h>
37 #include <vnet/dpo/classify_dpo.h>
38 #include <vnet/dpo/ip_null_dpo.h>
39 #include <vnet/dpo/replicate_dpo.h>
42 * Array of char* names for the DPO types and protos
44 static const char* dpo_type_names[] = DPO_TYPES;
45 static const char* dpo_proto_names[] = DPO_PROTOS;
48 * @brief Vector of virtual function tables for the DPO types
50 * This is a vector so we can dynamically register new DPO types in plugins.
52 static dpo_vft_t *dpo_vfts;
55 * @brief vector of graph node names associated with each DPO type and protocol.
57 * dpo_nodes[child_type][child_proto][node_X] = node_name;
59 * dpo_node[DPO_LOAD_BALANCE][DPO_PROTO_IP4][0] = "ip4-lookup"
60 * dpo_node[DPO_LOAD_BALANCE][DPO_PROTO_IP4][1] = "ip4-load-balance"
62 * This is a vector so we can dynamically register new DPO types in plugins.
64 static const char* const * const ** dpo_nodes;
67 * @brief Vector of edge indicies from parent DPO nodes to child
69 * dpo_edges[child_type][child_proto][parent_type][parent_proto] = edge_index
71 * This array is derived at init time from the dpo_nodes above. Note that
72 * the third dimension in dpo_nodes is lost, hence, the edge index from each
73 * node MUST be the same.
74 * Including both the child and parent protocol is required to support the
75 * case where it changes as the grapth is traversed, most notablly when an
76 * MPLS label is popped.
78 * Note that this array is child type specific, not child instance specific.
80 static u32 ****dpo_edges;
83 * @brief The DPO type value that can be assigend to the next dynamic
86 static dpo_type_t dpo_dynamic = DPO_LAST;
89 vnet_link_to_dpo_proto (vnet_link_t linkt)
94 return (DPO_PROTO_IP6);
96 return (DPO_PROTO_IP4);
98 return (DPO_PROTO_MPLS);
99 case VNET_LINK_ETHERNET:
100 return (DPO_PROTO_ETHERNET);
109 format_dpo_type (u8 * s, va_list * args)
111 dpo_type_t type = va_arg (*args, int);
113 s = format(s, "%s", dpo_type_names[type]);
119 format_dpo_id (u8 * s, va_list * args)
121 dpo_id_t *dpo = va_arg (*args, dpo_id_t*);
122 u32 indent = va_arg (*args, u32);
124 s = format(s, "[@%d]: ", dpo->dpoi_next_node);
126 if (NULL != dpo_vfts[dpo->dpoi_type].dv_format)
128 return (format(s, "%U",
129 dpo_vfts[dpo->dpoi_type].dv_format,
134 switch (dpo->dpoi_type)
137 s = format(s, "unset");
140 s = format(s, "unknown");
147 format_dpo_proto (u8 * s, va_list * args)
149 dpo_proto_t proto = va_arg (*args, int);
151 return (format(s, "%s", dpo_proto_names[proto]));
155 dpo_set (dpo_id_t *dpo,
162 dpo->dpoi_type = type;
163 dpo->dpoi_proto = proto,
164 dpo->dpoi_index = index;
166 if (DPO_ADJACENCY == type)
169 * set the adj subtype
173 adj = adj_get(index);
175 switch (adj->lookup_next_index)
177 case IP_LOOKUP_NEXT_ARP:
178 dpo->dpoi_type = DPO_ADJACENCY_INCOMPLETE;
180 case IP_LOOKUP_NEXT_MIDCHAIN:
181 dpo->dpoi_type = DPO_ADJACENCY_MIDCHAIN;
192 dpo_reset (dpo_id_t *dpo)
194 dpo_id_t tmp = DPO_INVALID;
197 * use the atomic copy operation.
204 * Compare two Data-path objects
206 * like memcmp, return 0 is matching, !0 otherwise.
209 dpo_cmp (const dpo_id_t *dpo1,
210 const dpo_id_t *dpo2)
214 res = dpo1->dpoi_type - dpo2->dpoi_type;
216 if (0 != res) return (res);
218 return (dpo1->dpoi_index - dpo2->dpoi_index);
222 dpo_copy (dpo_id_t *dst,
228 * the destination is written in a single u64 write - hence atomically w.r.t
229 * any packets inflight.
231 *((u64*)dst) = *(u64*)src;
238 dpo_is_adj (const dpo_id_t *dpo)
240 return ((dpo->dpoi_type == DPO_ADJACENCY) ||
241 (dpo->dpoi_type == DPO_ADJACENCY_INCOMPLETE) ||
242 (dpo->dpoi_type == DPO_ADJACENCY_MIDCHAIN) ||
243 (dpo->dpoi_type == DPO_ADJACENCY_GLEAN));
247 dpo_register (dpo_type_t type,
248 const dpo_vft_t *vft,
249 const char * const * const * nodes)
251 vec_validate(dpo_vfts, type);
252 dpo_vfts[type] = *vft;
254 vec_validate(dpo_nodes, type);
255 dpo_nodes[type] = nodes;
259 dpo_register_new_type (const dpo_vft_t *vft,
260 const char * const * const * nodes)
262 dpo_type_t type = dpo_dynamic++;
264 dpo_register(type, vft, nodes);
270 dpo_lock (dpo_id_t *dpo)
272 if (!dpo_id_is_valid(dpo))
275 dpo_vfts[dpo->dpoi_type].dv_lock(dpo);
279 dpo_unlock (dpo_id_t *dpo)
281 if (!dpo_id_is_valid(dpo))
284 dpo_vfts[dpo->dpoi_type].dv_unlock(dpo);
289 dpo_get_next_node (dpo_type_t child_type,
290 dpo_proto_t child_proto,
291 const dpo_id_t *parent_dpo)
293 dpo_proto_t parent_proto;
294 dpo_type_t parent_type;
296 parent_type = parent_dpo->dpoi_type;
297 parent_proto = parent_dpo->dpoi_proto;
299 vec_validate(dpo_edges, child_type);
300 vec_validate(dpo_edges[child_type], child_proto);
301 vec_validate(dpo_edges[child_type][child_proto], parent_type);
302 vec_validate_init_empty(
303 dpo_edges[child_type][child_proto][parent_type],
307 * if the edge index has not yet been created for this node to node transistion
309 if (~0 == dpo_edges[child_type][child_proto][parent_type][parent_proto])
311 vlib_node_t *parent_node, *child_node;
315 vm = vlib_get_main();
317 ASSERT(NULL != dpo_nodes[child_type]);
318 ASSERT(NULL != dpo_nodes[child_type][child_proto]);
319 ASSERT(NULL != dpo_nodes[parent_type]);
320 ASSERT(NULL != dpo_nodes[parent_type][parent_proto]);
325 * create a graph arc from each of the parent's registered node types,
326 * to each of the childs.
328 while (NULL != dpo_nodes[child_type][child_proto][cc])
331 vlib_get_node_by_name(vm,
332 (u8*) dpo_nodes[child_type][child_proto][cc]);
336 while (NULL != dpo_nodes[parent_type][parent_proto][pp])
339 vlib_get_node_by_name(vm,
340 (u8*) dpo_nodes[parent_type][parent_proto][pp]);
342 edge = vlib_node_add_next(vm,
346 if (~0 == dpo_edges[child_type][child_proto][parent_type][parent_proto])
348 dpo_edges[child_type][child_proto][parent_type][parent_proto] = edge;
352 ASSERT(dpo_edges[child_type][child_proto][parent_type][parent_proto] == edge);
360 return (dpo_edges[child_type][child_proto][parent_type][parent_proto]);
364 * @brief Stack one DPO object on another, and thus establish a child parent
365 * relationship. The VLIB graph arc used is taken from the parent and child types
369 dpo_stack_i (u32 edge,
371 const dpo_id_t *parent)
374 * in order to get an atomic update of the parent we create a temporary,
375 * from a copy of the child, and add the next_node. then we copy to the parent
377 dpo_id_t tmp = DPO_INVALID;
378 dpo_copy(&tmp, parent);
381 * get the edge index for the parent to child VLIB graph transisition
383 tmp.dpoi_next_node = edge;
386 * this update is atomic.
394 * @brief Stack one DPO object on another, and thus establish a child-parent
395 * relationship. The VLIB graph arc used is taken from the parent and child types
399 dpo_stack (dpo_type_t child_type,
400 dpo_proto_t child_proto,
402 const dpo_id_t *parent)
404 dpo_stack_i(dpo_get_next_node(child_type, child_proto, parent), dpo, parent);
408 * @brief Stack one DPO object on another, and thus establish a child parent
409 * relationship. A new VLIB graph arc is created from the child node passed
410 * to the nodes registered by the parent. The VLIB infra will ensure this arc
411 * is added only once.
414 dpo_stack_from_node (u32 child_node_index,
416 const dpo_id_t *parent)
418 dpo_proto_t parent_proto;
419 vlib_node_t *parent_node;
420 dpo_type_t parent_type;
424 parent_type = parent->dpoi_type;
425 parent_proto = parent->dpoi_proto;
427 vm = vlib_get_main();
429 ASSERT(NULL != dpo_nodes[parent_type]);
430 ASSERT(NULL != dpo_nodes[parent_type][parent_proto]);
433 vlib_get_node_by_name(vm, (u8*) dpo_nodes[parent_type][parent_proto][0]);
435 edge = vlib_node_add_next(vm,
439 dpo_stack_i(edge, dpo, parent);
442 static clib_error_t *
443 dpo_module_init (vlib_main_t * vm)
445 drop_dpo_module_init();
446 punt_dpo_module_init();
447 receive_dpo_module_init();
448 load_balance_module_init();
449 mpls_label_dpo_module_init();
450 classify_dpo_module_init();
451 lookup_dpo_module_init();
452 ip_null_dpo_module_init();
453 replicate_module_init();
458 VLIB_INIT_FUNCTION(dpo_module_init);
460 static clib_error_t *
461 dpo_memory_show (vlib_main_t * vm,
462 unformat_input_t * input,
463 vlib_cli_command_t * cmd)
467 vlib_cli_output (vm, "DPO memory");
468 vlib_cli_output (vm, "%=30s %=5s %=8s/%=9s totals",
469 "Name","Size", "in-use", "allocated");
471 vec_foreach(vft, dpo_vfts)
473 if (NULL != vft->dv_mem_show)
482 * The '<em>sh dpo memory </em>' command displays the memory usage for each
483 * data-plane object type.
486 * @cliexstart{show dpo memory}
488 * Name Size in-use /allocated totals
489 * load-balance 64 12 / 12 768/768
490 * Adjacency 256 1 / 1 256/256
491 * Receive 24 5 / 5 120/120
492 * Lookup 12 0 / 0 0/0
493 * Classify 12 0 / 0 0/0
494 * MPLS label 24 0 / 0 0/0
497 VLIB_CLI_COMMAND (show_fib_memory, static) = {
498 .path = "show dpo memory",
499 .function = dpo_memory_show,
500 .short_help = "show dpo memory",