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_CLOSING,
36 SESSION_STATE_N_STATES,
37 } stream_session_state_t;
39 typedef struct generic_session_
41 svm_fifo_t *rx_fifo; /**< rx fifo */
42 svm_fifo_t *tx_fifo; /**< tx fifo */
43 session_type_t session_type; /**< session type */
44 volatile u8 session_state; /**< session state */
45 u32 session_index; /**< index in owning pool */
48 typedef struct _stream_session_t
50 /** fifo pointers. Once allocated, these do not move */
51 svm_fifo_t *server_rx_fifo;
52 svm_fifo_t *server_tx_fifo;
55 session_type_t session_type;
58 volatile u8 session_state;
60 /** Session index in per_thread pool */
63 /** App worker pool index */
68 /** To avoid n**2 "one event per frame" check */
71 /** svm segment index where fifos were allocated */
72 u32 svm_segment_index;
74 /** Transport specific */
79 /** Parent listener session if the result of an accept */
82 /** Application index if a listener */
88 /** Transport app index for apps acting as transports */
91 /** Index in listener app's listener db */
92 u32 listener_db_index;
94 /** Opaque, for general use */
98 CLIB_CACHE_LINE_ALIGN_MARK (pad);
101 typedef struct local_session_
103 /** fifo pointers. Once allocated, these do not move */
104 svm_fifo_t *server_rx_fifo;
105 svm_fifo_t *server_tx_fifo;
108 session_type_t session_type;
111 volatile u8 session_state;
119 /** Port for connection. Overlaps thread_index/enqueue_epoch */
122 /** Segment index where fifos were allocated */
123 u32 svm_segment_index;
125 /** Transport listener index. Overlaps connection index */
126 u32 transport_listener_index;
134 u32 listener_db_index;
136 /** Has transport embedded when listener not purely local */
137 session_type_t listener_session_type;
142 u32 client_wrk_index;
148 CLIB_CACHE_LINE_ALIGN_MARK (pad);
151 #define foreach_session_endpoint_fields \
152 foreach_transport_connection_fields \
153 _(u8, transport_proto) \
155 typedef struct _session_endpoint
157 #define _(type, name) type name;
158 foreach_session_endpoint_fields
160 } session_endpoint_t;
162 typedef struct _session_endpoint_extended
164 #define _(type, name) type name;
165 foreach_session_endpoint_fields
170 } session_endpoint_extended_t;
172 #define SESSION_IP46_ZERO \
178 #define SESSION_ENDPOINT_NULL \
180 .sw_if_index = ENDPOINT_INVALID_INDEX, \
181 .ip = SESSION_IP46_ZERO, \
182 .fib_index = ENDPOINT_INVALID_INDEX, \
185 .transport_proto = 0, \
187 #define SESSION_ENDPOINT_EXT_NULL \
189 .sw_if_index = ENDPOINT_INVALID_INDEX, \
190 .ip = SESSION_IP46_ZERO, \
191 .fib_index = ENDPOINT_INVALID_INDEX, \
194 .transport_proto = 0, \
195 .app_wrk_index = ENDPOINT_INVALID_INDEX, \
196 .opaque = ENDPOINT_INVALID_INDEX, \
200 #define session_endpoint_to_transport(_sep) ((transport_endpoint_t *)_sep)
203 session_endpoint_fib_proto (session_endpoint_t * sep)
205 return sep->is_ip4 ? FIB_PROTOCOL_IP4 : FIB_PROTOCOL_IP6;
208 #endif /* SRC_VNET_SESSION_STREAM_SESSION_H_ */
211 * fd.io coding-style-patch-verification: ON
214 * eval: (c-set-style "gnu")