2 *------------------------------------------------------------------
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:
10 * http://www.apache.org/licenses/LICENSE-2.0
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 *------------------------------------------------------------------
20 #ifndef included_api_common_h
21 #define included_api_common_h
23 /** \file api_common.h
24 * API common definitions
25 * See api_doc.md for more info
28 #include <vppinfra/clib_error.h>
29 #include <vppinfra/elog.h>
30 #include <vppinfra/cJSON.h>
31 #include <vlibapi/api_types.h>
32 #include <svm/svm_common.h>
33 #include <svm/queue.h>
35 /** API registration types
39 REGISTRATION_TYPE_FREE = 0,
40 REGISTRATION_TYPE_SHMEM, /**< Shared memory connection */
41 REGISTRATION_TYPE_SOCKET_LISTEN, /**< Socket listener */
42 REGISTRATION_TYPE_SOCKET_SERVER, /**< Socket server */
43 REGISTRATION_TYPE_SOCKET_CLIENT, /**< Socket client */
44 } vl_registration_type_t;
46 /** An API client registration, only in vpp/vlib */
48 typedef struct vl_api_registration_
50 vl_registration_type_t registration_type; /**< type */
52 /** Index in VLIB's brain (not shared memory). */
53 u32 vl_api_registration_pool_index;
55 u8 *name; /**< Client name */
57 /* Zombie apocalypse checking */
63 /** shared memory only: pointer to client input queue */
64 svm_queue_t *vl_input_queue;
65 svm_region_t *vlib_rp;
68 /* socket server and client */
69 u32 clib_file_index; /**< Socket only: file index */
70 i8 *unprocessed_input; /**< Socket only: pending input */
71 u32 unprocessed_msg_length; /**< Socket only: unprocssed length */
72 u8 *output_vector; /**< Socket only: output vector */
73 int *additional_fds_to_close;
75 /* socket client only */
76 u32 server_handle; /**< Socket client only: server handle */
77 u32 server_index; /**< Socket client only: server index */
78 } vl_api_registration_t;
80 #define VL_API_INVALID_FI ((u32)~0)
82 /** Trace configuration for a single message */
85 int size; /**< for sanity checking */
86 int trace_enable; /**< trace this message */
87 int replay_enable; /**< This message can be replayed */
95 u8 endian; /**< trace endianness */
96 u8 enabled; /**< trace is enabled */
97 u8 wrapped; /**< trace has wrapped */
99 u32 nitems; /**< Number of trace records */
100 u32 curindex; /**< Current index in circular buffer */
101 u8 **traces; /**< Trace ring */
104 /** Trace RX / TX enum */
109 } vl_api_trace_which_t;
111 #define VL_API_LITTLE_ENDIAN 0x00
112 #define VL_API_BIG_ENDIAN 0x01
114 /** Message range (belonging to a plugin) */
117 u8 *name; /**< name of the plugin */
118 u16 first_msg_id; /**< first assigned message ID */
119 u16 last_msg_id; /**< last assigned message ID */
120 } vl_api_msg_range_t;
122 /** Message configuration definition */
125 int id; /**< the message ID */
126 char *name; /**< the message name */
127 u32 crc; /**< message definition CRC */
128 void *handler; /**< the message handler */
129 void *cleanup; /**< non-default message cleanup handler */
130 void *endian; /**< message endian function */
131 void *print; /**< message print function */
132 void *print_json; /**< message print function (JSON format) */
133 void *tojson; /**< binary to JSON convert function */
134 void *fromjson; /**< JSON to binary convert function */
135 int size; /**< message size */
136 int traced; /**< is this message to be traced? */
137 int replay; /**< is this message to be replayed? */
138 int message_bounce; /**< do not free message after processing */
139 int is_mp_safe; /**< worker thread barrier required? */
140 int is_autoendian; /**< endian conversion required? */
141 } vl_msg_api_msg_config_t;
143 /** Message header structure */
144 typedef struct msgbuf_
146 svm_queue_t *q; /**< message allocated in this shmem ring */
147 u32 data_len; /**< message length not including header */
148 u32 gc_mark_timestamp; /**< message garbage collector mark TS */
149 u8 data[0]; /**< actual message begins here */
152 CLIB_NOSANITIZE_ADDR static inline void
153 VL_MSG_API_UNPOISON (const void *a)
155 const msgbuf_t *m = &((const msgbuf_t *) a)[-1];
156 CLIB_MEM_UNPOISON (m, sizeof (*m) + ntohl (m->data_len));
159 CLIB_NOSANITIZE_ADDR static inline void
160 VL_MSG_API_SVM_QUEUE_UNPOISON (const svm_queue_t * q)
162 CLIB_MEM_UNPOISON (q, sizeof (*q) + q->elsize * q->maxsize);
166 VL_MSG_API_POISON (const void *a)
168 const msgbuf_t *m = &((const msgbuf_t *) a)[-1];
169 CLIB_MEM_POISON (m, sizeof (*m) + ntohl (m->data_len));
172 /* api_shared.c prototypes */
173 void vl_msg_api_handler (void *the_msg);
174 void vl_msg_api_handler_no_free (void *the_msg);
175 void vl_msg_api_handler_no_trace_no_free (void *the_msg);
176 void vl_msg_api_trace_only (void *the_msg);
177 void vl_msg_api_cleanup_handler (void *the_msg);
178 void vl_msg_api_replay_handler (void *the_msg);
179 void vl_msg_api_socket_handler (void *the_msg);
180 void vl_msg_api_set_handlers (int msg_id, char *msg_name, void *handler,
181 void *cleanup, void *endian, void *print,
182 int msg_size, int traced, void *print_json,
183 void *tojson, void *fromjson);
184 void vl_msg_api_clean_handlers (int msg_id);
185 void vl_msg_api_config (vl_msg_api_msg_config_t *);
186 void vl_msg_api_set_cleanup_handler (int msg_id, void *fp);
187 void vl_msg_api_queue_handler (svm_queue_t * q);
189 void vl_msg_api_barrier_sync (void) __attribute__ ((weak));
190 void vl_msg_api_barrier_release (void) __attribute__ ((weak));
191 #ifdef BARRIER_TRACING
192 void vl_msg_api_barrier_trace_context (const char *context)
193 __attribute__ ((weak));
195 #define vl_msg_api_barrier_trace_context(X)
197 void vl_msg_api_free (void *);
198 void vl_noop_handler (void *mp);
199 void vl_msg_api_increment_missing_client_counter (void);
200 void vl_msg_api_post_mortem_dump (void);
201 void vl_msg_api_post_mortem_dump_enable_disable (int enable);
202 void vl_msg_api_register_pd_handler (void *handler,
203 u16 msg_id_host_byte_order);
204 int vl_msg_api_pd_handler (void *mp, int rv);
206 void vl_msg_api_set_first_available_msg_id (u16 first_avail);
207 u16 vl_msg_api_get_msg_ids (const char *name, int n);
208 u32 vl_msg_api_get_msg_index (u8 * name_and_crc);
209 void *vl_msg_push_heap (void);
210 void *vl_msg_push_heap_w_region (svm_region_t * vlib_rp);
211 void vl_msg_pop_heap (void *oldheap);
212 void vl_msg_pop_heap_w_region (svm_region_t * vlib_rp, void *oldheap);
214 typedef clib_error_t *(vl_msg_api_init_function_t) (u32 client_index);
216 typedef struct _vl_msg_api_init_function_list_elt
218 struct _vl_msg_api_init_function_list_elt *next_init_function;
219 vl_msg_api_init_function_t *f;
220 } _vl_msg_api_function_list_elt_t;
230 /** API main structure, used by both vpp and binary API clients */
231 typedef struct api_main_t
233 /** Message handler vector */
234 void (**msg_handlers) (void *);
235 /** Plaform-dependent (aka hardware) message handler vector */
236 int (**pd_msg_handlers) (void *, int);
238 /** non-default message cleanup handler vector */
239 void (**msg_cleanup_handlers) (void *);
241 /** Message endian handler vector */
242 void (**msg_endian_handlers) (void *);
244 /** Message print function vector */
245 void (**msg_print_handlers) (void *, void *);
247 /** Message print function vector in JSON */
248 void (**msg_print_json_handlers) (void *, void *);
250 /** Message convert function vector */
251 cJSON *(**msg_tojson_handlers) (void *);
253 /** Message convert function vector */
254 void *(**msg_fromjson_handlers) (cJSON *, int *);
256 /** Message name vector */
257 const char **msg_names;
259 /** API message ID by name hash table */
260 uword *msg_id_by_name;
262 /** Don't automatically free message buffer vetor */
265 /** Message is mp safe vector */
268 /** Message requires us to do endian conversion */
271 /** Allocator ring vectors (in shared memory) */
272 struct ring_alloc_ *arings;
274 /** Number of times that the ring allocator failed */
277 /** Number of garbage-collected message buffers */
278 u32 garbage_collects;
280 /** Number of missing clients / failed message sends */
283 /** Received message trace configuration */
284 vl_api_trace_t *rx_trace;
286 /** Sent message trace configuration */
287 vl_api_trace_t *tx_trace;
289 /** Print every received message */
292 /** Current trace configuration */
293 trace_cfg_t *api_trace_cfg;
295 /** Current process PID */
298 /** Current binary api segment descriptor */
299 svm_region_t *vlib_rp;
301 /** Primary api segment descriptor */
302 svm_region_t *vlib_primary_rp;
304 /** Vector of all mapped shared-VM segments */
305 svm_region_t **vlib_private_rps;
306 svm_region_t **mapped_shmem_regions;
308 /** Binary API shared-memory segment header pointer */
309 struct vl_shmem_hdr_ *shmem_hdr;
311 /** vlib/vpp only: vector of client registrations */
312 vl_api_registration_t **vl_clients;
314 /** vlib/vpp only: serialized (message, name, crc) table */
315 u8 *serialized_message_table_in_shmem;
317 /** First available message ID, for theplugin msg allocator */
318 u16 first_available_msg_id;
320 /** Message range by name hash */
321 uword *msg_range_by_name;
323 /** vector of message ranges */
324 vl_api_msg_range_t *msg_ranges;
326 /** uid for the api shared memory region */
329 /** gid for the api shared memory region */
332 /** base virtual address for global VM region */
335 /** size of the global VM region */
338 /** size of the API region */
341 /** size of the global VM private mheap */
342 u64 global_pvt_heap_size;
344 /** size of the api private mheap */
345 u64 api_pvt_heap_size;
347 /** Peer input queue pointer */
348 svm_queue_t *vl_input_queue;
351 * All VLIB-side message handlers use my_client_index to identify
352 * the queue / client. This works in sim replay.
356 * This is the (shared VM) address of the registration,
357 * don't use it to id the connection since it can't possibly
358 * work in simulator replay.
360 vl_api_registration_t *my_registration;
362 /** vpp/vlib input queue length */
363 u32 vlib_input_queue_length;
365 /** client message index hash table */
366 uword *msg_index_by_name_and_crc;
368 /** api version list */
369 api_version_t *api_version_list;
371 /** Shared VM binary API region name */
372 const char *region_name;
374 /** Chroot path to the shared memory API files */
375 const char *root_path;
377 /** Replay in progress? */
378 int replay_in_progress;
380 /** Dump (msg-name, crc) snapshot here at startup */
381 u8 *save_msg_table_filename;
383 /** List of API client reaper functions */
384 _vl_msg_api_function_list_elt_t *reaper_function_registrations;
386 /** Bin API thread handle */
387 pthread_t rx_thread_handle;
390 elog_main_t *elog_main;
391 int elog_trace_api_messages;
393 /** performance counter callback **/
394 void (**perf_counter_cbs)
395 (struct api_main_t *, u32 id, int before_or_after);
396 void (**perf_counter_cbs_tmp)
397 (struct api_main_t *, u32 id, int before_or_after);
401 extern __thread api_main_t *my_api_main;
402 extern api_main_t api_global_main;
404 always_inline api_main_t *
405 vlibapi_get_main (void)
411 vlibapi_set_main (api_main_t * am)
416 #endif /* included_api_common_h */
419 * fd.io coding-style-patch-verification: ON
422 * eval: (c-set-style "gnu")