src/uri/vppcom.h

   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>
  21 #include <sys/epoll.h>
  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
  31 typedef enum
  32 {
  33   VPPCOM_PROTO_TCP = 0,
  34   VPPCOM_PROTO_UDP,
  35 } vppcom_proto_t;
  36
  37 typedef enum
  38 {
  39   VPPCOM_IS_IP6 = 0,
  40   VPPCOM_IS_IP4,
  41 } vppcom_is_ip4_t;
  42
  43 typedef 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
  52 typedef 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 typedef enum
  65 {
  66   VPPCOM_ATTR_GET_NREAD,
  67   VPPCOM_ATTR_PEEK_NREAD,
  68   VPPCOM_ATTR_GET_FLAGS,
  69   VPPCOM_ATTR_SET_FLAGS,
  70   VPPCOM_ATTR_GET_LCL_ADDR,
  71   VPPCOM_ATTR_GET_PEER_ADDR,
  72   VPPCOM_ATTR_SET_REUSEADDR,
  73   VPPCOM_ATTR_SET_BROADCAST,
  74   VPPCOM_ATTR_SET_V6ONLY,
  75 } vppcom_attr_op_t;
  76
  77 /*
  78  * VPPCOM Public API Functions
  79  */
  80 static inline const char *
  81 vppcom_retval_str (int retval)
  82 {
  83   char *st;
  84
  85   switch (retval)
  86     {
  87     case VPPCOM_OK:
  88       st = "VPPCOM_OK";
  89       break;
  90
  91     case VPPCOM_EAGAIN:
  92       st = "VPPCOM_EAGAIN";
  93       break;
  94
  95     case VPPCOM_EINVAL:
  96       st = "VPPCOM_EINVAL";
  97       break;
  98
  99     case VPPCOM_EBADFD:
 100       st = "VPPCOM_EBADFD";
 101       break;
 102
 103     case VPPCOM_EAFNOSUPPORT:
 104       st = "VPPCOM_EAFNOSUPPORT";
 105       break;
 106
 107     case VPPCOM_ECONNRESET:
 108       st = "VPPCOM_ECONNRESET";
 109       break;
 110
 111     case VPPCOM_ECONNREFUSED:
 112       st = "VPPCOM_ECONNREFUSED";
 113       break;
 114
 115     case VPPCOM_ETIMEDOUT:
 116       st = "VPPCOM_ETIMEDOUT";
 117       break;
 118
 119     default:
 120       st = "UNKNOWN_STATE";
 121       break;
 122     }
 123
 124   return st;
 125 }
 126
 127 static inline int
 128 is_vcom_fd (int fd)
 129 {
 130 #define VPPCOM_FD_OFFSET (1 << 30)
 131   return (fd >= VPPCOM_FD_OFFSET);
 132 }
 133
 134 /* TBD: make these constructor/destructor function */
 135 extern int vppcom_app_create (char *app_name);
 136 extern void vppcom_app_destroy (void);
 137
 138 extern int vppcom_session_create (uint32_t vrf, uint8_t proto,
 139                                   uint8_t is_nonblocking);
 140 extern int vppcom_session_close (uint32_t session_index);
 141
 142 extern int vppcom_session_bind (uint32_t session_index, vppcom_endpt_t * ep);
 143 extern int vppcom_session_listen (uint32_t session_index, uint32_t q_len);
 144 extern int vppcom_session_accept (uint32_t session_index,
 145                                   vppcom_endpt_t * client_ep,
 146                                   double wait_for_time);
 147
 148 extern int vppcom_session_connect (uint32_t session_index,
 149                                    vppcom_endpt_t * server_ep);
 150 extern int vppcom_session_read (uint32_t session_index, void *buf, int n);
 151 extern int vppcom_session_write (uint32_t session_index, void *buf, int n);
 152
 153 extern int vppcom_select (unsigned long n_bits,
 154                           unsigned long *read_map,
 155                           unsigned long *write_map,
 156                           unsigned long *except_map, double wait_for_time);
 157
 158 extern int vppcom_epoll_create (void);
 159 extern int vppcom_epoll_ctl (uint32_t vep_idx, int op,
 160                              uint32_t session_index,
 161                              struct epoll_event *event);
 162 extern int vppcom_epoll_wait (uint32_t vep_idx, struct epoll_event *events,
 163                               int maxevents, double wait_for_time);
 164 extern int vppcom_session_attr (uint32_t session_index, uint32_t op,
 165                                 void *buffer, uint32_t * buflen);
 166
 167 #endif /* included_vppcom_h */
 168
 169 /*
 170  * fd.io coding-style-patch-verification: ON
 171  *
 172  * Local Variables:
 173  * eval: (c-set-style "gnu")
 174  * End:
 175  */