FD.io VPP  v17.01.1-3-gc6833f8
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 /* *INDENT-OFF* */
91 typedef CLIB_PACKED
92 (struct
93  {
94  u8 endian; u8 wrapped;
95  u32 nitems;
96 }) vl_api_trace_file_header_t;
97 /* *INDENT-ON* */
98 
99 typedef enum
100 {
104 
105 #define VL_API_LITTLE_ENDIAN 0x00
106 #define VL_API_BIG_ENDIAN 0x01
107 
108 typedef struct
109 {
114 
115 typedef struct
116 {
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 *);
122  char **msg_names;
132  int our_pid;
137 
139 
140  /* For plugin msg allocator */
142 
143  /* message range by name hash */
145 
146  /* vector of message ranges */
148 
149  /* uid for the api shared memory region */
150  int api_uid;
151  /* gid for the api shared memory region */
152  int api_gid;
153 
154  /* base virtual address for global VM region */
156 
157  /* size of the global VM region */
159 
160  /* size of the API region */
162 
163  /* size of the global VM private mheap */
165 
166  /* size of the api private mheap */
168 
169  /* Client-only data structures */
171 
172  /*
173  * All VLIB-side message handlers use my_client_index to identify
174  * the queue / client. This works in sim replay.
175  */
177  /*
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.
181  */
183 
185 
186  /* client side message index hash table */
188 
189  char *region_name;
190  char *root_path;
191 } api_main_t;
192 
193 extern api_main_t api_main;
194 
195 typedef struct
196 {
197  int id;
198  char *name;
200  void *handler;
201  void *cleanup;
202  void *endian;
203  void *print;
204  int size;
205  int traced;
206  int replay;
210 
211 typedef struct msgbuf_
212 {
216  u8 data[0];
217 } msgbuf_t;
218 
219 /* api_shared.c prototypes */
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,
224  int onoff);
225 int vl_msg_api_trace_free (api_main_t * am, vl_api_trace_which_t which);
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,
229  u32 nitems);
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,
241  void *handler,
242  void *cleanup,
243  void *endian,
244  void *print, int msg_size, int traced);
246 void vl_msg_api_set_cleanup_handler (int msg_id, void *fp);
249  vl_api_trace_which_t which);
250 
251 void vl_msg_api_free (void *);
252 void vl_noop_handler (void *mp);
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);
259 
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);
264 
265 /* node_serialize.c prototypes */
266 u8 *vlib_node_serialize (vlib_node_main_t * nm, u8 * vector,
267  u32 max_threads, int include_nexts,
268  int include_stats);
270 
271 #define VLIB_API_INIT_FUNCTION(x) VLIB_DECLARE_INIT_FUNCTION(x,api_init)
272 
273 #endif /* included_api_h */
274 
275 /*
276  * fd.io coding-style-patch-verification: ON
277  *
278  * Local Variables:
279  * eval: (c-set-style "gnu")
280  * End:
281  */
u32 unix_file_index
Definition: api.h:56
u32 pad
Definition: api.h:215
u64 api_pvt_heap_size
Definition: api.h:167
char * region_name
Definition: api.h:189
u64 api_size
Definition: api.h:161
u8 wrapped
Definition: api.h:83
int size
Definition: api.h:71
int my_client_index
Definition: api.h:176
u8 * message_bounce
Definition: api.h:123
vlib_node_t ** vlib_node_unserialize(u8 *vector)
int api_uid
Definition: api.h:150
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:152
trace_cfg_t * api_trace_cfg
Definition: api.h:131
void vl_msg_api_config(vl_msg_api_msg_config_t *)
Definition: api_shared.c:660
void vl_msg_api_set_first_available_msg_id(u16 first_avail)
Definition: api_shared.c:1301
unix_shared_memory_queue_t * vl_input_queue
Definition: api.h:170
void vl_msg_api_post_mortem_dump(void)
Definition: api_shared.c:1231
struct vl_api_registration_ vl_api_registration_t
u8 pad
Definition: api.h:84
api_main_t api_main
Definition: api_shared.c:39
int our_pid
Definition: api.h:132
void vl_msg_api_handler_no_free(void *the_msg)
Definition: threads.c:344
vl_api_registration_t * my_registration
Definition: api.h:182
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:688
vl_api_trace_t * rx_trace
Definition: api.h:128
u32 ring_misses
Definition: api.h:126
void vl_msg_api_free(void *)
vl_api_registration_t ** vl_clients
Definition: api.h:136
int i32
Definition: types.h:81
char i8
Definition: types.h:45
svm_region_t * vlib_rp
Definition: api.h:133
unsigned long u64
Definition: types.h:89
struct vl_shmem_hdr_ * shmem_hdr
Definition: api.h:135
void vl_msg_api_cleanup_handler(void *the_msg)
Definition: api_shared.c:598
void vl_msg_api_replay_handler(void *the_msg)
Definition: api_shared.c:618
int vl_msg_api_trace_free(api_main_t *am, vl_api_trace_which_t which)
Definition: api_shared.c:172
vl_registration_type_t registration_type
Definition: api.h:40
u16 last_msg_id
Definition: api.h:112
int vl_msg_api_tx_trace_enabled(api_main_t *am)
Definition: api_shared.c:75
vl_api_trace_t * vl_msg_api_trace_get(api_main_t *am, vl_api_trace_which_t which)
Definition: api_shared.c:729
int replay_enable
Definition: api.h:73
u32 curindex
Definition: api.h:86
u32 unprocessed_msg_length
Definition: api.h:58
struct msgbuf_ msgbuf_t
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:473
int vl_msg_api_trace_save(api_main_t *am, vl_api_trace_which_t which, FILE *fp)
Definition: api_shared.c:209
u64 global_size
Definition: api.h:158
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:130
void vl_msg_api_set_cleanup_handler(int msg_id, void *fp)
Definition: api_shared.c:710
u64 global_baseva
Definition: api.h:155
unix_shared_memory_queue_t * vl_input_queue
Definition: api.h:53
unix_shared_memory_queue_t * q
Definition: api.h:213
vl_api_msg_range_t * msg_ranges
Definition: api.h:147
int vl_msg_api_pd_handler(void *mp, int rv)
Definition: api_shared.c:1280
void vl_msg_api_trace(api_main_t *am, vl_api_trace_t *tp, void *msg)
Definition: api_shared.c:84
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:1266
u8 ** traces
Definition: api.h:87
u32 vl_api_get_msg_index(u8 *name_and_crc)
vl_api_trace_which_t
Definition: api.h:99
vl_registration_type_t
Definition: api.h:29
void vl_msg_api_handler_no_trace_no_free(void *the_msg)
Definition: api_shared.c:570
vl_api_trace_t * tx_trace
Definition: api.h:129
unsigned int u32
Definition: types.h:88
u32 data_len
Definition: api.h:214
Definition: api.h:211
void vl_msg_api_add_msg_name_crc(api_main_t *am, char *string, u32 id)
Definition: api_shared.c:1353
u8 * serialized_message_table_in_shmem
Definition: api.h:138
typedef CLIB_PACKED(struct{u8 endian;u8 wrapped;u32 nitems;}) vl_api_trace_file_header_t
u64 global_pvt_heap_size
Definition: api.h:164
i8 * unprocessed_input
Definition: api.h:57
char ** msg_names
Definition: api.h:122
struct ring_alloc_ * arings
Definition: api.h:125
i32 vlib_signal
Definition: api.h:184
u64 uword
Definition: types.h:112
char * root_path
Definition: api.h:190
u32 missing_clients
Definition: api.h:127
unsigned short u16
Definition: types.h:57
void vl_msg_api_socket_handler(void *the_msg)
Definition: api_shared.c:639
u16 first_msg_id
Definition: api.h:111
unsigned char u8
Definition: types.h:56
void vl_msg_api_trace_only(void *the_msg)
Definition: api_shared.c:587
void vl_msg_api_handler(void *the_msg)
Definition: api_shared.c:549
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:69
u16 first_available_msg_id
Definition: api.h:141
void vl_msg_api_increment_missing_client_counter(void)
Definition: api_shared.c:54
u8 endian
Definition: api.h:81
u8 * is_mp_safe
Definition: api.h:124
void vl_noop_handler(void *mp)
Definition: api_shared.c:743
void vl_msg_api_queue_handler(unix_shared_memory_queue_t *q)
Definition: api_shared.c:720
int trace_enable
Definition: api.h:72
int msg_print_flag
Definition: api.h:130
u32 server_handle
Definition: api.h:62
u16 vl_msg_api_get_msg_ids(char *name, int n)
Definition: api_shared.c:1309
svm_region_t ** mapped_shmem_regions
Definition: api.h:134
uword * msg_index_by_name_and_crc
Definition: api.h:187
int vl_msg_api_trace_configure(api_main_t *am, vl_api_trace_which_t which, u32 nitems)
Definition: api_shared.c:340
uword * msg_range_by_name
Definition: api.h:144
u32 nitems
Definition: api.h:85
clib_error_t * vl_api_init(vlib_main_t *vm)
Definition: api_shared.c:748
struct _unix_shared_memory_queue unix_shared_memory_queue_t