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>
40 #include <vnet/dpo/interface_dpo.h>
41 #include <vnet/dpo/mpls_disposition.h>
44 * Array of char* names for the DPO types and protos
46 static const char* dpo_type_names[] = DPO_TYPES;
47 static const char* dpo_proto_names[] = DPO_PROTOS;
50 * @brief Vector of virtual function tables for the DPO types
52 * This is a vector so we can dynamically register new DPO types in plugins.
54 static dpo_vft_t *dpo_vfts;
57 * @brief vector of graph node names associated with each DPO type and protocol.
59 * dpo_nodes[child_type][child_proto][node_X] = node_name;
61 * dpo_node[DPO_LOAD_BALANCE][DPO_PROTO_IP4][0] = "ip4-lookup"
62 * dpo_node[DPO_LOAD_BALANCE][DPO_PROTO_IP4][1] = "ip4-load-balance"
64 * This is a vector so we can dynamically register new DPO types in plugins.
66 static const char* const * const ** dpo_nodes;
69 * @brief Vector of edge indicies from parent DPO nodes to child
71 * dpo_edges[child_type][child_proto][parent_type][parent_proto] = edge_index
73 * This array is derived at init time from the dpo_nodes above. Note that
74 * the third dimension in dpo_nodes is lost, hence, the edge index from each
75 * node MUST be the same.
76 * Including both the child and parent protocol is required to support the
77 * case where it changes as the grapth is traversed, most notablly when an
78 * MPLS label is popped.
80 * Note that this array is child type specific, not child instance specific.
82 static u32 ****dpo_edges;
85 * @brief The DPO type value that can be assigend to the next dynamic
88 static dpo_type_t dpo_dynamic = DPO_LAST;
91 vnet_link_to_dpo_proto (vnet_link_t linkt)
96 return (DPO_PROTO_IP6);
98 return (DPO_PROTO_IP4);
100 return (DPO_PROTO_MPLS);
101 case VNET_LINK_ETHERNET:
102 return (DPO_PROTO_ETHERNET);
104 return (DPO_PROTO_NSH);
113 format_dpo_type (u8 * s, va_list * args)
115 dpo_type_t type = va_arg (*args, int);
117 s = format(s, "%s", dpo_type_names[type]);
123 format_dpo_id (u8 * s, va_list * args)
125 dpo_id_t *dpo = va_arg (*args, dpo_id_t*);
126 u32 indent = va_arg (*args, u32);
128 s = format(s, "[@%d]: ", dpo->dpoi_next_node);
130 if (NULL != dpo_vfts[dpo->dpoi_type].dv_format)
132 return (format(s, "%U",
133 dpo_vfts[dpo->dpoi_type].dv_format,
138 switch (dpo->dpoi_type)
141 s = format(s, "unset");
144 s = format(s, "unknown");
151 format_dpo_proto (u8 * s, va_list * args)
153 dpo_proto_t proto = va_arg (*args, int);
155 return (format(s, "%s", dpo_proto_names[proto]));
159 dpo_set (dpo_id_t *dpo,
166 dpo->dpoi_type = type;
167 dpo->dpoi_proto = proto,
168 dpo->dpoi_index = index;
170 if (DPO_ADJACENCY == type)
173 * set the adj subtype
177 adj = adj_get(index);
179 switch (adj->lookup_next_index)
181 case IP_LOOKUP_NEXT_ARP:
182 dpo->dpoi_type = DPO_ADJACENCY_INCOMPLETE;
184 case IP_LOOKUP_NEXT_MIDCHAIN:
185 dpo->dpoi_type = DPO_ADJACENCY_MIDCHAIN;
187 case IP_LOOKUP_NEXT_MCAST_MIDCHAIN:
188 dpo->dpoi_type = DPO_ADJACENCY_MCAST_MIDCHAIN;
190 case IP_LOOKUP_NEXT_MCAST:
191 dpo->dpoi_type = DPO_ADJACENCY_MCAST;
202 dpo_reset (dpo_id_t *dpo)
204 dpo_id_t tmp = DPO_INVALID;
207 * use the atomic copy operation.
214 * Compare two Data-path objects
216 * like memcmp, return 0 is matching, !0 otherwise.
219 dpo_cmp (const dpo_id_t *dpo1,
220 const dpo_id_t *dpo2)
224 res = dpo1->dpoi_type - dpo2->dpoi_type;
226 if (0 != res) return (res);
228 return (dpo1->dpoi_index - dpo2->dpoi_index);
232 dpo_copy (dpo_id_t *dst,
238 * the destination is written in a single u64 write - hence atomically w.r.t
239 * any packets inflight.
241 *((u64*)dst) = *(u64*)src;
248 dpo_is_adj (const dpo_id_t *dpo)
250 return ((dpo->dpoi_type == DPO_ADJACENCY) ||
251 (dpo->dpoi_type == DPO_ADJACENCY_INCOMPLETE) ||
252 (dpo->dpoi_type == DPO_ADJACENCY_MIDCHAIN) ||
253 (dpo->dpoi_type == DPO_ADJACENCY_GLEAN));
257 dpo_register (dpo_type_t type,
258 const dpo_vft_t *vft,
259 const char * const * const * nodes)
261 vec_validate(dpo_vfts, type);
262 dpo_vfts[type] = *vft;
264 vec_validate(dpo_nodes, type);
265 dpo_nodes[type] = nodes;
269 dpo_register_new_type (const dpo_vft_t *vft,
270 const char * const * const * nodes)
272 dpo_type_t type = dpo_dynamic++;
274 dpo_register(type, vft, nodes);
280 dpo_lock (dpo_id_t *dpo)
282 if (!dpo_id_is_valid(dpo))
285 dpo_vfts[dpo->dpoi_type].dv_lock(dpo);
289 dpo_unlock (dpo_id_t *dpo)
291 if (!dpo_id_is_valid(dpo))
294 dpo_vfts[dpo->dpoi_type].dv_unlock(dpo);
299 dpo_get_next_node (dpo_type_t child_type,
300 dpo_proto_t child_proto,
301 const dpo_id_t *parent_dpo)
303 dpo_proto_t parent_proto;
304 dpo_type_t parent_type;
306 parent_type = parent_dpo->dpoi_type;
307 parent_proto = parent_dpo->dpoi_proto;
309 vec_validate(dpo_edges, child_type);
310 vec_validate(dpo_edges[child_type], child_proto);
311 vec_validate(dpo_edges[child_type][child_proto], parent_type);
312 vec_validate_init_empty(
313 dpo_edges[child_type][child_proto][parent_type],
317 * if the edge index has not yet been created for this node to node transistion
319 if (~0 == dpo_edges[child_type][child_proto][parent_type][parent_proto])
321 vlib_node_t *parent_node, *child_node;
325 vm = vlib_get_main();
327 ASSERT(NULL != dpo_nodes[child_type]);
328 ASSERT(NULL != dpo_nodes[child_type][child_proto]);
329 ASSERT(NULL != dpo_nodes[parent_type]);
330 ASSERT(NULL != dpo_nodes[parent_type][parent_proto]);
335 * create a graph arc from each of the parent's registered node types,
336 * to each of the childs.
338 while (NULL != dpo_nodes[child_type][child_proto][cc])
341 vlib_get_node_by_name(vm,
342 (u8*) dpo_nodes[child_type][child_proto][cc]);
346 while (NULL != dpo_nodes[parent_type][parent_proto][pp])
349 vlib_get_node_by_name(vm,
350 (u8*) dpo_nodes[parent_type][parent_proto][pp]);
352 edge = vlib_node_add_next(vm,
356 if (~0 == dpo_edges[child_type][child_proto][parent_type][parent_proto])
358 dpo_edges[child_type][child_proto][parent_type][parent_proto] = edge;
362 ASSERT(dpo_edges[child_type][child_proto][parent_type][parent_proto] == edge);
370 return (dpo_edges[child_type][child_proto][parent_type][parent_proto]);
374 * @brief Stack one DPO object on another, and thus establish a child parent
375 * relationship. The VLIB graph arc used is taken from the parent and child types
379 dpo_stack_i (u32 edge,
381 const dpo_id_t *parent)
384 * in order to get an atomic update of the parent we create a temporary,
385 * from a copy of the child, and add the next_node. then we copy to the parent
387 dpo_id_t tmp = DPO_INVALID;
388 dpo_copy(&tmp, parent);
391 * get the edge index for the parent to child VLIB graph transisition
393 tmp.dpoi_next_node = edge;
396 * this update is atomic.
404 * @brief Stack one DPO object on another, and thus establish a child-parent
405 * relationship. The VLIB graph arc used is taken from the parent and child types
409 dpo_stack (dpo_type_t child_type,
410 dpo_proto_t child_proto,
412 const dpo_id_t *parent)
414 dpo_stack_i(dpo_get_next_node(child_type, child_proto, parent), dpo, parent);
418 * @brief Stack one DPO object on another, and thus establish a child parent
419 * relationship. A new VLIB graph arc is created from the child node passed
420 * to the nodes registered by the parent. The VLIB infra will ensure this arc
421 * is added only once.
424 dpo_stack_from_node (u32 child_node_index,
426 const dpo_id_t *parent)
428 dpo_proto_t parent_proto;
429 vlib_node_t *parent_node;
430 dpo_type_t parent_type;
434 parent_type = parent->dpoi_type;
435 parent_proto = parent->dpoi_proto;
437 vm = vlib_get_main();
439 ASSERT(NULL != dpo_nodes[parent_type]);
440 ASSERT(NULL != dpo_nodes[parent_type][parent_proto]);
443 vlib_get_node_by_name(vm, (u8*) dpo_nodes[parent_type][parent_proto][0]);
445 edge = vlib_node_add_next(vm,
449 dpo_stack_i(edge, dpo, parent);
452 static clib_error_t *
453 dpo_module_init (vlib_main_t * vm)
455 drop_dpo_module_init();
456 punt_dpo_module_init();
457 receive_dpo_module_init();
458 load_balance_module_init();
459 mpls_label_dpo_module_init();
460 classify_dpo_module_init();
461 lookup_dpo_module_init();
462 ip_null_dpo_module_init();
463 replicate_module_init();
464 interface_dpo_module_init();
465 mpls_disp_dpo_module_init();
470 VLIB_INIT_FUNCTION(dpo_module_init);
472 static clib_error_t *
473 dpo_memory_show (vlib_main_t * vm,
474 unformat_input_t * input,
475 vlib_cli_command_t * cmd)
479 vlib_cli_output (vm, "DPO memory");
480 vlib_cli_output (vm, "%=30s %=5s %=8s/%=9s totals",
481 "Name","Size", "in-use", "allocated");
483 vec_foreach(vft, dpo_vfts)
485 if (NULL != vft->dv_mem_show)
494 * The '<em>sh dpo memory </em>' command displays the memory usage for each
495 * data-plane object type.
498 * @cliexstart{show dpo memory}
500 * Name Size in-use /allocated totals
501 * load-balance 64 12 / 12 768/768
502 * Adjacency 256 1 / 1 256/256
503 * Receive 24 5 / 5 120/120
504 * Lookup 12 0 / 0 0/0
505 * Classify 12 0 / 0 0/0
506 * MPLS label 24 0 / 0 0/0
509 VLIB_CLI_COMMAND (show_fib_memory, static) = {
510 .path = "show dpo memory",
511 .function = dpo_memory_show,
512 .short_help = "show dpo memory",