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 */
79 bool keepalive; /**< Dead client scan */
80 } vl_api_registration_t;
82 #define VL_API_INVALID_FI ((u32)~0)
89 u8 endian; /**< trace endianness */
90 u8 enabled; /**< trace is enabled */
91 u8 wrapped; /**< trace has wrapped */
93 u32 nitems; /**< Number of trace records */
94 u32 curindex; /**< Current index in circular buffer */
95 u8 **traces; /**< Trace ring */
98 /** Trace RX / TX enum */
103 } vl_api_trace_which_t;
105 #define VL_API_LITTLE_ENDIAN 0x00
106 #define VL_API_BIG_ENDIAN 0x01
108 /** Message range (belonging to a plugin) */
111 u8 *name; /**< name of the plugin */
112 u16 first_msg_id; /**< first assigned message ID */
113 u16 last_msg_id; /**< last assigned message ID */
114 } vl_api_msg_range_t;
116 /** Message configuration definition */
119 int id; /**< the message ID */
120 char *name; /**< the message name */
121 u32 crc; /**< message definition CRC */
122 void *handler; /**< the message handler */
123 void *cleanup; /**< non-default message cleanup handler */
124 void *endian; /**< message endian function */
125 void *format_fn; /**< message format function */
126 void *tojson; /**< binary to JSON convert function */
127 void *fromjson; /**< JSON to binary convert function */
128 void *calc_size; /**< message size calculation */
129 int size; /**< message size */
130 u32 traced : 1; /**< is this message to be traced? */
131 u32 replay : 1; /**< is this message to be replayed? */
132 u32 message_bounce : 1; /**< do not free message after processing */
133 u32 is_mp_safe : 1; /**< worker thread barrier required? */
134 u32 is_autoendian : 1; /**< endian conversion 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, uword msg_len);
168 void vl_msg_api_handler_no_free (void *the_msg, uword msg_len);
169 void vl_msg_api_handler_no_trace_no_free (void *the_msg, uword msg_len);
170 void vl_msg_api_trace_only (void *the_msg, uword msg_len);
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, uword msg_len);
174 void vl_msg_api_clean_handlers (int msg_id);
175 void vl_msg_api_config (vl_msg_api_msg_config_t *);
176 void vl_msg_api_set_cleanup_handler (int msg_id, void *fp);
177 void vl_msg_api_queue_handler (svm_queue_t * q);
179 void vl_msg_api_barrier_sync (void) __attribute__ ((weak));
180 void vl_msg_api_barrier_release (void) __attribute__ ((weak));
181 #ifdef BARRIER_TRACING
182 void vl_msg_api_barrier_trace_context (const char *context)
183 __attribute__ ((weak));
185 #define vl_msg_api_barrier_trace_context(X)
187 void vl_msg_api_free (void *);
188 void vl_msg_api_increment_missing_client_counter (void);
189 void vl_msg_api_post_mortem_dump (void);
190 void vl_msg_api_post_mortem_dump_enable_disable (int enable);
191 void vl_msg_api_register_pd_handler (void *handler,
192 u16 msg_id_host_byte_order);
194 void vl_msg_api_set_first_available_msg_id (u16 first_avail);
195 u16 vl_msg_api_get_msg_ids (const char *name, int n);
196 u32 vl_msg_api_get_msg_index (u8 * name_and_crc);
197 void *vl_msg_push_heap (void);
198 void *vl_msg_push_heap_w_region (svm_region_t * vlib_rp);
199 void vl_msg_pop_heap (void *oldheap);
200 void vl_msg_pop_heap_w_region (svm_region_t * vlib_rp, void *oldheap);
202 typedef clib_error_t *(vl_msg_api_init_function_t) (u32 client_index);
204 typedef struct _vl_msg_api_init_function_list_elt
206 struct _vl_msg_api_init_function_list_elt *next_init_function;
207 vl_msg_api_init_function_t *f;
208 } _vl_msg_api_function_list_elt_t;
220 /** Message handler vector */
221 void (*handler) (void *);
223 /** non-default message cleanup handler vector */
224 void (*cleanup_handler) (void *);
226 /** Message name vector */
229 /** Message format function */
230 format_function_t *format_fn;
232 /** Message convert function vector */
233 cJSON *(*tojson_handler) (void *);
235 /** Message convert function vector */
236 void *(*fromjson_handler) (cJSON *, int *);
238 /** Message endian handler vector. */
239 void (*endian_handler) (void *, bool to_net);
241 /** Message calc size function vector */
242 uword (*calc_size_func) (void *);
244 /** trace size for sanity checking */
248 u8 bounce : 1; /**> Don't automatically free message buffer vetor */
249 u8 is_mp_safe : 1; /**< Message is mp safe vector */
250 u8 is_autoendian : 1; /**< Message requires us to do endian conversion */
251 u8 trace_enable : 1; /**< trace this message */
252 u8 replay_allowed : 1; /**< This message can be replayed */
256 /** API main structure, used by both vpp and binary API clients */
257 typedef struct api_main_t
259 vl_api_msg_data_t *msg_data;
261 /** API message ID by name hash table */
262 uword *msg_id_by_name;
264 /** Allocator ring vectors (in shared memory) */
265 struct ring_alloc_ *arings;
267 /** Number of times that the ring allocator failed */
270 /** Number of garbage-collected message buffers */
271 u32 garbage_collects;
273 /** Number of missing clients / failed message sends */
276 /** Received message trace configuration */
277 vl_api_trace_t *rx_trace;
279 /** Sent message trace configuration */
280 vl_api_trace_t *tx_trace;
282 /** Print every received message */
285 /** Current process PID */
288 /** Current binary api segment descriptor */
289 svm_region_t *vlib_rp;
291 /** Primary api segment descriptor */
292 svm_region_t *vlib_primary_rp;
294 /** Vector of all mapped shared-VM segments */
295 svm_region_t **vlib_private_rps;
296 svm_region_t **mapped_shmem_regions;
298 /** Binary API shared-memory segment header pointer */
299 struct vl_shmem_hdr_ *shmem_hdr;
301 /** vlib/vpp only: vector of client registrations */
302 vl_api_registration_t **vl_clients;
304 /** vlib/vpp only: serialized (message, name, crc) table */
305 u8 *serialized_message_table_in_shmem;
307 /** First available message ID, for theplugin msg allocator */
308 u16 first_available_msg_id;
310 /** Message range by name hash */
311 uword *msg_range_by_name;
313 /** vector of message ranges */
314 vl_api_msg_range_t *msg_ranges;
316 /** uid for the api shared memory region */
319 /** gid for the api shared memory region */
322 /** base virtual address for global VM region */
325 /** size of the global VM region */
328 /** size of the API region */
331 /** size of the global VM private mheap */
332 u64 global_pvt_heap_size;
334 /** size of the api private mheap */
335 u64 api_pvt_heap_size;
337 /** Peer input queue pointer */
338 svm_queue_t *vl_input_queue;
341 * All VLIB-side message handlers use my_client_index to identify
342 * the queue / client. This works in sim replay.
346 * This is the (shared VM) address of the registration,
347 * don't use it to id the connection since it can't possibly
348 * work in simulator replay.
350 vl_api_registration_t *my_registration;
352 /** vpp/vlib input queue length */
353 u32 vlib_input_queue_length;
355 /** client message index hash table */
356 uword *msg_index_by_name_and_crc;
357 /** plugin JSON representation vector table */
360 /** api version list */
361 api_version_t *api_version_list;
363 /** Shared VM binary API region name */
364 const char *region_name;
366 /** Chroot path to the shared memory API files */
367 const char *root_path;
369 /** Replay in progress? */
370 int replay_in_progress;
372 /** Dump (msg-name, crc) snapshot here at startup */
373 u8 *save_msg_table_filename;
375 /** List of API client reaper functions */
376 _vl_msg_api_function_list_elt_t *reaper_function_registrations;
378 /** Bin API thread handle */
379 pthread_t rx_thread_handle;
382 elog_main_t *elog_main;
383 int elog_trace_api_messages;
385 /** performance counter callback **/
386 void (**perf_counter_cbs)
387 (struct api_main_t *, u32 id, int before_or_after);
388 void (**perf_counter_cbs_tmp)
389 (struct api_main_t *, u32 id, int before_or_after);
393 extern __thread api_main_t *my_api_main;
395 always_inline api_main_t *
396 vlibapi_get_main (void)
401 always_inline vl_api_msg_data_t *
402 vl_api_get_msg_data (api_main_t *am, u32 msg_id)
404 if (msg_id >= vec_len (am->msg_data))
406 return am->msg_data + msg_id;
410 vlibapi_set_main (api_main_t * am)
415 #endif /* included_api_common_h */
418 * fd.io coding-style-patch-verification: ON
421 * eval: (c-set-style "gnu")