src/vlib/punt.h

   1 /*
   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:
   6  *
   7  *     http://www.apache.org/licenses/LICENSE-2.0
   8  *
   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.
  14  */
  15
  16 #ifndef __PUNT_H__
  17 #define __PUNT_H__
  18
  19 #include <vlib/vlib.h>
  20
  21 /**
  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()
  25  */
  26 typedef enum vlib_punt_reason_t_
  27 {
  28   PUNT_N_REASONS,
  29 } vlib_punt_reason_t;
  30
  31 /**
  32  * Walk each punt reason
  33  */
  34 typedef int (*punt_reason_walk_cb_t) (vlib_punt_reason_t id,
  35                                       const u8 * name, void *ctx);
  36
  37 extern void punt_reason_walk (punt_reason_walk_cb_t cb, void *cxt);
  38
  39 /**
  40  * @brief Format a punt reason
  41  */
  42 extern u8 *format_vlib_punt_reason (u8 * s, va_list * args);
  43
  44 /**
  45  * Typedef for a client handle
  46  */
  47 typedef int vlib_punt_hdl_t;
  48
  49 /**
  50  * @brief Register a new clinet
  51  *
  52  * @param who - The name of the client
  53  *
  54  * @retrun the handle the punt infra allocated for this client that must
  55  *         be used when the client wishes to use the infra
  56  */
  57 vlib_punt_hdl_t vlib_punt_client_register (const char *who);
  58
  59 /**
  60  * Allocate a new punt reason
  61  */
  62 extern int vlib_punt_reason_alloc (vlib_punt_hdl_t client,
  63                                    const char *reason_name,
  64                                    vlib_punt_reason_t * reason);
  65
  66 /**
  67  * Validate that a punt reason is assigned
  68  */
  69 extern int vlib_punt_reason_validate (vlib_punt_reason_t reason);
  70
  71 /**
  72  * @brief Register a node to receive particular punted buffers
  73  *
  74  * @paran client - The registered client registering for the packets
  75  * @param reason - The reason the packet was punted
  76  * @param node   - The node to which the punted packets will be sent
  77  */
  78 extern int vlib_punt_register (vlib_punt_hdl_t client,
  79                                vlib_punt_reason_t reason, const char *node);
  80 extern int vlib_punt_unregister (vlib_punt_hdl_t client,
  81                                  vlib_punt_reason_t pr, const char *node);
  82
  83 /**
  84  * FOR USE IN THE DP ONLY
  85  *
  86  * Arc[s] to follow for each reason
  87  */
  88 extern u16 **punt_dp_db;
  89
  90 /**
  91  * FOR USE IN THE DP ONLY
  92  *
  93  * Per-reason counters
  94  */
  95 extern vlib_combined_counter_main_t punt_counters;
  96
  97 #endif
  98
  99 /*
 100  * fd.io coding-style-patch-verification: ON
 101  *
 102  * Local Variables:
 103  * eval: (c-set-style "gnu")
 104  * End:
 105  */