src/vnet/session/session_types.h

   1 /*
   2  * Copyright (c) 2017-2019 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_SESSION_TYPES_H_
  17 #define SRC_VNET_SESSION_SESSION_TYPES_H_
  18
  19 #include <svm/svm_fifo.h>
  20 #include <vnet/session/transport_types.h>
  21
  22 #define SESSION_LISTENER_PREFIX         0x5FFFFFFF
  23
  24 #define foreach_session_endpoint_fields                         \
  25   foreach_transport_endpoint_cfg_fields                         \
  26   _(u8, transport_proto)                                        \
  27
  28 typedef struct _session_endpoint
  29 {
  30 #define _(type, name) type name;
  31   foreach_session_endpoint_fields
  32 #undef _
  33 } session_endpoint_t;
  34
  35 typedef struct _session_endpoint_cfg
  36 {
  37 #define _(type, name) type name;
  38   foreach_session_endpoint_fields
  39 #undef _
  40   u32 app_wrk_index;
  41   u32 opaque;
  42   u32 ns_index;
  43   u8 original_tp;
  44   u8 *hostname;
  45   u64 transport_opts;
  46 } session_endpoint_cfg_t;
  47
  48 #define SESSION_IP46_ZERO                       \
  49 {                                               \
  50     .ip6 = {                                    \
  51         { 0, 0, },                              \
  52     },                                          \
  53 }
  54
  55 #define TRANSPORT_ENDPOINT_NULL                 \
  56 {                                               \
  57   .sw_if_index = ENDPOINT_INVALID_INDEX,        \
  58   .ip = SESSION_IP46_ZERO,                      \
  59   .fib_index = ENDPOINT_INVALID_INDEX,          \
  60   .is_ip4 = 0,                                  \
  61   .port = 0,                                    \
  62 }
  63 #define SESSION_ENDPOINT_NULL                   \
  64 {                                               \
  65   .sw_if_index = ENDPOINT_INVALID_INDEX,        \
  66   .ip = SESSION_IP46_ZERO,                      \
  67   .fib_index = ENDPOINT_INVALID_INDEX,          \
  68   .is_ip4 = 0,                                  \
  69   .port = 0,                                    \
  70   .peer = TRANSPORT_ENDPOINT_NULL,              \
  71   .transport_proto = 0,                         \
  72 }
  73 #define SESSION_ENDPOINT_CFG_NULL               \
  74 {                                               \
  75   .sw_if_index = ENDPOINT_INVALID_INDEX,        \
  76   .ip = SESSION_IP46_ZERO,                      \
  77   .fib_index = ENDPOINT_INVALID_INDEX,          \
  78   .is_ip4 = 0,                                  \
  79   .port = 0,                                    \
  80   .peer = TRANSPORT_ENDPOINT_NULL,              \
  81   .transport_proto = 0,                         \
  82   .app_wrk_index = ENDPOINT_INVALID_INDEX,      \
  83   .opaque = ENDPOINT_INVALID_INDEX,             \
  84   .hostname = 0,                                \
  85 }
  86
  87 #define session_endpoint_to_transport(_sep) ((transport_endpoint_t *)_sep)
  88 #define session_endpoint_to_transport_cfg(_sep)         \
  89   ((transport_endpoint_cfg_t *)_sep)
  90
  91 always_inline u8
  92 session_endpoint_fib_proto (session_endpoint_t * sep)
  93 {
  94   return sep->is_ip4 ? FIB_PROTOCOL_IP4 : FIB_PROTOCOL_IP6;
  95 }
  96
  97 static inline u8
  98 session_endpoint_is_local (session_endpoint_t * sep)
  99 {
 100   return (ip_is_zero (&sep->ip, sep->is_ip4)
 101           || ip_is_local_host (&sep->ip, sep->is_ip4));
 102 }
 103
 104 static inline u8
 105 session_endpoint_is_zero (session_endpoint_t * sep)
 106 {
 107   return ip_is_zero (&sep->ip, sep->is_ip4);
 108 }
 109
 110 typedef u8 session_type_t;
 111 typedef u64 session_handle_t;
 112
 113 /*
 114  * Session states
 115  */
 116 typedef enum
 117 {
 118   SESSION_STATE_CREATED,
 119   SESSION_STATE_LISTENING,
 120   SESSION_STATE_CONNECTING,
 121   SESSION_STATE_ACCEPTING,
 122   SESSION_STATE_READY,
 123   SESSION_STATE_OPENED,
 124   SESSION_STATE_TRANSPORT_CLOSING,
 125   SESSION_STATE_CLOSING,
 126   SESSION_STATE_CLOSED_WAITING,
 127   SESSION_STATE_TRANSPORT_CLOSED,
 128   SESSION_STATE_CLOSED,
 129   SESSION_STATE_N_STATES,
 130 } session_state_t;
 131
 132 typedef enum session_flags_
 133 {
 134   SESSION_F_RX_EVT = 1,
 135   SESSION_F_PROXY = (1 << 1),
 136 } session_flags_t;
 137
 138 typedef struct session_
 139 {
 140   /** Pointers to rx/tx buffers. Once allocated, these do not move */
 141   svm_fifo_t *rx_fifo;
 142   svm_fifo_t *tx_fifo;
 143
 144   /** Type built from transport and network protocol types */
 145   session_type_t session_type;
 146
 147   /** State in session layer state machine. See @ref session_state_t */
 148   volatile u8 session_state;
 149
 150   /** Index in thread pool where session was allocated */
 151   u32 session_index;
 152
 153   /** Index of the app worker that owns the session */
 154   u32 app_wrk_index;
 155
 156   /** Index of the thread that allocated the session */
 157   u8 thread_index;
 158
 159   /** Session flags. See @ref session_flags_t */
 160   u32 flags;
 161
 162   /** Index of the transport connection associated to the session */
 163   u32 connection_index;
 164
 165   /** Index of application that owns the listener. Set only if a listener */
 166   u32 app_index;
 167
 168   union
 169   {
 170     /** Parent listener session index if the result of an accept */
 171     u32 listener_index;
 172
 173     /** App listener index in app's listener pool if a listener */
 174     u32 al_index;
 175   };
 176
 177   /** Opaque, for general use */
 178   u32 opaque;
 179
 180     CLIB_CACHE_LINE_ALIGN_MARK (pad);
 181 } session_t;
 182
 183 always_inline session_type_t
 184 session_type_from_proto_and_ip (transport_proto_t proto, u8 is_ip4)
 185 {
 186   return (proto << 1 | is_ip4);
 187 }
 188
 189 always_inline transport_proto_t
 190 session_type_transport_proto (session_type_t st)
 191 {
 192   return (st >> 1);
 193 }
 194
 195 always_inline u8
 196 session_type_is_ip4 (session_type_t st)
 197 {
 198   return (st & 1);
 199 }
 200
 201 always_inline transport_proto_t
 202 session_get_transport_proto (session_t * s)
 203 {
 204   return (s->session_type >> 1);
 205 }
 206
 207 always_inline fib_protocol_t
 208 session_get_fib_proto (session_t * s)
 209 {
 210   u8 is_ip4 = s->session_type & 1;
 211   return (is_ip4 ? FIB_PROTOCOL_IP4 : FIB_PROTOCOL_IP6);
 212 }
 213
 214 always_inline u8
 215 session_has_transport (session_t * s)
 216 {
 217   return (session_get_transport_proto (s) != TRANSPORT_PROTO_NONE);
 218 }
 219
 220 static inline transport_service_type_t
 221 session_transport_service_type (session_t * s)
 222 {
 223   transport_proto_t tp;
 224   tp = session_get_transport_proto (s);
 225   return transport_protocol_service_type (tp);
 226 }
 227
 228 static inline transport_tx_fn_type_t
 229 session_transport_tx_fn_type (session_t * s)
 230 {
 231   transport_proto_t tp;
 232   tp = session_get_transport_proto (s);
 233   return transport_protocol_tx_fn_type (tp);
 234 }
 235
 236 static inline u8
 237 session_tx_is_dgram (session_t * s)
 238 {
 239   return (session_transport_tx_fn_type (s) == TRANSPORT_TX_DGRAM);
 240 }
 241
 242 always_inline session_handle_t
 243 session_handle (session_t * s)
 244 {
 245   return ((u64) s->thread_index << 32) | (u64) s->session_index;
 246 }
 247
 248 always_inline u32
 249 session_index_from_handle (session_handle_t handle)
 250 {
 251   return handle & 0xFFFFFFFF;
 252 }
 253
 254 always_inline u32
 255 session_thread_from_handle (session_handle_t handle)
 256 {
 257   return handle >> 32;
 258 }
 259
 260 always_inline void
 261 session_parse_handle (session_handle_t handle, u32 * index,
 262                       u32 * thread_index)
 263 {
 264   *index = session_index_from_handle (handle);
 265   *thread_index = session_thread_from_handle (handle);
 266 }
 267
 268 typedef enum
 269 {
 270   SESSION_IO_EVT_RX,
 271   SESSION_IO_EVT_TX,
 272   SESSION_IO_EVT_TX_FLUSH,
 273   SESSION_IO_EVT_BUILTIN_RX,
 274   SESSION_IO_EVT_BUILTIN_TX,
 275   SESSION_CTRL_EVT_RPC,
 276   SESSION_CTRL_EVT_CLOSE,
 277   SESSION_CTRL_EVT_BOUND,
 278   SESSION_CTRL_EVT_UNLISTEN_REPLY,
 279   SESSION_CTRL_EVT_ACCEPTED,
 280   SESSION_CTRL_EVT_ACCEPTED_REPLY,
 281   SESSION_CTRL_EVT_CONNECTED,
 282   SESSION_CTRL_EVT_CONNECTED_REPLY,
 283   SESSION_CTRL_EVT_DISCONNECTED,
 284   SESSION_CTRL_EVT_DISCONNECTED_REPLY,
 285   SESSION_CTRL_EVT_RESET,
 286   SESSION_CTRL_EVT_RESET_REPLY,
 287   SESSION_CTRL_EVT_REQ_WORKER_UPDATE,
 288   SESSION_CTRL_EVT_WORKER_UPDATE,
 289   SESSION_CTRL_EVT_WORKER_UPDATE_REPLY,
 290 } session_evt_type_t;
 291
 292 /* Deprecated and will be removed. Use types above */
 293 #define FIFO_EVENT_APP_RX SESSION_IO_EVT_RX
 294 #define FIFO_EVENT_APP_TX SESSION_IO_EVT_TX
 295 #define FIFO_EVENT_DISCONNECT SESSION_CTRL_EVT_CLOSE
 296 #define FIFO_EVENT_BUILTIN_RX SESSION_IO_EVT_BUILTIN_RX
 297 #define FIFO_EVENT_BUILTIN_TX SESSION_IO_EVT_BUILTIN_TX
 298
 299 typedef enum
 300 {
 301   SESSION_MQ_IO_EVT_RING,
 302   SESSION_MQ_CTRL_EVT_RING,
 303   SESSION_MQ_N_RINGS
 304 } session_mq_rings_e;
 305
 306 typedef struct
 307 {
 308   void *fp;
 309   void *arg;
 310 } session_rpc_args_t;
 311
 312 typedef struct
 313 {
 314   u8 event_type;
 315   u8 postponed;
 316   union
 317   {
 318     u32 session_index;
 319     session_handle_t session_handle;
 320     session_rpc_args_t rpc_args;
 321     struct
 322     {
 323       u8 data[0];
 324     };
 325   };
 326 } __clib_packed session_event_t;
 327
 328 #define SESSION_MSG_NULL { }
 329
 330 typedef struct session_dgram_pre_hdr_
 331 {
 332   u32 data_length;
 333   u32 data_offset;
 334 } session_dgram_pre_hdr_t;
 335
 336 typedef struct session_dgram_header_
 337 {
 338   u32 data_length;
 339   u32 data_offset;
 340   ip46_address_t rmt_ip;
 341   ip46_address_t lcl_ip;
 342   u16 rmt_port;
 343   u16 lcl_port;
 344   u8 is_ip4;
 345 } __clib_packed session_dgram_hdr_t;
 346
 347 #define SESSION_CONN_ID_LEN 37
 348 #define SESSION_CONN_HDR_LEN 45
 349
 350 STATIC_ASSERT (sizeof (session_dgram_hdr_t) == (SESSION_CONN_ID_LEN + 8),
 351                "session conn id wrong length");
 352 #endif /* SRC_VNET_SESSION_SESSION_TYPES_H_ */
 353
 354 /*
 355  * fd.io coding-style-patch-verification: ON
 356  *
 357  * Local Variables:
 358  * eval: (c-set-style "gnu")
 359  * End:
 360  */