30178d7a4539a199a12fa78d67b2eb17d1d659d7
[vpp.git] / src / vnet / session / stream_session.h
1 /*
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:
6  *
7  *     http://www.apache.org/licenses/LICENSE-2.0
8  *
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.
14  */
15
16 #ifndef SRC_VNET_SESSION_STREAM_SESSION_H_
17 #define SRC_VNET_SESSION_STREAM_SESSION_H_
18
19 #include <svm/svm_fifo.h>
20 #include <vnet/session/transport.h>
21
22 typedef u8 session_type_t;
23
24 /*
25  * Application session state
26  */
27 typedef enum
28 {
29   SESSION_STATE_LISTENING,
30   SESSION_STATE_CONNECTING,
31   SESSION_STATE_ACCEPTING,
32   SESSION_STATE_READY,
33   SESSION_STATE_OPENED,
34   SESSION_STATE_TRANSPORT_CLOSING,
35   SESSION_STATE_CLOSING,
36   SESSION_STATE_CLOSED,
37   SESSION_STATE_N_STATES,
38 } stream_session_state_t;
39
40 typedef struct generic_session_
41 {
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 */
47 } generic_session_t;
48
49 typedef struct _stream_session_t
50 {
51   /** fifo pointers. Once allocated, these do not move */
52   svm_fifo_t *server_rx_fifo;
53   svm_fifo_t *server_tx_fifo;
54
55   /** Type */
56   session_type_t session_type;
57
58   /** State */
59   volatile u8 session_state;
60
61   /** Session index in per_thread pool */
62   u32 session_index;
63
64   /** App worker pool index */
65   u32 app_wrk_index;
66
67   u8 thread_index;
68
69   /** To avoid n**2 "one event per frame" check */
70   u8 enqueue_epoch;
71
72   /** svm segment index where fifos were allocated */
73   u32 svm_segment_index;
74
75   /** Transport specific */
76   u32 connection_index;
77
78   union
79   {
80     /** Parent listener session if the result of an accept */
81     u32 listener_index;
82
83     /** Application index if a listener */
84     u32 app_index;
85   };
86
87   union
88   {
89     /** Transport app index for apps acting as transports */
90     u32 t_app_index;
91
92     /** Index in listener app's listener db */
93     u32 listener_db_index;
94
95     /** Opaque, for general use */
96     u32 opaque;
97   };
98
99     CLIB_CACHE_LINE_ALIGN_MARK (pad);
100 } stream_session_t;
101
102 typedef struct local_session_
103 {
104   /** fifo pointers. Once allocated, these do not move */
105   svm_fifo_t *server_rx_fifo;
106   svm_fifo_t *server_tx_fifo;
107
108   /** Type */
109   session_type_t session_type;
110
111   /** State */
112   volatile u8 session_state;
113
114   /** Session index */
115   u32 session_index;
116
117   /** Server index */
118   u32 app_wrk_index;
119
120   /** Port for connection. Overlaps thread_index/enqueue_epoch */
121   u16 port;
122
123   /** Segment index where fifos were allocated */
124   u32 svm_segment_index;
125
126   /** Transport listener index. Overlaps connection index */
127   u32 transport_listener_index;
128
129   union
130   {
131     u32 listener_index;
132     u32 app_index;
133   };
134
135   u32 listener_db_index;
136
137   /** Has transport embedded when listener not purely local */
138   session_type_t listener_session_type;
139
140   /**
141    * Client data
142    */
143   u32 client_wrk_index;
144   u32 client_opaque;
145
146   u64 server_evt_q;
147   u64 client_evt_q;
148
149     CLIB_CACHE_LINE_ALIGN_MARK (pad);
150 } local_session_t;
151
152 #define foreach_session_endpoint_fields                         \
153     foreach_transport_connection_fields                         \
154     _(u8, transport_proto)                                      \
155
156 typedef struct _session_endpoint
157 {
158 #define _(type, name) type name;
159   foreach_session_endpoint_fields
160 #undef _
161 } session_endpoint_t;
162
163 typedef struct _session_endpoint_extended
164 {
165 #define _(type, name) type name;
166   foreach_session_endpoint_fields
167 #undef _
168   u32 app_wrk_index;
169   u32 opaque;
170   u8 *hostname;
171 } session_endpoint_extended_t;
172
173 #define SESSION_IP46_ZERO                       \
174 {                                               \
175     .ip6 = {                                    \
176         { 0, 0, },                              \
177     },                                          \
178 }
179 #define SESSION_ENDPOINT_NULL                   \
180 {                                               \
181   .sw_if_index = ENDPOINT_INVALID_INDEX,        \
182   .ip = SESSION_IP46_ZERO,                      \
183   .fib_index = ENDPOINT_INVALID_INDEX,          \
184   .is_ip4 = 0,                                  \
185   .port = 0,                                    \
186   .transport_proto = 0,                         \
187 }
188 #define SESSION_ENDPOINT_EXT_NULL               \
189 {                                               \
190   .sw_if_index = ENDPOINT_INVALID_INDEX,        \
191   .ip = SESSION_IP46_ZERO,                      \
192   .fib_index = ENDPOINT_INVALID_INDEX,          \
193   .is_ip4 = 0,                                  \
194   .port = 0,                                    \
195   .transport_proto = 0,                         \
196   .app_wrk_index = ENDPOINT_INVALID_INDEX,      \
197   .opaque = ENDPOINT_INVALID_INDEX,             \
198   .hostname = 0,                                \
199 }
200
201 #define session_endpoint_to_transport(_sep) ((transport_endpoint_t *)_sep)
202
203 always_inline u8
204 session_endpoint_fib_proto (session_endpoint_t * sep)
205 {
206   return sep->is_ip4 ? FIB_PROTOCOL_IP4 : FIB_PROTOCOL_IP6;
207 }
208
209 #endif /* SRC_VNET_SESSION_STREAM_SESSION_H_ */
210
211 /*
212  * fd.io coding-style-patch-verification: ON
213  *
214  * Local Variables:
215  * eval: (c-set-style "gnu")
216  * End:
217  */