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 <vlibapi/api_types.h>
31 #include <svm/svm_common.h>
32 #include <svm/queue.h>
34 /** API registration types
38 REGISTRATION_TYPE_FREE = 0,
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 */
43 } vl_registration_type_t;
45 /** An API client registration, only in vpp/vlib */
47 typedef struct vl_api_registration_
49 vl_registration_type_t registration_type; /**< type */
51 /** Index in VLIB's brain (not shared memory). */
52 u32 vl_api_registration_pool_index;
54 u8 *name; /**< Client name */
56 /* Zombie apocalypse checking */
61 /** shared memory only: pointer to client input queue */
62 svm_queue_t *vl_input_queue;
63 svm_region_t *vlib_rp;
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 */
71 int *additional_fds_to_close;
73 /* socket client only */
74 u32 server_handle; /**< Socket client only: server handle */
75 u32 server_index; /**< Socket client only: server index */
76 } vl_api_registration_t;
78 #define VL_API_INVALID_FI ((u32)~0)
80 /** Trace configuration for a single message */
83 int size; /**< for sanity checking */
84 int trace_enable; /**< trace this message */
85 int replay_enable; /**< This message can be replayed */
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 */
102 /** Trace RX / TX enum */
107 } vl_api_trace_which_t;
109 #define VL_API_LITTLE_ENDIAN 0x00
110 #define VL_API_BIG_ENDIAN 0x01
112 /** Message range (belonging to a plugin) */
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 */
118 } vl_api_msg_range_t;
120 /** Message configuration definition */
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 } vl_msg_api_msg_config_t;
137 /** Message header structure */
138 typedef struct msgbuf_
140 svm_queue_t *q; /**< message allocated in this shmem ring */
141 u32 data_len; /**< message length not including header */
142 u32 gc_mark_timestamp; /**< message garbage collector mark TS */
143 u8 data[0]; /**< actual message begins here */
146 CLIB_NOSANITIZE_ADDR static inline void
147 VL_MSG_API_UNPOISON (const void *a)
149 const msgbuf_t *m = &((const msgbuf_t *) a)[-1];
150 CLIB_MEM_UNPOISON (m, sizeof (*m) + ntohl (m->data_len));
153 CLIB_NOSANITIZE_ADDR static inline void
154 VL_MSG_API_SVM_QUEUE_UNPOISON (const svm_queue_t * q)
156 CLIB_MEM_UNPOISON (q, sizeof (*q) + q->elsize * q->maxsize);
160 VL_MSG_API_POISON (const void *a)
162 const msgbuf_t *m = &((const msgbuf_t *) a)[-1];
163 CLIB_MEM_POISON (m, sizeof (*m) + ntohl (m->data_len));
166 /* api_shared.c prototypes */
167 void vl_msg_api_handler (void *the_msg);
168 void vl_msg_api_handler_no_free (void *the_msg);
169 void vl_msg_api_handler_no_trace_no_free (void *the_msg);
170 void vl_msg_api_trace_only (void *the_msg);
171 void vl_msg_api_cleanup_handler (void *the_msg);
172 void vl_msg_api_replay_handler (void *the_msg);
173 void vl_msg_api_socket_handler (void *the_msg);
174 void vl_msg_api_set_handlers (int msg_id, char *msg_name,
178 void *print, int msg_size, int traced);
179 void vl_msg_api_clean_handlers (int msg_id);
180 void vl_msg_api_config (vl_msg_api_msg_config_t *);
181 void vl_msg_api_set_cleanup_handler (int msg_id, void *fp);
182 void vl_msg_api_queue_handler (svm_queue_t * q);
184 void vl_msg_api_barrier_sync (void) __attribute__ ((weak));
185 void vl_msg_api_barrier_release (void) __attribute__ ((weak));
186 #ifdef BARRIER_TRACING
187 void vl_msg_api_barrier_trace_context (const char *context)
188 __attribute__ ((weak));
190 #define vl_msg_api_barrier_trace_context(X)
192 void vl_msg_api_free (void *);
193 void vl_noop_handler (void *mp);
194 void vl_msg_api_increment_missing_client_counter (void);
195 void vl_msg_api_post_mortem_dump (void);
196 void vl_msg_api_post_mortem_dump_enable_disable (int enable);
197 void vl_msg_api_register_pd_handler (void *handler,
198 u16 msg_id_host_byte_order);
199 int vl_msg_api_pd_handler (void *mp, int rv);
201 void vl_msg_api_set_first_available_msg_id (u16 first_avail);
202 u16 vl_msg_api_get_msg_ids (const char *name, int n);
203 u32 vl_msg_api_get_msg_index (u8 * name_and_crc);
204 void *vl_msg_push_heap (void);
205 void *vl_msg_push_heap_w_region (svm_region_t * vlib_rp);
206 void vl_msg_pop_heap (void *oldheap);
207 void vl_msg_pop_heap_w_region (svm_region_t * vlib_rp, void *oldheap);
209 typedef clib_error_t *(vl_msg_api_init_function_t) (u32 client_index);
211 typedef struct _vl_msg_api_init_function_list_elt
213 struct _vl_msg_api_init_function_list_elt *next_init_function;
214 vl_msg_api_init_function_t *f;
215 } _vl_msg_api_function_list_elt_t;
225 /** API main structure, used by both vpp and binary API clients */
228 /** Message handler vector */
229 void (**msg_handlers) (void *);
230 /** Plaform-dependent (aka hardware) message handler vector */
231 int (**pd_msg_handlers) (void *, int);
233 /** non-default message cleanup handler vector */
234 void (**msg_cleanup_handlers) (void *);
236 /** Message endian handler vector */
237 void (**msg_endian_handlers) (void *);
239 /** Message print function vector */
240 void (**msg_print_handlers) (void *, void *);
242 /** Message name vector */
243 const char **msg_names;
245 /** Don't automatically free message buffer vetor */
248 /** Message is mp safe vector */
251 /** Allocator ring vectors (in shared memory) */
252 struct ring_alloc_ *arings;
254 /** Number of times that the ring allocator failed */
257 /** Number of garbage-collected message buffers */
258 u32 garbage_collects;
260 /** Number of missing clients / failed message sends */
263 /** Received message trace configuration */
264 vl_api_trace_t *rx_trace;
266 /** Sent message trace configuration */
267 vl_api_trace_t *tx_trace;
269 /** Print every received message */
272 /** Current trace configuration */
273 trace_cfg_t *api_trace_cfg;
275 /** Current process PID */
278 /** Current binary api segment descriptor */
279 svm_region_t *vlib_rp;
281 /** Primary api segment descriptor */
282 svm_region_t *vlib_primary_rp;
284 /** Vector of all mapped shared-VM segments */
285 svm_region_t **vlib_private_rps;
286 svm_region_t **mapped_shmem_regions;
288 /** Binary API shared-memory segment header pointer */
289 struct vl_shmem_hdr_ *shmem_hdr;
291 /** vlib/vpp only: vector of client registrations */
292 vl_api_registration_t **vl_clients;
294 /** vlib/vpp only: serialized (message, name, crc) table */
295 u8 *serialized_message_table_in_shmem;
297 /** First available message ID, for theplugin msg allocator */
298 u16 first_available_msg_id;
300 /** Message range by name hash */
301 uword *msg_range_by_name;
303 /** vector of message ranges */
304 vl_api_msg_range_t *msg_ranges;
306 /** uid for the api shared memory region */
309 /** gid for the api shared memory region */
312 /** base virtual address for global VM region */
315 /** size of the global VM region */
318 /** size of the API region */
321 /** size of the global VM private mheap */
322 u64 global_pvt_heap_size;
324 /** size of the api private mheap */
325 u64 api_pvt_heap_size;
327 /** Peer input queue pointer */
328 svm_queue_t *vl_input_queue;
331 * All VLIB-side message handlers use my_client_index to identify
332 * the queue / client. This works in sim replay.
336 * This is the (shared VM) address of the registration,
337 * don't use it to id the connection since it can't possibly
338 * work in simulator replay.
340 vl_api_registration_t *my_registration;
342 /** vpp/vlib input queue length */
343 u32 vlib_input_queue_length;
345 /** client message index hash table */
346 uword *msg_index_by_name_and_crc;
348 /** api version list */
349 api_version_t *api_version_list;
351 /** Shared VM binary API region name */
352 const char *region_name;
354 /** Chroot path to the shared memory API files */
355 const char *root_path;
357 /** Replay in progress? */
358 int replay_in_progress;
360 /** Dump (msg-name, crc) snapshot here at startup */
361 u8 *save_msg_table_filename;
363 /** List of API client reaper functions */
364 _vl_msg_api_function_list_elt_t *reaper_function_registrations;
366 /** Bin API thread handle */
367 pthread_t rx_thread_handle;
370 elog_main_t *elog_main;
371 int elog_trace_api_messages;
375 extern __thread api_main_t *my_api_main;
376 extern api_main_t api_global_main;
378 always_inline api_main_t *
379 vlibapi_get_main (void)
385 vlibapi_set_main (api_main_t * am)
390 #endif /* included_api_common_h */
393 * fd.io coding-style-patch-verification: ON
396 * eval: (c-set-style "gnu")