11b71eee4afb2d0df48507368bb584d1681fadf6
[vpp.git] / src / vcl / vcl_locked.h
1 /*
2  * Copyright (c) 2019 Cisco and/or its affiliates.
3  * Licensed under the Apache License, Version 2.0 (the "License");
4  * you may not use this
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  * VCL Locked Sessions
16  */
17
18 #ifndef SRC_VCL_VCL_LOCKED_H_
19 #define SRC_VCL_VCL_LOCKED_H_
20
21 #include <vcl/vppcom.h>
22
23 #define VLS_INVALID_HANDLE ((int)-1)
24 #define VLS_WORKER_RPC_TIMEOUT 3 /* timeout to wait rpc response. */
25
26 typedef int vls_handle_t;
27
28 vls_handle_t vls_create (uint8_t proto, uint8_t is_nonblocking);
29 int vls_close (vls_handle_t vlsh);
30 int vls_bind (vls_handle_t vlsh, vppcom_endpt_t * ep);
31 int vls_listen (vls_handle_t vlsh, int q_len);
32 int vls_connect (vls_handle_t vlsh, vppcom_endpt_t * server_ep);
33 vls_handle_t vls_accept (vls_handle_t vlsh, vppcom_endpt_t * ep, int flags);
34 ssize_t vls_read (vls_handle_t vlsh, void *buf, size_t nbytes);
35 ssize_t vls_recvfrom (vls_handle_t vlsh, void *buffer, uint32_t buflen,
36                       int flags, vppcom_endpt_t * ep);
37 int vls_write (vls_handle_t vlsh, void *buf, size_t nbytes);
38 int vls_write_msg (vls_handle_t vlsh, void *buf, size_t nbytes);
39 int vls_sendto (vls_handle_t vlsh, void *buf, int buflen, int flags,
40                 vppcom_endpt_t * ep);
41 int vls_attr (vls_handle_t vlsh, uint32_t op, void *buffer,
42               uint32_t * buflen);
43 vls_handle_t vls_epoll_create (void);
44 int vls_epoll_ctl (vls_handle_t ep_vlsh, int op, vls_handle_t vlsh,
45                    struct epoll_event *event);
46 int vls_epoll_wait (vls_handle_t ep_vlsh, struct epoll_event *events,
47                     int maxevents, double wait_for_time);
48 int vls_select (int n_bits, vcl_si_set * read_map, vcl_si_set * write_map,
49                 vcl_si_set * except_map, double wait_for_time);
50 vcl_session_handle_t vlsh_to_sh (vls_handle_t vlsh);
51 vcl_session_handle_t vlsh_to_session_index (vls_handle_t vlsh);
52 vls_handle_t vls_session_index_to_vlsh (uint32_t session_index);
53 int vls_app_create (char *app_name);
54 unsigned char vls_use_eventfd (void);
55 unsigned char vls_mt_wrk_supported (void);
56 int vls_use_real_epoll (void);
57 void vls_register_vcl_worker (void);
58
59 #endif /* SRC_VCL_VCL_LOCKED_H_ */
60
61 /*
62  * fd.io coding-style-patch-verification: ON
63  *
64  * Local Variables:
65  * eval: (c-set-style "gnu")
66  * End:
67  */