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_F_CUSTOM_TX = (1 << 2),
 146 } session_flags_t;
 147
 148 typedef struct session_
 149 {
 150   /** Pointers to rx/tx buffers. Once allocated, these do not move */
 151   svm_fifo_t *rx_fifo;
 152   svm_fifo_t *tx_fifo;
 153
 154   /** Type built from transport and network protocol types */
 155   session_type_t session_type;
 156
 157   /** State in session layer state machine. See @ref session_state_t */
 158   volatile u8 session_state;
 159
 160   /** Index in thread pool where session was allocated */
 161   u32 session_index;
 162
 163   /** Index of the app worker that owns the session */
 164   u32 app_wrk_index;
 165
 166   /** Index of the thread that allocated the session */
 167   u8 thread_index;
 168
 169   /** Session flags. See @ref session_flags_t */
 170   u32 flags;
 171
 172   /** Index of the transport connection associated to the session */
 173   u32 connection_index;
 174
 175   /** Index of application that owns the listener. Set only if a listener */
 176   u32 app_index;
 177
 178   union
 179   {
 180     /** Parent listener session index if the result of an accept */
 181     session_handle_t listener_handle;
 182
 183     /** App listener index in app's listener pool if a listener */
 184     u32 al_index;
 185   };
 186
 187   /** Opaque, for general use */
 188   u32 opaque;
 189
 190     CLIB_CACHE_LINE_ALIGN_MARK (pad);
 191 } session_t;
 192
 193 always_inline session_type_t
 194 session_type_from_proto_and_ip (transport_proto_t proto, u8 is_ip4)
 195 {
 196   return (proto << 1 | is_ip4);
 197 }
 198
 199 always_inline transport_proto_t
 200 session_type_transport_proto (session_type_t st)
 201 {
 202   return (st >> 1);
 203 }
 204
 205 always_inline u8
 206 session_type_is_ip4 (session_type_t st)
 207 {
 208   return (st & 1);
 209 }
 210
 211 always_inline transport_proto_t
 212 session_get_transport_proto (session_t * s)
 213 {
 214   return (s->session_type >> 1);
 215 }
 216
 217 always_inline fib_protocol_t
 218 session_get_fib_proto (session_t * s)
 219 {
 220   u8 is_ip4 = s->session_type & 1;
 221   return (is_ip4 ? FIB_PROTOCOL_IP4 : FIB_PROTOCOL_IP6);
 222 }
 223
 224 always_inline u8
 225 session_has_transport (session_t * s)
 226 {
 227   return (session_get_transport_proto (s) != TRANSPORT_PROTO_NONE);
 228 }
 229
 230 static inline transport_service_type_t
 231 session_transport_service_type (session_t * s)
 232 {
 233   transport_proto_t tp;
 234   tp = session_get_transport_proto (s);
 235   return transport_protocol_service_type (tp);
 236 }
 237
 238 static inline transport_tx_fn_type_t
 239 session_transport_tx_fn_type (session_t * s)
 240 {
 241   transport_proto_t tp;
 242   tp = session_get_transport_proto (s);
 243   return transport_protocol_tx_fn_type (tp);
 244 }
 245
 246 static inline u8
 247 session_tx_is_dgram (session_t * s)
 248 {
 249   return (session_transport_tx_fn_type (s) == TRANSPORT_TX_DGRAM);
 250 }
 251
 252 always_inline session_handle_t
 253 session_handle (session_t * s)
 254 {
 255   return ((u64) s->thread_index << 32) | (u64) s->session_index;
 256 }
 257
 258 always_inline u32
 259 session_index_from_handle (session_handle_t handle)
 260 {
 261   return handle & 0xFFFFFFFF;
 262 }
 263
 264 always_inline u32
 265 session_thread_from_handle (session_handle_t handle)
 266 {
 267   return handle >> 32;
 268 }
 269
 270 always_inline void
 271 session_parse_handle (session_handle_t handle, u32 * index,
 272                       u32 * thread_index)
 273 {
 274   *index = session_index_from_handle (handle);
 275   *thread_index = session_thread_from_handle (handle);
 276 }
 277
 278 static inline session_handle_t
 279 session_make_handle (u32 session_index, u32 thread_index)
 280 {
 281   return (((u64) thread_index << 32) | (u64) session_index);
 282 }
 283
 284 typedef enum
 285 {
 286   SESSION_IO_EVT_RX,
 287   SESSION_IO_EVT_TX,
 288   SESSION_IO_EVT_TX_FLUSH,
 289   SESSION_IO_EVT_BUILTIN_RX,
 290   SESSION_IO_EVT_BUILTIN_TX,
 291   SESSION_CTRL_EVT_RPC,
 292   SESSION_CTRL_EVT_CLOSE,
 293   SESSION_CTRL_EVT_RESET,
 294   SESSION_CTRL_EVT_BOUND,
 295   SESSION_CTRL_EVT_UNLISTEN_REPLY,
 296   SESSION_CTRL_EVT_ACCEPTED,
 297   SESSION_CTRL_EVT_ACCEPTED_REPLY,
 298   SESSION_CTRL_EVT_CONNECTED,
 299   SESSION_CTRL_EVT_DISCONNECTED,
 300   SESSION_CTRL_EVT_DISCONNECTED_REPLY,
 301   SESSION_CTRL_EVT_RESET_REPLY,
 302   SESSION_CTRL_EVT_REQ_WORKER_UPDATE,
 303   SESSION_CTRL_EVT_WORKER_UPDATE,
 304   SESSION_CTRL_EVT_WORKER_UPDATE_REPLY,
 305   SESSION_CTRL_EVT_DISCONNECT,
 306   SESSION_CTRL_EVT_CONNECT,
 307   SESSION_CTRL_EVT_CONNECT_URI,
 308   SESSION_CTRL_EVT_LISTEN,
 309   SESSION_CTRL_EVT_LISTEN_URI,
 310   SESSION_CTRL_EVT_UNLISTEN,
 311   SESSION_CTRL_EVT_APP_DETACH,
 312 } session_evt_type_t;
 313
 314 #define foreach_session_ctrl_evt                                \
 315   _(LISTEN, listen)                                             \
 316   _(LISTEN_URI, listen_uri)                                     \
 317   _(BOUND, bound)                                               \
 318   _(UNLISTEN, unlisten)                                         \
 319   _(UNLISTEN_REPLY, unlisten_reply)                             \
 320   _(ACCEPTED, accepted)                                         \
 321   _(ACCEPTED_REPLY, accepted_reply)                             \
 322   _(CONNECT, connect)                                           \
 323   _(CONNECT_URI, connect_uri)                                   \
 324   _(CONNECTED, connected)                                       \
 325   _(DISCONNECT, disconnect)                                     \
 326   _(DISCONNECTED, disconnected)                                 \
 327   _(DISCONNECTED_REPLY, disconnected_reply)                     \
 328   _(RESET_REPLY, reset_reply)                                   \
 329   _(REQ_WORKER_UPDATE, req_worker_update)                       \
 330   _(WORKER_UPDATE, worker_update)                               \
 331   _(WORKER_UPDATE_REPLY, worker_update_reply)                   \
 332   _(APP_DETACH, app_detach)                                     \
 333
 334
 335 /* Deprecated and will be removed. Use types above */
 336 #define FIFO_EVENT_APP_RX SESSION_IO_EVT_RX
 337 #define FIFO_EVENT_APP_TX SESSION_IO_EVT_TX
 338 #define FIFO_EVENT_DISCONNECT SESSION_CTRL_EVT_CLOSE
 339 #define FIFO_EVENT_BUILTIN_RX SESSION_IO_EVT_BUILTIN_RX
 340 #define FIFO_EVENT_BUILTIN_TX SESSION_IO_EVT_BUILTIN_TX
 341
 342 typedef enum
 343 {
 344   SESSION_MQ_IO_EVT_RING,
 345   SESSION_MQ_CTRL_EVT_RING,
 346   SESSION_MQ_N_RINGS
 347 } session_mq_rings_e;
 348
 349 typedef struct
 350 {
 351   void *fp;
 352   void *arg;
 353 } session_rpc_args_t;
 354
 355 typedef struct
 356 {
 357   u8 event_type;
 358   u8 postponed;
 359   union
 360   {
 361     u32 session_index;
 362     session_handle_t session_handle;
 363     session_rpc_args_t rpc_args;
 364     u32 ctrl_data_index;
 365     struct
 366     {
 367       u8 data[0];
 368     };
 369   };
 370 } __clib_packed session_event_t;
 371
 372 #define SESSION_MSG_NULL { }
 373
 374 typedef struct session_dgram_pre_hdr_
 375 {
 376   u32 data_length;
 377   u32 data_offset;
 378 } session_dgram_pre_hdr_t;
 379
 380 typedef struct session_dgram_header_
 381 {
 382   u32 data_length;
 383   u32 data_offset;
 384   ip46_address_t rmt_ip;
 385   ip46_address_t lcl_ip;
 386   u16 rmt_port;
 387   u16 lcl_port;
 388   u8 is_ip4;
 389 } __clib_packed session_dgram_hdr_t;
 390
 391 #define SESSION_CONN_ID_LEN 37
 392 #define SESSION_CONN_HDR_LEN 45
 393
 394 STATIC_ASSERT (sizeof (session_dgram_hdr_t) == (SESSION_CONN_ID_LEN + 8),
 395                "session conn id wrong length");
 396 #endif /* SRC_VNET_SESSION_SESSION_TYPES_H_ */
 397
 398 /*
 399  * fd.io coding-style-patch-verification: ON
 400  *
 401  * Local Variables:
 402  * eval: (c-set-style "gnu")
 403  * End:
 404  */