2 *------------------------------------------------------------------
3 * Copyright (c) 2017 Cisco and/or its affiliates.
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at:
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 *------------------------------------------------------------------
18 #ifndef vpp_api_h_included
19 #define vpp_api_h_included
23 #include <vppinfra/types.h>
24 #include <vlibapi/api_types.h>
25 #include <vapi/vapi_common.h>
26 #include <svm/queue.h>
36 * common vpp api C declarations
38 * This file declares the common C API functions. These include connect,
39 * disconnect and utility functions as well as the low-level vapi_send and
40 * vapi_recv API. This is only the transport layer.
42 * Message formats and higher-level APIs are generated by running the
43 * vapi_c_gen.py script (which is run for in-tree APIs as part of the build
44 * process). It's not recommended to mix the higher and lower level APIs. Due
45 * to version issues, the higher-level APIs are not part of the shared library.
47 typedef struct vapi_ctx_s *vapi_ctx_t;
50 * @brief allocate vapi message of given size
52 * @note message must be freed by vapi_msg_free if not consumed by vapi_send
55 * @param ctx opaque vapi context
57 * @return pointer to message or NULL if out of memory
59 void *vapi_msg_alloc (vapi_ctx_t ctx, size_t size);
62 * @brief free a vapi message
64 * @note messages received by vapi_recv must be freed when no longer needed
66 * @param ctx opaque vapi context
67 * @param msg message to be freed
69 void vapi_msg_free (vapi_ctx_t ctx, void *msg);
72 * @brief allocate vapi context
74 * @param[out] pointer to result variable
76 * @return VAPI_OK on success, other error code on error
78 vapi_error_e vapi_ctx_alloc (vapi_ctx_t *result);
81 * @brief free vapi context
83 void vapi_ctx_free (vapi_ctx_t ctx);
86 * @brief check if message identified by it's message id is known by the vpp to
87 * which the connection is open
89 bool vapi_is_msg_available (vapi_ctx_t ctx, vapi_msg_id_t type);
92 * @brief connect to vpp
94 * @param ctx opaque vapi context, must be allocated using vapi_ctx_alloc first
95 * @param name application name
96 * @param chroot_prefix shared memory prefix
97 * @param max_outstanding_requests max number of outstanding requests queued
98 * @param response_queue_size size of the response queue
99 * @param mode mode of operation - blocking or nonblocking
100 * @param handle_keepalives - if true, automatically handle memclnt_keepalive
102 * @return VAPI_OK on success, other error code on error
104 vapi_error_e vapi_connect (vapi_ctx_t ctx, const char *name,
105 const char *chroot_prefix,
106 int max_outstanding_requests,
107 int response_queue_size, vapi_mode_e mode,
108 bool handle_keepalives);
111 * @brief connect to vpp from a client in same process
112 * @remark This MUST be called from a separate thread. If called
113 * from the main thread, it will deadlock.
115 * @param ctx opaque vapi context, must be allocated using vapi_ctx_alloc first
116 * @param name application name
117 * @param max_outstanding_requests max number of outstanding requests queued
118 * @param response_queue_size size of the response queue
119 * @param mode mode of operation - blocking or nonblocking
120 * @param handle_keepalives - if true, automatically handle memclnt_keepalive
122 * @return VAPI_OK on success, other error code on error
124 vapi_error_e vapi_connect_from_vpp (vapi_ctx_t ctx, const char *name,
125 int max_outstanding_requests,
126 int response_queue_size, vapi_mode_e mode,
127 bool handle_keepalives);
130 * @brief disconnect from vpp
132 * @param ctx opaque vapi context
134 * @return VAPI_OK on success, other error code on error
136 vapi_error_e vapi_disconnect (vapi_ctx_t ctx);
137 vapi_error_e vapi_disconnect_from_vpp (vapi_ctx_t ctx);
140 * @brief get event file descriptor
142 * @note this file descriptor becomes readable when messages (from vpp)
143 * are waiting in queue
145 * @param ctx opaque vapi context
146 * @param[out] fd pointer to result variable
148 * @return VAPI_OK on success, other error code on error
150 vapi_error_e vapi_get_fd (vapi_ctx_t ctx, int *fd);
153 * @brief low-level api for sending messages to vpp
155 * @note it is not recommended to use this api directly, use generated api
158 * @param ctx opaque vapi context
159 * @param msg message to send
161 * @return VAPI_OK on success, other error code on error
163 vapi_error_e vapi_send (vapi_ctx_t ctx, void *msg);
166 * @brief low-level api for atomically sending two messages to vpp - either
167 * both messages are sent or neither one is
169 * @note it is not recommended to use this api directly, use generated api
172 * @param ctx opaque vapi context
173 * @param msg1 first message to send
174 * @param msg2 second message to send
176 * @return VAPI_OK on success, other error code on error
178 vapi_error_e vapi_send2 (vapi_ctx_t ctx, void *msg1, void *msg2);
181 * @brief low-level api for reading messages from vpp
183 * @note it is not recommended to use this api directly, use generated api
186 * @param ctx opaque vapi context
187 * @param[out] msg pointer to result variable containing message
188 * @param[out] msg_size pointer to result variable containing message size
189 * @param cond enum type for blocking, non-blocking or timed wait call
190 * @param time in sec for timed wait
192 * @return VAPI_OK on success, other error code on error
194 vapi_error_e vapi_recv (vapi_ctx_t ctx, void **msg, size_t *msg_size,
195 svm_q_conditional_wait_t cond, u32 time);
198 * @brief wait for connection to become readable
200 * @param ctx opaque vapi context
202 * @return VAPI_OK on success, other error code on error
204 vapi_error_e vapi_wait (vapi_ctx_t ctx);
207 * @brief pick next message sent by vpp and call the appropriate callback
209 * @return VAPI_OK on success, other error code on error
211 vapi_error_e vapi_dispatch_one (vapi_ctx_t ctx);
214 * @brief loop vapi_dispatch_one until responses to all currently outstanding
215 * requests have been received and their callbacks called
217 * @note the dispatch loop is interrupted if any error is encountered or
218 * returned from the callback, in which case this error is returned as the
219 * result of vapi_dispatch. In this case it might be necessary to call dispatch
220 * again to process the remaining messages. Returning VAPI_EUSER from
221 * a callback allows the user to break the dispatch loop (and distinguish
222 * this case in the calling code from other failures). VAPI never returns
223 * VAPI_EUSER on its own.
225 * @return VAPI_OK on success, other error code on error
227 vapi_error_e vapi_dispatch (vapi_ctx_t ctx);
229 /** generic vapi event callback */
230 typedef vapi_error_e (*vapi_event_cb) (vapi_ctx_t ctx, void *callback_ctx,
234 * @brief set event callback to call when message with given id is dispatched
236 * @param ctx opaque vapi context
237 * @param id message id
238 * @param callback callback
239 * @param callback_ctx context pointer stored and passed to callback
241 void vapi_set_event_cb (vapi_ctx_t ctx, vapi_msg_id_t id,
242 vapi_event_cb callback, void *callback_ctx);
245 * @brief clear event callback for given message id
247 * @param ctx opaque vapi context
248 * @param id message id
250 void vapi_clear_event_cb (vapi_ctx_t ctx, vapi_msg_id_t id);
252 /** generic vapi event callback */
253 typedef vapi_error_e (*vapi_generic_event_cb) (vapi_ctx_t ctx,
255 vapi_msg_id_t id, void *msg);
257 * @brief set generic event callback
259 * @note this callback is called by dispatch if no message-type specific
260 * callback is set (so it's a fallback callback)
262 * @param ctx opaque vapi context
263 * @param callback callback
264 * @param callback_ctx context pointer stored and passed to callback
266 void vapi_set_generic_event_cb (vapi_ctx_t ctx, vapi_generic_event_cb callback,
270 * @brief clear generic event callback
272 * @param ctx opaque vapi context
274 void vapi_clear_generic_event_cb (vapi_ctx_t ctx);
277 * @brief signal RX thread to exit
279 * @note This adds a message to the client input queue that indicates that
280 * an RX thread should stop processing incoming messages and exit. If an
281 * application has an RX thread which sleeps while waiting for incoming
282 * messages using vapi_wait(), this call will allow the application to
283 * wake up from the vapi_wait() call and figure out that it should stop
286 * @param ctx opaque vapi context
288 void vapi_stop_rx_thread (vapi_ctx_t ctx);
297 * fd.io coding-style-patch-verification: ON
300 * eval: (c-set-style "gnu")