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 clib_error_report (err);
40 wrk->vcl_needs_real_epoll = 0;
46 vcl_api_attach_reply_handler (app_sapi_attach_reply_msg_t * mp, int *fds)
48 vcl_worker_t *wrk = vcl_worker_get_current ();
49 int i, rv, n_fds_used = 0;
55 VERR ("attach failed: %U", format_session_error, mp->retval);
59 wrk->api_client_handle = mp->api_client_handle;
60 segment_handle = mp->segment_handle;
61 if (segment_handle == VCL_INVALID_SEGMENT_HANDLE)
63 VERR ("invalid segment handle");
70 if (mp->fd_flags & SESSION_FD_F_VPP_MQ_SEGMENT)
71 if (vcl_segment_attach (vcl_vpp_worker_segment_handle (0), "vpp-mq-seg",
72 SSVM_SEGMENT_MEMFD, fds[n_fds_used++]))
75 if (mp->fd_flags & SESSION_FD_F_MEMFD_SEGMENT)
77 segment_name = format (0, "memfd-%ld%c", segment_handle, 0);
78 rv = vcl_segment_attach (segment_handle, (char *) segment_name,
79 SSVM_SEGMENT_MEMFD, fds[n_fds_used++]);
80 vec_free (segment_name);
85 vcl_segment_attach_mq (segment_handle, mp->app_mq, 0, &wrk->app_event_queue);
87 if (mp->fd_flags & SESSION_FD_F_MQ_EVENTFD)
89 svm_msg_q_set_eventfd (wrk->app_event_queue, fds[n_fds_used++]);
90 vcl_mq_epoll_add_evfd (wrk, wrk->app_event_queue);
93 vcl_segment_discover_mqs (vcl_vpp_worker_segment_handle (0),
94 fds + n_fds_used, mp->n_fds - n_fds_used);
95 vcl_segment_attach_mq (vcl_vpp_worker_segment_handle (0), mp->vpp_ctrl_mq,
96 mp->vpp_ctrl_mq_thread, &wrk->ctrl_mq);
97 vcm->ctrl_mq = wrk->ctrl_mq;
98 vcm->app_index = mp->app_index;
104 for (i = clib_max (n_fds_used - 1, 0); i < mp->n_fds; i++)
111 vcl_api_send_attach (clib_socket_t * cs)
113 app_sapi_msg_t msg = { 0 };
114 app_sapi_attach_msg_t *mp = &msg.attach;
115 u8 app_is_proxy, tls_engine;
118 app_is_proxy = (vcm->cfg.app_proxy_transport_tcp ||
119 vcm->cfg.app_proxy_transport_udp);
120 tls_engine = CRYPTO_ENGINE_OPENSSL;
122 clib_memcpy (&mp->name, vcm->app_name, vec_len (vcm->app_name));
123 mp->options[APP_OPTIONS_FLAGS] =
124 APP_OPTIONS_FLAGS_ACCEPT_REDIRECT | APP_OPTIONS_FLAGS_ADD_SEGMENT |
125 (vcm->cfg.app_scope_local ? APP_OPTIONS_FLAGS_USE_LOCAL_SCOPE : 0) |
126 (vcm->cfg.app_scope_global ? APP_OPTIONS_FLAGS_USE_GLOBAL_SCOPE : 0) |
127 (app_is_proxy ? APP_OPTIONS_FLAGS_IS_PROXY : 0) |
128 (vcm->cfg.use_mq_eventfd ? APP_OPTIONS_FLAGS_EVT_MQ_USE_EVENTFD : 0);
129 mp->options[APP_OPTIONS_PROXY_TRANSPORT] =
130 (u64) ((vcm->cfg.app_proxy_transport_tcp ? 1 << TRANSPORT_PROTO_TCP : 0) |
131 (vcm->cfg.app_proxy_transport_udp ? 1 << TRANSPORT_PROTO_UDP : 0));
132 mp->options[APP_OPTIONS_SEGMENT_SIZE] = vcm->cfg.segment_size;
133 mp->options[APP_OPTIONS_ADD_SEGMENT_SIZE] = vcm->cfg.add_segment_size;
134 mp->options[APP_OPTIONS_RX_FIFO_SIZE] = vcm->cfg.rx_fifo_size;
135 mp->options[APP_OPTIONS_TX_FIFO_SIZE] = vcm->cfg.tx_fifo_size;
136 mp->options[APP_OPTIONS_PREALLOC_FIFO_PAIRS] =
137 vcm->cfg.preallocated_fifo_pairs;
138 mp->options[APP_OPTIONS_EVT_QUEUE_SIZE] = vcm->cfg.event_queue_size;
139 mp->options[APP_OPTIONS_TLS_ENGINE] = tls_engine;
141 msg.type = APP_SAPI_MSG_TYPE_ATTACH;
142 err = clib_socket_sendmsg (cs, &msg, sizeof (msg), 0, 0);
145 clib_error_report (err);
153 vcl_sapi_attach (void)
155 vcl_worker_t *wrk = vcl_worker_get_current ();
156 app_sapi_msg_t _rmp, *rmp = &_rmp;
162 * Init client socket and send attach
164 if (vcl_api_connect_app_socket (wrk))
167 cs = &wrk->app_api_sock;
168 if (vcl_api_send_attach (cs))
172 * Wait for attach reply
174 err = clib_socket_recvmsg (cs, rmp, sizeof (*rmp), fds, ARRAY_LEN (fds));
177 clib_error_report (err);
181 if (rmp->type != APP_SAPI_MSG_TYPE_ATTACH_REPLY)
184 return vcl_api_attach_reply_handler (&rmp->attach_reply, fds);
188 vcl_api_add_del_worker_reply_handler (app_sapi_worker_add_del_reply_msg_t *
191 int n_fds = 0, i, rv;
197 VDBG (0, "add/del worker failed: %U", format_session_error, mp->retval);
204 wrk = vcl_worker_get_current ();
205 wrk->api_client_handle = mp->api_client_handle;
206 wrk->vpp_wrk_index = mp->wrk_index;
207 wrk->ctrl_mq = vcm->ctrl_mq;
209 segment_handle = mp->segment_handle;
210 if (segment_handle == VCL_INVALID_SEGMENT_HANDLE)
212 clib_warning ("invalid segment handle");
219 if (mp->fd_flags & SESSION_FD_F_VPP_MQ_SEGMENT)
220 if (vcl_segment_attach (vcl_vpp_worker_segment_handle (wrk->wrk_index),
221 "vpp-worker-seg", SSVM_SEGMENT_MEMFD,
225 if (mp->fd_flags & SESSION_FD_F_MEMFD_SEGMENT)
227 u8 *segment_name = format (0, "memfd-%ld%c", segment_handle, 0);
228 rv = vcl_segment_attach (segment_handle, (char *) segment_name,
229 SSVM_SEGMENT_MEMFD, fds[n_fds++]);
230 vec_free (segment_name);
235 vcl_segment_attach_mq (segment_handle, mp->app_event_queue_address, 0,
236 &wrk->app_event_queue);
238 if (mp->fd_flags & SESSION_FD_F_MQ_EVENTFD)
240 svm_msg_q_set_eventfd (wrk->app_event_queue, fds[n_fds]);
241 vcl_mq_epoll_add_evfd (wrk, wrk->app_event_queue);
245 VDBG (0, "worker %u vpp-worker %u added", wrk->wrk_index,
251 for (i = clib_max (n_fds - 1, 0); i < mp->n_fds; i++)
258 vcl_sapi_app_worker_add (void)
260 vcl_worker_t *wrk = vcl_worker_get_current ();
261 app_sapi_worker_add_del_msg_t *mp;
262 app_sapi_msg_t _rmp, *rmp = &_rmp;
263 app_sapi_msg_t msg = { 0 };
264 int fds[SESSION_N_FD_TYPE];
268 /* Connect to socket api */
269 if (vcl_api_connect_app_socket (wrk))
275 cs = &wrk->app_api_sock;
277 msg.type = APP_SAPI_MSG_TYPE_ADD_DEL_WORKER;
278 mp = &msg.worker_add_del;
279 mp->app_index = vcm->app_index;
282 err = clib_socket_sendmsg (cs, &msg, sizeof (msg), 0, 0);
285 clib_error_report (err);
290 * Wait for reply and process it
292 err = clib_socket_recvmsg (cs, rmp, sizeof (*rmp), fds, ARRAY_LEN (fds));
295 clib_error_report (err);
299 if (rmp->type != APP_SAPI_MSG_TYPE_ADD_DEL_WORKER_REPLY)
301 clib_warning ("unexpected reply type %u", rmp->type);
305 return vcl_api_add_del_worker_reply_handler (&rmp->worker_add_del_reply,
310 vcl_sapi_app_worker_del (vcl_worker_t * wrk)
312 app_sapi_worker_add_del_msg_t *mp;
313 app_sapi_msg_t msg = { 0 };
317 cs = &wrk->app_api_sock;
319 msg.type = APP_SAPI_MSG_TYPE_ADD_DEL_WORKER;
320 mp = &msg.worker_add_del;
321 mp->app_index = vcm->app_index;
322 mp->wrk_index = wrk->vpp_wrk_index;
325 err = clib_socket_sendmsg (cs, &msg, sizeof (msg), 0, 0);
327 clib_error_report (err);
328 clib_socket_close (cs);
332 vcl_sapi_detach (vcl_worker_t * wrk)
334 clib_socket_t *cs = &wrk->app_api_sock;
335 clib_socket_close (cs);
339 vcl_sapi_recv_fds (vcl_worker_t * wrk, int *fds, int n_fds)
341 app_sapi_msg_t _msg, *msg = &_msg;
345 cs = &wrk->app_api_sock;
347 err = clib_socket_recvmsg (cs, msg, sizeof (*msg), fds, n_fds);
350 clib_error_report (err);
353 if (msg->type != APP_SAPI_MSG_TYPE_SEND_FDS)
360 vcl_sapi_add_cert_key_pair (vppcom_cert_key_pair_t *ckpair)
362 u32 cert_len = ckpair->cert_len, key_len = ckpair->key_len, certkey_len;
363 vcl_worker_t *wrk = vcl_worker_get_current ();
364 app_sapi_msg_t _msg = { 0 }, *msg = &_msg;
365 app_sapi_cert_key_add_del_msg_t *mp;
366 app_sapi_msg_t _rmp, *rmp = &_rmp;
372 msg->type = APP_SAPI_MSG_TYPE_ADD_DEL_CERT_KEY;
373 mp = &msg->cert_key_add_del;
374 mp->context = wrk->wrk_index;
375 mp->cert_len = cert_len;
376 mp->certkey_len = cert_len + key_len;
379 certkey_len = cert_len + key_len;
380 vec_validate (certkey, certkey_len - 1);
381 clib_memcpy_fast (certkey, ckpair->cert, cert_len);
382 clib_memcpy_fast (certkey + cert_len, ckpair->key, key_len);
384 cs = &wrk->app_api_sock;
385 err = clib_socket_sendmsg (cs, msg, sizeof (*msg), 0, 0);
388 clib_error_report (err);
392 err = clib_socket_sendmsg (cs, certkey, certkey_len, 0, 0);
395 clib_error_report (err);
400 * Wait for reply and process it
402 err = clib_socket_recvmsg (cs, rmp, sizeof (*rmp), 0, 0);
405 clib_error_report (err);
409 if (rmp->type != APP_SAPI_MSG_TYPE_ADD_DEL_CERT_KEY_REPLY)
411 clib_warning ("unexpected reply type %u", rmp->type);
415 if (!rmp->cert_key_add_del_reply.retval)
416 rv = rmp->cert_key_add_del_reply.index;
424 vcl_sapi_del_cert_key_pair (u32 ckpair_index)
426 vcl_worker_t *wrk = vcl_worker_get_current ();
427 app_sapi_msg_t _msg = { 0 }, *msg = &_msg;
428 app_sapi_cert_key_add_del_msg_t *mp;
429 app_sapi_msg_t _rmp, *rmp = &_rmp;
433 msg->type = APP_SAPI_MSG_TYPE_ADD_DEL_CERT_KEY;
434 mp = &msg->cert_key_add_del;
435 mp->context = wrk->wrk_index;
436 mp->index = ckpair_index;
438 cs = &wrk->app_api_sock;
439 err = clib_socket_sendmsg (cs, &msg, sizeof (msg), 0, 0);
442 clib_error_report (err);
447 * Wait for reply and process it
449 err = clib_socket_recvmsg (cs, rmp, sizeof (*rmp), 0, 0);
452 clib_error_report (err);
456 if (rmp->type != APP_SAPI_MSG_TYPE_ADD_DEL_CERT_KEY_REPLY)
458 clib_warning ("unexpected reply type %u", rmp->type);
462 if (rmp->cert_key_add_del_reply.retval)
469 * fd.io coding-style-patch-verification: ON
472 * eval: (c-set-style "gnu")