vcl: postpone unhandled ctrl events if needed
[vpp.git] / src / vcl / vcl_private.h
index bbcc3fa..647532d 100644 (file)
@@ -62,23 +62,18 @@ typedef enum
   STATE_APP_READY
 } vcl_bapi_app_state_t;
 
-typedef enum
-{
-  STATE_CLOSED = 0,
-  STATE_CONNECT = 0x01,
-  STATE_LISTEN = 0x02,
-  STATE_ACCEPT = 0x04,
-  STATE_VPP_CLOSING = 0x08,
-  STATE_DISCONNECT = 0x10,
-  STATE_DETACHED = 0x20,
-  STATE_UPDATED = 0x40,
-  STATE_LISTEN_NO_MQ = 0x80,
+typedef enum vcl_session_state_
+{
+  VCL_STATE_CLOSED,
+  VCL_STATE_LISTEN,
+  VCL_STATE_READY,
+  VCL_STATE_VPP_CLOSING,
+  VCL_STATE_DISCONNECT,
+  VCL_STATE_DETACHED,
+  VCL_STATE_UPDATED,
+  VCL_STATE_LISTEN_NO_MQ,
 } vcl_session_state_t;
 
-#define SERVER_STATE_OPEN  (STATE_ACCEPT|STATE_VPP_CLOSING)
-#define CLIENT_STATE_OPEN  (STATE_CONNECT|STATE_VPP_CLOSING)
-#define STATE_OPEN (SERVER_STATE_OPEN | CLIENT_STATE_OPEN)
-
 typedef struct epoll_event vppcom_epoll_event_t;
 
 typedef struct
@@ -136,54 +131,41 @@ typedef enum
   VCL_SESS_ATTR_MAX
 } vppcom_session_attr_t;
 
-#define VCL_SESS_ATTR_SET(ATTR, VAL)            \
-do {                                            \
-  (ATTR) |= 1 << (VAL);                         \
- } while (0)
-
-#define VCL_SESS_ATTR_CLR(ATTR, VAL)            \
-do {                                            \
-  (ATTR) &= ~(1 << (VAL));                      \
- } while (0)
-
-#define VCL_SESS_ATTR_TEST(ATTR, VAL)           \
-  ((ATTR) & (1 << (VAL)) ? 1 : 0)
-
 typedef enum vcl_session_flags_
 {
   VCL_SESSION_F_CONNECTED = 1 << 0,
+  VCL_SESSION_F_IS_VEP = 1 << 1,
+  VCL_SESSION_F_IS_VEP_SESSION = 1 << 2,
+  VCL_SESSION_F_HAS_RX_EVT = 1 << 3,
 } __clib_packed vcl_session_flags_t;
 
-typedef struct
+typedef struct vcl_session_
 {
   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
+
 #define _(type, name) type name;
   foreach_app_session_field
 #undef _
-  u32 sndbuf_size;             // VPP-TBD: Hack until support setsockopt(SO_SNDBUF)
-  u32 rcvbuf_size;             // VPP-TBD: Hack until support setsockopt(SO_RCVBUF)
-  u32 user_mss;                        // VPP-TBD: Hack until support setsockopt(TCP_MAXSEG)
-  u64 vpp_handle;
-  u32 vpp_thread_index;
+  vcl_session_flags_t flags;   /**< see @ref vcl_session_flags_t */
+  u32 rx_bytes_pending;                /**< bytes rx-ed as segs but not yet freed */
 
   svm_fifo_t *ct_rx_fifo;
   svm_fifo_t *ct_tx_fifo;
+  vcl_session_msg_t *accept_evts_fifo;
 
-  /* Socket configuration state */
-  u8 is_vep;
-  u8 is_vep_session;
-  vcl_session_flags_t flags;
-  /* VCL session index of the listening session (if any) */
-  u32 listener_index;
-  /* Accepted sessions on this listener */
-  int n_accepted_sessions;
-  u8 has_rx_evt;
-  u32 attr;
+  u64 vpp_handle;
+  u32 vpp_thread_index;
+  u32 listener_index;          /**< index of parent listener (if any) */
+  int n_accepted_sessions;     /**< sessions accepted by this listener */
+  u32 attributes;              /**< see @ref vppcom_session_attr_t */
   u64 parent_handle;
-  vppcom_epoll_t vep;
   int libc_epfd;
-  svm_msg_q_t *our_evt_q;
-  vcl_session_msg_t *accept_evts_fifo;
+  vppcom_epoll_t vep;
+
+  u32 sndbuf_size;             // VPP-TBD: Hack until support setsockopt(SO_SNDBUF)
+  u32 rcvbuf_size;             // VPP-TBD: Hack until support setsockopt(SO_RCVBUF)
+  u32 user_mss;                        // VPP-TBD: Hack until support setsockopt(TCP_MAXSEG)
+
 #if VCL_ELOG
   elog_track_t elog_track;
 #endif
@@ -252,8 +234,11 @@ typedef struct vcl_worker_
   /** Worker index in vpp*/
   u32 vpp_wrk_index;
 
-  /** VPP bapi client handle */
-  u32 bapi_client_index;
+  /**
+   * Generic api client handle. When binary api is in used, it stores
+   * the "client_index" and when socket api is use, it stores the sapi
+   * client handle */
+  u32 api_client_handle;
 
   /** VPP binary api input queue */
   svm_queue_t *vl_input_queue;
@@ -313,6 +298,11 @@ typedef struct vcl_worker_
   volatile int rpc_done;
 } vcl_worker_t;
 
