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:
7 * http://www.apache.org/licenses/LICENSE-2.0
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.
16 #ifndef SRC_VNET_SESSION_SESSION_TYPES_H_
17 #define SRC_VNET_SESSION_SESSION_TYPES_H_
19 #include <svm/svm_fifo.h>
20 #include <vnet/session/transport_types.h>
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_CTRL_MSG_TX_MAX_SIZE 160
26 #define SESSION_NODE_FRAME_SIZE 128
28 #define foreach_session_endpoint_fields \
29 foreach_transport_endpoint_cfg_fields \
30 _(u8, transport_proto) \
32 typedef struct _session_endpoint
34 #define _(type, name) type name;
35 foreach_session_endpoint_fields
39 typedef struct _session_endpoint_cfg
41 #define _(type, name) type name;
42 foreach_session_endpoint_fields
50 transport_endpt_ext_cfg_t *ext_cfg;
51 } session_endpoint_cfg_t;
53 #define SESSION_IP46_ZERO \
60 #define TRANSPORT_ENDPOINT_NULL \
62 .sw_if_index = ENDPOINT_INVALID_INDEX, \
63 .ip = SESSION_IP46_ZERO, \
64 .fib_index = ENDPOINT_INVALID_INDEX, \
68 #define SESSION_ENDPOINT_NULL \
70 .sw_if_index = ENDPOINT_INVALID_INDEX, \
71 .ip = SESSION_IP46_ZERO, \
72 .fib_index = ENDPOINT_INVALID_INDEX, \
75 .peer = TRANSPORT_ENDPOINT_NULL, \
76 .transport_proto = 0, \
78 #define SESSION_ENDPOINT_CFG_NULL \
80 .sw_if_index = ENDPOINT_INVALID_INDEX, .ip = SESSION_IP46_ZERO, \
81 .fib_index = ENDPOINT_INVALID_INDEX, .is_ip4 = 0, .port = 0, \
82 .peer = TRANSPORT_ENDPOINT_NULL, .transport_proto = 0, \
83 .app_wrk_index = ENDPOINT_INVALID_INDEX, \
84 .opaque = ENDPOINT_INVALID_INDEX, \
85 .parent_handle = SESSION_INVALID_HANDLE, .ext_cfg = 0, \
88 #define session_endpoint_to_transport(_sep) ((transport_endpoint_t *)_sep)
89 #define session_endpoint_to_transport_cfg(_sep) \
90 ((transport_endpoint_cfg_t *)_sep)
93 session_endpoint_fib_proto (session_endpoint_t * sep)
95 return sep->is_ip4 ? FIB_PROTOCOL_IP4 : FIB_PROTOCOL_IP6;
99 session_endpoint_is_local (session_endpoint_t * sep)
101 return (ip_is_zero (&sep->ip, sep->is_ip4)
102 || ip_is_local_host (&sep->ip, sep->is_ip4));
106 session_endpoint_is_zero (session_endpoint_t * sep)
108 return ip_is_zero (&sep->ip, sep->is_ip4);
111 typedef u8 session_type_t;
112 typedef u64 session_handle_t;
116 SESSION_CLEANUP_TRANSPORT,
117 SESSION_CLEANUP_SESSION,
118 } session_cleanup_ntf_t;
120 typedef enum session_ft_action_
122 SESSION_FT_ACTION_ENQUEUED,
123 SESSION_FT_ACTION_DEQUEUED,
124 SESSION_FT_ACTION_N_ACTIONS
125 } session_ft_action_t;
130 #define foreach_session_state \
131 _(CREATED, "created") \
132 _(LISTENING, "listening") \
133 _(CONNECTING, "connecting") \
134 _(ACCEPTING, "accepting") \
136 _(OPENED, "opened") \
137 _(TRANSPORT_CLOSING, "transport-closing") \
138 _(CLOSING, "closing") \
139 _(APP_CLOSED, "app-closed") \
140 _(TRANSPORT_CLOSED, "transport-closed") \
141 _(CLOSED, "closed") \
142 _(TRANSPORT_DELETED, "transport-deleted") \
146 #define _(sym, str) SESSION_STATE_ ## sym,
147 foreach_session_state
152 #define foreach_session_flag \
153 _ (RX_EVT, "rx-event") \
155 _ (CUSTOM_TX, "custom-tx") \
156 _ (IS_MIGRATING, "migrating") \
157 _ (UNIDIRECTIONAL, "unidirectional") \
158 _ (CUSTOM_FIFO_TUNING, "custom-fifo-tuning") \
159 _ (HALF_OPEN, "half-open")
161 typedef enum session_flags_bits_
163 #define _(sym, str) SESSION_F_BIT_ ## sym,
167 } session_flag_bits_t;
169 typedef enum session_flags_
171 #define _(sym, str) SESSION_F_ ## sym = 1 << SESSION_F_BIT_ ## sym,
176 typedef struct session_
178 /** Pointers to rx/tx buffers. Once allocated, these do not move */
182 /** Type built from transport and network protocol types */
183 session_type_t session_type;
185 /** State in session layer state machine. See @ref session_state_t */
186 volatile u8 session_state;
188 /** Index in thread pool where session was allocated */
191 /** Index of the app worker that owns the session */
194 /** Index of the thread that allocated the session */
197 /** Session flags. See @ref session_flags_t */
200 /** Index of the transport connection associated to the session */
201 u32 connection_index;
203 /** Index of application that owns the listener. Set only if a listener */
208 /** Parent listener session index if the result of an accept */
209 session_handle_t listener_handle;
211 /** App listener index in app's listener pool if a listener */
214 /** Index in app worker's half-open table if a half-open */
218 /** Opaque, for general use */
221 CLIB_CACHE_LINE_ALIGN_MARK (pad);
224 always_inline session_type_t
225 session_type_from_proto_and_ip (transport_proto_t proto, u8 is_ip4)
227 return (proto << 1 | is_ip4);
230 always_inline transport_proto_t
231 session_type_transport_proto (session_type_t st)
237 session_type_is_ip4 (session_type_t st)
242 always_inline transport_proto_t
243 session_get_transport_proto (session_t * s)
245 return (s->session_type >> 1);
248 always_inline fib_protocol_t
249 session_get_fib_proto (session_t * s)
251 u8 is_ip4 = s->session_type & 1;
252 return (is_ip4 ? FIB_PROTOCOL_IP4 : FIB_PROTOCOL_IP6);
256 session_has_transport (session_t * s)
258 return (session_get_transport_proto (s) != TRANSPORT_PROTO_NONE);
261 static inline transport_service_type_t
262 session_transport_service_type (session_t * s)
264 transport_proto_t tp;
265 tp = session_get_transport_proto (s);
266 return transport_protocol_service_type (tp);
269 static inline transport_tx_fn_type_t
270 session_transport_tx_fn_type (session_t * s)
272 transport_proto_t tp;
273 tp = session_get_transport_proto (s);
274 return transport_protocol_tx_fn_type (tp);
278 session_tx_is_dgram (session_t * s)
280 return (session_transport_tx_fn_type (s) == TRANSPORT_TX_DGRAM);
283 always_inline session_handle_t
284 session_handle (session_t * s)
286 return ((u64) s->thread_index << 32) | (u64) s->session_index;
290 session_index_from_handle (session_handle_t handle)
292 return handle & 0xFFFFFFFF;
296 session_thread_from_handle (session_handle_t handle)
302 session_parse_handle (session_handle_t handle, u32 * index,
305 *index = session_index_from_handle (handle);
306 *thread_index = session_thread_from_handle (handle);
309 static inline session_handle_t
310 session_make_handle (u32 session_index, u32 data)
312 return (((u64) data << 32) | (u64) session_index);
316 session_handle_index (session_handle_t ho_handle)
318 return (ho_handle & 0xffffffff);
322 session_handle_data (session_handle_t ho_handle)
324 return (ho_handle >> 32);
331 SESSION_IO_EVT_TX_FLUSH,
332 SESSION_IO_EVT_BUILTIN_RX,
333 SESSION_IO_EVT_BUILTIN_TX,
334 SESSION_CTRL_EVT_RPC,
335 SESSION_CTRL_EVT_HALF_CLOSE,
336 SESSION_CTRL_EVT_CLOSE,
337 SESSION_CTRL_EVT_RESET,
338 SESSION_CTRL_EVT_BOUND,
339 SESSION_CTRL_EVT_UNLISTEN_REPLY,
340 SESSION_CTRL_EVT_ACCEPTED,
341 SESSION_CTRL_EVT_ACCEPTED_REPLY,
342 SESSION_CTRL_EVT_CONNECTED,
343 SESSION_CTRL_EVT_DISCONNECTED,
344 SESSION_CTRL_EVT_DISCONNECTED_REPLY,
345 SESSION_CTRL_EVT_RESET_REPLY,
346 SESSION_CTRL_EVT_REQ_WORKER_UPDATE,
347 SESSION_CTRL_EVT_WORKER_UPDATE,
348 SESSION_CTRL_EVT_WORKER_UPDATE_REPLY,
349 SESSION_CTRL_EVT_SHUTDOWN,
350 SESSION_CTRL_EVT_DISCONNECT,
351 SESSION_CTRL_EVT_CONNECT,
352 SESSION_CTRL_EVT_CONNECT_URI,
353 SESSION_CTRL_EVT_LISTEN,
354 SESSION_CTRL_EVT_LISTEN_URI,
355 SESSION_CTRL_EVT_UNLISTEN,
356 SESSION_CTRL_EVT_APP_DETACH,
357 SESSION_CTRL_EVT_APP_ADD_SEGMENT,
358 SESSION_CTRL_EVT_APP_DEL_SEGMENT,
359 SESSION_CTRL_EVT_MIGRATED,
360 SESSION_CTRL_EVT_CLEANUP,
361 SESSION_CTRL_EVT_APP_WRK_RPC,
362 SESSION_CTRL_EVT_TRANSPORT_ATTR,
363 SESSION_CTRL_EVT_TRANSPORT_ATTR_REPLY,
364 } session_evt_type_t;
366 #define foreach_session_ctrl_evt \
368 _ (LISTEN_URI, listen_uri) \
370 _ (UNLISTEN, unlisten) \
371 _ (UNLISTEN_REPLY, unlisten_reply) \
372 _ (ACCEPTED, accepted) \
373 _ (ACCEPTED_REPLY, accepted_reply) \
374 _ (CONNECT, connect) \
375 _ (CONNECT_URI, connect_uri) \
376 _ (CONNECTED, connected) \
377 _ (SHUTDOWN, shutdown) \
378 _ (DISCONNECT, disconnect) \
379 _ (DISCONNECTED, disconnected) \
380 _ (DISCONNECTED_REPLY, disconnected_reply) \
381 _ (RESET_REPLY, reset_reply) \
382 _ (REQ_WORKER_UPDATE, req_worker_update) \
383 _ (WORKER_UPDATE, worker_update) \
384 _ (WORKER_UPDATE_REPLY, worker_update_reply) \
385 _ (APP_DETACH, app_detach) \
386 _ (APP_ADD_SEGMENT, app_add_segment) \
387 _ (APP_DEL_SEGMENT, app_del_segment) \
388 _ (MIGRATED, migrated) \
389 _ (CLEANUP, cleanup) \
390 _ (APP_WRK_RPC, app_wrk_rpc) \
391 _ (TRANSPORT_ATTR, transport_attr) \
392 _ (TRANSPORT_ATTR_REPLY, transport_attr_reply) \
393 /* Deprecated and will be removed. Use types above */
394 #define FIFO_EVENT_APP_RX SESSION_IO_EVT_RX
395 #define FIFO_EVENT_APP_TX SESSION_IO_EVT_TX
396 #define FIFO_EVENT_DISCONNECT SESSION_CTRL_EVT_CLOSE
397 #define FIFO_EVENT_BUILTIN_RX SESSION_IO_EVT_BUILTIN_RX
398 #define FIFO_EVENT_BUILTIN_TX SESSION_IO_EVT_BUILTIN_TX
402 SESSION_MQ_IO_EVT_RING,
403 SESSION_MQ_CTRL_EVT_RING,
405 } session_mq_rings_e;
411 } session_rpc_args_t;
420 session_handle_t session_handle;
421 session_rpc_args_t rpc_args;
428 } __clib_packed session_event_t;
430 #define SESSION_MSG_NULL { }
432 typedef struct session_dgram_pre_hdr_
436 } session_dgram_pre_hdr_t;
438 typedef struct session_dgram_header_
442 ip46_address_t rmt_ip;
443 ip46_address_t lcl_ip;
447 } __clib_packed session_dgram_hdr_t;
449 #define SESSION_CONN_ID_LEN 37
450 #define SESSION_CONN_HDR_LEN 45
452 STATIC_ASSERT (sizeof (session_dgram_hdr_t) == (SESSION_CONN_ID_LEN + 8),
453 "session conn id wrong length");
455 #define foreach_session_error \
456 _ (NONE, "no error") \
457 _ (UNKNOWN, "generic/unknown error") \
458 _ (REFUSED, "refused") \
459 _ (TIMEDOUT, "timedout") \
460 _ (ALLOC, "obj/memory allocation error") \
461 _ (OWNER, "object not owned by application") \
462 _ (NOROUTE, "no route") \
463 _ (NOINTF, "no resolving interface") \
464 _ (NOIP, "no ip for lcl interface") \
465 _ (NOPORT, "no lcl port") \
466 _ (NOSUPPORT, "not supported") \
467 _ (NOLISTEN, "not listening") \
468 _ (NOSESSION, "session does not exist") \
469 _ (NOAPP, "app not attached") \
470 _ (PORTINUSE, "lcl port in use") \
471 _ (IPINUSE, "ip in use") \
472 _ (ALREADY_LISTENING, "ip port pair already listened on") \
473 _ (INVALID, "invalid value") \
474 _ (INVALID_RMT_IP, "invalid remote ip") \
475 _ (INVALID_APPWRK, "invalid app worker") \
476 _ (INVALID_NS, "invalid namespace") \
477 _ (SEG_NO_SPACE, "Couldn't allocate a fifo pair") \
478 _ (SEG_NO_SPACE2, "Created segment, couldn't allocate a fifo pair") \
479 _ (SEG_CREATE, "Couldn't create a new segment") \
480 _ (FILTERED, "session filtered") \
481 _ (SCOPE, "scope not supported") \
482 _ (BAPI_NO_FD, "bapi doesn't have a socket fd") \
483 _ (BAPI_SEND_FD, "couldn't send fd over bapi socket fd") \
484 _ (BAPI_NO_REG, "app bapi registration not found") \
485 _ (MQ_MSG_ALLOC, "failed to alloc mq msg") \
486 _ (TLS_HANDSHAKE, "failed tls handshake") \
487 _ (EVENTFD_ALLOC, "failed to alloc eventfd") \
488 _ (NOEXTCFG, "no extended transport config") \
489 _ (NOCRYPTOENG, "no crypto engine") \
490 _ (NOCRYPTOCKP, "cert key pair not found ") \
491 _ (LOCAL_CONNECT, "could not connect with local scope")
493 typedef enum session_error_p_
495 #define _(sym, str) SESSION_EP_##sym,
496 foreach_session_error
501 typedef enum session_error_
503 #define _(sym, str) SESSION_E_##sym = -SESSION_EP_##sym,
504 foreach_session_error
508 #define SESSION_CLI_ID_LEN "60"
509 #define SESSION_CLI_STATE_LEN "15"
511 /* Maintained for compatibility. Will be deprecated */
512 #define SESSION_ERROR_SEG_CREATE SESSION_E_SEG_CREATE
513 #define SESSION_ERROR_NO_SPACE SESSION_E_SEG_NO_SPACE
514 #define SESSION_ERROR_NEW_SEG_NO_SPACE SESSION_E_SEG_NO_SPACE2
516 #endif /* SRC_VNET_SESSION_SESSION_TYPES_H_ */
519 * fd.io coding-style-patch-verification: ON
522 * eval: (c-set-style "gnu")