Dave Barach | 68b0fb0 | 2017-02-28 15:15:56 -0500 | [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_APPLICATION_H_ |
| 17 | #define SRC_VNET_SESSION_APPLICATION_H_ |
| 18 | |
| 19 | #include <vnet/vnet.h> |
| 20 | #include <vnet/session/session.h> |
Florin Coras | 6cf30ad | 2017-04-04 23:08:23 -0700 | [diff] [blame] | 21 | #include <vnet/session/segment_manager.h> |
Florin Coras | cea194d | 2017-10-02 00:18:51 -0700 | [diff] [blame] | 22 | #include <vnet/session/application_namespace.h> |
Dave Barach | 68b0fb0 | 2017-02-28 15:15:56 -0500 | [diff] [blame] | 23 | typedef enum |
| 24 | { |
| 25 | APP_SERVER, |
Florin Coras | 6cf30ad | 2017-04-04 23:08:23 -0700 | [diff] [blame] | 26 | APP_CLIENT, |
| 27 | APP_N_TYPES |
Dave Barach | 68b0fb0 | 2017-02-28 15:15:56 -0500 | [diff] [blame] | 28 | } application_type_t; |
| 29 | |
| 30 | typedef struct _stream_session_cb_vft |
| 31 | { |
| 32 | /** Notify server of new segment */ |
Florin Coras | b384b54 | 2018-01-15 01:08:33 -0800 | [diff] [blame] | 33 | int (*add_segment_callback) (u32 api_client_index, |
| 34 | const ssvm_private_t * ssvm_seg); |
Florin Coras | f8f516a | 2018-02-08 15:10:09 -0800 | [diff] [blame] | 35 | /** Notify server of new segment */ |
| 36 | int (*del_segment_callback) (u32 api_client_index, |
| 37 | const ssvm_private_t * ssvm_seg); |
Dave Barach | 68b0fb0 | 2017-02-28 15:15:56 -0500 | [diff] [blame] | 38 | |
| 39 | /** Notify server of newly accepted session */ |
| 40 | int (*session_accept_callback) (stream_session_t * new_session); |
| 41 | |
Florin Coras | cea194d | 2017-10-02 00:18:51 -0700 | [diff] [blame] | 42 | /** Connection request callback */ |
Florin Coras | ab0289a | 2017-08-14 11:25:25 -0700 | [diff] [blame] | 43 | int (*session_connected_callback) (u32 app_index, u32 opaque, |
Dave Barach | 68b0fb0 | 2017-02-28 15:15:56 -0500 | [diff] [blame] | 44 | stream_session_t * s, u8 code); |
| 45 | |
| 46 | /** Notify app that session is closing */ |
| 47 | void (*session_disconnect_callback) (stream_session_t * s); |
| 48 | |
| 49 | /** Notify app that session was reset */ |
| 50 | void (*session_reset_callback) (stream_session_t * s); |
| 51 | |
Florin Coras | cea194d | 2017-10-02 00:18:51 -0700 | [diff] [blame] | 52 | /** Direct RX callback, for built-in servers */ |
Florin Coras | 6792ec0 | 2017-03-13 03:49:51 -0700 | [diff] [blame] | 53 | int (*builtin_server_rx_callback) (stream_session_t * session); |
Dave Barach | 68b0fb0 | 2017-02-28 15:15:56 -0500 | [diff] [blame] | 54 | |
Dave Barach | 68b0fb0 | 2017-02-28 15:15:56 -0500 | [diff] [blame] | 55 | } session_cb_vft_t; |
| 56 | |
| 57 | typedef struct _application |
| 58 | { |
| 59 | /** Index in server pool */ |
| 60 | u32 index; |
| 61 | |
| 62 | /** Flags */ |
| 63 | u32 flags; |
| 64 | |
Florin Coras | 6cf30ad | 2017-04-04 23:08:23 -0700 | [diff] [blame] | 65 | /* |
| 66 | * Binary API interface to external app |
| 67 | */ |
| 68 | |
Dave Barach | 68b0fb0 | 2017-02-28 15:15:56 -0500 | [diff] [blame] | 69 | /** Binary API connection index, ~0 if internal */ |
| 70 | u32 api_client_index; |
| 71 | |
Florin Coras | cea194d | 2017-10-02 00:18:51 -0700 | [diff] [blame] | 72 | /** Namespace the application belongs to */ |
| 73 | u32 ns_index; |
| 74 | |
Dave Barach | 68b0fb0 | 2017-02-28 15:15:56 -0500 | [diff] [blame] | 75 | /** Application listens for events on this svm queue */ |
Florin Coras | e86a8ed | 2018-01-05 03:20:25 -0800 | [diff] [blame] | 76 | svm_queue_t *event_queue; |
Dave Barach | 68b0fb0 | 2017-02-28 15:15:56 -0500 | [diff] [blame] | 77 | |
Dave Barach | 68b0fb0 | 2017-02-28 15:15:56 -0500 | [diff] [blame] | 78 | /* |
| 79 | * Callbacks: shoulder-taps for the server/client |
| 80 | */ |
Florin Coras | 6cf30ad | 2017-04-04 23:08:23 -0700 | [diff] [blame] | 81 | |
Dave Barach | 68b0fb0 | 2017-02-28 15:15:56 -0500 | [diff] [blame] | 82 | session_cb_vft_t cb_fns; |
Florin Coras | 6cf30ad | 2017-04-04 23:08:23 -0700 | [diff] [blame] | 83 | |
| 84 | /* |
Florin Coras | f8f516a | 2018-02-08 15:10:09 -0800 | [diff] [blame] | 85 | * ssvm (fifo) segment management |
Florin Coras | 6cf30ad | 2017-04-04 23:08:23 -0700 | [diff] [blame] | 86 | */ |
Florin Coras | f8f516a | 2018-02-08 15:10:09 -0800 | [diff] [blame] | 87 | /** Segment manager used for outgoing connects issued by the app */ |
Florin Coras | 6cf30ad | 2017-04-04 23:08:23 -0700 | [diff] [blame] | 88 | u32 connects_seg_manager; |
| 89 | |
Florin Coras | c87c91d | 2017-08-16 19:55:49 -0700 | [diff] [blame] | 90 | /** Lookup tables for listeners. Value is segment manager index */ |
Florin Coras | 6cf30ad | 2017-04-04 23:08:23 -0700 | [diff] [blame] | 91 | uword *listeners_table; |
| 92 | |
Florin Coras | 7999e83 | 2017-10-31 01:51:04 -0700 | [diff] [blame] | 93 | /** |
| 94 | * First segment manager has in the the first segment the application's |
Florin Coras | c87c91d | 2017-08-16 19:55:49 -0700 | [diff] [blame] | 95 | * event fifo. Depending on what the app does, it may be either used for |
Florin Coras | 7999e83 | 2017-10-31 01:51:04 -0700 | [diff] [blame] | 96 | * a listener or for connects. |
| 97 | */ |
Florin Coras | 6cf30ad | 2017-04-04 23:08:23 -0700 | [diff] [blame] | 98 | u32 first_segment_manager; |
Florin Coras | 0e9c33b | 2017-08-14 22:33:41 -0700 | [diff] [blame] | 99 | u8 first_segment_manager_in_use; |
Florin Coras | 6cf30ad | 2017-04-04 23:08:23 -0700 | [diff] [blame] | 100 | |
| 101 | /** Segment manager properties. Shared by all segment managers */ |
Florin Coras | a332c46 | 2018-01-31 06:52:17 -0800 | [diff] [blame] | 102 | segment_manager_properties_t sm_properties; |
Florin Coras | 7999e83 | 2017-10-31 01:51:04 -0700 | [diff] [blame] | 103 | |
| 104 | u16 proxied_transports; |
Florin Coras | f8f516a | 2018-02-08 15:10:09 -0800 | [diff] [blame] | 105 | |
| 106 | /* |
| 107 | * Local "cut through" connections specific |
| 108 | */ |
| 109 | |
| 110 | /** Segment manager used for incoming "cut through" connects */ |
| 111 | u32 local_segment_manager; |
| 112 | |
| 113 | /** Pool of local listen sessions */ |
| 114 | local_session_t *local_listen_sessions; |
| 115 | |
| 116 | /** Pool of local sessions the app owns (as a server) */ |
| 117 | local_session_t *local_sessions; |
| 118 | |
| 119 | /** Hash table of the app's local connects */ |
| 120 | uword *local_connects; |
Dave Barach | 68b0fb0 | 2017-02-28 15:15:56 -0500 | [diff] [blame] | 121 | } application_t; |
| 122 | |
Florin Coras | cea194d | 2017-10-02 00:18:51 -0700 | [diff] [blame] | 123 | #define APP_INVALID_INDEX ((u32)~0) |
| 124 | #define APP_NS_INVALID_INDEX ((u32)~0) |
Florin Coras | c87c91d | 2017-08-16 19:55:49 -0700 | [diff] [blame] | 125 | #define APP_INVALID_SEGMENT_MANAGER_INDEX ((u32) ~0) |
| 126 | |
Florin Coras | 6cf30ad | 2017-04-04 23:08:23 -0700 | [diff] [blame] | 127 | application_t *application_new (); |
Florin Coras | cea194d | 2017-10-02 00:18:51 -0700 | [diff] [blame] | 128 | int application_init (application_t * app, u32 api_client_index, |
| 129 | u64 * options, session_cb_vft_t * cb_fns); |
Dave Barach | 68b0fb0 | 2017-02-28 15:15:56 -0500 | [diff] [blame] | 130 | void application_del (application_t * app); |
| 131 | application_t *application_get (u32 index); |
Florin Coras | e04c299 | 2017-03-01 08:17:34 -0800 | [diff] [blame] | 132 | application_t *application_get_if_valid (u32 index); |
Dave Barach | 68b0fb0 | 2017-02-28 15:15:56 -0500 | [diff] [blame] | 133 | application_t *application_lookup (u32 api_client_index); |
| 134 | u32 application_get_index (application_t * app); |
| 135 | |
Florin Coras | cea194d | 2017-10-02 00:18:51 -0700 | [diff] [blame] | 136 | int application_start_listen (application_t * app, |
Florin Coras | f8f516a | 2018-02-08 15:10:09 -0800 | [diff] [blame] | 137 | session_endpoint_t * tep, |
| 138 | session_handle_t * handle); |
| 139 | int application_start_local_listen (application_t * server, |
| 140 | session_endpoint_t * sep, |
| 141 | session_handle_t * handle); |
| 142 | int application_stop_listen (application_t * srv, session_handle_t handle); |
| 143 | int application_stop_local_listen (application_t * server, |
| 144 | session_handle_t listener_handle); |
Florin Coras | cea194d | 2017-10-02 00:18:51 -0700 | [diff] [blame] | 145 | int application_open_session (application_t * app, session_endpoint_t * tep, |
| 146 | u32 api_context); |
Dave Barach | 68b0fb0 | 2017-02-28 15:15:56 -0500 | [diff] [blame] | 147 | int application_api_queue_is_full (application_t * app); |
| 148 | |
Florin Coras | 6cf30ad | 2017-04-04 23:08:23 -0700 | [diff] [blame] | 149 | segment_manager_t *application_get_listen_segment_manager (application_t * |
| 150 | app, |
| 151 | stream_session_t * |
Florin Coras | f8f516a | 2018-02-08 15:10:09 -0800 | [diff] [blame] | 152 | ls); |
Florin Coras | 6cf30ad | 2017-04-04 23:08:23 -0700 | [diff] [blame] | 153 | segment_manager_t *application_get_connect_segment_manager (application_t * |
| 154 | app); |
Dave Barach | 52851e6 | 2017-08-07 09:35:25 -0400 | [diff] [blame] | 155 | int application_is_proxy (application_t * app); |
Florin Coras | 7999e83 | 2017-10-31 01:51:04 -0700 | [diff] [blame] | 156 | int application_is_builtin (application_t * app); |
| 157 | int application_is_builtin_proxy (application_t * app); |
Florin Coras | a332c46 | 2018-01-31 06:52:17 -0800 | [diff] [blame] | 158 | int application_add_segment_notify (u32 app_index, ssvm_private_t * fs); |
Florin Coras | cea194d | 2017-10-02 00:18:51 -0700 | [diff] [blame] | 159 | u32 application_session_table (application_t * app, u8 fib_proto); |
| 160 | u32 application_local_session_table (application_t * app); |
| 161 | u8 *application_name_from_index (u32 app_index); |
| 162 | |
| 163 | u8 application_has_local_scope (application_t * app); |
| 164 | u8 application_has_global_scope (application_t * app); |
Florin Coras | 1c71045 | 2017-10-17 00:03:13 -0700 | [diff] [blame] | 165 | u32 application_n_listeners (application_t * app); |
Florin Coras | 7999e83 | 2017-10-31 01:51:04 -0700 | [diff] [blame] | 166 | stream_session_t *application_first_listener (application_t * app, |
| 167 | u8 fib_proto, |
| 168 | u8 transport_proto); |
| 169 | void application_setup_proxy (application_t * app); |
| 170 | void application_remove_proxy (application_t * app); |
| 171 | |
Florin Coras | a332c46 | 2018-01-31 06:52:17 -0800 | [diff] [blame] | 172 | segment_manager_properties_t *application_get_segment_manager_properties (u32 |
| 173 | app_index); |
| 174 | segment_manager_properties_t |
| 175 | * application_segment_manager_properties (application_t * app); |
| 176 | |
Florin Coras | f8f516a | 2018-02-08 15:10:09 -0800 | [diff] [blame] | 177 | local_session_t *application_alloc_local_session (application_t * app); |
| 178 | void application_free_local_session (application_t * app, |
| 179 | local_session_t * ls); |
| 180 | local_session_t *application_get_local_session (application_t * app, |
| 181 | u32 session_index); |
| 182 | local_session_t *application_get_local_session_from_handle (session_handle_t |
| 183 | handle); |
| 184 | int application_local_session_connect (u32 table_index, |
| 185 | application_t * client, |
| 186 | application_t * server, |
| 187 | local_session_t * ll, u32 opaque); |
| 188 | int application_local_session_connect_notify (local_session_t * ls); |
| 189 | int application_local_session_disconnect (u32 app_index, |
| 190 | local_session_t * ls); |
| 191 | void application_local_sessions_del (application_t * app); |
| 192 | |
| 193 | always_inline u32 |
| 194 | local_session_id (local_session_t * ll) |
| 195 | { |
| 196 | ASSERT (ll->app_index < (2 << 16) && ll->session_index < (2 << 16)); |
| 197 | return ((u32) ll->app_index << 16 | (u32) ll->session_index); |
| 198 | } |
| 199 | |
| 200 | always_inline void |
| 201 | local_session_parse_id (u32 ls_id, u32 * app_index, u32 * session_index) |
| 202 | { |
| 203 | *app_index = ls_id >> 16; |
| 204 | *session_index = ls_id & 0xFFF; |
| 205 | } |
| 206 | |
| 207 | always_inline void |
| 208 | local_session_parse_handle (session_handle_t handle, u32 * server_index, |
| 209 | u32 * session_index) |
| 210 | { |
| 211 | u32 bottom; |
Florin Coras | 5fda7a3 | 2018-02-14 08:04:31 -0800 | [diff] [blame] | 212 | ASSERT ((handle >> 32) == SESSION_LOCAL_HANDLE_PREFIX); |
Florin Coras | f8f516a | 2018-02-08 15:10:09 -0800 | [diff] [blame] | 213 | bottom = (handle & 0xFFFFFFFF); |
| 214 | local_session_parse_id (bottom, server_index, session_index); |
| 215 | } |
| 216 | |
| 217 | always_inline session_handle_t |
| 218 | application_local_session_handle (local_session_t * ls) |
| 219 | { |
Florin Coras | 5fda7a3 | 2018-02-14 08:04:31 -0800 | [diff] [blame] | 220 | return ((u64) SESSION_LOCAL_HANDLE_PREFIX << 32) |
| 221 | | (u64) local_session_id (ls); |
Florin Coras | f8f516a | 2018-02-08 15:10:09 -0800 | [diff] [blame] | 222 | } |
| 223 | |
| 224 | always_inline local_session_t * |
| 225 | application_get_local_listen_session (application_t * app, u32 session_index) |
| 226 | { |
| 227 | return pool_elt_at_index (app->local_listen_sessions, session_index); |
| 228 | } |
| 229 | |
Florin Coras | 5fda7a3 | 2018-02-14 08:04:31 -0800 | [diff] [blame] | 230 | always_inline local_session_t * |
| 231 | application_get_local_listener_w_handle (session_handle_t handle) |
| 232 | { |
| 233 | u32 server_index, session_index; |
| 234 | application_t *app; |
| 235 | local_session_parse_handle (handle, &server_index, &session_index); |
| 236 | app = application_get (server_index); |
| 237 | return application_get_local_listen_session (app, session_index); |
| 238 | } |
| 239 | |
Florin Coras | f8f516a | 2018-02-08 15:10:09 -0800 | [diff] [blame] | 240 | always_inline u8 |
| 241 | application_local_session_listener_has_transport (local_session_t * ls) |
| 242 | { |
| 243 | transport_proto_t tp; |
| 244 | tp = session_type_transport_proto (ls->listener_session_type); |
| 245 | return (tp != TRANSPORT_PROTO_NONE); |
| 246 | } |
| 247 | |
| 248 | |
Dave Barach | 68b0fb0 | 2017-02-28 15:15:56 -0500 | [diff] [blame] | 249 | #endif /* SRC_VNET_SESSION_APPLICATION_H_ */ |
| 250 | |
| 251 | /* |
| 252 | * fd.io coding-style-patch-verification: ON |
| 253 | * |
| 254 | * Local Variables: |
| 255 | * eval: (c-set-style "gnu") |
| 256 | * End: |
| 257 | */ |