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_NODE_FRAME_SIZE 128
27 #define foreach_session_endpoint_fields \
28 foreach_transport_endpoint_cfg_fields \
29 _(u8, transport_proto) \
31 typedef struct _session_endpoint
33 #define _(type, name) type name;
34 foreach_session_endpoint_fields
38 typedef struct _session_endpoint_cfg
40 #define _(type, name) type name;
41 foreach_session_endpoint_fields
49 transport_endpt_ext_cfg_t *ext_cfg;
50 } session_endpoint_cfg_t;
52 #define SESSION_IP46_ZERO \
59 #define TRANSPORT_ENDPOINT_NULL \
61 .sw_if_index = ENDPOINT_INVALID_INDEX, \
62 .ip = SESSION_IP46_ZERO, \
63 .fib_index = ENDPOINT_INVALID_INDEX, \
67 #define SESSION_ENDPOINT_NULL \
69 .sw_if_index = ENDPOINT_INVALID_INDEX, \
70 .ip = SESSION_IP46_ZERO, \
71 .fib_index = ENDPOINT_INVALID_INDEX, \
74 .peer = TRANSPORT_ENDPOINT_NULL, \
75 .transport_proto = 0, \
77 #define SESSION_ENDPOINT_CFG_NULL \
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, \
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)
92 session_endpoint_fib_proto (session_endpoint_t * sep)
94 return sep->is_ip4 ? FIB_PROTOCOL_IP4 : FIB_PROTOCOL_IP6;
98 session_endpoint_is_local (session_endpoint_t * sep)
100 return (ip_is_zero (&sep->ip, sep->is_ip4)
101 || ip_is_local_host (&sep->ip, sep->is_ip4));
105 session_endpoint_is_zero (session_endpoint_t * sep)
107 return ip_is_zero (&sep->ip, sep->is_ip4);
110 typedef u8 session_type_t;
111 typedef u64 session_handle_t;
115 SESSION_CLEANUP_TRANSPORT,
116 SESSION_CLEANUP_SESSION,
117 } session_cleanup_ntf_t;
119 typedef enum session_ft_action_
121 SESSION_FT_ACTION_ENQUEUED,
122 SESSION_FT_ACTION_DEQUEUED,
123 SESSION_FT_ACTION_N_ACTIONS
124 } session_ft_action_t;
129 #define foreach_session_state \
130 _(CREATED, "created") \
131 _(LISTENING, "listening") \
132 _(CONNECTING, "connecting") \
133 _(ACCEPTING, "accepting") \
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") \
145 #define _(sym, str) SESSION_STATE_ ## sym,
146 foreach_session_state
151 #define foreach_session_flag \
152 _ (RX_EVT, "rx-event") \
154 _ (CUSTOM_TX, "custom-tx") \
155 _ (IS_MIGRATING, "migrating") \
156 _ (UNIDIRECTIONAL, "unidirectional") \
157 _ (CUSTOM_FIFO_TUNING, "custom-fifo-tuning") \
158 _ (HALF_OPEN, "half-open")
160 typedef enum session_flags_bits_
162 #define _(sym, str) SESSION_F_BIT_ ## sym,
166 } session_flag_bits_t;
168 typedef enum session_flags_
170 #define _(sym, str) SESSION_F_ ## sym = 1 << SESSION_F_BIT_ ## sym,
175 typedef struct session_
177 /** Pointers to rx/tx buffers. Once allocated, these do not move */
181 /** Type built from transport and network protocol types */
182 session_type_t session_type;
184 /** State in session layer state machine. See @ref session_state_t */
185 volatile u8 session_state;
187 /** Index in thread pool where session was allocated */
190 /** Index of the app worker that owns the session */
193 /** Index of the thread that allocated the session */
196 /** Session flags. See @ref session_flags_t */
199 /** Index of the transport connection associated to the session */
200 u32 connection_index;
202 /** Index of application that owns the listener. Set only if a listener */
207 /** Parent listener session index if the result of an accept */
208 session_handle_t listener_handle;
210 /** App listener index in app's listener pool if a listener */
213 /** Index in app worker's half-open table if a half-open */
217 /** Opaque, for general use */
220 CLIB_CACHE_LINE_ALIGN_MARK (pad);
223 always_inline session_type_t
224 session_type_from_proto_and_ip (transport_proto_t proto, u8 is_ip4)
226 return (proto << 1 | is_ip4);
229 always_inline transport_proto_t
230 session_type_transport_proto (session_type_t st)
236 session_type_is_ip4 (session_type_t st)
241 always_inline transport_proto_t
242 session_get_transport_proto (session_t * s)
244 return (s->session_type >> 1);
247 always_inline fib_protocol_t
248 session_get_fib_proto (session_t * s)
250 u8 is_ip4 = s->session_type & 1;
251 return (is_ip4 ? FIB_PROTOCOL_IP4 : FIB_PROTOCOL_IP6);
255 session_has_transport (session_t * s)
257 return (session_get_transport_proto (s) != TRANSPORT_PROTO_NONE);
260 static inline transport_service_type_t
261 session_transport_service_type (session_t * s)
263 transport_proto_t tp;
264 tp = session_get_transport_proto (s);
265 return transport_protocol_service_type (tp);
268 static inline transport_tx_fn_type_t
269 session_transport_tx_fn_type (session_t * s)
271 transport_proto_t tp;
272 tp = session_get_transport_proto (s);
273 return transport_protocol_tx_fn_type (tp);
277 session_tx_is_dgram (session_t * s)
279 return (session_transport_tx_fn_type (s) == TRANSPORT_TX_DGRAM);
282 always_inline session_handle_t
283 session_handle (session_t * s)
285 return ((u64) s->thread_index << 32) | (u64) s->session_index;
289 session_index_from_handle (session_handle_t handle)
291 return handle & 0xFFFFFFFF;
295 session_thread_from_handle (session_handle_t handle)
301 session_parse_handle (session_handle_t handle, u32 * index,
304 *index = session_index_from_handle (handle);
305 *thread_index = session_thread_from_handle (handle);
308 static inline session_handle_t
309 session_make_handle (u32 session_index, u32 data)
311 return (((u64) data << 32) | (u64) session_index);
315 session_handle_index (session_handle_t ho_handle)
317 return (ho_handle & 0xffffffff);
321 session_handle_data (session_handle_t ho_handle)
323 return (ho_handle >> 32);
330 SESSION_IO_EVT_TX_FLUSH,
331 SESSION_IO_EVT_BUILTIN_RX,
332 SESSION_IO_EVT_BUILTIN_TX,
333 SESSION_CTRL_EVT_RPC,
334 SESSION_CTRL_EVT_HALF_CLOSE,
335 SESSION_CTRL_EVT_CLOSE,
336 SESSION_CTRL_EVT_RESET,
337 SESSION_CTRL_EVT_BOUND,
338 SESSION_CTRL_EVT_UNLISTEN_REPLY,
339 SESSION_CTRL_EVT_ACCEPTED,
340 SESSION_CTRL_EVT_ACCEPTED_REPLY,
341 SESSION_CTRL_EVT_CONNECTED,
342 SESSION_CTRL_EVT_DISCONNECTED,
343 SESSION_CTRL_EVT_DISCONNECTED_REPLY,
344 SESSION_CTRL_EVT_RESET_REPLY,
345 SESSION_CTRL_EVT_REQ_WORKER_UPDATE,
346 SESSION_CTRL_EVT_WORKER_UPDATE,
347 SESSION_CTRL_EVT_WORKER_UPDATE_REPLY,
348 SESSION_CTRL_EVT_SHUTDOWN,
349 SESSION_CTRL_EVT_DISCONNECT,
350 SESSION_CTRL_EVT_CONNECT,
351 SESSION_CTRL_EVT_CONNECT_URI,
352 SESSION_CTRL_EVT_LISTEN,
353 SESSION_CTRL_EVT_LISTEN_URI,
354 SESSION_CTRL_EVT_UNLISTEN,
355 SESSION_CTRL_EVT_APP_DETACH,
356 SESSION_CTRL_EVT_APP_ADD_SEGMENT,
357 SESSION_CTRL_EVT_APP_DEL_SEGMENT,
358 SESSION_CTRL_EVT_MIGRATED,
359 SESSION_CTRL_EVT_CLEANUP,
360 SESSION_CTRL_EVT_APP_WRK_RPC,
361 SESSION_CTRL_EVT_TRANSPORT_ATTR,
362 SESSION_CTRL_EVT_TRANSPORT_ATTR_REPLY,
363 } session_evt_type_t;
365 #define foreach_session_ctrl_evt \
367 _ (LISTEN_URI, listen_uri) \
369 _ (UNLISTEN, unlisten) \
370 _ (UNLISTEN_REPLY, unlisten_reply) \
371 _ (ACCEPTED, accepted) \
372 _ (ACCEPTED_REPLY, accepted_reply) \
373 _ (CONNECT, connect) \
374 _ (CONNECT_URI, connect_uri) \
375 _ (CONNECTED, connected) \
376 _ (SHUTDOWN, shutdown) \
377 _ (DISCONNECT, disconnect) \
378 _ (DISCONNECTED, disconnected) \
379 _ (DISCONNECTED_REPLY, disconnected_reply) \
380 _ (RESET_REPLY, reset_reply) \
381 _ (REQ_WORKER_UPDATE, req_worker_update) \
382 _ (WORKER_UPDATE, worker_update) \
383 _ (WORKER_UPDATE_REPLY, worker_update_reply) \
384 _ (APP_DETACH, app_detach) \
385 _ (APP_ADD_SEGMENT, app_add_segment) \
386 _ (APP_DEL_SEGMENT, app_del_segment) \
387 _ (MIGRATED, migrated) \
388 _ (CLEANUP, cleanup) \
389 _ (APP_WRK_RPC, app_wrk_rpc) \
390 _ (TRANSPORT_ATTR, transport_attr) \
391 _ (TRANSPORT_ATTR_REPLY, transport_attr_reply) \
392 /* Deprecated and will be removed. Use types above */
393 #define FIFO_EVENT_APP_RX SESSION_IO_EVT_RX
394 #define FIFO_EVENT_APP_TX SESSION_IO_EVT_TX
395 #define FIFO_EVENT_DISCONNECT SESSION_CTRL_EVT_CLOSE
396 #define FIFO_EVENT_BUILTIN_RX SESSION_IO_EVT_BUILTIN_RX
397 #define FIFO_EVENT_BUILTIN_TX SESSION_IO_EVT_BUILTIN_TX
401 SESSION_MQ_IO_EVT_RING,
402 SESSION_MQ_CTRL_EVT_RING,
404 } session_mq_rings_e;
410 } session_rpc_args_t;
419 session_handle_t session_handle;
420 session_rpc_args_t rpc_args;
427 } __clib_packed session_event_t;
429 #define SESSION_MSG_NULL { }
431 typedef struct session_dgram_pre_hdr_
435 } session_dgram_pre_hdr_t;
437 typedef struct session_dgram_header_
441 ip46_address_t rmt_ip;
442 ip46_address_t lcl_ip;
446 } __clib_packed session_dgram_hdr_t;
448 #define SESSION_CONN_ID_LEN 37
449 #define SESSION_CONN_HDR_LEN 45
451 STATIC_ASSERT (sizeof (session_dgram_hdr_t) == (SESSION_CONN_ID_LEN + 8),
452 "session conn id wrong length");
454 #define foreach_session_error \
455 _ (NONE, "no error") \
456 _ (UNKNOWN, "generic/unknown error") \
457 _ (REFUSED, "refused") \
458 _ (TIMEDOUT, "timedout") \
459 _ (ALLOC, "obj/memory allocation error") \
460 _ (OWNER, "object not owned by application") \
461 _ (NOROUTE, "no route") \
462 _ (NOINTF, "no resolving interface") \
463 _ (NOIP, "no ip for lcl interface") \
464 _ (NOPORT, "no lcl port") \
465 _ (NOSUPPORT, "not supported") \
466 _ (NOLISTEN, "not listening") \
467 _ (NOSESSION, "session does not exist") \
468 _ (NOAPP, "app not attached") \
469 _ (PORTINUSE, "lcl port in use") \
470 _ (IPINUSE, "ip in use") \
471 _ (ALREADY_LISTENING, "ip port pair already listened on") \
472 _ (INVALID, "invalid value") \
473 _ (INVALID_RMT_IP, "invalid remote ip") \
474 _ (INVALID_APPWRK, "invalid app worker") \
475 _ (INVALID_NS, "invalid namespace") \
476 _ (SEG_NO_SPACE, "Couldn't allocate a fifo pair") \
477 _ (SEG_NO_SPACE2, "Created segment, couldn't allocate a fifo pair") \
478 _ (SEG_CREATE, "Couldn't create a new segment") \
479 _ (FILTERED, "session filtered") \
480 _ (SCOPE, "scope not supported") \
481 _ (BAPI_NO_FD, "bapi doesn't have a socket fd") \
482 _ (BAPI_SEND_FD, "couldn't send fd over bapi socket fd") \
483 _ (BAPI_NO_REG, "app bapi registration not found") \
484 _ (MQ_MSG_ALLOC, "failed to alloc mq msg") \
485 _ (TLS_HANDSHAKE, "failed tls handshake") \
486 _ (EVENTFD_ALLOC, "failed to alloc eventfd") \
487 _ (NOEXTCFG, "no extended transport config") \
488 _ (NOCRYPTOENG, "no crypto engine") \
489 _ (NOCRYPTOCKP, "cert key pair not found ") \
490 _ (LOCAL_CONNECT, "could not connect with local scope")
492 typedef enum session_error_p_
494 #define _(sym, str) SESSION_EP_##sym,
495 foreach_session_error
500 typedef enum session_error_
502 #define _(sym, str) SESSION_E_##sym = -SESSION_EP_##sym,
503 foreach_session_error
507 #define SESSION_CLI_ID_LEN "60"
508 #define SESSION_CLI_STATE_LEN "15"
510 /* Maintained for compatibility. Will be deprecated */
511 #define SESSION_ERROR_SEG_CREATE SESSION_E_SEG_CREATE
512 #define SESSION_ERROR_NO_SPACE SESSION_E_SEG_NO_SPACE
513 #define SESSION_ERROR_NEW_SEG_NO_SPACE SESSION_E_SEG_NO_SPACE2
515 #endif /* SRC_VNET_SESSION_SESSION_TYPES_H_ */
518 * fd.io coding-style-patch-verification: ON
521 * eval: (c-set-style "gnu")