+STATIC_ASSERT (sizeof (session_disconnected_msg_t) <= 16,
+              "disconnected must fit in session_event_t");
+STATIC_ASSERT (sizeof (session_reset_msg_t) <= 16,
+              "disconnected must fit in session_event_t");
+
 typedef void (vcl_rpc_fn_t) (void *args);
 
 typedef struct vppcom_main_t_
@@ -504,18 +494,18 @@ vcl_session_is_connectable_listener (vcl_worker_t * wrk,
   if (session->session_type != VPPCOM_PROTO_QUIC)
     return 0;
   if (session->listener_index == VCL_INVALID_SESSION_INDEX)
-    return !(session->session_state STATE_LISTEN);
+    return !(session->session_state == VCL_STATE_LISTEN);
   ls = vcl_session_get_w_handle (wrk, session->listener_index);
   if (!ls)
     return VPPCOM_EBADFD;
-  return ls->session_state STATE_LISTEN;
+  return ls->session_state == VCL_STATE_LISTEN;
 }
 
 static inline vcl_session_t *
 vcl_session_table_lookup_listener (vcl_worker_t * wrk, u64 handle)
 {
   uword *p;
-  vcl_session_t *session;
+  vcl_session_t *s;
 
   p = hash_get (wrk->session_index_by_vpp_handles, handle);
   if (!p)
@@ -524,16 +514,17 @@ vcl_session_table_lookup_listener (vcl_worker_t * wrk, u64 handle)
            " %llx", handle);
       return 0;
     }
-  session = vcl_session_get (wrk, p[0]);
-  if (!session)
+  s = vcl_session_get (wrk, p[0]);
+  if (!s)
     {
       VDBG (1, "invalid listen session index (%u)", p[0]);
       return 0;
     }
 
-  ASSERT ((session->session_state & (STATE_LISTEN | STATE_LISTEN_NO_MQ)) ||
-         vcl_session_is_connectable_listener (wrk, session));
-  return session;
+  ASSERT (s->session_state == VCL_STATE_LISTEN
+         || s->session_state == VCL_STATE_LISTEN_NO_MQ
+         || vcl_session_is_connectable_listener (wrk, s));
+  return s;
 }
 
 const char *vppcom_session_state_str (vcl_session_state_t state);
@@ -552,38 +543,44 @@ vcl_session_is_cl (vcl_session_t * s)
   return 0;
 }
 
+static inline u8
+vcl_session_is_ready (vcl_session_t * s)
+{
+  return (s->session_state == VCL_STATE_READY
+         || s->session_state == VCL_STATE_VPP_CLOSING);
+}
+
 static inline u8
 vcl_session_is_open (vcl_session_t * s)
 {
-  return ((s->session_state & STATE_OPEN)
-         || (s->session_state == STATE_LISTEN
-             && s->session_type == VPPCOM_PROTO_UDP));
+  return ((vcl_session_is_ready (s))
+         || (s->session_state == VCL_STATE_LISTEN && vcl_session_is_cl (s)));
 }
 
 static inline u8
 vcl_session_is_closing (vcl_session_t * s)
 {
-  return (s->session_state == STATE_VPP_CLOSING
-         || s->session_state == STATE_DISCONNECT);
+  return (s->session_state == VCL_STATE_VPP_CLOSING
+         || s->session_state == VCL_STATE_DISCONNECT);
 }
 
 static inline u8
 vcl_session_is_closed (vcl_session_t * s)
 {
-  return (!s || (s->session_state == STATE_CLOSED));
+  return (!s || (s->session_state == VCL_STATE_CLOSED));
 }
 
 static inline int
 vcl_session_closing_error (vcl_session_t * s)
 {
   /* Return 0 on closing sockets */
-  return s->session_state == STATE_DISCONNECT ? VPPCOM_ECONNRESET : 0;
+  return s->session_state == VCL_STATE_DISCONNECT ? VPPCOM_ECONNRESET : 0;
 }
 
 static inline int
 vcl_session_closed_error (vcl_session_t * s)
 {
-  return s->session_state == STATE_DISCONNECT
+  return s->session_state == VCL_STATE_DISCONNECT
     ? VPPCOM_ECONNRESET : VPPCOM_ENOTCONN;
 }
 
@@ -612,6 +609,24 @@ vcl_proto_is_dgram (uint8_t proto)
   return proto == VPPCOM_PROTO_UDP;
 }
 
+static inline u8
+vcl_session_has_attr (vcl_session_t * s, u8 attr)
+{
+  return (s->attributes & (1 << attr)) ? 1 : 0;
+}
+
+static inline void
+vcl_session_set_attr (vcl_session_t * s, u8 attr)
+{
+  s->attributes |= 1 << attr;
+}
+
+static inline void
+vcl_session_clear_attr (vcl_session_t * s, u8 attr)
+{
+  s->attributes &= ~(1 << attr);
+}
+
 /*
  * Helpers
  */