2 * Copyright (c) 2017 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_STREAM_SESSION_H_
17 #define SRC_VNET_SESSION_STREAM_SESSION_H_
19 #include <svm/svm_fifo.h>
20 #include <vnet/session/transport.h>
22 typedef u8 session_type_t;
25 * Application session state
29 SESSION_STATE_LISTENING,
30 SESSION_STATE_CONNECTING,
31 SESSION_STATE_ACCEPTING,
34 SESSION_STATE_TRANSPORT_CLOSING,
35 SESSION_STATE_CLOSING,
37 SESSION_STATE_N_STATES,
38 } stream_session_state_t;
40 typedef struct generic_session_
42 svm_fifo_t *rx_fifo; /**< rx fifo */
43 svm_fifo_t *tx_fifo; /**< tx fifo */
44 session_type_t session_type; /**< session type */
45 volatile u8 session_state; /**< session state */
46 u32 session_index; /**< index in owning pool */
49 typedef struct _stream_session_t
51 /** fifo pointers. Once allocated, these do not move */
52 svm_fifo_t *server_rx_fifo;
53 svm_fifo_t *server_tx_fifo;
56 session_type_t session_type;
59 volatile u8 session_state;
61 /** Session index in per_thread pool */
64 /** App worker pool index */
69 /** To avoid n**2 "one event per frame" check */
72 /** svm segment index where fifos were allocated */
73 u32 svm_segment_index;
75 /** Transport specific */
80 /** Parent listener session if the result of an accept */
83 /** Application index if a listener */
89 /** Transport app index for apps acting as transports */
92 /** Index in listener app's listener db */
93 u32 listener_db_index;
95 /** Opaque, for general use */
99 CLIB_CACHE_LINE_ALIGN_MARK (pad);
102 typedef struct local_session_
104 /** fifo pointers. Once allocated, these do not move */
105 svm_fifo_t *server_rx_fifo;
106 svm_fifo_t *server_tx_fifo;
109 session_type_t session_type;
112 volatile u8 session_state;
120 /** Port for connection. Overlaps thread_index/enqueue_epoch */
123 /** Segment index where fifos were allocated */
124 u32 svm_segment_index;
126 /** Transport listener index. Overlaps connection index */
127 u32 transport_listener_index;
135 u32 listener_db_index;
137 /** Has transport embedded when listener not purely local */
138 session_type_t listener_session_type;
143 u32 client_wrk_index;
149 CLIB_CACHE_LINE_ALIGN_MARK (pad);
152 #define foreach_session_endpoint_fields \
153 foreach_transport_connection_fields \
154 _(u8, transport_proto) \
156 typedef struct _session_endpoint
158 #define _(type, name) type name;
159 foreach_session_endpoint_fields
161 } session_endpoint_t;
163 typedef struct _session_endpoint_extended
165 #define _(type, name) type name;
166 foreach_session_endpoint_fields
171 } session_endpoint_extended_t;
173 #define SESSION_IP46_ZERO \
179 #define SESSION_ENDPOINT_NULL \
181 .sw_if_index = ENDPOINT_INVALID_INDEX, \
182 .ip = SESSION_IP46_ZERO, \
183 .fib_index = ENDPOINT_INVALID_INDEX, \
186 .transport_proto = 0, \
188 #define SESSION_ENDPOINT_EXT_NULL \
190 .sw_if_index = ENDPOINT_INVALID_INDEX, \
191 .ip = SESSION_IP46_ZERO, \
192 .fib_index = ENDPOINT_INVALID_INDEX, \
195 .transport_proto = 0, \
196 .app_wrk_index = ENDPOINT_INVALID_INDEX, \
197 .opaque = ENDPOINT_INVALID_INDEX, \
201 #define session_endpoint_to_transport(_sep) ((transport_endpoint_t *)_sep)
204 session_endpoint_fib_proto (session_endpoint_t * sep)
206 return sep->is_ip4 ? FIB_PROTOCOL_IP4 : FIB_PROTOCOL_IP6;
209 #endif /* SRC_VNET_SESSION_STREAM_SESSION_H_ */
212 * fd.io coding-style-patch-verification: ON
215 * eval: (c-set-style "gnu")