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 <svm/svm_fifo.h>
  20 #include <vnet/session/transport.h>
  21
  22 typedef u8 session_type_t;
  23
  24 /*
  25  * Application session state
  26  */
  27 typedef enum
  28 {
  29   SESSION_STATE_LISTENING,
  30   SESSION_STATE_CONNECTING,
  31   SESSION_STATE_ACCEPTING,
  32   SESSION_STATE_READY,
  33   SESSION_STATE_OPENED,
  34   SESSION_STATE_TRANSPORT_CLOSING,
  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   /** App worker pool index */
  65   u32 app_wrk_index;
  66
  67   u8 thread_index;
  68
  69   /** To avoid n**2 "one event per frame" check */
  70   u64 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
  83     /** Application index if a listener */
  84     u32 app_index;
  85   };
  86
  87   union
  88   {
  89     /** Transport app index for apps acting as transports */
  90     u32 t_app_index;
  91
  92     /** Index in listener app's listener db */
  93     u32 listener_db_index;
  94
  95     /** Opaque, for general use */
  96     u32 opaque;
  97   };
  98
  99     CLIB_CACHE_LINE_ALIGN_MARK (pad);
 100 } stream_session_t;
 101
 102 typedef struct local_session_
 103 {
 104   /** fifo pointers. Once allocated, these do not move */
 105   svm_fifo_t *server_rx_fifo;
 106   svm_fifo_t *server_tx_fifo;
 107
 108   /** Type */
 109   session_type_t session_type;
 110
 111   /** State */
 112   volatile u8 session_state;
 113
 114   /** Session index */
 115   u32 session_index;
 116
 117   /** Server index */
 118   u32 app_wrk_index;
 119
 120   /** Port for connection. Overlaps thread_index/enqueue_epoch */
 121   u16 port;
 122
 123   /** Partly overlaps enqueue_epoch */
 124   u8 pad_epoch[7];
 125
 126   /** Segment index where fifos were allocated */
 127   u32 svm_segment_index;
 128
 129   /** Transport listener index. Overlaps connection index */
 130   u32 transport_listener_index;
 131
 132   union
 133   {
 134     u32 listener_index;
 135     u32 app_index;
 136   };
 137
 138   u32 listener_db_index;
 139
 140   /** Has transport embedded when listener not purely local */
 141   session_type_t listener_session_type;
 142
 143   /**
 144    * Client data
 145    */
 146   u32 client_wrk_index;
 147   u32 client_opaque;
 148
 149   u64 server_evt_q;
 150   u64 client_evt_q;
 151
 152     CLIB_CACHE_LINE_ALIGN_MARK (pad);
 153 } local_session_t;
 154
 155 #define foreach_session_endpoint_fields                         \
 156   foreach_transport_endpoint_cfg_fields                         \
 157   _(u8, transport_proto)                                        \
 158
 159 typedef struct _session_endpoint
 160 {
 161 #define _(type, name) type name;
 162   foreach_session_endpoint_fields
 163 #undef _
 164 } session_endpoint_t;
 165
 166 typedef struct _session_endpoint_cfg
 167 {
 168 #define _(type, name) type name;
 169   foreach_session_endpoint_fields
 170 #undef _
 171   u32 app_wrk_index;
 172   u32 opaque;
 173   u8 *hostname;
 174 } session_endpoint_cfg_t;
 175
 176 #define SESSION_IP46_ZERO                       \
 177 {                                               \
 178     .ip6 = {                                    \
 179         { 0, 0, },                              \
 180     },                                          \
 181 }
 182
 183 #define TRANSPORT_ENDPOINT_NULL                 \
 184 {                                               \
 185   .sw_if_index = ENDPOINT_INVALID_INDEX,        \
 186   .ip = SESSION_IP46_ZERO,                      \
 187   .fib_index = ENDPOINT_INVALID_INDEX,          \
 188   .is_ip4 = 0,                                  \
 189   .port = 0,                                    \
 190 }
 191 #define SESSION_ENDPOINT_NULL                   \
 192 {                                               \
 193   .sw_if_index = ENDPOINT_INVALID_INDEX,        \
 194   .ip = SESSION_IP46_ZERO,                      \
 195   .fib_index = ENDPOINT_INVALID_INDEX,          \
 196   .is_ip4 = 0,                                  \
 197   .port = 0,                                    \
 198   .peer = TRANSPORT_ENDPOINT_NULL,              \
 199   .transport_proto = 0,                         \
 200 }
 201 #define SESSION_ENDPOINT_CFG_NULL               \
 202 {                                               \
 203   .sw_if_index = ENDPOINT_INVALID_INDEX,        \
 204   .ip = SESSION_IP46_ZERO,                      \
 205   .fib_index = ENDPOINT_INVALID_INDEX,          \
 206   .is_ip4 = 0,                                  \
 207   .port = 0,                                    \
 208   .peer = TRANSPORT_ENDPOINT_NULL,              \
 209   .transport_proto = 0,                         \
 210   .app_wrk_index = ENDPOINT_INVALID_INDEX,      \
 211   .opaque = ENDPOINT_INVALID_INDEX,             \
 212   .hostname = 0,                                \
 213 }
 214
 215 #define session_endpoint_to_transport(_sep) ((transport_endpoint_t *)_sep)
 216 #define session_endpoint_to_transport_cfg(_sep)         \
 217   ((transport_endpoint_cfg_t *)_sep)
 218
 219 always_inline u8
 220 session_endpoint_fib_proto (session_endpoint_t * sep)
 221 {
 222   return sep->is_ip4 ? FIB_PROTOCOL_IP4 : FIB_PROTOCOL_IP6;
 223 }
 224
 225 #endif /* SRC_VNET_SESSION_STREAM_SESSION_H_ */
 226
 227 /*
 228  * fd.io coding-style-patch-verification: ON
 229  *
 230  * Local Variables:
 231  * eval: (c-set-style "gnu")
 232  * End:
 233  */