Dave Wallace | 543852a | 2017-08-03 02:11:34 -0400 | [diff] [blame] | 1 | /* |
Florin Coras | 66ec467 | 2020-06-15 07:59:40 -0700 | [diff] [blame] | 2 | * Copyright (c) 2017-2020 Cisco and/or its affiliates. |
Dave Wallace | 543852a | 2017-08-03 02:11:34 -0400 | [diff] [blame] | 3 | * Licensed under the Apache License, Version 2.0 (the "License"); |
| 4 | * you may not use this file except in compliance with the License. |
| 5 | * You may obtain a copy of the License at: |
| 6 | * |
| 7 | * http://www.apache.org/licenses/LICENSE-2.0 |
| 8 | * |
| 9 | * Unless required by applicable law or agreed to in writing, software |
| 10 | * distributed under the License is distributed on an "AS IS" BASIS, |
| 11 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 12 | * See the License for the specific language governing permissions and |
| 13 | * limitations under the License. |
| 14 | */ |
| 15 | |
| 16 | #ifndef included_vppcom_h |
| 17 | #define included_vppcom_h |
| 18 | |
| 19 | #include <netdb.h> |
| 20 | #include <errno.h> |
Florin Coras | 57c8893 | 2019-08-29 12:03:17 -0700 | [diff] [blame] | 21 | #include <sys/fcntl.h> |
Dave Wallace | 048b1d6 | 2018-01-03 22:24:41 -0500 | [diff] [blame] | 22 | #include <sys/poll.h> |
Dave Wallace | f7f809c | 2017-10-03 01:48:42 -0400 | [diff] [blame] | 23 | #include <sys/epoll.h> |
Dave Wallace | 543852a | 2017-08-03 02:11:34 -0400 | [diff] [blame] | 24 | |
Keith Burns (alagalah) | 5a2946c | 2018-02-02 08:21:56 -0800 | [diff] [blame] | 25 | /* *INDENT-OFF* */ |
| 26 | #ifdef __cplusplus |
| 27 | extern "C" |
| 28 | { |
| 29 | #endif |
| 30 | /* *INDENT-ON* */ |
| 31 | |
Dave Wallace | 543852a | 2017-08-03 02:11:34 -0400 | [diff] [blame] | 32 | /* |
| 33 | * VPPCOM Public API Definitions, Enums, and Data Structures |
| 34 | */ |
Florin Coras | 7baeb71 | 2019-01-04 17:05:43 -0800 | [diff] [blame] | 35 | #define INVALID_SESSION_ID ((u32)~0) |
Florin Coras | 9936831 | 2018-08-02 10:45:44 -0700 | [diff] [blame] | 36 | #define VPPCOM_CONF_DEFAULT "/etc/vpp/vcl.conf" |
| 37 | #define VPPCOM_ENV_CONF "VCL_CONFIG" |
| 38 | #define VPPCOM_ENV_DEBUG "VCL_DEBUG" |
Florin Coras | 9936831 | 2018-08-02 10:45:44 -0700 | [diff] [blame] | 39 | #define VPPCOM_ENV_APP_PROXY_TRANSPORT_TCP "VCL_APP_PROXY_TRANSPORT_TCP" |
| 40 | #define VPPCOM_ENV_APP_PROXY_TRANSPORT_UDP "VCL_APP_PROXY_TRANSPORT_UDP" |
| 41 | #define VPPCOM_ENV_APP_NAMESPACE_ID "VCL_APP_NAMESPACE_ID" |
| 42 | #define VPPCOM_ENV_APP_NAMESPACE_SECRET "VCL_APP_NAMESPACE_SECRET" |
| 43 | #define VPPCOM_ENV_APP_SCOPE_LOCAL "VCL_APP_SCOPE_LOCAL" |
| 44 | #define VPPCOM_ENV_APP_SCOPE_GLOBAL "VCL_APP_SCOPE_GLOBAL" |
Filip Tehlar | 794599b | 2022-02-09 08:35:26 +0000 | [diff] [blame] | 45 | #define VPPCOM_ENV_APP_USE_MQ_EVENTFD "VCL_APP_USE_MQ_EVENTFD" |
Florin Coras | 9936831 | 2018-08-02 10:45:44 -0700 | [diff] [blame] | 46 | #define VPPCOM_ENV_VPP_API_SOCKET "VCL_VPP_API_SOCKET" |
Florin Coras | 165f3ae | 2020-11-08 18:04:33 -0800 | [diff] [blame] | 47 | #define VPPCOM_ENV_VPP_SAPI_SOCKET "VCL_VPP_SAPI_SOCKET" |
Dave Wallace | 543852a | 2017-08-03 02:11:34 -0400 | [diff] [blame] | 48 | |
Florin Coras | 4b47ee2 | 2020-11-19 13:38:26 -0800 | [diff] [blame] | 49 | typedef enum |
| 50 | { |
| 51 | VPPCOM_PROTO_TCP = 0, |
| 52 | VPPCOM_PROTO_UDP, |
| 53 | VPPCOM_PROTO_NONE, |
| 54 | VPPCOM_PROTO_TLS, |
| 55 | VPPCOM_PROTO_QUIC, |
| 56 | VPPCOM_PROTO_DTLS, |
Florin Coras | 6621abf | 2021-01-06 17:35:17 -0800 | [diff] [blame] | 57 | VPPCOM_PROTO_SRTP, |
Florin Coras | 4b47ee2 | 2020-11-19 13:38:26 -0800 | [diff] [blame] | 58 | } vppcom_proto_t; |
Dave Wallace | 543852a | 2017-08-03 02:11:34 -0400 | [diff] [blame] | 59 | |
Florin Coras | 4b47ee2 | 2020-11-19 13:38:26 -0800 | [diff] [blame] | 60 | typedef enum |
| 61 | { |
| 62 | VPPCOM_IS_IP6 = 0, |
| 63 | VPPCOM_IS_IP4, |
| 64 | } vppcom_is_ip4_t; |
Dave Wallace | 543852a | 2017-08-03 02:11:34 -0400 | [diff] [blame] | 65 | |
Dou Chao | 243a043 | 2022-11-29 19:41:34 +0800 | [diff] [blame] | 66 | #define VCL_UDP_OPTS_BASE (VPPCOM_PROTO_UDP << 16) |
| 67 | #define VCL_UDP_SEGMENT (VCL_UDP_OPTS_BASE + 0) |
| 68 | |
| 69 | typedef struct vppcom_endpt_tlv_t_ |
| 70 | { |
| 71 | uint32_t data_type; |
| 72 | uint32_t data_len; |
| 73 | union |
| 74 | { |
| 75 | /* data */ |
| 76 | uint64_t value; |
| 77 | uint32_t as_u32[2]; |
| 78 | uint16_t as_u16[4]; |
| 79 | uint8_t as_u8[8]; |
| 80 | }; |
| 81 | } vppcom_endpt_tlv_t; |
| 82 | |
Florin Coras | 4b47ee2 | 2020-11-19 13:38:26 -0800 | [diff] [blame] | 83 | typedef struct vppcom_endpt_t_ |
| 84 | { |
| 85 | uint8_t is_cut_thru; |
| 86 | uint8_t is_ip4; |
| 87 | uint8_t *ip; |
| 88 | uint16_t port; |
| 89 | uint64_t parent_handle; |
Dou Chao | 243a043 | 2022-11-29 19:41:34 +0800 | [diff] [blame] | 90 | vppcom_endpt_tlv_t app_data; |
Florin Coras | 4b47ee2 | 2020-11-19 13:38:26 -0800 | [diff] [blame] | 91 | } vppcom_endpt_t; |
Dave Wallace | 543852a | 2017-08-03 02:11:34 -0400 | [diff] [blame] | 92 | |
Florin Coras | 30e79c2 | 2019-01-02 19:31:22 -0800 | [diff] [blame] | 93 | typedef uint32_t vcl_session_handle_t; |
| 94 | |
Florin Coras | a5a9efd | 2021-01-05 17:03:29 -0800 | [diff] [blame] | 95 | typedef struct vppcom_cert_key_pair_ |
| 96 | { |
| 97 | char *cert; |
| 98 | char *key; |
| 99 | uint32_t cert_len; |
| 100 | uint32_t key_len; |
| 101 | } vppcom_cert_key_pair_t; |
| 102 | |
Dave Wallace | 543852a | 2017-08-03 02:11:34 -0400 | [diff] [blame] | 103 | typedef enum |
| 104 | { |
| 105 | VPPCOM_OK = 0, |
| 106 | VPPCOM_EAGAIN = -EAGAIN, |
Florin Coras | 54693d2 | 2018-07-17 10:46:29 -0700 | [diff] [blame] | 107 | VPPCOM_EWOULDBLOCK = -EWOULDBLOCK, |
Florin Coras | 57c8893 | 2019-08-29 12:03:17 -0700 | [diff] [blame] | 108 | VPPCOM_EINPROGRESS = -EINPROGRESS, |
Dave Wallace | 048b1d6 | 2018-01-03 22:24:41 -0500 | [diff] [blame] | 109 | VPPCOM_EFAULT = -EFAULT, |
Dave Wallace | 60caa06 | 2017-11-10 17:07:13 -0500 | [diff] [blame] | 110 | VPPCOM_ENOMEM = -ENOMEM, |
Dave Wallace | 543852a | 2017-08-03 02:11:34 -0400 | [diff] [blame] | 111 | VPPCOM_EINVAL = -EINVAL, |
| 112 | VPPCOM_EBADFD = -EBADFD, |
| 113 | VPPCOM_EAFNOSUPPORT = -EAFNOSUPPORT, |
Dave Wallace | ee45d41 | 2017-11-24 21:44:06 -0500 | [diff] [blame] | 114 | VPPCOM_ECONNABORTED = -ECONNABORTED, |
Dave Wallace | 543852a | 2017-08-03 02:11:34 -0400 | [diff] [blame] | 115 | VPPCOM_ECONNRESET = -ECONNRESET, |
Dave Wallace | 4878cbe | 2017-11-21 03:45:09 -0500 | [diff] [blame] | 116 | VPPCOM_ENOTCONN = -ENOTCONN, |
Dave Wallace | 543852a | 2017-08-03 02:11:34 -0400 | [diff] [blame] | 117 | VPPCOM_ECONNREFUSED = -ECONNREFUSED, |
| 118 | VPPCOM_ETIMEDOUT = -ETIMEDOUT, |
Florin Coras | 04ae827 | 2021-04-12 19:55:37 -0700 | [diff] [blame] | 119 | VPPCOM_EEXIST = -EEXIST, |
Florin Coras | 2645f68 | 2021-06-04 15:59:41 -0700 | [diff] [blame] | 120 | VPPCOM_ENOPROTOOPT = -ENOPROTOOPT, |
liuyacan | 55c952e | 2021-06-13 14:54:55 +0800 | [diff] [blame] | 121 | VPPCOM_EPIPE = -EPIPE, |
Florin Coras | 2645f68 | 2021-06-04 15:59:41 -0700 | [diff] [blame] | 122 | VPPCOM_ENOENT = -ENOENT, |
Maros Ondrejicka | 6ff8e90 | 2022-10-06 18:17:05 +0200 | [diff] [blame] | 123 | VPPCOM_EADDRINUSE = -EADDRINUSE, |
| 124 | VPPCOM_ENOTSUP = -ENOTSUP |
Dave Wallace | 543852a | 2017-08-03 02:11:34 -0400 | [diff] [blame] | 125 | } vppcom_error_t; |
| 126 | |
Dave Wallace | 35830af | 2017-10-09 01:43:42 -0400 | [diff] [blame] | 127 | typedef enum |
| 128 | { |
| 129 | VPPCOM_ATTR_GET_NREAD, |
Dave Wallace | 227867f | 2017-11-13 21:21:53 -0500 | [diff] [blame] | 130 | VPPCOM_ATTR_GET_NWRITE, |
Dave Wallace | 35830af | 2017-10-09 01:43:42 -0400 | [diff] [blame] | 131 | VPPCOM_ATTR_GET_FLAGS, |
| 132 | VPPCOM_ATTR_SET_FLAGS, |
| 133 | VPPCOM_ATTR_GET_LCL_ADDR, |
Florin Coras | ef7cbf6 | 2019-10-17 09:56:27 -0700 | [diff] [blame] | 134 | VPPCOM_ATTR_SET_LCL_ADDR, |
Dave Wallace | 35830af | 2017-10-09 01:43:42 -0400 | [diff] [blame] | 135 | VPPCOM_ATTR_GET_PEER_ADDR, |
Dave Wallace | 048b1d6 | 2018-01-03 22:24:41 -0500 | [diff] [blame] | 136 | VPPCOM_ATTR_GET_LIBC_EPFD, |
| 137 | VPPCOM_ATTR_SET_LIBC_EPFD, |
| 138 | VPPCOM_ATTR_GET_PROTOCOL, |
| 139 | VPPCOM_ATTR_GET_LISTEN, |
| 140 | VPPCOM_ATTR_GET_ERROR, |
| 141 | VPPCOM_ATTR_GET_TX_FIFO_LEN, |
| 142 | VPPCOM_ATTR_SET_TX_FIFO_LEN, |
| 143 | VPPCOM_ATTR_GET_RX_FIFO_LEN, |
| 144 | VPPCOM_ATTR_SET_RX_FIFO_LEN, |
| 145 | VPPCOM_ATTR_GET_REUSEADDR, |
Steven | b5a1160 | 2017-10-11 09:59:30 -0700 | [diff] [blame] | 146 | VPPCOM_ATTR_SET_REUSEADDR, |
Dave Wallace | 048b1d6 | 2018-01-03 22:24:41 -0500 | [diff] [blame] | 147 | VPPCOM_ATTR_GET_REUSEPORT, |
| 148 | VPPCOM_ATTR_SET_REUSEPORT, |
| 149 | VPPCOM_ATTR_GET_BROADCAST, |
Steven | b5a1160 | 2017-10-11 09:59:30 -0700 | [diff] [blame] | 150 | VPPCOM_ATTR_SET_BROADCAST, |
Dave Wallace | 048b1d6 | 2018-01-03 22:24:41 -0500 | [diff] [blame] | 151 | VPPCOM_ATTR_GET_V6ONLY, |
Steven | b5a1160 | 2017-10-11 09:59:30 -0700 | [diff] [blame] | 152 | VPPCOM_ATTR_SET_V6ONLY, |
Dave Wallace | 048b1d6 | 2018-01-03 22:24:41 -0500 | [diff] [blame] | 153 | VPPCOM_ATTR_GET_KEEPALIVE, |
Steven | bccd339 | 2017-10-12 20:42:21 -0700 | [diff] [blame] | 154 | VPPCOM_ATTR_SET_KEEPALIVE, |
Dave Wallace | 048b1d6 | 2018-01-03 22:24:41 -0500 | [diff] [blame] | 155 | VPPCOM_ATTR_GET_TCP_NODELAY, |
| 156 | VPPCOM_ATTR_SET_TCP_NODELAY, |
| 157 | VPPCOM_ATTR_GET_TCP_KEEPIDLE, |
Steven | bccd339 | 2017-10-12 20:42:21 -0700 | [diff] [blame] | 158 | VPPCOM_ATTR_SET_TCP_KEEPIDLE, |
Dave Wallace | 048b1d6 | 2018-01-03 22:24:41 -0500 | [diff] [blame] | 159 | VPPCOM_ATTR_GET_TCP_KEEPINTVL, |
Steven | bccd339 | 2017-10-12 20:42:21 -0700 | [diff] [blame] | 160 | VPPCOM_ATTR_SET_TCP_KEEPINTVL, |
Dave Wallace | 048b1d6 | 2018-01-03 22:24:41 -0500 | [diff] [blame] | 161 | VPPCOM_ATTR_GET_TCP_USER_MSS, |
| 162 | VPPCOM_ATTR_SET_TCP_USER_MSS, |
Florin Coras | 1e96617 | 2020-05-16 18:18:14 +0000 | [diff] [blame] | 163 | VPPCOM_ATTR_SET_CONNECTED, |
Florin Coras | a5a9efd | 2021-01-05 17:03:29 -0800 | [diff] [blame] | 164 | VPPCOM_ATTR_SET_CKPAIR, |
Florin Coras | 6a6555a | 2021-01-28 11:39:27 -0800 | [diff] [blame] | 165 | VPPCOM_ATTR_SET_VRF, |
| 166 | VPPCOM_ATTR_GET_VRF, |
wanghanlin | 0674f85 | 2021-02-22 10:38:36 +0800 | [diff] [blame] | 167 | VPPCOM_ATTR_GET_DOMAIN, |
Florin Coras | 87f6389 | 2021-05-01 16:01:40 -0700 | [diff] [blame] | 168 | VPPCOM_ATTR_SET_ENDPT_EXT_CFG, |
Filip Tehlar | 2f09bfc | 2021-11-15 10:26:56 +0000 | [diff] [blame] | 169 | VPPCOM_ATTR_SET_DSCP, |
Dave Wallace | 35830af | 2017-10-09 01:43:42 -0400 | [diff] [blame] | 170 | } vppcom_attr_op_t; |
| 171 | |
Dave Wallace | 048b1d6 | 2018-01-03 22:24:41 -0500 | [diff] [blame] | 172 | typedef struct _vcl_poll |
| 173 | { |
| 174 | uint32_t fds_ndx; |
Florin Coras | 7baeb71 | 2019-01-04 17:05:43 -0800 | [diff] [blame] | 175 | vcl_session_handle_t sh; |
Dave Wallace | 048b1d6 | 2018-01-03 22:24:41 -0500 | [diff] [blame] | 176 | short events; |
Florin Coras | 6917b94 | 2018-11-13 22:44:54 -0800 | [diff] [blame] | 177 | short revents; |
Dave Wallace | 048b1d6 | 2018-01-03 22:24:41 -0500 | [diff] [blame] | 178 | } vcl_poll_t; |
| 179 | |
Florin Coras | 2cba853 | 2018-09-11 16:33:36 -0700 | [diff] [blame] | 180 | typedef struct vppcom_data_segment_ |
| 181 | { |
| 182 | unsigned char *data; |
| 183 | uint32_t len; |
| 184 | } vppcom_data_segment_t; |
| 185 | |
| 186 | typedef vppcom_data_segment_t vppcom_data_segments_t[2]; |
| 187 | |
Florin Coras | 294afe2 | 2019-01-07 17:49:17 -0800 | [diff] [blame] | 188 | typedef unsigned long vcl_si_set; |
| 189 | |
Dave Wallace | 543852a | 2017-08-03 02:11:34 -0400 | [diff] [blame] | 190 | /* |
| 191 | * VPPCOM Public API Functions |
| 192 | */ |
Dave Wallace | 543852a | 2017-08-03 02:11:34 -0400 | [diff] [blame] | 193 | |
Florin Coras | 66ec467 | 2020-06-15 07:59:40 -0700 | [diff] [blame] | 194 | extern int vppcom_app_create (const char *app_name); |
Dave Wallace | 543852a | 2017-08-03 02:11:34 -0400 | [diff] [blame] | 195 | extern void vppcom_app_destroy (void); |
| 196 | |
Dave Wallace | c04cbf1 | 2018-02-07 18:14:02 -0500 | [diff] [blame] | 197 | extern int vppcom_session_create (uint8_t proto, uint8_t is_nonblocking); |
liuyacan | 55c952e | 2021-06-13 14:54:55 +0800 | [diff] [blame] | 198 | extern int vppcom_session_shutdown (uint32_t session_handle, int how); |
Florin Coras | 134a996 | 2018-08-28 11:32:04 -0700 | [diff] [blame] | 199 | extern int vppcom_session_close (uint32_t session_handle); |
| 200 | extern int vppcom_session_bind (uint32_t session_handle, vppcom_endpt_t * ep); |
| 201 | extern int vppcom_session_listen (uint32_t session_handle, uint32_t q_len); |
Dave Wallace | 543852a | 2017-08-03 02:11:34 -0400 | [diff] [blame] | 202 | |
Florin Coras | 134a996 | 2018-08-28 11:32:04 -0700 | [diff] [blame] | 203 | extern int vppcom_session_accept (uint32_t session_handle, |
Dave Wallace | 048b1d6 | 2018-01-03 22:24:41 -0500 | [diff] [blame] | 204 | vppcom_endpt_t * client_ep, uint32_t flags); |
Dave Wallace | 543852a | 2017-08-03 02:11:34 -0400 | [diff] [blame] | 205 | |
Florin Coras | 134a996 | 2018-08-28 11:32:04 -0700 | [diff] [blame] | 206 | extern int vppcom_session_connect (uint32_t session_handle, |
Dave Wallace | 543852a | 2017-08-03 02:11:34 -0400 | [diff] [blame] | 207 | vppcom_endpt_t * server_ep); |
Nathan Skrzypczak | 9fd9962 | 2019-05-16 14:38:44 +0200 | [diff] [blame] | 208 | extern int vppcom_session_stream_connect (uint32_t session_handle, |
| 209 | uint32_t parent_session_handle); |
Florin Coras | 134a996 | 2018-08-28 11:32:04 -0700 | [diff] [blame] | 210 | extern int vppcom_session_read (uint32_t session_handle, void *buf, size_t n); |
| 211 | extern int vppcom_session_write (uint32_t session_handle, void *buf, |
| 212 | size_t n); |
Florin Coras | b0f662f | 2018-12-27 14:51:46 -0800 | [diff] [blame] | 213 | extern int vppcom_session_write_msg (uint32_t session_handle, void *buf, |
| 214 | size_t n); |
Dave Wallace | 543852a | 2017-08-03 02:11:34 -0400 | [diff] [blame] | 215 | |
Florin Coras | 294afe2 | 2019-01-07 17:49:17 -0800 | [diff] [blame] | 216 | extern int vppcom_select (int n_bits, vcl_si_set * read_map, |
| 217 | vcl_si_set * write_map, vcl_si_set * except_map, |
| 218 | double wait_for_time); |
Dave Wallace | 543852a | 2017-08-03 02:11:34 -0400 | [diff] [blame] | 219 | |
Dave Wallace | f7f809c | 2017-10-03 01:48:42 -0400 | [diff] [blame] | 220 | extern int vppcom_epoll_create (void); |
Florin Coras | 134a996 | 2018-08-28 11:32:04 -0700 | [diff] [blame] | 221 | extern int vppcom_epoll_ctl (uint32_t vep_handle, int op, |
| 222 | uint32_t session_handle, |
Dave Wallace | f7f809c | 2017-10-03 01:48:42 -0400 | [diff] [blame] | 223 | struct epoll_event *event); |
Florin Coras | 134a996 | 2018-08-28 11:32:04 -0700 | [diff] [blame] | 224 | extern int vppcom_epoll_wait (uint32_t vep_handle, struct epoll_event *events, |
Dave Wallace | f7f809c | 2017-10-03 01:48:42 -0400 | [diff] [blame] | 225 | int maxevents, double wait_for_time); |
Florin Coras | 134a996 | 2018-08-28 11:32:04 -0700 | [diff] [blame] | 226 | extern int vppcom_session_attr (uint32_t session_handle, uint32_t op, |
Dave Wallace | 35830af | 2017-10-09 01:43:42 -0400 | [diff] [blame] | 227 | void *buffer, uint32_t * buflen); |
Florin Coras | 134a996 | 2018-08-28 11:32:04 -0700 | [diff] [blame] | 228 | extern int vppcom_session_recvfrom (uint32_t session_handle, void *buffer, |
Steven | ac1f96d | 2017-10-24 16:03:58 -0700 | [diff] [blame] | 229 | uint32_t buflen, int flags, |
| 230 | vppcom_endpt_t * ep); |
Florin Coras | 134a996 | 2018-08-28 11:32:04 -0700 | [diff] [blame] | 231 | extern int vppcom_session_sendto (uint32_t session_handle, void *buffer, |
Steven | ac1f96d | 2017-10-24 16:03:58 -0700 | [diff] [blame] | 232 | uint32_t buflen, int flags, |
| 233 | vppcom_endpt_t * ep); |
Dave Wallace | 048b1d6 | 2018-01-03 22:24:41 -0500 | [diff] [blame] | 234 | extern int vppcom_poll (vcl_poll_t * vp, uint32_t n_sids, |
| 235 | double wait_for_time); |
Florin Coras | 9936831 | 2018-08-02 10:45:44 -0700 | [diff] [blame] | 236 | extern int vppcom_mq_epoll_fd (void); |
Florin Coras | 30e79c2 | 2019-01-02 19:31:22 -0800 | [diff] [blame] | 237 | extern int vppcom_session_index (vcl_session_handle_t session_handle); |
| 238 | extern int vppcom_session_worker (vcl_session_handle_t session_handle); |
Florin Coras | 134a996 | 2018-08-28 11:32:04 -0700 | [diff] [blame] | 239 | |
Florin Coras | 2cba853 | 2018-09-11 16:33:36 -0700 | [diff] [blame] | 240 | extern int vppcom_session_read_segments (uint32_t session_handle, |
Florin Coras | d68faf8 | 2020-09-25 15:18:13 -0700 | [diff] [blame] | 241 | vppcom_data_segment_t * ds, |
| 242 | uint32_t n_segments, |
| 243 | uint32_t max_bytes); |
Florin Coras | 2cba853 | 2018-09-11 16:33:36 -0700 | [diff] [blame] | 244 | extern void vppcom_session_free_segments (uint32_t session_handle, |
Florin Coras | d68faf8 | 2020-09-25 15:18:13 -0700 | [diff] [blame] | 245 | uint32_t n_bytes); |
Florin Coras | a5a9efd | 2021-01-05 17:03:29 -0800 | [diff] [blame] | 246 | extern int vppcom_add_cert_key_pair (vppcom_cert_key_pair_t *ckpair); |
| 247 | extern int vppcom_del_cert_key_pair (uint32_t ckpair_index); |
Nathan Skrzypczak | 9fd9962 | 2019-05-16 14:38:44 +0200 | [diff] [blame] | 248 | extern int vppcom_unformat_proto (uint8_t * proto, char *proto_str); |
| 249 | extern int vppcom_session_is_connectable_listener (uint32_t session_handle); |
| 250 | extern int vppcom_session_listener (uint32_t session_handle); |
| 251 | extern int vppcom_session_n_accepted (uint32_t session_handle); |
Florin Coras | 2cba853 | 2018-09-11 16:33:36 -0700 | [diff] [blame] | 252 | |
Florin Coras | 66ec467 | 2020-06-15 07:59:40 -0700 | [diff] [blame] | 253 | extern const char *vppcom_proto_str (vppcom_proto_t proto); |
| 254 | extern const char *vppcom_retval_str (int retval); |
| 255 | |
Florin Coras | 134a996 | 2018-08-28 11:32:04 -0700 | [diff] [blame] | 256 | /** |
| 257 | * Request from application to register a new worker |
| 258 | * |
| 259 | * Expectation is that applications will make use of this after a new pthread |
| 260 | * is spawned. |
| 261 | */ |
| 262 | extern int vppcom_worker_register (void); |
Dave Wallace | f7f809c | 2017-10-03 01:48:42 -0400 | [diff] [blame] | 263 | |
Florin Coras | dfe4cf4 | 2018-11-28 22:13:45 -0800 | [diff] [blame] | 264 | /** |
Florin Coras | 369db83 | 2019-07-08 12:34:45 -0700 | [diff] [blame] | 265 | * Unregister current worker |
| 266 | */ |
| 267 | extern void vppcom_worker_unregister (void); |
| 268 | |
| 269 | /** |
Florin Coras | dfe4cf4 | 2018-11-28 22:13:45 -0800 | [diff] [blame] | 270 | * Retrieve current worker index |
| 271 | */ |
| 272 | extern int vppcom_worker_index (void); |
| 273 | |
Florin Coras | e0982e5 | 2019-01-25 13:19:56 -0800 | [diff] [blame] | 274 | /** |
Pivo | 6017ff0 | 2020-05-04 17:57:33 +0200 | [diff] [blame] | 275 | * Set current worker index |
| 276 | */ |
| 277 | extern void vppcom_worker_index_set (int); |
| 278 | |
| 279 | /** |
Florin Coras | e0982e5 | 2019-01-25 13:19:56 -0800 | [diff] [blame] | 280 | * Returns the current worker's message queues epoll fd |
| 281 | * |
| 282 | * This only works if vcl is configured to do eventfd based message queue |
| 283 | * notifications. |
| 284 | */ |
| 285 | extern int vppcom_worker_mqs_epfd (void); |
| 286 | |
Radha krishna Saragadam | dd92bde | 2022-07-18 19:41:05 +0530 | [diff] [blame] | 287 | /** |
| 288 | * Returns Session error |
| 289 | * |
| 290 | * Application can use this API to find the detailed session error |
| 291 | */ |
| 292 | extern int vppcom_session_get_error (uint32_t session_handle); |
| 293 | |
Maros Ondrejicka | 6ff8e90 | 2022-10-06 18:17:05 +0200 | [diff] [blame] | 294 | /** |
| 295 | * Returns true if current worker is disconnected from vpp |
| 296 | * |
| 297 | * Application can use this API to check if VPP is disconnected |
| 298 | * as long as `use-mq-eventfd` is being set |
| 299 | */ |
| 300 | extern int vppcom_worker_is_detached (void); |
| 301 | |
Keith Burns (alagalah) | 5a2946c | 2018-02-02 08:21:56 -0800 | [diff] [blame] | 302 | /* *INDENT-OFF* */ |
| 303 | #ifdef __cplusplus |
| 304 | } |
| 305 | #endif |
| 306 | /* *INDENT-ON* */ |
| 307 | |
Dave Wallace | 543852a | 2017-08-03 02:11:34 -0400 | [diff] [blame] | 308 | #endif /* included_vppcom_h */ |
| 309 | |
| 310 | /* |
| 311 | * fd.io coding-style-patch-verification: ON |
| 312 | * |
| 313 | * Local Variables: |
| 314 | * eval: (c-set-style "gnu") |
| 315 | * End: |
| 316 | */ |