FD.io VPP  v19.08.3-2-gbabecb413
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  /** Segment manager used for outgoing connects issued by the app */
50 
51  /** Lookup tables for listeners. Value is segment manager index */
53 
54  /**
55  * First segment manager has in the the first segment the application's
56  * event fifo. Depending on what the app does, it may be either used for
57  * a listener or for connects.
58  */
61 
62  /** API index for the worker. Needed for multi-process apps */
64 
66 } app_worker_t;
67 
68 typedef struct app_worker_map_
69 {
72 
73 typedef struct app_listener_
74 {
75  clib_bitmap_t *workers; /**< workers accepting connections */
76  u32 accept_rotor; /**< last worker to accept a connection */
77  u32 al_index; /**< app listener index in app pool */
78  u32 app_index; /**< owning app index */
79  u32 local_index; /**< local listening session index */
80  u32 session_index; /**< global listening session index */
81  session_handle_t ls_handle; /**< session handle of the local or global
82  listening session that also identifies
83  the app listener */
85 
86 typedef struct application_
87 {
88  /** App index in app pool */
90 
91  /** Flags */
93 
94  /** Callbacks: shoulder-taps for the server/client */
96 
97  /** Segment manager properties. Shared by all segment managers */
99 
100  /** Pool of mappings that keep track of workers associated to this app */
102 
103  /** Name registered by builtin apps */
105 
106  /** Namespace the application belongs to */
108 
110 
111  /** Pool of listeners for the app */
113 
114  /*
115  * TLS & QUIC Specific
116  */
117 
118  /** Certificate to be used for listen sessions */
120 
121  /** PEM encoded key */
123 
124  /** Preferred tls engine */
126 
128 
129 } application_t;
130 
131 typedef struct app_main_
132 {
133  /**
134  * Pool from which we allocate all applications
135  */
137 
138  /**
139  * Hash table of apps by api client index
140  */
142 
143  /**
144  * Hash table of builtin apps by name
145  */
147 } app_main_t;
148 
149 typedef struct app_init_args_
150 {
151 #define _(_type, _name) _type _name;
153 #undef _
155 
156 typedef struct _vnet_app_worker_add_del_args
157 {
158  u32 app_index; /**< App for which a new worker is requested */
159  u32 wrk_map_index; /**< Index to delete or return value if add */
160  u32 api_client_index; /**< Binary API client index */
161  ssvm_private_t *segment; /**< First segment in segment manager */
162  u64 segment_handle; /**< Handle for the segment */
163  svm_msg_q_t *evt_q; /**< Worker message queue */
164  u8 is_add; /**< Flag set if addition */
166 
167 #define APP_INVALID_INDEX ((u32)~0)
168 #define APP_NS_INVALID_INDEX ((u32)~0)
169 #define APP_INVALID_SEGMENT_MANAGER_INDEX ((u32) ~0)
170 
175 void app_listener_cleanup (app_listener_t * app_listener);
178  session_endpoint_cfg_t * sep);
179 
180 /**
181  * Get app listener handle for listening session
182  *
183  * For a given listening session, this can return either the session
184  * handle of the app listener associated to the listening session or,
185  * if no such app listener exists, the session's handle
186  *
187  * @param ls listening session
188  * @return app listener or listening session handle
189  */
191 /**
192  * Get app listener for listener session handle
193  *
194  * Should only be called on handles that have an app listener, i.e.,
195  * were obtained at the end of a @ref vnet_listen call.
196  *
197  * @param handle handle of the app listener. This is the handle of
198  * either the global or local listener
199  * @return pointer to app listener or 0
200  */
205 
217 u32 application_session_table (application_t * app, u8 fib_proto);
219 const u8 *application_name_from_index (u32 app_or_wrk);
224 
226  app_index);
227 
230 
231 /*
232  * App worker
233  */
234 
237  app_worker_t ** wrk);
241 int app_worker_own_session (app_worker_t * app_wrk, session_t * s);
242 void app_worker_free (app_worker_t * app_wrk);
244  u32 api_context);
245 int app_worker_start_listen (app_worker_t * app_wrk, app_listener_t * lstnr);
248 int app_worker_accept_notify (app_worker_t * app_wrk, session_t * s);
251  u32 opaque);
252 int app_worker_close_notify (app_worker_t * app_wrk, session_t * s);
254  session_t * s);
255 int app_worker_reset_notify (app_worker_t * app_wrk, session_t * s);
259  session_handle_t new_sh);
260 int app_worker_builtin_rx (app_worker_t * app_wrk, session_t * s);
261 int app_worker_builtin_tx (app_worker_t * app_wrk, session_t * s);
263  session_t *);
269  u64 segment_handle);
271  u64 segment_handle);
274  u8 fib_proto, u8 transport_proto);
275 int app_worker_send_event (app_worker_t * app, session_t * s, u8 evt);
277  u8 evt_type);
279  u8 transport_proto);
280 u8 *format_app_worker (u8 * s, va_list * args);
281 u8 *format_app_worker_listener (u8 * s, va_list * args);
282 void app_worker_format_connects (app_worker_t * app_wrk, int verbose);
284 
285 uword unformat_application_proto (unformat_input_t * input, va_list * args);
286 
287 
288 /* Needed while we support both bapi and mq ctrl messages */
289 int mq_send_session_bound_cb (u32 app_wrk_index, u32 api_context,
290  session_handle_t handle, int rv);
291 int mq_send_session_connected_cb (u32 app_wrk_index, u32 api_context,
292  session_t * s, u8 is_fail);
294  u32 context, int rv);
295 
296 #endif /* SRC_VNET_SESSION_APPLICATION_H_ */
297 
298 /*
299  * fd.io coding-style-patch-verification: ON
300  *
301  * Local Variables:
302  * eval: (c-set-style "gnu")
303  * End:
304  */
u32 flags
Flags.
Definition: application.h:92
int app_worker_lock_and_send_event(app_worker_t *app, session_t *s, u8 evt_type)
Send event to application.
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)
u32 al_index
app listener index in app pool
Definition: application.h:77
a
Definition: bitmap.h:538
u32 ns_index
Namespace the application belongs to.
Definition: application.h:107
application_t * application_lookup_name(const u8 *name)
Definition: application.c:397
application_t * application_get_if_valid(u32 index)
Definition: application.c:426
segment_manager_props_t * application_segment_manager_properties(application_t *app)
Definition: application.c:1293
unsigned long u64
Definition: types.h:89
void application_remove_proxy(application_t *app)
Definition: application.c:1277
segment_manager_t * app_worker_get_or_alloc_connect_segment_manager(app_worker_t *)
int app_worker_connect_session(app_worker_t *app, session_endpoint_t *tep, u32 api_context)
app_listener_t * listeners
Pool of listeners for the app.
Definition: application.h:112
u32 wrk_map_index
Worker index in app&#39;s map pool.
Definition: application.h:40
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.
uword * listeners_table
Lookup tables for listeners.
Definition: application.h:52
application_t * application_lookup(u32 api_client_index)
Definition: application.c:386
struct app_listener_ app_listener_t
u8 app_is_builtin
Definition: application.h:65
u32 connects_seg_manager
Segment manager used for outgoing connects issued by the app.
Definition: application.h:49
segment_manager_t * app_worker_get_listen_segment_manager(app_worker_t *, session_t *)
unsigned char u8
Definition: types.h:56
app_listener_t * app_listener_lookup(application_t *app, session_endpoint_cfg_t *sep)
Definition: application.c:98
uword unformat_application_proto(unformat_input_t *input, va_list *args)
u32 app_index
owning app index
Definition: application.h:78
app_worker_t * application_listener_select_worker(session_t *ls)
Definition: application.c:666
session_t * app_listener_get_local_session(app_listener_t *al)
Definition: application.c:281
u32 first_segment_manager
First segment manager has in the the first segment the application&#39;s event fifo.
Definition: application.h:59
u32 local_index
local listening session index
Definition: application.h:79
u32 session_index
global listening session index
Definition: application.h:80
unsigned int u32
Definition: types.h:88
u16 proxied_transports
Definition: application.h:109
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:125
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:230
int app_worker_accept_notify(app_worker_t *app_wrk, session_t *s)
u64 * quicly_ctx
Definition: application.h:127
#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:1129
int mq_send_session_bound_cb(u32 app_wrk_index, u32 api_context, session_handle_t handle, int rv)
Definition: session_api.c:383
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
app_worker_t * app_worker_get_if_valid(u32 wrk_index)
app_worker_t * app_worker_alloc(application_t *app)
u8 name[64]
Definition: memclnt.api:152
int application_change_listener_owner(session_t *s, app_worker_t *app_wrk)
Definition: application.c:1090
u8 * format_app_worker_listener(u8 *s, va_list *args)
app_worker_map_t * worker_maps
Pool of mappings that keep track of workers associated to this app.
Definition: application.h:101
app_listener_t * app_listener_get_w_handle(session_handle_t handle)
Get app listener for listener session handle.
Definition: application.c:88
int mq_send_session_connected_cb(u32 app_wrk_index, u32 api_context, session_t *s, u8 is_fail)
Definition: session_api.c:303
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:146
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:98
int app_worker_builtin_rx(app_worker_t *app_wrk, session_t *s)
struct app_init_args_ app_init_args_t
int app_worker_cleanup_notify(app_worker_t *app_wrk, session_t *s, session_cleanup_ntf_t ntf)
struct _stream_session_cb_vft session_cb_vft_t
clib_bitmap_t * workers
workers accepting connections
Definition: application.h:75
int app_listener_alloc_and_init(application_t *app, session_endpoint_cfg_t *sep, app_listener_t **listener)
Definition: application.c:130
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:717
const u8 * application_name_from_index(u32 app_or_wrk)
Returns app name for app-index.
Definition: application.c:352
u8 application_has_global_scope(application_t *app)
Definition: application.c:1147
application_t * application_get(u32 index)
Definition: application.c:418
int application_is_proxy(application_t *app)
Definition: application.c:1123
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:141
session_cb_vft_t cb_fns
Callbacks: shoulder-taps for the server/client.
Definition: application.h:95
u32 app_worker_n_listeners(app_worker_t *app)
u8 * tls_key
PEM encoded key.
Definition: application.h:122
u32 application_session_table(application_t *app, u8 fib_proto)
Definition: application.c:324
u32 accept_rotor
last worker to accept a connection
Definition: application.h:76
int app_worker_migrate_notify(app_worker_t *app_wrk, session_t *s, session_handle_t new_sh)
int app_worker_del_segment_notify(app_worker_t *app_wrk, u64 segment_handle)
struct app_main_ app_main_t
u32 app_index
App index in app pool.
Definition: application.h:89
struct app_worker_map_ app_worker_map_t
u32 application_local_session_table(application_t *app)
Definition: application.c:339
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:136
u64 session_handle_t
int application_alloc_worker_and_init(application_t *app, app_worker_t **wrk)
Definition: application.c:677
u8 * name
Name registered by builtin apps.
Definition: application.h:104
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:81
int app_worker_alloc_connects_segment_manager(app_worker_t *app)
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:272
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:1141
u32 app_index
Index of owning app.
Definition: application.h:43
int application_is_builtin_proxy(application_t *app)
Definition: application.c:1135
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:654
u8 * tls_cert
Certificate to be used for listen sessions.
Definition: application.h:119
segment_manager_props_t * application_get_segment_manager_properties(u32 app_index)
Definition: application.c:1299
uword clib_bitmap_t
Definition: bitmap.h:50
void app_worker_format_connects(app_worker_t *app_wrk, int verbose)
u32 api_client_index
API index for the worker.
Definition: application.h:63
int app_worker_close_notify(app_worker_t *app_wrk, session_t *s)
struct _session_endpoint session_endpoint_t
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)
u32 context
Definition: gre.api:45
void application_setup_proxy(application_t *app)
Definition: application.c:1261
CLIB_CACHE_LINE_ALIGN_MARK(cacheline0)
int app_worker_connect_notify(app_worker_t *app_wrk, session_t *s, u32 opaque)
app_worker_t * application_get_worker(application_t *app, u32 wrk_index)
Definition: application.c:644
u8 first_segment_manager_in_use
Definition: application.h:60
void mq_send_unlisten_reply(app_worker_t *app_wrk, session_handle_t sh, u32 context, int rv)
Definition: session_api.c:443