/*
- * Copyright (c) 2017 Cisco and/or its affiliates.
+ * Copyright (c) 2017-2020 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:
#include <netdb.h>
#include <errno.h>
+#include <sys/fcntl.h>
#include <sys/poll.h>
#include <sys/epoll.h>
/*
* VPPCOM Public API Definitions, Enums, and Data Structures
*/
-#define INVALID_SESSION_ID (~0)
+#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"
{
VPPCOM_PROTO_TCP = 0,
VPPCOM_PROTO_UDP,
+ VPPCOM_PROTO_NONE,
+ VPPCOM_PROTO_TLS,
+ VPPCOM_PROTO_QUIC,
} vppcom_proto_t;
-static inline char *
-vppcom_proto_str (vppcom_proto_t proto)
-{
- char *proto_str;
-
- switch (proto)
- {
- case VPPCOM_PROTO_TCP:
- proto_str = "VPPCOM_PROTO_TCP";
- break;
- case VPPCOM_PROTO_UDP:
- proto_str = "VPPCOM_PROTO_UDP";
- break;
- default:
- proto_str = "UNKNOWN";
- break;
- }
- return proto_str;
-}
-
typedef enum
{
VPPCOM_IS_IP6 = 0,
uint8_t is_ip4;
uint8_t *ip;
uint16_t port;
+ uint64_t parent_handle;
} vppcom_endpt_t;
+typedef uint32_t vcl_session_handle_t;
+
typedef enum
{
VPPCOM_OK = 0,
VPPCOM_EAGAIN = -EAGAIN,
VPPCOM_EWOULDBLOCK = -EWOULDBLOCK,
+ VPPCOM_EINPROGRESS = -EINPROGRESS,
VPPCOM_EFAULT = -EFAULT,
VPPCOM_ENOMEM = -ENOMEM,
VPPCOM_EINVAL = -EINVAL,
VPPCOM_ATTR_GET_FLAGS,
VPPCOM_ATTR_SET_FLAGS,
VPPCOM_ATTR_GET_LCL_ADDR,
+ VPPCOM_ATTR_SET_LCL_ADDR,
VPPCOM_ATTR_GET_PEER_ADDR,
VPPCOM_ATTR_GET_LIBC_EPFD,
VPPCOM_ATTR_SET_LIBC_EPFD,
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_SET_CONNECTED,
} vppcom_attr_op_t;
typedef struct _vcl_poll
{
uint32_t fds_ndx;
- uint32_t sid;
+ vcl_session_handle_t sh;
short events;
short revents;
} vcl_poll_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 int vppcom_app_create (const 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_connect (uint32_t session_handle,
vppcom_endpt_t * server_ep);
+extern int vppcom_session_stream_connect (uint32_t session_handle,
+ uint32_t parent_session_handle);
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 (unsigned long n_bits,
- unsigned long *read_map,
- unsigned long *write_map,
- unsigned long *except_map, double wait_for_time);
+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,
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 (uint32_t session_handle);
-extern int vppcom_session_handle (uint32_t session_index);
+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);
+ vppcom_data_segment_t * ds,
+ uint32_t n_segments,
+ uint32_t max_bytes);
extern void vppcom_session_free_segments (uint32_t session_handle,
- vppcom_data_segments_t ds);
-extern int vppcom_data_segment_copy (void *buf, vppcom_data_segments_t ds,
- uint32_t max_bytes);
+ uint32_t n_bytes);
+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_unformat_proto (uint8_t * proto, char *proto_str);
+extern int vppcom_session_is_connectable_listener (uint32_t session_handle);
+extern int vppcom_session_listener (uint32_t session_handle);
+extern int vppcom_session_n_accepted (uint32_t session_handle);
+
+extern const char *vppcom_proto_str (vppcom_proto_t proto);
+extern const char *vppcom_retval_str (int retval);
/**
* Request from application to register a new worker
*/
extern int vppcom_worker_register (void);
+/**
+ * Unregister current worker
+ */
+extern void vppcom_worker_unregister (void);
+
/**
* Retrieve current worker index
*/
extern int vppcom_worker_index (void);
+/**
+ * Set current worker index
+ */
+extern void vppcom_worker_index_set (int);
+
+/**
+ * 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
}