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 <vnet/vnet.h>
20 #include <svm/svm_fifo.h>
21 #include <vnet/session/transport.h>
23 typedef u8 session_type_t;
26 * Application session state
30 SESSION_STATE_LISTENING,
31 SESSION_STATE_CONNECTING,
32 SESSION_STATE_ACCEPTING,
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 /** stream server 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 */
82 /** Opaque, for general use */
86 CLIB_CACHE_LINE_ALIGN_MARK (pad);
89 typedef struct local_session_
91 /** fifo pointers. Once allocated, these do not move */
92 svm_fifo_t *server_rx_fifo;
93 svm_fifo_t *server_tx_fifo;
96 session_type_t session_type;
99 volatile u8 session_state;
107 /** Segment index where fifos were allocated */
108 u32 svm_segment_index;
112 /** Port for connection */
115 /** Has transport embedded when listener not purely local */
116 session_type_t listener_session_type;
117 u32 transport_listener_index;
128 CLIB_CACHE_LINE_ALIGN_MARK (pad);
131 #define foreach_session_endpoint_fields \
132 foreach_transport_connection_fields \
133 _(u8, transport_proto) \
135 typedef struct _session_endpoint
137 #define _(type, name) type name;
138 foreach_session_endpoint_fields
140 } session_endpoint_t;
142 typedef struct _session_endpoint_extended
144 #define _(type, name) type name;
145 foreach_session_endpoint_fields
150 } session_endpoint_extended_t;
152 #define SESSION_IP46_ZERO \
158 #define SESSION_ENDPOINT_NULL \
160 .sw_if_index = ENDPOINT_INVALID_INDEX, \
161 .ip = SESSION_IP46_ZERO, \
162 .fib_index = ENDPOINT_INVALID_INDEX, \
165 .transport_proto = 0, \
167 #define SESSION_ENDPOINT_EXT_NULL \
169 .sw_if_index = ENDPOINT_INVALID_INDEX, \
170 .ip = SESSION_IP46_ZERO, \
171 .fib_index = ENDPOINT_INVALID_INDEX, \
174 .transport_proto = 0, \
175 .app_index = ENDPOINT_INVALID_INDEX, \
176 .opaque = ENDPOINT_INVALID_INDEX, \
180 #define session_endpoint_to_transport(_sep) ((transport_endpoint_t *)_sep)
183 session_endpoint_fib_proto (session_endpoint_t * sep)
185 return sep->is_ip4 ? FIB_PROTOCOL_IP4 : FIB_PROTOCOL_IP6;
188 #endif /* SRC_VNET_SESSION_STREAM_SESSION_H_ */
191 * fd.io coding-style-patch-verification: ON
194 * eval: (c-set-style "gnu")