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