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 #define SESSION_CTRL_MSG_MAX_SIZE 86
  25 #define SESSION_NODE_FRAME_SIZE 128
  26
  27 #define foreach_session_endpoint_fields                         \
  28   foreach_transport_endpoint_cfg_fields                         \
  29   _(u8, transport_proto)                                        \
  30
  31 typedef struct _session_endpoint
  32 {
  33 #define _(type, name) type name;
  34   foreach_session_endpoint_fields
  35 #undef _
  36 } session_endpoint_t;
  37
  38 typedef struct _session_endpoint_cfg
  39 {
  40 #define _(type, name) type name;
  41   foreach_session_endpoint_fields
  42 #undef _
  43   u32 app_wrk_index;
  44   u32 opaque;
  45   u32 ns_index;
  46   u8 original_tp;
  47   u64 parent_handle;
  48   u8 flags;
  49   transport_endpt_ext_cfg_t *ext_cfg;
  50 } session_endpoint_cfg_t;
  51
  52 #define SESSION_IP46_ZERO                       \
  53 {                                               \
  54     .ip6 = {                                    \
  55         { 0, 0, },                              \
  56     },                                          \
  57 }
  58
  59 #define TRANSPORT_ENDPOINT_NULL                 \
  60 {                                               \
  61   .sw_if_index = ENDPOINT_INVALID_INDEX,        \
  62   .ip = SESSION_IP46_ZERO,                      \
  63   .fib_index = ENDPOINT_INVALID_INDEX,          \
  64   .is_ip4 = 0,                                  \
  65   .port = 0,                                    \
  66 }
  67 #define SESSION_ENDPOINT_NULL                   \
  68 {                                               \
  69   .sw_if_index = ENDPOINT_INVALID_INDEX,        \
  70   .ip = SESSION_IP46_ZERO,                      \
  71   .fib_index = ENDPOINT_INVALID_INDEX,          \
  72   .is_ip4 = 0,                                  \
  73   .port = 0,                                    \
  74   .peer = TRANSPORT_ENDPOINT_NULL,              \
  75   .transport_proto = 0,                         \
  76 }
  77 #define SESSION_ENDPOINT_CFG_NULL                                             \
  78   {                                                                           \
  79     .sw_if_index = ENDPOINT_INVALID_INDEX, .ip = SESSION_IP46_ZERO,           \
  80     .fib_index = ENDPOINT_INVALID_INDEX, .is_ip4 = 0, .port = 0,              \
  81     .peer = TRANSPORT_ENDPOINT_NULL, .transport_proto = 0,                    \
  82     .app_wrk_index = ENDPOINT_INVALID_INDEX,                                  \
  83     .opaque = ENDPOINT_INVALID_INDEX,                                         \
  84     .parent_handle = SESSION_INVALID_HANDLE, .ext_cfg = 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 typedef enum
 114 {
 115   SESSION_CLEANUP_TRANSPORT,
 116   SESSION_CLEANUP_SESSION,
 117 } session_cleanup_ntf_t;
 118
 119 typedef enum session_ft_action_
 120 {
 121   SESSION_FT_ACTION_ENQUEUED,
 122   SESSION_FT_ACTION_DEQUEUED,
 123   SESSION_FT_ACTION_N_ACTIONS
 124 } session_ft_action_t;
 125
 126 /*
 127  * Session states
 128  */
 129 #define foreach_session_state                           \
 130   _(CREATED, "created")                                 \
 131   _(LISTENING, "listening")                             \
 132   _(CONNECTING, "connecting")                           \
 133   _(ACCEPTING, "accepting")                             \
 134   _(READY, "ready")                                     \
 135   _(OPENED, "opened")                                   \
 136   _(TRANSPORT_CLOSING, "transport-closing")             \
 137   _(CLOSING, "closing")                                 \
 138   _(APP_CLOSED, "app-closed")                           \
 139   _(TRANSPORT_CLOSED, "transport-closed")               \
 140   _(CLOSED, "closed")                                   \
 141   _(TRANSPORT_DELETED, "transport-deleted")             \
 142
 143 typedef enum
 144 {
 145 #define _(sym, str) SESSION_STATE_ ## sym,
 146   foreach_session_state
 147 #undef _
 148     SESSION_N_STATES,
 149 } session_state_t;
 150
 151 #define foreach_session_flag                            \
 152   _(RX_EVT, "rx-event")                                 \
 153   _(PROXY, "proxy")                                     \
 154   _(CUSTOM_TX, "custom-tx")                             \
 155   _(IS_MIGRATING, "migrating")                          \
 156   _(UNIDIRECTIONAL, "unidirectional")                   \
 157   _(CUSTOM_FIFO_TUNING, "custom-fifo-tuning")           \
 158
 159 typedef enum session_flags_bits_
 160 {
 161 #define _(sym, str) SESSION_F_BIT_ ## sym,
 162   foreach_session_flag
 163 #undef _
 164   SESSION_N_FLAGS
 165 } session_flag_bits_t;
 166
 167 typedef enum session_flags_
 168 {
 169 #define _(sym, str) SESSION_F_ ## sym = 1 << SESSION_F_BIT_ ## sym,
 170   foreach_session_flag
 171 #undef _
 172 } session_flags_t;
 173
 174 typedef struct session_
 175 {
 176   /** Pointers to rx/tx buffers. Once allocated, these do not move */
 177   svm_fifo_t *rx_fifo;
 178   svm_fifo_t *tx_fifo;
 179
 180   /** Type built from transport and network protocol types */
 181   session_type_t session_type;
 182
 183   /** State in session layer state machine. See @ref session_state_t */
 184   volatile u8 session_state;
 185
 186   /** Index in thread pool where session was allocated */
 187   u32 session_index;
 188
 189   /** Index of the app worker that owns the session */
 190   u32 app_wrk_index;
 191
 192   /** Index of the thread that allocated the session */
 193   u8 thread_index;
 194
 195   /** Session flags. See @ref session_flags_t */
 196   u32 flags;
 197
 198   /** Index of the transport connection associated to the session */
 199   u32 connection_index;
 200
 201   /** Index of application that owns the listener. Set only if a listener */
 202   u32 app_index;
 203
 204   union
 205   {
 206     /** Parent listener session index if the result of an accept */
 207     session_handle_t listener_handle;
 208
 209     /** App listener index in app's listener pool if a listener */
 210     u32 al_index;
 211   };
 212
 213   /** Opaque, for general use */
 214   u32 opaque;
 215
 216     CLIB_CACHE_LINE_ALIGN_MARK (pad);
 217 } session_t;
 218
 219 always_inline session_type_t
 220 session_type_from_proto_and_ip (transport_proto_t proto, u8 is_ip4)
 221 {
 222   return (proto << 1 | is_ip4);
 223 }
 224
 225 always_inline transport_proto_t
 226 session_type_transport_proto (session_type_t st)
 227 {
 228   return (st >> 1);
 229 }
 230
 231 always_inline u8
 232 session_type_is_ip4 (session_type_t st)
 233 {
 234   return (st & 1);
 235 }
 236
 237 always_inline transport_proto_t
 238 session_get_transport_proto (session_t * s)
 239 {
 240   return (s->session_type >> 1);
 241 }
 242
 243 always_inline fib_protocol_t
 244 session_get_fib_proto (session_t * s)
 245 {
 246   u8 is_ip4 = s->session_type & 1;
 247   return (is_ip4 ? FIB_PROTOCOL_IP4 : FIB_PROTOCOL_IP6);
 248 }
 249
 250 always_inline u8
 251 session_has_transport (session_t * s)
 252 {
 253   return (session_get_transport_proto (s) != TRANSPORT_PROTO_NONE);
 254 }
 255
 256 static inline transport_service_type_t
 257 session_transport_service_type (session_t * s)
 258 {
 259   transport_proto_t tp;
 260   tp = session_get_transport_proto (s);
 261   return transport_protocol_service_type (tp);
 262 }
 263
 264 static inline transport_tx_fn_type_t
 265 session_transport_tx_fn_type (session_t * s)
 266 {
 267   transport_proto_t tp;
 268   tp = session_get_transport_proto (s);
 269   return transport_protocol_tx_fn_type (tp);
 270 }
 271
 272 static inline u8
 273 session_tx_is_dgram (session_t * s)
 274 {
 275   return (session_transport_tx_fn_type (s) == TRANSPORT_TX_DGRAM);
 276 }
 277
 278 always_inline session_handle_t
 279 session_handle (session_t * s)
 280 {
 281   return ((u64) s->thread_index << 32) | (u64) s->session_index;
 282 }
 283
 284 always_inline u32
 285 session_index_from_handle (session_handle_t handle)
 286 {
 287   return handle & 0xFFFFFFFF;
 288 }
 289
 290 always_inline u32
 291 session_thread_from_handle (session_handle_t handle)
 292 {
 293   return handle >> 32;
 294 }
 295
 296 always_inline void
 297 session_parse_handle (session_handle_t handle, u32 * index,
 298                       u32 * thread_index)
 299 {
 300   *index = session_index_from_handle (handle);
 301   *thread_index = session_thread_from_handle (handle);
 302 }
 303
 304 static inline session_handle_t
 305 session_make_handle (u32 session_index, u32 data)
 306 {
 307   return (((u64) data << 32) | (u64) session_index);
 308 }
 309
 310 always_inline u32
 311 session_handle_index (session_handle_t ho_handle)
 312 {
 313   return (ho_handle & 0xffffffff);
 314 }
 315
 316 always_inline u32
 317 session_handle_data (session_handle_t ho_handle)
 318 {
 319   return (ho_handle >> 32);
 320 }
 321
 322 typedef enum
 323 {
 324   SESSION_IO_EVT_RX,
 325   SESSION_IO_EVT_TX,
 326   SESSION_IO_EVT_TX_FLUSH,
 327   SESSION_IO_EVT_BUILTIN_RX,
 328   SESSION_IO_EVT_BUILTIN_TX,
 329   SESSION_CTRL_EVT_RPC,
 330   SESSION_CTRL_EVT_CLOSE,
 331   SESSION_CTRL_EVT_RESET,
 332   SESSION_CTRL_EVT_BOUND,
 333   SESSION_CTRL_EVT_UNLISTEN_REPLY,
 334   SESSION_CTRL_EVT_ACCEPTED,
 335   SESSION_CTRL_EVT_ACCEPTED_REPLY,
 336   SESSION_CTRL_EVT_CONNECTED,
 337   SESSION_CTRL_EVT_DISCONNECTED,
 338   SESSION_CTRL_EVT_DISCONNECTED_REPLY,
 339   SESSION_CTRL_EVT_RESET_REPLY,
 340   SESSION_CTRL_EVT_REQ_WORKER_UPDATE,
 341   SESSION_CTRL_EVT_WORKER_UPDATE,
 342   SESSION_CTRL_EVT_WORKER_UPDATE_REPLY,
 343   SESSION_CTRL_EVT_DISCONNECT,
 344   SESSION_CTRL_EVT_CONNECT,
 345   SESSION_CTRL_EVT_CONNECT_URI,
 346   SESSION_CTRL_EVT_LISTEN,
 347   SESSION_CTRL_EVT_LISTEN_URI,
 348   SESSION_CTRL_EVT_UNLISTEN,
 349   SESSION_CTRL_EVT_APP_DETACH,
 350   SESSION_CTRL_EVT_APP_ADD_SEGMENT,
 351   SESSION_CTRL_EVT_APP_DEL_SEGMENT,
 352   SESSION_CTRL_EVT_MIGRATED,
 353   SESSION_CTRL_EVT_CLEANUP,
 354   SESSION_CTRL_EVT_APP_WRK_RPC,
 355   SESSION_CTRL_EVT_TRANSPORT_ATTR,
 356   SESSION_CTRL_EVT_TRANSPORT_ATTR_REPLY,
 357 } session_evt_type_t;
 358
 359 #define foreach_session_ctrl_evt                                              \
 360   _ (LISTEN, listen)                                                          \
 361   _ (LISTEN_URI, listen_uri)                                                  \
 362   _ (BOUND, bound)                                                            \
 363   _ (UNLISTEN, unlisten)                                                      \
 364   _ (UNLISTEN_REPLY, unlisten_reply)                                          \
 365   _ (ACCEPTED, accepted)                                                      \
 366   _ (ACCEPTED_REPLY, accepted_reply)                                          \
 367   _ (CONNECT, connect)                                                        \
 368   _ (CONNECT_URI, connect_uri)                                                \
 369   _ (CONNECTED, connected)                                                    \
 370   _ (DISCONNECT, disconnect)                                                  \
 371   _ (DISCONNECTED, disconnected)                                              \
 372   _ (DISCONNECTED_REPLY, disconnected_reply)                                  \
 373   _ (RESET_REPLY, reset_reply)                                                \
 374   _ (REQ_WORKER_UPDATE, req_worker_update)                                    \
 375   _ (WORKER_UPDATE, worker_update)                                            \
 376   _ (WORKER_UPDATE_REPLY, worker_update_reply)                                \
 377   _ (APP_DETACH, app_detach)                                                  \
 378   _ (APP_ADD_SEGMENT, app_add_segment)                                        \
 379   _ (APP_DEL_SEGMENT, app_del_segment)                                        \
 380   _ (MIGRATED, migrated)                                                      \
 381   _ (CLEANUP, cleanup)                                                        \
 382   _ (APP_WRK_RPC, app_wrk_rpc)                                                \
 383   _ (TRANSPORT_ATTR, transport_attr)                                          \
 384   _ (TRANSPORT_ATTR_REPLY, transport_attr_reply)                              \
 385 /* Deprecated and will be removed. Use types above */
 386 #define FIFO_EVENT_APP_RX SESSION_IO_EVT_RX
 387 #define FIFO_EVENT_APP_TX SESSION_IO_EVT_TX
 388 #define FIFO_EVENT_DISCONNECT SESSION_CTRL_EVT_CLOSE
 389 #define FIFO_EVENT_BUILTIN_RX SESSION_IO_EVT_BUILTIN_RX
 390 #define FIFO_EVENT_BUILTIN_TX SESSION_IO_EVT_BUILTIN_TX
 391
 392 typedef enum
 393 {
 394   SESSION_MQ_IO_EVT_RING,
 395   SESSION_MQ_CTRL_EVT_RING,
 396   SESSION_MQ_N_RINGS
 397 } session_mq_rings_e;
 398
 399 typedef struct
 400 {
 401   void *fp;
 402   void *arg;
 403 } session_rpc_args_t;
 404
 405 typedef struct
 406 {
 407   u8 event_type;
 408   u8 postponed;
 409   union
 410   {
 411     u32 session_index;
 412     session_handle_t session_handle;
 413     session_rpc_args_t rpc_args;
 414     u32 ctrl_data_index;
 415     struct
 416     {
 417       u8 data[0];
 418     };
 419   };
 420 } __clib_packed session_event_t;
 421
 422 #define SESSION_MSG_NULL { }
 423
 424 typedef struct session_dgram_pre_hdr_
 425 {
 426   u32 data_length;
 427   u32 data_offset;
 428 } session_dgram_pre_hdr_t;
 429
 430 typedef struct session_dgram_header_
 431 {
 432   u32 data_length;
 433   u32 data_offset;
 434   ip46_address_t rmt_ip;
 435   ip46_address_t lcl_ip;
 436   u16 rmt_port;
 437   u16 lcl_port;
 438   u8 is_ip4;
 439 } __clib_packed session_dgram_hdr_t;
 440
 441 #define SESSION_CONN_ID_LEN 37
 442 #define SESSION_CONN_HDR_LEN 45
 443
 444 STATIC_ASSERT (sizeof (session_dgram_hdr_t) == (SESSION_CONN_ID_LEN + 8),
 445                "session conn id wrong length");
 446
 447 #define foreach_session_error                                                 \
 448   _ (NONE, "no error")                                                        \
 449   _ (UNKNOWN, "generic/unknown error")                                        \
 450   _ (REFUSED, "refused")                                                      \
 451   _ (TIMEDOUT, "timedout")                                                    \
 452   _ (ALLOC, "obj/memory allocation error")                                    \
 453   _ (OWNER, "object not owned by application")                                \
 454   _ (NOROUTE, "no route")                                                     \
 455   _ (NOINTF, "no resolving interface")                                        \
 456   _ (NOIP, "no ip for lcl interface")                                         \
 457   _ (NOPORT, "no lcl port")                                                   \
 458   _ (NOSUPPORT, "not supported")                                              \
 459   _ (NOLISTEN, "not listening")                                               \
 460   _ (NOSESSION, "session does not exist")                                     \
 461   _ (NOAPP, "app not attached")                                               \
 462   _ (PORTINUSE, "lcl port in use")                                            \
 463   _ (IPINUSE, "ip in use")                                                    \
 464   _ (ALREADY_LISTENING, "ip port pair already listened on")                   \
 465   _ (INVALID_RMT_IP, "invalid remote ip")                                     \
 466   _ (INVALID_APPWRK, "invalid app worker")                                    \
 467   _ (INVALID_NS, "invalid namespace")                                         \
 468   _ (SEG_NO_SPACE, "Couldn't allocate a fifo pair")                           \
 469   _ (SEG_NO_SPACE2, "Created segment, couldn't allocate a fifo pair")         \
 470   _ (SEG_CREATE, "Couldn't create a new segment")                             \
 471   _ (FILTERED, "session filtered")                                            \
 472   _ (SCOPE, "scope not supported")                                            \
 473   _ (BAPI_NO_FD, "bapi doesn't have a socket fd")                             \
 474   _ (BAPI_SEND_FD, "couldn't send fd over bapi socket fd")                    \
 475   _ (BAPI_NO_REG, "app bapi registration not found")                          \
 476   _ (MQ_MSG_ALLOC, "failed to alloc mq msg")                                  \
 477   _ (TLS_HANDSHAKE, "failed tls handshake")                                   \
 478   _ (EVENTFD_ALLOC, "failed to alloc eventfd")
 479
 480 typedef enum session_error_p_
 481 {
 482 #define _(sym, str) SESSION_EP_##sym,
 483   foreach_session_error
 484 #undef _
 485   SESSION_N_ERRORS
 486 } session_error_p_t;
 487
 488 typedef enum session_error_
 489 {
 490 #define _(sym, str) SESSION_E_##sym = -SESSION_EP_##sym,
 491   foreach_session_error
 492 #undef _
 493 } session_error_t;
 494
 495 #define SESSION_CLI_ID_LEN "60"
 496 #define SESSION_CLI_STATE_LEN "15"
 497
 498 /* Maintained for compatibility. Will be deprecated */
 499 #define SESSION_ERROR_SEG_CREATE SESSION_E_SEG_CREATE
 500 #define SESSION_ERROR_NO_SPACE SESSION_E_SEG_NO_SPACE
 501 #define SESSION_ERROR_NEW_SEG_NO_SPACE SESSION_E_SEG_NO_SPACE2
 502
 503 #endif /* SRC_VNET_SESSION_SESSION_TYPES_H_ */
 504
 505 /*
 506  * fd.io coding-style-patch-verification: ON
 507  *
 508  * Local Variables:
 509  * eval: (c-set-style "gnu")
 510  * End:
 511  */