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_
33 * @brief Format a punt reason
35 extern u8 *format_vlib_punt_reason (u8 * s, va_list * args);
38 * Typedef for a client handle
40 typedef int vlib_punt_hdl_t;
43 * @brief Register a new clinet
45 * @param who - The name of the client
47 * @retrun the handle the punt infra allocated for this client that must
48 * be used when the client wishes to use the infra
50 vlib_punt_hdl_t vlib_punt_client_register (const char *who);
53 * Allocate a new punt reason
55 extern int vlib_punt_reason_alloc (vlib_punt_hdl_t client,
56 const char *reason_name,
57 vlib_punt_reason_t * reason);
60 * @brief Register a node to receive particular punted buffers
62 * @paran client - The registered client registering for the packets
63 * @param reason - The reason the packet was punted
64 * @param node - The node to which the punted packets will be sent
66 extern int vlib_punt_register (vlib_punt_hdl_t client,
67 vlib_punt_reason_t reason, const char *node);
68 extern int vlib_punt_unregister (vlib_punt_hdl_t client,
69 vlib_punt_reason_t pr, const char *node);
72 * FOR USE IN THE DP ONLY
74 * Arc[s] to follow for each reason
76 extern u16 **punt_dp_db;
79 * FOR USE IN THE DP ONLY
83 extern vlib_combined_counter_main_t punt_counters;
88 * fd.io coding-style-patch-verification: ON
91 * eval: (c-set-style "gnu")