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_h
21 #define included_api_h
23 #include <vppinfra/error.h>
25 #include <vlib/vlib.h>
26 #include <vlibmemory/unix_shared_memory_queue.h>
27 #include <vlib/unix/unix.h>
31 REGISTRATION_TYPE_FREE = 0,
32 REGISTRATION_TYPE_SHMEM,
33 REGISTRATION_TYPE_SOCKET_LISTEN,
34 REGISTRATION_TYPE_SOCKET_SERVER,
35 REGISTRATION_TYPE_SOCKET_CLIENT,
36 } vl_registration_type_t;
38 typedef struct vl_api_registration_
40 vl_registration_type_t registration_type;
42 /* Index in VLIB's brain (not shared memory). */
43 u32 vl_api_registration_pool_index;
48 * The following groups of data could be unioned, but my fingers are
49 * going to be sore enough.
52 /* shared memory only */
53 unix_shared_memory_queue_t *vl_input_queue;
55 /* socket server and client */
57 i8 *unprocessed_input;
58 u32 unprocessed_msg_length;
61 /* socket client only */
65 } vl_api_registration_t;
68 /* Trace configuration for a single message */
94 u8 endian; u8 wrapped;
96 }) vl_api_trace_file_header_t;
103 } vl_api_trace_which_t;
105 #define VL_API_LITTLE_ENDIAN 0x00
106 #define VL_API_BIG_ENDIAN 0x01
113 } vl_api_msg_range_t;
117 void (**msg_handlers) (void *);
118 int (**pd_msg_handlers) (void *, int);
119 void (**msg_cleanup_handlers) (void *);
120 void (**msg_endian_handlers) (void *);
121 void (**msg_print_handlers) (void *, void *);
125 struct ring_alloc_ *arings;
128 vl_api_trace_t *rx_trace;
129 vl_api_trace_t *tx_trace;
131 trace_cfg_t *api_trace_cfg;
133 svm_region_t *vlib_rp;
134 svm_region_t **mapped_shmem_regions;
135 struct vl_shmem_hdr_ *shmem_hdr;
136 vl_api_registration_t **vl_clients;
138 u8 *serialized_message_table_in_shmem;
140 /* For plugin msg allocator */
141 u16 first_available_msg_id;
143 /* message range by name hash */
144 uword *msg_range_by_name;
146 /* vector of message ranges */
147 vl_api_msg_range_t *msg_ranges;
149 /* uid for the api shared memory region */
151 /* gid for the api shared memory region */
154 /* base virtual address for global VM region */
157 /* size of the global VM region */
160 /* size of the API region */
163 /* size of the global VM private mheap */
164 u64 global_pvt_heap_size;
166 /* size of the api private mheap */
167 u64 api_pvt_heap_size;
169 /* Client-only data structures */
170 unix_shared_memory_queue_t *vl_input_queue;
173 * All VLIB-side message handlers use my_client_index to identify
174 * the queue / client. This works in sim replay.
178 * This is the (shared VM) address of the registration,
179 * don't use it to id the connection since it can't possibly
180 * work in simulator replay.
182 vl_api_registration_t *my_registration;
186 /* client side message index hash table */
187 uword *msg_index_by_name_and_crc;
193 extern api_main_t api_main;
209 } vl_msg_api_msg_config_t;
211 typedef struct msgbuf_
213 unix_shared_memory_queue_t *q;
219 /* api_shared.c prototypes */
220 int vl_msg_api_rx_trace_enabled (api_main_t * am);
221 int vl_msg_api_tx_trace_enabled (api_main_t * am);
222 void vl_msg_api_trace (api_main_t * am, vl_api_trace_t * tp, void *msg);
223 int vl_msg_api_trace_onoff (api_main_t * am, vl_api_trace_which_t which,
225 int vl_msg_api_trace_free (api_main_t * am, vl_api_trace_which_t which);
226 int vl_msg_api_trace_save (api_main_t * am,
227 vl_api_trace_which_t which, FILE * fp);
228 int vl_msg_api_trace_configure (api_main_t * am, vl_api_trace_which_t which,
230 void vl_msg_api_handler_with_vm_node (api_main_t * am,
231 void *the_msg, vlib_main_t * vm,
232 vlib_node_runtime_t * node);
233 void vl_msg_api_handler (void *the_msg);
234 void vl_msg_api_handler_no_free (void *the_msg);
235 void vl_msg_api_handler_no_trace_no_free (void *the_msg);
236 void vl_msg_api_trace_only (void *the_msg);
237 void vl_msg_api_cleanup_handler (void *the_msg);
238 void vl_msg_api_replay_handler (void *the_msg);
239 void vl_msg_api_socket_handler (void *the_msg);
240 void vl_msg_api_set_handlers (int msg_id, char *msg_name,
244 void *print, int msg_size, int traced);
245 void vl_msg_api_config (vl_msg_api_msg_config_t *);
246 void vl_msg_api_set_cleanup_handler (int msg_id, void *fp);
247 void vl_msg_api_queue_handler (unix_shared_memory_queue_t * q);
248 vl_api_trace_t *vl_msg_api_trace_get (api_main_t * am,
249 vl_api_trace_which_t which);
251 void vl_msg_api_free (void *);
252 void vl_noop_handler (void *mp);
253 clib_error_t *vl_api_init (vlib_main_t * vm);
254 void vl_msg_api_increment_missing_client_counter (void);
255 void vl_msg_api_post_mortem_dump (void);
256 void vl_msg_api_register_pd_handler (void *handler,
257 u16 msg_id_host_byte_order);
258 int vl_msg_api_pd_handler (void *mp, int rv);
260 void vl_msg_api_set_first_available_msg_id (u16 first_avail);
261 u16 vl_msg_api_get_msg_ids (char *name, int n);
262 void vl_msg_api_add_msg_name_crc (api_main_t * am, char *string, u32 id);
263 u32 vl_api_get_msg_index (u8 * name_and_crc);
265 /* node_serialize.c prototypes */
266 u8 *vlib_node_serialize (vlib_node_main_t * nm, u8 * vector,
267 u32 max_threads, int include_nexts,
269 vlib_node_t **vlib_node_unserialize (u8 * vector);
271 #define VLIB_API_INIT_FUNCTION(x) VLIB_DECLARE_INIT_FUNCTION(x,api_init)
273 #endif /* included_api_h */
276 * fd.io coding-style-patch-verification: ON
279 * eval: (c-set-style "gnu")