FD.io VPP  v20.01-46-g7006026de
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 definitions
24  * See api_doc.md for more info
25  */
26 
27 #include <vppinfra/clib_error.h>
28 #include <vppinfra/elog.h>
29 #include <vlibapi/api_types.h>
30 #include <svm/svm_common.h>
31 #include <svm/queue.h>
32 
33 /** API registration types
34  */
35 typedef enum
36 {
38  REGISTRATION_TYPE_SHMEM, /**< Shared memory connection */
39  REGISTRATION_TYPE_SOCKET_LISTEN, /**< Socket listener */
40  REGISTRATION_TYPE_SOCKET_SERVER, /**< Socket server */
41  REGISTRATION_TYPE_SOCKET_CLIENT, /**< Socket client */
43 
44 /** An API client registration, only in vpp/vlib */
45 
46 typedef struct vl_api_registration_
47 {
49 
50  /** Index in VLIB's brain (not shared memory). */
52 
53  u8 *name; /**< Client name */
54 
55  /* Zombie apocalypse checking */
59 
60  /** shared memory only: pointer to client input queue */
63  void *shmem_hdr;
64 
65  /* socket server and client */
66  u32 clib_file_index; /**< Socket only: file index */
67  i8 *unprocessed_input; /**< Socket only: pending input */
68  u32 unprocessed_msg_length; /**< Socket only: unprocssed length */
69  u8 *output_vector; /**< Socket only: output vector */
71 
72  /* socket client only */
73  u32 server_handle; /**< Socket client only: server handle */
74  u32 server_index; /**< Socket client only: server index */
76 
77 #define VL_API_INVALID_FI ((u32)~0)
78 
79 /** Trace configuration for a single message */
80 typedef struct
81 {
82  int size; /**< for sanity checking */
83  int trace_enable; /**< trace this message */
84  int replay_enable; /**< This message can be replayed */
85 } trace_cfg_t;
86 
87 /**
88  * API trace state
89  */
90 typedef struct
91 {
92  u8 endian; /**< trace endianness */
93  u8 enabled; /**< trace is enabled */
94  u8 wrapped; /**< trace has wrapped */
96  u32 nitems; /**< Number of trace records */
97  u32 curindex; /**< Current index in circular buffer */
98  u8 **traces; /**< Trace ring */
100 
101 /** Trace RX / TX enum */
102 typedef enum
103 {
107 
108 #define VL_API_LITTLE_ENDIAN 0x00
109 #define VL_API_BIG_ENDIAN 0x01
110 
111 /** Message range (belonging to a plugin) */
112 typedef struct
113 {
114  u8 *name; /**< name of the plugin */
115  u16 first_msg_id; /**< first assigned message ID */
116  u16 last_msg_id; /**< last assigned message ID */
118 
119 /** Message configuration definition */
120 typedef struct
121 {
122  int id; /**< the message ID */
123  char *name; /**< the message name */
124  u32 crc; /**< message definition CRC */
125  void *handler; /**< the message handler */
126  void *cleanup; /**< non-default message cleanup handler */
127  void *endian; /**< message endian function */
128  void *print; /**< message print function */
129  int size; /**< message size */
130  int traced; /**< is this message to be traced? */
131  int replay; /**< is this message to be replayed? */
132  int message_bounce; /**< do not free message after processing */
133  int is_mp_safe; /**< worker thread barrier required? */
135 
136 /** Message header structure */
137 typedef struct msgbuf_
138 {
139  svm_queue_t *q; /**< message allocated in this shmem ring */
140  u32 data_len; /**< message length not including header */
141  u32 gc_mark_timestamp; /**< message garbage collector mark TS */
142  u8 data[0]; /**< actual message begins here */
143 } msgbuf_t;
144 
145 CLIB_NOSANITIZE_ADDR static inline void
146 VL_MSG_API_UNPOISON (const void *a)
147 {
148  const msgbuf_t *m = &((const msgbuf_t *) a)[-1];
149  CLIB_MEM_UNPOISON (m, sizeof (*m) + ntohl (m->data_len));
150 }
151 
152 CLIB_NOSANITIZE_ADDR static inline void
154 {
155  CLIB_MEM_UNPOISON (q, sizeof (*q) + q->elsize * q->maxsize);
156 }
157 
158 static inline void
159 VL_MSG_API_POISON (const void *a)
160 {
161  const msgbuf_t *m = &((const msgbuf_t *) a)[-1];
162  CLIB_MEM_POISON (m, sizeof (*m) + ntohl (m->data_len));
163 }
164 
165 /* api_shared.c prototypes */
166 void vl_msg_api_handler (void *the_msg);
167 void vl_msg_api_handler_no_free (void *the_msg);
168 void vl_msg_api_handler_no_trace_no_free (void *the_msg);
169 void vl_msg_api_trace_only (void *the_msg);
170 void vl_msg_api_cleanup_handler (void *the_msg);
171 void vl_msg_api_replay_handler (void *the_msg);
172 void vl_msg_api_socket_handler (void *the_msg);
173 void vl_msg_api_set_handlers (int msg_id, char *msg_name,
174  void *handler,
175  void *cleanup,
176  void *endian,
177  void *print, int msg_size, int traced);
178 void vl_msg_api_clean_handlers (int msg_id);
180 void vl_msg_api_set_cleanup_handler (int msg_id, void *fp);
182 
183 void vl_msg_api_barrier_sync (void) __attribute__ ((weak));
184 void vl_msg_api_barrier_release (void) __attribute__ ((weak));
185 #ifdef BARRIER_TRACING
186 void vl_msg_api_barrier_trace_context (const char *context)
187  __attribute__ ((weak));
188 #else
189 #define vl_msg_api_barrier_trace_context(X)
190 #endif
191 void vl_msg_api_free (void *);
192 void vl_noop_handler (void *mp);
194 void vl_msg_api_post_mortem_dump (void);
196 void vl_msg_api_register_pd_handler (void *handler,
197  u16 msg_id_host_byte_order);
198 int vl_msg_api_pd_handler (void *mp, int rv);
199 
200 void vl_msg_api_set_first_available_msg_id (u16 first_avail);
201 u16 vl_msg_api_get_msg_ids (const char *name, int n);
202 u32 vl_msg_api_get_msg_index (u8 * name_and_crc);
203 void *vl_msg_push_heap (void);
205 void vl_msg_pop_heap (void *oldheap);
206 void vl_msg_pop_heap_w_region (svm_region_t * vlib_rp, void *oldheap);
207 
208 typedef clib_error_t *(vl_msg_api_init_function_t) (u32 client_index);
209 
210 typedef struct _vl_msg_api_init_function_list_elt
211 {
212  struct _vl_msg_api_init_function_list_elt *next_init_function;
214 } _vl_msg_api_function_list_elt_t;
215 
216 typedef struct
217 {
221  char name[64];
222 } api_version_t;
223 
224 /** API main structure, used by both vpp and binary API clients */
225 typedef struct
226 {
227  /** Message handler vector */
228  void (**msg_handlers) (void *);
229  /** Plaform-dependent (aka hardware) message handler vector */
230  int (**pd_msg_handlers) (void *, int);
231 
232  /** non-default message cleanup handler vector */
233  void (**msg_cleanup_handlers) (void *);
234 
235  /** Message endian handler vector */
236  void (**msg_endian_handlers) (void *);
237 
238  /** Message print function vector */
239  void (**msg_print_handlers) (void *, void *);
240 
241  /** Message name vector */
242  const char **msg_names;
243 
244  /** Don't automatically free message buffer vetor */
246 
247  /** Message is mp safe vector */
249 
250  /** Allocator ring vectors (in shared memory) */
252 
253  /** Number of times that the ring allocator failed */
255 
256  /** Number of garbage-collected message buffers */
258 
259  /** Number of missing clients / failed message sends */
261 
262  /** Received message trace configuration */
264 
265  /** Sent message trace configuration */
267 
268  /** Print every received message */
270 
271  /** Current trace configuration */
273 
274  /** Current process PID */
275  int our_pid;
276 
277  /** Current binary api segment descriptor */
279 
280  /** Primary api segment descriptor */
282 
283  /** Vector of all mapped shared-VM segments */
286 
287  /** Binary API shared-memory segment header pointer */
289 
290  /** vlib/vpp only: vector of client registrations */
292 
293  /** vlib/vpp only: serialized (message, name, crc) table */
295 
296  /** First available message ID, for theplugin msg allocator */
298 
299  /** Message range by name hash */
301 
302  /** vector of message ranges */
304 
305  /** uid for the api shared memory region */
306  int api_uid;
307 
308  /** gid for the api shared memory region */
309  int api_gid;
310 
311  /** base virtual address for global VM region */
313 
314  /** size of the global VM region */
316 
317  /** size of the API region */
319 
320  /** size of the global VM private mheap */
322 
323  /** size of the api private mheap */
325 
326  /** Peer input queue pointer */
328 
329  /**
330  * All VLIB-side message handlers use my_client_index to identify
331  * the queue / client. This works in sim replay.
332  */
334  /**
335  * This is the (shared VM) address of the registration,
336  * don't use it to id the connection since it can't possibly
337  * work in simulator replay.
338  */
340 
341  /** vpp/vlib input queue length */
343 
344  /** client message index hash table */
346 
347  /** api version list */
349 
350  /** Shared VM binary API region name */
351  const char *region_name;
352 
353  /** Chroot path to the shared memory API files */
354  const char *root_path;
355 
356  /** Replay in progress? */
358 
359  /** Dump (msg-name, crc) snapshot here at startup */
361 
362  /** List of API client reaper functions */
363  _vl_msg_api_function_list_elt_t *reaper_function_registrations;
364 
365  /** Bin API thread handle */
366  pthread_t rx_thread_handle;
367 
368  /** event log */
371 
372 } api_main_t;
373 
374 extern __thread api_main_t *my_api_main;
376 
379 {
380  return my_api_main;
381 }
382 
383 always_inline void
385 {
386  my_api_main = am;
387 }
388 
389 #endif /* included_api_common_h */
390 
391 /*
392  * fd.io coding-style-patch-verification: ON
393  *
394  * Local Variables:
395  * eval: (c-set-style "gnu")
396  * End:
397  */
Message range (belonging to a plugin)
Definition: api_common.h:112
u64 api_pvt_heap_size
size of the api private mheap
Definition: api_common.h:324
vl_registration_type_t
API registration types.
Definition: api_common.h:35
u8 * name
Client name.
Definition: api_common.h:53
#define CLIB_MEM_UNPOISON(a, s)
Definition: sanitizer.h:47
void vl_msg_api_handler_no_trace_no_free(void *the_msg)
Definition: api_shared.c:676
int id
the message ID
Definition: api_common.h:122
u8 * name
name of the plugin
Definition: api_common.h:114
void vl_msg_api_socket_handler(void *the_msg)
Definition: api_shared.c:751
int vl_msg_api_pd_handler(void *mp, int rv)
Definition: api_shared.c:951
a
Definition: bitmap.h:538
void * print
message print function
Definition: api_common.h:128
u64 api_size
size of the API region
Definition: api_common.h:318
u8 wrapped
trace has wrapped
Definition: api_common.h:94
int size
for sanity checking
Definition: api_common.h:82
unsigned long u64
Definition: types.h:89
int my_client_index
All VLIB-side message handlers use my_client_index to identify the queue / client.
Definition: api_common.h:333
u32 crc
message definition CRC
Definition: api_common.h:124
void vl_noop_handler(void *mp)
Definition: api_shared.c:888
u8 * message_bounce
Don&#39;t automatically free message buffer vetor.
Definition: api_common.h:245
void vl_msg_api_register_pd_handler(void *handler, u16 msg_id_host_byte_order)
Definition: api_shared.c:937
static void VL_MSG_API_POISON(const void *a)
Definition: api_common.h:159
Message configuration definition.
Definition: api_common.h:120
u32 gc_mark_timestamp
message garbage collector mark TS
Definition: api_common.h:141
svm_region_t * vlib_primary_rp
Primary api segment descriptor.
Definition: api_common.h:281
void vl_msg_api_post_mortem_dump(void)
Definition: api_shared.c:902
api_version_t * api_version_list
api version list
Definition: api_common.h:348
int api_uid
uid for the api shared memory region
Definition: api_common.h:306
svm_queue_t * q
message allocated in this shmem ring
Definition: api_common.h:139
u32 server_index
Socket client only: server index.
Definition: api_common.h:74
#define vl_msg_api_barrier_trace_context(X)
Definition: api_common.h:189
struct msgbuf_ msgbuf_t
Message header structure.
svm_queue_t * vl_input_queue
Peer input queue pointer.
Definition: api_common.h:327
int api_gid
gid for the api shared memory region
Definition: api_common.h:309
void * cleanup
non-default message cleanup handler
Definition: api_common.h:126
unsigned char u8
Definition: types.h:56
trace_cfg_t * api_trace_cfg
Current trace configuration.
Definition: api_common.h:272
void vl_msg_pop_heap_w_region(svm_region_t *vlib_rp, void *oldheap)
Definition: api_shared.c:1081
int size
message size
Definition: api_common.h:129
double f64
Definition: types.h:142
_vl_msg_api_function_list_elt_t * reaper_function_registrations
List of API client reaper functions.
Definition: api_common.h:363
int our_pid
Current process PID.
Definition: api_common.h:275
u32 clib_file_index
Socket only: file index.
Definition: api_common.h:66
void * endian
message endian function
Definition: api_common.h:127
vl_api_registration_t * my_registration
This is the (shared VM) address of the registration, don&#39;t use it to id the connection since it can&#39;t...
Definition: api_common.h:339
vl_api_trace_t * rx_trace
Received message trace configuration.
Definition: api_common.h:263
static void vlibapi_set_main(api_main_t *am)
Definition: api_common.h:384
void vl_msg_api_barrier_sync(void)
Definition: api_shared.c:426
u32 ring_misses
Number of times that the ring allocator failed.
Definition: api_common.h:254
vl_api_registration_t ** vl_clients
vlib/vpp only: vector of client registrations
Definition: api_common.h:291
void vl_msg_api_handler_no_free(void *the_msg)
Definition: threads.c:399
int replay_in_progress
Replay in progress?
Definition: api_common.h:357
const char * root_path
Chroot path to the shared memory API files.
Definition: api_common.h:354
svm_region_t * vlib_rp
Current binary api segment descriptor.
Definition: api_common.h:278
struct vl_shmem_hdr_ * shmem_hdr
Binary API shared-memory segment header pointer.
Definition: api_common.h:288
unsigned int u32
Definition: types.h:88
vl_registration_type_t registration_type
type
Definition: api_common.h:48
u16 last_msg_id
last assigned message ID
Definition: api_common.h:116
__thread api_main_t * my_api_main
Definition: api_shared.c:44
int elog_trace_api_messages
Definition: api_common.h:370
void vl_msg_pop_heap(void *oldheap)
Definition: cli.c:720
svm_queue_t * vl_input_queue
shared memory only: pointer to client input queue
Definition: api_common.h:61
void vl_msg_api_clean_handlers(int msg_id)
Definition: api_shared.c:843
int replay_enable
This message can be replayed.
Definition: api_common.h:84
unsigned short u16
Definition: types.h:57
void vl_msg_api_cleanup_handler(void *the_msg)
Definition: api_shared.c:704
int message_bounce
do not free message after processing
Definition: api_common.h:132
u32 curindex
Current index in circular buffer.
Definition: api_common.h:97
static void cleanup(void)
Definition: client.c:131
svm_region_t ** vlib_private_rps
Vector of all mapped shared-VM segments.
Definition: api_common.h:284
#define always_inline
Definition: ipsec.h:28
signed char i8
Definition: types.h:45
u32 unprocessed_msg_length
Socket only: unprocssed length.
Definition: api_common.h:68
clib_error_t *() vl_msg_api_init_function_t(u32 client_index)
Definition: api_common.h:208
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:821
elog_main_t * elog_main
event log
Definition: api_common.h:369
#define CLIB_NOSANITIZE_ADDR
Definition: sanitizer.h:45
void vl_msg_api_replay_handler(void *the_msg)
Definition: api_shared.c:724
API main structure, used by both vpp and binary API clients.
Definition: api_common.h:225
void vl_msg_api_config(vl_msg_api_msg_config_t *)
Definition: api_shared.c:772
u64 global_size
size of the global VM region
Definition: api_common.h:315
u8 enabled
trace is enabled
Definition: api_common.h:93
An API client registration, only in vpp/vlib.
Definition: api_common.h:46
The fine-grained event logger allows lightweight, thread-safe event logging at minimum cost...
void * vl_msg_push_heap_w_region(svm_region_t *vlib_rp)
Definition: api_shared.c:1067
Shared memory connection.
Definition: api_common.h:38
API trace state.
Definition: api_common.h:90
u64 global_baseva
base virtual address for global VM region
Definition: api_common.h:312
vl_api_msg_range_t * msg_ranges
vector of message ranges
Definition: api_common.h:303
u32 vl_msg_api_get_msg_index(u8 *name_and_crc)
Definition: api_shared.c:1052
u8 * output_vector
Socket only: output vector.
Definition: api_common.h:69
u8 ** traces
Trace ring.
Definition: api_common.h:98
int * additional_fds_to_close
Definition: api_common.h:70
const char ** msg_names
Message name vector.
Definition: api_common.h:242
static CLIB_NOSANITIZE_ADDR void VL_MSG_API_SVM_QUEUE_UNPOISON(const svm_queue_t *q)
Definition: api_common.h:153
struct vl_api_registration_ vl_api_registration_t
An API client registration, only in vpp/vlib.
int replay
is this message to be replayed?
Definition: api_common.h:131
u8 * save_msg_table_filename
Dump (msg-name, crc) snapshot here at startup.
Definition: api_common.h:360
vl_api_trace_t * tx_trace
Sent message trace configuration.
Definition: api_common.h:266
u32 garbage_collects
Number of garbage-collected message buffers.
Definition: api_common.h:257
u8 data[128]
Definition: ipsec_types.api:87
void vl_msg_api_trace_only(void *the_msg)
Definition: api_shared.c:693
u32 data_len
message length not including header
Definition: api_common.h:140
Message header structure.
Definition: api_common.h:137
vl_api_trace_which_t
Trace RX / TX enum.
Definition: api_common.h:102
u8 * serialized_message_table_in_shmem
vlib/vpp only: serialized (message, name, crc) table
Definition: api_common.h:294
void vl_msg_api_set_cleanup_handler(int msg_id, void *fp)
Definition: api_shared.c:855
u64 global_pvt_heap_size
size of the global VM private mheap
Definition: api_common.h:321
i8 * unprocessed_input
Socket only: pending input.
Definition: api_common.h:67
void vl_msg_api_queue_handler(svm_queue_t *q)
Definition: api_shared.c:865
pthread_t rx_thread_handle
Bin API thread handle.
Definition: api_common.h:366
struct ring_alloc_ * arings
Allocator ring vectors (in shared memory)
Definition: api_common.h:251
void vl_msg_api_free(void *)
u32 missing_clients
Number of missing clients / failed message sends.
Definition: api_common.h:260
u16 first_msg_id
first assigned message ID
Definition: api_common.h:115
api_main_t api_global_main
Definition: api_shared.c:35
u64 uword
Definition: types.h:112
u32 vl_api_registration_pool_index
Index in VLIB&#39;s brain (not shared memory).
Definition: api_common.h:51
struct _svm_queue svm_queue_t
u16 first_available_msg_id
First available message ID, for theplugin msg allocator.
Definition: api_common.h:297
static api_main_t * vlibapi_get_main(void)
Definition: api_common.h:378
u8 endian
trace endianness
Definition: api_common.h:92
u8 * is_mp_safe
Message is mp safe vector.
Definition: api_common.h:248
void vl_msg_api_increment_missing_client_counter(void)
Definition: api_shared.c:54
void * vl_msg_push_heap(void)
Definition: cli.c:713
int trace_enable
trace this message
Definition: api_common.h:83
int msg_print_flag
Print every received message.
Definition: api_common.h:269
u32 server_handle
Socket client only: server handle.
Definition: api_common.h:73
int is_mp_safe
worker thread barrier required?
Definition: api_common.h:133
int traced
is this message to be traced?
Definition: api_common.h:130
const char * region_name
Shared VM binary API region name.
Definition: api_common.h:351
Trace configuration for a single message.
Definition: api_common.h:80
svm_region_t ** mapped_shmem_regions
Definition: api_common.h:285
uword * msg_index_by_name_and_crc
client message index hash table
Definition: api_common.h:345
void vl_msg_api_barrier_release(void)
Definition: api_shared.c:431
uword * msg_range_by_name
Message range by name hash.
Definition: api_common.h:300
char * name
the message name
Definition: api_common.h:123
void vl_msg_api_post_mortem_dump_enable_disable(int enable)
Definition: api_shared.c:896
u32 nitems
Number of trace records.
Definition: api_common.h:96
svm_region_t * vlib_rp
Definition: api_common.h:62
void vl_msg_api_set_first_available_msg_id(u16 first_avail)
Definition: api_shared.c:972
void * handler
the message handler
Definition: api_common.h:125
u32 vlib_input_queue_length
vpp/vlib input queue length
Definition: api_common.h:342
static CLIB_NOSANITIZE_ADDR void VL_MSG_API_UNPOISON(const void *a)
Definition: api_common.h:146
#define CLIB_MEM_POISON(a, s)
Definition: sanitizer.h:46
u16 vl_msg_api_get_msg_ids(const char *name, int n)
Definition: api_shared.c:980
void vl_msg_api_handler(void *the_msg)
Definition: api_shared.c:655