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 /* reattaching via `vcl_api_retry_attach` wants wrk->vpp_wrk_index to be 0 */
63 wrk->vpp_wrk_index = 0;
64 segment_handle = mp->segment_handle;
65 if (segment_handle == VCL_INVALID_SEGMENT_HANDLE)
67 VERR ("invalid segment handle");
74 if (mp->fd_flags & SESSION_FD_F_VPP_MQ_SEGMENT)
75 if (vcl_segment_attach (vcl_vpp_worker_segment_handle (0), "vpp-mq-seg",
76 SSVM_SEGMENT_MEMFD, fds[n_fds_used++]))
79 if (mp->fd_flags & SESSION_FD_F_MEMFD_SEGMENT)
81 segment_name = format (0, "memfd-%ld%c", segment_handle, 0);
82 rv = vcl_segment_attach (segment_handle, (char *) segment_name,
83 SSVM_SEGMENT_MEMFD, fds[n_fds_used++]);
84 vec_free (segment_name);
89 vcl_segment_attach_mq (segment_handle, mp->app_mq, 0, &wrk->app_event_queue);
91 if (mp->fd_flags & SESSION_FD_F_MQ_EVENTFD)
93 svm_msg_q_set_eventfd (wrk->app_event_queue, fds[n_fds_used++]);
94 vcl_mq_epoll_add_evfd (wrk, wrk->app_event_queue);
97 vcl_segment_discover_mqs (vcl_vpp_worker_segment_handle (0),
98 fds + n_fds_used, mp->n_fds - n_fds_used);
99 vcl_segment_attach_mq (vcl_vpp_worker_segment_handle (0), mp->vpp_ctrl_mq,
100 mp->vpp_ctrl_mq_thread, &wrk->ctrl_mq);
101 vcm->ctrl_mq = wrk->ctrl_mq;
102 vcm->app_index = mp->app_index;
108 for (i = clib_max (n_fds_used - 1, 0); i < mp->n_fds; i++)
115 vcl_api_send_attach (clib_socket_t * cs)
117 app_sapi_msg_t msg = { 0 };
118 app_sapi_attach_msg_t *mp = &msg.attach;
119 u8 app_is_proxy, tls_engine;
122 app_is_proxy = (vcm->cfg.app_proxy_transport_tcp ||
123 vcm->cfg.app_proxy_transport_udp);
124 tls_engine = CRYPTO_ENGINE_OPENSSL;
126 clib_memcpy (&mp->name, vcm->app_name, vec_len (vcm->app_name));
127 mp->options[APP_OPTIONS_FLAGS] =
128 APP_OPTIONS_FLAGS_ACCEPT_REDIRECT | APP_OPTIONS_FLAGS_ADD_SEGMENT |
129 (vcm->cfg.app_scope_local ? APP_OPTIONS_FLAGS_USE_LOCAL_SCOPE : 0) |
130 (vcm->cfg.app_scope_global ? APP_OPTIONS_FLAGS_USE_GLOBAL_SCOPE : 0) |
131 (app_is_proxy ? APP_OPTIONS_FLAGS_IS_PROXY : 0) |
132 (vcm->cfg.use_mq_eventfd ? APP_OPTIONS_FLAGS_EVT_MQ_USE_EVENTFD : 0) |
133 (vcm->cfg.huge_page ? APP_OPTIONS_FLAGS_USE_HUGE_PAGE : 0);
134 mp->options[APP_OPTIONS_PROXY_TRANSPORT] =
135 (u64) ((vcm->cfg.app_proxy_transport_tcp ? 1 << TRANSPORT_PROTO_TCP : 0) |
136 (vcm->cfg.app_proxy_transport_udp ? 1 << TRANSPORT_PROTO_UDP : 0));
137 mp->options[APP_OPTIONS_SEGMENT_SIZE] = vcm->cfg.segment_size;
138 mp->options[APP_OPTIONS_ADD_SEGMENT_SIZE] = vcm->cfg.add_segment_size;
139 mp->options[APP_OPTIONS_RX_FIFO_SIZE] = vcm->cfg.rx_fifo_size;
140 mp->options[APP_OPTIONS_TX_FIFO_SIZE] = vcm->cfg.tx_fifo_size;
141 mp->options[APP_OPTIONS_PREALLOC_FIFO_PAIRS] =
142 vcm->cfg.preallocated_fifo_pairs;
143 mp->options[APP_OPTIONS_EVT_QUEUE_SIZE] = vcm->cfg.event_queue_size;
144 mp->options[APP_OPTIONS_TLS_ENGINE] = tls_engine;
146 msg.type = APP_SAPI_MSG_TYPE_ATTACH;
147 err = clib_socket_sendmsg (cs, &msg, sizeof (msg), 0, 0);
150 clib_error_report (err);
158 vcl_sapi_attach (void)
160 vcl_worker_t *wrk = vcl_worker_get_current ();
161 app_sapi_msg_t _rmp, *rmp = &_rmp;
167 * Init client socket and send attach
169 if (vcl_api_connect_app_socket (wrk))
172 cs = &wrk->app_api_sock;
173 if (vcl_api_send_attach (cs))
177 * Wait for attach reply
179 err = clib_socket_recvmsg (cs, rmp, sizeof (*rmp), fds, ARRAY_LEN (fds));
182 clib_error_report (err);
186 if (rmp->type != APP_SAPI_MSG_TYPE_ATTACH_REPLY)
189 return vcl_api_attach_reply_handler (&rmp->attach_reply, fds);
193 vcl_api_add_del_worker_reply_handler (app_sapi_worker_add_del_reply_msg_t *
196 int n_fds = 0, i, rv;
202 VDBG (0, "add/del worker failed: %U", format_session_error, mp->retval);
209 wrk = vcl_worker_get_current ();
210 wrk->api_client_handle = mp->api_client_handle;
211 wrk->vpp_wrk_index = mp->wrk_index;
212 wrk->ctrl_mq = vcm->ctrl_mq;
214 segment_handle = mp->segment_handle;
215 if (segment_handle == VCL_INVALID_SEGMENT_HANDLE)
217 clib_warning ("invalid segment handle");
224 if (mp->fd_flags & SESSION_FD_F_VPP_MQ_SEGMENT)
225 if (vcl_segment_attach (vcl_vpp_worker_segment_handle (wrk->wrk_index),
226 "vpp-worker-seg", SSVM_SEGMENT_MEMFD,
230 if (mp->fd_flags & SESSION_FD_F_MEMFD_SEGMENT)
232 u8 *segment_name = format (0, "memfd-%ld%c", segment_handle, 0);
233 rv = vcl_segment_attach (segment_handle, (char *) segment_name,
234 SSVM_SEGMENT_MEMFD, fds[n_fds++]);
235 vec_free (segment_name);
240 vcl_segment_attach_mq (segment_handle, mp->app_event_queue_address, 0,
241 &wrk->app_event_queue);
243 if (mp->fd_flags & SESSION_FD_F_MQ_EVENTFD)
245 svm_msg_q_set_eventfd (wrk->app_event_queue, fds[n_fds]);
246 vcl_mq_epoll_add_evfd (wrk, wrk->app_event_queue);
250 VDBG (0, "worker %u vpp-worker %u added", wrk->wrk_index,
256 for (i = clib_max (n_fds - 1, 0); i < mp->n_fds; i++)
263 vcl_sapi_app_worker_add (void)
265 vcl_worker_t *wrk = vcl_worker_get_current ();
266 app_sapi_worker_add_del_msg_t *mp;
267 app_sapi_msg_t _rmp, *rmp = &_rmp;
268 app_sapi_msg_t msg = { 0 };
269 int fds[SESSION_N_FD_TYPE];
273 /* Connect to socket api */
274 if (vcl_api_connect_app_socket (wrk))
280 cs = &wrk->app_api_sock;
282 msg.type = APP_SAPI_MSG_TYPE_ADD_DEL_WORKER;
283 mp = &msg.worker_add_del;
284 mp->app_index = vcm->app_index;
287 err = clib_socket_sendmsg (cs, &msg, sizeof (msg), 0, 0);
290 clib_error_report (err);
295 * Wait for reply and process it
297 err = clib_socket_recvmsg (cs, rmp, sizeof (*rmp), fds, ARRAY_LEN (fds));
300 clib_error_report (err);
304 if (rmp->type != APP_SAPI_MSG_TYPE_ADD_DEL_WORKER_REPLY)
306 clib_warning ("unexpected reply type %u", rmp->type);
310 return vcl_api_add_del_worker_reply_handler (&rmp->worker_add_del_reply,
315 vcl_sapi_app_worker_del (vcl_worker_t * wrk)
317 app_sapi_worker_add_del_msg_t *mp;
318 app_sapi_msg_t msg = { 0 };
322 cs = &wrk->app_api_sock;
324 msg.type = APP_SAPI_MSG_TYPE_ADD_DEL_WORKER;
325 mp = &msg.worker_add_del;
326 mp->app_index = vcm->app_index;
327 mp->wrk_index = wrk->vpp_wrk_index;
330 err = clib_socket_sendmsg (cs, &msg, sizeof (msg), 0, 0);
332 clib_error_report (err);
333 clib_socket_close (cs);
337 vcl_sapi_detach (vcl_worker_t * wrk)
339 clib_socket_t *cs = &wrk->app_api_sock;
340 clib_socket_close (cs);
344 vcl_sapi_recv_fds (vcl_worker_t * wrk, int *fds, int n_fds)
346 app_sapi_msg_t _msg, *msg = &_msg;
350 cs = &wrk->app_api_sock;
352 err = clib_socket_recvmsg (cs, msg, sizeof (*msg), fds, n_fds);
355 clib_error_report (err);
358 if (msg->type != APP_SAPI_MSG_TYPE_SEND_FDS)
365 vcl_sapi_add_cert_key_pair (vppcom_cert_key_pair_t *ckpair)
367 u32 cert_len = ckpair->cert_len, key_len = ckpair->key_len, certkey_len;
368 vcl_worker_t *wrk = vcl_worker_get_current ();
369 app_sapi_msg_t _msg = { 0 }, *msg = &_msg;
370 app_sapi_cert_key_add_del_msg_t *mp;
371 app_sapi_msg_t _rmp, *rmp = &_rmp;
377 msg->type = APP_SAPI_MSG_TYPE_ADD_DEL_CERT_KEY;
378 mp = &msg->cert_key_add_del;
379 mp->context = wrk->wrk_index;
380 mp->cert_len = cert_len;
381 mp->certkey_len = cert_len + key_len;
384 certkey_len = cert_len + key_len;
385 vec_validate (certkey, certkey_len - 1);
386 clib_memcpy_fast (certkey, ckpair->cert, cert_len);
387 clib_memcpy_fast (certkey + cert_len, ckpair->key, key_len);
389 cs = &wrk->app_api_sock;
390 err = clib_socket_sendmsg (cs, msg, sizeof (*msg), 0, 0);
393 clib_error_report (err);
397 err = clib_socket_sendmsg (cs, certkey, certkey_len, 0, 0);
400 clib_error_report (err);
405 * Wait for reply and process it
407 err = clib_socket_recvmsg (cs, rmp, sizeof (*rmp), 0, 0);
410 clib_error_report (err);
414 if (rmp->type != APP_SAPI_MSG_TYPE_ADD_DEL_CERT_KEY_REPLY)
416 clib_warning ("unexpected reply type %u", rmp->type);
420 if (!rmp->cert_key_add_del_reply.retval)
421 rv = rmp->cert_key_add_del_reply.index;
429 vcl_sapi_del_cert_key_pair (u32 ckpair_index)
431 vcl_worker_t *wrk = vcl_worker_get_current ();
432 app_sapi_msg_t _msg = { 0 }, *msg = &_msg;
433 app_sapi_cert_key_add_del_msg_t *mp;
434 app_sapi_msg_t _rmp, *rmp = &_rmp;
438 msg->type = APP_SAPI_MSG_TYPE_ADD_DEL_CERT_KEY;
439 mp = &msg->cert_key_add_del;
440 mp->context = wrk->wrk_index;
441 mp->index = ckpair_index;
443 cs = &wrk->app_api_sock;
444 err = clib_socket_sendmsg (cs, msg, sizeof (*msg), 0, 0);
447 clib_error_report (err);
452 * Wait for reply and process it
454 err = clib_socket_recvmsg (cs, rmp, sizeof (*rmp), 0, 0);
457 clib_error_report (err);
461 if (rmp->type != APP_SAPI_MSG_TYPE_ADD_DEL_CERT_KEY_REPLY)
463 clib_warning ("unexpected reply type %u", rmp->type);
467 if (rmp->cert_key_add_del_reply.retval)
474 * fd.io coding-style-patch-verification: ON
477 * eval: (c-set-style "gnu")