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_APPLICATION_H_
17 #define SRC_VNET_SESSION_APPLICATION_H_
19 #include <vnet/vnet.h>
20 #include <vnet/session/session.h>
21 #include <vnet/session/segment_manager.h>
22 #include <vnet/session/application_namespace.h>
30 typedef struct _stream_session_cb_vft
32 /** Notify server of new segment */
33 int (*add_segment_callback) (u32 api_client_index,
34 const ssvm_private_t * ssvm_seg);
35 /** Notify server of new segment */
36 int (*del_segment_callback) (u32 api_client_index,
37 const ssvm_private_t * ssvm_seg);
39 /** Notify server of newly accepted session */
40 int (*session_accept_callback) (stream_session_t * new_session);
42 /** Connection request callback */
43 int (*session_connected_callback) (u32 app_index, u32 opaque,
44 stream_session_t * s, u8 code);
46 /** Notify app that session is closing */
47 void (*session_disconnect_callback) (stream_session_t * s);
49 /** Notify app that session was reset */
50 void (*session_reset_callback) (stream_session_t * s);
52 /** Direct RX callback, for built-in servers */
53 int (*builtin_server_rx_callback) (stream_session_t * session);
57 typedef struct _application
59 /** Index in server pool */
66 * Binary API interface to external app
69 /** Binary API connection index, ~0 if internal */
72 /** Namespace the application belongs to */
75 /** Application listens for events on this svm queue */
76 svm_queue_t *event_queue;
79 * Callbacks: shoulder-taps for the server/client
82 session_cb_vft_t cb_fns;
85 * ssvm (fifo) segment management
87 /** Segment manager used for outgoing connects issued by the app */
88 u32 connects_seg_manager;
90 /** Lookup tables for listeners. Value is segment manager index */
91 uword *listeners_table;
94 * First segment manager has in the the first segment the application's
95 * event fifo. Depending on what the app does, it may be either used for
96 * a listener or for connects.
98 u32 first_segment_manager;
99 u8 first_segment_manager_in_use;
101 /** Segment manager properties. Shared by all segment managers */
102 segment_manager_properties_t sm_properties;
104 u16 proxied_transports;
107 * Local "cut through" connections specific
110 /** Segment manager used for incoming "cut through" connects */
111 u32 local_segment_manager;
113 /** Pool of local listen sessions */
114 local_session_t *local_listen_sessions;
116 /** Pool of local sessions the app owns (as a server) */
117 local_session_t *local_sessions;
119 /** Hash table of the app's local connects */
120 uword *local_connects;
123 #define APP_INVALID_INDEX ((u32)~0)
124 #define APP_NS_INVALID_INDEX ((u32)~0)
125 #define APP_INVALID_SEGMENT_MANAGER_INDEX ((u32) ~0)
127 application_t *application_new ();
128 int application_init (application_t * app, u32 api_client_index,
129 u64 * options, session_cb_vft_t * cb_fns);
130 void application_del (application_t * app);
131 application_t *application_get (u32 index);
132 application_t *application_get_if_valid (u32 index);
133 application_t *application_lookup (u32 api_client_index);
134 u32 application_get_index (application_t * app);
136 int application_start_listen (application_t * app,
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);
145 int application_open_session (application_t * app, session_endpoint_t * tep,
147 int application_api_queue_is_full (application_t * app);
149 segment_manager_t *application_get_listen_segment_manager (application_t *
153 segment_manager_t *application_get_connect_segment_manager (application_t *
155 int application_is_proxy (application_t * app);
156 int application_is_builtin (application_t * app);
157 int application_is_builtin_proxy (application_t * app);
158 int application_add_segment_notify (u32 app_index, ssvm_private_t * fs);
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);
163 u8 application_has_local_scope (application_t * app);
164 u8 application_has_global_scope (application_t * app);
165 u32 application_n_listeners (application_t * app);
166 stream_session_t *application_first_listener (application_t * app,
169 void application_setup_proxy (application_t * app);
170 void application_remove_proxy (application_t * app);
172 segment_manager_properties_t *application_get_segment_manager_properties (u32
174 segment_manager_properties_t
175 * application_segment_manager_properties (application_t * app);
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,
182 local_session_t *application_get_local_session_from_handle (session_handle_t
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);
194 local_session_id (local_session_t * ll)
196 ASSERT (ll->app_index < (2 << 16) && ll->session_index < (2 << 16));
197 return ((u32) ll->app_index << 16 | (u32) ll->session_index);
201 local_session_parse_id (u32 ls_id, u32 * app_index, u32 * session_index)
203 *app_index = ls_id >> 16;
204 *session_index = ls_id & 0xFFF;
208 local_session_parse_handle (session_handle_t handle, u32 * server_index,
212 ASSERT ((handle >> 32) == SESSION_LOCAL_HANDLE_PREFIX);
213 bottom = (handle & 0xFFFFFFFF);
214 local_session_parse_id (bottom, server_index, session_index);
217 always_inline session_handle_t
218 application_local_session_handle (local_session_t * ls)
220 return ((u64) SESSION_LOCAL_HANDLE_PREFIX << 32)
221 | (u64) local_session_id (ls);
224 always_inline local_session_t *
225 application_get_local_listen_session (application_t * app, u32 session_index)
227 return pool_elt_at_index (app->local_listen_sessions, session_index);
230 always_inline local_session_t *
231 application_get_local_listener_w_handle (session_handle_t handle)
233 u32 server_index, session_index;
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);
241 application_local_session_listener_has_transport (local_session_t * ls)
243 transport_proto_t tp;
244 tp = session_type_transport_proto (ls->listener_session_type);
245 return (tp != TRANSPORT_PROTO_NONE);
249 #endif /* SRC_VNET_SESSION_APPLICATION_H_ */
252 * fd.io coding-style-patch-verification: ON
255 * eval: (c-set-style "gnu")