session tcp: handle rxt and acks as custom events
[vpp.git] / src / vnet / session / session_types.h
index 9e51d69..9a5bc76 100644 (file)
@@ -19,7 +19,8 @@
 #include <svm/svm_fifo.h>
 #include <vnet/session/transport_types.h>
 
-#define SESSION_LISTENER_PREFIX                0x5FFFFFFF
+#define SESSION_INVALID_INDEX ((u32)~0)
+#define SESSION_INVALID_HANDLE ((u64)~0)
 
 #define foreach_session_endpoint_fields                                \
   foreach_transport_endpoint_cfg_fields                                \
@@ -42,6 +43,7 @@ typedef struct _session_endpoint_cfg
   u32 ns_index;
   u8 original_tp;
   u8 *hostname;
+  u64 parent_handle;
 } session_endpoint_cfg_t;
 
 #define SESSION_IP46_ZERO                      \
@@ -81,6 +83,7 @@ typedef struct _session_endpoint_cfg
   .app_wrk_index = ENDPOINT_INVALID_INDEX,     \
   .opaque = ENDPOINT_INVALID_INDEX,            \
   .hostname = 0,                               \
+  .parent_handle = SESSION_INVALID_HANDLE      \
 }
 
 #define session_endpoint_to_transport(_sep) ((transport_endpoint_t *)_sep)
@@ -109,8 +112,14 @@ session_endpoint_is_zero (session_endpoint_t * sep)
 typedef u8 session_type_t;
 typedef u64 session_handle_t;
 
+typedef enum
+{
+  SESSION_CLEANUP_TRANSPORT,
+  SESSION_CLEANUP_SESSION,
+} session_cleanup_ntf_t;
+
 /*
- * Application session state
+ * Session states
  */
 typedef enum
 {
@@ -122,71 +131,62 @@ typedef enum
   SESSION_STATE_OPENED,
   SESSION_STATE_TRANSPORT_CLOSING,
   SESSION_STATE_CLOSING,
-  SESSION_STATE_CLOSED_WAITING,
+  SESSION_STATE_APP_CLOSED,
   SESSION_STATE_TRANSPORT_CLOSED,
+  SESSION_STATE_TRANSPORT_DELETED,
   SESSION_STATE_CLOSED,
   SESSION_STATE_N_STATES,
 } session_state_t;
 
-typedef struct generic_session_
+typedef enum session_flags_
 {
-  svm_fifo_t *rx_fifo;         /**< rx fifo */
-  svm_fifo_t *tx_fifo;         /**< tx fifo */
-  session_type_t session_type; /**< session type */
-  volatile u8 session_state;   /**< session state */
-  u32 session_index;           /**< index in owning pool */
-} generic_session_t;
+  SESSION_F_RX_EVT = 1,
+  SESSION_F_PROXY = (1 << 1),
+  SESSION_F_CUSTOM_TX = (1 << 2),
+} session_flags_t;
 
 typedef struct session_
 {
-  /** fifo pointers. Once allocated, these do not move */
+  /** Pointers to rx/tx buffers. Once allocated, these do not move */
   svm_fifo_t *rx_fifo;
   svm_fifo_t *tx_fifo;
 
-  /** Type */
+  /** Type built from transport and network protocol types */
   session_type_t session_type;
 
-  /** State */
+  /** State in session layer state machine. See @ref session_state_t */
   volatile u8 session_state;
 
-  /** Session index in per_thread pool */
+  /** Index in thread pool where session was allocated */
   u32 session_index;
 
-  /** App worker pool index */
+  /** Index of the app worker that owns the session */
   u32 app_wrk_index;
 
+  /** Index of the thread that allocated the session */
   u8 thread_index;
 
-  /** To avoid n**2 "one event per frame" check */
-  u64 enqueue_epoch;
+  /** Session flags. See @ref session_flags_t */
+  u32 flags;
 
-  /** svm segment index where fifos were allocated */
-  u32 svm_segment_index;
-
-  /** Transport specific */
+  /** Index of the transport connection associated to the session */
   u32 connection_index;
 
-  union
-  {
-    /** Parent listener session if the result of an accept */
-    u32 listener_index;
-
-    /** Application index if a listener */
-    u32 app_index;
-  };
+  /** Index of application that owns the listener. Set only if a listener */
+  u32 app_index;
 
   union
   {
-    /** Transport app index for apps acting as transports */
-    u32 t_app_index;
+    /** Parent listener session index if the result of an accept */
+    session_handle_t listener_handle;
 
-    /** App listener index */
+    /** App listener index in app's listener pool if a listener */
     u32 al_index;
-
-    /** Opaque, for general use */
-    u32 opaque;
   };
 
+  /** Opaque, for general use */
+  u32 opaque;
+
     CLIB_CACHE_LINE_ALIGN_MARK (pad);
 } session_t;
 
@@ -319,14 +319,13 @@ typedef struct
   void *arg;
 } session_rpc_args_t;
 
-/* *INDENT-OFF* */
 typedef struct
 {
   u8 event_type;
   u8 postponed;
   union
   {
-    svm_fifo_t *fifo;
+    u32 session_index;
     session_handle_t session_handle;
     session_rpc_args_t rpc_args;
     struct
@@ -335,7 +334,6 @@ typedef struct
     };
   };
 } __clib_packed session_event_t;
-/* *INDENT-ON* */
 
 #define SESSION_MSG_NULL { }
 
@@ -345,8 +343,7 @@ typedef struct session_dgram_pre_hdr_
   u32 data_offset;
 } session_dgram_pre_hdr_t;
 
-/* *INDENT-OFF* */
-typedef CLIB_PACKED (struct session_dgram_header_
+typedef struct session_dgram_header_
 {
   u32 data_length;
   u32 data_offset;
@@ -355,8 +352,7 @@ typedef CLIB_PACKED (struct session_dgram_header_
   u16 rmt_port;
   u16 lcl_port;
   u8 is_ip4;
-}) session_dgram_hdr_t;
-/* *INDENT-ON* */
+} __clib_packed session_dgram_hdr_t;
 
 #define SESSION_CONN_ID_LEN 37
 #define SESSION_CONN_HDR_LEN 45