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_CLOSING,
  35   SESSION_STATE_CLOSED,
  36   SESSION_STATE_N_STATES,
  37 } stream_session_state_t;
  38
  39 typedef struct generic_session_
  40 {
  41   svm_fifo_t *rx_fifo;          /**< rx fifo */
  42   svm_fifo_t *tx_fifo;          /**< tx fifo */
  43   session_type_t session_type;  /**< session type */
  44   volatile u8 session_state;    /**< session state */
  45   u32 session_index;            /**< index in owning pool */
  46 } generic_session_t;
  47
  48 typedef struct _stream_session_t
  49 {
  50   /** fifo pointers. Once allocated, these do not move */
  51   svm_fifo_t *server_rx_fifo;
  52   svm_fifo_t *server_tx_fifo;
  53
  54   /** Type */
  55   session_type_t session_type;
  56
  57   /** State */
  58   volatile u8 session_state;
  59
  60   /** Session index in per_thread pool */
  61   u32 session_index;
  62
  63   /** App worker pool index */
  64   u32 app_wrk_index;
  65
  66   u8 thread_index;
  67
  68   /** To avoid n**2 "one event per frame" check */
  69   u8 enqueue_epoch;
  70
  71   /** svm segment index where fifos were allocated */
  72   u32 svm_segment_index;
  73
  74   /** Transport specific */
  75   u32 connection_index;
  76
  77   union
  78   {
  79     /** Parent listener session if the result of an accept */
  80     u32 listener_index;
  81
  82     /** Application index if a listener */
  83     u32 app_index;
  84   };
  85
  86   union
  87   {
  88     /** Transport app index for apps acting as transports */
  89     u32 t_app_index;
  90
  91     /** Index in listener app's listener db */
  92     u32 listener_db_index;
  93
  94     /** Opaque, for general use */
  95     u32 opaque;
  96   };
  97
  98     CLIB_CACHE_LINE_ALIGN_MARK (pad);
  99 } stream_session_t;
 100
 101 typedef struct local_session_
 102 {
 103   /** fifo pointers. Once allocated, these do not move */
 104   svm_fifo_t *server_rx_fifo;
 105   svm_fifo_t *server_tx_fifo;
 106
 107   /** Type */
 108   session_type_t session_type;
 109
 110   /** State */
 111   volatile u8 session_state;
 112
 113   /** Session index */
 114   u32 session_index;
 115
 116   /** Server index */
 117   u32 app_wrk_index;
 118
 119   /** Port for connection. Overlaps thread_index/enqueue_epoch */
 120   u16 port;
 121
 122   /** Segment index where fifos were allocated */
 123   u32 svm_segment_index;
 124
 125   /** Transport listener index. Overlaps connection index */
 126   u32 transport_listener_index;
 127
 128   union
 129   {
 130     u32 listener_index;
 131     u32 app_index;
 132   };
 133
 134   u32 listener_db_index;
 135
 136   /** Has transport embedded when listener not purely local */
 137   session_type_t listener_session_type;
 138
 139   /**
 140    * Client data
 141    */
 142   u32 client_wrk_index;
 143   u32 client_opaque;
 144
 145   u64 server_evt_q;
 146   u64 client_evt_q;
 147
 148     CLIB_CACHE_LINE_ALIGN_MARK (pad);
 149 } local_session_t;
 150
 151 #define foreach_session_endpoint_fields                         \
 152     foreach_transport_connection_fields                         \
 153     _(u8, transport_proto)                                      \
 154
 155 typedef struct _session_endpoint
 156 {
 157 #define _(type, name) type name;
 158   foreach_session_endpoint_fields
 159 #undef _
 160 } session_endpoint_t;
 161
 162 typedef struct _session_endpoint_extended
 163 {
 164 #define _(type, name) type name;
 165   foreach_session_endpoint_fields
 166 #undef _
 167   u32 app_wrk_index;
 168   u32 opaque;
 169   u8 *hostname;
 170 } session_endpoint_extended_t;
 171
 172 #define SESSION_IP46_ZERO                       \
 173 {                                               \
 174     .ip6 = {                                    \
 175         { 0, 0, },                              \
 176     },                                          \
 177 }
 178 #define SESSION_ENDPOINT_NULL                   \
 179 {                                               \
 180   .sw_if_index = ENDPOINT_INVALID_INDEX,        \
 181   .ip = SESSION_IP46_ZERO,                      \
 182   .fib_index = ENDPOINT_INVALID_INDEX,          \
 183   .is_ip4 = 0,                                  \
 184   .port = 0,                                    \
 185   .transport_proto = 0,                         \
 186 }
 187 #define SESSION_ENDPOINT_EXT_NULL               \
 188 {                                               \
 189   .sw_if_index = ENDPOINT_INVALID_INDEX,        \
 190   .ip = SESSION_IP46_ZERO,                      \
 191   .fib_index = ENDPOINT_INVALID_INDEX,          \
 192   .is_ip4 = 0,                                  \
 193   .port = 0,                                    \
 194   .transport_proto = 0,                         \
 195   .app_wrk_index = ENDPOINT_INVALID_INDEX,      \
 196   .opaque = ENDPOINT_INVALID_INDEX,             \
 197   .hostname = 0,                                \
 198 }
 199
 200 #define session_endpoint_to_transport(_sep) ((transport_endpoint_t *)_sep)
 201
 202 always_inline u8
 203 session_endpoint_fib_proto (session_endpoint_t * sep)
 204 {
 205   return sep->is_ip4 ? FIB_PROTOCOL_IP4 : FIB_PROTOCOL_IP6;
 206 }
 207
 208 #endif /* SRC_VNET_SESSION_STREAM_SESSION_H_ */
 209
 210 /*
 211  * fd.io coding-style-patch-verification: ON
 212  *
 213  * Local Variables:
 214  * eval: (c-set-style "gnu")
 215  * End:
 216  */