FD.io VPP  v18.10-32-g1161dda
Vector Packet Processing
application.h
Go to the documentation of this file.
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/session/session.h>
22 
23 #define APP_DEBUG 0
24 
25 #if APP_DEBUG > 0
26 #define APP_DBG(_fmt, _args...) clib_warning (_fmt, ##_args)
27 #else
28 #define APP_DBG(_fmt, _args...)
29 #endif
30 
31 typedef struct _stream_session_cb_vft
32 {
33  /** Notify server of new segment */
34  int (*add_segment_callback) (u32 api_client_index,
35  const ssvm_private_t * ssvm_seg);
36  /** Notify server of new segment */
37  int (*del_segment_callback) (u32 api_client_index,
38  const ssvm_private_t * ssvm_seg);
39 
40  /** Notify server of newly accepted session */
41  int (*session_accept_callback) (stream_session_t * new_session);
42 
43  /** Connection request callback */
44  int (*session_connected_callback) (u32 app_wrk_index, u32 opaque,
45  stream_session_t * s, u8 code);
46 
47  /** Notify app that session is closing */
48  void (*session_disconnect_callback) (stream_session_t * s);
49 
50  /** Notify app that session was reset */
51  void (*session_reset_callback) (stream_session_t * s);
52 
53  /** Direct RX callback for built-in application */
54  int (*builtin_app_rx_callback) (stream_session_t * session);
55 
56  /** Direct TX callback for built-in application */
57  int (*builtin_app_tx_callback) (stream_session_t * session);
58 
60 
61 typedef struct app_worker_
62 {
63  CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
64 
65  /** Worker index in global worker pool*/
67 
68  /** Worker index in app's map pool */
70 
71  /** Index of owning app */
73 
74  /** Application listens for events on this svm queue */
76 
77  /** Segment manager used for outgoing connects issued by the app */
79 
80  /** Lookup tables for listeners. Value is segment manager index */
82 
83  /**
84  * First segment manager has in the the first segment the application's
85  * event fifo. Depending on what the app does, it may be either used for
86  * a listener or for connects.
87  */
90 
91  /*
92  * Local "cut through" connections specific
93  */
94 
95  /** Segment manager used for incoming "cut through" connects */
97 
98  /** Pool of local sessions the app owns (as a server) */
100 
101  /** Hash table of the app's local connects */
103 
105 } app_worker_t;
106 
107 typedef struct app_worker_map_
108 {
111 
112 typedef struct app_listener_
113 {
114  clib_bitmap_t *workers; /**< workers accepting connections */
115  u32 accept_rotor; /**< last worker to accept a connection */
118 
119 typedef struct application_
120 {
121  /** App index in app pool */
123 
124  /** Binary API connection index, ~0 if internal */
126 
127  /** Flags */
129 
130  /** Callbacks: shoulder-taps for the server/client */
132 
133  /** Segment manager properties. Shared by all segment managers */
135 
136  /** Pool of mappings that keep track of workers associated to this app */
138 
139  /** Name registered by builtin apps */
141 
142  /** Namespace the application belongs to */
144 
146 
147  /** Pool of listeners for the app */
149 
150  /** Pool of local listeners for app */
152 
153  /** Pool of local listen sessions */
155 
156  /*
157  * TLS Specific
158  */
159 
160  /** Certificate to be used for listen sessions */
162 
163  /** PEM encoded key */
165 
166  /** Preferred tls engine */
168 
169 } application_t;
170 
171 typedef struct app_main_
172 {
173  /**
174  * Pool from which we allocate all applications
175  */
177 
178  /**
179  * Pool of workers associated to apps
180  */
182 
183  /**
184  * Hash table of apps by api client index
185  */
187 
188  /**
189  * Hash table of builtin apps by name
190  */
192 } app_main_t;
193 
194 #define foreach_app_init_args \
195  _(u32, api_client_index) \
196  _(u8 *, name) \
197  _(u64 *, options) \
198  _(u8 *, namespace_id) \
199  _(session_cb_vft_t *, session_cb_vft) \
200  _(u32, app_index) \
201 
202 typedef struct app_init_args_
203 {
204 #define _(_type, _name) _type _name;
206 #undef _
208 
209 typedef struct _vnet_app_worker_add_del_args
210 {
211  u32 app_index; /**< App for which a new worker is requested */
212  u32 wrk_index; /**< Index to delete or return value if add */
213  ssvm_private_t *segment; /**< First segment in segment manager */
214  svm_msg_q_t *evt_q; /**< Worker message queue */
215  u8 is_add; /**< Flag set if addition */
217 
218 #define APP_INVALID_INDEX ((u32)~0)
219 #define APP_NS_INVALID_INDEX ((u32)~0)
220 #define APP_INVALID_SEGMENT_MANAGER_INDEX ((u32) ~0)
221 
224 app_worker_t *app_worker_get (u32 wrk_index);
227 void app_worker_free (app_worker_t * app_wrk);
229  u32 api_context);
231  stream_session_t *);
234 int app_worker_add_segment_notify (u32 app_or_wrk, ssvm_private_t * fs);
237  u8 fib_proto,
238  u8 transport_proto);
242  u8 evt_type);
244 
247  session_handle_t * handle);
248 int application_stop_listen (u32 app_index, u32 app_or_wrk,
249  session_handle_t handle);
250 
253 void application_free (application_t * app);
256 application_t *application_lookup (u32 api_client_index);
262  u8 is_local);
263 
265 
269 u32 application_session_table (application_t * app, u8 fib_proto);
271 u8 *application_name_from_index (u32 app_or_wrk);
277 
279  app_index);
280 
283 
284 /*
285  * Local session
286  */
287 
290  local_session_t * ls);
292  u32 session_index);
294  handle);
299  session_handle_t * handle);
300 int application_stop_local_listen (u32 app_index, u32 app_or_wrk,
301  session_handle_t lh);
303  app_worker_t * server,
304  local_session_t * ls, u32 opaque);
307  local_session_t * ls);
309  u32 ls_index);
311 
314 {
315  ASSERT (ls->session_index < (2 << 16));
316  u32 app_or_wrk_index;
317 
319  {
320  ASSERT (ls->app_index < (2 << 16));
321  app_or_wrk_index = ls->app_index;
322  }
323  else
324  {
325  ASSERT (ls->app_wrk_index < (2 << 16));
326  app_or_wrk_index = ls->app_wrk_index;
327  }
328 
329  return ((u32) app_or_wrk_index << 16 | (u32) ls->session_index);
330 }
331 
332 always_inline void
333 local_session_parse_id (u32 ls_id, u32 * app_or_wrk, u32 * session_index)
334 {
335  *app_or_wrk = ls_id >> 16;
336  *session_index = ls_id & 0xFF;
337 }
338 
339 always_inline void
340 local_session_parse_handle (session_handle_t handle, u32 * app_or_wrk_index,
341  u32 * session_index)
342 {
343  u32 bottom;
344  ASSERT ((handle >> 32) == SESSION_LOCAL_HANDLE_PREFIX);
345  bottom = (handle & 0xFFFFFFFF);
346  local_session_parse_id (bottom, app_or_wrk_index, session_index);
347 }
348 
351 {
352  return ((u64) SESSION_LOCAL_HANDLE_PREFIX << 32)
353  | (u64) local_session_id (ls);
354 }
355 
358 {
359  return pool_elt_at_index (app->local_listen_sessions, session_index);
360 }
361 
364 {
365  u32 server_index, session_index;
366  application_t *app;
367  local_session_parse_handle (handle, &server_index, &session_index);
368  app = application_get (server_index);
369  return application_get_local_listen_session (app, session_index);
370 }
371 
374 {
377  return (tp != TRANSPORT_PROTO_NONE);
378 }
379 
381  local_session_t * ls);
382 
383 uword unformat_application_proto (unformat_input_t * input, va_list * args);
384 
385 #endif /* SRC_VNET_SESSION_APPLICATION_H_ */
386 
387 /*
388  * fd.io coding-style-patch-verification: ON
389  *
390  * Local Variables:
391  * eval: (c-set-style "gnu")
392  * End:
393  */
app_worker_t * application_listener_select_worker(stream_session_t *ls, u8 is_local)
Definition: application.c:460
u32 flags
Flags.
Definition: application.h:128
struct _vnet_app_worker_add_del_args vnet_app_worker_add_del_args_t
session_type_t listener_session_type
Has transport embedded when listener not purely local.
void application_free(application_t *app)
Definition: application.c:388
#define CLIB_CACHE_LINE_ALIGN_MARK(mark)
Definition: cache.h:60
static session_handle_t application_local_session_handle(local_session_t *ls)
Definition: application.h:350
int app_worker_lock_and_send_event(app_worker_t *app, stream_session_t *s, u8 evt_type)
Send event to application.
Definition: application.c:1339
a
Definition: bitmap.h:538
u32 ns_index
Namespace the application belongs to.
Definition: application.h:143
u8 application_use_mq_for_ctrl(application_t *app)
Definition: application.c:976
struct _segment_manager_properties segment_manager_properties_t
application_t * application_lookup_name(const u8 *name)
Definition: application.c:222
application_t * application_get_if_valid(u32 index)
Definition: application.c:251
unsigned long u64
Definition: types.h:89
void application_remove_proxy(application_t *app)
Definition: application.c:1169
local_session_t * local_listen_sessions
Pool of local listen sessions.
Definition: application.h:154
app_listener_t * listeners
Pool of listeners for the app.
Definition: application.h:148
u32 wrk_map_index
Worker index in app&#39;s map pool.
Definition: application.h:69
#define SESSION_LOCAL_HANDLE_PREFIX
Definition: session.h:28
local_session_t * application_get_local_session_from_handle(session_handle_t handle)
Definition: application.c:1374
u64 session_handle_t
Definition: session.h:107
uword * listeners_table
Lookup tables for listeners.
Definition: application.h:81
application_t * application_lookup(u32 api_client_index)
Definition: application.c:211
struct app_listener_ app_listener_t
u32 connects_seg_manager
Segment manager used for outgoing connects issued by the app.
Definition: application.h:78
int application_start_listen(application_t *app, session_endpoint_extended_t *tep, session_handle_t *handle)
Start listening local transport endpoint for requested transport.
Definition: application.c:717
int app_worker_add_segment_notify(u32 app_or_wrk, ssvm_private_t *fs)
Send an API message to the external app, to map new segment.
Definition: application.c:985
unsigned char u8
Definition: types.h:56
segment_manager_properties_t * application_get_segment_manager_properties(u32 app_index)
Definition: application.c:1191
uword unformat_application_proto(unformat_input_t *input, va_list *args)
int app_worker_alloc_and_init(application_t *app, app_worker_t **wrk)
Definition: application.c:579
u32 first_segment_manager
First segment manager has in the the first segment the application&#39;s event fifo.
Definition: application.h:88
#define always_inline
Definition: clib.h:94
int app_worker_open_session(app_worker_t *app, session_endpoint_t *tep, u32 api_context)
Definition: application.c:837
struct _stream_session_cb_vft session_cb_vft_t
app_listener_t * local_listeners
Pool of local listeners for app.
Definition: application.h:151
segment_manager_t * app_worker_get_listen_segment_manager(app_worker_t *, stream_session_t *)
Definition: application.c:874
unsigned int u32
Definition: types.h:88
static local_session_t * application_get_local_listen_session(application_t *app, u32 session_index)
Definition: application.h:357
u16 proxied_transports
Definition: application.h:145
struct _stream_session_t stream_session_t
int application_local_session_disconnect_w_index(u32 app_or_wrk, u32 ls_index)
Definition: application.c:1827
u8 tls_engine
Preferred tls engine.
Definition: application.h:167
clib_error_t * vnet_app_worker_add_del(vnet_app_worker_add_del_args_t *a)
Definition: application.c:884
int application_local_session_connect(app_worker_t *client, app_worker_t *server, local_session_t *ls, u32 opaque)
Definition: application.c:1562
struct app_worker_ app_worker_t
void application_local_session_free(app_worker_t *app, local_session_t *ls)
Definition: application.c:1358
app_worker_t * workers
Pool of workers associated to apps.
Definition: application.h:181
#define pool_elt_at_index(p, i)
Returns pointer to element at given index.
Definition: pool.h:464
struct _session_endpoint session_endpoint_t
struct _unformat_input_t unformat_input_t
unsigned short u16
Definition: types.h:57
int application_is_builtin(application_t *app)
Definition: application.c:952
static void local_session_parse_id(u32 ls_id, u32 *app_or_wrk, u32 *session_index)
Definition: application.h:333
segment_manager_t * app_worker_get_connect_segment_manager(app_worker_t *)
Definition: application.c:867
static u8 application_local_session_listener_has_transport(local_session_t *ls)
Definition: application.h:373
u32 application_index(application_t *app)
Definition: application.c:260
u32 wrk_index
Worker index in global worker pool.
Definition: application.h:66
app_worker_t * app_worker_get_if_valid(u32 wrk_index)
Definition: application.c:505
app_worker_t * app_worker_alloc(application_t *app)
Definition: application.c:483
u8 name[64]
Definition: memclnt.api:151
volatile u8 session_state
State.
app_worker_map_t * worker_maps
Pool of mappings that keep track of workers associated to this app.
Definition: application.h:137
uword * app_by_name
Hash table of builtin apps by name.
Definition: application.h:191
int application_start_local_listen(application_t *server, session_endpoint_extended_t *sep, session_handle_t *handle)
Definition: application.c:1410
static transport_proto_t session_type_transport_proto(session_type_t st)
Definition: session.h:385
struct app_init_args_ app_init_args_t
int app_worker_send_event(app_worker_t *app, stream_session_t *s, u8 evt)
Send event to application.
Definition: application.c:1326
u32 local_segment_manager
Segment manager used for incoming "cut through" connects.
Definition: application.h:96
clib_bitmap_t * workers
workers accepting connections
Definition: application.h:114
segment_manager_properties_t sm_properties
Segment manager properties.
Definition: application.h:134
u32 app_wrk_index
Server index.
int application_stop_local_listen(u32 app_index, u32 app_or_wrk, session_handle_t lh)
Clean up local session table.
Definition: application.c:1472
#define ASSERT(truth)
u8 application_has_global_scope(application_t *app)
Definition: application.c:970
application_t * application_get(u32 index)
Definition: application.c:243
static local_session_t * application_get_local_listener_w_handle(session_handle_t handle)
Definition: application.h:363
int application_is_proxy(application_t *app)
Definition: application.c:946
uword * app_by_api_client_index
Hash table of apps by api client index.
Definition: application.h:186
void app_worker_local_sessions_free(app_worker_t *app)
Definition: application.c:1837
session_cb_vft_t cb_fns
Callbacks: shoulder-taps for the server/client.
Definition: application.h:131
u32 app_worker_n_listeners(app_worker_t *app)
u8 * tls_key
PEM encoded key.
Definition: application.h:164
u32 application_session_table(application_t *app, u8 fib_proto)
Definition: application.c:124
stream_session_t * app_worker_first_listener(app_worker_t *app, u8 fib_proto, u8 transport_proto)
Definition: application.c:999
int application_alloc_and_init(app_init_args_t *args)
Definition: application.c:306
u32 accept_rotor
last worker to accept a connection
Definition: application.h:115
u32 api_client_index
Binary API connection index, ~0 if internal.
Definition: application.h:125
local_session_t * application_get_local_session(app_worker_t *app, u32 session_index)
Definition: application.c:1366
struct app_main_ app_main_t
u32 app_index
App index in app pool.
Definition: application.h:122
struct app_worker_map_ app_worker_map_t
u32 application_local_session_table(application_t *app)
Definition: application.c:139
application_t * application_alloc(void)
Definition: application.c:233
local_session_t * application_local_session_alloc(app_worker_t *app)
Definition: application.c:1346
struct application_ application_t
int application_local_session_disconnect(u32 app_or_wrk, local_session_t *ls)
Definition: application.c:1765
app_worker_t * app_worker_get(u32 wrk_index)
Definition: application.c:499
application_t * app_pool
Pool from which we allocate all applications.
Definition: application.h:176
enum _transport_proto transport_proto_t
segment_manager_properties_t * application_segment_manager_properties(application_t *app)
Definition: application.c:1185
static u32 local_session_id(local_session_t *ls)
Definition: application.h:313
u8 * name
Name registered by builtin apps.
Definition: application.h:140
u8 * application_name_from_index(u32 app_or_wrk)
Returns app name.
Definition: application.c:183
application_t * app_worker_get_app(u32 wrk_index)
Definition: application.c:627
u64 uword
Definition: types.h:112
u32 session_index
Session index.
int app_worker_alloc_connects_segment_manager(app_worker_t *app)
Definition: application.c:852
struct _segment_manager segment_manager_t
u8 app_worker_application_is_builtin(app_worker_t *app_wrk)
Definition: application.c:1023
u8 application_has_local_scope(application_t *app)
Definition: application.c:964
int application_stop_listen(u32 app_index, u32 app_or_wrk, session_handle_t handle)
Stop listening on session associated to handle.
Definition: application.c:799
u32 app_index
Index of owning app.
Definition: application.h:72
int application_is_builtin_proxy(application_t *app)
Definition: application.c:958
uword * local_connects
Hash table of the app&#39;s local connects.
Definition: application.h:102
local_session_t * local_sessions
Pool of local sessions the app owns (as a server)
Definition: application.h:99
void app_worker_free(app_worker_t *app_wrk)
Definition: application.c:513
app_worker_t * application_get_default_worker(application_t *app)
Definition: application.c:454
u8 * tls_cert
Certificate to be used for listen sessions.
Definition: application.h:161
local_session_t * application_get_local_listen_session_from_handle(session_handle_t lh)
int application_api_queue_is_full(application_t *app)
Definition: application.c:159
uword clib_bitmap_t
Definition: bitmap.h:50
int application_local_session_connect_notify(local_session_t *ls)
Definition: application.c:1677
#define foreach_app_init_args
Definition: application.h:194
svm_msg_q_t * event_queue
Application listens for events on this svm queue.
Definition: application.h:75
void application_setup_proxy(application_t *app)
Definition: application.c:1153
struct _session_endpoint_extended session_endpoint_extended_t
app_worker_t * application_get_worker(application_t *app, u32 wrk_index)
Definition: application.c:444
u8 first_segment_manager_in_use
Definition: application.h:89
static void local_session_parse_handle(session_handle_t handle, u32 *app_or_wrk_index, u32 *session_index)
Definition: application.h:340
void mq_send_local_session_disconnected_cb(u32 app_or_wrk, local_session_t *ls)
Definition: session_api.c:531