FD.io VPP  v21.06-3-gbb25fbf28
Vector Packet Processing
api_common.h
Go to the documentation of this file.
1 /*
2  *------------------------------------------------------------------
3  * api_common.h
4  *
5  * Copyright (c) 2009-2015 Cisco and/or its affiliates.
6  * Licensed under the Apache License, Version 2.0 (the "License");
7  * you may not use this file except in compliance with the License.
8  * You may obtain a copy of the License at:
9  *
10  * http://www.apache.org/licenses/LICENSE-2.0
11  *
12  * Unless required by applicable law or agreed to in writing, software
13  * distributed under the License is distributed on an "AS IS" BASIS,
14  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15  * See the License for the specific language governing permissions and
16  * limitations under the License.
17  *------------------------------------------------------------------
18  */
19 
20 #ifndef included_api_common_h
21 #define included_api_common_h
22 
23 /** \file api_common.h
24  * API common definitions
25  * See api_doc.md for more info
26  */
27 
28 #include <vppinfra/clib_error.h>
29 #include <vppinfra/elog.h>
30 #include <vlibapi/api_types.h>
31 #include <svm/svm_common.h>
32 #include <svm/queue.h>
33 
34 /** API registration types
35  */
36 typedef enum
37 {
39  REGISTRATION_TYPE_SHMEM, /**< Shared memory connection */
40  REGISTRATION_TYPE_SOCKET_LISTEN, /**< Socket listener */
41  REGISTRATION_TYPE_SOCKET_SERVER, /**< Socket server */
42  REGISTRATION_TYPE_SOCKET_CLIENT, /**< Socket client */
44 
45 /** An API client registration, only in vpp/vlib */
46 
47 typedef struct vl_api_registration_
48 {
50 
51  /** Index in VLIB's brain (not shared memory). */
53 
54  u8 *name; /**< Client name */
55 
56  /* Zombie apocalypse checking */
61 
62  /** shared memory only: pointer to client input queue */
65  void *shmem_hdr;
66 
67  /* socket server and client */
68  u32 clib_file_index; /**< Socket only: file index */
69  i8 *unprocessed_input; /**< Socket only: pending input */
70  u32 unprocessed_msg_length; /**< Socket only: unprocssed length */
71  u8 *output_vector; /**< Socket only: output vector */
73 
74  /* socket client only */
75  u32 server_handle; /**< Socket client only: server handle */
76  u32 server_index; /**< Socket client only: server index */
78 
79 #define VL_API_INVALID_FI ((u32)~0)
80 
81 /** Trace configuration for a single message */
82 typedef struct
83 {
84  int size; /**< for sanity checking */
85  int trace_enable; /**< trace this message */
86  int replay_enable; /**< This message can be replayed */
87 } trace_cfg_t;
88 
89 /**
90  * API trace state
91  */
92 typedef struct
93 {
94  u8 endian; /**< trace endianness */
95  u8 enabled; /**< trace is enabled */
96  u8 wrapped; /**< trace has wrapped */
98  u32 nitems; /**< Number of trace records */
99  u32 curindex; /**< Current index in circular buffer */
100  u8 **traces; /**< Trace ring */
102 
103 /** Trace RX / TX enum */
104 typedef enum
105 {
109 
110 #define VL_API_LITTLE_ENDIAN 0x00
111 #define VL_API_BIG_ENDIAN 0x01
112 
113 /** Message range (belonging to a plugin) */
114 typedef struct
115 {
116  u8 *name; /**< name of the plugin */
117  u16 first_msg_id; /**< first assigned message ID */
118  u16 last_msg_id; /**< last assigned message ID */
120 
121 /** Message configuration definition */
122 typedef struct
123 {
124  int id; /**< the message ID */
125  char *name; /**< the message name */
126  u32 crc; /**< message definition CRC */
127  void *handler; /**< the message handler */
128  void *cleanup; /**< non-default message cleanup handler */
129  void *endian; /**< message endian function */
130  void *print; /**< message print function */
131  int size; /**< message size */
132  int traced; /**< is this message to be traced? */
133  int replay; /**< is this message to be replayed? */
134  int message_bounce; /**< do not free message after processing */
135  int is_mp_safe; /**< worker thread barrier required? */
136  int is_autoendian; /**< endian conversion required? */
138 
139 /** Message header structure */
140 typedef struct msgbuf_
141 {
142  svm_queue_t *q; /**< message allocated in this shmem ring */
143  u32 data_len; /**< message length not including header */
144  u32 gc_mark_timestamp; /**< message garbage collector mark TS */
145  u8 data[0]; /**< actual message begins here */
146 } msgbuf_t;
147 
148 CLIB_NOSANITIZE_ADDR static inline void
149 VL_MSG_API_UNPOISON (const void *a)
150 {
151  const msgbuf_t *m = &((const msgbuf_t *) a)[-1];
152  CLIB_MEM_UNPOISON (m, sizeof (*m) + ntohl (m->data_len));
153 }
154 
155 CLIB_NOSANITIZE_ADDR static inline void
157 {
158  CLIB_MEM_UNPOISON (q, sizeof (*q) + q->elsize * q->maxsize);
159 }
160 
161 static inline void
162 VL_MSG_API_POISON (const void *a)
163 {
164  const msgbuf_t *m = &((const msgbuf_t *) a)[-1];
165  CLIB_MEM_POISON (m, sizeof (*m) + ntohl (m->data_len));
166 }
167 
168 /* api_shared.c prototypes */
169 void vl_msg_api_handler (void *the_msg);
170 void vl_msg_api_handler_no_free (void *the_msg);
171 void vl_msg_api_handler_no_trace_no_free (void *the_msg);
172 void vl_msg_api_trace_only (void *the_msg);
173 void vl_msg_api_cleanup_handler (void *the_msg);
174 void vl_msg_api_replay_handler (void *the_msg);
175 void vl_msg_api_socket_handler (void *the_msg);
176 void vl_msg_api_set_handlers (int msg_id, char *msg_name,
177  void *handler,
178  void *cleanup,
179  void *endian,
180  void *print, int msg_size, int traced);
181 void vl_msg_api_clean_handlers (int msg_id);
183 void vl_msg_api_set_cleanup_handler (int msg_id, void *fp);
185 
186 void vl_msg_api_barrier_sync (void) __attribute__ ((weak));
187 void vl_msg_api_barrier_release (void) __attribute__ ((weak));
188 #ifdef BARRIER_TRACING
189 void vl_msg_api_barrier_trace_context (const char *context)
190  __attribute__ ((weak));
191 #else
192 #define vl_msg_api_barrier_trace_context(X)
193 #endif
194 void vl_msg_api_free (void *);
195 void vl_noop_handler (void *mp);
197 void vl_msg_api_post_mortem_dump (void);
199 void vl_msg_api_register_pd_handler (void *handler,
200  u16 msg_id_host_byte_order);
201 int vl_msg_api_pd_handler (void *mp, int rv);
202 
203 void vl_msg_api_set_first_available_msg_id (u16 first_avail);
204 u16 vl_msg_api_get_msg_ids (const char *name, int n);
205 u32 vl_msg_api_get_msg_index (u8 * name_and_crc);
206 void *vl_msg_push_heap (void);
207 void *vl_msg_push_heap_w_region (svm_region_t * vlib_rp);
208 void vl_msg_pop_heap (void *oldheap);
209 void vl_msg_pop_heap_w_region (svm_region_t * vlib_rp, void *oldheap);
210 
211 typedef clib_error_t *(vl_msg_api_init_function_t) (u32 client_index);
212 
213 typedef struct _vl_msg_api_init_function_list_elt
214 {
215  struct _vl_msg_api_init_function_list_elt *next_init_function;
217 } _vl_msg_api_function_list_elt_t;
218 
219 typedef struct
220 {
224  char name[64];
225 } api_version_t;
226 
227 /** API main structure, used by both vpp and binary API clients */
228 typedef struct api_main_t
229 {
230  /** Message handler vector */
231  void (**msg_handlers) (void *);
232  /** Plaform-dependent (aka hardware) message handler vector */
233  int (**pd_msg_handlers) (void *, int);
234 
235  /** non-default message cleanup handler vector */
236  void (**msg_cleanup_handlers) (void *);
237 
238  /** Message endian handler vector */
239  void (**msg_endian_handlers) (void *);
240 
241  /** Message print function vector */
242  void (**msg_print_handlers) (void *, void *);
243 
244  /** Message name vector */
245  const char **msg_names;
246 
247  /** Don't automatically free message buffer vetor */
249 
250  /** Message is mp safe vector */
252 
253  /** Message requires us to do endian conversion */
255 
256  /** Allocator ring vectors (in shared memory) */
258 
259  /** Number of times that the ring allocator failed */
261 
262  /** Number of garbage-collected message buffers */
264 
265  /** Number of missing clients / failed message sends */
267 
268  /** Received message trace configuration */
270 
271  /** Sent message trace configuration */
273 
274  /** Print every received message */
276 
277  /** Current trace configuration */
279 
280  /** Current process PID */
281  int our_pid;
282 
283  /** Current binary api segment descriptor */
285 
286  /** Primary api segment descriptor */
288 
289  /** Vector of all mapped shared-VM segments */
292 
293  /** Binary API shared-memory segment header pointer */
295 
296  /** vlib/vpp only: vector of client registrations */
298 
299  /** vlib/vpp only: serialized (message, name, crc) table */
301 
302  /** First available message ID, for theplugin msg allocator */
304 
305  /** Message range by name hash */
307 
308  /** vector of message ranges */
310 
311  /** uid for the api shared memory region */
312  int api_uid;
313 
314  /** gid for the api shared memory region */
315  int api_gid;
316 
317  /** base virtual address for global VM region */
319 
320  /** size of the global VM region */
322 
323  /** size of the API region */
325 
326  /** size of the global VM private mheap */
328 
329  /** size of the api private mheap */
331 
332  /** Peer input queue pointer */
334 
335  /**
336  * All VLIB-side message handlers use my_client_index to identify
337  * the queue / client. This works in sim replay.
338  */
340  /**
341  * This is the (shared VM) address of the registration,
342  * don't use it to id the connection since it can't possibly
343  * work in simulator replay.
344  */
346 
347  /** vpp/vlib input queue length */
349 
350  /** client message index hash table */
352 
353  /** api version list */
355 
356  /** Shared VM binary API region name */
357  const char *region_name;
358 
359  /** Chroot path to the shared memory API files */
360  const char *root_path;
361 
362  /** Replay in progress? */
364 
365  /** Dump (msg-name, crc) snapshot here at startup */
367 
368  /** List of API client reaper functions */
369  _vl_msg_api_function_list_elt_t *reaper_function_registrations;
370 
371  /** Bin API thread handle */
372  pthread_t rx_thread_handle;
373 
374  /** event log */
377 
378  /** performance counter callback **/
379  void (**perf_counter_cbs)
380  (struct api_main_t *, u32 id, int before_or_after);
381  void (**perf_counter_cbs_tmp)
382  (struct api_main_t *, u32 id, int before_or_after);
383 
384 } api_main_t;
385 
386 extern __thread api_main_t *my_api_main;
388 
391 {
392  return my_api_main;
393 }
394 
395 always_inline void
397 {
398  my_api_main = am;
399 }
400 
401 #endif /* included_api_common_h */
402 
403 /*
404  * fd.io coding-style-patch-verification: ON
405  *
406  * Local Variables:
407  * eval: (c-set-style "gnu")
408  * End:
409  */
api_main_t::replay_in_progress
int replay_in_progress
Replay in progress?
Definition: api_common.h:363
vl_msg_api_barrier_release
void vl_msg_api_barrier_release(void)
Definition: api_shared.c:432
msgbuf_::q
svm_queue_t * q
message allocated in this shmem ring
Definition: api_common.h:142
api_main_t::global_size
u64 global_size
size of the global VM region
Definition: api_common.h:321
msgbuf_t
struct msgbuf_ msgbuf_t
Message header structure.
api_main_t::root_path
const char * root_path
Chroot path to the shared memory API files.
Definition: api_common.h:360
api_main_t::rx_thread_handle
pthread_t rx_thread_handle
Bin API thread handle.
Definition: api_common.h:372
vl_msg_api_msg_config_t::traced
int traced
is this message to be traced?
Definition: api_common.h:132
vl_msg_api_queue_handler
void vl_msg_api_queue_handler(svm_queue_t *q)
Definition: api_shared.c:917
vl_msg_api_msg_config_t::crc
u32 crc
message definition CRC
Definition: api_common.h:126
vl_msg_api_msg_config_t::cleanup
void * cleanup
non-default message cleanup handler
Definition: api_common.h:128
vl_api_msg_range_t::name
u8 * name
name of the plugin
Definition: api_common.h:116
elog.h
api_main_t::global_baseva
u64 global_baseva
base virtual address for global VM region
Definition: api_common.h:318
vl_msg_api_msg_config_t::name
char * name
the message name
Definition: api_common.h:125
CLIB_MEM_POISON
#define CLIB_MEM_POISON(a, s)
Definition: sanitizer.h:46
f
vlib_frame_t * f
Definition: interface_output.c:1080
vl_api_registration_::is_being_removed
int is_being_removed
Definition: api_common.h:60
REGISTRATION_TYPE_SOCKET_CLIENT
@ REGISTRATION_TYPE_SOCKET_CLIENT
Socket client.
Definition: api_common.h:42
name
string name[64]
Definition: fib.api:25
vl_registration_type_t
vl_registration_type_t
API registration types.
Definition: api_common.h:36
api_types.h
REGISTRATION_TYPE_SOCKET_LISTEN
@ REGISTRATION_TYPE_SOCKET_LISTEN
Socket listener
Definition: api_common.h:40
api_main_t::vlib_private_rps
svm_region_t ** vlib_private_rps
Vector of all mapped shared-VM segments.
Definition: api_common.h:290
vl_msg_api_socket_handler
void vl_msg_api_socket_handler(void *the_msg)
Definition: api_shared.c:800
trace_cfg_t::size
int size
for sanity checking
Definition: api_common.h:84
api_main_t::msg_handlers
void(** msg_handlers)(void *)
Message handler vector
Definition: api_common.h:231
vl_msg_api_config
void vl_msg_api_config(vl_msg_api_msg_config_t *)
Definition: api_shared.c:822
svm_queue_t
struct _svm_queue svm_queue_t
api_main_t::reaper_function_registrations
_vl_msg_api_function_list_elt_t * reaper_function_registrations
List of API client reaper functions.
Definition: api_common.h:369
REGISTRATION_TYPE_FREE
@ REGISTRATION_TYPE_FREE
Definition: api_common.h:38
VL_API_TRACE_RX
@ VL_API_TRACE_RX
Definition: api_common.h:107
vl_msg_api_msg_config_t
Message configuration definition.
Definition: api_common.h:122
vl_api_registration_::registration_type
vl_registration_type_t registration_type
type
Definition: api_common.h:49
api_main_t::my_registration
vl_api_registration_t * my_registration
This is the (shared VM) address of the registration, don't use it to id the connection since it can't...
Definition: api_common.h:345
u16
unsigned short u16
Definition: types.h:57
vl_api_trace_t::traces
u8 ** traces
Trace ring.
Definition: api_common.h:100
api_main_t::rx_trace
vl_api_trace_t * rx_trace
Received message trace configuration.
Definition: api_common.h:269
api_main_t::garbage_collects
u32 garbage_collects
Number of garbage-collected message buffers.
Definition: api_common.h:263
am
app_main_t * am
Definition: application.c:489
vl_msg_api_msg_config_t::print
void * print
message print function
Definition: api_common.h:130
vl_msg_api_set_first_available_msg_id
void vl_msg_api_set_first_available_msg_id(u16 first_avail)
Definition: api_shared.c:1039
vl_api_registration_::vl_input_queue
svm_queue_t * vl_input_queue
shared memory only: pointer to client input queue
Definition: api_common.h:63
msgbuf_::data_len
u32 data_len
message length not including header
Definition: api_common.h:143
vl_api_trace_which_t
vl_api_trace_which_t
Trace RX / TX enum.
Definition: api_common.h:104
api_main_t::arings
struct ring_alloc_ * arings
Allocator ring vectors (in shared memory)
Definition: api_common.h:257
api_main_t::message_bounce
u8 * message_bounce
Don't automatically free message buffer vetor.
Definition: api_common.h:248
vl_msg_api_get_msg_ids
u16 vl_msg_api_get_msg_ids(const char *name, int n)
Definition: api_shared.c:1047
vl_api_msg_range_t::last_msg_id
u16 last_msg_id
last assigned message ID
Definition: api_common.h:118
vl_msg_api_pd_handler
int vl_msg_api_pd_handler(void *mp, int rv)
Definition: api_shared.c:1018
my_api_main
__thread api_main_t * my_api_main
Definition: api_shared.c:45
VL_API_TRACE_TX
@ VL_API_TRACE_TX
Definition: api_common.h:106
vl_msg_api_msg_config_t::endian
void * endian
message endian function
Definition: api_common.h:129
svm_common.h
vl_msg_api_replay_handler
void vl_msg_api_replay_handler(void *the_msg)
Definition: api_shared.c:773
api_main_t::api_version_list
api_version_t * api_version_list
api version list
Definition: api_common.h:354
api_main_t::is_autoendian
u8 * is_autoendian
Message requires us to do endian conversion.
Definition: api_common.h:254
vl_msg_api_msg_config_t::size
int size
message size
Definition: api_common.h:131
vl_shmem_hdr_
Definition: memory_shared.h:76
vl_api_registration_::unprocessed_msg_length
u32 unprocessed_msg_length
Socket only: unprocssed length.
Definition: api_common.h:70
api_main_t::vl_input_queue
svm_queue_t * vl_input_queue
Peer input queue pointer.
Definition: api_common.h:333
api_main_t::api_pvt_heap_size
u64 api_pvt_heap_size
size of the api private mheap
Definition: api_common.h:330
api_main_t::api_gid
int api_gid
gid for the api shared memory region
Definition: api_common.h:315
vl_msg_api_msg_config_t::message_bounce
int message_bounce
do not free message after processing
Definition: api_common.h:134
vl_msg_pop_heap_w_region
void vl_msg_pop_heap_w_region(svm_region_t *vlib_rp, void *oldheap)
Definition: api_shared.c:1148
VL_MSG_API_UNPOISON
static CLIB_NOSANITIZE_ADDR void VL_MSG_API_UNPOISON(const void *a)
Definition: api_common.h:149
vl_api_trace_t::enabled
u8 enabled
trace is enabled
Definition: api_common.h:95
vl_msg_api_post_mortem_dump
void vl_msg_api_post_mortem_dump(void)
Definition: api_shared.c:969
vl_api_registration_::server_index
u32 server_index
Socket client only: server index.
Definition: api_common.h:76
vl_api_registration_t
struct vl_api_registration_ vl_api_registration_t
An API client registration, only in vpp/vlib.
api_main_t::pd_msg_handlers
int(** pd_msg_handlers)(void *, int)
Plaform-dependent (aka hardware) message handler vector.
Definition: api_common.h:233
vl_api_registration_::last_queue_head
int last_queue_head
Definition: api_common.h:58
trace_cfg_t
Trace configuration for a single message.
Definition: api_common.h:82
vl_api_registration_::unanswered_pings
int unanswered_pings
Definition: api_common.h:59
api_main_t::global_pvt_heap_size
u64 global_pvt_heap_size
size of the global VM private mheap
Definition: api_common.h:327
api_main_t::region_name
const char * region_name
Shared VM binary API region name.
Definition: api_common.h:357
vl_api_trace_t::endian
u8 endian
trace endianness
Definition: api_common.h:94
CLIB_NOSANITIZE_ADDR
#define CLIB_NOSANITIZE_ADDR
Definition: sanitizer.h:45
vl_msg_api_handler_no_trace_no_free
void vl_msg_api_handler_no_trace_no_free(void *the_msg)
Definition: api_shared.c:725
vl_api_registration_::additional_fds_to_close
int * additional_fds_to_close
Definition: api_common.h:72
vl_api_registration_
An API client registration, only in vpp/vlib.
Definition: api_common.h:47
vl_msg_api_handler_no_free
void vl_msg_api_handler_no_free(void *the_msg)
Definition: threads.c:376
api_main_t::elog_main
elog_main_t * elog_main
event log
Definition: api_common.h:375
api_main_t::missing_clients
u32 missing_clients
Number of missing clients / failed message sends.
Definition: api_common.h:266
api_main_t::serialized_message_table_in_shmem
u8 * serialized_message_table_in_shmem
vlib/vpp only: serialized (message, name, crc) table
Definition: api_common.h:300
api_main_t::msg_range_by_name
uword * msg_range_by_name
Message range by name hash.
Definition: api_common.h:306
api_main_t::my_client_index
int my_client_index
All VLIB-side message handlers use my_client_index to identify the queue / client.
Definition: api_common.h:339
api_main_t::shmem_hdr
struct vl_shmem_hdr_ * shmem_hdr
Binary API shared-memory segment header pointer.
Definition: api_common.h:294
api_main_t::msg_index_by_name_and_crc
uword * msg_index_by_name_and_crc
client message index hash table
Definition: api_common.h:351
print
static unsigned char * print(const cJSON *const item, cJSON_bool format, const internal_hooks *const hooks)
Definition: cJSON.c:1183
uword
u64 uword
Definition: types.h:112
msgbuf_::data
u8 data[0]
actual message begins here
Definition: api_common.h:145
api_main_t::api_uid
int api_uid
uid for the api shared memory region
Definition: api_common.h:312
vl_api_trace_t::pad
u8 pad
Definition: api_common.h:97
vl_api_registration_::clib_file_index
u32 clib_file_index
Socket only: file index.
Definition: api_common.h:68
vlibapi_get_main
static api_main_t * vlibapi_get_main(void)
Definition: api_common.h:390
api_main_t::msg_ranges
vl_api_msg_range_t * msg_ranges
vector of message ranges
Definition: api_common.h:309
vl_msg_api_get_msg_index
u32 vl_msg_api_get_msg_index(u8 *name_and_crc)
Definition: api_shared.c:1119
api_main_t::vlib_input_queue_length
u32 vlib_input_queue_length
vpp/vlib input queue length
Definition: api_common.h:348
VL_MSG_API_POISON
static void VL_MSG_API_POISON(const void *a)
Definition: api_common.h:162
f64
double f64
Definition: types.h:142
api_main_t::api_trace_cfg
trace_cfg_t * api_trace_cfg
Current trace configuration.
Definition: api_common.h:278
vl_msg_api_trace_only
void vl_msg_api_trace_only(void *the_msg)
Definition: api_shared.c:742
api_main_t::msg_endian_handlers
void(** msg_endian_handlers)(void *)
Message endian handler vector.
Definition: api_common.h:239
vl_api_trace_t::curindex
u32 curindex
Current index in circular buffer
Definition: api_common.h:99
api_main_t::msg_names
const char ** msg_names
Message name vector.
Definition: api_common.h:245
api_main_t::msg_print_handlers
void(** msg_print_handlers)(void *, void *)
Message print function vector.
Definition: api_common.h:242
api_version_t::minor
u32 minor
Definition: api_common.h:222
api_main_t::perf_counter_cbs_tmp
void(** perf_counter_cbs_tmp)(struct api_main_t *, u32 id, int before_or_after)
Definition: api_common.h:382
api_main_t::tx_trace
vl_api_trace_t * tx_trace
Sent message trace configuration.
Definition: api_common.h:272
api_main_t::first_available_msg_id
u16 first_available_msg_id
First available message ID, for theplugin msg allocator.
Definition: api_common.h:303
queue.h
vl_api_trace_t
API trace state.
Definition: api_common.h:92
vl_msg_api_set_handlers
void vl_msg_api_set_handlers(int msg_id, char *msg_name, void *handler, void *cleanup, void *endian, void *print, int msg_size, int traced)
Definition: api_shared.c:872
api_main_t
API main structure, used by both vpp and binary API clients.
Definition: api_common.h:228
api_main_t::api_size
u64 api_size
size of the API region
Definition: api_common.h:324
id
u8 id[64]
Definition: dhcp.api:160
api_version_t
Definition: api_common.h:219
api_main_t::vlib_rp
svm_region_t * vlib_rp
Current binary api segment descriptor.
Definition: api_common.h:284
vl_msg_api_clean_handlers
void vl_msg_api_clean_handlers(int msg_id)
Definition: api_shared.c:895
always_inline
#define always_inline
Definition: rdma_mlx5dv.h:23
api_main_t::ring_misses
u32 ring_misses
Number of times that the ring allocator failed.
Definition: api_common.h:260
vl_msg_api_handler
void vl_msg_api_handler(void *the_msg)
Definition: api_shared.c:704
vl_api_registration_::shmem_hdr
void * shmem_hdr
Definition: api_common.h:65
vl_api_trace_t::nitems
u32 nitems
Number of trace records.
Definition: api_common.h:98
vl_msg_api_free
void vl_msg_api_free(void *)
Definition: memory_shared.c:311
vl_api_trace_t::wrapped
u8 wrapped
trace has wrapped
Definition: api_common.h:96
u64
unsigned long u64
Definition: types.h:89
i8
signed char i8
Definition: types.h:45
vl_noop_handler
void vl_noop_handler(void *mp)
Definition: api_shared.c:955
vl_msg_api_barrier_trace_context
#define vl_msg_api_barrier_trace_context(X)
Definition: api_common.h:192
vl_msg_api_increment_missing_client_counter
void vl_msg_api_increment_missing_client_counter(void)
Definition: api_shared.c:55
vl_api_msg_range_t
Message range (belonging to a plugin)
Definition: api_common.h:114
u32
unsigned int u32
Definition: types.h:88
vl_msg_push_heap
void * vl_msg_push_heap(void)
Definition: cli.c:745
vl_msg_api_msg_config_t::replay
int replay
is this message to be replayed?
Definition: api_common.h:133
trace_cfg_t::trace_enable
int trace_enable
trace this message
Definition: api_common.h:85
CLIB_MEM_UNPOISON
#define CLIB_MEM_UNPOISON(a, s)
Definition: sanitizer.h:47
api_main_t::msg_cleanup_handlers
void(** msg_cleanup_handlers)(void *)
non-default message cleanup handler vector
Definition: api_common.h:236
vl_msg_push_heap_w_region
void * vl_msg_push_heap_w_region(svm_region_t *vlib_rp)
Definition: api_shared.c:1134
api_main_t
struct api_main_t api_main_t
API main structure, used by both vpp and binary API clients.
api_global_main
api_main_t api_global_main
Definition: api_shared.c:36
vl_api_msg_range_t::first_msg_id
u16 first_msg_id
first assigned message ID
Definition: api_common.h:117
vl_api_registration_::server_handle
u32 server_handle
Socket client only: server handle.
Definition: api_common.h:75
trace_cfg_t::replay_enable
int replay_enable
This message can be replayed
Definition: api_common.h:86
vl_msg_api_post_mortem_dump_enable_disable
void vl_msg_api_post_mortem_dump_enable_disable(int enable)
Definition: api_shared.c:963
vl_api_registration_::vlib_rp
svm_region_t * vlib_rp
Definition: api_common.h:64
vl_msg_api_init_function_t
clib_error_t *() vl_msg_api_init_function_t(u32 client_index)
Definition: api_common.h:211
msgbuf_
Message header structure.
Definition: api_common.h:140
vl_api_registration_::output_vector
u8 * output_vector
Socket only: output vector.
Definition: api_common.h:71
api_main_t::perf_counter_cbs
void(** perf_counter_cbs)(struct api_main_t *, u32 id, int before_or_after)
performance counter callback
Definition: api_common.h:380
vl_msg_api_register_pd_handler
void vl_msg_api_register_pd_handler(void *handler, u16 msg_id_host_byte_order)
Definition: api_shared.c:1004
api_main_t::our_pid
int our_pid
Current process PID.
Definition: api_common.h:281
svm_region_
Definition: svm_common.h:35
u8
unsigned char u8
Definition: types.h:56
clib_error_t
Definition: clib_error.h:21
a
a
Definition: bitmap.h:544
vl_msg_api_cleanup_handler
void vl_msg_api_cleanup_handler(void *the_msg)
Definition: api_shared.c:753
elog_main_t
Definition: elog.h:132
clib_error.h
VL_MSG_API_SVM_QUEUE_UNPOISON
static CLIB_NOSANITIZE_ADDR void VL_MSG_API_SVM_QUEUE_UNPOISON(const svm_queue_t *q)
Definition: api_common.h:156
api_main_t::vl_clients
vl_api_registration_t ** vl_clients
vlib/vpp only: vector of client registrations
Definition: api_common.h:297
api_main_t::mapped_shmem_regions
svm_region_t ** mapped_shmem_regions
Definition: api_common.h:291
vl_msg_api_msg_config_t::is_autoendian
int is_autoendian
endian conversion required?
Definition: api_common.h:136
context
u32 context
Definition: ip.api:780
api_version_t::major
u32 major
Definition: api_common.h:221
rv
int __clib_unused rv
Definition: application.c:491
cleanup
static void cleanup(void)
Definition: client.c:98
REGISTRATION_TYPE_SHMEM
@ REGISTRATION_TYPE_SHMEM
Shared memory connection.
Definition: api_common.h:39
vl_api_registration_::name
u8 * name
Client name.
Definition: api_common.h:54
msgbuf_::gc_mark_timestamp
u32 gc_mark_timestamp
message garbage collector mark TS
Definition: api_common.h:144
api_main_t::vlib_primary_rp
svm_region_t * vlib_primary_rp
Primary api segment descriptor.
Definition: api_common.h:287
vl_api_registration_::unprocessed_input
i8 * unprocessed_input
Socket only: pending input.
Definition: api_common.h:69
vl_api_registration_::last_heard
f64 last_heard
Definition: api_common.h:57
vl_msg_api_set_cleanup_handler
void vl_msg_api_set_cleanup_handler(int msg_id, void *fp)
Definition: api_shared.c:907
vl_msg_pop_heap
void vl_msg_pop_heap(void *oldheap)
Definition: cli.c:752
vl_msg_api_msg_config_t::handler
void * handler
the message handler
Definition: api_common.h:127
REGISTRATION_TYPE_SOCKET_SERVER
@ REGISTRATION_TYPE_SOCKET_SERVER
Socket server.
Definition: api_common.h:41
api_version_t::patch
u32 patch
Definition: api_common.h:223
vl_msg_api_barrier_sync
void vl_msg_api_barrier_sync(void)
Definition: api_shared.c:427
ring_alloc_
Definition: memory_shared.h:35
api_main_t::elog_trace_api_messages
int elog_trace_api_messages
Definition: api_common.h:376
vlibapi_set_main
static void vlibapi_set_main(api_main_t *am)
Definition: api_common.h:396
api_main_t::is_mp_safe
u8 * is_mp_safe
Message is mp safe vector.
Definition: api_common.h:251
vl_msg_api_msg_config_t::is_mp_safe
int is_mp_safe
worker thread barrier required?
Definition: api_common.h:135
api_main_t::msg_print_flag
int msg_print_flag
Print every received message.
Definition: api_common.h:275
vl_msg_api_msg_config_t::id
int id
the message ID
Definition: api_common.h:124
vl_api_registration_::vl_api_registration_pool_index
u32 vl_api_registration_pool_index
Index in VLIB's brain (not shared memory).
Definition: api_common.h:52
api_main_t::save_msg_table_filename
u8 * save_msg_table_filename
Dump (msg-name, crc) snapshot here at startup.
Definition: api_common.h:366