src/vnet/session/stream_session.h

   1 /*
   2  * Copyright (c) 2017 Cisco and/or its affiliates.
   3  * Licensed under the Apache License, Version 2.0 (the "License");
   4  * you may not use this file except in compliance with the License.
   5  * You may obtain a copy of the License at:
   6  *
   7  *     http://www.apache.org/licenses/LICENSE-2.0
   8  *
   9  * Unless required by applicable law or agreed to in writing, software
  10  * distributed under the License is distributed on an "AS IS" BASIS,
  11  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12  * See the License for the specific language governing permissions and
  13  * limitations under the License.
  14  */
  15
  16 #ifndef SRC_VNET_SESSION_STREAM_SESSION_H_
  17 #define SRC_VNET_SESSION_STREAM_SESSION_H_
  18
  19 #include <vnet/vnet.h>
  20 #include <svm/svm_fifo.h>
  21 #include <vnet/session/transport.h>
  22
  23 typedef u8 session_type_t;
  24
  25 /*
  26  * Application session state
  27  */
  28 typedef enum
  29 {
  30   SESSION_STATE_LISTENING,
  31   SESSION_STATE_CONNECTING,
  32   SESSION_STATE_ACCEPTING,
  33   SESSION_STATE_READY,
  34   SESSION_STATE_OPENED,
  35   SESSION_STATE_CLOSING,
  36   SESSION_STATE_CLOSED,
  37   SESSION_STATE_N_STATES,
  38 } stream_session_state_t;
  39
  40 typedef struct generic_session_
  41 {
  42   svm_fifo_t *rx_fifo;          /**< rx fifo */
  43   svm_fifo_t *tx_fifo;          /**< tx fifo */
  44   session_type_t session_type;  /**< session type */
  45   volatile u8 session_state;    /**< session state */
  46   u32 session_index;            /**< index in owning pool */
  47 } generic_session_t;
  48
  49 typedef struct _stream_session_t
  50 {
  51   /** fifo pointers. Once allocated, these do not move */
  52   svm_fifo_t *server_rx_fifo;
  53   svm_fifo_t *server_tx_fifo;
  54
  55   /** Type */
  56   session_type_t session_type;
  57
  58   /** State */
  59   volatile u8 session_state;
  60
  61   /** Session index in per_thread pool */
  62   u32 session_index;
  63
  64   /** stream server pool index */
  65   u32 app_index;
  66
  67   u8 thread_index;
  68
  69   /** To avoid n**2 "one event per frame" check */
  70   u8 enqueue_epoch;
  71
  72   /** svm segment index where fifos were allocated */
  73   u32 svm_segment_index;
  74
  75   /** Transport specific */
  76   u32 connection_index;
  77
  78   union
  79   {
  80     /** Parent listener session if the result of an accept */
  81     u32 listener_index;
  82     /** Opaque, for general use */
  83     u32 opaque;
  84   };
  85
  86     CLIB_CACHE_LINE_ALIGN_MARK (pad);
  87 } stream_session_t;
  88
  89 typedef struct local_session_
  90 {
  91   /** fifo pointers. Once allocated, these do not move */
  92   svm_fifo_t *server_rx_fifo;
  93   svm_fifo_t *server_tx_fifo;
  94
  95   /** Type */
  96   session_type_t session_type;
  97
  98   /** State */
  99   volatile u8 session_state;
 100
 101   /** Session index */
 102   u32 session_index;
 103
 104   /** Server index */
 105   u32 app_index;
 106
 107   /** Segment index where fifos were allocated */
 108   u32 svm_segment_index;
 109
 110   u32 listener_index;
 111
 112   /** Port for connection */
 113   u16 port;
 114
 115   /** Has transport embedded when listener not purely local */
 116   session_type_t listener_session_type;
 117   u32 transport_listener_index;
 118
 119   /**
 120    * Client data
 121    */
 122   u32 client_index;
 123   u32 client_opaque;
 124
 125   u64 server_evt_q;
 126   u64 client_evt_q;
 127
 128     CLIB_CACHE_LINE_ALIGN_MARK (pad);
 129 } local_session_t;
 130
 131 #define foreach_session_endpoint_fields                         \
 132     foreach_transport_connection_fields                         \
 133     _(u8, transport_proto)                                      \
 134
 135 typedef struct _session_endpoint
 136 {
 137 #define _(type, name) type name;
 138   foreach_session_endpoint_fields
 139 #undef _
 140 } session_endpoint_t;
 141
 142 typedef struct _session_endpoint_extended
 143 {
 144 #define _(type, name) type name;
 145   foreach_session_endpoint_fields
 146 #undef _
 147   u32 app_index;
 148   u32 opaque;
 149   u8 *hostname;
 150 } session_endpoint_extended_t;
 151
 152 #define SESSION_IP46_ZERO               \
 153 {                                       \
 154     .ip6 = {                            \
 155         { 0, 0, },                      \
 156     },                                  \
 157 }
 158 #define SESSION_ENDPOINT_NULL           \
 159 {                                       \
 160   .sw_if_index = ENDPOINT_INVALID_INDEX,        \
 161   .ip = SESSION_IP46_ZERO,              \
 162   .fib_index = ENDPOINT_INVALID_INDEX,  \
 163   .is_ip4 = 0,                          \
 164   .port = 0,                            \
 165   .transport_proto = 0,                 \
 166 }
 167 #define SESSION_ENDPOINT_EXT_NULL       \
 168 {                                       \
 169   .sw_if_index = ENDPOINT_INVALID_INDEX,        \
 170   .ip = SESSION_IP46_ZERO,              \
 171   .fib_index = ENDPOINT_INVALID_INDEX,  \
 172   .is_ip4 = 0,                          \
 173   .port = 0,                            \
 174   .transport_proto = 0,                 \
 175   .app_index = ENDPOINT_INVALID_INDEX,  \
 176   .opaque = ENDPOINT_INVALID_INDEX,     \
 177   .hostname = 0,                                \
 178 }
 179
 180 #define session_endpoint_to_transport(_sep) ((transport_endpoint_t *)_sep)
 181
 182 always_inline u8
 183 session_endpoint_fib_proto (session_endpoint_t * sep)
 184 {
 185   return sep->is_ip4 ? FIB_PROTOCOL_IP4 : FIB_PROTOCOL_IP6;
 186 }
 187
 188 #endif /* SRC_VNET_SESSION_STREAM_SESSION_H_ */
 189
 190 /*
 191  * fd.io coding-style-patch-verification: ON
 192  *
 193  * Local Variables:
 194  * eval: (c-set-style "gnu")
 195  * End:
 196  */