2 * Copyright (c) 2017 Cisco and/or its affiliates.
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:
7 * http://www.apache.org/licenses/LICENSE-2.0
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.
16 #ifndef included_vppcom_h
17 #define included_vppcom_h
22 #include <sys/epoll.h>
32 * VPPCOM Public API Definitions, Enums, and Data Structures
34 #define INVALID_SESSION_ID (~0)
35 #define VPPCOM_CONF_DEFAULT "/etc/vpp/vcl.conf"
36 #define VPPCOM_ENV_CONF "VCL_CONFIG"
37 #define VPPCOM_ENV_DEBUG "VCL_DEBUG"
38 #define VPPCOM_ENV_APP_PROXY_TRANSPORT_TCP "VCL_APP_PROXY_TRANSPORT_TCP"
39 #define VPPCOM_ENV_APP_PROXY_TRANSPORT_UDP "VCL_APP_PROXY_TRANSPORT_UDP"
40 #define VPPCOM_ENV_APP_NAMESPACE_ID "VCL_APP_NAMESPACE_ID"
41 #define VPPCOM_ENV_APP_NAMESPACE_SECRET "VCL_APP_NAMESPACE_SECRET"
42 #define VPPCOM_ENV_APP_SCOPE_LOCAL "VCL_APP_SCOPE_LOCAL"
43 #define VPPCOM_ENV_APP_SCOPE_GLOBAL "VCL_APP_SCOPE_GLOBAL"
52 vppcom_proto_str (vppcom_proto_t proto)
58 case VPPCOM_PROTO_TCP:
59 proto_str = "VPPCOM_PROTO_TCP";
61 case VPPCOM_PROTO_UDP:
62 proto_str = "VPPCOM_PROTO_UDP";
65 proto_str = "UNKNOWN";
77 typedef struct vppcom_endpt_t_
88 VPPCOM_EAGAIN = -EAGAIN,
89 VPPCOM_EFAULT = -EFAULT,
90 VPPCOM_ENOMEM = -ENOMEM,
91 VPPCOM_EINVAL = -EINVAL,
92 VPPCOM_EBADFD = -EBADFD,
93 VPPCOM_EAFNOSUPPORT = -EAFNOSUPPORT,
94 VPPCOM_ECONNABORTED = -ECONNABORTED,
95 VPPCOM_ECONNRESET = -ECONNRESET,
96 VPPCOM_ENOTCONN = -ENOTCONN,
97 VPPCOM_ECONNREFUSED = -ECONNREFUSED,
98 VPPCOM_ETIMEDOUT = -ETIMEDOUT,
103 VPPCOM_ATTR_GET_NREAD,
104 VPPCOM_ATTR_GET_NWRITE,
105 VPPCOM_ATTR_GET_FLAGS,
106 VPPCOM_ATTR_SET_FLAGS,
107 VPPCOM_ATTR_GET_LCL_ADDR,
108 VPPCOM_ATTR_GET_PEER_ADDR,
109 VPPCOM_ATTR_GET_LIBC_EPFD,
110 VPPCOM_ATTR_SET_LIBC_EPFD,
111 VPPCOM_ATTR_GET_PROTOCOL,
112 VPPCOM_ATTR_GET_LISTEN,
113 VPPCOM_ATTR_GET_ERROR,
114 VPPCOM_ATTR_GET_TX_FIFO_LEN,
115 VPPCOM_ATTR_SET_TX_FIFO_LEN,
116 VPPCOM_ATTR_GET_RX_FIFO_LEN,
117 VPPCOM_ATTR_SET_RX_FIFO_LEN,
118 VPPCOM_ATTR_GET_REUSEADDR,
119 VPPCOM_ATTR_SET_REUSEADDR,
120 VPPCOM_ATTR_GET_REUSEPORT,
121 VPPCOM_ATTR_SET_REUSEPORT,
122 VPPCOM_ATTR_GET_BROADCAST,
123 VPPCOM_ATTR_SET_BROADCAST,
124 VPPCOM_ATTR_GET_V6ONLY,
125 VPPCOM_ATTR_SET_V6ONLY,
126 VPPCOM_ATTR_GET_KEEPALIVE,
127 VPPCOM_ATTR_SET_KEEPALIVE,
128 VPPCOM_ATTR_GET_TCP_NODELAY,
129 VPPCOM_ATTR_SET_TCP_NODELAY,
130 VPPCOM_ATTR_GET_TCP_KEEPIDLE,
131 VPPCOM_ATTR_SET_TCP_KEEPIDLE,
132 VPPCOM_ATTR_GET_TCP_KEEPINTVL,
133 VPPCOM_ATTR_SET_TCP_KEEPINTVL,
134 VPPCOM_ATTR_GET_TCP_USER_MSS,
135 VPPCOM_ATTR_SET_TCP_USER_MSS,
138 typedef struct _vcl_poll
147 * VPPCOM Public API Functions
149 static inline const char *
150 vppcom_retval_str (int retval)
161 st = "VPPCOM_EAGAIN";
165 st = "VPPCOM_EFAULT";
169 st = "VPPCOM_ENOMEM";
173 st = "VPPCOM_EINVAL";
177 st = "VPPCOM_EBADFD";
180 case VPPCOM_EAFNOSUPPORT:
181 st = "VPPCOM_EAFNOSUPPORT";
184 case VPPCOM_ECONNABORTED:
185 st = "VPPCOM_ECONNABORTED";
188 case VPPCOM_ECONNRESET:
189 st = "VPPCOM_ECONNRESET";
192 case VPPCOM_ENOTCONN:
193 st = "VPPCOM_ENOTCONN";
196 case VPPCOM_ECONNREFUSED:
197 st = "VPPCOM_ECONNREFUSED";
200 case VPPCOM_ETIMEDOUT:
201 st = "VPPCOM_ETIMEDOUT";
205 st = "UNKNOWN_STATE";
212 /* TBD: make these constructor/destructor function */
213 extern int vppcom_app_create (char *app_name);
214 extern void vppcom_app_destroy (void);
216 extern int vppcom_session_create (uint8_t proto, uint8_t is_nonblocking);
217 extern int vppcom_session_close (uint32_t session_index);
219 extern int vppcom_session_bind (uint32_t session_index, vppcom_endpt_t * ep);
220 extern int vppcom_session_listen (uint32_t session_index, uint32_t q_len);
221 extern int vppcom_session_accept (uint32_t session_index,
222 vppcom_endpt_t * client_ep, uint32_t flags);
224 extern int vppcom_session_connect (uint32_t session_index,
225 vppcom_endpt_t * server_ep);
226 extern int vppcom_session_read (uint32_t session_index, void *buf, size_t n);
227 extern int vppcom_session_write (uint32_t session_index, void *buf, size_t n);
229 extern int vppcom_select (unsigned long n_bits,
230 unsigned long *read_map,
231 unsigned long *write_map,
232 unsigned long *except_map, double wait_for_time);
234 extern int vppcom_epoll_create (void);
235 extern int vppcom_epoll_ctl (uint32_t vep_idx, int op,
236 uint32_t session_index,
237 struct epoll_event *event);
238 extern int vppcom_epoll_wait (uint32_t vep_idx, struct epoll_event *events,
239 int maxevents, double wait_for_time);
240 extern int vppcom_session_attr (uint32_t session_index, uint32_t op,
241 void *buffer, uint32_t * buflen);
242 extern int vppcom_session_recvfrom (uint32_t session_index, void *buffer,
243 uint32_t buflen, int flags,
244 vppcom_endpt_t * ep);
245 extern int vppcom_session_sendto (uint32_t session_index, void *buffer,
246 uint32_t buflen, int flags,
247 vppcom_endpt_t * ep);
248 extern int vppcom_poll (vcl_poll_t * vp, uint32_t n_sids,
249 double wait_for_time);
257 #endif /* included_vppcom_h */
260 * fd.io coding-style-patch-verification: ON
263 * eval: (c-set-style "gnu")