FD.io VPP  v16.12-rc0-308-g931be3a
Vector Packet Processing
api.h
Go to the documentation of this file.
1 /*
2  *------------------------------------------------------------------
3  * api.h
4  *
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:
9  *
10  * http://www.apache.org/licenses/LICENSE-2.0
11  *
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  *------------------------------------------------------------------
18  */
19 
20 #ifndef included_api_h
21 #define included_api_h
22 
23 #include <vppinfra/error.h>
24 #include <svm.h>
25 #include <vlib/vlib.h>
27 #include <vlib/unix/unix.h>
28 
29 typedef enum
30 {
37 
38 typedef struct vl_api_registration_
39 {
40  vl_registration_type_t registration_type;
41 
42  /* Index in VLIB's brain (not shared memory). */
44 
45  u8 *name;
46 
47  /*
48  * The following groups of data could be unioned, but my fingers are
49  * going to be sore enough.
50  */
51 
52  /* shared memory only */
54 
55  /* socket server and client */
60 
61  /* socket client only */
64 
66 
67 
68 /* Trace configuration for a single message */
69 typedef struct
70 {
71  int size;
74 } trace_cfg_t;
75 
76 /*
77  * API recording
78  */
79 typedef struct
80 {
89 
90 typedef CLIB_PACKED (struct
91  {
92  u8 endian; u8 wrapped;
93  u32 nitems;
94  }) vl_api_trace_file_header_t;
95 
96 typedef enum
97 {
101 
102 #define VL_API_LITTLE_ENDIAN 0x00
103 #define VL_API_BIG_ENDIAN 0x01
104 
105 typedef struct
106 {
111 
112 typedef struct
113 {
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 *);
119  char **msg_names;
129  int our_pid;
134 
135  /* For plugin msg allocator */
137 
138  /* message range by name hash */
140 
141  /* vector of message ranges */
143 
144  /* uid for the api shared memory region */
145  int api_uid;
146  /* gid for the api shared memory region */
147  int api_gid;
148 
149  /* base virtual address for global VM region */
151 
152  /* size of the global VM region */
154 
155  /* size of the API region */
157 
158  /* size of the global VM private mheap */
160 
161  /* size of the api private mheap */
163 
164  /* Client-only data structures */
166 
167  /*
168  * All VLIB-side message handlers use my_client_index to identify
169  * the queue / client. This works in sim replay.
170  */
172  /*
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.
176  */
178 
180 
181  char *region_name;
182  char *root_path;
183 } api_main_t;
184 
186 
187 typedef struct
188 {
189  int id;
190  char *name;
191  void *handler;
192  void *cleanup;
193  void *endian;
194  void *print;
195  int size;
196  int traced;
197  int replay;
201 
202 /* api_shared.c prototypes */
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,
207  int onoff);
208 int vl_msg_api_trace_free (api_main_t * am, vl_api_trace_which_t which);
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,
212  u32 nitems);
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,
224  void *handler,
225  void *cleanup,
226  void *endian,
227  void *print, int msg_size, int traced);
229 void vl_msg_api_set_cleanup_handler (int msg_id, void *fp);
232  vl_api_trace_which_t which);
233 
234 void vl_msg_api_free (void *);
235 void vl_noop_handler (void *mp);
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);
242 
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);
245 
246 /* node_serialize.c prototypes */
247 u8 *vlib_node_serialize (vlib_node_main_t * nm, u8 * vector,
248  u32 max_threads, int include_nexts,
249  int include_stats);
251 
252 #define VLIB_API_INIT_FUNCTION(x) VLIB_DECLARE_INIT_FUNCTION(x,api_init)
253 
254 #endif /* included_api_h */
255 
256 /*
257  * fd.io coding-style-patch-verification: ON
258  *
259  * Local Variables:
260  * eval: (c-set-style "gnu")
261  * End:
262  */
u32 unix_file_index
Definition: api.h:56
u64 api_pvt_heap_size
Definition: api.h:162
char * region_name
Definition: api.h:181
u64 api_size
Definition: api.h:156
u8 wrapped
Definition: api.h:83
int size
Definition: api.h:71
int my_client_index
Definition: api.h:171
u8 * message_bounce
Definition: api.h:120
vlib_node_t ** vlib_node_unserialize(u8 *vector)
int api_uid
Definition: api.h:145
u32 server_index
Definition: api.h:63
u8 * vlib_node_serialize(vlib_node_main_t *nm, u8 *vector, u32 max_threads, int include_nexts, int include_stats)
int api_gid
Definition: api.h:147
trace_cfg_t * api_trace_cfg
Definition: api.h:128
void vl_msg_api_config(vl_msg_api_msg_config_t *)
Definition: api_shared.c:631
void vl_msg_api_set_first_available_msg_id(u16 first_avail)
Definition: api_shared.c:1261
unix_shared_memory_queue_t * vl_input_queue
Definition: api.h:165
void vl_msg_api_post_mortem_dump(void)
Definition: api_shared.c:1191
struct vl_api_registration_ vl_api_registration_t
u8 pad
Definition: api.h:84
api_main_t api_main
Definition: api.h:185
int our_pid
Definition: api.h:129
void vl_msg_api_handler_no_free(void *the_msg)
Definition: threads.c:347
vl_api_registration_t * my_registration
Definition: api.h:177
void vl_msg_api_set_handlers(int msg_id, char *msg_name, void *handler, void *cleanup, void *endian, void *print, int msg_size, int traced)
Definition: api_shared.c:659
vl_api_trace_t * rx_trace
Definition: api.h:125
u32 ring_misses
Definition: api.h:123
void vl_msg_api_free(void *)
vl_api_registration_t ** vl_clients
Definition: api.h:133
int i32
Definition: types.h:81
char i8
Definition: types.h:45
svm_region_t * vlib_rp
Definition: api.h:130
unsigned long u64
Definition: types.h:89
struct vl_shmem_hdr_ * shmem_hdr
Definition: api.h:132
void vl_msg_api_cleanup_handler(void *the_msg)
Definition: api_shared.c:569
void vl_msg_api_replay_handler(void *the_msg)
Definition: api_shared.c:589
int vl_msg_api_trace_free(api_main_t *am, vl_api_trace_which_t which)
Definition: api_shared.c:167
vl_registration_type_t registration_type
Definition: api.h:40
u16 last_msg_id
Definition: api.h:109
int vl_msg_api_tx_trace_enabled(api_main_t *am)
Definition: api_shared.c:74
vl_api_trace_t * vl_msg_api_trace_get(api_main_t *am, vl_api_trace_which_t which)
Definition: api_shared.c:699
int replay_enable
Definition: api.h:73
u32 curindex
Definition: api.h:86
u32 unprocessed_msg_length
Definition: api.h:58
void vl_msg_api_handler_with_vm_node(api_main_t *am, void *the_msg, vlib_main_t *vm, vlib_node_runtime_t *node)
Definition: api_shared.c:444
int vl_msg_api_trace_save(api_main_t *am, vl_api_trace_which_t which, FILE *fp)
Definition: api_shared.c:204
u64 global_size
Definition: api.h:153
u8 enabled
Definition: api.h:82
int vl_msg_api_trace_onoff(api_main_t *am, vl_api_trace_which_t which, int onoff)
Definition: api_shared.c:125
void vl_msg_api_set_cleanup_handler(int msg_id, void *fp)
Definition: api_shared.c:680
u64 global_baseva
Definition: api.h:150
unix_shared_memory_queue_t * vl_input_queue
Definition: api.h:53
vl_api_msg_range_t * msg_ranges
Definition: api.h:142
int vl_msg_api_pd_handler(void *mp, int rv)
Definition: api_shared.c:1240
void vl_msg_api_trace(api_main_t *am, vl_api_trace_t *tp, void *msg)
Definition: api_shared.c:83
u8 * output_vector
Definition: api.h:59
void vl_msg_api_register_pd_handler(void *handler, u16 msg_id_host_byte_order)
Definition: api_shared.c:1226
u8 ** traces
Definition: api.h:87
vl_api_trace_which_t
Definition: api.h:96
vl_registration_type_t
Definition: api.h:29
void vl_msg_api_handler_no_trace_no_free(void *the_msg)
Definition: api_shared.c:541
vl_api_trace_t * tx_trace
Definition: api.h:126
unsigned int u32
Definition: types.h:88
typedef CLIB_PACKED(struct{u8 endian;u8 wrapped;u32 nitems;}) vl_api_trace_file_header_t
u64 global_pvt_heap_size
Definition: api.h:159
i8 * unprocessed_input
Definition: api.h:57
char ** msg_names
Definition: api.h:119
struct ring_alloc_ * arings
Definition: api.h:122
i32 vlib_signal
Definition: api.h:179
u64 uword
Definition: types.h:112
char * root_path
Definition: api.h:182
u32 missing_clients
Definition: api.h:124
unsigned short u16
Definition: types.h:57
void vl_msg_api_socket_handler(void *the_msg)
Definition: api_shared.c:610
u16 first_msg_id
Definition: api.h:108
unsigned char u8
Definition: types.h:56
void vl_msg_api_trace_only(void *the_msg)
Definition: api_shared.c:558
void vl_msg_api_handler(void *the_msg)
Definition: api_shared.c:520
u32 vl_api_registration_pool_index
Definition: api.h:43
int vl_msg_api_rx_trace_enabled(api_main_t *am)
Definition: api_shared.c:68
u16 first_available_msg_id
Definition: api.h:136
void vl_msg_api_increment_missing_client_counter(void)
Definition: api_shared.c:53
u8 endian
Definition: api.h:81
u8 * is_mp_safe
Definition: api.h:121
void vl_noop_handler(void *mp)
Definition: api_shared.c:713
void vl_msg_api_queue_handler(unix_shared_memory_queue_t *q)
Definition: api_shared.c:690
int trace_enable
Definition: api.h:72
int msg_print_flag
Definition: api.h:127
u32 server_handle
Definition: api.h:62
u16 vl_msg_api_get_msg_ids(char *name, int n)
Definition: api_shared.c:1269
svm_region_t ** mapped_shmem_regions
Definition: api.h:131
int vl_msg_api_trace_configure(api_main_t *am, vl_api_trace_which_t which, u32 nitems)
Definition: api_shared.c:311
uword * msg_range_by_name
Definition: api.h:139
u32 nitems
Definition: api.h:85
clib_error_t * vl_api_init(vlib_main_t *vm)
Definition: api_shared.c:718
struct _unix_shared_memory_queue unix_shared_memory_queue_t