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