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 */
90 typedef CLIB_PACKED (struct
92 u8 endian; u8 wrapped;
94 }) vl_api_trace_file_header_t;
100 } vl_api_trace_which_t;
102 #define VL_API_LITTLE_ENDIAN 0x00
103 #define VL_API_BIG_ENDIAN 0x01
110 } vl_api_msg_range_t;
114 void (**msg_handlers) (void *);
115 int (**pd_msg_handlers) (void *, int);
116 void (**msg_cleanup_handlers) (void *);
117 void (**msg_endian_handlers) (void *);
118 void (**msg_print_handlers) (void *, void *);
122 struct ring_alloc_ *arings;
125 vl_api_trace_t *rx_trace;
126 vl_api_trace_t *tx_trace;
128 trace_cfg_t *api_trace_cfg;
130 svm_region_t *vlib_rp;
131 svm_region_t **mapped_shmem_regions;
132 struct vl_shmem_hdr_ *shmem_hdr;
133 vl_api_registration_t **vl_clients;
135 /* For plugin msg allocator */
136 u16 first_available_msg_id;
138 /* message range by name hash */
139 uword *msg_range_by_name;
141 /* vector of message ranges */
142 vl_api_msg_range_t *msg_ranges;
144 /* uid for the api shared memory region */
146 /* gid for the api shared memory region */
149 /* base virtual address for global VM region */
152 /* size of the global VM region */
155 /* size of the API region */
158 /* size of the global VM private mheap */
159 u64 global_pvt_heap_size;
161 /* size of the api private mheap */
162 u64 api_pvt_heap_size;
164 /* Client-only data structures */
165 unix_shared_memory_queue_t *vl_input_queue;
168 * All VLIB-side message handlers use my_client_index to identify
169 * the queue / client. This works in sim replay.
173 * This is the (shared VM) address of the registration,
174 * don't use it to id the connection since it can't possibly
175 * work in simulator replay.
177 vl_api_registration_t *my_registration;
200 } vl_msg_api_msg_config_t;
202 /* api_shared.c prototypes */
203 int vl_msg_api_rx_trace_enabled (api_main_t * am);
204 int vl_msg_api_tx_trace_enabled (api_main_t * am);
205 void vl_msg_api_trace (api_main_t * am, vl_api_trace_t * tp, void *msg);
206 int vl_msg_api_trace_onoff (api_main_t * am, vl_api_trace_which_t which,
208 int vl_msg_api_trace_free (api_main_t * am, vl_api_trace_which_t which);
209 int vl_msg_api_trace_save (api_main_t * am,
210 vl_api_trace_which_t which, FILE * fp);
211 int vl_msg_api_trace_configure (api_main_t * am, vl_api_trace_which_t which,
213 void vl_msg_api_handler_with_vm_node (api_main_t * am,
214 void *the_msg, vlib_main_t * vm,
215 vlib_node_runtime_t * node);
216 void vl_msg_api_handler (void *the_msg);
217 void vl_msg_api_handler_no_free (void *the_msg);
218 void vl_msg_api_handler_no_trace_no_free (void *the_msg);
219 void vl_msg_api_trace_only (void *the_msg);
220 void vl_msg_api_cleanup_handler (void *the_msg);
221 void vl_msg_api_replay_handler (void *the_msg);
222 void vl_msg_api_socket_handler (void *the_msg);
223 void vl_msg_api_set_handlers (int msg_id, char *msg_name,
227 void *print, int msg_size, int traced);
228 void vl_msg_api_config (vl_msg_api_msg_config_t *);
229 void vl_msg_api_set_cleanup_handler (int msg_id, void *fp);
230 void vl_msg_api_queue_handler (unix_shared_memory_queue_t * q);
231 vl_api_trace_t *vl_msg_api_trace_get (api_main_t * am,
232 vl_api_trace_which_t which);
234 void vl_msg_api_free (void *);
235 void vl_noop_handler (void *mp);
236 clib_error_t *vl_api_init (vlib_main_t * vm);
237 void vl_msg_api_increment_missing_client_counter (void);
238 void vl_msg_api_post_mortem_dump (void);
239 void vl_msg_api_register_pd_handler (void *handler,
240 u16 msg_id_host_byte_order);
241 int vl_msg_api_pd_handler (void *mp, int rv);
243 void vl_msg_api_set_first_available_msg_id (u16 first_avail);
244 u16 vl_msg_api_get_msg_ids (char *name, int n);
246 /* node_serialize.c prototypes */
247 u8 *vlib_node_serialize (vlib_node_main_t * nm, u8 * vector,
248 u32 max_threads, int include_nexts,
250 vlib_node_t **vlib_node_unserialize (u8 * vector);
252 #define VLIB_API_INIT_FUNCTION(x) VLIB_DECLARE_INIT_FUNCTION(x,api_init)
254 #endif /* included_api_h */
257 * fd.io coding-style-patch-verification: ON
260 * eval: (c-set-style "gnu")