session tcp vcl: api to update connection attributes
[vpp.git] / src / vcl / vppcom.h
index 49cff41..d956b5f 100644 (file)
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2017-2019 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:
@@ -18,6 +18,7 @@
 
 #include <netdb.h>
 #include <errno.h>
+#include <sys/fcntl.h>
 #include <sys/poll.h>
 #include <sys/epoll.h>
 
@@ -35,7 +36,6 @@ extern "C"
 #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"
@@ -43,67 +43,49 @@ extern "C"
 #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"
+#define VPPCOM_ENV_VPP_SAPI_SOCKET             "VCL_VPP_SAPI_SOCKET"
+
+  typedef enum
+  {
+    VPPCOM_PROTO_TCP = 0,
+    VPPCOM_PROTO_UDP,
+    VPPCOM_PROTO_NONE,
+    VPPCOM_PROTO_TLS,
+    VPPCOM_PROTO_QUIC,
+    VPPCOM_PROTO_DTLS,
+  } vppcom_proto_t;
+
+  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;
+    uint64_t parent_handle;
+  } vppcom_endpt_t;
 
-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 uint32_t vcl_session_handle_t;
 
-typedef struct vppcom_endpt_t_
+typedef struct vppcom_cert_key_pair_
 {
-  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;
+  char *cert;
+  char *key;
+  uint32_t cert_len;
+  uint32_t key_len;
+} vppcom_cert_key_pair_t;
 
 typedef enum
 {
   VPPCOM_OK = 0,
   VPPCOM_EAGAIN = -EAGAIN,
   VPPCOM_EWOULDBLOCK = -EWOULDBLOCK,
+  VPPCOM_EINPROGRESS = -EINPROGRESS,
   VPPCOM_EFAULT = -EFAULT,
   VPPCOM_ENOMEM = -ENOMEM,
   VPPCOM_EINVAL = -EINVAL,
@@ -114,7 +96,8 @@ typedef enum
   VPPCOM_ENOTCONN = -ENOTCONN,
   VPPCOM_ECONNREFUSED = -ECONNREFUSED,
   VPPCOM_ETIMEDOUT = -ETIMEDOUT,
-  VPPCOM_EEXIST = -EEXIST
+  VPPCOM_EEXIST = -EEXIST,
+  VPPCOM_ENOPROTOOPT = -ENOPROTOOPT
 } vppcom_error_t;
 
 typedef enum
@@ -124,6 +107,7 @@ typedef enum
   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,
@@ -154,6 +138,11 @@ typedef enum
   VPPCOM_ATTR_SET_TCP_USER_MSS,
   VPPCOM_ATTR_SET_SHUT,
   VPPCOM_ATTR_GET_SHUT,
+  VPPCOM_ATTR_SET_CONNECTED,
+  VPPCOM_ATTR_SET_CKPAIR,
+  VPPCOM_ATTR_SET_VRF,
+  VPPCOM_ATTR_GET_VRF,
+  VPPCOM_ATTR_GET_DOMAIN,
 } vppcom_attr_op_t;
 
 typedef struct _vcl_poll
@@ -177,71 +166,8 @@ 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);
@@ -254,6 +180,8 @@ extern int vppcom_session_accept (uint32_t session_handle,
 
 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);
@@ -285,15 +213,20 @@ 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_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);
+                                         uint32_t n_bytes);
+extern int vppcom_add_cert_key_pair (vppcom_cert_key_pair_t *ckpair);
+extern int vppcom_del_cert_key_pair (uint32_t ckpair_index);
+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
@@ -303,11 +236,21 @@ extern int vppcom_data_segment_copy (void *buf, vppcom_data_segments_t ds,
  */
 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
  *