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)
25 #define foreach_session_endpoint_fields \
26 foreach_transport_endpoint_cfg_fields \
27 _(u8, transport_proto) \
29 typedef struct _session_endpoint
31 #define _(type, name) type name;
32 foreach_session_endpoint_fields
36 typedef struct _session_endpoint_cfg
38 #define _(type, name) type name;
39 foreach_session_endpoint_fields
47 } session_endpoint_cfg_t;
49 #define SESSION_IP46_ZERO \
56 #define TRANSPORT_ENDPOINT_NULL \
58 .sw_if_index = ENDPOINT_INVALID_INDEX, \
59 .ip = SESSION_IP46_ZERO, \
60 .fib_index = ENDPOINT_INVALID_INDEX, \
64 #define SESSION_ENDPOINT_NULL \
66 .sw_if_index = ENDPOINT_INVALID_INDEX, \
67 .ip = SESSION_IP46_ZERO, \
68 .fib_index = ENDPOINT_INVALID_INDEX, \
71 .peer = TRANSPORT_ENDPOINT_NULL, \
72 .transport_proto = 0, \
74 #define SESSION_ENDPOINT_CFG_NULL \
76 .sw_if_index = ENDPOINT_INVALID_INDEX, \
77 .ip = SESSION_IP46_ZERO, \
78 .fib_index = ENDPOINT_INVALID_INDEX, \
81 .peer = TRANSPORT_ENDPOINT_NULL, \
82 .transport_proto = 0, \
83 .app_wrk_index = ENDPOINT_INVALID_INDEX, \
84 .opaque = ENDPOINT_INVALID_INDEX, \
86 .parent_handle = SESSION_INVALID_HANDLE \
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)
94 session_endpoint_fib_proto (session_endpoint_t * sep)
96 return sep->is_ip4 ? FIB_PROTOCOL_IP4 : FIB_PROTOCOL_IP6;
100 session_endpoint_is_local (session_endpoint_t * sep)
102 return (ip_is_zero (&sep->ip, sep->is_ip4)
103 || ip_is_local_host (&sep->ip, sep->is_ip4));
107 session_endpoint_is_zero (session_endpoint_t * sep)
109 return ip_is_zero (&sep->ip, sep->is_ip4);
112 typedef u8 session_type_t;
113 typedef u64 session_handle_t;
117 SESSION_CLEANUP_TRANSPORT,
118 SESSION_CLEANUP_SESSION,
119 } session_cleanup_ntf_t;
126 SESSION_STATE_CREATED,
127 SESSION_STATE_LISTENING,
128 SESSION_STATE_CONNECTING,
129 SESSION_STATE_ACCEPTING,
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,
141 typedef enum session_flags_
143 SESSION_F_RX_EVT = 1,
144 SESSION_F_PROXY = (1 << 1),
145 SESSION_F_CUSTOM_TX = (1 << 2),
148 typedef struct session_
150 /** Pointers to rx/tx buffers. Once allocated, these do not move */
154 /** Type built from transport and network protocol types */
155 session_type_t session_type;
157 /** State in session layer state machine. See @ref session_state_t */
158 volatile u8 session_state;
160 /** Index in thread pool where session was allocated */
163 /** Index of the app worker that owns the session */
166 /** Index of the thread that allocated the session */
169 /** Session flags. See @ref session_flags_t */
172 /** Index of the transport connection associated to the session */
173 u32 connection_index;
175 /** Index of application that owns the listener. Set only if a listener */
180 /** Parent listener session index if the result of an accept */
181 session_handle_t listener_handle;
183 /** App listener index in app's listener pool if a listener */
187 /** Opaque, for general use */
190 CLIB_CACHE_LINE_ALIGN_MARK (pad);
193 always_inline session_type_t
194 session_type_from_proto_and_ip (transport_proto_t proto, u8 is_ip4)
196 return (proto << 1 | is_ip4);
199 always_inline transport_proto_t
200 session_type_transport_proto (session_type_t st)
206 session_type_is_ip4 (session_type_t st)
211 always_inline transport_proto_t
212 session_get_transport_proto (session_t * s)
214 return (s->session_type >> 1);
217 always_inline fib_protocol_t
218 session_get_fib_proto (session_t * s)
220 u8 is_ip4 = s->session_type & 1;
221 return (is_ip4 ? FIB_PROTOCOL_IP4 : FIB_PROTOCOL_IP6);
225 session_has_transport (session_t * s)
227 return (session_get_transport_proto (s) != TRANSPORT_PROTO_NONE);
230 static inline transport_service_type_t
231 session_transport_service_type (session_t * s)
233 transport_proto_t tp;
234 tp = session_get_transport_proto (s);
235 return transport_protocol_service_type (tp);
238 static inline transport_tx_fn_type_t
239 session_transport_tx_fn_type (session_t * s)
241 transport_proto_t tp;
242 tp = session_get_transport_proto (s);
243 return transport_protocol_tx_fn_type (tp);
247 session_tx_is_dgram (session_t * s)
249 return (session_transport_tx_fn_type (s) == TRANSPORT_TX_DGRAM);
252 always_inline session_handle_t
253 session_handle (session_t * s)
255 return ((u64) s->thread_index << 32) | (u64) s->session_index;
259 session_index_from_handle (session_handle_t handle)
261 return handle & 0xFFFFFFFF;
265 session_thread_from_handle (session_handle_t handle)
271 session_parse_handle (session_handle_t handle, u32 * index,
274 *index = session_index_from_handle (handle);
275 *thread_index = session_thread_from_handle (handle);
278 static inline session_handle_t
279 session_make_handle (u32 session_index, u32 thread_index)
281 return (((u64) thread_index << 32) | (u64) session_index);
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;
314 #define foreach_session_ctrl_evt \
316 _(LISTEN_URI, listen_uri) \
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) \
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
344 SESSION_MQ_IO_EVT_RING,
345 SESSION_MQ_CTRL_EVT_RING,
347 } session_mq_rings_e;
353 } session_rpc_args_t;
362 session_handle_t session_handle;
363 session_rpc_args_t rpc_args;
370 } __clib_packed session_event_t;
372 #define SESSION_MSG_NULL { }
374 typedef struct session_dgram_pre_hdr_
378 } session_dgram_pre_hdr_t;
380 typedef struct session_dgram_header_
384 ip46_address_t rmt_ip;
385 ip46_address_t lcl_ip;
389 } __clib_packed session_dgram_hdr_t;
391 #define SESSION_CONN_ID_LEN 37
392 #define SESSION_CONN_HDR_LEN 45
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_ */
399 * fd.io coding-style-patch-verification: ON
402 * eval: (c-set-style "gnu")