Florin Coras | 04e5344 | 2017-07-16 17:12:15 -0700 | [diff] [blame] | 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 | |
Florin Coras | 04e5344 | 2017-07-16 17:12:15 -0700 | [diff] [blame] | 19 | #include <svm/svm_fifo.h> |
Florin Coras | cea194d | 2017-10-02 00:18:51 -0700 | [diff] [blame] | 20 | #include <vnet/session/transport.h> |
Florin Coras | 04e5344 | 2017-07-16 17:12:15 -0700 | [diff] [blame] | 21 | |
Florin Coras | 561af9b | 2017-12-09 10:19:43 -0800 | [diff] [blame] | 22 | typedef u8 session_type_t; |
Florin Coras | 04e5344 | 2017-07-16 17:12:15 -0700 | [diff] [blame] | 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, |
Florin Coras | 7fb0fe1 | 2018-04-09 09:24:52 -0700 | [diff] [blame] | 33 | SESSION_STATE_OPENED, |
Florin Coras | 568ebc7 | 2018-09-18 16:12:50 -0700 | [diff] [blame] | 34 | SESSION_STATE_TRANSPORT_CLOSING, |
Florin Coras | b2371c2 | 2018-05-31 17:14:10 -0700 | [diff] [blame] | 35 | SESSION_STATE_CLOSING, |
Florin Coras | 04e5344 | 2017-07-16 17:12:15 -0700 | [diff] [blame] | 36 | SESSION_STATE_CLOSED, |
| 37 | SESSION_STATE_N_STATES, |
| 38 | } stream_session_state_t; |
| 39 | |
Florin Coras | 7fb0fe1 | 2018-04-09 09:24:52 -0700 | [diff] [blame] | 40 | typedef struct generic_session_ |
Florin Coras | f8f516a | 2018-02-08 15:10:09 -0800 | [diff] [blame] | 41 | { |
Florin Coras | 7fb0fe1 | 2018-04-09 09:24:52 -0700 | [diff] [blame] | 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; |
Florin Coras | f8f516a | 2018-02-08 15:10:09 -0800 | [diff] [blame] | 48 | |
Florin Coras | 04e5344 | 2017-07-16 17:12:15 -0700 | [diff] [blame] | 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 */ |
Florin Coras | 561af9b | 2017-12-09 10:19:43 -0800 | [diff] [blame] | 56 | session_type_t session_type; |
Florin Coras | 04e5344 | 2017-07-16 17:12:15 -0700 | [diff] [blame] | 57 | |
| 58 | /** State */ |
Florin Coras | 1f152cd | 2017-08-18 19:28:03 -0700 | [diff] [blame] | 59 | volatile u8 session_state; |
Florin Coras | 04e5344 | 2017-07-16 17:12:15 -0700 | [diff] [blame] | 60 | |
Florin Coras | f8f516a | 2018-02-08 15:10:09 -0800 | [diff] [blame] | 61 | /** Session index in per_thread pool */ |
| 62 | u32 session_index; |
| 63 | |
Florin Coras | ab2f6db | 2018-08-31 14:31:41 -0700 | [diff] [blame] | 64 | /** App worker pool index */ |
Florin Coras | 1553197 | 2018-08-12 23:50:53 -0700 | [diff] [blame] | 65 | u32 app_wrk_index; |
Florin Coras | f8f516a | 2018-02-08 15:10:09 -0800 | [diff] [blame] | 66 | |
Florin Coras | 04e5344 | 2017-07-16 17:12:15 -0700 | [diff] [blame] | 67 | u8 thread_index; |
| 68 | |
| 69 | /** To avoid n**2 "one event per frame" check */ |
Florin Coras | eb97e5f | 2018-10-15 21:35:42 -0700 | [diff] [blame] | 70 | u64 enqueue_epoch; |
Florin Coras | 04e5344 | 2017-07-16 17:12:15 -0700 | [diff] [blame] | 71 | |
Florin Coras | 04e5344 | 2017-07-16 17:12:15 -0700 | [diff] [blame] | 72 | /** svm segment index where fifos were allocated */ |
| 73 | u32 svm_segment_index; |
| 74 | |
Florin Coras | 04e5344 | 2017-07-16 17:12:15 -0700 | [diff] [blame] | 75 | /** Transport specific */ |
| 76 | u32 connection_index; |
| 77 | |
Florin Coras | 371ca50 | 2018-02-21 12:07:41 -0800 | [diff] [blame] | 78 | union |
| 79 | { |
| 80 | /** Parent listener session if the result of an accept */ |
| 81 | u32 listener_index; |
Florin Coras | ab2f6db | 2018-08-31 14:31:41 -0700 | [diff] [blame] | 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 | |
Florin Coras | 371ca50 | 2018-02-21 12:07:41 -0800 | [diff] [blame] | 95 | /** Opaque, for general use */ |
| 96 | u32 opaque; |
| 97 | }; |
Florin Coras | 04e5344 | 2017-07-16 17:12:15 -0700 | [diff] [blame] | 98 | |
Florin Coras | 0e9c33b | 2017-08-14 22:33:41 -0700 | [diff] [blame] | 99 | CLIB_CACHE_LINE_ALIGN_MARK (pad); |
Florin Coras | 04e5344 | 2017-07-16 17:12:15 -0700 | [diff] [blame] | 100 | } stream_session_t; |
| 101 | |
Florin Coras | f8f516a | 2018-02-08 15:10:09 -0800 | [diff] [blame] | 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 */ |
Florin Coras | 1553197 | 2018-08-12 23:50:53 -0700 | [diff] [blame] | 118 | u32 app_wrk_index; |
Florin Coras | f8f516a | 2018-02-08 15:10:09 -0800 | [diff] [blame] | 119 | |
Florin Coras | ab2f6db | 2018-08-31 14:31:41 -0700 | [diff] [blame] | 120 | /** Port for connection. Overlaps thread_index/enqueue_epoch */ |
| 121 | u16 port; |
| 122 | |
Florin Coras | eb97e5f | 2018-10-15 21:35:42 -0700 | [diff] [blame] | 123 | /** Partly overlaps enqueue_epoch */ |
| 124 | u8 pad_epoch[7]; |
| 125 | |
Florin Coras | f8f516a | 2018-02-08 15:10:09 -0800 | [diff] [blame] | 126 | /** Segment index where fifos were allocated */ |
| 127 | u32 svm_segment_index; |
| 128 | |
Florin Coras | ab2f6db | 2018-08-31 14:31:41 -0700 | [diff] [blame] | 129 | /** Transport listener index. Overlaps connection index */ |
| 130 | u32 transport_listener_index; |
Florin Coras | f8f516a | 2018-02-08 15:10:09 -0800 | [diff] [blame] | 131 | |
Florin Coras | ab2f6db | 2018-08-31 14:31:41 -0700 | [diff] [blame] | 132 | union |
| 133 | { |
| 134 | u32 listener_index; |
| 135 | u32 app_index; |
| 136 | }; |
| 137 | |
| 138 | u32 listener_db_index; |
Florin Coras | f8f516a | 2018-02-08 15:10:09 -0800 | [diff] [blame] | 139 | |
| 140 | /** Has transport embedded when listener not purely local */ |
| 141 | session_type_t listener_session_type; |
| 142 | |
| 143 | /** |
| 144 | * Client data |
| 145 | */ |
Florin Coras | 1553197 | 2018-08-12 23:50:53 -0700 | [diff] [blame] | 146 | u32 client_wrk_index; |
Florin Coras | f8f516a | 2018-02-08 15:10:09 -0800 | [diff] [blame] | 147 | u32 client_opaque; |
| 148 | |
| 149 | u64 server_evt_q; |
| 150 | u64 client_evt_q; |
| 151 | |
| 152 | CLIB_CACHE_LINE_ALIGN_MARK (pad); |
| 153 | } local_session_t; |
| 154 | |
Florin Coras | 371ca50 | 2018-02-21 12:07:41 -0800 | [diff] [blame] | 155 | #define foreach_session_endpoint_fields \ |
Florin Coras | 5665ced | 2018-10-25 18:03:45 -0700 | [diff] [blame] | 156 | foreach_transport_endpoint_cfg_fields \ |
| 157 | _(u8, transport_proto) \ |
Florin Coras | 371ca50 | 2018-02-21 12:07:41 -0800 | [diff] [blame] | 158 | |
Florin Coras | cea194d | 2017-10-02 00:18:51 -0700 | [diff] [blame] | 159 | typedef struct _session_endpoint |
| 160 | { |
Florin Coras | cea194d | 2017-10-02 00:18:51 -0700 | [diff] [blame] | 161 | #define _(type, name) type name; |
Florin Coras | 371ca50 | 2018-02-21 12:07:41 -0800 | [diff] [blame] | 162 | foreach_session_endpoint_fields |
Florin Coras | cea194d | 2017-10-02 00:18:51 -0700 | [diff] [blame] | 163 | #undef _ |
Florin Coras | cea194d | 2017-10-02 00:18:51 -0700 | [diff] [blame] | 164 | } session_endpoint_t; |
| 165 | |
Florin Coras | 5665ced | 2018-10-25 18:03:45 -0700 | [diff] [blame] | 166 | typedef struct _session_endpoint_cfg |
Florin Coras | 371ca50 | 2018-02-21 12:07:41 -0800 | [diff] [blame] | 167 | { |
| 168 | #define _(type, name) type name; |
| 169 | foreach_session_endpoint_fields |
| 170 | #undef _ |
Florin Coras | 1553197 | 2018-08-12 23:50:53 -0700 | [diff] [blame] | 171 | u32 app_wrk_index; |
Florin Coras | 371ca50 | 2018-02-21 12:07:41 -0800 | [diff] [blame] | 172 | u32 opaque; |
Florin Coras | 8f89dd0 | 2018-03-05 16:53:07 -0800 | [diff] [blame] | 173 | u8 *hostname; |
Florin Coras | 5665ced | 2018-10-25 18:03:45 -0700 | [diff] [blame] | 174 | } session_endpoint_cfg_t; |
Florin Coras | 371ca50 | 2018-02-21 12:07:41 -0800 | [diff] [blame] | 175 | |
Florin Coras | 1553197 | 2018-08-12 23:50:53 -0700 | [diff] [blame] | 176 | #define SESSION_IP46_ZERO \ |
| 177 | { \ |
| 178 | .ip6 = { \ |
| 179 | { 0, 0, }, \ |
| 180 | }, \ |
Florin Coras | cea194d | 2017-10-02 00:18:51 -0700 | [diff] [blame] | 181 | } |
Florin Coras | 5665ced | 2018-10-25 18:03:45 -0700 | [diff] [blame] | 182 | |
| 183 | #define TRANSPORT_ENDPOINT_NULL \ |
| 184 | { \ |
| 185 | .sw_if_index = ENDPOINT_INVALID_INDEX, \ |
| 186 | .ip = SESSION_IP46_ZERO, \ |
| 187 | .fib_index = ENDPOINT_INVALID_INDEX, \ |
| 188 | .is_ip4 = 0, \ |
| 189 | .port = 0, \ |
| 190 | } |
Florin Coras | 1553197 | 2018-08-12 23:50:53 -0700 | [diff] [blame] | 191 | #define SESSION_ENDPOINT_NULL \ |
| 192 | { \ |
Florin Coras | cea194d | 2017-10-02 00:18:51 -0700 | [diff] [blame] | 193 | .sw_if_index = ENDPOINT_INVALID_INDEX, \ |
Florin Coras | 1553197 | 2018-08-12 23:50:53 -0700 | [diff] [blame] | 194 | .ip = SESSION_IP46_ZERO, \ |
| 195 | .fib_index = ENDPOINT_INVALID_INDEX, \ |
| 196 | .is_ip4 = 0, \ |
| 197 | .port = 0, \ |
Florin Coras | 5665ced | 2018-10-25 18:03:45 -0700 | [diff] [blame] | 198 | .peer = TRANSPORT_ENDPOINT_NULL, \ |
Florin Coras | 1553197 | 2018-08-12 23:50:53 -0700 | [diff] [blame] | 199 | .transport_proto = 0, \ |
Florin Coras | 8f89dd0 | 2018-03-05 16:53:07 -0800 | [diff] [blame] | 200 | } |
Florin Coras | 5665ced | 2018-10-25 18:03:45 -0700 | [diff] [blame] | 201 | #define SESSION_ENDPOINT_CFG_NULL \ |
Florin Coras | 1553197 | 2018-08-12 23:50:53 -0700 | [diff] [blame] | 202 | { \ |
Florin Coras | 8f89dd0 | 2018-03-05 16:53:07 -0800 | [diff] [blame] | 203 | .sw_if_index = ENDPOINT_INVALID_INDEX, \ |
Florin Coras | 1553197 | 2018-08-12 23:50:53 -0700 | [diff] [blame] | 204 | .ip = SESSION_IP46_ZERO, \ |
| 205 | .fib_index = ENDPOINT_INVALID_INDEX, \ |
| 206 | .is_ip4 = 0, \ |
| 207 | .port = 0, \ |
Florin Coras | 5665ced | 2018-10-25 18:03:45 -0700 | [diff] [blame] | 208 | .peer = TRANSPORT_ENDPOINT_NULL, \ |
Florin Coras | 1553197 | 2018-08-12 23:50:53 -0700 | [diff] [blame] | 209 | .transport_proto = 0, \ |
| 210 | .app_wrk_index = ENDPOINT_INVALID_INDEX, \ |
| 211 | .opaque = ENDPOINT_INVALID_INDEX, \ |
Florin Coras | 8f89dd0 | 2018-03-05 16:53:07 -0800 | [diff] [blame] | 212 | .hostname = 0, \ |
Florin Coras | cea194d | 2017-10-02 00:18:51 -0700 | [diff] [blame] | 213 | } |
| 214 | |
| 215 | #define session_endpoint_to_transport(_sep) ((transport_endpoint_t *)_sep) |
Florin Coras | 5665ced | 2018-10-25 18:03:45 -0700 | [diff] [blame] | 216 | #define session_endpoint_to_transport_cfg(_sep) \ |
| 217 | ((transport_endpoint_cfg_t *)_sep) |
Florin Coras | cea194d | 2017-10-02 00:18:51 -0700 | [diff] [blame] | 218 | |
| 219 | always_inline u8 |
| 220 | session_endpoint_fib_proto (session_endpoint_t * sep) |
| 221 | { |
| 222 | return sep->is_ip4 ? FIB_PROTOCOL_IP4 : FIB_PROTOCOL_IP6; |
| 223 | } |
| 224 | |
Florin Coras | 04e5344 | 2017-07-16 17:12:15 -0700 | [diff] [blame] | 225 | #endif /* SRC_VNET_SESSION_STREAM_SESSION_H_ */ |
| 226 | |
| 227 | /* |
| 228 | * fd.io coding-style-patch-verification: ON |
| 229 | * |
| 230 | * Local Variables: |
| 231 | * eval: (c-set-style "gnu") |
| 232 | * End: |
| 233 | */ |