Gitiles
Code Review Sign In
gerrit.nordix.org / fdio / vpp / f7f809c298104dc3026106fb498f474d5d8720cc / . / src / uri / vppcom.h
blob: b7c802897d926f6f78e25e967ddb00130875117d [file] [log] [blame]
Dave Wallace543852a2017-08-03 02:11:34 -0400[diff] [blame]1/*
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:
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>
Dave Wallacef7f809c2017-10-03 01:48:42 -0400[diff] [blame^]21#include <sys/epoll.h>
Dave Wallace543852a2017-08-03 02:11:34 -0400[diff] [blame]22
23/*
24 * VPPCOM Public API Definitions, Enums, and Data Structures
25 */
26#define INVALID_SESSION_ID (~0)
27#define VPPCOM_VRF_DEFAULT 0
28#define VPPCOM_CONF_ENV "VPPCOM_CONF"
29#define VPPCOM_CONF_DEFAULT "/etc/vpp/vppcom.conf"
30
31typedef enum
32{
33 VPPCOM_PROTO_TCP = 0,
34 VPPCOM_PROTO_UDP,
35} vppcom_proto_t;
36
37typedef enum
38{
39 VPPCOM_IS_IP6 = 0,
40 VPPCOM_IS_IP4,
41} vppcom_is_ip4_t;
42
43typedef struct vppcom_endpt_t_
44{
45 uint32_t vrf;
46 uint8_t is_cut_thru;
47 uint8_t is_ip4;
48 uint8_t *ip;
49 uint16_t port;
50} vppcom_endpt_t;
51
52typedef enum
53{
54 VPPCOM_OK = 0,
55 VPPCOM_EAGAIN = -EAGAIN,
56 VPPCOM_EINVAL = -EINVAL,
57 VPPCOM_EBADFD = -EBADFD,
58 VPPCOM_EAFNOSUPPORT = -EAFNOSUPPORT,
59 VPPCOM_ECONNRESET = -ECONNRESET,
60 VPPCOM_ECONNREFUSED = -ECONNREFUSED,
61 VPPCOM_ETIMEDOUT = -ETIMEDOUT,
62} vppcom_error_t;
63
64/*
65 * VPPCOM Public API Functions
66 */
67static inline const char *
68vppcom_retval_str (int retval)
69{
70 char *st;
71
72 switch (retval)
73 {
74 case VPPCOM_OK:
75 st = "VPPCOM_OK";
76 break;
77
78 case VPPCOM_EAGAIN:
79 st = "VPPCOM_EAGAIN";
80 break;
81
82 case VPPCOM_EINVAL:
83 st = "VPPCOM_EINVAL";
84 break;
85
86 case VPPCOM_EBADFD:
87 st = "VPPCOM_EBADFD";
88 break;
89
90 case VPPCOM_EAFNOSUPPORT:
91 st = "VPPCOM_EAFNOSUPPORT";
92 break;
93
94 case VPPCOM_ECONNRESET:
95 st = "VPPCOM_ECONNRESET";
96 break;
97
98 case VPPCOM_ECONNREFUSED:
99 st = "VPPCOM_ECONNREFUSED";
100 break;
101
102 case VPPCOM_ETIMEDOUT:
103 st = "VPPCOM_ETIMEDOUT";
104 break;
105
106 default:
107 st = "UNKNOWN_STATE";
108 break;
109 }
110
111 return st;
112}
113
114static inline int
115is_vcom_fd (int fd)
116{
117#define VPPCOM_FD_OFFSET (1 << 30)
118 return (fd >= VPPCOM_FD_OFFSET);
119}
120
121/* TBD: make these constructor/destructor function */
122extern int vppcom_app_create (char *app_name);
123extern void vppcom_app_destroy (void);
124
125extern int vppcom_session_create (uint32_t vrf, uint8_t proto,
126 uint8_t is_nonblocking);
127extern int vppcom_session_close (uint32_t session_index);
128
129extern int vppcom_session_bind (uint32_t session_index, vppcom_endpt_t * ep);
130extern int vppcom_session_listen (uint32_t session_index, uint32_t q_len);
131extern int vppcom_session_accept (uint32_t session_index,
132 vppcom_endpt_t * client_ep,
133 double wait_for_time);
134
135extern int vppcom_session_connect (uint32_t session_index,
136 vppcom_endpt_t * server_ep);
137extern int vppcom_session_read (uint32_t session_index, void *buf, int n);
138extern int vppcom_session_write (uint32_t session_index, void *buf, int n);
139
140extern int vppcom_select (unsigned long n_bits,
141 unsigned long *read_map,
142 unsigned long *write_map,
143 unsigned long *except_map, double wait_for_time);
144
Dave Wallacef7f809c2017-10-03 01:48:42 -0400[diff] [blame^]145extern int vppcom_epoll_create (void);
146extern int vppcom_epoll_ctl (uint32_t vep_idx, int op,
147 uint32_t session_index,
148 struct epoll_event *event);
149extern int vppcom_epoll_wait (uint32_t vep_idx, struct epoll_event *events,
150 int maxevents, double wait_for_time);
151
Dave Wallace543852a2017-08-03 02:11:34 -0400[diff] [blame]152#endif /* included_vppcom_h */
153
154/*
155 * fd.io coding-style-patch-verification: ON
156 *
157 * Local Variables:
158 * eval: (c-set-style "gnu")
159 * End:
160 */