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   /** Parent listener session if the result of an accept */
  89   u32 listener_index;
  90
  91     CLIB_CACHE_LINE_ALIGN_MARK (pad);
  92 } stream_session_t;
  93
  94 typedef struct local_session_
  95 {
  96   /** fifo pointers. Once allocated, these do not move */
  97   svm_fifo_t *server_rx_fifo;
  98   svm_fifo_t *server_tx_fifo;
  99
 100   /** Type */
 101   session_type_t session_type;
 102
 103   /** State */
 104   volatile u8 session_state;
 105
 106   /** Session index */
 107   u32 session_index;
 108
 109   /** Server index */
 110   u32 app_index;
 111
 112   /** Segment index where fifos were allocated */
 113   u32 svm_segment_index;
 114
 115   u32 listener_index;
 116
 117   /** Port for connection */
 118   u16 port;
 119
 120   /** Has transport embedded when listener not purely local */
 121   session_type_t listener_session_type;
 122
 123   /**
 124    * Client data
 125    */
 126   u32 client_index;
 127   u32 client_opaque;
 128
 129   u64 server_evt_q;
 130   u64 client_evt_q;
 131
 132     CLIB_CACHE_LINE_ALIGN_MARK (pad);
 133 } local_session_t;
 134
 135 typedef struct _session_endpoint
 136 {
 137   /*
 138    * Network specific
 139    */
 140 #define _(type, name) type name;
 141   foreach_transport_connection_fields
 142 #undef _
 143     /*
 144      * Session specific
 145      */
 146   u8 transport_proto;   /**< transport protocol for session */
 147 } session_endpoint_t;
 148
 149 #define SESSION_IP46_ZERO               \
 150 {                                       \
 151     .ip6 = {                            \
 152         { 0, 0, },                      \
 153     },                                  \
 154 }
 155 #define SESSION_ENDPOINT_NULL           \
 156 {                                       \
 157   .sw_if_index = ENDPOINT_INVALID_INDEX,        \
 158   .ip = SESSION_IP46_ZERO,              \
 159   .fib_index = ENDPOINT_INVALID_INDEX,  \
 160   .is_ip4 = 0,                          \
 161   .port = 0,                            \
 162   .transport_proto = 0,                 \
 163 }
 164
 165 #define session_endpoint_to_transport(_sep) ((transport_endpoint_t *)_sep)
 166
 167 always_inline u8
 168 session_endpoint_fib_proto (session_endpoint_t * sep)
 169 {
 170   return sep->is_ip4 ? FIB_PROTOCOL_IP4 : FIB_PROTOCOL_IP6;
 171 }
 172
 173 #endif /* SRC_VNET_SESSION_STREAM_SESSION_H_ */
 174
 175 /*
 176  * fd.io coding-style-patch-verification: ON
 177  *
 178  * Local Variables:
 179  * eval: (c-set-style "gnu")
 180  * End:
 181  */