FD.io VPP  v18.01-8-g0eacf49
Vector Packet Processing
api_common.h
Go to the documentation of this file.
1 /*
2  *------------------------------------------------------------------
3  * api_common.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_common_h
21 #define included_api_common_h
22 
23 /** \file API common definitions
24  * See api_doc.md for more info
25  */
26 
27 #include <vppinfra/clib_error.h>
28 #include <svm/svm_common.h>
30 
31 /** API registration types
32  */
33 typedef enum
34 {
36  REGISTRATION_TYPE_SHMEM, /**< Shared memory connection */
37  REGISTRATION_TYPE_SOCKET_LISTEN, /**< Socket listener */
38  REGISTRATION_TYPE_SOCKET_SERVER, /**< Socket server */
39  REGISTRATION_TYPE_SOCKET_CLIENT, /**< Socket client */
41 
42 /** An API client registration, only in vpp/vlib */
43 
44 typedef struct vl_api_registration_
45 {
46  vl_registration_type_t registration_type; /**< type */
47 
48  /** Index in VLIB's brain (not shared memory). */
50 
51  u8 *name; /**< Client name */
52 
53  /* Zombie apocalypse checking */
57 
58  /** shared memory only: pointer to client input queue */
61  void *shmem_hdr;
62 
63  /* socket server and client */
64  u32 clib_file_index; /**< Socket only: file index */
65  i8 *unprocessed_input; /**< Socket only: pending input */
66  u32 unprocessed_msg_length; /**< Socket only: unprocssed length */
67  u8 *output_vector; /**< Socket only: output vecto */
69 
70  /* socket client only */
71  u32 server_handle; /**< Socket client only: server handle */
72  u32 server_index; /**< Socket client only: server index */
74 
75 
76 /** Trace configuration for a single message */
77 typedef struct
78 {
79  int size; /**< for sanity checking */
80  int trace_enable; /**< trace this message */
81  int replay_enable; /**< This message can be replayed */
82 } trace_cfg_t;
83 
84 /**
85  * API trace state
86  */
87 typedef struct
88 {
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 */
97 
98 /** Trace RX / TX enum */
99 typedef enum
100 {
104 
105 #define VL_API_LITTLE_ENDIAN 0x00
106 #define VL_API_BIG_ENDIAN 0x01
107 
108 /** Message range (belonging to a plugin) */
109 typedef struct
110 {
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 */
115 
116 /** Message configuration definition */
117 typedef struct
118 {
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 *print; /**< message print function */
126  int size; /**< message size */
127  int traced; /**< is this message to be traced? */
128  int replay; /**< is this message to be replayed? */
129  int message_bounce; /**< do not free message after processing */
130  int is_mp_safe; /**< worker thread barrier required? */
132 
133 /** Message header structure */
134 typedef struct msgbuf_
135 {
136  unix_shared_memory_queue_t *q; /**< message allocated in this shmem ring */
137  u32 data_len; /**< message length not including header */
138  u32 gc_mark_timestamp; /**< message garbage collector mark TS */
139  u8 data[0]; /**< actual message begins here */
140 } msgbuf_t;
141 
142 /* api_shared.c prototypes */
143 void vl_msg_api_handler (void *the_msg);
144 void vl_msg_api_handler_no_free (void *the_msg);
145 void vl_msg_api_handler_no_trace_no_free (void *the_msg);
146 void vl_msg_api_trace_only (void *the_msg);
147 void vl_msg_api_cleanup_handler (void *the_msg);
148 void vl_msg_api_replay_handler (void *the_msg);
149 void vl_msg_api_socket_handler (void *the_msg);
150 void vl_msg_api_set_handlers (int msg_id, char *msg_name,
151  void *handler,
152  void *cleanup,
153  void *endian,
154  void *print, int msg_size, int traced);
155 void vl_msg_api_clean_handlers (int msg_id);
157 void vl_msg_api_set_cleanup_handler (int msg_id, void *fp);
159 
160 void vl_msg_api_barrier_sync (void) __attribute__ ((weak));
161 void vl_msg_api_barrier_release (void) __attribute__ ((weak));
162 #ifdef BARRIER_TRACING
163 void vl_msg_api_barrier_trace_context (const char *context)
164  __attribute__ ((weak));
165 #else
166 #define vl_msg_api_barrier_trace_context(X)
167 #endif
168 void vl_msg_api_free (void *);
169 void vl_noop_handler (void *mp);
171 void vl_msg_api_post_mortem_dump (void);
173 void vl_msg_api_register_pd_handler (void *handler,
174  u16 msg_id_host_byte_order);
175 int vl_msg_api_pd_handler (void *mp, int rv);
176 
177 void vl_msg_api_set_first_available_msg_id (u16 first_avail);
178 u16 vl_msg_api_get_msg_ids (const char *name, int n);
179 u32 vl_api_get_msg_index (u8 * name_and_crc);
180 
181 typedef clib_error_t *(vl_msg_api_init_function_t) (u32 client_index);
182 
183 typedef struct _vl_msg_api_init_function_list_elt
184 {
185  struct _vl_msg_api_init_function_list_elt *next_init_function;
187 } _vl_msg_api_function_list_elt_t;
188 
189 typedef struct
190 {
194  char name[64];
195 } api_version_t;
196 
197 /** API main structure, used by both vpp and binary API clients */
198 typedef struct
199 {
200  /** Message handler vector */
201  void (**msg_handlers) (void *);
202  /** Plaform-dependent (aka hardware) message handler vector */
203  int (**pd_msg_handlers) (void *, int);
204 
205  /** non-default message cleanup handler vector */
206  void (**msg_cleanup_handlers) (void *);
207 
208  /** Message endian handler vector */
209  void (**msg_endian_handlers) (void *);
210 
211  /** Message print function vector */
212  void (**msg_print_handlers) (void *, void *);
213 
214  /** Message name vector */
215  const char **msg_names;
216 
217  /** Don't automatically free message buffer vetor */
219 
220  /** Message is mp safe vector */
222 
223  /** Allocator ring vectors (in shared memory) */
225 
226  /** Number of times that the ring allocator failed */
228 
229  /** Number of garbage-collected message buffers */
231 
232  /** Number of missing clients / failed message sends */
234 
235  /** Received message trace configuration */
237 
238  /** Sent message trace configuration */
240 
241  /** Print every received message */
243 
244  /** Current trace configuration */
246 
247  /** Current process PID */
248  int our_pid;
249 
250  /** Current binary api segment descriptor */
252 
253  /** Primary api segment descriptor */
255 
256  /** Vector of all mapped shared-VM segments */
259 
260  /** Binary API shared-memory segment header pointer */
262 
263  /** vlib/vpp only: vector of client registrations */
265 
266  /** vlib/vpp only: serialized (message, name, crc) table */
268 
269  /** First available message ID, for theplugin msg allocator */
271 
272  /** Message range by name hash */
274 
275  /** vector of message ranges */
277 
278  /** uid for the api shared memory region */
279  int api_uid;
280 
281  /** gid for the api shared memory region */
282  int api_gid;
283 
284  /** base virtual address for global VM region */
286 
287  /** size of the global VM region */
289 
290  /** size of the API region */
292 
293  /** size of the global VM private mheap */
295 
296  /** size of the api private mheap */
298 
299  /** Peer input queue pointer */
301 
302  /**
303  * All VLIB-side message handlers use my_client_index to identify
304  * the queue / client. This works in sim replay.
305  */
307  /**
308  * This is the (shared VM) address of the registration,
309  * don't use it to id the connection since it can't possibly
310  * work in simulator replay.
311  */
313 
314  /** (Historical) signal-based queue non-empty signal, to be removed */
316 
317  /** vpp/vlib input queue length */
319 
320  /** client message index hash table */
322 
323  /** api version list */
325 
326  /** Shared VM binary API region name */
327  const char *region_name;
328 
329  /** Chroot path to the shared memory API files */
330  const char *root_path;
331 
332  /** Replay in progress? */
334 
335  /** Dump (msg-name, crc) snapshot here at startup */
337 
338  /** List of API client reaper functions */
339  _vl_msg_api_function_list_elt_t *reaper_function_registrations;
340 
341 } api_main_t;
342 
343 extern api_main_t api_main;
344 
345 #endif /* included_api_common_h */
346 
347 /*
348  * fd.io coding-style-patch-verification: ON
349  *
350  * Local Variables:
351  * eval: (c-set-style "gnu")
352  * End:
353  */
Message range (belonging to a plugin)
Definition: api_common.h:109
void vl_msg_api_config(vl_msg_api_msg_config_t *)
Definition: api_shared.c:664
u64 api_pvt_heap_size
size of the api private mheap
Definition: api_common.h:297
u16 vl_msg_api_get_msg_ids(const char *name, int n)
Definition: api_shared.c:872
u8 * name
Client name.
Definition: api_common.h:51
int id
the message ID
Definition: api_common.h:119
u8 * name
name of the plugin
Definition: api_common.h:111
struct msgbuf_ msgbuf_t
Message header structure.
void * print
message print function
Definition: api_common.h:125
u64 api_size
size of the API region
Definition: api_common.h:291
u8 wrapped
trace has wrapped
Definition: api_common.h:91
int size
for sanity checking
Definition: api_common.h:79
int my_client_index
All VLIB-side message handlers use my_client_index to identify the queue / client.
Definition: api_common.h:306
u32 crc
message definition CRC
Definition: api_common.h:121
u8 * message_bounce
Don&#39;t automatically free message buffer vetor.
Definition: api_common.h:218
Message configuration definition.
Definition: api_common.h:117
u32 gc_mark_timestamp
message garbage collector mark TS
Definition: api_common.h:138
svm_region_t * vlib_primary_rp
Primary api segment descriptor.
Definition: api_common.h:254
api_version_t * api_version_list
api version list
Definition: api_common.h:324
int api_uid
uid for the api shared memory region
Definition: api_common.h:279
u32 server_index
Socket client only: server index.
Definition: api_common.h:72
int api_gid
gid for the api shared memory region
Definition: api_common.h:282
void * cleanup
non-default message cleanup handler
Definition: api_common.h:123
trace_cfg_t * api_trace_cfg
Current trace configuration.
Definition: api_common.h:245
int size
message size
Definition: api_common.h:126
unix_shared_memory_queue_t * vl_input_queue
Peer input queue pointer.
Definition: api_common.h:300
_vl_msg_api_function_list_elt_t * reaper_function_registrations
List of API client reaper functions.
Definition: api_common.h:339
int our_pid
Current process PID.
Definition: api_common.h:248
u32 clib_file_index
Socket only: file index.
Definition: api_common.h:64
void vl_msg_api_set_cleanup_handler(int msg_id, void *fp)
Definition: api_shared.c:747
void * endian
message endian function
Definition: api_common.h:124
vl_api_registration_t * my_registration
This is the (shared VM) address of the registration, don&#39;t use it to id the connection since it can&#39;t...
Definition: api_common.h:312
vl_api_trace_t * rx_trace
Received message trace configuration.
Definition: api_common.h:236
void vl_msg_api_handler_no_trace_no_free(void *the_msg)
Definition: api_shared.c:568
u32 ring_misses
Number of times that the ring allocator failed.
Definition: api_common.h:227
#define vl_msg_api_barrier_trace_context(X)
Definition: api_common.h:166
vl_api_registration_t ** vl_clients
vlib/vpp only: vector of client registrations
Definition: api_common.h:264
int i32
Definition: types.h:81
char i8
Definition: types.h:45
int replay_in_progress
Replay in progress?
Definition: api_common.h:333
const char * root_path
Chroot path to the shared memory API files.
Definition: api_common.h:330
svm_region_t * vlib_rp
Current binary api segment descriptor.
Definition: api_common.h:251
unsigned long u64
Definition: types.h:89
struct vl_shmem_hdr_ * shmem_hdr
Binary API shared-memory segment header pointer.
Definition: api_common.h:261
void vl_msg_api_set_first_available_msg_id(u16 first_avail)
Definition: api_shared.c:864
void vl_msg_api_post_mortem_dump(void)
Definition: api_shared.c:794
u32 vl_api_get_msg_index(u8 *name_and_crc)
vl_registration_type_t registration_type
type
Definition: api_common.h:46
u16 last_msg_id
last assigned message ID
Definition: api_common.h:113
struct vl_api_registration_ vl_api_registration_t
An API client registration, only in vpp/vlib.
int replay_enable
This message can be replayed.
Definition: api_common.h:81
void vl_msg_api_free(void *)
int message_bounce
do not free message after processing
Definition: api_common.h:129
void vl_msg_api_handler(void *the_msg)
Definition: api_shared.c:547
u32 curindex
Current index in circular buffer.
Definition: api_common.h:94
static void cleanup(void)
Definition: client.c:90
void vl_msg_api_trace_only(void *the_msg)
Definition: api_shared.c:585
svm_region_t ** vlib_private_rps
Vector of all mapped shared-VM segments.
Definition: api_common.h:257
void vl_msg_api_barrier_sync(void)
Definition: api_shared.c:383
u32 unprocessed_msg_length
Socket only: unprocssed length.
Definition: api_common.h:66
void vl_msg_api_clean_handlers(int msg_id)
Definition: api_shared.c:735
void vl_msg_api_socket_handler(void *the_msg)
Definition: api_shared.c:643
API main structure, used by both vpp and binary API clients.
Definition: api_common.h:198
u64 global_size
size of the global VM region
Definition: api_common.h:288
u8 enabled
trace is enabled
Definition: api_common.h:90
An API client registration, only in vpp/vlib.
Definition: api_common.h:44
api_main_t api_main
Definition: api_shared.c:35
API trace state.
Definition: api_common.h:87
vl_registration_type_t
API registration types.
Definition: api_common.h:33
void vl_msg_api_handler_no_free(void *the_msg)
Definition: threads.c:506
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:713
u64 global_baseva
base virtual address for global VM region
Definition: api_common.h:285
unix_shared_memory_queue_t * vl_input_queue
shared memory only: pointer to client input queue
Definition: api_common.h:59
unix_shared_memory_queue_t * q
message allocated in this shmem ring
Definition: api_common.h:136
vl_api_msg_range_t * msg_ranges
vector of message ranges
Definition: api_common.h:276
u8 * output_vector
Socket only: output vecto.
Definition: api_common.h:67
void vl_noop_handler(void *mp)
Definition: api_shared.c:780
u8 ** traces
Trace ring.
Definition: api_common.h:95
int vl_msg_api_pd_handler(void *mp, int rv)
Definition: api_shared.c:843
int * additional_fds_to_close
Definition: api_common.h:68
const char ** msg_names
Message name vector.
Definition: api_common.h:215
void vl_msg_api_barrier_release(void)
Definition: api_shared.c:388
int replay
is this message to be replayed?
Definition: api_common.h:128
u8 * save_msg_table_filename
Dump (msg-name, crc) snapshot here at startup.
Definition: api_common.h:336
void vl_msg_api_increment_missing_client_counter(void)
Definition: api_shared.c:44
vl_api_trace_t * tx_trace
Sent message trace configuration.
Definition: api_common.h:239
u32 garbage_collects
Number of garbage-collected message buffers.
Definition: api_common.h:230
unsigned int u32
Definition: types.h:88
u32 data_len
message length not including header
Definition: api_common.h:137
Message header structure.
Definition: api_common.h:134
u8 * serialized_message_table_in_shmem
vlib/vpp only: serialized (message, name, crc) table
Definition: api_common.h:267
u64 global_pvt_heap_size
size of the global VM private mheap
Definition: api_common.h:294
i8 * unprocessed_input
Socket only: pending input.
Definition: api_common.h:65
struct ring_alloc_ * arings
Allocator ring vectors (in shared memory)
Definition: api_common.h:224
i32 vlib_signal
(Historical) signal-based queue non-empty signal, to be removed
Definition: api_common.h:315
u64 uword
Definition: types.h:112
u32 missing_clients
Number of missing clients / failed message sends.
Definition: api_common.h:233
void vl_msg_api_post_mortem_dump_enable_disable(int enable)
Definition: api_shared.c:788
unsigned short u16
Definition: types.h:57
u16 first_msg_id
first assigned message ID
Definition: api_common.h:112
double f64
Definition: types.h:142
unsigned char u8
Definition: types.h:56
u32 vl_api_registration_pool_index
Index in VLIB&#39;s brain (not shared memory).
Definition: api_common.h:49
void vl_msg_api_register_pd_handler(void *handler, u16 msg_id_host_byte_order)
Definition: api_shared.c:829
void vl_msg_api_queue_handler(unix_shared_memory_queue_t *q)
Definition: api_shared.c:757
u16 first_available_msg_id
First available message ID, for theplugin msg allocator.
Definition: api_common.h:270
u8 endian
trace endianness
Definition: api_common.h:89
u8 * is_mp_safe
Message is mp safe vector.
Definition: api_common.h:221
int trace_enable
trace this message
Definition: api_common.h:80
int msg_print_flag
Print every received message.
Definition: api_common.h:242
u32 server_handle
Socket client only: server handle.
Definition: api_common.h:71
void vl_msg_api_replay_handler(void *the_msg)
Definition: api_shared.c:616
void vl_msg_api_cleanup_handler(void *the_msg)
Definition: api_shared.c:596
int is_mp_safe
worker thread barrier required?
Definition: api_common.h:130
int traced
is this message to be traced?
Definition: api_common.h:127
vl_api_trace_which_t
Trace RX / TX enum.
Definition: api_common.h:99
const char * region_name
Shared VM binary API region name.
Definition: api_common.h:327
Trace configuration for a single message.
Definition: api_common.h:77
svm_region_t ** mapped_shmem_regions
Definition: api_common.h:258
uword * msg_index_by_name_and_crc
client message index hash table
Definition: api_common.h:321
uword * msg_range_by_name
Message range by name hash.
Definition: api_common.h:273
Shared memory connection.
Definition: api_common.h:36
char * name
the message name
Definition: api_common.h:120
u32 nitems
Number of trace records.
Definition: api_common.h:93
svm_region_t * vlib_rp
Definition: api_common.h:60
void * handler
the message handler
Definition: api_common.h:122
u32 vlib_input_queue_length
vpp/vlib input queue length
Definition: api_common.h:318
clib_error_t *( vl_msg_api_init_function_t)(u32 client_index)
Definition: api_common.h:181
struct _unix_shared_memory_queue unix_shared_memory_queue_t