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_LISTENER_PREFIX 0x5FFFFFFF
24 #define foreach_session_endpoint_fields \
25 foreach_transport_endpoint_cfg_fields \
26 _(u8, transport_proto) \
28 typedef struct _session_endpoint
30 #define _(type, name) type name;
31 foreach_session_endpoint_fields
35 typedef struct _session_endpoint_cfg
37 #define _(type, name) type name;
38 foreach_session_endpoint_fields
45 } session_endpoint_cfg_t;
47 #define SESSION_IP46_ZERO \
54 #define TRANSPORT_ENDPOINT_NULL \
56 .sw_if_index = ENDPOINT_INVALID_INDEX, \
57 .ip = SESSION_IP46_ZERO, \
58 .fib_index = ENDPOINT_INVALID_INDEX, \
62 #define SESSION_ENDPOINT_NULL \
64 .sw_if_index = ENDPOINT_INVALID_INDEX, \
65 .ip = SESSION_IP46_ZERO, \
66 .fib_index = ENDPOINT_INVALID_INDEX, \
69 .peer = TRANSPORT_ENDPOINT_NULL, \
70 .transport_proto = 0, \
72 #define SESSION_ENDPOINT_CFG_NULL \
74 .sw_if_index = ENDPOINT_INVALID_INDEX, \
75 .ip = SESSION_IP46_ZERO, \
76 .fib_index = ENDPOINT_INVALID_INDEX, \
79 .peer = TRANSPORT_ENDPOINT_NULL, \
80 .transport_proto = 0, \
81 .app_wrk_index = ENDPOINT_INVALID_INDEX, \
82 .opaque = ENDPOINT_INVALID_INDEX, \
86 #define session_endpoint_to_transport(_sep) ((transport_endpoint_t *)_sep)
87 #define session_endpoint_to_transport_cfg(_sep) \
88 ((transport_endpoint_cfg_t *)_sep)
91 session_endpoint_fib_proto (session_endpoint_t * sep)
93 return sep->is_ip4 ? FIB_PROTOCOL_IP4 : FIB_PROTOCOL_IP6;
97 session_endpoint_is_local (session_endpoint_t * sep)
99 return (ip_is_zero (&sep->ip, sep->is_ip4)
100 || ip_is_local_host (&sep->ip, sep->is_ip4));
104 session_endpoint_is_zero (session_endpoint_t * sep)
106 return ip_is_zero (&sep->ip, sep->is_ip4);
109 typedef u8 session_type_t;
110 typedef u64 session_handle_t;
117 SESSION_STATE_CREATED,
118 SESSION_STATE_LISTENING,
119 SESSION_STATE_CONNECTING,
120 SESSION_STATE_ACCEPTING,
122 SESSION_STATE_OPENED,
123 SESSION_STATE_TRANSPORT_CLOSING,
124 SESSION_STATE_CLOSING,
125 SESSION_STATE_CLOSED_WAITING,
126 SESSION_STATE_TRANSPORT_CLOSED,
127 SESSION_STATE_CLOSED,
128 SESSION_STATE_N_STATES,
131 typedef enum session_flags_
137 typedef struct session_
139 /** Pointers to rx/tx buffers. Once allocated, these do not move */
143 /** Type built from transport and network protocol types */
144 session_type_t session_type;
146 /** State in session layer state machine. See @ref session_state_t */
147 volatile u8 session_state;
149 /** Index in thread pool where session was allocated */
152 /** Index of the app worker that owns the session */
155 /** Index of the thread that allocated the session */
158 /** Session flags. See @ref session_flags_t */
161 /** Index of the transport connection associated to the session */
162 u32 connection_index;
164 /** Index of application that owns the listener. Set only if a listener */
169 /** Parent listener session index if the result of an accept */
172 /** App listener index in app's listener pool if a listener */
176 /** Opaque, for general use */
179 CLIB_CACHE_LINE_ALIGN_MARK (pad);
182 always_inline session_type_t
183 session_type_from_proto_and_ip (transport_proto_t proto, u8 is_ip4)
185 return (proto << 1 | is_ip4);
188 always_inline transport_proto_t
189 session_type_transport_proto (session_type_t st)
195 session_type_is_ip4 (session_type_t st)
200 always_inline transport_proto_t
201 session_get_transport_proto (session_t * s)
203 return (s->session_type >> 1);
206 always_inline fib_protocol_t
207 session_get_fib_proto (session_t * s)
209 u8 is_ip4 = s->session_type & 1;
210 return (is_ip4 ? FIB_PROTOCOL_IP4 : FIB_PROTOCOL_IP6);
214 session_has_transport (session_t * s)
216 return (session_get_transport_proto (s) != TRANSPORT_PROTO_NONE);
219 static inline transport_service_type_t
220 session_transport_service_type (session_t * s)
222 transport_proto_t tp;
223 tp = session_get_transport_proto (s);
224 return transport_protocol_service_type (tp);
227 static inline transport_tx_fn_type_t
228 session_transport_tx_fn_type (session_t * s)
230 transport_proto_t tp;
231 tp = session_get_transport_proto (s);
232 return transport_protocol_tx_fn_type (tp);
236 session_tx_is_dgram (session_t * s)
238 return (session_transport_tx_fn_type (s) == TRANSPORT_TX_DGRAM);
241 always_inline session_handle_t
242 session_handle (session_t * s)
244 return ((u64) s->thread_index << 32) | (u64) s->session_index;
248 session_index_from_handle (session_handle_t handle)
250 return handle & 0xFFFFFFFF;
254 session_thread_from_handle (session_handle_t handle)
260 session_parse_handle (session_handle_t handle, u32 * index,
263 *index = session_index_from_handle (handle);
264 *thread_index = session_thread_from_handle (handle);
271 SESSION_IO_EVT_TX_FLUSH,
272 SESSION_IO_EVT_BUILTIN_RX,
273 SESSION_IO_EVT_BUILTIN_TX,
274 SESSION_CTRL_EVT_RPC,
275 SESSION_CTRL_EVT_CLOSE,
276 SESSION_CTRL_EVT_BOUND,
277 SESSION_CTRL_EVT_UNLISTEN_REPLY,
278 SESSION_CTRL_EVT_ACCEPTED,
279 SESSION_CTRL_EVT_ACCEPTED_REPLY,
280 SESSION_CTRL_EVT_CONNECTED,
281 SESSION_CTRL_EVT_CONNECTED_REPLY,
282 SESSION_CTRL_EVT_DISCONNECTED,
283 SESSION_CTRL_EVT_DISCONNECTED_REPLY,
284 SESSION_CTRL_EVT_RESET,
285 SESSION_CTRL_EVT_RESET_REPLY,
286 SESSION_CTRL_EVT_REQ_WORKER_UPDATE,
287 SESSION_CTRL_EVT_WORKER_UPDATE,
288 SESSION_CTRL_EVT_WORKER_UPDATE_REPLY,
289 } session_evt_type_t;
291 /* Deprecated and will be removed. Use types above */
292 #define FIFO_EVENT_APP_RX SESSION_IO_EVT_RX
293 #define FIFO_EVENT_APP_TX SESSION_IO_EVT_TX
294 #define FIFO_EVENT_DISCONNECT SESSION_CTRL_EVT_CLOSE
295 #define FIFO_EVENT_BUILTIN_RX SESSION_IO_EVT_BUILTIN_RX
296 #define FIFO_EVENT_BUILTIN_TX SESSION_IO_EVT_BUILTIN_TX
300 SESSION_MQ_IO_EVT_RING,
301 SESSION_MQ_CTRL_EVT_RING,
303 } session_mq_rings_e;
309 } session_rpc_args_t;
318 session_handle_t session_handle;
319 session_rpc_args_t rpc_args;
325 } __clib_packed session_event_t;
327 #define SESSION_MSG_NULL { }
329 typedef struct session_dgram_pre_hdr_
333 } session_dgram_pre_hdr_t;
335 typedef struct session_dgram_header_
339 ip46_address_t rmt_ip;
340 ip46_address_t lcl_ip;
344 } __clib_packed session_dgram_hdr_t;
346 #define SESSION_CONN_ID_LEN 37
347 #define SESSION_CONN_HDR_LEN 45
349 STATIC_ASSERT (sizeof (session_dgram_hdr_t) == (SESSION_CONN_ID_LEN + 8),
350 "session conn id wrong length");
351 #endif /* SRC_VNET_SESSION_SESSION_TYPES_H_ */
354 * fd.io coding-style-patch-verification: ON
357 * eval: (c-set-style "gnu")