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