2 * Copyright (c) 2020 Cisco and/or its affiliates.
3 * Licensed under the Apache License, Version 2.0 (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 #include <vcl/vcl_private.h>
19 vcl_api_connect_app_socket (vcl_worker_t * wrk)
21 clib_socket_t *cs = &wrk->app_api_sock;
25 cs->config = (char *) vcm->cfg.vpp_app_socket_api;
27 CLIB_SOCKET_F_IS_CLIENT | CLIB_SOCKET_F_SEQPACKET | CLIB_SOCKET_F_BLOCKING;
29 wrk->vcl_needs_real_epoll = 1;
31 if ((err = clib_socket_init (cs)))
33 /* don't report the error to avoid flood of error messages during
35 clib_error_free (err);
42 wrk->vcl_needs_real_epoll = 0;
48 vcl_api_attach_reply_handler (app_sapi_attach_reply_msg_t * mp, int *fds)
50 vcl_worker_t *wrk = vcl_worker_get_current ();
51 int i, rv, n_fds_used = 0;
57 VERR ("attach failed: %U", format_session_error, mp->retval);
61 wrk->api_client_handle = mp->api_client_handle;
62 segment_handle = mp->segment_handle;
63 if (segment_handle == VCL_INVALID_SEGMENT_HANDLE)
65 VERR ("invalid segment handle");
72 if (mp->fd_flags & SESSION_FD_F_VPP_MQ_SEGMENT)
73 if (vcl_segment_attach (vcl_vpp_worker_segment_handle (0), "vpp-mq-seg",
74 SSVM_SEGMENT_MEMFD, fds[n_fds_used++]))
77 if (mp->fd_flags & SESSION_FD_F_MEMFD_SEGMENT)
79 segment_name = format (0, "memfd-%ld%c", segment_handle, 0);
80 rv = vcl_segment_attach (segment_handle, (char *) segment_name,
81 SSVM_SEGMENT_MEMFD, fds[n_fds_used++]);
82 vec_free (segment_name);
87 vcl_segment_attach_mq (segment_handle, mp->app_mq, 0, &wrk->app_event_queue);
89 if (mp->fd_flags & SESSION_FD_F_MQ_EVENTFD)
91 svm_msg_q_set_eventfd (wrk->app_event_queue, fds[n_fds_used++]);
92 vcl_mq_epoll_add_evfd (wrk, wrk->app_event_queue);
95 vcl_segment_discover_mqs (vcl_vpp_worker_segment_handle (0),
96 fds + n_fds_used, mp->n_fds - n_fds_used);
97 vcl_segment_attach_mq (vcl_vpp_worker_segment_handle (0), mp->vpp_ctrl_mq,
98 mp->vpp_ctrl_mq_thread, &wrk->ctrl_mq);
99 vcm->ctrl_mq = wrk->ctrl_mq;
100 vcm->app_index = mp->app_index;
106 for (i = clib_max (n_fds_used - 1, 0); i < mp->n_fds; i++)
113 vcl_api_send_attach (clib_socket_t * cs)
115 app_sapi_msg_t msg = { 0 };
116 app_sapi_attach_msg_t *mp = &msg.attach;
117 u8 app_is_proxy, tls_engine;
120 app_is_proxy = (vcm->cfg.app_proxy_transport_tcp ||
121 vcm->cfg.app_proxy_transport_udp);
122 tls_engine = CRYPTO_ENGINE_OPENSSL;
124 clib_memcpy (&mp->name, vcm->app_name, vec_len (vcm->app_name));
125 mp->options[APP_OPTIONS_FLAGS] =
126 APP_OPTIONS_FLAGS_ACCEPT_REDIRECT | APP_OPTIONS_FLAGS_ADD_SEGMENT |
127 (vcm->cfg.app_scope_local ? APP_OPTIONS_FLAGS_USE_LOCAL_SCOPE : 0) |
128 (vcm->cfg.app_scope_global ? APP_OPTIONS_FLAGS_USE_GLOBAL_SCOPE : 0) |
129 (app_is_proxy ? APP_OPTIONS_FLAGS_IS_PROXY : 0) |
130 (vcm->cfg.use_mq_eventfd ? APP_OPTIONS_FLAGS_EVT_MQ_USE_EVENTFD : 0);
131 mp->options[APP_OPTIONS_PROXY_TRANSPORT] =
132 (u64) ((vcm->cfg.app_proxy_transport_tcp ? 1 << TRANSPORT_PROTO_TCP : 0) |
133 (vcm->cfg.app_proxy_transport_udp ? 1 << TRANSPORT_PROTO_UDP : 0));
134 mp->options[APP_OPTIONS_SEGMENT_SIZE] = vcm->cfg.segment_size;
135 mp->options[APP_OPTIONS_ADD_SEGMENT_SIZE] = vcm->cfg.add_segment_size;
136 mp->options[APP_OPTIONS_RX_FIFO_SIZE] = vcm->cfg.rx_fifo_size;
137 mp->options[APP_OPTIONS_TX_FIFO_SIZE] = vcm->cfg.tx_fifo_size;
138 mp->options[APP_OPTIONS_PREALLOC_FIFO_PAIRS] =
139 vcm->cfg.preallocated_fifo_pairs;
140 mp->options[APP_OPTIONS_EVT_QUEUE_SIZE] = vcm->cfg.event_queue_size;
141 mp->options[APP_OPTIONS_TLS_ENGINE] = tls_engine;
143 msg.type = APP_SAPI_MSG_TYPE_ATTACH;
144 err = clib_socket_sendmsg (cs, &msg, sizeof (msg), 0, 0);
147 clib_error_report (err);
155 vcl_sapi_attach (void)
157 vcl_worker_t *wrk = vcl_worker_get_current ();
158 app_sapi_msg_t _rmp, *rmp = &_rmp;
164 * Init client socket and send attach
166 if (vcl_api_connect_app_socket (wrk))
169 cs = &wrk->app_api_sock;
170 if (vcl_api_send_attach (cs))
174 * Wait for attach reply
176 err = clib_socket_recvmsg (cs, rmp, sizeof (*rmp), fds, ARRAY_LEN (fds));
179 clib_error_report (err);
183 if (rmp->type != APP_SAPI_MSG_TYPE_ATTACH_REPLY)
186 return vcl_api_attach_reply_handler (&rmp->attach_reply, fds);
190 vcl_api_add_del_worker_reply_handler (app_sapi_worker_add_del_reply_msg_t *
193 int n_fds = 0, i, rv;
199 VDBG (0, "add/del worker failed: %U", format_session_error, mp->retval);
206 wrk = vcl_worker_get_current ();
207 wrk->api_client_handle = mp->api_client_handle;
208 wrk->vpp_wrk_index = mp->wrk_index;
209 wrk->ctrl_mq = vcm->ctrl_mq;
211 segment_handle = mp->segment_handle;
212 if (segment_handle == VCL_INVALID_SEGMENT_HANDLE)
214 clib_warning ("invalid segment handle");
221 if (mp->fd_flags & SESSION_FD_F_VPP_MQ_SEGMENT)
222 if (vcl_segment_attach (vcl_vpp_worker_segment_handle (wrk->wrk_index),
223 "vpp-worker-seg", SSVM_SEGMENT_MEMFD,
227 if (mp->fd_flags & SESSION_FD_F_MEMFD_SEGMENT)
229 u8 *segment_name = format (0, "memfd-%ld%c", segment_handle, 0);
230 rv = vcl_segment_attach (segment_handle, (char *) segment_name,
231 SSVM_SEGMENT_MEMFD, fds[n_fds++]);
232 vec_free (segment_name);
237 vcl_segment_attach_mq (segment_handle, mp->app_event_queue_address, 0,
238 &wrk->app_event_queue);
240 if (mp->fd_flags & SESSION_FD_F_MQ_EVENTFD)
242 svm_msg_q_set_eventfd (wrk->app_event_queue, fds[n_fds]);
243 vcl_mq_epoll_add_evfd (wrk, wrk->app_event_queue);
247 VDBG (0, "worker %u vpp-worker %u added", wrk->wrk_index,
253 for (i = clib_max (n_fds - 1, 0); i < mp->n_fds; i++)
260 vcl_sapi_app_worker_add (void)
262 vcl_worker_t *wrk = vcl_worker_get_current ();
263 app_sapi_worker_add_del_msg_t *mp;
264 app_sapi_msg_t _rmp, *rmp = &_rmp;
265 app_sapi_msg_t msg = { 0 };
266 int fds[SESSION_N_FD_TYPE];
270 /* Connect to socket api */
271 if (vcl_api_connect_app_socket (wrk))
277 cs = &wrk->app_api_sock;
279 msg.type = APP_SAPI_MSG_TYPE_ADD_DEL_WORKER;
280 mp = &msg.worker_add_del;
281 mp->app_index = vcm->app_index;
284 err = clib_socket_sendmsg (cs, &msg, sizeof (msg), 0, 0);
287 clib_error_report (err);
292 * Wait for reply and process it
294 err = clib_socket_recvmsg (cs, rmp, sizeof (*rmp), fds, ARRAY_LEN (fds));
297 clib_error_report (err);
301 if (rmp->type != APP_SAPI_MSG_TYPE_ADD_DEL_WORKER_REPLY)
303 clib_warning ("unexpected reply type %u", rmp->type);
307 return vcl_api_add_del_worker_reply_handler (&rmp->worker_add_del_reply,
312 vcl_sapi_app_worker_del (vcl_worker_t * wrk)
314 app_sapi_worker_add_del_msg_t *mp;
315 app_sapi_msg_t msg = { 0 };
319 cs = &wrk->app_api_sock;
321 msg.type = APP_SAPI_MSG_TYPE_ADD_DEL_WORKER;
322 mp = &msg.worker_add_del;
323 mp->app_index = vcm->app_index;
324 mp->wrk_index = wrk->vpp_wrk_index;
327 err = clib_socket_sendmsg (cs, &msg, sizeof (msg), 0, 0);
329 clib_error_report (err);
330 clib_socket_close (cs);
334 vcl_sapi_detach (vcl_worker_t * wrk)
336 clib_socket_t *cs = &wrk->app_api_sock;
337 clib_socket_close (cs);
341 vcl_sapi_recv_fds (vcl_worker_t * wrk, int *fds, int n_fds)
343 app_sapi_msg_t _msg, *msg = &_msg;
347 cs = &wrk->app_api_sock;
349 err = clib_socket_recvmsg (cs, msg, sizeof (*msg), fds, n_fds);
352 clib_error_report (err);
355 if (msg->type != APP_SAPI_MSG_TYPE_SEND_FDS)
362 vcl_sapi_add_cert_key_pair (vppcom_cert_key_pair_t *ckpair)
364 u32 cert_len = ckpair->cert_len, key_len = ckpair->key_len, certkey_len;
365 vcl_worker_t *wrk = vcl_worker_get_current ();
366 app_sapi_msg_t _msg = { 0 }, *msg = &_msg;
367 app_sapi_cert_key_add_del_msg_t *mp;
368 app_sapi_msg_t _rmp, *rmp = &_rmp;
374 msg->type = APP_SAPI_MSG_TYPE_ADD_DEL_CERT_KEY;
375 mp = &msg->cert_key_add_del;
376 mp->context = wrk->wrk_index;
377 mp->cert_len = cert_len;
378 mp->certkey_len = cert_len + key_len;
381 certkey_len = cert_len + key_len;
382 vec_validate (certkey, certkey_len - 1);
383 clib_memcpy_fast (certkey, ckpair->cert, cert_len);
384 clib_memcpy_fast (certkey + cert_len, ckpair->key, key_len);
386 cs = &wrk->app_api_sock;
387 err = clib_socket_sendmsg (cs, msg, sizeof (*msg), 0, 0);
390 clib_error_report (err);
394 err = clib_socket_sendmsg (cs, certkey, certkey_len, 0, 0);
397 clib_error_report (err);
402 * Wait for reply and process it
404 err = clib_socket_recvmsg (cs, rmp, sizeof (*rmp), 0, 0);
407 clib_error_report (err);
411 if (rmp->type != APP_SAPI_MSG_TYPE_ADD_DEL_CERT_KEY_REPLY)
413 clib_warning ("unexpected reply type %u", rmp->type);
417 if (!rmp->cert_key_add_del_reply.retval)
418 rv = rmp->cert_key_add_del_reply.index;
426 vcl_sapi_del_cert_key_pair (u32 ckpair_index)
428 vcl_worker_t *wrk = vcl_worker_get_current ();
429 app_sapi_msg_t _msg = { 0 }, *msg = &_msg;
430 app_sapi_cert_key_add_del_msg_t *mp;
431 app_sapi_msg_t _rmp, *rmp = &_rmp;
435 msg->type = APP_SAPI_MSG_TYPE_ADD_DEL_CERT_KEY;
436 mp = &msg->cert_key_add_del;
437 mp->context = wrk->wrk_index;
438 mp->index = ckpair_index;
440 cs = &wrk->app_api_sock;
441 err = clib_socket_sendmsg (cs, msg, sizeof (*msg), 0, 0);
444 clib_error_report (err);
449 * Wait for reply and process it
451 err = clib_socket_recvmsg (cs, rmp, sizeof (*rmp), 0, 0);
454 clib_error_report (err);
458 if (rmp->type != APP_SAPI_MSG_TYPE_ADD_DEL_CERT_KEY_REPLY)
460 clib_warning ("unexpected reply type %u", rmp->type);
464 if (rmp->cert_key_add_del_reply.retval)
471 * fd.io coding-style-patch-verification: ON
474 * eval: (c-set-style "gnu")