src/vcl/vppcom.h - fdio/vpp - Gitiles

 /*
  * Copyright (c) 2017-2019 Cisco and/or its affiliates.
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
  * You may obtain a copy of the License at:
  *
  *     http://www.apache.org/licenses/LICENSE-2.0
  *
  * Unless required by applicable law or agreed to in writing, software
  * distributed under the License is distributed on an "AS IS" BASIS,
  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */

 #ifndef included_vppcom_h
 #define included_vppcom_h

 #include <netdb.h>
 #include <errno.h>
 #include <sys/poll.h>
 #include <sys/epoll.h>

 /* *INDENT-OFF* */
 #ifdef __cplusplus
 extern "C"
 {
 #endif
 /* *INDENT-ON* */

 /*
  * VPPCOM Public API Definitions, Enums, and Data Structures
  */
 #define INVALID_SESSION_ID                  	((u32)~0)
 #define VPPCOM_CONF_DEFAULT                  	"/etc/vpp/vcl.conf"
 #define VPPCOM_ENV_CONF                      	"VCL_CONFIG"
 #define VPPCOM_ENV_DEBUG                     	"VCL_DEBUG"
 #define VPPCOM_ENV_API_PREFIX                	"VCL_API_PREFIX"
 #define VPPCOM_ENV_APP_PROXY_TRANSPORT_TCP   	"VCL_APP_PROXY_TRANSPORT_TCP"
 #define VPPCOM_ENV_APP_PROXY_TRANSPORT_UDP   	"VCL_APP_PROXY_TRANSPORT_UDP"
 #define VPPCOM_ENV_APP_NAMESPACE_ID          	"VCL_APP_NAMESPACE_ID"
 #define VPPCOM_ENV_APP_NAMESPACE_SECRET      	"VCL_APP_NAMESPACE_SECRET"
 #define VPPCOM_ENV_APP_SCOPE_LOCAL           	"VCL_APP_SCOPE_LOCAL"
 #define VPPCOM_ENV_APP_SCOPE_GLOBAL          	"VCL_APP_SCOPE_GLOBAL"
 #define VPPCOM_ENV_VPP_API_SOCKET           	"VCL_VPP_API_SOCKET"

 typedef enum
 {
   VPPCOM_PROTO_TCP = 0,
   VPPCOM_PROTO_UDP,
   VPPCOM_PROTO_SCTP,
   VPPCOM_PROTO_NONE,
   VPPCOM_PROTO_TLS,
   VPPCOM_PROTO_UDPC
 } vppcom_proto_t;

 static inline char *
 vppcom_proto_str (vppcom_proto_t proto)
 {
   char *proto_str;

   switch (proto)
     {
     case VPPCOM_PROTO_TCP:
       proto_str = "TCP";
       break;
     case VPPCOM_PROTO_UDP:
       proto_str = "UDP";
       break;
     case VPPCOM_PROTO_SCTP:
       proto_str = "SCTP";
       break;
     case VPPCOM_PROTO_TLS:
       proto_str = "TLS";
       break;
     case VPPCOM_PROTO_UDPC:
       proto_str = "UDPC";
       break;
     default:
       proto_str = "UNKNOWN";
       break;
     }
   return proto_str;
 }

 typedef enum
 {
   VPPCOM_IS_IP6 = 0,
   VPPCOM_IS_IP4,
 } vppcom_is_ip4_t;

 typedef struct vppcom_endpt_t_
 {
   uint8_t is_cut_thru;
   uint8_t is_ip4;
   uint8_t *ip;
   uint16_t port;
 } vppcom_endpt_t;

 typedef uint32_t vcl_session_handle_t;

 typedef enum
 {
   VPPCOM_OK = 0,
   VPPCOM_EAGAIN = -EAGAIN,
   VPPCOM_EWOULDBLOCK = -EWOULDBLOCK,
   VPPCOM_EFAULT = -EFAULT,
   VPPCOM_ENOMEM = -ENOMEM,
   VPPCOM_EINVAL = -EINVAL,
   VPPCOM_EBADFD = -EBADFD,
   VPPCOM_EAFNOSUPPORT = -EAFNOSUPPORT,
   VPPCOM_ECONNABORTED = -ECONNABORTED,
   VPPCOM_ECONNRESET = -ECONNRESET,
   VPPCOM_ENOTCONN = -ENOTCONN,
   VPPCOM_ECONNREFUSED = -ECONNREFUSED,
   VPPCOM_ETIMEDOUT = -ETIMEDOUT,
   VPPCOM_EEXIST = -EEXIST
 } vppcom_error_t;

 typedef enum
 {
   VPPCOM_ATTR_GET_NREAD,
   VPPCOM_ATTR_GET_NWRITE,
   VPPCOM_ATTR_GET_FLAGS,
   VPPCOM_ATTR_SET_FLAGS,
   VPPCOM_ATTR_GET_LCL_ADDR,
   VPPCOM_ATTR_GET_PEER_ADDR,
   VPPCOM_ATTR_GET_LIBC_EPFD,
   VPPCOM_ATTR_SET_LIBC_EPFD,
   VPPCOM_ATTR_GET_PROTOCOL,
   VPPCOM_ATTR_GET_LISTEN,
   VPPCOM_ATTR_GET_ERROR,
   VPPCOM_ATTR_GET_TX_FIFO_LEN,
   VPPCOM_ATTR_SET_TX_FIFO_LEN,
   VPPCOM_ATTR_GET_RX_FIFO_LEN,
   VPPCOM_ATTR_SET_RX_FIFO_LEN,
   VPPCOM_ATTR_GET_REUSEADDR,
   VPPCOM_ATTR_SET_REUSEADDR,
   VPPCOM_ATTR_GET_REUSEPORT,
   VPPCOM_ATTR_SET_REUSEPORT,
   VPPCOM_ATTR_GET_BROADCAST,
   VPPCOM_ATTR_SET_BROADCAST,
   VPPCOM_ATTR_GET_V6ONLY,
   VPPCOM_ATTR_SET_V6ONLY,
   VPPCOM_ATTR_GET_KEEPALIVE,
   VPPCOM_ATTR_SET_KEEPALIVE,
   VPPCOM_ATTR_GET_TCP_NODELAY,
   VPPCOM_ATTR_SET_TCP_NODELAY,
   VPPCOM_ATTR_GET_TCP_KEEPIDLE,
   VPPCOM_ATTR_SET_TCP_KEEPIDLE,
   VPPCOM_ATTR_GET_TCP_KEEPINTVL,
   VPPCOM_ATTR_SET_TCP_KEEPINTVL,
   VPPCOM_ATTR_GET_TCP_USER_MSS,
   VPPCOM_ATTR_SET_TCP_USER_MSS,
   VPPCOM_ATTR_SET_SHUT,
   VPPCOM_ATTR_GET_SHUT,
 } vppcom_attr_op_t;

 typedef struct _vcl_poll
 {
   uint32_t fds_ndx;
   vcl_session_handle_t sh;
   short events;
   short revents;
 } vcl_poll_t;

 typedef struct vppcom_data_segment_
 {
   unsigned char *data;
   uint32_t len;
 } vppcom_data_segment_t;

 typedef vppcom_data_segment_t vppcom_data_segments_t[2];

 typedef unsigned long vcl_si_set;

 /*
  * VPPCOM Public API Functions
  */
 static inline const char *
 vppcom_retval_str (int retval)
 {
   char *st;

   switch (retval)
     {
     case VPPCOM_OK:
       st = "VPPCOM_OK";
       break;

     case VPPCOM_EAGAIN:
       st = "VPPCOM_EAGAIN";
       break;

     case VPPCOM_EFAULT:
       st = "VPPCOM_EFAULT";
       break;

     case VPPCOM_ENOMEM:
       st = "VPPCOM_ENOMEM";
       break;

     case VPPCOM_EINVAL:
       st = "VPPCOM_EINVAL";
       break;

     case VPPCOM_EBADFD:
       st = "VPPCOM_EBADFD";
       break;

     case VPPCOM_EAFNOSUPPORT:
       st = "VPPCOM_EAFNOSUPPORT";
       break;

     case VPPCOM_ECONNABORTED:
       st = "VPPCOM_ECONNABORTED";
       break;

     case VPPCOM_ECONNRESET:
       st = "VPPCOM_ECONNRESET";
       break;

     case VPPCOM_ENOTCONN:
       st = "VPPCOM_ENOTCONN";
       break;

     case VPPCOM_ECONNREFUSED:
       st = "VPPCOM_ECONNREFUSED";
       break;

     case VPPCOM_ETIMEDOUT:
       st = "VPPCOM_ETIMEDOUT";
       break;

     default:
       st = "UNKNOWN_STATE";
       break;
     }

   return st;
 }

 /* TBD: make these constructor/destructor function */
 extern int vppcom_app_create (char *app_name);
 extern void vppcom_app_destroy (void);

 extern int vppcom_session_create (uint8_t proto, uint8_t is_nonblocking);
 extern int vppcom_session_close (uint32_t session_handle);
 extern int vppcom_session_bind (uint32_t session_handle, vppcom_endpt_t * ep);
 extern int vppcom_session_listen (uint32_t session_handle, uint32_t q_len);

 extern int vppcom_session_accept (uint32_t session_handle,
 				  vppcom_endpt_t * client_ep, uint32_t flags);

 extern int vppcom_session_connect (uint32_t session_handle,
 				   vppcom_endpt_t * server_ep);
 extern int vppcom_session_read (uint32_t session_handle, void *buf, size_t n);
 extern int vppcom_session_write (uint32_t session_handle, void *buf,
 				 size_t n);
 extern int vppcom_session_write_msg (uint32_t session_handle, void *buf,
 				     size_t n);

 extern int vppcom_select (int n_bits, vcl_si_set * read_map,
 			  vcl_si_set * write_map, vcl_si_set * except_map,
 			  double wait_for_time);

 extern int vppcom_epoll_create (void);
 extern int vppcom_epoll_ctl (uint32_t vep_handle, int op,
 			     uint32_t session_handle,
 			     struct epoll_event *event);
 extern int vppcom_epoll_wait (uint32_t vep_handle, struct epoll_event *events,
 			      int maxevents, double wait_for_time);
 extern int vppcom_session_attr (uint32_t session_handle, uint32_t op,
 				void *buffer, uint32_t * buflen);
 extern int vppcom_session_recvfrom (uint32_t session_handle, void *buffer,
 				    uint32_t buflen, int flags,
 				    vppcom_endpt_t * ep);
 extern int vppcom_session_sendto (uint32_t session_handle, void *buffer,
 				  uint32_t buflen, int flags,
 				  vppcom_endpt_t * ep);
 extern int vppcom_poll (vcl_poll_t * vp, uint32_t n_sids,
 			double wait_for_time);
 extern int vppcom_mq_epoll_fd (void);
 extern int vppcom_session_index (vcl_session_handle_t session_handle);
 extern int vppcom_session_worker (vcl_session_handle_t session_handle);

 extern int vppcom_session_read_segments (uint32_t session_handle,
 					 vppcom_data_segments_t ds);
 extern void vppcom_session_free_segments (uint32_t session_handle,
 					  vppcom_data_segments_t ds);
 extern int vppcom_session_tls_add_cert (uint32_t session_handle, char *cert,
 					uint32_t cert_len);
 extern int vppcom_session_tls_add_key (uint32_t session_handle, char *key,
 				       uint32_t key_len);
 extern int vppcom_data_segment_copy (void *buf, vppcom_data_segments_t ds,
 				     uint32_t max_bytes);

 /**
  * Request from application to register a new worker
  *
  * Expectation is that applications will make use of this after a new pthread
  * is spawned.
  */
 extern int vppcom_worker_register (void);

 /**
  * Retrieve current worker index
  */
 extern int vppcom_worker_index (void);

 /**
  * Returns the current worker's message queues epoll fd
  *
  * This only works if vcl is configured to do eventfd based message queue
  * notifications.
  */
 extern int vppcom_worker_mqs_epfd (void);

 /* *INDENT-OFF* */
 #ifdef __cplusplus
 }
 #endif
 /* *INDENT-ON* */

 #endif /* included_vppcom_h */

 /*
  * fd.io coding-style-patch-verification: ON
  *
  * Local Variables:
  * eval: (c-set-style "gnu")
  * End:
  */
	/*
	* Copyright (c) 2017-2019 Cisco and/or its affiliates.
	* Licensed under the Apache License, Version 2.0 (the "License");
	* you may not use this file except in compliance with the License.
	* You may obtain a copy of the License at:
	*
	* http://www.apache.org/licenses/LICENSE-2.0
	*
	* Unless required by applicable law or agreed to in writing, software
	* distributed under the License is distributed on an "AS IS" BASIS,
	* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
	* See the License for the specific language governing permissions and
	* limitations under the License.
	*/

	#ifndef included_vppcom_h
	#define included_vppcom_h

	#include <netdb.h>
	#include <errno.h>
	#include <sys/poll.h>
	#include <sys/epoll.h>

	/* INDENT-OFF */
	#ifdef __cplusplus
	extern "C"
	{
	#endif
	/* INDENT-ON */

	/*
	* VPPCOM Public API Definitions, Enums, and Data Structures
	*/
	#define INVALID_SESSION_ID ((u32)~0)
	#define VPPCOM_CONF_DEFAULT "/etc/vpp/vcl.conf"
	#define VPPCOM_ENV_CONF "VCL_CONFIG"
	#define VPPCOM_ENV_DEBUG "VCL_DEBUG"
	#define VPPCOM_ENV_API_PREFIX "VCL_API_PREFIX"
	#define VPPCOM_ENV_APP_PROXY_TRANSPORT_TCP "VCL_APP_PROXY_TRANSPORT_TCP"
	#define VPPCOM_ENV_APP_PROXY_TRANSPORT_UDP "VCL_APP_PROXY_TRANSPORT_UDP"
	#define VPPCOM_ENV_APP_NAMESPACE_ID "VCL_APP_NAMESPACE_ID"
	#define VPPCOM_ENV_APP_NAMESPACE_SECRET "VCL_APP_NAMESPACE_SECRET"
	#define VPPCOM_ENV_APP_SCOPE_LOCAL "VCL_APP_SCOPE_LOCAL"
	#define VPPCOM_ENV_APP_SCOPE_GLOBAL "VCL_APP_SCOPE_GLOBAL"
	#define VPPCOM_ENV_VPP_API_SOCKET "VCL_VPP_API_SOCKET"

	typedef enum
	{
	VPPCOM_PROTO_TCP = 0,
	VPPCOM_PROTO_UDP,
	VPPCOM_PROTO_SCTP,
	VPPCOM_PROTO_NONE,
	VPPCOM_PROTO_TLS,
	VPPCOM_PROTO_UDPC
	} vppcom_proto_t;

	static inline char *
	vppcom_proto_str (vppcom_proto_t proto)
	{
	char *proto_str;

	switch (proto)
	{
	case VPPCOM_PROTO_TCP:
	proto_str = "TCP";
	break;
	case VPPCOM_PROTO_UDP:
	proto_str = "UDP";
	break;
	case VPPCOM_PROTO_SCTP:
	proto_str = "SCTP";
	break;
	case VPPCOM_PROTO_TLS:
	proto_str = "TLS";
	break;
	case VPPCOM_PROTO_UDPC:
	proto_str = "UDPC";
	break;
	default:
	proto_str = "UNKNOWN";
	break;
	}
	return proto_str;
	}

	typedef enum
	{
	VPPCOM_IS_IP6 = 0,
	VPPCOM_IS_IP4,
	} vppcom_is_ip4_t;

	typedef struct vppcom_endpt_t_
	{
	uint8_t is_cut_thru;
	uint8_t is_ip4;
	uint8_t *ip;
	uint16_t port;
	} vppcom_endpt_t;

	typedef uint32_t vcl_session_handle_t;

	typedef enum
	{
	VPPCOM_OK = 0,
	VPPCOM_EAGAIN = -EAGAIN,
	VPPCOM_EWOULDBLOCK = -EWOULDBLOCK,
	VPPCOM_EFAULT = -EFAULT,
	VPPCOM_ENOMEM = -ENOMEM,
	VPPCOM_EINVAL = -EINVAL,
	VPPCOM_EBADFD = -EBADFD,
	VPPCOM_EAFNOSUPPORT = -EAFNOSUPPORT,
	VPPCOM_ECONNABORTED = -ECONNABORTED,
	VPPCOM_ECONNRESET = -ECONNRESET,
	VPPCOM_ENOTCONN = -ENOTCONN,
	VPPCOM_ECONNREFUSED = -ECONNREFUSED,
	VPPCOM_ETIMEDOUT = -ETIMEDOUT,
	VPPCOM_EEXIST = -EEXIST
	} vppcom_error_t;

	typedef enum
	{
	VPPCOM_ATTR_GET_NREAD,
	VPPCOM_ATTR_GET_NWRITE,
	VPPCOM_ATTR_GET_FLAGS,
	VPPCOM_ATTR_SET_FLAGS,
	VPPCOM_ATTR_GET_LCL_ADDR,
	VPPCOM_ATTR_GET_PEER_ADDR,
	VPPCOM_ATTR_GET_LIBC_EPFD,
	VPPCOM_ATTR_SET_LIBC_EPFD,
	VPPCOM_ATTR_GET_PROTOCOL,
	VPPCOM_ATTR_GET_LISTEN,
	VPPCOM_ATTR_GET_ERROR,
	VPPCOM_ATTR_GET_TX_FIFO_LEN,
	VPPCOM_ATTR_SET_TX_FIFO_LEN,
	VPPCOM_ATTR_GET_RX_FIFO_LEN,
	VPPCOM_ATTR_SET_RX_FIFO_LEN,
	VPPCOM_ATTR_GET_REUSEADDR,
	VPPCOM_ATTR_SET_REUSEADDR,
	VPPCOM_ATTR_GET_REUSEPORT,
	VPPCOM_ATTR_SET_REUSEPORT,
	VPPCOM_ATTR_GET_BROADCAST,
	VPPCOM_ATTR_SET_BROADCAST,
	VPPCOM_ATTR_GET_V6ONLY,
	VPPCOM_ATTR_SET_V6ONLY,
	VPPCOM_ATTR_GET_KEEPALIVE,
	VPPCOM_ATTR_SET_KEEPALIVE,
	VPPCOM_ATTR_GET_TCP_NODELAY,
	VPPCOM_ATTR_SET_TCP_NODELAY,
	VPPCOM_ATTR_GET_TCP_KEEPIDLE,
	VPPCOM_ATTR_SET_TCP_KEEPIDLE,
	VPPCOM_ATTR_GET_TCP_KEEPINTVL,
	VPPCOM_ATTR_SET_TCP_KEEPINTVL,
	VPPCOM_ATTR_GET_TCP_USER_MSS,
	VPPCOM_ATTR_SET_TCP_USER_MSS,
	VPPCOM_ATTR_SET_SHUT,
	VPPCOM_ATTR_GET_SHUT,
	} vppcom_attr_op_t;

	typedef struct _vcl_poll
	{
	uint32_t fds_ndx;
	vcl_session_handle_t sh;
	short events;
	short revents;
	} vcl_poll_t;

	typedef struct vppcom_data_segment_
	{
	unsigned char *data;
	uint32_t len;
	} vppcom_data_segment_t;

	typedef vppcom_data_segment_t vppcom_data_segments_t[2];

	typedef unsigned long vcl_si_set;

	/*
	* VPPCOM Public API Functions
	*/
	static inline const char *
	vppcom_retval_str (int retval)
	{
	char *st;

	switch (retval)
	{
	case VPPCOM_OK:
	st = "VPPCOM_OK";
	break;

	case VPPCOM_EAGAIN:
	st = "VPPCOM_EAGAIN";
	break;

	case VPPCOM_EFAULT:
	st = "VPPCOM_EFAULT";
	break;

	case VPPCOM_ENOMEM:
	st = "VPPCOM_ENOMEM";
	break;

	case VPPCOM_EINVAL:
	st = "VPPCOM_EINVAL";
	break;

	case VPPCOM_EBADFD:
	st = "VPPCOM_EBADFD";
	break;

	case VPPCOM_EAFNOSUPPORT:
	st = "VPPCOM_EAFNOSUPPORT";
	break;

	case VPPCOM_ECONNABORTED:
	st = "VPPCOM_ECONNABORTED";
	break;

	case VPPCOM_ECONNRESET:
	st = "VPPCOM_ECONNRESET";
	break;

	case VPPCOM_ENOTCONN:
	st = "VPPCOM_ENOTCONN";
	break;

	case VPPCOM_ECONNREFUSED:
	st = "VPPCOM_ECONNREFUSED";
	break;

	case VPPCOM_ETIMEDOUT:
	st = "VPPCOM_ETIMEDOUT";
	break;

	default:
	st = "UNKNOWN_STATE";
	break;
	}

	return st;
	}

	/* TBD: make these constructor/destructor function */
	extern int vppcom_app_create (char *app_name);
	extern void vppcom_app_destroy (void);

	extern int vppcom_session_create (uint8_t proto, uint8_t is_nonblocking);
	extern int vppcom_session_close (uint32_t session_handle);
	extern int vppcom_session_bind (uint32_t session_handle, vppcom_endpt_t * ep);
	extern int vppcom_session_listen (uint32_t session_handle, uint32_t q_len);

	extern int vppcom_session_accept (uint32_t session_handle,
	vppcom_endpt_t * client_ep, uint32_t flags);

	extern int vppcom_session_connect (uint32_t session_handle,
	vppcom_endpt_t * server_ep);
	extern int vppcom_session_read (uint32_t session_handle, void *buf, size_t n);
	extern int vppcom_session_write (uint32_t session_handle, void *buf,
	size_t n);
	extern int vppcom_session_write_msg (uint32_t session_handle, void *buf,
	size_t n);

	extern int vppcom_select (int n_bits, vcl_si_set * read_map,
	vcl_si_set * write_map, vcl_si_set * except_map,
	double wait_for_time);

	extern int vppcom_epoll_create (void);
	extern int vppcom_epoll_ctl (uint32_t vep_handle, int op,
	uint32_t session_handle,
	struct epoll_event *event);
	extern int vppcom_epoll_wait (uint32_t vep_handle, struct epoll_event *events,
	int maxevents, double wait_for_time);
	extern int vppcom_session_attr (uint32_t session_handle, uint32_t op,
	void buffer, uint32_t buflen);
	extern int vppcom_session_recvfrom (uint32_t session_handle, void *buffer,
	uint32_t buflen, int flags,
	vppcom_endpt_t * ep);
	extern int vppcom_session_sendto (uint32_t session_handle, void *buffer,
	uint32_t buflen, int flags,
	vppcom_endpt_t * ep);
	extern int vppcom_poll (vcl_poll_t * vp, uint32_t n_sids,
	double wait_for_time);
	extern int vppcom_mq_epoll_fd (void);
	extern int vppcom_session_index (vcl_session_handle_t session_handle);
	extern int vppcom_session_worker (vcl_session_handle_t session_handle);

	extern int vppcom_session_read_segments (uint32_t session_handle,
	vppcom_data_segments_t ds);
	extern void vppcom_session_free_segments (uint32_t session_handle,
	vppcom_data_segments_t ds);
	extern int vppcom_session_tls_add_cert (uint32_t session_handle, char *cert,
	uint32_t cert_len);
	extern int vppcom_session_tls_add_key (uint32_t session_handle, char *key,
	uint32_t key_len);
	extern int vppcom_data_segment_copy (void *buf, vppcom_data_segments_t ds,
	uint32_t max_bytes);

	/**
	* Request from application to register a new worker
	*
	* Expectation is that applications will make use of this after a new pthread
	* is spawned.
	*/
	extern int vppcom_worker_register (void);

	/**
	* Retrieve current worker index
	*/
	extern int vppcom_worker_index (void);

	/**
	* Returns the current worker's message queues epoll fd
	*
	* This only works if vcl is configured to do eventfd based message queue
	* notifications.
	*/
	extern int vppcom_worker_mqs_epfd (void);

	/* INDENT-OFF */
	#ifdef __cplusplus
	}
	#endif
	/* INDENT-ON */

	#endif /* included_vppcom_h */

	/*
	* fd.io coding-style-patch-verification: ON
	*
	* Local Variables:
	* eval: (c-set-style "gnu")
	* End:
	*/