2 * Copyright (c) 2018 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.
19 #include <vlib/vlib.h>
22 * The 'syatem' defined punt reasons.
23 * Only add to this list reasons defined and used within the vlib subsystem.
24 * To define new reasons in e.g. plgins, use punt_reason_alloc()
26 typedef enum vlib_punt_reason_t_
32 * Walk each punt reason
34 typedef int (*punt_reason_walk_cb_t) (vlib_punt_reason_t id, const u8 *name,
37 extern void punt_reason_walk (punt_reason_walk_cb_t cb, void *cxt);
40 * @brief Format a punt reason
42 extern u8 *format_vlib_punt_reason (u8 * s, va_list * args);
45 * @brief Unformat a punt reason
47 extern uword unformat_punt_reason (unformat_input_t *input, va_list *args);
50 * Typedef for a client handle
52 typedef int vlib_punt_hdl_t;
55 * @brief Register a new clinet
57 * @param who - The name of the client
59 * @retrun the handle the punt infra allocated for this client that must
60 * be used when the client wishes to use the infra
62 vlib_punt_hdl_t vlib_punt_client_register (const char *who);
64 typedef void (*punt_interested_listener_t) (vlib_enable_or_disable_t i,
68 * Allocate a new punt reason
69 * @param fn - A callback to invoke when an entity becomes
70 * [un]interested in the punt code.
71 * @param data - To be passed in the callback function.
72 * @param flags - flags associated with the punt reason
73 * @param flags_format - formatting function to display those flags (may be
76 extern int vlib_punt_reason_alloc (vlib_punt_hdl_t client,
77 const char *reason_name,
78 punt_interested_listener_t fn, void *data,
79 vlib_punt_reason_t *reason, u32 flags,
80 format_function_t *flags_format);
83 * Validate that a punt reason is assigned
85 extern int vlib_punt_reason_validate (vlib_punt_reason_t reason);
88 * @brief Register a node to receive particular punted buffers
90 * @paran client - The registered client registering for the packets
91 * @param reason - The reason the packet was punted
92 * @param node - The node to which the punted packets will be sent
94 extern int vlib_punt_register (vlib_punt_hdl_t client,
95 vlib_punt_reason_t reason, const char *node);
96 extern int vlib_punt_unregister (vlib_punt_hdl_t client,
97 vlib_punt_reason_t pr, const char *node);
99 extern u32 vlib_punt_reason_get_flags (vlib_punt_reason_t pr);
102 * FOR USE IN THE DP ONLY
104 * Arc[s] to follow for each reason
106 extern u16 **punt_dp_db;
109 * FOR USE IN THE DP ONLY
111 * Per-reason counters
113 extern vlib_combined_counter_main_t punt_counters;
118 * fd.io coding-style-patch-verification: ON
121 * eval: (c-set-style "gnu")