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