FD.io VPP  v21.06
Vector Packet Processing
application.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2017-2019 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 
23 
24 #define APP_DEBUG 0
25 
26 #if APP_DEBUG > 0
27 #define APP_DBG(_fmt, _args...) clib_warning (_fmt, ##_args)
28 #else
29 #define APP_DBG(_fmt, _args...)
30 #endif
31 
32 typedef struct app_worker_
33 {
34  CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
35 
36  /** Worker index in global worker pool*/
38 
39  /** Worker index in app's map pool */
41 
42  /** Index of owning app */
44 
45  /** Application listens for events on this svm queue */
47 
48  /**
49  * Segment manager used for outgoing connects issued by the app. By
50  * convention this is the first segment manager allocated by the worker
51  * so it's also the one that holds the first segment with the app's
52  * message queue in it.
53  */
55 
56  /** Lookup tables for listeners. Value is segment manager index */
58 
59  /** API index for the worker. Needed for multi-process apps */
61 
63 
64  /** Pool of half-open session handles. Tracked in case worker detaches */
66 
67  /** Protects detached seg managers */
69 
70  /** Vector of detached listener segment managers */
72 } app_worker_t;
73 
74 typedef struct app_worker_map_
75 {
78 
79 typedef struct app_listener_
80 {
81  clib_bitmap_t *workers; /**< workers accepting connections */
82  u32 accept_rotor; /**< last worker to accept a connection */
83  u32 al_index; /**< app listener index in app pool */
84  u32 app_index; /**< owning app index */
85  u32 local_index; /**< local listening session index */
86  u32 session_index; /**< global listening session index */
87  session_handle_t ls_handle; /**< session handle of the local or global
88  listening session that also identifies
89  the app listener */
91 
92 typedef enum app_rx_mq_flags_
93 {
97 
98 typedef struct app_rx_mq_elt_
99 {
107 
108 typedef struct application_
109 {
110  /** App index in app pool */
112 
113  /** Flags */
115 
116  /** Callbacks: shoulder-taps for the server/client */
118 
119  /** Segment manager properties. Shared by all segment managers */
121 
122  /** Pool of mappings that keep track of workers associated to this app */
124 
125  /** Name registered by builtin apps */
127 
128  /** Namespace the application belongs to */
130 
132 
133  /** Pool of listeners for the app */
135 
136  /** Preferred tls engine */
138 
139  /** quic initialization vector */
140  char quic_iv[17];
142 
143  /** Segment where rx mqs were allocated */
145 
146  /**
147  * Fixed vector of rx mqs that can be a part of pending_rx_mqs
148  * linked list maintained by the app sublayer for each worker
149  */
151 } application_t;
152 
153 typedef struct app_rx_mq_handle_
154 {
155  union
156  {
157  struct
158  {
161  };
163  };
164 } __attribute__ ((aligned (sizeof (u64)))) app_rx_mq_handle_t;
165 
166 /**
167  * App sublayer per vpp worker state
168  */
169 typedef struct asl_wrk_
170 {
171  /** Linked list of mqs with pending messages */
173 } appsl_wrk_t;
174 
175 typedef struct app_main_
176 {
177  /**
178  * Pool from which we allocate all applications
179  */
181 
182  /**
183  * Hash table of apps by api client index
184  */
186 
187  /**
188  * Hash table of builtin apps by name
189  */
191 
192  /**
193  * Pool from which we allocate certificates (key, cert)
194  */
196 
197  /*
198  * Last registered crypto engine type
199  */
201 
202  /**
203  * App sublayer per-worker state
204  */
206 } app_main_t;
207 
208 typedef struct app_init_args_
209 {
210 #define _(_type, _name) _type _name;
212 #undef _
214 
215 typedef struct _vnet_app_worker_add_del_args
216 {
217  u32 app_index; /**< App for which a new worker is requested */
218  u32 wrk_map_index; /**< Index to delete or return value if add */
219  u32 api_client_index; /**< Binary API client index */
220  ssvm_private_t *segment; /**< First segment in segment manager */
221  u64 segment_handle; /**< Handle for the segment */
222  svm_msg_q_t *evt_q; /**< Worker message queue */
223  u8 is_add; /**< Flag set if addition */
225 
226 #define APP_INVALID_INDEX ((u32)~0)
227 #define APP_NS_INVALID_INDEX ((u32)~0)
228 #define APP_INVALID_SEGMENT_MANAGER_INDEX ((u32) ~0)
229 
234 void app_listener_cleanup (app_listener_t * app_listener);
237  session_endpoint_cfg_t * sep);
238 
239 /**
240  * Get app listener handle for listening session
241  *
242  * For a given listening session, this can return either the session
243  * handle of the app listener associated to the listening session or,
244  * if no such app listener exists, the session's handle
245  *
246  * @param ls listening session
247  * @return app listener or listening session handle
248  */
250 /**
251  * Get app listener for listener session handle
252  *
253  * Should only be called on handles that have an app listener, i.e.,
254  * were obtained at the end of a @ref vnet_listen call.
255  *
256  * @param handle handle of the app listener. This is the handle of
257  * either the global or local listener
258  * @return pointer to app listener or 0
259  */
264 
276 u32 application_session_table (application_t * app, u8 fib_proto);
278 const u8 *application_name_from_index (u32 app_or_wrk);
283 
285  app_index);
286 
289 
294 
295 /*
296  * App worker
297  */
298 
301  app_worker_t ** wrk);
305 int app_worker_own_session (app_worker_t * app_wrk, session_t * s);
306 void app_worker_free (app_worker_t * app_wrk);
308  session_handle_t *rsh);
309 int app_worker_start_listen (app_worker_t * app_wrk, app_listener_t * lstnr);
312 int app_worker_accept_notify (app_worker_t * app_wrk, session_t * s);
315  session_error_t err, u32 opaque);
318 int app_worker_close_notify (app_worker_t * app_wrk, session_t * s);
320  session_t * s);
321 int app_worker_reset_notify (app_worker_t * app_wrk, session_t * s);
325  session_handle_t new_sh);
326 int app_worker_builtin_rx (app_worker_t * app_wrk, session_t * s);
327 int app_worker_builtin_tx (app_worker_t * app_wrk, session_t * s);
329  svm_fifo_t * f,
332  session_t *);
335  u64 segment_handle);
337  u64 segment_handle);
340  u8 fib_proto, u8 transport_proto);
341 int app_worker_send_event (app_worker_t * app, session_t * s, u8 evt);
343  u8 evt_type);
346 void app_worker_del_detached_sm (app_worker_t * app_wrk, u32 sm_index);
347 u8 *format_app_worker (u8 * s, va_list * args);
348 u8 *format_app_worker_listener (u8 * s, va_list * args);
349 u8 *format_crypto_engine (u8 * s, va_list * args);
350 u8 *format_crypto_context (u8 * s, va_list * args);
351 void app_worker_format_connects (app_worker_t * app_wrk, int verbose);
353 
354 uword unformat_application_proto (unformat_input_t * input, va_list * args);
355 
359 
360 /* Needed while we support both bapi and mq ctrl messages */
361 int mq_send_session_bound_cb (u32 app_wrk_index, u32 api_context,
362  session_handle_t handle, int rv);
363 int mq_send_session_connected_cb (u32 app_wrk_index, u32 api_context,
364  session_t * s, session_error_t err);
366  u32 context, int rv);
367 
370 
371 #endif /* SRC_VNET_SESSION_APPLICATION_H_ */
372 
373 /*
374  * fd.io coding-style-patch-verification: ON
375  *
376  * Local Variables:
377  * eval: (c-set-style "gnu")
378  * End:
379  */
u32 flags
Flags.
Definition: application.h:114
int app_worker_lock_and_send_event(app_worker_t *app, session_t *s, u8 evt_type)
Send event to application.
session_handle_t * half_open_table
Pool of half-open session handles.
Definition: application.h:65
struct _vnet_app_worker_add_del_args vnet_app_worker_add_del_args_t
int app_worker_init_accepted(session_t *s)
session_t * app_worker_proxy_listener(app_worker_t *app, u8 fib_proto, u8 transport_proto)
int app_worker_reset_notify(app_worker_t *app_wrk, session_t *s)
App sublayer per vpp worker state.
Definition: application.h:169
u32 al_index
app listener index in app pool
Definition: application.h:83
int mq_send_session_connected_cb(u32 app_wrk_index, u32 api_context, session_t *s, session_error_t err)
Definition: session_api.c:266
a
Definition: bitmap.h:544
transport_proto
Definition: session.api:22
int app_worker_connect_notify(app_worker_t *app_wrk, session_t *s, session_error_t err, u32 opaque)
app_cert_key_pair_t * app_cert_key_pair_get(u32 index)
Definition: application.c:2004
u32 ns_index
Namespace the application belongs to.
Definition: application.h:129
u32 * detached_seg_managers
Vector of detached listener segment managers.
Definition: application.h:71
int app_worker_connect_session(app_worker_t *app, session_endpoint_cfg_t *sep, session_handle_t *rsh)
application_t * application_lookup_name(const u8 *name)
Definition: application.c:431
fifo_segment_t * application_get_rx_mqs_segment(application_t *app)
Definition: application.c:683
application_t * application_get_if_valid(u32 index)
Definition: application.c:718
struct app_rx_mq_elt_ * next
Definition: application.h:100
app_rx_mq_elt_t * rx_mqs
Fixed vector of rx mqs that can be a part of pending_rx_mqs linked list maintained by the app sublaye...
Definition: application.h:150
session_worker_t * wrk
Definition: application.c:490
segment_manager_props_t * application_segment_manager_properties(application_t *app)
Definition: application.c:1636
unsigned long u64
Definition: types.h:89
void application_remove_proxy(application_t *app)
Definition: application.c:1620
app_listener_t * listeners
Pool of listeners for the app.
Definition: application.h:134
u32 wrk_map_index
Worker index in app&#39;s map pool.
Definition: application.h:40
app_cert_key_pair_t * cert_key_pair_store
Pool from which we allocate certificates (key, cert)
Definition: application.h:195
app_listener_t * app_listener_get_w_session(session_t *ls)
Definition: application.c:67
int app_worker_add_segment_notify(app_worker_t *app_wrk, u64 segment_handle)
Send an API message to the external app, to map new segment.
string name[64]
Definition: fib.api:25
uword * listeners_table
Lookup tables for listeners.
Definition: application.h:57
application_t * application_lookup(u32 api_client_index)
Definition: application.c:420
struct app_listener_ app_listener_t
u8 app_is_builtin
Definition: application.h:62
u8 * format_crypto_context(u8 *s, va_list *args)
Definition: application.c:1752
u32 connects_seg_manager
Segment manager used for outgoing connects issued by the app.
Definition: application.h:54
appsl_wrk_t * wrk
App sublayer per-worker state.
Definition: application.h:205
segment_manager_t * app_worker_get_listen_segment_manager(app_worker_t *, session_t *)
unsigned char u8
Definition: types.h:56
struct app_rx_mq_elt_ * prev
Definition: application.h:101
app_listener_t * app_listener_lookup(application_t *app, session_endpoint_cfg_t *sep)
Definition: application.c:98
unsigned int u32
Definition: types.h:88
u8 app_crypto_engine_n_types(void)
Definition: application.c:2105
vlib_frame_t * f
uword unformat_application_proto(unformat_input_t *input, va_list *args)
u32 app_index
owning app index
Definition: application.h:84
app_worker_t * application_listener_select_worker(session_t *ls)
Definition: application.c:972
enum session_ft_action_ session_ft_action_t
app_rx_mq_elt_t * pending_rx_mqs
Linked list of mqs with pending messages.
Definition: application.h:172
session_t * app_listener_get_local_session(app_listener_t *al)
Definition: application.c:315
u32 local_index
local listening session index
Definition: application.h:85
u32 session_index
global listening session index
Definition: application.h:86
u16 proxied_transports
Definition: application.h:131
int __clib_unused rv
Definition: application.c:491
session_handle_t app_listen_session_handle(session_t *ls)
Get app listener handle for listening session.
Definition: application.c:78
u8 tls_engine
Preferred tls engine.
Definition: application.h:137
struct app_worker_ app_worker_t
struct _session_endpoint_cfg session_endpoint_cfg_t
void app_listener_cleanup(app_listener_t *app_listener)
Definition: application.c:264
int app_worker_accept_notify(app_worker_t *app_wrk, session_t *s)
#define foreach_app_init_args
struct _unformat_input_t unformat_input_t
unsigned short u16
Definition: types.h:57
int application_is_builtin(application_t *app)
Definition: application.c:1472
app_cert_key_pair_t * app_cert_key_pair_get_default()
Definition: application.c:2010
struct asl_wrk_ appsl_wrk_t
App sublayer per vpp worker state.
int mq_send_session_bound_cb(u32 app_wrk_index, u32 api_context, session_handle_t handle, int rv)
Definition: session_api.c:351
struct _segment_manager_props segment_manager_props_t
segment_manager_t * app_worker_get_connect_segment_manager(app_worker_t *)
app_listener_t * app_listener_get(application_t *app, u32 al_index)
Definition: application.c:46
u32 wrk_index
Worker index in global worker pool.
Definition: application.h:37
struct app_rx_mq_elt_ app_rx_mq_elt_t
app_worker_t * app_worker_get_if_valid(u32 wrk_index)
int app_worker_session_fifo_tuning(app_worker_t *app_wrk, session_t *s, svm_fifo_t *f, session_ft_action_t act, u32 len)
app_worker_t * app_worker_alloc(application_t *app)
int application_change_listener_owner(session_t *s, app_worker_t *app_wrk)
Definition: application.c:1432
u8 * format_app_worker_listener(u8 *s, va_list *args)
fifo_segment_t rx_mqs_segment
Segment where rx mqs were allocated.
Definition: application.h:144
u8 len
Definition: ip_types.api:103
app_worker_map_t * worker_maps
Pool of mappings that keep track of workers associated to this app.
Definition: application.h:123
app_listener_t * app_listener_get_w_handle(session_handle_t handle)
Get app listener for listener session handle.
Definition: application.c:88
int app_worker_transport_closed_notify(app_worker_t *app_wrk, session_t *s)
uword * app_by_name
Hash table of builtin apps by name.
Definition: application.h:190
session_t * app_worker_first_listener(app_worker_t *app, u8 fib_proto, u8 transport_proto)
segment_manager_props_t sm_properties
Segment manager properties.
Definition: application.h:120
u32 index
Definition: flow_types.api:221
int app_worker_builtin_rx(app_worker_t *app_wrk, session_t *s)
struct app_init_args_ app_init_args_t
u8 * format_crypto_engine(u8 *s, va_list *args)
Definition: application.c:1713
int app_worker_cleanup_notify(app_worker_t *app_wrk, session_t *s, session_cleanup_ntf_t ntf)
svm_msg_q_t * application_rx_mq_get(application_t *app, u32 mq_index)
Definition: application.c:615
svm_msg_q_t * mq
Definition: application.h:102
clib_bitmap_t * workers
workers accepting connections
Definition: application.h:81
clib_spinlock_t detached_seg_managers_lock
Protects detached seg managers.
Definition: application.h:68
int app_listener_alloc_and_init(application_t *app, session_endpoint_cfg_t *sep, app_listener_t **listener)
Definition: application.c:156
int app_worker_init_connected(app_worker_t *app_wrk, session_t *s)
int vnet_app_worker_add_del(vnet_app_worker_add_del_args_t *a)
Definition: application.c:1022
const u8 * application_name_from_index(u32 app_or_wrk)
Returns app name for app-index.
Definition: application.c:386
u8 application_has_global_scope(application_t *app)
Definition: application.c:1490
application_t * application_get(u32 index)
Definition: application.c:710
void app_worker_del_detached_sm(app_worker_t *app_wrk, u32 sm_index)
int application_is_proxy(application_t *app)
Definition: application.c:1466
u8 application_use_private_rx_mqs(void)
Definition: application.c:677
int app_worker_send_event(app_worker_t *app, session_t *s, u8 evt)
uword * app_by_api_client_index
Hash table of apps by api client index.
Definition: application.h:185
void application_enable_rx_mqs_nodes(u8 is_en)
Definition: application.c:691
session_cb_vft_t cb_fns
Callbacks: shoulder-taps for the server/client.
Definition: application.h:117
u32 app_worker_n_listeners(app_worker_t *app)
u32 application_session_table(application_t *app, u8 fib_proto)
Definition: application.c:358
u32 accept_rotor
last worker to accept a connection
Definition: application.h:82
int app_worker_migrate_notify(app_worker_t *app_wrk, session_t *s, session_handle_t new_sh)
struct app_rx_mq_handle_ app_rx_mq_handle_t
u32 context
Definition: ip.api:780
int app_worker_del_segment_notify(app_worker_t *app_wrk, u64 segment_handle)
struct app_main_ app_main_t
enum app_rx_mq_flags_ app_rx_mq_flags_t
u32 app_index
App index in app pool.
Definition: application.h:111
struct app_worker_map_ app_worker_map_t
u32 application_local_session_table(application_t *app)
Definition: application.c:373
int app_worker_del_half_open(app_worker_t *app_wrk, session_t *s)
struct application_ application_t
session_handle_t app_listener_handle(app_listener_t *app_listener)
Definition: application.c:61
app_worker_t * app_worker_get(u32 wrk_index)
application_t * app_pool
Pool from which we allocate all applications.
Definition: application.h:180
u64 session_handle_t
int application_alloc_worker_and_init(application_t *app, app_worker_t **wrk)
Definition: application.c:983
u8 * name
Name registered by builtin apps.
Definition: application.h:126
int app_worker_add_half_open(app_worker_t *app_wrk, session_handle_t sh)
application_t * app_worker_get_app(u32 wrk_index)
u64 uword
Definition: types.h:112
session_handle_t ls_handle
session handle of the local or global listening session that also identifies the app listener ...
Definition: application.h:87
struct _segment_manager segment_manager_t
int app_worker_builtin_tx(app_worker_t *app_wrk, session_t *s)
session_t * app_listener_get_session(app_listener_t *al)
Definition: application.c:306
session_cleanup_ntf_t
int app_worker_start_listen(app_worker_t *app_wrk, app_listener_t *lstnr)
u8 application_has_local_scope(application_t *app)
Definition: application.c:1484
u32 app_index
Index of owning app.
Definition: application.h:43
int application_is_builtin_proxy(application_t *app)
Definition: application.c:1478
int app_worker_own_session(app_worker_t *app_wrk, session_t *s)
int app_worker_stop_listen(app_worker_t *app_wrk, app_listener_t *al)
void app_worker_free(app_worker_t *app_wrk)
app_worker_t * application_get_default_worker(application_t *app)
Definition: application.c:960
segment_manager_props_t * application_get_segment_manager_properties(u32 app_index)
Definition: application.c:1642
uword clib_bitmap_t
Definition: bitmap.h:50
enum session_error_ session_error_t
crypto_engine_type_t app_crypto_engine_type_add(void)
Definition: application.c:2099
enum crypto_engine_type_ crypto_engine_type_t
void app_worker_format_connects(app_worker_t *app_wrk, int verbose)
u32 api_client_index
API index for the worker.
Definition: application.h:60
int app_worker_close_notify(app_worker_t *app_wrk, session_t *s)
svm_msg_q_t * event_queue
Application listens for events on this svm queue.
Definition: application.h:46
u8 * format_app_worker(u8 *s, va_list *args)
struct _svm_fifo svm_fifo_t
void application_setup_proxy(application_t *app)
Definition: application.c:1604
CLIB_CACHE_LINE_ALIGN_MARK(cacheline0)
app_rx_mq_flags_
Definition: application.h:92
app_cert_key_pair_t * app_cert_key_pair_get_if_valid(u32 index)
Definition: application.c:1996
app_worker_t * application_get_worker(application_t *app, u32 wrk_index)
Definition: application.c:950
crypto_engine_type_t last_crypto_engine
Definition: application.h:200
void mq_send_unlisten_reply(app_worker_t *app_wrk, session_handle_t sh, u32 context, int rv)
Definition: session_api.c:413