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